1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
// Copyright (c) 2026 Erik Lening (hollowpointer) and Contributors
//
// This file is part of Zond Engine, licensed under the GNU Affero General
// Public License, version 3 or later. See the LICENSE file for details, or
// <https://www.gnu.org/licenses/agpl-3.0.html>.
//
// SPDX-License-Identifier: AGPL-3.0-or-later
//! What a capture saw, and what it did with it.
//!
//! Two things, in the vocabulary rather than beside the capture backend that
//! fills them in, because in both cases more than one module has to agree on
//! the shape. [`CaptureCounts`] is written by the capture and read by the
//! report. [`IpObservation`] is written by the capture and read by whatever
//! wants to know what a stack put in its headers.
//!
//! Putting them here lets a record describe its own shape rather than borrowing
//! it from the transport it came from, and leaves a backend with no kernel buffer
//! at all, such as a synthetic receive stream in a test, able to say so.
/// What a reply's IP header said, past the addressing the scanner needed to
/// correlate it.
///
/// A packet's headers carry two kinds of information. The addresses and the
/// protocol are routing: they say who sent this and how to read the rest, and the
/// scanners have always kept them. Everything else, meaning how many hops are
/// left and whether the datagram may be fragmented and what identifier was
/// stamped on it, is a fact about the stack that emitted it, chosen by its
/// authors and nearly identical across every packet that stack will ever send.
/// That second kind is what this carries, and it is why a reply to an ordinary
/// port probe says something about the machine behind it.
///
/// # Split by family rather than flattened
///
/// IPv4 and IPv6 do not describe the same header, and pretending otherwise is
/// the failure mode worth designing out. Half these fields exist in one family
/// and not the other: there is no identification field in an IPv6 header, and no
/// don't-fragment bit, because an IPv6 datagram is never fragmented in transit.
/// Modelled as one flat struct, those become an `Option` that is always `None`
/// for one family and a `bool` that is silently `false` for it, and a rule
/// written against `dont_fragment == false` would match every IPv6 packet ever
/// captured while looking correct. An enum makes the question unaskable in the
/// family where it has no answer.
///
/// [`remaining_hops`](Self::remaining_hops) is the one field both families do
/// have, under two different names, so it is the one thing worth reading without
/// first asking which family this is.
/// The fields of an IPv4 header that describe the stack that wrote it.
/// The fields of an IPv6 header that describe the stack that wrote it.
/// What became of the frames a capture's BPF filter admitted, cumulative over its
/// lifetime, and whether it lasted the scan.
///
/// `dropped` is the field this exists for. It counts frames that matched the
/// filter, reached the kernel's buffer, and were discarded because this process
/// did not read them in time. A scanner cannot tell such a frame from one that
/// was never sent - both are silence - so a reply lost here is
/// indistinguishable from a host that did not answer, and no amount of
/// retransmission helps if the retry's reply is lost the same way. That makes it
/// the one loss the scanner has to be told about rather than left to infer.
///
/// Read against a scanner's own counters with care. The filters that produce
/// these are narrow but not private: the SYN filter admits every TCP SYN and RST
/// crossing any captured interface, so `received` includes traffic that has
/// nothing to do with the scan. It bounds the receive path's load, not the
/// scan's share of it.
// ╔════════════════════════════════════════════╗
// ║ ████████╗███████╗███████╗████████╗███████╗ ║
// ║ ╚══██╔══╝██╔════╝██╔════╝╚══██╔══╝██╔════╝ ║
// ║ ██║ █████╗ ███████╗ ██║ ███████╗ ║
// ║ ██║ ██╔══╝ ╚════██║ ██║ ╚════██║ ║
// ║ ██║ ███████╗███████║ ██║ ███████║ ║
// ║ ╚═╝ ╚══════╝╚══════╝ ╚═╝ ╚══════╝ ║
// ╚════════════════════════════════════════════╝