┌─○───┐
│ │╲ │
│ │ ○ │
│ ○ ┌─┴───────────────────┐
└─░─┤ 4 github actions │
└─────────────────────┘
Gitleaks is a SAST tool for detecting and preventing hardcoded secrets like passwords, API keys, and tokens in git repos. Gitleaks is an easy-to-use, all-in-one solution for detecting secrets, past or present, in your code. Enable Gitleaks-Action in your GitHub workflows to be alerted when secrets are leaked as soon as they happen. Check out our demos here (.gif) and here (.png), or see what's new in v2 here. Don't forget to check out our blog, which details how to configure and set up Gitleaks-Action for organizations and enterprises.
name: gitleaks
on:
pull_request:
push:
workflow_dispatch:
schedule:
- cron: "0 4 * * *" # run once a day at 4 AM
jobs:
scan:
name: gitleaks
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: gitleaks/gitleaks-action@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE}} # Only required for Organizations, not personal accounts.GITHUB_TOKEN: This variable is automatically assigned by GitHub when any action gets kicked off. You can read more about the token here. gitleaks-action uses this token to call a GitHub API to comment on PRs.GITLEAKS_LICENSE(required for organizations, not required for user accounts): A gitleaks-action license can be obtained at gitleaks.io. It should be added as an encrypted secret to the repo or to the organization.GITLEAKS_NOTIFY_USER_LIST(optional): A list of GitHub accounts that should be alerted when gitleaks-action detects a leak. An email will be sent by GitHub to the user if their GitHub notification settings permit it. The format should be comma-separated with each username prefixed with@. Ex:@octocat,@zricethezav,@gitleaks. Spaces are okay too.GITLEAKS_ENABLE_COMMENTS(optional): Boolean value that turns on or off PR commenting. Default value istrue. Set tofalseto disable comments.GITLEAKS_CONFIG(optional): Path to a gitleaks configuration file.GITLEAKS_ENABLE_UPLOAD_ARTIFACT(optional): Boolean value that turns on or off uploading a sarif artifact when gitleaks detects secrets. Defaults totrue.GITLEAKS_ENABLE_SUMMARY(optional): Boolean value to enable or disable gitleaks job summary. Defaults totrue.
If you are scanning repos that belong to an organization account, you will need to obtain a license key. You can obtain a free "Trial" license key for scanning unlimited repos for up to 2 weeks. Scanning repos after the trial license has expired requires a paid license.
If you are scanning repos that belong to a personal account, then no license key is required.
You can visit gitleaks.io to sign up for a free trial license key for unlimited repo scanning for up to 2 weeks, or choose from a paid tier to enable scanning after the trial license has expired.
You can! This GitHub Action follows a similar order of precedence
as the gitleaks CLI tool. You can use GITLEAKS_CONFIG to explicitly set a
config path or create a gitleaks.toml at the root of the repo which will be
automatically detected and used by gitleaks-action.
The only data that gitleaks-action sends to any third party is data related to license key validation (namely GITLEAKS_LICENSE, repo name, and repo owner), which is sent to the license key validation service, keygen. Your code never leaves GitHub because the scanning takes place within the GitHub Actions docker container.
Can I use gitleaks-action as a third-party tool for GitHub code scanning?
You can but it is not recommended because it gives a false sense of security. If a secret is leaked in one commit, then removed in a subsequent commit, the security alert in the GitHub Security dashboard will show as resolved, even though the secret is still visible in the commit history. To truly address the leak, you should rotate the secret (and also consider re-writing the git history to remove the leak altogether).
6/21/2022
On June 21, 2022, we merged Gitleaks Action v2 into the master branch. This was a breaking update, and we made an effort to contact as many of our users as possible via GitHub, social media, etc. If you didn't know this breaking update was coming, we sincerely apologize for the inconvenience. The good news is, remedying the job failure is straightforward! You can either:
Please note that if you are scanning repos that belong to an organization, you'll have to acquire a GITLEAKS_LICENSE to use v2 (free "Trial" license available). That might come as a surprise to my users that are accustomed to using Gitleaks-Action free of charge, so I wrote a blog post explaining how/why I decided to monetize this project: https://blog.gitleaks.io/gitleaks-llc-announcement-d7d06a52e801
Finally, please see above for a summary of why I think you'll love the new v2 release: v2 Benefits
Enable this gitleaks-action and copy
<img alt="gitleaks badge" src="https://img.shields.io/badge/protected%20by-gitleaks-blue"> to your readme.
If you are scanning repos that belong to a personal account, then no license key is required. You can use it for free!
If your organization needs a secret scanner, you still have a few options:
- First, we do recommend writing up a brief justification for the powers-that-be at your organization, asking them to allocate budget for secret scanning. If you need help writing something up, contact us via our website: https://gitleaks.io/index.html
- You can encourage your developers to run the gitleaks core tool as a pre-commit hook (https://github.com/zricethezav/gitleaks#pre-commit). In fact, we encourage everyone to do this anyway, even if they are also running Gitleaks-Action v2.
- You can always pin your Gitleaks-Action yml to the last free version of Gitleaks-Action (v1.6.0). See here: How to pin to v1.6.0
Caveat: There are some known issues with that version, and it's no longer receiving updates. But it's better than nothing.
Since v2.0.0 of Gitleaks-Action, the license has changed from MIT to a commercial license. Prior versions to v2.0.0 of Gitleaks-Actions will remain under the MIT license.
Copyright © 2022 Gitleaks LLC - All Rights Reserved