1
0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-07-28 00:21:48 +03:00

- Updated Doxygen documentation generation and documentation on small parts

This commit is contained in:
Paul Bakker
2011-01-27 15:24:17 +00:00
parent 0a62cd1a18
commit f3b86c1e62
18 changed files with 228 additions and 79 deletions

View File

@ -12,21 +12,23 @@
* 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 randomness needed for longer
* messages.
* 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 following algorithms are provided:
* - Symmetric:
* - AES (see \c aes_crypt_ecb() and\c aes_crypt_cbc()).
* - AES (see \c aes_crypt_ecb(), \c aes_crypt_cbc() and \c aes_crypt_cfb128()).
* - ARCFOUR (see \c arc4_crypt()).
* - Camellia (see \c camellia_crypt_ecb() and\c camellia_crypt_cbc()).
* - DES/3DES (see \c des_crypt_ecb(),\c des_crypt_cbc(),\c des3_crypt_ecb()
* and\c des3_crypt_cbc()).
* - 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()
* 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()).
* - RSA (see \c rsa_public() and \c rsa_private()).
*
* This module provides encryption/decryption which can be used to provide
* secrecy.

View File

@ -12,9 +12,9 @@
* for authentication, which is a message integrity control.
* The following hashing-algorithms are provided:
* - MD2, MD4, MD5 128-bit one-way hash functions by Ron Rivest (see
* \c md2_hmac(),\c md4_hmac() and\c md5_hmac()).
* \c md2_hmac(), \c md4_hmac() and \c md5_hmac()).
* - SHA-1, SHA-256, SHA-384/512 160-bit or more one-way hash functions by
* NIST and NSA (see\c sha1_hmac(),\c sha2_hmac() and\c sha4_hmac()).
* NIST and NSA (see\c sha1_hmac(), \c sha2_hmac() and \c sha4_hmac()).
*
* This module provides one-way hashing which can be used for authentication.
*/

View File

@ -11,7 +11,7 @@
* The basic provisions are:
* - initialise an SSL/TLS context (see \c ssl_init()).
* - perform an SSL/TLS handshake (see \c ssl_handshake()).
* - read/write (see \c ssl_read() and\c ssl_write()).
* - read/write (see \c ssl_read() and \c ssl_write()).
* - notify a peer that conection is being closed (see \c ssl_close_notify()).
*
*

View File

@ -15,7 +15,7 @@
* its basic provisions:
* - listening on a port (see \c net_bind()).
* - accepting a connection (through \c net_accept()).
* - read/write (through \c net_recv/\c net_send()).
* - read/write (through \c net_recv()/\c net_send()).
* - close a connection (through \c net_close()).
*
* This way you have the means to, for example, implement and use an UDP or

View File

@ -614,7 +614,9 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = tests/fct.h
EXCLUDE = tests/fct.h \
programs \
CMakeFiles
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded