blob: 9538ed28ee24cc8875ea2d60b13cf128efd7bd48 [file] [log] [blame]
Paul Bakker37ca75d2011-01-06 12:28:03 +00001/**
2 * @file
3 * Encryption/decryption module documentation file.
Manuel Pégourié-Gonnard8119dad2015-08-06 10:59:26 +02004 *
5 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Manuel Pégourié-Gonnard8119dad2015-08-06 10:59:26 +020019 *
20 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker37ca75d2011-01-06 12:28:03 +000021 */
22
23/**
24 * @addtogroup encdec_module Encryption/decryption module
Paul Bakkerf3b86c12011-01-27 15:24:17 +000025 *
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020026 * The Encryption/decryption module provides encryption/decryption functions.
27 * One can differentiate between symmetric and asymmetric algorithms; the
28 * symmetric ones are mostly used for message confidentiality and the asymmetric
29 * ones for key exchange and message integrity.
30 * Some symmetric algorithms provide different block cipher modes, mainly
31 * Electronic Code Book (ECB) which is used for short (64-bit) messages and
32 * Cipher Block Chaining (CBC) which provides the structure needed for longer
33 * messages. In addition the Cipher Feedback Mode (CFB-128) stream cipher mode,
34 * Counter mode (CTR) and Galois Counter Mode (GCM) are implemented for
35 * specific algorithms.
36 *
37 * All symmetric encryption algorithms are accessible via the generic cipher layer
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +020038 * (see \c mbedtls_cipher_setup()).
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020039 *
40 * The asymmetric encryptrion algorithms are accessible via the generic public
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +020041 * key layer (see \c mbedtls_pk_init()).
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020042 *
Paul Bakker37ca75d2011-01-06 12:28:03 +000043 * The following algorithms are provided:
44 * - Symmetric:
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +020045 * - AES (see \c mbedtls_aes_crypt_ecb(), \c mbedtls_aes_crypt_cbc(), \c mbedtls_aes_crypt_cfb128() and
46 * \c mbedtls_aes_crypt_ctr()).
47 * - ARCFOUR (see \c mbedtls_arc4_crypt()).
48 * - Blowfish / BF (see \c mbedtls_blowfish_crypt_ecb(), \c mbedtls_blowfish_crypt_cbc(),
49 * \c mbedtls_blowfish_crypt_cfb64() and \c mbedtls_blowfish_crypt_ctr())
50 * - Camellia (see \c mbedtls_camellia_crypt_ecb(), \c mbedtls_camellia_crypt_cbc(),
51 * \c mbedtls_camellia_crypt_cfb128() and \c mbedtls_camellia_crypt_ctr()).
52 * - DES/3DES (see \c mbedtls_des_crypt_ecb(), \c mbedtls_des_crypt_cbc(), \c mbedtls_des3_crypt_ecb()
53 * and \c mbedtls_des3_crypt_cbc()).
54 * - GCM (AES-GCM and CAMELLIA-GCM) (see \c mbedtls_gcm_init())
55 * - XTEA (see \c mbedtls_xtea_crypt_ecb()).
Paul Bakker37ca75d2011-01-06 12:28:03 +000056 * - Asymmetric:
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +020057 * - Diffie-Hellman-Merkle (see \c mbedtls_dhm_read_public(), \c mbedtls_dhm_make_public()
58 * and \c mbedtls_dhm_calc_secret()).
59 * - RSA (see \c mbedtls_rsa_public() and \c mbedtls_rsa_private()).
60 * - Elliptic Curves over GF(p) (see \c mbedtls_ecp_point_init()).
61 * - Elliptic Curve Digital Signature Algorithm (ECDSA) (see \c mbedtls_ecdsa_init()).
62 * - Elliptic Curve Diffie Hellman (ECDH) (see \c mbedtls_ecdh_init()).
Paul Bakker37ca75d2011-01-06 12:28:03 +000063 *
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020064 * This module provides encryption/decryption which can be used to provide
Paul Bakker37ca75d2011-01-06 12:28:03 +000065 * secrecy.
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020066 *
67 * It also provides asymmetric key functions which can be used for
68 * confidentiality, integrity, authentication and non-repudiation.
Paul Bakker37ca75d2011-01-06 12:28:03 +000069 */