Gecko [ paxlifestyle.com ]

Name	Size	Permission	Date
acl.h	8.74 KB	-rw-r--r--	2025-01-20 13:39
adb.h	21.28 KB	-rw-r--r--	2025-01-20 13:39
badcache.h	3.28 KB	-rw-r--r--	2025-01-20 13:39
bit.h	788 B	-rw-r--r--	2025-01-20 13:39
byaddr.h	3.5 KB	-rw-r--r--	2025-01-20 13:39
cache.h	6.68 KB	-rw-r--r--	2025-01-20 13:39
callbacks.h	2.04 KB	-rw-r--r--	2025-01-20 13:39
catz.h	12.03 KB	-rw-r--r--	2025-01-20 13:39
cert.h	1.42 KB	-rw-r--r--	2025-01-20 13:39
client.h	9.18 KB	-rw-r--r--	2025-01-20 13:39
clientinfo.h	2.58 KB	-rw-r--r--	2025-01-20 13:39
compress.h	6.86 KB	-rw-r--r--	2025-01-20 13:39
db.h	49.1 KB	-rw-r--r--	2025-01-20 13:39
dbiterator.h	7.18 KB	-rw-r--r--	2025-01-20 13:39
diff.h	6.86 KB	-rw-r--r--	2025-01-20 13:39
dispatch.h	10.25 KB	-rw-r--r--	2026-03-27 00:00
dlz.h	10.61 KB	-rw-r--r--	2025-01-20 13:39
dlz_dlopen.h	4.27 KB	-rw-r--r--	2025-01-20 13:39
dns64.h	6.22 KB	-rw-r--r--	2025-01-20 13:39
dnsrps.h	2.49 KB	-rw-r--r--	2025-01-20 13:39
dnssec.h	12.86 KB	-rw-r--r--	2025-01-20 13:39
dnstap.h	9.95 KB	-rw-r--r--	2025-01-20 13:39
ds.h	1.62 KB	-rw-r--r--	2025-01-20 13:39
dsdigest.h	1.65 KB	-rw-r--r--	2025-01-20 13:39
dyndb.h	4.8 KB	-rw-r--r--	2025-01-20 13:39
ecs.h	1.91 KB	-rw-r--r--	2025-01-20 13:39
edns.h	763 B	-rw-r--r--	2025-01-20 13:39
enumclass.h	1.13 KB	-rw-r--r--	2026-03-27 00:00
enumtype.h	8.42 KB	-rw-r--r--	2026-03-27 00:00
events.h	4.33 KB	-rw-r--r--	2025-01-20 13:39
fixedname.h	1.59 KB	-rw-r--r--	2025-01-20 13:39
forward.h	3.13 KB	-rw-r--r--	2025-01-20 13:39
geoip.h	2.27 KB	-rw-r--r--	2025-01-20 13:39
ipkeylist.h	2.13 KB	-rw-r--r--	2025-01-20 13:39
iptable.h	1.46 KB	-rw-r--r--	2025-01-20 13:39
journal.h	9.46 KB	-rw-r--r--	2025-01-20 13:39
kasp.h	12.46 KB	-rw-r--r--	2025-01-20 13:39
keydata.h	1 KB	-rw-r--r--	2025-01-20 13:39
keyflags.h	1.22 KB	-rw-r--r--	2025-01-20 13:39
keymgr.h	3.99 KB	-rw-r--r--	2025-01-20 13:39
keytable.h	7.85 KB	-rw-r--r--	2025-01-20 13:39
keyvalues.h	3.96 KB	-rw-r--r--	2025-01-20 13:39
librpz.h	30.29 KB	-rw-r--r--	2025-01-20 13:39
log.h	3.91 KB	-rw-r--r--	2025-01-20 13:39
lookup.h	2.84 KB	-rw-r--r--	2025-01-20 13:39
master.h	8.52 KB	-rw-r--r--	2025-01-20 13:39
masterdump.h	9.64 KB	-rw-r--r--	2025-01-20 13:39
message.h	41.35 KB	-rw-r--r--	2026-03-27 00:00
name.h	36.35 KB	-rw-r--r--	2025-01-20 13:39
ncache.h	4.83 KB	-rw-r--r--	2025-01-20 13:39
nsec.h	3.43 KB	-rw-r--r--	2025-01-20 13:39
nsec3.h	8.05 KB	-rw-r--r--	2025-01-20 13:39
nta.h	4.6 KB	-rw-r--r--	2025-01-20 13:39
opcode.h	987 B	-rw-r--r--	2025-01-20 13:39
order.h	1.95 KB	-rw-r--r--	2025-01-20 13:39
peer.h	4.8 KB	-rw-r--r--	2025-01-20 13:39
private.h	1.89 KB	-rw-r--r--	2025-01-20 13:39
rbt.h	34.66 KB	-rw-r--r--	2025-01-20 13:39
rcode.h	2.4 KB	-rw-r--r--	2025-01-20 13:39
rdata.h	22.21 KB	-rw-r--r--	2025-01-20 13:39
rdataclass.h	2.17 KB	-rw-r--r--	2025-01-20 13:39
rdatalist.h	2.47 KB	-rw-r--r--	2025-01-20 13:39
rdataset.h	18.67 KB	-rw-r--r--	2025-01-20 13:39
rdatasetiter.h	3.81 KB	-rw-r--r--	2025-01-20 13:39
rdataslab.h	4.11 KB	-rw-r--r--	2025-01-20 13:39
rdatastruct.h	60.33 KB	-rw-r--r--	2026-03-27 00:00
rdatatype.h	2.21 KB	-rw-r--r--	2025-01-20 13:39
request.h	8.67 KB	-rw-r--r--	2026-03-27 00:00
resolver.h	18.7 KB	-rw-r--r--	2025-01-20 13:39
result.h	689 B	-rw-r--r--	2025-01-20 13:39
rootns.h	872 B	-rw-r--r--	2025-01-20 13:39
rpz.h	12.22 KB	-rw-r--r--	2025-01-20 13:39
rriterator.h	4.09 KB	-rw-r--r--	2025-01-20 13:39
rrl.h	6.8 KB	-rw-r--r--	2025-01-20 13:39
sdb.h	7.17 KB	-rw-r--r--	2025-01-20 13:39
sdlz.h	13.75 KB	-rw-r--r--	2025-01-20 13:39
secalg.h	1.65 KB	-rw-r--r--	2025-01-20 13:39
secproto.h	1.5 KB	-rw-r--r--	2025-01-20 13:39
soa.h	2.12 KB	-rw-r--r--	2025-01-20 13:39
ssu.h	7.6 KB	-rw-r--r--	2025-01-20 13:39
stats.h	24.15 KB	-rw-r--r--	2025-01-20 13:39
time.h	1.64 KB	-rw-r--r--	2025-01-20 13:39
tkey.h	7.46 KB	-rw-r--r--	2025-01-20 13:39
transport.h	5.93 KB	-rw-r--r--	2026-03-27 00:00
tsec.h	2.86 KB	-rw-r--r--	2025-01-20 13:39
tsig.h	8.18 KB	-rw-r--r--	2025-01-20 13:39
ttl.h	1.82 KB	-rw-r--r--	2025-01-20 13:39
types.h	14.03 KB	-rw-r--r--	2026-03-27 00:00
update.h	1.94 KB	-rw-r--r--	2025-01-20 13:39
validator.h	6.6 KB	-rw-r--r--	2025-01-20 13:39
view.h	36.94 KB	-rw-r--r--	2025-01-20 13:39
xfrin.h	2.26 KB	-rw-r--r--	2025-01-20 13:39
zone.h	63.88 KB	-rw-r--r--	2025-01-20 13:39
zonekey.h	754 B	-rw-r--r--	2025-01-20 13:39
zoneverify.h	1.4 KB	-rw-r--r--	2025-01-20 13:39
zt.h	5.02 KB	-rw-r--r--	2025-01-20 13:39

Rename

/*
 * 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

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

/*! \file
 *
 * \brief
 * The DNS client module provides convenient programming interfaces to various
 * DNS services, such as name resolution with or without DNSSEC validation or
 * dynamic DNS update.  This module is primarily expected to be used by other
 * applications than BIND9-related ones that need such advanced DNS features.
 *
 * MP:
 *\li	In the typical usage of this module, application threads will not share
 *	the same data structures created and manipulated in this module.
 *	However, the module still ensures appropriate synchronization of such
 *	data structures.
 *
 * Resources:
 *\li	TBS
 *
 * Security:
 *\li	This module does not handle any low-level data directly, and so no
 *	security issue specific to this module is anticipated.
 */

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

#include <dns/tsig.h>
#include <dns/types.h>

#include <dst/dst.h>

ISC_LANG_BEGINDECLS

/***
 *** Types
 ***/

/*%
 * Optional flags for dns_client_(start)resolve.
 */
/*%< Do not return DNSSEC data (e.g. RRSIGS) with response. */
#define DNS_CLIENTRESOPT_NODNSSEC 0x01
/*%< Allow running external context. */
#define DNS_CLIENTRESOPT_RESERVED 0x02
/*%< Don't validate responses. */
#define DNS_CLIENTRESOPT_NOVALIDATE 0x04
/*%< Don't set the CD flag on upstream queries. */
#define DNS_CLIENTRESOPT_NOCDFLAG 0x08
/*%< Use TCP transport. */
#define DNS_CLIENTRESOPT_TCP 0x10

/*%
 * View name used in dns_client.
 */
#define DNS_CLIENTVIEW_NAME "_dnsclient"

/*%
 * A dns_clientresevent_t is sent when name resolution performed by a client
 * completes.  'result' stores the result code of the entire resolution
 * procedure.  'vresult' specifically stores the result code of DNSSEC
 * validation if it is performed.  When name resolution successfully completes,
 * 'answerlist' is typically non empty, containing answer names along with
 * RRsets.  It is the receiver's responsibility to free this list by calling
 * dns_client_freeresanswer() before freeing the event structure.
 */
typedef struct dns_clientresevent {
	ISC_EVENT_COMMON(struct dns_clientresevent);
	isc_result_t   result;
	isc_result_t   vresult;
	dns_namelist_t answerlist;
} dns_clientresevent_t; /* too long? */

isc_result_t
dns_client_create(isc_mem_t *mctx, isc_appctx_t *actx, isc_taskmgr_t *taskmgr,
		  isc_nm_t *nm, isc_timermgr_t *timermgr, unsigned int options,
		  dns_client_t **clientp, const isc_sockaddr_t *localaddr4,
		  const isc_sockaddr_t *localaddr6);
/*%<
 * Create a DNS client object with minimal internal resources, such as
 * a default view for the IN class and IPv4/IPv6 dispatches for the view.
 *
 * dns_client_create() takes 'manager' arguments so that the caller can
 * control the behavior of the client through the underlying event framework.
 * 'localaddr4' and 'localaddr6' specify the local addresses to use for
 * each address family; if both are set to NULL, then wildcard addresses
 * will be used for both families. If only one is NULL, then the other
 * address will be used as the local address, and the NULL protocol family
 * will not be used.
 *
 * Requires:
 *
 *\li	'mctx' is a valid memory context.
 *
 *\li	'actx' is a valid application context.
 *
 *\li	'taskmgr' is a valid task manager.
 *
 *\li	'nm' is a valid network manager.
 *
 *\li	'timermgr' is a valid timer manager.
 *
 *\li	clientp != NULL && *clientp == NULL.
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS				On success.
 *
 *\li	Anything else				Failure.
 */

void
dns_client_detach(dns_client_t **clientp);
/*%<
 * Detach 'client' and destroy it if there are no more references.
 *
 * Requires:
 *
 *\li	'*clientp' is a valid client.
 *
 * Ensures:
 *
 *\li	*clientp == NULL.
 */

isc_result_t
dns_client_setservers(dns_client_t *client, dns_rdataclass_t rdclass,
		      const dns_name_t *name_space, isc_sockaddrlist_t *addrs);
/*%<
 * Specify a list of addresses of recursive name servers that the client will
 * use for name resolution.  A view for the 'rdclass' class must be created
 * beforehand.  If 'name_space' is non NULL, the specified server will be used
 * if and only if the query name is a subdomain of 'name_space'.  When servers
 * for multiple 'name_space's are provided, and a query name is covered by
 * more than one 'name_space', the servers for the best (longest) matching
 * name_space will be used.  If 'name_space' is NULL, it works as if
 * dns_rootname (.) were specified.
 *
 * Requires:
 *
 *\li	'client' is a valid client.
 *
 *\li	'name_space' is NULL or a valid name.
 *
 *\li	'addrs' != NULL.
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS				On success.
 *
 *\li	Anything else				Failure.
 */

isc_result_t
dns_client_clearservers(dns_client_t *client, dns_rdataclass_t rdclass,
			const dns_name_t *name_space);
/*%<
 * Remove configured recursive name servers for the 'rdclass' and 'name_space'
 * from the client.  See the description of dns_client_setservers() for
 * the requirements about 'rdclass' and 'name_space'.
 *
 * Requires:
 *
 *\li	'client' is a valid client.
 *
 *\li	'name_space' is NULL or a valid name.
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS				On success.
 *
 *\li	Anything else				Failure.
 */

void
dns_client_setmaxrestarts(dns_client_t *client, uint8_t max_restarts);
/*%<
 * Set the number of permissible chained queries before we give up,
 * to prevent CNAME loops. This defaults to 11.
 *
 * Requires:
 *
 *\li	'client' is a valid client.

*\li	'max_restarts' is greater than 0.
 */

isc_result_t
dns_client_resolve(dns_client_t *client, const dns_name_t *name,
		   dns_rdataclass_t rdclass, dns_rdatatype_t type,
		   unsigned int options, dns_namelist_t *namelist);

isc_result_t
dns_client_startresolve(dns_client_t *client, const dns_name_t *name,
			dns_rdataclass_t rdclass, dns_rdatatype_t type,
			unsigned int options, isc_task_t *task,
			isc_taskaction_t action, void *arg,
			dns_clientrestrans_t **transp);
/*%<
 * Perform name resolution for 'name', 'rdclass', and 'type'.
 *
 * If any trusted keys are configured and the query name is considered to
 * belong to a secure zone, these functions also validate the responses
 * using DNSSEC by default.  If the DNS_CLIENTRESOPT_NOVALIDATE flag is set
 * in 'options', DNSSEC validation is disabled regardless of the configured
 * trusted keys or the query name. With DNS_CLIENTRESOPT_NODNSSEC
 * DNSSEC data is not returned with response. DNS_CLIENTRESOPT_NOCDFLAG
 * disables the CD flag on queries, DNS_CLIENTRESOPT_TCP switches to
 * the TCP (vs. UDP) transport.
 *
 * dns_client_resolve() provides a synchronous service.  This function starts
 * name resolution internally and blocks until it completes.  On success,
 * 'namelist' will contain a list of answer names, each of which has
 * corresponding RRsets.  The caller must provide a valid empty list, and
 * is responsible for freeing the list content via dns_client_freeresanswer().
 * If the name resolution fails due to an error in DNSSEC validation,
 * dns_client_resolve() returns the result code indicating the validation
 * error. Otherwise, it returns the result code of the entire resolution
 * process, either success or failure.
 *
 * It is expected that the client object passed to dns_client_resolve() was
 * created via dns_client_create() and has external managers and contexts.
 *
 * dns_client_startresolve() is an asynchronous version of dns_client_resolve()
 * and does not block.  When name resolution is completed, 'action' will be
 * called with the argument of a 'dns_clientresevent_t' object, which contains
 * the resulting list of answer names (on success).  On return, '*transp' is
 * set to an opaque transaction ID so that the caller can cancel this
 * resolution process.
 *
 * Requires:
 *
 *\li	'client' is a valid client.
 *
 *\li	'addrs' != NULL.
 *
 *\li	'name' is a valid name.
 *
 *\li	'namelist' != NULL and is not empty.
 *
 *\li	'task' is a valid task.
 *
 *\li	'transp' != NULL && *transp == NULL;
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS				On success.
 *
 *\li	Anything else				Failure.
 */

void
dns_client_freeresanswer(dns_client_t *client, dns_namelist_t *namelist);
/*%<
 * Free resources allocated for the content of 'namelist'.
 *
 * Requires:
 *
 *\li	'client' is a valid client.
 *
 *\li	'namelist' != NULL.
 */

isc_result_t
dns_client_addtrustedkey(dns_client_t *client, dns_rdataclass_t rdclass,
			 dns_rdatatype_t rdtype, const dns_name_t *keyname,
			 isc_buffer_t *keydatabuf);
/*%<
 * Add a DNSSEC trusted key for the 'rdclass' class.  A view for the 'rdclass'
 * class must be created beforehand.  'rdtype' is the type of the RR data
 * for the key, either DNSKEY or DS.  'keyname' is the DNS name of the key,
 * and 'keydatabuf' stores the RR data.
 *
 * Requires:
 *
 *\li	'client' is a valid client.
 *
 *\li	'keyname' is a valid name.
 *
 *\li	'keydatabuf' is a valid buffer.
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS				On success.
 *
 *\li	Anything else				Failure.
 */

ISC_LANG_ENDDECLS