2020-12-28 10:15:37 -05:00
|
|
|
/**
|
|
|
|
|
* \file doc_ssltls.h
|
|
|
|
|
*
|
|
|
|
|
* \brief SSL/TLS communication module documentation file.
|
|
|
|
|
*/
|
|
|
|
|
/*
|
|
|
|
|
*
|
2021-03-05 19:41:47 -05:00
|
|
|
* Copyright The Mbed TLS Contributors
|
|
|
|
|
* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
|
|
|
|
|
*
|
|
|
|
|
* This file is provided under the Apache License 2.0, or the
|
|
|
|
|
* GNU General Public License v2.0 or later.
|
|
|
|
|
*
|
|
|
|
|
* **********
|
|
|
|
|
* Apache License 2.0:
|
|
|
|
|
*
|
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
|
|
|
* not use this file except in compliance with the License.
|
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
|
*
|
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
*
|
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
|
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
|
* limitations under the License.
|
|
|
|
|
*
|
|
|
|
|
* **********
|
|
|
|
|
*
|
|
|
|
|
* **********
|
|
|
|
|
* GNU General Public License v2.0 or later:
|
2020-12-28 10:15:37 -05:00
|
|
|
*
|
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
|
* (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
|
*
|
2021-03-05 19:41:47 -05:00
|
|
|
* **********
|
2020-12-28 10:15:37 -05:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @addtogroup ssltls_communication_module SSL/TLS communication module
|
|
|
|
|
*
|
|
|
|
|
* The SSL/TLS communication module provides the means to create an SSL/TLS
|
|
|
|
|
* communication channel.
|
|
|
|
|
*
|
|
|
|
|
* The basic provisions are:
|
|
|
|
|
* - initialise an SSL/TLS context (see \c mbedtls_ssl_init()).
|
|
|
|
|
* - perform an SSL/TLS handshake (see \c mbedtls_ssl_handshake()).
|
|
|
|
|
* - read/write (see \c mbedtls_ssl_read() and \c mbedtls_ssl_write()).
|
|
|
|
|
* - notify a peer that connection is being closed (see \c mbedtls_ssl_close_notify()).
|
|
|
|
|
*
|
|
|
|
|
* Many aspects of such a channel are set through parameters and callback
|
|
|
|
|
* functions:
|
|
|
|
|
* - the endpoint role: client or server.
|
|
|
|
|
* - the authentication mode. Should verification take place.
|
|
|
|
|
* - the Host-to-host communication channel. A TCP/IP module is provided.
|
|
|
|
|
* - the random number generator (RNG).
|
|
|
|
|
* - the ciphers to use for encryption/decryption.
|
|
|
|
|
* - session control functions.
|
|
|
|
|
* - X.509 parameters for certificate-handling and key exchange.
|
|
|
|
|
*
|
|
|
|
|
* This module can be used to create an SSL/TLS server and client and to provide a basic
|
|
|
|
|
* framework to setup and communicate through an SSL/TLS communication channel.\n
|
|
|
|
|
* Note that you need to provide for several aspects yourself as mentioned above.
|
|
|
|
|
*/
|
