Documentation

Documentation

Includes

config.h

#include "config.h"
#include "config.h"

MBEDTLS_CONFIG_FILE

#include MBEDTLS_CONFIG_FILE
#include MBEDTLS_CONFIG_FILE

stddef.h

#include <stddef.h>
#include 

stdint.h

#include <stdint.h>
#include 

md5_alt.h

#include "md5_alt.h"
#include "md5_alt.h"

Macros

Marco MBEDTLS_MD5_H

#define MBEDTLS_MD5_H


      

Marco MBEDTLS_ERR_MD5_HW_ACCEL_FAILED

#define MBEDTLS_ERR_MD5_HW_ACCEL_FAILED                  -47 /**< MD5 hardware accelerator failed */
/* MBEDTLS_ERR_MD5_HW_ACCEL_FAILED is deprecated and should not be used. */

Marco MBEDTLS_DEPRECATED

#define MBEDTLS_DEPRECATED     __attribute__((deprecated))


      

Marco MBEDTLS_DEPRECATED

#define MBEDTLS_DEPRECATED


      

Marco MBEDTLS_DEPRECATED

#define MBEDTLS_DEPRECATED     __attribute__((deprecated))


      

Marco MBEDTLS_DEPRECATED

#define MBEDTLS_DEPRECATED

      

Functions

Func mbedtls_md5_init

void mbedtls_md5_init( mbedtls_md5_context *ctx );
/**
 * \brief          Initialize MD5 context
 *
 * \param ctx      MD5 context to be initialized
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Func mbedtls_md5_free

void mbedtls_md5_free( mbedtls_md5_context *ctx );
/**
 * \brief          Clear MD5 context
 *
 * \param ctx      MD5 context to be cleared
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Func mbedtls_md5_clone

void mbedtls_md5_clone( mbedtls_md5_context *dst,
                       const mbedtls_md5_context *src );
/**
 * \brief          Clone (the state of) an MD5 context
 *
 * \param dst      The destination context
 * \param src      The context to be cloned
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Func mbedtls_md5_starts_ret

int mbedtls_md5_starts_ret( mbedtls_md5_context *ctx );
/**
 * \brief          MD5 context setup
 *
 * \param ctx      context to be initialized
 *
 * \return         0 if successful
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Func mbedtls_md5_update_ret

int mbedtls_md5_update_ret( mbedtls_md5_context *ctx,
                           const unsigned char *input,
                           size_t ilen );
/**
 * \brief          MD5 process buffer
 *
 * \param ctx      MD5 context
 * \param input    buffer holding the data
 * \param ilen     length of the input data
 *
 * \return         0 if successful
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Func mbedtls_md5_finish_ret

int mbedtls_md5_finish_ret( mbedtls_md5_context *ctx,
                           unsigned char output[16] );
/**
 * \brief          MD5 final digest
 *
 * \param ctx      MD5 context
 * \param output   MD5 checksum result
 *
 * \return         0 if successful
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Func mbedtls_internal_md5_process

int mbedtls_internal_md5_process( mbedtls_md5_context *ctx,
                                 const unsigned char data[64] );
/**
 * \brief          MD5 process data block (internal use only)
 *
 * \param ctx      MD5 context
 * \param data     buffer holding one block of data
 *
 * \return         0 if successful
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Func mbedtls_md5_ret

int mbedtls_md5_ret( const unsigned char *input,
                    size_t ilen,
                    unsigned char output[16] );
/**
 * \brief          Output = MD5( input buffer )
 *
 * \param input    buffer holding the data
 * \param ilen     length of the input data
 * \param output   MD5 checksum result
 *
 * \return         0 if successful
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Func mbedtls_md5_self_test

int mbedtls_md5_self_test( int verbose );
/**
 * \brief          Checkup routine
 *
 * \return         0 if successful, or 1 if the test failed
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Vars

Variable MBEDTLS_DEPRECATED

MBEDTLS_DEPRECATED void mbedtls_md5_starts( mbedtls_md5_context *ctx );
/**
 * \brief          MD5 context setup
 *
 * \deprecated     Superseded by mbedtls_md5_starts_ret() in 2.7.0
 *
 * \param ctx      context to be initialized
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Variable MBEDTLS_DEPRECATED

MBEDTLS_DEPRECATED void mbedtls_md5_update( mbedtls_md5_context *ctx,
                                           const unsigned char *input,
                                           size_t ilen );
/**
 * \brief          MD5 process buffer
 *
 * \deprecated     Superseded by mbedtls_md5_update_ret() in 2.7.0
 *
 * \param ctx      MD5 context
 * \param input    buffer holding the data
 * \param ilen     length of the input data
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Variable MBEDTLS_DEPRECATED

MBEDTLS_DEPRECATED void mbedtls_md5_finish( mbedtls_md5_context *ctx,
                                           unsigned char output[16] );
/**
 * \brief          MD5 final digest
 *
 * \deprecated     Superseded by mbedtls_md5_finish_ret() in 2.7.0
 *
 * \param ctx      MD5 context
 * \param output   MD5 checksum result
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Variable MBEDTLS_DEPRECATED

MBEDTLS_DEPRECATED void mbedtls_md5_process( mbedtls_md5_context *ctx,
                                            const unsigned char data[64] );
/**
 * \brief          MD5 process data block (internal use only)
 *
 * \deprecated     Superseded by mbedtls_internal_md5_process() in 2.7.0
 *
 * \param ctx      MD5 context
 * \param data     buffer holding one block of data
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Variable MBEDTLS_DEPRECATED

MBEDTLS_DEPRECATED void mbedtls_md5( const unsigned char *input,
                                    size_t ilen,
                                    unsigned char output[16] );
/**
 * \brief          Output = MD5( input buffer )
 *
 * \deprecated     Superseded by mbedtls_md5_ret() in 2.7.0
 *
 * \param input    buffer holding the data
 * \param ilen     length of the input data
 * \param output   MD5 checksum result
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */

Consts

Types

Typedefs

Typedef mbedtls_md5_context;

typedef struct mbedtls_md5_context
{
   uint32_t total[2];         /*!< number of bytes processed  */
   uint32_t state[4];         /*!< intermediate digest state  */
   unsigned char buffer[64];  /*!< data block being processed */
}
mbedtls_md5_context;
/**
 * \brief          MD5 context structure
 *
 * \warning        MD5 is considered a weak message digest and its use
 *                 constitutes a security risk. We recommend considering
 *                 stronger message digests instead.
 *
 */