mbed TLS v2.0.0
Data Structures | Macros | Typedefs | Enumerations | Functions
md.h File Reference
#include <stddef.h>
Include dependency graph for md.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  mbedtls_md_context_t
 Generic message digest context. More...
 

Macros

#define MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE   -0x5080
 The selected feature is not available. More...
 
#define MBEDTLS_ERR_MD_BAD_INPUT_DATA   -0x5100
 Bad input parameters to function. More...
 
#define MBEDTLS_ERR_MD_ALLOC_FAILED   -0x5180
 Failed to allocate memory. More...
 
#define MBEDTLS_ERR_MD_FILE_IO_ERROR   -0x5200
 Opening or reading of file failed. More...
 
#define MBEDTLS_MD_MAX_SIZE   32 /* longest known is SHA256 or less */
 
#define MBEDTLS_DEPRECATED
 

Typedefs

typedef struct mbedtls_md_info_t mbedtls_md_info_t
 Opaque struct defined in md_internal.h. More...
 

Enumerations

enum  mbedtls_md_type_t {
  MBEDTLS_MD_NONE =0, MBEDTLS_MD_MD2, MBEDTLS_MD_MD4, MBEDTLS_MD_MD5,
  MBEDTLS_MD_SHA1, MBEDTLS_MD_SHA224, MBEDTLS_MD_SHA256, MBEDTLS_MD_SHA384,
  MBEDTLS_MD_SHA512, MBEDTLS_MD_RIPEMD160
}
 

Functions

const int * mbedtls_md_list (void)
 Returns the list of digests supported by the generic digest module. More...
 
const mbedtls_md_info_tmbedtls_md_info_from_string (const char *md_name)
 Returns the message digest information associated with the given digest name. More...
 
const mbedtls_md_info_tmbedtls_md_info_from_type (mbedtls_md_type_t md_type)
 Returns the message digest information associated with the given digest type. More...
 
void mbedtls_md_init (mbedtls_md_context_t *ctx)
 Initialize a md_context (as NONE) This should always be called first. More...
 
void mbedtls_md_free (mbedtls_md_context_t *ctx)
 Free and clear the internal structures of ctx. More...
 
int mbedtls_md_init_ctx (mbedtls_md_context_t *ctx, const mbedtls_md_info_t *md_info) MBEDTLS_DEPRECATED
 Select MD to use and allocate internal structures. More...
 
int mbedtls_md_setup (mbedtls_md_context_t *ctx, const mbedtls_md_info_t *md_info, int hmac)
 Select MD to use and allocate internal structures. More...
 
int mbedtls_md_clone (mbedtls_md_context_t *dst, const mbedtls_md_context_t *src)
 Clone the state of an MD context. More...
 
unsigned char mbedtls_md_get_size (const mbedtls_md_info_t *md_info)
 Returns the size of the message digest output. More...
 
mbedtls_md_type_t mbedtls_md_get_type (const mbedtls_md_info_t *md_info)
 Returns the type of the message digest output. More...
 
const char * mbedtls_md_get_name (const mbedtls_md_info_t *md_info)
 Returns the name of the message digest output. More...
 
int mbedtls_md_starts (mbedtls_md_context_t *ctx)
 Prepare the context to digest a new message. More...
 
int mbedtls_md_update (mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen)
 Generic message digest process buffer Called between mbedtls_md_starts() and mbedtls_md_finish(). More...
 
int mbedtls_md_finish (mbedtls_md_context_t *ctx, unsigned char *output)
 Generic message digest final digest Called after mbedtls_md_update(). More...
 
int mbedtls_md (const mbedtls_md_info_t *md_info, const unsigned char *input, size_t ilen, unsigned char *output)
 Output = message_digest( input buffer ) More...
 
int mbedtls_md_hmac_starts (mbedtls_md_context_t *ctx, const unsigned char *key, size_t keylen)
 Set HMAC key and prepare to authenticate a new message. More...
 
int mbedtls_md_hmac_update (mbedtls_md_context_t *ctx, const unsigned char *input, size_t ilen)
 Generic HMAC process buffer. More...
 
int mbedtls_md_hmac_finish (mbedtls_md_context_t *ctx, unsigned char *output)
 Output HMAC. More...
 
int mbedtls_md_hmac_reset (mbedtls_md_context_t *ctx)
 Prepare to authenticate a new message with the same key. More...
 
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)
 Output = Generic_HMAC( hmac key, input buffer ) More...
 
int mbedtls_md_process (mbedtls_md_context_t *ctx, const unsigned char *data)
 

Macro Definition Documentation

#define MBEDTLS_DEPRECATED

Definition at line 130 of file md.h.

#define MBEDTLS_ERR_MD_ALLOC_FAILED   -0x5180

Failed to allocate memory.

Definition at line 37 of file md.h.

#define MBEDTLS_ERR_MD_BAD_INPUT_DATA   -0x5100

Bad input parameters to function.

Definition at line 36 of file md.h.

#define MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE   -0x5080

The selected feature is not available.

Definition at line 35 of file md.h.

#define MBEDTLS_ERR_MD_FILE_IO_ERROR   -0x5200

Opening or reading of file failed.

Definition at line 38 of file md.h.

#define MBEDTLS_MD_MAX_SIZE   32 /* longest known is SHA256 or less */

Definition at line 60 of file md.h.

Typedef Documentation

Opaque struct defined in md_internal.h.

Definition at line 66 of file md.h.

Enumeration Type Documentation

Enumerator
MBEDTLS_MD_NONE 
MBEDTLS_MD_MD2 
MBEDTLS_MD_MD4 
MBEDTLS_MD_MD5 
MBEDTLS_MD_SHA1 
MBEDTLS_MD_SHA224 
MBEDTLS_MD_SHA256 
MBEDTLS_MD_SHA384 
MBEDTLS_MD_SHA512 
MBEDTLS_MD_RIPEMD160 

Definition at line 44 of file md.h.

Function Documentation

int mbedtls_md ( const mbedtls_md_info_t md_info,
const unsigned char *  input,
size_t  ilen,
unsigned char *  output 
)

Output = message_digest( input buffer )

Parameters
md_infomessage digest info
inputbuffer holding the data
ilenlength of the input data
outputGeneric message digest checksum result
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_clone ( mbedtls_md_context_t dst,
const mbedtls_md_context_t src 
)

Clone the state of an MD context.

Note
The two contexts must have been setup to the same type (cloning from SHA-256 to SHA-512 make no sense).
Warning
Only clones the MD state, not the HMAC state! (for now)
Parameters
dstThe destination context
srcThe context to be cloned
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter failure.
int mbedtls_md_finish ( mbedtls_md_context_t ctx,
unsigned char *  output 
)

Generic message digest final digest Called after mbedtls_md_update().

Usually followed by mbedtls_md_free() or mbedtls_md_starts().

Parameters
ctxGeneric message digest context
outputGeneric message digest checksum result
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
void mbedtls_md_free ( mbedtls_md_context_t ctx)

Free and clear the internal structures of ctx.

Can be called at any time after mbedtls_md_init(). Mandatory once mbedtls_md_setup() has been called.

const char* mbedtls_md_get_name ( const mbedtls_md_info_t md_info)

Returns the name of the message digest output.

Parameters
md_infomessage digest info
Returns
name of the message digest output.
unsigned char mbedtls_md_get_size ( const mbedtls_md_info_t md_info)

Returns the size of the message digest output.

Parameters
md_infomessage digest info
Returns
size of the message digest output in bytes.
mbedtls_md_type_t mbedtls_md_get_type ( const mbedtls_md_info_t md_info)

Returns the type of the message digest output.

Parameters
md_infomessage digest info
Returns
type of the message digest output.
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 
)

Output = Generic_HMAC( hmac key, input buffer )

Parameters
md_infomessage digest info
keyHMAC secret key
keylenlength of the HMAC key in bytes
inputbuffer holding the data
ilenlength of the input data
outputGeneric HMAC-result
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_hmac_finish ( mbedtls_md_context_t ctx,
unsigned char *  output 
)

Output HMAC.

Called after mbedtls_md_hmac_update(). Usually followed my mbedtls_md_hmac_reset(), mbedtls_md_hmac_starts(), or mbedtls_md_free().

Parameters
ctxHMAC context
outputGeneric HMAC checksum result
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_hmac_reset ( mbedtls_md_context_t ctx)

Prepare to authenticate a new message with the same key.

Called after mbedtls_md_hmac_finish() and before mbedtls_md_hmac_update().

Parameters
ctxHMAC context to be reset
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_hmac_starts ( mbedtls_md_context_t ctx,
const unsigned char *  key,
size_t  keylen 
)

Set HMAC key and prepare to authenticate a new message.

Usually called after mbedtls_md_setup() or mbedtls_md_hmac_finish().

Parameters
ctxHMAC context
keyHMAC secret key
keylenlength of the HMAC key in bytes
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_hmac_update ( mbedtls_md_context_t ctx,
const unsigned char *  input,
size_t  ilen 
)

Generic HMAC process buffer.

Called between mbedtls_md_hmac_starts() or mbedtls_md_hmac_reset() and mbedtls_md_hmac_finish(). May be called repeatedly.

Parameters
ctxHMAC context
inputbuffer holding the data
ilenlength of the input data
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
const mbedtls_md_info_t* mbedtls_md_info_from_string ( const char *  md_name)

Returns the message digest information associated with the given digest name.

Parameters
md_nameName of the digest to search for.
Returns
The message digest information associated with md_name or NULL if not found.
const mbedtls_md_info_t* mbedtls_md_info_from_type ( mbedtls_md_type_t  md_type)

Returns the message digest information associated with the given digest type.

Parameters
md_typetype of digest to search for.
Returns
The message digest information associated with md_type or NULL if not found.
void mbedtls_md_init ( mbedtls_md_context_t ctx)

Initialize a md_context (as NONE) This should always be called first.

Prepares the context for mbedtls_md_setup() or mbedtls_md_free().

int mbedtls_md_init_ctx ( mbedtls_md_context_t ctx,
const mbedtls_md_info_t md_info 
)

Select MD to use and allocate internal structures.

Should be called after mbedtls_md_init() or mbedtls_md_free(). Makes it necessary to call mbedtls_md_free() later.

Deprecated:
Superseded by mbedtls_md_setup() in 2.0.0
Parameters
ctxContext to set up.
md_infoMessage digest to use.
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter failure, MBEDTLS_ERR_MD_ALLOC_FAILED memory allocation failure.
const int* mbedtls_md_list ( void  )

Returns the list of digests supported by the generic digest module.

Returns
a statically allocated array of digests, the last entry is 0.
int mbedtls_md_process ( mbedtls_md_context_t ctx,
const unsigned char *  data 
)
int mbedtls_md_setup ( mbedtls_md_context_t ctx,
const mbedtls_md_info_t md_info,
int  hmac 
)

Select MD to use and allocate internal structures.

Should be called after mbedtls_md_init() or mbedtls_md_free(). Makes it necessary to call mbedtls_md_free() later.

Parameters
ctxContext to set up.
md_infoMessage digest to use.
hmac0 to save some meory is HMAC will not be use, non-zero is HMAC is going to be used with this context.
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA on parameter failure, MBEDTLS_ERR_MD_ALLOC_FAILED memory allocation failure.
int mbedtls_md_starts ( mbedtls_md_context_t ctx)

Prepare the context to digest a new message.

Generally called after mbedtls_md_setup() or mbedtls_md_finish(). Followed by mbedtls_md_update().

Parameters
ctxgeneric message digest context.
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.
int mbedtls_md_update ( mbedtls_md_context_t ctx,
const unsigned char *  input,
size_t  ilen 
)

Generic message digest process buffer Called between mbedtls_md_starts() and mbedtls_md_finish().

May be called repeatedly.

Parameters
ctxGeneric message digest context
inputbuffer holding the datal
ilenlength of the input data
Returns
0 on success, MBEDTLS_ERR_MD_BAD_INPUT_DATA if parameter verification fails.