KTOR-2788 Add support for X-Forwarded-Port (#2518)

ktorio · Jun 17, 2021 · 0821569 · 0821569
1 parent 3cf7ab7
commit 0821569
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 0 deletions.
diff --git a/ktor-http/common/src/io/ktor/http/HttpHeaders.kt b/ktor-http/common/src/io/ktor/http/HttpHeaders.kt
@@ -120,6 +120,9 @@ public object HttpHeaders {
     public val XForwardedProto: String = "X-Forwarded-Proto"
     public val XForwardedFor: String = "X-Forwarded-For"
 
+    @PublicAPICandidate("2.0.0")
+    internal val XForwardedPort: String = "X-Forwarded-Port"
+
     public val XRequestId: String = "X-Request-ID"
     public val XCorrelationId: String = "X-Correlation-ID"
     public val XTotalCount: String = "X-Total-Count"

diff --git a/ktor-server/ktor-server-core/jvm/src/io/ktor/features/OriginConnectionPoint.kt b/ktor-server/ktor-server-core/jvm/src/io/ktor/features/OriginConnectionPoint.kt
@@ -129,6 +129,11 @@ public object XForwardedHeaderSupport :
                 }
             }
 
+            call.forEachHeader(config.portHeaders) { value ->
+                val port = value.toInt()
+                call.mutableOriginConnectionPoint.port = port
+            }
+
             call.forEachHeader(config.forHeaders) { xForwardedFor ->
                 val remoteHost = xForwardedFor.split(",").first().trim()
                 if (remoteHost.isNotBlank()) {
@@ -167,6 +172,12 @@ public object XForwardedHeaderSupport :
          * HTTPS/TLS flag header names. Default are `X-Forwarded-SSL` and `Front-End-Https`
          */
         public val httpsFlagHeaders: ArrayList<String> = arrayListOf("X-Forwarded-SSL", "Front-End-Https")
+
+        /**
+         * Port X-header names. Default is `X-Forwarded-Port`
+         */
+        @PublicAPICandidate("2.0.0")
+        internal val portHeaders: ArrayList<String> = arrayListOf("X-Forwarded-Port")
     }
 }
 

diff --git a/...ver/ktor-server-tests/jvm/test/io/ktor/tests/server/features/OriginConnectionPointTest.kt b/...ver/ktor-server-tests/jvm/test/io/ktor/tests/server/features/OriginConnectionPointTest.kt
@@ -189,6 +189,47 @@ class OriginConnectionPointTest {
         }
     }
 
+    @Test
+    fun testProxyXForwardedPort() {
+        withTestApplication {
+            application.install(XForwardedHeaderSupport)
+            application.routing {
+                get("/") {
+                    with(call.request.origin) {
+                        assertEquals(91, port)
+                    }
+
+                    call.respond("OK")
+                }
+            }
+
+            handleRequest(HttpMethod.Get, "/") {
+                addHeader("X-Forwarded-Port", "91")
+            }
+        }
+    }
+
+    @Test
+    fun testProxyXForwardedSchemeWithPortAndXForwardedPort() {
+        withTestApplication {
+            application.install(XForwardedHeaderSupport)
+            application.routing {
+                get("/") {
+                    with(call.request.origin) {
+                        assertEquals(91, port)
+                    }
+
+                    call.respond("OK")
+                }
+            }
+
+            handleRequest(HttpMethod.Get, "/") {
+                addHeader(HttpHeaders.XForwardedHost, "host:90")
+                addHeader("X-Forwarded-Port", "91")
+            }
+        }
+    }
+
     @Test
     fun testProxyXForwardedHttpsFlagOn() {
         withTestApplication {