md5.h File Reference

Structures and prototypes for our local MD5 implementation. More...

#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>

Include dependency graph for md5.h:

Go to the source code of this file.

Data Structures
struct	fr_md5_funcs_t

Macros
#define	fr_md5_ctx_alloc()   fr_md5_funcs->alloc()
	Allocation function for MD5 digest context.
#define	fr_md5_ctx_copy(_dst, _src)   fr_md5_funcs->copy(_dst, _src)
	Copy the contents of a ctx.
#define	fr_md5_ctx_free(_ctx)   fr_md5_funcs->free(_ctx)
	Free function for MD5 digest ctx.
#define	fr_md5_ctx_reset(_ctx)   fr_md5_funcs->reset(_ctx)
	Reset the ctx to allow reuse.
#define	fr_md5_final(_out, _ctx)   fr_md5_funcs->final(_out, _ctx)
	Finalise the ctx, producing the digest.
#define	fr_md5_update(_ctx, _in, _inlen)   fr_md5_funcs->update(_ctx, _in, _inlen)
	Ingest plaintext into the digest.
#define	MD5_DIGEST_LENGTH   16

Typedefs
typedef fr_md5_ctx_t *(*	fr_md5_ctx_alloc_t) (void)
typedef void(*	fr_md5_ctx_copy_t) (fr_md5_ctx_t *dst, fr_md5_ctx_t const *src)
typedef void(*	fr_md5_ctx_free_t) (fr_md5_ctx_t **ctx)
typedef void(*	fr_md5_ctx_reset_t) (fr_md5_ctx_t *ctx)
typedef void	fr_md5_ctx_t
typedef void(*	fr_md5_final_t) (uint8_t out[static MD5_DIGEST_LENGTH], fr_md5_ctx_t *ctx)
typedef void(*	fr_md5_update_t) (fr_md5_ctx_t *ctx, uint8_t const *in, size_t inlen)

Functions
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)
void	fr_md5_calc (uint8_t out[static MD5_DIGEST_LENGTH], uint8_t const *in, size_t inlen)
	Perform a single digest operation on a single input buffer.
fr_md5_ctx_t *	fr_md5_ctx_alloc_from_list (void)
	Allocate an MD5 context from a free list.
void	fr_md5_ctx_free_from_list (fr_md5_ctx_t **ctx)
	Release an MD5 context back to a free list.

Variables
fr_md5_funcs_t const *	fr_md5_funcs
	Swap a single pointer, so all functions get swapped as an atomic operation.

Detailed Description

Structures and prototypes for our local MD5 implementation.

Note

license is LGPL, but largely derived from a public domain source.

Structures and declarations for md5.

Definition in file md5.h.

---

Data Structure Documentation

fr_md5_funcs_t

struct fr_md5_funcs_t

Definition at line 39 of file md5.h.

Data Fields
fr_md5_ctx_alloc_t	alloc
fr_md5_ctx_copy_t	copy
fr_md5_final_t	final
fr_md5_ctx_free_t	free
fr_md5_ctx_reset_t	reset
fr_md5_update_t	update

Macro Definition Documentation

fr_md5_ctx_alloc

#define fr_md5_ctx_alloc

(

)

fr_md5_funcs->alloc()

Allocation function for MD5 digest context.

Returns

• An MD5 ctx.
• NULL if out of memory.

Definition at line 71 of file md5.h.

fr_md5_ctx_copy

#define fr_md5_ctx_copy	(		_dst,
			_src
	)		fr_md5_funcs->copy(_dst, _src)

Copy the contents of a ctx.

Parameters

[in]	dst	Where to copy the context to.
[in]	src	Where to copy the context from.

Definition at line 63 of file md5.h.

fr_md5_ctx_free

#define fr_md5_ctx_free

(

_ctx

)

fr_md5_funcs->free(_ctx)

Free function for MD5 digest ctx.

Parameters

[in]

ctx

MD5 ctx to free. If the shared ctx is passed in then the ctx is reset but not freed.

Definition at line 78 of file md5.h.

fr_md5_ctx_reset

#define fr_md5_ctx_reset

(

_ctx

)

fr_md5_funcs->reset(_ctx)

Reset the ctx to allow reuse.

Parameters

[in]

ctx

To reuse.

Definition at line 56 of file md5.h.

fr_md5_final

#define fr_md5_final	(		_out,
			_ctx
	)		fr_md5_funcs->final(_out, _ctx)

Finalise the ctx, producing the digest.

Parameters

[out]	out	The MD5 digest.
[in]	ctx	To finalise.

Definition at line 93 of file md5.h.

fr_md5_update

#define fr_md5_update	(		_ctx,
			_in,
			_inlen
	)		fr_md5_funcs->update(_ctx, _in, _inlen)

Ingest plaintext into the digest.

Parameters

[in]	ctx	To ingest data into.
[in]	in	Data to ingest.
[in]	inlen	Length of data to ingest.

Definition at line 86 of file md5.h.

MD5_DIGEST_LENGTH

#define MD5_DIGEST_LENGTH   16

Definition at line 25 of file md5.h.

Typedef Documentation

fr_md5_ctx_alloc_t

typedef fr_md5_ctx_t *(* fr_md5_ctx_alloc_t) (void)

Definition at line 34 of file md5.h.

fr_md5_ctx_copy_t

typedef void(* fr_md5_ctx_copy_t) (fr_md5_ctx_t *dst, fr_md5_ctx_t const *src)

Definition at line 33 of file md5.h.

fr_md5_ctx_free_t

typedef void(* fr_md5_ctx_free_t) (fr_md5_ctx_t **ctx)

Definition at line 35 of file md5.h.

fr_md5_ctx_reset_t

typedef void(* fr_md5_ctx_reset_t) (fr_md5_ctx_t *ctx)

Definition at line 32 of file md5.h.

fr_md5_ctx_t

typedef void fr_md5_ctx_t

Definition at line 28 of file md5.h.

fr_md5_final_t

typedef void(* fr_md5_final_t) (uint8_t out[static MD5_DIGEST_LENGTH], fr_md5_ctx_t *ctx)

Definition at line 37 of file md5.h.

fr_md5_update_t

typedef void(* fr_md5_update_t) (fr_md5_ctx_t *ctx, uint8_t const *in, size_t inlen)

Definition at line 36 of file md5.h.

Function Documentation

fr_hmac_md5()

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
	)

fr_md5_calc()

void fr_md5_calc	(	uint8_t	out[static MD5_DIGEST_LENGTH],
		uint8_t const *	in,
		size_t	inlen
	)

Perform a single digest operation on a single input buffer.

Perform a single digest operation on a single input buffer.

Parameters

[out]	out	Where to write the MD5 digest. Must be a minimum of MD5_DIGEST_LENGTH.
[in]	in	Data to hash.
[in]	inlen	Length of the data.

Definition at line 245 of file merged_model.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_md5_ctx_alloc_from_list()

fr_md5_ctx_t * fr_md5_ctx_alloc_from_list

(

void

)

Allocate an MD5 context from a free list.

Allocate an MD5 context from a free list.

Returns

• An MD5 ctx.
• NULL if out of memory.

Definition at line 499 of file md5.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_md5_ctx_free_from_list()

void fr_md5_ctx_free_from_list

(

fr_md5_ctx_t **

ctx

)

Release an MD5 context back to a free list.

Release an MD5 context back to a free list.

Parameters

[in]

ctx

MD5 ctx to free. If the shared ctx is passed in then the ctx is reset but not freed.

Definition at line 544 of file md5.c.

Here is the caller graph for this function:

Variable Documentation

fr_md5_funcs

fr_md5_funcs_t const* fr_md5_funcs

extern

Swap a single pointer, so all functions get swapped as an atomic operation.

Definition at line 53 of file md5.c.