File Manager

X7ROOT File Manager

Current Path: /usr/include/bind9/dns

ðŸ“ ..
ðŸ“„ acache.h(13.9 KB)
ðŸ“„ acl.h(7.07 KB)
ðŸ“„ adb.h(22.07 KB)
ðŸ“„ badcache.h(3.29 KB)
ðŸ“„ bit.h(807 B)
ðŸ“„ byaddr.h(3.91 KB)
ðŸ“„ cache.h(8.44 KB)
ðŸ“„ callbacks.h(2.22 KB)
ðŸ“„ catz.h(11.56 KB)
ðŸ“„ cert.h(1.43 KB)
ðŸ“„ client.h(21.53 KB)
ðŸ“„ clientinfo.h(1.96 KB)
ðŸ“„ compress.h(6.49 KB)
ðŸ“„ db.h(45.48 KB)
ðŸ“„ dbiterator.h(7.25 KB)
ðŸ“„ dbtable.h(3.09 KB)
ðŸ“„ diff.h(6.82 KB)
ðŸ“„ dispatch.h(16.04 KB)
ðŸ“„ dlz.h(10.37 KB)
ðŸ“„ dlz_dlopen.h(4.57 KB)
ðŸ“„ dns64.h(5.5 KB)
ðŸ“„ dnssec.h(11.83 KB)
ðŸ“„ dnstap.h(9.14 KB)
ðŸ“„ ds.h(1.2 KB)
ðŸ“„ dsdigest.h(1.68 KB)
ðŸ“„ dyndb.h(4.72 KB)
ðŸ“„ ecdb.h(809 B)
ðŸ“„ edns.h(722 B)
ðŸ“„ enumclass.h(1.19 KB)
ðŸ“„ enumtype.h(8.11 KB)
ðŸ“„ events.h(3.96 KB)
ðŸ“„ fixedname.h(1.62 KB)
ðŸ“„ forward.h(3.37 KB)
ðŸ“„ geoip.h(2.73 KB)
ðŸ“„ ipkeylist.h(2.13 KB)
ðŸ“„ iptable.h(1.58 KB)
ðŸ“„ journal.h(8.03 KB)
ðŸ“„ keydata.h(1.03 KB)
ðŸ“„ keyflags.h(1.25 KB)
ðŸ“„ keytable.h(9.24 KB)
ðŸ“„ keyvalues.h(4.06 KB)
ðŸ“„ lib.h(1.16 KB)
ðŸ“„ log.h(3.87 KB)
ðŸ“„ lookup.h(2.86 KB)
ðŸ“„ master.h(11.02 KB)
ðŸ“„ masterdump.h(12.35 KB)
ðŸ“„ message.h(37.92 KB)
ðŸ“„ name.h(36.25 KB)
ðŸ“„ ncache.h(4.81 KB)
ðŸ“„ nsec.h(2.86 KB)
ðŸ“„ nsec3.h(7.84 KB)
ðŸ“„ nta.h(4.44 KB)
ðŸ“„ opcode.h(1007 B)
ðŸ“„ order.h(1.95 KB)
ðŸ“„ peer.h(5.83 KB)
ðŸ“„ portlist.h(2.05 KB)
ðŸ“„ private.h(1.89 KB)
ðŸ“„ rbt.h(39.67 KB)
ðŸ“„ rcode.h(2.42 KB)
ðŸ“„ rdata.h(21.11 KB)
ðŸ“„ rdataclass.h(2.2 KB)
ðŸ“„ rdatalist.h(2.51 KB)
ðŸ“„ rdataset.h(21.03 KB)
ðŸ“„ rdatasetiter.h(3.83 KB)
ðŸ“„ rdataslab.h(4.28 KB)
ðŸ“„ rdatastruct.h(60.14 KB)
ðŸ“„ rdatatype.h(2.24 KB)
ðŸ“„ request.h(10.89 KB)
ðŸ“„ resolver.h(19.75 KB)
ðŸ“„ result.h(9.07 KB)
ðŸ“„ rootns.h(892 B)
ðŸ“„ rpz.h(10.09 KB)
ðŸ“„ rriterator.h(4.13 KB)
ðŸ“„ rrl.h(6.48 KB)
ðŸ“„ sdb.h(7.05 KB)
ðŸ“„ sdlz.h(13.88 KB)
ðŸ“„ secalg.h(1.67 KB)
ðŸ“„ secproto.h(1.52 KB)
ðŸ“„ soa.h(2.13 KB)
ðŸ“„ ssu.h(8.11 KB)
ðŸ“„ stats.h(13.14 KB)
ðŸ“„ tcpmsg.h(3.07 KB)
ðŸ“„ time.h(1.66 KB)
ðŸ“„ timer.h(1.03 KB)
ðŸ“„ tkey.h(7.45 KB)
ðŸ“„ tsec.h(2.88 KB)
ðŸ“„ tsig.h(8.19 KB)
ðŸ“„ ttl.h(1.9 KB)
ðŸ“„ types.h(13.83 KB)
ðŸ“„ update.h(1.61 KB)
ðŸ“„ validator.h(6.99 KB)
ðŸ“„ version.h(868 B)
ðŸ“„ view.h(34.45 KB)
ðŸ“„ xfrin.h(2.86 KB)
ðŸ“„ zone.h(59.44 KB)
ðŸ“„ zonekey.h(777 B)
ðŸ“„ zt.h(5.43 KB)

Editing: dnstap.h

/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * 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.
 */

#ifndef _DNSTAP_H
#define _DNSTAP_H

/*****
 ***** Module Info
 *****/

/*! \file
 * \brief
 * The dt (dnstap) module provides fast passive logging of DNS messages.
 * Protocol Buffers.  The protobuf schema for Dnstap messages is in the
 * file dnstap.proto, which is compiled to dnstap.pb-c.c and dnstap.pb-c.h.
 */

#include <inttypes.h>
#include <stdbool.h>

#ifdef HAVE_DNSTAP
#include <fstrm.h>
#include <protobuf-c/protobuf-c.h>
#else
struct fstrm_iothr_options;
#endif /* HAVE_DNSTAP */

#include <isc/region.h>
#include <isc/sockaddr.h>
#include <isc/time.h>
#include <isc/types.h>

#include <dns/name.h>
#include <dns/rdataclass.h>
#include <dns/rdatatype.h>
#include <dns/types.h>

/*%
 * Dnstap message types:
 *
 * STUB QUERY: SQ
 * STUB RESPONSE: SR
 * CLIENT QUERY: CQ
 * CLIENT RESPONSE: CR
 * AUTH QUERY: AQ
 * AUTH RESPONSE: AR
 * RESOLVER QUERY: RQ
 * RESOLVER RESPONSE: RR
 * FORWARDER QUERY: FQ
 * FORWARDER RESPONSE: FR
 */

#define DNS_DTTYPE_SQ 0x0001
#define DNS_DTTYPE_SR 0x0002
#define DNS_DTTYPE_CQ 0x0004
#define DNS_DTTYPE_CR 0x0008
#define DNS_DTTYPE_AQ 0x0010
#define DNS_DTTYPE_AR 0x0020
#define DNS_DTTYPE_RQ 0x0040
#define DNS_DTTYPE_RR 0x0080
#define DNS_DTTYPE_FQ 0x0100
#define DNS_DTTYPE_FR 0x0200
#define DNS_DTTYPE_TQ 0x0400
#define DNS_DTTYPE_TR 0x0800

typedef enum {
	dns_dtmode_none = 0,
	dns_dtmode_file,
	dns_dtmode_unix
} dns_dtmode_t;

typedef struct dns_dthandle dns_dthandle_t;

#ifdef HAVE_DNSTAP
struct dns_dtdata {
	isc_mem_t *mctx;

void *frame;

bool query;
	bool tcp;
	dns_dtmsgtype_t type;

isc_time_t qtime;
	isc_time_t rtime;

isc_region_t qaddr;
	isc_region_t raddr;

uint32_t qport;
	uint32_t rport;

isc_region_t msgdata;
	dns_message_t *msg;

char namebuf[DNS_NAME_FORMATSIZE];
	char typebuf[DNS_RDATATYPE_FORMATSIZE];
	char classbuf[DNS_RDATACLASS_FORMATSIZE];
};
#endif /* HAVE_DNSTAP */

isc_result_t
dns_dt_create(isc_mem_t *mctx, dns_dtmode_t mode, const char *path,
	      struct fstrm_iothr_options **foptp, dns_dtenv_t **envp);
/*%<
 * Create and initialize the dnstap environment.
 *
 * There should be a single global dnstap environment for the server;
 * copies of it will be attached to each view.
 *
 * Notes:
 *
 *\li	'path' refers to a UNIX domain socket by default. It may
 *	optionally be prepended with "socket:" or "file:". If prepended
 *	with "file:", then dnstap logs are sent to a file instead of a
 *	socket.
 *
 *\li	'*foptp' set the options for fstrm_iothr_init(). '*foptp' must have
 *	have had the number of input queues set and this should be set
 *	to the number of worker threads.  Additionally the queue model
 *	should also be set.  Other options may be set if desired.
 *	If dns_dt_create succeeds the *foptp is set to NULL.
 *
 * Requires:
 *
 *\li	'mctx' is a valid memory context.
 *
 *\li	'path' is a valid C string.
 *
 *\li	'fopt' is non NULL.
 *
 *\li	envp != NULL && *envp == NULL
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOMEMORY
 *
 *\li	Other errors are possible.
 */

isc_result_t
dns_dt_reopen(dns_dtenv_t *env, int roll);
/*%<
 * Reopens files established by dns_dt_create().
 *
 * If 'roll' is non-negative and 'env->mode' is dns_dtmode_file,
 * then the file is automatically rolled over before reopening.
 * The value of 'roll' indicates the number of backup log files to
 * keep.  If 'roll' is negative, or if 'env->mode' is dns_dtmode_unix,
 * then the channel is simply reopened.
 *
 * Note: dns_dt_reopen() must be called in task exclusive mode.
 *
 * Requires:
 *\li	'env' is a valid dnstap environment.
 */

isc_result_t
dns_dt_setidentity(dns_dtenv_t *env, const char *identity);
isc_result_t
dns_dt_setversion(dns_dtenv_t *env, const char *version);
/*%<
 * Set the "identity" and "version" strings to be sent in dnstap messages.
 *
 * Requires:
 *
 *\li	'env' is a valid dnstap environment.
 */

void
dns_dt_attach(dns_dtenv_t *source, dns_dtenv_t **destp);
/*%<
 * Attach '*destp' to 'source', incrementing the reference counter.
 *
 * Requires:
 *
 *\li	'source' is a valid dnstap environment.
 *
 *\li	'destp' is not NULL and '*destp' is NULL.
 *
 *\li	*destp is attached to source.
 */

void
dns_dt_detach(dns_dtenv_t **envp);
/*%<
 * Detach '*envp', decrementing the reference counter.
 *
 * Requires:
 *
 *\li	'*envp' is a valid dnstap environment.
 *
 * Ensures:
 *
 *\li	'*envp' will be destroyed when the number of references reaches zero.
 *
 *\li	'*envp' is NULL.
 */

isc_result_t
dns_dt_getstats(dns_dtenv_t *env, isc_stats_t **statsp);
/*%<
 * Attach to the stats struct if it exists.
 *
 * Requires:
 *
 *\li	'env' is a valid dnstap environment.
 *
 *\li	'statsp' is non NULL and '*statsp' is NULL.
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *
 *\li	ISC_R_NOTFOUND
 */

void
dns_dt_shutdown(void);
/*%<
 * Shuts down dnstap and frees global resources. This function must only
 * be called immediately before server shutdown.
 */

void
dns_dt_send(dns_view_t *view, dns_dtmsgtype_t msgtype,
	    isc_sockaddr_t *qaddr, isc_sockaddr_t *dstaddr,
	    bool tcp, isc_region_t *zone, isc_time_t *qtime,
	    isc_time_t *rtime, isc_buffer_t *buf);
/*%<
 * Sends a dnstap message to the log, if 'msgtype' is one of the message
 * types represented in 'view->dttypes'.
 *
 * Parameters are: 'qaddr' (query address, i.e, the address of the
 * query initiator); 'raddr' (response address, i.e., the address of
 * the query responder); 'tcp' (boolean indicating whether the transaction
 * was over TCP); 'zone' (the authoritative zone or bailiwick, in
 * uncompressed wire format), 'qtime' and 'rtime' (query and response
 * times; if NULL, they are set to the current time); and 'buf' (the
 * DNS message being logged, in wire format).
 *
 * Requires:
 *
 *\li	'view' is a valid view, and 'view->dtenv' is NULL or is a
 *	valid dnstap environment.
 */

isc_result_t
dns_dt_parse(isc_mem_t *mctx, isc_region_t *src, dns_dtdata_t **destp);
/*%<
 * Converts a raw dnstap frame in 'src' to a parsed dnstap data structure
 * in '*destp'.
 *
 * Requires:
 *\li	'src' is not NULL
 *
 *\li	'destp' is not NULL and '*destp' points to a valid buffer.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS on success
 *
 *\li	Other errors are possible.
 */

isc_result_t
dns_dt_datatotext(dns_dtdata_t *d, isc_buffer_t **dest);
/*%<
 * Converts a parsed dnstap data structure 'd' to text, storing
 * the result in the buffer 'dest'.  If 'dest' points to a dynamically
 * allocated buffer, then it may be reallocated as needed.
 *
 * (XXX: add a 'long_form' option to generate a detailed listing of
 * dnstap data instead * of a one-line summary.)
 *
 * Requires:
 *\li	'd' is not NULL
 *
 *\li	'dest' is not NULL and '*dest' points to a valid buffer.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS on success
 *\li	#ISC_R_NOSPACE if buffer is not dynamic and runs out of space
 *\li	#ISC_R_NOMEMORY if buffer is dynamic but memory could not be allocated
 *
 *\li	Other errors are possible.
 */

void
dns_dtdata_free(dns_dtdata_t **dp);
/*%<
 * Frees the specified dns_dtdata structure and all its members,
 * and sets *dp to NULL.
 */

isc_result_t
dns_dt_open(const char *filename, dns_dtmode_t mode,
	    isc_mem_t *mctx, dns_dthandle_t **handlep);
/*%<
 * Opens a dnstap framestream at 'filename' and stores a pointer to the
 * reader object in a dns_dthandle_t structure.
 *
 * The caller is responsible for allocating the handle structure.
 *
 * (XXX: Currently only file readers are supported, not unix-domain socket
 * readers.)
 *
 * Requires:
 *
 *\li	'filename' is not NULL.
 *
 *\li	'handlep' is not NULL and '*handlep' is NULL.
 *
 *\li	'*mctx' is not a valid memory context.
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS on success
 *\li	#ISC_R_NOTIMPLEMENTED if 'mode' is not dns_dtmode_file. (XXX)
 *\li	#ISC_R_NOMEMORY if the fstrm library was unable to allocate a
 *      reader or options structure
 *\li	#ISC_R_FAILURE if 'filename' could not be opened.
 *\li	#DNS_R_BADDNSTAP if 'filename' does not contain a dnstap
 *      framestream.
 */

isc_result_t
dns_dt_getframe(dns_dthandle_t *handle, uint8_t **bufp, size_t *sizep);
/*%<
 * Read a dnstap frame from the framstream reader in 'handle', storing
 * a pointer to it in '*bufp' and its size in '*sizep'.
 *
 * Requires:
 *
 *\li	'handle' is not NULL
 *\li	'bufp' is not NULL
 *\li	'sizep' is not NULL
 *
 * Ensures:
 * \li	if returning ISC_R_SUCCESS then '*bufp' is not NULL
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS on success
 *\li	#ISC_R_NOMORE at the end of the frame stream
 *\li	#ISC_R_FAILURE for any other failure
 */

void
dns_dt_close(dns_dthandle_t **handlep);
/*%<
 * Closes the dnstap file referenced by 'handle'.
 *
 * Requires:
 *
 *\li	'*handlep' is not NULL
 */

#endif /* _DNSTAP_H */

X7ROOT File Manager

Editing: dnstap.h

Upload File

Create Folder