Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

auth

package module

Go to main page

Versions in this module

v1

v1.4.0

Nov 3, 2026

v1.3.0

Nov 3, 2026

v1.2.0

Nov 2, 2026

v1.1.0

Nov 2, 2026

Changes in this version

+ var ErrSignUpNotAllowed = errors.New("auth: sign-up not allowed")

v1.0.2

Nov 2, 2026

v1.0.1

Oct 30, 2026

v1.0.0

Oct 29, 2026

Changes in this version

+ const EventAppRoleChanged

+ const EventEmailChanged

+ const EventLoginFailed

+ const EventLoginSucceeded

+ const EventLogout

+ const EventLogoutEverywhere

+ const EventMemberAdded

+ const EventMemberRemoved

+ const EventOAuthLinked

+ const EventOAuthUnlinked

+ const EventOrgRoleChanged

+ const EventPasswordChanged

+ const EventPasswordReset

+ const EventRecoveryCodeUsed

+ const EventRecoveryCodesRegenerated

+ const EventSessionEnded

+ const EventTwoFactorDisabled

+ const EventTwoFactorEnabled

+ const EventTwoFactorRequiredChanged

+ const EventTwoFactorReset

+ const InvitationLifetime

+ const OrgHeader

+ const OwnerRole

+ const PermMembersManage

+ const PermMembersRead

+ const PermOrganizationUpdate

+ const Schema

+ var ErrBadCursor = errors.New("auth: bad cursor")

+ var ErrInvalidOrgName = errors.New("auth: organization name must be 1 to 200 characters")

+ func Can(ctx context.Context, permission rbac.Permission) bool

+ func Migrate(ctx context.Context, pool *pgxpool.Pool) error

+ type Actor struct

+ IP *netip.Addr

+ UserAgent string

+ UserID *uuid.UUID

+ type Apple struct

+ BundleIDs []string

+ type Auth struct

+ func New(cfg Config) (*Auth, error)

+ func (a *Auth) ActorOf(r *http.Request) Actor

+ func (a *Auth) Authenticated(h http.Handler) http.Handler

+ func (a *Auth) Cleanup(ctx context.Context) error

+ func (a *Auth) Close(ctx context.Context) error

+ func (a *Auth) CreateOrganization(ctx context.Context, name string, ownerID uuid.UUID, by Actor) (Organization, error)

+ func (a *Auth) Events(ctx context.Context, userID uuid.UUID, cursor string) (EventPage, error)

+ func (a *Auth) Protect(mux *http.ServeMux) http.Handler

+ func (a *Auth) Public(h http.Handler) http.Handler

+ func (a *Auth) Register(mux *http.ServeMux)

+ func (a *Auth) Require(permission rbac.Permission, h http.Handler) http.Handler

+ func (a *Auth) RequireOrg(permission rbac.Permission, h http.Handler) http.Handler

+ func (a *Auth) ResetTwoFactor(ctx context.Context, userID uuid.UUID, by Actor) error

+ func (a *Auth) SetAppRole(ctx context.Context, userID uuid.UUID, role string, by Actor) error

+ func (a *Auth) SetTwoFactorRequired(ctx context.Context, userID uuid.UUID, required bool, by Actor) error

+ type Config struct

+ AllowUnverifiedLogin bool

+ AppName string

+ AppRoles rbac.Roles

+ AppURL string

+ DB *pgxpool.Pool

+ DisableBreachCheck bool

+ DisableCleanup bool

+ DisableNewDeviceEmails bool

+ DisableOrganizationCreation bool

+ Emails Emails

+ EncryptionKey string

+ Hooks Hooks

+ Logger *slog.Logger

+ Mailer mail.Mailer

+ Now func() time.Time

+ OAuth OAuth

+ OrgRoles rbac.Roles

+ TrustedProxies []netip.Prefix

+ TwoFactorRoles []string

+ type EmailData struct

+ AppName string

+ AppURL string

+ Device string

+ ExpiresIn time.Duration

+ Link string

+ LoggedInAt time.Time

+ OrgName string

+ Provider string

+ RecoveryCodesLeft int

+ type Emails struct

+ EmailChange func(EmailData) (subject, text, html string)

+ EmailChanged func(EmailData) (subject, text, html string)

+ Invitation func(EmailData) (subject, text, html string)

+ NewDeviceLogin func(EmailData) (subject, text, html string)

+ OAuthLinked func(EmailData) (subject, text, html string)

+ OAuthUnlinked func(EmailData) (subject, text, html string)

+ PasswordChanged func(EmailData) (subject, text, html string)

+ PasswordReset func(EmailData) (subject, text, html string)

+ RecoveryCodeUsed func(EmailData) (subject, text, html string)

+ RecoveryCodesRegenerated func(EmailData) (subject, text, html string)

+ SignUpAttempt func(EmailData) (subject, text, html string)

+ TwoFactorDisabled func(EmailData) (subject, text, html string)

+ TwoFactorEnabled func(EmailData) (subject, text, html string)

+ TwoFactorGuessing func(EmailData) (subject, text, html string)

+ VerifyEmail func(EmailData) (subject, text, html string)

+ type Event struct

+ ActorID *uuid.UUID

+ CreatedAt time.Time

+ ID uuid.UUID

+ IP *netip.Addr

+ Metadata map[string]string

+ Type string

+ UserAgent string

+ UserID *uuid.UUID

+ type EventPage struct

+ Events []Event

+ NextCursor string

+ type GitHub struct

+ ClientID string

+ ClientSecret string

+ type Google struct

+ ClientID string

+ ClientSecret string

+ type Hooks struct

+ OnEvent func(ctx context.Context, e Event)

+ OnUserCreated func(ctx context.Context, tx pgx.Tx, u User) error

+ type OAuth struct

+ Apple *Apple

+ GitHub *GitHub

+ Google *Google

+ type Org struct

+ ID uuid.UUID

+ Role string

+ func OrgFrom(ctx context.Context) (o Org, ok bool)

+ type Organization struct

+ CreatedAt time.Time

+ ID uuid.UUID

+ Name string

+ UpdatedAt time.Time

+ type Session struct

+ Client string

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID uuid.UUID

+ func SessionFrom(ctx context.Context) (s Session, ok bool)

+ type User struct

+ CreatedAt time.Time

+ Email string

+ EmailVerified bool

+ ID uuid.UUID

+ func UserFrom(ctx context.Context) (u User, ok bool)