分布式单点登录框架XXL-SSO

服务端 2018-05-14 11:17:01 阅读次数: 3

《分布式单点登录框架XXL-SSO》

Maven Central GitHub release License donate

一、简介

1.1 概述

XXL-SSO 是一个分布式单点登录框架。只需要登录一次就可以访问所有相互信任的应用系统。 拥有"轻量级、分布式、跨域、Cookie+Token均支持、Web+APP均支持"等特性；。现已开放源代码，开箱即用。

1.2 特性

  • 1、简洁：API直观简洁，可快速上手；
  • 2、轻量级：环境依赖小，部署与接入成本较低；
  • 3、单点登录：只需要登录一次就可以访问所有相互信任的应用系统。
  • 4、分布式：接入SSO认证中心的应用，支持分布式部署；
  • 5、HA：Server端与Client端，均支持集群部署，提高系统可用性；
  • 6、实时性：系统登陆、注销状态，全部Server与Client端实时共享；
  • 7、CS结构：基于CS结构，包括Server"认证中心"与Client"受保护应用"；
  • 8、跨域：支持跨域应用接入SSO认证中心；
  • 9、Cookie+Token均支持：支持基于Cookie和基于Token两种接入方式，并均提供Sample项目；
  • 10、Web+APP均支持：支持Web和APP接入；

1.3 下载

文档地址

源码仓库地址

源码仓库地址 Release Download
https://github.com/xuxueli/xxl-sso Download
https://gitee.com/xuxueli0323/xxl-sso Download

技术交流

1.4 环境

  • JDK：1.7+
  • Redis：4.0+
  • Mysql：5.6+

二、快速入门（基于Cookie）

基于Cookie，相关概念可参考 "章节 4.6"；

2.1：系统数据库初始化

建表SQL位置：

/xxl-sso/doc/db/xxl-sso-mysql.sql

2.2：源码编译

- xxl-sso-server：中央认证服务，支持集群；
- xxl-sso-core：Client端依赖；
- xxl-sso-samples：单点登陆Client端接入示例项目；
    - xxl-sso-sample-springboot：基于Cookie接入方式，供用户浏览器访问，springboot版本
    - xxl-sso-token-sample-springboot：基于Token接入方式，常用于无法使用Cookie的场景使用，如APP、Cookie被禁用等，springboot版本

2.3 部署 "认证中心（SSO Server）"

项目名：xxl-sso-server

配置说明

配置文件位置：application.properties

### web
server.port=8080
server.context-path=/xxl-sso-server

### freemarker
spring.freemarker.request-context-attribute=request
spring.freemarker.cache=false

### resource (default: /**  + classpath:/static/ )
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/

### jdbc    （登陆用户信息，账号密码等，可根据业务灵活调整定制；）
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl-sso
spring.datasource.username=root
spring.datasource.password=root_pwd
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.max-idle=10
spring.datasource.max-wait=10000
spring.datasource.min-idle=5
spring.datasource.initial-size=5

### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
mybatis.type-aliases-package=com.xxl.sso.server.model

### redis   （sessionid 分布式存储共享Redis）
redis.address=127.0.0.1:6379

2.4 部署 "单点登陆Client端接入示例项目"

项目名：xxl-sso-sample-springboot

maven依赖

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-sso-core</artifactId>
    <version>${最新稳定版}</version>
</dependency>

配置 XxlSsoFilter

参考代码：com.xxl.sso.sample.config.XxlSsoConfig

@Bean
public FilterRegistrationBean xxlSsoFilterRegistration() {

    // redis init
    JedisUtil.init(xxlSsoRedisAddress);

    // filter
    FilterRegistrationBean registration = new FilterRegistrationBean();

    registration.setName("XxlSsoFilter");
    registration.setOrder(1);
    registration.addUrlPatterns("/*");
    registration.setFilter(new XxlSsoFilter());
    registration.addInitParameter(Conf.SSO_SERVER, xxlSsoServer);
    registration.addInitParameter(Conf.SSO_LOGOUT_PATH, xxlSsoLogoutPath);

    return registration;
}

配置说明

配置文件位置：application.properties

### web
server.port=8081
server.context-path=/xxl-sso-sample-springboot

### freemarker
spring.freemarker.request-context-attribute=request
spring.freemarker.cache=false

### resource (default: /**  + classpath:/static/ )
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/

### xxl-sso (CLient端SSO配置)
##### SSO Server认证中心地址（推荐以域名方式配置认证中心，本机可参考章节"2.5"修改host文件配置域名指向）
xxl.sso.server=http://xxlssoserver.com:8080/xxl-sso-server
##### 注销登陆path，值为Client端应用的相对路径
xxl.sso.logout.path=/logout
##### （sessionid 分布式存储共享Redis）
xxl.sso.redis.address=127.0.0.1:6379

2.5 验证

  • 环境准备：启动Redis、初始化Mysql表数据；

  • 修改Host文件：域名方式访问认证中心，模拟跨域与线上真实环境

### 在host文件中添加以下内容0
127.0.0.1 xxlssoserver.com
127.0.0.1 xxlssoclient1.com
127.0.0.1 xxlssoclient2.com

  • 分别运行 "xxl-sso-server" 与 "xxl-sso-sample-springboot"

    1、SSO认证中心地址： http://xxlssoserver.com:8080/xxl-sso-server

    2、Client01应用地址： http://xxlssoclient1.com:8081/xxl-sso-sample-springboot/

    3、Client02应用地址： http://xxlssoclient2.com:8081/xxl-sso-sample-springboot/

  • SSO登录/注销流程验证

    正常情况下，登录流程如下： 1、访问 "Client01应用地址" ，将会自动 redirect 到 "SSO认证中心地址" 登录界面； 2、成功登录后，将会自动 redirect 返回到 "Client01应用地址"，并切换为已登录状态； 3、此时，访问 "Client02应用地址"，不需登陆将会自动切换为已登录状态；

    正常情况下，注销流程如下： 1、访问 "Client01应用地址" 配置的 "注销登陆path"，将会自动 redirect 到 "SSO认证中心地址" 并自动注销登陆状态； 2、此时，访问 "Client02应用地址"，也将会自动注销登陆状态；

三、快速入门（基于Token）

基于Token，相关概念可参考 "章节 4.7"；（在一些无法使用Cookie的场景下，可使用该方式，否则可以忽略本章节）

3.1 "认证中心（SSO Server）" 搭建

可参考 "章节二" 搭建；

"认证中心" 搭建成功后，默认为APP登陆提供API接口如下：

  • 1、登陆接口：/app/login

    • 参数：POST参数
      • username：账号
      • password：账号
    • 响应：JSON格式
      • code：200 表示成功、其他失败；
      • msg：错误提示
      • data: 登陆用户的 sso sessionid

  • 2、注销接口：/app/logout

    • 参数：POST参数
      • sessionId：登陆用户的 sso sessionid
    • 响应：JSON格式
      • code：200 表示成功、其他失败；
      • msg：错误提示

  • 3、登陆状态校验接口：/app/logincheck

    • 参数：POST参数
      • sessionId：登陆用户的 sso sessionid
    • 响应：JSON格式
      • code：200 表示成功、其他失败；
      • msg：错误提示
      • data：登陆用户信息
        • userid：用户ID
        • username：用户名

2.2 部署 "单点登陆Client端接入示例项目" (APP 应用)

项目名：xxl-sso-token-sample-springboot

可参考 "章节 2.4" 部署 "单点登陆Client端接入示例项目"，唯一不同点是：将web应用的 "XxlSsoFilter" 更换为app应用 "XxlSsoTokenFilter"；

2.3 验证 (模拟 APP 客户端)

  • 环境准备：启动Redis、初始化Mysql表数据；

  • 修改Host文件：域名方式访问认证中心，模拟跨域与线上真实环境

### 在host文件中添加以下内容0
127.0.0.1 xxlssoserver.com
127.0.0.1 xxlssoclient1.com
127.0.0.1 xxlssoclient2.com

可参考测试用例 ：com.xxl.app.sample.test.TokenClientTest

正常情况下，登录流程如下：
1、获取用户输入的账号密码后，请求SSO Server的登录接口，获取用户 sso sessionid ；（参考代码：TokenClientTest.loginTest）
2、登陆成功后，获取到 sso sessionid 可存储在APP客户端内部，后续请求受SSO保护的APP引用
3、此时，使用 sso sessionid 访问受保护的 "Client01应用" 和 "Client02应用" 提供的接口，接口均正常返回；（参考代码：TokenClientTest.clientApiRequestTest）

正常情况下，注销流程如下：
1、请求SSO Server的注销接口，注销登陆凭证 sso sessionid ；（参考代码：TokenClientTest.logoutTest）
2、注销成功后，sso sessionid 将会全局失效；
3、此时，使用 sso sessionid 访问受保护的 "Client01应用" 和 "Client02应用" 提供的接口，接口请求将会被拦截，提示未登录并返回状态码 501 ；（参考代码：TokenClientTest.clientApiRequestTest）

四、总体设计

4.1 架构图

输入图片说明

4.2 功能定位

XXL-SSO 是一个分布式单点登录框架。只需要登录一次就可以访问所有相互信任的应用系统。

借助 XXL-SSO，可以快速实现分布式系统单点登录。

4.3 核心概念

概念 说明
SSO Server 中央认证服务，支持集群；
SSO Client 接入SSO认证中心的Client应用；
SSO SessionId 登录用户会话ID，SSO 登录成功为用户自动分配；
SSO User 登录用户信息，与 SSO SessionId 相对应；

4.4 登录流程剖析

  • 用户于Client端应用访问受限资源时，将会自动 redirect 到 SSO Server 进入统一登录界面。
  • 用户登录成功之后将会为用户分配 SSO SessionId 并 redirect 返回来源Client端应用，同时附带分配的 SSO SessionId。
  • 在Client端的SSO Filter里验证 SSO SessionId 无误，将 SSO SessionId 写入到用户浏览器Client端域名下 cookie 中。
  • SSO Filter验证 SSO SessionId 通过，受限资源请求放行；

4.5 注销流程剖析

  • 用户与Client端应用请求注销Path时，将会 redirect 到 SSO Server 自动销毁全局 SSO SessionId，实现全局销毁；
  • 然后，访问接入SSO保护的任意Client端应用时，SSO Filter 均会拦截请求并 redirect 到 SSO Server 的统一登录界面。

4.6 基于Cookie，相关感念

  • 登陆凭证存储：登陆成功后，用户登陆凭证被自动存储在浏览器Cookie中；
  • Client端校验登陆状态：通过校验请求Cookie中的是否包含用户登录凭证判断；
  • 系统角色模型：
    • SSO Server：认证中心，提供用户登陆、注销以及登陆状态校验等功能。
    • Client应用：受SSO保护的Client端Web应用，为用户浏览器访问提供服务；
    • 用户浏览器：用户访问受SSO保护的Client应用的浏览器，登陆后浏览器Cookie中会存储登陆凭证，后续请求时携带；

4.7 基于Token，相关感念

  • 登陆凭证存储：登陆成功后，获取到登录凭证（xxl_sso_sessionid=xxx），需要主动存储，如存储在 localStorage、Sqlite 中；
  • Client端校验登陆状态：通过校验请求 Header参数 中的是否包含用户登录凭证（xxl_sso_sessionid=xxx）判断；因此，发送请求时需要在 Header参数 中设置登陆凭证；
  • 系统角色模型：
    • SSO Server：认证中心，提供用户登陆、注销以及登陆状态校验等功能。
    • Client应用：受SSO保护的Client端Web应用，为APP客户端提供接口服务；
    • APP客户端：用户访问受SSO保护的Client应用的客户端，如Android、IOS、桌面客户端等，登陆后APP客户端主动存储登陆凭证，后续请求时header参数携带；

4.8 未登录状态请求处理

基于Cookie，未登录状态请求：

  • 页面请求：redirect 到SSO Server登录界面；
  • JSON请求：返回未登录的JSON格式响应数据
    • 数据格式：
      • code：501 错误码
      • msg：sso not login.

基于Token，未登录状态请求：

  • 返回未登录的JSON格式响应数据
    • 数据格式：
      • code：501 错误码
      • msg：sso not login.

五、版本更新日志

5.1 版本 v0.1.0，新特性[2018-04-04]

  • 1、简洁：API直观简洁，可快速上手；
  • 2、轻量级：环境依赖小，部署与接入成本较低；
  • 3、单点登录：只需要登录一次就可以访问所有相互信任的应用系统。
  • 4、分布式：接入SSO认证中心的应用，支持分布式部署；
  • 5、HA：Server端与Client端，均支持集群部署，提高系统可用性；
  • 6、实时性：系统登陆、注销状态，全部Server与Client端实时共享；
  • 7、CS结构：基于CS结构，包括Server"认证中心"与Client"受保护应用"；
  • 8、跨域：支持跨域应用接入SSO认证中心；

5.2 版本 v0.1.1，新特性[迭代中]

  • 1、APP接入支持；除了常规Web应用接入方式外，支持APP应用接入，并提供Sample项目；
  • 2、Client端依赖Core包，slf4j依赖优化，移除log4j强依赖；
  • 3、Ajax请求未登录处理逻辑优化，返回JSON格式提示数据；

TODO LIST

  • 1、缓存失效优化：失效周期默认2H、记住密码时72H；失效前1H有请求则缓存时间顺延一个周期；
  • 2、除了 sessionid-user KV外，新增 userid-user KV，避免用户信息冗余缓存，登陆时主动清理旧KV数据；
  • 3、认证中心与接入端交互数据加密，增强安全性；redirect_url必须和临时AccessToken配合才会生效，AccessToken有效期60s；
  • 4、Redis增加password验证；
  • 5、支持设置exclude路径；

六、其他

6.1 项目贡献

欢迎参与项目贡献！比如提交PR修复一个bug，或者新建 Issue 讨论新特性或者变更。

6.2 用户接入登记

更多接入的公司，欢迎在 登记地址 登记，登记仅仅为了产品推广。

6.3 开源协议和版权

产品开源免费，并且将持续提供免费的社区技术支持。个人或企业内部可自由的接入和使用。

  • Licensed under the GNU General Public License (GPL) v3.
  • Copyright (c) 2015-present, xuxueli.

捐赠

无论金额多少都足够表达您这份心意，非常感谢 ：） 前往捐赠

猜你喜欢

转载自my.oschina.net/xuxueli/blog/1790025
今日推荐
基于大语言模型的开源知识库问答系统 MaxKB GitHub Star 数量突破 5,000 个！
美国拟限制 AI 大模型出口中国和俄罗斯
苹果将与 OpenAI 达成协议，将 ChatGPT 应用于 iPhone
openKylin 社区生态委员会第六次会议圆满召开
阿里云正式发布通义千问 2.5
Python 3.13 发布首个 Beta：实验性自由线程模式和 JIT、改进交互式解释器
Stack Overflow 拿我的代码去训练 AI 大模型，还封了我的账号
Pop!_OS 的 COSMIC 桌面完成 App Store 上架工作
报告：Django 仍然是 74% 开发者的首选
《2024 年一季度互联网投融资运行情况》研究报告
15 年前上了“FFmpeg 耻辱柱”，今天他还得谢谢咱——腾讯QQPlayer一雪前耻？
TIOBE 5 月榜单：Fortran “复活”进入 Top 10
周排行
BPM为企业带来的实际利益
好程序员web前端分享css常用属性缩写
Java文件下载（excel）
css样式的动态添加及显示和隐藏等零碎用法
axios全局配置以及拦截器
使用Logstash来实时同步MySQL和log日志数据到ES
C++获取当前时间（年月日、时分秒、毫秒）
Odoo产品分析 (四) -- 工具板块(11) -- 网站即时聊天(1)
Java环境配置正确，但是java、javac、java -version均返回“不是内部或外部命令，也不是可运行的程序或批处理文件”？
01 官网下载各种CentOS教程（超详细版）
每日归档
更多
2024-05-14(0)
2024-05-13(18)
2024-05-12(0)
2024-05-11(38)
2024-05-10(38)
2024-05-09(35)
2024-05-08(42)
2024-05-07(14)
2024-05-06(40)
2024-05-05(0)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022