【SpringSecurity】十五、完成系统支持Github三方登录

梦里梦外; 2024-04-23 15:47 0阅读 0赞

#### 文章目录 ####

*  1、需求
 *  2、在对接系统中完成客户端注册
 *  3、创建客户端应用
 *  4、CommonOAuth2Provider

SpringSecurity OAuth2.0文档： [https://docs.spring.io/spring-security/reference/servlet/oauth2/index.html][https_docs.spring.io_spring-security_reference_servlet_oauth2_index.html]

## 1、需求 ##

对接Github，在自己系统实现支持Github登录。

## 2、在对接系统中完成客户端注册 ##

头像 ⇒ Settings ⇒ Developer settings ⇒ OAuth Apps ⇒ 注册一个新的应用

![在这里插入图片描述][dac1ebffeae34b9aa713ef3d508bbc06.png]

![在这里插入图片描述][465e835e6af94e1b9906fc3b27128343.png]

注册成功，拿到客户端id和密钥。请求Github的授权服务器时，携带clinet\_id和secret，Github就知道你是一个合法的客户端应用。

![在这里插入图片描述][d90cb5ff997c482c9de6f11d539fdfa6.png]

## 3、创建客户端应用 ##

//官方示例
    https://github.com/spring-projects/spring-security-samples/blob/main/servlet/spring-boot/java/oauth2/login/README.adoc

新建模块，搜索勾选springweb、thymeleaf、spring security、**oauth2 client**依赖：

![在这里插入图片描述][2734876e3b38478dbeede447b69a03e1.png]

上一步完成客户端注册后，这里写application配置：

spring:
      security:
        oauth2:
          client:
            registration:
              github:
                client-id: 33ddf22a5738dcdeeca4
                client-secret: 79519586acf22ef10597e5d94ee0e67d39ebd64

写Controller：

import org.springframework.security.core.annotation.AuthenticationPrincipal;
    import org.springframework.security.oauth2.client.OAuth2AuthorizedClient;
    import org.springframework.security.oauth2.client.annotation.RegisteredOAuth2AuthorizedClient;
    import org.springframework.security.oauth2.core.user.OAuth2User;
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.GetMapping;
    
    @Controller
    public class OAuth2LoginController {
        
    
    	@GetMapping("/")
    	public String index(Model model, @RegisteredOAuth2AuthorizedClient OAuth2AuthorizedClient authorizedClient,
    			@AuthenticationPrincipal OAuth2User oauth2User) {
        
    		model.addAttribute("userName", oauth2User.getName());
    		model.addAttribute("clientName", authorizedClient.getClientRegistration().getClientName());
    		model.addAttribute("userAttributes", oauth2User.getAttributes());
    		return "index";
    	}
    
    }

写index视图：

<!DOCTYPE html>
    <html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="https://www.thymeleaf.org" xmlns:sec="https://www.thymeleaf.org/thymeleaf-extras-springsecurity5">
    <head>
    	<title>Spring Security - OAuth 2.0 Login</title>
    	<meta charset="utf-8" />
    </head>
    <body>
    <div style="float: right" th:fragment="logout" sec:authorize="isAuthenticated()">
    	<div style="float:left">
    		<span style="font-weight:bold">User: </span><span sec:authentication="name"></span>
    	</div>
    	<div style="float:none"> </div>
    	<div style="float:right">
    		<form action="#" th:action="@{/logout}" method="post">
    			<input type="submit" value="Logout" />
    		</form>
    	</div>
    </div>
    <h1>OAuth 2.0 Login with Spring Security</h1>
    <div>
    	You are successfully logged in <span style="font-weight:bold" th:text="${userName}"></span>
    	via the OAuth 2.0 Client <span style="font-weight:bold" th:text="${clientName}"></span>
    </div>
    <div> </div>
    <div>
    	<span style="font-weight:bold">User Attributes:</span>
    	<ul>
    		<li th:each="userAttribute : ${userAttributes}">
    			<span style="font-weight:bold" th:text="${userAttribute.key}"></span>: <span th:text="${userAttribute.value}"></span>
    		</li>
    	</ul>
    </div>
    </body>
    </html>

启动程序，localhost:8080/login

![在这里插入图片描述][053c7076fae2462586a388e69bf2b34a.png]

点击跳转github的登录页面：

![在这里插入图片描述][b643077163594315b2ee532a3ca669ad.png]

在github页面完成登录，在授权页面点击Authoize授权

![在这里插入图片描述][b014476a56474d38b12106fc62412f1a.png]

客户端成功获取到github上的用户信息：

![在这里插入图片描述][2ebbe0968af74cdfa2c8b005fb9084af.png]

退出登录后，再次授权直接授权成功，因为token还没过期：

![在这里插入图片描述][7a67652fefdf4b339d8589d313203513.png]

以上的实际流程为（绝大多数步骤已被框架spring security oauth2 client实现了）：

*  A网站（客户端）让用户跳转到 GitHub，并携带参数client\_id 以及 redirection url
 *  GitHub 要求用户登录，然后询问用户"A网站要求获取用户信息的权限，你是否同意?"
 *  用户同意，GitHub 就会重定向回A网站，同时发回一个授权码
 *  A网站使用授权码，向 GitHub 请求令牌token
 *  GitHub 返回令牌token
 *  A网站使用令牌，向 GitHub资源服务器请求用户数据
 *  GitHub返回用户数据
 *  A网站使用 GitHub用户数据登录

## 4、CommonOAuth2Provider ##

**CommonOAuth2Provider**是一个预定义的通用OAuth2Provider，为一些知名资源服务API提供商如Google、GitHub、Facebook，预定义了一组默认的属性。包括授权码URI、换取令牌URI和请求用户信息URI，因为它们不经常变化。因此，提供默认值以减少所需的配置。所以配置GitHub客户端时，只需要提供client-id和client-secret就行。

![在这里插入图片描述][add1a939b4d14d968fffe5731c8c7622.png]

[https_docs.spring.io_spring-security_reference_servlet_oauth2_index.html]: https://docs.spring.io/spring-security/reference/servlet/oauth2/index.html
[dac1ebffeae34b9aa713ef3d508bbc06.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/c3f16cb50cad4ea1b1e9fa6c902ec47e.png
[465e835e6af94e1b9906fc3b27128343.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/a80744ae6d1e43f0aa27fa6cd3db3420.png
[d90cb5ff997c482c9de6f11d539fdfa6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/eed12f0ca2924a59bf82fe525a9549ba.png
[2734876e3b38478dbeede447b69a03e1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/d9dbfc4df20745c394e62038ec0f87ed.png
[053c7076fae2462586a388e69bf2b34a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/8a99b6b8fcba4b2594f890ca211ac184.png
[b643077163594315b2ee532a3ca669ad.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/744b8c2c2c8f46daad66c746c8bd285d.png
[b014476a56474d38b12106fc62412f1a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/83f2465e99924071a3371cc226047031.png
[2ebbe0968af74cdfa2c8b005fb9084af.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/29fc3fa59fd146a09424ed2bc67822ac.png
[7a67652fefdf4b339d8589d313203513.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/6ce32f6981a04abf8f6b807d7600640c.png
[add1a939b4d14d968fffe5731c8c7622.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/ed43b94019f24ac69f5c4b2bc58652d2.png