Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
shield

GitHub Action

Trufflehog Actions Scan

v0.9c-beta

Trufflehog Actions Scan

shield

Trufflehog Actions Scan

Scan repository for secrets with basic trufflehog defaults in place for easy setup

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Trufflehog Actions Scan

uses: edplato/[email protected]

Learn more about this action in edplato/trufflehog-actions-scan

Choose a version

Trufflehog Actions Scan 🐽🔑

Scan repository for secrets with basic trufflehog defaults in place for easy setup.

Usage

workflow "Detect Secrets" {
  on = "push"
  resolves = ["edplato/trufflehog-actions-scan"]
}

action "edplato/trufflehog-actions-scan" {
  uses = "edplato/trufflehog-actions-scan@master"
}

Default trufflehog options for this tool include:

  • regex : Enable high signal regex checks

  • entropy disabled: Disabled entropy checks

  • max depth is 50: The max commit depth to go back when searching for secrets

Edit your corresponding actions yml file or create a new one.

Basic

steps:
- uses: actions/checkout@master
- name: trufflehog-actions-scan
    uses: edplato/trufflehog-actions-scan@master

Custom Arguments

steps:
- uses: actions/checkout@master
- name: trufflehog-actions-scan
  uses: edplato/trufflehog-actions-scan@master
    with:
  args:
    - "--regex --entropy=False --max_depth=5" # Add custom options here*

*if custom options argument string is used, it will overwrite default settings


MIT License