diff options
Diffstat (limited to 'doxygen/input/doc_hashing.h')
-rw-r--r-- | doxygen/input/doc_hashing.h | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doxygen/input/doc_hashing.h b/doxygen/input/doc_hashing.h new file mode 100644 index 00000000000..83613bfa925 --- /dev/null +++ b/doxygen/input/doc_hashing.h @@ -0,0 +1,30 @@ +/** + * \file doc_hashing.h + * + * \brief Hashing module documentation file. + */ +/* + * + * Copyright The Mbed TLS Contributors + * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later + */ + +/** + * @addtogroup hashing_module Hashing module + * + * The Message Digest (MD) or Hashing module provides one-way hashing + * functions. Such functions can be used for creating a hash message + * authentication code (HMAC) when sending a message. Such a HMAC can be used + * in combination with a private key for authentication, which is a message + * integrity control. + * + * All hash algorithms can be accessed via the generic MD layer (see + * \c mbedtls_md_setup()) + * + * The following hashing-algorithms are provided: + * - MD5 128-bit one-way hash function by Ron Rivest. + * - SHA-1, SHA-256, SHA-384/512 160-bit or more one-way hash functions by + * NIST and NSA. + * + * This module provides one-way hashing which can be used for authentication. + */ |