AzureAdAuth

Struct AzureAdAuth 

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

Azure AD authentication provider.

This provider supports Azure AD / Entra ID federated authentication using pre-acquired access tokens (Tier 1) or token acquisition with the azure-identity feature (Tier 2).

§Example

use mssql_auth::AzureAdAuth;

// Using a pre-acquired token
let auth = AzureAdAuth::with_token("eyJ0eXAi...");

Implementations§

Source§

impl AzureAdAuth

Source

pub fn with_token(token: impl Into<Cow<'static, str>>) -> Self

Create an Azure AD authenticator with a pre-acquired token.

This is the simplest form - provide a valid access token obtained from Azure AD / Entra ID via your preferred method.

§Arguments
  • token - A valid JWT access token for Azure SQL Database
Source

pub fn with_token_expiring( token: impl Into<Cow<'static, str>>, expires_in: Duration, ) -> Self

Create an Azure AD authenticator with a token and expiration.

Providing the expiration time allows the driver to proactively refresh tokens before they expire.

§Arguments
  • token - A valid JWT access token
  • expires_in - Duration until the token expires
Source

pub fn from_credentials(credentials: &Credentials) -> Result<Self, AuthError>

Create from existing credentials.

Returns an error if the credentials are not Azure AD credentials.

Source

pub fn with_library(self, library: FedAuthLibrary) -> Self

Set the library type to report to the server.

Source

pub fn is_expired(&self) -> bool

Check if the token is expired.

Source

pub fn is_expiring_soon(&self, within: Duration) -> bool

Check if the token is expiring soon (within the given duration).

Source

pub fn build_feature_data(&self) -> Bytes

Build the FEDAUTH feature extension data for Login7.

Format:

  • 1 byte: Library type (ADAL=1, SecurityToken=2, MSAL=3)
  • 1 byte: Workflow (0x00 for pre-acquired token)
  • 4 bytes: FedAuth token length (big-endian)
  • N bytes: FedAuth token (UTF-16LE encoded)
Source

pub fn build_token_data(&self) -> Bytes

Build the FEDAUTH token packet data.

This is the token data sent in response to FEDAUTHINFO from the server.

Trait Implementations§

Source§

impl AuthProvider for AzureAdAuth

Source§

fn method(&self) -> AuthMethod

Get the authentication method this provider uses.
Source§

fn authenticate(&self) -> Result<AuthData, AuthError>

Authenticate and produce authentication data. Read more
Source§

fn feature_extension_data(&self) -> Option<Bytes>

Get additional feature extension data for Login7. Read more
Source§

fn needs_refresh(&self) -> bool

Check if this provider needs to refresh its authentication. Read more
Source§

impl Clone for AzureAdAuth

Source§

fn clone(&self) -> AzureAdAuth

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 AzureAdAuth

Source§

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

Formats the value using the given formatter. 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> 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