Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 1 | /** |
| 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 Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 15 | * 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 Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 19 | * Sometimes the same functions are used for encryption and decryption. |
| 20 | * The following algorithms are provided: |
| 21 | * - Symmetric: |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 22 | * - AES (see \c aes_crypt_ecb(), \c aes_crypt_cbc() and \c aes_crypt_cfb128()). |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 23 | * - ARCFOUR (see \c arc4_crypt()). |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 24 | * - 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 Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 27 | * - XTEA (see \c xtea_crypt_ecb()). |
| 28 | * - Asymmetric: |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 29 | * - Diffie-Hellman-Merkle (see \c dhm_read_public(), \c dhm_make_public() |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 30 | * and \c dhm_calc_secret()). |
Paul Bakker | f3b86c1 | 2011-01-27 15:24:17 +0000 | [diff] [blame] | 31 | * - RSA (see \c rsa_public() and \c rsa_private()). |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 32 | * |
| 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 | */ |