Skip to content

Commit

Permalink
feat(bus): notify the user on status changes (#89)
Browse files Browse the repository at this point in the history
BREAKING CHANGES:

- **repeater**: `agent` option and `REPEATER_AGENT` environment variable have been deprecated, please instead use `id` or `REPEATER_ID` accordingly.

  Before:

  ```bash
  docker run neuralegion/repeater \
    -e 'REPEATER_TOKEN=my-api-tey' \
    -e 'REPEATER_AGENT=my-agent-id'
  ```

  After:

  ```bash
  docker run neuralegion/repeater \
    -e 'REPEATER_TOKEN=my-api-tey' \
    -e 'REPEATER_ID=my-repeater-id'
  ```

- **scan:run**: `agent` option has been deprecated, please instead use `repeater`.

  Before:

  ```bash
  nexploit-cli scan:run \
      --name scan-name \
      --archive received-archive-id \
      --agent my-agent-id
      --token my-api-token
  ```

  After:

  ```bash
  nexploit-cli scan:run \
      --name scan-name \
      --archive received-archive-id \
      --repeater my-repeater-id
      --token my-api-token
  ```

closes #88
  • Loading branch information
derevnjuk authored Sep 21, 2020
1 parent 1c60ba3 commit f697ed9
Show file tree
Hide file tree
Showing 11 changed files with 853 additions and 409 deletions.
12 changes: 6 additions & 6 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,12 @@
"avoidEscape": true
}
],
"@typescript-eslint/no-shadow": [
"error",
{
"hoist": "all"
}
],
"@typescript-eslint/typedef": [
"error",
{
Expand Down Expand Up @@ -170,12 +176,6 @@
"no-eval": "error",
"no-new-wrappers": "error",
"no-restricted-syntax": ["error", "ForInStatement"],
"no-shadow": [
"error",
{
"hoist": "all"
}
],
"no-throw-literal": "error",
"no-undef-init": "error",
"object-shorthand": "error",
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
Before you can use **NexPloit CLI** make sure you have the following:
- An active user on www.nexploit.app
- A valid `TOKEN`
- For the quick start these scopes are required: `agents:write:repeater`, `scans:run` and `scans:read`
- For the quick start these scopes are required: `repeaters:write`, `scans:run` and `scans:read`
- More info about [setting up an API key](https://kb.neuralegion.com/#/user-guide/organization-administration/details-and-policies#managing-organization-api-keys)
- An active `AGENT_ID`
- More info about [Setting up a New Agent](https://kb.neuralegion.com/#/user-guide/agents/overview.md)
- An active `ID`
- More info about [Setting up a New Repeater](https://kb.neuralegion.com/#/user-guide/agents/overview.md)

#### 1. Install NexPloit CLI globally
```bash
Expand All @@ -37,15 +37,15 @@ This will show you a list of possible commands for NexPloit CLI, for a full list
```bash
nexploit-cli repeater \
--token {TOKEN} \
--agent {AGENT_ID} \
--id {ID} \
--bus amqps://amq.nexploit.app:5672
```

#### 3. Start a new scan with a Crawler
```bash
nexploit-cli scan:run \
--token {TOKEN} \
--agent {AGENT_ID} \
--repeater {ID} \
--name "My First Scan" \
--crawler https://www.example.com \
--smart
Expand Down
Loading

0 comments on commit f697ed9

Please sign in to comment.