nipper.conf(12)

NAME
nipper.conf - Configuration file for Nipper.

DESCRIPTION
Nipper can be configured in three different ways. The first is through the command line options, this will override the other two configuration methods. The second is through an external configuration file, which is documented in this help document. Lastly, Nipper will fall back on its built-in default configuration settings. The main nipper.conf file is usually located at /etc/nipper.conf, though an alternative configuration file can be specified as a command line parameter.

The configuration settings outlined below are case-insensitive. Furthermore, Options that require a yes/no type answer can also be answered with true/false or on/off. Comment lines start with a # character.

General Section
Device Type
This changes the default device type. The choices are; Cisco Router (IOS), Cisco Switch (IOS), Cisco Catalyst (IOS), Cisco Catalyst (NMP), Cisco Catalyst (CatOS), Cisco Firewall (PIX), Cisco Firewall (ASA), Cisco Firewall (FWSM), Cisco Content Services Switch (CSS), Juniper ScreenOS Firewall, Nortel Passport, Checkpoint Firewall-1 or SonicWall SonicOS Firewall

Model
Specify the device model, this is useful for setting defaults.

Location
This tells Nipper where the device is being used. Is it an "Internal" device or an "Edge" device.

Force Type
This bypasses the Nipper configuration type checks and forces Nipper to treat the configuration file as the device type specified. The choices are; yes or no.

Report Section

Company Name
This changes the company name used throughout the report. The default is to use Nipper.

Show Passwords In Report
Used to enable or disable the output of passwords (encoded or otherwise) to the report. The options are; yes or no.

Convert Names To IP Addresses
As it suggests, names are converted to IP addresses in the report output. Options are; yes or no.

Report Format
This setting changes the default report format, the built-in default is HTML. The options are; HTML, XML, LATEX or TEXT.

HTML Section

Style Sheet File
The name of the HTML stylesheet to be used with the HTML report. If not specified, Nipper will use a built-in stylesheet.

Latex Section

Paper Size
The Latex paper size to use, the default is a4paper.

Document Class
The Latex document class to use, the default is article.

Report Sections Section

Security Audit
Output a security audit report section. Options are; on or off.

Appendix
Output an appendix section in the report. Options are; on or off.

Abbreviations
Output an abbreviations appendix section in the report. Options are; on or off.

Common Ports
Output a common ports appendix section in the report. Options are; on or off.

Logging Levels
Output a logging levels appendix section in the report. Options are; on or off.

Time Zones
Output a time zones appendix section in the report. Options are; on or off.

Nipper Details
Output a nipper details appendix section in the report. Options are; on or off.

Audit Section

Dictionary File
A dictionary file to use with password testing. If not specified a small built-in dictionary is used. The dictionary file must contain one password per line.

Minimum Password Length
The minimum length that passwords / authentication keys should be. The default is 8 characters.

Passwords Must Include Uppercase
Passwords / authentication keys must include uppercase characters. Options are; on or off.

Passwords Must Include Lowercase
Passwords / authentication keys must include lowercase characters. Options are; on or off.

Passwords Must Include Lowercase or Uppercase
Passwords / authentication keys must include lowercase or uppercase characters. Options are; on or off.

Passwords Must Include Numbers
Passwords / authentication keys must include numbers. Options are; on or off.

Passwords Must Include Special Characters
Passwords / authentication keys must include special / punctuation characters. Options are; on or off.

Check For Any Source
Firewall filters should not allow access from any source. Options are; on or off.

Check Source Rules Do Not Include Networks
Firewall filters should not allow access from a network source. Options are; on or off.

Check For Any Source Service
Firewall filters should not allow access from any source port. Options are; on or off.

Check For Any Destination
Firewall filters should not allow access to any destination. Options are; on or off.

Check Destination Rules Do Not Include Networks
Firewall filters should not allow access to a network destination. Options are; on or off.

Check For Any Destination Service
Firewall filters should not allow access to any destination service. Options are; on or off.

Check That All Rules Log
All firewall filters should log. Options are; on or off.

Check That All Rules Log
No disabled firewall filters should exist. Options are; on or off.

Check Rule Lists End With Deny All And Log
All firewall filter lists shoud end with a deny everything and log. Options are; on or off.

Check For Reject Rules
No firewall reject rules should exist, these are deny rules that inform the sender. Options are; on or off.

Check For Bypass Rules
No firewall bypass rules should exist, these are rules that bypass filtering. Options are; on or off.

Check For Default Rules
No firewall default rules should exist, these are rules that default to a ports filtering setting. Options are; on or off.

Minimum Timeout (Seconds)
The number of seconds that timeouts should be configured for. The default is 600.

AUTHOR
Nipper was developed by Ian Ventura-Whiting (Fizz).

COPYRIGHT
Copyright © 2006-2008 Ian Ventura-Whiting.
This is free software. You may redistribute copies of it under the terms of the GNU General Public License v3 or above <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.

SEE ALSO
nipper(1)