SpringBoot模拟单点登录

冷不防 2022-06-04 01:21 209阅读 0赞

SSO： Single Sign On，官方的概念：web系统由单系统发展成多系统组成的应用群，复杂性应该由系统内部承担，而不是用户。无论web系统内部多么复杂，对用户而言，都是一个统一的整体，也就是说，用户访问web系统的整个应用群与访问单个系统一样，登录/注销只要一次就够了。

简言之，系统内部通过某种技术实现用户统一登录和注销，所以单点登录技术一定要包括两部分：登录、注销。

1为什么要用单点登录？因为Cookie不能跨域。

Cookie为什么不能跨域请参考《[Cookie详解与跨域问题][Cookie]》。

2如何实现单点登录？

建立权限认证中心来处理登录和注销的问题，真正提供服务的应用服务端通过Filter将鉴权任务重定向给认证中心。

原理图：

![Center][]

注销：

![Center 1][]

首先看得出分为2个角色，一个是应用服务端，也就是认证客户端；另一个是认证服务端。根据上图来分析2个角色应该具备的功能。

认证客户端应该具备的能力：

1必须以Filter或者插件等形式提供，方便系统接入SSO。

2未登陆的用户重定向到SSO认证中心

3接收SSO发来的令牌并将该令牌发回给SSO做令牌认证

4处理令牌认证结果并创建局部会话

5拦截用户注销请求并重定向到SSO

6处理SSO发来的注销会话请求

认证服务端应该具备的能力：

0独立的web服务

1提供登陆页面，和对用户的校验

2创建全局会话、提供token

3校验token有效性并维护client端地址

4处理注销请求、销毁全局会话、并通知维护的client端地址

5判断用户有没有登录

代码模拟：

总共4个项目，核心的是2个SSO-server和SSO-client，其中client不是独立的web应用而是代码插件。SSO-mock-app1和SSO-mock-app2是安装了插件的2个独立应用。

Sso-server:https://github.com/yejingtao/forblog/tree/master/sso-server

Sso-client:https://github.com/yejingtao/forblog/tree/master/sso-client

Sso-mock-app1:https://github.com/yejingtao/forblog/tree/master/sso-mock-app1

Sso-moke-app2:https://github.com/yejingtao/forblog/tree/master/sso-mock-app2

Sso-client包括3部分：filter负责判断用户是否登陆和重定向到sso-server；controller负责与sso-server传递令牌等通信；service维护局部会话状态。

![Center 2][]

Sso-server包括3部分：controller负责与sso-client传递令盘、校验用户登陆情况等通信；service维护全局用户会话状态；templates为用户登陆提供页面入口

![Center 3][]

下面我们按照图中的顺序来对照代码看一下：

1 客户端filter判断如果用户没有登录，重定向到sso-server端：

登陆过放行

if(userName!=null 
    				&& String.valueOf(userName).trim().length()>0 
    				&& userAccessService.checkUserStatus(userName.toString())) {
    			chain.doFilter(req, response);
    		}

没登陆过重定向：

String originalUrl = req.getRequestURL().toString();
    				 httpResponse.sendRedirect(ssoServerPath+"/index?originalUrl="+originalUrl+"&ssoUser="+userName);

`2 sso-server端收到请求也需要判断用户是否登陆，用户不存在就给到自己的登陆页面，同时返回请求过来的连接在成功登陆后做3秒自动跳转。`

@RequestMapping("/index")
    	public String firstCheck(HttpServletRequest request) {
    		String originalUrl = request.getParameter("originalUrl");
    		String ssoUser = request.getParameter("ssoUser");
    		String token = null;
    		boolean loginFlag = false;
    		if(ssoUser!=null && ssoUser.trim().length()>0) {
    			//对用户先判断是否已经登陆过
    			token = authSessionService.getUserToken(ssoUser);
    			if(token!=null) {
    				loginFlag = true;
    			}
    		}
    		if(loginFlag) {
    			//判断如果用户已经在SSO-Server认证过，直接发送token
    			if(tokenTrans(request,originalUrl,ssoUser,token)) {
    				if(originalUrl!=null) {
    					if(originalUrl.contains("?")) {
    						originalUrl = originalUrl + "&ssoUser="+ssoUser;
    					}else {
    						originalUrl = originalUrl + "?ssoUser="+ssoUser;
    					}
    				}
    			}
    			return "redirect:"+originalUrl;
    		}else {
    			//需要替换成专业点的路径,自己登陆下了
    			return "redirect:/loginPage?originalUrl="+request.getParameter("originalUrl");
    		}
    	}

3 用户登陆页面登录后，验证用户名、创建token

//登陆逻辑,返回的是令牌
    	@RequestMapping(value="/doLogin",method=RequestMethod.POST)
    	public String login(HttpServletRequest request, HttpServletResponse response,
    			String userName, String password, String originalUrl) {
    		if(authSessionService.verify(userName,password)) {
    			String token = authSessionService.cacheSession(userName);
    			if(tokenTrans(request,originalUrl,userName,token)) {
    				//跳转到提示成功的页面
    				request.setAttribute("helloName", userName);
    				if(originalUrl!=null) {
    					if(originalUrl.contains("?")) {
    						originalUrl = originalUrl + "&ssoUser="+userName;
    					}else {
    						originalUrl = originalUrl + "?ssoUser="+userName;
    					}
    					request.setAttribute("originalUrl", originalUrl);
    				}
    			}
    			return "hello";//TO-DO 三秒跳转
    		}
    		//验证不通过，重新来吧
    		if(originalUrl!=null) {
    			request.setAttribute("originalUrl", originalUrl);
    		}
    		return "loginIndex";
    	}

重点是token如何传给sso-client端并从clinet端注册上来地址的：

4 server端将token传给client端：

private boolean tokenTrans(HttpServletRequest request, String originalUrl,String userName, String token) {
    		String[] paths = originalUrl.split("/");
    		String shortAppServerUrl = paths[2];
    		String returnUrl = "http://"+shortAppServerUrl+"/receiveToken?ssoToken="+token+"&userName="+userName;
    		//http://peer1:8088/receiveToken?ssoToken=80414bcb-a71d-48c8-bfee-098a303324d4&userName=xixi
    		return "success".equals(restTemplate.getForObject(returnUrl, String.class));
    		
    	}

5 client端将收到的token和自己的服务地址传递给server端：

@RequestMapping("/receiveToken")
    	@ResponseBody
    	public String receiveToken(HttpServletRequest request, String ssoToken,String userName) {
    		if(ssoToken!=null && ssoToken.toString().trim().length()>0) {
    			String realUrl = request.getRequestURL().toString();
    			String[] paths = realUrl.split("/");
    			String realUrlUrls = paths[2];
    			String returnUrl = ssoServerPath+"/varifyToken?address="+realUrlUrls+"&token="+ssoToken;
    			//http://peer2:8089/varifyToken?address=peer1:8088&token=c2ce29be-5adb-4aaf-82cc-2ba24330176e
    			String resultStr =  restTemplate.getForObject(returnUrl, String.class);
    			if("true".equals(resultStr)) {
    				//创建局部会话，保存用户状态为已登陆
    				userAccessService.putUserStatus(userName, resultStr);
    				return "success";
    			}
    		}
    		return "error";
    	}

6 server端检查token是否是自己发放的令牌并维护客户端的地址

//校验token并注册地址
    	@RequestMapping(value="/varifyToken",method=RequestMethod.GET)
    	@ResponseBody
    	public String varifyToken(String token, String address) {
    		return String.valueOf(authSessionService.checkAndAddAddress(token, address));
    	}

7 令牌交互完毕后，提示用户登陆成功并自动跳转回用户的app服务页面

onload = function(){
    		setInterval(go,1000);
    	};
    	var x = 3;
    	function go(){
    		x--;
    		if(x>0){
    			document.getElementById('sp').innerHTML = x;
    		}else{
    			var returnUrl = [[${originalUrl}]];
    			location.href = returnUrl;
    		}
    	}

8 sso-client要有根据用户名发起注销的能力

@RequestMapping("/ssoLogout")
    	@ResponseBody
    	public String ssoLogout(String userName) {
    		String userToken = userAccessService.getUserToken(userName);
    		if(userToken!=null) {
    			String returnUrl = ssoServerPath+"/logoutByToken?ssoToken="+userToken;
    			return restTemplate.getForObject(returnUrl, String.class);
    		}
    		return "None Token";
    	}

9 注销在sso-server端提供2种，可以用用户注销，也可以用token注销，代码中都有提供这里主要讲根据token注销，我们假定注销请求都是从客户端发起的

@RequestMapping(value="/logoutByToken",method=RequestMethod.GET)
    	@ResponseBody
    	public String logoutByToken(String ssoToken) {
    		List<String> addressList = authSessionService.logoutByToken(ssoToken);
    		if(addressList!=null) {
    			addressList.stream().forEach(s -> sendLogout2Client(s,ssoToken));
    		}
    		return "logout";
    	}
    	
    	private void sendLogout2Client(String address,String ssoToken) {
    		String returnUrl = "http://"+address+"/ssoDeleteToken?ssoToken="+ssoToken;
    		try {
    			restTemplate.getForObject(returnUrl, String.class);
    		}catch(Exception e) {
    			//Log and do nothing
    		}
    	}

10  对应的客户端要有个删除token的接收动作

@RequestMapping("/ssoDeleteToken")
    	@ResponseBody
    	public String ssoDeleteToken(String ssoToken) {
    		userAccessService.deleteToken(ssoToken);
    		return "success";
    	}

11 细节需要注意下：

a 客户端filter过滤范围要控制好，不要将sso-server发来的请求进行过滤，否则会死循环

b client端和server端的Redis要维护好user和token

启动测试：

Sso-mock-app1，植入sso-client插件，域名使用peer1,服务地址peer1:9001

Sso-mock-app2，植入sso-client插件，域名使用peer2,服务地址peer2:9002

Sso-Server，独立部署，域名使用peer3,服务地址peer3:9003

都启动之后，开始测试：

步骤一：无论我浏览器访问app1被重定向到[http://peer3:9003/loginPage?originalUrl=http://peer1:9001/hello][http_peer3_9003_loginPage_originalUrl_http_peer1_9001_hello]地址进行登录

步骤二：在peer3，也就是SSO-Server的登陆页面上用yejingtao账户登陆，登陆成功后3秒钟后页面自动跳转到peer1的步骤一中的请求页面。

步骤三：在app2服务尝试yejingtao账号直接访问，成功。

步骤四：在SSO-Server端注销该账号

步骤五：注销后app1和app2又要重新登录了。

整个过程中可以配合redisclient观察redis数据帮助自己理解。

由于只是验证和示例代码，好多可以优化的地方，例如

1 token已经预留了失效时间，可以在逻辑中增加对token时效的判断，并定时清理

2 sso-server与sso-client的通信可以改成post请求，虽然不会经过浏览器，从使用效果和安全级别上没有差别，但是从http协议设计来考虑还是post更好

3 Redis序列化部分可以换成Jackson2JsonRedisSerializer节省内存空间

4 sso-client拦截的权限范围可以放在application.yml中让用户自己设置

如果自己产品中用SSO的话当然不用自己写，成型有CAS等，原理当然差别不大。

还有一种解决系统间统一认证的思路，OAuth2.0，虽然也是解决多系统登录的，但是跟这里的单点登录思路完全不一样，等后面有机会再博文介绍。

[Cookie]: http://blog.csdn.net/yejingtao703/article/details/78617586
[Center]: /images/20220604/fdcb1bbcf90e4df3b106e0188945b6e4.png
[Center 1]: /images/20220604/5383bfbb024e4454978c2ffb98f01f21.png
[Center 2]: /images/20220604/59e9ce6356c84cdea236d6bd79813f10.png
[Center 3]: /images/20220604/8c98a271f75c423ea85668974648889f.png
[http_peer3_9003_loginPage_originalUrl_http_peer1_9001_hello]: http://peer3:9003/loginPage?originalUrl=http://peer1:9001/hello