Documentation
¶
Index ¶
- Constants
- Variables
- func ActorFromContext(ctx context.Context) (admin.Actor, bool)
- func CSRFMiddleware(next http.Handler) http.Handler
- func HashPassword(password string, config PasswordConfig) (string, error)
- func IssueCSRF(w http.ResponseWriter, secure bool) (string, error)
- func VerifyPassword(password, encoded string) (bool, error)
- type CacheSessionStore
- type MemorySessionStore
- type PGSessionStore
- func (s *PGSessionStore) Cleanup(ctx context.Context) (int64, error)
- func (s *PGSessionStore) Create(ctx context.Context, actor admin.Actor, ttl time.Duration) (Session, error)
- func (s *PGSessionStore) Delete(ctx context.Context, id string) error
- func (s *PGSessionStore) Get(ctx context.Context, id string) (Session, error)
- func (s *PGSessionStore) Migrate(ctx context.Context) error
- type PasswordConfig
- type RateLimiter
- type Session
- type SessionManager
- type SessionStore
Constants ¶
View Source
const SessionTableDDL = `` /* 308-byte string literal not displayed */
SessionTableDDL is the CREATE TABLE statement for the sessions table. Call PGSessionStore.Migrate to execute it.
Variables ¶
View Source
var ErrInvalidHash = errors.New("invalid password hash")
View Source
var ErrSessionNotFound = errors.New("session not found")
Functions ¶
func HashPassword ¶
func HashPassword(password string, config PasswordConfig) (string, error)
func VerifyPassword ¶
Types ¶
type CacheSessionStore ¶ added in v0.4.0
CacheSessionStore stores sessions in any cache.Cache implementation. Use it with Redis, Memcached, Dragonfly, KeyDB, or an existing app cache.
func NewCacheSessionStore ¶ added in v0.4.0
func NewCacheSessionStore(c cache.Cache) *CacheSessionStore
type MemorySessionStore ¶
type MemorySessionStore struct {
// contains filtered or unexported fields
}
func NewMemorySessionStore ¶
func NewMemorySessionStore() *MemorySessionStore
type PGSessionStore ¶
type PGSessionStore struct {
// contains filtered or unexported fields
}
PGSessionStore is a PostgreSQL-backed SessionStore. Use NewPGSessionStore to construct it, then call Migrate once at startup.
func NewPGSessionStore ¶
func NewPGSessionStore(pool *pgxpool.Pool) *PGSessionStore
NewPGSessionStore creates a PGSessionStore backed by the supplied pool.
func (*PGSessionStore) Cleanup ¶
func (s *PGSessionStore) Cleanup(ctx context.Context) (int64, error)
Cleanup deletes all expired sessions and returns the number of rows removed. Schedule this periodically (e.g. every hour) to keep the table small.
func (*PGSessionStore) Create ¶
func (s *PGSessionStore) Create(ctx context.Context, actor admin.Actor, ttl time.Duration) (Session, error)
Create inserts a new session for actor with the given TTL and returns it.
func (*PGSessionStore) Delete ¶
func (s *PGSessionStore) Delete(ctx context.Context, id string) error
Delete removes a session. It is not an error if the session does not exist.
type PasswordConfig ¶
type PasswordConfig struct {
Memory uint32
Iterations uint32
Parallelism uint8
SaltLength uint32
KeyLength uint32
}
func DefaultPasswordConfig ¶
func DefaultPasswordConfig() PasswordConfig
type RateLimiter ¶
type RateLimiter struct {
// contains filtered or unexported fields
}
func NewRateLimiter ¶
func NewRateLimiter(limit int, window time.Duration) *RateLimiter
func (*RateLimiter) Allow ¶
func (l *RateLimiter) Allow(key string) bool
func (*RateLimiter) Middleware ¶
func (l *RateLimiter) Middleware(next http.Handler) http.Handler
type SessionManager ¶
type SessionManager struct {
Store SessionStore
CookieName string
TTL time.Duration
Secure bool
SameSite http.SameSite
}
func NewSessionManager ¶
func NewSessionManager(store SessionStore) *SessionManager
func (*SessionManager) End ¶
func (m *SessionManager) End(ctx context.Context, w http.ResponseWriter, r *http.Request) error
func (*SessionManager) Middleware ¶
func (m *SessionManager) Middleware(next http.Handler) http.Handler
Source Files
Click to show internal directories.
Click to hide internal directories.