eden-emu/mbedtls
14
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated doxygen documentation in header files and HTML pages

Browse source
This commit is contained in:
Paul Bakker 2013-09-10 16:16:50 +02:00
parent 6ec34fb53d
commit dcbfdcc177
21 changed files with 120 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

50
doxygen/input/doc_encdec.h
View file

@ -5,33 +5,47 @@
/**
* @addtogroup encdec_module Encryption/decryption module
*
* The Encryption/decryption module provides encryption/decryption functions.
* One can differtiate between symmetric and asymetric algorithms; the
* symmetric ones are mostly used for message confidentiality and the asymmetric
* ones for key exchange and message integrity.
* Some symmetric algorithms provide different block cipher modes, mainly
* Electronic Code Book (ECB) which is used for short (64-bit) messages and
* Cipher Block Chaining (CBC) which provides the structure needed for longer
* messages. In addition the Cipher Feedback Mode (CFB-128) stream cipher mode
* is implemented for specific algorithms.
*
* Sometimes the same functions are used for encryption and decryption.
* The Encryption/decryption module provides encryption/decryption functions.
* One can differentiate between symmetric and asymmetric algorithms; the
* symmetric ones are mostly used for message confidentiality and the asymmetric
* ones for key exchange and message integrity.
* Some symmetric algorithms provide different block cipher modes, mainly
* Electronic Code Book (ECB) which is used for short (64-bit) messages and
* Cipher Block Chaining (CBC) which provides the structure needed for longer
* messages. In addition the Cipher Feedback Mode (CFB-128) stream cipher mode,
* Counter mode (CTR) and Galois Counter Mode (GCM) are implemented for
* specific algorithms.
*
* All symmetric encryption algorithms are accessible via the generic cipher layer
* (see \c cipher_init_ctx()).
*
* The asymmetric encryptrion algorithms are accessible via the generic public
* key layer (see \c pk_init()).
*
* The following algorithms are provided:
* - Symmetric:
* - AES (see \c aes_crypt_ecb(), \c aes_crypt_cbc() and \c aes_crypt_cfb128()).
* - AES (see \c aes_crypt_ecb(), \c aes_crypt_cbc(), \c aes_crypt_cfb128() and
* \c aes_crypt_ctr()).
* - ARCFOUR (see \c arc4_crypt()).
* - Camellia (see \c camellia_crypt_ecb(), \c camellia_crypt_cbc() and \c camellia_crypt_cfb128()).
* - DES/3DES (see \c des_crypt_ecb(), \c des_crypt_cbc(), \c des3_crypt_ecb()
* - Blowfish / BF (see \c blowfish_crypt_ecb(), \c blowfish_crypt_cbc(),
* \c blowfish_crypt_cfb64() and \c blowfish_crypt_ctr())
* - Camellia (see \c camellia_crypt_ecb(), \c camellia_crypt_cbc(),
* \c camellia_crypt_cfb128() and \c camellia_crypt_ctr()).
* - DES/3DES (see \c des_crypt_ecb(), \c des_crypt_cbc(), \c des3_crypt_ecb()
* and \c des3_crypt_cbc()).
* - XTEA (see \c xtea_crypt_ecb()).
* - Asymmetric:
* - Diffie-Hellman-Merkle (see \c dhm_read_public(), \c dhm_make_public()
* - Diffie-Hellman-Merkle (see \c dhm_read_public(), \c dhm_make_public()
* and \c dhm_calc_secret()).
* - RSA (see \c rsa_public() and \c rsa_private()).
* - Elliptic Curves over GF(p) (see \c ecp_point_init()).
* - Elliptic Curve Digital Signature Algorithm (ECDSA) (see \c ecdsa_init()).
* - Elliptic Curve Diffie Hellman (ECDH) (see \c ecdh_init()).
*
* This module provides encryption/decryption which can be used to provide
* This module provides encryption/decryption which can be used to provide
* secrecy.
* It also provides asymmetric key functions which can be used for
* confidentiality, integrity, authentication and non-repudiation.
*
* It also provides asymmetric key functions which can be used for
* confidentiality, integrity, authentication and non-repudiation.
*/