1b7579f77SDag-Erling Smørgrav /* 2b7579f77SDag-Erling Smørgrav * util/config_file.h - reads and stores the config file for unbound. 3b7579f77SDag-Erling Smørgrav * 4b7579f77SDag-Erling Smørgrav * Copyright (c) 2007, NLnet Labs. All rights reserved. 5b7579f77SDag-Erling Smørgrav * 6b7579f77SDag-Erling Smørgrav * This software is open source. 7b7579f77SDag-Erling Smørgrav * 8b7579f77SDag-Erling Smørgrav * Redistribution and use in source and binary forms, with or without 9b7579f77SDag-Erling Smørgrav * modification, are permitted provided that the following conditions 10b7579f77SDag-Erling Smørgrav * are met: 11b7579f77SDag-Erling Smørgrav * 12b7579f77SDag-Erling Smørgrav * Redistributions of source code must retain the above copyright notice, 13b7579f77SDag-Erling Smørgrav * this list of conditions and the following disclaimer. 14b7579f77SDag-Erling Smørgrav * 15b7579f77SDag-Erling Smørgrav * Redistributions in binary form must reproduce the above copyright notice, 16b7579f77SDag-Erling Smørgrav * this list of conditions and the following disclaimer in the documentation 17b7579f77SDag-Erling Smørgrav * and/or other materials provided with the distribution. 18b7579f77SDag-Erling Smørgrav * 19b7579f77SDag-Erling Smørgrav * Neither the name of the NLNET LABS nor the names of its contributors may 20b7579f77SDag-Erling Smørgrav * be used to endorse or promote products derived from this software without 21b7579f77SDag-Erling Smørgrav * specific prior written permission. 22b7579f77SDag-Erling Smørgrav * 23b7579f77SDag-Erling Smørgrav * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2417d15b25SDag-Erling Smørgrav * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2517d15b25SDag-Erling Smørgrav * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2617d15b25SDag-Erling Smørgrav * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2717d15b25SDag-Erling Smørgrav * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2817d15b25SDag-Erling Smørgrav * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 2917d15b25SDag-Erling Smørgrav * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 3017d15b25SDag-Erling Smørgrav * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 3117d15b25SDag-Erling Smørgrav * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 3217d15b25SDag-Erling Smørgrav * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3317d15b25SDag-Erling Smørgrav * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34b7579f77SDag-Erling Smørgrav */ 35b7579f77SDag-Erling Smørgrav 36b7579f77SDag-Erling Smørgrav /** 37b7579f77SDag-Erling Smørgrav * \file 38b7579f77SDag-Erling Smørgrav * 39b7579f77SDag-Erling Smørgrav * This file contains functions for the config file. 40b7579f77SDag-Erling Smørgrav */ 41b7579f77SDag-Erling Smørgrav 42b7579f77SDag-Erling Smørgrav #ifndef UTIL_CONFIG_FILE_H 43b7579f77SDag-Erling Smørgrav #define UTIL_CONFIG_FILE_H 44a39a5a69SCy Schubert #include "sldns/rrdef.h" 45b7579f77SDag-Erling Smørgrav struct config_stub; 4657bddd21SDag-Erling Smørgrav struct config_auth; 47bc892140SDag-Erling Smørgrav struct config_view; 48b7579f77SDag-Erling Smørgrav struct config_strlist; 49b7579f77SDag-Erling Smørgrav struct config_str2list; 50b5663de9SDag-Erling Smørgrav struct config_str3list; 51e2d15004SDag-Erling Smørgrav struct config_strbytelist; 52b7579f77SDag-Erling Smørgrav struct module_qstate; 53b7579f77SDag-Erling Smørgrav struct sock_list; 54b7579f77SDag-Erling Smørgrav struct ub_packed_rrset_key; 55b5663de9SDag-Erling Smørgrav struct regional; 56b7579f77SDag-Erling Smørgrav 577da0adf7SDag-Erling Smørgrav /** List head for strlist processing, used for append operation. */ 587da0adf7SDag-Erling Smørgrav struct config_strlist_head { 597da0adf7SDag-Erling Smørgrav /** first in list of text items */ 607da0adf7SDag-Erling Smørgrav struct config_strlist* first; 617da0adf7SDag-Erling Smørgrav /** last in list of text items */ 627da0adf7SDag-Erling Smørgrav struct config_strlist* last; 637da0adf7SDag-Erling Smørgrav }; 647da0adf7SDag-Erling Smørgrav 65b7579f77SDag-Erling Smørgrav /** 66b7579f77SDag-Erling Smørgrav * The configuration options. 67b7579f77SDag-Erling Smørgrav * Strings are malloced. 68b7579f77SDag-Erling Smørgrav */ 69b7579f77SDag-Erling Smørgrav struct config_file { 70b7579f77SDag-Erling Smørgrav /** verbosity level as specified in the config file */ 71b7579f77SDag-Erling Smørgrav int verbosity; 72b7579f77SDag-Erling Smørgrav 73b7579f77SDag-Erling Smørgrav /** statistics interval (in seconds) */ 74b7579f77SDag-Erling Smørgrav int stat_interval; 75b7579f77SDag-Erling Smørgrav /** if false, statistics values are reset after printing them */ 76b7579f77SDag-Erling Smørgrav int stat_cumulative; 77b7579f77SDag-Erling Smørgrav /** if true, the statistics are kept in greater detail */ 78b7579f77SDag-Erling Smørgrav int stat_extended; 791838dec3SCy Schubert /** if true, inhibits a lot of =0 lines from the extended stats output */ 801838dec3SCy Schubert int stat_inhibit_zero; 81b7579f77SDag-Erling Smørgrav 82b7579f77SDag-Erling Smørgrav /** number of threads to create */ 83b7579f77SDag-Erling Smørgrav int num_threads; 84b7579f77SDag-Erling Smørgrav 85b7579f77SDag-Erling Smørgrav /** port on which queries are answered. */ 86b7579f77SDag-Erling Smørgrav int port; 87b7579f77SDag-Erling Smørgrav /** do ip4 query support. */ 88b7579f77SDag-Erling Smørgrav int do_ip4; 89b7579f77SDag-Erling Smørgrav /** do ip6 query support. */ 90b7579f77SDag-Erling Smørgrav int do_ip6; 918f76bb7dSCy Schubert /** do nat64 on queries */ 928f76bb7dSCy Schubert int do_nat64; 9325039b37SCy Schubert /** prefer ip4 upstream queries. */ 9425039b37SCy Schubert int prefer_ip4; 95b5663de9SDag-Erling Smørgrav /** prefer ip6 upstream queries. */ 96b5663de9SDag-Erling Smørgrav int prefer_ip6; 97b7579f77SDag-Erling Smørgrav /** do udp query support. */ 98b7579f77SDag-Erling Smørgrav int do_udp; 99b7579f77SDag-Erling Smørgrav /** do tcp query support. */ 100b7579f77SDag-Erling Smørgrav int do_tcp; 1015469a995SCy Schubert /** max number of queries on a reuse connection. */ 1025469a995SCy Schubert size_t max_reuse_tcp_queries; 1035469a995SCy Schubert /** timeout for REUSE entries in milliseconds. */ 1045469a995SCy Schubert int tcp_reuse_timeout; 1055469a995SCy Schubert /** timeout in milliseconds for TCP queries to auth servers. */ 1065469a995SCy Schubert int tcp_auth_query_timeout; 107b7579f77SDag-Erling Smørgrav /** tcp upstream queries (no UDP upstream queries) */ 108b7579f77SDag-Erling Smørgrav int tcp_upstream; 1098a384985SDag-Erling Smørgrav /** udp upstream enabled when no UDP downstream is enabled (do_udp no)*/ 1108a384985SDag-Erling Smørgrav int udp_upstream_without_downstream; 111f61ef7f6SDag-Erling Smørgrav /** maximum segment size of tcp socket which queries are answered */ 112f61ef7f6SDag-Erling Smørgrav int tcp_mss; 113f61ef7f6SDag-Erling Smørgrav /** maximum segment size of tcp socket for outgoing queries */ 114f61ef7f6SDag-Erling Smørgrav int outgoing_tcp_mss; 1154c75e3aaSDag-Erling Smørgrav /** tcp idle timeout, in msec */ 1164c75e3aaSDag-Erling Smørgrav int tcp_idle_timeout; 1174c75e3aaSDag-Erling Smørgrav /** do edns tcp keepalive */ 1184c75e3aaSDag-Erling Smørgrav int do_tcp_keepalive; 1194c75e3aaSDag-Erling Smørgrav /** tcp keepalive timeout, in msec */ 1204c75e3aaSDag-Erling Smørgrav int tcp_keepalive_timeout; 1218f76bb7dSCy Schubert /** timeout of packets sitting in the socket queue */ 1228f76bb7dSCy Schubert int sock_queue_timeout; 123865f46b2SCy Schubert /** proxy protocol ports */ 124865f46b2SCy Schubert struct config_strlist* proxy_protocol_port; 125b7579f77SDag-Erling Smørgrav 126b7579f77SDag-Erling Smørgrav /** private key file for dnstcp-ssl service (enabled if not NULL) */ 127b7579f77SDag-Erling Smørgrav char* ssl_service_key; 128b7579f77SDag-Erling Smørgrav /** public key file for dnstcp-ssl service */ 129b7579f77SDag-Erling Smørgrav char* ssl_service_pem; 130b7579f77SDag-Erling Smørgrav /** port on which to provide ssl service */ 131b7579f77SDag-Erling Smørgrav int ssl_port; 132b7579f77SDag-Erling Smørgrav /** if outgoing tcp connections use SSL */ 133b7579f77SDag-Erling Smørgrav int ssl_upstream; 13457bddd21SDag-Erling Smørgrav /** cert bundle for outgoing connections */ 13557bddd21SDag-Erling Smørgrav char* tls_cert_bundle; 1363bd4df0aSDag-Erling Smørgrav /** should the system certificate store get added to the cert bundle */ 1373bd4df0aSDag-Erling Smørgrav int tls_win_cert; 1380fb34990SDag-Erling Smørgrav /** additional tls ports */ 1397da0adf7SDag-Erling Smørgrav struct config_strlist* tls_additional_port; 140e86b9096SDag-Erling Smørgrav /** secret key used to encrypt and decrypt TLS session ticket */ 141e86b9096SDag-Erling Smørgrav struct config_strlist_head tls_session_ticket_keys; 142e86b9096SDag-Erling Smørgrav /** TLS ciphers */ 143e86b9096SDag-Erling Smørgrav char* tls_ciphers; 144e86b9096SDag-Erling Smørgrav /** TLS chiphersuites (TLSv1.3) */ 145e86b9096SDag-Erling Smørgrav char* tls_ciphersuites; 14625039b37SCy Schubert /** if SNI is to be used */ 14725039b37SCy Schubert int tls_use_sni; 148b7579f77SDag-Erling Smørgrav 149c0caa2e2SCy Schubert /** port on which to provide DNS over HTTPS service */ 150c0caa2e2SCy Schubert int https_port; 151c0caa2e2SCy Schubert /** endpoint for HTTP service */ 152c0caa2e2SCy Schubert char* http_endpoint; 153c0caa2e2SCy Schubert /** MAX_CONCURRENT_STREAMS HTTP/2 setting */ 154c0caa2e2SCy Schubert uint32_t http_max_streams; 155c0caa2e2SCy Schubert /** maximum size of all HTTP2 query buffers combined. */ 156c0caa2e2SCy Schubert size_t http_query_buffer_size; 157c0caa2e2SCy Schubert /** maximum size of all HTTP2 response buffers combined. */ 158c0caa2e2SCy Schubert size_t http_response_buffer_size; 159c0caa2e2SCy Schubert /** set TCP_NODELAY option for http sockets */ 160c0caa2e2SCy Schubert int http_nodelay; 161369c6923SCy Schubert /** Disable TLS for http sockets downstream */ 162369c6923SCy Schubert int http_notls_downstream; 163c0caa2e2SCy Schubert 164b7579f77SDag-Erling Smørgrav /** outgoing port range number of ports (per thread) */ 165b7579f77SDag-Erling Smørgrav int outgoing_num_ports; 166b7579f77SDag-Erling Smørgrav /** number of outgoing tcp buffers per (per thread) */ 167b7579f77SDag-Erling Smørgrav size_t outgoing_num_tcp; 168b7579f77SDag-Erling Smørgrav /** number of incoming tcp buffers per (per thread) */ 169b7579f77SDag-Erling Smørgrav size_t incoming_num_tcp; 170b7579f77SDag-Erling Smørgrav /** allowed udp port numbers, array with 0 if not allowed */ 171b7579f77SDag-Erling Smørgrav int* outgoing_avail_ports; 172b7579f77SDag-Erling Smørgrav 173b7579f77SDag-Erling Smørgrav /** EDNS buffer size to use */ 174b7579f77SDag-Erling Smørgrav size_t edns_buffer_size; 175e86b9096SDag-Erling Smørgrav /** size of the stream wait buffers, max */ 176e86b9096SDag-Erling Smørgrav size_t stream_wait_size; 177b7579f77SDag-Erling Smørgrav /** number of bytes buffer size for DNS messages */ 178b7579f77SDag-Erling Smørgrav size_t msg_buffer_size; 179b7579f77SDag-Erling Smørgrav /** size of the message cache */ 180b7579f77SDag-Erling Smørgrav size_t msg_cache_size; 181b7579f77SDag-Erling Smørgrav /** slabs in the message cache. */ 182b7579f77SDag-Erling Smørgrav size_t msg_cache_slabs; 183b7579f77SDag-Erling Smørgrav /** number of queries every thread can service */ 184b7579f77SDag-Erling Smørgrav size_t num_queries_per_thread; 185b7579f77SDag-Erling Smørgrav /** number of msec to wait before items can be jostled out */ 186b7579f77SDag-Erling Smørgrav size_t jostle_time; 187b7579f77SDag-Erling Smørgrav /** size of the rrset cache */ 188b7579f77SDag-Erling Smørgrav size_t rrset_cache_size; 189b7579f77SDag-Erling Smørgrav /** slabs in the rrset cache */ 190b7579f77SDag-Erling Smørgrav size_t rrset_cache_slabs; 191b7579f77SDag-Erling Smørgrav /** host cache ttl in seconds */ 192b7579f77SDag-Erling Smørgrav int host_ttl; 193b7579f77SDag-Erling Smørgrav /** number of slabs in the infra host cache */ 194b7579f77SDag-Erling Smørgrav size_t infra_cache_slabs; 195b7579f77SDag-Erling Smørgrav /** max number of hosts in the infra cache */ 196b7579f77SDag-Erling Smørgrav size_t infra_cache_numhosts; 197790c6b24SCy Schubert /** min value for infra cache rtt (min retransmit timeout) */ 1986480faa8SDag-Erling Smørgrav int infra_cache_min_rtt; 199790c6b24SCy Schubert /** max value for infra cache rtt (max retransmit timeout) */ 200790c6b24SCy Schubert int infra_cache_max_rtt; 201369c6923SCy Schubert /** keep probing hosts that are down */ 202369c6923SCy Schubert int infra_keep_probing; 20317d15b25SDag-Erling Smørgrav /** delay close of udp-timeouted ports, if 0 no delayclose. in msec */ 20417d15b25SDag-Erling Smørgrav int delay_close; 205369c6923SCy Schubert /** udp_connect enable uses UDP connect to mitigate ICMP side channel */ 206369c6923SCy Schubert int udp_connect; 207b7579f77SDag-Erling Smørgrav 208b7579f77SDag-Erling Smørgrav /** the target fetch policy for the iterator */ 209b7579f77SDag-Erling Smørgrav char* target_fetch_policy; 210e86b9096SDag-Erling Smørgrav /** percent*10, how many times in 1000 to pick from the fastest 211e86b9096SDag-Erling Smørgrav * destinations */ 212e86b9096SDag-Erling Smørgrav int fast_server_permil; 213e86b9096SDag-Erling Smørgrav /** number of fastest server to select from */ 214e86b9096SDag-Erling Smørgrav size_t fast_server_num; 215b7579f77SDag-Erling Smørgrav 216b7579f77SDag-Erling Smørgrav /** automatic interface for incoming messages. Uses ipv6 remapping, 217b7579f77SDag-Erling Smørgrav * and recvmsg/sendmsg ancillary data to detect interfaces, boolean */ 218b7579f77SDag-Erling Smørgrav int if_automatic; 219a39a5a69SCy Schubert /** extra ports to open if if_automatic enabled, or NULL for default */ 220a39a5a69SCy Schubert char* if_automatic_ports; 221b7579f77SDag-Erling Smørgrav /** SO_RCVBUF size to set on port 53 UDP socket */ 222b7579f77SDag-Erling Smørgrav size_t so_rcvbuf; 223b7579f77SDag-Erling Smørgrav /** SO_SNDBUF size to set on port 53 UDP socket */ 224b7579f77SDag-Erling Smørgrav size_t so_sndbuf; 22517d15b25SDag-Erling Smørgrav /** SO_REUSEPORT requested on port 53 sockets */ 22617d15b25SDag-Erling Smørgrav int so_reuseport; 22709a3aaf3SDag-Erling Smørgrav /** IP_TRANSPARENT socket option requested on port 53 sockets */ 22809a3aaf3SDag-Erling Smørgrav int ip_transparent; 229e2d15004SDag-Erling Smørgrav /** IP_FREEBIND socket option request on port 53 sockets */ 230e2d15004SDag-Erling Smørgrav int ip_freebind; 23125039b37SCy Schubert /** IP_TOS socket option requested on port 53 sockets */ 23225039b37SCy Schubert int ip_dscp; 233b7579f77SDag-Erling Smørgrav 234b7579f77SDag-Erling Smørgrav /** number of interfaces to open. If 0 default all interfaces. */ 235b7579f77SDag-Erling Smørgrav int num_ifs; 236b7579f77SDag-Erling Smørgrav /** interface description strings (IP addresses) */ 237b7579f77SDag-Erling Smørgrav char **ifs; 238b7579f77SDag-Erling Smørgrav 239b7579f77SDag-Erling Smørgrav /** number of outgoing interfaces to open. 240b7579f77SDag-Erling Smørgrav * If 0 default all interfaces. */ 241b7579f77SDag-Erling Smørgrav int num_out_ifs; 242b7579f77SDag-Erling Smørgrav /** outgoing interface description strings (IP addresses) */ 243b7579f77SDag-Erling Smørgrav char **out_ifs; 244b7579f77SDag-Erling Smørgrav 245b7579f77SDag-Erling Smørgrav /** the root hints */ 246b7579f77SDag-Erling Smørgrav struct config_strlist* root_hints; 247b7579f77SDag-Erling Smørgrav /** the stub definitions, linked list */ 248b7579f77SDag-Erling Smørgrav struct config_stub* stubs; 249b7579f77SDag-Erling Smørgrav /** the forward zone definitions, linked list */ 250b7579f77SDag-Erling Smørgrav struct config_stub* forwards; 25157bddd21SDag-Erling Smørgrav /** the auth zone definitions, linked list */ 25257bddd21SDag-Erling Smørgrav struct config_auth* auths; 253bc892140SDag-Erling Smørgrav /** the views definitions, linked list */ 254bc892140SDag-Erling Smørgrav struct config_view* views; 255b7579f77SDag-Erling Smørgrav /** list of donotquery addresses, linked list */ 256b7579f77SDag-Erling Smørgrav struct config_strlist* donotqueryaddrs; 25765b390aaSDag-Erling Smørgrav #ifdef CLIENT_SUBNET 25865b390aaSDag-Erling Smørgrav /** list of servers we send edns-client-subnet option to and 25965b390aaSDag-Erling Smørgrav * accept option from, linked list */ 26065b390aaSDag-Erling Smørgrav struct config_strlist* client_subnet; 261c7f4d7adSDag-Erling Smørgrav /** list of zones we send edns-client-subnet option for */ 262c7f4d7adSDag-Erling Smørgrav struct config_strlist* client_subnet_zone; 26365b390aaSDag-Erling Smørgrav /** opcode assigned by IANA for edns0-client-subnet option */ 26465b390aaSDag-Erling Smørgrav uint16_t client_subnet_opcode; 26565b390aaSDag-Erling Smørgrav /** Do not check whitelist if incoming query contains an ECS record */ 26665b390aaSDag-Erling Smørgrav int client_subnet_always_forward; 26765b390aaSDag-Erling Smørgrav /** Subnet length we are willing to give up privacy for */ 26865b390aaSDag-Erling Smørgrav uint8_t max_client_subnet_ipv4; 26965b390aaSDag-Erling Smørgrav uint8_t max_client_subnet_ipv6; 270e86b9096SDag-Erling Smørgrav /** Minimum subnet length we are willing to answer */ 271e86b9096SDag-Erling Smørgrav uint8_t min_client_subnet_ipv4; 272e86b9096SDag-Erling Smørgrav uint8_t min_client_subnet_ipv6; 273e86b9096SDag-Erling Smørgrav /** Max number of nodes in the ECS radix tree */ 274e86b9096SDag-Erling Smørgrav uint32_t max_ecs_tree_size_ipv4; 275e86b9096SDag-Erling Smørgrav uint32_t max_ecs_tree_size_ipv6; 27665b390aaSDag-Erling Smørgrav #endif 277b7579f77SDag-Erling Smørgrav /** list of access control entries, linked list */ 278b7579f77SDag-Erling Smørgrav struct config_str2list* acls; 279b7579f77SDag-Erling Smørgrav /** use default localhost donotqueryaddr entries */ 280b7579f77SDag-Erling Smørgrav int donotquery_localhost; 281b7579f77SDag-Erling Smørgrav 2824c75e3aaSDag-Erling Smørgrav /** list of tcp connection limitss, linked list */ 2834c75e3aaSDag-Erling Smørgrav struct config_str2list* tcp_connection_limits; 2844c75e3aaSDag-Erling Smørgrav 285b7579f77SDag-Erling Smørgrav /** harden against very small edns buffer sizes */ 286b7579f77SDag-Erling Smørgrav int harden_short_bufsize; 287b7579f77SDag-Erling Smørgrav /** harden against very large query sizes */ 288b7579f77SDag-Erling Smørgrav int harden_large_queries; 289b7579f77SDag-Erling Smørgrav /** harden against spoofed glue (out of zone data) */ 290b7579f77SDag-Erling Smørgrav int harden_glue; 291b7579f77SDag-Erling Smørgrav /** harden against receiving no DNSSEC data for trust anchor */ 292b7579f77SDag-Erling Smørgrav int harden_dnssec_stripped; 293b7579f77SDag-Erling Smørgrav /** harden against queries that fall under known nxdomain names */ 294b7579f77SDag-Erling Smørgrav int harden_below_nxdomain; 295b7579f77SDag-Erling Smørgrav /** harden the referral path, query for NS,A,AAAA and validate */ 296b7579f77SDag-Erling Smørgrav int harden_referral_path; 29709a3aaf3SDag-Erling Smørgrav /** harden against algorithm downgrade */ 29809a3aaf3SDag-Erling Smørgrav int harden_algo_downgrade; 2998f76bb7dSCy Schubert /** harden against unknown records in the authority section and in 3008f76bb7dSCy Schubert * the additional section */ 3018f76bb7dSCy Schubert int harden_unknown_additional; 302b7579f77SDag-Erling Smørgrav /** use 0x20 bits in query as random ID bits */ 303b7579f77SDag-Erling Smørgrav int use_caps_bits_for_id; 30409a3aaf3SDag-Erling Smørgrav /** 0x20 whitelist, domains that do not use capsforid */ 30509a3aaf3SDag-Erling Smørgrav struct config_strlist* caps_whitelist; 306b7579f77SDag-Erling Smørgrav /** strip away these private addrs from answers, no DNS Rebinding */ 307b7579f77SDag-Erling Smørgrav struct config_strlist* private_address; 308b7579f77SDag-Erling Smørgrav /** allow domain (and subdomains) to use private address space */ 309b7579f77SDag-Erling Smørgrav struct config_strlist* private_domain; 310b7579f77SDag-Erling Smørgrav /** what threshold for unwanted action. */ 311b7579f77SDag-Erling Smørgrav size_t unwanted_threshold; 312b7579f77SDag-Erling Smørgrav /** the number of seconds maximal TTL used for RRsets and messages */ 313b7579f77SDag-Erling Smørgrav int max_ttl; 314b7579f77SDag-Erling Smørgrav /** the number of seconds minimum TTL used for RRsets and messages */ 315b7579f77SDag-Erling Smørgrav int min_ttl; 31609a3aaf3SDag-Erling Smørgrav /** the number of seconds maximal negative TTL for SOA in auth */ 31709a3aaf3SDag-Erling Smørgrav int max_negative_ttl; 318*335c7cdaSCy Schubert /** the number of seconds minimal negative TTL for SOA in auth */ 319*335c7cdaSCy Schubert int min_negative_ttl; 320b7579f77SDag-Erling Smørgrav /** if prefetching of messages should be performed. */ 321b7579f77SDag-Erling Smørgrav int prefetch; 322b7579f77SDag-Erling Smørgrav /** if prefetching of DNSKEYs should be performed. */ 323b7579f77SDag-Erling Smørgrav int prefetch_key; 324e86b9096SDag-Erling Smørgrav /** deny queries of type ANY with an empty answer */ 325e86b9096SDag-Erling Smørgrav int deny_any; 326b7579f77SDag-Erling Smørgrav 327b7579f77SDag-Erling Smørgrav /** chrootdir, if not "" or chroot will be done */ 328b7579f77SDag-Erling Smørgrav char* chrootdir; 329b7579f77SDag-Erling Smørgrav /** username to change to, if not "". */ 330b7579f77SDag-Erling Smørgrav char* username; 331b7579f77SDag-Erling Smørgrav /** working directory */ 332b7579f77SDag-Erling Smørgrav char* directory; 333b7579f77SDag-Erling Smørgrav /** filename to log to. */ 334b7579f77SDag-Erling Smørgrav char* logfile; 335b7579f77SDag-Erling Smørgrav /** pidfile to write pid to. */ 336b7579f77SDag-Erling Smørgrav char* pidfile; 337b7579f77SDag-Erling Smørgrav 338b7579f77SDag-Erling Smørgrav /** should log messages be sent to syslogd */ 339b7579f77SDag-Erling Smørgrav int use_syslog; 340b7579f77SDag-Erling Smørgrav /** log timestamp in ascii UTC */ 341b7579f77SDag-Erling Smørgrav int log_time_ascii; 342b7579f77SDag-Erling Smørgrav /** log queries with one line per query */ 343b7579f77SDag-Erling Smørgrav int log_queries; 3443005e0a3SDag-Erling Smørgrav /** log replies with one line per reply */ 3453005e0a3SDag-Erling Smørgrav int log_replies; 346e86b9096SDag-Erling Smørgrav /** tag log_queries and log_replies for filtering */ 347e86b9096SDag-Erling Smørgrav int log_tag_queryreply; 3484c75e3aaSDag-Erling Smørgrav /** log every local-zone hit **/ 3494c75e3aaSDag-Erling Smørgrav int log_local_actions; 3504c75e3aaSDag-Erling Smørgrav /** log servfails with a reason */ 3514c75e3aaSDag-Erling Smørgrav int log_servfail; 352bc892140SDag-Erling Smørgrav /** log identity to report */ 353bc892140SDag-Erling Smørgrav char* log_identity; 354b7c0c8c1SCy Schubert /** log dest addr for log_replies */ 355b7c0c8c1SCy Schubert int log_destaddr; 356b7579f77SDag-Erling Smørgrav 357b7579f77SDag-Erling Smørgrav /** do not report identity (id.server, hostname.bind) */ 358b7579f77SDag-Erling Smørgrav int hide_identity; 359b7579f77SDag-Erling Smørgrav /** do not report version (version.server, version.bind) */ 360b7579f77SDag-Erling Smørgrav int hide_version; 36165b390aaSDag-Erling Smørgrav /** do not report trustanchor (trustanchor.unbound) */ 36265b390aaSDag-Erling Smørgrav int hide_trustanchor; 3635469a995SCy Schubert /** do not report the User-Agent HTTP header */ 3645469a995SCy Schubert int hide_http_user_agent; 365b7579f77SDag-Erling Smørgrav /** identity, hostname is returned if "". */ 366b7579f77SDag-Erling Smørgrav char* identity; 367b7579f77SDag-Erling Smørgrav /** version, package version returned if "". */ 368b7579f77SDag-Erling Smørgrav char* version; 3695469a995SCy Schubert /** User-Agent for HTTP header */ 3705469a995SCy Schubert char* http_user_agent; 371f44e67d1SCy Schubert /** nsid */ 372f44e67d1SCy Schubert char *nsid_cfg_str; 373f44e67d1SCy Schubert uint8_t *nsid; 374f44e67d1SCy Schubert uint16_t nsid_len; 375b7579f77SDag-Erling Smørgrav 376b7579f77SDag-Erling Smørgrav /** the module configuration string */ 377b7579f77SDag-Erling Smørgrav char* module_conf; 378b7579f77SDag-Erling Smørgrav 379b7579f77SDag-Erling Smørgrav /** files with trusted DS and DNSKEYs in zonefile format, list */ 380b7579f77SDag-Erling Smørgrav struct config_strlist* trust_anchor_file_list; 381b7579f77SDag-Erling Smørgrav /** list of trustanchor keys, linked list */ 382b7579f77SDag-Erling Smørgrav struct config_strlist* trust_anchor_list; 383b7579f77SDag-Erling Smørgrav /** files with 5011 autotrust tracked keys */ 384b7579f77SDag-Erling Smørgrav struct config_strlist* auto_trust_anchor_file_list; 385b7579f77SDag-Erling Smørgrav /** files with trusted DNSKEYs in named.conf format, list */ 386b7579f77SDag-Erling Smørgrav struct config_strlist* trusted_keys_file_list; 387b7579f77SDag-Erling Smørgrav /** insecure domain list */ 388b7579f77SDag-Erling Smørgrav struct config_strlist* domain_insecure; 389c7f4d7adSDag-Erling Smørgrav /** send key tag query */ 390c7f4d7adSDag-Erling Smørgrav int trust_anchor_signaling; 3910fb34990SDag-Erling Smørgrav /** enable root key sentinel */ 3920fb34990SDag-Erling Smørgrav int root_key_sentinel; 393b7579f77SDag-Erling Smørgrav 394b7579f77SDag-Erling Smørgrav /** if not 0, this value is the validation date for RRSIGs */ 395b7579f77SDag-Erling Smørgrav int32_t val_date_override; 396b7579f77SDag-Erling Smørgrav /** the minimum for signature clock skew */ 397b7579f77SDag-Erling Smørgrav int32_t val_sig_skew_min; 398b7579f77SDag-Erling Smørgrav /** the maximum for signature clock skew */ 399b7579f77SDag-Erling Smørgrav int32_t val_sig_skew_max; 4005469a995SCy Schubert /** max number of query restarts, number of IPs to probe */ 4015469a995SCy Schubert int32_t val_max_restart; 402b7579f77SDag-Erling Smørgrav /** this value sets the number of seconds before revalidating bogus */ 403b7579f77SDag-Erling Smørgrav int bogus_ttl; 404b7579f77SDag-Erling Smørgrav /** should validator clean additional section for secure msgs */ 405b7579f77SDag-Erling Smørgrav int val_clean_additional; 406b7579f77SDag-Erling Smørgrav /** log bogus messages by the validator */ 407b7579f77SDag-Erling Smørgrav int val_log_level; 408b7579f77SDag-Erling Smørgrav /** squelch val_log_level to log - this is library goes to callback */ 409b7579f77SDag-Erling Smørgrav int val_log_squelch; 410b7579f77SDag-Erling Smørgrav /** should validator allow bogus messages to go through */ 411b7579f77SDag-Erling Smørgrav int val_permissive_mode; 41257bddd21SDag-Erling Smørgrav /** use cached NSEC records to synthesise (negative) answers */ 41357bddd21SDag-Erling Smørgrav int aggressive_nsec; 414b7579f77SDag-Erling Smørgrav /** ignore the CD flag in incoming queries and refuse them bogus data */ 415b7579f77SDag-Erling Smørgrav int ignore_cd; 416103ba509SCy Schubert /** disable EDNS DO flag in outgoing requests */ 417103ba509SCy Schubert int disable_edns_do; 418bc892140SDag-Erling Smørgrav /** serve expired entries and prefetch them */ 419bc892140SDag-Erling Smørgrav int serve_expired; 4204c75e3aaSDag-Erling Smørgrav /** serve expired entries until TTL after expiration */ 4214c75e3aaSDag-Erling Smørgrav int serve_expired_ttl; 4224c75e3aaSDag-Erling Smørgrav /** reset serve expired TTL after failed update attempt */ 4234c75e3aaSDag-Erling Smørgrav int serve_expired_ttl_reset; 424091e9e46SCy Schubert /** TTL for the serve expired replies */ 425091e9e46SCy Schubert int serve_expired_reply_ttl; 426091e9e46SCy Schubert /** serve expired entries only after trying to update the entries and this 427091e9e46SCy Schubert * timeout (in milliseconds) is reached */ 428091e9e46SCy Schubert int serve_expired_client_timeout; 429a39a5a69SCy Schubert /** serve EDE code 3 - Stale Answer (RFC8914) for expired entries */ 430a39a5a69SCy Schubert int ede_serve_expired; 431f44e67d1SCy Schubert /** serve original TTLs rather than decrementing ones */ 432f44e67d1SCy Schubert int serve_original_ttl; 433b7579f77SDag-Erling Smørgrav /** nsec3 maximum iterations per key size, string */ 434b7579f77SDag-Erling Smørgrav char* val_nsec3_key_iterations; 4355469a995SCy Schubert /** if zonemd failures are permitted, only logged */ 4365469a995SCy Schubert int zonemd_permissive_mode; 437b7579f77SDag-Erling Smørgrav /** autotrust add holddown time, in seconds */ 438b7579f77SDag-Erling Smørgrav unsigned int add_holddown; 439b7579f77SDag-Erling Smørgrav /** autotrust del holddown time, in seconds */ 440b7579f77SDag-Erling Smørgrav unsigned int del_holddown; 441b7579f77SDag-Erling Smørgrav /** autotrust keep_missing time, in seconds. 0 is forever. */ 442b7579f77SDag-Erling Smørgrav unsigned int keep_missing; 443b75612f8SDag-Erling Smørgrav /** permit small holddown values, allowing 5011 rollover very fast */ 444b75612f8SDag-Erling Smørgrav int permit_small_holddown; 445b7579f77SDag-Erling Smørgrav 446b7579f77SDag-Erling Smørgrav /** size of the key cache */ 447b7579f77SDag-Erling Smørgrav size_t key_cache_size; 448b7579f77SDag-Erling Smørgrav /** slabs in the key cache. */ 449b7579f77SDag-Erling Smørgrav size_t key_cache_slabs; 450b7579f77SDag-Erling Smørgrav /** size of the neg cache */ 451b7579f77SDag-Erling Smørgrav size_t neg_cache_size; 452b7579f77SDag-Erling Smørgrav 453b7579f77SDag-Erling Smørgrav /** local zones config */ 454b7579f77SDag-Erling Smørgrav struct config_str2list* local_zones; 455b7579f77SDag-Erling Smørgrav /** local zones nodefault list */ 456b7579f77SDag-Erling Smørgrav struct config_strlist* local_zones_nodefault; 4570eefd307SCy Schubert #ifdef USE_IPSET 4580eefd307SCy Schubert /** local zones ipset list */ 4590eefd307SCy Schubert struct config_strlist* local_zones_ipset; 4600eefd307SCy Schubert #endif 461c7f4d7adSDag-Erling Smørgrav /** do not add any default local zone */ 462c7f4d7adSDag-Erling Smørgrav int local_zones_disable_default; 46305ab2901SDag-Erling Smørgrav /** local data RRs configured */ 464b7579f77SDag-Erling Smørgrav struct config_strlist* local_data; 465b5663de9SDag-Erling Smørgrav /** local zone override types per netblock */ 466b5663de9SDag-Erling Smørgrav struct config_str3list* local_zone_overrides; 4670de4f1bfSDag-Erling Smørgrav /** unblock lan zones (reverse lookups for AS112 zones) */ 468c536e4dcSDag-Erling Smørgrav int unblock_lan_zones; 4690de4f1bfSDag-Erling Smørgrav /** insecure lan zones (don't validate AS112 zones) */ 4700de4f1bfSDag-Erling Smørgrav int insecure_lan_zones; 471e2d15004SDag-Erling Smørgrav /** list of zonename, tagbitlist */ 472e2d15004SDag-Erling Smørgrav struct config_strbytelist* local_zone_tags; 473b5663de9SDag-Erling Smørgrav /** list of aclname, tagbitlist */ 474b5663de9SDag-Erling Smørgrav struct config_strbytelist* acl_tags; 475b5663de9SDag-Erling Smørgrav /** list of aclname, tagname, localzonetype */ 476b5663de9SDag-Erling Smørgrav struct config_str3list* acl_tag_actions; 477b5663de9SDag-Erling Smørgrav /** list of aclname, tagname, redirectdata */ 478b5663de9SDag-Erling Smørgrav struct config_str3list* acl_tag_datas; 479bc892140SDag-Erling Smørgrav /** list of aclname, view*/ 480bc892140SDag-Erling Smørgrav struct config_str2list* acl_view; 481865f46b2SCy Schubert /** list of interface action entries, linked list */ 482865f46b2SCy Schubert struct config_str2list* interface_actions; 483865f46b2SCy Schubert /** list of interface, tagbitlist */ 484865f46b2SCy Schubert struct config_strbytelist* interface_tags; 485865f46b2SCy Schubert /** list of interface, tagname, localzonetype */ 486865f46b2SCy Schubert struct config_str3list* interface_tag_actions; 487865f46b2SCy Schubert /** list of interface, tagname, redirectdata */ 488865f46b2SCy Schubert struct config_str3list* interface_tag_datas; 489865f46b2SCy Schubert /** list of interface, view*/ 490865f46b2SCy Schubert struct config_str2list* interface_view; 49165b390aaSDag-Erling Smørgrav /** list of IP-netblock, tagbitlist */ 49265b390aaSDag-Erling Smørgrav struct config_strbytelist* respip_tags; 49365b390aaSDag-Erling Smørgrav /** list of response-driven access control entries, linked list */ 49465b390aaSDag-Erling Smørgrav struct config_str2list* respip_actions; 49565b390aaSDag-Erling Smørgrav /** RRs configured for response-driven access controls */ 49665b390aaSDag-Erling Smørgrav struct config_str2list* respip_data; 497e2d15004SDag-Erling Smørgrav /** tag list, array with tagname[i] is malloced string */ 498e2d15004SDag-Erling Smørgrav char** tagname; 499e2d15004SDag-Erling Smørgrav /** number of items in the taglist */ 500e2d15004SDag-Erling Smørgrav int num_tags; 501b7579f77SDag-Erling Smørgrav 502b7579f77SDag-Erling Smørgrav /** remote control section. enable toggle. */ 503b7579f77SDag-Erling Smørgrav int remote_control_enable; 504b7579f77SDag-Erling Smørgrav /** the interfaces the remote control should listen on */ 5057da0adf7SDag-Erling Smørgrav struct config_strlist_head control_ifs; 5067da0adf7SDag-Erling Smørgrav /** if the use-cert option is set */ 5077da0adf7SDag-Erling Smørgrav int control_use_cert; 508b7579f77SDag-Erling Smørgrav /** port number for the control port */ 509b7579f77SDag-Erling Smørgrav int control_port; 510b7579f77SDag-Erling Smørgrav /** private key file for server */ 511b7579f77SDag-Erling Smørgrav char* server_key_file; 512b7579f77SDag-Erling Smørgrav /** certificate file for server */ 513b7579f77SDag-Erling Smørgrav char* server_cert_file; 514b7579f77SDag-Erling Smørgrav /** private key file for unbound-control */ 515b7579f77SDag-Erling Smørgrav char* control_key_file; 516b7579f77SDag-Erling Smørgrav /** certificate file for unbound-control */ 517b7579f77SDag-Erling Smørgrav char* control_cert_file; 518b7579f77SDag-Erling Smørgrav 519b7579f77SDag-Erling Smørgrav /** Python script file */ 5200eefd307SCy Schubert struct config_strlist* python_script; 521b7579f77SDag-Erling Smørgrav 52225039b37SCy Schubert /** Dynamic library file */ 52325039b37SCy Schubert struct config_strlist* dynlib_file; 52425039b37SCy Schubert 5253005e0a3SDag-Erling Smørgrav /** Use systemd socket activation. */ 5263005e0a3SDag-Erling Smørgrav int use_systemd; 5273005e0a3SDag-Erling Smørgrav 528b7579f77SDag-Erling Smørgrav /** daemonize, i.e. fork into the background. */ 529b7579f77SDag-Erling Smørgrav int do_daemonize; 530b7579f77SDag-Erling Smørgrav 531b7579f77SDag-Erling Smørgrav /* minimal response when positive answer */ 532b7579f77SDag-Erling Smørgrav int minimal_responses; 533b7579f77SDag-Erling Smørgrav 534b7579f77SDag-Erling Smørgrav /* RRSet roundrobin */ 535b7579f77SDag-Erling Smørgrav int rrset_roundrobin; 53617d15b25SDag-Erling Smørgrav 537e86b9096SDag-Erling Smørgrav /* wait time for unknown server in msec */ 538e86b9096SDag-Erling Smørgrav int unknown_server_time_limit; 539e86b9096SDag-Erling Smørgrav 540*335c7cdaSCy Schubert /** Wait time to drop recursion replies */ 541*335c7cdaSCy Schubert int discard_timeout; 542*335c7cdaSCy Schubert 543*335c7cdaSCy Schubert /** Wait limit for number of replies per IP address */ 544*335c7cdaSCy Schubert int wait_limit; 545*335c7cdaSCy Schubert 546*335c7cdaSCy Schubert /** Wait limit for number of replies per IP address with cookie */ 547*335c7cdaSCy Schubert int wait_limit_cookie; 548*335c7cdaSCy Schubert 549*335c7cdaSCy Schubert /** wait limit per netblock */ 550*335c7cdaSCy Schubert struct config_str2list* wait_limit_netblock; 551*335c7cdaSCy Schubert 552*335c7cdaSCy Schubert /** wait limit with cookie per netblock */ 553*335c7cdaSCy Schubert struct config_str2list* wait_limit_cookie_netblock; 554*335c7cdaSCy Schubert 55517d15b25SDag-Erling Smørgrav /* maximum UDP response size */ 55617d15b25SDag-Erling Smørgrav size_t max_udp_size; 557ff825849SDag-Erling Smørgrav 558ff825849SDag-Erling Smørgrav /* DNS64 prefix */ 559ff825849SDag-Erling Smørgrav char* dns64_prefix; 560ff825849SDag-Erling Smørgrav 561ff825849SDag-Erling Smørgrav /* Synthetize all AAAA record despite the presence of an authoritative one */ 562ff825849SDag-Erling Smørgrav int dns64_synthall; 5634c75e3aaSDag-Erling Smørgrav /** ignore AAAAs for these domain names and use A record anyway */ 5644c75e3aaSDag-Erling Smørgrav struct config_strlist* dns64_ignore_aaaa; 565ff825849SDag-Erling Smørgrav 5668f76bb7dSCy Schubert /* NAT64 prefix; if unset defaults to dns64_prefix */ 5678f76bb7dSCy Schubert char* nat64_prefix; 5688f76bb7dSCy Schubert 569ff825849SDag-Erling Smørgrav /** true to enable dnstap support */ 570ff825849SDag-Erling Smørgrav int dnstap; 57125039b37SCy Schubert /** using bidirectional frame streams if true */ 57225039b37SCy Schubert int dnstap_bidirectional; 573ff825849SDag-Erling Smørgrav /** dnstap socket path */ 574ff825849SDag-Erling Smørgrav char* dnstap_socket_path; 57525039b37SCy Schubert /** dnstap IP */ 57625039b37SCy Schubert char* dnstap_ip; 57725039b37SCy Schubert /** dnstap TLS enable */ 57825039b37SCy Schubert int dnstap_tls; 57925039b37SCy Schubert /** dnstap tls server authentication name */ 58025039b37SCy Schubert char* dnstap_tls_server_name; 58125039b37SCy Schubert /** dnstap server cert bundle */ 58225039b37SCy Schubert char* dnstap_tls_cert_bundle; 58325039b37SCy Schubert /** dnstap client key for client authentication */ 58425039b37SCy Schubert char* dnstap_tls_client_key_file; 58525039b37SCy Schubert /** dnstap client cert for client authentication */ 58625039b37SCy Schubert char* dnstap_tls_client_cert_file; 587ff825849SDag-Erling Smørgrav /** true to send "identity" via dnstap */ 588ff825849SDag-Erling Smørgrav int dnstap_send_identity; 589ff825849SDag-Erling Smørgrav /** true to send "version" via dnstap */ 590ff825849SDag-Erling Smørgrav int dnstap_send_version; 591ff825849SDag-Erling Smørgrav /** dnstap "identity", hostname is used if "". */ 592ff825849SDag-Erling Smørgrav char* dnstap_identity; 593ff825849SDag-Erling Smørgrav /** dnstap "version", package version is used if "". */ 594ff825849SDag-Erling Smørgrav char* dnstap_version; 595ff825849SDag-Erling Smørgrav 596ff825849SDag-Erling Smørgrav /** true to log dnstap RESOLVER_QUERY message events */ 597ff825849SDag-Erling Smørgrav int dnstap_log_resolver_query_messages; 598ff825849SDag-Erling Smørgrav /** true to log dnstap RESOLVER_RESPONSE message events */ 599ff825849SDag-Erling Smørgrav int dnstap_log_resolver_response_messages; 600ff825849SDag-Erling Smørgrav /** true to log dnstap CLIENT_QUERY message events */ 601ff825849SDag-Erling Smørgrav int dnstap_log_client_query_messages; 602ff825849SDag-Erling Smørgrav /** true to log dnstap CLIENT_RESPONSE message events */ 603ff825849SDag-Erling Smørgrav int dnstap_log_client_response_messages; 604ff825849SDag-Erling Smørgrav /** true to log dnstap FORWARDER_QUERY message events */ 605ff825849SDag-Erling Smørgrav int dnstap_log_forwarder_query_messages; 606ff825849SDag-Erling Smørgrav /** true to log dnstap FORWARDER_RESPONSE message events */ 607ff825849SDag-Erling Smørgrav int dnstap_log_forwarder_response_messages; 60809a3aaf3SDag-Erling Smørgrav 609e2d15004SDag-Erling Smørgrav /** true to disable DNSSEC lameness check in iterator */ 610e2d15004SDag-Erling Smørgrav int disable_dnssec_lame_check; 611e2d15004SDag-Erling Smørgrav 6123005e0a3SDag-Erling Smørgrav /** ratelimit for ip addresses. 0 is off, otherwise qps (unless overridden) */ 6133005e0a3SDag-Erling Smørgrav int ip_ratelimit; 6148f76bb7dSCy Schubert /** ratelimit for ip addresses with a valid DNS Cookie. 0 is off, 6158f76bb7dSCy Schubert * otherwise qps (unless overridden) */ 6168f76bb7dSCy Schubert int ip_ratelimit_cookie; 6173005e0a3SDag-Erling Smørgrav /** number of slabs for ip_ratelimit cache */ 6183005e0a3SDag-Erling Smørgrav size_t ip_ratelimit_slabs; 6193005e0a3SDag-Erling Smørgrav /** memory size in bytes for ip_ratelimit cache */ 6203005e0a3SDag-Erling Smørgrav size_t ip_ratelimit_size; 6213005e0a3SDag-Erling Smørgrav /** ip_ratelimit factor, 0 blocks all, 10 allows 1/10 of traffic */ 6223005e0a3SDag-Erling Smørgrav int ip_ratelimit_factor; 6239cf5bc93SCy Schubert /** ratelimit backoff, when on, if the limit is reached it is 6249cf5bc93SCy Schubert * considered an attack and it backs off until 'demand' decreases over 6259cf5bc93SCy Schubert * the RATE_WINDOW. */ 6269cf5bc93SCy Schubert int ip_ratelimit_backoff; 6273005e0a3SDag-Erling Smørgrav 6283005e0a3SDag-Erling Smørgrav /** ratelimit for domains. 0 is off, otherwise qps (unless overridden) */ 62909a3aaf3SDag-Erling Smørgrav int ratelimit; 63009a3aaf3SDag-Erling Smørgrav /** number of slabs for ratelimit cache */ 63109a3aaf3SDag-Erling Smørgrav size_t ratelimit_slabs; 63209a3aaf3SDag-Erling Smørgrav /** memory size in bytes for ratelimit cache */ 63309a3aaf3SDag-Erling Smørgrav size_t ratelimit_size; 63409a3aaf3SDag-Erling Smørgrav /** ratelimits for domain (exact match) */ 63509a3aaf3SDag-Erling Smørgrav struct config_str2list* ratelimit_for_domain; 63609a3aaf3SDag-Erling Smørgrav /** ratelimits below domain */ 63709a3aaf3SDag-Erling Smørgrav struct config_str2list* ratelimit_below_domain; 63809a3aaf3SDag-Erling Smørgrav /** ratelimit factor, 0 blocks all, 10 allows 1/10 of traffic */ 63909a3aaf3SDag-Erling Smørgrav int ratelimit_factor; 6409cf5bc93SCy Schubert /** ratelimit backoff, when on, if the limit is reached it is 6419cf5bc93SCy Schubert * considered an attack and it backs off until 'demand' decreases over 6429cf5bc93SCy Schubert * the RATE_WINDOW. */ 6439cf5bc93SCy Schubert int ratelimit_backoff; 6449cf5bc93SCy Schubert 64524e36522SCy Schubert /** number of retries on outgoing queries */ 64624e36522SCy Schubert int outbound_msg_retry; 6471838dec3SCy Schubert /** max sent queries per qstate; resets on query restarts (e.g., 6481838dec3SCy Schubert * CNAMES) and referrals */ 6491838dec3SCy Schubert int max_sent_count; 6501838dec3SCy Schubert /** max number of query restarts; determines max length of CNAME chain */ 6511838dec3SCy Schubert int max_query_restarts; 65205ab2901SDag-Erling Smørgrav /** minimise outgoing QNAME and hide original QTYPE if possible */ 65305ab2901SDag-Erling Smørgrav int qname_minimisation; 654bc892140SDag-Erling Smørgrav /** minimise QNAME in strict mode, minimise according to RFC. 655bc892140SDag-Erling Smørgrav * Do not apply fallback */ 656bc892140SDag-Erling Smørgrav int qname_minimisation_strict; 65765b390aaSDag-Erling Smørgrav /** SHM data - true if shm is enabled */ 65865b390aaSDag-Erling Smørgrav int shm_enable; 65965b390aaSDag-Erling Smørgrav /** SHM data - key for the shm */ 66065b390aaSDag-Erling Smørgrav int shm_key; 66165b390aaSDag-Erling Smørgrav 662369c6923SCy Schubert /** list of EDNS client string entries, linked list */ 663369c6923SCy Schubert struct config_str2list* edns_client_strings; 664369c6923SCy Schubert /** EDNS opcode to use for EDNS client strings */ 665369c6923SCy Schubert uint16_t edns_client_string_opcode; 666c0caa2e2SCy Schubert 66765b390aaSDag-Erling Smørgrav /** DNSCrypt */ 66865b390aaSDag-Erling Smørgrav /** true to enable dnscrypt */ 66965b390aaSDag-Erling Smørgrav int dnscrypt; 67065b390aaSDag-Erling Smørgrav /** port on which to provide dnscrypt service */ 67165b390aaSDag-Erling Smørgrav int dnscrypt_port; 67265b390aaSDag-Erling Smørgrav /** provider name 2.dnscrypt-cert.example.com */ 67365b390aaSDag-Erling Smørgrav char* dnscrypt_provider; 67465b390aaSDag-Erling Smørgrav /** dnscrypt secret keys 1.key */ 67565b390aaSDag-Erling Smørgrav struct config_strlist* dnscrypt_secret_key; 67665b390aaSDag-Erling Smørgrav /** dnscrypt provider certs 1.cert */ 67765b390aaSDag-Erling Smørgrav struct config_strlist* dnscrypt_provider_cert; 67857bddd21SDag-Erling Smørgrav /** dnscrypt provider certs 1.cert which have been rotated and should not be 67957bddd21SDag-Erling Smørgrav * advertised through DNS's providername TXT record but are required to be 68057bddd21SDag-Erling Smørgrav * able to handle existing traffic using the old cert. */ 68157bddd21SDag-Erling Smørgrav struct config_strlist* dnscrypt_provider_cert_rotated; 682971980c3SDag-Erling Smørgrav /** memory size in bytes for dnscrypt shared secrets cache */ 683971980c3SDag-Erling Smørgrav size_t dnscrypt_shared_secret_cache_size; 684971980c3SDag-Erling Smørgrav /** number of slabs for dnscrypt shared secrets cache */ 685971980c3SDag-Erling Smørgrav size_t dnscrypt_shared_secret_cache_slabs; 6868a384985SDag-Erling Smørgrav /** memory size in bytes for dnscrypt nonces cache */ 6878a384985SDag-Erling Smørgrav size_t dnscrypt_nonce_cache_size; 6888a384985SDag-Erling Smørgrav /** number of slabs for dnscrypt nonces cache */ 6898a384985SDag-Erling Smørgrav size_t dnscrypt_nonce_cache_slabs; 690f44e67d1SCy Schubert 691f44e67d1SCy Schubert /** EDNS padding according to RFC7830 and RFC8467 */ 692f44e67d1SCy Schubert /** true to enable padding of responses (default: on) */ 693f44e67d1SCy Schubert int pad_responses; 694f44e67d1SCy Schubert /** block size with which to pad encrypted responses (default: 468) */ 695f44e67d1SCy Schubert size_t pad_responses_block_size; 696f44e67d1SCy Schubert /** true to enable padding of queries (default: on) */ 697f44e67d1SCy Schubert int pad_queries; 698f44e67d1SCy Schubert /** block size with which to pad encrypted queries (default: 128) */ 699f44e67d1SCy Schubert size_t pad_queries_block_size; 700f44e67d1SCy Schubert 701c7f4d7adSDag-Erling Smørgrav /** IPsec module */ 702c7f4d7adSDag-Erling Smørgrav #ifdef USE_IPSECMOD 703c7f4d7adSDag-Erling Smørgrav /** false to bypass the IPsec module */ 704c7f4d7adSDag-Erling Smørgrav int ipsecmod_enabled; 705c7f4d7adSDag-Erling Smørgrav /** whitelisted domains for ipsecmod */ 706c7f4d7adSDag-Erling Smørgrav struct config_strlist* ipsecmod_whitelist; 707c7f4d7adSDag-Erling Smørgrav /** path to external hook */ 708c7f4d7adSDag-Erling Smørgrav char* ipsecmod_hook; 709c7f4d7adSDag-Erling Smørgrav /** true to proceed even with a bogus IPSECKEY */ 710c7f4d7adSDag-Erling Smørgrav int ipsecmod_ignore_bogus; 711c7f4d7adSDag-Erling Smørgrav /** max TTL for the A/AAAA records that call the hook */ 712c7f4d7adSDag-Erling Smørgrav int ipsecmod_max_ttl; 713c7f4d7adSDag-Erling Smørgrav /** false to proceed even when ipsecmod_hook fails */ 714c7f4d7adSDag-Erling Smørgrav int ipsecmod_strict; 715c7f4d7adSDag-Erling Smørgrav #endif 716971980c3SDag-Erling Smørgrav 717971980c3SDag-Erling Smørgrav /* cachedb module */ 718971980c3SDag-Erling Smørgrav #ifdef USE_CACHEDB 719971980c3SDag-Erling Smørgrav /** backend DB name */ 720971980c3SDag-Erling Smørgrav char* cachedb_backend; 721971980c3SDag-Erling Smørgrav /** secret seed for hash key calculation */ 722971980c3SDag-Erling Smørgrav char* cachedb_secret; 723103ba509SCy Schubert /** cachedb that does not store, but only reads from database, if on */ 724103ba509SCy Schubert int cachedb_no_store; 725*335c7cdaSCy Schubert /** cachedb check before serving serve-expired response */ 726*335c7cdaSCy Schubert int cachedb_check_when_serve_expired; 7270fb34990SDag-Erling Smørgrav #ifdef USE_REDIS 7280fb34990SDag-Erling Smørgrav /** redis server's IP address or host name */ 7290fb34990SDag-Erling Smørgrav char* redis_server_host; 7300fb34990SDag-Erling Smørgrav /** redis server's TCP port */ 7310fb34990SDag-Erling Smørgrav int redis_server_port; 7328f76bb7dSCy Schubert /** redis server's unix path. Or "", NULL if unused */ 7338f76bb7dSCy Schubert char* redis_server_path; 7348f76bb7dSCy Schubert /** redis server's AUTH password. Or "", NULL if unused */ 7358f76bb7dSCy Schubert char* redis_server_password; 7360fb34990SDag-Erling Smørgrav /** timeout (in ms) for communication with the redis server */ 7370fb34990SDag-Erling Smørgrav int redis_timeout; 73825039b37SCy Schubert /** set timeout on redis records based on DNS response ttl */ 73925039b37SCy Schubert int redis_expire_records; 740103ba509SCy Schubert /** set the redis logical database upon connection */ 741103ba509SCy Schubert int redis_logical_db; 7420fb34990SDag-Erling Smørgrav #endif 743971980c3SDag-Erling Smørgrav #endif 7448f76bb7dSCy Schubert /** Downstream DNS Cookies */ 7458f76bb7dSCy Schubert /** do answer with server cookie when request contained cookie option */ 7468f76bb7dSCy Schubert int do_answer_cookie; 7478f76bb7dSCy Schubert /** cookie secret */ 7488f76bb7dSCy Schubert uint8_t cookie_secret[40]; 7498f76bb7dSCy Schubert /** cookie secret length */ 7508f76bb7dSCy Schubert size_t cookie_secret_len; 7510eefd307SCy Schubert 7520eefd307SCy Schubert /* ipset module */ 7530eefd307SCy Schubert #ifdef USE_IPSET 7540eefd307SCy Schubert char* ipset_name_v4; 7550eefd307SCy Schubert char* ipset_name_v6; 7560eefd307SCy Schubert #endif 757a39a5a69SCy Schubert /** respond with Extended DNS Errors (RFC8914) */ 758a39a5a69SCy Schubert int ede; 759b7579f77SDag-Erling Smørgrav }; 760b7579f77SDag-Erling Smørgrav 7618a384985SDag-Erling Smørgrav /** from cfg username, after daemonize setup performed */ 7626480faa8SDag-Erling Smørgrav extern uid_t cfg_uid; 7638a384985SDag-Erling Smørgrav /** from cfg username, after daemonize setup performed */ 7646480faa8SDag-Erling Smørgrav extern gid_t cfg_gid; 765b75612f8SDag-Erling Smørgrav /** debug and enable small timeouts */ 766b75612f8SDag-Erling Smørgrav extern int autr_permit_small_holddown; 767e86b9096SDag-Erling Smørgrav /** size (in bytes) of stream wait buffers max */ 768e86b9096SDag-Erling Smørgrav extern size_t stream_wait_max; 769c0caa2e2SCy Schubert /** size (in bytes) of all total HTTP2 query buffers max */ 770c0caa2e2SCy Schubert extern size_t http2_query_buffer_max; 771c0caa2e2SCy Schubert /** size (in bytes) of all total HTTP2 response buffers max */ 772c0caa2e2SCy Schubert extern size_t http2_response_buffer_max; 7736480faa8SDag-Erling Smørgrav 774b7579f77SDag-Erling Smørgrav /** 775b7579f77SDag-Erling Smørgrav * Stub config options 776b7579f77SDag-Erling Smørgrav */ 777b7579f77SDag-Erling Smørgrav struct config_stub { 778b7579f77SDag-Erling Smørgrav /** next in list */ 779b7579f77SDag-Erling Smørgrav struct config_stub* next; 780b7579f77SDag-Erling Smørgrav /** domain name (in text) of the stub apex domain */ 781b7579f77SDag-Erling Smørgrav char* name; 782b7579f77SDag-Erling Smørgrav /** list of stub nameserver hosts (domain name) */ 783b7579f77SDag-Erling Smørgrav struct config_strlist* hosts; 784b7579f77SDag-Erling Smørgrav /** list of stub nameserver addresses (IP address) */ 785b7579f77SDag-Erling Smørgrav struct config_strlist* addrs; 786b7579f77SDag-Erling Smørgrav /** if stub-prime is set */ 787b7579f77SDag-Erling Smørgrav int isprime; 788b7579f77SDag-Erling Smørgrav /** if forward-first is set (failover to without if fails) */ 789b7579f77SDag-Erling Smørgrav int isfirst; 79024e36522SCy Schubert /** use tcp for queries to this stub */ 79124e36522SCy Schubert int tcp_upstream; 79265b390aaSDag-Erling Smørgrav /** use SSL for queries to this stub */ 793bc892140SDag-Erling Smørgrav int ssl_upstream; 7944c75e3aaSDag-Erling Smørgrav /*** no cache */ 7954c75e3aaSDag-Erling Smørgrav int no_cache; 796bc892140SDag-Erling Smørgrav }; 797bc892140SDag-Erling Smørgrav 798bc892140SDag-Erling Smørgrav /** 79957bddd21SDag-Erling Smørgrav * Auth config options 80057bddd21SDag-Erling Smørgrav */ 80157bddd21SDag-Erling Smørgrav struct config_auth { 80257bddd21SDag-Erling Smørgrav /** next in list */ 80357bddd21SDag-Erling Smørgrav struct config_auth* next; 80457bddd21SDag-Erling Smørgrav /** domain name (in text) of the auth apex domain */ 80557bddd21SDag-Erling Smørgrav char* name; 80657bddd21SDag-Erling Smørgrav /** list of masters */ 80757bddd21SDag-Erling Smørgrav struct config_strlist* masters; 80857bddd21SDag-Erling Smørgrav /** list of urls */ 80957bddd21SDag-Erling Smørgrav struct config_strlist* urls; 8100fb34990SDag-Erling Smørgrav /** list of allow-notify */ 8110fb34990SDag-Erling Smørgrav struct config_strlist* allow_notify; 81257bddd21SDag-Erling Smørgrav /** zonefile (or NULL) */ 81357bddd21SDag-Erling Smørgrav char* zonefile; 81457bddd21SDag-Erling Smørgrav /** provide downstream answers */ 81557bddd21SDag-Erling Smørgrav int for_downstream; 81657bddd21SDag-Erling Smørgrav /** provide upstream answers */ 81757bddd21SDag-Erling Smørgrav int for_upstream; 81857bddd21SDag-Erling Smørgrav /** fallback to recursion to authorities if zone expired and other 81957bddd21SDag-Erling Smørgrav * reasons perhaps (like, query bogus) */ 82057bddd21SDag-Erling Smørgrav int fallback_enabled; 821091e9e46SCy Schubert /** this zone is used to create local-zone policies */ 822091e9e46SCy Schubert int isrpz; 823091e9e46SCy Schubert /** rpz tags (or NULL) */ 824091e9e46SCy Schubert uint8_t* rpz_taglist; 825091e9e46SCy Schubert /** length of the taglist (in bytes) */ 826091e9e46SCy Schubert size_t rpz_taglistlen; 827091e9e46SCy Schubert /** Override RPZ action for this zone, regardless of zone content */ 828091e9e46SCy Schubert char* rpz_action_override; 829091e9e46SCy Schubert /** Log when this RPZ policy is applied */ 830091e9e46SCy Schubert int rpz_log; 831091e9e46SCy Schubert /** Display this name in the log when RPZ policy is applied */ 832091e9e46SCy Schubert char* rpz_log_name; 833091e9e46SCy Schubert /** Always reply with this CNAME target if the cname override action is 834091e9e46SCy Schubert * used */ 835091e9e46SCy Schubert char* rpz_cname; 8369cf5bc93SCy Schubert /** signal nxdomain block with unset RA */ 8379cf5bc93SCy Schubert int rpz_signal_nxdomain_ra; 8385469a995SCy Schubert /** Check ZONEMD records for this zone */ 8395469a995SCy Schubert int zonemd_check; 8405469a995SCy Schubert /** Reject absence of ZONEMD records, zone must have one */ 8415469a995SCy Schubert int zonemd_reject_absence; 84257bddd21SDag-Erling Smørgrav }; 84357bddd21SDag-Erling Smørgrav 84457bddd21SDag-Erling Smørgrav /** 845bc892140SDag-Erling Smørgrav * View config options 846bc892140SDag-Erling Smørgrav */ 847bc892140SDag-Erling Smørgrav struct config_view { 848bc892140SDag-Erling Smørgrav /** next in list */ 849bc892140SDag-Erling Smørgrav struct config_view* next; 850bc892140SDag-Erling Smørgrav /** view name */ 851bc892140SDag-Erling Smørgrav char* name; 852bc892140SDag-Erling Smørgrav /** local zones */ 853bc892140SDag-Erling Smørgrav struct config_str2list* local_zones; 854bc892140SDag-Erling Smørgrav /** local data RRs */ 855bc892140SDag-Erling Smørgrav struct config_strlist* local_data; 856bc892140SDag-Erling Smørgrav /** local zones nodefault list */ 857bc892140SDag-Erling Smørgrav struct config_strlist* local_zones_nodefault; 8580eefd307SCy Schubert #ifdef USE_IPSET 8590eefd307SCy Schubert /** local zones ipset list */ 8600eefd307SCy Schubert struct config_strlist* local_zones_ipset; 8610eefd307SCy Schubert #endif 862bc892140SDag-Erling Smørgrav /** Fallback to global local_zones when there is no match in the view 863bc892140SDag-Erling Smørgrav * view specific tree. 1 for yes, 0 for no */ 864bc892140SDag-Erling Smørgrav int isfirst; 86565b390aaSDag-Erling Smørgrav /** predefined actions for particular IP address responses */ 86665b390aaSDag-Erling Smørgrav struct config_str2list* respip_actions; 86765b390aaSDag-Erling Smørgrav /** data complementing the 'redirect' response IP actions */ 86865b390aaSDag-Erling Smørgrav struct config_str2list* respip_data; 869b7579f77SDag-Erling Smørgrav }; 870b7579f77SDag-Erling Smørgrav 871b7579f77SDag-Erling Smørgrav /** 872b7579f77SDag-Erling Smørgrav * List of strings for config options 873b7579f77SDag-Erling Smørgrav */ 874b7579f77SDag-Erling Smørgrav struct config_strlist { 875b7579f77SDag-Erling Smørgrav /** next item in list */ 876b7579f77SDag-Erling Smørgrav struct config_strlist* next; 877b7579f77SDag-Erling Smørgrav /** config option string */ 878b7579f77SDag-Erling Smørgrav char* str; 879b7579f77SDag-Erling Smørgrav }; 880b7579f77SDag-Erling Smørgrav 881b7579f77SDag-Erling Smørgrav /** 882b7579f77SDag-Erling Smørgrav * List of two strings for config options 883b7579f77SDag-Erling Smørgrav */ 884b7579f77SDag-Erling Smørgrav struct config_str2list { 885b7579f77SDag-Erling Smørgrav /** next item in list */ 886b7579f77SDag-Erling Smørgrav struct config_str2list* next; 887b7579f77SDag-Erling Smørgrav /** first string */ 888b7579f77SDag-Erling Smørgrav char* str; 889b7579f77SDag-Erling Smørgrav /** second string */ 890b7579f77SDag-Erling Smørgrav char* str2; 891b7579f77SDag-Erling Smørgrav }; 892b7579f77SDag-Erling Smørgrav 893e2d15004SDag-Erling Smørgrav /** 894b5663de9SDag-Erling Smørgrav * List of three strings for config options 895b5663de9SDag-Erling Smørgrav */ 896b5663de9SDag-Erling Smørgrav struct config_str3list { 897b5663de9SDag-Erling Smørgrav /** next item in list */ 898b5663de9SDag-Erling Smørgrav struct config_str3list* next; 899b5663de9SDag-Erling Smørgrav /** first string */ 900b5663de9SDag-Erling Smørgrav char* str; 901b5663de9SDag-Erling Smørgrav /** second string */ 902b5663de9SDag-Erling Smørgrav char* str2; 903b5663de9SDag-Erling Smørgrav /** third string */ 904b5663de9SDag-Erling Smørgrav char* str3; 905b5663de9SDag-Erling Smørgrav }; 906b5663de9SDag-Erling Smørgrav 907b5663de9SDag-Erling Smørgrav 908b5663de9SDag-Erling Smørgrav /** 909e2d15004SDag-Erling Smørgrav * List of string, bytestring for config options 910e2d15004SDag-Erling Smørgrav */ 911e2d15004SDag-Erling Smørgrav struct config_strbytelist { 912e2d15004SDag-Erling Smørgrav /** next item in list */ 913e2d15004SDag-Erling Smørgrav struct config_strbytelist* next; 914e2d15004SDag-Erling Smørgrav /** first string */ 915e2d15004SDag-Erling Smørgrav char* str; 916e2d15004SDag-Erling Smørgrav /** second bytestring */ 917e2d15004SDag-Erling Smørgrav uint8_t* str2; 918e2d15004SDag-Erling Smørgrav size_t str2len; 919e2d15004SDag-Erling Smørgrav }; 920e2d15004SDag-Erling Smørgrav 921b7579f77SDag-Erling Smørgrav /** 922b7579f77SDag-Erling Smørgrav * Create config file structure. Filled with default values. 923b7579f77SDag-Erling Smørgrav * @return: the new structure or NULL on memory error. 924b7579f77SDag-Erling Smørgrav */ 925b7579f77SDag-Erling Smørgrav struct config_file* config_create(void); 926b7579f77SDag-Erling Smørgrav 927b7579f77SDag-Erling Smørgrav /** 928b7579f77SDag-Erling Smørgrav * Create config file structure for library use. Filled with default values. 929b7579f77SDag-Erling Smørgrav * @return: the new structure or NULL on memory error. 930b7579f77SDag-Erling Smørgrav */ 931b7579f77SDag-Erling Smørgrav struct config_file* config_create_forlib(void); 932b7579f77SDag-Erling Smørgrav 933b7579f77SDag-Erling Smørgrav /** 934b7579f77SDag-Erling Smørgrav * Read the config file from the specified filename. 935b7579f77SDag-Erling Smørgrav * @param config: where options are stored into, must be freshly created. 936b7579f77SDag-Erling Smørgrav * @param filename: name of configfile. If NULL nothing is done. 937b7579f77SDag-Erling Smørgrav * @param chroot: if not NULL, the chroot dir currently in use (for include). 938b7579f77SDag-Erling Smørgrav * @return: false on error. In that case errno is set, ENOENT means 939b7579f77SDag-Erling Smørgrav * file not found. 940b7579f77SDag-Erling Smørgrav */ 941b7579f77SDag-Erling Smørgrav int config_read(struct config_file* config, const char* filename, 942b7579f77SDag-Erling Smørgrav const char* chroot); 943b7579f77SDag-Erling Smørgrav 944b7579f77SDag-Erling Smørgrav /** 945b7579f77SDag-Erling Smørgrav * Destroy the config file structure. 946b7579f77SDag-Erling Smørgrav * @param config: to delete. 947b7579f77SDag-Erling Smørgrav */ 948b7579f77SDag-Erling Smørgrav void config_delete(struct config_file* config); 949b7579f77SDag-Erling Smørgrav 950b7579f77SDag-Erling Smørgrav /** 951b7579f77SDag-Erling Smørgrav * Apply config to global constants; this routine is called in single thread. 952b7579f77SDag-Erling Smørgrav * @param config: to apply. Side effect: global constants change. 953b7579f77SDag-Erling Smørgrav */ 954b7579f77SDag-Erling Smørgrav void config_apply(struct config_file* config); 955b7579f77SDag-Erling Smørgrav 956b7579f77SDag-Erling Smørgrav /** 9576480faa8SDag-Erling Smørgrav * Find username, sets cfg_uid and cfg_gid. 958748bd829SDag-Erling Smørgrav * @param config: the config structure. 959748bd829SDag-Erling Smørgrav */ 960748bd829SDag-Erling Smørgrav void config_lookup_uid(struct config_file* config); 961748bd829SDag-Erling Smørgrav 962748bd829SDag-Erling Smørgrav /** 963b7579f77SDag-Erling Smørgrav * Set the given keyword to the given value. 964b7579f77SDag-Erling Smørgrav * @param config: where to store config 965b7579f77SDag-Erling Smørgrav * @param option: option name, including the ':' character. 966b7579f77SDag-Erling Smørgrav * @param value: value, this string is copied if needed, or parsed. 967b7579f77SDag-Erling Smørgrav * The caller owns the value string. 968b7579f77SDag-Erling Smørgrav * @return 0 on error (malloc or syntax error). 969b7579f77SDag-Erling Smørgrav */ 970b7579f77SDag-Erling Smørgrav int config_set_option(struct config_file* config, const char* option, 971b7579f77SDag-Erling Smørgrav const char* value); 972b7579f77SDag-Erling Smørgrav 973b7579f77SDag-Erling Smørgrav /** 974b7579f77SDag-Erling Smørgrav * Call print routine for the given option. 975b7579f77SDag-Erling Smørgrav * @param cfg: config. 976b7579f77SDag-Erling Smørgrav * @param opt: option name without trailing :. 977b7579f77SDag-Erling Smørgrav * This is different from config_set_option. 978b7579f77SDag-Erling Smørgrav * @param func: print func, called as (str, arg) for every data element. 979b7579f77SDag-Erling Smørgrav * @param arg: user argument for print func. 980b7579f77SDag-Erling Smørgrav * @return false if the option name is not supported (syntax error). 981b7579f77SDag-Erling Smørgrav */ 982b7579f77SDag-Erling Smørgrav int config_get_option(struct config_file* cfg, const char* opt, 983b7579f77SDag-Erling Smørgrav void (*func)(char*,void*), void* arg); 984b7579f77SDag-Erling Smørgrav 985b7579f77SDag-Erling Smørgrav /** 986b7579f77SDag-Erling Smørgrav * Get an option and return strlist 987b7579f77SDag-Erling Smørgrav * @param cfg: config file 988b7579f77SDag-Erling Smørgrav * @param opt: option name. 989b7579f77SDag-Erling Smørgrav * @param list: list is returned here. malloced, caller must free it. 990b7579f77SDag-Erling Smørgrav * @return 0=OK, 1=syntax error, 2=malloc failed. 991b7579f77SDag-Erling Smørgrav */ 992b7579f77SDag-Erling Smørgrav int config_get_option_list(struct config_file* cfg, const char* opt, 993b7579f77SDag-Erling Smørgrav struct config_strlist** list); 994b7579f77SDag-Erling Smørgrav 995b7579f77SDag-Erling Smørgrav /** 996b7579f77SDag-Erling Smørgrav * Get an option and collate results into string 997b7579f77SDag-Erling Smørgrav * @param cfg: config file 998b7579f77SDag-Erling Smørgrav * @param opt: option name. 999b7579f77SDag-Erling Smørgrav * @param str: string. malloced, caller must free it. 1000b7579f77SDag-Erling Smørgrav * @return 0=OK, 1=syntax error, 2=malloc failed. 1001b7579f77SDag-Erling Smørgrav */ 1002b7579f77SDag-Erling Smørgrav int config_get_option_collate(struct config_file* cfg, const char* opt, 1003b7579f77SDag-Erling Smørgrav char** str); 1004b7579f77SDag-Erling Smørgrav 1005b7579f77SDag-Erling Smørgrav /** 1006b7579f77SDag-Erling Smørgrav * function to print to a file, use as func with config_get_option. 1007b7579f77SDag-Erling Smørgrav * @param line: text to print. \n appended. 1008b7579f77SDag-Erling Smørgrav * @param arg: pass a FILE*, like stdout. 1009b7579f77SDag-Erling Smørgrav */ 1010b7579f77SDag-Erling Smørgrav void config_print_func(char* line, void* arg); 1011b7579f77SDag-Erling Smørgrav 1012b7579f77SDag-Erling Smørgrav /** 1013b7579f77SDag-Erling Smørgrav * function to collate the text strings into a strlist_head. 1014b7579f77SDag-Erling Smørgrav * @param line: text to append. 1015b7579f77SDag-Erling Smørgrav * @param arg: pass a strlist_head structure. zeroed on start. 1016b7579f77SDag-Erling Smørgrav */ 1017b7579f77SDag-Erling Smørgrav void config_collate_func(char* line, void* arg); 1018b7579f77SDag-Erling Smørgrav 1019b7579f77SDag-Erling Smørgrav /** 1020b7579f77SDag-Erling Smørgrav * take a strlist_head list and return a malloc string. separated with newline. 1021b7579f77SDag-Erling Smørgrav * @param list: strlist first to collate. zeroes return "". 1022b7579f77SDag-Erling Smørgrav * @return NULL on malloc failure. Or if malloc failure happened in strlist. 1023b7579f77SDag-Erling Smørgrav */ 1024b7579f77SDag-Erling Smørgrav char* config_collate_cat(struct config_strlist* list); 1025b7579f77SDag-Erling Smørgrav 1026b7579f77SDag-Erling Smørgrav /** 1027b7579f77SDag-Erling Smørgrav * Append text at end of list. 1028b7579f77SDag-Erling Smørgrav * @param list: list head. zeroed at start. 1029b7579f77SDag-Erling Smørgrav * @param item: new item. malloced by caller. if NULL the insertion fails. 1030b7579f77SDag-Erling Smørgrav * @return true on success. 1031a755b6f6SDag-Erling Smørgrav * on fail the item is free()ed. 1032b7579f77SDag-Erling Smørgrav */ 1033b7579f77SDag-Erling Smørgrav int cfg_strlist_append(struct config_strlist_head* list, char* item); 1034b7579f77SDag-Erling Smørgrav 1035b7579f77SDag-Erling Smørgrav /** 10360eefd307SCy Schubert * Searches the end of a string list and appends the given text. 10370eefd307SCy Schubert * @param head: pointer to strlist head variable. 10380eefd307SCy Schubert * @param item: new item. malloced by caller. if NULL the insertion fails. 10390eefd307SCy Schubert * @return true on success. 10400eefd307SCy Schubert */ 10410eefd307SCy Schubert int cfg_strlist_append_ex(struct config_strlist** head, char* item); 10420eefd307SCy Schubert 10430eefd307SCy Schubert /** 104457bddd21SDag-Erling Smørgrav * Find string in strlist. 104557bddd21SDag-Erling Smørgrav * @param head: pointer to strlist head variable. 104657bddd21SDag-Erling Smørgrav * @param item: the item to search for. 104757bddd21SDag-Erling Smørgrav * @return: the element in the list when found, NULL otherwise. 104857bddd21SDag-Erling Smørgrav */ 104957bddd21SDag-Erling Smørgrav struct config_strlist* cfg_strlist_find(struct config_strlist* head, 105057bddd21SDag-Erling Smørgrav const char* item); 105157bddd21SDag-Erling Smørgrav 105257bddd21SDag-Erling Smørgrav /** 1053b7579f77SDag-Erling Smørgrav * Insert string into strlist. 1054b7579f77SDag-Erling Smørgrav * @param head: pointer to strlist head variable. 1055b7579f77SDag-Erling Smørgrav * @param item: new item. malloced by caller. If NULL the insertion fails. 1056b7579f77SDag-Erling Smørgrav * @return: true on success. 1057a755b6f6SDag-Erling Smørgrav * on fail, the item is free()d. 1058b7579f77SDag-Erling Smørgrav */ 1059b7579f77SDag-Erling Smørgrav int cfg_strlist_insert(struct config_strlist** head, char* item); 1060b7579f77SDag-Erling Smørgrav 1061b5663de9SDag-Erling Smørgrav /** insert with region for allocation. */ 1062b5663de9SDag-Erling Smørgrav int cfg_region_strlist_insert(struct regional* region, 1063b5663de9SDag-Erling Smørgrav struct config_strlist** head, char* item); 1064b5663de9SDag-Erling Smørgrav 1065b7579f77SDag-Erling Smørgrav /** 1066b7579f77SDag-Erling Smørgrav * Insert string into str2list. 1067b7579f77SDag-Erling Smørgrav * @param head: pointer to str2list head variable. 1068b7579f77SDag-Erling Smørgrav * @param item: new item. malloced by caller. If NULL the insertion fails. 1069b7579f77SDag-Erling Smørgrav * @param i2: 2nd string, malloced by caller. If NULL the insertion fails. 1070b7579f77SDag-Erling Smørgrav * @return: true on success. 1071a755b6f6SDag-Erling Smørgrav * on fail, the item and i2 are free()d. 1072b7579f77SDag-Erling Smørgrav */ 1073b7579f77SDag-Erling Smørgrav int cfg_str2list_insert(struct config_str2list** head, char* item, char* i2); 1074b7579f77SDag-Erling Smørgrav 1075b7579f77SDag-Erling Smørgrav /** 1076b5663de9SDag-Erling Smørgrav * Insert string into str3list. 1077b5663de9SDag-Erling Smørgrav * @param head: pointer to str3list head variable. 1078b5663de9SDag-Erling Smørgrav * @param item: new item. malloced by caller. If NULL the insertion fails. 1079b5663de9SDag-Erling Smørgrav * @param i2: 2nd string, malloced by caller. If NULL the insertion fails. 1080b5663de9SDag-Erling Smørgrav * @param i3: 3rd string, malloced by caller. If NULL the insertion fails. 1081b5663de9SDag-Erling Smørgrav * @return: true on success. 1082b5663de9SDag-Erling Smørgrav */ 1083b5663de9SDag-Erling Smørgrav int cfg_str3list_insert(struct config_str3list** head, char* item, char* i2, 1084b5663de9SDag-Erling Smørgrav char* i3); 1085b5663de9SDag-Erling Smørgrav 1086b5663de9SDag-Erling Smørgrav /** 1087e2d15004SDag-Erling Smørgrav * Insert string into strbytelist. 1088b5663de9SDag-Erling Smørgrav * @param head: pointer to strbytelist head variable. 1089e2d15004SDag-Erling Smørgrav * @param item: new item. malloced by caller. If NULL the insertion fails. 1090e2d15004SDag-Erling Smørgrav * @param i2: 2nd string, malloced by caller. If NULL the insertion fails. 1091e2d15004SDag-Erling Smørgrav * @param i2len: length of the i2 bytestring. 1092e2d15004SDag-Erling Smørgrav * @return: true on success. 1093e2d15004SDag-Erling Smørgrav */ 1094e2d15004SDag-Erling Smørgrav int cfg_strbytelist_insert(struct config_strbytelist** head, char* item, 1095e2d15004SDag-Erling Smørgrav uint8_t* i2, size_t i2len); 1096e2d15004SDag-Erling Smørgrav 1097e2d15004SDag-Erling Smørgrav /** 1098f61ef7f6SDag-Erling Smørgrav * Find stub in config list, also returns prevptr (for deletion). 1099f61ef7f6SDag-Erling Smørgrav * @param pp: call routine with pointer to a pointer to the start of the list, 1100f61ef7f6SDag-Erling Smørgrav * if the stub is found, on exit, the value contains a pointer to the 1101f61ef7f6SDag-Erling Smørgrav * next pointer that points to the found element (or to the list start 1102f61ef7f6SDag-Erling Smørgrav * pointer if it is the first element). 1103f61ef7f6SDag-Erling Smørgrav * @param nm: name of stub to find. 1104f61ef7f6SDag-Erling Smørgrav * @return: pointer to config_stub if found, or NULL if not found. 1105f61ef7f6SDag-Erling Smørgrav */ 1106f61ef7f6SDag-Erling Smørgrav struct config_stub* cfg_stub_find(struct config_stub*** pp, const char* nm); 1107f61ef7f6SDag-Erling Smørgrav 1108f61ef7f6SDag-Erling Smørgrav /** 1109b7579f77SDag-Erling Smørgrav * Delete items in config string list. 1110b7579f77SDag-Erling Smørgrav * @param list: list. 1111b7579f77SDag-Erling Smørgrav */ 1112b7579f77SDag-Erling Smørgrav void config_delstrlist(struct config_strlist* list); 1113b7579f77SDag-Erling Smørgrav 1114b7579f77SDag-Erling Smørgrav /** 1115b7579f77SDag-Erling Smørgrav * Delete items in config double string list. 1116b7579f77SDag-Erling Smørgrav * @param list: list. 1117b7579f77SDag-Erling Smørgrav */ 1118b7579f77SDag-Erling Smørgrav void config_deldblstrlist(struct config_str2list* list); 1119b7579f77SDag-Erling Smørgrav 1120b7579f77SDag-Erling Smørgrav /** 1121b5663de9SDag-Erling Smørgrav * Delete items in config triple string list. 1122b5663de9SDag-Erling Smørgrav * @param list: list. 1123b5663de9SDag-Erling Smørgrav */ 1124b5663de9SDag-Erling Smørgrav void config_deltrplstrlist(struct config_str3list* list); 1125b5663de9SDag-Erling Smørgrav 1126c0caa2e2SCy Schubert /** delete string array */ 1127c0caa2e2SCy Schubert void config_del_strarray(char** array, int num); 1128c0caa2e2SCy Schubert 1129b5663de9SDag-Erling Smørgrav /** delete stringbytelist */ 1130b5663de9SDag-Erling Smørgrav void config_del_strbytelist(struct config_strbytelist* list); 1131b5663de9SDag-Erling Smørgrav 1132b5663de9SDag-Erling Smørgrav /** 1133f61ef7f6SDag-Erling Smørgrav * Delete a stub item 1134f61ef7f6SDag-Erling Smørgrav * @param p: stub item 1135f61ef7f6SDag-Erling Smørgrav */ 1136f61ef7f6SDag-Erling Smørgrav void config_delstub(struct config_stub* p); 1137f61ef7f6SDag-Erling Smørgrav 1138f61ef7f6SDag-Erling Smørgrav /** 1139b7579f77SDag-Erling Smørgrav * Delete items in config stub list. 1140b7579f77SDag-Erling Smørgrav * @param list: list. 1141b7579f77SDag-Erling Smørgrav */ 1142b7579f77SDag-Erling Smørgrav void config_delstubs(struct config_stub* list); 1143b7579f77SDag-Erling Smørgrav 1144b7579f77SDag-Erling Smørgrav /** 114557bddd21SDag-Erling Smørgrav * Delete an auth item 114657bddd21SDag-Erling Smørgrav * @param p: auth item 114757bddd21SDag-Erling Smørgrav */ 114857bddd21SDag-Erling Smørgrav void config_delauth(struct config_auth* p); 114957bddd21SDag-Erling Smørgrav 115057bddd21SDag-Erling Smørgrav /** 115157bddd21SDag-Erling Smørgrav * Delete items in config auth list. 115257bddd21SDag-Erling Smørgrav * @param list: list. 115357bddd21SDag-Erling Smørgrav */ 115457bddd21SDag-Erling Smørgrav void config_delauths(struct config_auth* list); 115557bddd21SDag-Erling Smørgrav 115657bddd21SDag-Erling Smørgrav /** 1157bc892140SDag-Erling Smørgrav * Delete a view item 1158bc892140SDag-Erling Smørgrav * @param p: view item 1159bc892140SDag-Erling Smørgrav */ 1160bc892140SDag-Erling Smørgrav void config_delview(struct config_view* p); 1161bc892140SDag-Erling Smørgrav 1162bc892140SDag-Erling Smørgrav /** 1163bc892140SDag-Erling Smørgrav * Delete items in config view list. 1164bc892140SDag-Erling Smørgrav * @param list: list. 1165bc892140SDag-Erling Smørgrav */ 1166bc892140SDag-Erling Smørgrav void config_delviews(struct config_view* list); 1167bc892140SDag-Erling Smørgrav 11687da0adf7SDag-Erling Smørgrav /** check if config for remote control turns on IP-address interface 11697da0adf7SDag-Erling Smørgrav * with certificates or a named pipe without certificates. */ 11707da0adf7SDag-Erling Smørgrav int options_remote_is_address(struct config_file* cfg); 11717da0adf7SDag-Erling Smørgrav 1172bc892140SDag-Erling Smørgrav /** 1173b7579f77SDag-Erling Smørgrav * Convert 14digit to time value 1174b7579f77SDag-Erling Smørgrav * @param str: string of 14 digits 1175b7579f77SDag-Erling Smørgrav * @return time value or 0 for error. 1176b7579f77SDag-Erling Smørgrav */ 117717d15b25SDag-Erling Smørgrav time_t cfg_convert_timeval(const char* str); 1178b7579f77SDag-Erling Smørgrav 1179b7579f77SDag-Erling Smørgrav /** 1180b7579f77SDag-Erling Smørgrav * Count number of values in the string. 1181b7579f77SDag-Erling Smørgrav * format ::= (sp num)+ sp 1182b7579f77SDag-Erling Smørgrav * num ::= [-](0-9)+ 1183b7579f77SDag-Erling Smørgrav * sp ::= (space|tab)* 1184b7579f77SDag-Erling Smørgrav * 1185b7579f77SDag-Erling Smørgrav * @param str: string 1186b7579f77SDag-Erling Smørgrav * @return: 0 on parse error, or empty string, else 1187b7579f77SDag-Erling Smørgrav * number of integer values in the string. 1188b7579f77SDag-Erling Smørgrav */ 1189b7579f77SDag-Erling Smørgrav int cfg_count_numbers(const char* str); 1190b7579f77SDag-Erling Smørgrav 1191b7579f77SDag-Erling Smørgrav /** 1192b7579f77SDag-Erling Smørgrav * Convert a 'nice' memory or file size into a bytecount 1193b7579f77SDag-Erling Smørgrav * From '100k' to 102400. and so on. Understands kKmMgG. 1194b7579f77SDag-Erling Smørgrav * k=1024, m=1024*1024, g=1024*1024*1024. 1195b7579f77SDag-Erling Smørgrav * @param str: string 1196b7579f77SDag-Erling Smørgrav * @param res: result is stored here, size in bytes. 1197b7579f77SDag-Erling Smørgrav * @return: true if parsed correctly, or 0 on a parse error (and an error 1198b7579f77SDag-Erling Smørgrav * is logged). 1199b7579f77SDag-Erling Smørgrav */ 1200b7579f77SDag-Erling Smørgrav int cfg_parse_memsize(const char* str, size_t* res); 1201b7579f77SDag-Erling Smørgrav 1202b7579f77SDag-Erling Smørgrav /** 120324e36522SCy Schubert * Parse nsid from string into binary nsid. nsid is either a hexadecimal 1204f44e67d1SCy Schubert * string or an ascii string prepended with ascii_ in which case the 1205f44e67d1SCy Schubert * characters after ascii_ are simply copied. 1206f44e67d1SCy Schubert * @param str: the string to parse. 1207f44e67d1SCy Schubert * @param nsid_len: returns length of nsid in bytes. 1208f44e67d1SCy Schubert * @return malloced bytes or NULL on parse error or malloc failure. 1209f44e67d1SCy Schubert */ 1210f44e67d1SCy Schubert uint8_t* cfg_parse_nsid(const char* str, uint16_t* nsid_len); 1211f44e67d1SCy Schubert 1212f44e67d1SCy Schubert /** 1213e2d15004SDag-Erling Smørgrav * Add a tag name to the config. It is added at the end with a new ID value. 1214e2d15004SDag-Erling Smørgrav * @param cfg: the config structure. 1215e2d15004SDag-Erling Smørgrav * @param tag: string (which is copied) with the name. 1216e2d15004SDag-Erling Smørgrav * @return: false on alloc failure. 1217e2d15004SDag-Erling Smørgrav */ 1218e2d15004SDag-Erling Smørgrav int config_add_tag(struct config_file* cfg, const char* tag); 1219e2d15004SDag-Erling Smørgrav 1220e2d15004SDag-Erling Smørgrav /** 1221e2d15004SDag-Erling Smørgrav * Find tag ID in the tag list. 1222e2d15004SDag-Erling Smørgrav * @param cfg: the config structure. 1223e2d15004SDag-Erling Smørgrav * @param tag: string with tag name to search for. 1224e2d15004SDag-Erling Smørgrav * @return: 0..(num_tags-1) with tag ID, or -1 if tagname is not found. 1225e2d15004SDag-Erling Smørgrav */ 1226e2d15004SDag-Erling Smørgrav int find_tag_id(struct config_file* cfg, const char* tag); 1227e2d15004SDag-Erling Smørgrav 1228e2d15004SDag-Erling Smørgrav /** 1229e2d15004SDag-Erling Smørgrav * parse taglist from string into bytestring with bitlist. 1230e2d15004SDag-Erling Smørgrav * @param cfg: the config structure (with tagnames) 1231e2d15004SDag-Erling Smørgrav * @param str: the string to parse. Parse puts 0 bytes in string. 1232e2d15004SDag-Erling Smørgrav * @param listlen: returns length of in bytes. 1233e2d15004SDag-Erling Smørgrav * @return malloced bytes with a bitlist of the tags. or NULL on parse error 1234e2d15004SDag-Erling Smørgrav * or malloc failure. 1235e2d15004SDag-Erling Smørgrav */ 1236e2d15004SDag-Erling Smørgrav uint8_t* config_parse_taglist(struct config_file* cfg, char* str, 1237e2d15004SDag-Erling Smørgrav size_t* listlen); 1238e2d15004SDag-Erling Smørgrav 1239e2d15004SDag-Erling Smørgrav /** 1240e2d15004SDag-Erling Smørgrav * convert tag bitlist to a malloced string with tag names. For debug output. 1241e2d15004SDag-Erling Smørgrav * @param cfg: the config structure (with tagnames) 1242e2d15004SDag-Erling Smørgrav * @param taglist: the tag bitlist. 1243e2d15004SDag-Erling Smørgrav * @param len: length of the tag bitlist. 1244e2d15004SDag-Erling Smørgrav * @return malloced string or NULL. 1245e2d15004SDag-Erling Smørgrav */ 1246e2d15004SDag-Erling Smørgrav char* config_taglist2str(struct config_file* cfg, uint8_t* taglist, 1247e2d15004SDag-Erling Smørgrav size_t len); 1248e2d15004SDag-Erling Smørgrav 1249e2d15004SDag-Erling Smørgrav /** 1250e2d15004SDag-Erling Smørgrav * see if two taglists intersect (have tags in common). 1251e2d15004SDag-Erling Smørgrav * @param list1: first tag bitlist. 1252e2d15004SDag-Erling Smørgrav * @param list1len: length in bytes of first list. 1253e2d15004SDag-Erling Smørgrav * @param list2: second tag bitlist. 1254e2d15004SDag-Erling Smørgrav * @param list2len: length in bytes of second list. 1255e2d15004SDag-Erling Smørgrav * @return true if there are tags in common, 0 if not. 1256e2d15004SDag-Erling Smørgrav */ 1257091e9e46SCy Schubert int taglist_intersect(uint8_t* list1, size_t list1len, const uint8_t* list2, 1258e2d15004SDag-Erling Smørgrav size_t list2len); 1259e2d15004SDag-Erling Smørgrav 1260e2d15004SDag-Erling Smørgrav /** 1261b7579f77SDag-Erling Smørgrav * Parse local-zone directive into two strings and register it in the config. 1262b7579f77SDag-Erling Smørgrav * @param cfg: to put it in. 1263b7579f77SDag-Erling Smørgrav * @param val: argument strings to local-zone, "example.com nodefault". 1264b7579f77SDag-Erling Smørgrav * @return: false on failure 1265b7579f77SDag-Erling Smørgrav */ 1266b7579f77SDag-Erling Smørgrav int cfg_parse_local_zone(struct config_file* cfg, const char* val); 1267b7579f77SDag-Erling Smørgrav 1268b7579f77SDag-Erling Smørgrav /** 1269b7579f77SDag-Erling Smørgrav * Mark "number" or "low-high" as available or not in ports array. 1270b7579f77SDag-Erling Smørgrav * @param str: string in input 1271b7579f77SDag-Erling Smørgrav * @param allow: give true if this range is permitted. 1272b7579f77SDag-Erling Smørgrav * @param avail: the array from cfg. 1273b7579f77SDag-Erling Smørgrav * @param num: size of the array (65536). 1274b7579f77SDag-Erling Smørgrav * @return: true if parsed correctly, or 0 on a parse error (and an error 1275b7579f77SDag-Erling Smørgrav * is logged). 1276b7579f77SDag-Erling Smørgrav */ 1277b7579f77SDag-Erling Smørgrav int cfg_mark_ports(const char* str, int allow, int* avail, int num); 1278b7579f77SDag-Erling Smørgrav 1279b7579f77SDag-Erling Smørgrav /** 1280b7579f77SDag-Erling Smørgrav * Get a condensed list of ports returned. allocated. 1281b7579f77SDag-Erling Smørgrav * @param cfg: config file. 1282b7579f77SDag-Erling Smørgrav * @param avail: the available ports array is returned here. 1283b7579f77SDag-Erling Smørgrav * @return: number of ports in array or 0 on error. 1284b7579f77SDag-Erling Smørgrav */ 1285b7579f77SDag-Erling Smørgrav int cfg_condense_ports(struct config_file* cfg, int** avail); 1286b7579f77SDag-Erling Smørgrav 1287b7579f77SDag-Erling Smørgrav /** 12885469a995SCy Schubert * Apply system specific port range policy. 12895469a995SCy Schubert * @param cfg: config file. 12905469a995SCy Schubert * @param num: size of the array (65536). 12915469a995SCy Schubert */ 12925469a995SCy Schubert void cfg_apply_local_port_policy(struct config_file* cfg, int num); 12935469a995SCy Schubert 12945469a995SCy Schubert /** 1295b7579f77SDag-Erling Smørgrav * Scan ports available 1296b7579f77SDag-Erling Smørgrav * @param avail: the array from cfg. 1297b7579f77SDag-Erling Smørgrav * @param num: size of the array (65536). 1298b7579f77SDag-Erling Smørgrav * @return the number of ports available for use. 1299b7579f77SDag-Erling Smørgrav */ 1300b7579f77SDag-Erling Smørgrav int cfg_scan_ports(int* avail, int num); 1301b7579f77SDag-Erling Smørgrav 1302b7579f77SDag-Erling Smørgrav /** 1303b7579f77SDag-Erling Smørgrav * Convert a filename to full pathname in original filesys 1304b7579f77SDag-Erling Smørgrav * @param fname: the path name to convert. 1305b7579f77SDag-Erling Smørgrav * Must not be null or empty. 1306b7579f77SDag-Erling Smørgrav * @param cfg: config struct for chroot and chdir (if set). 1307b7579f77SDag-Erling Smørgrav * @param use_chdir: if false, only chroot is applied. 1308b7579f77SDag-Erling Smørgrav * @return pointer to malloced buffer which is: [chroot][chdir]fname 1309b7579f77SDag-Erling Smørgrav * or NULL on malloc failure. 1310b7579f77SDag-Erling Smørgrav */ 1311b7579f77SDag-Erling Smørgrav char* fname_after_chroot(const char* fname, struct config_file* cfg, 1312b7579f77SDag-Erling Smørgrav int use_chdir); 1313b7579f77SDag-Erling Smørgrav 1314b7579f77SDag-Erling Smørgrav /** 1315b7579f77SDag-Erling Smørgrav * Convert a ptr shorthand into a full reverse-notation PTR record. 1316b7579f77SDag-Erling Smørgrav * @param str: input string, "IP name" 1317b7579f77SDag-Erling Smørgrav * @return: malloced string "reversed-ip-name PTR name" 1318b7579f77SDag-Erling Smørgrav */ 1319b7579f77SDag-Erling Smørgrav char* cfg_ptr_reverse(char* str); 1320b7579f77SDag-Erling Smørgrav 1321b7579f77SDag-Erling Smørgrav /** 1322b7579f77SDag-Erling Smørgrav * Used during options parsing 1323b7579f77SDag-Erling Smørgrav */ 1324b7579f77SDag-Erling Smørgrav struct config_parser_state { 1325b7579f77SDag-Erling Smørgrav /** name of file being parser */ 1326b7579f77SDag-Erling Smørgrav char* filename; 1327b7579f77SDag-Erling Smørgrav /** line number in the file, starts at 1 */ 1328b7579f77SDag-Erling Smørgrav int line; 1329b7579f77SDag-Erling Smørgrav /** number of errors encountered */ 1330b7579f77SDag-Erling Smørgrav int errors; 1331b7579f77SDag-Erling Smørgrav /** the result of parsing is stored here. */ 1332b7579f77SDag-Erling Smørgrav struct config_file* cfg; 1333b7579f77SDag-Erling Smørgrav /** the current chroot dir (or NULL if none) */ 1334b7579f77SDag-Erling Smørgrav const char* chroot; 1335865f46b2SCy Schubert /** if we are started in a toplevel, or not, after a force_toplevel */ 1336865f46b2SCy Schubert int started_toplevel; 1337b7579f77SDag-Erling Smørgrav }; 1338b7579f77SDag-Erling Smørgrav 1339b7579f77SDag-Erling Smørgrav /** global config parser object used during config parsing */ 1340b7579f77SDag-Erling Smørgrav extern struct config_parser_state* cfg_parser; 134117d15b25SDag-Erling Smørgrav /** init lex state */ 134217d15b25SDag-Erling Smørgrav void init_cfg_parse(void); 1343f41b5392SDag-Erling Smørgrav /** lex in file */ 1344f41b5392SDag-Erling Smørgrav extern FILE* ub_c_in; 1345f41b5392SDag-Erling Smørgrav /** lex out file */ 1346f41b5392SDag-Erling Smørgrav extern FILE* ub_c_out; 1347f41b5392SDag-Erling Smørgrav /** the yacc lex generated parse function */ 1348f41b5392SDag-Erling Smørgrav int ub_c_parse(void); 1349f41b5392SDag-Erling Smørgrav /** the lexer function */ 1350f41b5392SDag-Erling Smørgrav int ub_c_lex(void); 1351f41b5392SDag-Erling Smørgrav /** wrap function */ 1352f41b5392SDag-Erling Smørgrav int ub_c_wrap(void); 1353b7579f77SDag-Erling Smørgrav /** parsing helpers: print error with file and line numbers */ 1354b7579f77SDag-Erling Smørgrav void ub_c_error(const char* msg); 1355b7579f77SDag-Erling Smørgrav /** parsing helpers: print error with file and line numbers */ 1356b7579f77SDag-Erling Smørgrav void ub_c_error_msg(const char* fmt, ...) ATTR_FORMAT(printf, 1, 2); 1357b7579f77SDag-Erling Smørgrav 1358b7579f77SDag-Erling Smørgrav #ifdef UB_ON_WINDOWS 1359b7579f77SDag-Erling Smørgrav /** 1360b7579f77SDag-Erling Smørgrav * Obtain registry string (if it exists). 1361b7579f77SDag-Erling Smørgrav * @param key: key string 1362b7579f77SDag-Erling Smørgrav * @param name: name of value to fetch. 1363b7579f77SDag-Erling Smørgrav * @return malloced string with the result or NULL if it did not 1364b7579f77SDag-Erling Smørgrav * exist on an error (logged with log_err) was encountered. 1365b7579f77SDag-Erling Smørgrav */ 1366b7579f77SDag-Erling Smørgrav char* w_lookup_reg_str(const char* key, const char* name); 136705ab2901SDag-Erling Smørgrav 136805ab2901SDag-Erling Smørgrav /** Modify directory in options for module file name */ 136905ab2901SDag-Erling Smørgrav void w_config_adjust_directory(struct config_file* cfg); 1370b7579f77SDag-Erling Smørgrav #endif /* UB_ON_WINDOWS */ 1371b7579f77SDag-Erling Smørgrav 1372bc892140SDag-Erling Smørgrav /** debug option for unit tests. */ 137365b390aaSDag-Erling Smørgrav extern int fake_dsa, fake_sha1; 1374bc892140SDag-Erling Smørgrav 13755469a995SCy Schubert /** see if interface is https, its port number == the https port number */ 13765469a995SCy Schubert int if_is_https(const char* ifname, const char* port, int https_port); 13775469a995SCy Schubert 13785469a995SCy Schubert /** 13795469a995SCy Schubert * Return true if the config contains settings that enable https. 13805469a995SCy Schubert * @param cfg: config information. 13815469a995SCy Schubert * @return true if https ports are used for server. 13825469a995SCy Schubert */ 13835469a995SCy Schubert int cfg_has_https(struct config_file* cfg); 13845469a995SCy Schubert 1385865f46b2SCy Schubert /** see if interface is PROXYv2, its port number == the proxy port number */ 1386865f46b2SCy Schubert int if_is_pp2(const char* ifname, const char* port, 1387865f46b2SCy Schubert struct config_strlist* proxy_protocol_port); 1388865f46b2SCy Schubert 1389865f46b2SCy Schubert /** see if interface is DNSCRYPT, its port number == the dnscrypt port number */ 1390865f46b2SCy Schubert int if_is_dnscrypt(const char* ifname, const char* port, int dnscrypt_port); 13915469a995SCy Schubert #ifdef USE_LINUX_IP_LOCAL_PORT_RANGE 13925469a995SCy Schubert #define LINUX_IP_LOCAL_PORT_RANGE_PATH "/proc/sys/net/ipv4/ip_local_port_range" 13935469a995SCy Schubert #endif 13945469a995SCy Schubert 1395b7579f77SDag-Erling Smørgrav #endif /* UTIL_CONFIG_FILE_H */ 1396