doc_encdec.h 1.7 KB

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