base32.h File Reference

#include <isc/lang.h>
#include <isc/types.h>

Go to the source code of this file.

Defines
#define	ISC_BASE32_H   1
Functions
ISC_LANG_BEGINDECLS isc_result_t	isc_base32_totext (isc_region_t *source, int wordlength, const char *wordbreak, isc_buffer_t *target)
isc_result_t	isc_base32hex_totext (isc_region_t *source, int wordlength, const char *wordbreak, isc_buffer_t *target)
isc_result_t	isc_base32hexnp_totext (isc_region_t *source, int wordlength, const char *wordbreak, isc_buffer_t *target)
	Convert data into base32 encoded text.
isc_result_t	isc_base32_decodestring (const char *cstr, isc_buffer_t *target)
isc_result_t	isc_base32hex_decodestring (const char *cstr, isc_buffer_t *target)
isc_result_t	isc_base32hexnp_decodestring (const char *cstr, isc_buffer_t *target)
	Decode a null-terminated string in base32, base32hex, or base32hex non-padded.
isc_result_t	isc_base32_tobuffer (isc_lex_t *lexer, isc_buffer_t *target, int length)
isc_result_t	isc_base32hex_tobuffer (isc_lex_t *lexer, isc_buffer_t *target, int length)
isc_result_t	isc_base32hexnp_tobuffer (isc_lex_t *lexer, isc_buffer_t *target, int length)
	Convert text encoded in base32, base32hex, or base32hex non-padded from a lexer context into data.
isc_result_t	isc_base32_decoderegion (isc_region_t *source, isc_buffer_t *target)
isc_result_t	isc_base32hex_decoderegion (isc_region_t *source, isc_buffer_t *target)
isc_result_t	isc_base32hexnp_decoderegion (isc_region_t *source, isc_buffer_t *target)
	Decode a packed (no white space permitted) region in base32, base32hex or base32hex non-padded.

---

Detailed Description

Definition in file base32.h.

---

Define Documentation

#define ISC_BASE32_H   1

Definition at line 18 of file base32.h.

---

Function Documentation

ISC_LANG_BEGINDECLS isc_result_t isc_base32_totext	(	isc_region_t *	source,
		int	wordlength,
		const char *	wordbreak,
		isc_buffer_t *	target
	)

Definition at line 121 of file base32.c.

References base32, and base32_totext().

isc_result_t isc_base32hex_totext	(	isc_region_t *	source,
		int	wordlength,
		const char *	wordbreak,
		isc_buffer_t *	target
	)

Definition at line 129 of file base32.c.

References base32_totext(), and base32hex.

Referenced by checknext().

isc_result_t isc_base32hexnp_totext	(	isc_region_t *	source,
		int	wordlength,
		const char *	wordbreak,
		isc_buffer_t *	target
	)

Convert data into base32 encoded text.

Notes:

• The base32 encoded text in 'target' will be divided into words of at most 'wordlength' characters, separated by the 'wordbreak' string. No parentheses will surround the text.

Requires:

• 'source' is a region containing binary data
• 'target' is a text buffer containing available space
• 'wordbreak' points to a null-terminated string of zero or more whitespace characters

Ensures:

• target will contain the base32 encoded version of the data in source. The 'used' pointer in target will be advanced as necessary.

Definition at line 137 of file base32.c.

References base32_totext(), and base32hex.

Referenced by dns_nsec3_hashname(), and totext_nsec3().

isc_result_t isc_base32_decodestring	(	const char *	cstr,
		isc_buffer_t *	target
	)

Definition at line 352 of file base32.c.

References base32, base32_decodestring(), and ISC_TRUE.

isc_result_t isc_base32hex_decodestring	(	const char *	cstr,
		isc_buffer_t *	target
	)

Definition at line 357 of file base32.c.

References base32_decodestring(), base32hex, and ISC_TRUE.

isc_result_t isc_base32hexnp_decodestring	(	const char *	cstr,
		isc_buffer_t *	target
	)

Decode a null-terminated string in base32, base32hex, or base32hex non-padded.

Requires:

• 'cstr' is non-null.
• 'target' is a valid buffer.

Returns:

• ISC_R_SUCCESS -- the entire decoded representation of 'cstring' fit in 'target'.
• ISC_R_BADBASE32 -- 'cstr' is not a valid base32 encoding.

Other error returns are any possible error code from:

• isc_lex_create(),
• isc_lex_openbuffer(),
• isc_base32_tobuffer().

Definition at line 362 of file base32.c.

References base32_decodestring(), base32hex, and ISC_FALSE.

Referenced by fromtext_nsec3().

isc_result_t isc_base32_tobuffer	(	isc_lex_t *	lexer,
		isc_buffer_t *	target,
		int	length
	)

Definition at line 318 of file base32.c.

References base32, base32_tobuffer(), and ISC_TRUE.

isc_result_t isc_base32hex_tobuffer	(	isc_lex_t *	lexer,
		isc_buffer_t *	target,
		int	length
	)

Definition at line 323 of file base32.c.

References base32_tobuffer(), base32hex, and ISC_TRUE.

isc_result_t isc_base32hexnp_tobuffer	(	isc_lex_t *	lexer,
		isc_buffer_t *	target,
		int	length
	)

Convert text encoded in base32, base32hex, or base32hex non-padded from a lexer context into data.

Requires:

• 'lex' is a valid lexer context
• 'target' is a buffer containing binary data
• 'length' is an integer

Ensures:

• target will contain the data represented by the base32 encoded string parsed by the lexer. No more than length bytes will be read, if length is positive. The 'used' pointer in target will be advanced as necessary.

Definition at line 328 of file base32.c.

References base32_tobuffer(), base32hex, and ISC_FALSE.

isc_result_t isc_base32_decoderegion	(	isc_region_t *	source,
		isc_buffer_t *	target
	)

Definition at line 383 of file base32.c.

References base32, base32_decoderegion(), and ISC_TRUE.

isc_result_t isc_base32hex_decoderegion	(	isc_region_t *	source,
		isc_buffer_t *	target
	)

Definition at line 388 of file base32.c.

References base32_decoderegion(), base32hex, and ISC_TRUE.

Referenced by dns_nsec3_noexistnodata(), nsec3clean(), and record_found().

isc_result_t isc_base32hexnp_decoderegion	(	isc_region_t *	source,
		isc_buffer_t *	target
	)

Decode a packed (no white space permitted) region in base32, base32hex or base32hex non-padded.

Requires:

• 'source' is a valid region.
• 'target' is a valid buffer.

Returns:

• ISC_R_SUCCESS -- the entire decoded representation of 'cstring' fit in 'target'.
• ISC_R_BADBASE32 -- 'source' is not a valid base32 encoding.

Definition at line 393 of file base32.c.

References base32_decoderegion(), base32hex, and ISC_FALSE.

Referenced by checkowner_nsec3(), and isdelegation().

---