| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 1 | /** |
| 2 | * @file |
| 3 | * SSL/TLS communication module documentation file. |
| Manuel Pégourié-Gonnard | 8119dad | 2015-08-06 10:59:26 +0200 | [diff] [blame] | 4 | * |
| 5 | * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved |
| 6 | * |
| 7 | * This file is part of mbed TLS (https://tls.mbed.org) |
| 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify |
| 10 | * it under the terms of the GNU General Public License as published by |
| 11 | * the Free Software Foundation; either version 2 of the License, or |
| 12 | * (at your option) any later version. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | * GNU General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU General Public License along |
| 20 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 21 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 22 | */ |
| 23 | |
| 24 | /** |
| 25 | * @addtogroup ssltls_communication_module SSL/TLS communication module |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 26 | * |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 27 | * 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] | 28 | * communication channel. |
| 29 | * |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 30 | * The basic provisions are: |
| Manuel Pégourié-Gonnard | 151dc77 | 2015-05-14 13:55:51 +0200 | [diff] [blame] | 31 | * - initialise an SSL/TLS context (see \c mbedtls_ssl_init()). |
| 32 | * - perform an SSL/TLS handshake (see \c mbedtls_ssl_handshake()). |
| 33 | * - read/write (see \c mbedtls_ssl_read() and \c mbedtls_ssl_write()). |
| 34 | * - 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] | 35 | * |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 36 | * Many aspects of such a channel are set through parameters and callback |
| 37 | * functions: |
| 38 | * - the endpoint role: client or server. |
| 39 | * - the authentication mode. Should verification take place. |
| 40 | * - the Host-to-host communication channel. A TCP/IP module is provided. |
| 41 | * - the random number generator (RNG). |
| 42 | * - the ciphers to use for encryption/decryption. |
| 43 | * - session control functions. |
| 44 | * - X.509 parameters for certificate-handling and key exchange. |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 45 | * |
| 46 | * This module can be used to create an SSL/TLS server and client and to provide a basic |
| 47 | * framework to setup and communicate through an SSL/TLS communication channel.\n |
| 48 | * Note that you need to provide for several aspects yourself as mentioned above. |
| 49 | */ |