Skip to main content

Crate opensaml

Crate opensaml 

Source
Expand description

Maintained compatibility re-export of saml-rs.

use opensaml::{OpenSamlError, Saml, Sp};

let _: Option<Saml<Sp>> = None;
#[allow(deprecated)]
let _: Option<OpenSamlError> = None;

Modules§

browser
Typed browser binding, endpoint, outbound, inbound, and pending-state APIs.
config
Typed configuration building blocks for high-level SAML APIs.
constants
SAML 2.0 URN constants and keywords.
error
Error types for saml-rs.
metadata
SAML metadata parsing and shared SP/IdP metadata accessors.
model
Typed SAML domain models built from validated raw flow results.
raw
Compatibility API and low-level protocol helpers.

Structs§

AcsEndpoint
Assertion Consumer Service endpoint.
AlgorithmPolicy
Algorithm choices used by outgoing SAML messages.
Assertion
Assertion view extracted from an SSO session.
AssertionId
Assertion ID extracted from a SAML assertion.
Attribute
SAML attribute with one or more values.
AttributeValue
A single SAML attribute value.
Attributes
Collection of SAML attributes.
AuthnRequest
Parsed AuthnRequest result.
AuthnSession
Session data from one AuthnStatement.
CertificatePem
PEM-encoded X.509 certificate material.
ClockSkew
Clock skew applied to SAML time-window checks.
Credentials
Secret-bearing and certificate material for local SAML operations.
EndpointUrl
Absolute HTTP(S) endpoint URL used by typed SAML endpoint wrappers.
EntityId
SAML entity ID.
EntitySetting
Runtime configuration for an entity (keys, algorithms, flags).
FormField
HTML form field emitted or consumed by browser POST bindings.
IdentityProvider
A SAML 2.0 Identity Provider: runtime EntitySetting plus parsed IdpMetadata.
Idp
Marker role for an Identity Provider facade.
IdpConfig
Typed Identity Provider configuration.
IdpConfigBuilder
Dependency-free builder for IdpConfig.
IdpDescriptor
Typed IdP peer descriptor imported from metadata.
IdpMetadataConfig
Local IdP metadata inputs used by typed configuration.
IdpValidationPolicy
IdP-side validation policy.
LogoutCompleted
Marker result for completed logout flows.
LogoutPolicy
Logout request and response signature policy.
LogoutRequest
Parsed LogoutRequest result.
LogoutResponse
Parsed LogoutResponse result.
LogoutSubject
Subject data used to issue a front-channel Single Logout request.
MessageId
SAML protocol message ID.
MetadataSignatureVerification
Detailed metadata signature verification result.
NameId
NameID value and optional format.
NameIdPolicy
AuthnRequest NameIDPolicy.
Outbound
Typed outbound browser action.
Passphrase
Passphrase used to decrypt private key material.
Pending
Pending SAML message correlation state.
PendingSnapshot
Persistable correlation snapshot for a pending SAML message.
PostForm
Typed auto-submit POST form data.
PrivateKeyPem
PEM-encoded private key material.
Received
Typed received message wrapper.
RelayState
RelayState value when a browser message carries the parameter.
RespondSlo
Options for issuing a LogoutResponse.
RespondSso
Options for issuing SAML Responses from an IdP.
Saml
Typed SAML facade for high-level browser SSO/SLO flows.
SamlInstant
SAML instant text carried in pending snapshots and parsed results.
SamlValidationContext
Caller-owned validation context for typed inbound SAML messages.
ServiceProvider
A SAML 2.0 Service Provider: runtime EntitySetting plus parsed SpMetadata.
SessionIndex
SessionIndex from an AuthnStatement or LogoutRequest.
SloEndpoint
Single Logout service endpoint.
Sp
Marker role for a Service Provider facade.
SpConfig
Typed Service Provider configuration.
SpConfigBuilder
Dependency-free builder for SpConfig.
SpDescriptor
Typed SP peer descriptor imported from metadata.
SpMetadataConfig
Local SP metadata inputs used by typed configuration.
SpValidationPolicy
SP-side validation and outbound signing policy.
SsoEndpoint
Single Sign-On service endpoint.
SsoResponse
Parsed SSO response envelope.
SsoSession
Parsed SSO login session.
StartSlo
Options for issuing a LogoutRequest.
StartSso
Options for starting SP-initiated Web SSO.
Started
Started browser flow with pending state and outbound browser action.
Subject
SAML subject.
SubjectConfirmation
SubjectConfirmation captured from the validated flow result.
TemplatePolicy
Template and XML tag-prefix customization.
XmlEncryptionPolicy
XML encryption policy.
XmlPolicy
XML parser, redirect decompression, clock, and XML encryption policy.

Enums§

AssertionEncryptionPolicy
Whether assertions are encrypted in generated responses.
AssertionSignaturePolicy
Whether SPs require assertion-level signatures.
AudienceValidationPolicy
Whether an SP validates assertion audience restrictions.
AuthnRequestSigningPolicy
Whether an SP signs outgoing AuthnRequests.
AuthnRequestValidationPolicy
Whether an IdP requires signed inbound AuthnRequests.
BrowserInput
Typed browser input for inbound SAML messages.
DataEncryptionAlgorithm
XML-Enc content encryption algorithm.
DigestAlgorithm
XML digest algorithm URI used by XML-DSig profiles.
ForceAuthn
Explicit ForceAuthn value for outbound AuthnRequests.
KeyEncryptionAlgorithm
XML-Enc key transport algorithm.
LogoutBinding
Single Logout bindings supported by the typed API.
LogoutSignaturePolicy
Whether logout messages require signatures.
LogoutSigning
Explicit signing choice for typed Single Logout messages.
MessageSignaturePolicy
Whether SPs require message-level signatures.
MetadataTrustPolicy
Explicit trust policy for imported SAML metadata.
NameIdCreationPolicy
Whether SP AuthnRequests allow IdPs to create a new identifier.
NameIdCreationRequest
AuthnRequest NameID creation request.
NameIdFormat
SAML NameID format URI.
RelayStateParam
RelayState represented as absent, present empty, or present with a value.
ReplayKey
Replay cache key derived from a validated SAML message.
ReplayPolicy
Replay behavior for typed inbound browser flows.
SignatureAlgorithm
XML signature algorithm used for outgoing signed messages.
SsoRequestBinding
Browser SSO request bindings supported by the typed API.
SsoResponseBinding
Browser SSO response bindings supported by the typed API.
TransformAlgorithm
XML-DSig transform or canonicalization algorithm.
Unknown
Marker role used before a facade has been configured as an SP or IdP.

Constants§

MAX_RELAY_STATE_BYTES
SAML Bindings 2.0 recommends limiting RelayState to 80 bytes.

Traits§

ReplayCache
Caller-owned replay cache.

Type Aliases§

OpenSamlErrorDeprecated
Deprecated compatibility name for SamlError.
PendingAuthnRequest
Pending AuthnRequest correlation state.
PendingLogoutRequest
Pending LogoutRequest correlation state.
SamlError
Error type returned by the typed SAML API.