Enum Effect 

#[non_exhaustive]
pub enum Effect {
    StoreSession {
        session: Session,
        replaces: Option<TokenHash>,
    },
    DeleteSession {
        token_hash: TokenHash,
    },
    SetCookie(SetCookie),
    RecordFailure {
        user_id: UserId,
        at: OffsetDateTime,
        ip_tag: Option<IpTag>,
    },
    ClearFailures {
        user_id: UserId,
    },
    RecordStepUpFailure {
        token_hash: TokenHash,
    },
    ClearStepUpFailures {
        token_hash: TokenHash,
    },
    RecordWrongPassword {
        key: AccountKey,
    },
    UseTotpStep {
        user_id: UserId,
        step: TotpStep,
    },
    UseRecoveryCode {
        user_id: UserId,
        hash: RecoveryCodeHash,
    },
    StoreRecoveryCodes {
        user_id: UserId,
        hashes: Vec<RecoveryCodeHash>,
    },
    StoreLinkToken {
        token_hash: TokenHash,
        link: LinkToken,
    },
    SendMail(Mail),
    Audit(AuditEvent),
    RememberDevice {
        user_id: UserId,
        device_hash: TokenHash,
        seen_at: OffsetDateTime,
    },
    CreateAccount(NewAccount),
    StorePassword {
        user_id: UserId,
        hash: PasswordHash,
    },
    ActivateAccount {
        user_id: UserId,
    },
    MarkStepUp {
        token_hash: TokenHash,
        at: OffsetDateTime,
        method: SignInMethod,
    },
}

Something the app must do. Carry out every effect of a Transition or Refusal, in order.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

StoreSession

Insert the session. With replaces, delete the session with that token hash in the same transaction (a stage change issues a new token).

Fields

session: Session

The session to insert.

replaces: Option<TokenHash>

The session it replaces.

DeleteSession

Delete the session with this token hash.

Fields

token_hash: TokenHash

Its token hash.

SetCookie(SetCookie)

Send this Set-Cookie header.

RecordFailure

Count one failure, atomically: UPDATE ... SET failures = failures + 1 ... RETURNING failures (never read-modify-write from the Account snapshot, or concurrent failures are lost). Then, with the returned count n, store LockoutPolicy::locked_until(n, at) as locked_until when it is Some, and append LockoutPolicy::lockout_event(user_id, n, at, ip_tag) when it is Some.

Fields

user_id: UserId

Whose.

at: OffsetDateTime

Now.

ip_tag: Option<IpTag>

The client, for the lockout audit event.

ClearFailures

Reset the account’s failure count to 0 and clear locked_until.

Fields

user_id: UserId

Whose.

RecordStepUpFailure

Count one wrong step-up guess against this session, atomically: UPDATE sessions SET step_up_failures = step_up_failures + 1 WHERE token_hash = ? RETURNING step_up_failures. Only under StepUpFailures::PerSession. When the guess reaches the limit the flow also ends the session (with DeleteSession); an app may end it as soon as the returned count satisfies StepUpFailures::ends_session, which also covers guesses that raced, and otherwise the next step-up from it is refused and ends it.

Fields

token_hash: TokenHash

The session’s token hash.

ClearStepUpFailures

Reset this session’s step-up failure count to 0, after a step-up succeeded. Only under StepUpFailures::PerSession.

Fields

token_hash: TokenHash

The session’s token hash.

RecordWrongPassword

Record a wrong password for the throttle (WrongPasswordThrottle::record).

Fields

key: AccountKey

The address it counts under.

UseTotpStep

Store step as the account’s last used TOTP step, only if it is newer than the stored one (compare-and-set); if it is not, the code was raced and the sign-in must be refused.

Fields

user_id: UserId

Whose.

step: TotpStep

The matched step.

UseRecoveryCode

Mark this recovery code used, only if it is still unused (compare-and-set), as above.

Fields

user_id: UserId

Whose.

hash: RecoveryCodeHash

Which.

StoreRecoveryCodes

Replace the account’s recovery codes with these.

Fields

user_id: UserId

Whose.

hashes: Vec<RecoveryCodeHash>

The new hashes.

StoreLinkToken

Store a one-time link under its token hash.

Fields

token_hash: TokenHash

Look-up key.

link: LinkToken

The record.

SendMail(Mail)

Send this mail.

Audit(AuditEvent)

Append this audit event.

RememberDevice

Remember (or refresh last_seen_at of) the device with this cookie hash for the account. Forget devices unused for Config::device_ttl.

Fields

user_id: UserId

Whose.

device_hash: TokenHash

The device cookie’s hash.

seen_at: OffsetDateTime

Now.

CreateAccount(NewAccount)

Create this inactive account; refuse duplicates by email.

StorePassword

Store the account’s new password hash.

Fields

user_id: UserId

Whose.

hash: PasswordHash

The hash.

ActivateAccount

Mark the account active.

Fields

user_id: UserId

Whose.

MarkStepUp

Set the session’s authenticated_at and method: the step-up window starts again.

Fields

token_hash: TokenHash

Which session.

at: OffsetDateTime

Now.

method: SignInMethod

SignInMethod::StepUp.

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Effect

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.