OAuth2客户端模式是OAuth2的一种授权模式,它适用于客户端与服务端之间的授权场景,例如第三方应用程序需要访问受保护的资源时。客户端模式不需要用户的参与,客户端通过自身的身份认证向授权服务器申请访问令牌,然后使用访问令牌来访问受保护的资源。
客户端模式的流程如下:
Spring Security OAuth2提供了完整的OAuth2实现,包括授权服务器和资源服务器等。以下是使用Spring Security OAuth2实现客户端模式的详细文档和示例:
在开始之前,我们需要添加Spring Security OAuth2和Spring Security Web的依赖。在Maven项目中,可以在pom.xml文件中添加以下依赖:
<dependency>
<groupId>org.springframework.security.oauth</groupId>
<artifactId>spring-security-oauth2</artifactId>
<version>2.5.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-web</artifactId>
<version>5.5.0</version>
</dependency>
我们需要配置授权服务器,以便客户端向授权服务器发送请求,并获取访问令牌。以下是授权服务器的配置:
@Configuration
@EnableAuthorizationServer
public class AuthorizationServerConfig extends AuthorizationServerConfigurerAdapter {
@Autowired
private AuthenticationManager authenticationManager;
@Autowired
private TokenStore tokenStore;
@Override
public void configure(ClientDetailsServiceConfigurer clients) throws Exception {
clients.inMemory()
.withClient("client")
.secret("{noop}secret")
.authorizedGrantTypes("client_credentials")
.scopes("read", "write")
.accessTokenValiditySeconds(3600);
}
@Override
public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
endpoints.authenticationManager(authenticationManager)
.tokenStore(tokenStore);
}
@Bean
public TokenStore tokenStore() {
return new InMemoryTokenStore();
}
}
在上面的代码中,我们配置了一个客户端,它的ID为"client",Secret为"secret",授权模式为客户端模式,授权范围为"read"和"write"。我们还配置了令牌的有效期为3600秒,并指定令牌存储方式为InMemoryTokenStore。
我们需要配置资源服务器,以便客户端使用访问令牌访问受保护的资源。以下是资源服务器的配置:
@Configuration
@EnableResourceServer
public class ResourceServerConfig extends ResourceServerConfigurerAdapter {
@Override
public void configure(HttpSecurity http) throws Exception {
http.authorizeRequests()
.antMatchers("/api/**").authenticated()
.anyRequest().permitAll();
}
}
在上面的代码中,我们配置了只有带有访问令牌的请求才能访问"/api"下的资源。
我们需要配置客户端,以便授权服务器能够对客户端进行身份认证,并发放访问令牌。在这个例子中,我们使用内存存储客户端信息。
@Configuration
public class ClientConfig {
@Bean
public ClientDetailsService clientDetailsService() {
InMemoryClientDetailsServiceBuilder builder = new InMemoryClientDetailsServiceBuilder();
builder.withClient("client")
.secret("{noop}secret")
.authorizedGrantTypes("client_credentials")
.scopes("read", "write")
.accessTokenValiditySeconds(3600);
return builder.build();
}
@Bean
public ClientCredentialsTokenEndpointFilter clientCredentialsTokenEndpointFilter() {
ClientCredentialsTokenEndpointFilter filter = new ClientCredentialsTokenEndpointFilter("/oauth/token");
filter.setAuthenticationManager(new AuthenticationManager() {
@Override
public Authentication authenticate(Authentication authentication) throws AuthenticationException {
String clientId = (String) authentication.getPrincipal();
String clientSecret = (String) authentication.getCredentials();
ClientDetails clientDetails = clientDetailsService().loadClientByClientId(clientId);
if (clientDetails == null) {
throw new ClientRegistrationException("Unknown client " + clientId);
}
if (!clientDetails.getClientSecret().equals(clientSecret)) {
throw new BadCredentialsException("Bad credentials for client " + clientId);
}
return new UsernamePasswordAuthenticationToken(clientId, clientSecret, clientDetails.getAuthorities());
}
});
return filter;
}
}
上面的代码中,我们定义了一个内存存储的客户端,它的ID是"client",Secret是"secret"。客户端可以使用"client_credentials"授权模式进行身份认证,并获得"read"和"write"权限。我们还定义了一个客户端凭证令牌端点过滤器,它使用客户端凭证对客户端进行身份认证,并将令牌发送给客户端。
客户端可以使用获得客户端可以使用获得的访问令牌访问资源服务器提供的受保护资源。在这个例子中,我们提供了一个简单的REST API,它需要认证才能访问。我们可以使用Spring MVC编写一个REST控制器来实现这个API。
@RestController
@RequestMapping("/api")
public class ApiController {
@GetMapping("/hello")
public String hello() {
return "Hello World!";
}
}
在这个例子中,我们定义了一个名为"hello"的REST端点,它返回"Hello World!"。这个端点需要认证才能访问。
为了测试我们的客户端,我们可以使用Postman发送一个HTTP GET请求,请求的URL为"http://localhost:8080/api/hello",并且我们需要在请求头中加上Authorization字段,值为"Bearer {access_token}",其中access_token是我们从授权服务器获取的访问令牌。如果一切正常,我们将在Postman中看到"Hello World!"的响应。