| Gilles Peskine | 458b8f2 | 2020-02-26 18:28:28 +0100 | [diff] [blame] | 1 | /** |
| 2 | * \file doc_ssltls.h |
| 3 | * |
| 4 | * \brief SSL/TLS communication module documentation file. |
| 5 | */ |
| 6 | /* |
| 7 | * |
| 8 | * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved |
| 9 | * SPDX-License-Identifier: Apache-2.0 |
| 10 | * |
| 11 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 12 | * not use this file except in compliance with the License. |
| 13 | * You may obtain a copy of the License at |
| 14 | * |
| 15 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 16 | * |
| 17 | * Unless required by applicable law or agreed to in writing, software |
| 18 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 19 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 20 | * See the License for the specific language governing permissions and |
| 21 | * limitations under the License. |
| 22 | * |
| 23 | * This file is part of mbed TLS (https://tls.mbed.org) |
| 24 | */ |
| 25 | |
| 26 | /** |
| 27 | * @addtogroup ssltls_communication_module SSL/TLS communication module |
| 28 | * |
| 29 | * The SSL/TLS communication module provides the means to create an SSL/TLS |
| 30 | * communication channel. |
| 31 | * |
| 32 | * The basic provisions are: |
| 33 | * - initialise an SSL/TLS context (see \c mbedtls_ssl_init()). |
| 34 | * - perform an SSL/TLS handshake (see \c mbedtls_ssl_handshake()). |
| 35 | * - read/write (see \c mbedtls_ssl_read() and \c mbedtls_ssl_write()). |
| 36 | * - notify a peer that connection is being closed (see \c mbedtls_ssl_close_notify()). |
| 37 | * |
| 38 | * Many aspects of such a channel are set through parameters and callback |
| 39 | * functions: |
| 40 | * - the endpoint role: client or server. |
| 41 | * - the authentication mode. Should verification take place. |
| 42 | * - the Host-to-host communication channel. A TCP/IP module is provided. |
| 43 | * - the random number generator (RNG). |
| 44 | * - the ciphers to use for encryption/decryption. |
| 45 | * - session control functions. |
| 46 | * - X.509 parameters for certificate-handling and key exchange. |
| 47 | * |
| 48 | * This module can be used to create an SSL/TLS server and client and to provide a basic |
| 49 | * framework to setup and communicate through an SSL/TLS communication channel.\n |
| 50 | * Note that you need to provide for several aspects yourself as mentioned above. |
| 51 | */ |