Struct OpenIdConnectMiddleware 

pub struct OpenIdConnectMiddleware { /* private fields */ }

Open ID Connect Middleware.

Implementations

impl OpenIdConnectMiddleware

pub async fn new(config: &Config) -> Self

Create a new instance.

Requests the Identity Provider’s metadata and uses that to initialize various provider-specific configuration inside of the middleware.

Panics

Panics if the OpenID Connect provider metadata could not be retrieved or does not match the configured issuer_url.

Defaults

The defaults for OpenIdConnectMiddleware are:

• redirect strategy: HttpRedirect
• login path: /login
• scopes: ["openid"]
• login landing path: /
• logout path: /logout
• logout destroys session: true
• logout landing path: /

Examples

use tide_openidconnect::{self};

let config = tide_openidconnect::Config {
    // ... set/load config ...
};
let middleware = tide_openidconnect::OpenIdConnectMiddleware::new(&config)
    .await
    .with_logout_landing_path("/loggedout");

pub fn with_login_path(self, login_path: &str) -> Self

Sets the path to the “login” route that will be intercepted by the middleware in order to redirect the browser to the OpenID Connect authentication page.

Defaults to /login

pub fn with_scopes(self, scopes: &[impl AsRef<str>]) -> Self

Adds one or more scopes to the OpenID Connect request.

Defaults to openid (which is the minimum required scope).

pub fn with_login_landing_path(self, login_landing_path: &str) -> Self

Sets the path where the browser will be sent after a successful login sequence.

Defaults to /

pub fn with_logout_path(self, logout_path: &str) -> Self

Sets the path to the “logout” route that will be intercepted by the middleware in order to clear the sessions’s authentication state.

Defaults to /logout

pub fn with_logout_destroys_session(self, logout_destroys_session: bool) -> Self

Sets a flag indicating if the logout URL should destroy all session state – both the auth state and any app-level state – or if logout should clear only the auth state and leave the remainder of the state intact.

Applications should only retain session state after a logout if doing so will not leave any (private) artifacts of the user’s data in the session after the logout process. The current page, status of collapsed UI elements, etc. would be safe to retain, whereas the user name, form content, etc. needs to be cleared after the logout process (which can be done by, for example, configuring the logout_landing_path to go to a route that cleans up personally-identifying information after the logout completes).

Defaults to true

pub fn with_logout_landing_path(self, logout_landing_path: &str) -> Self

Sets the path where the browser will be sent after the logout sequence.

Defaults to /

pub fn with_unauthenticated_redirect_strategy<R>( self, redirect_strategy: R, ) -> Self

where R: RedirectStrategy + 'static,

Sets the trait used to generate redirect responses to unauthenticated requests.

Defaults to HttpRedirect

Trait Implementations

impl Debug for OpenIdConnectMiddleware

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

Formats the value using the given formatter.

impl<State> Middleware<State> for OpenIdConnectMiddleware

where State: Clone + Send + Sync + 'static,

fn handle<'life0, 'life1, 'async_trait>( &'life0 self, req: Request<State>, next: Next<'life1, State>, ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Asynchronously handle the request, and return a response.

fn name(&self) -> &str

Set the middleware’s name. By default it uses the type signature.