sa-token/sa-token-doc/sso/sso-type2.md

305 lines
11 KiB
Markdown
Raw Normal View History

2021-06-26 23:30:29 +08:00
# SSO模式二 URL重定向传播会话
2021-08-29 23:52:45 +08:00
如果我们的多个系统部署在不同的域名之下但是后端可以连接同一个Redis那么便可以使用 **`[URL重定向传播会话]`** 的方式做到单点登录。
2021-06-26 23:30:29 +08:00
### 1、解题思路
2021-06-26 23:30:29 +08:00
2021-08-29 23:52:45 +08:00
首先我们再次复习一下,多个系统之间为什么无法同步登录状态?
2021-06-26 23:30:29 +08:00
2021-08-29 23:52:45 +08:00
1. 前端的`Token`无法在多个系统下共享。
2. 后端的`Session`无法在多个系统间共享。
2021-06-26 23:30:29 +08:00
2021-08-29 23:52:45 +08:00
关于第二点,我们已在 "SSO模式一" 章节中阐述,使用 [Alone独立Redis插件](/plugin/alone-redis) 做到权限缓存直连 SSO-Redis 数据中心,在此不再赘述。
2021-06-26 23:30:29 +08:00
2021-08-29 23:52:45 +08:00
而第一点,才是我们解决问题的关键所在,在跨域模式下,意味着 "共享Cookie方案" 的失效我们必须采用一种新的方案来传递Token。
2021-06-26 23:30:29 +08:00
2021-08-29 23:52:45 +08:00
1. 用户在 子系统 点击 `[登录]` 按钮。
2. 用户跳转到子系统登录接口 `/sso/login`,并携带 `back参数` 记录初始页面URL。
- 形如:`http://{sso-client}/sso/login?back=xxx`
3. 子系统检测到此用户尚未登录再次将其重定向至SSO认证中心并携带`redirect参数`记录子系统的登录页URL。
- 形如:`http://{sso-server}/sso/auth?redirect=xxx?back=xxx`
4. 用户进入了 SSO认证中心 的登录页面,开始登录。
5. 用户 输入账号密码 并 登录成功SSO认证中心再次将用户重定向至子系统的登录接口`/sso/login`,并携带`ticket码`参数。
- 形如:`http://{sso-client}/sso/login?back=xxx&ticket=xxxxxxxxx`
6. 子系统根据 `ticket码``SSO-Redis` 中获取账号id并在子系统登录此账号会话。
7. 子系统将用户再次重定向至最初始的 `back` 页面。
2021-06-26 23:30:29 +08:00
2021-08-29 23:52:45 +08:00
整个过程除了第四步用户在SSO认证中心登录时会被打断其余过程均是自动化的当用户在另一个子系统再次点击`[登录]`按钮由于此用户在SSO认证中心已有会话存在
2021-06-26 23:30:29 +08:00
所以第四步也将自动化,也就是单点登录的最终目的 —— 一次登录,处处通行。
2022-05-09 17:35:29 +08:00
<button class="show-img" img-src="https://oss.dev33.cn/sa-token/doc/g/g3--sso2.gif">加载动态演示图</button>
2021-08-29 23:52:45 +08:00
下面我们按照步骤依次完成上述过程:
2021-06-26 23:30:29 +08:00
### 2、准备工作
2021-07-23 02:13:44 +08:00
首先修改hosts文件`(C:\windows\system32\drivers\etc\hosts)`添加以下IP映射方便我们进行测试
``` url
127.0.0.1 sa-sso-server.com
127.0.0.1 sa-sso-client1.com
127.0.0.1 sa-sso-client2.com
127.0.0.1 sa-sso-client3.com
```
2021-06-26 23:30:29 +08:00
### 3、搭建 Client 端项目
2021-07-23 02:13:44 +08:00
> 搭建示例在官方仓库的 `/sa-token-demo/sa-token-demo-sso2-client/`,如遇到难点可结合源码进行测试学习
2021-06-26 23:30:29 +08:00
#### 3.1、去除 SSO-Server 的 Cookie 作用域配置
在SSO模式一章节中我们打开了配置
<!---------------------------- tabs:start ---------------------------->
<!------------- tab:yaml 风格 ------------->
``` yaml
2021-07-01 15:15:54 +08:00
sa-token:
cookie:
# 配置 Cookie 作用域
domain: stp.com
```
<!------------- tab:properties 风格 ------------->
``` properties
# 配置 Cookie 作用域
sa-token.cookie.domain=stp.com
2021-06-26 23:30:29 +08:00
```
<!---------------------------- tabs:end ---------------------------->
2021-06-26 23:30:29 +08:00
此为模式一专属配置,现在我们将其注释掉
2021-06-26 23:30:29 +08:00
#### 3.2、创建 SSO-Client 端项目
创建一个 SpringBoot 项目 `sa-token-demo-sso2-client`,引入依赖:
<!---------------------------- tabs:start ---------------------------->
<!-------- tab:Maven 方式 -------->
``` xml
2022-10-21 11:27:29 +08:00
<!-- Sa-Token 权限认证, 在线文档https://sa-token.cc -->
2021-06-26 23:30:29 +08:00
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-boot-starter</artifactId>
2021-07-08 01:59:49 +08:00
<version>${sa.top.version}</version>
2021-06-26 23:30:29 +08:00
</dependency>
2022-05-06 10:31:46 +08:00
<!-- Sa-Token 插件整合SSO -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-sso</artifactId>
<version>${sa.top.version}</version>
</dependency>
2021-06-26 23:30:29 +08:00
<!-- Sa-Token 整合redis (使用jackson序列化方式) -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-dao-redis-jackson</artifactId>
2021-07-08 01:59:49 +08:00
<version>${sa.top.version}</version>
2021-06-26 23:30:29 +08:00
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
<!-- Sa-Token插件权限缓存与业务缓存分离 -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-alone-redis</artifactId>
2021-07-08 01:59:49 +08:00
<version>${sa.top.version}</version>
2021-06-26 23:30:29 +08:00
</dependency>
```
<!-------- tab:Gradle 方式 -------->
``` gradle
2022-10-21 11:27:29 +08:00
// Sa-Token 权限认证在线文档https://sa-token.cc
implementation 'cn.dev33:sa-token-spring-boot-starter:${sa.top.version}'
// Sa-Token 插件整合SSO
implementation 'cn.dev33:sa-token-sso:${sa.top.version}'
// Sa-Token 整合 Redis (使用 jackson 序列化方式)
implementation 'cn.dev33:sa-token-dao-redis-jackson:${sa.top.version}'
implementation 'org.apache.commons:commons-pool2'
// Sa-Token插件权限缓存与业务缓存分离
implementation 'cn.dev33:sa-token-alone-redis:${sa.top.version}'
```
<!---------------------------- tabs:end ---------------------------->
2021-06-26 23:30:29 +08:00
#### 3.3、创建 SSO-Client 端认证接口
2021-08-29 23:52:45 +08:00
同 SSO-Server 一样Sa-Token 为 SSO-Client 端所需代码也提供了完整的封装,你只需提供一个访问入口,接入 Sa-Token 的方法即可。
2021-06-26 23:30:29 +08:00
``` java
/**
* Sa-Token-SSO Client端 Controller
*/
@RestController
public class SsoClientController {
2021-08-29 23:52:45 +08:00
// 首页
2021-06-26 23:30:29 +08:00
@RequestMapping("/")
public String index() {
String str = "<h2>Sa-Token SSO-Client 应用端</h2>" +
"<p>当前会话是否登录:" + StpUtil.isLogin() + "</p>" +
2021-07-09 02:31:34 +08:00
"<p><a href=\"javascript:location.href='/sso/login?back=' + encodeURIComponent(location.href);\">登录</a> " +
2021-08-16 02:12:02 +08:00
"<a href='/sso/logout?back=self'>注销</a></p>";
2021-06-26 23:30:29 +08:00
return str;
}
2021-08-29 23:52:45 +08:00
/*
* SSO-Client端处理所有SSO相关请求
* http://{host}:{port}/sso/login -- Client端登录地址接受参数back=登录后的跳转地址
* http://{host}:{port}/sso/logout -- Client端单点注销地址isSlo=true时打开接受参数back=注销后的跳转地址
* http://{host}:{port}/sso/logoutCall -- Client端单点注销回调地址isSlo=true时打开此接口为框架回调开发者无需关心
*/
2021-07-09 02:31:34 +08:00
@RequestMapping("/sso/*")
2021-07-08 01:24:42 +08:00
public Object ssoRequest() {
return SaSsoHandle.clientRequest();
2021-06-29 23:32:35 +08:00
}
2021-07-08 01:24:42 +08:00
2021-06-26 23:30:29 +08:00
}
```
##### 3.4、配置SSO认证中心地址
2021-06-26 23:30:29 +08:00
你需要在 `application.yml` 配置如下信息:
<!---------------------------- tabs:start ---------------------------->
<!------------- tab:yaml 风格 ------------->
``` yaml
2021-06-26 23:30:29 +08:00
# 端口
server:
port: 9001
2021-07-01 15:15:54 +08:00
# sa-token配置
sa-token:
# SSO-相关配置
sso:
# SSO-Server端 统一认证地址
auth-url: http://sa-sso-server.com:9000/sso/auth
2021-07-08 01:24:42 +08:00
# 是否打开单点注销接口
is-slo: true
# 配置Sa-Token单独使用的Redis连接 此处需要和SSO-Server端连接同一个Redis
alone-redis:
# Redis数据库索引 (默认为0)
database: 1
# Redis服务器地址
host: 127.0.0.1
# Redis服务器连接端口
port: 6379
# Redis服务器连接密码默认为空
password:
# 连接超时时间
timeout: 10s
2021-06-26 23:30:29 +08:00
```
<!------------- tab:properties 风格 ------------->
``` properties
# 端口
server.port=9001
######### Sa-Token 配置 #########
# SSO-Server端 统一认证地址
sa-token.sso.auth-url=http://sa-sso-server.com:9000/sso/auth
# 是否打开单点注销接口
sa-token.sso.is-slo=true
# 配置 Sa-Token 单独使用的Redis连接 此处需要和SSO-Server端连接同一个Redis
# Redis数据库索引
sa-token.alone-redis.database=1
# Redis服务器地址
sa-token.alone-redis.host=127.0.0.1
# Redis服务器连接端口
sa-token.alone-redis.port=6379
# Redis服务器连接密码默认为空
sa-token.alone-redis.password=
# 连接超时时间
sa-token.alone-redis.timeout=10s
```
<!---------------------------- tabs:end ---------------------------->
2021-07-01 15:15:54 +08:00
注意点:`sa-token.alone-redis` 的配置需要和SSO-Server端连接同一个Redisdatabase也要一样
2021-06-26 23:30:29 +08:00
#### 3.5、写启动类
2021-06-26 23:30:29 +08:00
``` java
@SpringBootApplication
public class SaSsoClientApplication {
public static void main(String[] args) {
SpringApplication.run(SaSsoClientApplication.class, args);
System.out.println("\nSa-Token-SSO Client端启动成功");
}
}
```
启动项目
2021-07-23 02:13:44 +08:00
### 4、测试访问
2021-06-26 23:30:29 +08:00
2021-08-29 23:52:45 +08:00
(1) 依次启动 `SSO-Server``SSO-Client`,然后从浏览器访问:[http://sa-sso-client1.com:9001/](http://sa-sso-client1.com:9001/)
2021-06-26 23:30:29 +08:00
![sso-client-index.png](https://oss.dev33.cn/sa-token/doc/sso/sso-client-index.png 's-w-sh')
(2) 首次打开,提示当前未登录,我们点击**`登录`** 按钮,页面会被重定向到登录中心
![sso-server-auth.png](https://oss.dev33.cn/sa-token/doc/sso/sso-server-auth.png 's-w-sh')
(3) SSO-Server提示我们在认证中心尚未登录我们点击 **`doLogin登录`**按钮进行模拟登录
![sso-server-dologin.png](https://oss.dev33.cn/sa-token/doc/sso/sso-server-dologin.png 's-w-sh')
(4) SSO-Server认证中心登录成功我们回到刚才的页面刷新页面
![sso-client-index-ok.png](https://oss.dev33.cn/sa-token/doc/sso/sso-client-index-ok.png 's-w-sh')
(5) 页面被重定向至`Client`端首页,并提示登录成功,至此,`Client1`应用已单点登录成功!
(6) 我们再次访问`Client2`[http://sa-sso-client2.com:9001/](http://sa-sso-client2.com:9001/)
![sso-client2-index.png](https://oss.dev33.cn/sa-token/doc/sso/sso-client2-index.png 's-w-sh')
(7) 提示未登录,我们点击**`登录`**按钮,会直接提示登录成功
![sso-client2-index-ok.png](https://oss.dev33.cn/sa-token/doc/sso/sso-client2-index-ok.png 's-w-sh')
(8) 同样的方式,我们打开`Client3`,也可以直接登录成功:[http://sa-sso-client3.com:9001/](http://sa-sso-client3.com:9001/)
![sso-client3-index-ok.png](https://oss.dev33.cn/sa-token/doc/sso/sso-client3-index-ok.png 's-w-sh')
至此,测试完毕!
2021-10-18 22:05:26 +08:00
可以看出,除了在`Client1`端我们需要手动登录一次之外,在`Client2端`和`Client3端`都是可以无需再次认证,直接登录成功的。
2021-06-26 23:30:29 +08:00
我们可以通过 F12控制台 Netword跟踪整个过程
![sso-genzong](https://oss.dev33.cn/sa-token/doc/sso/sso-genzong.png 's-w-sh')
<!--
2021-07-23 02:13:44 +08:00
### 5、运行官方仓库
2021-06-26 23:30:29 +08:00
以上示例,虽然完整的复现了单点登录的过程,但是页面还是有些简陋,我们可以运行一下官方仓库的示例,里面有制作好的登录页面
2021-08-26 23:17:39 +08:00
> 下载官方示例,依次运行:
> - `/sa-token-demo/sa-token-demo-sso2-server/`
> - `/sa-token-demo/sa-token-demo-sso2-client/`
>
> 然后访问:
> - [http://sa-sso-client1.com:9001/](http://sa-sso-client1.com:9001/)
2021-06-26 23:30:29 +08:00
![sso-server-login-hua](https://oss.dev33.cn/sa-token/doc/sso/sso-server-login-hua.png 's-w-sh')
默认测试密码:`sa / 123456`,其余流程保持不变
-->
2021-06-26 23:30:29 +08:00
### 5、跨 Redis 的单点登录
2021-06-29 23:32:35 +08:00
以上流程解决了跨域模式下的单点登录但是后端仍然采用了共享Redis来同步会话如果我们的架构设计中Client端与Server端无法共享Redis又该怎么完成单点登录
2021-08-24 02:05:16 +08:00
这就要采用模式三了,且往下看:[SSO模式三Http请求获取会话](/sso/sso-type3)
2021-06-29 23:32:35 +08:00
2021-07-08 01:24:42 +08:00
2021-06-26 23:30:29 +08:00