base64.h 2.8 KB
Newer Older
1
/*
2
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
3
 *
4 5 6
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 8 9
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
10 11 12 13 14 15
 */


#ifndef ISC_BASE64_H
#define ISC_BASE64_H 1

16
/*! \file isc/base64.h */
17

18 19 20 21 22 23 24 25 26
#include <isc/lang.h>
#include <isc/types.h>

ISC_LANG_BEGINDECLS

/***
 *** Functions
 ***/

27 28 29
isc_result_t
isc_base64_totext(isc_region_t *source, int wordlength,
		  const char *wordbreak, isc_buffer_t *target);
30 31
/*!<
 * \brief Convert data into base64 encoded text.
32 33
 *
 * Notes:
34
 *\li	The base64 encoded text in 'target' will be divided into
35 36
 *	words of at most 'wordlength' characters, separated by
 * 	the 'wordbreak' string.  No parentheses will surround
37
 *	the text.
38 39
 *
 * Requires:
40 41 42
 *\li	'source' is a region containing binary data
 *\li	'target' is a text buffer containing available space
 *\li	'wordbreak' points to a null-terminated string of
43
 *		zero or more whitespace characters
44 45
 *
 * Ensures:
46
 *\li	target will contain the base64 encoded version of the data
47
 *	in source.  The 'used' pointer in target will be advanced as
48 49 50
 *	necessary.
 */

51
isc_result_t
52
isc_base64_decodestring(const char *cstr, isc_buffer_t *target);
53 54
/*!<
 * \brief Decode a null-terminated base64 string.
55 56
 *
 * Requires:
57 58
 *\li	'cstr' is non-null.
 *\li	'target' is a valid buffer.
59 60
 *
 * Returns:
61
 *\li	#ISC_R_SUCCESS	-- the entire decoded representation of 'cstring'
62
 *			   fit in 'target'.
63
 *\li	#ISC_R_BADBASE64 -- 'cstr' is not a valid base64 encoding.
64 65
 *
 * 	Other error returns are any possible error code from:
66 67 68
 *\li		isc_lex_create(),
 *\li		isc_lex_openbuffer(),
 *\li		isc_base64_tobuffer().
69 70
 */

71 72
isc_result_t
isc_base64_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
73
/*!<
74 75 76 77 78 79 80 81 82 83 84
 * \brief Convert base64 encoded text from a lexer context into
 * `target`. If 'length' is non-negative, it is the expected number of
 * encoded octets to convert.
 *
 * If 'length' is -1 then 0 or more encoded octets are expected.
 * If 'length' is -2 then 1 or more encoded octets are expected.
 *
 * Returns:
 *\li	#ISC_R_BADBASE64 -- invalid base64 encoding.
 *\li	#ISC_R_UNEXPECTEDEND: the text does not contain the expected
 *			      number of encoded octets.
85 86
 *
 * Requires:
87
 *\li	'lexer' is a valid lexer context
88
 *\li	'target' is a buffer containing binary data
89
 *\li	'length' is -2, -1, or non-negative
90 91
 *
 * Ensures:
92
 *\li	target will contain the data represented by the base64 encoded
93 94 95
 *	string parsed by the lexer.  No more than `length` octets will
 *	be read, if `length` is non-negative.  The 'used' pointer in
 *	'target' will be advanced as necessary.
96
 */
97

98 99 100
ISC_LANG_ENDDECLS

#endif /* ISC_BASE64_H */