md5.h

Go to the documentation of this file.

#pragma once
/** Structures and prototypes for our local MD5 implementation
 *
 * @note license is LGPL, but largely derived from a public domain source.
 *
 * @file src/lib/util/md5.h
 * @brief Structures and declarations for md5.
 */
RCSIDH(md5_h, "$Id: 9337b7afabfe542007d5b7ad40ae21cb8dbc7342 $")
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <freeradius-devel/build.h>
#include <freeradius-devel/missing.h>
 
#include <inttypes.h>
#include <sys/types.h>
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
 
#ifndef MD5_DIGEST_LENGTH
#  define MD5_DIGEST_LENGTH 16
#endif
 
typedef void fr_md5_ctx_t;
 
/* md5.c */
 
typedef         void (*fr_md5_ctx_reset_t)(fr_md5_ctx_t *ctx);
typedef         void (*fr_md5_ctx_copy_t)(fr_md5_ctx_t *dst, fr_md5_ctx_t const *src);
typedef         fr_md5_ctx_t *(*fr_md5_ctx_alloc_t)(void);
typedef         void (*fr_md5_ctx_free_t)(fr_md5_ctx_t **ctx);
typedef         void (*fr_md5_update_t)(fr_md5_ctx_t *ctx, uint8_t const *in, size_t inlen);
typedef         void (*fr_md5_final_t)(uint8_t out[static MD5_DIGEST_LENGTH], fr_md5_ctx_t *ctx);
 
typedef struct {
        fr_md5_ctx_reset_t      reset;
        fr_md5_ctx_copy_t       copy;
        fr_md5_ctx_alloc_t      alloc;
        fr_md5_ctx_free_t       free;
        fr_md5_update_t         update;
        fr_md5_final_t          final;
} fr_md5_funcs_t;
 
/** Swap a single pointer, so all functions get swapped as an atomic operation
 */
extern fr_md5_funcs_t const *fr_md5_funcs;
 
/** Reset the ctx to allow reuse
 *
 * @param[in] ctx       To reuse.
 */
#define fr_md5_ctx_reset(_ctx)                  fr_md5_funcs->reset(_ctx)
 
/** Copy the contents of a ctx
 *
 * @param[in] dst       Where to copy the context to.
 * @param[in] src       Where to copy the context from.
 */
#define fr_md5_ctx_copy(_dst, _src)             fr_md5_funcs->copy(_dst, _src)
 
/** Allocation function for MD5 digest context
 *
 * @return
 *      - An MD5 ctx.
 *      - NULL if out of memory.
 */
#define fr_md5_ctx_alloc()                      fr_md5_funcs->alloc()
 
/** Free function for MD5 digest ctx
 *
 * @param[in] ctx       MD5 ctx to free.  If the shared ctx is passed in
 *                      then the ctx is reset but not freed.
 */
#define fr_md5_ctx_free(_ctx)                   fr_md5_funcs->free(_ctx)
 
/** Ingest plaintext into the digest
 *
 * @param[in] ctx       To ingest data into.
 * @param[in] in        Data to ingest.
 * @param[in] inlen     Length of data to ingest.
 */
#define fr_md5_update(_ctx, _in, _inlen)        fr_md5_funcs->update(_ctx, _in, _inlen)
 
/** Finalise the ctx, producing the digest
 *
 * @param[out] out      The MD5 digest.
 * @param[in] ctx       To finalise.
 */
#define fr_md5_final(_out, _ctx)                fr_md5_funcs->final(_out, _ctx)
 
/** Perform a single digest operation on a single input buffer
 *
 */
void            fr_md5_calc(uint8_t out[static MD5_DIGEST_LENGTH], uint8_t const *in, size_t inlen);
 
/** Allocate an MD5 context from a free list
 *
 */
fr_md5_ctx_t    *fr_md5_ctx_alloc_from_list(void);
 
/** Release an MD5 context back to a free list
 *
 */
void            fr_md5_ctx_free_from_list(fr_md5_ctx_t **ctx);
 
/* hmac.c */
int             fr_hmac_md5(uint8_t digest[static MD5_DIGEST_LENGTH], uint8_t const *in, size_t inlen,
                            uint8_t const *key, size_t key_len);
#ifdef __cplusplus
}
#endif