mirror of
https://github.com/isc-projects/bind9.git
synced 2026-04-07 02:05:09 -04:00
06f9163d51
Since BIND 9 headers are not longer public, there's no reason to keep the ISC_LANG_BEGINDECL and ISC_LANG_ENDDECL macros to support including them from C++ projects.
93 lines
2.7 KiB
C
93 lines
2.7 KiB
C
/*
|
|
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
*
|
|
* SPDX-License-Identifier: MPL-2.0
|
|
*
|
|
* 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 https://mozilla.org/MPL/2.0/.
|
|
*
|
|
* See the COPYRIGHT file distributed with this work for additional
|
|
* information regarding copyright ownership.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
/*! \file isc/base64.h */
|
|
|
|
#include <isc/types.h>
|
|
|
|
/***
|
|
*** Functions
|
|
***/
|
|
|
|
isc_result_t
|
|
isc_base64_totext(isc_region_t *source, int wordlength, const char *wordbreak,
|
|
isc_buffer_t *target);
|
|
/*!<
|
|
* \brief Convert data into base64 encoded text.
|
|
*
|
|
* Notes:
|
|
*\li 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
|
|
* the text.
|
|
*
|
|
* Requires:
|
|
*\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
|
|
* zero or more whitespace characters
|
|
*
|
|
* Ensures:
|
|
*\li target will contain the base64 encoded version of the data
|
|
* in source. The 'used' pointer in target will be advanced as
|
|
* necessary.
|
|
*/
|
|
|
|
isc_result_t
|
|
isc_base64_decodestring(const char *cstr, isc_buffer_t *target);
|
|
/*!<
|
|
* \brief Decode a null-terminated base64 string.
|
|
*
|
|
* Requires:
|
|
*\li 'cstr' is non-null.
|
|
*\li 'target' is a valid buffer.
|
|
*
|
|
* Returns:
|
|
*\li #ISC_R_SUCCESS -- the entire decoded representation of 'cstring'
|
|
* fit in 'target'.
|
|
*\li #ISC_R_BADBASE64 -- 'cstr' is not a valid base64 encoding.
|
|
*
|
|
* Other error returns are any possible error code from:
|
|
*\li isc_lex_create(),
|
|
*\li isc_lex_openbuffer(),
|
|
*\li isc_base64_tobuffer().
|
|
*/
|
|
|
|
isc_result_t
|
|
isc_base64_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
|
|
/*!<
|
|
* \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.
|
|
*
|
|
* Requires:
|
|
*\li 'lexer' is a valid lexer context
|
|
*\li 'target' is a buffer containing binary data
|
|
*\li 'length' is -2, -1, or non-negative
|
|
*
|
|
* Ensures:
|
|
*\li target will contain the data represented by the base64 encoded
|
|
* 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.
|
|
*/
|