https://github.com/neuralegion/stop-scan
Action stops a NeuraLegion scan
https://github.com/neuralegion/stop-scan
github-actions scan security
Last synced: 3 months ago
JSON representation
Action stops a NeuraLegion scan
- Host: GitHub
- URL: https://github.com/neuralegion/stop-scan
- Owner: NeuraLegion
- License: mit
- Created: 2020-05-08T13:51:25.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-25T12:29:17.000Z (over 1 year ago)
- Last Synced: 2025-10-22T07:34:14.794Z (9 months ago)
- Topics: github-actions, scan, security
- Language: JavaScript
- Homepage:
- Size: 586 KB
- Stars: 0
- Watchers: 13
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stop a Bright Scan
This action stops a Bright scan.
### Build Secure Apps & APIs. Fast.
[Bright](https://www.brightsec.com) is a powerful dynamic application & API security testing (DAST) platform that security teams trust and developers love.
### 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
### Seamlessly integrates with the Tools and Workflows You Already Use
Bright works with your existing CI/CD pipelines – trigger scans on every commit, pull request or build with unit testing.
### Spin-Up, Configure and Control Scans with Code
One file. One command. One scan. No UI needed.
### Super-Fast Scans
Interacts with applications and APIs, instead of just crawling them and guessing.
Scans are fast as our AI-powered engine can understand application architecture and generate sophisticated and targeted attacks.
### No False Positives
Stop chasing ghosts and wasting time. Bright doesn’t return false positives, so you can focus on releasing code.
### Comprehensive Security Testing
Bright tests for all common vulnerabilities, such as SQL injection, CSRF, XSS, and XXE -- as well as uncommon vulnerabilities, such as business logic vulnerabilities.
More information is available on Bright’s:
* [Website](https://www.brightsec.com/)
* [Knowledge base](https://docs.brightsec.com/docs/quickstart)
* [YouTube channel](https://www.youtube.com/channel/UCoIC0T1pmozq3eKLsUR2uUw)
* [GitHub Actions](https://github.com/marketplace?query=neuralegion+)
# Inputs
### `api_token`
**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.BRIGHTSEC_TOKEN }}`
### `scan`
**Required**. Scan ID to stop.
_Example:_ `scan: ${{ steps.start.outputs.id }}`
## Usage Example
### Stop a previously started scan
```yml
start_and_stop_scan:
runs-on: ubuntu-latest
name: A job to run a Bright scan
steps:
- name: 🏁 Start Bright Scan
id: start
uses: NeuraLegion/run-scan@v1.1
with:
api_token: ${{ secrets.BRIGHTSEC_TOKEN }}
name: GitHub scan ${{ github.sha }}
discovery_types: |
[ "crawler", "archive" ]
crawler_urls: |
[ "https://juice-shop.herokuapp.com" ]
file_id: LiYknMYSdbSZbqgMaC9Sj
hosts_filter: |
[ ]
wait_for: on_high
- name: Get the output scan url
run: echo "The scan was started on ${{ steps.start.outputs.url }}"
- name: ⏳ Wait for any issues
id: wait
uses: NeuraLegion/wait-for@v1.1
with:
api_token: ${{ secrets.BRIGHTEC_TOKEN }}
scan: ${{ steps.start.outputs.id }}
wait_for: any
timeout: 100
- name: 🛑 Stop the scan
if: ${{ always() }}
id: stop
uses: NeuraLegion/stop-scan@v1.1
with:
api_token: ${{ secrets.BRIGHTSEC_TOKEN }}
scan: ${{ steps.start.outputs.id }}
```