OAuth 2.0学习笔记（oauth2.0原理）

名词定义：

（1）Third-party application：第三方应用程序，本文中又称"客户端"（client），即上一节例子中的"云冲印"。

（2）HTTP service：HTTP服务提供商，本文中简称"服务提供商"，即上一节例子中的Google。

（3）Resource Owner：资源所有者，本文中又称"用户"（user）。

（4）User Agent：用户代理，本文中就是指浏览器。

（5）Authorization server：认证服务器，即服务提供商专门用来处理认证的服务器。

（6）Resource server：资源服务器，即服务提供商存放用户生成的资源的服务器。它与认证服务器，可以是同一台服务器，也可以是不同的服务器。

运行流程：

（1）用户打开客户端以后，客户端要求用户授权。

（2）用户同意给予客户端授权。

（3）客户端根据获得的授权，向认证服务器申请令牌。

（4）认证服务器对客户端进行认证，确认无误后发放令牌。

（5）客户端使用令牌，向资源服务器申请获取资源。

（6）资源服务器确认令牌无误后，向客户端开放资源。

客户端的授权模式：

授权码模式（authorization code）：功能最完整、流程最严密的授权模式。它的特点就是通过客户端的后台服务器，与"服务提供商"的认证服务器进行互动。

（1）用户访问客户端，客户端将用户导向认证服务器

客户端申请认证的URI包含以下参数：

response_type：表示授权类型，必选项，此处的值固定为"code"

client_id：表示客户端的ID，必选项

redirect_uri：表示重定向URI，可选项

scope：表示申请的权限范围，可选项

state：表示客户端的当前状态，可以指定任意值，认证服务器会原封不动地返回这个值。

例如：/authorize?response_type=code&client_id=s6BhdRkqt3&state=xyz&redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb

（2）用户选择是否给予客户端授权

（3）假设用户给予授权，认证服务器会将用户导向客户端原先指定的重定向URI，并加上一个授权码

服务器回应客户端的URI包含以下参数：

code：表示授权码，必选项。该码的有效期应该很短，通常设为10分钟，客户端只能使用该码一次，否则会被授权服务器拒绝。

该码与客户端ID和重定向URI，是一一对应关系。

state：如果客户端的请求中包含这个参数，认证服务器的回应也必须一模一样包含这个参数。

例如：https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz

（4）客户端接收到授权码和原先的重定向URI，向认证服务器申请令牌

客户端向认证服务器申请令牌的HTTP请求包含以下参数：

grant_type：表示使用的授权模式，必选项，此处的值固定为"authorization_code"。

code：表示上一步获得的授权码，必选项。

redirect_uri：表示重定向URI，必选项，且必须与A步骤中的该参数值保持一致。

client_id：表示客户端ID，必选项。

例如：grant_type=authorization_code&code=SplxlOBeZQQYbYS6WxSbIA&redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb

（5）认证服务器核对令牌和重定向URI，确认无误后向客户端发送访问令牌和更新令牌

认证服务器发送的HTTP回复，包含以下参数：

access_token：表示访问令牌，必选项。

token_type：表示令牌类型，该值大小写不敏感，必选项，可以是bearer类型或mac类型。

expires_in：表示过期时间，单位为秒。如果省略该参数，必须其他方式设置过期时间。

refresh_token：表示更新令牌，用来获取下一次的访问令牌，可选项。

scope：表示权限范围，如果与客户端申请的范围一致，此项可省略。

例如：

HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

Cache-Control: no-store

Pragma: no-cache

{

"access_token":"2YotnFZFEjr1zCsicMWpAA",

"token_type":"example",

"expires_in":3600,

"refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA",

"example_parameter":"example_value"

}

从上面回复代码可以看出，相关参数使用JSON格式发送（Content-Type: application/json）。此外，HTTP头信息中明确指定不得缓存。

简化模式（implicit grant type）：

spring security与OAuth2.0集成

1）修改web.xml文件：

<!-- filter代理，通过spring容器来管理filter的生命周期 -->

<filter>

<filter-name>springSecurityFilterChain</filter-name>

<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>

</filter>

<filter-mapping>

<filter-name>springSecurityFilterChain</filter-name>

<url-pattern>/*</url-pattern>

</filter-mapping>

2）配置applicationContext-security.xml：

<!-- 添加http拦截链 -->

<!-- /oauth/token是oauth2登陆验证请求的url，用于获取access_token，默认的生存时间是43200秒，即12小时 -->

<http pattern="/oauth/token" create-session="stateless"

authentication-manager-ref="oauth2AuthenticationManager"

entry-point-ref="oauth2AuthenticationEntryPoint">

<!-- 设置拦截地址和规则 -->

<intercept-url pattern="/oauth/token" access="isAuthenticated()" />

<csrf disabled="true"/>

<!-- 非匿名 -->

<anonymous enabled="false" />

<http-basic entry-point-ref="oauth2AuthenticationEntryPoint" />

<!-- 设置过滤链 -->

<custom-filter ref="clientCredentialsTokenEndpointFilter" before="BASIC_AUTH_FILTER" />

<!-- 拒绝访问处理 -->

<access-denied-handler ref="oauth2AccessDeniedHandler" />

</http>

<!-- token仓库：将token信息存放数据库，需要dataSource对象（也可以存储在内存中InMemoryTokenStore） -->

<beans:bean id="tokenStore"

class="org.springframework.security.oauth2.provider.token.store.JdbcTokenStore">

<beans:constructor-arg index="0" ref="dataSourceSys" />

</beans:bean>

<!-- 用于生成访问令牌token：如果允许刷新token,请将supportRefreshToken 的值设置为true, 默认为不允许-->

<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>

<!-- ClientDetailsService 配置, 使用JdbcClientDetailsService，oauth2客户端数据库操作类 -->

<beans:bean id="clientDetailsService"

class="org.springframework.security.oauth2.provider.client.JdbcClientDetailsService">

<beans:constructor-arg index="0" ref="dataSourceSys" />

</beans:bean>

<!-- ClientDetailsUserDetailsService配置：该类实现了Spring security中 UserDetailsService 接口 -->

<beans:bean id="oauth2ClientDetailsUserService"

class="org.springframework.security.oauth2.provider.client.ClientDetailsUserDetailsService">

<beans:constructor-arg ref="clientDetailsService" />

</beans:bean>

<!-- Oauth2 认证管理器：用来区分客户端用户-->

<authentication-manager id="oauth2AuthenticationManager">

<authentication-provider user-service-ref="oauth2ClientDetailsUserService" />

</authentication-manager>

<!-- 自定义oauth2认证错误信息处理类 -->

<beans:bean id="headerOnlyExceptionRender" class="com.spsoft.tms.security.oauth2.HeaderOnlyOAuth2ExceptionRenderer" />

<!-- Oauth2身份验证失败处理类（认证点） -->

<beans:bean id="oauth2AuthenticationEntryPoint"

class="org.springframework.security.oauth2.provider.error.OAuth2AuthenticationEntryPoint">

<beans:property name="exceptionRenderer" ref="headerOnlyExceptionRender" />

</beans:bean>

<!-- oauth2访问拒绝 -->

<beans:bean id="oauth2AccessDeniedHandler"

class="org.springframework.security.oauth2.provider.error.OAuth2AccessDeniedHandler">

<beans:property name="exceptionRenderer" ref="headerOnlyExceptionRender" />

</beans:bean>

<!-- oauth2访问成功，保存用户授权应用信息 -->

<beans:bean id="oauthUserApprovalHandler"

class="org.springframework.security.oauth2.provider.approval.ApprovalStoreUserApprovalHandler">

<beans:property name="approvalStore" ref="approvalStore" />

<beans:property name="requestFactory" ref="oauth2RequestFactory" />

</beans:bean>

<!-- 记录用户授权信息 -->

<beans:bean id="approvalStore"

class="org.springframework.security.oauth2.provider.approval.JdbcApprovalStore">

<beans:constructor-arg index="0" ref="dataSourceSys" />

</beans:bean>

<!-- oauth2请求工厂类，主要用于生成Oauth请求对象 -->

<beans:bean id="oauth2RequestFactory"

class="org.springframework.security.oauth2.provider.request.DefaultOAuth2RequestFactory">

<beans:constructor-arg index="0" ref="clientDetailsService" />

</beans:bean>

<!-- oauth2访问控制，AffirmativeBased：有一个同意就通过，ConsensusBased：票数多的通过，UnanimousBased：全部通过才能通过 -->

<beans:bean id="oauth2AccessDecisionManager"

class="org.springframework.security.access.vote.AffirmativeBased">

<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:property name="rolePrefix" value="" />

</beans:bean>

<beans:bean class="org.springframework.security.access.vote.AuthenticatedVoter" />

</beans:list>

</beans:constructor-arg>

</beans:bean>

<!-- oauth2 server授权模式：目前系统使用authorization-code授权码模式获取token -->

<oauth2:authorization-server

client-details-service-ref="clientDetailsService" token-services-ref="tokenServices"

user-approval-handler-ref="oauthUserApprovalHandler">

<oauth2:authorization-code authorization-code-services-ref="jdbcAuthorizationCodeServices" />

<oauth2:implicit />

<!-- 配置本服务器是否支持刷新token，默认支持刷新，不刷新就加上disabled="true" -->

<oauth2:refresh-token />

<oauth2:client-credentials />

<oauth2:password />

</oauth2:authorization-server>

<!-- 授权码即authorization-code数据库操作类 -->

<beans:bean id="jdbcAuthorizationCodeServices"

class="org.springframework.security.oauth2.provider.code.JdbcAuthorizationCodeServices">

<beans:constructor-arg index="0" ref="dataSourceSys" />

</beans:bean>

<!-- 用于把验证类型、用户名密码都作为表单参数提交的过滤器配置 -->

<beans:bean id="clientCredentialsTokenEndpointFilter"

class="org.springframework.security.oauth2.provider.client.ClientCredentialsTokenEndpointFilter">

<beans:property name="authenticationManager" ref="oauth2AuthenticationManager" />

</beans:bean>

<!-- 指定spring要保护的资源：如果没有这个，访问控制的时候会说没有Authentication object -->

<oauth2:resource-server id="restResourceServer"

resource-id="rest-resource" token-services-ref="tokenServices" />

<!-- 访问控制的配置：受保护的资源配置，以/rest/**打头的请求都会被Oauth2.0监听到请求 -->

<http pattern="/rest/**" create-session="never"

entry-point-ref="oauth2AuthenticationEntryPoint"

access-decision-manager-ref="oauth2AccessDecisionManager" use-expressions="false">

<!-- 不做角色限制，默认使用已登录即可访问接口 -->

<intercept-url pattern="/rest/**" access="IS_AUTHENTICATED_FULLY" />

<anonymous enabled="false" />

<custom-filter ref="restResourceServer" before="PRE_AUTH_FILTER" />

<access-denied-handler ref="oauth2AccessDeniedHandler" />

<csrf disabled="true"/>

</http>

<!-- Spring Security 验证配置，用于登录登出等操作 -->

<!-- IS_AUTHENTICATED_ANONYMOUSLY：允许匿名用户进入

IS_AUTHENTICATED_FULLY：允许登录用户进入

IS_AUTHENTICATED_REMEMBERED：允许登录用户和rememberMe用户进入

-->

<http disable-url-rewriting="false" use-expressions="true">

<intercept-url pattern="/index.jsp" access="permitAll"/>

<intercept-url pattern="/sso/**" access="permitAll"/>

<form-login authentication-success-handler-ref="authSuccess" username-parameter="tms_username" password-parameter="tms_password"

authentication-failure-url="/login.jsp?login_error=1"

default-target-url="/index.jsp" login-page="/login.jsp" login-processing-url="/tms_security_check"/>

<csrf disabled="true"/>

<logout logout-url="/logout" invalidate-session="true" success-handler-ref="logoutSuccess" />

<headers>

<frame-options policy="SAMEORIGIN"/>

</headers>

<session-management invalid-session-url="/login.jsp" />

</http>

<!-- 授权成功处理类 -->

<beans:bean id="authSuccess" class="com.spsoft.tms.security.security.AuthenticationSuccessHandlerImpl" />

<!-- 登出成功处理类 -->

<beans:bean id="logoutSuccess" class="com.spsoft.tms.security.security.CustomLogoutSuccessHandler" />