Gecko [ edgpens.lpkmn.gov.my ]

Name	Size	Permission
ap_compat.h	1.08 KB	-rw-rw-rw-
ap_config.h	6.65 KB	-rw-rw-rw-
ap_config_layout.h	1.21 KB	-rw-rw-rw-
ap_expr.h	14.09 KB	-rw-rw-rw-
ap_hooks.h	6.01 KB	-rw-rw-rw-
ap_listen.h	5.85 KB	-rw-rw-rw-
ap_mmn.h	35.22 KB	-rw-rw-rw-
ap_mpm.h	10.68 KB	-rw-rw-rw-
ap_provider.h	3.55 KB	-rw-rw-rw-
ap_regex.h	10.91 KB	-rw-rw-rw-
ap_regkey.h	9.18 KB	-rw-rw-rw-
ap_release.h	3.15 KB	-rw-rw-rw-
ap_slotmem.h	7.26 KB	-rw-rw-rw-
ap_socache.h	9.39 KB	-rw-rw-rw-
apache_noprobes.h	15.93 KB	-rw-rw-rw-
apr.h	18.29 KB	-rw-rw-rw-
apr_allocator.h	6.25 KB	-rw-rw-rw-
apr_anylock.h	5.06 KB	-rw-rw-rw-
apr_atomic.h	6.25 KB	-rw-rw-rw-
apr_base64.h	3.86 KB	-rw-rw-rw-
apr_buckets.h	64.6 KB	-rw-rw-rw-
apr_crypto.h	20.18 KB	-rw-rw-rw-
apr_cstr.h	11.42 KB	-rw-rw-rw-
apr_date.h	3.57 KB	-rw-rw-rw-
apr_dbd.h	23.88 KB	-rw-rw-rw-
apr_dbm.h	8.62 KB	-rw-rw-rw-
apr_dso.h	2.73 KB	-rw-rw-rw-
apr_encode.h	24.52 KB	-rw-rw-rw-
apr_env.h	2.12 KB	-rw-rw-rw-
apr_errno.h	55.08 KB	-rw-rw-rw-
apr_escape.h	17.65 KB	-rw-rw-rw-
apr_escape_test_char.h	1.4 KB	-rw-rw-rw-
apr_file_info.h	17.59 KB	-rw-rw-rw-
apr_file_io.h	43.11 KB	-rw-rw-rw-
apr_fnmatch.h	6.23 KB	-rw-rw-rw-
apr_general.h	7.36 KB	-rw-rw-rw-
apr_getopt.h	6 KB	-rw-rw-rw-
apr_global_mutex.h	7.38 KB	-rw-rw-rw-
apr_hash.h	10.36 KB	-rw-rw-rw-
apr_hooks.h	12.71 KB	-rw-rw-rw-
apr_inherit.h	2.14 KB	-rw-rw-rw-
apr_ldap.h	5.76 KB	-rw-rw-rw-
apr_ldap_init.h	5.81 KB	-rw-rw-rw-
apr_ldap_option.h	8.65 KB	-rw-rw-rw-
apr_ldap_rebind.h	3.19 KB	-rw-rw-rw-
apr_ldap_url.h	3.83 KB	-rw-rw-rw-
apr_lib.h	8.47 KB	-rw-rw-rw-
apr_md4.h	4.55 KB	-rw-rw-rw-
apr_md5.h	6.37 KB	-rw-rw-rw-
apr_memcache.h	17.25 KB	-rw-rw-rw-
apr_mmap.h	5.18 KB	-rw-rw-rw-
apr_network_io.h	36.94 KB	-rw-rw-rw-
apr_optional.h	2.8 KB	-rw-rw-rw-
apr_optional_hooks.h	3.9 KB	-rw-rw-rw-
apr_perms_set.h	1.93 KB	-rw-rw-rw-
apr_poll.h	21.04 KB	-rw-rw-rw-
apr_pools.h	31.73 KB	-rw-rw-rw-
apr_portable.h	20.56 KB	-rw-rw-rw-
apr_proc_mutex.h	7.04 KB	-rw-rw-rw-
apr_queue.h	4.12 KB	-rw-rw-rw-
apr_random.h	5.07 KB	-rw-rw-rw-
apr_redis.h	16.07 KB	-rw-rw-rw-
apr_reslist.h	7.19 KB	-rw-rw-rw-
apr_ring.h	19.07 KB	-rw-rw-rw-
apr_rmm.h	4.8 KB	-rw-rw-rw-
apr_sdbm.h	6.14 KB	-rw-rw-rw-
apr_sha1.h	3.91 KB	-rw-rw-rw-
apr_shm.h	9.48 KB	-rw-rw-rw-
apr_signal.h	2.8 KB	-rw-rw-rw-
apr_siphash.h	6.16 KB	-rw-rw-rw-
apr_skiplist.h	14.56 KB	-rw-rw-rw-
apr_strings.h	14.92 KB	-rw-rw-rw-
apr_strmatch.h	2.69 KB	-rw-rw-rw-
apr_support.h	1.65 KB	-rw-rw-rw-
apr_tables.h	19.39 KB	-rw-rw-rw-
apr_thread_cond.h	5.53 KB	-rw-rw-rw-
apr_thread_mutex.h	4.51 KB	-rw-rw-rw-
apr_thread_pool.h	11.14 KB	-rw-rw-rw-
apr_thread_proc.h	36.11 KB	-rw-rw-rw-
apr_thread_rwlock.h	4.78 KB	-rw-rw-rw-
apr_time.h	7.62 KB	-rw-rw-rw-
apr_uri.h	6.61 KB	-rw-rw-rw-
apr_user.h	5.34 KB	-rw-rw-rw-
apr_uuid.h	2.13 KB	-rw-rw-rw-
apr_version.h	5.44 KB	-rw-rw-rw-
apr_want.h	3.01 KB	-rw-rw-rw-
apr_xlate.h	6.42 KB	-rw-rw-rw-
apr_xml.h	12.54 KB	-rw-rw-rw-
apu.h	4.76 KB	-rw-rw-rw-
apu_errno.h	5.49 KB	-rw-rw-rw-
apu_version.h	4.33 KB	-rw-rw-rw-
apu_want.h	1.55 KB	-rw-rw-rw-
cache_common.h	2.02 KB	-rw-rw-rw-
expat.h	41.5 KB	-rw-rw-rw-
heartbeat.h	1.62 KB	-rw-rw-rw-
http_config.h	57.39 KB	-rw-rw-rw-
http_connection.h	6.4 KB	-rw-rw-rw-
http_core.h	35.69 KB	-rw-rw-rw-
http_log.h	36.82 KB	-rw-rw-rw-
http_main.h	3.25 KB	-rw-rw-rw-
http_protocol.h	39.38 KB	-rw-rw-rw-
http_request.h	25.86 KB	-rw-rw-rw-
http_vhost.h	4.05 KB	-rw-rw-rw-
httpd.h	90.22 KB	-rw-rw-rw-
mod_auth.h	4.55 KB	-rw-rw-rw-
mod_cache.h	7.27 KB	-rw-rw-rw-
mod_cgi.h	2.5 KB	-rw-rw-rw-
mod_core.h	3.43 KB	-rw-rw-rw-
mod_dav.h	95.29 KB	-rw-rw-rw-
mod_dbd.h	4.18 KB	-rw-rw-rw-
mod_http2.h	3.7 KB	-rw-rw-rw-
mod_include.h	4.01 KB	-rw-rw-rw-
mod_log_config.h	2.5 KB	-rw-rw-rw-
mod_proxy.h	55.11 KB	-rw-rw-rw-
mod_request.h	1.65 KB	-rw-rw-rw-
mod_rewrite.h	1.41 KB	-rw-rw-rw-
mod_so.h	1.23 KB	-rw-rw-rw-
mod_ssl.h	4.99 KB	-rw-rw-rw-
mod_ssl_openssl.h	4.79 KB	-rw-rw-rw-
mod_status.h	2.45 KB	-rw-rw-rw-
mod_watchdog.h	7.55 KB	-rw-rw-rw-
mpm_common.h	17.11 KB	-rw-rw-rw-
os.h	4.57 KB	-rw-rw-rw-
scoreboard.h	9.98 KB	-rw-rw-rw-
util_cfgtree.h	3.17 KB	-rw-rw-rw-
util_charset.h	2.28 KB	-rw-rw-rw-
util_cookies.h	4.99 KB	-rw-rw-rw-
util_ebcdic.h	2.78 KB	-rw-rw-rw-
util_fcgi.h	10.02 KB	-rw-rw-rw-
util_filter.h	26.46 KB	-rw-rw-rw-
util_ldap.h	18.36 KB	-rw-rw-rw-
util_md5.h	2.19 KB	-rw-rw-rw-
util_mutex.h	9.29 KB	-rw-rw-rw-
util_script.h	9.8 KB	-rw-rw-rw-
util_time.h	4.11 KB	-rw-rw-rw-
util_varbuf.h	8.28 KB	-rw-rw-rw-
util_xml.h	1.36 KB	-rw-rw-rw-
zconf.h	16.44 KB	-rw-rw-rw-
zlib.h	95.85 KB	-rw-rw-rw-

Code Editor : apr_encode.h

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file apr_encode.h
 * @brief APR-UTIL Encoding
 */
#ifndef APR_ENCODE_H
#define APR_ENCODE_H

#include "apr.h"
#include "apr_general.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @defgroup APR_Util_Encode Base64/Base64Url/Base32/Base32Hex/Base16 Encoding
 * @ingroup APR_Util
 * @{
 */

/**
 * 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.
 */
#define APR_ENCODE_STRING      (-1)

/**
 * Generate RFC4648 base16/base32/base64.
 */
#define APR_ENCODE_NONE 0

/**
 * If relaxed, decode up until the first non base16/base32/base64 character.
 */
#define APR_ENCODE_RELAXED 1

/**
 * Omit the padding character (=) while encoding.
 */
#define APR_ENCODE_NOPADDING 2

/**
 * Generate RFC4648 Base 64 Encoding with URL and Filename Safe Alphabet
 */
#define APR_ENCODE_URL 4

/**
 * Generate RFC7515 BASE64URL
 */
#define APR_ENCODE_BASE64URL (APR_ENCODE_NOPADDING | APR_ENCODE_URL)

/**
 * Generate base32hex encoding instead of base32 encoding
 */
#define APR_ENCODE_BASE32HEX 8

/**
 * Generate base16 with colons between each token.
 */
#define APR_ENCODE_COLON 16

/**
 * Generate base16 with lower case characters.
 */
#define APR_ENCODE_LOWER 32

/**
 * Convert text data to base64.
 * @param dest The destination string, can be NULL.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param 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.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination string, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL.
 */
APR_DECLARE(apr_status_t) apr_encode_base64(char *dest, const char *src,
        apr_ssize_t slen, int flags, apr_size_t * len);

/**
 * Convert binary data to base64.
 * @param dest The destination string, can be NULL.
 * @param src The original buffer.
 * @param slen The length of the original buffer.
 * @param 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.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination string, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL.
 */
APR_DECLARE(apr_status_t) apr_encode_base64_binary(char *dest, const unsigned char *src,
        apr_ssize_t slen, int flags, apr_size_t * len);

/**
 * Convert text data to base64, and return the results from a pool.
 * @param p Pool to allocate from.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param 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.
 * @param len If present, returns the number of characters written excluding
 *  the zero pad.
 * @return A zero padded string allocated from the pool on success, or
 * NULL if src was NULL.
 */
APR_DECLARE(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)));

/**
 * Convert binary data to base64, and return the results from a pool.
 * @param p Pool to allocate from.
 * @param src The original buffer.
 * @param slen The length of the original buffer.
 * @param 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.
 * @param len If present, returns the number of characters written excluding
 *  the zero pad.
 * @return A zero padded string allocated from the pool on success, or
 * NULL if src was NULL.
 */
APR_DECLARE(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)));

/**
 * Convert base64 or base64url with or without padding to text data.
 * @param dest The destination string, can be NULL.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param 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.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination string, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL, or APR_BADCH
 * if a non hex character is present.
 */
APR_DECLARE(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 binary data.
 * @param dest The destination buffer, can be NULL.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param 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.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination buffer, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the src was NULL, or APR_BADCH
 * if a non base64 character is present.
 */
APR_DECLARE(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 text data, and
 * return the results from a pool.
 * @param p Pool to allocate from.
 * @param src The base64 string to decode.
 * @param slen The length of the base64 string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param 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.
 * @param len If present, returns the number of characters written, excluding
 *  the zero padding.
 * @return A string allocated from the pool containing the result with a zero
 *  pad. If src was NULL, or an error occurred, NULL is returned.
 */
APR_DECLARE(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)));

/**
 * Convert base64 or base64url with or without padding to binary data, and
 * return the results from a pool.
 * @param p Pool to allocate from.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 *  NUL terminated.
 * @param 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.
 * @param len If present, returns the number of characters written, excluding
 *  the zero padding.
 * @return A buffer allocated from the pool containing the result with a zero
 *  pad. If src was NULL, or an error occurred, NULL is returned.
 */
APR_DECLARE(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)));

/**
 * Convert text data to base32.
 * @param dest The destination string, can be NULL.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param 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.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination string, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL.
 */
APR_DECLARE(apr_status_t) apr_encode_base32(char *dest, const char *src,
        apr_ssize_t slen, int flags, apr_size_t * len);

/**
 * Convert binary data to base32.
 * @param dest The destination string, can be NULL.
 * @param src The original buffer.
 * @param slen The length of the original buffer.
 * @param 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.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination string, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL.
 */
APR_DECLARE(apr_status_t) apr_encode_base32_binary(char *dest, const unsigned char *src,
        apr_ssize_t slen, int flags, apr_size_t * len);

/**
 * Convert text data to base32, and return the results from a pool.
 * @param p Pool to allocate from.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param 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.
 * @param len If present, returns the number of characters written excluding
 *  the zero pad.
 * @return A zero padded string allocated from the pool on success, or
 * NULL if src was NULL.
 */
APR_DECLARE(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)));

/**
 * Convert binary data to base32, and return the results from a pool.
 * @param p Pool to allocate from.
 * @param src The original buffer.
 * @param slen The length of the original buffer.
 * @param flags If APR_ENCODE_NONE, emit RFC4648 Base 32 Encoding. If
 *  APR_ENCODE_NOPADDING, omit the = padding character.	If APR_ENCODE_BASE32HEX,
 *  use RFC7515 base32hex Encoding.
 * @param len If present, returns the number of characters written excluding
 *  the zero pad.
 * @return A zero padded string allocated from the pool on success, or
 * NULL if src was NULL.
 */
APR_DECLARE(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)));

/**
 * Convert base32 or base32hex with or without padding to text data.
 * @param dest The destination string, can be NULL.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param flags If APR_ENCODE_NONE, parse RFC4648 Base 32 Encoding. If
 *  APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination buffer, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL, or APR_BADCH
 * if a non base32 character is present.
 */
APR_DECLARE(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 binary data.
 * @param dest The destination buffer, can be NULL.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param flags If APR_ENCODE_NONE, parse RFC4648 Base 32 Encoding. If
 *  APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination buffer, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the src was NULL, or APR_BADCH
 * if a non base32 character is present.
 */
APR_DECLARE(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 text data, and
 * return the results from a pool.
 * @param p Pool to allocate from.
 * @param src The base32 string to decode.
 * @param slen The length of the base32 string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param flags If APR_ENCODE_NONE, parse RFC4648 Base 32 Encoding. If
 *  APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
 * @param len If present, returns the number of characters written, excluding
 *  the zero padding.
 * @return A string allocated from the pool containing the result with a zero
 *  pad. If src was NULL, or an error occurred, NULL is returned.
 */
APR_DECLARE(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)));

/**
 * Convert base32 or base32hex with or without padding to binary data, and
 * return the results from a pool.
 * @param p Pool to allocate from.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 *  NUL terminated.
 * @param flags If APR_ENCODE_NONE, parse RFC4648 Base 32 Encoding. If
 *  APR_ENCODE_BASE32HEX, use RFC4648 base32hex Encoding.
 * @param len If present, returns the number of characters written, excluding
 *  the zero padding.
 * @return A buffer allocated from the pool containing the result with a zero
 *  pad. If src was NULL, or an error occurred, NULL is returned.
 */
APR_DECLARE(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)));

/**
 * Convert text data to base16 (hex).
 * @param dest The destination string, can be NULL.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param flags If APR_ENCODE_NONE, emit RFC4648 Base 16 Encoding. If
 *  APR_ENCODE_COLON, separate each token with a colon.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination buffer, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL.
 */
APR_DECLARE(apr_status_t) apr_encode_base16(char *dest, const char *src,
        apr_ssize_t slen, int flags, apr_size_t * len);

/**
 * Convert binary data to base16 (hex).
 * @param dest The destination string, can be NULL.
 * @param src The original buffer.
 * @param slen The length of the original buffer.
 * @param flags If APR_ENCODE_NONE, emit RFC4648 Base 16 Encoding. If
 *  APR_ENCODE_COLON, separate each token with a colon.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination buffer, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL.
 */
APR_DECLARE(apr_status_t) apr_encode_base16_binary(char *dest,
        const unsigned 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.
 * @param p Pool to allocate from.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param flags If APR_ENCODE_NONE, emit RFC4648 Base 16 Encoding. If
 *  APR_ENCODE_COLON, separate each token with a colon.
 * @param len If present, returns the number of characters written, excluding
 *  the zero padding.
 * @return A string allocated from the pool containing the result with a zero
 *  pad. If src was NULL, or an error occurred, NULL is returned.
 */
APR_DECLARE(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)));

/**
 * Convert binary data to base16 (hex), and return the results from a
 * pool.
 * @param p Pool to allocate from.
 * @param src The original buffer.
 * @param slen The length of the original buffer.
 * @param flags If APR_ENCODE_NONE, emit RFC4648 Base 16 Encoding. If
 *  APR_ENCODE_COLON, separate each token with a colon.
 * @param len If present, returns the number of characters written, excluding
 *  the zero padding.
 * @return A string allocated from the pool containing the result with a zero
 *  pad. If src was NULL, or an error occurred, NULL is returned.
 */
APR_DECLARE(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)));

/**
 * Convert base16 (hex) to text data.
 * @param dest The destination string, can be NULL.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param flags If APR_ENCODE_NONE, parse RFC4648 Base 16 Encoding. If
 *  APR_ENCODE_COLON, allow tokens to be separated with a colon.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination buffer, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL, or APR_BADCH
 * if a non hex character is present. A zero pad is appended to the buffer.
 */
APR_DECLARE(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 binary data.
 * @param dest The destination buffer, can be NULL.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param flags If APR_ENCODE_NONE, parse RFC4648 Base 16 Encoding. If
 *  APR_ENCODE_COLON, allow tokens to be separated with a colon.
 * @param len If present and src is NULL, returns the maximum possible length
 *  of the destination buffer, including a zero pad. If present and src is
 *  not NULL, returns the number of characters actually written.
 * @return APR_SUCCESS, or APR_NOTFOUND if the string was NULL, or APR_BADCH
 * if a non hex character is present. No zero pad is written to the buffer.
 */
APR_DECLARE(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) and return the results from a pool.
 * @param p Pool to allocate from.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param flags If APR_ENCODE_NONE, parse RFC4648 Base 16 Encoding. If
 *  APR_ENCODE_COLON, allow tokens to be separated with a colon.
 * @param len If present, returns the number of characters written, excluding
 *  the zero padding.
 * @return A buffer allocated from the pool containing the result with a zero
 *  pad. If src was NULL, or an error occurred, NULL is returned.
 */
APR_DECLARE(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)));

/**
 * Convert base16 (hex) to binary data, and return the results from a pool.
 * @param p Pool to allocate from.
 * @param src The original string.
 * @param slen The length of the original string, or APR_ENCODE_STRING if
 * NUL terminated.
 * @param flags If APR_ENCODE_NONE, parse RFC4648 Base 16 Encoding. If
 *  APR_ENCODE_COLON, allow tokens to be separated with a colon.
 * @param len If present, returns the number of characters written, excluding
 *  the zero padding.
 * @return A buffer allocated from the pool containing the result with a zero
 *  pad. If src was NULL, or an error occurred, NULL is returned.
 */
APR_DECLARE(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)));

/** @} */
#ifdef __cplusplus
}
#endif

#endif                          /* !APR_ENCODE_H */

${this.title}

Code Editor : apr_encode.h