apr_base64.h revision 251886 
1251876Speter/* Licensed to the Apache Software Foundation (ASF) under one or more
2251876Speter * contributor license agreements.  See the NOTICE file distributed with
3251876Speter * this work for additional information regarding copyright ownership.
4251876Speter * The ASF licenses this file to You under the Apache License, Version 2.0
5251876Speter * (the "License"); you may not use this file except in compliance with
6251876Speter * the License.  You may obtain a copy of the License at
7251876Speter *
8251876Speter *     http://www.apache.org/licenses/LICENSE-2.0
9251876Speter *
10251876Speter * Unless required by applicable law or agreed to in writing, software
11251876Speter * distributed under the License is distributed on an "AS IS" BASIS,
12251876Speter * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13251876Speter * See the License for the specific language governing permissions and
14251876Speter * limitations under the License.
15251876Speter * The apr_vsnprintf/apr_snprintf functions are based on, and used with the
16251876Speter * permission of, the  SIO stdio-replacement strx_* functions by Panos
17251876Speter * Tsirigotis <panos@alumni.cs.colorado.edu> for xinetd.
18251876Speter */
19251876Speter
20251876Speter/**
21251876Speter * @file apr_base64.h
22251876Speter * @brief APR-UTIL Base64 Encoding
23251876Speter */
24251876Speter#ifndef APR_BASE64_H
25251876Speter#define APR_BASE64_H
26251876Speter
27251876Speter#include "apu.h"
28251876Speter#include "apr_general.h"
29251876Speter
30251876Speter#ifdef __cplusplus
31251876Speterextern "C" {
32251876Speter#endif
33251876Speter
34251876Speter/**
35251876Speter * @defgroup APR_Util_Base64 Base64 Encoding
36251876Speter * @ingroup APR_Util
37251876Speter * @{
38251876Speter */
39251876Speter
40251876Speter/* Simple BASE64 encode/decode functions.
41251876Speter *
42251876Speter * As we might encode binary strings, hence we require the length of
43251876Speter * the incoming plain source. And return the length of what we decoded.
44251876Speter *
45251876Speter * The decoding function takes any non valid char (i.e. whitespace, \0
46251876Speter * or anything non A-Z,0-9 etc as terminal.
47251876Speter *
48251876Speter * plain strings/binary sequences are not assumed '\0' terminated. Encoded
49251876Speter * strings are neither. But probably should.
50251876Speter *
51251876Speter */
52
53/**
54 * Given the length of an un-encrypted string, get the length of the
55 * encrypted string.
56 * @param len the length of an unencrypted string.
57 * @return the length of the string after it is encrypted
58 */
59APU_DECLARE(int) apr_base64_encode_len(int len);
60
61/**
62 * Encode a text string using base64encoding.
63 * @param coded_dst The destination string for the encoded string.
64 * @param plain_src The original string in plain text
65 * @param len_plain_src The length of the plain text string
66 * @return the length of the encoded string
67 */
68APU_DECLARE(int) apr_base64_encode(char * coded_dst, const char *plain_src,
69                                 int len_plain_src);
70
71/**
72 * Encode an EBCDIC string using base64encoding.
73 * @param coded_dst The destination string for the encoded string.
74 * @param plain_src The original string in plain text
75 * @param len_plain_src The length of the plain text string
76 * @return the length of the encoded string
77 */
78APU_DECLARE(int) apr_base64_encode_binary(char * coded_dst,
79                                        const unsigned char *plain_src,
80                                        int len_plain_src);
81
82/**
83 * Determine the maximum buffer length required to decode the plain text
84 * string given the encoded string.
85 * @param coded_src The encoded string
86 * @return the maximum required buffer length for the plain text string
87 */
88APU_DECLARE(int) apr_base64_decode_len(const char * coded_src);
89
90/**
91 * Decode a string to plain text
92 * @param plain_dst The destination string for the plain text
93 * @param coded_src The encoded string
94 * @return the length of the plain text string
95 */
96APU_DECLARE(int) apr_base64_decode(char * plain_dst, const char *coded_src);
97
98/**
99 * Decode an EBCDIC string to plain text
100 * @param plain_dst The destination string for the plain text
101 * @param coded_src The encoded string
102 * @return the length of the plain text string
103 */
104APU_DECLARE(int) apr_base64_decode_binary(unsigned char * plain_dst,
105                                        const char *coded_src);
106
107/** @} */
108#ifdef __cplusplus
109}
110#endif
111
112#endif	/* !APR_BASE64_H */
113