Deckhouse Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.
Стадия жизненного цикла модуля: General Availability
DexAuthenticator
Short names: dex-auth
Scope: Namespaced
- v1
- v2alpha1
- v1alpha1
При появлении DexAuthenticator в неймспейсе будут созданы:
- Deployment с OAuth2-Proxy и Redis;
- Сервис (Service), ведущий на OAuth2-Proxy;
- Ingress-ресурс, который принимает запросы по адресу
https://<applicationDomain>/dex-authenticatorи отправляет их в сторону сервиса; - HTTPRoute (опционально), который принимает запросы по адресу
https://<applicationDomain>/dex-authenticatorи отправляет их в сторону сервиса; - Секреты, необходимые для доступа к Dex.
Внимание. DexAuthenticator работает только по HTTPS. Ingress приложения должен иметь настроенный TLS.
Внимание. При перезапуске пода с OAuth2-Proxy, с помощью refresh-токена в память Redis будут получены и сохранены актуальные Access Token и ID Token.
Имя DexAuthenticator должно быть DNS-меткой по RFC 1035 длиной не более 63 символов: начинаться со строчной латинской буквы и содержать только строчные латинские буквы, цифры и дефисы. Имя входит в имя Service и в значения лейблов создаваемых объектов.
Примеры:
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
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
- объект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 будет создан отдельный 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’ы пользователей, которым разрешено проходить аутентификацию.
Проверяется при входе и при каждом обновлении refresh-токена. Изменение списка запрещает дальнейшее обновление сессий, чей email больше не входит в список.
По умолчанию разрешено всем пользователям.
Значения не должны содержать переводы строк.
По умолчанию:
All emails are allowed.- строкаЭлемент массива
Шаблон:
^[^\r\n]*$Максимальная длина:
320
- массив строкspec.allowedGroups
Группы, пользователям которых разрешено проходить аутентификацию.
Проверяется при входе и при каждом обновлении refresh-токена. Изменение списка запрещает дальнейшее обновление сессий, чьи сохранённые группы больше с ним не пересекаются.
По умолчанию разрешено всем группам.
Значения не должны содержать переводы строк.
По умолчанию:
All groups are allowed.- строкаЭлемент массива
Шаблон:
^[^\r\n]*$Максимальная длина:
512
- строка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
Включает режим высокой доступности для экземпляра
dex-authenticator.При включении этого режима будет развернуто несколько реплик подов для обеспечения отказоустойчивости.
По умолчанию:
false - строкаspec.keepUsersLoggedInFor
Максимальное время бездействия пользователя, в течение которого его сессия остаётся активной.
Задаётся в виде строки с целым числом часов, минут и секунд, указанных именно в таком порядке:
30m,20s,2h30m10s,24h.Указанное значение не может быть меньше или равно значению параметра
idTokenTTL, заданному в настройках модуля. Если указать значение, меньшее или равноеidTokenTTL, фактическое время до выхода пользователя из системы составитidTokenTTL + 1s.Чтобы пользователь выходил из системы раньше значения
idTokenTTLпо умолчанию, уменьшите также значение параметраidTokenTTLв настройках модуля.По умолчанию:
168hШаблон:
^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$Пример:
keepUsersLoggedInFor: 24h - объектspec.nodeSelector
Определяет
nodeSelectorдля подовdex-authenticator.Формат: стандартный список nodeSelector. Поды инстанса унаследуют это поле как есть.
- объектspec.podMetadata
Дополнительные лейблы и аннотации для подов
dex-authenticator.- объектspec.podMetadata.annotations
Дополнительные аннотации для подов
dex-authenticator. - объектspec.podMetadata.labels
Дополнительные лейблы для подов
dex-authenticator.
- объектspec.resources
Ресурсы контейнеров (CPU/память) — requests/limits.
Если поле задано, применяются указанные значения, а VPA для этого экземпляра отключается. Если поле не задано, поведение не меняется — при включённом модуле VPA ресурсы управляются VPA, при выключенном — используются значения по умолчанию.
Ресурсы можно задать напрямую для контейнера
dex-authenticator(для обратной совместимости) либо во вложенных объектах — отдельно для каждого контейнера.- объектspec.resources.limits
Верхняя граница ресурсов контейнера
dex-authenticator(CPU/память). Поле поддерживается для обратной совместимости.Значения указываются в формате Kubernetes, например:
200m,256Mi. - объектspec.resources.redis
Ресурсы контейнера
redis(CPU/память) — requests/limits.- объектspec.resources.redis.limits
Верхняя граница ресурсов контейнера
redis(CPU/память).Значения указываются в формате Kubernetes, например:
200m,256Mi. - объектspec.resources.redis.requests
Гарантированно выделяемые ресурсы контейнера
redis(CPU/память).Значения указываются в формате Kubernetes, например:
100m,128Mi.
- объектspec.resources.requests
Гарантированно выделяемые ресурсы контейнера
dex-authenticator(CPU/память). Поле поддерживается для обратной совместимости.Значения указываются в формате Kubernetes, например:
100m,128Mi.
- булевый
Флаг, который отвечает за отправку конечному приложению заголовка
Authorization: Bearer.При его включении в заголовке передаётся подписанный Dex ID-токен (
id_token), содержащий email пользователя, его имя и список групп. Это единственный способ передать приложению группы пользователя через DexAuthenticator: отдельный заголовокX-Auth-Request-Groupsс группами не передаётся.Внимание. Включайте, только если приложение может обрабатывать такой заголовок.
При включении
sendAuthorizationHeader: trueукажите все необходимые заголовки в Ingress-ресурсе приложения (если приложение публикуется через Ingress) или в ресурсе HTTPRoute (если приложение публикуется через ALBInstance или ClusterALBInstance модуляalb).Также, если приложение публикуется через Ingress-ресурс, при включении
sendAuthorizationHeader: trueувеличьте размер буфера заголовков, так как JWT с большим числом групп может не поместиться в буфер по умолчанию.Подробнее об указании заголовков и увеличении буфера — в разделе «Как передать приложению логин и группы пользователя».
- строкаspec.signOutURL
URL для завершения сеанса аутентификации.
Используется в приложении для направления запросов на «Выход» (завершение сеанса). Для указанного URL будет создан отдельный Ingress-ресурс, запросы на который будут перенаправляться в
dex-authenticator.Значение не должно содержать переводы строк.
Шаблон:
^[^\r\n]*$Максимальная длина:
2048 - массив объектовspec.tolerations
Определяет
tolerationsдля подовdex-authenticator.Формат: стандартный список toleration. Поды инстанса унаследуют это поле как есть.
- строкаspec.tolerations.effect
Определяет, какому effect’у taint’а соответствует описываемый toleration. Пустой подразумевает соответствие любому effect.
Допустимые значения:
NoSchedule,PreferNoSchedule,NoExecute - строкаspec.tolerations.key
Определяет, какому ключу (key) taint’a соответствует описываемый toleration. Пустой подразумевает соответствие любому ключу.
Если ключ (key) не указан (пуст),
operatorдолжен бытьExists, что подразумевает соответствие любымvalueиkey. - строкаspec.tolerations.operator
Определяет отношение ключа (key) к значению (value) — должен ли ключ быть равен (
Equal) значению или допустимо существование ключа с любым значением.Указание
Existsозначает, что значение value может быть любым, чтобы под с указанным toleration был размещён на узле с соответствующим taint.По умолчанию:
EqualДопустимые значения:
Exists,Equal - целочисленныйspec.tolerations.tolerationSeconds
Определяет период времени в секундах, в течение которого планировщик должен ждать, прежде чем выселить (evict) под с узла, если toleration больше не соответствует taint (справедливо только для effect
NoExecute, иначе игнорируется).Если не установлено, тогда под не будет выселен с узла, если toleration больше не соответствует taint. Если установлен в ноль (или отрицателен), под будет выселен с узла немедленно, если toleration больше не соответствует taint.
По умолчанию используется значение «не установлено».
- строкаspec.tolerations.value
Значение, которому должен соответствовать toleration.
Должно быть пустым, если
operatorимеет параметрExists.
- массив строк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}$
- объектmetadata
- строкаmetadata.name
Максимальная длина:
63
- объектspec
Обязательный параметр
- массив строкspec.allowedEmails
Email’ы пользователей, которым разрешено проходить аутентификацию.
Проверяется при входе и при каждом обновлении refresh-токена. Изменение списка запрещает дальнейшее обновление сессий, чей email больше не входит в список.
По умолчанию разрешено всем пользователям.
Значения не должны содержать переводы строк.
По умолчанию:
All users are allowed.- строкаЭлемент массива
Шаблон:
^[^\r\n]*$Максимальная длина:
320
- массив строкspec.allowedGroups
Группы, пользователям которых разрешено проходить аутентификацию.
Проверяется при входе и при каждом обновлении refresh-токена. Изменение списка запрещает дальнейшее обновление сессий, чьи сохранённые группы больше с ним не пересекаются.
По умолчанию разрешено всем группам.
Значения не должны содержать переводы строк.
По умолчанию:
All groups are allowed.- строкаЭлемент массива
Шаблон:
^[^\r\n]*$Максимальная длина:
512
- массив объектов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 будет создан отдельный 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
Включает режим высокой доступности для экземпляра
dex-authenticator.При включении этого режима будет развернуто несколько реплик подов для обеспечения отказоустойчивости.
По умолчанию:
false - строкаspec.keepUsersLoggedInFor
Максимальное время бездействия пользователя, в течение которого его сессия остаётся активной.
Задаётся в виде строки с целым числом часов, минут и секунд, указанных именно в таком порядке:
30m,20s,2h30m10s,24h.Указанное значение не может быть меньше или равно значению параметра
idTokenTTL, заданному в настройках модуля. Если указать значение, меньшее или равноеidTokenTTL, фактическое время до выхода пользователя из системы составитidTokenTTL + 1s.Чтобы пользователь выходил из системы раньше значения
idTokenTTLпо умолчанию, уменьшите также значение параметраidTokenTTLв настройках модуля.По умолчанию:
168hШаблон:
^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$ - объектspec.nodeSelector
Определяет
nodeSelectorдля подовdex-authenticator.Формат: стандартный список nodeSelector. Поды инстанса унаследуют это поле как есть.
- объектspec.podMetadata
Дополнительные лейблы и аннотации для подов
dex-authenticator.- объектspec.podMetadata.annotations
Дополнительные аннотации для подов
dex-authenticator. - объектspec.podMetadata.labels
Дополнительные лейблы для подов
dex-authenticator.
- объектspec.resources
Ресурсы контейнеров (CPU/память) — requests/limits.
Если поле задано, применяются указанные значения, а VPA для этого экземпляра отключается. Если поле не задано, поведение не меняется — при включённом модуле VPA ресурсы управляются VPA, при выключенном — используются значения по умолчанию.
Ресурсы можно задать напрямую для контейнера
dex-authenticator(для обратной совместимости) либо во вложенных объектах — отдельно для каждого контейнера.- объектspec.resources.limits
Верхняя граница ресурсов контейнера
dex-authenticator(CPU/память). Поле поддерживается для обратной совместимости.Значения указываются в формате Kubernetes, например:
200m,256Mi. - объектspec.resources.redis
Ресурсы контейнера
redis(CPU/память) — requests/limits.- объектspec.resources.redis.limits
Верхняя граница ресурсов контейнера
redis(CPU/память).Значения указываются в формате Kubernetes, например:
200m,256Mi. - объектspec.resources.redis.requests
Гарантированно выделяемые ресурсы контейнера
redis(CPU/память).Значения указываются в формате Kubernetes, например:
100m,128Mi.
- объектspec.resources.requests
Гарантированно выделяемые ресурсы контейнера
dex-authenticator(CPU/память). Поле поддерживается для обратной совместимости.Значения указываются в формате Kubernetes, например:
100m,128Mi.
- булевый
Флаг, который отвечает за отправку конечному приложению заголовка
Authorization: Bearer.При его включении в заголовке передаётся подписанный Dex ID-токен (
id_token), содержащий email пользователя, его имя и список групп. Это единственный способ передать приложению группы пользователя через DexAuthenticator: отдельный заголовокX-Auth-Request-Groupsс группами не передаётся.Внимание. Включайте, только если приложение может обрабатывать такой заголовок.
При включении
sendAuthorizationHeader: trueукажите все необходимые заголовки в Ingress-ресурсе приложения (если приложение публикуется через Ingress) или в ресурсе HTTPRoute (если приложение публикуется через ALBInstance или ClusterALBInstance модуляalb).Также, если приложение публикуется через Ingress-ресурс, при включении
sendAuthorizationHeader: trueувеличьте размер буфера заголовков, так как JWT с большим числом групп может не поместиться в буфер по умолчанию.Подробнее об указании заголовков и увеличении буфера — в разделе «Как передать приложению логин и группы пользователя».
- массив объектовspec.tolerations
Определяет tolerations для подов
dex-authenticator.Формат: стандартный список toleration. Поды инстанса унаследуют это поле как есть.
- строкаspec.tolerations.effect
Определяет, какому effect’у taint’а соответствует описываемый toleration. Пустой подразумевает соответствие любому effect.
Допустимые значения:
NoSchedule,PreferNoSchedule,NoExecute - строкаspec.tolerations.key
Определяет, какому ключу (key) taint’a соответствует описываемый toleration. Пустой подразумевает соответствие любому ключу.
Если ключ (key) не указан (пуст),
operatorдолжен бытьExists, что подразумевает соответствие любымvalueиkey. - строкаspec.tolerations.operator
Определяет отношение ключа (key) к значению (value) — должен ли ключ быть равен (
Equal) значению или допустимо существование ключа с любым значением.Указание
Existsозначает, что значение value может быть любым, чтобы под с указанным toleration был размещён на узле с соответствующим taint.По умолчанию:
EqualДопустимые значения:
Exists,Equal - целочисленныйspec.tolerations.tolerationSeconds
Определяет период времени в секундах, в течение которого планировщик должен ждать, прежде чем выселить (evict) под с узла, если toleration больше не соответствует taint (справедливо только для effect
NoExecute, иначе игнорируется).Если не установлено, тогда под не будет выселен с узла, если toleration больше не соответствует taint. Если установлен в ноль (или отрицателен), под будет выселен с узла немедленно, если toleration больше не соответствует taint.
По умолчанию используется значение «не установлено».
- строкаspec.tolerations.value
Значение, которому должен удовлетворять toleration.
Должно быть пустым, если
operatorимеет параметрExists.
Устаревший ресурс. Поддержка ресурса может быть исключена в следующих версиях.
При появлении DexAuthenticator в неймспейсе будут созданы:
- Deployment с OAuth2-Proxy и Redis;
- Сервис (Service), ведущий на OAuth2-Proxy;
- Ingress-ресурс, который принимает запросы по адресу
https://<applicationDomain>/dex-authenticatorи отправляет их в сторону сервиса; - HTTPRoute (опционально), который принимает запросы по адресу
https://<applicationDomain>/dex-authenticatorи отправляет их в сторону сервиса; - Секреты, необходимые для доступа к Dex.
Внимание. DexAuthenticator работает только по HTTPS. Ingress приложения должен иметь настроенный TLS.
Внимание. При перезапуске пода с OAuth2-Proxy, с помощью refresh-токена в память Redis будут получены и сохранены актуальные Access Token и ID Token.
Имя DexAuthenticator должно быть DNS-меткой по RFC 1035 длиной не более 63 символов: начинаться со строчной латинской буквы и содержать только строчные латинские буквы, цифры и дефисы. Имя входит в имя Service и в значения лейблов создаваемых объектов.
Примеры:
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
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
- объект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 будет создан отдельный 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’ы пользователей, которым разрешено проходить аутентификацию.
Проверяется при входе и при каждом обновлении refresh-токена. Изменение списка запрещает дальнейшее обновление сессий, чей email больше не входит в список.
По умолчанию разрешено всем пользователям.
Значения не должны содержать переводы строк.
По умолчанию:
All emails are allowed.- строкаЭлемент массива
Шаблон:
^[^\r\n]*$Максимальная длина:
320
- массив строкspec.allowedGroups
Группы, пользователям которых разрешено проходить аутентификацию.
Проверяется при входе и при каждом обновлении refresh-токена. Изменение списка запрещает дальнейшее обновление сессий, чьи сохранённые группы больше с ним не пересекаются.
По умолчанию разрешено всем группам.
Значения не должны содержать переводы строк.
По умолчанию:
All groups are allowed.- строкаЭлемент массива
Шаблон:
^[^\r\n]*$Максимальная длина:
512
- строка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
Включает режим высокой доступности для экземпляра
dex-authenticator.При включении этого режима будет развернуто несколько реплик подов для обеспечения отказоустойчивости.
По умолчанию:
false - строкаspec.keepUsersLoggedInFor
Максимальное время бездействия пользователя, в течение которого его сессия остаётся активной.
Задаётся в виде строки с целым числом часов, минут и секунд, указанных именно в таком порядке:
30m,20s,2h30m10s,24h.Указанное значение не может быть меньше или равно значению параметра
idTokenTTL, заданному в настройках модуля. Если указать значение, меньшее или равноеidTokenTTL, фактическое время до выхода пользователя из системы составитidTokenTTL + 1s.Чтобы пользователь выходил из системы раньше значения
idTokenTTLпо умолчанию, уменьшите также значение параметраidTokenTTLв настройках модуля.По умолчанию:
168hШаблон:
^([0-9]{1,5}h)?([0-9]{1,7}m)?([0-9]{1,9}s)?$Пример:
keepUsersLoggedInFor: 24h - объектspec.nodeSelector
Определяет
nodeSelectorдля подовdex-authenticator.Формат: стандартный список nodeSelector. Поды инстанса унаследуют это поле как есть.
- объектspec.podMetadata
Дополнительные лейблы и аннотации для подов
dex-authenticator.- объектspec.podMetadata.annotations
Дополнительные аннотации для подов
dex-authenticator. - объектspec.podMetadata.labels
Дополнительные лейблы для подов
dex-authenticator.
- объектspec.resources
Ресурсы контейнеров (CPU/память) — requests/limits.
Если поле задано, применяются указанные значения, а VPA для этого экземпляра отключается. Если поле не задано, поведение не меняется — при включённом модуле VPA ресурсы управляются VPA, при выключенном — используются значения по умолчанию.
Ресурсы можно задать напрямую для контейнера
dex-authenticator(для обратной совместимости) либо во вложенных объектах — отдельно для каждого контейнера.- объектspec.resources.limits
Верхняя граница ресурсов контейнера
dex-authenticator(CPU/память). Поле поддерживается для обратной совместимости.Значения указываются в формате Kubernetes, например:
200m,256Mi. - объектspec.resources.redis
Ресурсы контейнера
redis(CPU/память) — requests/limits.- объектspec.resources.redis.limits
Верхняя граница ресурсов контейнера
redis(CPU/память).Значения указываются в формате Kubernetes, например:
200m,256Mi. - объектspec.resources.redis.requests
Гарантированно выделяемые ресурсы контейнера
redis(CPU/память).Значения указываются в формате Kubernetes, например:
100m,128Mi.
- объектspec.resources.requests
Гарантированно выделяемые ресурсы контейнера
dex-authenticator(CPU/память). Поле поддерживается для обратной совместимости.Значения указываются в формате Kubernetes, например:
100m,128Mi.
- булевый
Флаг, который отвечает за отправку конечному приложению заголовка
Authorization: Bearer.При его включении в заголовке передаётся подписанный Dex ID-токен (
id_token), содержащий email пользователя, его имя и список групп. Это единственный способ передать приложению группы пользователя через DexAuthenticator: отдельный заголовокX-Auth-Request-Groupsс группами не передаётся.Внимание. Включайте, только если приложение может обрабатывать такой заголовок.
При включении
sendAuthorizationHeader: trueукажите все необходимые заголовки в Ingress-ресурсе приложения (если приложение публикуется через Ingress) или в ресурсе HTTPRoute (если приложение публикуется через ALBInstance или ClusterALBInstance модуляalb).Также, если приложение публикуется через Ingress-ресурс, при включении
sendAuthorizationHeader: trueувеличьте размер буфера заголовков, так как JWT с большим числом групп может не поместиться в буфер по умолчанию.Подробнее об указании заголовков и увеличении буфера — в разделе «Как передать приложению логин и группы пользователя».
- строкаspec.signOutURL
URL для завершения сеанса аутентификации.
Используется в приложении для направления запросов на «Выход» (завершение сеанса). Для указанного URL будет создан отдельный Ingress-ресурс, запросы на который будут перенаправляться в
dex-authenticator.Значение не должно содержать переводы строк.
Шаблон:
^[^\r\n]*$Максимальная длина:
2048 - массив объектовspec.tolerations
Определяет
tolerationsдля подовdex-authenticator.Формат: стандартный список toleration. Поды инстанса унаследуют это поле как есть.
- строкаspec.tolerations.effect
Определяет, какому effect’у taint’а соответствует описываемый toleration. Пустой подразумевает соответствие любому effect.
Допустимые значения:
NoSchedule,PreferNoSchedule,NoExecute - строкаspec.tolerations.key
Определяет, какому ключу (key) taint’a соответствует описываемый toleration. Пустой подразумевает соответствие любому ключу.
Если ключ (key) не указан (пуст),
operatorдолжен бытьExists, что подразумевает соответствие любымvalueиkey. - строкаspec.tolerations.operator
Определяет отношение ключа (key) к значению (value) — должен ли ключ быть равен (
Equal) значению или допустимо существование ключа с любым значением.Указание
Existsозначает, что значение value может быть любым, чтобы под с указанным toleration был размещён на узле с соответствующим taint.По умолчанию:
EqualДопустимые значения:
Exists,Equal - целочисленныйspec.tolerations.tolerationSeconds
Определяет период времени в секундах, в течение которого планировщик должен ждать, прежде чем выселить (evict) под с узла, если toleration больше не соответствует taint (справедливо только для effect
NoExecute, иначе игнорируется).Если не установлено, тогда под не будет выселен с узла, если toleration больше не соответствует taint. Если установлен в ноль (или отрицателен), под будет выселен с узла немедленно, если toleration больше не соответствует taint.
По умолчанию используется значение «не установлено».
- строкаspec.tolerations.value
Значение, которому должен соответствовать toleration.
Должно быть пустым, если
operatorимеет параметрExists.
- массив строк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.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-аутентификация.
Значения не должны содержать переводы строк.
- строкаЭлемент массива
Шаблон:
^[^\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.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-аутентификация.
Значения не должны содержать переводы строк.
- строкаЭлемент массива
Шаблон:
^[^\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, если задан хотя бы один из списков, и сужает claimgroupsдо пересечения со списком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
Имена групп, которые провайдер может утвердить.
Применяется поверх типоспецифичных фильтров групп (
allowedGroups,groups,teams,orgs[].teams), если они есть.- строкаЭлемент массива
- объектspec.bitbucketCloud
Параметры провайдера Bitbucket Cloud (можно указывать, только если
type: BitbucketCloud).- строкаspec.bitbucketCloud.clientID
Обязательный параметр
ID приложения, созданного в Bitbucket Cloud (Key).
- строкаspec.bitbucketCloud.clientSecret
Обязательный параметр
Secret приложения, созданного в Bitbucket Cloud (Secret).
- булевый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).
- булевыйspec.crowd.enableBasicAuth
Включает базовую аутентификацию в API-сервере Kubernetes по логину и паролю пользователя Crowd.
Работает только при включённом параметре
apiserver.publishAPIмодуляcontrol-plane-manager. ПараметрenableBasicAuthможет быть включён только в одном DexProvider кластера.Базовая аутентификация выполняется в обход
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.
- массив объектов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).
- массив строкspec.gitlab.groups
Список-фильтр групп (пути групп — path, а не имена), допустимых для приема из GitLab.
Токен пользователя будет содержать пересечение множеств групп из GitLab и групп из этого списка. Если множество окажется пустым, авторизация не будет считаться успешной.
Если параметр не указан, токен пользователя будет содержать все группы из GitLab.
- строкаspec.gitlab.rootCAData
Цепочка сертификатов в формате PEM для проверки подлинности провайдера.
Пример:
rootCAData: | -----BEGIN CERTIFICATE----- MIIFaDC... -----END CERTIFICATE----- - булевыйspec.gitlab.useLoginAsID
Позволяет вместо использования внутреннего GitLab ID, использовать имя пользователя.
- объектspec.ldap
Параметры провайдера LDAP.
- строкаspec.ldap.bindDN
Путь до сервис-аккаунта приложения в LDAP.
Пример:
bindDN: uid=serviceaccount,cn=users,dc=example,dc=com - строкаspec.ldap.bindPW
Пароль сервисной учётной записи, заданной в
bindDN.Пример:
bindPW: password - булевыйspec.ldap.enableBasicAuth
Включает базовую аутентификацию в API-сервере Kubernetes по логину и паролю пользователя LDAP.
Работает только при включённом параметре
apiserver.publishAPIмодуляcontrol-plane-manager. ПараметрenableBasicAuthможет быть включён только в одном DexProvider кластера.Успешная проверка кешируется вместе с группами пользователя на 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.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.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-провайдере.
- булевый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. При значенииtransientIdP возвращает новый 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, если задан хотя бы один из списков, и сужает claimgroupsдо пересечения со списком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
Имена групп, которые провайдер может утвердить.
Применяется поверх типоспецифичных фильтров групп (
allowedGroups,groups,teams,orgs[].teams), если они есть.- строкаЭлемент массива
- объектspec.bitbucketCloud
Параметры провайдера Bitbucket Cloud (можно указывать, только если
type: BitbucketCloud).- строкаspec.bitbucketCloud.clientID
Обязательный параметр
ID приложения, созданного в Bitbucket Cloud (Key).
- строкаspec.bitbucketCloud.clientSecret
Обязательный параметр
Secret приложения, созданного в Bitbucket Cloud (Secret).
- булевый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).
- булевыйspec.crowd.enableBasicAuth
Включает базовую аутентификацию в API-сервере Kubernetes по логину и паролю пользователя Crowd.
Работает только при включённом параметре
apiserver.publishAPIмодуляcontrol-plane-manager. ПараметрenableBasicAuthможет быть включён только в одном DexProvider кластера.Базовая аутентификация выполняется в обход
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.
- массив объектов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).
- массив строкspec.gitlab.groups
Список-фильтр групп (пути групп — path, а не имена), допустимых для приема из GitLab.
Токен пользователя будет содержать пересечение множеств групп из GitLab и групп из этого списка. Если множество окажется пустым, авторизация не будет считаться успешной.
Если параметр не указан, токен пользователя будет содержать все группы из GitLab.
- строкаspec.gitlab.rootCAData
Цепочка сертификатов в формате PEM для проверки подлинности провайдера.
Пример:
rootCAData: | -----BEGIN CERTIFICATE----- MIIFaDC... -----END CERTIFICATE----- - булевыйspec.gitlab.useLoginAsID
Позволяет вместо использования внутреннего GitLab ID, использовать имя пользователя.
- объектspec.ldap
Параметры провайдера LDAP.
- строкаspec.ldap.bindDN
Путь до сервис-аккаунта приложения в LDAP.
Пример:
bindDN: uid=serviceaccount,cn=users,dc=example,dc=com - строкаspec.ldap.bindPW
Пароль сервисной учётной записи, заданной в
bindDN.Пример:
bindPW: password - булевыйspec.ldap.enableBasicAuth
Включает базовую аутентификацию в API-сервере Kubernetes по логину и паролю пользователя LDAP.
Работает только при включённом параметре
apiserver.publishAPIмодуляcontrol-plane-manager. ПараметрenableBasicAuthможет быть включён только в одном DexProvider кластера.Успешная проверка кешируется вместе с группами пользователя на 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.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.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-провайдере.
- булевый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. При значенииtransientIdP возвращает новый 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, которым разрешено обменивать токены через этот провайдер. Остальным клиентам отказывается до проверки токена.
- объект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и значения строкового claimclaim. Префикс обязателен и заканчивается двоеточием.- строка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и значения строкового claimclaim. Префикс обязателен и заканчивается двоеточием.- строка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.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
- браузер, выполнивший вход в Dex при включённых
сессиях Dex, вместе с приложениями, refresh-токены
которых привязаны к его сессии (объекты DexAuthenticator и объекты DexClient
с
- булевыйstatus.sessionsTruncated
Признак того, что устройств у учётной записи больше, чем в
sessions. Устройства с самой давней активностью в список не попали. - объектstatus.twoFactor
Состояние 2FA (TOTP) учётной записи в Dex, без секретов.
Заполняется после первого входа учётной записи через Dex.
- булевыйstatus.twoFactor.confirmed
Ввёл ли пользователь код для секрета TOTP.
До этого при входе снова показывается QR-код. UserOperation с типом
Reset2FAудаляет секрет. - булевыйstatus.twoFactor.enrolled
Хранит ли Dex секрет TOTP для учётной записи.
Dex создаёт секрет, когда показывает пользователю QR-код при входе.
- строка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— администратором (например, через CLId8 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 и claimd8_gidтокенов, выданных вместе с этим refresh-токеном. Остальные устройства сохраняют свои сессии. Операция завершается с ошибкой, если у пользователя нет такого refresh-токена.Шаблон:
^[a-z2-7]{1,64}$ - строкаspec.logout.session
Идентификатор сессии браузера, которую нужно завершить (claim
sidтокенов, выданных в ней), вместе с refresh-токенами, выданными в этой сессии. Операция завершается с ошибкой, если у пользователя нет такой сессии.Шаблон:
^[a-z2-7]{1,64}$
- объектspec.resetPassword
Параметры операции по сбросу пароля.
- строкаspec.resetPassword.newPasswordHash
Bcrypt-хеш нового пароля без кодирования в Base64.
- объектspec.target
Идентификатор учётной записи внешнего провайдера аутентификации по email.
Операции
Lock,UnlockиLogoutдля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-ldapconnectorID: 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);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.
- строка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 пользователя. Должен быть в нижнем регистре.
Чтобы выдать пользователю права, укажите значение
emailв качестве имени субъектаUserв RoleBinding или ClusterRoleBinding гранулярной ролевой модели.Пример:
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, которая вычисляет хеш локально.Важно. Поле неизменяемо после создания User. Изменение пароля через
kubectl editне обновляет учётные данные в Dex и будет отклонено. Для сброса пароля используйте ресурс UserOperation (илиd8 iam user).Пример:
password: JDJ5JDEwJGRNWGVGUVBkdUdYYVMyWDFPcGdZdk9HSy81LkdsNm5sdU9mUkhnNWlQdDhuSlh6SzhpeS5H - строка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 пользователя. Должен быть в нижнем регистре.
Чтобы выдать пользователю права, укажите значение
emailв качестве имени субъектаUserв RoleBinding или ClusterRoleBinding гранулярной ролевой модели.Важно! Email-адреса проверяются на уникальность без учёта регистра. Dex автоматически преобразует email-адреса в нижний регистр при аутентификации. Для новых пользователей заглавные буквы в email-адресах не допускаются. Существующие пользователи с заглавными буквами в email могут быть обновлены без изменения поля email.
Пример:
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, которая вычисляет хеш локально.Важно. Если используется политика паролей с контролем сложности выше
None, пользователь будет обязан сменить установленный таким образом пароль после первого успешного входа в систему.Важно. Поле неизменяемо после создания User. Изменение пароля через
kubectl editне обновляет учётные данные в Dex и будет отклонено. Для сброса пароля используйте ресурс UserOperation (илиd8 iam user).Пример:
password: JDJ5JDEwJGRNWGVGUVBkdUdYYVMyWDFPcGdZdk9HSy81LkdsNm5sdU9mUkhnNWlQdDhuSlh6SzhpeS5H - строка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), до которого учётная запись будет оставаться заблокированной. После наступления этого времени блокировка снимается автоматически.