doc_hashing.h 1.5 KB

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