Na}{

File Content: `ncache.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_NCACHE_H
#define DNS_NCACHE_H 1

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

/*! \file dns/ncache.h
 *\brief
 * DNS Ncache
 *
 * XXX TBS XXX
 *
 * MP:
 *\li	The caller must ensure any required synchronization.
 *
 * Reliability:
 *\li	No anticipated impact.
 *
 * Resources:
 *\li	TBS
 *
 * Security:
 *\li	No anticipated impact.
 *
 * Standards:
 *\li	RFC2308
 */

#include <stdbool.h>

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

#include <dns/types.h>

ISC_LANG_BEGINDECLS

/*%
 * _OMITDNSSEC:
 *      Omit DNSSEC records when rendering.
 */
#define DNS_NCACHETOWIRE_OMITDNSSEC   0x0001

isc_result_t
dns_ncache_add(dns_message_t *message, dns_db_t *cache, dns_dbnode_t *node,
	       dns_rdatatype_t covers, isc_stdtime_t now, dns_ttl_t maxttl,
	       dns_rdataset_t *addedrdataset);
isc_result_t
dns_ncache_addoptout(dns_message_t *message, dns_db_t *cache,
		     dns_dbnode_t *node, dns_rdatatype_t covers,
		     isc_stdtime_t now, dns_ttl_t maxttl,
		     bool optout, dns_rdataset_t *addedrdataset);
/*%<
 * Convert the authority data from 'message' into a negative cache
 * rdataset, and store it in 'cache' at 'node' with a TTL limited to
 * 'maxttl'.
 *
 * \li dns_ncache_add produces a negative cache entry with a trust of no
 *     more than answer
 * \li dns_ncache_addoptout produces a negative cache entry which will have
 *     a trust of secure if all the records that make up the entry are secure.
 *
 * The 'covers' argument is the RR type whose nonexistence we are caching,
 * or dns_rdatatype_any when caching a NXDOMAIN response.
 *
 * 'optout' indicates a DNS_RDATASETATTR_OPTOUT should be set.
 *
 * Note:
 *\li	If 'addedrdataset' is not NULL, then it will be attached to the added
 *	rdataset.  See dns_db_addrdataset() for more details.
 *
 * Requires:
 *\li	'message' is a valid message with a properly formatting negative cache
 *	authority section.
 *
 *\li	The requirements of dns_db_addrdataset() apply to 'cache', 'node',
 *	'now', and 'addedrdataset'.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOSPACE
 *
 *\li	Any result code of dns_db_addrdataset() is a possible result code
 *	of dns_ncache_add().
 */

isc_result_t
dns_ncache_towire(dns_rdataset_t *rdataset, dns_compress_t *cctx,
		  isc_buffer_t *target, unsigned int options,
		  unsigned int *countp);
/*%<
 * Convert the negative caching rdataset 'rdataset' to wire format,
 * compressing names as specified in 'cctx', and storing the result in
 * 'target'.  If 'omit_dnssec' is set, DNSSEC records will not
 * be added to 'target'.
 *
 * Notes:
 *\li	The number of RRs added to target will be added to *countp.
 *
 * Requires:
 *\li	'rdataset' is a valid negative caching rdataset.
 *
 *\li	'rdataset' is not empty.
 *
 *\li	'countp' is a valid pointer.
 *
 * Ensures:
 *\li	On a return of ISC_R_SUCCESS, 'target' contains a wire format
 *	for the data contained in 'rdataset'.  Any error return leaves
 *	the buffer unchanged.
 *
 *\li	*countp has been incremented by the number of RRs added to
 *	target.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS		- all ok
 *\li	#ISC_R_NOSPACE		- 'target' doesn't have enough room
 *
 *\li	Any error returned by dns_rdata_towire(), dns_rdataset_next(),
 *	dns_name_towire().
 */

isc_result_t
dns_ncache_getrdataset(dns_rdataset_t *ncacherdataset, dns_name_t *name,
		       dns_rdatatype_t type, dns_rdataset_t *rdataset);
/*%<
 * Search the negative caching rdataset for an rdataset with the
 * specified name and type.
 *
 * Requires:
 *\li	'ncacherdataset' is a valid negative caching rdataset.
 *
 *\li	'ncacherdataset' is not empty.
 *
 *\li	'name' is a valid name.
 *
 *\li	'type' is not SIG, or a meta-RR type.
 *
 *\li	'rdataset' is a valid disassociated rdataset.
 *
 * Ensures:
 *\li	On a return of ISC_R_SUCCESS, 'rdataset' is bound to the found
 *	rdataset.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS		- the rdataset was found.
 *\li	#ISC_R_NOTFOUND		- the rdataset was not found.
 *
 */

isc_result_t
dns_ncache_getsigrdataset(dns_rdataset_t *ncacherdataset, dns_name_t *name,
			  dns_rdatatype_t covers, dns_rdataset_t *rdataset);
/*%<
 * Similar to dns_ncache_getrdataset() but get the rrsig that matches.
 */

void
dns_ncache_current(dns_rdataset_t *ncacherdataset, dns_name_t *found,
		   dns_rdataset_t *rdataset);

/*%<
 * Extract the current rdataset and name from a ncache entry.
 *
 * Requires:
 * \li	'ncacherdataset' to be valid and to be a negative cache entry
 * \li	'found' to be valid.
 * \li	'rdataset' to be unassociated.
 */

ISC_LANG_ENDDECLS

#endif /* DNS_NCACHE_H */

Name	Size	Permission
acache.h	14232 bytes	0644
acl.h	7242 bytes	0644
adb.h	22595 bytes	0644
badcache.h	3369 bytes	0644
bit.h	807 bytes	0644
byaddr.h	4002 bytes	0644
cache.h	8643 bytes	0644
callbacks.h	2271 bytes	0644
catz.h	11833 bytes	0644
cert.h	1466 bytes	0644
client.h	22042 bytes	0644
clientinfo.h	2006 bytes	0644
compress.h	6646 bytes	0644
db.h	47061 bytes	0644
dbiterator.h	7422 bytes	0644
dbtable.h	3165 bytes	0644
diff.h	6980 bytes	0644
dispatch.h	16427 bytes	0644
dlz.h	10618 bytes	0644
dlz_dlopen.h	4677 bytes	0644
dns64.h	5635 bytes	0644
dnssec.h	12115 bytes	0644
dnstap.h	9364 bytes	0644
ds.h	1225 bytes	0644
dsdigest.h	1722 bytes	0644
dyndb.h	4835 bytes	0644
ecdb.h	809 bytes	0644
edns.h	722 bytes	0644
enumclass.h	1220 bytes	0644
enumtype.h	8300 bytes	0644
events.h	4059 bytes	0644
fixedname.h	1663 bytes	0644
forward.h	3452 bytes	0644
geoip.h	2792 bytes	0644
ipkeylist.h	2186 bytes	0644
iptable.h	1621 bytes	0644
journal.h	8227 bytes	0644
keydata.h	1059 bytes	0644
keyflags.h	1278 bytes	0644
keytable.h	9462 bytes	0644
keyvalues.h	4159 bytes	0644
lib.h	1192 bytes	0644
log.h	3964 bytes	0644
lookup.h	2924 bytes	0644
master.h	11289 bytes	0644
masterdump.h	12647 bytes	0644
message.h	39023 bytes	0644
name.h	37115 bytes	0644
ncache.h	4929 bytes	0644
nsec.h	2928 bytes	0644
nsec3.h	8032 bytes	0644
nta.h	4548 bytes	0644
opcode.h	1007 bytes	0644
order.h	1999 bytes	0644
peer.h	5966 bytes	0644
portlist.h	2101 bytes	0644
private.h	1935 bytes	0644
rbt.h	40618 bytes	0644
rcode.h	2481 bytes	0644
rdata.h	21613 bytes	0644
rdataclass.h	2257 bytes	0644
rdatalist.h	2569 bytes	0644
rdataset.h	21536 bytes	0644
rdatasetiter.h	3926 bytes	0644
rdataslab.h	4502 bytes	0644
rdatastruct.h	61584 bytes	0644
rdatatype.h	2298 bytes	0644
request.h	11156 bytes	0644
resolver.h	20227 bytes	0644
result.h	9284 bytes	0644
rootns.h	892 bytes	0644
rpz.h	10335 bytes	0644
rriterator.h	4230 bytes	0644
rrl.h	6640 bytes	0644
sdb.h	7224 bytes	0644
sdlz.h	14214 bytes	0644
secalg.h	1706 bytes	0644
secproto.h	1557 bytes	0644
soa.h	2186 bytes	0644
ssu.h	8308 bytes	0644
stats.h	13451 bytes	0644
tcpmsg.h	3145 bytes	0644
time.h	1695 bytes	0644
timer.h	1051 bytes	0644
tkey.h	7631 bytes	0644
tsec.h	2949 bytes	0644
tsig.h	8384 bytes	0644
ttl.h	1945 bytes	0644
types.h	14158 bytes	0644
update.h	1653 bytes	0644
validator.h	7161 bytes	0644
version.h	868 bytes	0644
view.h	35274 bytes	0644
xfrin.h	2924 bytes	0644
zone.h	60864 bytes	0644
zonekey.h	777 bytes	0644
zt.h	5562 bytes	0644

File Content: ncache.h

File Content: `ncache.h`