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

1. Install the dependencies (possibly using a virtualenv)

2. Instantiate the client

   from credentialdigger.cli import Client
   c = Client(host='xxx.xxx.xxx.xxx', port=NUM, dbname='mydbname', user='myusername', password='mypassword')

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('rule/path/file.yml')

   An example of rule file can be found here