WSHawk Documentation

Current v4.0.4 reference material for both desktop editions and stateful web, GraphQL, and WebSocket testing.

What v4 Optimizes For

Project-Backed Operations

Traffic, identities, notes, findings, and exports stay together in one local project.

Stateful Testing

Replay, AuthZ diff, and race testing matter more than a one-shot scanner when the target is stateful.

Protected Evidence

Encryption, redaction, hashes, retention controls, replay steps, and stable retesting keep findings reproducible.

GO

Electron + Go Desktop

Bridge-free architecture, install choices, workspaces, protected projects, native packages, and build commands.

AZ

Authorization Testing

Matrices, policies, object discovery, semantic analysis, safe writes, GraphQL, WebSocket, findings, and retesting.

๐Ÿ”„

v4 Workflow Lifecycle

How projects, capture, replay, diffing, race testing, and exports fit together.

๐Ÿš€

Getting Started

Install WSHawk, choose the right surface, and start with the recommended v4 path.

๐Ÿง 

Protocol & Heuristics

How WSHawk infers message families, fields, protocol hints, and likely attack paths.

โš”๏ธ

Replay & Attack Services

Where payload mutation still helps and where replay, AuthZ diff, and race become the stronger proof path.

๐Ÿ“ก

OAST & Blind Testing

Using callback-based detection for SSRF, XXE, and similar out-of-band behavior.

๐Ÿงช

Browser Evidence

What the Playwright-assisted evidence path does and what it does not claim.

๐Ÿ“Š

Vulnerability Coverage

The main issue classes WSHawk is good at proving in v4.

๐Ÿ“š

Academy

Longer v4.0.4 guides for both desktops, authorization, evidence, validation, and release history.

Core Command Reference

CommandDescription
wshawk ws://target.example/wsRun the compatibility scanner for a fast first pass.
wshawk-interactiveOpen the interactive CLI workflow.
wshawk-advanced ws://target.example/wsUse the advanced legacy CLI path with more scanner-side controls.
wshawk-defensiveRun the narrow defensive helper checks that still ship with the project.
cd desktop && npm run smokeRun the Classic Electron + Python sanity check.
cd electron-desktop && npm run test:allRun Electron + Go unit, Go worker, parity, Electron E2E, and authorization checks.
npm run test:authorization-benchmarkScore the 34 secure and deliberately vulnerable authorization scenarios.