dex

module
v2.0.0-alpha.4+incompa... Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 19, 2016 License: Apache-2.0

README

dex - A federated OpenID Connect provider

Caution image

This is an experimental version of dex that is likely to change in incompatible ways.

dex is an OAuth2 server that presents clients with a low overhead framework for identifying users while leveraging existing identity services such as Google Accounts, FreeIPA, GitHub, etc, for actual authentication. dex sits between your applications and an identity service, providing a backend agnostic flavor of OAuth2 called OpenID Connect, a spec will allows dex to support:

  • Short-lived, signed tokens with predefined fields (such as email) issued on behalf of users.
  • Well known discovery of OAuth2 endpoints.
  • OAuth2 mechanisms such as refresh tokens and revocation for long term access.
  • Automatic signing key rotation.

Any system which can query dex can cryptographically verify a users identity based on these tokens, allowing authentication events to be passed between backend services.

One such application that consumes OpenID Connect tokens is the Kubernetes API server, allowing dex to provide identity for any Kubernetes clusters.

Getting started

dex requires a Go installation and a GOPATH configured. Clone it down the correct place, and simply type make to compile dex.

git clone https://github.com/coreos/dex.git $GOPATH/src/github.com/coreos/dex
cd $GOPATH/src/github.com/coreos/dex
git checkout dev
make

dex is a single, scalable binary that pulls all configuration from a config file (no command line flags at the moment). Use one of the config files defined in the examples folder to start up dex with an in-memory data store.

./bin/dex serve examples/config-dev.yaml

dex allows OAuth2 clients to be defined statically through the config file. In another window, run the example-app (an OAuth2 client). By default this is configured to use the client ID and secret defined in the config file.

./bin/example-app

Then to interact with dex, like any other OAuth2 provider, you must first visit a client app, then be prompted to login through dex. This can be achieved using the following steps:

  1. Navigate to http://localhost:5555/ in your browser.
  2. Hit "login" on the example app to be redirected to dex.
  3. Choose the "Login with Email" and enter "admin@example.com" and "password"
  4. Approve the example app's request.
  5. See the resulting token the example app claims from dex.

Directories

Path Synopsis
Package api is a generated protocol buffer package.
Package api is a generated protocol buffer package.
cmd
dex
Package connector defines interfaces for federated identity strategies.
Package connector defines interfaces for federated identity strategies.
github
Package github provides authentication strategies using GitHub.
Package github provides authentication strategies using GitHub.
ldap
Package ldap implements strategies for authenticating using the LDAP protocol.
Package ldap implements strategies for authenticating using the LDAP protocol.
mock
Package mock implements connectors which help test various server components.
Package mock implements connectors which help test various server components.
oidc
Package oidc implements logging in through OpenID Connect providers.
Package oidc implements logging in through OpenID Connect providers.
Package server implements an OpenID Connect server with federated logins.
Package server implements an OpenID Connect server with federated logins.
Package storage defines the storage interface and types used by the server.
Package storage defines the storage interface and types used by the server.
conformance
Package conformance provides conformance tests for storage implementations.
Package conformance provides conformance tests for storage implementations.
kubernetes
Package kubernetes provides a storage interface using Kubernetes third party APIs.
Package kubernetes provides a storage interface using Kubernetes third party APIs.
kubernetes/k8sapi
Package k8sapi holds vendored Kubernetes types.
Package k8sapi holds vendored Kubernetes types.
memory
Package memory provides an in memory implementation of the storage interface.
Package memory provides an in memory implementation of the storage interface.
sql
Package sql provides SQL implementations of the storage interface.
Package sql provides SQL implementations of the storage interface.
Package version contains version information for this app.
Package version contains version information for this app.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL