contrib/bind9/lib/dns/include/dns/rdata.h

   1 /*
   2  * Copyright (C) 2004-2009  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1998-2003  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id: rdata.h,v 1.77 2009-12-04 21:09:33 marka Exp $ */
  19
  20 #ifndef DNS_RDATA_H
  21 #define DNS_RDATA_H 1
  22
  23 /*****
  24  ***** Module Info
  25  *****/
  26
  27 /*! \file dns/rdata.h
  28  * \brief
  29  * Provides facilities for manipulating DNS rdata, including conversions to
  30  * and from wire format and text format.
  31  *
  32  * Given the large amount of rdata possible in a nameserver, it was important
  33  * to come up with a very efficient way of storing rdata, but at the same
  34  * time allow it to be manipulated.
  35  *
  36  * The decision was to store rdata in uncompressed wire format,
  37  * and not to make it a fully abstracted object; i.e. certain parts of the
  38  * server know rdata is stored that way.  This saves a lot of memory, and
  39  * makes adding rdata to messages easy.  Having much of the server know
  40  * the representation would be perilous, and we certainly don't want each
  41  * user of rdata to be manipulating such a low-level structure.  This is
  42  * where the rdata module comes in.  The module allows rdata handles to be
  43  * created and attached to uncompressed wire format regions.  All rdata
  44  * operations and conversions are done through these handles.
  45  *
  46  * Implementation Notes:
  47  *
  48  *\li   The routines in this module are expected to be synthesized by the
  49  *      build process from a set of source files, one per rdata type.  For
  50  *      portability, it's probably best that the building be done by a C
  51  *      program.  Adding a new rdata type will be a simple matter of adding
  52  *      a file to a directory and rebuilding the server.  *All* knowledge of
  53  *      the format of a particular rdata type is in this file.
  54  *
  55  * MP:
  56  *\li   Clients of this module must impose any required synchronization.
  57  *
  58  * Reliability:
  59  *\li   This module deals with low-level byte streams.  Errors in any of
  60  *      the functions are likely to crash the server or corrupt memory.
  61  *
  62  *\li   Rdata is typed, and the caller must know what type of rdata it has.
  63  *      A caller that gets this wrong could crash the server.
  64  *
  65  *\li   The fromstruct() and tostruct() routines use a void * pointer to
  66  *      represent the structure.  The caller must ensure that it passes a
  67  *      pointer to the appropriate type, or the server could crash or memory
  68  *      could be corrupted.
  69  *
  70  * Resources:
  71  *\li   None.
  72  *
  73  * Security:
  74  *
  75  *\li   *** WARNING ***
  76  *      dns_rdata_fromwire() deals with raw network data.  An error in
  77  *      this routine could result in the failure or hijacking of the server.
  78  *
  79  * Standards:
  80  *\li   RFC1035
  81  *\li   Draft EDNS0 (0)
  82  *\li   Draft EDNS1 (0)
  83  *\li   Draft Binary Labels (2)
  84  *\li   Draft Local Compression (1)
  85  *\li   Various RFCs for particular types; these will be documented in the
  86  *       sources files of the types.
  87  *
  88  */
  89
  90 /***
  91  *** Imports
  92  ***/
  93
  94 #include <isc/lang.h>
  95
  96 #include <dns/types.h>
  97 #include <dns/name.h>
  98 #include <dns/message.h>
  99
 100 ISC_LANG_BEGINDECLS
 101
 102
 103 /***
 104  *** Types
 105  ***/
 106
 107 /*%
 108  ***** An 'rdata' is a handle to a binary region.  The handle has an RR
 109  ***** class and type, and the data in the binary region is in the format
 110  ***** of the given class and type.
 111  *****/
 112 /*%
 113  * Clients are strongly discouraged from using this type directly, with
 114  * the exception of the 'link' field which may be used directly for whatever
 115  * purpose the client desires.
 116  */
 117 struct dns_rdata {
 118         unsigned char *                 data;
 119         unsigned int                    length;
 120         dns_rdataclass_t                rdclass;
 121         dns_rdatatype_t                 type;
 122         unsigned int                    flags;
 123         ISC_LINK(dns_rdata_t)           link;
 124 };
 125
 126 #define DNS_RDATA_INIT { NULL, 0, 0, 0, 0, {(void*)(-1), (void *)(-1)}}
 127
 128 #define DNS_RDATA_CHECKINITIALIZED
 129 #ifdef DNS_RDATA_CHECKINITIALIZED
 130 #define DNS_RDATA_INITIALIZED(rdata) \
 131         ((rdata)->data == NULL && (rdata)->length == 0 && \
 132          (rdata)->rdclass == 0 && (rdata)->type == 0 && (rdata)->flags == 0 && \
 133          !ISC_LINK_LINKED((rdata), link))
 134 #else
 135 #ifdef ISC_LIST_CHECKINIT
 136 #define DNS_RDATA_INITIALIZED(rdata) \
 137         (!ISC_LINK_LINKED((rdata), link))
 138 #else
 139 #define DNS_RDATA_INITIALIZED(rdata) ISC_TRUE
 140 #endif
 141 #endif
 142
 143 #define DNS_RDATA_UPDATE        0x0001          /*%< update pseudo record. */
 144 #define DNS_RDATA_OFFLINE       0x0002          /*%< RRSIG has a offline key. */
 145
 146 #define DNS_RDATA_VALIDFLAGS(rdata) \
 147         (((rdata)->flags & ~(DNS_RDATA_UPDATE|DNS_RDATA_OFFLINE)) == 0)
 148
 149 /*
 150  * The maximum length of a RDATA that can be sent on the wire.
 151  * Max packet size (65535) less header (12), less name (1), type (2),
 152  * class (2), ttl(4), length (2).
 153  *
 154  * None of the defined types that support name compression can exceed
 155  * this and all new types are to be sent uncompressed.
 156  */
 157
 158 #define DNS_RDATA_MAXLENGTH     65512U
 159
 160 /*
 161  * Flags affecting rdata formatting style.  Flags 0xFFFF0000
 162  * are used by masterfile-level formatting and defined elsewhere.
 163  * See additional comments at dns_rdata_tofmttext().
 164  */
 165
 166 /*% Split the rdata into multiple lines to try to keep it
 167  within the "width". */
 168 #define DNS_STYLEFLAG_MULTILINE         0x00000001U
 169
 170 /*% Output explanatory comments. */
 171 #define DNS_STYLEFLAG_COMMENT           0x00000002U
 172
 173 #define DNS_RDATA_DOWNCASE              DNS_NAME_DOWNCASE
 174 #define DNS_RDATA_CHECKNAMES            DNS_NAME_CHECKNAMES
 175 #define DNS_RDATA_CHECKNAMESFAIL        DNS_NAME_CHECKNAMESFAIL
 176 #define DNS_RDATA_CHECKREVERSE          DNS_NAME_CHECKREVERSE
 177 #define DNS_RDATA_CHECKMX               DNS_NAME_CHECKMX
 178 #define DNS_RDATA_CHECKMXFAIL           DNS_NAME_CHECKMXFAIL
 179
 180 /***
 181  *** Initialization
 182  ***/
 183
 184 void
 185 dns_rdata_init(dns_rdata_t *rdata);
 186 /*%<
 187  * Make 'rdata' empty.
 188  *
 189  * Requires:
 190  *      'rdata' is a valid rdata (i.e. not NULL, points to a struct dns_rdata)
 191  */
 192
 193 void
 194 dns_rdata_reset(dns_rdata_t *rdata);
 195 /*%<
 196  * Make 'rdata' empty.
 197  *
 198  * Requires:
 199  *\li   'rdata' is a previously initialized rdata and is not linked.
 200  */
 201
 202 void
 203 dns_rdata_clone(const dns_rdata_t *src, dns_rdata_t *target);
 204 /*%<
 205  * Clone 'target' from 'src'.
 206  *
 207  * Requires:
 208  *\li   'src' to be initialized.
 209  *\li   'target' to be initialized.
 210  */
 211
 212 /***
 213  *** Comparisons
 214  ***/
 215
 216 int
 217 dns_rdata_compare(const dns_rdata_t *rdata1, const dns_rdata_t *rdata2);
 218 /*%<
 219  * Determine the relative ordering under the DNSSEC order relation of
 220  * 'rdata1' and 'rdata2'.
 221  *
 222  * Requires:
 223  *
 224  *\li   'rdata1' is a valid, non-empty rdata
 225  *
 226  *\li   'rdata2' is a valid, non-empty rdata
 227  *
 228  * Returns:
 229  *\li   < 0             'rdata1' is less than 'rdata2'
 230  *\li   0               'rdata1' is equal to 'rdata2'
 231  *\li   > 0             'rdata1' is greater than 'rdata2'
 232  */
 233
 234 int
 235 dns_rdata_casecompare(const dns_rdata_t *rdata1, const dns_rdata_t *rdata2);
 236 /*%<
 237  * dns_rdata_casecompare() is similar to dns_rdata_compare() but also
 238  * compares domain names case insensitively in known rdata types that
 239  * are treated as opaque data by dns_rdata_compare().
 240  *
 241  * Requires:
 242  *
 243  *\li   'rdata1' is a valid, non-empty rdata
 244  *
 245  *\li   'rdata2' is a valid, non-empty rdata
 246  *
 247  * Returns:
 248  *\li   < 0             'rdata1' is less than 'rdata2'
 249  *\li   0               'rdata1' is equal to 'rdata2'
 250  *\li   > 0             'rdata1' is greater than 'rdata2'
 251  */
 252
 253 /***
 254  *** Conversions
 255  ***/
 256
 257 void
 258 dns_rdata_fromregion(dns_rdata_t *rdata, dns_rdataclass_t rdclass,
 259                      dns_rdatatype_t type, isc_region_t *r);
 260 /*%<
 261  * Make 'rdata' refer to region 'r'.
 262  *
 263  * Requires:
 264  *
 265  *\li   The data in 'r' is properly formatted for whatever type it is.
 266  */
 267
 268 void
 269 dns_rdata_toregion(const dns_rdata_t *rdata, isc_region_t *r);
 270 /*%<
 271  * Make 'r' refer to 'rdata'.
 272  */
 273
 274 isc_result_t
 275 dns_rdata_fromwire(dns_rdata_t *rdata, dns_rdataclass_t rdclass,
 276                    dns_rdatatype_t type, isc_buffer_t *source,
 277                    dns_decompress_t *dctx, unsigned int options,
 278                    isc_buffer_t *target);
 279 /*%<
 280  * Copy the possibly-compressed rdata at source into the target region.
 281  *
 282  * Notes:
 283  *\li   Name decompression policy is controlled by 'dctx'.
 284  *
 285  *      'options'
 286  *\li   DNS_RDATA_DOWNCASE      downcase domain names when they are copied
 287  *                              into target.
 288  *
 289  * Requires:
 290  *
 291  *\li   'rdclass' and 'type' are valid.
 292  *
 293  *\li   'source' is a valid buffer, and the active region of 'source'
 294  *      references the rdata to be processed.
 295  *
 296  *\li   'target' is a valid buffer.
 297  *
 298  *\li   'dctx' is a valid decompression context.
 299  *
 300  * Ensures,
 301  *      if result is success:
 302  *      \li     If 'rdata' is not NULL, it is attached to the target.
 303  *      \li     The conditions dns_name_fromwire() ensures for names hold
 304  *              for all names in the rdata.
 305  *      \li     The current location in source is advanced, and the used space
 306  *              in target is updated.
 307  *
 308  * Result:
 309  *\li   Success
 310  *\li   Any non-success status from dns_name_fromwire()
 311  *\li   Various 'Bad Form' class failures depending on class and type
 312  *\li   Bad Form: Input too short
 313  *\li   Resource Limit: Not enough space
 314  */
 315
 316 isc_result_t
 317 dns_rdata_towire(dns_rdata_t *rdata, dns_compress_t *cctx,
 318                  isc_buffer_t *target);
 319 /*%<
 320  * Convert 'rdata' into wire format, compressing it as specified by the
 321  * compression context 'cctx', and storing the result in 'target'.
 322  *
 323  * Notes:
 324  *\li   If the compression context allows global compression, then the
 325  *      global compression table may be updated.
 326  *
 327  * Requires:
 328  *\li   'rdata' is a valid, non-empty rdata
 329  *
 330  *\li   target is a valid buffer
 331  *
 332  *\li   Any offsets specified in a global compression table are valid
 333  *      for target.
 334  *
 335  * Ensures,
 336  *      if the result is success:
 337  *      \li     The used space in target is updated.
 338  *
 339  * Returns:
 340  *\li   Success
 341  *\li   Any non-success status from dns_name_towire()
 342  *\li   Resource Limit: Not enough space
 343  */
 344
 345 isc_result_t
 346 dns_rdata_fromtext(dns_rdata_t *rdata, dns_rdataclass_t rdclass,
 347                    dns_rdatatype_t type, isc_lex_t *lexer, dns_name_t *origin,
 348                    unsigned int options, isc_mem_t *mctx,
 349                    isc_buffer_t *target, dns_rdatacallbacks_t *callbacks);
 350 /*%<
 351  * Convert the textual representation of a DNS rdata into uncompressed wire
 352  * form stored in the target region.  Tokens constituting the text of the rdata
 353  * are taken from 'lexer'.
 354  *
 355  * Notes:
 356  *\li   Relative domain names in the rdata will have 'origin' appended to them.
 357  *      A NULL origin implies "origin == dns_rootname".
 358  *
 359  *
 360  *      'options'
 361  *\li   DNS_RDATA_DOWNCASE      downcase domain names when they are copied
 362  *                              into target.
 363  *\li   DNS_RDATA_CHECKNAMES    perform checknames checks.
 364  *\li   DNS_RDATA_CHECKNAMESFAIL fail if the checknames check fail.  If
 365  *                              not set a warning will be issued.
 366  *\li   DNS_RDATA_CHECKREVERSE  this should set if the owner name ends
 367  *                              in IP6.ARPA, IP6.INT or IN-ADDR.ARPA.
 368  *
 369  * Requires:
 370  *
 371  *\li   'rdclass' and 'type' are valid.
 372  *
 373  *\li   'lexer' is a valid isc_lex_t.
 374  *
 375  *\li   'mctx' is a valid isc_mem_t.
 376  *
 377  *\li   'target' is a valid region.
 378  *
 379  *\li   'origin' if non NULL it must be absolute.
 380  *
 381  *\li   'callbacks' to be NULL or callbacks->warn and callbacks->error be
 382  *      initialized.
 383  *
 384  * Ensures,
 385  *      if result is success:
 386  *\li           If 'rdata' is not NULL, it is attached to the target.
 387
 388  *\li           The conditions dns_name_fromtext() ensures for names hold
 389  *              for all names in the rdata.
 390
 391  *\li           The used space in target is updated.
 392  *
 393  * Result:
 394  *\li   Success
 395  *\li   Translated result codes from isc_lex_gettoken
 396  *\li   Various 'Bad Form' class failures depending on class and type
 397  *\li   Bad Form: Input too short
 398  *\li   Resource Limit: Not enough space
 399  *\li   Resource Limit: Not enough memory
 400  */
 401
 402 isc_result_t
 403 dns_rdata_totext(dns_rdata_t *rdata, dns_name_t *origin, isc_buffer_t *target);
 404 /*%<
 405  * Convert 'rdata' into text format, storing the result in 'target'.
 406  * The text will consist of a single line, with fields separated by
 407  * single spaces.
 408  *
 409  * Notes:
 410  *\li   If 'origin' is not NULL, then any names in the rdata that are
 411  *      subdomains of 'origin' will be made relative it.
 412  *
 413  *\li   XXX Do we *really* want to support 'origin'?  I'm inclined towards "no"
 414  *      at the moment.
 415  *
 416  * Requires:
 417  *
 418  *\li   'rdata' is a valid, non-empty rdata
 419  *
 420  *\li   'origin' is NULL, or is a valid name
 421  *
 422  *\li   'target' is a valid text buffer
 423  *
 424  * Ensures,
 425  *      if the result is success:
 426  *
 427  *      \li     The used space in target is updated.
 428  *
 429  * Returns:
 430  *\li   Success
 431  *\li   Any non-success status from dns_name_totext()
 432  *\li   Resource Limit: Not enough space
 433  */
 434
 435 isc_result_t
 436 dns_rdata_tofmttext(dns_rdata_t *rdata, dns_name_t *origin, unsigned int flags,
 437                     unsigned int width, const char *linebreak,
 438                     isc_buffer_t *target);
 439 /*%<
 440  * Like dns_rdata_totext, but do formatted output suitable for
 441  * database dumps.  This is intended for use by dns_db_dump();
 442  * library users are discouraged from calling it directly.
 443  *
 444  * If (flags & #DNS_STYLEFLAG_MULTILINE) != 0, attempt to stay
 445  * within 'width' by breaking the text into multiple lines.
 446  * The string 'linebreak' is inserted between lines, and parentheses
 447  * are added when necessary.  Because RRs contain unbreakable elements
 448  * such as domain names whose length is variable, unpredictable, and
 449  * potentially large, there is no guarantee that the lines will
 450  * not exceed 'width' anyway.
 451  *
 452  * If (flags & #DNS_STYLEFLAG_MULTILINE) == 0, the rdata is always
 453  * printed as a single line, and no parentheses are used.
 454  * The 'width' and 'linebreak' arguments are ignored.
 455  *
 456  * If (flags & #DNS_STYLEFLAG_COMMENT) != 0, output explanatory
 457  * comments next to things like the SOA timer fields.  Some
 458  * comments (e.g., the SOA ones) are only printed when multiline
 459  * output is selected.
 460  */
 461
 462 isc_result_t
 463 dns_rdata_fromstruct(dns_rdata_t *rdata, dns_rdataclass_t rdclass,
 464                      dns_rdatatype_t type, void *source, isc_buffer_t *target);
 465 /*%<
 466  * Convert the C structure representation of an rdata into uncompressed wire
 467  * format in 'target'.
 468  *
 469  * XXX  Should we have a 'size' parameter as a sanity check on target?
 470  *
 471  * Requires:
 472  *
 473  *\li   'rdclass' and 'type' are valid.
 474  *
 475  *\li   'source' points to a valid C struct for the class and type.
 476  *
 477  *\li   'target' is a valid buffer.
 478  *
 479  *\li   All structure pointers to memory blocks should be NULL if their
 480  *      corresponding length values are zero.
 481  *
 482  * Ensures,
 483  *      if result is success:
 484  *      \li     If 'rdata' is not NULL, it is attached to the target.
 485  *
 486  *      \li     The used space in 'target' is updated.
 487  *
 488  * Result:
 489  *\li   Success
 490  *\li   Various 'Bad Form' class failures depending on class and type
 491  *\li   Resource Limit: Not enough space
 492  */
 493
 494 isc_result_t
 495 dns_rdata_tostruct(dns_rdata_t *rdata, void *target, isc_mem_t *mctx);
 496 /*%<
 497  * Convert an rdata into its C structure representation.
 498  *
 499  * If 'mctx' is NULL then 'rdata' must persist while 'target' is being used.
 500  *
 501  * If 'mctx' is non NULL then memory will be allocated if required.
 502  *
 503  * Requires:
 504  *
 505  *\li   'rdata' is a valid, non-empty rdata.
 506  *
 507  *\li   'target' to point to a valid pointer for the type and class.
 508  *
 509  * Result:
 510  *\li   Success
 511  *\li   Resource Limit: Not enough memory
 512  */
 513
 514 void
 515 dns_rdata_freestruct(void *source);
 516 /*%<
 517  * Free dynamic memory attached to 'source' (if any).
 518  *
 519  * Requires:
 520  *
 521  *\li   'source' to point to the structure previously filled in by
 522  *      dns_rdata_tostruct().
 523  */
 524
 525 isc_boolean_t
 526 dns_rdatatype_ismeta(dns_rdatatype_t type);
 527 /*%<
 528  * Return true iff the rdata type 'type' is a meta-type
 529  * like ANY or AXFR.
 530  */
 531
 532 isc_boolean_t
 533 dns_rdatatype_issingleton(dns_rdatatype_t type);
 534 /*%<
 535  * Return true iff the rdata type 'type' is a singleton type,
 536  * like CNAME or SOA.
 537  *
 538  * Requires:
 539  * \li  'type' is a valid rdata type.
 540  *
 541  */
 542
 543 isc_boolean_t
 544 dns_rdataclass_ismeta(dns_rdataclass_t rdclass);
 545 /*%<
 546  * Return true iff the rdata class 'rdclass' is a meta-class
 547  * like ANY or NONE.
 548  */
 549
 550 isc_boolean_t
 551 dns_rdatatype_isdnssec(dns_rdatatype_t type);
 552 /*%<
 553  * Return true iff 'type' is one of the DNSSEC
 554  * rdata types that may exist alongside a CNAME record.
 555  *
 556  * Requires:
 557  * \li  'type' is a valid rdata type.
 558  */
 559
 560 isc_boolean_t
 561 dns_rdatatype_iszonecutauth(dns_rdatatype_t type);
 562 /*%<
 563  * Return true iff rdata of type 'type' is considered authoritative
 564  * data (not glue) in the NSEC chain when it occurs in the parent zone
 565  * at a zone cut.
 566  *
 567  * Requires:
 568  * \li  'type' is a valid rdata type.
 569  *
 570  */
 571
 572 isc_boolean_t
 573 dns_rdatatype_isknown(dns_rdatatype_t type);
 574 /*%<
 575  * Return true iff the rdata type 'type' is known.
 576  *
 577  * Requires:
 578  * \li  'type' is a valid rdata type.
 579  *
 580  */
 581
 582
 583 isc_result_t
 584 dns_rdata_additionaldata(dns_rdata_t *rdata, dns_additionaldatafunc_t add,
 585                          void *arg);
 586 /*%<
 587  * Call 'add' for each name and type from 'rdata' which is subject to
 588  * additional section processing.
 589  *
 590  * Requires:
 591  *
 592  *\li   'rdata' is a valid, non-empty rdata.
 593  *
 594  *\li   'add' is a valid dns_additionalfunc_t.
 595  *
 596  * Ensures:
 597  *
 598  *\li   If successful, then add() will have been called for each name
 599  *      and type subject to additional section processing.
 600  *
 601  *\li   If add() returns something other than #ISC_R_SUCCESS, that result
 602  *      will be returned as the result of dns_rdata_additionaldata().
 603  *
 604  * Returns:
 605  *
 606  *\li   ISC_R_SUCCESS
 607  *
 608  *\li   Many other results are possible if not successful.
 609  */
 610
 611 isc_result_t
 612 dns_rdata_digest(dns_rdata_t *rdata, dns_digestfunc_t digest, void *arg);
 613 /*%<
 614  * Send 'rdata' in DNSSEC canonical form to 'digest'.
 615  *
 616  * Note:
 617  *\li   'digest' may be called more than once by dns_rdata_digest().  The
 618  *      concatenation of all the regions, in the order they were given
 619  *      to 'digest', will be the DNSSEC canonical form of 'rdata'.
 620  *
 621  * Requires:
 622  *
 623  *\li   'rdata' is a valid, non-empty rdata.
 624  *
 625  *\li   'digest' is a valid dns_digestfunc_t.
 626  *
 627  * Ensures:
 628  *
 629  *\li   If successful, then all of the rdata's data has been sent, in
 630  *      DNSSEC canonical form, to 'digest'.
 631  *
 632  *\li   If digest() returns something other than ISC_R_SUCCESS, that result
 633  *      will be returned as the result of dns_rdata_digest().
 634  *
 635  * Returns:
 636  *
 637  *\li   ISC_R_SUCCESS
 638  *
 639  *\li   Many other results are possible if not successful.
 640  */
 641
 642 isc_boolean_t
 643 dns_rdatatype_questiononly(dns_rdatatype_t type);
 644 /*%<
 645  * Return true iff rdata of type 'type' can only appear in the question
 646  * section of a properly formatted message.
 647  *
 648  * Requires:
 649  * \li  'type' is a valid rdata type.
 650  *
 651  */
 652
 653 isc_boolean_t
 654 dns_rdatatype_notquestion(dns_rdatatype_t type);
 655 /*%<
 656  * Return true iff rdata of type 'type' can not appear in the question
 657  * section of a properly formatted message.
 658  *
 659  * Requires:
 660  * \li  'type' is a valid rdata type.
 661  *
 662  */
 663
 664 isc_boolean_t
 665 dns_rdatatype_atparent(dns_rdatatype_t type);
 666 /*%<
 667  * Return true iff rdata of type 'type' should appear at the parent of
 668  * a zone cut.
 669  *
 670  * Requires:
 671  * \li  'type' is a valid rdata type.
 672  *
 673  */
 674
 675 unsigned int
 676 dns_rdatatype_attributes(dns_rdatatype_t rdtype);
 677 /*%<
 678  * Return attributes for the given type.
 679  *
 680  * Requires:
 681  *\li   'rdtype' are known.
 682  *
 683  * Returns:
 684  *\li   a bitmask consisting of the following flags.
 685  */
 686
 687 /*% only one may exist for a name */
 688 #define DNS_RDATATYPEATTR_SINGLETON             0x00000001U
 689 /*% requires no other data be present */
 690 #define DNS_RDATATYPEATTR_EXCLUSIVE             0x00000002U
 691 /*% Is a meta type */
 692 #define DNS_RDATATYPEATTR_META                  0x00000004U
 693 /*% Is a DNSSEC type, like RRSIG or NSEC */
 694 #define DNS_RDATATYPEATTR_DNSSEC                0x00000008U
 695 /*% Is a zone cut authority type */
 696 #define DNS_RDATATYPEATTR_ZONECUTAUTH           0x00000010U
 697 /*% Is reserved (unusable) */
 698 #define DNS_RDATATYPEATTR_RESERVED              0x00000020U
 699 /*% Is an unknown type */
 700 #define DNS_RDATATYPEATTR_UNKNOWN               0x00000040U
 701 /*% Is META, and can only be in a question section */
 702 #define DNS_RDATATYPEATTR_QUESTIONONLY          0x00000080U
 703 /*% is META, and can NOT be in a question section */
 704 #define DNS_RDATATYPEATTR_NOTQUESTION           0x00000100U
 705 /*% Is present at zone cuts in the parent, not the child */
 706 #define DNS_RDATATYPEATTR_ATPARENT              0x00000200U
 707
 708 dns_rdatatype_t
 709 dns_rdata_covers(dns_rdata_t *rdata);
 710 /*%<
 711  * Return the rdatatype that this type covers.
 712  *
 713  * Requires:
 714  *\li   'rdata' is a valid, non-empty rdata.
 715  *
 716  *\li   'rdata' is a type that covers other rdata types.
 717  *
 718  * Returns:
 719  *\li   The type covered.
 720  */
 721
 722 isc_boolean_t
 723 dns_rdata_checkowner(dns_name_t* name, dns_rdataclass_t rdclass,
 724                      dns_rdatatype_t type, isc_boolean_t wildcard);
 725 /*
 726  * Returns whether this is a valid ownername for this <type,class>.
 727  * If wildcard is true allow the first label to be a wildcard if
 728  * appropriate.
 729  *
 730  * Requires:
 731  *      'name' is a valid name.
 732  */
 733
 734 isc_boolean_t
 735 dns_rdata_checknames(dns_rdata_t *rdata, dns_name_t *owner, dns_name_t *bad);
 736 /*
 737  * Returns whether 'rdata' contains valid domain names.  The checks are
 738  * sensitive to the owner name.
 739  *
 740  * If 'bad' is non-NULL and a domain name fails the check the
 741  * the offending name will be return in 'bad' by cloning from
 742  * the 'rdata' contents.
 743  *
 744  * Requires:
 745  *      'rdata' to be valid.
 746  *      'owner' to be valid.
 747  *      'bad'   to be NULL or valid.
 748  */
 749
 750 void
 751 dns_rdata_exists(dns_rdata_t *rdata, dns_rdatatype_t type);
 752
 753 void
 754 dns_rdata_notexist(dns_rdata_t *rdata, dns_rdatatype_t type);
 755
 756 void
 757 dns_rdata_deleterrset(dns_rdata_t *rdata, dns_rdatatype_t type);
 758
 759 void
 760 dns_rdata_makedelete(dns_rdata_t *rdata);
 761
 762 const char *
 763 dns_rdata_updateop(dns_rdata_t *rdata, dns_section_t section);
 764
 765 ISC_LANG_ENDDECLS
 766
 767 #endif /* DNS_RDATA_H */