OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	11/10/2025 03:35:42 AM	rwxr-xr-x
📄 acl.h	6.33 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 adb.h	21.75 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 badcache.h	3.31 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 bit.h	798 bytes	11/05/2021 09:03:26 AM	rw-r--r--
📄 byaddr.h	3.51 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 cache.h	8.53 KB	11/10/2025 03:33:48 AM	rw-r--r--
📄 callbacks.h	2.23 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 catz.h	11.6 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 cert.h	1.43 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 client.h	14.19 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 clientinfo.h	1.97 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 compress.h	6.88 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 db.h	49.26 KB	11/10/2025 03:33:48 AM	rw-r--r--
📄 dbiterator.h	7.21 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 dbtable.h	3.09 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 diff.h	6.87 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 dispatch.h	15.17 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 dlz.h	10.62 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 dlz_dlopen.h	4.29 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 dns64.h	5.59 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 dnsrps.h	2.51 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 dnssec.h	12.29 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 dnstap.h	9.95 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 ds.h	1.63 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 dsdigest.h	1.67 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 dyndb.h	4.75 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 ecdb.h	806 bytes	11/05/2021 09:03:26 AM	rw-r--r--
📄 ecs.h	1.22 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 edns.h	783 bytes	11/05/2021 09:03:26 AM	rw-r--r--
📄 enumclass.h	1.19 KB	11/10/2025 03:34:13 AM	rw-r--r--
📄 enumtype.h	8.29 KB	11/10/2025 03:34:13 AM	rw-r--r--
📄 events.h	4.35 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 fixedname.h	1.61 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 forward.h	2.99 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 geoip.h	2.29 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 ipkeylist.h	2.17 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 iptable.h	1.49 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 journal.h	9.48 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 kasp.h	11.84 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 keydata.h	1.02 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 keyflags.h	1.25 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 keymgr.h	4.01 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 keytable.h	7.69 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 keyvalues.h	3.99 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 lib.h	993 bytes	11/05/2021 09:03:26 AM	rw-r--r--
📄 librpz.h	30.67 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 lmdb.h	779 bytes	11/05/2021 09:03:26 AM	rw-r--r--
📄 log.h	3.93 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 lookup.h	2.85 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 master.h	8.58 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 masterdump.h	9.9 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 message.h	38.64 KB	11/10/2025 03:33:48 AM	rw-r--r--
📄 name.h	36.9 KB	11/10/2025 03:33:48 AM	rw-r--r--
📄 ncache.h	4.84 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 nsec.h	2.99 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 nsec3.h	8.06 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 nta.h	4.73 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 opcode.h	1006 bytes	11/05/2021 09:03:26 AM	rw-r--r--
📄 order.h	1.96 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 peer.h	6.32 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 portlist.h	2.05 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 private.h	1.92 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 rbt.h	36.61 KB	11/10/2025 03:33:48 AM	rw-r--r--
📄 rcode.h	2.41 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 rdata.h	22.04 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 rdataclass.h	2.2 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 rdatalist.h	2.5 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 rdataset.h	18.28 KB	11/10/2025 03:33:48 AM	rw-r--r--
📄 rdatasetiter.h	3.82 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 rdataslab.h	4.14 KB	11/10/2025 03:33:48 AM	rw-r--r--
📄 rdatastruct.h	61.23 KB	11/10/2025 03:34:13 AM	rw-r--r--
📄 rdatatype.h	2.24 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 request.h	8.97 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 resolver.h	19.68 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 result.h	8.98 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 rootns.h	891 bytes	11/05/2021 09:03:26 AM	rw-r--r--
📄 rpz.h	11.87 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 rriterator.h	4.12 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 rrl.h	6.8 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 sdb.h	7.18 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 sdlz.h	13.76 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 secalg.h	1.67 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 secproto.h	1.52 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 soa.h	2.13 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 ssu.h	7.01 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 stats.h	24.11 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 tcpmsg.h	3.05 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 time.h	1.65 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 timer.h	1.03 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 tkey.h	7.48 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 tsec.h	2.88 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 tsig.h	8.3 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 ttl.h	1.83 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 types.h	14.19 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 update.h	1.96 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 validator.h	6.52 KB	11/10/2025 03:33:48 AM	rw-r--r--
📄 version.h	679 bytes	11/05/2021 09:03:26 AM	rw-r--r--
📄 view.h	34.51 KB	11/10/2025 03:33:48 AM	rw-r--r--
📄 xfrin.h	2.26 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 zone.h	64.01 KB	11/10/2025 03:33:48 AM	rw-r--r--
📄 zonekey.h	776 bytes	11/05/2021 09:03:26 AM	rw-r--r--
📄 zoneverify.h	1.36 KB	11/05/2021 09:03:26 AM	rw-r--r--
📄 zt.h	5.12 KB	11/10/2025 03:33:48 AM	rw-r--r--

Editing: request.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 DNS_REQUEST_H
#define DNS_REQUEST_H 1

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

/*! \file dns/request.h
 *
 * \brief
 * The request module provides simple request/response services useful for
 * sending SOA queries, DNS Notify messages, and dynamic update requests.
 *
 * MP:
 *\li	The module ensures appropriate synchronization of data structures it
 *	creates and manipulates.
 *
 * Resources:
 *\li	TBS
 *
 * Security:
 *\li	No anticipated impact.
 */

#include <stdbool.h>

#include <isc/event.h>
#include <isc/lang.h>

#include <dns/types.h>

#define DNS_REQUESTOPT_TCP     0x00000001U
#define DNS_REQUESTOPT_CASE    0x00000002U
#define DNS_REQUESTOPT_FIXEDID 0x00000004U
#define DNS_REQUESTOPT_SHARE   0x00000008U

typedef struct dns_requestevent {
	ISC_EVENT_COMMON(struct dns_requestevent);
	isc_result_t   result;
	dns_request_t *request;
} dns_requestevent_t;

ISC_LANG_BEGINDECLS

isc_result_t
dns_requestmgr_create(isc_mem_t *mctx, isc_timermgr_t *timermgr,
		      isc_socketmgr_t *socketmgr, isc_taskmgr_t *taskmgr,
		      dns_dispatchmgr_t *dispatchmgr,
		      dns_dispatch_t *dispatchv4, dns_dispatch_t *dispatchv6,
		      dns_requestmgr_t **requestmgrp);
/*%<
 * Create a request manager.
 *
 * Requires:
 *
 *\li	'mctx' is a valid memory context.
 *
 *\li	'timermgr' is a valid timer manager.
 *
 *\li	'socketmgr' is a valid socket manager.
 *
 *\li	'taskmgr' is a valid task manager.
 *
 *\li	'dispatchv4' is a valid dispatcher with an IPv4 UDP socket, or is NULL.
 *
 *\li	'dispatchv6' is a valid dispatcher with an IPv6 UDP socket, or is NULL.
 *
 *\li	requestmgrp != NULL && *requestmgrp == NULL
 *
 * Ensures:
 *
 *\li	On success, *requestmgrp is a valid request manager.
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *
 *\li	Any other result indicates failure.
 */

void
dns_requestmgr_whenshutdown(dns_requestmgr_t *requestmgr, isc_task_t *task,
			    isc_event_t **eventp);
/*%<
 * Send '*eventp' to 'task' when 'requestmgr' has completed shutdown.
 *
 * Notes:
 *
 *\li	It is not safe to detach the last reference to 'requestmgr' until
 *	shutdown is complete.
 *
 * Requires:
 *
 *\li	'requestmgr' is a valid request manager.
 *
 *\li	'task' is a valid task.
 *
 *\li	*eventp is a valid event.
 *
 * Ensures:
 *
 *\li	*eventp == NULL.
 */

void
dns_requestmgr_shutdown(dns_requestmgr_t *requestmgr);
/*%<
 * Start the shutdown process for 'requestmgr'.
 *
 * Notes:
 *
 *\li	This call has no effect if the request manager is already shutting
 *	down.
 *
 * Requires:
 *
 *\li	'requestmgr' is a valid requestmgr.
 */

void
dns_requestmgr_attach(dns_requestmgr_t *source, dns_requestmgr_t **targetp);
/*%<
 *	Attach to the request manager.  dns_requestmgr_shutdown() must not
 *	have been called on 'source' prior to calling dns_requestmgr_attach().
 *
 * Requires:
 *
 *\li	'source' is a valid requestmgr.
 *
 *\li	'targetp' to be non NULL and '*targetp' to be NULL.
 */

void
dns_requestmgr_detach(dns_requestmgr_t **requestmgrp);
/*%<
 *	Detach from the given requestmgr.  If this is the final detach
 *	requestmgr will be destroyed.  dns_requestmgr_shutdown() must
 *	be called before the final detach.
 *
 * Requires:
 *
 *\li	'*requestmgrp' is a valid requestmgr.
 *
 * Ensures:
 *\li	'*requestmgrp' is NULL.
 */

isc_result_t
dns_request_create(dns_requestmgr_t *requestmgr, dns_message_t *message,
		   const isc_sockaddr_t *address, unsigned int options,
		   dns_tsigkey_t *key, unsigned int timeout, isc_task_t *task,
		   isc_taskaction_t action, void *arg,
		   dns_request_t **requestp);
/*%<
 * Create and send a request.
 *
 * Notes:
 *
 *\li	'message' will be rendered and sent to 'address'.  If the
 *	#DNS_REQUESTOPT_TCP option is set, TCP will be used,
 *	#DNS_REQUESTOPT_SHARE option is set too, connecting TCP
 *	(vs. connected) will be shared too.  The request
 *	will timeout after 'timeout' seconds.
 *
 *\li	If the #DNS_REQUESTOPT_CASE option is set, use case sensitive
 *	compression.
 *
 *\li	When the request completes, successfully, due to a timeout, or
 *	because it was canceled, a completion event will be sent to 'task'.
 *
 * Requires:
 *
 *\li	'message' is a valid DNS message.
 *
 *\li	'address' is a valid sockaddr.
 *
 *\li	'timeout' > 0
 *
 *\li	'task' is a valid task.
 *
 *\li	requestp != NULL && *requestp == NULL
 */

isc_result_t
dns_request_createvia(dns_requestmgr_t *requestmgr, dns_message_t *message,
		      const isc_sockaddr_t *srcaddr,
		      const isc_sockaddr_t *destaddr, isc_dscp_t dscp,
		      unsigned int options, dns_tsigkey_t *key,
		      unsigned int timeout, unsigned int udptimeout,
		      unsigned int udpretries, isc_task_t *task,
		      isc_taskaction_t action, void *arg,
		      dns_request_t **requestp);
/*%<
 * Create and send a request.
 *
 * Notes:
 *
 *\li	'message' will be rendered and sent to 'address'.  If the
 *	#DNS_REQUESTOPT_TCP option is set, TCP will be used,
 *	#DNS_REQUESTOPT_SHARE option is set too, connecting TCP
 *	(vs. connected) will be shared too.  The request
 *	will timeout after 'timeout' seconds.  UDP requests will be resent
 *	at 'udptimeout' intervals if non-zero or 'udpretries' is non-zero.
 *
 *\li	If the #DNS_REQUESTOPT_CASE option is set, use case sensitive
 *	compression.
 *
 *\li	When the request completes, successfully, due to a timeout, or
 *	because it was canceled, a completion event will be sent to 'task'.
 *
 * Requires:
 *
 *\li	'message' is a valid DNS message.
 *
 *\li	'dstaddr' is a valid sockaddr.
 *
 *\li	'srcaddr' is a valid sockaddr or NULL.
 *
 *\li	'srcaddr' and 'dstaddr' are the same protocol family.
 *
 *\li	'timeout' > 0
 *
 *\li	'task' is a valid task.
 *
 *\li	requestp != NULL && *requestp == NULL
 */

isc_result_t
dns_request_createraw(dns_requestmgr_t *requestmgr, isc_buffer_t *msgbuf,
		      const isc_sockaddr_t *srcaddr,
		      const isc_sockaddr_t *destaddr, isc_dscp_t dscp,
		      unsigned int options, unsigned int timeout,
		      unsigned int udptimeout, unsigned int udpretries,
		      isc_task_t *task, isc_taskaction_t action, void *arg,
		      dns_request_t **requestp);
/*!<
 * \brief Create and send a request.
 *
 * Notes:
 *
 *\li	'msgbuf' will be sent to 'destaddr' after setting the id.  If the
 *	#DNS_REQUESTOPT_TCP option is set, TCP will be used,
 *	#DNS_REQUESTOPT_SHARE option is set too, connecting TCP
 *	(vs. connected) will be shared too.  The request
 *	will timeout after 'timeout' seconds.   UDP requests will be resent
 *	at 'udptimeout' intervals if non-zero or if 'udpretries' is not zero.
 *
 *\li	When the request completes, successfully, due to a timeout, or
 *	because it was canceled, a completion event will be sent to 'task'.
 *
 * Requires:
 *
 *\li	'msgbuf' is a valid DNS message in compressed wire format.
 *
 *\li	'destaddr' is a valid sockaddr.
 *
 *\li	'srcaddr' is a valid sockaddr or NULL.
 *
 *\li	'srcaddr' and 'dstaddr' are the same protocol family.
 *
 *\li	'timeout' > 0
 *
 *\li	'task' is a valid task.
 *
 *\li	requestp != NULL && *requestp == NULL
 */

void
dns_request_cancel(dns_request_t *request);
/*%<
 * Cancel 'request'.
 *
 * Requires:
 *
 *\li	'request' is a valid request.
 *
 * Ensures:
 *
 *\li	If the completion event for 'request' has not yet been sent, it
 *	will be sent, and the result code will be ISC_R_CANCELED.
 */

isc_result_t
dns_request_getresponse(dns_request_t *request, dns_message_t *message,
			unsigned int options);
/*%<
 * Get the response to 'request' by filling in 'message'.
 *
 * 'options' is passed to dns_message_parse().  See dns_message_parse()
 * for more details.
 *
 * Requires:
 *
 *\li	'request' is a valid request for which the caller has received the
 *	completion event.
 *
 *\li	The result code of the completion event was #ISC_R_SUCCESS.
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *
 *\li	Any result that dns_message_parse() can return.
 */
isc_buffer_t *
dns_request_getanswer(dns_request_t *request);
/*
 * Get the response to 'request' as a buffer.
 *
 * Requires:
 *
 *\li	'request' is a valid request for which the caller has received the
 *	completion event.
 *
 * Returns:
 *
 *\li	a pointer to the answer buffer.
 */

bool
dns_request_usedtcp(dns_request_t *request);
/*%<
 * Return whether this query used TCP or not.  Setting #DNS_REQUESTOPT_TCP
 * in the call to dns_request_create() will cause the function to return
 * #true, otherwise the result is based on the query message size.
 *
 * Requires:
 *\li	'request' is a valid request.
 *
 * Returns:
 *\li	true	if TCP was used.
 *\li	false	if UDP was used.
 */

void
dns_request_destroy(dns_request_t **requestp);
/*%<
 * Destroy 'request'.
 *
 * Requires:
 *
 *\li	'request' is a valid request for which the caller has received the
 *	completion event.
 *
 * Ensures:
 *
 *\li	*requestp == NULL
 */

ISC_LANG_ENDDECLS

#endif /* DNS_REQUEST_H */