Struct Allowlist 

pub struct Allowlist {
    pub credential_hashes: HashSet<CredentialHash>,
    pub ignored_detectors: HashSet<String>,
    pub ignored_paths: ObservedPaths,
    /* private fields */
}

User-defined suppressions loaded from .keyhogignore: credential hashes, detector IDs, and path globs.

Examples

use keyhog_core::Allowlist;

let path = std::env::temp_dir().join(format!(
    "keyhog_allowlist_struct_{}.keyhogignore",
    std::process::id()
));
std::fs::write(&path, "detector:demo-token\npath:**/*.md\n")?;
let allowlist = Allowlist::load_with_metadata_policy(&path, false, false, None)?;
std::fs::remove_file(&path)?;
assert!(allowlist.ignored_detectors.contains("demo-token"));

Fields

credential_hashes: HashSet<CredentialHash>

SHA-256 hashes of credentials to ignore.

ignored_detectors: HashSet<String>

Detector IDs to ignore entirely.

ignored_paths: ObservedPaths

Glob patterns for paths to ignore (raw, as authored). Kept as the public Vec-compatible contract + serialized form; the matcher consumes the precompiled [PathGlobIndex] built from these in Allowlist::parse.

Implementations

impl Allowlist

pub fn load_with_metadata_policy( path: &Path, require_reason: bool, require_approved_by: bool, max_expires_days: Option<u64>, ) -> Result<Self, Error>

Load from a .keyhogignore file and enforce metadata governance.

pub fn is_path_ignored(&self, path: &str) -> bool

Check whether a raw path matches an ignored-path glob.

Examples

use keyhog_core::Allowlist;

let path = std::env::temp_dir().join(format!(
    "keyhog_allowlist_path_{}.keyhogignore",
    std::process::id()
));
std::fs::write(&path, "path:**/*.md\n")?;
let allowlist = Allowlist::load_with_metadata_policy(&path, false, false, None)?;
std::fs::remove_file(&path)?;
assert!(allowlist.is_path_ignored("docs/README.md"));

Trait Implementations

impl Clone for Allowlist

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Allowlist

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Allowlist

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for Allowlist

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.