Spring Security和OAuth2实现RESTful服务安全认证
转自:http://blog.csdn.net/l241002209/article/details/37518869这篇教程是展示如何设置一个OAuth2服务来保护REST资源. 源代码下载github. (https://github.com/iainporter/oauth2-provider)你能下载这个源码就开始编写一个被OAuth方法保护的服务。该源码包含功能:
* 用户注册和登录
* Email验证
* Password 丢失
采取的技术有以下:
* OAuth2 Protocol
* spring Security
* Spring Integration
* Spring Data
* Jersey/JAX-RS
* Gradle / Groovy
* MongoDB
通过以下方式构建项目:
> Git clone git@github.com:iainporter/oauth2-provider.git
> cd oauth2-provider
> ./gradlew clean build integrationTest
运行Web项目:
这个应用是基于mongodb作为持久层,在运行应用之前确认mongod是运行在端口27017.
运行命令:
> ./gradlew tomcatRun
在浏览器打开http://localhost:8080/oauth2-provider/index.html
1. 创建一个用户:
curl -v -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Basic MzUzYjMwMmM0NDU3NGY1NjUwNDU2ODdlNTM0ZTdkNmE6Mjg2OTI0Njk3ZTYxNWE2NzJhNjQ2YTQ5MzU0NTY0NmM=" \
-d '{"user":{"emailAddress":"user@example.com"}, "password":"password"}' \
'http://localhost:8080/oauth2-provider/v1.0/users'
结果应该是:
{"apiUser":
{"emailAddress":"user@example.com",
"firstName":null,
"lastName":null,
"age":null,
"id":"8a34d009-3558-4c8c-a8da-1ad2b2a393c7",
"name":"user@example.com"},
"oauth2AccessToken":
{"access_token":"7e0e4708-7837-4a7e-9f87-81c6429b02ac",
"token_type":"bearer",
"refresh_token":"d0f248ab-e30f-4a85-860c-bd1e388a39b5",
"expires_in":5183999,
"scope":"read write"
}
}
2. 请求一个access token:
curl -v -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Basic MzUzYjMwMmM0NDU3NGY1NjUwNDU2ODdlNTM0ZTdkNmE6Mjg2OTI0Njk3ZTYxNWE2NzJhNjQ2YTQ5MzU0NTY0NmM=" \
'http://localhost:8080/oauth2-provider/oauth/token?grant_type=password&username=user@example.com&password=password'
结果应该是:
{
"access_token":"a838780e-35ef-4bd5-92c0-07a45aa74948",
"token_type":"bearer",
"refresh_token":"ab06022f-247c-450a-a11e-2ffab116e3dc",
"expires_in":5183999
}
3. 刷新一个token:
curl -v -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Basic MzUzYjMwMmM0NDU3NGY1NjUwNDU2ODdlNTM0ZTdkNmE6Mjg2OTI0Njk3ZTYxNWE2NzJhNjQ2YTQ5MzU0NTY0NmM=" \
'http://localhost:8080/oauth2-provider/oauth/token?grant_type=refresh_token&refresh_token=ab06022f-247c-450a-a11e-2ffab116e3dc'
结果应该是:
{
"access_token":"4835cd11-8bb7-4b76-b857-55c6e7f36fc4",
"token_type":"bearer",
"refresh_token":"ab06022f-247c-450a-a11e-2ffab116e3dc",
"expires_in":5183999
}
Web Context
一个Jersey 处理所有资源调用:
- <servlet-mapping>
- <servlet-name>jersey-servlet</servlet-name>
- <url-pattern>/*</url-pattern>
- </servlet-mapping>
Spring servlet处理所有oauth 调用:
- <servlet-mapping>
- <servlet-name>spring</servlet-name>
- <url-pattern>/oauth/*</url-pattern>
- </servlet-mapping>
spring security配合定义一个过滤器:
- <filter>
- <filter-name>springSecurityFilterChain</filter-name>
- <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
- <init-param>
- <param-name>contextAttribute</param-name>
- <param-value>org.springframework.web.servlet.FrameworkServlet.CONTEXT.spring</param-value>
- </init-param>
- </filter>
对根目录下所有url进行 过滤:
- <filter-mapping>
- <filter-name>springSecurityFilterChain</filter-name>
- <url-pattern>/*</url-pattern>
- </filter-mapping>
配置OAuth 流程
- <oauth:authorization-server client-details-service-ref="client-details-service" token-services-ref="tokenServices">
- <oauth:refresh-token/>
- <oauth:password/>
- </oauth:authorization-server>
缺省的token端点是/oauth/token ,只有 password flow 和刷新 token 支持。
保护token端点
使用Spring security 保护token端点:
- <http pattern="/oauth/token" create-session="stateless" authentication-manager-ref="clientAuthenticationManager"
- xmlns="http://www.springframework.org/schema/security">
- <anonymous enabled="false"/>
- <http-basic entry-point-ref="clientAuthenticationEntryPoint"/>
- <access-denied-handler ref="oauthAccessDeniedHandler"/>
- </http>
下面配置授权authentication 管理器和客户端服务:
- <bean id="clientCredentialsTokenEndpointFilter"
- class="org.springframework.security.oauth2.provider.client.ClientCredentialsTokenEndpointFilter">
- <property name="authenticationManager" ref="clientAuthenticationManager"/>
- </bean>
- <authentication-manager id="clientAuthenticationManager" xmlns="http://www.springframework.org/schema/security">
- <authentication-provider user-service-ref="client-details-user-service"/>
- </authentication-manager>
- <bean id="client-details-user-service" class="org.springframework.security.oauth2.provider.client.ClientDetailsUserDetailsService">
- <constructor-arg ref="client-details-service" />
- </bean>
配置用户授权服务
Resource Owner Password flow 需要管理用户的授权管理器
- <bean id="passwordEncoder" class="org.springframework.security.crypto.password.StandardPasswordEncoder"/>
- <sec:authentication-manager alias="userAuthenticationManager">
- <sec:authentication-provider user-service-ref="userService">
- <sec:password-encoder ref="passwordEncoder"/>
- </sec:authentication-provider>
- </sec:authentication-manager>
密码 password encoder是用于加密密码。用户服务必须实现一个UserDetailsService ,能根据用户名返回用户。
- @Override
- public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
- notNull(username, "Mandatory argument 'username' missing.");
- User user = userRepository.findByEmailAddress(username.toLowerCase());
- if (user == null) {
- throw new AuthenticationException();
- }
- return user;
- }
配置Token 服务
- <bean id="tokenServices" class="org.springframework.security.oauth2.provider.token.DefaultTokenServices">
- <property name="tokenStore" ref="tokenStore"/>
- <property name="supportRefreshToken" value="true"/>
- <property name="clientDetailsService" ref="client-details-service"/>
- </bean>
保护资源访问
- <oauth:resource-server id="resourceServerFilter" token-services-ref="tokenServices"/>
核心服务
这个服务提供基于访问token获得用户的信息。URL格式:
/v1.0/users/{id}/someresource
- @Path("/v1.0/me")
- @Component
- @Produces({MediaType.APPLICATION_JSON})
- @Consumes({MediaType.APPLICATION_JSON})
- public class MeResource extends BaseResource {
- @RolesAllowed({"ROLE_USER"})
- @GET
- public ApiUser getUser(final @Context SecurityContext securityContext) {
- User requestingUser = loadUserFromSecurityContext(securityContext);
- if(requestingUser == null) {
- throw new UserNotFoundException();
- }
- return new ApiUser(requestingUser);
- }
- protected User loadUserFromSecurityContext(SecurityContext securityContext) {
- OAuth2Authentication requestingUser = (OAuth2Authentication) securityContext.getUserPrincipal();
- Object principal = requestingUser.getUserAuthentication().getPrincipal();
- User user = null;
- if(principal instanceof User) {
- user = (User)principal;
- } else {
- user = userRepository.findByEmailAddress((String)principal);
- }
- return user;
- }
- }
测试这个应用,启动:
> ./gradlew tomcatRun
测试:
curl -v -X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer [your token here]" \
'http://localhost:8080/oauth2-provider/v1.0/me'