1/**
2 * \file doc_encdec.h
3 *
4 * \brief Encryption/decryption 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 encdec_module Encryption/decryption module
26 *
27 * The Encryption/decryption module provides encryption/decryption functions.
28 * One can differentiate between symmetric and asymmetric algorithms; the
29 * symmetric ones are mostly used for message confidentiality and the asymmetric
30 * ones for key exchange and message integrity.
31 * Some symmetric algorithms provide different block cipher modes, mainly
32 * Electronic Code Book (ECB) which is used for short (64-bit) messages and
33 * Cipher Block Chaining (CBC) which provides the structure needed for longer
34 * messages. In addition the Cipher Feedback Mode (CFB-128) stream cipher mode,
35 * Counter mode (CTR) and Galois Counter Mode (GCM) are implemented for
36 * specific algorithms.
37 *
38 * All symmetric encryption algorithms are accessible via the generic cipher layer
39 * (see \c mbedtls_cipher_setup()).
40 *
41 * The asymmetric encryption algorithms are accessible via the generic public
42 * key layer (see \c mbedtls_pk_init()).
43 *
44 * The following algorithms are provided:
45 * - Symmetric:
46 *   - AES (see \c mbedtls_aes_crypt_ecb(), \c mbedtls_aes_crypt_cbc(), \c mbedtls_aes_crypt_cfb128() and
47 *     \c mbedtls_aes_crypt_ctr()).
48 *   - Camellia (see \c mbedtls_camellia_crypt_ecb(), \c mbedtls_camellia_crypt_cbc(),
49 *     \c mbedtls_camellia_crypt_cfb128() and \c mbedtls_camellia_crypt_ctr()).
50 *   - DES/3DES (see \c mbedtls_des_crypt_ecb(), \c mbedtls_des_crypt_cbc(), \c mbedtls_des3_crypt_ecb()
51 *     and \c mbedtls_des3_crypt_cbc()).
52 *   - GCM (AES-GCM and CAMELLIA-GCM) (see \c mbedtls_gcm_init())
53 * - Asymmetric:
54 *   - Diffie-Hellman-Merkle (see \c mbedtls_dhm_read_public(), \c mbedtls_dhm_make_public()
55 *     and \c mbedtls_dhm_calc_secret()).
56 *   - RSA (see \c mbedtls_rsa_public() and \c mbedtls_rsa_private()).
57 *   - Elliptic Curves over GF(p) (see \c mbedtls_ecp_point_init()).
58 *   - Elliptic Curve Digital Signature Algorithm (ECDSA) (see \c mbedtls_ecdsa_init()).
59 *   - Elliptic Curve Diffie Hellman (ECDH) (see \c mbedtls_ecdh_init()).
60 *
61 * This module provides encryption/decryption which can be used to provide
62 * secrecy.
63 *
64 * It also provides asymmetric key functions which can be used for
65 * confidentiality, integrity, authentication and non-repudiation.
66 */
67