2 * Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2001 Internet Software Consortium.
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: base64.h,v 1.16.18.2 2005/04/29 00:16:53 marka Exp $ */
21 #define ISC_BASE64_H 1
26 #include <isc/types.h>
35 isc_base64_totext(isc_region_t *source, int wordlength,
36 const char *wordbreak, isc_buffer_t *target);
38 * \brief Convert data into base64 encoded text.
41 *\li The base64 encoded text in 'target' will be divided into
42 * words of at most 'wordlength' characters, separated by
43 * the 'wordbreak' string. No parentheses will surround
47 *\li 'source' is a region containing binary data
48 *\li 'target' is a text buffer containing available space
49 *\li 'wordbreak' points to a null-terminated string of
50 * zero or more whitespace characters
53 *\li target will contain the base64 encoded version of the data
54 * in source. The 'used' pointer in target will be advanced as
59 isc_base64_decodestring(const char *cstr, isc_buffer_t *target);
61 * \brief Decode a null-terminated base64 string.
64 *\li 'cstr' is non-null.
65 *\li 'target' is a valid buffer.
68 *\li #ISC_R_SUCCESS -- the entire decoded representation of 'cstring'
70 *\li #ISC_R_BADBASE64 -- 'cstr' is not a valid base64 encoding.
72 * Other error returns are any possible error code from:
73 *\li isc_lex_create(),
74 *\li isc_lex_openbuffer(),
75 *\li isc_base64_tobuffer().
79 isc_base64_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
81 * \brief Convert base64 encoded text from a lexer context into data.
84 *\li 'lex' is a valid lexer context
85 *\li 'target' is a buffer containing binary data
86 *\li 'length' is an integer
89 *\li target will contain the data represented by the base64 encoded
90 * string parsed by the lexer. No more than length bytes will be read,
91 * if length is positive. The 'used' pointer in target will be
92 * advanced as necessary.
99 #endif /* ISC_BASE64_H */