rr.h

Go to the documentation of this file.
00001 /*
00002  * rr.h -  resource record definitions
00003  *
00004  * a Net::DNS like library for C
00005  *
00006  * (c) NLnet Labs, 2005-2006
00007  *
00008  * See the file LICENSE for the license
00009  */
00010 
00018 #ifndef LDNS_RR_H
00019 #define LDNS_RR_H
00020 
00021 #include <ldns/common.h>
00022 #include <ldns/rdata.h>
00023 #include <ldns/buffer.h>
00024 #include <ldns/error.h>
00025 
00027 #define LDNS_MAX_LABELLEN     63
00028 
00029 #define LDNS_MAX_DOMAINLEN    255
00030 
00031 #define LDNS_MAX_POINTERS       65535
00032 
00033 #define LDNS_RR_OVERHEAD        10
00034 
00035 /* The first fields are 'common' and can be referenced instantly */
00036 #define LDNS_RDATA_FIELD_DESCRIPTORS_COMMON 51
00037 
00038 
00039 
00043 enum ldns_enum_rr_class
00044 {
00046         LDNS_RR_CLASS_IN        = 1,
00048         LDNS_RR_CLASS_CH        = 3,
00050         LDNS_RR_CLASS_HS        = 4,
00052         LDNS_RR_CLASS_NONE      = 254,
00054         LDNS_RR_CLASS_ANY       = 255,
00055 
00056         LDNS_RR_CLASS_FIRST     = 0,
00057         LDNS_RR_CLASS_LAST      = 65535,
00058         LDNS_RR_CLASS_COUNT     = LDNS_RR_CLASS_LAST - LDNS_RR_CLASS_FIRST + 1
00059 };
00060 typedef enum ldns_enum_rr_class ldns_rr_class;
00061 
00065 enum ldns_enum_rr_compress
00066 {
00068         LDNS_RR_COMPRESS,
00069         LDNS_RR_NO_COMPRESS
00070 };
00071 typedef enum ldns_enum_rr_compress ldns_rr_compress;
00072 
00076 enum ldns_enum_rr_type
00077 {
00079         LDNS_RR_TYPE_A = 1, 
00081         LDNS_RR_TYPE_NS = 2, 
00083         LDNS_RR_TYPE_MD = 3, 
00085         LDNS_RR_TYPE_MF = 4, 
00087         LDNS_RR_TYPE_CNAME = 5, 
00089         LDNS_RR_TYPE_SOA = 6, 
00091         LDNS_RR_TYPE_MB = 7, 
00093         LDNS_RR_TYPE_MG = 8, 
00095         LDNS_RR_TYPE_MR = 9, 
00097         LDNS_RR_TYPE_NULL = 10,
00099         LDNS_RR_TYPE_WKS = 11,
00101         LDNS_RR_TYPE_PTR = 12,
00103         LDNS_RR_TYPE_HINFO = 13,
00105         LDNS_RR_TYPE_MINFO = 14,
00107         LDNS_RR_TYPE_MX = 15,
00109         LDNS_RR_TYPE_TXT = 16,
00111         LDNS_RR_TYPE_RP = 17,
00113         LDNS_RR_TYPE_AFSDB = 18,
00115         LDNS_RR_TYPE_X25 = 19,
00117         LDNS_RR_TYPE_ISDN = 20,
00119         LDNS_RR_TYPE_RT = 21,
00121         LDNS_RR_TYPE_NSAP = 22,
00123         LDNS_RR_TYPE_NSAP_PTR = 23,
00125         LDNS_RR_TYPE_SIG = 24,
00127         LDNS_RR_TYPE_KEY = 25,
00129         LDNS_RR_TYPE_PX = 26,
00131         LDNS_RR_TYPE_GPOS = 27,
00133         LDNS_RR_TYPE_AAAA = 28,
00135         LDNS_RR_TYPE_LOC = 29,
00137         LDNS_RR_TYPE_NXT = 30,
00139         LDNS_RR_TYPE_EID = 31,
00141         LDNS_RR_TYPE_NIMLOC = 32,
00143         LDNS_RR_TYPE_SRV = 33,
00145         LDNS_RR_TYPE_ATMA = 34,
00147         LDNS_RR_TYPE_NAPTR = 35,
00149         LDNS_RR_TYPE_KX = 36,
00151         LDNS_RR_TYPE_CERT = 37,
00153         LDNS_RR_TYPE_A6 = 38,
00155         LDNS_RR_TYPE_DNAME = 39,
00157         LDNS_RR_TYPE_SINK = 40,
00159         LDNS_RR_TYPE_OPT = 41,
00161         LDNS_RR_TYPE_APL = 42,
00163         LDNS_RR_TYPE_DS = 43,
00165         LDNS_RR_TYPE_SSHFP = 44,
00167         LDNS_RR_TYPE_IPSECKEY = 45,
00169         LDNS_RR_TYPE_RRSIG = 46,
00170         LDNS_RR_TYPE_NSEC = 47,      
00171         LDNS_RR_TYPE_DNSKEY = 48,
00172         LDNS_RR_TYPE_DHCID = 49,
00173 
00174         /* TODO: Temporary assume type code 50, 51 (from draft-11) */
00175         LDNS_RR_TYPE_NSEC3 = 50,
00176         LDNS_RR_TYPE_NSEC3PARAMS = 51,
00177 
00178         LDNS_RR_TYPE_UINFO = 100,
00179         LDNS_RR_TYPE_UID = 101,
00180         LDNS_RR_TYPE_GID = 102,
00181         LDNS_RR_TYPE_UNSPEC = 103,
00182 
00183         LDNS_RR_TYPE_TSIG = 250,
00184         LDNS_RR_TYPE_IXFR = 251,
00185         LDNS_RR_TYPE_AXFR = 252,
00187         LDNS_RR_TYPE_MAILB = 253,
00189         LDNS_RR_TYPE_MAILA = 254,
00191         LDNS_RR_TYPE_ANY = 255,
00192 
00193         /* type codes from nsec3 experimental phase
00194         LDNS_RR_TYPE_NSEC3 = 65324,
00195         LDNS_RR_TYPE_NSEC3PARAMS = 65325, */
00196         LDNS_RR_TYPE_FIRST = 0,
00197         LDNS_RR_TYPE_LAST  = 65535,
00198         LDNS_RR_TYPE_COUNT = LDNS_RR_TYPE_LAST - LDNS_RR_TYPE_FIRST + 1
00199 };
00200 typedef enum ldns_enum_rr_type ldns_rr_type;
00201 
00263 struct ldns_struct_rr
00264 {
00266         ldns_rdf        *_owner;        
00268         uint32_t        _ttl;   
00270         size_t          _rd_count;
00272         ldns_rr_type    _rr_type;       
00274         ldns_rr_class   _rr_class;
00275         /* everything in the rdata is in network order */
00277         ldns_rdf         **_rdata_fields;
00278 };
00279 typedef struct ldns_struct_rr ldns_rr;
00280 
00287 struct ldns_struct_rr_list
00288 {
00289         size_t _rr_count;
00290         size_t _rr_capacity;
00291         ldns_rr **_rrs;
00292 };
00293 typedef struct ldns_struct_rr_list ldns_rr_list;
00294 
00300 struct ldns_struct_rr_descriptor
00301 {
00303         ldns_rr_type    _type;
00305         const char *_name;
00307         uint8_t     _minimum;
00309         uint8_t     _maximum;
00311         const ldns_rdf_type *_wireformat;
00313         ldns_rdf_type _variable;
00315         ldns_rr_compress _compress;
00317         uint8_t _dname_count;
00318 };
00319 typedef struct ldns_struct_rr_descriptor ldns_rr_descriptor;
00320 
00325 ldns_rr* ldns_rr_new(void);
00326 
00331 ldns_rr* ldns_rr_new_frm_type(ldns_rr_type t);
00332 
00338 void ldns_rr_free(ldns_rr *rr);
00339 
00353 ldns_status ldns_rr_new_frm_str(ldns_rr **n, const char *str, uint32_t default_ttl, ldns_rdf *origin, ldns_rdf **prev);
00354 
00369 ldns_status ldns_rr_new_frm_fp(ldns_rr **rr, FILE *fp, uint32_t *default_ttl, ldns_rdf **origin, ldns_rdf **prev);
00370 
00386 ldns_status ldns_rr_new_frm_fp_l(ldns_rr **rr, FILE *fp, uint32_t *default_ttl, ldns_rdf **origin, ldns_rdf **prev, int *line_nr);
00387 
00394 void ldns_rr_set_owner(ldns_rr *rr, ldns_rdf *owner);
00395 
00402 void ldns_rr_set_ttl(ldns_rr *rr, uint32_t ttl);
00403 
00410 void ldns_rr_set_rd_count(ldns_rr *rr, size_t count);
00411 
00418 void ldns_rr_set_type(ldns_rr *rr, ldns_rr_type rr_type);
00419 
00426 void ldns_rr_set_class(ldns_rr *rr, ldns_rr_class rr_class);
00427 
00436 ldns_rdf* ldns_rr_set_rdf(ldns_rr *rr, const ldns_rdf *f, size_t position);
00437 
00445 bool ldns_rr_push_rdf(ldns_rr *rr, const ldns_rdf *f);
00446 
00453 ldns_rdf* ldns_rr_pop_rdf(ldns_rr *rr);
00454 
00461 ldns_rdf* ldns_rr_rdf(const ldns_rr *rr, size_t nr);
00462 
00468 ldns_rdf* ldns_rr_owner(const ldns_rr *rr);
00469 
00475 uint32_t ldns_rr_ttl(const ldns_rr *rr);
00476 
00482 size_t ldns_rr_rd_count(const ldns_rr *rr);
00483 
00489 ldns_rr_type ldns_rr_get_type(const ldns_rr *rr);
00490 
00496 ldns_rr_class ldns_rr_get_class(const ldns_rr *rr);
00497 
00498 /* rr_lists */
00499 
00505 size_t ldns_rr_list_rr_count(const ldns_rr_list *rr_list);
00506 
00513 void ldns_rr_list_set_rr_count(ldns_rr_list *rr_list, size_t count);
00514 
00523 ldns_rr * ldns_rr_list_set_rr(ldns_rr_list *rr_list, const ldns_rr *r, size_t count);
00524 
00531 ldns_rr* ldns_rr_list_rr(const ldns_rr_list *rr_list, size_t nr);
00532 
00537 ldns_rr_list* ldns_rr_list_new();
00538 
00543 void ldns_rr_list_free(ldns_rr_list *rr_list);
00544 
00549 void ldns_rr_list_deep_free(ldns_rr_list *rr_list);
00550 
00558 bool ldns_rr_list_cat(ldns_rr_list *left, ldns_rr_list *right);
00559 
00567 ldns_rr_list* ldns_rr_list_cat_clone(ldns_rr_list *left, ldns_rr_list *right);
00568 
00575 bool ldns_rr_list_push_rr(ldns_rr_list *rr_list, const ldns_rr *rr);
00576 
00583 bool ldns_rr_list_push_rr_list(ldns_rr_list *rr_list, const ldns_rr_list *push_list);
00584 
00590 ldns_rr* ldns_rr_list_pop_rr(ldns_rr_list *rr_list);
00591 
00598 ldns_rr_list* ldns_rr_list_pop_rr_list(ldns_rr_list *rr_list, size_t size);
00599 
00607 bool ldns_rr_list_contains_rr(const ldns_rr_list *rr_list, ldns_rr *rr); 
00608 
00614 bool ldns_is_rrset(ldns_rr_list *rr_list);
00615 
00622 bool ldns_rr_set_push_rr(ldns_rr_list *rr_list, ldns_rr *rr);
00623 
00631 ldns_rr* ldns_rr_set_pop_rr(ldns_rr_list *rr_list);
00632 
00638 ldns_rr_list *ldns_rr_list_pop_rrset(ldns_rr_list *rr_list);
00639 
00640 
00646 ldns_rr_type ldns_get_rr_type_by_name(const char *name);
00647 
00653 ldns_rr_class ldns_get_rr_class_by_name(const char *name);
00654 
00660 ldns_rr* ldns_rr_clone(const ldns_rr *rr);
00661 
00667 ldns_rr_list* ldns_rr_list_clone(const ldns_rr_list *rrlist);
00668 
00674 void ldns_rr_list_sort(ldns_rr_list *unsorted);
00675 
00684 int ldns_rr_compare(const ldns_rr *rr1, const ldns_rr *rr2);
00685 int ldns_rr_compare_nsec3(const ldns_rr *rr1, const ldns_rr *rr2);
00686 
00695 int ldns_rr_compare_no_rdata(const ldns_rr *rr1, const ldns_rr *rr2);
00696 
00705 int ldns_rr_compare_wire(ldns_buffer *rr1_buf, ldns_buffer *rr2_buf);
00706 
00715 bool ldns_rr_compare_ds(const ldns_rr *rr1, const ldns_rr *rr2);
00716 
00725 int ldns_rr_list_compare(const ldns_rr_list *rrl1, const ldns_rr_list *rrl2);
00726 
00732 size_t ldns_rr_uncompressed_size(const ldns_rr *r);
00733 
00739 void ldns_rr2canonical(ldns_rr *rr);
00740 
00746 void ldns_rr_list2canonical(ldns_rr_list *rr_list);
00747 
00753 uint8_t ldns_rr_label_count(ldns_rr *rr);
00754 
00761 const ldns_rr_descriptor *ldns_rr_descript(uint16_t type);
00762 
00769 size_t ldns_rr_descriptor_minimum(const ldns_rr_descriptor *descriptor);
00770 
00777 size_t ldns_rr_descriptor_maximum(const ldns_rr_descriptor *descriptor);
00778 
00786 ldns_rdf_type ldns_rr_descriptor_field_type(const ldns_rr_descriptor *descriptor, size_t field);
00787 
00799 ldns_rr_list *ldns_rr_list_subtype_by_rdf(ldns_rr_list *l, ldns_rdf *r, size_t pos);
00800 
00809 ldns_rr_type    ldns_rdf2rr_type(const ldns_rdf *rd);
00810 
00811 #endif /* LDNS_RR_H */

Generated on Fri Sep 19 13:35:25 2008 for ldns by  doxygen 1.5.5