message.h 30.9 KB
Newer Older
1
/*
Bob Halley's avatar
Bob Halley committed
2
 * Copyright (C) 1999, 2000  Internet Software Consortium.
3
 *
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.
16 17
 */

18
/* $Id: message.h,v 1.83 2000/11/13 21:34:01 bwelling Exp $ */
David Lawrence's avatar
David Lawrence committed
19

20 21
#ifndef DNS_MESSAGE_H
#define DNS_MESSAGE_H 1
22 23 24 25 26

/***
 ***	Imports
 ***/

27 28
#include <isc/lang.h>
#include <isc/magic.h>
29

Michael Graff's avatar
Michael Graff committed
30
#include <dns/compress.h>
31
#include <dns/types.h>
32

33 34
#include <dst/dst.h>

35 36 37
/*
 * How this beast works:
 *
38
 * When a dns message is received in a buffer, dns_message_fromwire() is called
39 40 41 42 43
 * on the memory region.  Various items are checked including the format
 * of the message (if counts are right, if counts consume the entire sections,
 * and if sections consume the entire message) and known pseudo-RRs in the
 * additional data section are analyzed and removed.
 *
Brian Wellington's avatar
Brian Wellington committed
44 45
 * TSIG checking is also done at this layer, and any DNSSEC transaction
 * signatures should also be checked here.
46 47 48 49
 *
 * Notes on using the gettemp*() and puttemp*() functions:
 *
 * These functions return items (names, rdatasets, etc) allocated from some
50 51 52 53
 * internal state of the dns_message_t.
 *
 * Names and rdatasets must be put back into the dns_message_t in
 * one of two ways.  Assume a name was allocated via
54 55 56 57 58 59
 * dns_message_gettempname():
 *
 *	(1) insert it into a section, using dns_message_addname().
 *
 *	(2) return it to the message using dns_message_puttempname().
 *
60 61 62 63 64 65 66
 * The same applies to rdatasets.
 *
 * On the other hand, rdatalists and rdatas allocated using
 * dns_message_gettemp*() will always be freed automatically
 * when the message is reset or destroyed; calling dns_message_puttemp*()
 * on these is optional and serves only to enable the item to be reused
 * multiple times during the lifetime of the message.
67 68 69 70 71 72 73 74
 *
 * Buffers allocated using isc_buffer_allocate() can be automatically freed
 * as well by giving the buffer to the message using dns_message_takebuffer().
 * Doing this will cause the buffer to be freed using isc_buffer_free()
 * when the section lists are cleared, such as in a reset or in a destroy.
 * Since the buffer itself exists until the message is destroyed, this sort
 * of code can be written:
 *
75
 *	buffer = isc_buffer_allocate(mctx, 512);
76 77 78 79 80 81 82 83 84 85
 *	name = NULL;
 *	name = dns_message_gettempname(message, &name);
 *	dns_name_init(name, NULL);
 *	result = dns_name_fromtext(name, &source, dns_rootname, ISC_FALSE,
 *				   buffer);
 *	dns_message_takebuffer(message, &buffer);
 *
 *
 * TODO:
 *
Brian Wellington's avatar
Brian Wellington committed
86 87
 * XXX Needed:  ways to set and retrieve EDNS information, add rdata to a
 * section, move rdata from one section to another, remove rdata, etc.
88 89
 */

90 91 92 93 94
#define DNS_MESSAGEFLAG_QR		0x8000U
#define DNS_MESSAGEFLAG_AA		0x0400U
#define DNS_MESSAGEFLAG_TC		0x0200U
#define DNS_MESSAGEFLAG_RD		0x0100U
#define DNS_MESSAGEFLAG_RA		0x0080U
Bob Halley's avatar
Bob Halley committed
95 96
#define DNS_MESSAGEFLAG_AD		0x0020U
#define DNS_MESSAGEFLAG_CD		0x0010U
97

98 99
#define DNS_MESSAGEEXTFLAG_DO		0x8000U

Bob Halley's avatar
Bob Halley committed
100
#define DNS_MESSAGE_REPLYPRESERVE	(DNS_MESSAGEFLAG_RD)
101

Bob Halley's avatar
Bob Halley committed
102 103 104
#define DNS_MESSAGE_HEADERLEN		12 /* 6 isc_uint16_t's */

#define DNS_MESSAGE_MAGIC		0x4d534740U	/* MSG@ */
Michael Graff's avatar
Michael Graff committed
105
#define DNS_MESSAGE_VALID(msg)		ISC_MAGIC_VALID(msg, DNS_MESSAGE_MAGIC)
Michael Graff's avatar
Michael Graff committed
106

Michael Graff's avatar
Michael Graff committed
107 108 109 110
/*
 * Ordering here matters.  DNS_SECTION_ANY must be the lowest and negative,
 * and DNS_SECTION_MAX must be one greater than the last used section.
 */
Michael Graff's avatar
Michael Graff committed
111
typedef int dns_section_t;
Michael Graff's avatar
Michael Graff committed
112
#define DNS_SECTION_ANY			(-1)
Michael Graff's avatar
Michael Graff committed
113 114 115 116
#define DNS_SECTION_QUESTION		0
#define DNS_SECTION_ANSWER		1
#define DNS_SECTION_AUTHORITY		2
#define DNS_SECTION_ADDITIONAL		3
117
#define DNS_SECTION_MAX			4
118

119 120 121 122 123 124 125
typedef int dns_pseudosection_t;
#define DNS_PSEUDOSECTION_ANY		(-1)
#define DNS_PSEUDOSECTION_OPT           0
#define DNS_PSEUDOSECTION_TSIG          1
#define DNS_PSEUDOSECTION_SIG0          2
#define DNS_PSEUDOSECTION_MAX           3

126 127 128 129
typedef int dns_messagetextflag_t;
#define DNS_MESSAGETEXTFLAG_NOCOMMENTS	0x0001
#define DNS_MESSAGETEXTFLAG_NOHEADERS	0x0002
#define DNS_MESSAGETEXTFLAG_OMITDOT	0x0004
130

131
/*
Andreas Gustafsson's avatar
Andreas Gustafsson committed
132
 * Dynamic update names for these sections.
133 134 135 136
 */
#define DNS_SECTION_ZONE		DNS_SECTION_QUESTION
#define DNS_SECTION_PREREQUISITE	DNS_SECTION_ANSWER
#define DNS_SECTION_UPDATE		DNS_SECTION_AUTHORITY
Michael Graff's avatar
Michael Graff committed
137 138

/*
Michael Graff's avatar
Michael Graff committed
139
 * These tell the message library how the created dns_message_t will be used.
Michael Graff's avatar
Michael Graff committed
140
 */
Michael Graff's avatar
Michael Graff committed
141 142 143
#define DNS_MESSAGE_INTENTUNKNOWN	0 /* internal use only */
#define DNS_MESSAGE_INTENTPARSE		1 /* parsing messages */
#define DNS_MESSAGE_INTENTRENDER	2 /* rendering */
Michael Graff's avatar
Michael Graff committed
144

145 146 147 148 149 150 151 152
/*
 * Control behavior of parsing
 */
#define DNS_MESSAGEPARSE_PRESERVEORDER	0x0001	/* preserve rdata order */
#define DNS_MESSAGEPARSE_BESTEFFORT	0x0002	/* return a message if a
						   recoverable parse error
						   occurs */

Michael Graff's avatar
Michael Graff committed
153 154 155 156 157
/*
 * Control behavior of rendering
 */
#define DNS_MESSAGERENDER_ORDERED	0x0001	/* don't change order */

Michael Graff's avatar
Michael Graff committed
158 159
typedef struct dns_msgblock dns_msgblock_t;

Bob Halley's avatar
Bob Halley committed
160
struct dns_message {
Michael Graff's avatar
Michael Graff committed
161
	/* public from here down */
Michael Graff's avatar
Michael Graff committed
162
	unsigned int			magic;
163

164
	dns_messageid_t			id;
Michael Graff's avatar
Michael Graff committed
165 166 167
	unsigned int			flags;
	unsigned int			rcode;
	unsigned int			opcode;
Michael Graff's avatar
Michael Graff committed
168
	dns_rdataclass_t		rdclass;
Michael Graff's avatar
Michael Graff committed
169

170
	/* 4 real, 1 pseudo */
Michael Graff's avatar
Michael Graff committed
171
	unsigned int			counts[DNS_SECTION_MAX];
Michael Graff's avatar
Michael Graff committed
172 173

	/* private from here down */
Michael Graff's avatar
Michael Graff committed
174 175
	dns_namelist_t			sections[DNS_SECTION_MAX];
	dns_name_t		       *cursors[DNS_SECTION_MAX];
Bob Halley's avatar
Bob Halley committed
176
	dns_rdataset_t		       *opt;
177
	dns_rdataset_t		       *sig0;
178
	dns_rdataset_t		       *tsig;
179

Michael Graff's avatar
Michael Graff committed
180
	int				state;
Michael Graff's avatar
Michael Graff committed
181
	unsigned int			from_to_wire : 2;
182
	unsigned int			need_cctx_cleanup : 1;
Bob Halley's avatar
Bob Halley committed
183 184
	unsigned int			header_ok : 1;
	unsigned int			question_ok : 1;
185
	unsigned int			tcp_continuation : 1;
186 187
	unsigned int			verified_sig : 1;
	unsigned int			verify_attempted : 1;
188

189
	unsigned int			opt_reserved;
190
	unsigned int			sig_reserved;
191
	unsigned int			reserved; /* reserved space (render) */
192

193
	isc_buffer_t		       *buffer;
Michael Graff's avatar
Michael Graff committed
194
	dns_compress_t			cctx;
195

Michael Graff's avatar
Michael Graff committed
196
	isc_mem_t		       *mctx;
197 198 199
	isc_mempool_t		       *namepool;
	isc_mempool_t		       *rdspool;

200
	isc_bufferlist_t		scratchpad;
201 202
	isc_bufferlist_t		cleanup;

Michael Graff's avatar
Michael Graff committed
203 204
	ISC_LIST(dns_msgblock_t)	rdatas;
	ISC_LIST(dns_msgblock_t)	rdatalists;
205 206 207

	ISC_LIST(dns_rdata_t)		freerdata;
	ISC_LIST(dns_rdatalist_t)	freerdatalist;
208 209 210

	dns_rcode_t			tsigstatus;
	dns_rcode_t			querytsigstatus;
211
	dns_name_t		       *tsigname;
212
	dns_rdataset_t		       *querytsig;
213
	dns_tsigkey_t		       *tsigkey;
Brian Wellington's avatar
Brian Wellington committed
214
	dst_context_t		       *tsigctx;
215 216
	int				sigstart;

217
	dns_name_t		       *sig0name;
218 219 220
	dst_key_t		       *sig0key;
	dns_rcode_t			sig0status;
	isc_region_t		       *query;
Brian Wellington's avatar
Brian Wellington committed
221
	isc_region_t		       *saved;
222
	isc_buffer_t		       *rawmessge;
223 224 225

	dns_rdatasetorderfunc_t		order;
	void *				order_arg;
Bob Halley's avatar
Bob Halley committed
226
};
227

228 229 230 231 232 233
/***
 *** Functions
 ***/

ISC_LANG_BEGINDECLS

234
isc_result_t
235
dns_message_create(isc_mem_t *mctx, unsigned int intent, dns_message_t **msgp);
236

237
/*
Michael Graff's avatar
Michael Graff committed
238
 * Create msg structure.
239
 *
Michael Graff's avatar
Michael Graff committed
240
 * This function will allocate some internal blocks of memory that are
Michael Graff's avatar
Michael Graff committed
241
 * expected to be needed for parsing or rendering nearly any type of message.
Michael Graff's avatar
Michael Graff committed
242 243 244
 *
 * Requires:
 *	'mctx' be a valid memory context.
245
 *
Michael Graff's avatar
Michael Graff committed
246
 *	'msgp' be non-null and '*msg' be NULL.
Michael Graff's avatar
Michael Graff committed
247
 *
Andreas Gustafsson's avatar
typo  
Andreas Gustafsson committed
248 249
 *	'intent' must be one of DNS_MESSAGE_INTENTPARSE or
 *	DNS_MESSAGE_INTENTRENDER.
Michael Graff's avatar
Michael Graff committed
250 251
 *
 * Ensures:
Michael Graff's avatar
Michael Graff committed
252
 *	The data in "*msg" is set to indicate an unused and empty msg
Michael Graff's avatar
Michael Graff committed
253 254 255
 *	structure.
 *
 * Returns:
256 257
 *	ISC_R_NOMEMORY		-- out of memory
 *	ISC_R_SUCCESS		-- success
258 259
 */

Michael Graff's avatar
Michael Graff committed
260
void
Bob Halley's avatar
Bob Halley committed
261
dns_message_reset(dns_message_t *msg, unsigned int intent);
Michael Graff's avatar
Michael Graff committed
262 263 264 265 266 267
/*
 * Reset a message structure to default state.  All internal lists are freed
 * or reset to a default state as well.  This is simply a more efficient
 * way to call dns_message_destroy() followed by dns_message_allocate(),
 * since it avoid many memory allocations.
 *
Michael Graff's avatar
Michael Graff committed
268 269 270
 * If any data loanouts (buffers, names, rdatas, etc) were requested,
 * the caller must no longer use them after this call.
 *
Bob Halley's avatar
Bob Halley committed
271 272
 * The intended next use of the message will be 'intent'.
 *
Michael Graff's avatar
Michael Graff committed
273 274 275
 * Requires:
 *
 *	'msg' be valid.
Bob Halley's avatar
Bob Halley committed
276 277
 *
 *	'intent' is DNS_MESSAGE_INTENTPARSE or DNS_MESSAGE_INTENTRENDER
Michael Graff's avatar
Michael Graff committed
278
 */
Michael Graff's avatar
Michael Graff committed
279

Michael Graff's avatar
Michael Graff committed
280
void
Michael Graff's avatar
Michael Graff committed
281
dns_message_destroy(dns_message_t **msgp);
Michael Graff's avatar
Michael Graff committed
282
/*
Michael Graff's avatar
Michael Graff committed
283 284 285 286
 * Destroy all state in the message.
 *
 * Requires:
 *
Michael Graff's avatar
Michael Graff committed
287
 *	'msgp' be valid.
Michael Graff's avatar
Michael Graff committed
288 289
 *
 * Ensures:
Michael Graff's avatar
Michael Graff committed
290
 *	'*msgp' == NULL
Michael Graff's avatar
Michael Graff committed
291 292
 */

293 294
isc_result_t
dns_message_sectiontotext(dns_message_t *msg, dns_section_t section,
295
			  dns_messagetextflag_t flags,
296
			  isc_buffer_t *target);
297 298 299 300

isc_result_t
dns_message_pseudosectiontotext(dns_message_t *msg,
				dns_pseudosection_t section,
301
				dns_messagetextflag_t flags,
302
				isc_buffer_t *target);
303
/*
304
 * Convert section 'section' or 'pseudosection' of message 'msg' to
305
 * a cleartext representation
306 307
 *
 * Notes:
308
 *      See dns_message_totext for meanings of flags.
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
 *
 * Requires:
 *
 *	'msg' is a valid message.
 *
 *	'target' is a valid buffer.
 *
 *	'section' is a valid section label.
 *
 * Ensures:
 *
 *	If the result is success:
 *
 *		Any bitstring labels are in canonical form.
 *
 *		The used space in 'target' is updated.
 *
 * Returns:
 *
 *	ISC_R_SUCCESS
 *	ISC_R_NOSPACE
 *	ISC_R_NOMORE
 *
332
 *	Note: On error return, *target may be partially filled with data.
333 334 335
*/

isc_result_t
336
dns_message_totext(dns_message_t *msg, dns_messagetextflag_t flags,
337 338 339 340 341
		   isc_buffer_t *target);
/*
 * Convert all sections of message 'msg' to a cleartext representation
 *
 * Notes:
342
 *      In flags, If DNS_MESSAGETEXTFLAG_OMITDOT is set, then the
343
 *      final '.' in absolute names will not be emitted.  If
344
 *      DNS_MESSAGETEXTFLAG_NOCOMMENTS is cleared, lines beginning
345 346
 *      with ";;" will be emitted indicating section name.  If
 *      DNS_MESSAGETEXTFLAG_NOHEADERS is cleared, header lines will
347
 *      be emitted.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
 *
 * Requires:
 *
 *	'msg' is a valid message.
 *
 *	'target' is a valid buffer.
 *
 * Ensures:
 *
 *	If the result is success:
 *
 *		Any bitstring labels are in canonical form.
 *
 *		The used space in 'target' is updated.
 *
 * Returns:
 *
 *	ISC_R_SUCCESS
 *	ISC_R_NOSPACE
 *	ISC_R_NOMORE
 *
369 370
 *	Note: On error return, *target may be partially filled with data.
 */
371

372
isc_result_t
373
dns_message_parse(dns_message_t *msg, isc_buffer_t *source,
374
		  unsigned int options);
Michael Graff's avatar
Michael Graff committed
375
/*
Michael Graff's avatar
Michael Graff committed
376 377 378 379
 * Parse raw wire data pointed to by "buffer" and bounded by "buflen" as a
 * DNS message.
 *
 * OPT records are detected and stored in the pseudo-section "opt".
Brian Wellington's avatar
Brian Wellington committed
380
 * TSIGs are detected and stored in the pseudo-section "tsig".
Michael Graff's avatar
Michael Graff committed
381
 *
382 383 384 385
 * If DNS_MESSAGEPARSE_PRESERVEORDER is set, or if the opcode of the message
 * is UPDATE, a separate dns_name_t object will be created for each RR in the
 * message.  Each such dns_name_t will have a single rdataset containing the
 * single RR, * and the order of the RRs in the message is preserved.
386 387
 * Otherwise, only one dns_name_t object will be created for each unique
 * owner name in the section, and each such dns_name_t will have a list
388 389
 * of rdatasets.  To access the names and their data, use
 * dns_message_firstname() and dns_message_nextname().
390
 *
391 392 393 394
 * If DNS_MESSAGEPARSE_BESTEFFORT is set, errors in message content will
 * not be considered FORMERRs.  If the entire message can be parsed, it
 * will be returned and DNS_R_RECOVERABLE will be returned.
 *
395 396 397
 * OPT and TSIG records are always handled specially, regardless of the
 * 'preserve_order' setting.
 *
Michael Graff's avatar
Michael Graff committed
398 399 400
 * Requires:
 *	"msg" be valid.
 *
401
 *	"buffer" be a wire format buffer.
Michael Graff's avatar
Michael Graff committed
402 403 404 405
 *
 * Ensures:
 *	The buffer's data format is correct.
 *
Michael Graff's avatar
Michael Graff committed
406 407
 *	The buffer's contents verify as correct regarding header bits, buffer
 * 	and rdata sizes, etc.
Michael Graff's avatar
Michael Graff committed
408 409
 *
 * Returns:
410 411
 *	ISC_R_SUCCESS		-- all is well
 *	ISC_R_NOMEMORY		-- no memory
412 413
 *	DNS_R_RECOVERABLE	-- the message parsed properly, but contained
 *				   errors.
Michael Graff's avatar
Michael Graff committed
414 415
 *	DNS_R_???		-- bad signature (XXXMLG need more of these)
 *	Many other errors possible XXXMLG
Michael Graff's avatar
Michael Graff committed
416 417
 */

418
isc_result_t
Michael Graff's avatar
Michael Graff committed
419
dns_message_renderbegin(dns_message_t *msg, isc_buffer_t *buffer);
Michael Graff's avatar
Michael Graff committed
420
/*
Michael Graff's avatar
Michael Graff committed
421 422
 * Begin rendering on a message.  Only one call can be made to this function
 * per message.
Michael Graff's avatar
Michael Graff committed
423
 *
Andreas Gustafsson's avatar
Andreas Gustafsson committed
424
 * The buffer is "owned" by the message library until dns_message_renderend()
Michael Graff's avatar
Michael Graff committed
425 426
 * is called.
 *
Michael Graff's avatar
Michael Graff committed
427
 * Requires:
Michael Graff's avatar
Michael Graff committed
428 429
 *
 *	'msg' be valid.
430
 *
431
 *	'buffer' is a valid buffer.
Michael Graff's avatar
Michael Graff committed
432 433 434 435
 *
 * Side Effects:
 *
 *	The buffer is cleared before it is used.
436
 *
Michael Graff's avatar
Michael Graff committed
437
 * Returns:
438 439
 *	ISC_R_SUCCESS		-- all is well
 *	ISC_R_NOSPACE		-- output buffer is too small
Michael Graff's avatar
Michael Graff committed
440
 *	Anything that dns_compress_init() can return.
Michael Graff's avatar
Michael Graff committed
441 442
 */

443
isc_result_t
444 445 446
dns_message_renderchangebuffer(dns_message_t *msg, isc_buffer_t *buffer);
/*
 * Reset the buffer.  This can be used after growing the old buffer
447
 * on a ISC_R_NOSPACE return from most of the render functions.
448
 *
Michael Graff's avatar
Michael Graff committed
449 450 451 452
 * On successful completion, the old buffer is no longer used by the
 * library.  The new buffer is owned by the library until
 * dns_message_renderend() is called.
 *
453 454 455 456 457 458 459 460 461
 * Requires:
 *
 *	'msg' be valid.
 *
 *	dns_message_renderbegin() was called.
 *
 *	buffer != NULL.
 *
 * Returns:
462 463
 *	ISC_R_NOSPACE		-- new buffer is too small
 *	ISC_R_SUCCESS		-- all is well.
464 465
 */

466
isc_result_t
467
dns_message_renderreserve(dns_message_t *msg, unsigned int space);
Michael Graff's avatar
Michael Graff committed
468
/*
Michael Graff's avatar
Michael Graff committed
469 470 471
 * XXXMLG should use size_t rather than unsigned int once the buffer
 * API is cleaned up
 *
Michael Graff's avatar
Michael Graff committed
472 473 474 475 476
 * Reserve "space" bytes in the given buffer.
 *
 * Requires:
 *
 *	'msg' be valid.
Michael Graff's avatar
Michael Graff committed
477
 *
478 479
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
480
 * Returns:
481 482
 *	ISC_R_SUCCESS		-- all is well.
 *	ISC_R_NOSPACE		-- not enough free space in the buffer.
Michael Graff's avatar
Michael Graff committed
483 484
 */

485
void
Michael Graff's avatar
Michael Graff committed
486 487
dns_message_renderrelease(dns_message_t *msg, unsigned int space);
/*
Michael Graff's avatar
Michael Graff committed
488 489 490
 * XXXMLG should use size_t rather than unsigned int once the buffer
 * API is cleaned up
 *
Michael Graff's avatar
Michael Graff committed
491 492 493 494 495 496
 * Release "space" bytes in the given buffer that was previously reserved.
 *
 * Requires:
 *
 *	'msg' be valid.
 *
497 498
 *	'space' is less than or equal to the total amount of space reserved
 *	via prior calls to dns_message_renderreserve().
499
 *
500
 *	dns_message_renderbegin() was called.
Michael Graff's avatar
Michael Graff committed
501 502
 */

503
isc_result_t
504
dns_message_rendersection(dns_message_t *msg, dns_section_t section,
Michael Graff's avatar
Michael Graff committed
505
			  unsigned int options);
Michael Graff's avatar
Michael Graff committed
506
/*
Michael Graff's avatar
Michael Graff committed
507 508
 * Render all names, rdatalists, etc from the given section at the
 * specified priority or higher.
Michael Graff's avatar
Michael Graff committed
509 510
 *
 * Requires:
Michael Graff's avatar
Michael Graff committed
511 512 513
 *	'msg' be valid.
 *
 *	'section' be a valid section.
Michael Graff's avatar
Michael Graff committed
514
 *
515 516
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
517
 * Returns:
518
 *	ISC_R_SUCCESS		-- all records were written, and there are
Michael Graff's avatar
Michael Graff committed
519
 *				   no more records for this section.
520
 *	ISC_R_NOSPACE		-- Not enough room in the buffer to write
Michael Graff's avatar
Michael Graff committed
521 522 523
 *				   all records requested.
 *	DNS_R_MOREDATA		-- All requested records written, and there
 *				   are records remaining for this section.
Michael Graff's avatar
Michael Graff committed
524 525
 */

526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
void
dns_message_renderheader(dns_message_t *msg, isc_buffer_t *target);
/*
 * Render the message header.  This is implicitly called by
 * dns_message_renderend().
 *
 * Requires:
 *
 *	'msg' be a valid message.
 *
 *	dns_message_renderbegin() was called.
 *
 *	'target' is a valid buffer with enough space to hold a message header
 */

541
isc_result_t
542
dns_message_renderend(dns_message_t *msg);
Michael Graff's avatar
Michael Graff committed
543
/*
Michael Graff's avatar
Michael Graff committed
544 545 546 547 548 549 550 551
 * Finish rendering to the buffer.  Note that more data can be in the
 * 'msg' structure.  Destroying the structure will free this, or in a multi-
 * part EDNS1 message this data can be rendered to another buffer later.
 *
 * Requires:
 *
 *	'msg' be a valid message.
 *
552 553
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
554
 * Returns:
555
 *	ISC_R_SUCCESS		-- all is well.
Michael Graff's avatar
Michael Graff committed
556
 */
557

Bob Halley's avatar
Bob Halley committed
558 559 560 561 562 563 564 565 566 567 568 569 570 571
void
dns_message_renderreset(dns_message_t *msg);
/*
 * Reset the message so that it may be rendered again.
 *
 * Notes:
 *
 *	If dns_message_renderbegin() has been called, dns_message_renderend()
 *	must be called before calling this function.
 *
 * Requires:
 *
 *	'msg' be a valid message with rendering intent.
 */
Michael Graff's avatar
Michael Graff committed
572

573
isc_result_t
Michael Graff's avatar
Michael Graff committed
574 575 576 577
dns_message_firstname(dns_message_t *msg, dns_section_t section);
/*
 * Set internal per-section name pointer to the beginning of the section.
 *
Michael Graff's avatar
Michael Graff committed
578
 * The functions dns_message_firstname() and dns_message_nextname() may
579
 * be used for iterating over the owner names in a section.
Michael Graff's avatar
Michael Graff committed
580
 *
Michael Graff's avatar
Michael Graff committed
581 582 583 584 585 586 587
 * Requires:
 *
 *   	'msg' be valid.
 *
 *	'section' be a valid section.
 *
 * Returns:
588 589
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMORE		-- No names on given section.
Michael Graff's avatar
Michael Graff committed
590 591
 */

592
isc_result_t
Michael Graff's avatar
Michael Graff committed
593 594 595 596 597 598 599 600 601 602 603
dns_message_nextname(dns_message_t *msg, dns_section_t section);
/*
 * Sets the internal per-section name pointer to point to the next name
 * in that section.
 *
 * Requires:
 *
 *   	'msg' be valid.
 *
 *	'section' be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
604
 *	dns_message_firstname() must have been called on this section,
605
 *	and the result was ISC_R_SUCCESS.
Michael Graff's avatar
Michael Graff committed
606
 *
Michael Graff's avatar
Michael Graff committed
607
 * Returns:
608 609
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMORE		-- No names in given section.
Michael Graff's avatar
Michael Graff committed
610 611
 */

Michael Graff's avatar
Michael Graff committed
612
void
Michael Graff's avatar
Michael Graff committed
613 614 615 616 617 618
dns_message_currentname(dns_message_t *msg, dns_section_t section,
			dns_name_t **name);
/*
 * Sets 'name' to point to the name where the per-section internal name
 * pointer is currently set.
 *
Michael Graff's avatar
Michael Graff committed
619 620 621
 * This function returns the name in the database, so any data associated
 * with it (via the name's "list" member) contains the actual rdatasets.
 *
Michael Graff's avatar
Michael Graff committed
622 623 624 625 626 627 628 629
 * Requires:
 *
 *	'msg' be valid.
 *
 *	'name' be non-NULL, and *name be NULL.
 *
 *	'section' be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
630 631
 *	dns_message_firstname() must have been called on this section,
 *	and the result of it and any dns_message_nextname() calls was
632
 *	ISC_R_SUCCESS.
Michael Graff's avatar
Michael Graff committed
633 634
 */

635
isc_result_t
Michael Graff's avatar
Michael Graff committed
636 637
dns_message_findname(dns_message_t *msg, dns_section_t section,
		     dns_name_t *target, dns_rdatatype_t type,
Bob Halley's avatar
Bob Halley committed
638 639
		     dns_rdatatype_t covers, dns_name_t **foundname,
		     dns_rdataset_t **rdataset);
Michael Graff's avatar
Michael Graff committed
640
/*
Michael Graff's avatar
Michael Graff committed
641 642
 * Search for a name in the specified section.  If it is found, *name is
 * set to point to the name, and *rdataset is set to point to the found
Bob Halley's avatar
Bob Halley committed
643
 * rdataset (if type is specified as other than dns_rdatatype_any).
Michael Graff's avatar
Michael Graff committed
644 645 646 647 648 649
 *
 * Requires:
 *	'msg' be valid.
 *
 *	'section' be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
650 651
 *	If a pointer to the name is desired, 'foundname' should be non-NULL.
 *	If it is non-NULL, '*foundname' MUST be NULL.
Michael Graff's avatar
Michael Graff committed
652 653 654
 *
 *	If a type other than dns_datatype_any is searched for, 'rdataset'
 *	may be non-NULL, '*rdataset' be NULL, and will point at the found
Michael Graff's avatar
Michael Graff committed
655
 *	rdataset.  If the type is dns_datatype_any, 'rdataset' must be NULL.
Michael Graff's avatar
Michael Graff committed
656 657 658 659 660 661
 *
 *	'target' be a valid name.
 *
 *	'type' be a valid type.
 *
 * Returns:
662
 *	ISC_R_SUCCESS		-- all is well.
Michael Graff's avatar
Michael Graff committed
663
 *	DNS_R_NXDOMAIN		-- name does not exist in that section.
664
 *	DNS_R_NXRRSET		-- The name does exist, but the desired
Michael Graff's avatar
Michael Graff committed
665
 *				   type does not.
Michael Graff's avatar
Michael Graff committed
666 667
 */

668
isc_result_t
669 670 671 672 673 674 675 676 677 678 679 680
dns_message_findtype(dns_name_t *name, dns_rdatatype_t type,
		     dns_rdatatype_t covers, dns_rdataset_t **rdataset);
/*
 * Search the name for the specified type.  If it is found, *rdataset is
 * filled in with a pointer to that rdataset.
 *
 * Requires:
 *	if '**rdataset' is non-NULL, *rdataset needs to be NULL.
 *
 *	'type' be a valid type, and NOT dns_rdatatype_any.
 *
 * Returns:
681 682
 *	ISC_R_SUCCESS		-- all is well.
 *	ISC_R_NOTFOUND		-- the desired type does not exist.
683 684
 */

Michael Graff's avatar
Michael Graff committed
685 686 687 688
void
dns_message_movename(dns_message_t *msg, dns_name_t *name,
		     dns_section_t fromsection,
		     dns_section_t tosection);
Michael Graff's avatar
Michael Graff committed
689 690
/*
 * Move a name from one section to another.
Michael Graff's avatar
Michael Graff committed
691 692 693 694 695
 *
 * Requires:
 *
 *	'msg' be valid.
 *
Michael Graff's avatar
Michael Graff committed
696
 *	'name' must be a name already in 'fromsection'.
Michael Graff's avatar
Michael Graff committed
697 698 699
 *
 *	'fromsection' must be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
700
 *	'tosection' must be a valid section.
Michael Graff's avatar
Michael Graff committed
701 702
 */

Michael Graff's avatar
Michael Graff committed
703 704 705
void
dns_message_addname(dns_message_t *msg, dns_name_t *name,
		    dns_section_t section);
Michael Graff's avatar
Michael Graff committed
706 707 708
/*
 * Adds the name to the given section.
 *
Michael Graff's avatar
Michael Graff committed
709 710
 * It is the caller's responsibility to enforce any unique name requirements
 * in a section.
Michael Graff's avatar
Michael Graff committed
711 712 713 714 715 716 717 718
 *
 * Requires:
 *
 *	'msg' be valid, and be a renderable message.
 *
 *	'name' be a valid name.
 *
 *	'section' be a named section.
Michael Graff's avatar
Michael Graff committed
719
 */
720

721 722 723 724 725 726 727 728
/*
 * LOANOUT FUNCTIONS
 *
 * Each of these functions loan a particular type of data to the caller.
 * The storage for these will vanish when the message is destroyed or
 * reset, and must NOT be used after these operations.
 */

729
isc_result_t
730 731 732
dns_message_gettempname(dns_message_t *msg, dns_name_t **item);
/*
 * Return a name that can be used for any temporary purpose, including
733 734 735
 * inserting into the message's linked lists.  The name must be returned
 * to the message code using dns_message_puttempname() or inserted into
 * one of the message's sections before the message is destroyed.
736 737 738 739 740 741 742 743 744
 *
 * It is the caller's responsibility to initialize this name.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item == NULL
 *
 * Returns:
745 746
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
747 748
 */

749
isc_result_t
750 751 752
dns_message_gettemprdata(dns_message_t *msg, dns_rdata_t **item);
/*
 * Return a rdata that can be used for any temporary purpose, including
753 754
 * inserting into the message's linked lists.  The rdata will be freed
 * when the message is destroyed or reset.
755 756 757 758 759 760 761
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item == NULL
 *
 * Returns:
762 763
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
764 765
 */

766
isc_result_t
767 768 769
dns_message_gettemprdataset(dns_message_t *msg, dns_rdataset_t **item);
/*
 * Return a rdataset that can be used for any temporary purpose, including
770 771 772
 * inserting into the message's linked lists. The name must be returned
 * to the message code using dns_message_puttempname() or inserted into
 * one of the message's sections before the message is destroyed.
773 774 775 776 777 778 779
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item == NULL
 *
 * Returns:
780 781
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
782 783
 */

784
isc_result_t
785 786 787
dns_message_gettemprdatalist(dns_message_t *msg, dns_rdatalist_t **item);
/*
 * Return a rdatalist that can be used for any temporary purpose, including
788 789
 * inserting into the message's linked lists.  The rdatalist will be
 * destroyed when the message is destroyed or reset.
790 791 792 793 794 795 796
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item == NULL
 *
 * Returns:
797 798
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
 */

void
dns_message_puttempname(dns_message_t *msg, dns_name_t **item);
/*
 * Return a borrowed name to the message's name free list.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item point to a name returned by
 *	dns_message_gettempname()
 *
 * Ensures:
 *	*item == NULL
 */

void
dns_message_puttemprdata(dns_message_t *msg, dns_rdata_t **item);
/*
 * Return a borrowed rdata to the message's rdata free list.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item point to a rdata returned by
 *	dns_message_gettemprdata()
 *
 * Ensures:
 *	*item == NULL
 */

void
dns_message_puttemprdataset(dns_message_t *msg, dns_rdataset_t **item);
/*
 * Return a borrowed rdataset to the message's rdataset free list.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item point to a rdataset returned by
 *	dns_message_gettemprdataset()
 *
 * Ensures:
 *	*item == NULL
 */

void
dns_message_puttemprdatalist(dns_message_t *msg, dns_rdatalist_t **item);
/*
 * Return a borrowed rdatalist to the message's rdatalist free list.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item point to a rdatalist returned by
 *	dns_message_gettemprdatalist()
 *
 * Ensures:
 *	*item == NULL
 */

861
isc_result_t
Michael Graff's avatar
Michael Graff committed
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
dns_message_peekheader(isc_buffer_t *source, dns_messageid_t *idp,
		       unsigned int *flagsp);
/*
 * Assume the remaining region of "source" is a DNS message.  Peek into
 * it and fill in "*idp" with the message id, and "*flagsp" with the flags.
 *
 * Requires:
 *
 *	source != NULL
 *
 * Ensures:
 *
 *	if (idp != NULL) *idp == message id.
 *
 *	if (flagsp != NULL) *flagsp == message flags.
 *
 * Returns:
 *
880
 *	ISC_R_SUCCESS		-- all is well.
Michael Graff's avatar
Michael Graff committed
881
 *
882
 *	ISC_R_UNEXPECTEDEND	-- buffer doesn't contain enough for a header.
Michael Graff's avatar
Michael Graff committed
883 884
 */

885
isc_result_t
Bob Halley's avatar
Bob Halley committed
886 887 888 889 890 891
dns_message_reply(dns_message_t *msg, isc_boolean_t want_question_section);
/*
 * Start formatting a reply to the query in 'msg'.
 *
 * Requires:
 *
Bob Halley's avatar
EDNS0  
Bob Halley committed
892
 *	'msg' is a valid message with parsing intent, and contains a query.
893
 *
Bob Halley's avatar
Bob Halley committed
894 895 896
 * Ensures:
 *
 *	The message will have a rendering intent.  If 'want_question_section'
897 898 899 900 901
 *	is true, the message opcode is query or notify, and the question
 *	section is present and properly formatted, then the question section
 *	will be included in the reply.  All other sections will be cleared.
 *	The QR flag will be set, the RD flag will be preserved, and all other
 *	flags will be cleared.
Bob Halley's avatar
Bob Halley committed
902 903 904
 *
 * Returns:
 *
905
 *	ISC_R_SUCCESS		-- all is well.
Bob Halley's avatar
Bob Halley committed
906
 *
Bob Halley's avatar
Bob Halley committed
907 908 909 910 911 912 913
 *	DNS_R_FORMERR		-- the header or question section of the
 *				   message is invalid, replying is impossible.
 *				   If DNS_R_FORMERR is returned when
 *				   want_question_section is ISC_FALSE, then
 *				   it's the header section that's bad;
 *				   otherwise either of the header or question
 *				   sections may be bad.
Bob Halley's avatar
Bob Halley committed
914 915
 */

Bob Halley's avatar
EDNS0  
Bob Halley committed
916 917 918 919 920 921 922 923 924 925 926 927 928 929
dns_rdataset_t *
dns_message_getopt(dns_message_t *msg);
/*
 * Get the OPT record for 'msg'.
 *
 * Requires:
 *
 *	'msg' is a valid message.
 *
 * Returns:
 *
 *	The OPT rdataset of 'msg', or NULL if there isn't one.
 */

930
isc_result_t
Bob Halley's avatar
EDNS0  
Bob Halley committed
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
dns_message_setopt(dns_message_t *msg, dns_rdataset_t *opt);
/*
 * Set the OPT record for 'msg'.
 *
 * Requires:
 *
 *	'msg' is a valid message with rendering intent,
 *	dns_message_renderbegin() has been called, and no sections have been
 *	rendered.
 *
 *	'opt' is a valid OPT record.
 *
 * Ensures:
 *
 *	The OPT record will be rendered when dns_message_renderend() is
 *	called.
 *
 * Returns:
 *
950
 *	ISC_R_SUCCESS		-- all is well.
Bob Halley's avatar
EDNS0  
Bob Halley committed
951
 *
952
 *	ISC_R_NOSPACE		-- there is no space for the OPT record.
Bob Halley's avatar
EDNS0  
Bob Halley committed
953 954
 */

955 956 957 958 959 960 961 962
dns_rdataset_t *
dns_message_gettsig(dns_message_t *msg, dns_name_t **owner);
/*
 * Get the TSIG record and owner for 'msg'.
 *
 * Requires:
 *
 *	'msg' is a valid message.
963
 *	'owner' is NULL or *owner is NULL.
964 965 966 967
 *
 * Returns:
 *
 *	The TSIG rdataset of 'msg', or NULL if there isn't one.
968 969 970 971
 *
 * Ensures:
 *
 * 	If 'owner' is not NULL, it will point to the owner name.
972 973
 */

974
isc_result_t
975 976 977 978 979 980 981 982
dns_message_settsigkey(dns_message_t *msg, dns_tsigkey_t *key);
/*
 * Set the tsig key for 'msg'.  This is only necessary for when rendering a
 * query or parsing a response.  The key (if non-NULL) is attached to, and
 * will be detached when the message is destroyed.
 *
 * Requires:
 *
983 984 985
 *	'msg' is a valid message with rendering intent,
 *	dns_message_renderbegin() has been called, and no sections have been
 *	rendered.
986
 *	'key' is a valid tsig key or NULL.
987 988 989 990 991 992
 *
 * Returns:
 *
 *	ISC_R_SUCCESS		-- all is well.
 *
 *	ISC_R_NOSPACE		-- there is no space for the TSIG record.
993 994 995 996 997 998 999 1000 1001 1002 1003 1004
 */

dns_tsigkey_t *
dns_message_gettsigkey(dns_message_t *msg);
/*
 * Gets the tsig key for 'msg'.
 *
 * Requires:
 *
 *	'msg' is a valid message
 */

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
isc_result_t
dns_message_setquerytsig(dns_message_t *msg, isc_buffer_t *querytsig);
/*
 * Indicates that 'querytsig' is the TSIG from the signed query for which
 * 'msg' is the response.  This is also used for chained TSIGs in TCP
 * responses.
 *
 * Requires:
 *
 *	'querytsig' is a valid buffer as returned by dns_message_getquerytsig()
 *	or NULL
 *
 *	'msg' is a valid message
 *
 * Returns:
 *
 *	ISC_R_SUCCESS
 *	ISC_R_NOMEMORY
 */

isc_result_t
dns_message_getquerytsig(dns_message_t *msg, isc_mem_t *mctx,
			 isc_buffer_t **querytsig);
/*
 * Gets the tsig from the TSIG from the signed query 'msg'.  This is also used
 * for chained TSIGs in TCP responses.  Unlike dns_message_gettsig, this makes
 * a copy of the data, so can be used if the message is destroyed.
 *
 * Requires:
 *
 *	'msg' is a valid signed message
 *	'mctx' is a valid memory context
 *	querytsig != NULL && *querytsig == NULL
 *
 * Returns:
 *
 *	ISC_R_SUCCESS
 *	ISC_R_NOMEMORY
 *
 * Ensures:
 * 	'tsig' points to NULL or an allocated buffer which must be freed
 * 	by the caller.
 */

1049
dns_rdataset_t *
1050
dns_message_getsig0(dns_message_t *msg, dns_name_t **owner);
1051
/*
1052
 * Get the SIG(0) record and owner for 'msg'.
1053 1054 1055 1056
 *
 * Requires:
 *
 *	'msg' is a valid message.
1057
 *	'owner' is NULL or *owner is NULL.
1058 1059 1060 1061
 *
 * Returns:
 *
 *	The SIG(0) rdataset of 'msg', or NULL if there isn't one.
1062 1063 1064 1065
 *
 * Ensures:
 *
 * 	If 'owner' is not NULL, it will point to the owner name.
1066 1067
 */

1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
isc_result_t
dns_message_setsig0key(dns_message_t *msg, dst_key_t *key);
/*
 * Set the SIG(0) key for 'msg'.
 *
 * Requires:
 *
 *	'msg' is a valid message with rendering intent,
 *	dns_message_renderbegin() has been called, and no sections have been
 *	rendered.
 *	'key' is a valid sig key or NULL.
 *
 * Returns:
 *
 *	ISC_R_SUCCESS		-- all is well.
 *
 *	ISC_R_NOSPACE		-- there is no space for the SIG(0) record.
 */

dst_key_t *
dns_message_getsig0key(dns_message_t *msg);
/*
 * Gets the SIG(0) key for 'msg'.
 *
 * Requires:
 *
 *	'msg' is a valid message
 */

1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
void
dns_message_takebuffer(dns_message_t *msg, isc_buffer_t **buffer);
/*
 * Give the *buffer to the message code to clean up when it is no
 * longer needed.  This is usually when the message is reset or
 * destroyed.
 *
 * Requires:
 *
 *	msg be a valid message.
 *
 *	buffer != NULL && *buffer is a valid isc_buffer_t, which was
 *	dynamincally allocated via isc_buffer_allocate().
 */

Brian Wellington's avatar
Brian Wellington committed
1112
isc_result_t
1113
dns_message_signer(dns_message_t *msg, dns_name_t *signer);
Brian Wellington's avatar
Brian Wellington committed
1114
/*
1115
 * If this message was signed, return the identity of the signer.
Brian Wellington's avatar
Brian Wellington committed
1116 1117
 * Unless ISC_R_NOTFOUND is returned, signer will reflect the name of the
 * key that signed the message.
Brian Wellington's avatar
Brian Wellington committed
1118 1119 1120
 *
 * Requires:
 *
1121 1122
 *	msg is a valid parsed message.
 *	signer is a valid name
Brian Wellington's avatar
Brian Wellington committed
1123 1124 1125 1126 1127 1128
 *
 * Returns:
 *
 *	ISC_R_SUCCESS		- the message was signed, and *signer
 *				  contains the signing identity
 *
1129
 *	ISC_R_NOTFOUND		- no TSIG or SIG(0) record is present in the
Brian Wellington's avatar
Brian Wellington committed
1130 1131
 *				  message
 *
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
 *	DNS_R_TSIGVERIFYFAILURE	- the message was signed by a TSIG, but the
 *				  signature failed to verify
 *
 *	DNS_R_TSIGERRORSET	- the message was signed by a TSIG and
 *				  verified, but the query was rejected by
 *				  the server
 *
 *	DNS_R_NOIDENTITY	- the message was signed by a TSIG and
 *				  verified, but the key has no identity since
 *				  it was generated by an unsigned TKEY process
Brian Wellington's avatar
Brian Wellington committed
1142
 *
1143 1144
 *	DNS_R_SIGINVALID	- the message was signed by a SIG(0), but
 *				  the signature failed to verify
Brian Wellington's avatar
Brian Wellington committed
1145
 *
1146 1147
 *	DNS_R_SIGNOTVERIFIEDYET	- the message was signed by a SIG(0), but
 *				  the signature has not been verified yet
Brian Wellington's avatar
Brian Wellington committed
1148 1149
 */

Brian Wellington's avatar
Brian Wellington committed
1150 1151 1152 1153 1154 1155 1156 1157
isc_result_t
dns_message_checksig(dns_message_t *msg, dns_view_t *view);
/*
 * If this message was signed, verify the signature.
 *
 * Requires:
 *
 *	msg is a valid parsed message.