Willie Solano / mbedtls-slave-prot-prod

mbed TLS Build

Dependents:   Slave-prot-prod

doxygen/input/doc_mainpage.h@1:1a219dea6cb5, 2019-06-04 (annotated)

Committer:
williequesada
Date:
Tue Jun 04 16:03:38 2019 +0000
Revision:
1:1a219dea6cb5
Parent:
0:cdf462088d13 
compartir a Pablo

Who changed what in which revision?

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