Helper tools
Helper binaries
nevisProxy comes with some helper tools. These tools are usually preset in the configuration files, for example the log rotation tool bclogmgr or the passphrase getter keystorepwget. But you can use some tools for testing and debugging issues, too.
| Name | Description |
|---|---|
| base62 | Base62 encoding and decoding tool. |
| bclogmgr | Log file rotation tool used by nevisProxy. See usage below. |
./bclogmgr [ pidfile=<file> ] [ size=<num> ] [ time=<time> ] [ compression=<command> ]
./bclogmgr [ archives=<num> ] [ archivedir=<dir> ] [ archivefmt=<format> ] [persistent] [input=<file>] <logfile>
persistent: Disables program termination on EOF. It is useful when reading from named pipes. input: A file which gives the log's input. Default is standard input.
| Name | Description |
|---|---|
| bcxmlparser | A simple XML parser with limited XPath support. |
| bin2hex | Prints out the hexadecimal representation of the input. |
| keystorepwget | Script to access the passphrase of certificates. For more information, see the bc.security.PassPhraseDialog low level property (chapter "Low-level properties"). |
| nevisproxy_pkcs11 | The nevisproxy_pkcs11 command allows the dumping of information and contents of PKCS#11 (Cryptoki) devices. For more information, see “Appendix E”. |
| openssl | The most recent version of OpenSSL shipped by nevisProxy. Can be used to generate certificates, DH parameters, etc. |
mod-qos utilities
The Apache module mod_qos provides optional tools for log data processing and analysis. For more information on these tools, see the official mod_qos documentation.
| Name | Description |
|---|---|
| qscheck | Monitor tool testing the TCP connectivity to servers used by mod_proxy. |
| qsdt | Simple tool to measure the elapsed time between related log messages. |
| qsexec | Command execution triggered by patterns within log files. |
| qsfilter2 | Rule generator. Creates *QS_Permit** directives and rule patterns from audit log files. |
| qsgeo | Adds the country code for the client IP address within a log file. |
| qsgrep | Searches a file for a pattern and prints the data in a new format. |
| qshead | A utility that reads from stdin and prints all lines to stdout until reaching the defined pattern. |
| qslog | A real time TransferLog/CustomLog data analyzer. It reads the per request log data from stdin and generates statistic records every minute. qslog collects request statistics (req/sec, bytes/sec, status codes, response times, memory consumption, server load) every minute and writes the collected data to the configured log file. This utility can be configured within the navajo.xml file as shown in the template that comes with the nevisProxy package. For more information, see the chapter “Syslog log data forwarding”. |
| qslogger | Shell command interface to the syslog(3) system log module. |
| qsre | Regular expression (pcre) pattern match test tool. |
| qsrespeed | Compares the expected processing time per regular expression. |
| qsrotate | Log rotation tool similar to Apache's rotatelogs. |
| qssign | A log data integrity check tool. It reads log data from stdin (pipe) and writes the signed data to stdout adding a sequence number and signature to every log line.qssign.rb is a Logstash filter plug-in that you can use to verify the signatures of log messages in real time. |
| qstail | Shows the end of a log file beginning at a defined pattern. |
| ipfilter | Simple tool to replace/hide IP addresses in log files. |
| wlsg | Internal binary for rule generation for the self-learning feature of input validation. |
Internal binaries
| Name | Description |
|---|---|
| apachesv_2_4 | Internal binaries used by nevisProxy. |
| navajosv2_4 | |
| nevisproxy | |
| nevisproxy2_4 |