authhttp

package

Go to main page

Versions in this module

v0

v0.99.2

Sep 7, 2026

v0.99.1

Sep 6, 2026

v0.99.0

Sep 5, 2026

v0.98.1

Sep 5, 2026

v0.98.0

Sep 5, 2026

Changes in this version

+ const ActionRequestVerification

+ const RLContactChangeRequest

+ const RLDeviceKeysManage

+ const RLRegisterResend

+ const RLVerifyConfirm

+ const RLVerifyRequest

+ type Config struct

+ ClientIP ClientIPFunc

+ CloudflareProxies []string

+ DirectPeerIP bool

+ DisableRateLimiting bool

+ Documents []DocumentProvider

+ Languages LanguageConfig

+ Limiter RateLimiter

+ RateLimits map[string]ratelimit.Limit

+ Redis *redis.Client

+ TrustedProxies []string

+ func (c Config) Validate() error

+ type RouteAuthTier string

+ const AuthOptional

+ const AuthPermission

+ const AuthPublic

+ const AuthRequired

+ const AuthSigned

type RouteSpec

+ Auth RouteAuthTier

+ Bucket string

+ Permission authkit.Perm

+ func (r RouteSpec) Requires() string

type Service

+ func (s *Service) Close()

v0.97.2

Aug 31, 2026

Changes in this version

+ const RLDeviceKeyEnrollBegin

+ const RLDeviceKeyEnrollFinish

+ const RLDeviceKeyLoginBegin

+ const RLDeviceKeyLoginFinish

type ErrorCode

+ const ErrWalletChangeRequiresUnlink

type RouteGroup

+ const RouteDeviceKeys

v0.97.1

Aug 26, 2026

v0.97.0

Aug 12, 2026

v0.96.0

Aug 12, 2026

v0.95.0

Aug 11, 2026

v0.94.0

Aug 11, 2026

Changes in this version

+ const RefreshCookieName

type MountOptions

+ RefreshCookie bool

v0.93.0

Aug 11, 2026

v0.92.0

Aug 11, 2026

v0.91.0

Aug 11, 2026

Changes in this version

+ const DocumentsPath

+ const RLDelegatedTokenMint

+ type DocumentProvider interface

+ CurrentDigest func(ctx context.Context) (string, error)

+ EnsureSigningKID func(ctx context.Context, tokenKID string) error

+ Lookup func(ctx context.Context, digest string) (documents.SignedDocument, error)

+ Reference func() documents.Reference

type ErrorCode

+ const ErrDelegatedAttributesUnavailable

+ const ErrDelegatedDocumentUnavailable

+ const ErrDelegatedMintFailed

+ const ErrDocumentDigestCollision

+ const ErrInvalidAudiences

type Option

+ func WithDocuments(providers ...DocumentProvider) Option

type RouteGroup

+ const RouteDelegated

+ const RouteDocuments

v0.90.0

Aug 11, 2026

Changes in this version

+ const RLGroupCreate

+ const RLUserMetadata

type ErrorCode

+ const ErrGroupCreationRefused

+ const ErrGroupSlugInvalid

+ const ErrGroupSlugReserved

+ const ErrMetadataKeyReserved

v0.89.0

Aug 11, 2026

v0.88.1

Aug 11, 2026

v0.88.0

Aug 11, 2026

Changes in this version

+ const RLApplicationRegister

+ const RLApplicationRotate

+ const RLGroupSettings

type ErrorCode

+ const ErrApplicationDocumentFetchFailed

+ const ErrApplicationDocumentInvalid

+ const ErrApplicationDomainConflict

+ const ErrApplicationDomainInvalid

+ const ErrApplicationIssuerConflict

+ const ErrApplicationNotDomainRooted

+ const ErrApplicationRegistrationDisabled

+ const ErrApplicationSignatureInvalid

+ const ErrApplicationSignatureStale

+ const ErrApplicationSlugConflict

+ const ErrApplicationTierInvalid

+ const ErrGroupSlugApplicationManaged

+ const ErrGroupSlugTaken

type RouteGroup

+ const RouteApplications

v0.87.0

Jul 21, 2026

Changes in this version

type RemoteApplicationIssuersClientOption

+ func WithRemoteApplicationIssuersInsecureJWKS() RemoteApplicationIssuersClientOption

v0.86.1

Jul 15, 2026

v0.86.0

Jul 14, 2026

v0.85.0

Jul 13, 2026

Changes in this version

type ErrorCode

+ const ErrProviderError

v0.84.0

Jul 7, 2026

Changes in this version

+ const DefaultAPIPrefix

+ const DefaultOIDCPath

+ const JWKSPath

+ func MountHandler(svc *Service, opts MountOptions) (h http.Handler, err error)

+ type MountOptions struct

+ APIPrefix string

+ ExcludeRoutes []RouteRef

+ Groups []RouteGroup

+ MountPrefix string

+ OIDCPath string

+ Wrap func(RouteSpec, http.Handler) http.Handler

+ type RouteRef struct

+ Method string

+ Path string

v0.83.1

Jul 7, 2026

v0.83.0

Jul 6, 2026

v0.82.0

Jul 5, 2026

v0.81.0

Jul 4, 2026

v0.80.0

Jul 4, 2026

Changes in this version

type Option

+ func WithEngine(opts ...embedded.Option) Option

type Service

+ func New(cfg embedded.Config, pg *pgxpool.Pool, opts ...Option) (*Service, *embedded.Client, error)

v0.79.0

Jul 4, 2026

Changes in this version

type Option

+ func WithRateLimitOverrides(overrides map[string]ratelimit.Limit) Option

type RouteSpec

+ MFAEnrollmentExempt bool

v0.78.0

Jul 3, 2026

Changes in this version

+ const AccessTokenType

+ const ActionRequestEmailVerification

+ const ActionRequestPasswordReset

+ const ActionRequestPhoneVerification

+ const ActionUpdateUsername

+ const DefaultOutboundTimeout

+ const DelegatedAccessTokenType

+ const RL2FADisable

+ const RL2FAEnable

+ const RL2FARegenerateCodes

+ const RL2FAStartPhone

+ const RL2FAStartTOTP

+ const RL2FAVerify

+ const RLAdminPasswordReset

+ const RLAdminRolesGrant

+ const RLAdminRolesRevoke

+ const RLAdminUserSessionsList

+ const RLAdminUserSessionsRevokeAll

+ const RLAuthLogout

+ const RLAuthRegister

+ const RLAuthRegisterAbandon

+ const RLAuthRegisterAvailability

+ const RLAuthRegisterResendEmail

+ const RLAuthRegisterResendPhone

+ const RLAuthSessionsCurrent

+ const RLAuthSessionsList

+ const RLAuthSessionsRevoke

+ const RLAuthSessionsRevokeAll

+ const RLAuthToken

+ const RLEmailVerifyConfirm

+ const RLEmailVerifyRequest

+ const RLInviteCreate

+ const RLOIDCCallback

+ const RLOIDCStart

+ const RLPasskeyLogin

+ const RLPasskeyRegister

+ const RLPasswordLogin

+ const RLPasswordResetConfirm

+ const RLPasswordResetRequest

+ const RLPasswordlessConfirm

+ const RLPasswordlessStart

+ const RLPhoneVerifyConfirm

+ const RLPhoneVerifyRequest

+ const RLSolanaChallenge

+ const RLSolanaLink

+ const RLSolanaLogin

+ const RLUserDelete

+ const RLUserEmailChangeCancel

+ const RLUserEmailChangeConfirm

+ const RLUserEmailChangeRequest

+ const RLUserEmailChangeResend

+ const RLUserMe

+ const RLUserPasswordChange

+ const RLUserPhoneChangeCancel

+ const RLUserPhoneChangeConfirm

+ const RLUserPhoneChangeRequest

+ const RLUserPhoneChangeResend

+ const RLUserPreferredLanguage

+ const RLUserUnlinkProvider

+ const RLUserUpdateEmail

+ const RLUserUpdateUsername

+ const RemoteApplicationAccessTokenType

+ func DefaultRateLimits() map[string]ratelimit.Limit

+ func JWKSHandler(jwks jwtkit.JWKS) http.Handler

+ func LanguageMiddleware(cfg *LanguageConfig) func(http.Handler) http.Handler

+ type ActionAvailability struct

+ Action string

+ Allowed bool

+ CooldownSeconds *int64

+ Limit *int

+ NextAllowedAt *time.Time

+ Reason string

+ Remaining *int

+ RetryAfterSeconds int64

+ WindowSeconds *int64

+ type AuthCapabilities struct

+ Languages []string

+ Passkeys AuthPasskeyCapabilities

+ Password AuthPasswordCapabilities

+ Passwordless AuthPasswordlessCapabilities

+ Providers []AuthProviderSummary

+ Registration AuthRegistrationCapabilities

+ Solana AuthSolanaCapabilities

+ Verification AuthVerificationCapabilities

+ type AuthPasskeyCapabilities struct

+ Login bool

+ type AuthPasswordCapabilities struct

+ Login bool

+ type AuthPasswordlessCapabilities struct

+ Channels []string

+ Enabled bool

+ type AuthProviderSummary struct

+ ID string

+ Kind string

+ Name string

+ SupportsLink bool

+ SupportsLogin bool

+ SupportsRegistration bool

+ type AuthRegistrationCapabilities struct

+ InviteTokenRequired bool

+ Mode string

+ type AuthSolanaCapabilities struct

+ Login bool

+ type AuthVerificationCapabilities struct

+ Registration string

+ type ClientIPFunc func(r *http.Request) string

+ func ClientIPFromForwardedHeaders(trustedProxies []netip.Prefix) ClientIPFunc

+ func DefaultClientIP() ClientIPFunc

+ func PublicRemoteAddrClientIP() ClientIPFunc

+ type ErrorCode string

+ const ErrAbandonFailed

+ const ErrAccessTokenCreateFailed

+ const ErrAccessTokenListFailed

+ const ErrAccessTokenNotFound

+ const ErrAccessTokenRevokeFailed

+ const ErrAccountAlreadyClaimed

+ const ErrAccountClaimUserFailed

+ const ErrAccountExistsLinkRequired

+ const ErrAccountParkFailed

+ const ErrAccountRestrictFailed

+ const ErrAccountUnrestrictFailed

+ const ErrAddMemberFailed

+ const ErrAddressMismatch

+ const ErrAddressRequired

+ const ErrAssignRoleFailed

+ const ErrAttributeDefNotFound

+ const ErrAttributeDefRegisterFailed

+ const ErrAttributeDefResolveFailed

+ const ErrAuthRequiredForLink

+ const ErrAuthenticationFailed

+ const ErrAuthenticationRequired

+ const ErrAuthkitNotInitialized

+ const ErrAuthlogUnavailable

+ const ErrCancelFailed

+ const ErrCannotRemoveLastOwner

+ const ErrCannotUnlinkLastLoginMethod

+ const ErrChallengeExpired

+ const ErrChallengeFailed

+ const ErrChallengeVerifyFailed

+ const ErrDatabaseError

+ const ErrDefineRoleFailed

+ const ErrDeleteRoleFailed

+ const ErrDisableTwoFAFailed

+ const ErrDuplicateResource

+ const ErrEmailAlreadyVerified

+ const ErrEmailDeliveryFailed

+ const ErrEmailInUse

+ const ErrEmailNotVerified

+ const ErrEmailPasswordResetUnavailable

+ const ErrEmailRegistrationUnavailable

+ const ErrEmailSenderUnavailable

+ const ErrEmailUnavailable

+ const ErrEmailUnchanged

+ const ErrEmailVerificationFailed

+ const ErrEmailVerificationUnavailable

+ const ErrEnableTwoFAFailed

+ const ErrEntitlementFilterUnavailable

+ const ErrExchangeFailed

+ const ErrFailedToBan

+ const ErrFailedToDelete

+ const ErrFailedToList

+ const ErrFailedToListDeletedUsers

+ const ErrFailedToListSignins

+ const ErrFailedToListUsers

+ const ErrFailedToLogout

+ const ErrFailedToRequestEmailChange

+ const ErrFailedToRequestPhoneChange

+ const ErrFailedToRestoreUser

+ const ErrFailedToRevoke

+ const ErrFailedToRevokeAll

+ const ErrFailedToRevokeSessions

+ const ErrFailedToSetPassword

+ const ErrFailedToUnban

+ const ErrFailedToUnlink

+ const ErrFailedToUpdateBiography

+ const ErrFailedToUpdateEmail

+ const ErrFailedToUpdatePreferredLanguage

+ const ErrFailedToUpdateUsername

+ const ErrForbidden

+ const ErrHashFailed

+ const ErrInvalidAddress

+ const ErrInvalidBaseURL

+ const ErrInvalidChallenge

+ const ErrInvalidCode

+ const ErrInvalidCredentials

+ const ErrInvalidDefinition

+ const ErrInvalidEmail

+ const ErrInvalidExpiresAt

+ const ErrInvalidExpiry

+ const ErrInvalidFederationIssuer

+ const ErrInvalidFederationTrustSource

+ const ErrInvalidIdentifier

+ const ErrInvalidMessageEncoding

+ const ErrInvalidMethod

+ const ErrInvalidOrExpiredCode

+ const ErrInvalidOrExpiredResetSession

+ const ErrInvalidOrExpiredToken

+ const ErrInvalidOwnerNamespaceTransition

+ const ErrInvalidPassword

+ const ErrInvalidPhoneNumber

+ const ErrInvalidPreferredLanguage

+ const ErrInvalidProvider

+ const ErrInvalidRefreshToken

+ const ErrInvalidRequest

+ const ErrInvalidResource

+ const ErrInvalidRole

+ const ErrInvalidSignature

+ const ErrInvalidSignatureEncoding

+ const ErrInvalidSlug

+ const ErrInvalidState

+ const ErrInvalidToken

+ const ErrInvalidTrustSource

+ const ErrInvalidUI

+ const ErrInvalidUntil

+ const ErrInvalidVersion

+ const ErrInviteNotFound

+ const ErrIssuerReserved

+ const ErrLinkFailed

+ const ErrMemberPermissionsLookupFailed

+ const ErrMemberRolesLookupFailed

+ const ErrMissingFields

+ const ErrMissingName

+ const ErrMissingRole

+ const ErrMissingSessionID

+ const ErrMissingSidClaim

+ const ErrNoEmail

+ const ErrNoPendingEmailChange

+ const ErrNoPendingPhoneChange

+ const ErrNotAuthenticated

+ const ErrNotFound

+ const ErrOIDCBeginFailed

+ const ErrOIDCExchangeFailed

+ const ErrOwnerMembershipRequired

+ const ErrOwnerNamespaceInfoFailed

+ const ErrOwnerSlugTaken

+ const ErrOwnerUserNotFound

+ const ErrPKCEGenerationFailed

+ const ErrPasskeyFailed

+ const ErrPasswordChangeFailed

+ const ErrPasswordResetRequestFailed

+ const ErrPasswordResetRequired

+ const ErrPasswordTooShort

+ const ErrPasswordlessDisabled

+ const ErrPendingRegistrationNotFound

+ const ErrPermissionCheckFailed

+ const ErrPermissionGrantDenied

+ const ErrPermissionValidateFailed

+ const ErrPermissionsLookupFailed

+ const ErrPhoneAlreadyVerified

+ const ErrPhoneAndCodeRequired

+ const ErrPhoneChangeUnavailable

+ const ErrPhoneInUse

+ const ErrPhoneNotVerified

+ const ErrPhoneNumberMustBeE164

+ const ErrPhoneRegistrationUnavailable

+ const ErrPhoneTwoFAUnavailable

+ const ErrPhoneUnavailable

+ const ErrPhoneUnchanged

+ const ErrPhoneVerificationFailed

+ const ErrPhoneVerificationUnavailable

+ const ErrPreferredLanguageLookupFailed

+ const ErrProtectedRole

+ const ErrProviderAlreadyLinked

+ const ErrProviderLinkFailed

+ const ErrProviderNotLinked

+ const ErrRateLimited

+ const ErrRegenerateCodesFailed

+ const ErrRegistrationDisabled

+ const ErrRegistrationFailed

+ const ErrRemoteApplicationDeleteFailed

+ const ErrRemoteApplicationLookupFailed

+ const ErrRemoteApplicationMembershipFailed

+ const ErrRemoteApplicationNotFound

+ const ErrRemoteApplicationOwnerLookupFailed

+ const ErrRemoteApplicationRegisterFailed

+ const ErrRemoveMemberFailed

+ const ErrRenameRateLimited

+ const ErrResendFailed

+ const ErrReservedAccountNotFound

+ const ErrRoleExceedsGrantor

+ const ErrRoleNotFound

+ const ErrRoleNotGrantableToAPIKey

+ const ErrRolePermissionsLookupFailed

+ const ErrRolePermissionsUpdateFailed

+ const ErrSMSDeliveryFailed

+ const ErrSMSUnavailable

+ const ErrSendCodeFailed

+ const ErrSessionCreationFailed

+ const ErrSessionIssueFailed

+ const ErrStateStoreFailed

+ const ErrStepUpFailed

+ const ErrStepUpRequired

+ const ErrTokenCreationFailed

+ const ErrTokenIssueFailed

+ const ErrTwoFAChallengeFailed

+ const ErrTwoFAEnrollmentRequired

+ const ErrTwoFASendFailed

+ const ErrUnassignRoleFailed

+ const ErrUnauthorized

+ const ErrUnknownPermission

+ const ErrUnknownProvider

+ const ErrUnknownRole

+ const ErrUserBanned

+ const ErrUserCreationFailed

+ const ErrUserInvitesLookupFailed

+ const ErrUserLookupFailed

+ const ErrUserNotFound

+ const ErrUserRecoverFailed

+ const ErrUserinfoFailed

+ const ErrUsernameCannotContainAt

+ const ErrUsernameCannotStartWithPlus

+ const ErrUsernameInUse

+ const ErrUsernameInvalidCharacters

+ const ErrUsernameMissing

+ const ErrUsernameMustStartWithLetter

+ const ErrUsernameNotAllowed

+ const ErrUsernameTooLong

+ const ErrUsernameTooShort

+ const ErrVerificationLinkExpired

+ const ErrVerificationRequestFailed

+ const ErrWalletAlreadyLinked

+ func (c ErrorCode) String() string

+ type LanguageConfig struct

+ Default string

+ Supported []string

+ type Option func(*Service)

+ func WithClientIPFunc(fn ClientIPFunc) Option

+ func WithLanguageConfig(cfg LanguageConfig) Option

+ func WithRateLimiter(rl RateLimiter) Option

+ func WithRedis(rd *redis.Client) Option

+ func WithTrustedProxies(cidrs ...string) Option

+ func WithoutRateLimiter() Option

+ type RateLimitResult struct

+ Allowed bool

+ Availability *ActionAvailability

+ RetryAfter time.Duration

+ type RateLimiter interface

+ AllowNamed func(bucket string, key string) (bool, error)

+ type RateLimiterWithResult interface

+ AllowNamedResult func(bucket string, key string) (ratelimit.Result, error)

+ type RemoteApplicationIssuerRegistration struct

+ Issuer string

+ JWKSURI string

+ PublicKeys []authkit.RemoteAppKey

+ Slug string

+ type RemoteApplicationIssuersClient struct

+ func NewRemoteApplicationIssuersClient(opts ...RemoteApplicationIssuersClientOption) *RemoteApplicationIssuersClient

+ func (fc *RemoteApplicationIssuersClient) RegisterIssuer(ctx context.Context, acceptURL string, reg RemoteApplicationIssuerRegistration) error

+ type RemoteApplicationIssuersClientOption func(*RemoteApplicationIssuersClient)

+ func WithRemoteApplicationIssuersAuthToken(token string) RemoteApplicationIssuersClientOption

+ func WithRemoteApplicationIssuersHTTPClient(c *http.Client) RemoteApplicationIssuersClientOption

+ type RouteGroup string

+ const RouteAccount

+ const RouteAdmin

+ const RouteAuth

+ const RouteBrowserOIDC

+ const RoutePermissionGroups

+ const RouteRegistration

+ type RouteSpec struct

+ Group RouteGroup

+ Handler http.Handler

+ Method string

+ Path string

+ type Routes struct

+ func (r Routes) DefaultAPI() []RouteSpec

+ func (r Routes) Groups(groups ...RouteGroup) []RouteSpec

+ func (r Routes) OIDCBrowser() []RouteSpec

+ func (r Routes) PermissionGroups() []RouteSpec

+ type Service struct

+ func NewServer(client *embedded.Client, opts ...Option) (*Service, error)

+ func (s *Service) APIHandler() http.Handler

+ func (s *Service) APIRoutes(groups ...RouteGroup) []RouteSpec

+ func (s *Service) CheckSMSHealth(ctx context.Context) error

+ func (s *Service) JWKSHandler() http.Handler

+ func (s *Service) OIDCBrowserRoutes(groups ...RouteGroup) []RouteSpec

+ func (s *Service) OIDCHandler() http.Handler

+ func (s *Service) PermissionGroupRoutes() []RouteSpec

+ func (s *Service) Routes() Routes

+ func (s *Service) SMSAvailable() bool

+ func (s *Service) SMSHealthReason() string

+ func (s *Service) SMSHealthy() bool

+ func (s *Service) Verifier() *verify.Verifier

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL