Debian Codegraph @

src/drool-respdiff.1in

raw
1 .\" DNS Reply Tool (drool)
2 .\"
3 .\" Copyright (c) 2017-2021, OARC, Inc.
4 .\" Copyright (c) 2017, Comcast Corporation
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\"
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\"
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in
16 .\" the documentation and/or other materials provided with the
17 .\" distribution.
18 .\"
19 .\" 3. Neither the name of the copyright holder nor the names of its
20 .\" contributors may be used to endorse or promote products derived
21 .\" from this software without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27 .\" COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 .\" POSSIBILITY OF SUCH DAMAGE.
35 .\"
36 .TH drool 1 "@PACKAGE_VERSION@" "DNS Replay Tool"
37 .SH NAME
38 drool \- DNS Replay Tool
39 .SH SYNOPSIS
40 .B drool respdiff
41 [
42 .I options
43 ]
44 .B path
45 .B name
46 .B file
47 .B name
48 .B host
49 .B port
50 .SH DESCRIPTION
51 This tool is to be used in conjunction with the tool-chain
52 .I respdiff
53 by CZ.NIC (see
54 .IR https://gitlab.labs.nic.cz/knot/respdiff ).
55 .LP
56 It will replay DNS queries found in the PCAP, but only if a correlating
57 response is also found, against the target
58 .I host
59 and
60 .IR port .
61 The query, original response and the received response is then stored into
62 a LMDB database located at
63 .IR path .
64 The
65 .I name
66 before the PCAP
67 .I file
68 and the
69 .I name
70 before the target
71 .I host
72 are stored in the meta table which should correspond with the configuration
73 use for
74 .I respdiff
75 in order for it to be able to read the results correctly.
76 .SH OPTIONS
77 These options are specific for the
78 .B respdiff
79 command, see
80 .IR drool (1)
81 for generic options.
82 .TP
83 .B \-D
84 Show DNS queries and responses as processing goes.
85 .TP
86 .B \-\-no\-tcp
87 Do not use TCP.
88 .TP
89 .B \-\-no\-udp
90 Do not use UDP.
91 .TP
92 .B \-T \-\-threads
93 Use threads.
94 .TP
95 .B \-\-tcp\-threads N
96 Set the number of TCP threads to use, default 2.
97 .TP
98 .B \-\-udp\-threads N
99 Set the number of UDP threads to use, default 4.
100 .TP
101 .B \-\-timeout N.N
102 Set timeout for waiting on responses [seconds.nanoseconds], default 10.0.
103 .TP
104 .B \-\-size BYTES
105 Set the size (in bytes, multiple of OS page size) of the LMDB database, default 10485760.
106 .SH DATABASE SIZE
107 Note that you will need to set a database size that is large enough for all
108 queries, all original responses, all received responses and all analysis done
109 by
110 .I respdiff
111 tool-chain in order for a successful analysis to be done.
112 .SH EXAMPLE
113 This example replays a PCAP file against localhost and then uses the
114 .I respdiff
115 tool-chain to analyze the results.
116 .LP
117 $ drool respdiff /lmdb/path pcap file.pcap target 127.0.0.1 53
118 $ msgdiff.py /lmdb/path
119 $ diffsum.py /lmdb/path
120 .SH SEE ALSO
121 drool(1)
122 .SH AUTHORS
123 Jerry Lundström, DNS-OARC
124 .LP
125 Maintained by DNS-OARC
126 .LP
127 .RS
128 .I https://www.dns-oarc.net/
129 .RE
130 .LP
131 .SH BUGS
132 For issues and feature requests please use:
133 .LP
134 .RS
135 \fI@PACKAGE_URL@\fP
136 .RE
137 .LP
138 For question and help please use:
139 .LP
140 .RS
141 \fI@PACKAGE_BUGREPORT@\fP
142 .RE
143 .LP