TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ

TiDB コンポーネント間の TLS を有効にする

このドキュメントでは、TiDB クラスター内のコンポーネント間で暗号化されたデータ転送を有効にする方法について説明します。有効にすると、次のコンポーネント間で暗号化された転送が使用されます。

  • TiDB、TiKV、PD、 TiFlash間の通信
  • TiDB コントロールと TiDB、 TiKV Controlと TiKV、 PD Controlと PD
  • 各 TiDB、TiKV、PD、およびTiFlashクラスタ内の内部通信

現在、特定のコンポーネントの暗号化された送信のみを有効にすることはサポートされていません。

暗号化されたデータ転送を設定して有効にする

  1. 証明書を準備します。

    TiDB、TiKV、PD のサーバー証明書を個別に準備することをお勧めします。これらのコンポーネントが相互に認証できることを確認してください。TiDB、TiKV、PD のコントロール ツールは、1 つのクライアント証明書を共有することを選択できます。

    opensslなどcfsslツールを使用して自己easy-rsa証明書を生成できます。

    openssl選択した場合は自己署名証明書の生成を参照できます。

  2. 証明書を構成します。

    TiDB コンポーネント間の相互認証を有効にするには、TiDB、TiKV、PD の証明書を次のように構成します。

    • ティビ

      設定ファイルまたはコマンドライン引数で設定します。

      [security]
# Path of the file that contains list of trusted SSL CAs for connection with cluster components.
cluster-ssl-ca = "/path/to/ca.pem"
# Path of the file that contains X509 certificate in PEM format for connection with cluster components.
cluster-ssl-cert = "/path/to/tidb-server.pem"
# Path of the file that contains X509 key in PEM format for connection with cluster components.
cluster-ssl-key = "/path/to/tidb-server-key.pem"

    • ティクヴ

      設定ファイルまたはコマンドライン引数で設定し、対応する URL をhttpsに設定します。

      [security]
## The path for certificates. An empty string means that secure connections are disabled.
# Path of the file that contains a list of trusted SSL CAs. If it is set, the following settings `cert_path` and `key_path` are also needed.
ca-path = "/path/to/ca.pem"
# Path of the file that contains X509 certificate in PEM format.
cert-path = "/path/to/tikv-server.pem"
# Path of the file that contains X509 key in PEM format.
key-path = "/path/to/tikv-server-key.pem"

    • PD

      設定ファイルまたはコマンドライン引数で設定し、対応する URL をhttpsに設定します。

      [security]
## The path for certificates. An empty string means that secure connections are disabled.
# Path of the file that contains a list of trusted SSL CAs. If it is set, the following settings `cert_path` and `key_path` are also needed.
cacert-path = "/path/to/ca.pem"
# Path of the file that contains X509 certificate in PEM format.
cert-path = "/path/to/pd-server.pem"
# Path of the file that contains X509 key in PEM format.
key-path = "/path/to/pd-server-key.pem"

    • TiFlash (v4.0.5 の新機能)

      tiflash.tomlファイルで設定し、 http_port項目をhttps_portに変更します。

      [security]
## The path for certificates. An empty string means that secure connections are disabled.
# Path of the file that contains a list of trusted SSL CAs. If it is set, the following settings `cert_path` and `key_path` are also needed.
ca_path = "/path/to/ca.pem"
# Path of the file that contains X509 certificate in PEM format.
cert_path = "/path/to/tiflash-server.pem"
# Path of the file that contains X509 key in PEM format.
key_path = "/path/to/tiflash-server-key.pem"

      tiflash-learner.tomlファイルで設定します:

      [security]
# Path of the file that contains a list of trusted SSL CAs. If it is set, the following settings `cert_path` and `key_path` are also needed.
ca-path = "/path/to/ca.pem"
# Path of the file that contains X509 certificate in PEM format.
cert-path = "/path/to/tiflash-server.pem"
# Path of the file that contains X509 key in PEM format.
key-path = "/path/to/tiflash-server-key.pem"

    • ティCDC

      設定ファイルで設定します:

      [security]
ca-path = "/path/to/ca.pem"
cert-path = "/path/to/cdc-server.pem"
key-path = "/path/to/cdc-server-key.pem"

      または、コマンドライン引数で設定し、対応する URL をhttpsに設定します。

      cdc server --pd=https://127.0.0.1:2379 --log-file=ticdc.log --addr=0.0.0.0:8301 --advertise-addr=127.0.0.1:8301 --ca=/path/to/ca.pem --cert=/path/to/ticdc-cert.pem --key=/path/to/ticdc-key.pem

      これで、TiDB コンポーネント間の暗号化された送信が有効になります。

    注記：

    TiDB クラスターで暗号化された送信を有効にした後、tidb-ctl、tikv-ctl、または pd-ctl を使用してクラスターに接続する必要がある場合は、クライアント証明書を指定します。例:

    ./tidb-ctl -u https://127.0.0.1:10080 --ca /path/to/ca.pem --ssl-cert /path/to/client.pem --ssl-key /path/to/client-key.pem

    tiup ctl:v<CLUSTER_VERSION> pd -u https://127.0.0.1:2379 --cacert /path/to/ca.pem --cert /path/to/client.pem --key /path/to/client-key.pem

    ./tikv-ctl --host="127.0.0.1:20160" --ca-path="/path/to/ca.pem" --cert-path="/path/to/client.pem" --key-path="/path/to/clinet-key.pem"

コンポーネント呼び出し元のIDを確認する

一般的に、呼び出し先は、呼び出し元が提供するキー、証明書、および CA を検証することに加えて、 Common Name使用して呼び出し元の ID を検証する必要があります。たとえば、TiKV には TiDB のみがアクセスでき、他の訪問者は正当な証明書を持っていてもブロックされます。

コンポーネントの呼び出し元の ID を確認するには、証明書を生成するときにCommon Name使用して証明書のユーザー ID をマークし、呼び出し先にcluster-verify-cn (TiDB の場合) またはcert-allowed-cn (その他のコンポーネントの場合) を設定して呼び出し元の ID を確認する必要があります。

注記：

  • v8.4.0 以降、PD 構成項目cert-allowed-cn複数の値をサポートします。必要に応じて、TiDB のcluster-verify-cn構成項目と他のコンポーネントのcert-allowed-cn構成項目に複数のCommon Name設定できます。TiUPは、コンポーネントのステータスを照会するときに別の識別子を使用することに注意してください。たとえば、クラスター名がtest場合、 TiUP はCommon Nameとしてtest-client使用します。
  • v8.3.0 以前のバージョンでは、PD 構成項目cert-allowed-cnには 1 つの値しか設定できません。したがって、すべての認証オブジェクトのCommon Name同じ値に設定する必要があります。関連する構成例については、 v8.3.0 ドキュメント参照してください。

  • ティビ

    設定ファイルまたはコマンドライン引数で設定します。

    [security]
cluster-verify-cn = ["tidb", "test-client", "prometheus"]

  • ティクヴ

    設定ファイルまたはコマンドライン引数で設定します。

    [security]
cert-allowed-cn = ["tidb", "pd", "tikv", "tiflash", "prometheus"]

  • PD

    設定ファイルまたはコマンドライン引数で設定します。

    [security]
cert-allowed-cn = ["tidb", "pd", "tikv", "tiflash", "test-client", "prometheus"]

  • TiFlash (v4.0.5 の新機能)

    tiflash.tomlファイルまたはコマンドライン引数で設定します。

    [security]
cert_allowed_cn = ["tidb", "tikv", "prometheus"]

    tiflash-learner.tomlファイルで設定します:

    [security]
cert-allowed-cn = ["tidb", "tikv", "tiflash", "prometheus"]

証明書を再読み込み

  • TiDB クラスターがローカル データ センターに展開されている場合、証明書とキーを再ロードするために、TiDB、PD、TiKV、 TiFlash、TiCDC、およびあらゆる種類のクライアントは、TiDB クラスターを再起動せずに、新しい接続が作成されるたびに現在の証明書とキー ファイルを再読み取ります。

  • TiDB クラスターが独自の管理クラウドにデプロイされている場合は、TLS 証明書の発行がクラウド プロバイダーの証明書管理サービスと統合されていることを確認してください。TiDB、PD、TiKV、 TiFlash、および TiCDC コンポーネントの TLS 証明書は、TiDB クラスターを再起動せずに自動的にローテーションできます。

証明書の有効期間

TiDB クラスター内の各コンポーネントの TLS 証明書の有効期間をカスタマイズできます。たとえば、OpenSSL を使用して TLS 証明書を発行および生成する場合、 daysパラメータを使用して有効期間を設定できます。詳細については、 自己署名証明書を生成する参照してください。

参照

このページは役に立ちましたか？