Metadata-Version: 2.1
Name: nessus_file_reader
Version: 0.2.0
Summary: nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module created to quickly parse nessus files containing the results of scans performed by using Nessus by (C) Tenable, Inc.
Home-page: https://github.com/LimberDuck/nessus-file-reader
Author: Damian Krawczyk
Author-email: damian.krawczyk@limberduck.org
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Description-Content-Type: text/x-rst
License-File: LICENSE

nessus file reader by LimberDuck
################################

*nessus file reader* by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python
module created to quickly parse nessus files containing the results of scans
performed by using Nessus by (C) Tenable, Inc. This module will let you get
data through functions grouped into categories like file, scan, host and
plugin to get specific information from the provided nessus scan files.

|license| |repo_size| |code_size| |supported_platform|


.. class:: no-web no-pdf

.. contents::

.. section-numbering::

Main features
=============

* read data from nessus files containing results of scans performed by using Nessus by (C) Tenable, Inc.
* use `nfr_example_script.py`_. to see examples

Usage
=====
1. Install *nessus-file-reader* module.

    .. code-block:: bash

        pip install nessus-file-reader

2. Import *nessus-file-reader* module.

    .. code-block:: python

        import nessus_file_reader as nfr

3. Use *file* functions to get details about provided file e.g. root, file name, file size.

    .. code-block:: python

        nessus_scan_file = './your_nessus_file.nessus'
        root = nfr.file.nessus_scan_file_root_element(nessus_scan_file)
        file_name = nfr.file.nessus_scan_file_name_with_path(nessus_scan_file)
        file_size = nfr.file.nessus_scan_file_size_human(nessus_scan_file)
        print(f'File name: {file_name}')
        print(f'File size: {file_size}')

4. Use *scan* functions to get details about provided scan e.g. report name, number of target/scanned/credentialed hosts, scan time start/end/elapsed and more.

    .. code-block:: python

        report_name = nfr.scan.report_name(root)
        number_of_target_hosts = nfr.scan.number_of_target_hosts(root)
        number_of_scanned_hosts = nfr.scan.number_of_scanned_hosts(root)
        number_of_scanned_hosts_with_credentialed_checks_yes = nfr.scan.number_of_scanned_hosts_with_credentialed_checks_yes(root)
        scan_time_start = nfr.scan.scan_time_start(root)
        scan_time_end = nfr.scan.scan_time_end(root)
        scan_time_elapsed = nfr.scan.scan_time_elapsed(root)
        print(f' Report name: {report_name}')
        print(f' Number of target/scanned/credentialed hosts: {number_of_target_hosts}/{number_of_scanned_hosts}/{number_of_scanned_hosts_with_credentialed_checks_yes}')
        print(f' Scan time START - END (ELAPSED): {scan_time_start} - {scan_time_end} ({scan_time_elapsed})')

5. Use *host* functions to get details about hosts from provided scan e.g. report hosts names, operating system, hosts scan time start/end/elapsed, number of Critical/High/Medium/Low/None findings and more.

    .. code-block:: python

        for report_host in nfr.scan.report_hosts(root):
            report_host_name = nfr.host.report_host_name(report_host)
            report_host_os = nfr.host.detected_os(report_host)
            report_host_scan_time_start = nfr.host.host_time_start(report_host)
            report_host_scan_time_end = nfr.host.host_time_end(report_host)
            report_host_scan_time_elapsed = nfr.host.host_time_elapsed(report_host)
            report_host_critical = nfr.host.number_of_plugins_per_risk_factor(report_host, 'Critical')
            report_host_high = nfr.host.number_of_plugins_per_risk_factor(report_host, 'High')
            report_host_medium = nfr.host.number_of_plugins_per_risk_factor(report_host, 'Medium')
            report_host_low = nfr.host.number_of_plugins_per_risk_factor(report_host, 'Low')
            report_host_none = nfr.host.number_of_plugins_per_risk_factor(report_host, 'None')
            print(f'  Report host name: {report_host_name}')
            print(f'  Report host OS: {report_host_os}')
            print(f'  Host scan time START - END (ELAPSED): {report_host_scan_time_start} - {report_host_scan_time_end} ({report_host_scan_time_elapsed})')
            print(f'  Critical/High/Medium/Low/None findings: {report_host_critical}/{report_host_high}/{report_host_medium}/{report_host_low}/{report_host_none}')

6. Use *plugin* functions to get details about plugins reported in provided scan e.g. plugins ID, plugins risk factor, plugins name.

    .. code-block:: python

        print('\tPlugin ID\t\tRisk Factor\t\t\t\tPlugin Name')
        report_items_per_host = nfr.host.report_items(report_host)
        for report_item in report_items_per_host:
            plugin_id = int(nfr.plugin.report_item_value(report_item, 'pluginID'))
            risk_factor = nfr.plugin.report_item_value(report_item, 'risk_factor')
            plugin_name = nfr.plugin.report_item_value(report_item, 'pluginName')
            print('\t', plugin_id, '  \t\t\t', risk_factor, '  \t\t\t', plugin_name)

7. If you want to get output for interesting you plugin e.g. "Nessus Scan Information" use below function

    .. code-block:: python

        for report_host in nfr.scan.report_hosts(root):
            pido_19506 = nfr.plugin.plugin_output(root, report_host, '19506')
            print(f'Nessus Scan Information Plugin Output:\n{pido_19506}')

8. If you know that interesting you plugin occurs more than ones for particular host e.g. "Netstat Portscanner (SSH)" use below function

    .. code-block:: python

        for report_host in nfr.scan.report_hosts(root):
            pidos_14272 = nfr.plugin.plugin_outputs(root, report_host, '14272')
            print(f'All findings for Netstat Portscanner (SSH): \n{pidos_14272}')


Meta
====

Change log
----------

See `CHANGELOG`_.


Licence
-------

GNU GPLv3: `LICENSE`_.



Authors
-------

`Damian Krawczyk`_ created *nessus file reader* by LimberDuck.

.. _Damian Krawczyk: https://limberduck.org
.. _CHANGELOG: https://github.com/LimberDuck/nessus-file-reader/blob/master/CHANGELOG.rst
.. _LICENSE: https://github.com/LimberDuck/nessus-file-reader/blob/master/LICENSE
.. _nfr_example_script.py: https://github.com/LimberDuck/nessus-file-reader/blob/master/nfr_example_script.py

.. |license| image:: https://img.shields.io/github/license/LimberDuck/nessus-file-reader.svg
    :target: https://github.com/LimberDuck/nessus-file-reader/blob/master/LICENSE
    :alt: License

.. |repo_size| image:: https://img.shields.io/github/repo-size/LimberDuck/nessus-file-reader.svg
    :target: https://github.com/LimberDuck/nessus-file-reader

.. |code_size| image:: https://img.shields.io/github/languages/code-size/LimberDuck/nessus-file-reader.svg
    :target: https://github.com/LimberDuck/nessus-file-reader

.. |supported_platform| image:: https://img.shields.io/badge/platform-windows%20%7C%20macos%20%7C%20linux-lightgrey.svg
    :target: https://github.com/LimberDuck/nessus-file-reader
