Package-level declarations

Types

Link copied to clipboard
@JvmBlocking
@JvmAsync
class AuthManager

认证管理器

Link copied to clipboard
class JsOAuthCallbackHandler(config: OAuthCallbackServerConfig) : OAuthCallbackHandler
Link copied to clipboard
@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。

Link copied to clipboard

OAuth 回调处理器接口。

Link copied to clipboard
sealed class OAuthCallbackResult

OAuth 回调结果。

Link copied to clipboard
@Serializable
data class OAuthCallbackServerConfig(val callbackHost: String = "localhost", val callbackPort: Int = 8080, val callbackPath: String = "/callback", val timeoutSeconds: Long = 300)

OAuth 回调服务器配置。

Link copied to clipboard
@Serializable
data class OAuthConfig(val callbackHost: String = DEFAULT_CALLBACK_HOST, val callbackPort: Int = DEFAULT_CALLBACK_PORT, val callbackPath: String = DEFAULT_CALLBACK_PATH, val stateTimeoutMinutes: Int = DEFAULT_STATE_TIMEOUT_MINUTES, val enablePkce: Boolean = false)

OAuth 2.0 授权码流程配置。

Link copied to clipboard
@Serializable
data class OAuthTokenData(val accessToken: String, val expiresIn: Int, val tokenType: String, val scope: String? = null, val refreshToken: String? = null)

OAuth 令牌数据,包含 OAuth 访问令牌信息。

Link copied to clipboard
@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 令牌交换接口。

Link copied to clipboard
@Serializable
data class OAuthTokenResponse(val success: Boolean, val data: OAuthTokenData, val requestId: String)

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

Link copied to clipboard
object Sha256

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

Link copied to clipboard

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

Link copied to clipboard
@Serializable
data class TokenData(val accessToken: String, val apiKey: String, val expiresIn: Int, val tokenType: String, val appId: String? = null, val grants: List<String>? = null, val refresh: TokenRefreshInfo? = null)

令牌数据,包含访问令牌信息(签名交换接口返回)。

Link copied to clipboard
@Serializable
data class TokenExchangeRequest(val clientId: String, val clientSecret: String)

签名交换请求,用于获取 apiKey/accessToken。

Link copied to clipboard
@Serializable
data class TokenExchangeResponse(val success: Boolean, val data: TokenData, val requestId: String)

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

Link copied to clipboard
@Serializable
data class TokenInfo(val accessToken: String, val apiKey: String, val expiresAt: Long, val tokenType: String, val refreshToken: String? = null)

令牌信息,SDK 内部使用的令牌存储结构,统一管理签名交换和 OAuth 两种认证方式的令牌。

Link copied to clipboard
@Serializable
data class TokenRefreshInfo(val mode: String, val refreshWindowSeconds: Int, val previousTokenSecondsRemaining: Int)

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

Link copied to clipboard
@Serializable
data class TokenRefreshResponse(val success: Boolean, val data: TokenData, val requestId: String, val refresh: TokenRefreshInfo? = null)

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

Link copied to clipboard
@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, val iss: String? = null, val aud: Long? = null)

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

Link copied to clipboard
@Serializable
data class UserInfoResponse(val success: Boolean, val data: UserInfoData, val requestId: String)

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

Functions

Link copied to clipboard
expect fun createDefaultOAuthHandler(config: OAuthCallbackServerConfig = OAuthCallbackServerConfig.DEFAULT): OAuthCallbackHandler

创建平台默认的 OAuth 回调处理器。

actual fun createDefaultOAuthHandler(config: OAuthCallbackServerConfig): OAuthCallbackHandler

创建平台默认的 OAuth 回调处理器。

创建平台默认的 OAuth 回调处理器。

创建平台默认的 OAuth 回调处理器。

Link copied to clipboard

计算 ByteArray 的 SHA256 哈希

Link copied to clipboard

将 OAuth 令牌数据转换为 TokenInfo。

将签名交换令牌数据转换为 TokenInfo。