Skip to content
Server Plugin

HSTS

必要相依性: io.ktor:ktor-server-hsts

程式碼範例: ssl-engine-main-hsts

Native 伺服器Ktor 支援 Kotlin/Native,可讓您在無需額外執行階段或虛擬機的情況下執行伺服器。支援: ✅

HSTS 外掛程式會根據 RFC 6797 在請求中新增必要的 HTTP Strict Transport Security 標頭。當瀏覽器收到 HSTS 策略標頭後,在指定期間內將不再嘗試使用不安全連線來連線至伺服器。

請注意,透過不安全的 HTTP 連線傳輸時,HSTS 策略標頭會被忽略。若要讓 HSTS 生效,應透過安全連線提供服務。

新增相依性 ​

若要使用 HSTS,請將 ktor-server-hsts 構件新增至您的組建指令碼中:

kotlin
implementation(ktorLibs.server.hsts)
上述程式碼片段使用 Ktor version catalog 來指定 Ktor 相依性。
groovy
implementation ktorLibs.server.hsts
上述程式碼片段使用 Ktor version catalog 來指定 Ktor 相依性。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-hsts-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

安裝 HSTS ​

若要將 HSTS 外掛程式安裝至您的應用程式,請將其傳遞給指定模組模組可讓您透過對路由進行分組來建構應用程式。中的 install 函式。 以下範例示範如何安裝 HSTS:

  • 在 embeddedServer() 函式呼叫中。
  • 在 Application 類別上明確定義的 module() 擴充函式中。
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.hsts.*

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

HSTS 外掛程式也可以安裝到特定路由。 如果您需要為不同的應用程式資源使用不同的 HSTS 配置,這會很有幫助。

設定 HSTS ​

HSTS 透過 HSTSConfig 公開其設定。以下範例示範如何使用 maxAgeInSeconds 屬性來指定用戶端應將該主機保留在已知 HSTS 主機清單中的時間長度:

kotlin
install(HSTS) {
    maxAgeInSeconds = 10
}

您也可以使用 withHost 為不同的主機提供不同的 HSTS 配置:

kotlin
install(HSTS) {
    maxAgeInSeconds = 10
    withHost("sample-host") {
        maxAgeInSeconds = 60
        includeSubDomains = false
    }
}

您可以在此處找到完整的範例:ssl-engine-main-hsts。