【OAuth2.0】Spring Security OAuth2.0篇之初識

• 不吐不快

　　

　　因為項目需求開始接觸OAuth2.0授權協議。斷斷續續接觸了有兩周左右的時間。不得不吐槽的，依然是自己的學習習慣問題，總是着急想了解一切，習慣性地鑽牛角尖去理解小的細節，而不是從宏觀上去掌握，或者說先用起來(少年，一輩子辣么長，你這么着急合適嗎？)。好在前人們已經做好了很好的demo，我自己照着抄一抄也就理解了大概如何用，依舊手殘黨，依舊敲不出好代碼。懺悔…

 

• WHAT？

　　

　　項目之中實際使用OAuth2.0實現是用的Spring Security OAuth2.0，一套基於Spring Security項目的實現，配合Spring Security配置使用。

　　總體來講，自己所理解的這套實現當中，是在Spring Security的基礎之上又增加了幾部分內容：

• authorization server

這部分配置算是OAuth2.0的核心配置部分。

該配置涉及:

　　client details service(第三方client端信息查詢配置)、

　　token service(token查詢操作相關)、

　　authorization code service(授權code獲取)、

　　user approval handler(用戶授權處理)、

　　client端的各種grant_type等等。

同時，這部分內容“內置”了兩個FrameworkEndpoint(和Controller意義相同)：AuthorizationEndpoint和TokenEndpoint，分別對應請求/oauth/authorize和/oauth/token。只要在spring配置文件中開啟MVC配置就能使用並攔截對應

該部分簡單配置：

<mvc:annotation-driven/>
<mvc:default-servlet-handler/>

<!-- 1. OAuth2 related config -->
<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="authorizationCodeServices" />
       <oauth2:implicit/>
       <oauth2:refresh-token/>
       <oauth2:client-credentials/>
       <oauth2:password/>
   </oauth2:authorization-server>
   
<!-- 1.1 client detail service -->
<beans:bean id="clientDetailsService" class="com.cyou.nad.bet.oauth.service.impl.CustomJdbcClientDetailsServiceImpl">
    <beans:constructor-arg index="0" ref="platform_dataSource"/>
</beans:bean>

<!-- 1.2 Config token services-->
<beans:bean id="tokenServices" class="org.springframework.security.oauth2.provider.token.DefaultTokenServices">
    <beans:property name="tokenStore" ref="tokenStore"/>
    <beans:property name="supportRefreshToken" value="true"/>
</beans:bean>
<beans:bean id="tokenStore" class="org.springframework.security.oauth2.provider.token.JdbcTokenStore">
    <beans:constructor-arg index="0" ref="platform_dataSource"/>
</beans:bean>

<!-- 1.3 oauthUserApprovalHandler -->
<beans:bean id="oauthUserApprovalHandler" class="com.cyou.nad.bet.oauth.approval.SimpleTokenServiceUserApprovalHandler">
    <beans:property name="tokenServices" ref="tokenServices"/>
    <beans:property name="oauthClientDetailsService" ref="oauthClientDetailsService"/><!-- FIXME 考慮直接使用clientDetailService -->
   </beans:bean>

<!-- 1.4 authorization code creator -->
<beans:bean id="authorizationCodeServices" class="org.springframework.security.oauth2.provider.code.JdbcAuthorizationCodeServices">
       <beans:constructor-arg index="0" ref="platform_dataSource"/>
</beans:bean>

 

• 第三方client配置

在spring的這套實現當中，在第三方client端也有自己單獨的id、secret和權限，所以從某種程度上來講，其實client端相當於是一種特殊的user了。

以前使用Spring Security配置user權限校驗的時候，會配置authentication-manager，使用DB的話，還需要提供userService用於查詢DB獲取用戶信息。

這里在配置OAuth的時候，client端也有類似配置，同樣需要配置authentication-manager並指定clientDetailService。

實際后續了解更多之后，發現實際校驗時，二者封裝成的都是類UserDetails的實例

 

用於client端校驗的AuthenticationManager配置：

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

 

• resource custom filter

在spring oauth2.0的配置當中，可以單獨配置resource-server，指定特定的resource-id。

這個resource-server的用處在於，之后會作為一個custom-filter加到Spring Security Filter Chain當中的。當第三方client嘗試訪問受限資源時，該filter會對client信息和其攜帶過來的access_token進行校驗，校驗通過之后才能拿到資源。

resource配置：

<oauth2:resource-server id="userResourceServerFilter" resource-id="user" token-services-ref="tokenServices"/>

　　　　后續作為custom-filter添加到http配置中：

<http pattern="/oauth/userInfo*" create-session="never" entry-point-ref="oauth2AuthenticationEntryPoint"
      access-decision-manager-ref="oauth2AccessDecisionManager">
    <anonymous enabled="false"/>
    <!-- 獲取用戶信息 -->
    <intercept-url pattern="/oauth/userInfo*" access="ROLE_UNITY,scope=READ"/>
    <custom-filter ref="userResourceServerFilter" before="PRE_AUTH_FILTER"/>
    <access-denied-handler ref="oauth2AccessDeniedHandler"/>
</http>

 

另外需要一提的就是，OAuth2.0當中還有一個SCOPE的概念，相當於用戶對client授權訪問自己擁有的某一資源時，可以指定其范圍，比如read(只讀), write(可寫)，或者get_user_info(獲取用戶信息), share(分享)等等。一開始沒有很好的理解，后來看到別的項目的配置，感覺可以這樣想：如果resource對應的是工程的Controller的話，那么scope可以理解為Controller當中的方法，類似於user.getUserInfo()或者user.addShare()等。配置參考：https://github.com/cloudfoundry/uaa/blob/master/samples/api/src/main/webapp/WEB-INF/spring-servlet.xml

添加scope之后，在<http>配置的AccessDecisionManager中就需要添加用於oauth2.0 scope校驗相關的voter了：

<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:property name="scopePrefix" value="scope="></beans:property>
            </beans:bean>
            <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>

　　

　　關於Spring這套實現的配置，前輩們分享的已經很多了，基本都是類似的配置。后續主要整理對於整體流程和諸如code或token的生成和存儲規則相關的東西，最最重要的，還是要把使用過程中遇到的各種問題記錄下來才是。