Struct Config

pub struct Config {

    pub verbose: u8,
    pub lemmeknow_config: Identifier,
    pub lemmeknow_min_rarity: f32,
    pub lemmeknow_max_rarity: f32,
    pub lemmeknow_tags: Vec<String>,
    pub lemmeknow_exclude_tags: Vec<String>,
    pub lemmeknow_boundaryless: bool,
    pub human_checker_on: bool,
    pub timeout: u32,
    pub top_results: bool,
    pub api_mode: bool,
    pub regex: Option<String>,
    pub wordlist_path: Option<String>,
    pub wordlist: Option<HashSet<String>>,
    pub colourscheme: HashMap<String, String>,
    pub enhanced_detection: bool,
    pub model_path: Option<String>,
}

Library input is the default API input The CLI turns its arguments into a LibraryInput struct The Config object is a default configuration object For the entire program It’s access using a variable like configuration

use ares::config::get_config;
let config = get_config();
assert_eq!(config.verbose, 0);

Fields

verbose: u8

A level of verbosity to determine. How much we print in logs.

lemmeknow_config: Identifier

The lemmeknow config to use

lemmeknow_min_rarity: f32

lemmeknow_config serialization fields

lemmeknow_max_rarity: f32

Maximum rarity threshold for lemmeknow detection

lemmeknow_tags: Vec<String>

List of lemmeknow tags to include in detection

lemmeknow_exclude_tags: Vec<String>

List of lemmeknow tags to exclude from detection

lemmeknow_boundaryless: bool

Whether to use boundaryless mode in lemmeknow detection

human_checker_on: bool

Should the human checker be on? This asks yes/no for plaintext. Turn off for API

timeout: u32

The timeout threshold before Ares quits This is in seconds

top_results: bool

Whether to collect all plaintexts until timeout expires instead of exiting after finding the first valid plaintext

api_mode: bool

Is the program being run in API mode? This is used to determine if we should print to stdout Or return the values

regex: Option<String>

Regex enables the user to search for a specific regex or crib

wordlist_path: Option<String>

Path to the wordlist file. Will be overridden by CLI argument if provided.

wordlist: Option<HashSet<String>>

Wordlist data structure (loaded from file). CLI takes precedence if both config and CLI specify a wordlist.

colourscheme: HashMap<String, String>

Colourscheme hashmap

enhanced_detection: bool

Enables enhanced plaintext detection using a BERT model.

model_path: Option<String>

Path to the enhanced detection model. If None, will use the default path.

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.