rules package¶

Submodules¶

class credsweeper.rules.rule.Rule(config, rule_template)[source]¶

Regular expression to detect some credential type.

Class contains regular expression to detect some credential type, credential name, assumed severity: and details on how detection should be processed

Parameters:

rule_name – Name displayed if rule
rule_type – RuleType used for this rule
severity – critical/high/medium/low
filters – List of Filter objects that can be used to filters False detections based on rules
patterns – Regular expressions that can be used for detection
pattern_type – single_pattern/multi_pattern/pem_key_pattern. single_pattern for simple single line credentials multi_pattern for credentials span for rew lines. pem_key_pattern for PEM like credentials
use_ml – Should ML work on this credential or not. If not prediction based on regular expression and filter only
validations – List of Validation objects that can check this credential using external API
required_substrings – Optional list of substrings. Scanner would only apply this rule if line contain at least one of this substrings
min_line_len – Optional minimal line length. Scanner would only apply this rule if line is equal or longer

property filters: List[Filter]¶

filters getter

property min_line_len: int¶

min_line_len getter

property pattern_type: str¶

pattern_type getter

property patterns: List[Pattern]¶

patterns getter

property required_substrings: List[str]¶

required_substrings getter

property rule_name: str¶

rule_name getter

property rule_type: RuleType¶

rule_type getter

property severity: Severity¶

severity getter

property use_ml: bool¶

use_ml getter

property validations: List[Validation]¶

validations getter