dex README

The project's README from github.com/dexidp/dex. As one markdown file: README.md.

dex - A federated OpenID Connect provider

GitHub Workflow Status OpenSSF Scorecard OpenSSF Best Practices Go Report Card LFX Health Score

logo

Dex is an identity service that uses OpenID Connect to drive authentication for other apps.

Dex acts as a portal to other identity providers through "connectors." This lets dex defer authentication to LDAP servers, SAML providers, or established identity providers like GitHub, Google, and Active Directory. Clients write their authentication logic once to talk to dex, then dex handles the protocols for a given backend.

ID Tokens

ID Tokens are an OAuth2 extension introduced by OpenID Connect and dex's primary feature. ID Tokens are JSON Web Tokens (JWTs) signed by dex and returned as part of the OAuth2 response that attests to the end user's identity. An example JWT might look like:

eyJhbGciOiJSUzI1NiIsImtpZCI6IjlkNDQ3NDFmNzczYjkzOGNmNjVkZDMyNjY4NWI4NjE4MGMzMjRkOTkifQ.eyJpc3MiOiJodHRwOi8vMTI3LjAuMC4xOjU1NTYvZGV4Iiwic3ViIjoiQ2djeU16UXlOelE1RWdabmFYUm9kV0kiLCJhdWQiOiJleGFtcGxlLWFwcCIsImV4cCI6MTQ5Mjg4MjA0MiwiaWF0IjoxNDkyNzk1NjQyLCJhdF9oYXNoIjoiYmk5NmdPWFpTaHZsV1l0YWw5RXFpdyIsImVtYWlsIjoiZXJpYy5jaGlhbmdAY29yZW9zLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJncm91cHMiOlsiYWRtaW5zIiwiZGV2ZWxvcGVycyJdLCJuYW1lIjoiRXJpYyBDaGlhbmcifQ.OhROPq_0eP-zsQRjg87KZ4wGkjiQGnTi5QuG877AdJDb3R2ZCOk2Vkf5SdP8cPyb3VMqL32G4hLDayniiv8f1_ZXAde0sKrayfQ10XAXFgZl_P1yilkLdknxn6nbhDRVllpWcB12ki9vmAxklAr0B1C4kr5nI3-BZLrFcUR5sQbxwJj4oW1OuG6jJCNGHXGNTBTNEaM28eD-9nhfBeuBTzzO7BKwPsojjj4C9ogU4JQhGvm_l4yfVi0boSx8c0FX3JsiB0yLa1ZdJVWVl9m90XmbWRSD85pNDQHcWZP9hR6CMgbvGkZsgjG32qeRwUL_eNkNowSBNWLrGNPoON1gMg

ID Tokens contains standard claims assert which client app logged the user in, when the token expires, and the identity of the user.

{
  "iss": "http://127.0.0.1:5556/dex",
  "sub": "CgcyMzQyNzQ5EgZnaXRodWI",
  "aud": "example-app",
  "exp": 1492882042,
  "iat": 1492795642,
  "at_hash": "bi96gOXZShvlWYtal9Eqiw",
  "email": "[email protected]",
  "email_verified": true,
  "groups": [
    "admins",
    "developers"
  ],
  "name": "Jane Doe"
}

Because these tokens are signed by dex and contain standard-based claims other services can consume them as service-to-service credentials. Systems that can already consume OpenID Connect ID Tokens issued by dex include:

For details on how to request or validate an ID Token, see "Writing apps that use dex".

Kubernetes and Dex

Dex runs natively on top of any Kubernetes cluster using Custom Resource Definitions and can drive API server authentication through the OpenID Connect plugin. Clients, such as kubelogin and kubectl, can act on behalf of users who can login to the cluster through any identity provider dex supports.

Connectors

When a user logs in through dex, the user's identity is usually stored in another user-management system: a LDAP directory, a GitHub org, etc. Dex acts as a shim between a client app and the upstream identity provider. The client only needs to understand OpenID Connect to query dex, while dex implements an array of protocols for querying other user-management systems.

A "connector" is a strategy used by dex for authenticating a user against another identity provider. Dex implements connectors that target specific platforms such as GitHub, LinkedIn, and Microsoft as well as established protocols like LDAP and SAML.

Depending on the connectors limitations in protocols can prevent dex from issuing refresh tokens or returning group membership claims. For example, because SAML doesn't provide a non-interactive way to refresh assertions, if a user logs in through the SAML connector dex won't issue a refresh token to its client. Refresh token support is required for clients that require offline access, such as kubectl.

Dex implements the following connectors:

Name supports refresh tokens supports groups claim supports preferred_username claim status notes
LDAP yes yes yes stable
GitHub yes yes yes stable
SAML 2.0 no yes no stable WARNING: Unmaintained and likely vulnerable to auth bypasses (#1884)
GitLab yes yes yes beta
OpenID Connect yes yes yes beta Includes Salesforce, Azure, etc.
OAuth 2.0 no yes yes alpha
Google yes yes yes alpha
LinkedIn yes no no beta
Microsoft yes yes no beta
AuthProxy no yes no alpha Authentication proxies such as Apache2 mod_auth, etc.
Bitbucket Cloud yes yes no alpha
OpenShift yes yes no alpha
Atlassian Crowd yes yes yes * beta preferred_username claim must be configured through config
Gitea yes no yes beta
OpenStack Keystone yes yes no alpha

Stable, beta, and alpha are defined as:

All changes or deprecations of connector features will be announced in the release notes.

Documentation

See the official documentation for getting started, configuration, and usage guides.

Reporting a vulnerability

Please see our security policy for details about reporting vulnerabilities.

Getting help

Contributing

Please see CONTRIBUTING.md for development setup, guidelines, and how to submit pull requests.

License

The project is licensed under the Apache License, Version 2.0.

dex (dexidp/dex)

Searching Database…

11.2K ·GitHub
Что это такое?Dex — это сервис идентификации, который управляет аутентификацией для других приложений по протоколу OpenID Connect. Через подключаемые 'коннекторы' он передаёт вход в LDAP, SAML или провайдерам вроде GitHub и Google, поэтому клиентам достаточно один раз написать логику аутентификации.
Так dex — это полноценный продукт для управления учётными записями или прослойка перед провайдерами, которые у меня уже есть?Это федеративный OIDC-провайдер: учётные записи пользователей обычно хранятся выше по цепочке — в LDAP-каталоге, организации GitHub или в SAML, а dex выступает прослойкой между вашим приложением и этим провайдером, выпуская подписанные токены, которые и используют клиенты.
Как запустить dex у себя?Это сервер на Go: соберите его командой make или запустите опубликованный Docker-образ. README отсылает к официальной документации — там есть руководства по началу работы, настройке и использованию.
Перед какими провайдерами идентификации он может стоять?15 коннекторов: LDAP, GitHub, GitLab, Gitea, SAML 2.0, универсальный OpenID Connect (покрывает Salesforce, Azure и подобные) и OAuth 2.0, Google, LinkedIn, Microsoft, AuthProxy, Bitbucket Cloud, OpenShift, Atlassian Crowd и OpenStack Keystone.
Все ли эти коннекторы одинаково надёжны?Нет. Каждый помечен статусом stable, beta или alpha, и возможности различаются — например, SAML 2.0, несмотря на статус stable, сопровождается предупреждением, что он не поддерживается и, вероятно, уязвим к обходу аутентификации.
Где работает dex — обязательно ли иметь Kubernetes?Kubernetes — основной сценарий, но не обязательное условие: dex нативно запускается в любом кластере через CRD и может управлять аутентификацией API-сервера через OIDC-плагин. Клиенты вроде kubectl и kubelogin затем могут действовать от имени пользователей, вошедших через любой подключённый провайдер.
Что приложение реально получает после успешного входа?ID Token — главная особенность dex. Это подписанный dex JSON Web Token со стандартными claims: какое клиентское приложение выполнило вход, когда токен истекает и кто этот пользователь. Другие сервисы могут использовать эти токены как учётные данные для обмена между сервисами; Kubernetes и AWS STS уже так делают.
Каждый ли вход даст моему приложению refresh-токен?Нет — ограничения протоколов выше по цепочке наследуются. У SAML нет неинтерактивного способа обновлять утверждения, поэтому dex не выдаст refresh-токен для входа через SAML, а LDAP, GitHub, GitLab и большинство других коннекторов — выдадут. Сценариям с офлайн-доступом, таким как kubectl, нужен коннектор с поддержкой refresh.
Зачем вообще ставить dex перед моим LDAP или GitHub?Потому что клиенты пишут логику аутентификации один раз — для общения с dex, а dex реализует протоколы для каждого бэкенда — смена провайдера или добавление нового означает правку конфигурации dex, а не переписывание каждого приложения.
Умеет ли он federate с Azure AD или Salesforce?Да, через универсальный коннектор OpenID Connect (beta), который, как сказано в README, покрывает провайдеров вроде Salesforce и Azure; также есть универсальный коннектор OAuth 2.0 в статусе alpha.
What are similar projects?casdoor, kratos, hydra, zitadel, authentik, keycloak, cas, casbin
Creator
dexidp
Size
28.7 MB
Stars
11.2K
Age
11y
Commits · 90 Days