Mbed TLS v3.6.2
|
This file contains the generic functions for message-digest (hashing) and HMAC. More...
#include "mbedtls/private_access.h"
#include <stddef.h>
#include "mbedtls/build_info.h"
#include "mbedtls/platform_util.h"
Go to the source code of this file.
Data Structures | |
struct | mbedtls_md_context_t |
Macros | |
#define | MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE -0x5080 |
#define | MBEDTLS_ERR_MD_BAD_INPUT_DATA -0x5100 |
#define | MBEDTLS_ERR_MD_ALLOC_FAILED -0x5180 |
#define | MBEDTLS_ERR_MD_FILE_IO_ERROR -0x5200 |
#define | MBEDTLS_MD_MAX_SIZE 64 /* longest known is SHA512 */ |
#define | MBEDTLS_MD_MAX_BLOCK_SIZE 144 /* the longest known is SHA3-224 */ |
Typedefs | |
typedef struct mbedtls_md_info_t | mbedtls_md_info_t |
typedef struct mbedtls_md_context_t | mbedtls_md_context_t |
Enumerations | |
enum | mbedtls_md_type_t { MBEDTLS_MD_NONE =0 , MBEDTLS_MD_MD5 =0x03 , MBEDTLS_MD_RIPEMD160 =0x04 , MBEDTLS_MD_SHA1 =0x05 , MBEDTLS_MD_SHA224 =0x08 , MBEDTLS_MD_SHA256 =0x09 , MBEDTLS_MD_SHA384 =0x0a , MBEDTLS_MD_SHA512 =0x0b , MBEDTLS_MD_SHA3_224 =0x10 , MBEDTLS_MD_SHA3_256 =0x11 , MBEDTLS_MD_SHA3_384 =0x12 , MBEDTLS_MD_SHA3_512 =0x13 } |
Supported message digests. More... | |
enum | mbedtls_md_engine_t { MBEDTLS_MD_ENGINE_LEGACY = 0 , MBEDTLS_MD_ENGINE_PSA } |
Functions | |
const mbedtls_md_info_t * | mbedtls_md_info_from_type (mbedtls_md_type_t md_type) |
This function returns the message-digest information associated with the given digest type. | |
void | mbedtls_md_init (mbedtls_md_context_t *ctx) |
This function initializes a message-digest context without binding it to a particular message-digest algorithm. | |
void | mbedtls_md_free (mbedtls_md_context_t *ctx) |
This function clears the internal structure of ctx and frees any embedded internal structure, but does not free ctx itself. | |
int | mbedtls_md_setup (mbedtls_md_context_t *ctx, const mbedtls_md_info_t *md_info, int hmac) |
This function selects the message digest algorithm to use, and allocates internal structures. | |
int | mbedtls_md_clone (mbedtls_md_context_t *dst, const mbedtls_md_context_t *src) |
This function clones the state of a message-digest context. | |
unsigned char | mbedtls_md_get_size (const mbedtls_md_info_t *md_info) |
This function extracts the message-digest size from the message-digest information structure. | |
static unsigned char | mbedtls_md_get_size_from_type (mbedtls_md_type_t md_type) |
This function gives the message-digest size associated to message-digest type. | |
mbedtls_md_type_t | mbedtls_md_get_type (const mbedtls_md_info_t *md_info) |
This function extracts the message-digest type from the message-digest information structure. | |
int | mbedtls_md_starts (mbedtls_md_context_t *ctx) |
This function starts a message-digest computation. | |
int | mbedtls_md_update (mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen) |
This function feeds an input buffer into an ongoing message-digest computation. | |
int | mbedtls_md_finish (mbedtls_md_context_t *ctx, unsigned char *output) |
This function finishes the digest operation, and writes the result to the output buffer. | |
int | mbedtls_md (const mbedtls_md_info_t *md_info, const unsigned char *input, size_t ilen, unsigned char *output) |
This function calculates the message-digest of a buffer, with respect to a configurable message-digest algorithm in a single call. | |
const int * | mbedtls_md_list (void) |
This function returns the list of digests supported by the generic digest module. | |
const mbedtls_md_info_t * | mbedtls_md_info_from_string (const char *md_name) |
This function returns the message-digest information associated with the given digest name. | |
const char * | mbedtls_md_get_name (const mbedtls_md_info_t *md_info) |
This function returns the name of the message digest for the message-digest information structure given. | |
const mbedtls_md_info_t * | mbedtls_md_info_from_ctx (const mbedtls_md_context_t *ctx) |
This function returns the message-digest information from the given context. | |
int | mbedtls_md_file (const mbedtls_md_info_t *md_info, const char *path, unsigned char *output) |
This function calculates the message-digest checksum result of the contents of the provided file. | |
int | mbedtls_md_hmac_starts (mbedtls_md_context_t *ctx, const unsigned char *key, size_t keylen) |
This function sets the HMAC key and prepares to authenticate a new message. | |
int | mbedtls_md_hmac_update (mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen) |
This function feeds an input buffer into an ongoing HMAC computation. | |
int | mbedtls_md_hmac_finish (mbedtls_md_context_t *ctx, unsigned char *output) |
This function finishes the HMAC operation, and writes the result to the output buffer. | |
int | mbedtls_md_hmac_reset (mbedtls_md_context_t *ctx) |
This function prepares to authenticate a new message with the same key as the previous HMAC operation. | |
int | mbedtls_md_hmac (const mbedtls_md_info_t *md_info, const unsigned char *key, size_t keylen, const unsigned char *input, size_t ilen, unsigned char *output) |
This function calculates the full generic HMAC on the input buffer with the provided key. | |
This file contains the generic functions for message-digest (hashing) and HMAC.
Definition in file md.h.
#define MBEDTLS_ERR_MD_ALLOC_FAILED -0x5180 |
#define MBEDTLS_ERR_MD_BAD_INPUT_DATA -0x5100 |
#define MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE -0x5080 |
#define MBEDTLS_ERR_MD_FILE_IO_ERROR -0x5200 |
#define MBEDTLS_MD_MAX_BLOCK_SIZE 144 /* the longest known is SHA3-224 */ |
typedef struct mbedtls_md_context_t mbedtls_md_context_t |
The generic message-digest context.
typedef struct mbedtls_md_info_t mbedtls_md_info_t |
Opaque struct.
Constructed using either mbedtls_md_info_from_string or mbedtls_md_info_from_type.
Fields can be accessed with mbedtls_md_get_size, mbedtls_md_get_type and mbedtls_md_get_name.
enum mbedtls_md_engine_t |
enum mbedtls_md_type_t |
Supported message digests.
int mbedtls_md | ( | const mbedtls_md_info_t * | md_info, |
const unsigned char * | input, | ||
size_t | ilen, | ||
unsigned char * | output ) |
This function calculates the message-digest of a buffer, with respect to a configurable message-digest algorithm in a single call.
The result is calculated as Output = message_digest(input buffer).
md_info | The information structure of the message-digest algorithm to use. |
input | The buffer holding the data. |
ilen | The length of the input data. |
output | The generic message-digest checksum result. |
0
on success. int mbedtls_md_clone | ( | mbedtls_md_context_t * | dst, |
const mbedtls_md_context_t * | src ) |
This function clones the state of a message-digest context.
dst
before calling this function.dst | The destination context. |
src | The context to be cloned. |
0
on success. int mbedtls_md_file | ( | const mbedtls_md_info_t * | md_info, |
const char * | path, | ||
unsigned char * | output ) |
This function calculates the message-digest checksum result of the contents of the provided file.
The result is calculated as Output = message_digest(file contents).
md_info | The information structure of the message-digest algorithm to use. |
path | The input file name. |
output | The generic message-digest checksum result. |
0
on success. path
. md_info
was NULL. int mbedtls_md_finish | ( | mbedtls_md_context_t * | ctx, |
unsigned char * | output ) |
This function finishes the digest operation, and writes the result to the output buffer.
Call this function after a call to mbedtls_md_starts(), followed by any number of calls to mbedtls_md_update(). Afterwards, you may either clear the context with mbedtls_md_free(), or call mbedtls_md_starts() to reuse the context for another digest operation with the same algorithm.
ctx | The generic message-digest context. |
output | The buffer for the generic message-digest checksum result. |
0
on success. void mbedtls_md_free | ( | mbedtls_md_context_t * | ctx | ) |
This function clears the internal structure of ctx
and frees any embedded internal structure, but does not free ctx
itself.
If you have called mbedtls_md_setup() on ctx
, you must call mbedtls_md_free() when you are no longer using the context. Calling this function if you have previously called mbedtls_md_init() and nothing else is optional. You must not call this function if you have not called mbedtls_md_init().
const char * mbedtls_md_get_name | ( | const mbedtls_md_info_t * | md_info | ) |
This function returns the name of the message digest for the message-digest information structure given.
md_info | The information structure of the message-digest algorithm to use. |
unsigned char mbedtls_md_get_size | ( | const mbedtls_md_info_t * | md_info | ) |
This function extracts the message-digest size from the message-digest information structure.
md_info | The information structure of the message-digest algorithm to use. |
Referenced by mbedtls_md_get_size_from_type().
|
inlinestatic |
This function gives the message-digest size associated to message-digest type.
md_type | The message-digest type. |
Definition at line 246 of file md.h.
References mbedtls_md_get_size(), and mbedtls_md_info_from_type().
mbedtls_md_type_t mbedtls_md_get_type | ( | const mbedtls_md_info_t * | md_info | ) |
This function extracts the message-digest type from the message-digest information structure.
md_info | The information structure of the message-digest algorithm to use. |
int mbedtls_md_hmac | ( | const mbedtls_md_info_t * | md_info, |
const unsigned char * | key, | ||
size_t | keylen, | ||
const unsigned char * | input, | ||
size_t | ilen, | ||
unsigned char * | output ) |
This function calculates the full generic HMAC on the input buffer with the provided key.
The function allocates the context, performs the calculation, and frees the context.
The HMAC result is calculated as output = generic HMAC(hmac key, input buffer).
md_info | The information structure of the message-digest algorithm to use. |
key | The HMAC secret key. |
keylen | The length of the HMAC secret key in Bytes. |
input | The buffer holding the input data. |
ilen | The length of the input data. |
output | The generic HMAC result. |
0
on success. int mbedtls_md_hmac_finish | ( | mbedtls_md_context_t * | ctx, |
unsigned char * | output ) |
This function finishes the HMAC operation, and writes the result to the output buffer.
Call this function after mbedtls_md_hmac_starts() and mbedtls_md_hmac_update() to get the HMAC value. Afterwards you may either call mbedtls_md_free() to clear the context, or call mbedtls_md_hmac_reset() to reuse the context with the same HMAC key.
ctx | The message digest context containing an embedded HMAC context. |
output | The generic HMAC checksum result. |
0
on success. int mbedtls_md_hmac_reset | ( | mbedtls_md_context_t * | ctx | ) |
This function prepares to authenticate a new message with the same key as the previous HMAC operation.
You may call this function after mbedtls_md_hmac_finish(). Afterwards call mbedtls_md_hmac_update() to pass the new input.
ctx | The message digest context containing an embedded HMAC context. |
0
on success. int mbedtls_md_hmac_starts | ( | mbedtls_md_context_t * | ctx, |
const unsigned char * | key, | ||
size_t | keylen ) |
This function sets the HMAC key and prepares to authenticate a new message.
Call this function after mbedtls_md_setup(), to use the MD context for an HMAC calculation, then call mbedtls_md_hmac_update() to provide the input data, and mbedtls_md_hmac_finish() to get the HMAC value.
ctx | The message digest context containing an embedded HMAC context. |
key | The HMAC secret key. |
keylen | The length of the HMAC key in Bytes. |
0
on success. int mbedtls_md_hmac_update | ( | mbedtls_md_context_t * | ctx, |
const unsigned char * | input, | ||
size_t | ilen ) |
This function feeds an input buffer into an ongoing HMAC computation.
Call mbedtls_md_hmac_starts() or mbedtls_md_hmac_reset() before calling this function. You may call this function multiple times to pass the input piecewise. Afterwards, call mbedtls_md_hmac_finish().
ctx | The message digest context containing an embedded HMAC context. |
input | The buffer holding the input data. |
ilen | The length of the input data. |
0
on success. const mbedtls_md_info_t * mbedtls_md_info_from_ctx | ( | const mbedtls_md_context_t * | ctx | ) |
This function returns the message-digest information from the given context.
ctx | The context from which to extract the information. This must be initialized (or NULL ). |
ctx
. NULL
if ctx
is NULL
. const mbedtls_md_info_t * mbedtls_md_info_from_string | ( | const char * | md_name | ) |
This function returns the message-digest information associated with the given digest name.
md_name | The name of the digest to search for. |
md_name
. const mbedtls_md_info_t * mbedtls_md_info_from_type | ( | mbedtls_md_type_t | md_type | ) |
This function returns the message-digest information associated with the given digest type.
md_type | The type of digest to search for. |
md_type
. Referenced by mbedtls_md_get_size_from_type().
void mbedtls_md_init | ( | mbedtls_md_context_t * | ctx | ) |
This function initializes a message-digest context without binding it to a particular message-digest algorithm.
This function should always be called first. It prepares the context for mbedtls_md_setup() for binding it to a message-digest algorithm.
const int * mbedtls_md_list | ( | void | ) |
This function returns the list of digests supported by the generic digest module.
int mbedtls_md_setup | ( | mbedtls_md_context_t * | ctx, |
const mbedtls_md_info_t * | md_info, | ||
int | hmac ) |
This function selects the message digest algorithm to use, and allocates internal structures.
It should be called after mbedtls_md_init() or mbedtls_md_free(). Makes it necessary to call mbedtls_md_free() later.
ctx | The context to set up. |
md_info | The information structure of the message-digest algorithm to use. |
hmac | Defines if HMAC is used. 0: HMAC is not used (saves some memory), or non-zero: HMAC is used with this context. |
0
on success. int mbedtls_md_starts | ( | mbedtls_md_context_t * | ctx | ) |
This function starts a message-digest computation.
You must call this function after setting up the context with mbedtls_md_setup(), and before passing data with mbedtls_md_update().
ctx | The generic message-digest context. |
0
on success. int mbedtls_md_update | ( | mbedtls_md_context_t * | ctx, |
const unsigned char * | input, | ||
size_t | ilen ) |
This function feeds an input buffer into an ongoing message-digest computation.
You must call mbedtls_md_starts() before calling this function. You may call this function multiple times. Afterwards, call mbedtls_md_finish().
ctx | The generic message-digest context. |
input | The buffer holding the input data. |
ilen | The length of the input data. |
0
on success.