[base16] Add buffer size parameter to base16_encode() and base16_decode()

The current API for Base16 (and Base64) encoding requires the caller
to always provide sufficient buffer space.  This prevents the use of
the generic encoding/decoding functionality in some situations, such
as in formatting the hex setting types.

Implement a generic hex_encode() (based on the existing
format_hex_setting()), implement base16_encode() and base16_decode()
in terms of the more generic hex_encode() and hex_decode(), and update
all callers to provide the additional buffer length parameter.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
This commit is contained in:
Michael Brown
2015-04-24 14:34:32 +01:00
parent b56b482fa3
commit 9aa8090d06
12 changed files with 111 additions and 126 deletions

View File

@@ -77,30 +77,42 @@ BASE16 ( random_test,
* Report a base16 encoding test result
*
* @v test Base16 test
* @v file Test code file
* @v line Test code line
*/
#define base16_encode_ok( test ) do { \
size_t len = base16_encoded_len ( (test)->len ); \
char buf[ len + 1 /* NUL */ ]; \
ok ( len == strlen ( (test)->encoded ) ); \
base16_encode ( (test)->data, (test)->len, buf ); \
ok ( strcmp ( (test)->encoded, buf ) == 0 ); \
} while ( 0 )
static void base16_encode_okx ( struct base16_test *test, const char *file,
unsigned int line ) {
size_t len = base16_encoded_len ( test->len );
char buf[ len + 1 /* NUL */ ];
size_t check_len;
okx ( len == strlen ( test->encoded ), file, line );
check_len = base16_encode ( test->data, test->len, buf, sizeof ( buf ));
okx ( check_len == len, file, line );
okx ( strcmp ( test->encoded, buf ) == 0, file, line );
}
#define base16_encode_ok( test ) base16_encode_okx ( test, __FILE__, __LINE__ )
/**
* Report a base16 decoding test result
*
* @v test Base16 test
* @v file Test code file
* @v line Test code line
*/
#define base16_decode_ok( test ) do { \
size_t max_len = base16_decoded_max_len ( (test)->encoded ); \
uint8_t buf[max_len]; \
int len; \
len = base16_decode ( (test)->encoded, buf ); \
ok ( len >= 0 ); \
ok ( ( size_t ) len <= max_len ); \
ok ( ( size_t ) len == (test)->len ); \
ok ( memcmp ( (test)->data, buf, len ) == 0 ); \
} while ( 0 )
static void base16_decode_okx ( struct base16_test *test, const char *file,
unsigned int line ) {
size_t max_len = base16_decoded_max_len ( test->encoded );
uint8_t buf[max_len];
int len;
len = base16_decode ( test->encoded, buf, sizeof ( buf ) );
okx ( len >= 0, file, line );
okx ( ( size_t ) len <= max_len, file, line );
okx ( ( size_t ) len == test->len, file, line );
okx ( memcmp ( test->data, buf, len ) == 0, file, line );
}
#define base16_decode_ok( test ) base16_decode_okx ( test, __FILE__, __LINE__ )
/**
* Perform Base16 self-tests