1*62c56f98SSadaf Ebrahimi /** 2*62c56f98SSadaf Ebrahimi * \file doc_encdec.h 3*62c56f98SSadaf Ebrahimi * 4*62c56f98SSadaf Ebrahimi * \brief Encryption/decryption module documentation file. 5*62c56f98SSadaf Ebrahimi */ 6*62c56f98SSadaf Ebrahimi /* 7*62c56f98SSadaf Ebrahimi * 8*62c56f98SSadaf Ebrahimi * Copyright The Mbed TLS Contributors 9*62c56f98SSadaf Ebrahimi * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later 10*62c56f98SSadaf Ebrahimi */ 11*62c56f98SSadaf Ebrahimi 12*62c56f98SSadaf Ebrahimi /** 13*62c56f98SSadaf Ebrahimi * @addtogroup encdec_module Encryption/decryption module 14*62c56f98SSadaf Ebrahimi * 15*62c56f98SSadaf Ebrahimi * The Encryption/decryption module provides encryption/decryption functions. 16*62c56f98SSadaf Ebrahimi * One can differentiate between symmetric and asymmetric algorithms; the 17*62c56f98SSadaf Ebrahimi * symmetric ones are mostly used for message confidentiality and the asymmetric 18*62c56f98SSadaf Ebrahimi * ones for key exchange and message integrity. 19*62c56f98SSadaf Ebrahimi * Some symmetric algorithms provide different block cipher modes, mainly 20*62c56f98SSadaf Ebrahimi * Electronic Code Book (ECB) which is used for short (64-bit) messages and 21*62c56f98SSadaf Ebrahimi * Cipher Block Chaining (CBC) which provides the structure needed for longer 22*62c56f98SSadaf Ebrahimi * messages. In addition the Cipher Feedback Mode (CFB-128) stream cipher mode, 23*62c56f98SSadaf Ebrahimi * Counter mode (CTR) and Galois Counter Mode (GCM) are implemented for 24*62c56f98SSadaf Ebrahimi * specific algorithms. 25*62c56f98SSadaf Ebrahimi * 26*62c56f98SSadaf Ebrahimi * All symmetric encryption algorithms are accessible via the generic cipher layer 27*62c56f98SSadaf Ebrahimi * (see \c mbedtls_cipher_setup()). 28*62c56f98SSadaf Ebrahimi * 29*62c56f98SSadaf Ebrahimi * The asymmetric encryption algorithms are accessible via the generic public 30*62c56f98SSadaf Ebrahimi * key layer (see \c mbedtls_pk_init()). 31*62c56f98SSadaf Ebrahimi * 32*62c56f98SSadaf Ebrahimi * The following algorithms are provided: 33*62c56f98SSadaf Ebrahimi * - Symmetric: 34*62c56f98SSadaf Ebrahimi * - AES (see \c mbedtls_aes_crypt_ecb(), \c mbedtls_aes_crypt_cbc(), \c mbedtls_aes_crypt_cfb128() and 35*62c56f98SSadaf Ebrahimi * \c mbedtls_aes_crypt_ctr()). 36*62c56f98SSadaf Ebrahimi * - Camellia (see \c mbedtls_camellia_crypt_ecb(), \c mbedtls_camellia_crypt_cbc(), 37*62c56f98SSadaf Ebrahimi * \c mbedtls_camellia_crypt_cfb128() and \c mbedtls_camellia_crypt_ctr()). 38*62c56f98SSadaf Ebrahimi * - DES/3DES (see \c mbedtls_des_crypt_ecb(), \c mbedtls_des_crypt_cbc(), \c mbedtls_des3_crypt_ecb() 39*62c56f98SSadaf Ebrahimi * and \c mbedtls_des3_crypt_cbc()). 40*62c56f98SSadaf Ebrahimi * - GCM (AES-GCM and CAMELLIA-GCM) (see \c mbedtls_gcm_init()) 41*62c56f98SSadaf Ebrahimi * - Asymmetric: 42*62c56f98SSadaf Ebrahimi * - Diffie-Hellman-Merkle (see \c mbedtls_dhm_read_public(), \c mbedtls_dhm_make_public() 43*62c56f98SSadaf Ebrahimi * and \c mbedtls_dhm_calc_secret()). 44*62c56f98SSadaf Ebrahimi * - RSA (see \c mbedtls_rsa_public() and \c mbedtls_rsa_private()). 45*62c56f98SSadaf Ebrahimi * - Elliptic Curves over GF(p) (see \c mbedtls_ecp_point_init()). 46*62c56f98SSadaf Ebrahimi * - Elliptic Curve Digital Signature Algorithm (ECDSA) (see \c mbedtls_ecdsa_init()). 47*62c56f98SSadaf Ebrahimi * - Elliptic Curve Diffie Hellman (ECDH) (see \c mbedtls_ecdh_init()). 48*62c56f98SSadaf Ebrahimi * 49*62c56f98SSadaf Ebrahimi * This module provides encryption/decryption which can be used to provide 50*62c56f98SSadaf Ebrahimi * secrecy. 51*62c56f98SSadaf Ebrahimi * 52*62c56f98SSadaf Ebrahimi * It also provides asymmetric key functions which can be used for 53*62c56f98SSadaf Ebrahimi * confidentiality, integrity, authentication and non-repudiation. 54*62c56f98SSadaf Ebrahimi */ 55