diff options
| author | Colleen Murphy <colleen@gazlene.net> | 2017-09-29 16:16:29 +0200 |
|---|---|---|
| committer | Colleen Murphy <colleen.murphy@suse.com> | 2017-10-11 14:00:49 +0200 |
| commit | 409b482253dec248ed828e92e52b09d4c02e51dd (patch) | |
| tree | 928f25bae37d42a10b4cf9a2a9ccfab60ff9da2f /doc | |
| parent | 04735348de7e81e8190849fd676b04377a2a4e8c (diff) | |
| download | keystonemiddleware-409b482253dec248ed828e92e52b09d4c02e51dd.tar.gz | |
Rename auth_uri to www_authenticate_uri
The [keystone_authtoken]/auth_uri middleware parameter has been causing
extreme confusion amongst operators and developers ever since the
keystonemiddleware started accepting keystoneauth plugin parameters
including auth_url. The two parameters look identical and yet have
completely different meanings and are both required. This patch
deprecates auth_uri and renames it to www_authenticate_uri, which more
accurately describes the WWW-Authenticate header it is configuring and
is dissimilar to any other keystone_authtoken middleware parameter. This
also renames the internal variable names for consistency with the config
option.
Change-Id: I0cf11da3d395749df28077427689fdafc8a6b981
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/middlewarearchitecture.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/source/middlewarearchitecture.rst b/doc/source/middlewarearchitecture.rst index 2df21eb..28ff0c6 100644 --- a/doc/source/middlewarearchitecture.rst +++ b/doc/source/middlewarearchitecture.rst @@ -261,7 +261,8 @@ swift/cloud files and for legacy Rackspace use. If the token isn't present and the middleware is configured to not delegate auth responsibility, it will respond to the HTTP request with HTTPUnauthorized, returning the header ``WWW-Authenticate`` with the value `Keystone uri='...'` to indicate where to -request a token. The auth_uri returned is configured with the middleware. +request a token. The URI returned is configured with the +``www_authenticate_uri`` option. The authentication middleware extends the HTTP request with the header ``X-Identity-Status``. If a request is successfully authenticated, the value |