doc_mainpage.h

00001 /**
00002  * @file
00003  * Main page documentation file.
00004  *
00005  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
00006  *  SPDX-License-Identifier: Apache-2.0
00007  *
00008  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
00009  *  not use this file except in compliance with the License.
00010  *  You may obtain a copy of the License at
00011  *
00012  *  http://www.apache.org/licenses/LICENSE-2.0
00013  *
00014  *  Unless required by applicable law or agreed to in writing, software
00015  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
00016  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00017  *  See the License for the specific language governing permissions and
00018  *  limitations under the License.
00019  *
00020  *  This file is part of mbed TLS (https://tls.mbed.org)
00021  */
00022 
00023 /**
00024  * @mainpage mbed TLS v2.4.1 source code documentation
00025  *
00026  * This documentation describes the internal structure of mbed TLS.  It was
00027  * automatically generated from specially formatted comment blocks in
00028  * mbed TLS's source code using Doxygen.  (See
00029  * http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen)
00030  *
00031  * mbed TLS has a simple setup: it provides the ingredients for an SSL/TLS
00032  * implementation. These ingredients are listed as modules in the
00033  * \ref mainpage_modules "Modules section". This "Modules section" introduces
00034  * the high-level module concepts used throughout this documentation.\n
00035  * Some examples of mbed TLS usage can be found in the \ref mainpage_examples
00036  * "Examples section".
00037  *
00038  * @section mainpage_modules Modules
00039  *
00040  * mbed TLS supports SSLv3 up to TLSv1.2 communication by providing the
00041  * following:
00042  * - TCP/IP communication functions: listen, connect, accept, read/write.
00043  * - SSL/TLS communication functions: init, handshake, read/write.
00044  * - X.509 functions: CRT, CRL and key handling
00045  * - Random number generation
00046  * - Hashing
00047  * - Encryption/decryption
00048  *
00049  * Above functions are split up neatly into logical interfaces. These can be
00050  * used separately to provide any of the above functions or to mix-and-match
00051  * into an SSL server/client solution that utilises a X.509 PKI. Examples of
00052  * such implementations are amply provided with the source code.
00053  *
00054  * Note that mbed TLS does not provide a control channel or (multiple) session
00055  * handling without additional work from the developer.
00056  *
00057  * @section mainpage_examples Examples
00058  *
00059  * Example server setup:
00060  *
00061  * \b Prerequisites:
00062  * - X.509 certificate and private key
00063  * - session handling functions
00064  *
00065  * \b Setup:
00066  * - Load your certificate and your private RSA key (X.509 interface)
00067  * - Setup the listening TCP socket (TCP/IP interface)
00068  * - Accept incoming client connection (TCP/IP interface)
00069  * - Initialise as an SSL-server (SSL/TLS interface)
00070  *   - Set parameters, e.g. authentication, ciphers, CA-chain, key exchange
00071  *   - Set callback functions RNG, IO, session handling
00072  * - Perform an SSL-handshake (SSL/TLS interface)
00073  * - Read/write data (SSL/TLS interface)
00074  * - Close and cleanup (all interfaces)
00075  *
00076  * Example client setup:
00077  *
00078  * \b Prerequisites:
00079  * - X.509 certificate and private key
00080  * - X.509 trusted CA certificates
00081  *
00082  * \b Setup:
00083  * - Load the trusted CA certificates (X.509 interface)
00084  * - Load your certificate and your private RSA key (X.509 interface)
00085  * - Setup a TCP/IP connection (TCP/IP interface)
00086  * - Initialise as an SSL-client (SSL/TLS interface)
00087  *   - Set parameters, e.g. authentication mode, ciphers, CA-chain, session
00088  *   - Set callback functions RNG, IO
00089  * - Perform an SSL-handshake (SSL/TLS interface)
00090  * - Verify the server certificate (SSL/TLS interface)
00091  * - Write/read data (SSL/TLS interface)
00092  * - Close and cleanup (all interfaces)
00093  */