Home

Welcome to the Credential Digger wiki! Here is an index of the wiki.

Usage

The project supports several major scanning features accessible through three different user interfaces.

Setting up

• Installation instructions can be found in the Readme
• Preparation for the regex scanner's rules
• Deploy over HTTPS (Optional)
• How to update Credential Digger
• How to install on MacOS ARM

User interfaces

• The package can be used programmatically through the Python library
• The CLI is available through the pip installation or source installation
• The web UI can be accessed through the Docker installation of Credential Digger
  • Setup Login System for the UI
• The pre-commit hook based on Credential Digger can be installed to prevent hardcoded secrets in source code

Features

• Scan an online repository
• Scan a local repository (with the --local option)
• Scan the snapshot of a repository
• Scan all repositories belonging to a user
• Scan GitHub wikis
• Scan local files and directories

Architecture

The following pages detail the architecture of the software.

• General architecture
• Available states
• Available scanners
• Machine Learning models:
  • General architecture
  • Template for the models
• Similarity Model
• Testing