credsweeper.deep_scanner package¶

Submodules¶

credsweeper.deep_scanner.abstract_scanner module¶

class credsweeper.deep_scanner.abstract_scanner.AbstractScanner[source]¶

Bases: ABC

Base abstract class for all recursive scanners

abstract property config: Config¶: Abstract property to be defined in DeepScanner

abstract recursive_scan(data_provider, depth=0, recursive_limit_size=0)[source]¶

Abstract method to be defined in DeepScanner

Return type:: List[Candidate]

abstract property scanner: Scanner¶: Abstract property to be defined in DeepScanner

abstract structure_scan(struct_provider, depth, recursive_limit_size)[source]¶

Abstract method to be defined in DeepScanner

Return type:: List[Candidate]

credsweeper.deep_scanner.byte_scanner module¶

class credsweeper.deep_scanner.byte_scanner.ByteScanner[source]¶

Bases: AbstractScanner, ABC

Implements plain data scanning

data_scan(data_provider, depth, recursive_limit_size)[source]¶

Tries to represent data as plain text with splitting by lines and scan as text lines

Return type:: List[Candidate]

credsweeper.deep_scanner.bzip2_scanner module¶

class credsweeper.deep_scanner.bzip2_scanner.Bzip2Scanner[source]¶

Bases: AbstractScanner, ABC

Implements bzip2 scanning

data_scan(data_provider, depth, recursive_limit_size)[source]¶

Extracts data from bzip2 archive and launches data_scan

Return type:: List[Candidate]

credsweeper.deep_scanner.deep_scanner module¶

class credsweeper.deep_scanner.deep_scanner.DeepScanner(config, scanner)[source]¶

Bases: ByteScanner, Bzip2Scanner, DocxScanner, EncoderScanner, GzipScanner, HtmlScanner, JksScanner, LangScanner, PdfScanner, Pkcs12Scanner, PptxScanner, TarScanner, XmlScanner, XlsxScanner, ZipScanner

Advanced scanner with recursive exploring of data

property config: Config¶: Abstract property to be defined in DeepScanner

static get_deep_scanners(data, file_type)[source]¶

Returns possibly scan methods for the data depends on content

Return type:: List[Any]

recursive_scan(data_provider, depth=0, recursive_limit_size=0)[source]¶

Recursive function to scan files which might be containers like ZIP archives

Parameters:

data_provider (DataContentProvider) – DataContentProvider object may be a container
depth (int) – maximal level of recursion
recursive_limit_size (int) – maximal bytes of opened files to prevent recursive zip-bomb attack

Return type:

List[Candidate]

scan(content_provider, depth, recursive_limit_size=None)[source]¶

Initial scan method to launch recursive scan. Skips ByteScanner to prevent extra scan

Parameters:

content_provider (ContentProvider) – ContentProvider that might contain raw data
depth (int) – maximal level of recursion
recursive_limit_size (Optional[int]) – maximal bytes of opened files to prevent recursive zip-bomb attack

Return type:

List[Candidate]

property scanner: Scanner¶: Abstract property to be defined in DeepScanner

structure_scan(struct_provider, depth, recursive_limit_size)[source]¶

Recursive function to scan structured data

Parameters:

struct_provider (StructContentProvider) – DataContentProvider object may be a container
depth (int) – maximal level of recursion
recursive_limit_size (int) – maximal bytes of opened files to prevent recursive zip-bomb attack

Return type: