SOOS is an independent software security company, located in Winooski, VT USA, building security software for your team. SOOS, Software security, simplified.
Use SOOS to scan your software for vulnerabilities and open source license issues with SOOS Core SCA. Generate and ingest SBOMs. Export reports to industry standards. Govern your open source dependencies. Run the SOOS DAST vulnerability scanner against your web apps or APIs. Scan your Docker containers for vulnerabilities. Check your source code for issues with SAST Analysis.
Demo SOOS or Register for a Free Trial.
If you maintain an Open Source project, sign up for the Free as in Beer SOOS Community Edition.
You can use the Action as follows:
- Update the
.github/workflows/main.yml
file to include a step like this
on: [push]
jobs:
soos_sast_analysis_example:
name: SOOS SAST Analysis Example
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Run SOOS SAST Analysis
uses: soos-io/soos-sast-github-action@v1.0.0
with:
client_id: ${{ secrets.SOOS_CLIENT_ID }}
api_key: ${{ secrets.SOOS_API_KEY }}
project_name: "My Project Name"
source_code_path: "The path to start searching for SAST files."
Property | Default | Description |
---|---|---|
api_key | [none] | The API Key provided to you when subscribing to SOOS services. |
api_url | [none] | The API BASE URI provided to you when subscribing to SOOS services. (Internal Use Only) |
branch_name | [none] | Branch Name to create scan under. |
branch_uri | [none] | URI to branch from SCM system. |
build_uri | [none] | URI to CI build info. |
build_version | [none] | Version of application build artifacts. |
client_id | [none] | The Client Id provided to you when subscribing to SOOS services. |
directories_to_exclude | [none] | Listing of directories or patterns to exclude from the search for SAST files. eg: bin/start/, /start/ |
files_to_exclude | [none] | Listing of files or patterns patterns to exclude from the search for SAST files. eg: /sa.sarif.json/, **/sast.sarif.json |
log_level | 'INFO' | Log level to show: DEBUG, INFO, WARN, FAIL, ERROR. |
on_failure | continue_on_failure | Set the On Failure Scan Strategy: fail_the_build, and continue_on_failure |
operating_environment | ${{ runner.os }} | System info regarding operating system, etc. |
project_name | ${{ github.repository }} | The project name that will be displayed on the dashboard. By Default is owner/repository_name. |
source_code_path | ${{ github.workspace }} | The path to start searching for SAST files. |