reviewbot.tools.rbsecretscanner¶

Review Bot tool to check for hard-coded security credentials.

Classes

class SecretScannerTool(settings=None, **kwargs)[source]¶

Bases: BaseTool

Review Bot tool to check for hard-coded secrets and credentials.

name = 'Secret Scanner'[source]¶

The displayed name of the tool.

Type:

str

version = '1.0'[source]¶

The compatibility version of the tool.

This should only be changed for major breaking updates. It will break compatibility with existing integration configurations, requiring manual updates to those configurations. Any existing configurations referencing the old version will not be run, unless an older version of the tool is being handled through another Review Bot worker providing the older tool.

Type:

str

description = 'Review Bot tool to check for hard-coded secrets and credentials.'[source]¶

A short description of the tool.

Type:

str

timeout = 60[source]¶

Timeout for tool execution, in seconds.

Type:

int

handle_files(files, **kwargs)[source]¶

Perform a review of all files.

This will compute a regex used to match secret keys, before checking each individual file.

Parameters:

• files (list of reviewbot.processing.review.File) – The files to process.

• **kwargs (dict) – Keyword arguments passed to execute().

handle_file(f, **kwargs)[source]¶

Perform a review of a single file.

Parameters:

• f (reviewbot.processing.review.File) – The file to process.

• **kwargs (dict) – Additional keyword arguments.

__annotations__ = {}¶