auth

type AuthContext string

type AuthProvider interface {
	// Authenticate 验证用户凭证并返回认证实体
	Authenticate(ctx context.Context, credentials map[string]string) (Authenticatable, error)

	// GetUserByID 根据ID获取认证实体
	GetUserByID(ctx context.Context, id string) (Authenticatable, error)

	// GetUserByIdentifier 根据标识符获取认证实体
	GetUserByIdentifier(ctx context.Context, identifier string) (Authenticatable, error)

	// GenerateToken 为认证实体生成令牌
	GenerateToken(ctx context.Context, user Authenticatable, expiry time.Duration) (string, error)

	// ValidateToken 验证令牌并返回认证实体
	ValidateToken(ctx context.Context, token string) (Authenticatable, error)

	// RefreshToken 刷新令牌
	RefreshToken(ctx context.Context, token string) (string, error)

	// InvalidateToken 使令牌失效
	InvalidateToken(ctx context.Context, token string) error

	// CheckPermission 检查认证实体是否拥有指定权限
	CheckPermission(ctx context.Context, user Authenticatable, permission string) bool

	// CheckRole 检查认证实体是否拥有指定角色
	CheckRole(ctx context.Context, user Authenticatable, role string) bool
}

type Authenticatable interface {
	// GetAuthIdentifier 返回实体的唯一标识符
	GetAuthIdentifier() string

	// GetAuthUsername 返回实体的用户名
	GetAuthUsername() string

	// GetPermissions 返回实体拥有的权限列表
	GetPermissions() []string

	// GetRoles 返回实体拥有的角色列表
	GetRoles() []string
}

type AuthenticatableUser struct {
	ID          string   `json:"id"`
	Identifier  string   `json:"identifier"`
	Password    string   `json:"password"`
	Roles       []string `json:"roles"`
	Permissions []string `json:"permissions"`
	Status      bool     `json:"status"`
}

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

type Config struct {
	// DefaultProvider 默认认证提供者名称
	DefaultProvider string

	// TokenExpiry 令牌默认过期时间
	TokenExpiry time.Duration

	// ContextKey 存储在Flow上下文中的已认证用户键名
	ContextKey string

	// LoginURL 登录页面URL
	LoginURL string

	// LogoutURL 登出页面URL
	LogoutURL string

	// RedirectKey 重定向URL参数键名
	RedirectKey string

	// CookieName 认证Cookie名称
	CookieName string

	// CookiePath Cookie路径
	CookiePath string

	// CookieDomain Cookie域
	CookieDomain string

	// CookieSecure Cookie是否仅通过HTTPS发送
	CookieSecure bool

	// CookieHTTPOnly Cookie是否仅可通过HTTP访问
	CookieHTTPOnly bool

	// SessionDriver 会话驱动类型
	SessionDriver string

	// UserProvider 用户提供者实现
	UserProvider UserProvider
}

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

type PolicyHandler func(ctx context.Context, user Authenticatable, resource interface{}, action string) bool

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

type Provider interface {
	// Authenticate 验证用户凭证并返回已认证用户
	Authenticate(ctx context.Context, credentials map[string]string) (Authenticatable, error)

	// GetUserByID 通过ID获取用户
	GetUserByID(ctx context.Context, id string) (Authenticatable, error)

	// GenerateToken 为用户生成认证令牌
	GenerateToken(ctx context.Context, user Authenticatable, expiry time.Duration) (string, error)

	// ValidateToken 验证令牌并返回关联的用户
	ValidateToken(ctx context.Context, token string) (Authenticatable, error)

	// RefreshToken 刷新认证令牌
	RefreshToken(ctx context.Context, token string) (string, error)

	// InvalidateToken 使令牌失效
	InvalidateToken(ctx context.Context, token string) error

	// CheckPermission 检查用户是否拥有指定权限
	CheckPermission(ctx context.Context, user Authenticatable, permission string) bool

	// CheckRole 检查用户是否拥有指定角色
	CheckRole(ctx context.Context, user Authenticatable, role string) bool
}

type ResourcePolicy interface {
	// Name 返回策略名称
	Name() string

	// Resource 返回策略适用的资源类型名称
	Resource() string

	// Check 检查用户是否对资源有执行操作的权限
	Check(ctx context.Context, user Authenticatable, resource interface{}, action string) bool
}

type TokenClaims struct {
	jwt.RegisteredClaims

	// UserID 是用户的唯一标识符
	UserID string `json:"user_id"`

	// Username 是用户的用户名
	Username string `json:"username"`

	// Permissions 是用户的权限列表
	Permissions []string `json:"permissions,omitempty"`

	// Roles 是用户的角色列表
	Roles []string `json:"roles,omitempty"`
}

type UserProvider interface {
	// FindByID 通过ID查找用户
	FindByID(ctx context.Context, id string) (Authenticatable, error)

	// FindByCredentials 通过凭证查找用户
	FindByCredentials(ctx context.Context, credentials map[string]string) (Authenticatable, error)

	// ValidateCredentials 验证用户的凭证
	ValidateCredentials(ctx context.Context, user Authenticatable, credentials map[string]string) (bool, error)
}