blob: dde95c563c80db99b9692b44a30b26e558ad334c [file] [log] [blame]
Gilles Peskine449bd832023-01-11 14:50:10 +01001/**
Simon Butcher5b331b92016-01-03 16:14:14 +00002 * \file md.h
Paul Bakker9af723c2014-05-01 13:03:14 +02003 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01004 * \brief This file contains the generic functions for message-digest
5 * (hashing) and HMAC.
Paul Bakker17373852011-01-06 14:20:01 +00006 *
7 * \author Adriaan de Jong <dejong@fox-it.com>
Darryl Greena40a1012018-01-05 15:33:17 +00008 */
9/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020010 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020011 * SPDX-License-Identifier: Apache-2.0
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License"); you may
14 * not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
21 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
Paul Bakker17373852011-01-06 14:20:01 +000024 */
Rose Zadik64feefb2018-01-25 22:01:10 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#ifndef MBEDTLS_MD_H
27#define MBEDTLS_MD_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020028#include "mbedtls/private_access.h"
Paul Bakker17373852011-01-06 14:20:01 +000029
Rich Evans00ab4702015-02-06 13:43:58 +000030#include <stddef.h>
Paul Bakker23986e52011-04-24 08:57:21 +000031
Bence Szépkútic662b362021-05-27 11:25:03 +020032#include "mbedtls/build_info.h"
Gilles Peskineecf6beb2021-12-10 21:35:10 +010033#include "mbedtls/platform_util.h"
Ron Eldorf231eaa2017-08-22 14:50:14 +030034
Gilles Peskine416d0e22022-10-22 18:27:57 +020035#if defined(MBEDTLS_MD_LIGHT)
36
37/*
38 * - MBEDTLS_MD_CAN_xxx is defined if the md module can perform xxx.
Manuel Pégourié-Gonnard9d698df2023-03-14 12:24:05 +010039 * - MBEDTLS_MD_xxx_VIA_PSA is defined if the md module may perform xxx via PSA
40 * (see below).
41 * - MBEDTLS_MD_SOME_PSA is defined if at least one algorithm may be performed
42 * via PSA (see below).
43 * - MBEDTLS_MD_SOME_LEGACY is defined if at least one algorithm may be performed
44 * via a direct legacy call (see below).
Gilles Peskine416d0e22022-10-22 18:27:57 +020045 *
46 * The md module performs an algorithm via PSA if there is a PSA hash
Manuel Pégourié-Gonnard9d698df2023-03-14 12:24:05 +010047 * accelerator and the PSA driver subsytem is initialized at the time the
48 * operation is started, and makes a direct legacy call otherwise.
Gilles Peskine416d0e22022-10-22 18:27:57 +020049 */
50
51/* PSA accelerated implementations */
52#if defined(MBEDTLS_PSA_CRYPTO_C)
53#if defined(MBEDTLS_PSA_ACCEL_ALG_MD5)
54#define MBEDTLS_MD_CAN_MD5
55#define MBEDTLS_MD_MD5_VIA_PSA
56#define MBEDTLS_MD_SOME_PSA
57#endif
58#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA_1)
59#define MBEDTLS_MD_CAN_SHA1
60#define MBEDTLS_MD_SHA1_VIA_PSA
61#define MBEDTLS_MD_SOME_PSA
62#endif
63#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA_224)
64#define MBEDTLS_MD_CAN_SHA224
65#define MBEDTLS_MD_SHA224_VIA_PSA
66#define MBEDTLS_MD_SOME_PSA
67#endif
68#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA_256)
69#define MBEDTLS_MD_CAN_SHA256
70#define MBEDTLS_MD_SHA256_VIA_PSA
71#define MBEDTLS_MD_SOME_PSA
72#endif
73#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA_384)
74#define MBEDTLS_MD_CAN_SHA384
75#define MBEDTLS_MD_SHA384_VIA_PSA
76#define MBEDTLS_MD_SOME_PSA
77#endif
78#if defined(MBEDTLS_PSA_ACCEL_ALG_SHA_512)
79#define MBEDTLS_MD_CAN_SHA512
80#define MBEDTLS_MD_SHA512_VIA_PSA
81#define MBEDTLS_MD_SOME_PSA
82#endif
83#if defined(MBEDTLS_PSA_ACCEL_ALG_RIPEMD160)
84#define MBEDTLS_MD_CAN_RIPEMD160
85#define MBEDTLS_MD_RIPEMD160_VIA_PSA
86#define MBEDTLS_MD_SOME_PSA
87#endif
88#endif /* MBEDTLS_PSA_CRYPTO_C */
89
90/* Built-in implementations */
91#if defined(MBEDTLS_MD5_C)
92#define MBEDTLS_MD_CAN_MD5
93#define MBEDTLS_MD_SOME_LEGACY
94#endif
95#if defined(MBEDTLS_SHA1_C)
96#define MBEDTLS_MD_CAN_SHA1
97#define MBEDTLS_MD_SOME_LEGACY
98#endif
99#if defined(MBEDTLS_SHA224_C)
100#define MBEDTLS_MD_CAN_SHA224
101#define MBEDTLS_MD_SOME_LEGACY
102#endif
103#if defined(MBEDTLS_SHA256_C)
104#define MBEDTLS_MD_CAN_SHA256
105#define MBEDTLS_MD_SOME_LEGACY
106#endif
107#if defined(MBEDTLS_SHA384_C)
108#define MBEDTLS_MD_CAN_SHA384
109#define MBEDTLS_MD_SOME_LEGACY
110#endif
111#if defined(MBEDTLS_SHA512_C)
112#define MBEDTLS_MD_CAN_SHA512
113#define MBEDTLS_MD_SOME_LEGACY
114#endif
Dave Rodgman05d71ff2023-06-07 18:02:04 +0100115#if defined(MBEDTLS_SHA3_C)
Dave Rodgmanff45d442023-06-08 10:11:34 +0100116#define MBEDTLS_MD_CAN_SHA3_224
117#define MBEDTLS_MD_CAN_SHA3_256
118#define MBEDTLS_MD_CAN_SHA3_384
119#define MBEDTLS_MD_CAN_SHA3_512
Dave Rodgman05d71ff2023-06-07 18:02:04 +0100120#endif
Gilles Peskine416d0e22022-10-22 18:27:57 +0200121#if defined(MBEDTLS_RIPEMD160_C)
122#define MBEDTLS_MD_CAN_RIPEMD160
123#define MBEDTLS_MD_SOME_LEGACY
124#endif
125
126#endif /* MBEDTLS_MD_LIGHT */
127
Gilles Peskined2971572021-07-26 18:48:10 +0200128/** The selected feature is not available. */
129#define MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE -0x5080
130/** Bad input parameters to function. */
131#define MBEDTLS_ERR_MD_BAD_INPUT_DATA -0x5100
132/** Failed to allocate memory. */
133#define MBEDTLS_ERR_MD_ALLOC_FAILED -0x5180
134/** Opening or reading of file failed. */
135#define MBEDTLS_ERR_MD_FILE_IO_ERROR -0x5200
Ron Eldor9924bdc2018-10-04 10:59:13 +0300136
Paul Bakker407a0da2013-06-27 14:29:21 +0200137#ifdef __cplusplus
138extern "C" {
139#endif
140
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100141/**
Rose Zadik8c9c7942018-03-27 11:52:58 +0100142 * \brief Supported message digests.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100143 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200144 * \warning MD5 and SHA-1 are considered weak message digests and
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100145 * their use constitutes a security risk. We recommend considering
146 * stronger message digests instead.
147 *
148 */
Manuel Pégourié-Gonnard1f6d2e32023-06-06 12:34:45 +0200149/* Note: these are aligned with the definitions of PSA_ALG_ macros for hashes,
150 * in order to enable an efficient implementation of conversion functions.
151 * This is tested by md_to_from_psa() in test_suite_md. */
Paul Bakker17373852011-01-06 14:20:01 +0000152typedef enum {
Rose Zadikf3e47362018-04-16 16:31:16 +0100153 MBEDTLS_MD_NONE=0, /**< None. */
Manuel Pégourié-Gonnard9b763182023-05-31 10:54:08 +0200154 MBEDTLS_MD_MD5=0x03, /**< The MD5 message digest. */
155 MBEDTLS_MD_RIPEMD160=0x04, /**< The RIPEMD-160 message digest. */
156 MBEDTLS_MD_SHA1=0x05, /**< The SHA-1 message digest. */
157 MBEDTLS_MD_SHA224=0x08, /**< The SHA-224 message digest. */
158 MBEDTLS_MD_SHA256=0x09, /**< The SHA-256 message digest. */
159 MBEDTLS_MD_SHA384=0x0a, /**< The SHA-384 message digest. */
160 MBEDTLS_MD_SHA512=0x0b, /**< The SHA-512 message digest. */
161 MBEDTLS_MD_SHA3_224=0x10, /**< The SHA3-224 message digest. */
162 MBEDTLS_MD_SHA3_256=0x11, /**< The SHA3-256 message digest. */
163 MBEDTLS_MD_SHA3_384=0x12, /**< The SHA3-384 message digest. */
164 MBEDTLS_MD_SHA3_512=0x13, /**< The SHA3-512 message digest. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200165} mbedtls_md_type_t;
Paul Bakker17373852011-01-06 14:20:01 +0000166
Dave Rodgman93041862023-06-08 10:13:22 +0100167/* Note: this should always be >= PSA_HASH_MAX_SIZE
168 * in all builds with both CRYPTO_C and MD_LIGHT.
169 *
170 * This is to make things easier for modules such as TLS that may define a
171 * buffer size using MD_MAX_SIZE in a part of the code that's common to PSA
172 * and legacy, then assume the buffer's size is PSA_HASH_MAX_SIZE in another
173 * part of the code based on PSA.
174 */
Dave Rodgman0442e1b2023-06-08 16:03:33 +0100175#if defined(MBEDTLS_MD_CAN_SHA512) || defined(MBEDTLS_MD_CAN_SHA3_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176#define MBEDTLS_MD_MAX_SIZE 64 /* longest known is SHA512 */
Dave Rodgman0442e1b2023-06-08 16:03:33 +0100177#elif defined(MBEDTLS_MD_CAN_SHA384) || defined(MBEDTLS_MD_CAN_SHA3_384)
Valerio Settid55cb5b2022-12-22 14:26:55 +0100178#define MBEDTLS_MD_MAX_SIZE 48 /* longest known is SHA384 */
Dave Rodgman0442e1b2023-06-08 16:03:33 +0100179#elif defined(MBEDTLS_MD_CAN_SHA256) || defined(MBEDTLS_MD_CAN_SHA3_256)
Valerio Settid55cb5b2022-12-22 14:26:55 +0100180#define MBEDTLS_MD_MAX_SIZE 32 /* longest known is SHA256 */
Dave Rodgman0442e1b2023-06-08 16:03:33 +0100181#elif defined(MBEDTLS_MD_CAN_SHA224) || defined(MBEDTLS_MD_CAN_SHA3_224)
Valerio Settid55cb5b2022-12-22 14:26:55 +0100182#define MBEDTLS_MD_MAX_SIZE 28 /* longest known is SHA224 */
Paul Bakker7db01092013-09-10 11:10:57 +0200183#else
Gilles Peskine83d9e092022-10-22 18:32:43 +0200184#define MBEDTLS_MD_MAX_SIZE 20 /* longest known is SHA1 or RIPE MD-160
185 or smaller (MD5 and earlier) */
Paul Bakker7db01092013-09-10 11:10:57 +0200186#endif
Paul Bakker1b57b062011-01-06 15:48:19 +0000187
Dave Rodgmanff45d442023-06-08 10:11:34 +0100188#if defined(MBEDTLS_MD_CAN_SHA3_224)
Pol Henarejos4712d4c2022-05-20 14:17:14 +0200189#define MBEDTLS_MD_MAX_BLOCK_SIZE 144 /* the longest known is SHA3-224 */
Dave Rodgman0442e1b2023-06-08 16:03:33 +0100190#elif defined(MBEDTLS_MD_CAN_SHA3_256)
191#define MBEDTLS_MD_MAX_BLOCK_SIZE 136
Dave Rodgmanf9563122023-06-11 16:04:29 +0100192#elif defined(MBEDTLS_MD_CAN_SHA512) || defined(MBEDTLS_MD_CAN_SHA384)
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000193#define MBEDTLS_MD_MAX_BLOCK_SIZE 128
Dave Rodgman0442e1b2023-06-08 16:03:33 +0100194#elif defined(MBEDTLS_MD_CAN_SHA3_384)
195#define MBEDTLS_MD_MAX_BLOCK_SIZE 104
196#elif defined(MBEDTLS_MD_CAN_SHA3_512)
197#define MBEDTLS_MD_MAX_BLOCK_SIZE 72
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000198#else
199#define MBEDTLS_MD_MAX_BLOCK_SIZE 64
200#endif
201
Paul Bakker17373852011-01-06 14:20:01 +0000202/**
Chris Jones3848e312021-03-11 16:17:59 +0000203 * Opaque struct.
204 *
205 * Constructed using either #mbedtls_md_info_from_string or
206 * #mbedtls_md_info_from_type.
207 *
208 * Fields can be accessed with #mbedtls_md_get_size,
209 * #mbedtls_md_get_type and #mbedtls_md_get_name.
Paul Bakker17373852011-01-06 14:20:01 +0000210 */
Chris Jones3848e312021-03-11 16:17:59 +0000211/* Defined internally in library/md_wrap.h. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200212typedef struct mbedtls_md_info_t mbedtls_md_info_t;
Paul Bakker17373852011-01-06 14:20:01 +0000213
214/**
Manuel Pégourié-Gonnardd8ea37f2023-03-09 10:46:22 +0100215 * Used internally to indicate whether a context uses legacy or PSA.
216 *
217 * Internal use only.
218 */
219typedef enum {
220 MBEDTLS_MD_ENGINE_LEGACY = 0,
221 MBEDTLS_MD_ENGINE_PSA,
222} mbedtls_md_engine_t;
223
224/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000225 * The generic message-digest context.
Paul Bakker17373852011-01-06 14:20:01 +0000226 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100227typedef struct mbedtls_md_context_t {
Rose Zadik64feefb2018-01-25 22:01:10 +0000228 /** Information about the associated message digest. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200229 const mbedtls_md_info_t *MBEDTLS_PRIVATE(md_info);
Paul Bakker17373852011-01-06 14:20:01 +0000230
Manuel Pégourié-Gonnardd8ea37f2023-03-09 10:46:22 +0100231#if defined(MBEDTLS_MD_SOME_PSA)
232 /** Are hash operations dispatched to PSA or legacy? */
233 mbedtls_md_engine_t MBEDTLS_PRIVATE(engine);
234#endif
235
236 /** The digest-specific context (legacy) or the PSA operation. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200237 void *MBEDTLS_PRIVATE(md_ctx);
Manuel Pégourié-Gonnard8379a822015-03-24 16:48:22 +0100238
Manuel Pégourié-Gonnard39a376a2023-03-09 17:21:40 +0100239#if defined(MBEDTLS_MD_C)
Rose Zadik64feefb2018-01-25 22:01:10 +0000240 /** The HMAC part of the context. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200241 void *MBEDTLS_PRIVATE(hmac_ctx);
Manuel Pégourié-Gonnard39a376a2023-03-09 17:21:40 +0100242#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243} mbedtls_md_context_t;
Paul Bakker17373852011-01-06 14:20:01 +0000244
Paul Bakker17373852011-01-06 14:20:01 +0000245/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000246 * \brief This function returns the message-digest information
247 * associated with the given digest type.
Paul Bakker17373852011-01-06 14:20:01 +0000248 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000249 * \param md_type The type of digest to search for.
Paul Bakker17373852011-01-06 14:20:01 +0000250 *
Rose Zadik8c9c7942018-03-27 11:52:58 +0100251 * \return The message-digest information associated with \p md_type.
252 * \return NULL if the associated message-digest information is not found.
Paul Bakker17373852011-01-06 14:20:01 +0000253 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100254const mbedtls_md_info_t *mbedtls_md_info_from_type(mbedtls_md_type_t md_type);
Paul Bakker17373852011-01-06 14:20:01 +0000255
256/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000257 * \brief This function initializes a message-digest context without
258 * binding it to a particular message-digest algorithm.
259 *
260 * This function should always be called first. It prepares the
261 * context for mbedtls_md_setup() for binding it to a
262 * message-digest algorithm.
Paul Bakker84bbeb52014-07-01 14:53:22 +0200263 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100264void mbedtls_md_init(mbedtls_md_context_t *ctx);
Paul Bakker84bbeb52014-07-01 14:53:22 +0200265
266/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000267 * \brief This function clears the internal structure of \p ctx and
268 * frees any embedded internal structure, but does not free
269 * \p ctx itself.
270 *
271 * If you have called mbedtls_md_setup() on \p ctx, you must
272 * call mbedtls_md_free() when you are no longer using the
273 * context.
274 * Calling this function if you have previously
275 * called mbedtls_md_init() and nothing else is optional.
276 * You must not call this function if you have not called
277 * mbedtls_md_init().
Paul Bakker84bbeb52014-07-01 14:53:22 +0200278 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100279void mbedtls_md_free(mbedtls_md_context_t *ctx);
Paul Bakker84bbeb52014-07-01 14:53:22 +0200280
Manuel Pégourié-Gonnard147fa092015-03-25 16:43:14 +0100281
Paul Bakker84bbeb52014-07-01 14:53:22 +0200282/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000283 * \brief This function selects the message digest algorithm to use,
284 * and allocates internal structures.
Paul Bakker562535d2011-01-20 16:42:01 +0000285 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000286 * It should be called after mbedtls_md_init() or
287 * mbedtls_md_free(). Makes it necessary to call
288 * mbedtls_md_free() later.
289 *
290 * \param ctx The context to set up.
291 * \param md_info The information structure of the message-digest algorithm
292 * to use.
Rose Zadik8c9c7942018-03-27 11:52:58 +0100293 * \param hmac Defines if HMAC is used. 0: HMAC is not used (saves some memory),
294 * or non-zero: HMAC is used with this context.
Paul Bakker562535d2011-01-20 16:42:01 +0000295 *
Rose Zadikf3e47362018-04-16 16:31:16 +0100296 * \return \c 0 on success.
297 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification
298 * failure.
299 * \return #MBEDTLS_ERR_MD_ALLOC_FAILED on memory-allocation failure.
Paul Bakker562535d2011-01-20 16:42:01 +0000300 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100301MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100302int mbedtls_md_setup(mbedtls_md_context_t *ctx, const mbedtls_md_info_t *md_info, int hmac);
Paul Bakker562535d2011-01-20 16:42:01 +0000303
304/**
Tom Cosgrovece7f18c2022-07-28 05:50:56 +0100305 * \brief This function clones the state of a message-digest
Rose Zadik64feefb2018-01-25 22:01:10 +0000306 * context.
Manuel Pégourié-Gonnard052a6c92015-07-06 16:06:02 +0200307 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000308 * \note You must call mbedtls_md_setup() on \c dst before calling
309 * this function.
Manuel Pégourié-Gonnard052a6c92015-07-06 16:06:02 +0200310 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000311 * \note The two contexts must have the same type,
312 * for example, both are SHA-256.
Manuel Pégourié-Gonnard052a6c92015-07-06 16:06:02 +0200313 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000314 * \warning This function clones the message-digest state, not the
315 * HMAC state.
316 *
317 * \param dst The destination context.
318 * \param src The context to be cloned.
Manuel Pégourié-Gonnard052a6c92015-07-06 16:06:02 +0200319 *
Rose Zadik8c9c7942018-03-27 11:52:58 +0100320 * \return \c 0 on success.
Rose Zadikf3e47362018-04-16 16:31:16 +0100321 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification failure.
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +0100322 * \return #MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE if both contexts are
323 * not using the same engine. This can be avoided by moving
324 * the call to psa_crypto_init() before the first call to
325 * mbedtls_md_setup().
Manuel Pégourié-Gonnard052a6c92015-07-06 16:06:02 +0200326 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100327MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100328int mbedtls_md_clone(mbedtls_md_context_t *dst,
329 const mbedtls_md_context_t *src);
Manuel Pégourié-Gonnard052a6c92015-07-06 16:06:02 +0200330
331/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000332 * \brief This function extracts the message-digest size from the
333 * message-digest information structure.
Paul Bakker17373852011-01-06 14:20:01 +0000334 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000335 * \param md_info The information structure of the message-digest algorithm
336 * to use.
Paul Bakker17373852011-01-06 14:20:01 +0000337 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000338 * \return The size of the message-digest output in Bytes.
Paul Bakker17373852011-01-06 14:20:01 +0000339 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100340unsigned char mbedtls_md_get_size(const mbedtls_md_info_t *md_info);
Paul Bakker17373852011-01-06 14:20:01 +0000341
342/**
Manuel Pégourié-Gonnard1ef26e22023-01-27 11:47:05 +0100343 * \brief This function gives the message-digest size associated to
344 * message-digest type.
345 *
346 * \param md_type The message-digest type.
347 *
348 * \return The size of the message-digest output in Bytes,
349 * or 0 if the message-digest type is not known.
350 */
351static inline unsigned char mbedtls_md_get_size_from_type(mbedtls_md_type_t md_type)
352{
353 return mbedtls_md_get_size(mbedtls_md_info_from_type(md_type));
354}
355
356/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000357 * \brief This function extracts the message-digest type from the
358 * message-digest information structure.
Paul Bakker17373852011-01-06 14:20:01 +0000359 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000360 * \param md_info The information structure of the message-digest algorithm
361 * to use.
Paul Bakker17373852011-01-06 14:20:01 +0000362 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000363 * \return The type of the message digest.
Paul Bakker17373852011-01-06 14:20:01 +0000364 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100365mbedtls_md_type_t mbedtls_md_get_type(const mbedtls_md_info_t *md_info);
Paul Bakker17373852011-01-06 14:20:01 +0000366
367/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000368 * \brief This function starts a message-digest computation.
Paul Bakker17373852011-01-06 14:20:01 +0000369 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000370 * You must call this function after setting up the context
371 * with mbedtls_md_setup(), and before passing data with
372 * mbedtls_md_update().
Paul Bakker17373852011-01-06 14:20:01 +0000373 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000374 * \param ctx The generic message-digest context.
375 *
Rose Zadikf3e47362018-04-16 16:31:16 +0100376 * \return \c 0 on success.
377 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification
378 * failure.
Paul Bakker17373852011-01-06 14:20:01 +0000379 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100380MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100381int mbedtls_md_starts(mbedtls_md_context_t *ctx);
Paul Bakker17373852011-01-06 14:20:01 +0000382
383/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000384 * \brief This function feeds an input buffer into an ongoing
385 * message-digest computation.
Paul Bakker17373852011-01-06 14:20:01 +0000386 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000387 * You must call mbedtls_md_starts() before calling this
388 * function. You may call this function multiple times.
389 * Afterwards, call mbedtls_md_finish().
Paul Bakker17373852011-01-06 14:20:01 +0000390 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000391 * \param ctx The generic message-digest context.
392 * \param input The buffer holding the input data.
393 * \param ilen The length of the input data.
394 *
Rose Zadikf3e47362018-04-16 16:31:16 +0100395 * \return \c 0 on success.
396 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification
397 * failure.
Paul Bakker17373852011-01-06 14:20:01 +0000398 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100399MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400int mbedtls_md_update(mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen);
Paul Bakker17373852011-01-06 14:20:01 +0000401
402/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000403 * \brief This function finishes the digest operation,
404 * and writes the result to the output buffer.
Paul Bakker17373852011-01-06 14:20:01 +0000405 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000406 * Call this function after a call to mbedtls_md_starts(),
407 * followed by any number of calls to mbedtls_md_update().
408 * Afterwards, you may either clear the context with
409 * mbedtls_md_free(), or call mbedtls_md_starts() to reuse
410 * the context for another digest operation with the same
411 * algorithm.
Paul Bakker17373852011-01-06 14:20:01 +0000412 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000413 * \param ctx The generic message-digest context.
414 * \param output The buffer for the generic message-digest checksum result.
415 *
Rose Zadikf3e47362018-04-16 16:31:16 +0100416 * \return \c 0 on success.
417 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification
418 * failure.
Paul Bakker17373852011-01-06 14:20:01 +0000419 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100420MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100421int mbedtls_md_finish(mbedtls_md_context_t *ctx, unsigned char *output);
Paul Bakker17373852011-01-06 14:20:01 +0000422
423/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000424 * \brief This function calculates the message-digest of a buffer,
425 * with respect to a configurable message-digest algorithm
426 * in a single call.
Paul Bakker17373852011-01-06 14:20:01 +0000427 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000428 * The result is calculated as
429 * Output = message_digest(input buffer).
Paul Bakker17373852011-01-06 14:20:01 +0000430 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000431 * \param md_info The information structure of the message-digest algorithm
432 * to use.
433 * \param input The buffer holding the data.
434 * \param ilen The length of the input data.
435 * \param output The generic message-digest checksum result.
436 *
Rose Zadikf3e47362018-04-16 16:31:16 +0100437 * \return \c 0 on success.
438 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification
439 * failure.
Paul Bakker17373852011-01-06 14:20:01 +0000440 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100441MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100442int mbedtls_md(const mbedtls_md_info_t *md_info, const unsigned char *input, size_t ilen,
443 unsigned char *output);
Paul Bakker17373852011-01-06 14:20:01 +0000444
Manuel Pégourié-Gonnard82a43942023-02-23 09:36:29 +0100445/**
446 * \brief This function returns the list of digests supported by the
447 * generic digest module.
448 *
449 * \note The list starts with the strongest available hashes.
450 *
451 * \return A statically allocated array of digests. Each element
452 * in the returned list is an integer belonging to the
453 * message-digest enumeration #mbedtls_md_type_t.
454 * The last entry is 0.
455 */
456const int *mbedtls_md_list(void);
457
458/**
459 * \brief This function returns the message-digest information
460 * associated with the given digest name.
461 *
462 * \param md_name The name of the digest to search for.
463 *
464 * \return The message-digest information associated with \p md_name.
465 * \return NULL if the associated message-digest information is not found.
466 */
467const mbedtls_md_info_t *mbedtls_md_info_from_string(const char *md_name);
468
469/**
Manuel Pégourié-Gonnard0fda0d22023-07-27 12:22:52 +0200470 * \brief This function returns the name of the message digest for
471 * the message-digest information structure given.
Manuel Pégourié-Gonnard82a43942023-02-23 09:36:29 +0100472 *
473 * \param md_info The information structure of the message-digest algorithm
474 * to use.
475 *
476 * \return The name of the message digest.
477 */
478const char *mbedtls_md_get_name(const mbedtls_md_info_t *md_info);
479
480/**
481 * \brief This function returns the message-digest information
482 * from the given context.
483 *
484 * \param ctx The context from which to extract the information.
485 * This must be initialized (or \c NULL).
486 *
487 * \return The message-digest information associated with \p ctx.
488 * \return \c NULL if \p ctx is \c NULL.
489 */
490const mbedtls_md_info_t *mbedtls_md_info_from_ctx(
491 const mbedtls_md_context_t *ctx);
492
Manuel Pégourié-Gonnardbfffa902015-05-28 14:44:00 +0200493#if defined(MBEDTLS_FS_IO)
Paul Bakker17373852011-01-06 14:20:01 +0000494/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000495 * \brief This function calculates the message-digest checksum
496 * result of the contents of the provided file.
Paul Bakker17373852011-01-06 14:20:01 +0000497 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000498 * The result is calculated as
499 * Output = message_digest(file contents).
Paul Bakker17373852011-01-06 14:20:01 +0000500 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000501 * \param md_info The information structure of the message-digest algorithm
502 * to use.
503 * \param path The input file name.
504 * \param output The generic message-digest checksum result.
505 *
Rose Zadik8c9c7942018-03-27 11:52:58 +0100506 * \return \c 0 on success.
Rose Zadikf3e47362018-04-16 16:31:16 +0100507 * \return #MBEDTLS_ERR_MD_FILE_IO_ERROR on an I/O error accessing
508 * the file pointed by \p path.
509 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA if \p md_info was NULL.
Paul Bakker17373852011-01-06 14:20:01 +0000510 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100511MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100512int mbedtls_md_file(const mbedtls_md_info_t *md_info, const char *path,
513 unsigned char *output);
Manuel Pégourié-Gonnardbfffa902015-05-28 14:44:00 +0200514#endif /* MBEDTLS_FS_IO */
Paul Bakker17373852011-01-06 14:20:01 +0000515
516/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000517 * \brief This function sets the HMAC key and prepares to
518 * authenticate a new message.
Paul Bakker17373852011-01-06 14:20:01 +0000519 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000520 * Call this function after mbedtls_md_setup(), to use
521 * the MD context for an HMAC calculation, then call
522 * mbedtls_md_hmac_update() to provide the input data, and
523 * mbedtls_md_hmac_finish() to get the HMAC value.
Paul Bakker17373852011-01-06 14:20:01 +0000524 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000525 * \param ctx The message digest context containing an embedded HMAC
526 * context.
527 * \param key The HMAC secret key.
528 * \param keylen The length of the HMAC key in Bytes.
529 *
Rose Zadikf3e47362018-04-16 16:31:16 +0100530 * \return \c 0 on success.
531 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification
532 * failure.
Paul Bakker17373852011-01-06 14:20:01 +0000533 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100534MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100535int mbedtls_md_hmac_starts(mbedtls_md_context_t *ctx, const unsigned char *key,
536 size_t keylen);
Paul Bakker17373852011-01-06 14:20:01 +0000537
538/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000539 * \brief This function feeds an input buffer into an ongoing HMAC
540 * computation.
Paul Bakker17373852011-01-06 14:20:01 +0000541 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000542 * Call mbedtls_md_hmac_starts() or mbedtls_md_hmac_reset()
543 * before calling this function.
544 * You may call this function multiple times to pass the
545 * input piecewise.
546 * Afterwards, call mbedtls_md_hmac_finish().
Paul Bakker17373852011-01-06 14:20:01 +0000547 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000548 * \param ctx The message digest context containing an embedded HMAC
549 * context.
550 * \param input The buffer holding the input data.
551 * \param ilen The length of the input data.
552 *
Rose Zadikf3e47362018-04-16 16:31:16 +0100553 * \return \c 0 on success.
554 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification
555 * failure.
Paul Bakker17373852011-01-06 14:20:01 +0000556 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100557MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100558int mbedtls_md_hmac_update(mbedtls_md_context_t *ctx, const unsigned char *input,
559 size_t ilen);
Paul Bakker17373852011-01-06 14:20:01 +0000560
561/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000562 * \brief This function finishes the HMAC operation, and writes
563 * the result to the output buffer.
Paul Bakker17373852011-01-06 14:20:01 +0000564 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000565 * Call this function after mbedtls_md_hmac_starts() and
566 * mbedtls_md_hmac_update() to get the HMAC value. Afterwards
567 * you may either call mbedtls_md_free() to clear the context,
568 * or call mbedtls_md_hmac_reset() to reuse the context with
569 * the same HMAC key.
Paul Bakker17373852011-01-06 14:20:01 +0000570 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000571 * \param ctx The message digest context containing an embedded HMAC
572 * context.
573 * \param output The generic HMAC checksum result.
574 *
Rose Zadikf3e47362018-04-16 16:31:16 +0100575 * \return \c 0 on success.
576 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification
577 * failure.
Paul Bakker17373852011-01-06 14:20:01 +0000578 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100579MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100580int mbedtls_md_hmac_finish(mbedtls_md_context_t *ctx, unsigned char *output);
Paul Bakker17373852011-01-06 14:20:01 +0000581
582/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000583 * \brief This function prepares to authenticate a new message with
584 * the same key as the previous HMAC operation.
Paul Bakker17373852011-01-06 14:20:01 +0000585 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000586 * You may call this function after mbedtls_md_hmac_finish().
587 * Afterwards call mbedtls_md_hmac_update() to pass the new
588 * input.
Paul Bakker17373852011-01-06 14:20:01 +0000589 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000590 * \param ctx The message digest context containing an embedded HMAC
591 * context.
592 *
Rose Zadikf3e47362018-04-16 16:31:16 +0100593 * \return \c 0 on success.
594 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification
595 * failure.
Paul Bakker17373852011-01-06 14:20:01 +0000596 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100597MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100598int mbedtls_md_hmac_reset(mbedtls_md_context_t *ctx);
Paul Bakker17373852011-01-06 14:20:01 +0000599
600/**
Rose Zadik64feefb2018-01-25 22:01:10 +0000601 * \brief This function calculates the full generic HMAC
602 * on the input buffer with the provided key.
Paul Bakker17373852011-01-06 14:20:01 +0000603 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000604 * The function allocates the context, performs the
605 * calculation, and frees the context.
Paul Bakker17373852011-01-06 14:20:01 +0000606 *
Rose Zadik64feefb2018-01-25 22:01:10 +0000607 * The HMAC result is calculated as
608 * output = generic HMAC(hmac key, input buffer).
609 *
610 * \param md_info The information structure of the message-digest algorithm
611 * to use.
612 * \param key The HMAC secret key.
613 * \param keylen The length of the HMAC secret key in Bytes.
614 * \param input The buffer holding the input data.
615 * \param ilen The length of the input data.
616 * \param output The generic HMAC result.
617 *
Rose Zadikf3e47362018-04-16 16:31:16 +0100618 * \return \c 0 on success.
619 * \return #MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter-verification
620 * failure.
Paul Bakker17373852011-01-06 14:20:01 +0000621 */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100622MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100623int mbedtls_md_hmac(const mbedtls_md_info_t *md_info, const unsigned char *key, size_t keylen,
624 const unsigned char *input, size_t ilen,
625 unsigned char *output);
Paul Bakker17373852011-01-06 14:20:01 +0000626
Paul Bakker17373852011-01-06 14:20:01 +0000627#ifdef __cplusplus
628}
629#endif
630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200631#endif /* MBEDTLS_MD_H */