Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 1 | /** |
Simon Butcher | 5b331b9 | 2016-01-03 16:14:14 +0000 | [diff] [blame] | 2 | * \file md.h |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 3 | * |
Manuel Pégourié-Gonnard | b9b630d | 2023-02-16 19:07:31 +0100 | [diff] [blame] | 4 | * \brief This file contains the generic functions for message-digest |
| 5 | * (hashing) and HMAC. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 6 | * |
| 7 | * \author Adriaan de Jong <dejong@fox-it.com> |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 8 | */ |
| 9 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 10 | * Copyright The Mbed TLS Contributors |
Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 11 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 12 | */ |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 13 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 14 | #ifndef MBEDTLS_MD_H |
| 15 | #define MBEDTLS_MD_H |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 16 | #include "mbedtls/private_access.h" |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 17 | |
Rich Evans | 00ab470 | 2015-02-06 13:43:58 +0000 | [diff] [blame] | 18 | #include <stddef.h> |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 19 | |
Bence Szépkúti | c662b36 | 2021-05-27 11:25:03 +0200 | [diff] [blame] | 20 | #include "mbedtls/build_info.h" |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 21 | #include "mbedtls/platform_util.h" |
Ron Eldor | f231eaa | 2017-08-22 14:50:14 +0300 | [diff] [blame] | 22 | |
Gilles Peskine | d297157 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 23 | /** The selected feature is not available. */ |
| 24 | #define MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE -0x5080 |
| 25 | /** Bad input parameters to function. */ |
| 26 | #define MBEDTLS_ERR_MD_BAD_INPUT_DATA -0x5100 |
| 27 | /** Failed to allocate memory. */ |
| 28 | #define MBEDTLS_ERR_MD_ALLOC_FAILED -0x5180 |
| 29 | /** Opening or reading of file failed. */ |
| 30 | #define MBEDTLS_ERR_MD_FILE_IO_ERROR -0x5200 |
Ron Eldor | 9924bdc | 2018-10-04 10:59:13 +0300 | [diff] [blame] | 31 | |
Paul Bakker | 407a0da | 2013-06-27 14:29:21 +0200 | [diff] [blame] | 32 | #ifdef __cplusplus |
| 33 | extern "C" { |
| 34 | #endif |
| 35 | |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 36 | /** |
Rose Zadik | 8c9c794 | 2018-03-27 11:52:58 +0100 | [diff] [blame] | 37 | * \brief Supported message digests. |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 38 | * |
TRodziewicz | 10e8cf5 | 2021-05-31 17:58:57 +0200 | [diff] [blame] | 39 | * \warning MD5 and SHA-1 are considered weak message digests and |
Hanno Becker | bbca8c5 | 2017-09-25 14:53:51 +0100 | [diff] [blame] | 40 | * their use constitutes a security risk. We recommend considering |
| 41 | * stronger message digests instead. |
| 42 | * |
| 43 | */ |
Manuel Pégourié-Gonnard | 1f6d2e3 | 2023-06-06 12:34:45 +0200 | [diff] [blame] | 44 | /* Note: these are aligned with the definitions of PSA_ALG_ macros for hashes, |
| 45 | * in order to enable an efficient implementation of conversion functions. |
| 46 | * This is tested by md_to_from_psa() in test_suite_md. */ |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 47 | typedef enum { |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 48 | MBEDTLS_MD_NONE=0, /**< None. */ |
Manuel Pégourié-Gonnard | 9b76318 | 2023-05-31 10:54:08 +0200 | [diff] [blame] | 49 | MBEDTLS_MD_MD5=0x03, /**< The MD5 message digest. */ |
| 50 | MBEDTLS_MD_RIPEMD160=0x04, /**< The RIPEMD-160 message digest. */ |
| 51 | MBEDTLS_MD_SHA1=0x05, /**< The SHA-1 message digest. */ |
| 52 | MBEDTLS_MD_SHA224=0x08, /**< The SHA-224 message digest. */ |
| 53 | MBEDTLS_MD_SHA256=0x09, /**< The SHA-256 message digest. */ |
| 54 | MBEDTLS_MD_SHA384=0x0a, /**< The SHA-384 message digest. */ |
| 55 | MBEDTLS_MD_SHA512=0x0b, /**< The SHA-512 message digest. */ |
| 56 | MBEDTLS_MD_SHA3_224=0x10, /**< The SHA3-224 message digest. */ |
| 57 | MBEDTLS_MD_SHA3_256=0x11, /**< The SHA3-256 message digest. */ |
| 58 | MBEDTLS_MD_SHA3_384=0x12, /**< The SHA3-384 message digest. */ |
| 59 | MBEDTLS_MD_SHA3_512=0x13, /**< The SHA3-512 message digest. */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 60 | } mbedtls_md_type_t; |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 61 | |
Dave Rodgman | 9304186 | 2023-06-08 10:13:22 +0100 | [diff] [blame] | 62 | /* Note: this should always be >= PSA_HASH_MAX_SIZE |
| 63 | * in all builds with both CRYPTO_C and MD_LIGHT. |
| 64 | * |
| 65 | * This is to make things easier for modules such as TLS that may define a |
| 66 | * buffer size using MD_MAX_SIZE in a part of the code that's common to PSA |
| 67 | * and legacy, then assume the buffer's size is PSA_HASH_MAX_SIZE in another |
| 68 | * part of the code based on PSA. |
| 69 | */ |
Dave Rodgman | 0442e1b | 2023-06-08 16:03:33 +0100 | [diff] [blame] | 70 | #if defined(MBEDTLS_MD_CAN_SHA512) || defined(MBEDTLS_MD_CAN_SHA3_512) |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 71 | #define MBEDTLS_MD_MAX_SIZE 64 /* longest known is SHA512 */ |
Dave Rodgman | 0442e1b | 2023-06-08 16:03:33 +0100 | [diff] [blame] | 72 | #elif defined(MBEDTLS_MD_CAN_SHA384) || defined(MBEDTLS_MD_CAN_SHA3_384) |
Valerio Setti | d55cb5b | 2022-12-22 14:26:55 +0100 | [diff] [blame] | 73 | #define MBEDTLS_MD_MAX_SIZE 48 /* longest known is SHA384 */ |
Dave Rodgman | 0442e1b | 2023-06-08 16:03:33 +0100 | [diff] [blame] | 74 | #elif defined(MBEDTLS_MD_CAN_SHA256) || defined(MBEDTLS_MD_CAN_SHA3_256) |
Valerio Setti | d55cb5b | 2022-12-22 14:26:55 +0100 | [diff] [blame] | 75 | #define MBEDTLS_MD_MAX_SIZE 32 /* longest known is SHA256 */ |
Dave Rodgman | 0442e1b | 2023-06-08 16:03:33 +0100 | [diff] [blame] | 76 | #elif defined(MBEDTLS_MD_CAN_SHA224) || defined(MBEDTLS_MD_CAN_SHA3_224) |
Valerio Setti | d55cb5b | 2022-12-22 14:26:55 +0100 | [diff] [blame] | 77 | #define MBEDTLS_MD_MAX_SIZE 28 /* longest known is SHA224 */ |
Paul Bakker | 7db0109 | 2013-09-10 11:10:57 +0200 | [diff] [blame] | 78 | #else |
Gilles Peskine | 83d9e09 | 2022-10-22 18:32:43 +0200 | [diff] [blame] | 79 | #define MBEDTLS_MD_MAX_SIZE 20 /* longest known is SHA1 or RIPE MD-160 |
| 80 | or smaller (MD5 and earlier) */ |
Paul Bakker | 7db0109 | 2013-09-10 11:10:57 +0200 | [diff] [blame] | 81 | #endif |
Paul Bakker | 1b57b06 | 2011-01-06 15:48:19 +0000 | [diff] [blame] | 82 | |
Dave Rodgman | ff45d44 | 2023-06-08 10:11:34 +0100 | [diff] [blame] | 83 | #if defined(MBEDTLS_MD_CAN_SHA3_224) |
Pol Henarejos | 4712d4c | 2022-05-20 14:17:14 +0200 | [diff] [blame] | 84 | #define MBEDTLS_MD_MAX_BLOCK_SIZE 144 /* the longest known is SHA3-224 */ |
Dave Rodgman | 0442e1b | 2023-06-08 16:03:33 +0100 | [diff] [blame] | 85 | #elif defined(MBEDTLS_MD_CAN_SHA3_256) |
| 86 | #define MBEDTLS_MD_MAX_BLOCK_SIZE 136 |
Dave Rodgman | f956312 | 2023-06-11 16:04:29 +0100 | [diff] [blame] | 87 | #elif defined(MBEDTLS_MD_CAN_SHA512) || defined(MBEDTLS_MD_CAN_SHA384) |
Hanno Becker | 2e24c3b | 2017-12-27 21:28:58 +0000 | [diff] [blame] | 88 | #define MBEDTLS_MD_MAX_BLOCK_SIZE 128 |
Dave Rodgman | 0442e1b | 2023-06-08 16:03:33 +0100 | [diff] [blame] | 89 | #elif defined(MBEDTLS_MD_CAN_SHA3_384) |
| 90 | #define MBEDTLS_MD_MAX_BLOCK_SIZE 104 |
| 91 | #elif defined(MBEDTLS_MD_CAN_SHA3_512) |
| 92 | #define MBEDTLS_MD_MAX_BLOCK_SIZE 72 |
Hanno Becker | 2e24c3b | 2017-12-27 21:28:58 +0000 | [diff] [blame] | 93 | #else |
| 94 | #define MBEDTLS_MD_MAX_BLOCK_SIZE 64 |
| 95 | #endif |
| 96 | |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 97 | /** |
Chris Jones | 3848e31 | 2021-03-11 16:17:59 +0000 | [diff] [blame] | 98 | * Opaque struct. |
| 99 | * |
| 100 | * Constructed using either #mbedtls_md_info_from_string or |
| 101 | * #mbedtls_md_info_from_type. |
| 102 | * |
| 103 | * Fields can be accessed with #mbedtls_md_get_size, |
| 104 | * #mbedtls_md_get_type and #mbedtls_md_get_name. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 105 | */ |
Chris Jones | 3848e31 | 2021-03-11 16:17:59 +0000 | [diff] [blame] | 106 | /* Defined internally in library/md_wrap.h. */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 107 | typedef struct mbedtls_md_info_t mbedtls_md_info_t; |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 108 | |
| 109 | /** |
Manuel Pégourié-Gonnard | d8ea37f | 2023-03-09 10:46:22 +0100 | [diff] [blame] | 110 | * Used internally to indicate whether a context uses legacy or PSA. |
| 111 | * |
| 112 | * Internal use only. |
| 113 | */ |
| 114 | typedef enum { |
| 115 | MBEDTLS_MD_ENGINE_LEGACY = 0, |
| 116 | MBEDTLS_MD_ENGINE_PSA, |
| 117 | } mbedtls_md_engine_t; |
| 118 | |
| 119 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 120 | * The generic message-digest context. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 121 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 122 | typedef struct mbedtls_md_context_t { |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 123 | /** Information about the associated message digest. */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 124 | const mbedtls_md_info_t *MBEDTLS_PRIVATE(md_info); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 125 | |
Manuel Pégourié-Gonnard | d8ea37f | 2023-03-09 10:46:22 +0100 | [diff] [blame] | 126 | #if defined(MBEDTLS_MD_SOME_PSA) |
| 127 | /** Are hash operations dispatched to PSA or legacy? */ |
| 128 | mbedtls_md_engine_t MBEDTLS_PRIVATE(engine); |
| 129 | #endif |
| 130 | |
| 131 | /** The digest-specific context (legacy) or the PSA operation. */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 132 | void *MBEDTLS_PRIVATE(md_ctx); |
Manuel Pégourié-Gonnard | 8379a82 | 2015-03-24 16:48:22 +0100 | [diff] [blame] | 133 | |
Manuel Pégourié-Gonnard | 39a376a | 2023-03-09 17:21:40 +0100 | [diff] [blame] | 134 | #if defined(MBEDTLS_MD_C) |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 135 | /** The HMAC part of the context. */ |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 136 | void *MBEDTLS_PRIVATE(hmac_ctx); |
Manuel Pégourié-Gonnard | 39a376a | 2023-03-09 17:21:40 +0100 | [diff] [blame] | 137 | #endif |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 138 | } mbedtls_md_context_t; |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 139 | |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 140 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 141 | * \brief This function returns the message-digest information |
| 142 | * associated with the given digest type. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 143 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 144 | * \param md_type The type of digest to search for. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 145 | * |
Rose Zadik | 8c9c794 | 2018-03-27 11:52:58 +0100 | [diff] [blame] | 146 | * \return The message-digest information associated with \p md_type. |
| 147 | * \return NULL if the associated message-digest information is not found. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 148 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 149 | const mbedtls_md_info_t *mbedtls_md_info_from_type(mbedtls_md_type_t md_type); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 150 | |
| 151 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 152 | * \brief This function initializes a message-digest context without |
| 153 | * binding it to a particular message-digest algorithm. |
| 154 | * |
| 155 | * This function should always be called first. It prepares the |
| 156 | * context for mbedtls_md_setup() for binding it to a |
| 157 | * message-digest algorithm. |
Paul Bakker | 84bbeb5 | 2014-07-01 14:53:22 +0200 | [diff] [blame] | 158 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 159 | void mbedtls_md_init(mbedtls_md_context_t *ctx); |
Paul Bakker | 84bbeb5 | 2014-07-01 14:53:22 +0200 | [diff] [blame] | 160 | |
| 161 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 162 | * \brief This function clears the internal structure of \p ctx and |
| 163 | * frees any embedded internal structure, but does not free |
| 164 | * \p ctx itself. |
| 165 | * |
| 166 | * If you have called mbedtls_md_setup() on \p ctx, you must |
| 167 | * call mbedtls_md_free() when you are no longer using the |
| 168 | * context. |
| 169 | * Calling this function if you have previously |
| 170 | * called mbedtls_md_init() and nothing else is optional. |
| 171 | * You must not call this function if you have not called |
| 172 | * mbedtls_md_init(). |
Paul Bakker | 84bbeb5 | 2014-07-01 14:53:22 +0200 | [diff] [blame] | 173 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 174 | void mbedtls_md_free(mbedtls_md_context_t *ctx); |
Paul Bakker | 84bbeb5 | 2014-07-01 14:53:22 +0200 | [diff] [blame] | 175 | |
Manuel Pégourié-Gonnard | 147fa09 | 2015-03-25 16:43:14 +0100 | [diff] [blame] | 176 | |
Paul Bakker | 84bbeb5 | 2014-07-01 14:53:22 +0200 | [diff] [blame] | 177 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 178 | * \brief This function selects the message digest algorithm to use, |
| 179 | * and allocates internal structures. |
Paul Bakker | 562535d | 2011-01-20 16:42:01 +0000 | [diff] [blame] | 180 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 181 | * It should be called after mbedtls_md_init() or |
| 182 | * mbedtls_md_free(). Makes it necessary to call |
| 183 | * mbedtls_md_free() later. |
| 184 | * |
| 185 | * \param ctx The context to set up. |
| 186 | * \param md_info The information structure of the message-digest algorithm |
| 187 | * to use. |
Rose Zadik | 8c9c794 | 2018-03-27 11:52:58 +0100 | [diff] [blame] | 188 | * \param hmac Defines if HMAC is used. 0: HMAC is not used (saves some memory), |
| 189 | * or non-zero: HMAC is used with this context. |
Paul Bakker | 562535d | 2011-01-20 16:42:01 +0000 | [diff] [blame] | 190 | * |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 191 | * \return \c 0 on success. |
| 192 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification |
| 193 | * failure. |
| 194 | * \return #MBEDTLS_ERR_MD_ALLOC_FAILED on memory-allocation failure. |
Paul Bakker | 562535d | 2011-01-20 16:42:01 +0000 | [diff] [blame] | 195 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 196 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 197 | int mbedtls_md_setup(mbedtls_md_context_t *ctx, const mbedtls_md_info_t *md_info, int hmac); |
Paul Bakker | 562535d | 2011-01-20 16:42:01 +0000 | [diff] [blame] | 198 | |
| 199 | /** |
Tom Cosgrove | ce7f18c | 2022-07-28 05:50:56 +0100 | [diff] [blame] | 200 | * \brief This function clones the state of a message-digest |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 201 | * context. |
Manuel Pégourié-Gonnard | 052a6c9 | 2015-07-06 16:06:02 +0200 | [diff] [blame] | 202 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 203 | * \note You must call mbedtls_md_setup() on \c dst before calling |
| 204 | * this function. |
Manuel Pégourié-Gonnard | 052a6c9 | 2015-07-06 16:06:02 +0200 | [diff] [blame] | 205 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 206 | * \note The two contexts must have the same type, |
| 207 | * for example, both are SHA-256. |
Manuel Pégourié-Gonnard | 052a6c9 | 2015-07-06 16:06:02 +0200 | [diff] [blame] | 208 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 209 | * \warning This function clones the message-digest state, not the |
| 210 | * HMAC state. |
| 211 | * |
| 212 | * \param dst The destination context. |
| 213 | * \param src The context to be cloned. |
Manuel Pégourié-Gonnard | 052a6c9 | 2015-07-06 16:06:02 +0200 | [diff] [blame] | 214 | * |
Rose Zadik | 8c9c794 | 2018-03-27 11:52:58 +0100 | [diff] [blame] | 215 | * \return \c 0 on success. |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 216 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification failure. |
Manuel Pégourié-Gonnard | 9b14639 | 2023-03-09 15:56:14 +0100 | [diff] [blame] | 217 | * \return #MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE if both contexts are |
| 218 | * not using the same engine. This can be avoided by moving |
| 219 | * the call to psa_crypto_init() before the first call to |
| 220 | * mbedtls_md_setup(). |
Manuel Pégourié-Gonnard | 052a6c9 | 2015-07-06 16:06:02 +0200 | [diff] [blame] | 221 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 222 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 223 | int mbedtls_md_clone(mbedtls_md_context_t *dst, |
| 224 | const mbedtls_md_context_t *src); |
Manuel Pégourié-Gonnard | 052a6c9 | 2015-07-06 16:06:02 +0200 | [diff] [blame] | 225 | |
| 226 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 227 | * \brief This function extracts the message-digest size from the |
| 228 | * message-digest information structure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 229 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 230 | * \param md_info The information structure of the message-digest algorithm |
| 231 | * to use. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 232 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 233 | * \return The size of the message-digest output in Bytes. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 234 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 235 | unsigned char mbedtls_md_get_size(const mbedtls_md_info_t *md_info); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 236 | |
| 237 | /** |
Manuel Pégourié-Gonnard | 1ef26e2 | 2023-01-27 11:47:05 +0100 | [diff] [blame] | 238 | * \brief This function gives the message-digest size associated to |
| 239 | * message-digest type. |
| 240 | * |
| 241 | * \param md_type The message-digest type. |
| 242 | * |
| 243 | * \return The size of the message-digest output in Bytes, |
| 244 | * or 0 if the message-digest type is not known. |
| 245 | */ |
| 246 | static inline unsigned char mbedtls_md_get_size_from_type(mbedtls_md_type_t md_type) |
| 247 | { |
| 248 | return mbedtls_md_get_size(mbedtls_md_info_from_type(md_type)); |
| 249 | } |
| 250 | |
| 251 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 252 | * \brief This function extracts the message-digest type from the |
| 253 | * message-digest information structure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 254 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 255 | * \param md_info The information structure of the message-digest algorithm |
| 256 | * to use. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 257 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 258 | * \return The type of the message digest. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 259 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 260 | mbedtls_md_type_t mbedtls_md_get_type(const mbedtls_md_info_t *md_info); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 261 | |
| 262 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 263 | * \brief This function starts a message-digest computation. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 264 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 265 | * You must call this function after setting up the context |
| 266 | * with mbedtls_md_setup(), and before passing data with |
| 267 | * mbedtls_md_update(). |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 268 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 269 | * \param ctx The generic message-digest context. |
| 270 | * |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 271 | * \return \c 0 on success. |
| 272 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification |
| 273 | * failure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 274 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 275 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 276 | int mbedtls_md_starts(mbedtls_md_context_t *ctx); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 277 | |
| 278 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 279 | * \brief This function feeds an input buffer into an ongoing |
| 280 | * message-digest computation. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 281 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 282 | * You must call mbedtls_md_starts() before calling this |
| 283 | * function. You may call this function multiple times. |
| 284 | * Afterwards, call mbedtls_md_finish(). |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 285 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 286 | * \param ctx The generic message-digest context. |
| 287 | * \param input The buffer holding the input data. |
| 288 | * \param ilen The length of the input data. |
| 289 | * |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 290 | * \return \c 0 on success. |
| 291 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification |
| 292 | * failure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 293 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 294 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 295 | int mbedtls_md_update(mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 296 | |
| 297 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 298 | * \brief This function finishes the digest operation, |
| 299 | * and writes the result to the output buffer. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 300 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 301 | * Call this function after a call to mbedtls_md_starts(), |
| 302 | * followed by any number of calls to mbedtls_md_update(). |
| 303 | * Afterwards, you may either clear the context with |
| 304 | * mbedtls_md_free(), or call mbedtls_md_starts() to reuse |
| 305 | * the context for another digest operation with the same |
| 306 | * algorithm. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 307 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 308 | * \param ctx The generic message-digest context. |
| 309 | * \param output The buffer for the generic message-digest checksum result. |
| 310 | * |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 311 | * \return \c 0 on success. |
| 312 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification |
| 313 | * failure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 314 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 315 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 316 | int mbedtls_md_finish(mbedtls_md_context_t *ctx, unsigned char *output); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 317 | |
| 318 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 319 | * \brief This function calculates the message-digest of a buffer, |
| 320 | * with respect to a configurable message-digest algorithm |
| 321 | * in a single call. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 322 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 323 | * The result is calculated as |
| 324 | * Output = message_digest(input buffer). |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 325 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 326 | * \param md_info The information structure of the message-digest algorithm |
| 327 | * to use. |
| 328 | * \param input The buffer holding the data. |
| 329 | * \param ilen The length of the input data. |
| 330 | * \param output The generic message-digest checksum result. |
| 331 | * |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 332 | * \return \c 0 on success. |
| 333 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification |
| 334 | * failure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 335 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 336 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 337 | int mbedtls_md(const mbedtls_md_info_t *md_info, const unsigned char *input, size_t ilen, |
| 338 | unsigned char *output); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 339 | |
Manuel Pégourié-Gonnard | 82a4394 | 2023-02-23 09:36:29 +0100 | [diff] [blame] | 340 | /** |
| 341 | * \brief This function returns the list of digests supported by the |
| 342 | * generic digest module. |
| 343 | * |
| 344 | * \note The list starts with the strongest available hashes. |
| 345 | * |
| 346 | * \return A statically allocated array of digests. Each element |
| 347 | * in the returned list is an integer belonging to the |
| 348 | * message-digest enumeration #mbedtls_md_type_t. |
| 349 | * The last entry is 0. |
| 350 | */ |
| 351 | const int *mbedtls_md_list(void); |
| 352 | |
| 353 | /** |
| 354 | * \brief This function returns the message-digest information |
| 355 | * associated with the given digest name. |
| 356 | * |
| 357 | * \param md_name The name of the digest to search for. |
| 358 | * |
| 359 | * \return The message-digest information associated with \p md_name. |
| 360 | * \return NULL if the associated message-digest information is not found. |
| 361 | */ |
| 362 | const mbedtls_md_info_t *mbedtls_md_info_from_string(const char *md_name); |
| 363 | |
| 364 | /** |
Manuel Pégourié-Gonnard | 0fda0d2 | 2023-07-27 12:22:52 +0200 | [diff] [blame] | 365 | * \brief This function returns the name of the message digest for |
| 366 | * the message-digest information structure given. |
Manuel Pégourié-Gonnard | 82a4394 | 2023-02-23 09:36:29 +0100 | [diff] [blame] | 367 | * |
| 368 | * \param md_info The information structure of the message-digest algorithm |
| 369 | * to use. |
| 370 | * |
| 371 | * \return The name of the message digest. |
| 372 | */ |
| 373 | const char *mbedtls_md_get_name(const mbedtls_md_info_t *md_info); |
| 374 | |
| 375 | /** |
| 376 | * \brief This function returns the message-digest information |
| 377 | * from the given context. |
| 378 | * |
| 379 | * \param ctx The context from which to extract the information. |
| 380 | * This must be initialized (or \c NULL). |
| 381 | * |
| 382 | * \return The message-digest information associated with \p ctx. |
| 383 | * \return \c NULL if \p ctx is \c NULL. |
| 384 | */ |
| 385 | const mbedtls_md_info_t *mbedtls_md_info_from_ctx( |
| 386 | const mbedtls_md_context_t *ctx); |
| 387 | |
Manuel Pégourié-Gonnard | bfffa90 | 2015-05-28 14:44:00 +0200 | [diff] [blame] | 388 | #if defined(MBEDTLS_FS_IO) |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 389 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 390 | * \brief This function calculates the message-digest checksum |
| 391 | * result of the contents of the provided file. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 392 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 393 | * The result is calculated as |
| 394 | * Output = message_digest(file contents). |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 395 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 396 | * \param md_info The information structure of the message-digest algorithm |
| 397 | * to use. |
| 398 | * \param path The input file name. |
| 399 | * \param output The generic message-digest checksum result. |
| 400 | * |
Rose Zadik | 8c9c794 | 2018-03-27 11:52:58 +0100 | [diff] [blame] | 401 | * \return \c 0 on success. |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 402 | * \return #MBEDTLS_ERR_MD_FILE_IO_ERROR on an I/O error accessing |
| 403 | * the file pointed by \p path. |
| 404 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA if \p md_info was NULL. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 405 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 406 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 407 | int mbedtls_md_file(const mbedtls_md_info_t *md_info, const char *path, |
| 408 | unsigned char *output); |
Manuel Pégourié-Gonnard | bfffa90 | 2015-05-28 14:44:00 +0200 | [diff] [blame] | 409 | #endif /* MBEDTLS_FS_IO */ |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 410 | |
| 411 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 412 | * \brief This function sets the HMAC key and prepares to |
| 413 | * authenticate a new message. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 414 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 415 | * Call this function after mbedtls_md_setup(), to use |
| 416 | * the MD context for an HMAC calculation, then call |
| 417 | * mbedtls_md_hmac_update() to provide the input data, and |
| 418 | * mbedtls_md_hmac_finish() to get the HMAC value. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 419 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 420 | * \param ctx The message digest context containing an embedded HMAC |
| 421 | * context. |
| 422 | * \param key The HMAC secret key. |
| 423 | * \param keylen The length of the HMAC key in Bytes. |
| 424 | * |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 425 | * \return \c 0 on success. |
| 426 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification |
| 427 | * failure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 428 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 429 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 430 | int mbedtls_md_hmac_starts(mbedtls_md_context_t *ctx, const unsigned char *key, |
| 431 | size_t keylen); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 432 | |
| 433 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 434 | * \brief This function feeds an input buffer into an ongoing HMAC |
| 435 | * computation. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 436 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 437 | * Call mbedtls_md_hmac_starts() or mbedtls_md_hmac_reset() |
| 438 | * before calling this function. |
| 439 | * You may call this function multiple times to pass the |
| 440 | * input piecewise. |
| 441 | * Afterwards, call mbedtls_md_hmac_finish(). |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 442 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 443 | * \param ctx The message digest context containing an embedded HMAC |
| 444 | * context. |
| 445 | * \param input The buffer holding the input data. |
| 446 | * \param ilen The length of the input data. |
| 447 | * |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 448 | * \return \c 0 on success. |
| 449 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification |
| 450 | * failure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 451 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 452 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 453 | int mbedtls_md_hmac_update(mbedtls_md_context_t *ctx, const unsigned char *input, |
| 454 | size_t ilen); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 455 | |
| 456 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 457 | * \brief This function finishes the HMAC operation, and writes |
| 458 | * the result to the output buffer. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 459 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 460 | * Call this function after mbedtls_md_hmac_starts() and |
| 461 | * mbedtls_md_hmac_update() to get the HMAC value. Afterwards |
| 462 | * you may either call mbedtls_md_free() to clear the context, |
| 463 | * or call mbedtls_md_hmac_reset() to reuse the context with |
| 464 | * the same HMAC key. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 465 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 466 | * \param ctx The message digest context containing an embedded HMAC |
| 467 | * context. |
| 468 | * \param output The generic HMAC checksum result. |
| 469 | * |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 470 | * \return \c 0 on success. |
| 471 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification |
| 472 | * failure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 473 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 474 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 475 | int mbedtls_md_hmac_finish(mbedtls_md_context_t *ctx, unsigned char *output); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 476 | |
| 477 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 478 | * \brief This function prepares to authenticate a new message with |
| 479 | * the same key as the previous HMAC operation. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 480 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 481 | * You may call this function after mbedtls_md_hmac_finish(). |
| 482 | * Afterwards call mbedtls_md_hmac_update() to pass the new |
| 483 | * input. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 484 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 485 | * \param ctx The message digest context containing an embedded HMAC |
| 486 | * context. |
| 487 | * |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 488 | * \return \c 0 on success. |
| 489 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification |
| 490 | * failure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 491 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 492 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 493 | int mbedtls_md_hmac_reset(mbedtls_md_context_t *ctx); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 494 | |
| 495 | /** |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 496 | * \brief This function calculates the full generic HMAC |
| 497 | * on the input buffer with the provided key. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 498 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 499 | * The function allocates the context, performs the |
| 500 | * calculation, and frees the context. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 501 | * |
Rose Zadik | 64feefb | 2018-01-25 22:01:10 +0000 | [diff] [blame] | 502 | * The HMAC result is calculated as |
| 503 | * output = generic HMAC(hmac key, input buffer). |
| 504 | * |
| 505 | * \param md_info The information structure of the message-digest algorithm |
| 506 | * to use. |
| 507 | * \param key The HMAC secret key. |
| 508 | * \param keylen The length of the HMAC secret key in Bytes. |
| 509 | * \param input The buffer holding the input data. |
| 510 | * \param ilen The length of the input data. |
| 511 | * \param output The generic HMAC result. |
| 512 | * |
Rose Zadik | f3e4736 | 2018-04-16 16:31:16 +0100 | [diff] [blame] | 513 | * \return \c 0 on success. |
| 514 | * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification |
| 515 | * failure. |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 516 | */ |
Gilles Peskine | ecf6beb | 2021-12-10 21:35:10 +0100 | [diff] [blame] | 517 | MBEDTLS_CHECK_RETURN_TYPICAL |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 518 | int mbedtls_md_hmac(const mbedtls_md_info_t *md_info, const unsigned char *key, size_t keylen, |
| 519 | const unsigned char *input, size_t ilen, |
| 520 | unsigned char *output); |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 521 | |
Paul Bakker | 1737385 | 2011-01-06 14:20:01 +0000 | [diff] [blame] | 522 | #ifdef __cplusplus |
| 523 | } |
| 524 | #endif |
| 525 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 526 | #endif /* MBEDTLS_MD_H */ |