1 /** 2 * \file doc_ssltls.h 3 * 4 * \brief SSL/TLS communication module documentation file. 5 */ 6 /* 7 * 8 * Copyright The Mbed TLS Contributors 9 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later 10 * 11 * This file is provided under the Apache License 2.0, or the 12 * GNU General Public License v2.0 or later. 13 * 14 * ********** 15 * Apache License 2.0: 16 * 17 * Licensed under the Apache License, Version 2.0 (the "License"); you may 18 * not use this file except in compliance with the License. 19 * You may obtain a copy of the License at 20 * 21 * http://www.apache.org/licenses/LICENSE-2.0 22 * 23 * Unless required by applicable law or agreed to in writing, software 24 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 25 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 26 * See the License for the specific language governing permissions and 27 * limitations under the License. 28 * 29 * ********** 30 * 31 * ********** 32 * GNU General Public License v2.0 or later: 33 * 34 * This program is free software; you can redistribute it and/or modify 35 * it under the terms of the GNU General Public License as published by 36 * the Free Software Foundation; either version 2 of the License, or 37 * (at your option) any later version. 38 * 39 * This program is distributed in the hope that it will be useful, 40 * but WITHOUT ANY WARRANTY; without even the implied warranty of 41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 42 * GNU General Public License for more details. 43 * 44 * You should have received a copy of the GNU General Public License along 45 * with this program; if not, write to the Free Software Foundation, Inc., 46 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 47 * 48 * ********** 49 */ 50 51 /** 52 * @addtogroup ssltls_communication_module SSL/TLS communication module 53 * 54 * The SSL/TLS communication module provides the means to create an SSL/TLS 55 * communication channel. 56 * 57 * The basic provisions are: 58 * - initialise an SSL/TLS context (see \c mbedtls_ssl_init()). 59 * - perform an SSL/TLS handshake (see \c mbedtls_ssl_handshake()). 60 * - read/write (see \c mbedtls_ssl_read() and \c mbedtls_ssl_write()). 61 * - notify a peer that connection is being closed (see \c mbedtls_ssl_close_notify()). 62 * 63 * Many aspects of such a channel are set through parameters and callback 64 * functions: 65 * - the endpoint role: client or server. 66 * - the authentication mode. Should verification take place. 67 * - the Host-to-host communication channel. A TCP/IP module is provided. 68 * - the random number generator (RNG). 69 * - the ciphers to use for encryption/decryption. 70 * - session control functions. 71 * - X.509 parameters for certificate-handling and key exchange. 72 * 73 * This module can be used to create an SSL/TLS server and client and to provide a basic 74 * framework to setup and communicate through an SSL/TLS communication channel.\n 75 * Note that you need to provide for several aspects yourself as mentioned above. 76 */ 77