message.h 25.3 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
#include <isc/lang.h>
Michael Graff's avatar
Michael Graff committed
26
#include <isc/buffer.h>
27
#include <isc/bufferlist.h>
28 29
#include <isc/magic.h>
#include <isc/mem.h>
30 31 32 33

#include <dns/types.h>
#include <dns/name.h>
#include <dns/rdataset.h>
34
#include <dns/rdatastruct.h>
Michael Graff's avatar
Michael Graff committed
35
#include <dns/compress.h>
36

37 38
#include <dst/dst.h>

39 40 41
/*
 * How this beast works:
 *
42
 * When a dns message is received in a buffer, dns_message_fromwire() is called
43 44 45 46 47 48 49 50
 * 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.
 *
51
 * If dns_message_fromwire() returns DNS_R_MOREDATA additional
52 53
 * message packets are required.  This implies an EDNS message.
 *
54
 * When going from structure to wire, dns_message_towire() will return
Michael Graff's avatar
typo  
Michael Graff committed
55
 * DNS_R_MOREDATA if there is more data left in the output buffer that
56 57
 * could not be rendered into the exisiting buffer.
 *
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
 *
 * 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:
 *
80
 *	buffer = isc_buffer_allocate(mctx, 512);
81 82 83 84 85 86 87 88 89 90
 *	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:
 *
91 92 93 94 95
 * 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.
 */

96 97 98 99 100
#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
101 102
#define DNS_MESSAGEFLAG_AD		0x0020U
#define DNS_MESSAGEFLAG_CD		0x0010U
103

Bob Halley's avatar
Bob Halley committed
104
#define DNS_MESSAGE_REPLYPRESERVE	(DNS_MESSAGEFLAG_RD)
105

Bob Halley's avatar
Bob Halley committed
106 107 108
#define DNS_MESSAGE_HEADERLEN		12 /* 6 isc_uint16_t's */

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

Michael Graff's avatar
Michael Graff committed
111 112 113 114
/*
 * 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
115
typedef int dns_section_t;
Michael Graff's avatar
Michael Graff committed
116
#define DNS_SECTION_ANY			(-1)
Michael Graff's avatar
Michael Graff committed
117 118 119 120
#define DNS_SECTION_QUESTION		0
#define DNS_SECTION_ANSWER		1
#define DNS_SECTION_AUTHORITY		2
#define DNS_SECTION_ADDITIONAL		3
121
#define DNS_SECTION_MAX			4
122 123

/*
Andreas Gustafsson's avatar
Andreas Gustafsson committed
124
 * Dynamic update names for these sections.
125 126 127 128
 */
#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
129 130

/*
Michael Graff's avatar
Michael Graff committed
131
 * These tell the message library how the created dns_message_t will be used.
Michael Graff's avatar
Michael Graff committed
132
 */
Michael Graff's avatar
Michael Graff committed
133 134 135
#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
136

Michael Graff's avatar
Michael Graff committed
137 138 139 140 141
/*
 * Control behavior of rendering
 */
#define DNS_MESSAGERENDER_ORDERED	0x0001	/* don't change order */

Michael Graff's avatar
Michael Graff committed
142 143
typedef struct dns_msgblock dns_msgblock_t;

Bob Halley's avatar
Bob Halley committed
144
struct dns_message {
Michael Graff's avatar
Michael Graff committed
145
	/* public from here down */
Michael Graff's avatar
Michael Graff committed
146
	unsigned int			magic;
147

148
	dns_messageid_t			id;
Michael Graff's avatar
Michael Graff committed
149 150 151
	unsigned int			flags;
	unsigned int			rcode;
	unsigned int			opcode;
Michael Graff's avatar
Michael Graff committed
152
	dns_rdataclass_t		rdclass;
Michael Graff's avatar
Michael Graff committed
153

154
	/* 4 real, 1 pseudo */
Michael Graff's avatar
Michael Graff committed
155
	unsigned int			counts[DNS_SECTION_MAX];
Michael Graff's avatar
Michael Graff committed
156 157

	/* private from here down */
Michael Graff's avatar
Michael Graff committed
158 159
	dns_namelist_t			sections[DNS_SECTION_MAX];
	dns_name_t		       *cursors[DNS_SECTION_MAX];
Bob Halley's avatar
Bob Halley committed
160
	dns_rdataset_t		       *opt;
161 162
	dns_rdataset_t		       *sig0;
	dns_rdataset_t		       *tsigset;
163

Michael Graff's avatar
Michael Graff committed
164
	int				state;
Michael Graff's avatar
Michael Graff committed
165
	unsigned int			from_to_wire : 2;
166
	unsigned int			need_cctx_cleanup : 1;
Bob Halley's avatar
Bob Halley committed
167 168
	unsigned int			header_ok : 1;
	unsigned int			question_ok : 1;
169
	unsigned int			tcp_continuation : 1;
170 171
	unsigned int			verified_sig : 1;
	unsigned int			verify_attempted : 1;
172

173
	unsigned int			opt_reserved;
174
	unsigned int			reserved; /* reserved space (render) */
175

176
	isc_buffer_t		       *buffer;
Michael Graff's avatar
Michael Graff committed
177
	dns_compress_t			cctx;
178

Michael Graff's avatar
Michael Graff committed
179
	isc_mem_t		       *mctx;
180 181 182
	isc_mempool_t		       *namepool;
	isc_mempool_t		       *rdspool;

183
	isc_bufferlist_t		scratchpad;
184 185
	isc_bufferlist_t		cleanup;

Michael Graff's avatar
Michael Graff committed
186 187
	ISC_LIST(dns_msgblock_t)	rdatas;
	ISC_LIST(dns_msgblock_t)	rdatalists;
188 189 190

	ISC_LIST(dns_rdata_t)		freerdata;
	ISC_LIST(dns_rdatalist_t)	freerdatalist;
191 192 193

	dns_rcode_t			tsigstatus;
	dns_rcode_t			querytsigstatus;
194
	dns_name_t		       *tsigname;
195 196
	dns_rdata_any_tsig_t	       *tsig;
	dns_rdata_any_tsig_t	       *querytsig;
197
	dns_tsigkey_t		       *tsigkey;
198
	void			       *tsigctx;
199 200 201 202 203
	int				sigstart;

	dst_key_t		       *sig0key;
	dns_rcode_t			sig0status;
	isc_region_t		       *query;
Brian Wellington's avatar
Brian Wellington committed
204
	isc_region_t		       *saved;
Bob Halley's avatar
Bob Halley committed
205
};
206

207 208 209 210 211 212
/***
 *** Functions
 ***/

ISC_LANG_BEGINDECLS

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

Michael Graff's avatar
Michael Graff committed
239
void
Bob Halley's avatar
Bob Halley committed
240
dns_message_reset(dns_message_t *msg, unsigned int intent);
Michael Graff's avatar
Michael Graff committed
241 242 243 244 245 246
/*
 * 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
247 248 249
 * 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
250 251
 * The intended next use of the message will be 'intent'.
 *
Michael Graff's avatar
Michael Graff committed
252 253 254
 * Requires:
 *
 *	'msg' be valid.
Bob Halley's avatar
Bob Halley committed
255 256
 *
 *	'intent' is DNS_MESSAGE_INTENTPARSE or DNS_MESSAGE_INTENTRENDER
Michael Graff's avatar
Michael Graff committed
257
 */
Michael Graff's avatar
Michael Graff committed
258

Michael Graff's avatar
Michael Graff committed
259
void
Michael Graff's avatar
Michael Graff committed
260
dns_message_destroy(dns_message_t **msgp);
Michael Graff's avatar
Michael Graff committed
261
/*
Michael Graff's avatar
Michael Graff committed
262 263 264 265
 * Destroy all state in the message.
 *
 * Requires:
 *
Michael Graff's avatar
Michael Graff committed
266
 *	'msgp' be valid.
Michael Graff's avatar
Michael Graff committed
267 268
 *
 * Ensures:
Michael Graff's avatar
Michael Graff committed
269
 *	'*msgp' == NULL
Michael Graff's avatar
Michael Graff committed
270 271
 */

272
isc_result_t
273 274
dns_message_parse(dns_message_t *msg, isc_buffer_t *source,
		  isc_boolean_t preserve_order);
Michael Graff's avatar
Michael Graff committed
275
/*
Michael Graff's avatar
Michael Graff committed
276 277 278 279
 * 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
280
 * TSIGs are detected and stored in the pseudo-section "tsig".
Michael Graff's avatar
Michael Graff committed
281
 *
282 283 284 285 286 287 288 289 290 291 292 293
 * 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
294 295
 * 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,
296
 * this function should be repeated with all input buffers until ISC_R_SUCCESS
Michael Graff's avatar
Michael Graff committed
297 298 299 300 301
 * (or an error) is returned.
 *
 * Requires:
 *	"msg" be valid.
 *
Michael Graff's avatar
Michael Graff committed
302
 *	"buffer" be a wire format binary buffer.
Michael Graff's avatar
Michael Graff committed
303 304 305 306
 *
 * Ensures:
 *	The buffer's data format is correct.
 *
Michael Graff's avatar
Michael Graff committed
307 308
 *	The buffer's contents verify as correct regarding header bits, buffer
 * 	and rdata sizes, etc.
Michael Graff's avatar
Michael Graff committed
309 310
 *
 * Returns:
311 312
 *	ISC_R_SUCCESS		-- all is well
 *	ISC_R_NOMEMORY		-- no memory
Michael Graff's avatar
Michael Graff committed
313
 *	DNS_R_MOREDATA		-- more packets needed for complete message
Michael Graff's avatar
Michael Graff committed
314 315
 *	DNS_R_???		-- bad signature (XXXMLG need more of these)
 *	Many other errors possible XXXMLG
Michael Graff's avatar
Michael Graff committed
316 317
 */

318
isc_result_t
Michael Graff's avatar
Michael Graff committed
319
dns_message_renderbegin(dns_message_t *msg, isc_buffer_t *buffer);
Michael Graff's avatar
Michael Graff committed
320
/*
Michael Graff's avatar
Michael Graff committed
321 322
 * Begin rendering on a message.  Only one call can be made to this function
 * per message.
Michael Graff's avatar
Michael Graff committed
323
 *
Andreas Gustafsson's avatar
Andreas Gustafsson committed
324
 * The buffer is "owned" by the message library until dns_message_renderend()
Michael Graff's avatar
Michael Graff committed
325 326
 * is called.
 *
Michael Graff's avatar
Michael Graff committed
327
 * Requires:
Michael Graff's avatar
Michael Graff committed
328 329
 *
 *	'msg' be valid.
330
 *
Michael Graff's avatar
Michael Graff committed
331 332 333 334 335
 *	buffer is a valid binary buffer.
 *
 * Side Effects:
 *
 *	The buffer is cleared before it is used.
336
 *
Michael Graff's avatar
Michael Graff committed
337
 * Returns:
338 339
 *	ISC_R_SUCCESS		-- all is well
 *	ISC_R_NOSPACE		-- output buffer is too small
Michael Graff's avatar
Michael Graff committed
340
 *	Anything that dns_compress_init() can return.
Michael Graff's avatar
Michael Graff committed
341 342
 */

343
isc_result_t
344 345 346
dns_message_renderchangebuffer(dns_message_t *msg, isc_buffer_t *buffer);
/*
 * Reset the buffer.  This can be used after growing the old buffer
347
 * on a ISC_R_NOSPACE return from most of the render functions.
348
 *
Michael Graff's avatar
Michael Graff committed
349 350 351 352
 * 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.
 *
353 354 355 356 357 358 359 360 361
 * Requires:
 *
 *	'msg' be valid.
 *
 *	dns_message_renderbegin() was called.
 *
 *	buffer != NULL.
 *
 * Returns:
362 363
 *	ISC_R_NOSPACE		-- new buffer is too small
 *	ISC_R_SUCCESS		-- all is well.
364 365
 */

366
isc_result_t
367
dns_message_renderreserve(dns_message_t *msg, unsigned int space);
Michael Graff's avatar
Michael Graff committed
368
/*
Michael Graff's avatar
Michael Graff committed
369 370 371
 * XXXMLG should use size_t rather than unsigned int once the buffer
 * API is cleaned up
 *
Michael Graff's avatar
Michael Graff committed
372 373 374 375 376
 * Reserve "space" bytes in the given buffer.
 *
 * Requires:
 *
 *	'msg' be valid.
Michael Graff's avatar
Michael Graff committed
377
 *
378 379
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
380
 * Returns:
381 382
 *	ISC_R_SUCCESS		-- all is well.
 *	ISC_R_NOSPACE		-- not enough free space in the buffer.
Michael Graff's avatar
Michael Graff committed
383 384
 */

385
void
Michael Graff's avatar
Michael Graff committed
386 387
dns_message_renderrelease(dns_message_t *msg, unsigned int space);
/*
Michael Graff's avatar
Michael Graff committed
388 389 390
 * XXXMLG should use size_t rather than unsigned int once the buffer
 * API is cleaned up
 *
Michael Graff's avatar
Michael Graff committed
391 392 393 394 395 396
 * Release "space" bytes in the given buffer that was previously reserved.
 *
 * Requires:
 *
 *	'msg' be valid.
 *
397 398
 *	'space' is less than or equal to the total amount of space reserved
 *	via prior calls to dns_message_renderreserve().
399
 *
400
 *	dns_message_renderbegin() was called.
Michael Graff's avatar
Michael Graff committed
401 402
 */

403
isc_result_t
404
dns_message_rendersection(dns_message_t *msg, dns_section_t section,
Michael Graff's avatar
Michael Graff committed
405
			  unsigned int options);
Michael Graff's avatar
Michael Graff committed
406
/*
Michael Graff's avatar
Michael Graff committed
407 408
 * Render all names, rdatalists, etc from the given section at the
 * specified priority or higher.
Michael Graff's avatar
Michael Graff committed
409 410
 *
 * Requires:
Michael Graff's avatar
Michael Graff committed
411 412 413
 *	'msg' be valid.
 *
 *	'section' be a valid section.
Michael Graff's avatar
Michael Graff committed
414
 *
415 416
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
417
 * Returns:
418
 *	ISC_R_SUCCESS		-- all records were written, and there are
Michael Graff's avatar
Michael Graff committed
419
 *				   no more records for this section.
420
 *	ISC_R_NOSPACE		-- Not enough room in the buffer to write
Michael Graff's avatar
Michael Graff committed
421 422 423
 *				   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
424 425
 */

426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
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
 */

441
isc_result_t
442
dns_message_renderend(dns_message_t *msg);
Michael Graff's avatar
Michael Graff committed
443
/*
Michael Graff's avatar
Michael Graff committed
444 445 446 447 448 449 450 451
 * 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.
 *
452 453
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
454
 * Returns:
455
 *	ISC_R_SUCCESS		-- all is well.
Michael Graff's avatar
Michael Graff committed
456 457
 */
		      
Bob Halley's avatar
Bob Halley committed
458 459 460 461 462 463 464 465 466 467 468 469 470 471
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
472

473
isc_result_t
Michael Graff's avatar
Michael Graff committed
474 475 476 477
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
478
 * The functions dns_message_firstname() and dns_message_nextname() may
479
 * be used for iterating over the owner names in a section. 
Michael Graff's avatar
Michael Graff committed
480
 *
Michael Graff's avatar
Michael Graff committed
481 482 483 484 485 486 487
 * Requires:
 *
 *   	'msg' be valid.
 *
 *	'section' be a valid section.
 *
 * Returns:
488 489
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMORE		-- No names on given section.
Michael Graff's avatar
Michael Graff committed
490 491
 */

492
isc_result_t
Michael Graff's avatar
Michael Graff committed
493 494 495 496 497 498 499 500 501 502 503
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
504
 *	dns_message_firstname() must have been called on this section,
505
 *	and the result was ISC_R_SUCCESS.
Michael Graff's avatar
Michael Graff committed
506
 *
Michael Graff's avatar
Michael Graff committed
507
 * Returns:
508 509
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMORE		-- No names in given section.
Michael Graff's avatar
Michael Graff committed
510 511
 */

Michael Graff's avatar
Michael Graff committed
512
void
Michael Graff's avatar
Michael Graff committed
513 514 515 516 517 518
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
519 520 521
 * 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
522 523 524 525 526 527 528 529
 * Requires:
 *
 *	'msg' be valid.
 *
 *	'name' be non-NULL, and *name be NULL.
 *
 *	'section' be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
530 531
 *	dns_message_firstname() must have been called on this section,
 *	and the result of it and any dns_message_nextname() calls was
532
 *	ISC_R_SUCCESS.
Michael Graff's avatar
Michael Graff committed
533 534
 */

535
isc_result_t
Michael Graff's avatar
Michael Graff committed
536 537
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
538 539
		     dns_rdatatype_t covers, dns_name_t **foundname,
		     dns_rdataset_t **rdataset);
Michael Graff's avatar
Michael Graff committed
540
/*
Michael Graff's avatar
Michael Graff committed
541 542
 * 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
543
 * rdataset (if type is specified as other than dns_rdatatype_any).
Michael Graff's avatar
Michael Graff committed
544 545 546 547 548 549
 *
 * Requires:
 *	'msg' be valid.
 *
 *	'section' be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
550 551
 *	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
552 553 554
 *
 *	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
555
 *	rdataset.  If the type is dns_datatype_any, 'rdataset' must be NULL.
Michael Graff's avatar
Michael Graff committed
556 557 558 559 560 561
 *
 *	'target' be a valid name.
 *
 *	'type' be a valid type.
 *
 * Returns:
562
 *	ISC_R_SUCCESS		-- all is well.
Michael Graff's avatar
Michael Graff committed
563
 *	DNS_R_NXDOMAIN		-- name does not exist in that section.
564
 *	DNS_R_NXRRSET		-- The name does exist, but the desired
Michael Graff's avatar
Michael Graff committed
565
 *				   type does not.
Michael Graff's avatar
Michael Graff committed
566 567
 */

568
isc_result_t
569 570 571 572 573 574 575 576 577 578 579 580
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:
581 582
 *	ISC_R_SUCCESS		-- all is well.
 *	ISC_R_NOTFOUND		-- the desired type does not exist.
583 584
 */

Michael Graff's avatar
Michael Graff committed
585 586 587 588
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
589 590
/*
 * Move a name from one section to another.
Michael Graff's avatar
Michael Graff committed
591 592 593 594 595
 *
 * Requires:
 *
 *	'msg' be valid.
 *
Michael Graff's avatar
Michael Graff committed
596
 *	'name' must be a name already in 'fromsection'.
Michael Graff's avatar
Michael Graff committed
597 598 599
 *
 *	'fromsection' must be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
600
 *	'tosection' must be a valid section.
Michael Graff's avatar
Michael Graff committed
601 602
 */

Michael Graff's avatar
Michael Graff committed
603 604 605
void
dns_message_addname(dns_message_t *msg, dns_name_t *name,
		    dns_section_t section);
Michael Graff's avatar
Michael Graff committed
606 607 608
/*
 * Adds the name to the given section.
 *
Michael Graff's avatar
Michael Graff committed
609 610
 * It is the caller's responsibility to enforce any unique name requirements
 * in a section.
Michael Graff's avatar
Michael Graff committed
611 612 613 614 615 616 617 618
 *
 * 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
619
 */
620

621 622 623 624 625 626 627 628
/*
 * 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.
 */

629
isc_result_t
630 631 632
dns_message_gettempname(dns_message_t *msg, dns_name_t **item);
/*
 * Return a name that can be used for any temporary purpose, including
633 634 635
 * 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.
636 637 638 639 640 641 642 643 644
 *
 * It is the caller's responsibility to initialize this name.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item == NULL
 *
 * Returns:
645 646
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
647 648
 */

649
isc_result_t
650 651 652 653 654 655 656 657 658 659 660 661
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:
662 663
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
664 665
 */

666
isc_result_t
667 668 669 670 671 672 673 674 675 676 677 678
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:
679 680
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
681 682
 */

683
isc_result_t
684 685 686 687 688 689 690 691 692 693 694 695
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:
696 697
 *	ISC_R_SUCCESS		-- All is well.
 *	ISC_R_NOMEMORY		-- No item can be allocated.
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
 */

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

760
isc_result_t
Michael Graff's avatar
Michael Graff committed
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
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:
 *
779
 *	ISC_R_SUCCESS		-- all is well.
Michael Graff's avatar
Michael Graff committed
780
 *
781
 *	ISC_R_UNEXPECTEDEND	-- buffer doesn't contain enough for a header.
Michael Graff's avatar
Michael Graff committed
782 783
 */

784
isc_result_t
Bob Halley's avatar
Bob Halley committed
785 786 787 788 789 790
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
791
 *	'msg' is a valid message with parsing intent, and contains a query.
Bob Halley's avatar
Bob Halley committed
792 793 794 795
 * 
 * Ensures:
 *
 *	The message will have a rendering intent.  If 'want_question_section'
796 797 798 799 800
 *	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
801 802 803
 *
 * Returns:
 *
804
 *	ISC_R_SUCCESS		-- all is well.
Bob Halley's avatar
Bob Halley committed
805
 *
Bob Halley's avatar
Bob Halley committed
806 807 808 809 810 811 812
 *	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
813 814
 */

Bob Halley's avatar
EDNS0  
Bob Halley committed
815 816 817 818 819 820 821 822 823 824 825 826 827 828
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.
 */

829
isc_result_t
Bob Halley's avatar
EDNS0  
Bob Halley committed
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
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:
 *
849
 *	ISC_R_SUCCESS		-- all is well.
Bob Halley's avatar
EDNS0  
Bob Halley committed
850
 *
851
 *	ISC_R_NOSPACE		-- there is no space for the OPT record.
Bob Halley's avatar
EDNS0  
Bob Halley committed
852 853
 */

854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
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.
 */

dns_rdataset_t *
dns_message_getsig0(dns_message_t *msg);
/*
 * Get the SIG(0) record for 'msg'.
 *
 * Requires:
 *
 *	'msg' is a valid message.
 *
 * Returns:
 *
 *	The SIG(0) rdataset of 'msg', or NULL if there isn't one.
 */

883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
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
898
isc_result_t
899
dns_message_signer(dns_message_t *msg, dns_name_t *signer);
Brian Wellington's avatar
Brian Wellington committed
900
/*
901
 * If this message was signed, return the identity of the signer.
Brian Wellington's avatar
Brian Wellington committed
902 903
 * 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
904 905 906
 *
 * Requires:
 *
907 908
 *	msg is a valid parsed message.
 *	signer is a valid name
Brian Wellington's avatar
Brian Wellington committed
909 910 911 912 913 914
 *
 * Returns:
 *
 *	ISC_R_SUCCESS		- the message was signed, and *signer
 *				  contains the signing identity
 *
915
 *	ISC_R_NOTFOUND		- no TSIG or SIG(0) record is present in the
Brian Wellington's avatar
Brian Wellington committed
916 917
 *				  message
 *
918 919 920 921 922 923 924 925 926 927
 *	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
928
 *
929 930
 *	DNS_R_SIGINVALID	- the message was signed by a SIG(0), but
 *				  the signature failed to verify
Brian Wellington's avatar
Brian Wellington committed
931
 *
932 933
 *	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
934 935
 */

Brian Wellington's avatar
Brian Wellington committed
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
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
 */

956 957
ISC_LANG_ENDDECLS

958
#endif /* DNS_MESSAGE_H */