|
5 | 5 | */
|
6 | 6 | /*
|
7 | 7 | *
|
8 |
| - * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved |
| 8 | + * Copyright (C) 2006-2019, ARM Limited, All Rights Reserved |
9 | 9 | * SPDX-License-Identifier: Apache-2.0
|
10 | 10 | *
|
11 | 11 | * Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
24 | 24 | */
|
25 | 25 |
|
26 | 26 | /**
|
27 |
| - * @mainpage mbed TLS v2.17.0 source code documentation |
| 27 | + * @mainpage Mbed Crypto v0.1.0 source code documentation |
28 | 28 | *
|
29 | 29 | * This documentation describes the internal structure of mbed TLS. It was
|
30 | 30 | * automatically generated from specially formatted comment blocks in
|
31 | 31 | * mbed TLS's source code using Doxygen. (See
|
32 | 32 | * http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen)
|
33 | 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". |
| 34 | + * Mbed Crypto provides an implementation of the PSA Crypto API. The library is |
| 35 | + * comprised of a number of independent modules, listed in the \ref |
| 36 | + * mainpage_modules "Modules section". This "Modules section" introduces the |
| 37 | + * high-level module concepts used throughout this documentation. |
40 | 38 | *
|
41 | 39 | * @section mainpage_modules Modules
|
42 | 40 | *
|
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 |
| 41 | + * Mbed Crypto provides the following modules: |
48 | 42 | * - Random number generation
|
49 | 43 | * - Hashing
|
50 | 44 | * - Encryption/decryption
|
51 | 45 | *
|
52 | 46 | * 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. |
| 47 | + * used separately to provide any of the above functions or to mix-and-match. |
56 | 48 | *
|
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 | 49 | */
|
0 commit comments