Ssf
Table of Contents
Interfaces
- ReplayStore
- Remembers the `jti`s an {@see SsfReceiver} already accepted (CONTRACT.md §32.7 step 9).
Classes
- InMemoryReplayStore
- The default {@see ReplayStore}: one process's memory, entries expiring after the window.
- RefusedSet
- One SET a poll returned that {@see SsfReceiver::verifySet()} refused.
- SecurityEvent
- A verified Security Event Token — {@see SsfReceiver::verifySet()}'s result (CONTRACT.md
§32.7).
- SetErr
- One RFC 8936 `setErrs` entry: the RFC 8935 §2.4 `err` code and an optional description.
- SetVerificationError
- A Security Event Token refused by {@see SsfReceiver::verifySet()} (CONTRACT.md §32.7) — an
{@see AuthError}, as §32.7 requires, carrying the step that failed as a typed
{@see SetFailureReason}. {@see AuthError::getReason()} returns the same code as a string.
- SsfEventTypes
- The six event types AXIAM transmits and the two SSF stream events (CONTRACT.md §32.6), as
named constants. Event types are open: a SET of another type still verifies, and
{@see SecurityEvent::$eventType} carries it verbatim.
- SsfPollOptions
- Arguments to {@see SsfReceiver::poll()} (RFC 8936). Every member is passed through exactly
as given; an unset (`null`) one is not sent, so a poll with no options sends `{}`.
- SsfPollResult
- What {@see SsfReceiver::poll()} returns: the verified SETs and the refused ones, apart — and
the ones it could not judge.
- SsfReceiver
- The SSF receiver helper — CONTRACT.md §32.7 (contract 1.56).
Enums
- SetFailureReason
- Why {@see SsfReceiver::verifySet()} refused a Security Event Token — the bracketed reason
codes of CONTRACT.md §32.7, one per verification step that can fail.