auth

package

v0.8.0 Latest Latest Go to latest Published: Jun 17, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/skael-dev/skael

Links

Open Source Insights

Documentation ¶

Index ¶

func CheckAPIKey(storedHash, key string) bool
func CheckPassword(hash, password string) bool
func ContextWithUser(ctx context.Context, user *User) context.Context
func GenerateAPIKey() (fullKey, prefix string, err error)
func GenerateTemporaryPassword() (string, error)
func HashAPIKey(key string) (string, error)
func HashPassword(password string) (string, error)
func Middleware(sessionManager *scs.SessionManager, userStore *UserStore, keyStore *KeyStore) func(http.Handler) http.Handler
func RegisterRoutes(api huma.API, sessionManager *scs.SessionManager, userStore *UserStore, ...)
type APIKeyInfo
type APIKeyRow
type KeyStore
- func NewKeyStore(pool *pgxpool.Pool) *KeyStore
- func (s *KeyStore) Create(ctx context.Context, userID, name, keyPrefix, keyHash string) (*APIKeyRow, error)
- func (s *KeyStore) Delete(ctx context.Context, id, userID string) 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 User
- func UserFromContext(ctx context.Context) *User
type UserRow
type UserStore
- func NewUserStore(pool *pgxpool.Pool) *UserStore
- func (s *UserStore) Count(ctx context.Context) (int, error)
- func (s *UserStore) Create(ctx context.Context, email, name, passwordHash string) (*UserRow, error)
- func (s *UserStore) CreateWithRole(ctx context.Context, email, name, passwordHash, 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) SetResetRequired(ctx context.Context, id string, required bool) error
- func (s *UserStore) UpdatePassword(ctx context.Context, id, passwordHash string) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CheckAPIKey ¶

func CheckAPIKey(storedHash, key string) bool

func CheckPassword ¶

func CheckPassword(hash, password string) bool

func ContextWithUser ¶

func ContextWithUser(ctx context.Context, user *User) context.Context

func GenerateAPIKey ¶

func GenerateAPIKey() (fullKey, prefix string, err error)

func GenerateTemporaryPassword ¶ added in v0.7.0

func GenerateTemporaryPassword() (string, error)

func HashAPIKey ¶

func HashAPIKey(key string) (string, error)

func HashPassword ¶

func HashPassword(password string) (string, error)

func Middleware ¶

func Middleware(sessionManager *scs.SessionManager, userStore *UserStore, keyStore *KeyStore) func(http.Handler) http.Handler

Middleware returns a chi-compatible middleware that enforces authentication on all /api/ routes except explicitly exempt paths. It checks two auth methods in order:

Session cookie (via scs session manager)
API key (X-API-Key header with "sk-" prefix, SHA-256 hashed)

On success, the authenticated User is attached to the request context via ContextWithUser.

func RegisterRoutes ¶

func RegisterRoutes(api huma.API, sessionManager *scs.SessionManager, userStore *UserStore, keyStore *KeyStore, disableSignup bool)

RegisterRoutes wires up all authentication-related HTTP endpoints onto the provided Huma API: signup, login, logout, me, and API key management.

Types ¶

type APIKeyInfo ¶

type APIKeyInfo struct {
	ID         string     `json:"id"`
	Name       string     `json:"name"`
	Prefix     string     `json:"prefix"`
	LastUsedAt *time.Time `json:"last_used_at"`
	CreatedAt  time.Time  `json:"created_at"`
}

type APIKeyRow ¶

type APIKeyRow struct {
	ID         string
	UserID     string
	Name       string
	KeyPrefix  string
	KeyHash    string
	LastUsedAt *time.Time
	CreatedAt  time.Time
}

type KeyStore ¶

type KeyStore struct {
	// contains filtered or unexported fields
}

func NewKeyStore ¶

func NewKeyStore(pool *pgxpool.Pool) *KeyStore

func (*KeyStore) Create ¶

func (s *KeyStore) Create(ctx context.Context, userID, name, keyPrefix, keyHash string) (*APIKeyRow, error)

func (*KeyStore) Delete ¶

func (s *KeyStore) Delete(ctx context.Context, id, userID string) error

func (*KeyStore) GetByPrefix ¶

func (s *KeyStore) GetByPrefix(ctx context.Context, prefix string) (*APIKeyRow, error)

func (*KeyStore) ListByUser ¶

func (s *KeyStore) ListByUser(ctx context.Context, userID string) ([]APIKeyInfo, error)

func (*KeyStore) UpdateLastUsed ¶

func (s *KeyStore) UpdateLastUsed(ctx context.Context, id string)

type User ¶

type User struct {
	ID    string `json:"id"`
	Email string `json:"email"`
	Name  string `json:"name"`
	Role  string `json:"role"`
}

func UserFromContext ¶

func UserFromContext(ctx context.Context) *User

type UserRow ¶

type UserRow struct {
	ID                    string
	Email                 string
	Name                  string
	PasswordHash          string
	Role                  string
	PasswordResetRequired bool
	CreatedAt             time.Time
}

type UserStore ¶

type UserStore struct {
	// contains filtered or unexported fields
}

func NewUserStore ¶

func NewUserStore(pool *pgxpool.Pool) *UserStore

func (*UserStore) Count ¶

func (s *UserStore) Count(ctx context.Context) (int, error)

func (*UserStore) Create ¶

func (s *UserStore) Create(ctx context.Context, email, name, passwordHash string) (*UserRow, error)

func (*UserStore) CreateWithRole ¶

func (s *UserStore) CreateWithRole(ctx context.Context, email, name, passwordHash, role string) (*UserRow, error)

func (*UserStore) GetByEmail ¶

func (s *UserStore) GetByEmail(ctx context.Context, email string) (*UserRow, error)

func (*UserStore) GetByID ¶

func (s *UserStore) GetByID(ctx context.Context, id string) (*UserRow, error)

func (*UserStore) List ¶ added in v0.7.0

func (s *UserStore) List(ctx context.Context) ([]UserRow, error)

func (*UserStore) SetResetRequired ¶ added in v0.7.0

func (s *UserStore) SetResetRequired(ctx context.Context, id string, required bool) error

func (*UserStore) UpdatePassword ¶ added in v0.7.0

func (s *UserStore) UpdatePassword(ctx context.Context, id, passwordHash string) error

Source Files ¶

View all Source files

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