mbed TLS Build
doxygen/input/doc_hashing.h@0:cdf462088d13, 2017-01-05 (annotated)
- Committer:
- markrad
- Date:
- Thu Jan 05 00:18:44 2017 +0000
- Revision:
- 0:cdf462088d13
Initial commit
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
markrad | 0:cdf462088d13 | 1 | /** |
markrad | 0:cdf462088d13 | 2 | * @file |
markrad | 0:cdf462088d13 | 3 | * Hashing module documentation file. |
markrad | 0:cdf462088d13 | 4 | * |
markrad | 0:cdf462088d13 | 5 | * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved |
markrad | 0:cdf462088d13 | 6 | * SPDX-License-Identifier: Apache-2.0 |
markrad | 0:cdf462088d13 | 7 | * |
markrad | 0:cdf462088d13 | 8 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
markrad | 0:cdf462088d13 | 9 | * not use this file except in compliance with the License. |
markrad | 0:cdf462088d13 | 10 | * You may obtain a copy of the License at |
markrad | 0:cdf462088d13 | 11 | * |
markrad | 0:cdf462088d13 | 12 | * http://www.apache.org/licenses/LICENSE-2.0 |
markrad | 0:cdf462088d13 | 13 | * |
markrad | 0:cdf462088d13 | 14 | * Unless required by applicable law or agreed to in writing, software |
markrad | 0:cdf462088d13 | 15 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
markrad | 0:cdf462088d13 | 16 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
markrad | 0:cdf462088d13 | 17 | * See the License for the specific language governing permissions and |
markrad | 0:cdf462088d13 | 18 | * limitations under the License. |
markrad | 0:cdf462088d13 | 19 | * |
markrad | 0:cdf462088d13 | 20 | * This file is part of mbed TLS (https://tls.mbed.org) |
markrad | 0:cdf462088d13 | 21 | */ |
markrad | 0:cdf462088d13 | 22 | |
markrad | 0:cdf462088d13 | 23 | /** |
markrad | 0:cdf462088d13 | 24 | * @addtogroup hashing_module Hashing module |
markrad | 0:cdf462088d13 | 25 | * |
markrad | 0:cdf462088d13 | 26 | * The Message Digest (MD) or Hashing module provides one-way hashing |
markrad | 0:cdf462088d13 | 27 | * functions. Such functions can be used for creating a hash message |
markrad | 0:cdf462088d13 | 28 | * authentication code (HMAC) when sending a message. Such a HMAC can be used |
markrad | 0:cdf462088d13 | 29 | * in combination with a private key for authentication, which is a message |
markrad | 0:cdf462088d13 | 30 | * integrity control. |
markrad | 0:cdf462088d13 | 31 | * |
markrad | 0:cdf462088d13 | 32 | * All hash algorithms can be accessed via the generic MD layer (see |
markrad | 0:cdf462088d13 | 33 | * \c mbedtls_md_setup()) |
markrad | 0:cdf462088d13 | 34 | * |
markrad | 0:cdf462088d13 | 35 | * The following hashing-algorithms are provided: |
markrad | 0:cdf462088d13 | 36 | * - MD2, MD4, MD5 128-bit one-way hash functions by Ron Rivest. |
markrad | 0:cdf462088d13 | 37 | * - SHA-1, SHA-256, SHA-384/512 160-bit or more one-way hash functions by |
markrad | 0:cdf462088d13 | 38 | * NIST and NSA. |
markrad | 0:cdf462088d13 | 39 | * |
markrad | 0:cdf462088d13 | 40 | * This module provides one-way hashing which can be used for authentication. |
markrad | 0:cdf462088d13 | 41 | */ |