summaryrefslogtreecommitdiffstats
path: root/doc/README.html.in
blob: 726dec38e5a6d75ca4141ee42a984761cff9a191 (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
<?xml version="1.0" encoding="iso-8895-15"?> <!-- -*-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>waproamd @PACKAGE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>

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

<p><i>Copyright 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 Oct 17 2003: </div> <p class="news-text"><a
href="@PACKAGE_URL@waproamd-0.3b.tar.gz">Version 0.3b</a> released,
changes include: minor bug fixes.</p>

<div class="news-date">Fri Oct 17 2003: </div> <p class="news-text"><a
href="@PACKAGE_URL@waproamd-0.3.tar.gz">Version 0.3</a> released,
changes include: split <tt><a href="http://0pointer.de/lennart/projects/aeswepd/"><tt>aeswepd</tt></a></tt> into its
own package, add documentation, several bug fixes.</p>

<h2><a name="overview">Overview</a></h2>

<p><tt>waproamd</tt> is a roaming daemon for wireless IEEE 802.11 NICs supporting the
Linux wireless extensions. It is intended to configure the WEP
keys according to the networks found.</p>

<p><tt>waproamd</tt> is intended to be used together with <a href="http://0pointer.de/lennart/projects/ifplugd/"><tt>ifplugd</tt></a>. Whenever
an association succeeds, <tt>ifplugd</tt> detects it and runs further
configuration commands for it.</p>

<h2><a name="status">Status</a></h2>

<p>Version 0.3 works fine on <a href="http://www.hostap.org"><tt>hostap</tt></a> 0.0.4 and <tt>airolan</tt>. Other driver/card combinations not tested, but may work too.</p>
  
<h2><a name="documentation">Documentation</a></h2>

<p>Have a look on the man pages <a href="@PACKAGE_URL@waproamd.8.xml"><tt>waproamd(8)</tt></a>, <a href="@PACKAGE_URL@waproamd.conf.5.xml"><tt>waproamd.conf(5)</tt></a>. (An XSLT capable browser is required)</p>

<h3>Mode of Operation</h3>

<p>As long as the local NIC is not associated to any wireless
network <tt>waproamd</tt> scans iteratively for them. If one is detected, a
script in <tt>@sysconfdir@/waproamd/scripts/</tt> named after
the MAC address of the access point is called. If this script is
not existent, <tt>@sysconfdir@/waproamd/scripts/default</tt>
is called instead. The first argument to this script is
<tt>"start"</tt>. If the association is lost, the same script is run with
the argument <tt>"stop"</tt>. While the NIC is associated no scans are
issued.</p>

<p>If multiple WLANs are detected at the same time, the network
which is detected by the hardware first is selected. However,
networks where a matching script exists take precedence.</p>

<p><tt>waproamd</tt> requires a network driver supporting the Linux
wireless extensions v15 or newer. The driver needs to support scanning
for wireless networks, which may be tested by running <tt>"iwlist
scan"</tt>. If the driver supports the wireless event subsystem,
waproamd may use it to improve latency behaviour. It is not required,
however.</p>

<h3>Configuration</h3>

<p>Edit <tt>/etc/waproamd/waproamd.conf</tt> for configuration
changes. This file is a bourne shell script sourced by the init script
and used to generate a suiting command line. You may specify more than
one ethernet interface in <tt>INTERFACES</tt>. For each interface a
seperate instance of <tt>waproamd</tt> is spawned. The arguments specified in
<tt>ARGS</tt> are append to <tt>waproamd</tt>'s command line. Have a look on
<tt>waproamd -h</tt> or <tt>man waproamd</tt> for further information
about the options available.</p>

<p>Put your WEP keys in <tt>/etc/waproamd/keys/</tt> in files named
after the AP's MAC address with an appended <tt>.wep</tt>. If the AP
uses <a
href="http://0pointer.de/projects/lennart/aeswepd/"><tt>aeswepd</tt></a>
for automatic rekeying, you may put the AES key into a file with the
suffix <tt>.aes</tt> instead.</p>

<p>The configuration is similar to <tt>ifplugd</tt>.</p>

<h3>Troubleshooting</h3>

<p>Not all drivers/cards support the wireless event subsystem of the
Linux wireless extensions. Its support on your machine cannot be
detected automatically, you have to test it yourself with <tt>"iwlist
scan"</tt>. See <tt>man 8 iwlist</tt> for more information. If your
driver/card combination does not support this, you have to enable
polling of association status by passing <tt>-e</tt> on the command
line. This will increase the reaction latency of waproamd.</p>

<h2><a name="requirements">Requirements</a></h2>

<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 <a
href="http://www.hostap.org/"><tt>hostap</tt></a> driver, version
0.0.3 and above. The driver has to support the scanning interface,
wireless event support ist nice to have.</p>

<p><tt>waproamd</tt> was developed and tested on Debian GNU/Linux
"testing" from October 2003, it should work on most other Linux
distributions since it uses GNU autoconf for source code
configuration.</p>

<p>The machines used for development are a Medion 9580-F laptop with a
TEAC and a ZONET PCMCIA WLAN NIC. Both cards feature a PRISM2 chipset. <tt>hostap 0.0.4</tt> was used as driver.</p>

<p><tt>waproamd</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>waproamd</tt>.</p>

<p>The installation scripts create an init script in
<tt>${sysconfdir}/init.d/waproamd</tt>, however no <tt>/etc/rc?.d/</tt> links are created
for it.</p>

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

<p>Thomas Hood for patches</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@waproamd-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>

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

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

</body>
</html>