Skip to main content

ScanConfig

Struct ScanConfig 

Source
pub struct ScanConfig {
Show 17 fields pub min_confidence: f64, pub max_decode_depth: usize, pub entropy_enabled: bool, pub entropy_in_source_files: bool, pub entropy_threshold: f64, pub min_secret_len: usize, pub max_file_size: u64, pub dedup: DedupScope, pub ml_enabled: bool, pub ml_weight: f64, pub unicode_normalization: bool, pub decode_size_limit: usize, pub max_matches_per_chunk: usize, pub known_prefixes: Vec<String>, pub secret_keywords: Vec<String>, pub test_keywords: Vec<String>, pub placeholder_keywords: Vec<String>,
}
Expand description

Configuration for a scan run.

Fields§

§min_confidence: f64

Minimum confidence (0.0 to 1.0) required to report a finding.

§max_decode_depth: usize

Maximum recursive decoding depth (e.g. Base64(Hex(URL(secret)))).

§entropy_enabled: bool

Whether to enable Shannon entropy analysis for unknown high-entropy strings.

§entropy_in_source_files: bool

Whether to enable entropy analysis even in standard source code files.

§entropy_threshold: f64

Shannon entropy threshold (typical secrets are 4.5+).

§min_secret_len: usize

Minimum length for entropy-based secret detection.

§max_file_size: u64

Maximum file size to scan (bytes). Large files are skipped or sampled.

§dedup: DedupScope

Deduplication strategy.

§ml_enabled: bool

Whether to enable ML-based probabilistic gating.

§ml_weight: f64

Weight given to the ML score (0.0 to 1.0).

§unicode_normalization: bool

Whether to normalize Unicode characters before scanning.

§decode_size_limit: usize

Maximum bytes allowed from recursive decoding.

§max_matches_per_chunk: usize

Maximum matches allowed per chunk to prevent OOM.

§known_prefixes: Vec<String>

List of common secret prefixes to prioritize.

§secret_keywords: Vec<String>

List of keywords that strongly indicate a secret.

§test_keywords: Vec<String>

Keywords used in test environments.

§placeholder_keywords: Vec<String>

Keywords for placeholders and documentation.

Implementations§

Source§

impl ScanConfig

Source

pub fn fast() -> Self

Fast configuration optimized for speed over exhaustive recall.

Source

pub fn thorough() -> Self

Thorough configuration for deep penetration into encoded layers.

Source

pub fn paranoid() -> Self

Maximum paranoia: deep decoding and aggressive entropy analysis.

Source

pub fn validate(&self) -> Result<(), ConfigError>

Validate the configuration parameters.

Trait Implementations§

Source§

impl Clone for ScanConfig

Source§

fn clone(&self) -> ScanConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ScanConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ScanConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ScanConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ScanConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,