magiclink

Oct 30, 2024

Changes in this version

+ type CreateParams struct

+ Expires time.Time

+ JWTClaims jwt.Claims

+ JWTKeyID *string

+ JWTSigningMethod string

+ RedirectQueryKey string

+ RedirectURL *url.URL

+ func (p CreateParams) Valid() error

+ type ErrorHandlerParams struct

+ Err error

+ Request *http.Request

+ SuggestedResponseCode int

+ Writer http.ResponseWriter

+ type JWKSParams struct

+ CacheRefresh time.Duration

+ Store jwkset.Storage

+ type ReadResult struct

+ CreateParams CreateParams

+ Visited *time.Time

+ type RedirectorParams struct

+ ReadAndExpireLink func(ctx context.Context, secret string) (jwtB64 string, response ReadResult, err error)

+ Request *http.Request

+ Secret string

+ Writer http.ResponseWriter

type Storage

+ MagicLinkCreate func(ctx context.Context, params CreateParams) (secret string, err error)

+ MagicLinkRead func(ctx context.Context, secret string) (ReadResult, error)

Oct 4, 2024

Changes in this version

type CreateArgs

+ Expires time.Time

type ReadResponse

+ Visited *time.Time

Jan 14, 2024

Changes in this version

+ const DefaultJWKSCacheRefresh

+ const DefaultRedirectQueryKey

+ const DefaultSecretQueryKey

+ const ReCAPTCHAV3QueryButtonBypassKey

+ const ReCAPTCHAV3QueryButtonBypassValue

+ var ErrArgs = errors.New("invalid arguments")

+ var ErrJWKSEmpty = errors.New("JWK Set is empty")

+ var ErrJWKSJSON = errors.New("failed to get JWK Set as JSON")

+ var ErrJWKSReadGivenKID = errors.New("failed to read JWK with given key ID")

+ var ErrJWKSSnapshot = errors.New("failed to snapshot JWK Set")

+ var ErrJWTSign = errors.New("failed to sign JWT")

+ var ErrLinkNotFound = errors.New("link not found")

+ var ErrMagicLinkMissingSecret = errors.New("visited magic link endpoint without a secret")

+ var ErrMagicLinkRead = errors.New("failed to read the magic link from storage")

+ func BestSigningMethod(key interface{}) jwt.SigningMethod

+ type Config struct

+ CustomRedirector Redirector[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]

+ ErrorHandler ErrorHandler

+ JWKS JWKSArgs[CustomKeyMeta]

+ SecretQueryKey string

+ ServiceURL *url.URL

+ Store Storage[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]

+ func (c Config[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]) Valid() error

+ type CreateArgs struct

+ Custom CustomCreateArgs

+ JWTClaims jwt.Claims

+ JWTKeyID *string

+ JWTSigningMethod string

+ RedirectQueryKey string

+ RedirectURL *url.URL

+ func (p CreateArgs[CustomCreateArgs]) Valid() error

+ type CreateResponse struct

+ MagicLink *url.URL

+ Secret string

+ type ErrorHandler interface

+ Handle func(args ErrorHandlerArgs)

+ type ErrorHandlerArgs struct

+ Err error

+ Request *http.Request

+ SuggestedResponseCode int

+ Writer http.ResponseWriter

+ type ErrorHandlerFunc func(args ErrorHandlerArgs)

+ func (f ErrorHandlerFunc) Handle(args ErrorHandlerArgs)

+ type JWKSArgs struct

+ CacheRefresh time.Duration

+ Store jwkset.Storage[CustomKeyMeta]

+ type MagicLink struct

+ Store Storage[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]

+ func NewMagicLink[CustomCreateArgs, CustomReadResponse, CustomKeyMeta any](setupCtx context.Context, ...) (MagicLink[CustomCreateArgs, CustomReadResponse, CustomKeyMeta], error)

+ func (m MagicLink[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]) HandleMagicLink(ctx context.Context, secret string) (jwtB64 string, response ReadResponse[CustomCreateArgs, CustomReadResponse], ...)

+ func (m MagicLink[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]) JWKSHandler() http.Handler

+ func (m MagicLink[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]) JWKSet() jwkset.JWKSet[CustomKeyMeta]

+ func (m MagicLink[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]) MagicLinkHandler() http.Handler

+ func (m MagicLink[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]) NewLink(ctx context.Context, args CreateArgs[CustomCreateArgs]) (CreateResponse, error)

+ type ReCAPTCHAV3Config struct

+ APKPackageName []string

+ Action []string

+ Hostname []string

+ MinScore float64

+ SecretKey string

+ TemplateData ReCAPTCHAV3TemplateData

+ Verifier recaptcha.VerifierV3

+ func (r ReCAPTCHAV3Config) DefaultsAndValidate() (ReCAPTCHAV3Config, error)

+ type ReCAPTCHAV3Redirector struct

+ func (r ReCAPTCHAV3Redirector[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]) Redirect(args RedirectorArgs[CustomCreateArgs, CustomReadResponse, CustomKeyMeta])

+ type ReCAPTCHAV3TemplateData struct

+ ButtonBypass bool

+ ButtonText string

+ CSS template.CSS

+ Code string

+ FormAction string

+ HTMLTitle string

+ Instruction string

+ SiteKey template.HTML

+ Title string

+ func (r ReCAPTCHAV3TemplateData) DefaultsAndValidate() (ReCAPTCHAV3TemplateData, error)

+ type ReadResponse struct

+ CreateArgs CreateArgs[CustomCreateArgs]

+ Custom CustomReadResponse

+ type Redirector interface

+ Redirect func(args RedirectorArgs[CustomCreateArgs, CustomReadResponse, CustomKeyMeta])

+ func NewReCAPTCHAV3Redirector[CustomCreateArgs, CustomReadResponse, CustomKeyMeta any](config ReCAPTCHAV3Config) Redirector[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]

+ type RedirectorArgs struct

+ ReadAndExpireLink func(ctx context.Context, secret string) (jwtB64 string, response ReadResponse[CustomCreateArgs, CustomReadResponse], ...)

+ Request *http.Request

+ Secret string

+ Writer http.ResponseWriter

+ type Storage interface

+ CreateLink func(ctx context.Context, args CreateArgs[CustomCreateArgs]) (secret string, err error)

+ ReadLink func(ctx context.Context, secret string) (ReadResponse[CustomCreateArgs, CustomReadResponse], error)

+ func NewMemoryStorage[CustomCreateArgs, CustomReadResponse, CustomKeyMeta any]() Storage[CustomCreateArgs, CustomReadResponse, CustomKeyMeta]