Spring Security Oauth2 的配置

使用oauth2保护你的应用，可以分为简易的分为三个步骤

• 配置资源服务器
• 配置认证服务器
• 配置spring security

前两点是oauth2的主体内容，但前面我已经描述过了，spring security oauth2是建立在spring security基础之上的，所以有一些体系是公用的。

oauth2根据使用场景不同，分成了4种模式

• 授权码模式（authorization code）
• 简化模式（implicit）
• 密码模式（resource owner password credentials）
• 客户端模式（client credentials）

本文重点讲解接口对接中常使用的密码模式（以下简称password模式）和客户端模式（以下简称client模式）。授权码模式使用到了回调地址，是最为复杂的方式，通常网站中经常出现的微博，qq第三方登录，都会采用这个形式。简化模式不常用。

配置资源服务器和授权服务器

由于是两个oauth2的核心配置，我们放到一个配置类中。 
为了方便下载代码直接运行，我这里将客户端信息放到了内存中，生产中可以配置到数据库中。token的存储一般选择使用redis，一是性能比较好，二是自动过期的机制，符合token的特性。

 @Configuration
 public class OAuth2ServerConfig {

     private static final String RESOURCE_ID = "wymlib";
     //资源配置服务器
     @Configuration
     @EnableResourceServer
     @Order(110)
     protected static class ResourceServerConfiguration extends ResourceServerConfigurerAdapter {

         @Override
         public void configure(ResourceServerSecurityConfigurer resources) {
             resources.resourceId(RESOURCE_ID).stateless(true);
         }

         @Override
         public void configure(HttpSecurity http) throws Exception {
             http.sessionManagement().sessionCreationPolicy(SessionCreationPolicy.IF_REQUIRED)
                 .and()
                 .requestMatchers().anyRequest()
                 .and()
                 .anonymous()
                 .and()
                 .authorizeRequests()
                 .antMatchers("/api/v1/**").authenticated();//配置访问控制，必须认证过后才可以访问
         }
     }

     //认证服务器
     @Configuration
     @EnableAuthorizationServer
     @Order(99)
     protected static class AuthorizationServerConfiguration extends AuthorizationServerConfigurerAdapter {

         @Autowired
         AuthenticationManager authenticationManager;
 //        @Autowired
 //        RedisConnectionFactory redisConnectionFactory;

         @Value("${config.oauth2.clientID}")
         String clientID;

         @Value("${config.oauth2.clientSecret}")
         String clientSecret;

         @Value("${config.oauth2.accessTokenValiditySeconds}")
         int accessTokenValiditySeconds;

         @Override
         public void configure(ClientDetailsServiceConfigurer clients) throws Exception {
             clients.inMemory().withClient(clientID)
                     .resourceIds(RESOURCE_ID)
                     .authorizedGrantTypes("client_credentials", "refresh_token")
                     .scopes("select")
                     .authorities("client")
                     .secret(clientSecret)
                     .accessTokenValiditySeconds(accessTokenValiditySeconds);
         }

         /*@Override
         public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
             endpoints.tokenStore(new RedisTokenStore(redisConnectionFactory))
                     .authenticationManager(authenticationManager);
         }*/

         @Override
         public void configure(AuthorizationServerSecurityConfigurer oauthServer) throws Exception {
             //允许表单认证
             oauthServer.allowFormAuthenticationForClients();
         }

     }

 }

简单说下spring security oauth2的认证思路。

• client模式，没有用户的概念，直接与认证服务器交互，用配置中的客户端信息去申请accessToken，客户端有自己的client_id,client_secret对应于用户的username,password，而客户端也拥有自己的authorities，当采取client模式认证时，对应的权限也就是客户端自己的authorities。

• password模式，自己本身有一套用户体系，在认证时需要带上自己的用户名和密码，以及客户端的client_id,client_secret。此时，accessToken所包含的权限是用户本身的权限，而不是客户端的权限。

我对于两种模式的理解便是，如果你的系统已经有了一套用户体系，每个用户也有了一定的权限，可以采用password模式；如果仅仅是接口的对接，不考虑用户，则可以使用client模式。

配置spring security

在spring security的版本迭代中，产生了多种配置方式，建造者模式，适配器模式等等设计模式的使用，spring security内部的认证flow也是错综复杂，在我一开始学习ss也产生了不少困惑，总结了一下配置经验：使用了springboot之后，spring security其实是有不少自动配置的，我们可以仅仅修改自己需要的那一部分，并且遵循一个原则，直接覆盖最需要的那一部分。这一说法比较抽象，举个例子。比如配置内存中的用户认证器。有两种配置方式

 planA：

 @Bean
 protected UserDetailsService userDetailsService(){
     InMemoryUserDetailsManager manager = new InMemoryUserDetailsManager();
     manager.createUser(User.withUsername("user_1").password("123456").authorities("USER").build());
     manager.createUser(User.withUsername("user_2").password("123456").authorities("USER").build());
     return manager;
 }
 planB：

 @Configuration
 @EnableWebSecurity
 public class SecurityConfiguration extends WebSecurityConfigurerAdapter {

     @Override
     protected void configure(AuthenticationManagerBuilder auth) throws Exception {
         auth.inMemoryAuthentication()
                 .withUser("user_1").password("123456").authorities("USER")
                 .and()
                 .withUser("user_2").password("123456").authorities("USER");
    }

    @Bean
    @Override
    public AuthenticationManager authenticationManagerBean() throws Exception {
        AuthenticationManager manager = super.authenticationManagerBean();
         return manager;
     }
 }

你最终都能得到配置在内存中的两个用户，前者是直接替换掉了容器中的UserDetailsService，这么做比较直观；后者是替换了AuthenticationManager，当然你还会在SecurityConfiguration 复写其他配置，这么配置最终会由一个委托者去认证。如果你熟悉spring security，会知道AuthenticationManager和AuthenticationProvider以及UserDetailsService的关系，他们都是顶级的接口，实现类之间错综复杂的聚合关系…配置方式千差万别，但理解清楚认证流程，知道各个实现类对应的职责才是掌握spring security的关键。

下面给出我最终的配置：

 @Configuration
 @EnableWebSecurity
 public class SecurityConfiguration extends WebSecurityConfigurerAdapter {

     @Bean
     @Override
     protected UserDetailsService userDetailsService(){
         InMemoryUserDetailsManager manager = new InMemoryUserDetailsManager();
         manager.createUser(User.withUsername("user_1").password("123456").authorities("USER").build());
         manager.createUser(User.withUsername("user_2").password("123456").authorities("USER").build());
         return manager;
     }

     @Override
     protected void configure(HttpSecurity http) throws Exception {
         // @formatter:off
         http
             .requestMatchers().anyRequest()
             .and()
                 .authorizeRequests()
                 .antMatchers("/oauth/*").permitAll();
         // @formatter:on
     }
 }

重点就是配置了一个UserDetailsService，和ClientDetailsService一样，为了方便运行，使用内存中的用户，实际项目中，一般使用的是数据库保存用户，具体的实现类可以使用JdbcDaoImpl或者JdbcUserDetailsManager。

xml配置：

 <!-- OAuth2 URL: /oauth/token 的处理与配置 一般使用时这里不需要修改, 直接使用即可 -->
     <sec:http pattern="/oauth/token" create-session="stateless"
         authentication-manager-ref="oauth2AuthenticationManager"
         entry-point-ref="oauth2AuthenticationEntryPoint" use-expressions="false">
         <sec:intercept-url pattern="/oauth/token" access="IS_AUTHENTICATED_FULLY" />
         <sec:anonymous enabled="false" />
         <sec:http-basic entry-point-ref="oauth2AuthenticationEntryPoint" />
         <sec:custom-filter ref="clientCredentialsTokenEndpointFilter"
             before="BASIC_AUTH_FILTER" />
         <sec:access-denied-handler ref="oauth2AccessDeniedHandler" />
         <!-- <csrf disabled="true"/> -->
     </sec:http>

     <sec:authentication-manager id="oauth2AuthenticationManager">
         <sec:authentication-provider
             user-service-ref="oauth2ClientDetailsUserService" />
     </sec:authentication-manager>

         <beans:bean id="oauth2ClientDetailsUserService"
         class="org.springframework.security.oauth2.provider.client.ClientDetailsUserDetailsService">
         <beans:constructor-arg ref="clientDetailsService" />
         </beans:bean>

         <!-- 管理 ClientDetails -->
         <beans:bean id="clientDetailsService"
             class="org.springframework.security.oauth2.provider.client.JdbcClientDetailsService">
             <beans:constructor-arg index="0" ref="dataSource" />
         </beans:bean>

     <beans:bean id="oauth2AuthenticationEntryPoint" class="org.springframework.security.oauth2.provider.error.OAuth2AuthenticationEntryPoint" />

     <!-- 处理grant_type=client_credentials 的逻辑 只从请求中获取client_id与client_secret -->
     <beans:bean id="clientCredentialsTokenEndpointFilter"
         class="org.springframework.security.oauth2.provider.client.ClientCredentialsTokenEndpointFilter">
         <beans:property name="authenticationManager" ref="oauth2AuthenticationManager" />
     </beans:bean>

 拦截api/v1：

     <sec:http pattern="/api/v1/**" create-session="never"
         entry-point-ref="oauth2AuthenticationEntryPoint"
         access-decision-manager-ref="oauth2AccessDecisionManager"
         use-expressions="false">
         <sec:anonymous enabled="false" />
         <sec:intercept-url pattern="/api/v1/**"
             access="IS_AUTHENTICATED_ANONYMOUSLY" />
         <sec:custom-filter ref="unityResourceServer" before="PRE_AUTH_FILTER" />
         <sec:access-denied-handler ref="oauth2AccessDeniedHandler" />
     </sec:http>

     <!-- 扩展Spring Security 默认的 AccessDecisionManager 添加对OAuth中 scope 的检查与校验 -->
     <beans:bean id="oauth2AccessDecisionManager"
         class="org.springframework.security.access.vote.UnanimousBased">
         <beans:constructor-arg>
             <beans:list>
                 <beans:bean class="org.springframework.security.oauth2.provider.vote.ScopeVoter" />
                 <beans:bean class="org.springframework.security.access.vote.RoleVoter" />
                 <beans:bean class="org.springframework.security.access.vote.AuthenticatedVoter" />
             </beans:list>
         </beans:constructor-arg>
     </beans:bean>    

     <!-- 每一个资源(resource)的定义, resource-id必须唯一, OauthClientDetails中的resourceIds属性的值由此来的,
         允许一个Client有多个resource-id, 由逗号(,)分隔 每一个定义会在Security Flow中添加一个位于 PRE_AUTH_FILTER
         之前的Filter -->
     <!--unity resource server filter -->
     <oauth2:resource-server id="unityResourceServer"
         resource-id="unity-resource" token-services-ref="tokenServices" />

     <beans:bean id="tokenServices"
         class="org.springframework.security.oauth2.provider.token.DefaultTokenServices">
         <beans:property name="tokenStore" ref="tokenStore" />
         <beans:property name="clientDetailsService" ref="clientDetailsService" />
         <beans:property name="supportRefreshToken" value="true" />
         <beans:property name="accessTokenValiditySeconds"    value="30" />
     </beans:bean>

     <!--Config token services -->
     <!--<beans:bean id="tokenStore" class="org.springframework.security.oauth2.provider.token.InMemoryTokenStore"/> -->
     <beans:bean id="tokenStore"
         class="org.springframework.security.oauth2.provider.token.store.JdbcTokenStore">
         <beans:constructor-arg index="0" ref="dataSource" />
     </beans:bean>

 <!-- Security OAuth Flow的核心配置 每一个配置对应一类具体的grant_type 可根据需求删除或禁用, 如: <oauth2:implicit
         disabled="true"/> 默认支持OAuth2提供的5类grant_type, 若不需要任何一类, 将其配置注释掉(或删掉)即可. 若需要自定义
         authorization url, 在 <oauth2:authorization-server > 配置中添加authorization-endpoint-url,如:
         authorization-endpoint-url="/oauth2/authorization" 若需要自定义 token url, 在 <oauth2:authorization-server
         > 配置中添加token-endpoint-url配置, 如:token-endpoint-url="/oauth2/my_token" -->
     <oauth2:authorization-server
         client-details-service-ref="clientDetailsService" token-services-ref="tokenServices"
         user-approval-handler-ref="oauthUserApprovalHandler"
         user-approval-page="oauth_approval" error-page="oauth_error">
         <oauth2:authorization-code authorization-code-services-ref="jdbcAuthorizationCodeServices" />
         <oauth2:implicit />
         <oauth2:refresh-token />
         <oauth2:client-credentials />
         <oauth2:password />
     </oauth2:authorization-server>

     <beans:bean id="oauthUserApprovalHandler"
         class="org.springframework.security.oauth2.provider.approval.TokenStoreUserApprovalHandler">
         <beans:property name="tokenStore" ref="tokenStore" />
         <beans:property name="clientDetailsService" ref="clientDetailsService" />
         <beans:property name="requestFactory" ref="oAuth2RequestFactory" />
         <!-- <beans:property name="oauthService" ref="oauthService"/> -->
     </beans:bean>

     <!-- 管理 Authorization code -->
     <beans:bean id="jdbcAuthorizationCodeServices"
         class="org.springframework.security.oauth2.provider.code.JdbcAuthorizationCodeServices">
         <beans:constructor-arg index="0" ref="dataSource" />
     </beans:bean>

 请求token的url:
 http://192.9.8.144/ymlib/oauth/token?client_id=aa086e67c36342ed9ab6519247f5b68b&client_secret=mQDUMa03Rdy5vcMWjYHJmitkWJi3Rosr&grant_type=client_credentials

参考资料：

从零开始的Spring Security Oauth2（一）

从零开始的Spring Security Oauth2（二）

从零开始的Spring Security Oauth2（三）