Large commit

git-svn-id: file:///home/lennart/svn/public/aeswepd/trunk@20 022f378f-78c4-0310-b860-d162c87e6274

4 files changed, 365 insertions, 0 deletions

diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..11ac17d
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,40 @@
+# $Id$
+
+# This file is part of aeswepd.
+#
+# aeswepd is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# aeswepd is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with aeswepd; if not, write to the Free Software Foundation,
+# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+
+man_MANS = aeswepd.8 aeswepls.8
+
+noinst_DATA = aeswepd.8.xml 
+
+EXTRA_DIST = $(man_MANS) aeswepd.8.xml.in man.css man.xsl
+
+CLEANFILES = aeswepd.8.xml aeswepls.8
+
+aeswepd.8.xml: aeswepd.8.xml.in Makefile
+	sed -e 's,@sysconfdir\@,$(sysconfdir),g' -e 's,@sbindir\@,$(sbindir),g' -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+if USE_XMLTOMAN
+
+CLEANFILES += $(man_MANS)
+
+aeswepd.8: aeswepd.8.xml Makefile
+	xmltoman $< > $@
+
+endif
+
+aeswepls.8: aeswepd.8
+	ln -sf $< $@
diff --git a/man/aeswepd.8.xml.in b/man/aeswepd.8.xml.in
new file mode 100644
index 0000000..3fb3557
--- /dev/null
+++ b/man/aeswepd.8.xml.in
@@ -0,0 +1,175 @@
+<?xml version="1.0" standalone='no'?>
+<!DOCTYPE manpage SYSTEM "man.dtd">
+<?xml-stylesheet type="text/xsl" href="man.xsl" ?>
+
+<!-- $Id$ -->
+
+<!-- 
+  This file is part of aeswepd.
+
+  aeswepd is free software; you can redistribute it and/or modify it under
+  the terms of the GNU General Public License as published by the Free
+  Software Foundation; either version 2 of the License, or (at your
+  option) any later version.
+
+  aeswepd is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+  for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with aeswepd; if not, write to the Free Software Foundation,
+  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+-->
+
+  <manpage name="aeswepd" section="8" desc="AES Rekeying Daemon for IEEE 802.11 WEP">
+
+	<synopsis>
+	  <cmd>aeswepd [<arg>options</arg>]</cmd>
+      <cmd>aeswepls [<arg>options</arg>]</cmd>
+	</synopsis>
+	
+	<description>
+	  <p>aeswepd is UNIX daemon for changing WEP keys of WLAN devices
+	  in constant intervals. The WEP keys are calculated by encrypting
+	  the current UNIX time using the AES cypher with a given constant
+	  key. aeswepd is intended to increase the security of the
+	  hardware based, standards compliant WEP technology. </p>
+	  
+     <p>aeswepd may use up to three hardware WEP keys: the first is
+     set to the current, the second to the previous and the third to
+     the next key. This is useful when working with not completely
+     synchronized RTCs. If only a single hardware WEP key is used, you
+     have to synchronize your RTCs so that no connectivity interrupts
+     may occur.</p>
+
+     <p>Currently, aeswepd is able to modify the WEP keys of local
+     network devices providing the Linux wireless extensions only.</p>
+
+     <p>aeswepls may be used to query the current keys of a running
+     daemon for the specified interface.</p>
+
+	</description>
+	
+	<options>
+	  
+	  <option>
+		<p><opt>-n | --no-daemon</opt></p>
+		<optdesc><p>
+			Do not daemonize (for debugging) (default: off)
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-s | --no-syslog</opt></p>
+		<optdesc><p>
+			Do not use syslog, use stdout instead (for debugging) (default: off).
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-i | --iface=</opt> <arg>IFACE</arg></p>
+		<optdesc><p>
+			Specify ethernet interface (default: eth0)
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-w | --wait-on-fork</opt></p> 
+
+		<optdesc><p> When daemonizing, wait until the background
+		process finished with the initial link beat detection. When
+		this is enabled, the parent process will return the link
+		status on exit. 1 means link beat detected, 2 stands for link
+		beat not detected, everything else is an error.
+		</p></optdesc>
+	  </option>
+
+      <option>
+       <p><opt>-t | --rekey-time=</opt> <arg>SEC</arg></p>
+       <optdesc><p>Specify the rekeying interval in seconds.</p></optdesc>
+      </option>
+
+      <option>
+       <p><opt>-K | --key</opt> <arg>KEY</arg></p>
+       <optdesc><p>Specify the AES key to use. Don't use this options, since users may get access to the key by running <file>ps</file>.</p></optdesc>
+      </option>
+
+      <option>
+       <p><opt>-E | --keye-env</opt> <arg>ENV</arg></p>
+       <optdesc><p>Specify an environment variable to read the AES key to use from.</p></optdesc>
+      </option>
+
+      <option>
+       <p><opt>-F | --key-file</opt> <arg>FILE</arg></p>
+       <optdesc><p>Specify a file to read the AES key to use from.</p></optdesc>
+      </option>
+
+      <option>
+       <p><opt>-m | --max-keys=</opt> <arg>NR</arg></p>
+       <optdesc><p>Specify how many hardware WEP keys are to be used
+       by aeswepd. Currently only 1 and 3 are supported. Most 802.11
+       hardware is capable to use up to four distinct WEP keys
+       concurrently.</p></optdesc>
+      </option>
+
+      <option>
+        <p><opt>-l | --list-keys</opt></p>
+        <optdesc><p>Show keys of running daemon for the specified interface. This is implied if the binary is called as <file>aeswepls</file></p></optdesc>
+      </option>
+
+	  <option>
+		<p><opt>-h | --help</opt></p>
+		<optdesc><p>
+			Show help
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-k | --kill</opt></p>
+		<optdesc><p>
+			Kill a running daemon (Specify -i to select the daemon instance to kill)
+		  </p></optdesc>
+	  </option>
+
+	  <option>
+		<p><opt>-c | --check-running</opt></p>
+		<optdesc><p>
+			Check if a daemon is running for a given network interface. Sets the return value to 0 if a daemon is already running or to 255 if not.
+		  </p></optdesc>
+	  </option>
+	  
+	  <option>
+		<p><opt>-v | --version</opt></p>
+		<optdesc><p>
+			Show version
+		  </p></optdesc>
+	  </option>
+	  
+	</options>
+	
+    <section name="Signals">
+      <p><arg>SIGINT, SIGTERM, SIGTQUIT</arg> aeswepd will quit. This is issued by passing -k to aeswepd.</p>
+      <p><arg>SIGHUP</arg> aeswepd will rekey immediately.</p>
+    </section>
+
+	<section name="Author">
+	  <p>aeswepd was written by Lennart Poettering
+		&lt;@PACKAGE_BUGREPORT@&gt;. aeswepd is available
+		at <url
+		href="@PACKAGE_URL@"/>
+	  </p>
+	</section>
+	
+	<section name="See also">
+	  <p>
+		<manref name="waproamd" section="8"/>, <manref name="iwconfig" section="8"/>
+	  </p>
+	</section>
+	
+	<section name="Comments">
+	  <p>This man page was written using <manref name="xmltoman" section="1"
+		  href="http://masqmail.cx/xml2man/"/> by Oliver Kurth.</p>
+	</section>
+	
+  </manpage>
diff --git a/man/man.css b/man/man.css
new file mode 100644
index 0000000..0892e4f
--- /dev/null
+++ b/man/man.css
@@ -0,0 +1,30 @@
+/* $Id$ */
+
+/***
+  This file is part of ifplugd.
+
+  ifplugd is free software; you can redistribute it and/or modify it under
+  the terms of the GNU General Public License as published by the Free
+  Software Foundation; either version 2 of the License, or (at your
+  option) any later version.
+
+  ifplugd is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+  for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with ifplugd; if not, write to the Free Software Foundation,
+  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+***/
+
+body { color: black; background-color: white; margin: 0.5cm; } 
+a:link, a:visited { color: #900000; }       
+h1 { text-transform:uppercase; font-size: 18pt; color: #00009F; }
+p { margin-left:1cm; margin-right:1cm; }
+.cmd { font-family:monospace; }
+.file { font-family:monospace; }
+.arg { text-transform:uppercase; font-family:monospace; font-style: italic; }
+.opt { font-family:monospace; font-weight: bold;  }
+.manref { font-family:monospace; }
+.option .optdesc { margin-left:2cm; }
diff --git a/man/man.xsl b/man/man.xsl
new file mode 100644
index 0000000..e633de1
--- /dev/null
+++ b/man/man.xsl
@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml">
+
+<!-- 
+  This file is part of ifplugd.
+
+  ifplugd is free software; you can redistribute it and/or modify it under
+  the terms of the GNU General Public License as published by the Free
+  Software Foundation; either version 2 of the License, or (at your
+  option) any later version.
+
+  ifplugd is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+  for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with ifplugd; if not, write to the Free Software Foundation,
+  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+-->
+
+<xsl:template match="/manpage">
+    <xsl:text disable-output-escaping="yes">
+    &lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"&gt;
+    </xsl:text>
+    <html>
+
+    <head>
+      <title>
+        <xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>) 
+      </title>
+      <link rel="stylesheet" type="text/css" href="man.css"/>
+    </head>
+    <body>
+      <h1>Name</h1>
+      <p><xsl:value-of select="@name"/>
+        <xsl:if test="string-length(@desc) &gt; 0">
+          - <xsl:value-of select="@desc"/>
+        </xsl:if>
+      </p>
+      <xsl:apply-templates />
+    </body>
+  </html>
+</xsl:template>
+
+<xsl:template match="p">
+ <p>
+  <xsl:apply-templates/>
+ </p>
+</xsl:template>
+
+<xsl:template match="cmd">
+ <p class="cmd">
+  <xsl:apply-templates/>
+ </p>
+</xsl:template>
+
+<xsl:template match="arg">
+  <span class="arg"><xsl:apply-templates/></span>
+</xsl:template>
+
+<xsl:template match="opt">
+  <span class="opt"><xsl:apply-templates/></span>
+</xsl:template>
+
+<xsl:template match="file">
+  <span class="file"><xsl:apply-templates/></span>
+</xsl:template>
+
+<xsl:template match="optdesc">
+  <div class="optdesc">
+    <xsl:apply-templates/>
+  </div>
+</xsl:template>
+
+<xsl:template match="synopsis">
+  <h1>Synopsis</h1>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="seealso">
+  <h1>Synopsis</h1>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="description">
+  <h1>Description</h1>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="options">
+  <h1>Options</h1>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="section">
+  <h1><xsl:value-of select="@name"/></h1>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="option">
+  <div class="option"><xsl:apply-templates/></div>
+</xsl:template>
+
+<xsl:template match="manref">
+  <xsl:choose>
+    <xsl:when test="string-length(@href) &gt; 0">
+    <a class="manref"><xsl:attribute name="href"><xsl:value-of select="@href"/></xsl:attribute><xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>)</a>
+    </xsl:when>
+    <xsl:otherwise>
+    <span class="manref"><xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>)</span>
+    </xsl:otherwise>
+  </xsl:choose>
+</xsl:template>
+
+<xsl:template match="url">
+  <a class="url"><xsl:attribute name="href"><xsl:value-of select="@href"/></xsl:attribute><xsl:value-of select="@href"/></a>
+</xsl:template>
+
+</xsl:stylesheet>