xref: /openbsd/usr.sbin/hostapd/hostapd.8 (revision e5dd7070)
1.\" $OpenBSD: hostapd.8,v 1.21 2015/03/26 20:34:54 jmc Exp $
2.\"
3.\" Copyright (c) 2004, 2005 Reyk Floeter <reyk@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: March 26 2015 $
18.Dt HOSTAPD 8
19.Os
20.Sh NAME
21.Nm hostapd
22.Nd Host Access Point daemon
23.Sh SYNOPSIS
24.Nm hostapd
25.Op Fl dv
26.Op Fl D Ar macro Ns = Ns Ar value
27.Op Fl f Ar file
28.Sh DESCRIPTION
29.Nm
30is a daemon which allows communication between different 802.11
31wireless access points running in
32.Em Host AP
33mode.
34.Pp
35.Nm
36implements the Inter Access Point Protocol (IAPP).
37Its purpose is to exchange station association updates between access
38points in large wireless networks.
39IAPP has been designed to speed up roaming between different access
40points in the same Extended Service Set (ESS).
41IAPP is described in the IEEE 802.11f standard.
42.Pp
43.Nm
44additionally allows the monitoring and logging of station associations on a
45non-hostap host which is receiving IAPP messages.
46.Pp
47.Nm
48uses two network interfaces on startup specified in the configuration file
49.Xr hostapd.conf 5 .
50The first interface is used to access the Host AP,
51which is a wireless interface running in Host AP mode.
52Host AP mode can be enabled using
53.Xr ifconfig 8 .
54The second interface is used to communicate with other
55.Nm
56in the same broadcast domain or multicast group.
57Usually a wired interface is used to communicate with other
58.Nm .
59.Pp
60.Nm
61broadcasts an
62.Em ADD.notify
63IAPP message when a new station is associated to the Host AP.
64When
65.Nm
66receives an ADD.notify message it tells the Host AP
67to remove the specified station.
68.Pp
69.Nm
70may also handle dynamic roaming of IP addresses and routes in
71addition to the standard IAPP ADD.notify behaviour.
72See the section called IP Roaming in
73.Xr hostapd.conf 5
74for details.
75.Pp
76The options are as follows:
77.Bl -tag -width Ds
78.It Fl D Ar macro Ns = Ns Ar value
79Define
80.Ar macro
81to be set to
82.Ar value
83on the command line.
84Overrides the definition of
85.Ar macro
86in the configuration file.
87.It Fl d
88Do not daemonize and log to
89.Em stderr .
90.It Fl f Ar file
91Use
92.Ar file
93as the configuration file, instead of the default
94.Pa /etc/hostapd.conf .
95.It Fl v
96Produce more verbose output.
97.El
98.Sh FILES
99.Bl -tag -width "/etc/hostapd.confXXX" -compact
100.It Pa /etc/hostapd.conf
101default
102.Nm
103configuration file
104.El
105.Sh SEE ALSO
106.Xr hostapd.conf 5 ,
107.Xr ifconfig 8
108.Rs
109.%R IEEE 802.11f
110.%T Inter Access Point Protocol
111.%D March 2001
112.Re
113.Sh HISTORY
114The
115.Nm
116program first appeared at the 21st Chaos Communication Congress
117.Pq Lk http://www.ccc.de/congress/2004/
118and later in
119.Ox 3.8 .
120.Sh AUTHORS
121The
122.Nm
123program was written by
124.An Reyk Floeter Aq Mt reyk@openbsd.org .
125.Sh CAVEATS
126.Nm
127depends on drivers using the net80211
128kernel wireless layer with support of Host AP mode.
129For traditional reasons,
130the
131.Xr wi 4
132driver still uses its own Host AP code in
133.Fn if_wi_hostap ,
134which is not supported by
135.Nm .
136.Pp
137The IEEE 802.11 WLAN protocol lacks authentication of management
138frames and is vulnerable to various denial of service and
139man-in-the-middle attacks.
140That should be considered when implementing wireless networks
141with
142.Nm .
143