Struct SamlSp 

pub struct SamlSp { /* private fields */ }

Available on crate features sso-saml and sso only.

A SAML 2.0 Service Provider — see the module docs.

Implementations

impl SamlSp

pub fn new(config: SamlConfig) -> SamlSp

Create a new SamlSp. Defaults post_login_redirect to / and the four intercepted paths to /saml/{metadata,login,acs,logout}.

pub fn attribute_map(self, map: AttributeMap) -> SamlSp

Set the AttributeMap translating IdP attribute names to claim field names.

pub fn post_login_redirect(self, path: &str) -> SamlSp

Override the default post-login redirect path (default: /).

pub fn login_path(self, path: &str) -> SamlSp

Override the login path (default: /saml/login).

pub fn acs_path(self, path: &str) -> SamlSp

Override the ACS path (default: /saml/acs).

pub fn logout_path(self, path: &str) -> SamlSp

Override the logout path (default: /saml/logout).

pub fn metadata_path(self, path: &str) -> SamlSp

Override the SP metadata path (default: /saml/metadata).

pub fn claims(req: &Request) -> Option<SamlClaims>

Read the SAML claims injected by SamlSp from a request. Returns None if the request did not pass through an authenticated SamlSp layer.

pub fn name_id(req: &Request) -> Option<String>

Shortcut: return the NameID from the injected claims.

pub fn attr(req: &Request, field: &str) -> Option<String>

Shortcut: return a mapped attribute field from the injected claims.

Trait Implementations

impl Middleware for SamlSp

fn handle( &self, request: &Request, connection: &ConnectionInfo, next: &dyn Application, ) -> Result<Response, String>

fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool

true when this layer’s own work for request never blocks (in-memory state, atomics, short mutexes) — see Application::runs_inline. A WithMiddleware stack runs inline only if every layer and the inner application agree. Default false.

fn is_passthrough( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when handle would do nothing for request but call next (e.g. a rate limit that isn’t configured). A WithMiddleware stack offers the inner application’s execute_async only if every layer passes the request through. Default false.

fn accepts_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer never reads request.body, so the inner application may receive it as a stream (Application::streams_body). A layer that inspects the body (CSRF tokens in a form, request signatures, rewriting) must keep the default false: it would see an empty body.

fn answers_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer answers request itself — it doesn’t call next — and reads its body as a stream (a proxy forwarding it as it arrives). The body is then streamed whatever the layers after it and the application would say. Requires accepts_streamed_body. Since 18.3.0.

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

A short name for this layer, as tools that describe an app list it (Application::middleware_names): by default the type’s name without its module path or generic parameters (CacheLayer). Since 18.28.0.