diff options
author | Gilles Peskine <Gilles.Peskine@arm.com> | 2020-02-26 18:25:13 +0100 |
---|---|---|
committer | Gilles Peskine <Gilles.Peskine@arm.com> | 2020-03-04 15:39:14 +0100 |
commit | 9bf54fa22cac985500e43e308a5bce3d7dda5a32 (patch) | |
tree | 19c69c85ca0444572ffb39db03a8e4479b377d26 /doxygen | |
parent | 84a63fad5b7f8993e197a3ed94146cc7713436f2 (diff) | |
download | mbedtls-9bf54fa22cac985500e43e308a5bce3d7dda5a32.zip mbedtls-9bf54fa22cac985500e43e308a5bce3d7dda5a32.tar.gz mbedtls-9bf54fa22cac985500e43e308a5bce3d7dda5a32.tar.bz2 |
Revert "doxygen: Update for Mbed Crypto"
This reverts commit 32577734e2635da3684d03ad04ba07044775cef9.
Diffstat (limited to 'doxygen')
-rw-r--r-- | doxygen/input/doc_mainpage.h | 63 | ||||
-rw-r--r-- | doxygen/mbedtls.doxyfile | 1 |
2 files changed, 56 insertions, 8 deletions
diff --git a/doxygen/input/doc_mainpage.h b/doxygen/input/doc_mainpage.h index 2a637d1..4eff836 100644 --- a/doxygen/input/doc_mainpage.h +++ b/doxygen/input/doc_mainpage.h @@ -5,7 +5,7 @@ */ /* * - * Copyright (C) 2006-2019, ARM Limited, All Rights Reserved + * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved * SPDX-License-Identifier: Apache-2.0 * * Licensed under the Apache License, Version 2.0 (the "License"); you may @@ -24,26 +24,73 @@ */ /** - * @mainpage Mbed Crypto v0.1.0 source code documentation + * @mainpage mbed TLS v2.17.0 source code documentation * * This documentation describes the internal structure of mbed TLS. It was * automatically generated from specially formatted comment blocks in * mbed TLS's source code using Doxygen. (See * http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen) * - * Mbed Crypto provides an implementation of the PSA Crypto API. The library is - * comprised of a number of independent modules, listed in the \ref - * mainpage_modules "Modules section". This "Modules section" introduces the - * high-level module concepts used throughout this documentation. + * mbed TLS has a simple setup: it provides the ingredients for an SSL/TLS + * implementation. These ingredients are listed as modules in the + * \ref mainpage_modules "Modules section". This "Modules section" introduces + * the high-level module concepts used throughout this documentation.\n + * Some examples of mbed TLS usage can be found in the \ref mainpage_examples + * "Examples section". * * @section mainpage_modules Modules * - * Mbed Crypto provides the following modules: + * mbed TLS supports SSLv3 up to TLSv1.2 communication by providing the + * following: + * - TCP/IP communication functions: listen, connect, accept, read/write. + * - SSL/TLS communication functions: init, handshake, read/write. + * - X.509 functions: CRT, CRL and key handling * - Random number generation * - Hashing * - Encryption/decryption * * Above functions are split up neatly into logical interfaces. These can be - * used separately to provide any of the above functions or to mix-and-match. + * used separately to provide any of the above functions or to mix-and-match + * into an SSL server/client solution that utilises a X.509 PKI. Examples of + * such implementations are amply provided with the source code. * + * Note that mbed TLS does not provide a control channel or (multiple) session + * handling without additional work from the developer. + * + * @section mainpage_examples Examples + * + * Example server setup: + * + * \b Prerequisites: + * - X.509 certificate and private key + * - session handling functions + * + * \b Setup: + * - Load your certificate and your private RSA key (X.509 interface) + * - Setup the listening TCP socket (TCP/IP interface) + * - Accept incoming client connection (TCP/IP interface) + * - Initialise as an SSL-server (SSL/TLS interface) + * - Set parameters, e.g. authentication, ciphers, CA-chain, key exchange + * - Set callback functions RNG, IO, session handling + * - Perform an SSL-handshake (SSL/TLS interface) + * - Read/write data (SSL/TLS interface) + * - Close and cleanup (all interfaces) + * + * Example client setup: + * + * \b Prerequisites: + * - X.509 certificate and private key + * - X.509 trusted CA certificates + * + * \b Setup: + * - Load the trusted CA certificates (X.509 interface) + * - Load your certificate and your private RSA key (X.509 interface) + * - Setup a TCP/IP connection (TCP/IP interface) + * - Initialise as an SSL-client (SSL/TLS interface) + * - Set parameters, e.g. authentication mode, ciphers, CA-chain, session + * - Set callback functions RNG, IO + * - Perform an SSL-handshake (SSL/TLS interface) + * - Verify the server certificate (SSL/TLS interface) + * - Write/read data (SSL/TLS interface) + * - Close and cleanup (all interfaces) */ diff --git a/doxygen/mbedtls.doxyfile b/doxygen/mbedtls.doxyfile index 2b14a36..4732271 100644 --- a/doxygen/mbedtls.doxyfile +++ b/doxygen/mbedtls.doxyfile @@ -1618,6 +1618,7 @@ PREDEFINED = WIN32 \ P2MP \ P2MP_SERVER \ USE_CRYPTO \ + USE_SSL \ ENABLE_PLUGIN \ ENABLE_MANAGEMENT \ ENABLE_OCC \ |