blob: dc98951052a0d2edc89c1db3aa2dd319ce9902f1 [file] [log] [blame]
Paul Bakker3c18a832012-01-23 09:44:43 +00001/**
Paul Bakker37ca75d2011-01-06 12:28:03 +00002 * @file
3 * Main page documentation file.
4 */
5
6/**
Paul Bakker90f042d2013-03-11 11:38:44 +01007 * @mainpage PolarSSL v1.2.6 source code documentation
Paul Bakker37ca75d2011-01-06 12:28:03 +00008 *
9 * This documentation describes the internal structure of PolarSSL. It was
10 * automatically generated from specially formatted comment blocks in
11 * PolarSSL's source code using Doxygen. (See
12 * http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen)
13 *
14 * PolarSSL has a simple setup: it provides the ingredients for an SSL/TLS
15 * implementation. These ingredients are listed as modules in the
16 * \ref mainpage_modules "Modules section". This "Modules section" introduces
17 * the high-level module concepts used throughout this documentation.\n
18 * Some examples of PolarSSL usage can be found in the \ref mainpage_examples
19 * "Examples section".
20 *
21 *
22 * @section mainpage_modules Modules
23 *
Paul Bakker9a736322012-11-14 12:39:52 +000024 * PolarSSL supports SSLv3 up to TLSv1.2 communication by providing the
Paul Bakker37ca75d2011-01-06 12:28:03 +000025 * following:
26 * - TCP/IP communication functions: listen, connect, accept, read/write.
27 * - SSL/TLS communication functions: init, handshake, read/write.
28 * - X.509 functions: CRT, CRL and key handling
29 * - Random number generation
30 * - Hashing
31 * - Encryption/decryption
32 *
33 * Above functions are split up neatly into logical interfaces. These can be
34 * used separately to provide any of the above functions or to mix-and-match
35 * into an SSL server/client solution that utilises a X.509 PKI. Examples of
36 * such implementations are amply provided with the source code. Note that
37 * there is also an OpenSSL wrapper provided.\n
38 * Note that PolarSSL does not provide a control channel or (multiple) session
39 * handling.
40 *
41 * @section mainpage_examples Examples
42 *
43 * Example server setup:
44 *
45 * \b Prerequisites:
46 * - X.509 certificate and private key
47 * - session handling functions
48 *
49 * \b Setup:
50 * - Load your certificate and your private RSA key (X.509 interface)
51 * - Setup the listening TCP socket (TCP/IP interface)
52 * - Accept incoming client connection (TCP/IP interface)
53 * - Initialise as an SSL-server (SSL/TLS interface)
54 * - Set parameters, e.g. authentication, ciphers, CA-chain, key exchange
55 * - Set callback functions RNG, IO, session handling
56 * - Perform an SSL-handshake (SSL/TLS interface)
57 * - Read/write data (SSL/TLS interface)
58 * - Close and cleanup (all interfaces)
59 *
60 *
61 * Example client setup:
62 *
63 * \b Prerequisites:
64 * - X.509 certificate and private key
65 * - X.509 trusted CA certificates
66 *
67 * \b Setup:
68 * - Load the trusted CA certificates (X.509 interface)
69 * - Load your certificate and your private RSA key (X.509 interface)
70 * - Setup a TCP/IP connection (TCP/IP interface)
71 * - Initialise as an SSL-client (SSL/TLS interface)
72 * - Set parameters, e.g. authentication mode, ciphers, CA-chain, session
73 * - Set callback functions RNG, IO
74 * - Perform an SSL-handshake (SSL/TLS interface)
75 * - Verify the server certificate (SSL/TLS interface)
76 * - Write/read data (SSL/TLS interface)
77 * - Close and cleanup (all interfaces)
78 *
79 *
80 */