message.h 19.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 * Copyright (C) 1999  Internet Software Consortium.
 * 
 * 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 25

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

#include <isc/mem.h>
Michael Graff's avatar
Michael Graff committed
26
#include <isc/buffer.h>
27 28 29 30 31

#include <dns/types.h>
#include <dns/result.h>
#include <dns/name.h>
#include <dns/rdataset.h>
32
#include <dns/rdatastruct.h>
Michael Graff's avatar
Michael Graff committed
33
#include <dns/compress.h>
34 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 44 45 46
 * 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.
 *
47
 * If dns_message_fromwire() returns DNS_R_MOREDATA additional
48 49
 * message packets are required.  This implies an EDNS message.
 *
50
 * When going from structure to wire, dns_message_towire() will return
Michael Graff's avatar
typo  
Michael Graff committed
51
 * DNS_R_MOREDATA if there is more data left in the output buffer that
52 53 54 55 56 57 58 59 60
 * could not be rendered into the exisiting buffer.
 *
 * 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.
 */

ISC_LANG_BEGINDECLS

61 62 63 64 65
#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
66

Bob Halley's avatar
Bob Halley committed
67
#define DNS_MESSAGE_REPLYPRESERVE	(DNS_MESSAGEFLAG_RD)
68

Bob Halley's avatar
Bob Halley committed
69 70 71 72
#define DNS_MESSAGE_HEADERLEN		12 /* 6 isc_uint16_t's */

#define DNS_MESSAGE_MAGIC		0x4d534740U	/* MSG@ */
#define DNS_MESSAGE_VALID(msg)		(((msg)->magic) == DNS_MESSAGE_MAGIC)
Michael Graff's avatar
Michael Graff committed
73

Michael Graff's avatar
Michael Graff committed
74 75 76 77
/*
 * 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
78
typedef int dns_section_t;
Michael Graff's avatar
Michael Graff committed
79
#define DNS_SECTION_ANY			(-1)
Michael Graff's avatar
Michael Graff committed
80 81 82 83
#define DNS_SECTION_QUESTION		0
#define DNS_SECTION_ANSWER		1
#define DNS_SECTION_AUTHORITY		2
#define DNS_SECTION_ADDITIONAL		3
84 85 86 87 88 89 90 91 92
#define DNS_SECTION_TSIG		4 /* pseudo-section */
#define DNS_SECTION_MAX			5

/*
 * Dynamic update named for these sections.
 */
#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
93 94

/*
Michael Graff's avatar
Michael Graff committed
95
 * These tell the message library how the created dns_message_t will be used.
Michael Graff's avatar
Michael Graff committed
96
 */
Michael Graff's avatar
Michael Graff committed
97 98 99
#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
100

Michael Graff's avatar
Michael Graff committed
101 102
typedef struct dns_msgblock dns_msgblock_t;

Bob Halley's avatar
Bob Halley committed
103
struct dns_message {
Michael Graff's avatar
Michael Graff committed
104
	/* public from here down */
Michael Graff's avatar
Michael Graff committed
105
	unsigned int			magic;
106

107
	dns_messageid_t			id;
Michael Graff's avatar
Michael Graff committed
108 109 110
	unsigned int			flags;
	unsigned int			rcode;
	unsigned int			opcode;
Michael Graff's avatar
Michael Graff committed
111
	dns_rdataclass_t		rdclass;
Michael Graff's avatar
Michael Graff committed
112

113
	/* 4 real, 1 pseudo */
Michael Graff's avatar
Michael Graff committed
114
	unsigned int			counts[DNS_SECTION_MAX];
Michael Graff's avatar
Michael Graff committed
115 116

	/* private from here down */
Michael Graff's avatar
Michael Graff committed
117 118
	dns_namelist_t			sections[DNS_SECTION_MAX];
	dns_name_t		       *cursors[DNS_SECTION_MAX];
119
	dns_rdata_t		       *opt;
120

Michael Graff's avatar
Michael Graff committed
121
	int				state;
Michael Graff's avatar
Michael Graff committed
122
	unsigned int			from_to_wire : 2;
123
	unsigned int			need_cctx_cleanup : 1;
Bob Halley's avatar
Bob Halley committed
124 125
	unsigned int			header_ok : 1;
	unsigned int			question_ok : 1;
126 127

	unsigned int			reserved; /* reserved space (render) */
128

129
	isc_buffer_t		       *buffer;
Michael Graff's avatar
Michael Graff committed
130
	dns_compress_t			cctx;
131

Michael Graff's avatar
Michael Graff committed
132
	isc_mem_t		       *mctx;
Michael Graff's avatar
Michael Graff committed
133
	ISC_LIST(isc_dynbuffer_t)	scratchpad;
Michael Graff's avatar
Michael Graff committed
134 135
	ISC_LIST(dns_msgblock_t)	names;
	ISC_LIST(dns_msgblock_t)	rdatas;
Michael Graff's avatar
Michael Graff committed
136
	ISC_LIST(dns_msgblock_t)	rdatasets;
Michael Graff's avatar
Michael Graff committed
137
	ISC_LIST(dns_msgblock_t)	rdatalists;
138 139 140 141 142

	ISC_LIST(dns_name_t)		freename;
	ISC_LIST(dns_rdata_t)		freerdata;
	ISC_LIST(dns_rdataset_t)	freerdataset;
	ISC_LIST(dns_rdatalist_t)	freerdatalist;
143 144 145 146 147 148 149

	dns_rcode_t			tsigstatus;
	dns_rcode_t			querytsigstatus;
	dns_rdata_any_tsig_t	       *tsig;
	dns_rdata_any_tsig_t	       *querytsig;
	dns_tsig_key_t		       *tsigkey;
	int				tsigstart;
Bob Halley's avatar
Bob Halley committed
150
};
151

Michael Graff's avatar
Michael Graff committed
152
dns_result_t
Bob Halley's avatar
Bob Halley committed
153 154 155
dns_message_create(isc_mem_t *mctx, unsigned int intent,
		   dns_message_t **msgp);
		   
156
/*
Michael Graff's avatar
Michael Graff committed
157
 * Create msg structure.
158
 *
Michael Graff's avatar
Michael Graff committed
159
 * This function will allocate some internal blocks of memory that are
Michael Graff's avatar
Michael Graff committed
160
 * expected to be needed for parsing or rendering nearly any type of message.
Michael Graff's avatar
Michael Graff committed
161 162 163
 *
 * Requires:
 *	'mctx' be a valid memory context.
164
 *
Michael Graff's avatar
Michael Graff committed
165
 *	'msgp' be non-null and '*msg' be NULL.
Michael Graff's avatar
Michael Graff committed
166
 *
Andreas Gustafsson's avatar
typo  
Andreas Gustafsson committed
167 168
 *	'intent' must be one of DNS_MESSAGE_INTENTPARSE or
 *	DNS_MESSAGE_INTENTRENDER.
Michael Graff's avatar
Michael Graff committed
169 170
 *
 * Ensures:
Michael Graff's avatar
Michael Graff committed
171
 *	The data in "*msg" is set to indicate an unused and empty msg
Michael Graff's avatar
Michael Graff committed
172 173 174
 *	structure.
 *
 * Returns:
175 176
 *	DNS_R_NOMEMORY		-- out of memory
 *	DNS_R_SUCCESS		-- success
177 178
 */

Michael Graff's avatar
Michael Graff committed
179
void
Bob Halley's avatar
Bob Halley committed
180
dns_message_reset(dns_message_t *msg, unsigned int intent);
Michael Graff's avatar
Michael Graff committed
181 182 183 184 185 186
/*
 * 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
187 188 189
 * 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
190 191
 * The intended next use of the message will be 'intent'.
 *
Michael Graff's avatar
Michael Graff committed
192 193 194
 * Requires:
 *
 *	'msg' be valid.
Bob Halley's avatar
Bob Halley committed
195 196
 *
 *	'intent' is DNS_MESSAGE_INTENTPARSE or DNS_MESSAGE_INTENTRENDER
Michael Graff's avatar
Michael Graff committed
197
 */
Michael Graff's avatar
Michael Graff committed
198

Michael Graff's avatar
Michael Graff committed
199
void
Michael Graff's avatar
Michael Graff committed
200
dns_message_destroy(dns_message_t **msgp);
Michael Graff's avatar
Michael Graff committed
201
/*
Michael Graff's avatar
Michael Graff committed
202 203 204 205
 * Destroy all state in the message.
 *
 * Requires:
 *
Michael Graff's avatar
Michael Graff committed
206
 *	'msgp' be valid.
Michael Graff's avatar
Michael Graff committed
207 208
 *
 * Ensures:
Michael Graff's avatar
Michael Graff committed
209
 *	'*msgp' == NULL
Michael Graff's avatar
Michael Graff committed
210 211
 */

Michael Graff's avatar
Michael Graff committed
212
dns_result_t
213 214
dns_message_parse(dns_message_t *msg, isc_buffer_t *source,
		  isc_boolean_t preserve_order);
Michael Graff's avatar
Michael Graff committed
215
/*
Michael Graff's avatar
Michael Graff committed
216 217 218 219 220 221 222
 * 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".
 * TSIGs are detected and stored in the pseudo-section "tsig".  At detection
 * time, the TSIG is verified (XXX) and the message fails if the TSIG fails
 * to verify.
Michael Graff's avatar
Michael Graff committed
223
 *
224 225 226 227 228 229 230 231 232 233 234 235
 * 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
236 237 238 239 240 241 242 243
 * 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,
 * this function should be repeated with all input buffers until DNS_R_SUCCESS
 * (or an error) is returned.
 *
 * Requires:
 *	"msg" be valid.
 *
Michael Graff's avatar
Michael Graff committed
244
 *	"buffer" be a wire format binary buffer.
Michael Graff's avatar
Michael Graff committed
245 246 247 248
 *
 * Ensures:
 *	The buffer's data format is correct.
 *
Michael Graff's avatar
Michael Graff committed
249 250
 *	The buffer's contents verify as correct regarding header bits, buffer
 * 	and rdata sizes, etc.
Michael Graff's avatar
Michael Graff committed
251 252 253
 *
 * Returns:
 *	DNS_R_SUCCESS		-- all is well
Michael Graff's avatar
Michael Graff committed
254
 *	DNS_R_NOMEMORY		-- no memory
Michael Graff's avatar
Michael Graff committed
255
 *	DNS_R_MOREDATA		-- more packets needed for complete message
Michael Graff's avatar
Michael Graff committed
256 257
 *	DNS_R_???		-- bad signature (XXXMLG need more of these)
 *	Many other errors possible XXXMLG
Michael Graff's avatar
Michael Graff committed
258 259
 */

Michael Graff's avatar
Michael Graff committed
260 261
dns_result_t
dns_message_renderbegin(dns_message_t *msg, isc_buffer_t *buffer);
Michael Graff's avatar
Michael Graff committed
262
/*
Michael Graff's avatar
Michael Graff committed
263 264
 * Begin rendering on a message.  Only one call can be made to this function
 * per message.
Michael Graff's avatar
Michael Graff committed
265
 *
Michael Graff's avatar
Michael Graff committed
266 267 268
 * The buffer is "owned" buy the message library until dns_message_renderend()
 * is called.
 *
Michael Graff's avatar
Michael Graff committed
269
 * Requires:
Michael Graff's avatar
Michael Graff committed
270 271
 *
 *	'msg' be valid.
272
 *
Michael Graff's avatar
Michael Graff committed
273 274 275 276 277
 *	buffer is a valid binary buffer.
 *
 * Side Effects:
 *
 *	The buffer is cleared before it is used.
278
 *
Michael Graff's avatar
Michael Graff committed
279 280 281 282
 * Returns:
 *	DNS_R_SUCCESS		-- all is well
 *	DNS_R_NOSPACE		-- output buffer is too small
 *	Anything that dns_compress_init() can return.
Michael Graff's avatar
Michael Graff committed
283 284 285
 */

dns_result_t
286 287 288 289 290
dns_message_renderchangebuffer(dns_message_t *msg, isc_buffer_t *buffer);
/*
 * Reset the buffer.  This can be used after growing the old buffer
 * on a DNS_R_NOSPACE return from most of the render functions.
 *
Michael Graff's avatar
Michael Graff committed
291 292 293 294
 * 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.
 *
295 296 297 298 299 300 301 302 303
 * Requires:
 *
 *	'msg' be valid.
 *
 *	dns_message_renderbegin() was called.
 *
 *	buffer != NULL.
 *
 * Returns:
304 305
 *	DNS_R_NOSPACE		-- new buffer is too small
 *	DNS_R_SUCCESS		-- all is well.
306 307 308 309
 */

dns_result_t
dns_message_renderreserve(dns_message_t *msg, unsigned int space);
Michael Graff's avatar
Michael Graff committed
310
/*
Michael Graff's avatar
Michael Graff committed
311 312 313
 * XXXMLG should use size_t rather than unsigned int once the buffer
 * API is cleaned up
 *
Michael Graff's avatar
Michael Graff committed
314 315 316 317 318
 * Reserve "space" bytes in the given buffer.
 *
 * Requires:
 *
 *	'msg' be valid.
Michael Graff's avatar
Michael Graff committed
319
 *
320 321
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
322
 * Returns:
Michael Graff's avatar
Michael Graff committed
323 324
 *	DNS_R_SUCCESS		-- all is well.
 *	DNS_R_NOSPACE		-- not enough free space in the buffer.
Michael Graff's avatar
Michael Graff committed
325 326
 */

Michael Graff's avatar
Michael Graff committed
327 328 329
dns_result_t
dns_message_renderrelease(dns_message_t *msg, unsigned int space);
/*
Michael Graff's avatar
Michael Graff committed
330 331 332
 * XXXMLG should use size_t rather than unsigned int once the buffer
 * API is cleaned up
 *
Michael Graff's avatar
Michael Graff committed
333 334 335 336 337 338
 * Release "space" bytes in the given buffer that was previously reserved.
 *
 * Requires:
 *
 *	'msg' be valid.
 *
339 340
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
341 342 343 344 345
 * Returns:
 *	DNS_R_SUCCESS		-- all is well.
 *	DNS_R_NOSPACE		-- trying to release more than was reserved.
 */

Michael Graff's avatar
Michael Graff committed
346
dns_result_t
347
dns_message_rendersection(dns_message_t *msg, dns_section_t section,
Michael Graff's avatar
Michael Graff committed
348
			  unsigned int priority, unsigned int options);
Michael Graff's avatar
Michael Graff committed
349
/*
Michael Graff's avatar
Michael Graff committed
350 351
 * Render all names, rdatalists, etc from the given section at the
 * specified priority or higher.
Michael Graff's avatar
Michael Graff committed
352 353
 *
 * Requires:
Michael Graff's avatar
Michael Graff committed
354 355 356
 *	'msg' be valid.
 *
 *	'section' be a valid section.
Michael Graff's avatar
Michael Graff committed
357
 *
358 359
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
360
 * Returns:
Michael Graff's avatar
Michael Graff committed
361 362 363 364 365 366
 *	DNS_R_SUCCESS		-- all records were written, and there are
 *				   no more records for this section.
 *	DNS_R_NOSPACE		-- Not enough room in the buffer to write
 *				   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
367 368
 */

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
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
 */

Michael Graff's avatar
Michael Graff committed
384
dns_result_t
385
dns_message_renderend(dns_message_t *msg);
Michael Graff's avatar
Michael Graff committed
386
/*
Michael Graff's avatar
Michael Graff committed
387 388 389 390 391 392 393 394
 * 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.
 *
395 396
 *	dns_message_renderbegin() was called.
 *
Michael Graff's avatar
Michael Graff committed
397 398 399 400 401 402 403 404 405 406
 * Returns:
 *	DNS_R_SUCCESS		-- all is well.
 */
		      

dns_result_t
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
407
 * The functions dns_message_firstname() and dns_message_nextname() may
408
 * be used for iterating over the owner names in a section. 
Michael Graff's avatar
Michael Graff committed
409
 *
Michael Graff's avatar
Michael Graff committed
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
 * Requires:
 *
 *   	'msg' be valid.
 *
 *	'section' be a valid section.
 *
 * Returns:
 *	DNS_R_SUCCESS		-- All is well.
 *	DNS_R_NOMORE		-- No names on given section.
 */

dns_result_t
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
433 434 435
 *	dns_message_firstname() must have been called on this section,
 *	and the result was DNS_R_SUCCESS.
 *
Michael Graff's avatar
Michael Graff committed
436 437 438 439 440
 * Returns:
 *	DNS_R_SUCCESS		-- All is well.
 *	DNS_R_NOMORE		-- No names in given section.
 */

Michael Graff's avatar
Michael Graff committed
441
void
Michael Graff's avatar
Michael Graff committed
442 443 444 445 446 447
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
448 449 450
 * 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
451 452 453 454 455 456 457 458
 * Requires:
 *
 *	'msg' be valid.
 *
 *	'name' be non-NULL, and *name be NULL.
 *
 *	'section' be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
459 460 461
 *	dns_message_firstname() must have been called on this section,
 *	and the result of it and any dns_message_nextname() calls was
 *	DNS_R_SUCCESS.
Michael Graff's avatar
Michael Graff committed
462 463
 */

Michael Graff's avatar
Michael Graff committed
464 465 466
dns_result_t
dns_message_findname(dns_message_t *msg, dns_section_t section,
		     dns_name_t *target, dns_rdatatype_t type,
Michael Graff's avatar
Michael Graff committed
467
		     dns_name_t **foundname, dns_rdataset_t **rdataset);
Michael Graff's avatar
Michael Graff committed
468
/*
Michael Graff's avatar
Michael Graff committed
469 470 471 472 473 474 475 476 477
 * 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
 * rdataset (if type is specified as other than dns_rdatatype_any.)
 *
 * Requires:
 *	'msg' be valid.
 *
 *	'section' be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
478 479
 *	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
480 481 482
 *
 *	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
483
 *	rdataset.  If the type is dns_datatype_any, 'rdataset' must be NULL.
Michael Graff's avatar
Michael Graff committed
484 485 486 487 488 489 490 491 492 493
 *
 *	'target' be a valid name.
 *
 *	'type' be a valid type.
 *
 * Returns:
 *	DNS_R_SUCCESS		-- all is well.
 *	DNS_R_NXDOMAIN		-- name does not exist in that section.
 *	DNS_R_NXRDATASET	-- The name does exist, but the desired
 *				   type does not.
Michael Graff's avatar
Michael Graff committed
494 495
 */

Michael Graff's avatar
Michael Graff committed
496 497 498 499
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
500 501
/*
 * Move a name from one section to another.
Michael Graff's avatar
Michael Graff committed
502 503 504 505 506
 *
 * Requires:
 *
 *	'msg' be valid.
 *
Michael Graff's avatar
Michael Graff committed
507
 *	'name' must be a name already in 'fromsection'.
Michael Graff's avatar
Michael Graff committed
508 509 510
 *
 *	'fromsection' must be a valid section.
 *
Michael Graff's avatar
Michael Graff committed
511
 *	'tosection' must be a valid section.
Michael Graff's avatar
Michael Graff committed
512 513
 */

Michael Graff's avatar
Michael Graff committed
514 515 516
void
dns_message_addname(dns_message_t *msg, dns_name_t *name,
		    dns_section_t section);
Michael Graff's avatar
Michael Graff committed
517 518 519
/*
 * Adds the name to the given section.
 *
Michael Graff's avatar
Michael Graff committed
520 521
 * It is the caller's responsibility to enforce any unique name requirements
 * in a section.
Michael Graff's avatar
Michael Graff committed
522 523 524 525 526 527 528 529
 *
 * 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
530
 */
531

532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
/*
 * 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.
 */

dns_result_t
dns_message_gettempname(dns_message_t *msg, dns_name_t **item);
/*
 * Return a name that can be used for any temporary purpose, including
 * inserting into the message's linked lists.  The storage associated with
 * this name will be destroyed when the message is destroyed or reset.
 *
 * It is the caller's responsibility to initialize this name.
 *
 * Requires:
 *	msg be a valid message
 *
 *	item != NULL && *item == NULL
 *
 * Returns:
 *	DNS_R_SUCCESS		-- All is well.
 *	DNS_R_NOMEMORY		-- No item can be allocated.
 */

dns_result_t
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:
 *	DNS_R_SUCCESS		-- All is well.
 *	DNS_R_NOMEMORY		-- No item can be allocated.
 */

dns_result_t
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:
 *	DNS_R_SUCCESS		-- All is well.
 *	DNS_R_NOMEMORY		-- No item can be allocated.
 */

dns_result_t
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:
 *	DNS_R_SUCCESS		-- All is well.
 *	DNS_R_NOMEMORY		-- No item can be allocated.
 */

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

Michael Graff's avatar
Michael Graff committed
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
dns_result_t
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:
 *
 *	DNS_R_SUCCESS		-- all is well.
 *
 *	DNS_R_UNEXPECTEDEND	-- buffer doesn't contain enough for a header.
 */

Bob Halley's avatar
Bob Halley committed
694 695 696 697 698 699 700 701 702 703 704 705
dns_result_t
dns_message_reply(dns_message_t *msg, isc_boolean_t want_question_section);
/*
 * Start formatting a reply to the query in 'msg'.
 *
 * Requires:
 *
 *	'msg' is a valid message with parsing intent, and contains a query
 * 
 * Ensures:
 *
 *	The message will have a rendering intent.  If 'want_question_section'
Bob Halley's avatar
Bob Halley committed
706 707 708 709 710
 *	is true, the message opcode is query, 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
711 712 713 714 715
 *
 * Returns:
 *
 *	DNS_R_SUCCESS		-- all is well.
 *
Bob Halley's avatar
Bob Halley committed
716 717 718 719 720 721 722
 *	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
723 724
 */

725 726 727
ISC_LANG_ENDDECLS

#endif	/* DNS_DNS_H */