authn

Documentation

Index

• func GenerateToken(role, secret string) (string, error)
• func Middleware(cfg MiddlewareConfig, forceDBE bool, getDBName GetDatabaseNameFn) heligo.Middleware
• type Claims
• type GetDatabaseNameFn
• type MiddlewareConfig
• type Session
• type SessionList
• type SessionManager
  • func NewSessionManager(logger *logging.Logger, enabled bool, shutdown chan struct{}) *SessionManager
  • func (sm *SessionManager) Statistics() SessionStatistics
• type SessionStatistics

Functions

func GenerateToken

func GenerateToken(role, secret string) (string, error)

func Middleware

func Middleware(cfg MiddlewareConfig, forceDBE bool, getDBName GetDatabaseNameFn) heligo.Middleware

Types

type Claims

type Claims struct {
	Role string `json:"role"`
	Id   string `json:"id"`
	jwt.RegisteredClaims
}

type GetDatabaseNameFn

type GetDatabaseNameFn func(ctx context.Context, r heligo.Request) string

type MiddlewareConfig

type MiddlewareConfig interface {
	GetDatabase(context.Context, string) (*database.Database, error)
	JWTSecret() string
	AllowAnon() bool
	AnonRole() string
	SessionManager() *SessionManager
	Logger() *logging.Logger
}

type Session

type Session struct {
	Claims     *Claims
	LastUsedAt time.Time
	Db         *database.Database
	DbConn     *database.DbPoolConn
	// contains filtered or unexported fields
}

A Session for SmoothDB is the way to cache information about a user and his connection to a database

type SessionList

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

type SessionManager

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

SessionManager manages user sessions and monitors them efficiently. When disabled, it simply returns Sessions without managing or monitoring.

func NewSessionManager

func NewSessionManager(logger *logging.Logger, enabled bool, shutdown chan struct{}) *SessionManager

func (*SessionManager) Statistics

func (sm *SessionManager) Statistics() SessionStatistics

type SessionStatistics

type SessionStatistics struct {
	Count int
	InUse int
	Users int
}