Deckhouse Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.

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

DexAuthenticator

Short names: dex-auth

Scope: Namespaced

  • v1
  • v2alpha1
  • v1alpha1

Аутентификация через Dex для веб-приложений в неймспейсе объекта.

Собственных подов у DexAuthenticator нет. В неймспейсе объекта модуль создаёт Service <NAME>-dex-authenticator, на который указывает аннотация auth-url приложения, и публикует путь https://<DOMAIN>/dex-authenticator через Ingress или HTTPRoute.

Условие Served в status.conditions показывает, обслуживает ли модуль объект.

Внимание. DexAuthenticator работает только по HTTPS. Ingress приложения должен иметь настроенный TLS.

Имя DexAuthenticator должно быть не длиннее 63 символов, начинаться со строчной латинской буквы и содержать только строчные латинские буквы, цифры и дефисы (RFC 1035).

Примеры:

apiVersion: deckhouse.io/v1
kind: DexAuthenticator
metadata:
  name: app-name
  namespace: app-namespace
spec:
  applicationDomain: app-name.kube.my-domain.com
  sendAuthorizationHeader: false
  applicationIngressCertificateSecretName: ingress-tls
  applicationIngressClassName: nginx
  keepUsersLoggedInFor: 720h
  allowedGroups:
  - everyone
  - admins
  allowedProviders:
  - local
  - corp-ldap
  whitelistSourceRanges:
  - 1.1.1.1/32
  - 192.168.0.0/24
  additionalApplications:
  - domain: additional-app-name.kube.my-domain.com
    ingressSecretName: ingress-tls
    ingressClassName: nginx
    signOutURL: "/logout"
    whitelistSourceRanges:
    - 2.2.2.2/32
apiVersion: deckhouse.io/v1
kind: DexAuthenticator
metadata:
  name: app-alb
  namespace: app-namespace
spec:
  applicationDomain: app.example.com
  gatewayAPI:
    applicationHTTPRouteListenerSetName: app-listeners
  • metadata
    объект
    • metadata.name
      строка

      Максимальная длина: 63

  • status
    объект

    Состояние объекта, которое записывает модуль.

    • status.conditions
      массив объектов

      Условия объекта.

      Условие Served показывает, обслуживает ли dex-authenticator модуля объект на всех доменах, указанных в объекте. Новый или изменённый объект начинает обслуживаться в течение нескольких минут. Если статус условия False, в reason указана одна из причин:

      • WaitingForInstance — объект ещё не обслуживается.
      • HostConflict — домен уже занят другим DexAuthenticator. Смените домен или Ingress-класс, если домен должен быть общим. На остальных доменах объект обслуживается.
      • InvalidRecord — объект нельзя обслужить в таком виде, причина указана в message.
      • ClientNotCreated — модуль не смог зарегистрировать приложение в Dex, причина указана в message.
      • ForeignObject — в неймспейсе есть Service, Ingress или HTTPRoute с именем, которое нужно модулю. Переименуйте или удалите его.
      • ObjectsNotWritten — API-сервер отказал в создании Service или маршрута объекта, например из-за политики допуска. Ответ API-сервера указан в message.
      • TableFull — достигнут предел числа обслуживаемых DexAuthenticator в кластере или в неймспейсе. Подробности указаны в message.
      • status.conditions.lastTransitionTime
        строка

        Время последнего изменения статуса.

      • status.conditions.message
        строка

        Подробности статуса.

      • status.conditions.observedGeneration
        целочисленный

        Поколение объекта, для которого установлено условие.

      • status.conditions.reason
        строка

        Причина статуса, например HostConflict.

      • status.conditions.status
        строка

        Обязательный параметр

        Статус условия.

        Допустимые значения: True, False, Unknown

      • status.conditions.type
        строка

        Обязательный параметр

        Тип условия, например Served.

  • spec
    объект

    Обязательный параметр

    • spec.additionalApplications
      массив объектов

      Список дополнительных приложений, для которых необходима аутентификация.

      • spec.additionalApplications.domain
        строка

        Обязательный параметр

        Домен приложения (для использования в Ingress-ресурсе), запросы на который будут перенаправлены в Dex для аутентификации.

        Внимание. Укажите DNS-имя, соответствующее требованиям RFC 1123 (subdomain), без HTTP-схемы. Использование IP-адресов не допускается.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

      • spec.additionalApplications.gatewayAPI
        объект

        Набор параметров для настройки создаваемого объекта HTTPRoute.

        Внимание. Используется только в кластерах с поддержкой Gateway API. Должен быть указан тот же объект ListenerSet, который используется для домена приложения.

        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetName
          строка

          Обязательный параметр

          Имя объекта ListenerSet из Gateway API, на который будет ссылаться создаваемый HTTPRoute.

          Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Максимальная длина: 253

          Пример:

          httpRouteListenerSetName: default-listener-set
          
        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetNamespace
          строка

          Имя неймспейса, в котором располагается объект ListenerSet из Gateway API, на который будет ссылаться создаваемый HTTPRoute.

          Если не указано, используется неймспейс объекта DexAuthenticator.

          Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Максимальная длина: 63

          Пример:

          httpRouteListenerSetNamespace: default
          
        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetSectionName
          строка

          Имя секции объекта ListenerSet из Gateway API, на которую будет ссылаться создаваемый HTTPRoute.

          Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Максимальная длина: 253

          Пример:

          httpRouteListenerSetSectionName: web-listener
          
      • spec.additionalApplications.ingressClassName
        строка

        Название Ingress-класса, которое будет использоваться в Ingress-ресурсе (должно совпадать с названием Ingress-класса для домена приложения).

        Обязательно, если не указан gatewayAPI. Если класс не указан, Ingress-ресурсы для приложения не создаются. Можно указать оба поля.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

      • spec.additionalApplications.ingressSecretName
        строка

        Имя секрета (Secret) с TLS-сертификатом для домена приложения, который используется в Ingress-ресурсе приложения. Секрет должен обязательно находиться в том же неймспейсе, что и DexAuthenticator.

        Шаблон: ^(|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)$

      • spec.additionalApplications.signOutURL
        строка

        URL приложения, запросы с которого перенаправляются на URL выхода dex-authenticator.

        Используется в приложении для направления запросов на “Выход” (завершение сеанса). Для указанного URL будет создан отдельный Ingress-ресурс, запросы на который будут перенаправляться в dex-authenticator.

        Значение не должно содержать переводы строк.

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 2048

      • spec.additionalApplications.whitelistSourceRanges
        массив строк

        Список адресов в формате CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.

        Пример:

        whitelistSourceRanges:
        - 192.168.42.0/24
        
        • Элемент массива
          строка

          Шаблон: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$

    • spec.allowedEmails
      массив строк

      Email’ы пользователей, которым разрешено проходить аутентификацию.

      Смена списка завершает сессии пользователей, которые больше не подходят, при следующем обновлении токена, в пределах idTokenTTL.

      По умолчанию разрешено всем пользователям.

      Значения не должны содержать переводы строк.

      По умолчанию: All emails are allowed.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 320

    • spec.allowedGroups
      массив строк

      Группы, пользователям которых разрешено проходить аутентификацию.

      Смена списка завершает сессии пользователей, которые больше не подходят, при следующем обновлении токена, в пределах idTokenTTL.

      По умолчанию разрешено всем группам.

      Значения не должны содержать переводы строк.

      По умолчанию: All groups are allowed.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 512

    • spec.allowedProviders
      массив строк

      Имена объектов DexProvider, через которые пользователи могут входить в приложение.

      Для пользователей встроенной базы паролей (User) укажите local.

      Провайдер вне списка не показывается на странице входа. Если в списке один провайдер, пользователи сразу направляются к нему. Смена списка завершает сессии пользователей, которые больше не подходят, при следующем обновлении токена, в пределах idTokenTTL.

      Имя, которому не соответствует ни один DexProvider, принимается с предупреждением. Войти через него никто не сможет, пока провайдер не появится.

      По умолчанию можно использовать всех провайдеров.

      По умолчанию: All providers are allowed.

      • Элемент массива
        строка

        Шаблон: ^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$

        Максимальная длина: 253

    • spec.applicationDomain
      строка

      Обязательный параметр

      Адрес приложения (домен DNS для Ingress-ресурса), для которого необходима аутентификация.

      Внимание. Укажите DNS-имя, соответствующее требованиям RFC 1123 (subdomain), без HTTP-схемы. Использование IP-адресов не допускается.

      Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

      Пример:

      applicationDomain: my-app.domain.com
      
    • spec.applicationIngressCertificateSecretName
      строка

      Имя секрета (Secret) с TLS-сертификатом для домена приложения, который используется в Ingress-ресурсе приложения. Секрет должен обязательно находиться в том же неймспейсе, что и DexAuthenticator.

      Шаблон: ^(|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)$

      Пример:

      applicationIngressCertificateSecretName: ingress-tls
      
    • spec.applicationIngressClassName
      строка

      Название Ingress-класса, которое будет использоваться в Ingress-ресурсе (должно совпадать с названием Ingress-класса для домена приложения).

      Обязательно, если не указан gatewayAPI. Если класс не указан, Ingress-ресурсы для приложения не создаются. Можно указать оба поля.

      Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

      Пример:

      applicationIngressClassName: nginx
      
    • spec.gatewayAPI
      объект

      Набор параметров для настройки создаваемого объекта HTTPRoute.

      Внимание. Используется только в кластерах с поддержкой Gateway API. Должен быть указан тот же объект ListenerSet, который используется для домена приложения.

      • spec.gatewayAPI.applicationHTTPRouteListenerSetName
        строка

        Обязательный параметр

        Имя объекта ListenerSet из Gateway API, на который будет ссылаться создаваемый HTTPRoute.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

        Максимальная длина: 253

        Пример:

        applicationHTTPRouteListenerSetName: default-listenerset
        
      • spec.gatewayAPI.applicationHTTPRouteListenerSetNamespace
        строка

        Имя неймспейса, в котором располагается объект ListenerSet из Gateway API, на который будет ссылаться создаваемый HTTPRoute.

        Если не указано, используется неймспейс объекта DexAuthenticator.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

        Максимальная длина: 63

        Пример:

        applicationHTTPRouteListenerSetNamespace: default
        
      • spec.gatewayAPI.applicationHTTPRouteListenerSetSectionName
        строка

        Имя секции объекта ListenerSet из Gateway API, на которую будет ссылаться создаваемый HTTPRoute.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

        Максимальная длина: 253

        Пример:

        applicationHTTPRouteListenerSetSectionName: default-listener
        
    • spec.highAvailability
      Параметр устарел
      булевый

      Игнорируется, оставлено для совместимости.

      По умолчанию: false

    • spec.keepUsersLoggedInFor
      строка

      Максимальное время бездействия пользователя, в течение которого его сессия остаётся активной.

      Задаётся в виде строки с целым числом часов, минут и секунд, указанных именно в таком порядке: 30m, 20s, 2h30m10s, 24h.

      Значение должно быть больше idTokenTTL, иначе сессия длится idTokenTTL + 1s. Чтобы пользователи выходили раньше, уменьшите idTokenTTL.

      По умолчанию: 168h

      Шаблон: ^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$

      Пример:

      keepUsersLoggedInFor: 24h
      
    • spec.nodeSelector
      Параметр устарел
      объект

      Игнорируется, оставлено для совместимости.

    • spec.podMetadata
      Параметр устарел
      объект

      Игнорируется, оставлено для совместимости.

      • spec.podMetadata.annotations
        объект
      • spec.podMetadata.labels
        объект
    • spec.resources
      Параметр устарел
      объект

      Игнорируется, оставлено для совместимости.

      • spec.resources.limits
        объект
      • spec.resources.redis
        объект
        • spec.resources.redis.limits
          объект
        • spec.resources.redis.requests
          объект
      • spec.resources.requests
        объект
    • spec.sendAuthorizationHeader
      булевый

      Флаг, который отвечает за отправку конечному приложению заголовка Authorization: Bearer.

      При его включении в заголовке передаётся подписанный Dex ID-токен (id_token), содержащий email пользователя, его имя и список групп.

      Внимание. Включайте, только если приложение может обрабатывать такой заголовок, и настройте маршрут приложения, как описано в разделе «Как передать приложению логин и группы пользователя».

    • spec.signOutURL
      строка

      URL приложения, запросы с которого перенаправляются на URL выхода dex-authenticator.

      Используется в приложении для направления запросов на «Выход» (завершение сеанса). Для указанного URL будет создан отдельный Ingress-ресурс, запросы на который будут перенаправляться в dex-authenticator.

      Значение не должно содержать переводы строк.

      Шаблон: ^[^\r\n]*$

      Максимальная длина: 2048

    • spec.tolerations
      Параметр устарел
      массив объектов

      Игнорируется, оставлено для совместимости.

      • spec.tolerations.effect
        строка

        Допустимые значения: NoSchedule, PreferNoSchedule, NoExecute

      • spec.tolerations.key
        строка
      • spec.tolerations.operator
        строка

        По умолчанию: Equal

        Допустимые значения: Exists, Equal

      • spec.tolerations.tolerationSeconds
        целочисленный
      • spec.tolerations.value
        строка
    • spec.whitelistSourceRanges
      массив строк

      Список адресов в формате CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.

      Пример:

      whitelistSourceRanges:
      - 192.168.42.0/24
      
      • Элемент массива
        строка

        Шаблон: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$

Аутентификация через Dex для веб-приложений в неймспейсе объекта.

Собственных подов у DexAuthenticator нет. В неймспейсе объекта модуль создаёт Service <NAME>-dex-authenticator, на который указывает аннотация auth-url приложения, и публикует путь https://<DOMAIN>/dex-authenticator через Ingress или HTTPRoute.

Условие Served в status.conditions показывает, обслуживает ли модуль объект.

Внимание. DexAuthenticator работает только по HTTPS. Ingress приложения должен иметь настроенный TLS.

Имя DexAuthenticator должно быть не длиннее 63 символов, начинаться со строчной латинской буквы и содержать только строчные латинские буквы, цифры и дефисы (RFC 1035).

  • metadata
    объект
    • metadata.name
      строка

      Максимальная длина: 63

  • status
    объект

    Состояние объекта, которое записывает модуль.

    • status.conditions
      массив объектов

      Условия объекта.

      Условие Served показывает, обслуживает ли dex-authenticator модуля объект на всех доменах, указанных в объекте. Новый или изменённый объект начинает обслуживаться в течение нескольких минут. Если статус условия False, в reason указана одна из причин:

      • WaitingForInstance — объект ещё не обслуживается.
      • HostConflict — домен уже занят другим DexAuthenticator. Смените домен или Ingress-класс, если домен должен быть общим. На остальных доменах объект обслуживается.
      • InvalidRecord — объект нельзя обслужить в таком виде, причина указана в message.
      • ClientNotCreated — модуль не смог зарегистрировать приложение в Dex, причина указана в message.
      • ForeignObject — в неймспейсе есть Service, Ingress или HTTPRoute с именем, которое нужно модулю. Переименуйте или удалите его.
      • ObjectsNotWritten — API-сервер отказал в создании Service или маршрута объекта, например из-за политики допуска. Ответ API-сервера указан в message.
      • TableFull — достигнут предел числа обслуживаемых DexAuthenticator в кластере или в неймспейсе. Подробности указаны в message.
      • status.conditions.lastTransitionTime
        строка

        Время последнего изменения статуса.

      • status.conditions.message
        строка

        Подробности статуса.

      • status.conditions.observedGeneration
        целочисленный

        Поколение объекта, для которого установлено условие.

      • status.conditions.reason
        строка

        Причина статуса, например HostConflict.

      • status.conditions.status
        строка

        Обязательный параметр

        Статус условия.

        Допустимые значения: True, False, Unknown

      • status.conditions.type
        строка

        Обязательный параметр

        Тип условия, например Served.

  • spec
    объект

    Обязательный параметр

    • spec.allowedEmails
      массив строк

      Email’ы пользователей, которым разрешено проходить аутентификацию.

      Смена списка завершает сессии пользователей, которые больше не подходят, при следующем обновлении токена, в пределах idTokenTTL.

      По умолчанию разрешено всем пользователям.

      Значения не должны содержать переводы строк.

      По умолчанию: All users are allowed.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 320

    • spec.allowedGroups
      массив строк

      Группы, пользователям которых разрешено проходить аутентификацию.

      Смена списка завершает сессии пользователей, которые больше не подходят, при следующем обновлении токена, в пределах idTokenTTL.

      По умолчанию разрешено всем группам.

      Значения не должны содержать переводы строк.

      По умолчанию: All groups are allowed.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 512

    • spec.allowedProviders
      массив строк

      Имена объектов DexProvider, через которые пользователи могут входить в приложение.

      Для пользователей встроенной базы паролей (User) укажите local.

      Провайдер вне списка не показывается на странице входа. Если в списке один провайдер, пользователи сразу направляются к нему. Смена списка завершает сессии пользователей, которые больше не подходят, при следующем обновлении токена, в пределах idTokenTTL.

      Имя, которому не соответствует ни один DexProvider, принимается с предупреждением. Войти через него никто не сможет, пока провайдер не появится.

      По умолчанию можно использовать всех провайдеров.

      По умолчанию: All providers are allowed.

      • Элемент массива
        строка

        Шаблон: ^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$

        Максимальная длина: 253

    • spec.applications
      массив объектов

      Обязательный параметр

      Список приложений, для которых необходима аутентификация.

      • spec.applications.domain
        строка

        Обязательный параметр

        Домен приложения (для использования в Ingress-ресурсе), запросы на который будут перенаправлены в Dex для аутентификации.

        Внимание. Укажите DNS-имя, соответствующее требованиям RFC 1123 (subdomain), без HTTP-схемы. Использование IP-адресов не допускается.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

      • spec.applications.gatewayAPI
        объект

        Набор параметров для настройки создаваемого объекта HTTPRoute.

        Внимание. Используется только в кластерах с поддержкой Gateway API. Должен быть указан тот же объект ListenerSet, который используется для домена приложения.

        • spec.applications.gatewayAPI.httpRouteListenerSetName
          строка

          Обязательный параметр

          Имя объекта ListenerSet из Gateway API, на который будет ссылаться создаваемый HTTPRoute.

          Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Максимальная длина: 253

          Пример:

          httpRouteListenerSetName: default-listener-set
          
        • spec.applications.gatewayAPI.httpRouteListenerSetNamespace
          строка

          Имя неймспейса, в котором располагается объект ListenerSet из Gateway API, на который будет ссылаться создаваемый HTTPRoute.

          Если не указано, используется неймспейс объекта DexAuthenticator.

          Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Максимальная длина: 63

          Пример:

          httpRouteListenerSetNamespace: default
          
        • spec.applications.gatewayAPI.httpRouteListenerSetSectionName
          строка

          Имя секции объекта ListenerSet из Gateway API, на которую будет ссылаться создаваемый HTTPRoute.

          Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Максимальная длина: 253

          Пример:

          httpRouteListenerSetSectionName: web-listener
          
      • spec.applications.ingressClassName
        строка

        Название Ingress-класса, которое будет использоваться в Ingress-ресурсе (должно совпадать с названием Ingress-класса для домена приложения).

        Обязательно, если не указан gatewayAPI. Если класс не указан, Ingress-ресурсы для приложения не создаются. Можно указать оба поля.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

      • spec.applications.ingressSecretName
        строка

        Имя секрета (Secret) с TLS-сертификатом для домена приложения, который используется в Ingress-ресурсе приложения. Секрет должен обязательно находиться в том же неймспейсе, что и DexAuthenticator.

        Шаблон: ^(|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)$

      • spec.applications.signOutURL
        строка

        URL приложения, запросы с которого перенаправляются на URL выхода dex-authenticator.

        Используется в приложении для направления запросов на «Выход» (завершение сеанса). Для указанного URL будет создан отдельный Ingress-ресурс, запросы на который будут перенаправляться в dex-authenticator.

        Значение не должно содержать переводы строк.

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 2048

      • spec.applications.whitelistSourceRanges
        массив строк

        Список адресов в формате CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.

        Пример:

        whitelistSourceRanges:
        - 192.168.42.0/24
        
        • Элемент массива
          строка

          Шаблон: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$

    • spec.highAvailability
      Параметр устарел
      булевый

      Игнорируется, оставлено для совместимости.

      По умолчанию: false

    • spec.keepUsersLoggedInFor
      строка

      Максимальное время бездействия пользователя, в течение которого его сессия остаётся активной.

      Задаётся в виде строки с целым числом часов, минут и секунд, указанных именно в таком порядке: 30m, 20s, 2h30m10s, 24h.

      Значение должно быть больше idTokenTTL, иначе сессия длится idTokenTTL + 1s. Чтобы пользователи выходили раньше, уменьшите idTokenTTL.

      По умолчанию: 168h

      Шаблон: ^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$

    • spec.nodeSelector
      Параметр устарел
      объект

      Игнорируется, оставлено для совместимости.

    • spec.podMetadata
      Параметр устарел
      объект

      Игнорируется, оставлено для совместимости.

      • spec.podMetadata.annotations
        объект
      • spec.podMetadata.labels
        объект
    • spec.resources
      Параметр устарел
      объект

      Игнорируется, оставлено для совместимости.

      • spec.resources.limits
        объект
      • spec.resources.redis
        объект
        • spec.resources.redis.limits
          объект
        • spec.resources.redis.requests
          объект
      • spec.resources.requests
        объект
    • spec.sendAuthorizationHeader
      булевый

      Флаг, который отвечает за отправку конечному приложению заголовка Authorization: Bearer.

      При его включении в заголовке передаётся подписанный Dex ID-токен (id_token), содержащий email пользователя, его имя и список групп.

      Внимание. Включайте, только если приложение может обрабатывать такой заголовок, и настройте маршрут приложения, как описано в разделе «Как передать приложению логин и группы пользователя».

    • spec.tolerations
      Параметр устарел
      массив объектов

      Игнорируется, оставлено для совместимости.

      • spec.tolerations.effect
        строка

        Допустимые значения: NoSchedule, PreferNoSchedule, NoExecute

      • spec.tolerations.key
        строка
      • spec.tolerations.operator
        строка

        По умолчанию: Equal

        Допустимые значения: Exists, Equal

      • spec.tolerations.tolerationSeconds
        целочисленный
      • spec.tolerations.value
        строка

Устаревший ресурс. Поддержка ресурса может быть исключена в следующих версиях.

Аутентификация через Dex для веб-приложений в неймспейсе объекта.

Собственных подов у DexAuthenticator нет. В неймспейсе объекта модуль создаёт Service <NAME>-dex-authenticator, на который указывает аннотация auth-url приложения, и публикует путь https://<DOMAIN>/dex-authenticator через Ingress или HTTPRoute.

Условие Served в status.conditions показывает, обслуживает ли модуль объект.

Внимание. DexAuthenticator работает только по HTTPS. Ingress приложения должен иметь настроенный TLS.

Имя DexAuthenticator должно быть не длиннее 63 символов, начинаться со строчной латинской буквы и содержать только строчные латинские буквы, цифры и дефисы (RFC 1035).

Примеры:

apiVersion: deckhouse.io/v1
kind: DexAuthenticator
metadata:
  name: app-name
  namespace: app-namespace
spec:
  applicationDomain: app-name.kube.my-domain.com
  sendAuthorizationHeader: false
  applicationIngressCertificateSecretName: ingress-tls
  applicationIngressClassName: nginx
  keepUsersLoggedInFor: 720h
  allowedGroups:
  - everyone
  - admins
  allowedProviders:
  - local
  - corp-ldap
  whitelistSourceRanges:
  - 1.1.1.1/32
  - 192.168.0.0/24
  additionalApplications:
  - domain: additional-app-name.kube.my-domain.com
    ingressSecretName: ingress-tls
    ingressClassName: nginx
    signOutURL: "/logout"
    whitelistSourceRanges:
    - 2.2.2.2/32
apiVersion: deckhouse.io/v1
kind: DexAuthenticator
metadata:
  name: app-alb
  namespace: app-namespace
spec:
  applicationDomain: app.example.com
  gatewayAPI:
    applicationHTTPRouteListenerSetName: app-listeners
  • metadata
    объект
    • metadata.name
      строка

      Максимальная длина: 63

  • status
    объект

    Состояние объекта, которое записывает модуль.

    • status.conditions
      массив объектов

      Условия объекта.

      Условие Served показывает, обслуживает ли dex-authenticator модуля объект на всех доменах, указанных в объекте. Новый или изменённый объект начинает обслуживаться в течение нескольких минут. Если статус условия False, в reason указана одна из причин:

      • WaitingForInstance — объект ещё не обслуживается.
      • HostConflict — домен уже занят другим DexAuthenticator. Смените домен или Ingress-класс, если домен должен быть общим. На остальных доменах объект обслуживается.
      • InvalidRecord — объект нельзя обслужить в таком виде, причина указана в message.
      • ClientNotCreated — модуль не смог зарегистрировать приложение в Dex, причина указана в message.
      • ForeignObject — в неймспейсе есть Service, Ingress или HTTPRoute с именем, которое нужно модулю. Переименуйте или удалите его.
      • ObjectsNotWritten — API-сервер отказал в создании Service или маршрута объекта, например из-за политики допуска. Ответ API-сервера указан в message.
      • TableFull — достигнут предел числа обслуживаемых DexAuthenticator в кластере или в неймспейсе. Подробности указаны в message.
      • status.conditions.lastTransitionTime
        строка

        Время последнего изменения статуса.

      • status.conditions.message
        строка

        Подробности статуса.

      • status.conditions.observedGeneration
        целочисленный

        Поколение объекта, для которого установлено условие.

      • status.conditions.reason
        строка

        Причина статуса, например HostConflict.

      • status.conditions.status
        строка

        Обязательный параметр

        Статус условия.

        Допустимые значения: True, False, Unknown

      • status.conditions.type
        строка

        Обязательный параметр

        Тип условия, например Served.

  • spec
    объект

    Обязательный параметр

    • spec.additionalApplications
      массив объектов

      Список дополнительных приложений, для которых необходима аутентификация.

      • spec.additionalApplications.domain
        строка

        Обязательный параметр

        Домен приложения (для использования в Ingress-ресурсе), запросы на который будут перенаправлены в Dex для аутентификации.

        Внимание. Укажите DNS-имя, соответствующее требованиям RFC 1123 (subdomain), без HTTP-схемы. Использование IP-адресов не допускается.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

      • spec.additionalApplications.gatewayAPI
        объект

        Набор параметров для настройки создаваемого объекта HTTPRoute.

        Внимание. Используется только в кластерах с поддержкой Gateway API. Должен быть указан тот же объект ListenerSet, который используется для домена приложения.

        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetName
          строка

          Обязательный параметр

          Имя объекта ListenerSet из Gateway API, на который будет ссылаться создаваемый HTTPRoute.

          Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Максимальная длина: 253

          Пример:

          httpRouteListenerSetName: default-listener-set
          
        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetNamespace
          строка

          Имя неймспейса, в котором располагается объект ListenerSet из Gateway API, на который будет ссылаться создаваемый HTTPRoute.

          Если не указано, используется неймспейс объекта DexAuthenticator.

          Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Максимальная длина: 63

          Пример:

          httpRouteListenerSetNamespace: default
          
        • spec.additionalApplications.gatewayAPI.httpRouteListenerSetSectionName
          строка

          Имя секции объекта ListenerSet из Gateway API, на которую будет ссылаться создаваемый HTTPRoute.

          Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

          Максимальная длина: 253

          Пример:

          httpRouteListenerSetSectionName: web-listener
          
      • spec.additionalApplications.ingressClassName
        строка

        Название Ingress-класса, которое будет использоваться в Ingress-ресурсе (должно совпадать с названием Ingress-класса для домена приложения).

        Обязательно, если не указан gatewayAPI. Если класс не указан, Ingress-ресурсы для приложения не создаются. Можно указать оба поля.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

      • spec.additionalApplications.ingressSecretName
        строка

        Имя секрета (Secret) с TLS-сертификатом для домена приложения, который используется в Ingress-ресурсе приложения. Секрет должен обязательно находиться в том же неймспейсе, что и DexAuthenticator.

        Шаблон: ^(|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)$

      • spec.additionalApplications.signOutURL
        строка

        URL приложения, запросы с которого перенаправляются на URL выхода dex-authenticator.

        Используется в приложении для направления запросов на “Выход” (завершение сеанса). Для указанного URL будет создан отдельный Ingress-ресурс, запросы на который будут перенаправляться в dex-authenticator.

        Значение не должно содержать переводы строк.

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 2048

      • spec.additionalApplications.whitelistSourceRanges
        массив строк

        Список адресов в формате CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.

        Пример:

        whitelistSourceRanges:
        - 192.168.42.0/24
        
        • Элемент массива
          строка

          Шаблон: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$

    • spec.allowedEmails
      массив строк

      Email’ы пользователей, которым разрешено проходить аутентификацию.

      Смена списка завершает сессии пользователей, которые больше не подходят, при следующем обновлении токена, в пределах idTokenTTL.

      По умолчанию разрешено всем пользователям.

      Значения не должны содержать переводы строк.

      По умолчанию: All emails are allowed.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 320

    • spec.allowedGroups
      массив строк

      Группы, пользователям которых разрешено проходить аутентификацию.

      Смена списка завершает сессии пользователей, которые больше не подходят, при следующем обновлении токена, в пределах idTokenTTL.

      По умолчанию разрешено всем группам.

      Значения не должны содержать переводы строк.

      По умолчанию: All groups are allowed.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 512

    • spec.allowedProviders
      массив строк

      Имена объектов DexProvider, через которые пользователи могут входить в приложение.

      Для пользователей встроенной базы паролей (User) укажите local.

      Провайдер вне списка не показывается на странице входа. Если в списке один провайдер, пользователи сразу направляются к нему. Смена списка завершает сессии пользователей, которые больше не подходят, при следующем обновлении токена, в пределах idTokenTTL.

      Имя, которому не соответствует ни один DexProvider, принимается с предупреждением. Войти через него никто не сможет, пока провайдер не появится.

      По умолчанию можно использовать всех провайдеров.

      По умолчанию: All providers are allowed.

      • Элемент массива
        строка

        Шаблон: ^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$

        Максимальная длина: 253

    • spec.applicationDomain
      строка

      Обязательный параметр

      Адрес приложения (домен DNS для Ingress-ресурса), для которого необходима аутентификация.

      Внимание. Укажите DNS-имя, соответствующее требованиям RFC 1123 (subdomain), без HTTP-схемы. Использование IP-адресов не допускается.

      Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

      Пример:

      applicationDomain: my-app.domain.com
      
    • spec.applicationIngressCertificateSecretName
      строка

      Имя секрета (Secret) с TLS-сертификатом для домена приложения, который используется в Ingress-ресурсе приложения. Секрет должен обязательно находиться в том же неймспейсе, что и DexAuthenticator.

      Шаблон: ^(|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)$

      Пример:

      applicationIngressCertificateSecretName: ingress-tls
      
    • spec.applicationIngressClassName
      строка

      Название Ingress-класса, которое будет использоваться в Ingress-ресурсе (должно совпадать с названием Ingress-класса для домена приложения).

      Обязательно, если не указан gatewayAPI. Если класс не указан, Ingress-ресурсы для приложения не создаются. Можно указать оба поля.

      Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

      Пример:

      applicationIngressClassName: nginx
      
    • spec.gatewayAPI
      объект

      Набор параметров для настройки создаваемого объекта HTTPRoute.

      Внимание. Используется только в кластерах с поддержкой Gateway API. Должен быть указан тот же объект ListenerSet, который используется для домена приложения.

      • spec.gatewayAPI.applicationHTTPRouteListenerSetName
        строка

        Обязательный параметр

        Имя объекта ListenerSet из Gateway API, на который будет ссылаться создаваемый HTTPRoute.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

        Максимальная длина: 253

        Пример:

        applicationHTTPRouteListenerSetName: default-listenerset
        
      • spec.gatewayAPI.applicationHTTPRouteListenerSetNamespace
        строка

        Имя неймспейса, в котором располагается объект ListenerSet из Gateway API, на который будет ссылаться создаваемый HTTPRoute.

        Если не указано, используется неймспейс объекта DexAuthenticator.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

        Максимальная длина: 63

        Пример:

        applicationHTTPRouteListenerSetNamespace: default
        
      • spec.gatewayAPI.applicationHTTPRouteListenerSetSectionName
        строка

        Имя секции объекта ListenerSet из Gateway API, на которую будет ссылаться создаваемый HTTPRoute.

        Шаблон: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

        Максимальная длина: 253

        Пример:

        applicationHTTPRouteListenerSetSectionName: default-listener
        
    • spec.highAvailability
      Параметр устарел
      булевый

      Игнорируется, оставлено для совместимости.

      По умолчанию: false

    • spec.keepUsersLoggedInFor
      строка

      Максимальное время бездействия пользователя, в течение которого его сессия остаётся активной.

      Задаётся в виде строки с целым числом часов, минут и секунд, указанных именно в таком порядке: 30m, 20s, 2h30m10s, 24h.

      Значение должно быть больше idTokenTTL, иначе сессия длится idTokenTTL + 1s. Чтобы пользователи выходили раньше, уменьшите idTokenTTL.

      По умолчанию: 168h

      Шаблон: ^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$

      Пример:

      keepUsersLoggedInFor: 24h
      
    • spec.nodeSelector
      Параметр устарел
      объект

      Игнорируется, оставлено для совместимости.

    • spec.podMetadata
      Параметр устарел
      объект

      Игнорируется, оставлено для совместимости.

      • spec.podMetadata.annotations
        объект
      • spec.podMetadata.labels
        объект
    • spec.resources
      Параметр устарел
      объект

      Игнорируется, оставлено для совместимости.

      • spec.resources.limits
        объект
      • spec.resources.redis
        объект
        • spec.resources.redis.limits
          объект
        • spec.resources.redis.requests
          объект
      • spec.resources.requests
        объект
    • spec.sendAuthorizationHeader
      булевый

      Флаг, который отвечает за отправку конечному приложению заголовка Authorization: Bearer.

      При его включении в заголовке передаётся подписанный Dex ID-токен (id_token), содержащий email пользователя, его имя и список групп.

      Внимание. Включайте, только если приложение может обрабатывать такой заголовок, и настройте маршрут приложения, как описано в разделе «Как передать приложению логин и группы пользователя».

    • spec.signOutURL
      строка

      URL приложения, запросы с которого перенаправляются на URL выхода dex-authenticator.

      Используется в приложении для направления запросов на «Выход» (завершение сеанса). Для указанного URL будет создан отдельный Ingress-ресурс, запросы на который будут перенаправляться в dex-authenticator.

      Значение не должно содержать переводы строк.

      Шаблон: ^[^\r\n]*$

      Максимальная длина: 2048

    • spec.tolerations
      Параметр устарел
      массив объектов

      Игнорируется, оставлено для совместимости.

      • spec.tolerations.effect
        строка

        Допустимые значения: NoSchedule, PreferNoSchedule, NoExecute

      • spec.tolerations.key
        строка
      • spec.tolerations.operator
        строка

        По умолчанию: Equal

        Допустимые значения: Exists, Equal

      • spec.tolerations.tolerationSeconds
        целочисленный
      • spec.tolerations.value
        строка
    • spec.whitelistSourceRanges
      массив строк

      Список адресов в формате CIDR, которым разрешено проходить аутентификацию. Если параметр не указан, аутентификацию разрешено проходить без ограничения по IP-адресу.

      Пример:

      whitelistSourceRanges:
      - 192.168.42.0/24
      
      • Элемент массива
        строка

        Шаблон: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}/[0-9]{1,2}$

DexClient

Scope: Namespaced

  • v1
  • v1alpha1

Позволяет приложениям, поддерживающим OIDC-аутентификацию, взаимодействовать с Dex.

После появления в кластере объекта DexClient:

  • в Dex будет зарегистрирован клиент с идентификатором (clientID) dex-client-<NAME>@<NAMESPACE>, где <NAME> и <NAMESPACE> — metadata.name и metadata.namespace объекта DexClient соответственно;
  • в соответствующем namespace будет создан Secret dex-client-<NAME> (где <NAME> — metadata.name объекта DexClient), содержащий пароль доступа к клиенту (clientSecret).

Пример использования…

  • spec
    объект

    Обязательный параметр

    • spec.allowedEmails
      массив строк

      Email’ы пользователей, которым разрешено проходить аутентификацию.

      Проверяется при входе и при каждом обновлении refresh-токена. Изменение списка запрещает дальнейшее обновление сессий, чей email больше не входит в список.

      По умолчанию разрешено всем пользователям.

      Значения не должны содержать переводы строк.

      По умолчанию: All users are allowed.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 320

    • spec.allowedGroups
      массив строк

      Группы, пользователям которых разрешено проходить аутентификацию.

      Проверяется при входе и при каждом обновлении refresh-токена. Изменение списка запрещает дальнейшее обновление сессий, чьи сохранённые группы больше с ним не пересекаются.

      По умолчанию разрешено всем группам.

      Значения не должны содержать переводы строк.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 512

    • spec.allowedProviders
      массив строк

      Имена объектов DexProvider, через которые пользователи могут входить в приложение.

      Для пользователей встроенной базы паролей (User) укажите local.

      Проверяется на странице входа, при входе и при каждом обновлении refresh-токена и обмене токенов. Провайдер вне списка не показывается на странице входа. Если в списке один провайдер, пользователи сразу направляются к нему. Удаление провайдера из списка прекращает обновление refresh-токенов, выданных через него.

      DexClient также может обменивать токены через любой TokenExchangeProvider, в spec.clients которого он указан, даже если этого провайдера нет в списке.

      Имя, которому не соответствует ни один DexProvider, принимается с предупреждением. Войти через него никто не сможет, пока провайдер не появится.

      По умолчанию можно использовать всех провайдеров.

      По умолчанию: All providers are allowed.

      • Элемент массива
        строка

        Шаблон: ^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$

        Максимальная длина: 253

    • spec.backchannelLogoutURI
      строка

      Адрес, на который Dex отправляет уведомление, когда заканчивается браузерная сессия, через которую пользователь вошёл в приложение (OpenID Connect Back-Channel Logout): пользователь выходит из сессии; провайдер пользователя отвечает, что пользователя больше нет или ему закрыт доступ; сессию завершает операция UserOperation или самообслуживание в веб-интерфейсе; пользователя удаляют. О сессии, завершённой вне Dex, Dex уведомляет в течение нескольких секунд.

      Работает только при включённых браузерных сессиях Dex. Dex отправляет уведомление один раз, без повторов: приложение не может полагаться на него, чтобы завершить свою сессию.

      Должен быть HTTPS-адресом, хост которого — имя с точкой: Dex отправляет уведомление изнутри кластера, поэтому IP-адреса, localhost, имена без точки или с точкой в конце и имена в зонах .svc и .cluster.local не принимаются. Короткое имя вида <СЕРВИС>.<НЕЙМСПЕЙС> не отличить от внешнего имени: указывайте полное внешнее имя приложения.

      Шаблон: ^https://[^\r\n]*$

      Максимальная длина: 2048

    • spec.postLogoutRedirectURIs
      массив строк

      Адреса, на которые Dex может вернуть браузер после выхода пользователя из Dex через приложение (post_logout_redirect_uri в OpenID Connect RP-Initiated Logout).

      Работает только при включённых браузерных сессиях Dex.

      Значения не должны содержать переводы строк.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 2048

    • spec.redirectURIs
      массив строк

      Список адресов, на которые допустимо редиректить Dex’у после успешного прохождения аутентификации.

      Значения не должны содержать переводы строк.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 2048

    • spec.refreshTokenLifetime
      строка

      Время жизни refresh-токенов приложения при включённых браузерных сессиях Dex.

      • Standalone — токены действуют до истечения срока, что бы ни происходило с сессией браузера. Приложение, запрашивающее офлайн-доступ, получает refresh-токен только после интерактивного входа.
      • Session — токены перестают действовать, когда пользователь выходит из сессии Dex, через которую они выданы. Такое приложение может впустить пользователя по сессии браузера.

      Без параметра токены работают как Standalone.

      Допустимые значения: Standalone, Session

    • spec.secretMetadata
      объект

      Лейблы и аннотации, которые добавляются в Secret dex-client-<NAME>.

      • spec.secretMetadata.annotations
        объект

        Аннотации Secret.

      • spec.secretMetadata.labels
        объект

        Лейблы Secret.

    • spec.trustedPeers
      массив строк

      ID клиентов, которым позволена cross-аутентификация.

      Доверенный клиент может запросить токен с аудиторией этого клиента через провайдера, который разрешён его собственным allowedProviders. allowedProviders этого клиента для такого токена не проверяется, как и allowedEmails и allowedGroups.

      Значения не должны содержать переводы строк.

      Подробнее…

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 256

Устаревший ресурс. Поддержка ресурса может быть исключена в следующих версиях.

Позволяет приложениям, поддерживающим OIDC-аутентификацию, взаимодействовать с Dex.

После появления в кластере объекта DexClient:

  • в Dex будет зарегистрирован клиент с идентификатором (clientID) dex-client-<NAME>@<NAMESPACE>, где <NAME> и <NAMESPACE> — metadata.name и metadata.namespace объекта DexClient соответственно;
  • в соответствующем namespace будет создан Secret dex-client-<NAME> (где <NAME> — metadata.name объекта DexClient), содержащий пароль доступа к клиенту (clientSecret).

Пример использования…

  • spec
    объект

    Обязательный параметр

    • spec.allowedEmails
      массив строк

      Email’ы пользователей, которым разрешено проходить аутентификацию.

      Проверяется при входе и при каждом обновлении refresh-токена. Изменение списка запрещает дальнейшее обновление сессий, чей email больше не входит в список.

      По умолчанию разрешено всем пользователям.

      Значения не должны содержать переводы строк.

      По умолчанию: All users are allowed.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 320

    • spec.allowedGroups
      массив строк

      Группы, пользователям которых разрешено проходить аутентификацию.

      Проверяется при входе и при каждом обновлении refresh-токена. Изменение списка запрещает дальнейшее обновление сессий, чьи сохранённые группы больше с ним не пересекаются.

      По умолчанию разрешено всем группам.

      Значения не должны содержать переводы строк.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 512

    • spec.allowedProviders
      массив строк

      Имена объектов DexProvider, через которые пользователи могут входить в приложение.

      Для пользователей встроенной базы паролей (User) укажите local.

      Проверяется на странице входа, при входе и при каждом обновлении refresh-токена и обмене токенов. Провайдер вне списка не показывается на странице входа. Если в списке один провайдер, пользователи сразу направляются к нему. Удаление провайдера из списка прекращает обновление refresh-токенов, выданных через него.

      DexClient также может обменивать токены через любой TokenExchangeProvider, в spec.clients которого он указан, даже если этого провайдера нет в списке.

      Имя, которому не соответствует ни один DexProvider, принимается с предупреждением. Войти через него никто не сможет, пока провайдер не появится.

      По умолчанию можно использовать всех провайдеров.

      По умолчанию: All providers are allowed.

      • Элемент массива
        строка

        Шаблон: ^[a-z0-9]([-a-z0-9.]*[a-z0-9])?$

        Максимальная длина: 253

    • spec.backchannelLogoutURI
      строка

      Адрес, на который Dex отправляет уведомление, когда заканчивается браузерная сессия, через которую пользователь вошёл в приложение (OpenID Connect Back-Channel Logout): пользователь выходит из сессии; провайдер пользователя отвечает, что пользователя больше нет или ему закрыт доступ; сессию завершает операция UserOperation или самообслуживание в веб-интерфейсе; пользователя удаляют. О сессии, завершённой вне Dex, Dex уведомляет в течение нескольких секунд.

      Работает только при включённых браузерных сессиях Dex. Dex отправляет уведомление один раз, без повторов: приложение не может полагаться на него, чтобы завершить свою сессию.

      Должен быть HTTPS-адресом, хост которого — имя с точкой: Dex отправляет уведомление изнутри кластера, поэтому IP-адреса, localhost, имена без точки или с точкой в конце и имена в зонах .svc и .cluster.local не принимаются. Короткое имя вида <СЕРВИС>.<НЕЙМСПЕЙС> не отличить от внешнего имени: указывайте полное внешнее имя приложения.

      Шаблон: ^https://[^\r\n]*$

      Максимальная длина: 2048

    • spec.postLogoutRedirectURIs
      массив строк

      Адреса, на которые Dex может вернуть браузер после выхода пользователя из Dex через приложение (post_logout_redirect_uri в OpenID Connect RP-Initiated Logout).

      Работает только при включённых браузерных сессиях Dex.

      Значения не должны содержать переводы строк.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 2048

    • spec.redirectURIs
      массив строк

      Список адресов, на которые допустимо редиректить Dex’у после успешного прохождения аутентификации.

      Значения не должны содержать переводы строк.

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 2048

    • spec.refreshTokenLifetime
      строка

      Время жизни refresh-токенов приложения при включённых браузерных сессиях Dex.

      • Standalone — токены действуют до истечения срока, что бы ни происходило с сессией браузера. Приложение, запрашивающее офлайн-доступ, получает refresh-токен только после интерактивного входа.
      • Session — токены перестают действовать, когда пользователь выходит из сессии Dex, через которую они выданы. Такое приложение может впустить пользователя по сессии браузера.

      Без параметра токены работают как Standalone.

      Допустимые значения: Standalone, Session

    • spec.secretMetadata
      объект

      Лейблы и аннотации, которые добавляются в Secret dex-client-<NAME>.

      • spec.secretMetadata.annotations
        объект

        Аннотации Secret.

      • spec.secretMetadata.labels
        объект

        Лейблы Secret.

    • spec.trustedPeers
      массив строк

      ID клиентов, которым позволена cross-аутентификация.

      Доверенный клиент может запросить токен с аудиторией этого клиента через провайдера, который разрешён его собственным allowedProviders. allowedProviders этого клиента для такого токена не проверяется, как и allowedEmails и allowedGroups.

      Значения не должны содержать переводы строк.

      Подробнее…

      • Элемент массива
        строка

        Шаблон: ^[^\r\n]*$

        Максимальная длина: 256

DexProviderCheck

Scope: Cluster
Version: v1

Описывает одноразовую проверку доступности DexProvider.

Проверка убеждается, что провайдер существует, включён, Dex доступен, а эндпоинт провайдера отвечает на сетевом уровне. Полный сценарий аутентификации пользователя не выполняется.

  • spec
    объект

    Обязательный параметр

    • spec.initiatorType
      строка

      Указывает, кем инициирована проверка. Возможные значения:

      • Admin — администратором;
      • System — автоматически системой.

      Допустимые значения: Admin, System

    • spec.providerName
      строка

      Обязательный параметр

      Имя ресурса DexProvider, который нужно проверить.

      Пример:

      providerName: my-oidc
      
  • status
    объект
    • status.checks
      массив объектов

      Детальные результаты отдельных шагов проверки.

      • status.checks.message
        строка

        Дополнительное сообщение по шагу проверки.

      • status.checks.name
        строка

        Обязательный параметр

        Название шага проверки.

      • status.checks.status
        строка

        Обязательный параметр

        Статус шага проверки. Возможные значения:

        • Succeeded — шаг успешно выполнен;
        • Failed — шаг завершился ошибкой;
        • Skipped — шаг неприменим и был пропущен;
        • Warning — шаг выполнен, но настройка требует внимания (например, отключена проверка TLS-сертификата или сертификат скоро истекает). Общую проверку это не проваливает.

        Допустимые значения: Succeeded, Failed, Skipped, Warning

    • status.completedAt
      строка

      Время завершения проверки.

    • status.message
      строка

      Дополнительное сообщение о результате проверки или причине ошибки.

    • status.observedDexProviderGeneration
      целочисленный

      Поколение DexProvider, на котором была выполнена проверка.

    • status.phase
      строка

      Текущий статус выполнения проверки. Возможные значения:

      • Pending — проверка принята в обработку и ожидает выполнения или выполняется;
      • Succeeded — проверка доступности успешно завершена;
      • Failed — проверка доступности завершилась ошибкой.

      Допустимые значения: Pending, Succeeded, Failed

DexProvider

Scope: Cluster

  • v1
  • v1alpha1

Описывает конфигурацию подключения стороннего провайдера.

С его помощью можно гибко настроить интеграцию каталога учетных записей с Kubernetes.

Пример использования…

Внимание. Запрещено использовать пользователей и группы с префиксом system:. Аутентификация таких пользователей или участников этих групп будет отклонена, а в логах kube-apiserver появится соответствующее предупреждение.

  • spec
    объект

    Обязательный параметр

    • spec.allowedIdentities
      объект

      Ограничивает идентичности, которые этот провайдер может утвердить, независимо от его типа.

      Dex отказывает во входе пользователю, чей email не входит в emails и emailDomains, если задан хотя бы один из списков, и сужает claim groups до пересечения со списком groups, если он задан (пустое пересечение — отказ во входе). Каждый список необязателен; отсутствующий или пустой список ничего не ограничивает.

      Dex проверяет ограничения также при каждом запросе с refresh-токеном и при базовой аутентификации через LDAP-провайдер. Refresh-токен вне ограничений отзывается, и пользователю нужно войти заново. Для провайдеров Crowd и OIDC basic-auth-proxy проверяет учётные данные напрямую у провайдера, поэтому при базовой аутентификации ограничения не действуют.

      Ограничения также определяют, кто может создать или изменить провайдер. Провайдер, способный утвердить email или группу, которым в кластере уже назначены роли, может записать только тот, кому разрешено назначать эти роли. Без ограничения по email провайдер может утвердить любой адрес, в том числе с SuperAdmin, поэтому его запись требует SuperAdmin. С ограничениями по обоим признакам учитываются только роли, выданные перечисленным идентичностям. Провайдер Crowd или OIDC с enableBasicAuth: true считается провайдером без ограничения по email, потому что базовая аутентификация выполняется в обход ограничений.

      • spec.allowedIdentities.emailDomains
        массив строк

        Домены email, которые провайдер может утвердить, без @.

        Сравнивается точно с частью адреса после последнего @; поддомены перечисляются явно.

        • Элемент массива
          строка
      • spec.allowedIdentities.emails
        массив строк

        Точные email-адреса, которые провайдер может утвердить.

        Сравнение без учёта регистра.

        • Элемент массива
          строка
      • spec.allowedIdentities.groups
        массив строк

        Имена групп, которые провайдер может утвердить, с groupPrefix перед ними, если он задан.

        Применяется поверх типоспецифичных фильтров групп (allowedGroups, groups, teams, orgs[].teams), если они есть.

        • Элемент массива
          строка

          Длина: 1..256

    • spec.bitbucketCloud
      объект

      Параметры провайдера Bitbucket Cloud (можно указывать, только если type: BitbucketCloud).

      • spec.bitbucketCloud.clientID
        строка

        Обязательный параметр

        ID приложения, созданного в Bitbucket Cloud (Key).

      • spec.bitbucketCloud.clientSecret
        строка

        Обязательный параметр

        Secret приложения, созданного в Bitbucket Cloud (Secret).

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

      • spec.bitbucketCloud.includeTeamGroups
        булевый

        Включает в список команд все группы команды, в которых состоит пользователь.

        Пример групп пользователя с включенной опцией:

        groups=["my_team", "my_team/administrators", "my_team/members"]
        

        По умолчанию: false

      • spec.bitbucketCloud.teams
        массив строк

        Список-фильтр команд, допустимых для приема из Bitbucket Cloud.

        Токен пользователя будет содержать пересечение множеств команд из Bitbucket Cloud и команд из этого списка. Если если множество окажется пустым, авторизация не будет считаться успешной.

        Токен будет содержать команды пользователя в claim groups, как и у других провайдеров.

    • spec.crowd
      объект

      Параметры провайдера Crowd (можно указывать, только если type: Crowd).

      • spec.crowd.baseURL
        строка

        Обязательный параметр

        Адрес Crowd.

        Пример:

        baseURL: https://crowd.example.com/crowd
        
      • spec.crowd.clientID
        строка

        Обязательный параметр

        ID приложения, созданного в Crowd (Application Name).

      • spec.crowd.clientSecret
        строка

        Обязательный параметр

        Пароль приложения, созданного в Crowd (Password).

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

      • spec.crowd.enableBasicAuth
        булевый

        Включает базовую аутентификацию в API-сервере Kubernetes по логину и паролю пользователя Crowd.

        Работает только при включённом параметре apiserver.publishAPI модуля control-plane-manager. Параметр enableBasicAuth может быть включён только в одном DexProvider кластера.

        Параметр нельзя включить, пока twoFactor.providerTypes содержит Crowd, потому что у базовой аутентификации нет страницы для второго фактора.

        Базовая аутентификация выполняется в обход spec.allowedIdentities. Поэтому создать провайдер с включённым параметром или включить параметр в существующем провайдере может только SuperAdmin.

        Успешная проверка кешируется вместе с группами пользователя на 2 минуты, неуспешная — на 10 секунд. Пользователь, у которого отозван доступ в провайдере, может обращаться к Kubernetes API до истечения кешированного результата.

      • spec.crowd.groups
        массив строк

        Список-фильтр групп, допустимых для приема из Crowd.

        Токен пользователя будет содержать пересечение множеств групп из Crowd и групп из этого списка. Если множество окажется пустым, авторизация не будет считаться успешной.

        Если параметр не указан, токен пользователя будет содержать все группы из Crowd.

      • spec.crowd.usernamePrompt
        строка

        Строка, которая будет отображаться возле поля для имени пользователя в форме ввода логина и пароля.

        По умолчанию: Crowd username

    • spec.displayName
      строка

      Обязательный параметр

      Имя провайдера, которое будет отображено на странице выбора провайдера для аутентификации.

      Если настроен всего один провайдер, страница выбора провайдера показываться не будет.

    • spec.enabled
      булевый

      Включает провайдер.

      Выключенный провайдер не отображается на странице входа, и войти через него нельзя. DexProvider и его настройки сохраняются.

      По умолчанию: true

    • spec.github
      объект

      Параметры провайдера GitHub (можно указывать, только если type: Github).

      • spec.github.clientID
        строка

        Обязательный параметр

        ID организации на GitHub.

      • spec.github.clientSecret
        строка

        Обязательный параметр

        Secret организации на GitHub.

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

      • spec.github.orgs
        массив объектов

        Массив названий организаций в GitHub.

        • spec.github.orgs.name
          строка

          Обязательный параметр

          Название организации.

        • spec.github.orgs.teams
          массив строк

          Список-фильтр команд, допустимых для приема из GitHub.

          Токен пользователя будет содержать пересечение множеств команд из GitHub и команд из этого списка. Если множество окажется пустым, авторизация не будет считаться успешной.

          Если параметр не указан, токен пользователя будет содержать все команды из GitHub.

      • spec.github.teamNameField
        строка

        Формат команд, которые будут получены из GitHub.

        Если в организации acme есть группа Site Reliability Engineers, в случае:

        • Name будет получена группа с именем ['acme:Site Reliability Engineers'];
        • Slug будет получена группа с именем ['acme:site-reliability-engineers'];
        • Both будут получены группы с именами ['acme:Site Reliability Engineers', 'acme:site-reliability-engineers'].

        По умолчанию: Name

        Допустимые значения: Name, Slug, Both

      • spec.github.useLoginAsID
        булевый

        Позволяет вместо использования внутреннего GitHub ID использовать имя пользователя.

    • spec.gitlab
      объект

      Параметры провайдера GitLab (можно указывать, только если type: Gitlab).

      • spec.gitlab.baseURL
        строка

        Адрес GitLab.

        Пример:

        baseURL: https://gitlab.example.com
        
      • spec.gitlab.clientID
        строка

        Обязательный параметр

        ID приложения, созданного в GitLab (Application ID).

      • spec.gitlab.clientSecret
        строка

        Обязательный параметр

        Secret приложения, созданного в GitLab (Secret).

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

      • spec.gitlab.groups
        массив строк

        Список-фильтр групп (пути групп — path, а не имена), допустимых для приема из GitLab.

        Токен пользователя будет содержать пересечение множеств групп из GitLab и групп из этого списка. Если множество окажется пустым, авторизация не будет считаться успешной.

        Если параметр не указан, токен пользователя будет содержать все группы из GitLab.

      • spec.gitlab.rootCAData
        строка

        Цепочка сертификатов в формате PEM для проверки подлинности провайдера.

        Пример:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.gitlab.useLoginAsID
        булевый

        Позволяет вместо использования внутреннего GitLab ID, использовать имя пользователя.

    • spec.groupPrefix
      строка

      Префикс, который Dex добавляет перед каждой группой, утверждаемой провайдером, независимо от типа провайдера.

      С префиксом группы этого провайдера называются <PREFIX><GROUP> в токенах и в правилах кластера, например corp-ldap:admins. Префикс отделяет их от групп другого провайдера, только когда свой префикс есть у каждого провайдера, который может сообщить такие имена.

      Префикс должен заканчиваться двоеточием, например corp-ldap:. Он должен отличаться от префикса любого другого DexProvider и от префиксов групп любого TokenExchangeProvider, и ни один из двух префиксов не должен начинаться с другого. Admission-вебхуки отклоняют такой префикс.

      Каждое имя в allowedIdentities.groups должно начинаться с префикса, иначе API отклоняет манифест, потому что Dex добавляет префикс до сравнения. Настройки групп в блоке типа провайдера (например, oidc.allowedGroups, gitlab.groups и ldap.groupSearch) принимают имена провайдера идентификации, без префикса.

      Префикс не может начинаться с system:, который зарезервирован за API-сервером Kubernetes, или с peering:, который зарезервирован для ServiceAccount неймспейса d8-peering. Его нельзя задать вместе с enableBasicAuth у провайдера OIDC или Crowd, потому что basic-auth-proxy проверяет учётные данные у такого провайдера напрямую и передаёт его группы как есть.

      Установка или смена префикса переименовывает группы провайдера, и правила, написанные для старых имён, перестают действовать на его пользователей. Перепишите правила до того, как задать префикс, как описано в разделе «Префикс для групп провайдера».

      По умолчанию префикса нет.

      Шаблон: ^[A-Za-z0-9][A-Za-z0-9._:/-]*:$

      Длина: 2..64

      Пример:

      groupPrefix: 'corp-ldap:'
      
    • spec.ldap
      объект

      Параметры провайдера LDAP.

      • spec.ldap.bindDN
        строка

        Путь до сервис-аккаунта приложения в LDAP.

        Пример:

        bindDN: uid=serviceaccount,cn=users,dc=example,dc=com
        
      • spec.ldap.bindPW
        строка

        Пароль сервисной учётной записи, заданной в bindDN.

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

        Пример:

        bindPW: password
        
      • spec.ldap.enableBasicAuth
        булевый

        Включает базовую аутентификацию в API-сервере Kubernetes по логину и паролю пользователя LDAP.

        Работает только при включённом параметре apiserver.publishAPI модуля control-plane-manager. Параметр enableBasicAuth может быть включён только в одном DexProvider кластера.

        Параметр нельзя включить, пока twoFactor.providerTypes содержит LDAP, потому что у базовой аутентификации нет страницы для второго фактора.

        Успешная проверка кешируется вместе с группами пользователя на 2 минуты, неуспешная — на 10 секунд. Пользователь, у которого отозван доступ в провайдере, может обращаться к Kubernetes API до истечения кешированного результата.

      • spec.ldap.groupSearch
        объект

        Настройки фильтра для поиска групп для указанного пользователя.

        Подробнее о процессе фильтрации…

        • spec.ldap.groupSearch.baseDN
          строка

          Обязательный параметр

          Откуда будет начат поиск групп

          Пример:

          baseDN: cn=users,dc=example,dc=com
          
        • spec.ldap.groupSearch.filter
          строка

          Фильтр для директории с группами.

          Пример:

          filter: "(objectClass=person)"
          
        • spec.ldap.groupSearch.nameAttr
          строка

          Обязательный параметр

          Имя атрибута, в котором хранится уникальное имя группы.

          Пример:

          nameAttr: name
          
        • spec.ldap.groupSearch.userMatchers
          массив объектов

          Обязательный параметр

          Список сопоставлений атрибута имени юзера с именем группы.

          • spec.ldap.groupSearch.userMatchers.groupAttr
            строка

            Обязательный параметр

            Имя атрибута, в котором хранятся имена пользователей, состоящих в группе.

            Пример:

            groupAttr: member
            
          • spec.ldap.groupSearch.userMatchers.recursionGroupAttr
            строка

            Имя атрибута группы, в котором хранятся DN её участников.

            Если параметр задан, Dex дополнительно ищет группы, в которые входят найденные группы, уровень за уровнем, и добавляет их к группам пользователя. Используйте его для вложенных групп. Обычно значение совпадает с groupAttr, например member.

            Dex делает ещё один поиск для каждой группы каждого уровня при каждом входе и каждом обновлении токенов, поэтому ограничьте baseDN и filter в groupSearch.

            Пример:

            recursionGroupAttr: member
            
          • spec.ldap.groupSearch.userMatchers.userAttr
            строка

            Обязательный параметр

            Имя атрибута, в котором хранится имя пользователя.

            Пример:

            userAttr: uid
            
      • spec.ldap.host
        строка

        Обязательный параметр

        Адрес и порт (опционально) LDAP-сервера.

        Пример:

        host: ldap.example.com:636
        
      • spec.ldap.insecureNoSSL
        булевый

        Подключаться к каталогу LDAP не по защищенному порту.

        Несовместимо с startTLS, insecureSkipVerify и rootCAData: если insecureNoSSL: true, TLS отключён и эти параметры не имеют эффекта.

        По умолчанию: false

      • spec.ldap.insecureSkipVerify
        булевый

        Не производить проверку подлинности провайдера с помощью TLS. Небезопасно, не рекомендуется использовать в production-окружениях.

        Не используется при insecureNoSSL: true.

        По умолчанию: false

      • spec.ldap.kerberos
        объект

        Опциональные настройки Kerberos (SPNEGO) SSO для LDAP.

        • spec.ldap.kerberos.enabled
          булевый

          Включить поток аутентификации Kerberos SPNEGO для данного LDAP‑провайдера.

          По умолчанию: false

        • spec.ldap.kerberos.expectedRealm
          строка

          Необязательный требуемый realm (без учета регистра). Если указан и не совпадает с realm билета — вход отклоняется.

        • spec.ldap.kerberos.fallbackToPassword
          булевый

          Если true, при отсутствии/некорректном заголовке Authorization: Negotiate будет показана форма ввода логина/пароля вместо ответа 401 с WWW-Authenticate: Negotiate.

          По умолчанию: false

        • spec.ldap.kerberos.keytabSecretName
          строка

          Имя секрета в неймспейсе d8-user-authn, содержащего ключ krb5.keytab, который монтируется в под Dex.

          Обязательно, если enabled равен true.

        • spec.ldap.kerberos.krb5ConfConfigMapName
          строка

          Не используется. Dex проверяет билеты Kerberos только по keytab, и модуль не монтирует этот ConfigMap.

        • spec.ldap.kerberos.krb5ConfSecretName
          строка

          Не используется. Dex проверяет билеты Kerberos только по keytab, и модуль не монтирует этот секрет.

        • spec.ldap.kerberos.usernameFromPrincipal
          строка

          Способ сопоставления Kerberos principal с именем пользователя в LDAP: Localpart, SAMAccountName или UserPrincipalName.

          По умолчанию: Localpart

          Допустимые значения: Localpart, SAMAccountName, UserPrincipalName

      • spec.ldap.rootCAData
        строка

        Цепочка CA в формате PEM, используемая для валидации TLS.

        Не используется при insecureNoSSL: true.

        Пример:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.ldap.startTLS
        булевый

        Использовать STARTTLS для шифрования.

        Несовместимо с insecureNoSSL.

        По умолчанию: false

      • spec.ldap.userSearch
        объект

        Обязательный параметр

        Настройки фильтров пользователей, которые помогают сначала отфильтровать директории, в которых будет производиться поиск пользователей, а затем найти пользователя по полям (его имени, адресу электронной почты или отображаемому имени).

        Подробнее о процессе фильтрации…

        • spec.ldap.userSearch.baseDN
          строка

          Обязательный параметр

          Откуда будет начат поиск пользователей.

          Пример:

          baseDN: cn=users,dc=example,dc=com
          
        • spec.ldap.userSearch.emailAttr
          строка

          Обязательный параметр

          Имя атрибута, из которого будет получен email пользователя.

          Пример:

          emailAttr: mail
          
        • spec.ldap.userSearch.filter
          строка

          Позволяет добавить фильтр для директории с пользователями.

          Пример:

          filter: "(objectClass=person)"
          
        • spec.ldap.userSearch.idAttr
          строка

          Обязательный параметр

          Имя атрибута, из которого будет получен ID пользователя.

          Поддерживаются двоичные атрибуты GUID в Active Directory, objectGUID и mS-DS-ConsistencyGuid: ID пользователя в этом случае будет GUID в строковом виде, например 7ed41c2b-e283-4b10-9cb8-a6e7d1f39a4c.

          Пример:

          idAttr: uid
          
        • spec.ldap.userSearch.nameAttr
          строка

          Атрибут отображаемого имени пользователя.

          Пример:

          nameAttr: name
          
        • spec.ldap.userSearch.username
          строка

          Имя атрибута, из которого будет получен username пользователя.

          Пример:

          username: uid
          
        • spec.ldap.userSearch.usernames
          массив строк

          Атрибуты, с которыми сравнивается введённое имя пользователя, вместо username.

          Фильтр поиска имеет вид (|(<ATTR_1>=<USERNAME>)(<ATTR_2>=<USERNAME>)), поэтому пользователь может входить, например, по логину или по email. Если имени соответствует больше одной записи, вход отклоняется.

          Principal Kerberos, сопоставленный с именем пользователя (после usernameFromPrincipal), так же сравнивается со всеми атрибутами списка. Перечисляйте только атрибуты с уникальными в каталоге значениями, согласованные с usernameFromPrincipal. Если значение другой записи совпадёт с principal, у этого пользователя перестанет работать SSO. Principal, не совпавший ни с одним атрибутом своей записи, будет сопоставлен с записью другого пользователя.

          Укажите либо username, либо usernames.

          Пример:

          usernames:
          - uid
          - mail
          
          • Элемент массива
            строка

            Шаблон: ^[^\r\n]*$

            Длина: 1..256

      • spec.ldap.usernamePrompt
        строка

        Строка, которая будет отображаться возле поля для имени пользователя в форме ввода логина и пароля.

        По умолчанию: LDAP username

        Пример:

        usernamePrompt: SSO Username
        
    • spec.oidc
      объект

      Параметры провайдера OIDC (можно указывать, только если type: OIDC).

      • spec.oidc.allowedGroups
        массив строк

        Список групп, которые должны быть у пользователя для успешной аутентификации.

        Если список содержит группу, которой у пользователя нет, аутентификация будет отклонена.

        Если параметр не задан, проверка принадлежности к группам не выполняется.

      • spec.oidc.basicAuthUnsupported
        булевый

        Использовать POST-запросы для общения с провайдером вместо добавления токена в Basic Authorization header.

        В большинстве случаев Dex сам определяет, какой запрос ему нужно сделать, но иногда включение этого параметра может помочь.

        По умолчанию: false

      • spec.oidc.claimMapping
        объект

        Некоторые провайдеры возвращают нестандартные claim’ы (например, mail). Claim mappings помогают Dex преобразовать их в стандартные claim’ы OIDC.

        Dex может преобразовать нестандартный claim в стандартный, только если id_token, полученный от OIDC-провайдера, не содержит аналогичный стандартный claim.

        • spec.oidc.claimMapping.email
          строка

          Claim, который будет использован для получения email пользователя.

          По умолчанию: email

        • spec.oidc.claimMapping.groups
          строка

          Claim, который будет использован для получения групп пользователя.

          По умолчанию: groups

        • spec.oidc.claimMapping.preferred_username
          строка

          Claim, который будет использован для получения предпочтительного имени пользователя.

          По умолчанию: preferred_username

      • spec.oidc.claimMappingOverride
        булевый

        Если включено, сопоставление claim’ов (claimMapping) будет переопределять стандартные claim’ы OIDC.

        По умолчанию сопоставление claim’ов будет использоваться только в том случае, если стандартные claim’ы OIDC отсутствуют, например, если в id_token нет claim’а email, будет использоваться claimMapping.email.

        По умолчанию: false

      • spec.oidc.clientID
        строка

        Обязательный параметр

        ID приложения, созданного в OIDC-провайдере.

      • spec.oidc.clientSecret
        строка

        Обязательный параметр

        Пароль приложения, созданного в OIDC-провайдере.

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

      • spec.oidc.enableBasicAuth
        булевый

        Включает базовую аутентификацию в API-сервере Kubernetes по логину и паролю пользователя OIDC-провайдера.

        Работает только при включённом параметре apiserver.publishAPI модуля control-plane-manager. Параметр enableBasicAuth может быть включён только в одном DexProvider кластера.

        Базовая аутентификация выполняется в обход spec.allowedIdentities. Поэтому создать провайдер с включённым параметром или включить параметр в существующем провайдере может только SuperAdmin.

        Успешная проверка кешируется вместе с группами пользователя на 2 минуты, неуспешная — на 10 секунд. Пользователь, у которого отозван доступ в провайдере, может обращаться к Kubernetes API до истечения кешированного результата.

      • spec.oidc.getUserInfo
        булевый

        Запрашивать дополнительные данные об успешно подключенном пользователе.

        Подробнее…

        По умолчанию: false

      • spec.oidc.insecureSkipEmailVerified
        булевый

        Игнорировать информацию о статусе подтверждения email пользователя.

        Как именно подтверждается email, решает сам провайдер. В ответе от провайдера приходит лишь информация — подтвержден email или нет.

        По умолчанию: false

      • spec.oidc.insecureSkipVerify
        булевый

        Не производить проверку подлинности провайдера с помощью TLS. Небезопасно, не рекомендуется использовать в production-окружениях.

        По умолчанию: false

      • spec.oidc.issuer
        строка

        Обязательный параметр

        Адрес OIDC-провайдера.

        Пример:

        issuer: https://accounts.google.com
        
      • spec.oidc.promptType
        строка

        Определяет — должен ли Issuer запрашивать подтверждение и давать подсказки при аутентификации.

        По умолчанию будет запрошено подтверждение при первой аутентификации. Допустимые значения могут изменяться в зависимости от Issuer.

        По умолчанию: consent

      • spec.oidc.rootCAData
        строка

        Цепочка CA в формате PEM, используемая для валидации TLS.

        Пример:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.oidc.scopes
        массив строк

        Список полей для включения в ответ при запросе токена.

        Scope — это одиночный токен, он не может содержать пробельные символы: протокол OAuth2 передаёт scope’ы списком, разделённым пробелами.

        По умолчанию: ["openid","profile","email","groups","offline_access"]

        • Элемент массива
          строка

          Шаблон: ^\S+$

      • spec.oidc.upstreamLogout
        булевый

        Завершает сессию пользователя и у провайдера, когда пользователь выходит из Dex.

        Работает только при включённых браузерных сессиях Dex и только если провайдер публикует end_session_endpoint.

        По умолчанию выход из Dex не затрагивает сессию у провайдера: выход из одного приложения не завершает сессии пользователя в других приложениях. В этом случае провайдер может снова аутентифицировать пользователя без пароля. Чтобы пароль запрашивался при каждом входе, задайте promptType: login.

        По умолчанию: false

      • spec.oidc.userIDKey
        строка

        Claim, который будет использован для получения ID пользователя.

        По умолчанию: sub

      • spec.oidc.userNameKey
        строка

        Claim, который будет использован для получения имени пользователя.

        По умолчанию: name

    • spec.saml
      объект

      Параметры провайдера SAML (можно указывать, только если type: SAML).

      • spec.saml.allowedGroups
        массив строк

        Если задано, вход будет разрешён только членам хотя бы одной из перечисленных групп.

      • spec.saml.emailAttr
        строка

        SAML-атрибут для маппинга в claim email.

        По умолчанию: email

      • spec.saml.entityIssuer
        строка

        Значение Issuer, которое Dex передаёт в SAML AuthnRequest (идентификатор Dex как сервис-провайдера). Это же значение Dex ожидает в элементе Audience SAML-утверждения.

        Если не задано, Issuer в запрос не добавляется, а в элементе Audience Dex ожидает URL callback.

      • spec.saml.filterGroups
        булевый

        Если true, коннектор будет фильтровать claim groups, оставляя только группы из списка allowedGroups.

        По умолчанию: false

      • spec.saml.groupsAttr
        строка

        SAML-атрибут для маппинга в claim groups.

      • spec.saml.groupsDelim
        строка

        Разделитель для разбиения значения атрибута groups, если оно является одной строкой.

      • spec.saml.insecureSkipSignatureValidation
        булевый

        Пропустить проверку подписи SAML-ответов. Небезопасно, использовать только для тестирования.

        По умолчанию: false

      • spec.saml.nameIDPolicyFormat
        строка

        Формат NameIDPolicy для запроса к IdP.

        Если параметр не задан, Dex запрашивает persistent.

        UserOperation Lock со spec.target действует на идентификатор пользователя, который Dex берёт из NameID. Чтобы такая блокировка работала, используйте persistent или emailAddress. При значении transient IdP возвращает новый NameID при каждом входе, и блокировка не действует при следующем входе пользователя.

        Допустимые значения: persistent, emailAddress, unspecified, X509SubjectName, WindowsDomainQualifiedName, transient

      • spec.saml.redirectURI
        строка

        URI обратного вызова.

        Переопределяет URL callback по умолчанию. Должен быть установлен в https://<dex-domain>/callback.

      • spec.saml.rootCAData
        строка

        Цепочка CA в формате PEM, используемая для валидации TLS.

        Пример:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.saml.ssoIssuer
        строка

        Значение Issuer, ожидаемое в SAML-ответе от IdP.

        Если не задано, Issuer ответа не проверяется.

      • spec.saml.ssoURL
        строка

        Обязательный параметр

        URL для отправки SAML AuthnRequest (SSO URL провайдера).

        Пример:

        ssoURL: https://idp.example.com/saml/sso
        
      • spec.saml.usernameAttr
        строка

        SAML-атрибут для маппинга в claim username.

        По умолчанию: name

    • spec.tokenExchange
      объект

      Настройки обмена токенов (RFC 8693) через провайдер. Dex обменивает ID-токен издателя провайдера на свой токен. Обменивать токены могут только провайдеры OIDC и Gitlab.

      Коннектор провайдера не проверяет аудиторию обмениваемого токена, поэтому токен кластера могло бы получить любое приложение издателя. Обменивайте токены через TokenExchangeProvider. Поле временное и будет удалено после следующего LTS-релиза вместе с обменом токенов через DexProvider.

      • spec.tokenExchange.enabled
        булевый

        Обменивает ли провайдер токены. Отсутствие поля означает false.

        Обмен можно только выключить. Администратор не может установить true ни при создании провайдера, ни при его изменении. При обновлении с релиза, в котором этого поля нет, user-authn один раз выставляет его всем существующим провайдерам OIDC и Gitlab. Если есть хотя бы один DexClient с аннотацией dexclient.deckhouse.io/allow-access-to-kubernetes: "true", всем выставляется true, иначе всем выставляется false. DexAuthenticator с доступом к Kubernetes не учитывается. Его oauth2-proxy токены не обменивает, а обмен с его client secret, взятым из Secret в неймспейсе приложения, не сохраняется.

    • spec.type
      строка

      Обязательный параметр

      Тип внешнего провайдера.

      Допустимые значения: Github, Gitlab, BitbucketCloud, Crowd, OIDC, LDAP, SAML

Устаревший ресурс. Поддержка ресурса может быть исключена в следующих версиях.

Описывает конфигурацию подключения стороннего провайдера.

С его помощью можно гибко настроить интеграцию каталога учетных записей с Kubernetes.

Пример использования…

  • spec
    объект

    Обязательный параметр

    • spec.allowedIdentities
      объект

      Ограничивает идентичности, которые этот провайдер может утвердить, независимо от его типа.

      Dex отказывает во входе пользователю, чей email не входит в emails и emailDomains, если задан хотя бы один из списков, и сужает claim groups до пересечения со списком groups, если он задан (пустое пересечение — отказ во входе). Каждый список необязателен; отсутствующий или пустой список ничего не ограничивает.

      Dex проверяет ограничения также при каждом запросе с refresh-токеном и при базовой аутентификации через LDAP-провайдер. Refresh-токен вне ограничений отзывается, и пользователю нужно войти заново. Для провайдеров Crowd и OIDC basic-auth-proxy проверяет учётные данные напрямую у провайдера, поэтому при базовой аутентификации ограничения не действуют.

      Ограничения также определяют, кто может создать или изменить провайдер. Провайдер, способный утвердить email или группу, которым в кластере уже назначены роли, может записать только тот, кому разрешено назначать эти роли. Без ограничения по email провайдер может утвердить любой адрес, в том числе с SuperAdmin, поэтому его запись требует SuperAdmin. С ограничениями по обоим признакам учитываются только роли, выданные перечисленным идентичностям. Провайдер Crowd или OIDC с enableBasicAuth: true считается провайдером без ограничения по email, потому что базовая аутентификация выполняется в обход ограничений.

      • spec.allowedIdentities.emailDomains
        массив строк

        Домены email, которые провайдер может утвердить, без @.

        Сравнивается точно с частью адреса после последнего @; поддомены перечисляются явно.

        • Элемент массива
          строка
      • spec.allowedIdentities.emails
        массив строк

        Точные email-адреса, которые провайдер может утвердить.

        Сравнение без учёта регистра.

        • Элемент массива
          строка
      • spec.allowedIdentities.groups
        массив строк

        Имена групп, которые провайдер может утвердить, с groupPrefix перед ними, если он задан.

        Применяется поверх типоспецифичных фильтров групп (allowedGroups, groups, teams, orgs[].teams), если они есть.

        • Элемент массива
          строка

          Длина: 1..256

    • spec.bitbucketCloud
      объект

      Параметры провайдера Bitbucket Cloud (можно указывать, только если type: BitbucketCloud).

      • spec.bitbucketCloud.clientID
        строка

        Обязательный параметр

        ID приложения, созданного в Bitbucket Cloud (Key).

      • spec.bitbucketCloud.clientSecret
        строка

        Обязательный параметр

        Secret приложения, созданного в Bitbucket Cloud (Secret).

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

      • spec.bitbucketCloud.includeTeamGroups
        булевый

        Включает в список команд все группы команды, в которых состоит пользователь.

        Пример групп пользователя с включенной опцией:

        groups=["my_team", "my_team/administrators", "my_team/members"]
        

        По умолчанию: false

      • spec.bitbucketCloud.teams
        массив строк

        Список-фильтр команд, допустимых для приема из Bitbucket Cloud.

        Токен пользователя будет содержать пересечение множеств команд из Bitbucket Cloud и команд из этого списка. Если если множество окажется пустым, авторизация не будет считаться успешной.

        Токен будет содержать команды пользователя в claim groups, как и у других провайдеров.

    • spec.crowd
      объект

      Параметры провайдера Crowd (можно указывать, только если type: Crowd).

      • spec.crowd.baseURL
        строка

        Обязательный параметр

        Адрес Crowd.

        Пример:

        baseURL: https://crowd.example.com/crowd
        
      • spec.crowd.clientID
        строка

        Обязательный параметр

        ID приложения, созданного в Crowd (Application Name).

      • spec.crowd.clientSecret
        строка

        Обязательный параметр

        Пароль приложения, созданного в Crowd (Password).

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

      • spec.crowd.enableBasicAuth
        булевый

        Включает базовую аутентификацию в API-сервере Kubernetes по логину и паролю пользователя Crowd.

        Работает только при включённом параметре apiserver.publishAPI модуля control-plane-manager. Параметр enableBasicAuth может быть включён только в одном DexProvider кластера.

        Параметр нельзя включить, пока twoFactor.providerTypes содержит Crowd, потому что у базовой аутентификации нет страницы для второго фактора.

        Базовая аутентификация выполняется в обход spec.allowedIdentities. Поэтому создать провайдер с включённым параметром или включить параметр в существующем провайдере может только SuperAdmin.

        Успешная проверка кешируется вместе с группами пользователя на 2 минуты, неуспешная — на 10 секунд. Пользователь, у которого отозван доступ в провайдере, может обращаться к Kubernetes API до истечения кешированного результата.

      • spec.crowd.groups
        массив строк

        Список-фильтр групп, допустимых для приема из Crowd.

        Токен пользователя будет содержать пересечение множеств групп из Crowd и групп из этого списка. Если множество окажется пустым, авторизация не будет считаться успешной.

        Если параметр не указан, токен пользователя будет содержать все группы из Crowd.

      • spec.crowd.usernamePrompt
        строка

        Строка, которая будет отображаться возле поля для имени пользователя в форме ввода логина и пароля.

        По умолчанию: Crowd username

    • spec.displayName
      строка

      Обязательный параметр

      Имя провайдера, которое будет отображено на странице выбора провайдера для аутентификации.

      Если настроен всего один провайдер, страница выбора провайдера показываться не будет.

    • spec.enabled
      булевый

      Включает провайдер.

      Выключенный провайдер не отображается на странице входа, и войти через него нельзя. DexProvider и его настройки сохраняются.

      По умолчанию: true

    • spec.github
      объект

      Параметры провайдера GitHub (можно указывать? только если type: Github).

      • spec.github.clientID
        строка

        Обязательный параметр

        ID организации на GitHub.

      • spec.github.clientSecret
        строка

        Обязательный параметр

        Secret организации на GitHub.

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

      • spec.github.orgs
        массив объектов

        Массив названий организаций в GitHub.

        • spec.github.orgs.name
          строка

          Обязательный параметр

          Название организации.

        • spec.github.orgs.teams
          массив строк

          Список команд, допустимых для приема из GitHub.

          Токен пользователя будет содержать объединенное множество команд из GitHub и команд из этого списка. Если множество окажется пустым, авторизация не будет считаться успешной.

          Если параметр не указан, токен пользователя будет содержать все команды из GitHub.

      • spec.github.teamNameField
        строка

        Формат команд, которые будут получены из GitHub.

        Если в организации acme есть группа Site Reliability Engineers, в случае:

        • name будет получена группа с именем ['acme:Site Reliability Engineers'];
        • slug будет получена группа с именем ['acme:site-reliability-engineers'];
        • both будут получены группы с именами ['acme:Site Reliability Engineers', 'acme:site-reliability-engineers'].

        По умолчанию: name

        Допустимые значения: name, slug, both

      • spec.github.useLoginAsID
        булевый

        Позволяет вместо использования внутреннего GitHub ID использовать имя пользователя.

    • spec.gitlab
      объект

      Параметры провайдера GitLab (можно указывать, только если type: Gitlab).

      • spec.gitlab.baseURL
        строка

        Адрес GitLab.

        Пример:

        baseURL: https://gitlab.example.com
        
      • spec.gitlab.clientID
        строка

        Обязательный параметр

        ID приложения, созданного в GitLab (Application ID).

      • spec.gitlab.clientSecret
        строка

        Обязательный параметр

        Secret приложения, созданного в GitLab (Secret).

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

      • spec.gitlab.groups
        массив строк

        Список-фильтр групп (пути групп — path, а не имена), допустимых для приема из GitLab.

        Токен пользователя будет содержать пересечение множеств групп из GitLab и групп из этого списка. Если множество окажется пустым, авторизация не будет считаться успешной.

        Если параметр не указан, токен пользователя будет содержать все группы из GitLab.

      • spec.gitlab.rootCAData
        строка

        Цепочка сертификатов в формате PEM для проверки подлинности провайдера.

        Пример:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.gitlab.useLoginAsID
        булевый

        Позволяет вместо использования внутреннего GitLab ID, использовать имя пользователя.

    • spec.groupPrefix
      строка

      Префикс, который Dex добавляет перед каждой группой, утверждаемой провайдером, независимо от типа провайдера.

      С префиксом группы этого провайдера называются <PREFIX><GROUP> в токенах и в правилах кластера, например corp-ldap:admins. Префикс отделяет их от групп другого провайдера, только когда свой префикс есть у каждого провайдера, который может сообщить такие имена.

      Префикс должен заканчиваться двоеточием, например corp-ldap:. Он должен отличаться от префикса любого другого DexProvider и от префиксов групп любого TokenExchangeProvider, и ни один из двух префиксов не должен начинаться с другого. Admission-вебхуки отклоняют такой префикс.

      Каждое имя в allowedIdentities.groups должно начинаться с префикса, иначе API отклоняет манифест, потому что Dex добавляет префикс до сравнения. Настройки групп в блоке типа провайдера (например, oidc.allowedGroups, gitlab.groups и ldap.groupSearch) принимают имена провайдера идентификации, без префикса.

      Префикс не может начинаться с system:, который зарезервирован за API-сервером Kubernetes, или с peering:, который зарезервирован для ServiceAccount неймспейса d8-peering. Его нельзя задать вместе с enableBasicAuth у провайдера OIDC или Crowd, потому что basic-auth-proxy проверяет учётные данные у такого провайдера напрямую и передаёт его группы как есть.

      Установка или смена префикса переименовывает группы провайдера, и правила, написанные для старых имён, перестают действовать на его пользователей. Перепишите правила до того, как задать префикс, как описано в разделе «Префикс для групп провайдера».

      По умолчанию префикса нет.

      Шаблон: ^[A-Za-z0-9][A-Za-z0-9._:/-]*:$

      Длина: 2..64

      Пример:

      groupPrefix: 'corp-ldap:'
      
    • spec.ldap
      объект

      Параметры провайдера LDAP.

      • spec.ldap.bindDN
        строка

        Путь до сервис-аккаунта приложения в LDAP.

        Пример:

        bindDN: uid=serviceaccount,cn=users,dc=example,dc=com
        
      • spec.ldap.bindPW
        строка

        Пароль сервисной учётной записи, заданной в bindDN.

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

        Пример:

        bindPW: password
        
      • spec.ldap.enableBasicAuth
        булевый

        Включает базовую аутентификацию в API-сервере Kubernetes по логину и паролю пользователя LDAP.

        Работает только при включённом параметре apiserver.publishAPI модуля control-plane-manager. Параметр enableBasicAuth может быть включён только в одном DexProvider кластера.

        Параметр нельзя включить, пока twoFactor.providerTypes содержит LDAP, потому что у базовой аутентификации нет страницы для второго фактора.

        Успешная проверка кешируется вместе с группами пользователя на 2 минуты, неуспешная — на 10 секунд. Пользователь, у которого отозван доступ в провайдере, может обращаться к Kubernetes API до истечения кешированного результата.

      • spec.ldap.groupSearch
        объект

        Настройки фильтра для поиска групп для указанного пользователя.

        Подробнее о процессе фильтрации…

        • spec.ldap.groupSearch.baseDN
          строка

          Обязательный параметр

          Откуда будет начат поиск групп

          Пример:

          baseDN: cn=users,dc=example,dc=com
          
        • spec.ldap.groupSearch.filter
          строка

          Фильтр для директории с группами.

          Пример:

          filter: "(objectClass=person)"
          
        • spec.ldap.groupSearch.nameAttr
          строка

          Обязательный параметр

          Имя атрибута, в котором хранится уникальное имя группы.

          Пример:

          nameAttr: name
          
        • spec.ldap.groupSearch.userMatchers
          массив объектов

          Обязательный параметр

          Список сопоставлений атрибута имени юзера с именем группы.

          • spec.ldap.groupSearch.userMatchers.groupAttr
            строка

            Обязательный параметр

            Имя атрибута, в котором хранятся имена пользователей, состоящих в группе.

            Пример:

            groupAttr: member
            
          • spec.ldap.groupSearch.userMatchers.recursionGroupAttr
            строка

            Имя атрибута группы, в котором хранятся DN её участников.

            Если параметр задан, Dex дополнительно ищет группы, в которые входят найденные группы, уровень за уровнем, и добавляет их к группам пользователя. Используйте его для вложенных групп. Обычно значение совпадает с groupAttr, например member.

            Dex делает ещё один поиск для каждой группы каждого уровня при каждом входе и каждом обновлении токенов, поэтому ограничьте baseDN и filter в groupSearch.

            Пример:

            recursionGroupAttr: member
            
          • spec.ldap.groupSearch.userMatchers.userAttr
            строка

            Обязательный параметр

            Имя атрибута, в котором хранится имя пользователя.

            Пример:

            userAttr: uid
            
      • spec.ldap.host
        строка

        Обязательный параметр

        Адрес и порт (опционально) LDAP-сервера.

        Пример:

        host: ldap.example.com:636
        
      • spec.ldap.insecureNoSSL
        булевый

        Подключаться к каталогу LDAP не по защищенному порту.

        Несовместимо с startTLS, insecureSkipVerify и rootCAData: если insecureNoSSL: true, TLS отключён и эти параметры не имеют эффекта.

        По умолчанию: false

      • spec.ldap.insecureSkipVerify
        булевый

        Не производить проверку подлинности провайдера с помощью TLS. Небезопасно, не рекомендуется использовать в production-окружениях.

        Не используется при insecureNoSSL: true.

        По умолчанию: false

      • spec.ldap.kerberos
        объект

        Опциональные настройки Kerberos (SPNEGO) SSO для LDAP.

        • spec.ldap.kerberos.enabled
          булевый

          Включить поток аутентификации Kerberos SPNEGO для данного LDAP‑провайдера.

          По умолчанию: false

        • spec.ldap.kerberos.expectedRealm
          строка

          Необязательный требуемый realm (без учета регистра). Если указан и не совпадает с realm билета — вход отклоняется.

        • spec.ldap.kerberos.fallbackToPassword
          булевый

          Если true, при отсутствии/некорректном заголовке Authorization: Negotiate будет показана форма ввода логина/пароля вместо ответа 401 с WWW-Authenticate: Negotiate.

          По умолчанию: false

        • spec.ldap.kerberos.keytabSecretName
          строка

          Имя секрета в неймспейсе d8-user-authn, содержащего ключ krb5.keytab, который монтируется в под Dex.

          Обязательно, если enabled равен true.

        • spec.ldap.kerberos.krb5ConfConfigMapName
          строка

          Не используется. Dex проверяет билеты Kerberos только по keytab, и модуль не монтирует этот ConfigMap.

        • spec.ldap.kerberos.krb5ConfSecretName
          строка

          Не используется. Dex проверяет билеты Kerberos только по keytab, и модуль не монтирует этот секрет.

        • spec.ldap.kerberos.usernameFromPrincipal
          строка

          Способ сопоставления Kerberos principal с именем пользователя в LDAP: Localpart, SAMAccountName или UserPrincipalName.

          По умолчанию: Localpart

          Допустимые значения: Localpart, SAMAccountName, UserPrincipalName

      • spec.ldap.rootCAData
        строка

        Цепочка CA в формате PEM, используемая для валидации TLS.

        Не используется при insecureNoSSL: true.

        Пример:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.ldap.startTLS
        булевый

        Использовать STARTTLS для шифрования.

        Несовместимо с insecureNoSSL.

        По умолчанию: false

      • spec.ldap.userSearch
        объект

        Обязательный параметр

        Настройки фильтров пользователей, которые помогают сначала отфильтровать директории, в которых будет производиться поиск пользователей, а затем найти пользователя по полям (его имени, адресу электронной почты или отображаемому имени).

        Подробнее о процессе фильтрации…

        • spec.ldap.userSearch.baseDN
          строка

          Обязательный параметр

          Откуда будет начат поиск пользователей.

          Пример:

          baseDN: cn=users,dc=example,dc=com
          
        • spec.ldap.userSearch.emailAttr
          строка

          Обязательный параметр

          Имя атрибута, из которого будет получен email пользователя.

          Пример:

          emailAttr: mail
          
        • spec.ldap.userSearch.filter
          строка

          Позволяет добавить фильтр для директории с пользователями.

          Пример:

          filter: "(objectClass=person)"
          
        • spec.ldap.userSearch.idAttr
          строка

          Обязательный параметр

          Имя атрибута, из которого будет получен ID пользователя.

          Поддерживаются двоичные атрибуты GUID в Active Directory, objectGUID и mS-DS-ConsistencyGuid: ID пользователя в этом случае будет GUID в строковом виде, например 7ed41c2b-e283-4b10-9cb8-a6e7d1f39a4c.

          Пример:

          idAttr: uid
          
        • spec.ldap.userSearch.nameAttr
          строка

          Атрибут отображаемого имени пользователя.

          Пример:

          nameAttr: name
          
        • spec.ldap.userSearch.username
          строка

          Имя атрибута, из которого будет получен username пользователя.

          Пример:

          username: uid
          
        • spec.ldap.userSearch.usernames
          массив строк

          Атрибуты, с которыми сравнивается введённое имя пользователя, вместо username.

          Фильтр поиска имеет вид (|(<ATTR_1>=<USERNAME>)(<ATTR_2>=<USERNAME>)), поэтому пользователь может входить, например, по логину или по email. Если имени соответствует больше одной записи, вход отклоняется.

          Principal Kerberos, сопоставленный с именем пользователя (после usernameFromPrincipal), так же сравнивается со всеми атрибутами списка. Перечисляйте только атрибуты с уникальными в каталоге значениями, согласованные с usernameFromPrincipal. Если значение другой записи совпадёт с principal, у этого пользователя перестанет работать SSO. Principal, не совпавший ни с одним атрибутом своей записи, будет сопоставлен с записью другого пользователя.

          Укажите либо username, либо usernames.

          Пример:

          usernames:
          - uid
          - mail
          
          • Элемент массива
            строка

            Шаблон: ^[^\r\n]*$

            Длина: 1..256

      • spec.ldap.usernamePrompt
        строка

        Строка, которая будет отображаться возле поля для имени пользователя в форме ввода логина и пароля.

        По умолчанию: LDAP username

        Пример:

        usernamePrompt: SSO Username
        
    • spec.oidc
      объект

      Параметры провайдера OIDC (можно указывать, только если type: OIDC).

      • spec.oidc.allowedGroups
        массив строк

        Список групп, которые должны быть у пользователя для успешной аутентификации.

        Если список содержит группу, которой у пользователя нет, аутентификация будет отклонена.

        Если параметр не задан, проверка принадлежности к группам не выполняется.

      • spec.oidc.basicAuthUnsupported
        булевый

        Использовать POST-запросы для общения с провайдером вместо добавления токена в Basic Authorization header.

        В большинстве случаев Dex сам определяет, какой запрос ему нужно сделать, но иногда включение этого параметра может помочь.

        По умолчанию: false

      • spec.oidc.claimMapping
        объект

        Некоторые провайдеры возвращают нестандартные claim’ы (например, mail). Claim mappings помогают Dex преобразовать их в стандартные claim’ы OIDC.

        Dex может преобразовать нестандартный claim в стандартный, только если id_token, полученный от OIDC-провайдера, не содержит аналогичный стандартный claim.

        • spec.oidc.claimMapping.email
          строка

          Claim, который будет использован для получения email пользователя.

          По умолчанию: email

        • spec.oidc.claimMapping.groups
          строка

          Claim, который будет использован для получения групп пользователя.

          По умолчанию: groups

        • spec.oidc.claimMapping.preferred_username
          строка

          Claim, который будет использован для получения предпочтительного имени пользователя.

          По умолчанию: preferred_username

      • spec.oidc.claimMappingOverride
        булевый

        Если включено, сопоставление claim’ов (claimMapping) будет переопределять стандартные claim’ы OIDC.

        По умолчанию сопоставление claim’ов будет использоваться только в том случае, если стандартные claim’ы OIDC отсутствуют, например, если в id_token нет claim’а email, будет использоваться claimMapping.email.

        По умолчанию: false

      • spec.oidc.clientID
        строка

        Обязательный параметр

        ID приложения, созданного в OIDC-провайдере.

      • spec.oidc.clientSecret
        строка

        Обязательный параметр

        Пароль приложения, созданного в OIDC-провайдере.

        Если у вызывающей стороны нет прав на подресурс dexproviders/sensitive, API возвращает <omitted> вместо значения.

      • spec.oidc.enableBasicAuth
        булевый

        Включает базовую аутентификацию в API-сервере Kubernetes по логину и паролю пользователя OIDC-провайдера.

        Работает только при включённом параметре apiserver.publishAPI модуля control-plane-manager. Параметр enableBasicAuth может быть включён только в одном DexProvider кластера.

        Базовая аутентификация выполняется в обход spec.allowedIdentities. Поэтому создать провайдер с включённым параметром или включить параметр в существующем провайдере может только SuperAdmin.

        Успешная проверка кешируется вместе с группами пользователя на 2 минуты, неуспешная — на 10 секунд. Пользователь, у которого отозван доступ в провайдере, может обращаться к Kubernetes API до истечения кешированного результата.

      • spec.oidc.getUserInfo
        булевый

        Запрашивать дополнительные данные об успешно подключенном пользователе.

        Подробнее…

        По умолчанию: false

      • spec.oidc.insecureSkipEmailVerified
        булевый

        Игнорировать информацию о статусе подтверждения email пользователя.

        Как именно подтверждается email, решает сам провайдер. В ответе от провайдера приходит лишь информация — подтвержден email или нет.

        По умолчанию: false

      • spec.oidc.insecureSkipVerify
        булевый

        Не производить проверку подлинности провайдера с помощью TLS. Небезопасно, не рекомендуется использовать в production-окружениях.

        По умолчанию: false

      • spec.oidc.issuer
        строка

        Обязательный параметр

        Адрес OIDC-провайдера.

        Пример:

        issuer: https://accounts.google.com
        
      • spec.oidc.promptType
        строка

        Определяет — должен ли Issuer запрашивать подтверждение и давать подсказки при аутентификации.

        По умолчанию будет запрошено подтверждение при первой аутентификации. Допустимые значения могут изменяться в зависимости от Issuer.

        По умолчанию: consent

      • spec.oidc.rootCAData
        строка

        Цепочка CA в формате PEM, используемая для валидации TLS.

        Пример:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.oidc.scopes
        массив строк

        Список полей для включения в ответ при запросе токена.

        Scope — это одиночный токен, он не может содержать пробельные символы: протокол OAuth2 передаёт scope’ы списком, разделённым пробелами.

        По умолчанию: ["openid","profile","email","groups","offline_access"]

        • Элемент массива
          строка

          Шаблон: ^\S+$

      • spec.oidc.upstreamLogout
        булевый

        Завершает сессию пользователя и у провайдера, когда пользователь выходит из Dex.

        Работает только при включённых браузерных сессиях Dex и только если провайдер публикует end_session_endpoint.

        По умолчанию выход из Dex не затрагивает сессию у провайдера: выход из одного приложения не завершает сессии пользователя в других приложениях. В этом случае провайдер может снова аутентифицировать пользователя без пароля. Чтобы пароль запрашивался при каждом входе, задайте promptType: login.

        По умолчанию: false

      • spec.oidc.userIDKey
        строка

        Claim, который будет использован для получения ID пользователя.

        По умолчанию: sub

      • spec.oidc.userNameKey
        строка

        Claim, который будет использован для получения имени пользователя.

        По умолчанию: name

    • spec.saml
      объект

      Параметры провайдера SAML (можно указывать, только если type: SAML).

      • spec.saml.allowedGroups
        массив строк

        Если задано, вход будет разрешён только членам хотя бы одной из перечисленных групп.

      • spec.saml.emailAttr
        строка

        SAML-атрибут для маппинга в claim email.

        По умолчанию: email

      • spec.saml.entityIssuer
        строка

        Значение Issuer, которое Dex передаёт в SAML AuthnRequest (идентификатор Dex как сервис-провайдера). Это же значение Dex ожидает в элементе Audience SAML-утверждения.

        Если не задано, Issuer в запрос не добавляется, а в элементе Audience Dex ожидает URL callback.

      • spec.saml.filterGroups
        булевый

        Если true, коннектор будет фильтровать claim groups, оставляя только группы из списка allowedGroups.

        По умолчанию: false

      • spec.saml.groupsAttr
        строка

        SAML-атрибут для маппинга в claim groups.

      • spec.saml.groupsDelim
        строка

        Разделитель для разбиения значения атрибута groups, если оно является одной строкой.

      • spec.saml.insecureSkipSignatureValidation
        булевый

        Пропустить проверку подписи SAML-ответов. Небезопасно, использовать только для тестирования.

        По умолчанию: false

      • spec.saml.nameIDPolicyFormat
        строка

        Формат NameIDPolicy для запроса к IdP.

        Если параметр не задан, Dex запрашивает persistent.

        UserOperation Lock со spec.target действует на идентификатор пользователя, который Dex берёт из NameID. Чтобы такая блокировка работала, используйте persistent или emailAddress. При значении transient IdP возвращает новый NameID при каждом входе, и блокировка не действует при следующем входе пользователя.

        Допустимые значения: persistent, emailAddress, unspecified, X509SubjectName, WindowsDomainQualifiedName, transient

      • spec.saml.redirectURI
        строка

        URI обратного вызова.

        Переопределяет URL callback по умолчанию. Должен быть установлен в https://<dex-domain>/callback.

      • spec.saml.rootCAData
        строка

        Цепочка CA в формате PEM, используемая для валидации TLS.

        Пример:

        rootCAData: |
          -----BEGIN CERTIFICATE-----
          MIIFaDC...
          -----END CERTIFICATE-----
        
      • spec.saml.ssoIssuer
        строка

        Значение Issuer, ожидаемое в SAML-ответе от IdP.

        Если не задано, Issuer ответа не проверяется.

      • spec.saml.ssoURL
        строка

        Обязательный параметр

        URL для отправки SAML AuthnRequest (SSO URL провайдера).

        Пример:

        ssoURL: https://idp.example.com/saml/sso
        
      • spec.saml.usernameAttr
        строка

        SAML-атрибут для маппинга в claim username.

        По умолчанию: name

    • spec.tokenExchange
      объект

      Настройки обмена токенов (RFC 8693) через провайдер. Dex обменивает ID-токен издателя провайдера на свой токен. Обменивать токены могут только провайдеры OIDC и Gitlab.

      Коннектор провайдера не проверяет аудиторию обмениваемого токена, поэтому токен кластера могло бы получить любое приложение издателя. Обменивайте токены через TokenExchangeProvider. Поле временное и будет удалено после следующего LTS-релиза вместе с обменом токенов через DexProvider.

      • spec.tokenExchange.enabled
        булевый

        Обменивает ли провайдер токены. Отсутствие поля означает false.

        Обмен можно только выключить. Администратор не может установить true ни при создании провайдера, ни при его изменении. При обновлении с релиза, в котором этого поля нет, user-authn один раз выставляет его всем существующим провайдерам OIDC и Gitlab. Если есть хотя бы один DexClient с аннотацией dexclient.deckhouse.io/allow-access-to-kubernetes: "true", всем выставляется true, иначе всем выставляется false. DexAuthenticator с доступом к Kubernetes не учитывается. Его oauth2-proxy токены не обменивает, а обмен с его client secret, взятым из Secret в неймспейсе приложения, не сохраняется.

    • spec.type
      строка

      Обязательный параметр

      Тип внешнего провайдера.

      Допустимые значения: Github, Gitlab, BitbucketCloud, Crowd, OIDC, LDAP, SAML

Group

Scope: Cluster
Version: v1alpha1

Содержит информацию о статических группах.

  • spec
    объект

    Обязательный параметр

    • spec.members
      массив объектов

      Обязательный параметр

      Список членов группы.

      • spec.members.kind
        строка

        Обязательный параметр

        Тип члена группы.

        Допустимые значения: User, Group

      • spec.members.name
        строка

        Обязательный параметр

        Для kind User — metadata.name пользователя. Для kind Group — spec.name вложенной группы (имя в токене), не metadata.name.

    • spec.name
      строка

      Обязательный параметр

      Уникальное имя группы, которое попадает в claim groups токена и в RBAC-субъекты. Это не metadata.name.

TokenExchangeProvider

Scope: Cluster
Version: v1alpha1

Определяет доверенного издателя токенов, которые Dex обменивает на свои токены (обмен токенов по RFC 8693).

Имя объекта — не длиннее 50 символов.

Клиент из spec.clients отправляет токен издателя на эндпоинт /token Dex и получает токен Dex для кластера. API-сервер Kubernetes принимает его так же, как токен любого другого пользователя Dex. Типичные издатели — CI-системы (id_tokens в GitLab CI, GitHub Actions), Dex соседнего кластера и издатель токенов ServiceAccount другого кластера.

Dex проверяет подпись, издателя, срок действия и аудиторию токена, а также обязательные claims. Затем называет субъекта так, как задано в spec.identity. Провайдер служит только для обмена токенов и не показывается на странице входа.

Внимание. Тот, кто может создать объект, выбирает издателя, его ключи и имена, а значит может получить токен за любого пользователя или группу вне зарезервированных префиксов. Это право равносильно праву действовать от имени любого пользователя. Выдавайте его только администраторам кластера.

После удаления объекта API Kubernetes в течение нескольких секунд отклоняет все токены, выданные через него, если у модуля user-authz включён параметр enableMultiTenancy и в кластере Kubernetes 1.34 или новее. Иначе эти токены действуют до истечения срока (параметр idTokenTTL модуля).

  • spec
    объект

    Обязательный параметр

    • spec.allowedIdentities
      объект

      Ограничивает субъектов, которых может утверждать провайдер, как в DexProvider. Dex отказывает субъекту, чей email не входит в emails и emailDomains, если задано хотя бы одно из полей, и оставляет только группы из groups, если оно задано.

      • spec.allowedIdentities.emailDomains
        массив строк

        Разрешённые домены email.

      • spec.allowedIdentities.emails
        массив строк

        Разрешённые адреса email.

      • spec.allowedIdentities.groups
        массив строк

        Разрешённые группы. Остальные группы удаляются у субъекта.

    • spec.audiences
      массив объектов

      Обязательный параметр

      Аудитории, для которых принимается токен. Токен принимается, если его claim aud совпадает хотя бы с одной записью.

      • spec.audiences.exact
        строка

        Значение, которому должен быть равен aud.

      • spec.audiences.prefix
        строка

        Префикс, с которого должен начинаться aud.

    • spec.claimValidation
      массив объектов

      Значения claims, которые обязан нести токен.

      Строковый claim должен быть равен equals. Булев или числовой claim в строковой записи должен быть равен equals. Список должен содержать equals.

      • spec.claimValidation.claim
        строка

        Обязательный параметр

        Имя проверяемого claim.

      • spec.claimValidation.equals
        строка

        Обязательный параметр

        Значение, которое должен иметь claim.

    • spec.clients
      массив объектов

      Обязательный параметр

      Клиенты Dex, которым разрешено обменивать токены через этот провайдер. Остальным клиентам отказывается до проверки токена.

      Указанный DexClient может обменивать токены через этот провайдер, даже если провайдер не перечислен в его allowedProviders.

      • spec.clients.dexClient
        объект

        Обязательный параметр

        DexClient, которому разрешён обмен токенов. Его идентификатор клиента — dex-client-<DEXCLIENT_NAME>@<DEXCLIENT_NAMESPACE>.

        • spec.clients.dexClient.name
          строка

          Обязательный параметр

          Имя DexClient.

        • spec.clients.dexClient.namespace
          строка

          Обязательный параметр

          Неймспейс DexClient.

    • spec.identity
      объект

      Обязательный параметр

      Как субъект токена называется в кластере. API-сервер Kubernetes берёт имя пользователя из email, поэтому email совпадает с именем пользователя, если не задан email.

      • spec.identity.email
        объект

        Email субъекта, составленный из prefix и значения строкового claim claim. Префикс обязателен и заканчивается двоеточием.

        • spec.identity.email.claim
          строка

          Обязательный параметр

          Имя строкового claim, значение которого идёт после префикса.

        • spec.identity.email.prefix
          строка

          Префикс, который добавляется к значению claim. Обязателен и заканчивается двоеточием, например ci:.

      • spec.identity.groups
        массив объектов

        Группы субъекта, взятые из строковых claims или claims-списков.

        С trimPrefix значения, которые с него не начинаются, отбрасываются, а у остальных он удаляется. Затем ко всем оставшимся значениям добавляется prefix. Он обязателен и заканчивается двоеточием.

        • spec.identity.groups.claim
          строка

          Обязательный параметр

          Имя строкового claim или claim-списка с группами.

        • spec.identity.groups.prefix
          строка

          Префикс, который добавляется к каждой группе. Обязателен и заканчивается двоеточием, например ci:.

        • spec.identity.groups.trimPrefix
          строка

          Префикс, с которого должны начинаться значения групп. Он удаляется из них, а значения без него отбрасываются.

      • spec.identity.username
        объект

        Обязательный параметр

        Имя пользователя субъекта, составленное из prefix и значения строкового claim claim. Префикс обязателен и заканчивается двоеточием.

        • spec.identity.username.claim
          строка

          Обязательный параметр

          Имя строкового claim, значение которого идёт после префикса.

        • spec.identity.username.prefix
          строка

          Префикс, который добавляется к значению claim. Обязателен и заканчивается двоеточием, например ci:.

    • spec.issuer
      строка

      Обязательный параметр

      Издатель токенов. Должен совпадать с claim iss токена.

      URL-адрес со схемой https без query и fragment.

      Пример:

      issuer: https://gitlab.example.com
      
    • spec.keys
      объект

      Обязательный параметр

      Источник ключей, которыми подписаны токены, — discovery-документ издателя или открытые ключи, заданные здесь.

      • spec.keys.discovery
        объект

        Настройки чтения ключей из discovery-документа издателя. Dex читает его при первом обмене и повторно после ошибки.

        • spec.keys.discovery.caData
          строка

          PEM-бандл CA, к которому ведёт цепочка сертификата издателя, в дополнение к системным корневым.

        • spec.keys.discovery.url
          строка

          HTTPS-адрес discovery-документа.

          Если параметр не задан, используется <ISSUER>/.well-known/openid-configuration, где <ISSUER> — значение spec.issuer.

      • spec.keys.jwks
        объект

        Открытые ключи издателя (JWK Set, RFC 7517). Используйте, когда discovery-документ издателя недоступен из кластера или когда у нескольких издателей один URL-адрес, например у издателей токенов ServiceAccount разных кластеров. Закрытые ключи отклоняются. Токен, который называет ключ в заголовке kid, проверяется только ключом с этим kid, даже если ключ в наборе один.

        • spec.keys.jwks.keys
          массив объектов

          Обязательный параметр

          Открытые ключи в формате JWK.

          • spec.keys.jwks.keys.kty
            строка

            Обязательный параметр

            Тип ключа, например RSA или EC.

    • spec.subjectTokenMaxLifetime
      строка

      Наибольший срок действия токена, считая от iat до exp, а у токена без iat — от текущего момента до exp.

      Токен с бо́льшим сроком отклоняется, чтобы утёкший долгоживущий токен нельзя было обменивать на новые токены Dex, пока он не истечёт. Значение задаётся в часах, минутах и секундах, например 24h или 1h30m.

      По умолчанию: 24h

      Длина: 2..16

  • status
    объект

    Состояние провайдера.

    Пока задан metadata.deletionTimestamp, провайдер отзывается, и клиент должен перестать использовать полученные через него токены.

    • status.conditions
      массив объектов

      Условия провайдера. Условие Ready показывает, обменивает ли провайдер токены, а его reason — почему нет.

      • status.conditions.lastTransitionTime
        строка

        Время последнего изменения статуса.

      • status.conditions.message
        строка

        Подробности статуса.

      • status.conditions.observedGeneration
        целочисленный

        Поколение объекта, для которого установлено условие.

      • status.conditions.reason
        строка

        Причина статуса, например PrefixConflict.

      • status.conditions.status
        строка

        Обязательный параметр

        Статус условия, True, False или Unknown.

      • status.conditions.type
        строка

        Обязательный параметр

        Тип условия, например Ready.

    • status.connectorID
      строка

      Идентификатор коннектора Dex для этого провайдера. Передавайте его как connector_id в запросе обмена. Токены, выданные через него, несут его в extra пользователя user-authn.deckhouse.io/dex-provider.

    • status.observedGeneration
      целочисленный

      Поколение объекта, которое контроллер обработал последним.

UserAccount

Scope: Cluster
Version: v1alpha1

Создаваемое контроллером представление объектов Dex Password, OfflineSessions и UserIdentity для веб-интерфейса Deckhouse.

Контроллер ведёт по одному объекту UserAccount на каждого локального пользователя и на каждого пользователя, входившего через любой внешний провайдер.

Не создавайте и не изменяйте объекты UserAccount. Ими владеет контроллер user-authn. Источником истины для учётных данных и состояния сессий остаётся Dex.

  • spec
    объект

    Пустой объект. UserAccount принадлежит контроллеру и не содержит пользовательской спецификации.

    Не создавайте объекты UserAccount. Контроллер проецирует его из Dex.

  • status
    объект

    Наблюдаемое состояние учётной записи, проецируемое из Dex.

    Это представление для веб-интерфейса Deckhouse. Учётные данные и секреты коннектора не хранятся.

    • status.connectorID
      строка

      Идентификатор коннектора Dex.

      Для локальных учётных записей — local; для внешних — имя DexProvider.

    • status.email
      строка

      Email учётной записи, как его сообщает Dex.

    • status.expireAt
      строка

      Срок действия учётной записи в формате RFC3339.

    • status.groups
      массив строк

      Список групп, связанных с учётной записью.

    • status.incorrectLoginAttempts
      целочисленный

      Количество последовательных неудачных попыток входа, зафиксированных в Dex.

      Dex ведёт счётчик для локальных учётных записей, а также для учётных записей провайдеров LDAP и Atlassian Crowd, тип которых указан в параметре модуля passwordPolicy.lockout.applyToConnectors.

      Допустимые значения: 0 <= X

    • status.kind
      строка

      Тип учётной записи.

      Возможные значения:

      • Local — Dex Password (статический пользователь);
      • External — федеративная учётная запись из коннектора.

      Допустимые значения: Local, External

    • status.lastLogin
      строка

      Время последнего входа через Dex в формате RFC3339.

      Dex записывает его после прохождения всех шагов входа, включая 2FA. Базовая аутентификация в API-сервере через LDAP-провайдер с enableBasicAuth тоже обновляет это время, потому что проходит через Dex.

      Для учётной записи, которая не входила с момента обновления на Deckhouse 1.78, это время её последнего входа, при котором был выдан refresh-токен.

    • status.locked
      булевый

      Признак того, что учётная запись в данный момент заблокирована.

    • status.lockedByAdministrator
      булевый

      Признак того, что текущая блокировка выставлена администратором (в отличие от автоматической блокировки политикой паролей).

      Не означает бессрочность: срок по-прежнему задаёт lockedUntil.

    • status.lockedUntil
      строка

      Время (в формате RFC3339), до которого учётная запись остаётся заблокированной.

      После наступления этого времени блокировка снимается автоматически, в том числе если её выставил администратор на ограниченный срок (например, на час через UserOperation). Бессрочная блокировка записывается администратором как далёкая дата в будущем.

    • status.providerType
      строка

      Тип внешнего провайдера идентификации.

      Совпадает со значением spec.type в DexProvider, например LDAP, Crowd, OIDC, SAML или Github.

      Для локальных учётных записей поле пустое.

    • status.sessions
      массив объектов

      Устройства, на которых выполнен вход в учётную запись. Первыми идут устройства с самой свежей активностью.

      Устройство — это одно из следующего:

      • браузер, выполнивший вход в Dex при включённых сессиях Dex, вместе с приложениями, refresh-токены которых привязаны к его сессии (объекты DexAuthenticator и объекты DexClient с refreshTokenLifetime: Session);
      • refresh-токен, не привязанный к действующей сессии Dex в браузере: kubeconfig, вход через device flow, приложение DexClient, базовая аутентификация в API-сервере, токен, сессия которого закончилась, а приложение его сохранило, а при выключенных сессиях Dex — каждый вход в приложение DexAuthenticator.

      В списке не больше 50 устройств. Чтобы завершить вход на устройстве, создайте UserOperation с типом Logout и укажите его id в logout.session (браузер) или в logout.grant (refresh-токен).

      • status.sessions.clients
        массив строк

        Клиенты Dex (приложения), в которые выполнен вход на устройстве.

      • status.sessions.endsAt
        строка

        Время в формате RFC3339, когда сеанс устройства закончится, если устройством больше не пользоваться. Сеанс заканчивается по первому из двух сроков: сроку жизни от входа и сроку без использования от последнего использования.

        • Для устройства вида Browser это конец его сессии Dex (параметры sessions.absoluteLifetime и sessions.validIfNotUsedFor). После него при следующем входе браузер запрашивает пароль; приложения, в которые из него уже выполнен вход, продолжают работать.
        • Для устройства вида Grant это конец его refresh-токена (параметры refreshTokenAbsoluteLifetime и refreshTokenValidIfNotUsedFor). После него устройство выполняет вход заново.

        Пока устройством пользуются, время сдвигается вперёд и обновляется с задержкой до 15 минут, поэтому сеанс не заканчивается раньше указанного времени. Не указывается, если у сеанса нет срока.

      • status.sessions.id
        строка

        Обязательный параметр

        Идентификатор устройства: для браузера — идентификатор сессии Dex (claim sid в его токенах), для остальных устройств — идентификатор refresh-токена.

      • status.sessions.ipAddress
        строка

        Адрес клиента при последнем входе с устройства, каким его передал в Dex Ingress-контроллер. Указывает на устройство лишь приблизительно: прокси, NAT или VPN меняют адрес. За балансировщиком, который скрывает адрес клиента, это адрес балансировщика (подробнее — в разделе Какой адрес клиента видит Dex?).

        Максимальная длина: 64

      • status.sessions.kind
        строка

        Обязательный параметр

        Вид устройства.

        Возможные значения:

        • Browser — браузер, выполнивший вход в Dex;
        • Grant — refresh-токен, не привязанный к действующей сессии Dex в браузере.

        Допустимые значения: Browser, Grant

      • status.sessions.knownSince
        строка

        Время, когда Dex впервые увидел вход в учётную запись из браузера этого устройства, в формате RFC3339.

        Указывается, если раньше signedInAt больше чем на минуту: из браузера уже входили, выходили и вошли снова. Dex узнаёт браузер по долгоживущей cookie, которую ставит при входе. Выход на остальных устройствах, выход на всех устройствах и операции, которые завершают все сеансы пользователя, заставляют Dex забыть браузеры. То же происходит, если это устройство завершили с другого устройства или это сделал администратор.

      • status.sessions.lastActivity
        строка

        Время последнего использования устройства в формате RFC3339, округлённое вниз до часа. Для устройства, вошедшего меньше часа назад, указывается время входа.

      • status.sessions.signedInAt
        строка

        Время входа с устройства в формате RFC3339.

      • status.sessions.userAgent
        строка

        Заголовок User-Agent, который устройство отправило при последнем входе, обрезанный до 512 байт.

        Заголовок задаёт само устройство. Выводите его как текст.

        Максимальная длина: 512

    • status.sessionsTruncated
      булевый

      Признак того, что устройств у учётной записи больше, чем в sessions. Устройства с самой давней активностью в список не попали.

    • status.twoFactor
      объект

      Состояние 2FA учётной записи в Dex, без секретов.

      Поле показывает, что настройки требуют от пользователей типа провайдера учётной записи, есть ли это у учётной записи и какие методы у неё есть.

      Заполняется после первого входа учётной записи через Dex. Поля нет, если второй фактор не охватывает тип провайдера учётной записи.

      • status.twoFactor.confirmed
        булевый

        Есть ли у учётной записи то, что требуют methods и require, причём секрет TOTP подтверждён кодом.

        Ключ WebAuthn готов сразу после регистрации.

        Пока код не введён, при входе снова показывается QR-код.

      • status.twoFactor.enrolled
        булевый

        Есть ли у учётной записи то, что требуют methods и require: секрет TOTP, хотя бы один ключ WebAuthn, оба (All) или один из них (Any).

        Секрет или ключ метода, который не требуется, не учитывается. Без methods — есть ли у учётной записи хоть один из них. Dex создаёт секрет TOTP, когда показывает пользователю QR-код при входе.

      • status.twoFactor.methods
        массив строк

        Вторые факторы, которые настройки требуют от пользователей типа провайдера учётной записи (twoFactor.methods модуля или запись providerTypeOverrides для этого типа).

        Поле отсутствует, когда 2FA выключена или не охватывает этот тип.

        • Элемент массива
          строка

          Допустимые значения: TOTP, WebAuthn

      • status.twoFactor.require
        строка

        Как сочетаются два метода из methods.

        При Any пользователь проходит один из них, при All — оба. При одном методе поля нет.

        Допустимые значения: Any, All

      • status.twoFactor.totp
        объект

        Секрет TOTP учётной записи. Поля нет, если секрета нет.

        UserOperation с типом Reset2FA удаляет его, кроме случая, когда в spec.reset2FA.methods указан только WebAuthn.

        • status.twoFactor.totp.confirmed
          булевый

          Ввёл ли пользователь код для секрета.

      • status.twoFactor.webAuthn
        объект

        Учётные данные WebAuthn (ключи безопасности) учётной записи. Поля нет, если их нет.

        UserOperation с типом Reset2FA удаляет их, кроме случая, когда в spec.reset2FA.methods указан только TOTP.

        • status.twoFactor.webAuthn.credentials
          целочисленный

          Число зарегистрированных ключей безопасности.

        • status.twoFactor.webAuthn.maxCredentials
          целочисленный

          Сколько учётных данных может зарегистрировать учётная запись (twoFactor.webAuthn.maxCredentials модуля).

    • status.userID
      строка

      Уникальный идентификатор пользователя из Dex.

    • status.userRef
      строка

      Имя связанного ресурса User.

      Заполняется для локальных учётных записей.

    • status.username
      строка

      Имя пользователя, как его сообщает Dex.

UserOperation

Scope: Cluster

  • v1
  • v1alpha1

Содержит информацию об одноразовой операции над пользователем (сброс пароля, сброс 2FA, блокировка/разблокировка, выход).

UserOperation выполняется один раз, и изменения его спецификации после создания игнорируются. Модуль обрабатывает операцию и записывает результат в status.phase (Succeeded или Failed). Операции автоматически удаляются через срок из настройки модуля retention.userOperations (по умолчанию 24 часа). Для нового действия нужно создать новый UserOperation.

Операции Lock, ResetPassword, Reset2FA и Logout сразу завершают сессии пользователя. Модуль повышает поколение учётной записи пользователя в Dex (пары провайдера и идентификатора пользователя), записывает отзыв в объект Dex Revocation и удаляет принадлежащие пользователю объекты Dex AuthSession (сессии браузера) и RefreshToken. Dex отклоняет всё, что выдал этой учётной записи раньше, а dex-authenticator перестаёт принимать сессии пользователя в течение нескольких секунд. Секрет 2FA пользователя эти операции сохраняют. Удаляет его только Reset2FA, и эта операция также удаляет принадлежащий пользователю объект Dex OfflineSessions. Unlock и RequirePasswordChange сессии не завершают. Что отозвала операция, записывается в status.revocation.

  • spec
    объект

    Обязательный параметр

    • spec.initiatorType
      строка

      Указывает, кем инициирована операция. Возможные значения:

      • admin — администратором (например, через CLI d8 iam user или ручное создание UserOperation);
      • system — зарезервировано, ни один компонент это значение не устанавливает (Dex блокирует пользователя после неудачных попыток входа без создания UserOperation);
      • self — самим пользователем (выход на всех устройствах или смена пароля в веб-интерфейсе Deckhouse).
    • spec.lock
      объект

      Параметры операции по блокировке пользователя.

      • spec.lock.for
        строка

        Обязательный параметр

        Длительность блокировки в формате Go (30s, 10m, 1h, 2h30m, 7d) либо permanent — бессрочная блокировка, снимается только Unlock. 1d равно 24h.

        Шаблон: ^(permanent|([0-9]+(\.[0-9]+)?(s|m|h|d))+)$

    • spec.logout
      объект

      Уточняет операцию Logout. Без этого поля Logout завершает все сессии пользователя.

      Можно указать не больше одного поля. Поля session и exceptSession относятся к сессиям браузера в Dex.

      • spec.logout.exceptGrant
        строка

        Идентификатор refresh-токена, который нужно сохранить, чтобы выйти на остальных устройствах с устройства без сессии Dex в браузере. Все сессии браузера пользователя завершаются, кроме той, в которой выдан сохраняемый refresh-токен, и все остальные refresh-токены отзываются. Токен, выданный во время выполнения операции, может сохраниться. Операция завершается с ошибкой, если у пользователя нет такого refresh-токена.

        Шаблон: ^[a-z2-7]{1,64}$

      • spec.logout.exceptSession
        строка

        Идентификатор сессии браузера, которую нужно сохранить. Все остальные сессии браузера пользователя завершаются, и все refresh-токены, выданные не в этой сессии, отзываются. Токен, выданный во время выполнения операции, может сохраниться. Операция завершается с ошибкой, если у пользователя нет такой сессии.

        Шаблон: ^[a-z2-7]{1,64}$

      • spec.logout.grant
        строка

        Идентификатор refresh-токена, который нужно отозвать: устройство, вошедшее без сессии Dex в браузере, например kubeconfig. Это id устройства вида Grant в status.sessions объекта UserAccount и claim d8_gid токенов, выданных вместе с этим refresh-токеном. Остальные устройства сохраняют свои сессии. Если у пользователя нет такого refresh-токена, например он истёк, отозван или принадлежит другому пользователю, операция ничего не завершает и завершается успешно с сообщением the user has no such grant.

        Шаблон: ^[a-z2-7]{1,64}$

      • spec.logout.session
        строка

        Идентификатор сессии браузера, которую нужно завершить (claim sid токенов, выданных в ней), вместе с refresh-токенами, выданными в этой сессии. Если у пользователя нет такой сессии, например она истекла или принадлежит другому пользователю, операция ничего не завершает и завершается успешно с сообщением the user has no such session.

        Шаблон: ^[a-z2-7]{1,64}$

    • spec.reset2FA
      объект

      Сужает Reset2FA. Без этого поля Reset2FA удаляет все вторые факторы пользователя.

      • spec.reset2FA.methods
        массив строк

        Вторые факторы, которые нужно удалить: TOTP — секрет приложения-аутентификатора, WebAuthn — ключи безопасности. Второй метод остаётся. Удалённый метод пользователь регистрирует заново при следующем входе, который его запрашивает. Сессии пользователя завершаются при любом наборе методов.

        • Элемент массива
          строка

          Допустимые значения: TOTP, WebAuthn

    • spec.resetPassword
      объект

      Параметры операции по сбросу пароля.

      • spec.resetPassword.newPasswordHash
        строка

        Bcrypt-хеш нового пароля без кодирования в Base64.

        Если у вызывающей стороны нет прав на подресурс useroperations/sensitive, API возвращает <omitted> вместо значения.

      • spec.resetPassword.requirePasswordChange
        булевый

        Требовать от пользователя сменить пароль при следующем входе.

        При false новый пароль действует, пока пользователь его не сменит или пока не истечёт интервал ротации парольной политики. Пароль, не соответствующий правилам сложности, всё равно потребуется сменить при следующем входе.

        По умолчанию: true

    • spec.target
      объект

      Идентификатор учётной записи внешнего провайдера аутентификации по email.

      Операции Lock, Unlock, Logout и Reset2FA для target применяются к учётной записи Dex (объекту UserIdentity) пользователя, у которого при последнем входе был этот email. Поля connectorID и userID сужают поиск до одного провайдера и одного идентификатора пользователя. Операция завершается с ошибкой, если ни у одной учётной записи нет этого email (пользователь ни разу не входил) или если подходят несколько учётных записей; тогда нужно указать connectorID, а если у провайдера несколько пользователей с этим email, то и userID. Операция применяется только к найденной учётной записи: блокировка не блокирует локального пользователя или пользователя другого провайдера с тем же email. Локальный пользователь указывается только в spec.user.

      Блокировка действует на идентификатор пользователя, который провайдер возвращает при входе. SAML-провайдер должен возвращать один и тот же идентификатор при каждом входе, для этого параметр nameIDPolicyFormat должен иметь значение persistent или emailAddress либо не должен быть задан. При значении transient каждый вход получает новый идентификатор, и блокировка не действует при следующем входе.

      Одновременно можно указать только одно из полей: user или target.

      • spec.target.connectorID
        строка

        Идентификатор DexProvider (коннектора), через который входит пользователь.

        Примеры:

        connectorID: my-ldap
        
        connectorID: my-crowd
        
      • spec.target.email
        строка

        Обязательный параметр

        Email пользователя, который провайдер сообщил при последнем входе пользователя.

        Регистр букв при сравнении не учитывается.

        Пример:

        email: jane.doe@example.org
        
      • spec.target.userID
        строка

        Идентификатор пользователя, который провайдер возвращает при входе (userID объекта Dex UserIdentity). Позволяет различить учётные записи провайдера с одинаковым email.

        Пример:

        userID: cn=jane.doe,ou=people,dc=example,dc=org
        
    • spec.type
      строка

      Обязательный параметр

      Тип операции над пользователем. Возможные значения:

      • ResetPassword — сброс пароля. Применимо только к локальным пользователям (spec.user);
      • Reset2FA — сброс двухфакторной аутентификации. Поддерживает как локальных (spec.user), так и внешних (spec.target) пользователей. Из внешних пользователей второй фактор может быть только у пользователей провайдера LDAP или Atlassian Crowd. Для пользователя провайдера другого типа операция только завершает сессии;
      • Lock — блокировка пользователя. Поддерживает как локальных (spec.user), так и внешних (spec.target) пользователей;
      • Unlock — разблокировка пользователя. Поддерживает как локальных (spec.user), так и внешних (spec.target) пользователей;
      • Logout — завершение сессий пользователя. Без logout завершает все сессии во всех приложениях и отзывает refresh-токены файлов kubeconfig. Поддерживает как локальных (spec.user), так и внешних (spec.target) пользователей;
      • RequirePasswordChange — пользователь должен задать новый пароль при следующем входе. Сессии не завершает. Применимо только к локальным пользователям (spec.user).

      Допустимые значения: ResetPassword, Reset2FA, Lock, Unlock, Logout, RequirePasswordChange

    • spec.user
      строка

      Имя локального пользователя (ссылка на ресурс User).

      Используется для операций над пользователями, которыми DP управляет через CRD User (встроенный локальный коннектор).

      Одновременно можно указать только одно из полей: user или target.

      Пример:

      user: jane.doe
      
  • status
    объект
    • status.completedAt
      строка

      Время завершения операции в формате RFC 3339 (например, 2025-01-15T10:30:00Z). Пусто, пока операция не завершена.

    • status.message
      строка

      Дополнительное сообщение о результате выполнения операции или причине ошибки.

    • status.phase
      строка

      Текущий статус выполнения операции. Возможные значения:

      • Succeeded — операция успешно выполнена;
      • Failed — операция завершилась ошибкой.

      Допустимые значения: Succeeded, Failed

    • status.revocation
      объект

      Что отозвала операция. Заполняют операции Lock, ResetPassword, Reset2FA и Logout.

      • status.revocation.authSessionsDeleted
        целочисленный

        Число удалённых операцией объектов Dex AuthSession (сессий браузера) пользователя.

      • status.revocation.generation
        целочисленный

        Новое поколение учётной записи пользователя в Dex. Всё, что выдано учётной записи с меньшим поколением, отозвано. Не заполняется, если операция отозвала не всю учётную запись.

      • status.revocation.name
        строка

        Имя объекта Dex Revocation, который записала операция, или первого из них.

      • status.revocation.refreshTokensDeleted
        целочисленный

        Число удалённых операцией объектов Dex RefreshToken пользователя.

Устаревший ресурс. Поддержка ресурса может быть исключена в следующих версиях.

Содержит информацию об операции над пользователем (сброс пароля, сброс 2FA, блокировка/разблокировка).

Операции Lock, ResetPassword и Reset2FA сразу завершают сессии пользователя, как в v1. Секрет 2FA пользователя эти операции сохраняют. Удаляет его только Reset2FA, и эта операция также удаляет объект Dex OfflineSessions пользователя.

  • spec
    объект

    Обязательный параметр

    • spec.initiatorType
      строка

      Указывает, кем инициирована операция. Возможные значения:

      • admin — администратором;
      • system — зарезервировано, ни один компонент это значение не устанавливает;
      • self — самим пользователем.
    • spec.lock
      объект

      Параметры операции по блокировке пользователя.

      • spec.lock.for
        строка

        Обязательный параметр

        Длительность блокировки в формате Go (30s, 10m, 1h, 2h30m, 7d) либо permanent — бессрочная блокировка, снимается только Unlock. 1d равно 24h.

        Шаблон: ^(permanent|([0-9]+(\.[0-9]+)?(s|m|h|d))+)$

    • spec.resetPassword
      объект

      Параметры операции по сбросу пароля.

      • spec.resetPassword.newPasswordHash
        строка

        Новый пароль в виде bcrypt-хеша.
        Хеш должен быть получен заранее и передан в поле CR.

        Если у вызывающей стороны нет прав на подресурс useroperations/sensitive, API возвращает <omitted> вместо значения.

    • spec.type
      строка

      Обязательный параметр

      Тип операции над пользователем. Возможные значения:

      • ResetPassword — сброс пароля;
      • Reset2FA — сброс двухфакторной аутентификации;
      • Lock — блокировка пользователя;
      • Unlock — разблокировка пользователя.

      Допустимые значения: ResetPassword, Reset2FA, Lock, Unlock

    • spec.user
      строка

      Обязательный параметр

      Имя пользователя (ссылка на ресурс User).

      Пример:

      user: jane.doe
      
  • status
    объект
    • status.completedAt
      строка

      Время завершения операции.

    • status.message
      строка

      Дополнительное сообщение о результате выполнения операции или причине ошибки.

    • status.phase
      строка

      Текущий статус выполнения операции. Возможные значения:

      • Succeeded — операция успешно выполнена;
      • Failed — операция завершилась ошибкой.

      Допустимые значения: Succeeded, Failed

User

Scope: Cluster

  • v1
  • v1alpha1

Содержит информацию о статическом пользователе.

Создание пользователя

  • spec
    объект

    Обязательный параметр

    • spec.email
      строка

      Обязательный параметр

      Email пользователя. Должен быть в нижнем регистре и не длиннее 150 байт (150 символов из латинских букв, цифр и знаков препинания): Dex называет объект с паролем пользователя по email, а имя объекта Kubernetes не длиннее 253 символов.

      Чтобы выдать пользователю права, укажите значение email в качестве имени субъекта User в RoleBinding или ClusterRoleBinding гранулярной ролевой модели.

      Длина: 1..150

      Пример:

      email: user@domain.com
      
    • spec.groups
      Параметр устарел
      массив строк

      Список групп, в которых у пользователя есть членство.

      Т.к. параметр устарел, добавление пользователя в группы теперь осуществляется через ресурс Group.

    • spec.password
      строка

      Обязательный параметр

      Хеш пароля пользователя в явном виде или закодированный в Base64.

      Для получения хеша пароля в Base64 можно воспользоваться командой echo -n '<PASSWORD>' | htpasswd -BinC 10 "" | cut -d: -f2 | tr -d '\n' | base64 -w0; echo. Также можно создать пользователя командой d8 iam user create, которая вычисляет хеш локально.

      Важно. Если пароль не соответствует правилам сложности парольной политики, пользователь должен сменить его при первом входе. Чтобы пользователь сменил пароль при первом входе в любом случае, укажите requirePasswordChangeOnFirstLogin.

      Важно. Поле неизменяемо после создания User. Изменение пароля через kubectl edit не обновляет учётные данные в Dex и будет отклонено. Для сброса пароля используйте ресурс UserOperation (или d8 iam user).

      Если у вызывающей стороны нет прав на подресурс users/sensitive, API возвращает <omitted> вместо значения.

      Пример:

      password: JDJ5JDEwJGRNWGVGUVBkdUdYYVMyWDFPcGdZdk9HSy81LkdsNm5sdU9mUkhnNWlQdDhuSlh6SzhpeS5H
      
    • spec.requirePasswordChangeOnFirstLogin
      булевый

      Требовать от пользователя сменить пароль при первом входе.

      Действует, когда модуль создаёт учётные данные пользователя в Dex из password: при создании User, при его повторном создании и после восстановления из резервной копии.

      Задаётся только при создании User. Добавить, изменить или удалить поле позже нельзя.

    • spec.ttl
      строка

      Время жизни учетной записи пользователя (TTL).

      Задаётся в виде строки с указанием часов и минут: 30m, 1h, 2h30m, 24h.

      Указать TTL можно только 1 раз. При повторном изменении TTL, дата expireAt не обновляется.

      Шаблон: ^([0-9]+h([0-9]+m)?|[0-9]+m)$

      Пример:

      ttl: 24h
      
    • spec.userID
      Параметр устарел
      строка

      Устарел и игнорируется. Идентификатором пользователя в Dex служит metadata.name объекта User.

  • status
    объект
    • status.expireAt
      строка

      Время окончания действия учётной записи. Задаётся, только если указан spec.ttl. В это время User удаляется и исключается из всех Group.

    • status.groups
      массив строк

      Список групп, в которых у пользователя есть членство.

    • status.lock
      объект

      Информация о блокировке учётной записи пользователя. Если объект присутствует и state: true, пользователь не может аутентифицироваться до указанного времени или пока блокировка не будет снята администратором.

      Действия с учётной записью (блокировка, разблокировка, сброс пароля, принудительная смена пароля, сброс 2FA, выход) выполняются через ресурс UserOperation. Блокировка, сброс пароля, сброс 2FA и выход сразу завершают сессии пользователя. После сброса пароля или принудительной смены пароля при следующем успешном входе пользователю показывается форма смены пароля. Секрет 2FA пользователя удаляет только сброс 2FA.

      • status.lock.message
        строка

        Человекочитаемое описание причины блокировки.

      • status.lock.reason
        строка

        Машиночитаемая причина блокировки учётной записи. Используется для проверки политик и автоматических обработчиков.

        Допустимые значения: PasswordPolicyLockout, LockedByAdministrator

      • status.lock.state
        булевый

        Показывает, заблокирован ли в данный момент пользователь.

        • true — учётная запись заблокирована.
        • false — учётная запись активна.
      • status.lock.until
        строка

        Время (в формате RFC3339), до которого учётная запись будет оставаться заблокированной. После наступления этого времени блокировка снимается автоматически.

Устаревший ресурс. Поддержка ресурса может быть исключена в следующих версиях.

Содержит информацию о статическом пользователе.

Создание пользователя

  • spec
    объект

    Обязательный параметр

    • spec.email
      строка

      Обязательный параметр

      Email пользователя. Должен быть в нижнем регистре и не длиннее 150 байт (150 символов из латинских букв, цифр и знаков препинания): Dex называет объект с паролем пользователя по email, а имя объекта Kubernetes не длиннее 253 символов.

      Чтобы выдать пользователю права, укажите значение email в качестве имени субъекта User в RoleBinding или ClusterRoleBinding гранулярной ролевой модели.

      Важно! Email-адреса проверяются на уникальность без учёта регистра. Dex автоматически преобразует email-адреса в нижний регистр при аутентификации. Для новых пользователей заглавные буквы в email-адресах не допускаются. Существующие пользователи с заглавными буквами в email могут быть обновлены без изменения поля email.

      Длина: 1..150

      Пример:

      email: user@domain.com
      
    • spec.groups
      Параметр устарел
      массив строк

      Список групп, в которых у пользователя есть членство.

      Т.к. параметр устарел, добавление пользователя в группы теперь осуществляется через ресурс Group.

    • spec.password
      строка

      Обязательный параметр

      Хеш пароля пользователя в явном виде или закодированный в Base64.

      Для получения хеша пароля в Base64 можно воспользоваться командой echo -n '<PASSWORD>' | htpasswd -BinC 10 "" | cut -d: -f2 | tr -d '\n' | base64 -w0; echo. Также можно создать пользователя командой d8 iam user create, которая вычисляет хеш локально.

      Важно. Если пароль не соответствует правилам сложности парольной политики, пользователь должен сменить его при первом входе. Чтобы пользователь сменил пароль при первом входе в любом случае, укажите requirePasswordChangeOnFirstLogin.

      Важно. Поле неизменяемо после создания User. Изменение пароля через kubectl edit не обновляет учётные данные в Dex и будет отклонено. Для сброса пароля используйте ресурс UserOperation (или d8 iam user).

      Если у вызывающей стороны нет прав на подресурс users/sensitive, API возвращает <omitted> вместо значения.

      Пример:

      password: JDJ5JDEwJGRNWGVGUVBkdUdYYVMyWDFPcGdZdk9HSy81LkdsNm5sdU9mUkhnNWlQdDhuSlh6SzhpeS5H
      
    • spec.requirePasswordChangeOnFirstLogin
      булевый

      Требовать от пользователя сменить пароль при первом входе.

      Действует, когда модуль создаёт учётные данные пользователя в Dex из password: при создании User, при его повторном создании и после восстановления из резервной копии.

      Задаётся только при создании User. Добавить, изменить или удалить поле позже нельзя.

    • spec.ttl
      строка

      Время жизни учетной записи пользователя (TTL).

      Задается в виде строки с указанием часов и минут: 30m, 1h, 2h30m, 24h.

      Указать TTL можно только 1 раз. При повторном изменении TTL дата expireAt не обновляется.

      Шаблон: ^([0-9]+h([0-9]+m)?|[0-9]+m)$

      Пример:

      ttl: 24h
      
    • spec.userID
      строка

      Устарел и игнорируется. Идентификатором пользователя в Dex служит metadata.name объекта User.

      Пример:

      userID: '08a8684b-db88-4b73-90a9-3cd1661f5466'
      
  • status
    объект
    • status.expireAt
      строка

      Время окончания действия учётной записи. Задаётся, только если указан spec.ttl. В это время User удаляется и исключается из всех Group.

    • status.groups
      массив строк

      Список групп, в которых у пользователя есть членство.

    • status.lock
      объект

      Информация о блокировке учётной записи пользователя. Если объект присутствует и state: true, пользователь не может аутентифицироваться до указанного времени или пока блокировка не будет снята администратором.

      Действия с учётной записью (блокировка, разблокировка, сброс пароля, принудительная смена пароля, сброс 2FA, выход) выполняются через ресурс UserOperation. Блокировка, сброс пароля, сброс 2FA и выход сразу завершают сессии пользователя. После сброса пароля или принудительной смены пароля при следующем успешном входе пользователю показывается форма смены пароля. Секрет 2FA пользователя удаляет только сброс 2FA.

      • status.lock.message
        строка

        Человекочитаемое описание причины блокировки.

      • status.lock.reason
        строка

        Машиночитаемая причина блокировки учётной записи. Используется для проверки политик и автоматических обработчиков.

        Допустимые значения: PasswordPolicyLockout, LockedByAdministrator

      • status.lock.state
        булевый

        Показывает, заблокирован ли в данный момент пользователь.

        • true — учётная запись заблокирована.
        • false — учётная запись активна.
      • status.lock.until
        строка

        Время (в формате RFC3339), до которого учётная запись будет оставаться заблокированной. После наступления этого времени блокировка снимается автоматически.