Contains functions to translate the wireformat to text representation, as well as functions to print them. More...

#include "config.h"
#include "sldns/wire2str.h"
#include "sldns/str2wire.h"
#include "sldns/rrdef.h"
#include "sldns/pkthdr.h"
#include "sldns/parseutil.h"
#include "sldns/sbuffer.h"
#include "sldns/keyraw.h"
#include "util/data/dname.h"
#include <sys/time.h>
#include <stdarg.h>
#include <ctype.h>

Functions
char *	sldns_wire2str_pkt (uint8_t *data, size_t len)
	Convert wireformat packet to a string representation. More...

char *	sldns_wire2str_rr (uint8_t *rr, size_t len)
	Convert wireformat RR to a string representation. More...

char *	sldns_wire2str_type (uint16_t rrtype)
	Convert wire RR type to a string, 'MX', 'TYPE1234'... More...

char *	sldns_wire2str_class (uint16_t rrclass)
	Convert wire RR class to a string, 'IN', 'CLASS1'. More...

char *	sldns_wire2str_dname (uint8_t *dname, size_t dname_len)
	Convert wire dname to a string. More...

char *	sldns_wire2str_rcode (int rcode)
	Convert wire packet rcode to a string, 'NOERROR', 'NXDOMAIN'... More...

int	sldns_wire2str_pkt_buf (uint8_t d, size_t dlen, char s, size_t slen)
	Convert wireformat packet to a string representation with user buffer It appends every RR with default comments. More...

int	sldns_wire2str_rr_buf (uint8_t d, size_t dlen, char s, size_t slen)
	Convert RR to string presentation format, on one line. More...

int	sldns_wire2str_rrquestion_buf (uint8_t d, size_t dlen, char s, size_t slen)
	Convert question RR to string presentation format, on one line. More...

int	sldns_wire2str_rdata_buf (uint8_t rdata, size_t rdata_len, char str, size_t str_len, uint16_t rrtype)
	Convert RDATA to string presentation format, on one line. More...

int	sldns_wire2str_rr_unknown_buf (uint8_t d, size_t dlen, char s, size_t slen)
	3597 printout of an RR in unknown rr format. More...

int	sldns_wire2str_rr_comment_buf (uint8_t rr, size_t rrlen, size_t dname_len, char s, size_t slen)
	This creates the comment to print after the RR. More...

int	sldns_wire2str_type_buf (uint16_t rrtype, char *s, size_t slen)
	Convert wire RR type to a string, 'MX', 'TYPE12'. More...

int	sldns_wire2str_class_buf (uint16_t rrclass, char *s, size_t slen)
	Convert wire RR class to a string, 'IN', 'CLASS12'. More...

int	sldns_wire2str_rcode_buf (int rcode, char *s, size_t slen)
	Convert wire RR rcode to a string, 'NOERROR', 'NXDOMAIN'. More...

int	sldns_wire2str_opcode_buf (int opcode, char *s, size_t slen)
	Convert host format opcode to a string. More...

int	sldns_wire2str_dname_buf (uint8_t d, size_t dlen, char s, size_t slen)
	Convert wire dname to a string, "example.com.". More...

int	sldns_str_vprint (char *str, size_t slen, const char *format, va_list args)
	Print to string, move string along for next content. More...

int	sldns_str_print (char *str, size_t slen, const char *format,...)

static int	print_hex_buf (char *s, size_t slen, uint8_t *buf, size_t len)
	print hex format into text buffer for specified length

static int	print_remainder_hex (const char pref, uint8_t d, size_t dlen, char *s, size_t slen)
	print remainder of buffer in hex format with prefixed text

int	sldns_wire2str_pkt_scan (uint8_t *d, size_t dlen, char *s, size_t slen)
	Scan wireformat packet to a string representation with user buffer It appends every RR with default comments. More...

static int	sldns_rr_tcttl_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	scan type, class and ttl and printout, for rr

int	sldns_wire2str_rr_scan (uint8_t *d, size_t dlen, char *s, size_t slen, uint8_t pkt, size_t pktlen, int comprloop)
	Scan wireformat rr to string, with user buffers. More...

int	sldns_wire2str_rrquestion_scan (uint8_t *d, size_t dlen, char *s, size_t slen, uint8_t pkt, size_t pktlen, int comprloop)
	Scan wireformat question rr to string, with user buffers. More...

int	sldns_wire2str_rr_unknown_scan (uint8_t *d, size_t dlen, char *s, size_t slen, uint8_t pkt, size_t pktlen, int comprloop)
	Scan wireformat RR to string in unknown RR format, with user buffers. More...

static int	rr_comment_dnskey (char *s, size_t slen, uint8_t *rr, size_t rrlen, size_t dname_off)
	print rr comment for type DNSKEY

static int	rr_comment_rrsig (char *s, size_t slen, uint8_t *rr, size_t rrlen, size_t dname_off)
	print rr comment for type RRSIG

static int	rr_comment_nsec3 (char *s, size_t slen, uint8_t *rr, size_t rrlen, size_t dname_off)
	print rr comment for type NSEC3

int	sldns_wire2str_rr_comment_print (char *s, size_t slen, uint8_t *rr, size_t rrlen, size_t dname_off, uint16_t rrtype)
	Print to string the RR-information comment in default format, with user buffers. More...

int	sldns_wire2str_header_scan (uint8_t *d, size_t dlen, char *s, size_t slen)
	Scan wireformat packet header to string, with user buffers. More...

int	sldns_wire2str_rdata_scan (uint8_t *d, size_t dlen, char *s, size_t slen, uint16_t rrtype, uint8_t pkt, size_t pktlen, int comprloop)
	Scan wireformat rdata to string, with user buffers. More...

int	sldns_wire2str_rdata_unknown_scan (uint8_t *d, size_t dlen, char *s, size_t slen)
	Scan wireformat rdata to string in unknown format, with user buffers. More...

static int	dname_char_print (char *s, size_t slen, uint8_t c)
	print and escape one character for a domain dname

int	sldns_wire2str_dname_scan (uint8_t *d, size_t dlen, char *s, size_t slen, uint8_t pkt, size_t pktlen, int comprloop)
	Scan wireformat domain name to string, with user buffers. More...

int	sldns_wire2str_opcode_print (char *s, size_t slen, int opcode)
	Print host format opcode to string. More...

int	sldns_wire2str_rcode_print (char *s, size_t slen, int rcode)
	Print host format rcode to string. More...

int	sldns_wire2str_class_print (char *s, size_t slen, uint16_t rrclass)
	Print host format rr class to string. More...

int	sldns_wire2str_type_print (char *s, size_t slen, uint16_t rrtype)
	Print host format rr type to string. More...

int	sldns_wire2str_edns_option_code_print (char *s, size_t slen, uint16_t opcode)
	Print host format EDNS0 option to string. More...

int	sldns_wire2str_class_scan (uint8_t *d, size_t dlen, char *s, size_t slen)
	Scan wireformat rr class to string, with user buffers. More...

int	sldns_wire2str_type_scan (uint8_t *d, size_t dlen, char *s, size_t slen)
	Scan wireformat rr type to string, with user buffers. More...

int	sldns_wire2str_ttl_scan (uint8_t *d, size_t dlen, char *s, size_t slen)
	Scan wireformat rr ttl to string, with user buffers. More...

static int	sldns_print_svcparamkey (char *s, size_t slen, uint16_t svcparamkey)

static int	sldns_wire2str_svcparam_port2str (char *s, size_t slen, uint16_t data_len, uint8_t *data)

static int	sldns_wire2str_svcparam_ipv4hint2str (char *s, size_t slen, uint16_t data_len, uint8_t *data)

static int	sldns_wire2str_svcparam_ipv6hint2str (char *s, size_t slen, uint16_t data_len, uint8_t *data)

static int	sldns_wire2str_svcparam_mandatory2str (char *s, size_t slen, uint16_t data_len, uint8_t *data)

static int	sldns_wire2str_svcparam_alpn2str (char *s, size_t slen, uint16_t data_len, uint8_t *data)

static int	sldns_wire2str_svcparam_ech2str (char *s, size_t slen, uint16_t data_len, uint8_t *data)

int	sldns_wire2str_svcparam_scan (uint8_t *d, size_t dlen, char *s, size_t slen)
	Convert wire SVCB to a string with user buffer. More...

int	sldns_wire2str_rdf_scan (uint8_t *d, size_t dlen, char *s, size_t slen, int rdftype, uint8_t pkt, size_t pktlen, int comprloop)
	Scan wireformat rdf field to string, with user buffers. More...

int	sldns_wire2str_int8_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat int8 field to string, with user buffers. More...

int	sldns_wire2str_int16_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat int16 field to string, with user buffers. More...

int	sldns_wire2str_int32_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat int32 field to string, with user buffers. More...

int	sldns_wire2str_period_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat period field to string, with user buffers. More...

int	sldns_wire2str_tsigtime_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat tsigtime field to string, with user buffers. More...

int	sldns_wire2str_a_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat ip4 A field to string, with user buffers. More...

int	sldns_wire2str_aaaa_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat ip6 AAAA field to string, with user buffers. More...

static int	str_char_print (char *s, size_t sl, uint8_t c)
	printout escaped TYPE_STR character

int	sldns_wire2str_str_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat str field to string, with user buffers. More...

int	sldns_wire2str_apl_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat apl field to string, with user buffers. More...

int	sldns_wire2str_b32_ext_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat b32_ext field to string, with user buffers. More...

static int	sldns_wire2str_b64_scan_num (uint8_t *d, size_t dl, char *s, size_t sl, size_t num)
	scan number of bytes from wire into b64 presentation format

int	sldns_wire2str_b64_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat b64 field to string, with user buffers. More...

int	sldns_wire2str_hex_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat hex field to string, with user buffers. More...

int	sldns_wire2str_nsec_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat nsec bitmap field to string, with user buffers. More...

int	sldns_wire2str_nsec3_salt_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat nsec3_salt field to string, with user buffers. More...

int	sldns_wire2str_cert_alg_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat cert_alg field to string, with user buffers. More...

int	sldns_wire2str_alg_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat alg field to string, with user buffers. More...

int	sldns_wire2str_unknown_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat type unknown field to string, with user buffers. More...

int	sldns_wire2str_time_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat time field to string, with user buffers. More...

static int	loc_cm_print (char *str, size_t sl, uint8_t mantissa, uint8_t exponent)

int	sldns_wire2str_loc_scan (uint8_t *d, size_t dl, char *str, size_t sl)
	Scan wireformat LOC field to string, with user buffers. More...

int	sldns_wire2str_wks_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat WKS field to string, with user buffers. More...

int	sldns_wire2str_nsap_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat NSAP field to string, with user buffers. More...

int	sldns_wire2str_atma_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat ATMA field to string, with user buffers. More...

static int	sldns_wire2str_ipseckey_scan_internal (uint8_t *d, size_t dl, char *s, size_t sl, uint8_t pkt, size_t pktlen, int comprloop)

int	sldns_wire2str_ipseckey_scan (uint8_t *d, size_t dl, char *s, size_t sl, uint8_t pkt, size_t pktlen, int comprloop)
	Scan wireformat IPSECKEY field to string, with user buffers. More...

int	sldns_wire2str_hip_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat HIP (algo, HIT, pubkey) field to string, with user buffers. More...

int	sldns_wire2str_int16_data_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat int16_data field to string, with user buffers. More...

int	sldns_wire2str_nsec3_next_owner_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat nsec3_next_owner field to string, with user buffers. More...

int	sldns_wire2str_ilnp64_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat ILNP64 field to string, with user buffers. More...

int	sldns_wire2str_eui48_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat EUI48 field to string, with user buffers. More...

int	sldns_wire2str_eui64_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat EUI64 field to string, with user buffers. More...

int	sldns_wire2str_tag_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat TAG field to string, with user buffers. More...

int	sldns_wire2str_long_str_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat long_str field to string, with user buffers. More...

int	sldns_wire2str_tsigerror_scan (uint8_t *d, size_t dl, char *s, size_t sl)
	Scan wireformat tsigerror field to string, with user buffers. More...

int	sldns_wire2str_edns_llq_print (char *s, size_t sl, uint8_t *data, size_t len)
	Print EDNS LLQ option data to string. More...

int	sldns_wire2str_edns_ul_print (char *s, size_t sl, uint8_t *data, size_t len)
	Print EDNS UL option data to string. More...

int	sldns_wire2str_edns_nsid_print (char *s, size_t sl, uint8_t *data, size_t len)
	Print EDNS NSID option data to string. More...

int	sldns_wire2str_edns_dau_print (char *s, size_t sl, uint8_t *data, size_t len)
	Print EDNS DAU option data to string. More...

int	sldns_wire2str_edns_dhu_print (char *s, size_t sl, uint8_t *data, size_t len)
	Print EDNS DHU option data to string. More...

int	sldns_wire2str_edns_n3u_print (char *s, size_t sl, uint8_t *data, size_t len)
	Print EDNS N3U option data to string. More...

int	sldns_wire2str_edns_subnet_print (char *s, size_t sl, uint8_t *data, size_t len)
	Print EDNS SUBNET option data to string. More...

static int	sldns_wire2str_edns_keepalive_print (char *s, size_t sl, uint8_t *data, size_t len)

int	sldns_wire2str_edns_ede_print (char *s, size_t sl, uint8_t *data, size_t len)
	Print EDNS EDE option data to string. More...

int	sldns_wire2str_edns_option_print (char *s, size_t sl, uint16_t option_code, uint8_t *optdata, size_t optlen)
	Print an EDNS option as OPT: VALUE. More...

static int	print_edns_opts (char *s, size_t sl, uint8_t *rdata, size_t rdatalen)
	print the edns options to string

int	sldns_wire2str_edns_scan (uint8_t *data, size_t data_len, char *str, size_t str_len, uint8_t *pkt, size_t pktlen)
	Scan wireformat EDNS OPT to string, with user buffers. More...

Variables
static sldns_lookup_table	sldns_algorithms_data []

sldns_lookup_table *	sldns_algorithms = sldns_algorithms_data
	Taken from RFC 2535, section 7. More...

static sldns_lookup_table	sldns_hashes_data []

sldns_lookup_table *	sldns_hashes = sldns_hashes_data
	DS record hash algorithms.

static sldns_lookup_table	sldns_cert_algorithms_data []

sldns_lookup_table *	sldns_cert_algorithms = sldns_cert_algorithms_data
	Taken from RFC 2538, section 2.1. More...

static sldns_lookup_table	sldns_rcodes_data []

sldns_lookup_table *	sldns_rcodes = sldns_rcodes_data
	Response codes.

static sldns_lookup_table	sldns_opcodes_data []

sldns_lookup_table *	sldns_opcodes = sldns_opcodes_data
	Operation codes.

static sldns_lookup_table	sldns_wireparse_errors_data []

sldns_lookup_table *	sldns_wireparse_errors = sldns_wireparse_errors_data
	error string from wireparse

static sldns_lookup_table	sldns_edns_flags_data []

sldns_lookup_table *	sldns_edns_flags = sldns_edns_flags_data
	EDNS flags.

static sldns_lookup_table	sldns_edns_options_data []

sldns_lookup_table *	sldns_edns_options = sldns_edns_options_data
	EDNS option codes.

static sldns_lookup_table	sldns_edns_ede_codes_data []

sldns_lookup_table *	sldns_edns_ede_codes = sldns_edns_ede_codes_data
	EDNS EDE codes.

static sldns_lookup_table	sldns_tsig_errors_data []

sldns_lookup_table *	sldns_tsig_errors = sldns_tsig_errors_data
	tsig errors are the rcodes with extra (higher) values

const char *	svcparamkey_strs []

Detailed Description

Contains functions to translate the wireformat to text representation, as well as functions to print them.

Function Documentation

◆ sldns_wire2str_pkt()

char* sldns_wire2str_pkt	(	uint8_t *	data,
		size_t	len
	)

Convert wireformat packet to a string representation.

Parameters

data	wireformat packet data (starting at ID bytes).
len	length of packet.

Returns: string(malloced) or NULL on failure.

References sldns_wire2str_pkt_buf().

Referenced by checkformerr(), dstest_entry(), match_all(), match_answer(), match_question(), nsec3_hash_test_entry(), pretty_output(), test_buffers(), and verifytest_entry().

◆ sldns_wire2str_rr()

char* sldns_wire2str_rr	(	uint8_t *	rr,
		size_t	len
	)

Convert wireformat RR to a string representation.

Parameters

rr	the wireformat RR, in uncompressed form. Starts at the domain name start, ends with the rdata of the RR.
len	length of the rr wireformat.

Returns: string(malloced) or NULL on failure.

References sldns_wire2str_rr_buf().

◆ sldns_wire2str_type()

char* sldns_wire2str_type ( uint16_t rrtype )

Convert wire RR type to a string, 'MX', 'TYPE1234'...

Parameters

rrtype the RR type in host order.

Returns: malloced string with the RR type or NULL on malloc failure.

References sldns_wire2str_type_buf().

Referenced by do_dump_requestlist(), dump_msg(), dump_msg_ref(), and get_mesh_status().

◆ sldns_wire2str_class()

char* sldns_wire2str_class ( uint16_t rrclass )

Convert wire RR class to a string, 'IN', 'CLASS1'.

Parameters

rrclass the RR class in host order.

Returns: malloced string with the RR class or NULL on malloc failure.

References sldns_wire2str_class_buf().

Referenced by do_dump_requestlist(), dump_msg(), dump_msg_ref(), and get_mesh_status().

◆ sldns_wire2str_dname()

char* sldns_wire2str_dname	(	uint8_t *	dname,
		size_t	dname_len
	)

Convert wire dname to a string.

Parameters

dname	the dname in uncompressed wireformat.
dname_len	length of the dname.

Returns: string or NULL on failure.

References sldns_wire2str_dname_buf().

Referenced by auth_zone_read_zonefile(), dump_msg(), dump_msg_ref(), print_id(), and rpz_insert_rr().

◆ sldns_wire2str_rcode()

char* sldns_wire2str_rcode ( int rcode )

Convert wire packet rcode to a string, 'NOERROR', 'NXDOMAIN'...

Parameters

rcode as integer, host order

Returns: malloced string with the rcode or NULL on malloc failure.

References sldns_wire2str_rcode_buf().

Referenced by find_match().

◆ sldns_wire2str_pkt_buf()

int sldns_wire2str_pkt_buf	(	uint8_t *	data,
		size_t	data_len,
		char *	str,
		size_t	str_len
	)

Convert wireformat packet to a string representation with user buffer It appends every RR with default comments.

For more formatter options use the function: TBD(TODO)

Parameters

data	wireformat packet data (starting at ID bytes).
data_len	length of packet.
str	the string buffer for the output. If you pass NULL as the str the return value of the function is the str_len you need for the entire packet. It does not include the 0 byte at the end.
str_len	the size of the string buffer. If more is needed, it'll silently truncate the output to fit in the buffer.

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

References sldns_wire2str_pkt_scan().

Referenced by sldns_wire2str_pkt().

◆ sldns_wire2str_rr_buf()

int sldns_wire2str_rr_buf	(	uint8_t *	rr,
		size_t	rr_len,
		char *	str,
		size_t	str_len
	)

Convert RR to string presentation format, on one line.

User buffer.

Parameters

rr	wireformat RR data
rr_len	length of the rr wire data.
str	the string buffer to write to. If you pass NULL as the str, the return value of the function is the str_len you need for the entire packet. It does not include the 0 byte at the end.
str_len	the size of the string buffer. If more is needed, it'll silently truncate the output to fit in the buffer.

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

References sldns_wire2str_rr_scan().

Referenced by sldns_wire2str_rr().

◆ sldns_wire2str_rrquestion_buf()

int sldns_wire2str_rrquestion_buf	(	uint8_t *	rr,
		size_t	rr_len,
		char *	str,
		size_t	str_len
	)

Convert question RR to string presentation format, on one line.

User buffer.

Parameters

rr	wireformat RR data
rr_len	length of the rr wire data.
str	the string buffer to write to. If you pass NULL as the str, the return value of the function is the str_len you need for the entire packet. It does not include the 0 byte at the end.
str_len	the size of the string buffer. If more is needed, it'll silently truncate the output to fit in the buffer.

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

References sldns_wire2str_rrquestion_scan().

◆ sldns_wire2str_rdata_buf()

int sldns_wire2str_rdata_buf	(	uint8_t *	rdata,
		size_t	rdata_len,
		char *	str,
		size_t	str_len,
		uint16_t	rrtype
	)

Convert RDATA to string presentation format, on one line.

User buffer.

Parameters

rdata	wireformat rdata part of an RR.
rdata_len	length of the rr wire data.
str	the string buffer to write to. If you pass NULL as the str, the return value of the function is the str_len you need for the entire packet. It does not include the 0 byte at the end.
str_len	the size of the string buffer. If more is needed, it'll silently truncate the output to fit in the buffer.
rrtype	rr type of the data

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

Referenced by do_print(), and print_rd().

◆ sldns_wire2str_rr_unknown_buf()

int sldns_wire2str_rr_unknown_buf	(	uint8_t *	rr,
		size_t	rr_len,
		char *	str,
		size_t	str_len
	)

3597 printout of an RR in unknown rr format.

There are more format and comment options available for printout with the function: TBD(TODO)

Parameters

rr	wireformat RR data
rr_len	length of the rr wire data.
str	the string buffer to write to. If you pass NULL as the str, the return value of the function is the str_len you need for the entire rr. It does not include the 0 byte at the end.
str_len	the size of the string buffer. If more is needed, it'll silently truncate the output to fit in the buffer.

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

References sldns_wire2str_rr_unknown_scan().

◆ sldns_wire2str_rr_comment_buf()

int sldns_wire2str_rr_comment_buf	(	uint8_t *	rr,
		size_t	rr_len,
		size_t	dname_len,
		char *	str,
		size_t	str_len
	)

This creates the comment to print after the RR.

; keytag=... , and other basic comments for RRs. There are more format and comment options available for printout with the function: TBD(TODO)

Parameters

rr	wireformat RR data
rr_len	length of the rr wire data.
dname_len	length of the dname in front of the RR.
str	the string buffer to write to. If you pass NULL as the str, the return value of the function is the str_len you need for the entire comment. It does not include the 0 byte at the end.
str_len	the size of the string buffer. If more is needed, it'll silently truncate the output to fit in the buffer.

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

References sldns_wire2str_rr_comment_print(), and sldns_wirerr_get_type().

◆ sldns_wire2str_type_buf()

int sldns_wire2str_type_buf	(	uint16_t	rrtype,
		char *	str,
		size_t	len
	)

Convert wire RR type to a string, 'MX', 'TYPE12'.

With user buffer.

Parameters

rrtype	the RR type in host order.
str	the string to write to.
len	length of str.

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

References sldns_wire2str_type_print().

Referenced by auth_zone_generate_answer(), do_print(), errinf_rrset(), errinf_to_str_bogus(), errinf_to_str_servfail(), infra_ratelimit_inc(), pretty_type(), sldns_wire2str_type(), and zonemd_dnssec_verify_rrset().

◆ sldns_wire2str_class_buf()

int sldns_wire2str_class_buf	(	uint16_t	rrclass,
		char *	str,
		size_t	len
	)

Convert wire RR class to a string, 'IN', 'CLASS12'.

With user buffer.

Parameters

rrclass	the RR class in host order.
str	the string to write to.
len	length of str.

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

References sldns_wire2str_class_print().

Referenced by errinf_rrset(), errinf_to_str_bogus(), errinf_to_str_servfail(), infra_ratelimit_inc(), pretty_class(), and sldns_wire2str_class().

◆ sldns_wire2str_rcode_buf()

int sldns_wire2str_rcode_buf	(	int	rcode,
		char *	str,
		size_t	len
	)

Convert wire RR rcode to a string, 'NOERROR', 'NXDOMAIN'.

With user buffer.

Parameters

rcode	rcode as integer in host order
str	the string to write to.
len	length of str.

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

References sldns_wire2str_rcode_print().

Referenced by entry_to_repinfo(), errinf_reply(), log_reply_info(), perftestpkt(), pr_flags(), pretty_rcode(), sldns_wire2str_rcode(), and testpkt().

◆ sldns_wire2str_opcode_buf()

int sldns_wire2str_opcode_buf	(	int	opcode,
		char *	str,
		size_t	len
	)

Convert host format opcode to a string.

'QUERY', 'NOTIFY', 'UPDATE'. With user buffer.

Parameters

opcode	opcode as integer in host order
str	the string to write to.
len	length of str.

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

References sldns_wire2str_opcode_print().

◆ sldns_wire2str_dname_buf()

int sldns_wire2str_dname_buf	(	uint8_t *	dname,
		size_t	dname_len,
		char *	str,
		size_t	len
	)

Convert wire dname to a string, "example.com.".

With user buffer.

Parameters

dname	the dname in uncompressed wireformat.
dname_len	length of the dname.
str	the string to write to.
len	length of string.

Returns: the number of characters for this element, excluding zerobyte. Is larger or equal than str_len if output was truncated.

References sldns_wire2str_dname_scan().

Referenced by auth_zone_generate_answer(), and sldns_wire2str_dname().

◆ sldns_str_vprint()

int sldns_str_vprint	(	char **	str,
		size_t *	slen,
		const char *	format,
		va_list	args
	)

Print to string, move string along for next content.

With va_list.

Parameters

str	string buffer. Adjusted at end to after the output.
slen	length of the string buffer. Adjusted at end.
format	printf format string.
args	arguments for printf.

Returns: number of characters needed. Can be larger than slen.

◆ sldns_wire2str_pkt_scan()

int sldns_wire2str_pkt_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

Scan wireformat packet to a string representation with user buffer It appends every RR with default comments.

For more formatter options use the function: TBD(TODO)

Parameters

data	wireformat packet data (starting at ID bytes).
data_len	length of packet.
str	the string buffer for the output.
str_len	the size of the string buffer.

Returns: number of characters for string. returns the number of characters that are needed (except terminating null), so it may return a value larger than str_len. On error you get less output (i.e. shorter output in str (null terminated)) On exit the data, data_len, str and str_len values are adjusted to move them from their original position along the input and output for the content that has been consumed (and produced) by this function. If the end of the output string is reached, *str_len is set to 0. The output string is null terminated (shortening the output if necessary). If the end of the input is reached *data_len is set to 0.

Referenced by sldns_wire2str_pkt_buf().

◆ sldns_wire2str_rr_scan()

int sldns_wire2str_rr_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len,
		uint8_t *	pkt,
		size_t	pktlen,
		int *	comprloop
	)

Scan wireformat rr to string, with user buffers.

It shifts the arguments to move along (see sldns_wire2str_pkt_scan).

Parameters

data	wireformat data.
data_len	length of data buffer.
str	string buffer.
str_len	length of string buffer.
pkt	packet for decompression, if NULL no decompression.
pktlen	length of packet buffer.
comprloop	if pkt, bool detects compression loops.

Returns: number of characters (except null) needed to print.

Referenced by sldns_wire2str_rr_buf().

◆ sldns_wire2str_rrquestion_scan()

int sldns_wire2str_rrquestion_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len,
		uint8_t *	pkt,
		size_t	pktlen,
		int *	comprloop
	)

Scan wireformat question rr to string, with user buffers.

It shifts the arguments to move along (see sldns_wire2str_pkt_scan).

Parameters

data	wireformat data.
data_len	length of data buffer.
str	string buffer.
str_len	length of string buffer.
pkt	packet for decompression, if NULL no decompression.
pktlen	length of packet buffer.
comprloop	if pkt, bool detects compression loops.

Returns: number of characters (except null) needed to print.

References print_remainder_hex(), sldns_str_print(), and sldns_wire2str_dname_scan().

Referenced by sldns_wire2str_rrquestion_buf().

◆ sldns_wire2str_rr_unknown_scan()

int sldns_wire2str_rr_unknown_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len,
		uint8_t *	pkt,
		size_t	pktlen,
		int *	comprloop
	)

Scan wireformat RR to string in unknown RR format, with user buffers.

It shifts the arguments to move along (see sldns_wire2str_pkt_scan).

Parameters

data	wireformat data.
data_len	length of data buffer.
str	string buffer.
str_len	length of string buffer.
pkt	packet for decompression, if NULL no decompression.
pktlen	length of packet buffer.
comprloop	if pkt, bool detects compression loops.

Returns: number of characters (except null) needed to print.

References print_remainder_hex(), sldns_rr_tcttl_scan(), sldns_str_print(), and sldns_wire2str_dname_scan().

Referenced by sldns_wire2str_rr_unknown_buf().

◆ sldns_wire2str_rr_comment_print()

int sldns_wire2str_rr_comment_print	(	char **	str,
		size_t *	str_len,
		uint8_t *	rr,
		size_t	rrlen,
		size_t	dname_off,
		uint16_t	rrtype
	)

Print to string the RR-information comment in default format, with user buffers.

Moves string along.

Parameters

str	string buffer.
str_len	length of string buffer.
rr	wireformat data.
rrlen	length of data buffer.
dname_off	offset in buffer behind owner dname, the compressed size of the owner name.
rrtype	type of the RR, host format.

Returns: number of characters (except null) needed to print.

Referenced by sldns_wire2str_rr_comment_buf().

◆ sldns_wire2str_header_scan()

int sldns_wire2str_header_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

Scan wireformat packet header to string, with user buffers.

It shifts the arguments to move along (see sldns_wire2str_pkt_scan).

Parameters

data	wireformat data.
data_len	length of data buffer.
str	string buffer.
str_len	length of string buffer.

Returns: number of characters (except null) needed to print.

References print_remainder_hex(), and sldns_str_print().

◆ sldns_wire2str_rdata_scan()

int sldns_wire2str_rdata_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len,
		uint16_t	rrtype,
		uint8_t *	pkt,
		size_t	pktlen,
		int *	comprloop
	)

Scan wireformat rdata to string, with user buffers.

It shifts the arguments to move along (see sldns_wire2str_pkt_scan).

Parameters

data	wireformat data.
data_len	length of data buffer. The length of the rdata in the buffer. The rdatalen itself has already been scanned, the data points to the rdata after the rdatalen.
str	string buffer.
str_len	length of string buffer.
rrtype	RR type of Rdata, host format.
pkt	packet for decompression, if NULL no decompression.
pktlen	length of packet buffer.
comprloop	if pkt, bool detects compression loops.

Returns: number of characters (except null) needed to print.

References sldns_rr_descript(), sldns_rr_descriptor_field_type(), sldns_rr_descriptor_maximum(), sldns_rr_descriptor_minimum(), sldns_str_print(), sldns_wire2str_rdata_unknown_scan(), and sldns_wire2str_rdf_scan().

Referenced by auth_rr_to_string().

◆ sldns_wire2str_rdata_unknown_scan()

int sldns_wire2str_rdata_unknown_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

Scan wireformat rdata to string in unknown format, with user buffers.

It shifts the arguments to move along (see sldns_wire2str_pkt_scan).

Parameters

data	wireformat data.
data_len	length of data buffer, the length of the rdata in buffer.
str	string buffer.
str_len	length of string buffer.

Returns: number of characters (except null) needed to print.

References print_hex_buf(), and sldns_str_print().

Referenced by sldns_wire2str_rdata_scan(), and sldns_wire2str_unknown_scan().

◆ sldns_wire2str_dname_scan()

int sldns_wire2str_dname_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len,
		uint8_t *	pkt,
		size_t	pktlen,
		int *	comprloop
	)

Scan wireformat domain name to string, with user buffers.

It shifts the arguments to move along (see sldns_wire2str_pkt_scan).

Parameters

data	wireformat data.
data_len	length of data buffer.
str	string buffer.
str_len	length of string buffer.
pkt	packet for decompression, if NULL no decompression.
pktlen	length of packet buffer.
comprloop	inout bool, that is set true if compression loop failure happens. Pass in 0, if passsed in as true, a lower bound is set on compression loops to stop arbitrary long packet parse times. This is meant so you can set it to 0 at the start of a list of dnames, and then scan all of them in sequence, if a loop happens, it becomes true and then it becomes more strict for the next dnames in the list. You can leave it at NULL if there is no pkt (pkt is NULL too).

Returns: number of characters (except null) needed to print.

References dname_char_print(), LDNS_MAX_DOMAINLEN, MAX_COMPRESS_PTRS, and sldns_str_print().

Referenced by auth_rr_to_string(), equal_dname(), sldns_wire2str_dname_buf(), sldns_wire2str_rdf_scan(), sldns_wire2str_rr_unknown_scan(), sldns_wire2str_rrquestion_scan(), and subdomain_dname().

◆ sldns_wire2str_opcode_print()

int sldns_wire2str_opcode_print	(	char **	str,
		size_t *	str_len,
		int	opcode
	)

Print host format opcode to string.

Moves string along, user buffers.

Parameters

str	string buffer.
str_len	length of string buffer.
opcode	host format opcode number.

Returns: number of characters (except null) needed to print.

References sldns_lookup_by_id(), sldns_opcodes, and sldns_str_print().

Referenced by sldns_wire2str_opcode_buf().

◆ sldns_wire2str_rcode_print()

int sldns_wire2str_rcode_print	(	char **	str,
		size_t *	str_len,
		int	rcode
	)

Print host format rcode to string.

Moves string along, user buffers.

Parameters

str	string buffer.
str_len	length of string buffer.
rcode	host format rcode number.

Returns: number of characters (except null) needed to print.

References sldns_lookup_by_id(), sldns_rcodes, and sldns_str_print().

Referenced by sldns_wire2str_rcode_buf().

◆ sldns_wire2str_class_print()

int sldns_wire2str_class_print	(	char **	str,
		size_t *	str_len,
		uint16_t	rrclass
	)

Print host format rr class to string.

Moves string along, user buffers.

Parameters

str	string buffer.
str_len	length of string buffer.
rrclass	host format rr class.

Returns: number of characters (except null) needed to print.

References sldns_lookup_by_id(), sldns_rr_classes, and sldns_str_print().

Referenced by auth_rr_to_string(), and sldns_wire2str_class_buf().

◆ sldns_wire2str_type_print()

int sldns_wire2str_type_print	(	char **	str,
		size_t *	str_len,
		uint16_t	rrtype
	)

Print host format rr type to string.

Moves string along, user buffers.

Parameters

str	string buffer.
str_len	length of string buffer.
rrtype	host format rr type.

Returns: number of characters (except null) needed to print.

References sldns_struct_rr_descriptor::_name, sldns_rr_descript(), and sldns_str_print().

Referenced by auth_rr_to_string(), sldns_wire2str_nsec_scan(), and sldns_wire2str_type_buf().

◆ sldns_wire2str_edns_option_code_print()

int sldns_wire2str_edns_option_code_print	(	char **	str,
		size_t *	str_len,
		uint16_t	opcode
	)

Print host format EDNS0 option to string.

Moves string along, user buffers.

Parameters

str	string buffer.
str_len	length of string buffer.
opcode	host format option number.

Returns: number of characters (except null) needed to print.

References sldns_edns_options, sldns_lookup_by_id(), and sldns_str_print().

Referenced by sldns_wire2str_edns_option_print().

◆ sldns_wire2str_class_scan()

int sldns_wire2str_class_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

Scan wireformat rr class to string, with user buffers.

It shifts the arguments to move along (see sldns_wire2str_pkt_scan).

Parameters

data	wireformat data.
data_len	length of data buffer.
str	string buffer.
str_len	length of string buffer.

Returns: number of characters (except null) needed to print.

int sldns_wire2str_type_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_ttl_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_svcparam_scan	(	uint8_t **	d,
		size_t *	dlen,
		char **	s,
		size_t *	slen
	)

d	the SVCB data in uncompressed wireformat.
dlen	length of the SVCB data.
s	the string to write to.
slen	length of string.

int sldns_wire2str_rdf_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len,
		int	rdftype,
		uint8_t *	pkt,
		size_t	pktlen,
		int *	comprloop
	)

int sldns_wire2str_int8_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_int16_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_int32_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_period_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_tsigtime_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_a_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_aaaa_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_str_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_apl_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_b32_ext_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_b64_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_hex_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_nsec_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_nsec3_salt_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_cert_alg_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

Functions

Variables

Detailed Description

Function Documentation

◆ sldns_wire2str_pkt()

◆ sldns_wire2str_rr()

◆ sldns_wire2str_type()

◆ sldns_wire2str_class()

◆ sldns_wire2str_dname()

◆ sldns_wire2str_rcode()

◆ sldns_wire2str_pkt_buf()

◆ sldns_wire2str_rr_buf()

◆ sldns_wire2str_rrquestion_buf()

◆ sldns_wire2str_rdata_buf()

◆ sldns_wire2str_rr_unknown_buf()

◆ sldns_wire2str_rr_comment_buf()

◆ sldns_wire2str_type_buf()

◆ sldns_wire2str_class_buf()

◆ sldns_wire2str_rcode_buf()

◆ sldns_wire2str_opcode_buf()

◆ sldns_wire2str_dname_buf()

◆ sldns_str_vprint()

◆ sldns_wire2str_pkt_scan()

◆ sldns_wire2str_rr_scan()

◆ sldns_wire2str_rrquestion_scan()

◆ sldns_wire2str_rr_unknown_scan()

◆ sldns_wire2str_rr_comment_print()

◆ sldns_wire2str_header_scan()

◆ sldns_wire2str_rdata_scan()

◆ sldns_wire2str_rdata_unknown_scan()

◆ sldns_wire2str_dname_scan()

◆ sldns_wire2str_opcode_print()

◆ sldns_wire2str_rcode_print()

◆ sldns_wire2str_class_print()

◆ sldns_wire2str_type_print()

◆ sldns_wire2str_edns_option_code_print()

◆ sldns_wire2str_class_scan()

◆ sldns_wire2str_type_scan()

◆ sldns_wire2str_ttl_scan()

◆ sldns_wire2str_svcparam_scan()

◆ sldns_wire2str_rdf_scan()

◆ sldns_wire2str_int8_scan()

◆ sldns_wire2str_int16_scan()

◆ sldns_wire2str_int32_scan()

◆ sldns_wire2str_period_scan()

◆ sldns_wire2str_tsigtime_scan()

◆ sldns_wire2str_a_scan()

◆ sldns_wire2str_aaaa_scan()

◆ sldns_wire2str_str_scan()

◆ sldns_wire2str_apl_scan()

◆ sldns_wire2str_b32_ext_scan()

◆ sldns_wire2str_b64_scan()

◆ sldns_wire2str_hex_scan()

◆ sldns_wire2str_nsec_scan()

◆ sldns_wire2str_nsec3_salt_scan()

◆ sldns_wire2str_cert_alg_scan()

◆ sldns_wire2str_alg_scan()

◆ sldns_wire2str_unknown_scan()

◆ sldns_wire2str_time_scan()

◆ sldns_wire2str_loc_scan()

◆ sldns_wire2str_wks_scan()

◆ sldns_wire2str_nsap_scan()

◆ sldns_wire2str_atma_scan()

◆ sldns_wire2str_ipseckey_scan()

◆ sldns_wire2str_hip_scan()

◆ sldns_wire2str_int16_data_scan()

◆ sldns_wire2str_nsec3_next_owner_scan()

◆ sldns_wire2str_ilnp64_scan()

◆ sldns_wire2str_eui48_scan()

◆ sldns_wire2str_eui64_scan()

◆ sldns_wire2str_tag_scan()

◆ sldns_wire2str_long_str_scan()

◆ sldns_wire2str_tsigerror_scan()

◆ sldns_wire2str_edns_llq_print()

◆ sldns_wire2str_edns_ul_print()

◆ sldns_wire2str_edns_nsid_print()

◆ sldns_wire2str_edns_dau_print()

◆ sldns_wire2str_edns_dhu_print()

◆ sldns_wire2str_edns_n3u_print()

◆ sldns_wire2str_edns_subnet_print()

int sldns_wire2str_alg_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_unknown_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_time_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_loc_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_wks_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_nsap_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_atma_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_ipseckey_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len,
		uint8_t *	pkt,
		size_t	pktlen,
		int *	comprloop
	)

int sldns_wire2str_hip_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)

int sldns_wire2str_int16_data_scan	(	uint8_t **	data,
		size_t *	data_len,
		char **	str,
		size_t *	str_len
	)