ClickHouseをLDAPで認証およびロールマッピングに使用するための設定

Not supported in ClickHouse Cloud

注記

このページは ClickHouse Cloud には適用されません。ここで文書化されている機能は、ClickHouse Cloud サービスでは利用できません。詳細については、ClickHouse の Cloud Compatibility ガイドを参照してください。

ClickHouseは、LDAPを使用してClickHouseデータベースユーザーを認証するように構成できます。このガイドでは、公開されているディレクトリに対して認証を行うLDAPシステムとClickHouseを統合する簡単な例を提供します。

1. ClickHouseでのLDAP接続設定の構成

この公開LDAPサーバーへの接続をテストします：

$ ldapsearch -x -b dc=example,dc=com -H ldap://ldap.forumsys.com

応答は次のようになります：

# extended LDIF
#
# LDAPv3
# base <dc=example,dc=com> with scope subtree
# filter: (objectclass=*)
# requesting: ALL
#

# example.com
dn: dc=example,dc=com
objectClass: top
objectClass: dcObject
objectClass: organization
o: example.com
dc: example
...

config.xmlファイルを編集し、以下を追加してLDAPを構成します：

<ldap_servers>
    <test_ldap_server>
    <host>ldap.forumsys.com</host>
    <port>389</port>
    <bind_dn>uid={user_name},dc=example,dc=com</bind_dn>
    <enable_tls>no</enable_tls>
    <tls_require_cert>never</tls_require_cert>
    </test_ldap_server>
</ldap_servers>

注記

<test_ldap_server>タグは特定のLDAPサーバーを識別するための任意のラベルです。

上記で使用される基本設定は次の通りです：

パラメータ	説明	例
host	LDAPサーバーのホスト名またはIP	ldap.forumsys.com
port	LDAPサーバー用のディレクトリポート	389
bind_dn	ユーザーへのテンプレートパス	`uid={user_name},dc=example,dc=com`
enable_tls	安全なLDAPを使用するかどうか	no
tls_require_cert	接続のために証明書が必要かどうか	never

注記

この例では、公開サーバーが389を使用し安全なポートを使用していないため、デモ目的でTLSを無効にしています。

注記

LDAP設定の詳細については、LDAPドキュメントページを参照してください。

<user_directories>セクションに<ldap>セクションを追加してユーザーロールのマッピングを構成します。このセクションは、ユーザーが認証されたときにどのロールを取得するかを定義します。この基本的な例では、LDAPに対して認証を行ったユーザーはscientists_roleを取得し、これは後のステップでClickHouseで定義されます。このセクションは次のようになります：

<user_directories>
    <users_xml>
        <path>users.xml</path>
    </users_xml>
    <local_directory>
        <path>/var/lib/clickhouse/access/</path>
    </local_directory>
    <ldap>
          <server>test_ldap_server</server>
          <roles>
             <scientists_role />
          </roles>
          <role_mapping>
             <base_dn>dc=example,dc=com</base_dn>
             <search_filter>(&amp;(objectClass=groupOfUniqueNames)(uniqueMember={bind_dn}))</search_filter>
             <attribute>cn</attribute>
          </role_mapping>
    </ldap>
</user_directories>

上記で使用される基本設定は次の通りです：

パラメータ	説明	例
server	前のldap_serversセクションで定義されたラベル	test_ldap_server
roles	ClickHouseで定義されたユーザーがマッピングされるロールの名前	scientists_role
base_dn	ユーザーとグループの検索を開始する基本パス	dc=example,dc=com
search_filter	マッピングのために選択するグループを識別するLDAP検索フィルター	`(&(objectClass=groupOfUniqueNames)(uniqueMember={bind_dn}))`
attribute	返される属性名	cn

設定を適用するためにClickHouseサーバーを再起動します。

2. ClickHouseデータベースのロールと権限を構成する

注記

このセクションの手順は、ClickHouseでSQLアクセス制御とアカウント管理が有効になっていることを前提としています。有効にするには、SQLユーザーとロールガイドを参照してください。

config.xmlファイルのロールマッピングセクションで使用されたのと同じ名前のロールをClickHouseで作成します。
```
CREATE ROLE scientists_role;
```
ロールに必要な権限を付与します。次のステートメントは、LDAPを通じて認証できるユーザーに管理者権限を付与します：
```
GRANT ALL ON *.* TO scientists_role;
```

3. LDAP設定をテストする

ClickHouseクライアントを使用してログインします。
```
$ clickhouse-client --user einstein --password password
ClickHouse client version 22.2.2.1.
Connecting to localhost:9000 as user einstein.
Connected to ClickHouse server version 22.2.2 revision 54455.

chnode1 :)
```
注記
ステップ1でldapsearchコマンドを使用してディレクトリに利用可能なすべてのユーザーを表示し、すべてのユーザーのパスワードがpasswordであることを確認してください。

ユーザーがscientists_roleロールに正しくマッピングされており、管理者権限を持っているかテストします。

SHOW DATABASES

Query id: 93b785ff-1482-4eda-95b0-b2d68b2c5e0f

┌─name───────────────┐
│ INFORMATION_SCHEMA │
│ db1_mysql          │
│ db2                │
│ db3                │
│ db4_mysql          │
│ db5_merge          │
│ default            │
│ information_schema │
│ system             │
└────────────────────┘

9 rows in set. Elapsed: 0.004 sec.

要約

この記事では、ClickHouseをLDAPサーバーに対して認証し、ロールにマッピングする基本を示しました。また、ClickHouse内の個々のユーザーを構成するオプションもありますが、これらのユーザーが自動的なロールマッピングを構成せずにLDAPで認証されるようにすることも可能です。LDAPモジュールはActive Directoryへの接続にも使用できます。

1. ClickHouseでのLDAP接続設定の構成​

2. ClickHouseデータベースのロールと権限を構成する​

3. LDAP設定をテストする​

要約​

1. ClickHouseでのLDAP接続設定の構成

2. ClickHouseデータベースのロールと権限を構成する

3. LDAP設定をテストする

要約