Доступно в редакциях:  Open/CE, BE, SE, SE+, Ultimate/EE, Core, Certified Core/CSE Lite (1.73), Certified Pro/CSE Pro (1.73)

Входит в расширения: Биллинг

Стадия жизненного цикла модуля: General Availability

Модуль отвечает за единую систему аутентификации, интегрированную с Kubernetes и веб-интерфейсами, используемыми в других модулях, например, Grafana и Dashboard.

Основные возможности

Модуль предоставляет следующие возможности:

  • единый вход в веб-интерфейсы модулей Deckhouse Platform (DP) и в API Kubernetes через Dex;
  • вход через внешние провайдеры: GitHub, GitLab, Bitbucket Cloud, Atlassian Crowd, LDAP (с SSO по Kerberos), OIDC и SAML 2.0;
  • статические пользователи и группы с парольной политикой, блокировкой учётных записей и двухфакторной аутентификацией;
  • аутентификация для любого веб-приложения в кластере с помощью DexAuthenticator и OAuth2-клиенты для приложений с поддержкой OIDC (DexClient);
  • генерация kubeconfig в веб-интерфейсе Deckhouse для доступа через kubectl с OIDC-токенами;
  • базовая аутентификация в API Kubernetes через один провайдер Crowd, OIDC или LDAP.

Компоненты

Модуль состоит из следующих компонентов:

  • dex — федеративный OpenID Connect провайдер, поддерживающий работу со статическими пользователями и с возможностью подключения к различным внешним провайдерам аутентификации, например, SAML, GitLab, GitHub.
  • dex-authenticator (на основе oauth2-proxy) выполняет аутентификацию запросов к приложению, опубликованному через Ingress или через Gateway API модуля alb.

Управление статическими пользователями осуществляется с помощью ресурсов User и Group:

  • в объекте User хранится информация о пользователе, включая email и хеш пароля (пароль в открытом виде не сохраняется);
  • в объекте Group задаётся список пользователей, объединённых в группу для управления правами доступа.

Операции управления пользователями — создание и удаление пользователей, управление группами, сброс пароля, сброс 2FA, блокировка и разблокировка — можно выполнять с помощью группы команд d8 iam или объекта UserOperation. Объект UserOperation одноразовый и автоматически удаляется через retention.userOperations (по умолчанию 24 часа).

Поддерживаются следующие внешние провайдеры/протоколы аутентификации:

  • GitHub;
  • GitLab;
  • BitBucket Cloud;
  • Crowd;
  • LDAP;
  • OIDC;
  • SAML 2.0.

Одновременно можно подключить более одного внешнего провайдера аутентификации.

Возможности интеграции

OIDC-аутентификацию в kube-apiserver автоматически настраивает модуль control-plane-manager. Подробнее — в разделе «Настройка kube-apiserver».

При включении модуля веб-интерфейсы модулей DP выполняют аутентификацию пользователей через Dex вместо HTTP Basic Auth.

Базовая аутентификация в API Kubernetes

Базовая аутентификация в API Kubernetes доступна для провайдеров Crowd, OIDC и LDAP (параметр enableBasicAuth в секции crowd, oidc или ldap). Её можно включить только для одного провайдера в кластере. Для провайдеров Crowd и OIDC базовая аутентификация выполняется в обход ограничений идентичностей провайдера, поэтому включить её может только SuperAdmin.

К API Kubernetes можно подключаться и через другие поддерживаемые внешние провайдеры.

Интеграция с приложениями

Чтобы добавить аутентификацию в любое веб-приложение в кластере, создайте DexAuthenticator в неймспейсе приложения и добавьте аннотации аутентификации в его Ingress или HTTPRoute. DexAuthenticator позволяет ограничить группы и email пользователей, которым разрешён вход, и сети, из которых разрешена аутентификация.

Если приложение само поддерживает OIDC, вместо этого создайте DexClient в его неймспейсе. Модуль регистрирует OAuth2-клиент в Dex и создаёт в том же неймспейсе Secret dex-client-<NAME> с секретом клиента. DexClient позволяет ограничить группы и email пользователей, которым разрешён вход, и указать клиентов, токенам которых доверяет приложение (trustedPeers).

Генерация kubeconfig

После входа пользователь может сгенерировать kubeconfig для kubectl и других утилит Kubernetes в веб-интерфейсе Deckhouse. В kubeconfig используется OIDC-токен. Если провайдер аутентификации поддерживает продление сессий, kubeconfig также содержит refresh-токен, и сессия продлевается автоматически. Если при продлении провайдер сообщает, что пользователя больше нет или у него отозван доступ, Dex отклоняет refresh-токен с ошибкой invalid_grant, и пользователю нужно войти заново.

Параметр kubeconfigGenerator добавляет другие способы доступа к API-серверу, каждый со своим адресом и сертификатом CA, например для доступа через Bastion-хост или VPN.

Дополнительные возможности Dex

В модуле используется Dex с дополнительными возможностями:

  • группы статических пользователей (объект Group);
  • двухфакторная аутентификация (2FA) локальных пользователей и пользователей провайдеров LDAP и Crowd (параметр twoFactor);
  • парольная политика для статических пользователей: сложность, история паролей, ротация и блокировка после неудачных попыток входа (параметр passwordPolicy);
  • принудительная смена пароля при следующем входе после сброса пароля администратором;
  • блокировка после неудачных попыток входа для пользователей LDAP и Atlassian Crowd (параметр passwordPolicy.lockout.applyToConnectors);
  • ограничение частоты неудачных попыток входа с одного IP-адреса (параметр rateLimit);
  • блокировка и разблокировка пользователей любого провайдера с помощью объекта UserOperation, в том числе без парольной политики;
  • списки разрешённых пользователей и групп в DexClient и DexAuthenticator, которые Dex проверяет при входе и при каждом запросе с refresh-токеном;
  • ограничение идентичностей, которые может утверждать провайдер (параметр spec.allowedIdentities DexProvider);
  • вход по Kerberos (SPNEGO) через провайдер LDAP без формы ввода пароля, с проверкой билетов из заголовка Authorization: Negotiate по keytab сервиса;
  • refresh-токены для провайдера SAML;
  • собственный сертификат CA для провайдера GitLab (параметр gitlab.rootCAData).

Отказоустойчивый режим

В отказоустойчивом режиме (highAvailability) Dex и другие компоненты модуля запускаются в нескольких репликах, поэтому вход продолжает работать при отказе одного пода. DexAuthenticator использует ту же настройку, если в нём не задан собственный параметр spec.highAvailability.

Внешние компоненты

Список стороннего программного обеспечения, используемого в модуле user-authn (информация представлена на английском языке):

  • Dex 2.46.0

    License: Apache License 2.0

    A Federated OpenID Connect Provider with pluggable connectors.

  • OAuth2 Proxy 7.15.5

    License: MIT License

    A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others) to validate accounts by email, domain or group.