Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: delete or change Neuralegion mentioins #32

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ jobs:
cp README.md release/
cp action.yml release/
cp -R dist/ release/dist/
- name: Start NeuraLegion Scan 🏁
- name: Start Bright Scan 🏁
uses: ./release
with:
api_token: ${{ secrets.NEXPLOIT_TOKEN }}
api_token: ${{ secrets.BRIGHT_TOKEN }}
name: GitHub scan ${{ github.sha }}
discovery_types: |
[ "crawler" ]
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This action runs a new security scan in Bright, or reruns an existing one.

### Automatically Tests Every Aspect of Your Apps & APIs

Scans any target, whether Web Apps, APIs (REST. & SOAP, GraphQL & more), Web sockets or mobile, providing actionable reports
Scans any target, whether Web Apps, APIs (REST. & SOAP, GraphQL & more) or mobile, providing actionable reports

### Seamlessly integrates with the Tools and Workflows You Already Use

Expand All @@ -25,7 +25,7 @@ Scans are fast as our AI-powered engine can understand application architecture

### No False Positives

Stop chasing ghosts and wasting time. Bright doesn’t return false positives, so you can focus on releasing code.
Bright keeps false positives to a minimum, letting you focus on real issues and release better code faster.

### Comprehensive Security Testing

Expand All @@ -48,21 +48,21 @@ _Example:_ `name: GitHub scan ${{ github.sha }}`

### `api_token`

**Required**. Your Bright API authorization token (key). You can generate it in the **Organization** section in [the Bright app](https://app.neuralegion.com/login). Find more information [here](https://docs.brightsec.com/docs/manage-your-organization#manage-organization-apicli-authentication-tokens).
**Required**. Your Bright API authorization token (key). You can generate it in the **Organization** section in [the Bright app](https://app.brightsec.com/login). Find more information [here](https://docs.brightsec.com/docs/manage-your-organization#manage-organization-apicli-authentication-tokens).

_Example:_ `api_token: ${{ secrets.NEURALEGION_TOKEN }}`
_Example:_ `api_token: ${{ secrets.BRIGHT_TOKEN }}`

### `restart_scan`

**Required** when restarting an existing scan by its ID. You can get the scan ID in the Scans section in [the Bright app](https://app.neuralegion.com/login).
**Required** when restarting an existing scan using its ID. You can get the scan ID in the Scans section in [the Bright app](https://app.brightsec.com/login).

Please make sure to only use the necessary parameters. Otherwise, you will get a response with the parameter usage requirements.
Please make sure only to use the necessary parameters. Otherwise, you will get a response with the parameter usage requirements.

_Example:_ `restart_scan: ai3LG8DmVn9Rn1YeqCNRGQ)`

### `discovery_types`

**Required**. Array of discovery types. The following types are available:
**Required**. An array of discovery types. The following types are available:

- `archive` - uses an uploaded HAR-file for a scan
- `crawler` - uses a crawler to define the attack surface for a scan
Expand Down Expand Up @@ -135,13 +135,13 @@ _Recommended tests:_

### `file_id`

**Required** if the discovery type is set to `archive` or `oas`. ID of a HAR-file or an OpenAPI schema you want to use for a scan. You can get the ID of an uploaded HAR-file or an OpenAPI schema in the **Storage** section on [app.neuralegion.com](https://app.neuralegion.com/login).
**Required** if the discovery type is set to `archive` or `oas`. ID of a HAR-file or an OpenAPI schema you want to use for a scan. You can get the ID of an uploaded HAR-file or an OpenAPI schema in the **Storage** section on [app.brightsec.com](https://app.brightsec.com/login).

_Example:_

```
FILE_ID=$(nexploit-cli archive:upload \
--token ${{ secrets.NEURALEGION_TOKEN }} \
FILE_ID=$(bright-cli archive:upload \
--token ${{ secrets.BRIGHT_TOKEN }} \
--discard true \
./example.har)
```
Expand Down Expand Up @@ -218,11 +218,11 @@ ID of the created scan. This ID could then be used to restart the scan, or for t

```yaml
steps:
- name: Start NeuraLegion Scan
- name: Start Bright Scan
id: start
uses: NeuraLegion/[email protected]
with:
api_token: ${{ secrets.NEURALEGION_TOKEN }}
api_token: ${{ secrets.BRIGHT_TOKEN }}
name: GitHub scan ${{ github.sha }}
discovery_types: |
[ "crawler", "archive" ]
Expand All @@ -237,11 +237,11 @@ steps:

```yaml
steps:
- name: Start NeuraLegion Scan
- name: Start Bright Scan
id: start
uses: NeuraLegion/[email protected]
with:
api_token: ${{ secrets.NEURALEGION_TOKEN }}
api_token: ${{ secrets.BRIGHT_TOKEN }}
name: GitHub scan ${{ github.sha }}
restart_scan: ai3LG8DmVn9Rn1YeqCNRGQ
- name: Get the output scan url
Expand Down
6 changes: 3 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: 'Run a NeuraLegion Scan'
description: 'Run a NeuraLegion scan right in GitHub Action'
name: 'Run a Bright Scan'
description: 'Run a Bright scan right in GitHub Action'
branding:
icon: 'upload-cloud'
color: 'blue'
inputs:
api_token:
description: 'Api Token. You can generate it in Organization section'
description: 'Api Token. You can generate it in Organization section of the Project settings'
required: true
restart_scan:
description: 'Scan ID to restart'
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "run-scan",
"version": "0.1.0",
"description": "This action runs a new security scan in NeuraLegion, or reruns an existing one.",
"description": "This action runs a new security scan in Bright, or reruns an existing one.",
"main": "index.js",
"scripts": {
"build": "tsc",
Expand Down
Loading