search

owtf / ptp

Pentester's Tools Parser (PTP) provides an unified way to retrieve the information from all (final goal) automated pentesting tools and assign an automated ranking for each finding.
http://owtf.github.io/ptp/
BSD 3-Clause "New" or "Revised" License
31 stars 13 forks source link
owasp owtf pentesting python vulne

readme

============ What is PTP?

.. image:: https://travis-ci.org/owtf/ptp.svg?branch=develop :target: https://travis-ci.org/owtf/ptp

The primary goal of ptp (Pentester's Tools Parser) is to enhance OWASP - OWTF project <https://www.owasp.org/index.php/OWASP_OWTF>_ in order to provide an automated ranking for each plugin. This will allow the user to focus attention on the most likely weak areas of a web application or network first, which will be valuable to efficiently use the remaining time in a penetration assessment.

Instead of evaluating every plugins run by OWASP - OWTF and defining the rankings for each of them, thanks to ptp, the user will be able to focus on the ones that have been ranked with the highest risks. The user is then able to confirm or override the automated rankings since we estimate that she/he is the only one that can accurately detect the false positives.

When developing the automated ranking system, ptp's main goal was joined with a secondary one.

Apart from its main feature which is ranking the results from security tools reports, it also provides an unified way to reuse these reports directly in your python code, without having to deal with complex parsing.

============ Installation

Using pip

The ptp library is available on PyPI <https://pypi.python.org/pypi> at the following address: https://pypi.python.org/pypi/ptp <https://pypi.python.org/pypi/ptp>.

The easiest way to install it is using pip <https://pip.readthedocs.org/en/latest/installing.html>_.

.. code-block:: bash

$ pip install ptp

Note: If an error occurs during the installation process, check your permissions. It might be required to run pip <https://pip.readthedocs.org/en/latest/installing.html>_ as root.

From scratch

It is also possible to install the library from its repository. You will then be able to use the latest possible version or even try the develop branch <https://github.com/owtf/ptp/tree/develop>_.

The first step is to clone the repository of the project:

.. code-block:: bash

$ git clone https://github.com/owtf/ptp.git

Then use the Makefile command:

.. code-block:: bash

$ make install

===== Usage

.. code-block:: python

from __future__ import print_function
from ptp import PTP

if __name__ == '__main__':
    ptp = PTP()
    ptp.parse('path/to/the/report/directory')
    print('Highest severity:', ptp.highest_ranking)

============= Documentation

The documentation is available online at the following address: https://owtf.github.io/ptp/ <https://owtf.github.io/ptp/>_.

It explains how to use the library and even how to contribute. Plus it contains the technical documentation of the project.

=============== Current support

Warning: Since v0.4, PTP relies on the fact that the supported tools are following semantic version <http://semver.org/>_ (except observed otherwise). In other words, as long as the tool doesn't update its MAJOR version, PTP will assume that it can parse its report, reducing the maintenance cost on our side.