Explore this article (English)  (Spanish)

The content of this article was published (in Spanish) in the edition 25th of the digital magazine .Seguridad of UNAM-CERT.

CONTENT

• Introduction
• General model of PNAF
• Installation modes
  • Installation with installer
  • Installation with pre-configured Debian chroot tarball
  • Installation with Virtual Machine image (OVA file)
  • Installation as Perl module (advanced independent installation)
• CONFIGURATION
• POC: PCAP file analysis
  • Initial execution
  • General processing
  • Specific processing
  • Analysis and data interpretation
    • Summary from command line (stdout)
    • Web interface

Introduction

PNAF v0.1 public prototype is an implementation of a TU/e masters thesis developed as internship project at Fox-IT B.V in The Netherlands. This public prototype DOES NOT include any internal information about TU/e nor Fox-IT.

From Version 0.1.2, PNAF is a project of UNAM-Chapter [The Honeynet Project]

Main development repository

• https://dev.honeynet.org.mx/traffic-analysis/pnaf

News, updates and howtos

• http://blog.honeynet.org.mx
• http://www.honeynet.unam.mx

Resources downloads

• http://pnaf.honeynet.org.mx

Version 0.1.2 will get just minor updates (bugs/parsing) and it is the last version of 0.1.x branch. You can either clone this repository and install it on your standalone machine, or download the Virtual Machine image available on http://pnaf.honeynet.org.mx/download/

Summary

PNAF is a framework intended to provide the capability of getting a security assessment of network platforms by analysing in-depth the network traffic (in a passive way) and by providing a high-level interpretation in an automated way. It combines different analysis techniques and tools. The framework is intended to achieve the following goals:

Architecture

• To be a flexible, scalable and modular framework
• To provide accurate analysis of network platforms
• To provide a useful API in order to develop further features and improvements (not included on 0.1.2 prototype, but on 0.2.x)

Functional

• Summary of the security level of the network
• Findings of anomalous activities
• Findings of security audit policy
• Findings of impact analysis (e.g. based on CVE)
• Summary of security recommendations
• Reference of evidence

ARCHITECTURE

PNAF (original prototype) is comprised by three main modules. Each module has its own engines which manage specific tools and process the data. PNAF is written in Perl, why? because Perl rules!

DCM – DATA COLLECTION MODULE

1. NTCE – Network Traffic Capture Engine
2. NCPE – Network Traffic Pre-processing Engine

DPM – DATA PROCESSING MODULE

1. NPEE – Network Profiling and Enumeration Engine
   • p0f : Network and service enumeration
   • prads : Network and service enumeration
2. IDSE – Network Intrusion Detection Engine
   • Suricata
   • Snort
   • Bro
   • Barnyard : Unified2 reader
3. NFAE – Network Flow Analysis Engine
   • Cxtracker : Basic flow data summary
   • Argus : Flow data analysis
   • Yaf : Flow data analysis
   • Silk : Flow data analysis
   • Tcpdstat : Protocol statistics
4. DPIE – Deep Packet Inspection Engine
   • Chaosreader : Application data extraction “any-snarf”
   • Nftracker : File extraction
   • Xplico : Application data extraction (url, files, …)
   • Httpry : HTTP data logger
   • Ssldump : SSLv3/TLS data tracker
   • Dnsdump : DNS data extraction
   • PassiveDNS : Passive DNS data collection
   • Dnscap : DNS capture utility (tcpdump-like for DNS)
   • Tcpxtract : File extraction
   • Tcpdump : Pcap filtering
5. NSAE – Network Security Audit Engine
   • Pnaf-auditor

DVM – DATA VISUALIZATION MODULE (TODO — Dev)

• WDVE – Web Data Visualization Engine
• GSVE – Graphic Security Visualization Engine
• SARE – Security Audit Report Engine
• DIEE – Data Import/Export Engine

General model of PNAF

The general model of PNAF (Figure 1) defines the workflow of how PNAF decodes, filters and interprets data from network traffic capture files as single input.

Figure 1. Workflow of Passive Network Audit Framework (PNAF)

INSTALLATION MODES

PNAF includes a set of tools[2] for capturing and analysis of network traffic such as passive profilers, IDS, protocol decoders, etc. Since some of these tools are quite complex by themselves, they may involve complex installation processes as well. Thus, PNAF is designed not only to use the set of tools in an automated way, but also to facilitate their integration by implementing clean and easy ways to deploy the whole unified framework. There are four main installation modes which are explained in the sections below.

Installation using installer

PNAF includes an installer that automates the downloading, compilation and configuration of all the tools included within the framework. This installer is a shell script (bash) that provides a wizard based on dialog. In order to use this installation mode, it is necessary to meet the following requirements:

• Debian GNU/Linux 7 or later (8.x recommended) o Gentoo stage 3.x.
• Internet connection during installation process (the installer downloads and installs some libraries and other dependencies via Apt or Emerge), as well as some Perl modules through CPAN.

It may be possible to make PNAF work under Ubuntu or any other GNU/Linux distribution based on Debian APT packages. However, it would imply checking of all the libraries’ equivalences corresponding with such distributions. Moreover, it may be possible to use the installer under other systems which are not based on APT nor Emerge. To do so, you would need to install all needed dependencies manually and then make some small changes on the installer itself. For more information you can check the list of dependencies on README file. Further versions of PNAF are planned to include additional support for the installer as well as additional automated (easier) ways to deploy it (e.g. containers).

Since PNAF needs to install a lot of libraries and dependencies that may cause compatibility issues with the native system, then it is recommended to install PNAF within a chroot environment. This article explains how to perform the installation using chroot.

Thus, assuming that a Debian 8 (amd64) system is used:

1. Generation of chroot environment (via debootstrap)

  # aptitude install debootstrap
  # debootstrap --arch amd64 jessie chroot_pnaf http://ftp.nl.debian.org/debian
  # mount -t sysfs sysfs   chroot_pnaf/sys
  # mount -t proc proc     chroot_pnaf/proc
  # mount -o bind /dev     chroot_pnaf/dev
  # mount -o bind /dev/pts chroot_pnaf/dev/pts

Then switch to the chroot environment:

  # chroot chroot_pnaf
  # cd ~

2. Download PNAF

Option 1: From its official repository (main development site)

 # aptitude install git
 # git clone https://dev.honeynet.org.mx/traffic-analysis/pnaf.git

Option 2: From github (mirror)

 # git clone https://github.com/jusafing/pnaf

Once pnaf latest release is downloaded, get into the directory and execute the installer.

 # cd pnaf
 # ./install.sh

This will execute the installer wizard. First it is necessary to confirm that you want to install PNAF on the system. Afterwards, it is possible to choose what tools will be installed. Despite the fact that in version 0.1.2 not all the tools are used, it is recommended to install all the listed tools. Thus, PNAF installer by itself can be considered as an automated and easy tool to deploy a set of network traffic analysis tools..

Figure 2. Selection of tools within PNAF installer

If it is the very first time that PNAF is installed on the system, then it should be a “clean installation”. Otherwise, in case of PNAF is already on the system, a clean installation will delete any tool and configuration previously set. So, if you need to install or re-install certain too and keeping a previous configuration, then select “NO” option on this step.

Figure 3. Selection of clean installation

After this step, PNAF will start the compilation and configuration process. which may take around 30-40 minutes depending on the features of the machine. In case of any error encountered by the installer, it will show up the corresponding message and you can check the details in the files install.log (basic log)  and install.log.exec (detailed log) to identify the problem. If no problems are encountered, then the installer will show a success confirmation and PNAF will be installed on the system.

It is recommended that in order to update all the environment variables, exit out of the chroot environment and switch back again. Furthermore, it may be useful to add a tag on the chroot shell:

 # echo 'PS1="(PNAF) $PS1"' >> ~/.bashrc
 # exit
 # chroot chroot_pnaf

To verify that PNAF has been installed correctly:

# pnaf_auditor --help

Figure 4. Execution option of PNAF auditor

Installation with a preconfigured Debian chroot (tarball)

The second installation mode can be done by using a preconfigured chroot directory with all the tools already installed and configured. This mode basically avoid the whole process explained in the first installation mode (using debootstrap and run the installer). Moreover, this mode provides a way of deploying environments through the use of templates (chroot directory). In order to use this installation mode, it is only necessary to download the tarball (about 1.3 Gb) that contains the aforementioned template and then just unpack it within the local filesystem.

Note: It is important to emphasize the fact that this mode only works if the native system in which the template is used is Debian 8 (amd64), although it might be possible to make it work on any 64 bit Debian based system.

  # wget http://pnaf.honeynet.org.mx/download/chroot_pnaf.tar.bz2
  # tar -jxvf chroot_pnaf.tar.bz2
  # mount -t sysfs sysfs   chroot_pnaf/sys
  # mount -t proc proc     chroot_pnaf/proc
  # mount -o bind /dev     chroot_pnaf/dev
  # mount -o bind /dev/pts chroot_pnaf/dev/pts
  # chroot chroot_pnaf

Similarly, it can be tested that PNAF works properly by running:

 # pnaf_auditor --help

Installation by using a Virtual machine

This installation mode is very simple. It only need to download an image of a virtual machine (OVA file) that contains a pre-installed and configured PNAF environment under a Debian system. This OVA file can be imported using either VirtualBox or Vmware.

1. Download the OVA image http://pnaf.honeynet.org.mx/download/pnaf-0.1.2.ova
2. Import it on Virtual Box:

Menu  File/Import appliance/ and select the OVA file in order to create the virtual machine. This virtual machine includes a chroot directory with all the tools that the installer is able to deploy. The login credential are shown in the Welcome screen itself once the virtual machine is started.

Figure 5. Pre-configured virtual machine with PNAF environment

Once the user is logged in, it is necessary to switch to the PNAF environment included in a chroot directory.

  # mount -t sysfs sysfs   chroot_pnaf/sys
  # mount -t proc proc     chroot_pnaf/proc
  # mount -o bind /dev     chroot_pnaf/dev
  # mount -o bind /dev/pts chroot_pnaf/dev/pts
  # chroot /root/chroot_pnaf

Independent installation (advanced mode)

This installation mode is intended to be used when some tools are already installed and configured on the system, so the PNAF core itself (Perl module) is used to process all the information generated by such tools. However, it is not recommended to use this mode since it implies that a huge set of parameters need to be specified on the configuration files, which would make the framework very prone to fail. Thus, it is recommended to use any of the aforementioned installation modes instead.

If you really need to use an independent installation, then just install the Perl module:

 # cd pnaf
 # vim build/pnaf/Pnaf/lib/Pnaf/Core.pm (set all the parameters: paths, binaries, configuration files, etc.)
 # cd build/pnaf/Pnaf
 # perl Makefile.PL
 # make
 # make test
 # make install

CONFIGURATION

Version 0.1.2 takes all the configuration options directly from the arguments passed during execution. In order to see the available option of PNAF (pnaf_auditor), it can be used the following options:

 # pnaf_auditor –-help

In addition, in order to visualize the versions of the tools included on the built version:

 # pnaf_auditor –-version

In case any specific configuration is needed (e.g. a specific path or rules file for suricata, log files for prads, etc), all the configuration files within the directory /pnaf/etc can be set.

POC: Analysis of network traffic files (pcap)

This PoC will show how to perform a basic analysis of network traffic files using PNAF. It has to be emphasized that PNAF extracts and interprets information in different ways, depending the purpose and depth of the desired analysis. Thus, the information presented on this PoC does not represent all the findings that can be obtained using PNAF.

The following table describes the kind of information and purpose obtained on this general analysis.

Initial execution

General processing:

Having the PCAP file test1.cap, pnaf_auditor is executed as follows:

 # pnaf_auditor –-cap test1.cap –log_dir /pnaf/www/test1

These options specify that the file will be taken by the tools used by PNAF and the output data will be stored within /pnaf/www/test1 directory.

Figure 6. PNAF generic processing execution

Specific processing

Now, assuming that a more specific analysis is needed, it is possible to execute pnaf_auditor using the following options:

 # pnaf_auditor –-cap test2.cap –log_dir /pnaf/www/test2 --home_net 192.168.1.0/24 –-payload

With these parameters pnaf_editor will analyze the pcap file test2.cap, taking the network segment 192.168.1.0/24 as “home_net”, which is the internal network of theorganization. It is possible to specify the home_net using CIDR format. Furthermore, it is specified that payloads will be decoded in case any IDS alert is triggered. This is specially useful to analyse and identify potential false positives.

Analysis and data interpretation

In order to get a basic meaningful information, based on a bunch of raw data, the analysis can be done through different stages.

1.  Command line logs (execution stdout)

Logs generated during the execution are displayed on the standard output (Figure 7 below). This phase is important since the analyst can check what tools are being used to retrieve raw logs, as well as the basic overview of parsed events and assets audit.

Figure 7. Execution log and summary

2.      Web visualization

PNAF provides a basic web visualization that includes the following data:

• Raw data logs generated by all the tools included on the PNAF built
• Pre-processed logs in JSON format
• Audit data processed logs in JSON format displayed on a JSON viewer.

All JSON data generated by PNAF can be used and interpreted within the framework itself, however it is important to emphasize that such data can be also exported to feed data analysis systems such as SIEM.

In order to use the basic web visualization, it is necessary to enable the web server Apache.

 # apachectl start

By default, all the findings are stored in /pnaf/www directory. When pnaf_auditor is executed, –log_dir option can be used to specify that the output directory is set directly within the webdir. In the running example the output directory was set on /pnaf/www/test2 which can be accessed directly through a web browser on http://localhost or the corresponding IP address of the server where PNAF has been deployed.

Figure 8. PNAF basic web visualization

The web directory has the following structure (practical example on Figure 9):

DIRECTORY_NAME/                 (Raw logs generated by tools)
 |
 |----- JSON/                    (Parsed files in JSON format)
 |       |
 |       |---SUMMARY/            (JSON tree view of dataset and audits)
 |       |   |                   (This is the main basic visualizer)
 |       |   |
 |       |   |---dataset         (Parsed data of all toolsets)
 |       |   |---auditSummary    (Summary of audit information)
 |       |   |---dataset.html    (All software found within trafic)
 |       |   |---auditOutput     (Audit based on CVE (NIST) and software)
 |       |   |---dataset.html    (Audit data sorted per single asset)
 |       |
 |       |-------VIEW1/          (Alternative JSON viewer)
 |       |
 |       |-------VIEW2/          (Deprecated)

Figure 9. Files generated for web visualization

The analysis of this PoC is performed from general data to specific findings. First, it is useful to review the file  json/summary/dataset.html. Here, the analyst can visualize data logs generated by all the tools using JSON viewers. Each tree has two main categories:

• Summary: it contains the summary of findings
• Tracking: It contains data sorted out by single asset

Depending on the depth of the analysis, it is possible to dig into details on each dataset, as well as perform searching using the textbox embedded on the viewer.

Figure 10. Dataset of tools used in PNAF

The next step on the analysis involves checking the parsed and correlated data stored on the file /json/summary/auditSummary.html . Here, the analyst can visualize detailed information of each asset identified on the network traffic. For instance, it is possible to review information about URLs, SSL certificates, IDS alerts, transferred files, software, etc. Moreover, it is possible to review the audit correlation through a Tracking category (just as the main dataset explained before), in which audit data is sorted out by single asset. In order to do so, the file /json/summary/auditTracking.html can be accessed.

Figura 11. Audit summary. Main correlation

Figure 12. Audit summary. Tracking category (sorted by assets)

Finally, the file /json/summary/auditOutput.html  shows findings about vulnerabilities in software identified within the network traffic, based on CVE database[3]. This analysis includes a score that measures the impact of the aforementioned vulnerabilities. Furthermore, a list of assets identified within blacklists (IP & domain name based and taken from trusted sources: e.g. EmergingTheats DB) is presented.

Figure 13. Audit summary. Vulnerability and blacklisted asset analysis based on trusted databases

Taking into consideration all the data gathered by the tools, the information interpreted by PNAF, as well as the meaningful (specific) interpretation performed by the analyst herself, then a big picture of the context and characteristics of the network can be determined. In fact, the kind of information that should be filtered and put focus on, depends upon the kind of problem, context and issue that needs to be identified.

It is very important to note that PNAF is prone to false positives due to the nature of PNA itself, in which the single input and potential lack of complete datasets (e.g. actual logs from applications, etc) may cause a miss interpretation and inaccurate correlation, leading to inaccurate findings that need to be verified manually by the analyst himself.

Currently PNAF is under development. Version 0.1.2 is the last version of 0.1 branch. Next versions will include improvements mainly on the visualization of the results, stability, ease of deployment and integration with external software for data analysis. For additional information you can follow the activities on the official blog of the UNAM-Chapter of the Honeynet Project and its development repository:

• http://blog.honeynet.org.mx
• https://dev.honeynet.org.mx/traffic-analysis/pnaf
• http://www.honeynet.unam.mx

References

[1] Passive Network Audit Framework, Master thesis. Santillan, Javier. Eindhoven University of Technology. The Netherlands. 2014

[2]Tabla 1. “Herramientas de análisis de tráfico de red” del artículo anterior

[3] https://cve.mitre.org/

Feel free to ask anything or request help for development

miguelraulb at gmail dot com

Installation Requirements on Debian (base) 6.x, 7.x

• Perl 5.10.1
• CPAN Modules
  • IO::Socket
  • Mail::MboxParser
  • LWP::Simple
  • LWP::UserAgent
  • experimental
  • DBI
  • DBD::mysql
  • Digest::MD5::File
• MySQL Server

Installation Linux Debian installation instructions

Execution

Once you have all the modules installed you just have to create a database called spampot or whatever you wish to name it, create a user with password and then assign the name of your database to the user you’ve already created.

Please set this values on the spampot-ng.conf file.

In order to run the tool you have to run it with sudo or using a wrapper as authbind, here are the instructions

sudo perl spampot-ng.pl
authbind --deep perl spampot-ng.pl

Author

Miguel Raúl Bautista Soria

PNAF v0.1.1 public prototype is an implementation of a TU/e master thesis developed as internship project at Fox-IT B.V in The Netherlands. This public prototype DOES NOT include any internal information about TU/e nor Fox-IT.

From Version 0.1.2, PNAF is a project of UNAM-Chapter [The Honeynet Project]

Main development site

• https://dev.honeynet.org.mx/traffic-analysis/pnaf

Updates, news and howtos

• http://blog.honeynet.org.mx
• http://pnaf.honeynet.org.mx
• http://www.honeynet.unam.mx
• http://sec.jusanet.org

Version 0.1.2 will get just minor updates (bugs/parsing) and it is the last version of 0.1.x branch. You can either clone this repository and install it on your standalone machine, or download the pre-installed sources available on http://pnaf.honeynet.org.mx/download/

• Virtual Machine image – (OVA file)
• (Debian 8) Chroot directory with a pre-compiled and full installed PNAF – (tar.gz)

The next version of PNAF is 0.2.x and it is the current main dev project. It will contain significant changes (dockerized?, improved installation, parsing, daemon model, multi-threading support, etc). If you have any feedback/idea please drop an email (see contact information below).

SUMMARY

PNAF is a framework intended to provide the capability of getting a security assessment of network plattforms by analysing in-depth the network traffic (in a passive way) and by providing a high-level interpretation in an automated way. It combines different analysis techniques and tools. The framework is intended to achieve the following goals:

Architecture

• To be a flexible, scalable and modular framework
• To provide accurate analysis of network plattforms
• To provide a useful API in order to develop further features and improvements (not included on 0.1.2 prototype, but on next 0.2.x)

Functional

• Summary of the Security Level of the network
• Findings of anomalous activities
• Findings of security audit policy
• Findings of impact analysis (e.g. based on CVE)
• Summary of security recommendations
• Reference of evidence

ARCHITECTURE

PNAF is comprised by three main modules. Each module has its own engines which manage specific tools and process the data.
PNAF is written in Perl, why? because Perl rules!

DCM – DATA COLLECTION MODULE

1. NTCE – Network Traffic Capture Engine
2. NCPE – Network Traffic Pre-processing Engine

DPM – DATA PROCESSING MODULE

1. NPEE – Network Profiling and Enumeraton Engine
   • p0f : Network and service enumeration
   • prads : Network and service enumeration
2. IDSE – Network Intrusion Detection Engine
   • Suricata
   • Snort
   • Bro
   • Barnyard : Unified2 reader
3. NFAE – Network Flow Analysis Engine
   • Cxtracker : Basic flow data summary
   • Argus : Flow data analysis
   • Yaf : Flow data analysys
   • Silk : Flow data analysys
   • Tcpdstat : Protocol statistics
4. DPIE – Deep Packet Inspection Engine
   • Chaoreader : Application data extraction “any-snarf”
   • Nftracker : File extraction
   • Xplico : Application data extraction (url, files, …)
   • Httpry : HTTP data logger
   • Ssldump : SSLv3/TLS data tracker
   • Dnsdump : DNS data extraction
   • Passivedns : Passive DNS data collection
   • Dnscap : DNS capture utility (tcpdump-like for DNS)
   • Tcpxtract : File extraction
   • Tcpdump : Pcap filtering
5. NSAE – Network Security Audit Engine
   • Pnaf-auditor

DVM – DATA VISUALIZATION MODULE (TODO — Dev)

• WDVE – Web Data Visualization Engine
• GSVE – Graphic Security Visualization Engine
• SARE – Security Audit Report Engine
• DIEE – Data Import/Export Engine

The current version has been tested on GNU/Linux Debian (6.x or later) and Gentoo (Stage 3) distributions. The main installer prepares automatically the whole environment by compiling all the tools included within the framework as well as their dependencies.

Since the installer downloads some packages using either apt or emerge depending on the distribution, then the installer needs to have access to Internet. Otherwise you can use the option ‘–no-packages’ and then install by yourself the following packages/libraries:

APT packages:

autoconf automake binutils-dev bison build-essential byacc ccache cmake dsniff flex g++ gawk gcc libcap-ng-dev libcli-dev libdatetime-perl libdumbnet-dev libfixposix0 libfixposix-dev libgeoip-dev zlib1g zlib1g-dev libgetopt-long-descriptive-perl libglib2.0-cil-dev libjansson4 libjansson-dev libldns-dev liblzo2-2 libnet1-dev libmagic-dev libmysql++3 libmysqlclient-dev libmysql++-dev libnacl-dev libncurses5-dev libldns1 libnetfilter-conntrack-dev libnetfilter-queue1 libnetfilter-queue-dev libnet-pcap-perl libnfnetlink0 libnfnetlink-dev libnl-3-dev libnl-genl-3-dev libpcap-dev libpcre3 libpcre3-dbg libpcre3-dev libsqlite3-dev libssl-dev liburcu-dev libyaml-0-2 libyaml-dev liblzo2-dev openssl pkg-config python-dev python-docutils sqlite3 swig git-core libglib2.0-dev libtool tcpslice tcpick tshark tcpflow ethtool

Emerge sources

autoconf automake binutils bison libtool byacc ccache cmake flex gawk gcc dev-util/cmake sys-libs/libcap-ng dev-perl/glib-perl dev-libs/jansson dev-libs/lzo net-libs/libnet dev-libs/libnl virtual/perl-libnet dev-libs/geoip net-libs/libnetfilter_queue net-libs/libnetfilter_conntrack perl-core/libnet dev-perl/Net-PcapUtils dev-perl/Net-Pcap net-libs/libnfnetlink dev-db/sqlite dev-libs/libyaml dev-lang/swig net-analyzer/tcpflow dev-libs/libcli net-analyzer/dsniff dev-perl/DateTime ethtool

Additionally you need to install the following Perl Modules

Config::Auto Pod::Usage  Proc::Daemon IO::CaptureOutput JSON:XS Cwd JSON::Parse Time::Piece Exception::Class Test::Warn Test::Differences Test::Deep Test::Most HTTP::BrowserDetect Getopt::Long String::Tokenizer URI::Encode Devel::Hexdump  Digest::MD5 Data::Dumper YAML NetPacket::Ethernet Net::Subnet

INSTALLATION

Installer

You can install the whole framework (i.e. including the tools) by using the installer script. It has been tested on both Debian 7.x / Gentoo Stage 3 based systems (clean installation, base system, chrooted)

./install.sh

Alternatively you can install the Core Framework (without tools) by using the Makefile. In such a case you need to specify a bunch of option within the PNAF configuration file (binary files, configuration files, log dirs,..). For more information check out the ‘build/pnaf/etc/pnaf.conf’ file.

To install this module type the following:

$ cd build/pnaf/Pnaf
$ perl Makefile.PL
$ make
$ make test
# make install  // (as root)

Chroot

To use the CHROOT way, just download the chroot directory, unpack it in your
local file system and just execute the following:

# chroot chroot_pnaf

(This README file will be shown when you switch to that directory)

NOTE: This way just works using Debian 8 amd64.

Virtual Machine

Import the OVA image using VirtualBox or Vmware. Login credentials are given in the welcome login screen. (You may need to change/add virtual network interfaces to meet local configuration requirements)

USAGE

$ pnaf_auditor [options]

Options:

Execution:
--debug                 : Enable debug mode
--conf                  : Specify configuration file (yaml)
--help                  : Show this
--version               : Show tools versions
--parser arg1[,arg2]    : Specify parsers to be loaded
    'p0f'               : Process enumeration data
    'prads'             : Process enumeration data
    'argusFlow'         : Process NFA data (flow analysis)
    'snortAppId'        : Process enumeration data (App identification)
    'httpry'            : DPI over HTTP (URL's, UA, etc)
    'tcpdstat'          : Process enumeration data (protocol dist)
    'suricataEve'       : Process IDS data (alerts and payloads)
    'bro'               : DPI over different protocols
    'tcpflow'           : Process NFA data (session tracking)
--out_dataset           : Specify the kind of output data to generate
    'all'               : Generate all datasets
    'audit'             : Generate only audit dataset
--home_net              : Specify the 'homenet' in CIDR format
--payload               : Flag to enable payload decoding (IDS data)

Inputs:
--cap_file              : Set input capture file (pcap)
--audit_dict            : Path to vulnerability dictionary
--instance_dir          : Path to directory with 'initial raw dataset'

Logging:
--log_dir       : Path to log directory
--log_file      : Path to output directory

Examples

Perform a basic execution: All parsers/tools enabled

    $ pnaf_auditor --cap_file test1.cap --log_dir /pnaf/www/test1

Perform analysis of existing “raw logs” from tools

Note: input directory must contains actual raw logs that are generated by Tools (e.g. Snort unified2 files, Suricata JSON output, p0f logs, etc

$ pnaf_auditor --instance_dir existinglogs --log_dir /pnaf/www/exlogs

Perform analysis of IDS tools only

$pnaf_auditor --cap_file test2.cap --log_dir /pnaf/www/test2 --parser bro,snort,suricataEve

Perform analysis with homenet: When a homenet is specified, audit is focused only on homenet IP addresses/networks and Flow data (stats) are separated from External networks (useful to identify usage and filter out devices)

$pnaf_auditor --cap_file test3.cap --log_dir /pnaf/www/test3 --homenet 192.168.1.0/14,192.168.2.30/27

Perform analysis decoding payloads from unified2 file (Snort) stored within a certain existing directory.

$pnaf_auditor --instance_dir mysnortfiles --payload

WEB VISUALIZATION

A (very) basic Web visualization can be used within PNAF.

First, To start HTTP daemon:

# /pnaf/bin/apachectl

Then, when executing pnaf_auditor, place output directories within /pnaf/www/. If you already got some outpudt directories, then copy them to this path.

Output data stored in ‘–log_dir’ contains a tree as follows:

DIRECTORY_NAME/                     (Raw logs genrated by tools)
|
|----- JSON/                        (Parsed files in JSON format)
|       |
|       |---SUMMARY/            (JSON tree view of dataset and audits)
|       |   |                   (This is the main basic visualizer)
|       |   |
|       |   |---dataset         (Parsed data of all toolsets)
|       |   |---auditSummary    (Summary of audit information)
|       |   |---dataset.html    (All software found within trafic)
|       |   |---auditOutput     (Audit based on CVE (NIST) and software)
|       |   |---dataset.html    (Audit data sorted per single asset)
|       |
|       |-------VIEW1/          (Alternative JSON viewer)
|       |
|       |-------VIEWs/          (Deprecated)

COPYRIGHT AND LICENSE

Copyright (C) 2014 by Javier Santillan

### Disclaimer

This framework contains external tools that have their own licenses. For more information about licensing you can read the corresponding licence files that are included within the tarballs that this framework uses for an automated installation. Such packages have not been modified and any information about licenses/authors is as it can be found on the corresponding releases (oficial websites, github, etc). For more information of versions used by this framework, you can check out the ‘–version’ option of pnaf_auditor.

PNAF does not claim any rights, modifications nor ownerships. The PNAF core itself (Perl module included on this tarball within build/pnaf), is authored by -Javier Santillan- and the licence cited below applies only to PNAF itself.

PNAF core is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/. Also add information on how to contact you by electronic and paper mail.

PNAF v0.1.2 Copyright (C) 2014 Javier Santillan This program comes with ABSOLUTELY NO WARRANTY; for details type `–help’
option on pnaf_auditor. This is free software, and you are welcome to redistribute it under certain conditions.

TODO

• Provide a complete plattform-independent installation (Docker)
• Add additional parsers (for all tools within the framework)
• Frontend?
• Prototype version 0.1.2. Some parsers/functionalities from the original prototype are not included… YET. Next release will contain additional parsers/features

CONTACT

For further updates visit:

• http://blog.honeynet.org.mx
• http://sec.jusanet.org

Oficial websites

• http://pnaf.honeynet.org.mx
• http://pnaf.jusanet.org

Related posts/info/howtos

• http://www.honeynet.unam.mx

Email

• Javier Santillan [email protected]
• HoneynetProject UNAM-Chapter [email protected]

,