Skip to main content

EnvExpansionRule

Struct EnvExpansionRule 

Source
pub struct EnvExpansionRule { /* private fields */ }
Expand description

Rejects input containing environment variable expansion patterns.

Detects:

  • $NAME (simple variable reference)
  • ${NAME} (braced variable reference)
  • %NAME% (Windows-style variable reference)

§Intentionally allowed patterns

The following patterns are not flagged:

  • Positional parameters ($1, $2, …) — These start with a digit and are not environment variable names. They are common in pricing text (e.g. "$5 off") and typically cannot leak secrets.
  • Lone $ at end of input — Not a valid expansion.

If your use case requires blocking positional parameters as well, combine this rule with ShellMetaRule, which rejects the $ character itself.

§Rationale

Environment variable expansion can leak secrets or alter behavior:

$HOME/.ssh/id_rsa   → leaks home directory
${SECRET_KEY}        → leaks credentials
%USERPROFILE%        → Windows equivalent

Implementations§

Source§

impl EnvExpansionRule

Source

pub fn posix_only() -> Self

Create a POSIX-only rule (skip %VAR% detection).

Trait Implementations§

Source§

impl Default for EnvExpansionRule

Source§

fn default() -> Self

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

impl Rule for EnvExpansionRule

Source§

fn name(&self) -> &'static str

A unique, human-readable identifier for this rule.
Source§

fn check(&self, input: &str) -> RuleResult

Check the input and return violations, if any.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.