Willie Solano / mbedtls-slave-prot-prod

mbed TLS Build

Dependents:   Slave-prot-prod

doxygen/input/doc_ssltls.h@0:cdf462088d13, 2017-01-05 (annotated)

Committer:
markrad
Date:
Thu Jan 05 00:18:44 2017 +0000
Revision:
0:cdf462088d13
Initial commit

Who changed what in which revision?

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