Pillage filesystems for sensitive information with Go.
Pillager is designed to provide a simple means of leveraging Go's strong concurrency model to recursively search directories for sensitive information in files. Pillager does this by standing on the shoulders of a few giants. Once pillager finds files that match the specified pattern, the file is scanned using a series of concurrent workers that each take a line of the file from the job queue and hunt for sensitive pattern matches. The available pattern filters can be defined in a pillager.toml file or you can use the default ruleset.
If you have Go setup on your system, you can install Pillager with go install
go install github.com/brittonhayes/pillager@latestscoop bucket add pillager https://github.com/brittonhayes/pillager-scoop.git
scoop install pillagerbrew tap brittonhayes/homebrew-pillager
brew install pillagerdocker run --rm -it ghcr.io/brittonhayes/pillager:latest hunt .
If you're looking for a binary, check the latest releases for the executable that matches your system
To see all the commands available with pillager
# To see instructions for the entire application
pillager
# From any subcommand
pillager [cmd] --helpPillager provides a terminal user interface built with bubbletea if you'd like to scan for secrets interactively.
Pillager provides full support for Gitleaks1 rules. This can either be passed in with a rules2 section in your pillager.toml file, or you can use the default ruleset by leaving the config flag blank.
# pillager.toml
# Basic configuration
verbose = false
path = "."
workers = 4
redact = true
reporter = "json-pretty"
# Rules for secret detection
[[rules]]
description = "AWS Access Key"
id = "aws-access-key"
regex = '''(A3T[A-Z0-9]|AKIA|AGPA|AIDA|AROA|AIPA|ANPA|ANVA|ASIA)[A-Z0-9]{16}'''
tags = ["aws", "credentials"]
[[rules]]
description = "AWS Secret Key"
id = "aws-secret-key"
regex = '''(?i)aws(.{0,20})?(?-i)['\"][0-9a-zA-Z\/+]{40}['\"]'''
tags = ["aws", "credentials"]
[[rules]]
description = "GitHub Token"
id = "github-token"
regex = '''ghp_[0-9a-zA-Z]{36}'''
tags = ["github", "token"]
[[rules]]
description = "Private Key"
id = "private-key"
regex = '''-----BEGIN (?:RSA|OPENSSH|DSA|EC|PGP) PRIVATE KEY( BLOCK)?-----'''
tags = ["key", "private"]
# Allowlist configuration
[allowlist]
paths = [
".*/_test\\.go$",
".*/testdata/.*",
".*\\.md$",
".*/vendor/.*"
]
regexes = [
"EXAMPLE_KEY",
"DUMMY_SECRET"
] Pillager has a series of built-in output formats available. Pick your flavor!
pillager hunt .pillager hunt ./example -f json | jqJSON output is designed to work seamlessly with the amazing jq utility for easy parsing.
Click to view more output formats
pillager hunt . -f yamlpillager hunt . -f json-prettypillager hunt . -f html > results.htmlpillager hunt . -f html-table > results.htmlpillager hunt . -f markdown > results.mdpillager hunt . -f table > results.mdpillager hunt . --template "{{ range .}}Secret: {{.Secret}}{{end}}"pillager hunt . -t "$(cat internal/templates/simple.tmpl)"Pillager allows you to use powerful go text/template and sprig functions to customize the output format. Here are a few template examples.
{{ range . -}}
File: {{ .File }}
Secret: {{ .Secret}}
Description: {{ quote .Description }}
{{ end -}}
# Results
{{ range . -}}
## {{ .File }}
- Location: {{.StartLine}}
{{end}}
More template examples can be found in the templates directory.
GoDoc documentation is available on pkg.go.dev for pillager.
To get involved developing features and fixes for Pillager, get started with the following:
- Install Go
- Install Taskfile.dev
- Read the CONTRIBUTING.MD
What is Cobra?
Cobra is a library providing a simple interface to create powerful modern CLI interfaces similar to git & go tools. Cobra is also an application that will generate your application scaffolding to rapidly develop a Cobra-based application.
If you've seen a CLI written in Go before, there's a pretty high chance it was built with Cobra. I can't recommend this
library enough. It empowers developers to make consistent, dynamic, and self-documenting command line tools with ease.
Some examples include kubectl, hugo, and Github's gh CLI.
What is Gitleaks?
Gitleaks1 is a SAST tool for detecting hardcoded secrets like passwords, api keys, and tokens in git repos.
Gitleaks is an amazing tool for secret leak prevention. If you haven't implemented Gitleaks as a pre-commit checker, it's worth your time to check it out.
Why is Gitleaks relevant to Pillager?
Pillager implements the powerful rules functionality of Gitleaks while taking a different approach to presenting and handling the secrets found. While I have provided a baseline set of default rules, Pillager becomes much more powerful if you allow users to create rules for their own use-cases.
Check out the included rules2 for a baseline ruleset.
This goes without saying but I'm going to say it anyways: I am not responsible for any repercussions caused by your use of pillager. This tool is intended for defensive use, educational use, and security researcher use with the consent of all involved parties. Malicious behavior with pillager is in no way condoned, nor encouraged. Please use this tool responsibly and ensure you have permission to scan for secrets on any systems before doing so.
At it's core, Pillager is designed to assist you in determining if a system is affected by common sources of credential leakage as documented by the MITRE ATT&CK3 framework.
MITRE ATT&CK Technique - T1552,003 - Unsecured Credentials: Bash History
MITRE ATT&CK Technique - T1552,001 - Unsecured Credentials: Credentials In Files