Skip to content

ThreatWorx discovery CLI twigs

Actions
This action will run ThreatWorx s based discovery CLI - twigs
v1.0.2
Latest
Star (0)

ThreatWorx GitHub Actions

A set of GitHub Action for using ThreatWorx twigs CLI to check for vulnerabilities in your GitHub projects. Following actions that are currently available:

The Install twigs action is a pre-requisite for any workflow that needs to run the twigs CLI. Also these actions require Here's an example of a workflow that uses these actions to scan a Github repository:

name: Example workflow using ThreatWorx Github Actions
on: push
jobs:
  security:
    runs-on: ubuntu-latest
    steps:
      - name: checkout repo content
        uses: actions/checkout@v2 # checkout the repository content to github runner
          
      - name: Install ThreatWorx discovery CLI twigs
        uses: threatworx/actions/install-twigs@master

      - name: Run ThreatWorx discovery CLI twigs
        uses: threatworx/actions/repo-scan@master
        env: 
          TW_HANDLE: ${{ secrets.TW_HANDLE }}
          TW_INSTANCE: ${{ secrets.TW_INSTANCE }}
          TW_TOKEN: ${{ secrets.TW_TOKEN }}
        with:
          args: -vv
          mode_args: --repo ${{ github.workspace }}

Details on options/arguments available for scanning repositories including, SAST checks, secrets scan, IaC scan etc. are available in the twigs user guide

The example here uses actions/setup-go would you would need to select the right actions to install the relevant development requirements for your project. If you are already using the same pipeline to build and test your application you're likely already doing so.

Getting your ThreatWorx API token

The Actions example above refer to a ThreatWorx API token:

env:
  TW_TOKEN: ${{ secrets.TW_TOKEN }}

You can create an API token through your ThreatWorx account either from your account on ThreatWorx SaaS or by logging in to your dedicated ThreatWorx instance. Follow the Profile -> Key Management menu to generate a token to use in your workflow.

ThreatWorx discovery CLI twigs is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

This action will run ThreatWorx s based discovery CLI - twigs
v1.0.2
Latest

ThreatWorx discovery CLI twigs is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.