| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 1 | /** |
| Jaeden Amero | 25facdd | 2018-01-23 15:36:58 +0000 | [diff] [blame] | 2 | * \file doc_hashing.h |
| 3 | * |
| 4 | * \brief Hashing module documentation file. |
| 5 | */ |
| 6 | /* |
| Manuel Pégourié-Gonnard | 8119dad | 2015-08-06 10:59:26 +0200 | [diff] [blame] | 7 | * |
| Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 8 | * Copyright The Mbed TLS Contributors |
| Dave Rodgman | 7ff7965 | 2023-11-03 12:04:52 +0000 | [diff] [blame] | 9 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * @addtogroup hashing_module Hashing module |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 14 | * |
| Simon Butcher | 00aea9a | 2016-03-17 00:30:35 +0000 | [diff] [blame] | 15 | * The Message Digest (MD) or Hashing module provides one-way hashing |
| 16 | * functions. Such functions can be used for creating a hash message |
| 17 | * authentication code (HMAC) when sending a message. Such a HMAC can be used |
| 18 | * in combination with a private key for authentication, which is a message |
| 19 | * integrity control. |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 20 | * |
| 21 | * All hash algorithms can be accessed via the generic MD layer (see |
| Simon Butcher | 00aea9a | 2016-03-17 00:30:35 +0000 | [diff] [blame] | 22 | * \c mbedtls_md_setup()) |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 23 | * |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 24 | * The following hashing-algorithms are provided: |
| Manuel Pégourié-Gonnard | d4b9173 | 2015-03-25 16:25:23 +0100 | [diff] [blame] | 25 | * - MD2, MD4, MD5 128-bit one-way hash functions by Ron Rivest. |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 26 | * - SHA-1, SHA-256, SHA-384/512 160-bit or more one-way hash functions by |
| Manuel Pégourié-Gonnard | d4b9173 | 2015-03-25 16:25:23 +0100 | [diff] [blame] | 27 | * NIST and NSA. |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 28 | * |
| 29 | * This module provides one-way hashing which can be used for authentication. |
| 30 | */ |