Scanning Engine v2 - Module - WebSocket¶

Overview¶

Targeting¶

Configuration¶

Only the publicly-available configuration keys that can be set in a job's module invocations will be described below. Additional configuration keys may exist, but not be shown here because they are restricted to specific users or because they are permanently set as a static value. If no keys have (required) after their names then invocations of this module need not contain a config key.

Named Keys¶

`connect-timeout`¶

Timeout for each connection, in seconds.

Type: integer
Default: 3

`data`¶

Data to send.

Type: string

`debug`¶

Run module with a debugging configuration.

Type: boolean

`path`¶

Connection path.

Type: string
Default: /

`ssl`¶

Connect using SSL/TLS.

Type: boolean

Schemas¶

The schema for the body object of all results generated with .task.module_name equal to websocket can be found here. The schema for results is available both in standalone and bundled form.

Examples¶

These are examples of the .body object for results with .task.module_name equal to websocket.

WebSocket.org's Echo Service¶

This example was generated with WebSocket.org's Echo service.

{
  "url": "wss://echo.websocket.org:443/",
  "state": "open",
  "banner": "Request served by 7811941c69e658"
}

Live Host¶

This example was generated with a live host on the internet.

{
  "url": "ws://[REDACTED]:80/",
  "state": "closed",
  "error": "Handshake status 200 OK"
}

Changelog¶

YYYY-MM-DD: Initial public release of documentation.