Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch '5.6.x' into 5.7.x 

Closes gh-13404
This commit is contained in:
Rob Winch 2023-06-18 21:31:35 -05:00
parent 0a022a348c 39c43159f4
commit 0cf95dbf61
96 changed files with 4418 additions and 2667 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
docs/modules/ROOT/pages/features/authentication/password-storage.adoc
View File

@ -67,26 +67,31 @@ Instead Spring Security introduces `DelegatingPasswordEncoder` which solves all
You can easily construct an instance of `DelegatingPasswordEncoder` using `PasswordEncoderFactories`.
.Create Default DelegatingPasswordEncoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
PasswordEncoder passwordEncoder =
PasswordEncoderFactories.createDelegatingPasswordEncoder();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val passwordEncoder: PasswordEncoder = PasswordEncoderFactories.createDelegatingPasswordEncoder()
----
====
======
Alternatively, you may create your own custom instance. For example:
.Create Custom DelegatingPasswordEncoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
String idForEncode = "bcrypt";
@ -101,7 +106,8 @@ PasswordEncoder passwordEncoder =
new DelegatingPasswordEncoder(idForEncode, encoders);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val idForEncode = "bcrypt"
@ -114,7 +120,7 @@ encoders["sha256"] = StandardPasswordEncoder()
val passwordEncoder: PasswordEncoder = DelegatingPasswordEncoder(idForEncode, encoders)
----
====
======
[[authentication-password-storage-dpe-format]]
=== Password Storage Format
@ -122,12 +128,10 @@ val passwordEncoder: PasswordEncoder = DelegatingPasswordEncoder(idForEncode, en
The general format for a password is:
.DelegatingPasswordEncoder Storage Format
====
[source,text,attrs="-attributes"]
----
{id}encodedPassword
----
====
Such that `id` is an identifier used to look up which `PasswordEncoder` should be used and `encodedPassword` is the original encoded password for the selected `PasswordEncoder`.
The `id` must be at the beginning of the password, start with `{` and end with `}`.
@ -136,7 +140,6 @@ For example, the following might be a list of passwords encoded using different
All of the original passwords are "password".
.DelegatingPasswordEncoder Encoded Passwords Example
====
[source,text,attrs="-attributes"]
----
{bcrypt}$2a$10$dXJ3SW6G7P50lGmMkkmwe.20cQQubK3.HZWzG3YB1tlRy.fqvM/BG // <1>
@ -145,7 +148,6 @@ All of the original passwords are "password".
{scrypt}$e0801$8bWJaSu2IKSn9Z9kM+TPXfOc/9bdYSrN1oD9qfVThWEwdRTnO7re7Ei+fUZRJ68k9lTyuTeUp4of4g24hHnazw==$OAOec05+bXxvuu/1qZ6NUR+xQYvYv7BeL1QxwRpY5Pc= // <4>
{sha256}97cde38028ad898ebc02e690819fa220e88c62e0699403e94fff291cfffaf8410849f27605abcbc0 // <5>
----
====
<1> The first password would have a `PasswordEncoder` id of `bcrypt` and encodedPassword of `$2a$10$dXJ3SW6G7P50lGmMkkmwe.20cQQubK3.HZWzG3YB1tlRy.fqvM/BG`.
When matching it would delegate to `BCryptPasswordEncoder`
@ -174,12 +176,10 @@ In the `DelegatingPasswordEncoder` we constructed above, that means that the res
The end result would look like:
.DelegatingPasswordEncoder Encode Example
====
[source,text,attrs="-attributes"]
----
{bcrypt}$2a$10$dXJ3SW6G7P50lGmMkkmwe.20cQQubK3.HZWzG3YB1tlRy.fqvM/BG
----
====
[[authentication-password-storage-dpe-matching]]
=== Password Matching
@ -201,8 +201,10 @@ If you are putting together a demo or a sample, it is a bit cumbersome to take t
There are convenience mechanisms to make this easier, but this is still not intended for production.
.withDefaultPasswordEncoder Example
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
User user = User.withDefaultPasswordEncoder()
@ -214,7 +216,8 @@ System.out.println(user.getPassword());
// {bcrypt}$2a$10$dXJ3SW6G7P50lGmMkkmwe.20cQQubK3.HZWzG3YB1tlRy.fqvM/BG
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
val user = User.withDefaultPasswordEncoder()
@ -225,13 +228,15 @@ val user = User.withDefaultPasswordEncoder()
println(user.password)
// {bcrypt}$2a$10$dXJ3SW6G7P50lGmMkkmwe.20cQQubK3.HZWzG3YB1tlRy.fqvM/BG
----
====
======
If you are creating multiple users, you can also reuse the builder.
.withDefaultPasswordEncoder Reusing the Builder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
UserBuilder users = User.withDefaultPasswordEncoder();
@ -247,7 +252,8 @@ User admin = users
.build();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val users = User.withDefaultPasswordEncoder()
@ -262,7 +268,7 @@ val admin = users
.roles("USER", "ADMIN")
.build()
----
====
======
This does hash the password that is stored, but the passwords are still exposed in memory and in the compiled source code.
Therefore, it is still not considered secure for a production environment.
@ -276,13 +282,11 @@ The easiest way to properly encode your password is to use the https://docs.spri
For example, the following will encode the password of `password` for use with <<authentication-password-storage-dpe>>:
.Spring Boot CLI encodepassword Example
====
[source,attrs="-attributes"]
----
spring encodepassword password
{bcrypt}$2a$10$X5wFBtLrL/kHcmrOGGTrGufsBX8CJ0WpQpF3pgeuxBB/H73BK1DW6
----
====
[[authentication-password-storage-dpe-troubleshoot]]
=== Troubleshooting
@ -328,8 +332,10 @@ The default implementation of `BCryptPasswordEncoder` uses strength 10 as mentio
tune and test the strength parameter on your own system so that it takes roughly 1 second to verify a password.
.BCryptPasswordEncoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Create an encoder with strength 16
@ -338,7 +344,8 @@ String result = encoder.encode("myPassword");
assertTrue(encoder.matches("myPassword", result));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Create an encoder with strength 16
@ -346,7 +353,7 @@ val encoder = BCryptPasswordEncoder(16)
val result: String = encoder.encode("myPassword")
assertTrue(encoder.matches("myPassword", result))
----
====
======
[[authentication-password-storage-argon2]]
== Argon2PasswordEncoder
@ -358,8 +365,10 @@ Like other adaptive one-way functions, it should be tuned to take about 1 second
The current implementation of the `Argon2PasswordEncoder` requires BouncyCastle.
.Argon2PasswordEncoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Create an encoder with all the defaults
@ -368,7 +377,8 @@ String result = encoder.encode("myPassword");
assertTrue(encoder.matches("myPassword", result));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Create an encoder with all the defaults
@ -376,7 +386,7 @@ val encoder = Argon2PasswordEncoder()
val result: String = encoder.encode("myPassword")
assertTrue(encoder.matches("myPassword", result))
----
====
======
[[authentication-password-storage-pbkdf2]]
== Pbkdf2PasswordEncoder
@ -387,8 +397,10 @@ Like other adaptive one-way functions, it should be tuned to take about 1 second
This algorithm is a good choice when FIPS certification is required.
.Pbkdf2PasswordEncoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Create an encoder with all the defaults
@ -397,7 +409,8 @@ String result = encoder.encode("myPassword");
assertTrue(encoder.matches("myPassword", result));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Create an encoder with all the defaults
@ -405,7 +418,7 @@ val encoder = Pbkdf2PasswordEncoder()
val result: String = encoder.encode("myPassword")
assertTrue(encoder.matches("myPassword", result))
----
====
======
[[authentication-password-storage-scrypt]]
== SCryptPasswordEncoder
@ -415,8 +428,10 @@ In order to defeat password cracking on custom hardware scrypt is a deliberately
Like other adaptive one-way functions, it should be tuned to take about 1 second to verify a password on your system.
.SCryptPasswordEncoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Create an encoder with all the defaults
@ -425,7 +440,8 @@ String result = encoder.encode("myPassword");
assertTrue(encoder.matches("myPassword", result));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Create an encoder with all the defaults
@ -433,7 +449,7 @@ val encoder = SCryptPasswordEncoder()
val result: String = encoder.encode("myPassword")
assertTrue(encoder.matches("myPassword", result))
----
====
======
[[authentication-password-storage-other]]
== Other PasswordEncoders
@ -458,8 +474,10 @@ You should instead migrate to using `DelegatingPasswordEncoder` to support secur
====
.NoOpPasswordEncoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -468,14 +486,16 @@ public static PasswordEncoder passwordEncoder() {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<b:bean id="passwordEncoder"
class="org.springframework.security.crypto.password.NoOpPasswordEncoder" factory-method="getInstance"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -483,7 +503,7 @@ fun passwordEncoder(): PasswordEncoder {
return NoOpPasswordEncoder.getInstance();
}
----
====
======
[NOTE]
====
@ -501,36 +521,42 @@ You can configure Spring Security to provide this discovery endpoint.
For example, if the change password endpoint in your application is `/change-password`, then you can configure Spring Security like so:
.Default Change Password Endpoint
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
http
.passwordManagement(Customizer.withDefaults())
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<sec:password-management/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
http {
passwordManagement { }
}
----
====
======
Then, when a password manager navigates to `/.well-known/change-password` then Spring Security will redirect your endpoint, `/change-password`.
Or, if your endpoint is something other than `/change-password`, you can also specify that like so:
.Change Password Endpoint
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
http
@ -539,13 +565,15 @@ http
)
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<sec:password-management change-password-page="/update-password"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
http {
@ -554,6 +582,6 @@ http {
}
}
----
====
======
With the above configuration, when a password manager navigates to `/.well-known/change-password`, then Spring Security will redirect to `/update-password`.

20
docs/modules/ROOT/pages/features/exploits/csrf.adoc
View File

@ -25,7 +25,6 @@ Assume that your bank's website provides a form that allows transferring money f
For example, the transfer form might look like:
.Transfer form
====
[source,html]
----
<form method="post"
@ -40,12 +39,10 @@ For example, the transfer form might look like:
value="Transfer"/>
</form>
----
====
The corresponding HTTP request might look like:
.Transfer HTTP request
====
[source]
----
POST /transfer HTTP/1.1
@ -55,13 +52,11 @@ Content-Type: application/x-www-form-urlencoded
amount=100.00&routingNumber=1234&account=9876
----
====
Now pretend you authenticate to your bank's website and then, without logging out, visit an evil website.
The evil website contains an HTML page with the following form:
.Evil transfer form
====
[source,html]
----
<form method="post"
@ -79,7 +74,6 @@ The evil website contains an HTML page with the following form:
value="Win Money!"/>
</form>
----
====
You like to win money, so you click on the submit button.
In the process, you have unintentionally transferred $100 to a malicious user.
@ -134,7 +128,6 @@ Assume the actual CSRF token is required to be in an HTTP parameter named `_csrf
Our application's transfer form would look like:
.Synchronizer Token Form
====
[source,html]
----
<form method="post"
@ -152,7 +145,6 @@ Our application's transfer form would look like:
value="Transfer"/>
</form>
----
====
The form now contains a hidden input with the value of the CSRF token.
External sites cannot read the CSRF token since the same origin policy ensures the evil site cannot read the response.
@ -160,7 +152,6 @@ External sites cannot read the CSRF token since the same origin policy ensures t
The corresponding HTTP request to transfer money would look like this:
.Synchronizer Token request
====
[source]
----
POST /transfer HTTP/1.1
@ -170,7 +161,6 @@ Content-Type: application/x-www-form-urlencoded
amount=100.00&routingNumber=1234&account=9876&_csrf=4bfd1575-3ad1-4d21-96c7-4ef2d9f86721
----
====
You will notice that the HTTP request now contains the `_csrf` parameter with a secure random value.
@ -191,12 +181,10 @@ Spring Framework's https://docs.spring.io/spring-framework/docs/current/javadoc-
An example, HTTP response header with the `SameSite` attribute might look like:
.SameSite HTTP response
====
[source]
----
Set-Cookie: JSESSIONID=randomid; Domain=bank.example.com; Secure; HttpOnly; SameSite=Lax
----
====
Valid values for the `SameSite` attribute are:
@ -245,7 +233,6 @@ However, you must be very careful as there are CSRF exploits that can impact JSO
For example, a malicious user can create a http://blog.opensecurityresearch.com/2012/02/json-csrf-with-parameter-padding.html[CSRF with JSON using the following form]:
.CSRF with JSON form
====
[source,html]
----
<form action="https://bank.example.com/transfer" method="post" enctype="text/plain">
@ -254,13 +241,11 @@ For example, a malicious user can create a http://blog.opensecurityresearch.com/
value="Win Money!"/>
</form>
----
====
This will produce the following JSON structure
.CSRF with JSON request
====
[source,javascript]
----
{ "amount": 100,
@ -269,13 +254,11 @@ This will produce the following JSON structure
"ignore_me": "=test"
}
----
====
If an application were not validating the Content-Type, then it would be exposed to this exploit.
Depending on the setup, a Spring MVC application that validates the Content-Type could still be exploited by updating the URL suffix to end with `.json` as shown below:
.CSRF with JSON Spring MVC form
====
[source,html]
----
<form action="https://bank.example.com/transfer.json" method="post" enctype="text/plain">
@ -284,7 +267,6 @@ Depending on the setup, a Spring MVC application that validates the Content-Type
value="Win Money!"/>
</form>
----
====
[[csrf-when-stateless]]
=== CSRF and Stateless Browser Applications
@ -393,7 +375,6 @@ In some applications a form parameter can be used to override the HTTP method.
For example, the form below could be used to treat the HTTP method as a `delete` rather than a `post`.
.CSRF Hidden HTTP Method Form
====
[source,html]
----
<form action="/process"
@ -404,7 +385,6 @@ For example, the form below could be used to treat the HTTP method as a `delete`
value="delete"/>
</form>
----
====
Overriding the HTTP method occurs in a filter.

20
docs/modules/ROOT/pages/features/exploits/headers.adoc
View File

@ -24,7 +24,6 @@ Spring Security provides a default set of security related HTTP response headers
The default for Spring Security is to include the following headers:
.Default Security HTTP Response Headers
====
[source,http]
----
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
@ -35,7 +34,6 @@ Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
X-XSS-Protection: 1; mode=block
----
====
NOTE: Strict-Transport-Security is only added on HTTPS requests
@ -62,14 +60,12 @@ If a user authenticates to view sensitive information and then logs out, we don'
The cache control headers that are sent by default are:
.Default Cache Control HTTP Response Headers
====
[source]
----
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
----
====
In order to be secure by default, Spring Security adds these headers by default.
However, if your application provides its own cache control headers Spring Security will back out of the way.
@ -102,12 +98,10 @@ A malicious user might create a http://webblaze.cs.berkeley.edu/papers/barth-cab
Spring Security disables content sniffing by default by adding the following header to HTTP responses:
.nosniff HTTP Response Header
====
[source,http]
----
X-Content-Type-Options: nosniff
----
====
[[headers-hsts]]
== HTTP Strict Transport Security (HSTS)
@ -137,12 +131,10 @@ For example, Spring Security's default behavior is to add the following header w
.Strict Transport Security HTTP Response Header
====
[source]
----
Strict-Transport-Security: max-age=31536000 ; includeSubDomains ; preload
----
====
The optional `includeSubDomains` directive instructs the browser that subdomains (e.g. secure.mybank.example.com) should also be treated as an HSTS domain.
@ -247,12 +239,10 @@ A security policy contains a set of security policy directives, each responsible
For example, a web application can declare that it expects to load scripts from specific, trusted sources, by including the following header in the response:
.Content Security Policy Example
====
[source]
----
Content-Security-Policy: script-src https://trustedscripts.example.com
----
====
An attempt to load a script from another source other than what is declared in the `script-src` directive will be blocked by the user-agent.
Additionally, if the https://www.w3.org/TR/CSP2/#directive-report-uri[report-uri] directive is declared in the security policy, then the violation will be reported by the user-agent to the declared URL.
@ -260,12 +250,10 @@ Additionally, if the https://www.w3.org/TR/CSP2/#directive-report-uri[report-uri
For example, if a web application violates the declared security policy, the following response header will instruct the user-agent to send violation reports to the URL specified in the policy's `report-uri` directive.
.Content Security Policy with report-uri
====
[source]
----
Content-Security-Policy: script-src https://trustedscripts.example.com; report-uri /csp-report-endpoint/
----
====
https://www.w3.org/TR/CSP2/#violation-reports[Violation reports] are standard JSON structures that can be captured either by the web application's own API or by a publicly hosted CSP violation reporting service, such as, https://report-uri.com/.
@ -276,12 +264,10 @@ When a policy is deemed effective, it can be enforced by using the `Content-Secu
Given the following response header, the policy declares that scripts may be loaded from one of two possible sources.
.Content Security Policy Report Only
====
[source]
----
Content-Security-Policy-Report-Only: script-src 'self' https://trustedscripts.example.com; report-uri /csp-report-endpoint/
----
====
If the site violates this policy, by attempting to load a script from _evil.com_, the user-agent will send a violation report to the declared URL specified by the _report-uri_ directive, but still allow the violating resource to load nevertheless.
@ -308,12 +294,10 @@ page the user was on.
Spring Security's approach is to use https://www.w3.org/TR/referrer-policy/[Referrer Policy] header, which provides different https://www.w3.org/TR/referrer-policy/#referrer-policies[policies]:
.Referrer Policy Example
====
[source]
----
Referrer-Policy: same-origin
----
====
The Referrer-Policy response header instructs the browser to let the destination knows the source where the user was previously.
@ -328,12 +312,10 @@ Refer to the relevant sections to see how to configure both xref:servlet/exploit
https://wicg.github.io/feature-policy/[Feature Policy] is a mechanism that allows web developers to selectively enable, disable, and modify the behavior of certain APIs and web features in the browser.
.Feature Policy Example
====
[source]
----
Feature-Policy: geolocation 'self'
----
====
With Feature Policy, developers can opt-in to a set of "policies" for the browser to enforce on specific features used throughout your site.
These policies restrict what APIs the site can access or modify the browser's default behavior for certain features.
@ -350,12 +332,10 @@ Refer to the relevant sections to see how to configure both xref:servlet/exploit
https://w3c.github.io/webappsec-permissions-policy/[Permissions Policy] is a mechanism that allows web developers to selectively enable, disable, and modify the behavior of certain APIs and web features in the browser.
.Permissions Policy Example
====
[source]
----
Permissions-Policy: geolocation=(self)
----
====
With Permissions Policy, developers can opt-in to a set of "policies" for the browser to enforce on specific features used throughout your site.
These policies restrict what APIs the site can access or modify the browser's default behavior for certain features.

66
docs/modules/ROOT/pages/features/integrations/concurrency.adoc
View File

@ -14,8 +14,10 @@ It wraps a delegate `Runnable` in order to initialize the `SecurityContextHolder
It then invokes the delegate Runnable ensuring to clear the `SecurityContextHolder` afterwards.
The `DelegatingSecurityContextRunnable` looks something like this:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public void run() {
@ -28,7 +30,8 @@ try {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
fun run() {
@ -40,7 +43,7 @@ fun run() {
}
}
----
====
======
While very simple, it makes it seamless to transfer the SecurityContext from one Thread to another.
This is important since, in most cases, the SecurityContextHolder acts on a per Thread basis.
@ -48,8 +51,10 @@ For example, you might have used Spring Security's xref:servlet/appendix/namespa
You can now easily transfer the `SecurityContext` of the current `Thread` to the `Thread` that invokes the secured service.
An example of how you might do this can be found below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Runnable originalRunnable = new Runnable() {
@ -65,7 +70,8 @@ DelegatingSecurityContextRunnable wrappedRunnable =
new Thread(wrappedRunnable).start();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val originalRunnable = Runnable {
@ -76,7 +82,7 @@ val wrappedRunnable = DelegatingSecurityContextRunnable(originalRunnable, contex
Thread(wrappedRunnable).start()
----
====
======
The code above performs the following steps:
@ -90,8 +96,10 @@ Since it is quite common to create a `DelegatingSecurityContextRunnable` with th
The following code is the same as the code above:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Runnable originalRunnable = new Runnable() {
@ -106,7 +114,8 @@ DelegatingSecurityContextRunnable wrappedRunnable =
new Thread(wrappedRunnable).start();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val originalRunnable = Runnable {
@ -117,7 +126,7 @@ val wrappedRunnable = DelegatingSecurityContextRunnable(originalRunnable)
Thread(wrappedRunnable).start()
----
====
======
The code we have is simple to use, but it still requires knowledge that we are using Spring Security.
In the next section we will take a look at how we can utilize `DelegatingSecurityContextExecutor` to hide the fact that we are using Spring Security.
@ -131,8 +140,10 @@ The design of `DelegatingSecurityContextExecutor` is very similar to that of `De
You can see an example of how it might be used below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
SecurityContext context = SecurityContextHolder.createEmptyContext();
@ -154,7 +165,8 @@ public void run() {
executor.execute(originalRunnable);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val context: SecurityContext = SecurityContextHolder.createEmptyContext()
@ -171,7 +183,7 @@ val originalRunnable = Runnable {
executor.execute(originalRunnable)
----
====
======
The code performs the following steps:
@ -185,8 +197,10 @@ In this instance, the same `SecurityContext` will be used for every Runnable sub
This is nice if we are running background tasks that need to be run by a user with elevated privileges.
* At this point you may be asking yourself "How does this shield my code of any knowledge of Spring Security?" Instead of creating the `SecurityContext` and the `DelegatingSecurityContextExecutor` in our own code, we can inject an already initialized instance of `DelegatingSecurityContextExecutor`.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Autowired
@ -202,7 +216,8 @@ executor.execute(originalRunnable);
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Autowired
@ -215,7 +230,7 @@ fun submitRunnable() {
executor.execute(originalRunnable)
}
----
====
======
Now our code is unaware that the `SecurityContext` is being propagated to the `Thread`, then the `originalRunnable` is run, and then the `SecurityContextHolder` is cleared out.
In this example, the same user is being used to run each thread.
@ -224,8 +239,10 @@ This can be done by removing the `SecurityContext` argument from our `Delegating
For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
SimpleAsyncTaskExecutor delegateExecutor = new SimpleAsyncTaskExecutor();
@ -233,13 +250,14 @@ DelegatingSecurityContextExecutor executor =
new DelegatingSecurityContextExecutor(delegateExecutor);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val delegateExecutor = SimpleAsyncTaskExecutor()
val executor = DelegatingSecurityContextExecutor(delegateExecutor)
----
====
======
Now anytime `executor.execute(Runnable)` is executed the `SecurityContext` is first obtained by the `SecurityContextHolder` and then that `SecurityContext` is used to create our `DelegatingSecurityContextRunnable`.
This means that we are running our `Runnable` with the same user that was used to invoke the `executor.execute(Runnable)` code.

110
docs/modules/ROOT/pages/features/integrations/cryptography.adoc
View File

@ -20,19 +20,22 @@ Encryptors are thread-safe.
Use the `Encryptors.stronger` factory method to construct a BytesEncryptor:
.BytesEncryptor
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Encryptors.stronger("password", "salt");
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
Encryptors.stronger("password", "salt")
----
====
======
The "stronger" encryption method creates an encryptor using 256 bit AES encryption with
Galois Counter Mode (GCM).
@ -46,19 +49,22 @@ The provided salt should be in hex-encoded String form, be random, and be at lea
Such a salt may be generated using a KeyGenerator:
.Generating a key
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
String salt = KeyGenerators.string().generateKey(); // generates a random 8-byte salt that is then hex-encoded
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val salt = KeyGenerators.string().generateKey() // generates a random 8-byte salt that is then hex-encoded
----
====
======
Users may also use the `standard` encryption method, which is 256-bit AES in Cipher Block Chaining (CBC) Mode.
This mode is not https://en.wikipedia.org/wiki/Authenticated_encryption[authenticated] and does not provide any
@ -70,19 +76,22 @@ For a more secure alternative, users should prefer `Encryptors.stronger`.
Use the Encryptors.text factory method to construct a standard TextEncryptor:
.TextEncryptor
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Encryptors.text("password", "salt");
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
Encryptors.text("password", "salt")
----
====
======
A TextEncryptor uses a standard BytesEncryptor to encrypt text data.
Encrypted results are returned as hex-encoded strings for easy storage on the filesystem or in the database.
@ -90,19 +99,22 @@ Encrypted results are returned as hex-encoded strings for easy storage on the fi
Use the Encryptors.queryableText factory method to construct a "queryable" TextEncryptor:
.Queryable TextEncryptor
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Encryptors.queryableText("password", "salt");
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
Encryptors.queryableText("password", "salt")
----
====
======
The difference between a queryable TextEncryptor and a standard TextEncryptor has to do with initialization vector (iv) handling.
The iv used in a queryable TextEncryptor#encrypt operation is shared, or constant, and is not randomly generated.
@ -121,74 +133,86 @@ KeyGenerators are thread-safe.
Use the KeyGenerators.secureRandom factory methods to generate a BytesKeyGenerator backed by a SecureRandom instance:
.BytesKeyGenerator
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
BytesKeyGenerator generator = KeyGenerators.secureRandom();
byte[] key = generator.generateKey();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val generator = KeyGenerators.secureRandom()
val key = generator.generateKey()
----
====
======
The default key length is 8 bytes.
There is also a KeyGenerators.secureRandom variant that provides control over the key length:
.KeyGenerators.secureRandom
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
KeyGenerators.secureRandom(16);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
KeyGenerators.secureRandom(16)
----
====
======
Use the KeyGenerators.shared factory method to construct a BytesKeyGenerator that always returns the same key on every invocation:
.KeyGenerators.shared
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
KeyGenerators.shared(16);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
KeyGenerators.shared(16)
----
====
======
=== StringKeyGenerator
Use the KeyGenerators.string factory method to construct a 8-byte, SecureRandom KeyGenerator that hex-encodes each key as a String:
.StringKeyGenerator
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
KeyGenerators.string();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
KeyGenerators.string()
----
====
======
[[spring-security-crypto-passwordencoders]]
== Password Encoding
@ -219,8 +243,10 @@ The default value is 10.
You can change this value in your deployed system without affecting existing passwords, as the value is also stored in the encoded hash.
.BCryptPasswordEncoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ -230,7 +256,8 @@ String result = encoder.encode("myPassword");
assertTrue(encoder.matches("myPassword", result));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@ -239,15 +266,17 @@ val encoder = BCryptPasswordEncoder(16)
val result: String = encoder.encode("myPassword")
assertTrue(encoder.matches("myPassword", result))
----
====
======
The `Pbkdf2PasswordEncoder` implementation uses PBKDF2 algorithm to hash the passwords.
In order to defeat password cracking PBKDF2 is a deliberately slow algorithm and should be tuned to take about .5 seconds to verify a password on your system.
.Pbkdf2PasswordEncoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Create an encoder with all the defaults
@ -256,7 +285,8 @@ String result = encoder.encode("myPassword");
assertTrue(encoder.matches("myPassword", result));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Create an encoder with all the defaults
@ -264,4 +294,4 @@ val encoder = Pbkdf2PasswordEncoder()
val result: String = encoder.encode("myPassword")
assertTrue(encoder.matches("myPassword", result))
----
====
======

22
docs/modules/ROOT/pages/features/integrations/data.adoc
View File

@ -10,8 +10,10 @@ It is not only useful but necessary to include the user in the queries to suppor
To use this support, add `org.springframework.security:spring-security-data` dependency and provide a bean of type `SecurityEvaluationContextExtension`.
In Java Configuration, this would look like:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -20,7 +22,8 @@ public SecurityEvaluationContextExtension securityEvaluationContextExtension() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -28,7 +31,7 @@ fun securityEvaluationContextExtension(): SecurityEvaluationContextExtension {
return SecurityEvaluationContextExtension()
}
----
====
======
In XML Configuration, this would look like:
@ -43,8 +46,10 @@ In XML Configuration, this would look like:
Now Spring Security can be used within your queries.
For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Repository
@ -54,7 +59,8 @@ public interface MessageRepository extends PagingAndSortingRepository<Message,Lo
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Repository
@ -63,7 +69,7 @@ interface MessageRepository : PagingAndSortingRepository<Message?, Long?> {
fun findInbox(pageable: Pageable?): Page<Message?>?
}
----
====
======
This checks to see if the `Authentication.getPrincipal().getId()` is equal to the recipient of the `Message`.
Note that this example assumes you have customized the principal to be an Object that has an id property.

11
docs/modules/ROOT/pages/features/integrations/jackson.adoc
View File

@ -6,8 +6,10 @@ This can improve the performance of serializing Spring Security related classes
To use it, register the `SecurityJackson2Modules.getModules(ClassLoader)` with `ObjectMapper` (https://github.com/FasterXML/jackson-databind[jackson-databind]):
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
ObjectMapper mapper = new ObjectMapper();
@ -21,7 +23,8 @@ SecurityContext context = new SecurityContextImpl();
String json = mapper.writeValueAsString(context);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val mapper = ObjectMapper()
@ -34,7 +37,7 @@ val context: SecurityContext = SecurityContextImpl()
// ...
val json: String = mapper.writeValueAsString(context)
----
====
======
[NOTE]
====

34
docs/modules/ROOT/pages/getting-spring-security.adoc
View File

@ -30,7 +30,6 @@ Alternatively, you can manually add the starter, as the following example shows:
.pom.xml
====
[source,xml,subs="verbatim,attributes"]
----
<dependencies>
@ -41,13 +40,11 @@ Alternatively, you can manually add the starter, as the following example shows:
</dependency>
</dependencies>
----
====
Since Spring Boot provides a Maven BOM to manage dependency versions, you do not need to specify a version.
If you wish to override the Spring Security version, you may do so by providing a Maven property, as the following example shows:
.pom.xml
====
[source,xml,subs="verbatim,attributes"]
----
<properties>
@ -55,14 +52,12 @@ If you wish to override the Spring Security version, you may do so by providing
<spring-security.version>{spring-security-version}</spring-security.version>
</properties>
----
====
Since Spring Security makes breaking changes only in major releases, it is safe to use a newer version of Spring Security with Spring Boot.
However, at times, you may need to update the version of Spring Framework as well.
You can do so by adding a Maven property, as the following example shows:
.pom.xml
====
[source,xml,subs="verbatim,attributes"]
----
<properties>
@ -70,7 +65,6 @@ You can do so by adding a Maven property, as the following example shows:
<spring.version>{spring-core-version}</spring.version>
</properties>
----
====
If you use additional features (such as LDAP, OpenID, and others), you need to also include the appropriate xref:modules.adoc#modules[Project Modules and Dependencies].
@ -80,7 +74,6 @@ If you use additional features (such as LDAP, OpenID, and others), you need to a
When you use Spring Security without Spring Boot, the preferred way is to use Spring Security's BOM to ensure a consistent version of Spring Security is used throughout the entire project. The following example shows how to do so:
.pom.xml
====
[source,xml,ubs="verbatim,attributes"]
----
<dependencyManagement>
@ -96,12 +89,10 @@ When you use Spring Security without Spring Boot, the preferred way is to use Sp
</dependencies>
</dependencyManagement>
----
====
A minimal Spring Security Maven set of dependencies typically looks like the following:
.pom.xml
====
[source,xml,subs="verbatim,attributes"]
----
<dependencies>
@ -116,7 +107,6 @@ A minimal Spring Security Maven set of dependencies typically looks like the fol
</dependency>
</dependencies>
----
====
If you use additional features (such as LDAP, OpenID, and others), you need to also include the appropriate xref:modules.adoc#modules[Project Modules and Dependencies].
@ -125,7 +115,6 @@ Many users are likely to run afoul of the fact that Spring Security's transitive
The easiest way to resolve this is to use the `spring-framework-bom` within the `<dependencyManagement>` section of your `pom.xml` as the following example shows:
.pom.xml
====
[source,xml,subs="verbatim,attributes"]
----
<dependencyManagement>
@ -141,7 +130,6 @@ The easiest way to resolve this is to use the `spring-framework-bom` within the
</dependencies>
</dependencyManagement>
----
====
The preceding example ensures that all the transitive dependencies of Spring Security use the Spring {spring-core-version} modules.
@ -155,7 +143,6 @@ All GA releases (that is, versions ending in .RELEASE) are deployed to Maven Cen
If you use a SNAPSHOT version, you need to ensure that you have the Spring Snapshot repository defined, as the following example shows:
.pom.xml
====
[source,xml]
----
<repositories>
@ -167,12 +154,10 @@ If you use a SNAPSHOT version, you need to ensure that you have the Spring Snaps
</repository>
</repositories>
----
====
If you use a milestone or release candidate version, you need to ensure that you have the Spring Milestone repository defined, as the following example shows:
.pom.xml
====
[source,xml]
----
<repositories>
@ -184,7 +169,6 @@ If you use a milestone or release candidate version, you need to ensure that you
</repository>
</repositories>
----
====
[[getting-gradle]]
== Gradle
@ -201,7 +185,6 @@ The simplest and preferred method to use the starter is to use https://docs.spri
Alternatively, you can manually add the starter, as the following example shows:
.build.gradle
====
[source,groovy]
[subs="verbatim,attributes"]
----
@ -209,32 +192,27 @@ dependencies {
compile "org.springframework.boot:spring-boot-starter-security"
}
----
====
Since Spring Boot provides a Maven BOM to manage dependency versions, you need not specify a version.
If you wish to override the Spring Security version, you may do so by providing a Gradle property, as the following example shows:
.build.gradle
====
[source,groovy]
[subs="verbatim,attributes"]
----
ext['spring-security.version']='{spring-security-version}'
----
====
Since Spring Security makes breaking changes only in major releases, it is safe to use a newer version of Spring Security with Spring Boot.
However, at times, you may need to update the version of Spring Framework as well.
You can do so by adding a Gradle property, as the following example shows:
.build.gradle
====
[source,groovy]
[subs="verbatim,attributes"]
----
ext['spring.version']='{spring-core-version}'
----
====
If you use additional features (such as LDAP, OpenID, and others), you need to also include the appropriate xref:modules.adoc#modules[Project Modules and Dependencies].
@ -244,7 +222,6 @@ When you use Spring Security without Spring Boot, the preferred way is to use Sp
You can do so by using the https://github.com/spring-gradle-plugins/dependency-management-plugin[Dependency Management Plugin], as the following example shows:
.build.gradle
====
[source,groovy]
[subs="verbatim,attributes"]
----
@ -258,12 +235,10 @@ dependencyManagement {
}
}
----
====
A minimal Spring Security Maven set of dependencies typically looks like the following:
.build.gradle
====
[source,groovy]
[subs="verbatim,attributes"]
----
@ -272,7 +247,6 @@ dependencies {
compile "org.springframework.security:spring-security-config"
}
----
====
If you use additional features (such as LDAP, OpenID, and others), you need to also include the appropriate xref:modules.adoc#modules[Project Modules and Dependencies].
@ -282,7 +256,6 @@ The easiest way to resolve this is to use the `spring-framework-bom` within your
You can do so by using the https://github.com/spring-gradle-plugins/dependency-management-plugin[Dependency Management Plugin], as the following example shows:
.build.gradle
====
[source,groovy]
[subs="verbatim,attributes"]
----
@ -296,7 +269,6 @@ dependencyManagement {
}
}
----
====
The preceding example ensures that all the transitive dependencies of Spring Security use the Spring {spring-core-version} modules.
@ -305,35 +277,29 @@ The preceding example ensures that all the transitive dependencies of Spring Sec
All GA releases (that is, versions ending in .RELEASE) are deployed to Maven Central, so using the mavenCentral() repository is sufficient for GA releases. The following example shows how to do so:
.build.gradle
====
[source,groovy]
----
repositories {
mavenCentral()
}
----
====
If you use a SNAPSHOT version, you need to ensure you have the Spring Snapshot repository defined, as the following example shows:
.build.gradle
====
[source,groovy]
----
repositories {
maven { url 'https://repo.spring.io/snapshot' }
}
----
====
If you use a milestone or release candidate version, you need to ensure that you have the Spring Milestone repository defined, as the following example shows:
.build.gradle
====
[source,groovy]
----
repositories {
maven { url 'https://repo.spring.io/milestone' }
}
----
====

9
docs/modules/ROOT/pages/reactive/authentication/logout.adoc
View File

@ -11,7 +11,10 @@ This will:
Often, you will want to also invalidate the session on logout.
To achieve this, you can add the `WebSessionServerLogoutHandler` to your logout configuration, like so:
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -28,7 +31,8 @@ SecurityWebFilterChain http(ServerHttpSecurity http) throws Exception {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -47,3 +51,4 @@ fun http(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
======

22
docs/modules/ROOT/pages/reactive/authentication/x509.adoc
View File

@ -4,8 +4,10 @@
Similar to xref:servlet/authentication/x509.adoc#servlet-x509[Servlet X.509 authentication], reactive x509 authentication filter allows extracting an authentication token from a certificate provided by a client.
Below is an example of a reactive x509 security configuration:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -19,7 +21,8 @@ public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -32,14 +35,16 @@ fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
In the configuration above, when neither `principalExtractor` nor `authenticationManager` is provided defaults will be used. The default principal extractor is `SubjectDnX509PrincipalExtractor` which extracts the CN (common name) field from a certificate provided by a client. The default authentication manager is `ReactivePreAuthenticatedAuthenticationManager` which performs user account validation, checking that user account with a name extracted by `principalExtractor` exists and it is not locked, disabled, or expired.
The next example demonstrates how these defaults can be overridden.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -66,7 +71,8 @@ public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -88,7 +94,7 @@ fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain? {
}
}
----
====
======
In this example, a username is extracted from the OU field of a client certificate instead of CN, and account lookup using `ReactiveUserDetailsService` is not performed at all. Instead, if the provided certificate issued to an OU named "Trusted Org Unit", a request will be authenticated.

22
docs/modules/ROOT/pages/reactive/authorization/authorize-http-requests.adoc
View File

@ -6,8 +6,10 @@ By default, Spring Security’s authorization will require all requests to be au
The explicit configuration looks like:
.All Requests Require Authenticated User
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -22,7 +24,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -36,14 +39,16 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
We can configure Spring Security to have different rules by adding more rules in order of precedence.
.Multiple Authorize Requests Rules
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import static org.springframework.security.authorization.AuthorityReactiveAuthorizationManager.hasRole;
@ -68,7 +73,8 @@ SecurityWebFilterChain springWebFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -88,7 +94,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
<1> There are multiple authorization rules specified.
Each rule is considered in the order they were declared.

63
docs/modules/ROOT/pages/reactive/authorization/method.adoc
View File

@ -10,8 +10,10 @@ For this to work the return type of the method must be a `org.reactivestreams.Pu
This is necessary to integrate with Reactor's `Context`.
====
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Authentication authentication = new TestingAuthenticationToken("user", "password", "ROLE_USER");
@ -28,7 +30,8 @@ StepVerifier.create(messageByUsername)
.verifyComplete();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val authentication: Authentication = TestingAuthenticationToken("user", "password", "ROLE_USER")
@ -43,12 +46,14 @@ StepVerifier.create(messageByUsername)
.expectNext("Hi user")
.verifyComplete()
----
====
======
with `this::findMessageByUsername` defined as:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Mono<String> findMessageByUsername(String username) {
@ -56,19 +61,22 @@ Mono<String> findMessageByUsername(String username) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
fun findMessageByUsername(username: String): Mono<String> {
return Mono.just("Hi $username")
}
----
====
======
Below is a minimal method security configuration when using method security in reactive applications.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableReactiveMethodSecurity
@ -89,7 +97,8 @@ public class SecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableReactiveMethodSecurity
@ -109,12 +118,14 @@ class SecurityConfig {
}
}
----
====
======
Consider the following class:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Component
@ -126,7 +137,8 @@ public class HelloWorldMessageService {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Component
@ -137,12 +149,14 @@ class HelloWorldMessageService {
}
}
----
====
======
Or, the following class using Kotlin coroutines:
====
.Kotlin
[tabs]
======
Kotlin::
+
[source,kotlin,role="primary"]
----
@Component
@ -154,7 +168,7 @@ class HelloWorldMessageService {
}
}
----
====
======
Combined with our configuration above, `@PreAuthorize("hasRole('ADMIN')")` will ensure that `findByMessage` is only invoked by a user with the role `ADMIN`.
@ -164,8 +178,10 @@ This means that the expression must not block.
When integrating with xref:reactive/configuration/webflux.adoc#jc-webflux[WebFlux Security], the Reactor Context is automatically established by Spring Security according to the authenticated user.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -201,7 +217,8 @@ public class SecurityConfig {
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -232,6 +249,6 @@ class SecurityConfig {
}
}
----
====
======
You can find a complete sample in {gh-samples-url}/reactive/webflux/java/method[hellowebflux-method]

33
docs/modules/ROOT/pages/reactive/configuration/webflux.adoc
View File

@ -14,8 +14,10 @@ You can find a few sample applications that demonstrate the code below:
You can find a minimal WebFlux Security configuration below:
.Minimal WebFlux Security Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
-----
@ -34,7 +36,8 @@ public class HelloWebfluxSecurityConfig {
}
-----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
-----
@EnableWebFluxSecurity
@ -51,7 +54,7 @@ class HelloWebfluxSecurityConfig {
}
}
-----
====
======
This configuration provides form and http basic authentication, sets up authorization to require an authenticated user for accessing any page, sets up a default log in page and a default log out page, sets up security related HTTP headers, CSRF protection, and more.
@ -60,8 +63,10 @@ This configuration provides form and http basic authentication, sets up authoriz
You can find an explicit version of the minimal WebFlux Security configuration below:
.Explicit WebFlux Security Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
-----
@Configuration
@ -91,7 +96,8 @@ public class HelloWebfluxSecurityConfig {
}
-----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
-----
import org.springframework.security.config.web.server.invoke
@ -122,7 +128,7 @@ class HelloWebfluxSecurityConfig {
}
}
-----
====
======
[NOTE]
Make sure that you import the `invoke` function in your Kotlin class, sometimes the IDE will not auto-import it causing compilation issues.
@ -139,8 +145,10 @@ You can configure multiple `SecurityWebFilterChain` instances to separate config
For example, you can isolate configuration for URLs that start with `/api`, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Configuration
@ -178,7 +186,8 @@ static class MultiSecurityHttpConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.security.config.web.server.invoke
@ -218,7 +227,7 @@ open class MultiSecurityHttpConfig {
}
}
----
====
======
<1> Configure a `SecurityWebFilterChain` with an `@Order` to specify which `SecurityWebFilterChain` Spring Security should consider first
<2> Use `PathPatternParserServerWebExchangeMatcher` to state that this `SecurityWebFilterChain` will only apply to URL paths that start with `/api/`

67
docs/modules/ROOT/pages/reactive/exploits/csrf.adoc
View File

@ -35,8 +35,10 @@ These defaults come from https://docs.angularjs.org/api/ng/service/$http#cross-s
You can configure `CookieServerCsrfTokenRepository` in Java Configuration using:
.Store CSRF Token in a Cookie
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
-----
@Bean
@ -48,7 +50,8 @@ public SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http)
}
-----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
-----
@Bean
@ -61,7 +64,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
-----
====
======
[NOTE]
====
@ -78,8 +81,10 @@ However, it is simple to disable CSRF protection if it xref:features/exploits/cs
The Java configuration below will disable CSRF protection.
.Disable CSRF Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -91,7 +96,8 @@ public SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http)
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
-----
@Bean
@ -104,7 +110,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
-----
====
======
[[webflux-csrf-include]]
=== Include the CSRF Token
@ -120,8 +126,10 @@ If your view technology does not provide a simple way to subscribe to the `Mono<
For example, the following code will place the `CsrfToken` on the default attribute name (`_csrf`) used by Spring Security's <<webflux-csrf-include-form-auto,CsrfRequestDataValueProcessor>> to automatically include the CSRF token as a hidden input.
.`CsrfToken` as `@ModelAttribute`
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ControllerAdvice
@ -135,7 +143,8 @@ public class SecurityControllerAdvice {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@ControllerAdvice
@ -149,7 +158,7 @@ class SecurityControllerAdvice {
}
}
----
====
======
Fortunately, Thymeleaf provides <<webflux-csrf-include-form-auto,integration>> that works without any additional work.
@ -159,14 +168,12 @@ In order to post an HTML form the CSRF token must be included in the form as a h
For example, the rendered HTML might look like:
.CSRF Token HTML
====
[source,html]
----
<input type="hidden"
name="_csrf"
value="4bfd1575-3ad1-4d21-96c7-4ef2d9f86721"/>
----
====
Next we will discuss various ways of including the CSRF token in a form as a hidden input.
@ -186,7 +193,6 @@ If the <<webflux-csrf-include,other options>> for including the actual CSRF toke
The Thymeleaf sample below assumes that you <<webflux-csrf-include-subscribe,expose>> the `CsrfToken` on an attribute named `_csrf`.
.CSRF Token in Form with Request Attribute
====
[source,html]
----
<form th:action="@{/logout}"
@ -198,7 +204,6 @@ The Thymeleaf sample below assumes that you <<webflux-csrf-include-subscribe,exp
th:value="${_csrf.token}"/>
</form>
----
====
[[webflux-csrf-include-ajax]]
==== Ajax and JSON Requests
@ -220,7 +225,6 @@ An alternative pattern to <<webflux-csrf-include-form-auto,exposing the CSRF in
The HTML might look something like this:
.CSRF meta tag HTML
====
[source,html]
----
<html>
@ -231,13 +235,11 @@ The HTML might look something like this:
</head>
<!-- ... -->
----
====
Once the meta tags contained the CSRF token, the JavaScript code would read the meta tags and include the CSRF token as a header.
If you were using jQuery, this could be done with the following:
.AJAX send CSRF Token
====
[source,javascript]
----
$(function () {
@ -248,13 +250,11 @@ $(function () {
});
});
----
====
The sample below assumes that you <<webflux-csrf-include-subscribe,expose>> the `CsrfToken` on an attribute named `_csrf`.
An example of doing this with Thymeleaf is shown below:
.CSRF meta tag JSP
====
[source,html]
----
<html>
@ -266,7 +266,6 @@ An example of doing this with Thymeleaf is shown below:
</head>
<!-- ... -->
----
====
[[webflux-csrf-considerations]]
== CSRF Considerations
@ -298,8 +297,10 @@ For example, the following Java Configuration will perform logout with the URL `
// FIXME: This should be a link to log out documentation
.Log out with HTTP GET
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -311,7 +312,8 @@ public SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http)
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -324,7 +326,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
[[webflux-considerations-csrf-timeouts]]
@ -360,8 +362,10 @@ We have xref:features/exploits/csrf.adoc#csrf-considerations-multipart[already d
In a WebFlux application, this can be configured with the following configuration:
.Enable obtaining CSRF token from multipart/form-data
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -373,7 +377,8 @@ public SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http)
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -386,7 +391,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
[[webflux-csrf-considerations-multipart-url]]
==== Include CSRF Token in URL
@ -396,14 +401,12 @@ Since the `CsrfToken` is exposed as an `ServerHttpRequest` <<webflux-csrf-includ
An example with Thymeleaf is shown below:
.CSRF Token in Action
====
[source,html]
----
<form method="post"
th:action="@{/upload(${_csrf.parameterName}=${_csrf.token})}"
enctype="multipart/form-data">
----
====
[[webflux-csrf-considerations-override-method]]
=== HiddenHttpMethodFilter

163
docs/modules/ROOT/pages/reactive/exploits/headers.adoc
View File

@ -16,8 +16,10 @@ For example, assume that you want the defaults except you wish to specify `SAMEO
You can easily do this with the following Configuration:
.Customize Default Security Headers
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -33,7 +35,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -48,14 +51,16 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
If you do not want the defaults to be added and want explicit control over what should be used, you can disable the defaults.
An example is provided below:
.Disable HTTP Security Response Headers
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -67,7 +72,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -80,7 +86,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-cache-control]]
== Cache Control
@ -96,8 +102,10 @@ Details on how to do this can be found in the https://docs.spring.io/spring/docs
If necessary, you can also disable Spring Security's cache control HTTP response headers.
.Cache Control Disabled
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -111,7 +119,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -126,7 +135,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-content-type-options]]
@ -135,8 +144,10 @@ Spring Security includes xref:features/exploits/headers.adoc#headers-content-typ
However, you can disable it with:
.Content Type Options Disabled
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -150,7 +161,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -165,7 +177,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-hsts]]
== HTTP Strict Transport Security (HSTS)
@ -174,8 +186,10 @@ However, you can customize the results explicitly.
For example, the following is an example of explicitly providing HSTS:
.Strict Transport Security
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -193,7 +207,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -210,7 +225,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-frame-options]]
== X-Frame-Options
@ -219,8 +234,10 @@ By default, Spring Security disables rendering within an iframe using xref:featu
You can customize frame options to use the same origin using the following:
.X-Frame-Options: SAMEORIGIN
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -236,7 +253,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -251,7 +269,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-xss-protection]]
== X-XSS-Protection
@ -259,8 +277,10 @@ By default, Spring Security instructs browsers to block reflected XSS attacks us
You can disable `X-XSS-Protection` with the following Configuration:
.X-XSS-Protection Customization
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -274,7 +294,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -289,7 +310,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-csp]]
== Content Security Policy (CSP)
@ -299,18 +320,18 @@ The web application author must declare the security policy(s) to enforce and/or
For example, given the following security policy:
.Content Security Policy Example
====
[source,http]
----
Content-Security-Policy: script-src 'self' https://trustedscripts.example.com; object-src https://trustedplugins.example.com; report-uri /csp-report-endpoint/
----
====
You can enable the CSP header as shown below:
.Content Security Policy
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -326,7 +347,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -341,13 +363,15 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
To enable the CSP `report-only` header, provide the following configuration:
.Content Security Policy Report Only
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -364,7 +388,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -380,7 +405,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-referrer]]
== Referrer Policy
@ -389,8 +414,10 @@ Spring Security does not add xref:features/exploits/headers.adoc#headers-referre
You can enable the Referrer Policy header using configuration as shown below:
.Referrer Policy Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -406,7 +433,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -421,7 +449,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-feature]]
@ -431,18 +459,18 @@ Spring Security does not add xref:features/exploits/headers.adoc#headers-feature
The following `Feature-Policy` header:
.Feature-Policy Example
====
[source]
----
Feature-Policy: geolocation 'self'
----
====
You can enable the Feature Policy header as shown below:
.Feature-Policy Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -456,7 +484,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -469,7 +498,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-permissions]]
@ -479,18 +508,18 @@ Spring Security does not add xref:features/exploits/headers.adoc#headers-permiss
The following `Permissions-Policy` header:
.Permissions-Policy Example
====
[source]
----
Permissions-Policy: geolocation=(self)
----
====
You can enable the Permissions Policy header as shown below:
.Permissions-Policy Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -506,7 +535,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -521,7 +551,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-clear-site-data]]
@ -531,17 +561,17 @@ Spring Security does not add xref:features/exploits/headers.adoc#headers-clear-s
The following Clear-Site-Data header:
.Clear-Site-Data Example
====
----
Clear-Site-Data: "cache", "cookies"
----
====
can be sent on log out with the following configuration:
.Clear-Site-Data Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -559,7 +589,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -577,7 +608,7 @@ fun webFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
}
}
----
====
======
[[webflux-headers-cross-origin-policies]]
== Cross-Origin Policies
@ -595,8 +626,10 @@ Spring Security does not add <<headers-cross-origin-policies,Cross-Origin Polici
The headers can be added with the following configuration:
.Cross-Origin Policies
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -613,7 +646,9 @@ public class WebSecurityConfig {
}
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -631,7 +666,7 @@ open class CrossOriginPoliciesCustomConfig {
}
}
----
====
======
This configuration will write the headers with the values provided:
[source]

22
docs/modules/ROOT/pages/reactive/exploits/http.adoc
View File

@ -13,8 +13,10 @@ If a client makes a request using HTTP rather than HTTPS, Spring Security can be
For example, the following Java configuration will redirect any HTTP requests to HTTPS:
.Redirect to HTTPS
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -26,7 +28,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -37,15 +40,17 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
The configuration can easily be wrapped around an if statement to only be turned on in production.
Alternatively, it can be enabled by looking for a property about the request that only happens in production.
For example, if the production environment adds a header named `X-Forwarded-Proto` the following Java Configuration could be used:
.Redirect to HTTPS when X-Forwarded
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -59,7 +64,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -74,7 +80,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
[[webflux-hsts]]
== Strict Transport Security

24
docs/modules/ROOT/pages/reactive/getting-started.adoc
View File

@ -14,8 +14,10 @@ For your convenience, you can download a minimal Reactive Spring Boot + Spring S
You can add Spring Security to your Spring Boot project by adding `spring-boot-starter-security`.
====
.Maven
[tabs]
======
Maven::
+
[source,xml,role="primary"]
----
<dependency>
@ -24,12 +26,13 @@ You can add Spring Security to your Spring Boot project by adding `spring-boot-s
</dependency>
----
.Gradle
Gradle::
+
[source,groovy,role="secondary"]
----
implementation 'org.springframework.boot:spring-boot-starter-security'
----
====
======
[[servlet-hello-starting]]
@ -38,10 +41,12 @@ You can add Spring Security to your Spring Boot project by adding `spring-boot-s
You can now https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-running-with-the-maven-plugin[run the Spring Boot application] by using the Maven Plugin's `run` goal.
The following example shows how to do so (and the beginning of the output from doing so):
.Running Spring Boot Application
====
.Maven
.Running Spring Boot Application
[tabs]
======
Maven::
+
[source,bash,role="primary"]
----
$ ./mvnw spring-boot:run
@ -53,7 +58,8 @@ Using generated security password: 8e557245-73e2-4286-969a-ff57fe326336
...
----
.Gradle
Gradle::
+
[source,bash,role="secondary"]
----
$ ./gradlew bootRun
@ -64,7 +70,7 @@ Using generated security password: 8e557245-73e2-4286-969a-ff57fe326336
...
----
====
======
[[authenticating]]
== Authenticating

22
docs/modules/ROOT/pages/reactive/integrations/cors.adoc
View File

@ -10,8 +10,10 @@ The easiest way to ensure that CORS is handled first is to use the `CorsWebFilte
Users can integrate the `CorsWebFilter` with Spring Security by providing a `CorsConfigurationSource`.
For example, the following will integrate CORS support within Spring Security:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -25,7 +27,8 @@ CorsConfigurationSource corsConfigurationSource() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -38,12 +41,14 @@ fun corsConfigurationSource(): CorsConfigurationSource {
return source
}
----
====
======
The following will disable the CORS integration within Spring Security:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -55,7 +60,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -68,4 +74,4 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======

122
docs/modules/ROOT/pages/reactive/integrations/rsocket.adoc
View File

@ -14,8 +14,10 @@ You can find a few sample applications that demonstrate the code below:
You can find a minimal RSocket Security configuration below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
-----
@Configuration
@ -34,7 +36,8 @@ public class HelloRSocketSecurityConfig {
}
-----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Configuration
@ -51,7 +54,7 @@ open class HelloRSocketSecurityConfig {
}
}
----
====
======
This configuration enables <<rsocket-authentication-simple,simple authentication>> and sets up <<rsocket-authorization,rsocket-authorization>> to require an authenticated user for any request.
@ -61,8 +64,10 @@ For Spring Security to work we need to apply `SecuritySocketAcceptorInterceptor`
This is what connects our `PayloadSocketAcceptorInterceptor` we created with the RSocket infrastructure.
In a Spring Boot application this is done automatically using `RSocketSecurityAutoConfiguration` with the following code.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -71,7 +76,8 @@ RSocketServerCustomizer springSecurityRSocketSecurity(SecuritySocketAcceptorInte
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -83,7 +89,7 @@ fun springSecurityRSocketSecurity(interceptor: SecuritySocketAcceptorInterceptor
}
}
----
====
======
[[rsocket-authentication]]
== RSocket Authentication
@ -123,8 +129,10 @@ See `RSocketSecurity.basicAuthentication(Customizer)` for setting it up.
The RSocket receiver can decode the credentials using `AuthenticationPayloadExchangeConverter` which is automatically setup using the `simpleAuthentication` portion of the DSL.
An explicit configuration can be found below.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -140,7 +148,8 @@ PayloadSocketAcceptorInterceptor rsocketInterceptor(RSocketSecurity rsocket) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -154,30 +163,35 @@ open fun rsocketInterceptor(rsocket: RSocketSecurity): PayloadSocketAcceptorInte
return rsocket.build()
}
----
====
======
The RSocket sender can send credentials using `SimpleAuthenticationEncoder` which can be added to Spring's `RSocketStrategies`.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
RSocketStrategies.Builder strategies = ...;
strategies.encoder(new SimpleAuthenticationEncoder());
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
var strategies: RSocketStrategies.Builder = ...
strategies.encoder(SimpleAuthenticationEncoder())
----
====
======
It can then be used to send a username and password to the receiver in the setup:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
MimeType authenticationMimeType =
@ -189,7 +203,8 @@ Mono<RSocketRequester> requester = RSocketRequester.builder()
.connectTcp(host, port);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val authenticationMimeType: MimeType =
@ -200,12 +215,14 @@ val requester: Mono<RSocketRequester> = RSocketRequester.builder()
.rsocketStrategies(strategies.build())
.connectTcp(host, port)
----
====
======
Alternatively or additionally, a username and password can be sent in a request.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Mono<RSocketRequester> requester;
@ -220,7 +237,8 @@ public Mono<AirportLocation> findRadar(String code) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.messaging.rsocket.retrieveMono
@ -238,7 +256,7 @@ open fun findRadar(code: String): Mono<AirportLocation> {
}
}
----
====
======
[[rsocket-authentication-jwt]]
=== JWT
@ -249,8 +267,10 @@ The support comes in the form of authenticating a JWT (determining the JWT is va
The RSocket receiver can decode the credentials using `BearerPayloadExchangeConverter` which is automatically setup using the `jwt` portion of the DSL.
An example configuration can be found below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -266,7 +286,8 @@ PayloadSocketAcceptorInterceptor rsocketInterceptor(RSocketSecurity rsocket) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -280,13 +301,15 @@ fun rsocketInterceptor(rsocket: RSocketSecurity): PayloadSocketAcceptorIntercept
return rsocket.build()
}
----
====
======
The configuration above relies on the existence of a `ReactiveJwtDecoder` `@Bean` being present.
An example of creating one from the issuer can be found below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -296,7 +319,8 @@ ReactiveJwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -305,13 +329,15 @@ fun jwtDecoder(): ReactiveJwtDecoder {
.fromIssuerLocation("https://example.com/auth/realms/demo")
}
----
====
======
The RSocket sender does not need to do anything special to send the token because the value is just a simple String.
For example, the token can be sent at setup time:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
MimeType authenticationMimeType =
@ -322,7 +348,8 @@ Mono<RSocketRequester> requester = RSocketRequester.builder()
.connectTcp(host, port);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val authenticationMimeType: MimeType =
@ -333,12 +360,14 @@ val requester = RSocketRequester.builder()
.setupMetadata(token, authenticationMimeType)
.connectTcp(host, port)
----
====
======
Alternatively or additionally, the token can be sent in a request.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
MimeType authenticationMimeType =
@ -355,7 +384,8 @@ public Mono<AirportLocation> findRadar(String code) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val authenticationMimeType: MimeType =
@ -371,7 +401,7 @@ open fun findRadar(code: String): Mono<AirportLocation> {
}
}
----
====
======
[[rsocket-authorization]]
== RSocket Authorization
@ -380,8 +410,10 @@ RSocket authorization is performed with `AuthorizationPayloadInterceptor` which
The DSL can be used to setup authorization rules based upon the `PayloadExchange`.
An example configuration can be found below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
rsocket
@ -397,7 +429,9 @@ rsocket
.anyExchange().permitAll() // <6>
);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
rsocket
@ -413,7 +447,7 @@ rsocket
.anyExchange().permitAll()
} // <6>
----
====
======
<1> Setting up a connection requires the authority `ROLE_SETUP`
<2> If the route is `fetch.profile.me` authorization only requires the user be authenticated
<3> In this rule we setup a custom matcher where authorization requires the user to have the authority `ROLE_CUSTOM`

155
docs/modules/ROOT/pages/reactive/oauth2/client/authorization-grants.adoc
View File

@ -111,8 +111,10 @@ OPTIONAL. Space delimited, case sensitive list of ASCII string values that speci
The following example shows how to configure the `DefaultServerOAuth2AuthorizationRequestResolver` with a `Consumer<OAuth2AuthorizationRequest.Builder>` that customizes the Authorization Request for `oauth2Login()`, by including the request parameter `prompt=consent`.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -154,7 +156,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -192,7 +195,7 @@ class SecurityConfig {
}
}
----
====
======
For the simple use case, where the additional request parameter is always the same for a specific provider, it may be added directly in the `authorization-uri` property.
@ -217,8 +220,10 @@ Alternatively, if your requirements are more advanced, you can take full control
The following example shows a variation of `authorizationRequestCustomizer()` from the preceding example, and instead overrides the `OAuth2AuthorizationRequest.authorizationRequestUri` property.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
private Consumer<OAuth2AuthorizationRequest.Builder> authorizationRequestCustomizer() {
@ -228,7 +233,8 @@ private Consumer<OAuth2AuthorizationRequest.Builder> authorizationRequestCustomi
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
private fun authorizationRequestCustomizer(): Consumer<OAuth2AuthorizationRequest.Builder> {
@ -241,7 +247,7 @@ private fun authorizationRequestCustomizer(): Consumer<OAuth2AuthorizationReques
}
}
----
====
======
=== Storing the Authorization Request
@ -256,8 +262,10 @@ The default implementation of `ServerAuthorizationRequestRepository` is `WebSess
If you have a custom implementation of `ServerAuthorizationRequestRepository`, you may configure it as shown in the following example:
.ServerAuthorizationRequestRepository Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -275,7 +283,8 @@ public class OAuth2ClientSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -291,7 +300,7 @@ class OAuth2ClientSecurityConfig {
}
}
----
====
======
=== Requesting an Access Token
@ -327,8 +336,10 @@ Alternatively, if your requirements are more advanced, you can take full control
Whether you customize `WebClientReactiveAuthorizationCodeTokenResponseClient` or provide your own implementation of `ReactiveOAuth2AccessTokenResponseClient`, you’ll need to configure it as shown in the following example:
.Access Token Response Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -354,7 +365,8 @@ public class OAuth2ClientSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -377,7 +389,7 @@ class OAuth2ClientSecurityConfig {
}
}
----
====
======
[[oauth2Client-refresh-token-grant]]
@ -421,8 +433,10 @@ Alternatively, if your requirements are more advanced, you can take full control
Whether you customize `WebClientReactiveRefreshTokenTokenResponseClient` or provide your own implementation of `ReactiveOAuth2AccessTokenResponseClient`, you’ll need to configure it as shown in the following example:
.Access Token Response Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Customize
@ -439,7 +453,8 @@ ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider =
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Customize
@ -454,7 +469,7 @@ val authorizedClientProvider: ReactiveOAuth2AuthorizedClientProvider = ReactiveO
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
----
====
======
[NOTE]
`ReactiveOAuth2AuthorizedClientProviderBuilder.builder().refreshToken()` configures a `RefreshTokenReactiveOAuth2AuthorizedClientProvider`,
@ -504,8 +519,10 @@ Alternatively, if your requirements are more advanced, you can take full control
Whether you customize `WebClientReactiveClientCredentialsTokenResponseClient` or provide your own implementation of `ReactiveOAuth2AccessTokenResponseClient`, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Customize
@ -521,7 +538,8 @@ ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider =
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Customize
@ -535,7 +553,7 @@ val authorizedClientProvider: ReactiveOAuth2AuthorizedClientProvider = ReactiveO
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
----
====
======
[NOTE]
`ReactiveOAuth2AuthorizedClientProviderBuilder.builder().clientCredentials()` configures a `ClientCredentialsReactiveOAuth2AuthorizedClientProvider`,
@ -564,8 +582,10 @@ spring:
...and the `ReactiveOAuth2AuthorizedClientManager` `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -587,7 +607,8 @@ public ReactiveOAuth2AuthorizedClientManager authorizedClientManager(
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -603,12 +624,14 @@ fun authorizedClientManager(
return authorizedClientManager
}
----
====
======
You may obtain the `OAuth2AccessToken` as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -632,7 +655,8 @@ public class OAuth2ClientController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class OAuth2ClientController {
@ -654,7 +678,7 @@ class OAuth2ClientController {
}
}
----
====
======
[NOTE]
`ServerWebExchange` is an OPTIONAL attribute.
@ -701,8 +725,10 @@ Alternatively, if your requirements are more advanced, you can take full control
Whether you customize `WebClientReactivePasswordTokenResponseClient` or provide your own implementation of `ReactiveOAuth2AccessTokenResponseClient`, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Customize
@ -719,7 +745,8 @@ ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider =
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val passwordTokenResponseClient: ReactiveOAuth2AccessTokenResponseClient<OAuth2PasswordGrantRequest> = ...
@ -733,7 +760,7 @@ val authorizedClientProvider = ReactiveOAuth2AuthorizedClientProviderBuilder.bui
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
----
====
======
[NOTE]
`ReactiveOAuth2AuthorizedClientProviderBuilder.builder().password()` configures a `PasswordReactiveOAuth2AuthorizedClientProvider`,
@ -762,8 +789,10 @@ spring:
...and the `ReactiveOAuth2AuthorizedClientManager` `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -807,7 +836,9 @@ private Function<OAuth2AuthorizeRequest, Mono<Map<String, Object>>> contextAttri
};
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -846,12 +877,14 @@ private fun contextAttributesMapper(): Function<OAuth2AuthorizeRequest, Mono<Mut
}
}
----
====
======
You may obtain the `OAuth2AccessToken` as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -875,7 +908,8 @@ public class OAuth2ClientController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Controller
@ -897,7 +931,7 @@ class OAuth2ClientController {
}
}
----
====
======
[NOTE]
`ServerWebExchange` is an OPTIONAL attribute.
@ -943,8 +977,10 @@ Alternatively, if your requirements are more advanced, you can take full control
Whether you customize `WebClientReactiveJwtBearerTokenResponseClient` or provide your own implementation of `ReactiveOAuth2AccessTokenResponseClient`, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Customize
@ -963,7 +999,8 @@ ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider =
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Customize
@ -980,7 +1017,7 @@ val authorizedClientProvider = ReactiveOAuth2AuthorizedClientProviderBuilder.bui
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
----
====
======
=== Using the Access Token
@ -1005,8 +1042,10 @@ spring:
...and the `OAuth2AuthorizedClientManager` `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -1031,7 +1070,8 @@ public ReactiveOAuth2AuthorizedClientManager authorizedClientManager(
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -1048,12 +1088,14 @@ fun authorizedClientManager(
return authorizedClientManager
}
----
====
======
You may obtain the `OAuth2AccessToken` as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@RestController
@ -1075,7 +1117,8 @@ public class OAuth2ResourceServerController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class OAuth2ResourceServerController {
@ -1094,7 +1137,7 @@ class OAuth2ResourceServerController {
}
}
----
====
======
[NOTE]
`JwtBearerReactiveOAuth2AuthorizedClientProvider` resolves the `Jwt` assertion via `OAuth2AuthorizationContext.getPrincipal().getPrincipal()` by default, hence the use of `JwtAuthenticationToken` in the preceding example.

66
docs/modules/ROOT/pages/reactive/oauth2/client/authorized-clients.adoc
View File

@ -8,8 +8,10 @@
The `@RegisteredOAuth2AuthorizedClient` annotation provides the capability of resolving a method parameter to an argument value of type `OAuth2AuthorizedClient`.
This is a convenient alternative compared to accessing the `OAuth2AuthorizedClient` using the `ReactiveOAuth2AuthorizedClientManager` or `ReactiveOAuth2AuthorizedClientService`.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -24,7 +26,8 @@ public class OAuth2ClientController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Controller
@ -37,7 +40,7 @@ class OAuth2ClientController {
}
}
----
====
======
The `@RegisteredOAuth2AuthorizedClient` annotation is handled by `OAuth2AuthorizedClientArgumentResolver`, which directly uses a <<oauth2Client-authorized-manager-provider, ReactiveOAuth2AuthorizedClientManager>> and therefore inherits it's capabilities.
@ -58,8 +61,10 @@ It directly uses an <<oauth2Client-authorized-manager-provider, ReactiveOAuth2Au
The following code shows an example of how to configure `WebClient` with OAuth 2.0 Client support:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -72,7 +77,8 @@ WebClient webClient(ReactiveOAuth2AuthorizedClientManager authorizedClientManage
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -83,7 +89,7 @@ fun webClient(authorizedClientManager: ReactiveOAuth2AuthorizedClientManager): W
.build()
}
----
====
======
=== Providing the Authorized Client
@ -91,8 +97,10 @@ The `ServerOAuth2AuthorizedClientExchangeFilterFunction` determines the client t
The following code shows how to set an `OAuth2AuthorizedClient` as a request attribute:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@GetMapping("/")
@ -110,7 +118,8 @@ public Mono<String> index(@RegisteredOAuth2AuthorizedClient("okta") OAuth2Author
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@GetMapping("/")
@ -127,14 +136,16 @@ fun index(@RegisteredOAuth2AuthorizedClient("okta") authorizedClient: OAuth2Auth
.thenReturn("index")
}
----
====
======
<1> `oauth2AuthorizedClient()` is a `static` method in `ServerOAuth2AuthorizedClientExchangeFilterFunction`.
The following code shows how to set the `ClientRegistration.getRegistrationId()` as a request attribute:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@GetMapping("/")
@ -152,7 +163,8 @@ public Mono<String> index() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@GetMapping("/")
@ -169,7 +181,7 @@ fun index(): Mono<String> {
.thenReturn("index")
}
----
====
======
<1> `clientRegistrationId()` is a `static` method in `ServerOAuth2AuthorizedClientExchangeFilterFunction`.
@ -181,8 +193,10 @@ If `setDefaultOAuth2AuthorizedClient(true)` is configured and the user has authe
The following code shows the specific configuration:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -196,7 +210,8 @@ WebClient webClient(ReactiveOAuth2AuthorizedClientManager authorizedClientManage
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -208,7 +223,7 @@ fun webClient(authorizedClientManager: ReactiveOAuth2AuthorizedClientManager): W
.build()
}
----
====
======
[WARNING]
It is recommended to be cautious with this feature since all HTTP requests will receive the access token.
@ -217,8 +232,10 @@ Alternatively, if `setDefaultClientRegistrationId("okta")` is configured with a
The following code shows the specific configuration:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -232,7 +249,8 @@ WebClient webClient(ReactiveOAuth2AuthorizedClientManager authorizedClientManage
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -244,7 +262,7 @@ fun webClient(authorizedClientManager: ReactiveOAuth2AuthorizedClientManager): W
.build()
}
----
====
======
[WARNING]
It is recommended to be cautious with this feature since all HTTP requests will receive the access token.

33
docs/modules/ROOT/pages/reactive/oauth2/client/client-authentication.adoc
View File

@ -36,8 +36,10 @@ spring:
The following example shows how to configure `WebClientReactiveAuthorizationCodeTokenResponseClient`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Function<ClientRegistration, JWK> jwkResolver = (clientRegistration) -> {
@ -59,7 +61,8 @@ tokenResponseClient.addParametersConverter(
new NimbusJwtClientAuthenticationParametersConverter<>(jwkResolver));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val jwkResolver: Function<ClientRegistration, JWK> =
@ -81,7 +84,7 @@ tokenResponseClient.addParametersConverter(
NimbusJwtClientAuthenticationParametersConverter(jwkResolver)
)
----
====
======
=== Authenticate using `client_secret_jwt`
@ -105,8 +108,10 @@ spring:
The following example shows how to configure `WebClientReactiveClientCredentialsTokenResponseClient`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Function<ClientRegistration, JWK> jwkResolver = (clientRegistration) -> {
@ -127,7 +132,8 @@ tokenResponseClient.addParametersConverter(
new NimbusJwtClientAuthenticationParametersConverter<>(jwkResolver));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val jwkResolver = Function<ClientRegistration, JWK?> { clientRegistration: ClientRegistration ->
@ -148,14 +154,16 @@ tokenResponseClient.addParametersConverter(
NimbusJwtClientAuthenticationParametersConverter(jwkResolver)
)
----
====
======
=== Customizing the JWT assertion
The JWT produced by `NimbusJwtClientAuthenticationParametersConverter` contains the `iss`, `sub`, `aud`, `jti`, `iat` and `exp` claims by default. You can customize the headers and/or claims by providing a `Consumer<NimbusJwtClientAuthenticationParametersConverter.JwtClientAuthenticationContext<T>>` to `setJwtClientAssertionCustomizer()`. The following example shows how to customize claims of the JWT:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Function<ClientRegistration, JWK> jwkResolver = ...
@ -168,7 +176,8 @@ converter.setJwtClientAssertionCustomizer((context) -> {
});
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val jwkResolver = ...
@ -180,4 +189,4 @@ converter.setJwtClientAssertionCustomizer { context ->
context.claims.claim("custom-claim", "claim-value")
}
----
====
======

66
docs/modules/ROOT/pages/reactive/oauth2/client/core.adoc
View File

@ -69,20 +69,23 @@ A `ClientRegistration` can be initially configured using discovery of an OpenID
`ClientRegistrations` provides convenience methods for configuring a `ClientRegistration` in this way, as can be seen in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
ClientRegistration clientRegistration =
ClientRegistrations.fromIssuerLocation("https://idp.example.com/issuer").build();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val clientRegistration = ClientRegistrations.fromIssuerLocation("https://idp.example.com/issuer").build()
----
====
======
The above code will query in series `https://idp.example.com/issuer/.well-known/openid-configuration`, and then `https://idp.example.com/.well-known/openid-configuration/issuer`, and finally `https://idp.example.com/.well-known/oauth-authorization-server/issuer`, stopping at the first to return a 200 response.
@ -106,8 +109,10 @@ The auto-configuration also registers the `ReactiveClientRegistrationRepository`
The following listing shows an example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -125,7 +130,8 @@ public class OAuth2ClientController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Controller
@ -142,7 +148,7 @@ class OAuth2ClientController {
}
}
----
====
======
[[oauth2Client-authorized-client]]
== OAuth2AuthorizedClient
@ -163,8 +169,10 @@ From a developer perspective, the `ServerOAuth2AuthorizedClientRepository` or `R
The following listing shows an example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -183,7 +191,8 @@ public class OAuth2ClientController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Controller
@ -201,7 +210,7 @@ class OAuth2ClientController {
}
}
----
====
======
[NOTE]
Spring Boot 2.x auto-configuration registers an `ServerOAuth2AuthorizedClientRepository` and/or `ReactiveOAuth2AuthorizedClientService` `@Bean` in the `ApplicationContext`.
@ -235,8 +244,10 @@ The `ReactiveOAuth2AuthorizedClientProviderBuilder` may be used to configure and
The following code shows an example of how to configure and build a `ReactiveOAuth2AuthorizedClientProvider` composite that provides support for the `authorization_code`, `refresh_token`, `client_credentials` and `password` authorization grant types:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -261,7 +272,8 @@ public ReactiveOAuth2AuthorizedClientManager authorizedClientManager(
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -280,7 +292,7 @@ fun authorizedClientManager(
return authorizedClientManager
}
----
====
======
When an authorization attempt succeeds, the `DefaultReactiveOAuth2AuthorizedClientManager` will delegate to the `ReactiveOAuth2AuthorizationSuccessHandler`, which (by default) will save the `OAuth2AuthorizedClient` via the `ServerOAuth2AuthorizedClientRepository`.
In the case of a re-authorization failure, eg. a refresh token is no longer valid, the previously saved `OAuth2AuthorizedClient` will be removed from the `ServerOAuth2AuthorizedClientRepository` via the `RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler`.
@ -291,8 +303,10 @@ This can be useful when you need to supply a `ReactiveOAuth2AuthorizedClientProv
The following code shows an example of the `contextAttributesMapper`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -337,7 +351,8 @@ private Function<OAuth2AuthorizeRequest, Mono<Map<String, Object>>> contextAttri
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -376,7 +391,7 @@ private fun contextAttributesMapper(): Function<OAuth2AuthorizeRequest, Mono<Mut
}
}
----
====
======
The `DefaultReactiveOAuth2AuthorizedClientManager` is designed to be used *_within_* the context of a `ServerWebExchange`.
When operating *_outside_* of a `ServerWebExchange` context, use `AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager` instead.
@ -387,8 +402,10 @@ An OAuth 2.0 Client configured with the `client_credentials` grant type can be c
The following code shows an example of how to configure an `AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager` that provides support for the `client_credentials` grant type:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -410,7 +427,8 @@ public ReactiveOAuth2AuthorizedClientManager authorizedClientManager(
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -426,4 +444,4 @@ fun authorizedClientManager(
return authorizedClientManager
}
----
====
======

22
docs/modules/ROOT/pages/reactive/oauth2/client/index.adoc
View File

@ -24,8 +24,10 @@ The `ServerHttpSecurity.oauth2Client()` DSL provides a number of configuration o
The following code shows the complete configuration options provided by the `ServerHttpSecurity.oauth2Client()` DSL:
.OAuth2 Client Configuration Options
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -47,7 +49,8 @@ public class OAuth2ClientSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -67,14 +70,16 @@ class OAuth2ClientSecurityConfig {
}
}
----
====
======
The `ReactiveOAuth2AuthorizedClientManager` is responsible for managing the authorization (or re-authorization) of an OAuth 2.0 Client, in collaboration with one or more `ReactiveOAuth2AuthorizedClientProvider`(s).
The following code shows an example of how to register a `ReactiveOAuth2AuthorizedClientManager` `@Bean` and associate it with a `ReactiveOAuth2AuthorizedClientProvider` composite that provides support for the `authorization_code`, `refresh_token`, `client_credentials` and `password` authorization grant types:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -99,7 +104,8 @@ public ReactiveOAuth2AuthorizedClientManager authorizedClientManager(
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -118,4 +124,4 @@ fun authorizedClientManager(
return authorizedClientManager
}
----
====
======

108
docs/modules/ROOT/pages/reactive/oauth2/login/advanced.adoc
View File

@ -23,8 +23,10 @@ These claims are normally represented by a JSON object that contains a collectio
The following code shows the complete configuration options available for the `oauth2Login()` DSL:
.OAuth2 Login Configuration Options
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -52,7 +54,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -78,7 +81,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
The following sections go into more detail on each of the configuration options available:
@ -115,8 +118,10 @@ To override the default login page, configure the `exceptionHandling().authentic
The following listing shows an example:
.OAuth2 Login Page Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -148,7 +153,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -179,7 +185,7 @@ class OAuth2LoginSecurityConfig {
...
}
----
====
======
[IMPORTANT]
You need to provide a `@Controller` with a `@RequestMapping("/login/oauth2")` that is capable of rendering the custom login page.
@ -212,8 +218,10 @@ The default Authorization Response redirection endpoint is `+/login/oauth2/code/
If you would like to customize the Authorization Response redirection endpoint, configure it as shown in the following example:
.Redirection Endpoint Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -231,7 +239,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -247,7 +256,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
[IMPORTANT]
====
@ -255,7 +264,10 @@ You also need to ensure the `ClientRegistration.redirectUri` matches the custom
The following listing shows an example:
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
return CommonOAuth2Provider.GOOGLE.getBuilder("google")
@ -265,7 +277,8 @@ return CommonOAuth2Provider.GOOGLE.getBuilder("google")
.build();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
return CommonOAuth2Provider.GOOGLE.getBuilder("google")
@ -274,6 +287,7 @@ return CommonOAuth2Provider.GOOGLE.getBuilder("google")
.redirectUri("{baseUrl}/login/oauth2/callback/{registrationId}")
.build()
----
======
====
@ -307,8 +321,10 @@ There are a couple of options to choose from when mapping user authorities:
Register a `GrantedAuthoritiesMapper` `@Bean` to have it automatically applied to the configuration, as shown in the following example:
.Granted Authorities Mapper Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -355,7 +371,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -389,7 +406,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
[[webflux-oauth2-login-advanced-map-authorities-reactiveoauth2userservice]]
==== Delegation-based strategy with ReactiveOAuth2UserService
@ -401,8 +418,10 @@ The `OAuth2UserRequest` (and `OidcUserRequest`) provides you access to the assoc
The following example shows how to implement and configure a delegation-based strategy using an OpenID Connect 1.0 UserService:
.ReactiveOAuth2UserService Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -442,7 +461,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -478,7 +498,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
[[webflux-oauth2-login-advanced-oauth2-user-service]]
@ -495,8 +515,10 @@ If you need to customize the pre-processing of the UserInfo Request and/or the p
Whether you customize `DefaultReactiveOAuth2UserService` or provide your own implementation of `ReactiveOAuth2UserService`, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -518,7 +540,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -537,7 +560,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
[[webflux-oauth2-login-advanced-oidc-user-service]]
@ -551,8 +574,10 @@ If you need to customize the pre-processing of the UserInfo Request and/or the p
Whether you customize `OidcReactiveOAuth2UserService` or provide your own implementation of `ReactiveOAuth2UserService` for OpenID Connect 1.0 Provider's, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -574,7 +599,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -593,7 +619,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
[[webflux-oauth2-login-advanced-idtoken-verify]]
@ -610,8 +636,10 @@ The JWS algorithm resolver is a `Function` that accepts a `ClientRegistration` a
The following code shows how to configure the `OidcIdTokenDecoderFactory` `@Bean` to default to `MacAlgorithm.HS256` for all `ClientRegistration`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -622,7 +650,8 @@ public ReactiveJwtDecoderFactory<ClientRegistration> idTokenDecoderFactory() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -632,7 +661,7 @@ fun idTokenDecoderFactory(): ReactiveJwtDecoderFactory<ClientRegistration> {
return idTokenDecoderFactory
}
----
====
======
[NOTE]
For MAC based algorithms such as `HS256`, `HS384` or `HS512`, the `client-secret` corresponding to the `client-id` is used as the symmetric key for signature verification.
@ -668,8 +697,10 @@ spring:
...and the `OidcClientInitiatedServerLogoutSuccessHandler`, which implements RP-Initiated Logout, may be configured as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -705,7 +736,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -737,7 +769,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
NOTE: `OidcClientInitiatedServerLogoutSuccessHandler` supports the `+{baseUrl}+` placeholder.
If used, the application's base URL, like `https://app.example.org`, will replace it at request time.

46
docs/modules/ROOT/pages/reactive/oauth2/login/core.adoc
View File

@ -61,10 +61,8 @@ spring:
----
+
.OAuth Client properties
====
<1> `spring.security.oauth2.client.registration` is the base property prefix for OAuth Client properties.
<2> Following the base property prefix is the ID for the xref:reactive/oauth2/client/core.adoc#oauth2Client-client-registration[`ClientRegistration`], such as google.
====
. Replace the values in the `client-id` and `client-secret` property with the OAuth 2.0 credentials you created earlier.
@ -244,8 +242,10 @@ If you need to override the auto-configuration based on your specific requiremen
The following example shows how to register a `ReactiveClientRegistrationRepository` `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
@Configuration
@ -275,7 +275,8 @@ public class OAuth2LoginConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
@Configuration
@ -304,7 +305,7 @@ class OAuth2LoginConfig {
}
}
----
====
======
[[webflux-oauth2-login-register-securitywebfilterchain-bean]]
@ -313,8 +314,10 @@ class OAuth2LoginConfig {
The following example shows how to register a `SecurityWebFilterChain` `@Bean` with `@EnableWebFluxSecurity` and enable OAuth 2.0 login through `serverHttpSecurity.oauth2Login()`:
.OAuth2 Login Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -333,7 +336,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -350,7 +354,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
[[webflux-oauth2-login-completely-override-autoconfiguration]]
@ -359,8 +363,10 @@ class OAuth2LoginSecurityConfig {
The following example shows how to completely override the auto-configuration by registering a `ReactiveClientRegistrationRepository` `@Bean` and a `SecurityWebFilterChain` `@Bean`.
.Overriding the auto-configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
@EnableWebFluxSecurity
@ -401,7 +407,8 @@ public class OAuth2LoginConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
@EnableWebFluxSecurity
@ -440,7 +447,7 @@ class OAuth2LoginConfig {
}
}
----
====
======
[[webflux-oauth2-login-javaconfig-wo-boot]]
@ -449,8 +456,10 @@ class OAuth2LoginConfig {
If you are not able to use Spring Boot 2.x and would like to configure one of the pre-defined providers in `CommonOAuth2Provider` (for example, Google), apply the following configuration:
.OAuth2 Login Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -493,7 +502,8 @@ public class OAuth2LoginConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebFluxSecurity
@ -536,4 +546,4 @@ class OAuth2LoginConfig {
}
}
----
====
======

44
docs/modules/ROOT/pages/reactive/oauth2/resource-server/bearer-tokens.adoc
View File

@ -10,8 +10,10 @@ For example, you may have a need to read the bearer token from a custom header.
To achieve this, you can wire an instance of `ServerBearerTokenAuthenticationConverter` into the DSL, as you can see in the following example:
.Custom Bearer Token Header
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
ServerBearerTokenAuthenticationConverter converter = new ServerBearerTokenAuthenticationConverter();
@ -22,7 +24,8 @@ http
);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val converter = ServerBearerTokenAuthenticationConverter()
@ -33,15 +36,17 @@ return http {
}
}
----
====
======
== Bearer Token Propagation
Now that you're in possession of a bearer token, it might be handy to pass that to downstream services.
This is quite simple with `{security-api-url}org/springframework/security/oauth2/server/resource/web/reactive/function/client/ServerBearerExchangeFilterFunction.html[ServerBearerExchangeFilterFunction]`, which you can see in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -52,7 +57,8 @@ public WebClient rest() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -62,15 +68,17 @@ fun rest(): WebClient {
.build()
}
----
====
======
When the above `WebClient` is used to perform requests, Spring Security will look up the current `Authentication` and extract any `{security-api-url}org/springframework/security/oauth2/core/AbstractOAuth2Token.html[AbstractOAuth2Token]` credential.
Then, it will propagate that token in the `Authorization` header.
For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
this.rest.get()
@ -79,7 +87,8 @@ this.rest.get()
.bodyToMono(String.class)
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
this.rest.get()
@ -87,14 +96,16 @@ this.rest.get()
.retrieve()
.bodyToMono<String>()
----
====
======
Will invoke the `https://other-service.example.com/endpoint`, adding the bearer token `Authorization` header for you.
In places where you need to override this behavior, it's a simple matter of supplying the header yourself, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
this.rest.get()
@ -104,7 +115,8 @@ this.rest.get()
.bodyToMono(String.class)
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
rest.get()
@ -113,7 +125,7 @@ rest.get()
.retrieve()
.bodyToMono<String>()
----
====
======
In this case, the filter will fall back and simply forward the request onto the rest of the web filter chain.

231
docs/modules/ROOT/pages/reactive/oauth2/resource-server/jwt.adoc
View File

@ -112,8 +112,10 @@ There are two ``@Bean``s that Spring Boot generates on Resource Server's behalf.
The first is a `SecurityWebFilterChain` that configures the app as a resource server. When including `spring-security-oauth2-jose`, this `SecurityWebFilterChain` looks like:
.Resource Server SecurityWebFilterChain
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -127,7 +129,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -142,15 +145,17 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
If the application doesn't expose a `SecurityWebFilterChain` bean, then Spring Boot will expose the above default one.
Replacing this is as simple as exposing the bean within the application:
.Replacing SecurityWebFilterChain
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -167,7 +172,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -183,7 +189,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
The above requires the scope of `message:read` for any URL that starts with `/messages/`.
@ -192,8 +198,10 @@ Methods on the `oauth2ResourceServer` DSL will also override or replace auto con
For example, the second `@Bean` Spring Boot creates is a `ReactiveJwtDecoder`, which decodes `String` tokens into validated instances of `Jwt`:
.ReactiveJwtDecoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -202,7 +210,8 @@ public ReactiveJwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -210,7 +219,7 @@ fun jwtDecoder(): ReactiveJwtDecoder {
return ReactiveJwtDecoders.fromIssuerLocation(issuerUri)
}
----
====
======
[NOTE]
Calling `{security-api-url}org/springframework/security/oauth2/jwt/ReactiveJwtDecoders.html#fromIssuerLocation-java.lang.String-[ReactiveJwtDecoders#fromIssuerLocation]` is what invokes the Provider Configuration or Authorization Server Metadata endpoint in order to derive the JWK Set Uri.
@ -223,8 +232,10 @@ And its configuration can be overridden using `jwkSetUri()` or replaced using `d
An authorization server's JWK Set Uri can be configured <<webflux-oauth2resourceserver-jwt-jwkseturi,as a configuration property>> or it can be supplied in the DSL:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -242,7 +253,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -259,7 +271,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
Using `jwkSetUri()` takes precedence over any configuration property.
@ -268,8 +280,10 @@ Using `jwkSetUri()` takes precedence over any configuration property.
More powerful than `jwkSetUri()` is `decoder()`, which will completely replace any Boot auto configuration of `JwtDecoder`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -287,7 +301,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -304,7 +319,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
This is handy when deeper configuration, like <<webflux-oauth2resourceserver-jwt-validation,validation>>, is necessary.
@ -313,8 +328,10 @@ This is handy when deeper configuration, like <<webflux-oauth2resourceserver-jwt
Or, exposing a `ReactiveJwtDecoder` `@Bean` has the same effect as `decoder()`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -323,7 +340,8 @@ public ReactiveJwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -331,7 +349,7 @@ fun jwtDecoder(): ReactiveJwtDecoder {
return ReactiveJwtDecoders.fromIssuerLocation(issuerUri)
}
----
====
======
[[webflux-oauth2resourceserver-jwt-decoder-algorithm]]
== Configuring Trusted Algorithms
@ -361,8 +379,10 @@ spring:
For greater power, though, we can use a builder that ships with `NimbusReactiveJwtDecoder`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -372,7 +392,8 @@ ReactiveJwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -381,12 +402,14 @@ fun jwtDecoder(): ReactiveJwtDecoder {
.jwsAlgorithm(RS512).build()
}
----
====
======
Calling `jwsAlgorithm` more than once will configure `NimbusReactiveJwtDecoder` to trust more than one algorithm, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -396,7 +419,8 @@ ReactiveJwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -405,12 +429,14 @@ fun jwtDecoder(): ReactiveJwtDecoder {
.jwsAlgorithm(RS512).jwsAlgorithm(ES512).build()
}
----
====
======
Or, you can call `jwsAlgorithms`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -423,7 +449,8 @@ ReactiveJwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -436,7 +463,7 @@ fun jwtDecoder(): ReactiveJwtDecoder {
.build()
}
----
====
======
[[webflux-oauth2resourceserver-jwt-decoder-public-key]]
=== Trusting a Single Asymmetric Key
@ -463,8 +490,10 @@ spring:
Or, to allow for a more sophisticated lookup, you can post-process the `RsaKeyConversionServicePostProcessor`:
.BeanFactoryPostProcessor
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -475,7 +504,8 @@ BeanFactoryPostProcessor conversionServiceCustomizer() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -486,7 +516,7 @@ fun conversionServiceCustomizer(): BeanFactoryPostProcessor {
}
}
----
====
======
Specify your key's location:
@ -497,29 +527,34 @@ key.location: hfds://my-key.pub
And then autowire the value:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Value("${key.location}")
RSAPublicKey key;
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Value("\${key.location}")
val key: RSAPublicKey? = null
----
====
======
[[webflux-oauth2resourceserver-jwt-decoder-public-key-builder]]
==== Using a Builder
To wire an `RSAPublicKey` directly, you can simply use the appropriate `NimbusReactiveJwtDecoder` builder, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -528,7 +563,8 @@ public ReactiveJwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -536,7 +572,7 @@ fun jwtDecoder(): ReactiveJwtDecoder {
return NimbusReactiveJwtDecoder.withPublicKey(key).build()
}
----
====
======
[[webflux-oauth2resourceserver-jwt-decoder-secret-key]]
=== Trusting a Single Symmetric Key
@ -544,8 +580,10 @@ fun jwtDecoder(): ReactiveJwtDecoder {
Using a single symmetric key is also simple.
You can simply load in your `SecretKey` and use the appropriate `NimbusReactiveJwtDecoder` builder, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -554,7 +592,8 @@ public ReactiveJwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -562,7 +601,7 @@ fun jwtDecoder(): ReactiveJwtDecoder {
return NimbusReactiveJwtDecoder.withSecretKey(this.key).build()
}
----
====
======
[[webflux-oauth2resourceserver-jwt-authorization]]
=== Configuring Authorization
@ -575,8 +614,10 @@ When this is the case, Resource Server will attempt to coerce these scopes into
This means that to protect an endpoint or method with a scope derived from a JWT, the corresponding expressions should include this prefix:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -592,7 +633,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -609,25 +651,28 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
Or similarly with method security:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@PreAuthorize("hasAuthority('SCOPE_messages')")
public Flux<Message> getMessages(...) {}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@PreAuthorize("hasAuthority('SCOPE_messages')")
fun getMessages(): Flux<Message> { }
----
====
======
[[webflux-oauth2resourceserver-jwt-authorization-extraction]]
==== Extracting Authorities Manually
@ -638,8 +683,10 @@ Or, at other times, the resource server may need to adapt the attribute or a com
To this end, the DSL exposes `jwtAuthenticationConverter()`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -665,7 +712,8 @@ Converter<Jwt, Mono<AbstractAuthenticationToken>> grantedAuthoritiesExtractor()
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -688,15 +736,17 @@ fun grantedAuthoritiesExtractor(): Converter<Jwt, Mono<AbstractAuthenticationTok
return ReactiveJwtAuthenticationConverterAdapter(jwtAuthenticationConverter)
}
----
====
======
which is responsible for converting a `Jwt` into an `Authentication`.
As part of its configuration, we can supply a subsidiary converter to go from `Jwt` to a `Collection` of granted authorities.
That final converter might be something like `GrantedAuthoritiesExtractor` below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
static class GrantedAuthoritiesExtractor
@ -714,7 +764,8 @@ static class GrantedAuthoritiesExtractor
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
internal class GrantedAuthoritiesExtractor : Converter<Jwt, Collection<GrantedAuthority>> {
@ -727,12 +778,14 @@ internal class GrantedAuthoritiesExtractor : Converter<Jwt, Collection<GrantedAu
}
}
----
====
======
For more flexibility, the DSL supports entirely replacing the converter with any class that implements `Converter<Jwt, Mono<AbstractAuthenticationToken>>`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
static class CustomAuthenticationConverter implements Converter<Jwt, Mono<AbstractAuthenticationToken>> {
@ -742,7 +795,8 @@ static class CustomAuthenticationConverter implements Converter<Jwt, Mono<Abstra
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
internal class CustomAuthenticationConverter : Converter<Jwt, Mono<AbstractAuthenticationToken>> {
@ -751,7 +805,7 @@ internal class CustomAuthenticationConverter : Converter<Jwt, Mono<AbstractAuthe
}
}
----
====
======
[[webflux-oauth2resourceserver-jwt-validation]]
=== Configuring Validation
@ -770,8 +824,10 @@ This can cause some implementation heartburn as the number of collaborating serv
Resource Server uses `JwtTimestampValidator` to verify a token's validity window, and it can be configured with a `clockSkew` to alleviate the above problem:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -789,7 +845,8 @@ ReactiveJwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -802,7 +859,7 @@ fun jwtDecoder(): ReactiveJwtDecoder {
return jwtDecoder
}
----
====
======
[NOTE]
By default, Resource Server configures a clock skew of 60 seconds.
@ -812,8 +869,10 @@ By default, Resource Server configures a clock skew of 60 seconds.
Adding a check for the `aud` claim is simple with the `OAuth2TokenValidator` API:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class AudienceValidator implements OAuth2TokenValidator<Jwt> {
@ -829,7 +888,8 @@ public class AudienceValidator implements OAuth2TokenValidator<Jwt> {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class AudienceValidator : OAuth2TokenValidator<Jwt> {
@ -843,12 +903,14 @@ class AudienceValidator : OAuth2TokenValidator<Jwt> {
}
}
----
====
======
Then, to add into a resource server, it's a matter of specifying the `ReactiveJwtDecoder` instance:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -866,7 +928,8 @@ ReactiveJwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -879,4 +942,4 @@ fun jwtDecoder(): ReactiveJwtDecoder {
return jwtDecoder
}
----
====
======

22
docs/modules/ROOT/pages/reactive/oauth2/resource-server/multitenancy.adoc
View File

@ -17,8 +17,10 @@ In each case, there are two things that need to be done and trade-offs associate
One way to differentiate tenants is by the issuer claim. Since the issuer claim accompanies signed JWTs, this can be done with the `JwtIssuerReactiveAuthenticationManagerResolver`, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
JwtIssuerReactiveAuthenticationManagerResolver authenticationManagerResolver = new JwtIssuerReactiveAuthenticationManagerResolver
@ -33,7 +35,8 @@ http
);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val customAuthenticationManagerResolver = JwtIssuerReactiveAuthenticationManagerResolver("https://idp.example.org/issuerOne", "https://idp.example.org/issuerTwo")
@ -47,7 +50,7 @@ return http {
}
}
----
====
======
This is nice because the issuer endpoints are loaded lazily.
In fact, the corresponding `JwtReactiveAuthenticationManager` is instantiated only when the first request with the corresponding issuer is sent.
@ -58,8 +61,10 @@ This allows for an application startup that is independent from those authorizat
Of course, you may not want to restart the application each time a new tenant is added.
In this case, you can configure the `JwtIssuerReactiveAuthenticationManagerResolver` with a repository of `ReactiveAuthenticationManager` instances, which you can edit at runtime, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
private Mono<ReactiveAuthenticationManager> addManager(
@ -85,7 +90,8 @@ http
);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
private fun addManager(
@ -108,7 +114,7 @@ return http {
}
}
----
====
======
In this case, you construct `JwtIssuerReactiveAuthenticationManagerResolver` with a strategy for obtaining the `ReactiveAuthenticationManager` given the issuer.
This approach allows us to add and remove elements from the repository (shown as a `Map` in the snippet) at runtime.

198
docs/modules/ROOT/pages/reactive/oauth2/resource-server/opaque-token.adoc
View File

@ -82,8 +82,10 @@ Once a token is authenticated, an instance of `BearerTokenAuthentication` is set
This means that it's available in `@Controller` methods when using `@EnableWebFlux` in your configuration:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@GetMapping("/foo")
@ -92,7 +94,8 @@ public Mono<String> foo(BearerTokenAuthentication authentication) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@GetMapping("/foo")
@ -100,12 +103,14 @@ fun foo(authentication: BearerTokenAuthentication): Mono<String> {
return Mono.just(authentication.tokenAttributes["sub"].toString() + " is the subject")
}
----
====
======
Since `BearerTokenAuthentication` holds an `OAuth2AuthenticatedPrincipal`, that also means that it's available to controller methods, too:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@GetMapping("/foo")
@ -114,7 +119,8 @@ public Mono<String> foo(@AuthenticationPrincipal OAuth2AuthenticatedPrincipal pr
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@GetMapping("/foo")
@ -122,7 +128,7 @@ fun foo(@AuthenticationPrincipal principal: OAuth2AuthenticatedPrincipal): Mono<
return Mono.just(principal.getAttribute<Any>("sub").toString() + " is the subject")
}
----
====
======
=== Looking Up Attributes Via SpEL
@ -130,8 +136,10 @@ Of course, this also means that attributes can be accessed via SpEL.
For example, if using `@EnableReactiveMethodSecurity` so that you can use `@PreAuthorize` annotations, you can do:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@PreAuthorize("principal?.attributes['sub'] = 'foo'")
@ -140,7 +148,8 @@ public Mono<String> forFoosEyesOnly() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@PreAuthorize("principal.attributes['sub'] = 'foo'")
@ -148,7 +157,7 @@ fun forFoosEyesOnly(): Mono<String> {
return Mono.just("foo")
}
----
====
======
[[webflux-oauth2resourceserver-opaque-sansboot]]
== Overriding or Replacing Boot Auto Configuration
@ -158,8 +167,10 @@ There are two ``@Bean``s that Spring Boot generates on Resource Server's behalf.
The first is a `SecurityWebFilterChain` that configures the app as a resource server.
When use Opaque Token, this `SecurityWebFilterChain` looks like:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -173,7 +184,8 @@ SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -188,15 +200,17 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
If the application doesn't expose a `SecurityWebFilterChain` bean, then Spring Boot will expose the above default one.
Replacing this is as simple as exposing the bean within the application:
.Replacing SecurityWebFilterChain
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -218,7 +232,8 @@ public class MyCustomSecurityConfiguration {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -236,7 +251,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
The above requires the scope of `message:read` for any URL that starts with `/messages/`.
@ -244,8 +259,10 @@ Methods on the `oauth2ResourceServer` DSL will also override or replace auto con
For example, the second `@Bean` Spring Boot creates is a `ReactiveOpaqueTokenIntrospector`, which decodes `String` tokens into validated instances of `OAuth2AuthenticatedPrincipal`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -254,7 +271,8 @@ public ReactiveOpaqueTokenIntrospector introspector() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -262,7 +280,7 @@ fun introspector(): ReactiveOpaqueTokenIntrospector {
return NimbusReactiveOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret)
}
----
====
======
If the application doesn't expose a `ReactiveOpaqueTokenIntrospector` bean, then Spring Boot will expose the above default one.
@ -273,8 +291,10 @@ And its configuration can be overridden using `introspectionUri()` and `introspe
An authorization server's Introspection Uri can be configured <<webflux-oauth2resourceserver-opaque-introspectionuri,as a configuration property>> or it can be supplied in the DSL:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -296,7 +316,8 @@ public class DirectlyConfiguredIntrospectionUri {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -314,7 +335,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
Using `introspectionUri()` takes precedence over any configuration property.
@ -323,8 +344,10 @@ Using `introspectionUri()` takes precedence over any configuration property.
More powerful than `introspectionUri()` is `introspector()`, which will completely replace any Boot auto configuration of `ReactiveOpaqueTokenIntrospector`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -345,7 +368,8 @@ public class DirectlyConfiguredIntrospector {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -362,7 +386,7 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
This is handy when deeper configuration, like <<webflux-oauth2resourceserver-opaque-authorization-extraction,authority mapping>>or <<webflux-oauth2resourceserver-opaque-jwt-introspector,JWT revocation>> is necessary.
@ -371,8 +395,10 @@ This is handy when deeper configuration, like <<webflux-oauth2resourceserver-opa
Or, exposing a `ReactiveOpaqueTokenIntrospector` `@Bean` has the same effect as `introspector()`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -381,7 +407,8 @@ public ReactiveOpaqueTokenIntrospector introspector() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -389,7 +416,7 @@ fun introspector(): ReactiveOpaqueTokenIntrospector {
return NimbusReactiveOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret)
}
----
====
======
[[webflux-oauth2resourceserver-opaque-authorization]]
== Configuring Authorization
@ -402,8 +429,10 @@ When this is the case, Resource Server will attempt to coerce these scopes into
This means that to protect an endpoint or method with a scope derived from an Opaque Token, the corresponding expressions should include this prefix:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebFluxSecurity
@ -422,7 +451,8 @@ public class MappedAuthorities {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -439,25 +469,28 @@ fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain
}
}
----
====
======
Or similarly with method security:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@PreAuthorize("hasAuthority('SCOPE_messages')")
public Flux<Message> getMessages(...) {}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@PreAuthorize("hasAuthority('SCOPE_messages')")
fun getMessages(): Flux<Message> { }
----
====
======
[[webflux-oauth2resourceserver-opaque-authorization-extraction]]
=== Extracting Authorities Manually
@ -478,8 +511,10 @@ Then Resource Server would generate an `Authentication` with two authorities, on
This can, of course, be customized using a custom `ReactiveOpaqueTokenIntrospector` that takes a look at the attribute set and converts in its own way:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class CustomAuthoritiesOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
@ -501,7 +536,8 @@ public class CustomAuthoritiesOpaqueTokenIntrospector implements ReactiveOpaqueT
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class CustomAuthoritiesOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
@ -521,12 +557,14 @@ class CustomAuthoritiesOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector
}
}
----
====
======
Thereafter, this custom introspector can be configured simply by exposing it as a `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -535,7 +573,8 @@ public ReactiveOpaqueTokenIntrospector introspector() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -543,7 +582,7 @@ fun introspector(): ReactiveOpaqueTokenIntrospector {
return CustomAuthoritiesOpaqueTokenIntrospector()
}
----
====
======
[[webflux-oauth2resourceserver-opaque-jwt-introspector]]
== Using Introspection with JWTs
@ -575,8 +614,10 @@ Now what?
In this case, you can create a custom `ReactiveOpaqueTokenIntrospector` that still hits the endpoint, but then updates the returned principal to have the JWTs claims as the attributes:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class JwtOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
@ -602,7 +643,8 @@ public class JwtOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospect
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class JwtOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
@ -625,12 +667,14 @@ class JwtOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
}
}
----
====
======
Thereafter, this custom introspector can be configured simply by exposing it as a `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -639,7 +683,8 @@ public ReactiveOpaqueTokenIntrospector introspector() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -647,7 +692,7 @@ fun introspector(): ReactiveOpaqueTokenIntrospector {
return JwtOpaqueTokenIntrospector()
}
----
====
======
[[webflux-oauth2resourceserver-opaque-userinfo]]
== Calling a `/userinfo` Endpoint
@ -663,8 +708,10 @@ This implementation below does three things:
* Looks up the appropriate client registration associated with the `/userinfo` endpoint
* Invokes and returns the response from the `/userinfo` endpoint
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class UserInfoOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
@ -693,7 +740,8 @@ public class UserInfoOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntro
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class UserInfoOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
@ -716,13 +764,15 @@ class UserInfoOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
}
}
----
====
======
If you aren't using `spring-security-oauth2-client`, it's still quite simple.
You will simply need to invoke the `/userinfo` with your own instance of `WebClient`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class UserInfoOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
@ -738,7 +788,8 @@ public class UserInfoOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntro
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class UserInfoOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
@ -751,12 +802,14 @@ class UserInfoOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
}
}
----
====
======
Either way, having created your `ReactiveOpaqueTokenIntrospector`, you should publish it as a `@Bean` to override the defaults:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -765,7 +818,8 @@ ReactiveOpaqueTokenIntrospector introspector() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -773,4 +827,4 @@ fun introspector(): ReactiveOpaqueTokenIntrospector {
return UserInfoOpaqueTokenIntrospector()
}
----
====
======

11
docs/modules/ROOT/pages/reactive/test/method.adoc
View File

@ -4,8 +4,10 @@
For example, we can test our example from xref:reactive/authorization/method.adoc#jc-erms[EnableReactiveMethodSecurity] using the same setup and annotations we did in xref:servlet/test/method.adoc#test-method[Testing Method Security].
Here is a minimal sample of what we can do:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ExtendWith(SpringExtension.class)
@ -39,7 +41,8 @@ public class HelloWorldMessageServiceTests {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@ExtendWith(SpringExtension.class)
@ -72,4 +75,4 @@ class HelloWorldMessageServiceTests {
}
}
----
====
======

11
docs/modules/ROOT/pages/reactive/test/web/authentication.adoc
View File

@ -3,8 +3,10 @@
After xref:reactive/test/web/setup.adoc[applying the Spring Security support to `WebTestClient`] we can use either annotations or `mutateWith` support.
For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import static org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers.mockUser;
@ -65,7 +67,8 @@ public void messageWhenMutateWithMockAdminThenOk() throws Exception {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.test.web.reactive.server.expectBody
@ -112,6 +115,6 @@ fun messageWhenMutateWithMockAdminThenOk() {
.expectBody<String>().isEqualTo("Hello World!")
}
----
====
======
In addition to `mockUser()`, Spring Security ships with several other convenience mutators for things like xref:reactive/test/web/csrf.adoc[CSRF] and xref:reactive/test/web/oauth2.adoc[OAuth 2.0].

11
docs/modules/ROOT/pages/reactive/test/web/csrf.adoc
View File

@ -3,8 +3,10 @@
Spring Security also provides support for CSRF testing with `WebTestClient`.
For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import static org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers.csrf;
@ -17,7 +19,8 @@ this.rest
...
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers.csrf
@ -29,4 +32,4 @@ this.rest
.uri("/login")
...
----
====
======

462
docs/modules/ROOT/pages/reactive/test/web/oauth2.adoc
View File

File diff suppressed because it is too large Load Diff

11
docs/modules/ROOT/pages/reactive/test/web/setup.adoc
View File

@ -2,8 +2,10 @@
The basic setup looks like this:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import static org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers.springSecurity;
@ -31,7 +33,8 @@ public class HelloWebfluxMethodApplicationTests {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers.springSecurity
@ -58,4 +61,4 @@ class HelloWebfluxMethodApplicationTests {
// ...
}
----
====
======

46
docs/modules/ROOT/pages/servlet/appendix/faq.adoc
View File

@ -108,12 +108,12 @@ If you are using other technologies which you aren't familiar with then you shou
.. <<appendix-faq-session-listener-missing>>
.. <<appendix-faq-unwanted-session-creation>>
. Miscellaneous
.. <<appendix-faq-forbidden-csrf>>
.. <<appendix-faq-no-security-on-forward>>
.. <<appendix-faq-method-security-in-web-context>>
.. <<appendix-faq-no-filters-no-context>>
.. <<appendix-faq-method-security-with-taglib>>
[[appendix-faq-bad-credentials]]
=== When I try to log in, I get an error message that says "Bad Credentials". What's wrong?
@ -196,8 +196,10 @@ This will be different in different companies, so you have to find it out yourse
Before adding a Spring Security LDAP configuration to an application, it's a good idea to write a simple test using standard Java LDAP code (without Spring Security involved), and make sure you can get that to work first.
For example, to authenticate a user, you could use the following code:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ -216,7 +218,8 @@ public void ldapAuthenticationIsSuccessful() throws Exception {
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test
@ -230,7 +233,7 @@ fun ldapAuthenticationIsSuccessful() {
val ctx = InitialLdapContext(env, null)
}
----
====
======
=== Session Management
@ -516,8 +519,10 @@ To load the data from an alternative source, you must be using an explicitly dec
You can't use the namespace.
You would then implement `FilterInvocationSecurityMetadataSource` to load the data as you please for a particular `FilterInvocation` footnote:[The `FilterInvocation` object contains the `HttpServletRequest`, so you can obtain the URL or any other relevant information on which to base your decision on what the list of returned attributes will contain.]. A very basic outline would look something like this:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ -546,7 +551,8 @@ You would then implement `FilterInvocationSecurityMetadataSource` to load the da
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class MyFilterSecurityMetadataSource : FilterInvocationSecurityMetadataSource {
@ -569,7 +575,7 @@ class MyFilterSecurityMetadataSource : FilterInvocationSecurityMetadataSource {
}
}
----
====
======
For more information, look at the code for `DefaultFilterInvocationSecurityMetadataSource`.
@ -582,8 +588,10 @@ The `DefaultLdapAuthoritiesPopulator` loads the user authorities from the LDAP d
To use JDBC instead, you can implement the interface yourself, using whatever SQL is appropriate for your schema:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ -609,7 +617,8 @@ To use JDBC instead, you can implement the interface yourself, using whatever SQ
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class MyAuthoritiesPopulator : LdapAuthoritiesPopulator {
@ -629,7 +638,7 @@ class MyAuthoritiesPopulator : LdapAuthoritiesPopulator {
}
}
----
====
======
You would then add a bean of this type to your application context and inject it into the `LdapAuthenticationProvider`. This is covered in the section on configuring LDAP using explicit Spring beans in the LDAP chapter of the reference manual.
Note that you can't use the namespace for configuration in this case.
@ -647,8 +656,10 @@ More information can be found in the https://docs.spring.io/spring/docs/3.0.x/sp
Normally, you would add the functionality you require to the `postProcessBeforeInitialization` method of `BeanPostProcessor`. Let's say that you want to customize the `AuthenticationDetailsSource` used by the `UsernamePasswordAuthenticationFilter`, (created by the `form-login` element). You want to extract a particular header called `CUSTOM_HEADER` from the request and make use of it while authenticating the user.
The processor class would look like this:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ -674,7 +685,8 @@ public class CustomBeanPostProcessor implements BeanPostProcessor {
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class CustomBeanPostProcessor : BeanPostProcessor {
@ -692,7 +704,7 @@ class CustomBeanPostProcessor : BeanPostProcessor {
}
}
----
====
======
You would then register this bean in your application context.
Spring will automatically invoke it on the beans defined in the application context.

22
docs/modules/ROOT/pages/servlet/architecture.adoc
View File

@ -28,8 +28,10 @@ In this instance the `Filter` will typically write the `HttpServletResponse`.
The power of the `Filter` comes from the `FilterChain` that is passed into it.
.`FilterChain` Usage Example
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
@ -39,7 +41,8 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
fun doFilter(request: ServletRequest, response: ServletResponse, chain: FilterChain) {
@ -48,7 +51,7 @@ fun doFilter(request: ServletRequest, response: ServletResponse, chain: FilterCh
// do something after the rest of the application
}
----
====
======
Since a `Filter` only impacts downstream ``Filter``s and the `Servlet`, the order each `Filter` is invoked is extremely important.
@ -70,8 +73,10 @@ image::{figures}/delegatingfilterproxy.png[]
The pseudo code of `DelegatingFilterProxy` can be seen below.
.`DelegatingFilterProxy` Pseudo Code
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",subs="+quotes,+macros"]
----
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {
@ -83,7 +88,8 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",subs="+quotes,+macros"]
----
fun doFilter(request: ServletRequest, response: ServletResponse, chain: FilterChain) {
@ -94,7 +100,7 @@ fun doFilter(request: ServletRequest, response: ServletResponse, chain: FilterCh
delegate.doFilter(request, response)
}
----
====
======
Another benefit of `DelegatingFilterProxy` is that it allows delaying looking `Filter` bean instances.
This is important because the container needs to register the `Filter` instances before the container can startup.

22
docs/modules/ROOT/pages/servlet/authentication/anonymous.adoc
View File

@ -108,8 +108,10 @@ https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc
This means that a construct like this one:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@GetMapping("/")
@ -122,7 +124,8 @@ public String method(Authentication authentication) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@GetMapping("/")
@ -134,7 +137,7 @@ fun method(authentication: Authentication?): String {
}
}
----
====
======
will always return "not anonymous", even for anonymous requests.
The reason is that Spring MVC resolves the parameter using `HttpServletRequest#getPrincipal`, which is `null` when the request is anonymous.
@ -142,8 +145,10 @@ The reason is that Spring MVC resolves the parameter using `HttpServletRequest#g
If you'd like to obtain the `Authentication` in anonymous requests, use `@CurrentSecurityContext` instead:
.Use CurrentSecurityContext for Anonymous requests
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@GetMapping("/")
@ -152,11 +157,12 @@ public String method(@CurrentSecurityContext SecurityContext context) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@GetMapping("/")
fun method(@CurrentSecurityContext context : SecurityContext) : String =
context!!.authentication!!.name
----
====
======

22
docs/modules/ROOT/pages/servlet/authentication/architecture.adoc
View File

@ -31,8 +31,10 @@ If it contains a value, then it is used as the currently authenticated user.
The simplest way to indicate a user is authenticated is to set the `SecurityContextHolder` directly.
.Setting `SecurityContextHolder`
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
SecurityContext context = SecurityContextHolder.createEmptyContext(); // <1>
@ -43,7 +45,8 @@ context.setAuthentication(authentication);
SecurityContextHolder.setContext(context); // <3>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val context: SecurityContext = SecurityContextHolder.createEmptyContext() // <1>
@ -52,7 +55,7 @@ context.authentication = authentication
SecurityContextHolder.setContext(context) // <3>
----
====
======
<1> We start by creating an empty `SecurityContext`.
It is important to create a new `SecurityContext` instance instead of using `SecurityContextHolder.getContext().setAuthentication(authentication)` to avoid race conditions across multiple threads.
@ -66,8 +69,10 @@ Spring Security will use this information for xref:servlet/authorization/index.a
If you wish to obtain information about the authenticated principal, you can do so by accessing the `SecurityContextHolder`.
.Access Currently Authenticated User
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
SecurityContext context = SecurityContextHolder.getContext();
@ -77,7 +82,8 @@ Object principal = authentication.getPrincipal();
Collection<? extends GrantedAuthority> authorities = authentication.getAuthorities();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val context = SecurityContextHolder.getContext()
@ -86,7 +92,7 @@ val username = authentication.name
val principal = authentication.principal
val authorities = authentication.authorities
----
====
======
// FIXME: add links to HttpServletRequest.getRemoteUser() and @CurrentSecurityContext @AuthenticationPrincipal

11
docs/modules/ROOT/pages/servlet/authentication/cas.adoc
View File

@ -340,8 +340,10 @@ Now that Spring Security obtains PGTs, you can use them to create proxy tickets
The CAS xref:samples.adoc#samples[sample application] contains a working example in the `ProxyTicketSampleServlet`.
Example code can be found below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
protected void doGet(HttpServletRequest request, HttpServletResponse response)
@ -360,7 +362,8 @@ String proxyResponse = CommonUtils.getResponseFromServer(serviceUrl, "UTF-8");
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
protected fun doGet(request: HttpServletRequest, response: HttpServletResponse?) {
@ -376,7 +379,7 @@ protected fun doGet(request: HttpServletRequest, response: HttpServletResponse?)
val proxyResponse = CommonUtils.getResponseFromServer(serviceUrl, "UTF-8")
}
----
====
======
[[cas-pt]]
=== Proxy Ticket Authentication

44
docs/modules/ROOT/pages/servlet/authentication/events.adoc
View File

@ -6,8 +6,10 @@ For each authentication that succeeds or fails, a `AuthenticationSuccessEvent` o
To listen for these events, you must first publish an `AuthenticationEventPublisher`.
Spring Security's `DefaultAuthenticationEventPublisher` will probably do fine:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -17,7 +19,8 @@ public AuthenticationEventPublisher authenticationEventPublisher
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -26,12 +29,14 @@ fun authenticationEventPublisher
return DefaultAuthenticationEventPublisher(applicationEventPublisher)
}
----
====
======
Then, you can use Spring's `@EventListener` support:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Component
@ -48,7 +53,8 @@ public class AuthenticationEvents {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Component
@ -64,7 +70,7 @@ class AuthenticationEvents {
}
}
----
====
======
While similar to `AuthenticationSuccessHandler` and `AuthenticationFailureHandler`, these are nice in that they can be used independently from the servlet API.
@ -89,8 +95,10 @@ The publisher does an exact `Exception` match, which means that sub-classes of t
To that end, you may want to supply additional mappings to the publisher via the `setAdditionalExceptionMappings` method:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -106,7 +114,8 @@ public AuthenticationEventPublisher authenticationEventPublisher
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -119,14 +128,16 @@ fun authenticationEventPublisher
return authenticationEventPublisher
}
----
====
======
== Default Event
And, you can supply a catch-all event to fire in the case of any `AuthenticationException`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -140,7 +151,8 @@ public AuthenticationEventPublisher authenticationEventPublisher
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -151,4 +163,4 @@ fun authenticationEventPublisher
return authenticationEventPublisher
}
----
====
======

11
docs/modules/ROOT/pages/servlet/authentication/logout.adoc
View File

@ -16,8 +16,10 @@ The default is that accessing the URL `/logout` will log the user out by:
Similar to configuring login capabilities, however, you also have various options to further customize your logout requirements:
.Logout Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public SecurityFilterChain filterChain(HttpSecurity http) {
@ -34,7 +36,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
-----
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
@ -51,7 +54,7 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
// ...
}
-----
====
======
<1> Provides logout support.
<2> The URL that triggers log out to occur (default is `/logout`).

14
docs/modules/ROOT/pages/servlet/authentication/passwords/basic.adoc
View File

@ -58,9 +58,11 @@ However, as soon as any servlet based configuration is provided, HTTP Basic must
A minimal, explicit configuration can be found below:
.Explicit HTTP Basic Configuration
====
[tabs]
======
Java::
+
[source,java,role="primary"]
.Java
----
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) {
@ -71,8 +73,9 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
XML::
+
[source,xml,role="secondary"]
.XML
----
<http>
<!-- ... -->
@ -80,8 +83,9 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
</http>
----
Kotlin::
+
[source,kotlin,role="secondary"]
.Kotlin
----
@Bean
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
@ -92,4 +96,4 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
return http.build()
}
----
====
======

13
docs/modules/ROOT/pages/servlet/authentication/passwords/digest.adoc
View File

@ -25,21 +25,21 @@ This is a value the server generates.
Spring Security's nonce adopts the following format:
.Digest Syntax
====
[source,txt]
----
base64(expirationTime + ":" + md5Hex(expirationTime + ":" + key))
expirationTime: The date and time when the nonce expires, expressed in milliseconds
key: A private key to prevent modification of the nonce token
----
====
You will need to ensure you xref:features/authentication/password-storage.adoc#authentication-password-storage-configuration[configure] insecure plain text xref:features/authentication/password-storage.adoc#authentication-password-storage[Password Storage] using `NoOpPasswordEncoder`.
The following provides an example of configuring Digest Authentication with Java Configuration:
.Digest Authentication
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Autowired
@ -67,7 +67,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<b:bean id="digestFilter"
@ -87,4 +88,4 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
<custom-filter ref="userFilter" position="DIGEST_AUTH_FILTER"/>
</http>
----
====
======

44
docs/modules/ROOT/pages/servlet/authentication/passwords/form.adoc
View File

@ -67,8 +67,10 @@ However, as soon as any servlet based configuration is provided, form based log
A minimal, explicit Java configuration can be found below:
.Form Log In
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public SecurityFilterChain filterChain(HttpSecurity http) {
@ -78,7 +80,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -87,7 +90,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
@ -97,7 +101,7 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
// ...
}
----
====
======
In this configuration Spring Security will render a default log in page.
Most production applications will require a custom log in form.
@ -106,8 +110,10 @@ Most production applications will require a custom log in form.
The configuration below demonstrates how to provide a custom log in form.
.Custom Log In Form Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public SecurityFilterChain filterChain(HttpSecurity http) {
@ -120,7 +126,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -130,7 +137,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
@ -143,16 +151,14 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
// ...
}
----
====
======
[[servlet-authentication-form-custom-html]]
When the login page is specified in the Spring Security configuration, you are responsible for rendering the page.
// FIXME: default login page rendered by Spring Security
Below is a https://www.thymeleaf.org/[Thymeleaf] template that produces an HTML login form that complies with a login page of `/login`:
.Log In Form
====
.src/main/resources/templates/login.html
.Log In Form - src/main/resources/templates/login.html
[source,xml]
----
<!DOCTYPE html>
@ -178,7 +184,6 @@ Below is a https://www.thymeleaf.org/[Thymeleaf] template that produces an HTML
</body>
</html>
----
====
There are a few key points about the default HTML form:
@ -197,8 +202,10 @@ If you are using Spring MVC, you will need a controller that maps `GET /login` t
A minimal sample `LoginController` can be seen below:
.LoginController
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -210,7 +217,8 @@ class LoginController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Controller
@ -221,4 +229,4 @@ class LoginController {
}
}
----
====
======

27
docs/modules/ROOT/pages/servlet/authentication/passwords/in-memory.adoc
View File

@ -8,8 +8,10 @@ Spring Security's `InMemoryUserDetailsManager` implements xref:servlet/authentic
In this sample we use xref:features/authentication/password-storage.adoc#authentication-password-storage-boot-cli[Spring Boot CLI] to encode the password of `password` and get the encoded password of `+{bcrypt}$2a$10$GRLdNijSQMUvl/au9ofL.eDwmoohzzS7.rmNSJZ.0FxO/BTk76klW+`.
.InMemoryUserDetailsManager Java Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
@Bean
@ -28,7 +30,8 @@ public UserDetailsService users() {
}
----
.XML
XML::
+
[source,xml,role="secondary",attrs="-attributes"]
----
<user-service>
@ -41,7 +44,8 @@ public UserDetailsService users() {
</user-service>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
@Bean
@ -59,7 +63,7 @@ fun users(): UserDetailsService {
return InMemoryUserDetailsManager(user, admin)
}
----
====
======
The samples above store the passwords in a secure format, but leave a lot to be desired in terms of getting started experience.
@ -69,8 +73,10 @@ However, it does not protect against obtaining the password by decompiling the s
For this reason, `User.withDefaultPasswordEncoder` should only be used for "getting started" and is not intended for production.
.InMemoryUserDetailsManager with User.withDefaultPasswordEncoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -91,7 +97,8 @@ public UserDetailsService users() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -111,13 +118,12 @@ fun users(): UserDetailsService {
return InMemoryUserDetailsManager(user, admin)
}
----
====
======
There is no simple way to use `User.withDefaultPasswordEncoder` with XML based configuration.
For demos or just getting started, you can choose to prefix the password with `+{noop}+` to indicate xref:features/authentication/password-storage.adoc#authentication-password-storage-dpe-format[no encoding should be used].
.<user-service> `+{noop}+` XML Configuration
====
[source,xml,attrs="-attributes"]
----
<user-service>
@ -129,4 +135,3 @@ For demos or just getting started, you can choose to prefix the password with `+
authorities="ROLE_USER,ROLE_ADMIN" />
</user-service>
----
====

34
docs/modules/ROOT/pages/servlet/authentication/passwords/jdbc.adoc
View File

@ -30,7 +30,6 @@ The default schema is also exposed as a classpath resource named `org/springfram
====
.Default User Schema
====
[source,sql]
----
create table users(
@ -46,13 +45,11 @@ create table authorities (
);
create unique index ix_auth_username on authorities (username,authority);
----
====
Oracle is a popular database choice, but requires a slightly different schema.
You can find the default Oracle Schema for users below.
.Default User Schema for Oracle Databases
====
[source,sql]
----
CREATE TABLE USERS (
@ -69,7 +66,6 @@ CREATE TABLE AUTHORITIES (
ALTER TABLE AUTHORITIES ADD CONSTRAINT AUTHORITIES_UNIQUE UNIQUE (USERNAME, AUTHORITY);
ALTER TABLE AUTHORITIES ADD CONSTRAINT AUTHORITIES_FK1 FOREIGN KEY (USERNAME) REFERENCES USERS (USERNAME) ENABLE;
----
====
[[servlet-authentication-jdbc-schema-group]]
=== Group Schema
@ -78,7 +74,6 @@ If your application is leveraging groups, you will need to provide the groups sc
The default schema for groups can be found below.
.Default Group Schema
====
[source,sql]
----
create table groups (
@ -99,7 +94,6 @@ create table group_members (
constraint fk_group_members_group foreign key(group_id) references groups(id)
);
----
====
[[servlet-authentication-jdbc-datasource]]
== Setting up a DataSource
@ -108,8 +102,10 @@ Before we configure `JdbcUserDetailsManager`, we must create a `DataSource`.
In our example, we will setup an https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/data-access.html#jdbc-embedded-database-support[embedded DataSource] that is initialized with the <<servlet-authentication-jdbc-schema,default user schema>>.
.Embedded Data Source
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -121,7 +117,8 @@ DataSource dataSource() {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<jdbc:embedded-database>
@ -129,7 +126,8 @@ DataSource dataSource() {
</jdbc:embedded-database>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -140,7 +138,7 @@ fun dataSource(): DataSource {
.build()
}
----
====
======
In a production environment, you will want to ensure you setup a connection to an external database.
@ -151,9 +149,11 @@ In this sample we use xref:features/authentication/password-storage.adoc#authent
See the xref:features/authentication/password-storage.adoc#authentication-password-storage[PasswordEncoder] section for more details about how to store passwords.
.JdbcUserDetailsManager
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
@Bean
@ -175,7 +175,8 @@ UserDetailsManager users(DataSource dataSource) {
}
----
.XML
XML::
+
[source,xml,role="secondary",attrs="-attributes"]
----
<jdbc-user-service>
@ -188,7 +189,8 @@ UserDetailsManager users(DataSource dataSource) {
</jdbc-user-service>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
@Bean
@ -209,4 +211,4 @@ fun users(dataSource: DataSource): UserDetailsManager {
return users
}
----
====
======

170
docs/modules/ROOT/pages/servlet/authentication/passwords/ldap.adoc
View File

@ -97,8 +97,10 @@ uniqueMember: uid=admin,ou=people,dc=springframework,dc=org
If you wish to use https://ldap.com/unboundid-ldap-sdk-for-java/[UnboundID], then specify the following dependencies:
.UnboundID Dependencies
====
.Maven
[tabs]
======
Maven::
+
[source,xml,role="primary",subs="verbatim,attributes"]
----
<dependency>
@ -109,21 +111,24 @@ If you wish to use https://ldap.com/unboundid-ldap-sdk-for-java/[UnboundID], the
</dependency>
----
.Gradle
Gradle::
+
[source,groovy,role="secondary",subs="verbatim,attributes"]
----
depenendencies {
runtimeOnly "com.unboundid:unboundid-ldapsdk:{unboundid-ldapsdk-version}"
}
----
====
======
You can then configure the Embedded LDAP Server using an `EmbeddedLdapServerContextSourceFactoryBean`.
This will instruct Spring Security to start an in-memory LDAP server.
.Embedded LDAP Server Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -132,7 +137,8 @@ public EmbeddedLdapServerContextSourceFactoryBean contextSourceFactoryBean() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -140,14 +146,16 @@ fun contextSourceFactoryBean(): EmbeddedLdapServerContextSourceFactoryBean {
return EmbeddedLdapServerContextSourceFactoryBean.fromEmbeddedLdapServer()
}
----
====
======
Alternatively, you can manually configure the Embedded LDAP Server.
If you choose this approach, you will be responsible for managing the lifecycle of the Embedded LDAP Server.
.Explicit Embedded LDAP Server Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -157,7 +165,8 @@ UnboundIdContainer ldapContainer() {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<b:bean class="org.springframework.security.ldap.server.UnboundIdContainer"
@ -165,7 +174,8 @@ UnboundIdContainer ldapContainer() {
c:ldif="classpath:users.ldif"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -173,7 +183,7 @@ fun ldapContainer(): UnboundIdContainer {
return UnboundIdContainer("dc=springframework,dc=org","classpath:users.ldif")
}
----
====
======
[[servlet-authentication-ldap-apacheds]]
=== Embedded ApacheDS Server
@ -188,8 +198,10 @@ Once a stable release of ApacheDS 2.x is available, we will consider updating.
If you wish to use https://directory.apache.org/apacheds/[Apache DS], then specify the following dependencies:
.ApacheDS Dependencies
====
.Maven
[tabs]
======
Maven::
+
[source,xml,role="primary",subs="+attributes"]
----
<dependency>
@ -206,7 +218,8 @@ If you wish to use https://directory.apache.org/apacheds/[Apache DS], then speci
</dependency>
----
.Gradle
Gradle::
+
[source,groovy,role="secondary",subs="+attributes"]
----
depenendencies {
@ -214,13 +227,15 @@ depenendencies {
runtimeOnly "org.apache.directory.server:apacheds-server-jndi:{apacheds-core-version}"
}
----
====
======
You can then configure the Embedded LDAP Server
.Embedded LDAP Server Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -230,7 +245,8 @@ ApacheDSContainer ldapContainer() {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<b:bean class="org.springframework.security.ldap.server.ApacheDSContainer"
@ -238,7 +254,8 @@ ApacheDSContainer ldapContainer() {
c:ldif="classpath:users.ldif"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -246,7 +263,7 @@ fun ldapContainer(): ApacheDSContainer {
return ApacheDSContainer("dc=springframework,dc=org", "classpath:users.ldif")
}
----
====
======
[[servlet-authentication-ldap-contextsource]]
== LDAP ContextSource
@ -256,8 +273,10 @@ This is done by creating an LDAP `ContextSource`, which is the equivalent of a J
If you have already configured an `EmbeddedLdapServerContextSourceFactoryBean`, Spring Security will create an LDAP `ContextSource` that points to the embedded LDAP server.
.LDAP Context Source with Embedded LDAP Server
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -269,7 +288,8 @@ public EmbeddedLdapServerContextSourceFactoryBean contextSourceFactoryBean() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -279,13 +299,15 @@ fun contextSourceFactoryBean(): EmbeddedLdapServerContextSourceFactoryBean {
return contextSourceFactoryBean
}
----
====
======
Alternatively, you can explicitly configure the LDAP `ContextSource` to connect to the supplied LDAP server.
.LDAP Context Source
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
ContextSource contextSource(UnboundIdContainer container) {
@ -293,21 +315,23 @@ ContextSource contextSource(UnboundIdContainer container) {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<ldap-server
url="ldap://localhost:53389/dc=springframework,dc=org" />
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
fun contextSource(container: UnboundIdContainer): ContextSource {
return DefaultSpringSecurityContextSource("ldap://localhost:53389/dc=springframework,dc=org")
}
----
====
======
[[servlet-authentication-ldap-authentication]]
== Authentication
@ -336,8 +360,10 @@ The advantage to using bind authentication is that the user's secrets (i.e. pass
An example of bind authentication configuration can be found below.
.Bind Authentication
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
@Bean
@ -348,14 +374,16 @@ AuthenticationManager authenticationManager(BaseLdapPathContextSource contextSou
}
----
.XML
XML::
+
[source,xml,role="secondary",attrs="-attributes"]
----
<ldap-authentication-provider
user-dn-pattern="uid={0},ou=people"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
@Bean
@ -365,15 +393,17 @@ fun authenticationManager(contextSource: BaseLdapPathContextSource): Authenticat
return factory.createAuthenticationManager()
}
----
====
======
This simple example would obtain the DN for the user by substituting the user login name in the supplied pattern and attempting to bind as that user with the login password.
This is OK if all your users are stored under a single node in the directory.
If instead you wished to configure an LDAP search filter to locate the user, you could use the following:
.Bind Authentication with Search Filter
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
@Bean
@ -385,7 +415,8 @@ AuthenticationManager authenticationManager(BaseLdapPathContextSource contextSou
}
----
.XML
XML::
+
[source,xml,role="secondary",attrs="-attributes"]
----
<ldap-authentication-provider
@ -393,7 +424,8 @@ AuthenticationManager authenticationManager(BaseLdapPathContextSource contextSou
user-search-base="ou=people"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
@Bean
@ -404,7 +436,7 @@ fun authenticationManager(contextSource: BaseLdapPathContextSource): Authenticat
return factory.createAuthenticationManager()
}
----
====
======
If used with the `ContextSource` <<servlet-authentication-ldap-contextsource,definition above>>, this would perform a search under the DN `ou=people,dc=springframework,dc=org` using `+(uid={0})+` as a filter.
Again the user login name is substituted for the parameter in the filter name, so it will search for an entry with the `uid` attribute equal to the user name.
@ -418,8 +450,10 @@ This can either be done by retrieving the value of the password attribute and ch
An LDAP compare cannot be done when the password is properly hashed with a random salt.
.Minimal Password Compare Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -431,7 +465,8 @@ AuthenticationManager authenticationManager(BaseLdapPathContextSource contextSou
}
----
.XML
XML::
+
[source,xml,role="secondary",attrs="-attributes"]
----
<ldap-authentication-provider
@ -440,7 +475,8 @@ AuthenticationManager authenticationManager(BaseLdapPathContextSource contextSou
</ldap-authentication-provider>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -452,13 +488,15 @@ fun authenticationManager(contextSource: BaseLdapPathContextSource?): Authentica
return factory.createAuthenticationManager()
}
----
====
======
A more advanced configuration with some customizations can be found below.
.Password Compare Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -471,7 +509,8 @@ AuthenticationManager authenticationManager(BaseLdapPathContextSource contextSou
}
----
.XML
XML::
+
[source,xml,role="secondary",attrs="-attributes"]
----
<ldap-authentication-provider
@ -484,7 +523,8 @@ AuthenticationManager authenticationManager(BaseLdapPathContextSource contextSou
class="org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder" />
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -497,7 +537,7 @@ fun authenticationManager(contextSource: BaseLdapPathContextSource): Authenticat
return factory.createAuthenticationManager()
}
----
====
======
<1> Specify the password attribute as `pwd`
@ -506,8 +546,10 @@ fun authenticationManager(contextSource: BaseLdapPathContextSource): Authenticat
Spring Security's `LdapAuthoritiesPopulator` is used to determine what authorites are returned for the user.
.LdapAuthoritiesPopulator Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
@Bean
@ -528,7 +570,8 @@ AuthenticationManager authenticationManager(BaseLdapPathContextSource contextSou
}
----
.XML
XML::
+
[source,xml,role="secondary",attrs="-attributes"]
----
<ldap-authentication-provider
@ -536,7 +579,8 @@ AuthenticationManager authenticationManager(BaseLdapPathContextSource contextSou
group-search-filter="member={0}"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
@Bean
@ -557,7 +601,7 @@ fun authenticationManager(
return factory.createAuthenticationManager()
}
----
====
======
== Active Directory
@ -571,8 +615,10 @@ This is not currently supported, but hopefully will be in a future version.].
An example configuration can be seen below:
.Example Active Directory Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -581,7 +627,8 @@ ActiveDirectoryLdapAuthenticationProvider authenticationProvider() {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<bean id="authenticationProvider"
@ -591,7 +638,8 @@ ActiveDirectoryLdapAuthenticationProvider authenticationProvider() {
</bean>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -599,4 +647,4 @@ fun authenticationProvider(): ActiveDirectoryLdapAuthenticationProvider {
return ActiveDirectoryLdapAuthenticationProvider("example.com", "ldap://company.example.com/")
}
----
====
======

14
docs/modules/ROOT/pages/servlet/authentication/passwords/user-details-service.adoc
View File

@ -10,8 +10,10 @@ For example, the following will customize authentication assuming that `CustomUs
NOTE: This is only used if the `AuthenticationManagerBuilder` has not been populated and no `AuthenticationProviderBean` is defined.
.Custom UserDetailsService Bean
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -20,18 +22,20 @@ CustomUserDetailsService customUserDetailsService() {
}
----
.XML
XML::
+
[source,java,role="secondary"]
----
<b:bean class="example.CustomUserDetailsService"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
fun customUserDetailsService() = CustomUserDetailsService()
----
====
======
// FIXME: Add CustomUserDetails example with links to @AuthenticationPrincipal

28
docs/modules/ROOT/pages/servlet/authentication/persistence.adoc
View File

@ -25,7 +25,6 @@ Location: /login
The user submits their username and password.
.Username and Password Submitted
====
[source,http]
----
POST /login HTTP/1.1
@ -34,31 +33,26 @@ Cookie: SESSION=91470ce0-3f3c-455b-b7ad-079b02290f7b
username=user&password=password&_csrf=35942e65-a172-4cd4-a1d4-d16a51147b3e
----
====
Upon authenticating the user, the user is associated to a new session id to prevent xref:servlet/authentication/session-management.adoc#ns-session-fixation[session fixation attacks].
.Authenticated User is Associated to New Session
====
[source,http]
----
HTTP/1.1 302 Found
Location: /
Set-Cookie: SESSION=4c66e474-3f5a-43ed-8e48-cc1d8cb1d1c8; Path=/; HttpOnly; SameSite=Lax
----
====
Subsequent requests include the session cookie which is used to authenticate the user for the remainder of the session.
.Authenticated Session Provided as Credentials
====
[source,http]
----
GET / HTTP/1.1
Host: example.com
Cookie: SESSION=4c66e474-3f5a-43ed-8e48-cc1d8cb1d1c8
----
====
[[securitycontextrepository]]
@ -89,8 +83,10 @@ When the error dispatch is made, there is no `SecurityContext` established.
This means that the error page cannot use the `SecurityContext` for authorization or displaying the current user unless the `SecurityContext` is persisted somehow.
.Use RequestAttributeSecurityContextRepository
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public SecurityFilterChain filterChain(HttpSecurity http) {
@ -103,7 +99,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http security-context-repository-ref="contextRepository">
@ -112,7 +109,7 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
<b:bean name="contextRepository"
class="org.springframework.security.web.context.RequestAttributeSecurityContextRepository" />
----
====
======
[[securitycontextpersistencefilter]]
@ -151,8 +148,10 @@ Unlike, xref:servlet/authentication/persistence.adoc#securitycontextpersistencef
This means that when using `SecurityContextHolderFilter`, it is required that the `SecurityContext` is explicitly saved.
.Explicit Saving of SecurityContext
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public SecurityFilterChain filterChain(HttpSecurity http) {
@ -165,11 +164,12 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http security-context-explicit-save="true">
<!-- ... -->
</http>
----
====
======

11
docs/modules/ROOT/pages/servlet/authentication/preauth.adoc
View File

@ -30,8 +30,10 @@ This class will check the current contents of the security context and, if empty
Subclasses override the following methods to obtain this information:
.Override AbstractPreAuthenticatedProcessingFilter
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
protected abstract Object getPreAuthenticatedPrincipal(HttpServletRequest request);
@ -39,14 +41,15 @@ protected abstract Object getPreAuthenticatedPrincipal(HttpServletRequest reques
protected abstract Object getPreAuthenticatedCredentials(HttpServletRequest request);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
protected abstract fun getPreAuthenticatedPrincipal(request: HttpServletRequest): Any?
protected abstract fun getPreAuthenticatedCredentials(request: HttpServletRequest): Any?
----
====
======
After calling these, the filter will create a `PreAuthenticatedAuthenticationToken` containing the returned data and submit it for authentication.

66
docs/modules/ROOT/pages/servlet/authentication/session-management.adoc
View File

@ -9,8 +9,10 @@ Typical usage includes session-fixation protection attack prevention, detection
At times it can be valuable to eagerly create sessions.
This can be done by using the {security-api-url}org/springframework/security/web/session/ForceEagerSessionCreationFilter.html[`ForceEagerSessionCreationFilter`] which can be configured using:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -23,21 +25,24 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http create-session="ALWAYS">
</http>
----
====
======
== Detecting Timeouts
You can configure Spring Security to detect the submission of an invalid session ID and redirect the user to an appropriate URL.
This is achieved through the `session-management` element:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -50,7 +55,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -58,14 +64,16 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
<session-management invalid-session-url="/invalidSession.htm" />
</http>
----
====
======
Note that if you use this mechanism to detect session timeouts, it may falsely report an error if the user logs out and then logs back in without closing the browser.
This is because the session cookie is not cleared when you invalidate the session and will be resubmitted even if the user has logged out.
You may be able to explicitly delete the JSESSIONID cookie on logging out, for example by using the following syntax in the logout handler:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -78,14 +86,15 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
<logout delete-cookies="JSESSIONID" />
</http>
----
====
======
Unfortunately this can't be guaranteed to work with every servlet container, so you will need to test it in your environment
@ -109,8 +118,10 @@ Header always set Set-Cookie "JSESSIONID=;Path=/tutorial;Expires=Thu, 01 Jan 197
If you wish to place constraints on a single user's ability to log in to your application, Spring Security supports this out of the box with the following simple additions.
First, you need to add the following listener to your configuration to keep Spring Security updated about session lifecycle events:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -119,7 +130,8 @@ public HttpSessionEventPublisher httpSessionEventPublisher() {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<listener>
@ -128,12 +140,14 @@ public HttpSessionEventPublisher httpSessionEventPublisher() {
</listener-class>
</listener>
----
====
======
Then add the following lines to your application context:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -146,7 +160,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -156,14 +171,16 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
</session-management>
</http>
----
====
======
This will prevent a user from logging in multiple times - a second login will cause the first to be invalidated.
Often you would prefer to prevent a second login, in which case you can use
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -177,7 +194,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -186,7 +204,7 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
</session-management>
</http>
----
====
======
The second login will then be rejected.

11
docs/modules/ROOT/pages/servlet/authorization/acls.adoc
View File

@ -148,8 +148,10 @@ We do not intend to support non-long identifiers in Spring Security's ACL module
The following fragment of code shows how to create an `Acl`, or modify an existing `Acl`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Prepare the information we'd like in our access control entry (ACE)
@ -170,7 +172,8 @@ acl.insertAce(acl.getEntries().length, p, sid, true);
aclService.updateAcl(acl);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val oi: ObjectIdentity = ObjectIdentityImpl(Foo::class.java, 44)
@ -189,7 +192,7 @@ aclService.createAcl(oi)
acl!!.insertAce(acl.entries.size, p, sid, true)
aclService.updateAcl(acl)
----
====
======
In the example above, we're retrieving the ACL associated with the "Foo" domain object with identifier number 44.

27
docs/modules/ROOT/pages/servlet/authorization/architecture.adoc
View File

@ -110,8 +110,10 @@ In some cases, like migrating an older application, it may be desirable to intro
To call an existing `AccessDecisionManager`, you can do:
.Adapting an AccessDecisionManager
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Component
@ -137,15 +139,17 @@ public class AccessDecisionManagerAuthorizationManagerAdapter implements Authori
}
}
----
====
======
And then wire it into your `SecurityFilterChain`.
Or to only call an `AccessDecisionVoter`, you can do:
.Adapting an AccessDecisionVoter
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Component
@ -167,7 +171,7 @@ public class AccessDecisionVoterAuthorizationManagerAdapter implements Authoriza
}
}
----
====
======
And then wire it into your `SecurityFilterChain`.
@ -184,8 +188,10 @@ An extended version of Spring Security's `RoleVoter`, `RoleHierarchyVoter`, is c
A typical configuration might look like this:
.Hierarchical Roles Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -198,7 +204,8 @@ AccessDecisionVoter hierarchyVoter() {
}
----
.Xml
Xml::
+
[source,java,role="secondary"]
----
@ -216,7 +223,7 @@ AccessDecisionVoter hierarchyVoter() {
</property>
</bean>
----
====
======
Here we have four roles in a hierarchy `ROLE_ADMIN => ROLE_STAFF => ROLE_USER => ROLE_GUEST`.
A user who is authenticated with `ROLE_ADMIN`, will behave as if they have all four roles when security constraints are evaluated against an `AuthorizationManager` adapted to call the above `RoleHierarchyVoter`.

52
docs/modules/ROOT/pages/servlet/authorization/authorize-http-requests.adoc
View File

@ -16,8 +16,10 @@ You can override the default when you declare a `SecurityFilterChain`.
Instead of using xref:servlet/authorization/authorize-http-requests.adoc#servlet-authorize-requests-defaults[`authorizeRequests`], use `authorizeHttpRequests`, like so:
.Use authorizeHttpRequests
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -31,7 +33,7 @@ SecurityFilterChain web(HttpSecurity http) throws AuthenticationException {
return http.build();
}
----
====
======
This improves on `authorizeRequests` in a number of ways:
@ -56,8 +58,10 @@ In this case the xref:servlet/architecture.adoc#servlet-exceptiontranslationfilt
We can configure Spring Security to have different rules by adding more rules in order of precedence.
.Authorize Requests
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -78,7 +82,7 @@ SecurityFilterChain web(HttpSecurity http) throws Exception {
return http.build();
}
----
====
======
<1> There are multiple authorization rules specified.
Each rule is considered in the order they were declared.
<2> We specified multiple URL patterns that any user can access.
@ -93,8 +97,10 @@ This is a good strategy if you do not want to accidentally forget to update your
You can take a bean-based approach by constructing your own xref:servlet/authorization/architecture.adoc#authz-delegate-authorization-manager[`RequestMatcherDelegatingAuthorizationManager`] like so:
.Configure RequestMatcherDelegatingAuthorizationManager
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -128,15 +134,17 @@ AuthorizationManager<RequestAuthorizationContext> requestMatcherAuthorizationMan
return (context) -> manager.check(context.getRequest());
}
----
====
======
You can also wire xref:servlet/authorization/architecture.adoc#authz-custom-authorization-manager[your own custom authorization managers] for any request matcher.
Here is an example of mapping a custom authorization manager to the `my/authorized/endpoint`:
.Custom Authorization Manager
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -150,13 +158,15 @@ SecurityFilterChain web(HttpSecurity http) throws Exception {
return http.build();
}
----
====
======
Or you can provide it for all requests as seen below:
.Custom Authorization Manager for All Requests
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -170,14 +180,16 @@ SecurityFilterChain web(HttpSecurity http) throws Exception {
return http.build();
}
----
====
======
By default, the `AuthorizationFilter` does not apply to `DispatcherType.ERROR` and `DispatcherType.ASYNC`.
We can configure Spring Security to apply the authorization rules to all dispatcher types by using the `shouldFilterAllDispatcherTypes` method:
.Set shouldFilterAllDispatcherTypes to true
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -192,7 +204,9 @@ SecurityFilterChain web(HttpSecurity http) throws Exception {
return http.build();
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -206,4 +220,4 @@ open fun web(http: HttpSecurity): SecurityFilterChain {
return http.build()
}
----
====
======

28
docs/modules/ROOT/pages/servlet/authorization/authorize-requests.adoc
View File

@ -30,8 +30,10 @@ The explicit configuration looks like:
[[servlet-authorize-requests-defaults]]
.Every Request Must be Authenticated
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -45,7 +47,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -54,7 +57,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -68,13 +72,15 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
return http.build()
}
----
====
======
We can configure Spring Security to have different rules by adding more rules in order of precedence.
.Authorize Requests
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -91,7 +97,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http> <!--1-->
@ -107,7 +114,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -126,7 +134,7 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
return http.build()
}
----
====
======
<1> There are multiple authorization rules specified.
Each rule is considered in the order they were declared.
<2> We specified multiple URL patterns that any user can access.

33
docs/modules/ROOT/pages/servlet/authorization/events.adoc
View File

@ -9,8 +9,10 @@ To listen for these events, you must first publish an `AuthorizationEventPublish
Spring Security's `SpringAuthorizationEventPublisher` will probably do fine.
It comes publishes authorization events using Spring's `ApplicationEventPublisher`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -20,7 +22,8 @@ public AuthorizationEventPublisher authorizationEventPublisher
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -29,12 +32,14 @@ fun authorizationEventPublisher
return SpringAuthorizationEventPublisher(applicationEventPublisher)
}
----
====
======
Then, you can use Spring's `@EventListener` support:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Component
@ -47,7 +52,8 @@ public class AuthenticationEvents {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Component
@ -59,7 +65,7 @@ class AuthenticationEvents {
}
}
----
====
======
[[authorization-granted-events]]
== Authorization Granted Events
@ -71,8 +77,10 @@ In fact, publishing these events will likely require some business logic on your
You can create your own event publisher that filters success events.
For example, the following publisher only publishes authorization grants where `ROLE_ADMIN` was required:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Component
@ -117,7 +125,8 @@ public class MyAuthorizationEventPublisher implements AuthorizationEventPublishe
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Component
@ -157,4 +166,4 @@ class MyAuthorizationEventPublisher(val publisher: ApplicationEventPublisher,
}
}
----
====
======

127
docs/modules/ROOT/pages/servlet/authorization/expression-based.adoc
View File

@ -114,8 +114,10 @@ So if you aren't using the namespace and want to use expressions, you will have
If you wish to extend the expressions that are available, you can easily refer to any Spring Bean you expose.
For example, assuming you have a Bean with the name of `webSecurity` that contains the following method signature:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class WebSecurity {
@ -125,7 +127,8 @@ public class WebSecurity {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class WebSecurity {
@ -134,13 +137,15 @@ class WebSecurity {
}
}
----
====
======
You could refer to the method using:
.Refer to method
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
http
@ -150,7 +155,8 @@ http
)
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -160,7 +166,8 @@ http
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
http {
@ -169,7 +176,7 @@ http {
}
}
----
====
======
[[el-access-web-path-variables]]
=== Path Variables in Web Security Expressions
@ -180,8 +187,10 @@ For example, consider a RESTful application that looks up a user by id from the
You can easily refer to the path variable by placing it in the pattern.
For example, if you had a Bean with the name of `webSecurity` that contains the following method signature:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class WebSecurity {
@ -191,7 +200,8 @@ public class WebSecurity {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class WebSecurity {
@ -200,13 +210,15 @@ class WebSecurity {
}
}
----
====
======
You could refer to the method using:
.Path Variables
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
http
@ -216,7 +228,8 @@ http
);
----
.XML
XML::
+
[source,xml,role="secondary",attrs="-attributes"]
----
<http>
@ -226,7 +239,8 @@ http
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
http {
@ -235,7 +249,7 @@ http {
}
}
----
====
======
In this configuration URLs that match would pass in the path variable (and convert it) into checkUserId method.
For example, if the URL were `/user/123/resource`, then the id passed in would be `123`.
@ -260,41 +274,47 @@ Their use is enabled through the `global-method-security` namespace element:
The most obviously useful annotation is `@PreAuthorize` which decides whether a method can actually be invoked or not.
For example (from the {gh-samples-url}/servlet/xml/java/contacts[Contacts] sample application)
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@PreAuthorize("hasRole('USER')")
public void create(Contact contact);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@PreAuthorize("hasRole('USER')")
fun create(contact: Contact?)
----
====
======
which means that access will only be allowed for users with the role "ROLE_USER".
Obviously the same thing could easily be achieved using a traditional configuration and a simple configuration attribute for the required role.
But what about:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@PreAuthorize("hasPermission(#contact, 'admin')")
public void deletePermission(Contact contact, Sid recipient, Permission permission);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@PreAuthorize("hasPermission(#contact, 'admin')")
fun deletePermission(contact: Contact?, recipient: Sid?, permission: Permission?)
----
====
======
Here we're actually using a method argument as part of the expression to decide whether the current user has the "admin" permission for the given contact.
The built-in `hasPermission()` expression is linked into the Spring Security ACL module through the application context, as we'll <<el-permission-evaluator,see below>>.
@ -310,8 +330,10 @@ For example:
+
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import org.springframework.security.access.method.P;
@ -322,7 +344,8 @@ import org.springframework.security.access.method.P;
public void doSomething(@P("c") Contact contact);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.security.access.method.P
@ -332,7 +355,7 @@ import org.springframework.security.access.method.P
@PreAuthorize("#c.name == authentication.name")
fun doSomething(@P("c") contact: Contact?)
----
====
======
+
@ -344,8 +367,10 @@ For example:
+
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import org.springframework.data.repository.query.Param;
@ -356,7 +381,8 @@ import org.springframework.data.repository.query.Param;
Contact findContactByName(@Param("n") String name);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.data.repository.query.Param
@ -366,7 +392,7 @@ import org.springframework.data.repository.query.Param
@PreAuthorize("#n == authentication.name")
fun findContactByName(@Param("n") name: String?): Contact?
----
====
======
+
@ -385,21 +411,24 @@ Any Spring-EL functionality is available within the expression, so you can also
For example, if you wanted a particular method to only allow access to a user whose username matched that of the contact, you could write
--
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@PreAuthorize("#contact.name == authentication.name")
public void doSomething(Contact contact);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@PreAuthorize("#contact.name == authentication.name")
fun doSomething(contact: Contact?)
----
====
======
Here we are accessing another built-in expression, `authentication`, which is the `Authentication` stored in the security context.
You can also access its "principal" property directly, using the expression `principal`.
@ -417,8 +446,10 @@ Spring Security supports filtering of collections, arrays, maps and streams usin
This is most commonly performed on the return value of a method.
For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@PreAuthorize("hasRole('USER')")
@ -426,14 +457,15 @@ For example:
public List<Contact> getAll();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@PreAuthorize("hasRole('USER')")
@PostFilter("hasPermission(filterObject, 'read') or hasPermission(filterObject, 'admin')")
fun getAll(): List<Contact?>
----
====
======
When using the `@PostFilter` annotation, Spring Security iterates through the returned collection or map and removes any elements for which the supplied expression is false.
For an array, a new array instance will be returned containing filtered elements.
@ -507,8 +539,10 @@ For example, consider the following:
Instead of repeating this everywhere, we can create a meta annotation that can be used instead.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Retention(RetentionPolicy.RUNTIME)
@ -516,14 +550,15 @@ Instead of repeating this everywhere, we can create a meta annotation that can b
public @interface ContactPermission {}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Retention(AnnotationRetention.RUNTIME)
@PreAuthorize("#contact.name == authentication.name")
annotation class ContactPermission
----
====
======
Meta annotations can be used for any of the Spring Security method security annotations.
In order to remain compliant with the specification JSR-250 annotations do not support meta annotations.

250
docs/modules/ROOT/pages/servlet/authorization/method-security.adoc
View File

@ -28,8 +28,10 @@ For earlier versions, please read about similar support with <<jc-enable-global-
For example, the following would enable Spring Security's `@PreAuthorize` annotation:
.Method Security Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableMethodSecurity
@ -38,7 +40,8 @@ public class MethodSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableMethodSecurity
@ -47,20 +50,23 @@ class MethodSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<sec:method-security/>
----
====
======
Adding an annotation to a method (on a class or interface) would then limit the access to that method accordingly.
Spring Security's native annotation support defines a set of attributes for the method.
These will be passed to the `DefaultAuthorizationMethodInterceptorChain` for it to make the actual decision:
.Method Security Annotation Usage
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public interface BankService {
@ -75,7 +81,8 @@ public interface BankService {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
interface BankService {
@ -89,13 +96,15 @@ interface BankService {
fun post(account : Account, amount : Double) : Account
}
----
====
======
You can enable support for Spring Security's `@Secured` annotation using:
.@Secured Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableMethodSecurity(securedEnabled = true)
@ -104,7 +113,8 @@ public class MethodSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableMethodSecurity(securedEnabled = true)
@ -113,18 +123,21 @@ class MethodSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<sec:method-security secured-enabled="true"/>
----
====
======
or JSR-250 using:
.JSR-250 Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableMethodSecurity(jsr250Enabled = true)
@ -133,7 +146,8 @@ public class MethodSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableMethodSecurity(jsr250Enabled = true)
@ -142,12 +156,13 @@ class MethodSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<sec:method-security jsr250-enabled="true"/>
----
====
======
=== Customizing Authorization
@ -157,8 +172,10 @@ Spring Security's `@PreAuthorize`, `@PostAuthorize`, `@PreFilter`, and `@PostFil
If you need to customize the way that expressions are handled, you can expose a custom `MethodSecurityExpressionHandler`, like so:
.Custom MethodSecurityExpressionHandler
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -169,7 +186,8 @@ static MethodSecurityExpressionHandler methodSecurityExpressionHandler() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
companion object {
@ -182,7 +200,8 @@ companion object {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<sec:method-security>
@ -194,7 +213,7 @@ companion object {
<property name="trustResolver" ref="myCustomTrustResolver"/>
</bean>
----
====
======
[TIP]
====
@ -207,8 +226,10 @@ Also, for role-based authorization, Spring Security adds a default `ROLE_` prefi
You can configure the authorization rules to use a different prefix by exposing a `GrantedAuthorityDefaults` bean, like so:
.Custom MethodSecurityExpressionHandler
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -217,7 +238,8 @@ static GrantedAuthorityDefaults grantedAuthorityDefaults() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
companion object {
@ -228,7 +250,8 @@ companion object {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<sec:method-security/>
@ -237,7 +260,7 @@ companion object {
<constructor-arg value="MYPREFIX_"/>
</bean>
----
====
======
[TIP]
====
@ -260,8 +283,10 @@ If that authorization denies access, the value is not returned, and an `AccessDe
To recreate what adding `@EnableMethodSecurity` does by default, you would publish the following configuration:
.Full Pre-post Method Security Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableMethodSecurity(prePostEnabled = false)
@ -292,7 +317,8 @@ class MethodSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableMethodSecurity(prePostEnabled = false)
@ -323,7 +349,8 @@ class MethodSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<sec:method-security pre-post-enabled="false"/>
@ -341,15 +368,17 @@ class MethodSecurityConfig {
<bean id="postFilterAuthorizationMethodInterceptor"
class="org.springframework.security.authorization.method.PostFilterAuthorizationMethodInterceptor"/>
----
====
======
Notice that Spring Security's method security is built using Spring AOP.
So, interceptors are invoked based on the order specified.
This can be customized by calling `setOrder` on the interceptor instances like so:
.Publish Custom Advisor
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -361,7 +390,8 @@ Advisor postFilterAuthorizationMethodInterceptor() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -373,7 +403,8 @@ fun postFilterAuthorizationMethodInterceptor() : Advisor {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<bean id="postFilterAuthorizationMethodInterceptor"
@ -382,14 +413,16 @@ fun postFilterAuthorizationMethodInterceptor() : Advisor {
value="#{T(org.springframework.security.authorization.method.AuthorizationInterceptorsOrder).POST_AUTHORIZE.getOrder() -1}"/>
</bean>
----
====
======
You may want to only support `@PreAuthorize` in your application, in which case you can do the following:
.Only @PreAuthorize Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableMethodSecurity(prePostEnabled = false)
@ -402,7 +435,8 @@ class MethodSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableMethodSecurity(prePostEnabled = false)
@ -415,7 +449,8 @@ class MethodSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<sec:method-security pre-post-enabled="false"/>
@ -426,7 +461,7 @@ class MethodSecurityConfig {
class="org.springframework.security.authorization.method.AuthorizationManagerBeforeMethodInterceptor"
factory-method="preAuthorize"/>
----
====
======
Or, you may have a custom before-method `AuthorizationManager` that you want to add to the list.
@ -435,9 +470,11 @@ In this case, you will need to tell Spring Security both the `AuthorizationManag
Thus, you can configure Spring Security to invoke your `AuthorizationManager` in between `@PreAuthorize` and `@PostAuthorize` like so:
.Custom Before Advisor
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableMethodSecurity
@ -455,7 +492,8 @@ class MethodSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableMethodSecurity
@ -473,7 +511,8 @@ class MethodSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<sec:method-security/>
@ -495,7 +534,7 @@ class MethodSecurityConfig {
value="#{T(org.springframework.security.authorization.method.AuthorizationInterceptorsOrder).PRE_AUTHORIZE_ADVISOR_ORDER.getOrder() + 1}"/>
</bean>
----
====
======
[TIP]
====
@ -508,8 +547,10 @@ After-method authorization is generally concerned with analysing the return valu
For example, you might have a method that confirms that the account requested actually belongs to the logged-in user like so:
.@PostAuthorize example
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public interface BankService {
@ -520,7 +561,8 @@ public interface BankService {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
interface BankService {
@ -530,7 +572,7 @@ interface BankService {
fun readAccount(id : Long) : Account
}
----
====
======
You can supply your own `AuthorizationMethodInterceptor` to customize how access to the return value is evaluated.
@ -538,8 +580,10 @@ For example, if you have your own custom annotation, you can configure it like s
.Custom After Advisor
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableMethodSecurity
@ -555,7 +599,8 @@ class MethodSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableMethodSecurity
@ -571,7 +616,8 @@ class MethodSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<sec:method-security/>
@ -593,7 +639,7 @@ class MethodSecurityConfig {
value="#{T(org.springframework.security.authorization.method.AuthorizationInterceptorsOrder).PRE_AUTHORIZE_ADVISOR_ORDER.getOrder() + 1}"/>
</bean>
----
====
======
and it will be invoked after the `@PostAuthorize` interceptor.
@ -603,8 +649,10 @@ and it will be invoked after the `@PostAuthorize` interceptor.
We can enable annotation-based security using the `@EnableGlobalMethodSecurity` annotation on any `@Configuration` instance.
For example, the following would enable Spring Security's `@Secured` annotation.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableGlobalMethodSecurity(securedEnabled = true)
@ -613,7 +661,8 @@ public class MethodSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableGlobalMethodSecurity(securedEnabled = true)
@ -621,14 +670,16 @@ open class MethodSecurityConfig {
// ...
}
----
====
======
Adding an annotation to a method (on a class or interface) would then limit the access to that method accordingly.
Spring Security's native annotation support defines a set of attributes for the method.
These will be passed to the AccessDecisionManager for it to make the actual decision:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public interface BankService {
@ -644,7 +695,8 @@ public Account post(Account account, double amount);
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
interface BankService {
@ -658,12 +710,14 @@ interface BankService {
fun post(account: Account, amount: Double): Account
}
----
====
======
Support for JSR-250 annotations can be enabled using
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableGlobalMethodSecurity(jsr250Enabled = true)
@ -672,7 +726,8 @@ public class MethodSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableGlobalMethodSecurity(jsr250Enabled = true)
@ -680,13 +735,15 @@ open class MethodSecurityConfig {
// ...
}
----
====
======
These are standards-based and allow simple role-based constraints to be applied but do not have the power Spring Security's native annotations.
To use the new expression-based syntax, you would use
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableGlobalMethodSecurity(prePostEnabled = true)
@ -695,7 +752,8 @@ public class MethodSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableGlobalMethodSecurity(prePostEnabled = true)
@ -703,12 +761,14 @@ open class MethodSecurityConfig {
// ...
}
----
====
======
and the equivalent Java code would be
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public interface BankService {
@ -724,7 +784,8 @@ public Account post(Account account, double amount);
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
interface BankService {
@ -738,7 +799,7 @@ interface BankService {
fun post(account: Account, amount: Double): Account
}
----
====
======
== GlobalMethodSecurityConfiguration
@ -746,8 +807,10 @@ Sometimes you may need to perform operations that are more complicated than are
For these instances, you can extend the `GlobalMethodSecurityConfiguration` ensuring that the `@EnableGlobalMethodSecurity` annotation is present on your subclass.
For example, if you wanted to provide a custom `MethodSecurityExpressionHandler`, you could use the following configuration:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableGlobalMethodSecurity(prePostEnabled = true)
@ -760,7 +823,8 @@ public class MethodSecurityConfig extends GlobalMethodSecurityConfiguration {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableGlobalMethodSecurity(prePostEnabled = true)
@ -771,7 +835,7 @@ open class MethodSecurityConfig : GlobalMethodSecurityConfiguration() {
}
}
----
====
======
For additional information about methods that can be overridden, refer to the `GlobalMethodSecurityConfiguration` Javadoc.
@ -790,8 +854,10 @@ Adding an annotation to a method (on an class or interface) would then limit the
Spring Security's native annotation support defines a set of attributes for the method.
These will be passed to the `AccessDecisionManager` for it to make the actual decision:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public interface BankService {
@ -808,7 +874,8 @@ public Account post(Account account, double amount);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
interface BankService {
@ -822,7 +889,7 @@ interface BankService {
fun post(account: Account, amount: Double): Account
}
----
====
======
Support for JSR-250 annotations can be enabled using
@ -841,8 +908,10 @@ To use the new expression-based syntax, you would use
and the equivalent Java code would be
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public interface BankService {
@ -858,7 +927,8 @@ public Account post(Account account, double amount);
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
interface BankService {
@ -872,7 +942,7 @@ interface BankService {
fun post(account: Account, amount: Double): Account
}
----
====
======
Expression-based annotations are a good choice if you need to define simple rules that go beyond checking the role names against the user's list of authorities.

62
docs/modules/ROOT/pages/servlet/exploits/csrf.adoc
View File

@ -36,7 +36,6 @@ You can configure `CookieCsrfTokenRepository` in XML using the following:
.Store CSRF Token in a Cookie with XML Configuration
====
[source,xml]
----
<http>
@ -47,7 +46,6 @@ You can configure `CookieCsrfTokenRepository` in XML using the following:
class="org.springframework.security.web.csrf.CookieCsrfTokenRepository"
p:cookieHttpOnly="false"/>
----
====
[NOTE]
====
@ -60,8 +58,10 @@ If you do not need the ability to read the cookie with JavaScript directly, it i
You can configure `CookieCsrfTokenRepository` in Java Configuration using:
.Store CSRF Token in a Cookie
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -78,7 +78,8 @@ public class WebSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -95,7 +96,7 @@ class SecurityConfig {
}
}
----
====
======
[NOTE]
====
@ -113,7 +114,6 @@ The XML configuration below will disable CSRF protection.
.Disable CSRF XML Configuration
====
[source,xml]
----
<http>
@ -121,13 +121,14 @@ The XML configuration below will disable CSRF protection.
<csrf disabled="true"/>
</http>
----
====
The Java configuration below will disable CSRF protection.
.Disable CSRF
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Configuration
@ -143,7 +144,8 @@ public class WebSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Configuration
@ -161,7 +163,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-csrf-include]]
=== Include the CSRF Token
@ -179,14 +181,12 @@ In order to post an HTML form the CSRF token must be included in the form as a h
For example, the rendered HTML might look like:
.CSRF Token HTML
====
[source,html]
----
<input type="hidden"
name="_csrf"
value="4bfd1575-3ad1-4d21-96c7-4ef2d9f86721"/>
----
====
Next we will discuss various ways of including the CSRF token in a form as a hidden input.
@ -210,7 +210,6 @@ If the <<servlet-csrf-include,other options>> for including the actual CSRF toke
An example of doing this with a JSP is shown below:
.CSRF Token in Form with Request Attribute
====
[source,xml]
----
<c:url var="logoutUrl" value="/logout"/>
@ -223,7 +222,6 @@ An example of doing this with a JSP is shown below:
value="${_csrf.token}"/>
</form>
----
====
[[servlet-csrf-include-ajax]]
==== Ajax and JSON Requests
@ -245,7 +243,6 @@ An alternative pattern to <<servlet-csrf-include-form-auto,exposing the CSRF in
The HTML might look something like this:
.CSRF meta tag HTML
====
[source,html]
----
<html>
@ -256,13 +253,11 @@ The HTML might look something like this:
</head>
<!-- ... -->
----
====
Once the meta tags contained the CSRF token, the JavaScript code would read the meta tags and include the CSRF token as a header.
If you were using jQuery, this could be done with the following:
.AJAX send CSRF Token
====
[source,javascript]
----
$(function () {
@ -273,7 +268,6 @@ $(function () {
});
});
----
====
[[servlet-csrf-include-ajax-meta-tag]]
====== csrfMeta tag
@ -287,7 +281,6 @@ If the <<servlet-csrf-include,other options>> for including the actual CSRF toke
An example of doing this with a JSP is shown below:
.CSRF meta tag JSP
====
[source,html]
----
<html>
@ -299,7 +292,6 @@ An example of doing this with a JSP is shown below:
</head>
<!-- ... -->
----
====
[[servlet-csrf-considerations]]
== CSRF Considerations
@ -329,8 +321,10 @@ If you really want to use HTTP GET with logout you can do so, but remember this
For example, the following Java Configuration will perform logout with the URL `/logout` is requested with any HTTP method:
.Log out with HTTP GET
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -347,7 +341,8 @@ public class WebSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -364,7 +359,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-considerations-csrf-timeouts]]
@ -411,8 +406,10 @@ In general, this is the recommended approach because the temporary file upload s
To ensure `MultipartFilter` is specified before the Spring Security filter with java configuration, users can override beforeSpringSecurityFilterChain as shown below:
.Initializer MultipartFilter
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class SecurityApplicationInitializer extends AbstractSecurityWebApplicationInitializer {
@ -424,7 +421,8 @@ public class SecurityApplicationInitializer extends AbstractSecurityWebApplicati
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class SecurityApplicationInitializer : AbstractSecurityWebApplicationInitializer() {
@ -433,12 +431,11 @@ class SecurityApplicationInitializer : AbstractSecurityWebApplicationInitializer
}
}
----
====
======
To ensure `MultipartFilter` is specified before the Spring Security filter with XML configuration, users can ensure the <filter-mapping> element of the `MultipartFilter` is placed before the springSecurityFilterChain within the web.xml as shown below:
.web.xml - MultipartFilter
====
[source,xml]
----
<filter>
@ -458,7 +455,6 @@ To ensure `MultipartFilter` is specified before the Spring Security filter with
<url-pattern>/*</url-pattern>
</filter-mapping>
----
====
[[servlet-csrf-considerations-multipart-url]]
==== Include CSRF Token in URL
@ -468,14 +464,12 @@ Since the `CsrfToken` is exposed as an `HttpServletRequest` <<servlet-csrf-inclu
An example with a jsp is shown below
.CSRF Token in Action
====
[source,html]
----
<form method="post"
action="./upload?${_csrf.parameterName}=${_csrf.token}"
enctype="multipart/form-data">
----
====
[[servlet-csrf-considerations-override-method]]
=== HiddenHttpMethodFilter

63
docs/modules/ROOT/pages/servlet/exploits/firewall.adoc
View File

@ -46,8 +46,10 @@ However, it is important that you do so knowing that this can open your applicat
For example, if you wish to leverage Spring MVC's Matrix Variables, the following configuration could be used:
.Allow Matrix Variables
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -58,7 +60,8 @@ public StrictHttpFirewall httpFirewall() {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<b:bean id="httpFirewall"
@ -68,7 +71,8 @@ public StrictHttpFirewall httpFirewall() {
<http-firewall ref="httpFirewall"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -78,7 +82,7 @@ fun httpFirewall(): StrictHttpFirewall {
return firewall
}
----
====
======
The `StrictHttpFirewall` provides an allowed list of valid HTTP methods that are allowed to protect against https://owasp.org/www-community/attacks/Cross_Site_Tracing[Cross Site Tracing (XST)] and https://owasp.org/www-project-web-security-testing-guide/latest/4-Web_Application_Security_Testing/02-Configuration_and_Deployment_Management_Testing/06-Test_HTTP_Methods[HTTP Verb Tampering].
The default valid methods are "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", and "PUT".
@ -87,8 +91,10 @@ For example, the following will only allow HTTP "GET" and "POST" methods:
.Allow Only GET & POST
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -99,7 +105,8 @@ public StrictHttpFirewall httpFirewall() {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<b:bean id="httpFirewall"
@ -109,7 +116,8 @@ public StrictHttpFirewall httpFirewall() {
<http-firewall ref="httpFirewall"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -119,7 +127,7 @@ fun httpFirewall(): StrictHttpFirewall {
return firewall
}
----
====
======
[TIP]
====
@ -132,8 +140,8 @@ See https://jira.spring.io/browse/SPR-16851[SPR_16851] for an issue requesting t
If you must allow any HTTP method (not recommended), you can use `StrictHttpFirewall.setUnsafeAllowAnyHttpMethod(true)`.
This will disable validation of the HTTP method entirely.
[[servlet-httpfirewall-headers-parameters]]
[[servlet-httpfirewall-headers-parameters]]
`StrictHttpFirewall` also checks header names and values and parameter names.
It requires that each character have a defined code point and not be a control character.
@ -148,8 +156,10 @@ NOTE: Also, parameter values can be controlled with `setAllowedParameterValues(P
For example, to switch off this check, you can wire your `StrictHttpFirewall` with ``Predicate``s that always return `true`, like so:
.Allow Any Header Name, Header Value, and Parameter Name
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -162,7 +172,8 @@ public StrictHttpFirewall httpFirewall() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -174,7 +185,7 @@ fun httpFirewall(): StrictHttpFirewall {
return firewall
}
----
====
======
Or, there might be a specific value that you need to allow.
@ -184,8 +195,10 @@ Due to this fact, some application servers will parse this value into two separa
You can address this with the `setAllowedHeaderValues` method, as you can see below:
.Allow Certain User Agents
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -198,7 +211,8 @@ public StrictHttpFirewall httpFirewall() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -210,13 +224,15 @@ fun httpFirewall(): StrictHttpFirewall {
return firewall
}
----
====
======
In the case of header values, you may instead consider parsing them as UTF-8 at verification time like so:
.Parse Headers As UTF-8
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
firewall.setAllowedHeaderValues((header) -> {
@ -225,7 +241,8 @@ firewall.setAllowedHeaderValues((header) -> {
});
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
firewall.setAllowedHeaderValues {
@ -233,4 +250,4 @@ firewall.setAllowedHeaderValues {
return allowed.matcher(parsed).matches()
}
----
====
======

270
docs/modules/ROOT/pages/servlet/exploits/headers.adoc
View File

@ -16,8 +16,10 @@ For example, assume that you want the defaults except you wish to specify `SAMEO
You can easily do this with the following Configuration:
.Customize Default Security Headers
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -37,7 +39,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -49,7 +52,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -68,7 +72,7 @@ class SecurityConfig {
}
}
----
====
======
If you do not want the defaults to be added and want explicit control over what should be used, you can disable the defaults.
An example is provided below:
@ -76,8 +80,10 @@ An example is provided below:
If you are using Spring Security's Configuration the following will only add xref:features/exploits/headers.adoc#headers-cache-control[Cache Control].
.Customize Cache Control Headers
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -97,7 +103,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -109,7 +116,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -129,13 +137,15 @@ class SecurityConfig {
}
}
----
====
======
If necessary, you can disable all of the HTTP Security response headers with the following Configuration:
.Disable All HTTP Security Headers
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -151,7 +161,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -161,7 +172,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -178,7 +190,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-cache-control]]
== Cache Control
@ -194,8 +206,10 @@ Details on how to do this can be found in the https://docs.spring.io/spring/docs
If necessary, you can also disable Spring Security's cache control HTTP response headers.
.Cache Control Disabled
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Configuration
@ -214,7 +228,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -226,7 +241,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -245,7 +261,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-content-type-options]]
== Content Type Options
@ -254,8 +270,10 @@ Spring Security includes xref:features/exploits/headers.adoc#headers-content-typ
However, you can disable it with:
.Content Type Options Disabled
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Configuration
@ -274,7 +292,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -286,7 +305,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -305,7 +325,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-hsts]]
== HTTP Strict Transport Security (HSTS)
@ -315,8 +335,10 @@ However, you can customize the results explicitly.
For example, the following is an example of explicitly providing HSTS:
.Strict Transport Security
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -338,7 +360,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -353,7 +376,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -374,7 +398,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-hpkp]]
== HTTP Public Key Pinning (HPKP)
@ -383,8 +407,10 @@ For passivity reasons, Spring Security provides servlet support for xref:feature
You can enable HPKP headers with the following Configuration:
.HTTP Public Key Pinning
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -405,7 +431,9 @@ public class WebSecurityConfig {
}
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -424,7 +452,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -446,7 +475,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-frame-options]]
== X-Frame-Options
@ -456,8 +485,10 @@ By default, Spring Security disables rendering within an iframe using xref:featu
You can customize frame options to use the same origin within a Configuration using the following:
.X-Frame-Options: SAMEORIGIN
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -477,7 +508,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -491,7 +523,8 @@ public class WebSecurityConfig {
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -510,7 +543,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-xss-protection]]
== X-XSS-Protection
@ -520,8 +553,10 @@ However, you can change this default.
For example, the following Configuration specifies that Spring Security should no longer instruct browsers to block the content:
.X-XSS-Protection Customization
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -541,7 +576,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -553,7 +589,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -573,7 +610,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-csp]]
== Content Security Policy (CSP)
@ -584,18 +621,18 @@ The web application author must declare the security policy(s) to enforce and/or
For example, given the following security policy:
.Content Security Policy Example
====
[source,http]
----
Content-Security-Policy: script-src 'self' https://trustedscripts.example.com; object-src https://trustedplugins.example.com; report-uri /csp-report-endpoint/
----
====
You can enable the CSP header as shown below:
.Content Security Policy
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -615,7 +652,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -628,7 +666,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -648,13 +687,15 @@ class SecurityConfig {
}
}
----
====
======
To enable the CSP `report-only` header, provide the following configuration:
.Content Security Policy Report Only
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -675,7 +716,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -689,7 +731,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -710,7 +753,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-referrer]]
== Referrer Policy
@ -719,8 +762,10 @@ Spring Security does not add xref:features/exploits/headers.adoc#headers-referre
You can enable the Referrer Policy header using the configuration as shown below:
.Referrer Policy
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -740,7 +785,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -752,7 +798,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -772,7 +819,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-feature]]
== Feature Policy
@ -781,18 +828,18 @@ Spring Security does not add xref:features/exploits/headers.adoc#headers-feature
The following `Feature-Policy` header:
.Feature-Policy Example
====
[source]
----
Feature-Policy: geolocation 'self'
----
====
can enable the Feature Policy header using the configuration shown below:
.Feature-Policy
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -810,7 +857,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -822,7 +870,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -840,7 +889,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-permissions]]
== Permissions Policy
@ -849,18 +898,18 @@ Spring Security does not add xref:features/exploits/headers.adoc#headers-permiss
The following `Permissions-Policy` header:
.Permissions-Policy Example
====
[source]
----
Permissions-Policy: geolocation=(self)
----
====
can enable the Permissions Policy header using the configuration shown below:
.Permissions-Policy
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -880,7 +929,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -892,7 +942,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -912,7 +963,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-clear-site-data]]
== Clear Site Data
@ -921,17 +972,17 @@ Spring Security does not add xref:features/exploits/headers.adoc#headers-clear-s
The following Clear-Site-Data header:
.Clear-Site-Data Example
====
----
Clear-Site-Data: "cache", "cookies"
----
====
can be sent on log out with the following configuration:
.Clear-Site-Data
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -949,7 +1000,8 @@ public class WebSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -967,7 +1019,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-cross-origin-policies]]
== Cross-Origin Policies
@ -985,8 +1037,10 @@ Spring Security does not add <<headers-cross-origin-policies,Cross-Origin Polici
The headers can be added with the following configuration:
.Cross-Origin Policies
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -1002,7 +1056,9 @@ public class WebSecurityConfig {
}
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -1020,7 +1076,7 @@ open class CrossOriginPoliciesConfig {
}
}
----
====
======
This configuration will write the headers with the values provided:
[source]
@ -1048,8 +1104,10 @@ X-Custom-Security-Header: header-value
The headers could be added to the response using the following Configuration:
.StaticHeadersWriter
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -1067,7 +1125,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -1079,7 +1138,8 @@ public class WebSecurityConfig {
</http>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -1097,7 +1157,7 @@ class SecurityConfig {
}
}
----
====
======
[[servlet-headers-writer]]
=== Headers Writer
@ -1107,8 +1167,10 @@ Let's take a look at an example of using an custom instance of `XFrameOptionsHea
If you wanted to explicitly configure <<servlet-headers-frame-options>> it could be done with the following Configuration:
.Headers Writer
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -1126,7 +1188,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -1144,7 +1207,8 @@ See https://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsi
c:frameOptionsMode="SAMEORIGIN"/>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -1162,7 +1226,7 @@ class SecurityConfig {
}
}
----
====
======
[[headers-delegatingrequestmatcherheaderwriter]]
=== DelegatingRequestMatcherHeaderWriter
@ -1174,8 +1238,10 @@ You could use the `DelegatingRequestMatcherHeaderWriter` to do so.
An example of using `DelegatingRequestMatcherHeaderWriter` in Java Configuration can be seen below:
.DelegatingRequestMatcherHeaderWriter Java Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -1197,7 +1263,8 @@ public class WebSecurityConfig {
}
----
.XML
XML::
+
[source,xml,role="secondary"]
----
<http>
@ -1222,7 +1289,8 @@ public class WebSecurityConfig {
</beans:bean>
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -1244,4 +1312,4 @@ class SecurityConfig {
}
}
----
====
======

13
docs/modules/ROOT/pages/servlet/exploits/http.adoc
View File

@ -13,8 +13,10 @@ If a client makes a request using HTTP rather than HTTPS, Spring Security can be
For example, the following Java configuration will redirect any HTTP requests to HTTPS:
.Redirect to HTTPS
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Configuration
@ -33,7 +35,8 @@ public class WebSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Configuration
@ -52,12 +55,11 @@ class SecurityConfig {
}
}
----
====
======
The following XML configuration will redirect all HTTP requests to HTTPS
.Redirect to HTTPS with XML Configuration
====
[source,xml]
----
<http>
@ -65,7 +67,6 @@ The following XML configuration will redirect all HTTP requests to HTTPS
...
</http>
----
====
[[servlet-hsts]]

2
docs/modules/ROOT/pages/servlet/getting-started.adoc
View File

@ -21,7 +21,6 @@ You can now https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle
The following example shows how to do so (and the beginning of the output from doing so):
.Running Spring Boot Application
====
[source,bash]
----
$ ./mvn spring-boot:run
@ -32,7 +31,6 @@ Using generated security password: 8e557245-73e2-4286-969a-ff57fe326336
...
----
====
[[servlet-hello-auto-configuration]]

22
docs/modules/ROOT/pages/servlet/integrations/cors.adoc
View File

@ -8,8 +8,10 @@ If the request does not contain any cookies and Spring Security is first, the re
The easiest way to ensure that CORS is handled first is to use the `CorsFilter`.
Users can integrate the `CorsFilter` with Spring Security by providing a `CorsConfigurationSource` using the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -36,7 +38,8 @@ public class WebSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -62,7 +65,7 @@ open class WebSecurityConfig {
}
}
----
====
======
or in XML
@ -79,8 +82,10 @@ or in XML
If you are using Spring MVC's CORS support, you can omit specifying the `CorsConfigurationSource` and Spring Security will leverage the CORS configuration provided to Spring MVC.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -98,7 +103,8 @@ public class WebSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -115,7 +121,7 @@ open class WebSecurityConfig {
}
}
----
====
======
or in XML

22
docs/modules/ROOT/pages/servlet/integrations/data.adoc
View File

@ -9,8 +9,10 @@ It is not only useful but necessary to include the user in the queries to suppor
To use this support, add `org.springframework.security:spring-security-data` dependency and provide a bean of type `SecurityEvaluationContextExtension`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -19,7 +21,8 @@ public SecurityEvaluationContextExtension securityEvaluationContextExtension() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -27,7 +30,7 @@ fun securityEvaluationContextExtension(): SecurityEvaluationContextExtension {
return SecurityEvaluationContextExtension()
}
----
====
======
In XML Configuration, this would look like:
@ -42,8 +45,10 @@ In XML Configuration, this would look like:
Now Spring Security can be used within your queries.
For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Repository
@ -53,7 +58,8 @@ public interface MessageRepository extends PagingAndSortingRepository<Message,Lo
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Repository
@ -62,7 +68,7 @@ interface MessageRepository : PagingAndSortingRepository<Message,Long> {
fun findInbox(pageable: Pageable): Page<Message>
}
----
====
======
This checks to see if the `Authentication.getPrincipal().getId()` is equal to the recipient of the `Message`.
Note that this example assumes you have customized the principal to be an Object that has an id property.

143
docs/modules/ROOT/pages/servlet/integrations/mvc.adoc
View File

@ -56,8 +56,10 @@ For a `web.xml` this means that you should place your configuration in the `Disp
Below `WebSecurityConfiguration` in placed in the ``DispatcherServlet``s `ApplicationContext`.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class SecurityInitializer extends
@ -81,7 +83,8 @@ public class SecurityInitializer extends
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class SecurityInitializer : AbstractAnnotationConfigDispatcherServletInitializer() {
@ -101,7 +104,7 @@ class SecurityInitializer : AbstractAnnotationConfigDispatcherServletInitializer
}
}
----
====
======
[NOTE]
====
@ -114,26 +117,31 @@ This is what is known as https://en.wikipedia.org/wiki/Defense_in_depth_(computi
Consider a controller that is mapped as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@RequestMapping("/admin")
public String admin() {
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@RequestMapping("/admin")
fun admin(): String {
----
====
======
If we wanted to restrict access to this controller method to admin users, a developer can provide authorization rules by matching on the `HttpServletRequest` with the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -146,7 +154,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -159,7 +168,7 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
return http.build()
}
----
====
======
or in XML
@ -181,8 +190,10 @@ Instead, we can leverage Spring Security's `MvcRequestMatcher`.
The following configuration will protect the same URLs that Spring MVC will match on by using Spring MVC to match on the URL.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -195,7 +206,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -208,7 +220,7 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
// ...
}
----
====
======
or in XML
@ -240,8 +252,10 @@ Once `AuthenticationPrincipalArgumentResolver` is properly configured, you can b
Consider a situation where a custom `UserDetailsService` that returns an `Object` that implements `UserDetails` and your own `CustomUser` `Object`. The `CustomUser` of the currently authenticated user could be accessed using the following code:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@RequestMapping("/messages/inbox")
@ -254,7 +268,8 @@ public ModelAndView findMessagesForUser() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@RequestMapping("/messages/inbox")
@ -265,12 +280,14 @@ open fun findMessagesForUser(): ModelAndView {
// .. find messages for this user and return them ...
}
----
====
======
As of Spring Security 3.2 we can resolve the argument more directly by adding an annotation. For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import org.springframework.security.core.annotation.AuthenticationPrincipal;
@ -284,7 +301,8 @@ public ModelAndView findMessagesForUser(@AuthenticationPrincipal CustomUser cust
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@RequestMapping("/messages/inbox")
@ -293,15 +311,17 @@ open fun findMessagesForUser(@AuthenticationPrincipal customUser: CustomUser?):
// .. find messages for this user and return them ...
}
----
====
======
Sometimes it may be necessary to transform the principal in some way.
For example, if `CustomUser` needed to be final it could not be extended.
In this situation the `UserDetailsService` might returns an `Object` that implements `UserDetails` and provides a method named `getCustomUser` to access `CustomUser`.
For example, it might look like:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class CustomUserUserDetails extends User {
@ -312,7 +332,8 @@ public class CustomUserUserDetails extends User {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class CustomUserUserDetails(
@ -324,12 +345,14 @@ class CustomUserUserDetails(
val customUser: CustomUser? = null
}
----
====
======
We could then access the `CustomUser` using a https://docs.spring.io/spring/docs/current/spring-framework-reference/html/expressions.html[SpEL expression] that uses `Authentication.getPrincipal()` as the root object:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import org.springframework.security.core.annotation.AuthenticationPrincipal;
@ -343,7 +366,8 @@ public ModelAndView findMessagesForUser(@AuthenticationPrincipal(expression = "c
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.security.core.annotation.AuthenticationPrincipal
@ -356,13 +380,15 @@ open fun findMessagesForUser(@AuthenticationPrincipal(expression = "customUser")
// .. find messages for this user and return them ...
}
----
====
======
We can also refer to Beans in our SpEL expressions.
For example, the following could be used if we were using JPA to manage our Users and we wanted to modify and save a property on the current user.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import org.springframework.security.core.annotation.AuthenticationPrincipal;
@ -380,7 +406,8 @@ public ModelAndView updateName(@AuthenticationPrincipal(expression = "@jpaEntity
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.security.core.annotation.AuthenticationPrincipal
@ -399,7 +426,7 @@ open fun updateName(
// ...
}
----
====
======
We can further remove our dependency on Spring Security by making `@AuthenticationPrincipal` a meta annotation on our own annotation.
Below we demonstrate how we could do this on an annotation named `@CurrentUser`.
@ -407,8 +434,10 @@ Below we demonstrate how we could do this on an annotation named `@CurrentUser`.
NOTE: It is important to realize that in order to remove the dependency on Spring Security, it is the consuming application that would create `@CurrentUser`.
This step is not strictly required, but assists in isolating your dependency to Spring Security to a more central location.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Target({ElementType.PARAMETER, ElementType.TYPE})
@ -418,7 +447,8 @@ This step is not strictly required, but assists in isolating your dependency to
public @interface CurrentUser {}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Target(AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.TYPE)
@ -427,13 +457,15 @@ public @interface CurrentUser {}
@AuthenticationPrincipal
annotation class CurrentUser
----
====
======
Now that `@CurrentUser` has been specified, we can use it to signal to resolve our `CustomUser` of the currently authenticated user.
We have also isolated our dependency on Spring Security to a single file.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@RequestMapping("/messages/inbox")
@ -443,7 +475,8 @@ public ModelAndView findMessagesForUser(@CurrentUser CustomUser customUser) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@RequestMapping("/messages/inbox")
@ -452,7 +485,7 @@ open fun findMessagesForUser(@CurrentUser customUser: CustomUser?): ModelAndView
// .. find messages for this user and return them ...
}
----
====
======
[[mvc-async]]
@ -462,8 +495,10 @@ Spring Web MVC 3.2+ has excellent support for https://docs.spring.io/spring/docs
With no additional configuration, Spring Security will automatically setup the `SecurityContext` to the `Thread` that invokes a `Callable` returned by your controllers.
For example, the following method will automatically have its `Callable` invoked with the `SecurityContext` that was available when the `Callable` was created:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@RequestMapping(method=RequestMethod.POST)
@ -478,7 +513,8 @@ return new Callable<String>() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@RequestMapping(method = [RequestMethod.POST])
@ -489,7 +525,7 @@ open fun processUpload(file: MultipartFile?): Callable<String> {
}
}
----
====
======
[NOTE]
.Associating SecurityContext to Callable's
@ -557,8 +593,10 @@ If you use XML based configuration, you must add this yourself.
Once `CsrfTokenArgumentResolver` is properly configured, you can expose the `CsrfToken` to your static HTML based application.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@RestController
@ -571,7 +609,8 @@ public class CsrfController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@RestController
@ -582,7 +621,7 @@ class CsrfController {
}
}
----
====
======
It is important to keep the `CsrfToken` a secret from other domains.
This means if you are using https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS[Cross Origin Sharing (CORS)], you should **NOT** expose the `CsrfToken` to any external domains.

55
docs/modules/ROOT/pages/servlet/integrations/servlet-api.adoc
View File

@ -24,8 +24,10 @@ For example, you might have created a custom `UserDetailsService` that returns a
You could obtain this information with the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Authentication auth = httpServletRequest.getUserPrincipal();
@ -36,7 +38,8 @@ String firstName = userDetails.getFirstName();
String lastName = userDetails.getLastName();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val auth: Authentication = httpServletRequest.getUserPrincipal()
@ -46,7 +49,7 @@ val userDetails: MyCustomUserDetails = auth.principal as MyCustomUserDetails
val firstName: String = userDetails.firstName
val lastName: String = userDetails.lastName
----
====
======
[NOTE]
====
@ -60,19 +63,22 @@ The https://docs.oracle.com/javaee/6/api/javax/servlet/http/HttpServletRequest.h
Typically users should not pass in the "ROLE_" prefix into this method since it is added automatically.
For example, if you want to determine if the current user has the authority "ROLE_ADMIN", you could use the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
boolean isAdmin = httpServletRequest.isUserInRole("ADMIN");
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val isAdmin: Boolean = httpServletRequest.isUserInRole("ADMIN")
----
====
======
This might be useful to determine if certain UI components should be displayed.
For example, you might display admin links only if the current user is an admin.
@ -93,8 +99,10 @@ If they are not authenticated, the configured AuthenticationEntryPoint will be u
The https://docs.oracle.com/javaee/6/api/javax/servlet/http/HttpServletRequest.html#login%28java.lang.String,%20java.lang.String%29[HttpServletRequest.login(String,String)] method can be used to authenticate the user with the current `AuthenticationManager`.
For example, the following would attempt to authenticate with the username "user" and password "password":
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
try {
@ -104,7 +112,8 @@ httpServletRequest.login("user","password");
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
try {
@ -113,7 +122,7 @@ try {
// fail to authenticate
}
----
====
======
[NOTE]
====
@ -135,8 +144,10 @@ The https://docs.oracle.com/javaee/6/api/javax/servlet/AsyncContext.html#start%2
Using Spring Security's concurrency support, Spring Security overrides the AsyncContext.start(Runnable) to ensure that the current SecurityContext is used when processing the Runnable.
For example, the following would output the current user's Authentication:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
final AsyncContext async = httpServletRequest.startAsync();
@ -155,7 +166,8 @@ async.start(new Runnable() {
});
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val async: AsyncContext = httpServletRequest.startAsync()
@ -171,7 +183,7 @@ async.start {
}
}
----
====
======
[[servletapi-async]]
=== Async Servlet Support
@ -217,8 +229,10 @@ Prior to Spring Security 3.2, the SecurityContext from the SecurityContextHolder
This can cause issues in an Async environment.
For example, consider the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
httpServletRequest.startAsync();
@ -238,7 +252,8 @@ new Thread("AsyncThread") {
}.start();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
httpServletRequest.startAsync()
@ -256,7 +271,7 @@ object : Thread("AsyncThread") {
}
}.start()
----
====
======
The issue is that this Thread is not known to Spring Security, so the SecurityContext is not propagated to it.
This means when we commit the HttpServletResponse there is no SecurityContext.

66
docs/modules/ROOT/pages/servlet/integrations/websocket.adoc
View File

@ -18,8 +18,10 @@ Spring Security 4.0 has introduced authorization support for WebSockets through
To configure authorization using Java Configuration, simply extend the `AbstractSecurityWebSocketMessageBrokerConfigurer` and configure the `MessageSecurityMetadataSourceRegistry`.
For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Configuration
@ -33,7 +35,8 @@ public class WebSocketSecurityConfig
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Configuration
@ -43,7 +46,7 @@ open class WebSocketSecurityConfig : AbstractSecurityWebSocketMessageBrokerConfi
}
}
----
====
======
This will ensure that:
@ -84,8 +87,10 @@ Spring Security 4.0 has introduced authorization support for WebSockets through
To configure authorization using Java Configuration, simply extend the `AbstractSecurityWebSocketMessageBrokerConfigurer` and configure the `MessageSecurityMetadataSourceRegistry`.
For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Configuration
@ -105,7 +110,8 @@ public class WebSocketSecurityConfig extends AbstractSecurityWebSocketMessageBro
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Configuration
@ -121,7 +127,7 @@ open class WebSocketSecurityConfig : AbstractSecurityWebSocketMessageBrokerConfi
}
}
----
====
======
This will ensure that:
@ -266,8 +272,10 @@ var token = "${_csrf.token}";
If you are using static HTML, you can expose the `CsrfToken` on a REST endpoint.
For example, the following would expose the `CsrfToken` on the URL /csrf
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@RestController
@ -280,7 +288,8 @@ public class CsrfController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@RestController
@ -291,7 +300,7 @@ class CsrfController {
}
}
----
====
======
The JavaScript can make a REST call to the endpoint and use the response to populate the headerName and the token.
@ -315,8 +324,10 @@ stompClient.connect(headers, function(frame) {
If you want to allow other domains to access your site, you can disable Spring Security's protection.
For example, in Java Configuration you can use the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Configuration
@ -331,7 +342,8 @@ public class WebSocketSecurityConfig extends AbstractSecurityWebSocketMessageBro
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Configuration
@ -344,7 +356,7 @@ open class WebSocketSecurityConfig : AbstractSecurityWebSocketMessageBrokerConfi
}
}
----
====
======
[[websocket-sockjs]]
@ -377,8 +389,10 @@ For example, the following will instruct Spring Security to use "X-Frame-Options
Similarly, you can customize frame options to use the same origin within Java Configuration using the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -398,7 +412,8 @@ public class WebSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -417,7 +432,7 @@ open class WebSecurityConfig {
}
}
----
====
======
[[websocket-sockjs-csrf]]
=== SockJS & Relaxing CSRF
@ -436,8 +451,10 @@ We can easily achieve this by providing a CSRF RequestMatcher.
Our Java Configuration makes this extremely easy.
For example, if our stomp endpoint is "/chat" we can disable CSRF protection for only URLs that start with "/chat/" using the following configuration:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Configuration
@ -463,7 +480,8 @@ public class WebSecurityConfig {
...
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Configuration
@ -486,7 +504,7 @@ open class WebSecurityConfig {
// ...
----
====
======
If we are using XML based configuration, we can use the xref:servlet/appendix/namespace/http.adoc#nsa-csrf-request-matcher-ref[csrf@request-matcher-ref].
For example:

216
docs/modules/ROOT/pages/servlet/oauth2/client/authorization-grants.adoc
View File

@ -111,8 +111,10 @@ OPTIONAL. Space delimited, case sensitive list of ASCII string values that speci
The following example shows how to configure the `DefaultOAuth2AuthorizationRequestResolver` with a `Consumer<OAuth2AuthorizationRequest.Builder>` that customizes the Authorization Request for `oauth2Login()`, by including the request parameter `prompt=consent`.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -156,7 +158,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -197,7 +200,7 @@ class SecurityConfig {
}
}
----
====
======
For the simple use case, where the additional request parameter is always the same for a specific provider, it may be added directly in the `authorization-uri` property.
@ -222,8 +225,10 @@ Alternatively, if your requirements are more advanced, you can take full control
The following example shows a variation of `authorizationRequestCustomizer()` from the preceding example, and instead overrides the `OAuth2AuthorizationRequest.authorizationRequestUri` property.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
private Consumer<OAuth2AuthorizationRequest.Builder> authorizationRequestCustomizer() {
@ -233,7 +238,8 @@ private Consumer<OAuth2AuthorizationRequest.Builder> authorizationRequestCustomi
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
private fun authorizationRequestCustomizer(): Consumer<OAuth2AuthorizationRequest.Builder> {
@ -246,7 +252,7 @@ private fun authorizationRequestCustomizer(): Consumer<OAuth2AuthorizationReques
}
}
----
====
======
=== Storing the Authorization Request
@ -261,8 +267,10 @@ The default implementation of `AuthorizationRequestRepository` is `HttpSessionOA
If you have a custom implementation of `AuthorizationRequestRepository`, you may configure it as shown in the following example:
.AuthorizationRequestRepository Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -291,7 +299,8 @@ public class OAuth2ClientSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -311,7 +320,8 @@ class OAuth2ClientSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -320,7 +330,7 @@ class OAuth2ClientSecurityConfig {
</oauth2-client>
</http>
----
====
======
=== Requesting an Access Token
@ -351,8 +361,10 @@ IMPORTANT: The custom `Converter` must return a valid `RequestEntity` representa
On the other end, if you need to customize the post-handling of the Token Response, you will need to provide `DefaultAuthorizationCodeTokenResponseClient.setRestOperations()` with a custom configured `RestOperations`.
The default `RestOperations` is configured as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
RestTemplate restTemplate = new RestTemplate(Arrays.asList(
@ -362,7 +374,8 @@ RestTemplate restTemplate = new RestTemplate(Arrays.asList(
restTemplate.setErrorHandler(new OAuth2ErrorResponseErrorHandler());
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val restTemplate = RestTemplate(listOf(
@ -371,7 +384,7 @@ val restTemplate = RestTemplate(listOf(
restTemplate.errorHandler = OAuth2ErrorResponseErrorHandler()
----
====
======
TIP: Spring MVC `FormHttpMessageConverter` is required as it's used when sending the OAuth 2.0 Access Token Request.
@ -384,8 +397,10 @@ It uses an `OAuth2ErrorHttpMessageConverter` for converting the OAuth 2.0 Error
Whether you customize `DefaultAuthorizationCodeTokenResponseClient` or provide your own implementation of `OAuth2AccessTokenResponseClient`, you'll need to configure it as shown in the following example:
.Access Token Response Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -405,7 +420,8 @@ public class OAuth2ClientSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -425,7 +441,8 @@ class OAuth2ClientSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -434,7 +451,7 @@ class OAuth2ClientSecurityConfig {
</oauth2-client>
</http>
----
====
======
[[oauth2Client-refresh-token-grant]]
@ -473,8 +490,10 @@ IMPORTANT: The custom `Converter` must return a valid `RequestEntity` representa
On the other end, if you need to customize the post-handling of the Token Response, you will need to provide `DefaultRefreshTokenTokenResponseClient.setRestOperations()` with a custom configured `RestOperations`.
The default `RestOperations` is configured as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
RestTemplate restTemplate = new RestTemplate(Arrays.asList(
@ -484,7 +503,8 @@ RestTemplate restTemplate = new RestTemplate(Arrays.asList(
restTemplate.setErrorHandler(new OAuth2ErrorResponseErrorHandler());
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val restTemplate = RestTemplate(listOf(
@ -493,7 +513,7 @@ val restTemplate = RestTemplate(listOf(
restTemplate.errorHandler = OAuth2ErrorResponseErrorHandler()
----
====
======
TIP: Spring MVC `FormHttpMessageConverter` is required as it's used when sending the OAuth 2.0 Access Token Request.
@ -505,8 +525,10 @@ It uses an `OAuth2ErrorHttpMessageConverter` for converting the OAuth 2.0 Error
Whether you customize `DefaultRefreshTokenTokenResponseClient` or provide your own implementation of `OAuth2AccessTokenResponseClient`, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Customize
@ -523,7 +545,8 @@ OAuth2AuthorizedClientProvider authorizedClientProvider =
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Customize
@ -538,7 +561,7 @@ val authorizedClientProvider = OAuth2AuthorizedClientProviderBuilder.builder()
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
----
====
======
[NOTE]
`OAuth2AuthorizedClientProviderBuilder.builder().refreshToken()` configures a `RefreshTokenOAuth2AuthorizedClientProvider`,
@ -584,8 +607,10 @@ IMPORTANT: The custom `Converter` must return a valid `RequestEntity` representa
On the other end, if you need to customize the post-handling of the Token Response, you will need to provide `DefaultClientCredentialsTokenResponseClient.setRestOperations()` with a custom configured `RestOperations`.
The default `RestOperations` is configured as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
RestTemplate restTemplate = new RestTemplate(Arrays.asList(
@ -595,7 +620,8 @@ RestTemplate restTemplate = new RestTemplate(Arrays.asList(
restTemplate.setErrorHandler(new OAuth2ErrorResponseErrorHandler());
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val restTemplate = RestTemplate(listOf(
@ -604,7 +630,7 @@ val restTemplate = RestTemplate(listOf(
restTemplate.errorHandler = OAuth2ErrorResponseErrorHandler()
----
====
======
TIP: Spring MVC `FormHttpMessageConverter` is required as it's used when sending the OAuth 2.0 Access Token Request.
@ -616,8 +642,10 @@ It uses an `OAuth2ErrorHttpMessageConverter` for converting the OAuth 2.0 Error
Whether you customize `DefaultClientCredentialsTokenResponseClient` or provide your own implementation of `OAuth2AccessTokenResponseClient`, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Customize
@ -633,7 +661,8 @@ OAuth2AuthorizedClientProvider authorizedClientProvider =
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Customize
@ -647,7 +676,7 @@ val authorizedClientProvider = OAuth2AuthorizedClientProviderBuilder.builder()
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
----
====
======
[NOTE]
`OAuth2AuthorizedClientProviderBuilder.builder().clientCredentials()` configures a `ClientCredentialsOAuth2AuthorizedClientProvider`,
@ -676,8 +705,10 @@ spring:
...and the `OAuth2AuthorizedClientManager` `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -699,7 +730,8 @@ public OAuth2AuthorizedClientManager authorizedClientManager(
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -715,12 +747,14 @@ fun authorizedClientManager(
return authorizedClientManager
}
----
====
======
You may obtain the `OAuth2AccessToken` as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -752,7 +786,8 @@ public class OAuth2ClientController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class OAuth2ClientController {
@ -780,7 +815,7 @@ class OAuth2ClientController {
}
}
----
====
======
[NOTE]
`HttpServletRequest` and `HttpServletResponse` are both OPTIONAL attributes.
@ -823,8 +858,10 @@ IMPORTANT: The custom `Converter` must return a valid `RequestEntity` representa
On the other end, if you need to customize the post-handling of the Token Response, you will need to provide `DefaultPasswordTokenResponseClient.setRestOperations()` with a custom configured `RestOperations`.
The default `RestOperations` is configured as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
RestTemplate restTemplate = new RestTemplate(Arrays.asList(
@ -834,7 +871,8 @@ RestTemplate restTemplate = new RestTemplate(Arrays.asList(
restTemplate.setErrorHandler(new OAuth2ErrorResponseErrorHandler());
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val restTemplate = RestTemplate(listOf(
@ -843,7 +881,7 @@ val restTemplate = RestTemplate(listOf(
restTemplate.errorHandler = OAuth2ErrorResponseErrorHandler()
----
====
======
TIP: Spring MVC `FormHttpMessageConverter` is required as it's used when sending the OAuth 2.0 Access Token Request.
@ -855,8 +893,10 @@ It uses an `OAuth2ErrorHttpMessageConverter` for converting the OAuth 2.0 Error
Whether you customize `DefaultPasswordTokenResponseClient` or provide your own implementation of `OAuth2AccessTokenResponseClient`, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Customize
@ -873,7 +913,8 @@ OAuth2AuthorizedClientProvider authorizedClientProvider =
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val passwordTokenResponseClient: OAuth2AccessTokenResponseClient<OAuth2PasswordGrantRequest> = ...
@ -887,7 +928,7 @@ val authorizedClientProvider = OAuth2AuthorizedClientProviderBuilder.builder()
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
----
====
======
[NOTE]
`OAuth2AuthorizedClientProviderBuilder.builder().password()` configures a `PasswordOAuth2AuthorizedClientProvider`,
@ -916,8 +957,10 @@ spring:
...and the `OAuth2AuthorizedClientManager` `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -960,7 +1003,9 @@ private Function<OAuth2AuthorizeRequest, Map<String, Object>> contextAttributesM
};
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -998,12 +1043,14 @@ private fun contextAttributesMapper(): Function<OAuth2AuthorizeRequest, MutableM
}
}
----
====
======
You may obtain the `OAuth2AccessToken` as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -1035,7 +1082,8 @@ public class OAuth2ClientController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Controller
@ -1063,7 +1111,7 @@ class OAuth2ClientController {
}
}
----
====
======
[NOTE]
`HttpServletRequest` and `HttpServletResponse` are both OPTIONAL attributes.
@ -1104,8 +1152,10 @@ If you prefer to only add additional parameters, you can provide `JwtBearerGrant
On the other end, if you need to customize the post-handling of the Token Response, you will need to provide `DefaultJwtBearerTokenResponseClient.setRestOperations()` with a custom configured `RestOperations`.
The default `RestOperations` is configured as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
RestTemplate restTemplate = new RestTemplate(Arrays.asList(
@ -1115,7 +1165,8 @@ RestTemplate restTemplate = new RestTemplate(Arrays.asList(
restTemplate.setErrorHandler(new OAuth2ErrorResponseErrorHandler());
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val restTemplate = RestTemplate(listOf(
@ -1124,7 +1175,7 @@ val restTemplate = RestTemplate(listOf(
restTemplate.errorHandler = OAuth2ErrorResponseErrorHandler()
----
====
======
TIP: Spring MVC `FormHttpMessageConverter` is required as it's used when sending the OAuth 2.0 Access Token Request.
@ -1136,8 +1187,10 @@ It uses an `OAuth2ErrorHttpMessageConverter` for converting the OAuth 2.0 Error
Whether you customize `DefaultJwtBearerTokenResponseClient` or provide your own implementation of `OAuth2AccessTokenResponseClient`, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
// Customize
@ -1156,7 +1209,8 @@ OAuth2AuthorizedClientProvider authorizedClientProvider =
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
// Customize
@ -1173,7 +1227,7 @@ val authorizedClientProvider = OAuth2AuthorizedClientProviderBuilder.builder()
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
----
====
======
=== Using the Access Token
@ -1198,8 +1252,10 @@ spring:
...and the `OAuth2AuthorizedClientManager` `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -1224,7 +1280,8 @@ public OAuth2AuthorizedClientManager authorizedClientManager(
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -1241,12 +1298,14 @@ fun authorizedClientManager(
return authorizedClientManager
}
----
====
======
You may obtain the `OAuth2AccessToken` as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@RestController
@ -1269,7 +1328,8 @@ public class OAuth2ResourceServerController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class OAuth2ResourceServerController {
@ -1290,7 +1350,7 @@ class OAuth2ResourceServerController {
}
}
----
====
======
[NOTE]
`JwtBearerOAuth2AuthorizedClientProvider` resolves the `Jwt` assertion via `OAuth2AuthorizationContext.getPrincipal().getPrincipal()` by default, hence the use of `JwtAuthenticationToken` in the preceding example.

66
docs/modules/ROOT/pages/servlet/oauth2/client/authorized-clients.adoc
View File

@ -7,8 +7,10 @@
The `@RegisteredOAuth2AuthorizedClient` annotation provides the capability of resolving a method parameter to an argument value of type `OAuth2AuthorizedClient`.
This is a convenient alternative compared to accessing the `OAuth2AuthorizedClient` using the `OAuth2AuthorizedClientManager` or `OAuth2AuthorizedClientService`.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -25,7 +27,8 @@ public class OAuth2ClientController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Controller
@ -40,7 +43,7 @@ class OAuth2ClientController {
}
}
----
====
======
The `@RegisteredOAuth2AuthorizedClient` annotation is handled by `OAuth2AuthorizedClientArgumentResolver`, which directly uses an xref:servlet/oauth2/client/core.adoc#oauth2Client-authorized-manager-provider[`OAuth2AuthorizedClientManager`] and therefore inherits it's capabilities.
@ -61,8 +64,10 @@ It directly uses an xref:servlet/oauth2/client/core.adoc#oauth2Client-authorized
The following code shows an example of how to configure `WebClient` with OAuth 2.0 Client support:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -75,7 +80,8 @@ WebClient webClient(OAuth2AuthorizedClientManager authorizedClientManager) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -86,7 +92,7 @@ fun webClient(authorizedClientManager: OAuth2AuthorizedClientManager?): WebClien
.build()
}
----
====
======
=== Providing the Authorized Client
@ -94,8 +100,10 @@ The `ServletOAuth2AuthorizedClientExchangeFilterFunction` determines the client
The following code shows how to set an `OAuth2AuthorizedClient` as a request attribute:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@GetMapping("/")
@ -116,7 +124,8 @@ public String index(@RegisteredOAuth2AuthorizedClient("okta") OAuth2AuthorizedCl
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@GetMapping("/")
@ -135,14 +144,16 @@ fun index(@RegisteredOAuth2AuthorizedClient("okta") authorizedClient: OAuth2Auth
return "index"
}
----
====
======
<1> `oauth2AuthorizedClient()` is a `static` method in `ServletOAuth2AuthorizedClientExchangeFilterFunction`.
The following code shows how to set the `ClientRegistration.getRegistrationId()` as a request attribute:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@GetMapping("/")
@ -163,7 +174,8 @@ public String index() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@GetMapping("/")
@ -183,7 +195,7 @@ fun index(): String {
return "index"
}
----
====
======
<1> `clientRegistrationId()` is a `static` method in `ServletOAuth2AuthorizedClientExchangeFilterFunction`.
@ -195,8 +207,10 @@ If `setDefaultOAuth2AuthorizedClient(true)` is configured and the user has authe
The following code shows the specific configuration:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -210,7 +224,8 @@ WebClient webClient(OAuth2AuthorizedClientManager authorizedClientManager) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -222,7 +237,7 @@ fun webClient(authorizedClientManager: OAuth2AuthorizedClientManager?): WebClien
.build()
}
----
====
======
[WARNING]
It is recommended to be cautious with this feature since all HTTP requests will receive the access token.
@ -231,8 +246,10 @@ Alternatively, if `setDefaultClientRegistrationId("okta")` is configured with a
The following code shows the specific configuration:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -246,7 +263,8 @@ WebClient webClient(OAuth2AuthorizedClientManager authorizedClientManager) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -258,7 +276,7 @@ fun webClient(authorizedClientManager: OAuth2AuthorizedClientManager?): WebClien
.build()
}
----
====
======
[WARNING]
It is recommended to be cautious with this feature since all HTTP requests will receive the access token.

33
docs/modules/ROOT/pages/servlet/oauth2/client/client-authentication.adoc
View File

@ -36,8 +36,10 @@ spring:
The following example shows how to configure `DefaultAuthorizationCodeTokenResponseClient`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Function<ClientRegistration, JWK> jwkResolver = (clientRegistration) -> {
@ -63,7 +65,8 @@ DefaultAuthorizationCodeTokenResponseClient tokenResponseClient =
tokenResponseClient.setRequestEntityConverter(requestEntityConverter);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val jwkResolver: Function<ClientRegistration, JWK> =
@ -88,7 +91,7 @@ requestEntityConverter.addParametersConverter(
val tokenResponseClient = DefaultAuthorizationCodeTokenResponseClient()
tokenResponseClient.setRequestEntityConverter(requestEntityConverter)
----
====
======
=== Authenticate using `client_secret_jwt`
@ -112,8 +115,10 @@ spring:
The following example shows how to configure `DefaultClientCredentialsTokenResponseClient`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Function<ClientRegistration, JWK> jwkResolver = (clientRegistration) -> {
@ -138,7 +143,8 @@ DefaultClientCredentialsTokenResponseClient tokenResponseClient =
tokenResponseClient.setRequestEntityConverter(requestEntityConverter);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val jwkResolver = Function<ClientRegistration, JWK?> { clientRegistration: ClientRegistration ->
@ -162,14 +168,16 @@ requestEntityConverter.addParametersConverter(
val tokenResponseClient = DefaultClientCredentialsTokenResponseClient()
tokenResponseClient.setRequestEntityConverter(requestEntityConverter)
----
====
======
=== Customizing the JWT assertion
The JWT produced by `NimbusJwtClientAuthenticationParametersConverter` contains the `iss`, `sub`, `aud`, `jti`, `iat` and `exp` claims by default. You can customize the headers and/or claims by providing a `Consumer<NimbusJwtClientAuthenticationParametersConverter.JwtClientAuthenticationContext<T>>` to `setJwtClientAssertionCustomizer()`. The following example shows how to customize claims of the JWT:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Function<ClientRegistration, JWK> jwkResolver = ...
@ -182,7 +190,8 @@ converter.setJwtClientAssertionCustomizer((context) -> {
});
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val jwkResolver = ...
@ -194,4 +203,4 @@ converter.setJwtClientAssertionCustomizer { context ->
context.claims.claim("custom-claim", "claim-value")
}
----
====
======

66
docs/modules/ROOT/pages/servlet/oauth2/client/core.adoc
View File

@ -69,20 +69,23 @@ A `ClientRegistration` can be initially configured using discovery of an OpenID
`ClientRegistrations` provides convenience methods for configuring a `ClientRegistration` in this way, as can be seen in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
ClientRegistration clientRegistration =
ClientRegistrations.fromIssuerLocation("https://idp.example.com/issuer").build();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val clientRegistration = ClientRegistrations.fromIssuerLocation("https://idp.example.com/issuer").build()
----
====
======
The above code will query in series `https://idp.example.com/issuer/.well-known/openid-configuration`, and then `https://idp.example.com/.well-known/openid-configuration/issuer`, and finally `https://idp.example.com/.well-known/oauth-authorization-server/issuer`, stopping at the first to return a 200 response.
@ -106,8 +109,10 @@ The auto-configuration also registers the `ClientRegistrationRepository` as a `@
The following listing shows an example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -128,7 +133,8 @@ public class OAuth2ClientController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Controller
@ -148,7 +154,7 @@ class OAuth2ClientController {
}
}
----
====
======
[[oauth2Client-authorized-client]]
== OAuth2AuthorizedClient
@ -169,8 +175,10 @@ From a developer perspective, the `OAuth2AuthorizedClientRepository` or `OAuth2A
The following listing shows an example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -193,7 +201,8 @@ public class OAuth2ClientController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Controller
@ -214,7 +223,7 @@ class OAuth2ClientController {
}
}
----
====
======
[NOTE]
Spring Boot 2.x auto-configuration registers an `OAuth2AuthorizedClientRepository` and/or `OAuth2AuthorizedClientService` `@Bean` in the `ApplicationContext`.
@ -248,8 +257,10 @@ The `OAuth2AuthorizedClientProviderBuilder` may be used to configure and build t
The following code shows an example of how to configure and build an `OAuth2AuthorizedClientProvider` composite that provides support for the `authorization_code`, `refresh_token`, `client_credentials` and `password` authorization grant types:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -274,7 +285,8 @@ public OAuth2AuthorizedClientManager authorizedClientManager(
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -293,7 +305,7 @@ fun authorizedClientManager(
return authorizedClientManager
}
----
====
======
When an authorization attempt succeeds, the `DefaultOAuth2AuthorizedClientManager` will delegate to the `OAuth2AuthorizationSuccessHandler`, which (by default) will save the `OAuth2AuthorizedClient` via the `OAuth2AuthorizedClientRepository`.
In the case of a re-authorization failure, eg. a refresh token is no longer valid, the previously saved `OAuth2AuthorizedClient` will be removed from the `OAuth2AuthorizedClientRepository` via the `RemoveAuthorizedClientOAuth2AuthorizationFailureHandler`.
@ -304,8 +316,10 @@ This can be useful when you need to supply an `OAuth2AuthorizedClientProvider` w
The following code shows an example of the `contextAttributesMapper`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -349,7 +363,8 @@ private Function<OAuth2AuthorizeRequest, Map<String, Object>> contextAttributesM
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -387,7 +402,7 @@ private fun contextAttributesMapper(): Function<OAuth2AuthorizeRequest, MutableM
}
}
----
====
======
The `DefaultOAuth2AuthorizedClientManager` is designed to be used *_within_* the context of a `HttpServletRequest`.
When operating *_outside_* of a `HttpServletRequest` context, use `AuthorizedClientServiceOAuth2AuthorizedClientManager` instead.
@ -398,8 +413,10 @@ An OAuth 2.0 Client configured with the `client_credentials` grant type can be c
The following code shows an example of how to configure an `AuthorizedClientServiceOAuth2AuthorizedClientManager` that provides support for the `client_credentials` grant type:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -421,7 +438,8 @@ public OAuth2AuthorizedClientManager authorizedClientManager(
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -437,4 +455,4 @@ fun authorizedClientManager(
return authorizedClientManager
}
----
====
======

24
docs/modules/ROOT/pages/servlet/oauth2/client/index.adoc
View File

@ -25,8 +25,10 @@ In addition, `HttpSecurity.oauth2Client().authorizationCodeGrant()` enables the
The following code shows the complete configuration options provided by the `HttpSecurity.oauth2Client()` DSL:
.OAuth2 Client Configuration Options
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -50,7 +52,8 @@ public class OAuth2ClientSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -74,14 +77,13 @@ class OAuth2ClientSecurityConfig {
}
}
----
====
======
In addition to the `HttpSecurity.oauth2Client()` DSL, XML configuration is also supported.
The following code shows the complete configuration options available in the xref:servlet/appendix/namespace/http.adoc#nsa-oauth2-client[ security namespace]:
.OAuth2 Client XML Configuration Options
====
[source,xml]
----
<http>
@ -95,14 +97,15 @@ The following code shows the complete configuration options available in the xre
</oauth2-client>
</http>
----
====
The `OAuth2AuthorizedClientManager` is responsible for managing the authorization (or re-authorization) of an OAuth 2.0 Client, in collaboration with one or more `OAuth2AuthorizedClientProvider`(s).
The following code shows an example of how to register an `OAuth2AuthorizedClientManager` `@Bean` and associate it with an `OAuth2AuthorizedClientProvider` composite that provides support for the `authorization_code`, `refresh_token`, `client_credentials` and `password` authorization grant types:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -127,7 +130,8 @@ public OAuth2AuthorizedClientManager authorizedClientManager(
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -146,4 +150,4 @@ fun authorizedClientManager(
return authorizedClientManager
}
----
====
======

144
docs/modules/ROOT/pages/servlet/oauth2/login/advanced.adoc
View File

@ -9,8 +9,10 @@ For example, `oauth2Login().authorizationEndpoint()` allows configuring the _Aut
The following code shows an example:
.Advanced OAuth2 Login Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -38,7 +40,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -66,7 +69,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
The main goal of the `oauth2Login()` DSL was to closely align with the naming, as defined in the specifications.
@ -90,8 +93,10 @@ These claims are normally represented by a JSON object that contains a collectio
The following code shows the complete configuration options available for the `oauth2Login()` DSL:
.OAuth2 Login Configuration Options
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -127,7 +132,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -163,14 +169,13 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
In addition to the `oauth2Login()` DSL, XML configuration is also supported.
The following code shows the complete configuration options available in the xref:servlet/appendix/namespace/http.adoc#nsa-oauth2-login[ security namespace]:
.OAuth2 Login XML Configuration Options
====
[source,xml]
----
<http>
@ -190,7 +195,6 @@ The following code shows the complete configuration options available in the xre
jwt-decoder-factory-ref="jwtDecoderFactory"/>
</http>
----
====
The following sections go into more detail on each of the configuration options available:
@ -227,8 +231,10 @@ To override the default login page, configure `oauth2Login().loginPage()` and (o
The following listing shows an example:
.OAuth2 Login Page Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -250,7 +256,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -271,7 +278,8 @@ class OAuth2LoginSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -280,7 +288,7 @@ class OAuth2LoginSecurityConfig {
/>
</http>
----
====
======
[IMPORTANT]
You need to provide a `@Controller` with a `@RequestMapping("/login/oauth2")` that is capable of rendering the custom login page.
@ -313,8 +321,10 @@ The default Authorization Response `baseUri` (redirection endpoint) is `*/login/
If you would like to customize the Authorization Response `baseUri`, configure it as shown in the following example:
.Redirection Endpoint Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -334,7 +344,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -354,7 +365,8 @@ class OAuth2LoginSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -363,7 +375,7 @@ class OAuth2LoginSecurityConfig {
/>
</http>
----
====
======
[IMPORTANT]
====
@ -371,7 +383,10 @@ You also need to ensure the `ClientRegistration.redirectUri` matches the custom
The following listing shows an example:
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
return CommonOAuth2Provider.GOOGLE.getBuilder("google")
@ -381,7 +396,8 @@ return CommonOAuth2Provider.GOOGLE.getBuilder("google")
.build();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
return CommonOAuth2Provider.GOOGLE.getBuilder("google")
@ -390,6 +406,7 @@ return CommonOAuth2Provider.GOOGLE.getBuilder("google")
.redirectUri("{baseUrl}/login/oauth2/callback/{registrationId}")
.build()
----
======
====
@ -423,8 +440,10 @@ There are a couple of options to choose from when mapping user authorities:
Provide an implementation of `GrantedAuthoritiesMapper` and configure it as shown in the following example:
.Granted Authorities Mapper Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -473,7 +492,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -512,7 +532,8 @@ class OAuth2LoginSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -521,13 +542,15 @@ class OAuth2LoginSecurityConfig {
/>
</http>
----
====
======
Alternatively, you may register a `GrantedAuthoritiesMapper` `@Bean` to have it automatically applied to the configuration, as shown in the following example:
.Granted Authorities Mapper Bean Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -547,7 +570,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -567,7 +591,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
[[oauth2login-advanced-map-authorities-oauth2userservice]]
==== Delegation-based strategy with OAuth2UserService
@ -579,8 +603,10 @@ The `OAuth2UserRequest` (and `OidcUserRequest`) provides you access to the assoc
The following example shows how to implement and configure a delegation-based strategy using an OpenID Connect 1.0 UserService:
.OAuth2UserService Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -621,7 +647,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -662,7 +689,8 @@ class OAuth2LoginSecurityConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -671,7 +699,7 @@ class OAuth2LoginSecurityConfig {
/>
</http>
----
====
======
[[oauth2login-advanced-oauth2-user-service]]
@ -701,8 +729,10 @@ It uses an `OAuth2ErrorHttpMessageConverter` for converting the OAuth 2.0 Error
Whether you customize `DefaultOAuth2UserService` or provide your own implementation of `OAuth2UserService`, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -726,7 +756,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -750,7 +781,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
[[oauth2login-advanced-oidc-user-service]]
@ -764,8 +795,10 @@ If you need to customize the pre-processing of the UserInfo Request and/or the p
Whether you customize `OidcUserService` or provide your own implementation of `OAuth2UserService` for OpenID Connect 1.0 Provider's, you'll need to configure it as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -789,7 +822,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -813,7 +847,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
[[oauth2login-advanced-idtoken-verify]]
@ -830,8 +864,10 @@ The JWS algorithm resolver is a `Function` that accepts a `ClientRegistration` a
The following code shows how to configure the `OidcIdTokenDecoderFactory` `@Bean` to default to `MacAlgorithm.HS256` for all `ClientRegistration`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -842,7 +878,8 @@ public JwtDecoderFactory<ClientRegistration> idTokenDecoderFactory() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -852,7 +889,7 @@ fun idTokenDecoderFactory(): JwtDecoderFactory<ClientRegistration?> {
return idTokenDecoderFactory
}
----
====
======
[NOTE]
For MAC based algorithms such as `HS256`, `HS384` or `HS512`, the `client-secret` corresponding to the `client-id` is used as the symmetric key for signature verification.
@ -888,8 +925,10 @@ spring:
...and the `OidcClientInitiatedLogoutSuccessHandler`, which implements RP-Initiated Logout, may be configured as follows:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -924,7 +963,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -956,7 +996,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
NOTE: `OidcClientInitiatedLogoutSuccessHandler` supports the `+{baseUrl}+` placeholder.
If used, the application's base URL, like `https://app.example.org`, will replace it at request time.

49
docs/modules/ROOT/pages/servlet/oauth2/login/core.adoc
View File

@ -60,10 +60,8 @@ spring:
----
+
.OAuth Client properties
====
<1> `spring.security.oauth2.client.registration` is the base property prefix for OAuth Client properties.
<2> Following the base property prefix is the ID for the xref:servlet/oauth2/client/index.adoc#oauth2Client-client-registration[ClientRegistration], such as google.
====
. Replace the values in the `client-id` and `client-secret` property with the OAuth 2.0 credentials you created earlier.
@ -243,8 +241,10 @@ If you need to override the auto-configuration based on your specific requiremen
The following example shows how to register a `ClientRegistrationRepository` `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
@Configuration
@ -274,7 +274,8 @@ public class OAuth2LoginConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
@Configuration
@ -302,7 +303,7 @@ class OAuth2LoginConfig {
}
}
----
====
======
[[oauth2login-provide-securityfilterchain-bean]]
@ -311,8 +312,10 @@ class OAuth2LoginConfig {
The following example shows how to register a `SecurityFilterChain` `@Bean` with `@EnableWebSecurity` and enable OAuth 2.0 login through `httpSecurity.oauth2Login()`:
.OAuth2 Login Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -330,7 +333,8 @@ public class OAuth2LoginSecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -347,7 +351,7 @@ class OAuth2LoginSecurityConfig {
}
}
----
====
======
[[oauth2login-completely-override-autoconfiguration]]
@ -356,8 +360,10 @@ class OAuth2LoginSecurityConfig {
The following example shows how to completely override the auto-configuration by registering a `ClientRegistrationRepository` `@Bean` and a `SecurityFilterChain` `@Bean`.
.Overriding the auto-configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary",attrs="-attributes"]
----
@Configuration
@ -397,7 +403,8 @@ public class OAuth2LoginConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary",attrs="-attributes"]
----
@Configuration
@ -437,7 +444,7 @@ class OAuth2LoginConfig {
}
}
----
====
======
[[oauth2login-javaconfig-wo-boot]]
@ -446,8 +453,10 @@ class OAuth2LoginConfig {
If you are not able to use Spring Boot 2.x and would like to configure one of the pre-defined providers in `CommonOAuth2Provider` (for example, Google), apply the following configuration:
.OAuth2 Login Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -489,7 +498,8 @@ public class OAuth2LoginConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -533,7 +543,8 @@ open class OAuth2LoginConfig {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http auto-config="true">
@ -557,4 +568,4 @@ open class OAuth2LoginConfig {
<b:constructor-arg ref="authorizedClientService"/>
</b:bean>
----
====
======

83
docs/modules/ROOT/pages/servlet/oauth2/resource-server/bearer-tokens.adoc
View File

@ -12,8 +12,10 @@ For example, you may have a need to read the bearer token from a custom header.
To achieve this, you can expose a `DefaultBearerTokenResolver` as a bean, or wire an instance into the DSL, as you can see in the following example:
.Custom Bearer Token Header
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -24,7 +26,8 @@ BearerTokenResolver bearerTokenResolver() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -35,7 +38,8 @@ fun bearerTokenResolver(): BearerTokenResolver {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -47,7 +51,7 @@ fun bearerTokenResolver(): BearerTokenResolver {
<property name="bearerTokenHeaderName" value="Proxy-Authorization"/>
</bean>
----
====
======
Or, in circumstances where a provider is using both a custom header and value, you can use `HeaderBearerTokenResolver` instead.
@ -56,8 +60,10 @@ Or, in circumstances where a provider is using both a custom header and value, y
Or, you may wish to read the token from a form parameter, which you can do by configuring the `DefaultBearerTokenResolver`, as you can see below:
.Form Parameter Bearer Token
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
DefaultBearerTokenResolver resolver = new DefaultBearerTokenResolver();
@ -68,7 +74,8 @@ http
);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val resolver = DefaultBearerTokenResolver()
@ -80,7 +87,8 @@ http {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -92,15 +100,17 @@ http {
<property name="allowFormEncodedBodyParameter" value="true"/>
</bean>
----
====
======
== Bearer Token Propagation
Now that your resource server has validated the token, it might be handy to pass it to downstream services.
This is quite simple with `{security-api-url}org/springframework/security/oauth2/server/resource/web/reactive/function/client/ServletBearerExchangeFilterFunction.html[ServletBearerExchangeFilterFunction]`, which you can see in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -111,7 +121,8 @@ public WebClient rest() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -121,15 +132,17 @@ fun rest(): WebClient {
.build()
}
----
====
======
When the above `WebClient` is used to perform requests, Spring Security will look up the current `Authentication` and extract any `{security-api-url}org/springframework/security/oauth2/core/AbstractOAuth2Token.html[AbstractOAuth2Token]` credential.
Then, it will propagate that token in the `Authorization` header.
For example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
this.rest.get()
@ -139,7 +152,8 @@ this.rest.get()
.block()
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
this.rest.get()
@ -148,14 +162,16 @@ this.rest.get()
.bodyToMono<String>()
.block()
----
====
======
Will invoke the `https://other-service.example.com/endpoint`, adding the bearer token `Authorization` header for you.
In places where you need to override this behavior, it's a simple matter of supplying the header yourself, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
this.rest.get()
@ -166,7 +182,8 @@ this.rest.get()
.block()
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
this.rest.get()
@ -176,7 +193,7 @@ this.rest.get()
.bodyToMono<String>()
.block()
----
====
======
In this case, the filter will fall back and simply forward the request onto the rest of the web filter chain.
@ -188,8 +205,10 @@ To obtain this level of support, please use the OAuth 2.0 Client filter.
There is no `RestTemplate` equivalent for `ServletBearerExchangeFilterFunction` at the moment, but you can propagate the request's bearer token quite simply with your own interceptor:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -213,7 +232,8 @@ RestTemplate rest() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -236,7 +256,7 @@ fun rest(): RestTemplate {
return rest
}
----
====
======
[NOTE]
@ -259,8 +279,10 @@ WWW-Authenticate: Bearer error_code="invalid_token", error_description="Unsuppor
Additionally, it is published as an `AuthenticationFailureBadCredentialsEvent`, which you can xref:servlet/authentication/events.adoc#servlet-events[listen for in your application] like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Component
@ -274,7 +296,8 @@ public class FailureEvents {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Component
@ -287,4 +310,4 @@ class FailureEvents {
}
}
----
====
======

361
docs/modules/ROOT/pages/servlet/oauth2/resource-server/jwt.adoc
View File

@ -140,8 +140,10 @@ There are two ``@Bean``s that Spring Boot generates on Resource Server's behalf.
The first is a `SecurityFilterChain` that configures the app as a resource server. When including `spring-security-oauth2-jose`, this `SecurityFilterChain` looks like:
.Default JWT Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -155,7 +157,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -171,15 +174,17 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
return http.build()
}
----
====
======
If the application doesn't expose a `SecurityFilterChain` bean, then Spring Boot will expose the above default one.
Replacing this is as simple as exposing the bean within the application:
.Custom JWT Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -201,7 +206,8 @@ public class MyCustomSecurityConfiguration {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -223,7 +229,7 @@ class MyCustomSecurityConfiguration {
}
}
----
====
======
The above requires the scope of `message:read` for any URL that starts with `/messages/`.
@ -233,8 +239,10 @@ Methods on the `oauth2ResourceServer` DSL will also override or replace auto con
For example, the second `@Bean` Spring Boot creates is a `JwtDecoder`, which <<oauth2resourceserver-jwt-architecture-jwtdecoder,decodes `String` tokens into validated instances of `Jwt`>>:
.JWT Decoder
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -243,7 +251,8 @@ public JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -251,7 +260,7 @@ fun jwtDecoder(): JwtDecoder {
return JwtDecoders.fromIssuerLocation(issuerUri)
}
----
====
======
[NOTE]
Calling `{security-api-url}org/springframework/security/oauth2/jwt/JwtDecoders.html#fromIssuerLocation-java.lang.String-[JwtDecoders#fromIssuerLocation]` is what invokes the Provider Configuration or Authorization Server Metadata endpoint in order to derive the JWK Set Uri.
@ -265,8 +274,10 @@ Or, if you're not using Spring Boot at all, then both of these components - the
The filter chain is specified like so:
.Default JWT Configuration
====
.Xml
[tabs]
======
Xml::
+
[source,xml,role="primary"]
----
<http>
@ -276,13 +287,15 @@ The filter chain is specified like so:
</oauth2-resource-server>
</http>
----
====
======
And the `JwtDecoder` like so:
.JWT Decoder
====
.Xml
[tabs]
======
Xml::
+
[source,xml,role="primary"]
----
<bean id="jwtDecoder"
@ -291,7 +304,7 @@ And the `JwtDecoder` like so:
<constructor-arg value="${spring.security.oauth2.resourceserver.jwt.jwk-set-uri}"/>
</bean>
----
====
======
[[oauth2resourceserver-jwt-jwkseturi-dsl]]
=== Using `jwkSetUri()`
@ -299,8 +312,10 @@ And the `JwtDecoder` like so:
An authorization server's JWK Set Uri can be configured <<oauth2resourceserver-jwt-jwkseturi,as a configuration property>> or it can be supplied in the DSL:
.JWK Set Uri Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -321,7 +336,8 @@ public class DirectlyConfiguredJwkSetUri {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -343,7 +359,8 @@ class DirectlyConfiguredJwkSetUri {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -353,7 +370,7 @@ class DirectlyConfiguredJwkSetUri {
</oauth2-resource-server>
</http>
----
====
======
Using `jwkSetUri()` takes precedence over any configuration property.
@ -363,8 +380,10 @@ Using `jwkSetUri()` takes precedence over any configuration property.
More powerful than `jwkSetUri()` is `decoder()`, which will completely replace any Boot auto configuration of <<oauth2resourceserver-jwt-architecture-jwtdecoder,`JwtDecoder`>>:
.JWT Decoder Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -385,7 +404,8 @@ public class DirectlyConfiguredJwtDecoder {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -407,7 +427,8 @@ class DirectlyConfiguredJwtDecoder {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -417,7 +438,7 @@ class DirectlyConfiguredJwtDecoder {
</oauth2-resource-server>
</http>
----
====
======
This is handy when deeper configuration, like <<oauth2resourceserver-jwt-validation,validation>>, <<oauth2resourceserver-jwt-claimsetmapping,mapping>>, or <<oauth2resourceserver-jwt-timeouts,request timeouts>>, is necessary.
@ -426,8 +447,10 @@ This is handy when deeper configuration, like <<oauth2resourceserver-jwt-validat
Or, exposing a <<oauth2resourceserver-jwt-architecture-jwtdecoder,`JwtDecoder`>> `@Bean` has the same effect as `decoder()`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -436,7 +459,8 @@ public JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -444,7 +468,7 @@ fun jwtDecoder(): JwtDecoder {
return NimbusJwtDecoder.withJwkSetUri(jwkSetUri).build()
}
----
====
======
[[oauth2resourceserver-jwt-decoder-algorithm]]
== Configuring Trusted Algorithms
@ -474,8 +498,10 @@ spring:
For greater power, though, we can use a builder that ships with `NimbusJwtDecoder`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -485,7 +511,8 @@ JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -494,12 +521,14 @@ fun jwtDecoder(): JwtDecoder {
.jwsAlgorithm(RS512).build()
}
----
====
======
Calling `jwsAlgorithm` more than once will configure `NimbusJwtDecoder` to trust more than one algorithm, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -509,7 +538,8 @@ JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -518,12 +548,14 @@ fun jwtDecoder(): JwtDecoder {
.jwsAlgorithm(RS512).jwsAlgorithm(ES512).build()
}
----
====
======
Or, you can call `jwsAlgorithms`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -536,7 +568,8 @@ JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -548,7 +581,7 @@ fun jwtDecoder(): JwtDecoder {
}.build()
}
----
====
======
[[oauth2resourceserver-jwt-decoder-jwk-response]]
=== From JWK Set response
@ -558,8 +591,10 @@ Since Spring Security's JWT support is based off of Nimbus, you can use all it's
For example, Nimbus has a `JWSKeySelector` implementation that will select the set of algorithms based on the JWK Set URI response.
You can use it to generate a `NimbusJwtDecoder` like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -576,7 +611,8 @@ public JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -588,7 +624,7 @@ fun jwtDecoder(): JwtDecoder {
return NimbusJwtDecoder(jwtProcessor)
}
----
====
======
[[oauth2resourceserver-jwt-decoder-public-key]]
== Trusting a Single Asymmetric Key
@ -614,8 +650,10 @@ spring:
Or, to allow for a more sophisticated lookup, you can post-process the `RsaKeyConversionServicePostProcessor`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -626,7 +664,8 @@ BeanFactoryPostProcessor conversionServiceCustomizer() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -637,7 +676,7 @@ fun conversionServiceCustomizer(): BeanFactoryPostProcessor {
}
}
----
====
======
Specify your key's location:
@ -648,29 +687,34 @@ key.location: hfds://my-key.pub
And then autowire the value:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Value("${key.location}")
RSAPublicKey key;
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Value("\${key.location}")
val key: RSAPublicKey? = null
----
====
======
[[oauth2resourceserver-jwt-decoder-public-key-builder]]
=== Using a Builder
To wire an `RSAPublicKey` directly, you can simply use the appropriate `NimbusJwtDecoder` builder, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -679,7 +723,8 @@ public JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -687,7 +732,7 @@ fun jwtDecoder(): JwtDecoder {
return NimbusJwtDecoder.withPublicKey(this.key).build()
}
----
====
======
[[oauth2resourceserver-jwt-decoder-secret-key]]
== Trusting a Single Symmetric Key
@ -695,8 +740,10 @@ fun jwtDecoder(): JwtDecoder {
Using a single symmetric key is also simple.
You can simply load in your `SecretKey` and use the appropriate `NimbusJwtDecoder` builder, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -705,7 +752,8 @@ public JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -713,7 +761,7 @@ fun jwtDecoder(): JwtDecoder {
return NimbusJwtDecoder.withSecretKey(key).build()
}
----
====
======
[[oauth2resourceserver-jwt-authorization]]
== Configuring Authorization
@ -727,8 +775,10 @@ When this is the case, Resource Server will attempt to coerce these scopes into
This means that to protect an endpoint or method with a scope derived from a JWT, the corresponding expressions should include this prefix:
.Authorization Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -747,7 +797,8 @@ public class DirectlyConfiguredJwkSetUri {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -769,7 +820,8 @@ class DirectlyConfiguredJwkSetUri {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -780,25 +832,28 @@ class DirectlyConfiguredJwkSetUri {
</oauth2-resource-server>
</http>
----
====
======
Or similarly with method security:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@PreAuthorize("hasAuthority('SCOPE_messages')")
public List<Message> getMessages(...) {}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@PreAuthorize("hasAuthority('SCOPE_messages')")
fun getMessages(): List<Message> { }
----
====
======
[[oauth2resourceserver-jwt-authorization-extraction]]
=== Extracting Authorities Manually
@ -816,8 +871,10 @@ Let's say that that your authorization server communicates authorities in a cust
In that case, you can configure the claim that <<oauth2resourceserver-jwt-architecture-jwtauthenticationconverter,`JwtAuthenticationConverter`>> should inspect, like so:
.Authorities Claim Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -831,7 +888,8 @@ public JwtAuthenticationConverter jwtAuthenticationConverter() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -845,7 +903,8 @@ fun jwtAuthenticationConverter(): JwtAuthenticationConverter {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -867,14 +926,16 @@ fun jwtAuthenticationConverter(): JwtAuthenticationConverter {
<property name="authoritiesClaimName" value="authorities"/>
</bean>
----
====
======
You can also configure the authority prefix to be different as well.
Instead of prefixing each authority with `SCOPE_`, you can change it to `ROLE_` like so:
.Authorities Prefix Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -888,7 +949,8 @@ public JwtAuthenticationConverter jwtAuthenticationConverter() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -902,7 +964,8 @@ fun jwtAuthenticationConverter(): JwtAuthenticationConverter {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -924,14 +987,16 @@ fun jwtAuthenticationConverter(): JwtAuthenticationConverter {
<property name="authorityPrefix" value="ROLE_"/>
</bean>
----
====
======
Or, you can remove the prefix altogether by calling `JwtGrantedAuthoritiesConverter#setAuthorityPrefix("")`.
For more flexibility, the DSL supports entirely replacing the converter with any class that implements `Converter<Jwt, AbstractAuthenticationToken>`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
static class CustomAuthenticationConverter implements Converter<Jwt, AbstractAuthenticationToken> {
@ -960,7 +1025,8 @@ public class CustomAuthenticationConverterConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
internal class CustomAuthenticationConverter : Converter<Jwt, AbstractAuthenticationToken> {
@ -989,7 +1055,7 @@ class CustomAuthenticationConverterConfig {
}
}
----
====
======
[[oauth2resourceserver-jwt-validation]]
== Configuring Validation
@ -1008,8 +1074,10 @@ This can cause some implementation heartburn as the number of collaborating serv
Resource Server uses `JwtTimestampValidator` to verify a token's validity window, and it can be configured with a `clockSkew` to alleviate the above problem:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -1027,7 +1095,8 @@ JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -1043,7 +1112,7 @@ fun jwtDecoder(): JwtDecoder {
return jwtDecoder
}
----
====
======
[NOTE]
By default, Resource Server configures a clock skew of 60 seconds.
@ -1053,8 +1122,10 @@ By default, Resource Server configures a clock skew of 60 seconds.
Adding a check for the `aud` claim is simple with the `OAuth2TokenValidator` API:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
OAuth2TokenValidator<Jwt> audienceValidator() {
@ -1062,19 +1133,22 @@ OAuth2TokenValidator<Jwt> audienceValidator() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
fun audienceValidator(): OAuth2TokenValidator<Jwt?> {
return JwtClaimValidator<List<String>>(AUD) { aud -> aud.contains("messaging") }
}
----
====
======
Or, for more control you can implement your own `OAuth2TokenValidator`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
static class AudienceValidator implements OAuth2TokenValidator<Jwt> {
@ -1097,7 +1171,8 @@ OAuth2TokenValidator<Jwt> audienceValidator() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
internal class AudienceValidator : OAuth2TokenValidator<Jwt> {
@ -1118,12 +1193,14 @@ fun audienceValidator(): OAuth2TokenValidator<Jwt> {
return AudienceValidator()
}
----
====
======
Then, to add into a resource server, it's a matter of specifying the <<oauth2resourceserver-jwt-architecture-jwtdecoder,`JwtDecoder`>> instance:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -1141,7 +1218,8 @@ JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -1157,7 +1235,7 @@ fun jwtDecoder(): JwtDecoder {
return jwtDecoder
}
----
====
======
[[oauth2resourceserver-jwt-claimsetmapping]]
== Configuring Claim Set Mapping
@ -1191,8 +1269,10 @@ By default, `MappedJwtClaimSetConverter` will attempt to coerce claims into the
An individual claim's conversion strategy can be configured using `MappedJwtClaimSetConverter.withDefaults`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -1207,7 +1287,8 @@ JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -1221,7 +1302,7 @@ fun jwtDecoder(): JwtDecoder {
return jwtDecoder
}
----
====
======
This will keep all the defaults, except it will override the default claim converter for `sub`.
[[oauth2resourceserver-jwt-claimsetmapping-add]]
@ -1229,46 +1310,54 @@ This will keep all the defaults, except it will override the default claim conve
`MappedJwtClaimSetConverter` can also be used to add a custom claim, for example, to adapt to an existing system:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
MappedJwtClaimSetConverter.withDefaults(Collections.singletonMap("custom", custom -> "value"));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
MappedJwtClaimSetConverter.withDefaults(mapOf("custom" to Converter<Any, String> { "value" }))
----
====
======
[[oauth2resourceserver-jwt-claimsetmapping-remove]]
=== Removing a Claim
And removing a claim is also simple, using the same API:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
MappedJwtClaimSetConverter.withDefaults(Collections.singletonMap("legacyclaim", legacy -> null));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
MappedJwtClaimSetConverter.withDefaults(mapOf("legacyclaim" to Converter<Any, Any> { null }))
----
====
======
[[oauth2resourceserver-jwt-claimsetmapping-rename]]
=== Renaming a Claim
In more sophisticated scenarios, like consulting multiple claims at once or renaming a claim, Resource Server accepts any class that implements `Converter<Map<String, Object>, Map<String,Object>>`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class UsernameSubClaimAdapter implements Converter<Map<String, Object>, Map<String, Object>> {
@ -1286,7 +1375,8 @@ public class UsernameSubClaimAdapter implements Converter<Map<String, Object>, M
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class UsernameSubClaimAdapter : Converter<Map<String, Any?>, Map<String, Any?>> {
@ -1299,12 +1389,14 @@ class UsernameSubClaimAdapter : Converter<Map<String, Any?>, Map<String, Any?>>
}
}
----
====
======
And then, the instance can be supplied like normal:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -1315,7 +1407,8 @@ JwtDecoder jwtDecoder() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -1325,7 +1418,7 @@ fun jwtDecoder(): JwtDecoder {
return jwtDecoder
}
----
====
======
[[oauth2resourceserver-jwt-timeouts]]
== Configuring Timeouts
@ -1337,8 +1430,10 @@ Further, it doesn't take into account more sophisticated patterns like back-off
To adjust the way in which Resource Server connects to the authorization server, `NimbusJwtDecoder` accepts an instance of `RestOperations`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -1353,7 +1448,8 @@ public JwtDecoder jwtDecoder(RestTemplateBuilder builder) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -1365,15 +1461,17 @@ fun jwtDecoder(builder: RestTemplateBuilder): JwtDecoder {
return NimbusJwtDecoder.withJwkSetUri(jwkSetUri).restOperations(rest).build()
}
----
====
======
Also by default, Resource Server caches in-memory the authorization server's JWK set for 5 minutes, which you may want to adjust.
Further, it doesn't take into account more sophisticated caching patterns like eviction or using a shared cache.
To adjust the way in which Resource Server caches the JWK set, `NimbusJwtDecoder` accepts an instance of `Cache`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -1384,7 +1482,8 @@ public JwtDecoder jwtDecoder(CacheManager cacheManager) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -1394,7 +1493,7 @@ fun jwtDecoder(cacheManager: CacheManager): JwtDecoder {
.build()
}
----
====
======
When given a `Cache`, Resource Server will use the JWK Set Uri as the key and the JWK Set JSON as the value.

94
docs/modules/ROOT/pages/servlet/oauth2/resource-server/multitenancy.adoc
View File

@ -8,8 +8,10 @@ For example, you may support more than one tenant where one tenant issues JWTs a
If this decision must be made at request-time, then you can use an `AuthenticationManagerResolver` to achieve it, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -22,7 +24,8 @@ AuthenticationManagerResolver<HttpServletRequest> tokenAuthenticationManagerReso
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -41,15 +44,17 @@ fun tokenAuthenticationManagerResolver
}
}
----
====
======
NOTE: The implementation of `useJwt(HttpServletRequest)` will likely depend on custom request material like the path.
And then specify this `AuthenticationManagerResolver` in the DSL:
.Authentication Manager Resolver
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
http
@ -61,7 +66,8 @@ http
);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
http {
@ -74,14 +80,15 @@ http {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
<oauth2-resource-server authentication-manager-resolver-ref="tokenAuthenticationManagerResolver"/>
</http>
----
====
======
[[oauth2resourceserver-multitenancy]]
== Multi-tenancy
@ -101,8 +108,10 @@ In each case, there are two things that need to be done and trade-offs associate
One way to differentiate tenants is by the issuer claim. Since the issuer claim accompanies signed JWTs, this can be done with the `JwtIssuerAuthenticationManagerResolver`, like so:
.Multi-tenancy Tenant by JWT Claim
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
JwtIssuerAuthenticationManagerResolver authenticationManagerResolver = new JwtIssuerAuthenticationManagerResolver
@ -117,7 +126,8 @@ http
);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val customAuthenticationManagerResolver = JwtIssuerAuthenticationManagerResolver
@ -132,7 +142,8 @@ http {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -149,7 +160,7 @@ http {
</constructor-arg>
</bean>
----
====
======
This is nice because the issuer endpoints are loaded lazily.
In fact, the corresponding `JwtAuthenticationProvider` is instantiated only when the first request with the corresponding issuer is sent.
@ -160,8 +171,10 @@ This allows for an application startup that is independent from those authorizat
Of course, you may not want to restart the application each time a new tenant is added.
In this case, you can configure the `JwtIssuerAuthenticationManagerResolver` with a repository of `AuthenticationManager` instances, which you can edit at runtime, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
private void addManager(Map<String, AuthenticationManager> authenticationManagers, String issuer) {
@ -184,7 +197,8 @@ http
);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
private fun addManager(authenticationManagers: MutableMap<String, AuthenticationManager>, issuer: String) {
@ -207,7 +221,7 @@ http {
}
}
----
====
======
In this case, you construct `JwtIssuerAuthenticationManagerResolver` with a strategy for obtaining the `AuthenticationManager` given the issuer.
This approach allows us to add and remove elements from the repository (shown as a `Map` in the snippet) at runtime.
@ -221,8 +235,10 @@ You may have observed that this strategy, while simple, comes with the trade-off
This extra parsing can be alleviated by configuring the xref:servlet/oauth2/resource-server/jwt.adoc#oauth2resourceserver-jwt-architecture-jwtdecoder[`JwtDecoder`] directly with a `JWTClaimsSetAwareJWSKeySelector` from Nimbus:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Component
@ -264,7 +280,8 @@ public class TenantJWSKeySelector
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Component
@ -301,7 +318,7 @@ class TenantJWSKeySelector(tenants: TenantRepository) : JWTClaimsSetAwareJWSKeyS
}
}
----
====
======
<1> A hypothetical source for tenant information
<2> A cache for `JWKKeySelector`s, keyed by tenant identifier
<3> Looking up the tenant is more secure than simply calculating the JWK Set endpoint on the fly - the lookup acts as a list of allowed tenants
@ -315,8 +332,10 @@ Without this, you have no guarantee that the issuer hasn't been altered by a bad
Next, we can construct a `JWTProcessor`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -328,7 +347,8 @@ JWTProcessor jwtProcessor(JWTClaimSetJWSKeySelector keySelector) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -338,7 +358,7 @@ fun jwtProcessor(keySelector: JWTClaimsSetAwareJWSKeySelector<SecurityContext>):
return jwtProcessor
}
----
====
======
As you are already seeing, the trade-off for moving tenant-awareness down to this level is more configuration.
We have just a bit more.
@ -346,8 +366,10 @@ We have just a bit more.
Next, we still want to make sure you are validating the issuer.
But, since the issuer may be different per JWT, then you'll need a tenant-aware validator, too:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Component
@ -378,7 +400,8 @@ public class TenantJwtIssuerValidator implements OAuth2TokenValidator<Jwt> {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Component
@ -406,12 +429,14 @@ class TenantJwtIssuerValidator(tenants: TenantRepository) : OAuth2TokenValidator
}
}
----
====
======
Now that we have a tenant-aware processor and a tenant-aware validator, we can proceed with creating our xref:servlet/oauth2/resource-server/jwt.adoc#oauth2resourceserver-jwt-architecture-jwtdecoder[`JwtDecoder`]:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -424,7 +449,8 @@ JwtDecoder jwtDecoder(JWTProcessor jwtProcessor, OAuth2TokenValidator<Jwt> jwtVa
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -435,7 +461,7 @@ fun jwtDecoder(jwtProcessor: JWTProcessor<SecurityContext>?, jwtValidator: OAuth
return decoder
}
----
====
======
We've finished talking about resolving the tenant.

223
docs/modules/ROOT/pages/servlet/oauth2/resource-server/opaque-token.adoc
View File

@ -106,8 +106,10 @@ Once a token is authenticated, an instance of `BearerTokenAuthentication` is set
This means that it's available in `@Controller` methods when using `@EnableWebMvc` in your configuration:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@GetMapping("/foo")
@ -116,7 +118,8 @@ public String foo(BearerTokenAuthentication authentication) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@GetMapping("/foo")
@ -124,12 +127,14 @@ fun foo(authentication: BearerTokenAuthentication): String {
return authentication.tokenAttributes["sub"].toString() + " is the subject"
}
----
====
======
Since `BearerTokenAuthentication` holds an `OAuth2AuthenticatedPrincipal`, that also means that it's available to controller methods, too:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@GetMapping("/foo")
@ -138,7 +143,8 @@ public String foo(@AuthenticationPrincipal OAuth2AuthenticatedPrincipal principa
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@GetMapping("/foo")
@ -146,7 +152,7 @@ fun foo(@AuthenticationPrincipal principal: OAuth2AuthenticatedPrincipal): Strin
return principal.getAttribute<Any>("sub").toString() + " is the subject"
}
----
====
======
=== Looking Up Attributes Via SpEL
@ -154,8 +160,10 @@ Of course, this also means that attributes can be accessed via SpEL.
For example, if using `@EnableGlobalMethodSecurity` so that you can use `@PreAuthorize` annotations, you can do:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@PreAuthorize("principal?.attributes['sub'] == 'foo'")
@ -164,7 +172,8 @@ public String forFoosEyesOnly() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@PreAuthorize("principal?.attributes['sub'] == 'foo'")
@ -172,7 +181,7 @@ fun forFoosEyesOnly(): String {
return "foo"
}
----
====
======
[[oauth2resourceserver-opaque-sansboot]]
== Overriding or Replacing Boot Auto Configuration
@ -183,8 +192,10 @@ The first is a `SecurityFilterChain` that configures the app as a resource serve
When use Opaque Token, this `SecurityFilterChain` looks like:
.Default Opaque Token Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -198,7 +209,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -214,15 +226,17 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
return http.build()
}
----
====
======
If the application doesn't expose a `SecurityFilterChain` bean, then Spring Boot will expose the above default one.
Replacing this is as simple as exposing the bean within the application:
.Custom Opaque Token Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -244,7 +258,8 @@ public class MyCustomSecurityConfiguration {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -266,7 +281,7 @@ class MyCustomSecurityConfiguration {
}
}
----
====
======
The above requires the scope of `message:read` for any URL that starts with `/messages/`.
@ -275,8 +290,10 @@ Methods on the `oauth2ResourceServer` DSL will also override or replace auto con
[[oauth2resourceserver-opaque-introspector]]
For example, the second `@Bean` Spring Boot creates is an `OpaqueTokenIntrospector`, <<oauth2resourceserver-opaque-architecture-introspector,which decodes `String` tokens into validated instances of `OAuth2AuthenticatedPrincipal`>>:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -285,7 +302,8 @@ public OpaqueTokenIntrospector introspector() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -293,7 +311,7 @@ fun introspector(): OpaqueTokenIntrospector {
return NimbusOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret)
}
----
====
======
If the application doesn't expose a <<oauth2resourceserver-opaque-architecture-introspector,`OpaqueTokenIntrospector`>> bean, then Spring Boot will expose the above default one.
@ -304,8 +322,10 @@ Or, if you're not using Spring Boot at all, then both of these components - the
The filter chain is specified like so:
.Default Opaque Token Configuration
====
.Xml
[tabs]
======
Xml::
+
[source,xml,role="primary"]
----
<http>
@ -315,13 +335,15 @@ The filter chain is specified like so:
</oauth2-resource-server>
</http>
----
====
======
And the <<oauth2resourceserver-opaque-architecture-introspector,`OpaqueTokenIntrospector`>> like so:
.Opaque Token Introspector
====
.Xml
[tabs]
======
Xml::
+
[source,xml,role="primary"]
----
<bean id="opaqueTokenIntrospector"
@ -331,7 +353,7 @@ And the <<oauth2resourceserver-opaque-architecture-introspector,`OpaqueTokenIntr
<constructor-arg value="${spring.security.oauth2.resourceserver.opaquetoken.client_secret}"/>
</bean>
----
====
======
[[oauth2resourceserver-opaque-introspectionuri-dsl]]
=== Using `introspectionUri()`
@ -339,8 +361,10 @@ And the <<oauth2resourceserver-opaque-architecture-introspector,`OpaqueTokenIntr
An authorization server's Introspection Uri can be configured <<oauth2resourceserver-opaque-introspectionuri,as a configuration property>> or it can be supplied in the DSL:
.Introspection URI Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -362,7 +386,8 @@ public class DirectlyConfiguredIntrospectionUri {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -385,7 +410,8 @@ class DirectlyConfiguredIntrospectionUri {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<bean id="opaqueTokenIntrospector"
@ -395,7 +421,7 @@ class DirectlyConfiguredIntrospectionUri {
<constructor-arg value="secret"/>
</bean>
----
====
======
Using `introspectionUri()` takes precedence over any configuration property.
@ -405,8 +431,10 @@ Using `introspectionUri()` takes precedence over any configuration property.
More powerful than `introspectionUri()` is `introspector()`, which will completely replace any Boot auto configuration of <<oauth2resourceserver-opaque-architecture-introspector,`OpaqueTokenIntrospector`>>:
.Introspector Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -427,7 +455,8 @@ public class DirectlyConfiguredIntrospector {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -449,7 +478,8 @@ class DirectlyConfiguredIntrospector {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -459,7 +489,7 @@ class DirectlyConfiguredIntrospector {
</oauth2-resource-server>
</http>
----
====
======
This is handy when deeper configuration, like <<oauth2resourceserver-opaque-authorization-extraction,authority mapping>>, <<oauth2resourceserver-opaque-jwt-introspector,JWT revocation>>, or <<oauth2resourceserver-opaque-timeouts,request timeouts>>, is necessary.
@ -488,8 +518,10 @@ When this is the case, Resource Server will attempt to coerce these scopes into
This means that to protect an endpoint or method with a scope derived from an Opaque Token, the corresponding expressions should include this prefix:
.Authorization Opaque Token Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -508,7 +540,8 @@ public class MappedAuthorities {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -530,7 +563,8 @@ class MappedAuthorities {
}
----
.Xml
Xml::
+
[source,xml,role="secondary"]
----
<http>
@ -541,25 +575,28 @@ class MappedAuthorities {
</oauth2-resource-server>
</http>
----
====
======
Or similarly with method security:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@PreAuthorize("hasAuthority('SCOPE_messages')")
public List<Message> getMessages(...) {}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@PreAuthorize("hasAuthority('SCOPE_messages')")
fun getMessages(): List<Message?> {}
----
====
======
[[oauth2resourceserver-opaque-authorization-extraction]]
=== Extracting Authorities Manually
@ -580,8 +617,10 @@ Then Resource Server would generate an `Authentication` with two authorities, on
This can, of course, be customized using a custom <<oauth2resourceserver-opaque-architecture-introspector,`OpaqueTokenIntrospector`>> that takes a look at the attribute set and converts in its own way:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class CustomAuthoritiesOpaqueTokenIntrospector implements OpaqueTokenIntrospector {
@ -603,7 +642,8 @@ public class CustomAuthoritiesOpaqueTokenIntrospector implements OpaqueTokenIntr
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class CustomAuthoritiesOpaqueTokenIntrospector : OpaqueTokenIntrospector {
@ -621,12 +661,14 @@ class CustomAuthoritiesOpaqueTokenIntrospector : OpaqueTokenIntrospector {
}
}
----
====
======
Thereafter, this custom introspector can be configured simply by exposing it as a `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -635,7 +677,8 @@ public OpaqueTokenIntrospector introspector() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -643,7 +686,7 @@ fun introspector(): OpaqueTokenIntrospector {
return CustomAuthoritiesOpaqueTokenIntrospector()
}
----
====
======
[[oauth2resourceserver-opaque-timeouts]]
== Configuring Timeouts
@ -655,8 +698,10 @@ Further, it doesn't take into account more sophisticated patterns like back-off
To adjust the way in which Resource Server connects to the authorization server, `NimbusOpaqueTokenIntrospector` accepts an instance of `RestOperations`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -671,7 +716,8 @@ public OpaqueTokenIntrospector introspector(RestTemplateBuilder builder, OAuth2R
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -684,7 +730,7 @@ fun introspector(builder: RestTemplateBuilder, properties: OAuth2ResourceServerP
return NimbusOpaqueTokenIntrospector(introspectionUri, rest)
}
----
====
======
[[oauth2resourceserver-opaque-jwt-introspector]]
== Using Introspection with JWTs
@ -716,8 +762,10 @@ Now what?
In this case, you can create a custom <<oauth2resourceserver-opaque-architecture-introspector,`OpaqueTokenIntrospector`>> that still hits the endpoint, but then updates the returned principal to have the JWTs claims as the attributes:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class JwtOpaqueTokenIntrospector implements OpaqueTokenIntrospector {
@ -744,7 +792,8 @@ public class JwtOpaqueTokenIntrospector implements OpaqueTokenIntrospector {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class JwtOpaqueTokenIntrospector : OpaqueTokenIntrospector {
@ -767,12 +816,14 @@ class JwtOpaqueTokenIntrospector : OpaqueTokenIntrospector {
}
}
----
====
======
Thereafter, this custom introspector can be configured simply by exposing it as a `@Bean`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -781,7 +832,8 @@ public OpaqueTokenIntrospector introspector() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -789,7 +841,7 @@ fun introspector(): OpaqueTokenIntrospector {
return JwtOpaqueTokenIntrospector()
}
----
====
======
[[oauth2resourceserver-opaque-userinfo]]
== Calling a `/userinfo` Endpoint
@ -805,8 +857,10 @@ This implementation below does three things:
* Looks up the appropriate client registration associated with the `/userinfo` endpoint
* Invokes and returns the response from the `/userinfo` endpoint
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class UserInfoOpaqueTokenIntrospector implements OpaqueTokenIntrospector {
@ -831,7 +885,8 @@ public class UserInfoOpaqueTokenIntrospector implements OpaqueTokenIntrospector
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class UserInfoOpaqueTokenIntrospector : OpaqueTokenIntrospector {
@ -852,13 +907,15 @@ class UserInfoOpaqueTokenIntrospector : OpaqueTokenIntrospector {
}
}
----
====
======
If you aren't using `spring-security-oauth2-client`, it's still quite simple.
You will simply need to invoke the `/userinfo` with your own instance of `WebClient`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class UserInfoOpaqueTokenIntrospector implements OpaqueTokenIntrospector {
@ -874,7 +931,8 @@ public class UserInfoOpaqueTokenIntrospector implements OpaqueTokenIntrospector
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class UserInfoOpaqueTokenIntrospector : OpaqueTokenIntrospector {
@ -887,12 +945,14 @@ class UserInfoOpaqueTokenIntrospector : OpaqueTokenIntrospector {
}
}
----
====
======
Either way, having created your <<oauth2resourceserver-opaque-architecture-introspector,`OpaqueTokenIntrospector`>>, you should publish it as a `@Bean` to override the defaults:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -901,7 +961,8 @@ OpaqueTokenIntrospector introspector() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -909,4 +970,4 @@ fun introspector(): OpaqueTokenIntrospector {
return UserInfoOpaqueTokenIntrospector(...)
}
----
====
======

58
docs/modules/ROOT/pages/servlet/saml2/login/authentication-requests.adoc
View File

@ -23,8 +23,10 @@ By default, Spring Security uses an `HttpSessionSaml2AuthenticationRequestReposi
If you have a custom implementation of `Saml2AuthenticationRequestRepository`, you may configure it by exposing it as a `@Bean` as shown in the following example:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -33,7 +35,8 @@ Saml2AuthenticationRequestRepository<AbstractSaml2AuthenticationRequest> authent
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -41,7 +44,7 @@ open fun authenticationRequestRepository(): Saml2AuthenticationRequestRepository
return CustomSaml2AuthenticationRequestRepository()
}
----
====
======
[[servlet-saml2login-sp-initiated-factory-signing]]
== Changing How the `<saml2:AuthnRequest>` Gets Sent
@ -53,8 +56,10 @@ This can be configured automatically via `RelyingPartyRegistrations`, or you can
.Not Requiring Signed AuthnRequests
====
.Boot
[tabs]
======
Boot::
+
[source,yaml,role="primary"]
----
spring:
@ -67,7 +72,8 @@ spring:
singlesignon.sign-request: false
----
.Java
Java::
+
[source,java,role="secondary"]
----
RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistration.withRegistrationId("okta")
@ -79,7 +85,8 @@ RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistration.wit
.build();
----
.Kotlin
Kotlin::
+
[source,java,role="secondary"]
----
var relyingPartyRegistration: RelyingPartyRegistration =
@ -91,7 +98,7 @@ var relyingPartyRegistration: RelyingPartyRegistration =
}
.build();
----
====
======
Otherwise, you will need to specify a private key to `RelyingPartyRegistration#signingX509Credentials` so that Spring Security can sign the `<saml2:AuthnRequest>` before sending.
@ -102,8 +109,10 @@ You can configure the algorithm based on the asserting party's xref:servlet/saml
Or, you can provide it manually:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
String metadataLocation = "classpath:asserting-party-metadata.xml";
@ -116,7 +125,8 @@ RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistrations.fr
.build();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
var metadataLocation = "classpath:asserting-party-metadata.xml"
@ -133,7 +143,7 @@ var relyingPartyRegistration: RelyingPartyRegistration =
}
.build();
----
====
======
NOTE: The snippet above uses the OpenSAML `SignatureConstants` class to supply the algorithm name.
But, that's just for convenience.
@ -143,8 +153,10 @@ Since the datatype is `String`, you can supply the name of the algorithm directl
Some asserting parties require that the `<saml2:AuthnRequest>` be POSTed.
This can be configured automatically via `RelyingPartyRegistrations`, or you can supply it manually, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistration.withRegistrationId("okta")
@ -156,7 +168,8 @@ RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistration.wit
.build();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
var relyingPartyRegistration: RelyingPartyRegistration? =
@ -168,7 +181,7 @@ var relyingPartyRegistration: RelyingPartyRegistration? =
}
.build()
----
====
======
[[servlet-saml2login-sp-initiated-factory-custom-authnrequest]]
== Customizing OpenSAML's `AuthnRequest` Instance
@ -178,8 +191,10 @@ For example, you may want `ForceAuthN` to be set to `true`, which Spring Securit
You can customize elements of OpenSAML's `AuthnRequest` by publishing an `OpenSaml4AuthenticationRequestResolver` as a `@Bean`, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -194,7 +209,8 @@ Saml2AuthenticationRequestResolver authenticationRequestResolver(RelyingPartyReg
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -208,5 +224,5 @@ fun authenticationRequestResolver(registrations : RelyingPartyRegistrationReposi
return authenticationRequestResolver
}
----
====
======

110
docs/modules/ROOT/pages/servlet/saml2/login/authentication.adoc
View File

@ -20,8 +20,10 @@ To configure these, you'll use the `saml2Login#authenticationManager` method in
To apply a `RelyingPartyRegistrationResolver` when processing `<saml2:Response>` payloads, you should first publish a `Saml2AuthenticationTokenConverter` bean like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -30,7 +32,8 @@ Saml2AuthenticationTokenConverter authenticationConverter(InMemoryRelyingPartyRe
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -38,13 +41,15 @@ fun authenticationConverter(val registrations: InMemoryRelyingPartyRegistrationR
return Saml2AuthenticationTokenConverter(MyRelyingPartyRegistrationResolver(registrations));
}
----
====
======
Recall that the Assertion Consumer Service URL is `+/saml2/login/sso/{registrationId}+` by default.
If you are no longer wanting the `registrationId` in the URL, change it in the filter chain and in your relying party metadata:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -58,7 +63,8 @@ SecurityFilterChain securityFilters(HttpSecurity http) throws Exception {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -74,23 +80,26 @@ fun securityFilters(val http: HttpSecurity): SecurityFilterChain {
return http.build()
}
----
====
======
and:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
relyingPartyRegistrationBuilder.assertionConsumerServiceLocation("/saml2/login/sso")
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
relyingPartyRegistrationBuilder.assertionConsumerServiceLocation("/saml2/login/sso")
----
====
======
[[servlet-saml2login-opensamlauthenticationprovider-clockskew]]
== Setting a Clock Skew
@ -98,8 +107,10 @@ relyingPartyRegistrationBuilder.assertionConsumerServiceLocation("/saml2/login/s
It's not uncommon for the asserting and relying parties to have system clocks that aren't perfectly synchronized.
For that reason, you can configure ``OpenSaml4AuthenticationProvider``'s default assertion validator with some tolerance:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -129,7 +140,8 @@ public class SecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -158,7 +170,7 @@ open class SecurityConfig {
}
}
----
====
======
[[servlet-saml2login-opensamlauthenticationprovider-userdetailsservice]]
== Coordinating with a `UserDetailsService`
@ -166,8 +178,10 @@ open class SecurityConfig {
Or, perhaps you would like to include user details from a legacy `UserDetailsService`.
In that case, the response authentication converter can come in handy, as can be seen below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -200,7 +214,8 @@ public class SecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -232,7 +247,7 @@ open class SecurityConfig {
}
}
----
====
======
<1> First, call the default converter, which extracts attributes and authorities from the response
<2> Second, call the xref:servlet/authentication/passwords/user-details-service.adoc#servlet-authentication-userdetailsservice[`UserDetailsService`] using the relevant information
<3> Third, return a custom authentication that includes the user details
@ -276,8 +291,10 @@ To perform additional validation, you can configure your own assertion validator
[[servlet-saml2login-opensamlauthenticationprovider-onetimeuse]]
For example, you can use OpenSAML's `OneTimeUseConditionValidator` to also validate a `<OneTimeUse>` condition, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
OpenSaml4AuthenticationProvider provider = new OpenSaml4AuthenticationProvider();
@ -300,7 +317,8 @@ provider.setAssertionValidator(assertionToken -> {
});
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
var provider = OpenSaml4AuthenticationProvider()
@ -322,7 +340,7 @@ provider.setAssertionValidator { assertionToken ->
result.concat(Saml2Error(INVALID_ASSERTION, context.validationFailureMessage))
}
----
====
======
[NOTE]
While recommended, it's not necessary to call ``OpenSaml4AuthenticationProvider``'s default assertion validator.
@ -340,8 +358,10 @@ The assertion decrypter is for decrypting encrypted elements of the `<saml2:Asse
You can replace ``OpenSaml4AuthenticationProvider``'s default decryption strategy with your own.
For example, if you have a separate service that decrypts the assertions in a `<saml2:Response>`, you can use it instead like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
MyDecryptionService decryptionService = ...;
@ -349,30 +369,34 @@ OpenSaml4AuthenticationProvider provider = new OpenSaml4AuthenticationProvider()
provider.setResponseElementsDecrypter((responseToken) -> decryptionService.decrypt(responseToken.getResponse()));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val decryptionService: MyDecryptionService = ...
val provider = OpenSaml4AuthenticationProvider()
provider.setResponseElementsDecrypter { responseToken -> decryptionService.decrypt(responseToken.response) }
----
====
======
If you are also decrypting individual elements in a `<saml2:Assertion>`, you can customize the assertion decrypter, too:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
provider.setAssertionElementsDecrypter((assertionToken) -> decryptionService.decrypt(assertionToken.getAssertion()));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
provider.setAssertionElementsDecrypter { assertionToken -> decryptionService.decrypt(assertionToken.assertion) }
----
====
======
NOTE: There are two separate decrypters since assertions can be signed separately from responses.
Trying to decrypt a signed assertion's elements before signature verification may invalidate the signature.
@ -385,8 +409,10 @@ If your asserting party signs the response only, then it's safe to decrypt all e
Of course, the `authenticationManager` DSL method can be also used to perform a completely custom SAML 2.0 authentication.
This authentication manager should expect a `Saml2AuthenticationToken` object containing the SAML 2.0 Response XML data.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -408,7 +434,8 @@ public class SecurityConfig {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -428,7 +455,7 @@ open class SecurityConfig {
}
}
----
====
======
[[servlet-saml2login-authenticatedprincipal]]
== Using `Saml2AuthenticatedPrincipal`
@ -438,8 +465,10 @@ Once the relying party validates an assertion, the result is a `Saml2Authenticat
This means that you can access the principal in your controller like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Controller
@ -453,7 +482,8 @@ public class MainController {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Controller
@ -466,7 +496,7 @@ class MainController {
}
}
----
====
======
[TIP]
Because the SAML 2.0 specification allows for each attribute to have multiple values, you can either call `getAttribute` to get the list of attributes or `getFirstAttribute` to get the first in the list.

168
docs/modules/ROOT/pages/servlet/saml2/login/overview.adoc
View File

@ -188,8 +188,10 @@ The resulting `Authentication#getPrincipal` is a Spring Security `Saml2Authentic
Any class that uses both Spring Security and OpenSAML should statically initialize `OpenSamlInitializationService` at the beginning of the class, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
static {
@ -198,7 +200,8 @@ static {
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
companion object {
@ -207,7 +210,7 @@ companion object {
}
}
----
====
======
This replaces OpenSAML's `InitializationService#initialize`.
@ -217,8 +220,10 @@ In these circumstances, you may instead want to call `OpenSamlInitializationServ
For example, when sending an unsigned AuthNRequest, you may want to force reauthentication.
In that case, you can register your own `AuthnRequestMarshaller`, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
static {
@ -245,7 +250,8 @@ static {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
companion object {
@ -271,7 +277,7 @@ companion object {
}
}
----
====
======
The `requireInitialize` method may only be called once per application instance.
@ -284,8 +290,10 @@ The first is a `SecurityFilterChain` that configures the app as a relying party.
When including `spring-security-saml2-service-provider`, the `SecurityFilterChain` looks like:
.Default SAML 2.0 Login Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Bean
@ -299,7 +307,8 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Bean
@ -313,15 +322,17 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
return http.build()
}
----
====
======
If the application doesn't expose a `SecurityFilterChain` bean, then Spring Boot will expose the above default one.
You can replace this by exposing the bean within the application:
.Custom SAML 2.0 Login Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -339,7 +350,8 @@ public class MyCustomSecurityConfiguration {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -358,7 +370,7 @@ class MyCustomSecurityConfiguration {
}
}
----
====
======
The above requires the role of `USER` for any URL that starts with `/messages/`.
@ -370,8 +382,10 @@ You can override the default by publishing your own `RelyingPartyRegistrationRep
For example, you can look up the asserting party's configuration by hitting its metadata endpoint like so:
.Relying Party Registration Repository
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Value("${metadata.location}")
@ -387,7 +401,8 @@ public RelyingPartyRegistrationRepository relyingPartyRegistrations() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Value("\${metadata.location}")
@ -402,7 +417,7 @@ open fun relyingPartyRegistrations(): RelyingPartyRegistrationRepository? {
return InMemoryRelyingPartyRegistrationRepository(registration)
}
----
====
======
[[servlet-saml2login-relyingpartyregistrationid]]
[NOTE]
@ -411,8 +426,10 @@ The `registrationId` is an arbitrary value that you choose for differentiating b
Or you can provide each detail manually, as you can see below:
.Relying Party Registration Repository Manual Configuration
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Value("${verification.key}")
@ -435,7 +452,8 @@ public RelyingPartyRegistrationRepository relyingPartyRegistrations() throws Exc
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Value("\${verification.key}")
@ -462,18 +480,20 @@ open fun relyingPartyRegistrations(): RelyingPartyRegistrationRepository {
return InMemoryRelyingPartyRegistrationRepository(registration)
}
----
====
======
[NOTE]
Note that `X509Support` is an OpenSAML class, used here in the snippet for brevity
[[servlet-saml2login-relyingpartyregistrationrepository-dsl]]
[[servlet-saml2login-relyingpartyregistrationrepository-dsl]]
Alternatively, you can directly wire up the repository using the DSL, which will also override the auto-configured `SecurityFilterChain`:
.Custom Relying Party Registration DSL
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@EnableWebSecurity
@ -493,7 +513,8 @@ public class MyCustomSecurityConfiguration {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@EnableWebSecurity
@ -513,7 +534,7 @@ class MyCustomSecurityConfiguration {
}
}
----
====
======
[NOTE]
A relying party can be multi-tenant by registering more than one relying party in the `RelyingPartyRegistrationRepository`.
@ -529,8 +550,10 @@ Also, you can provide asserting party metadata like its `Issuer` value, where it
The following `RelyingPartyRegistration` is the minimum required for most setups:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistrations
@ -538,7 +561,9 @@ RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistrations
.registrationId("my-id")
.build();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val relyingPartyRegistration = RelyingPartyRegistrations
@ -546,7 +571,7 @@ val relyingPartyRegistration = RelyingPartyRegistrations
.registrationId("my-id")
.build()
----
====
======
Note that you can also create a `RelyingPartyRegistration` from an arbitrary `InputStream` source.
One such example is when the metadata is stored in a database:
@ -564,8 +589,10 @@ try (InputStream source = new ByteArrayInputStream(xml.getBytes())) {
Though a more sophisticated setup is also possible, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistration.withRegistrationId("my-id")
@ -580,7 +607,8 @@ RelyingPartyRegistration relyingPartyRegistration = RelyingPartyRegistration.wit
.build();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val relyingPartyRegistration =
@ -597,7 +625,7 @@ val relyingPartyRegistration =
}
.build()
----
====
======
[TIP]
The top-level metadata methods are details about the relying party.
@ -666,8 +694,10 @@ At a minimum, it's necessary to have a certificate from the asserting party so t
To construct a `Saml2X509Credential` that you'll use to verify assertions from the asserting party, you can load the file and use
the `CertificateFactory` like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Resource resource = new ClassPathResource("ap.crt");
@ -678,7 +708,8 @@ try (InputStream is = resource.getInputStream()) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val resource = ClassPathResource("ap.crt")
@ -688,7 +719,7 @@ resource.inputStream.use {
)
}
----
====
======
Let's say that the asserting party is going to also encrypt the assertion.
In that case, the relying party will need a private key to be able to decrypt the encrypted value.
@ -696,8 +727,10 @@ In that case, the relying party will need a private key to be able to decrypt th
In that case, you'll need an `RSAPrivateKey` as well as its corresponding `X509Certificate`.
You can load the first using Spring Security's `RsaKeyConverters` utility class and the second as you did before:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
X509Certificate certificate = relyingPartyDecryptionCertificate();
@ -708,7 +741,8 @@ try (InputStream is = resource.getInputStream()) {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val certificate: X509Certificate = relyingPartyDecryptionCertificate()
@ -718,7 +752,7 @@ resource.inputStream.use {
return Saml2X509Credential.decryption(rsa, certificate)
}
----
====
======
[TIP]
When you specify the locations of these files as the appropriate Spring Boot properties, then Spring Boot will perform these conversions for you.
@ -760,8 +794,10 @@ Second, in a database, it's not necessary to replicate `RelyingPartyRegistration
Third, in Java, you can create a custom configuration method, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
private RelyingPartyRegistration.Builder
@ -788,7 +824,8 @@ public RelyingPartyRegistrationRepository relyingPartyRegistrations() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
private fun addRelyingPartyDetails(builder: RelyingPartyRegistration.Builder): RelyingPartyRegistration.Builder {
@ -816,7 +853,7 @@ open fun relyingPartyRegistrations(): RelyingPartyRegistrationRepository? {
return InMemoryRelyingPartyRegistrationRepository(okta, azure)
}
----
====
======
[[servlet-saml2login-rpr-relyingpartyregistrationresolver]]
=== Resolving the `RelyingPartyRegistration` from the Request
@ -839,8 +876,10 @@ Remember that if you have any placeholders in your `RelyingPartyRegistration`, y
You can provide a resolver that, for example, always returns the same `RelyingPartyRegistration`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class SingleRelyingPartyRegistrationResolver implements RelyingPartyRegistrationResolver {
@ -858,7 +897,8 @@ public class SingleRelyingPartyRegistrationResolver implements RelyingPartyRegis
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class SingleRelyingPartyRegistrationResolver(delegate: RelyingPartyRegistrationResolver) : RelyingPartyRegistrationResolver {
@ -867,7 +907,7 @@ class SingleRelyingPartyRegistrationResolver(delegate: RelyingPartyRegistrationR
}
}
----
====
======
[TIP]
You might next take a look at how to use this resolver to customize xref:servlet/saml2/metadata.adoc#servlet-saml2login-metadata[`<saml2:SPSSODescriptor>` metadata production].
@ -882,8 +922,10 @@ This carries the implication that the assertion consumer service endpoint will b
You can instead resolve the `registrationId` via the `Issuer`.
A custom implementation of `RelyingPartyRegistrationResolver` that does this may look like:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class SamlResponseIssuerRelyingPartyRegistrationResolver implements RelyingPartyRegistrationResolver {
@ -911,7 +953,8 @@ public class SamlResponseIssuerRelyingPartyRegistrationResolver implements Relyi
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class SamlResponseIssuerRelyingPartyRegistrationResolver(val registrations: InMemoryRelyingPartyRegistrationRepository):
@ -935,7 +978,7 @@ class SamlResponseIssuerRelyingPartyRegistrationResolver(val registrations: InMe
}
}
----
====
======
[TIP]
You might next take a look at how to use this resolver to customize xref:servlet/saml2/login/authentication.adoc#relyingpartyregistrationresolver-apply[`<saml2:Response>` authentication].
@ -948,8 +991,10 @@ In this case, the identity provider's metadata endpoint returns multiple `<md:ID
These multiple asserting parties can be accessed in a single call to `RelyingPartyRegistrations` like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
Collection<RelyingPartyRegistration> registrations = RelyingPartyRegistrations
@ -962,7 +1007,8 @@ Collection<RelyingPartyRegistration> registrations = RelyingPartyRegistrations
.collect(Collectors.toList()));
----
.Kotlin
Kotlin::
+
[source,java,role="secondary"]
----
var registrations: Collection<RelyingPartyRegistration> = RelyingPartyRegistrations
@ -974,7 +1020,7 @@ var registrations: Collection<RelyingPartyRegistration> = RelyingPartyRegistrati
}
.collect(Collectors.toList()));
----
====
======
Note that because the registration id is set to a random value, this will change certain SAML 2.0 endpoints to be unpredictable.
There are several ways to address this; let's focus on a way that suits the specific use case of federation.

8
docs/modules/ROOT/pages/servlet/saml2/logout.adoc
View File

@ -100,8 +100,10 @@ This URL is customizable in the DSL.
For example, if you are migrating your existing relying party over to Spring Security, your asserting party may already be pointing to `GET /SLOService.saml2`.
To reduce changes in configuration for the asserting party, you can configure the filter in the DSL like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
http
@ -110,7 +112,7 @@ http
.logoutResponse((response) -> response.logoutUrl("/SLOService.saml2"))
);
----
====
======
You should also configure these endpoints in your `RelyingPartyRegistration`.

60
docs/modules/ROOT/pages/servlet/saml2/metadata.adoc
View File

@ -11,8 +11,10 @@ You can parse an asserting party's metadata xref:servlet/saml2/login/overview.ad
When using the OpenSAML vendor support, the resulting `AssertingPartyDetails` will be of type `OpenSamlAssertingPartyDetails`.
This means you'll be able to do get the underlying OpenSAML XMLObject by doing the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
OpenSamlAssertingPartyDetails details = (OpenSamlAssertingPartyDetails)
@ -20,22 +22,25 @@ OpenSamlAssertingPartyDetails details = (OpenSamlAssertingPartyDetails)
EntityDescriptor openSamlEntityDescriptor = details.getEntityDescriptor();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val details: OpenSamlAssertingPartyDetails =
registration.getAssertingPartyDetails() as OpenSamlAssertingPartyDetails;
val openSamlEntityDescriptor: EntityDescriptor = details.getEntityDescriptor();
----
====
======
[[publishing-relying-party-metadata]]
== Producing `<saml2:SPSSODescriptor>` Metadata
You can publish a metadata endpoint by adding the `Saml2MetadataFilter` to the filter chain, as you'll see below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
DefaultRelyingPartyRegistrationResolver relyingPartyRegistrationResolver =
@ -50,7 +55,8 @@ http
.addFilterBefore(filter, Saml2WebSsoAuthenticationFilter.class);
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
val relyingPartyRegistrationResolver: Converter<HttpServletRequest, RelyingPartyRegistration> =
@ -66,7 +72,7 @@ http {
addFilterBefore<Saml2WebSsoAuthenticationFilter>(filter)
}
----
====
======
You can use this metadata endpoint to register your relying party with your asserting party.
This is often as simple as finding the correct form field to supply the metadata endpoint.
@ -74,42 +80,50 @@ This is often as simple as finding the correct form field to supply the metadata
By default, the metadata endpoint is `+/saml2/service-provider-metadata/{registrationId}+`.
You can change this by calling the `setRequestMatcher` method on the filter:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
filter.setRequestMatcher(new AntPathRequestMatcher("/saml2/metadata/{registrationId}", "GET"));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
filter.setRequestMatcher(AntPathRequestMatcher("/saml2/metadata/{registrationId}", "GET"))
----
====
======
Or, if you have registered a custom relying party registration resolver in the constructor, then you can specify a path without a `registrationId` hint, like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
filter.setRequestMatcher(new AntPathRequestMatcher("/saml2/metadata", "GET"));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
filter.setRequestMatcher(AntPathRequestMatcher("/saml2/metadata", "GET"))
----
====
======
== Changing the Way a `RelyingPartyRegistration` Is Looked Up
To apply a custom `RelyingPartyRegistrationResolver` to the metadata endpoint, you can provide it directly in the filter constructor like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
RelyingPartyRegistrationResolver myRegistrationResolver = ...;
@ -119,6 +133,7 @@ Saml2MetadataFilter metadata = new Saml2MetadataFilter(myRegistrationResolver, n
http.addFilterBefore(metadata, BasicAuthenticationFilter.class);
----
======
.Kotlin
----
@ -129,19 +144,20 @@ val metadata = new Saml2MetadataFilter(myRegistrationResolver, OpenSamlMetadataR
http.addFilterBefore(metadata, BasicAuthenticationFilter::class.java);
----
====
In the event that you are applying a `RelyingPartyRegistrationResolver` to remove the `registrationId` from the URI, you must also change the URI in the filter like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
metadata.setRequestMatcher("/saml2/metadata")
----
======
.Kotlin
----
metadata.setRequestMatcher("/saml2/metadata")
----
====

198
docs/modules/ROOT/pages/servlet/test/method.adoc
View File

@ -4,8 +4,10 @@
This section demonstrates how to use Spring Security's Test support to test method based security.
We first introduce a `MessageService` that requires the user to be authenticated in order to access it.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class HelloMessageService implements MessageService {
@ -19,7 +21,8 @@ public class HelloMessageService implements MessageService {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class HelloMessageService : MessageService {
@ -30,7 +33,7 @@ class HelloMessageService : MessageService {
}
}
----
====
======
The result of `getMessage` is a String saying "Hello" to the current Spring Security `Authentication`.
An example of the output is displayed below.
@ -45,8 +48,10 @@ Hello org.springframework.security.authentication.UsernamePasswordAuthentication
Before we can use Spring Security Test support, we must perform some setup. An example can be seen below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ExtendWith(SpringExtension.class) // <1>
@ -54,14 +59,15 @@ Before we can use Spring Security Test support, we must perform some setup. An e
public class WithMockUserTests {
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@ExtendWith(SpringExtension.class)
@ContextConfiguration
class WithMockUserTests {
----
====
======
This is a basic example of how to setup Spring Security Test. The highlights are:
@ -77,8 +83,10 @@ If you only need Spring Security related support, you can replace `@ContextConfi
Remember we added the `@PreAuthorize` annotation to our `HelloMessageService` and so it requires an authenticated user to invoke it.
If we ran the following test, we would expect the following test will pass:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Test(expected = AuthenticationCredentialsNotFoundException.class)
@ -87,7 +95,8 @@ public void getMessageUnauthenticated() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test(expected = AuthenticationCredentialsNotFoundException::class)
@ -95,7 +104,7 @@ fun getMessageUnauthenticated() {
messageService.getMessage()
}
----
====
======
[[test-method-withmockuser]]
== @WithMockUser
@ -104,8 +113,10 @@ The question is "How could we most easily run the test as a specific user?"
The answer is to use `@WithMockUser`.
The following test will be run as a user with the username "user", the password "password", and the roles "ROLE_USER".
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Test
@ -116,7 +127,8 @@ String message = messageService.getMessage();
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test
@ -126,7 +138,7 @@ fun getMessageWithMockUser() {
// ...
}
----
====
======
Specifically the following is true:
@ -139,8 +151,10 @@ Our example is nice because we are able to leverage a lot of defaults.
What if we wanted to run the test with a different username?
The following test would run with the username "customUser". Again, the user does not need to actually exist.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Test
@ -151,7 +165,8 @@ public void getMessageWithMockUserCustomUsername() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test
@ -161,13 +176,15 @@ fun getMessageWithMockUserCustomUsername() {
// ...
}
----
====
======
We can also easily customize the roles.
For example, this test will be invoked with the username "admin" and the roles "ROLE_USER" and "ROLE_ADMIN".
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Test
@ -178,7 +195,8 @@ public void getMessageWithMockUserCustomUser() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test
@ -188,13 +206,15 @@ fun getMessageWithMockUserCustomUser() {
// ...
}
----
====
======
If we do not want the value to automatically be prefixed with ROLE_ we can leverage the authorities attribute.
For example, this test will be invoked with the username "admin" and the authorities "USER" and "ADMIN".
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Test
@ -205,7 +225,8 @@ public void getMessageWithMockUserCustomAuthorities() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test
@ -215,14 +236,16 @@ fun getMessageWithMockUserCustomUsername() {
// ...
}
----
====
======
Of course it can be a bit tedious placing the annotation on every test method.
Instead, we can place the annotation at the class level and every test will use the specified user.
For example, the following would run every test with a user with the username "admin", the password "password", and the roles "ROLE_USER" and "ROLE_ADMIN".
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ExtendWith(SpringExtension.class)
@ -231,7 +254,8 @@ For example, the following would run every test with a user with the username "a
public class WithMockUserTests {
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@ExtendWith(SpringExtension.class)
@ -239,13 +263,15 @@ public class WithMockUserTests {
@WithMockUser(username="admin",roles=["USER","ADMIN"])
class WithMockUserTests {
----
====
======
If you are using JUnit 5's `@Nested` test support, you can also place the annotation on the enclosing class to apply to all nested classes.
For example, the following would run every test with a user with the username "admin", the password "password", and the roles "ROLE_USER" and "ROLE_ADMIN" for both test methods.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ExtendWith(SpringExtension.class)
@ -265,7 +291,8 @@ public class WithMockUserTests {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@ExtendWith(SpringExtension::class)
@ -281,7 +308,7 @@ class WithMockUserTests {
}
}
----
====
======
By default the `SecurityContext` is set during the `TestExecutionListener.beforeTestMethod` event.
This is the equivalent of happening before JUnit's `@Before`.
@ -300,8 +327,10 @@ Using `@WithAnonymousUser` allows running as an anonymous user.
This is especially convenient when you wish to run most of your tests with a specific user, but want to run a few tests as an anonymous user.
For example, the following will run withMockUser1 and withMockUser2 using <<test-method-withmockuser,@WithMockUser>> and anonymous as an anonymous user.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ExtendWith(SpringExtension.class)
@ -324,7 +353,8 @@ public class WithUserClassLevelAuthenticationTests {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@ExtendWith(SpringExtension.class)
@ -345,7 +375,7 @@ class WithUserClassLevelAuthenticationTests {
}
}
----
====
======
By default the `SecurityContext` is set during the `TestExecutionListener.beforeTestMethod` event.
This is the equivalent of happening before JUnit's `@Before`.
@ -370,8 +400,10 @@ That is exactly what `@WithUserDetails` does.
Assuming we have a `UserDetailsService` exposed as a bean, the following test will be invoked with an `Authentication` of type `UsernamePasswordAuthenticationToken` and a principal that is returned from the `UserDetailsService` with the username of "user".
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Test
@ -382,7 +414,8 @@ public void getMessageWithUserDetails() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test
@ -392,13 +425,15 @@ fun getMessageWithUserDetails() {
// ...
}
----
====
======
We can also customize the username used to lookup the user from our `UserDetailsService`.
For example, this test would be run with a principal that is returned from the `UserDetailsService` with the username of "customUsername".
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Test
@ -409,7 +444,8 @@ public void getMessageWithUserDetailsCustomUsername() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test
@ -419,13 +455,15 @@ fun getMessageWithUserDetailsCustomUsername() {
// ...
}
----
====
======
We can also provide an explicit bean name to look up the `UserDetailsService`.
For example, this test would look up the username of "customUsername" using the `UserDetailsService` with the bean name "myUserDetailsService".
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Test
@ -436,7 +474,8 @@ public void getMessageWithUserDetailsServiceBeanName() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test
@ -446,7 +485,7 @@ fun getMessageWithUserDetailsServiceBeanName() {
// ...
}
----
====
======
Like `@WithMockUser` we can also place our annotation at the class level so that every test uses the same user.
However unlike `@WithMockUser`, `@WithUserDetails` requires the user to exist.
@ -471,8 +510,10 @@ We will now see an option that allows the most flexibility.
We can create our own annotation that uses the `@WithSecurityContext` to create any `SecurityContext` we want.
For example, we might create an annotation named `@WithMockCustomUser` as shown below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Retention(RetentionPolicy.RUNTIME)
@ -485,22 +526,25 @@ public @interface WithMockCustomUser {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Retention(AnnotationRetention.RUNTIME)
@WithSecurityContext(factory = WithMockCustomUserSecurityContextFactory::class)
annotation class WithMockCustomUser(val username: String = "rob", val name: String = "Rob Winch")
----
====
======
You can see that `@WithMockCustomUser` is annotated with the `@WithSecurityContext` annotation.
This is what signals to Spring Security Test support that we intend to create a `SecurityContext` for the test.
The `@WithSecurityContext` annotation requires we specify a `SecurityContextFactory` that will create a new `SecurityContext` given our `@WithMockCustomUser` annotation.
You can find our `WithMockCustomUserSecurityContextFactory` implementation below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public class WithMockCustomUserSecurityContextFactory
@ -519,7 +563,8 @@ public class WithMockCustomUserSecurityContextFactory
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class WithMockCustomUserSecurityContextFactory : WithSecurityContextFactory<WithMockCustomUser> {
@ -533,15 +578,17 @@ class WithMockCustomUserSecurityContextFactory : WithSecurityContextFactory<With
}
}
----
====
======
We can now annotate a test class or a test method with our new annotation and Spring Security's `WithSecurityContextTestExecutionListener` will ensure that our `SecurityContext` is populated appropriately.
When creating your own `WithSecurityContextFactory` implementations, it is nice to know that they can be annotated with standard Spring annotations.
For example, the `WithUserDetailsSecurityContextFactory` uses the `@Autowired` annotation to acquire the `UserDetailsService`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
final class WithUserDetailsSecurityContextFactory
@ -566,7 +613,8 @@ final class WithUserDetailsSecurityContextFactory
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
class WithUserDetailsSecurityContextFactory @Autowired constructor(private val userDetailsService: UserDetailsService) :
@ -583,7 +631,7 @@ class WithUserDetailsSecurityContextFactory @Autowired constructor(private val u
}
}
----
====
======
By default the `SecurityContext` is set during the `TestExecutionListener.beforeTestMethod` event.
This is the equivalent of happening before JUnit's `@Before`.
@ -601,25 +649,30 @@ You can change this to happen during the `TestExecutionListener.beforeTestExecut
If you reuse the same user within your tests often, it is not ideal to have to repeatedly specify the attributes.
For example, if there are many tests related to an administrative user with the username "admin" and the roles `ROLE_USER` and `ROLE_ADMIN` you would have to write:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@WithMockUser(username="admin",roles={"USER","ADMIN"})
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@WithMockUser(username="admin",roles=["USER","ADMIN"])
----
====
======
Rather than repeating this everywhere, we can use a meta annotation.
For example, we could create a meta annotation named `WithMockAdmin`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Retention(RetentionPolicy.RUNTIME)
@ -627,14 +680,15 @@ For example, we could create a meta annotation named `WithMockAdmin`:
public @interface WithMockAdmin { }
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Retention(AnnotationRetention.RUNTIME)
@WithMockUser(value = "rob", roles = ["ADMIN"])
annotation class WithMockAdmin
----
====
======
Now we can use `@WithMockAdmin` in the same way as the more verbose `@WithMockUser`.

121
docs/modules/ROOT/pages/servlet/test/mockmvc/authentication.adoc
View File

@ -24,127 +24,147 @@ A few ways to do this are:
* Manually adding `SecurityContextPersistenceFilter` to the `MockMvc` instance may make sense when using `MockMvcBuilders.standaloneSetup`
====
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(get("/").with(user("user")))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc.get("/") {
with(user("user"))
}
----
====
======
You can easily make customizations.
For example, the following will run as a user (which does not need to exist) with the username "admin", the password "pass", and the roles "ROLE_USER" and "ROLE_ADMIN".
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(get("/admin").with(user("admin").password("pass").roles("USER","ADMIN")))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc.get("/admin") {
with(user("admin").password("pass").roles("USER","ADMIN"))
}
----
====
======
If you have a custom `UserDetails` that you would like to use, you can easily specify that as well.
For example, the following will use the specified `UserDetails` (which does not need to exist) to run with a `UsernamePasswordAuthenticationToken` that has a principal of the specified `UserDetails`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(get("/").with(user(userDetails)))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc.get("/") {
with(user(userDetails))
}
----
====
======
You can run as anonymous user using the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(get("/").with(anonymous()))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc.get("/") {
with(anonymous())
}
----
====
======
This is especially useful if you are running with a default user and wish to process a few requests as an anonymous user.
If you want a custom `Authentication` (which does not need to exist) you can do so using the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(get("/").with(authentication(authentication)))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc.get("/") {
with(authentication(authentication))
}
----
====
======
You can even customize the `SecurityContext` using the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(get("/").with(securityContext(securityContext)))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc.get("/") {
with(securityContext(securityContext))
}
----
====
======
We can also ensure to run as a specific user for every request by using ``MockMvcBuilders``'s default request.
For example, the following will run as a user (which does not need to exist) with the username "admin", the password "password", and the role "ROLE_ADMIN":
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc = MockMvcBuilders
@ -154,7 +174,8 @@ mvc = MockMvcBuilders
.build();
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc = MockMvcBuilders
@ -163,13 +184,15 @@ mvc = MockMvcBuilders
.apply<DefaultMockMvcBuilder>(springSecurity())
.build()
----
====
======
If you find you are using the same user in many of your tests, it is recommended to move the user to a method.
For example, you can specify the following in your own class named `CustomSecurityMockMvcRequestPostProcessors`:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
public static RequestPostProcessor rob() {
@ -177,19 +200,22 @@ public static RequestPostProcessor rob() {
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
fun rob(): RequestPostProcessor {
return user("rob").roles("ADMIN")
}
----
====
======
Now you can perform a static import on `CustomSecurityMockMvcRequestPostProcessors` and use that within your tests:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import static sample.CustomSecurityMockMvcRequestPostProcessors.*;
@ -200,7 +226,8 @@ mvc
.perform(get("/").with(rob()))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import sample.CustomSecurityMockMvcRequestPostProcessors.*
@ -211,7 +238,7 @@ mvc.get("/") {
with(rob())
}
----
====
======
[[test-mockmvc-withmockuser]]
== Running as a User in Spring MVC Test with Annotations
@ -219,8 +246,10 @@ mvc.get("/") {
As an alternative to using a `RequestPostProcessor` to create your user, you can use annotations described in xref:servlet/test/method.adoc[Testing Method Security].
For example, the following will run the test with the user with username "user", password "password", and role "ROLE_USER":
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Test
@ -232,7 +261,8 @@ mvc
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test
@ -243,12 +273,14 @@ fun requestProtectedUrlWithUser() {
// ...
}
----
====
======
Alternatively, the following will run the test with the user with username "user", password "password", and role "ROLE_ADMIN":
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@Test
@ -260,7 +292,8 @@ mvc
}
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@Test
@ -271,4 +304,4 @@ fun requestProtectedUrlWithUser() {
// ...
}
----
====
======

33
docs/modules/ROOT/pages/servlet/test/mockmvc/csrf.adoc
View File

@ -4,57 +4,66 @@
When testing any non-safe HTTP methods and using Spring Security's CSRF protection, you must be sure to include a valid CSRF Token in the request.
To specify a valid CSRF token as a request parameter use the CSRF xref:servlet/test/mockmvc/request-post-processors.adoc[`RequestPostProcessor`] like so:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(post("/").with(csrf()))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc.post("/") {
with(csrf())
}
----
====
======
If you like you can include CSRF token in the header instead:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(post("/").with(csrf().asHeader()))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc.post("/") {
with(csrf().asHeader())
}
----
====
======
You can also test providing an invalid CSRF token using the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(post("/").with(csrf().useInvalidToken()))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc.post("/") {
with(csrf().useInvalidToken())
}
----
====
======

33
docs/modules/ROOT/pages/servlet/test/mockmvc/form-login.adoc
View File

@ -3,56 +3,65 @@
You can easily create a request to test a form based authentication using Spring Security's testing support.
For example, the following `formLogin` xref:servlet/test/mockmvc/request-post-processors.adoc[`RequestPostProcessor`] will submit a POST to "/login" with the username "user", the password "password", and a valid CSRF token:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(formLogin())
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
.perform(formLogin())
----
====
======
It is easy to customize the request.
For example, the following will submit a POST to "/auth" with the username "admin", the password "pass", and a valid CSRF token:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(formLogin("/auth").user("admin").password("pass"))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
.perform(formLogin("/auth").user("admin").password("pass"))
----
====
======
We can also customize the parameters names that the username and password are included on.
For example, this is the above request modified to include the username on the HTTP parameter "u" and the password on the HTTP parameter "p".
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(formLogin("/auth").user("u","admin").password("p","pass"))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
.perform(formLogin("/auth").user("u","admin").password("p","pass"))
----
====
======

11
docs/modules/ROOT/pages/servlet/test/mockmvc/http-basic.adoc
View File

@ -4,22 +4,25 @@ While it has always been possible to authenticate with HTTP Basic, it was a bit
Now this can be done using Spring Security's `httpBasic` xref:servlet/test/mockmvc/request-post-processors.adoc[`RequestPostProcessor`].
For example, the snippet below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(get("/").with(httpBasic("user","password")))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc.get("/") {
with(httpBasic("user","password"))
}
----
====
======
will attempt to use HTTP Basic to authenticate a user with the username "user" and the password "password" by ensuring the following header is populated on the HTTP Request:

22
docs/modules/ROOT/pages/servlet/test/mockmvc/logout.adoc
View File

@ -4,37 +4,43 @@
While fairly trivial using standard Spring MVC Test, you can use Spring Security's testing support to make testing log out easier.
For example, the following `logout` xref:servlet/test/mockmvc/request-post-processors.adoc[`RequestPostProcessor`] will submit a POST to "/logout" with a valid CSRF token:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(logout())
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
.perform(logout())
----
====
======
You can also customize the URL to post to.
For example, the snippet below will submit a POST to "/signout" with a valid CSRF token:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
.perform(logout("/signout"))
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
.perform(logout("/signout"))
----
====
======

462
docs/modules/ROOT/pages/servlet/test/mockmvc/oauth2.adoc
View File

File diff suppressed because it is too large Load Diff

11
docs/modules/ROOT/pages/servlet/test/mockmvc/request-builders.adoc
View File

@ -4,16 +4,19 @@ Spring MVC Test also provides a `RequestBuilder` interface that can be used to c
Spring Security provides a few `RequestBuilder` implementations that can be used to make testing easier.
In order to use Spring Security's `RequestBuilder` implementations ensure the following static import is used:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestBuilders.*;
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestBuilders.*
----
====
======

11
docs/modules/ROOT/pages/servlet/test/mockmvc/request-post-processors.adoc
View File

@ -5,16 +5,19 @@ Spring MVC Test provides a convenient interface called a `RequestPostProcessor`
Spring Security provides a number of `RequestPostProcessor` implementations that make testing easier.
In order to use Spring Security's `RequestPostProcessor` implementations ensure the following static import is used:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.*;
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.*
----
====
======

77
docs/modules/ROOT/pages/servlet/test/mockmvc/result-matchers.adoc
View File

@ -4,20 +4,23 @@ At times it is desirable to make various security related assertions about a req
To accommodate this need, Spring Security Test support implements Spring MVC Test's `ResultMatcher` interface.
In order to use Spring Security's `ResultMatcher` implementations ensure the following static import is used:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
import static org.springframework.security.test.web.servlet.response.SecurityMockMvcResultMatchers.*;
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
import org.springframework.security.test.web.servlet.response.SecurityMockMvcResultMatchers.*
----
====
======
=== Unauthenticated Assertion
@ -25,8 +28,10 @@ At times it may be valuable to assert that there is no authenticated user associ
For example, you might want to test submitting an invalid username and password and verify that no user is authenticated.
You can easily do this with Spring Security's testing support using something like the following:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
@ -34,14 +39,15 @@ mvc
.andExpect(unauthenticated());
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
.perform(formLogin().password("invalid"))
.andExpect { unauthenticated() }
----
====
======
=== Authenticated Assertion
@ -49,8 +55,10 @@ It is often times that we must assert that an authenticated user exists.
For example, we may want to verify that we authenticated successfully.
We could verify that a form based login was successful with the following snippet of code:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
@ -58,19 +66,22 @@ mvc
.andExpect(authenticated());
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
.perform(formLogin())
.andExpect { authenticated() }
----
====
======
If we wanted to assert the roles of the user, we could refine our previous code as shown below:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
@ -78,19 +89,22 @@ mvc
.andExpect(authenticated().withRoles("USER","ADMIN"));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
.perform(formLogin())
.andExpect { authenticated().withRoles("USER","ADMIN") }
----
====
======
Alternatively, we could verify the username:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
@ -98,19 +112,22 @@ mvc
.andExpect(authenticated().withUsername("admin"));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
.perform(formLogin().user("admin"))
.andExpect { authenticated().withUsername("admin") }
----
====
======
We can also combine the assertions:
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
@ -118,19 +135,22 @@ mvc
.andExpect(authenticated().withUsername("admin").withRoles("USER", "ADMIN"));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
.perform(formLogin().user("admin"))
.andExpect { authenticated().withUsername("admin").withRoles("USER", "ADMIN") }
----
====
======
We can also make arbitrary assertions on the authentication
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
mvc
@ -139,7 +159,8 @@ mvc
assertThat(auth).isInstanceOf(UsernamePasswordAuthenticationToken.class)));
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
mvc
@ -150,4 +171,4 @@ mvc
}
}
----
====
======

11
docs/modules/ROOT/pages/servlet/test/mockmvc/setup.adoc
View File

@ -8,8 +8,10 @@ For example:
NOTE: Spring Security's testing support requires spring-test-4.1.3.RELEASE or greater.
====
.Java
[tabs]
======
Java::
+
[source,java,role="primary"]
----
@ -36,7 +38,8 @@ public class CsrfShowcaseTests {
...
----
.Kotlin
Kotlin::
+
[source,kotlin,role="secondary"]
----
@ExtendWith(SpringExtension.class)
@ -58,6 +61,6 @@ class CsrfShowcaseTests {
}
// ...
----
====
======
<1> `SecurityMockMvcConfigurers.springSecurity()` will perform all of the initial setup we need to integrate Spring Security with Spring MVC Test