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_DECLARE (apr_status_t) apr_encode_base64(char *dest

	APR_DECLARE (const char ) apr_pencode_base64(apr_pool_t p

const char apr_ssize_t int apr_size_t *len	__attribute__ ((nonnull(1)))

	APR_DECLARE (const unsigned char ) apr_pdecode_base64_binary(apr_pool_t p

Variables
const char *	src

const char apr_ssize_t	slen

const char apr_ssize_t int	flags

const char apr_ssize_t int apr_size_t *	len

Detailed Description

Macro Definition Documentation

◆ APR_ENCODE_BASE32HEX

#define APR_ENCODE_BASE32HEX 8

Generate base32hex encoding instead of base32 encoding

Definition at line 135 of file apr_encode.h.

◆ APR_ENCODE_BASE64URL

#define APR_ENCODE_BASE64URL (APR_ENCODE_NOPADDING | APR_ENCODE_URL)

Generate RFC7515 BASE64URL

Definition at line 130 of file apr_encode.h.

◆ APR_ENCODE_COLON

#define APR_ENCODE_COLON 16

Generate base16 with colons between each token.

Definition at line 140 of file apr_encode.h.

◆ APR_ENCODE_LOWER

#define APR_ENCODE_LOWER 32

Generate base16 with lower case characters.

Definition at line 145 of file apr_encode.h.

◆ APR_ENCODE_NONE

#define APR_ENCODE_NONE 0

Generate RFC4648 base16/base32/base64.

Definition at line 110 of file apr_encode.h.

◆ APR_ENCODE_NOPADDING

#define APR_ENCODE_NOPADDING 2

Omit the padding character (=) while encoding.

Definition at line 120 of file apr_encode.h.

◆ APR_ENCODE_RELAXED

#define APR_ENCODE_RELAXED 1

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

Definition at line 115 of file apr_encode.h.

◆ 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.

Definition at line 105 of file apr_encode.h.

◆ APR_ENCODE_URL

#define APR_ENCODE_URL 4

Generate RFC4648 Base 64 Encoding with URL and Filename Safe Alphabet

Definition at line 125 of file apr_encode.h.

Function Documentation

◆ attribute()

const char apr_ssize_t int apr_size_t *len __attribute__ ( (nonnull(1)) )

◆ APR_DECLARE() [1/3]

APR_DECLARE ( apr_status_t )

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

< File is read-only

< File is executable

< all protections

< File is read-only

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< File is executable

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Stat the link not the file itself if it is a link

< ->name in proper case

< Access Time

< Create the file if not there

< Open the file for reading

< Open the file for writing

< Delete the file after close

< Open should fail if APR_FOPEN_CREATE and file exists.

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Read by user

<

Deprecated:

See also: APR_FPROT_UREAD

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< ->name in proper case

< Modification Time

< Access Time

< Creation or inode-changed time

< Type

< Size of the file

< Storage size consumed by the file

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< ->name in proper case

< Type

< all protections

< ->name in proper case

< File is read-only

< File is hidden

< File is read-only

< File is hidden

< Platform dependent flag to enable * non blocking file io

< Open the file for reading

< Open the file for writing

< Open the file for reading

< Open the file for writing

< Open the file for buffered I/O

< Create the file if not there

< Open should fail if APR_FOPEN_CREATE and file exists.

< Open the file and truncate to 0 length

< Open should fail if APR_FOPEN_CREATE and file exists.

< Create the file if not there

< Open the file and truncate to 0 length

< Append to the end of the file

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Delete the file after close

< Open the file for buffered I/O

< Open the file for writing

< Open the file for reading

< Append to the end of the file

< an atomic unix apr_stat()

< Open the file for writing

< Create the file if not there

< Open the file and truncate to 0 length

< Open the file for writing

< Create the file if not there

< Append to the end of the file

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< File is read-only

< File is executable

< all protections

< File is read-only

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< File is executable

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Access Time

< Stat the link not the file itself if it is a link

< Create the file if not there

< Open the file for reading

< Open the file for writing

< Open should fail if APR_FOPEN_CREATE and file exists.

< Delete the file after close

< Open the file for reading

< Open the file for writing

< Open the file for reading

< Open the file for writing

< Create the file if not there

< Open should fail if APR_FOPEN_CREATE and file exists.

< Create the file if not there

< Append to the end of the file

< Open the file and truncate to 0 length

< Platform dependent flag to enable * non blocking file io

< use OS's default permissions

<

Deprecated:

See also: APR_FPROT_OS_DEFAULT

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Open the file for buffered I/O

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Open the file for buffered I/O

< Open the file for writing

< Open the file for reading

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

The problem with trying to output the entire iovec is that we cannot maintain the behaviour that a real writev would have. If we iterate over the iovec one at a time, we lose the atomic properties of writev(). The other option is to combine the entire iovec into one buffer that we could then send in one call to write(). This is not reasonable since we do not know how much data an iovec could contain.

The only reasonable option, that maintains the semantics of a real writev(), is to only write the first iovec. Callers of file_writev() must deal with partial writes as they normally would. If you want to ensure an entire iovec is written, use apr_file_writev_full().

< ->name in proper case

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Size of the file

< dev and inode

< Number of links

< ->name in proper case

< Type

< ->name in proper case

< File is read-only

< File is hidden

< File is read-only

< File is hidden

< Open the file for reading

< use OS's default permissions

<

Deprecated:

See also: APR_FPROT_OS_DEFAULT

< Platform dependent flag to enable * non blocking file io

< Open the file for reading

< Open the file for writing

< Create the file if not there

< Open should fail if APR_FOPEN_CREATE and file exists.

< Open the file and truncate to 0 length

< Open should fail if APR_FOPEN_CREATE and file exists.

< Create the file if not there

< Delete the file after close

< Open the file for reading

< Open the file for writing

< Platform dependent tag to open the file for use across multiple threads

< Append to the end of the file

< Open the file for buffered I/O

< Platform dependent flag to enable * sparse file support, see WARNING below

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Append to the end of the file

< Open the file for buffered I/O

< Open the file for writing

< Open the file for reading

< Platform dependent tag to open the file for use across multiple threads

< Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".

< Platform dependent tag to open the file for use across multiple threads

< Size of the file

< Platform dependent tag to open the file for use across multiple threads

< Size of the file

Definition at line 74 of file apr_atomic.c.

◆ APR_DECLARE() [2/3]

APR_DECLARE ( const char * )

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).

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).

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).

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).

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).

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).

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).

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).

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).

Definition at line 140 of file dso.c.

◆ APR_DECLARE() [3/3]

APR_DECLARE ( const unsigned char * )

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).

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).

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).

Variable Documentation

◆ flags

const char apr_ssize_t int flags

Definition at line 168 of file apr_encode.h.

◆ len

const char apr_ssize_t int apr_size_t * len

Definition at line 168 of file apr_encode.h.

◆ slen

const char apr_ssize_t slen

Definition at line 168 of file apr_encode.h.

◆ src

const void * src

Definition at line 167 of file apr_encode.h.

Macros

Functions

Variables

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

◆ __attribute__()

◆ APR_DECLARE() [1/3]

◆ APR_DECLARE() [2/3]

◆ APR_DECLARE() [3/3]

Variable Documentation

◆ flags

◆ len

◆ slen

◆ src

◆ attribute()