saml-rs 0.3.0

Pure-Rust SAML 2.0 Service Provider and Identity Provider support.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! Typed high-level API contract for `saml-rs`.
//!
//! Artifact binding is not part of the high-level browser SSO request binding
//! contract.
//!
//! ```compile_fail
//! use saml_rs::SsoRequestBinding;
//!
//! let binding = SsoRequestBinding::Artifact;
//! ```
//!
//! ```compile_fail
//! use saml_rs::{AuthnRequest, Received, RespondSso, Saml, Sp, SpDescriptor, Subject};
//!
//! let sp: Saml<Sp> = unreachable!();
//! let peer: SpDescriptor = unreachable!();
//! let request: Received<AuthnRequest> = unreachable!();
//! let subject: Subject = unreachable!();
//!
//! let _ = sp.respond_sso(&peer, &request, subject, RespondSso::post());
//! ```
//!
//! ```compile_fail
//! use saml_rs::{Idp, IdpDescriptor, Saml, StartSso};
//!
//! let idp: Saml<Idp> = unreachable!();
//! let peer: IdpDescriptor = unreachable!();
//!
//! let _ = idp.start_sso(&peer, StartSso::post());
//! ```

mod idp;
mod options;
mod raw_mapping;
mod slo;
mod sp;

use crate::config::{IdpConfig, SpConfig};
use crate::entity::EntitySetting;
use crate::error::SamlError as Error;
use crate::idp::IdentityProvider;
use crate::sp::ServiceProvider;

use raw_mapping::{raw_idp_metadata_config, raw_sp_metadata_config};

pub use options::{ForceAuthn, LogoutSigning, RespondSlo, RespondSso, StartSlo, StartSso};

/// Typed SAML facade for high-level browser SSO/SLO flows.
pub struct Saml<Role = Unknown>(Role);

/// Marker role used before a facade has been configured as an SP or IdP.
pub enum Unknown {}

/// Marker role for a Service Provider facade.
pub struct Sp {
    service_provider: ServiceProvider,
}

/// Marker role for an Identity Provider facade.
pub struct Idp {
    identity_provider: IdentityProvider,
}

/// Error type returned by the typed SAML API.
pub type SamlError = Error;

impl Saml {
    /// Build a typed Service Provider facade.
    ///
    /// # Errors
    ///
    /// Returns [`SamlError`] when the SP config cannot be converted into raw
    /// settings or metadata, including missing metadata, missing keys, or
    /// unsupported crypto configuration.
    pub fn sp(config: SpConfig) -> Result<Saml<Sp>, SamlError> {
        let setting = EntitySetting::try_from(&config)?;
        let raw_config = raw_sp_metadata_config(&config);
        let service_provider = ServiceProvider::from_config(&raw_config, setting)?;
        Ok(Saml(Sp { service_provider }))
    }

    /// Build a typed Identity Provider facade.
    ///
    /// # Errors
    ///
    /// Returns [`SamlError`] when the IdP config cannot be converted into raw
    /// settings or metadata, including missing metadata, missing keys, or
    /// unsupported crypto configuration.
    pub fn idp(config: IdpConfig) -> Result<Saml<Idp>, SamlError> {
        let setting = EntitySetting::try_from(&config)?;
        let raw_config = raw_idp_metadata_config(&config);
        let identity_provider = IdentityProvider::from_config(&raw_config, setting)?;
        Ok(Saml(Idp { identity_provider }))
    }
}