devbox
花生_TL007
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

OAuth2 详细介绍!

作者：花生_TL007 | 2024-04-09 03:55:27

赞

踩

oauth2

目录

一、文章介绍

二、OAth2

2.1 简介

2.2 OAuth2  授权总体流程

2.3 四种授权模式

1.授权码模式

2.简化模式

3.密码模式

4. 客户端模式

2.4 OAuth2 标准接口

2.5 GitHub 授权登录

1.创建 OAuth应用

 2.项目开发

3.原理分析

3.原理总结

三、Spring Security OAuth2

3.1 授权、资源服务器

1.基于内存授权服务器搭建

2 基于数据库客户端和令牌存储

3.资源服务器搭建

四、JWT的应用

4.1 授权服务器颁发 JWT 令牌

4.2.使用 JWT 令牌资源服务器

一、文章介绍

如今很多互联网应用中，OAuth2 是一个非常重要的认证协议，很多场景下都会用到它，Spring Security 对 OAuth2 协议提供了相应的支持。开发者非常方便的使用 OAuth2 协议 。

  • OAuth2 简介
  • 四种授权模式
  • Spring Security OAuth2
  • GitHub 授权登录
  • 授权服务器与资源服务器
  • 使用 JWT

二、OAth2

2.1 简介

        OAuth 是一个开放标准，该标准允许用户让第三方应用访问该用户在某一网站上存储的私密资源 （如头像、照片、视频等），并且在这个过程中无须将用户名和密码提供给第三方应用。通过令牌 （token） 可以实现这一功能。每一个令牌授权一个特定的网站在特定的时间段内允许可访问特定的资源。OAuth 让用户可以授权第三方网站灵活访问它们存储在另外一些资源服务器上的特定信息，而非所有的内容。对于用户而言，我们在互联网应用中最常见的 OAuth 应用就是各种第三方登录，例如 QQ授权登录、微信授权登录、微博授权登录、GitHub 授权登录等。

        例如用户想登录 Ruby China ，传统方式是使用用户名和密码但是这样并不安全，因为网站会存储你的用户名密码，这样可能会导致密码泄露。这种授权方式安全隐患很大如果使用 OAuth 协议就能很好地解决这一问题。

        oAuth2协议解决了多个网站登录问题，账号密码不安全的问题，比如一些小众的网站就可以不用注册登录，使用 oAuth2，也就是通过第三方向要访问的网站发送请求获取Token，第三方网站每次请求写到Token就可以访问到内容。

472c41a595f137154dc248ff0382b383.png

注意：OAuth2 是 OAuth 协议的下一个版本，但不兼容 OAth 1.0 ，OAth2 关注客户端开发者的简易性，同时为 Web 应用、桌面应用、移动设备、 IOT 设备提供专门的认证流程。

以上大致流程，角色不完善。

        oAuth2就是对用户的信息进步的保护，如很多喜欢将所有密码设置为同样的，就可能会泄露，但是通过已经注册过的网站用户信息，来进行授权给第三方网站信息进行登录则免去了注册，oAuth主要做的就是认证保护用户隐私安全。

2.2 OAuth2  授权总体流程

角色梳理 ：第三方应用 <--------> 存储用户私密信息应用 ----------> 授权服务器 ------> 资源服务器

整体流程如下:（图片来自 RFC6749 文档 https://tools.ietf.org/html/rfc6749）

#                                            官网流程 
- (A) 用户打开客户端以后，客户端要求用户给予授权。
- (B) 用户同意给予客户端授权。
- (C) 客户端使用上一步获得的授权，向认证服务器申请令牌。
- (D) 认证服务器对用户端进行认证以后，确认无误，同意发放令牌。
- (E) 客户端使用令牌，向资源服务器申请资源。
- (F) 资源服务器确认令牌无误,同意向客户端开放资源。

  #                                  例子流程
  - 1.用户打开第三方网站如 (京东),用户点击了微信授权登录，此时 就会跳转到 微信的授权页面。
  - 2.用户点击授权给京东后，进行授权认证，授权成功会进行回调到京东回调页面。
  - 3.授权页面会发起请求向授权服务器索要授权令牌。
  - 4.授权服务器将授权令牌进行返回,用户此时可以在第三方网站（京东）向 微信服务器携带令牌获取部分用户信息 。
  - 5.用户此时可以在第三方网站（京东）向 微信服务器携带令牌获取部分用户信息 。
  - 6.资源服务器将资源返回给第三方网站

从上图中我们可以看出六个步骤之中，B是关键，即用户怎么才能给于客户端授权。同时会发现 OAuth2 中包含四种不同角色：

  • Client ：第三方应用。
  • Resource Owner：资源所有者。
  • Authorizetion Server ：授权服务器。
  • Resource Server ：资源服务器。

授权服务器和资源服务器可以放一起，但是在如今的互联网和分布的推动下，都是分别存储。

2.3 四种授权模式

OAuth2 协议一种支持四种不同的授权模式：

  1. 授权码模式：常见的第三方平台登录功能基本都是使用这种模式。（安全性高）
  2. 简化模式：简化模式是不需要第三方服务端（客户端）参与，直接在浏览器中向授权服务器申请令牌（token），如果网站是纯静态页面，则可以采用这种方式。
  3. 密码模式：密码模式是用户把用户名/密码直接告诉客户端，客户端使用在这些信息项授权服务器申请令牌（token）。这需要用户对客户端高度信任，例如客户端应用和服务器提供商就是同一家公司。
  4. 客户端模式：客户端模式是指客户端使用自己的名义而不是用户的名义向授权服务器提供申请授权。严格来说，客户端模式并不能算作 OAuth 协议解决问题的一种解决方案，但是对于开发者而言，在一些为移动端提供的授权服务器上使用这种模式还是非常方便的。

用的最多的就是 最多的就是授权码模式

无论那种授权模式，其授权流程都是相似的，只不过在个别步骤上有差异而已。如上图所示。

1.授权码模式

        授权码模式（Authorization Code ） 是功能最完整，流程最严密、最全并且使用最广泛的一种 OAuth2 授权模式。同时也是最复杂的一种授权模式，它的特点就是通过客户端的后台服务器，与服务器提供商的认证服务器进行交互。其具体授权流程如下

（图片来自 RFC6749 文档 https://tools.ietf.org/html/rfc6749）

  • Third-party application ：第三方应用程序，简称 "客户端" （client）；
  • Resource Owner ：资源所有者，简称 "用户" （User）；
  • User Agent ：用户代理，是指浏览器；
  • Authorization Server：认证服务器，即服务器专门用来处理认证的服务器；
  • Resource Server ：资源服务器，即服务端存放用户生成的资源的服务器。它与认证服务器，可以是同一台服务器，也可以是不同的服务器。
  • Redirection URL :重定向的 URI 就是授权后要回到的网站

#                                             授权流程 
- AB 两步在进行获取授权码
- 1.用户点击授权登录，通过浏览器，会先到Github授权服务器
- 2.授权服务器此时会有一张页面是否允许授权登录
- 3.允许后才是把客户端信息发送给 授权服务器.
- 4.授权服务根据客户端密钥，授权模式等进行认证，成功后会颁发一个对象数据返回，如授权码模式就会颁发一个授权码给浏览器，最终浏览器跟重定向会我们的客户端。
- 5.客户端会再一次发送请求带着授权码以及重定向的URI再次想授权服务器获取令牌
- 6.授权服务器根据授权码进行比较，如果成功将返回一个令牌。
- 

注意：授权码是一次性的。认证服务器和授权服务器是可以放在一起

主要分为两部：1.客户端向授权服务器索要授权码，2.获取授权码后再次向授权服务器携带授权码索要令牌。

在最后，拿到令牌后，再拿着令牌向资源服务器索要资源。

具体流程如下：

  • （A） 用户访问第三方应用，第三方应用通过浏览器导向认证服务器。
  • （B）用户选择是否给予用户端授权。
  • （C）假设用户给予授权，认证服务器将用户导向客户端事先指定的 "重定向URI"（redirection URI），同时附上一个授权码。
  • （D）客户端收到授权码，附上早先的 "重定向URI"，向认证服务器申请令牌。这一步是在客户端的后端的服务器上完成的。对用户不可见。
  • （E）认证服务器对授权码和重定向URI ，确认无误后。想客户端发送令牌（access token ） 和更新令牌（refresh token）。

核心参数：

https://wx.com/oauth/authorize?response_type=code&client_id=CLENT_Id&redirect_uri=http://www.baidu.com&scope=read

2.简化模式

简化模式(implicitgrant type ) 不通过第三方应用程序的服务器，直接在浏览器中向认证服务器申请令牌，跳过了 "授权码" 这个步骤，因此得名。所有步骤在浏览器中完成，令牌访问者是可见的，而客户端不需要认证。其具体的授权流程如图所示

（图片来自 RFC6749 文档 http://tools.ietf.org/html/rfc6749）

这种模式令牌解析比较都在浏览器不是在安全，spring sercuirty 不支持。

  • （A）第三方应用将用户导向认证服务器。
  • （B）用户决定是否给予客户端授权。
  • （C）假设用户给予授权，认证服务器将用户导向客户端指定的 “重定向URI”，并在URI的Hash部分包含了访问令牌。# token 。（也就是# 路径方式）
  • （D）浏览器向资源服务器发出请求，其中包含上一步收到的 Hash 值。
  • （E）资源服务器返回一个网页，其中包含的代码可以取出 Hash值中的令牌。
  • （F）浏览器执行上一步获得脚本，提取出令牌。
  • （G）浏览器将令牌发给客户端。

核心参数：

 https://wx.com/auth/authorize?response_type=token&client_id=CLIENT_ID&redirect_uri=http://www.baidu.com&scope=read

3.密码模式

        密码模式（Resource Owner Password Credentials Grant） 中，用户向客户端提供自己的用户名和密码，客户端使用这些信息，向” 服务提供商“ 索要授权。这种模式中，用户必现把自己的密码给客户端，但是客户端不得存储密码，这通常在用户对客户端高度信任的清下，比如客户端是操作系统的一部分，或者由一个相同公司出品。而认证服务器只有在其他授权模式无法执行的情况下，才能考虑使用这种模式。其具体授权流程图所示

（图片来自 RFC6749 https://tools.ieft.org/html/rfc6749）

具体步骤如下：

  • （A）用户向客户端提供用户名和密码
  • （B）客户端用户和密码发给认证服务器，后者请求令牌
  • （C）认证服务器确认无误后，向客户端提供访问令牌。

核心参数：

https://wx/com/token?grant_type=password&username=Username&password=PASSWORD&client_id =CLIENT_ID

4. 客户端模式

        客户端模式（Client Credentials Grant） 指客户端以自己的名义，而不是用户的名义，向 ”服务提供商“进行认证，严格地说，客户端模式并不属于 OAuth框架索要解决的问题。在这种模式中，用户直接向客户端注册，客户端以自己的名义要求 ”服务提供商“ 提供服务，其实不存在授权问题。

步骤如下：

  • （A）客户端想认证服务器进行身份认证，并要求一个访问令牌。
  • （B）认证服务器确认无误后，向客户端提供访问令牌。

https://wx.com/token?grant_type=client_credentials&client_idCLIENT_ID&client_secret=CLEINT_SECRET

这种方式没有授权的过程，是直接那种密钥和客户端编号向要授权服务器去要。这种适合于有凭证信息，有某种协议,直接要直接颁发令牌。

2.4 OAuth2 标准接口

  • /oauth/authorize：授权端点 ，固定授权入口路径 ，也是授权服务器的用户允许授权的页面
  • /oauth/token ：获取令牌端点
  • /oauth/confirm_access：用户确认授权提交端点
  • /oauth/error：授权服务错误信息端点
  • /oauth/check_token：用于资源服务访问的令牌解析端点
  • /oauth/token_key：提供公有密钥的端点，如果使用 JWT 令牌的话

以上是规范化固定接口 ，端口就是路径

2.5 GitHub 授权登录

        

该项目是实现创建一个应用，调用第三方Github方式进行认证操作 。

主要流程：

      • 1.需要获取到GitHub授权认证，并获取到GitHub的 ClientId 和 sererc
      • 2.创建一个应用使用GitHub授权方式认证。

1.创建 OAuth应用

访问 github 并登录，在 Sign in to GitHub · GitHub 中找到Developer settings 选项

  • 创建 OAuth App并输入基本信息：68481317162d0221542806e24faf7cdd.png
  • Applicatiion name ：应用名称
  • Homepage URL ：授权的服务器路径
  • Application Description ：介绍
  • Authorization callback URL ：就是颁发令牌之后返回的地址

认证成功后会生成 Client_id 和secret 在授权登录时需要使用到

 2.项目开发

1.创建 SpringBoot 应用 ,并引入依赖

  1.     <!--security oAuth2 的客户端依赖-->
  2.         <dependency>
  3.             <groupId>org.springframework.boot</groupId>
  4.             <artifactId>spring-boot-starter-oauth2-client</artifactId>
  5.         </dependency>
  6.         <!--security 依赖-->
  7.         <dependency>
  8.             <groupId>org.springframework.boot</groupId>
  9.             <artifactId>spring-boot-starter-security</artifactId>
  10.         </dependency>
  11.         <dependency>
  12.             <groupId>org.springframework.boot</groupId>
  13.             <artifactId>spring-boot-starter-web</artifactId>
  14.         </dependency>

2.创建测试 Controller

  1. @RestController
  2. public class IndexController {
  3.  
  4.     @GetMapping("/getOAuthInfo")
  5.     public DefaultOAuth2User getOAuthInfo(){
  6.         /**
  7.          * 使用 OAuth2 认证成功后也会被放入到 Session中 
  8.          */
  9.         Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
  10.         return (DefaultOAuth2User) authentication.getPrincipal();
  11.     }
  12. }

3.配置 Security 配置类

  1. @Configuration
  2. public class SecurityWebConfig extends WebSecurityConfigurerAdapter {
  3.  
  4.     @Override
  5.     protected void configure(HttpSecurity http) throws Exception {
  6.  
  7.         http.authorizeRequests()
  8.                 .anyRequest().authenticated()
  9.                 .and()
  10.                 .formLogin().and() // 支持 oAuth2 和其他方式同时开启认证方式 
  11.                 .oauth2Login(); // 使用 oAuth2 认证 需要在配置文件中配置认证服务
  12.     }
  13. }

4.配置配置文件

  1. # 注册客户端编号
  2. spring.security.oauth2.client.registration.github.client-id=178210b433b87f612163
  3. # 注册客户端密钥
  4. spring.security.oauth2.client.registration.github.client-secret=9cf77bbbf0b164113bc0554d5130f65adbe60b37
  5. # 授权成功的重定向密钥
  6. spring.security.oauth2.client.registration.github.redirect-uri=http://localhost:8080/login/oauth2/code/github

可以指定如下信息

5.代码测试

点击 GitHub登录后会跳转到 GitHub的授权页面 ，携带必要的参数

https://github.com/login/oauth/authorize?response_type=code&client_id=178210b433b87f612163&scope=read:user&state=pBk0kcLrcD98l0mTD-ACDYFUIOhL9iYuVp248BJqZdQ%3D&redirect_uri=http://localhost:8080/login/oauth2/code/github 

 

6.总结

        如果向让自己开发的应用使用oAuth2 进行授权，首先第一点需要在第三方应用注册 获取到clientId 和 client secret，第二点创建 SpringBoot 应用 添加 spring-security-client 依赖，客户端依赖并配置授权登录认证方式即可。

3.原理分析

        众所周知，Spring Security 的底层实现是通过大量的Filter 实现的，那么OAuth2的实现也离不开 Filter。

OAuth2LoginAuthenticationFilter

处理 OAuth2 认证的

NO

OAuth2AuthorizationCodeGrantFilter

处理OAuth2认证中授权码

NO

1.oauth2Login 源码分析

  1. /*
  2.  * Copyright 2002-2019 the original author or authors.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *      https://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  */
  16. package org.springframework.security.config.annotation.web.configurers.oauth2.client;
  17.  
  18. import java.util.ArrayList;
  19. import java.util.Collections;
  20. import java.util.HashMap;
  21. import java.util.LinkedHashMap;
  22. import java.util.List;
  23. import java.util.Map;
  24.  
  25. import org.springframework.beans.factory.BeanFactoryUtils;
  26. import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
  27. import org.springframework.context.ApplicationContext;
  28. import org.springframework.core.ResolvableType;
  29. import org.springframework.security.authentication.AuthenticationProvider;
  30. import org.springframework.security.config.Customizer;
  31. import org.springframework.security.config.annotation.web.HttpSecurityBuilder;
  32. import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  33. import org.springframework.security.config.annotation.web.configurers.AbstractAuthenticationFilterConfigurer;
  34. import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
  35. import org.springframework.security.core.Authentication;
  36. import org.springframework.security.core.AuthenticationException;
  37. import org.springframework.security.core.authority.mapping.GrantedAuthoritiesMapper;
  38. import org.springframework.security.oauth2.client.OAuth2AuthorizedClientService;
  39. import org.springframework.security.oauth2.client.authentication.OAuth2LoginAuthenticationProvider;
  40. import org.springframework.security.oauth2.client.authentication.OAuth2LoginAuthenticationToken;
  41. import org.springframework.security.oauth2.client.endpoint.DefaultAuthorizationCodeTokenResponseClient;
  42. import org.springframework.security.oauth2.client.endpoint.OAuth2AccessTokenResponseClient;
  43. import org.springframework.security.oauth2.client.endpoint.OAuth2AuthorizationCodeGrantRequest;
  44. import org.springframework.security.oauth2.client.oidc.authentication.OidcAuthorizationCodeAuthenticationProvider;
  45. import org.springframework.security.oauth2.client.oidc.userinfo.OidcUserRequest;
  46. import org.springframework.security.oauth2.client.oidc.userinfo.OidcUserService;
  47. import org.springframework.security.oauth2.client.registration.ClientRegistration;
  48. import org.springframework.security.oauth2.client.registration.ClientRegistrationRepository;
  49. import org.springframework.security.oauth2.client.userinfo.CustomUserTypesOAuth2UserService;
  50. import org.springframework.security.oauth2.client.userinfo.DefaultOAuth2UserService;
  51. import org.springframework.security.oauth2.client.userinfo.DelegatingOAuth2UserService;
  52. import org.springframework.security.oauth2.client.userinfo.OAuth2UserRequest;
  53. import org.springframework.security.oauth2.client.userinfo.OAuth2UserService;
  54. import org.springframework.security.oauth2.client.web.AuthenticatedPrincipalOAuth2AuthorizedClientRepository;
  55. import org.springframework.security.oauth2.client.web.AuthorizationRequestRepository;
  56. import org.springframework.security.oauth2.client.web.OAuth2AuthorizationRequestRedirectFilter;
  57. import org.springframework.security.oauth2.client.web.OAuth2AuthorizationRequestResolver;
  58. import org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository;
  59. import org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter;
  60. import org.springframework.security.oauth2.core.OAuth2AuthenticationException;
  61. import org.springframework.security.oauth2.core.OAuth2Error;
  62. import org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest;
  63. import org.springframework.security.oauth2.core.oidc.OidcScopes;
  64. import org.springframework.security.oauth2.core.oidc.user.OidcUser;
  65. import org.springframework.security.oauth2.core.user.OAuth2User;
  66. import org.springframework.security.oauth2.jwt.JwtDecoderFactory;
  67. import org.springframework.security.web.AuthenticationEntryPoint;
  68. import org.springframework.security.web.authentication.DelegatingAuthenticationEntryPoint;
  69. import org.springframework.security.web.authentication.LoginUrlAuthenticationEntryPoint;
  70. import org.springframework.security.web.authentication.ui.DefaultLoginPageGeneratingFilter;
  71. import org.springframework.security.web.savedrequest.RequestCache;
  72. import org.springframework.security.web.util.matcher.AndRequestMatcher;
  73. import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
  74. import org.springframework.security.web.util.matcher.NegatedRequestMatcher;
  75. import org.springframework.security.web.util.matcher.OrRequestMatcher;
  76. import org.springframework.security.web.util.matcher.RequestHeaderRequestMatcher;
  77. import org.springframework.security.web.util.matcher.RequestMatcher;
  78. import org.springframework.util.Assert;
  79. import org.springframework.util.ClassUtils;
  80.  
  81. /**
  82.  * An {@link AbstractHttpConfigurer} for OAuth 2.0 Login,
  83.  * which leverages the OAuth 2.0 Authorization Code Grant Flow.
  84.  *
  85.  * <p>
  86.  * OAuth 2.0 Login provides an application with the capability to have users log in
  87.  * by using their existing account at an OAuth 2.0 or OpenID Connect 1.0 Provider.
  88.  *
  89.  * <p>
  90.  * Defaults are provided for all configuration options with the only required configuration
  91.  * being {@link #clientRegistrationRepository(ClientRegistrationRepository)}.
  92.  * Alternatively, a {@link ClientRegistrationRepository} {@code @Bean} may be registered instead.
  93.  *
  94.  * <h2>Security Filters</h2>
  95.  *
  96.  * The following {@code Filter}'s are populated:
  97.  *
  98.  * <ul>
  99.  * <li>{@link OAuth2AuthorizationRequestRedirectFilter}</li>
  100.  * <li>{@link OAuth2LoginAuthenticationFilter}</li>
  101.  * </ul>
  102.  *
  103.  * <h2>Shared Objects Created</h2>
  104.  *
  105.  * The following shared objects are populated:
  106.  *
  107.  * <ul>
  108.  * <li>{@link ClientRegistrationRepository} (required)</li>
  109.  * <li>{@link OAuth2AuthorizedClientRepository} (optional)</li>
  110.  * <li>{@link GrantedAuthoritiesMapper} (optional)</li>
  111.  * </ul>
  112.  *
  113.  * <h2>Shared Objects Used</h2>
  114.  *
  115.  * The following shared objects are used:
  116.  *
  117.  * <ul>
  118.  * <li>{@link ClientRegistrationRepository}</li>
  119.  * <li>{@link OAuth2AuthorizedClientRepository}</li>
  120.  * <li>{@link GrantedAuthoritiesMapper}</li>
  121.  * <li>{@link DefaultLoginPageGeneratingFilter} - if {@link #loginPage(String)} is not configured
  122.  * and {@code DefaultLoginPageGeneratingFilter} is available, then a default login page will be made available</li>
  123.  * </ul>
  124.  *
  125.  * @author Joe Grandja
  126.  * @author Kazuki Shimizu
  127.  * @since 5.0
  128.  * @see HttpSecurity#oauth2Login()
  129.  * @see OAuth2AuthorizationRequestRedirectFilter
  130.  * @see OAuth2LoginAuthenticationFilter
  131.  * @see ClientRegistrationRepository
  132.  * @see OAuth2AuthorizedClientRepository
  133.  * @see AbstractAuthenticationFilterConfigurer
  134.  */
  135. public final class OAuth2LoginConfigurer<B extends HttpSecurityBuilder<B>> extends
  136. 	AbstractAuthenticationFilterConfigurer<B, OAuth2LoginConfigurer<B>, OAuth2LoginAuthenticationFilter> {
  137.  
  138. 	private final AuthorizationEndpointConfig authorizationEndpointConfig = new AuthorizationEndpointConfig();
  139. 	private final TokenEndpointConfig tokenEndpointConfig = new TokenEndpointConfig();
  140. 	private final RedirectionEndpointConfig redirectionEndpointConfig = new RedirectionEndpointConfig();
  141. 	private final UserInfoEndpointConfig userInfoEndpointConfig = new UserInfoEndpointConfig();
  142. 	private String loginPage;
  143. 	private String loginProcessingUrl = OAuth2LoginAuthenticationFilter.DEFAULT_FILTER_PROCESSES_URI;
  144.  
  145. 	/**
  146. 	 * Sets the repository of client registrations.
  147. 	 *
  148. 	 * @param clientRegistrationRepository the repository of client registrations
  149. 	 * @return the {@link OAuth2LoginConfigurer} for further configuration
  150. 	 */
  151. 	public OAuth2LoginConfigurer<B> clientRegistrationRepository(ClientRegistrationRepository clientRegistrationRepository) {
  152. 		Assert.notNull(clientRegistrationRepository, "clientRegistrationRepository cannot be null");
  153. 		this.getBuilder().setSharedObject(ClientRegistrationRepository.class, clientRegistrationRepository);
  154. 		return this;
  155. 	}
  156.  
  157. 	/**
  158. 	 * Sets the repository for authorized client(s).
  159. 	 *
  160. 	 * @since 5.1
  161. 	 * @param authorizedClientRepository the authorized client repository
  162. 	 * @return the {@link OAuth2LoginConfigurer} for further configuration
  163. 	 */
  164. 	public OAuth2LoginConfigurer<B> authorizedClientRepository(OAuth2AuthorizedClientRepository authorizedClientRepository) {
  165. 		Assert.notNull(authorizedClientRepository, "authorizedClientRepository cannot be null");
  166. 		this.getBuilder().setSharedObject(OAuth2AuthorizedClientRepository.class, authorizedClientRepository);
  167. 		return this;
  168. 	}
  169.  
  170. 	/**
  171. 	 * Sets the service for authorized client(s).
  172. 	 *
  173. 	 * @param authorizedClientService the authorized client service
  174. 	 * @return the {@link OAuth2LoginConfigurer} for further configuration
  175. 	 */
  176. 	public OAuth2LoginConfigurer<B> authorizedClientService(OAuth2AuthorizedClientService authorizedClientService) {
  177. 		Assert.notNull(authorizedClientService, "authorizedClientService cannot be null");
  178. 		this.authorizedClientRepository(new AuthenticatedPrincipalOAuth2AuthorizedClientRepository(authorizedClientService));
  179. 		return this;
  180. 	}
  181.  
  182. 	@Override
  183. 	public OAuth2LoginConfigurer<B> loginPage(String loginPage) {
  184. 		Assert.hasText(loginPage, "loginPage cannot be empty");
  185. 		this.loginPage = loginPage;
  186. 		return this;
  187. 	}
  188.  
  189. 	@Override
  190. 	public OAuth2LoginConfigurer<B> loginProcessingUrl(String loginProcessingUrl) {
  191. 		Assert.hasText(loginProcessingUrl, "loginProcessingUrl cannot be empty");
  192. 		this.loginProcessingUrl = loginProcessingUrl;
  193. 		return this;
  194. 	}
  195.  
  196. 	/**
  197. 	 * Returns the {@link AuthorizationEndpointConfig} for configuring the Authorization Server's Authorization Endpoint.
  198. 	 *
  199. 	 * @return the {@link AuthorizationEndpointConfig}
  200. 	 */
  201. 	public AuthorizationEndpointConfig authorizationEndpoint() {
  202. 		return this.authorizationEndpointConfig;
  203. 	}
  204.  
  205. 	/**
  206. 	 * Configures the Authorization Server's Authorization Endpoint.
  207. 	 *
  208. 	 * @param authorizationEndpointCustomizer the {@link Customizer} to provide more options for
  209. 	 * the {@link AuthorizationEndpointConfig}
  210. 	 * @return the {@link OAuth2LoginConfigurer} for further customizations
  211. 	 */
  212. 	public OAuth2LoginConfigurer<B> authorizationEndpoint(Customizer<AuthorizationEndpointConfig> authorizationEndpointCustomizer) {
  213. 		authorizationEndpointCustomizer.customize(this.authorizationEndpointConfig);
  214. 		return this;
  215. 	}
  216.  
  217. 	/**
  218. 	 * Configuration options for the Authorization Server's Authorization Endpoint.
  219. 	 */
  220. 	public class AuthorizationEndpointConfig {
  221. 		private String authorizationRequestBaseUri;
  222. 		private OAuth2AuthorizationRequestResolver authorizationRequestResolver;
  223. 		private AuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository;
  224.  
  225. 		private AuthorizationEndpointConfig() {
  226. 		}
  227.  
  228. 		/**
  229. 		 * Sets the base {@code URI} used for authorization requests.
  230. 		 *
  231. 		 * @param authorizationRequestBaseUri the base {@code URI} used for authorization requests
  232. 		 * @return the {@link AuthorizationEndpointConfig} for further configuration
  233. 		 */
  234. 		public AuthorizationEndpointConfig baseUri(String authorizationRequestBaseUri) {
  235. 			Assert.hasText(authorizationRequestBaseUri, "authorizationRequestBaseUri cannot be empty");
  236. 			this.authorizationRequestBaseUri = authorizationRequestBaseUri;
  237. 			return this;
  238. 		}
  239.  
  240. 		/**
  241. 		 * Sets the resolver used for resolving {@link OAuth2AuthorizationRequest}'s.
  242. 		 *
  243. 		 * @since 5.1
  244. 		 * @param authorizationRequestResolver the resolver used for resolving {@link OAuth2AuthorizationRequest}'s
  245. 		 * @return the {@link AuthorizationEndpointConfig} for further configuration
  246. 		 */
  247. 		public AuthorizationEndpointConfig authorizationRequestResolver(OAuth2AuthorizationRequestResolver authorizationRequestResolver) {
  248. 			Assert.notNull(authorizationRequestResolver, "authorizationRequestResolver cannot be null");
  249. 			this.authorizationRequestResolver = authorizationRequestResolver;
  250. 			return this;
  251. 		}
  252.  
  253. 		/**
  254. 		 * Sets the repository used for storing {@link OAuth2AuthorizationRequest}'s.
  255. 		 *
  256. 		 * @param authorizationRequestRepository the repository used for storing {@link OAuth2AuthorizationRequest}'s
  257. 		 * @return the {@link AuthorizationEndpointConfig} for further configuration
  258. 		 */
  259. 		public AuthorizationEndpointConfig authorizationRequestRepository(AuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository) {
  260. 			Assert.notNull(authorizationRequestRepository, "authorizationRequestRepository cannot be null");
  261. 			this.authorizationRequestRepository = authorizationRequestRepository;
  262. 			return this;
  263. 		}
  264.  
  265. 		/**
  266. 		 * Returns the {@link OAuth2LoginConfigurer} for further configuration.
  267. 		 *
  268. 		 * @return the {@link OAuth2LoginConfigurer}
  269. 		 */
  270. 		public OAuth2LoginConfigurer<B> and() {
  271. 			return OAuth2LoginConfigurer.this;
  272. 		}
  273. 	}
  274.  
  275. 	/**
  276. 	 * Returns the {@link TokenEndpointConfig} for configuring the Authorization Server's Token Endpoint.
  277. 	 *
  278. 	 * @return the {@link TokenEndpointConfig}
  279. 	 */
  280. 	public TokenEndpointConfig tokenEndpoint() {
  281. 		return this.tokenEndpointConfig;
  282. 	}
  283.  
  284. 	/**
  285. 	 * Configures the Authorization Server's Token Endpoint.
  286. 	 *
  287. 	 * @param tokenEndpointCustomizer the {@link Customizer} to provide more options for
  288. 	 * the {@link TokenEndpointConfig}
  289. 	 * @return the {@link OAuth2LoginConfigurer} for further customizations
  290. 	 * @throws Exception
  291. 	 */
  292. 	public OAuth2LoginConfigurer<B> tokenEndpoint(Customizer<TokenEndpointConfig> tokenEndpointCustomizer) {
  293. 		tokenEndpointCustomizer.customize(this.tokenEndpointConfig);
  294. 		return this;
  295. 	}
  296.  
  297. 	/**
  298. 	 * Configuration options for the Authorization Server's Token Endpoint.
  299. 	 */
  300. 	public class TokenEndpointConfig {
  301. 		private OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient;
  302.  
  303. 		private TokenEndpointConfig() {
  304. 		}
  305.  
  306. 		/**
  307. 		 * Sets the client used for requesting the access token credential from the Token Endpoint.
  308. 		 *
  309. 		 * @param accessTokenResponseClient the client used for requesting the access token credential from the Token Endpoint
  310. 		 * @return the {@link TokenEndpointConfig} for further configuration
  311. 		 */
  312. 		public TokenEndpointConfig accessTokenResponseClient(
  313. 			OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient) {
  314.  
  315. 			Assert.notNull(accessTokenResponseClient, "accessTokenResponseClient cannot be null");
  316. 			this.accessTokenResponseClient = accessTokenResponseClient;
  317. 			return this;
  318. 		}
  319.  
  320. 		/**
  321. 		 * Returns the {@link OAuth2LoginConfigurer} for further configuration.
  322. 		 *
  323. 		 * @return the {@link OAuth2LoginConfigurer}
  324. 		 */
  325. 		public OAuth2LoginConfigurer<B> and() {
  326. 			return OAuth2LoginConfigurer.this;
  327. 		}
  328. 	}
  329.  
  330. 	/**
  331. 	 * Returns the {@link RedirectionEndpointConfig} for configuring the Client's Redirection Endpoint.
  332. 	 *
  333. 	 * @return the {@link RedirectionEndpointConfig}
  334. 	 */
  335. 	public RedirectionEndpointConfig redirectionEndpoint() {
  336. 		return this.redirectionEndpointConfig;
  337. 	}
  338.  
  339. 	/**
  340. 	 * Configures the Client's Redirection Endpoint.
  341. 	 *
  342. 	 * @param redirectionEndpointCustomizer the {@link Customizer} to provide more options for
  343. 	 * the {@link RedirectionEndpointConfig}
  344. 	 * @return the {@link OAuth2LoginConfigurer} for further customizations
  345. 	 */
  346. 	public OAuth2LoginConfigurer<B> redirectionEndpoint(Customizer<RedirectionEndpointConfig> redirectionEndpointCustomizer) {
  347. 		redirectionEndpointCustomizer.customize(this.redirectionEndpointConfig);
  348. 		return this;
  349. 	}
  350.  
  351. 	/**
  352. 	 * Configuration options for the Client's Redirection Endpoint.
  353. 	 */
  354. 	public class RedirectionEndpointConfig {
  355. 		private String authorizationResponseBaseUri;
  356.  
  357. 		private RedirectionEndpointConfig() {
  358. 		}
  359.  
  360. 		/**
  361. 		 * Sets the {@code URI} where the authorization response will be processed.
  362. 		 *
  363. 		 * @param authorizationResponseBaseUri the {@code URI} where the authorization response will be processed
  364. 		 * @return the {@link RedirectionEndpointConfig} for further configuration
  365. 		 */
  366. 		public RedirectionEndpointConfig baseUri(String authorizationResponseBaseUri) {
  367. 			Assert.hasText(authorizationResponseBaseUri, "authorizationResponseBaseUri cannot be empty");
  368. 			this.authorizationResponseBaseUri = authorizationResponseBaseUri;
  369. 			return this;
  370. 		}
  371.  
  372. 		/**
  373. 		 * Returns the {@link OAuth2LoginConfigurer} for further configuration.
  374. 		 *
  375. 		 * @return the {@link OAuth2LoginConfigurer}
  376. 		 */
  377. 		public OAuth2LoginConfigurer<B> and() {
  378. 			return OAuth2LoginConfigurer.this;
  379. 		}
  380. 	}
  381.  
  382. 	/**
  383. 	 * Returns the {@link UserInfoEndpointConfig} for configuring the Authorization Server's UserInfo Endpoint.
  384. 	 *
  385. 	 * @return the {@link UserInfoEndpointConfig}
  386. 	 */
  387. 	public UserInfoEndpointConfig userInfoEndpoint() {
  388. 		return this.userInfoEndpointConfig;
  389. 	}
  390.  
  391. 	/**
  392. 	 * Configures the Authorization Server's UserInfo Endpoint.
  393. 	 *
  394. 	 * @param userInfoEndpointCustomizer the {@link Customizer} to provide more options for
  395. 	 * the {@link UserInfoEndpointConfig}
  396. 	 * @return the {@link OAuth2LoginConfigurer} for further customizations
  397. 	 */
  398. 	public OAuth2LoginConfigurer<B> userInfoEndpoint(Customizer<UserInfoEndpointConfig> userInfoEndpointCustomizer) {
  399. 		userInfoEndpointCustomizer.customize(this.userInfoEndpointConfig);
  400. 		return this;
  401. 	}
  402.  
  403. 	/**
  404. 	 * Configuration options for the Authorization Server's UserInfo Endpoint.
  405. 	 */
  406. 	public class UserInfoEndpointConfig {
  407. 		private OAuth2UserService<OAuth2UserRequest, OAuth2User> userService;
  408. 		private OAuth2UserService<OidcUserRequest, OidcUser> oidcUserService;
  409. 		private Map<String, Class<? extends OAuth2User>> customUserTypes = new HashMap<>();
  410.  
  411. 		private UserInfoEndpointConfig() {
  412. 		}
  413.  
  414. 		/**
  415. 		 * Sets the OAuth 2.0 service used for obtaining the user attributes of the End-User from the UserInfo Endpoint.
  416. 		 *
  417. 		 * @param userService the OAuth 2.0 service used for obtaining the user attributes of the End-User from the UserInfo Endpoint
  418. 		 * @return the {@link UserInfoEndpointConfig} for further configuration
  419. 		 */
  420. 		public UserInfoEndpointConfig userService(OAuth2UserService<OAuth2UserRequest, OAuth2User> userService) {
  421. 			Assert.notNull(userService, "userService cannot be null");
  422. 			this.userService = userService;
  423. 			return this;
  424. 		}
  425.  
  426. 		/**
  427. 		 * Sets the OpenID Connect 1.0 service used for obtaining the user attributes of the End-User from the UserInfo Endpoint.
  428. 		 *
  429. 		 * @param oidcUserService the OpenID Connect 1.0 service used for obtaining the user attributes of the End-User from the UserInfo Endpoint
  430. 		 * @return the {@link UserInfoEndpointConfig} for further configuration
  431. 		 */
  432. 		public UserInfoEndpointConfig oidcUserService(OAuth2UserService<OidcUserRequest, OidcUser> oidcUserService) {
  433. 			Assert.notNull(oidcUserService, "oidcUserService cannot be null");
  434. 			this.oidcUserService = oidcUserService;
  435. 			return this;
  436. 		}
  437.  
  438. 		/**
  439. 		 * Sets a custom {@link OAuth2User} type and associates it to the provided
  440. 		 * client {@link ClientRegistration#getRegistrationId() registration identifier}.
  441. 		 *
  442. 		 * @param customUserType a custom {@link OAuth2User} type
  443. 		 * @param clientRegistrationId the client registration identifier
  444. 		 * @return the {@link UserInfoEndpointConfig} for further configuration
  445. 		 */
  446. 		public UserInfoEndpointConfig customUserType(Class<? extends OAuth2User> customUserType, String clientRegistrationId) {
  447. 			Assert.notNull(customUserType, "customUserType cannot be null");
  448. 			Assert.hasText(clientRegistrationId, "clientRegistrationId cannot be empty");
  449. 			this.customUserTypes.put(clientRegistrationId, customUserType);
  450. 			return this;
  451. 		}
  452.  
  453. 		/**
  454. 		 * Sets the {@link GrantedAuthoritiesMapper} used for mapping {@link OAuth2User#getAuthorities()}.
  455. 		 *
  456. 		 * @param userAuthoritiesMapper the {@link GrantedAuthoritiesMapper} used for mapping the user's authorities
  457. 		 * @return the {@link UserInfoEndpointConfig} for further configuration
  458. 		 */
  459. 		public UserInfoEndpointConfig userAuthoritiesMapper(GrantedAuthoritiesMapper userAuthoritiesMapper) {
  460. 			Assert.notNull(userAuthoritiesMapper, "userAuthoritiesMapper cannot be null");
  461. 			OAuth2LoginConfigurer.this.getBuilder().setSharedObject(GrantedAuthoritiesMapper.class, userAuthoritiesMapper);
  462. 			return this;
  463. 		}
  464.  
  465. 		/**
  466. 		 * Returns the {@link OAuth2LoginConfigurer} for further configuration.
  467. 		 *
  468. 		 * @return the {@link OAuth2LoginConfigurer}
  469. 		 */
  470. 		public OAuth2LoginConfigurer<B> and() {
  471. 			return OAuth2LoginConfigurer.this;
  472. 		}
  473. 	}
  474.  
  475. 	@Override
  476. 	public void init(B http) throws Exception {
  477. 		OAuth2LoginAuthenticationFilter authenticationFilter =
  478. 			new OAuth2LoginAuthenticationFilter(
  479. 				OAuth2ClientConfigurerUtils.getClientRegistrationRepository(this.getBuilder()),
  480. 				OAuth2ClientConfigurerUtils.getAuthorizedClientRepository(this.getBuilder()),
  481. 				this.loginProcessingUrl);
  482. 		this.setAuthenticationFilter(authenticationFilter);
  483. 		super.loginProcessingUrl(this.loginProcessingUrl);
  484.  
  485. 		if (this.loginPage != null) {
  486. 			// Set custom login page
  487. 			super.loginPage(this.loginPage);
  488. 			super.init(http);
  489. 		} else {
  490. 			Map<String, String> loginUrlToClientName = this.getLoginLinks();
  491. 			if (loginUrlToClientName.size() == 1) {
  492. 				// Setup auto-redirect to provider login page
  493. 				// when only 1 client is configured
  494. 				this.updateAuthenticationDefaults();
  495. 				this.updateAccessDefaults(http);
  496. 				String providerLoginPage = loginUrlToClientName.keySet().iterator().next();
  497. 				this.registerAuthenticationEntryPoint(http, this.getLoginEntryPoint(http, providerLoginPage));
  498. 			} else {
  499. 				super.init(http);
  500. 			}
  501. 		}
  502.  
  503. 		OAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> accessTokenResponseClient =
  504. 			this.tokenEndpointConfig.accessTokenResponseClient;
  505. 		if (accessTokenResponseClient == null) {
  506. 			accessTokenResponseClient = new DefaultAuthorizationCodeTokenResponseClient();
  507. 		}
  508.  
  509. 		OAuth2UserService<OAuth2UserRequest, OAuth2User> oauth2UserService = getOAuth2UserService();
  510. 		OAuth2LoginAuthenticationProvider oauth2LoginAuthenticationProvider =
  511. 			new OAuth2LoginAuthenticationProvider(accessTokenResponseClient, oauth2UserService);
  512. 		GrantedAuthoritiesMapper userAuthoritiesMapper = this.getGrantedAuthoritiesMapper();
  513. 		if (userAuthoritiesMapper != null) {
  514. 			oauth2LoginAuthenticationProvider.setAuthoritiesMapper(userAuthoritiesMapper);
  515. 		}
  516. 		http.authenticationProvider(this.postProcess(oauth2LoginAuthenticationProvider));
  517.  
  518. 		boolean oidcAuthenticationProviderEnabled = ClassUtils.isPresent(
  519. 			"org.springframework.security.oauth2.jwt.JwtDecoder", this.getClass().getClassLoader());
  520.  
  521. 		if (oidcAuthenticationProviderEnabled) {
  522. 			OAuth2UserService<OidcUserRequest, OidcUser> oidcUserService = getOidcUserService();
  523. 			OidcAuthorizationCodeAuthenticationProvider oidcAuthorizationCodeAuthenticationProvider =
  524. 				new OidcAuthorizationCodeAuthenticationProvider(accessTokenResponseClient, oidcUserService);
  525. 			JwtDecoderFactory<ClientRegistration> jwtDecoderFactory = this.getJwtDecoderFactoryBean();
  526. 			if (jwtDecoderFactory != null) {
  527. 				oidcAuthorizationCodeAuthenticationProvider.setJwtDecoderFactory(jwtDecoderFactory);
  528. 			}
  529. 			if (userAuthoritiesMapper != null) {
  530. 				oidcAuthorizationCodeAuthenticationProvider.setAuthoritiesMapper(userAuthoritiesMapper);
  531. 			}
  532. 			http.authenticationProvider(this.postProcess(oidcAuthorizationCodeAuthenticationProvider));
  533. 		} else {
  534. 			http.authenticationProvider(new OidcAuthenticationRequestChecker());
  535. 		}
  536.  
  537. 		this.initDefaultLoginFilter(http);
  538. 	}
  539.  
  540. 	@Override
  541. 	public void configure(B http) throws Exception {
  542. 		OAuth2AuthorizationRequestRedirectFilter authorizationRequestFilter;
  543.  
  544. 		if (this.authorizationEndpointConfig.authorizationRequestResolver != null) {
  545. 			authorizationRequestFilter = new OAuth2AuthorizationRequestRedirectFilter(
  546. 					this.authorizationEndpointConfig.authorizationRequestResolver);
  547. 		} else {
  548. 			String authorizationRequestBaseUri = this.authorizationEndpointConfig.authorizationRequestBaseUri;
  549. 			if (authorizationRequestBaseUri == null) {
  550. 				authorizationRequestBaseUri = OAuth2AuthorizationRequestRedirectFilter.DEFAULT_AUTHORIZATION_REQUEST_BASE_URI;
  551. 			}
  552. 			authorizationRequestFilter = new OAuth2AuthorizationRequestRedirectFilter(
  553. 					OAuth2ClientConfigurerUtils.getClientRegistrationRepository(this.getBuilder()), authorizationRequestBaseUri);
  554. 		}
  555.  
  556. 		if (this.authorizationEndpointConfig.authorizationRequestRepository != null) {
  557. 			authorizationRequestFilter.setAuthorizationRequestRepository(
  558. 				this.authorizationEndpointConfig.authorizationRequestRepository);
  559. 		}
  560. 		RequestCache requestCache = http.getSharedObject(RequestCache.class);
  561. 		if (requestCache != null) {
  562. 			authorizationRequestFilter.setRequestCache(requestCache);
  563. 		}
  564. 		http.addFilter(this.postProcess(authorizationRequestFilter));
  565.  
  566. 		OAuth2LoginAuthenticationFilter authenticationFilter = this.getAuthenticationFilter();
  567. 		if (this.redirectionEndpointConfig.authorizationResponseBaseUri != null) {
  568. 			authenticationFilter.setFilterProcessesUrl(this.redirectionEndpointConfig.authorizationResponseBaseUri);
  569. 		}
  570. 		if (this.authorizationEndpointConfig.authorizationRequestRepository != null) {
  571. 			authenticationFilter.setAuthorizationRequestRepository(
  572. 				this.authorizationEndpointConfig.authorizationRequestRepository);
  573. 		}
  574. 		super.configure(http);
  575. 	}
  576.  
  577. 	@Override
  578. 	protected RequestMatcher createLoginProcessingUrlMatcher(String loginProcessingUrl) {
  579. 		return new AntPathRequestMatcher(loginProcessingUrl);
  580. 	}
  581.  
  582. 	@SuppressWarnings("unchecked")
  583. 	private JwtDecoderFactory<ClientRegistration> getJwtDecoderFactoryBean() {
  584. 		ResolvableType type = ResolvableType.forClassWithGenerics(JwtDecoderFactory.class, ClientRegistration.class);
  585. 		String[] names = this.getBuilder().getSharedObject(ApplicationContext.class).getBeanNamesForType(type);
  586. 		if (names.length > 1) {
  587. 			throw new NoUniqueBeanDefinitionException(type, names);
  588. 		}
  589. 		if (names.length == 1) {
  590. 			return (JwtDecoderFactory<ClientRegistration>) this.getBuilder().getSharedObject(ApplicationContext.class).getBean(names[0]);
  591. 		}
  592. 		return null;
  593. 	}
  594.  
  595. 	private GrantedAuthoritiesMapper getGrantedAuthoritiesMapper() {
  596. 		GrantedAuthoritiesMapper grantedAuthoritiesMapper =
  597. 				this.getBuilder().getSharedObject(GrantedAuthoritiesMapper.class);
  598. 		if (grantedAuthoritiesMapper == null) {
  599. 			grantedAuthoritiesMapper = this.getGrantedAuthoritiesMapperBean();
  600. 			if (grantedAuthoritiesMapper != null) {
  601. 				this.getBuilder().setSharedObject(GrantedAuthoritiesMapper.class, grantedAuthoritiesMapper);
  602. 			}
  603. 		}
  604. 		return grantedAuthoritiesMapper;
  605. 	}
  606.  
  607. 	private GrantedAuthoritiesMapper getGrantedAuthoritiesMapperBean() {
  608. 		Map<String, GrantedAuthoritiesMapper> grantedAuthoritiesMapperMap =
  609. 				BeanFactoryUtils.beansOfTypeIncludingAncestors(
  610. 						this.getBuilder().getSharedObject(ApplicationContext.class),
  611. 						GrantedAuthoritiesMapper.class);
  612. 		return (!grantedAuthoritiesMapperMap.isEmpty() ? grantedAuthoritiesMapperMap.values().iterator().next() : null);
  613. 	}
  614.  
  615. 	private OAuth2UserService<OidcUserRequest, OidcUser> getOidcUserService() {
  616. 		if (this.userInfoEndpointConfig.oidcUserService != null) {
  617. 			return this.userInfoEndpointConfig.oidcUserService;
  618. 		}
  619. 		ResolvableType type = ResolvableType.forClassWithGenerics(OAuth2UserService.class, OidcUserRequest.class, OidcUser.class);
  620. 		OAuth2UserService<OidcUserRequest, OidcUser> bean = getBeanOrNull(type);
  621. 		if (bean == null) {
  622. 			return new OidcUserService();
  623. 		}
  624.  
  625. 		return bean;
  626. 	}
  627.  
  628. 	private OAuth2UserService<OAuth2UserRequest, OAuth2User> getOAuth2UserService() {
  629. 		if (this.userInfoEndpointConfig.userService != null) {
  630. 			return this.userInfoEndpointConfig.userService;
  631. 		}
  632. 		ResolvableType type = ResolvableType.forClassWithGenerics(OAuth2UserService.class, OAuth2UserRequest.class, OAuth2User.class);
  633. 		OAuth2UserService<OAuth2UserRequest, OAuth2User> bean = getBeanOrNull(type);
  634. 		if (bean == null) {
  635. 			if (!this.userInfoEndpointConfig.customUserTypes.isEmpty()) {
  636. 				List<OAuth2UserService<OAuth2UserRequest, OAuth2User>> userServices = new ArrayList<>();
  637. 				userServices.add(new CustomUserTypesOAuth2UserService(this.userInfoEndpointConfig.customUserTypes));
  638. 				userServices.add(new DefaultOAuth2UserService());
  639. 				return new DelegatingOAuth2UserService<>(userServices);
  640. 			} else {
  641. 				return new DefaultOAuth2UserService();
  642. 			}
  643. 		}
  644.  
  645. 		return bean;
  646. 	}
  647.  
  648. 	private <T> T getBeanOrNull(ResolvableType type) {
  649. 		ApplicationContext context = getBuilder().getSharedObject(ApplicationContext.class);
  650. 		if (context == null) {
  651. 			return null;
  652. 		}
  653. 		String[] names =  context.getBeanNamesForType(type);
  654. 		if (names.length == 1) {
  655. 			return (T) context.getBean(names[0]);
  656. 		}
  657. 		return null;
  658. 	}
  659.  
  660. 	private void initDefaultLoginFilter(B http) {
  661. 		DefaultLoginPageGeneratingFilter loginPageGeneratingFilter = http.getSharedObject(DefaultLoginPageGeneratingFilter.class);
  662. 		if (loginPageGeneratingFilter == null || this.isCustomLoginPage()) {
  663. 			return;
  664. 		}
  665.  
  666. 		loginPageGeneratingFilter.setOauth2LoginEnabled(true);
  667. 		loginPageGeneratingFilter.setOauth2AuthenticationUrlToClientName(this.getLoginLinks());
  668. 		loginPageGeneratingFilter.setLoginPageUrl(this.getLoginPage());
  669. 		loginPageGeneratingFilter.setFailureUrl(this.getFailureUrl());
  670. 	}
  671.  
  672. 	@SuppressWarnings("unchecked")
  673. 	private Map<String, String> getLoginLinks() {
  674. 		Iterable<ClientRegistration> clientRegistrations = null;
  675. 		ClientRegistrationRepository clientRegistrationRepository =
  676. 				OAuth2ClientConfigurerUtils.getClientRegistrationRepository(this.getBuilder());
  677. 		ResolvableType type = ResolvableType.forInstance(clientRegistrationRepository).as(Iterable.class);
  678. 		if (type != ResolvableType.NONE && ClientRegistration.class.isAssignableFrom(type.resolveGenerics()[0])) {
  679. 			clientRegistrations = (Iterable<ClientRegistration>) clientRegistrationRepository;
  680. 		}
  681. 		if (clientRegistrations == null) {
  682. 			return Collections.emptyMap();
  683. 		}
  684.  
  685. 		String authorizationRequestBaseUri = this.authorizationEndpointConfig.authorizationRequestBaseUri != null ?
  686. 				this.authorizationEndpointConfig.authorizationRequestBaseUri :
  687. 				OAuth2AuthorizationRequestRedirectFilter.DEFAULT_AUTHORIZATION_REQUEST_BASE_URI;
  688. 		Map<String, String> loginUrlToClientName = new HashMap<>();
  689. 		clientRegistrations.forEach(registration -> loginUrlToClientName.put(
  690. 				authorizationRequestBaseUri + "/" + registration.getRegistrationId(),
  691. 				registration.getClientName()));
  692.  
  693. 		return loginUrlToClientName;
  694. 	}
  695.  
  696. 	private AuthenticationEntryPoint getLoginEntryPoint(B http, String providerLoginPage) {
  697. 		RequestMatcher loginPageMatcher = new AntPathRequestMatcher(this.getLoginPage());
  698. 		RequestMatcher faviconMatcher = new AntPathRequestMatcher("/favicon.ico");
  699. 		RequestMatcher defaultEntryPointMatcher = this.getAuthenticationEntryPointMatcher(http);
  700. 		RequestMatcher defaultLoginPageMatcher = new AndRequestMatcher(
  701. 				new OrRequestMatcher(loginPageMatcher, faviconMatcher), defaultEntryPointMatcher);
  702.  
  703. 		RequestMatcher notXRequestedWith = new NegatedRequestMatcher(
  704. 				new RequestHeaderRequestMatcher("X-Requested-With", "XMLHttpRequest"));
  705.  
  706. 		LinkedHashMap<RequestMatcher, AuthenticationEntryPoint> entryPoints = new LinkedHashMap<>();
  707. 		entryPoints.put(new AndRequestMatcher(notXRequestedWith, new NegatedRequestMatcher(defaultLoginPageMatcher)),
  708. 				new LoginUrlAuthenticationEntryPoint(providerLoginPage));
  709.  
  710. 		DelegatingAuthenticationEntryPoint loginEntryPoint = new DelegatingAuthenticationEntryPoint(entryPoints);
  711. 		loginEntryPoint.setDefaultEntryPoint(this.getAuthenticationEntryPoint());
  712.  
  713. 		return loginEntryPoint;
  714. 	}
  715.  
  716. 	private static class OidcAuthenticationRequestChecker implements AuthenticationProvider {
  717.  
  718. 		@Override
  719. 		public Authentication authenticate(Authentication authentication) throws AuthenticationException {
  720. 			OAuth2LoginAuthenticationToken authorizationCodeAuthentication =
  721. 				(OAuth2LoginAuthenticationToken) authentication;
  722.  
  723. 			// Section 3.1.2.1 Authentication Request - https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
  724. 			// scope
  725. 			// 		REQUIRED. OpenID Connect requests MUST contain the "openid" scope value.
  726. 			if (authorizationCodeAuthentication.getAuthorizationExchange()
  727. 				.getAuthorizationRequest().getScopes().contains(OidcScopes.OPENID)) {
  728.  
  729. 				OAuth2Error oauth2Error = new OAuth2Error(
  730. 					"oidc_provider_not_configured",
  731. 					"An OpenID Connect Authentication Provider has not been configured. " +
  732. 						"Check to ensure you include the dependency 'spring-security-oauth2-jose'.",
  733. 					null);
  734. 				throw new OAuth2AuthenticationException(oauth2Error, oauth2Error.toString());
  735. 			}
  736.  
  737. 			return null;
  738. 		}
  739.  
  740. 		@Override
  741. 		public boolean supports(Class<?> authentication) {
  742. 			return OAuth2LoginAuthenticationToken.class.isAssignableFrom(authentication);
  743. 		}
  744. 	}
  745. }

1.编写 oauth2Login() 方法后 ，HttpSecurity 底层 会创建 OAuth2LoginConfigurer 配置类，并且将他应用。

b560f30e1d16131d3c90eb742ae16c96.png

2. OAuth2LoginConfigurer 这个类中它的继承Filter 类型就是 OAuth2LoginAuthenticationFilter ，用于做OAuth2 认证的Filter 。

8bd40dddc746240802464583a9ead0b8.png

3.通过clientRegistrationRepository 获取到注册的第三方Provider 客户端信息， 默认是基于内存的

8b493276da6a8a13ffb48656ebee44ef.png

4.通过 authorizedClientRepository 生成授权成功之后的存储授权信息的库

5.在这里里还会进行添加一些其他所需要的参数信息，进行装配。最终认证的方法在 OAuth2LoginAuthenticationFilter类中。

2.OAuth2LoginAuthenticationFilter 源码分析

        OAuth 2.0登录AbstractAuthenticationProcessingFilter的实现。 此身份验证筛选器处理授权代码授予流的OAuth 2.0授权响应，并将OAuth2LoginAuthenticationToken委托给AuthentizationManager以登录最终用户。 OAuth 2.0授权响应的处理方式如下： 假设最终用户（资源所有者）已授予客户端访问权限，授权服务器将把代码和状态参数附加到redirect_uri（在授权请求中提供），并将最终用户的用户代理重定向回该筛选器（客户端）。 然后，此筛选器将使用收到的代码创建OAuth2LoginAuthenticationToken，并将其委托给AuthentizationManager进行身份验证。 成功身份验证后，将创建OAuth2AuthenticationToken（代表最终用户主体），并使用OAuth2AauthorizedClientRepository与授权客户端关联。

        以上是 OAuth2LoginAuthenticationFilter 的介绍 ，它是实现 OAuth2 的Filter ，他会将验证成功的结果 OAuth2LoginAuthenticationToken 交给 AuthentizationManager 进行处理 。

1.默认定义好了授权成功后回调的URI路径

2.核心认证方法 attemptAuthentication 在进行认证授权和授权码验证

  1. @Override
  2. 	public Authentication attemptAuthentication(HttpServletRequest request, HttpServletResponse response)
  3. 			throws AuthenticationException {
  4.  
  5. 		MultiValueMap<String, String> params = OAuth2AuthorizationResponseUtils.toMultiMap(request.getParameterMap());
  6. 		if (!OAuth2AuthorizationResponseUtils.isAuthorizationResponse(params)) {
  7. 			OAuth2Error oauth2Error = new OAuth2Error(OAuth2ErrorCodes.INVALID_REQUEST);
  8. 			throw new OAuth2AuthenticationException(oauth2Error, oauth2Error.toString());
  9. 		}
  10.  
  11. 		OAuth2AuthorizationRequest authorizationRequest =
  12. 				this.authorizationRequestRepository.removeAuthorizationRequest(request, response);
  13. 		if (authorizationRequest == null) {
  14. 			OAuth2Error oauth2Error = new OAuth2Error(AUTHORIZATION_REQUEST_NOT_FOUND_ERROR_CODE);
  15. 			throw new OAuth2AuthenticationException(oauth2Error, oauth2Error.toString());
  16. 		}
  17.  
  18. 		String registrationId = authorizationRequest.getAttribute(OAuth2ParameterNames.REGISTRATION_ID);
  19. 		ClientRegistration clientRegistration = this.clientRegistrationRepository.findByRegistrationId(registrationId);
  20. 		if (clientRegistration == null) {
  21. 			OAuth2Error oauth2Error = new OAuth2Error(CLIENT_REGISTRATION_NOT_FOUND_ERROR_CODE,
  22. 					"Client Registration not found with Id: " + registrationId, null);
  23. 			throw new OAuth2AuthenticationException(oauth2Error, oauth2Error.toString());
  24. 		}
  25. 		String redirectUri = UriComponentsBuilder.fromHttpUrl(UrlUtils.buildFullRequestUrl(request))
  26. 				.replaceQuery(null)
  27. 				.build()
  28. 				.toUriString();
  29. 		OAuth2AuthorizationResponse authorizationResponse = OAuth2AuthorizationResponseUtils.convert(params, redirectUri);
  30.  
  31. 		Object authenticationDetails = this.authenticationDetailsSource.buildDetails(request);
  32. 		OAuth2LoginAuthenticationToken authenticationRequest = new OAuth2LoginAuthenticationToken(
  33. 				clientRegistration, new OAuth2AuthorizationExchange(authorizationRequest, authorizationResponse));
  34. 		authenticationRequest.setDetails(authenticationDetails);
  35.  
  36. 		OAuth2LoginAuthenticationToken authenticationResult =
  37. 			(OAuth2LoginAuthenticationToken) this.getAuthenticationManager().authenticate(authenticationRequest);
  38.  
  39. 		OAuth2AuthenticationToken oauth2Authentication = new OAuth2AuthenticationToken(
  40. 			authenticationResult.getPrincipal(),
  41. 			authenticationResult.getAuthorities(),
  42. 			authenticationResult.getClientRegistration().getRegistrationId());
  43. 		oauth2Authentication.setDetails(authenticationDetails);
  44.  
  45. 		OAuth2AuthorizedClient authorizedClient = new OAuth2AuthorizedClient(
  46. 			authenticationResult.getClientRegistration(),
  47. 			oauth2Authentication.getName(),
  48. 			authenticationResult.getAccessToken(),
  49. 			authenticationResult.getRefreshToken());
  50.  
  51. 		this.authorizedClientRepository.saveAuthorizedClient(authorizedClient, oauth2Authentication, request, response);
  52.  
  53. 		return oauth2Authentication;
  54. 	}

3.首先获取到请求参数的 code 和state 值

4.验证请求参数是否有效 验证参数中是否 code 和state 并验证是否有值 。

1921f7ca3c5d2d3cd750e8b39bfc9f48.png

5.移除之前授权信息，并将授权信息返回

40a43203ee525d270ba43840ce747524.png

6.判断授权客户端信息是否null

f255113efaef6c7de2dc7aa9180b441a.png

7.获取当前注册的授权服务器类型

8.根据注册类型从缓存 InMemoryClientRegistrationRepository 中获取当前注册过的授权服务器信息

9.拼装重定向URI

10.将uri和参数进行转成,获取授权码信息

11.创建 OAuth2LoginAuthenticationToken

12.将封装好的 OAuth2LoginAuthenticationToken 交给 AuthenticationManager 进行认证。认证是有OAuth2LoginAuthenticationProvider 进行认证 调用 authenticate方法，在 authenticate ；里会调用 OAuth2AuthorizationCodeAuthenticationProvider的 authenticate 进行验证码认证。

c9997cd5026ed65261b928bab9b5309d.png

OAuth2LoginAuthenticationProvider 的 authenticate

  1. @Override
  2. 	public Authentication authenticate(Authentication authentication) throws AuthenticationException {
  3. 		OAuth2LoginAuthenticationToken loginAuthenticationToken =
  4. 			(OAuth2LoginAuthenticationToken) authentication;
  5.  
  6. 		// Section 3.1.2.1 Authentication Request - https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
  7. 		// scope
  8. 		// 		REQUIRED. OpenID Connect requests MUST contain the "openid" scope value.
  9. 		if (loginAuthenticationToken.getAuthorizationExchange()
  10. 			.getAuthorizationRequest().getScopes().contains("openid")) {
  11. 			// This is an OpenID Connect Authentication Request so return null
  12. 			// and let OidcAuthorizationCodeAuthenticationProvider handle it instead
  13. 			return null;
  14. 		}
  15.  
  16. 		OAuth2AuthorizationCodeAuthenticationToken authorizationCodeAuthenticationToken;
  17. 		try {
  18. 			authorizationCodeAuthenticationToken = (OAuth2AuthorizationCodeAuthenticationToken) this.authorizationCodeAuthenticationProvider
  19. 					.authenticate(new OAuth2AuthorizationCodeAuthenticationToken(
  20. 							loginAuthenticationToken.getClientRegistration(),
  21. 							loginAuthenticationToken.getAuthorizationExchange()));
  22. 		} catch (OAuth2AuthorizationException ex) {
  23. 			OAuth2Error oauth2Error = ex.getError();
  24. 			throw new OAuth2AuthenticationException(oauth2Error, oauth2Error.toString());
  25. 		}
  26.  
  27. 		OAuth2AccessToken accessToken = authorizationCodeAuthenticationToken.getAccessToken();
  28. 		Map<String, Object> additionalParameters = authorizationCodeAuthenticationToken.getAdditionalParameters();
  29.  
  30. 		OAuth2User oauth2User = this.userService.loadUser(new OAuth2UserRequest(
  31. 				loginAuthenticationToken.getClientRegistration(), accessToken, additionalParameters));
  32.  
  33. 		Collection<? extends GrantedAuthority> mappedAuthorities =
  34. 			this.authoritiesMapper.mapAuthorities(oauth2User.getAuthorities());
  35.  
  36. 		OAuth2LoginAuthenticationToken authenticationResult = new OAuth2LoginAuthenticationToken(
  37. 			loginAuthenticationToken.getClientRegistration(),
  38. 			loginAuthenticationToken.getAuthorizationExchange(),
  39. 			oauth2User,
  40. 			mappedAuthorities,
  41. 			accessToken,
  42. 			authorizationCodeAuthenticationToken.getRefreshToken());
  43. 		authenticationResult.setDetails(loginAuthenticationToken.getDetails());
  44.  
  45. 		return authenticationResult;
  46. 	}

OAuth2AuthorizationCodeAuthenticationProvider 的 authenticate

  1. 	@Override
  2. 	public Authentication authenticate(Authentication authentication) throws AuthenticationException {
  3. 		OAuth2AuthorizationCodeAuthenticationToken authorizationCodeAuthentication =
  4. 			(OAuth2AuthorizationCodeAuthenticationToken) authentication;
  5.  
  6. 		OAuth2AuthorizationResponse authorizationResponse = authorizationCodeAuthentication
  7. 				.getAuthorizationExchange().getAuthorizationResponse();
  8. 		if (authorizationResponse.statusError()) {
  9. 			throw new OAuth2AuthorizationException(authorizationResponse.getError());
  10. 		}
  11.  
  12. 		OAuth2AuthorizationRequest authorizationRequest = authorizationCodeAuthentication
  13. 				.getAuthorizationExchange().getAuthorizationRequest();
  14. 		if (!authorizationResponse.getState().equals(authorizationRequest.getState())) {
  15. 			OAuth2Error oauth2Error = new OAuth2Error(INVALID_STATE_PARAMETER_ERROR_CODE);
  16. 			throw new OAuth2AuthorizationException(oauth2Error);
  17. 		}
  18.  
  19. 		OAuth2AccessTokenResponse accessTokenResponse =
  20. 			this.accessTokenResponseClient.getTokenResponse(
  21. 				new OAuth2AuthorizationCodeGrantRequest(
  22. 					authorizationCodeAuthentication.getClientRegistration(),
  23. 					authorizationCodeAuthentication.getAuthorizationExchange()));
  24.  
  25. 		OAuth2AuthorizationCodeAuthenticationToken authenticationResult =
  26. 			new OAuth2AuthorizationCodeAuthenticationToken(
  27. 				authorizationCodeAuthentication.getClientRegistration(),
  28. 				authorizationCodeAuthentication.getAuthorizationExchange(),
  29. 				accessTokenResponse.getAccessToken(),
  30. 				accessTokenResponse.getRefreshToken(),
  31. 				accessTokenResponse.getAdditionalParameters());
  32. 		authenticationResult.setDetails(authorizationCodeAuthentication.getDetails());
  33.  
  34. 		return authenticationResult;
  35. 	}

13.最终他将获取的数据进行存储，并Authentication 进行封装成进行返回 ，不管什么类型授权方式最后转化为的对象都是相同的

82f21d084189af695712a641b25feef7.png

3.原理总结

        通过原理分析得知，当使用OAuth2 进行认证时，如果是授权码模式，则是 授权携带客户端信息向第三方应用发送请求跳转授权页面，如果用户允许授权，则会获取授权码，获取授权码后，跳转到重定向页面，此时浏览器会再次发送请求获取令牌。

        由此得出，自定义的第三方应用是在获取的授权码后，进行验证授权码的合法性，在向第三方服务器发送请求获取令牌的方式。

三、Spring Security OAuth2

        Spring Security 对 OAuth2 提供了很好的支持，这使得我们在 Spring Security 中使用 OAuth2 非常地方便，然后由于历史原因，Spring Security 对 OAuth2 的支持比较混乱，这里简单梳理一下。

        大概十年前，Spring 引入一个社区驱动的开源项目 Spring Security OAuth ，并将其纳入 Spring 项目组合中。到今天为止，这个项目已经发展为一个成熟的项目，可以支持大部分的OAuth 规范，包括资源服务器，客户端和授权服务器等 。

然而早期的项目存在一些问题，例如：

    • OAuth 是在早前完成的，开发者无法预料未来的变化以及这些代码到底要被怎么使用。这导致很多 Spring 项目提供了自己的 OAuth 支持，也就带来了 OAuth 支持的碎片化。
    • 最早的 OAuth 项目同时支持 OAuth1.0 和 OAuth 2.0，而现在 OAuth1.0 早已经不再使用，可以放弃了。
    • 现在我们有更多的库可以选择，可以在这些库的基础上去开发，以便更好地支持JWT 等新技术。

                基于以上这些原因，官方决定重写 Spring Security OAuth ，以便更好地协调 Spring 和 Auth ，并简化代码库，使 Spring 的 OAuth 支持更加灵活。然后，在重写的过程中，发生了不少波折。

2018年1月30日，Spring 官方发一个通知，表示要逐渐停止现有的 OAuth2支持 ，然后在 Spring Security 5 中构建下一代 OAuth2.0 支持。这么做的原因是因为当时 OAuth2 的落地方案比较混乱，在 Spring Security OAuth 、Spring Colud Security 、Spring Boot 1.5.x 以及当时最新的Spring Security 5.x 中都提供了对 OAuth2 的实现。以至于当开发者需要使用 OAuth2 时，不得不问，到底那个依赖合适呢？

        所以 Spring 官方决定有必要将 OAuth2.0 的支持统一到一个项目中，以便为用户提供明确的选择，并避免任何潜在的混乱，同时 OAuth2.0 的开发文档也要重新编写，以方便开发人员学习。所有的决定在 Spring Security 5 中开始，构建下一代 OAuth2.0的支持、从哪个时候起，Spring Security OAuth 项目就正式处于维护模式。官方将提供至少一年的错识/安全修复程序，并且会考虑添加次要功能，但不会添加主要功能。同时将 Spring Security OAuth 中的所有功能重构到 Spring Security 5.x 中 。

        到了2019年11月14日，Spring 官方又发布一个通知，这次的通知首先表示 Spring Security OAuth 在迁往 Spring Security 5.x 的过程非常顺利，大多分迁工程工作已经完成了，剩下的将在5.3 版本中完成迁移，在迁移的过程中添加许多新功能。包括对 OpenID Connection1.0 支持 。同时还宣布将不在支持授权服务器，不支持的原因有两个：

  1. 在2019年，已经有大量的商业和开源授权服务器可用。
  2. 授权服务器是使用一个库来构建产品，而 Spring Security 作为框架，并不适合做这件事情 。

        一石激起千层浪，许多开发者表示对此难以接受。这件事在 Spring 社区引起了激烈的讨论，好在 Spring 官方愿意倾听来自社区的声音。

        到了2020年4月15日，Spring 官方宣布启动 Spring Authorization server 项目 。这是一个由 Spring Security 团队领导的社区驱动的项目，致力于向 Spring 社区提供 Authorization Server 支持，也就是说，Spring 又重新支持授权服务器了。

        2020年8月21日，Spring uthorization Server 0.0.1 正式发布！

        这就是 OAuth2 在 Spring 家族中的发展历程了。在后面的学习中，客户端和资源服务器都将采用最新的方式来构建，授权服务器依然采用旧的方式来构建。因为目前的 Spring Authentication Server 0.0.1 功能较少且 BUG 较多 。

        一般来说，当我们在项目中使用 OAuth2 时，都是开发客户端，授权服务器和资源服务器由外部提供。例如我们想在自己搭建网站上集成 GitHub 第三方登录，只需要开发自己客户端即可，认证服务器和授权服务器由 GitHub 提供的 。        

3.1 授权、资源服务器

前面的 GitHub 授权登录主要向大家展示了 OAuth2 中客户端的工作模式。对于大部分的开发者而言，日常接触到的 OAuth2 都是客户端，例如接入 QQ登录 、接入微信登录等。不过也有少量场景，可能需要开发者提供授权服务器与资源服务器，接下来我们就通过一个完整的案例演示如何搭建授权服务器与资源服务器。

搭建授权服务器，我们可以选择一些线程的开源项目，直接运行即可，例如 ：

    • Keycloak ：RedFat 公司提供的开源工具，提供了很多实用功能，例如单点登录、支持OpenID、可视化后台管理等。
    • Apache Oltu：Apache 上的开源项目，最近几年没怎么维护了。

接下来我们将搭建一个包含授权服务器、资源服务器以及客户端在内的 OAuth2 案例。

    • 授权服务器：采用较早的 spring-cloud-starter-oauth2 来搭建授权服务器。
    • 资源服务器：采用最新的 Spring Security 5.x 搭建资源服务器。
    • 客户端：采用最新的 Spring Security 5.x 搭建客户端。

注意：Spring Boot 的版本不能过高 ，因为 Spring-cloud-starter-oatuh2 的版本不能过高 。

1.基于内存授权服务器搭建

做授权服务器的话，

1.需要提供一个授权登录的功能

2.注册功能，其他服务器向授权服务器注册的功

1.1 基于内存客户端和令牌存储

        创建 SpringBoot 应用 ，并引入依赖

  1.     <properties>
  2. 			<spring-boot.version>2.2.5.RELEASE</spring-boot.version>
  3.     </properties>
  4.  
  5.     <dependencies>
  6.  
  7.         <!--spring web 依赖 -->
  8.         <dependency>
  9.             <groupId>org.springframework.boot</groupId>
  10.             <artifactId>spring-boot-starter-web</artifactId>
  11.         </dependency>
  12.         <!--spring cloud oauth 授权服务器 依赖 -->
  13.         <dependency>
  14.             <groupId>org.springframework.cloud</groupId>
  15.             <artifactId>spring-cloud-starter-oauth2</artifactId>
  16.             <version>2.2.5.RELEASE</version>
  17.         </dependency>
  18.         <!--spring security 依赖 -->
  19.         <dependency>
  20.             <groupId>org.springframework.boot</groupId>
  21.             <artifactId>spring-boot-starter-security</artifactId>
  22.         </dependency>

编写配置类 ，添加 security 配置类以及 oAuth 配置类

  1. package com.bjpowenrode.security.config;
  2.  
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.security.authentication.AuthenticationManager;
  6. import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
  7. import org.springframework.security.config.annotation.web.builders.HttpSecurity;
  8. import org.springframework.security.config.annotation.web.builders.WebSecurity;
  9. import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
  10. import org.springframework.security.core.userdetails.User;
  11. import org.springframework.security.core.userdetails.UserDetailsService;
  12. import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
  13. import org.springframework.security.crypto.password.PasswordEncoder;
  14. import org.springframework.security.provisioning.InMemoryUserDetailsManager;
  15.  
  16. /**
  17.  * @author 千城丶Y
  18.  * @className : WebSecuriyConfig
  19.  * @PACKAGE_NAME : com.bjpowenrode.security.config
  20.  * @date : 2022/9/21 18:19
  21.  * @Description TODO 基础的webSecurity 配置
  22.  */
  23. @Configuration
  24. public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
  25.  
  26.     @Bean
  27.     public PasswordEncoder passwordEncoder (){
  28.         return  new BCryptPasswordEncoder();
  29.     }
  30.     /**
  31.      * 基于内存的身份验证
  32.      */
  33.     @Override
  34.     @Bean
  35.     public UserDetailsService userDetailsService (){
  36.         InMemoryUserDetailsManager inMemoryUserDetailsManager = new InMemoryUserDetailsManager();
  37.         inMemoryUserDetailsManager.createUser(User.withUsername("root").password(passwordEncoder().encode("123")).roles("admin").build());
  38.         return inMemoryUserDetailsManager ;
  39.     }
  40.  
  41.     @Override
  42.     protected void configure(AuthenticationManagerBuilder auth) throws Exception {
  43.         auth.userDetailsService(userDetailsService());
  44.     }
  45.  
  46.     @Bean
  47.     @Override // 将内容 authorizationManager 暴露
  48.     public AuthenticationManager authenticationManagerBean() throws Exception {
  49.         return super.authenticationManagerBean();
  50.     }
  51.  
  52.     @Override
  53.     public void configure(WebSecurity web) throws Exception {
  54.         super.configure(web);
  55.     }
  56.  
  57.     /**
  58.      * 基础的web 安全配置
  59.      * @param http
  60.      * @throws Exception
  61.      */
  62.     @Override
  63.     protected void configure(HttpSecurity http) throws Exception {
  64.         http.authorizeRequests()
  65.                 .anyRequest().authenticated()
  66.                 .and()
  67.                 .formLogin()
  68.                 .and()
  69.                 .csrf().disable() ;
  70.     }
  71. }
  72.  

  1. package com.bjpowenrode.oauth.config;
  2.  
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.security.authentication.AuthenticationManager;
  5. import org.springframework.security.core.userdetails.UserDetailsService;
  6. import org.springframework.security.crypto.password.PasswordEncoder;
  7. import org.springframework.security.oauth2.config.annotation.configurers.ClientDetailsServiceConfigurer;
  8. import org.springframework.security.oauth2.config.annotation.web.configuration.AuthorizationServerConfigurerAdapter;
  9. import org.springframework.security.oauth2.config.annotation.web.configuration.EnableAuthorizationServer;
  10. import org.springframework.security.oauth2.config.annotation.web.configurers.AuthorizationServerEndpointsConfigurer;
  11.  
  12. /**
  13.  * @author 千城丶Y
  14.  * @className : AuthorizationServerConfig
  15.  * @PACKAGE_NAME : com.bjpowenrode.oauth.config
  16.  * @date : 2022/9/21 18:28
  17.  * @Description TODO 授权服务器配置
  18.  */
  19. @Configuration
  20. @EnableAuthorizationServer // 启用授权服务器
  21. public class AuthorizationServerConfig extends AuthorizationServerConfigurerAdapter {
  22.     private final PasswordEncoder passwordEncoder ;
  23.     private final UserDetailsService userDetailsService ;
  24.     /**
  25.      * 注入进来 认证管理器
  26.      */
  27.     private final AuthenticationManager authenticationManager ;
  28.  
  29.     public AuthorizationServerConfig(PasswordEncoder passwordEncoder, UserDetailsService userDetailsService, AuthenticationManager authenticationManager) {
  30.         this.passwordEncoder = passwordEncoder;
  31.         this.userDetailsService = userDetailsService;
  32.         this.authenticationManager = authenticationManager;
  33.     }
  34.  
  35.     /**
  36.      *  对授权客户端的配置
  37.      *
  38.      *  用来配置授权服务器可以为哪些客户端授权 // id secret redirectURI 使用那种授权模式
  39.      *
  40.      *  {
  41.      *     "access_token": "becac041-faf4-4b2d-8c58-8b10a38f290f",
  42.      *     "token_type": "bearer",
  43.      *     "refresh_token": "4752515d-f528-4932-a255-d20cdb5e95c4",
  44.      *     "expires_in": 43199,
  45.      *     "scope": "read:user"
  46.      * }
  47.      * */
  48.     @Override
  49.     public void configure(ClientDetailsServiceConfigurer clients) throws Exception {
  50.             clients
  51.                     .inMemory() // 表示基于内存
  52.                     .withClient("clientId" ) // 设置客户端编号
  53.                     .secret(passwordEncoder.encode("secret")) // 设置客户端密钥 ,这里官方规定secret必现加密 可以使用 passwordEncode
  54.                     .redirectUris("http://www.baidu.com") // 重定向URI
  55.                     // authorization_code 授权码   refresh_token 刷新令牌  implicit 简化模式   password 密码模式  client_credentials 客户端模式
  56.                     // 暂不支持简化模式, 因为需要解析一段脚本来获取令牌
  57.                     .authorizedGrantTypes("authorization_code","refresh_token","implicit","password","client_credentials") // 表示使用那种授权模式 可以设置支持多种，授权码模式
  58.                     .scopes("read:user");// 令牌允许获取资源权限
  59.     }
  60.  
  61.     // 授权码这种模式：
  62.     // 1.请求用户是否授权 /oauth/authorize
  63.     // 完整路径 : http://localhost:8080/oauth/authorize?client_id=clientId&response_type=code&redirect_uri=http://www.baidu.com
  64.     // 2.授权之后根据获取的授权码获取令牌 /oauth/token 参数 ： client_id secret redirect_uri code
  65.     // 完整路径 :curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'grant_type=authorization_code&code=2qewq&redirect_uri=http://www.baidu.com' "http://client:secret@localhost:8080/oauth/token"
  66.  
  67.     // 3.支持令牌刷新 /oauth/token 参数 id secret 授权类型 :refresh_token 刷新的令牌:refresh_token
  68.     // 完整路径  :curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'grant_type=refresh_token&refresh_token=2qewq&redirect_uri=http://www.baidu.com' "http://client:secret@localhost:8080/oauth/token"
  69.  
  70.     /**
  71.      * 开启刷新令牌功能  实现刷新令牌必现指定userDetailsService ，有了它，刷新令牌时就不需要在获取授权码了 刷新令牌和  获取令牌的路径是一样的 参数多了
  72.      */
  73.     @Override
  74.     public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
  75.         endpoints.userDetailsService(userDetailsService); // 开启刷新令牌必现指定
  76.         endpoints.authenticationManager(authenticationManager); // 密码模式需要注入 authenticationManager
  77.     }
  78. }

启动服务，登录之后进行授权获取

1.先登录

2.访问授权路径 获取授权码

http://localhost:8080/oauth/authorize?client_id=clientId&response_type=code&redirect_uri=http://www.baidu.com

3.允许授权后会从客户端授权码，并跳转到重定向URI

4.根据授权码，申请令牌

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d ' grant_type=authorization_code&code=IWvwq&redirect_uri=http://www.baidu.com' "http://client:secret@localhost:8080/oauth/token"

注意授权码是一次性的

PostMian请求 方法：

使用介绍：Spring Cloud OAuth2中访问/oauth/token报401 Unauthorized问题的解决(POSTMAN) - mangoubiubiu - 博客园

路径：http://client:secret@localhost:8080/oauth/token

参数：

  • grant_type：授权类型，填写authorization_code，表示授权码模式
  • code：授权码，就是刚刚获取的授权码，注意：授权码只使用一次就无效了，需要重新申请。
  • client_id:客户端标识
  • redirect_uri：申请授权码时的跳转url，一定和申请授权码时用的redirect_uri一致。
  • scope:授权范围。

还需要在Authorzation 写上你配的client_id 和 client-secret

 

5.刷新令牌

首先需要开启了刷新令牌功能

刷新令牌的路径和获取令牌的路径是一样的

支持令牌刷新 /oauth/token 参数 id secret 授权类型 :refresh_token 刷新的令牌:refresh_token

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'grant_type=refresh_token&refresh_token=2qewq&redirect_uri=http://www.baidu.com' "http://client:secret@localhost:8080/oauth/token"

Postmain 使用

6.简化模式

7.密码模式

8.密码模式刷新令牌

9.客户端模式获取令牌

2 基于数据库客户端和令牌存储

将客户端信息和令牌信息转为数据库存储

在上面的案例中，TokenStore 的默认实现 为 InMemoryTokenStore 即内存存储，对于 Client 信息，ClientDetailsService 接口负责从存储仓库中读取数据，在上面的案例中默认使用的也是 InMemoryClientDetailsService 实现类。

如果要想使用数据库存储，只要提供这些接口的实现类即可，而框架已经为我们写好 JdbcTokenStore 和 JdbcDetailsService

建表：

https://github.com/spring-projects/spring-security-oauth/blob/master/spring-security-oauth2/src/test/resources/schema.sql

  1. # 注意：并用BLOB 替换语句中的 LONGVARBINARY 类型
  2.  
  3. -- used in tests that use HSQL
  4. create table oauth_client_details (
  5.   client_id VARCHAR(256) PRIMARY KEY,
  6.   resource_ids VARCHAR(256),
  7.   client_secret VARCHAR(256),
  8.   scope VARCHAR(256),
  9.   authorized_grant_types VARCHAR(256),
  10.   web_server_redirect_uri VARCHAR(256),
  11.   authorities VARCHAR(256),
  12.   access_token_validity INTEGER,
  13.   refresh_token_validity INTEGER,
  14.   additional_information VARCHAR(4096),
  15.   autoapprove VARCHAR(256)
  16. );
  17.  
  18. create table oauth_client_token (
  19.   token_id VARCHAR(256),
  20.   token BLOB,
  21.   authentication_id VARCHAR(256) PRIMARY KEY,
  22.   user_name VARCHAR(256),
  23.   client_id VARCHAR(256)
  24. );
  25.  
  26. create table oauth_access_token (
  27.   token_id VARCHAR(256),
  28.   token BLOB,
  29.   authentication_id VARCHAR(256) PRIMARY KEY,
  30.   user_name VARCHAR(256),
  31.   client_id VARCHAR(256),
  32.   authentication BLOB,
  33.   refresh_token VARCHAR(256)
  34. );
  35.  
  36. create table oauth_refresh_token (
  37.   token_id VARCHAR(256),
  38.   token BLOB,
  39.   authentication BLOB
  40. );
  41.  
  42. create table oauth_code (
  43.   code VARCHAR(256), authentication LONGVARBINARY
  44. );
  45.  
  46. create table oauth_approvals (
  47. 	userId VARCHAR(256),
  48. 	clientId VARCHAR(256),
  49. 	scope VARCHAR(256),
  50. 	status VARCHAR(10),
  51. 	expiresAt TIMESTAMP,
  52. 	lastModifiedAt TIMESTAMP
  53. );
  54.  
  55.  
  56. -- customized oauth_client_details table
  57. create table ClientDetails (
  58.   appId VARCHAR(256) PRIMARY KEY,
  59.   resourceIds VARCHAR(256),
  60.   appSecret VARCHAR(256),
  61.   scope VARCHAR(256),
  62.   grantTypes VARCHAR(256),
  63.   redirectUrl VARCHAR(256),
  64.   authorities VARCHAR(256),
  65.   access_token_validity INTEGER,
  66.   refresh_token_validity INTEGER,
  67.   additionalInformation VARCHAR(4096),
  68.   autoApproveScopes VARCHAR(256)
  69. );
  70.  
  71. -- 写入客户端信息
  72. INSERT INTO `oauth_client_details` VALUES ('clientId', '', '$2a$10$rvtuV.bPeFA5zfowgr9OJuQSj07AFJfHl5Y7QND0thykzlB7S8hW6', 'read', 'authorization_code,refresh_token', 'http://www.baidu.com', NULL, NULL, NULL, NULL, NULL);

主要用到表：

oauth_client_details : 客户端信息 oauth_client_details 的 auhoapprove 是否自动授权

oauth_client_token :存放令牌信息

1.引入依赖

  1.     <!--引入数据库依赖-->
  2.         <dependency>
  3.             <groupId>mysql</groupId>
  4.             <artifactId>mysql-connector-java</artifactId>
  5.         </dependency>
  6.         <dependency>
  7.             <groupId>org.springframework.boot</groupId>
  8.             <artifactId>spring-boot-starter-jdbc</artifactId>
  9.         </dependency>

2.编写配置文件

  1. # 添加数据库配置
  2. spring.datasource.driver-class-name=com.mysql.jdbc.Driver
  3. spring.datasource.url=jdbc:mysql://localhost:3306/oauth?characterEncoding=UTF-8&serverTimezone=UTC&useSSL=false
  4. spring.datasource.username=root
  5. spring.datasource.password=admin

3.编写数据库信息实现

  1. package com.bjpowenrode.oauth.config;
  2.  
  3. import jdk.nashorn.internal.parser.Token;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  6. import org.springframework.security.authentication.AuthenticationManager;
  7. import org.springframework.security.crypto.password.PasswordEncoder;
  8. import org.springframework.security.oauth2.config.annotation.configurers.ClientDetailsServiceConfigurer;
  9. import org.springframework.security.oauth2.config.annotation.web.configuration.AuthorizationServerConfigurerAdapter;
  10. import org.springframework.security.oauth2.config.annotation.web.configuration.EnableAuthorizationServer;
  11. import org.springframework.security.oauth2.config.annotation.web.configurers.AuthorizationServerEndpointsConfigurer;
  12. import org.springframework.security.oauth2.provider.ClientDetailsService;
  13. import org.springframework.security.oauth2.provider.client.JdbcClientDetailsService;
  14. import org.springframework.security.oauth2.provider.token.DefaultTokenServices;
  15. import org.springframework.security.oauth2.provider.token.TokenStore;
  16. import org.springframework.security.oauth2.provider.token.store.JdbcTokenStore;
  17.  
  18. import javax.sql.DataSource;
  19. import java.util.concurrent.TimeUnit;
  20.  
  21. /**
  22.  * @author 千城丶Y
  23.  * @className : JdbcAuthorizationServerConfig
  24.  * @PACKAGE_NAME : com.bjpowenrode.oauth.config
  25.  * @date : 2022/9/21 23:17
  26.  * @Description TODO 基于数据库的客户端信息和令牌的 授权服务器配置
  27.  */
  28. @Configuration
  29. @EnableAuthorizationServer
  30. public class JdbcAuthorizationServerConfig extends AuthorizationServerConfigurerAdapter {
  31.  
  32.     private final AuthenticationManager authenticationManager ;
  33.     private final PasswordEncoder passwordEncoder ;
  34.     private final DataSource dataSource ;
  35.  
  36.     public JdbcAuthorizationServerConfig(AuthenticationManager authenticationManager, PasswordEncoder passwordEncoder, DataSource dataSource) {
  37.         this.authenticationManager = authenticationManager;
  38.         this.passwordEncoder = passwordEncoder;
  39.         this.dataSource = dataSource;
  40.     }
  41.  
  42.     /**
  43.      * 声明基于数据库实现的存储方式
  44.      */
  45.     @Bean
  46.     public TokenStore tokenStore (){
  47.         return  new JdbcTokenStore(dataSource);
  48.     }
  49.  
  50.     /**
  51.      * 声明 基于数据库实现的ClientDetails 用于存储和查询客户端信息和令牌
  52.      */
  53.     @Bean
  54.     public ClientDetailsService detailsService (){
  55.         JdbcClientDetailsService jdbcClientDetailsService = new JdbcClientDetailsService(dataSource);
  56.         jdbcClientDetailsService.setPasswordEncoder(passwordEncoder); // 用于加密和解密  密钥
  57.         return jdbcClientDetailsService;
  58.     }
  59.  
  60.     /**
  61.      *  配置使用数据库实现
  62.      */
  63.     @Override
  64.     public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
  65.         endpoints.authenticationManager(authenticationManager) ; // 认证管理器
  66.         endpoints.tokenStore(tokenStore()); // 配置令牌存储为数据库存储
  67.  
  68.         // 配置 TokenService 参数
  69.         DefaultTokenServices tokenServices = new DefaultTokenServices(); // 修改默认生成令牌服务
  70.         tokenServices.setTokenStore(endpoints.getTokenStore()); // 基于数据库令牌生成
  71.         tokenServices.setSupportRefreshToken(true); // 是否支持刷新令牌
  72.         tokenServices.setReuseRefreshToken(true); // 是否支持重复使用刷新令牌 （直到过期）
  73.  
  74.         tokenServices.setClientDetailsService(endpoints.getClientDetailsService());// 设置客户端信息
  75.         tokenServices.setTokenEnhancer(endpoints.getTokenEnhancer()); // 用来控制令牌存储增强策略
  76.         // 访问令牌的默认有效 (以秒为单位) 。过期的令牌为零或负数。
  77.         tokenServices.setAccessTokenValiditySeconds((int) TimeUnit.DAYS.toSeconds(30)) ;// 30天
  78.         // 刷新令牌的有效性（以秒为单位）。如果小于或等于零，则令牌将不会过期
  79.         tokenServices.setRefreshTokenValiditySeconds((int)TimeUnit.DAYS.toSeconds(3));// 3天
  80.         endpoints.tokenServices(tokenServices); // 使用配置令牌服务
  81.     }
  82.  
  83.     @Override
  84.     public void configure(ClientDetailsServiceConfigurer clients) throws Exception {
  85.         clients.withClientDetails(detailsService()); // 使用JDBC存储
  86.     }
  87. }

4.启动测试，发现数据库中已经存储相关令牌。

 

5.总结

        切换方式主要是通过 TokenStore 它是一个接口有多种实现方式

3.资源服务器搭建

        资源服务器不仅需要引入资源服务器依赖还需要引入授权服务器依赖，因为资源服务器需要认证请求所携带的令牌，令牌验证可以通过 http请求或者两者基于同一个数据库查询方式，或者使用JWT的方式，两者使用相同的 secret 。

        资源服务器接受到请求后首先需要进行令牌校验，当客户端拿着颁发的额令牌向资源服务器索要资源时，资源服务器就需要验证令牌，验证令牌可以通过http请求向授权访问器校验，但这样不是百分百能获取的，还有一种方式是通过授权服务器和资源服务器共享同一个数据库，数据库中存放这令牌信息资源服务器直接根据数据库进行校验就可以了，可以使用redis解决分布式的方式，也就是黑板模式，引入授权服的依赖就是为了访问数据库进行令牌机制.

1.引入依赖

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <groupId>com.bjpowernode</groupId>
  6.     <artifactId>ch022-spring-security-oauth2-resource-server</artifactId>
  7.     <version>0.0.1-SNAPSHOT</version>
  8.     <name>ch022-spring-security-oauth2-resource-server</name>
  9.     <description>ch022-spring-security-oauth2-resource-server</description>
  10.  
  11.     <properties>
  12.         <java.version>1.8</java.version>
  13.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  14.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  15.         <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
  16.         <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
  17.     </properties>
  18.  
  19.     <dependencies>
  20.         <!--web依赖-->
  21.         <dependency>
  22.             <groupId>org.springframework.boot</groupId>
  23.             <artifactId>spring-boot-starter-web</artifactId>
  24.         </dependency>
  25.         <!--授权服务器依赖-->
  26.         <dependency>
  27.             <groupId>org.springframework.cloud</groupId>
  28.             <artifactId>spring-cloud-starter-oauth2</artifactId>
  29.         </dependency>
  30.         <!--资源服务器依赖-->
  31.         <dependency>
  32.             <groupId>org.springframework.security</groupId>
  33.             <artifactId>spring-security-oauth2-resource-server</artifactId>
  34.         </dependency>
  35.         <!--spring security 依赖-->
  36.         <dependency>
  37.             <groupId>org.springframework.boot</groupId>
  38.             <artifactId>spring-boot-starter-security</artifactId>
  39.         </dependency>
  40.         <!--mysql-->
  41.         <dependency>
  42.             <groupId>mysql</groupId>
  43.             <artifactId>mysql-connector-java</artifactId>
  44.         </dependency>
  45.         <!--jdbc-->
  46.         <dependency>
  47.             <groupId>org.springframework.boot</groupId>
  48.             <artifactId>spring-boot-starter-jdbc</artifactId>
  49.         </dependency>
  50.  
  51.         <dependency>
  52.             <groupId>org.springframework.boot</groupId>
  53.             <artifactId>spring-boot-starter-test</artifactId>
  54.             <scope>test</scope>
  55.             <exclusions>
  56.                 <exclusion>
  57.                     <groupId>org.junit.vintage</groupId>
  58.                     <artifactId>junit-vintage-engine</artifactId>
  59.                 </exclusion>
  60.             </exclusions>
  61.         </dependency>
  62.     </dependencies>
  63.  
  64.     <dependencyManagement>
  65.         <dependencies>
  66.             <dependency>
  67.                 <groupId>org.springframework.cloud</groupId>
  68.                 <artifactId>spring-cloud-dependencies</artifactId>
  69.                 <version>${spring-cloud.version}</version>
  70.                 <type>pom</type>
  71.                 <scope>import</scope>
  72.             </dependency>
  73.             <dependency>
  74.                 <groupId>org.springframework.boot</groupId>
  75.                 <artifactId>spring-boot-dependencies</artifactId>
  76.                 <version>${spring-boot.version}</version>
  77.                 <type>pom</type>
  78.                 <scope>import</scope>
  79.             </dependency>
  80.         </dependencies>
  81.     </dependencyManagement>
  82.  
  83.     <build>
  84.         <plugins>
  85.             <plugin>
  86.                 <groupId>org.apache.maven.plugins</groupId>
  87.                 <artifactId>maven-compiler-plugin</artifactId>
  88.                 <version>3.8.1</version>
  89.                 <configuration>
  90.                     <source>1.8</source>
  91.                     <target>1.8</target>
  92.                     <encoding>UTF-8</encoding>
  93.                 </configuration>
  94.             </plugin>
  95.             <plugin>
  96.                 <groupId>org.springframework.boot</groupId>
  97.                 <artifactId>spring-boot-maven-plugin</artifactId>
  98.                 <version>2.3.7.RELEASE</version>
  99.                 <configuration>
  100.                     <mainClass>com.bjpowernode.Ch022SpringSecurityOauth2ResourceServerApplication</mainClass>
  101.                 </configuration>
  102.                 <executions>
  103.                     <execution>
  104.                         <id>repackage</id>
  105.                         <goals>
  106.                             <goal>repackage</goal>
  107.                         </goals>
  108.                     </execution>
  109.                 </executions>
  110.             </plugin>
  111.         </plugins>
  112.     </build>
  113.  
  114. </project>

2.创建资源

  1. package com.bjpowernode.controller;
  2.  
  3. import org.springframework.web.bind.annotation.GetMapping;
  4. import org.springframework.web.bind.annotation.RestController;
  5.  
  6. /**
  7.  * @author 千城丶Y
  8.  * @className : IndexController
  9.  * @PACKAGE_NAME : com.bjpowernode.controller
  10.  * @date : 2022/9/21 23:59
  11.  * @Description TODO
  12.  */
  13. @RestController
  14. public class IndexController {
  15.  
  16.     @GetMapping("/hello")
  17.     public String hello(){
  18.         return "hello!";
  19.     }
  20. }

3.编写资源服务器配置类

  1. package com.bjpowernode.config;
  2.  
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.security.oauth2.config.annotation.web.configuration.EnableResourceServer;
  6. import org.springframework.security.oauth2.config.annotation.web.configuration.ResourceServerConfigurerAdapter;
  7. import org.springframework.security.oauth2.config.annotation.web.configurers.ResourceServerSecurityConfigurer;
  8. import org.springframework.security.oauth2.provider.token.TokenStore;
  9. import org.springframework.security.oauth2.provider.token.store.JdbcTokenStore;
  10.  
  11. import javax.sql.DataSource;
  12.  
  13. /**
  14.  * @author 千城丶Y
  15.  * @className : ResourceServer
  16.  * @PACKAGE_NAME : com.bjpowernode.config
  17.  * @date : 2022/9/22 0:00
  18.  * @Description TODO 资源配置服务器
  19.  */
  20. @Configuration
  21. @EnableResourceServer // 启动资源服务器
  22. public class ResourceServer extends ResourceServerConfigurerAdapter {
  23.     private final DataSource dataSource;
  24.  
  25.     public ResourceServer(DataSource dataSource) {
  26.         this.dataSource = dataSource;
  27.     }
  28.  
  29.  
  30.     /**
  31.      * 基于数据库的认证
  32.      * @return
  33.      */
  34.     @Bean
  35.     public TokenStore tokenStore (){
  36.         return new JdbcTokenStore(dataSource);
  37.     }
  38.  
  39.     @Override
  40.     public void configure(ResourceServerSecurityConfigurer resources) throws Exception {
  41.         resources.tokenStore(tokenStore());
  42.     }
  43. }

4.编写配置文件

  1. # 应用名称
  2. spring.application.name=ch022-spring-security-oauth2-resource-server
  3. # 应用服务 WEB 访问端口
  4. server.port=8081
  5.  
  6.  
  7.  
  8. # 添加数据库配置
  9. spring.datasource.driver-class-name=com.mysql.jdbc.Driver
  10. spring.datasource.url=jdbc:mysql://localhost:3306/oauth?characterEncoding=UTF-8&serverTimezone=UTC&useSSL=false
  11. spring.datasource.username=root
  12. spring.datasource.password=admin

5.启动测试，生成令牌之后带有令牌访问：

curl -H "Authorization:Bearer deff--213-21312-213jk213-1231j2k" http://localhost:8081/hello

测试时，需要在 请求头中携带 Authorization:Bearer deff--213-21312-213jk213-1231j2k

四、JWT的应用

将授权服务器和资源服务器的类型令牌类型都替换为JWT的方式，这种方式效率最高。

资源服务器验证授权令牌常见的两种方式都有弊端：

1.通过http请求向授权服务器方式请求认证，可能会受到网络的问题，

2.通过将令牌存放到数据库或redis中，资源服务器和授权服务器使用同一个，这样如果分布式分库就会有问题’

3.所以最好是使用jwt ，使用jwt的好处，就是jwt有自己一套规范，授权办法的jwt令牌，资源服务器只需要使用相对的jwt规范进行验证就行

jwt生成是三部分，最核心的就是密钥，它是根据密钥进行生成和解析的，所有授权服务器和认证服务器的密钥要是相同的

4.1 授权服务器颁发 JWT 令牌

1.配置颁发 JWT 令牌

JWT header.payload.sin + 秘钥OPSTATA jwt+Resource ServerOPSATA

  1. package com.bjpowenrode.oauth.config;
  2.  
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.security.authentication.AuthenticationManager;
  6. import org.springframework.security.crypto.password.PasswordEncoder;
  7. import org.springframework.security.jwt.Jwt;
  8. import org.springframework.security.oauth2.config.annotation.configurers.ClientDetailsServiceConfigurer;
  9. import org.springframework.security.oauth2.config.annotation.web.configuration.AuthorizationServerConfigurerAdapter;
  10. import org.springframework.security.oauth2.config.annotation.web.configuration.EnableAuthorizationServer;
  11. import org.springframework.security.oauth2.config.annotation.web.configurers.AuthorizationServerEndpointsConfigurer;
  12. import org.springframework.security.oauth2.provider.ClientDetailsService;
  13. import org.springframework.security.oauth2.provider.client.JdbcClientDetailsService;
  14. import org.springframework.security.oauth2.provider.token.DefaultTokenServices;
  15. import org.springframework.security.oauth2.provider.token.TokenStore;
  16. import org.springframework.security.oauth2.provider.token.store.JdbcTokenStore;
  17. import org.springframework.security.oauth2.provider.token.store.JwtAccessTokenConverter;
  18. import org.springframework.security.oauth2.provider.token.store.JwtTokenStore;
  19.  
  20. import javax.sql.DataSource;
  21. import java.util.concurrent.TimeUnit;
  22.  
  23. /**
  24.  * @author 千城丶Y
  25.  * @className : JdbcAuthorizationServerConfig
  26.  * @PACKAGE_NAME : com.bjpowenrode.oauth.config
  27.  * @date : 2022/9/21 23:17
  28.  * @Description TODO 基于JWT令牌的 授权服务器配置
  29.  */
  30. @Configuration
  31. @EnableAuthorizationServer
  32. public class JWTAuthorizationServerConfig extends AuthorizationServerConfigurerAdapter {
  33.  
  34.     private final AuthenticationManager authenticationManager ;
  35.     private final PasswordEncoder passwordEncoder ;
  36.     private final DataSource dataSource ;
  37.  
  38.     public JWTAuthorizationServerConfig(AuthenticationManager authenticationManager, PasswordEncoder passwordEncoder, DataSource dataSource) {
  39.         this.authenticationManager = authenticationManager;
  40.         this.passwordEncoder = passwordEncoder;
  41.         this.dataSource = dataSource;
  42.     }
  43.  
  44.     /**
  45.      * 声明基于jwt实现令牌的存储方式
  46.      */
  47.     @Bean
  48.     public TokenStore tokenStore (){
  49.         return  new JwtTokenStore(jwtAccessTokenConverter());
  50.     }
  51.  
  52.     /**
  53.      * 声明 基于数据库实现的ClientDetails 用于存储和查询客户端信息和令牌
  54.      */
  55.     @Bean
  56.     public ClientDetailsService detailsService (){
  57.         JdbcClientDetailsService jdbcClientDetailsService = new JdbcClientDetailsService(dataSource);
  58.         jdbcClientDetailsService.setPasswordEncoder(passwordEncoder); // 用于加密和解密  密钥
  59.         return jdbcClientDetailsService;
  60.     }
  61.  
  62.     /**
  63.      *  配置使用基于 jwt 方式颁发令牌，同时配置 jwt转换器
  64.      */
  65.     @Override
  66.     public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
  67.         endpoints.tokenStore(tokenStore())
  68.                 .accessTokenConverter(jwtAccessTokenConverter())
  69.                 .authenticationManager(authenticationManager);
  70.     }
  71.     // 使用同一个密钥来编码 JWT OAuth2 令牌
  72.     @Bean
  73.     public JwtAccessTokenConverter jwtAccessTokenConverter (){
  74.         JwtAccessTokenConverter jwtAccessTokenConverter = new JwtAccessTokenConverter();
  75.         jwtAccessTokenConverter.setSigningKey("123"); // 可以采用属性注入方式，生产中建议加密 ，密钥的key 很重要
  76.         return jwtAccessTokenConverter;
  77.     }
  78.     @Override
  79.     public void configure(ClientDetailsServiceConfigurer clients) throws Exception {
  80.         clients.withClientDetails(detailsService()); // 使用JDBC存储
  81.     }
  82. }

2.启动服务，根据授权码获取令牌

4.2.使用 JWT 令牌资源服务器

1.配置资源服务器解析 jwt 

  1. /**
  2.  * @author 千城丶Y
  3.  * @className : ResourceServer
  4.  * @PACKAGE_NAME : com.bjpowernode.config
  5.  * @date : 2022/9/22 0:00
  6.  * @Description TODO 基于JWT令牌认证 ，资源配置服务器
  7.  */
  8. @Configuration
  9. @EnableResourceServer // 启动资源服务器
  10. public class JWTResourceServer extends ResourceServerConfigurerAdapter {
  11.     private final DataSource dataSource;
  12.  
  13.     public JWTResourceServer(DataSource dataSource) {
  14.         this.dataSource = dataSource;
  15.     }
  16.  
  17.  
  18.     /**
  19.      * 基于JWT的认证
  20.      * @return
  21.      */
  22.     @Bean
  23.     public TokenStore tokenStore (){
  24.         return new JwtTokenStore(jwtAccessTokenConverter());
  25.     }
  26.     // 使用同一个密钥来编码 JWT OAuth2 令牌
  27.     @Bean
  28.     public JwtAccessTokenConverter jwtAccessTokenConverter (){
  29.         JwtAccessTokenConverter jwtAccessTokenConverter = new JwtAccessTokenConverter();
  30.         jwtAccessTokenConverter.setSigningKey("123"); // 可以采用属性注入方式，生产中建议加密 ，密钥的key 很重要
  31.         return jwtAccessTokenConverter;
  32.     }
  33.     @Override
  34.     public void configure(ResourceServerSecurityConfigurer resources) throws Exception {
  35.         resources.tokenStore(tokenStore());
  36.     }
  37. }

2.启动测试，通过jwt测试访问资源

curl -H "Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NjM4MjA5MTYsInVzZXJfbmFtZSI6InJvb3QiLCJhdXRob3JpdGllcyI6WyJST0xFX2FkbWluIl0sImp0aSI6IjQyYmNiMDIzLTJmZTAtNDk1My05Y2Q3LWExNmVlNGU1N2RkMyIsImNsaWVudF9pZCI6ImNsaWVudElkIiwic2NvcGUiOlsicmVhZCJdfQ._wMSXarEFbtEjZmXEzv2qfPni4cpiIm4krXWLy6c_-Y" http://localhost:8081/hello

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/花生_TL007/article/detail/390146
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号