Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/padok-team/git-secret-scanner
Find secrets in git repositories with TruffleHog & Gitleaks
https://github.com/padok-team/git-secret-scanner
auditing credentials git scan secrets security
Last synced: 26 days ago
JSON representation
Find secrets in git repositories with TruffleHog & Gitleaks
- Host: GitHub
- URL: https://github.com/padok-team/git-secret-scanner
- Owner: padok-team
- License: apache-2.0
- Created: 2023-05-31T13:18:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:03:42.000Z (about 2 months ago)
- Last Synced: 2024-10-29T09:49:45.735Z (about 2 months ago)
- Topics: auditing, credentials, git, scan, secrets, security
- Language: Go
- Homepage:
- Size: 180 KB
- Stars: 35
- Watchers: 2
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# git-secret-scanner
This tool aims to find secrets and credentials in git repositories owned by Organizations or Groups using the libraries [TruffleHog](https://trufflesecurity.com/) & [Gitleaks](https://gitleaks.io/).
> **Warning**
>
> This tool is only designed for Linux and MacOS.
> The current version only supports Gitlab and GitHub.
## Why this tool?
Trufflehog and Gitleaks are already designed to find secrets in git repositories. So you may wonder *"what is the purpose of a tool combining both scanners?"*
These two tools have both their own strenghts and weaknesses:
- TruffleHog is very effective at classifying different secrets, but cannot find them all. It relies on detectors that can easily detect specific types of secrets, but not general secrets or general API keys.
- Gitleaks is able to find many more secrets, but is not as good as Trufflehog at classification. It contains fewer detectors and relies on string entropy to detect potential secrets that are not found by its detectors.
We designed this tool to combine the strenghts of both previous tools in order to find as many secrets as possible and to have an efficient classification of these secrets.
## Requirements
`git-secret-scanner` requires the following tools to work:
- [git](https://git-scm.com/book/fr/v2/D%C3%A9marrage-rapide-Installation-de-Git)
- [TruffleHog](https://github.com/trufflesecurity/trufflehog) (>= 3.82.13)
- [Gitleaks](https://github.com/gitleaks/gitleaks) (>= 8.21.1)
You can easily check that all requirements are met with the commands below:
```shell
git --version
trufflehog --version
gitleaks version
```
## Installation
### Using `homebrew`
The simplest way to install `git-secret-scanner` is with `homebrew`.
```shell
brew tap padok-team/tap
brew install git-secret-scanner
```
### With Docker
`git-secret-scanner` is prepackaged in a Docker image with all required dependencies.
```shell
# Run GitHub scan
docker run --rm -it \
-e GITHUB_TOKEN=$GITHUB_TOKEN \
-v "$(pwd):/home/git-secret-scanner" \
ghcr.io/padok-team/git-secret-scanner github -o ""
# Run Gitlab scan
docker run --rm -it \
-e GITLAB_TOKEN=$GITLAB_TOKEN \
-v "$(pwd):/home/git-secret-scanner" \
ghcr.io/padok-team/git-secret-scanner gitlab -g ""
```
### With binary
Download the binary for your platform and OS on the [realeases page](https://github.com/zricethezav/gitleaks/releases).
### From source
1. Clone the repository
```shell
git clone https://github.com/padok-team/git-secret-scanner.git
cd git-secret-scanner
```
2. Build the binary
```shell
make build
```
## Usage
To get detailed usage information about how to use this tool, run
```shell
git-secret-scanner --help
```
### Basics
Add a personal access token ([GitHub](https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) / [Gitlab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)) for your git SaaS in your environment variables.
```shell
# GitHub
export GITHUB_TOKEN=""
# Gitlab
export GITLAB_TOKEN=""
```
> GitHub tokens require the `repo` scope, Gitlab tokens require both `read_api` and `read_repository` scopes.
```shell
# With GITHUB_TOKEN set
git-secret-scanner github -o ""
# With GITLAB_TOKEN set
git-secret-scanner gitlab -g ""
```
### Ignore secrets
You can instruct `git-secret-scanner` to ignore some specific secrets in its results. This is useful to ignore false positives or to ignore secrets that have already been dealt with.
#### Ignore secrets with comments
`git-secret-scanner` understands Gitleaks and Trufflehog annotations to ignore secrets (`gitleaks:allow` and `trufflehog:ignore`). You can add a comment with one of these annotations on the line that has the secret to have `git-secret-scanner` ignore it.
#### Ignore secrets with fingerprints
To ignore specific fingerprints, create a file with a list of all secret fingerprints to ignore during the scan. A fingerprint is computed in the following way:
```
:::
```
Then run `git-secret-scanner` with the `-i` flag:
```shell
git-secret-scanner github -o "" -i ""
git-secret-scanner gitlab -g "" -i ""
```
### Baseline
`git-secret-scanner` supports using a previous report as a baseline for a scan. All previous secrets found in the baseline are ignored in the final report. This is useful to detect added secrets between two scans.
```shell
git-secret-scanner github -o "" -b ""
git-secret-scanner gitlab -g "" -b ""
```
## Questions?
Open an issue to contact us or to give us suggestions. We are open to collaboration.
## License
[](https://opensource.org/licenses/Apache-2.0)