Expand description
§sa-token-plugin-tide
为 Tide 框架提供 sa-token 认证和授权支持 Provides sa-token authentication and authorization support for Tide framework
§特性 | Features
- ✨ 一行导入所有功能 | One-line import for all functionalities
- 🔧 支持多种存储后端 | Support for multiple storage backends
- 🚀 简化的中间件集成 | Simplified middleware integration
- 📦 包含核心、宏、存储 | Includes core, macros, and storage
§快速开始 | Quick Start
[dependencies]
sa-token-plugin-tide = "0.1.4"ⓘ
use sa_token_plugin_tide::*;
#[async_std::main]
async fn main() -> tide::Result<()> {
let storage = Arc::new(MemoryStorage::new());
SaTokenConfig::builder()
.token_name("Authorization")
.timeout(7200)
.storage(storage)
.build();
let mut app = tide::new();
app.at("/login").post(login_handler);
app.at("/user").get(user_info_handler);
app.listen("127.0.0.1:8080").await?;
Ok(())
}Re-exports§
pub use adapter::*;pub use middleware::*;
Modules§
- adapter
- config
- 配置模块
- distributed
- Distributed Session Management Module | 分布式 Session 管理模块
- event
- Event Listener Module | 事件监听模块
- framework
- 框架集成适配器trait定义
- middleware
- nonce
- Nonce Manager | Nonce 管理器
- oauth2
- OAuth2 Authorization Code Flow Implementation | OAuth2 授权码模式实现
- online
- Online User Management and Real-time Push Module | 在线用户管理和实时推送模块
- permission
- 权限验证模块
- refresh
- Refresh Token Module | Refresh Token 模块
- session
- Session 管理模块
- sso
- SSO 单点登录模块 | SSO Single Sign-On Module
- storage
- 存储适配器trait定义
- token
- Token 管理模块
- util
- StpUtil - sa-token 便捷工具类
- utils
- ws
- WebSocket Authentication Module | WebSocket 认证模块
Structs§
- Access
Token - Access Token Response | 访问令牌响应
- Authorization
Code - Authorization Code | 授权码
- Cookie
Options - Cookie 选项
- Default
WsToken Extractor - Default token extractor implementation 默认的 Token 提取器实现
- Distributed
Session - Distributed session data structure 分布式 Session 数据结构
- Distributed
Session Manager - Distributed session manager 分布式 Session 管理器
- InMemory
Distributed Storage - In-memory distributed session storage implementation 内存分布式 Session 存储实现
- InMemory
Pusher - In-memory message pusher implementation 内存消息推送器实现
- JwtClaims
- JWT Claims | JWT 声明
- JwtManager
- JWT Manager | JWT 管理器
- Logging
Listener - 简单的日志监听器示例
- Memory
Storage - 内存存储实现
- Nonce
Manager - Nonce Manager | Nonce 管理器
- OAuth2
Client - OAuth2 Client Information | OAuth2 客户端信息
- OAuth2
Manager - OAuth2 Manager | OAuth2 管理器
- OAuth2
Token Info - OAuth2 Token Information (for storage) | OAuth2 令牌信息(用于存储)
- Online
Manager - Online user manager 在线用户管理器
- Online
User - Online user information 在线用户信息
- Push
Message - Push message structure 推送消息结构
- Refresh
Token Manager - Refresh Token Manager | Refresh Token 管理器
- SaSession
- Session 对象 | Session Object
- SaToken
Config - sa-token 配置
- SaToken
Context - sa-token 上下文 | sa-token Context
- SaToken
Event - 事件数据
- SaToken
Event Bus - 事件总线 - 管理所有监听器并分发事件
- SaToken
Manager - sa-token 管理器
- Service
Credential - Service credential for inter-service authentication 服务间认证的服务凭证
- SsoClient
- SSO 客户端 | SSO Client
- SsoConfig
- SsoManager
- SsoServer
- SSO 服务端 | SSO Server
- SsoSession
- SSO 全局会话 | SSO Global Session
- SsoTicket
- SSO 票据结构 | SSO Ticket Structure
- StpUtil
- StpUtil - 权限认证工具类
- Token
Info - Token 信息 | Token Information
- Token
Value - Token 值
- WsAuth
Info - WebSocket authentication information WebSocket 认证信息
- WsAuth
Manager - WebSocket authentication manager WebSocket 认证管理器
Enums§
- JwtAlgorithm
- JWT Algorithm | JWT 算法
- Message
Type - Message type enumeration 消息类型枚举
- SaToken
Error - SaToken
Event Type - 事件类型
- Same
Site - SameSite 属性
Traits§
- Distributed
Session Storage - Distributed session storage trait 分布式 Session 存储 trait
- Framework
Adapter - 框架适配器trait
- LoginId
- LoginId trait - 支持任何可以转换为字符串的类型作为登录 ID
- Message
Pusher - Message pusher trait 消息推送器 trait
- Permission
Checker - 权限检查器 | Permission Checker
- Role
Checker - 角色检查器 | Role Checker
- SaRequest
- 请求上下文trait
- SaResponse
- 响应上下文trait
- SaStorage
- 存储适配器trait
- SaToken
Listener - 事件监听器 trait | Event Listener Trait
- WsToken
Extractor - Token extractor trait for WebSocket connections WebSocket 连接的 Token 提取器 trait
Functions§
- build_
cookie_ string - 中文 | English 从 CookieOptions 构建完整的 Set-Cookie 字符串 | Build complete Set-Cookie string from CookieOptions
- extract_
bearer_ token - 中文 | English 从 Authorization 头提取 Bearer token | Extract Bearer token from Authorization header
- parse_
cookies - 中文 | English 解析 Cookie 字符串为键值对映射 | Parse Cookie string into key-value map
- parse_
query_ string - 中文 | English 解析 URL 查询字符串为键值对映射 | Parse URL query string into key-value map
Type Aliases§
Attribute Macros§
- sa_
check_ login - 检查登录状态的宏
- sa_
check_ permission - 检查权限的宏
- sa_
check_ permissions_ and - 同时检查多个权限(AND逻辑)
- sa_
check_ permissions_ or - 同时检查多个权限(OR逻辑)
- sa_
check_ role - 检查角色的宏
- sa_
check_ roles_ and - 同时检查多个角色(AND逻辑)
- sa_
check_ roles_ or - 同时检查多个角色(OR逻辑)
- sa_
ignore - 忽略认证检查的宏