user

package module
v0.0.29 Latest Latest
Warning

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

 Go to latest Published: Jun 27, 2026 License: MIT Imports: 22 Imported by: 0

README

tinywasm/user

User management library for the tinywasm ecosystem. Handles user entities, password authentication, OAuth providers (Google, Microsoft), LAN (local network) authentication by RUT + IP, and session management. Applications import tinywasm/user directly to configure session behaviour, and use its isomorphic UI modules for authentication workflows.

Documentation

Note: RBAC is now integrated into the User module (see ARCHITECTURE.md).

Diagrams

Initialization

import "github.com/tinywasm/user"

// ...

// Initialize the user module directly with an ORM db instance
err := user.Init(db, user.Config{
    CookieName: "session_id", // default: "session"
    TokenTTL:   86400,        // default: 86400 (24h)
    TrustProxy: true,         // default: false
    OAuthProviders: []user.OAuthProvider{
        &user.GoogleProvider{
            ClientID:     os.Getenv("GOOGLE_CLIENT_ID"),
            ClientSecret: os.Getenv("GOOGLE_CLIENT_SECRET"),
            RedirectURL:  "https://example.com/oauth/callback",
        },
    },
})
if err != nil {
    // handle error
}

For detailed API usage and module integration guidance, refer to docs/SKILL.md.

Status

Implementation pending. Documentation complete.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidCredentials = fmt.Err("access", "denied")             // EN: Access Denied                    / ES: Acceso Denegado
	ErrSuspended          = fmt.Err("user", "suspended")            // EN: User Suspended                   / ES: Usuario Suspendido
	ErrEmailTaken         = fmt.Err("email", "registered")          // EN: Email Registered                 / ES: Correo electrónico Registrado
	ErrWeakPassword       = fmt.Err("password", "weak")             // EN: Password Weak                    / ES: Contraseña Débil
	ErrSessionExpired     = fmt.Err("token", "expired")             // EN: Token Expired                    / ES: Token Expirado
	ErrNotFound           = fmt.Err("user", "not", "found")         // EN: User Not Found                   / ES: Usuario No Encontrado
	ErrProviderNotFound   = fmt.Err("provider", "not", "found")     // EN: Provider Not Found               / ES: Proveedor No Encontrado
	ErrInvalidOAuthState  = fmt.Err("state", "invalid")             // EN: State Invalid                    / ES: Estado Inválido
	ErrCannotUnlink       = fmt.Err("identity", "cannot", "unlink") // EN: Identity Cannot Unlink           / ES: Identidad No puede Desvincular
	ErrInvalidRUT         = fmt.Err("rut", "invalid")               // EN: Rut Invalid                      / ES: Rut Inválido
	ErrRUTTaken           = fmt.Err("rut", "registered")            // EN: Rut Registered                   / ES: Rut Registrado
	ErrIPTaken            = fmt.Err("ip", "registered")             // EN: Ip Registered                    / ES: Ip Registrado
)
View Source 
var ErrInvalidToken = fmt.Err("token", "invalid")
View Source 
var Identity_ = struct {
	ID         string
	UserID     string
	Provider   string
	ProviderID string
	Email      string
	CreatedAt  string
}{
	ID:         "id",
	UserID:     "user_id",
	Provider:   "provider",
	ProviderID: "provider_id",
	Email:      "email",
	CreatedAt:  "created_at",
}
View Source 
var LANIP_ = struct {
	ID        string
	UserID    string
	IP        string
	Label     string
	CreatedAt string
}{
	ID:        "id",
	UserID:    "user_id",
	IP:        "ip",
	Label:     "label",
	CreatedAt: "created_at",
}
View Source 
var OAuthState_ = struct {
	State     string
	Provider  string
	ExpiresAt string
	CreatedAt string
}{
	State:     "state",
	Provider:  "provider",
	ExpiresAt: "expires_at",
	CreatedAt: "created_at",
}
View Source 
var PasswordHashCost = bcrypt.DefaultCost
View Source 
var Permission_ = struct {
	ID       string
	Name     string
	Resource string
	Action   string
}{
	ID:       "id",
	Name:     "name",
	Resource: "resource",
	Action:   "action",
}
View Source 
var RolePermission_ = struct {
	RoleID       string
	PermissionID string
}{
	RoleID:       "role_id",
	PermissionID: "permission_id",
}
View Source 
var Role_ = struct {
	ID          string
	Code        string
	Name        string
	Description string
}{
	ID:          "id",
	Code:        "code",
	Name:        "name",
	Description: "description",
}
View Source 
var Session_ = struct {
	ID        string
	UserID    string
	ExpiresAt string
	IP        string
	UserAgent string
	CreatedAt string
}{
	ID:        "id",
	UserID:    "user_id",
	ExpiresAt: "expires_at",
	IP:        "ip",
	UserAgent: "user_agent",
	CreatedAt: "created_at",
}
View Source 
var UserRole_ = struct {
	UserID string
	RoleID string
}{
	UserID: "user_id",
	RoleID: "role_id",
}
View Source 
var User_ = struct {
	ID        string
	Email     string
	Name      string
	Phone     string
	Status    string
	CreatedAt string
}{
	ID:        "id",
	Email:     "email",
	Name:      "name",
	Phone:     "phone",
	Status:    "status",
	CreatedAt: "created_at",
}

Functions

func GenerateJWT added in v0.0.17 

func GenerateJWT(secret []byte, userID string, ttl int) (string, error)

func UIModules added in v0.0.15 

func UIModules() []any

UIModules returns all standard authentication UI flow handlers. Isomorphic: available in both WASM and non-WASM builds.

func ValidateJWT added in v0.0.17 

func ValidateJWT(secret []byte, token string) (string, error)

Types

type AuthMode added in v0.0.17 

type AuthMode uint8

AuthMode selects the session strategy. 

const (
	// AuthModeCookie stores a session ID in an HttpOnly cookie.
	// Stateful: requires user_sessions table. Supports immediate revocation.
	AuthModeCookie AuthMode = iota // default

	// AuthModeJWT stores a signed JWT in an HttpOnly cookie.
	// Stateless: no DB lookup per request. No immediate revocation.
	// Ideal for SPA/PWA and multi-server deployments.
	AuthModeJWT

	// AuthModeBearer reads a signed JWT from the "Authorization: Bearer <token>" header.
	// Stateless: for API clients (MCP servers, IDEs, LLMs) that cannot use cookies.
	// Structurally implements mcp.Authorizer via InjectIdentity + CanExecute methods.
	// Requires JWTSecret.
	AuthModeBearer
)

type Config added in v0.0.2 

type Config struct {
	AuthMode AuthMode // default: AuthModeCookie

	// Shared by all modes
	CookieName string // default: "session"
	TokenTTL   int    // default: 86400 (seconds). Session TTL in cookie mode, JWT expiry in JWT mode.

	// Required when AuthMode == AuthModeJWT or AuthMode == AuthModeBearer.
	// Also required to call GenerateAPIToken regardless of AuthMode.
	JWTSecret []byte

	TrustProxy     bool
	OAuthProviders []OAuthProvider

	// Optional hook for receiving security events (e.g. tampering, brute force)
	OnSecurityEvent func(SecurityEvent)

	// OnPasswordValidate is called by SetPassword before hashing.
	// Return a non-nil error to reject the password.
	// If nil, only the built-in len >= 8 check applies.
	OnPasswordValidate func(password string) error
}

type Executor added in v0.0.2 

type Executor interface {
	Exec(query string, args ...any) error
	Query(query string, args ...any) (Rows, error)
	QueryRow(query string, args ...any) Scanner
	Prepare(query string) (*sql.Stmt, error)
	Begin() (*sql.Tx, error)
}

Executor interface abstracts database operations.

type GoogleProvider added in v0.0.2 

type GoogleProvider struct {
	ClientID     string
	ClientSecret string
	RedirectURL  string
	// contains filtered or unexported fields
}

func (*GoogleProvider) AuthCodeURL added in v0.0.2 

func (p *GoogleProvider) AuthCodeURL(state string) string

func (*GoogleProvider) ExchangeCode added in v0.0.2 

func (p *GoogleProvider) ExchangeCode(ctx context.Context, code string) (*oauth2.Token, error)

func (*GoogleProvider) GetUserInfo added in v0.0.2 

func (p *GoogleProvider) GetUserInfo(ctx context.Context, token *oauth2.Token) (OAuthUserInfo, error)

func (*GoogleProvider) Name added in v0.0.2 

func (p *GoogleProvider) Name() string

type Identity added in v0.0.2 

type Identity struct {
	ID         string `db:"pk"`
	UserID     string `db:"ref=users"`
	Provider   string
	ProviderID string
	Email      string
	CreatedAt  int64
}

orm:typed_fields

func ReadOneIdentity added in v0.0.6 

func ReadOneIdentity(qb *orm.QB, model *Identity) (*Identity, error)

func (*Identity) DecodeFields added in v0.0.29 

func (m *Identity) DecodeFields(r fmt.FieldReader)

func (*Identity) EncodeFields added in v0.0.29 

func (m *Identity) EncodeFields(w fmt.FieldWriter)

func (*Identity) IsNil added in v0.0.29 

func (m *Identity) IsNil() bool

func (*Identity) ModelName added in v0.0.29 

func (m *Identity) ModelName() string

func (*Identity) Pointers added in v0.0.6 

func (m *Identity) Pointers() []any

func (*Identity) Schema added in v0.0.6 

func (m *Identity) Schema() []fmt.Field

type IdentityList added in v0.0.29 

type IdentityList []*Identity

func ReadAllIdentity added in v0.0.6 

func ReadAllIdentity(qb *orm.QB) (IdentityList, error)

func (*IdentityList) Append added in v0.0.29 

func (s *IdentityList) Append() fmt.Fielder

func (*IdentityList) At added in v0.0.29 

func (s *IdentityList) At(i int) fmt.Fielder

func (*IdentityList) DecodeFields added in v0.0.29 

func (s *IdentityList) DecodeFields(_ fmt.FieldReader)

func (*IdentityList) EncodeFields added in v0.0.29 

func (s *IdentityList) EncodeFields(_ fmt.FieldWriter)

func (*IdentityList) IsNil added in v0.0.29 

func (s *IdentityList) IsNil() bool

func (*IdentityList) Len added in v0.0.29 

func (s *IdentityList) Len() int

func (*IdentityList) Pointers added in v0.0.29 

func (s *IdentityList) Pointers() []any

func (*IdentityList) Schema added in v0.0.29 

func (s *IdentityList) Schema() []fmt.Field

type LANIP added in v0.0.2 

type LANIP struct {
	ID        string `db:"pk"`
	UserID    string `db:"ref=users"`
	IP        string
	Label     string
	CreatedAt int64
}

orm:typed_fields

func ReadOneLANIP added in v0.0.6 

func ReadOneLANIP(qb *orm.QB, model *LANIP) (*LANIP, error)

func (*LANIP) DecodeFields added in v0.0.29 

func (m *LANIP) DecodeFields(r fmt.FieldReader)

func (*LANIP) EncodeFields added in v0.0.29 

func (m *LANIP) EncodeFields(w fmt.FieldWriter)

func (*LANIP) IsNil added in v0.0.29 

func (m *LANIP) IsNil() bool

func (*LANIP) ModelName added in v0.0.29 

func (m *LANIP) ModelName() string

func (*LANIP) Pointers added in v0.0.6 

func (m *LANIP) Pointers() []any

func (*LANIP) Schema added in v0.0.6 

func (m *LANIP) Schema() []fmt.Field

type LANIPList added in v0.0.29 

type LANIPList []*LANIP

func ReadAllLANIP added in v0.0.6 

func ReadAllLANIP(qb *orm.QB) (LANIPList, error)

func (*LANIPList) Append added in v0.0.29 

func (s *LANIPList) Append() fmt.Fielder

func (*LANIPList) At added in v0.0.29 

func (s *LANIPList) At(i int) fmt.Fielder

func (*LANIPList) DecodeFields added in v0.0.29 

func (s *LANIPList) DecodeFields(_ fmt.FieldReader)

func (*LANIPList) EncodeFields added in v0.0.29 

func (s *LANIPList) EncodeFields(_ fmt.FieldWriter)

func (*LANIPList) IsNil added in v0.0.29 

func (s *LANIPList) IsNil() bool

func (*LANIPList) Len added in v0.0.29 

func (s *LANIPList) Len() int

func (*LANIPList) Pointers added in v0.0.29 

func (s *LANIPList) Pointers() []any

func (*LANIPList) Schema added in v0.0.29 

func (s *LANIPList) Schema() []fmt.Field

type LoginData added in v0.0.2 

type LoginData struct {
	Email    string
	Password string
}

LoginData is validated by LoginModule on both frontend and backend.

func (*LoginData) DecodeFields added in v0.0.29 

func (m *LoginData) DecodeFields(r fmt.FieldReader)

func (*LoginData) EncodeFields added in v0.0.29 

func (m *LoginData) EncodeFields(w fmt.FieldWriter)

func (*LoginData) IsNil added in v0.0.29 

func (m *LoginData) IsNil() bool

func (*LoginData) ModelName added in v0.0.29 

func (m *LoginData) ModelName() string

func (*LoginData) Pointers added in v0.0.28 

func (m *LoginData) Pointers() []any

func (*LoginData) Schema added in v0.0.28 

func (m *LoginData) Schema() []fmt.Field

type LoginDataList added in v0.0.29 

type LoginDataList []*LoginData

func (*LoginDataList) Append added in v0.0.29 

func (s *LoginDataList) Append() fmt.Fielder

func (*LoginDataList) At added in v0.0.29 

func (s *LoginDataList) At(i int) fmt.Fielder

func (*LoginDataList) DecodeFields added in v0.0.29 

func (s *LoginDataList) DecodeFields(_ fmt.FieldReader)

func (*LoginDataList) EncodeFields added in v0.0.29 

func (s *LoginDataList) EncodeFields(_ fmt.FieldWriter)

func (*LoginDataList) IsNil added in v0.0.29 

func (s *LoginDataList) IsNil() bool

func (*LoginDataList) Len added in v0.0.29 

func (s *LoginDataList) Len() int

func (*LoginDataList) Pointers added in v0.0.29 

func (s *LoginDataList) Pointers() []any

func (*LoginDataList) Schema added in v0.0.29 

func (s *LoginDataList) Schema() []fmt.Field

type MicrosoftProvider added in v0.0.2 

type MicrosoftProvider struct {
	ClientID     string
	ClientSecret string
	RedirectURL  string
	// contains filtered or unexported fields
}

func (*MicrosoftProvider) AuthCodeURL added in v0.0.2 

func (p *MicrosoftProvider) AuthCodeURL(state string) string

func (*MicrosoftProvider) ExchangeCode added in v0.0.2 

func (p *MicrosoftProvider) ExchangeCode(ctx context.Context, code string) (*oauth2.Token, error)

func (*MicrosoftProvider) GetUserInfo added in v0.0.2 

func (p *MicrosoftProvider) GetUserInfo(ctx context.Context, token *oauth2.Token) (OAuthUserInfo, error)

func (*MicrosoftProvider) Name added in v0.0.2 

func (p *MicrosoftProvider) Name() string

type Module added in v0.0.15 

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

Module is the user/auth/rbac handle. All backend operations are methods on this type. Created exclusively via New().

func New 

func New(db *orm.DB, cfg Config) (*Module, error)

New initializes the user/rbac schema, warms the cache, and returns a Module handle. This is the ONLY entry point for this package on the backend.

func (*Module) AccessCheck added in v0.0.15 

func (m *Module) AccessCheck(resource string, action byte, data ...any) bool

AccessCheck is the bridge function for tinywasm/crudp and tinywasm/site. Reads the *http.Request from data, validates the session, and checks RBAC permissions. Satisfies the site.SetAccessCheck(fn) signature directly.

Usage: site.SetAccessCheck(m.AccessCheck)

func (*Module) Add added in v0.0.15 

func (m *Module) Add() []any

Add returns all admin-managed CRUDP handlers for registration. The concrete types are private — pass directly to crudp.RegisterHandlers.

Usage: cp.RegisterHandlers(m.Add()...)

func (*Module) AssignLANIP added in v0.0.15 

func (m *Module) AssignLANIP(userID, ip, label string) error

func (*Module) AssignPermission added in v0.0.15 

func (m *Module) AssignPermission(roleID, permissionID string) error

func (*Module) AssignRole added in v0.0.15 

func (m *Module) AssignRole(userID, roleID string) error

func (*Module) BeginOAuth added in v0.0.15 

func (m *Module) BeginOAuth(providerName string) (string, error)

func (*Module) CanExecute added in v0.0.24 

func (m *Module) CanExecute(ctx context.Context, resource string, action byte) bool

CanExecute implements mcp.Authorizer. Reads identity injected by InjectIdentity and checks RBAC.

func (*Module) CompleteOAuth added in v0.0.15 

func (m *Module) CompleteOAuth(providerName string, r *http.Request, ip, ua string) (User, bool, error)

func (*Module) CreatePermission added in v0.0.15 

func (m *Module) CreatePermission(id, name, resource string, action string) error

func (*Module) CreateRole added in v0.0.15 

func (m *Module) CreateRole(id string, code string, name, description string) error

func (*Module) CreateSession added in v0.0.15 

func (m *Module) CreateSession(userID, ip, userAgent string) (Session, error)

func (*Module) DeletePermission added in v0.0.15 

func (m *Module) DeletePermission(id string) error

func (*Module) DeleteRole added in v0.0.15 

func (m *Module) DeleteRole(id string) error

func (*Module) DeleteSession added in v0.0.15 

func (m *Module) DeleteSession(id string) error

func (*Module) FromContext added in v0.0.15 

func (m *Module) FromContext(ctx context.Context) (*User, bool)

FromContext extracts the authenticated *User injected by Middleware or RegisterMCP. Returns (nil, false) if the context carries no authenticated user.

func (*Module) GenerateAPIToken added in v0.0.24 

func (m *Module) GenerateAPIToken(userID string, ttl int) (string, error)

GenerateAPIToken creates a signed JWT for API access (MCP clients, IDEs, LLMs). Requires Config.JWTSecret — independent of the configured AuthMode. ttl=0 → 100 years (effectively no expiry). The returned token is used as a Bearer token in Authorization headers.

func (*Module) GetLANIPs added in v0.0.15 

func (m *Module) GetLANIPs(userID string) ([]LANIP, error)

func (*Module) GetPermission added in v0.0.15 

func (m *Module) GetPermission(id string) (*Permission, error)

func (*Module) GetRole added in v0.0.15 

func (m *Module) GetRole(id string) (*Role, error)

func (*Module) GetRoleByCode added in v0.0.15 

func (m *Module) GetRoleByCode(code string) (*Role, error)

func (*Module) GetSession added in v0.0.15 

func (m *Module) GetSession(id string) (Session, error)

func (*Module) GetUser added in v0.0.15 

func (m *Module) GetUser(id string) (User, error)

func (*Module) GetUserIdentities added in v0.0.15 

func (m *Module) GetUserIdentities(userID string) ([]Identity, error)

func (*Module) GetUserRoles added in v0.0.15 

func (m *Module) GetUserRoles(userID string) ([]Role, error)

func (*Module) HasPermission added in v0.0.15 

func (m *Module) HasPermission(userID, resource string, action byte) (bool, error)

func (*Module) InjectIdentity added in v0.0.24 

func (m *Module) InjectIdentity(ctx context.Context, r *http.Request) context.Context

InjectIdentity implements mcp.Authorizer. Delegates to validateSession (respects configured AuthMode). On failure: returns ctx unchanged — CanExecute will deny.

func (*Module) Login added in v0.0.15 

func (m *Module) Login(email, password string) (User, error)

func (*Module) LoginLAN added in v0.0.15 

func (m *Module) LoginLAN(rut string, r *http.Request) (User, error)

func (*Module) Middleware added in v0.0.15 

func (m *Module) Middleware(next http.Handler) http.Handler

Middleware protects HTTP routes. Validates the session cookie and injects the authenticated *User into the request context. Returns HTTP 401 if the session is missing or expired.

Example: 

mux.Handle("/admin", m.Middleware(adminHandler))

func (*Module) PurgeExpiredOAuthStates added in v0.0.15 

func (m *Module) PurgeExpiredOAuthStates() error

func (*Module) PurgeExpiredSessions added in v0.0.15 

func (m *Module) PurgeExpiredSessions() error

func (*Module) PurgeSessionsByUser added in v0.0.22 

func (m *Module) PurgeSessionsByUser(userID string) error

PurgeSessionsByUser deletes all sessions belonging to userID from cache and DB.

func (*Module) ReactivateUser added in v0.0.22 

func (m *Module) ReactivateUser(id string) error

ReactivateUser sets Status = "active". Evicts user from cache.

func (*Module) Register added in v0.0.15 

func (m *Module) Register(handlers ...RBACObject) error

func (*Module) RegisterLAN added in v0.0.15 

func (m *Module) RegisterLAN(userID, rut string) error

func (*Module) RegisterMCP added in v0.0.15 

func (m *Module) RegisterMCP(next http.Handler) http.Handler

RegisterMCP envuelve el handler MCP con middleware de sesión. Alternativa limpia a registrar hooks en el MCPServer (que no existe en tinywasm/mcp).

Ejemplo: 

mcpHandler := mcp.NewStreamableHTTPServer(srv)
mux.Handle("/mcp", m.RegisterMCP(mcpHandler))

func (*Module) RevokeLANIP added in v0.0.15 

func (m *Module) RevokeLANIP(userID, ip string) error

func (*Module) RevokeRole added in v0.0.15 

func (m *Module) RevokeRole(userID, roleID string) error

func (*Module) RotateSession added in v0.0.22 

func (m *Module) RotateSession(oldID, ip, userAgent string) (Session, error)

RotateSession atomically deletes the old session and creates a new one with the same userID, updated IP/UserAgent, and a fresh TTL. Prevents session fixation attacks when called post-login.

func (*Module) SetLog added in v0.0.15 

func (m *Module) SetLog(fn func(...any))

SetLog configures optional logging. Call immediately after New(). Default: no-op. Follows the tinywasm ecosystem SetLog convention (same as rbac).

Example: 

m.SetLog(func(msg ...any) { log.Println(msg...) })

func (*Module) SetPassword added in v0.0.15 

func (m *Module) SetPassword(userID, password string) error

func (*Module) SuspendUser added in v0.0.22 

func (m *Module) SuspendUser(id string) error

SuspendUser sets Status = "suspended". Evicts user from cache.

func (*Module) UIModules added in v0.0.15 

func (m *Module) UIModules() []any

UIModules returns all standard authentication UI flow handlers bound to this module. Isomorphic: The signature exists in both WASM and backend. On the backend, it links to the DB.

func (*Module) UnlinkIdentity added in v0.0.15 

func (m *Module) UnlinkIdentity(userID, provider string) error

func (*Module) UnregisterLAN added in v0.0.15 

func (m *Module) UnregisterLAN(userID string) error

func (*Module) VerifyPassword added in v0.0.15 

func (m *Module) VerifyPassword(userID, password string) error

type OAuthProvider added in v0.0.2 

type OAuthProvider interface {
	Name() string
	AuthCodeURL(state string) string
	ExchangeCode(ctx context.Context, code string) (*oauth2.Token, error)
	GetUserInfo(ctx context.Context, token *oauth2.Token) (OAuthUserInfo, error)
}

type OAuthState added in v0.0.6 

type OAuthState struct {
	State     string `db:"pk"`
	Provider  string
	ExpiresAt int64
	CreatedAt int64
}

orm:typed_fields

func ReadOneOAuthState added in v0.0.6 

func ReadOneOAuthState(qb *orm.QB, model *OAuthState) (*OAuthState, error)

func (*OAuthState) DecodeFields added in v0.0.29 

func (m *OAuthState) DecodeFields(r fmt.FieldReader)

func (*OAuthState) EncodeFields added in v0.0.29 

func (m *OAuthState) EncodeFields(w fmt.FieldWriter)

func (*OAuthState) IsNil added in v0.0.29 

func (m *OAuthState) IsNil() bool

func (*OAuthState) ModelName added in v0.0.29 

func (m *OAuthState) ModelName() string

func (*OAuthState) Pointers added in v0.0.6 

func (m *OAuthState) Pointers() []any

func (*OAuthState) Schema added in v0.0.6 

func (m *OAuthState) Schema() []fmt.Field

type OAuthStateList added in v0.0.29 

type OAuthStateList []*OAuthState

func ReadAllOAuthState added in v0.0.6 

func ReadAllOAuthState(qb *orm.QB) (OAuthStateList, error)

func (*OAuthStateList) Append added in v0.0.29 

func (s *OAuthStateList) Append() fmt.Fielder

func (*OAuthStateList) At added in v0.0.29 

func (s *OAuthStateList) At(i int) fmt.Fielder

func (*OAuthStateList) DecodeFields added in v0.0.29 

func (s *OAuthStateList) DecodeFields(_ fmt.FieldReader)

func (*OAuthStateList) EncodeFields added in v0.0.29 

func (s *OAuthStateList) EncodeFields(_ fmt.FieldWriter)

func (*OAuthStateList) IsNil added in v0.0.29 

func (s *OAuthStateList) IsNil() bool

func (*OAuthStateList) Len added in v0.0.29 

func (s *OAuthStateList) Len() int

func (*OAuthStateList) Pointers added in v0.0.29 

func (s *OAuthStateList) Pointers() []any

func (*OAuthStateList) Schema added in v0.0.29 

func (s *OAuthStateList) Schema() []fmt.Field

type OAuthUserInfo added in v0.0.2 

type OAuthUserInfo struct {
	ID    string
	Email string
	Name  string
}

type PasswordData added in v0.0.2 

type PasswordData struct {
	Current string
	New     string
	Confirm string
}

PasswordData is validated by ProfileModule (password change sub-form).

func (*PasswordData) DecodeFields added in v0.0.29 

func (m *PasswordData) DecodeFields(r fmt.FieldReader)

func (*PasswordData) EncodeFields added in v0.0.29 

func (m *PasswordData) EncodeFields(w fmt.FieldWriter)

func (*PasswordData) IsNil added in v0.0.29 

func (m *PasswordData) IsNil() bool

func (*PasswordData) ModelName added in v0.0.29 

func (m *PasswordData) ModelName() string

func (*PasswordData) Pointers added in v0.0.28 

func (m *PasswordData) Pointers() []any

func (*PasswordData) Schema added in v0.0.28 

func (m *PasswordData) Schema() []fmt.Field

type PasswordDataList added in v0.0.29 

type PasswordDataList []*PasswordData

func (*PasswordDataList) Append added in v0.0.29 

func (s *PasswordDataList) Append() fmt.Fielder

func (*PasswordDataList) At added in v0.0.29 

func (s *PasswordDataList) At(i int) fmt.Fielder

func (*PasswordDataList) DecodeFields added in v0.0.29 

func (s *PasswordDataList) DecodeFields(_ fmt.FieldReader)

func (*PasswordDataList) EncodeFields added in v0.0.29 

func (s *PasswordDataList) EncodeFields(_ fmt.FieldWriter)

func (*PasswordDataList) IsNil added in v0.0.29 

func (s *PasswordDataList) IsNil() bool

func (*PasswordDataList) Len added in v0.0.29 

func (s *PasswordDataList) Len() int

func (*PasswordDataList) Pointers added in v0.0.29 

func (s *PasswordDataList) Pointers() []any

func (*PasswordDataList) Schema added in v0.0.29 

func (s *PasswordDataList) Schema() []fmt.Field

type Permission added in v0.0.6 

type Permission struct {
	ID       string `db:"pk"`
	Name     string
	Resource string
	Action   string
}

orm:typed_fields

func ReadOnePermission added in v0.0.6 

func ReadOnePermission(qb *orm.QB, model *Permission) (*Permission, error)

func (*Permission) DecodeFields added in v0.0.29 

func (m *Permission) DecodeFields(r fmt.FieldReader)

func (*Permission) EncodeFields added in v0.0.29 

func (m *Permission) EncodeFields(w fmt.FieldWriter)

func (*Permission) IsNil added in v0.0.29 

func (m *Permission) IsNil() bool

func (*Permission) ModelName added in v0.0.29 

func (m *Permission) ModelName() string

func (*Permission) Pointers added in v0.0.6 

func (m *Permission) Pointers() []any

func (*Permission) Schema added in v0.0.6 

func (m *Permission) Schema() []fmt.Field

type PermissionList added in v0.0.29 

type PermissionList []*Permission

func ReadAllPermission added in v0.0.6 

func ReadAllPermission(qb *orm.QB) (PermissionList, error)

func (*PermissionList) Append added in v0.0.29 

func (s *PermissionList) Append() fmt.Fielder

func (*PermissionList) At added in v0.0.29 

func (s *PermissionList) At(i int) fmt.Fielder

func (*PermissionList) DecodeFields added in v0.0.29 

func (s *PermissionList) DecodeFields(_ fmt.FieldReader)

func (*PermissionList) EncodeFields added in v0.0.29 

func (s *PermissionList) EncodeFields(_ fmt.FieldWriter)

func (*PermissionList) IsNil added in v0.0.29 

func (s *PermissionList) IsNil() bool

func (*PermissionList) Len added in v0.0.29 

func (s *PermissionList) Len() int

func (*PermissionList) Pointers added in v0.0.29 

func (s *PermissionList) Pointers() []any

func (*PermissionList) Schema added in v0.0.29 

func (s *PermissionList) Schema() []fmt.Field

type ProfileData added in v0.0.2 

type ProfileData struct {
	Name  string
	Phone string
}

ProfileData is validated by ProfileModule (name/phone update).

func (*ProfileData) DecodeFields added in v0.0.29 

func (m *ProfileData) DecodeFields(r fmt.FieldReader)

func (*ProfileData) EncodeFields added in v0.0.29 

func (m *ProfileData) EncodeFields(w fmt.FieldWriter)

func (*ProfileData) IsNil added in v0.0.29 

func (m *ProfileData) IsNil() bool

func (*ProfileData) ModelName added in v0.0.29 

func (m *ProfileData) ModelName() string

func (*ProfileData) Pointers added in v0.0.28 

func (m *ProfileData) Pointers() []any

func (*ProfileData) Schema added in v0.0.28 

func (m *ProfileData) Schema() []fmt.Field

type ProfileDataList added in v0.0.29 

type ProfileDataList []*ProfileData

func (*ProfileDataList) Append added in v0.0.29 

func (s *ProfileDataList) Append() fmt.Fielder

func (*ProfileDataList) At added in v0.0.29 

func (s *ProfileDataList) At(i int) fmt.Fielder

func (*ProfileDataList) DecodeFields added in v0.0.29 

func (s *ProfileDataList) DecodeFields(_ fmt.FieldReader)

func (*ProfileDataList) EncodeFields added in v0.0.29 

func (s *ProfileDataList) EncodeFields(_ fmt.FieldWriter)

func (*ProfileDataList) IsNil added in v0.0.29 

func (s *ProfileDataList) IsNil() bool

func (*ProfileDataList) Len added in v0.0.29 

func (s *ProfileDataList) Len() int

func (*ProfileDataList) Pointers added in v0.0.29 

func (s *ProfileDataList) Pointers() []any

func (*ProfileDataList) Schema added in v0.0.29 

func (s *ProfileDataList) Schema() []fmt.Field

type RBACObject added in v0.0.6 

type RBACObject interface {
	HandlerName() string
	AllowedRoles(action byte) []byte
}

type RegisterData added in v0.0.2 

type RegisterData struct {
	Name     string
	Email    string
	Password string
	Phone    string
}

RegisterData is validated by RegisterModule.

func (*RegisterData) DecodeFields added in v0.0.29 

func (m *RegisterData) DecodeFields(r fmt.FieldReader)

func (*RegisterData) EncodeFields added in v0.0.29 

func (m *RegisterData) EncodeFields(w fmt.FieldWriter)

func (*RegisterData) IsNil added in v0.0.29 

func (m *RegisterData) IsNil() bool

func (*RegisterData) ModelName added in v0.0.29 

func (m *RegisterData) ModelName() string

func (*RegisterData) Pointers added in v0.0.28 

func (m *RegisterData) Pointers() []any

func (*RegisterData) Schema added in v0.0.28 

func (m *RegisterData) Schema() []fmt.Field

type RegisterDataList added in v0.0.29 

type RegisterDataList []*RegisterData

func (*RegisterDataList) Append added in v0.0.29 

func (s *RegisterDataList) Append() fmt.Fielder

func (*RegisterDataList) At added in v0.0.29 

func (s *RegisterDataList) At(i int) fmt.Fielder

func (*RegisterDataList) DecodeFields added in v0.0.29 

func (s *RegisterDataList) DecodeFields(_ fmt.FieldReader)

func (*RegisterDataList) EncodeFields added in v0.0.29 

func (s *RegisterDataList) EncodeFields(_ fmt.FieldWriter)

func (*RegisterDataList) IsNil added in v0.0.29 

func (s *RegisterDataList) IsNil() bool

func (*RegisterDataList) Len added in v0.0.29 

func (s *RegisterDataList) Len() int

func (*RegisterDataList) Pointers added in v0.0.29 

func (s *RegisterDataList) Pointers() []any

func (*RegisterDataList) Schema added in v0.0.29 

func (s *RegisterDataList) Schema() []fmt.Field

type Role added in v0.0.6 

type Role struct {
	ID          string `db:"pk"`
	Code        string
	Name        string
	Description string
}

orm:typed_fields

func ReadOneRole added in v0.0.6 

func ReadOneRole(qb *orm.QB, model *Role) (*Role, error)

func (*Role) DecodeFields added in v0.0.29 

func (m *Role) DecodeFields(r fmt.FieldReader)

func (*Role) EncodeFields added in v0.0.29 

func (m *Role) EncodeFields(w fmt.FieldWriter)

func (*Role) IsNil added in v0.0.29 

func (m *Role) IsNil() bool

func (*Role) ModelName added in v0.0.29 

func (m *Role) ModelName() string

func (*Role) Pointers added in v0.0.6 

func (m *Role) Pointers() []any

func (*Role) Schema added in v0.0.6 

func (m *Role) Schema() []fmt.Field

type RoleList added in v0.0.29 

type RoleList []*Role

func ReadAllRole added in v0.0.6 

func ReadAllRole(qb *orm.QB) (RoleList, error)

func (*RoleList) Append added in v0.0.29 

func (s *RoleList) Append() fmt.Fielder

func (*RoleList) At added in v0.0.29 

func (s *RoleList) At(i int) fmt.Fielder

func (*RoleList) DecodeFields added in v0.0.29 

func (s *RoleList) DecodeFields(_ fmt.FieldReader)

func (*RoleList) EncodeFields added in v0.0.29 

func (s *RoleList) EncodeFields(_ fmt.FieldWriter)

func (*RoleList) IsNil added in v0.0.29 

func (s *RoleList) IsNil() bool

func (*RoleList) Len added in v0.0.29 

func (s *RoleList) Len() int

func (*RoleList) Pointers added in v0.0.29 

func (s *RoleList) Pointers() []any

func (*RoleList) Schema added in v0.0.29 

func (s *RoleList) Schema() []fmt.Field

type RolePermission added in v0.0.6 

type RolePermission struct {
	RoleID       string `db:"pk,ref=roles"`
	PermissionID string `db:"pk,ref=permissions"`
}

orm:typed_fields

func ReadOneRolePermission added in v0.0.6 

func ReadOneRolePermission(qb *orm.QB, model *RolePermission) (*RolePermission, error)

func (*RolePermission) DecodeFields added in v0.0.29 

func (m *RolePermission) DecodeFields(r fmt.FieldReader)

func (*RolePermission) EncodeFields added in v0.0.29 

func (m *RolePermission) EncodeFields(w fmt.FieldWriter)

func (*RolePermission) IsNil added in v0.0.29 

func (m *RolePermission) IsNil() bool

func (*RolePermission) ModelName added in v0.0.29 

func (m *RolePermission) ModelName() string

func (*RolePermission) Pointers added in v0.0.6 

func (m *RolePermission) Pointers() []any

func (*RolePermission) Schema added in v0.0.6 

func (m *RolePermission) Schema() []fmt.Field

type RolePermissionList added in v0.0.29 

type RolePermissionList []*RolePermission

func ReadAllRolePermission added in v0.0.6 

func ReadAllRolePermission(qb *orm.QB) (RolePermissionList, error)

func (*RolePermissionList) Append added in v0.0.29 

func (s *RolePermissionList) Append() fmt.Fielder

func (*RolePermissionList) At added in v0.0.29 

func (s *RolePermissionList) At(i int) fmt.Fielder

func (*RolePermissionList) DecodeFields added in v0.0.29 

func (s *RolePermissionList) DecodeFields(_ fmt.FieldReader)

func (*RolePermissionList) EncodeFields added in v0.0.29 

func (s *RolePermissionList) EncodeFields(_ fmt.FieldWriter)

func (*RolePermissionList) IsNil added in v0.0.29 

func (s *RolePermissionList) IsNil() bool

func (*RolePermissionList) Len added in v0.0.29 

func (s *RolePermissionList) Len() int

func (*RolePermissionList) Pointers added in v0.0.29 

func (s *RolePermissionList) Pointers() []any

func (*RolePermissionList) Schema added in v0.0.29 

func (s *RolePermissionList) Schema() []fmt.Field

type Rows added in v0.0.2 

type Rows interface {
	Scan(dest ...any) error
	Next() bool
	Close() error
	Err() error
}

Rows interface abstracts scanning multiple rows.

type Scanner added in v0.0.2 

type Scanner interface {
	Scan(dest ...any) error
}

Scanner interface abstracts scanning a row.

type SecurityEvent added in v0.0.22 

type SecurityEvent struct {
	Type      SecurityEventType
	IP        string // client IP, empty if not available
	UserID    string // empty if user not yet identified
	Provider  string // OAuth provider name, for OAuth events
	Resource  string // RBAC resource, for EventAccessDenied
	Timestamp int64  // time.Now().Unix()
}

type SecurityEventType added in v0.0.22 

type SecurityEventType uint8
const (
	EventJWTTampered        SecurityEventType = iota // ValidateJWT: HMAC mismatch
	EventOAuthReplay                                 // consumeState: state already consumed (2nd use)
	EventOAuthExpiredState                           // consumeState: state found but past ExpiresAt
	EventOAuthCrossProvider                          // consumeState: provider mismatch (state preserved)
	EventIPMismatch                                  // LoginLAN: IP not registered
	EventNonActiveAccess                             // Login/LoginLAN: status != "active"
	EventUnauthorizedAccess                          // validateSession: cookie present but session invalid
	EventAccessDenied                                // AccessCheck: RBAC denied with valid session
)

type Session added in v0.0.2 

type Session struct {
	ID        string `db:"pk"`
	UserID    string `db:"ref=users"`
	ExpiresAt int64
	IP        string
	UserAgent string
	CreatedAt int64
}

orm:typed_fields

func ReadOneSession added in v0.0.6 

func ReadOneSession(qb *orm.QB, model *Session) (*Session, error)

func (*Session) DecodeFields added in v0.0.29 

func (m *Session) DecodeFields(r fmt.FieldReader)

func (*Session) EncodeFields added in v0.0.29 

func (m *Session) EncodeFields(w fmt.FieldWriter)

func (*Session) IsNil added in v0.0.29 

func (m *Session) IsNil() bool

func (*Session) ModelName added in v0.0.29 

func (m *Session) ModelName() string

func (*Session) Pointers added in v0.0.6 

func (m *Session) Pointers() []any

func (*Session) Schema added in v0.0.6 

func (m *Session) Schema() []fmt.Field

type SessionList added in v0.0.29 

type SessionList []*Session

func ReadAllSession added in v0.0.6 

func ReadAllSession(qb *orm.QB) (SessionList, error)

func (*SessionList) Append added in v0.0.29 

func (s *SessionList) Append() fmt.Fielder

func (*SessionList) At added in v0.0.29 

func (s *SessionList) At(i int) fmt.Fielder

func (*SessionList) DecodeFields added in v0.0.29 

func (s *SessionList) DecodeFields(_ fmt.FieldReader)

func (*SessionList) EncodeFields added in v0.0.29 

func (s *SessionList) EncodeFields(_ fmt.FieldWriter)

func (*SessionList) IsNil added in v0.0.29 

func (s *SessionList) IsNil() bool

func (*SessionList) Len added in v0.0.29 

func (s *SessionList) Len() int

func (*SessionList) Pointers added in v0.0.29 

func (s *SessionList) Pointers() []any

func (*SessionList) Schema added in v0.0.29 

func (s *SessionList) Schema() []fmt.Field

type User 

type User struct {
	ID          string `db:"pk"`
	Email       string `db:"unique"`
	Name        string
	Phone       string
	Status      string // "active", "suspended"
	CreatedAt   int64
	Roles       []Role       `db:"-"`
	Permissions []Permission `db:"-"`
}

orm:typed_fields

func ReadOneUser added in v0.0.6 

func ReadOneUser(qb *orm.QB, model *User) (*User, error)

func (*User) DecodeFields added in v0.0.29 

func (m *User) DecodeFields(r fmt.FieldReader)

func (*User) EncodeFields added in v0.0.29 

func (m *User) EncodeFields(w fmt.FieldWriter)

func (*User) IsNil added in v0.0.29 

func (m *User) IsNil() bool

func (*User) ModelName added in v0.0.29 

func (m *User) ModelName() string

func (*User) Pointers added in v0.0.6 

func (m *User) Pointers() []any

func (*User) Schema added in v0.0.6 

func (m *User) Schema() []fmt.Field

type UserList added in v0.0.29 

type UserList []*User

func ReadAllUser added in v0.0.6 

func ReadAllUser(qb *orm.QB) (UserList, error)

func (*UserList) Append added in v0.0.29 

func (s *UserList) Append() fmt.Fielder

func (*UserList) At added in v0.0.29 

func (s *UserList) At(i int) fmt.Fielder

func (*UserList) DecodeFields added in v0.0.29 

func (s *UserList) DecodeFields(_ fmt.FieldReader)

func (*UserList) EncodeFields added in v0.0.29 

func (s *UserList) EncodeFields(_ fmt.FieldWriter)

func (*UserList) IsNil added in v0.0.29 

func (s *UserList) IsNil() bool

func (*UserList) Len added in v0.0.29 

func (s *UserList) Len() int

func (*UserList) Pointers added in v0.0.29 

func (s *UserList) Pointers() []any

func (*UserList) Schema added in v0.0.29 

func (s *UserList) Schema() []fmt.Field

type UserRole added in v0.0.6 

type UserRole struct {
	UserID string `db:"pk,ref=users"`
	RoleID string `db:"pk,ref=roles"`
}

orm:typed_fields

func ReadOneUserRole added in v0.0.6 

func ReadOneUserRole(qb *orm.QB, model *UserRole) (*UserRole, error)

func (*UserRole) DecodeFields added in v0.0.29 

func (m *UserRole) DecodeFields(r fmt.FieldReader)

func (*UserRole) EncodeFields added in v0.0.29 

func (m *UserRole) EncodeFields(w fmt.FieldWriter)

func (*UserRole) IsNil added in v0.0.29 

func (m *UserRole) IsNil() bool

func (*UserRole) ModelName added in v0.0.29 

func (m *UserRole) ModelName() string

func (*UserRole) Pointers added in v0.0.6 

func (m *UserRole) Pointers() []any

func (*UserRole) Schema added in v0.0.6 

func (m *UserRole) Schema() []fmt.Field

type UserRoleList added in v0.0.29 

type UserRoleList []*UserRole

func ReadAllUserRole added in v0.0.6 

func ReadAllUserRole(qb *orm.QB) (UserRoleList, error)

func (*UserRoleList) Append added in v0.0.29 

func (s *UserRoleList) Append() fmt.Fielder

func (*UserRoleList) At added in v0.0.29 

func (s *UserRoleList) At(i int) fmt.Fielder

func (*UserRoleList) DecodeFields added in v0.0.29 

func (s *UserRoleList) DecodeFields(_ fmt.FieldReader)

func (*UserRoleList) EncodeFields added in v0.0.29 

func (s *UserRoleList) EncodeFields(_ fmt.FieldWriter)

func (*UserRoleList) IsNil added in v0.0.29 

func (s *UserRoleList) IsNil() bool

func (*UserRoleList) Len added in v0.0.29 

func (s *UserRoleList) Len() int

func (*UserRoleList) Pointers added in v0.0.29 

func (s *UserRoleList) Pointers() []any

func (*UserRoleList) Schema added in v0.0.29 

func (s *UserRoleList) Schema() []fmt.Field

Source Files

View all Source files

Directories

Path Synopsis

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.