文档

OAuth常用的SDK示例

更新时间:

本文基于Spring Boot OAuth2和Pac4J,为您介绍OAuth常用的SDK示例的相关配置。

Spring Boot OAuth2示例

参考Spring Boot and OAuth2文档及示例,主要做以下两点修改:

  • 配置文件改为阿里云对应的配置。

    aliyun:
        client:
          clientId: 415195082384692****
          clientSecret: 6EwN4qutnZuchG6n677Ie33SsjAhwyTpcOMSoIo6v0gqJtw4QcHhERVXfqzc****
          accessTokenUri: https://oauth.aliyun.com/v1/token
          userAuthorizationUri: https://signin.aliyun.com/oauth2/v1/auth
          tokenName: access_token
          authenticationScheme: query
          clientAuthenticationScheme: form
        resource:
          userInfoUri: https://oauth.aliyun.com/v1/userinfo
  • 修改重定向URI。

    修改OAuth2ClientAuthenticationProcessingFilter中的回调地址,改成与应用中的配置相同。 例如:应用配置的是http://localhost:8080/login/aliyun,则把代码中的回调地址替换为/login/aliyun

    整体示例代码如下:

    public class WebApplication extends WebSecurityConfigurerAdapter {
    
      @Autowired
      OAuth2ClientContext oauth2ClientContext;
    
      @RequestMapping("/user")
      public Principal user(Principal principal) {
        return principal;
      }
    
      @Override
      protected void configure(HttpSecurity http) throws Exception {
        // @formatter:off
        http.antMatcher("/**").authorizeRequests().antMatchers("/", "/login**", "/webjars/**").permitAll().anyRequest()
            .authenticated().and().exceptionHandling()
            .authenticationEntryPoint(new LoginUrlAuthenticationEntryPoint("/")).and().logout()
            .logoutSuccessUrl("/").permitAll().and().csrf()
            .csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse()).and()
            .addFilterBefore(ssoFilter(), BasicAuthenticationFilter.class);
        // @formatter:on
      }
    
      public static void main(String[] args) {
        SpringApplication.run(WebApplication.class, args);
      }
    
      @Bean
      public FilterRegistrationBean oauth2ClientFilterRegistration(OAuth2ClientContextFilter filter) {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(filter);
        registration.setOrder(-100);
        return registration;
      }
    
      private Filter ssoFilter() {
        OAuth2ClientAuthenticationProcessingFilter aliyunFilter = new OAuth2ClientAuthenticationProcessingFilter(
            "/login/aliyun");
        OAuth2RestTemplate aliyunTemplate = new OAuth2RestTemplate(aliyun(), oauth2ClientContext);
        aliyunFilter.setRestTemplate(aliyunTemplate);
        UserInfoTokenServices tokenServices = new UserInfoTokenServices(aliyunResource().getUserInfoUri(),
            aliyun().getClientId());
        tokenServices.setRestTemplate(aliyunTemplate);
        aliyunFilter.setTokenServices(tokenServices);
        return aliyunFilter;
      }
    
      @Bean
      @ConfigurationProperties("aliyun.client")
      public AuthorizationCodeResourceDetails aliyun() {
        return new AuthorizationCodeResourceDetails();
      }
    
      @Bean
      @ConfigurationProperties("aliyun.resource")
      public ResourceServerProperties aliyunResource() {
        return new ResourceServerProperties();
      }
    
    }

Pac4J 示例

参考Pac4J的spring-webmvc-pac4j示例,进行以下操作:

  • 创建AliyunOidcClient

    public class AliyunOidcClient extends OidcClient<OidcProfile, OidcConfiguration> {
        public AliyunOidcClient() {
    
        }
    
        public AliyunOidcClient(OidcConfiguration configuration) {
            super(configuration);
        }
    
        @Override
        protected void clientInit() {
            CommonHelper.assertNotNull("configuration", this.getConfiguration());
            this.getConfiguration().defaultDiscoveryURI("https://oauth.aliyun.com/.well-known/openid-configuration");
            OidcProfileCreator<OidcProfile> profileCreator = new OidcProfileCreator(this.getConfiguration());
            profileCreator.setProfileDefinition(new OidcProfileDefinition((x) -> {
                return new OidcProfile();
            }));
            this.defaultProfileCreator(profileCreator);
            super.clientInit();
        }
    }
  • 添加oidcConfigbean

    <bean id="oidcConfiguration" class="org.pac4j.oidc.config.OidcConfiguration">
            <property name="clientId" value=your application id />
            <property name="secret" value=your application secret />
            <property name="useNonce" value="false" />
            <property name="scope" value="openid profile aliuid" />
            <property name="clientAuthenticationMethod" value="client_secret_post" />
    </bean>
  • 添加aliyunOidcClientbean

    <bean id="aliyunOidClient" class="org.pac4j.demo.spring.AliyunOidcClient">
            <constructor-arg name="configuration" ref="oidcConfiguration" />
            <property name="authorizationGenerator">
                <bean class="org.pac4j.demo.spring.RoleAdminAuthGenerator" />
            </property>
    </bean>
  • 配置bean clientscallbackUrl以及client属性。

    说明

    其中callbackUri需要配置在阿里云控制台中应用的回调地址里。

    <bean id="clients" class="org.pac4j.core.client.Clients">
            <constructor-arg name="callbackUrl" value="http://127.0.0.1:8080/callback" />
            <constructor-arg name="clients">
                <list>
                    <ref bean="aliyunOidClient" />
                </list>
            </constructor-arg>
    </bean>
  • 添加oidc拦截器。

    <mvc:interceptor>
                <mvc:mapping path="/oidc/*" />
                <bean class="org.pac4j.springframework.web.SecurityInterceptor">
                    <constructor-arg name="config" ref="config" />
                    <constructor-arg name="clients" value="AliyunOidcClient" />
                </bean>
    </mvc:interceptor>
  • 启动示例,访问http://localhost:8080/oidc/index.html

  • 本页导读 (1)
文档反馈