fursuit-tv-sdk/com.furrist.rp.furtv.sdk.auth

Package-level declarations

Types

认证管理器负责令牌的管理、刷新和 OAuth 流程提供签名交换、令牌刷新、OAuth 授权、用户信息获取等功能

@Serializable

data class OAuthAuthorizeParams(val clientId: String, val redirectUri: String, val state: String? = null, val scope: String? = null, val responseType: String = "code", val codeChallenge: String? = null, val codeChallengeMethod: String? = null)

OAuth 授权 URL 参数用于生成 OAuth 授权 URL 的参数（OAuth 流程）

OAuthCallbackException

class OAuthCallbackException(message: String, cause: Throwable? = null)

OAuth 回调异常用于在 OAuth 回调过程中抛出异常

OAuthCallbackHandler

class OAuthCallbackHandler(config: OAuthCallbackServerConfig)

OAuth 回调处理器使用 Ktor CIO 引擎启动嵌入式 HTTP 服务器

OAuthCallbackResult

sealed class OAuthCallbackResult

OAuth 回调结果统一的返回格式，所有平台使用相同的 sealed class

OAuthCallbackServerConfig

data class OAuthCallbackServerConfig(val callbackHost: String = "localhost", val callbackPort: Int = 8080, val callbackPath: String = "/callback", val timeoutSeconds: Long = 300)

OAuth 回调服务器配置

OAuthConfig

@Serializable

data class OAuthConfig(val callbackHost: String = "localhost", val callbackPort: Int = 8080, val callbackPath: String = "/callback", val stateTimeoutMinutes: Int = 10, val enablePkce: Boolean = false)

OAuth 配置用于配置 OAuth 回调参数（OAuth 流程）

OAuthTokenData

@Serializable

data class OAuthTokenData(val accessToken: String, val expiresIn: Int, val tokenType: String, val scope: String? = null, val refreshToken: String? = null)

OAuth 令牌数据包含 OAuth 访问令牌信息（OAuth 流程）

OAuthTokenRequest

@Serializable

data class OAuthTokenRequest(val grantType: String = "authorization_code", val clientSecret: String, val code: String, val redirectUri: String, val clientId: String, val codeVerifier: String? = null)

OAuth 令牌请求用于 OAuth 令牌交换接口的请求体（OAuth 流程）

OAuthTokenResponse

@Serializable

data class OAuthTokenResponse(val success: Boolean, val data: OAuthTokenData, val requestId: String)

OAuth 令牌响应 OAuth 令牌交换接口的响应包装

Sha256

object Sha256

纯 Kotlin 实现的 SHA256 哈希算法基于 FIPS 180-2 规范，支持所有 Kotlin Multiplatform 平台

StateManager

object StateManager

State 管理器负责 OAuth 流程中 state 参数的生成、验证和管理提供加密安全的 state 生成、存储、验证和超时失效功能

TokenData

@Serializable

data class TokenData(val accessToken: String, val apiKey: String, val expiresIn: Int, val tokenType: String, val refresh: TokenRefreshInfo? = null)

令牌数据包含访问令牌信息（签名交换接口返回）注意：accessToken 和 apiKey 是两个不同的值

TokenExchangeRequest

@Serializable

data class TokenExchangeRequest(val clientId: String, val clientSecret: String)

签名交换请求（用于获取 apiKey/accessToken）用于签名交换接口的请求体

TokenExchangeResponse

@Serializable

data class TokenExchangeResponse(val success: Boolean, val data: TokenData, val requestId: String)

令牌交换响应签名交换接口的响应包装

TokenInfo

@Serializable

data class TokenInfo(val accessToken: String, val apiKey: String, val expiresAt: Long, val tokenType: String, val refreshToken: String? = null)

令牌信息 SDK 内部使用的令牌存储结构

TokenRefreshInfo

@Serializable

data class TokenRefreshInfo(val mode: String, val refreshWindowSeconds: Int, val previousTokenSecondsRemaining: Int)

令牌刷新信息包含签名换新策略的相关信息

TokenRefreshRequest

@Serializable

data class TokenRefreshRequest(val dummy: String? = null)

令牌刷新请求用于令牌刷新接口的请求体根据文档，刷新接口不需要请求体，只需要 Authorization header 使用空对象作为请求体

TokenRefreshResponse

@Serializable

data class TokenRefreshResponse(val success: Boolean, val data: TokenData, val requestId: String, val refresh: TokenRefreshInfo? = null)

令牌刷新响应令牌刷新接口的响应包装

UserInfoData

@Serializable

data class UserInfoData(val sub: String, val nickname: String? = null, val avatarUrl: String? = null, val email: String? = null, val name: String? = null, val username: String? = null, val updatedAt: Long? = null, val phoneNumber: String? = null)

用户信息数据包含 OAuth 用户的基本信息

UserInfoResponse

@Serializable

data class UserInfoResponse(val success: Boolean, val data: UserInfoData, val requestId: String)

用户信息响应用户信息接口的响应包装

Functions

sha256

fun ByteArray.sha256(): ByteArray

计算 ByteArray 的 SHA256 哈希