Macros
#define	APR_ENCODE_STRING (-1)

#define	APR_ENCODE_NONE 0

#define	APR_ENCODE_RELAXED 1

#define	APR_ENCODE_NOPADDING 2

#define	APR_ENCODE_URL 4

#define	APR_ENCODE_BASE64URL (APR_ENCODE_NOPADDING \| APR_ENCODE_URL)

#define	APR_ENCODE_BASE32HEX 8

#define	APR_ENCODE_COLON 16

#define	APR_ENCODE_LOWER 32

Functions
apr_status_t	apr_encode_base64 (char dest, const char src, apr_ssize_t slen, int flags, apr_size_t *len)

apr_status_t	apr_encode_base64_binary (char dest, const unsigned char src, apr_ssize_t slen, int flags, apr_size_t *len)

const char *	apr_pencode_base64 (apr_pool_t p, const char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

const char *	apr_pencode_base64_binary (apr_pool_t p, const unsigned char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

apr_status_t	apr_decode_base64 (char dest, const char src, apr_ssize_t slen, int flags, apr_size_t *len)

apr_status_t	apr_decode_base64_binary (unsigned char dest, const char src, apr_ssize_t slen, int flags, apr_size_t *len)

const char *	apr_pdecode_base64 (apr_pool_t p, const char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

const unsigned char *	apr_pdecode_base64_binary (apr_pool_t p, const char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

apr_status_t	apr_encode_base32 (char dest, const char src, apr_ssize_t slen, int flags, apr_size_t *len)

apr_status_t	apr_encode_base32_binary (char dest, const unsigned char src, apr_ssize_t slen, int flags, apr_size_t *len)

const char *	apr_pencode_base32 (apr_pool_t p, const char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

const char *	apr_pencode_base32_binary (apr_pool_t p, const unsigned char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

apr_status_t	apr_decode_base32 (char dest, const char src, apr_ssize_t slen, int flags, apr_size_t *len)

apr_status_t	apr_decode_base32_binary (unsigned char dest, const char src, apr_ssize_t slen, int flags, apr_size_t *len)

const char *	apr_pdecode_base32 (apr_pool_t p, const char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

const unsigned char *	apr_pdecode_base32_binary (apr_pool_t p, const char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

apr_status_t	apr_encode_base16 (char dest, const char src, apr_ssize_t slen, int flags, apr_size_t *len)

apr_status_t	apr_encode_base16_binary (char dest, const unsigned char src, apr_ssize_t slen, int flags, apr_size_t *len)

const char *	apr_pencode_base16 (apr_pool_t p, const char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

const char *	apr_pencode_base16_binary (apr_pool_t p, const unsigned char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

apr_status_t	apr_decode_base16 (char dest, const char src, apr_ssize_t slen, int flags, apr_size_t *len)

apr_status_t	apr_decode_base16_binary (unsigned char dest, const char src, apr_ssize_t slen, int flags, apr_size_t *len)

const char *	apr_pdecode_base16 (apr_pool_t p, const char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

const unsigned char *	apr_pdecode_base16_binary (apr_pool_t p, const char src, apr_ssize_t slen, int flags, apr_size_t *len) __attribute__((nonnull(1)))

Detailed Description

Macro Definition Documentation

◆ APR_ENCODE_BASE32HEX

#define APR_ENCODE_BASE32HEX 8

Generate base32hex encoding instead of base32 encoding

◆ APR_ENCODE_BASE64URL

#define APR_ENCODE_BASE64URL (APR_ENCODE_NOPADDING | APR_ENCODE_URL)

Generate RFC7515 BASE64URL

◆ APR_ENCODE_COLON

#define APR_ENCODE_COLON 16

Generate base16 with colons between each token.

◆ APR_ENCODE_LOWER

#define APR_ENCODE_LOWER 32

Generate base16 with lower case characters.

◆ APR_ENCODE_NONE

#define APR_ENCODE_NONE 0

Generate RFC4648 base16/base32/base64.

◆ APR_ENCODE_NOPADDING

#define APR_ENCODE_NOPADDING 2

Omit the padding character (=) while encoding.

◆ APR_ENCODE_RELAXED

#define APR_ENCODE_RELAXED 1

If relaxed, decode up until the first non base16/base32/base64 character.

◆ APR_ENCODE_STRING

#define APR_ENCODE_STRING (-1)

RFC4648 and RFC7515 compliant BASE64, BASE64URL, BASE32, BASE32HEX and BASE16 encode/decode functions.

The following encodings are supported:

Base 64 Encoding

o Use flag APR_ENCODE_NONE o https://tools.ietf.org/html/rfc4648#section-4
Base 64 Encoding with URL and Filename Safe Alphabet

o Use flag APR_ENCODE_URL o https://tools.ietf.org/html/rfc4648#section-5
Base 64 URL Encoding without Padding

o Use flag APR_ENCODE_BASE64URL o https://tools.ietf.org/html/rfc7515#appendix-C
Base 32 Encoding

o Use flag APR_ENCODE_NONE o https://tools.ietf.org/html/rfc4648#section-6
Base 32 Encoding with Extended Hex Alphabet

o Use flag APR_ENCODE_BASE32HEX o https://tools.ietf.org/html/rfc4648#section-7
Base 16 Encoding

o Use flags APR_ENCODE_NONE/APR_ENCODE_COLON o https://tools.ietf.org/html/rfc4648#section-8

If a non valid character of any kind including whitespace is passed to any of the decoder functions, APR_BADCH will be returned. In this case decoding will still take place, but the results can not be trusted.

If APR_ENCODE_RELAXED is passed to the decoder functions, decoding will be attempted up until the first non valid character. If this results in an invalid state in the decoder, such as but not limited to an odd number of base16 characters, APR_BADCH will still be returned.

If APR_ENCODE_RELAXED is not passed to a decoder function, the decoding will be done in constant time regardless of whether the result returns APR_SUCCESS or APR_BADCH.

If the dest parameter is NULL, the maximum theoretical buffer size is returned in the len field, including space for a terminating zero character if the destination is a string. This value can be used to allocate buffers of a suitable safe size.

If the dest parameter is provided, the encoding or decoding will take place, and the actual number of characters written is returned in the len field, ignoring any terminating zero.

Plain strings are not assumed '\0' terminated unless APR_ENCODE_STRING is provided. When passing a string to one of the encode functions, this value can be passed to indicate a string-valued key, and have the length computed automatically.

◆ APR_ENCODE_URL

#define APR_ENCODE_URL 4

Generate RFC4648 Base 64 Encoding with URL and Filename Safe Alphabet

Function Documentation

◆ apr_decode_base16()

apr_status_t apr_decode_base16	(	char *	dest,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base16 (hex) to text data.

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for decoding.
src	The base16 string, can be NULL if `dest` is NULL and `slen` is positive or nul.
slen	The length of the base16 string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, parse RFC4648 Base 16 Encoding. If APR_ENCODE_COLON, allow tokens to be separated with a colon.
len	If not NULL, outputs the length of the buffer needed for decoding (including the trailing NUL) if `dest` is NULL, or the actual length of the decoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is not APR_ENCODE_STRING and negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to decode, or APR_EINCOMPLETE if the source length (based on slen or APR_ENCODE_STRING) is invalid for a base16 encoding, or APR_BADCH if a non base16 character is present and APR_ENCODE_RELAXED is not specified.

◆ apr_decode_base16_binary()

apr_status_t apr_decode_base16_binary	(	unsigned char *	dest,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base16 (hex) to binary data.

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for decoding.
src	The base16 string, can be NULL if `dest` is NULL and `slen` is positive or nul.
slen	The length of the base16 string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, parse RFC4648 Base 16 Encoding. If APR_ENCODE_COLON, allow tokens to be separated with a colon.
len	If not NULL, outputs the length of the buffer needed for decoding (including the trailing NUL) if `dest` is NULL, or the actual length of the decoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is not APR_ENCODE_STRING and negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to decode, or APR_EINCOMPLETE if the source length (based on slen or APR_ENCODE_STRING) is invalid for a base16 encoding, or APR_BADCH if a non base16 character is present and APR_ENCODE_RELAXED is not specified.

◆ apr_decode_base32()

apr_status_t apr_decode_base32	(	char *	dest,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base32 or base32hex with or without padding to text data.

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for decoding.
src	The base32 string, can be NULL if `dest` is NULL and `slen` is positive or nul.
slen	The length of the base32 string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, parse RFC4648 Base 32 Encoding. If APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
len	If not NULL, outputs the length of the buffer needed for decoding (including the trailing NUL) if `dest` is NULL, or the actual length of the decoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is not APR_ENCODE_STRING and negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to decode, or APR_EINCOMPLETE if the source length (based on slen or APR_ENCODE_STRING) is invalid for a base32 encoding, or APR_BADCH if a non base32 character is present and APR_ENCODE_RELAXED is not specified.

◆ apr_decode_base32_binary()

apr_status_t apr_decode_base32_binary	(	unsigned char *	dest,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base32 or base32hex with or without padding to binary data.

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for decoding.
src	The base32 string, can be NULL if `dest` is NULL and `slen` is positive or nul.
slen	The length of the base32 string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, parse RFC4648 Base 32 Encoding. If APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
len	If not NULL, outputs the length of the buffer needed for decoding (including the trailing NUL) if `dest` is NULL, or the actual length of the decoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is not APR_ENCODE_STRING and negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to decode, or APR_EINCOMPLETE if the source length (based on slen or APR_ENCODE_STRING) is invalid for a base32 encoding, or APR_BADCH if a non base32 character is present and APR_ENCODE_RELAXED is not specified.

◆ apr_decode_base64()

apr_status_t apr_decode_base64	(	char *	dest,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base64 or base64url with or without padding to text data.

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for decoding.
src	The base64 string, can be NULL if `dest` is NULL and `slen` is positive or nul.
slen	The length of the base64 string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, attempt to decode the full base64 string, and return NULL if any bad character is detected. If APR_ENCODE_RELAXED, decode until the first non base64/base64url character.
len	If not NULL, outputs the length of the buffer needed for decoding (including the trailing NUL) if `dest` is NULL, or the actual length of the decoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is not APR_ENCODE_STRING and negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to decode, or APR_EINCOMPLETE if the source length (based on slen or APR_ENCODE_STRING) is invalid for a base64 encoding, or APR_BADCH if a non base64 character is present and APR_ENCODE_RELAXED is not specified.

◆ apr_decode_base64_binary()

apr_status_t apr_decode_base64_binary	(	unsigned char *	dest,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base64 or base64url with or without padding to binary data.

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for decoding.
src	The base64 string, can be NULL if `dest` is NULL and `slen` is positive or nul.
slen	The length of the base64 string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, attempt to decode the full base64 string, and return NULL if any bad character is detected. If APR_ENCODE_RELAXED, decode until the first non base64/base64url character.
len	If not NULL, outputs the length of the buffer needed for decoding (including the trailing NUL) if `dest` is NULL, or the actual length of the decoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is not APR_ENCODE_STRING and negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to decode, or APR_EINCOMPLETE if the source length (based on slen or APR_ENCODE_STRING) is invalid for a base64 encoding, or APR_BADCH if a non base64 character is present and APR_ENCODE_RELAXED is not specified.

◆ apr_encode_base16()

apr_status_t apr_encode_base16	(	char *	dest,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert text data to base16 (hex).

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for encoding.
src	The original string, can be NULL if `dest` is NULL and `slen` is positive or nul.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 16 Encoding. If APR_ENCODE_COLON, separate each token with a colon.
len	If not NULL, outputs the length of the buffer needed for encoding (including the trailing NUL) if `dest` is NULL, or the actual length of the encoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is not APR_ENCODE_STRING and negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to encode.

◆ apr_encode_base16_binary()

apr_status_t apr_encode_base16_binary	(	char *	dest,
		const unsigned char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert binary data to base16 (hex).

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for encoding.
src	The original buffer, can be NULL if `dest` is NULL.
slen	The length of the original buffer.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 16 Encoding. If APR_ENCODE_COLON, separate each token with a colon.
len	If not NULL, outputs the length of the buffer needed for encoding (including the trailing NUL) if `dest` is NULL, or the actual length of the encoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to encode.

◆ apr_encode_base32()

apr_status_t apr_encode_base32	(	char *	dest,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert text data to base32.

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for encoding.
src	The original string, can be NULL if `dest` is NULL and `slen` is positive or nul.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 32 Encoding. If APR_ENCODE_NOPADDING, omit the = padding character. If APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
len	If not NULL, outputs the length of the buffer needed for encoding (including the trailing NUL) if `dest` is NULL, or the actual length of the encoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is not APR_ENCODE_STRING and negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to encode.

◆ apr_encode_base32_binary()

apr_status_t apr_encode_base32_binary	(	char *	dest,
		const unsigned char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert binary data to base32.

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for encoding.
src	The original buffer, can be NULL if `dest` is NULL.
slen	The length of the original buffer.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 32 Encoding. If APR_ENCODE_NOPADDING, omit the = padding character. If APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
len	If not NULL, outputs the length of the buffer needed for encoding (including the trailing NUL) if `dest` is NULL, or the actual length of the encoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to encode.

◆ apr_encode_base64()

apr_status_t apr_encode_base64	(	char *	dest,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert text data to base64.

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for encoding.
src	The original string, can be NULL if `dest` is NULL and `slen` is positive or nul.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 64 Encoding. If APR_ENCODE_NOPADDING, omit the = padding character. If APR_ENCODE_URL, use RFC4648 Base 64 Encoding with URL and Filename Safe Alphabet. If APR_ENCODE_BASE64URL, use RFC7515 base64url Encoding.
len	If not NULL, outputs the length of the buffer needed for encoding (including the trailing NUL) if `dest` is NULL, or the actual length of the encoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is not APR_ENCODE_STRING and negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to encode.

◆ apr_encode_base64_binary()

apr_status_t apr_encode_base64_binary	(	char *	dest,
		const unsigned char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert binary data to base64.

Parameters

dest	The destination string, can be NULL to output in `len` the needed buffer length for encoding.
src	The original buffer, can be NULL if `dest` is NULL.
slen	The length of the original buffer.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 64 Encoding. If APR_ENCODE_NOPADDING, omit the = padding character. If APR_ENCODE_URL, use RFC4648 Base 64 Encoding with URL and Filename Safe Alphabet. If APR_ENCODE_BASE64URL, use RFC7515 base64url Encoding.
len	If not NULL, outputs the length of the buffer needed for encoding (including the trailing NUL) if `dest` is NULL, or the actual length of the encoding (excluding the trailing NUL) if `dest` is not NULL.

Returns: APR_SUCCESS, or APR_EINVAL if slen is negative, or APR_NOTFOUND if dest is not NULL and src is NULL, or APR_ENOSPC if dest is NULL and the source length (based on slen or APR_ENCODE_STRING) is too big to encode.

◆ apr_pdecode_base16()

const char* apr_pdecode_base16	(	apr_pool_t *	p,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base16 (hex) and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The base16 string to decode.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, parse RFC4648 Base 16 Encoding. If APR_ENCODE_COLON, allow tokens to be separated with a colon.
len	If not NULL, outputs the length of the encoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the decoding is not possible (see apr_decode_base16 errors).

◆ apr_pdecode_base16_binary()

const unsigned char* apr_pdecode_base16_binary	(	apr_pool_t *	p,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base16 (hex) to binary data, and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The base16 string to decode.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, parse RFC4648 Base 16 Encoding. If APR_ENCODE_COLON, allow tokens to be separated with a colon.
len	If not NULL, outputs the length of the encoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the decoding is not possible (see apr_decode_base16_binary errors).

◆ apr_pdecode_base32()

const char* apr_pdecode_base32	(	apr_pool_t *	p,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base32 or base32hex with or without padding to text data, and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The base32 string to decode.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, parse RFC4648 Base 32 Encoding. If APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
len	If not NULL, outputs the length of the encoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the decoding is not possible (see apr_decode_base32 errors).

◆ apr_pdecode_base32_binary()

const unsigned char* apr_pdecode_base32_binary	(	apr_pool_t *	p,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base32 or base32hex with or without padding to binary data, and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The base32 string to decode.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, parse RFC4648 Base 32 Encoding. If APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
len	If not NULL, outputs the length of the encoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the decoding is not possible (see apr_decode_base32_binary errors).

◆ apr_pdecode_base64()

const char* apr_pdecode_base64	(	apr_pool_t *	p,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base64 or base64url with or without padding to text data, and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The base64 string to decode.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, attempt to decode the full original buffer, and return NULL if any bad character is detected. If APR_ENCODE_RELAXED, decode until the first non base64/base64url character.
len	If not NULL, outputs the length of the decoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the decoding is not possible (see apr_decode_base64_binary errors).

◆ apr_pdecode_base64_binary()

const unsigned char* apr_pdecode_base64_binary	(	apr_pool_t *	p,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert base64 or base64url with or without padding to binary data, and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The base64 string to decode.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, attempt to decode the full original buffer, and return NULL if any bad character is detected. If APR_ENCODE_RELAXED, decode until the first non base64/base64url character.
len	If not NULL, outputs the length of the decoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the decoding is not possible (see apr_decode_base64_binary errors).

◆ apr_pencode_base16()

const char* apr_pencode_base16	(	apr_pool_t *	p,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert text data to base16 (hex), and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The original string.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 16 Encoding. If APR_ENCODE_COLON, separate each token with a colon.
len	If not NULL, outputs the length of the encoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the encoding is not possible (see apr_encode_base16 errors).

◆ apr_pencode_base16_binary()

const char* apr_pencode_base16_binary	(	apr_pool_t *	p,
		const unsigned char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert binary data to base16 (hex), and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The original buffer.
slen	The length of the original buffer.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 16 Encoding. If APR_ENCODE_COLON, separate each token with a colon.
len	If not NULL, outputs the length of the encoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the encoding is not possible (see apr_encode_base16_binary errors).

◆ apr_pencode_base32()

const char* apr_pencode_base32	(	apr_pool_t *	p,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert text data to base32, and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The original string.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 32 Encoding. If APR_ENCODE_NOPADDING, omit the = padding character. If APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
len	If not NULL, outputs the length of the encoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the encoding is not possible (see apr_encode_base32 errors).

◆ apr_pencode_base32_binary()

const char* apr_pencode_base32_binary	(	apr_pool_t *	p,
		const unsigned char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert binary data to base32, and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The original buffer.
slen	The length of the original buffer.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 32 Encoding. If APR_ENCODE_NOPADDING, omit the = padding character. If APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
len	If not NULL, outputs the length of the encoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the encoding is not possible (see apr_encode_base32_binary errors).

◆ apr_pencode_base64()

const char* apr_pencode_base64	(	apr_pool_t *	p,
		const char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert text data to base64, and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The original string.
slen	The length of the original string, or APR_ENCODE_STRING if the actual length should be computed based on NUL termination.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 64 Encoding. If APR_ENCODE_NOPADDING, omit the = padding character. If APR_ENCODE_URL, use RFC4648 Base 64 Encoding with URL and Filename Safe Alphabet. If APR_ENCODE_BASE64URL, use RFC7515 base64url Encoding.
len	If not NULL, outputs the length of the encoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the encoding is not possible (see apr_encode_base64 errors).

◆ apr_pencode_base64_binary()

const char* apr_pencode_base64_binary	(	apr_pool_t *	p,
		const unsigned char *	src,
		apr_ssize_t	slen,
		int	flags,
		apr_size_t *	len
	)

Convert binary data to base64, and return the results from a pool.

Parameters

p	Pool to allocate from.
src	The original buffer.
slen	The length of the original buffer.
flags	If APR_ENCODE_NONE, emit RFC4648 Base 64 Encoding. If APR_ENCODE_NOPADDING, omit the = padding character. If APR_ENCODE_URL, use RFC4648 Base 64 Encoding with URL and Filename Safe Alphabet. If APR_ENCODE_BASE64URL, use RFC7515 base64url Encoding.
len	If not NULL, outputs the length of the encoding (excluding the trailing NUL).

Returns: A NUL terminated string allocated from the pool on success, or NULL if src is NULL or allocation failed or the encoding is not possible (see apr_encode_base64_binary errors).

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ APR_ENCODE_BASE32HEX

◆ APR_ENCODE_BASE64URL

◆ APR_ENCODE_COLON

◆ APR_ENCODE_LOWER

◆ APR_ENCODE_NONE

◆ APR_ENCODE_NOPADDING

◆ APR_ENCODE_RELAXED

◆ APR_ENCODE_STRING

◆ APR_ENCODE_URL

Function Documentation

◆ apr_decode_base16()

◆ apr_decode_base16_binary()

◆ apr_decode_base32()

◆ apr_decode_base32_binary()

◆ apr_decode_base64()

◆ apr_decode_base64_binary()

◆ apr_encode_base16()

◆ apr_encode_base16_binary()

◆ apr_encode_base32()

◆ apr_encode_base32_binary()

◆ apr_encode_base64()

◆ apr_encode_base64_binary()

◆ apr_pdecode_base16()

◆ apr_pdecode_base16_binary()

◆ apr_pdecode_base32()

◆ apr_pdecode_base32_binary()

◆ apr_pdecode_base64()

◆ apr_pdecode_base64_binary()

◆ apr_pencode_base16()

◆ apr_pencode_base16_binary()

◆ apr_pencode_base32()

◆ apr_pencode_base32_binary()

◆ apr_pencode_base64()

◆ apr_pencode_base64_binary()