Secret Scanning Tools

ℹ️ This is an unofficial tool created by Field Security Services, and is not officially supported by GitHub.

This is a testing suite for GitHub Secret Scanning Custom Patterns.

It can be used in combination with GitHub Actions to test custom patterns before they are deployed.

An example repository that uses this Action is advanced-security/secret-scanning-custom-patterns.

A sample custom patterns config file compatible with this tool suite is provided in examples/config/patterns.yml.

Usage in Actions

- name: Secret Scanning Test Suite
  uses: advanced-security/secret-scanning-tools@v1

Advanced Configuration

- name: Secret Scanning Test Suite
  uses: advanced-security/secret-scanning-tools@v1
  with:
    # Modes to run
    # > 'validate' (default), 'all', 'snapshot', 'markdown'
    mode: 'validate'

Using GitHub App Token

- name: Get Token
  id: get_workflow_token
  uses: peter-murray/workflow-application-token-action@v1
  with:
    application_id: ${{ secrets.ADVANCED_SECURITY_APP_ID }}
    application_private_key: ${{ secrets.ADVANCED_SECURITY_APP_KEY }}

- name: Secret Scanning Test Suite
  uses: advanced-security/secret-scanning-tools@v1
  with:
    token: ${{ steps.get_workflow_token.outputs.token }}

Using in Enterprise Server or with self-hosted Actions runners

The Action will set up Python on GitHub Hosted runners or on runners with a configured tool cache.

If you are using a self-hosted runner, or Enterprise Server, and you have not set up the tool cache, you will need to set up Python yourself (version 3.9+)

You can do that in the workflow, or by installing it permanently into your runner's image and including it in the path of the Actions runner.

Defining expected results for online testing

Create a snapshot of the results of a pattern by running the action with snapshot.

This is checked in the validate mode, to check for changes in the results of the pattern. Check that these changes are expected, and if so, update the snapshot, or fix the pattern, as necessary.

ℹ️ the earliest commit that a secret has been found at is reported by secret scanning, so it is not possible to cleanly define a current state of expected secrets in the repository, and test for those expected results. Instead, we use this overall snapshot approach.

In contrast, offline testing, below can be used to test for expected results, since it can be run on a single commit of a repository.

Using locally with pipenv

Install the requirements using pipenv install, then run pipenv run <command> to run the commands: markdown, validate, snapshot.

See this sample script for how to update the README.md files for your custom patterns.

Offline testing of Secret Scanning custom patterns

We have a test Python script, secretscanning/test.py that uses Intel's hyperscan to test custom GitHub Advanced Security Secret Scanning patterns.

This is useful for thorough testing of patterns before they are deployed, whereas the rest of the test suite is primarily designed to be run in GitHub Actions for testing in CI.

Local test script usage

Change directory to secretscanning.

First run make requirements to install required dependencies.

./test.py

By default it searches the directory above the testing directory for pattern.yml files, and tests those patterns on the same directory that file was found in.

or

./test.py --tests <directory>

For full usage use ./test.py --help

Local test script requirements

This only works on Intel-compatible platforms, since hyperscan is an Intel application and written to use Intel-specific instructions.

The packages can be installed using make requirements on Ubuntu-compatible platforms. On other platforms, install the following dependencies:

• Python 3.9+
• Python packages (listed in requirements.txt)
  • hyperscan
  • python-pcre (requires libpcre3)
  • pygit2
  • GitPython

Development notes

Please run make lint after any changes

License

This project is licensed under the terms of the MIT open source license. Please refer to the LICENSE for the full terms.

Maintainers

See CODEOWNERS for the list of maintainers.

Support

ℹ️ This is an unofficial tool created by Field Security Services, and is not officially supported by GitHub.

See the SUPPORT file.

Background

See the CHANGELOG, CONTRIBUTING, SECURITY, SUPPORT, CODE OF CONDUCT and PRIVACY files for more information.