GitHub - spring-projects/spring-security: Spring Security

Gitter

Build Status

Revved up by Develocity

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

Downloading Artifacts

Documentation

Quick Start

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

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

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.

IDE setup (IntelliJ)

No special steps are needed to open Spring Security in IntelliJ.

IDE setup (Eclipse and VS Code)

To work in Eclipse or VS Code, first generate Eclipse metadata so you can import the project into Eclipse or VS Code:

./gradlew cleanEclipse eclipse

If you have not built the project yet, run ./gradlew publishToMavenLocal first so dependencies are resolved.

VS Code: Open the repository root as a folder. The repository includes .vscode/settings.json which disables automatic Gradle import so that the generated Eclipse metadata (.classpath, .project) is used. Do not use the Gradle for Java extension to import the project.

Eclipse: File → Import → General → Existing Projects into Workspace, then select the repository root.

The build uses a custom Eclipse plugin to work around Gradle dependency cycles that confuse IDE metadata generation. You may see Eclipse warnings about xml-apis from some test dependencies; those are excluded in the build and can be ignored.

Getting Support

Contributing

License