mirror of
https://github.com/isc-projects/bind9.git
synced 2026-03-19 17:17:04 -04:00
58bd26b6cf
This commit converts the license handling to adhere to the REUSE specification. It specifically: 1. Adds used licnses to LICENSES/ directory 2. Add "isc" template for adding the copyright boilerplate 3. Changes all source files to include copyright and SPDX license header, this includes all the C sources, documentation, zone files, configuration files. There are notes in the doc/dev/copyrights file on how to add correct headers to the new files. 4. Handle the rest that can't be modified via .reuse/dep5 file. The binary (or otherwise unmodifiable) files could have license places next to them in <foo>.license file, but this would lead to cluttered repository and most of the files handled in the .reuse/dep5 file are system test files.
143 lines
4.3 KiB
C
143 lines
4.3 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 */
|
|
|
|
/*
|
|
* Routines for manipulating base 32 and base 32 hex encoded data.
|
|
* Based on RFC 4648.
|
|
*
|
|
* Base 32 hex preserves the sort order of data when it is encoded /
|
|
* decoded.
|
|
*
|
|
* Base 32 hex "np" is base 32 hex but no padding is produced or accepted.
|
|
*/
|
|
|
|
#include <isc/lang.h>
|
|
#include <isc/types.h>
|
|
|
|
ISC_LANG_BEGINDECLS
|
|
|
|
/***
|
|
*** Functions
|
|
***/
|
|
|
|
isc_result_t
|
|
isc_base32_totext(isc_region_t *source, int wordlength, const char *wordbreak,
|
|
isc_buffer_t *target);
|
|
isc_result_t
|
|
isc_base32hex_totext(isc_region_t *source, int wordlength,
|
|
const char *wordbreak, isc_buffer_t *target);
|
|
isc_result_t
|
|
isc_base32hexnp_totext(isc_region_t *source, int wordlength,
|
|
const char *wordbreak, isc_buffer_t *target);
|
|
/*!<
|
|
* \brief Convert data into base32 encoded text.
|
|
*
|
|
* Notes:
|
|
*\li The base32 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 base32 encoded version of the data
|
|
* in source. The 'used' pointer in target will be advanced as
|
|
* necessary.
|
|
*/
|
|
|
|
isc_result_t
|
|
isc_base32_decodestring(const char *cstr, isc_buffer_t *target);
|
|
isc_result_t
|
|
isc_base32hex_decodestring(const char *cstr, isc_buffer_t *target);
|
|
isc_result_t
|
|
isc_base32hexnp_decodestring(const char *cstr, isc_buffer_t *target);
|
|
/*!<
|
|
* \brief Decode a null-terminated string in base32, base32hex, or
|
|
* base32hex non-padded.
|
|
*
|
|
* 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_BADBASE32 -- 'cstr' is not a valid base32 encoding.
|
|
*
|
|
* Other error returns are any possible error code from:
|
|
*\li isc_lex_create(),
|
|
*\li isc_lex_openbuffer(),
|
|
*\li isc_base32_tobuffer().
|
|
*/
|
|
|
|
isc_result_t
|
|
isc_base32_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
|
|
isc_result_t
|
|
isc_base32hex_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
|
|
isc_result_t
|
|
isc_base32hexnp_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
|
|
/*!<
|
|
* \brief Convert text encoded in base32, base32hex, or base32hex
|
|
* non-padded 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_BADBASE32 -- invalid base32 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 base32 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.
|
|
*/
|
|
|
|
isc_result_t
|
|
isc_base32_decoderegion(isc_region_t *source, isc_buffer_t *target);
|
|
isc_result_t
|
|
isc_base32hex_decoderegion(isc_region_t *source, isc_buffer_t *target);
|
|
isc_result_t
|
|
isc_base32hexnp_decoderegion(isc_region_t *source, isc_buffer_t *target);
|
|
/*!<
|
|
* \brief Decode a packed (no white space permitted) region in
|
|
* base32, base32hex or base32hex non-padded.
|
|
*
|
|
* Requires:
|
|
*\li 'source' is a valid region.
|
|
*\li 'target' is a valid buffer.
|
|
*
|
|
* Returns:
|
|
*\li #ISC_R_SUCCESS -- the entire decoded representation of 'cstring'
|
|
* fit in 'target'.
|
|
*\li #ISC_R_BADBASE32 -- 'source' is not a valid base32 encoding.
|
|
*/
|
|
|
|
ISC_LANG_ENDDECLS
|