Scan for sensitive information in Github easily and effectively.
The project is based on golang with AdminLTE to build a management system to manage the Github search results. Github API is utilized to scawl the related results according to key words and some rules. It proves to be a proper way to detect the information related to your company.
- go version 1.10+
- the project should be placed in GOPATH
The configuration can be set according to app-template.ini. You should rename it to app.ini to config the project.
HTTP_HOST = 127.0.0.1 HTTP_PORT = 8000 MAX_INDEXERS = 2 DEBUG_MODE = true REPO_PATH = repos MAX_Concurrency_REPOS = 5 [database] ;support sqlite3, mysql, postgres DB_TYPE = sqlite HOST = 127.0.0.1 PORT = 3306 NAME = misec USER = root PASSWD = SSL_MODE = disable ;the path to store the database file of sqlite3 PATH =
- Make sure you have installed dependencies
- Make sure the app.ini in config folder, you can rename app-template.ini to app.ini
- Make sure that you have config and set database correctly
You should build the
main.go file firstly with the command
go build main.go.
USAGE: main [global options] command [command options] [arguments...] COMMANDS: web Startup a web Service scan Start to scan github leak info help, h Show a list of commands or help for one command GLOBAL OPTIONS: --debug, -d Debug Mode --host value, -H value web listen address (default: "0.0.0.0") --port value, -p value web listen port (default: 8000) --time value, -t value scan interval(second) (default: 900) --help, -h show help --version, -v print the version
If it's the first time to run, there are some initial works will be finished automatically.
main scan, you need to add a Github token for crawl information in github. You can generate a token in tokens. Most access scopes are enough.