Skip to content

Commit

Permalink
Deploying to release from @ 39998ec 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
rielas committed May 5, 2020
1 parent 1992f5e commit 31e4b6a
Show file tree
Hide file tree
Showing 3 changed files with 2,687 additions and 0 deletions.
80 changes: 80 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Nexploit Scan Runner

This action runs a new scan in Nexploit, or reruns an existing one.

## Inputs

### `api_token`

**Required** Api Token. You can generate it in *Organization* section

### `restart_scan`

Scan ID to restart.

### `file_id`

HAR-file ID.

### `discovery_types`

Array of discovery types. Can be: archive, crawler, oas.

Example:

```yml
discovery_types: |
[ "crawler", "archive" ]
```
### `crawler_urls`

Crawler URLs

Example:

```yml
crawler_urls: |
[ "http://vulnerable-bank.com" ]
```

### `module`

Possible values: *core*, *exploratory*

### `hosts_filter`

Hosts filter

### `name`

Scan name.

Example: ```name: GitHub scan ${{ github.sha }}```

## Outputs

### `url`

Url of the resulting scan

## Example usage

```yml
steps:
- name: Start Nexploit Scan
id: start
uses: NeuraLegion/[email protected]
with:
api_token: ${{ secrets.NEXPLOIT_TOKEN }}
name: GitHub scan ${{ github.sha }}
discovery_types: |
[ "crawler", "archive" ]
crawler_urls: |
[ "http://vulnerable-bank.com" ]
file_id: LiYknMYSdbSZbqgMaC9Sj
hosts_filter: |
[ ]
- name: Get the output scan url
run: echo "The scan was started on ${{ steps.start.outputs.url }}"
```
41 changes: 41 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: 'Nexploit Scan'
description: 'Run a Nexploit scan right in GitHub Action'
branding:
icon: 'upload-cloud'
color: 'blue'
inputs:
api_token:
description: 'Api Token. You can generate it in Organization section'
required: true
restart_scan:
description: 'Scan ID to restart'
required: false
hostname:
description: 'Hostname. Default is nexploit.app'
required: false
file_id:
description: 'HAR-file ID'
required: false
discovery_types:
description: 'Array of discovery types. Can be: archive, crawler, oas'
required: false
crawler_urls:
description: 'Crawler URLs'
required: false
module:
description: 'Possible values: *core*, *exploratory*'
required: false
hosts_filter:
description: 'Hosts filter'
required: false
name:
description: 'Scan Name'
default: 'GitHub Scan'
required: false

outputs:
url:
description: 'Url of the resulting scan'
runs:
using: 'node12'
main: 'dist/index.js'
Loading

0 comments on commit 31e4b6a

Please sign in to comment.