storage

Documentation

Index

• Variables
• type JWKSetCustomKeyMeta
• type MagicLinkCustomCreateArgs
• type MagicLinkCustomReadResponse
• type ReadSigningKeyOptions
• type Storage
• type Tx

Variables

var (
	// ErrKeySize is returned when the symmetric key for the database is the incorrect size.
	ErrKeySize = errors.New("symmetric key for database is incorrect size")
	// ErrNotFound is returned when a record is not found.
	ErrNotFound = errors.New("not found")
)

Types

type JWKSetCustomKeyMeta

type JWKSetCustomKeyMeta struct {
	SigningDefault bool
}

JWKSetCustomKeyMeta is the custom metadata for a JWKSet key.

type MagicLinkCustomCreateArgs

type MagicLinkCustomCreateArgs struct {
	Expires time.Time
}

MagicLinkCustomCreateArgs is the custom arguments for creating a magic link.

type MagicLinkCustomReadResponse

type MagicLinkCustomReadResponse struct {
	Visited *time.Time
}

MagicLinkCustomReadResponse is the custom response for reading a magic link.

type ReadSigningKeyOptions

type ReadSigningKeyOptions struct {
	JWTAlg string
}

ReadSigningKeyOptions are the options for the ReadSigningKey method.

type Storage

type Storage interface {
	Begin(ctx context.Context) (Tx, error)
	Close(ctx context.Context) error
	TestingTruncate(ctx context.Context) error

	CreateAdminSA(ctx context.Context, args model.ValidAdminCreateArgs) error
	CreateSA(ctx context.Context, args model.ValidServiceAccountCreateArgs) (model.ServiceAccount, error)
	ReadSA(ctx context.Context, u uuid.UUID) (model.ServiceAccount, error)
	ReadSAFromAPIKey(ctx context.Context, apiKey uuid.UUID) (model.ServiceAccount, error)
	ReadSigningKey(ctx context.Context, options ReadSigningKeyOptions) (meta jwkset.KeyWithMeta[JWKSetCustomKeyMeta], err error)
	UpdateDefaultSigningKey(ctx context.Context, keyID string) error

	jwkset.Storage[JWKSetCustomKeyMeta]
	magiclink.Storage[MagicLinkCustomCreateArgs, MagicLinkCustomReadResponse, JWKSetCustomKeyMeta]
}

Storage is the interface for magiclinksdev storage.

type Tx

type Tx interface {
	Commit(ctx context.Context) error
	Rollback(ctx context.Context) error
}

Tx is the interface for a transaction.