TLS (HTTPS)

server.ssl.certificate と server.ssl.certificate-private-key に二つの PEM ファイルを設定すると、サーバーは HTTP の代わりに HTTPS を話します。

使う理由

TLS がなければ、クライアントとサーバーの間のすべて、つまりパスワード、セッション Cookie、トークンが、途中で読まれたり変更されたりする可能性があります。前段にプロキシを置かず、クライアントがサーバーに直接アクセスする場合は TLS を使ってください。

リバースプロキシやロードバランサー (nginx、Traefik、クラウドのロードバランサー) が TLS を終端してくれる場合は、通常 server.ssl.* を空のままにし、代わりに server.forward-headers-strategy を設定します。リバースプロキシの背後で を参照してください。

クライアント証明書 (server.ssl.client-auth) を使うと、サーバーはどのマシンが呼んでいるかを知ることができます。サービス間の相互 TLS です。

例

# lib/resources/application.yml
server:
  port: 8443
  ssl:
    certificate: /etc/shop/tls/fullchain.pem
    certificate-private-key: /etc/shop/tls/privkey.pem
server.port=8443
server.ssl.certificate=/etc/shop/tls/fullchain.pem
server.ssl.certificate-private-key=/etc/shop/tls/privkey.pem

すると起動時の行は https になります。

Web server started on port 8443 (https)

開発用の自己署名証明書:

openssl req -x509 -newkey rsa:2048 -nodes -days 30 -subj /CN=localhost \
  -keyout key.pem -out cert.pem
server.ssl.certificate=cert.pem
server.ssl.certificate-private-key=key.pem

相対パスは、プロセスの作業ディレクトリから読まれます。

相互 TLS

server:
  ssl:
    certificate: /etc/billing/tls/server.pem
    certificate-private-key: /etc/billing/tls/server-key.pem
    key-password: ${TLS_KEY_PASSWORD}
    trust-certificate: /etc/billing/tls/clients-ca.pem
    client-auth: need

clients-ca.pem の証明書で署名された証明書を持つクライアントだけが応答を受け取ります。それ以外は 403 になります。

プロパティ

キー 型 デフォルト 意味
server.ssl.enabled bool true false は TLS を無効にし、他の server.ssl.* キーを無視する。
server.ssl.certificate String (ファイルパス) なし 証明書チェーン (PEM ファイル)。設定されていれば TLS が有効。
server.ssl.certificate-private-key String (ファイルパス) なし 秘密鍵 (PEM ファイル)。certificate と一緒に必須。
server.ssl.key-password String なし 暗号化された秘密鍵のパスワード。
server.ssl.trust-certificate String (ファイルパス) なし クライアント証明書の署名者でなければならない証明書 (PEM ファイル)。
server.ssl.client-auth none / want / need none クライアントに証明書を求めるかどうか。

server.ssl.enabled

server.ssl.certificate

server.ssl.certificate-private-key

server.ssl.certificate needs server.ssl.certificate-private-key

server.ssl.key-password

server.ssl.trust-certificate

server.ssl.client-auth

値 動作
none クライアント証明書を求めない。
want TLS ハンドシェイク中に証明書を求める。持たないクライアントにもサービスする。
need 証明書を求める。持たないリクエストには 403 Forbidden (詳細 A client certificate is required の ProblemDetail) で応答する。

TLS を有効にすると変わるもの

ルール

Spring (Java) との対応

server.port=8443
server.ssl.certificate=classpath:tls/fullchain.pem
server.ssl.certificate-private-key=classpath:tls/privkey.pem
server.ssl.trust-certificate=classpath:tls/clients-ca.pem
server.ssl.client-auth=need

重要な違い:

関連項目