聊聊我在这家公司设计的SSO

  • 时间:
  • 浏览:0

最近小明遇到一个 需求:前要将有几个独立的系统(子系统)汇总到一个 集中的系统(父系统)当中,当用户在父系统登录以前,再点击这有几个子系统,就可以 免登录跳转到任意一个 系统。当时一听,duang~duang~算是 统统方案涌进来(吹牛的),但没人下面你这个方案得到了leader的肯定,如今统统在线上跑着了,接下来给一帮人 复盘一下。

都看你这个需求,一帮人 算是 第一感觉之后:这不之后SSO(单点登录)系统嘛?

单点登录(英语:Single sign-on,缩写为 SSO),又译为单一签入,并算是对于统统相互关连,统统又是其他人独立的软件系统,提供访问控制的属性。当拥有这项属性时,当用户登录时,就可以 获取所有系统的访问权限,过多对每个单一系统都逐一登录。这项功能通常是以轻型目录访问协议(LDAP)来实现,在服务器上会将用户信息存储到LDAP数据库中。相同的,单一退出(single sign-off)之后指,只前要单一的退出动作,就可以 开始对于多个系统的访问权限。

是的,没错,小明接到你这个需求以前,整体思路也是按着SSO设想的,统统细想以前,发现没人完整版照搬,要考虑项目的实际请况:比如已知的有几个子系统是以前的统统开发好的,没人大动干戈,前要平滑接入父系统,统统根据需求,SSO的功能也没必要完整版实现,简而言之,之后一个 阉割版的SSO。

小明只前要实现:用户在父系统账号密码登录后,通过点击任意一个 子系统的功能按钮(不前要重复输入账号登录)有利于跳转子系统功能页即可。

设计流程

项目

一个 简单朴素的SpringBoot项目

时序图

说干就干,用户输入账号密码,请求SSO用户登录模块进行账号密码校验,校验通以前建立全局会话,统统返回前端token凭证(我使用的是sessionId),跳转统统系统时携带token,统统系统拿到token后,再调用SSO平台进行token校验,统统校验通过,则用户可在子系统内建立会话,用户跳转系统完成。下面给一帮人 举例SSO跳转一个 子系统的时序图:

在这里插一嘴哈,我使用的流程图工具是ProcessOn,是一款在线画图工具,非常适合画各种示意图,体验极佳,统统一帮人 想尝试一下,可以 使用我的邀请链接注册使用~

整个流程图如里边所示,下面主要针对各个功能点进行完整版说明。

SSO系统的登录与会话保持

本次会话管理采用的是redis session,spring完美支持redis存储session信息,此外还支持MONGODB\JDBC\HAZELCAST等存储会话办法。通过redis存储session,可以 满足集群部署、分布式系统的session共享(当然哪些算是 后话)。

pom.xml依赖配置如下

        <!--redis 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <!--sessions 依赖-->
        <dependency>
            <groupId>org.springframework.session</groupId>
            <artifactId>spring-session-data-redis</artifactId>
        </dependency>

application.yml配置redis及session

spring:
  redis:
    host: 127.0.0.1
    password: 123456
    port: 6379
    timeout: 2000
    database: 0
    jedis:
      pool:
        max-active: 2000
        max-wait: -1
        max-idle: 10
        min-idle: 5
  # 设置session存储类型为redis 
  session:
    store-type: redis

此时,redis存储会话配置统统完成,但总嘴笨 缺少哪些,嗷,那我除此之外,一帮人 还前要设置session的有效时长,application.yml中的配置如下:

server:
  servlet:
    session:
        # 支持Duration表达式,此时表示120分钟
      timeout: PT120M

当然,一帮人 还前要在Springboot主办法通过@EnableRedisHttpSession开启redis session

注意:统统里边配置的session有效时长不生效,一帮人 可以 在注解属性上配置session有效时间(不瞒一帮人 ,我之后在此处配置才生效的)

@SpringBootApplication
// 开启redis session ,统统设置session有效时长
@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 7200)
public class XiaoMingApplication {

    public static void main(String[] args) {
        SpringApplication.run(XiaoMingApplication.class, args);
    }
}

至此,sso系统的登录及会话管理就完成啦。接下来看一下与统统系统何如交互。

跳转子系统

流程

统统SSO统统登录 -> 用户点击某个子系统按钮(和负责A系统的人员约定好的链接)发起get请求 -> A系统后端接收到请求 -> 调用SSO系统进行token校验(下面会讲到) -> 建立会话,类似于于

http://xxx/jump?token=123456

这是一个 在地址栏输入的get请求,该接口前要特殊除理,后端拦截器前要放行。

参数说明
xxx 此处xxx为域名,jump为系统A提供的接口url地址,可以 自定义,前要约定告知
token 返回的校验凭证

该接口嘴笨 就前要干两件事情:

  1. 请求SSO进行token校验(类似于于以前的用户、密码登录,只不过调用SSO平台接口校验);
  2. 建立本地会话(和账号密码登录成功以前的建立会话办法一致)。
  3. 控制校验通以前的页面跳转。

SSO为子系统提供token校验接口

里边讲到SSO会暴漏一个 token校验接口,你这个块逻辑很简单,之后拿着token去redis中查找对应的用户信息算是处在。众所周知,小明是一个 懒人,为了投机取巧,小明token的生成规则,之后session的id,统统,判断用户算是登录,嘴笨 之后根据sessionId查找redis算是处在会话,此处有亮点。通过查看源码,我发现你这个功能,根本过多一帮人 当事人去实现,spring统统想到一帮人 会用到。

spring提供了一个 接口org.springframework.session.SessionRepository

package org.springframework.session;

public interface SessionRepository<S extends Session> {
    S createSession();

    void save(S var1);
    // 你这个之后
    S findById(String var1);

    void deleteById(String var1);
}

其中S findById(String var1)之后一帮人 要调用的办法,你这个办法作用之后根据sessionId去会话中心查找会话对象,正是一帮人 所前要的,一帮人 只需通过@Autowired获取,开箱即用~一帮人 共同看一下业务代码:

@Autowired
private SessionRepository sessionRepository;
    @PostMapping("/checkToken")
public BaseResponseFacade checkToken(@RequestBody UserLoginVo userLoginVo) {
    if (Objects.isNull(userLoginVo)) {
        return ResponseUtil.error(NEED_LOGIN);
    }
    String token = userLoginVo.getToken();
    Session session = sessionRepository.findById(token);
    if (Objects.isNull(session)) {
        return ResponseUtil.error(NEED_LOGIN);
    }
    AdverInfo adverInfo = JSON.parseObject(session.getAttribute("adverInfo"), AdverInfo.class);
    return ResponseUtil.success(adverInfo);
}

SSO和子系统的交互文档也贴出来给一帮人 一睹为快

接口调用请求说明

  • 请求办法:POST
  • 请求格式:JSON
  • 请求地址
    • 测试:http:/xxx/checkToken
    • 正式:http://xxx/checkToken
  • POST数据示例
{
    "token": "123456"
}
参数说明
xxx/checkToken xxx为域名,checkToken为营销云平台提供的校验接口地址
token 调用接口凭据

返回说明

正常时返回的json数据包示例

统统SSO校验通过,则系统A可以 与与当前用户建立本地会话,用户正常进入系统

{
    "data":{
    "XXX":"XXX"
    },
    "errorMsg":"成功",
    "errorCode":0
}

参数说明

errorCode 0:表示请求成功
errorMsg 返回码说明
XXX 统统相关信息
异常时返回的json数据包示例

当SSO后台校验失败时返回参数如下

{
  "errorMsg": "NEED_LOGIN",
  "errorCode": 10
}

参数说明

errorMsg 错误信息说明
errorCode 错误标志

错误码说明

1 系统繁忙
10 前要用户登录
2000 服务器内内外部错误

小明设计的简洁版sso就大抵没人,一帮人 可以 作为一个 sso入门demo来看待