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 * This file is provided under the Apache License 2.0, or the 12 * GNU General Public License v2.0 or later. 13 * 14 * ********** 15 * Apache License 2.0: 16 * 17 * Licensed under the Apache License, Version 2.0 (the "License"); you may 18 * not use this file except in compliance with the License. 19 * You may obtain a copy of the License at 20 * 21 * http://www.apache.org/licenses/LICENSE-2.0 22 * 23 * Unless required by applicable law or agreed to in writing, software 24 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 25 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 26 * See the License for the specific language governing permissions and 27 * limitations under the License. 28 * 29 * ********** 30 * 31 * ********** 32 * GNU General Public License v2.0 or later: 33 * 34 * This program is free software; you can redistribute it and/or modify 35 * it under the terms of the GNU General Public License as published by 36 * the Free Software Foundation; either version 2 of the License, or 37 * (at your option) any later version. 38 * 39 * This program is distributed in the hope that it will be useful, 40 * but WITHOUT ANY WARRANTY; without even the implied warranty of 41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 42 * GNU General Public License for more details. 43 * 44 * You should have received a copy of the GNU General Public License along 45 * with this program; if not, write to the Free Software Foundation, Inc., 46 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 47 * 48 * ********** 49 */ 50 51 /** 52 * @addtogroup hashing_module Hashing module 53 * 54 * The Message Digest (MD) or Hashing module provides one-way hashing 55 * functions. Such functions can be used for creating a hash message 56 * authentication code (HMAC) when sending a message. Such a HMAC can be used 57 * in combination with a private key for authentication, which is a message 58 * integrity control. 59 * 60 * All hash algorithms can be accessed via the generic MD layer (see 61 * \c mbedtls_md_setup()) 62 * 63 * The following hashing-algorithms are provided: 64 * - MD2, MD4, MD5 128-bit one-way hash functions by Ron Rivest. 65 * - SHA-1, SHA-256, SHA-384/512 160-bit or more one-way hash functions by 66 * NIST and NSA. 67 * 68 * This module provides one-way hashing which can be used for authentication. 69 */ 70