Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/python-security/pyt

A Static Analysis Tool for Detecting Security Vulnerabilities in Python Web Applications
https://github.com/python-security/pyt

abstract-syntax abstract-syntax-tree control-flow-graph dataflow dataflow-analysis fixed-point fixed-point-analysis flask program-analysis pyt python python3 security static-analysis static-code-analysis taint taint-analysis

Last synced: 7 days ago
JSON representation

A Static Analysis Tool for Detecting Security Vulnerabilities in Python Web Applications

Awesome Lists containing this project

README 

        
.. image:: https://travis-ci.org/python-security/pyt.svg?branch=master

    :target: https://travis-ci.org/python-security/pyt



.. image:: https://readthedocs.org/projects/pyt/badge/?version=latest

    :target: http://pyt.readthedocs.io/en/latest/?badge=latest



.. image:: https://codeclimate.com/github/python-security/pyt/badges/coverage.svg

    :target: https://codeclimate.com/github/python-security/pyt/coverage



.. image:: https://badge.fury.io/py/python-taint.svg

    :target: https://badge.fury.io/py/python-taint



.. image:: https://img.shields.io/badge/PRs-welcome-ff69b4.svg

    :target: https://github.com/python-security/pyt/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+



.. image:: https://img.shields.io/badge/python-v3.6-blue.svg

    :target: https://pypi.org/project/python-taint/



.. image:: https://img.shields.io/badge/Donate-Charity-orange.svg

    :target: https://www.againstmalaria.com/donation.aspx



This project is no longer maintained

====================================



**March 2020 Update**: Please go see the amazing `Pysa tutorial`_ that should get you up to speed finding security vulnerabilities in your Python codebase.



`Pyre`_ from Facebook is an amazing project that has a bright future and many smart people working on it.

I would suggest, if you don't know that much about program analysis, that you understand how PyT works before diving into Pyre. Along with the `README's in most directories`_, there are the original `Master's Thesis`_ and `some slides`_.

With that said, **I am happy to review pull requests and give you write permissions if you make more than a few.**



There were a lot of great contributors to this project, I plan on working on other projects like `detect-secrets`_ and others (e.g. Pyre eventually) in the future if you'd like to work together more :)



If you are a security engineer with e.g. a Python codebase without type annotations, that Pyre won't handle, I would suggest you replace your sinks with a secure wrapper (something like `defusedxml`_), and alert off any uses of the standard sink. You can use `Bandit`_ to do this since dataflow analysis is not required, but you will have to trim it a lot, due to the high false-positive rate.



.. _Pysa tutorial: https://github.com/facebook/pyre-check/tree/master/pysa_tutorial#pysa-tutorial

.. _Pyre: https://github.com/facebook/pyre-check

.. _README's in most directories: https://github.com/python-security/pyt/tree/master/pyt#how-it-works

.. _Master's Thesis: https://projekter.aau.dk/projekter/files/239563289/final.pdf

.. _some slides: https://docs.google.com/presentation/d/1JfAykAxR0DcJwwGfHmhrz1RhhKqYsnt5x_GY8CbTp7s

.. _detect-secrets: https://github.com/Yelp/detect-secrets/blob/master/CHANGELOG.md#whats-new

.. _defusedxml: https://pypi.org/project/defusedxml/

.. _Bandit: https://github.com/PyCQA/bandit



Python Taint

============



Static analysis of Python web applications based on theoretical foundations (Control flow graphs, fixed point, dataflow analysis)



--------

Features

--------



* Detect command injection, SSRF, SQL injection, XSS, directory traveral etc.



* A lot of customisation possible



For a look at recent changes, please see the `changelog`_.



.. _changelog: https://github.com/python-security/pyt/blob/master/CHANGELOG.md



Example usage and output:



.. image:: https://raw.githubusercontent.com/KevinHock/rtdpyt/master/readme_static_files/pyt_example.png



Install

=======



Before continuing, make sure you have python3.6 or 3.7 installed.



.. code-block:: python



	pip install python-taint

	✨🍰✨



PyT can also be installed from source. To do so, clone the repo, and then run:



.. code-block:: python



  python3 setup.py install



How it Works

============



Soon you will find a `README.rst`_ in every directory in the ``pyt/`` folder, `start here`_.



.. _README.rst: https://github.com/python-security/pyt/tree/master/pyt

.. _start here: https://github.com/python-security/pyt/tree/master/pyt



How to Use

============



1. Choose a web framework



`The -a option determines which functions will have their arguments tainted`_, by default it is Flask.



2. (optional) Customize source and sink information



Use the ``-t`` option to specify sources and sinks, by default `this file is used`_.



3. (optional) Customize which library functions propagate taint



For functions from builtins or libraries, e.g. ``url_for`` or ``os.path.join``, use the ``-m`` option to specify whether or not they return tainted values given tainted inputs, by `default this file is used`_.



.. _The -a option determines which functions will have their arguments tainted: https://github.com/python-security/pyt/tree/master/pyt/web_frameworks#web-frameworks

.. _this file is used: https://github.com/python-security/pyt/blob/master/pyt/vulnerability_definitions/all_trigger_words.pyt

.. _default this file is used: https://github.com/python-security/pyt/blob/master/pyt/vulnerability_definitions/blackbox_mapping.json



Usage

=====



.. code-block::



  usage: python -m pyt [-h] [-a ADAPTOR] [-pr PROJECT_ROOT]

                       [-b BASELINE_JSON_FILE] [-j] [-t TRIGGER_WORD_FILE]

                       [-m BLACKBOX_MAPPING_FILE] [-i] [-o OUTPUT_FILE]

                       [--ignore-nosec] [-r] [-x EXCLUDED_PATHS]

                       [--dont-prepend-root] [--no-local-imports]

                       targets [targets ...]



  required arguments:

    targets               source file(s) or directory(s) to be scanned



  important optional arguments:

    -a ADAPTOR, --adaptor ADAPTOR

                          Choose a web framework adaptor: Flask(Default),

                          Django, Every or Pylons



    -t TRIGGER_WORD_FILE, --trigger-word-file TRIGGER_WORD_FILE

                          Input file with a list of sources and sinks



    -m BLACKBOX_MAPPING_FILE, --blackbox-mapping-file BLACKBOX_MAPPING_FILE

                              Input blackbox mapping file



  optional arguments:

    -pr PROJECT_ROOT, --project-root PROJECT_ROOT

                          Add project root, only important when the entry file

                          is not at the root of the project.



    -b BASELINE_JSON_FILE, --baseline BASELINE_JSON_FILE

                          Path of a baseline report to compare against (only

                          JSON-formatted files are accepted)



    -j, --json            Prints JSON instead of report.



    -i, --interactive     Will ask you about each blackbox function call in

                          vulnerability chains.



    -o OUTPUT_FILE, --output OUTPUT_FILE

                          Write report to filename



    --ignore-nosec        Do not skip lines with # nosec comments



    -r, --recursive       Find and process files in subdirectories



    -x EXCLUDED_PATHS, --exclude EXCLUDED_PATHS

                          Separate files with commas



    --dont-prepend-root   In project root e.g. /app, imports are not prepended

                          with app.*



    --no-local-imports    If set, absolute imports must be relative to the

                          project root. If not set, modules in the same

                          directory can be imported just by their names.



Usage from Source

=================



Using it like a user ``python3 -m pyt examples/vulnerable_code/XSS_call.py``



Running the tests ``python3 -m tests``



Running an individual test file ``python3 -m unittest tests.import_test``



Running an individual test ``python3 -m unittest tests.import_test.ImportTest.test_import``



Contributions

=============



Join our slack group: https://pyt-dev.slack.com/ - ask for invite: [email protected]



`Guidelines`_



.. _Guidelines: https://github.com/python-security/pyt/blob/master/CONTRIBUTIONS.md



Virtual env setup guide

=======================



Create a directory to hold the virtual env and project



``mkdir ~/a_folder``



``cd ~/a_folder``



Clone the project into the directory



``git clone https://github.com/python-security/pyt.git``



Create the virtual environment



``python3 -m venv ~/a_folder/``



Check that you have the right versions



``python3 --version`` sample output ``Python 3.6.0``



``pip --version`` sample output ``pip 9.0.1 from /Users/kevinhock/a_folder/lib/python3.6/site-packages (python 3.6)``



Change to project directory



``cd pyt``



In the future, just type ``source ~/a_folder/bin/activate`` to start developing.