https://github.com/workleap/github-secret-finder
https://github.com/workleap/github-secret-finder
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/workleap/github-secret-finder
- Owner: workleap
- License: apache-2.0
- Archived: true
- Created: 2019-10-17T19:25:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-13T20:22:30.000Z (about 5 years ago)
- Last Synced: 2025-03-15T14:03:20.738Z (about 1 year ago)
- Language: Python
- Size: 83 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-secret-finder
Script to monitor commits from Github users and organizations for secrets.
## Setup
```
python3 setup.py install
```
Create a new readonly personal access token here: https://github.com/settings/tokens
## Usage
```
usage: github-secret-finder [-h] [--users USERS] [--user USER] [--emails EMAILS]
[--email EMAIL] [--names NAMES] [--name NAME]
[--organizations ORGANIZATIONS] [--organization ORGANIZATION]
--tokens TOKENS [--blacklist BLACKLIST_FILE]
[--slack-webhook SLACK_WEBHOOK] [--results] [--verbose]
Github Secret Finder
optional arguments:
-h, --help show this help message and exit
--users USERS, -U USERS
File containing Github users to monitor.
--user USER, -u USER Single Github user to monitor.
--emails EMAILS, -E EMAILS
File containing email addresses to monitor.
--email EMAIL, -e EMAIL
Single email address to monitor.
--names NAMES, -N NAMES
File containing full names to monitor.
--name NAME, -n NAME Single full name to monitor.
--organizations ORGANIZATIONS, -O ORGANIZATIONS
File containing organizations to monitor.
--organization ORGANIZATION, -o ORGANIZATION
Single organization to monitor.
--tokens TOKENS, -t TOKENS
Github tokens separated by a comma (,)
--blacklist BLACKLIST_FILE, -B BLACKLIST_FILE
File containing regexes to blacklist file names.
Defaults to default-blacklist.json
--slack-webhook SLACK_WEBHOOK, -w SLACK_WEBHOOK
Slack webhook to send messages when secrets are found.
--results, -r Shows the previously found results.
--verbose, -v Increases output verbosity.
```
## License
Copyright © 2020, GSoft inc. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license [here](https://github.com/gsoft-inc/gsoft-license/blob/master/LICENSE).