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.

https://github.com/owtf/ptp

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.0%) to scientific vocabulary

Keywords

owasp owtf pentesting python vulne
Last synced: 6 months ago · JSON representation

Repository

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.

Basic Info
  • Host: GitHub
  • Owner: owtf
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: develop
  • Homepage: http://owtf.github.io/ptp/
  • Size: 5.97 MB
Statistics
  • Stars: 31
  • Watchers: 8
  • Forks: 13
  • Open Issues: 8
  • Releases: 7
Topics
owasp owtf pentesting python vulne
Created almost 12 years ago · Last pushed almost 3 years ago
Metadata Files
Readme License

README.rst

============
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 `_ 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 `_ at the
following address: `https://pypi.python.org/pypi/ptp
`_.

The easiest way to install it is using `pip
`_.

.. 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
`_ 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
`_.

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/ `_.

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

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

+ arachni (0.4.x to 1.x) (XML and JSON report)
+ burpsuite (1.x.x) (XML report)
+ dirbuster (1.0-RC1)
+ hoppy (1.x.x)
+ metasploit
+ owasp
+ robots.txt
+ skipfish (2.10b)
+ w3af (1.x.x) (XML report)
+ wapiti (2.x.x) (XML report)


*Warning*: Since v0.4, PTP relies on the fact that the supported tools are following `semantic version `_
(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.

Owner

  • Name: OWASP OWTF
  • Login: owtf
  • Kind: organization
  • Email: owasp_owtf_developers@lists.owasp.org
  • Location: Pwnageland

GitHub Events

Total
Last Year

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 358
  • Total Committers: 3
  • Avg Commits per committer: 119.333
  • Development Distribution Score (DDS): 0.014
Past Year
  • Commits: 2
  • Committers: 1
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Tao Sauvage s****o@g****m 353
DoomTaper a****3@i****n 3
Viyat v****b 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 23
  • Total pull requests: 5
  • Average time to close issues: 5 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 5
  • Total pull request authors: 1
  • Average comments per issue: 1.17
  • Average comments per pull request: 2.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • DePierre (15)
  • DoomTaper (4)
  • viyatb (2)
  • DarKnight24 (1)
  • esotracuenta (1)
Pull Request Authors
  • DoomTaper (5)
Top Labels
Issue Labels
enhancement (10) help wanted (6) bug (6) need more info (2) easy (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 386 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 8
  • Total maintainers: 2
pypi.org: ptp

PTP parses and ranks the discoveries listed in security tool reports.

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 176 Last month
Rankings
Downloads: 7.7%
Forks count: 9.8%
Dependent packages count: 10.0%
Stargazers count: 11.7%
Average: 12.2%
Dependent repos count: 21.7%
Maintainers (1)
Last synced: 6 months ago
pypi.org: owtf-ptp

PTP parses and ranks the discoveries listed in security tool reports.

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 210 Last month
Rankings
Dependent packages count: 6.9%
Forks count: 10.0%
Stargazers count: 11.8%
Average: 18.5%
Dependent repos count: 30.6%
Downloads: 32.9%
Maintainers (1)
Last synced: 6 months ago

Dependencies

setup.py pypi
  • lxml *