Documentation
¶
Index ¶
- Constants
- func Allowed(ctx context.Context, scope string) bool
- func CheckAPIKey(storedHash, key string) bool
- func ContextWithKey(ctx context.Context, k *KeyInfo) context.Context
- func ContextWithUser(ctx context.Context, user *User) context.Context
- func GenerateAPIKey() (fullKey, prefix string, err error)
- func HasScope(ctx context.Context, scope string) bool
- func HashAPIKey(key string) (string, error)
- func KindOf(u *store.User) string
- func Middleware(people *People, keyStore *KeyStore) func(http.Handler) http.Handler
- func NewSMTPSender(host string, port int, username, password, from string) email.Sender
- func PassXAPIKey(r *http.Request)
- func RegisterRoutes(api huma.API, people *People, userStore *UserStore, keyStore *KeyStore)
- func RegisterServiceAccountRoutes(api huma.API, pool *pgxpool.Pool, keys *KeyStore)
- func SignupAllowed(provider, address string, disableSignup bool, domains []string) error
- func ValidScope(s string) bool
- type APIKeyInfo
- type APIKeyRow
- type KeyInfo
- type KeyStore
- func (s *KeyStore) Create(ctx context.Context, userID, name, keyPrefix, keyHash string) (*APIKeyRow, error)
- func (s *KeyStore) CreateLimited(ctx context.Context, userID, name, keyPrefix, keyHash string, scopes []string, ...) (*APIKeyRow, error)
- func (s *KeyStore) Delete(ctx context.Context, id, userID string) error
- func (s *KeyStore) GetByID(ctx context.Context, id string) (*APIKeyRow, error)
- func (s *KeyStore) GetByPrefix(ctx context.Context, prefix string) (*APIKeyRow, error)
- func (s *KeyStore) ListByUser(ctx context.Context, userID string) ([]APIKeyInfo, error)
- func (s *KeyStore) UpdateLastUsed(ctx context.Context, id string)
- type People
- type PeopleConfig
- type RouteRule
- type ServiceAccount
- type SignInMethods
- type User
- type UserRow
- type UserStore
- func (s *UserStore) Count(ctx context.Context) (int, error)
- func (s *UserStore) Create(ctx context.Context, email, name string) (*UserRow, error)
- func (s *UserStore) CreateWithRole(ctx context.Context, email, name, role string) (*UserRow, error)
- func (s *UserStore) GetByEmail(ctx context.Context, email string) (*UserRow, error)
- func (s *UserStore) GetByID(ctx context.Context, id string) (*UserRow, error)
- func (s *UserStore) List(ctx context.Context) ([]UserRow, error)
- func (s *UserStore) Search(ctx context.Context, q string, limit int) ([]UserRow, error)
Constants ¶
const ( RoleOwner = "owner" RoleAdmin = "admin" RoleMember = "member" KindHuman = "human" KindService = "service" )
const ( ScopeSkillsRead = "skills:read" ScopeSetsRead = "sets:read" ScopeEvalWork = "eval:work" ScopeEventsWrite = "events:write" ScopeOutcomesWrite = "outcomes:write" ScopeSubmissionsWrite = "submissions:write" )
The scopes a key may hold.
const AuthAllRoutes = "/api/auth/*"
AuthAllRoutes is the chi pattern auth-all serves a person's own account on.
Variables ¶
This section is empty.
Functions ¶
func Allowed ¶ added in v0.16.0
Allowed reports whether a tool or handler that needs scope may run for the request: an unrestricted caller may, and a restricted key needs the scope.
func CheckAPIKey ¶
func ContextWithKey ¶ added in v0.16.0
ContextWithKey attaches the authenticating key to ctx.
func GenerateAPIKey ¶
func HasScope ¶ added in v0.16.0
HasScope reports whether the request's key holds scope explicitly. An unrestricted key holds no scopes: its rights come from its owner's role.
func HashAPIKey ¶
func Middleware ¶
Middleware enforces authentication on /mcp and all /api/ routes except exempt paths. auth-all resolves a session cookie or a bearer value, and Skael adds its key limits, which auth-all does not hold.
func NewSMTPSender ¶ added in v0.17.0
NewSMTPSender returns the sender behind self-service password reset. net/smtp uses STARTTLS when the server offers it, and refuses to send auth in the clear.
func PassXAPIKey ¶ added in v0.17.0
PassXAPIKey lets installed hooks keep sending X-API-Key.
func RegisterRoutes ¶
RegisterRoutes wires up the routes Skael keeps: account state, API keys, and owner administration. auth-all serves the rest of a person's account.
func RegisterServiceAccountRoutes ¶ added in v0.16.0
RegisterServiceAccountRoutes wires service account and audit endpoints.
func SignupAllowed ¶ added in v0.17.0
SignupAllowed decides whether one new account may exist. The company's identity provider is its own gate, so DISABLE_SIGNUP does not stop OIDC.
func ValidScope ¶ added in v0.16.0
ValidScope reports whether s is a scope the server knows.
Types ¶
type APIKeyInfo ¶
type KeyInfo ¶ added in v0.16.0
KeyInfo describes the API key that authenticated a request. A session or an unrestricted personal key has none of these limits.
func KeyFromContext ¶ added in v0.16.0
KeyFromContext returns the authenticating key, or nil for a session.
func (*KeyInfo) Restricted ¶ added in v0.16.0
Restricted reports whether the deny-by-default table applies to the key.
type KeyStore ¶
type KeyStore struct {
// contains filtered or unexported fields
}
func NewKeyStore ¶
func (*KeyStore) CreateLimited ¶ added in v0.16.0
func (s *KeyStore) CreateLimited(ctx context.Context, userID, name, keyPrefix, keyHash string, scopes []string, setID *string) (*APIKeyRow, error)
CreateLimited inserts a key with scopes and an optional set limit.
func (*KeyStore) GetByPrefix ¶
func (*KeyStore) ListByUser ¶
type People ¶ added in v0.17.0
type People struct {
Auth *authall.Auth
Admin *admin.Plugin
// contains filtered or unexported fields
}
People is the auth-all instance behind every person's account.
func NewPeople ¶ added in v0.17.0
NewPeople builds auth-all with Skael's roles, key resolver and signup rules.
func (*People) SignInMethods ¶ added in v0.17.0
func (p *People) SignInMethods() SignInMethods
SignInMethods reports what the sign-in page may show.
type PeopleConfig ¶ added in v0.17.0
type PeopleConfig struct {
PublicURL string
CookieSecure bool
DisableSignup bool
AllowedDomains []string
TrustedOrigins []string
TrustedProxies []string
OIDCIssuer, OIDCClientID, OIDCClientSecret string
GoogleClientID, GoogleClientSecret string
GitHubClientID, GitHubClientSecret string
EmailSender email.Sender
// Inspecting builds routes for the OpenAPI document with no database.
Inspecting bool
}
PeopleConfig is the part of the server configuration auth-all reads.
type RouteRule ¶ added in v0.16.0
type RouteRule struct {
Method string
Pattern string
Scopes []string
// SetLimited marks a route a set-limited key may reach. The handler then
// checks that the set is the key's own.
SetLimited bool
}
RouteRule says which scopes reach one route. A rule with no scopes is listed so that the route is a decision, and a restricted key still never reaches it.
func RouteRules ¶ added in v0.16.0
func RouteRules() []RouteRule
RouteRules returns the table for the coverage test.
type ServiceAccount ¶ added in v0.16.0
type ServiceAccount struct {
ID string `json:"id"`
Name string `json:"name"`
KeyCount int `json:"key_count"`
LastUsedAt *time.Time `json:"last_used_at"`
CreatedAt time.Time `json:"created_at"`
}
ServiceAccount is a machine identity. Its name is the consumer it acts for.
func CreateServiceAccountTx ¶ added in v0.18.0
func CreateServiceAccountTx(ctx context.Context, tx pgx.Tx, name, actor string) (*ServiceAccount, error)
CreateServiceAccountTx inserts a service account inside tx, so a feature that owns one creates it with the rows that point at it.
type SignInMethods ¶ added in v0.17.0
type SignInMethods struct {
Password bool `json:"password"`
Signup bool `json:"signup"`
ForgotPassword bool `json:"forgot_password"`
Providers []string `json:"providers"`
}
SignInMethods says which sign-in methods an instance offers.
type User ¶
type User struct {
ID string `json:"id"`
Email string `json:"email"`
Name string `json:"name"`
Role string `json:"role"`
Kind string `json:"-"`
}
func UserFromContext ¶
func (*User) IsPrivileged ¶ added in v0.9.0
IsPrivileged reports whether the user may perform privileged operations. Gate on this rather than comparing role strings at call sites.
type UserRow ¶
type UserRow struct {
ID string
Email string
Name string
Role string
MustChangePassword bool
DisabledAt *time.Time
CreatedAt time.Time
Kind string
}
UserRow is one auth_users row. auth-all writes people, and Skael reads them.
type UserStore ¶
type UserStore struct {
// contains filtered or unexported fields
}
func NewUserStore ¶
func (*UserStore) CreateWithRole ¶
CreateWithRole inserts a user with no credential.