Willie Solano / mbedtls-slave-prot-prod

mbed TLS Build

Dependents:   Slave-prot-prod

doxygen/input/doc_encdec.h@0:cdf462088d13, 2017-01-05 (annotated)

Committer:
markrad
Date:
Thu Jan 05 00:18:44 2017 +0000
Revision:
0:cdf462088d13
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
markrad 0:cdf462088d13 1 /**
markrad 0:cdf462088d13 2 * @file
markrad 0:cdf462088d13 3 * Encryption/decryption module documentation file.
markrad 0:cdf462088d13 4 *
markrad 0:cdf462088d13 5 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
markrad 0:cdf462088d13 6 * SPDX-License-Identifier: Apache-2.0
markrad 0:cdf462088d13 7 *
markrad 0:cdf462088d13 8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
markrad 0:cdf462088d13 9 * not use this file except in compliance with the License.
markrad 0:cdf462088d13 10 * You may obtain a copy of the License at
markrad 0:cdf462088d13 11 *
markrad 0:cdf462088d13 12 * http://www.apache.org/licenses/LICENSE-2.0
markrad 0:cdf462088d13 13 *
markrad 0:cdf462088d13 14 * Unless required by applicable law or agreed to in writing, software
markrad 0:cdf462088d13 15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
markrad 0:cdf462088d13 16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
markrad 0:cdf462088d13 17 * See the License for the specific language governing permissions and
markrad 0:cdf462088d13 18 * limitations under the License.
markrad 0:cdf462088d13 19 *
markrad 0:cdf462088d13 20 * This file is part of mbed TLS (https://tls.mbed.org)
markrad 0:cdf462088d13 21 */
markrad 0:cdf462088d13 22
markrad 0:cdf462088d13 23 /**
markrad 0:cdf462088d13 24 * @addtogroup encdec_module Encryption/decryption module
markrad 0:cdf462088d13 25 *
markrad 0:cdf462088d13 26 * The Encryption/decryption module provides encryption/decryption functions.
markrad 0:cdf462088d13 27 * One can differentiate between symmetric and asymmetric algorithms; the
markrad 0:cdf462088d13 28 * symmetric ones are mostly used for message confidentiality and the asymmetric
markrad 0:cdf462088d13 29 * ones for key exchange and message integrity.
markrad 0:cdf462088d13 30 * Some symmetric algorithms provide different block cipher modes, mainly
markrad 0:cdf462088d13 31 * Electronic Code Book (ECB) which is used for short (64-bit) messages and
markrad 0:cdf462088d13 32 * Cipher Block Chaining (CBC) which provides the structure needed for longer
markrad 0:cdf462088d13 33 * messages. In addition the Cipher Feedback Mode (CFB-128) stream cipher mode,
markrad 0:cdf462088d13 34 * Counter mode (CTR) and Galois Counter Mode (GCM) are implemented for
markrad 0:cdf462088d13 35 * specific algorithms.
markrad 0:cdf462088d13 36 *
markrad 0:cdf462088d13 37 * All symmetric encryption algorithms are accessible via the generic cipher layer
markrad 0:cdf462088d13 38 * (see \c mbedtls_cipher_setup()).
markrad 0:cdf462088d13 39 *
markrad 0:cdf462088d13 40 * The asymmetric encryptrion algorithms are accessible via the generic public
markrad 0:cdf462088d13 41 * key layer (see \c mbedtls_pk_init()).
markrad 0:cdf462088d13 42 *
markrad 0:cdf462088d13 43 * The following algorithms are provided:
markrad 0:cdf462088d13 44 * - Symmetric:
markrad 0:cdf462088d13 45 * - AES (see \c mbedtls_aes_crypt_ecb(), \c mbedtls_aes_crypt_cbc(), \c mbedtls_aes_crypt_cfb128() and
markrad 0:cdf462088d13 46 * \c mbedtls_aes_crypt_ctr()).
markrad 0:cdf462088d13 47 * - ARCFOUR (see \c mbedtls_arc4_crypt()).
markrad 0:cdf462088d13 48 * - Blowfish / BF (see \c mbedtls_blowfish_crypt_ecb(), \c mbedtls_blowfish_crypt_cbc(),
markrad 0:cdf462088d13 49 * \c mbedtls_blowfish_crypt_cfb64() and \c mbedtls_blowfish_crypt_ctr())
markrad 0:cdf462088d13 50 * - Camellia (see \c mbedtls_camellia_crypt_ecb(), \c mbedtls_camellia_crypt_cbc(),
markrad 0:cdf462088d13 51 * \c mbedtls_camellia_crypt_cfb128() and \c mbedtls_camellia_crypt_ctr()).
markrad 0:cdf462088d13 52 * - DES/3DES (see \c mbedtls_des_crypt_ecb(), \c mbedtls_des_crypt_cbc(), \c mbedtls_des3_crypt_ecb()
markrad 0:cdf462088d13 53 * and \c mbedtls_des3_crypt_cbc()).
markrad 0:cdf462088d13 54 * - GCM (AES-GCM and CAMELLIA-GCM) (see \c mbedtls_gcm_init())
markrad 0:cdf462088d13 55 * - XTEA (see \c mbedtls_xtea_crypt_ecb()).
markrad 0:cdf462088d13 56 * - Asymmetric:
markrad 0:cdf462088d13 57 * - Diffie-Hellman-Merkle (see \c mbedtls_dhm_read_public(), \c mbedtls_dhm_make_public()
markrad 0:cdf462088d13 58 * and \c mbedtls_dhm_calc_secret()).
markrad 0:cdf462088d13 59 * - RSA (see \c mbedtls_rsa_public() and \c mbedtls_rsa_private()).
markrad 0:cdf462088d13 60 * - Elliptic Curves over GF(p) (see \c mbedtls_ecp_point_init()).
markrad 0:cdf462088d13 61 * - Elliptic Curve Digital Signature Algorithm (ECDSA) (see \c mbedtls_ecdsa_init()).
markrad 0:cdf462088d13 62 * - Elliptic Curve Diffie Hellman (ECDH) (see \c mbedtls_ecdh_init()).
markrad 0:cdf462088d13 63 *
markrad 0:cdf462088d13 64 * This module provides encryption/decryption which can be used to provide
markrad 0:cdf462088d13 65 * secrecy.
markrad 0:cdf462088d13 66 *
markrad 0:cdf462088d13 67 * It also provides asymmetric key functions which can be used for
markrad 0:cdf462088d13 68 * confidentiality, integrity, authentication and non-repudiation.
markrad 0:cdf462088d13 69 */