keyhog-sources 0.5.42

keyhog-sources: pluggable input backends for KeyHog (git, S3, GCS, Azure Blob, Docker, Web)
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

//! Swappable compiled-binary analyzer contract and implementations.

use std::path::Path;

use keyhog_core::{Chunk, SourceError};

mod ghidra;
#[cfg(test)]
mod tests;

pub(super) use ghidra::{find_ghidra_headless, GhidraAnalyzer};

pub(super) struct BinaryAnalysisRequest<'a> {
    pub(super) path: &'a Path,
    pub(super) decompiled_bytes_limit: u64,
    pub(super) timeout: std::time::Duration,
}

pub(super) trait BinaryAnalyzer {
    fn analyze(
        &self,
        request: BinaryAnalysisRequest<'_>,
    ) -> Result<BinaryAnalysisOutcome, SourceError>;
}

#[derive(Debug)]
pub(super) enum BinaryAnalysisOutcome {
    Complete(Vec<Chunk>),
    Degraded(BinaryAnalysisDegradation),
}

#[derive(Debug, PartialEq, Eq)]
pub(super) enum BinaryAnalysisDegradation {
    ToolFailure {
        reason: String,
        stderr_excerpt: String,
    },
    OutputTooLarge {
        actual_bytes: u64,
        limit_bytes: u64,
    },
}