rrdef.h

Go to the documentation of this file.

/*
 * rrdef.h
 *
 * RR definitions
 *
 * a Net::DNS like library for C
 *
 * (c) NLnet Labs, 2005-2006
 *
 * See the file LICENSE for the license
 */

 
#ifndef LDNS_RRDEF_H
#define LDNS_RRDEF_H
 
#ifdef __cplusplus
extern "C" {
#endif

#define LDNS_MAX_LABELLEN     63
#define LDNS_MAX_DOMAINLEN    255
#define LDNS_MAX_POINTERS   65535
#define LDNS_RR_OVERHEAD    10
 
#define LDNS_DNSSEC_KEYPROTO    3
#define LDNS_KEY_ZONE_KEY   0x0100 /* set for ZSK&KSK, rfc 4034 */
#define LDNS_KEY_SEP_KEY    0x0001 /* set for KSK, rfc 4034 */
#define LDNS_KEY_REVOKE_KEY 0x0080 /* used to revoke KSK, rfc 5011 */
 
/* The first fields are contiguous and can be referenced instantly */
#define LDNS_RDATA_FIELD_DESCRIPTORS_COMMON 259

extern struct sldns_struct_lookup_table* sldns_rr_classes;

enum sldns_enum_rr_class
{
    LDNS_RR_CLASS_IN    = 1,
    LDNS_RR_CLASS_CH    = 3,
    LDNS_RR_CLASS_HS    = 4,
    LDNS_RR_CLASS_NONE      = 254,
    LDNS_RR_CLASS_ANY   = 255,
 
    LDNS_RR_CLASS_FIRST     = 0,
    LDNS_RR_CLASS_LAST      = 65535,
    LDNS_RR_CLASS_COUNT     = LDNS_RR_CLASS_LAST - LDNS_RR_CLASS_FIRST + 1
};
typedef enum sldns_enum_rr_class sldns_rr_class;

enum sldns_enum_rr_compress
{
    LDNS_RR_COMPRESS,
    LDNS_RR_NO_COMPRESS
};
typedef enum sldns_enum_rr_compress sldns_rr_compress;

enum sldns_enum_rr_type
{
    LDNS_RR_TYPE_A = 1,
    LDNS_RR_TYPE_NS = 2,
    LDNS_RR_TYPE_MD = 3,
    LDNS_RR_TYPE_MF = 4,
    LDNS_RR_TYPE_CNAME = 5,
    LDNS_RR_TYPE_SOA = 6,
    LDNS_RR_TYPE_MB = 7,
    LDNS_RR_TYPE_MG = 8,
    LDNS_RR_TYPE_MR = 9,
    LDNS_RR_TYPE_NULL = 10,
    LDNS_RR_TYPE_WKS = 11,
    LDNS_RR_TYPE_PTR = 12,
    LDNS_RR_TYPE_HINFO = 13,
    LDNS_RR_TYPE_MINFO = 14,
    LDNS_RR_TYPE_MX = 15,
    LDNS_RR_TYPE_TXT = 16,
    LDNS_RR_TYPE_RP = 17,
    LDNS_RR_TYPE_AFSDB = 18,
    LDNS_RR_TYPE_X25 = 19,
    LDNS_RR_TYPE_ISDN = 20,
    LDNS_RR_TYPE_RT = 21,
    LDNS_RR_TYPE_NSAP = 22,
    LDNS_RR_TYPE_NSAP_PTR = 23,
    LDNS_RR_TYPE_SIG = 24,
    LDNS_RR_TYPE_KEY = 25,
    LDNS_RR_TYPE_PX = 26,
    LDNS_RR_TYPE_GPOS = 27,
    LDNS_RR_TYPE_AAAA = 28,
    LDNS_RR_TYPE_LOC = 29,
    LDNS_RR_TYPE_NXT = 30,
    LDNS_RR_TYPE_EID = 31,
    LDNS_RR_TYPE_NIMLOC = 32,
    LDNS_RR_TYPE_SRV = 33,
    LDNS_RR_TYPE_ATMA = 34,
    LDNS_RR_TYPE_NAPTR = 35,
    LDNS_RR_TYPE_KX = 36,
    LDNS_RR_TYPE_CERT = 37,
    LDNS_RR_TYPE_A6 = 38,
    LDNS_RR_TYPE_DNAME = 39,
    LDNS_RR_TYPE_SINK = 40,
    LDNS_RR_TYPE_OPT = 41,
    LDNS_RR_TYPE_APL = 42,
    LDNS_RR_TYPE_DS = 43,
    LDNS_RR_TYPE_SSHFP = 44, /* RFC 4255 */
    LDNS_RR_TYPE_IPSECKEY = 45, /* RFC 4025 */
    LDNS_RR_TYPE_RRSIG = 46, /* RFC 4034 */
    LDNS_RR_TYPE_NSEC = 47, /* RFC 4034 */
    LDNS_RR_TYPE_DNSKEY = 48, /* RFC 4034 */
 
    LDNS_RR_TYPE_DHCID = 49, /* RFC 4701 */
    /* NSEC3 */
    LDNS_RR_TYPE_NSEC3 = 50, /* RFC 5155 */
    LDNS_RR_TYPE_NSEC3PARAM = 51, /* RFC 5155 */
    LDNS_RR_TYPE_NSEC3PARAMS = 51,
    LDNS_RR_TYPE_TLSA = 52, /* RFC 6698 */
    LDNS_RR_TYPE_SMIMEA = 53, /* draft-ietf-dane-smime, TLSA-like but may
                     be extended */
 
    LDNS_RR_TYPE_HIP = 55, /* RFC 5205 */

    LDNS_RR_TYPE_NINFO = 56,
    LDNS_RR_TYPE_RKEY = 57,
        LDNS_RR_TYPE_TALINK = 58,
    LDNS_RR_TYPE_CDS = 59, 
    LDNS_RR_TYPE_CDNSKEY = 60, 
    LDNS_RR_TYPE_OPENPGPKEY = 61, /* RFC 7929 */
    LDNS_RR_TYPE_CSYNC = 62, /* RFC 7477 */
 
    LDNS_RR_TYPE_SPF = 99, /* RFC 4408 */
 
    LDNS_RR_TYPE_UINFO = 100,
    LDNS_RR_TYPE_UID = 101,
    LDNS_RR_TYPE_GID = 102,
    LDNS_RR_TYPE_UNSPEC = 103,
 
    LDNS_RR_TYPE_NID = 104, /* RFC 6742 */
    LDNS_RR_TYPE_L32 = 105, /* RFC 6742 */
    LDNS_RR_TYPE_L64 = 106, /* RFC 6742 */
    LDNS_RR_TYPE_LP = 107, /* RFC 6742 */

    LDNS_RR_TYPE_EUI48 = 108,
    LDNS_RR_TYPE_EUI64 = 109,
 
    LDNS_RR_TYPE_TKEY = 249, /* RFC 2930 */
    LDNS_RR_TYPE_TSIG = 250,
    LDNS_RR_TYPE_IXFR = 251,
    LDNS_RR_TYPE_AXFR = 252,
    LDNS_RR_TYPE_MAILB = 253,
    LDNS_RR_TYPE_MAILA = 254,
    LDNS_RR_TYPE_ANY = 255,
    LDNS_RR_TYPE_URI = 256, /* RFC 7553 */
    LDNS_RR_TYPE_CAA = 257, /* RFC 6844 */
    LDNS_RR_TYPE_AVC = 258,

    LDNS_RR_TYPE_TA = 32768,
    /* RFC 4431, 5074, DNSSEC Lookaside Validation */
    LDNS_RR_TYPE_DLV = 32769,
 
    /* type codes from nsec3 experimental phase
    LDNS_RR_TYPE_NSEC3 = 65324,
    LDNS_RR_TYPE_NSEC3PARAMS = 65325, */
    LDNS_RR_TYPE_FIRST = 0,
    LDNS_RR_TYPE_LAST  = 65535,
    LDNS_RR_TYPE_COUNT = LDNS_RR_TYPE_LAST - LDNS_RR_TYPE_FIRST + 1
};
typedef enum sldns_enum_rr_type sldns_rr_type;
 
/* RDATA */
#define LDNS_MAX_RDFLEN 65535
 
#define LDNS_RDF_SIZE_BYTE              1
#define LDNS_RDF_SIZE_WORD              2
#define LDNS_RDF_SIZE_DOUBLEWORD        4
#define LDNS_RDF_SIZE_6BYTES            6
#define LDNS_RDF_SIZE_8BYTES            8
#define LDNS_RDF_SIZE_16BYTES           16
 
#define LDNS_NSEC3_VARS_OPTOUT_MASK 0x01
 
#define LDNS_APL_IP4            1
#define LDNS_APL_IP6            2
#define LDNS_APL_MASK           0x7f
#define LDNS_APL_NEGATION       0x80

enum sldns_enum_rdf_type
{
    LDNS_RDF_TYPE_NONE,
    LDNS_RDF_TYPE_DNAME,
    LDNS_RDF_TYPE_INT8,
    LDNS_RDF_TYPE_INT16,
    LDNS_RDF_TYPE_INT32,
    LDNS_RDF_TYPE_A,
    LDNS_RDF_TYPE_AAAA,
    LDNS_RDF_TYPE_STR,
    LDNS_RDF_TYPE_APL,
    LDNS_RDF_TYPE_B32_EXT,
    LDNS_RDF_TYPE_B64,
    LDNS_RDF_TYPE_HEX,
    LDNS_RDF_TYPE_NSEC,
    LDNS_RDF_TYPE_TYPE,
    LDNS_RDF_TYPE_CLASS,
    LDNS_RDF_TYPE_CERT_ALG,
        LDNS_RDF_TYPE_ALG,
        LDNS_RDF_TYPE_UNKNOWN,
        LDNS_RDF_TYPE_TIME,
        LDNS_RDF_TYPE_PERIOD,
        LDNS_RDF_TYPE_TSIGTIME,
    LDNS_RDF_TYPE_HIP,
        LDNS_RDF_TYPE_INT16_DATA,
        LDNS_RDF_TYPE_SERVICE,
        LDNS_RDF_TYPE_LOC,
        LDNS_RDF_TYPE_WKS,
        LDNS_RDF_TYPE_NSAP,
        LDNS_RDF_TYPE_ATMA,
        LDNS_RDF_TYPE_IPSECKEY,
        LDNS_RDF_TYPE_NSEC3_SALT,
        LDNS_RDF_TYPE_NSEC3_NEXT_OWNER,

        LDNS_RDF_TYPE_ILNP64,

        LDNS_RDF_TYPE_EUI48,
        LDNS_RDF_TYPE_EUI64,

        LDNS_RDF_TYPE_TAG,

        LDNS_RDF_TYPE_LONG_STR,

    LDNS_RDF_TYPE_TSIGERROR,
 
        /* Aliases */
        LDNS_RDF_TYPE_BITMAP = LDNS_RDF_TYPE_NSEC
};
typedef enum sldns_enum_rdf_type sldns_rdf_type;

enum sldns_enum_algorithm
{
        LDNS_RSAMD5             = 1,   /* RFC 4034,4035 */
        LDNS_DH                 = 2,
        LDNS_DSA                = 3,
        LDNS_ECC                = 4,
        LDNS_RSASHA1            = 5,
        LDNS_DSA_NSEC3          = 6,
        LDNS_RSASHA1_NSEC3      = 7,
        LDNS_RSASHA256          = 8,   /* RFC 5702 */
        LDNS_RSASHA512          = 10,  /* RFC 5702 */
        LDNS_ECC_GOST           = 12,  /* RFC 5933 */
        LDNS_ECDSAP256SHA256    = 13,  /* RFC 6605 */
        LDNS_ECDSAP384SHA384    = 14,  /* RFC 6605 */
    LDNS_ED25519        = 15,  /* RFC 8080 */
    LDNS_ED448      = 16,  /* RFC 8080 */
        LDNS_INDIRECT           = 252,
        LDNS_PRIVATEDNS         = 253,
        LDNS_PRIVATEOID         = 254
};
typedef enum sldns_enum_algorithm sldns_algorithm;

enum sldns_enum_hash
{
        LDNS_SHA1               = 1,  /* RFC 4034 */
        LDNS_SHA256             = 2,  /* RFC 4509 */
        LDNS_HASH_GOST          = 3,  /* RFC 5933 */
        LDNS_SHA384             = 4   /* RFC 6605 */
};
typedef enum sldns_enum_hash sldns_hash;

enum sldns_enum_cert_algorithm
{
        LDNS_CERT_PKIX          = 1,
        LDNS_CERT_SPKI          = 2,
        LDNS_CERT_PGP           = 3,
        LDNS_CERT_IPKIX         = 4,
        LDNS_CERT_ISPKI         = 5,
        LDNS_CERT_IPGP          = 6,
        LDNS_CERT_ACPKIX        = 7,
        LDNS_CERT_IACPKIX       = 8,
        LDNS_CERT_URI           = 253,
        LDNS_CERT_OID           = 254
};
typedef enum sldns_enum_cert_algorithm sldns_cert_algorithm;

enum sldns_enum_edns_option
{
    LDNS_EDNS_LLQ = 1, /* http://files.dns-sd.org/draft-sekar-dns-llq.txt */
    LDNS_EDNS_UL = 2, /* http://files.dns-sd.org/draft-sekar-dns-ul.txt */
    LDNS_EDNS_NSID = 3, /* RFC5001 */
    /* 4 draft-cheshire-edns0-owner-option */
    LDNS_EDNS_DAU = 5, /* RFC6975 */
    LDNS_EDNS_DHU = 6, /* RFC6975 */
    LDNS_EDNS_N3U = 7, /* RFC6975 */
    LDNS_EDNS_CLIENT_SUBNET = 8, /* RFC7871 */
    LDNS_EDNS_KEEPALIVE = 11, /* draft-ietf-dnsop-edns-tcp-keepalive*/
    LDNS_EDNS_PADDING = 12 /* RFC7830 */
};
typedef enum sldns_enum_edns_option sldns_edns_option;
 
#define LDNS_EDNS_MASK_DO_BIT 0x8000

#define LDNS_TSIG_ERROR_NOERROR  0
#define LDNS_TSIG_ERROR_BADSIG   16
#define LDNS_TSIG_ERROR_BADKEY   17
#define LDNS_TSIG_ERROR_BADTIME  18
#define LDNS_TSIG_ERROR_BADMODE  19
#define LDNS_TSIG_ERROR_BADNAME  20
#define LDNS_TSIG_ERROR_BADALG   21

struct sldns_struct_rr_descriptor
{
    sldns_rr_type    _type;
    const char *_name;
    uint8_t     _minimum;
    uint8_t     _maximum;
    const sldns_rdf_type *_wireformat;
    sldns_rdf_type _variable;
    sldns_rr_compress _compress;
    uint8_t _dname_count;
};
typedef struct sldns_struct_rr_descriptor sldns_rr_descriptor;

const sldns_rr_descriptor *sldns_rr_descript(uint16_t type);

size_t sldns_rr_descriptor_minimum(const sldns_rr_descriptor *descriptor);

size_t sldns_rr_descriptor_maximum(const sldns_rr_descriptor *descriptor);

sldns_rdf_type sldns_rr_descriptor_field_type(const sldns_rr_descriptor *descriptor, size_t field);

sldns_rr_type sldns_get_rr_type_by_name(const char *name);

sldns_rr_class sldns_get_rr_class_by_name(const char *name);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LDNS_RRDEF_H */