1
0
mirror of https://github.com/Snailclimb/JavaGuide synced 2025-06-16 18:10:13 +08:00

[docs update] SSO 单点登录排版完善

This commit is contained in:
guide 2022-08-08 09:52:18 +08:00
parent 5f828a0060
commit 8dba9eb7c0

View File

@ -6,13 +6,12 @@ tag:
---
> 本文授权转载自 https://ken.io/note/sso-design-implement 作者ken.io
>
## 一、前言
## SSO 介绍
### 1、SSO说明
### 什么是 SSO
SSO英文全称Single Sign On单点登录。SSO是在多个应用系统中用户只需要登录一次就可以访问所有相互信任的应用系统。https://baike.baidu.com/item/SSO/3451380
SSO 英文全称 Single Sign On单点登录。SSO 是在多个应用系统中用户只需要登录一次就可以访问所有相互信任的应用系统。https://baike.baidu.com/item/SSO/3451380
例如访问在网易账号中心https://reg.163.com/ )登录之后
访问以下站点都是登录状态
@ -21,17 +20,17 @@ SSO英文全称Single Sign On单点登录。SSO是在多个应用系统中
- 网易博客 [https://blog.163.com](https://blog.163.com/)
- 网易花田 [https://love.163.com](https://love.163.com/)
- 网易考拉 [https://www.kaola.com](https://www.kaola.com/)
- 网易Lofter [http://www.lofter.com](http://www.lofter.com/)
- 网易 Lofter [http://www.lofter.com](http://www.lofter.com/)
### 2、单点登录系统的好处
### SSO 有什么好处?
1. **用户角度** :用户能够做到一次登录多次使用,无需记录多套用户名和密码,省心。
2. **系统管理员角度** : 管理员只需维护好一个统一的账号中心就可以了,方便。
3. **新系统开发角度:** 新系统开发时只需直接对接统一的账号中心即可,简化开发流程,省时。
### 3、设计目标
## SSO 设计与实现
本篇文章也主要是为了探讨如何设计&实现一个SSO系统
本篇文章也主要是为了探讨如何设计&实现一个 SSO 系统
以下为需要实现的核心功能:
@ -40,88 +39,85 @@ SSO英文全称Single Sign On单点登录。SSO是在多个应用系统中
- 支持跨域单点登录
- 支持跨域单点登出
## 二、SSO设计与实现
### 核心应用与依赖
### 1、核心应用与依赖
![单点登录SSO设计](https://guide-blog-images.oss-cn-shenzhen.aliyuncs.com/github/javaguide/system-design/security/sso/sso-system.png-kblb.png)
![单点登录SSO设计](https://img.ken.io/blog/sso/sso-system.png-kblb.png)
| 应用/模块/对象 | 说明 |
| ----------------- | ----------------------------------- |
| 前台站点 | 需要登录的站点 |
| SSO 站点-登录 | 提供登录的页面 |
| SSO 站点-登出 | 提供注销登录的入口 |
| SSO 服务-登录 | 提供登录服务 |
| SSO 服务-登录状态 | 提供登录状态校验/登录信息查询的服务 |
| SSO 服务-登出 | 提供用户注销登录的服务 |
| 数据库 | 存储用户账户信息 |
| 缓存 | 存储用户的登录信息,通常使用 Redis |
| 应用/模块/对象 | 说明 |
| ---------------- | ----------------------------------- |
| 前台站点 | 需要登录的站点 |
| SSO站点-登录 | 提供登录的页面 |
| SSO站点-登出 | 提供注销登录的入口 |
| SSO服务-登录 | 提供登录服务 |
| SSO服务-登录状态 | 提供登录状态校验/登录信息查询的服务 |
| SSO服务-登出 | 提供用户注销登录的服务 |
| 数据库 | 存储用户账户信息 |
| 缓存 | 存储用户的登录信息通常使用Redis |
### 用户登录状态的存储与校验
### 2、用户登录状态的存储与校验
常见的 Web 框架对于 Session 的实现都是生成一个 SessionId 存储在浏览器 Cookie 中。然后将 Session 内容存储在服务器端内存中,这个 [ken.io](https://ken.io/) 在之前[Session 工作原理](https://ken.io/note/session-principle-skill)中也提到过。整体也是借鉴这个思路。
常见的Web框架对于[Session](https://ken.io/note/session-principle-skill)的实现都是生成一个SessionId存储在浏览器Cookie中。然后将Session内容存储在服务器端内存中这个 ken.io 在之前[Session工作原理](https://ken.io/note/session-principle-skill)中也提到过。整体也是借鉴这个思路。
用户登录成功之后生成AuthToken交给客户端保存。如果是浏览器就保存在Cookie中。如果是手机App就保存在App本地缓存中。本篇主要探讨基于Web站点的SSO。
用户在浏览需要登录的页面时客户端将AuthToken提交给SSO服务校验登录状态/获取用户登录信息
用户登录成功之后,生成 AuthToken 交给客户端保存。如果是浏览器,就保存在 Cookie 中。如果是手机 App 就保存在 App 本地缓存中。本篇主要探讨基于 Web 站点的 SSO。
对于登录信息的存储建议采用Redis使用Redis集群来存储登录信息既可以保证高可用又可以线性扩充。同时也可以让SSO服务满足负载均衡/可伸缩的需求。
用户在浏览需要登录的页面时,客户端将 AuthToken 提交给 SSO 服务校验登录状态/获取用户登录信息
对于登录信息的存储,建议采用 Redis使用 Redis 集群来存储登录信息,既可以保证高可用,又可以线性扩充。同时也可以让 SSO 服务满足负载均衡/可伸缩的需求。
| 对象 | 说明 |
| --------- | ------------------------------------------------------------ |
| AuthToken | 直接使用UUID/GUID即可如果有验证AuthToken合法性需求可以将UserName+时间戳加密生成,服务端解密之后验证合法性 |
| 登录信息 | 通常是将UserIdUserName缓存起来 |
| AuthToken | 直接使用 UUID/GUID 即可,如果有验证 AuthToken 合法性需求,可以将 UserName+时间戳加密生成,服务端解密之后验证合法性 |
| 登录信息 | 通常是将 UserIdUserName 缓存起来 |
### 3、用户登录/登录校验
### 用户登录/登录校验
- 登录时序图
**登录时序图**
![SSO系统设计-登录时序图](https://img.ken.io/blog/sso/sso-login-sequence.png-kbrb.png)
![SSO系统设计-登录时序图](https://guide-blog-images.oss-cn-shenzhen.aliyuncs.com/github/javaguide/system-design/security/sso/sso-login-sequence.png-kbrb.png)
按照上图用户登录后AuthToken保存在Cookie中。 domain=test.com
浏览器会将domain设置成 .test.com
这样访问所有*.test.com的web站点都会将AuthToken携带到服务器端。
然后通过SSO服务完成对用户状态的校验/用户登录信息的获取
按照上图,用户登录后 AuthToken 保存在 Cookie 中。 domain=test.com
浏览器会将 domain 设置成 .test.com
- 登录信息获取/登录状态校验
这样访问所有 \*.test.com 的 web 站点,都会将 AuthToken 携带到服务器端。
然后通过 SSO 服务,完成对用户状态的校验/用户登录信息的获取
![SSO系统设计-登录信息获取/登录状态校验](https://img.ken.io/blog/sso/sso-logincheck-sequence.png-kbrb.png)
**登录信息获取/登录状态校验**
### 4、用户登出
![SSO系统设计-登录信息获取/登录状态校验](https://guide-blog-images.oss-cn-shenzhen.aliyuncs.com/github/javaguide/system-design/security/sso/sso-logincheck-sequence.png-kbrb.png)
### 用户登出
用户登出时要做的事情很简单:
1. 服务端清除缓存Redis中的登录状态
2. 客户端清除存储的AuthToken
2. 客户端清除存储的 AuthToken
- 登出时序图
**登出时序图**
![SSO系统设计-用户登出](https://img.ken.io/blog/sso/sso-logout-sequence.png-kbrb.png)
![SSO系统设计-用户登出](https://guide-blog-images.oss-cn-shenzhen.aliyuncs.com/github/javaguide/system-design/security/sso/sso-logout-sequence.png-kbrb.png)
### 5、跨域登录、登出
### 跨域登录、登出
前面提到过核心思路是客户端存储AuthToken服务器端通过Redis存储登录信息。由于客户端是将AuthToken存储在Cookie中的。所以跨域要解决的问题就是如何解决Cookie的跨域读写问题。
前面提到过,核心思路是客户端存储 AuthToken服务器端通过 Redis 存储登录信息。由于客户端是将 AuthToken 存储在 Cookie 中的。所以跨域要解决的问题,就是如何解决 Cookie 的跨域读写问题。
解决跨域的核心思路就是:
- 登录完成之后通过回调的方式将AuthToken传递给主域名之外的站点该站点自行将AuthToken保存在当前域下的Cookie中。
- 登出完成之后通过回调的方式调用非主域名站点的登出页面完成设置Cookie中的AuthToken过期的操作。
- 跨域登录(主域名已登录)
- 登录完成之后通过回调的方式,将 AuthToken 传递给主域名之外的站点,该站点自行将 AuthToken 保存在当前域下的 Cookie 中。
- 登出完成之后通过回调的方式,调用非主域名站点的登出页面,完成设置 Cookie 中的 AuthToken 过期的操作。
![SSO系统设计-跨域登录(主域名已登录)](https://img.ken.io/blog/sso/sso-crossdomain-login-loggedin-sequence.png-kbrb.png)
**跨域登录(主域名已登录)**
- 跨域登录(主域名未登录)
![SSO系统设计-跨域登录(主域名已登录)](https://guide-blog-images.oss-cn-shenzhen.aliyuncs.com/github/javaguide/system-design/security/sso/sso-crossdomain-login-loggedin-sequence.png-kbrb.png)
![SSO系统设计-跨域登录(主域名未登录)](https://img.ken.io/blog/sso/sso-crossdomain-login-unlogin-sequence.png-kbrb.png)
**跨域登录(主域名未登录)**
- 跨域登出
![SSO系统设计-跨域登录(主域名未登录)](https://guide-blog-images.oss-cn-shenzhen.aliyuncs.com/github/javaguide/system-design/security/sso/sso-crossdomain-login-unlogin-sequence.png-kbrb.png)
![SSO系统设计-跨域登出](https://img.ken.io/blog/sso/sso-crossdomain-logout-sequence.png-kbrb.png)
**跨域登出**
## 三、备注
![SSO系统设计-跨域登出](https://guide-blog-images.oss-cn-shenzhen.aliyuncs.com/github/javaguide/system-design/security/sso/sso-crossdomain-logout-sequence.png-kbrb.png)
- 关于方案
## 说明
这次设计方案更多是提供实现思路。如果涉及到APP用户登录等情况在访问SSO服务时增加对APP的签名验证就好了。当然如果有无线网关验证签名不是问题。
- 关于时序图
时序图中并没有包含所有场景ken.io只列举了核心/主要场景,另外对于一些不影响理解思路的消息能省就省了。
- 关于方案 :这次设计方案更多是提供实现思路。如果涉及到 APP 用户登录等情况,在访问 SSO 服务时,增加对 APP 的签名验证就好了。当然,如果有无线网关,验证签名不是问题。
- 关于时序图:时序图中并没有包含所有场景,只列举了核心/主要场景,另外对于一些不影响理解思路的消息能省就省了。