encode.c File Reference

Functions to encode DER. More...

#include <freeradius-devel/util/dbuff.h>
#include <freeradius-devel/util/encode.h>
#include <freeradius-devel/util/proto.h>
#include <freeradius-devel/util/sbuff.h>
#include <freeradius-devel/util/struct.h>
#include <freeradius-devel/util/time.h>
#include <freeradius-devel/util/dict_ext.h>
#include <freeradius-devel/io/test_point.h>
#include "der.h"

Include dependency graph for encode.c:

Go to the source code of this file.

Data Structures
struct	fr_der_encode_ctx_t
struct	fr_der_encode_set_of_ptr_pairs_t
struct	fr_der_tag_encode_t

Macros
#define	fr_der_encode_enumerated   fr_der_encode_integer

Typedefs
typedef ssize_t(*	fr_der_encode_t) (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, fr_der_encode_ctx_t *encode_ctx)
	Function signature for DER encode functions.

Functions
static ssize_t	encode_pair (fr_dbuff_t *dbuff, UNUSED fr_da_stack_t *da_stack, UNUSED unsigned int depth, fr_dcursor_t *cursor, void *encode_ctx)
static int	encode_test_ctx (void **out, TALLOC_CTX *ctx, UNUSED fr_dict_t const *dict)
static ssize_t	encode_value (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, void *encode_ctx)
	Encode a DER structure.
static ssize_t	fr_der_encode_bitstring (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_boolean (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_choice (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, fr_der_encode_ctx_t *encode_ctx)
	Encode a CHOICE type.
static ssize_t	fr_der_encode_combo_ip (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_generalized_time (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_integer (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_ipv4_addr (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_ipv4_prefix (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_ipv6_addr (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_ipv6_prefix (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_len (fr_dbuff_t *dbuff, fr_dbuff_marker_t *length_start)
	Encode the length field of a DER structure.
static ssize_t	fr_der_encode_null (UNUSED fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_octetstring (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_oid (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_oid_and_value (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_oid_from_value (fr_dbuff_t *dbuff, uint64_t value, uint64_t *component, int *count)
static ssize_t	fr_der_encode_proto (UNUSED TALLOC_CTX *ctx, fr_pair_list_t *vps, uint8_t *data, size_t data_len, void *encode_ctx)
static ssize_t	fr_der_encode_sequence (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_set (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, fr_der_encode_ctx_t *encode_ctx)
static int	fr_der_encode_set_of_cmp (void const *one, void const *two)
static ssize_t	fr_der_encode_string (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_tag (fr_dbuff_t *dbuff, fr_der_tag_t tag_num, fr_der_tag_class_t tag_class, fr_der_tag_constructed_t constructed)
	Encode a DER tag.
static ssize_t	fr_der_encode_utc_time (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, UNUSED fr_der_encode_ctx_t *encode_ctx)
static ssize_t	fr_der_encode_X509_extensions (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, fr_der_encode_ctx_t *encode_ctx)
static int8_t	fr_der_pair_cmp_by_da_tag (void const *a, void const *b)
	Compare two pairs by their tag number.

Variables
fr_test_point_pair_encode_t	der_tp_encode_pair
fr_test_point_proto_encode_t	der_tp_encode_proto
static const fr_der_tag_encode_t	tag_funcs [FR_DER_TAG_MAX]
static const fr_der_tag_encode_t	type_funcs [FR_TYPE_MAX]

Detailed Description

Functions to encode DER.

Id

ef6f1ce808f5aebecdac92a8c814f067e8865a39

Copyright

2025 Network RADIUS SAS (legal.nosp@m.@net.nosp@m.workr.nosp@m.adiu.nosp@m.s.com)

Definition in file encode.c.

---

Data Structure Documentation

fr_der_encode_ctx_t

struct fr_der_encode_ctx_t

Definition at line 39 of file encode.c.

Data Fields
uint8_t *	tmp_ctx	Temporary context for encoding.

fr_der_encode_set_of_ptr_pairs_t

struct fr_der_encode_set_of_ptr_pairs_t

Definition at line 749 of file encode.c.

Data Fields
uint8_t *	data	Pointer to the start of the encoded item (beginning of the tag)
size_t	len	Length of the encoded item (tag + length + value)

fr_der_tag_encode_t

struct fr_der_tag_encode_t

Definition at line 55 of file encode.c.

Collaboration diagram for fr_der_tag_encode_t:

Data Fields
fr_der_tag_constructed_t	constructed
fr_der_encode_t	encode

Macro Definition Documentation

fr_der_encode_enumerated

#define fr_der_encode_enumerated   fr_der_encode_integer

Definition at line 69 of file encode.c.

Typedef Documentation

fr_der_encode_t

typedef ssize_t(* fr_der_encode_t) (fr_dbuff_t *dbuff, fr_dcursor_t *cursor, fr_der_encode_ctx_t *encode_ctx)

Function signature for DER encode functions.

Parameters

[in]	dbuff	Where to encode the data.
[in]	cursor	Where to encode the data from.
[in]	encode_ctx	Any encode specific data.

Returns

• > 0 on success. How many bytes were encoded.
• 0 no bytes encoded.
• < 0 on error. May be the offset (as a negative value) where the error occurred.

Definition at line 53 of file encode.c.

Function Documentation

encode_pair()

static ssize_t encode_pair ( fr_dbuff_t *  dbuff, UNUSED fr_da_stack_t *  da_stack, UNUSED unsigned int  depth, fr_dcursor_t *  cursor, void *  encode_ctx  )

static

Definition at line 92 of file encode.c.

Here is the call graph for this function:

encode_test_ctx()

static int encode_test_ctx ( void **  out, TALLOC_CTX *  ctx, UNUSED fr_dict_t const *  dict  )

static

Definition at line 1802 of file encode.c.

encode_value()

static ssize_t encode_value ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, void *  encode_ctx  )

static

Encode a DER structure.

Parameters

[out]	dbuff	The buffer to write the structure to
[in]	cursor	The cursor to the structure to encode
[in]	encode_ctx	The encoding context

Returns

The number of bytes written to the buffer

Definition at line 1619 of file encode.c.

Here is the call graph for this function:

fr_der_encode_bitstring()

static ssize_t fr_der_encode_bitstring ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 217 of file encode.c.

Here is the call graph for this function:

fr_der_encode_boolean()

static ssize_t fr_der_encode_boolean ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 98 of file encode.c.

Here is the call graph for this function:

fr_der_encode_choice()

static ssize_t fr_der_encode_choice ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, fr_der_encode_ctx_t *  encode_ctx  )

static

Encode a CHOICE type.

Parameters

[in]	dbuff	Buffer to write the encoded data to
[in]	cursor	Cursor to the pair to encode
[in]	encode_ctx	Encoding context

Returns

Number of bytes written to the buffer, or -1 on error

Definition at line 1095 of file encode.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_der_encode_combo_ip()

static ssize_t fr_der_encode_combo_ip ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 497 of file encode.c.

Here is the call graph for this function:

fr_der_encode_generalized_time()

static ssize_t fr_der_encode_generalized_time ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 983 of file encode.c.

Here is the call graph for this function:

fr_der_encode_integer()

static ssize_t fr_der_encode_integer ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 128 of file encode.c.

Here is the call graph for this function:

fr_der_encode_ipv4_addr()

static ssize_t fr_der_encode_ipv4_addr ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 350 of file encode.c.

Here is the call graph for this function:

fr_der_encode_ipv4_prefix()

static ssize_t fr_der_encode_ipv4_prefix ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 382 of file encode.c.

Here is the call graph for this function:

fr_der_encode_ipv6_addr()

static ssize_t fr_der_encode_ipv6_addr ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 425 of file encode.c.

Here is the call graph for this function:

fr_der_encode_ipv6_prefix()

static ssize_t fr_der_encode_ipv6_prefix ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 457 of file encode.c.

Here is the call graph for this function:

fr_der_encode_len()

static ssize_t fr_der_encode_len ( fr_dbuff_t *  dbuff, fr_dbuff_marker_t *  length_start  )

static

Encode the length field of a DER structure.

The input dbuff is composed of the following data:

1 byte of nothing (length_start).  Where the "length length" will be written to.
N bytes of data.  dbuff is pointing to the end of the encoded data.

We have to either write a length to length_start (if it's < 0x7f),

OR we figure out how many bytes we need to encode the length, shift the data to the right to make room, and then encode the length.

Parameters

dbuff	The buffer to update with the length field
length_start	The start of the length field

Returns

• <0 for "cannot extend the input buffer by the needed "length length". - 1 for "success". Note that 'length_start' WILL be updated after this call, and the caller should just release it immediately.

Definition at line 1518 of file encode.c.

Here is the caller graph for this function:

fr_der_encode_null()

static ssize_t fr_der_encode_null ( UNUSED fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 567 of file encode.c.

Here is the call graph for this function:

fr_der_encode_octetstring()

static ssize_t fr_der_encode_octetstring ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 527 of file encode.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_der_encode_oid()

static ssize_t fr_der_encode_oid ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 650 of file encode.c.

Here is the call graph for this function:

fr_der_encode_oid_and_value()

static ssize_t fr_der_encode_oid_and_value ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 1340 of file encode.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_der_encode_oid_from_value()

static ssize_t fr_der_encode_oid_from_value ( fr_dbuff_t *  dbuff, uint64_t  value, uint64_t *  component, int *  count  )

static

Definition at line 591 of file encode.c.

Here is the caller graph for this function:

fr_der_encode_proto()

static ssize_t fr_der_encode_proto ( UNUSED TALLOC_CTX *  ctx, fr_pair_list_t *  vps, uint8_t *  data, size_t  data_len, void *  encode_ctx  )

static

Definition at line 1778 of file encode.c.

Here is the call graph for this function:

fr_der_encode_sequence()

static ssize_t fr_der_encode_sequence ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 716 of file encode.c.

Here is the call graph for this function:

fr_der_encode_set()

static ssize_t fr_der_encode_set ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 769 of file encode.c.

Here is the call graph for this function:

fr_der_encode_set_of_cmp()

static int fr_der_encode_set_of_cmp ( void const *  one, void const *  two  )

static

Definition at line 757 of file encode.c.

Here is the caller graph for this function:

fr_der_encode_string()

static ssize_t fr_der_encode_string ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 1433 of file encode.c.

Here is the call graph for this function:

fr_der_encode_tag()

static ssize_t fr_der_encode_tag ( fr_dbuff_t *  dbuff, fr_der_tag_t  tag_num, fr_der_tag_class_t  tag_class, fr_der_tag_constructed_t  constructed  )

inlinestatic

Encode a DER tag.

Parameters

dbuff	The buffer to write the tag to
tag_num	The tag number
tag_class	The tag class
constructed	Whether the tag is constructed

Returns

The number of bytes written to the buffer

Definition at line 1597 of file encode.c.

Here is the caller graph for this function:

fr_der_encode_utc_time()

static ssize_t fr_der_encode_utc_time ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, UNUSED fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 899 of file encode.c.

Here is the call graph for this function:

fr_der_encode_X509_extensions()

static ssize_t fr_der_encode_X509_extensions ( fr_dbuff_t *  dbuff, fr_dcursor_t *  cursor, fr_der_encode_ctx_t *  encode_ctx  )

static

Definition at line 1119 of file encode.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fr_der_pair_cmp_by_da_tag()

static int8_t fr_der_pair_cmp_by_da_tag ( void const *  a, void const *  b  )

inlinestatic

Compare two pairs by their tag number.

Parameters

[in]	a	First pair.
[in]	b	Second pair.

Returns

-1 if a < b, 0 if a == b, 1 if a > b.

Definition at line 84 of file encode.c.

Here is the caller graph for this function:

Variable Documentation

der_tp_encode_pair

fr_test_point_pair_encode_t der_tp_encode_pair

Initial value:

= {
               .test_ctx = encode_test_ctx,
               .func     = encode_value,
}

Definition at line 1817 of file encode.c.

der_tp_encode_proto

fr_test_point_proto_encode_t der_tp_encode_proto

Initial value:

= {
               .test_ctx = encode_test_ctx,
               .func     = fr_der_encode_proto,
}

Definition at line 1823 of file encode.c.

tag_funcs

const fr_der_tag_encode_t tag_funcs[FR_DER_TAG_MAX]

static

Initial value:

= {
        [FR_DER_TAG_BOOLEAN]          = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_boolean },
        [FR_DER_TAG_INTEGER]          = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_integer },
        [FR_DER_TAG_BITSTRING]        = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_bitstring },
        [FR_DER_TAG_OCTETSTRING]      = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_octetstring },
        [FR_DER_TAG_NULL]             = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_null },
        [FR_DER_TAG_OID]              = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_oid },
        [FR_DER_TAG_ENUMERATED]       = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_enumerated },
        [FR_DER_TAG_UTF8_STRING]      = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_string },
        [FR_DER_TAG_SEQUENCE]         = { .constructed = FR_DER_TAG_CONSTRUCTED, .encode = fr_der_encode_sequence },
        [FR_DER_TAG_SET]              = { .constructed = FR_DER_TAG_CONSTRUCTED, .encode = fr_der_encode_set },
        [FR_DER_TAG_PRINTABLE_STRING] = { .constructed = FR_DER_TAG_PRIMITIVE,
                                          .encode      = fr_der_encode_string },
        [FR_DER_TAG_T61_STRING]       = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_string },
        [FR_DER_TAG_IA5_STRING]       = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_string },
        [FR_DER_TAG_UTC_TIME]         = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_utc_time },
        [FR_DER_TAG_GENERALIZED_TIME] = { .constructed = FR_DER_TAG_PRIMITIVE,
                                          .encode      = fr_der_encode_generalized_time },
        [FR_DER_TAG_VISIBLE_STRING]   = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_string },
        [FR_DER_TAG_GENERAL_STRING]   = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_string },
        [FR_DER_TAG_UNIVERSAL_STRING] = { .constructed = FR_DER_TAG_PRIMITIVE,
                                          .encode      = fr_der_encode_string },
}

Definition at line 1464 of file encode.c.

type_funcs

const fr_der_tag_encode_t type_funcs[FR_TYPE_MAX]

static

Initial value:

= {
        [FR_TYPE_IPV4_ADDR]       = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_ipv4_addr },
        [FR_TYPE_IPV4_PREFIX]     = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_ipv4_prefix },
        [FR_TYPE_IPV6_ADDR]       = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_ipv6_addr },
        [FR_TYPE_IPV6_PREFIX]     = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_ipv6_prefix },
 
        [FR_TYPE_COMBO_IP_ADDR]   = { .constructed = FR_DER_TAG_PRIMITIVE, .encode = fr_der_encode_combo_ip },
}

Definition at line 1488 of file encode.c.