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 OR GPL-2.0-or-later 10 * 11 * This file is provided under the Apache License 2.0, or the 12 * GNU General Public License v2.0 or later. 13 * 14 * ********** 15 * Apache License 2.0: 16 * 17 * Licensed under the Apache License, Version 2.0 (the "License"); you may 18 * not use this file except in compliance with the License. 19 * You may obtain a copy of the License at 20 * 21 * http://www.apache.org/licenses/LICENSE-2.0 22 * 23 * Unless required by applicable law or agreed to in writing, software 24 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 25 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 26 * See the License for the specific language governing permissions and 27 * limitations under the License. 28 * 29 * ********** 30 * 31 * ********** 32 * GNU General Public License v2.0 or later: 33 * 34 * This program is free software; you can redistribute it and/or modify 35 * it under the terms of the GNU General Public License as published by 36 * the Free Software Foundation; either version 2 of the License, or 37 * (at your option) any later version. 38 * 39 * This program is distributed in the hope that it will be useful, 40 * but WITHOUT ANY WARRANTY; without even the implied warranty of 41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 42 * GNU General Public License for more details. 43 * 44 * You should have received a copy of the GNU General Public License along 45 * with this program; if not, write to the Free Software Foundation, Inc., 46 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 47 * 48 * ********** 49 */ 50 51 /** 52 * @addtogroup encdec_module Encryption/decryption module 53 * 54 * The Encryption/decryption module provides encryption/decryption functions. 55 * One can differentiate between symmetric and asymmetric algorithms; the 56 * symmetric ones are mostly used for message confidentiality and the asymmetric 57 * ones for key exchange and message integrity. 58 * Some symmetric algorithms provide different block cipher modes, mainly 59 * Electronic Code Book (ECB) which is used for short (64-bit) messages and 60 * Cipher Block Chaining (CBC) which provides the structure needed for longer 61 * messages. In addition the Cipher Feedback Mode (CFB-128) stream cipher mode, 62 * Counter mode (CTR) and Galois Counter Mode (GCM) are implemented for 63 * specific algorithms. 64 * 65 * All symmetric encryption algorithms are accessible via the generic cipher layer 66 * (see \c mbedtls_cipher_setup()). 67 * 68 * The asymmetric encryptrion algorithms are accessible via the generic public 69 * key layer (see \c mbedtls_pk_init()). 70 * 71 * The following algorithms are provided: 72 * - Symmetric: 73 * - AES (see \c mbedtls_aes_crypt_ecb(), \c mbedtls_aes_crypt_cbc(), \c mbedtls_aes_crypt_cfb128() and 74 * \c mbedtls_aes_crypt_ctr()). 75 * - ARCFOUR (see \c mbedtls_arc4_crypt()). 76 * - Blowfish / BF (see \c mbedtls_blowfish_crypt_ecb(), \c mbedtls_blowfish_crypt_cbc(), 77 * \c mbedtls_blowfish_crypt_cfb64() and \c mbedtls_blowfish_crypt_ctr()) 78 * - Camellia (see \c mbedtls_camellia_crypt_ecb(), \c mbedtls_camellia_crypt_cbc(), 79 * \c mbedtls_camellia_crypt_cfb128() and \c mbedtls_camellia_crypt_ctr()). 80 * - DES/3DES (see \c mbedtls_des_crypt_ecb(), \c mbedtls_des_crypt_cbc(), \c mbedtls_des3_crypt_ecb() 81 * and \c mbedtls_des3_crypt_cbc()). 82 * - GCM (AES-GCM and CAMELLIA-GCM) (see \c mbedtls_gcm_init()) 83 * - XTEA (see \c mbedtls_xtea_crypt_ecb()). 84 * - Asymmetric: 85 * - Diffie-Hellman-Merkle (see \c mbedtls_dhm_read_public(), \c mbedtls_dhm_make_public() 86 * and \c mbedtls_dhm_calc_secret()). 87 * - RSA (see \c mbedtls_rsa_public() and \c mbedtls_rsa_private()). 88 * - Elliptic Curves over GF(p) (see \c mbedtls_ecp_point_init()). 89 * - Elliptic Curve Digital Signature Algorithm (ECDSA) (see \c mbedtls_ecdsa_init()). 90 * - Elliptic Curve Diffie Hellman (ECDH) (see \c mbedtls_ecdh_init()). 91 * 92 * This module provides encryption/decryption which can be used to provide 93 * secrecy. 94 * 95 * It also provides asymmetric key functions which can be used for 96 * confidentiality, integrity, authentication and non-repudiation. 97 */ 98