Skip to content

Commit bfc6e05

Browse files
authored
Merge pull request #202 from esarafianou/victimEndpointArch
Add /victim API endpoint in arch
2 parents c14a355 + 48622b5 commit bfc6e05

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

etc/spec/ARCHITECTURE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,3 +412,25 @@ If *success* is *True*, this indicates that the series of indicated requests
412412
were performed by the victim correctly. Otherwise, the victim failed to perform
413413
the required requests due to a network error or a timeout and the work has to
414414
be redone.
415+
416+
The backend also exposes a RESTful API via HTTP to which the the Web UI
417+
makes requests for work. This API is explained below.
418+
419+
## webUI <-> backend(HTTP)
420+
421+
The backend implements various API endpoints for communication with the
422+
Web UI.
423+
424+
### `/victim`
425+
426+
HTTP POST endpoint.
427+
428+
Creates a new victim.
429+
430+
Arguments:
431+
432+
- IP: IP address
433+
- target: string
434+
435+
Returns HTTP `200` with a JSON that has a field *victimid*, which contains the
436+
ID of the new victim.

0 commit comments

Comments
 (0)