diff options
| author | Lennart Poettering <lennart@poettering.net> | 2003-10-16 19:59:54 +0000 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2003-10-16 19:59:54 +0000 |
| commit | c4db3c56f3feb04592eeeb14ccda71fb92cc05a3 (patch) | |
| tree | 4c820a310e3fd4df961bf158e46591cc07776eee | |
| parent | 06ba2a37d32475c4aa00f4153515716104ee43f1 (diff) | |
documentation finished
git-svn-id: file:///home/lennart/svn/public/aeswepd/trunk@27 022f378f-78c4-0310-b860-d162c87e6274
| -rw-r--r-- | doc/README.html.in | 132 | ||||
| -rw-r--r-- | doc/style.css | 10 | ||||
| -rw-r--r-- | man/aeswepd.8.xml.in | 21 |
3 files changed, 51 insertions, 112 deletions
diff --git a/doc/README.html.in b/doc/README.html.in index 8675a90..7de603a 100644 --- a/doc/README.html.in +++ b/doc/README.html.in @@ -10,7 +10,7 @@ <body> <h1><a name="top">aeswepd @PACKAGE_VERSION@</a></h1> -<p><i>Copyright 2002,2003 Lennart Poettering <@PACKAGE_BUGREPORT@></i></p> +<p><i>Copyright 2003 Lennart Poettering <@PACKAGE_BUGREPORT@></i></p> <ul class="toc"> <li><a href="#license">License</a></li> @@ -44,117 +44,55 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p> <div class="news-date">Fri Sep 13 2003: </div> -<p class="news-text"><a href="@PACKAGE_URL@aeswepd-0.3.tar.gz">Version 0.3</a> released, splitted from <tt><a href="http://0pointer.de/lennart/projects/waproamd">waproamd</a></tt>, added documentation, manpage, some bug fixes.</p> +<p class="news-text"><a href="@PACKAGE_URL@aeswepd-0.3.tar.gz">Version 0.3</a> released, split from <tt><a href="http://0pointer.de/lennart/projects/waproamd/">waproamd</a></tt>, added documentation, manpage, some bug fixes.</p> <h2><a name="overview">Overview</a></h2> -<pre> -What is it? waproamd is a Linux WLAN roaming daemon for IEEE 802.11b -cards supported by a driver with wireless extension API. It may be -used for configuring WEP keys according to the WLANs available. It is -intended to be used in conjunction with ifplugd, which configures your -network automatically whenever an association with an AP suceeded. - -waproamd is intended to be used together with ifplugd. - -A short overview on the daemons involved and how they work together: - - waproamd: when not associated waproamd does periodic scans and tries - to associate to a sensible AP by running a script in - /etc/waproamd/scripts - - (built from waproamd-xxx.tar.gz) - - aeswepd: A daemon for doing AES based WEP rekeying, it is called by - /etc/waproamd/scripts/default if - /etc/waproamd/keys/[AP-MAC-ADDRESS].aes exists. It implements an - algorithm which is not standardized and only compatible with APs - using aeswepd as well. aeswepd may be used without waproamd. The - opposite is true as well. - - If you create a root-owned directory /var/lib/aeswepd all running - aeswepd instances will save the current wep keys to a file therein - which may be accessed via "aeswepls". - - (built from waproamd-xxx.tar.gz too) - - ifplugd: if an association succeeded ifplugd runs ifup for the - device (and ifdown if it is lost again) - - (built from ifplugd-xxx.tar.gz) - -waproamd will not issue scans while associated. - -The algorithm to select an AP if multiple are available is rather -simple: The first AP which has a script named by the AP MAC address -available in /etc/waproamd/scripts/ is seleted. If none has suh a -script /etc/waproamd/scripts/default is run for the first AP. - -waproamd requires libdaemon. - -waproamd is tested with hostap 0.0.3 only, with other drivers -ymmv. The host roaming feature of newer hostap releases might be -useful, however it is broken on 0.0.3 and not required by waproamd. - -Update: waproamd works fine with 0.0.4 - -waproamd requires a driver supporting the wireless extension v15 or -newer. Drivers supporting the iwevent ("wireless events") API are -useful, however not required. Unfortunately support for this API -cannot be detected automatically. Use the "-e" switch to disable it. - -waproamd requires a driver supporting scanning (iwlist scan) for -detecting the networks available. - -There is no need to compile, nor to install aeswepd if your interest is -limited to waproamd only. See "configure --help" for more information. - -no manpages, no further documentation included. Read the source, luke! - -waproamd relies on autoconf/automake for source code configuration and -building. - -The software packages involved are available from the following URLs: - - http://0pointer.de/lennart/projects/waproamd/ - http://0pointer.de/lennart/projects/libdaemon/ - http://0pointer.de/lennart/projects/ifplugd/ -</pre> +<p><tt>aeswepd</tt> 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. <tt>aeswepd</tt> strengthens the security of the weak hardware based, standards +compliant WEP technology.</p> + +<p><tt>aeswepd</tt> 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><tt>aeswepd</tt> has several advantages over other solutions to +improve WEP: it is easy to use, doesn't involve computing intensive +algorithms, doesn't increase traffic latency. On the other hand it has +several disadvantages as well: it requires an installation of +<tt>aeswepd</tt> on all network members, it is not standardized, +currently only APs which run a flavour of Linux may be used with +it.</p> <h2><a name="status">Status</a></h2> -<p>Version 0.3 is stable and has all the sensible features its users could think of.</p> +<p>Version 0.3 is more or less stable. It features only a single WEP key driver for local NICs supporting the Linux wireless extensions v15.</p> <h2><a name="documentation">Documentation</a></h2> -<p>Have a look on the man pages <a href="@PACKAGE_URL@aeswepd.8.xml"><tt>aeswepd(8)</tt></a>, <a href="@PACKAGE_URL@ifstatus.8.xml"><tt>ifstatus(8)</tt></a>, <a href="@PACKAGE_URL@aeswepd.conf.5.xml"><tt>aeswepd.conf(5)</tt></a>. (A XSLT capable browser is required)</p> - -<h3>Configuration</h3> - - -<h3>Troubleshooting</h3> - - -<h3>FAQ</h3> +<p>Have a look on the man page <a href="@PACKAGE_URL@aeswepd.8.xml"><tt>aeswepd(8)</tt></a>. (An XSLT capable browser is required)</p> -<ol> -</ol> +<p><tt>aeswepd</tt> has no configuration file. It is intended to be run with correct command line arguments from <tt>ifup</tt>/<tt>ifdown</tt> or <tt><a href="http://0pointer.de/projects/waproamd/">waproamd</a></tt>.</p> <h2><a name="requirements">Requirements</a></h2> -<p>A newer Linux Kernel (I think 2.2 is good enough, alltough I tested it -only with 2.4) with a compatible device driver and -ethernet card. Most modern cards and drivers are compatible, like mine -which works with the <tt>8139too</tt> driver.</p> +<p>A newer Linux Kernel with a compatible device driver and WLAN NIC +(Wireless extensions v15 or newer). Most modern cards and drivers are +compatible, like mines which work with the <tt>hostap</tt> driver, version 0.0.3 and above.</p> <p><tt>aeswepd</tt> was developed and tested on Debian GNU/Linux -"testing" from July 2003, it should work on most other Linux -distributions (and maybe Unix versions) since it uses GNU autoconf and -GNU libtool for source code configuration and shared library -management.</p> +"testing" from october 2003, it should work on most other Linux +distributions since it uses GNU autoconf for +source code configuration.</p> -<p>The machine used was a Medion 9580-F laptop with a Realtek 8139 -network card and a PRISM1 PCMCIA wireless LAN card.</p> +<p>The machines used for development are a Medion 9580-F laptop with a +TEAC and a ZONET PCMCIA WLAN NIC, and an 1 GHz Celeron PC with a noname PCI +WLAN NIC. All three cards feature a PRISM2 chipset.</p> <p><tt>aeswepd</tt> needs <a href="http://0pointer.de/lennart/projects/libdaemon/"><tt>libdaemon</tt></a>.</p> @@ -181,7 +119,7 @@ compilation and <tt>make install</tt> (as root) for installation of <hr/> <address>Lennart Poettering <@PACKAGE_BUGREPORT@>, October 2003</address> -<div><i>$Id: README.html.in 48 2003-09-13 11:36:11Z lennart $</i></div> +<div><i>$Id$</i></div> </body> </html> diff --git a/doc/style.css b/doc/style.css index 090bbc7..e122e35 100644 --- a/doc/style.css +++ b/doc/style.css @@ -1,20 +1,20 @@ -/* $Id: style.css 43 2003-09-13 11:25:11Z lennart $ */ +/* $Id$ */ /*** - * This file is part of ifplugd. + * This file is part of aeswepd. * - * ifplugd is free software; you can redistribute it and/or modify it + * 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. * - * ifplugd is distributed in the hope that it will be useful, but + * 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 ifplugd; if not, write to the Free Software Foundation, + * along with aeswepd; if not, write to the Free Software Foundation, * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. ***/ diff --git a/man/aeswepd.8.xml.in b/man/aeswepd.8.xml.in index 0677219..d666da9 100644 --- a/man/aeswepd.8.xml.in +++ b/man/aeswepd.8.xml.in @@ -29,12 +29,12 @@ <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> + <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 strengthens the security of the weak 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 @@ -84,7 +84,8 @@ <option> <p><opt>-t | --rekey-time=</opt><arg>SEC</arg></p> - <optdesc><p>Specify the rekeying interval in seconds.</p></optdesc> + <optdesc><p>Specify the rekeying interval in seconds. (default: + 900, that is 15 minutes)</p></optdesc> </option> <option> @@ -93,7 +94,7 @@ </option> <option> - <p><opt>-E | --keye-env=</opt><arg>ENV</arg></p> + <p><opt>-E | --key-env=</opt><arg>ENV</arg></p> <optdesc><p>Specify an environment variable to read the AES key to use from.</p></optdesc> </option> @@ -146,12 +147,12 @@ </options> <section name="Files"> - <p><file>/var/run/aeswepd.<aeswepdgt;.pid</file>: the pid file + <p><file>/var/run/aeswepd.<interface>.pid</file>: the pid file for aeswepd.</p> </section> <section name="Signals"> - <p><arg>SIGINT, SIGTERM, SIGTQUIT</arg> aeswepd will quit. This is issued by passing -k to aeswepd.</p> + <p><arg>SIGINT, SIGTERM, SIGQUIT</arg> aeswepd will quit. This is issued by passing -k to aeswepd.</p> <p><arg>SIGHUP</arg> aeswepd will rekey immediately.</p> </section> |