third_party/mbedtls/repo/doxygen/input/doc_mainpage.h

   1 /**
   2  * \file doc_mainpage.h
   3  *
   4  * \brief Main page documentation file.
   5  */
   6 /*
   7  *
   8  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
   9  *  SPDX-License-Identifier: Apache-2.0
  10  *
  11  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
  12  *  not use this file except in compliance with the License.
  13  *  You may obtain a copy of the License at
  14  *
  15  *  http://www.apache.org/licenses/LICENSE-2.0
  16  *
  17  *  Unless required by applicable law or agreed to in writing, software
  18  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  19  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20  *  See the License for the specific language governing permissions and
  21  *  limitations under the License.
  22  *
  23  *  This file is part of mbed TLS (https://tls.mbed.org)
  24  */
  25
  26 /**
  27  * @mainpage mbed TLS v2.18.0 source code documentation
  28  *
  29  * This documentation describes the internal structure of mbed TLS.  It was
  30  * automatically generated from specially formatted comment blocks in
  31  * mbed TLS's source code using Doxygen.  (See
  32  * http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen)
  33  *
  34  * mbed TLS has a simple setup: it provides the ingredients for an SSL/TLS
  35  * implementation. These ingredients are listed as modules in the
  36  * \ref mainpage_modules "Modules section". This "Modules section" introduces
  37  * the high-level module concepts used throughout this documentation.\n
  38  * Some examples of mbed TLS usage can be found in the \ref mainpage_examples
  39  * "Examples section".
  40  *
  41  * @section mainpage_modules Modules
  42  *
  43  * mbed TLS supports SSLv3 up to TLSv1.2 communication by providing the
  44  * following:
  45  * - TCP/IP communication functions: listen, connect, accept, read/write.
  46  * - SSL/TLS communication functions: init, handshake, read/write.
  47  * - X.509 functions: CRT, CRL and key handling
  48  * - Random number generation
  49  * - Hashing
  50  * - Encryption/decryption
  51  *
  52  * Above functions are split up neatly into logical interfaces. These can be
  53  * used separately to provide any of the above functions or to mix-and-match
  54  * into an SSL server/client solution that utilises a X.509 PKI. Examples of
  55  * such implementations are amply provided with the source code.
  56  *
  57  * Note that mbed TLS does not provide a control channel or (multiple) session
  58  * handling without additional work from the developer.
  59  *
  60  * @section mainpage_examples Examples
  61  *
  62  * Example server setup:
  63  *
  64  * \b Prerequisites:
  65  * - X.509 certificate and private key
  66  * - session handling functions
  67  *
  68  * \b Setup:
  69  * - Load your certificate and your private RSA key (X.509 interface)
  70  * - Setup the listening TCP socket (TCP/IP interface)
  71  * - Accept incoming client connection (TCP/IP interface)
  72  * - Initialise as an SSL-server (SSL/TLS interface)
  73  *   - Set parameters, e.g. authentication, ciphers, CA-chain, key exchange
  74  *   - Set callback functions RNG, IO, session handling
  75  * - Perform an SSL-handshake (SSL/TLS interface)
  76  * - Read/write data (SSL/TLS interface)
  77  * - Close and cleanup (all interfaces)
  78  *
  79  * Example client setup:
  80  *
  81  * \b Prerequisites:
  82  * - X.509 certificate and private key
  83  * - X.509 trusted CA certificates
  84  *
  85  * \b Setup:
  86  * - Load the trusted CA certificates (X.509 interface)
  87  * - Load your certificate and your private RSA key (X.509 interface)
  88  * - Setup a TCP/IP connection (TCP/IP interface)
  89  * - Initialise as an SSL-client (SSL/TLS interface)
  90  *   - Set parameters, e.g. authentication mode, ciphers, CA-chain, session
  91  *   - Set callback functions RNG, IO
  92  * - Perform an SSL-handshake (SSL/TLS interface)
  93  * - Verify the server certificate (SSL/TLS interface)
  94  * - Write/read data (SSL/TLS interface)
  95  * - Close and cleanup (all interfaces)
  96  */