base16.h File Reference

Base16 encoding. More...

#include <stdint.h>
#include <string.h>

Go to the source code of this file.

Macros
#define	HEX_DECODE_OPTIONAL   0x80
	Treat separator as optional while decoding. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static size_t	base16_encoded_len (size_t raw_len)
	Calculate length of base16-encoded data. More...
static size_t	base16_decoded_max_len (const char *encoded)
	Calculate maximum length of base16-decoded string. More...
size_t	hex_encode (char separator, const void *raw, size_t raw_len, char *data, size_t len)
	Encode hexadecimal string (with optional byte separator character) More...
int	hex_decode (char separator, const char *encoded, void *data, size_t len)
	Decode hexadecimal string (with optional byte separator character) More...
static	__attribute__ ((always_inline)) size_t base16_encode(const void *raw
	Base16-encode data. More...

Variables
static size_t	raw_len
static size_t char *	data
static size_t char size_t	len

Detailed Description

Base16 encoding.

Definition in file base16.h.

Macro Definition Documentation

HEX_DECODE_OPTIONAL

#define HEX_DECODE_OPTIONAL   0x80

Treat separator as optional while decoding.

Definition at line 17 of file base16.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

base16_encoded_len()

static size_t base16_encoded_len ( size_t  raw_len )

inlinestatic

Calculate length of base16-encoded data.

Parameters

raw_len

Raw data length

Return values

encoded_len

Encoded string length (excluding NUL)

Definition at line 25 of file base16.h.

                                                           {
        return ( 2 * raw_len );
}

References raw_len.

Referenced by base16_encode_okx(), certstat(), ecm_fetch_mac(), http_digest_authenticate(), iscsi_build_login_request_strings(), peerdisc_open(), and peerdist_info_hash_ntoa().

base16_decoded_max_len()

static size_t base16_decoded_max_len ( const char *  encoded )

inlinestatic

Calculate maximum length of base16-decoded string.

Parameters

encoded	Encoded string
max_raw_len	Maximum length of raw data

Definition at line 35 of file base16.h.

                                                                    {
        return ( ( strlen ( encoded ) + 1 ) / 2 );
}

References strlen().

Referenced by base16_decode_okx().

hex_encode()

size_t hex_encode	(	char	separator,
		const void *	raw,
		size_t	raw_len,
		char *	data,
		size_t	len
	)

Encode hexadecimal string (with optional byte separator character)

Parameters

separator	Byte separator character, or 0 for no separator
raw	Raw data
raw_len	Length of raw data
data	Buffer
len	Length of buffer

Return values

len	Encoded length

Definition at line 51 of file base16.c.

                                             {
        const uint8_t *bytes = raw;
        const char delimiter[2] = { separator, '\0' };
        size_t used = 0;
        unsigned int i;

        if ( len )
                data[0] = 0; /* Ensure that a terminating NUL exists */
        for ( i = 0 ; i < raw_len ; i++ ) {
                used += ssnprintf ( ( data + used ), ( len - used ),
                                    "%s%02x", ( used ? delimiter : "" ),
                                    bytes[i] );
        }
        return used;
}

References bytes, data, len, raw, raw_len, and ssnprintf().

Referenced by format_hex_colon_setting(), format_hex_hyphen_setting(), and format_hex_raw_setting().

hex_decode()

int hex_decode	(	char	separator,
		const char *	encoded,
		void *	data,
		size_t	len
	)

Decode hexadecimal string (with optional byte separator character)

Parameters

separator	Byte separator character, or 0 for no separator
encoded	Encoded string
data	Buffer
len	Length of buffer

Return values

len	Length of data, or negative error

Definition at line 77 of file base16.c.

                                                                               {
        uint8_t *out = data;
        unsigned int count = 0;
        unsigned int sixteens;
        unsigned int units;
        int optional;

        /* Strip out optionality flag from separator character */
        optional = ( separator & HEX_DECODE_OPTIONAL );
        separator &= ~HEX_DECODE_OPTIONAL;

        /* Decode string */
        while ( *encoded ) {

                /* Check separator, if applicable */
                if ( count && separator ) {
                        if ( *encoded == separator ) {
                                encoded++;
                        } else if ( ! optional ) {
                                return -EINVAL;
                        }
                }

                /* Extract digits.  Note that either digit may be NUL,
                 * which would be interpreted as an invalid value by
                 * digit_value(); there is therefore no need for an
                 * explicit end-of-string check.
                 */
                sixteens = digit_value ( *(encoded++) );
                if ( sixteens >= 16 )
                        return -EINVAL;
                units = digit_value ( *(encoded++) );
                if ( units >= 16 )
                        return -EINVAL;

                /* Store result */
                if ( count < len )
                        out[count] = ( ( sixteens << 4 ) | units );
                count++;

        }
        return count;
}

References count, data, digit_value(), EINVAL, HEX_DECODE_OPTIONAL, len, and out.

Referenced by netfront_read_mac(), parse_hex_hyphen_setting(), parse_hex_raw_setting(), parse_hex_setting(), and uuid_aton().

__attribute__()

static __attribute__ ( (always_inline)  ) const

inlinestatic

Base16-encode data.

Base16-decode data.

Parameters

raw	Raw data
raw_len	Length of raw data
data	Buffer
len	Length of buffer

Return values

len	Encoded length

Parameters

encoded	Encoded string
data	Buffer
len	Length of buffer

Return values

len	Length of data, or negative error

Variable Documentation

raw_len

size_t raw_len

Definition at line 54 of file base16.h.

Referenced by base16_encoded_len(), base64_encode(), base64_encoded_len(), fetchf_setting(), fetchn_setting(), format_base64_setting(), format_busdevfn_setting(), format_dnssl_setting(), format_hex_colon_setting(), format_hex_hyphen_setting(), format_hex_raw_setting(), format_int_setting(), format_ipv4_setting(), format_ipv6_setting(), format_string_setting(), format_uint_setting(), format_uristring_setting(), format_uuid_setting(), hex_encode(), numerate_int_setting(), parse_string_setting(), parse_uri(), pxebs_list(), setting_format(), setting_numerate(), storef_setting(), storen_setting(), and uri_encode().

data

void* data

Definition at line 54 of file base16.h.

len

void size_t len

Initial value:

{
        return hex_encode ( 0, raw, raw_len, data, len )

Definition at line 54 of file base16.h.