Documentation
¶
Overview ¶
Package mfastore owns typed persistence models for MFA. Applications use auth/mfa's typed manager instead of depending on these implementation rows.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Factors = orm.Define("foundry_mfa_factors", func(b orm.Builder[Factor], m *Factor) FactorTable { table := orm.TableOf(b, &m.Key) return FactorTable{Table: table, Scope: orm.TextOf(b, &m.Scope), Identity: orm.JSONOf(b, &m.Identity), Generation: orm.ColumnOf(b, &m.Generation), Ciphertext: orm.TextOf(b, &m.Ciphertext), CreatedAt: orm.TimeOf(b, &m.CreatedAt), PendingUntil: orm.NullableTimeOf(b, &m.PendingUntil), ConfirmedAt: orm.NullableTimeOf(b, &m.ConfirmedAt), LastStep: orm.NullableNumberOf(b, &m.LastStep), RecoveryHashes: orm.JSONOf(b, &m.RecoveryHashes), } })
Factors owns the immutable Factor declaration. Example: orm.First(ctx, tx, Factors.Query()).
Functions ¶
This section is empty.
Types ¶
type Factor ¶
type Factor struct {
Key string
Scope string
Identity value.JSON[model.Identity]
Generation model.ID[Factor]
Ciphertext string
CreatedAt temporal.DateTime
PendingUntil value.Nullable[temporal.DateTime]
ConfirmedAt value.Nullable[temporal.DateTime]
LastStep value.Nullable[int64]
RecoveryHashes value.JSON[[]string]
}
The application model is locked before this row, including when absent. Generation changes whenever a pending enrollment is replaced.
type FactorTable ¶
type FactorTable struct {
// Table provides Factor queries and writes. Example: Factors.Query().Limit(10).
orm.Table[Factor, string]
// Scope binds the persisted Factor.Scope column.
// Example: orm.TextSet(Factors.Scope, scope).
Scope orm.Text[Factor, string]
// Identity binds the persisted Factor.Identity column.
// Example: encoded, err := value.NewJSON(identity); if err == nil { _ = orm.JSONSet(Factors.Identity, encoded) }.
Identity orm.JSON[Factor, model.Identity]
// Generation binds the persisted Factor.Generation column.
// Example: orm.ColumnSet(Factors.Generation, generation).
Generation orm.Column[Factor, model.ID[Factor]]
// Ciphertext binds the persisted Factor.Ciphertext column.
// Example: orm.TextSet(Factors.Ciphertext, ciphertext).
Ciphertext orm.Text[Factor, string]
// CreatedAt binds the caller-supplied creation time; the ORM does not automatically populate or refresh it.
// Example: orm.TimeSet(Factors.CreatedAt, createdAt).
CreatedAt orm.Time[Factor, temporal.DateTime]
// PendingUntil binds the persisted Factor.PendingUntil column.
// Example: orm.NullableTimeSetNull(Factors.PendingUntil).
PendingUntil orm.NullableTime[Factor, temporal.DateTime]
// ConfirmedAt binds the persisted Factor.ConfirmedAt column.
// Example: orm.NullableTimeSetNull(Factors.ConfirmedAt).
ConfirmedAt orm.NullableTime[Factor, temporal.DateTime]
// LastStep binds the persisted Factor.LastStep column.
// Example: orm.NullableNumberSetNull(Factors.LastStep).
LastStep orm.NullableNumber[Factor, int64]
// RecoveryHashes binds the persisted Factor.RecoveryHashes column.
// Example: encoded, err := value.NewJSON(recoveryHashes); if err == nil { _ = orm.JSONSet(Factors.RecoveryHashes, encoded) }.
RecoveryHashes orm.JSON[Factor, []string]
}
FactorTable binds the persisted Factor columns. Example: Factors.Query().Limit(10).
Source Files
Click to show internal directories.
Click to hide internal directories.