Skip to content
Server Plugin

HSTS

所需依赖项:io.ktor:ktor-server-hsts

代码示例: ssl-engine-main-hsts

Native 服务器Ktor 支持 Kotlin/Native,并允许您在无需额外运行时或虚拟机的情况下运行服务器。支持:✅

HSTS 插件根据 RFC 6797 为请求添加必需的 HTTP 严格传输安全 (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。