message.h 28 KB
Newer Older
1
/*
Bob Halley's avatar
Bob Halley committed
2
 * Copyright (C) 1999, 2000  Internet Software Consortium.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
 * 
 * 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.
 * 
 * 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.
 */

18 19
#ifndef DNS_MESSAGE_H
#define DNS_MESSAGE_H 1
20 21 22 23 24

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

25 26
#include <isc/lang.h>
#include <isc/magic.h>
27

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

32 33
#include <dst/dst.h>

34 35 36
/*
 * How this beast works:
 *
37
 * When a dns message is received in a buffer, dns_message_fromwire() is called
38 39 40 41 42 43 44 45
 * 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.
 *
 * TSIG checking is also done at this layer, and any DNSSEC information should
 * also be performed at this time.
 *
46
 * If dns_message_fromwire() returns DNS_R_MOREDATA additional
47 48
 * message packets are required.  This implies an EDNS message.
 *
49
 * When going from structure to wire, dns_message_towire() will return
Michael Graff's avatar
typo  
Michael Graff committed
50
 * DNS_R_MOREDATA if there is more data left in the output buffer that
51 52
 * could not be rendered into the exisiting buffer.
 *
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
 *
 * Notes on using the gettemp*() and puttemp*() functions:
 *
 * These functions return items (names, rdatasets, etc) allocated from some
 * internal state of the dns_message_t.  These items must be put back into
 * the dns_message_t in one of two ways.  Assume a name was allocated via
 * dns_message_gettempname():
 *
 *	(1) insert it into a section, using dns_message_addname().
 *
 *	(2) return it to the message using dns_message_puttempname().
 *
 * The same applies to rdata, rdatasets, and rdatalists which were
 * allocated using this group of functions.
 *
 * 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:
 *
86 87 88 89 90
 * XXX Needed:  ways to handle TSIG and DNSSEC, supply TSIG and DNSSEC
 * keys, set and retrieve EDNS information, add rdata to a section,
 * move rdata from one section to another, remove rdata, etc.
 */

91 92 93 94 95
#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
96 97
#define DNS_MESSAGEFLAG_AD		0x0020U
#define DNS_MESSAGEFLAG_CD		0x0010U
98

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

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

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

Michael Graff's avatar
Michael Graff committed
106 107 108 109
/*
 * 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
110
typedef int dns_section_t;
Michael Graff's avatar
Michael Graff committed
111
#define DNS_SECTION_ANY			(-1)
Michael Graff's avatar
Michael Graff committed
112 113 114 115
#define DNS_SECTION_QUESTION		0
#define DNS_SECTION_ANSWER		1
#define DNS_SECTION_AUTHORITY		2
#define DNS_SECTION_ADDITIONAL		3
116
#define DNS_SECTION_MAX			4
117

118 119 120 121 122 123 124
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

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

130
/*
Andreas Gustafsson's avatar
Andreas Gustafsson committed
131
 * Dynamic update names for these sections.
132 133 134 135
 */
#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
136 137

/*
Michael Graff's avatar
Michael Graff committed
138
 * These tell the message library how the created dns_message_t will be used.
Michael Graff's avatar
Michael Graff committed
139
 */
Michael Graff's avatar
Michael Graff committed
140 141 142
#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
143

Michael Graff's avatar
Michael Graff committed
144 145 146 147 148
/*
 * Control behavior of rendering
 */
#define DNS_MESSAGERENDER_ORDERED	0x0001	/* don't change order */

Michael Graff's avatar
Michael Graff committed
149 150
typedef struct dns_msgblock dns_msgblock_t;

Bob Halley's avatar
Bob Halley committed
151
struct dns_message {
Michael Graff's avatar
Michael Graff committed
152
	/* public from here down */
Michael Graff's avatar
Michael Graff committed
153
	unsigned int			magic;
154

155
	dns_messageid_t			id;
Michael Graff's avatar
Michael Graff committed
156 157 158
	unsigned int			flags;
	unsigned int			rcode;
	unsigned int			opcode;
Michael Graff's avatar
Michael Graff committed
159
	dns_rdataclass_t		rdclass;
Michael Graff's avatar
Michael Graff committed
160

161
	/* 4 real, 1 pseudo */
Michael Graff's avatar
Michael Graff committed
162
	unsigned int			counts[DNS_SECTION_MAX];
Michael Graff's avatar
Michael Graff committed
163 164

	/* private from here down */
Michael Graff's avatar
Michael Graff committed
165 166
	dns_namelist_t			sections[DNS_SECTION_MAX];
	dns_name_t		       *cursors[DNS_SECTION_MAX];
Bob Halley's avatar
Bob Halley committed
167
	dns_rdataset_t		       *opt;
168 169
	dns_rdataset_t		       *sig0;
	dns_rdataset_t		       *tsigset;
170

Michael Graff's avatar
Michael Graff committed
171
	int				state;
Michael Graff's avatar
Michael Graff committed
172
	unsigned int			from_to_wire : 2;
173
	unsigned int			need_cctx_cleanup : 1;
Bob Halley's avatar
Bob Halley committed
174 175
	unsigned int			header_ok : 1;
	unsigned int			question_ok : 1;
176
	unsigned int			tcp_continuation : 1;
177 178
	unsigned int			verified_sig : 1;
	unsigned int			verify_attempted : 1;
179

180
	unsigned int			opt_reserved;
181
	unsigned int			reserved; /* reserved space (render) */
182

183
	isc_buffer_t		       *buffer;
Michael Graff's avatar
Michael Graff committed
184
	dns_compress_t			cctx;
185

Michael Graff's avatar
Michael Graff committed
186
	isc_mem_t		       *mctx;
187 188 189
	isc_mempool_t		       *namepool;
	isc_mempool_t		       *rdspool;

190
	isc_bufferlist_t		scratchpad;
191 192
	isc_bufferlist_t		cleanup;

Michael Graff's avatar
Michael Graff committed
193 194
	ISC_LIST(dns_msgblock_t)	rdatas;
	ISC_LIST(dns_msgblock_t)	rdatalists;
195 196 197

	ISC_LIST(dns_rdata_t)		freerdata;
	ISC_LIST(dns_rdatalist_t)	freerdatalist;
198 199 200

	dns_rcode_t			tsigstatus;
	dns_rcode_t			querytsigstatus;
201
	dns_name_t		       *tsigname;
202 203
	dns_rdata_any_tsig_t	       *tsig;
	dns_rdata_any_tsig_t	       *querytsig;
204
	dns_tsigkey_t		       *tsigkey;
205
	void			       *tsigctx;
206 207
	int				sigstart;

208
	dns_name_t		       *sig0name;
209 210 211
	dst_key_t		       *sig0key;
	dns_rcode_t			sig0status;
	isc_region_t		       *query;
Brian Wellington's avatar
Brian Wellington committed
212
	isc_region_t		       *saved;
Bob Halley's avatar
Bob Halley committed
213
};
214

215 216 217 218 219 220
/***
 *** Functions
 ***/

ISC_LANG_BEGINDECLS

221
isc_result_t
222
dns_message_create(isc_mem_t *mctx, unsigned int intent, dns_message_t **msgp);
Bob Halley's avatar
Bob Halley committed
223
		   
224
/*
Michael Graff's avatar
Michael Graff committed
225
 * Create msg structure.
226
 *
Michael Graff's avatar
Michael Graff committed
227
 * This function will allocate some internal blocks of memory that are
Michael Graff's avatar
Michael Graff committed
228
 * expected to be needed for parsing or rendering nearly any type of message.
Michael Graff's avatar
Michael Graff committed
229 230 231
 *
 * Requires:
 *	'mctx' be a valid memory context.
232
 *
Michael Graff's avatar
Michael Graff committed
233
 *	'msgp' be non-null and '*msg' be NULL.
Michael Graff's avatar
Michael Graff committed
234
 *
Andreas Gustafsson's avatar
typo  
Andreas Gustafsson committed
235 236
 *	'intent' must be one of DNS_MESSAGE_INTENTPARSE or
 *	DNS_MESSAGE_INTENTRENDER.
Michael Graff's avatar
Michael Graff committed
237 238
 *
 * Ensures:
Michael Graff's avatar
Michael Graff committed
239
 *	The data in "*msg" is set to indicate an unused and empty msg
Michael Graff's avatar
Michael Graff committed
240 241 242
 *	structure.
 *
 * Returns:
243 244
 *	ISC_R_NOMEMORY		-- out of memory
 *	ISC_R_SUCCESS		-- success
245 246
 */

Michael Graff's avatar
Michael Graff committed
247
void
Bob Halley's avatar
Bob Halley committed
248
dns_message_reset(dns_message_t *msg, unsigned int intent);
Michael Graff's avatar
Michael Graff committed
249 250 251 252 253 254
/*
 * 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
255 256 257
 * 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
258 259
 * The intended next use of the message will be 'intent'.
 *
Michael Graff's avatar
Michael Graff committed
260 261 262
 * Requires:
 *
 *	'msg' be valid.
Bob Halley's avatar
Bob Halley committed
263 264
 *
 *	'intent' is DNS_MESSAGE_INTENTPARSE or DNS_MESSAGE_INTENTRENDER
Michael Graff's avatar
Michael Graff committed
265
 */
Michael Graff's avatar
Michael Graff committed
266

Michael Graff's avatar
Michael Graff committed
267
void
Michael Graff's avatar
Michael Graff committed
268
dns_message_destroy(dns_message_t **msgp);
Michael Graff's avatar
Michael Graff committed
269
/*
Michael Graff's avatar
Michael Graff committed
270 271 272 273
 * Destroy all state in the message.
 *
 * Requires:
 *
Michael Graff's avatar
Michael Graff committed
274
 *	'msgp' be valid.
Michael Graff's avatar
Michael Graff committed
275 276
 *
 * Ensures:
Michael Graff's avatar
Michael Graff committed
277
 *	'*msgp' == NULL
Michael Graff's avatar
Michael Graff committed
278 279
 */

280 281
isc_result_t
dns_message_sectiontotext(dns_message_t *msg, dns_section_t section,
282
			  dns_messagetextflag_t flags,
283
			  isc_buffer_t *target);
284 285 286 287

isc_result_t
dns_message_pseudosectiontotext(dns_message_t *msg,
				dns_pseudosection_t section,
288
				dns_messagetextflag_t flags,
289
				isc_buffer_t *target);
290
/*
291 292
 * Convert section 'section' or 'pseudosection' of message 'msg' to 
 * a cleartext representation
293 294
 *
 * Notes:
295
 *      See dns_message_totext for meanings of flags.
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
 *
 * 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
 *
 *	Note: On error return, *target may be partially filled with data. 
*/

isc_result_t
323
dns_message_totext(dns_message_t *msg, dns_messagetextflag_t flags,
324 325 326 327 328
		   isc_buffer_t *target);
/*
 * Convert all sections of message 'msg' to a cleartext representation
 *
 * Notes:
329 330 331 332 333 334
 *      In flags, If DNS_MESSAGETEXTFLAG_OMITDOT is set, then the *
 *      final '.' in absolute names will not be emitted.  If
 *      DNS_MESSAGETEXTFLAG_NOCOMMENTS is cleared, * lines * beginning
 *      with ";;" will be emitted indicating section name.  If
 *      DNS_MESSAGETEXTFLAG_NOHEADERS is cleared, header lines will
 *      be emmitted.
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
 *
 * 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
 *
356
 *	Note: On error return, *target may be partially filled with data.  */
357

358
isc_result_t
359 360
dns_message_parse(dns_message_t *msg, isc_buffer_t *source,
		  isc_boolean_t preserve_order);
Michael Graff's avatar
Michael Graff committed
361
/*
Michael Graff's avatar
Michael Graff committed
362 363 364 365
 * 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
366
 * TSIGs are detected and stored in the pseudo-section "tsig".
Michael Graff's avatar
Michael Graff committed
367
 *
368 369 370 371 372 373 374 375 376 377 378 379
 * If 'preserve_order' is true, 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.
 * 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
 * of rdatasets.  To access the names and their data, use 
 * dns_message_firstname() and dns_message_nextname(). 
 *
 * OPT and TSIG records are always handled specially, regardless of the
 * 'preserve_order' setting.
 *
Michael Graff's avatar
Michael Graff committed
380 381
 * If this is a multi-packet message (edns) and more data is required to
 * build the full message state, DNS_R_MOREDATA is returned.  In this case,
382
 * this function should be repeated with all input buffers until ISC_R_SUCCESS
Michael Graff's avatar
Michael Graff committed
383 384 385 386 387
 * (or an error) is returned.
 *
 * Requires:
 *	"msg" be valid.
 *
Michael Graff's avatar
Michael Graff committed
388
 *	"buffer" be a wire format binary buffer.
Michael Graff's avatar
Michael Graff committed
389 390 391 392
 *
 * Ensures:
 *	The buffer's data format is correct.
 *
Michael Graff's avatar
Michael Graff committed
393 394
 *	The buffer's contents verify as correct regarding header bits, buffer
 * 	and rdata sizes, etc.
Michael Graff's avatar
Michael Graff committed
395 396
 *
 * Returns:
397 398
 *	ISC_R_SUCCESS		-- all is well
 *	ISC_R_NOMEMORY		-- no memory
Michael Graff's avatar
Michael Graff committed
399
 *	DNS_R_MOREDATA		-- more packets needed for complete message
Michael Graff's avatar
Michael Graff committed
400 401
 *	DNS_R_???		-- bad signature (XXXMLG need more of these)
 *	Many other errors possible XXXMLG
Michael Graff's avatar
Michael Graff committed
402 403
 */

404
isc_result_t
Michael Graff's avatar
Michael Graff committed
405
dns_message_renderbegin(dns_message_t *msg, isc_buffer_t *buffer);
Michael Graff's avatar
Michael Graff committed
406
/*
Michael Graff's avatar
Michael Graff committed
407 408
 * Begin rendering on a message.  Only one call can be made to this function
 * per message.
Michael Graff's avatar
Michael Graff committed
409
 *
Andreas Gustafsson's avatar
Andreas Gustafsson committed
410
 * The buffer is "owned" by the message library until dns_message_renderend()
Michael Graff's avatar
Michael Graff committed
411 412
 * is called.
 *
Michael Graff's avatar
Michael Graff committed
413
 * Requires:
Michael Graff's avatar
Michael Graff committed
414 415
 *
 *	'msg' be valid.
416
 *
Michael Graff's avatar
Michael Graff committed
417 418 419 420 421
 *	buffer is a valid binary buffer.
 *
 * Side Effects:
 *
 *	The buffer is cleared before it is used.
422
 *
Michael Graff's avatar
Michael Graff committed
423
 * Returns:
424 425
 *	ISC_R_SUCCESS		-- all is well
 *	ISC_R_NOSPACE		-- output buffer is too small
Michael Graff's avatar
Michael Graff committed
426
 *	Anything that dns_compress_init() can return.
Michael Graff's avatar
Michael Graff committed
427 428
 */

429
isc_result_t
430 431 432
dns_message_renderchangebuffer(dns_message_t *msg, isc_buffer_t *buffer);
/*
 * Reset the buffer.  This can be used after growing the old buffer
433
 * on a ISC_R_NOSPACE return from most of the render functions.
434
 *
Michael Graff's avatar
Michael Graff committed
435 436 437 438
 * 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.
 *
439 440 441 442 443 444 445 446 447
 * Requires:
 *
 *	'msg' be valid.
 *
 *	dns_message_renderbegin() was called.
 *
 *	buffer != NULL.
 *
 * Returns:
448 449
 *	ISC_R_NOSPACE		-- new buffer is too small
 *	ISC_R_SUCCESS		-- all is well.
450 451
 */

452
isc_result_t
453
dns_message_renderreserve(dns_message_t *msg, unsigned int space);
Michael Graff's avatar
Michael Graff committed
454
/*
Michael Graff's avatar
Michael Graff committed
455 456 457
 * XXXMLG should use size_t rather than unsigned int once the buffer
 * API is cleaned up
 *
Michael Graff's avatar
Michael Graff committed
458 459 460 461 462
 * Reserve "space" bytes in the given buffer.
 *
 * Requires:
 *
 *	'msg' be valid.
Michael Graff's avatar
Michael Graff committed
463
 *
464 465
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
466
 * Returns:
467 468
 *	ISC_R_SUCCESS		-- all is well.
 *	ISC_R_NOSPACE		-- not enough free space in the buffer.
Michael Graff's avatar
Michael Graff committed
469 470
 */

471
void
Michael Graff's avatar
Michael Graff committed
472 473
dns_message_renderrelease(dns_message_t *msg, unsigned int space);
/*
Michael Graff's avatar
Michael Graff committed
474 475 476
 * XXXMLG should use size_t rather than unsigned int once the buffer
 * API is cleaned up
 *
Michael Graff's avatar
Michael Graff committed
477 478 479 480 481 482
 * Release "space" bytes in the given buffer that was previously reserved.
 *
 * Requires:
 *
 *	'msg' be valid.
 *
483 484
 *	'space' is less than or equal to the total amount of space reserved
 *	via prior calls to dns_message_renderreserve().
485
 *
486
 *	dns_message_renderbegin() was called.
Michael Graff's avatar
Michael Graff committed
487 488
 */

489
isc_result_t
490
dns_message_rendersection(dns_message_t *msg, dns_section_t section,
Michael Graff's avatar
Michael Graff committed
491
			  unsigned int options);
Michael Graff's avatar
Michael Graff committed
492
/*
Michael Graff's avatar
Michael Graff committed
493 494
 * Render all names, rdatalists, etc from the given section at the
 * specified priority or higher.
Michael Graff's avatar
Michael Graff committed
495 496
 *
 * Requires:
Michael Graff's avatar
Michael Graff committed
497 498 499
 *	'msg' be valid.
 *
 *	'section' be a valid section.
Michael Graff's avatar
Michael Graff committed
500
 *
501 502
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
503
 * Returns:
504
 *	ISC_R_SUCCESS		-- all records were written, and there are
Michael Graff's avatar
Michael Graff committed
505
 *				   no more records for this section.
506
 *	ISC_R_NOSPACE		-- Not enough room in the buffer to write
Michael Graff's avatar
Michael Graff committed
507 508 509
 *				   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
510 511
 */

512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
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
 */

527
isc_result_t
528
dns_message_renderend(dns_message_t *msg);
Michael Graff's avatar
Michael Graff committed
529
/*
Michael Graff's avatar
Michael Graff committed
530 531 532 533 534 535 536 537
 * 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.
 *
538 539
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
540
 * Returns:
541
 *	ISC_R_SUCCESS		-- all is well.
Michael Graff's avatar
Michael Graff committed
542 543
 */
		      
Bob Halley's avatar
Bob Halley committed
544 545 546 547 548 549 550 551 552 553 554 555 556 557
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
558

559
isc_result_t
Michael Graff's avatar
Michael Graff committed
560 561 562 563
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
564
 * The functions dns_message_firstname() and dns_message_nextname() may
565
 * be used for iterating over the owner names in a section. 
Michael Graff's avatar
Michael Graff committed
566
 *
Michael Graff's avatar
Michael Graff committed
567 568 569 570 571 572 573
 * Requires:
 *
 *   	'msg' be valid.
 *
 *	'section' be a valid section.
 *
 * Returns:
574 575
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMORE		-- No names on given section.
Michael Graff's avatar
Michael Graff committed
576 577
 */

578
isc_result_t
Michael Graff's avatar
Michael Graff committed
579 580 581 582 583 584 585 586 587 588 589
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
590
 *	dns_message_firstname() must have been called on this section,
591
 *	and the result was ISC_R_SUCCESS.
Michael Graff's avatar
Michael Graff committed
592
 *
Michael Graff's avatar
Michael Graff committed
593
 * Returns:
594 595
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMORE		-- No names in given section.
Michael Graff's avatar
Michael Graff committed
596 597
 */

Michael Graff's avatar
Michael Graff committed
598
void
Michael Graff's avatar
Michael Graff committed
599 600 601 602 603 604
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
605 606 607
 * 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
608 609 610 611 612 613 614 615
 * Requires:
 *
 *	'msg' be valid.
 *
 *	'name' be non-NULL, and *name be NULL.
 *
 *	'section' be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
616 617
 *	dns_message_firstname() must have been called on this section,
 *	and the result of it and any dns_message_nextname() calls was
618
 *	ISC_R_SUCCESS.
Michael Graff's avatar
Michael Graff committed
619 620
 */

621
isc_result_t
Michael Graff's avatar
Michael Graff committed
622 623
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
624 625
		     dns_rdatatype_t covers, dns_name_t **foundname,
		     dns_rdataset_t **rdataset);
Michael Graff's avatar
Michael Graff committed
626
/*
Michael Graff's avatar
Michael Graff committed
627 628
 * 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
629
 * rdataset (if type is specified as other than dns_rdatatype_any).
Michael Graff's avatar
Michael Graff committed
630 631 632 633 634 635
 *
 * Requires:
 *	'msg' be valid.
 *
 *	'section' be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
636 637
 *	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
638 639 640
 *
 *	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
641
 *	rdataset.  If the type is dns_datatype_any, 'rdataset' must be NULL.
Michael Graff's avatar
Michael Graff committed
642 643 644 645 646 647
 *
 *	'target' be a valid name.
 *
 *	'type' be a valid type.
 *
 * Returns:
648
 *	ISC_R_SUCCESS		-- all is well.
Michael Graff's avatar
Michael Graff committed
649
 *	DNS_R_NXDOMAIN		-- name does not exist in that section.
650
 *	DNS_R_NXRRSET		-- The name does exist, but the desired
Michael Graff's avatar
Michael Graff committed
651
 *				   type does not.
Michael Graff's avatar
Michael Graff committed
652 653
 */

654
isc_result_t
655 656 657 658 659 660 661 662 663 664 665 666
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:
667 668
 *	ISC_R_SUCCESS		-- all is well.
 *	ISC_R_NOTFOUND		-- the desired type does not exist.
669 670
 */

Michael Graff's avatar
Michael Graff committed
671 672 673 674
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
675 676
/*
 * Move a name from one section to another.
Michael Graff's avatar
Michael Graff committed
677 678 679 680 681
 *
 * Requires:
 *
 *	'msg' be valid.
 *
Michael Graff's avatar
Michael Graff committed
682
 *	'name' must be a name already in 'fromsection'.
Michael Graff's avatar
Michael Graff committed
683 684 685
 *
 *	'fromsection' must be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
686
 *	'tosection' must be a valid section.
Michael Graff's avatar
Michael Graff committed
687 688
 */

Michael Graff's avatar
Michael Graff committed
689 690 691
void
dns_message_addname(dns_message_t *msg, dns_name_t *name,
		    dns_section_t section);
Michael Graff's avatar
Michael Graff committed
692 693 694
/*
 * Adds the name to the given section.
 *
Michael Graff's avatar
Michael Graff committed
695 696
 * It is the caller's responsibility to enforce any unique name requirements
 * in a section.
Michael Graff's avatar
Michael Graff committed
697 698 699 700 701 702 703 704
 *
 * 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
705
 */
706

707 708 709 710 711 712 713 714
/*
 * 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.
 */

715
isc_result_t
716 717 718
dns_message_gettempname(dns_message_t *msg, dns_name_t **item);
/*
 * Return a name that can be used for any temporary purpose, including
719 720 721
 * 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.
722 723 724 725 726 727 728 729 730
 *
 * It is the caller's responsibility to initialize this name.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item == NULL
 *
 * Returns:
731 732
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
733 734
 */

735
isc_result_t
736 737 738 739 740 741 742 743 744 745 746 747
dns_message_gettemprdata(dns_message_t *msg, dns_rdata_t **item);
/*
 * Return a rdata that can be used for any temporary purpose, including
 * inserting into the message's linked lists.  The storage associated with
 * this rdata will be destroyed when the message is destroyed or reset.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item == NULL
 *
 * Returns:
748 749
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
750 751
 */

752
isc_result_t
753 754 755 756 757 758 759 760 761 762 763 764
dns_message_gettemprdataset(dns_message_t *msg, dns_rdataset_t **item);
/*
 * Return a rdataset that can be used for any temporary purpose, including
 * inserting into the message's linked lists.  The storage associated with
 * this rdataset will be destroyed when the message is destroyed or reset.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item == NULL
 *
 * Returns:
765 766
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
767 768
 */

769
isc_result_t
770 771 772 773 774 775 776 777 778 779 780 781
dns_message_gettemprdatalist(dns_message_t *msg, dns_rdatalist_t **item);
/*
 * Return a rdatalist that can be used for any temporary purpose, including
 * inserting into the message's linked lists.  The storage associated with
 * this rdatalist will be destroyed when the message is destroyed or reset.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item == NULL
 *
 * Returns:
782 783
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 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
 */

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
 */

846
isc_result_t
Michael Graff's avatar
Michael Graff committed
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
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:
 *
865
 *	ISC_R_SUCCESS		-- all is well.
Michael Graff's avatar
Michael Graff committed
866
 *
867
 *	ISC_R_UNEXPECTEDEND	-- buffer doesn't contain enough for a header.
Michael Graff's avatar
Michael Graff committed
868 869
 */

870
isc_result_t
Bob Halley's avatar
Bob Halley committed
871 872 873 874 875 876
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
877
 *	'msg' is a valid message with parsing intent, and contains a query.
Bob Halley's avatar
Bob Halley committed
878 879 880 881
 * 
 * Ensures:
 *
 *	The message will have a rendering intent.  If 'want_question_section'
882 883 884 885 886
 *	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
887 888 889
 *
 * Returns:
 *
890
 *	ISC_R_SUCCESS		-- all is well.
Bob Halley's avatar
Bob Halley committed
891
 *
Bob Halley's avatar
Bob Halley committed
892 893 894 895 896 897 898
 *	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
899 900
 */

Bob Halley's avatar
EDNS0  
Bob Halley committed
901 902 903 904 905 906 907 908 909 910 911 912 913 914
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.
 */

915
isc_result_t
Bob Halley's avatar
EDNS0  
Bob Halley committed
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
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:
 *
935
 *	ISC_R_SUCCESS		-- all is well.
Bob Halley's avatar
EDNS0  
Bob Halley committed
936
 *
937
 *	ISC_R_NOSPACE		-- there is no space for the OPT record.
Bob Halley's avatar
EDNS0  
Bob Halley committed
938 939
 */

940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
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.
 *	'owner' is not NULL, and *owner is NULL.  Contains the owner on return.
 *
 * Returns:
 *
 *	The TSIG rdataset of 'msg', or NULL if there isn't one.
 */

955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
void
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:
 *
 *	'msg' is a valid message
 *	'key' is a valid tsig key or NULL.
 */

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

978
dns_rdataset_t *
979
dns_message_getsig0(dns_message_t *msg, dns_name_t **owner);
980
/*
981
 * Get the SIG(0) record and owner for 'msg'.
982 983 984 985
 *
 * Requires:
 *
 *	'msg' is a valid message.
986
 *	'owner' is not NULL, and *owner is NULL.  Contains the owner on return.
987 988 989 990 991 992
 *
 * Returns:
 *
 *	The SIG(0) rdataset of 'msg', or NULL if there isn't one.
 */

993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
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
1008
isc_result_t
1009
dns_message_signer(dns_message_t *msg, dns_name_t *signer);
Brian Wellington's avatar
Brian Wellington committed
1010
/*
1011
 * If this message was signed, return the identity of the signer.
Brian Wellington's avatar
Brian Wellington committed
1012 1013
 * 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
1014 1015 1016
 *
 * Requires:
 *
1017 1018
 *	msg is a valid parsed message.
 *	signer is a valid name
Brian Wellington's avatar
Brian Wellington committed
1019 1020 1021 1022 1023 1024
 *
 * Returns:
 *
 *	ISC_R_SUCCESS		- the message was signed, and *signer
 *				  contains the signing identity
 *
1025
 *	ISC_R_NOTFOUND		- no TSIG or SIG(0) record is present in the
Brian Wellington's avatar
Brian Wellington committed
1026 1027
 *				  message
 *
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
 *	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
1038
 *
1039 1040
 *	DNS_R_SIGINVALID	- the message was signed by a SIG(0), but
 *				  the signature failed to verify
Brian Wellington's avatar
Brian Wellington committed
1041
 *
1042 1043
 *	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
1044 1045
 */

Brian Wellington's avatar
Brian Wellington committed
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
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.
 *	view is a valid view
 *
 * Returns:
 *
 *	ISC_R_SUCCESS		- the message was unsigned, or the message
 *				  was signed correctly.
 *
 *	DNS_R_EXPECTEDTSIG	- A TSIG was expected, but not seen
 *	DNS_R_UNEXPECTEDTSIG	- A TSIG was seen but not expected
 *	DNS_R_TSIGVERIFYFAILURE - The TSIG failed to verify
 */

1066 1067
ISC_LANG_ENDDECLS

1068
#endif /* DNS_MESSAGE_H */