RefreshTokenManager

Struct RefreshTokenManager 

Source
pub struct RefreshTokenManager { /* private fields */ }
Expand description

Refresh Token 管理器

提供 Refresh Token 的完整生命周期管理,包括生成、验证、轮换和撤销。

§示例

use authrs::token::refresh::{RefreshTokenManager, RefreshConfig, GenerateOptions};

let manager = RefreshTokenManager::new(RefreshConfig::default());

// 生成 Token
let token = manager.generate("user123").await.unwrap();

// 带元数据生成 Token
let options = GenerateOptions::new()
    .with_device_info("iPhone 15")
    .with_ip_address("192.168.1.1");
let token = manager
    .generate_with_options("user123", options)
    .await
    .unwrap();

// 使用 Token(会自动轮换)
let result = manager.use_token(&token.token).await.unwrap();
if let Some(new_token) = result.new_token {
    println!("使用新 Token: {}", new_token.token);
}

// 撤销用户的所有 Token
manager.revoke_all_for_user("user123").await.unwrap();

Implementations§

Source§

impl RefreshTokenManager

Source

pub fn new(config: RefreshConfig) -> Self

使用默认内存存储创建管理器

Source

pub fn with_store( config: RefreshConfig, store: Arc<dyn RefreshTokenStore>, ) -> Self

使用自定义存储创建管理器

Source

pub async fn generate(&self, user_id: impl Into<String>) -> Result<RefreshToken>

生成新的 Refresh Token

§参数
  • user_id - 用户 ID
§返回

返回生成的 Token

Source

pub async fn generate_with_options( &self, user_id: impl Into<String>, options: GenerateOptions, ) -> Result<RefreshToken>

使用选项生成 Refresh Token

允许设置设备信息、IP 地址和初始元数据。

Source

pub async fn use_token(&self, token: &str) -> Result<TokenUseResult>

使用 Refresh Token

如果启用了 Token 轮换,会生成新的 Token 并使旧 Token 失效。 如果检测到重用攻击(已使用的 Token 被再次使用),会撤销整个 Token 家族。

§参数
  • token - Token 值
§返回

返回使用结果,包含新 Token(如果启用轮换)

Source

pub async fn validate(&self, token: &str) -> Result<RefreshToken>

验证 Token

只检查 Token 是否有效,不会使用或轮换 Token。

Source

pub async fn revoke(&self, token: &str) -> Result<()>

撤销 Token

Source

pub async fn revoke_family(&self, family_id: &str) -> Result<usize>

撤销 Token 家族

Source

pub async fn revoke_all_for_user(&self, user_id: &str) -> Result<usize>

撤销用户的所有 Token

Source

pub async fn get_user_tokens(&self, user_id: &str) -> Result<Vec<RefreshToken>>

获取用户的所有 Token

Source

pub async fn get_family_tokens( &self, family_id: &str, ) -> Result<Vec<RefreshToken>>

获取 Token 家族的所有 Token

Source

pub async fn cleanup(&self) -> Result<usize>

清理过期的 Token

Source

pub async fn count(&self) -> Result<usize>

获取 Token 总数

Source

pub fn config(&self) -> &RefreshConfig

获取配置

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V