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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
// 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
//! # The operating-system rule authoring schema
//!
//! What an `assets/fingerprinting/os` TOML file is allowed to say, as types.
//!
//! Compiled into the build script as well as the library — `build.rs` loads this
//! very file with `#[path]` — so a rule the build accepts is exactly a rule the
//! runtime can match. Nothing here may reach for anything the build script
//! cannot compile, which in practice means `serde` and the standard library.
//!
//! A rule is a table of predicates over the fields of a
//! [`StackObservation`](super::StackObservation), and deliberately not a regex:
//! an operating-system rule matches a typed feature vector rather than text. The
//! three predicate forms are the intersection of what nmap-os-db, p0f and Satori
//! can express, so a translator from any of them never has to invent semantics
//! the source format has no way to state.
use ;
/// The largest weight a single rule may carry.
///
/// A weight ranks rules against each other when several match; it is not a
/// probability and it is not an accuracy. Bounding it keeps one authored value
/// from dominating every other piece of evidence about a host, which is the same
/// reasoning that clamps `OsFingerprint::accuracy` at construction.
pub const MAX_RULE_WEIGHT: f32 = 10.0;
/// A test against one field of an observation.
///
/// Exactly one of the three forms must be given; the build refuses a predicate
/// that sets none or several, because both are an authoring mistake that would
/// otherwise silently match everything or nothing.
///
/// Written as three optional fields rather than an enum so the TOML reads as
/// `{ equals = 64 }` and `{ range = [40, 64] }` without a tag, and so a
/// malformed one produces an error naming the file rather than a deserialization
/// message about variants.
/// Which segment a rule describes.
///
/// Required on every authored rule. A reset carries no TCP options at
/// all whatever the probe offered, and the two replies come from different code
/// paths in one stack that can disagree about the same field — a host measured
/// on a real segment wrote identifier zero on its SYN+ACK path and ran a counter
/// on its reset path. A rule that does not say which segment it reads is
/// matching two different things at once.
/// Where a rule's values came from.
///
/// Not bookkeeping. It changes what the rule is worth, and it changes what the
/// corpus test demands of it.
///
/// The distinction is **not** that published values are unreliable. A stack's
/// initial hop counter, the order it writes its TCP options in, and whether it
/// offers timestamps by default are ordinary engineering facts, documented for
/// decades and stable across releases; refusing to use them would mean
/// re-deriving the whole of p0f from scratch to arrive at the same table.
///
/// The distinction is that a published value has not been seen **by this engine,
/// through this probe, on a real network** — and that gap is exactly where this
/// project has already been caught out. Option negotiation is reciprocal, so a
/// layout the literature records is the layout a peer sends *to a probe that
/// asked for those options*; against a probe that asked for less it is simply
/// wrong, and it fails by matching nothing while looking perfectly correct.
///
/// So a published rule ships, and scores lower until somebody confirms it here.
/// Who a rule says the host is, as much of the path as the evidence supports.
///
/// A path rather than a name: `family` is the only required part, and a rule
/// that cannot honestly say more stops there. That is what lets a first
/// iteration ship family-level rules and a later one add versions without the
/// schema, the matcher or the resolver changing.
/// The predicates a rule tests, all optional: a field not named is not tested.
///
/// Absence is "do not care", never "must be absent". A rule that needs a field
/// to be missing says so with the field's own predicate — `mss` unset on a reset
/// is a property of resets, not something a rule has to assert.
/// One observation a rule is required to match, recorded from a real host.
///
/// Not decoration. The corpus test runs every example through its own rule and
/// through every *other* family's rules, so an authored rule that stopped
/// matching what it was written for, or started matching a different family,
/// fails at that point rather than silently degrading detection.
///
/// `source` is free text and is meant to say where the values came from and
/// when, because a corpus entry nobody can trace is a corpus entry nobody can
/// re-measure.
/// One authored rule: who it names, what it tests, and what it must match.