lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2026-02-27 16:50:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat(sso): 新增 SSO Strategy 策略类

Browse Source
This commit is contained in:
click33
2025-05-03 12:04:14 +08:00
parent 1d9b730685
commit 6e9bb2b31a
15 changed files with 217 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/config/SaSsoClientConfig.java
View File

@@ -16,7 +16,6 @@
package cn.dev33.satoken.sso.config;
import cn.dev33.satoken.sso.function.TicketResultHandleFunction;
import cn.dev33.satoken.util.SaFoxUtil;
import java.io.Serializable;
@@ -133,16 +132,6 @@ public class SaSsoClientConfig implements Serializable {
}
// -------------------- 所有回调函数 --------------------
/**
* SSO-Client端：自定义校验 ticket 返回值的处理逻辑 （每次从认证中心获取校验 ticket 的结果后调用）
* <p> 参数：loginId, back
* <p> 返回值：返回给前端的值
*/
public TicketResultHandleFunction ticketResultHandle = null;
// get set
/**

30
sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/config/SaSsoServerConfig.java
View File

@@ -16,12 +16,8 @@
package cn.dev33.satoken.sso.config;
import cn.dev33.satoken.sso.function.CheckTicketAppendDataFunction;
import cn.dev33.satoken.sso.function.DoLoginHandleFunction;
import cn.dev33.satoken.sso.function.NotLoginViewFunction;
import cn.dev33.satoken.sso.template.SaSsoServerTemplate;
import cn.dev33.satoken.util.SaFoxUtil;
import cn.dev33.satoken.util.SaResult;
import java.io.Serializable;
import java.util.LinkedHashMap;
@@ -122,31 +118,6 @@ public class SaSsoServerConfig implements Serializable {
}
// -------------------- 所有回调函数 --------------------
/**
* SSO-Server端：未登录时返回的View
*/
public NotLoginViewFunction notLoginView = () -> {
return "当前会话在SSO-Server认证中心尚未登录（当前未配置登录视图）";
};
/**
* SSO-Server端：登录函数
*/
public DoLoginHandleFunction doLoginHandle = (name, pwd) -> {
return SaResult.error();
};
/**
* SSO-Server端：在校验 ticket 后，给 sso-client 端追加返回信息的函数
*/
public CheckTicketAppendDataFunction checkTicketAppendData = (loginId, result) -> {
return result;
};
// get set
/**
@@ -363,5 +334,4 @@ public class SaSsoServerConfig implements Serializable {
+ "]";
}
}

2
sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/message/handle/server/SaSsoMessageCheckTicketHandle.java
View File

@@ -94,7 +94,7 @@ public class SaSsoMessageCheckTicketHandle implements SaSsoMessageHandle {
result.set(paramName.remainTokenTimeout, stpLogic.getTokenTimeout(ticketModel.getTokenValue()));
result.set(paramName.remainSessionTimeout, stpLogic.getSessionTimeoutByLoginId(loginId));
result = ssoServerConfig.checkTicketAppendData.apply(loginId, result);
result = ssoServerTemplate.strategy.checkTicketAppendData.apply(loginId, result);
return result;
}

4
sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/processor/SaSsoClientProcessor.java
View File

@@ -138,8 +138,8 @@ public class SaSsoClientProcessor {
SaCheckTicketResult ctr = checkTicket(ticket, apiName.ssoLogin);
// 2、如果开发者自定义了ticket结果值处理函数，则使用自定义的函数
if(cfg.ticketResultHandle != null) {
return cfg.ticketResultHandle.run(ctr, back);
if(ssoClientTemplate.strategy.ticketResultHandle != null) {
return ssoClientTemplate.strategy.ticketResultHandle.run(ctr, back);
}
// 3、登录并重定向至back地址

4
sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/processor/SaSsoServerProcessor.java
View File

@@ -107,7 +107,7 @@ public class SaSsoServerProcessor {
// ---------- 此处有两种情况分开处理：
// ---- 情况1：在SSO认证中心尚未登录，需要先去登录
if( ! stpLogic.isLogin()) {
return cfg.notLoginView.get();
return ssoServerTemplate.strategy.notLoginView.get();
}
// ---- 情况2：在SSO认证中心已经登录，需要重定向回 Client 端，而这又分为两种方式：
String mode = req.getParam(paramName.mode, SaSsoConsts.MODE_TICKET);
@@ -155,7 +155,7 @@ public class SaSsoServerProcessor {
ParamName paramName = ssoServerTemplate.paramName;
// 处理
return cfg.doLoginHandle.apply(req.getParam(paramName.name), req.getParam(paramName.pwd));
return ssoServerTemplate.strategy.doLoginHandle.apply(req.getParam(paramName.name), req.getParam(paramName.pwd));
}
/**

44
sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/strategy/SaSsoClientStrategy.java Normal file
View File

@@ -0,0 +1,44 @@
/*
* Copyright 2020-2099 sa-token.cc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cn.dev33.satoken.sso.strategy;
import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.sso.function.SendHttpFunction;
import cn.dev33.satoken.sso.function.TicketResultHandleFunction;
/**
* Sa-Token SSO Client 相关策略
*
* @author click33
* @since 1.43.0
*/
public class SaSsoClientStrategy {
/**
* 发送 Http 请求的处理函数
*/
public SendHttpFunction sendHttp = url -> {
return SaManager.getSaHttpTemplate().get(url);
};
/**
* SSO-Client端：自定义校验 ticket 返回值的处理逻辑 （每次从认证中心获取校验 ticket 的结果后调用）
* <p> 参数：loginId, back
* <p> 返回值：返回给前端的值
*/
public TicketResultHandleFunction ticketResultHandle = null;
}

61
sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/strategy/SaSsoServerStrategy.java Normal file
View File

@@ -0,0 +1,61 @@
/*
* Copyright 2020-2099 sa-token.cc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cn.dev33.satoken.sso.strategy;
import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.sso.function.CheckTicketAppendDataFunction;
import cn.dev33.satoken.sso.function.DoLoginHandleFunction;
import cn.dev33.satoken.sso.function.NotLoginViewFunction;
import cn.dev33.satoken.sso.function.SendHttpFunction;
import cn.dev33.satoken.util.SaResult;
/**
* Sa-Token SSO Server 相关策略
*
* @author click33
* @since 1.43.0
*/
public class SaSsoServerStrategy {
/**
* 发送 Http 请求的处理函数
*/
public SendHttpFunction sendHttp = url -> {
return SaManager.getSaHttpTemplate().get(url);
};
/**
* 未登录时返回的 View
*/
public NotLoginViewFunction notLoginView = () -> {
return "当前会话在 SSO-Server 认证中心尚未登录（当前未配置登录视图）";
};
/**
* SSO-Server端：登录函数
*/
public DoLoginHandleFunction doLoginHandle = (name, pwd) -> {
return SaResult.error();
};
/**
* SSO-Server端：在校验 ticket 后，给 sso-client 端追加返回信息的函数
*/
public CheckTicketAppendDataFunction checkTicketAppendData = (loginId, result) -> {
return result;
};
}

24
sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/template/SaSsoClientTemplate.java
View File

@@ -24,6 +24,7 @@ import cn.dev33.satoken.sso.error.SaSsoErrorCode;
import cn.dev33.satoken.sso.exception.SaSsoException;
import cn.dev33.satoken.sso.message.SaSsoMessage;
import cn.dev33.satoken.sso.message.handle.client.SaSsoMessageLogoutCallHandle;
import cn.dev33.satoken.sso.strategy.SaSsoClientStrategy;
import cn.dev33.satoken.sso.util.SaSsoConsts;
import cn.dev33.satoken.stp.parameter.SaLogoutParameter;
import cn.dev33.satoken.util.SaFoxUtil;
@@ -39,12 +40,16 @@ import java.util.Map;
*/
public class SaSsoClientTemplate extends SaSsoTemplate {
/**
* Client 相关策略
*/
public SaSsoClientStrategy strategy = new SaSsoClientStrategy();
public SaSsoClientTemplate() {
super.messageHolder.addHandle(new SaSsoMessageLogoutCallHandle());
}
// ------------------- SSO 模式三相关 -------------------
/**
@@ -65,7 +70,7 @@ public class SaSsoClientTemplate extends SaSsoTemplate {
*/
public Object getData(String path, Map<String, Object> paramMap) {
String url = buildCustomPathUrl(path, paramMap);
return request(url);
return strategy.sendHttp.apply(url);
}
// ---------------------- 构建URL ----------------------
@@ -88,7 +93,6 @@ public class SaSsoClientTemplate extends SaSsoTemplate {
serverUrl = SaFoxUtil.joinParam(serverUrl, paramName.client, client);
}
// 对back地址编码
back = (back == null ? "" : back);
back = SaFoxUtil.encodeUrl(back);
@@ -179,6 +183,18 @@ public class SaSsoClientTemplate extends SaSsoTemplate {
// ------------------- 消息推送 -------------------
/**
* 发送 Http 请求，并将响应结果转换为 SaResult
*
* @param url 请求地址
* @return 返回的结果
*/
public SaResult requestAsSaResult(String url) {
String body = strategy.sendHttp.apply(url);
Map<String, Object> map = SaManager.getSaJsonTemplate().jsonToMap(body);
return new SaResult(map);
}
/**
* 向 sso-server 推送消息
*
@@ -199,7 +215,7 @@ public class SaSsoClientTemplate extends SaSsoTemplate {
// 发起请求
String finalUrl = SaFoxUtil.joinParam(pushUrl, paramsStr);
return request(finalUrl);
return strategy.sendHttp.apply(finalUrl);
}
/**

22
sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/template/SaSsoServerTemplate.java
View File

@@ -29,6 +29,7 @@ import cn.dev33.satoken.sso.message.handle.server.SaSsoMessageCheckTicketHandle;
import cn.dev33.satoken.sso.message.handle.server.SaSsoMessageSignoutHandle;
import cn.dev33.satoken.sso.model.SaSsoClientInfo;
import cn.dev33.satoken.sso.model.TicketModel;
import cn.dev33.satoken.sso.strategy.SaSsoServerStrategy;
import cn.dev33.satoken.sso.util.SaSsoConsts;
import cn.dev33.satoken.stp.parameter.SaLogoutParameter;
import cn.dev33.satoken.strategy.SaStrategy;
@@ -45,6 +46,11 @@ import java.util.*;
*/
public class SaSsoServerTemplate extends SaSsoTemplate {
/**
* Server 相关策略
*/
public SaSsoServerStrategy strategy = new SaSsoServerStrategy();
public SaSsoServerTemplate() {
super.messageHolder.addHandle(new SaSsoMessageCheckTicketHandle());
super.messageHolder.addHandle(new SaSsoMessageSignoutHandle());
@@ -634,12 +640,24 @@ public class SaSsoServerTemplate extends SaSsoTemplate {
String finalUrl = SaFoxUtil.joinParam(sloCallUrl, signParamsStr);
// 发起请求
request(finalUrl);
strategy.sendHttp.apply(finalUrl);
}
// ------------------- 消息推送 -------------------
/**
* 发送 Http 请求，并将响应结果转换为 SaResult
*
* @param url 请求地址
* @return 返回的结果
*/
public SaResult requestAsSaResult(String url) {
String body = strategy.sendHttp.apply(url);;
Map<String, Object> map = SaManager.getSaJsonTemplate().jsonToMap(body);
return new SaResult(map);
}
/**
* 向指定 Client 推送消息
* @param clientModel /
@@ -651,7 +669,7 @@ public class SaSsoServerTemplate extends SaSsoTemplate {
String noticeUrl = clientModel.splicingNoticeUrl();
String paramsStr = getSignTemplate(clientModel.getClient()).addSignParamsAndJoin(message);
String finalUrl = SaFoxUtil.joinParam(noticeUrl, paramsStr);
return request(finalUrl);
return strategy.sendHttp.apply(finalUrl);
}
/**

30
sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/template/SaSsoTemplate.java
View File

@@ -76,27 +76,15 @@ public class SaSsoTemplate {
public SaSsoMessageHolder messageHolder = new SaSsoMessageHolder();
/**
* 发送 Http 请求
*
* @param url /
* @return /
*/
public String request(String url) {
return SaManager.getSaHttpTemplate().get(url);
}
/**
* 发送 Http 请求，并将响应结果转换为 SaResult
*
* @param url 请求地址
* @return 返回的结果
*/
public SaResult requestAsSaResult(String url) {
String body = request(url);
Map<String, Object> map = SaManager.getSaJsonTemplate().jsonToMap(body);
return new SaResult(map);
}
// /**
// * 发送 Http 请求
// *
// * @param url /
// * @return /
// */
// public String request(String url) {
// return SaManager.getSaHttpTemplate().get(url);
// }
/**
* 处理指定消息