blob: 48e8a54f4b0509c13c01324922698acd0ddfc2c7 [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
15 * Cipher Block Chaining (CBC) which provides the randomness needed for longer
16 * messages.
17 * Sometimes the same functions are used for encryption and decryption.
18 * The following algorithms are provided:
19 * - Symmetric:
20 * - AES (see \c aes_crypt_ecb() and\c aes_crypt_cbc()).
21 * - ARCFOUR (see \c arc4_crypt()).
22 * - Camellia (see \c camellia_crypt_ecb() and\c camellia_crypt_cbc()).
23 * - DES/3DES (see \c des_crypt_ecb(),\c des_crypt_cbc(),\c des3_crypt_ecb()
24 * and\c des3_crypt_cbc()).
25 * - XTEA (see \c xtea_crypt_ecb()).
26 * - Asymmetric:
27 * - Diffie-Hellman-Merkle (see \c dhm_read_public(),\c dhm_make_public()
28 * and \c dhm_calc_secret()).
29 * - RSA (see \c rsa_public() and\c rsa_private()).
30 *
31 * This module provides encryption/decryption which can be used to provide
32 * secrecy.
33 * It also provides asymmetric key functions which can be used for
34 * confidentiality, integrity, authentication and non-repudiation.
35 */