Skip to content
This repository was archived by the owner on Jul 16, 2026. It is now read-only.

Architecture

Sofiane Lounici edited this page Jul 16, 2020 · 5 revisions

Credential Digger finds credentials hardcoded in a repository. The tool is composed of:

  • Postgres database
  • Python client
  • User interface

Database

The database is structured in the following way (arrows point to foreign keys).

Project structure

The project includes 3 components: a db (sql folder), a client (credentialdigger folder), and a user interface (ui folder).

sql

create_table.sql defines the db schema.

Note that, given the file_name and commit_hash of a discovery, both the commit and the file can be accessible at addresses:

REPO_URL/commit/COMMIT_HASH
REPO_URL/blob/COMMIT_HASH/file_name
credentialdigger

This client can be used to easily interact with the db. It offers a scanner for git repositories, based on Hyperscan (others can be implemented). Please note that the database must be up and running.

ui

The user interface can be used to easily perform scans and flag the discoveries.

Clone this wiki locally