ユーザーとロール設定

users.xml 構成ファイルの users セクションには、ユーザー設定が含まれています。

注記

ClickHouse はユーザー管理のための SQL駆動型ワークフロー をサポートしています。これを使用することをお勧めします。

users セクションの構造:

<users>
    <!-- ユーザー名が指定されていない場合は、'default' ユーザーが使用されます。 -->
    <user_name>
        <password></password>
        <!-- または -->
        <password_sha256_hex></password_sha256_hex>

        <ssh_keys>
            <ssh_key>
                <type>ssh-ed25519</type>
                <base64_key>AAAAC3NzaC1lZDI1NTE5AAAAIDNf0r6vRl24Ix3tv2IgPmNPO2ATa2krvt80DdcTatLj</base64_key>
            </ssh_key>
            <ssh_key>
                <type>ecdsa-sha2-nistp256</type>
                <base64_key>AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBNxeV2uN5UY6CUbCzTA1rXfYimKQA5ivNIqxdax4bcMXz4D0nSk2l5E1TkR5mG8EBWtmExSPbcEPJ8V7lyWWbA8=</base64_key>
            </ssh_key>
            <ssh_key>
                <type>ssh-rsa</type>
                <base64_key>AAAAB3NzaC1yc2EAAAADAQABAAABgQCpgqL1SHhPVBOTFlOm0pu+cYBbADzC2jL41sPMawYCJHDyHuq7t+htaVVh2fRgpAPmSEnLEC2d4BEIKMtPK3bfR8plJqVXlLt6Q8t4b1oUlnjb3VPA9P6iGcW7CV1FBkZQEVx8ckOfJ3F+kI5VsrRlEDgiecm/C1VPl0/9M2llW/mPUMaD65cM9nlZgM/hUeBrfxOEqM11gDYxEZm1aRSbZoY4dfdm3vzvpSQ6lrCrkjn3X2aSmaCLcOWJhfBWMovNDB8uiPuw54g3ioZ++qEQMlfxVsqXDGYhXCrsArOVuW/5RbReO79BvXqdssiYShfwo+GhQ0+aLWMIW/jgBkkqx/n7uKLzCMX7b2F+aebRYFh+/QXEj7SnihdVfr9ud6NN3MWzZ1ltfIczlEcFLrLJ1Yq57wW6wXtviWh59WvTWFiPejGjeSjjJyqqB49tKdFVFuBnIU5u/bch2DXVgiAEdQwUrIp1ACoYPq22HFFAYUJrL32y7RxX3PGzuAv3LOc=</base64_key>
            </ssh_key>
        </ssh_keys>

        <access_management>0|1</access_management>

        <networks incl="networks" replace="replace">
        </networks>

        <profile>profile_name</profile>

        <quota>default</quota>
        <default_database>default</default_database>
        <databases>
            <database_name>
                <table_name>
                    <filter>expression</filter>
                </table_name>
            </database_name>
        </databases>
        
        <grants>
            <query>GRANT SELECT ON system.*</query>
        </grants>
    </user_name>
    <!-- 他のユーザー設定 -->
</users>

user_name/password

パスワードはプレーンテキストまたはSHA256（16進数形式）で指定できます。

• プレーンテキストでパスワードを指定するには（推奨されません）、password 要素内に配置します。

  例えば、<password>qwerty</password> のようになります。パスワードは空にしても構いません。

• SHA256ハッシュを使用してパスワードを指定するには、password_sha256_hex 要素内に配置します。

  例えば、<password_sha256_hex>65e84be33532fb784c48129675f9eff3a682b27168c0ea744b2cf58ee02337c5</password_sha256_hex> のようになります。

  シェルからパスワードを生成する例:

  PASSWORD=$(base64 < /dev/urandom | head -c8); echo "$PASSWORD"; echo -n "$PASSWORD" | sha256sum | tr -d '-'
  

  結果の最初の行がパスワードで、2行目が対応するSHA256ハッシュです。

• MySQLクライアントとの互換性のために、パスワードをダブルSHA1ハッシュで指定できます。password_double_sha1_hex 要素内に配置します。

  例えば、<password_double_sha1_hex>08b4a0f1de6ad37da17359e592c8d74788a83eb0</password_double_sha1_hex> のようになります。

  シェルからパスワードを生成する例:

  PASSWORD=$(base64 < /dev/urandom | head -c8); echo "$PASSWORD"; echo -n "$PASSWORD" | sha1sum | tr -d '-' | xxd -r -p | sha1sum | tr -d '-'
  

  結果の最初の行がパスワードで、2行目が対応するダブルSHA1ハッシュです。

username/ssh-key

この設定はSSHキーでの認証を可能にします。

ssh-keygen で生成されたSSHキーが次のような形式である場合

ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDNf0r6vRl24Ix3tv2IgPmNPO2ATa2krvt80DdcTatLj [email protected]

ssh_key 要素は次のように期待されます。

<ssh_key>
     <type>ssh-ed25519</type>
     <base64_key>AAAAC3NzaC1lZDI1NTE5AAAAIDNf0r6vRl24Ix3tv2IgPmNPO2ATa2krvt80DdcTatLj</base64_key>
 </ssh_key>

他のサポートされているアルゴリズムには、ssh-rsa または ecdsa-sha2-nistp256 を使用します。

access_management

この設定は、ユーザーのSQL駆動型 アクセス制御とアカウント管理 の使用を有効または無効にします。

可能な値:

• 0 — 無効。
• 1 — 有効。

デフォルト値: 0。

grants

この設定により、選択されたユーザーに対して任意の権限を付与できます。 リストの各要素は、指定された受取人なしの GRANT クエリである必要があります。

例:

<user1>
    <grants>
        <query>GRANT SHOW ON *.*</query>
        <query>GRANT CREATE ON *.* WITH GRANT OPTION</query>
        <query>GRANT SELECT ON system.*</query>
    </grants>
</user1>

この設定は、dictionaries, access_management, named_collection_control, show_named_collections_secrets および allow_databases 設定と同時に指定することはできません。

user_name/networks

ユーザーがClickHouseサーバーに接続できるネットワークのリスト。

リストの各要素は次のいずれかの形式を持つことができます:

• <ip> — IPアドレスまたはネットワークマスク。

  例: 213.180.204.3, 10.0.0.1/8, 10.0.0.1/255.255.255.0, 2a02:6b8::3, 2a02:6b8::3/64, 2a02:6b8::3/ffff:ffff:ffff:ffff::.

• <host> — ホスト名。

  例: example01.host.ru。

  アクセスを確認するために、DNSクエリが実行され、返されたすべてのIPアドレスがピアアドレスと比較されます。

• <host_regexp> — ホスト名用の正規表現。

  例: ^example\d\d-\d\d-\d\.host\.ru$

  アクセスを確認するために、ピアアドレスに対して DNS PTRクエリ が実行され、その後指定された正規表現が適用されます。その後、PTRクエリの結果に対して別のDNSクエリが実行され、すべての取得されたアドレスがピアアドレスと比較されます。正規表現は $ で終わることを強く推奨します。

すべてのDNSリクエストの結果は、サーバーが再起動されるまでキャッシュされます。

例

任意のネットワークからのユーザーのアクセスを開放するには、次のように指定します:

<ip>::/0</ip>

注記

ファイアウォールが適切に構成されているか、サーバーが直接インターネットに接続されていない限り、任意のネットワークからアクセスを開放することは安全ではありません。

ローカルホストからのみアクセスを開放するには、次のように指定します:

<ip>::1</ip>
<ip>127.0.0.1</ip>

user_name/profile

ユーザーに設定プロファイルを割り当てることができます。設定プロファイルは users.xml ファイルの別のセクションで構成されます。詳細については、設定プロファイルを参照してください。

user_name/quota

クォータは、一定期間内のリソース使用を追跡または制限します。クォータは users.xml 構成ファイルの quotas セクションで構成されます。

ユーザーに対してクォータセットを割り当てることができます。クォータ設定の詳細については、クォータを参照してください。

user_name/databases

このセクションでは、現在のユーザーによって実行された SELECT クエリの結果としてClickHouseから返される行を制限し、基本的な行レベルのセキュリティを実装できます。

例

以下の構成は、ユーザー user1 が table1 の行を SELECT クエリの結果としてのみ見ることができるように強制します。ここで、id フィールドの値は1000です。

<user1>
    <databases>
        <database_name>
            <table1>
                <filter>id = 1000</filter>
            </table1>
        </database_name>
    </databases>
</user1>

filter は UInt8-型の値を生成する任意の式にすることができます。通常は比較と論理演算子を含みます。filter が 0 である database_name.table1 の行は、このユーザーには返されません。フィルタリングは PREWHERE 操作と互換性がなく、WHERE→PREWHERE の最適化を無効にします。

ロール

user.xml 構成ファイルの roles セクションを使用して、任意の事前定義されたロールを作成できます。

roles セクションの構造:

<roles>
    <test_role>
        <grants>
            <query>GRANT SHOW ON *.*</query>
            <query>REVOKE SHOW ON system.*</query>
            <query>GRANT CREATE ON *.* WITH GRANT OPTION</query>
        </grants>
    </test_role>
</roles>

これらのロールは、users セクションのユーザーにも付与することができます:

<users>
    <user_name>
        ...
        <grants>
            <query>GRANT test_role</query>
        </grants>
    </user_name>
<users>