TOC

Reddit OAuth2とSpring Securityによる認証

Reddit OAuth2とSpring Securityによる認証

1. 概要

このチュートリアルでは、Spring SecurityOAuthを使用してRedditAPIで認証します。

2. Mavenの構成

まず、Spring Security OAuthを使用するには、次の依存関係をpom.xmlに追加する必要があります（もちろん、使用する可能性のある他のSpring依存関係に沿って）。 


    org.springframework.security.oauth
    spring-security-oauth2
    2.0.6.RELEASE

3. OAuth2クライアントを構成する

次に、OAuth2クライアント（OAuth2RestTemplate）とreddit.propertiesファイルをすべての認証関連プロパティ用に構成しましょう。 

@Configuration
@EnableOAuth2Client
@PropertySource("classpath:reddit.properties")
protected static class ResourceConfiguration {

    @Value("${accessTokenUri}")
    private String accessTokenUri;

    @Value("${userAuthorizationUri}")
    private String userAuthorizationUri;

    @Value("${clientID}")
    private String clientID;

    @Value("${clientSecret}")
    private String clientSecret;

    @Bean
    public OAuth2ProtectedResourceDetails reddit() {
        AuthorizationCodeResourceDetails details = new AuthorizationCodeResourceDetails();
        details.setId("reddit");
        details.setClientId(clientID);
        details.setClientSecret(clientSecret);
        details.setAccessTokenUri(accessTokenUri);
        details.setUserAuthorizationUri(userAuthorizationUri);
        details.setTokenName("oauth_token");
        details.setScope(Arrays.asList("identity"));
        details.setPreEstablishedRedirectUri("http://localhost/login");
        details.setUseCurrentUri(false);
        return details;
    }

    @Bean
    public OAuth2RestTemplate redditRestTemplate(OAuth2ClientContext clientContext) {
        OAuth2RestTemplate template = new OAuth2RestTemplate(reddit(), clientContext);
        AccessTokenProvider accessTokenProvider = new AccessTokenProviderChain(
          Arrays. asList(
            new MyAuthorizationCodeAccessTokenProvider(),
            new ImplicitAccessTokenProvider(),
            new ResourceOwnerPasswordAccessTokenProvider(),
            new ClientCredentialsAccessTokenProvider())
        );
        template.setAccessTokenProvider(accessTokenProvider);
        return template;
    }

}

そして「reddit.properties」： 

clientID=xxxxxxxx
clientSecret=xxxxxxxx
accessTokenUri=https://www.reddit.com/api/v1/access_token
userAuthorizationUri=https://www.reddit.com/api/v1/authorize

https://www.reddit.com/prefs/apps/からRedditアプリを作成することで、独自のシークレットコードを取得できます

OAuth2RestTemplateを使用して次のことを行います。

  1. リモートリソースへのアクセスに必要なアクセストークンを取得します。

  2. アクセストークンを取得した後、リモートリソースにアクセスします。

また、後でユーザーアカウント情報を取得できるように、スコープ「identity」をRedditOAuth2ProtectedResourceDetailsに追加した方法にも注意してください。

4. カスタムAuthorizationCodeAccessTokenProvider

Reddit OAuth2の実装は、標準とは少し異なります。 したがって、AuthorizationCodeAccessTokenProviderをエレガントに拡張する代わりに、実際にその一部をオーバーライドする必要があります。

これを必要としない改善を追跡するgithubの問題がありますが、これらの問題はまだ完了していません。

Redditが行う非標準的なことの1つは、ユーザーをリダイレクトし、Redditで認証するように促すときに、リダイレクトURLにいくつかのカスタムパラメーターが必要なことです。 具体的には、Redditから永続的なアクセストークンを要求する場合は、パラメータ「duration」に値「permanent」を追加する必要があります。

したがって、AuthorizationCodeAccessTokenProviderを拡張した後、このパラメーターをgetRedirectForAuthorization()メソッドに追加しました。 

    requestParameters.put("duration", "permanent");

hereから完全なソースコードを確認できます。

5. ServerInitializer

次へ–カスタムServerInitializerを作成しましょう。

IDoauth2ClientContextFilterのフィルターBeanを追加して、現在のコンテキストを格納するために使用できるようにする必要があります。 

public class ServletInitializer extends AbstractDispatcherServletInitializer {

    @Override
    protected WebApplicationContext createServletApplicationContext() {
        AnnotationConfigWebApplicationContext context =
          new AnnotationConfigWebApplicationContext();
        context.register(WebConfig.class, SecurityConfig.class);
        return context;
    }

    @Override
    protected String[] getServletMappings() {
        return new String[] { "/" };
    }

    @Override
    protected WebApplicationContext createRootApplicationContext() {
        return null;
    }

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        super.onStartup(servletContext);
        registerProxyFilter(servletContext, "oauth2ClientContextFilter");
        registerProxyFilter(servletContext, "springSecurityFilterChain");
    }

    private void registerProxyFilter(ServletContext servletContext, String name) {
        DelegatingFilterProxy filter = new DelegatingFilterProxy(name);
        filter.setContextAttribute(
          "org.springframework.web.servlet.FrameworkServlet.CONTEXT.dispatcher");
        servletContext.addFilter(name, filter).addMappingForUrlPatterns(null, false, "/*");
    }
}

6. MVC構成

それでは、単純なWebアプリのMVC構成を見てみましょう。 

@Configuration
@EnableWebMvc
@ComponentScan(basePackages = { "org.example.web" })
public class WebConfig implements WebMvcConfigurer {

    @Bean
    public static PropertySourcesPlaceholderConfigurer
      propertySourcesPlaceholderConfigurer() {
        return new PropertySourcesPlaceholderConfigurer();
    }

    @Bean
    public ViewResolver viewResolver() {
        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
        viewResolver.setPrefix("/WEB-INF/jsp/");
        viewResolver.setSuffix(".jsp");
        return viewResolver;
    }

    @Override
    public void configureDefaultServletHandling(
      DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/resources/**").addResourceLocations("/resources/");
    }

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/home.html");
    }
}

7. セキュリティ構成

次へ–the main Spring Security configurationを見てみましょう： 

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(AuthenticationManagerBuilder auth)
      throws Exception {
        auth.inMemoryAuthentication();
    }

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .anonymous().disable()
            .csrf().disable()
            .authorizeRequests()
            .antMatchers("/home.html").hasRole("USER")
            .and()
            .httpBasic()
            .authenticationEntryPoint(oauth2AuthenticationEntryPoint());
    }

    private LoginUrlAuthenticationEntryPoint oauth2AuthenticationEntryPoint() {
        return new LoginUrlAuthenticationEntryPoint("/login");
    }
}

注：次のセクションで説明するように、ユーザー情報を取得してそこから認証をロードする「/login」にリダイレクトする単純なセキュリティ構成を追加しました。

8. RedditController

では、コントローラーのRedditControllerを見てみましょう。

次の例のように、メソッドredditLogin()を使用してRedditアカウントからユーザー情報を取得し、そこから認証をロードします。 

@Controller
public class RedditController {

    @Autowired
    private OAuth2RestTemplate redditRestTemplate;

    @RequestMapping("/login")
    public String redditLogin() {
        JsonNode node = redditRestTemplate.getForObject(
          "https://oauth.reddit.com/api/v1/me", JsonNode.class);
        UsernamePasswordAuthenticationToken auth =
          new UsernamePasswordAuthenticationToken(node.get("name").asText(),
          redditRestTemplate.getAccessToken().getValue(),
          Arrays.asList(new SimpleGrantedAuthority("ROLE_USER")));

        SecurityContextHolder.getContext().setAuthentication(auth);
        return "redirect:home.html";
    }

}

この一見単純な方法の興味深い詳細 - redditテンプレートchecks if the access token is available before executing any request;トークンが利用できない場合は、トークンを取得します。

次に、非常に単純化されたフロントエンドに情報を提示します。

9. home.jsp

最後に、home.jspを見て、ユーザーのRedditアカウントから取得した情報を表示します。 

<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
<%@ taglib prefix="sec" uri="http://www.springframework.org/security/tags"%>


    
Welcome,

10. 結論

この紹介記事では、authenticating with the Reddit OAuth2 APIを調べ、いくつかの非常に基本的な情報を単純なフロントエンドに表示しました。

認証されたので、この新しいシリーズの次の記事で、RedditAPIを使用してさらに興味深いことを行う方法を検討します。

このチュートリアルのfull implementationは、the github projectにあります。これはEclipseベースのプロジェクトであるため、そのままインポートして実行するのは簡単です。

Related