温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

Spring Security怎么自定义授权服务器

发布时间:2022-08-26 10:40:35 来源:亿速云 阅读:130 作者:iii 栏目:开发技术

本篇内容介绍了“Spring Security怎么自定义授权服务器”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!

    前言

    在之前我们已经对接过了GitHub、Gitee客户端,使用OAuth3 Client能够快速便捷的集成第三方登录,集成第三方登录一方面降低了企业的获客成本,同时为用户提供更为便捷的登录体验。
    但是随着企业的发展壮大,越来越有必要搭建自己的OAuth3服务器。
    OAuth3不仅包括前面的OAuth客户端,还包括了授权服务器,在这里我们要通过最小化配置搭建自己的授权服务器。
    授权服务器主要提供OAuth Client注册、用户认证、token分发、token验证、token刷新等功能。实际应用中授权服务器与资源服务器可以在同一个应用中实现,也可以拆分成两个独立应用,在这里为了方便理解,我们拆分成两个应用。

    授权服务器变迁

    授权服务器(Authorization Server)目前并没有集成在Spring Security项目中,而是作为独立项目存在于Spring生态中,图1为Spring Authorization Server 在Spring 项目列表中的位置。

    Spring Security怎么自定义授权服务器

    图1

    Spring Authorization Server 为什么没被集成在Spring Security中呢?

    起因是因为Spring 中的Spring Security OAuth、Spring Cloud Security都对OAuth有自己的实现,Spring团队开始是想把OAuth独立出来放到Spring Security中,但是后面Spring团队意识到OAuth授权服务并不适合包含在Spring Security框架中,于是在2019年11月Spring宣布不在Spring Security中支持授权服务器。原文如下:

    原文:
    Since the Spring Security OAuth project was created, the number of authorization server choices has grown significantly. Additionally, we did not feel like creating an authorization server was a common scenario. Nor did we feel like it was appropriate to provide authorization support within a framework with no library support. After careful consideration, the Spring Security team decided that we would not formally support creating authorization servers.

    但是对于Spring Security不再支持授权服务器,社区反应强烈。于是在2020年4月,Spring推出了Spring Authorization Server项目。
    目前项目最新GA版本为0.3 GA,预览版本1.0.0-M1。

    最小化配置

    安装授权服务器

    1、新创建一个Spring Boot项目,命名为spring-security-authorization-server
    2、引入pom依赖

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
    
    <dependency>
        <groupId>org.springframework.security</groupId>
        <artifactId>spring-security-oauth3-authorization-server</artifactId>
        <version>0.3.1</version>
    </dependency>
    
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    配置授权服务器

    import com.nimbusds.jose.jwk.JWKSet;
    import com.nimbusds.jose.jwk.RSAKey;
    import com.nimbusds.jose.jwk.source.ImmutableJWKSet;
    import com.nimbusds.jose.jwk.source.JWKSource;
    import com.nimbusds.jose.proc.SecurityContext;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.Ordered;
    import org.springframework.core.annotation.Order;
    import org.springframework.security.config.Customizer;
    import org.springframework.security.config.annotation.web.builders.HttpSecurity;
    import org.springframework.security.config.annotation.web.configurers.oauth3.server.authorization.OAuth3AuthorizationServerConfigurer;
    import org.springframework.security.core.userdetails.User;
    import org.springframework.security.core.userdetails.UserDetails;
    import org.springframework.security.core.userdetails.UserDetailsService;
    import org.springframework.security.crypto.factory.PasswordEncoderFactories;
    import org.springframework.security.oauth3.core.AuthorizationGrantType;
    import org.springframework.security.oauth3.core.ClientAuthenticationMethod;
    import org.springframework.security.oauth3.core.oidc.OidcScopes;
    import org.springframework.security.oauth3.server.authorization.client.InMemoryRegisteredClientRepository;
    import org.springframework.security.oauth3.server.authorization.client.RegisteredClient;
    import org.springframework.security.oauth3.server.authorization.client.RegisteredClientRepository;
    import org.springframework.security.oauth3.server.authorization.config.ClientSettings;
    import org.springframework.security.oauth3.server.authorization.config.ProviderSettings;
    import org.springframework.security.provisioning.InMemoryUserDetailsManager;
    import org.springframework.security.web.SecurityFilterChain;
    import org.springframework.security.web.authentication.LoginUrlAuthenticationEntryPoint;
    import org.springframework.security.web.util.matcher.RequestMatcher;
    import java.security.KeyPair;
    import java.security.KeyPairGenerator;
    import java.security.interfaces.RSAPrivateKey;
    import java.security.interfaces.RSAPublicKey;
    import java.util.UUID;
    @Configuration(proxyBeanMethods = false)
    public class AuthorizationServerConfig {
        //授权端点过滤器链
        @Bean
        @Order(Ordered.HIGHEST_PRECEDENCE)
        public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity http) throws Exception {
            OAuth3AuthorizationServerConfigurer<HttpSecurity> authorizationServerConfigurer =
                    new OAuth3AuthorizationServerConfigurer<>();
            RequestMatcher endpointsMatcher = authorizationServerConfigurer
                    .getEndpointsMatcher();
            http
                    //没有认证会自动跳转到/login页面
                    .exceptionHandling((exceptions) -> exceptions
                            .authenticationEntryPoint(
                                    new LoginUrlAuthenticationEntryPoint("/login"))
                    )
                    .requestMatcher(endpointsMatcher)
                    .authorizeRequests(authorizeRequests ->
                            authorizeRequests.anyRequest().authenticated()
                    )
                    .csrf(csrf -> csrf.ignoringRequestMatchers(endpointsMatcher))
                    .apply(authorizationServerConfigurer);
            return http.build();
        }
        //用于身份验证的过滤器链
        @Bean
        @Order(2)
        public SecurityFilterChain defaultSecurityFilterChain(HttpSecurity http)
                throws Exception {
            http
                    .authorizeHttpRequests((authorize) -> authorize
                            .anyRequest().authenticated()
                    )
                    .formLogin(Customizer.withDefaults());
            return http.build();
        }
        //配置主体用户
        @Bean
        public UserDetailsService userDetailsService() {
            UserDetails userDetails = User.withDefaultPasswordEncoder()
                    .username("user")
                    .password("user")
                    .roles("USER")
                    .build();
            return new InMemoryUserDetailsManager(userDetails);
        }
        //注册客户端
        @Bean
        public RegisteredClientRepository registeredClientRepository() {
            RegisteredClient registeredClient = RegisteredClient.withId(UUID.randomUUID().toString())
                    //客户端id
                    .clientId("testClientId")
                    //客户端秘钥,授权服务器需要加密存储
                    .clientSecret(PasswordEncoderFactories.createDelegatingPasswordEncoder().encode("testClientSecret"))
                    //授权方法
                    .clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_BASIC)
                    //支持的授权类型
                    .authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
                    .authorizationGrantType(AuthorizationGrantType.REFRESH_TOKEN)
                    .authorizationGrantType(AuthorizationGrantType.CLIENT_CREDENTIALS)
                    //回调地址,支持多个,本地测试不能使用localhost
                    .redirectUri("http://127.0.0.1:8080/login/oauth3/code/customize")
                    .scope(OidcScopes.OPENID)
                    //授权scope
                    .scope("message.read")
                    .scope("userinfo")
                    .scope("message.write")
                    //是否需要授权页面,开启跳转到授权页面,需要手动确认
                    .clientSettings(ClientSettings.builder().requireAuthorizationConsent(true).build())
                    .build();
            return new InMemoryRegisteredClientRepository(registeredClient);
        }
        //token加密
        @Bean
        public JWKSource<SecurityContext> jwkSource() {
            KeyPair keyPair = generateRsaKey();
            RSAPublicKey publicKey = (RSAPublicKey) keyPair.getPublic();
            RSAPrivateKey privateKey = (RSAPrivateKey) keyPair.getPrivate();
            RSAKey rsaKey = new RSAKey.Builder(publicKey)
                    .privateKey(privateKey)
                    .keyID(UUID.randomUUID().toString())
                    .build();
            JWKSet jwkSet = new JWKSet(rsaKey);
            return new ImmutableJWKSet<>(jwkSet);
        }
        private static KeyPair generateRsaKey() {
            KeyPair keyPair;
            try {
                KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance("RSA");
                keyPairGenerator.initialize(2048);
                keyPair = keyPairGenerator.generateKeyPair();
            }
            catch (Exception ex) {
                throw new IllegalStateException(ex);
            }
            return keyPair;
        }
        //配置协议端点,比如/oauth3/authorize、/oauth3/token等
        @Bean
        public ProviderSettings providerSettings() {
            return ProviderSettings.builder().build();
        }
    }

    如上是最小化授权服务器的配置,这里我们将授权主体和客户端都存储在内存中,当然也可以持久化到数据库中,分别使用JdbcUserDetailsManagerJdbcRegisteredClientRepository
    ProviderSettings.builder().build()使用了默认的配置,这几个地址我们后面就会用到:

    public static Builder builder() {
        return new Builder()
                .authorizationEndpoint("/oauth3/authorize")
                .tokenEndpoint("/oauth3/token")
                .jwkSetEndpoint("/oauth3/jwks")
                .tokenRevocationEndpoint("/oauth3/revoke")
                .tokenIntrospectionEndpoint("/oauth3/introspect")
                .oidcClientRegistrationEndpoint("/connect/register")
                .oidcUserInfoEndpoint("/userinfo");
    }

    ❗ 官方指出@Import(OAuth3AuthorizationServerConfiguration.class)也可以用来最小化配置,但我亲测这种方式没多大用处,并且还有问题。

    配置客户端

    这里我们要使用自己的搭建授权服务器,需要自定义一个客户端,还是使用前面集成GitHub的示例,只要在配置文件中扩展就可以。
    完整配置如下:

    spring:
      security:
        oauth3:
          client:
            registration:
              gitee:
                client-id: gitee_clientId
                client-secret: gitee_secret
                authorization-grant-type: authorization_code
                redirect-uri: '{baseUrl}/login/oauth3/code/{registrationId}'
                client-name: Gitee
              github:
                client-id: github_clientId
                client-secret: github_secret
              # 自定义
              customize:
                client-id: testClientId
                client-secret: testClientSecret
                authorization-grant-type: authorization_code
                redirect-uri: '{baseUrl}/login/oauth3/code/{registrationId}'
                client-name: Customize
                scope:
                  - userinfo
            provider:
              gitee:
                authorization-uri: https://gitee.com/oauth/authorize
                token-uri: https://gitee.com/oauth/token
                user-info-uri: https://gitee.com/api/v5/user
                user-name-attribute: name
              # 自定义
              customize:
                authorization-uri: http://localhost:9000/oauth3/authorize
                token-uri: http://localhost:9000/oauth3/token
                user-info-uri: http://localhost:9000/userinfo
                user-name-attribute: username

    ❗ 在配置授权服务器uri的时候,请勿依旧使用127.0.0.1,由于是在本地测试,授权服务器的session和客户端的session会互相覆盖,导致莫名其妙的问题。
    请区分回调地址,和授权服务器端点uri的地址。

    Spring Security怎么自定义授权服务器

    客户端的session

    Spring Security怎么自定义授权服务器

    授权服务器的session

    体验

    另外为了能够更好的调式,可以在两个应用增加@EnableWebSecurity(debug = true)和 log日志,日志如下,打开TRACE级别日志:

    logging:
      level:
        root: INFO
        org.springframework.web: INFO
        org.springframework.security: TRACE
        org.springframework.security.oauth3: TRACE

    现在启动两个应用,访问http://127.0.0.1:8080/hello,自动跳转到登录页面。

    Spring Security怎么自定义授权服务器


    点击Customize,将跳转至授权服务器,注意看地址栏地址为localhost:9000/login,输入用户名/密码登录,user/user

    Spring Security怎么自定义授权服务器


    登录后,将跳转至授权页面,由于我们没有定制,使用的是默认页面,可以看到该页面的地址为
    http://localhost:9000/oauth3/authorize?response_type=code&client_id=testClientId&scope=userinfo&state=yV1ElAN2855yq3bY5kgj_rmilnCclyvZHkxVB7a1d84%3D&redirect_uri=http://127.0.0.1:8080/login/oauth3/code/customize

    Spring Security怎么自定义授权服务器


    我们勾选userinfo,提交后即跳转回客户端。
    我们看下客户收到的日志,授权服务器带着code回调了我们填写的回调地址。
    Request received for GET '/login/oauth3/code/customize?code=DPAlx5uyrUpfrZIlBKrpIy_mmcgiyC2qCxPFtUeLA0fBrZd238XM2vN8M1jv9XAgl0KA-D54P_KzVH7RbUw7ApBUc2pbnuSVRZUyHazozmNM4YgQ06CZryfr20qLRhW4&state=_Sgak7GLILLKbwr9JVuwA2xVp95CWPgUMByQcvePkgM%3D'

    ************************************************************
    Request received for GET '/login/oauth3/code/customize?code=DPAlx5uyrUpfrZIlBKrpIy_mmcgiyC2qCxPFtUeLA0fBrZd238XM2vN8M1jv9XAgl0KA-D54P_KzVH7RbUw7ApBUc2pbnuSVRZUyHazozmNM4YgQ06CZryfr20qLRhW4&state=_Sgak7GLILLKbwr9JVuwA2xVp95CWPgUMByQcvePkgM%3D':
    org.apache.catalina.connector.RequestFacade@1a8761d0
    servletPath:/login/oauth3/code/customize
    pathInfo:null
    headers: 
    host: 127.0.0.1:8080
    connection: keep-alive
    upgrade-insecure-requests: 1
    user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36
    accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9
    sec-fetch-site: cross-site
    sec-fetch-mode: navigate
    sec-fetch-user: ?1
    sec-fetch-dest: document
    sec-ch-ua: "Chromium";v="104", " Not A;Brand";v="99", "Google Chrome";v="104"
    sec-ch-ua-mobile: ?0
    sec-ch-ua-platform: "Windows"
    referer: http://127.0.0.1:8080/
    accept-encoding: gzip, deflate, br
    accept-language: zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7
    cookie: JSESSIONID=2527F412F53FA27A30BFBC39161ABB63
    Security filter chain: [
      DisableEncodeUrlFilter
      WebAsyncManagerIntegrationFilter
      SecurityContextPersistenceFilter
      HeaderWriterFilter
      CsrfFilter
      LogoutFilter
      OAuth3AuthorizationRequestRedirectFilter
      OAuth3AuthorizationRequestRedirectFilter
      OAuth3LoginAuthenticationFilter
      DefaultLoginPageGeneratingFilter
      DefaultLogoutPageGeneratingFilter
      RequestCacheAwareFilter
      SecurityContextHolderAwareRequestFilter
      AnonymousAuthenticationFilter
      OAuth3AuthorizationCodeGrantFilter
      SessionManagementFilter
      ExceptionTranslationFilter
      FilterSecurityInterceptor
    ]
    ************************************************************

    总结

    Spring Security 的最小化授权服务器的配置,到这里结束了,该demo虽然代码量非常少,但涉及的知识非常多,并且坑也多。

    Spring Security文档中的代码说明更新不及时,比如@Import(OAuth3AuthorizationServerConfiguration.class)文档中说明是最小化配置,但文档的快速开始又提供了另外一种的最小化配置方式。

    另外授权服务器如果发生异常,是不会打印堆栈的,而是把错误信息放入到response中,是打算要在页面上显示,然而demo的默认错误页并不会显示错误详情,只有错误编号400,如图。

    Spring Security怎么自定义授权服务器

    Spring Authorization Server 还需要多多完善,Spring Security也不例外,不久前我还提了一个PR,把一个持续数个版本的bug给修复了????(过了,只是文档中的错误罢了,被标记为文档中的bug????),看多了外国人的产品,其实也没有太比国内的开源项目好,坑也很多,而我们某些大厂的开源项目其实很好,却被网友门各种喷。

    Spring Security怎么自定义授权服务器

    “Spring Security怎么自定义授权服务器”的内容就介绍到这里了,感谢大家的阅读。如果想了解更多行业相关的知识可以关注亿速云网站,小编将为大家输出更多高质量的实用文章!

    向AI问一下细节

    免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

    AI