From 0b6f9655a804b6edea84cfb443f17b08ea8d355d Mon Sep 17 00:00:00 2001 From: "Robert J. Hansen" Date: Sat, 2 Mar 2013 11:50:00 -0500 Subject: [PATCH] Initial import from Subversion sources. --- AUTHORS | 5 + CHANGELOG | 80 +++ INSTALL | 56 ++ INSTALL.GIT | 19 + LICENSE | 13 + Makefile.am | 3 + README.md | 11 +- THANKS | 14 + bootstrap.sh | 5 + config.h.in | 163 +++++ configure.ac | 118 +++ convert-format.py | 30 + denistify.py | 23 + m4/acx_pthread.m4 | 242 +++++++ man/Makefile.am | 2 + man/nsrlsvr.1 | 62 ++ src/Doxyfile | 1757 +++++++++++++++++++++++++++++++++++++++++++++ src/Makefile.am | 6 + src/handler.cc | 595 +++++++++++++++ src/handler.hpp | 19 + src/main.cc | 498 +++++++++++++ 21 files changed, 3720 insertions(+), 1 deletion(-) create mode 100644 AUTHORS create mode 100644 CHANGELOG create mode 100644 INSTALL create mode 100644 INSTALL.GIT create mode 100644 LICENSE create mode 100644 Makefile.am create mode 100644 THANKS create mode 100755 bootstrap.sh create mode 100644 config.h.in create mode 100644 configure.ac create mode 100755 convert-format.py create mode 100755 denistify.py create mode 100644 m4/acx_pthread.m4 create mode 100644 man/Makefile.am create mode 100644 man/nsrlsvr.1 create mode 100644 src/Doxyfile create mode 100644 src/Makefile.am create mode 100644 src/handler.cc create mode 100644 src/handler.hpp create mode 100644 src/main.cc diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..9434bc6 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,5 @@ +Robert J. Hansen + * nsrlsvr + + + diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..3b57e7e --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,80 @@ +1.1.1: February 22, 2013 + * Code cleanups. Now has better support for using custom datasets. + Less dependence on scripts for building. + +1.1: May 2, 2012 + * Supports version 2 of the wire protocol, which introduces new + commands: STATUS (gives server status), BYE (what it says), + UPSHIFT (attempt to negotiate to a more recent protocol) and + DOWNSHIFT (negotiate to a lower protocol). Version 2 also + supports multiple QUERY commands in a single connection, which + helps a lot when fighting off port exhaustion. + * Switched from blocking I/O to poll()-based I/O. This helps + deal with the out-of-control system loads that some users + were seeing. + * Uses RDS 2.36 + +1.0.6: January 20, 2012 + * Discovered that Win32 I/O redirection didn't work at all. + Whoops. This got fixed. + +1.0.5: January 17, 2012 + * 1.0.4 added a bad regex that didn't match as much as it + should have. This had the effects of stripping SHA-1 hashes + down to 128 bits. Whoops. + * Now compiles on FreeBSD 9.0. + * nsrlparse became nsrlparse.py + * nsrllookup became nsrllookup.py + * Fixed documentation to reflect these name changes + +1.0.4: January 3, 2012 + * Added a preflight script to help in development. This has no + effect on end-users. + * Removed a bit of debugging output that was accidentally left + in. + * Moved the 'populate' script to 'nsrlparse' and added it to + the list of installed files + * MD5 is now fully supported, as is interoperability with + md5deep. + +1.0.3: January 3, 2012 + * Fixed an interoperability bug with sha1deep. + +1.0.2: December 30, 2011 + * Ubuntu 11.10 complains about handler.cc, on account of how + there are some write() calls that aren't checked for returning + a -1. Virtually all of those were superfluous warnings: one + could possibly have created an intermittent error sooner or + later. They have all been patched, and it now compiles cleanly + on Ubuntu 11.10. + +1.0.1: December 30, 2011 + * nsrllookup had a bug that would become manifest while querying + millions of records. Now nsrllookup breaks it up into blocks + of 4096 queries (a maximum of 164k of data per connection). + This will hopefully improve performance for those times when + you want to push millions of queries to the server. + +1.0: December 30, 2011 + * First ready-for-the-users release. The only new feature over + the release candidate series is a much improved installation + procedure. + * It should be possible to make RPMs, Debian packages, or + what-have-you, since the install process is now bog-standard + GNU ./configure && make && make install + +1.0rcX: December, 2011 + * Ready for limited beta testing. The only change visible to + end users was introducing support for OS X 10.6. + * A bug that prevented reliable functioning on Fedora and OpenSUSE + was found and crushed. + * The internals were ported from a very C-like C++ subset to a + much more C++ code style. This reduced our dependency on GNU + getline(), which had been the major obstacle to OS X 10.6 + support. + +0.9: December, 2011 + * Successfully tested nsrlsvr with the full NIST NSRL RDS on a 4Gb + Apple iMac. It made it completely unusable as a desktop, but was + able to successfully service requests. + diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..896a578 --- /dev/null +++ b/INSTALL @@ -0,0 +1,56 @@ +Installation instructions: + +1. Decide what data set you want nsrlsvr to query against by + default. Your options are: + + a. NIST's NSRL RDS (http://http://www.nsrl.nist.gov/). + + b. A dataset that you provide at compile-time. For instance, + if you have a proprietary set of SHA-1 hashes of known + malware and know you'll only ever want to use that, this is + the way to go. + + You may also tell nsrlsvr to use a different file by passing the + "-f" flag when launching the server. This file must contain nothing + but MD5, SHA-1 or SHA-256 hashes, one per line in hexadecimal format, + with no other content on a line. This option is mostly for developer + testing: most users will never touch it. + + +2. If you're compiling it using your own dataset, your dataset must + be in a format nsrlsvr understands. One good way to do this is with + Jesse Kornblum's md5deep tool: + + $ md5deep -c [FILES] > my_dataset.txt + + +3. Run the ./configure script, passing it one or more of: + + a. No options: if the current RDS zipfile exists in the build + directory, use that; otherwise, try to download it. + b. --with-custom=my_set.txt: use your own dataset + c. --with-nsrl=filename: use an already-downloaded NSRL RDS + zip file (one that lives, e.g., outside the build dir). + You will want to use this option if a newer NSRL RDS has + been released than the one nsrlsvr knows about. + + +4. Once you've completed the "make && make install" dance, an + executables will be installed to $PREFIX/bin: nsrlsvr, the server + application, which runs as a UNIX daemon + + +5. As an example of how it can be used: + + $ md5deep -c /path/to/evil/files > evil_dataset.txt + $ ./configure --with-custom=evil_dataset.txt + $ make + $ sudo make install + + You've now created a custom dataset that contains MD5 hashes + of files you've declared to be evil. + + $ nsrlsvr -t 1800 + + You've started the server and instructed it to automatically + shut down after a half-hour of inactivity. diff --git a/INSTALL.GIT b/INSTALL.GIT new file mode 100644 index 0000000..1f48859 --- /dev/null +++ b/INSTALL.GIT @@ -0,0 +1,19 @@ +If you're reading this, then you're using a Subversion snapshot of +nsrlsvr. Please check your configure.in script to ensure the +version has "svn" after it. If it doesn't, please holler at me +that I've got a broken version string. :) + +Building from Subversion sources is not recommended. At any given +moment the tree may be broken. That said, if you want to live on +the edge, go for it. + +1. Do an 'svn up'. Don't assume that just because you checked the + code out yesterday that it's still the same today. Seriously, + svn up. +2. 'sh ./bootstrap.sh'. The Subversion tree does not include a + configure script. If you have a configure script in your + directory, then it is something you created and it may no longer + be in sync with changes to the tree. Running the bootstrap + script will create a new configure script for you. +3. Once you've recreated the configure script, build it just as + you would a released version. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6ad735a --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright (c) 2011-2013, Robert J. Hansen + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..6d8139c --- /dev/null +++ b/Makefile.am @@ -0,0 +1,3 @@ +EXTRA_DIST=LICENSE README CHANGELOG AUTHORS INSTALL THANKS convert-format.py denistify.py +SUBDIRS=src man +ACLOCAL_AMFLAGS=-I m4 diff --git a/README.md b/README.md index 3e45307..d00c3f7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ nsrlsvr -======= \ No newline at end of file +======= +nsrlsvr is a tool to facilitate looking up data in the National Software +Reference Library (NSRL). It's in a 1.1 state, which means it's unlikely +to break in two if you look at it the wrong way but still may not be as +stable as you'd like. + +Installation instructions are found in the INSTALL file. Please read them. +Due to the size of the NSRL's reference data set (RDS), installing nsrlsvr +is a little bit more involved than one would like. It isn't hard: it's just +not quite a configure, make, make install dance. diff --git a/THANKS b/THANKS new file mode 100644 index 0000000..298517b --- /dev/null +++ b/THANKS @@ -0,0 +1,14 @@ +* RedJack Security + - RedJack's been kind enough to let me hack on nsrlquery during + business hours during lulls in work. Thanks, guys. It's immensely + appreciated. + +* Jesse Kornblum + - Proposed the original "you know, there ought to be a way..." that + led to nsrlquery + - helped make nsrlquery work on OS X 10.6 + - noticed more bugs than can quickly be listed here :) + +* Mark Kealiher + - Early adopters get to bleed on the cutting edge, and he shed more + than his due. Thanks, Mark. Hopefully it works better now. :) diff --git a/bootstrap.sh b/bootstrap.sh new file mode 100755 index 0000000..4b7abc3 --- /dev/null +++ b/bootstrap.sh @@ -0,0 +1,5 @@ +#!/bin/sh +aclocal -I m4 +automake --foreign --add-missing +autoheader +autoconf \ No newline at end of file diff --git a/config.h.in b/config.h.in new file mode 100644 index 0000000..788f901 --- /dev/null +++ b/config.h.in @@ -0,0 +1,163 @@ +/* config.h.in. Generated from configure.ac by autoheader. */ + +/* Define to 1 if you have the header file. */ +#undef HAVE_ARPA_INET_H + +/* Define to 1 if you have the `fork' function. */ +#undef HAVE_FORK + +/* Define to 1 if you have the `inet_ntoa' function. */ +#undef HAVE_INET_NTOA + +/* Define to 1 if the system has the type `intmax_t'. */ +#undef HAVE_INTMAX_T + +/* Define to 1 if you have the header file. */ +#undef HAVE_INTTYPES_H + +/* Define to 1 if you have the header file. */ +#undef HAVE_LIMITS_H + +/* Define to 1 if the system has the type `long long int'. */ +#undef HAVE_LONG_LONG_INT + +/* Define to 1 if you have the header file. */ +#undef HAVE_MEMORY_H + +/* Define to 1 if you have the `memset' function. */ +#undef HAVE_MEMSET + +/* Define to 1 if you have the header file. */ +#undef HAVE_NETINET_IN_H + +/* Define if you have POSIX threads libraries and header files. */ +#undef HAVE_PTHREAD + +/* Define to 1 if you have the `socket' function. */ +#undef HAVE_SOCKET + +/* Define to 1 if stdbool.h conforms to C99. */ +#undef HAVE_STDBOOL_H + +/* Define to 1 if you have the header file. */ +#undef HAVE_STDINT_H + +/* Define to 1 if you have the header file. */ +#undef HAVE_STDLIB_H + +/* Define to 1 if you have the header file. */ +#undef HAVE_STRINGS_H + +/* Define to 1 if you have the header file. */ +#undef HAVE_STRING_H + +/* Define to 1 if you have the header file. */ +#undef HAVE_SYSLOG_H + +/* Define to 1 if you have the header file. */ +#undef HAVE_SYS_SOCKET_H + +/* Define to 1 if you have the header file. */ +#undef HAVE_SYS_STAT_H + +/* Define to 1 if you have the header file. */ +#undef HAVE_SYS_TYPES_H + +/* Define to 1 if you have the header file. */ +#undef HAVE_UNISTD_H + +/* Define to 1 if you have the `vfork' function. */ +#undef HAVE_VFORK + +/* Define to 1 if you have the header file. */ +#undef HAVE_VFORK_H + +/* Define to 1 if `fork' works. */ +#undef HAVE_WORKING_FORK + +/* Define to 1 if `vfork' works. */ +#undef HAVE_WORKING_VFORK + +/* Define to 1 if the system has the type `_Bool'. */ +#undef HAVE__BOOL + +/* Name of package */ +#undef PACKAGE + +/* Define to the address where bug reports for this package should be sent. */ +#undef PACKAGE_BUGREPORT + +/* Define to the full name of this package. */ +#undef PACKAGE_NAME + +/* Define to the full name and version of this package. */ +#undef PACKAGE_STRING + +/* Define to the one symbol short name of this package. */ +#undef PACKAGE_TARNAME + +/* Define to the version of this package. */ +#undef PACKAGE_VERSION + +/* Define to necessary symbol if this constant uses a non-standard name on + your system. */ +#undef PTHREAD_CREATE_JOINABLE + +/* Define to 1 if you have the ANSI C header files. */ +#undef STDC_HEADERS + +/* Version number of package */ +#undef VERSION + +/* Define for Solaris 2.5.1 so the uint32_t typedef from , + , or is not used. If the typedef was allowed, the + #define below would cause a syntax error. */ +#undef _UINT32_T + +/* Define for Solaris 2.5.1 so the uint8_t typedef from , + , or is not used. If the typedef was allowed, the + #define below would cause a syntax error. */ +#undef _UINT8_T + +/* Define to empty if `const' does not conform to ANSI C. */ +#undef const + +/* Define to the type of a signed integer type of width exactly 16 bits if + such a type exists and the standard includes do not define it. */ +#undef int16_t + +/* Define to the type of a signed integer type of width exactly 32 bits if + such a type exists and the standard includes do not define it. */ +#undef int32_t + +/* Define to the type of a signed integer type of width exactly 8 bits if such + a type exists and the standard includes do not define it. */ +#undef int8_t + +/* Define to the widest signed integer type if and do + not define. */ +#undef intmax_t + +/* Define to `int' if does not define. */ +#undef pid_t + +/* Define to `unsigned int' if does not define. */ +#undef size_t + +/* Define to `int' if does not define. */ +#undef ssize_t + +/* Define to the type of an unsigned integer type of width exactly 16 bits if + such a type exists and the standard includes do not define it. */ +#undef uint16_t + +/* Define to the type of an unsigned integer type of width exactly 32 bits if + such a type exists and the standard includes do not define it. */ +#undef uint32_t + +/* Define to the type of an unsigned integer type of width exactly 8 bits if + such a type exists and the standard includes do not define it. */ +#undef uint8_t + +/* Define as `fork' if `vfork' does not work. */ +#undef vfork diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..f42601d --- /dev/null +++ b/configure.ac @@ -0,0 +1,118 @@ +AC_INIT([NSRL Server], [1.1.2], [Robert J. Hansen ], [nsrlsvr], [http://nsrlquery.sourceforge.net]) +AC_ARG_WITH([nsrl], + [AS_HELP_STRING([--with-nsrl], + [use NIST's NSRL RDS @<:@default: use the NSRL RDS@:>@])], + [nsrl=${withval}], [nsrl=no]) + +AC_ARG_WITH([custom], + [AS_HELP_STRING([--with-custom], + [use a custom dataset @<:@default: don't@:>@])], + [custom=${withval}], [custom=no]) + +if test "x$custom" != "xno" ; then + AM_PATH_PYTHON([2.7]) +fi + +if test "x$nsrl" != "xno" && test "x$custom" != "xno" ; then + AC_MSG_ERROR([The --with-nsrl and --with-custom flags are mutually exclusive.]); +fi + +AC_CONFIG_MACRO_DIR([m4]) +AC_CONFIG_SRCDIR([src/main.cc]) +AC_PREREQ([2.58]) +AC_CONFIG_HEADERS([config.h]) +AM_INIT_AUTOMAKE([foreign]) +m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) + +AC_PROG_CXX +AC_TYPE_INT8_T +AC_TYPE_UINT8_T +AC_TYPE_INT16_T +AC_TYPE_UINT16_T +AC_TYPE_INT32_T +AC_TYPE_UINT32_T +AC_TYPE_INTMAX_T +ACX_PTHREAD([], AC_MSG_ERROR([pthreads does not appear usable.])) +AC_CHECK_FUNCS([inet_ntoa]) +AC_CHECK_FUNCS([memset]) +AC_CHECK_FUNCS([socket]) +AC_CHECK_HEADERS([arpa/inet.h]) +AC_CHECK_HEADERS([limits.h]) +AC_CHECK_HEADERS([netinet/in.h]) +AC_CHECK_HEADERS([sys/socket.h]) +AC_CHECK_HEADERS([syslog.h]) +AC_C_CONST +AC_FUNC_FORK +dnl AC_FUNC_GETLOADAVG +AC_HEADER_STDBOOL +AC_TYPE_PID_T +AC_TYPE_SIZE_T +AC_TYPE_SSIZE_T + +RDS_URL=http://www.nsrl.nist.gov/RDS/rds_2.39/RDS_239m.zip +nsrl_filename=RDS_239m.zip + + +if test "x$nsrl" != xno ; then + if ! test -r $nsrl ; then + AC_MSG_ERROR([Couldn't find the dataset specified.]) + else + nsrl_filename = $nsrl + fi +fi + +if ! test -r $nsrl_filename && test "x$custom" = xno ; then + AC_CHECK_PROG([UNZIP], [unzip], [unzip], AC_MSG_ERROR([unzip not found: this is necessary to use the downloaded NIST NSRL RDS])) + AC_CHECK_PROG([WGET], [wget], [wget], [no]) + if test "x$WGET" = xwget ; then + wget $RDS_URL ; + else + AC_CHECK_PROG([CURL], [curl], [curl], [no]) + if test "x$CURL" = xcurl ; then + curl -O $RDS_URL ; + else + AC_MSG_ERROR([The NIST NSRL RDS must be downloaded, but neither curl nor wget are in your PATH. Please fix this, and try again.]) + fi + fi + AC_MSG_NOTICE([ +*** +*** I'm going to leave the file $nsrl_filename around in the toplevel of the +*** build directory. If you leave it here, the next time you build this it +*** will save you a long download. +***]) +fi + +if test "x$custom" = xno ; then + if ! test -r $nsrl_filename ; then + AC_MSG_ERROR([ +*** +*** Couldn't open $nsrl_filename for reading. +*** +*** If you used a tilde ("~") in the path, try giving a full directory +*** path: sometimes tilde expansion confuses configure. +***]); + else + AC_MSG_NOTICE([uncompressing the NSRL RDS -- this may take a while...]) + rm -f NSRLFile.txt src/NSRLFile.txt + unzip -o $nsrl_filename NSRLFile.txt + AC_MSG_NOTICE([converting into nsrlsvr's data format -- please wait...]) + $PYTHON ./denistify.py + rm -f NSRLFile.txt + fi +else + if ! test -r $custom ; then + AC_MSG_ERROR([ +*** +*** Couldn't open $custom for reading. +*** +*** If you used a tilde ("~") in the path, try giving a full directory +*** path: sometimes tilde expansion confuses configure. +***]); + fi + AC_MSG_NOTICE([converting $custom to the proper data format -- please wait...]) + rm -f src/NSRLFile.txt + $PYTHON ./convert-format.py $custom +fi + +AC_OUTPUT([Makefile src/Makefile man/Makefile]) + diff --git a/convert-format.py b/convert-format.py new file mode 100755 index 0000000..816167d --- /dev/null +++ b/convert-format.py @@ -0,0 +1,30 @@ +#!/usr/bin/env python + +from __future__ import print_function + +import re, sys, os + +hash_re = re.compile(r"([0-9A-Fa-f]{64}|[0-9A-Fa-f]{40}|[0-9A-Fa-f]{32})") + +if len(sys.argv) != 2: + print("No file specified.") + exit(-1) +if not os.access(sys.argv[1], os.R_OK): + print("Couldn't read " + sys.argv[1]) + exit(-2) + +with open(sys.argv[1]) as fh: + hashes = [hash_re.search(X).group(1) for X in fh.readlines() if hash_re.search(X)] + +if not hashes: + print("Zero hashes found -- check to see if this is correct.") + exit(-4) + +first_len = len(hashes[0]) +if [X for X in hashes[1:] if len(X) != first_len]: + print("Multiple different hash algorithms present in " + sys.argv[1]) + exit(-8) + +with open("src/NSRLFile.txt", "w") as output: + for hash in hashes: + output.write(hash + "\n") diff --git a/denistify.py b/denistify.py new file mode 100755 index 0000000..4272b47 --- /dev/null +++ b/denistify.py @@ -0,0 +1,23 @@ +#!/usr/bin/env python +#coding=UTF-8 + +import re, sys + +md5_re = re.compile('^.*"([0-9A-Fa-f]{32})".*$') +hashes = [] +count = 0 + +with open("NSRLFile.txt") as fh: + line = fh.readline() + while line: + elements = line.split(",") + if len(elements) >= 2: + match = md5_re.match(elements[1]) + if match: + hashes.append(match.group(1)) + line = fh.readline() + +hashes.sort() +with open("src/NSRLFile.txt", "w") as fh: + for entry in hashes: + fh.write(entry + "\n") diff --git a/m4/acx_pthread.m4 b/m4/acx_pthread.m4 new file mode 100644 index 0000000..e4e91d3 --- /dev/null +++ b/m4/acx_pthread.m4 @@ -0,0 +1,242 @@ +dnl @synopsis ACX_PTHREAD([ACTION-IF-FOUND[, ACTION-IF-NOT-FOUND]]) +dnl +dnl @summary figure out how to build C programs using POSIX threads +dnl +dnl This macro figures out how to build C programs using POSIX threads. +dnl It sets the PTHREAD_LIBS output variable to the threads library and +dnl linker flags, and the PTHREAD_CFLAGS output variable to any special +dnl C compiler flags that are needed. (The user can also force certain +dnl compiler flags/libs to be tested by setting these environment +dnl variables.) +dnl +dnl Also sets PTHREAD_CC to any special C compiler that is needed for +dnl multi-threaded programs (defaults to the value of CC otherwise). +dnl (This is necessary on AIX to use the special cc_r compiler alias.) +dnl +dnl NOTE: You are assumed to not only compile your program with these +dnl flags, but also link it with them as well. e.g. you should link +dnl with $PTHREAD_CC $CFLAGS $PTHREAD_CFLAGS $LDFLAGS ... $PTHREAD_LIBS +dnl $LIBS +dnl +dnl If you are only building threads programs, you may wish to use +dnl these variables in your default LIBS, CFLAGS, and CC: +dnl +dnl LIBS="$PTHREAD_LIBS $LIBS" +dnl CFLAGS="$CFLAGS $PTHREAD_CFLAGS" +dnl CC="$PTHREAD_CC" +dnl +dnl In addition, if the PTHREAD_CREATE_JOINABLE thread-attribute +dnl constant has a nonstandard name, defines PTHREAD_CREATE_JOINABLE to +dnl that name (e.g. PTHREAD_CREATE_UNDETACHED on AIX). +dnl +dnl ACTION-IF-FOUND is a list of shell commands to run if a threads +dnl library is found, and ACTION-IF-NOT-FOUND is a list of commands to +dnl run it if it is not found. If ACTION-IF-FOUND is not specified, the +dnl default action will define HAVE_PTHREAD. +dnl +dnl Please let the authors know if this macro fails on any platform, or +dnl if you have any other suggestions or comments. This macro was based +dnl on work by SGJ on autoconf scripts for FFTW (www.fftw.org) (with +dnl help from M. Frigo), as well as ac_pthread and hb_pthread macros +dnl posted by Alejandro Forero Cuervo to the autoconf macro repository. +dnl We are also grateful for the helpful feedback of numerous users. +dnl +dnl @category InstalledPackages +dnl @author Steven G. Johnson +dnl @version 2006-05-29 +dnl @license GPLWithACException + +AC_DEFUN([ACX_PTHREAD], [ +AC_REQUIRE([AC_CANONICAL_HOST]) +AC_LANG_SAVE +AC_LANG_C +acx_pthread_ok=no + +# We used to check for pthread.h first, but this fails if pthread.h +# requires special compiler flags (e.g. on True64 or Sequent). +# It gets checked for in the link test anyway. + +# First of all, check if the user has set any of the PTHREAD_LIBS, +# etcetera environment variables, and if threads linking works using +# them: +if test x"$PTHREAD_LIBS$PTHREAD_CFLAGS" != x; then + save_CFLAGS="$CFLAGS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + save_LIBS="$LIBS" + LIBS="$PTHREAD_LIBS $LIBS" + AC_MSG_CHECKING([for pthread_join in LIBS=$PTHREAD_LIBS with CFLAGS=$PTHREAD_CFLAGS]) + AC_TRY_LINK_FUNC(pthread_join, acx_pthread_ok=yes) + AC_MSG_RESULT($acx_pthread_ok) + if test x"$acx_pthread_ok" = xno; then + PTHREAD_LIBS="" + PTHREAD_CFLAGS="" + fi + LIBS="$save_LIBS" + CFLAGS="$save_CFLAGS" +fi + +# We must check for the threads library under a number of different +# names; the ordering is very important because some systems +# (e.g. DEC) have both -lpthread and -lpthreads, where one of the +# libraries is broken (non-POSIX). + +# Create a list of thread flags to try. Items starting with a "-" are +# C compiler flags, and other items are library names, except for "none" +# which indicates that we try without any flags at all, and "pthread-config" +# which is a program returning the flags for the Pth emulation library. + +acx_pthread_flags="pthreads none -Kthread -kthread lthread -pthread -pthreads -mthreads pthread --thread-safe -mt pthread-config" + +# The ordering *is* (sometimes) important. Some notes on the +# individual items follow: + +# pthreads: AIX (must check this before -lpthread) +# none: in case threads are in libc; should be tried before -Kthread and +# other compiler flags to prevent continual compiler warnings +# -Kthread: Sequent (threads in libc, but -Kthread needed for pthread.h) +# -kthread: FreeBSD kernel threads (preferred to -pthread since SMP-able) +# lthread: LinuxThreads port on FreeBSD (also preferred to -pthread) +# -pthread: Linux/gcc (kernel threads), BSD/gcc (userland threads) +# -pthreads: Solaris/gcc +# -mthreads: Mingw32/gcc, Lynx/gcc +# -mt: Sun Workshop C (may only link SunOS threads [-lthread], but it +# doesn't hurt to check since this sometimes defines pthreads too; +# also defines -D_REENTRANT) +# ... -mt is also the pthreads flag for HP/aCC +# pthread: Linux, etcetera +# --thread-safe: KAI C++ +# pthread-config: use pthread-config program (for GNU Pth library) + +case "${host_cpu}-${host_os}" in + *solaris*) + + # On Solaris (at least, for some versions), libc contains stubbed + # (non-functional) versions of the pthreads routines, so link-based + # tests will erroneously succeed. (We need to link with -pthreads/-mt/ + # -lpthread.) (The stubs are missing pthread_cleanup_push, or rather + # a function called by this macro, so we could check for that, but + # who knows whether they'll stub that too in a future libc.) So, + # we'll just look for -pthreads and -lpthread first: + + acx_pthread_flags="-pthreads pthread -mt -pthread $acx_pthread_flags" + ;; +esac + +if test x"$acx_pthread_ok" = xno; then +for flag in $acx_pthread_flags; do + + case $flag in + none) + AC_MSG_CHECKING([whether pthreads work without any flags]) + ;; + + -*) + AC_MSG_CHECKING([whether pthreads work with $flag]) + PTHREAD_CFLAGS="$flag" + ;; + + pthread-config) + AC_CHECK_PROG(acx_pthread_config, pthread-config, yes, no) + if test x"$acx_pthread_config" = xno; then continue; fi + PTHREAD_CFLAGS="`pthread-config --cflags`" + PTHREAD_LIBS="`pthread-config --ldflags` `pthread-config --libs`" + ;; + + *) + AC_MSG_CHECKING([for the pthreads library -l$flag]) + PTHREAD_LIBS="-l$flag" + ;; + esac + + save_LIBS="$LIBS" + save_CFLAGS="$CFLAGS" + LIBS="$PTHREAD_LIBS $LIBS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + + # Check for various functions. We must include pthread.h, + # since some functions may be macros. (On the Sequent, we + # need a special flag -Kthread to make this header compile.) + # We check for pthread_join because it is in -lpthread on IRIX + # while pthread_create is in libc. We check for pthread_attr_init + # due to DEC craziness with -lpthreads. We check for + # pthread_cleanup_push because it is one of the few pthread + # functions on Solaris that doesn't have a non-functional libc stub. + # We try pthread_create on general principles. + AC_TRY_LINK([#include ], + [pthread_t th; pthread_join(th, 0); + pthread_attr_init(0); pthread_cleanup_push(0, 0); + pthread_create(0,0,0,0); pthread_cleanup_pop(0); ], + [acx_pthread_ok=yes]) + + LIBS="$save_LIBS" + CFLAGS="$save_CFLAGS" + + AC_MSG_RESULT($acx_pthread_ok) + if test "x$acx_pthread_ok" = xyes; then + break; + fi + + PTHREAD_LIBS="" + PTHREAD_CFLAGS="" +done +fi + +# Various other checks: +if test "x$acx_pthread_ok" = xyes; then + save_LIBS="$LIBS" + LIBS="$PTHREAD_LIBS $LIBS" + save_CFLAGS="$CFLAGS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + + # Detect AIX lossage: JOINABLE attribute is called UNDETACHED. + AC_MSG_CHECKING([for joinable pthread attribute]) + attr_name=unknown + for attr in PTHREAD_CREATE_JOINABLE PTHREAD_CREATE_UNDETACHED; do + AC_TRY_LINK([#include ], [int attr=$attr; return attr;], + [attr_name=$attr; break]) + done + AC_MSG_RESULT($attr_name) + if test "$attr_name" != PTHREAD_CREATE_JOINABLE; then + AC_DEFINE_UNQUOTED(PTHREAD_CREATE_JOINABLE, $attr_name, + [Define to necessary symbol if this constant + uses a non-standard name on your system.]) + fi + + AC_MSG_CHECKING([if more special flags are required for pthreads]) + flag=no + case "${host_cpu}-${host_os}" in + *-aix* | *-freebsd* | *-darwin*) flag="-D_THREAD_SAFE";; + *solaris* | *-osf* | *-hpux*) flag="-D_REENTRANT";; + esac + AC_MSG_RESULT(${flag}) + if test "x$flag" != xno; then + PTHREAD_CFLAGS="$flag $PTHREAD_CFLAGS" + fi + + LIBS="$save_LIBS" + CFLAGS="$save_CFLAGS" + + # More AIX lossage: must compile with xlc_r or cc_r + if test x"$GCC" != xyes; then + AC_CHECK_PROGS(PTHREAD_CC, xlc_r cc_r, ${CC}) + else + PTHREAD_CC=$CC + fi +else + PTHREAD_CC="$CC" +fi + +AC_SUBST(PTHREAD_LIBS) +AC_SUBST(PTHREAD_CFLAGS) +AC_SUBST(PTHREAD_CC) + +# Finally, execute ACTION-IF-FOUND/ACTION-IF-NOT-FOUND: +if test x"$acx_pthread_ok" = xyes; then + ifelse([$1],,AC_DEFINE(HAVE_PTHREAD,1,[Define if you have POSIX threads libraries and header files.]),[$1]) + : +else + acx_pthread_ok=no + $2 +fi +AC_LANG_RESTORE +])dnl ACX_PTHREAD diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..2132e32 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,2 @@ +EXTRA_DIST=nsrlsvr.1 +man_MANS=nsrlsvr.1 diff --git a/man/nsrlsvr.1 b/man/nsrlsvr.1 new file mode 100644 index 0000000..74cb403 --- /dev/null +++ b/man/nsrlsvr.1 @@ -0,0 +1,62 @@ +.Dd January 30, 2012 +.Dt NSRLSVR 1 +.Os +.Sh NAME +.Nm nsrlsvr +.Nd server yielding hashes from NIST's NSRL RDS +.Sh SYNOPSIS +.Nm nsrlsvr +.Op Fl b +.Op Fl h +.Op Fl o +.Op Fl s +.Op Fl S +.Op Fl v +.Op Fl f Ar RDS-file +.Op Fl p Ar port +.Op Fl t Ar timeout +.Sh DESCRIPTION +nsrlsvr provides a daemon that services queries from clients requesting information +about whether certain hash values are present in the NIST National Software Reference +Laboratory Reference Data Set (NSRL RDS). +.Sh OPTIONS +.Bl -tag -width Ds +.It Fl b +show information on submitting bug reports, then exit +.It Fl h +show a help screen, then exit +.It Fl o +only support the old 1.0 server protocol +.It Fl s +allow clients to query the server status (default: disabled) +.It Fl S +run as a normal process (do not run as a daemon) +.It Fl v +show version information, then exit +.It Fl f Ar RDS-file +specify an alternate RDS file in +.Ar RDS-file +.It Fl p Ar port +listen on port (default: 9120) +.Ar port +.It Fl t Ar timeout +shut down after +.Ar timeout +seconds of inactivity (default: disabled) +.El +.Sh NOTES +To support the full NSRL RDS requires a lot of memory. Although it will run on +a 4Gb system, the results may be unsatisfactory. A 64-bit OS with at least 8Gb +of RAM is recommended. +.Pp +nsrlsvr treats the +.Ar timeout +value as a guideline. It will not shut down before +.Ar timeout +seconds of inactivity, but it may allow up to thirty seconds more. +.Sh BUGS +None known. +.Sh SEE ALSO +nsrllookup(1) +.Sh AUTHOR +Robert J. Hansen diff --git a/src/Doxyfile b/src/Doxyfile new file mode 100644 index 0000000..8279ac9 --- /dev/null +++ b/src/Doxyfile @@ -0,0 +1,1757 @@ +# Doxyfile 1.7.5.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" "). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = nsrlsvr + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = 0.1 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = Interfacing with the NSRL + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this +# tag. The format is ext=language, where ext is a file extension, and language +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. The create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = main.cc handler.cc handler.hpp + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to directory from which doxygen is run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is adviced to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the stylesheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = NO + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the +# mathjax.org site, so you can quickly see the result without installing +# MathJax, but it is strongly recommended to install a local copy of MathJax +# before deployment. + +MATHJAX_RELPATH = http://www.mathjax.org/mathjax + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/src/Makefile.am b/src/Makefile.am new file mode 100644 index 0000000..7fc90a7 --- /dev/null +++ b/src/Makefile.am @@ -0,0 +1,6 @@ +EXTRA_DIST = handler.hpp Doxyfile +bin_PROGRAMS = nsrlsvr +nodist_pkgdata_DATA = NSRLFile.txt +nsrlsvr_SOURCES = main.cc handler.cc +nsrlsvr_CPPFLAGS = -DPKGDATADIR="\"$(pkgdatadir)\"" -DPACKAGE_VERSION="\"$(PACKAGE_VERSION)\"" -DPACKAGE_URL="\"$(PACKAGE_URL)\"" -DPACKAGE_BUGREPORT="\"$(PACKAGE_BUGREPORT)\"" $(PTHREAD_CFLAGS) +nsrlsvr_LDFLAGS=$(PTHREAD_CFLAGS) diff --git a/src/handler.cc b/src/handler.cc new file mode 100644 index 0000000..acfb8bc --- /dev/null +++ b/src/handler.cc @@ -0,0 +1,595 @@ +/* $Id: handler.cc 142 2013-02-23 22:25:32Z rjh $ + * + * Copyright (c) 2011-2012, Robert J. Hansen + * and others. + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + * + * Code standards: + * This is a small enough project we don't need a formal coding standard. + * That said, here are some helpful tips for people who want to submit + * patches: + * + * - If it's not 100% ISO C++98, it won't get in. + * - It must compile cleanly and without warnings under both GNU G++ + * and Clang++, even with "-W -Wextra -ansi -pedantic". + * - C++ offers 'and', 'or' and 'not' keywords instead of &&, || and !. + * I like these: I think they're more readable. Please use them. + * - C++ allows you to initialize variables at declaration time by + * doing something like "int x(3)" instead of "int x = 3". Please + * do this where practical: it's a good habit to get into for C++. + * - Please try to follow the formatting conventions. It's mostly + * straight-up astyle format, with occasional tweaks where necessary + * to get nice hardcopy printouts. + * - If you write a new function it must have a Doxygen block + * documenting it. + * + * Contributor history: + * + * Robert J. Hansen + * - most everything + * Jesse Kornblum + * - patch to log how many hashes are in each QUERY statement + */ + +#include +#include +#include +#include +#include +#include +#include +#include "handler.hpp" +#include +#include // for getloadavg +#include +#include +#include + +#define INFO LOG_MAKEPRI(LOG_USER, LOG_INFO) + +/* Additional defines necessary on Linux: */ +#ifdef __linux__ +#include // for memset +#include // for snprintf +#include // because Fedora has lately taken to being weird +#endif + +using std::set; +using std::string; +using std::find; +using std::find_if; +using std::transform; +using std::vector; +using std::not1; +using std::equal_to; +using std::ptr_fun; +using std::remove; +using std::auto_ptr; +using std::exception; + +extern const set& hashes; +extern const bool& enable_status; +extern const bool& only_old; + +namespace { + +/** A convenience exception representing network errors that cannot + * be recovered from, and will result in a graceful bomb-out. + * + * @since 1.1 + * @author Robert J. Hansen */ +class UnrecoverableNetworkError : public exception +{ +public: + const char* what() const throw() { + return "unr net err"; + } +}; + + +/** A functor that provides stateful reading of line-oriented data + * across UNIX file descriptors. + * + * The big problem with reading information over a socket + * connection is that data can arrive in a badly fragmented form. + * On a console you can just call getline() and be confident that + * when it returns there will be a CR/LF at the end and no data + * afterwards: that's the great virtue of accepting data one byte + * at a time on a tty. On a network connection you have to take + * what the system gives you, and if the system gives you two + * strings spread over three packets with a CR/LF smack in the + * middle, well ... you have to make do. That means returning the + * first line and storing the rest of the data for use in a + * subsequent call to the data reading facility. + * + * So, in other words, our get_line function needs to track state + * *and* be threadsafe/re-entrant. Declaring a static buffer within + * the function would let it track state, but thread safety would be + * a problem. + * + * Fortunately, the C++ functor idiom solves this problem + * beautifully. + * + * Further: naïve blocking I/O, although it works rather well, will + * artificially inflate the server load. For this reason the code + * uses slightly more complex but still quite manageable poll()- + * based I/O with a 750ms timeout. Responsiveness isn't quite as + * high as it could be, but it's a small price to pay for better + * behavior server-side. + * + * @author Rob Hansen + * @since 0.9*/ + +struct SocketIO +{ +public: + /** Initializes the object to listen on a particular file + * descriptor. + * + * @param fd File descriptor to read on */ + SocketIO(int32_t fd) : + sock_fd(fd), buffer(""), tmp_buf(65536, '\0') {} + + /** Writes a line of text to the socket. The caller is + * responsible for ensuring the text has a '\r\n' appended. + * + * @param line The line to write + * @since 1.1 */ + void write_line(string line) const + { + if (-1 == write(sock_fd, line.c_str(), line.size())) { + throw UnrecoverableNetworkError(); + } + } + + /** Writes a line of text to the socket. The caller is + * responsible for ensuring the text has a '\r\n' appended. + * + * @param line The line to write + * @since 1.1 */ + void write_line(const char* line) const + { + write_line(string(line)); + } + + /** Reads a line from the socket. Returns an auto_ptr + * because clients might be sending arbitrarily-sized (i.e., + * really huge) data to us. Passing smartpointers around is + * ridiculously faster than copying huge blocks of memory. + * + * Arguably this should return a shared_ptr, but a lot + * of C++ compilers have shaky support for TR1. Instead we use + * the lowest common denominator: std::auto_ptr. + * + * This function replaces the old operator(). + * + * @since 1.1 + * @return An auto_ptr representing one line read from + * the file descriptor.*/ + auto_ptr read_line() + { + /* "But in Latin, Jehovah begins with the letter 'I'..." + * + * SAVE YOURSELF THE NIGHTMARE BUG HUNT. Remember that when + * you test this code at the console, tapping return will + * enter a \n. When you do it from a Telnet client, it enters + * a \r\n. This one-character difference turned into a six- + * hour bug hunt. Documented here for posterity. If you ever + * wonder why I'm tempted to start drinking before the sun + * rises, well, this one's a good example... */ + + while (true) { + pollfd fds = { sock_fd, POLLIN, 0 }; + int poll_code(poll(&fds, 1, 750)); + + if (-1 == poll_code) + throw UnrecoverableNetworkError(); + + else if (fds.revents & POLLERR || + fds.revents & POLLHUP) + throw UnrecoverableNetworkError(); + + else if (fds.revents & POLLIN) { + memset(static_cast(&tmp_buf[0]), + 0, + tmp_buf.size()); + ssize_t bytes_read = read(sock_fd, + static_cast(&tmp_buf[0]), + tmp_buf.size()); + buffer += string(&tmp_buf[0], &tmp_buf[bytes_read]); + + /* To prevent DoS from clients spamming us with huge + packets, bomb on any query larger than 256k. */ + if (buffer.size() > 262144) + throw UnrecoverableNetworkError(); + + string::iterator iter = find(buffer.begin(), + buffer.end(), '\n'); + if (iter != buffer.end()) { + auto_ptr rv(new string(buffer.begin(), iter)); + rv->erase(remove(rv->begin(), + rv->end(), + '\r'), + rv->end()); + rv->erase(remove(rv->begin(), + rv->end(), + '\n'), + rv->end()); + buffer = string(iter + 1, buffer.end()); + return rv; + } + } + } + } +private: + /** Tracks the file descriptor to read */ + const int32_t sock_fd; + /** Internal storage buffer for keeping track of read, but not + * yet finished, data */ + string buffer; + /** Internal storage buffer used only briefly, but declared here + * in order so that we can avoid repeatedly putting it on the + * stack. Additionally, this only takes a few bytes on the stack: + * the actual buffer gets allocated on the heap. */ + vector tmp_buf; +}; + +/** A hand-rolled string tokenizer in C++. + * + * Efficient string tokenization in 29 lines, without absurd + * contortions of code. Booyah. Given the state of things in C, + * where on some platforms strtok is outright obsoleted by strsep + * and on other platforms strsep is just a distant promise of what + * the future might hold... I'll take this way. + * + * Returns a smartpointer to a vector for the same reason + * SocketIO::read_line() returns one: to spare us the + * otherwise absurd amount of memcpying that would be going on. + * + * @param line A pointer to the line to tokenize + * @param character The delimiter character + * @returns An auto_ptr to a vector of strings representing tokens */ +auto_ptr > tokenize(string& line, char character = ' ') +{ + auto_ptr > rv(new vector()); + transform(line.begin(), line.end(), line.begin(), toupper); + + string::iterator begin(find_if(line.begin(), line.end(), + not1(bind2nd(equal_to(), + character)))); + string::iterator end( + (begin != line.end()) + ? find(begin + 1, line.end(), character) + : line.end() + ); + + while (begin != line.end()) { + rv->push_back(string(begin, end)); + if (end == line.end()) { + begin = line.end(); + continue; + } + begin = find_if(end + 1, line.end(), + not1(bind2nd(equal_to(), character))); + end = (begin != line.end()) + ? find(begin + 1, line.end(), character) + : line.end(); + } + return rv; +} + +/** A hand-rolled string tokenizer in C++. + * + * Efficient string tokenization in 29 lines, without absurd + * contortions of code. Booyah. Given the state of things in C, + * where on some platforms strtok is outright obsoleted by strsep + * and on other platforms strsep is just a distant promise of what + * the future might hold... I'll take this way. + * + * Returns a smartpointer to a vector for the same reason + * SocketIO::read_line() returns one: to spare us the + * otherwise absurd amount of memcpying that would be going on. + * + * @param line A pointer to the line to tokenize + * @param character The delimiter character + * @returns An auto_ptr to a vector of strings representing tokens */ +auto_ptr > tokenize(auto_ptr line, char ch = ' ') +{ + return tokenize(*line, ch); +} + +/** Turns a string of 'a.b.c.d', ala dotted-quad style, into a + * 32-bit integer. 'a' must be present: if b through d are + * omitted, they are assumed to be zero. + * + * @param line A smartpointer to a version string + * @returns A 32-bit integer representing a version, or -1 on + * failure. + * @author Rob Hansen + * @since 0.9 */ +int32_t parse_version(auto_ptr line) +{ + int32_t version(0); + int32_t this_token(0); + auto_ptr > tokens(tokenize(line)); + auto_ptr > version_tokens; + size_t index(0); + + if (tokens->size() != 2 or + tokens->at(0) != "VERSION:") { + goto PARSE_VERSION_BAIL_BAD; + } + + version_tokens = tokenize(tokens->at(1), '.'); + + if (version_tokens->size() < 1 or version_tokens->size() > 4) { + goto PARSE_VERSION_BAIL_BAD; + } + + while (version_tokens->size() != 4) { + version_tokens->push_back("0"); + } + + for (index = 0 ; index < 4 ; ++index) { + string& thing(version_tokens->at(index)); + if (thing.end() != find_if(thing.begin(), + thing.end(), + not1(ptr_fun(::isdigit)))) { + goto PARSE_VERSION_BAIL_BAD; + } + this_token = atoi(thing.c_str()); + if (this_token < 0 or this_token > 254) { + goto PARSE_VERSION_BAIL_BAD; + } + version = (version << 8) + this_token; + } + goto PARSE_VERSION_BAIL; + +PARSE_VERSION_BAIL_BAD: + version = -1; + +PARSE_VERSION_BAIL: + return version; +} + + +/** A simple convenience function that allows us to ensure + * we're getting valid hashes. + * + * @param digest The string being checked + * @returns true if it could be an MD5 or SHA-1 digest, false otherwise + * @since 0.9 + * @author Rob Hansen */ +bool ishexdigest(const string& digest) +{ + string::const_iterator iter(digest.begin()); + + if (not (digest.size() == 40 or digest.size() == 32)) { + return false; + } + for ( ; iter != digest.end() ; ++iter) { + bool is_number = (*iter >= '0' and *iter <= '9'); + bool is_letter = (*iter >= 'A' and *iter <= 'F'); + if (not (is_number or is_letter)) + return false; + } + return true; +} + +/** Performs a transaction with a client. Adheres to protocol + * version 1.0. + * + * @param sio The socket to listen and respond on + * @param ip_addr The IP address of the remote host + * @since 0.9 */ +void handle_protocol_10(SocketIO& sio, const char* ip_addr) +{ + string return_seq(""); + uint32_t found(0); + double frac(0.0); + uint32_t total_queries(0); + + try { + auto_ptr > commands(tokenize(sio.read_line())); + + if (commands->size() < 2 or commands->at(0) != "QUERY") { + sio.write_line("NOT OK\r\n"); + return; + } + + for (size_t index = 1 ; index < commands->size() ; ++index) { + if (not ishexdigest(commands->at(index))) { + sio.write_line("NOT OK\r\n"); + return; + } + if (hashes.end() != hashes.find(commands->at(index))) { + return_seq += "1"; + found += 1; + } else { + return_seq += "0"; + } + } + + total_queries = commands->size() - + (commands->size() > 0 ? 1 : 0); + + if (total_queries) { + double numerator(100 * found); + double denominator(total_queries); + frac = numerator / denominator; + } + + syslog(INFO, +"%s: protocol 1.0, found %u of %u hashes (%.1f%%), closed normally", + ip_addr, + found, + total_queries, + frac); + return_seq = "OK " + return_seq + "\r\n"; + sio.write_line(return_seq); + } catch (exception&) { + return; + } +} + +/** Performs a transaction with a client. Adheres to protocol + * version 2.0. + * + * @param sio The socket to listen and respond on + * @since 1.1 */ +void handle_protocol_20(SocketIO& sio, const char* ip_addr) +{ + uint32_t total_queries(0); + uint32_t found(0); + double frac(0.0); + + try { + auto_ptr > commands(tokenize(sio.read_line())); + while (commands->size() >= 1) { + string return_seq(""); + + if ("BYE" == commands->at(0)) { + if (total_queries) { + double numerator(100 * found); + double denominator(total_queries); + frac = numerator / denominator; + } + syslog(INFO, +"%s: protocol 2.0, found %u of %u hashes (%.1f%%), closed normally", + ip_addr, + found, + total_queries, + frac); + return; + } + + else if ("DOWNSHIFT" == commands->at(0)) { + syslog(INFO, + "%s asked for a protocol downgrade to 1.0", + ip_addr); + sio.write_line("OK\r\n"); + handle_protocol_10(sio, ip_addr); + return; + } + + else if ("UPSHIFT" == commands->at(0)) { + syslog(INFO, + "%s asked for a protocol upgrade (refused)", + ip_addr); + sio.write_line("NOT OK\r\n"); + } + + else if ("QUERY" == commands->at(0)) { + if (commands->size() == 1) { + sio.write_line("NOT OK\r\n"); + return; + } else { + size_t index(1); + for ( ; index < commands->size() ; ++index) { + if (not ishexdigest(commands->at(index))) { + sio.write_line("NOT OK\r\n"); + return; + } + + set::const_iterator iter(hashes.begin()); + iter = hashes.find(commands->at(index)); + if (iter != hashes.end()) { + return_seq += "1"; + found += 1; + } else { + return_seq += "0"; + } + } + return_seq = "OK " + return_seq + "\r\n"; + total_queries += commands->size() - 1; + } + } + + else if ("STATUS" == commands->at(0) and enable_status) { + double loadavg[3] = { 0.0, 0.0, 0.0 }; + char buf[1024]; + + getloadavg(loadavg, 3); + memset(buf, 0, 1024); + snprintf(buf, + 1024, + "OK %u %s hashes, load %.2f %.2f %.2f\r\n", + (u_int32_t) hashes.size(), + (hashes.begin() == hashes.end()) ? "unknown" : + (hashes.begin()->size() == 32 ? "MD5" : + hashes.begin()->size() == 40 ? "SHA-1" : + hashes.begin()->size() == 64 ? "SHA-256" : + "unknown algorithm"), + loadavg[0], + loadavg[1], + loadavg[2]); + string line(buf); + return_seq = string(buf); + syslog(INFO, + "%s asked for server status (sent '%s')", + ip_addr, + buf); + } else if ("STATUS" == commands->at(0)) { + syslog(INFO, + "%s asked for server status (refused)", + ip_addr); + return_seq = "OK NOT SUPPORTED\r\n"; + } else { + sio.write_line("NOT OK\r\n"); + return; + } + sio.write_line(return_seq); + commands = tokenize(sio.read_line()); + } + } catch (exception&) { + if (total_queries) { + double numerator(100 * found); + double denominator(total_queries); + frac = numerator / denominator; + } + syslog(INFO, +"%s: protocol 2.0, found %u of %u hashes (%.1f%%), closed abnormally", + ip_addr, + found, + total_queries, + frac); + } +} +} + +/** Handles client query requests. + * + * @param fd the client's socket file descriptor + * @since 0.9 */ +void handle_client(const int32_t fd, const string& ip_addr) +{ + SocketIO sio(fd); + + try { + int32_t version(parse_version(sio.read_line())); + if (version > 0 and version <= 0x01000000) { + sio.write_line("OK\r\n"); + handle_protocol_10(sio, ip_addr.c_str()); + } else if (version > 0x01000000 and + version <= 0x02000000 and + not only_old) { + sio.write_line("OK\r\n"); + handle_protocol_20(sio, ip_addr.c_str()); + } else { + sio.write_line("NOT OK\r\n"); + } + } catch (exception&) { + return; + } +} diff --git a/src/handler.hpp b/src/handler.hpp new file mode 100644 index 0000000..a4bd1a2 --- /dev/null +++ b/src/handler.hpp @@ -0,0 +1,19 @@ +/* $Id: handler.hpp 108 2012-01-30 19:30:29Z rjh $ + * + * Copyright (c) 2011, Robert J. Hansen + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.*/ + +#include + +void handle_client(int32_t, const std::string&); diff --git a/src/main.cc b/src/main.cc new file mode 100644 index 0000000..18885c5 --- /dev/null +++ b/src/main.cc @@ -0,0 +1,498 @@ +/* $Id: main.cc 142 2013-02-23 22:25:32Z rjh $ + * + * Copyright (c) 2011-2012, Robert J. Hansen + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + * + * Code standards: + * This is a small enough project we don't need a formal coding standard. + * That said, here are some helpful tips for people who want to submit + * patches: + * + * - If it's not 100% ISO C++98, it won't get in. + * - It must compile cleanly and without warnings under both GNU G++ + * and Clang++, even with "-W -Wextra -ansi -pedantic". + * - C++ offers 'and', 'or' and 'not' keywords instead of &&, || and !. + * I like these: I think they're more readable. Please use them. + * - C++ allows you to initialize variables at declaration time by + * doing something like "int x(3)" instead of "int x = 3". Please + * do this where practical: it's a good habit to get into for C++. + * - Please try to follow the formatting conventions. It's mostly + * straight-up astyle format, with occasional tweaks where necessary + * to get nice hardcopy printouts. + * - If you write a new function it must have a Doxygen block + * documenting it. + * + * Contributor history: + * Robert J. Hansen + * - everything + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "handler.hpp" +#include +#include +#include +#include + +/* Additional defines necessary on Linux: */ +#ifdef __linux__ +#include // for memset +#include // for stderr +#include // for close, fork, chdir (Fedora only) +#endif + +/* Additional defines necessary on FreeBSD: */ +/* Necessary for sockaddr and sockaddr_in structures */ +#ifdef __FreeBSD__ +#include +#include +#endif + +using std::string; +using std::set; +using std::transform; +using std::find_if; +using std::not1; +using std::ptr_fun; +using std::ifstream; +using std::cerr; +using std::vector; +using std::remove_if; + +#define INFO LOG_MAKEPRI(LOG_USER, LOG_INFO) +#define WARN LOG_MAKEPRI(LOG_USER, LOG_WARNING) +#define DEBUG LOG_MAKEPRI(LOG_USER, LOG_DEBUG) +#define MAX_PENDING_REQUESTS 20 +#define BUFFER_SIZE 8192 + +namespace { + +/** Tracks whether the server should only support protocol 1.0. */ +bool old_only(false); + +/** Tracks whether the server should support status queries. */ +bool status_enabled(false); + +/** Tracks whether the server should run as a daemon. */ +bool standalone(false); + +/** Our set of hashes, represented as a set of strings. Note + * that the current NSRL library contains approximately 32 + * million values, each at roughly 64 bytes (rounded to binary + * powers to make the math easier). This is 2**25 values times + * 2**6 bytes each = 2**31 bytes, or about two gigs of RAM. + * + * Moral of the story: populating this set is computationally + * expensive. */ +set hash_set; + +/** Tracks where we look for the location of the + * reference data set. */ +string RDS_LOC(PKGDATADIR "/NSRLFile.txt"); + +/** Keeps track of the last time we serviced a request. + * This is locked via the active_sessions_mutex mutex.*/ +time_t last_req_at(time(0)); + +/** Keeps track of how many clients are currently being serviced. + * This is locked via the active_sessions_mutex mutex. */ +int32_t active_sessions(0); + +/** A mutex to keep various threads from clobbering each other + * in their fanatical zeal to update shared resources. + * + * Interestingly, PTHREAD_MUTEX_INITIALIZER is so complex that + * it cannot be used in a C++ initializer: you have to use old + * C-style equals-operator initialization. */ +pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER; + +/** The server's inactivity timeout interval */ +int32_t TIMEOUT(INT_MAX); + +/** Which port to listen on */ +uint16_t PORT(9120); + +/** A convenience class allowing us to pass multiple pieces of + data with a void*. */ +struct clientinfo { + clientinfo(int32_t sfd, const char* ipaddr) : + sock_fd(sfd), ip_address(ipaddr) {} + int32_t sock_fd; + string ip_address; +}; + + +/** Determines whether a character represents a valid uppercase + * hexadecimal digit. */ + +bool is_hexit(char ch) +{ + return (ch >= '0' and ch <= '9') or (ch >= 'A' and ch <= 'F'); +} + +/** Loads hashes from disk and stores them in a fast-accessing + * in-memory data structure. This will be slow. */ +void load_hashes() +{ + vector buf(BUFFER_SIZE); + ifstream infile(RDS_LOC.c_str()); + + if (not infile.good()) { + syslog(WARN, "couldn't open hashes file %s", + RDS_LOC.c_str()); + exit(EXIT_FAILURE); + } + + while (infile) { + // Per the C++ spec, &vector[loc] is guaranteed + // to be a T*. (Unless it's a vector, in which + // case you're living in such sin there's absolutely + // no help for you. Friends don't let friends use + // vector.) + memset(static_cast(&buf[0]), 0, BUFFER_SIZE); + infile.getline(&buf[0], BUFFER_SIZE); + string line(buf.begin(), buf.end()); + string::iterator iter(line.begin()); + string token(""); + + while (iter != line.end()) { + string::iterator end(find(iter, line.end(), ',')); + token = string(iter, end); + transform(token.begin(), token.end(), token.begin(), ::toupper); + token.erase(remove_if(token.begin(), + token.end(), + not1(ptr_fun(is_hexit))), + token.end()); + if (32 == token.size() || 40 == token.size() || 64 == token.size()) { + break; + } + iter = (end == line.end() ? line.end() : end + 1); + } + + if (32 != token.size() && 40 != token.size() && 64 != token.size()) { + continue; + } + if (hash_set.size() > 0 and hash_set.size() % 1000000 == 0) { + syslog(INFO, "%lu million hashes read", hash_set.size() / 1000000); + } + hash_set.insert(token); + } + infile.close(); + syslog(INFO, "read in %u unique hashes", + static_cast(hash_set.size())); +} + +/** A thin wrapper around handler.cc and handle_client, meant + * to ensure the programmer of that function doesn't have to + * worry about thread contention. */ +void* run_client_thread(void* arg) +{ + clientinfo* ci(static_cast(arg)); + const int32_t sock_fd(ci->sock_fd); + const string ip_address(ci->ip_address); + + // Delete the dynamically-allocated memory block. This + // is an inevitable line of execution after successfully + // allocating the block in the main loop (below). + delete ci; + + if (0 != pthread_mutex_lock(&mutex)) { + syslog(WARN, "couldn't acquire the mutex!"); + close(sock_fd); + exit(EXIT_FAILURE); + } + last_req_at = time(0); + active_sessions += 1; + if (0 != pthread_mutex_unlock(&mutex)) { + syslog(WARN, "couldn't release the mutex!"); + close(sock_fd); + exit(EXIT_FAILURE); + } + + syslog(INFO, "connection from %s", ip_address.c_str()); + + handle_client(sock_fd, ip_address); + + close(sock_fd); + + syslog(INFO, "disconnected from %s", ip_address.c_str()); + + if (0 != pthread_mutex_lock(&mutex)) { + syslog(WARN, "couldn't acquire the mutex!"); + exit(-1); + } + active_sessions -= 1; + if (0 != pthread_mutex_unlock(&mutex)) { + syslog(WARN, "couldn't release the mutex!"); + exit(EXIT_FAILURE); + } + return NULL; +} + + +/** Converts our application into a proper daemon. */ +void daemonize() +{ + const pid_t pid(fork()); + if (pid < 0) { + syslog(WARN, "couldn't fork!"); + exit(EXIT_FAILURE); + } else if (pid > 0) { + exit(EXIT_SUCCESS); + } + + syslog(INFO, "daemon started"); + umask(0); + + if (setsid() < 0) { + syslog(WARN, "couldn't set sid"); + exit(EXIT_FAILURE); + } + // Technically, the root directory is the only one guaranteed + // to exist on the filesystem. Therefore, it's the only safe + // directory to point our daemon at. I doubt this is strictly + // necessary, but remembering to completely rebase a daemon is + // part of just good hacking etiquette. + if (0 > chdir("/")) { + syslog(WARN, "couldn't chdir to root"); + exit(EXIT_FAILURE); + } + // No extraneous filehandles for us. Daemons lack stdio, so + // shut 'em on down. + close(STDIN_FILENO); + close(STDOUT_FILENO); + close(STDERR_FILENO); +} + + +/** Creates a server socket that will listen for clients. */ +int32_t make_socket() +{ + int32_t sock; + sockaddr_in server; + + memset(static_cast(&server), 0, sizeof(server)); + server.sin_family = AF_INET; + server.sin_addr.s_addr = htonl(INADDR_ANY); + server.sin_port = htons(PORT); + + if (0 > (sock = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP))) { + syslog(WARN, "couldn't create a server socket"); + exit(EXIT_FAILURE); + } + if (0 > bind(sock, reinterpret_cast(&server), + sizeof(server))) { + syslog(WARN, "couldn't bind to port 9120"); + exit(EXIT_FAILURE); + } + if (0 > listen(sock, MAX_PENDING_REQUESTS)) { + syslog(WARN, "couldn't listen for clients"); + exit(EXIT_FAILURE); + } + syslog(INFO, "ready for clients"); + return sock; +} + +/** A thread that runs every thirty seconds checking to see if the + * daemon should politely exit. It will automatically shut down + * if no clients are currently being serviced and more than + * AUTOSHUTDOWN seconds have elapsed since the time the last client + * connected. */ +void* shutdown_handler(void*) +{ + while (1) { + if (0 != pthread_mutex_lock(&mutex)) { + syslog(WARN, "shutdown handler couldn't get mutex"); + exit(EXIT_FAILURE); + } + if (0 == active_sessions && + (TIMEOUT < (time(0) - last_req_at))) { + syslog(INFO, "exiting normally due to inactivity"); + exit(EXIT_SUCCESS); + } + if (0 != pthread_mutex_unlock(&mutex)) { + syslog(WARN, "shutdown handler couldn't release mutex"); + exit(EXIT_FAILURE); + } + sleep(30); + } + return NULL; +} + +/** Checks a string to see if it's a valid base-10 number. */ +int32_t is_num(const string& num) +{ + string::const_iterator b(num.begin()); + string::const_iterator e(num.end()); + + return (e == find_if(b, e, not1(ptr_fun(::isdigit)))) + ? ::atoi(num.c_str()) + : -1; +} + +/** Checks a string to see whether it's a port in the range + * (1024, 65535) inclusive (i.e., in userspace). */ +bool validate_port(const string& foo) +{ + PORT = is_num(foo) & 0xFFFF; + return (PORT >= 1024); +} + +bool validate_timeout(const string& foo) +{ + int32_t timeout(is_num(foo)); + if (0 == timeout) { + timeout = INT_MAX; + } + else if (0 < timeout) { + TIMEOUT = timeout; + } + return (0 < timeout); +} + +void show_usage(const char* program_name) +{ + cerr << + "Usage: " << program_name << " [-vbhsSo -f FILE -p PORT -t TIMEOUT]\n\n" << + "-v : print version information\n" << + "-b : get information on reporting bugs\n" << + "-f : specify an alternate RDS (default: "<< PKGDATADIR << + "/NSRLFile.txt)\n" << + "-s : allow clients to query server status (default: disabled)\n" << + "-S : run as a normal process (do not run as a daemon)\n" << + "-o : only support old (1.0) nsrlsvr protocol\n" << + "-h : show this help message\n" << + "-p : listen on PORT, between 1024 and 65535 (default: 9120)\n" << + "-t : stop after TIMEOUT seconds of inactivity (default: disabled)\n\n"; + exit(EXIT_FAILURE); +} +} + +/** An externally available const reference to the hash set. */ +const set& hashes(hash_set); + +/** An externally available const reference to the variable storing + * whether or not status checking should be enabled. */ +const bool& enable_status(status_enabled); + +/** An externally available const reference to the variable storing + * whether or not only protocol 1.0 should be supported. */ +const bool& only_old(old_only); + +/** magic happens here */ +int main(int argc, char* argv[]) +{ + int32_t svr_sock(0); + int32_t client_sock(0); + sockaddr_in client; + uint32_t client_length(0); + pthread_t shutdown_handler_id; + string port_num("9120"); + string timeout("0"); + std::auto_ptr infile; + int32_t opt(0); + + while (-1 != (opt = getopt(argc, argv, "bsvof:hp:t:S"))) { + switch (opt) { + case 'v': + cerr << argv[0] << " " << PACKAGE_VERSION << "\n\n"; + exit(0); + break; + case 'b': + cerr << argv[0] << " " << PACKAGE_VERSION + << "\n" << PACKAGE_URL << "\n" << + "Praise, blame and bug reports to " << PACKAGE_BUGREPORT << ".\n\n" << + "Please be sure to include your operating system, version of your\n" << + "operating system, and a detailed description of how to recreate\n" << + "your bug.\n\n"; + exit(0); + break; + case 'f': + RDS_LOC = string((const char*) optarg); + infile = std::auto_ptr(new ifstream(RDS_LOC.c_str())); + if (not infile->good()) { + cerr << + "Error: the specified dataset file could not be found.\n\n"; + exit(EXIT_FAILURE); + } + // No explicit close: the auto_ptr will take care of that + // on object destruction. + break; + case 'h': + show_usage(argv[0]); + break; + case 'p': + port_num = string(optarg); + break; + case 't': + timeout = string(optarg); + break; + case 's': + status_enabled = true; + break; + case 'S': + standalone = true; + break; + case 'o': + old_only = true; + break; + default: + show_usage(argv[0]); + exit(EXIT_FAILURE); + } + } + + if (not (validate_port(port_num) and validate_timeout(timeout))) { + show_usage(argv[0]); + exit(EXIT_FAILURE); + } + + if (not standalone) + daemonize(); + + load_hashes(); + svr_sock = make_socket(); + + pthread_create(&shutdown_handler_id, NULL, shutdown_handler, NULL); + + while (true) { + client_length = sizeof(client); + if (0 > (client_sock = accept(svr_sock, + reinterpret_cast(&client), + &client_length))) { + syslog(WARN, "dropped a connection"); + } else { + try { + pthread_t thread_id; + const char* ipaddr(inet_ntoa(client.sin_addr)); + clientinfo* data(new clientinfo(client_sock, ipaddr)); + pthread_create(&thread_id, NULL, run_client_thread, data); + } catch (std::bad_alloc&) { + // There's no reason to have the server fall over: + // the sysadmin might be able to kill off whatever + // errant process is taking up all the RAM. + syslog(WARN, "Critically short of available RAM!"); + continue; + } + } + } +}