Enum Filter 

pub enum Filter {
    And(Vec<Filter>),
    Or(Vec<Filter>),
    Not(Box<Filter>),
    Equality {
        attribute: String,
        value: String,
    },
    GreaterOrEqual {
        attribute: String,
        value: String,
    },
    LessOrEqual {
        attribute: String,
        value: String,
    },
    Approximate {
        attribute: String,
        value: String,
    },
    Present {
        attribute: String,
    },
    Substrings {
        attribute: String,
        initial: Option<String>,
        any: Vec<String>,
        last: Option<String>,
    },
}

A search filter, built as a value rather than pasted together as a string.

This is the security-relevant type in the package. The classic LDAP injection is a filter template — (&(objectClass=person)(uid=NAME)) — with a username interpolated into it: a username of * turns the lookup into a wildcard that matches every account, and one containing )(uid=admin re- writes the filter outright.

A Filter cannot be injected into, because it never becomes a string on the way to the directory. Filter::encode writes each assertion value as a length-delimited BER octet string, where * and ) are just bytes with no syntax of their own.

Display does produce RFC 4515 text — for logs, and for anything that genuinely needs the string form — and escapes every value on the way out.

Variants

And(Vec<Filter>)

(&(a)(b)). An empty And is the absolute-true filter (&) of RFC 4526, which is well defined and matches everything.

Or(Vec<Filter>)

(|(a)(b)). An empty Or is RFC 4526’s absolute-false filter (|).

Not(Box<Filter>)

Equality

(attribute=value)

Fields

attribute: String

value: String

GreaterOrEqual

(attribute>=value)

Fields

attribute: String

value: String

LessOrEqual

(attribute<=value)

Fields

attribute: String

value: String

Approximate

(attribute~=value)

Fields

attribute: String

value: String

Present

(attribute=*) — the entry has this attribute at all.

Fields

attribute: String

Substrings

(attribute=initial*any*any*last). RFC 4511 calls the trailing part final, which is a Rust keyword, so it is last here.

Fields

attribute: String

initial: Option<String>

any: Vec<String>

last: Option<String>

Implementations

impl Filter

pub fn equals(attribute: impl Into<String>, value: impl Into<String>) -> Filter

pub fn greater_or_equal( attribute: impl Into<String>, value: impl Into<String>, ) -> Filter

pub fn less_or_equal( attribute: impl Into<String>, value: impl Into<String>, ) -> Filter

pub fn approximately( attribute: impl Into<String>, value: impl Into<String>, ) -> Filter

pub fn present(attribute: impl Into<String>) -> Filter

pub fn starts_with( attribute: impl Into<String>, prefix: impl Into<String>, ) -> Filter

pub fn ends_with( attribute: impl Into<String>, suffix: impl Into<String>, ) -> Filter

pub fn contains( attribute: impl Into<String>, fragment: impl Into<String>, ) -> Filter

pub fn and(filters: impl IntoIterator<Item = Filter>) -> Filter

pub fn or(filters: impl IntoIterator<Item = Filter>) -> Filter

pub fn negate(self) -> Filter

(!(…)). Also spelled !filter, through std::ops::Not; this form exists because it chains, and a filter is usually built left to right.

pub fn encode(&self, encoder: &mut Encoder)

Write the filter as BER, per RFC 4511 §4.5.1.

Trait Implementations

impl Clone for Filter

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 Filter

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

Formats the value using the given formatter.

impl Display for Filter

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

The RFC 4515 string form, with every value escaped.

impl Eq for Filter

impl Not for Filter

!filter, for the times that reads better than Filter::negate.

type Output = Filter

The resulting type after applying the ! operator.

fn not(self) -> Filter

Performs the unary ! operation using logical or bitwise negation.

impl PartialEq for Filter

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Filter