HTTP

Not supported in ClickHouse Cloud

примечание

Эта страница не применяется к ClickHouse Cloud. Функция, описанная здесь, недоступна в сервисах ClickHouse Cloud. Смотрите руководство по Cloud Compatibility для получения дополнительной информации.

HTTP сервер может использоваться для аутентификации пользователей ClickHouse. HTTP аутентификация может использоваться только в качестве внешнего аутентификатора для существующих пользователей, которые определены в users.xml или в локальных путях управления доступом. В настоящее время поддерживается схема аутентификации Basic с использованием метода GET.

Определение HTTP сервера аутентификации

Для определения HTTP сервера аутентификации необходимо добавить секцию http_authentication_servers в config.xml.

Пример

Обратите внимание, что вы можете определить несколько HTTP серверов в секции http_authentication_servers, используя различные имена.

Параметры

• uri - URI для выполнения запроса аутентификации

Таймауты в миллисекундах на сокете, используемом для связи с сервером:

• connection_timeout_ms - По умолчанию: 1000 мс.
• receive_timeout_ms - По умолчанию: 1000 мс.
• send_timeout_ms - По умолчанию: 1000 мс.

Параметры повторной попытки:

• max_tries - Максимальное количество попыток для выполнения запроса аутентификации. По умолчанию: 3
• retry_initial_backoff_ms - Начальный интервал ожидания при повторной попытке. По умолчанию: 50 мс
• retry_max_backoff_ms - Максимальный интервал ожидания. По умолчанию: 1000 мс

Включение HTTP аутентификации в users.xml

Чтобы включить HTTP аутентификацию для пользователя, укажите секцию http_authentication вместо password или аналогичных секций в определении пользователя.

Параметры:

• server - Имя HTTP сервера аутентификации, настроенного в основном файле config.xml, как описано ранее.
• scheme - Схема HTTP аутентификации. В настоящее время поддерживается только Basic. По умолчанию: Basic

Пример (добавляется в users.xml):

примечание

Обратите внимание, что HTTP аутентификация не может использоваться вместе с любым другим механизмом аутентификации. Наличие любых других секций, таких как password, вместе с http_authentication, приведет к завершению работы ClickHouse.

Включение HTTP аутентификации с помощью SQL

Когда SQL-управляемый контроль доступа и управление учетными записями включен в ClickHouse, пользователи, идентифицированные через HTTP аутентификацию, также могут быть созданы с использованием SQL операторов.

...или, Basic по умолчанию без явного указания схемы

Передача настроек сессии

Если тело ответа от сервера HTTP аутентификации имеет формат JSON и содержит подобъект settings, ClickHouse попытается разобрать его пары ключ: значение как строковые значения и установить их как настройки сессии для текущей сессии авторизованного пользователя. Если разбор не удался, тело ответа с сервера будет проигнорировано.