Security Top

I just announced the new Learn Spring Security course, including the full material focused on the new OAuth2 stack in Spring Security 5:

>> CHECK OUT THE COURSE

1. Overview

In this article, we'll explain how to setup Spring Security with Maven and go over specific use-cases of using Spring Security dependencies. You can find the latest Spring Security releases on Maven Central.

This is a followup to the previous Spring with Maven article, so for non-security Spring dependencies, that's the place to start.

2. Spring Security With Maven

2.1. spring-security-core

The Core Spring Security support – spring-security-core – contains authentication and access control functionality.

Additionally, it supports the standalone (non-web) applications, method level security and JDBC:

<properties>
    <spring-security.version>5.0.6.RELEASE</spring-security.version>
    <spring.version>5.0.6.RELEASE</spring.version>
</properties>
<dependency>
    <groupId>org.springframework.security</groupId>
    <artifactId>spring-security-core</artifactId>
    <version>${spring-security.version}</version>
</dependency>

Note that Spring and Spring Security are on different release schedules, so there isn't always a 1:1 match between the version numbers.

If you're working with older versions of Spring – also very important to understand is the fact that, unintuitively, Spring Security 3.1.x do not depend on Spring 3.1.x releases! This is because Spring Security 3.1.x was released before Spring 3.1. The plan is to align these dependencies more closely in future releases – see this JIRA for more details – but for the time being, this has practical implications that we'll look at next.

2.2. spring-security-web

To add Web support for Spring Security, we need the spring-security-web dependency:

<dependency>
    <groupId>org.springframework.security</groupId>
    <artifactId>spring-security-web</artifactId>
    <version>${spring-security.version}</version>
</dependency>

This contains filters and related web security infrastructure that enables URL access control in a Servlet environment.

2.3. Spring Security and Older Spring Core Dependencies Problem

This new dependency also exhibits a problem for the Maven dependency graph. As mentioned above, Spring Security jars do not depend on the latest Spring core jars (but on the previous version). This may lead to these older dependencies making their way on top the classpath instead of the newer 4.x Spring artifacts.

To understand why this is happening, we need to look at how Maven resolves conficts. In case of a version conflict, Maven will pick the jar that is closest to the root of the tree. In our case, spring-core is defined by both spring-orm (with the 4.x.RELEASE version) but also by spring-security-core (with the old 3.2.8.RELEASE version). So in both cases, spring-jdbc is defined at a depth of 1 from the root pom of our project. Because of that, it will actually matter in which order spring-orm and spring-security-core are defined in our own pom. The first one will take priority so we may end up with either version on our classpath.

To address this problem, we'll have to explicitly define some of the Spring dependencies in our own pom and not rely on the implicit Maven dependency resolution mechanism. Doing this will put that particular dependency at depth 0 from our pom (as it's defined in the pom itself) so it will take priority. All of the following fall into the same category and all need to be explicitly defined, either directly or, for multi-module projects, in the dependencyManagement element of the parent:

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>${spring-version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>${spring-version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-jdbc</artifactId>
    <version>${spring-version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-beans</artifactId>
    <version>${spring-version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aop</artifactId>
    <version>${spring-version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-tx</artifactId>
    <version>${spring-version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-expression</artifactId>
    <version>${spring-version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
    <version>${spring-version}</version>
</dependency>

2.4. spring-security-config and Others

To use the rich Spring Security XML namespace and annotations, we'll need the spring-security-config dependency:

<dependency>
    <groupId>org.springframework.security</groupId>
    <artifactId>spring-security-config</artifactId>
    <version>${spring-security.version}</version>
</dependency>

Finally, LDAP, ACL, CAS and OpenID support have their own dependencies in Spring Security: spring-security-ldap, spring-security-acl, spring-security-cas and spring-security-openid.

3. Using Snapshots and Milestones

Spring Security milestones as well as snapshots are available in the custom Maven repositories provided by Spring. For additional details about how to configure these, see how to use Snapshots and Milestones.

4. Conclusion

In this quick tutorial, we discussed the practical details of using Spring Security with Maven. The Maven dependencies presented here are of course some of the major ones, and there are several others that may be worth mentioning and haven't yet made the cut. Nevertheless this should be a good starting point for using Spring in a Maven enabled project.

Security bottom

I just announced the new Learn Spring Security course, including the full material focused on the new OAuth2 stack in Spring Security 5:

>> CHECK OUT THE COURSE
2 Comments
Oldest
Newest Most Voted
Inline Feedbacks
View all comments
Alexey Dushen
Alexey Dushen
5 years ago

Instead of explicitly defining Spring dependencies you could use Spring BOM (Bill Of Materials)
Look at http://docs.spring.io/spring-security/site/docs/3.2.3.RELEASE/reference/htmlsingle/#maven-bom

org.springframework
spring-framework-bom
4.0.2.RELEASE
pom
import

Current Spring Security release (v3.2.5) is compatible with Spring Framework 3.2.8.RELEASE & Spring Framework 4.0.2.RELEASE.
http://docs.spring.io/spring-security/site/docs/3.2.5.RELEASE/reference/htmlsingle/#maven-bom

You have a lot of great articles! Thank you so much.

Eugen Paraschiv
5 years ago
Reply to  Alexey Dushen

Hey Alexey – the bom approach is an interesting one and I’ve looked into it when it came out. I still think that it pays off understanding the exact dependencies that you have in your pom, but yes – as a shortcut, I’d try out the bom first. Glad you’re finding the site useful. Cheers,
Eugen.

Comments are closed on this article!