Spring Security

Spring Security provides security services for the Spring IO Platform. Spring Security 6.0 requires Spring 6.0 as a minimum and also requires Java 17.

For a detailed list of features and access to the latest release, please visit Spring projects.

Code of Conduct

Please see our code of conduct

Downloading Artifacts

See Getting Spring Security for how to obtain Spring Security.

Documentation

Be sure to read the Spring Security Reference. Extensive JavaDoc for the Spring Security code is also available in the Spring Security API Documentation.

Quick Start

See Hello Spring Security to get started with a "Hello, World" application.

Building from Source

Spring Security uses a Gradle-based build system. In the instructions below, ./gradlew is invoked from the root of the source tree and serves as a cross-platform, self-contained bootstrap mechanism for the build.

Prerequisites

Git and the JDK17 build.

Be sure that your JAVA_HOME environment variable points to the jdk-17 folder extracted from the JDK download.

Check out sources

git clone git@github.com:spring-projects/spring-security.git

Install all spring-*.jar into your local Maven repository.

./gradlew publishToMavenLocal

Compile and test; build all JARs, distribution zips, and docs

./gradlew build

The reference docs are not currently included in the distribution zip. You can build the reference docs for this branch by running the following command:

./gradlew :spring-security-docs:antora

That command publishes the docs site to the docs/build/site directory. The playbook branch describes how to build the reference docs in detail.

Discover more commands with ./gradlew tasks.

Getting Support

Check out the Spring Security tags on Stack Overflow. Commercial support is available too.

Contributing

Pull requests are welcome; see the contributor guidelines for details.

License

Spring Security is Open Source software released under the Apache 2.0 license.