| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 1 | /** |
| 2 | * @file |
| 3 | * SSL/TLS communication module documentation file. |
| 4 | */ |
| 5 | |
| 6 | /** |
| 7 | * @addtogroup ssltls_communication_module SSL/TLS communication module |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 8 | * |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 9 | * The SSL/TLS communication module provides the means to create an SSL/TLS |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 10 | * communication channel. |
| 11 | * |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 12 | * The basic provisions are: |
| Manuel Pégourié-Gonnard | 151dc77 | 2015-05-14 13:55:51 +0200 | [diff] [blame] | 13 | * - initialise an SSL/TLS context (see \c mbedtls_ssl_init()). |
| 14 | * - perform an SSL/TLS handshake (see \c mbedtls_ssl_handshake()). |
| 15 | * - read/write (see \c mbedtls_ssl_read() and \c mbedtls_ssl_write()). |
| 16 | * - notify a peer that connection is being closed (see \c mbedtls_ssl_close_notify()). |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 17 | * |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 18 | * Many aspects of such a channel are set through parameters and callback |
| 19 | * functions: |
| 20 | * - the endpoint role: client or server. |
| 21 | * - the authentication mode. Should verification take place. |
| 22 | * - the Host-to-host communication channel. A TCP/IP module is provided. |
| 23 | * - the random number generator (RNG). |
| 24 | * - the ciphers to use for encryption/decryption. |
| 25 | * - session control functions. |
| 26 | * - X.509 parameters for certificate-handling and key exchange. |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 27 | * |
| 28 | * This module can be used to create an SSL/TLS server and client and to provide a basic |
| 29 | * framework to setup and communicate through an SSL/TLS communication channel.\n |
| 30 | * Note that you need to provide for several aspects yourself as mentioned above. |
| 31 | */ |