doc_hashing.h

00001 /**
00002  * @file
00003  * Hashing module documentation file.
00004  *
00005  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
00006  *  SPDX-License-Identifier: Apache-2.0
00007  *
00008  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
00009  *  not use this file except in compliance with the License.
00010  *  You may obtain a copy of the License at
00011  *
00012  *  http://www.apache.org/licenses/LICENSE-2.0
00013  *
00014  *  Unless required by applicable law or agreed to in writing, software
00015  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
00016  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00017  *  See the License for the specific language governing permissions and
00018  *  limitations under the License.
00019  *
00020  *  This file is part of mbed TLS (https://tls.mbed.org)
00021  */
00022 
00023 /**
00024  * @addtogroup hashing_module Hashing module
00025  *
00026  * The Message Digest (MD) or Hashing module provides one-way hashing
00027  * functions. Such functions can be used for creating a hash message
00028  * authentication code (HMAC) when sending a message. Such a HMAC can be used
00029  * in combination with a private key for authentication, which is a message
00030  * integrity control.
00031  *
00032  * All hash algorithms can be accessed via the generic MD layer (see
00033  * \c mbedtls_md_setup())
00034  *
00035  * The following hashing-algorithms are provided:
00036  * - MD2, MD4, MD5 128-bit one-way hash functions by Ron Rivest.
00037  * - SHA-1, SHA-256, SHA-384/512 160-bit or more one-way hash functions by
00038  *   NIST and NSA.
00039  *
00040  * This module provides one-way hashing which can be used for authentication.
00041  */