config_file.h

Go to the documentation of this file.

/*
 * util/config_file.h - reads and stores the config file for unbound.
 *
 * Copyright (c) 2007, NLnet Labs. All rights reserved.
 *
 * This software is open source.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the NLNET LABS nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

 
#ifndef UTIL_CONFIG_FILE_H
#define UTIL_CONFIG_FILE_H
struct config_stub;
struct config_auth;
struct config_view;
struct config_strlist;
struct config_str2list;
struct config_str3list;
struct config_strbytelist;
struct module_qstate;
struct sock_list;
struct ub_packed_rrset_key;
struct regional;

struct config_strlist_head {
    struct config_strlist* first;
    struct config_strlist* last;
};

struct config_file {
    int verbosity;

    int stat_interval;
    int stat_cumulative;
    int stat_extended;

    int num_threads;

    int port;
    int do_ip4;
    int do_ip6;
    int prefer_ip6;
    int do_udp;
    int do_tcp;
    int tcp_upstream;
    int udp_upstream_without_downstream;
    int tcp_mss;
    int outgoing_tcp_mss;

    char* ssl_service_key;
    char* ssl_service_pem;
    int ssl_port;
    int ssl_upstream;
    char* tls_cert_bundle;
    int tls_win_cert;
    struct config_strlist* tls_additional_port;

    int outgoing_num_ports;
    size_t outgoing_num_tcp;
    size_t incoming_num_tcp;
    int* outgoing_avail_ports;

    size_t edns_buffer_size;
    size_t msg_buffer_size;
    size_t msg_cache_size;
    size_t msg_cache_slabs;
    size_t num_queries_per_thread;
    size_t jostle_time;
    size_t rrset_cache_size;
    size_t rrset_cache_slabs;
    int host_ttl;
    size_t infra_cache_slabs;
    size_t infra_cache_numhosts;
    int infra_cache_min_rtt;
    int delay_close;

    char* target_fetch_policy;
    int low_rtt_permil;
    int low_rtt;

    int if_automatic;
    size_t so_rcvbuf;
    size_t so_sndbuf;
    int so_reuseport;
    int ip_transparent;
    int ip_freebind;

    int num_ifs;
    char **ifs;

    int num_out_ifs;
    char **out_ifs;

    struct config_strlist* root_hints;
    struct config_stub* stubs;
    struct config_stub* forwards;
    struct config_auth* auths;
    struct config_view* views;
    struct config_strlist* donotqueryaddrs;
#ifdef CLIENT_SUBNET
    struct config_strlist* client_subnet;
    struct config_strlist* client_subnet_zone;
    uint16_t client_subnet_opcode;
    int client_subnet_always_forward;
    uint8_t max_client_subnet_ipv4;
    uint8_t max_client_subnet_ipv6;
#endif
    struct config_str2list* acls;
    int donotquery_localhost;

    int harden_short_bufsize;
    int harden_large_queries;
    int harden_glue;
    int harden_dnssec_stripped;
    int harden_below_nxdomain;
    int harden_referral_path;
    int harden_algo_downgrade;
    int use_caps_bits_for_id;
    struct config_strlist* caps_whitelist;
    struct config_strlist* private_address;
    struct config_strlist* private_domain;
    size_t unwanted_threshold;
    int max_ttl;
    int min_ttl;
    int max_negative_ttl;
    int prefetch;
    int prefetch_key;

    char* chrootdir;
    char* username;
    char* directory;
    char* logfile;
    char* pidfile;

    int use_syslog;
    int log_time_ascii;
    int log_queries;
    int log_replies;
    char* log_identity;

    int hide_identity;
    int hide_version;
    int hide_trustanchor;
    char* identity;
    char* version;

    char* module_conf;
    
    struct config_strlist* trust_anchor_file_list;
    struct config_strlist* trust_anchor_list;
    struct config_strlist* auto_trust_anchor_file_list;
    struct config_strlist* trusted_keys_file_list;
    char* dlv_anchor_file;
    struct config_strlist* dlv_anchor_list;
    struct config_strlist* domain_insecure;
    int trust_anchor_signaling;
    int root_key_sentinel;

    int32_t val_date_override;
    int32_t val_sig_skew_min;
    int32_t val_sig_skew_max;
    int bogus_ttl; 
    int val_clean_additional;
    int val_log_level;
    int val_log_squelch;
    int val_permissive_mode;
    int aggressive_nsec;
    int ignore_cd;
    int serve_expired;
    char* val_nsec3_key_iterations;
    unsigned int add_holddown;
    unsigned int del_holddown;
    unsigned int keep_missing;
    int permit_small_holddown;

    size_t key_cache_size;
    size_t key_cache_slabs;
    size_t neg_cache_size;

    struct config_str2list* local_zones;
    struct config_strlist* local_zones_nodefault;
    int local_zones_disable_default;
    struct config_strlist* local_data;
    struct config_str3list* local_zone_overrides;
    int unblock_lan_zones;
    int insecure_lan_zones;
    struct config_strbytelist* local_zone_tags;
    struct config_strbytelist* acl_tags;
    struct config_str3list* acl_tag_actions;
    struct config_str3list* acl_tag_datas;
    struct config_str2list* acl_view;
    struct config_strbytelist* respip_tags;
    struct config_str2list* respip_actions;
    struct config_str2list* respip_data;
    char** tagname;
    int num_tags;

    int remote_control_enable;
    struct config_strlist_head control_ifs;
    int control_use_cert;
    int control_port;
    char* server_key_file;
    char* server_cert_file;
    char* control_key_file;
    char* control_cert_file;

    char* python_script;

    int use_systemd;

    int do_daemonize;
 
    /* minimal response when positive answer */
    int minimal_responses;
 
    /* RRSet roundrobin */
    int rrset_roundrobin;
 
    /* maximum UDP response size */
    size_t max_udp_size;
 
    /* DNS64 prefix */
    char* dns64_prefix;
 
    /* Synthetize all AAAA record despite the presence of an authoritative one */
    int dns64_synthall;

    int dnstap;
    char* dnstap_socket_path;
    int dnstap_send_identity;
    int dnstap_send_version;
    char* dnstap_identity;
    char* dnstap_version;

    int dnstap_log_resolver_query_messages;
    int dnstap_log_resolver_response_messages;
    int dnstap_log_client_query_messages;
    int dnstap_log_client_response_messages;
    int dnstap_log_forwarder_query_messages;
    int dnstap_log_forwarder_response_messages;

    int disable_dnssec_lame_check;

    int ip_ratelimit;
    size_t ip_ratelimit_slabs;
    size_t ip_ratelimit_size;
    int ip_ratelimit_factor;

    int ratelimit;
    size_t ratelimit_slabs;
    size_t ratelimit_size;
    struct config_str2list* ratelimit_for_domain;
    struct config_str2list* ratelimit_below_domain;
    int ratelimit_factor;
    int qname_minimisation;
    int qname_minimisation_strict;
    int shm_enable;
    int shm_key;

    int dnscrypt;
    int dnscrypt_port;
    char* dnscrypt_provider;
    struct config_strlist* dnscrypt_secret_key;
    struct config_strlist* dnscrypt_provider_cert;
    struct config_strlist* dnscrypt_provider_cert_rotated;
    size_t dnscrypt_shared_secret_cache_size;
    size_t dnscrypt_shared_secret_cache_slabs;
    size_t dnscrypt_nonce_cache_size;
    size_t dnscrypt_nonce_cache_slabs;
#ifdef USE_IPSECMOD
    int ipsecmod_enabled;
    struct config_strlist* ipsecmod_whitelist;
    char* ipsecmod_hook;
    int ipsecmod_ignore_bogus;
    int ipsecmod_max_ttl;
    int ipsecmod_strict;
#endif
 
    /* cachedb module */
#ifdef USE_CACHEDB
    char* cachedb_backend;
    char* cachedb_secret;
#ifdef USE_REDIS
    char* redis_server_host;
    int redis_server_port;
    int redis_timeout;
#endif
#endif
};

extern uid_t cfg_uid;
extern gid_t cfg_gid;
extern int autr_permit_small_holddown;

struct config_stub {
    struct config_stub* next;
    char* name;
    struct config_strlist* hosts;
    struct config_strlist* addrs;
    int isprime;
    int isfirst;
    int ssl_upstream;
};

struct config_auth {
    struct config_auth* next;
    char* name;
    struct config_strlist* masters;
    struct config_strlist* urls;
    struct config_strlist* allow_notify;
    char* zonefile;
    int for_downstream;
    int for_upstream;
    int fallback_enabled;
};

struct config_view {
    struct config_view* next;
    char* name;
    struct config_str2list* local_zones;
    struct config_strlist* local_data;
    struct config_strlist* local_zones_nodefault;   
    int isfirst;
    struct config_str2list* respip_actions;
    struct config_str2list* respip_data;
};

struct config_strlist {
    struct config_strlist* next;
    char* str;
};

struct config_str2list {
    struct config_str2list* next;
    char* str;
    char* str2;
};

struct config_str3list {
    struct config_str3list* next;
    char* str;
    char* str2;
    char* str3;
};
 

struct config_strbytelist {
    struct config_strbytelist* next;
    char* str;
    uint8_t* str2;
    size_t str2len;
};

struct config_file* config_create(void);

struct config_file* config_create_forlib(void);

int config_read(struct config_file* config, const char* filename,
    const char* chroot);

void config_delete(struct config_file* config);

void config_apply(struct config_file* config);

void config_lookup_uid(struct config_file* config);

int config_set_option(struct config_file* config, const char* option,
    const char* value);

int config_get_option(struct config_file* cfg, const char* opt, 
    void (*func)(char*,void*), void* arg);

int config_get_option_list(struct config_file* cfg, const char* opt,
    struct config_strlist** list);

int config_get_option_collate(struct config_file* cfg, const char* opt, 
    char** str);

void config_print_func(char* line, void* arg);

void config_collate_func(char* line, void* arg);

char* config_collate_cat(struct config_strlist* list);

int cfg_strlist_append(struct config_strlist_head* list, char* item);

struct config_strlist* cfg_strlist_find(struct config_strlist* head,
    const char* item);

int cfg_strlist_insert(struct config_strlist** head, char* item);

int cfg_region_strlist_insert(struct regional* region,
    struct config_strlist** head, char* item);

int cfg_str2list_insert(struct config_str2list** head, char* item, char* i2);

int cfg_str3list_insert(struct config_str3list** head, char* item, char* i2,
    char* i3);

int cfg_strbytelist_insert(struct config_strbytelist** head, char* item,
    uint8_t* i2, size_t i2len);

struct config_stub* cfg_stub_find(struct config_stub*** pp, const char* nm);

void config_delstrlist(struct config_strlist* list);

void config_deldblstrlist(struct config_str2list* list);

void config_deltrplstrlist(struct config_str3list* list);

void config_del_strbytelist(struct config_strbytelist* list);

void config_delstub(struct config_stub* p);

void config_delstubs(struct config_stub* list);

void config_delauth(struct config_auth* p);

void config_delauths(struct config_auth* list);

void config_delview(struct config_view* p);

void config_delviews(struct config_view* list);

int options_remote_is_address(struct config_file* cfg);

time_t cfg_convert_timeval(const char* str);

int cfg_count_numbers(const char* str);

int cfg_parse_memsize(const char* str, size_t* res);

int config_add_tag(struct config_file* cfg, const char* tag);

int find_tag_id(struct config_file* cfg, const char* tag);

uint8_t* config_parse_taglist(struct config_file* cfg, char* str,
    size_t* listlen);

char* config_taglist2str(struct config_file* cfg, uint8_t* taglist,
    size_t len);

int taglist_intersect(uint8_t* list1, size_t list1len, uint8_t* list2,
    size_t list2len);

int cfg_parse_local_zone(struct config_file* cfg, const char* val);

int cfg_mark_ports(const char* str, int allow, int* avail, int num);

int cfg_condense_ports(struct config_file* cfg, int** avail);

int cfg_scan_ports(int* avail, int num);

char* fname_after_chroot(const char* fname, struct config_file* cfg, 
    int use_chdir);

char* cfg_ptr_reverse(char* str);

void errinf(struct module_qstate* qstate, const char* str);

void errinf_origin(struct module_qstate* qstate, struct sock_list *origin);

void errinf_rrset(struct module_qstate* qstate, struct ub_packed_rrset_key *rr);

void errinf_dname(struct module_qstate* qstate, const char* str, 
    uint8_t* dname);

char* errinf_to_str(struct module_qstate* qstate);

struct config_parser_state {
    char* filename;
    int line;
    int errors;
    struct config_file* cfg;
    const char* chroot;
};

extern struct config_parser_state* cfg_parser;
void init_cfg_parse(void);
extern FILE* ub_c_in;
extern FILE* ub_c_out;
int ub_c_parse(void);
int ub_c_lex(void);
int ub_c_wrap(void);
void ub_c_error(const char* msg);
void ub_c_error_msg(const char* fmt, ...) ATTR_FORMAT(printf, 1, 2);
 
#ifdef UB_ON_WINDOWS
char* w_lookup_reg_str(const char* key, const char* name);

void w_config_adjust_directory(struct config_file* cfg);
#endif /* UB_ON_WINDOWS */

extern int fake_dsa, fake_sha1;
 
#endif /* UTIL_CONFIG_FILE_H */