Merge branch 'spring-cloud:main' into #2975-Suggestion-Add-Permissions-Policy-as-configurable-option-to-SecureHeaders-GatewayFilter

Author: joerg-richter-5234

docs/modules/ROOT/pages/spring-cloud-gateway-server-webflux/gatewayfilter-factories/retry-factory.adoc

@@ -12,6 +12,9 @@ The `Retry` `GatewayFilter` factory supports the following parameters:
 Retries are performed after a backoff interval of `firstBackoff * (factor ^ n)`, where `n` is the iteration.
 If `maxBackoff` is configured, the maximum backoff applied is limited to `maxBackoff`.
 If `basedOnPreviousValue` is true, the backoff is calculated by using `prevBackoff * factor`.
+* `jitter`: The configured random jitter for the retries.
+Generating a backoff between `[backoff - backoff*randomFactor, backoff + backoff*randomFactor]`
+* `timeout`:  The configured timeout for the retries.
 
 The following defaults are configured for `Retry` filter, if enabled:
 
@@ -20,6 +23,8 @@ The following defaults are configured for `Retry` filter, if enabled:
 * `methods`: GET method
 * `exceptions`: `IOException` and `TimeoutException`
 * `backoff`: disabled
+* `jitter`: disabled
+* `timeout`: unlimited
 
 The following listing configures a Retry `GatewayFilter`:
 
@@ -45,6 +50,9 @@ spring:
               maxBackoff: 50ms
               factor: 2
               basedOnPreviousValue: false
+            jitter:
+              randomFactor: 0.5
+            timeout: 100ms
 ----
 
 NOTE: When using the retry filter with a `forward:` prefixed URL, the target endpoint should be written carefully so that, in case of an error, it does not do anything that could result in a response being sent to the client and committed.
@@ -79,10 +87,13 @@ spring:
               maxBackoff: 50ms
               factor: 2
               basedOnPreviousValue: false
+            jitter:
+              randomFactor: 0.5
+            timeout: 100ms
 
       - id: retryshortcut_route
         uri: https://example.org
         filters:
-        - Retry=3,INTERNAL_SERVER_ERROR,GET,10ms,50ms,2,false
+        - Retry=3,INTERNAL_SERVER_ERROR,GET,10ms,50ms,2,false,0.5,100ms
 ----
 

docs/modules/ROOT/pages/spring-cloud-gateway-server-webflux/httpheadersfilters.adoc

@@ -7,6 +7,10 @@
 == Forwarded Headers Filter
 The `Forwarded` Headers Filter creates a `Forwarded` header to send to the downstream service. It adds the `Host` header, scheme and port of the current request to any existing `Forwarded` header.
 
+The `Forwarded by` header part can be enabled by setting the following property to true (defaults to false):
+
+- `spring.cloud.gateway.forwarded.by.enabled=true`
+
 [[removehopbyhop-headers-filter]]
 == RemoveHopByHop Headers Filter
 The `RemoveHopByHop` Headers Filter removes headers from forwarded requests. The default list of headers that is removed comes from the https://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-14#section-7.1.3[IETF].

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/addrequestheader.adoc

@@ -14,13 +14,16 @@ spring:
         routes:
         - id: add_request_header_route
           uri: https://example.org
+          predicates:
+          - Path=/red
           filters:
           - AddRequestHeader=X-Request-red, blue
 ----
 
 .GatewaySampleApplication.java
 [source,java]
 ----
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
 import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestHeader;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
 import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
@@ -30,10 +33,10 @@ class RouteConfiguration {
 
     @Bean
     public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeader() {
-        return route("addRequestHeader")
-                .route(GET("/red"), http("https://example.org"))
-                .before(addRequestHeader("X-Request-red", "blue"))
-                .build();
+        return route("add_request_header_route")
+            .GET("/red", http())
+            .before(uri("https://example.org"))
+            .before(addRequestHeader("X-Request-red", "blue"));
     }
 }
 ----
@@ -47,15 +50,20 @@ The following example configures an `AddRequestHeader` filter that uses a variab
 .GatewaySampleApplication.java
 [source,java]
 ----
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestHeader;
+import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
+import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
+
 @Configuration
 class RouteConfiguration {
 
     @Bean
     public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeader() {
-        return route("addRequestHeader")
-                .route(GET("/red/{segment}"), http("https://example.org"))
-                .before(addRequestHeader("X-Request-red", "blue-{segment}"))
-                .build();
+        return route("add_request_header_route")
+            .GET("/red/{segment}", http())
+            .before(uri("https://example.org"))
+            .before(addRequestHeader("X-Request-red", "blue-{segment}"));
     }
 }
 ----

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/addrequestheadersifnotpresent.adoc

@@ -12,15 +12,18 @@ spring:
     gateway:
       mvc:
         routes:
-        - id: add_request_headers_route
+        - id: add_request_headers_route_inp
           uri: https://example.org
+          predicates:
+          - Path=/red
           filters:
           - AddRequestHeadersIfNotPresent=X-Request-Color-1:blue,X-Request-Color-2:green
 ----
 
 .GatewaySampleApplication.java
 [source,java]
 ----
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
 import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestHeadersIfNotPresent;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
 import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
@@ -29,9 +32,11 @@ import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFuncti
 class RouteConfiguration {
 
     @Bean
-    public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeader() {
-        return route(GET("/red"), http("https://example.org"))
-                .before(addRequestHeadersIfNotPresent("X-Request-Color-1:blue","X-Request-Color-2:green"));
+    public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeaderInp() {
+        return route("add_request_headers_route_inp")
+            .GET("/red", http())
+            .before(uri("https://example.org"))
+            .before(addRequestHeadersIfNotPresent("X-Request-Color-1:blue","X-Request-Color-2:green"));
     }
 }
 ----
@@ -49,13 +54,20 @@ The following example configures an `AddRequestHeadersIfNotPresent` filter that
 .GatewaySampleApplication.java
 [source,java]
 ----
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestHeadersIfNotPresent;
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
+import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
+import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
+
 @Configuration
 class RouteConfiguration {
 
     @Bean
-    public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeader() {
-        return route(GET("/red/{segment}"), http("https://example.org"))
-                .before(addRequestHeadersIfNotPresent("X-Request-red", "blue-{segment}"));
+    public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeaderInp() {
+        return route("add_request_header_route_inp")
+            .GET("/red/{segment}", http())
+            .before(uri("https://example.org"))
+            .before(addRequestHeadersIfNotPresent("X-Request-red", "blue-{segment}"));
     }
 }
 ----
@@ -66,7 +78,7 @@ spring:
   cloud:
     gateway:
       routes:
-      - id: add_request_header_route
+      - id: add_request_header_route_inp
         uri: https://example.org
         predicates:
         - Path=/red/{segment}

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/addrequestparameter.adoc

@@ -14,13 +14,16 @@ spring:
         routes:
         - id: add_request_parameter_route
           uri: https://example.org
+          predicates:
+          - Path=/anything/addrequestparam
           filters:
           - AddRequestParameter=red, blue
 ----
 
 .GatewaySampleApplication.java
 [source,java]
 ----
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
 import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestParameter;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
 import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
@@ -29,11 +32,12 @@ import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFuncti
 class RouteConfiguration {
 
     @Bean
-    public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeader() {
-		return route("add_request_parameter_route")
-				.GET("/anything/addrequestparam", http("https://example.org"))
-					.before(addRequestParameter("red", "blue"))
-					.build();
+    public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqParameter() {
+        return route("add_request_parameter_route")
+            .GET("/anything/addrequestparam", http())
+            .before(uri("https://example.org"))
+            .before(addRequestParameter("red", "blue"))
+            .build();
     }
 }
 ----
@@ -47,6 +51,7 @@ The following example configures an `AddRequestParameter` filter that uses a var
 .GatewaySampleApplication.java
 [source,java]
 ----
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
 import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.addRequestParameter;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
 import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
@@ -56,11 +61,12 @@ import static org.springframework.cloud.gateway.server.mvc.predicate.GatewayRequ
 class RouteConfiguration {
 
     @Bean
-    public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqHeader() {
-		return route("add_request_parameter_route")
-				.route(host("{segment}.myhost.org"), http("https://example.org"))
-				.before(addRequestParameter("foo", "bar-{segment}"))
-				.build();
+    public RouterFunction<ServerResponse> gatewayRouterFunctionsAddReqParameter() {
+        return route("add_request_parameter_route")
+            .route(host("{segment}.myhost.org"), http())
+            .before(uri("https://example.org"))
+            .before(addRequestParameter("foo", "bar-{segment}"))
+            .build();
     }
 }
 ----

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/addresponseheader.adoc

@@ -14,13 +14,16 @@ spring:
         routes:
         - id: add_response_header_route
           uri: https://example.org
+          predicates:
+          - Path=/anything/addresheader
           filters:
           - AddResponseHeader=X-Response-Red, Blue
 ----
 
 .GatewaySampleApplication.java
 [source,java]
 ----
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
 import static org.springframework.cloud.gateway.server.mvc.filter.AfterFilterFunctions.addResponseHeader;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
 import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
@@ -30,9 +33,10 @@ class RouteConfiguration {
 
     @Bean
     public RouterFunction<ServerResponse> gatewayRouterFunctionsAddRespHeader() {
-        return route("addresponseheader")
-                .GET("/anything/addresheader", http("https://example.org"))
-                .after(addResponseHeader("X-Response-Red", "Blue"))
+        return route("add_response_header_route")
+            .GET("/anything/addresheader", http())
+            .before(uri("https://example.org"))
+            .after(addResponseHeader("X-Response-Red", "Blue"))
             .build();
     }
 }
@@ -47,6 +51,7 @@ The following example configures an `AddResponseHeader` filter that uses a varia
 .GatewaySampleApplication.java
 [source,java]
 ----
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
 import static org.springframework.cloud.gateway.server.mvc.filter.AfterFilterFunctions.addResponseHeader;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
 import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
@@ -57,10 +62,11 @@ class RouteConfiguration {
 
     @Bean
     public RouterFunction<ServerResponse> gatewayRouterFunctionsAddRespHeader() {
-		return route("add_response_header_route")
-				.route(host("{segment}.myhost.org"), http("https://example.org"))
-				.after(addResponseHeader("foo", "bar-{segment}"))
-				.build();
+        return route("add_response_header_route")
+            .route(host("{segment}.myhost.org"), http())
+            .before(uri("https://example.org"))
+            .after(addResponseHeader("foo", "bar-{segment}"))
+            .build();
     }
 }
 ----

docs/modules/ROOT/pages/spring-cloud-gateway-server-webmvc/filters/circuitbreaker-filter.adoc

@@ -15,14 +15,17 @@ spring:
     gateway:
       mvc:
         routes:
-        - id: circuitbreaker_route
+        - id: circuitbreakernofallback
           uri: https://example.org
+          predicates:
+          - Path=/anything/circuitbreakernofallback
           filters:
           - CircuitBreaker=myCircuitBreaker
 ----
 .GatewaySampleApplication.java
 [source,java]
 ----
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
 import static org.springframework.cloud.gateway.server.mvc.filter.CircuitBreakerFilterFunctions.circuitBreaker;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
 import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
@@ -33,9 +36,10 @@ class RouteConfiguration {
     @Bean
     public RouterFunction<ServerResponse> gatewayRouterFunctionsCircuitBreakerNoFallback() {
         return route("circuitbreakernofallback")
-                .route(path("/anything/circuitbreakernofallback"), http("https://example.org"))
-                .filter(circuitBreaker("mycb3"))
-                .build();
+            .route(path("/anything/circuitbreakernofallback"), http())
+            .before(uri("https://example.org"))
+            .filter(circuitBreaker("myCircuitBreaker"))
+            .build();
     }
 }
 ----
@@ -74,6 +78,7 @@ The following listing does the same thing in Java:
 [source,java]
 ----
 import java.net.URI;
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
 import static org.springframework.cloud.gateway.server.mvc.filter.CircuitBreakerFilterFunctions.circuitBreaker;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
 import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
@@ -84,9 +89,10 @@ class RouteConfiguration {
     @Bean
     public RouterFunction<ServerResponse> gatewayRouterFunctionsCircuitBreakerFallback() {
         return route("circuitbreaker_route")
-                .route(path("/consumingServiceEndpoint"), http("https://example.org"))
-                .filter(circuitBreaker("myCircuitBreaker", URI.create("forward:/inCaseOfFailureUseThis")))
-                .build();
+            .route(path("/consumingServiceEndpoint"), http())
+            .before(uri("https://example.org"))
+            .filter(circuitBreaker("myCircuitBreaker", URI.create("forward:/inCaseOfFailureUseThis")))
+            .build();
     }
 }
 ----
@@ -102,6 +108,7 @@ In the example below the call `consumingServiceEndpoint/users/1` will be redirec
 [source,java]
 ----
 import java.net.URI;
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
 import static org.springframework.cloud.gateway.server.mvc.filter.CircuitBreakerFilterFunctions.circuitBreaker;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
 import static org.springframework.cloud.gateway.server.mvc.handler.HandlerFunctions.http;
@@ -112,9 +119,10 @@ class RouteConfiguration {
     @Bean
     public RouterFunction<ServerResponse> gatewayRouterFunctionsCircuitBreakerFallback() {
         return route("circuitbreaker_route")
-                .route(path("/consumingServiceEndpoint/{*segments}"), http("https://example.org"))
-                .filter(circuitBreaker("myCircuitBreaker", URI.create("forward:/inCaseOfFailureUseThis/{segments}")))
-                .build();
+            .route(path("/consumingServiceEndpoint/{*segments}"), http())
+            .before(uri("https://example.org"))
+            .filter(circuitBreaker("myCircuitBreaker", URI.create("forward:/inCaseOfFailureUseThis/{segments}")))
+            .build();
     }
 }
 ----
@@ -126,6 +134,7 @@ However, you can also reroute the request to a controller or handler in an exter
 .GatewaySampleApplication.java
 [source,java]
 ----
+import static org.springframework.cloud.gateway.server.mvc.filter.BeforeFilterFunctions.uri;
 import static org.springframework.cloud.gateway.server.mvc.filter.CircuitBreakerFilterFunctions.circuitBreaker;
 import static org.springframework.cloud.gateway.server.mvc.filter.LoadBalancerFilterFunctions.lb;
 import static org.springframework.cloud.gateway.server.mvc.handler.GatewayRouterFunctions.route;
@@ -142,7 +151,8 @@ class RouteConfiguration {
                 .filter(circuitBreaker("fetchIngredients", URI.create("forward:/fallback")))
                 .build()
             .and(route("ingredients-fallback")
-                .route(path("/fallback"), http("http://localhost:9994"))
+                .route(path("/fallback"), http())
+                .before(uri("https://localhost:9994"))
                 .build());
     }
 }