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.70.120.3 2009/02/16 00:29:27 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
  99 ISC_LANG_BEGINDECLS
 100
 101
 102 /***
 103  *** Types
 104  ***/
 105
 106 /*%
 107  ***** An 'rdata' is a handle to a binary region.  The handle has an RR
 108  ***** class and type, and the data in the binary region is in the format
 109  ***** of the given class and type.
 110  *****/
 111 /*%
 112  * Clients are strongly discouraged from using this type directly, with
 113  * the exception of the 'link' field which may be used directly for whatever
 114  * purpose the client desires.
 115  */
 116 struct dns_rdata {
 117         unsigned char *                 data;
 118         unsigned int                    length;
 119         dns_rdataclass_t                rdclass;
 120         dns_rdatatype_t                 type;
 121         unsigned int                    flags;
 122         ISC_LINK(dns_rdata_t)           link;
 123 };
 124
 125 #define DNS_RDATA_INIT { NULL, 0, 0, 0, 0, {(void*)(-1), (void *)(-1)}}
 126
 127 #define DNS_RDATA_UPDATE        0x0001          /*%< update pseudo record. */
 128 #define DNS_RDATA_OFFLINE       0x0002          /*%< RRSIG has a offline key. */
 129
 130 /*
 131  * Flags affecting rdata formatting style.  Flags 0xFFFF0000
 132  * are used by masterfile-level formatting and defined elsewhere.
 133  * See additional comments at dns_rdata_tofmttext().
 134  */
 135
 136 /*% Split the rdata into multiple lines to try to keep it
 137  within the "width". */
 138 #define DNS_STYLEFLAG_MULTILINE         0x00000001U
 139
 140 /*% Output explanatory comments. */
 141 #define DNS_STYLEFLAG_COMMENT           0x00000002U
 142
 143 #define DNS_RDATA_DOWNCASE              DNS_NAME_DOWNCASE
 144 #define DNS_RDATA_CHECKNAMES            DNS_NAME_CHECKNAMES
 145 #define DNS_RDATA_CHECKNAMESFAIL        DNS_NAME_CHECKNAMESFAIL
 146 #define DNS_RDATA_CHECKREVERSE          DNS_NAME_CHECKREVERSE
 147 #define DNS_RDATA_CHECKMX               DNS_NAME_CHECKMX
 148 #define DNS_RDATA_CHECKMXFAIL           DNS_NAME_CHECKMXFAIL
 149
 150 /***
 151  *** Initialization
 152  ***/
 153
 154 void
 155 dns_rdata_init(dns_rdata_t *rdata);
 156 /*%<
 157  * Make 'rdata' empty.
 158  *
 159  * Requires:
 160  *      'rdata' is a valid rdata (i.e. not NULL, points to a struct dns_rdata)
 161  */
 162
 163 void
 164 dns_rdata_reset(dns_rdata_t *rdata);
 165 /*%<
 166  * Make 'rdata' empty.
 167  *
 168  * Requires:
 169  *\li   'rdata' is a previously initialized rdata and is not linked.
 170  */
 171
 172 void
 173 dns_rdata_clone(const dns_rdata_t *src, dns_rdata_t *target);
 174 /*%<
 175  * Clone 'target' from 'src'.
 176  *
 177  * Requires:
 178  *\li   'src' to be initialized.
 179  *\li   'target' to be initialized.
 180  */
 181
 182 /***
 183  *** Comparisons
 184  ***/
 185
 186 int
 187 dns_rdata_compare(const dns_rdata_t *rdata1, const dns_rdata_t *rdata2);
 188 /*%<
 189  * Determine the relative ordering under the DNSSEC order relation of
 190  * 'rdata1' and 'rdata2'.
 191  *
 192  * Requires:
 193  *
 194  *\li   'rdata1' is a valid, non-empty rdata
 195  *
 196  *\li   'rdata2' is a valid, non-empty rdata
 197  *
 198  * Returns:
 199  *\li   < 0             'rdata1' is less than 'rdata2'
 200  *\li   0               'rdata1' is equal to 'rdata2'
 201  *\li   > 0             'rdata1' is greater than 'rdata2'
 202  */
 203
 204 /***
 205  *** Conversions
 206  ***/
 207
 208 void
 209 dns_rdata_fromregion(dns_rdata_t *rdata, dns_rdataclass_t rdclass,
 210                      dns_rdatatype_t type, isc_region_t *r);
 211 /*%<
 212  * Make 'rdata' refer to region 'r'.
 213  *
 214  * Requires:
 215  *
 216  *\li   The data in 'r' is properly formatted for whatever type it is.
 217  */
 218
 219 void
 220 dns_rdata_toregion(const dns_rdata_t *rdata, isc_region_t *r);
 221 /*%<
 222  * Make 'r' refer to 'rdata'.
 223  */
 224
 225 isc_result_t
 226 dns_rdata_fromwire(dns_rdata_t *rdata, dns_rdataclass_t rdclass,
 227                    dns_rdatatype_t type, isc_buffer_t *source,
 228                    dns_decompress_t *dctx, unsigned int options,
 229                    isc_buffer_t *target);
 230 /*%<
 231  * Copy the possibly-compressed rdata at source into the target region.
 232  *
 233  * Notes:
 234  *\li   Name decompression policy is controlled by 'dctx'.
 235  *
 236  *      'options'
 237  *\li   DNS_RDATA_DOWNCASE      downcase domain names when they are copied
 238  *                              into target.
 239  *
 240  * Requires:
 241  *
 242  *\li   'rdclass' and 'type' are valid.
 243  *
 244  *\li   'source' is a valid buffer, and the active region of 'source'
 245  *      references the rdata to be processed.
 246  *
 247  *\li   'target' is a valid buffer.
 248  *
 249  *\li   'dctx' is a valid decompression context.
 250  *
 251  * Ensures,
 252  *      if result is success:
 253  *      \li     If 'rdata' is not NULL, it is attached to the target.
 254  *      \li     The conditions dns_name_fromwire() ensures for names hold
 255  *              for all names in the rdata.
 256  *      \li     The current location in source is advanced, and the used space
 257  *              in target is updated.
 258  *
 259  * Result:
 260  *\li   Success
 261  *\li   Any non-success status from dns_name_fromwire()
 262  *\li   Various 'Bad Form' class failures depending on class and type
 263  *\li   Bad Form: Input too short
 264  *\li   Resource Limit: Not enough space
 265  */
 266
 267 isc_result_t
 268 dns_rdata_towire(dns_rdata_t *rdata, dns_compress_t *cctx,
 269                  isc_buffer_t *target);
 270 /*%<
 271  * Convert 'rdata' into wire format, compressing it as specified by the
 272  * compression context 'cctx', and storing the result in 'target'.
 273  *
 274  * Notes:
 275  *\li   If the compression context allows global compression, then the
 276  *      global compression table may be updated.
 277  *
 278  * Requires:
 279  *\li   'rdata' is a valid, non-empty rdata
 280  *
 281  *\li   target is a valid buffer
 282  *
 283  *\li   Any offsets specified in a global compression table are valid
 284  *      for target.
 285  *
 286  * Ensures,
 287  *      if the result is success:
 288  *      \li     The used space in target is updated.
 289  *
 290  * Returns:
 291  *\li   Success
 292  *\li   Any non-success status from dns_name_towire()
 293  *\li   Resource Limit: Not enough space
 294  */
 295
 296 isc_result_t
 297 dns_rdata_fromtext(dns_rdata_t *rdata, dns_rdataclass_t rdclass,
 298                    dns_rdatatype_t type, isc_lex_t *lexer, dns_name_t *origin,
 299                    unsigned int options, isc_mem_t *mctx,
 300                    isc_buffer_t *target, dns_rdatacallbacks_t *callbacks);
 301 /*%<
 302  * Convert the textual representation of a DNS rdata into uncompressed wire
 303  * form stored in the target region.  Tokens constituting the text of the rdata
 304  * are taken from 'lexer'.
 305  *
 306  * Notes:
 307  *\li   Relative domain names in the rdata will have 'origin' appended to them.
 308  *      A NULL origin implies "origin == dns_rootname".
 309  *
 310  *
 311  *      'options'
 312  *\li   DNS_RDATA_DOWNCASE      downcase domain names when they are copied
 313  *                              into target.
 314  *\li   DNS_RDATA_CHECKNAMES    perform checknames checks.
 315  *\li   DNS_RDATA_CHECKNAMESFAIL fail if the checknames check fail.  If
 316  *                              not set a warning will be issued.
 317  *\li   DNS_RDATA_CHECKREVERSE  this should set if the owner name ends
 318  *                              in IP6.ARPA, IP6.INT or IN-ADDR.ARPA.
 319  *
 320  * Requires:
 321  *
 322  *\li   'rdclass' and 'type' are valid.
 323  *
 324  *\li   'lexer' is a valid isc_lex_t.
 325  *
 326  *\li   'mctx' is a valid isc_mem_t.
 327  *
 328  *\li   'target' is a valid region.
 329  *
 330  *\li   'origin' if non NULL it must be absolute.
 331  *
 332  *\li   'callbacks' to be NULL or callbacks->warn and callbacks->error be
 333  *      initialized.
 334  *
 335  * Ensures,
 336  *      if result is success:
 337  *\li           If 'rdata' is not NULL, it is attached to the target.
 338
 339  *\li           The conditions dns_name_fromtext() ensures for names hold
 340  *              for all names in the rdata.
 341
 342  *\li           The used space in target is updated.
 343  *
 344  * Result:
 345  *\li   Success
 346  *\li   Translated result codes from isc_lex_gettoken
 347  *\li   Various 'Bad Form' class failures depending on class and type
 348  *\li   Bad Form: Input too short
 349  *\li   Resource Limit: Not enough space
 350  *\li   Resource Limit: Not enough memory
 351  */
 352
 353 isc_result_t
 354 dns_rdata_totext(dns_rdata_t *rdata, dns_name_t *origin, isc_buffer_t *target);
 355 /*%<
 356  * Convert 'rdata' into text format, storing the result in 'target'.
 357  * The text will consist of a single line, with fields separated by
 358  * single spaces.
 359  *
 360  * Notes:
 361  *\li   If 'origin' is not NULL, then any names in the rdata that are
 362  *      subdomains of 'origin' will be made relative it.
 363  *
 364  *\li   XXX Do we *really* want to support 'origin'?  I'm inclined towards "no"
 365  *      at the moment.
 366  *
 367  * Requires:
 368  *
 369  *\li   'rdata' is a valid, non-empty rdata
 370  *
 371  *\li   'origin' is NULL, or is a valid name
 372  *
 373  *\li   'target' is a valid text buffer
 374  *
 375  * Ensures,
 376  *      if the result is success:
 377  *
 378  *      \li     The used space in target is updated.
 379  *
 380  * Returns:
 381  *\li   Success
 382  *\li   Any non-success status from dns_name_totext()
 383  *\li   Resource Limit: Not enough space
 384  */
 385
 386 isc_result_t
 387 dns_rdata_tofmttext(dns_rdata_t *rdata, dns_name_t *origin, unsigned int flags,
 388                     unsigned int width, const char *linebreak,
 389                     isc_buffer_t *target);
 390 /*%<
 391  * Like dns_rdata_totext, but do formatted output suitable for
 392  * database dumps.  This is intended for use by dns_db_dump();
 393  * library users are discouraged from calling it directly.
 394  *
 395  * If (flags & #DNS_STYLEFLAG_MULTILINE) != 0, attempt to stay
 396  * within 'width' by breaking the text into multiple lines.
 397  * The string 'linebreak' is inserted between lines, and parentheses
 398  * are added when necessary.  Because RRs contain unbreakable elements
 399  * such as domain names whose length is variable, unpredictable, and
 400  * potentially large, there is no guarantee that the lines will
 401  * not exceed 'width' anyway.
 402  *
 403  * If (flags & #DNS_STYLEFLAG_MULTILINE) == 0, the rdata is always
 404  * printed as a single line, and no parentheses are used.
 405  * The 'width' and 'linebreak' arguments are ignored.
 406  *
 407  * If (flags & #DNS_STYLEFLAG_COMMENT) != 0, output explanatory
 408  * comments next to things like the SOA timer fields.  Some
 409  * comments (e.g., the SOA ones) are only printed when multiline
 410  * output is selected.
 411  */
 412
 413 isc_result_t
 414 dns_rdata_fromstruct(dns_rdata_t *rdata, dns_rdataclass_t rdclass,
 415                      dns_rdatatype_t type, void *source, isc_buffer_t *target);
 416 /*%<
 417  * Convert the C structure representation of an rdata into uncompressed wire
 418  * format in 'target'.
 419  *
 420  * XXX  Should we have a 'size' parameter as a sanity check on target?
 421  *
 422  * Requires:
 423  *
 424  *\li   'rdclass' and 'type' are valid.
 425  *
 426  *\li   'source' points to a valid C struct for the class and type.
 427  *
 428  *\li   'target' is a valid buffer.
 429  *
 430  *\li   All structure pointers to memory blocks should be NULL if their
 431  *      corresponding length values are zero.
 432  *
 433  * Ensures,
 434  *      if result is success:
 435  *      \li     If 'rdata' is not NULL, it is attached to the target.
 436  *
 437  *      \li     The used space in 'target' is updated.
 438  *
 439  * Result:
 440  *\li   Success
 441  *\li   Various 'Bad Form' class failures depending on class and type
 442  *\li   Resource Limit: Not enough space
 443  */
 444
 445 isc_result_t
 446 dns_rdata_tostruct(dns_rdata_t *rdata, void *target, isc_mem_t *mctx);
 447 /*%<
 448  * Convert an rdata into its C structure representation.
 449  *
 450  * If 'mctx' is NULL then 'rdata' must persist while 'target' is being used.
 451  *
 452  * If 'mctx' is non NULL then memory will be allocated if required.
 453  *
 454  * Requires:
 455  *
 456  *\li   'rdata' is a valid, non-empty rdata.
 457  *
 458  *\li   'target' to point to a valid pointer for the type and class.
 459  *
 460  * Result:
 461  *\li   Success
 462  *\li   Resource Limit: Not enough memory
 463  */
 464
 465 void
 466 dns_rdata_freestruct(void *source);
 467 /*%<
 468  * Free dynamic memory attached to 'source' (if any).
 469  *
 470  * Requires:
 471  *
 472  *\li   'source' to point to the structure previously filled in by
 473  *      dns_rdata_tostruct().
 474  */
 475
 476 isc_boolean_t
 477 dns_rdatatype_ismeta(dns_rdatatype_t type);
 478 /*%<
 479  * Return true iff the rdata type 'type' is a meta-type
 480  * like ANY or AXFR.
 481  */
 482
 483 isc_boolean_t
 484 dns_rdatatype_issingleton(dns_rdatatype_t type);
 485 /*%<
 486  * Return true iff the rdata type 'type' is a singleton type,
 487  * like CNAME or SOA.
 488  *
 489  * Requires:
 490  * \li  'type' is a valid rdata type.
 491  *
 492  */
 493
 494 isc_boolean_t
 495 dns_rdataclass_ismeta(dns_rdataclass_t rdclass);
 496 /*%<
 497  * Return true iff the rdata class 'rdclass' is a meta-class
 498  * like ANY or NONE.
 499  */
 500
 501 isc_boolean_t
 502 dns_rdatatype_isdnssec(dns_rdatatype_t type);
 503 /*%<
 504  * Return true iff 'type' is one of the DNSSEC
 505  * rdata types that may exist alongside a CNAME record.
 506  *
 507  * Requires:
 508  * \li  'type' is a valid rdata type.
 509  */
 510
 511 isc_boolean_t
 512 dns_rdatatype_iszonecutauth(dns_rdatatype_t type);
 513 /*%<
 514  * Return true iff rdata of type 'type' is considered authoritative
 515  * data (not glue) in the NSEC chain when it occurs in the parent zone
 516  * at a zone cut.
 517  *
 518  * Requires:
 519  * \li  'type' is a valid rdata type.
 520  *
 521  */
 522
 523 isc_boolean_t
 524 dns_rdatatype_isknown(dns_rdatatype_t type);
 525 /*%<
 526  * Return true iff the rdata type 'type' is known.
 527  *
 528  * Requires:
 529  * \li  'type' is a valid rdata type.
 530  *
 531  */
 532
 533
 534 isc_result_t
 535 dns_rdata_additionaldata(dns_rdata_t *rdata, dns_additionaldatafunc_t add,
 536                          void *arg);
 537 /*%<
 538  * Call 'add' for each name and type from 'rdata' which is subject to
 539  * additional section processing.
 540  *
 541  * Requires:
 542  *
 543  *\li   'rdata' is a valid, non-empty rdata.
 544  *
 545  *\li   'add' is a valid dns_additionalfunc_t.
 546  *
 547  * Ensures:
 548  *
 549  *\li   If successful, then add() will have been called for each name
 550  *      and type subject to additional section processing.
 551  *
 552  *\li   If add() returns something other than #ISC_R_SUCCESS, that result
 553  *      will be returned as the result of dns_rdata_additionaldata().
 554  *
 555  * Returns:
 556  *
 557  *\li   ISC_R_SUCCESS
 558  *
 559  *\li   Many other results are possible if not successful.
 560  */
 561
 562 isc_result_t
 563 dns_rdata_digest(dns_rdata_t *rdata, dns_digestfunc_t digest, void *arg);
 564 /*%<
 565  * Send 'rdata' in DNSSEC canonical form to 'digest'.
 566  *
 567  * Note:
 568  *\li   'digest' may be called more than once by dns_rdata_digest().  The
 569  *      concatenation of all the regions, in the order they were given
 570  *      to 'digest', will be the DNSSEC canonical form of 'rdata'.
 571  *
 572  * Requires:
 573  *
 574  *\li   'rdata' is a valid, non-empty rdata.
 575  *
 576  *\li   'digest' is a valid dns_digestfunc_t.
 577  *
 578  * Ensures:
 579  *
 580  *\li   If successful, then all of the rdata's data has been sent, in
 581  *      DNSSEC canonical form, to 'digest'.
 582  *
 583  *\li   If digest() returns something other than ISC_R_SUCCESS, that result
 584  *      will be returned as the result of dns_rdata_digest().
 585  *
 586  * Returns:
 587  *
 588  *\li   ISC_R_SUCCESS
 589  *
 590  *\li   Many other results are possible if not successful.
 591  */
 592
 593 isc_boolean_t
 594 dns_rdatatype_questiononly(dns_rdatatype_t type);
 595 /*%<
 596  * Return true iff rdata of type 'type' can only appear in the question
 597  * section of a properly formatted message.
 598  *
 599  * Requires:
 600  * \li  'type' is a valid rdata type.
 601  *
 602  */
 603
 604 isc_boolean_t
 605 dns_rdatatype_notquestion(dns_rdatatype_t type);
 606 /*%<
 607  * Return true iff rdata of type 'type' can not appear in the question
 608  * section of a properly formatted message.
 609  *
 610  * Requires:
 611  * \li  'type' is a valid rdata type.
 612  *
 613  */
 614
 615 isc_boolean_t
 616 dns_rdatatype_atparent(dns_rdatatype_t type);
 617 /*%<
 618  * Return true iff rdata of type 'type' should appear at the parent of
 619  * a zone cut.
 620  *
 621  * Requires:
 622  * \li  'type' is a valid rdata type.
 623  *
 624  */
 625
 626 unsigned int
 627 dns_rdatatype_attributes(dns_rdatatype_t rdtype);
 628 /*%<
 629  * Return attributes for the given type.
 630  *
 631  * Requires:
 632  *\li   'rdtype' are known.
 633  *
 634  * Returns:
 635  *\li   a bitmask consisting of the following flags.
 636  */
 637
 638 /*% only one may exist for a name */
 639 #define DNS_RDATATYPEATTR_SINGLETON             0x00000001U
 640 /*% requires no other data be present */
 641 #define DNS_RDATATYPEATTR_EXCLUSIVE             0x00000002U
 642 /*% Is a meta type */
 643 #define DNS_RDATATYPEATTR_META                  0x00000004U
 644 /*% Is a DNSSEC type, like RRSIG or NSEC */
 645 #define DNS_RDATATYPEATTR_DNSSEC                0x00000008U
 646 /*% Is a zone cut authority type */
 647 #define DNS_RDATATYPEATTR_ZONECUTAUTH           0x00000010U
 648 /*% Is reserved (unusable) */
 649 #define DNS_RDATATYPEATTR_RESERVED              0x00000020U
 650 /*% Is an unknown type */
 651 #define DNS_RDATATYPEATTR_UNKNOWN               0x00000040U
 652 /*% Is META, and can only be in a question section */
 653 #define DNS_RDATATYPEATTR_QUESTIONONLY          0x00000080U
 654 /*% is META, and can NOT be in a question section */
 655 #define DNS_RDATATYPEATTR_NOTQUESTION           0x00000100U
 656 /*% Is present at zone cuts in the parent, not the child */
 657 #define DNS_RDATATYPEATTR_ATPARENT              0x00000200U
 658
 659 dns_rdatatype_t
 660 dns_rdata_covers(dns_rdata_t *rdata);
 661 /*%<
 662  * Return the rdatatype that this type covers.
 663  *
 664  * Requires:
 665  *\li   'rdata' is a valid, non-empty rdata.
 666  *
 667  *\li   'rdata' is a type that covers other rdata types.
 668  *
 669  * Returns:
 670  *\li   The type covered.
 671  */
 672
 673 isc_boolean_t
 674 dns_rdata_checkowner(dns_name_t* name, dns_rdataclass_t rdclass,
 675                      dns_rdatatype_t type, isc_boolean_t wildcard);
 676 /*
 677  * Returns whether this is a valid ownername for this <type,class>.
 678  * If wildcard is true allow the first label to be a wildcard if
 679  * appropriate.
 680  *
 681  * Requires:
 682  *      'name' is a valid name.
 683  */
 684
 685 isc_boolean_t
 686 dns_rdata_checknames(dns_rdata_t *rdata, dns_name_t *owner, dns_name_t *bad);
 687 /*
 688  * Returns whether 'rdata' contains valid domain names.  The checks are
 689  * sensitive to the owner name.
 690  *
 691  * If 'bad' is non-NULL and a domain name fails the check the
 692  * the offending name will be return in 'bad' by cloning from
 693  * the 'rdata' contents.
 694  *
 695  * Requires:
 696  *      'rdata' to be valid.
 697  *      'owner' to be valid.
 698  *      'bad'   to be NULL or valid.
 699  */
 700
 701 ISC_LANG_ENDDECLS
 702
 703 #endif /* DNS_RDATA_H */