credsweeper.scanner.scan_type package

Submodules

credsweeper.scanner.scan_type.multi_pattern module

class credsweeper.scanner.scan_type.multi_pattern.MultiPattern

Bases: ScanType

Check if line is a part of a multi-line credential and second part is present within MAX_SEARCH_MARGIN lines.

Parameters:

MAX_SEARCH_MARGIN – Int constant. Number of lines around current to perform search for the second part

MAX_SEARCH_MARGIN = 10

classmethod run(config, rule, target)

Check if multiline credential present if the file within MAX_SEARCH_MARGIN range from current line_num.

Parameters:

• config (Config) – user configs

• rule (Rule) – Rule object to check current line. Should be a multi-pattern rule

• target (AnalysisTarget) – Analysis target

Return type:

List[Candidate]

Returns:

List of Candidates if pattern defined in a rule is present in a line and second part of multi-pattern rule is present within MAX_SEARCH_MARGIN from the line. Empty list (False) - otherwise.

credsweeper.scanner.scan_type.pem_key_pattern module

class credsweeper.scanner.scan_type.pem_key_pattern.PemKeyPattern

Bases: ScanType

Scanner detects single PEM private key in target from current line

classmethod run(config, rule, target)

Check if target is a PEM key

Parameters:

• config (Config) – user configs

• rule (Rule) – Rule object to check current line. Should be a pem-pattern rule

• target (AnalysisTarget) – Analysis target

Return type:

List[Candidate]

Returns:

List of Candidate objects if pattern defined in a rule is present in a line and filters defined in rule do not remove current line. Empty list - otherwise

credsweeper.scanner.scan_type.scan_type module

class credsweeper.scanner.scan_type.scan_type.ScanType

Bases: ABC

Base class for all Scanners.

Scanner allow to check if regex pattern defined in a rule is present in a line.

classmethod filtering(config, target, line_data, filters)

Check if line data should be removed based on filters.

If use_filters option is false, always return False

Parameters:

• config (Config) – dict of credsweeper configuration

• target (AnalysisTarget) – AnalysisTarget from which line_data was obtained

• line_data (LineData) – Line data to check with filters

• filters (List[Filter]) – Filters to use

Returns:

True if line_data should be removed. False otherwise. If use_filters option is false, always return False

Return type:

boolean

classmethod get_line_data_list(config, target, pattern, filters)

Check if regex pattern is present in line, and line should not be removed by filters.

Parameters:

• config (Config) – dict of credsweeper configuration

• target (AnalysisTarget) – AnalysisTarget with all necessary data

• pattern (Pattern) – Compiled regex object to be searched in line

• filters (List[Filter]) – Filters to use

Return type:

List[LineData]

Returns:

List of LineData objects if pattern a line and filters do not remove current line. Empty otherwise

abstract classmethod run(config, rule, target)

Check if regex pattern defined in a rule is present in a line.

Parameters:

• config (Config) – user configs

• rule (Rule) – Rule object to check current line

• target (AnalysisTarget) – Analysis target

Return type:

List[Candidate]

Returns:

List of Candidate objects if pattern defined in a rule is present in a line and filters defined in rule do not remove current line. Empty list - otherwise

credsweeper.scanner.scan_type.single_pattern module

class credsweeper.scanner.scan_type.single_pattern.SinglePattern

Bases: ScanType

Check if single line rule present in the line.

classmethod run(config, rule, target)

Check if regex pattern defined in a rule is present in a line.

Parameters:

• config (Config) – config object of user configs

• rule (Rule) – Rule object to check current line

• target (AnalysisTarget) – Analysis target

Return type:

List[Candidate]

Returns:

List of Candidate objects if pattern defined in a rule is present in a line and filters defined in rule do not remove current line. Empty list - otherwise

Module contents