2
* Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
2
* Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
3
3
* Copyright (C) 1999-2001 Internet Software Consortium.
5
* Permission to use, copy, modify, and distribute this software for any
5
* Permission to use, copy, modify, and/or distribute this software for any
6
6
* purpose with or without fee is hereby granted, provided that the above
7
7
* copyright notice and this permission notice appear in all copies.
33
35
isc_base64_totext(isc_region_t *source, int wordlength,
34
36
const char *wordbreak, isc_buffer_t *target);
36
* Convert data into base64 encoded text.
38
* \brief Convert data into base64 encoded text.
39
* The base64 encoded text in 'target' will be divided into
41
*\li The base64 encoded text in 'target' will be divided into
40
42
* words of at most 'wordlength' characters, separated by
41
43
* the 'wordbreak' string. No parentheses will surround
45
* 'source' is a region containing binary data
46
* 'target' is a text buffer containing available space
47
* 'wordbreak' points to a null-terminated string of
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
48
50
* zero or more whitespace characters
51
* target will contain the base64 encoded version of the data
53
*\li target will contain the base64 encoded version of the data
52
54
* in source. The 'used' pointer in target will be advanced as
57
59
isc_base64_decodestring(const char *cstr, isc_buffer_t *target);
59
* Decode a null-terminated base64 string.
61
* \brief Decode a null-terminated base64 string.
63
* 'target' is a valid buffer.
64
*\li 'cstr' is non-null.
65
*\li 'target' is a valid buffer.
66
* ISC_R_SUCCESS -- the entire decoded representation of 'cstring'
68
*\li #ISC_R_SUCCESS -- the entire decoded representation of 'cstring'
68
* ISC_R_BADBASE64 -- 'cstr' is not a valid base64 encoding.
70
*\li #ISC_R_BADBASE64 -- 'cstr' is not a valid base64 encoding.
70
72
* Other error returns are any possible error code from:
72
* isc_lex_openbuffer(),
73
* isc_base64_tobuffer().
73
*\li isc_lex_create(),
74
*\li isc_lex_openbuffer(),
75
*\li isc_base64_tobuffer().
77
79
isc_base64_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
79
* Convert base64 encoded text from a lexer context into data.
81
* \brief Convert base64 encoded text from a lexer context into data.
82
* 'lex' is a valid lexer context
83
* 'target' is a buffer containing binary data
84
* 'length' is an integer
84
*\li 'lex' is a valid lexer context
85
*\li 'target' is a buffer containing binary data
86
*\li 'length' is an integer
87
* target will contain the data represented by the base64 encoded
89
*\li target will contain the data represented by the base64 encoded
88
90
* string parsed by the lexer. No more than length bytes will be read,
89
91
* if length is positive. The 'used' pointer in target will be
90
92
* advanced as necessary.