mirror of
https://github.com/NLnetLabs/unbound.git
synced 2025-12-18 23:06:06 -05:00
3d89c26d32
* - dnsoverquic, configure --with-libngtcp2 option. * - dnsoverquic, create comm_point for doq and receive cmsg local address. * - dnsoverquic, less obtrusive debug. * - dnsoverquic, log and fix local port number. Neater subroutines and ifdefs. * - dnsoverquic, add testcode/doqclient. * - dnsoverquic, review fixes on doqclient. * - dnsoverquic, fix unit test testbound link. * - dnsoverquic, parse query in doqclient. * - dnsoverquic, link with libngtcp2_crypto_openssl and code for doqclient. * - dnsoverquic, random routine for doqclient and fix ngaddr allocation, and check ub_initstate return. * - dnsoverquic, fix doqclient free of allocated ngaddr addresses. * - dnsoverquic, enable debug output with -v for doqclient. * - dnsoverquic, create and set TLS object and TLS context in doqclient. * - dnsoverquic, work on quic tls context in doqclient. * - dnsoverquic, set default dnsoverquic port to the standardized 853 port. * - dnsoverquic, remove debug comment. * - dnsoverquic, dns-over-quic quic-port: 853 config option. * - dnsoverquic, log type of interface created at start of unbound. * - dnsoverquic, log type of no tls https as https when interface is created. * - dnsoverquic, setup client quic tls methods. * - dnsoverquic, event work in doqclient. * - dnsoverquic, explain in documentation that QUIC uses UDP. * - dnsoverquic, make doqclient exit. * - dnsoverquic, doqclient cleanup run routine. * - dnsoverquic, doqclient code nicer. * - dnsoverquic, doqclient read and timer. * - dnsoverquic, doqclient write work. * - dnsoverquic, review fixes. * - dnsoverquic, detect openssl quic support at configure time. * - dnsoverquic, do not allow QUIC on port 53 to stop confusion of DoQ and DNS. * - dnsoverquic, in doqclient, when idle close is returned, drop the connection without calling ngtcp2_conn_write_connection_close. * - dnsoverquic, in doqclient, log callbacks. * - dnsoverquic, in doqclient add extend_max_local_streams_bidi callback. * - dnsoverquic, in doqclient add client query lists. * - dnsoverquic, in doqclient, code cleaner, log text nicer. * - dnsoverquic, in doqclient, work on write_streams. * - dnsoverquic, in doqclient, use signed int for stream_id, work on the ngtcp2_recv_stream_data callback. * - dnsoverquic, in doqclient, print result and fixes for recv data. * - dnsoverquic, in doqclient, add the event callbacks to fptr wlist. * - dnsoverquic, in doqclient, when already expired, use zero timeout timer. * - dnsoverquic, in doqclient, ignore unused return codes from ngtcp2_conn_writev_stream. * - dnsoverquic, add doqclient event functions to the unbound-dnstap-socket test tool for linking. * - dnsoverquic, in doqclient, fix multiple operands for the commandline. neater dns message output. * - dnsoverquic, in doqclient, store packet when write blocks and try later. * - dnsoverquic, in doqclient, limit number of packets and number of bytes sent. * - dnsoverquic, in doqclient, better size estimate for outgoing packet. * - dnsoverquic, in doqclient, fix that already written next packet is not counted for data length to send. * - dnsoverquic, in doqclient, early data transmission and session resumption. * - dnsoverquic, send version negotiation packet. * - dnsoverquic, send retry and accept the connection. * - dnsoverquic, storage structures. * - dnsoverquic, doq connection setup. * - dnsoverquic, neater code layout for new conn. Fix verbosity of log print. * - dnsoverquic, doq conn callback functions. * - dnsoverquic, doq_fill_rand routine in header file. * - dnsoverquic, keep track of connection ids. * - dnsoverquic, get_new_connection_id callback. * - dnsoverquic, create doq_conid tree. * - dnsoverquic, settings for server connection. * - dnsoverquic, tls context. * - dnsoverquic, sendmsg error handling. * - dnsoverquic, neat code. * - dnsoverquic, track doq connection last error. * - dnsoverquic, neater packet address parameters. * - dnsoverquic, fix uninitialized bytes in msg control in doq sendmsg, and fix tree cleanup of conid tree. * - dnsoverquic, better usage text for doqclient. * - dnsoverquic, neat code. * - dnsoverquic, connection receive packet handling. * - dnsoverquic, debug output. * - dnsoverquic, debug switched meaning of scid and dcid gives ERR_TRANSPORT_PARAM. * - dnsoverquic, remove debug output. * - dnsoverquic, connection delete routine and error from connection read in more detail with less clutter. * - dnsoverquic, write to stream, and receive stream data, log packet. * - dnsoverquic, alpn set up. * - dnsoverquic, connection close. * - dnsoverquic, doq_table and locks. * - dnsoverquic, fix tests. * - dnsoverquic, better locking. * - dnsoverquic, doq_stream. * - dnsoverquic, remove compile warning. * - dnsoverquic, doq_stream receive data. * - dnsoverquic, fixes for locks and keep length bytes allocated. * - dnsoverquic, lock connection on initial insertion. * - dnsoverquic, reply information, and reply buffer. * - dnsoverquic, reply info from cache, local-zone and recursion lookups. * - dnsoverquic, spelling in comment about buffer storage. * - dnsoverquic, stream write list and doqclient fixes to exit and printout. * - dnsoverquic, doqclient -q option for short printout. * - dnsoverquic, unit test with local data reply. * - dnsoverquic, write connection and write event is set. * - dnsoverquic, neater logging for write event connection stream writes. * - dnsoverquic, log remote connection when the streams are written for it. * - dnsoverquic, better threaded use, threads can write to doq connections at the same time. * - dnsoverquic, unit test for the calculation of connection size with a query. * - dnsoverquic, use less memory per connection. * - dnsoverquic, remove unit test output. * - dnsoverquic, add MSG_DONTWAIT so that there is no mistakenly blocking socket operations. * - dnsoverquic, doqclient logs address on connection failures. * - dnsoverquic, compat code for clock get time routine. * - dnsoverquic, use skip_test for doq unit test. * - dnsoverquic, fixes for proxyprotocol, use remote_addr and set proxyprotocol disabled on the doq connection. * - dnsoverquic, doqclient sets log identity to its name, instead of "unbound". * - dnsoverquic, handle blocked udp packet writes. * - dnsoverquic, fix function documentation for verbose_print_addr from services/listen_dnsport.c. * - dnsoverquic, fix doq_conn lock protection. The checklock allows to set the output file name, and doqclient uses that. Print place of lock_protect. * - dnsoverquic, neater buffer clear when write of blocked packet fails, make sure that memory area does not overlap for blocked packet addresses when write of blocked packet fails, and size blocked packet buffer to the pkt buf. * - dnsoverquic, move lock check after the test to test script in doq test. * - dnsoverquic, the doq test uses valgrind when enabled. * - dnsoverquic, git ignore the doqclient test. * - dnsoverquic, limit the buffer for packets to max packet size with some more. * - dnsoverquic, spelling fix. * - dnsoverquic, timer work, structure and adds and deletes. * - dnsoverquic, timer_tree uses table.lock. * - dnsoverquic, fix timer tree remove and spelling in header file comment. * - dnsoverquic, fix testbound for timer compare function linkage. * - dnsoverquic, timer set add debug output. * - dnsoverquic, doq_conn_check_timer function. * - dnsoverquic, doq_done_setup_timer_and_write function. * - dnsoverquic, fix that doq conn is not deleted whilst editing write and timer. * - dnsoverquic, Fix #861 make ERROR netevent.h:1073:32: error: field 'blocked_pkt_pi' has incomplete type * - dnsoverquic, timer element has timeout setup when socket callback complete. * - dnsoverquic, fix unit test compile. * - dnsoverquic, timer callback routine, handle timeout and close and delete the connection if necessary. * - dnsoverquic, timer pickup stops at current time. * - dnsoverquic, timer comparable with the event base time. * - dnsoverquic, erase marked time when timer disabled. * - dnsoverquic, fix timer to set correctly and lock popped write connection early, before it is modified. * - dnsoverquic, fix to unlock connection lock when it is unlinked and deleted. * - dnsoverquic, fix to unlock connection lock when it is deleted because it is a duplicate connection. * - dnsoverquic, fix that doq timer is not disabled when not set. * - dnsoverquic, quic-size: 8m maximum number of bytes for QUIC buffers. * - dnsoverquic, flex and bison. * - dnsoverquic, quic-size turn away new connections when full. * - dnsoverquic, doqclient outputs stream reset information. * - dnsoverquic, detect stream close and reset. * - dnsoverquic, free stream buffers when data is acked and stream is closed. * - dnsoverquic, delete stream when closed. Unlink it. Allow stream_id 4 as first. * - dnsoverquic, stats output for mem.quic and num.query.quic. * - dnsoverquic, review fix. * - dnsoverquic, fix when compiled without ngtcp2. * - dnsoverquic, fix to detect ngtcp2_crypto_quictls for openssl crypto, after change in libngtcp2. * - dnsoverquic, fix for newer ngtcp2 versions. detect ngtcp2_ccerr_default, ngtcp2/ngtcp2_crypto_quictls.h, struct ngtcp2_pkt_hd.tokenlen, struct ngtcp2_settings.tokenlen and struct ngtcp2_version_cid. * - dnsoverquic, fix for newer ngtcp2 version, detect number of arguments for ngtcp2_conn_shutdown_stream. * - dnsoverquic, fix for newer ngtcp2. * - dnsoverquic, use the functions from util/timeval_func.h. * - dnsoverquic, fix in doqclient only write transport parameters once. * - dnsoverquic, debug log output removed. * - dnsoverquic, fix in doqclient to work with renamed NGTCP2_CC_ALGO_BBR_V2 from ngtcp2. * - dnsoverquic, fix to check in doq_server_socket_create that tls-service-key and tls-service-pem have a value. * - dnsoverquic, fix to error when doq_server_socket_create fails. * - dnsoverquic, improve linebreaks in configparser additions. * - dnsoverquic, fix port from interface pickup after main branch change. * Fix getting user data from SSL, fix calloc warning. * Fix fwrite return value check in doqclient * - timeval_substruct from timeval_func.h - lock_protect also for HAVE_NGTCP2_CCERR_DEFAULT - fix doq logging for inet_ntop failures * - memset for consistency - no value returned from msghdr_get_ecn when S_SPLINT_S is defined * - dnsoverquic, rerun autoconf. --------- Co-authored-by: Yorgos Thessalonikefs <yorgos@nlnetlabs.nl>
815 lines
31 KiB
Groff
815 lines
31 KiB
Groff
.TH "unbound-control" "8" "@date@" "NLnet Labs" "unbound @version@"
|
|
.\"
|
|
.\" unbound-control.8 -- unbound remote control manual
|
|
.\"
|
|
.\" Copyright (c) 2008, NLnet Labs. All rights reserved.
|
|
.\"
|
|
.\" See LICENSE for the license.
|
|
.\"
|
|
.\"
|
|
.SH "NAME"
|
|
.B unbound\-control,
|
|
.B unbound\-control\-setup
|
|
\- Unbound remote server control utility.
|
|
.SH "SYNOPSIS"
|
|
.B unbound\-control
|
|
.RB [ \-hq ]
|
|
.RB [ \-c
|
|
.IR cfgfile ]
|
|
.RB [ \-s
|
|
.IR server ]
|
|
.IR command
|
|
.SH "DESCRIPTION"
|
|
.B Unbound\-control
|
|
performs remote administration on the \fIunbound\fR(8) DNS server.
|
|
It reads the configuration file, contacts the Unbound server over SSL
|
|
sends the command and displays the result.
|
|
.P
|
|
The available options are:
|
|
.TP
|
|
.B \-h
|
|
Show the version and commandline option help.
|
|
.TP
|
|
.B \-c \fIcfgfile
|
|
The config file to read with settings. If not given the default
|
|
config file @ub_conf_file@ is used.
|
|
.TP
|
|
.B \-s \fIserver[@port]
|
|
IPv4 or IPv6 address of the server to contact. If not given, the
|
|
address is read from the config file.
|
|
.TP
|
|
.B \-q
|
|
quiet, if the option is given it does not print anything if it works ok.
|
|
.SH "COMMANDS"
|
|
There are several commands that the server understands.
|
|
.TP
|
|
.B start
|
|
Start the server. Simply execs \fIunbound\fR(8). The Unbound executable
|
|
is searched for in the \fBPATH\fR set in the environment. It is started
|
|
with the config file specified using \fI\-c\fR or the default config file.
|
|
.TP
|
|
.B stop
|
|
Stop the server. The server daemon exits.
|
|
.TP
|
|
.B reload
|
|
Reload the server. This flushes the cache and reads the config file fresh.
|
|
.TP
|
|
.B reload_keep_cache
|
|
Reload the server but try to keep the RRset and message cache if
|
|
(re)configuration allows for it.
|
|
That means the caches sizes and the number of threads must not change between
|
|
reloads.
|
|
.TP
|
|
.B verbosity \fInumber
|
|
Change verbosity value for logging. Same values as \fBverbosity\fR keyword in
|
|
\fIunbound.conf\fR(5). This new setting lasts until the server is issued
|
|
a reload (taken from config file again), or the next verbosity control command.
|
|
.TP
|
|
.B log_reopen
|
|
Reopen the logfile, close and open it. Useful for logrotation to make the
|
|
daemon release the file it is logging to. If you are using syslog it will
|
|
attempt to close and open the syslog (which may not work if chrooted).
|
|
.TP
|
|
.B stats
|
|
Print statistics. Resets the internal counters to zero, this can be
|
|
controlled using the \fBstatistics\-cumulative\fR config statement.
|
|
Statistics are printed with one [name]: [value] per line.
|
|
.TP
|
|
.B stats_noreset
|
|
Peek at statistics. Prints them like the \fBstats\fR command does, but does not
|
|
reset the internal counters to zero.
|
|
.TP
|
|
.B status
|
|
Display server status. Exit code 3 if not running (the connection to the
|
|
port is refused), 1 on error, 0 if running.
|
|
.TP
|
|
.B local_zone \fIname\fR \fItype
|
|
Add new local zone with name and type. Like \fBlocal\-zone\fR config statement.
|
|
If the zone already exists, the type is changed to the given argument.
|
|
.TP
|
|
.B local_zone_remove \fIname
|
|
Remove the local zone with the given name. Removes all local data inside
|
|
it. If the zone does not exist, the command succeeds.
|
|
.TP
|
|
.B local_data \fIRR data...
|
|
Add new local data, the given resource record. Like \fBlocal\-data\fR
|
|
config statement, except for when no covering zone exists. In that case
|
|
this remote control command creates a transparent zone with the same
|
|
name as this record.
|
|
.TP
|
|
.B local_data_remove \fIname
|
|
Remove all RR data from local name. If the name already has no items,
|
|
nothing happens. Often results in NXDOMAIN for the name (in a static zone),
|
|
but if the name has become an empty nonterminal (there is still data in
|
|
domain names below the removed name), NOERROR nodata answers are the
|
|
result for that name.
|
|
.TP
|
|
.B local_zones
|
|
Add local zones read from stdin of unbound\-control. Input is read per line,
|
|
with name space type on a line. For bulk additions.
|
|
.TP
|
|
.B local_zones_remove
|
|
Remove local zones read from stdin of unbound\-control. Input is one name per
|
|
line. For bulk removals.
|
|
.TP
|
|
.B local_datas
|
|
Add local data RRs read from stdin of unbound\-control. Input is one RR per
|
|
line. For bulk additions.
|
|
.TP
|
|
.B local_datas_remove
|
|
Remove local data RRs read from stdin of unbound\-control. Input is one name per
|
|
line. For bulk removals.
|
|
.TP
|
|
.B dump_cache
|
|
The content of the cache is printed in a text format to stdout.
|
|
You can redirect it to a file to store the cache in a file.
|
|
Not supported in remote Unbounds in multi-process operation.
|
|
.TP
|
|
.B load_cache
|
|
The content of the cache is loaded from stdin.
|
|
Uses the same format as dump_cache uses.
|
|
Loading the cache with old, or wrong data can result in old or wrong data
|
|
returned to clients.
|
|
Loading data into the cache in this way is supported in order to aid with
|
|
debugging.
|
|
Not supported in remote Unbounds in multi-process operation.
|
|
.TP
|
|
.B lookup \fIname
|
|
Print to stdout the name servers that would be used to look up the
|
|
name specified.
|
|
.TP
|
|
.B flush \fR[\fI+c\fR] \fIname
|
|
Remove the name from the cache. Removes the types
|
|
A, AAAA, NS, SOA, CNAME, DNAME, MX, PTR, SRV, NAPTR, SVCB and HTTPS.
|
|
Because that is fast to do. Other record types can be removed using
|
|
.B flush_type
|
|
or
|
|
.B flush_zone\fR.
|
|
.IP
|
|
The '+c' option removes the items also from the cachedb cache. If
|
|
cachedb is in use.
|
|
.TP
|
|
.B flush_type \fR[\fI+c\fR] \fIname\fR \fItype
|
|
Remove the name, type information from the cache.
|
|
.TP
|
|
.B flush_zone \fR[\fI+c\fR] \fIname
|
|
Remove all information at or below the name from the cache.
|
|
The rrsets and key entries are removed so that new lookups will be performed.
|
|
This needs to walk and inspect the entire cache, and is a slow operation.
|
|
The entries are set to expired in the implementation of this command (so,
|
|
with serve\-expired enabled, it'll serve that information but schedule a
|
|
prefetch for new information).
|
|
.TP
|
|
.B flush_bogus \fR[\fI+c\fR]
|
|
Remove all bogus data from the cache.
|
|
.TP
|
|
.B flush_negative \fR[\fI+c\fR]
|
|
Remove all negative data from the cache. This is nxdomain answers,
|
|
nodata answers and servfail answers. Also removes bad key entries
|
|
(which could be due to failed lookups) from the dnssec key cache, and
|
|
iterator last-resort lookup failures from the rrset cache.
|
|
.TP
|
|
.B flush_stats
|
|
Reset statistics to zero.
|
|
.TP
|
|
.B flush_requestlist
|
|
Drop the queries that are worked on. Stops working on the queries that the
|
|
server is working on now. The cache is unaffected. No reply is sent for
|
|
those queries, probably making those users request again later.
|
|
Useful to make the server restart working on queries with new settings,
|
|
such as a higher verbosity level.
|
|
.TP
|
|
.B dump_requestlist
|
|
Show what is worked on. Prints all queries that the server is currently
|
|
working on. Prints the time that users have been waiting. For internal
|
|
requests, no time is printed. And then prints out the module status.
|
|
This prints the queries from the first thread, and not queries that are
|
|
being serviced from other threads.
|
|
.TP
|
|
.B flush_infra \fIall|IP
|
|
If all then entire infra cache is emptied. If a specific IP address, the
|
|
entry for that address is removed from the cache. It contains EDNS, ping
|
|
and lameness data.
|
|
.TP
|
|
.B dump_infra
|
|
Show the contents of the infra cache.
|
|
.TP
|
|
.B set_option \fIopt: val
|
|
Set the option to the given value without a reload. The cache is
|
|
therefore not flushed. The option must end with a ':' and whitespace
|
|
must be between the option and the value. Some values may not have an
|
|
effect if set this way, the new values are not written to the config file,
|
|
not all options are supported. This is different from the set_option call
|
|
in libunbound, where all values work because Unbound has not been initialized.
|
|
.IP
|
|
The values that work are: statistics\-interval, statistics\-cumulative,
|
|
do\-not\-query\-localhost, harden\-short\-bufsize, harden\-large\-queries,
|
|
harden\-glue, harden\-dnssec\-stripped, harden\-below\-nxdomain,
|
|
harden\-referral\-path, prefetch, prefetch\-key, log\-queries,
|
|
hide\-identity, hide\-version, identity, version, val\-log\-level,
|
|
val\-log\-squelch, ignore\-cd\-flag, add\-holddown, del\-holddown,
|
|
keep\-missing, tcp\-upstream, ssl\-upstream, max\-udp\-size, ratelimit,
|
|
ip\-ratelimit, cache\-max\-ttl, cache\-min\-ttl, cache\-max\-negative\-ttl.
|
|
.TP
|
|
.B get_option \fIopt
|
|
Get the value of the option. Give the option name without a trailing ':'.
|
|
The value is printed. If the value is "", nothing is printed
|
|
and the connection closes. On error 'error ...' is printed (it gives
|
|
a syntax error on unknown option). For some options a list of values,
|
|
one on each line, is printed. The options are shown from the config file
|
|
as modified with set_option. For some options an override may have been
|
|
taken that does not show up with this command, not results from e.g. the
|
|
verbosity and forward control commands. Not all options work, see list_stubs,
|
|
list_forwards, list_local_zones and list_local_data for those.
|
|
.TP
|
|
.B list_stubs
|
|
List the stub zones in use. These are printed one by one to the output.
|
|
This includes the root hints in use.
|
|
.TP
|
|
.B list_forwards
|
|
List the forward zones in use. These are printed zone by zone to the output.
|
|
.TP
|
|
.B list_insecure
|
|
List the zones with domain\-insecure.
|
|
.TP
|
|
.B list_local_zones
|
|
List the local zones in use. These are printed one per line with zone type.
|
|
.TP
|
|
.B list_local_data
|
|
List the local data RRs in use. The resource records are printed.
|
|
.TP
|
|
.B insecure_add \fIzone
|
|
Add a \fBdomain\-insecure\fR for the given zone, like the statement in unbound.conf.
|
|
Adds to the running Unbound without affecting the cache contents (which may
|
|
still be bogus, use \fBflush_zone\fR to remove it), does not affect the config file.
|
|
.TP
|
|
.B insecure_remove \fIzone
|
|
Removes domain\-insecure for the given zone.
|
|
.TP
|
|
.B forward_add \fR[\fI+it\fR] \fIzone addr ...
|
|
Add a new forward zone to running Unbound. With +i option also adds a
|
|
\fIdomain\-insecure\fR for the zone (so it can resolve insecurely if you have
|
|
a DNSSEC root trust anchor configured for other names).
|
|
The addr can be IP4, IP6 or nameserver names, like \fIforward-zone\fR config
|
|
in unbound.conf.
|
|
The +t option sets it to use tls upstream, like \fIforward\-tls\-upstream\fR: yes.
|
|
.TP
|
|
.B forward_remove \fR[\fI+i\fR] \fIzone
|
|
Remove a forward zone from running Unbound. The +i also removes a
|
|
\fIdomain\-insecure\fR for the zone.
|
|
.TP
|
|
.B stub_add \fR[\fI+ipt\fR] \fIzone addr ...
|
|
Add a new stub zone to running Unbound. With +i option also adds a
|
|
\fIdomain\-insecure\fR for the zone. With +p the stub zone is set to prime,
|
|
without it it is set to notprime. The addr can be IP4, IP6 or nameserver
|
|
names, like the \fIstub-zone\fR config in unbound.conf.
|
|
The +t option sets it to use tls upstream, like \fIstub\-tls\-upstream\fR: yes.
|
|
.TP
|
|
.B stub_remove \fR[\fI+i\fR] \fIzone
|
|
Remove a stub zone from running Unbound. The +i also removes a
|
|
\fIdomain\-insecure\fR for the zone.
|
|
.TP
|
|
.B forward \fR[\fIoff\fR | \fIaddr ...\fR ]
|
|
Setup forwarding mode. Configures if the server should ask other upstream
|
|
nameservers, should go to the internet root nameservers itself, or show
|
|
the current config. You could pass the nameservers after a DHCP update.
|
|
.IP
|
|
Without arguments the current list of addresses used to forward all queries
|
|
to is printed. On startup this is from the forward\-zone "." configuration.
|
|
Afterwards it shows the status. It prints off when no forwarding is used.
|
|
.IP
|
|
If \fIoff\fR is passed, forwarding is disabled and the root nameservers
|
|
are used. This can be used to avoid to avoid buggy or non\-DNSSEC supporting
|
|
nameservers returned from DHCP. But may not work in hotels or hotspots.
|
|
.IP
|
|
If one or more IPv4 or IPv6 addresses are given, those are then used to forward
|
|
queries to. The addresses must be separated with spaces. With '@port' the
|
|
port number can be set explicitly (default port is 53 (DNS)).
|
|
.IP
|
|
By default the forwarder information from the config file for the root "." is
|
|
used. The config file is not changed, so after a reload these changes are
|
|
gone. Other forward zones from the config file are not affected by this command.
|
|
.TP
|
|
.B ratelimit_list \fR[\fI+a\fR]
|
|
List the domains that are ratelimited. Printed one per line with current
|
|
estimated qps and qps limit from config. With +a it prints all domains, not
|
|
just the ratelimited domains, with their estimated qps. The ratelimited
|
|
domains return an error for uncached (new) queries, but cached queries work
|
|
as normal.
|
|
.TP
|
|
.B ip_ratelimit_list \fR[\fI+a\fR]
|
|
List the ip addresses that are ratelimited. Printed one per line with current
|
|
estimated qps and qps limit from config. With +a it prints all ips, not
|
|
just the ratelimited ips, with their estimated qps. The ratelimited
|
|
ips are dropped before checking the cache.
|
|
.TP
|
|
.B list_auth_zones
|
|
List the auth zones that are configured. Printed one per line with a status,
|
|
indicating if the zone is expired and current serial number. Configured RPZ
|
|
zones are included.
|
|
.TP
|
|
.B auth_zone_reload \fIzone\fR
|
|
Reload the auth zone (or RPZ zone) from zonefile. The zonefile is read in
|
|
overwriting the current contents of the zone in memory. This changes the auth
|
|
zone contents itself, not the cache contents. Such cache contents exists if
|
|
you set Unbound to validate with for-upstream yes and that can be cleared with
|
|
\fBflush_zone\fR \fIzone\fR.
|
|
.TP
|
|
.B auth_zone_transfer \fIzone\fR
|
|
Transfer the auth zone (or RPZ zone) from master. The auth zone probe sequence
|
|
is started, where the masters are probed to see if they have an updated zone
|
|
(with the SOA serial check). And then the zone is transferred for a newer zone
|
|
version.
|
|
.TP
|
|
.B rpz_enable \fIzone\fR
|
|
Enable the RPZ zone if it had previously been disabled.
|
|
.TP
|
|
.B rpz_disable \fIzone\fR
|
|
Disable the RPZ zone.
|
|
.TP
|
|
.B view_list_local_zones \fIview\fR
|
|
\fIlist_local_zones\fR for given view.
|
|
.TP
|
|
.B view_local_zone \fIview\fR \fIname\fR \fItype
|
|
\fIlocal_zone\fR for given view.
|
|
.TP
|
|
.B view_local_zone_remove \fIview\fR \fIname
|
|
\fIlocal_zone_remove\fR for given view.
|
|
.TP
|
|
.B view_list_local_data \fIview\fR
|
|
\fIlist_local_data\fR for given view.
|
|
.TP
|
|
.B view_local_data \fIview\fR \fIRR data...
|
|
\fIlocal_data\fR for given view.
|
|
.TP
|
|
.B view_local_data_remove \fIview\fR \fIname
|
|
\fIlocal_data_remove\fR for given view.
|
|
.TP
|
|
.B view_local_datas_remove \fIview\fR
|
|
Remove a list of \fIlocal_data\fR for given view from stdin. Like local_datas_remove.
|
|
.TP
|
|
.B view_local_datas \fIview\fR
|
|
Add a list of \fIlocal_data\fR for given view from stdin. Like local_datas.
|
|
.TP
|
|
.B add_cookie_secret <secret>
|
|
Add or replace a cookie secret persistently. <secret> needs to be an 128 bit
|
|
hex string.
|
|
.IP
|
|
Cookie secrets can be either \fIactive\fR or \fIstaging\fR. \fIActive\fR cookie
|
|
secrets are used to create DNS Cookies, but verification of a DNS Cookie
|
|
succeeds with any of the \fIactive\fR or \fIstaging\fR cookie secrets. The
|
|
state of the current cookie secrets can be printed with the
|
|
\fBprint_cookie_secrets\fR command.
|
|
.IP
|
|
When there are no cookie secrets configured yet, the <secret> is added as
|
|
\fIactive\fR. If there is already an \fIactive\fR cookie secret, the <secret>
|
|
is added as \fIstaging\fR or replacing an existing \fIstaging\fR secret.
|
|
.IP
|
|
To "roll" a cookie secret used in an anycast set. The new secret has to be
|
|
added as staging secret to \fBall\fR nodes in the anycast set. When \fBall\fR
|
|
nodes can verify DNS Cookies with the new secret, the new secret can be
|
|
activated with the \fBactivate_cookie_secret\fR command. After \fBall\fR nodes
|
|
have the new secret \fIactive\fR for at least one hour, the previous secret can
|
|
be dropped with the \fBdrop_cookie_secret\fR command.
|
|
.IP
|
|
Persistence is accomplished by writing to a file which if configured with the
|
|
\fBcookie\-secret\-file\fR option in the server section of the config file.
|
|
This is disabled by default, "".
|
|
.TP
|
|
.B drop_cookie_secret
|
|
Drop the \fIstaging\fR cookie secret.
|
|
.TP
|
|
.B activate_cookie_secret
|
|
Make the current \fIstaging\fR cookie secret \fIactive\fR, and the current
|
|
\fIactive\fR cookie secret \fIstaging\fR.
|
|
.TP
|
|
.B print_cookie_secrets
|
|
Show the current configured cookie secrets with their status.
|
|
.SH "EXIT CODE"
|
|
The unbound\-control program exits with status code 1 on error, 0 on success.
|
|
.SH "SET UP"
|
|
The setup requires a self\-signed certificate and private keys for both
|
|
the server and client. The script \fIunbound\-control\-setup\fR generates
|
|
these in the default run directory, or with \-d in another directory.
|
|
If you change the access control permissions on the key files you can decide
|
|
who can use unbound\-control, by default owner and group but not all users.
|
|
Run the script under the same username as you have configured in unbound.conf
|
|
or as root, so that the daemon is permitted to read the files, for example with:
|
|
.nf
|
|
sudo \-u unbound unbound\-control\-setup
|
|
.fi
|
|
If you have not configured
|
|
a username in unbound.conf, the keys need read permission for the user
|
|
credentials under which the daemon is started.
|
|
The script preserves private keys present in the directory.
|
|
After running the script as root, turn on \fBcontrol\-enable\fR in
|
|
\fIunbound.conf\fR.
|
|
.SH "STATISTIC COUNTERS"
|
|
The \fIstats\fR command shows a number of statistic counters.
|
|
.TP
|
|
.I threadX.num.queries
|
|
number of queries received by thread
|
|
.TP
|
|
.I threadX.num.queries_ip_ratelimited
|
|
number of queries rate limited by thread
|
|
.TP
|
|
.I threadX.num.queries_cookie_valid
|
|
number of queries with a valid DNS Cookie by thread
|
|
.TP
|
|
.I threadX.num.queries_cookie_client
|
|
number of queries with a client part only DNS Cookie by thread
|
|
.TP
|
|
.I threadX.num.queries_cookie_invalid
|
|
number of queries with an invalid DNS Cookie by thread
|
|
.TP
|
|
.I threadX.num.cachehits
|
|
number of queries that were successfully answered using a cache lookup
|
|
.TP
|
|
.I threadX.num.cachemiss
|
|
number of queries that needed recursive processing
|
|
.TP
|
|
.I threadX.num.dnscrypt.crypted
|
|
number of queries that were encrypted and successfully decapsulated by dnscrypt.
|
|
.TP
|
|
.I threadX.num.dnscrypt.cert
|
|
number of queries that were requesting dnscrypt certificates.
|
|
.TP
|
|
.I threadX.num.dnscrypt.cleartext
|
|
number of queries received on dnscrypt port that were cleartext and not a
|
|
request for certificates.
|
|
.TP
|
|
.I threadX.num.dnscrypt.malformed
|
|
number of request that were neither cleartext, not valid dnscrypt messages.
|
|
.TP
|
|
.I threadX.num.prefetch
|
|
number of cache prefetches performed. This number is included in
|
|
cachehits, as the original query had the unprefetched answer from cache,
|
|
and resulted in recursive processing, taking a slot in the requestlist.
|
|
Not part of the recursivereplies (or the histogram thereof) or cachemiss,
|
|
as a cache response was sent.
|
|
.TP
|
|
.I threadX.num.expired
|
|
number of replies that served an expired cache entry.
|
|
.TP
|
|
.I threadX.num.queries_timed_out
|
|
number of queries that are dropped because they waited in the UDP socket buffer
|
|
for too long.
|
|
.TP
|
|
.I threadX.query.queue_time_us.max
|
|
The maximum wait time for packets in the socket buffer, in microseconds. This
|
|
is only reported when sock-queue-timeout is enabled.
|
|
.TP
|
|
.I threadX.num.recursivereplies
|
|
The number of replies sent to queries that needed recursive processing. Could be smaller than threadX.num.cachemiss if due to timeouts no replies were sent for some queries.
|
|
.TP
|
|
.I threadX.requestlist.avg
|
|
The average number of requests in the internal recursive processing request list on insert of a new incoming recursive processing query.
|
|
.TP
|
|
.I threadX.requestlist.max
|
|
Maximum size attained by the internal recursive processing request list.
|
|
.TP
|
|
.I threadX.requestlist.overwritten
|
|
Number of requests in the request list that were overwritten by newer entries. This happens if there is a flood of queries that recursive processing and the server has a hard time.
|
|
.TP
|
|
.I threadX.requestlist.exceeded
|
|
Queries that were dropped because the request list was full. This happens if a flood of queries need recursive processing, and the server can not keep up.
|
|
.TP
|
|
.I threadX.requestlist.current.all
|
|
Current size of the request list, includes internally generated queries (such
|
|
as priming queries and glue lookups).
|
|
.TP
|
|
.I threadX.requestlist.current.user
|
|
Current size of the request list, only the requests from client queries.
|
|
.TP
|
|
.I threadX.recursion.time.avg
|
|
Average time it took to answer queries that needed recursive processing. Note that queries that were answered from the cache are not in this average.
|
|
.TP
|
|
.I threadX.recursion.time.median
|
|
The median of the time it took to answer queries that needed recursive
|
|
processing. The median means that 50% of the user queries were answered in
|
|
less than this time. Because of big outliers (usually queries to non
|
|
responsive servers), the average can be bigger than the median. This median
|
|
has been calculated by interpolation from a histogram.
|
|
.TP
|
|
.I threadX.tcpusage
|
|
The currently held tcp buffers for incoming connections. A spot value on
|
|
the time of the request. This helps you spot if the incoming\-num\-tcp
|
|
buffers are full.
|
|
.TP
|
|
.I total.num.queries
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.queries_ip_ratelimited
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.queries_cookie_valid
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.queries_cookie_client
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.queries_cookie_invalid
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.cachehits
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.cachemiss
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.dnscrypt.crypted
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.dnscrypt.cert
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.dnscrypt.cleartext
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.dnscrypt.malformed
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.prefetch
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.expired
|
|
summed over threads.
|
|
.TP
|
|
.I total.num.queries_timed_out
|
|
summed over threads.
|
|
.TP
|
|
.I total.query.queue_time_us.max
|
|
the maximum of the thread values.
|
|
.TP
|
|
.I total.num.recursivereplies
|
|
summed over threads.
|
|
.TP
|
|
.I total.requestlist.avg
|
|
averaged over threads.
|
|
.TP
|
|
.I total.requestlist.max
|
|
the maximum of the thread requestlist.max values.
|
|
.TP
|
|
.I total.requestlist.overwritten
|
|
summed over threads.
|
|
.TP
|
|
.I total.requestlist.exceeded
|
|
summed over threads.
|
|
.TP
|
|
.I total.requestlist.current.all
|
|
summed over threads.
|
|
.TP
|
|
.I total.recursion.time.median
|
|
averaged over threads.
|
|
.TP
|
|
.I total.tcpusage
|
|
summed over threads.
|
|
.TP
|
|
.I time.now
|
|
current time in seconds since 1970.
|
|
.TP
|
|
.I time.up
|
|
uptime since server boot in seconds.
|
|
.TP
|
|
.I time.elapsed
|
|
time since last statistics printout, in seconds.
|
|
.SH EXTENDED STATISTICS
|
|
.TP
|
|
.I mem.cache.rrset
|
|
Memory in bytes in use by the RRset cache.
|
|
.TP
|
|
.I mem.cache.message
|
|
Memory in bytes in use by the message cache.
|
|
.TP
|
|
.I mem.cache.dnscrypt_shared_secret
|
|
Memory in bytes in use by the dnscrypt shared secrets cache.
|
|
.TP
|
|
.I mem.cache.dnscrypt_nonce
|
|
Memory in bytes in use by the dnscrypt nonce cache.
|
|
.TP
|
|
.I mem.mod.iterator
|
|
Memory in bytes in use by the iterator module.
|
|
.TP
|
|
.I mem.mod.validator
|
|
Memory in bytes in use by the validator module. Includes the key cache and
|
|
negative cache.
|
|
.TP
|
|
.I mem.streamwait
|
|
Memory in bytes in used by the TCP and TLS stream wait buffers. These are
|
|
answers waiting to be written back to the clients.
|
|
.TP
|
|
.I mem.http.query_buffer
|
|
Memory in bytes used by the HTTP/2 query buffers. Containing (partial) DNS
|
|
queries waiting for request stream completion.
|
|
.TP
|
|
.I mem.http.response_buffer
|
|
Memory in bytes used by the HTTP/2 response buffers. Containing DNS responses
|
|
waiting to be written back to the clients.
|
|
.TP
|
|
.I mem.quic
|
|
Memory in bytes used by QUIC. Containing connection information, stream
|
|
information, queries read and responses written back to the clients.
|
|
.TP
|
|
.I histogram.<sec>.<usec>.to.<sec>.<usec>
|
|
Shows a histogram, summed over all threads. Every element counts the
|
|
recursive queries whose reply time fit between the lower and upper bound.
|
|
Times larger or equal to the lowerbound, and smaller than the upper bound.
|
|
There are 40 buckets, with bucket sizes doubling.
|
|
.TP
|
|
.I num.query.type.A
|
|
The total number of queries over all threads with query type A.
|
|
Printed for the other query types as well, but only for the types for which
|
|
queries were received, thus =0 entries are omitted for brevity.
|
|
.TP
|
|
.I num.query.type.other
|
|
Number of queries with query types 256\-65535.
|
|
.TP
|
|
.I num.query.class.IN
|
|
The total number of queries over all threads with query class IN (internet).
|
|
Also printed for other classes (such as CH (CHAOS) sometimes used for
|
|
debugging), or NONE, ANY, used by dynamic update.
|
|
num.query.class.other is printed for classes 256\-65535.
|
|
.TP
|
|
.I num.query.opcode.QUERY
|
|
The total number of queries over all threads with query opcode QUERY.
|
|
Also printed for other opcodes, UPDATE, ...
|
|
.TP
|
|
.I num.query.tcp
|
|
Number of queries that were made using TCP towards the Unbound server.
|
|
.TP
|
|
.I num.query.tcpout
|
|
Number of queries that the Unbound server made using TCP outgoing towards
|
|
other servers.
|
|
.TP
|
|
.I num.query.udpout
|
|
Number of queries that the Unbound server made using UDP outgoing towards
|
|
other servers.
|
|
.TP
|
|
.I num.query.tls
|
|
Number of queries that were made using TLS towards the Unbound server.
|
|
These are also counted in num.query.tcp, because TLS uses TCP.
|
|
.TP
|
|
.I num.query.tls.resume
|
|
Number of TLS session resumptions, these are queries over TLS towards
|
|
the Unbound server where the client negotiated a TLS session resumption key.
|
|
.TP
|
|
.I num.query.https
|
|
Number of queries that were made using HTTPS towards the Unbound server.
|
|
These are also counted in num.query.tcp and num.query.tls, because HTTPS
|
|
uses TLS and TCP.
|
|
.TP
|
|
.I num.query.quic
|
|
Number of queries that were made using QUIC towards the Unbound server.
|
|
These are also counted in num.query.tls, because TLS is used for these queries.
|
|
.TP
|
|
.I num.query.ipv6
|
|
Number of queries that were made using IPv6 towards the Unbound server.
|
|
.TP
|
|
.I num.query.flags.RD
|
|
The number of queries that had the RD flag set in the header.
|
|
Also printed for flags QR, AA, TC, RA, Z, AD, CD.
|
|
Note that queries with flags QR, AA or TC may have been rejected
|
|
because of that.
|
|
.TP
|
|
.I num.query.edns.present
|
|
number of queries that had an EDNS OPT record present.
|
|
.TP
|
|
.I num.query.edns.DO
|
|
number of queries that had an EDNS OPT record with the DO (DNSSEC OK) bit set.
|
|
These queries are also included in the num.query.edns.present number.
|
|
.TP
|
|
.I num.query.ratelimited
|
|
The number of queries that are turned away from being send to nameserver due to
|
|
ratelimiting.
|
|
.TP
|
|
.I num.query.dnscrypt.shared_secret.cachemiss
|
|
The number of dnscrypt queries that did not find a shared secret in the cache.
|
|
This can be used to compute the shared secret hitrate.
|
|
.TP
|
|
.I num.query.dnscrypt.replay
|
|
The number of dnscrypt queries that found a nonce hit in the nonce cache and
|
|
hence are considered a query replay.
|
|
.TP
|
|
.I num.answer.rcode.NXDOMAIN
|
|
The number of answers to queries, from cache or from recursion, that had the
|
|
return code NXDOMAIN. Also printed for the other return codes.
|
|
.TP
|
|
.I num.answer.rcode.nodata
|
|
The number of answers to queries that had the pseudo return code nodata.
|
|
This means the actual return code was NOERROR, but additionally, no data was
|
|
carried in the answer (making what is called a NOERROR/NODATA answer).
|
|
These queries are also included in the num.answer.rcode.NOERROR number.
|
|
Common for AAAA lookups when an A record exists, and no AAAA.
|
|
.TP
|
|
.I num.answer.secure
|
|
Number of answers that were secure. The answer validated correctly.
|
|
The AD bit might have been set in some of these answers, where the client
|
|
signalled (with DO or AD bit in the query) that they were ready to accept
|
|
the AD bit in the answer.
|
|
.TP
|
|
.I num.answer.bogus
|
|
Number of answers that were bogus. These answers resulted in SERVFAIL
|
|
to the client because the answer failed validation.
|
|
.TP
|
|
.I num.rrset.bogus
|
|
The number of rrsets marked bogus by the validator. Increased for every
|
|
RRset inspection that fails.
|
|
.TP
|
|
.I unwanted.queries
|
|
Number of queries that were refused or dropped because they failed the
|
|
access control settings.
|
|
.TP
|
|
.I unwanted.replies
|
|
Replies that were unwanted or unsolicited. Could have been random traffic,
|
|
delayed duplicates, very late answers, or could be spoofing attempts.
|
|
Some low level of late answers and delayed duplicates are to be expected
|
|
with the UDP protocol. Very high values could indicate a threat (spoofing).
|
|
.TP
|
|
.I msg.cache.count
|
|
The number of items (DNS replies) in the message cache.
|
|
.TP
|
|
.I rrset.cache.count
|
|
The number of RRsets in the rrset cache. This includes rrsets used by
|
|
the messages in the message cache, but also delegation information.
|
|
.TP
|
|
.I infra.cache.count
|
|
The number of items in the infra cache. These are IP addresses with their
|
|
timing and protocol support information.
|
|
.TP
|
|
.I key.cache.count
|
|
The number of items in the key cache. These are DNSSEC keys, one item
|
|
per delegation point, and their validation status.
|
|
.TP
|
|
.I msg.cache.max_collisions
|
|
The maximum number of hash table collisions in the msg cache. This is the
|
|
number of hashes that are identical when a new element is inserted in the
|
|
hash table. If the value is very large, like hundreds, something is wrong
|
|
with the performance of the hash table, hash values are incorrect or malicious.
|
|
.TP
|
|
.I rrset.cache.max_collisions
|
|
The maximum number of hash table collisions in the rrset cache. This is the
|
|
number of hashes that are identical when a new element is inserted in the
|
|
hash table. If the value is very large, like hundreds, something is wrong
|
|
with the performance of the hash table, hash values are incorrect or malicious.
|
|
.TP
|
|
.I dnscrypt_shared_secret.cache.count
|
|
The number of items in the shared secret cache. These are precomputed shared
|
|
secrets for a given client public key/server secret key pair. Shared secrets
|
|
are CPU intensive and this cache allows Unbound to avoid recomputing the
|
|
shared secret when multiple dnscrypt queries are sent from the same client.
|
|
.TP
|
|
.I dnscrypt_nonce.cache.count
|
|
The number of items in the client nonce cache. This cache is used to prevent
|
|
dnscrypt queries replay. The client nonce must be unique for each client public
|
|
key/server secret key pair. This cache should be able to host QPS * `replay
|
|
window` interval keys to prevent replay of a query during `replay window`
|
|
seconds.
|
|
.TP
|
|
.I num.query.authzone.up
|
|
The number of queries answered from auth\-zone data, upstream queries.
|
|
These queries would otherwise have been sent (with fallback enabled) to
|
|
the internet, but are now answered from the auth zone.
|
|
.TP
|
|
.I num.query.authzone.down
|
|
The number of queries for downstream answered from auth\-zone data.
|
|
These queries are from downstream clients, and have had an answer from
|
|
the data in the auth zone.
|
|
.TP
|
|
.I num.query.aggressive.NOERROR
|
|
The number of queries answered using cached NSEC records with NODATA RCODE.
|
|
These queries would otherwise have been sent to the internet, but are now
|
|
answered using cached data.
|
|
.TP
|
|
.I num.query.aggressive.NXDOMAIN
|
|
The number of queries answered using cached NSEC records with NXDOMAIN RCODE.
|
|
These queries would otherwise have been sent to the internet, but are now
|
|
answered using cached data.
|
|
.TP
|
|
.I num.query.subnet
|
|
Number of queries that got an answer that contained EDNS client subnet data.
|
|
.TP
|
|
.I num.query.subnet_cache
|
|
Number of queries answered from the edns client subnet cache. These are
|
|
counted as cachemiss by the main counters, but hit the client subnet
|
|
specific cache after getting processed by the edns client subnet module.
|
|
.TP
|
|
.I num.query.cachedb
|
|
Number of queries answered from the external cache of cachedb.
|
|
These are counted as cachemiss by the main counters, but hit the cachedb
|
|
external cache after getting processed by the cachedb module.
|
|
.TP
|
|
.I num.rpz.action.<rpz_action>
|
|
Number of queries answered using configured RPZ policy, per RPZ action type.
|
|
Possible actions are: nxdomain, nodata, passthru, drop, tcp\-only, local\-data,
|
|
disabled, and cname\-override.
|
|
.SH "FILES"
|
|
.TP
|
|
.I @ub_conf_file@
|
|
Unbound configuration file.
|
|
.TP
|
|
.I @UNBOUND_RUN_DIR@
|
|
directory with private keys (unbound_server.key and unbound_control.key) and
|
|
self\-signed certificates (unbound_server.pem and unbound_control.pem).
|
|
.SH "SEE ALSO"
|
|
\fIunbound.conf\fR(5),
|
|
\fIunbound\fR(8).
|