Skip to content
Server Plugin

Forwarded 헤더

필수 의존성: io.ktor:ktor-server-forwarded-header

코드 예제: forwarded-header

Native 서버Ktor는 Kotlin/Native를 지원하므로 추가 런타임이나 가상 머신 없이도 서버를 실행할 수 있습니다. 지원: ✅

ForwardedHeaders 및 XForwardedHeaders 플러그인을 사용하면 Ktor 서버가 리버스 프록시(reverse proxy) 뒤에 배치되었을 때 리버스 프록시 헤더를 처리하여 원래의 요청에 대한 정보를 얻을 수 있습니다. 이는 로깅 목적으로 유용할 수 있습니다.

  • ForwardedHeaders는 Forwarded 헤더(RFC 7239)를 처리합니다.
  • XForwardedHeaders는 다음 X-Forwarded- 헤더들을 처리합니다:
    • X-Forwarded-Host/X-Forwarded-Server
    • X-Forwarded-For
    • X-Forwarded-By
    • X-Forwarded-Proto/X-Forwarded-Protocol
    • X-Forwarded-SSL/Front-End-Https

Forwarded 헤더의 위변조를 방지하려면 애플리케이션이 리버스 프록시 연결만 허용하는 경우에만 이 플러그인들을 설치하세요.

의존성 추가 ​

ForwardedHeaders/XForwardedHeaders 플러그인을 사용하려면 빌드 스크립트에 ktor-server-forwarded-header 아티팩트를 포함해야 합니다:

kotlin
implementation(ktorLibs.server.forwardedHeader)
위 코드 스니펫은 Ktor 의존성을 지정하기 위해 Ktor 버전 카탈로그를 사용합니다.
groovy
implementation ktorLibs.server.forwardedHeader
위 코드 스니펫은 Ktor 의존성을 지정하기 위해 Ktor 버전 카탈로그를 사용합니다.
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-forwarded-header-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

플러그인 설치 ​

애플리케이션에 ForwardedHeaders 플러그인을 설치하려면, 지정된 모듈모듈을 사용하면 라우트를 그룹화하여 애플리케이션의 구조를 설계할 수 있습니다.의 install 함수에 전달하세요. 다음 예제는 ForwardedHeaders을 설치하는 방법을 보여줍니다:

  • embeddedServer() 함수 호출 내부에서 설치.
  • Application 클래스에 명시적으로 정의된 module() 확장 함수 내부에서 설치.
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.forwardedheaders.*

fun main() {
    embeddedServer(Netty, port = 8080) {
        install(ForwardedHeaders)
        // ...
    }.start(wait = true)
}
kotlin
import io.ktor.server.application.*
import io.ktor.server.plugins.forwardedheaders.*
// ...
fun Application.module() {
    install(ForwardedHeaders)
    // ...
}

애플리케이션에 XForwardedHeaders 플러그인을 설치하려면, 지정된 모듈모듈을 사용하면 라우트를 그룹화하여 애플리케이션의 구조를 설계할 수 있습니다.의 install 함수에 전달하세요. 다음 예제는 XForwardedHeaders을 설치하는 방법을 보여줍니다:

  • embeddedServer() 함수 호출 내부에서 설치.
  • Application 클래스에 명시적으로 정의된 module() 확장 함수 내부에서 설치.
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.forwardedheaders.*

fun main() {
    embeddedServer(Netty, port = 8080) {
        install(XForwardedHeaders)
        // ...
    }.start(wait = true)
}
kotlin
import io.ktor.server.application.*
import io.ktor.server.plugins.forwardedheaders.*
// ...
fun Application.module() {
    install(XForwardedHeaders)
    // ...
}

ForwardedHeaders/XForwardedHeaders를 설치한 후에는 call.request.origin 프로퍼티를 사용하여 원래 요청에 대한 정보를 가져올 수 있습니다.

요청 정보 가져오기 ​

프록시 요청 정보 ​

프록시 요청에 대한 정보를 가져오려면 라우트 핸들러 내부에서 call.request.local 프로퍼티를 사용하세요. 아래 코드 스니펫은 프록시 주소와 요청이 전송된 대상 호스트에 대한 정보를 가져오는 방법을 보여줍니다:

kotlin
get("/hello") {
    val remoteHost = call.request.local.remoteHost
    val serverHost = call.request.local.serverHost
}

원래 요청 정보 ​

원래 요청에 대한 정보를 읽으려면 call.request.origin 프로퍼티를 사용하세요:

kotlin
get("/hello") {
    val originRemoteHost = call.request.origin.remoteHost
    val originServerHost = call.request.origin.serverHost
}

아래 표는 ForwardedHeaders/XForwardedHeaders 설치 여부에 따라 call.request.origin이 제공하는 다양한 프로퍼티의 값을 보여줍니다.

요청 다이어그램

프로퍼티ForwardedHeaders 미사용ForwardedHeaders 사용
origin.localHostweb-serverweb-server
origin.localPort80808080
origin.serverHostweb-serverproxy
origin.serverPort808080
origin.remoteHostproxyclient
origin.remotePort3286432864

전체 예제는 여기에서 확인할 수 있습니다: forwarded-header.

ForwardedHeaders 구성하기 ​

요청이 여러 프록시를 통과하는 경우 ForwardedHeaders/XForwardedHeaders를 구성해야 할 수 있습니다. 이 경우 X-Forwarded-For에는 연속된 각 프록시의 모든 IP 주소가 포함됩니다. 예를 들면 다음과 같습니다:

HTTP
X-Forwarded-For: <client>, <proxy1>, <proxy2>

기본적으로 XForwardedHeader는 X-Forwarded-For의 첫 번째 항목을 call.request.origin.remoteHost 프로퍼티에 할당합니다. 또한 IP 주소 선택을 위한 커스텀 로직을 제공할 수도 있습니다. XForwardedHeadersConfig는 이를 위해 다음과 같은 API를 제공합니다:

  • useFirstProxy 및 useLastProxy를 사용하면 IP 주소 목록에서 각각 첫 번째 또는 마지막 값을 가져올 수 있습니다.
  • skipLastProxies는 오른쪽 끝부터 지정된 개수의 항목을 건너뛰고 그다음 항목을 가져옵니다. 예를 들어 proxiesCount 매개변수가 3인 경우, 아래 헤더에 대해 origin.remoteHost는 10.0.0.123을 반환합니다:
    HTTP
    X-Forwarded-For: 10.0.0.123, proxy-1, proxy-2, proxy-3
  • skipKnownProxies는 목록에서 지정된 항목들을 제거하고 마지막 항목을 가져옵니다. 예를 들어 이 함수에 listOf("proxy-1", "proxy-3")을 전달하면, 아래 헤더에 대해 origin.remoteHost는 proxy-2를 반환합니다:
    HTTP
    X-Forwarded-For: 10.0.0.123, proxy-1, proxy-2, proxy-3
  • extractEdgeProxy를 사용하면 X-Forward-* 헤더에서 값을 추출하기 위한 커스텀 로직을 제공할 수 있습니다.