| Tom Rini | 0344c60 | 2024-10-08 13:56:50 -0600 | [diff] [blame^] | 1 | /** |
| 2 | * \file doc_hashing.h |
| 3 | * |
| 4 | * \brief Hashing module documentation file. |
| 5 | */ |
| 6 | /* |
| 7 | * |
| 8 | * Copyright The Mbed TLS Contributors |
| 9 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
| 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * @addtogroup hashing_module Hashing module |
| 14 | * |
| 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. |
| 20 | * |
| 21 | * All hash algorithms can be accessed via the generic MD layer (see |
| 22 | * \c mbedtls_md_setup()) |
| 23 | * |
| 24 | * The following hashing-algorithms are provided: |
| 25 | * - MD5 128-bit one-way hash function by Ron Rivest. |
| 26 | * - SHA-1, SHA-256, SHA-384/512 160-bit or more one-way hash functions by |
| 27 | * NIST and NSA. |
| 28 | * |
| 29 | * This module provides one-way hashing which can be used for authentication. |
| 30 | */ |