Struct rusty_hogs::SecretScanner

pub struct SecretScanner {
    pub regex_map: BTreeMap<String, Regex>,
    pub pretty_print: bool,
    pub output_path: Option<String>,
}

Contains helper functions and the map of regular expressions that are used to find secrets

The main object that provides the "secret scanning" functionality. The regex_map field provides all the regular expressions that the secret scanner will look for. Use get_matches(line: [u8]) to perform a regex.find_iter() for each regular expression in regex_map. get_matches will return another BTreeMap where the key is the name of the regular expression and the value is a Matches object.

Fields

regex_map: BTreeMap<String, Regex>

pretty_print: bool

output_path: Option<String>

Methods

impl SecretScanner

pub fn set_logging(verbose_level: u64)

Helper function to set global logging level

pub fn matches<'a, 'b: 'a>(
    &'a self,
    line: &'b [u8]
) -> BTreeMap<&'a String, Matches>

Scan a byte array for regular expression matches, returns a BTreeMap of Matches for each regular expression.

pub fn entropy_findings(line: &[u8]) -> Vec<String>

Scan a byte array for arbitrary hex sequences and base64 sequences. Will return a list of matches for those sequences with a high amount of entropy, potentially indicating a private key.

pub fn output_findings<T: Serialize + Eq + Hash>(&self, findings: &HashSet<T>)

Helper function that takes a HashSet of serializable structs and outputs them as JSON Side effect: May write to the file-system based on self.output_path

Trait Implementations

impl Clone for SecretScanner

fn clone(&self) -> SecretScanner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretScanner

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

Formats the value using the given formatter.

impl Default for SecretScanner

fn default() -> Self

Returns the "default value" for a type.

impl Display for SecretScanner

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

Formats the value using the given formatter.

impl Eq for SecretScanner

impl Hash for SecretScanner

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<SecretScanner> for SecretScanner

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.