Combine multiple popular python security tools and generate reports or output into different formats
Project description
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
- 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
- Example Use
- Developer Notes
- Documentation
- Install With PIP
- Language information
- Install Python on Windows
- Install Python on Linux
- How to run
- Download Project
- Community Files
Developer Notes
Generate semgrep_sec.yaml
- Clone https://github.com/returntocorp/semgrep-rules
- cd to project/python
- do
$ cat **/security/**/*.yaml >> semgrep_sec.yaml $ cat **/security/*.yaml >> semgrep_sec.yaml
- Find and replace
rules:
with `` apart from the first instance - Reformat with
ctrl+shift+i
- 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 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
- Open the .py file in vscode
- Ensure a python 3.9 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.9)
- Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)
From the Terminal
./[file].py
Download Project
Clone
Using The Command Line
- Press the Clone or download button in the top right
- Copy the URL (link)
- Open the command line and change directory to where you wish to clone to
- 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
- Press the Clone or download button in the top right
- Click open in desktop
- 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
- Download this GitHub repository
- Extract the zip archive
- 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for simplesecurity-2021.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2f35f460249ce6f0790c851e0fc337662649ecebe4db0a8ebafa8bf4224ab90 |
|
MD5 | dfe21d7c8ffa92decc58daa50ca66f71 |
|
BLAKE2b-256 | 9c511213a406c899868b7d99edf14e061509d68d031a25524d9fbc5d27f31b1a |