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