Annotation of src/external/mpl/bind/dist/bin/delv/delv.1, Revision 1.4
1.3 christos 1: .\" $NetBSD: delv.1,v 1.1.1.2 2019/02/24 18:56:38 christos Exp $
1.1 christos 2: .\"
1.4 ! christos 3: .\" Copyright (C) 2014-2020 Internet Systems Consortium, Inc. ("ISC")
1.1 christos 4: .\"
5: .\" This Source Code Form is subject to the terms of the Mozilla Public
6: .\" License, v. 2.0. If a copy of the MPL was not distributed with this
7: .\" file, You can obtain one at http://mozilla.org/MPL/2.0/.
8: .\"
9: .hy 0
10: .ad l
11: '\" t
12: .\" Title: delv
13: .\" Author:
14: .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
15: .\" Date: 2014-04-23
16: .\" Manual: BIND9
17: .\" Source: ISC
18: .\" Language: English
19: .\"
20: .TH "DELV" "1" "2014\-04\-23" "ISC" "BIND9"
21: .\" -----------------------------------------------------------------
22: .\" * Define some portability stuff
23: .\" -----------------------------------------------------------------
24: .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25: .\" http://bugs.debian.org/507673
26: .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
27: .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28: .ie \n(.g .ds Aq \(aq
29: .el .ds Aq '
30: .\" -----------------------------------------------------------------
31: .\" * set default formatting
32: .\" -----------------------------------------------------------------
33: .\" disable hyphenation
34: .nh
35: .\" disable justification (adjust text to left margin only)
36: .ad l
37: .\" -----------------------------------------------------------------
38: .\" * MAIN CONTENT STARTS HERE *
39: .\" -----------------------------------------------------------------
40: .SH "NAME"
41: delv \- DNS lookup and validation utility
42: .SH "SYNOPSIS"
43: .HP \w'\fBdelv\fR\ 'u
44: \fBdelv\fR [@server] [[\fB\-4\fR] | [\fB\-6\fR]] [\fB\-a\ \fR\fB\fIanchor\-file\fR\fR] [\fB\-b\ \fR\fB\fIaddress\fR\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-d\ \fR\fB\fIlevel\fR\fR] [\fB\-i\fR] [\fB\-m\fR] [\fB\-p\ \fR\fB\fIport#\fR\fR] [\fB\-q\ \fR\fB\fIname\fR\fR] [\fB\-t\ \fR\fB\fItype\fR\fR] [\fB\-x\ \fR\fB\fIaddr\fR\fR] [name] [type] [class] [queryopt...]
45: .HP \w'\fBdelv\fR\ 'u
46: \fBdelv\fR [\fB\-h\fR]
47: .HP \w'\fBdelv\fR\ 'u
48: \fBdelv\fR [\fB\-v\fR]
49: .HP \w'\fBdelv\fR\ 'u
50: \fBdelv\fR [queryopt...] [query...]
51: .SH "DESCRIPTION"
52: .PP
53: \fBdelv\fR
54: is a tool for sending DNS queries and validating the results, using the same internal resolver and validator logic as
55: \fBnamed\fR\&.
56: .PP
57: \fBdelv\fR
1.4 ! christos 58: will send to a specified name server all queries needed to fetch and validate the requested data; this includes the original requested query, subsequent queries to follow CNAME or DNAME chains, and queries for DNSKEY and DS records to establish a chain of trust for DNSSEC validation\&. It does not perform iterative resolution, but simulates the behavior of a name server configured for DNSSEC validating and forwarding\&.
1.1 christos 59: .PP
60: By default, responses are validated using built\-in DNSSEC trust anchor for the root zone ("\&.")\&. Records returned by
61: \fBdelv\fR
62: are either fully validated or were not signed\&. If validation fails, an explanation of the failure is included in the output; the validation process can be traced in detail\&. Because
63: \fBdelv\fR
64: does not rely on an external server to carry out validation, it can be used to check the validity of DNS responses in environments where local name servers may not be trustworthy\&.
65: .PP
66: Unless it is told to query a specific name server,
67: \fBdelv\fR
68: will try each of the servers listed in
69: /etc/resolv\&.conf\&. If no usable server addresses are found,
70: \fBdelv\fR
71: will send queries to the localhost addresses (127\&.0\&.0\&.1 for IPv4, ::1 for IPv6)\&.
72: .PP
73: When no command line arguments or options are given,
74: \fBdelv\fR
75: will perform an NS query for "\&." (the root zone)\&.
76: .SH "SIMPLE USAGE"
77: .PP
78: A typical invocation of
79: \fBdelv\fR
80: looks like:
81: .sp
82: .if n \{\
83: .RS 4
84: .\}
85: .nf
86: delv @server name type
87: .fi
88: .if n \{\
89: .RE
90: .\}
91: .sp
92: where:
93: .PP
94: \fBserver\fR
95: .RS 4
96: is the name or IP address of the name server to query\&. This can be an IPv4 address in dotted\-decimal notation or an IPv6 address in colon\-delimited notation\&. When the supplied
97: \fIserver\fR
98: argument is a hostname,
99: \fBdelv\fR
100: resolves that name before querying that name server (note, however, that this initial lookup is
101: \fInot\fR
102: validated by DNSSEC)\&.
103: .sp
104: If no
105: \fIserver\fR
106: argument is provided,
107: \fBdelv\fR
108: consults
109: /etc/resolv\&.conf; if an address is found there, it queries the name server at that address\&. If either of the
110: \fB\-4\fR
111: or
112: \fB\-6\fR
113: options are in use, then only addresses for the corresponding transport will be tried\&. If no usable addresses are found,
114: \fBdelv\fR
115: will send queries to the localhost addresses (127\&.0\&.0\&.1 for IPv4, ::1 for IPv6)\&.
116: .RE
117: .PP
118: \fBname\fR
119: .RS 4
120: is the domain name to be looked up\&.
121: .RE
122: .PP
123: \fBtype\fR
124: .RS 4
125: indicates what type of query is required \(em ANY, A, MX, etc\&.
126: \fItype\fR
127: can be any valid query type\&. If no
128: \fItype\fR
129: argument is supplied,
130: \fBdelv\fR
131: will perform a lookup for an A record\&.
132: .RE
133: .SH "OPTIONS"
134: .PP
135: \-a \fIanchor\-file\fR
136: .RS 4
137: Specifies a file from which to read DNSSEC trust anchors\&. The default is
138: /etc/bind\&.keys, which is included with
139: BIND
140: 9 and contains one or more trust anchors for the root zone ("\&.")\&.
141: .sp
142: Keys that do not match the root zone name are ignored\&. An alternate key name can be specified using the
143: \fB+root=NAME\fR
1.4 ! christos 144: options\&.
1.1 christos 145: .sp
146: Note: When reading the trust anchor file,
147: \fBdelv\fR
148: treats
1.4 ! christos 149: \fBtrust\-anchors\fR\fBinitial\-key\fR
! 150: and
! 151: \fBstatic\-key\fR
! 152: entries identically\&. That is, even if a key is configured with
! 153: \fBinitial\-key\fR, indicating that it is meant to be used only as an initializing key for RFC 5011 key maintenance, it is still treated by
! 154: \fBdelv\fR
! 155: as if it had been configured as a
! 156: \fBstatic\-key\fR\&.
1.1 christos 157: \fBdelv\fR
1.4 ! christos 158: does not consult the managed keys database maintained by
1.1 christos 159: \fBnamed\fR\&. This means that if either of the keys in
160: /etc/bind\&.keys
161: is revoked and rolled over, it will be necessary to update
162: /etc/bind\&.keys
163: to use DNSSEC validation in
164: \fBdelv\fR\&.
165: .RE
166: .PP
167: \-b \fIaddress\fR
168: .RS 4
169: Sets the source IP address of the query to
170: \fIaddress\fR\&. This must be a valid address on one of the host\*(Aqs network interfaces or "0\&.0\&.0\&.0" or "::"\&. An optional source port may be specified by appending "#<port>"
171: .RE
172: .PP
173: \-c \fIclass\fR
174: .RS 4
175: Sets the query class for the requested data\&. Currently, only class "IN" is supported in
176: \fBdelv\fR
177: and any other value is ignored\&.
178: .RE
179: .PP
180: \-d \fIlevel\fR
181: .RS 4
182: Set the systemwide debug level to
183: \fBlevel\fR\&. The allowed range is from 0 to 99\&. The default is 0 (no debugging)\&. Debugging traces from
184: \fBdelv\fR
185: become more verbose as the debug level increases\&. See the
186: \fB+mtrace\fR,
187: \fB+rtrace\fR, and
188: \fB+vtrace\fR
189: options below for additional debugging details\&.
190: .RE
191: .PP
192: \-h
193: .RS 4
194: Display the
195: \fBdelv\fR
196: help usage output and exit\&.
197: .RE
198: .PP
199: \-i
200: .RS 4
201: Insecure mode\&. This disables internal DNSSEC validation\&. (Note, however, this does not set the CD bit on upstream queries\&. If the server being queried is performing DNSSEC validation, then it will not return invalid data; this can cause
202: \fBdelv\fR
203: to time out\&. When it is necessary to examine invalid data to debug a DNSSEC problem, use
204: \fBdig +cd\fR\&.)
205: .RE
206: .PP
207: \-m
208: .RS 4
209: Enables memory usage debugging\&.
210: .RE
211: .PP
212: \-p \fIport#\fR
213: .RS 4
214: Specifies a destination port to use for queries instead of the standard DNS port number 53\&. This option would be used with a name server that has been configured to listen for queries on a non\-standard port number\&.
215: .RE
216: .PP
217: \-q \fIname\fR
218: .RS 4
219: Sets the query name to
220: \fIname\fR\&. While the query name can be specified without using the
221: \fB\-q\fR, it is sometimes necessary to disambiguate names from types or classes (for example, when looking up the name "ns", which could be misinterpreted as the type NS, or "ch", which could be misinterpreted as class CH)\&.
222: .RE
223: .PP
224: \-t \fItype\fR
225: .RS 4
226: Sets the query type to
227: \fItype\fR, which can be any valid query type supported in BIND 9 except for zone transfer types AXFR and IXFR\&. As with
228: \fB\-q\fR, this is useful to distinguish query name type or class when they are ambiguous\&. it is sometimes necessary to disambiguate names from types\&.
229: .sp
230: The default query type is "A", unless the
231: \fB\-x\fR
232: option is supplied to indicate a reverse lookup, in which case it is "PTR"\&.
233: .RE
234: .PP
235: \-v
236: .RS 4
237: Print the
238: \fBdelv\fR
239: version and exit\&.
240: .RE
241: .PP
242: \-x \fIaddr\fR
243: .RS 4
244: Performs a reverse lookup, mapping an addresses to a name\&.
245: \fIaddr\fR
246: is an IPv4 address in dotted\-decimal notation, or a colon\-delimited IPv6 address\&. When
247: \fB\-x\fR
248: is used, there is no need to provide the
249: \fIname\fR
250: or
251: \fItype\fR
252: arguments\&.
253: \fBdelv\fR
254: automatically performs a lookup for a name like
255: 11\&.12\&.13\&.10\&.in\-addr\&.arpa
256: and sets the query type to PTR\&. IPv6 addresses are looked up using nibble format under the IP6\&.ARPA domain\&.
257: .RE
258: .PP
259: \-4
260: .RS 4
261: Forces
262: \fBdelv\fR
263: to only use IPv4\&.
264: .RE
265: .PP
266: \-6
267: .RS 4
268: Forces
269: \fBdelv\fR
270: to only use IPv6\&.
271: .RE
272: .SH "QUERY OPTIONS"
273: .PP
274: \fBdelv\fR
275: provides a number of query options which affect the way results are displayed, and in some cases the way lookups are performed\&.
276: .PP
277: Each query option is identified by a keyword preceded by a plus sign (+)\&. Some keywords set or reset an option\&. These may be preceded by the string
278: no
279: to negate the meaning of that keyword\&. Other keywords assign values to options like the timeout interval\&. They have the form
280: \fB+keyword=value\fR\&. The query options are:
281: .PP
282: \fB+[no]cdflag\fR
283: .RS 4
284: Controls whether to set the CD (checking disabled) bit in queries sent by
285: \fBdelv\fR\&. This may be useful when troubleshooting DNSSEC problems from behind a validating resolver\&. A validating resolver will block invalid responses, making it difficult to retrieve them for analysis\&. Setting the CD flag on queries will cause the resolver to return invalid responses, which
286: \fBdelv\fR
287: can then validate internally and report the errors in detail\&.
288: .RE
289: .PP
290: \fB+[no]class\fR
291: .RS 4
292: Controls whether to display the CLASS when printing a record\&. The default is to display the CLASS\&.
293: .RE
294: .PP
295: \fB+[no]ttl\fR
296: .RS 4
297: Controls whether to display the TTL when printing a record\&. The default is to display the TTL\&.
298: .RE
299: .PP
300: \fB+[no]rtrace\fR
301: .RS 4
302: Toggle resolver fetch logging\&. This reports the name and type of each query sent by
303: \fBdelv\fR
304: in the process of carrying out the resolution and validation process: this includes including the original query and all subsequent queries to follow CNAMEs and to establish a chain of trust for DNSSEC validation\&.
305: .sp
306: This is equivalent to setting the debug level to 1 in the "resolver" logging category\&. Setting the systemwide debug level to 1 using the
307: \fB\-d\fR
308: option will product the same output (but will affect other logging categories as well)\&.
309: .RE
310: .PP
311: \fB+[no]mtrace\fR
312: .RS 4
313: Toggle message logging\&. This produces a detailed dump of the responses received by
314: \fBdelv\fR
315: in the process of carrying out the resolution and validation process\&.
316: .sp
317: This is equivalent to setting the debug level to 10 for the "packets" module of the "resolver" logging category\&. Setting the systemwide debug level to 10 using the
318: \fB\-d\fR
319: option will produce the same output (but will affect other logging categories as well)\&.
320: .RE
321: .PP
322: \fB+[no]vtrace\fR
323: .RS 4
324: Toggle validation logging\&. This shows the internal process of the validator as it determines whether an answer is validly signed, unsigned, or invalid\&.
325: .sp
326: This is equivalent to setting the debug level to 3 for the "validator" module of the "dnssec" logging category\&. Setting the systemwide debug level to 3 using the
327: \fB\-d\fR
328: option will produce the same output (but will affect other logging categories as well)\&.
329: .RE
330: .PP
331: \fB+[no]short\fR
332: .RS 4
333: Provide a terse answer\&. The default is to print the answer in a verbose form\&.
334: .RE
335: .PP
336: \fB+[no]comments\fR
337: .RS 4
338: Toggle the display of comment lines in the output\&. The default is to print comments\&.
339: .RE
340: .PP
341: \fB+[no]rrcomments\fR
342: .RS 4
343: Toggle the display of per\-record comments in the output (for example, human\-readable key information about DNSKEY records)\&. The default is to print per\-record comments\&.
344: .RE
345: .PP
346: \fB+[no]crypto\fR
347: .RS 4
348: Toggle the display of cryptographic fields in DNSSEC records\&. The contents of these field are unnecessary to debug most DNSSEC validation failures and removing them makes it easier to see the common failures\&. The default is to display the fields\&. When omitted they are replaced by the string "[omitted]" or in the DNSKEY case the key id is displayed as the replacement, e\&.g\&. "[ key id = value ]"\&.
349: .RE
350: .PP
351: \fB+[no]trust\fR
352: .RS 4
353: Controls whether to display the trust level when printing a record\&. The default is to display the trust level\&.
354: .RE
355: .PP
356: \fB+[no]split[=W]\fR
357: .RS 4
358: Split long hex\- or base64\-formatted fields in resource records into chunks of
359: \fIW\fR
360: characters (where
361: \fIW\fR
362: is rounded up to the nearest multiple of 4)\&.
363: \fI+nosplit\fR
364: or
365: \fI+split=0\fR
366: causes fields not to be split at all\&. The default is 56 characters, or 44 characters when multiline mode is active\&.
367: .RE
368: .PP
369: \fB+[no]all\fR
370: .RS 4
371: Set or clear the display options
372: \fB+[no]comments\fR,
373: \fB+[no]rrcomments\fR, and
374: \fB+[no]trust\fR
375: as a group\&.
376: .RE
377: .PP
378: \fB+[no]multiline\fR
379: .RS 4
380: Print long records (such as RRSIG, DNSKEY, and SOA records) in a verbose multi\-line format with human\-readable comments\&. The default is to print each record on a single line, to facilitate machine parsing of the
381: \fBdelv\fR
382: output\&.
383: .RE
384: .PP
385: \fB+[no]dnssec\fR
386: .RS 4
387: Indicates whether to display RRSIG records in the
388: \fBdelv\fR
389: output\&. The default is to do so\&. Note that (unlike in
390: \fBdig\fR) this does
391: \fInot\fR
392: control whether to request DNSSEC records or whether to validate them\&. DNSSEC records are always requested, and validation will always occur unless suppressed by the use of
393: \fB\-i\fR
394: or
1.4 ! christos 395: \fB+noroot\fR\&.
1.1 christos 396: .RE
397: .PP
398: \fB+[no]root[=ROOT]\fR
399: .RS 4
1.4 ! christos 400: Indicates whether to perform conventional DNSSEC validation, and if so, specifies the name of a trust anchor\&. The default is to validate using a trust anchor of "\&." (the root zone), for which there is a built\-in key\&. If specifying a different trust anchor, then
1.1 christos 401: \fB\-a\fR
402: must be used to specify a file containing the key\&.
403: .RE
404: .PP
405: \fB+[no]tcp\fR
406: .RS 4
407: Controls whether to use TCP when sending queries\&. The default is to use UDP unless a truncated response has been received\&.
408: .RE
409: .PP
410: \fB+[no]unknownformat\fR
411: .RS 4
412: Print all RDATA in unknown RR type presentation format (RFC 3597)\&. The default is to print RDATA for known types in the type\*(Aqs presentation format\&.
413: .RE
1.4 ! christos 414: .PP
! 415: \fB+[no]yaml\fR
! 416: .RS 4
! 417: Print response data in YAML format\&.
! 418: .RE
1.1 christos 419: .SH "FILES"
420: .PP
421: /etc/bind\&.keys
422: .PP
423: /etc/resolv\&.conf
424: .SH "SEE ALSO"
425: .PP
426: \fBdig\fR(1),
427: \fBnamed\fR(8),
428: RFC4034,
429: RFC4035,
430: RFC4431,
431: RFC5074,
432: RFC5155\&.
433: .SH "AUTHOR"
434: .PP
435: \fBInternet Systems Consortium, Inc\&.\fR
436: .SH "COPYRIGHT"
437: .br
1.4 ! christos 438: Copyright \(co 2014-2020 Internet Systems Consortium, Inc. ("ISC")
1.1 christos 439: .br
CVSweb <webmaster@jp.NetBSD.org>