afc163/gitleaks

.gitleaks.toml rules

Gitleaks Rules

custom rules

Usage

create a github action for your repo in .github/workflows/.gitleaks.yml

Use Default Rules

name: gitleaks

on: [push,pull_request]

jobs:
  gitleaks:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
      with:
        fetch-depth: '1'
    - name: wget
      uses: wei/wget@v1
      with:
        args: -O .gitleaks.toml https://raw.githubusercontent.com/ycjcl868/gitleaks/master/.gitleaks.toml
    - name: gitleaks-action
      uses: zricethezav/gitleaks-action@master

About fetch-depth:

• using a fetch-depth of '0' clones the entire history.
• If you want to do a more efficient clone, use '2', but that is not guaranteed to work with pull requests.

Using your own configuration

create a .gitleaks.toml in the root of your repo directory.

name: gitleaks

on: [push,pull_request]

jobs:
  gitleaks:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
      with:
        fetch-depth: '1'
    - name: gitleaks-action
      uses: zricethezav/gitleaks-action@master

Contributing

add rules in .gitleaks.toml and add test cases in package-lock.json.

The content of package-lock.json:

{
  // This is description in .gitleaks.toml
  "Github Token": {
    // testCase String <=> expectValue
    "a3k2k3k3k3k3k3k3k3k3k3k3k33232k12ksk": true,
    "a3k2k3k3k3k3k3k3k3k3k3k3k3k12k1": false
  }
}