doc_hashing.h 1.5 KB

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