base64.h 2.81 KB
Newer Older
1
/*
Bob Halley's avatar
Bob Halley committed
2
 * Copyright (C) 1999, 2000  Internet Software Consortium.
3 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 9 10 11 12 13 14 15
 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
 * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
 * INTERNET SOFTWARE CONSORTIUM 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.11 2000/07/27 09:51:25 tale Exp $ */
19 20 21 22 23 24 25 26 27 28 29 30 31

#ifndef ISC_BASE64_H
#define ISC_BASE64_H 1

#include <isc/lang.h>
#include <isc/types.h>

ISC_LANG_BEGINDECLS

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

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

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

77 78 79
isc_result_t
isc_base64_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
/*
80
 * Convert base64 encoded text from a lexer context into data.
81 82
 *
 * Requires:
83 84 85
 *	'lex' is a valid lexer context
 *	'target' is a buffer containing binary data
 *	'length' is an integer
86 87 88 89
 *
 * Ensures:
 *	target will contain the data represented by the base64 encoded 
 *	string parsed by the lexer.  No more than length bytes will be read,
90
 *	if length is positive.  The 'used' pointer in target will be
91 92
 *	advanced as necessary.
 */
93

94

95

96 97 98
ISC_LANG_ENDDECLS

#endif /* ISC_BASE64_H */