blob: 242e2c4fbd001519d4ba3877ba6cd6b6a36ba25e [file] [log] [blame]
Paul Bakker37ca75d2011-01-06 12:28:03 +00001/**
2 * @file
3 * Hashing module documentation file.
4 */
5
6/**
7 * @addtogroup hashing_module Hashing module
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02008 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00009 * The Hashing module provides one-way hashing functions. Such functions can be
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020010 * used for creating a hash message authentication code (HMAC) when sending a
Paul Bakker37ca75d2011-01-06 12:28:03 +000011 * message. Such a HMAC can be used in combination with a private key
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020012 * for authentication, which is a message integrity control.
13 *
14 * All hash algorithms can be accessed via the generic MD layer (see
15 * \c md_init_ctx())
16 *
Paul Bakker37ca75d2011-01-06 12:28:03 +000017 * The following hashing-algorithms are provided:
Manuel Pégourié-Gonnardd4b91732015-03-25 16:25:23 +010018 * - MD2, MD4, MD5 128-bit one-way hash functions by Ron Rivest.
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020019 * - SHA-1, SHA-256, SHA-384/512 160-bit or more one-way hash functions by
Manuel Pégourié-Gonnardd4b91732015-03-25 16:25:23 +010020 * NIST and NSA.
Paul Bakker37ca75d2011-01-06 12:28:03 +000021 *
22 * This module provides one-way hashing which can be used for authentication.
23 */