]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/unbound/doc/example.conf.in
THIS BRANCH IS OBSOLETE, PLEASE READ:
[FreeBSD/FreeBSD.git] / contrib / unbound / doc / example.conf.in
1 #
2 # Example configuration file.
3 #
4 # See unbound.conf(5) man page, version 1.13.0.
5 #
6 # this is a comment.
7
8 # Use this anywhere in the file to include other text into this file.
9 #include: "otherfile.conf"
10
11 # Use this anywhere in the file to include other text, that explicitly starts a
12 # clause, into this file. Text after this directive needs to start a clause.
13 #include-toplevel: "otherfile.conf"
14
15 # The server clause sets the main parameters.
16 server:
17         # whitespace is not necessary, but looks cleaner.
18
19         # verbosity number, 0 is least verbose. 1 is default.
20         verbosity: 1
21
22         # print statistics to the log (for every thread) every N seconds.
23         # Set to "" or 0 to disable. Default is disabled.
24         # statistics-interval: 0
25
26         # enable shm for stats, default no.  if you enable also enable
27         # statistics-interval, every time it also writes stats to the
28         # shared memory segment keyed with shm-key.
29         # shm-enable: no
30
31         # shm for stats uses this key, and key+1 for the shared mem segment.
32         # shm-key: 11777
33
34         # enable cumulative statistics, without clearing them after printing.
35         # statistics-cumulative: no
36
37         # enable extended statistics (query types, answer codes, status)
38         # printed from unbound-control. default off, because of speed.
39         # extended-statistics: no
40
41         # number of threads to create. 1 disables threading.
42         # num-threads: 1
43
44         # specify the interfaces to answer queries from by ip-address.
45         # The default is to listen to localhost (127.0.0.1 and ::1).
46         # specify 0.0.0.0 and ::0 to bind to all available interfaces.
47         # specify every interface[@port] on a new 'interface:' labelled line.
48         # The listen interfaces are not changed on reload, only on restart.
49         # interface: 192.0.2.153
50         # interface: 192.0.2.154
51         # interface: 192.0.2.154@5003
52         # interface: 2001:DB8::5
53
54         # enable this feature to copy the source address of queries to reply.
55         # Socket options are not supported on all platforms. experimental.
56         # interface-automatic: no
57
58         # port to answer queries from
59         # port: 53
60
61         # specify the interfaces to send outgoing queries to authoritative
62         # server from by ip-address. If none, the default (all) interface
63         # is used. Specify every interface on a 'outgoing-interface:' line.
64         # outgoing-interface: 192.0.2.153
65         # outgoing-interface: 2001:DB8::5
66         # outgoing-interface: 2001:DB8::6
67
68         # Specify a netblock to use remainder 64 bits as random bits for
69         # upstream queries.  Uses freebind option (Linux).
70         # outgoing-interface: 2001:DB8::/64
71         # Also (Linux:) ip -6 addr add 2001:db8::/64 dev lo
72         # And: ip -6 route add local 2001:db8::/64 dev lo
73         # And set prefer-ip6: yes to use the ip6 randomness from a netblock.
74         # Set this to yes to prefer ipv6 upstream servers over ipv4.
75         # prefer-ip6: no
76
77         # Prefer ipv4 upstream servers, even if ipv6 is available.
78         # prefer-ip4: no
79
80         # number of ports to allocate per thread, determines the size of the
81         # port range that can be open simultaneously.  About double the
82         # num-queries-per-thread, or, use as many as the OS will allow you.
83         # outgoing-range: 4096
84
85         # permit unbound to use this port number or port range for
86         # making outgoing queries, using an outgoing interface.
87         # outgoing-port-permit: 32768
88
89         # deny unbound the use this of port number or port range for
90         # making outgoing queries, using an outgoing interface.
91         # Use this to make sure unbound does not grab a UDP port that some
92         # other server on this computer needs. The default is to avoid
93         # IANA-assigned port numbers.
94         # If multiple outgoing-port-permit and outgoing-port-avoid options
95         # are present, they are processed in order.
96         # outgoing-port-avoid: "3200-3208"
97
98         # number of outgoing simultaneous tcp buffers to hold per thread.
99         # outgoing-num-tcp: 10
100
101         # number of incoming simultaneous tcp buffers to hold per thread.
102         # incoming-num-tcp: 10
103
104         # buffer size for UDP port 53 incoming (SO_RCVBUF socket option).
105         # 0 is system default.  Use 4m to catch query spikes for busy servers.
106         # so-rcvbuf: 0
107
108         # buffer size for UDP port 53 outgoing (SO_SNDBUF socket option).
109         # 0 is system default.  Use 4m to handle spikes on very busy servers.
110         # so-sndbuf: 0
111
112         # use SO_REUSEPORT to distribute queries over threads.
113         # at extreme load it could be better to turn it off to distribute even.
114         # so-reuseport: yes
115
116         # use IP_TRANSPARENT so the interface: addresses can be non-local
117         # and you can config non-existing IPs that are going to work later on
118         # (uses IP_BINDANY on FreeBSD).
119         # ip-transparent: no
120
121         # use IP_FREEBIND so the interface: addresses can be non-local
122         # and you can bind to nonexisting IPs and interfaces that are down.
123         # Linux only.  On Linux you also have ip-transparent that is similar.
124         # ip-freebind: no
125
126         # the value of the Differentiated Services Codepoint (DSCP)
127         # in the differentiated services field (DS) of the outgoing
128         # IP packets
129         # ip-dscp: 0
130
131         # EDNS reassembly buffer to advertise to UDP peers (the actual buffer
132         # is set with msg-buffer-size).
133         # edns-buffer-size: 1232
134
135         # Maximum UDP response size (not applied to TCP response).
136         # Suggested values are 512 to 4096. Default is 4096. 65536 disables it.
137         # max-udp-size: 4096
138
139         # max memory to use for stream(tcp and tls) waiting result buffers.
140         # stream-wait-size: 4m
141
142         # buffer size for handling DNS data. No messages larger than this
143         # size can be sent or received, by UDP or TCP. In bytes.
144         # msg-buffer-size: 65552
145
146         # the amount of memory to use for the message cache.
147         # plain value in bytes or you can append k, m or G. default is "4Mb".
148         # msg-cache-size: 4m
149
150         # the number of slabs to use for the message cache.
151         # the number of slabs must be a power of 2.
152         # more slabs reduce lock contention, but fragment memory usage.
153         # msg-cache-slabs: 4
154
155         # the number of queries that a thread gets to service.
156         # num-queries-per-thread: 1024
157
158         # if very busy, 50% queries run to completion, 50% get timeout in msec
159         # jostle-timeout: 200
160
161         # msec to wait before close of port on timeout UDP. 0 disables.
162         # delay-close: 0
163
164         # perform connect for UDP sockets to mitigate ICMP side channel.
165         # udp-connect: yes
166
167         # msec for waiting for an unknown server to reply.  Increase if you
168         # are behind a slow satellite link, to eg. 1128.
169         # unknown-server-time-limit: 376
170
171         # the amount of memory to use for the RRset cache.
172         # plain value in bytes or you can append k, m or G. default is "4Mb".
173         # rrset-cache-size: 4m
174
175         # the number of slabs to use for the RRset cache.
176         # the number of slabs must be a power of 2.
177         # more slabs reduce lock contention, but fragment memory usage.
178         # rrset-cache-slabs: 4
179
180         # the time to live (TTL) value lower bound, in seconds. Default 0.
181         # If more than an hour could easily give trouble due to stale data.
182         # cache-min-ttl: 0
183
184         # the time to live (TTL) value cap for RRsets and messages in the
185         # cache. Items are not cached for longer. In seconds.
186         # cache-max-ttl: 86400
187
188         # the time to live (TTL) value cap for negative responses in the cache
189         # cache-max-negative-ttl: 3600
190
191         # the time to live (TTL) value for cached roundtrip times, lameness and
192         # EDNS version information for hosts. In seconds.
193         # infra-host-ttl: 900
194
195         # minimum wait time for responses, increase if uplink is long. In msec.
196         # infra-cache-min-rtt: 50
197
198         # enable to make server probe down hosts more frequently.
199         # infra-keep-probing: no
200
201         # the number of slabs to use for the Infrastructure cache.
202         # the number of slabs must be a power of 2.
203         # more slabs reduce lock contention, but fragment memory usage.
204         # infra-cache-slabs: 4
205
206         # the maximum number of hosts that are cached (roundtrip, EDNS, lame).
207         # infra-cache-numhosts: 10000
208
209         # define a number of tags here, use with local-zone, access-control.
210         # repeat the define-tag statement to add additional tags.
211         # define-tag: "tag1 tag2 tag3"
212
213         # Enable IPv4, "yes" or "no".
214         # do-ip4: yes
215
216         # Enable IPv6, "yes" or "no".
217         # do-ip6: yes
218
219         # Enable UDP, "yes" or "no".
220         # do-udp: yes
221
222         # Enable TCP, "yes" or "no".
223         # do-tcp: yes
224
225         # upstream connections use TCP only (and no UDP), "yes" or "no"
226         # useful for tunneling scenarios, default no.
227         # tcp-upstream: no
228
229         # upstream connections also use UDP (even if do-udp is no).
230         # useful if if you want UDP upstream, but don't provide UDP downstream.
231         # udp-upstream-without-downstream: no
232
233         # Maximum segment size (MSS) of TCP socket on which the server
234         # responds to queries. Default is 0, system default MSS.
235         # tcp-mss: 0
236
237         # Maximum segment size (MSS) of TCP socket for outgoing queries.
238         # Default is 0, system default MSS.
239         # outgoing-tcp-mss: 0
240
241         # Idle TCP timeout, connection closed in milliseconds
242         # tcp-idle-timeout: 30000
243
244         # Enable EDNS TCP keepalive option.
245         # edns-tcp-keepalive: no
246
247         # Timeout for EDNS TCP keepalive, in msec.
248         # edns-tcp-keepalive-timeout: 120000
249
250         # Use systemd socket activation for UDP, TCP, and control sockets.
251         # use-systemd: no
252
253         # Detach from the terminal, run in background, "yes" or "no".
254         # Set the value to "no" when unbound runs as systemd service.
255         # do-daemonize: yes
256
257         # control which clients are allowed to make (recursive) queries
258         # to this server. Specify classless netblocks with /size and action.
259         # By default everything is refused, except for localhost.
260         # Choose deny (drop message), refuse (polite error reply),
261         # allow (recursive ok), allow_setrd (recursive ok, rd bit is forced on),
262         # allow_snoop (recursive and nonrecursive ok)
263         # deny_non_local (drop queries unless can be answered from local-data)
264         # refuse_non_local (like deny_non_local but polite error reply).
265         # access-control: 0.0.0.0/0 refuse
266         # access-control: 127.0.0.0/8 allow
267         # access-control: ::0/0 refuse
268         # access-control: ::1 allow
269         # access-control: ::ffff:127.0.0.1 allow
270
271         # tag access-control with list of tags (in "" with spaces between)
272         # Clients using this access control element use localzones that
273         # are tagged with one of these tags.
274         # access-control-tag: 192.0.2.0/24 "tag2 tag3"
275
276         # set action for particular tag for given access control element
277         # if you have multiple tag values, the tag used to lookup the action
278         # is the first tag match between access-control-tag and local-zone-tag
279         # where "first" comes from the order of the define-tag values.
280         # access-control-tag-action: 192.0.2.0/24 tag3 refuse
281
282         # set redirect data for particular tag for access control element
283         # access-control-tag-data: 192.0.2.0/24 tag2 "A 127.0.0.1"
284
285         # Set view for access control element
286         # access-control-view: 192.0.2.0/24 viewname
287
288         # if given, a chroot(2) is done to the given directory.
289         # i.e. you can chroot to the working directory, for example,
290         # for extra security, but make sure all files are in that directory.
291         #
292         # If chroot is enabled, you should pass the configfile (from the
293         # commandline) as a full path from the original root. After the
294         # chroot has been performed the now defunct portion of the config
295         # file path is removed to be able to reread the config after a reload.
296         #
297         # All other file paths (working dir, logfile, roothints, and
298         # key files) can be specified in several ways:
299         #       o as an absolute path relative to the new root.
300         #       o as a relative path to the working directory.
301         #       o as an absolute path relative to the original root.
302         # In the last case the path is adjusted to remove the unused portion.
303         #
304         # The pid file can be absolute and outside of the chroot, it is
305         # written just prior to performing the chroot and dropping permissions.
306         #
307         # Additionally, unbound may need to access /dev/urandom (for entropy).
308         # How to do this is specific to your OS.
309         #
310         # If you give "" no chroot is performed. The path must not end in a /.
311         # chroot: "@UNBOUND_CHROOT_DIR@"
312
313         # if given, user privileges are dropped (after binding port),
314         # and the given username is assumed. Default is user "unbound".
315         # If you give "" no privileges are dropped.
316         # username: "@UNBOUND_USERNAME@"
317
318         # the working directory. The relative files in this config are
319         # relative to this directory. If you give "" the working directory
320         # is not changed.
321         # If you give a server: directory: dir before include: file statements
322         # then those includes can be relative to the working directory.
323         # directory: "@UNBOUND_RUN_DIR@"
324
325         # the log file, "" means log to stderr.
326         # Use of this option sets use-syslog to "no".
327         # logfile: ""
328
329         # Log to syslog(3) if yes. The log facility LOG_DAEMON is used to
330         # log to. If yes, it overrides the logfile.
331         # use-syslog: yes
332
333         # Log identity to report. if empty, defaults to the name of argv[0]
334         # (usually "unbound").
335         # log-identity: ""
336
337         # print UTC timestamp in ascii to logfile, default is epoch in seconds.
338         # log-time-ascii: no
339
340         # print one line with time, IP, name, type, class for every query.
341         # log-queries: no
342
343         # print one line per reply, with time, IP, name, type, class, rcode,
344         # timetoresolve, fromcache and responsesize.
345         # log-replies: no
346
347         # log with tag 'query' and 'reply' instead of 'info' for
348         # filtering log-queries and log-replies from the log.
349         # log-tag-queryreply: no
350
351         # log the local-zone actions, like local-zone type inform is enabled
352         # also for the other local zone types.
353         # log-local-actions: no
354
355         # print log lines that say why queries return SERVFAIL to clients.
356         # log-servfail: no
357
358         # the pid file. Can be an absolute path outside of chroot/work dir.
359         # pidfile: "@UNBOUND_PIDFILE@"
360
361         # file to read root hints from.
362         # get one from https://www.internic.net/domain/named.cache
363         # root-hints: ""
364
365         # enable to not answer id.server and hostname.bind queries.
366         # hide-identity: no
367
368         # enable to not answer version.server and version.bind queries.
369         # hide-version: no
370
371         # enable to not answer trustanchor.unbound queries.
372         # hide-trustanchor: no
373
374         # the identity to report. Leave "" or default to return hostname.
375         # identity: ""
376
377         # the version to report. Leave "" or default to return package version.
378         # version: ""
379
380         # the target fetch policy.
381         # series of integers describing the policy per dependency depth.
382         # The number of values in the list determines the maximum dependency
383         # depth the recursor will pursue before giving up. Each integer means:
384         #       -1 : fetch all targets opportunistically,
385         #       0: fetch on demand,
386         #       positive value: fetch that many targets opportunistically.
387         # Enclose the list of numbers between quotes ("").
388         # target-fetch-policy: "3 2 1 0 0"
389
390         # Harden against very small EDNS buffer sizes.
391         # harden-short-bufsize: no
392
393         # Harden against unseemly large queries.
394         # harden-large-queries: no
395
396         # Harden against out of zone rrsets, to avoid spoofing attempts.
397         # harden-glue: yes
398
399         # Harden against receiving dnssec-stripped data. If you turn it
400         # off, failing to validate dnskey data for a trustanchor will
401         # trigger insecure mode for that zone (like without a trustanchor).
402         # Default on, which insists on dnssec data for trust-anchored zones.
403         # harden-dnssec-stripped: yes
404
405         # Harden against queries that fall under dnssec-signed nxdomain names.
406         # harden-below-nxdomain: yes
407
408         # Harden the referral path by performing additional queries for
409         # infrastructure data.  Validates the replies (if possible).
410         # Default off, because the lookups burden the server.  Experimental
411         # implementation of draft-wijngaards-dnsext-resolver-side-mitigation.
412         # harden-referral-path: no
413
414         # Harden against algorithm downgrade when multiple algorithms are
415         # advertised in the DS record.  If no, allows the weakest algorithm
416         # to validate the zone.
417         # harden-algo-downgrade: no
418
419         # Sent minimum amount of information to upstream servers to enhance
420         # privacy. Only sent minimum required labels of the QNAME and set QTYPE
421         # to A when possible.
422         # qname-minimisation: yes
423
424         # QNAME minimisation in strict mode. Do not fall-back to sending full
425         # QNAME to potentially broken nameservers. A lot of domains will not be
426         # resolvable when this option in enabled.
427         # This option only has effect when qname-minimisation is enabled.
428         # qname-minimisation-strict: no
429
430         # Aggressive NSEC uses the DNSSEC NSEC chain to synthesize NXDOMAIN
431         # and other denials, using information from previous NXDOMAINs answers.
432         # aggressive-nsec: no
433
434         # Use 0x20-encoded random bits in the query to foil spoof attempts.
435         # This feature is an experimental implementation of draft dns-0x20.
436         # use-caps-for-id: no
437
438         # Domains (and domains in them) without support for dns-0x20 and
439         # the fallback fails because they keep sending different answers.
440         # caps-exempt: "licdn.com"
441         # caps-exempt: "senderbase.org"
442
443         # Enforce privacy of these addresses. Strips them away from answers.
444         # It may cause DNSSEC validation to additionally mark it as bogus.
445         # Protects against 'DNS Rebinding' (uses browser as network proxy).
446         # Only 'private-domain' and 'local-data' names are allowed to have
447         # these private addresses. No default.
448         # private-address: 10.0.0.0/8
449         # private-address: 172.16.0.0/12
450         # private-address: 192.168.0.0/16
451         # private-address: 169.254.0.0/16
452         # private-address: fd00::/8
453         # private-address: fe80::/10
454         # private-address: ::ffff:0:0/96
455
456         # Allow the domain (and its subdomains) to contain private addresses.
457         # local-data statements are allowed to contain private addresses too.
458         # private-domain: "example.com"
459
460         # If nonzero, unwanted replies are not only reported in statistics,
461         # but also a running total is kept per thread. If it reaches the
462         # threshold, a warning is printed and a defensive action is taken,
463         # the cache is cleared to flush potential poison out of it.
464         # A suggested value is 10000000, the default is 0 (turned off).
465         # unwanted-reply-threshold: 0
466
467         # Do not query the following addresses. No DNS queries are sent there.
468         # List one address per entry. List classless netblocks with /size,
469         # do-not-query-address: 127.0.0.1/8
470         # do-not-query-address: ::1
471
472         # if yes, the above default do-not-query-address entries are present.
473         # if no, localhost can be queried (for testing and debugging).
474         # do-not-query-localhost: yes
475
476         # if yes, perform prefetching of almost expired message cache entries.
477         # prefetch: no
478
479         # if yes, perform key lookups adjacent to normal lookups.
480         # prefetch-key: no
481
482         # deny queries of type ANY with an empty response.
483         # deny-any: no
484
485         # if yes, Unbound rotates RRSet order in response.
486         # rrset-roundrobin: yes
487
488         # if yes, Unbound doesn't insert authority/additional sections
489         # into response messages when those sections are not required.
490         # minimal-responses: yes
491
492         # true to disable DNSSEC lameness check in iterator.
493         # disable-dnssec-lame-check: no
494
495         # module configuration of the server. A string with identifiers
496         # separated by spaces. Syntax: "[dns64] [validator] iterator"
497         # most modules have to be listed at the beginning of the line,
498         # except cachedb(just before iterator), and python (at the beginning,
499         # or, just before the iterator).
500         # module-config: "validator iterator"
501
502         # File with trusted keys, kept uptodate using RFC5011 probes,
503         # initial file like trust-anchor-file, then it stores metadata.
504         # Use several entries, one per domain name, to track multiple zones.
505         #
506         # If you want to perform DNSSEC validation, run unbound-anchor before
507         # you start unbound (i.e. in the system boot scripts).  And enable:
508         # Please note usage of unbound-anchor root anchor is at your own risk
509         # and under the terms of our LICENSE (see that file in the source).
510         # auto-trust-anchor-file: "@UNBOUND_ROOTKEY_FILE@"
511
512         # trust anchor signaling sends a RFC8145 key tag query after priming.
513         # trust-anchor-signaling: yes
514
515         # Root key trust anchor sentinel (draft-ietf-dnsop-kskroll-sentinel)
516         # root-key-sentinel: yes
517
518         # File with trusted keys for validation. Specify more than one file
519         # with several entries, one file per entry.
520         # Zone file format, with DS and DNSKEY entries.
521         # Note this gets out of date, use auto-trust-anchor-file please.
522         # trust-anchor-file: ""
523
524         # Trusted key for validation. DS or DNSKEY. specify the RR on a
525         # single line, surrounded by "". TTL is ignored. class is IN default.
526         # Note this gets out of date, use auto-trust-anchor-file please.
527         # (These examples are from August 2007 and may not be valid anymore).
528         # trust-anchor: "nlnetlabs.nl. DNSKEY 257 3 5 AQPzzTWMz8qSWIQlfRnPckx2BiVmkVN6LPupO3mbz7FhLSnm26n6iG9N Lby97Ji453aWZY3M5/xJBSOS2vWtco2t8C0+xeO1bc/d6ZTy32DHchpW 6rDH1vp86Ll+ha0tmwyy9QP7y2bVw5zSbFCrefk8qCUBgfHm9bHzMG1U BYtEIQ=="
529         # trust-anchor: "jelte.nlnetlabs.nl. DS 42860 5 1 14D739EB566D2B1A5E216A0BA4D17FA9B038BE4A"
530
531         # File with trusted keys for validation. Specify more than one file
532         # with several entries, one file per entry. Like trust-anchor-file
533         # but has a different file format. Format is BIND-9 style format,
534         # the trusted-keys { name flag proto algo "key"; }; clauses are read.
535         # you need external update procedures to track changes in keys.
536         # trusted-keys-file: ""
537
538         # Ignore chain of trust. Domain is treated as insecure.
539         # domain-insecure: "example.com"
540
541         # Override the date for validation with a specific fixed date.
542         # Do not set this unless you are debugging signature inception
543         # and expiration. "" or "0" turns the feature off. -1 ignores date.
544         # val-override-date: ""
545
546         # The time to live for bogus data, rrsets and messages. This avoids
547         # some of the revalidation, until the time interval expires. in secs.
548         # val-bogus-ttl: 60
549
550         # The signature inception and expiration dates are allowed to be off
551         # by 10% of the signature lifetime (expir-incep) from our local clock.
552         # This leeway is capped with a minimum and a maximum.  In seconds.
553         # val-sig-skew-min: 3600
554         # val-sig-skew-max: 86400
555
556         # Should additional section of secure message also be kept clean of
557         # unsecure data. Useful to shield the users of this validator from
558         # potential bogus data in the additional section. All unsigned data
559         # in the additional section is removed from secure messages.
560         # val-clean-additional: yes
561
562         # Turn permissive mode on to permit bogus messages. Thus, messages
563         # for which security checks failed will be returned to clients,
564         # instead of SERVFAIL. It still performs the security checks, which
565         # result in interesting log files and possibly the AD bit in
566         # replies if the message is found secure. The default is off.
567         # val-permissive-mode: no
568
569         # Ignore the CD flag in incoming queries and refuse them bogus data.
570         # Enable it if the only clients of unbound are legacy servers (w2008)
571         # that set CD but cannot validate themselves.
572         # ignore-cd-flag: no
573
574         # Serve expired responses from cache, with serve-expired-reply-ttl in
575         # the response, and then attempt to fetch the data afresh.
576         # serve-expired: no
577         #
578         # Limit serving of expired responses to configured seconds after
579         # expiration. 0 disables the limit.
580         # serve-expired-ttl: 0
581         #
582         # Set the TTL of expired records to the serve-expired-ttl value after a
583         # failed attempt to retrieve the record from upstream. This makes sure
584         # that the expired records will be served as long as there are queries
585         # for it.
586         # serve-expired-ttl-reset: no
587         #
588         # TTL value to use when replying with expired data.
589         # serve-expired-reply-ttl: 30
590         #
591         # Time in milliseconds before replying to the client with expired data.
592         # This essentially enables the serve-stale behavior as specified in
593         # RFC 8767 that first tries to resolve before
594         # immediately responding with expired data.  0 disables this behavior.
595         # A recommended value is 1800.
596         # serve-expired-client-timeout: 0
597
598         # Have the validator log failed validations for your diagnosis.
599         # 0: off. 1: A line per failed user query. 2: With reason and bad IP.
600         # val-log-level: 0
601
602         # It is possible to configure NSEC3 maximum iteration counts per
603         # keysize. Keep this table very short, as linear search is done.
604         # A message with an NSEC3 with larger count is marked insecure.
605         # List in ascending order the keysize and count values.
606         # val-nsec3-keysize-iterations: "1024 150 2048 500 4096 2500"
607
608         # instruct the auto-trust-anchor-file probing to add anchors after ttl.
609         # add-holddown: 2592000 # 30 days
610
611         # instruct the auto-trust-anchor-file probing to del anchors after ttl.
612         # del-holddown: 2592000 # 30 days
613
614         # auto-trust-anchor-file probing removes missing anchors after ttl.
615         # If the value 0 is given, missing anchors are not removed.
616         # keep-missing: 31622400 # 366 days
617
618         # debug option that allows very small holddown times for key rollover,
619         # otherwise the RFC mandates probe intervals must be at least 1 hour.
620         # permit-small-holddown: no
621
622         # the amount of memory to use for the key cache.
623         # plain value in bytes or you can append k, m or G. default is "4Mb".
624         # key-cache-size: 4m
625
626         # the number of slabs to use for the key cache.
627         # the number of slabs must be a power of 2.
628         # more slabs reduce lock contention, but fragment memory usage.
629         # key-cache-slabs: 4
630
631         # the amount of memory to use for the negative cache.
632         # plain value in bytes or you can append k, m or G. default is "1Mb".
633         # neg-cache-size: 1m
634
635         # By default, for a number of zones a small default 'nothing here'
636         # reply is built-in.  Query traffic is thus blocked.  If you
637         # wish to serve such zone you can unblock them by uncommenting one
638         # of the nodefault statements below.
639         # You may also have to use domain-insecure: zone to make DNSSEC work,
640         # unless you have your own trust anchors for this zone.
641         # local-zone: "localhost." nodefault
642         # local-zone: "127.in-addr.arpa." nodefault
643         # local-zone: "1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa." nodefault
644         # local-zone: "onion." nodefault
645         # local-zone: "test." nodefault
646         # local-zone: "invalid." nodefault
647         # local-zone: "10.in-addr.arpa." nodefault
648         # local-zone: "16.172.in-addr.arpa." nodefault
649         # local-zone: "17.172.in-addr.arpa." nodefault
650         # local-zone: "18.172.in-addr.arpa." nodefault
651         # local-zone: "19.172.in-addr.arpa." nodefault
652         # local-zone: "20.172.in-addr.arpa." nodefault
653         # local-zone: "21.172.in-addr.arpa." nodefault
654         # local-zone: "22.172.in-addr.arpa." nodefault
655         # local-zone: "23.172.in-addr.arpa." nodefault
656         # local-zone: "24.172.in-addr.arpa." nodefault
657         # local-zone: "25.172.in-addr.arpa." nodefault
658         # local-zone: "26.172.in-addr.arpa." nodefault
659         # local-zone: "27.172.in-addr.arpa." nodefault
660         # local-zone: "28.172.in-addr.arpa." nodefault
661         # local-zone: "29.172.in-addr.arpa." nodefault
662         # local-zone: "30.172.in-addr.arpa." nodefault
663         # local-zone: "31.172.in-addr.arpa." nodefault
664         # local-zone: "168.192.in-addr.arpa." nodefault
665         # local-zone: "0.in-addr.arpa." nodefault
666         # local-zone: "254.169.in-addr.arpa." nodefault
667         # local-zone: "2.0.192.in-addr.arpa." nodefault
668         # local-zone: "100.51.198.in-addr.arpa." nodefault
669         # local-zone: "113.0.203.in-addr.arpa." nodefault
670         # local-zone: "255.255.255.255.in-addr.arpa." nodefault
671         # local-zone: "0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa." nodefault
672         # local-zone: "d.f.ip6.arpa." nodefault
673         # local-zone: "8.e.f.ip6.arpa." nodefault
674         # local-zone: "9.e.f.ip6.arpa." nodefault
675         # local-zone: "a.e.f.ip6.arpa." nodefault
676         # local-zone: "b.e.f.ip6.arpa." nodefault
677         # local-zone: "8.b.d.0.1.0.0.2.ip6.arpa." nodefault
678         # And for 64.100.in-addr.arpa. to 127.100.in-addr.arpa.
679
680         # Add example.com into ipset
681         # local-zone: "example.com" ipset
682
683         # If unbound is running service for the local host then it is useful
684         # to perform lan-wide lookups to the upstream, and unblock the
685         # long list of local-zones above.  If this unbound is a dns server
686         # for a network of computers, disabled is better and stops information
687         # leakage of local lan information.
688         # unblock-lan-zones: no
689
690         # The insecure-lan-zones option disables validation for
691         # these zones, as if they were all listed as domain-insecure.
692         # insecure-lan-zones: no
693
694         # a number of locally served zones can be configured.
695         #       local-zone: <zone> <type>
696         #       local-data: "<resource record string>"
697         # o deny serves local data (if any), else, drops queries.
698         # o refuse serves local data (if any), else, replies with error.
699         # o static serves local data, else, nxdomain or nodata answer.
700         # o transparent gives local data, but resolves normally for other names
701         # o redirect serves the zone data for any subdomain in the zone.
702         # o nodefault can be used to normally resolve AS112 zones.
703         # o typetransparent resolves normally for other types and other names
704         # o inform acts like transparent, but logs client IP address
705         # o inform_deny drops queries and logs client IP address
706         # o inform_redirect redirects queries and logs client IP address
707         # o always_transparent, always_refuse, always_nxdomain, resolve in
708         #   that way but ignore local data for that name
709         # o noview breaks out of that view towards global local-zones.
710         #
711         # defaults are localhost address, reverse for 127.0.0.1 and ::1
712         # and nxdomain for AS112 zones. If you configure one of these zones
713         # the default content is omitted, or you can omit it with 'nodefault'.
714         #
715         # If you configure local-data without specifying local-zone, by
716         # default a transparent local-zone is created for the data.
717         #
718         # You can add locally served data with
719         # local-zone: "local." static
720         # local-data: "mycomputer.local. IN A 192.0.2.51"
721         # local-data: 'mytext.local TXT "content of text record"'
722         #
723         # You can override certain queries with
724         # local-data: "adserver.example.com A 127.0.0.1"
725         #
726         # You can redirect a domain to a fixed address with
727         # (this makes example.com, www.example.com, etc, all go to 192.0.2.3)
728         # local-zone: "example.com" redirect
729         # local-data: "example.com A 192.0.2.3"
730         #
731         # Shorthand to make PTR records, "IPv4 name" or "IPv6 name".
732         # You can also add PTR records using local-data directly, but then
733         # you need to do the reverse notation yourself.
734         # local-data-ptr: "192.0.2.3 www.example.com"
735
736         # tag a localzone with a list of tag names (in "" with spaces between)
737         # local-zone-tag: "example.com" "tag2 tag3"
738
739         # add a netblock specific override to a localzone, with zone type
740         # local-zone-override: "example.com" 192.0.2.0/24 refuse
741
742         # service clients over TLS (on the TCP sockets) with plain DNS inside
743         # the TLS stream, and over HTTPS using HTTP/2 as specified in RFC8484.
744         # Give the certificate to use and private key.
745         # default is "" (disabled).  requires restart to take effect.
746         # tls-service-key: "path/to/privatekeyfile.key"
747         # tls-service-pem: "path/to/publiccertfile.pem"
748         # tls-port: 853
749         # https-port: 443
750
751         # cipher setting for TLSv1.2
752         # tls-ciphers: "DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256"
753         # cipher setting for TLSv1.3
754         # tls-ciphersuites: "TLS_AES_128_GCM_SHA256:TLS_AES_128_CCM_8_SHA256:TLS_AES_128_CCM_SHA256:TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256"
755
756         # Use the SNI extension for TLS connections.  Default is yes.
757         # Changing the value requires a reload.
758         # tls-use-sni: yes
759
760         # Add the secret file for TLS Session Ticket.
761         # Secret file must be 80 bytes of random data.
762         # First key use to encrypt and decrypt TLS session tickets.
763         # Other keys use to decrypt only.
764         # requires restart to take effect.
765         # tls-session-ticket-keys: "path/to/secret_file1"
766         # tls-session-ticket-keys: "path/to/secret_file2"
767
768         # request upstream over TLS (with plain DNS inside the TLS stream).
769         # Default is no.  Can be turned on and off with unbound-control.
770         # tls-upstream: no
771
772         # Certificates used to authenticate connections made upstream.
773         # tls-cert-bundle: ""
774
775         # Add system certs to the cert bundle, from the Windows Cert Store
776         # tls-win-cert: no
777
778         # Also serve tls on these port numbers (eg. 443, ...), by listing
779         # tls-additional-port: portno for each of the port numbers.
780
781         # HTTP endpoint to provide DNS-over-HTTPS service on.
782         # http-endpoint: "/dns-query"
783
784         # HTTP/2 SETTINGS_MAX_CONCURRENT_STREAMS value to use.
785         # http-max-streams: 100
786
787         # Maximum number of bytes used for all HTTP/2 query buffers.
788         # http-query-buffer-size: 4m
789
790         # Maximum number of bytes used for all HTTP/2 response buffers.
791         # http-response-buffer-size: 4m
792
793         # Set TCP_NODELAY socket option on sockets used for DNS-over-HTTPS
794         # service.
795         # http-nodelay: yes
796
797         # Disable TLS for DNS-over-HTTP downstream service.
798         # http-notls-downstream: no
799
800         # DNS64 prefix. Must be specified when DNS64 is use.
801         # Enable dns64 in module-config.  Used to synthesize IPv6 from IPv4.
802         # dns64-prefix: 64:ff9b::0/96
803
804         # DNS64 ignore AAAA records for these domains and use A instead.
805         # dns64-ignore-aaaa: "example.com"
806
807         # ratelimit for uncached, new queries, this limits recursion effort.
808         # ratelimiting is experimental, and may help against randomqueryflood.
809         # if 0(default) it is disabled, otherwise state qps allowed per zone.
810         # ratelimit: 0
811
812         # ratelimits are tracked in a cache, size in bytes of cache (or k,m).
813         # ratelimit-size: 4m
814         # ratelimit cache slabs, reduces lock contention if equal to cpucount.
815         # ratelimit-slabs: 4
816
817         # 0 blocks when ratelimited, otherwise let 1/xth traffic through
818         # ratelimit-factor: 10
819
820         # override the ratelimit for a specific domain name.
821         # give this setting multiple times to have multiple overrides.
822         # ratelimit-for-domain: example.com 1000
823         # override the ratelimits for all domains below a domain name
824         # can give this multiple times, the name closest to the zone is used.
825         # ratelimit-below-domain: com 1000
826
827         # global query ratelimit for all ip addresses.
828         # feature is experimental.
829         # if 0(default) it is disabled, otherwise states qps allowed per ip address
830         # ip-ratelimit: 0
831
832         # ip ratelimits are tracked in a cache, size in bytes of cache (or k,m).
833         # ip-ratelimit-size: 4m
834         # ip ratelimit cache slabs, reduces lock contention if equal to cpucount.
835         # ip-ratelimit-slabs: 4
836
837         # 0 blocks when ip is ratelimited, otherwise let 1/xth traffic through
838         # ip-ratelimit-factor: 10
839
840         # Limit the number of connections simultaneous from a netblock
841         # tcp-connection-limit: 192.0.2.0/24 12
842
843         # select from the fastest servers this many times out of 1000. 0 means
844         # the fast server select is disabled. prefetches are not sped up.
845         # fast-server-permil: 0
846         # the number of servers that will be used in the fast server selection.
847         # fast-server-num: 3
848
849         # Specific options for ipsecmod. unbound needs to be configured with
850         # --enable-ipsecmod for these to take effect.
851         #
852         # Enable or disable ipsecmod (it still needs to be defined in
853         # module-config above). Can be used when ipsecmod needs to be
854         # enabled/disabled via remote-control(below).
855         # ipsecmod-enabled: yes
856         #
857         # Path to executable external hook. It must be defined when ipsecmod is
858         # listed in module-config (above).
859         # ipsecmod-hook: "./my_executable"
860         #
861         # When enabled unbound will reply with SERVFAIL if the return value of
862         # the ipsecmod-hook is not 0.
863         # ipsecmod-strict: no
864         #
865         # Maximum time to live (TTL) for cached A/AAAA records with IPSECKEY.
866         # ipsecmod-max-ttl: 3600
867         #
868         # Reply with A/AAAA even if the relevant IPSECKEY is bogus. Mainly used for
869         # testing.
870         # ipsecmod-ignore-bogus: no
871         #
872         # Domains for which ipsecmod will be triggered. If not defined (default)
873         # all domains are treated as being allowed.
874         # ipsecmod-allow: "example.com"
875         # ipsecmod-allow: "nlnetlabs.nl"
876
877
878 # Python config section. To enable:
879 # o use --with-pythonmodule to configure before compiling.
880 # o list python in the module-config string (above) to enable.
881 #   It can be at the start, it gets validated results, or just before
882 #   the iterator and process before DNSSEC validation.
883 # o and give a python-script to run.
884 python:
885         # Script file to load
886         # python-script: "@UNBOUND_SHARE_DIR@/ubmodule-tst.py"
887
888 # Dynamic library config section. To enable:
889 # o use --with-dynlibmodule to configure before compiling.
890 # o list dynlib in the module-config string (above) to enable.
891 #   It can be placed anywhere, the dynlib module is only a very thin wrapper
892 #   to load modules dynamically.
893 # o and give a dynlib-file to run. If more than one dynlib entry is listed in
894 #   the module-config then you need one dynlib-file per instance.
895 dynlib:
896         # Script file to load
897         # dynlib-file: "@UNBOUND_SHARE_DIR@/dynlib.so"
898
899 # Remote control config section.
900 remote-control:
901         # Enable remote control with unbound-control(8) here.
902         # set up the keys and certificates with unbound-control-setup.
903         # control-enable: no
904
905         # what interfaces are listened to for remote control.
906         # give 0.0.0.0 and ::0 to listen to all interfaces.
907         # set to an absolute path to use a unix local name pipe, certificates
908         # are not used for that, so key and cert files need not be present.
909         # control-interface: 127.0.0.1
910         # control-interface: ::1
911
912         # port number for remote control operations.
913         # control-port: 8953
914
915         # for localhost, you can disable use of TLS by setting this to "no"
916         # For local sockets this option is ignored, and TLS is not used.
917         # control-use-cert: "yes"
918
919         # unbound server key file.
920         # server-key-file: "@UNBOUND_RUN_DIR@/unbound_server.key"
921
922         # unbound server certificate file.
923         # server-cert-file: "@UNBOUND_RUN_DIR@/unbound_server.pem"
924
925         # unbound-control key file.
926         # control-key-file: "@UNBOUND_RUN_DIR@/unbound_control.key"
927
928         # unbound-control certificate file.
929         # control-cert-file: "@UNBOUND_RUN_DIR@/unbound_control.pem"
930
931 # Stub zones.
932 # Create entries like below, to make all queries for 'example.com' and
933 # 'example.org' go to the given list of nameservers. list zero or more
934 # nameservers by hostname or by ipaddress. If you set stub-prime to yes,
935 # the list is treated as priming hints (default is no).
936 # With stub-first yes, it attempts without the stub if it fails.
937 # Consider adding domain-insecure: name and local-zone: name nodefault
938 # to the server: section if the stub is a locally served zone.
939 # stub-zone:
940 #       name: "example.com"
941 #       stub-addr: 192.0.2.68
942 #       stub-prime: no
943 #       stub-first: no
944 #       stub-tls-upstream: no
945 #       stub-no-cache: no
946 # stub-zone:
947 #       name: "example.org"
948 #       stub-host: ns.example.com.
949
950 # Forward zones
951 # Create entries like below, to make all queries for 'example.com' and
952 # 'example.org' go to the given list of servers. These servers have to handle
953 # recursion to other nameservers. List zero or more nameservers by hostname
954 # or by ipaddress. Use an entry with name "." to forward all queries.
955 # If you enable forward-first, it attempts without the forward if it fails.
956 # forward-zone:
957 #       name: "example.com"
958 #       forward-addr: 192.0.2.68
959 #       forward-addr: 192.0.2.73@5355  # forward to port 5355.
960 #       forward-first: no
961 #       forward-tls-upstream: no
962 #       forward-no-cache: no
963 # forward-zone:
964 #       name: "example.org"
965 #       forward-host: fwd.example.com
966
967 # Authority zones
968 # The data for these zones is kept locally, from a file or downloaded.
969 # The data can be served to downstream clients, or used instead of the
970 # upstream (which saves a lookup to the upstream).  The first example
971 # has a copy of the root for local usage.  The second serves example.org
972 # authoritatively.  zonefile: reads from file (and writes to it if you also
973 # download it), primary: fetches with AXFR and IXFR, or url to zonefile.
974 # With allow-notify: you can give additional (apart from primaries) sources of
975 # notifies.
976 # auth-zone:
977 #       name: "."
978 #       primary: 199.9.14.201         # b.root-servers.net
979 #       primary: 192.33.4.12          # c.root-servers.net
980 #       primary: 199.7.91.13          # d.root-servers.net
981 #       primary: 192.5.5.241          # f.root-servers.net
982 #       primary: 192.112.36.4         # g.root-servers.net
983 #       primary: 193.0.14.129         # k.root-servers.net
984 #       primary: 192.0.47.132         # xfr.cjr.dns.icann.org
985 #       primary: 192.0.32.132         # xfr.lax.dns.icann.org
986 #       primary: 2001:500:200::b      # b.root-servers.net
987 #       primary: 2001:500:2::c        # c.root-servers.net
988 #       primary: 2001:500:2d::d       # d.root-servers.net
989 #       primary: 2001:500:2f::f       # f.root-servers.net
990 #       primary: 2001:500:12::d0d     # g.root-servers.net
991 #       primary: 2001:7fd::1          # k.root-servers.net
992 #       primary: 2620:0:2830:202::132 # xfr.cjr.dns.icann.org
993 #       primary: 2620:0:2d0:202::132  # xfr.lax.dns.icann.org
994 #       fallback-enabled: yes
995 #       for-downstream: no
996 #       for-upstream: yes
997 # auth-zone:
998 #       name: "example.org"
999 #       for-downstream: yes
1000 #       for-upstream: yes
1001 #       zonefile: "example.org.zone"
1002
1003 # Views
1004 # Create named views. Name must be unique. Map views to requests using
1005 # the access-control-view option. Views can contain zero or more local-zone
1006 # and local-data options. Options from matching views will override global
1007 # options. Global options will be used if no matching view is found.
1008 # With view-first yes, it will try to answer using the global local-zone and
1009 # local-data elements if there is no view specific match.
1010 # view:
1011 #       name: "viewname"
1012 #       local-zone: "example.com" redirect
1013 #       local-data: "example.com A 192.0.2.3"
1014 #       local-data-ptr: "192.0.2.3 www.example.com"
1015 #       view-first: no
1016 # view:
1017 #       name: "anotherview"
1018 #       local-zone: "example.com" refuse
1019
1020 # DNSCrypt
1021 # Caveats:
1022 # 1. the keys/certs cannot be produced by unbound. You can use dnscrypt-wrapper
1023 #   for this: https://github.com/cofyc/dnscrypt-wrapper/blob/master/README.md#usage
1024 # 2. dnscrypt channel attaches to an interface. you MUST set interfaces to
1025 #   listen on `dnscrypt-port` with the follo0wing snippet:
1026 # server:
1027 #     interface: 0.0.0.0@443
1028 #     interface: ::0@443
1029 #
1030 # Finally, `dnscrypt` config has its own section.
1031 # dnscrypt:
1032 #     dnscrypt-enable: yes
1033 #     dnscrypt-port: 443
1034 #     dnscrypt-provider: 2.dnscrypt-cert.example.com.
1035 #     dnscrypt-secret-key: /path/unbound-conf/keys1/1.key
1036 #     dnscrypt-secret-key: /path/unbound-conf/keys2/1.key
1037 #     dnscrypt-provider-cert: /path/unbound-conf/keys1/1.cert
1038 #     dnscrypt-provider-cert: /path/unbound-conf/keys2/1.cert
1039
1040 # CacheDB
1041 # Enable external backend DB as auxiliary cache.  Specify the backend name
1042 # (default is "testframe", which has no use other than for debugging and
1043 # testing) and backend-specific options.  The 'cachedb' module must be
1044 # included in module-config, just before the iterator module.
1045 # cachedb:
1046 #     backend: "testframe"
1047 #     # secret seed string to calculate hashed keys
1048 #     secret-seed: "default"
1049 #
1050 #     # For "redis" backend:
1051 #     # redis server's IP address or host name
1052 #     redis-server-host: 127.0.0.1
1053 #     # redis server's TCP port
1054 #     redis-server-port: 6379
1055 #     # timeout (in ms) for communication with the redis server
1056 #     redis-timeout: 100
1057 #     # set timeout on redis records based on DNS response TTL
1058 #     redis-expire-records: no
1059
1060 # IPSet
1061 # Add specify domain into set via ipset.
1062 # Note: To enable ipset unbound needs to run as root user.
1063 # ipset:
1064 #     # set name for ip v4 addresses
1065 #     name-v4: "list-v4"
1066 #     # set name for ip v6 addresses
1067 #     name-v6: "list-v6"
1068 #
1069
1070 # Dnstap logging support, if compiled in.  To enable, set the dnstap-enable
1071 # to yes and also some of dnstap-log-..-messages to yes.  And select an
1072 # upstream log destination, by socket path, TCP or TLS destination.
1073 # dnstap:
1074 #       dnstap-enable: no
1075 #       # if set to yes frame streams will be used in bidirectional mode
1076 #       dnstap-bidirectional: yes
1077 #       dnstap-socket-path: "@DNSTAP_SOCKET_PATH@"
1078 #       # if "" use the unix socket in dnstap-socket-path, otherwise,
1079 #       # set it to "IPaddress[@port]" of the destination.
1080 #       dnstap-ip: ""
1081 #       # if set to yes if you want to use TLS to dnstap-ip, no for TCP.
1082 #       dnstap-tls: yes
1083 #       # name for authenticating the upstream server. or "" disabled.
1084 #       dnstap-tls-server-name: ""
1085 #       # if "", it uses the cert bundle from the main unbound config.
1086 #       dnstap-tls-cert-bundle: ""
1087 #       # key file for client authentication, or "" disabled.
1088 #       dnstap-tls-client-key-file: ""
1089 #       # cert file for client authentication, or "" disabled.
1090 #       dnstap-tls-client-cert-file: ""
1091 #       dnstap-send-identity: no
1092 #       dnstap-send-version: no
1093 #       # if "" it uses the hostname.
1094 #       dnstap-identity: ""
1095 #       # if "" it uses the package version.
1096 #       dnstap-version: ""
1097 #       dnstap-log-resolver-query-messages: no
1098 #       dnstap-log-resolver-response-messages: no
1099 #       dnstap-log-client-query-messages: no
1100 #       dnstap-log-client-response-messages: no
1101 #       dnstap-log-forwarder-query-messages: no
1102 #       dnstap-log-forwarder-response-messages: no
1103
1104 # Response Policy Zones
1105 # RPZ policies. Applied in order of configuration. QNAME and Response IP
1106 # Address trigger are the only supported triggers. Supported actions are:
1107 # NXDOMAIN, NODATA, PASSTHRU, DROP and Local Data. Policies can be loaded from
1108 # file, using zone transfer, or using HTTP. The respip module needs to be added
1109 # to the module-config, e.g.: module-config: "respip validator iterator".
1110 # rpz:
1111 #     name: "rpz.example.com"
1112 #     zonefile: "rpz.example.com"
1113 #     primary: 192.0.2.0
1114 #     allow-notify: 192.0.2.0/32
1115 #     url: http://www.example.com/rpz.example.org.zone
1116 #     rpz-action-override: cname
1117 #     rpz-cname-override: www.example.org
1118 #     rpz-log: yes
1119 #     rpz-log-name: "example policy"
1120 #     tags: "example"