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

ログインのための証明書ベースの認証

TiDB は、ユーザーが TiDB にログインするための証明書ベースの認証方法をサポートしています。この方法では、TiDB はさまざまなユーザーに証明書を発行し、暗号化された接続を使用してデータを転送し、ユーザーのログイン時に証明書を検証します。このアプローチは、MySQL ユーザーが一般的に使用する従来のパスワードベースの認証方法よりも安全であるため、ますます多くのユーザーに採用されています。

証明書ベースの認証を使用するには、次の操作を実行する必要がある場合があります。

  • セキュリティキーと証明書を作成する
  • TiDBとクライアントの証明書を構成する
  • ユーザーがログインするときに検証されるユーザー証明書情報を構成する
  • 証明書の更新と置き換え

ドキュメントの残りの部分では、これらの操作を実行する方法について詳しく説明します。

セキュリティキーと証明書を作成する

キーと証明書を作成するには、 オープンSSL使用することをお勧めします。証明書の生成プロセスは、 TiDBクライアントとサーバー間のTLSを有効にするで説明したプロセスと似ています。次の段落では、証明書で検証する必要がある追加の属性フィールドを構成する方法を示します。

CAキーと証明書を生成する

  1. CA キーを生成するには、次のコマンドを実行します。

    sudo openssl genrsa 2048 > ca-key.pem

    上記のコマンドの出力:

    Generating RSA private key, 2048 bit long modulus (2 primes)
....................+++++
...............................................+++++
e is 65537 (0x010001)

  2. 次のコマンドを実行して、CA キーに対応する証明書を生成します。

    sudo openssl req -new -x509 -nodes -days 365000 -key ca-key.pem -out ca-cert.pem

  3. 詳細な証明書情報を入力します。例:

    Country Name (2 letter code) [AU]:US
State or Province Name (full name) [Some-State]:California
Locality Name (e.g. city) []:San Francisco
Organization Name (e.g. company) [Internet Widgits Pty Ltd]:PingCAP Inc.
Organizational Unit Name (e.g. section) []:TiDB
Common Name (e.g. server FQDN or YOUR name) []:TiDB admin
Email Address []:s@pingcap.com

    注記：

    上記の証明書の詳細において、 :以降のテキストは入力された情報です。

サーバーキーと証明書を生成する

  1. 次のコマンドを実行してサーバーキーを生成します。

    sudo openssl req -newkey rsa:2048 -days 365000 -nodes -keyout server-key.pem -out server-req.pem

  2. 詳細な証明書情報を入力します。例:

    Country Name (2 letter code) [AU]:US
State or Province Name (full name) [Some-State]:California
Locality Name (e.g. city) []:San Francisco
Organization Name (e.g. company) [Internet Widgits Pty Ltd]:PingCAP Inc.
Organizational Unit Name (e.g. section) []:TiKV
Common Name (e.g. server FQDN or YOUR name) []:TiKV Test Server
Email Address []:k@pingcap.com

Please enter the following 'extra' attributes
to be sent with your certificate request
A challenge password []:
An optional company name []:

  3. サーバーの RSA キーを生成するには、次のコマンドを実行します。

    sudo openssl rsa -in server-key.pem -out server-key.pem

    上記のコマンドの出力:

    writing RSA key

  4. CA 証明書の署名を使用して、署名されたサーバー証明書を生成します。

    sudo openssl x509 -req -in server-req.pem -days 365000 -CA ca-cert.pem -CAkey ca-key.pem -set_serial 01 -out server-cert.pem

    上記のコマンドの出力（例）：

    Signature ok
subject=C = US, ST = California, L = San Francisco, O = PingCAP Inc., OU = TiKV, CN = TiKV Test Server, emailAddress = k@pingcap.com
Getting CA Private Key

    注記：

    ログインすると、TiDB は上記の出力のsubjectセクションの情報が一貫しているかどうかを確認します。

クライアントキーと証明書を生成する

サーバーキーと証明書を生成したら、クライアントのキーと証明書を生成する必要があります。ユーザーごとに異なるキーと証明書を生成する必要があることがよくあります。

  1. 次のコマンドを実行してクライアント キーを生成します。

    sudo openssl req -newkey rsa:2048 -days 365000 -nodes -keyout client-key.pem -out client-req.pem

  2. 詳細な証明書情報を入力します。例:

    Country Name (2 letter code) [AU]:US
State or Province Name (full name) [Some-State]:California
Locality Name (e.g. city) []:San Francisco
Organization Name (e.g. company) [Internet Widgits Pty Ltd]:PingCAP Inc.
Organizational Unit Name (e.g. section) []:TiDB
Common Name (e.g. server FQDN or YOUR name) []:tpch-user1
Email Address []:zz@pingcap.com

Please enter the following 'extra' attributes
to be sent with your certificate request
A challenge password []:
An optional company name []:

  3. 次のコマンドを実行して、クライアントの RSA キーを生成します。

    sudo openssl rsa -in client-key.pem -out client-key.pem

    上記のコマンドの出力:

    writing RSA key

  4. CA 証明書の署名を使用してクライアント証明書を生成します。

    sudo openssl x509 -req -in client-req.pem -days 365000 -CA ca-cert.pem -CAkey ca-key.pem -set_serial 01 -out client-cert.pem

    上記のコマンドの出力（例）：

    Signature ok
subject=C = US, ST = California, L = San Francisco, O = PingCAP Inc., OU = TiDB, CN = tpch-user1, emailAddress = zz@pingcap.com
Getting CA Private Key

    注記：

    上記出力のセクションsubjectの情報は、セクションrequireのログイン検証用の証明書設定に使用されます。

証明書を確認する

証明書を検証するには、次のコマンドを実行します。

openssl verify -CAfile ca-cert.pem server-cert.pem client-cert.pem

証明書が検証されると、次の結果が表示されます。

server-cert.pem: OK
client-cert.pem: OK

証明書を使用するようにTiDBとクライアントを構成する

証明書を生成した後、対応するサーバー証明書またはクライアント証明書を使用するように TiDBサーバーとクライアントを構成する必要があります。

サーバー証明書を使用するようにTiDBを構成する

TiDB 構成ファイルの[security]セクションを変更します。この手順では、CA 証明書、サーバーキー、サーバー証明書が保存されるディレクトリを指定します。 path/to/server-cert.pem 、 path/to/server-key.pem 、 path/to/ca-cert.pem独自のディレクトリに置き換えることができます。

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

TiDB を起動し、ログを確認します。ログに次の情報が表示されれば、構成は成功です。

[INFO] [server.go:286] ["mysql protocol server secure connection is enabled"] ["client verification enabled"=true]

クライアント証明書を使用するようにクライアントを構成する

クライアントがログインにクライアント キーと証明書を使用するようにクライアントを構成します。

MySQL クライアントを例にとると、 ssl-cert 、 ssl-key 、 ssl-caを指定して、新しく作成されたクライアント証明書、クライアント キー、 CA を使用できます。

mysql -utest -h0.0.0.0 -P4000 --ssl-cert /path/to/client-cert.new.pem --ssl-key /path/to/client-key.new.pem --ssl-ca /path/to/ca-cert.pem

注記：

/path/to/client-cert.new.pem 、 /path/to/client-key.new.pem 、 /path/to/ca-cert.pem 、 CA 証明書、クライアント キー、クライアント証明書のディレクトリです。独自のディレクトリに置き換えることができます。

ログイン検証用のユーザー証明書情報を構成する

まず、クライアントを使用して TiDB に接続し、ログイン検証を構成します。次に、検証するユーザー証明書情報を取得して構成できます。

ユーザー証明書情報を取得する

ユーザー証明書情報は、X.509 証明書属性を確認するために使用されるREQUIRE SUBJECT 、 REQUIRE ISSUER 、 REQUIRE SAN 、およびREQUIRE CIPHERで指定できます。

  • REQUIRE SUBJECT : ログイン時のクライアント証明書のサブジェクト情報を指定します。このオプションを指定すると、 require sslまたは x509 を設定する必要はありません。指定する情報は、 クライアントキーと証明書を生成するで入力したサブジェクト情報と一致します。

    このオプションを取得するには、次のコマンドを実行します。

    openssl x509 -noout -subject -in client-cert.pem | sed 's/.\{8\}//'  | sed 's/, /\//g' | sed 's/ = /=/g' | sed 's/^/\//'

  • require issuer : ユーザー証明書を発行する CA 証明書のsubject情報を指定します。指定する情報は、 CAキーと証明書を生成するで入力したsubject情報と一致します。

    このオプションを取得するには、次のコマンドを実行します。

    openssl x509 -noout -subject -in ca-cert.pem | sed 's/.\{8\}//'  | sed 's/, /\//g' | sed 's/ = /=/g' | sed 's/^/\//'

  • require san : ユーザー証明書を発行する CA 証明書のSubject Alternative Name情報を指定します。指定する情報は、クライアント証明書の生成に使用されたopenssl.cnf設定ファイルのalt_namesの情報と一致します。

    • 生成された証明書のREQUIRE SAN項目の情報を取得するには、次のコマンドを実行します。

      openssl x509 -noout -extensions subjectAltName -in client.crt

    • REQUIRE SAN現在、次のSubject Alternative Nameチェック項目をサポートしています。

      • URI
      • IP
      • ドメイン名

    • 複数のチェック項目は、カンマでつなげて設定できます。例えば、 u1ユーザーの場合はREQUIRE SAN次のように設定します。

      CREATE USER 'u1'@'%' REQUIRE SAN 'DNS:d1,URI:spiffe://example.org/myservice1,URI:spiffe://example.org/myservice2';

      上記の構成では、URI 項目spiffe://example.org/myservice1またはspiffe://example.org/myservice2と DNS 項目d1を持つ証明書を使用して、 u1ユーザーのみが TiDB にログインできます。

  • REQUIRE CIPHER : クライアントがサポートする暗号方式をチェックします。サポートされている暗号方式のリストを確認するには、次のステートメントを使用します。

    SHOW SESSION STATUS LIKE 'Ssl_cipher_list';

ユーザー証明書情報を構成する

ユーザー証明書情報 ( REQUIRE SUBJECT 、 REQUIRE ISSUER 、 REQUIRE SAN 、 REQUIRE CIPHER ) を取得したら、ユーザーの作成、権限の付与、またはユーザーの変更時にこれらの情報が検証されるように構成します。次のステートメントの<replaceable>を対応する情報に置き換えます。

スペースまたはand区切り文字として使用して、1 つのオプションまたは複数のオプションを設定できます。

  • ユーザー作成時にユーザー証明書を設定します（ CREATE USER ）：

    CREATE USER 'u1'@'%' REQUIRE ISSUER '<replaceable>' SUBJECT '<replaceable>' SAN '<replaceable>' CIPHER '<replaceable>';

  • ユーザーを変更するときにユーザー証明書を構成します。

    ALTER USER 'u1'@'%' REQUIRE ISSUER '<replaceable>' SUBJECT '<replaceable>' SAN '<replaceable>' CIPHER '<replaceable>';

上記の設定後、ログイン時に以下の項目が確認されます。

  • SSL が使用され、クライアント証明書を発行する CA はサーバーで構成されている CA と一致します。
  • クライアント証明書のissuer情報はREQUIRE ISSUERで指定された情報と一致します。
  • クライアント証明書のsubject情報はREQUIRE CIPHERで指定された情報と一致します。
  • クライアント証明書のSubject Alternative Name情報はREQUIRE SANで指定された情報と一致します。

上記のすべての項目が検証された後にのみ、TiDB にログインできます。そうでない場合は、 ERROR 1045 (28000): Access deniedエラーが返されます。次のコマンドを使用して、TLS バージョン、暗号アルゴリズム、および現在の接続がログインに証明書を使用しているかどうかを確認できます。

MySQL クライアントに接続し、次のステートメントを実行します。

\s

出力：

--------------
mysql  Ver 8.3.0 for Linux on x86_64 (MySQL Community Server - GPL)

Connection id:       1
Current database:    test
Current user:        root@127.0.0.1
SSL:                 Cipher in use is TLS_AES_128_GCM_SHA256

次に、次のステートメントを実行します。

SHOW VARIABLES LIKE '%ssl%';

出力：

+---------------+----------------------------------+
| Variable_name | Value                            |
+---------------+----------------------------------+
| have_openssl  | YES                              |
| have_ssl      | YES                              |
| ssl_ca        | /path/to/ca-cert.pem             |
| ssl_cert      | /path/to/server-cert.pem         |
| ssl_cipher    |                                  |
| ssl_key       | /path/to/server-key.pem          |
+---------------+----------------------------------+
6 rows in set (0.06 sec)

証明書の更新と置き換え

キーと証明書は定期的に更新されます。次のセクションでは、キーと証明書を更新する方法について説明します。

CA 証明書は、クライアントとサーバー間の相互検証の基礎となります。CA 証明書を置き換えるには、古い証明書と新しい証明書の両方の認証をサポートする結合証明書を生成します。クライアントとサーバーで、最初に CA 証明書を置き換え、次にクライアント/サーバーのキーと証明書を置き換えます。

CAキーと証明書を更新する

  1. 古い CA キーと証明書をバックアップします ( ca-key.pemが盗まれたと仮定)。

    mv ca-key.pem ca-key.old.pem && \
mv ca-cert.pem ca-cert.old.pem

  2. 新しい CA キーを生成します。

    sudo openssl genrsa 2048 > ca-key.pem

  3. 新しく生成された CA キーを使用して新しい CA 証明書を生成します。

    sudo openssl req -new -x509 -nodes -days 365000 -key ca-key.pem -out ca-cert.new.pem

    注記：

    新しい CA 証明書を生成するのは、クライアントとサーバーのキーと証明書を置き換え、オンライン ユーザーに影響が及ばないようにするためです。したがって、上記のコマンドで追加される情報は、 require issuer情報と一致している必要があります。

  4. 結合された CA 証明書を生成します。

    cat ca-cert.new.pem ca-cert.old.pem > ca-cert.pem

上記の操作の後、新しく作成された結合 CA 証明書を使用して TiDBサーバーを再起動します。その後、サーバーは新しい CA 証明書と古い CA 証明書の両方を受け入れます。

また、クライアントが古い CA 証明書と新しい CA 証明書の両方を受け入れるように、古い CA 証明書を結合された証明書に置き換えます。

クライアントキーと証明書を更新する

注記：

クライアントとサーバーの古い CA 証明書を結合された CA 証明書に置き換えた後にのみ、次の手順を実行してください。

  1. クライアントの新しい RSA キーを生成します。

    sudo openssl req -newkey rsa:2048 -days 365000 -nodes -keyout client-key.new.pem -out client-req.new.pem && \
sudo openssl rsa -in client-key.new.pem -out client-key.new.pem

    注記：

    上記のコマンドは、クライアントのキーと証明書を置き換え、オンライン ユーザーに影響が及ばないようにするためのものです。したがって、上記のコマンドで追加される情報は、 require subject情報と一致している必要があります。

  2. 結合された証明書と新しい CA キーを使用して、新しいクライアント証明書を生成します。

    sudo openssl x509 -req -in client-req.new.pem -days 365000 -CA ca-cert.pem -CAkey ca-key.pem -set_serial 01 -out client-cert.new.pem

  3. クライアント (MySQL など) が新しいクライアント キーと証明書を使用して TiDB に接続するようにします。

    mysql -utest -h0.0.0.0 -P4000 --ssl-cert /path/to/client-cert.new.pem --ssl-key /path/to/client-key.new.pem --ssl-ca /path/to/ca-cert.pem

    注記：

    /path/to/client-cert.new.pem 、 /path/to/client-key.new.pem 、 /path/to/ca-cert.pem 、CA 証明書、クライアント キー、クライアント証明書のディレクトリを指定します。これらは独自のディレクトリに置き換えることができます。

サーバーキーと証明書を更新する

  1. サーバーの新しい RSA キーを生成します:

    sudo openssl req -newkey rsa:2048 -days 365000 -nodes -keyout server-key.new.pem -out server-req.new.pem && \
sudo openssl rsa -in server-key.new.pem -out server-key.new.pem

  2. 結合された CA 証明書と新しい CA キーを使用して、新しいサーバー証明書を生成します。

    sudo openssl x509 -req -in server-req.new.pem -days 365000 -CA ca-cert.pem -CAkey ca-key.pem -set_serial 01 -out server-cert.new.pem

  3. 新しいサーバーキーと証明書を使用するように TiDBサーバーを構成します。詳細についてはTiDBサーバーを構成するを参照してください。

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