Spring Security
Go to file
Eleftheria Stein 88a3f5ad39 Fix README local Maven install command
Switching from the maven to maven-publish plugin means users should use publishToMavenLocal to install jars into their local Maven cache.

Closes gh-10047
2021-07-07 12:01:57 +02:00
.github Add Name for Check Milestone 2021-06-22 14:04:37 -05:00
.idea Fix checkstyle rules could not be parsed 2020-11-23 14:33:18 -05:00
acl add management platform(project(":spring-security-dependencies")) 2021-04-05 10:36:36 -05:00
aspects add management platform(project(":spring-security-dependencies")) 2021-04-05 10:36:36 -05:00
bom fix bom 2021-05-17 22:29:45 -05:00
buildSrc Add a link checker to docs build 2021-06-21 10:42:55 -03:00
cas add management platform(project(":spring-security-dependencies")) 2021-04-05 10:36:36 -05:00
config Support A Well-Known URL for Changing Passwords 2021-07-01 16:57:53 -06:00
core Polish Assertion 2021-06-30 10:12:27 -06:00
crypto Replace < and > with &lt and &gt in Javadoc 2021-06-04 12:26:07 +03:00
data add management platform(project(":spring-security-dependencies")) 2021-04-05 10:36:36 -05:00
dependencies Add springFrameworkVersion property in gradle 2021-06-29 13:20:47 -03:00
docs Document PasswordManagementConfigurer 2021-07-01 16:58:43 -06:00
etc Add Jwt Client Authentication support 2021-04-08 15:44:33 -04:00
gradle/wrapper Update to Gradle 6.9 2021-05-14 13:39:18 -05:00
itest add management platform(project(":spring-security-dependencies")) 2021-04-05 10:36:36 -05:00
ldap Handle encoded spaces in the root dn 2021-05-25 10:54:41 -06:00
messaging add management platform(project(":spring-security-dependencies")) 2021-04-05 10:36:36 -05:00
oauth2 Update Copyright 2021-06-17 08:34:31 -06:00
openid add management platform(project(":spring-security-dependencies")) 2021-04-05 10:36:36 -05:00
remoting Polish DNS SRV lookup method with port 2021-05-20 14:29:45 +02:00
rsocket Format PayloadInterceptorRSocket 2021-06-04 11:54:47 -06:00
saml2/saml2-service-provider Fix Saml2WebSsoAuthenticationRequestFilter javadoc 2021-06-30 13:41:52 +02:00
scripts Fix Release Notes Template 2021-05-14 11:01:27 -05:00
taglibs Update to Spring Security 5.6 2021-05-18 10:45:17 -06:00
test Replace StringUtils from oauth2-oidc-sdk 2021-06-16 12:18:28 -06:00
web Support A Well-Known URL for Changing Passwords 2021-07-01 16:57:53 -06:00
.editorconfig Use UTF-8 for Java sources and XML 2019-08-14 08:47:00 -05:00
.gitattributes Ensure line endings for .bat are not modified 2021-07-05 14:11:49 -03:00
.gitignore Ignore Lock Files 2020-02-07 13:59:05 -06:00
CONTRIBUTING.adoc master->main 2021-04-26 16:55:43 -05:00
LICENSE.txt Add LICENSE.txt 2020-04-15 16:44:13 -05:00
README.adoc Fix README local Maven install command 2021-07-07 12:01:57 +02:00
RELEASE.adoc Add generateChangelog 2021-04-30 16:10:08 -05:00
build.gradle opensaml fixes 2021-05-17 15:51:55 -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 Add samplesBranch property 2021-07-01 09:01:25 -03:00
gradlew Update to Gradle 6.6.1 2020-10-12 17:41:16 -06:00
gradlew.bat Update to Gradle 6.6.1 2020-10-12 17:41:16 -06:00
notice.txt URL Cleanup 2019-03-19 23:53:23 -05:00
settings.gradle Update to com.gradle.enterprise 3.6.1 2021-05-17 10:37:09 -05: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]

image:https://github.com/spring-projects/spring-security/workflows/CI/badge.svg?branch=main["Build Status", link="https://github.com/spring-projects/spring-security/actions?query=workflow%3ACI"]

image:https://img.shields.io/badge/Revved%20up%20by-Gradle%20Enterprise-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Gradle Enterprise", link="https://ge.spring.io/scans?search.rootProjectNames=spring-security"]

= 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/main/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
See https://docs.spring.io/spring-security/site/docs/current/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[JDK11 build].

Be sure that your `JAVA_HOME` environment variable points to the `jdk-11` 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 publishToMavenLocal
----

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