From d09914592175fd990f23bbd400b215dcbdc42c5d Mon Sep 17 00:00:00 2001
From: Eric Chiang <eric.chiang@coreos.com>
Date: Thu, 26 Oct 2017 10:47:16 -0700
Subject: [PATCH] authproxy: update docs and set a userID
---
Documentation/authproxy.md | 48 ++++++++++++++++++++++++++++----
connector/authproxy/authproxy.go | 1 +
2 files changed, 44 insertions(+), 5 deletions(-)
diff --git a/Documentation/authproxy.md b/Documentation/authproxy.md
index 10ff1980..21362fcb 100644
--- a/Documentation/authproxy.md
+++ b/Documentation/authproxy.md
@@ -1,14 +1,52 @@
-# External authentication
+# Authenticating proxy
+
+NOTE: This connector is experimental and may change in the future.
## Overview
-The authproxy connector returns identities based on authentication which your
-front-end web server performs.
+The `authproxy` connector returns identities based on authentication which your
+front-end web server performs. Dex consumes the `X-Remote-User` header set by
+the proxy, which is then used as the user's email address.
+
+__The proxy MUST remove any `X-Remote-*` headers set by the client, for any URL
+path, before the request is forwarded to dex.__
-The connector does not support refresh tokens or groups at this point.
+The connector does not support refresh tokens or groups.
## Configuration
+The `authproxy` connector is used by proxies to implement login strategies not
+supported by dex. For example, a proxy could handle a different OAuth2 strategy
+such as Slack. The connector takes no configuration other than a `name` and `id`:
+
+```yaml
+connectors:
+# Slack login implemented by an authenticating proxy, not by dex.
+- type: authproxy
+ id: slack
+ name: Slack
+```
+
+The proxy only needs to authenticate the user when they attempt to visit the
+callback URL path:
+
+```
+( dex issuer URL )/callback/( connector id )?( url query )
+```
+
+For example, if dex is running at `https://auth.example.com/dex` and the connector
+ID is `slack`, the callback URL would look like:
+
+```
+https://auth.example.com/dex/callback/slack?state=xdg3z6quhrhwaueo5iysvliqf
+```
+
+The proxy should login the user then return them to the exact URL (inlucing the
+query), setting `X-Remote-User` to the user's email before proxying the request
+to dex.
+
+## Configuration example - Apache 2
+
The following is an example config file that can be used by the external
connector to authenticate a user.
@@ -84,4 +122,4 @@ virtual host configuration in e.g. `/etc/apache2/sites-available/sso.conf`:
</VirtualHost>
```
-Then, enable it using `a2ensite sso.conf`, followed by a restart of Apache2.
\ No newline at end of file
+Then, enable it using `a2ensite sso.conf`, followed by a restart of Apache2.
diff --git a/connector/authproxy/authproxy.go b/connector/authproxy/authproxy.go
index a895789d..e367c4f9 100644
--- a/connector/authproxy/authproxy.go
+++ b/connector/authproxy/authproxy.go
@@ -50,6 +50,7 @@ func (m *callback) HandleCallback(s connector.Scopes, r *http.Request) (connecto
// TODO: add support for X-Remote-Group, see
// https://kubernetes.io/docs/admin/authentication/#authenticating-proxy
return connector.Identity{
+ UserID: remoteUser, // TODO: figure out if this is a bad ID value.
Email: remoteUser,
EmailVerified: true,
}, nil
--
GitLab