base64.h 2.88 KB
Newer Older
1
/*
Mark Andrews's avatar
Mark Andrews committed
2
 * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
Brian Wellington's avatar
Brian Wellington committed
3
 * Copyright (C) 1999-2001  Internet Software Consortium.
4
 *
5 6 7
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
8
 *
Mark Andrews's avatar
Mark Andrews committed
9 10 11 12 13 14 15
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
16 17
 */

18
/* $Id: base64.h,v 1.17 2005/04/27 04:57:16 sra Exp $ */
19 20 21 22

#ifndef ISC_BASE64_H
#define ISC_BASE64_H 1

23 24
/*! \file */

25 26 27 28 29 30 31 32 33
#include <isc/lang.h>
#include <isc/types.h>

ISC_LANG_BEGINDECLS

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

34 35 36
isc_result_t
isc_base64_totext(isc_region_t *source, int wordlength,
		  const char *wordbreak, isc_buffer_t *target);
37 38
/*!<
 * \brief Convert data into base64 encoded text.
39 40
 *
 * Notes:
41
 *\li	The base64 encoded text in 'target' will be divided into
42 43
 *	words of at most 'wordlength' characters, separated by
 * 	the 'wordbreak' string.  No parentheses will surround
44
 *	the text.
45 46
 *
 * Requires:
47 48 49
 *\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
50
 *		zero or more whitespace characters
51 52
 *
 * Ensures:
53
 *\li	target will contain the base64 encoded version of the data
54
 *	in source.  The 'used' pointer in target will be advanced as
55 56 57
 *	necessary.
 */

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

78 79
isc_result_t
isc_base64_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
80 81
/*!<
 * \brief Convert base64 encoded text from a lexer context into data.
82 83
 *
 * Requires:
84 85 86
 *\li	'lex' is a valid lexer context
 *\li	'target' is a buffer containing binary data
 *\li	'length' is an integer
87 88
 *
 * Ensures:
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 93
 *	advanced as necessary.
 */
94

95

96

97 98 99
ISC_LANG_ENDDECLS

#endif /* ISC_BASE64_H */