Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of mbedtls by
doc_ssltls.h
00001 /** 00002 * @file 00003 * SSL/TLS communication module documentation file. 00004 * 00005 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved 00006 * SPDX-License-Identifier: Apache-2.0 00007 * 00008 * Licensed under the Apache License, Version 2.0 (the "License"); you may 00009 * not use this file except in compliance with the License. 00010 * You may obtain a copy of the License at 00011 * 00012 * http://www.apache.org/licenses/LICENSE-2.0 00013 * 00014 * Unless required by applicable law or agreed to in writing, software 00015 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 00016 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00017 * See the License for the specific language governing permissions and 00018 * limitations under the License. 00019 * 00020 * This file is part of mbed TLS (https://tls.mbed.org) 00021 */ 00022 00023 /** 00024 * @addtogroup ssltls_communication_module SSL/TLS communication module 00025 * 00026 * The SSL/TLS communication module provides the means to create an SSL/TLS 00027 * communication channel. 00028 * 00029 * The basic provisions are: 00030 * - initialise an SSL/TLS context (see \c mbedtls_ssl_init()). 00031 * - perform an SSL/TLS handshake (see \c mbedtls_ssl_handshake()). 00032 * - read/write (see \c mbedtls_ssl_read() and \c mbedtls_ssl_write()). 00033 * - notify a peer that connection is being closed (see \c mbedtls_ssl_close_notify()). 00034 * 00035 * Many aspects of such a channel are set through parameters and callback 00036 * functions: 00037 * - the endpoint role: client or server. 00038 * - the authentication mode. Should verification take place. 00039 * - the Host-to-host communication channel. A TCP/IP module is provided. 00040 * - the random number generator (RNG). 00041 * - the ciphers to use for encryption/decryption. 00042 * - session control functions. 00043 * - X.509 parameters for certificate-handling and key exchange. 00044 * 00045 * This module can be used to create an SSL/TLS server and client and to provide a basic 00046 * framework to setup and communicate through an SSL/TLS communication channel.\n 00047 * Note that you need to provide for several aspects yourself as mentioned above. 00048 */
Generated on Tue Jul 12 2022 17:25:41 by
