unstrip 1.2.0

Recover symbols, types, and method signatures from stripped Go binaries. Ghidra/IDA/Binary Ninja exporters included.
Documentation
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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
//! Garble obfuscation detection from recovered function names.
//!
//! The `output::detect_garble` entry point answers a coarse "are any of the
//! three big garble signals (rewritten pclntab magic, missing buildVersion,
//! hashed-looking user names) tripped". This module is the finer-grained
//! pass: it ignores metadata entirely and looks only at the shape of the
//! USER-space function name distribution. Real Go binaries have a long-tail
//! mix of `pkg.Func` dotted names; garble rewrites the user packages into
//! short, uniform, Go-identifier-safe hashes (`_xUmF`, `KbZxz_a`). The
//! signals are:
//!
//!   H1 dotless ratio   share of user names without a package dot
//!   H2 uniform length  mean length in [3, 9] and stdev < 2.5
//!   H3 charset shape   short identifier with underscore-or-mixed-case
//!
//! H1 + H2 together fire the verdict; H3 only nudges confidence. Falls
//! back to "indeterminate" below a 50-function sample. See the README for
//! the rationale on the thresholds.
//!
//! `detect()` here is heuristic-only and metadata-free, so it is unit-
//! testable against synthetic Function lists. The richer combined report
//! (this plus magic and buildVersion signals) lives in
//! `crate::output::detect_garble` and gates the warning emitted from
//! `--info` and `--buildinfo`.

use crate::gobin::{GoBinary, SectionKind};
use crate::pclntab::Function;

/// Minimum number of user-space functions required before the heuristic
/// will commit to a verdict. Below this the result is always "indeterminate".
pub const MIN_SAMPLE: usize = 50;

/// Verdict shape from `detect()`. `is_garbled` only fires when there were
/// enough samples AND H1 + H2 both tripped; `confidence` is 0.0 when we
/// declined for lack of evidence.
#[derive(Debug, Clone, Default)]
pub struct GarbleVerdict {
    pub is_garbled: bool,
    pub confidence: f32,
    pub evidence: Vec<String>,
}

/// Run the name-shape heuristic over the recovered function set. Pure
/// function of the names; no I/O. Returns `is_garbled = false` with
/// confidence 0.0 and an "insufficient sample" evidence line when fewer
/// than `MIN_SAMPLE` user-space names are present.
pub fn detect(functions: &[Function]) -> GarbleVerdict {
    let user: Vec<&str> = functions
        .iter()
        .map(|f| f.name.as_str())
        .filter(|n| is_user_space(n))
        .collect();

    if user.len() < MIN_SAMPLE {
        return GarbleVerdict {
            is_garbled: false,
            confidence: 0.0,
            evidence: vec![format!(
                "insufficient sample: {} user-space functions (need {})",
                user.len(),
                MIN_SAMPLE
            )],
        };
    }

    let total = user.len() as f32;
    let dotless: Vec<&str> = user.iter().copied().filter(|n| !n.contains('.')).collect();
    let dotless_ratio = dotless.len() as f32 / total;
    let h1 = dotless_ratio >= 0.50;

    let lens: Vec<f32> = dotless.iter().map(|n| n.len() as f32).collect();
    let (mean_len, stdev) = mean_stdev(&lens);
    let h2 = !dotless.is_empty() && (3.0..=9.0).contains(&mean_len) && stdev < 2.5;

    let short_hits = dotless
        .iter()
        .filter(|n| looks_like_garbled_identifier(n))
        .count();
    let short_ratio = if dotless.is_empty() {
        0.0
    } else {
        short_hits as f32 / dotless.len() as f32
    };
    let h3 = short_ratio >= 0.60;

    let mut evidence = Vec::new();
    evidence.push(format!(
        "dotless user-name ratio: {:.2} ({}/{})",
        dotless_ratio,
        dotless.len(),
        user.len()
    ));
    evidence.push(format!(
        "dotless name length: mean {:.2}, stdev {:.2}",
        mean_len, stdev
    ));
    evidence.push(format!(
        "short identifier ratio: {:.2} ({}/{})",
        short_ratio,
        short_hits,
        dotless.len().max(1)
    ));

    let mut is_garbled = false;
    let confidence: f32;
    if h1 && h2 {
        is_garbled = true;
        let mut c = 0.9_f32;
        if h3 {
            c += 0.05;
            evidence.push("charset signal (H3) present".into());
        }
        confidence = c;
    } else {
        confidence = (dotless_ratio * 0.5).clamp(0.0, 0.49);
        if !h1 {
            evidence.push("H1 dotless ratio below 0.50".into());
        }
        if !h2 {
            evidence.push("H2 uniform length signal absent".into());
        }
    }

    GarbleVerdict {
        is_garbled,
        confidence: confidence.min(1.0),
        evidence,
    }
}

/// True when the name belongs to user (main / first-party) space. We filter
/// out runtime, reflect, type metadata, special compiler symbols, and any
/// import-path-shaped name (slash or double-dot), so the remaining set is
/// the surface garble actually rewrites.
fn is_user_space(name: &str) -> bool {
    if name.starts_with("runtime.")
        || name.starts_with("reflect.")
        || name.starts_with("type:")
        || name.starts_with("type..")
        || name.starts_with("go:")
        || name.starts_with("go.")
        || name.starts_with("gcWriteBarrier")
        || name.starts_with("$f64.")
        || name.starts_with("$f32.")
    {
        return false;
    }
    if name.contains('/') || name.contains("..") {
        return false;
    }
    true
}

/// Garble's hashed identifiers are Go-identifier-safe, short, and either
/// carry a leading underscore or mix case. Real short symbols (asm stubs,
/// closures) don't cluster on that pattern.
fn looks_like_garbled_identifier(name: &str) -> bool {
    let len = name.len();
    if !(3..=9).contains(&len) {
        return false;
    }
    let mut chars = name.chars();
    let first = match chars.next() {
        Some(c) => c,
        None => return false,
    };
    if !(first.is_ascii_alphabetic() || first == '_') {
        return false;
    }
    let body_ok = name.chars().all(|c| c.is_ascii_alphanumeric() || c == '_');
    if !body_ok {
        return false;
    }
    let has_underscore = name.contains('_');
    let has_lower = name.chars().any(|c| c.is_ascii_lowercase());
    let has_upper = name.chars().any(|c| c.is_ascii_uppercase());
    has_underscore || (has_lower && has_upper)
}

// ---------------------------------------------------------------------------
//
// Unified garble assessment.
//
// `detect()` above is the name-shape detector and runs metadata-free for
// unit testability. `crate::output::detect_garble` is the structural
// detector (pclntab magic + buildVersion + name hashing). On obfuscated
// binaries the two can legitimately disagree: garble's default mode
// keeps method names intact (so dotted `pkg.Method` symbols survive in
// many user packages and the dotless-ratio statistic stays low), even
// though pclntab magic and buildVersion are clearly rewritten.
//
// Surfacing two separate "is_garbled" verdicts on the same binary made
// the tool look like it was contradicting itself in two adjacent
// invocations (`--info` vs `--detect-garble`). [`assess`] is the
// reconciliation: one verdict, one confidence, plus a structured
// breakdown of every individual signal's vote so the operator can audit
// why we landed where we did.
//
// Verdict precedence (intentional, not weighted-vote):
//   1. Structural evidence dominates. A rewritten pclntab magic byte is
//      a thing garble does and nothing else does; if we see it we are
//      garbled, even when the name-shape statistic disagrees.
//   2. Below that, a two-of-three majority across {magic, buildVersion,
//      hashed-names structural ratio, name-shape verdict} fires garbled.
//   3. Below that, indeterminate.
//
// Indeterminate exists because zero-sample, runtime-only inputs and
// otherwise-clean binaries should not be force-classified.

/// Vote of a single underlying heuristic.
#[derive(Debug, Clone, serde::Serialize)]
pub struct Signal {
    /// Stable identifier for grep/CI gating (e.g. `pclntab.magic`,
    /// `runtime.build_version`, `names.hashed_ratio`,
    /// `names.shape_heuristic`).
    pub id: &'static str,
    /// Did this signal fire?
    pub fired: bool,
    /// One-sentence justification of why it did or didn't fire.
    pub detail: String,
}

/// The fused verdict surfaced by `--detect-garble` and the warning block
/// in `--info` / `--buildinfo`. One answer, one confidence, structured
/// per-signal evidence.
#[derive(Debug, Clone, serde::Serialize)]
pub struct GarbleAssessment {
    /// Three-state verdict: `Garbled`, `Clean`, or `Indeterminate`. Use
    /// this for routing; use the [`GarbleAssessment::exit_code`] helper
    /// for CI gating.
    pub verdict: Verdict,
    /// Combined confidence in `[0.0, 1.0]`. 1.0 when the magic signal
    /// fires (structural evidence is conclusive); lower when we relied
    /// on a majority vote of weaker signals.
    pub confidence: f32,
    /// Every signal we evaluated, in stable order. Lets CI gate on a
    /// specific signal id rather than the fused verdict.
    pub signals: Vec<Signal>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize)]
#[serde(rename_all = "lowercase")]
pub enum Verdict {
    Garbled,
    Clean,
    Indeterminate,
}

impl GarbleAssessment {
    /// Exit code for `--detect-garble`:
    ///   0 = garbled, 1 = clean, 2 = indeterminate. CI scripts gate on
    /// these and the values are part of the public contract.
    pub fn exit_code(&self) -> i32 {
        match self.verdict {
            Verdict::Garbled => 0,
            Verdict::Clean => 1,
            Verdict::Indeterminate => 2,
        }
    }

    /// `true` when the fused verdict is `Garbled`. Convenience for
    /// callers that don't care about the indeterminate case.
    pub fn is_garbled(&self) -> bool {
        matches!(self.verdict, Verdict::Garbled)
    }
}

/// Fuse the structural garble report with the name-shape heuristic into
/// a single authoritative verdict. Both `--detect-garble` and the
/// garble warning block in `--info` / `--buildinfo` route through this
/// function so they always agree byte-for-byte on the verdict and the
/// per-signal evidence.
pub fn assess(
    functions: &[Function],
    go_version: Option<&str>,
    magic_is_official: bool,
) -> GarbleAssessment {
    let structural = crate::output::detect_garble(functions, go_version, magic_is_official);
    let shape = detect(functions);

    let mut signals = Vec::with_capacity(4);
    signals.push(Signal {
        id: "pclntab.magic",
        fired: structural.magic_rewritten,
        detail: if structural.magic_rewritten {
            "pclntab magic is not 0xfffffff1 / 0xfffffff0 (garble rewrites it)".into()
        } else {
            "pclntab magic matches an official Go release".into()
        },
    });
    signals.push(Signal {
        id: "runtime.build_version",
        fired: structural.version_overwritten,
        detail: if structural.version_overwritten {
            "runtime.buildVersion missing or non-standard (garble overwrites it)".into()
        } else {
            "runtime.buildVersion looks like a real Go release".into()
        },
    });
    let names_ratio_fired = structural
        .hashed_names
        .map(|(h, t)| t > 0 && (h * 5) > (t * 2))
        .unwrap_or(false);
    signals.push(Signal {
        id: "names.hashed_ratio",
        fired: names_ratio_fired,
        detail: match structural.hashed_names {
            Some((h, t)) => {
                format!("{h}/{t} user-package function names look hashed (threshold > 40%)")
            }
            None => "fewer than 20 user-space functions to evaluate".into(),
        },
    });
    signals.push(Signal {
        id: "names.shape_heuristic",
        fired: shape.is_garbled,
        detail: if shape.evidence.is_empty() {
            format!(
                "dotless-name shape heuristic (confidence {:.2})",
                shape.confidence
            )
        } else {
            // Pull the first two evidence lines — they are the
            // ratio and length numbers the heuristic actually voted
            // on.
            let mut joined = shape
                .evidence
                .iter()
                .take(2)
                .cloned()
                .collect::<Vec<_>>()
                .join("; ");
            joined.push_str(&format!(
                "; H1+H2 verdict: {} (confidence {:.2})",
                shape.is_garbled, shape.confidence
            ));
            joined
        },
    });

    // Magic-byte signal is conclusive on its own: nothing else in the
    // Go ecosystem rewrites that constant. When it fires we are
    // garbled with confidence 1.0, regardless of what the name-shape
    // heuristic thinks.
    if structural.magic_rewritten {
        return GarbleAssessment {
            verdict: Verdict::Garbled,
            confidence: 1.0,
            signals,
        };
    }

    let fired = signals.iter().filter(|s| s.fired).count();
    let evaluable = signals
        .iter()
        .filter(|s| {
            // names.hashed_ratio with `None` evidence means we did not
            // evaluate it; don't count it against indeterminacy. All
            // other signals are always evaluable.
            !(s.id == "names.hashed_ratio" && s.detail.starts_with("fewer than 20"))
        })
        .count();

    if fired >= 2 {
        let confidence = match fired {
            2 => 0.75,
            3 => 0.9,
            _ => 0.95,
        };
        GarbleAssessment {
            verdict: Verdict::Garbled,
            confidence,
            signals,
        }
    } else if evaluable < 2 {
        GarbleAssessment {
            verdict: Verdict::Indeterminate,
            confidence: 0.0,
            signals,
        }
    } else {
        GarbleAssessment {
            verdict: Verdict::Clean,
            confidence: 1.0 - (fired as f32) * 0.2,
            signals,
        }
    }
}

fn mean_stdev(xs: &[f32]) -> (f32, f32) {
    if xs.is_empty() {
        return (0.0, 0.0);
    }
    let n = xs.len() as f32;
    let mean = xs.iter().sum::<f32>() / n;
    let var = xs.iter().map(|x| (x - mean).powi(2)).sum::<f32>() / n;
    (mean, var.sqrt())
}

/// An obfuscated-to-original name dictionary recovered from a garble binary.
///
/// To keep `reflect` working, garble embeds a table mapping every obfuscated
/// reflected name back to its original, and patches the runtime name reader to
/// translate on the fly. The table is a `[]string` of `[obf, orig, obf, orig,
/// ...]` injected into the main package; even though `-s -w` strips its symbol,
/// the backing array is a run of Go string headers in a data section and the
/// keys are sorted, which is enough to find and parse it. This is the highest
/// value artifact on a garbled binary: it recovers type, field, and method
/// names that are otherwise only present as hashes.
#[derive(Debug, Clone, Default)]
pub struct ReflectNames {
    obf_to_orig: std::collections::HashMap<String, String>,
}

impl ReflectNames {
    pub fn len(&self) -> usize {
        self.obf_to_orig.len()
    }

    pub fn is_empty(&self) -> bool {
        self.obf_to_orig.is_empty()
    }

    /// Original name for one obfuscated token, if known.
    pub fn translate(&self, obf: &str) -> Option<&str> {
        self.obf_to_orig.get(obf).map(String::as_str)
    }

    /// Pairs in arbitrary order, for dumping the dictionary.
    pub fn iter(&self) -> impl Iterator<Item = (&str, &str)> {
        self.obf_to_orig
            .iter()
            .map(|(k, v)| (k.as_str(), v.as_str()))
    }

    /// Relabel every function name in place.
    pub fn relabel_functions(&self, functions: &mut [Function]) {
        for f in functions {
            f.name = self.relabel(&f.name);
        }
    }

    /// Relabel type names and, for structs, their field names in place.
    pub fn relabel_types(&self, types: &mut [crate::types::Type]) {
        for t in types {
            t.name = self.relabel(&t.name);
            if let crate::types::KindData::Struct { fields } = &mut t.kind_data {
                for field in fields {
                    field.name = self.relabel(&field.name);
                }
            }
        }
    }

    /// Relabel the interface, concrete, and method names of each itab in place.
    pub fn relabel_itabs(&self, itabs: &mut [crate::itabs::Itab]) {
        for it in itabs {
            it.interface_name = self.relabel(&it.interface_name);
            it.concrete_name = self.relabel(&it.concrete_name);
            for m in &mut it.methods {
                m.interface_method = self.relabel(&m.interface_method);
            }
        }
    }

    /// Rewrite a qualified name, replacing each obfuscated identifier token with
    /// its original where the dictionary knows it. Tokens are the maximal
    /// `[A-Za-z0-9_]` runs, so the separators in `*pkg.Type.Method` survive and
    /// only the hashed parts change.
    pub fn relabel(&self, name: &str) -> String {
        let mut out = String::with_capacity(name.len());
        let mut tok = String::new();
        let flush = |tok: &mut String, out: &mut String| {
            if !tok.is_empty() {
                match self.obf_to_orig.get(tok.as_str()) {
                    Some(orig) => out.push_str(orig),
                    None => out.push_str(tok),
                }
                tok.clear();
            }
        };
        for ch in name.chars() {
            if ch.is_ascii_alphanumeric() || ch == '_' {
                tok.push(ch);
            } else {
                flush(&mut tok, &mut out);
                out.push(ch);
            }
        }
        flush(&mut tok, &mut out);
        out
    }
}

/// Smallest pair count we will accept as the name table. A handful of valid
/// string headers can occur by chance in any data section; a sorted run this
/// long of identifier-charset keys does not.
const MIN_NAME_PAIRS: usize = 8;

/// Recover garble's obfuscated-to-original reflected-name dictionary, if the
/// binary carries one. Returns None on a non-garbled binary (no such table) or
/// when the table can't be located.
pub fn recover_reflect_names(bin: &GoBinary) -> Option<ReflectNames> {
    if bin.pointer_size() != 8 {
        return None; // 64-bit string headers only for now
    }
    let mut best: Option<ReflectNames> = None;
    for section in &bin.sections {
        // The table lives in writable or read-only data, never in code or bss.
        match section.kind {
            SectionKind::Data | SectionKind::NoPtrData | SectionKind::ReadOnlyData => {}
            _ => continue,
        }
        let start = section.file_offset.min(bin.bytes.len());
        let end = section
            .file_offset
            .saturating_add(section.file_size)
            .min(bin.bytes.len());
        let mut off = start;
        while off + 16 <= end {
            // A run is consecutive 16-byte string headers that each resolve to
            // a short printable string.
            if string_header(bin, off).is_some() {
                let mut run = Vec::new();
                let mut p = off;
                while p + 16 <= end {
                    match string_header(bin, p) {
                        Some(s) => run.push(s),
                        None => break,
                    }
                    p += 16;
                }
                if let Some(map) = pairs_from_run(&run) {
                    if best.as_ref().is_none_or(|b| map.len() > b.len()) {
                        best = Some(map);
                    }
                }
                off = p.max(off + 16);
            } else {
                off += 8;
            }
        }
    }
    best.filter(|m| !m.is_empty())
}

/// Read a Go string header (`{data *byte; len int}`) at file offset `off` and
/// return the pointed-to string when it is a short printable run.
fn string_header(bin: &GoBinary, off: usize) -> Option<String> {
    let ptr = u64::from_le_bytes(bin.bytes.get(off..off + 8)?.try_into().ok()?);
    let len = u64::from_le_bytes(bin.bytes.get(off + 8..off + 16)?.try_into().ok()?);
    if len == 0 || len > 128 {
        return None;
    }
    let bytes = bin.read_at_addr(ptr, len as usize)?;
    if bytes.iter().all(|&b| b.is_ascii_graphic() || b == b' ') {
        Some(String::from_utf8_lossy(bytes).into_owned())
    } else {
        None
    }
}

/// Interpret a run of string-header strings as the `[obf, orig, ...]` table.
/// garble sorts the array by the obfuscated key, so the table shows up as a
/// long stretch of pairs whose key column is strictly ascending and
/// identifier-charset. The run may also absorb adjacent, unrelated string
/// headers, so rather than demanding the whole run qualify, take the longest
/// contiguous segment of ascending identifier keys under each pairing
/// alignment. The wrong alignment (keys land on the original column) is not
/// sorted, so its longest segment stays short.
fn pairs_from_run(run: &[String]) -> Option<ReflectNames> {
    let mut best: Option<ReflectNames> = None;
    for align in [0usize, 1] {
        let pairs: Vec<(&String, &String)> = (align..run.len().saturating_sub(1))
            .step_by(2)
            .map(|i| (&run[i], &run[i + 1]))
            .collect();
        let mut j = 0;
        while j < pairs.len() {
            let mut k = j;
            while k < pairs.len()
                && is_identifier_token(pairs[k].0)
                && (k == j || pairs[k - 1].0 < pairs[k].0)
            {
                k += 1;
            }
            if k - j >= MIN_NAME_PAIRS {
                let map: std::collections::HashMap<String, String> = pairs[j..k]
                    .iter()
                    .map(|(key, val)| ((*key).clone(), (*val).clone()))
                    .collect();
                if best.as_ref().is_none_or(|b| map.len() > b.len()) {
                    best = Some(ReflectNames { obf_to_orig: map });
                }
            }
            j = k.max(j + 1);
        }
    }
    best
}

/// A garble key is a base64-derived identifier: only `[A-Za-z0-9_]`, no dots or
/// slashes, within a plausible hash length.
fn is_identifier_token(s: &str) -> bool {
    (1..=32).contains(&s.len()) && s.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'_')
}

#[cfg(test)]
mod tests {
    use super::*;

    fn func(name: &str) -> Function {
        Function {
            address: 0,
            name: name.to_string(),
            file: None,
            start_line: None,
        }
    }

    fn synthetic_normal(n: usize) -> Vec<Function> {
        // A spread of dotted user names plus the usual runtime padding.
        // Lengths and shapes vary so the variance check stays high.
        let mut out = Vec::new();
        for i in 0..n {
            out.push(func(&format!("main.handleRequest{i}")));
            out.push(func(&format!("github.com/acme/proj/api.Server{i}.Serve")));
            out.push(func(&format!("runtime.gcMark{i}")));
        }
        out
    }

    fn synthetic_garbled(n: usize) -> Vec<Function> {
        // Garble-shaped hashes: short, identifier-safe, no dots, mixed
        // case or underscored, uniform length.
        let samples = [
            "_xUmF", "KbZxz_a", "_qq3w", "Vn4Hp", "_aA1bC", "kkLmN", "_z0pQr", "Ww8eR_", "_b3LpQ",
            "Tt9_kX",
        ];
        let mut out = Vec::new();
        for i in 0..n {
            out.push(func(samples[i % samples.len()]));
        }
        // Garble still leaves runtime alone; include some so the filter
        // path is exercised.
        for i in 0..20 {
            out.push(func(&format!("runtime.gcMark{i}")));
        }
        out
    }

    #[test]
    fn declines_below_sample_threshold() {
        let funcs = synthetic_normal(5);
        let v = detect(&funcs);
        assert!(!v.is_garbled);
        assert_eq!(v.confidence, 0.0);
        assert!(v.evidence.iter().any(|e| e.contains("insufficient sample")));
    }

    #[test]
    fn normal_binary_does_not_trip() {
        let funcs = synthetic_normal(60);
        let v = detect(&funcs);
        assert!(!v.is_garbled, "verdict: {v:?}");
        assert!(v.confidence < 0.5, "confidence: {v:?}");
    }

    #[test]
    fn garbled_binary_trips_with_high_confidence() {
        let funcs = synthetic_garbled(80);
        let v = detect(&funcs);
        assert!(v.is_garbled, "verdict: {v:?}");
        assert!(v.confidence >= 0.9, "confidence: {v:?}");
        assert!(v.evidence.iter().any(|e| e.contains("dotless")));
    }

    #[test]
    fn runtime_only_is_insufficient_sample() {
        // 100 runtime names should all get filtered out, leaving zero
        // user-space samples.
        let funcs: Vec<Function> = (0..100)
            .map(|i| func(&format!("runtime.gcMark{i}")))
            .collect();
        let v = detect(&funcs);
        assert!(!v.is_garbled);
        assert!(v.evidence[0].contains("insufficient sample"));
    }

    #[test]
    fn import_paths_are_filtered_from_user_space() {
        // Names with slashes (vendor / module paths) are not user-space for
        // the purposes of this heuristic.
        assert!(!is_user_space("github.com/foo/bar.Baz"));
        assert!(!is_user_space("type:.eq.[3]int"));
        assert!(is_user_space("main.run"));
        assert!(is_user_space("_xUmF"));
    }

    #[test]
    fn charset_check_rejects_plain_lowercase_words() {
        assert!(!looks_like_garbled_identifier("hello"));
        assert!(!looks_like_garbled_identifier("server"));
        assert!(looks_like_garbled_identifier("_xUmF"));
        assert!(looks_like_garbled_identifier("KbZxz_a"));
    }

    // ---- assess() unification tests --------------------------------
    //
    // The point of `assess` is that `--detect-garble` and the warning
    // in `--info` / `--buildinfo` never disagree on the same input.
    // These tests pin the precedence the implementation depends on:
    // rewritten magic is conclusive on its own; otherwise majority of
    // evaluable signals fires the verdict; otherwise indeterminate.

    #[test]
    fn assess_magic_alone_is_conclusive() {
        // Pclntab magic rewrite is a thing garble does and nothing else
        // does. On its own it should fire Garbled at confidence 1.0
        // even when the name-shape heuristic would have voted clean.
        let funcs = synthetic_normal(60);
        let a = assess(&funcs, Some("go1.22.2"), /* magic_is_official */ false);
        assert_eq!(a.verdict, Verdict::Garbled);
        assert_eq!(a.confidence, 1.0);
        assert_eq!(a.exit_code(), 0);
        let magic = a.signals.iter().find(|s| s.id == "pclntab.magic").unwrap();
        assert!(magic.fired, "magic signal must have fired");
    }

    #[test]
    fn assess_clean_binary_is_clean() {
        let funcs = synthetic_normal(60);
        let a = assess(&funcs, Some("go1.22.2"), true);
        assert_eq!(a.verdict, Verdict::Clean);
        assert_eq!(a.exit_code(), 1);
    }

    #[test]
    fn assess_majority_of_evaluable_signals_fires() {
        // No magic rewrite, but version is overwritten AND the
        // name-shape heuristic fires AND most user names look hashed.
        // That's 3 of 4 signals, well over the 2-of-evaluable bar.
        let funcs = synthetic_garbled(80);
        let a = assess(&funcs, None, true);
        assert_eq!(a.verdict, Verdict::Garbled);
        assert!(a.confidence >= 0.75);
        assert_eq!(a.exit_code(), 0);
    }

    #[test]
    fn assess_signal_count_matches_emitted_signals() {
        // Stable contract for CI gating: callers grep on signal ids.
        // Adding or removing a signal here is a public-API change.
        let funcs = synthetic_normal(60);
        let a = assess(&funcs, Some("go1.22.2"), true);
        let ids: Vec<&str> = a.signals.iter().map(|s| s.id).collect();
        assert_eq!(
            ids,
            vec![
                "pclntab.magic",
                "runtime.build_version",
                "names.hashed_ratio",
                "names.shape_heuristic",
            ]
        );
    }

    #[test]
    fn assess_resolves_field_test_self_contradiction() {
        // Regression test for the field-test pain point. On the actual
        // garbled shfmt sample `--info` reported "likely garbled" with
        // three structural reasons while `--detect-garble` reported
        // `is_garbled: false, confidence: 0.01` because the name-shape
        // statistic alone disagreed. assess() must collapse these to
        // one Garbled verdict no matter which signals the caller asks
        // about. Simulated by: magic rewritten, build version wiped,
        // user names still mostly dotted (name-shape heuristic clean).
        let mut funcs = Vec::new();
        for i in 0..120 {
            // Garble default keeps method names visible, so the
            // package-half is hashed but a dot survives in the symbol.
            // Name-shape's dotless-ratio statistic stays low here.
            funcs.push(func(&format!("Hx7m{}.Method", i)));
        }
        let a = assess(&funcs, None, /* magic_is_official */ false);
        assert_eq!(
            a.verdict,
            Verdict::Garbled,
            "structural magic rewrite must dominate even when name-shape disagrees"
        );
        // The name-shape detector ran but voted clean; that's a
        // signal we surface in the breakdown, not a contradiction the
        // operator sees.
        let shape = a
            .signals
            .iter()
            .find(|s| s.id == "names.shape_heuristic")
            .unwrap();
        assert!(
            !shape.fired,
            "name-shape signal must not fire on dotted obfuscated names"
        );
    }
}