Blame SOURCES/hostapd.conf.5

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