Skip to main content

Module model

Module model 

Source
Expand description

Typed SAML domain models built from validated raw flow results.

References: SAML Core 2.0 https://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf and SAML Profiles 2.0 https://docs.oasis-open.org/security/saml/v2.0/saml-profiles-2.0-os.pdf.

Structs§

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.
ClockSkew
Clock skew applied to SAML time-window checks.
EndpointUrl
Absolute HTTP(S) endpoint URL used by typed SAML endpoint wrappers.
LogoutCompleted
Marker result for completed logout flows.
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.
NameId
NameID value, format, and optional qualifier attributes.
NameIdPolicy
AuthnRequest NameIDPolicy.
OutstandingLogout
A LogoutRequest the caller has already accepted.
Received
Typed received message wrapper.
RelayState
RelayState value when a browser message carries the parameter.
RequestedSubject
Subject requested by an <AuthnRequest> (Core §3.4.1).
SamlInstant
SAML instant text carried in pending snapshots and parsed results.
SamlValidationContext
Caller-owned validation context for typed inbound SAML messages.
SessionIndex
SessionIndex from an AuthnStatement or LogoutRequest.
SsoResponse
Parsed SSO response envelope.
SsoSession
Parsed SSO login session.
Status
Top-level StatusCode and an optional subordinate code.
Subject
SAML subject.
SubjectConfirmation
SubjectConfirmation captured from the validated flow result.
SubordinateStatusCode
Optional second-level StatusCode.
VerifiedXmlSignature
Evidence from one successfully verified embedded XML signature.

Enums§

ForceAuthn
ForceAuthn on an <AuthnRequest> (Core §3.4.1).
IsPassive
IsPassive on an <AuthnRequest> (Core §3.4.1).
NameIdCreationRequest
AuthnRequest NameID creation request.
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.
RequestedSubjectIdentifier
Identifier inside a requested RequestedSubject (Core §3.4.1).
TopLevelStatusCode
Top-level StatusCode value.
VerifiedXmlSignatureCoverage
Authenticated SAML objects covered by one verified embedded XML signature.

Constants§

MAX_RELAY_STATE_BYTES
SAML Bindings 2.0 prohibits a RelayState value longer than 80 bytes.

Traits§

ReplayCache
Caller-owned replay cache.