summaryrefslogtreecommitdiffstats
path: root/doc/README.html.in
blob: 8675a90f7c347146cce30a9cbbf1c7eb132b873a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<?xml version="1.0" encoding="iso-8859-1"?> <!-- -*-html-helper-*- -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
<title>aeswepd @PACKAGE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>

<body>
<h1><a name="top">aeswepd @PACKAGE_VERSION@</a></h1>

<p><i>Copyright 2002,2003 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</i></p>

<ul class="toc">
    <li><a href="#license">License</a></li>
    <li><a href="#news">News</a></li>
    <li><a href="#overview">Overview</a></li>
    <li><a href="#status">Status</a></li>
    <li><a href="#documentation">Documentation</a></li>
    <li><a href="#requirements">Requirements</a></li>
    <li><a href="#installation">Installation</a></li>
    <li><a href="#acks">Acknowledgements</a></li>
    <li><a href="#download">Download</a></li>
</ul>

<h2><a name="license">License</a></h2>

<p>This program 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.</p>

<p>This program 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.</p>

<p>You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>

<h2><a name="news">News</a></h2>

<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>

<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>

<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>
  
<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>

<ol>
</ol>

<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><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>

<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><tt>aeswepd</tt> needs <a href="http://0pointer.de/lennart/projects/libdaemon/"><tt>libdaemon</tt></a>.</p>
 
<h2><a name="installation">Installation</a></h2>

<p>As this package is made with the GNU autotools you should run
<tt>./configure</tt> inside the distribution directory for configuring
the source tree. After that you should run <tt>make</tt> for
compilation and <tt>make install</tt> (as root) for installation of
<tt>aeswepd</tt>.</p>

<h2><a name="acks">Acknowledgements</a></h2>

<p>None so far</p>

<h2><a name="download">Download</a></h2>

<p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p>

<p>The current release is <a href="@PACKAGE_URL@aeswepd-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>

<p>Get <tt>aeswepd</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="https://seth.intheinter.net:8081/svn/aeswepd/">repository</a>.</p>

<hr/>
<address>Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, October 2003</address>

<div><i>$Id: README.html.in 48 2003-09-13 11:36:11Z lennart $</i></div>

</body>
</html>