aboutsummaryrefslogtreecommitdiffstats
path: root/doc/code_structure.doxygen
diff options
context:
space:
mode:
authorJouni Malinen <j@w1.fi>2015-01-03 13:44:35 (GMT)
committerJouni Malinen <j@w1.fi>2015-01-03 13:44:35 (GMT)
commit5eb513c3baec763381b3002ce344e6dc6c5010b9 (patch)
tree83aa828d13d362dc7927035df42f2e7ff1e0ce73 /doc/code_structure.doxygen
parentbbd89bfca0b446d605c4cc38cedf55eb81d0eed7 (diff)
downloadhostap-5eb513c3baec763381b3002ce344e6dc6c5010b9.zip
hostap-5eb513c3baec763381b3002ce344e6dc6c5010b9.tar.gz
hostap-5eb513c3baec763381b3002ce344e6dc6c5010b9.tar.bz2
doc: Disable Doxygen autolink support
The way autolink support is implementing in Doxygen is a bit inconvenient with wpa_supplicant being recognized as something that would always be linked to struct wpa_supplicant. In addition, number of links were not really noticed automatically. To get this working more robustly and without having to use the %wpa_supplicant workaround (which had its own issues, e.g., with titles), disable autolinking and use explicit \ref commands instead. This is also updating some of the obsolete notes to point to correct file names, etc. changes in the source code tree. Signed-off-by: Jouni Malinen <j@w1.fi>
Diffstat (limited to 'doc/code_structure.doxygen')
-rw-r--r--doc/code_structure.doxygen183
1 files changed, 88 insertions, 95 deletions
diff --git a/doc/code_structure.doxygen b/doc/code_structure.doxygen
index 26f5f6d..454f179 100644
--- a/doc/code_structure.doxygen
+++ b/doc/code_structure.doxygen
@@ -13,7 +13,7 @@
\ref win_port "Windows port" |
\ref test_programs "Test programs" ]
-%wpa_supplicant implementation is divided into number of independent
+wpa_supplicant implementation is divided into number of independent
modules. Core code includes functionality for controlling the network
selection, association, and configuration. Independent modules include
WPA code (key handshake, PMKSA caching, pre-authentication), EAPOL
@@ -21,82 +21,77 @@ state machine, and EAP state machine and methods. In addition, there
are number of separate files for generic helper functions.
Both WPA and EAPOL/EAP state machines can be used separately in other
-programs than %wpa_supplicant. As an example, the included test
+programs than wpa_supplicant. As an example, the included test
programs eapol_test and preauth_test are using these modules.
-\ref driver_wrapper "Driver interface API" is defined in driver.h and
+\ref driver_wrapper "Driver interface API" is defined in \ref driver.h and
all hardware/driver dependent functionality is implemented in
driver_*.c.
\section _wpa_supplicant_core wpa_supplicant core functionality
-wpa_supplicant.c
+\ref wpa_supplicant.c
Program initialization, main control loop
-main.c
+\ref wpa_supplicant/main.c
main() for UNIX-like operating systems and MinGW (Windows); this
uses command line arguments to configure wpa_supplicant
-events.c
- Driver event processing; wpa_supplicant_event() and related functions
+\ref events.c
+ Driver event processing; \ref wpa_supplicant_event() and related functions
-wpa_supplicant_i.h
- Internal definitions for %wpa_supplicant core; should not be
+\ref wpa_supplicant_i.h
+ Internal definitions for wpa_supplicant core; should not be
included into independent modules
\section generic_helper_func Generic helper functions
-%wpa_supplicant uses generic helper functions some of which are shared
+wpa_supplicant uses generic helper functions some of which are shared
with with hostapd. The following C files are currently used:
-eloop.c and eloop.h
+\ref eloop.c and \ref eloop.h
Event loop (select() loop with registerable timeouts, socket read
callbacks, and signal callbacks)
-common.c and common.h
+\ref common.c and \ref common.h
Common helper functions
-defs.h
+\ref defs.h
Definitions shared by multiple files
-l2_packet.h, l2_packet_linux.c, and l2_packet_pcap.c
+\ref l2_packet.h, \ref l2_packet_linux.c, and \ref l2_packet_pcap.c
Layer 2 (link) access wrapper (includes native Linux implementation
and wrappers for libdnet/libpcap). A new l2_packet implementation
may need to be added when porting to new operating systems that are
not supported by libdnet/libpcap. Makefile can be used to select which
- l2_packet implementation is included. l2_packet_linux.c uses Linux
- packet sockets and l2_packet_pcap.c has a more portable version using
+ l2_packet implementation is included. \ref l2_packet_linux.c uses Linux
+ packet sockets and \ref l2_packet_pcap.c has a more portable version using
libpcap and libdnet.
-pcsc_funcs.c and pcsc_funcs.h
+\ref pcsc_funcs.c and \ref pcsc_funcs.h
Wrapper for PC/SC lite SIM and smart card readers
-priv_netlink.h
+\ref priv_netlink.h
Private version of netlink definitions from Linux kernel header files;
this could be replaced with C library header file once suitable
version becomes commonly available
-version.h
+\ref version.h
Version number definitions
-wireless_copy.h
- Private version of Linux wireless extensions definitions from kernel
- header files; this could be replaced with C library header file once
- suitable version becomes commonly available
-
\section crypto_func Cryptographic functions
-md5.c and md5.h
+\ref md5.c and \ref md5.h
MD5 (replaced with a crypto library if TLS support is included)
HMAC-MD5 (keyed checksum for message authenticity validation)
-rc4.c and rc4.h
+\ref rc4.c and \ref rc4.h
RC4 (broadcast/default key encryption)
-sha1.c and sha1.h
+\ref sha1.c and \ref sha1.h
SHA-1 (replaced with a crypto library if TLS support is included)
HMAC-SHA-1 (keyed checksum for message authenticity validation)
PRF-SHA-1 (pseudorandom (key/nonce generation) function)
@@ -104,10 +99,10 @@ sha1.c and sha1.h
T-PRF (for EAP-FAST)
TLS-PRF (RFC 2246)
-sha256.c and sha256.h
+\ref sha256.c and \ref sha256.h
SHA-256 (replaced with a crypto library if TLS support is included)
-aes_wrap.c, aes_wrap.h, aes.c
+\ref aes-wrap.c, \ref aes_wrap.h, \ref aes.c
AES (replaced with a crypto library if TLS support is included),
AES Key Wrap Algorithm with 128-bit KEK, RFC3394 (broadcast/default
key encryption),
@@ -116,207 +111,205 @@ aes_wrap.c, aes_wrap.h, aes.c
AES-128 EAX mode encryption/decryption,
AES-128 CBC
-crypto.h
+\ref crypto.h
Definition of crypto library wrapper
-crypto_openssl.c
+\ref crypto_openssl.c
Wrapper functions for libcrypto (OpenSSL)
-crypto_internal.c
+\ref crypto_internal.c
Wrapper functions for internal crypto implementation
-crypto_gnutls.c
+\ref crypto_gnutls.c
Wrapper functions for libgcrypt (used by GnuTLS)
-ms_funcs.c and ms_funcs.h
+\ref ms_funcs.c and \ref ms_funcs.h
Helper functions for MSCHAPV2 and LEAP
-tls.h
+\ref tls.h
Definition of TLS library wrapper
-tls_none.c
+\ref tls_none.c
Dummy implementation of TLS library wrapper for cases where TLS
functionality is not included.
-tls_openssl.c
+\ref tls_openssl.c
TLS library wrapper for openssl
-tls_internal.c
+\ref tls_internal.c
TLS library for internal TLS implementation
-tls_gnutls.c
+\ref tls_gnutls.c
TLS library wrapper for GnuTLS
\section tls_func TLS library
-asn1.c and asn1.h
+\ref asn1.c and \ref asn1.h
ASN.1 DER parsing
-bignum.c and bignum.h
+\ref bignum.c and \ref bignum.h
Big number math
-rsa.c and rsa.h
+\ref rsa.c and \ref rsa.h
RSA
-x509v3.c and x509v3.h
+\ref x509v3.c and \ref x509v3.h
X.509v3 certificate parsing and processing
-tlsv1_client.c, tlsv1_client.h
+\ref tlsv1_client.c, \ref tlsv1_client.h
TLSv1 client (RFC 2246)
-tlsv1_client_i.h
+\ref tlsv1_client_i.h
Internal structures for TLSv1 client
-tlsv1_client_read.c
+\ref tlsv1_client_read.c
TLSv1 client: read handshake messages
-tlsv1_client_write.c
+\ref tlsv1_client_write.c
TLSv1 client: write handshake messages
-tlsv1_common.c and tlsv1_common.h
+\ref tlsv1_common.c and \ref tlsv1_common.h
Common TLSv1 routines and definitions
-tlsv1_cred.c and tlsv1_cred.h
+\ref tlsv1_cred.c and \ref tlsv1_cred.h
TLSv1 credentials
-tlsv1_record.c and tlsv1_record.h
+\ref tlsv1_record.c and \ref tlsv1_record.h
TLSv1 record protocol
\section configuration Configuration
-config_ssid.h
+\ref config_ssid.h
Definition of per network configuration items
-config.h
- Definition of the %wpa_supplicant configuration
+\ref config.h
+ Definition of the wpa_supplicant configuration
-config.c
+\ref config.c
Configuration parser and common functions
-config_file.c
+\ref wpa_supplicant/config_file.c
Configuration backend for text files (e.g., wpa_supplicant.conf)
-config_winreg.c
+\ref config_winreg.c
Configuration backend for Windows registry
\section ctrl_iface Control interface
-%wpa_supplicant has a \ref ctrl_iface_page "control interface"
+wpa_supplicant has a \ref ctrl_iface_page "control interface"
that can be used to get status
information and manage operations from external programs. An example
command line interface (wpa_cli) and GUI (wpa_gui) for this interface
-are included in the %wpa_supplicant distribution.
+are included in the wpa_supplicant distribution.
-ctrl_iface.c and ctrl_iface.h
- %wpa_supplicant-side of the control interface
+\ref wpa_supplicant/ctrl_iface.c and \ref wpa_supplicant/ctrl_iface.h
+ wpa_supplicant-side of the control interface
-ctrl_iface_unix.c
+\ref ctrl_iface_unix.c
UNIX domain sockets -based control interface backend
-ctrl_iface_udp.c
+\ref ctrl_iface_udp.c
UDP sockets -based control interface backend
-ctrl_iface_named_pipe.c
+\ref ctrl_iface_named_pipe.c
Windows named pipes -based control interface backend
-wpa_ctrl.c and wpa_ctrl.h
+\ref wpa_ctrl.c and \ref wpa_ctrl.h
Library functions for external programs to provide access to the
- %wpa_supplicant control interface
+ wpa_supplicant control interface
-wpa_cli.c
- Example program for using %wpa_supplicant control interface
+\ref wpa_cli.c
+ Example program for using wpa_supplicant control interface
\section wpa_code WPA supplicant
-wpa.c and wpa.h
+\ref wpa.c and \ref wpa.h
WPA state machine and 4-Way/Group Key Handshake processing
-preauth.c and preauth.h
+\ref preauth.c and \ref preauth.h
PMKSA caching and pre-authentication (RSN/WPA2)
-wpa_i.h
+\ref wpa_i.h
Internal definitions for WPA code; not to be included to other modules.
\section eap_peer EAP peer
\ref eap_peer_module "EAP peer implementation" is a separate module that
-can be used by other programs than just %wpa_supplicant.
+can be used by other programs than just wpa_supplicant.
-eap.c and eap.h
+\ref eap.c and \ref eap.h
EAP state machine and method interface
-eap_defs.h
+\ref eap_defs.h
Common EAP definitions
-eap_i.h
+\ref eap_i.h
Internal definitions for EAP state machine and EAP methods; not to be
included in other modules
-eap_sim_common.c and eap_sim_common.h
+\ref eap_sim_common.c and \ref eap_sim_common.h
Common code for EAP-SIM and EAP-AKA
-eap_tls_common.c and eap_tls_common.h
+\ref eap_tls_common.c and \ref eap_tls_common.h
Common code for EAP-PEAP, EAP-TTLS, and EAP-FAST
-eap_tlv.c and eap_tlv.h
- EAP-TLV code for EAP-PEAP and EAP-FAST
-
-eap_ttls.c and eap_ttls.h
+\ref eap_ttls.c and \ref eap_ttls.h
EAP-TTLS
-eap_pax.c, eap_pax_common.h, eap_pax_common.c
+\ref eap_pax.c, \ref eap_pax_common.h, \ref eap_pax_common.c
EAP-PAX
-eap_psk.c, eap_psk_common.h, eap_psk_common.c
+\ref eap_psk.c, \ref eap_psk_common.h, \ref eap_psk_common.c
EAP-PSK (note: this is not needed for WPA-PSK)
-eap_sake.c, eap_sake_common.h, eap_sake_common.c
+\ref eap_sake.c, \ref eap_sake_common.h, \ref eap_sake_common.c
EAP-SAKE
-eap_gpsk.c, eap_gpsk_common.h, eap_gpsk_common.c
+\ref eap_gpsk.c, \ref eap_gpsk_common.h, \ref eap_gpsk_common.c
EAP-GPSK
-eap_aka.c, eap_fast.c, eap_gtc.c, eap_leap.c, eap_md5.c, eap_mschapv2.c,
-eap_otp.c, eap_peap.c, eap_sim.c, eap_tls.c
+\ref eap_aka.c, \ref eap_fast.c, \ref eap_gtc.c, \ref eap_leap.c,
+\ref eap_md5.c, \ref eap_mschapv2.c, \ref eap_otp.c, \ref eap_peap.c,
+\ref eap_sim.c, \ref eap_tls.c
Other EAP method implementations
\section eapol_supp EAPOL supplicant
-eapol_supp_sm.c and eapol_supp_sm.h
+\ref eapol_supp_sm.c and \ref eapol_supp_sm.h
EAPOL supplicant state machine and IEEE 802.1X processing
\section win_port Windows port
-ndis_events.c
+\ref ndis_events.c
Code for receiving NdisMIndicateStatus() events and delivering them to
- %wpa_supplicant driver_ndis.c in more easier to use form
+ wpa_supplicant \ref driver_ndis.c in more easier to use form
-win_if_list.c
+\ref win_if_list.c
External program for listing current network interface
\section test_programs Test programs
-radius_client.c and radius_client.h
+\ref radius_client.c and \ref radius_client.h
RADIUS authentication client implementation for eapol_test
-radius.c and radius.h
+\ref radius.c and \ref radius.h
RADIUS message processing for eapol_test
-eapol_test.c
+\ref eapol_test.c
Standalone EAP testing tool with integrated RADIUS authentication
client
-preauth_test.c
+\ref preauth_test.c
Standalone RSN pre-authentication tool
-wpa_passphrase.c
+\ref wpa_passphrase.c
WPA ASCII passphrase to PSK conversion
*/