mirror of
				https://github.com/spring-projects/spring-security.git
				synced 2025-11-04 00:28:54 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			137 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
			
		
		
	
	
			137 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
= Authorization Migrations
 | 
						|
 | 
						|
The following steps relate to how to finish migrating authorization support.
 | 
						|
 | 
						|
== Use `AuthorizationManager` for Method Security
 | 
						|
 | 
						|
There are no further migration steps for this feature.
 | 
						|
 | 
						|
== Use `AuthorizationManager` for Message Security
 | 
						|
 | 
						|
In 6.0, `<websocket-message-broker>` defaults `use-authorization-manager` to `true`.
 | 
						|
So, to complete migration, remove any `websocket-message-broker@use-authorization-manager=true` attribute.
 | 
						|
 | 
						|
For example:
 | 
						|
 | 
						|
[tabs]
 | 
						|
======
 | 
						|
Xml::
 | 
						|
+
 | 
						|
[source,xml,role="primary"]
 | 
						|
----
 | 
						|
<websocket-message-broker use-authorization-manager="true"/>
 | 
						|
----
 | 
						|
======
 | 
						|
 | 
						|
changes to:
 | 
						|
 | 
						|
[tabs]
 | 
						|
======
 | 
						|
Xml::
 | 
						|
+
 | 
						|
[source,xml,role="primary"]
 | 
						|
----
 | 
						|
<websocket-message-broker/>
 | 
						|
----
 | 
						|
======
 | 
						|
 | 
						|
There are no further migrations steps for Java or Kotlin for this feature.
 | 
						|
 | 
						|
== Use `AuthorizationManager` for Request Security
 | 
						|
 | 
						|
In 6.0, `<http>` defaults `once-per-request` to `false`, `filter-all-dispatcher-types` to `true`, and `use-authorization-manager` to `true`.
 | 
						|
Also, xref:servlet/authorization/authorize-http-requests.adoc[`authorizeHttpRequests#filterAllDispatcherTypes`] defaults to `true`.
 | 
						|
So, to complete migration, any defaults values can be removed.
 | 
						|
 | 
						|
For example, if you opted in to the 6.0 default for `filter-all-dispatcher-types` or `authorizeHttpRequests#filterAllDispatcherTypes` like so:
 | 
						|
 | 
						|
[tabs]
 | 
						|
======
 | 
						|
Java::
 | 
						|
+
 | 
						|
[source,java,role="primary"]
 | 
						|
----
 | 
						|
http
 | 
						|
    .authorizeHttpRequests((authorize) -> authorize
 | 
						|
        .filterAllDispatcherTypes(true)
 | 
						|
        // ...
 | 
						|
    )
 | 
						|
----
 | 
						|
 | 
						|
Kotlin::
 | 
						|
+
 | 
						|
[source,java,role="secondary"]
 | 
						|
----
 | 
						|
http {
 | 
						|
	authorizeHttpRequests {
 | 
						|
		filterAllDispatcherTypes = true
 | 
						|
        // ...
 | 
						|
	}
 | 
						|
}
 | 
						|
----
 | 
						|
 | 
						|
Xml::
 | 
						|
+
 | 
						|
[source,xml,role="secondary"]
 | 
						|
----
 | 
						|
<http use-authorization-manager="true" filter-all-dispatcher-types="true"/>
 | 
						|
----
 | 
						|
======
 | 
						|
 | 
						|
then the defaults may be removed:
 | 
						|
 | 
						|
[tabs]
 | 
						|
======
 | 
						|
Java::
 | 
						|
+
 | 
						|
[source,java,role="primary"]
 | 
						|
----
 | 
						|
http
 | 
						|
    .authorizeHttpRequests((authorize) -> authorize
 | 
						|
        // ...
 | 
						|
    )
 | 
						|
----
 | 
						|
 | 
						|
Kotlin::
 | 
						|
+
 | 
						|
[source,java,role="secondary"]
 | 
						|
----
 | 
						|
http {
 | 
						|
	authorizeHttpRequests {
 | 
						|
		// ...
 | 
						|
	}
 | 
						|
}
 | 
						|
----
 | 
						|
 | 
						|
Xml::
 | 
						|
+
 | 
						|
[source,xml,role="secondary"]
 | 
						|
----
 | 
						|
<http/>
 | 
						|
----
 | 
						|
======
 | 
						|
 | 
						|
[NOTE]
 | 
						|
====
 | 
						|
`once-per-request` applies only when `use-authorization-manager="false"` and `filter-all-dispatcher-types` only applies when `use-authorization-manager="true"`
 | 
						|
====
 | 
						|
 | 
						|
[[compile-with-parameters]]
 | 
						|
=== Compile With `-parameters`
 | 
						|
 | 
						|
Spring Framework 6.1 https://github.com/spring-projects/spring-framework/issues/29559[removes LocalVariableTableParameterNameDiscoverer].
 | 
						|
This affects how `@PreAuthorize` and other xref:servlet/authorization/method-security.adoc[method security] annotations will process parameter names.
 | 
						|
If you are using method security annotations with parameter names, for example:
 | 
						|
 | 
						|
[source,java]
 | 
						|
.Method security annotation using `id` parameter name
 | 
						|
----
 | 
						|
@PreAuthorize("@authz.checkPermission(#id, authentication)")
 | 
						|
public void doSomething(Long id) {
 | 
						|
    // ...
 | 
						|
}
 | 
						|
----
 | 
						|
 | 
						|
You must compile with `-parameters` to ensure that the parameter names are available at runtime.
 | 
						|
For more information about this, please visit the https://github.com/spring-projects/spring-framework/wiki/Upgrading-to-Spring-Framework-6.x#core-container[Upgrading to Spring Framework 6.1 page].
 |