Skip to content

maddygoround/secretduty

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

secretduty

✨ A GitHub Action that automatically checks for hardcoded secrets in your code. You can integrate it in your CI/CD pipeline.

Detects

  • Passwords
  • API tokens
  • AWS keys
  • Private keys
  • Hashed credentials
  • Authentication tokens
  • Dangerous functions
  • Sensitive files

Installation

Action

This action fails the build when there is an hardcoded secrets found in your code.

Inputs

severity - Severity to watch out for. The pipeline fails if the action detecs any of severity from the input.

Outputs

result - List of vulnerabilities detetced with there severity.

Example usage

Basic usage

on: [push]

jobs:
  secret-checker:
    runs-on: ubuntu-latest
    name: Vulnerabilities check
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Check for vulnerabilities
        id: checks
        uses: maddygoround/secretduty@v1.3
      - name: Get results of scan
        run: echo "Scan Results - ${{ steps.checks.outputs.result }}"

Example with severity options

on: [push]

jobs:
  secret-checker:
    runs-on: ubuntu-latest
    name: Vulnerabilities check
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Check for vulnerabilities
        id: checks
        uses: maddygoround/secretduty@v1.3
        with:
          severity: "['CRITICAL','MAJOR']"
      - name: Get results of scan
        run: echo "Scan Results - ${{ steps.checks.outputs.result }}"

Input Options

severity

  • CRITICAL
  • MAJOR
  • MINOR
  • BLOCKED

License

The scripts and documentation in this project are released under the MIT License.

About

✨ A GitHub Action that automatically checks for hardcoded secrets in static structured text.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors