Rules

Rules

Each rule comprises a regex (that will be searched in the commits), a category, and a description (optional).

How to add a new rule

Basic method

1. Download the rules file

2. Add the rules to the database via the CLI

   python -m credentialdigger add_rules rules.yml --sqlite /path/to/data.db

   or (please make sure that a Postgres instance is running)

   python -m credentialdigger add_rules rules.yml

Advanced method

1. Install the dependencies (possibly using a virtualenv)

2. Instantiate the client (either Postgres or sqlite)

   from credentialdigger import PgClient
   
   c = PgClient(dbhost='xxx.xxx.xxx.xxx', dbport=NUM, dbname='mydbname', dbuser='myusername', dbpassword='mypassword')

   or

   from credentialdigger import SqliteClient
   
   c = SqliteClient(path='/path/to/data.db')

3. Add a single rule

   c.add_rule('regex', 'category', 'description')

   or add a list of rules from a (yaml) file

   c.add_rules_from_file('/path/to/rules/file.yml')

   An example of rule file can be found here