No description
Find a file
2015-08-28 12:43:07 -07:00
admin *: move original project to dex 2015-08-18 11:26:57 -07:00
client *: move original project to dex 2015-08-18 11:26:57 -07:00
cmd cmd, server: base64 encode multiple secrets 2015-08-26 10:43:24 -07:00
connector *: move original project to dex 2015-08-18 11:26:57 -07:00
contrib contrib: get standup up-to-date 2015-08-26 15:28:09 -07:00
db Merge pull request #87 from bobbyrullo/keyspace 2015-08-26 10:43:42 -07:00
Documentation Documentation: add notes on OIDC 2015-08-28 12:28:42 -07:00
email *: move original project to dex 2015-08-18 11:26:57 -07:00
examples examples/static: various changes to fix examples 2015-08-28 12:43:07 -07:00
functional Merge pull request #87 from bobbyrullo/keyspace 2015-08-26 10:43:42 -07:00
Godeps godep: add github.com/go-gorp/gorp 2015-08-24 15:43:15 -07:00
integration *: move original project to dex 2015-08-18 11:26:57 -07:00
pkg pkg/crypto: Don't modify ciphertext in place. 2015-08-26 10:43:24 -07:00
refresh *: move original project to dex 2015-08-18 11:26:57 -07:00
repo *: move original project to dex 2015-08-18 11:26:57 -07:00
schema *: move original project to dex 2015-08-18 11:26:57 -07:00
server cmd, server: base64 encode multiple secrets 2015-08-26 10:43:24 -07:00
session *: move original project to dex 2015-08-18 11:26:57 -07:00
static examples/static: various changes to fix examples 2015-08-28 12:43:07 -07:00
user *: move original project to dex 2015-08-18 11:26:57 -07:00
.gitignore *: move original project to dex 2015-08-18 11:26:57 -07:00
build db: add DB migration code and scripts. 2015-08-20 11:44:43 -07:00
build-docker-push build-docker-push: allow override of quay repo 2015-08-26 15:28:09 -07:00
build-units *: move original project to dex 2015-08-18 11:26:57 -07:00
CONTRIBUTING.md *: move original project to dex 2015-08-18 11:26:57 -07:00
cover *: move original project to dex 2015-08-18 11:26:57 -07:00
DCO *: move original project to dex 2015-08-18 11:26:57 -07:00
Dockerfile *: move original project to dex 2015-08-18 11:26:57 -07:00
go-docker go-docker: support functional tests 2015-08-20 16:50:30 -07:00
LICENSE *: move original project to dex 2015-08-18 11:26:57 -07:00
MAINTAINERS *: move original project to dex 2015-08-18 11:26:57 -07:00
NOTICE *: move original project to dex 2015-08-18 11:26:57 -07:00
README.md Documentation: bring dev-guide up to date. 2015-08-26 15:27:11 -07:00
test *: move original project to dex 2015-08-18 11:26:57 -07:00
test-functional go-docker: support functional tests 2015-08-20 16:50:30 -07:00

dex

Docker Repository on Quay.io

dex is a federated identity management service. It provides OpenID Connect (OIDC) to users, and can proxy to multiple remote identity providers (IdP) to drive actual authentication, as well as managing local username/password credentials.

We named the project 'dex' beceause it is a central index of users that other pieces of software can authenticate against.

Architecture

dex consists of multiple components:

  • dex-worker is the primary server component of dex
    • host a user-facing API that drives the OIDC protocol
    • proxy to remote identity providers via "connectors"
    • provides an API for administrators to manage users.
  • dex-overlord is an auxiliary process responsible for two things:
    • rotation of keys used by the workers to sign identity tokens
    • garbage collection of stale data in the database
    • provides an API for bootstrapping the system.
  • dexctl is CLI tool used to manage an dex deployment
    • configure identity provider connectors
    • administer OIDC client identities
  • database; a database is used to for persistent storage for keys, users, OAuth sessions and other data. Currently Postgres is the only supported database.

A typical dex deployment consists of N dex-workers behind a load balanacer, and one dex-overlord. The dex-workers directly handle user requests, so the loss of all workers can result in service downtime. The single dex-overlord runs its tasks periodically, so it does not need to maintain 100% uptime.

Who Should Use Dex?

**TODO**

Similar Software

**TODO**

Connectors

Remote IdPs could implement any auth-N protocol. Connectors contain protocol-specific logic and are used to communicate with remote IdPs. Possible examples of connectors could be: OIDC, LDAP, Local credentials, Basic Auth, etc.

dex ships with an OIDC connector, useful for authenticating with services like Google and Salesforce (or even other dex instances!) and a "local" connector, in which dex itself presents a UI for users to authenticate via dex-stored credentials.

Future connectors can be developed and added as future interoperability requirements emerge.

Relevant Specifications

These specs are referenced and implemented to some degree in the jose package of this project.

OpenID Connect (OIDC) is broken up into several specifications. The following (amongst others) are relevant:

Example OIDC Discovery Endpoints

Next steps:

If you want to try out dex quickly with a single process and no database (do not run this way in production!) take a look at the dev guide.

For running the full stack check out the getting started guide.

Coming Soon

  • Multiple backing Identity Providers
  • Identity Management
  • Authorization