view.h 17.1 KB
Newer Older
Bob Halley's avatar
add  
Bob Halley committed
1
/*
Brian Wellington's avatar
Brian Wellington committed
2
 * Copyright (C) 1999-2001  Internet Software Consortium.
3
 *
Bob Halley's avatar
add  
Bob Halley committed
4 5 6
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
7
 *
8 9 10 11 12 13 14 15
 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
 * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
 * INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Bob Halley's avatar
add  
Bob Halley committed
16 17
 */

18
/* $Id: view.h,v 1.77 2002/03/07 13:46:34 marka Exp $ */
David Lawrence's avatar
David Lawrence committed
19

Bob Halley's avatar
add  
Bob Halley committed
20 21 22 23 24 25 26 27 28 29
#ifndef DNS_VIEW_H
#define DNS_VIEW_H 1

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

/*
 * DNS View
 *
Bob Halley's avatar
Bob Halley committed
30 31 32 33 34 35 36 37 38 39 40 41
 * A "view" is a DNS namespace, together with an optional resolver and a
 * forwarding policy.  A "DNS namespace" is a (possibly empty) set of
 * authoritative zones together with an optional cache and optional
 * "hints" information.
 *
 * Views start out "unfrozen".  In this state, core attributes like
 * the cache, set of zones, and forwarding policy may be set.  While
 * "unfrozen", the caller (e.g. nameserver configuration loading
 * code), must ensure exclusive access to the view.  When the view is
 * "frozen", the core attributes become immutable, and the view module
 * will ensure synchronization.  Freezing allows the view's core attributes
 * to be accessed without locking.
Bob Halley's avatar
add  
Bob Halley committed
42 43
 *
 * MP:
Bob Halley's avatar
Bob Halley committed
44 45 46 47
 *	Before the view is frozen, the caller must ensure synchronization.
 *
 *	After the view is frozen, the module guarantees appropriate
 *	synchronization of any data structures it creates and manipulates.
Bob Halley's avatar
add  
Bob Halley committed
48 49 50 51 52 53 54 55 56 57 58
 *
 * Reliability:
 *	No anticipated impact.
 *
 * Resources:
 *	<TBS>
 *
 * Security:
 *	No anticipated impact.
 *
 * Standards:
59 60
 *	None.
 */
Bob Halley's avatar
add  
Bob Halley committed
61

Brian Wellington's avatar
Brian Wellington committed
62 63
#include <stdio.h>

Bob Halley's avatar
add  
Bob Halley committed
64
#include <isc/lang.h>
65
#include <isc/magic.h>
Bob Halley's avatar
add  
Bob Halley committed
66
#include <isc/event.h>
Brian Wellington's avatar
Brian Wellington committed
67
#include <isc/mutex.h>
68
#include <isc/net.h>
69
#include <isc/refcount.h>
70
#include <isc/rwlock.h>
Bob Halley's avatar
Bob Halley committed
71
#include <isc/stdtime.h>
Bob Halley's avatar
add  
Bob Halley committed
72

73
#include <dns/acl.h>
Bob Halley's avatar
add  
Bob Halley committed
74 75 76 77 78 79 80 81 82 83
#include <dns/types.h>

ISC_LANG_BEGINDECLS

struct dns_view {
	/* Unlocked. */
	unsigned int			magic;
	isc_mem_t *			mctx;
	dns_rdataclass_t		rdclass;
	char *				name;
84
	dns_zt_t *			zonetable;
Bob Halley's avatar
add  
Bob Halley committed
85
	dns_resolver_t *		resolver;
Bob Halley's avatar
add adb  
Bob Halley committed
86
	dns_adb_t *			adb;
Mark Andrews's avatar
Mark Andrews committed
87
	dns_requestmgr_t *		requestmgr;
88
	dns_cache_t *			cache;
Bob Halley's avatar
Bob Halley committed
89
	dns_db_t *			cachedb;
Bob Halley's avatar
Bob Halley committed
90
	dns_db_t *			hints;
91 92
	dns_keytable_t *		secroots;
	dns_keytable_t *		trustedkeys;
Bob Halley's avatar
add  
Bob Halley committed
93
	isc_mutex_t			lock;
Bob Halley's avatar
Bob Halley committed
94
	isc_boolean_t			frozen;
95 96 97
	isc_task_t *			task;
	isc_event_t			resevent;
	isc_event_t			adbevent;
Mark Andrews's avatar
Mark Andrews committed
98
	isc_event_t			reqevent;
99
	/* Configurable data. */
Brian Wellington's avatar
Brian Wellington committed
100 101
	dns_tsig_keyring_t *		statickeys;
	dns_tsig_keyring_t *		dynamickeys;
102
	dns_peerlist_t *		peers;
103
	dns_order_t *			order;
104
	dns_fwdtable_t *		fwdtable;
105 106
	isc_boolean_t			recursion;
	isc_boolean_t			auth_nxdomain;
Michael Graff's avatar
 
Michael Graff committed
107 108
	isc_boolean_t			additionalfromcache;
	isc_boolean_t			additionalfromauth;
Bob Halley's avatar
Bob Halley committed
109
	isc_boolean_t			minimalresponses;
110
	dns_transfer_format_t		transfer_format;
111 112
	dns_acl_t *			queryacl;
	dns_acl_t *			recursionacl;
113
	dns_acl_t *			v6synthesisacl;
114
	dns_acl_t *			sortlist;
115 116
	isc_boolean_t			requestixfr;
	isc_boolean_t			provideixfr;
117 118
	dns_ttl_t			maxcachettl;
	dns_ttl_t			maxncachettl;
119
	in_port_t			dstport;
120
	dns_aclenv_t			aclenv;
121

122 123 124 125 126
	/*
	 * Configurable data for server use only,
	 * locked by server configuration lock.
	 */
	dns_acl_t *			matchclients;
127 128
	dns_acl_t *			matchdestinations;
	isc_boolean_t			matchrecursiveonly;
129

130 131 132
	/* Locked by themselves. */
	isc_refcount_t			references;

Bob Halley's avatar
add  
Bob Halley committed
133
	/* Locked by lock. */
134
	unsigned int			weakrefs;
135
	unsigned int			attributes;
Bob Halley's avatar
add  
Bob Halley committed
136 137 138 139
	/* Under owner's locking control. */
	ISC_LINK(struct dns_view)	link;
};

140
#define DNS_VIEW_MAGIC			ISC_MAGIC('V','i','e','w')
141
#define DNS_VIEW_VALID(view)		ISC_MAGIC_VALID(view, DNS_VIEW_MAGIC)
Bob Halley's avatar
add  
Bob Halley committed
142

143 144
#define DNS_VIEWATTR_RESSHUTDOWN	0x01
#define DNS_VIEWATTR_ADBSHUTDOWN	0x02
Mark Andrews's avatar
Mark Andrews committed
145
#define DNS_VIEWATTR_REQSHUTDOWN	0x04
146

Bob Halley's avatar
add  
Bob Halley committed
147
isc_result_t
148 149
dns_view_create(isc_mem_t *mctx, dns_rdataclass_t rdclass,
		const char *name, dns_view_t **viewp);
Bob Halley's avatar
Bob Halley committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
/*
 * Create a view.
 *
 * Notes:
 *
 *	The newly created view has no cache, no resolver, and an empty
 *	zone table.  The view is not frozen.
 *
 * Requires:
 *
 *	'mctx' is a valid memory context.
 *
 *	'rdclass' is a valid class.
 *
 *	'name' is a valid C string.
 *
 *	viewp != NULL && *viewp == NULL
 *
 * Returns:
 *
 *	ISC_R_SUCCESS
 *	ISC_R_NOMEMORY
 *
 *	Other errors are possible.
 */
Bob Halley's avatar
add  
Bob Halley committed
175 176 177

void
dns_view_attach(dns_view_t *source, dns_view_t **targetp);
Bob Halley's avatar
Bob Halley committed
178 179 180 181 182 183 184 185 186 187 188 189
/*
 * Attach '*targetp' to 'source'.
 *
 * Requires:
 *
 *	'source' is a valid, frozen view.
 *
 *	'targetp' points to a NULL dns_view_t *.
 *
 * Ensures:
 *
 *	*targetp is attached to source.
190 191
 *
 *	While *targetp is attached, the view will not shut down.
Bob Halley's avatar
Bob Halley committed
192
 */
Bob Halley's avatar
add  
Bob Halley committed
193 194 195

void
dns_view_detach(dns_view_t **viewp);
Bob Halley's avatar
Bob Halley committed
196 197 198 199 200
/*
 * Detach '*viewp' from its view.
 *
 * Requires:
 *
201
 *	'viewp' points to a valid dns_view_t *
Bob Halley's avatar
Bob Halley committed
202 203 204 205
 *
 * Ensures:
 *
 *	*viewp is NULL.
206 207
 */

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
void
dns_view_flushanddetach(dns_view_t **viewp);
/*
 * Detach '*viewp' from its view.  If this was the last reference
 * uncommited changed in zones will be flushed to disk.
 *
 * Requires:
 *
 *	'viewp' points to a valid dns_view_t *
 *
 * Ensures:
 *
 *	*viewp is NULL.
 */

223 224 225 226 227 228 229 230 231 232 233 234
void
dns_view_weakattach(dns_view_t *source, dns_view_t **targetp);
/*
 * Weakly attach '*targetp' to 'source'.
 *
 * Requires:
 *
 *	'source' is a valid, frozen view.
 *
 *	'targetp' points to a NULL dns_view_t *.
 *
 * Ensures:
Bob Halley's avatar
Bob Halley committed
235
 *
236 237 238 239 240 241 242 243 244
 *	*targetp is attached to source.
 *
 * 	While *targetp is attached, the view will not be freed.
 */

void
dns_view_weakdetach(dns_view_t **targetp);
/*
 * Detach '*viewp' from its view.
Bob Halley's avatar
Bob Halley committed
245
 *
246 247 248 249 250 251 252
 * Requires:
 *
 *	'viewp' points to a valid dns_view_t *.
 *
 * Ensures:
 *
 *	*viewp is NULL.
Bob Halley's avatar
Bob Halley committed
253
 */
Bob Halley's avatar
add  
Bob Halley committed
254

Bob Halley's avatar
Bob Halley committed
255
isc_result_t
Bob Halley's avatar
Bob Halley committed
256 257 258 259
dns_view_createresolver(dns_view_t *view,
			isc_taskmgr_t *taskmgr, unsigned int ntasks,
			isc_socketmgr_t *socketmgr,
			isc_timermgr_t *timermgr,
260
			unsigned int options,
261
			dns_dispatchmgr_t *dispatchmgr,
262 263
			dns_dispatch_t *dispatchv4,
			dns_dispatch_t *dispatchv6);
Bob Halley's avatar
Bob Halley committed
264
/*
Bob Halley's avatar
add adb  
Bob Halley committed
265
 * Create a resolver and address database for the view.
Bob Halley's avatar
Bob Halley committed
266 267 268
 *
 * Requires:
 *
Bob Halley's avatar
Bob Halley committed
269
 *	'view' is a valid, unfrozen view.
Bob Halley's avatar
Bob Halley committed
270
 *
Bob Halley's avatar
Bob Halley committed
271
 *	'view' does not have a resolver already.
Bob Halley's avatar
Bob Halley committed
272
 *
Bob Halley's avatar
Bob Halley committed
273
 *	The requirements of dns_resolver_create() apply to 'taskmgr',
274 275
 *	'ntasks', 'socketmgr', 'timermgr', 'options', 'dispatchv4', and
 *	'dispatchv6'.
Bob Halley's avatar
Bob Halley committed
276 277
 *
 * Returns:
Bob Halley's avatar
Bob Halley committed
278
 *
Bob Halley's avatar
Bob Halley committed
279 280 281
 *     	ISC_R_SUCCESS
 *
 *	Any error that dns_resolver_create() can return.
Bob Halley's avatar
Bob Halley committed
282
 */
283 284

void
285
dns_view_setcache(dns_view_t *view, dns_cache_t *cache);
Bob Halley's avatar
Bob Halley committed
286 287 288 289 290
/*
 * Set the view's cache database.
 *
 * Requires:
 *
Bob Halley's avatar
add adb  
Bob Halley committed
291
 *	'view' is a valid, unfrozen view.
Bob Halley's avatar
Bob Halley committed
292
 *
293
 *	'cache' is a valid cache.
Bob Halley's avatar
Bob Halley committed
294 295 296
 *
 * Ensures:
 *
297
 *     	The cache of 'view' is 'cached.
Bob Halley's avatar
add adb  
Bob Halley committed
298
 *
299 300
 *	If this is not the first call to dns_view_setcache() for this
 *	view, then previously set cache is detached.
Bob Halley's avatar
Bob Halley committed
301
 */
302

Bob Halley's avatar
Bob Halley committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
void
dns_view_sethints(dns_view_t *view, dns_db_t *hints);
/*
 * Set the view's hints database.
 *
 * Requires:
 *
 *	'view' is a valid, unfrozen view, whose hints database has not been
 *	set.
 *
 *	'hints' is a valid zone database.
 *
 * Ensures:
 *
 *     	The hints database of 'view' is 'hints'.
 */

Brian Wellington's avatar
Brian Wellington committed
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
void
dns_view_setkeyring(dns_view_t *view, dns_tsig_keyring_t *ring);
/*
 * Set the view's static TSIG keys
 *
 * Requires:
 *
 *      'view' is a valid, unfrozen view, whose static TSIG keyring has not
 *	been set.
 *
 *      'ring' is a valid TSIG keyring
 *
 * Ensures:
 *
 *      The static TSIG keyring of 'view' is 'ring'.
 */

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
void
dns_view_setdstport(dns_view_t *view, in_port_t dstport);
/*
 * Set the view's destination port.  This is the port to
 * which outgoing queries are sent.  The default is 53,
 * the standard DNS port.
 *
 * Requires:
 *
 *      'view' is a valid view.
 *
 *      'dstport' is a valid TCP/UDP port number.
 *
 * Ensures:
 *	External name servers will be assumed to be listning
 *	on 'dstport'.  For servers whose address has already
 *	obtained obtained at the time of the call, the view may
 *	continue to use the previously set port until the address
 *	times out from the view's address database.
 */
Brian Wellington's avatar
Brian Wellington committed
357 358


359
isc_result_t
360
dns_view_addzone(dns_view_t *view, dns_zone_t *zone);
Bob Halley's avatar
Bob Halley committed
361
/*
362
 * Add zone 'zone' to 'view'.
Bob Halley's avatar
Bob Halley committed
363 364 365 366 367
 *
 * Requires:
 *
 *	'view' is a valid, unfrozen view.
 *
368 369
 *	'zone' is a valid zone.
 */
370 371 372

void
dns_view_freeze(dns_view_t *view);
Bob Halley's avatar
Bob Halley committed
373 374 375 376 377 378 379 380 381 382 383 384 385 386
/*
 * Freeze view.
 *
 * Requires:
 *
 *	'view' is a valid, unfrozen view.
 *
 * Ensures:
 *
 *	'view' is frozen.
 */

isc_result_t
dns_view_find(dns_view_t *view, dns_name_t *name, dns_rdatatype_t type,
387 388
	      isc_stdtime_t now, unsigned int options, isc_boolean_t use_hints,
	      dns_db_t **dbp, dns_dbnode_t **nodep, dns_name_t *foundname,
Bob Halley's avatar
Bob Halley committed
389
	      dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset);
390 391 392 393 394 395 396 397 398 399 400 401 402 403
/*
 * Find an rdataset whose owner name is 'name', and whose type is
 * 'type'.
 *
 * Notes:
 *
 *	See the description of dns_db_find() for information about 'options'.
 *	If the caller sets DNS_DBFIND_GLUEOK, it must ensure that 'name'
 *	and 'type' are appropriate for glue retrieval.
 *
 *	If 'now' is zero, then the current time will be used.
 *
 *	If 'use_hints' is ISC_TRUE, and the view has a hints database, then
 *	it will be searched last.  If the answer is found in the hints
404 405 406
 *	database, the result code will be DNS_R_HINT.  If the name is found
 *	in the hints database but not the type, the result code will be
 *	DNS_R_HINTNXRRSET.
407 408 409 410 411 412 413 414 415 416 417 418 419
 *
 *	'foundname' must meet the requirements of dns_db_find().
 *
 *	If 'sigrdataset' is not NULL, and there is a SIG rdataset which
 *	covers 'type', then 'sigrdataset' will be bound to it.
 *
 * Requires:
 *
 *	'view' is a valid, frozen view.
 *
 *	'name' is valid name.
 *
 *	'type' is a valid dns_rdatatype_t, and is not a meta query type
420
 *	except dns_rdatatype_any.
421
 *
422 423 424 425 426
 *	dbp == NULL || *dbp == NULL
 *
 *	nodep == NULL || *nodep == NULL.  If nodep != NULL, dbp != NULL.
 *
 *	'foundname' is a valid name with a dedicated buffer or NULL.
427 428 429 430 431 432 433 434 435 436
 *
 *	'rdataset' is a valid, disassociated rdataset.
 *
 *	'sigrdataset' is NULL, or is a valid, disassociated rdataset.
 *
 * Ensures:
 *
 *	In successful cases, 'rdataset', and possibly 'sigrdataset', are
 *	bound to the found data.
 *
437 438 439 440 441 442
 *	If dbp != NULL, it points to the database containing the data.
 *
 *	If nodep != NULL, it points to the database node containing the data.
 *
 *	If foundname != NULL, it contains the full name of the found data.
 *
443 444 445 446 447 448 449 450 451 452 453
 * Returns:
 *
 *	Any result that dns_db_find() can return, with the exception of
 *	DNS_R_DELEGATION.
 */

isc_result_t
dns_view_simplefind(dns_view_t *view, dns_name_t *name, dns_rdatatype_t type,
		    isc_stdtime_t now, unsigned int options,
		    isc_boolean_t use_hints,
		    dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset);
Bob Halley's avatar
Bob Halley committed
454 455 456 457 458 459 460
/*
 * Find an rdataset whose owner name is 'name', and whose type is
 * 'type'.
 *
 * Notes:
 *
 *	This routine is appropriate for simple, exact-match queries of the
Bob Halley's avatar
Bob Halley committed
461 462
 *	view.  'name' must be a canonical name; there is no DNAME or CNAME
 *	processing.
Bob Halley's avatar
Bob Halley committed
463 464 465 466 467 468 469
 *
 *	See the description of dns_db_find() for information about 'options'.
 *	If the caller sets DNS_DBFIND_GLUEOK, it must ensure that 'name'
 *	and 'type' are appropriate for glue retrieval.
 *
 *	If 'now' is zero, then the current time will be used.
 *
Bob Halley's avatar
Bob Halley committed
470 471
 *	If 'use_hints' is ISC_TRUE, and the view has a hints database, then
 *	it will be searched last.  If the answer is found in the hints
472 473 474
 *	database, the result code will be DNS_R_HINT.  If the name is found
 *	in the hints database but not the type, the result code will be
 *	DNS_R_HINTNXRRSET.
Bob Halley's avatar
Bob Halley committed
475
 *
Bob Halley's avatar
Bob Halley committed
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
 *	If 'sigrdataset' is not NULL, and there is a SIG rdataset which
 *	covers 'type', then 'sigrdataset' will be bound to it.
 *
 * Requires:
 *
 *	'view' is a valid, frozen view.
 *
 *	'name' is valid name.
 *
 *	'type' is a valid dns_rdatatype_t, and is not a meta query type
 *	(e.g. dns_rdatatype_any), or dns_rdatatype_sig.
 *
 *	'rdataset' is a valid, disassociated rdataset.
 *
 *	'sigrdataset' is NULL, or is a valid, disassociated rdataset.
 *
 * Ensures:
 *
494 495
 *	In successful cases, 'rdataset', and possibly 'sigrdataset', are
 *	bound to the found data.
Bob Halley's avatar
Bob Halley committed
496 497 498
 *
 * Returns:
 *
499
 *	ISC_R_SUCCESS			Success; result is desired type.
500 501 502 503
 *	DNS_R_GLUE			Success; result is glue.
 *	DNS_R_HINT			Success; result is a hint.
 *	DNS_R_NCACHENXDOMAIN		Success; result is a ncache entry.
 *	DNS_R_NCACHENXRRSET		Success; result is a ncache entry.
504 505
 *	DNS_R_NXDOMAIN			The name does not exist.
 *	DNS_R_NXRRSET			The rrset does not exist.
506 507
 *	ISC_R_NOTFOUND			No matching data found,
 *					or an error occurred.
Bob Halley's avatar
Bob Halley committed
508
 */
509

Bob Halley's avatar
Bob Halley committed
510 511 512 513 514 515 516 517
isc_result_t
dns_view_findzonecut(dns_view_t *view, dns_name_t *name, dns_name_t *fname,
		     isc_stdtime_t now, unsigned int options,
		     isc_boolean_t use_hints,
		     dns_rdataset_t *rdataset, dns_rdataset_t *sigrdataset);
/*
 * Find the best known zonecut containing 'name'.
 *
Andreas Gustafsson's avatar
Andreas Gustafsson committed
518 519 520
 * This uses local authority, cache, and optionally hints data.
 * No external queries are performed.
 *
Bob Halley's avatar
Bob Halley committed
521 522 523 524 525 526 527 528 529 530
 * Notes:
 *
 *	If 'now' is zero, then the current time will be used.
 *
 *	If 'use_hints' is ISC_TRUE, and the view has a hints database, then
 *	it will be searched last.
 *
 *	If 'sigrdataset' is not NULL, and there is a SIG rdataset which
 *	covers 'type', then 'sigrdataset' will be bound to it.
 *
Andreas Gustafsson's avatar
Andreas Gustafsson committed
531
 *	If the DNS_DBFIND_NOEXACT option is set, then the zonecut returned
532
 *	(if any) will be the deepest known ancestor of 'name'.
Andreas Gustafsson's avatar
Andreas Gustafsson committed
533
 *
Bob Halley's avatar
Bob Halley committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
 * Requires:
 *
 *	'view' is a valid, frozen view.
 *
 *	'name' is valid name.
 *
 *	'rdataset' is a valid, disassociated rdataset.
 *
 *	'sigrdataset' is NULL, or is a valid, disassociated rdataset.
 *
 * Returns:
 *
 *	ISC_R_SUCCESS				Success.
 *
 *	Many other results are possible.
 */

551 552 553
isc_result_t
dns_viewlist_find(dns_viewlist_t *list, const char *name,
		  dns_rdataclass_t rdclass, dns_view_t **viewp);
554
/*
555 556 557 558 559 560 561 562 563 564 565
 * Search for a view with name 'name' and class 'rdclass' in 'list'.
 * If found, '*viewp' is (strongly) attached to it.
 *
 * Requires:
 *
 *	'viewp' points to a NULL dns_view_t *.
 *
 * Returns:
 *
 *	ISC_R_SUCCESS		A matching view was found.
 *	ISC_R_NOTFOUND		No matching view was found.
566 567
 */

568
isc_result_t
569
dns_view_findzone(dns_view_t *view, dns_name_t *name, dns_zone_t **zonep);
570
/*
571 572 573 574 575 576 577 578 579 580 581 582
 * Search for the zone 'name' in the zone table of 'view'.
 * If found, 'zonep' is (strongly) attached to it.  There
 * are no partial matches.
 *
 * Requires:
 *
 *	'zonep' points to a NULL dns_zone_t *.
 *
 * Returns:
 *	ISC_R_SUCCESS		A matching zone was found.
 *	ISC_R_NOTFOUND		No matching zone was found.
 *	others			An error occurred.
583 584
 */

585 586
isc_result_t
dns_view_load(dns_view_t *view, isc_boolean_t stop);
587 588 589

isc_result_t
dns_view_loadnew(dns_view_t *view, isc_boolean_t stop);
Mark Andrews's avatar
Mark Andrews committed
590
/*
591 592 593 594 595 596 597
 * Load zones attached to this view.  dns_view_load() loads
 * all zones whose master file has changed since the last
 * load; dns_view_loadnew() loads only zones that have never 
 * been loaded.
 *
 * If 'stop' is ISC_TRUE, stop on the first error and return it.
 * If 'stop' is ISC_FALSE, ignore errors.
Mark Andrews's avatar
Mark Andrews committed
598 599 600
 *
 * Requires:
 *
601
 *	'view' is valid.
Mark Andrews's avatar
Mark Andrews committed
602
 */
603

604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
isc_result_t
dns_view_gettsig(dns_view_t *view, dns_name_t *keyname,
		 dns_tsigkey_t **keyp);
/*
 * Find the TSIG key configured in 'view' with name 'keyname',
 * if any.
 *
 * Reqires:
 *	keyp points to a NULL dns_tsigkey_t *.
 *
 * Returns:
 *	ISC_R_SUCCESS	A key was found and '*keyp' now points to it.
 *	ISC_R_NOTFOUND	No key was found.
 *	others		An error occurred.
 */

isc_result_t
dns_view_getpeertsig(dns_view_t *view, isc_netaddr_t *peeraddr,
		     dns_tsigkey_t **keyp);
/*
 * Find the TSIG key configured in 'view' for the server whose
 * address is 'peeraddr', if any.
 *
 * Reqires:
 *	keyp points to a NULL dns_tsigkey_t *.
 *
 * Returns:
 *	ISC_R_SUCCESS	A key was found and '*keyp' now points to it.
 *	ISC_R_NOTFOUND	No key was found.
 *	others		An error occurred.
 */

Brian Wellington's avatar
Brian Wellington committed
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
isc_result_t
dns_view_checksig(dns_view_t *view, isc_buffer_t *source, dns_message_t *msg);
/*
 * Verifies the signature of a message.
 *
 * Requires:
 *
 *	'view' is a valid view.
 *	'source' is a valid buffer containing the message
 *	'msg' is a valid message
 *
 * Returns:
 *	see dns_tsig_verify()
 */

Mark Andrews's avatar
Mark Andrews committed
651 652
void
dns_view_dialup(dns_view_t *view);
653 654 655
/*
 * Perform dialup-time maintenance on the zones of 'view'.
 */
Mark Andrews's avatar
Mark Andrews committed
656

657
isc_result_t
658
dns_view_dumpdbtostream(dns_view_t *view, FILE *fp);
659
/*
660 661 662 663 664 665 666
 * Dump the current state of the view 'view' to the stream 'fp'
 * for purposes of analysis or debugging.
 *
 * Currently the dumped state includes the view's cache; in the future
 * it may also include other state such as the address database.
 * It will not not include authoritative data since it is voluminous and
 * easily obtainable by other means.
667 668 669 670 671
 *
 * Requires:
 * 	
 *	'view' is valid.
 *
672
 *	'fp' refers to a file open for writing.
673 674 675 676 677 678
 *
 * Returns:
 * 	ISC_R_SUCCESS	The cache was successfully dumped.
 * 	others		An error occurred (see dns_master_dump)
 */

679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
isc_result_t
dns_view_flushcache(dns_view_t *view);
/*
 * Flush the view's cache (and ADB).
 *
 * Requires:
 * 	'view' is valid.
 *
 * 	No other tasks are executing.
 *
 * Returns:
 *	ISC_R_SUCCESS
 *	ISC_R_NOMEMORY
 */

694 695 696 697 698 699 700 701 702 703 704 705 706 707
isc_result_t
dns_view_flushname(dns_view_t *view, dns_name_t *);
/*
 * Flush the given name from the view's cache (and ADB).
 *
 * Requires:
 *	'view' is valid.
 *	'name' is valid.
 *
 * Returns:
 *	ISC_R_SUCCESS
 *	other returns are failures.
 */

Bob Halley's avatar
add  
Bob Halley committed
708 709 710
ISC_LANG_ENDDECLS

#endif /* DNS_VIEW_H */