edns.h

Go to the documentation of this file.

/*
 * edns.h
 *
 *
 * a Net::DNS like library for C
 *
 * (c) NLnet Labs, 2004-2022
 *
 * See the file LICENSE for the license
 */
 
#ifndef LDNS_EDNS_H
#define LDNS_EDNS_H
 
#include <ldns/common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
enum ldns_enum_edns_option
{
        LDNS_EDNS_LLQ = 1, /* RFC8764 */
        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_EXPIRE = 9, /* RFC7314 */
        LDNS_EDNS_COOKIE = 10, /* RFC7873 */
        LDNS_EDNS_KEEPALIVE = 11, /* RFC7828*/
        LDNS_EDNS_PADDING = 12, /* RFC7830 */
        LDNS_EDNS_CHAIN = 13, /* RFC7901 */
        LDNS_EDNS_KEY_TAG = 14, /* RFC8145 */
        LDNS_EDNS_EDE = 15, /* RFC8914 */
        LDNS_EDNS_CLIENT_TAG = 16, /* draft-bellis-dnsop-edns-tags-01 */
        LDNS_EDNS_SERVER_TAG = 17 /* draft-bellis-dnsop-edns-tags-01 */
};
typedef enum ldns_enum_edns_option ldns_edns_option_code;
 
enum ldns_edns_enum_ede_code
{
        LDNS_EDE_OTHER = 0,
        LDNS_EDE_UNSUPPORTED_DNSKEY_ALG = 1,
        LDNS_EDE_UNSUPPORTED_DS_DIGEST = 2,
        LDNS_EDE_STALE_ANSWER = 3,
        LDNS_EDE_FORGED_ANSWER = 4,
        LDNS_EDE_DNSSEC_INDETERMINATE = 5,
        LDNS_EDE_DNSSEC_BOGUS = 6,
        LDNS_EDE_SIGNATURE_EXPIRED = 7,
        LDNS_EDE_SIGNATURE_NOT_YET_VALID = 8,
        LDNS_EDE_DNSKEY_MISSING = 9,
        LDNS_EDE_RRSIGS_MISSING = 10,
        LDNS_EDE_NO_ZONE_KEY_BIT_SET = 11,
        LDNS_EDE_NSEC_MISSING = 12,
        LDNS_EDE_CACHED_ERROR = 13,
        LDNS_EDE_NOT_READY = 14,
        LDNS_EDE_BLOCKED = 15,
        LDNS_EDE_CENSORED = 16,
        LDNS_EDE_FILTERED = 17,
        LDNS_EDE_PROHIBITED = 18,
        LDNS_EDE_STALE_NXDOMAIN_ANSWER = 19,
        LDNS_EDE_NOT_AUTHORITATIVE = 20,
        LDNS_EDE_NOT_SUPPORTED = 21,
        LDNS_EDE_NO_REACHABLE_AUTHORITY = 22,
        LDNS_EDE_NETWORK_ERROR = 23,
        LDNS_EDE_INVALID_DATA = 24,
        LDNS_EDE_SIGNATURE_EXPIRED_BEFORE_VALID = 25,
        LDNS_EDE_TOO_EARLY = 26
};
typedef enum ldns_edns_enum_ede_code ldns_edns_ede_code;
 
struct ldns_struct_edns_option {
        ldns_edns_option_code _code;
        size_t                _size;
        void                 *_data;
};
typedef struct ldns_struct_edns_option ldns_edns_option;
 
 
/* 
 * Array structure to store multiple EDNS options
 */
struct ldns_struct_edns_option_list
{
        size_t _option_count; /* the number of EDNS options in the list */
   size_t _option_capacity; /* the amount of options that fit into the list */
        size_t _options_size; /* the total size of the options serialized */
        ldns_edns_option **_options;
};
typedef struct ldns_struct_edns_option_list ldns_edns_option_list;
 
/*
 * Access functions 
 * do this as functions to get type checking
 */
 
size_t ldns_edns_get_size(const ldns_edns_option *edns);
 
ldns_edns_option_code ldns_edns_get_code(const ldns_edns_option *edns);
 
uint8_t *ldns_edns_get_data(const ldns_edns_option *edns);
 
ldns_status ldns_edns_ede_get_code(const ldns_edns_option *edns, uint16_t *ede_code);
 
ldns_status ldns_edns_ede_get_text(const ldns_edns_option* edns, char **ede_text);
 
ldns_buffer *ldns_edns_get_wireformat_buffer(const ldns_edns_option *edns);
 
/* Constructors and destructors*/
 
ldns_edns_option *ldns_edns_new(ldns_edns_option_code code, size_t size, void *data);
 
ldns_edns_option *ldns_edns_new_from_data(ldns_edns_option_code code, size_t size, const void *data);
 
ldns_edns_option *ldns_edns_clone(ldns_edns_option *edns);
 
void ldns_edns_deep_free(ldns_edns_option *edns);
void ldns_edns_free(ldns_edns_option *edns);
 
ldns_edns_option_list* ldns_edns_option_list_new(void);
 
ldns_edns_option_list *ldns_edns_option_list_clone(ldns_edns_option_list *options_list);
 
void ldns_edns_option_list_free(ldns_edns_option_list *options_list);
void ldns_edns_option_list_deep_free(ldns_edns_option_list *options_list);
 
/* edns_option_list functions */
 
size_t ldns_edns_option_list_get_count(const ldns_edns_option_list *options_list);
 
ldns_edns_option* ldns_edns_option_list_get_option(const ldns_edns_option_list *options_list,
        size_t index);
 
 
size_t ldns_edns_option_list_get_options_size(const ldns_edns_option_list *options_list);
 
ldns_edns_option *ldns_edns_option_list_set_option(ldns_edns_option_list *options_list,
        ldns_edns_option *option, size_t index);
 
bool ldns_edns_option_list_push(ldns_edns_option_list *options_list,
        ldns_edns_option *option);
 
ldns_edns_option* ldns_edns_option_list_pop(ldns_edns_option_list *options_list);
 
ldns_buffer *ldns_edns_option_list2wireformat_buffer(const ldns_edns_option_list *option_list);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LDNS_EDNS_H */