authsetup

Oct 5, 2026

Changes in this version

+ var ErrNoDirectorySync = errors.New("this provider is not running or has no directory to sync")

+ var ErrSyncRunning = errors.New("a directory sync is already running")

+ func SyncKeyPrefix(name string) string

type Live

+ func (l *Live) CanSync(name string) bool

+ func (l *Live) DirectoryFor(email string, tenant int64) (slug, label string, ok bool)

+ func (l *Live) LastSync(ctx context.Context, name string) (*auth.DirectorySyncReport, error)

+ func (l *Live) RunDirectorySync(ctx context.Context)

+ func (l *Live) StartSync(ctx context.Context, name, trigger string) error

+ func (l *Live) SyncInterval(name string) time.Duration

+ func (l *Live) SyncNow(ctx context.Context, name, trigger string) (*auth.DirectorySyncReport, error)

+ func (l *Live) Syncing(name string) bool

type Set

+ func (s *Set) Serves(e Entry, tenantID int64) bool

Oct 3, 2026

Changes in this version

+ const InstancesSetting

+ const OriginTenant

+ const OwnSSOKey

+ const ReviewSetting

+ var ErrNoSSOForTenant = errors.New("oidc: no such sign-in for this realm")

+ var OSProviders = []string

+ var TenantDrivers = []string

+ func EnsureAnchors(ctx context.Context, store db.Store, env []Entry, log *slog.Logger) error

+ func EnvTrustEmail(ctx context.Context, store trustStore, explicit *bool) (trust, byUpgrade bool)

+ func ForgetTrustUpgradeInstance(ctx context.Context, store trustStore, slug string)

+ func ForgetTrustUpgradeTenant(ctx context.Context, store trustStore, id int64)

+ func IsOS(name string) bool

+ func PrimarySlug(slug, driver string) bool

+ func RowConfigJSON(s *Stored) string

+ func TenantGuard(insecureAllowed bool) func(map[string]any)

+ func UpgradeOIDCTrust(ctx context.Context, store db.Store, log *slog.Logger) error

+ type Bindings struct

+ Main int64

+ func ReadBindings(ctx context.Context, store db.Store) (*Bindings, error)

+ func (b *Bindings) Bound(instanceID, tenantID int64) bool

+ func (b *Bindings) Insecure(tenantID int64) bool

+ func (b *Bindings) Tenants() []int64

+ func (b *Bindings) TenantsOf(instanceID int64) []int64

type Entry

+ InstanceID int64

+ Label string

+ Owner int64

+ SetByUpgrade []string

+ Slug string

type Field

+ func TenantFields(driver string) []Field

type FieldKind

+ const FieldMultiline

type Live

+ func (l *Live) AdminPathsIn(ctx context.Context, tenantID int64, exclude func(Entry) bool) []string

+ func (l *Live) SSOChoices(ctx context.Context, p *model.Provider, tenantID int64, host string) []SSOChoice

+ func (l *Live) SetProviderAlarm(f func(name, reason string))

type Options

+ LoginEmailToken string

+ type SSOChoice struct

+ Key string

+ Label string

type Set

+ func (s *Set) Bindings() *Bindings

+ func (s *Set) For(tenantID int64) *View

+ func (s *Set) MultiTenant() bool

type Stored

+ func StoredOfRow(a *model.AuthInstance) (*Stored, error)

+ type TrustUpgrade struct

+ Instances []string

+ Tenants []int64

+ func ReadTrustUpgrade(ctx context.Context, store trustStore) TrustUpgrade

+ func (t TrustUpgrade) Instance(slug string) bool

+ func (t TrustUpgrade) Tenant(id int64) bool

+ type View struct

+ SSO []Entry

+ Tenant int64

+ func (v *View) Names() []string

+ func (v *View) PasswordLogin() bool

+ func (v *View) Recovery() bool

Sep 24, 2026

Changes in this version

+ const OriginEnvironment

+ const OriginPage

+ const SchemaSetting

+ var ErrOIDCOff = errors.New("OIDC is not configured")

+ var ErrPasswordSignInOff = errors.New("password sign-in is off")

+ var ErrSecretKeyRequired = errors.New(...)

+ var Managed = []string

+ var Schema = map[string][]Field

+ func Build(ctx context.Context, store db.Store, name string, cfg map[string]any) (auth.Driver, error)

+ func Canonical(name string) string

+ func DraftConfig(s *Stored, draft map[string]any, box *secretbox.Box, opts Options) (map[string]any, error)

+ func DriverConfig(s *Stored, box *secretbox.Box, opts Options) (map[string]any, bool, error)

+ func FromWords(from, lang string) string

+ func IsManaged(name string) bool

+ func LoadStored(ctx context.Context, store db.Store) (map[string]*Stored, error)

+ func Save(ctx context.Context, store db.Store, next *Stored) error

+ func UpgradeLegacy(ctx context.Context, store db.Store, box *secretbox.Box, log *slog.Logger) error

+ func WithRecoveryLogin(loginDrvs []auth.LoginDriver, enabled bool, store db.Store) ([]auth.LoginDriver, bool)

+ func WithSessionAuthenticator(enabled []auth.Driver, store db.Store) []auth.Driver

+ type Change struct

+ Enabled *bool

+ Values map[string]any

+ type Directory interface

+ VerifyPassword func(ctx context.Context, identifier, password string) (*model.User, error)

+ type Entry struct

+ Directory bool

+ Display map[string]any

+ Driver auth.Driver

+ Err string

+ From string

+ Name string

+ Origin string

+ Secrets []string

+ func NewEnvEntry(name, from string, cfg map[string]any, d auth.Driver, err error, ...) Entry

+ func (e Entry) Config() map[string]any

+ func (e Entry) Live() bool

+ type Field struct

+ Default string

+ Key string

+ Kind FieldKind

+ Required bool

+ func FieldOf(name, key string) (Field, bool)

+ type FieldKind string

+ const FieldBool

+ const FieldSecret

+ const FieldText

+ type Live struct

+ func New(ctx context.Context, opts Options, env []Entry) (*Live, error)

+ func (l *Live) AdminPaths(ctx context.Context, without string) []string

+ func (l *Live) Current() *Set

+ func (l *Live) Dir() Directory

+ func (l *Live) EnvDefines(name string) (Entry, bool)

+ func (l *Live) Environment() []Entry

+ func (l *Live) Login() auth.LoginDriver

+ func (l *Live) LoginName() string

+ func (l *Live) OIDC() auth.OIDCDriver

+ func (l *Live) OnSwap(f func(*Set))

+ func (l *Live) Options() Options

+ func (l *Live) Reload(ctx context.Context) error

+ func (l *Live) Start(ctx context.Context)

+ type Options struct

+ Box *secretbox.Box

+ BuildTimeout time.Duration

+ Log *slog.Logger

+ MultiTenant bool

+ PublicURL string

+ RecoveryLogin bool

+ RetryBackoff []time.Duration

+ Store db.Store

+ type Set struct

+ Entries []Entry

+ func (s *Set) Entry(name string) (Entry, bool)

+ func (s *Set) HasDirectory() bool

+ func (s *Set) Names() []string

+ func (s *Set) PasswordLogin() bool

+ func (s *Set) Recovery() bool

+ type Stored struct

+ Enabled bool

+ Exists bool

+ Legacy bool

+ Name string

+ Values map[string]string

+ func Merge(cur *Stored, ch Change, box *secretbox.Box) (*Stored, []string, error)