Blame SOURCES/hostapd.conf.5

faa14f
.\" Manpage for hostapd.conf.
faa14f
.\" Original scrape of https://www.daemon-systems.org/man/hostapd.conf.5.html
faa14f
.\" Contact linville@redhat.com to correct errors or typos.
faa14f
.TH hostapd.conf 5 "10 Feb 2021" "1.0" "hostapd.conf man page"
faa14f
.SH NAME
faa14f
hostapd.conf \- configuration file for hostapd(8) utility
faa14f
.SH DESCRIPTION
faa14f
The hostapd.conf utility is an authenticator for IEEE 802.11 networks.
faa14f
It provides full support for WPA/IEEE 802.11i and can also act as an IEEE
faa14f
802.1X Authenticator with a suitable backend Authentication Server
faa14f
(typically FreeRADIUS).
faa14f
The configuration file consists of global parameters and domain specific
faa14f
configuration:
faa14f
.P
faa14f
\(bu IEEE 802.1X-2004
faa14f
.P
faa14f
\(bu RADIUS client
faa14f
.P
faa14f
\(bu RADIUS authentication server
faa14f
.P
faa14f
\(bu WPA/IEEE 802.11i
faa14f
.SH GLOBAL PARAMETERS
faa14f
The following parameters are recognized:
faa14f
.SS interface
faa14f
Interface name.  Should be set in "hostap" mode.
faa14f
.SS debug
faa14f
Debugging mode: 0 = no, 1 = minimal, 2 = verbose, 3 = msg dumps,
faa14f
4 = excessive.
faa14f
.SS dump_file
faa14f
Dump file for state information (on SIGUSR1).
faa14f
.SS ctrl_interface
faa14f
The pathname of the directory in which hostapd(8) creates UNIX
faa14f
domain socket files for communication with frontend programs such
faa14f
as hostapd_cli(8).
faa14f
.SS ctrl_interface_group
faa14f
A group name or group ID to use in setting protection on the
faa14f
control interface file.  This can be set to allow non-root users
faa14f
to access the control interface files.  If no group is specified,
faa14f
the group ID of the control interface is not modified and will,
faa14f
typically, be the group ID of the directory in which the socket
faa14f
is created.
faa14f
.SH IEEE 802.1X-2004 PARAMETERS
faa14f
The following parameters are recognized:
faa14f
.SS ieee8021x
faa14f
Require IEEE 802.1X authorization.
faa14f
.SS eap_message
faa14f
Optional displayable message sent with EAP Request-Identity.
faa14f
.SS wep_key_len_broadcast
faa14f
Key lengths for broadcast keys.
faa14f
.SS wep_key_len_unicast
faa14f
Key lengths for unicast keys.
faa14f
.SS wep_rekey_period
faa14f
Rekeying period in seconds.
faa14f
.SS eapol_key_index_workaround
faa14f
EAPOL-Key index workaround (set bit7) for WinXP Supplicant.
faa14f
.SS eap_reauth_period
faa14f
EAP reauthentication period in seconds.  To disable
faa14f
reauthentication, use "0".
faa14f
.SH RADIUS CLIENT PARAMETERS
faa14f
The following parameters are recognized:
faa14f
.SS own_ip_addr
faa14f
The own IP address of the access point (used as NAS-IP-Address).
faa14f
.SS nas_identifier
faa14f
Optional NAS-Identifier string for RADIUS messages.
faa14f
.SS auth_server_addr, auth_server_port, auth_server_shared_secret
faa14f
RADIUS authentication server parameters.  Can be defined twice
faa14f
for secondary servers to be used if primary one does not reply to
faa14f
RADIUS packets.
faa14f
.SS acct_server_addr, acct_server_port, acct_server_shared_secret
faa14f
RADIUS accounting server parameters.  Can be defined twice for
faa14f
secondary servers to be used if primary one does not reply to
faa14f
RADIUS packets.
faa14f
.SS radius_retry_primary_interval
faa14f
Retry interval for trying to return to the primary RADIUS server
faa14f
(in seconds).
faa14f
.SS radius_acct_interim_interval
faa14f
Interim accounting update interval.  If this is set (larger than
faa14f
0) and acct_server is configured, hostapd(8) will send interim
faa14f
accounting updates every N seconds.
faa14f
.SH RADIUS AUTHENTICATION SERVER PARAMETERS
faa14f
The following parameters are recognized:
faa14f
.SS radius_server_clients
faa14f
File name of the RADIUS clients configuration for the RADIUS
faa14f
server.  If this is commented out, RADIUS server is disabled.
faa14f
.SS radius_server_auth_port
faa14f
The UDP port number for the RADIUS authentication server.
faa14f
.SS radius_server_ipv6
faa14f
Use IPv6 with RADIUS server.
faa14f
.SH WPA/IEEE 802.11i PARAMETERS
faa14f
The following parameters are recognized:
faa14f
.SS wpa
faa14f
Enable WPA.  Setting this variable configures the AP to require
faa14f
WPA (either WPA-PSK or WPA-RADIUS/EAP based on other
faa14f
configuration).
faa14f
.SS wpa_psk, wpa_passphrase
faa14f
WPA pre-shared keys for WPA-PSK.  This can be either entered as a
faa14f
256-bit secret in hex format (64 hex digits), wpa_psk, or as an
faa14f
ASCII passphrase (8..63 characters) that will be converted to
faa14f
PSK.  This conversion uses SSID so the PSK changes when ASCII
faa14f
passphrase is used and the SSID is changed.
faa14f
.SS wpa_psk_file
faa14f
Optionally, WPA PSKs can be read from a separate text file
faa14f
(containing a list of (PSK,MAC address) pairs.
faa14f
.SS wpa_key_mgmt
faa14f
Set of accepted key management algorithms (WPA-PSK, WPA-EAP, or
faa14f
both).
faa14f
.SS wpa_pairwise
faa14f
Set of accepted cipher suites (encryption algorithms) for
faa14f
pairwise keys (unicast packets).  See the example file for more
faa14f
information.
faa14f
.SS wpa_group_rekey
faa14f
Time interval for rekeying GTK (broadcast/multicast encryption
faa14f
keys) in seconds.
faa14f
.SS wpa_strict_rekey
faa14f
Rekey GTK when any STA that possesses the current GTK is leaving
faa14f
the BSS.
faa14f
.SS wpa_gmk_rekey
faa14f
Time interval for rekeying GMK (master key used internally to
faa14f
generate GTKs (in seconds).
faa14f
.SH SEE ALSO
faa14f
hostapd(8), hostapd_cli(8), /usr/share/examples/hostapd/hostapd.conf
faa14f
.SH HISTORY
faa14f
The hostapd.conf manual page and hostapd(8) functionality first appeared
faa14f
in NetBSD 4.0.
faa14f
.SH AUTHORS
faa14f
This manual page is derived from the README and hostapd.conf files in the
faa14f
hostapd distribution provided by Jouni Malinen <jkmaline@cc.hut.fi>.