Safety checks your installed dependencies for known security vulnerabilities.
Project description
Safety checks your installed dependencies for known security vulnerabilities.
By default it uses the open Python vulnerability database Safety DB,
but can be upgraded to use pyup.io's Safety API using the --key option.
Installation
Install safety with pip
pip install safety
Usage
To check your currently selected virtual environment for dependencies with known security vulnerabilites, run:
safety check
You should get a report similar to this:
╒══════════════════════════════════════════════════════════════════════════════╕ │ │ │ /$$$$$$ /$$ │ │ /$$__ $$ | $$ │ │ /$$$$$$$ /$$$$$$ | $$ \__//$$$$$$ /$$$$$$ /$$ /$$ │ │ /$$_____/ |____ $$| $$$$ /$$__ $$|_ $$_/ | $$ | $$ │ │ | $$$$$$ /$$$$$$$| $$_/ | $$$$$$$$ | $$ | $$ | $$ │ │ \____ $$ /$$__ $$| $$ | $$_____/ | $$ /$$| $$ | $$ │ │ /$$$$$$$/| $$$$$$$| $$ | $$$$$$$ | $$$$/| $$$$$$$ │ │ |_______/ \_______/|__/ \_______/ \___/ \____ $$ │ │ /$$ | $$ │ │ | $$$$$$/ │ │ by pyup.io \______/ │ │ │ ╞══════════════════════════════════════════════════════════════════════════════╡ │ REPORT │ ╞══════════════════════════════════════════════════════════════════════════════╡ │ No known security vulnerabilities found. │ ╘══════════════════════════════════════════════════════════════════════════════╛
Now, let's install something insecure:
pip install insecure-package
Yeah, you can really install that.
Run safety check again:
╒══════════════════════════════════════════════════════════════════════════════╕ │ │ │ /$$$$$$ /$$ │ │ /$$__ $$ | $$ │ │ /$$$$$$$ /$$$$$$ | $$ \__//$$$$$$ /$$$$$$ /$$ /$$ │ │ /$$_____/ |____ $$| $$$$ /$$__ $$|_ $$_/ | $$ | $$ │ │ | $$$$$$ /$$$$$$$| $$_/ | $$$$$$$$ | $$ | $$ | $$ │ │ \____ $$ /$$__ $$| $$ | $$_____/ | $$ /$$| $$ | $$ │ │ /$$$$$$$/| $$$$$$$| $$ | $$$$$$$ | $$$$/| $$$$$$$ │ │ |_______/ \_______/|__/ \_______/ \___/ \____ $$ │ │ /$$ | $$ │ │ | $$$$$$/ │ │ by pyup.io \______/ │ │ │ ╞══════════════════════════════════════════════════════════════════════════════╡ │ REPORT │ ╞══════════════════════════╤═══════════════╤═══════════════════╤═══════════════╡ │ package │ installed │ affected │ source │ ╞══════════════════════════╧═══════════════╧═══════════════════╧═══════════════╡ │ insecure-package │ 0.1.0 │ <0.2.0 │ changelog │ ╘══════════════════════════╧═══════════════╧═══════════════════╧═══════════════╛
Examples
Read requirement files
Just like pip, Safety is able to read local requirement files:
safety check -r requirements.txt
Read from stdin
Safety is also able to read from stdin with the --stdin flag set.
To check a local requirements file, run:
cat requirements.txt | safety check --stdin
or the output of pip freeze:
pip freeze | safety check --stdin
or to check a single package:
echo "insecure-package==0.1" | safety check --stdin
For more examples, take a look at the options section.
Using Safety in Docker
Safety can be easily executed as Docker container. To build the container just execute:
docker build -t safety-docker .
The container can be used just as described in the examples section.
echo "insecure-package==0.1" | docker run -i --rm safety-docker safety check --stdin
cat requirements_dev.txt | docker run -i --rm safety-docker safety check --stdin
Using Safety with a CI service
Safety works great in your CI pipeline. It returns a non-zero exit status if it finds a vulnerability.
Run it before or after your tests. If Safety finds something, your tests will fail.
Travis
install:
- pip install safety
script:
- safety check
Deep GitHub Integration
If you are looking for a deep integration with your GitHub repositories: Safety is available as a part of pyup.io, called Safety CI. Safety CI checks your commits and pull requests for dependencies with known security vulnerabilities and displays a status on GitHub.
Using Safety in production
Safety is free and open source (MIT Licensed). The underlying open vulnerability database is updated once per month.
To get access to all vulnerabilites as soon as they are added, you need a Safety API key that comes with a paid pyup.io account, starting at $99 for organizations.
Options
--key
API Key for pyup.io's vulnerability database. Can be set as SAFETY_API_KEY environment variable.
Example
safety check --key=12345-ABCDEFGH
--db
Path to a directory with a local vulnerability database including insecure.json and insecure_full.json
Example
safety check --db=/home/safety-db/data
--proxy-host
Proxy host IP or DNS
--proxy-port
Proxy port number
--proxy-protocol
Proxy protocol (https or http)
--json
Output vulnerabilities in JSON format.
Example
safety check --json
[ [ "django", "<1.2.2", "1.2", "Cross-site scripting (XSS) vulnerability in Django 1.2.x before 1.2.2 allows remote attackers to inject arbitrary web script or HTML via a csrfmiddlewaretoken (aka csrf_token) cookie.", "25701" ] ]
--full-report
Full reports include a security advisory (if available).
Example
safety check --full-report
╒══════════════════════════════════════════════════════════════════════════════╕
│ │
│ /$$$$$$ /$$ │
│ /$$__ $$ | $$ │
│ /$$$$$$$ /$$$$$$ | $$ \__//$$$$$$ /$$$$$$ /$$ /$$ │
│ /$$_____/ |____ $$| $$$$ /$$__ $$|_ $$_/ | $$ | $$ │
│ | $$$$$$ /$$$$$$$| $$_/ | $$$$$$$$ | $$ | $$ | $$ │
│ \____ $$ /$$__ $$| $$ | $$_____/ | $$ /$$| $$ | $$ │
│ /$$$$$$$/| $$$$$$$| $$ | $$$$$$$ | $$$$/| $$$$$$$ │
│ |_______/ \_______/|__/ \_______/ \___/ \____ $$ │
│ /$$ | $$ │
│ | $$$$$$/ │
│ by pyup.io \______/ │
│ │
╞══════════════════════════════════════════════════════════════════════════════╡
│ REPORT │
╞════════════════════════════╤═══════════╤══════════════════════════╤══════════╡
│ package │ installed │ affected │ ID │
╞════════════════════════════╧═══════════╧══════════════════════════╧══════════╡
│ django │ 1.2 │ <1.2.2 │ 25701 │
╞══════════════════════════════════════════════════════════════════════════════╡
│ Cross-site scripting (XSS) vulnerability in Django 1.2.x before 1.2.2 allows │
│ remote attackers to inject arbitrary web script or HTML via a csrfmiddlewar │
│ etoken (aka csrf_token) cookie. │
╘══════════════════════════════════════════════════════════════════════════════╛
--bare
Output vulnerable packages only. Useful in combination with other tools.
Example
safety check --bare
cryptography django
--cache
Cache requests to the vulnerability database locally for 2 hours.
Example
safety check --cache
--stdin
Read input from stdin.
Example
cat requirements.txt | safety check --stdin
pip freeze | safety check --stdin
echo "insecure-package==0.1" | safety check --stdin
--file, -r
Read input from one (or multiple) requirement files.
Example
safety check -r requirements.txt
safety check --file=requirements.txt
safety check -r req_dev.txt -r req_prod.txt
--ignore, -i
Ignore one (or multiple) vulnerabilities by ID
Example
safety check -i 1234
safety check --ignore=1234
safety check -i 1234 -i 4567 -i 89101
--output, -o
Save the report to a file
Example
safety check -o insecure_report.txt
safety check --output --json insecure_report.json
Review
If you save the report in JSON format you can review in the report format again.
Options
--file, -f (REQUIRED)
Read an insecure report.
Example
safety check -f insecure.json
safety check --file=insecure.json
--full-report
Full reports include a security advisory (if available).
Example
safety review -r insecure.json --full-report
╒══════════════════════════════════════════════════════════════════════════════╕
│ │
│ /$$$$$$ /$$ │
│ /$$__ $$ | $$ │
│ /$$$$$$$ /$$$$$$ | $$ \__//$$$$$$ /$$$$$$ /$$ /$$ │
│ /$$_____/ |____ $$| $$$$ /$$__ $$|_ $$_/ | $$ | $$ │
│ | $$$$$$ /$$$$$$$| $$_/ | $$$$$$$$ | $$ | $$ | $$ │
│ \____ $$ /$$__ $$| $$ | $$_____/ | $$ /$$| $$ | $$ │
│ /$$$$$$$/| $$$$$$$| $$ | $$$$$$$ | $$$$/| $$$$$$$ │
│ |_______/ \_______/|__/ \_______/ \___/ \____ $$ │
│ /$$ | $$ │
│ | $$$$$$/ │
│ by pyup.io \______/ │
│ │
╞══════════════════════════════════════════════════════════════════════════════╡
│ REPORT │
╞════════════════════════════╤═══════════╤══════════════════════════╤══════════╡
│ package │ installed │ affected │ ID │
╞════════════════════════════╧═══════════╧══════════════════════════╧══════════╡
│ django │ 1.2 │ <1.2.2 │ 25701 │
╞══════════════════════════════════════════════════════════════════════════════╡
│ Cross-site scripting (XSS) vulnerability in Django 1.2.x before 1.2.2 allows │
│ remote attackers to inject arbitrary web script or HTML via a csrfmiddlewar │
│ etoken (aka csrf_token) cookie. │
╘══════════════════════════════════════════════════════════════════════════════╛
--bare
Output vulnerable packages only.
Example
safety review --file report.json --bare
django
======= History
1.8.5 (2019-02-04)
- Wrap words in full report (Thanks @mgedmin)
- Added Dockerfile and readme instructions (Thanks @ayeks)
- Remove API dependency on pip (Thanks @benjaminp)
1.8.4 (2018-08-03)
- Update cryptography dependency from verision 1.9 to version 2.3 due to security vulnerability
1.8.3b (2018-07-24)
- Allows both unicode and non-unicode type encoding when parsing requriment files
1.8.2 (2018-07-10)
- Fixed unicode error
1.8.1 (2018-04-06)
- Fixed a packaging error with the dparse dependency
1.8.0 (2018-04-05)
- Safety now support pip 10
1.7.0 (2018-02-03)
- Safety now shows a filename if it finds an unpinned requirement. Thanks @nnadeau
- Removed official support for Python 2.6 and Python 3.3. Thanks @nnadeau
1.6.1 (2017-10-20)
- Fixed an error that caused the CLI to fail on requirement files/stdin.
1.6.0 (2017-10-20)
- Added an indicator which DB is currently used
- Added a package count how many packages have been checked
- Allow multiple version of the same library. Thanks @thatarchguy
1.5.1 (2017-07-20)
- Fixed an error on unpinned VCS requirements. This is a regression, see https://github.com/pyupio/safety/issues/72
1.5.0 (2017-07-19)
- Internal refactoring. Removed dependency on setuptools and switched to the new dparse library.
1.4.1 (2017-07-04)
- Fixed a bug where absence of
sttywas causing a traceback insafety checkon Python 2.7 for Windows.
1.4.0 (2017-04-21)
- Added the ability to ignore one (or multiple) vulnerabilities by ID via the
--ignore/-iflag.
1.3.0 (2017-04-21)
- Added
--bareoutput format. - Added a couple of help text to the command line interface.
- Fixed a bug that caused requirement files with unpinned dependencies to fail when using a recent setuptools release.
1.2.0 (2017-04-06)
- Added JSON as an output format. Use it with the
--jsonflag. Thanks @Stype.
1.1.1 (2017-03-27)
- Fixed terminal size detection when fed via stdin.
1.1.0 (2017-03-23)
- Compatibility release. Safety should now run on macOs, Linux and Windows with Python 2.7, 3.3-3.6. Python 2.6 support is available on a best-effort basis on Linux.
1.0.2 (2017-03-23)
- Fixed another error on Python 2. The fallback function for get_terminal_size wasn't working correctly.
1.0.1 (2017-03-23)
- Fixed an error on Python 2, FileNotFoundError was introduced in Python 3.
1.0.0 (2017-03-22)
- Added terminal size detection. Terminals with fewer than 80 columns should now display nicer reports.
- Added an option to load the database from the filesystem or a mirror that's reachable via http(s). This can be done by using the --db flag.
- Added an API Key option that uses pyup.io's vulnerability database.
- Added an option to cache the database locally for 2 hours. The default still is to not use the cache. Use the --cache flag.
0.6.0 (2017-03-10)
- Made the requirements parser more robust. The parser should no longer fail on editable requirements and requirements that are supplied by package URL.
- Running safety requires setuptools >= 16
0.5.1 (2016-11-08)
- Fixed a bug where not all requirement files were read correctly.
0.5.0 (2016-11-08)
- Added option to read requirements from files.
0.4.0 (2016-11-07)
- Filter out non-requirements when reading from stdin.
0.3.0 (2016-10-28)
- Added option to read from stdin.
0.2.2 (2016-10-21)
- Fix import errors on python 2.6 and 2.7.
0.2.1 (2016-10-21)
- Fix packaging bug.
0.2.0 (2016-10-20)
- Releasing first prototype.
0.1.0 (2016-10-19)
- First release on PyPI.
Release history Release notifications
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size & hash SHA256 hash help | File type | Python version | Upload date |
|---|---|---|---|
| safety-1.8.5-py2.py3-none-any.whl (14.8 kB) Copy SHA256 hash SHA256 | Wheel | py2.py3 | |
| safety-1.8.5.tar.gz (1.1 MB) Copy SHA256 hash SHA256 | Source | None |
