contrib/wpa/hostapd/doc/mainpage.doxygen

   1 /**
   2 \mainpage Developers' documentation for hostapd
   3
   4 hostapd includes IEEE 802.11 access point management (authentication /
   5 association), IEEE 802.1X/WPA/WPA2 Authenticator, EAP server, and
   6 RADIUS authentication server functionality. It can be build with
   7 various configuration option, e.g., a standalone AP management
   8 solution or a RADIUS authentication server with support for number of
   9 EAP methods.
  10
  11 The goal of this documentation and comments in the source code is to
  12 give enough information for other developers to understand how hostapd
  13 has been implemented, how it can be modified, how new drivers can be
  14 supported, and how hostapd can be ported to other operating
  15 systems. If any information is missing, feel free to contact Jouni
  16 Malinen <j@w1.fi> for more information. Contributions as
  17 patch files are also very welcome at the same address. Please note
  18 that hostapd is licensed under dual license, GPLv2 or BSD at user's
  19 choice. All contributions to hostapd are expected to use compatible
  20 licensing terms.
  21
  22 The source code and read-only access to hostapd CVS repository
  23 is available from the project home page at
  24 http://hostap.epitest.fi/hostapd/. This developers' documentation
  25 is also available as a PDF file from
  26 http://hostap.epitest.fi/hostapd/hostapd-devel.pdf .
  27
  28 The design goal for hostapd was to use hardware, driver, and
  29 OS independent, portable C code for all WPA functionality. The source
  30 code is divided into separate C files as shown on the \ref
  31 code_structure "code structure page". All hardware/driver specific
  32 functionality is in separate files that implement a \ref
  33 driver_wrapper "well-defined driver API". Information about porting
  34 to different target boards and operating systems is available on
  35 the \ref porting "porting page".
  36
  37 EAPOL (IEEE 802.1X) state machines are implemented as a separate
  38 module that interacts with \ref eap_module "EAP server implementation".
  39 Similarly, RADIUS authentication server is in its own separate module.
  40 Both IEEE 802.1X and RADIUS authentication server can use EAP server
  41 functionality.
  42
  43 hostapd implements a \ref ctrl_iface_page "control interface" that can
  44 be used by external programs to control the operations of the hostapdt
  45 daemon and to get status information and event notifications. There is
  46 a small C library that provides helper functions to facilitate the use
  47 of the control interface. This library can also be used with C++.
  48
  49 \image html hostapd.png "hostapd modules"
  50 \image latex hostapd.eps "hostapd modules" width=15cm
  51
  52 */