/*

[0] Fix | Delete

* Copyright (C) Internet Systems Consortium, Inc. ("ISC")

[1] Fix | Delete

*

[2] Fix | Delete

* This Source Code Form is subject to the terms of the Mozilla Public

[3] Fix | Delete

* License, v. 2.0. If a copy of the MPL was not distributed with this

[4] Fix | Delete

* file, you can obtain one at https://mozilla.org/MPL/2.0/.

[5] Fix | Delete

*

[6] Fix | Delete

* See the COPYRIGHT file distributed with this work for additional

[7] Fix | Delete

* information regarding copyright ownership.

[8] Fix | Delete

*/

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

#ifndef ISC_HEX_H

[12] Fix | Delete

#define ISC_HEX_H 1

[13] Fix | Delete

[14] Fix | Delete

/*! \file isc/hex.h */

[15] Fix | Delete

[16] Fix | Delete

#include <isc/lang.h>

[17] Fix | Delete

#include <isc/types.h>

[18] Fix | Delete

[19] Fix | Delete

ISC_LANG_BEGINDECLS

[20] Fix | Delete

[21] Fix | Delete

/***

[22] Fix | Delete

*** Functions

[23] Fix | Delete

***/

[24] Fix | Delete

[25] Fix | Delete

isc_result_t

[26] Fix | Delete

isc_hex_totext(isc_region_t *source, int wordlength,

[27] Fix | Delete

const char *wordbreak, isc_buffer_t *target);

[28] Fix | Delete

/*!<

[29] Fix | Delete

* \brief Convert data into hex encoded text.

[30] Fix | Delete

*

[31] Fix | Delete

* Notes:

[32] Fix | Delete

*\li The hex encoded text in 'target' will be divided into

[33] Fix | Delete

* words of at most 'wordlength' characters, separated by

[34] Fix | Delete

* the 'wordbreak' string. No parentheses will surround

[35] Fix | Delete

* the text.

[36] Fix | Delete

*

[37] Fix | Delete

* Requires:

[38] Fix | Delete

*\li 'source' is a region containing binary data

[39] Fix | Delete

*\li 'target' is a text buffer containing available space

[40] Fix | Delete

*\li 'wordbreak' points to a null-terminated string of

[41] Fix | Delete

* zero or more whitespace characters

[42] Fix | Delete

*

[43] Fix | Delete

* Ensures:

[44] Fix | Delete

*\li target will contain the hex encoded version of the data

[45] Fix | Delete

* in source. The 'used' pointer in target will be advanced as

[46] Fix | Delete

* necessary.

[47] Fix | Delete

*/

[48] Fix | Delete

[49] Fix | Delete

isc_result_t

[50] Fix | Delete

isc_hex_decodestring(const char *cstr, isc_buffer_t *target);

[51] Fix | Delete

/*!<

[52] Fix | Delete

* \brief Decode a null-terminated hex string.

[53] Fix | Delete

*

[54] Fix | Delete

* Requires:

[55] Fix | Delete

*\li 'cstr' is non-null.

[56] Fix | Delete

*\li 'target' is a valid buffer.

[57] Fix | Delete

*

[58] Fix | Delete

* Returns:

[59] Fix | Delete

*\li #ISC_R_SUCCESS -- the entire decoded representation of 'cstring'

[60] Fix | Delete

* fit in 'target'.

[61] Fix | Delete

*\li #ISC_R_BADHEX -- 'cstr' is not a valid hex encoding.

[62] Fix | Delete

*

[63] Fix | Delete

* Other error returns are any possible error code from:

[64] Fix | Delete

* isc_lex_create(),

[65] Fix | Delete

* isc_lex_openbuffer(),

[66] Fix | Delete

* isc_hex_tobuffer().

[67] Fix | Delete

*/

[68] Fix | Delete

[69] Fix | Delete

isc_result_t

[70] Fix | Delete

isc_hex_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);

[71] Fix | Delete

/*!<

[72] Fix | Delete

* \brief Convert hex-encoded text from a lexer context into

[73] Fix | Delete

* `target`. If 'length' is non-negative, it is the expected number of

[74] Fix | Delete

* encoded octets to convert.

[75] Fix | Delete

*

[76] Fix | Delete

* If 'length' is -1 then 0 or more encoded octets are expected.

[77] Fix | Delete

* If 'length' is -2 then 1 or more encoded octets are expected.

[78] Fix | Delete

*

[79] Fix | Delete

* Returns:

[80] Fix | Delete

*\li #ISC_R_BADHEX -- invalid hex encoding

[81] Fix | Delete

*\li #ISC_R_UNEXPECTEDEND: the text does not contain the expected

[82] Fix | Delete

* number of encoded octets.

[83] Fix | Delete

*

[84] Fix | Delete

* Requires:

[85] Fix | Delete

*\li 'lexer' is a valid lexer context

[86] Fix | Delete

*\li 'target' is a buffer containing binary data

[87] Fix | Delete

*\li 'length' is -2, -1, or non-negative

[88] Fix | Delete

*

[89] Fix | Delete

* Ensures:

[90] Fix | Delete

*\li target will contain the data represented by the hex encoded

[91] Fix | Delete

* string parsed by the lexer. No more than `length` octets will

[92] Fix | Delete

* be read, if `length` is non-negative. The 'used' pointer in

[93] Fix | Delete

* 'target' will be advanced as necessary.

[94] Fix | Delete

*/

[95] Fix | Delete

[96] Fix | Delete

ISC_LANG_ENDDECLS

[97] Fix | Delete

[98] Fix | Delete

#endif /* ISC_HEX_H */

[99] Fix | Delete

[100] Fix | Delete