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 、 easy-rsa 、 cfsslなどのツールを使用して自己署名証明書を生成できます。

   opensslを選択すると自己署名証明書の生成を参照できます。

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

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

   • TiDB

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

     [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"
     

   • TiKV

     構成ファイルまたはコマンドライン引数で構成し、対応する 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"
     

   • TiCDC

     設定ファイルで設定：

     [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"
   

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

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

コンポーネントの呼び出し元の ID を検証するには、証明書の生成時にCommon Name使用して証明書ユーザー ID をマークし、呼び出し先のCommon Nameリストを構成して呼び出し元の ID を確認する必要があります。

• TiDB

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

  [security]
  cluster-verify-cn = [
      "TiDB-Server",
      "TiKV-Control",
  ]
  

• TiKV

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

  [security]
  cert-allowed-cn = [
      "TiDB-Server", "PD-Server", "TiKV-Control", "RawKvClient1",
  ]
  

• PD

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

  [security]
  cert-allowed-cn = ["TiKV-Server", "TiDB-Server", "PD-Control"]
  

• TiFlash (v4.0.5 の新機能)

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

  [security]
  cert_allowed_cn = ["TiKV-Server", "TiDB-Server"]
  

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

  [security]
  cert-allowed-cn = ["PD-Server", "TiKV-Server", "TiFlash-Server"]
  

証明書をリロードする

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

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

証明書の有効期限

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

こちらも参照

• TiDB クライアントとサーバー間で TLS を有効にする