shieldpasswordreset

type Config ¶

type Config struct {
	PasswordHasher shieldpassword.PasswordHasher // optional
	Logger         *slog.Logger                  // optional

	// TokenLength set the length of the reset token.
	//
	// Defaults to DefaultResetTokenExpiry.
	TokenLength int // optional

	// TokenExpiryIn set the expiry time of the reset token.
	//
	// Defaults to DefaultResetTokenLength
	TokenExpiryIn time.Duration // optional
}

Config is the configuration for the password handler.

Make sure to use the NewConfig function to create a new config, instead of instantiating the struct directly.

func NewConfig(opts ...func(*Config)) *Config

type Handler ¶

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

Handler handles password reset requests.

It is a general enough implementation so it can be used for different communication methods.

Check out the FormHandler for a ready to use implementation that handles HTTP form requests.

func NewHandler(
	pool *pgxpool.Pool,
	sender shieldsender.Sender,
	config *Config,
) *Handler

func (h *Handler) HandlePasswordReset(
	ctx context.Context,
	email string,
) error

func (h *Handler) HandlePasswordResetConfirm(
	ctx context.Context,
	password, tokStr string,
) error

type PasswordResetRequestMessagePayload ¶

type PasswordResetRequestMessagePayload struct {
	Token string
}

ResetTokenMessagePayload is the payload for the reset token message.