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
use crate::args::{CliDedupScope, ScanArgs};
use anyhow::Result;
use keyhog_scanner::ScannerConfig;
use std::path::PathBuf;
mod calibration;
mod detectors;
mod effective;
mod engine_runtime;
mod policy;
mod runtime;
mod scanner;
use calibration::load_explicit_scan_calibration;
pub(crate) use detectors::{
auto_discover_detectors, detector_compile_failed, load_detectors_or_embedded,
load_effective_detector_corpus, validate_detector_mode_selection,
validate_explicit_detector_path, DetectorCorpusProvenance, LoadedDetectorCorpus,
};
pub(crate) use effective::{
autoroute_config_digest, matcher_resolved_config_digest, profiling_policy_digest,
profiling_resolved_config_digest, render_effective_config,
};
pub(crate) use engine_runtime::ResolvedEngineRuntimeSettings;
pub(crate) use policy::{ResolvedAllowlistConfig, ResolvedReportPolicy, ResolvedVerifyPolicy};
#[cfg(feature = "git")]
pub(crate) use runtime::MAX_COMMITS_DEFAULT;
pub(crate) use runtime::{
backend_override_cli_value, backend_override_label, configure_hyperscan_cache_dir,
configure_matcher_artifact_cache_dir, configure_persistent_daemon_threads, configure_threads,
fused_batch_calibration_counts, fused_cpu_wave_width, fused_depth_default,
gpu_runtime_policy_for_backend_override, gpu_runtime_policy_from_args, keyhog_worker_threads,
parse_backend_override, ScanRuntimeInput, FUSED_BATCH_BYTES, FUSED_BATCH_DEFAULT,
MAX_THREADS_CAP, ML_THRESHOLD_DEFAULT, VERIFY_MAX_CONCURRENT_DEFAULT,
VERIFY_TIMEOUT_DEFAULT_SECS,
};
pub(crate) use scanner::build_scanner_config;
use scanner::{build_scanner_config_from_input, ScannerConfigInput};
/// The single resolved scan configuration: the END of the precedence chain
/// `compiled defaults -> each setting's unique ConfigFile owner -> CLI flags`,
/// already merged into the engine's [`ScannerConfig`] PLUS the post-scan policy
/// the live worker needs (the per-detector confidence floors and the global
/// floor / ml gate read in `orchestrator/postprocess.rs`).
///
/// This exists to kill the "tuned != benched != shipped" leak: before it, the
/// scan-time floor lived in `ScannerConfig.min_confidence` (declared default
/// 0.5) while the post-scan floor was re-derived in `postprocess.rs` from
/// `args.min_confidence.unwrap_or(0.3)` - a SECOND, different literal, gated on
/// `!no_ml`. Two floors meant the value the operator set, the value the engine
/// applied, and the value postprocess applied could all disagree. Resolving
/// once and handing the live worker this struct makes "what runs" a single,
/// printable answer (see `keyhog config --effective`).
#[derive(Debug, Clone)]
pub(crate) struct ResolvedScanConfig {
/// Explicit backend selected by `--backend`. `None` means autoroute/cache
/// decides; shipped scans do not read backend selection from ambient env.
pub(crate) backend_override: Option<keyhog_scanner::ScanBackend>,
/// Force the coalesced batch scan pipeline. False means filesystem scans
/// may use the fused filesystem pipeline when the backend/source contract
/// permits it.
pub(crate) batch_pipeline: bool,
/// Explicit scan worker count from `--threads` / `[scan].threads`.
/// `None` means the runtime uses the host physical-core default.
pub(crate) threads: Option<usize>,
/// Explicit filesystem reader thread count.
pub(crate) reader_threads: Option<usize>,
/// Fused filesystem pipeline chunk batch size.
pub(crate) fused_batch: usize,
/// Fused filesystem pipeline channel depth. `None` means derive from the
/// configured worker pool at scan time.
pub(crate) fused_depth: Option<usize>,
/// Resolved GPU runtime policy for probe/init/degrade behavior.
pub(crate) gpu_runtime_policy: keyhog_scanner::gpu::GpuRuntimePolicy,
/// Whether autoroute calibration may include GPU candidates.
pub(crate) autoroute_gpu: bool,
/// Explicit scan execution mode that writes autoroute calibration evidence.
/// Canonical all-candidate calibration shares the normal scan identity it
/// serves. An explicitly GPU-excluded calibration is isolated under a
/// diagnostic identity so incomplete evidence cannot replace that record.
pub(crate) autoroute_calibration: bool,
/// Engine-side config consumed by `CompiledScanner::with_config`.
pub(crate) scanner: ScannerConfig,
/// The global post-scan confidence floor a finding must clear to be
/// reported. This is `scanner.min_confidence` - the SAME resolved value the
/// engine uses, never a re-read of the raw args or a second literal. The
/// live worker reads THIS, not `args.min_confidence.unwrap_or(0.3)`.
pub(crate) min_confidence: f64,
/// Whether ML confidence scoring is enabled. Mirrors `scanner.ml_enabled`.
/// The post-scan floor applies regardless of this: disabling ML changes how
/// confidence is *computed*, not whether a `--min-confidence` floor the
/// operator set is honoured. (Pre-fix the floor was gated on `!no_ml`, so
/// `--no-ml` silently bypassed `--min-confidence` entirely.)
pub(crate) ml_enabled: bool,
/// Per-detector floors from `.keyhog.toml` `[detector.<id>] min_confidence`.
/// Take precedence over `min_confidence` for the matching detector id.
pub(crate) detector_min_confidence: std::collections::HashMap<String, f64>,
/// Detector ids disabled via `.keyhog.toml` `[detector.<id>] enabled = false`.
/// These are dropped from the loaded corpus before scanner compilation.
pub(crate) disabled_detectors: std::collections::HashSet<String>,
/// Whether `.keyhog.toml` requires lockdown mode for this scan.
pub(crate) require_lockdown: bool,
/// Resolved regex lazy-DFA cache cap applied before scanner compilation.
pub(crate) regex_dfa_limit: Option<usize>,
/// Resolved GPU batch-input buffer byte budget (Tier-A override of the
/// VRAM-adaptive default), applied to the process-global before scanning.
pub(crate) gpu_batch_input_limit: Option<usize>,
/// Resolved filesystem max-file-size cap applied by the source factory.
pub(crate) max_file_size: Option<usize>,
/// Resolved git history/blob traversal cap applied by the source factory.
#[cfg(feature = "git")]
pub(crate) max_commits: usize,
/// Whether source-owned default excludes are disabled.
pub(crate) no_default_excludes: bool,
/// Explicit operator path/glob exclusions merged with allowlist paths.
pub(crate) exclude_paths: Vec<String>,
/// Whether incremental Merkle-cache scanning is enabled.
pub(crate) incremental: bool,
/// Explicit incremental cache file path. `None` means platform default when
/// incremental mode is enabled.
pub(crate) incremental_cache_path: Option<PathBuf>,
/// Resolved Hyperscan compiled-database cache directory.
pub(crate) hyperscan_cache_dir: Option<PathBuf>,
/// Resolved persistent autoroute calibration cache file. `None` means
/// persistence is explicitly disabled.
pub(crate) autoroute_cache_path: Option<PathBuf>,
/// Resolved MatcherArtifact cache directory. `None` means persistence is
/// explicitly disabled.
pub(crate) matcher_cache_path: Option<PathBuf>,
/// Resolved explicit per-detector Bayesian calibration cache file. `None`
/// means confidence scoring is hermetic and does not read disk state.
pub(crate) calibration_cache_path: Option<PathBuf>,
/// Number of detector counters loaded from the explicit calibration cache.
pub(crate) calibration_entry_count: usize,
/// Stable digest of the loaded calibration counters for config identity.
pub(crate) calibration_digest: u64,
/// Extra AWS canary/knockoff account IDs supplied by `.keyhog.toml`.
pub(crate) aws_canary_accounts: Vec<String>,
/// Explicit scanner route tuning supplied by `.keyhog.toml`.
pub(crate) scanner_tuning: keyhog_scanner::ScannerTuningConfig,
/// Resolved allowlist file and governance policy supplied by `.keyhog.toml`.
pub(crate) allowlist: ResolvedAllowlistConfig,
/// Resolved source byte/count limits applied while constructing sources.
pub(crate) source_limits: keyhog_sources::SourceLimits,
/// Resolved reporting/postprocess policy that can come from CLI or TOML.
pub(crate) report: ResolvedReportPolicy,
/// Resolved verifier transport/execution policy consumed by verifier
/// postprocess without re-reading raw post-merge CLI args.
pub(crate) verify: ResolvedVerifyPolicy,
}
impl ResolvedScanConfig {
/// Return the engine configuration without enabling detailed diagnostics for
/// the low-overhead operator profile. `--perf-trace` owns that hot-path cost.
pub(crate) fn engine_scanner_config(&self) -> ScannerConfig {
let mut config = self.scanner.clone();
config.profile = config.perf_trace;
config
}
}
/// Resolve the full scan configuration in one place: run the precedence merge
/// (compiled default -> `[scan]` table -> flat `ConfigFile` fields -> CLI flags)
/// via [`apply_config_file`], build the engine [`ScannerConfig`], and surface
/// the post-scan policy (global floor, ml gate, per-detector floors) so the live
/// worker consumes a resolved struct instead of re-reading raw args + a literal.
///
/// `args` is mutated in place by the config-file merge (CLI flags already win;
/// the merge only fills fields the operator left at their default), exactly as
/// the orchestrator's pre-existing `apply_config_file(&mut args)` call did.
/// Scanner, runtime, reporting, and verifier policy are captured into resolved
/// structs here so scan execution does not re-derive those decisions from raw
/// args.
pub(crate) fn resolve_scan_config(args: &mut ScanArgs) -> Result<ResolvedScanConfig> {
let outcome = crate::config::apply_config_file(args);
if !outcome.config_errors.is_empty() {
anyhow::bail!(
"invalid .keyhog.toml configuration:\n{}",
outcome.config_errors.join("\n")
);
}
keyhog_core::set_extra_trusted_dirs(outcome.trusted_bin_dirs.clone());
let mut aws_canary_accounts = outcome.aws_canary_accounts;
aws_canary_accounts.sort();
aws_canary_accounts.dedup();
let aws_canary_set = aws_canary_accounts.iter().cloned().collect();
keyhog_core::set_extra_canary_accounts(aws_canary_set);
let runtime_input = ScanRuntimeInput::from_scan_args(args);
let report = ResolvedReportPolicy::from_scan_args(args);
let verify = ResolvedVerifyPolicy::from_scan_args(args);
configure_hyperscan_cache_dir(runtime_input.cache_dir.clone())?;
let autoroute_cache_path = crate::autoroute_cache_path::resolve_autoroute_cache_path(
runtime_input.autoroute_cache.as_deref(),
)
.map_err(anyhow::Error::msg)?;
let mut matcher_cache_path = crate::matcher_cache_path::resolve_matcher_cache_path(
runtime_input.matcher_cache.as_deref(),
)
.map_err(anyhow::Error::msg)?;
// Lockdown forbids reading detector graphs from unsigned on-disk caches.
if args.lockdown && matcher_cache_path.is_some() {
// Only surface warnings when the operator explicitly configured the
// cache; default-on resolution must not spam --lockdown/--quiet CI.
if runtime_input.matcher_cache.is_some() {
tracing::warn!("lockdown mode: MatcherArtifact cache disabled");
eprintln!(
"warning: MatcherArtifact cache disabled because --lockdown forbids unsigned on-disk detector/matcher caches"
);
}
matcher_cache_path = None;
}
configure_matcher_artifact_cache_dir(matcher_cache_path.clone())?;
let backend_override = parse_backend_override(runtime_input.backend.as_deref())?;
let scanner_tuning = outcome.scanner_tuning;
let scanner_input = ScannerConfigInput::from_scan_args(args);
let mut scanner = build_scanner_config_from_input(&scanner_input);
let (calibration_cache_path, calibration_store, calibration_entry_count, calibration_digest) = {
// Detector calibration cache load and lookup share the incremental-cache stage.
let _cache_span = keyhog_profile::span(keyhog_profile::Stage::IncrementalLookup);
load_explicit_scan_calibration(runtime_input.calibration_cache.as_deref())?
};
if let Some(calibration_store) = calibration_store {
scanner = scanner.with_calibration(calibration_store);
}
// The post-scan floor is the SAME value the engine resolved - read it back
// off the built config rather than re-deriving from `args`, so the two can
// never drift. `ScannerConfig::from`/`sanitise` already clamped NaN/range.
let min_confidence = scanner.min_confidence;
let ml_enabled = scanner.ml_enabled;
Ok(ResolvedScanConfig {
backend_override,
batch_pipeline: runtime_input.batch_pipeline,
threads: runtime_input.threads,
reader_threads: runtime_input.reader_threads,
fused_batch: runtime_input.fused_batch,
fused_depth: runtime_input.fused_depth,
gpu_runtime_policy: runtime_input.gpu_runtime_policy,
autoroute_gpu: runtime_input.autoroute_gpu,
autoroute_calibration: runtime_input.autoroute_calibration,
scanner,
min_confidence,
ml_enabled,
detector_min_confidence: outcome.detector_min_confidence,
disabled_detectors: outcome.disabled_detectors.into_iter().collect(),
require_lockdown: outcome.require_lockdown,
regex_dfa_limit: runtime_input.regex_dfa_limit,
gpu_batch_input_limit: runtime_input.gpu_batch_input_limit,
max_file_size: runtime_input.max_file_size,
#[cfg(feature = "git")]
max_commits: runtime_input.max_commits,
no_default_excludes: runtime_input.no_default_excludes,
exclude_paths: runtime_input.exclude_paths,
incremental: runtime_input.incremental,
incremental_cache_path: runtime_input.incremental_cache_path,
hyperscan_cache_dir: runtime_input.cache_dir,
autoroute_cache_path,
matcher_cache_path,
calibration_cache_path,
calibration_entry_count,
calibration_digest,
aws_canary_accounts,
scanner_tuning,
allowlist: ResolvedAllowlistConfig {
file: outcome.allowlist_file,
require_reason: outcome.allowlist_require_reason,
require_approved_by: outcome.allowlist_require_approved_by,
max_expires_days: outcome.allowlist_max_expires_days,
},
source_limits: runtime_input.source_limits,
report,
verify,
})
}
pub(crate) fn resolved_scan_config_for_scanner(scanner: ScannerConfig) -> ResolvedScanConfig {
let min_confidence = scanner.min_confidence;
let ml_enabled = scanner.ml_enabled;
ResolvedScanConfig {
backend_override: None,
batch_pipeline: false,
threads: None,
reader_threads: None,
fused_batch: FUSED_BATCH_DEFAULT,
fused_depth: None,
gpu_runtime_policy: keyhog_scanner::gpu::GpuRuntimePolicy::Auto,
autoroute_gpu: false,
autoroute_calibration: false,
scanner,
min_confidence,
ml_enabled,
detector_min_confidence: std::collections::HashMap::new(),
disabled_detectors: std::collections::HashSet::new(),
require_lockdown: false,
regex_dfa_limit: None,
gpu_batch_input_limit: None,
max_file_size: None,
#[cfg(feature = "git")]
max_commits: MAX_COMMITS_DEFAULT,
no_default_excludes: false,
exclude_paths: Vec::new(),
incremental: false,
incremental_cache_path: None,
hyperscan_cache_dir: None,
autoroute_cache_path: None,
matcher_cache_path: None,
calibration_cache_path: None,
calibration_entry_count: 0,
calibration_digest: 0,
aws_canary_accounts: Vec::new(),
scanner_tuning: keyhog_scanner::ScannerTuningConfig::default(),
allowlist: ResolvedAllowlistConfig {
file: None,
require_reason: false,
require_approved_by: false,
max_expires_days: None,
},
source_limits: keyhog_sources::SourceLimits::default(),
report: ResolvedReportPolicy {
format: crate::args::OutputFormat::Text,
severity: None,
dedup: CliDedupScope::Credential,
verify: false,
lockdown: false,
show_secrets: false,
no_suppress_test_fixtures: false,
hide_client_safe: false,
},
verify: ResolvedVerifyPolicy::disabled(),
}
}
#[doc(hidden)]
pub(crate) mod testing {
use anyhow::Result;
use keyhog_core::DetectorSpec;
use std::path::Path;
pub(crate) fn sanitise_thread_count(
requested: usize,
physical_cores: usize,
source: &'static str,
) -> usize {
super::runtime::testing::sanitise_thread_count(requested, physical_cores, source)
}
pub(crate) fn load_detectors_from_dir_with_cache(
source_dir: &Path,
cache_path: &Path,
) -> Result<Vec<DetectorSpec>> {
super::detectors::testing::load_detectors_from_dir_with_cache(source_dir, cache_path)
}
}