Files
iam/pkg/schema/verification.go
zooqueenandHanzo Dev 8dda76e12d An invitation pinned to an address is proven by a join code IAM sends to the caller
Accept of a pinned invitation without emailCode now mints the code itself, for the caller's own account and address, and answers email_code_sent (email_code_required inside the resend interval). Verification records carry a purpose: a join code spends only for joining, and the general code that sign-in, reset, signup and second factors use does not join; minting one does not cancel the other.

Co-authored-by: Hanzo Dev <[email protected]>
2026-09-27 09:09:09 -07:00

49 lines
2.4 KiB
Go

// Copyright 2026 Hanzo AI, Inc.
// SPDX-License-Identifier: MIT OR Apache-2.0
package schema
import "github.com/hanzoai/orm"
// VerificationRecord is a one-time verification code (email/SMS OTP) issued for
// signup, sign-in, password reset, or MFA — the v2 form of the v1 the legacy surface
// `verification` row. It is verify-only credential material: Code is the secret
// the caller must echo back, so the send endpoint returns only a status and
// never the record.
//
// The natural key is (Owner, Name): Owner is the organization, Name a generated
// unique id. Receiver — the email/phone the code was sent to — is the indexed
// lookup key the check path resolves the latest unused, unexpired record by.
// Every field carries a real json tag: orm persists the entity as one JSON
// document, so a json:"-" field would never be stored (the same trap that once
// silently dropped User.PasswordHash).
type VerificationRecord struct {
orm.Model[VerificationRecord]
Owner string `json:"owner" orm:"index"`
Name string `json:"name" orm:"index"`
CreatedTime string `json:"createdTime"`
RemoteAddr string `json:"remoteAddr,omitempty"`
User string `json:"user,omitempty"` // owner/name of the resolved user, when known
Provider string `json:"provider,omitempty"` // delivery provider name; "demo" when none
Type string `json:"type"` // "email" | "phone"
Receiver string `json:"receiver" orm:"index"`
Code string `json:"code"`
Time int64 `json:"time"`
IsUsed bool `json:"isUsed"`
// Purpose is what the code may be spent for. "" is the general code — sign-in,
// a password reset, a signup's proof of address, a second factor; "join" is a
// code IAM sent to prove an address for joining an org through an invitation
// pinned to it. A code spends only for its own purpose, and issuing one
// replaces only the outstanding code of the same purpose.
Purpose string `json:"purpose,omitempty"`
// Attempts counts wrong codes submitted against this record. A six-digit code
// live for ten minutes is a million guesses if nothing counts them, which is
// fine for a code that only gates a signup and NOT fine for one that is a
// login credential on its own. Bounding the count is what makes the two uses
// the same strength. Absent on rows written before this field existed, which
// reads as zero — the right starting value.
Attempts int `json:"attempts,omitempty"`
}