credentials package

Submodules

credentials.candidate module

class credsweeper.credentials.candidate.Candidate(line_data_list, patterns, rule_name, severity, config, validations=None, use_ml=False)

Bases: object

Candidates that can be credentials.

Class contains list of LineData, some attributes from Rule object, and config

Parameters:

• line_data_list (List[LineData]) – List of LineData

• patterns (List[Pattern]) – Regular expressions that can be used for detection

• rule_name (str) – Name of Rule

• severity (Severity) – critical/high/medium/low

• config (Config) – user configs

• validations (Optional[List[Validation]]) – List of Validation objects that can check this credential using external API

• use_ml (bool) – Should ML work on this credential or not. If not prediction based on regular expression and filter only

add_line_data(line_data)

Add new line data to the current credential.

Parameters:

line_data (LineData) – Line data object to be added

Return type:

None

property api_validation: KeyValidationOption

api_validation getter

Return type:

KeyValidationOption

classmethod get_dummy_candidate(config, file_path)

Create dummy instance to use in searching file by extension

is_api_validation_available()

Check if current credential candidate can be validated with external API.

Return type:

bool

Returns:

True if any validation available, False otherwise

property line_data_list: List[LineData]

line_data_list getter

Return type:

List[LineData]

property ml_validation: KeyValidationOption

ml_validation getter

Return type:

KeyValidationOption

property patterns: List[Pattern]

patterns getter

Return type:

List[Pattern]

property rule_name: str

rule_name getter

Return type:

str

property severity: Severity

severity getter

Return type:

Severity

to_dict_list()

Convert credential candidate object to List[dict].

Return type:

List[dict]

Returns:

List[dict] object generated from current credential candidate

to_json()

Convert credential candidate object to dictionary.

Return type:

dict

Returns:

Dictionary object generated from current credential candidate

credentials.candidate_group_generator module

class credsweeper.credentials.candidate_group_generator.CandidateGroupGenerator

Bases: object

property grouped_candidates: Dict[CandidateKey, List[Candidate]]

Return type:

Dict[CandidateKey, List[Candidate]]

items()

Return type:

List[Tuple[CandidateKey, List[Candidate]]]

credentials.candidate_key module

class credsweeper.credentials.candidate_key.CandidateKey(line_data)

Bases: object

Class used to identify credential candidates.

Candidates that detected same value on same string in a same file would have identical CandidateKey

credentials.credential_manager module

class credsweeper.credentials.credential_manager.CredentialManager

Bases: object

The manager allows you to store, add and delete separate credit candidates.

Parameters:

candidates – list of credential candidates

add_credential(candidate)

Add credential candidate to the manager.

Parameters:

candidate (Candidate) – credential candidate to be added

Return type:

None

get_credentials()

Get all credential candidates stored in the manager.

Return type:

List[Candidate]

Returns:

List with all Candidate objects stored in manager

group_credentials()

Join candidates that reference same secret value in the same line.

Candidate can belong to two groups in the same time if it has more than one LineData object inside

Return type:

CandidateGroupGenerator

Returns:

Contain dictionary of [path, line_num, value] -> credential candidates list

remove_credential(candidate)

Remove credential candidate from the manager.

Parameters:

candidate (Candidate) – credential candidate to be removed

Return type:

None

set_credentials(candidates)

Remove all current credentials candidates from the manager and add new credentials.

Parameters:

candidates (List[Candidate]) – List with candidates to replace current candidates in the manager

Return type:

None

credentials.line_data module

class credsweeper.credentials.line_data.LineData(config, line, line_num, path, pattern)

Bases: object

Object to treat and store scanned line related data.

Parameters:

• key – Optional[str] = None

• line (str) – string variable, line

• line_num (int) – int variable, number of line in file

• path (str) – string variable, path to file

• pattern (Pattern) – regex pattern, detected pattern in line

• separator – optional string variable, separators between variable and value

• separator_span – optional tuple variable, separator position

• value – optional string variable, detected value in line

• variable – optional string variable, detected variable in line

bash_param_split = regex.Regex('\\s+(\\-|\\||\\>|\\w+?\\>|\\&)', flags=regex.V0)

clean_bash_parameters()

Split variable and value by bash special characters, if line assumed to be CLI command.

Return type:

None

clean_url_parameters()

Clean url address from ‘query parameters’.

If line seem to be a URL - split by & character. Variable should be right most value after & or ? ([-1]). And value should be left most before & ([0])

Return type:

None

comment_starts = ['//', '*', '#', '/*', '<!––', '%{', '%', '...', '(*', '--', '--[[', '#=']

initialize()

Set all internal fields.

Return type:

None

is_comment()

Check if line with credential is a comment.

Return type:

bool

Returns:

True if line is a comment, False otherwise

is_source_file()

Check if file with credential is a source code file or not (data, log, plain text).

Return type:

bool

Returns:

True if file is source file, False otherwise

is_source_file_with_quotes()

Check if file with credential require quotation for string literals.

Return type:

bool

Returns:

True if file require quotation, False otherwise

property key: str

key getter

Return type:

str

property line: str

line getter

Return type:

str

property line_num: int

line_num getter

Return type:

int

property path: str

path getter

Return type:

str

property pattern: Pattern

pattern getter

Return type:

Pattern

sanitize_variable()

Remove trailing spaces, dashes and quotations around the variable.

Return type:

None

property separator: str

separator getter

Return type:

str

property separator_span: Tuple[int, int]

separator_span getter

Return type:

Tuple[int, int]

set_pattern_match_groups()

Apply regex to the candidate line and set internal fields based on match.

Return type:

None

to_json()

Convert line data object to dictionary.

Return type:

dict

Returns:

Dictionary object generated from current line data

property value: str

value getter

Return type:

str

property value_leftquote: str

value_leftquote getter

Return type:

str

property value_rightquote: str

value_rightquote getter

Return type:

str

property variable: str

variable getter

Return type:

str

Module contents