Maintenance Mode

This project is in maintenance mode and will each End-of-Life on 6 October 2021. Please use Spring Security’s SAML support instead.

Note	In the past, there were develop and develop-3.0 branches, though these are not maintained, and PRs are no longer being considered on these branches. No further releases will be issued from these two branches. Please feel free to fork the repository if you need to make changes.

We continue to consider pull requests for 1.0.x bug fixes, but are not actively developing this project.

Spring SAML

Spring SAML Extension allows seamless inclusion of SAML 2.0 Service Provider capabilities in Spring applications. All products supporting SAML 2.0 in Identity Provider mode (e.g. ADFS 2.0, Shibboleth, OpenAM/OpenSSO, Ping Federate, Okta) can be used to connect with Spring SAML Extension.

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.

Dependencies

Spring Security SAML publishes GA (general availability) versions to Maven Central, so you can just add the following to your POM:

<dependency>
    <groupId>org.springframework.security.extensions</groupId>
    <artifactId>spring-security-saml</artifactId>
    <version>1.0.10.RELEASE</version>
</dependency>

or the following to build.gradle:

implementation 'org.springframework.security.extensions:spring-security-saml:1.0.10.RELEASE'

See downloading Spring artifacts for more information.

Documentation

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

Quick Start

We recommend you visit Spring Security SAML Reference’s quick start.

Or, feel free to check out an online demonstration.

Building from Source

Spring Security SAML 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 a JDK, Spring Security SAML is compatible with JDK 1.6.

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

Checkout sources

git clone [email protected]:spring-projects/spring-security-saml.git

Install all spring-\* jars into your local Maven cache

./gradlew install

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

./gradlew build

Discover more commands with ./gradlew tasks. See also Spring Framework’s Build from Source documentation.

Getting Support

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

Commercial: [email protected]

Contributing

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