教程由来:项目需要为第三方客户端提供授权和资源访问,无疑OAuth2现在是最好的方式,如果OAuth2相关知识大家还不够了解,请移步到阮一峰的理解OAuth2.0,本文实战为主,理论方面请自行查阅相关资料。
1. OAuth2的四种模式
- 授权码模式(authorization code)(最正统的方式,也是目前绝大多数系统所采用的)(支持refresh token) (用在服务端应用之间)
- 密码模式(resource owner password credentials)(为遗留系统设计) (支持refresh token)
- 简化模式(implicit)(为web浏览器应用设计)(不支持refresh token) (用在移动app或者web app,这些app是在用户的设备上的,如在手机上调起微信来进行认证授权)
- 客户端模式(client credentials)(为后台api服务消费者设计) (不支持refresh token) (为后台api服务消费者设计)
本文采用数据库的方式对上述四种模式进行配置,网上绝大多数都是配置在内存中的demo,学习尚可,真实的开发环境却是还远远不够。
废话也就不多说了,咱进入正题吧。
2. 所需依赖
//Springboot版本为2.0.2.RELEASE<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- spring-security--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-security</artifactId></dependency><!-- OAuth2--><dependency><groupId>org.springframework.security.oauth</groupId><artifactId>spring-security-oauth2</artifactId><version>2.3.0.RELEASE</version></dependency>
3. 授权服务器
授权服务器是OAuth2的两大核心之一,它将根据不同的授权类型为客户端提供不同的获取令牌的方式。
@Configuration@EnableAuthorizationServer // 授权服务器核心注解protected static class AuthorizationServerConfiguration extends AuthorizationServerConfigurerAdapter {
@AutowiredAuthenticationManager authenticationManager; // 注入manager@Autowiredprivate DataSource dataSource; // 注入数据源@AutowiredSecurityUserService userDetailsService; //@AutowiredClientDetailsService clientDetailsService; @Autowiredprivate AuthorizationCodeServices authorizationCodeServices;// redis 的相关配置已注释,若需启用,在tokenStore中注入即可。// @Autowired// private RedisConnectionFactory redisConnectionFactory;// @Bean// public TokenStore redisTokenStore() {
// return new RedisTokenStore(redisConnectionFactory);// }/*** 密码加密*/@Beanpublic PasswordEncoder passwordEncoder() {
return new BCryptPasswordEncoder();}/*** ClientDetails实现* @return*/@Beanpublic ClientDetailsService clientDetails() {
return new JdbcClientDetailsService(dataSource);}@Beanpublic TokenStore tokenStore() {
return new JdbcTokenStore(dataSource);}/*** 加入对授权码模式的支持* @param dataSource* @return*/@Beanpublic AuthorizationCodeServices authorizationCodeServices(DataSource dataSource) {
return new JdbcAuthorizationCodeServices(dataSource);}@Overridepublic void configure(ClientDetailsServiceConfigurer clients) throws Exception {
// 1. 数据库的方式clients.withClientDetails(clientDetails());// 2. 在内存中配置,这种方式不够灵活,学习倒是没有问题// //配置两个客户端,一个用于password认证一个用于client认证// clients.inMemory().withClient("client_1")// .resourceIds(DEMO_RESOURCE_ID)// .authorizedGrantTypes("client_credentials", "refresh_token")// .scopes("select")// .authorities("client")// .secret("123456")// .and().withClient("client_2")// .resourceIds(DEMO_RESOURCE_ID)// .authorizedGrantTypes("password", "refresh_token")// .scopes("select")// .authorities("client")// .secret("123456");}/*** 声明授权和token的端点以及token的服务的一些配置信息,* 比如采用什么存储方式、token的有效期等* @param endpoints*/@Overridepublic void configure(AuthorizationServerEndpointsConfigurer endpoints) {
endpoints// 使用redis的配置// .tokenStore(new RedisTokenStore(redisConnectionFactory)).tokenStore(tokenStore()).authenticationManager(authenticationManager).userDetailsService(userDetailsService).authorizationCodeServices(authorizationCodeServices).setClientDetailsService(clientDetailsService);}/*** 声明安全约束,哪些允许访问,哪些不允许访问* @param oauthServer*/@Overridepublic void configure(AuthorizationServerSecurityConfigurer oauthServer) {
// 允许表单认证oauthServer.allowFormAuthenticationForClients();// 配置BCrypt加密oauthServer.passwordEncoder(passwordEncoder());// 对于CheckEndpoint控制器[框架自带的校验]的/oauth/check端点允许所有客户端发送器请求而不会被Spring-security拦截oauthServer.tokenKeyAccess("permitAll()").checkTokenAccess("isAuthenticated()");// 此处可添加自定义过滤器,对oauth相关的请求做进一步处理// oauthServer.addTokenEndpointAuthenticationFilter(new Oauth2Filter());}}
4. 资源服务器
1. 资源服务器主要配置拦截的路径,以及访问拦截的URL所需要的权限。
2. 本文,主系统、资源服务器和授权服务器放在一起的,很多人说这样配置security的主过滤器和资源服务器的过滤器会冲突,其实是不会的,资源服务器会优先于security主过滤器拦截你访问的URL,当然你也没必要在类上配置Order去改变他们的优先级,你只需要注意不要让你的资源服务器把security主过滤器放行的资源给拦截了就行。
下面直接上代码
@Configuration@EnableResourceServerprotected static class ResourceServerConfiguration extends ResourceServerConfigurerAdapter {
private static final String RESOURCE_ID = "oauth2";@Overridepublic void configure(ResourceServerSecurityConfigurer resources) {
// 如果关闭 stateless,则 accessToken 使用时的 session id 会被记录,后续请求不携带 accessToken 也可以正常响应// 如果 stateless 为 true 打开状态,则 每次请求都必须携带 accessToken 请求才行,否则将无法访问resources.resourceId(RESOURCE_ID).stateless(true);}/*** 为oauth2单独创建角色,这些角色只具有访问受限资源的权限,可解决token失效的问题* @param http* @throws Exception*/@Overridepublic void configure(HttpSecurity http) throws Exception {
http// 获取登录用户的 session.sessionManagement().sessionCreationPolicy(SessionCreationPolicy.IF_REQUIRED).and()// 资源服务器拦截的路径 注意此路径不要拦截主过滤器放行的URL.requestMatchers().antMatchers("/authmenu/**");http.authorizeRequests()// 配置资源服务器已拦截的路径才有效.antMatchers("/authmenu/**").authenticated();// .access(" #oauth2.hasScope('select') or hasAnyRole('ROLE_超级管理员', 'ROLE_设备管理员')");http.exceptionHandling().accessDeniedHandler(new OAuth2AccessDeniedHandler()).and().authorizeRequests().anyRequest().authenticated();}}
5. 主过滤器的配置
关于主过滤器,每个人的配置可能不太一样,都是有一点是必须的,就是必须把authenticationManagerBean方法注册为bean,本文是基于前后端分离而开发,下文只出示了与OAuth2相关的配置,详细信息请参考文末的GitHub地址。
@Override@Beanpublic AuthenticationManager authenticationManagerBean() throws Exception {
return super.authenticationManagerBean();}@Overrideprotected void configure(HttpSecurity http) throws Exception {
http.authorizeRequests().anyRequest().authenticated().withObjectPostProcessor(urlObjectPostProcessor()).and().formLogin().loginPage("/login").loginProcessingUrl("/login").usernameParameter("username").passwordParameter("password").permitAll().failureHandler(securityAuthenticationFailureHandler).successHandler(userLoginSuccessHandler).and().exceptionHandling().authenticationEntryPoint(securityAuthenticationEntryPoint).and().logout().deleteCookies("remove").invalidateHttpSession(false).logoutUrl("/logout").logoutSuccessHandler(securityLogoutSuccessHandler).permitAll().and().csrf().requireCsrfProtectionMatcher(new AntPathRequestMatcher("/oauth/authorize")).disable();http.sessionManagement()// 无效session跳转.invalidSessionUrl("/login").maximumSessions(1)// session过期跳转.expiredUrl("/login").sessionRegistry(sessionRegistry());}
6. OAuth2所需数据表
--
-- Oauth2 sql -- MYSQL
--Drop table if exists oauth_client_details;
create table oauth_client_details (client_id VARCHAR(255) PRIMARY KEY,resource_ids VARCHAR(255),client_secret VARCHAR(255),scope VARCHAR(255),authorized_grant_types VARCHAR(255),web_server_redirect_uri VARCHAR(255),authorities VARCHAR(255),access_token_validity INTEGER,refresh_token_validity INTEGER,additional_information TEXT,create_time timestamp default now(),archived tinyint(1) default '0',trusted tinyint(1) default '0',autoapprove VARCHAR (255) default 'false'
) ENGINE=InnoDB DEFAULT CHARSET=utf8;Drop table if exists oauth_access_token;
create table oauth_access_token (create_time timestamp default now(),token_id VARCHAR(255),token BLOB,authentication_id VARCHAR(255),user_name VARCHAR(255),client_id VARCHAR(255),authentication BLOB,refresh_token VARCHAR(255)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;Drop table if exists oauth_refresh_token;
create table oauth_refresh_token (create_time timestamp default now(),token_id VARCHAR(255),token BLOB,authentication BLOB
) ENGINE=InnoDB DEFAULT CHARSET=utf8;Drop table if exists oauth_code;
create table oauth_code (create_time timestamp default now(),code VARCHAR(255),authentication BLOB
) ENGINE=InnoDB DEFAULT CHARSET=utf8;-- Add indexes
create index token_id_index on oauth_access_token (token_id);
create index authentication_id_index on oauth_access_token (authentication_id);
create index user_name_index on oauth_access_token (user_name);
create index client_id_index on oauth_access_token (client_id);
create index refresh_token_index on oauth_access_token (refresh_token);create index token_id_index on oauth_refresh_token (token_id);create index code_index on oauth_code (code);
点击此处,获取OAuth2表中所涉及字段的详细说明 看起来不方便的话,可以直接到源码中通过HTML的方式查看。
最后附上我数据库的配置截图,嗯,差不多了。
截图:
7. 测试
7.1 授权码模式测试
1. 直接请求获取授权码:http://localhost:9999/oauth/authorize?client_id=sheep1&redirect_uri=http://localhost:8086/login&response_type=code&scope=all
2. 访问登录页面:http://localhost:9999/static/login.html
为什么不直接使用postman测试,而要准备一个登录页面?
1. 首先获取授权码,要求用户是已经登录的状态,就是未登录的用户是不能请求到授权码的
2. 请求授权码的时候,服务器收到请求,验证参数无误之后,会自动响应到 请求授权码的重定向地址,并在重定向地址后面附加 我们需要的授权码。
3. 登录成功后,再次请求授权码:http://localhost:9999/oauth/authorize?client_id=sheep1&redirect_uri=http://localhost:8086/login&response_type=code&scope=all
4. 拿到授权码再去获取需要的token,注意此处是post请求,所以需要你在postman上测试:http://localhost:9999/oauth/token?client_id=sheep1&client_secret=123456&grant_type=authorization_code&code=Y1e37c&redirect_uri=http://localhost:8086/login
5. 使用获取到的token获取服务器的资源:http://localhost:9999/user/oauth/all?access_token=1542569a-ca94-4015-90ee-402158be4f78
授权码和password模式测试如下:
项目Github地址:https://github.com/Janche/springboot-security-project.git (你的star是对我最大的支持,测试OAuth2时,可以切换到 oauth2分支,oauth2分支的客户端数据用的client_id: janche, redirect_uri: https://janche.github.io,想要和文中的保持一致,替换一下表oauth_client_details的数据就可以了)
oauth2相关资料参考
- 程序猿DD-从零开始的Spring Security Oauth2(一)\
- Spring Security & OAuth2