snapshot of https://github.com/ory/kratos.git (master, 2026-09-15; blobs > 131072B omitted)

identity/identity_verification.go

@@ -0,0 +1,137 @@
+// Copyright © 2023 Ory Corp
+// SPDX-License-Identifier: Apache-2.0
+
+package identity
+
+import (
+	"fmt"
+	"slices"
+	"time"
+
+	"github.com/gofrs/uuid"
+
+	"github.com/ory/x/sqlxx"
+)
+
+const (
+	VerifiableAddressStatusPending   VerifiableAddressStatus = "pending"
+	VerifiableAddressStatusSent      VerifiableAddressStatus = "sent"
+	VerifiableAddressStatusCompleted VerifiableAddressStatus = "completed"
+)
+
+// VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema
+//
+// swagger:model identityVerifiableAddressStatus
+type VerifiableAddressStatus string
+
+// VerifiableAddress is an identity's verifiable address
+//
+// swagger:model verifiableIdentityAddress
+type VerifiableAddress struct {
+	// The ID
+	//
+	ID uuid.UUID `json:"id" db:"id" faker:"-"`
+
+	// The address value
+	//
+	// example foo@user.com
+	// required: true
+	Value string `json:"value" db:"value"`
+
+	// Indicates if the address has already been verified
+	//
+	// example: true
+	// required: true
+	Verified bool `json:"verified" db:"verified"`
+
+	// The delivery method
+	//
+	// enum: email,sms
+	// example: email
+	// required: true
+	Via string `json:"via" db:"via"`
+
+	// The verified address status
+	//
+	// enum: pending,sent,completed
+	// example: sent
+	// required: true
+	Status VerifiableAddressStatus `json:"status" db:"status"`
+
+	// When the address was verified
+	//
+	// example: 2014-01-01T23:28:56.782Z
+	// required: false
+	VerifiedAt *sqlxx.NullTime `json:"verified_at,omitempty" faker:"-" db:"verified_at"`
+
+	// When this entry was created
+	//
+	// example: 2014-01-01T23:28:56.782Z
+	CreatedAt time.Time `json:"created_at" faker:"-" db:"created_at"`
+
+	// When this entry was last updated
+	//
+	// example: 2014-01-01T23:28:56.782Z
+	UpdatedAt time.Time `json:"updated_at" faker:"-" db:"updated_at"`
+
+	// IdentityID is a helper struct field for gobuffalo.pop.
+	IdentityID uuid.UUID `json:"-" faker:"-" db:"identity_id"`
+	NID        uuid.UUID `json:"-"  faker:"-" db:"nid"`
+}
+
+func (a VerifiableAddress) TableName() string {
+	return "identity_verifiable_addresses"
+}
+
+func NewVerifiableEmailAddress(value string, identity uuid.UUID) *VerifiableAddress {
+	return NewVerifiableAddress(value, identity, AddressTypeEmail)
+}
+
+func NewVerifiableAddress(value string, identity uuid.UUID, channel string) *VerifiableAddress {
+	return &VerifiableAddress{
+		Value:      value,
+		Verified:   false,
+		Status:     VerifiableAddressStatusPending,
+		Via:        channel,
+		IdentityID: identity,
+	}
+}
+
+func (a VerifiableAddress) GetID() uuid.UUID {
+	return a.ID
+}
+
+// Signature returns a unique string representation for the recovery address.
+func (a VerifiableAddress) Signature() string {
+	return fmt.Sprintf("%v|%v|%v|%v|%v|%v|%v", a.Value, a.Verified, a.Via, a.Status, a.VerifiedAt, a.IdentityID, a.NID)
+}
+
+func VerifiableAddressesEqual(original, updated []VerifiableAddress) bool {
+	return slices.EqualFunc(original, updated, func(a, b VerifiableAddress) bool {
+		return a.Signature() == b.Signature()
+	})
+}
+
+type VerifiableAddressLike interface {
+	// ToPersistable returns the verifiable address to be persisted.
+	// Returns nil when the change is pending (e.g., via PendingTraitsChange).
+	ToPersistable() (va *VerifiableAddress, isPersistable bool)
+	// Address returns the address value
+	Address() string
+	// Via returns the delivery method
+	DeliveryVia() string
+}
+
+var _ VerifiableAddressLike = &VerifiableAddress{}
+
+func (va *VerifiableAddress) ToPersistable() (*VerifiableAddress, bool) {
+	return va, true
+}
+
+func (va VerifiableAddress) Address() string {
+	return va.Value
+}
+
+func (va VerifiableAddress) DeliveryVia() string {
+	return va.Via
+}