simplesecurity 2020.4.0

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

SimpleSecurity

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

Formats

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

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]

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, pygraudit, 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)

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

Table of Contents

• Example Use
  • Help
• Changelog
• Install With PIP
• Developer Notes
  • Generate semgrep_sec.yaml
• Language information
  • Built for
• Install Python on Windows
  • Chocolatey
  • Download
• Install Python on Linux
  • Apt
• How to run
  • With VSCode
  • From the Terminal
• Community Files
  • Licence
  • Changelog
  • Code of Conduct
  • Contributing
  • Security
  • Support

Changelog

See the CHANGELOG 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

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

Language information

Built for

This program has been written for Python 3 and has been tested with Python version 3.9.0 https://www.python.org/downloads/release/python-380/.

Install Python on Windows

Chocolatey

choco install python

Download

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

Install Python on Linux

Apt

sudo apt install python3.9

How to run

With VSCode

1. Open the .py file in vscode
2. Ensure a python 3.9 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.9)
3. Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)

From the Terminal

./[file].py

Community Files

Licence

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

Changelog

See the Changelog for more information.

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone. 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.