Expand description
Maintained compatibility re-export of saml-rs.
use samlet::{Saml, Sp};
let _: Option<Saml<Sp>> = 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.
- Algorithm
Policy - Algorithm choices used by outgoing SAML messages.
- Assertion
- Assertion view extracted from an SSO session.
- Assertion
Id - Assertion ID extracted from a SAML assertion.
- Attribute
- SAML attribute with one or more values.
- Attribute
Value - A single SAML attribute value.
- Attributes
- Collection of SAML attributes.
- Authn
Request - Parsed AuthnRequest result.
- Authn
Session - Session data from one
AuthnStatement. - Certificate
Pem - PEM-encoded X.509 certificate material.
- Clock
Skew - Clock skew applied to SAML time-window checks.
- Credentials
- Secret-bearing and certificate material for local SAML operations.
- Crypto
Provider Info - Attested information about the selected document-crypto provider.
- Endpoint
Url - Absolute HTTP(S) endpoint URL used by typed SAML endpoint wrappers.
- Entity
Id - SAML entity ID.
- Entity
Setting - Re-export kept for older crate-root imports of the raw samlify-port API. Use
Samlfor new integrations; advanced raw callers should importraw::EntitySetting. Runtime configuration for an entity (keys, algorithms, flags). - Form
Field - HTML form field emitted or consumed by browser POST bindings.
- Identity
Provider - Re-export kept for older crate-root imports of the raw samlify-port API. Use
Samlfor new integrations; advanced raw callers should importraw::IdentityProvider. A SAML 2.0 Identity Provider: runtimeEntitySettingplus parsedIdpMetadata. - Idp
- Marker role for an Identity Provider facade.
- IdpConfig
- Typed Identity Provider configuration.
- IdpConfig
Builder - Dependency-free builder for
IdpConfig. - IdpDescriptor
- Typed IdP peer descriptor imported from metadata.
- IdpMetadata
Config - Local IdP metadata inputs used by typed configuration.
- IdpValidation
Policy - IdP-side validation policy.
- Logout
Completed - Marker result for completed logout flows.
- Logout
Policy - Logout request and response signature policy.
- Logout
Request - Parsed LogoutRequest result.
- Logout
Response - Parsed LogoutResponse result.
- Logout
Subject - Subject data used to issue a front-channel Single Logout request.
- Message
Id - SAML protocol message
ID. - Metadata
Signature Verification - Detailed metadata signature verification result.
- NameId
- NameID value, format, and optional qualifier attributes.
- Name
IdPolicy - AuthnRequest NameIDPolicy.
- Outbound
- Typed outbound browser action.
- Outstanding
Logout - A
LogoutRequestthe caller has already accepted. - Passphrase
- Passphrase used to decrypt private key material.
- Pending
- Pending SAML message correlation state.
- Pending
Snapshot - Persistable correlation snapshot for a pending SAML message.
- Post
Form - Typed auto-submit POST form data.
- Private
KeyPem - PEM-encoded private key material.
- Received
- Typed received message wrapper.
- Relay
State - RelayState value when a browser message carries the parameter.
- Requested
Subject - Subject requested by an
<AuthnRequest>(Core §3.4.1). - Respond
Slo - Options for issuing a LogoutResponse.
- Respond
Sso - Options for issuing SAML Responses from an IdP.
- Saml
- Typed SAML facade for high-level browser SSO/SLO flows.
- Saml
Instant - SAML instant text carried in pending snapshots and parsed results.
- Saml
Validation Context - Caller-owned validation context for typed inbound SAML messages.
- Service
Provider - Re-export kept for older crate-root imports of the raw samlify-port API. Use
Samlfor new integrations; advanced raw callers should importraw::ServiceProvider. A SAML 2.0 Service Provider: runtimeEntitySettingplus parsedSpMetadata. - Session
Index - SessionIndex from an AuthnStatement or LogoutRequest.
- SloEndpoint
- Single Logout service endpoint.
- Sp
- Marker role for a Service Provider facade.
- SpConfig
- Typed Service Provider configuration.
- SpConfig
Builder - Dependency-free builder for
SpConfig. - SpDescriptor
- Typed SP peer descriptor imported from metadata.
- SpMetadata
Config - Local SP metadata inputs used by typed configuration.
- SpValidation
Policy - SP-side validation and outbound signing policy.
- SsoEndpoint
- Single Sign-On service endpoint.
- SsoResponse
- Parsed SSO response envelope.
- SsoSession
- Parsed SSO login session.
- Start
Slo - Options for issuing a LogoutRequest.
- Start
Sso - Options for starting SP-initiated Web SSO.
- Started
- Started browser flow with pending state and outbound browser action.
- Status
- Top-level
StatusCodeand an optional subordinate code. - Subject
- SAML subject.
- Subject
Confirmation - SubjectConfirmation captured from the validated flow result.
- Subordinate
Status Code - Optional second-level
StatusCode. - Template
Policy - Template and XML tag-prefix customization.
- Verified
XmlSignature - Evidence from one successfully verified embedded XML signature.
- XmlEncryption
Policy - XML encryption policy.
- XmlPolicy
- XML parser, redirect decompression, clock, and XML encryption policy.
Enums§
- Assertion
Encryption Policy - Whether assertions are encrypted in generated responses.
- Assertion
Signature Policy - Whether an accepting service provider requires a signature on the Assertion itself.
- Audience
Validation Policy - Whether an accepting service provider evaluates
<AudienceRestriction>. - Authn
Request AgePolicy - Maximum age for an inbound
AuthnRequestIssueInstant. - Authn
Request Signing Policy - Whether an SP signs outgoing AuthnRequests.
- Authn
Request Validation Policy - Whether an identity provider requires a signed inbound
<AuthnRequest>. - Browser
Input - Typed browser input for inbound SAML messages.
- Crypto
Fips Status - Runtime FIPS attestation state for the selected provider.
- Crypto
Provider - Compile-time selected document-crypto provider.
- Data
Encryption Algorithm - XML-Enc content encryption algorithm.
- Digest
Algorithm - XML digest algorithm URI used by XML-DSig profiles.
- Force
Authn ForceAuthnon an<AuthnRequest>(Core §3.4.1).- IsPassive
IsPassiveon an<AuthnRequest>(Core §3.4.1).- KeyEncryption
Algorithm - XML-Enc key transport algorithm.
- Logout
Binding - Single Logout bindings supported by the typed API.
- Logout
Signature Policy - Whether logout messages require signatures.
- Logout
Signing - Explicit signing choice for typed Single Logout requests.
- Metadata
Trust Policy - Explicit trust policy for imported SAML metadata.
- Name
IdCreation Policy - Whether SP AuthnRequests allow IdPs to create a new identifier.
- Name
IdCreation Request - AuthnRequest NameID creation request.
- Name
IdFormat - SAML NameID format URI.
- Relay
State Param - RelayState represented as absent, present empty, or present with a value.
- Replay
Key - Replay cache key derived from a validated SAML message.
- Replay
Policy - Replay behavior for typed inbound browser flows.
- Requested
Subject Identifier - Identifier inside a requested
RequestedSubject(Core §3.4.1). - Response
Signature Policy - Whether an accepting service provider requires a signature on the
<Response>. - Signature
Algorithm - XML signature algorithm used for outgoing signed messages.
- SsoRequest
Binding - Browser SSO request bindings supported by the typed API.
- SsoResponse
Binding - Browser SSO response bindings supported by the typed API.
- TopLevel
Status Code - Top-level
StatusCodevalue. - Transform
Algorithm - XML-DSig transform or canonicalization algorithm.
- Unknown
- Marker role used before a facade has been configured as an SP or IdP.
- Verified
XmlSignature Coverage - Authenticated SAML objects covered by one verified embedded XML signature.
- XmlSignature
Profile - Inbound embedded XML-signature algorithm profile for accepted SSO and Single Logout messages.
Constants§
- MAX_
RELAY_ STATE_ BYTES - SAML Bindings 2.0 prohibits a RelayState value longer than 80 bytes.
Traits§
- Replay
Cache - Caller-owned replay cache.
Functions§
- crypto_
provider_ info - Inspect the selected provider without triggering initialization.
- initialize_
crypto_ provider - Initialize and attest the selected document-crypto provider.
Type Aliases§
- Pending
Authn Request - Pending AuthnRequest correlation state.
- Pending
Logout Request - Pending LogoutRequest correlation state.
- Saml
Error - Error type returned by the typed SAML API.