outputpbnj [Query Options] [Database Options] [General Options]

 OutputPBNJ uses a query yaml config file to execute queries against 
 the PBNJ 2.0 database. OutputPBNJ returns the result in various 
 output types (csv, tab and html).

 Apart of PBNJ 2.0 suite of tools to monitor changes on a network.

 Usage: outputpbnj [Query Options] [Config Options] [General Options]
 Query Options:
   -q  --query <name>     Perform sql query
   -t  --type <type>      Output Type [csv,tab,html]
   -f  --file <file>      Store the result in file otherwise stdout
       --both             Print results and store them in a file
       --dir <dir>        Store the result in this directory [def .]

   -l  --lookup <name>    Lookup description based on name
       --list             List of names and descriptions
   -n  --name             Lookup all the names
   -d  --desc             Lookup all the descriptions
   -s  --sql              Lookup all the sql queries

 Config Options:
        --qconfig <file>  Config of sql queries [def query.yaml]
        --dbconfig <file> Config for accessing database [def config.yaml]        
        --dbdir <dir>     Directory for Config file [def .]

        --data <file>     SQLite Database override [def data.dbl]

 General Options:
       --test <level>     Test Level
       --debug <level>    Verbose information
   -v  --version          Display version
   -h  --help             Display this information

 Send Comments to Joshua D. Abraham ( [email protected] )

THINGS TO NOTE

 * OutputPBNJ requires root privileges to query a database that is
 owned by root. Thus, if you are scanning with ScanPBNJ you will need
 to run OutputPBNJ with root privileges to access the database.

 * If there are configs in the current directory, they are used
 instead of those in the user's config directory.

Query Options

-q --query <name> Perform sql query

-t --type <type> Output Type [csv,tab,html]

-f --file <file>

--both

--dir <dir> Store the result in this directory [default .]

-l --lookup <name>

--list List of names and descriptions

-n --name

-d --desc

-s --sql

Config Options

--qconfig <file>

 This option is used to specify an alternative query.yaml file.

--dbconfig <file>

 This option is used to specify an alternative config.yaml file.

--dbdir <dir>

 This option is used to specify an alternative directory for the
 config.yaml file.

GENERAL OPTIONS

--test <level>

 This option is also used for reporting bugs. All bug reports should
 be submitted using --test 1 and an additional report may be needed
 depending on the issue

--debug <level>

-v --version

-h --help Display this information

 PBNJ's data files are stored in ScanPBNJ and OutputPBNJ. When either
 of these programs is run the configuration files will be generated
 for the user if they do not already exists and placed in the
 $HOME/.pbnj-2.0 directory. Again, if there is a configuration file in
 the current directory it is used instead of the version in the
 configuration directory.

 $HOME/.pbnj-2.0/config.yaml - holds settings for connecting to the
 database which store the information from PBNJ scans.

 $HOME/.pbnj-2.0/query.yaml - lists all queries that can be used to
 retrieve information from the database. Also, includes the name and
 description for each query. This is only generated when you executed
 OutputPBNJ.

 For Windows, the pbnj-2.0 config directory is in the APPDATA
 directory, which contains both config.yaml and query.yaml. Depending
 on your environment, the APPDATA directory may be a different location
 from other environments. Therefore, when the configs are executed for
 the first time they will display the path where the configs were 
 generated.

QUERY

 The query.yaml file contains the list of various names, descriptions
 and sql queries that can be executed by OutputPBNJ.

 Here is one example:

 - name: vulnssh
   desc: list all of the services that have old ssh running
   sql: |-
    select S.updated_on,M.ip,S.service,S.port,S.version from services
    as S, machines as M where service='ssh' and state='up' and
    version!='4.1p1'

 This examples shows how the name, description and sql are layed out in
 the yaml format. Therefore, we know the name of the query is vulnssh
 and it's purpose is to list SSH servers which are not running
 a version 4.1p1. It is very easy to create another script that would
 check for the latest version of a given service and therefore the
 user would be able to verify that that particular service needed to
 be updated on the machine that was scanned.

FEATURE REQUESTS

 The following databases are supported:

 * SQLite [default]
 * MySQL
 * Postgres
 * CSV

DATABASE SCHEMA

 The following is the SQLite version of the database schema:

 CREATE TABLE machines (
            mid INTEGER PRIMARY KEY AUTOINCREMENT,
            ip TEXT,
            host TEXT,
            localh INTEGER,
            os TEXT,
            machine_created TEXT,
            created_on TEXT);
 CREATE TABLE services (
            mid INTEGER,
            service TEXT,
            state TEXT,
            port INTEGER,
            protocol TEXT,
            version TEXT,
            banner TEXT,
            machine_updated TEXT,
            updated_on TEXT);

 Joshua D. Abraham ( [email protected] )

LEGAL NOTICES