cn.dev33.satoken.oauth2.logic

类 SaOAuth2Util

java.lang.Object

cn.dev33.satoken.oauth2.logic.SaOAuth2Util

public class SaOAuth2Util
extends java.lang.Object

Sa-Token-OAuth2 模块 工具类

作者:

kong

字段概要

字段

限定符和类型	字段和说明
static SaOAuth2Template	saOAuth2Template 模板代码对象

构造器概要

构造器

构造器和说明
SaOAuth2Util()

方法概要

限定符和类型	方法和说明
static java.lang.String	buildImplicitRedirectUri(java.lang.String redirectUri, java.lang.String token, java.lang.String state) 构建URL：下放Access-Token URL （implicit 隐藏式）
static java.lang.String	buildRedirectUri(java.lang.String redirectUri, java.lang.String code, java.lang.String state) 构建URL：下放Code URL (Authorization Code 授权码)
static AccessTokenModel	checkAccessToken(java.lang.String accessToken) 获取 Access-Token，如果AccessToken为空则抛出异常
static AccessTokenModel	checkAccessTokenParam(java.lang.String clientId, java.lang.String clientSecret, java.lang.String accessToken) 校验：Access-Token、clientId、clientSecret 三者是否匹配成功
static SaClientModel	checkClientModel(java.lang.String clientId) 根据id获取Client信息, 如果Client为空，则抛出异常
static SaClientModel	checkClientSecret(java.lang.String clientId, java.lang.String clientSecret) 校验：clientId 与 clientSecret 是否正确
static ClientTokenModel	checkClientToken(java.lang.String clientToken) 获取 Client-Token，如果ClientToken为空则抛出异常
static void	checkContract(java.lang.String clientId, java.lang.String scope) 校验：该Client是否签约了指定的Scope
static CodeModel	checkGainTokenParam(java.lang.String code, java.lang.String clientId, java.lang.String clientSecret, java.lang.String redirectUri) 校验：使用 code 获取 token 时提供的参数校验
static RefreshTokenModel	checkRefreshTokenParam(java.lang.String clientId, java.lang.String clientSecret, java.lang.String refreshToken) 校验：使用 Refresh-Token 刷新 Access-Token 时提供的参数校验
static void	checkRightUrl(java.lang.String clientId, java.lang.String url) 校验：该Client使用指定url作为回调地址，是否合法
static void	checkScope(java.lang.String accessToken, java.lang.String... scopes) 校验：指定 Access-Token 是否具有指定 Scope
static AccessTokenModel	generateAccessToken(RequestAuthModel ra, boolean isCreateRt) 构建Model：Access-Token (根据RequestAuthModel构建，用于隐藏式 and 密码式)
static AccessTokenModel	generateAccessToken(java.lang.String code) 构建Model：Access-Token
static ClientTokenModel	generateClientToken(java.lang.String clientId, java.lang.String scope) 构建Model：Client-Token
static CodeModel	generateCode(RequestAuthModel ra) 构建Model：Code授权码
static RequestAuthModel	generateRequestAuth(SaRequest req, java.lang.Object loginId) 构建Model：请求Model
static AccessTokenModel	getAccessToken(java.lang.String accessToken) 获取：Access-Token Model
static ClientTokenModel	getClientToken(java.lang.String clientToken) 获取：Client-Token Model
static CodeModel	getCode(java.lang.String code) 获取：Code Model
static java.lang.String	getGrantScope(java.lang.String clientId, java.lang.Object loginId) 获取：用户授权记录
static java.lang.Object	getLoginIdByAccessToken(java.lang.String accessToken) 获取 Access-Token 所代表的LoginId
static RefreshTokenModel	getRefreshToken(java.lang.String refreshToken) 获取：Refresh-Token Model
static boolean	isGrant(java.lang.Object loginId, java.lang.String clientId, java.lang.String scope) 判断：指定 loginId 是否对一个 Client 授权给了指定 Scope
static AccessTokenModel	refreshAccessToken(java.lang.String refreshToken) 刷新Model：根据 Refresh-Token 生成一个新的 Access-Token
static void	revokeAccessToken(java.lang.String accessToken) 回收 Access-Token
static void	saveGrantScope(java.lang.String clientId, java.lang.Object loginId, java.lang.String scope) 持久化：用户授权记录

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

saOAuth2Template

public static SaOAuth2Template saOAuth2Template

模板代码对象

构造器详细资料

SaOAuth2Util

public SaOAuth2Util()

方法详细资料

checkClientModel

public static SaClientModel checkClientModel(java.lang.String clientId)

根据id获取Client信息, 如果Client为空，则抛出异常

参数:

clientId - 应用id

返回:

ClientModel

checkAccessToken

public static AccessTokenModel checkAccessToken(java.lang.String accessToken)

获取 Access-Token，如果AccessToken为空则抛出异常

参数:

accessToken - .

返回:

.

checkClientToken

public static ClientTokenModel checkClientToken(java.lang.String clientToken)

获取 Client-Token，如果ClientToken为空则抛出异常

参数:

clientToken - .

返回:

.

getLoginIdByAccessToken

public static java.lang.Object getLoginIdByAccessToken(java.lang.String accessToken)

获取 Access-Token 所代表的LoginId

参数:

accessToken - Access-Token

返回:

LoginId

checkScope

public static void checkScope(java.lang.String accessToken,
                              java.lang.String... scopes)

校验：指定 Access-Token 是否具有指定 Scope

参数:

accessToken - Access-Token

scopes - 需要校验的权限列表

generateRequestAuth

public static RequestAuthModel generateRequestAuth(SaRequest req,
                                                   java.lang.Object loginId)

构建Model：请求Model

参数:

req - SaRequest对象

loginId - 账号id

返回:

RequestAuthModel对象

generateCode

public static CodeModel generateCode(RequestAuthModel ra)

构建Model：Code授权码

参数:

ra - 请求参数Model

返回:

授权码Model

generateAccessToken

public static AccessTokenModel generateAccessToken(java.lang.String code)

构建Model：Access-Token

参数:

code - 授权码Model

返回:

AccessToken Model

refreshAccessToken

public static AccessTokenModel refreshAccessToken(java.lang.String refreshToken)

刷新Model：根据 Refresh-Token 生成一个新的 Access-Token

参数:

refreshToken - Refresh-Token值

返回:

新的 Access-Token

generateAccessToken

public static AccessTokenModel generateAccessToken(RequestAuthModel ra,
                                                   boolean isCreateRt)

构建Model：Access-Token (根据RequestAuthModel构建，用于隐藏式 and 密码式)

参数:

ra - 请求参数Model

isCreateRt - 是否生成对应的Refresh-Token

返回:

Access-Token Model

generateClientToken

public static ClientTokenModel generateClientToken(java.lang.String clientId,
                                                   java.lang.String scope)

构建Model：Client-Token

参数:

clientId - 应用id

scope - 授权范围

返回:

Client-Token Model

buildRedirectUri

public static java.lang.String buildRedirectUri(java.lang.String redirectUri,
                                                java.lang.String code,
                                                java.lang.String state)

构建URL：下放Code URL (Authorization Code 授权码)

参数:

redirectUri - 下放地址

code - code参数

state - state参数

返回:

构建完毕的URL

buildImplicitRedirectUri

public static java.lang.String buildImplicitRedirectUri(java.lang.String redirectUri,
                                                        java.lang.String token,
                                                        java.lang.String state)

构建URL：下放Access-Token URL （implicit 隐藏式）

参数:

redirectUri - 下放地址

token - token

state - state参数

返回:

构建完毕的URL

revokeAccessToken

public static void revokeAccessToken(java.lang.String accessToken)

回收 Access-Token

参数:

accessToken - Access-Token值

isGrant

public static boolean isGrant(java.lang.Object loginId,
                              java.lang.String clientId,
                              java.lang.String scope)

判断：指定 loginId 是否对一个 Client 授权给了指定 Scope

参数:

loginId - 账号id

clientId - 应用id

scope - 权限

返回:

是否已经授权

checkContract

public static void checkContract(java.lang.String clientId,
                                 java.lang.String scope)

校验：该Client是否签约了指定的Scope

参数:

clientId - 应用id

scope - 权限(多个用逗号隔开)

checkRightUrl

public static void checkRightUrl(java.lang.String clientId,
                                 java.lang.String url)

校验：该Client使用指定url作为回调地址，是否合法

参数:

clientId - 应用id

url - 指定url

checkClientSecret

public static SaClientModel checkClientSecret(java.lang.String clientId,
                                              java.lang.String clientSecret)

校验：clientId 与 clientSecret 是否正确

参数:

clientId - 应用id

clientSecret - 秘钥

返回:

SaClientModel对象

checkGainTokenParam

public static CodeModel checkGainTokenParam(java.lang.String code,
                                            java.lang.String clientId,
                                            java.lang.String clientSecret,
                                            java.lang.String redirectUri)

校验：使用 code 获取 token 时提供的参数校验

参数:

code - 授权码

clientId - 应用id

clientSecret - 秘钥

redirectUri - 重定向地址

返回:

CodeModel对象

checkRefreshTokenParam

public static RefreshTokenModel checkRefreshTokenParam(java.lang.String clientId,
                                                       java.lang.String clientSecret,
                                                       java.lang.String refreshToken)

校验：使用 Refresh-Token 刷新 Access-Token 时提供的参数校验

参数:

clientId - 应用id

clientSecret - 秘钥

refreshToken - Refresh-Token

返回:

CodeModel对象

checkAccessTokenParam

public static AccessTokenModel checkAccessTokenParam(java.lang.String clientId,
                                                     java.lang.String clientSecret,
                                                     java.lang.String accessToken)

校验：Access-Token、clientId、clientSecret 三者是否匹配成功

参数:

clientId - 应用id

clientSecret - 秘钥

accessToken - Access-Token

返回:

SaClientModel对象

saveGrantScope

public static void saveGrantScope(java.lang.String clientId,
                                  java.lang.Object loginId,
                                  java.lang.String scope)

持久化：用户授权记录

参数:

clientId - 应用id

loginId - 账号id

scope - 权限列表(多个逗号隔开)

getCode

public static CodeModel getCode(java.lang.String code)

获取：Code Model

参数:

code - .

返回:

.

getAccessToken

public static AccessTokenModel getAccessToken(java.lang.String accessToken)

获取：Access-Token Model

参数:

accessToken - .

返回:

.

getRefreshToken

public static RefreshTokenModel getRefreshToken(java.lang.String refreshToken)

获取：Refresh-Token Model

参数:

refreshToken - .

返回:

.

getClientToken

public static ClientTokenModel getClientToken(java.lang.String clientToken)

获取：Client-Token Model

参数:

clientToken - .

返回:

.

getGrantScope

public static java.lang.String getGrantScope(java.lang.String clientId,
                                             java.lang.Object loginId)

获取：用户授权记录

参数:

clientId - 应用id

loginId - 账号id

返回:

权限