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: replace domain in links for documentation #18

Merged
merged 8 commits into from
Apr 25, 2022
Merged
Show file tree
Hide file tree
Changes from 3 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 @@ -3,7 +3,7 @@ name: CI / Automated testing
on:
pull_request:
branches:
- '**'
- "**"

jobs:
build:
Expand All @@ -24,7 +24,7 @@ jobs:
cp README.md release/
cp action.yml release/
cp -R dist/ release/dist/
- name: Start NeuraLegion Scan 🏁
- name: Start Brightsec Scan 🏁
id: scan
uses: NeuraLegion/run-scan@release
with:
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 NeuraLegion
Copyright (c) 2021 Bright Security Inc. All Rights Reserved
denis-novozhilov-neuralegion marked this conversation as resolved.
Show resolved Hide resolved

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Poll Results of a NeuraLegion Scan
# Poll Results of a Brightsec Scan

This action polls a NeuraLegion scan until it returns a detected issue, or its time runs out.
This action polls a Brightsec scan until it returns a detected issue, or its time runs out.

### Build Secure Apps & APIs. Fast.

[NeuraLegion](https://www.neuralegion.com) is a powerful dynamic application & API security testing (DAST) platform that security teams trust and developers love.
[Brightsec](https://www.brightsec.com) is a powerful dynamic application & API security testing (DAST) platform that security teams trust and developers love.
denis-novozhilov-neuralegion marked this conversation as resolved.
Show resolved Hide resolved

### 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

NeuraLegion works with your existing CI/CD pipelines – trigger scans on every commit, pull request or build with unit testing.
Brightsec works with your existing CI/CD pipelines – trigger scans on every commit, pull request or build with unit testing.
denis-novozhilov-neuralegion marked this conversation as resolved.
Show resolved Hide resolved

### Spin-Up, Configure and Control Scans with Code

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

### No False Positives

Stop chasing ghosts and wasting time. NeuraLegion doesn’t return false positives, so you can focus on releasing code.
Stop chasing ghosts and wasting time. Brightsec doesn’t return false positives, so you can focus on releasing code.
denis-novozhilov-neuralegion marked this conversation as resolved.
Show resolved Hide resolved

### Comprehensive Security Testing

NeuraLegion tests for all common vulnerabilities, such as SQL injection, CSRF, XSS, and XXE -- as well as uncommon vulnerabilities, such as business logic vulnerabilities.
Brightsec 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 NeuraLegion’s:
* [Website](https://www.neuralegion.com/)
* [Knowledge base](https://docs.neuralegion.com/docs/quickstart)
More information is available on Brightsec’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 NeuraLegion API authorization token (key). You can generate it in the **Organization** section on [app.neuralegion.com](https://app.neuralegion.com/login). Find more information [here](https://docs.neuralegion.com/docs/manage-your-organization#manage-organization-apicli-authentication-tokens).
**Required**. Your Brightsec 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 }}`

### `scan`

**Required**. ID of an existing scan to be restarted. You can get the scan ID in the Scans section on [app.neuralegion.com](https://app.neuralegion.com/login).
**Required**. ID of an existing scan to be restarted. You can get the scan ID in the Scans section in [the Bright app](https://app.brightsec.com/login).

_Example:_ `scan: ${{ steps.start.outputs.id }}`

Expand Down Expand Up @@ -83,9 +83,9 @@ URL of the resulting scan.
```yml
start_and_wait_scan:
runs-on: ubuntu-latest
name: A job to run a NeuraLegion scan
name: A job to run a Brightsec scan
steps:
- name: Start NeuraLegion Scan 🏁
- name: Start Brightsec Scan 🏁
id: start
uses: NeuraLegion/run-scan@master
with:
Expand Down
28 changes: 14 additions & 14 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,45 +1,45 @@
name: NeuraLegion Wait for Issues
description: 'Run a NeuraLegion scan right in GitHub Action'
name: Brightsec Wait for Issues
description: "Run a Brightsec scan right in GitHub Action"
branding:
icon: clock
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"
required: true
scan:
description: 'Scan ID to wait for'
description: "Scan ID to wait for"
required: true
hostname:
description: 'Hostname. Default is app.neuralegion.com'
description: "Hostname. Default is app.brightsec.com"
required: false
wait_for:
description: 'Wait for first issue: *any*, *medium*, *high*'
description: "Wait for first issue: *any*, *medium*, *high*"
required: true
timeout:
description: 'Time in seconds for the action to wait for issues'
description: "Time in seconds for the action to wait for issues"
required: false
default: 600
code_scanning_alerts:
description: 'If `true`, upload a Code Scanning Alert in GitHub if scan find a first issue'
description: "If `true`, upload a Code Scanning Alert in GitHub if scan find a first issue"
required: false
default: false
github_token:
description: 'The GitHub Token for uploading Code Scanning report. Required if `codeScanningAlerts` is enabled'
description: "The GitHub Token for uploading Code Scanning report. Required if `codeScanningAlerts` is enabled"
required: false
default: ${{ github.token }}
ref:
description: 'The branch or tag ref that triggered the workflow. For example, `refs/heads/feature-branch-1`'
description: "The branch or tag ref that triggered the workflow. For example, `refs/heads/feature-branch-1`"
required: false
default: ${{ github.ref }}
commit_sha:
description: 'The commit SHA that triggered the workflow. For example, `ffac537e6cbbf934b08745a378932722df287a53`'
description: "The commit SHA that triggered the workflow. For example, `ffac537e6cbbf934b08745a378932722df287a53`"
required: false
default: ${{ github.sha }}

outputs:
url:
description: 'Url of the resulting scan'
description: "Url of the resulting scan"
runs:
using: 'node12'
main: 'dist/index.js'
using: "node12"
main: "dist/index.js"
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "wait-for",
"version": "0.1.0",
"description": "This action polls a NeuraLegion scan until it returns a detected issue, or its time runs out.",
"description": "This action polls a Brightsec scan until it returns a detected issue, or its time runs out.",
"main": "index.js",
"scripts": {
"build": "tsc",
Expand Down
4 changes: 2 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const interval = 20000;
const timeout = 1000 * Number(core.getInput('timeout'));

const baseUrl = (
hostname ? `https://${hostname}` : 'https://app.neuralegion.com'
hostname ? `https://${hostname}` : 'https://app.brightsec.com'
).replace(/\/$/, '');

axiosRetry(axios, { retries: 3 });
Expand Down Expand Up @@ -176,7 +176,7 @@ const uploadSarif = async (params: {
sarif,
ref: params.ref,
commit_sha: params.commitSha,
tool_name: 'NeuraLegion’s DAST',
tool_name: 'Brightsec’s DAST',
checkout_uri: pathToFileURL(process.cwd()).toString()
},
{
Expand Down