Spring Security
Go to file
Josh Cummings 5f7fc0eb26
Improve Upgrading
Closes gh-11259
2022-05-16 11:08:00 -06:00
.github Add build scans to PR builds 2020-09-30 10:20:12 -04:00
.idea Add Checkstyle configuration for IntelliJ IDEA 2019-08-09 16:21:30 -05:00
acl Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
aspects Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
bom Use spring-build-conventions Bom plugin 2018-01-09 11:27:34 -06:00
buildSrc Use parenthesis with single-arg lambdas 2020-08-24 17:33:08 -05:00
cas Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
config Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
core Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
crypto Improve Upgrading 2022-05-16 11:08:00 -06:00
data Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
docs Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
etc Merge Formatting Changes 2020-08-24 17:33:23 -05:00
gradle Downgrade to Nimbus JOSE JWT 8.+ 2021-02-12 10:56:35 +00:00
itest Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
ldap Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
messaging Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
oauth2 Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
openid Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
remoting Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
rsocket Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
saml2/saml2-service-provider Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
samples Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
scripts Add custom release notes configuration file 2019-12-31 14:19:40 -05:00
taglibs Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
test Revert "Lock Dependencies for Release" 2021-12-20 16:47:36 -03:00
web AntRegexRequestMatcher Optimization 2022-05-16 10:18:51 -05:00
.editorconfig Fixed link in .editorconfig 2021-10-13 15:38:01 -06:00
.gitignore Ignore Lock Files 2020-02-07 13:59:05 -06:00
CONTRIBUTING.adoc Rework CONTRIBUTING.adoc 2020-10-12 13:35:34 -06:00
LICENSE.txt Add LICENSE.txt 2020-04-15 16:44:13 -05:00
README.adoc Add End-of-Life Notice 2022-01-03 12:58:28 +02:00
build.gradle Update to spring-build-conventions:0.0.38 2021-06-29 16:14:43 -05:00
class_mapping_from_2.0.x.txt SEC-1148: Simple classname mapping from 2.0 to 3.0 2009-12-02 22:44:30 +00:00
gradle.properties Next development version 2021-12-20 16:48:09 -03:00
gradlew Update to Gradle 6.6.1 2020-10-12 18:01:31 -06:00
gradlew.bat Update to Gradle 6.6.1 2020-10-12 18:01:31 -06:00
notice.txt URL Cleanup 2019-03-19 23:53:23 -05:00
settings.gradle Update to Gradle 6.6.1 2020-10-12 18:01:31 -06:00

README.adoc

image::https://badges.gitter.im/Join%20Chat.svg[Gitter,link=https://gitter.im/spring-projects/spring-security?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge]

[NOTE]
======
This branch of Spring Security has reached its https://github.com/spring-projects/spring-framework/wiki/Spring-Framework-Versions#supported-versions[End of Life], meaning that there are no further maintenance releases or security patches planned.
Please migrate to a supported branch as soon as possible.
======

= Spring Security

Spring Security provides security services for the https://docs.spring.io[Spring IO Platform]. Spring Security 5.0 requires Spring 5.0 as
a minimum and also requires Java 8.

For a detailed list of features and access to the latest release, please visit https://spring.io/projects[Spring projects].

== Code of Conduct
Please see our https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md[code of conduct]

== Downloading Artifacts
See https://github.com/spring-projects/spring-framework/wiki/Downloading-Spring-artifacts[downloading Spring artifacts] for Maven repository information.

== Documentation
Be sure to read the https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference].
Extensive JavaDoc for the Spring Security code is also available in the https://docs.spring.io/spring-security/site/docs/current/api/[Spring Security API Documentation].

== Quick Start
See https://docs.spring.io/spring-security/site/docs/5.4.x/reference/html5/#servlet-hello[Hello Spring Security] to get started with a "Hello, World" application.

== Building from Source
Spring Security uses a https://gradle.org[Gradle]-based build system.
In the instructions below, https://vimeo.com/34436402[`./gradlew`] is invoked from the root of the source tree and serves as
a cross-platform, self-contained bootstrap mechanism for the build.

=== Prerequisites
https://help.github.com/set-up-git-redirect[Git] and the https://www.oracle.com/technetwork/java/javase/downloads[JDK8 build].

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

=== Check out sources
[indent=0]
----
git clone git@github.com:spring-projects/spring-security.git
----

=== Install all spring-\* jars into your local Maven cache
[indent=0]
----
./gradlew install
----

=== Compile and test; build all jars, distribution zips, and docs
[indent=0]
----
./gradlew build
----

Discover more commands with `./gradlew tasks`.
See also the https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ[Gradle build and release FAQ].

== Getting Support
Check out the https://stackoverflow.com/questions/tagged/spring-security[Spring Security tags on Stack Overflow].
https://spring.io/services[Commercial support] is available too.

== Contributing
https://help.github.com/articles/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/master/CONTRIBUTING.adoc[contributor guidelines] for details.

== License
Spring Security is Open Source software released under the
https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].