challenge

Documentation

Index

• Variables
• type Config
• type CreateEmailChangeChallengeInput
• type CreatePasswordResetChallengeInput
• type CreateSignupChallengeInput
• type Service
  • func New(cfg Config) *Service
  • func (s *Service) CreateEmailChangeChallenge(ctx context.Context, in CreateEmailChangeChallengeInput, now time.Time) (uuid.UUID, error)
  • func (s *Service) CreateOpaqueChallenge(ctx context.Context, now time.Time, purpose domain.ChallengePurpose, ...) (uuid.UUID, error)
  • func (s *Service) CreatePasswordResetChallenge(ctx context.Context, in CreatePasswordResetChallengeInput, now time.Time) (uuid.UUID, error)
  • func (s *Service) CreateSignupChallenge(ctx context.Context, in CreateSignupChallengeInput, now time.Time) (uuid.UUID, error)
  • func (s *Service) ExecuteEmailChange(ctx context.Context, action domain.PendingEmailChange, now time.Time) error
  • func (s *Service) ExecutePasswordReset(ctx context.Context, action domain.PendingPasswordReset, now time.Time) error
  • func (s *Service) ResendChallenge(ctx context.Context, challengeID uuid.UUID, now time.Time) error
  • func (s *Service) VerifyEmailChangeChallenge(ctx context.Context, challengeID uuid.UUID, code string, ...) (*VerifyEmailChangeChallengeResult, error)
  • func (s *Service) VerifyPasswordResetChallenge(ctx context.Context, challengeID uuid.UUID, code string, ...) (*VerifyPasswordResetChallengeResult, error)
  • func (s *Service) VerifySignupChallenge(ctx context.Context, challengeID uuid.UUID, code string, ...) (*VerifySignupChallengeResult, error)
• type VerificationCodeService
  • func NewVerificationCodeService(store *store.Store, ttl time.Duration, secrets ...[]byte) *VerificationCodeService
  • func (s *VerificationCodeService) GenerateCode(ctx context.Context, challenge domain.Challenge, now time.Time) (string, error)
  • func (s *VerificationCodeService) VerifyCode(ctx context.Context, challengeID uuid.UUID, code string, now time.Time) error
• type VerifyEmailChangeChallengeResult
• type VerifyPasswordResetChallengeResult
• type VerifySignupChallengeResult
• type Worker
  • func NewWorker(store *store.Store, codeSvc *VerificationCodeService, sender email.Sender, ...) *Worker
  • func (w *Worker) Run(ctx context.Context)
  • func (w *Worker) RunOnce(ctx context.Context, now time.Time) (bool, error)
• type WorkerConfig

Variables

var (
	ErrChallengeExpired            = errors.New("challenge expired")
	ErrChallengeConsumed           = errors.New("challenge already consumed")
	ErrTooManyAttempts             = errors.New("too many verification attempts")
	ErrTooManyResends              = errors.New("too many resend attempts")
	ErrResendTooSoon               = errors.New("resend requested too soon")
	ErrInvalidVerificationCode     = errors.New("invalid verification code")
	ErrUnsupportedChallengePurpose = errors.New("unsupported challenge purpose")
)

Types

type Config

type Config struct {
	Store             *store.Store
	Tx                *tx.Manager
	ChallengeTTL      time.Duration
	MaxAttempts       int
	MaxResends        int
	MinResendInterval time.Duration
}

type CreateEmailChangeChallengeInput

type CreateEmailChangeChallengeInput struct {
	UserID   uuid.UUID
	OldEmail string
	NewEmail string
}

type CreatePasswordResetChallengeInput

type CreatePasswordResetChallengeInput struct {
	UserID       uuid.UUID
	Email        string
	PasswordHash string
}

type CreateSignupChallengeInput

type CreateSignupChallengeInput struct {
	Email        string
	Username     string
	PasswordHash string
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

func New

func New(cfg Config) *Service

func (*Service) CreateEmailChangeChallenge

func (s *Service) CreateEmailChangeChallenge(
	ctx context.Context,
	in CreateEmailChangeChallengeInput,
	now time.Time,
) (uuid.UUID, error)

func (*Service) CreateOpaqueChallenge

func (s *Service) CreateOpaqueChallenge(
	ctx context.Context,
	now time.Time,
	purpose domain.ChallengePurpose,
	email string,
) (uuid.UUID, error)

func (*Service) CreatePasswordResetChallenge

func (s *Service) CreatePasswordResetChallenge(
	ctx context.Context,
	in CreatePasswordResetChallengeInput,
	now time.Time,
) (uuid.UUID, error)

func (*Service) CreateSignupChallenge

func (s *Service) CreateSignupChallenge(
	ctx context.Context,
	in CreateSignupChallengeInput,
	now time.Time,
) (uuid.UUID, error)

func (*Service) ExecuteEmailChange

func (s *Service) ExecuteEmailChange(
	ctx context.Context,
	action domain.PendingEmailChange,
	now time.Time,
) error

func (*Service) ExecutePasswordReset

func (s *Service) ExecutePasswordReset(
	ctx context.Context,
	action domain.PendingPasswordReset,
	now time.Time,
) error

func (*Service) ResendChallenge

func (s *Service) ResendChallenge(
	ctx context.Context,
	challengeID uuid.UUID,
	now time.Time,
) error

func (*Service) VerifyEmailChangeChallenge

func (s *Service) VerifyEmailChangeChallenge(
	ctx context.Context,
	challengeID uuid.UUID,
	code string,
	verifier *VerificationCodeService,
	now time.Time,
) (*VerifyEmailChangeChallengeResult, error)

func (*Service) VerifyPasswordResetChallenge

func (s *Service) VerifyPasswordResetChallenge(
	ctx context.Context,
	challengeID uuid.UUID,
	code string,
	verifier *VerificationCodeService,
	now time.Time,
) (*VerifyPasswordResetChallengeResult, error)

func (*Service) VerifySignupChallenge

func (s *Service) VerifySignupChallenge(
	ctx context.Context,
	challengeID uuid.UUID,
	code string,
	verifier *VerificationCodeService,
	now time.Time,
) (*VerifySignupChallengeResult, error)

type VerificationCodeService

type VerificationCodeService struct {
	// contains filtered or unexported fields
}

func NewVerificationCodeService

func NewVerificationCodeService(store *store.Store, ttl time.Duration, secrets ...[]byte) *VerificationCodeService

func (*VerificationCodeService) GenerateCode

func (s *VerificationCodeService) GenerateCode(
	ctx context.Context,
	challenge domain.Challenge,
	now time.Time,
) (string, error)

func (*VerificationCodeService) VerifyCode

func (s *VerificationCodeService) VerifyCode(
	ctx context.Context,
	challengeID uuid.UUID,
	code string,
	now time.Time,
) error

type VerifyEmailChangeChallengeResult

type VerifyEmailChangeChallengeResult struct {
	Challenge domain.Challenge
	Action    domain.PendingEmailChange
}

type VerifyPasswordResetChallengeResult

type VerifyPasswordResetChallengeResult struct {
	Challenge domain.Challenge
	Action    domain.PendingPasswordReset
}

type VerifySignupChallengeResult

type VerifySignupChallengeResult struct {
	Challenge domain.Challenge
	Action    domain.PendingSignupAction
}

type Worker

type Worker struct {
	// contains filtered or unexported fields
}

func NewWorker

func NewWorker(
	store *store.Store,
	codeSvc *VerificationCodeService,
	sender email.Sender,
	logger *slog.Logger,
	cfg WorkerConfig,
) *Worker

func (*Worker) Run

func (w *Worker) Run(ctx context.Context)

func (*Worker) RunOnce

func (w *Worker) RunOnce(ctx context.Context, now time.Time) (bool, error)

type WorkerConfig

type WorkerConfig struct {
	WorkerCount        int
	PollInterval       time.Duration
	JobMaxAttempts     int
	CleanupSentAfter   time.Duration
	CleanupFailedAfter time.Duration
	CleanupInterval    time.Duration
	SendTimeout        time.Duration
}