#acupoftea - accounting.gulfstore-gcc.com

System	:	Linux server1.ontime-gulf.com 4.18.0-553.5.1.el8_10.x86_64 #1 SMP Wed Jun 5 09:12:13 EDT 2024 x86_64
Software	:	Apache
Server	:	162.0.230.206
Domains	:	40 Domain
Permission	:	[ drwxr-xr-x ]
	:	/ usr / include / bind9 / dns /

216.73.216.141

Home

File keytable.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_KEYTABLE_H
#define DNS_KEYTABLE_H 1

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

/*! \file
 * \brief
 * The keytable module provides services for storing and retrieving DNSSEC
 * trusted keys, as well as the ability to find the deepest matching key
 * for a given domain name.
 *
 * 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/lang.h>
#include <isc/magic.h>
#include <isc/rwlock.h>
#include <isc/stdtime.h>

#include <dns/types.h>

#include <dst/dst.h>

ISC_LANG_BEGINDECLS

isc_result_t
dns_keytable_create(isc_mem_t *mctx, dns_keytable_t **keytablep);
/*%<
 * Create a keytable.
 *
 * Requires:
 *
 *\li	'mctx' is a valid memory context.
 *
 *\li	keytablep != NULL && *keytablep == NULL
 *
 * Ensures:
 *
 *\li	On success, *keytablep is a valid, empty key table.
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *
 *\li	Any other result indicates failure.
 */

void
dns_keytable_attach(dns_keytable_t *source, dns_keytable_t **targetp);
/*%<
 * Attach *targetp to source.
 *
 * Requires:
 *
 *\li	'source' is a valid keytable.
 *
 *\li	'targetp' points to a NULL dns_keytable_t *.
 *
 * Ensures:
 *
 *\li	*targetp is attached to source.
 */

void
dns_keytable_detach(dns_keytable_t **keytablep);
/*%<
 * Detach *keytablep from its keytable.
 *
 * Requires:
 *
 *\li	'keytablep' points to a valid keytable.
 *
 * Ensures:
 *
 *\li	*keytablep is NULL.
 *
 *\li	If '*keytablep' is the last reference to the keytable,
 *		all resources used by the keytable will be freed
 */

isc_result_t
dns_keytable_add(dns_keytable_t *keytable, bool managed,
		 dst_key_t **keyp);
/*%<
 * Add '*keyp' to 'keytable' (using the name in '*keyp').
 * The value of keynode->managed is set to 'managed'
 *
 * Notes:
 *
 *\li	Ownership of *keyp is transferred to the keytable.
 *\li   If the key already exists in the table, ISC_R_EXISTS is
 *      returned and the new key is freed.
 *
 * Requires:
 *
 *\li	'keytable' points to a valid keytable.
 *
 *\li	keyp != NULL && *keyp is a valid dst_key_t *.
 *
 * Ensures:
 *
 *\li	On success, *keyp == NULL
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *\li	ISC_R_EXISTS
 *
 *\li	Any other result indicates failure.
 */

isc_result_t
dns_keytable_marksecure(dns_keytable_t *keytable, dns_name_t *name);
/*%<
 * Add a null key to 'keytable' for name 'name'.  This marks the
 * name as a secure domain, but doesn't supply any key data to allow the
 * domain to be validated.  (Used when automated trust anchor management
 * has gotten broken by a zone misconfiguration; for example, when the
 * active key has been revoked but the stand-by key was still in its 30-day
 * waiting period for validity.)
 *
 * Notes:
 *
 *\li   If a key already exists in the table, ISC_R_EXISTS is
 *      returned and nothing is done.
 *
 * Requires:
 *
 *\li	'keytable' points to a valid keytable.
 *
 *\li	keyp != NULL && *keyp is a valid dst_key_t *.
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *\li	ISC_R_EXISTS
 *
 *\li	Any other result indicates failure.
 */

isc_result_t
dns_keytable_delete(dns_keytable_t *keytable, dns_name_t *keyname);
/*%<
 * Delete node(s) from 'keytable' matching name 'keyname'
 *
 * Requires:
 *
 *\li	'keytable' points to a valid keytable.
 *
 *\li	'name' is not NULL
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *
 *\li	Any other result indicates failure.
 */

isc_result_t
dns_keytable_deletekeynode(dns_keytable_t *keytable, dst_key_t *dstkey);
/*%<
 * Delete node(s) from 'keytable' containing copies of the key pointed
 * to by 'dstkey'
 *
 * Requires:
 *
 *\li	'keytable' points to a valid keytable.
 *\li	'dstkey' is not NULL
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *
 *\li	Any other result indicates failure.
 */

isc_result_t
dns_keytable_find(dns_keytable_t *keytable, dns_name_t *keyname,
		  dns_keynode_t **keynodep);
/*%<
 * Search for the first instance of a key named 'name' in 'keytable',
 * without regard to keyid and algorithm.  Use dns_keytable_nextkeynode()
 * to find subsequent instances.
 *
 * Requires:
 *
 *\li	'keytable' is a valid keytable.
 *
 *\li	'name' is a valid absolute name.
 *
 *\li	keynodep != NULL && *keynodep == NULL
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *\li	ISC_R_NOTFOUND
 *
 *\li	Any other result indicates an error.
 */

isc_result_t
dns_keytable_nextkeynode(dns_keytable_t *keytable, dns_keynode_t *keynode,
			 dns_keynode_t **nextnodep);
/*%<
 * Return for the next key after 'keynode' in 'keytable', without regard to
 * keyid and algorithm.
 *
 * Requires:
 *
 *\li	'keytable' is a valid keytable.
 *
 *\li	'keynode' is a valid keynode.
 *
 *\li	nextnodep != NULL && *nextnodep == NULL
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *\li	ISC_R_NOTFOUND
 *
 *\li	Any other result indicates an error.
 */

isc_result_t
dns_keytable_findkeynode(dns_keytable_t *keytable, dns_name_t *name,
			 dns_secalg_t algorithm, dns_keytag_t tag,
			 dns_keynode_t **keynodep);
/*%<
 * Search for a key named 'name', matching 'algorithm' and 'tag' in
 * 'keytable'.  This finds the first instance which matches.  Use
 * dns_keytable_findnextkeynode() to find other instances.
 *
 * Requires:
 *
 *\li	'keytable' is a valid keytable.
 *
 *\li	'name' is a valid absolute name.
 *
 *\li	keynodep != NULL && *keynodep == NULL
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *\li	DNS_R_PARTIALMATCH	the name existed in the keytable.
 *\li	ISC_R_NOTFOUND
 *
 *\li	Any other result indicates an error.
 */

isc_result_t
dns_keytable_findnextkeynode(dns_keytable_t *keytable, dns_keynode_t *keynode,
					     dns_keynode_t **nextnodep);
/*%<
 * Search for the next key with the same properties as 'keynode' in
 * 'keytable' as found by dns_keytable_findkeynode().
 *
 * Requires:
 *
 *\li	'keytable' is a valid keytable.
 *
 *\li	'keynode' is a valid keynode.
 *
 *\li	nextnodep != NULL && *nextnodep == NULL
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *\li	ISC_R_NOTFOUND
 *
 *\li	Any other result indicates an error.
 */

isc_result_t
dns_keytable_finddeepestmatch(dns_keytable_t *keytable, dns_name_t *name,
			      dns_name_t *foundname);
/*%<
 * Search for the deepest match of 'name' in 'keytable'.
 *
 * Requires:
 *
 *\li	'keytable' is a valid keytable.
 *
 *\li	'name' is a valid absolute name.
 *
 *\li	'foundname' is a name with a dedicated buffer.
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *\li	ISC_R_NOTFOUND
 *
 *\li	Any other result indicates an error.
 */

void
dns_keytable_attachkeynode(dns_keytable_t *keytable, dns_keynode_t *source,
			   dns_keynode_t **target);
/*%<
 * Attach a keynode and and increment the active_nodes counter in a
 * corresponding keytable.
 *
 * Requires:
 *
 *\li	'keytable' is a valid keytable.
 *
 *\li	'source' is a valid keynode.
 *
 *\li	'target' is not null and '*target' is null.
 */

void
dns_keytable_detachkeynode(dns_keytable_t *keytable,
			   dns_keynode_t **keynodep);
/*%<
 * Give back a keynode found via dns_keytable_findkeynode().
 *
 * Requires:
 *
 *\li	'keytable' is a valid keytable.
 *
 *\li	*keynodep is a valid keynode returned by a call to
 *	dns_keytable_findkeynode().
 *
 * Ensures:
 *
 *\li	*keynodep == NULL
 */

isc_result_t
dns_keytable_issecuredomain(dns_keytable_t *keytable, dns_name_t *name,
			    dns_name_t *foundname, bool *wantdnssecp);
/*%<
 * Is 'name' at or beneath a trusted key?
 *
 * Requires:
 *
 *\li	'keytable' is a valid keytable.
 *
 *\li	'name' is a valid absolute name.
 *
 *\li	'foundanme' is NULL or is a pointer to an initialized dns_name_t
 *
 *\li	'*wantsdnssecp' is a valid bool.

* Ensures:
 *
 *\li	On success, *wantsdnssecp will be true if and only if 'name'
 *	is at or beneath a trusted key.  If 'foundname' is not NULL, then
 *	it will be updated to contain the name of the closest enclosing
 *	trust anchor.
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *
 *\li	Any other result is an error.
 */

isc_result_t
dns_keytable_dump(dns_keytable_t *keytable, FILE *fp);
/*%<
 * Dump the keytable on fp.
 */

isc_result_t
dns_keytable_totext(dns_keytable_t *keytable, isc_buffer_t **buf);
/*%<
 * Dump the keytable to buffer at 'buf'
 */

dst_key_t *
dns_keynode_key(dns_keynode_t *keynode);
/*%<
 * Get the DST key associated with keynode.
 */

bool
dns_keynode_managed(dns_keynode_t *keynode);
/*%<
 * Is this flagged as a managed key?
 */

isc_result_t
dns_keynode_create(isc_mem_t *mctx, dns_keynode_t **target);
/*%<
 * Allocate space for a keynode
 */

void
dns_keynode_attach(dns_keynode_t *source, dns_keynode_t **target);
/*%<
 * Attach keynode 'source' to '*target'
 */

void
dns_keynode_detach(isc_mem_t *mctx, dns_keynode_t **target);
/*%<
 * Detach a single keynode, without touching any keynodes that
 * may be pointed to by its 'next' pointer
 */

void
dns_keynode_detachall(isc_mem_t *mctx, dns_keynode_t **target);
/*%<
 * Detach a keynode and all its successors.
 */

isc_result_t
dns_keytable_forall(dns_keytable_t *keytable,
		    void (*func)(dns_keytable_t *, dns_keynode_t *, void *),
		    void *arg);
ISC_LANG_ENDDECLS

#endif /* DNS_KEYTABLE_H */

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

~ ACUPOFTEA - accounting.gulfstore-gcc.com