Spring Security
Go to file
Matthias Luppi 78d5ffe60d Apply minor rewording and formatting 2020-10-12 13:18:02 -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 Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
aspects Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06: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 Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
config Polish JWT Signature Algorithm Discovery 2020-10-09 14:17:30 -06:00
core Bump Schema, Serialization, and Taglib to 5.5 2020-10-07 17:17:58 -06:00
crypto Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
data Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
docs Rework community.adoc 2020-10-12 13:18:02 -06:00
etc Merge Formatting Changes 2020-08-24 17:33:23 -05:00
gradle Set springDataVersion to Neumann-SR+ 2020-09-09 12:35:28 -04:00
itest Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
ldap Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
messaging Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
oauth2 Polish JWT Signature Algorithm Discovery 2020-10-09 14:17:30 -06:00
openid Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
remoting Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
rsocket Revert "Lock Dependency Versions for 5.4.0" 2020-09-09 18:14:12 -04:00
saml2/saml2-service-provider Remove Unused Code 2020-09-28 13:07:48 -06:00
samples Update RSocket Sample to RSocket 1.1.0-M2 2020-10-07 16:01:19 -06:00
scripts Add custom release notes configuration file 2019-12-31 14:19:40 -05:00
taglibs Bump Schema, Serialization, and Taglib to 5.5 2020-10-07 17:17:58 -06:00
test Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
web Replace expected @Test attributes with AssertJ 2020-09-22 16:13:51 -06:00
.editorconfig Use UTF-8 for Java sources and XML 2019-08-14 08:47:00 -05:00
.gitignore Ignore Lock Files 2020-02-07 13:59:05 -06:00
CONTRIBUTING.adoc Apply minor rewording and formatting 2020-10-12 13:18:02 -06:00
Jenkinsfile Disable parallel deployment build in Jenkins 2020-09-09 15:04:15 -04:00
LICENSE.txt Add LICENSE.txt 2020-04-15 16:44:13 -05:00
README.adoc Update Link Text for Getting Spring Security 2020-10-08 09:48:58 -05:00
build.gradle Add build scans to PR builds 2020-09-30 10:20:12 -04: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 Begin 5.5 Development 2020-10-07 16:06:14 -06:00
gradlew Update to Gradle 6.1.1 2020-02-04 23:36:47 -06:00
gradlew.bat Update to Gradle 5.5 2019-07-11 22:15:42 -04:00
notice.txt URL Cleanup 2019-03-19 23:53:23 -05:00
settings.gradle Add build scans to PR builds 2020-09-30 10:20:12 -04: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]

= 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://docs.spring.io/spring-security/site/docs/current/reference/html5/#getting[Getting Spring Security] for how to obtain Spring Security.

== 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
We recommend you visit https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference] and read the "Getting Started" page.

== 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].