Blame SOURCES/hostapd.conf.5

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