メインコンテンツまでスキップ
メインコンテンツまでスキップ

HTTP

Not supported in ClickHouse Cloud
注記

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

HTTPサーバーは、ClickHouseユーザーを認証するために使用できます。HTTP認証は、users.xmlで定義されている既存のユーザーに対する外部認証機構としてのみ使用できます。また、ローカルアクセス制御パスでも定義できます。現在、GETメソッドを使用したBasic認証スキームがサポートされています。

HTTP認証サーバーの定義​

HTTP認証サーバーを定義するには、config.xmlにhttp_authentication_serversセクションを追加する必要があります。

例

<clickhouse>
    <!- ... -->
    <http_authentication_servers>
        <basic_auth_server>
          <uri>http://localhost:8000/auth</uri>
          <connection_timeout_ms>1000</connection_timeout_ms>
          <receive_timeout_ms>1000</receive_timeout_ms>
          <send_timeout_ms>1000</send_timeout_ms>
          <max_tries>3</max_tries>
          <retry_initial_backoff_ms>50</retry_initial_backoff_ms>
          <retry_max_backoff_ms>1000</retry_max_backoff_ms>
          <forward_headers>
            <name>Custom-Auth-Header-1</name>
            <name>Custom-Auth-Header-2</name>
          </forward_headers>

        </basic_auth_server>
    </http_authentication_servers>
</clickhouse>

注意点として、http_authentication_serversセクション内に異なる名前を使って複数のHTTPサーバーを定義することができます。

パラメーター

  • uri - 認証リクエストを行うためのURI

サーバーとの通信に使用されるソケットのタイムアウト（ミリ秒）：

  • connection_timeout_ms - デフォルト: 1000 ms。
  • receive_timeout_ms - デフォルト: 1000 ms。
  • send_timeout_ms - デフォルト: 1000 ms。

リトライパラメーター：

  • max_tries - 認証リクエストを行う最大試行回数。デフォルト: 3
  • retry_initial_backoff_ms - リトライ時の初期バックオフ間隔。デフォルト: 50 ms
  • retry_max_backoff_ms - 最大バックオフ間隔。デフォルト: 1000 ms

フォワードヘッダー：

この部分は、クライアントリクエストヘッダーから外部HTTP認証機構に転送されるヘッダーを定義します。

users.xmlでのHTTP認証の有効化​

ユーザーのHTTP認証を有効にするには、ユーザー定義のpasswordや同様のセクションの代わりにhttp_authenticationセクションを指定します。

パラメーター：

  • server - 前述のようにメインのconfig.xmlファイルに設定されたHTTP認証サーバーの名前。
  • scheme - HTTP認証スキーム。現時点ではBasicのみがサポートされています。デフォルト: Basic

例（users.xmlに入れる）：

<clickhouse>
    <!- ... -->
    <my_user>
        <!- ... -->
        <http_authentication>
            <server>basic_server</server>
            <scheme>basic</scheme>
        </http_authentication>
    </my_user>
</clickhouse>
注記

HTTP認証は、他のいかなる認証メカニズムと併用することはできません。http_authenticationと共にpasswordなどの他のセクションが存在すると、ClickHouseはシャットダウンします。

SQLを使用したHTTP認証の有効化​

ClickHouseでSQL駆動のアクセス制御とアカウント管理が有効になっている場合、HTTP認証によって識別されたユーザーはSQLステートメントを使用して作成することもできます。

CREATE USER my_user IDENTIFIED WITH HTTP SERVER 'basic_server' SCHEME 'Basic'

...または、Basicは明示的なスキーム定義なしでデフォルトとして使用されます。

CREATE USER my_user IDENTIFIED WITH HTTP SERVER 'basic_server'

セッション設定の渡し方​

HTTP認証サーバーからのレスポンスボディがJSON形式で、settingsサブオブジェクトを含む場合、ClickHouseはそのキー:バリューペアを文字列値として解析し、認証されたユーザーの現在のセッションのセッション設定として設定しようとします。解析に失敗した場合、サーバーからのレスポンスボディは無視されます。