Expand description
Strict, sans-I/O SCRAM protocol engine.
This scaffold provides bounded transcript-preserving message parsers,
canonical encoders, exact transcript assembly, explicit credential,
channel-binding, policy, and secret types, and consuming SCRAM-SHA-256 client
and server roles, including SHA-256-PLUS. The opt-in sha512 feature adds
the widely deployed, unregistered SHA-512 extension profile. Both profiles
retain explicit derivation and application continuations.
Modules§
- message
- Borrowed SCRAM message views that preserve exact authenticated fragments.
Structs§
- Ascii
Profile - A strict profile for protocols that intentionally limit credentials to printable ASCII.
- Authentication
Properties - Nonsecret mechanism properties established by complete proof verification.
- Authorization
Request - Borrowed, proof-verified request presented to application authorization policy.
- Awaiting
Client Final - Server state that accepts exactly one client-final message.
- Awaiting
Server Final - A client state that accepts exactly one server-final message.
- Awaiting
Server First - A client state that accepts exactly one server-first message.
- Channel
Binding - One validated channel-binding name and payload supplied by the transport.
- Channel
Binding Data - Owned channel-binding bytes, redacted and zeroized like other key material.
- Channel
Binding Name - A validated GS2 channel-binding name.
- Client
Authenticated - Terminal proof that the selected SCRAM server signature was verified.
- Client
Config - Owned configuration consumed by one SCRAM client conversation.
- Client
Config Builder - Consuming builder for one
ClientConfig. - Client
Policy - Client-side limits and derivation policy.
- Concealment
Key - Server-side secret used to derive deterministic unknown-user verifier records.
- Concealment
Profile - Public verifier shape reproduced for deterministic unknown-user records.
- Credential
Request - Borrowed identity request for an application credential store.
- Iteration
Count - A positive iteration count parsed from a SCRAM challenge or credential.
- Iteration
Policy - Credential-strength and denial-of-service bounds for derivation work.
- Need
Credential - One parsed client-first message awaiting caller-owned credential lookup.
- Need
Identity Preparation - Parsed client-first state awaiting one explicit server identity profile.
- Nonce
Error - An opaque nonce-source failure.
- Outbound
Message - An owned SCRAM message whose contents are explicit to access and zeroized on drop.
- Pending
Authorization - Proof-verified state awaiting one application authorization decision.
- Pending
Derivation - One transcript-bound challenge awaiting explicit PBKDF2 derivation.
- Pending
Server Credential - One prepared password awaiting explicit verifier PBKDF2 derivation.
- Prepared
Authentication Identity - Authentication identity prepared by an explicit credential profile.
- Prepared
Authorization Identity - Authorization identity prepared by an explicit credential profile.
- Prepared
Credentials - Credentials prepared exactly once for one SCRAM conversation.
- Prepared
Password - Password bytes that have already passed one explicit preparation profile.
- Received
Authentication Identity - Authentication identity decoded from one client-first message, before preparation.
- Received
Authorization Identity - Authorization identity decoded from one client-first message, before preparation.
- Resource
Limits - Bounds for attacker-controlled message structure and decoded values.
- Resource
Limits Builder - A consuming builder for
ResourceLimits. - Rfc5802
Profile - The RFC 5802
SASLprepcredential profile. - Salt
- Owned salt paired with a server verifier record.
- Salt
Policy - Credential-strength bounds for decoded salt bytes.
- Secret
Bytes - Owned secret bytes that are zeroized on drop.
- Secret
String - Owned UTF-8 secret text that is zeroized on drop.
- Server
- One configured namespace value consumed to begin a server conversation.
- Server
Authenticated - Terminal proof of authentication and application authorization.
- Server
Config - Owned, secret-free configuration consumed by one server conversation.
- Server
Config Builder - Consuming builder for one
ServerConfig. - Server
Credential - Binary SCRAM verifier material independent of any storage serialization.
- Server
Policy - Server-side limits and credential iteration policy.
Enums§
- Algorithm
- A supported, internally coherent SCRAM algorithm profile.
- Attribute
Name - A reserved SCRAM attribute name safe to include in diagnostics.
- Authentication
Error - Authentication failed after structurally valid protocol processing.
- Authorization
Outcome - Result of one explicit application authorization decision.
- Channel
Binding Mode - The negotiated GS2 channel-binding mode.
- Channel
Binding Outcome - The channel-binding property authenticated by a successful exchange.
- Client
- Namespace for starting a SCRAM client conversation.
- Credential
Response - Caller-supplied lookup result that never exposes an unknown-user variant.
- Crypto
Error - A cryptographic operation failed without exposing intermediates.
- Error
- The top-level library error.
- Peer
Error - A bounded SCRAM peer-error classification.
- Policy
Error - An application-selected security policy rejected otherwise valid input.
- Preparation
Error - Credential preparation failed without retaining credential contents.
- Proof
Result - Result of complete client-proof processing.
- Protocol
Error - A structural SCRAM protocol failure.
- State
Error - A consuming state-machine transition was invalid.
Traits§
- Nonce
Source - A caller-owned source of unpredictable nonce bytes.