blob: a1b7e16437d2c7b26f36829c2c5181b9c0e2962f [file] [log] [blame]
Paul Bakker37ca75d2011-01-06 12:28:03 +00001/**
2 * @file
3 * Encryption/decryption module documentation file.
4 */
5
6/**
7 * @addtogroup encdec_module Encryption/decryption module
8 *
9 * The Encryption/decryption module provides encryption/decryption functions.
10 * One can differtiate between symmetric and asymetric algorithms; the
11 * symmetric ones are mostly used for message confidentiality and the asymmetric
12 * ones for key exchange and message integrity.
13 * Some symmetric algorithms provide different block cipher modes, mainly
14 * Electronic Code Book (ECB) which is used for short (64-bit) messages and
Paul Bakkerf3b86c12011-01-27 15:24:17 +000015 * Cipher Block Chaining (CBC) which provides the structure needed for longer
16 * messages. In addition the Cipher Feedback Mode (CFB-128) stream cipher mode
17 * is implemented for specific algorithms.
18 *
Paul Bakker37ca75d2011-01-06 12:28:03 +000019 * Sometimes the same functions are used for encryption and decryption.
20 * The following algorithms are provided:
21 * - Symmetric:
Paul Bakkerf3b86c12011-01-27 15:24:17 +000022 * - AES (see \c aes_crypt_ecb(), \c aes_crypt_cbc() and \c aes_crypt_cfb128()).
Paul Bakker37ca75d2011-01-06 12:28:03 +000023 * - ARCFOUR (see \c arc4_crypt()).
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024 * - Camellia (see \c camellia_crypt_ecb(), \c camellia_crypt_cbc() and \c camellia_crypt_cfb128()).
25 * - DES/3DES (see \c des_crypt_ecb(), \c des_crypt_cbc(), \c des3_crypt_ecb()
26 * and \c des3_crypt_cbc()).
Paul Bakker37ca75d2011-01-06 12:28:03 +000027 * - XTEA (see \c xtea_crypt_ecb()).
28 * - Asymmetric:
Paul Bakkerf3b86c12011-01-27 15:24:17 +000029 * - Diffie-Hellman-Merkle (see \c dhm_read_public(), \c dhm_make_public()
Paul Bakker37ca75d2011-01-06 12:28:03 +000030 * and \c dhm_calc_secret()).
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031 * - RSA (see \c rsa_public() and \c rsa_private()).
Paul Bakker37ca75d2011-01-06 12:28:03 +000032 *
33 * This module provides encryption/decryption which can be used to provide
34 * secrecy.
35 * It also provides asymmetric key functions which can be used for
36 * confidentiality, integrity, authentication and non-repudiation.
37 */