Na}{

File Content: `validator.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 http://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */


#ifndef DNS_VALIDATOR_H
#define DNS_VALIDATOR_H 1

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

/*! \file dns/validator.h
 *
 * \brief
 * DNS Validator
 * This is the BIND 9 validator, the module responsible for validating the
 * rdatasets and negative responses (messages).  It makes use of zones in
 * the view and may fetch RRset to complete trust chains.  It implements
 * DNSSEC as specified in RFC 4033, 4034 and 4035.
 *
 * It can also optionally implement ISC's DNSSEC look-aside validation.
 *
 * Correct operation is critical to preventing spoofed answers from secure
 * zones being accepted.
 *
 * MP:
 *\li	The module ensures appropriate synchronization of data structures it
 *	creates and manipulates.
 *
 * Reliability:
 *\li	No anticipated impact.
 *
 * Resources:
 *\li	TBS
 *
 * Security:
 *\li	No anticipated impact.
 *
 * Standards:
 *\li	RFCs:	1034, 1035, 2181, 4033, 4034, 4035.
 */

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

#include <dns/fixedname.h>
#include <dns/types.h>
#include <dns/rdataset.h>
#include <dns/rdatastruct.h> /* for dns_rdata_rrsig_t */

#include <dst/dst.h>

/*%
 * A dns_validatorevent_t is sent when a 'validation' completes.
 * \brief
 * 'name', 'rdataset', 'sigrdataset', and 'message' are the values that were
 * supplied when dns_validator_create() was called.  They are returned to the
 * caller so that they may be freed.
 *
 * If the RESULT is ISC_R_SUCCESS and the answer is secure then
 * proofs[] will contain the names of the NSEC records that hold the
 * various proofs.  Note the same name may appear multiple times.
 */
typedef struct dns_validatorevent {
	ISC_EVENT_COMMON(struct dns_validatorevent);
	dns_validator_t *		validator;
	isc_result_t			result;
	/*
	 * Name and type of the response to be validated.
	 */
	dns_name_t *			name;
	dns_rdatatype_t			type;
	/*
	 * Rdata and RRSIG (if any) for positive responses.
	 */
	dns_rdataset_t *		rdataset;
	dns_rdataset_t *		sigrdataset;
	/*
	 * The full response.  Required for negative responses.
	 * Also required for positive wildcard responses.
	 */
	dns_message_t *			message;
	/*
	 * Proofs to be cached.
	 */
	dns_name_t *			proofs[4];
	/*
	 * Optout proof seen.
	 */
	isc_boolean_t			optout;
	/*
	 * Answer is secure.
	 */
	isc_boolean_t			secure;
} dns_validatorevent_t;

#define DNS_VALIDATOR_NOQNAMEPROOF 0
#define DNS_VALIDATOR_NODATAPROOF 1
#define DNS_VALIDATOR_NOWILDCARDPROOF 2
#define DNS_VALIDATOR_CLOSESTENCLOSER 3

/*%
 * A validator object represents a validation in progress.
 * \brief
 * Clients are strongly discouraged from using this type directly, with
 * the exception of the 'link' field, which may be used directly for
 * whatever purpose the client desires.
 */
struct dns_validator {
	/* Unlocked. */
	unsigned int			magic;
	isc_mutex_t			lock;
	dns_view_t *			view;
	/* Locked by lock. */
	unsigned int			options;
	unsigned int			attributes;
	dns_validatorevent_t *		event;
	dns_fetch_t *			fetch;
	dns_validator_t *		subvalidator;
	dns_validator_t *		parent;
	dns_keytable_t *		keytable;
	dns_keynode_t *			keynode;
	dst_key_t *			key;
	dns_rdata_rrsig_t *		siginfo;
	isc_task_t *			task;
	isc_taskaction_t		action;
	void *				arg;
	unsigned int			labels;
	dns_rdataset_t *		currentset;
	isc_boolean_t			seensig;
	dns_rdataset_t *		keyset;
	dns_rdataset_t *		dsset;
	dns_rdataset_t *		soaset;
	dns_rdataset_t *		nsecset;
	dns_rdataset_t *		nsec3set;
	dns_name_t *			soaname;
	dns_rdataset_t			frdataset;
	dns_rdataset_t			fsigrdataset;
	dns_fixedname_t			fname;
	dns_fixedname_t			wild;
	dns_fixedname_t			nearest;
	dns_fixedname_t			closest;
	ISC_LINK(dns_validator_t)	link;
	dns_rdataset_t 			dlv;
	dns_fixedname_t			dlvsep;
	isc_boolean_t			havedlvsep;
	isc_boolean_t			mustbesecure;
	unsigned int			dlvlabels;
	unsigned int			depth;
	unsigned int			authcount;
	unsigned int			authfail;
	isc_stdtime_t			start;
};

/*%
 * dns_validator_create() options.
 */
#define DNS_VALIDATOR_DLV		0x0001U
#define DNS_VALIDATOR_DEFER		0x0002U
#define DNS_VALIDATOR_NOCDFLAG		0x0004U
#define DNS_VALIDATOR_NONTA		0x0008U  /*% Ignore NTA table */

ISC_LANG_BEGINDECLS

isc_result_t
dns_validator_create(dns_view_t *view, dns_name_t *name, dns_rdatatype_t type,
		     dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset,
		     dns_message_t *message, unsigned int options,
		     isc_task_t *task, isc_taskaction_t action, void *arg,
		     dns_validator_t **validatorp);
/*%<
 * Start a DNSSEC validation.
 *
 * This validates a response to the question given by
 * 'name' and 'type'.
 *
 * To validate a positive response, the response data is
 * given by 'rdataset' and 'sigrdataset'.  If 'sigrdataset'
 * is NULL, the data is presumed insecure and an attempt
 * is made to prove its insecurity by finding the appropriate
 * null key.
 *
 * The complete response message may be given in 'message',
 * to make available any authority section NSECs that may be
 * needed for validation of a response resulting from a
 * wildcard expansion (though no such wildcard validation
 * is implemented yet).  If the complete response message
 * is not available, 'message' is NULL.
 *
 * To validate a negative response, the complete negative response
 * message is given in 'message'.  The 'rdataset', and
 * 'sigrdataset' arguments must be NULL, but the 'name' and 'type'
 * arguments must be provided.
 *
 * The validation is performed in the context of 'view'.
 *
 * When the validation finishes, a dns_validatorevent_t with
 * the given 'action' and 'arg' are sent to 'task'.
 * Its 'result' field will be ISC_R_SUCCESS iff the
 * response was successfully proven to be either secure or
 * part of a known insecure domain.
 *
 * options:
 * If DNS_VALIDATOR_DLV is set the caller knows there is not a
 * trusted key and the validator should immediately attempt to validate
 * the answer by looking for an appropriate DLV RRset.
 */

void
dns_validator_send(dns_validator_t *validator);
/*%<
 * Send a deferred validation request
 *
 * Requires:
 *	'validator' to points to a valid DNSSEC validator.
 */

void
dns_validator_cancel(dns_validator_t *validator);
/*%<
 * Cancel a DNSSEC validation in progress.
 *
 * Requires:
 *\li	'validator' points to a valid DNSSEC validator, which
 *	may or may not already have completed.
 *
 * Ensures:
 *\li	It the validator has not already sent its completion
 *	event, it will send it with result code ISC_R_CANCELED.
 */

void
dns_validator_destroy(dns_validator_t **validatorp);
/*%<
 * Destroy a DNSSEC validator.
 *
 * Requires:
 *\li	'*validatorp' points to a valid DNSSEC validator.
 * \li	The validator must have completed and sent its completion
 * 	event.
 *
 * Ensures:
 *\li	All resources used by the validator are freed.
 */

ISC_LANG_ENDDECLS

#endif /* DNS_VALIDATOR_H */

Name	Size	Permission
acache.h	14328 bytes	0644
acl.h	7274 bytes	0644
adb.h	22560 bytes	0644
badcache.h	3362 bytes	0644
bit.h	856 bytes	0644
byaddr.h	3988 bytes	0644
cache.h	8141 bytes	0644
callbacks.h	2270 bytes	0644
catz.h	11002 bytes	0644
cert.h	1465 bytes	0644
client.h	22040 bytes	0644
clientinfo.h	1994 bytes	0644
compress.h	6671 bytes	0644
db.h	45753 bytes	0644
dbiterator.h	7434 bytes	0644
dbtable.h	3164 bytes	0644
diff.h	6979 bytes	0644
dispatch.h	16433 bytes	0644
dlz.h	10626 bytes	0644
dlz_dlopen.h	4654 bytes	0644
dns64.h	5644 bytes	0644
dnssec.h	12292 bytes	0644
dnstap.h	9423 bytes	0644
ds.h	1222 bytes	0644
dsdigest.h	1721 bytes	0644
dyndb.h	4829 bytes	0644
ecdb.h	808 bytes	0644
edns.h	721 bytes	0644
enumclass.h	1220 bytes	0644
enumtype.h	7921 bytes	0644
events.h	4058 bytes	0644
fixedname.h	1600 bytes	0644
forward.h	3451 bytes	0644
geoip.h	2395 bytes	0644
ipkeylist.h	2170 bytes	0644
iptable.h	1642 bytes	0644
journal.h	8239 bytes	0644
keydata.h	1047 bytes	0644
keyflags.h	1277 bytes	0644
keytable.h	9504 bytes	0644
keyvalues.h	4158 bytes	0644
lib.h	1191 bytes	0644
log.h	3963 bytes	0644
lookup.h	2923 bytes	0644
master.h	11348 bytes	0644
masterdump.h	12646 bytes	0644
message.h	39195 bytes	0644
name.h	37278 bytes	0644
ncache.h	4915 bytes	0644
nsec.h	2954 bytes	0644
nsec3.h	8370 bytes	0644
nta.h	4422 bytes	0644
opcode.h	1006 bytes	0644
order.h	1998 bytes	0644
peer.h	6205 bytes	0644
portlist.h	2095 bytes	0644
private.h	1949 bytes	0644
rbt.h	40648 bytes	0644
rcode.h	2480 bytes	0644
rdata.h	21425 bytes	0644
rdataclass.h	2256 bytes	0644
rdatalist.h	2568 bytes	0644
rdataset.h	20962 bytes	0644
rdatasetiter.h	3925 bytes	0644
rdataslab.h	4395 bytes	0644
rdatastruct.h	58955 bytes	0644
rdatatype.h	2297 bytes	0644
request.h	11155 bytes	0644
resolver.h	19080 bytes	0644
result.h	8780 bytes	0644
rootns.h	891 bytes	0644
rpz.h	10329 bytes	0644
rriterator.h	4272 bytes	0644
rrl.h	6650 bytes	0644
sdb.h	7204 bytes	0644
sdlz.h	14207 bytes	0644
secalg.h	1705 bytes	0644
secproto.h	1556 bytes	0644
soa.h	2222 bytes	0644
ssu.h	8280 bytes	0644
stats.h	13463 bytes	0644
tcpmsg.h	3125 bytes	0644
time.h	1695 bytes	0644
timer.h	1041 bytes	0644
tkey.h	7612 bytes	0644
tsec.h	2948 bytes	0644
tsig.h	8250 bytes	0644
ttl.h	1981 bytes	0644
types.h	13975 bytes	0644
update.h	1645 bytes	0644
validator.h	7166 bytes	0644
version.h	867 bytes	0644
view.h	35519 bytes	0644
xfrin.h	2923 bytes	0644
zone.h	61231 bytes	0644
zonekey.h	763 bytes	0644
zt.h	5439 bytes	0644

File Content: validator.h

File Content: `validator.h`