base16.c File Reference

#include <freeradius-devel/util/base16.h>

Include dependency graph for base16.c:

Go to the source code of this file.

Macros
#define	us(x)   (uint8_t) x
	Encode/decode binary data using printable characters (base16 format - hex)

Functions
fr_slen_t	fr_base16_decode_nstd (fr_sbuff_parse_error_t *err, fr_dbuff_t *out, fr_sbuff_t *in, bool no_trailing, uint8_t const alphabet[static SBUFF_CHAR_CLASS])
	Decode base16 encoded input.
fr_slen_t	fr_base16_encode_nstd (fr_sbuff_t *out, fr_dbuff_t *in, char const alphabet[static SBUFF_CHAR_CLASS])
	Convert binary data to a hex string.

Variables
uint8_t const	fr_base16_alphabet_decode_mc [SBUFF_CHAR_CLASS]
	Mixed case decode alphabet for base16.
char const	fr_base16_alphabet_encode_lc [SBUFF_CHAR_CLASS]
	lower case encode alphabet for base16
char const	fr_base16_alphabet_encode_uc [SBUFF_CHAR_CLASS]
	lower case encode alphabet for base16

Macro Definition Documentation

us

#define us

(

x

)

(uint8_t) x

Encode/decode binary data using printable characters (base16 format - hex)

See also

RFC 4648 http://www.ietf.org/rfc/rfc4648.txt.

Copyright

2021 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

Definition at line 26 of file base16.c.

Function Documentation

fr_base16_decode_nstd()

fr_slen_t fr_base16_decode_nstd	(	fr_sbuff_parse_error_t *	err,
		fr_dbuff_t *	out,
		fr_sbuff_t *	in,
		bool	no_trailing,
		uint8_t const	alphabet[static SBUFF_CHAR_CLASS]
	)

Decode base16 encoded input.

Parameters

[out]	err	If non-null contains any parse errors.
[out]	out	Where to write the decoded binary data.
[in]	in	String to decode.
[in]	no_trailing	Error out if we find non-base16 characters at the end of the string.
[in]	alphabet	to use for decoding.

Returns

• < 0 on failure. The offset where the decoding error occurred as a negative integer.
• Length of decoded data.

Definition at line 144 of file base16.c.

Here is the call graph for this function:

fr_base16_encode_nstd()

fr_slen_t fr_base16_encode_nstd	(	fr_sbuff_t *	out,
		fr_dbuff_t *	in,
		char const	alphabet[static SBUFF_CHAR_CLASS]
	)

Convert binary data to a hex string.

Ascii encoded hex string will not be prefixed with '0x'

Parameters

[out]	out	Output buffer to write to.
[in]	in	input.
[in]	alphabet	to use for encode.

Returns

• >=0 the number of bytes written to out.
• <0 number of bytes we would have needed to print the next hexit.

Definition at line 115 of file base16.c.

Variable Documentation

fr_base16_alphabet_decode_mc

uint8_t const fr_base16_alphabet_decode_mc[SBUFF_CHAR_CLASS]

Initial value:

= {
        F32(0, UINT8_MAX), F16(32, UINT8_MAX),
        ['0'] = 0,
        ['1'] = 1,
        ['2'] = 2,
        ['3'] = 3,
        ['4'] = 4,
        ['5'] = 5,
        ['6'] = 6,
        ['7'] = 7,
        ['8'] = 8,
        ['9'] = 9,
        F4(58, UINT8_MAX), F2(62, UINT8_MAX), F1(64, UINT8_MAX),
        ['A'] = 10,     
        ['B'] = 11,
        ['C'] = 12,
        ['D'] = 13,
        ['E'] = 14,
        ['F'] = 15,
        F16(71, UINT8_MAX), F8(87, UINT8_MAX), F2(95, UINT8_MAX),
        ['a'] = 10,     
        ['b'] = 11,
        ['c'] = 12,
        ['d'] = 13,
        ['e'] = 14,
        ['f'] = 15,
        F128(103, UINT8_MAX), F16(231, UINT8_MAX), F8(247, UINT8_MAX), F1(255, UINT8_MAX)
}

Mixed case decode alphabet for base16.

Definition at line 75 of file base16.c.

fr_base16_alphabet_encode_lc

char const fr_base16_alphabet_encode_lc[SBUFF_CHAR_CLASS]

Initial value:

= {
        [0] = '0',
        [1] = '1',
        [2] = '2',
        [3] = '3',
        [4] = '4',
        [5] = '5',
        [6] = '6',
        [7] = '7',
        [8] = '8',
        [9] = '9',
        [10] = 'a',
        [11] = 'b',
        [12] = 'c',
        [13] = 'd',
        [14] = 'e',
        [15] = 'f'
}

lower case encode alphabet for base16

Encode/decode binary data using printable characters (base16 format - hex)

Definition at line 31 of file base16.c.

fr_base16_alphabet_encode_uc

char const fr_base16_alphabet_encode_uc[SBUFF_CHAR_CLASS]

Initial value:

= {
        [0] = '0',
        [1] = '1',
        [2] = '2',
        [3] = '3',
        [4] = '4',
        [5] = '5',
        [6] = '6',
        [7] = '7',
        [8] = '8',
        [9] = '9',
        [10] = 'A',
        [11] = 'B',
        [12] = 'C',
        [13] = 'D',
        [14] = 'E',
        [15] = 'F'
}

lower case encode alphabet for base16

Definition at line 53 of file base16.c.