From 16e340c9e9bc9a2dab903349da4325da985e13db Mon Sep 17 00:00:00 2001 From: Stef Walter Date: Fri, 7 Apr 2006 15:46:19 +0000 Subject: Added documentation, licenses etc... --- AUTHORS | 2 +- COPYING | 2 +- ChangeLog | 2 + Makefile.am | 2 +- README | 3 + configure.in | 2 +- doc/BEGEMOT-MIB.txt | 59 +++++++++++++ doc/FOKUS-MIB.txt | 57 +++++++++++++ doc/Makefile.am | 12 +++ doc/PING-MIB.txt | 122 +++++++++++++++++++++++++++ doc/bsnmp-ping.8 | 118 ++++++++++++++++++++++++++ doc/man2html.pl | 230 +++++++++++++++++++++++++++++++++++++++++++++++++++ module/ping-tree.def | 37 +++++++++ module/usuals.h | 36 ++++++++ 14 files changed, 680 insertions(+), 4 deletions(-) create mode 100644 doc/BEGEMOT-MIB.txt create mode 100644 doc/FOKUS-MIB.txt create mode 100644 doc/Makefile.am create mode 100644 doc/PING-MIB.txt create mode 100644 doc/bsnmp-ping.8 create mode 100755 doc/man2html.pl diff --git a/AUTHORS b/AUTHORS index 0cc01a2..e967018 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1 +1 @@ -nielsen@memberwebs.com \ No newline at end of file +Nate Nielsen diff --git a/COPYING b/COPYING index a636b2c..fddaa97 100644 --- a/COPYING +++ b/COPYING @@ -1,6 +1,6 @@ LICENSE -Copyright (c) 2004, Nate Nielsen +Copyright (c) 2006, Nate Nielsen All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/ChangeLog b/ChangeLog index e69de29..01555b1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -0,0 +1,2 @@ +0.1 + Initial Release diff --git a/Makefile.am b/Makefile.am index 9bb1356..0dd0260 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,4 @@ # EXTRA_DIST = BUGS -SUBDIRS = module +SUBDIRS = module doc diff --git a/README b/README index e69de29..f30192a 100644 --- a/README +++ b/README @@ -0,0 +1,3 @@ +This is a module for bsnmpd (included with FreeBSD 6.x, installable on 5.x): + +http://people.freebsd.org/~harti/bsnmp/ diff --git a/configure.in b/configure.in index eae4aaa..ca506bd 100644 --- a/configure.in +++ b/configure.in @@ -36,5 +36,5 @@ AC_FUNC_MALLOC AC_FUNC_MEMCMP dnl TODO AC_CHECK_FUNCS([atexit inet_ntoa inet_pton memset strerror strspn strtol]) -AC_CONFIG_FILES([Makefile module/Makefile]) +AC_CONFIG_FILES([Makefile module/Makefile doc/Makefile]) AC_OUTPUT diff --git a/doc/BEGEMOT-MIB.txt b/doc/BEGEMOT-MIB.txt new file mode 100644 index 0000000..9d99eab --- /dev/null +++ b/doc/BEGEMOT-MIB.txt @@ -0,0 +1,59 @@ +-- +-- Copyright (c) 2001-2003 +-- Fraunhofer Institute for Open Communication Systems (FhG Fokus). +-- All rights reserved. +-- +-- Author: Harti Brandt +-- +-- Redistribution and use in source and binary forms, with or without +-- modification, are permitted provided that the following conditions +-- are met: +-- 1. Redistributions of source code must retain the above copyright +-- notice, this list of conditions and the following disclaimer. +-- 2. Redistributions in binary form must reproduce the above copyright +-- notice, this list of conditions and the following disclaimer in the +-- documentation and/or other materials provided with the distribution. +-- +-- THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND +-- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +-- ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE +-- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +-- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +-- OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +-- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +-- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +-- OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +-- SUCH DAMAGE. +-- +-- $Begemot: bsnmp/snmpd/BEGEMOT-MIB.txt,v 1.5 2004/08/06 08:47:07 brandt Exp $ +-- +-- Begemot private definitions and root. +-- +BEGEMOT-MIB DEFINITIONS ::= BEGIN + +IMPORTS + MODULE-IDENTITY + FROM SNMPv2-SMI + fokus + FROM FOKUS-MIB; + +begemot MODULE-IDENTITY + LAST-UPDATED "200201300000Z" + ORGANIZATION "Fraunhofer FOKUS, CATS" + CONTACT-INFO + " Hartmut Brandt + + Postal: Fraunhofer Institute for Open Communication Systems + Kaiserin-Augusta-Allee 31 + 10589 Berlin + Germany + + Fax: +49 30 3463 7352 + + E-mail: harti@freebsd.org" + DESCRIPTION + "The root of the Begemot subtree of the fokus tree." + ::= { fokus 1 } + +END diff --git a/doc/FOKUS-MIB.txt b/doc/FOKUS-MIB.txt new file mode 100644 index 0000000..d4671e8 --- /dev/null +++ b/doc/FOKUS-MIB.txt @@ -0,0 +1,57 @@ +-- +-- Copyright (c) 2001-2003 +-- Fraunhofer Institute for Open Communication Systems (FhG Fokus). +-- All rights reserved. +-- +-- Author: Harti Brandt +-- +-- Redistribution and use in source and binary forms, with or without +-- modification, are permitted provided that the following conditions +-- are met: +-- 1. Redistributions of source code must retain the above copyright +-- notice, this list of conditions and the following disclaimer. +-- 2. Redistributions in binary form must reproduce the above copyright +-- notice, this list of conditions and the following disclaimer in the +-- documentation and/or other materials provided with the distribution. +-- +-- THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND +-- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +-- ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE +-- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +-- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +-- OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +-- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +-- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +-- OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +-- SUCH DAMAGE. +-- +-- $Begemot: bsnmp/snmpd/FOKUS-MIB.txt,v 1.5 2004/08/06 08:47:08 brandt Exp $ +-- +-- Begemot private definitions and fokus root. +-- +FOKUS-MIB DEFINITIONS ::= BEGIN + +IMPORTS + MODULE-IDENTITY, enterprises + FROM SNMPv2-SMI; + +fokus MODULE-IDENTITY + LAST-UPDATED "200202050000Z" + ORGANIZATION "Fraunhofer FOKUS, CATS" + CONTACT-INFO + " Hartmut Brandt + + Postal: Fraunhofer Institute for Open Communication Systems + Kaiserin-Augusta-Allee 31 + 10589 Berlin + Germany + + Fax: +49 30 3463 7352 + + E-mail: harti@freebsd.org" + DESCRIPTION + "The root of the Fokus enterprises tree." + ::= { enterprises 12325 } + +END diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..51bc926 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,12 @@ + +man_MANS = bsnmp-ping.8 + +# Simple way to make docs +html: + perl man2html.pl bsnmp-ping.8 > bsnmp-ping.8.html + +EXTRA_DIST = $(man_MANS) \ + man2html.pl \ + BEGEMOT-MIB.txt \ + FOKUS-MIB.txt \ + PING-MIB.txt diff --git a/doc/PING-MIB.txt b/doc/PING-MIB.txt new file mode 100644 index 0000000..ac9c4e3 --- /dev/null +++ b/doc/PING-MIB.txt @@ -0,0 +1,122 @@ +-- +-- Copyright (c) 2006 +-- Nate Nielsen +-- +-- Redistribution and use in source and binary forms, with or without +-- modification, are permitted provided that the following conditions +-- are met: +-- 1. Redistributions of source code must retain the above copyright +-- notice, this list of conditions and the following disclaimer. +-- 2. Redistributions in binary form must reproduce the above copyright +-- notice, this list of conditions and the following disclaimer in the +-- documentation and/or other materials provided with the distribution. +-- +-- THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND +-- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +-- ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE +-- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +-- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +-- OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +-- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +-- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +-- OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +-- SUCH DAMAGE. +-- +REGEX-MIB DEFINITIONS ::= BEGIN + +IMPORTS + MODULE-IDENTITY, OBJECT-TYPE, Counter64, Integer32, TimeTicks, Unsigned32 + FROM SNMPv2-SMI + begemot + FROM BEGEMOT-MIB; + +ping MODULE-IDENTITY + LAST-UPDATED "200603290000Z" + ORGANIZATION "Nate Nielsen" + CONTACT-INFO "nielsen@memberwebs.com" + DESCRIPTION "The MIB for the bsnmp-ping module." + + ::= { begemot 204 } + +-- -------------------------------------------------------------------------- + +pingCount OBJECT-TYPE + SYNTAX Integer32 + MAX-ACCESS read-only + STATUS current + DESCRIPTION "Number of ping entries." + ::= { ping 0 } + +pingEntry OBJECT IDENTIFIER + ::= { ping 1 } + +-- +-- entry information +-- + +pingIndex OBJECT-TYPE + SYNTAX Integer32 + MAX-ACCESS read-only + STATUS current + DESCRIPTION "Index of this pingEntry." + :: { pingEntry 1 } + +pingHost OBJECT-TYPE + SYNTAX OCTET STRING + MAX-ACCESS read-only + STATUS current + DESCRIPTION "The host that this pingEntry sends ICMP echo packets to." + :: { pingEntry 2 } + +pingInterval OBJECT-TYPE + SYNTAX TimeTicks + UNITS "1/100th of a Second" + MAX-ACCESS read-only + STATUS current + DESCRIPTION "The frequency with which ICMP echo packets are sent to the pingHost." + ::= { pingEntry 3 } + +pingHistory OBJECT-TYPE + SYNTAX Integer32 + MAX-ACCESS read-only + STATUS current + DESCRIPTION "The amount of time (in units of pingInterval) to keep history." + :: { pingEntry 4 } + +pingResponses OBJECT-TYPE + SYNTAX Integer32 + MAX-ACCESS read-only + STATUS current + DESCRIPTION "The number of ICMP echo responses received during the pingHistory timespan." + :: { pingEntry 10 } + +pingDropped OBJECT-TYPE + SYNTAX Integer32 + MAX-ACCESS read-only + STATUS current + DESCRIPTION "The number of ICMP echo responses dropped during the pingHistory timespan." + :: { pingEntry 11 } + +pingLatencyAvg OBJECT-TYPE + SYNTAX Integer32 + MAX-ACCESS read-only + STATUS current + DESCRIPTION "The average latency (in ms) of responses received during the pingHistory timespan." + :: { pingEntry 12 } + +pingLatencyMin OBJECT-TYPE + SYNTAX Integer32 + MAX-ACCESS read-only + STATUS current + DESCRIPTION "The minimum latency (in ms) of responses received during the pingHistory timespan." + :: { pingEntry 13 } + +pingLatencyMin OBJECT-TYPE + SYNTAX Integer32 + MAX-ACCESS read-only + STATUS current + DESCRIPTION "The maximum latency (in ms) of responses received during the pingHistory timespan." + :: { pingEntry 14 } + +END diff --git a/doc/bsnmp-ping.8 b/doc/bsnmp-ping.8 new file mode 100644 index 0000000..4a4b1c8 --- /dev/null +++ b/doc/bsnmp-ping.8 @@ -0,0 +1,118 @@ +.\" +.\" Copyright (c) 2006, Nate Nielsen +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" * Redistributions of source code must retain the above +.\" copyright notice, this list of conditions and the +.\" following disclaimer. +.\" * Redistributions in binary form must reproduce the +.\" above copyright notice, this list of conditions and +.\" the following disclaimer in the documentation and/or +.\" other materials provided with the distribution. +.\" * The names of contributors to this software may not be +.\" used to endorse or promote products derived from this +.\" software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS +.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF +.\" THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +.\" DAMAGE. +.\" +.\" +.\" CONTRIBUTORS +.\" Nate Nielsen +.\" +.Dd April, 2006 +.Dt bsnmp-ping 8 +.Os bsnmp-ping +.Sh NAME +.Nm bsnmp-ping +.Nd an SNMP module which measures latency and reachability to hosts over a time period. +.Sh DESCRIPTION +.Nm +is a module for +.Xr bsnmpd 1 +which allows you to measure latency and reachability. It sends out ICMP packets +to the configured hosts. A history of received packets is maintained, and you can +query via SNMP how many dropped packets, maximum/minumum latency and other stats +for that history period. +.Pp +.Sh MIBS +The counters will be available as a table under the following MIB: +.Bd -literal -offset indent + .1.3.6.1.4.1.12325.1.204 +.Ed +.Pp +Or if the appropriate MIB.txt files have been installed: +.Bd -literal -offset indent + enterprises.fokus.begemot.ping +.Ed +.Pp +The following SNMP MIBs are available for use (where X is the counter index): +.Bl -tag -width Fl +.It Ar ping.pingCount +The number of hosts to ping. +.It Ar ping.pingEntry.pingIndex.X +The index of the host. +.It Ar ping.pingEntry.pingHost.X +The host (address) to which ICMP packets are being sent. +.It Ar ping.pingEntry.pingInterval.X +The interval (in TimeTicks, 100th of a second) between sent ICMP packets. +.It Ar ping.pingEntry.pingHistory.X +The time period (in pingInterval units, above) that history for received ICMP packets is maintained. +.It Ar ping.pingEntry.pingResponses.X +The number of responses received in the (pingHistory) time period. +.It Ar ping.pingEntry.pingDropped.X +The number of dropped packets in the (pingHistory) time period. +.It Ar ping.pingEntry.pingLatencyAvg.X +The average latency (ms) of ICMP responses in the time period. +.It Ar ping.pingEntry.pingLatencyMin.X +The minimum latency (ms) of ICMP responses in the time period. +.It Ar ping.pingEntry.pingLatencyMax.X +The maximum latency (ms) of ICMP responses in the time period. +.El +.Sh OPTIONS +To activate the +.Nm +module you must load the module in +.Pa /etc/snmpd.config +and configure the location for the UNIX socket and +.Xr bsnmp-regex.conf 5 +.Pp +Use the pingHost, pingInterval, and pingHistory SNMP MIBs in the +.pa /etc/snmpd.config +file to setup the hosts you'd like to ping. +.Sh EXAMPLES +The following example pings two hosts. The first gets pinged once per second, and +keeps a history for 300 seconds. The second is pinged 5 times per second, and the +history is kept for 30 seconds. +.Pp +The following would be added to +.Pa /etc/snmpd.config: +.Bd -literal -offset indent +begemotSnmpdModulePath."ping" = "/usr/local/lib/snmp_ping.so" +%ping +pingHost.1 = "10.8.9.2" +pingInterval.1 = 100 +pingHistory.1 = 300 + +pingHost.2 = "2.2.2.2" +pingInterval.1 = 20 +pingHistory.1 = 150 +.Ed +.Sh SEE ALSO +.Xr bsnmpd 1 +.Sh AUTHOR +.An Nate Nielsen Aq nielsen@memberwebs.com diff --git a/doc/man2html.pl b/doc/man2html.pl new file mode 100755 index 0000000..21e3ab5 --- /dev/null +++ b/doc/man2html.pl @@ -0,0 +1,230 @@ +#!/usr/bin/perl + +# TODO: We need to make this more resilient +# currently expects args without enforcing + +$FIL = $NAM = $SEC = @ARGV[0]; + +$NAM =~ s/^([^.]+)\..+$/$1/; +$SEC =~ s/^.+\.([^.]+)$/$1/; + +$command = "groff"; +@args = split(" ", "-Tascii -mdoc $FIL"); + +$enable_include_links = 0; + +man($NAM, $SEC); + +sub man { + local($name, $section) = @_; + local($_, $title, $head, *MAN); + local($html_name, $html_section, $prefix); + local(@manargs); + local($query) = $name; + + # $section =~ s/^([0-9ln]).*$/$1/; + $section =~ tr/A-Z/a-z/; + + $prefix = "Man "; + if ($alttitle) { + $prefix = ""; + $title = &encode_title($alttitle); + $head = &encode_data($alttitle); + } elsif ($section) { + $title = &encode_title("${name}($section)"); + $head = &encode_data("${name}($section)"); + } else { + $title = &encode_title("${name}"); + $head = &encode_data("${name}"); + } + + print &html_header("$title"); + print "

Man Page: ${title}

"; + print "
\n";
+
+    $html_name = &encode_data($name);
+    $html_section = &encode_data($section);
+
+    #print Dumper($sectionpath);
+    #print "yy $section yy $manpath\n";
+    if ($name =~ /^\s*$/) {
+        print "Empty input, no man page given.\n";
+        return;
+    }
+
+    if (index($name, '*') != -1) {
+        print "Invalid character input '*': $name\n";
+        return;
+    }
+
+    if ($section !~ /^[0-9ln]\w*$/ && $section ne '') {
+        print "Sorry, section `$section' is not valid\n";
+        return;
+    }
+
+    if (!$section) {
+        if ($sectionpath->{$manpath}) {
+            $section = "-S " . $sectionpath->{$manpath}{'path'};
+        } else {
+            $section =  '';
+        }
+    } else {
+        if ($sectionpath->{$manpath}{$section}) {
+            $section = "-S " . $sectionpath->{$manpath}{$section};
+        } else {
+            $section = "-S $section";
+        }
+    }
+
+    # print "X $command{'man'} @manargs -- x $name x\n";
+    &proc(*MAN, $command, @args) ||
+        &mydie ("$0: open of $command{'man'} command failed: $!\n");
+    if (eof(MAN)) {
+        # print "X $command{'man'} @manargs -- x $name x\n";
+        print "Sorry, no data found for `$html_name" .
+                ($html_section ? "($html_section)": '') . "'.\n";
+        return;
+    }
+
+    local($space) = 1;
+    local(@sect);
+    local($i, $j);
+    while() {
+        # remove tailing white space
+        if (/^\s+$/) {
+            next if $space;
+            $space = 1;
+        } else {
+            $space = 0;
+        }
+
+        $_ = &encode_data($_);
+        if($enable_include_links &&
+           m,()?\#include()?\s+()?\<\;(.*\.h)\>\;()?,) {
+            $match = $4; ($regexp = $match) =~ s/\./\\\./;
+            s,$regexp,\$match\,;
+        }
+        /^\s/ &&                         # skip headers
+            s,((<[IB]>)?[\w\_\.\-]+\s*()?\s*\(([1-9ln][a-zA-Z]*)\)),&mlnk($1),oige;
+
+        # detect E-Mail Addreses in manpages
+        if (/\@/) {
+            s/([a-z0-9_\-\.]+\@[a-z0-9\-\.]+\.[a-z]+)/$1<\/A>/gi;
+        }
+
+        # detect URLs in manpages
+        if (m%tp://%) {
+            s,((ftp|http)://[^\s<>\)]+),$1,gi;
+        }
+
+        if (/^\S+/ && m%^([^<]+)%) {
+            $i = $1; $j = &encode_url($i);
+            s%^([^<]+)%$i%;
+            push(@sect, $1);
+        }
+        print;
+    }
+    close(MAN);
+
+    print "
Copyright, N. Nielsen   [ back | home ]
";
+    print "\n";
+    print "\n";
+
+    # Sleep 0.35 seconds to avoid DoS attacs
+    select undef, undef, undef, 0.35;
+}
+
+# encode unknown data for use in ...</TITILE>
+sub encode_title {
+    # like encode_url but less strict (I couldn't find docs on this)
+    local($_) = @_;
+    s/([\000-\031\%\&\<\>\177-\377])/sprintf('%%%02x',ord($1))/eg;
+    $_;
+}
+
+# encode unknown data for use in a URL <A HREF="...">
+sub encode_url {
+    local($_) = @_;
+    # rfc1738 says that ";"|"/"|"?"|":"|"@"|"&"|"=" may be reserved.
+    # And % is the escape character so we escape it along with
+    # single-quote('), double-quote("), grave accent(`), less than(<),
+    # greater than(>), and non-US-ASCII characters (binary data),
+    # and white space.  Whew.
+    s/([\000-\032\;\/\?\:\@\&\=\%\'\"\`\<\>\177-\377 ])/sprintf('%%%02x',ord($1))/eg;
+    s/%20/+/g;
+    $_;
+}
+# encode unknown data for use inside markup attributes <MARKUP ATTR="...">
+sub encode_attribute {
+    # rfc1738 says to use entity references here
+    local($_) = @_;
+    s/([\000-\031\"\'\`\%\&\<\>\177-\377])/sprintf('\&#%03d;',ord($1))/eg;
+    $_;
+}
+# encode unknown text data for using as HTML,
+# treats ^H as overstrike ala nroff.
+sub encode_data {
+    local($_) = @_;
+    local($str);
+
+    # Escape &, < and >
+    s,\010[><&],,g;
+    s/\&/\&\;/g;
+    s/\</\<\;/g;
+    s/\>/\>\;/g;
+
+    s,((_\010.)+),($str = $1) =~ s/.\010//g; "<I>$str</I>";,ge;
+    s,(.\010)+,$1,g;
+
+    if (!s,((.\010.)+\s+(.\010.)+),($str = $1) =~ s/.\010//g; "<B>$str</B>";,ge) {
+        s,((.\010.)+),($str = $1) =~ s/.\010//g; "<B>$str</B>";,ge;
+    }
+
+    s,.\010,,g;
+
+    $_;
+}
+
+sub html_header {
+    return qq{<HTML>
+<HEAD>
+<TITLE>$_[0]
+
+
+
+
+
+\n\n};
+}
+
+sub mlnk {
+    local($matched) = @_;
+    return qq{$matched};
+}
+
+sub proc {
+    local(*FH, $prog, @args) = @_;
+    local($pid) = open(FH, "-|");
+    return undef unless defined($pid);
+    if ($pid == 0) {
+    exec $prog, @args;
+    &mydie("exec $prog failed\n");
+    }
+    1;
+}
+
+# CGI script must die with error status 0
+sub mydie {
+	local($message) = @_;
+	print &html_header("Error");
+	print $message;
+
+print qq{
+

+Index Page and Help
+
+
+};
+
+	exit(0);
+}
diff --git a/module/ping-tree.def b/module/ping-tree.def
index e80506a..37e843e 100644
--- a/module/ping-tree.def
+++ b/module/ping-tree.def
@@ -1,3 +1,40 @@
+#
+# Copyright (c) 2006, Nate Nielsen
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without 
+# modification, are permitted provided that the following conditions 
+# are met:
+# 
+#     * Redistributions of source code must retain the above 
+#       copyright notice, this list of conditions and the 
+#       following disclaimer.
+#     * Redistributions in binary form must reproduce the 
+#       above copyright notice, this list of conditions and 
+#       the following disclaimer in the documentation and/or 
+#       other materials provided with the distribution.
+#     * The names of contributors to this software may not be 
+#       used to endorse or promote products derived from this 
+#       software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
+# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
+# OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
+# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
+# THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
+# DAMAGE.
+# 
+#
+# CONTRIBUTORS
+#  Nate Nielsen 
+#
+
 (1 internet
   (4 private
     (1 enterprises
diff --git a/module/usuals.h b/module/usuals.h
index 6dc7b08..7e0cd8d 100644
--- a/module/usuals.h
+++ b/module/usuals.h
@@ -1,3 +1,39 @@
+/*
+ * Copyright (c) 2006, Nate Nielsen
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *     * Redistributions of source code must retain the above
+ *       copyright notice, this list of conditions and the
+ *       following disclaimer.
+ *     * Redistributions in binary form must reproduce the
+ *       above copyright notice, this list of conditions and
+ *       the following disclaimer in the documentation and/or
+ *       other materials provided with the distribution.
+ *     * The names of contributors to this software may not be
+ *       used to endorse or promote products derived from this
+ *       software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+ * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+ * DAMAGE.
+ *
+ *
+ * CONTRIBUTORS
+ *  Nate Nielsen 
+ */
 
 #ifndef __USUALS_H__
 #define __USUALS_H__
-- 
cgit v1.2.3