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