Skip to content

Latest commit

 

History

History
188 lines (105 loc) · 3.24 KB

File metadata and controls

188 lines (105 loc) · 3.24 KB

Plugins

Simplesecurity Index / Simplesecurity / Plugins

Auto-generated documentation for simplesecurity.plugins module.

bandit

Show source in plugins.py:92

Generate list of findings using bandit. requires bandit on the system path.

Params: scanDir(str): select a scan directory (useful for cicd etc)

Raises

  • RuntimeError - if bandit is not on the system path, then throw this error

Returns

  • list[Finding] - our findings dictionary

Signature

def bandit(scanDir=".") -> list[Finding]: ...

See also

dlint

Show source in plugins.py:274

Generate list of findings using tool. requires tool on the system path.

Params: scanDir(str): select a scan directory (useful for cicd etc)

Raises

  • RuntimeError - if flake8 is not on the system path, then throw this error

Returns

  • list[Finding] - our findings dictionary

Signature

def dlint(scanDir=".") -> list[Finding]: ...

See also

dodgy

Show source in plugins.py:237

Generate list of findings using tool. requires tool on the system path.

Params: scanDir(str): select a scan directory (useful for cicd etc)

Raises

  • RuntimeError - if dodgy is not on the system path, then throw this error

Returns

  • list[Finding] - our findings dictionary

Signature

def dodgy(scanDir=".") -> list[Finding]: ...

See also

extractEvidence

Show source in plugins.py:66

Grab evidence from the source file.

Arguments

  • desiredLine int - line to highlight
  • file str - file to extract evidence from

Returns

  • list[Line] - list of lines

Signature

def extractEvidence(desiredLine: int, file: str) -> list[Line]: ...

See also

safety

Show source in plugins.py:198

Generate list of findings using tool. requires tool on the system path.

Params: scanDir(str): select a scan directory (useful for cicd etc)

Raises

  • RuntimeError - if safety is not on the system path, then throw this error

Returns

  • list[Finding] - our findings dictionary

Signature

def safety(scanDir=".") -> list[Finding]: ...

See also

semgrep

Show source in plugins.py:331

Generate list of findings using for semgrep. Requires semgrep on the system path (wsl in windows).

Raises

  • RuntimeError - if semgrep is not on the system path, then throw this error

Returns

  • list[Finding] - our findings dictionary

Signature

def semgrep(scanDir=".") -> list[Finding]: ...

See also