Skip to content
Server Plugin

HSTS

必要な依存関係: io.ktor:ktor-server-hsts

コード例: ssl-engine-main-hsts

ネイティブサーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✅

HSTS プラグインは、RFC 6797 に従って、必要な HTTP Strict Transport Security ヘッダーをリクエストに追加します。ブラウザが HSTS ポリシーヘッダーを受信すると、指定された期間、安全でない接続でサーバーに接続することを試みなくなります。

安全でない HTTP 接続上では、HSTS ポリシーヘッダーは無視されることに注意してください。HSTS を有効にするには、安全な接続経由で配信される必要があります。

依存関係の追加 ​

HSTS を使用するには、ビルドスクリプトに ktor-server-hsts アーティファクトを追加します。

kotlin
implementation(ktorLibs.server.hsts)
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログを使用しています。
groovy
implementation ktorLibs.server.hsts
上記のコードスニペットでは、Ktor の依存関係を指定するために 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 を介してその設定を公開します。以下の例では、クライアントが既知の HSTS ホストのリストにそのホストを保持する期間を maxAgeInSeconds プロパティを使って指定する方法を示しています。

kotlin
install(HSTS) {
    maxAgeInSeconds = 10
}

また、withHost を使用してホストごとに異なる HSTS 設定を提供することもできます。

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

完全な例はこちらで確認できます: ssl-engine-main-hsts