Skip to main content

Crate truman_core

Crate truman_core 

Source
Expand description

truman-core: core types, traits, filters, and scanner.

This crate holds everything detector-agnostic: findings with exact positions, the Detector trait + DetectorRegistry, file-type detection, the staged FilterSet pipeline, entropy helpers, and the parallel Scanner

Re-exports§

pub use detector::Detector;
pub use detector::DetectorContext;
pub use detector::DetectorRegistry;
pub use detector::RawFinding;
pub use entropy::base64_shannon_entropy;
pub use entropy::hex_shannon_entropy;
pub use entropy::shannon_entropy;
pub use entropy::shannon_entropy_bytes;
pub use error::Result;
pub use error::TrumanError;
pub use filetype::determine_file_type;
pub use filetype::FileType;
pub use filter::is_allowlisted;
pub use filter::is_indirect_reference;
pub use filter::is_invalid_file;
pub use filter::is_likely_id_string;
pub use filter::is_likely_id_string_at;
pub use filter::is_lock_file;
pub use filter::is_non_text_file;
pub use filter::is_not_alphanumeric_string;
pub use filter::is_potential_uuid;
pub use filter::is_prefixed_with_dollar_sign;
pub use filter::is_regex_based_detector;
pub use filter::is_sequential_string;
pub use filter::is_swagger_file;
pub use filter::is_templated_secret;
pub use filter::should_exclude_due_to_verification_policy;
pub use filter::should_exclude_file;
pub use filter::should_exclude_line;
pub use filter::should_exclude_secret;
pub use filter::FileFilter;
pub use filter::FilterConfig;
pub use filter::FilterSet;
pub use filter::LineFilter;
pub use filter::SecretFilter;
pub use finding::Finding;
pub use finding::Location;
pub use finding::Span;
pub use finding::VerifiedResult;
pub use scanner::hash_secret;
pub use scanner::scan_paths_streaming;
pub use scanner::FileStats;
pub use scanner::ScanConfig;
pub use scanner::ScanEvent;
pub use scanner::Scanner;

Modules§

detector
entropy
Shannon entropy helpers for high-entropy detectors.
error
filetype
filter
Staged filter pipeline.
finding
scanner
Parallel file scanner with streaming callbacks.

Constants§

VERSION
Crate version (mirrors workspace version).