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
10  *
11  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
12  *  not use this file except in compliance with the License.
13  *  You may obtain a copy of the License at
14  *
15  *  http://www.apache.org/licenses/LICENSE-2.0
16  *
17  *  Unless required by applicable law or agreed to in writing, software
18  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
19  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20  *  See the License for the specific language governing permissions and
21  *  limitations under the License.
22  */
23 
24 /**
25  * @addtogroup hashing_module Hashing module
26  *
27  * The Message Digest (MD) or Hashing module provides one-way hashing
28  * functions. Such functions can be used for creating a hash message
29  * authentication code (HMAC) when sending a message. Such a HMAC can be used
30  * in combination with a private key for authentication, which is a message
31  * integrity control.
32  *
33  * All hash algorithms can be accessed via the generic MD layer (see
34  * \c mbedtls_md_setup())
35  *
36  * The following hashing-algorithms are provided:
37  * - MD2, MD4, MD5 128-bit one-way hash functions by Ron Rivest.
38  * - SHA-1, SHA-256, SHA-384/512 160-bit or more one-way hash functions by
39  *   NIST and NSA.
40  *
41  * This module provides one-way hashing which can be used for authentication.
42  */
43