Skip to content

Latest commit

 

History

History
187 lines (136 loc) · 8.69 KB

README.md

File metadata and controls

187 lines (136 loc) · 8.69 KB
Raw

Auth0 Spring Security for API

CircleCI MIT Maven Download codecov FOSSA Status

Note As part of our ongoing commitment to best security practices, we have rotated the signing keys used to sign previous releases of this SDK. As a result, new patch builds have been released using the new signing key. Please upgrade at your earliest convenience.

While this change won't affect most developers, if you have implemented a dependency signature validation step in your build process, you may notice a warning that past releases can't be verified. This is expected, and a result of the key rotation process. Updating to the latest version will resolve this for you.

Spring Security integration with Auth0 to secure your API with Json Web Tokens (JWT)

This library targets Spring 4 and Spring Boot 1. If you are using Spring 5 and Spring Boot 2, please see the Spring Security 5 API Quickstart.

Security Considerations

This library uses Spring Security 4, and is targeted at applications using Spring 4 and/or Spring Boot 1.

The following are vulnerabilities that could affect this library when used with Spring 4/Boot 1:

  • CVE-2021-22112 is a medium severity vulnerability in Spring Security (org.springframework.security:spring-security-web) 5.4.x prior to 5.4.4, 5.3.x prior to 5.3.8.RELEASE, and 5.2.x prior to 5.2.9.RELEASE.
    • 5.2.x prior to 5.2.9.RELEASE.
    • 5.3.x prior to 5.3.8.RELASE.
    • 5.4.x prior to 5.4.4.
  • CVE-2021-22060 is a medium severity vulnerability in org.springframework:spring-core affecting:
    • 5.2.x prior to 5.2.19.RELEASE.
    • 5.3.x prior to 5.3.14.
  • CVE-2021-22096 is a medium severity vulnerability in org.springframework:spring-core affecting:
    • 5.2.x prior to 5.2.18.
    • 5.3.x prior to 5.3.12.

It is recommended that projects using this library upgrade to at least:

  • org.springframework.security:spring-security-web to 5.2.9.RELEASE, 5.3.8.RELASE, 5.4.4, or better
  • org.springframework:spring-core to 5.2.19.RELEASE, 5.3.14, or better

💡 Developers will often find it more convenient to use's Spring's native, out-of-the-box OAuth2 support. Please review Auth0's Spring Boot API quickstart for guidance on that implementation path.

Download

Get Auth0 Spring Security API using Maven:

<dependency>
    <groupId>com.auth0</groupId>
    <artifactId>auth0-spring-security-api</artifactId>
    <version>1.5.2</version>
</dependency>

or Gradle:

implementation 'com.auth0:auth0-spring-security-api:1.5.2'

Usage

Inside a WebSecurityConfigurerAdapter you can configure your API to only accept RS256 signed JWTs:

@EnableWebSecurity
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        JwtWebSecurityConfigurer
                .forRS256("YOUR_API_AUDIENCE", "YOUR_API_ISSUER")
                .configure(http);
    }
}

or for HS256 signed JWTs:

@EnableWebSecurity
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        JwtWebSecurityConfigurer
                .forHS256("YOUR_API_AUDIENCE", "YOUR_API_ISSUER", "YOUR_API_SECRET".getBytes())
                .configure(http);
    }
}

If you need further customization (like a leeway for JWT verification) use the JwtWebSecurityConfigurer signatures which accept a JwtAuthenticationProvider.

If you need to configure several allowed issuers use the JwtWebSecurityConfigurer signatures which accept a String[] issuers.

Then using Spring Security HttpSecurity you can specify which paths requires authentication:

    http.authorizeRequests()
        .antMatchers("/api/**").fullyAuthenticated();

To restrict access based on the presence of a specific scope or permission claim, you can use the hasAuthority method. Scope and permissions claim values are prefixed with SCOPE_ and PERMISSION_, respectively.

To require a specific scope (read:users in the example below):

    http.authorizeRequests()
        .antMatchers(HttpMethod.GET, "/api/users/**").hasAuthority("SCOPE_read:users");

To require a specific permission (admin in the example below):

    http.authorizeRequests()
        .antMatchers(HttpMethod.GET, "/api/admin/**").hasAuthority("PERMISSION_admin");

JwtWebSecurityConfigurer#configure(HttpSecurity) also returns HttpSecurity so you can do the following:

@EnableWebSecurity
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        JwtWebSecurityConfigurer
                .forRS256("YOUR_API_AUDIENCE", "YOUR_API_ISSUER")
                .configure(http)
                .authorizeRequests()
                        .antMatchers(HttpMethod.GET, "/api/users/**").hasAuthority("SCOPE_read:users")
                        .antMatchers(HttpMethod.GET, "/api/admin/**").hasAuthority("PERMISSION_admin");
    }
}

Sample

Perhaps the easiest way to learn how to use this library (and quickly get started with a working app) is to study the Auth0 Spring Security API Sample and its README.

What is Auth0?

Auth0 helps you to:

  • Add authentication with multiple authentication sources, either social like Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, amont others, or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS or any SAML Identity Provider.
  • Add authentication through more traditional username/password databases.
  • Add support for linking different user accounts with the same user.
  • Support for generating signed Json Web Tokens to call your APIs and flow the user identity securely.
  • Analytics of how, when and where users are logging in.
  • Pull data from other sources and add it to the user profile, through JavaScript rules.

Create a free account in Auth0

  1. Go to Auth0 and click Sign Up.
  2. Use Google, GitHub or Microsoft Account to login.

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.

FOSSA Status