Skip to content
OpenID Connect Identity (OIDC) and OAuth 2.0 Provider with Pluggable Connectors
Go Other
  1. Go 97.1%
  2. Other 2.9%
Branch: master
Clone or download
bonifaido Merge pull request #1569 from bhageena/master
Fix spelling errors in docs
Latest commit b7184be Nov 5, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Documentation Merge pull request #1569 from bhageena/master Nov 5, 2019
api regenerate protobuf code Jul 31, 2019
cmd Use a more conservative set of CipherSuites Aug 31, 2019
connector Merge pull request #1544 from kenperkins/saml-groups Oct 30, 2019
examples Add examples for recent additions to oauth2 configuration options Aug 9, 2019
pkg connectors: refactor filter code into a helper package Jul 3, 2019
scripts storage/kubernetes: Removing Kubernetes TPR support Aug 14, 2019
server Fix missing email in log message Oct 30, 2019
storage Merge pull request #1566 from dexidp/preferred_username Oct 30, 2019
vendor deps: bump go-grpc (1.22.1 -> 1.23.0) Aug 14, 2019
version *: determine version from git Aug 9, 2016
web web: change header template to use new url function Oct 2, 2019
.dockerignore Replace docker-build script with multi-stage build Sep 21, 2017
.gitignore gitignore: add .idea folder Oct 2, 2019
.travis.yml storage/sql: rework of the original MySQL PR Jul 23, 2019
ADOPTERS.md Pydio Cells adopters list Aug 28, 2019
DCO *: add DCO and LICENSE Oct 13, 2016
Dockerfile Dockerfile: build with golang 1.12.9 Aug 22, 2019
LICENSE *: add DCO and LICENSE Oct 13, 2016
MAINTAINERS MAINTAINERS: add @bonifaido Jul 23, 2019
Makefile Adjusting Makefile so that `golint` will compile Aug 2, 2019
NOTICE update CoC and legalese Jan 4, 2018
README.md add preffered_username to idToken Oct 30, 2019
code-of-conduct.md update CoC and legalese Jan 4, 2018
go.mod deps: bump go-grpc (1.22.1 -> 1.23.0) Aug 14, 2019
go.sum deps: bump go-grpc (1.22.1 -> 1.23.0) Aug 14, 2019
vendor.go *: remove glide and add Go module files Dec 3, 2018

README.md

dex - A federated OpenID Connect provider

Travis GoDoc Go Report Card

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 attest 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": "jane.doe@coreos.com",
  "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 + dex

Dex's main production use is as an auth-N addon in CoreOS's enterprise Kubernetes solution, Tectonic. Dex runs natively on top of any Kubernetes cluster using Third Party Resources and can drive API server authentication through the OpenID Connect plugin. Clients, such as the Tectonic Console and kubectl, can act on behalf users who can login to the cluster through any identity provider dex supports.

More docs for running dex as a Kubernetes authenticator can be found here.

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
GitLab yes yes yes beta
OpenID Connect yes no (#1065) no beta Includes Google, Salesforce, Azure, etc.
LinkedIn yes no no beta
Microsoft yes yes no beta
AuthProxy no no no alpha Authentication proxies such as Apache2 mod_auth, etc.
Bitbucket Cloud yes yes no alpha

Stable, beta, and alpha are defined as:

  • Stable: well tested, in active use, and will not change in backward incompatible ways.
  • Beta: tested and unlikely to change in backward incompatible ways.
  • Alpha: may be untested by core maintainers and is subject to change in backward incompatible ways.

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

Documentation

Reporting a security vulnerability

Due to their public nature, GitHub and mailing lists are NOT appropriate places for reporting vulnerabilities. Please refer to CoreOS's security disclosure process when reporting issues that may be security related.

Getting help

  • For feature requests and bugs, file an issue.
  • For general discussion about both using and developing dex, join the dex-dev mailing list.
You can’t perform that action at this time.