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