205 lines
5.0 KiB
Plaintext
Raw Normal View History

2022-10-24 17:38:58 -06:00
[[migration]]
= Migrating to 6.0
The Spring Security team has prepared the 5.8 release to simplify upgrading to Spring Security 6.0.
2022-10-25 15:04:43 -06:00
Use 5.8 and its preparation steps to simplify updating to 6.0
2022-10-24 17:38:58 -06:00
2022-10-25 15:04:43 -06:00
After updating to 5.8, follow this guide to perform any needed migration steps.
2022-10-24 17:38:58 -06:00
2022-10-26 12:52:37 -06:00
Also, this guide includes ways to <<revert,revert to 5.x>> behaviors and its defaults, should you run into trouble.
2022-10-24 17:38:58 -06:00
2022-10-26 12:52:37 -06:00
== Servlet
2022-10-24 17:38:58 -06:00
2022-10-26 12:52:37 -06:00
=== Use `AuthorizationManager` for Method Security
2022-10-24 17:38:58 -06:00
2022-10-26 12:52:37 -06:00
There are no further migration steps for this feature.
However, if you run into trouble with this enhancement, you can instead <<servlet-replace-methodsecurity-with-globalmethodsecurity,revert the behavior>>.
== Reactive
=== Use `AuthorizationManager` for Method Security
If you run into trouble with this enhancement, you can instead <<reactive-change-to-useauthorizationmanager-false,revert the behavior>>.
[[reactive-method-security-remove-useauthorizationmanager]]
[%interactive]
* [ ] Remove `useAuthorizationManager` usage from `@EnableReactiveMethodSecurity`
2022-10-25 15:04:43 -06:00
{security-api-url}org/springframework/security/config/annotation/method/configuration/EnableReactiveMethodSecurity.html[`@EnableReactiveMethodSecurity`] sets `useAuthorizationManager` to `true` by default.
Because of that, in 6.0 you can change:
2022-10-24 17:38:58 -06:00
====
.Java
[source,java,role="primary"]
----
2022-10-25 15:04:43 -06:00
@EnableReactiveMethodSecurity(useAuthorizationManager = true)
2022-10-24 17:38:58 -06:00
----
.Kotlin
[source,kotlin,role="secondary"]
----
2022-10-25 15:04:43 -06:00
@EnableReactiveMethodSecurity(useAuthorizationManager = true)
2022-10-24 17:38:58 -06:00
----
====
2022-10-25 15:04:43 -06:00
to:
2022-10-24 17:38:58 -06:00
====
.Java
[source,java,role="primary"]
----
2022-10-25 15:04:43 -06:00
@EnableReactiveMethodSecurity
2022-10-24 17:38:58 -06:00
----
.Kotlin
[source,kotlin,role="secondary"]
----
2022-10-25 15:04:43 -06:00
@EnableReactiveMethodSecurity
2022-10-24 17:38:58 -06:00
----
====
2022-10-26 12:52:37 -06:00
'''
2022-10-25 15:04:43 -06:00
2022-10-26 12:52:37 -06:00
[[revert]]
2022-10-25 15:04:43 -06:00
If you are running into trouble with any of the 6.0 changes, please first try to apply the following changes to get you up and running.
It's more important to stay on 6.0 and get the security improvements.
2022-10-26 12:52:37 -06:00
== Revert Servlet
=== Don't Use `AuthorizationManager` in Method Security
2022-10-25 15:04:43 -06:00
2022-10-26 12:52:37 -06:00
[[servlet-replace-methodsecurity-with-globalmethodsecurity]]
[%interactive]
* [ ] Replace xref:servlet/authorization/method-security.adoc#jc-enable-method-security[method security] with xref:servlet/authorization/method-security.adoc#jc-enable-global-method-security[global method security]
2022-10-25 15:04:43 -06:00
2022-10-26 12:52:37 -06:00
For applications using xref:servlet/authorization/method-security.adoc#jc-enable-method-security[pre-post annotations], make sure to turn it on to reactivate the behavior.
2022-10-24 17:38:58 -06:00
2022-10-25 15:04:43 -06:00
For example, change:
2022-10-24 17:38:58 -06:00
====
.Java
[source,java,role="primary"]
----
2022-10-25 15:04:43 -06:00
@EnableMethodSecurity
2022-10-24 17:38:58 -06:00
----
.Kotlin
[source,kotlin,role="secondary"]
----
2022-10-25 15:04:43 -06:00
@EnableMethodSecurity
2022-10-24 17:38:58 -06:00
----
2022-10-26 12:52:37 -06:00
.Xml
[source,xml,role="secondary"]
----
<method-security/>
----
2022-10-24 17:38:58 -06:00
====
2022-10-25 15:04:43 -06:00
to:
2022-10-24 17:38:58 -06:00
====
.Java
[source,java,role="primary"]
----
2022-10-25 15:04:43 -06:00
@EnableGlobalMethodSecurity(prePostEnabled = true)
2022-10-24 17:38:58 -06:00
----
.Kotlin
[source,kotlin,role="secondary"]
----
2022-10-25 15:04:43 -06:00
@EnableGlobalMethodSecurity(prePostEnabled = true)
2022-10-24 17:38:58 -06:00
----
2022-10-26 12:52:37 -06:00
.Xml
[source,xml,role="secondary"]
----
<global-method-security pre-post-enabled="true"/>
----
2022-10-24 17:38:58 -06:00
====
2022-10-26 12:52:37 -06:00
Other usages can simply change {security-api-url}org/springframework/security/config/annotation/method/configuration/EnableMethodSecurity.html[`@EnableMethodSecurity`] and xref:servlet/appendix/namespace/method-security.adoc#nsa-method-security[`<method-security>`] to {security-api-url}org/springframework/security/config/annotation/method/configuration/EnableGlobalMethodSecurity.html[`@EnableGlobalMethodSecurity`] and xref:servlet/appendix/namespace/method-security.adoc#nsa-global-method-security[`<global-method-security>`], like so:
2022-10-24 17:38:58 -06:00
====
.Java
[source,java,role="primary"]
----
2022-10-25 15:04:43 -06:00
@EnableMethodSecurity(securedEnabled = true, prePostEnabled = false)
2022-10-24 17:38:58 -06:00
----
.Kotlin
[source,kotlin,role="secondary"]
----
2022-10-25 15:04:43 -06:00
@EnableMethodSecurity(securedEnabled = true, prePostEnabled = false)
2022-10-24 17:38:58 -06:00
----
2022-10-26 12:52:37 -06:00
.Xml
[source,xml,role="secondary"]
----
<method-security secured-enabled="true" pre-post-enabled="false"/>
----
2022-10-24 17:38:58 -06:00
====
2022-10-25 15:04:43 -06:00
should change to:
2022-10-24 17:38:58 -06:00
====
.Java
[source,java,role="primary"]
----
2022-10-25 15:04:43 -06:00
@EnableGlobalMethodSecurity(securedEnabled = true, prePostEnabled = false)
2022-10-24 17:38:58 -06:00
----
.Kotlin
[source,kotlin,role="secondary"]
----
2022-10-25 15:04:43 -06:00
@EnableGlobalMethodSecurity(securedEnabled = true, prePostEnabled = false)
2022-10-24 17:38:58 -06:00
----
2022-10-26 12:52:37 -06:00
.Xml
[source,xml,role="secondary"]
----
<global-method-security secured-enabled="true" pre-post-enabled="false"/>
----
2022-10-24 17:38:58 -06:00
====
2022-10-26 12:52:37 -06:00
== Revert Reactive
=== Don't Use `AuthorizationManager` in Method Security
2022-10-24 17:38:58 -06:00
2022-10-26 12:52:37 -06:00
[[reactive-change-to-useauthorizationmanager-false]]
[%interactive]
* [ ] Change `useAuthorizationManager` to `false`
2022-10-24 17:38:58 -06:00
2022-10-25 15:04:43 -06:00
To opt-out of {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[`AuthorizationManager`] for reactive method security, add `useAuthorizationManager = false`:
2022-10-24 17:38:58 -06:00
====
.Java
[source,java,role="primary"]
----
@EnableReactiveMethodSecurity
----
.Kotlin
[source,kotlin,role="secondary"]
----
@EnableReactiveMethodSecurity
----
====
changes to:
====
.Java
[source,java,role="primary"]
----
2022-10-25 15:04:43 -06:00
@EnableReactiveMethodSecurity(useAuthorizationManager = false)
2022-10-24 17:38:58 -06:00
----
.Kotlin
[source,kotlin,role="secondary"]
----
2022-10-25 15:04:43 -06:00
@EnableReactiveMethodSecurity(useAuthorizationManager = false)
2022-10-24 17:38:58 -06:00
----
====