From c813f2d41f14af517e2822ceb9e987dc4da8d851 Mon Sep 17 00:00:00 2001 From: hefangqiang Date: Tue, 30 Nov 2021 16:19:52 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E5=A4=8D=E9=97=AE=E9=A2=98=EF=BC=9A?= =?UTF-8?q?=E5=9B=9E=E6=94=B6accesstoken=20index=20=E5=85=A5=E5=8F=82?= =?UTF-8?q?=E4=BC=A0=E9=94=99=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../oauth2/logic/SaOAuth2Template.java | 596 +++++++++--------- 1 file changed, 298 insertions(+), 298 deletions(-) diff --git a/sa-token-plugin/sa-token-oauth2/src/main/java/cn/dev33/satoken/oauth2/logic/SaOAuth2Template.java b/sa-token-plugin/sa-token-oauth2/src/main/java/cn/dev33/satoken/oauth2/logic/SaOAuth2Template.java index dca5f2f2..ddeedc44 100644 --- a/sa-token-plugin/sa-token-oauth2/src/main/java/cn/dev33/satoken/oauth2/logic/SaOAuth2Template.java +++ b/sa-token-plugin/sa-token-oauth2/src/main/java/cn/dev33/satoken/oauth2/logic/SaOAuth2Template.java @@ -17,15 +17,15 @@ import cn.dev33.satoken.strategy.SaStrategy; import cn.dev33.satoken.util.SaFoxUtil; /** - * Sa-Token-OAuth2 模块 代码实现 + * Sa-Token-OAuth2 模块 代码实现 * @author kong * */ public class SaOAuth2Template { - // ------------------- 获取数据 (开发者必须重写的函数) + // ------------------- 获取数据 (开发者必须重写的函数) /** - * 根据id获取Client信息 + * 根据id获取Client信息 * @param clientId 应用id * @return ClientModel */ @@ -33,20 +33,20 @@ public class SaOAuth2Template { return null; } /** - * 根据ClientId 和 LoginId 获取openid - * @param clientId 应用id - * @param loginId 账号id - * @return 此账号在此Client下的openid + * 根据ClientId 和 LoginId 获取openid + * @param clientId 应用id + * @param loginId 账号id + * @return 此账号在此Client下的openid */ public String getOpenid(String clientId, Object loginId) { return null; } - - // ------------------- 资源校验API + + // ------------------- 资源校验API /** - * 根据id获取Client信息, 如果Client为空，则抛出异常 + * 根据id获取Client信息, 如果Client为空，则抛出异常 * @param clientId 应用id - * @return ClientModel + * @return ClientModel */ public SaClientModel checkClientModel(String clientId) { SaClientModel clientModel = getClientModel(clientId); @@ -56,8 +56,8 @@ public class SaOAuth2Template { return clientModel; } /** - * 获取 Access-Token，如果AccessToken为空则抛出异常 - * @param accessToken . + * 获取 Access-Token，如果AccessToken为空则抛出异常 + * @param accessToken . * @return . */ public AccessTokenModel checkAccessToken(String accessToken) { @@ -66,8 +66,8 @@ public class SaOAuth2Template { return at; } /** - * 获取 Client-Token，如果ClientToken为空则抛出异常 - * @param clientToken . + * 获取 Client-Token，如果ClientToken为空则抛出异常 + * @param clientToken . * @return . */ public ClientTokenModel checkClientToken(String clientToken) { @@ -76,17 +76,17 @@ public class SaOAuth2Template { return ct; } /** - * 获取 Access-Token 所代表的LoginId - * @param accessToken Access-Token - * @return LoginId + * 获取 Access-Token 所代表的LoginId + * @param accessToken Access-Token + * @return LoginId */ public Object getLoginIdByAccessToken(String accessToken) { return checkAccessToken(accessToken).loginId; } /** - * 校验：指定 Access-Token 是否具有指定 Scope + * 校验：指定 Access-Token 是否具有指定 Scope * @param accessToken Access-Token - * @param scopes 需要校验的权限列表 + * @param scopes 需要校验的权限列表 */ public void checkScope(String accessToken, String... scopes) { if(scopes == null || scopes.length == 0) { @@ -98,13 +98,13 @@ public class SaOAuth2Template { SaOAuth2Exception.throwBy(scopeList.contains(scope) == false, "该 Access-Token 不具备 Scope：" + scope); } } - - // ------------------- generate 构建数据 + + // ------------------- generate 构建数据 /** - * 构建Model：请求Model - * @param req SaRequest对象 - * @param loginId 账号id - * @return RequestAuthModel对象 + * 构建Model：请求Model + * @param req SaRequest对象 + * @param loginId 账号id + * @return RequestAuthModel对象 */ public RequestAuthModel generateRequestAuth(SaRequest req, Object loginId) { RequestAuthModel ra = new RequestAuthModel(); @@ -117,210 +117,210 @@ public class SaOAuth2Template { return ra; } /** - * 构建Model：Code授权码 - * @param ra 请求参数Model + * 构建Model：Code授权码 + * @param ra 请求参数Model * @return 授权码Model */ public CodeModel generateCode(RequestAuthModel ra) { - - // 删除旧Code + + // 删除旧Code deleteCode(getCodeValue(ra.clientId, ra.loginId)); - // 生成新Code + // 生成新Code String code = randomCode(ra.clientId, ra.loginId, ra.scope); CodeModel cm = new CodeModel(code, ra.clientId, ra.scope, ra.loginId, ra.redirectUri); - - // 保存新Code + + // 保存新Code saveCode(cm); saveCodeIndex(cm); - - // 返回 + + // 返回 return cm; } /** - * 构建Model：Access-Token + * 构建Model：Access-Token * @param code 授权码Model * @return AccessToken Model */ public AccessTokenModel generateAccessToken(String code) { - // 1、先校验 + // 1、先校验 CodeModel cm = getCode(code); SaOAuth2Exception.throwBy(cm == null, "无效code"); - - // 2、删除旧Token + + // 2、删除旧Token deleteAccessToken(getAccessTokenValue(cm.clientId, cm.loginId)); deleteRefreshToken(getRefreshTokenValue(cm.clientId, cm.loginId)); - - // 3、生成token - AccessTokenModel at = converCodeToAccessToken(cm); + + // 3、生成token + AccessTokenModel at = converCodeToAccessToken(cm); RefreshTokenModel rt = converAccessTokenToRefreshToken(at); at.refreshToken = rt.refreshToken; at.refreshExpiresTime = rt.expiresTime; - // 4、保存token + // 4、保存token saveAccessToken(at); saveAccessTokenIndex(at); saveRefreshToken(rt); saveRefreshTokenIndex(rt); - - // 5、删除此Code + + // 5、删除此Code deleteCode(code); deleteCodeIndex(cm.clientId, cm.loginId); - + // 6、返回 Access-Token return at; } /** - * 刷新Model：根据 Refresh-Token 生成一个新的 Access-Token - * @param refreshToken Refresh-Token值 - * @return 新的 Access-Token + * 刷新Model：根据 Refresh-Token 生成一个新的 Access-Token + * @param refreshToken Refresh-Token值 + * @return 新的 Access-Token */ public AccessTokenModel refreshAccessToken(String refreshToken) { - - // 获取 Refresh-Token 信息 + + // 获取 Refresh-Token 信息 RefreshTokenModel rt = getRefreshToken(refreshToken); - SaOAuth2Exception.throwBy(rt == null, "无效refresh_token: " + refreshToken); - + SaOAuth2Exception.throwBy(rt == null, "无效refresh_token: " + refreshToken); + // 如果配置了[每次刷新产生新的Refresh-Token] if(SaOAuth2Manager.getConfig().getIsNewRefresh()) { - // 删除旧 Refresh-Token + // 删除旧 Refresh-Token deleteRefreshToken(rt.refreshToken); - - // 创建并保持新的 Refresh-Token + + // 创建并保持新的 Refresh-Token rt = converRefreshTokenToRefreshToken(rt); saveRefreshToken(rt); saveRefreshTokenIndex(rt); } - - // 删除旧 Access-Token + + // 删除旧 Access-Token deleteAccessToken(getAccessTokenValue(rt.clientId, rt.loginId)); - - // 生成新 Access-Token + + // 生成新 Access-Token AccessTokenModel at = converRefreshTokenToAccessToken(rt); - - // 保存新 Access-Token + + // 保存新 Access-Token saveAccessToken(at); - saveAccessTokenIndex(at); - - // 返回新 Access-Token + saveAccessTokenIndex(at); + + // 返回新 Access-Token return at; } /** - * 构建Model：Access-Token (根据RequestAuthModel构建，用于隐藏式 and 密码式) - * @param ra 请求参数Model - * @param isCreateRt 是否生成对应的Refresh-Token - * @return Access-Token Model + * 构建Model：Access-Token (根据RequestAuthModel构建，用于隐藏式 and 密码式) + * @param ra 请求参数Model + * @param isCreateRt 是否生成对应的Refresh-Token + * @return Access-Token Model */ public AccessTokenModel generateAccessToken(RequestAuthModel ra, boolean isCreateRt) { - - // 1、删除 旧Token + + // 1、删除 旧Token deleteAccessToken(getAccessTokenValue(ra.clientId, ra.loginId)); if(isCreateRt) { - deleteRefreshToken(getRefreshTokenValue(ra.clientId, ra.loginId)); + deleteRefreshToken(getRefreshTokenValue(ra.clientId, ra.loginId)); } - // 2、生成 新Access-Token + // 2、生成 新Access-Token String newAtValue = randomAccessToken(ra.clientId, ra.loginId, ra.scope); AccessTokenModel at = new AccessTokenModel(newAtValue, ra.clientId, ra.loginId, ra.scope); at.openid = getOpenid(ra.clientId, ra.loginId); at.expiresTime = System.currentTimeMillis() + (SaOAuth2Manager.getConfig().getAccessTokenTimeout() * 1000); - // 3、生成&保存 Refresh-Token + // 3、生成&保存 Refresh-Token if(isCreateRt) { RefreshTokenModel rt = converAccessTokenToRefreshToken(at); saveRefreshToken(rt); saveRefreshTokenIndex(rt); } - // 5、保存 新Access-Token + // 5、保存 新Access-Token saveAccessToken(at); saveAccessTokenIndex(at); - - // 6、返回 新Access-Token + + // 6、返回 新Access-Token return at; } /** - * 构建Model：Client-Token - * @param clientId 应用id - * @param scope 授权范围 - * @return Client-Token Model + * 构建Model：Client-Token + * @param clientId 应用id + * @param scope 授权范围 + * @return Client-Token Model */ public ClientTokenModel generateClientToken(String clientId, String scope) { - // 1、删掉 Past-Token + // 1、删掉 Past-Token deleteClientToken(getPastTokenValue(clientId)); - - // 2、将Client-Token 标记 Past-Token + + // 2、将Client-Token 标记 Past-Token String ctValue = getClientTokenValue(clientId); - savePastTokenIndex(getClientToken(ctValue)); - - // 3、生成新Token + savePastTokenIndex(getClientToken(ctValue)); + + // 3、生成新Token ClientTokenModel ct = new ClientTokenModel(randomClientToken(clientId, scope), clientId, scope); ct.expiresTime = System.currentTimeMillis() + (SaOAuth2Manager.getConfig().getClientTokenTimeout() * 1000); - - // 3、保存新Token + + // 3、保存新Token saveClientToken(ct); - saveClientTokenIndex(ct); - - // 4、返回 + saveClientTokenIndex(ct); + + // 4、返回 return ct; } /** * 构建URL：下放Code URL (Authorization Code 授权码) - * @param redirectUri 下放地址 + * @param redirectUri 下放地址 * @param code code参数 - * @param state state参数 - * @return 构建完毕的URL + * @param state state参数 + * @return 构建完毕的URL */ public String buildRedirectUri(String redirectUri, String code, String state) { String url = SaFoxUtil.joinParam(redirectUri, Param.code, code); if(SaFoxUtil.isEmpty(state) == false) { - url = SaFoxUtil.joinParam(url, Param.state, state); + url = SaFoxUtil.joinParam(url, Param.state, state); } return url; } /** * 构建URL：下放Access-Token URL （implicit 隐藏式） - * @param redirectUri 下放地址 + * @param redirectUri 下放地址 * @param token token - * @param state state参数 - * @return 构建完毕的URL + * @param state state参数 + * @return 构建完毕的URL */ public String buildImplicitRedirectUri(String redirectUri, String token, String state) { String url = SaFoxUtil.joinSharpParam(redirectUri, Param.token, token); if(SaFoxUtil.isEmpty(state) == false) { - url = SaFoxUtil.joinSharpParam(url, Param.state, state); + url = SaFoxUtil.joinSharpParam(url, Param.state, state); } return url; } /** - * 回收 Access-Token - * @param accessToken Access-Token值 + * 回收 Access-Token + * @param accessToken Access-Token值 */ public void revokeAccessToken(String accessToken) { - - // 如果查不到任何东西, 直接返回 + + // 如果查不到任何东西, 直接返回 AccessTokenModel at = getAccessToken(accessToken); if(at == null) { return; } - - // 删除 Access-Token + + // 删除 Access-Token deleteAccessToken(accessToken); - deleteAccessTokenIndex(at.clientId, at.accessToken); - + deleteAccessTokenIndex(at.clientId, at.loginId); + // 删除对应的 Refresh-Token String refreshToken = getRefreshTokenValue(at.clientId, at.loginId); deleteRefreshToken(refreshToken); deleteRefreshTokenIndex(at.clientId, at.loginId); } - - // ------------------- check 数据校验 + + // ------------------- check 数据校验 /** - * 判断：指定 loginId 是否对一个 Client 授权给了指定 Scope - * @param loginId 账号id - * @param clientId 应用id - * @param scope 权限 + * 判断：指定 loginId 是否对一个 Client 授权给了指定 Scope + * @param loginId 账号id + * @param clientId 应用id + * @param scope 权限 * @return 是否已经授权 */ public boolean isGrant(Object loginId, String clientId, String scope) { @@ -329,9 +329,9 @@ public class SaOAuth2Template { return scopeList.size() == 0 || grantScopeList.containsAll(scopeList); } /** - * 校验：该Client是否签约了指定的Scope + * 校验：该Client是否签约了指定的Scope * @param clientId 应用id - * @param scope 权限(多个用逗号隔开) + * @param scope 权限(多个用逗号隔开) */ public void checkContract(String clientId, String scope) { List clientScopeList = SaFoxUtil.convertStringToList(checkClientModel(clientId).contractScope); @@ -341,33 +341,33 @@ public class SaOAuth2Template { } } /** - * 校验：该Client使用指定url作为回调地址，是否合法 - * @param clientId 应用id + * 校验：该Client使用指定url作为回调地址，是否合法 + * @param clientId 应用id * @param url 指定url */ public void checkRightUrl(String clientId, String url) { - // 1、是否是一个有效的url + // 1、是否是一个有效的url if(SaFoxUtil.isUrl(url) == false) { throw new SaOAuth2Exception("无效redirect_url：" + url); } - - // 2、截取掉?后面的部分 + + // 2、截取掉?后面的部分 int qIndex = url.indexOf("?"); if(qIndex != -1) { url = url.substring(0, qIndex); } - - // 3、是否在[允许地址列表]之中 - List allowList = SaFoxUtil.convertStringToList(checkClientModel(clientId).allowUrl); + + // 3、是否在[允许地址列表]之中 + List allowList = SaFoxUtil.convertStringToList(checkClientModel(clientId).allowUrl); if(SaStrategy.me.hasElement.apply(allowList, url) == false) { throw new SaOAuth2Exception("非法redirect_url：" + url); } } /** * 校验：clientId 与 clientSecret 是否正确 - * @param clientId 应用id - * @param clientSecret 秘钥 - * @return SaClientModel对象 + * @param clientId 应用id + * @param clientSecret 秘钥 + * @return SaClientModel对象 */ public SaClientModel checkClientSecret(String clientId, String clientSecret) { SaClientModel cm = checkClientModel(clientId); @@ -375,63 +375,63 @@ public class SaOAuth2Template { return cm; } /** - * 校验：使用 code 获取 token 时提供的参数校验 + * 校验：使用 code 获取 token 时提供的参数校验 * @param code 授权码 - * @param clientId 应用id - * @param clientSecret 秘钥 - * @param redirectUri 重定向地址 - * @return CodeModel对象 + * @param clientId 应用id + * @param clientSecret 秘钥 + * @param redirectUri 重定向地址 + * @return CodeModel对象 */ public CodeModel checkGainTokenParam(String code, String clientId, String clientSecret, String redirectUri) { - - // 校验：Code是否存在 + + // 校验：Code是否存在 CodeModel cm = getCode(code); SaOAuth2Exception.throwBy(cm == null, "无效code: " + code); - // 校验：ClientId是否一致 + // 校验：ClientId是否一致 SaOAuth2Exception.throwBy(cm.clientId.equals(clientId) == false, "无效client_id: " + clientId); - - // 校验：Secret是否正确 + + // 校验：Secret是否正确 String dbSecret = checkClientModel(clientId).clientSecret; SaOAuth2Exception.throwBy(dbSecret == null || dbSecret.equals(clientSecret) == false, "无效client_secret: " + clientSecret); - - // 如果提供了redirectUri，则校验其是否与请求Code时提供的一致 + + // 如果提供了redirectUri，则校验其是否与请求Code时提供的一致 if(SaFoxUtil.isEmpty(redirectUri) == false) { SaOAuth2Exception.throwBy(redirectUri.equals(cm.redirectUri) == false, "无效redirect_uri: " + redirectUri); } - - // 返回CodeMdoel + + // 返回CodeMdoel return cm; } /** - * 校验：使用 Refresh-Token 刷新 Access-Token 时提供的参数校验 - * @param clientId 应用id - * @param clientSecret 秘钥 + * 校验：使用 Refresh-Token 刷新 Access-Token 时提供的参数校验 + * @param clientId 应用id + * @param clientSecret 秘钥 * @param refreshToken Refresh-Token - * @return CodeModel对象 + * @return CodeModel对象 */ public RefreshTokenModel checkRefreshTokenParam(String clientId, String clientSecret, String refreshToken) { - - // 校验：Refresh-Token是否存在 + + // 校验：Refresh-Token是否存在 RefreshTokenModel rt = getRefreshToken(refreshToken); SaOAuth2Exception.throwBy(rt == null, "无效refresh_token: " + refreshToken); - // 校验：ClientId是否一致 + // 校验：ClientId是否一致 SaOAuth2Exception.throwBy(rt.clientId.equals(clientId) == false, "无效client_id: " + clientId); - - // 校验：Secret是否正确 + + // 校验：Secret是否正确 String dbSecret = checkClientModel(clientId).clientSecret; SaOAuth2Exception.throwBy(dbSecret == null || dbSecret.equals(clientSecret) == false, "无效client_secret: " + clientSecret); - - // 返回Refresh-Token + + // 返回Refresh-Token return rt; } /** - * 校验：Access-Token、clientId、clientSecret 三者是否匹配成功 - * @param clientId 应用id - * @param clientSecret 秘钥 - * @param accessToken Access-Token - * @return SaClientModel对象 + * 校验：Access-Token、clientId、clientSecret 三者是否匹配成功 + * @param clientId 应用id + * @param clientSecret 秘钥 + * @param accessToken Access-Token + * @return SaClientModel对象 */ public AccessTokenModel checkAccessTokenParam(String clientId, String clientSecret, String accessToken) { AccessTokenModel at = checkAccessToken(accessToken); @@ -439,16 +439,16 @@ public class SaOAuth2Template { checkClientSecret(clientId, clientSecret); return at; } - - // ------------------- conver 数据转换 + + // ------------------- conver 数据转换 /** - * 将 Code 转换为 Access-Token + * 将 Code 转换为 Access-Token * @param cm CodeModel对象 - * @return AccessToken对象 + * @return AccessToken对象 */ public AccessTokenModel converCodeToAccessToken(CodeModel cm) { AccessTokenModel at = new AccessTokenModel(); - at.accessToken = randomAccessToken(cm.clientId, cm.loginId, cm.scope); + at.accessToken = randomAccessToken(cm.clientId, cm.loginId, cm.scope); // at.refreshToken = randomRefreshToken(cm.clientId, cm.loginId, cm.scope); at.clientId = cm.clientId; at.loginId = cm.loginId; @@ -459,7 +459,7 @@ public class SaOAuth2Template { return at; } /** - * 将 Access-Token 转换为 Refresh-Token + * 将 Access-Token 转换为 Refresh-Token * @param at . * @return . */ @@ -471,13 +471,13 @@ public class SaOAuth2Template { rt.scope = at.scope; rt.openid = at.openid; rt.expiresTime = System.currentTimeMillis() + (SaOAuth2Manager.getConfig().getRefreshTokenTimeout() * 1000); - // 改变at属性 + // 改变at属性 at.refreshToken = rt.refreshToken; at.refreshExpiresTime = rt.expiresTime; return rt; } /** - * 将 Refresh-Token 转换为 Access-Token + * 将 Refresh-Token 转换为 Access-Token * @param rt . * @return . */ @@ -494,7 +494,7 @@ public class SaOAuth2Template { return at; } /** - * 根据 Refresh-Token 创建一个新的 Refresh-Token + * 根据 Refresh-Token 创建一个新的 Refresh-Token * @param rt . * @return . */ @@ -509,10 +509,10 @@ public class SaOAuth2Template { return newRt; } - // ------------------- save 数据 + // ------------------- save 数据 /** - * 持久化：Code-Model - * @param c . + * 持久化：Code-Model + * @param c . */ public void saveCode(CodeModel c) { if(c == null) { @@ -521,8 +521,8 @@ public class SaOAuth2Template { SaManager.getSaTokenDao().setObject(splicingCodeSaveKey(c.code), c, SaOAuth2Manager.getConfig().getCodeTimeout()); } /** - * 持久化：Code-索引 - * @param c . + * 持久化：Code-索引 + * @param c . */ public void saveCodeIndex(CodeModel c) { if(c == null) { @@ -531,8 +531,8 @@ public class SaOAuth2Template { SaManager.getSaTokenDao().set(splicingCodeIndexKey(c.clientId, c.loginId), c.code, SaOAuth2Manager.getConfig().getCodeTimeout()); } /** - * 持久化：AccessToken-Model - * @param at . + * 持久化：AccessToken-Model + * @param at . */ public void saveAccessToken(AccessTokenModel at) { if(at == null) { @@ -541,8 +541,8 @@ public class SaOAuth2Template { SaManager.getSaTokenDao().setObject(splicingAccessTokenSaveKey(at.accessToken), at, at.getExpiresIn()); } /** - * 持久化：AccessToken-索引 - * @param at . + * 持久化：AccessToken-索引 + * @param at . */ public void saveAccessTokenIndex(AccessTokenModel at) { if(at == null) { @@ -551,8 +551,8 @@ public class SaOAuth2Template { SaManager.getSaTokenDao().set(splicingAccessTokenIndexKey(at.clientId, at.loginId), at.accessToken, at.getExpiresIn()); } /** - * 持久化：RefreshToken-Model - * @param rt . + * 持久化：RefreshToken-Model + * @param rt . */ public void saveRefreshToken(RefreshTokenModel rt) { if(rt == null) { @@ -561,8 +561,8 @@ public class SaOAuth2Template { SaManager.getSaTokenDao().setObject(splicingRefreshTokenSaveKey(rt.refreshToken), rt, rt.getExpiresIn()); } /** - * 持久化：RefreshToken-索引 - * @param rt . + * 持久化：RefreshToken-索引 + * @param rt . */ public void saveRefreshTokenIndex(RefreshTokenModel rt) { if(rt == null) { @@ -571,8 +571,8 @@ public class SaOAuth2Template { SaManager.getSaTokenDao().set(splicingRefreshTokenIndexKey(rt.clientId, rt.loginId), rt.refreshToken, rt.getExpiresIn()); } /** - * 持久化：ClientToken-Model - * @param ct . + * 持久化：ClientToken-Model + * @param ct . */ public void saveClientToken(ClientTokenModel ct) { if(ct == null) { @@ -581,8 +581,8 @@ public class SaOAuth2Template { SaManager.getSaTokenDao().setObject(splicingClientTokenSaveKey(ct.clientToken), ct, ct.getExpiresIn()); } /** - * 持久化：ClientToken-索引 - * @param ct . + * 持久化：ClientToken-索引 + * @param ct . */ public void saveClientTokenIndex(ClientTokenModel ct) { if(ct == null) { @@ -591,8 +591,8 @@ public class SaOAuth2Template { SaManager.getSaTokenDao().set(splicingClientTokenIndexKey(ct.clientId), ct.clientToken, ct.getExpiresIn()); } /** - * 持久化：Past-Token-索引 - * @param ct . + * 持久化：Past-Token-索引 + * @param ct . */ public void savePastTokenIndex(ClientTokenModel ct) { if(ct == null) { @@ -601,10 +601,10 @@ public class SaOAuth2Template { SaManager.getSaTokenDao().set(splicingPastTokenIndexKey(ct.clientId), ct.clientToken, ct.getExpiresIn()); } /** - * 持久化：用户授权记录 - * @param clientId 应用id - * @param loginId 账号id - * @param scope 权限列表(多个逗号隔开) + * 持久化：用户授权记录 + * @param clientId 应用id + * @param loginId 账号id + * @param scope 权限列表(多个逗号隔开) */ public void saveGrantScope(String clientId, Object loginId, String scope) { if(SaFoxUtil.isEmpty(scope) == false) { @@ -612,10 +612,10 @@ public class SaOAuth2Template { SaManager.getSaTokenDao().set(splicingGrantScopeKey(clientId, loginId), scope, ttl); } } - - // ------------------- get 数据 + + // ------------------- get 数据 /** - * 获取：Code Model + * 获取：Code Model * @param code . * @return . */ @@ -626,17 +626,17 @@ public class SaOAuth2Template { return (CodeModel)SaManager.getSaTokenDao().getObject(splicingCodeSaveKey(code)); } /** - * 获取：Code Value - * @param clientId 应用id - * @param loginId 账号id + * 获取：Code Value + * @param clientId 应用id + * @param loginId 账号id * @return . */ public String getCodeValue(String clientId, Object loginId) { - return SaManager.getSaTokenDao().get(splicingCodeIndexKey(clientId, loginId)); + return SaManager.getSaTokenDao().get(splicingCodeIndexKey(clientId, loginId)); } /** - * 获取：Access-Token Model - * @param accessToken . + * 获取：Access-Token Model + * @param accessToken . * @return . */ public AccessTokenModel getAccessToken(String accessToken) { @@ -646,18 +646,18 @@ public class SaOAuth2Template { return (AccessTokenModel)SaManager.getSaTokenDao().getObject(splicingAccessTokenSaveKey(accessToken)); } /** - * 获取：Access-Token Value - * @param clientId 应用id - * @param loginId 账号id + * 获取：Access-Token Value + * @param clientId 应用id + * @param loginId 账号id * @return . */ public String getAccessTokenValue(String clientId, Object loginId) { - return SaManager.getSaTokenDao().get(splicingAccessTokenIndexKey(clientId, loginId)); + return SaManager.getSaTokenDao().get(splicingAccessTokenIndexKey(clientId, loginId)); } /** - * 获取：Refresh-Token Model - * @param refreshToken . - * @return . + * 获取：Refresh-Token Model + * @param refreshToken . + * @return . */ public RefreshTokenModel getRefreshToken(String refreshToken) { if(refreshToken == null) { @@ -666,17 +666,17 @@ public class SaOAuth2Template { return (RefreshTokenModel)SaManager.getSaTokenDao().getObject(splicingRefreshTokenSaveKey(refreshToken)); } /** - * 获取：Refresh-Token Value - * @param clientId 应用id - * @param loginId 账号id + * 获取：Refresh-Token Value + * @param clientId 应用id + * @param loginId 账号id * @return . */ public String getRefreshTokenValue(String clientId, Object loginId) { - return SaManager.getSaTokenDao().get(splicingRefreshTokenIndexKey(clientId, loginId)); + return SaManager.getSaTokenDao().get(splicingRefreshTokenIndexKey(clientId, loginId)); } /** - * 获取：Client-Token Model - * @param clientToken . + * 获取：Client-Token Model + * @param clientToken . * @return . */ public ClientTokenModel getClientToken(String clientToken) { @@ -686,35 +686,35 @@ public class SaOAuth2Template { return (ClientTokenModel)SaManager.getSaTokenDao().getObject(splicingClientTokenSaveKey(clientToken)); } /** - * 获取：Client-Token Value - * @param clientId 应用id + * 获取：Client-Token Value + * @param clientId 应用id * @return . */ public String getClientTokenValue(String clientId) { - return SaManager.getSaTokenDao().get(splicingClientTokenIndexKey(clientId)); + return SaManager.getSaTokenDao().get(splicingClientTokenIndexKey(clientId)); } /** - * 获取：Past-Token Value - * @param clientId 应用id + * 获取：Past-Token Value + * @param clientId 应用id * @return . */ public String getPastTokenValue(String clientId) { - return SaManager.getSaTokenDao().get(splicingPastTokenIndexKey(clientId)); + return SaManager.getSaTokenDao().get(splicingPastTokenIndexKey(clientId)); } /** - * 获取：用户授权记录 - * @param clientId 应用id - * @param loginId 账号id - * @return 权限 + * 获取：用户授权记录 + * @param clientId 应用id + * @param loginId 账号id + * @return 权限 */ public String getGrantScope(String clientId, Object loginId) { return SaManager.getSaTokenDao().get(splicingGrantScopeKey(clientId, loginId)); } - - // ------------------- delete数据 + + // ------------------- delete数据 /** - * 删除：Code - * @param code 值 + * 删除：Code + * @param code 值 */ public void deleteCode(String code) { if(code != null) { @@ -722,16 +722,16 @@ public class SaOAuth2Template { } } /** - * 删除：Code索引 - * @param clientId 应用id - * @param loginId 账号id + * 删除：Code索引 + * @param clientId 应用id + * @param loginId 账号id */ public void deleteCodeIndex(String clientId, Object loginId) { - SaManager.getSaTokenDao().delete(splicingCodeIndexKey(clientId, loginId)); + SaManager.getSaTokenDao().delete(splicingCodeIndexKey(clientId, loginId)); } /** - * 删除：Access-Token - * @param accessToken 值 + * 删除：Access-Token + * @param accessToken 值 */ public void deleteAccessToken(String accessToken) { if(accessToken != null) { @@ -739,16 +739,16 @@ public class SaOAuth2Template { } } /** - * 删除：Access-Token索引 - * @param clientId 应用id - * @param loginId 账号id + * 删除：Access-Token索引 + * @param clientId 应用id + * @param loginId 账号id */ public void deleteAccessTokenIndex(String clientId, Object loginId) { - SaManager.getSaTokenDao().delete(splicingAccessTokenIndexKey(clientId, loginId)); + SaManager.getSaTokenDao().delete(splicingAccessTokenIndexKey(clientId, loginId)); } /** - * 删除：Refresh-Token - * @param refreshToken 值 + * 删除：Refresh-Token + * @param refreshToken 值 */ public void deleteRefreshToken(String refreshToken) { if(refreshToken != null) { @@ -756,16 +756,16 @@ public class SaOAuth2Template { } } /** - * 删除：Refresh-Token索引 - * @param clientId 应用id - * @param loginId 账号id + * 删除：Refresh-Token索引 + * @param clientId 应用id + * @param loginId 账号id */ public void deleteRefreshTokenIndex(String clientId, Object loginId) { - SaManager.getSaTokenDao().delete(splicingRefreshTokenIndexKey(clientId, loginId)); + SaManager.getSaTokenDao().delete(splicingRefreshTokenIndexKey(clientId, loginId)); } /** - * 删除：Client-Token - * @param clientToken 值 + * 删除：Client-Token + * @param clientToken 值 */ public void deleteClientToken(String clientToken) { if(clientToken != null) { @@ -773,80 +773,80 @@ public class SaOAuth2Template { } } /** - * 删除：Client-Token索引 - * @param clientId 应用id + * 删除：Client-Token索引 + * @param clientId 应用id */ public void deleteClientTokenIndex(String clientId) { - SaManager.getSaTokenDao().delete(splicingClientTokenIndexKey(clientId)); + SaManager.getSaTokenDao().delete(splicingClientTokenIndexKey(clientId)); } /** - * 删除：Past-Token索引 - * @param clientId 应用id + * 删除：Past-Token索引 + * @param clientId 应用id */ public void deletePastTokenIndex(String clientId) { - SaManager.getSaTokenDao().delete(splicingPastTokenIndexKey(clientId)); + SaManager.getSaTokenDao().delete(splicingPastTokenIndexKey(clientId)); } /** - * 删除：用户授权记录 - * @param clientId 应用id - * @param loginId 账号id + * 删除：用户授权记录 + * @param clientId 应用id + * @param loginId 账号id */ public void deleteGrantScope(String clientId, Object loginId) { - SaManager.getSaTokenDao().delete(splicingGrantScopeKey(clientId, loginId)); + SaManager.getSaTokenDao().delete(splicingGrantScopeKey(clientId, loginId)); } - - // ------------------- Random数据 + + // ------------------- Random数据 /** - * 随机一个 Code - * @param clientId 应用id - * @param loginId 账号id + * 随机一个 Code + * @param clientId 应用id + * @param loginId 账号id * @param scope 权限 - * @return Code + * @return Code */ public String randomCode(String clientId, Object loginId, String scope) { - return SaFoxUtil.getRandomString(60); + return SaFoxUtil.getRandomString(60); } /** - * 随机一个 Access-Token - * @param clientId 应用id - * @param loginId 账号id + * 随机一个 Access-Token + * @param clientId 应用id + * @param loginId 账号id * @param scope 权限 - * @return Access-Token + * @return Access-Token */ public String randomAccessToken(String clientId, Object loginId, String scope) { return SaFoxUtil.getRandomString(60); } /** - * 随机一个 Refresh-Token - * @param clientId 应用id - * @param loginId 账号id + * 随机一个 Refresh-Token + * @param clientId 应用id + * @param loginId 账号id * @param scope 权限 - * @return Refresh-Token + * @return Refresh-Token */ public String randomRefreshToken(String clientId, Object loginId, String scope) { return SaFoxUtil.getRandomString(60); } /** - * 随机一个 Client-Token - * @param clientId 应用id + * 随机一个 Client-Token + * @param clientId 应用id * @param scope 权限 - * @return Client-Token + * @return Client-Token */ public String randomClientToken(String clientId, String scope) { return SaFoxUtil.getRandomString(60); } - - // ------------------- 拼接key - /** - * 拼接key：Code持久化 + + // ------------------- 拼接key + /** + * 拼接key：Code持久化 * @param code 授权码 * @return key */ public String splicingCodeSaveKey(String code) { return SaManager.getConfig().getTokenName() + ":oauth2:code:" + code; } - /** - * 拼接key：Code索引 + /** + * 拼接key：Code索引 * @param clientId 应用id * @param loginId 账号id * @return key @@ -854,16 +854,16 @@ public class SaOAuth2Template { public String splicingCodeIndexKey(String clientId, Object loginId) { return SaManager.getConfig().getTokenName() + ":oauth2:code-index:" + clientId + ":" + loginId; } - /** - * 拼接key：Access-Token持久化 + /** + * 拼接key：Access-Token持久化 * @param accessToken accessToken * @return key */ public String splicingAccessTokenSaveKey(String accessToken) { return SaManager.getConfig().getTokenName() + ":oauth2:access-token:" + accessToken; } - /** - * 拼接key：Access-Token索引 + /** + * 拼接key：Access-Token索引 * @param clientId 应用id * @param loginId 账号id * @return key @@ -871,16 +871,16 @@ public class SaOAuth2Template { public String splicingAccessTokenIndexKey(String clientId, Object loginId) { return SaManager.getConfig().getTokenName() + ":oauth2:access-token-index:" + clientId + ":" + loginId; } - /** - * 拼接key：Refresh-Token持久化 + /** + * 拼接key：Refresh-Token持久化 * @param refreshToken refreshToken * @return key */ public String splicingRefreshTokenSaveKey(String refreshToken) { return SaManager.getConfig().getTokenName() + ":oauth2:refresh-token:" + refreshToken; } - /** - * 拼接key：Refresh-Token索引 + /** + * 拼接key：Refresh-Token索引 * @param clientId 应用id * @param loginId 账号id * @return key @@ -888,38 +888,38 @@ public class SaOAuth2Template { public String splicingRefreshTokenIndexKey(String clientId, Object loginId) { return SaManager.getConfig().getTokenName() + ":oauth2:refresh-token-index:" + clientId + ":" + loginId; } - /** - * 拼接key：Client-Token持久化 + /** + * 拼接key：Client-Token持久化 * @param clientToken clientToken * @return key */ public String splicingClientTokenSaveKey(String clientToken) { return SaManager.getConfig().getTokenName() + ":oauth2:client-token:" + clientToken; } - /** - * 拼接key：Past-Token 索引 - * @param clientId clientId + /** + * 拼接key：Past-Token 索引 + * @param clientId clientId * @return key */ public String splicingClientTokenIndexKey(String clientId) { return SaManager.getConfig().getTokenName() + ":oauth2:client-token-indedx:" + clientId; } - /** - * 拼接key：Past-Token 索引 - * @param clientId clientId - * @return key + /** + * 拼接key：Past-Token 索引 + * @param clientId clientId + * @return key */ public String splicingPastTokenIndexKey(String clientId) { return SaManager.getConfig().getTokenName() + ":oauth2:past-token-indedx:" + clientId; } - /** - * 拼接key：用户授权记录 + /** + * 拼接key：用户授权记录 * @param clientId 应用id * @param loginId 账号id - * @return key + * @return key */ public String splicingGrantScopeKey(String clientId, Object loginId) { return SaManager.getConfig().getTokenName() + ":oauth2:grant-scope:" + clientId + ":" + loginId; } - + }