third_party/mbedtls/repo/doxygen/input/doc_encdec.h

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