Skip to main content

GitHub top language Repository size Issues License Commit activity Last commit PyPI Downloads PyPI Total Downloads PyPI Version

SimpleSecurity

Project Icon

Combine multiple popular python security tools and generate reports or output into different formats

Plugins (these require the plugin executable in the system path. e.g. bandit requires bandit to be in the system path...)

  • bandit
  • safety
  • dodgy
  • dlint
  • semgrep

Formats

  • ansi (for terminal)
  • json
  • markdown
  • csv
  • sarif

Example Use

See below for the output if you run simplesecurity in this directory

Help

usage: __main__.py [-h] [--format FORMAT] [--plugin PLUGIN] [--file FILE] [--level LEVEL] [--confidence CONFIDENCE]
                   [--no-colour] [--high-contrast] [--fast] [--zero]

Combine multiple popular python security tools...

and generate reports or output into different formats.

optional arguments:
  -h, --help            show this help message and exit
  --format FORMAT, -f FORMAT
                        Output format. One of ansi, json, markdown, csv. default=ansi
  --plugin PLUGIN, -p PLUGIN
                        Plugin to use. One of bandit, safety, dodgy, dlint, semgrep, all, default=all
  --file FILE, -o FILE  Filename to write to (omit for stdout)
  --level LEVEL, -l LEVEL
                        Minimum level/ severity to show
  --confidence CONFIDENCE, -c CONFIDENCE
                        Minimum confidence to show
  --no-colour, -z       No ANSI colours
  --high-contrast, -Z   High contrast colours
  --fast, --skip        Skip long running jobs. Will omit plugins with long run time (applies to -p all only)
  --zero, -0            Return non zero exit code if any security vulnerabilities are found

You can also import this into your own project and use any of the functions in the DOCS

Table of Contents

Developer Notes

Generate semgrep_sec.yaml

  1. Clone https://github.com/returntocorp/semgrep-rules

  2. cd to project/python

  3. do

    cat **/security/**/*.yaml >> semgrep_sec.yaml
    cat **/security/*.yaml >> semgrep_sec.yaml
    
  4. Find and replace rules: with `` apart from the first instance

  5. Reformat with ctrl+shift+i

  6. replace simplesecurity/semgrep_sec.yaml with the new one

Documentation

See the Docs for more information.

Install With PIP

"Slim" Build: Install bandit, dlint, dodgy, poetry, and safety with pipx

pip install simplesecurity

Otherwise:

pip install simplesecurity[full]

Head to https://pypi.org/project/SimpleSecurity/ for more info

Language information

Built for

This program has been written for Python versions 3.7 - 3.10 and has been tested with both 3.7 and 3.10

Install Python on Windows

Chocolatey

choco install python

Windows - Python.org

To install Python, go to https://www.python.org/downloads/windows/ and download the latest version.

Install Python on Linux

Apt

sudo apt install python3.x

Dnf

sudo dnf install python3.x

Install Python on MacOS

Homebrew

brew install python@3.x

MacOS - Python.org

To install Python, go to https://www.python.org/downloads/macos/ and download the latest version.

How to run

Windows

  • Module py -3.x -m [module] or [module] (if module installs a script)

  • File py -3.x [file] or ./[file]

Linux/ MacOS

  • Module python3.x -m [module] or [module] (if module installs a script)

  • File python3.x [file] or ./[file]

Download Project

Clone

Using The Command Line

  1. Press the Clone or download button in the top right

  2. Copy the URL (link)

  3. Open the command line and change directory to where you wish to clone to

  4. Type 'git clone' followed by URL in step 2

    git clone https://github.com/FHPythonUtils/SimpleSecurity
    

More information can be found at https://help.github.com/en/articles/cloning-a-repository

Using GitHub Desktop

  1. Press the Clone or download button in the top right
  2. Click open in desktop
  3. Choose the path for where you want and click Clone

More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Download Zip File

  1. Download this GitHub repository
  2. Extract the zip archive
  3. Copy/ move to the desired location

Community Files

Licence

MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)

Changelog

See the Changelog for more information.

Code of Conduct

Online communities include people from many backgrounds. The Project contributors are committed to providing a friendly, safe and welcoming environment for all. Please see the Code of Conduct for more information.

Contributing

Contributions are welcome, please see the Contributing Guidelines for more information.

Security

Thank you for improving the security of the project, please see the Security Policy for more information.

Support

Thank you for using this project, I hope it is of use to you. Please be aware that those involved with the project often do so for fun along with other commitments (such as work, family, etc). Please see the Support Policy for more information.

Rationale

The rationale acts as a guide to various processes regarding projects such as the versioning scheme and the programming styles used. Please see the Rationale for more information.

Metadata

Release files for simplesecurity 2021.3.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for simplesecurity 2021.3.4
File Size Uploaded Provenance Actions
simplesecurity-2021.3.4.tar.gz 36.3 kB Without provenance Details for simplesecurity-2021.3.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for simplesecurity 2021.3.4
File Interpreter ABI Platform Actions
simplesecurity-2021.3.4-py3-none-any.whl Python 3 none any Details for simplesecurity-2021.3.4-py3-none-any.whl

Total release size: 71.2 kB

Release files / simplesecurity-2021.3.4.tar.gz

Download URL simplesecurity-2021.3.4.tar.gz
Size 36.3 kB
Tags Source
SHA-256 checksum
How to use checksums
f2bcbd484842eb9876a103bdac036845c92ff5ddc750b270d1b18a308afc142b
BLAKE2b-256 checksum
How to use checksums
6a1bf44c53b2c76c30d05e3a9fbfba5daf7daddc1234d827cc9af12c1179fe33
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.11 CPython/3.10.0 Windows/10

Release files / simplesecurity-2021.3.4-py3-none-any.whl

Download URL simplesecurity-2021.3.4-py3-none-any.whl
Size 34.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4e1d3e7aef445e546d97ca00ae949051d3d92381b62434a2e4f746c08679c0d3
BLAKE2b-256 checksum
How to use checksums
820954a5ab2240ec96dce0bb4dfe953c7ad5c2e14961fcdecd013da6c9624d57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.11 CPython/3.10.0 Windows/10

Security for simplesecurity 2021.3.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2021.3.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page