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
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
24/**
25 * @addtogroup ssltls_communication_module SSL/TLS communication module
26 *
27 * The SSL/TLS communication module provides the means to create an SSL/TLS
28 * communication channel.
29 *
30 * The basic provisions are:
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()).
35 *
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.
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 */
50