Skip to main content

LdapConfig

Struct LdapConfig 

Source
pub struct LdapConfig {
Show 19 fields pub url: String, pub base_dn: String, pub user_search_base: String, pub user_search_filter: String, pub group_search_base: String, pub group_search_filter: String, pub group_role_attribute: String, pub bind_dn: Option<String>, pub bind_password: Option<String>, pub user_dn_pattern: Option<String>, pub connect_timeout: Duration, pub operation_timeout: Duration, pub use_starttls: bool, pub role_prefix: String, pub convert_to_uppercase: bool, pub username_attribute: String, pub email_attribute: String, pub display_name_attribute: String, pub attribute_mappings: HashMap<String, String>,
}
Expand description

LDAP connection configuration.

Fields§

§url: String

LDAP server URL (e.g., “ldap://localhost:389” or “ldaps://localhost:636”)

§base_dn: String

Base DN for searches (e.g., “dc=example,dc=com”)

§user_search_base: String

User search base (relative to base_dn)

§user_search_filter: String

User search filter (use {0} for username placeholder)

§group_search_base: String

Group search base (relative to base_dn)

§group_search_filter: String

Group search filter (use {0} for user DN placeholder)

§group_role_attribute: String

Group role attribute (e.g., “cn”)

§bind_dn: Option<String>

Bind DN for searching (optional, for bind-then-search)

§bind_password: Option<String>

Bind password

§user_dn_pattern: Option<String>

User DN pattern for direct bind (use {0} for username)

§connect_timeout: Duration

Connection timeout

§operation_timeout: Duration

Operation timeout

§use_starttls: bool

Use StartTLS

§role_prefix: String

Role prefix (e.g., “ROLE_”)

§convert_to_uppercase: bool

Convert roles to uppercase

§username_attribute: String

Username attribute in LDAP

§email_attribute: String

Email attribute in LDAP

§display_name_attribute: String

Display name attribute in LDAP

§attribute_mappings: HashMap<String, String>

Custom attribute mappings

Implementations§

Source§

impl LdapConfig

Source

pub fn new(url: impl Into<String>) -> Self

Create a new LDAP configuration with the server URL.

Source

pub fn active_directory( url: impl Into<String>, domain: impl Into<String>, ) -> Self

Create configuration for Active Directory.

Source

pub fn base_dn(self, dn: impl Into<String>) -> Self

Set the base DN.

Source

pub fn user_search_base(self, base: impl Into<String>) -> Self

Set the user search base (relative to base DN).

Source

pub fn user_search_filter(self, filter: impl Into<String>) -> Self

Set the user search filter.

Source

pub fn group_search_base(self, base: impl Into<String>) -> Self

Set the group search base (relative to base DN).

Source

pub fn group_search_filter(self, filter: impl Into<String>) -> Self

Set the group search filter.

Source

pub fn bind_dn(self, dn: impl Into<String>) -> Self

Set the bind DN for searching.

Source

pub fn bind_password(self, password: impl Into<String>) -> Self

Set the bind password.

Source

pub fn user_dn_pattern(self, pattern: impl Into<String>) -> Self

Set the user DN pattern for direct bind authentication.

Source

pub fn connect_timeout(self, timeout: Duration) -> Self

Set connection timeout.

Source

pub fn operation_timeout(self, timeout: Duration) -> Self

Set operation timeout.

Source

pub fn use_starttls(self, use_tls: bool) -> Self

Enable StartTLS.

Source

pub fn role_prefix(self, prefix: impl Into<String>) -> Self

Set the role prefix.

Source

pub fn convert_to_uppercase(self, convert: bool) -> Self

Set whether to convert roles to uppercase.

Source

pub fn map_attribute( self, ldap_attr: impl Into<String>, user_attr: impl Into<String>, ) -> Self

Add a custom attribute mapping.

Source

pub fn full_user_search_base(&self) -> String

Get the full user search base DN.

Source

pub fn full_group_search_base(&self) -> String

Get the full group search base DN.

Source

pub fn build_user_filter(&self, username: &str) -> String

Build the user search filter with username substituted.

Source

pub fn build_group_filter(&self, user_dn: &str) -> String

Build the group search filter with user DN substituted.

Source

pub fn build_user_dn(&self, username: &str) -> Option<String>

Build the user DN from pattern.

Trait Implementations§

Source§

impl Clone for LdapConfig

Source§

fn clone(&self) -> LdapConfig

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 LdapConfig

Source§

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

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

impl Default for LdapConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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