auth

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 25, 2026 License: MIT Imports: 23 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	AccessLevelRead  = "read"
	AccessLevelWrite = "write"
	AccessLevelAdmin = "admin"
)

Variables

View Source 
var (
	ErrUserNotFound     = errors.New("user not found")
	ErrUserExists       = errors.New("user already exists")
	ErrInvalidPassword  = errors.New("invalid password")
	ErrAPIKeyNotFound   = errors.New("api key not found")
	ErrAPIKeyExpired    = errors.New("api key has expired")
	ErrAPIKeyInactive   = errors.New("api key is inactive")
	ErrSessionNotFound  = errors.New("session not found")
	ErrSessionExpired   = errors.New("session has expired")
	ErrSessionRevoked   = errors.New("session has been revoked")
	ErrInvalidRole      = errors.New("invalid role")
	ErrUserInactive     = errors.New("user account is inactive")
	ErrCannotDeleteSelf = errors.New("cannot delete your own account")
)

Functions

func GenerateAPIKey added in v0.1.5 

func GenerateAPIKey() (plainKey string, keyHash string, keyID string, prefix string, err error)

func GenerateSessionID added in v0.1.5 

func GenerateSessionID() (string, error)

func GenerateUID added in v0.1.5 

func GenerateUID() (string, error)

func HasPermission added in v0.1.5 

func HasPermission(role Role, explicitPerms []string, required Permission) bool

func HashAPIKey added in v0.1.5 

func HashAPIKey(key string) string

func HashPassword added in v0.1.5 

func HashPassword(password string) (string, error)

func ParsePermissionsJSON added in v0.1.5 

func ParsePermissionsJSON(s string) []string

func ValidAccessLevel added in v0.1.5 

func ValidAccessLevel(level string) bool

func VerifyPassword added in v0.1.5 

func VerifyPassword(password, hash string) bool

Types

type APIKey added in v0.1.5 

type APIKey struct {
	ID          int64            `json:"id"`
	KeyID       string           `json:"key_id"`
	UserID      int64            `json:"user_id"`
	Name        string           `json:"name"`
	Description string           `json:"description,omitempty"`
	KeyHash     string           `json:"-"`
	KeyPrefix   string           `json:"key_prefix"`
	Role        Role             `json:"role,omitempty"`
	Permissions []string         `json:"permissions,omitempty"`
	Deployments DeploymentAccess `json:"deployments,omitempty"`
	ExpiresAt   time.Time        `json:"expires_at,omitempty"`
	LastUsedAt  time.Time        `json:"last_used_at,omitempty"`
	LastUsedIP  string           `json:"last_used_ip,omitempty"`
	IsActive    bool             `json:"is_active"`
	CreatedAt   time.Time        `json:"created_at"`
}

func (*APIKey) GetDeploymentsJSON added in v0.1.5 

func (a *APIKey) GetDeploymentsJSON() string

func (*APIKey) GetPermissionsJSON added in v0.1.5 

func (a *APIKey) GetPermissionsJSON() string

type ActorContext added in v0.1.5 

type ActorContext struct {
	Type        string            `json:"type"`
	UserID      int64             `json:"user_id,omitempty"`
	User        *User             `json:"user,omitempty"`
	APIKey      *APIKey           `json:"api_key,omitempty"`
	Role        Role              `json:"role"`
	Permissions []string          `json:"permissions,omitempty"`
	Deployments map[string]string `json:"deployments,omitempty"`
}

func GetActorFromContext added in v0.1.5 

func GetActorFromContext(c *gin.Context) *ActorContext

func (*ActorContext) CanAccessDeployment added in v0.1.5 

func (a *ActorContext) CanAccessDeployment(name string, requiredLevel string) bool

func (*ActorContext) HasPermission added in v0.1.5 

func (a *ActorContext) HasPermission(p Permission) bool

type Claims 

type Claims struct {
	Username  string `json:"username"`
	UserID    int64  `json:"user_id,omitempty"`
	SessionID string `json:"session_id,omitempty"`
	jwt.RegisteredClaims
}

type DB added in v0.1.5 

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

func NewAuthDB added in v0.1.5 

func NewAuthDB(deploymentsPath string) (*DB, error)

func (*DB) CleanupExpiredSessions added in v0.1.5 

func (db *DB) CleanupExpiredSessions() (int64, error)

func (*DB) Close added in v0.1.5 

func (db *DB) Close() error

func (*DB) CountUsers added in v0.1.5 

func (db *DB) CountUsers() (int, error)

func (*DB) CreateAPIKey added in v0.1.5 

func (db *DB) CreateAPIKey(key *APIKey) (int64, error)

func (*DB) CreateSession added in v0.1.5 

func (db *DB) CreateSession(session *Session) (int64, error)

func (*DB) CreateUser added in v0.1.5 

func (db *DB) CreateUser(user *User) (int64, error)

func (*DB) CreateUserDeployment added in v0.1.5 

func (db *DB) CreateUserDeployment(ud *UserDeployment) (int64, error)

func (*DB) DeactivateAPIKey added in v0.1.5 

func (db *DB) DeactivateAPIKey(id int64) error

func (*DB) DeleteAPIKey added in v0.1.5 

func (db *DB) DeleteAPIKey(id int64) error

func (*DB) DeleteAllUserDeployments added in v0.1.5 

func (db *DB) DeleteAllUserDeployments(userID int64) error

func (*DB) DeleteUser added in v0.1.5 

func (db *DB) DeleteUser(id int64) error

func (*DB) DeleteUserDeployment added in v0.1.5 

func (db *DB) DeleteUserDeployment(userID int64, deploymentName string) error

func (*DB) GetAPIKeyByHash added in v0.1.5 

func (db *DB) GetAPIKeyByHash(hash string) (*APIKey, error)

func (*DB) GetAPIKeyByID added in v0.1.5 

func (db *DB) GetAPIKeyByID(id int64) (*APIKey, error)

func (*DB) GetAPIKeysByUserID added in v0.1.5 

func (db *DB) GetAPIKeysByUserID(userID int64) ([]APIKey, error)

func (*DB) GetAllAPIKeys added in v0.1.5 

func (db *DB) GetAllAPIKeys() ([]APIKey, error)

func (*DB) GetDeploymentUsers added in v0.1.5 

func (db *DB) GetDeploymentUsers(deploymentName string) ([]UserDeployment, error)

func (*DB) GetSessionByID added in v0.1.5 

func (db *DB) GetSessionByID(sessionID string) (*Session, error)

func (*DB) GetSessionByTokenHash added in v0.1.5 

func (db *DB) GetSessionByTokenHash(hash string) (*Session, error)

func (*DB) GetUserByID added in v0.1.5 

func (db *DB) GetUserByID(id int64) (*User, error)

func (*DB) GetUserByUID added in v0.1.5 

func (db *DB) GetUserByUID(uid string) (*User, error)

func (*DB) GetUserByUsername added in v0.1.5 

func (db *DB) GetUserByUsername(username string) (*User, error)

func (*DB) GetUserDeployments added in v0.1.5 

func (db *DB) GetUserDeployments(userID int64) ([]UserDeployment, error)

func (*DB) GetUserDeploymentsMap added in v0.1.5 

func (db *DB) GetUserDeploymentsMap(userID int64) (map[string]string, error)

func (*DB) GetUsers added in v0.1.5 

func (db *DB) GetUsers() ([]User, error)

func (*DB) RevokeSession added in v0.1.5 

func (db *DB) RevokeSession(sessionID string) error

func (*DB) RevokeUserSessions added in v0.1.5 

func (db *DB) RevokeUserSessions(userID int64) error

func (*DB) UpdateAPIKey added in v0.2.0 

func (db *DB) UpdateAPIKey(key *APIKey) error

func (*DB) UpdateAPIKeyLastUsed added in v0.1.5 

func (db *DB) UpdateAPIKeyLastUsed(id int64, ip string) error

func (*DB) UpdateUser added in v0.1.5 

func (db *DB) UpdateUser(user *User) error

func (*DB) UpdateUserDeployment added in v0.1.5 

func (db *DB) UpdateUserDeployment(userID int64, deploymentName, accessLevel string) error

func (*DB) UpdateUserLastLogin added in v0.1.5 

func (db *DB) UpdateUserLastLogin(id int64) error

func (*DB) UpdateUserPassword added in v0.1.5 

func (db *DB) UpdateUserPassword(id int64, passwordHash string) error

type DeploymentAccess added in v0.2.0 

type DeploymentAccess map[string]string

func ParseDeploymentsJSON added in v0.1.5 

func ParseDeploymentsJSON(s string) DeploymentAccess

func (*DeploymentAccess) UnmarshalJSON added in v0.2.0 

func (d *DeploymentAccess) UnmarshalJSON(data []byte) error

type Manager added in v0.1.5 

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

func NewManager added in v0.1.5 

func NewManager(deploymentsPath string, cfg *config.AuthConfig, setupComplete bool) (*Manager, error)

func (*Manager) AssignDeployment added in v0.1.5 

func (m *Manager) AssignDeployment(userID int64, deploymentName, accessLevel string, grantedBy int64) error

func (*Manager) BuildActorContext added in v0.1.5 

func (m *Manager) BuildActorContext(user *User, apiKey *APIKey) (*ActorContext, error)

func (*Manager) CleanupExpiredSessions added in v0.1.5 

func (m *Manager) CleanupExpiredSessions() (int64, error)

func (*Manager) Close added in v0.1.5 

func (m *Manager) Close() error

func (*Manager) CreateAPIKey added in v0.1.5 

func (m *Manager) CreateAPIKey(userID int64, name, description string, role Role, permissions []string, deployments DeploymentAccess, expiresAt time.Time) (*APIKey, string, error)

func (*Manager) CreateAPIKeyFromRaw added in v0.1.5 

func (m *Manager) CreateAPIKeyFromRaw(rawKey string, userID int64, name, description string, role Role, permissions []string, deployments DeploymentAccess, expiresAt time.Time) (*APIKey, error)

func (*Manager) CreateSession added in v0.1.5 

func (m *Manager) CreateSession(userID int64, apiKeyID int64, sessionID, tokenHash, clientIP string, expiresAt time.Time) (*Session, error)

func (*Manager) CreateUser added in v0.1.5 

func (m *Manager) CreateUser(username, email, password string, role Role, permissions []string) (*User, error)

func (*Manager) DeactivateAPIKey added in v0.1.5 

func (m *Manager) DeactivateAPIKey(id int64) error

func (*Manager) DeleteAPIKey added in v0.1.5 

func (m *Manager) DeleteAPIKey(id int64) error

func (*Manager) DeleteUser added in v0.1.5 

func (m *Manager) DeleteUser(id int64, actorID int64) error

func (*Manager) GetAPIKey added in v0.1.5 

func (m *Manager) GetAPIKey(id int64) (*APIKey, error)

func (*Manager) GetAPIKeysByUser added in v0.1.5 

func (m *Manager) GetAPIKeysByUser(userID int64) ([]APIKey, error)

func (*Manager) GetAllAPIKeys added in v0.1.5 

func (m *Manager) GetAllAPIKeys() ([]APIKey, error)

func (*Manager) GetDeploymentUsers added in v0.1.5 

func (m *Manager) GetDeploymentUsers(deploymentName string) ([]UserDeployment, error)

func (*Manager) GetLegacyKeyIndex added in v0.1.5 

func (m *Manager) GetLegacyKeyIndex(key string) int

func (*Manager) GetSessionByID added in v0.1.5 

func (m *Manager) GetSessionByID(sessionID string) (*Session, error)

func (*Manager) GetSessionByToken added in v0.1.5 

func (m *Manager) GetSessionByToken(tokenHash string) (*Session, error)

func (*Manager) GetUser added in v0.1.5 

func (m *Manager) GetUser(id int64) (*User, error)

func (*Manager) GetUserByUID added in v0.1.5 

func (m *Manager) GetUserByUID(uid string) (*User, error)

func (*Manager) GetUserByUsername added in v0.1.5 

func (m *Manager) GetUserByUsername(username string) (*User, error)

func (*Manager) GetUserDeployments added in v0.1.5 

func (m *Manager) GetUserDeployments(userID int64) ([]UserDeployment, error)

func (*Manager) GetUserDeploymentsMap added in v0.1.5 

func (m *Manager) GetUserDeploymentsMap(userID int64) (map[string]string, error)

func (*Manager) GetUsers added in v0.1.5 

func (m *Manager) GetUsers() ([]User, error)

func (*Manager) RemoveDeploymentAccess added in v0.1.5 

func (m *Manager) RemoveDeploymentAccess(userID int64, deploymentName string) error

func (*Manager) RevokeSession added in v0.1.5 

func (m *Manager) RevokeSession(sessionID string) error

func (*Manager) RevokeUserSessions added in v0.1.5 

func (m *Manager) RevokeUserSessions(userID int64) error

func (*Manager) UpdateAPIKey added in v0.2.0 

func (m *Manager) UpdateAPIKey(id int64, name, description string, role Role, permissions []string, deployments DeploymentAccess, expiresAt time.Time) (*APIKey, error)

func (*Manager) UpdateAPIKeyLastUsed added in v0.1.5 

func (m *Manager) UpdateAPIKeyLastUsed(keyID int64, ip string) error

func (*Manager) UpdatePassword added in v0.1.5 

func (m *Manager) UpdatePassword(userID int64, newPassword string) error

func (*Manager) UpdateUser added in v0.1.5 

func (m *Manager) UpdateUser(user *User) error

func (*Manager) UpdateUserDeployment added in v0.1.5 

func (m *Manager) UpdateUserDeployment(userID int64, deploymentName, accessLevel string) error

func (*Manager) ValidateAPIKey added in v0.1.5 

func (m *Manager) ValidateAPIKey(plainKey string) (*APIKey, *User, error)

func (*Manager) ValidateCredentials added in v0.1.5 

func (m *Manager) ValidateCredentials(username, password string) (*User, error)

func (*Manager) ValidateLegacyAPIKey added in v0.1.5 

func (m *Manager) ValidateLegacyAPIKey(key string) bool

type Middleware 

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

func NewMiddleware 

func NewMiddleware(cfg *config.AuthConfig) *Middleware

func NewMiddlewareWithManager added in v0.1.5 

func NewMiddlewareWithManager(cfg *config.AuthConfig, manager *Manager) *Middleware

func (*Middleware) ActorForTokenString added in v0.2.0 

func (m *Middleware) ActorForTokenString(token string, clientIP string) (*ActorContext, error)

func (*Middleware) GenerateJWT 

func (m *Middleware) GenerateJWT(username string) (string, error)

func (*Middleware) GenerateJWTForUser added in v0.1.5 

func (m *Middleware) GenerateJWTForUser(user *User, sessionID string) (string, error)

func (*Middleware) GetAuthStatus 

func (m *Middleware) GetAuthStatus(c *gin.Context)

func (*Middleware) IsAuthEnabled added in v0.1.5 

func (m *Middleware) IsAuthEnabled() bool

func (*Middleware) Login 

func (m *Middleware) Login(c *gin.Context)

func (*Middleware) RequireAuth 

func (m *Middleware) RequireAuth() gin.HandlerFunc

func (*Middleware) RequireDeploymentAccess added in v0.1.5 

func (m *Middleware) RequireDeploymentAccess(level string) gin.HandlerFunc

func (*Middleware) RequirePermission added in v0.1.5 

func (m *Middleware) RequirePermission(perms ...Permission) gin.HandlerFunc

func (*Middleware) SetManager added in v0.1.5 

func (m *Middleware) SetManager(manager *Manager)

func (*Middleware) ValidateToken 

func (m *Middleware) ValidateToken(c *gin.Context)

func (*Middleware) ValidateTokenString added in v0.1.5 

func (m *Middleware) ValidateTokenString(token string) bool

type Permission added in v0.1.5 

type Permission string
const (
	PermDeploymentsRead   Permission = "deployments:read"
	PermDeploymentsWrite  Permission = "deployments:write"
	PermDeploymentsDelete Permission = "deployments:delete"

	PermCertificatesRead   Permission = "certificates:read"
	PermCertificatesWrite  Permission = "certificates:write"
	PermCertificatesDelete Permission = "certificates:delete"

	PermNetworksRead   Permission = "networks:read"
	PermNetworksWrite  Permission = "networks:write"
	PermNetworksDelete Permission = "networks:delete"

	PermSecurityRead  Permission = "security:read"
	PermSecurityWrite Permission = "security:write"

	PermBackupsRead   Permission = "backups:read"
	PermBackupsWrite  Permission = "backups:write"
	PermBackupsDelete Permission = "backups:delete"

	PermUsersRead   Permission = "users:read"
	PermUsersWrite  Permission = "users:write"
	PermUsersDelete Permission = "users:delete"

	PermAPIKeysRead   Permission = "apikeys:read"
	PermAPIKeysWrite  Permission = "apikeys:write"
	PermAPIKeysDelete Permission = "apikeys:delete"

	PermSettingsRead  Permission = "settings:read"
	PermSettingsWrite Permission = "settings:write"

	PermAuditRead Permission = "audit:read"

	PermContainersRead   Permission = "containers:read"
	PermContainersWrite  Permission = "containers:write"
	PermContainersDelete Permission = "containers:delete"

	PermImagesRead   Permission = "images:read"
	PermImagesWrite  Permission = "images:write"
	PermImagesDelete Permission = "images:delete"

	PermVolumesRead   Permission = "volumes:read"
	PermVolumesWrite  Permission = "volumes:write"
	PermVolumesDelete Permission = "volumes:delete"

	PermDatabasesRead   Permission = "databases:read"
	PermDatabasesWrite  Permission = "databases:write"
	PermDatabasesDelete Permission = "databases:delete"

	PermInfrastructureRead  Permission = "infrastructure:read"
	PermInfrastructureWrite Permission = "infrastructure:write"

	PermSchedulerRead   Permission = "scheduler:read"
	PermSchedulerWrite  Permission = "scheduler:write"
	PermSchedulerDelete Permission = "scheduler:delete"

	PermSystemRead  Permission = "system:read"
	PermSystemWrite Permission = "system:write"
	PermSystemFiles Permission = "system:files"

	PermDNSRead  Permission = "dns:read"
	PermDNSWrite Permission = "dns:write"

	PermRegistriesRead   Permission = "registries:read"
	PermRegistriesWrite  Permission = "registries:write"
	PermRegistriesDelete Permission = "registries:delete"

	PermTemplatesRead  Permission = "templates:read"
	PermTemplatesWrite Permission = "templates:write"

	PermTrafficRead  Permission = "traffic:read"
	PermTrafficWrite Permission = "traffic:write"

	PermClusterRead  Permission = "cluster:read"
	PermClusterWrite Permission = "cluster:write"
)

func EffectivePermissions added in v0.1.5 

func EffectivePermissions(user *User, role Role) []Permission

func GetAllPermissions added in v0.1.5 

func GetAllPermissions() []Permission

func GetRolePermissions added in v0.1.5 

func GetRolePermissions(role Role) []Permission

func (Permission) String added in v0.1.5 

func (p Permission) String() string

type Role added in v0.1.5 

type Role string
const (
	RoleAdmin    Role = "admin"
	RoleOperator Role = "operator"
	RoleViewer   Role = "viewer"
)

func (Role) IsValid added in v0.1.5 

func (r Role) IsValid() bool

type Session added in v0.1.5 

type Session struct {
	ID        int64     `json:"id"`
	SessionID string    `json:"session_id"`
	UserID    int64     `json:"user_id"`
	APIKeyID  int64     `json:"api_key_id,omitempty"`
	TokenHash string    `json:"-"`
	ExpiresAt time.Time `json:"expires_at"`
	RevokedAt time.Time `json:"revoked_at,omitempty"`
	CreatedAt time.Time `json:"created_at"`
	ClientIP  string    `json:"client_ip,omitempty"`
}

type User added in v0.1.5 

type User struct {
	ID           int64     `json:"id"`
	UID          string    `json:"uid"`
	Username     string    `json:"username"`
	Email        string    `json:"email,omitempty"`
	PasswordHash string    `json:"-"`
	Role         Role      `json:"role"`
	Permissions  []string  `json:"permissions,omitempty"`
	IsActive     bool      `json:"is_active"`
	CreatedAt    time.Time `json:"created_at"`
	UpdatedAt    time.Time `json:"updated_at"`
	LastLoginAt  time.Time `json:"last_login_at,omitempty"`
}

func (*User) GetPermissionsJSON added in v0.1.5 

func (u *User) GetPermissionsJSON() string

type UserDeployment added in v0.1.5 

type UserDeployment struct {
	ID             int64     `json:"id"`
	UserID         int64     `json:"user_id"`
	DeploymentName string    `json:"deployment_name"`
	AccessLevel    string    `json:"access_level"`
	GrantedBy      int64     `json:"granted_by,omitempty"`
	CreatedAt      time.Time `json:"created_at"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.