42 API Key Authentication
A library to easily configure API Key authentication in (parts of) your Spring Boot Application.
Features
- Easily configure API Key authentication for (a portion) of endpoints in your app
- Support for specifying multiple keys from multiple sources
- Configurable header name
- Configurable filter placement in the FilterChain
Setting up API Key authentication
-
You must have the following components in your application:
- A list of authorized API keys (these can come from your
application.yml, for example) - One or more endpoints to protect
- A list of authorized API keys (these can come from your
-
The maven dependencies you need:
<dependencies>
<dependency>
<groupId>nl.42</groupId>
<artifactId>api-key-authentication</artifactId>
<version>1.0.0</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>`
</dependencies>
- Create a class annotated by
@Configurationand extendingWebSecurityConfigurerAdapterand add it to your app:
@Configuration
@EnableWebSecurity
public class ApiKeyConfig extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity http) throws Exception {
// You can easily configure this library using the Builder...
// ... or you can create your very own implementation of ApiKeyAuthenticationConfiguration
ApiKeyAuthenticationConfiguration config = ApiKeyAuthenticationConfigurationBuilder.builder()
.authorizedApiKeys(Set.of(ALLOWED_KEY_1, ALLOWED_KEY_2)) // The API Keys that will be granted access to the endpoints
.antPattern("/public-api/**") // The endpoints you want to protect by API Key (basic pattern). Defaults to 'all endpoints'.
.requestMatcher(new OrRequestMatcher(new AntPathRequestMatcher("/public-api/v1/hello"), new AntPathRequestMatcher("/public-api/v1/goodbye"))) // The endpoints you want to protect by API Key (advanced matching)
.addFilterBeforeClass(BasicAuthenticationFilter.class) // Customize where the API Key check will be inserted (defaults to before BasicAuthenticationFilter)
.addFilterAfterClass(FooFilter.class) // Customize where the API Key check will be inserted (defaults to null)
.headerName("my-awesome-api-key") // Customize the header name (defaults to x-api-key)
.build();
ApiKeyAuthenticationConfigurer.configure(config, http);
}
}
Customization
Using a custom header name
The default header name will be x-api-key, but you can override it as following:
@Configuration
@EnableWebSecurity
public class ApiKeyConfig extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity http) throws Exception {
ApiKeyAuthenticationConfiguration config = ApiKeyAuthenticationConfigurationBuilder.builder()
.authorizedApiKeys(Set.of(ALLOWED_KEY_1, ALLOWED_KEY_2))
.headerName("my-awesome-api-key-header-name")
.build();
ApiKeyAuthenticationConfigurer.configure(config, http);
}
}
Advanced request matching
By default, all endpoints will be secured. You can either use a String-based ANT Pattern or a RequestMatcher to customize which endpoints to protect.
@Configuration
@EnableWebSecurity
public class ApiKeyConfig extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity http) throws Exception {
ApiKeyAuthenticationConfiguration config = ApiKeyAuthenticationConfigurationBuilder.builder()
.authorizedApiKeys(Set.of(ALLOWED_KEY_1, ALLOWED_KEY_2))
.requestMatcher(new OrRequestMatcher(new AntPathRequestMatcher("/public-api/v1/**"), new AntPathRequestMatcher("/public-api/v2/**")))
.build();
ApiKeyAuthenticationConfigurer.configure(config, http);
}
}
NOTE: Unless configured otherwise, endpoints not matched by the request matcher will NOT be secured!
Customizing the timing of the check
The check will be done by a Filter in the FilterChain of each request.
If you want to change when this check happens (e.g. perform other checks first or afterwards), either use the addFilterBeforeClass and addFilterAfterClass methods of the Builder:
@Configuration
@EnableWebSecurity
public class ApiKeyConfig extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity http) throws Exception {
ApiKeyAuthenticationConfiguration config = ApiKeyAuthenticationConfigurationBuilder.builder()
.authorizedApiKeys(Set.of(ALLOWED_KEY_1, ALLOWED_KEY_2))
.addFilterBeforeClass(BasicAuthenticationFilter.class)
.addFilterAfterClass(FooFilter.class)
.build();
ApiKeyAuthenticationConfigurer.configure(config, http);
}
}
NOTE: You can only specify one position. The addFilterAfterClass has a higher priority than addFilterBeforeClass.
43 Dec 10, 2022
3 Mar 9, 2022
10 Oct 9, 2022
158 Dec 30, 2022
274 Dec 28, 2022
2.2k Dec 30, 2022
140 Dec 1, 2022
3 Aug 29, 2021
62 Jan 1, 2023