credsweeper.scanner package¶

Subpackages¶

class credsweeper.scanner.scanner.Scanner(config, rule_path)[source]¶

Advanced Credential Scanner base class.

Parameters:

rules – list of rule objects to check
min_pattern_len – minimal length specified in all pattern rules
min_keyword_len – minimal possible length for a string to be matched by any keyword rule
min_len – Smallest between min_pattern_len and min_keyword_len
TargetGroup – Type for List[Tuple[AnalysisTarget, str, int]]

static get_scanner(rule)[source]¶

Choose type of scanner base on rule affiliation.

Parameters:: rule (Rule) – rule object used to scanning
Return type:: Type[ScanType]
Returns:: depending on the rule type, returns the corresponding scanner class

keywords_required_substrings_check(text)[source]¶

check whether text has any required substring for all keyword type rules

scan(provider)[source]¶

Run scanning of list of target lines from ‘targets’ with set of rule from ‘self.rules’.

Parameters:: provider (ContentProvider) – objects with data to analyze: line, line number, filepath and all lines in file
Return type:: List[Candidate]
Returns:: list of all detected credential candidates in analyzed targets

yield_rule_scanner(line_len, matched_pattern, matched_keyword, matched_pem_key, matched_multi)[source]¶

returns generator for rules and according scanner

Return type:: Generator[Tuple[Rule, Type[ScanType]], None, None]