Interface ISamlRequestStore

Store port for pending SAML requests and consumed assertion ids.

All methods are async so a shared backend (Redis, a database) can implement the interface; an application running several replicas MUST supply one, because a login started on one replica is answered on whichever receives the IdP's POST.

Since

0.8.0

interface ISamlRequestStore {
    claimAssertionId(
        assertionId: string,
        retainUntil: number,
        now: number,
    ): Promise<boolean>;
    consumeRequest(
        requestId: string,
        now: number,
    ): Promise<SamlPendingRequest | null>;
    peekRequest(
        requestId: string,
        now: number,
    ): Promise<SamlPendingRequest | null>;
    saveRequest(request: SamlPendingRequest, now: number): Promise<void>;
}

Implemented by

MemorySamlRequestStore

Index

Methods

claimAssertionId consumeRequest peekRequest saveRequest

Methods

claimAssertionId

claimAssertionId(
    assertionId: string,
    retainUntil: number,
    now: number,
): Promise<boolean>
Atomically records an assertion id as used until retainUntil (ms). Returns true on the first claim and false when the id was already claimed and has not yet aged out.
Parameters
- assertionId: string
- retainUntil: number
- now: number
Returns Promise<boolean>
- Defined in packages/auth-plugin/src/stores/saml-request-store.ts:72

consumeRequest

consumeRequest(
requestId: string,
now: number,
): Promise<SamlPendingRequest | null>
Atomically removes a pending request and returns it, or null when it was already consumed, never existed, or has expired at now. Of two concurrent calls for one id, exactly one receives the record.
Parameters
- requestId: string
- now: number
Returns Promise<SamlPendingRequest | null>
- Defined in packages/auth-plugin/src/stores/saml-request-store.ts:66

peekRequest

peekRequest(requestId: string, now: number): Promise<SamlPendingRequest | null>
Reads a pending request WITHOUT consuming it, or null when absent or expired at now.
Parameters
- requestId: string
- now: number
Returns Promise<SamlPendingRequest | null>
- Defined in packages/auth-plugin/src/stores/saml-request-store.ts:60

saveRequest

saveRequest(request: SamlPendingRequest, now: number): Promise<void>
Records a pending request; now lets an implementation sweep expired entries.
Parameters
- request: SamlPendingRequest
- now: number
Returns Promise<void>
- Defined in packages/auth-plugin/src/stores/saml-request-store.ts:55

Interface ISamlRequestStore

Since

Implemented by

Index

Methods

Methods

claimAssertionId

Parameters

Returns Promise<boolean>

consumeRequest

Parameters

Returns Promise<SamlPendingRequest | null>

peekRequest

Parameters

Returns Promise<SamlPendingRequest | null>

saveRequest

Parameters

Returns Promise<void>

Settings

On This Page