Struct SamlValidationContext 

pub struct SamlValidationContext<'a> { /* private fields */ }

Caller-owned validation context for typed inbound SAML messages.

Implementations

impl<'a> SamlValidationContext<'a>

pub fn new(now: SystemTime, replay: ReplayPolicy<'a>) -> Self

Build a validation context that allows five minutes of clock skew.

The same skew covers assertion conditions, bearer confirmation, SessionNotOnOrAfter, and LogoutRequest@NotOnOrAfter. Self::with_clock_skew replaces it.

Examples found in repository

examples/sso.rs (line 34)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    use saml_rs::{
        AcsEndpoint, AuthnRequest, BrowserInput, CertificatePem, Credentials, EntityId, IdpConfig,
        IdpDescriptor, IdpValidationPolicy, MetadataTrustPolicy, NameId, PrivateKeyPem,
        RelayStateParam, ReplayPolicy, RespondSso, Saml, SamlValidationContext, SpConfig,
        SpDescriptor, SpValidationPolicy, SsoEndpoint, SsoResponse, StartSso, Subject,
    };
    use std::time::SystemTime;

    let privkey = include_str!("../tests/fixtures/key/sp_privkey.pem");
    let cert = include_str!("../tests/fixtures/key/sp_signing_cert.cer");
    let credentials = || Credentials {
        signing_key: Some(PrivateKeyPem::new(privkey)),
        signing_certificate: Some(CertificatePem::new(cert)),
        ..Credentials::default()
    };
    // DisabledForCompatibility preserves the raw API, which has no replay cache.
    let validation =
        || SamlValidationContext::new(SystemTime::now(), ReplayPolicy::DisabledForCompatibility);

    let sp = Saml::sp(
        SpConfig::builder(EntityId::try_new("https://sp.example.com/metadata")?)
            .acs_endpoint(AcsEndpoint::post("https://sp.example.com/acs")?)
            .credentials(credentials())
            .validation(SpValidationPolicy::strict())
            .build()?,
    )?;
    let idp = Saml::idp(
        IdpConfig::builder(EntityId::try_new("https://idp.example.com/metadata")?)
            .sso_endpoint(SsoEndpoint::post("https://idp.example.com/sso")?)
            .credentials(credentials())
            .validation(IdpValidationPolicy::strict())
            .build()?,
    )?;

    let sp_descriptor = SpDescriptor::from_metadata_xml_for(
        EntityId::try_new("https://sp.example.com/metadata")?,
        sp.metadata_xml(),
        // UnsignedForCompatibility preserves an unsigned samlify-port metadata import.
        MetadataTrustPolicy::UnsignedForCompatibility,
    )?;
    let idp_descriptor = IdpDescriptor::from_metadata_xml_for(
        EntityId::try_new("https://idp.example.com/metadata")?,
        idp.metadata_xml(),
        // UnsignedForCompatibility preserves an unsigned samlify-port metadata import.
        MetadataTrustPolicy::UnsignedForCompatibility,
    )?;

    let relay_state = RelayStateParam::try_from_option(Some("demo-state".to_string()))?;
    let started = sp.start_sso(&idp_descriptor, StartSso::post().relay_state(relay_state))?;
    println!(
        "SP  -> AuthnRequest id = {}",
        started.pending.request_id().as_str()
    );

    let request = idp.receive_sso(
        &sp_descriptor,
        BrowserInput::<AuthnRequest>::post(started.outbound.post_form()?.fields().to_vec()),
        validation(),
    )?;
    println!(
        "IdP <- request issuer  = {}",
        request.message().issuer().as_str()
    );

    let response = idp.respond_sso(
        &sp_descriptor,
        &request,
        Subject::new(NameId::new("alice@example.com", None), Vec::new()),
        RespondSso::post(),
    )?;

    let session = sp.finish_sso(
        &idp_descriptor,
        &started.pending,
        BrowserInput::<SsoResponse>::post(response.post_form()?.fields().to_vec()),
        validation(),
    );
    let session = session?;
    println!("SP  <- authenticated   = {}", session.name_id().value());
    Ok(())
}

examples/slo.rs (line 34)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    use saml_rs::{
        AcsEndpoint, AuthnRequest, BrowserInput, CertificatePem, Credentials, EntityId, IdpConfig,
        IdpDescriptor, IdpValidationPolicy, LogoutRequest, LogoutResponse, MetadataTrustPolicy,
        NameId, PrivateKeyPem, ReplayPolicy, RespondSlo, RespondSso, Saml, SamlValidationContext,
        SloEndpoint, SpConfig, SpDescriptor, SpValidationPolicy, SsoEndpoint, SsoResponse,
        StartSlo, StartSso, Subject,
    };
    use std::time::SystemTime;

    let privkey = include_str!("../tests/fixtures/key/sp_privkey.pem");
    let cert = include_str!("../tests/fixtures/key/sp_signing_cert.cer");
    let credentials = || Credentials {
        signing_key: Some(PrivateKeyPem::new(privkey)),
        signing_certificate: Some(CertificatePem::new(cert)),
        ..Credentials::default()
    };
    // DisabledForCompatibility preserves the raw API, which has no replay cache.
    let validation =
        || SamlValidationContext::new(SystemTime::now(), ReplayPolicy::DisabledForCompatibility);

    let sp = Saml::sp(
        SpConfig::builder(EntityId::try_new("https://sp.example.com/metadata")?)
            .acs_endpoint(AcsEndpoint::post("https://sp.example.com/acs")?)
            .slo_endpoint(SloEndpoint::post("https://sp.example.com/slo")?)
            .credentials(credentials())
            .validation(SpValidationPolicy::strict())
            .build()?,
    )?;
    let idp = Saml::idp(
        IdpConfig::builder(EntityId::try_new("https://idp.example.com/metadata")?)
            .sso_endpoint(SsoEndpoint::post("https://idp.example.com/sso")?)
            .slo_endpoint(SloEndpoint::post("https://idp.example.com/slo")?)
            .credentials(credentials())
            .validation(IdpValidationPolicy::strict())
            .build()?,
    )?;
    let sp_descriptor = SpDescriptor::from_metadata_xml_for(
        EntityId::try_new("https://sp.example.com/metadata")?,
        sp.metadata_xml(),
        // UnsignedForCompatibility preserves an unsigned samlify-port metadata import.
        MetadataTrustPolicy::UnsignedForCompatibility,
    )?;
    let idp_descriptor = IdpDescriptor::from_metadata_xml_for(
        EntityId::try_new("https://idp.example.com/metadata")?,
        idp.metadata_xml(),
        // UnsignedForCompatibility preserves an unsigned samlify-port metadata import.
        MetadataTrustPolicy::UnsignedForCompatibility,
    )?;

    let sso = sp.start_sso(&idp_descriptor, StartSso::post())?;
    let request = idp.receive_sso(
        &sp_descriptor,
        BrowserInput::<AuthnRequest>::post(sso.outbound.post_form()?.fields().to_vec()),
        validation(),
    )?;
    let response = idp.respond_sso(
        &sp_descriptor,
        &request,
        Subject::new(NameId::new("alice@example.com", None), Vec::new()),
        RespondSso::post(),
    )?;
    let session = sp.finish_sso(
        &idp_descriptor,
        &sso.pending,
        BrowserInput::<SsoResponse>::post(response.post_form()?.fields().to_vec()),
        validation(),
    )?;

    let subject = session
        .logout_subject()
        .ok_or("session has no logout subject")?;
    let logout = sp.start_slo(&idp_descriptor, subject, StartSlo::post())?;
    println!("SP  -> LogoutRequest id = {}", logout.pending.id().as_str());

    let logout_request = idp.receive_slo(
        &sp_descriptor,
        BrowserInput::<LogoutRequest>::post(logout.outbound.post_form()?.fields().to_vec()),
        validation(),
    )?;
    let logout_response = idp.respond_slo(
        &sp_descriptor,
        &logout_request,
        RespondSlo::post().relay_state(logout.pending.relay_state().clone()),
    )?;
    let completed = sp.finish_slo(
        &idp_descriptor,
        &logout.pending,
        BrowserInput::<LogoutResponse>::post(logout_response.post_form()?.fields().to_vec()),
        validation(),
    )?;
    println!(
        "SP  <- LogoutResponse status = {}",
        completed.status().unwrap_or("missing")
    );
    Ok(())
}

pub fn with_clock_skew(self, clock_skew: ClockSkew) -> Self

Replace the context clock skew, including ClockSkew::strict.

pub fn with_authn_request_age( self, authn_request_age: AuthnRequestAgePolicy, ) -> Self

Select the maximum age of an inbound AuthnRequest IssueInstant.

AuthnRequestAgePolicy::Disabled skips the comparison. AuthnRequestAgePolicy::Bounded accepts an instant at or after now - max_age - past_tolerance and at or before now + future_tolerance. Both edges are inclusive. Past tolerance is the positive NotOnOrAfter skew. Future tolerance is the magnitude of a negative NotBefore skew. Zero skew and inverted skew do not shrink max_age.

pub fn with_replay_retention(self, retention: Duration) -> Self

Set explicit replay retention for protocol messages that do not carry a SAML NotOnOrAfter value suitable for cache expiry.

pub fn now(&self) -> SystemTime

Validation instant supplied by the caller.

pub fn clock_skew(&self) -> ClockSkew

Clock skew applied to time-window checks.

pub fn authn_request_age(&self) -> AuthnRequestAgePolicy

Maximum age policy for an inbound AuthnRequest IssueInstant.

pub fn replay_retention(&self) -> Option<Duration>

Replay retention for protocol message IDs without SAML expiry.