@ -28,13 +28,13 @@ V2 Identity Plugins
-------------------
Standard V2 identity plugins are defined in the module:
:py:mod: `keystone client .auth.identity.v2`
:py:mod: `keystone auth .auth.identity.v2`
They include:
- :py:class: `~keystone client .auth.identity.v2.Password`: Authenticate against
- :py:class: `~keystone auth .auth.identity.v2.Password`: Authenticate against
a V2 identity service using a username and password.
- :py:class: `~keystone client .auth.identity.v2.Token`: Authenticate against a
- :py:class: `~keystone auth .auth.identity.v2.Token`: Authenticate against a
V2 identity service using an existing token.
V2 identity plugins must use an auth_url that points to the root of a V2
@ -44,23 +44,23 @@ V3 Identity Plugins
-------------------
Standard V3 identity plugins are defined in the module
:py:mod: `keystone client .auth.identity.v3`.
:py:mod: `keystone auth .auth.identity.v3`.
V3 Identity plugins are slightly different from their V2 counterparts as a V3
authentication request can contain multiple authentication methods. To handle
this V3 defines a number of different
:py:class: `~keystone client .auth.identity.v3.AuthMethod` classes:
:py:class: `~keystone auth .auth.identity.v3.AuthMethod` classes:
- :py:class: `~keystone client .auth.identity.v3.PasswordMethod`: Authenticate
- :py:class: `~keystone auth .auth.identity.v3.PasswordMethod`: Authenticate
against a V3 identity service using a username and password.
- :py:class: `~keystone client .auth.identity.v3.TokenMethod`: Authenticate against
- :py:class: `~keystone auth .auth.identity.v3.TokenMethod`: Authenticate against
a V2 identity service using an existing token.
The :py:class: `~keystone client .auth.identity.v3.AuthMethod` objects are then
passed to the :py:class: `~keystone client .auth.identity.v3.Auth` plugin::
The :py:class: `~keystone auth .auth.identity.v3.AuthMethod` objects are then
passed to the :py:class: `~keystone auth .auth.identity.v3.Auth` plugin::
>>> from keystoneclient import session
>>> from keystoneclient .auth.identity import v3
>>> from keystoneauth import session
>>> from keystoneauth .auth.identity import v3
>>> password = v3.PasswordMethod(username='user',
... password='password')
>>> auth = v3.Auth(auth_url='http://my.keystone.com:5000/v3',
@ -69,15 +69,15 @@ passed to the :py:class:`~keystoneclient.auth.identity.v3.Auth` plugin::
>>> sess = session.Session(auth=auth)
As in the majority of cases you will only want to use one
:py:class: `~keystone client .auth.identity.v3.AuthMethod` there are also helper
:py:class: `~keystone auth .auth.identity.v3.AuthMethod` there are also helper
authentication plugins for the various
:py:class: `~keystone client .auth.identity.v3.AuthMethod` which can be used more
:py:class: `~keystone auth .auth.identity.v3.AuthMethod` which can be used more
like the V2 plugins:
- :py:class: `~keystone client .auth.identity.v3.Password`: Authenticate using
only a :py:class: `~keystone client .auth.identity.v3.PasswordMethod`.
- :py:class: `~keystone client .auth.identity.v3.Token`: Authenticate using only a
:py:class: `~keystone client .auth.identity.v3.TokenMethod`.
- :py:class: `~keystone auth .auth.identity.v3.Password`: Authenticate using
only a :py:class: `~keystone auth .auth.identity.v3.PasswordMethod`.
- :py:class: `~keystone auth .auth.identity.v3.Token`: Authenticate using only a
:py:class: `~keystone auth .auth.identity.v3.TokenMethod`.
::
@ -88,7 +88,7 @@ like the V2 plugins:
>>> sess = session.Session(auth=auth)
This will have exactly the same effect as using the single
:py:class: `~keystone client .auth.identity.v3.PasswordMethod` above.
:py:class: `~keystone auth .auth.identity.v3.PasswordMethod` above.
V3 identity plugins must use an auth_url that points to the root of a V3
identity server URL, i.e.: `http://hostname:5000/v3` .
@ -97,7 +97,7 @@ Version Independent Identity Plugins
------------------------------------
Standard version independent identity plugins are defined in the module
:py:mod: `keystone client .auth.identity.generic`.
:py:mod: `keystone auth .auth.identity.generic`.
For the cases of plugins that exist under both the identity V2 and V3 APIs
there is an abstraction to allow the plugin to determine which of the V2 and V3
@ -105,9 +105,9 @@ APIs are supported by the server and use the most appropriate API.
These plugins are:
- :py:class: `~keystone client .auth.identity.generic.Password`: Authenticate
- :py:class: `~keystone auth .auth.identity.generic.Password`: Authenticate
using a user/password against either v2 or v3 API.
- :py:class: `~keystone client .auth.identity.generic.Token`: Authenticate using
- :py:class: `~keystone auth .auth.identity.generic.Token`: Authenticate using
an existing token against either v2 or v3 API.
These plugins work by first querying the identity server to determine available
@ -124,7 +124,7 @@ same provided token and endpoint is available. This is useful in situations
where you have an `` ADMIN_TOKEN `` or in testing when you specifically know the
endpoint you want to communicate with.
It can be found at :py:class: `keystone client .auth.token_endpoint.Token`.
It can be found at :py:class: `keystone auth .auth.token_endpoint.Token`.
V3 OAuth 1.0a Plugins
@ -132,13 +132,13 @@ V3 OAuth 1.0a Plugins
There also exists a plugin for OAuth 1.0a authentication. We provide a helper
authentication plugin at:
:py:class: `~keystone client .v3.contrib.oauth1.auth.OAuth`.
:py:class: `~keystone auth .v3.contrib.oauth1.auth.OAuth`.
The plugin requires the OAuth consumer's key and secret, as well as the OAuth
access token's key and secret. For example::
>>> from keystoneclient .v3.contrib.oauth1 import auth
>>> from keystoneclient import session
>>> from keystoneclient .v3 import client
>>> from keystoneauth .v3.contrib.oauth1 import auth
>>> from keystoneauth import session
>>> from keystoneauth .v3 import client
>>> a = auth.OAuth('http://my.keystone.com:5000/v3',
... consumer_key=consumer_id,
... consumer_secret=consumer_secret,
@ -153,14 +153,14 @@ Loading Plugins by Name
In auth_token middleware and for some service to service communication it is
possible to specify a plugin to load via name. The authentication options that
are available are then specific to the plugin that you specified. Currently the
authentication plugins that are available in `keystone client ` are:
authentication plugins that are available in `keystone auth ` are:
- password: :py:class: `keystone client .auth.identity.generic.Password`
- token: :py:class: `keystone client .auth.identity.generic.Token`
- v2password: :py:class: `keystone client .auth.identity.v2.Password`
- v2token: :py:class: `keystone client .auth.identity.v2.Token`
- v3password: :py:class: `keystone client .auth.identity.v3.Password`
- v3token: :py:class: `keystone client .auth.identity.v3.Token`
- password: :py:class: `keystone auth .auth.identity.generic.Password`
- token: :py:class: `keystone auth .auth.identity.generic.Token`
- v2password: :py:class: `keystone auth .auth.identity.v2.Password`
- v2token: :py:class: `keystone auth .auth.identity.v2.Token`
- v3password: :py:class: `keystone auth .auth.identity.v3.Password`
- v3token: :py:class: `keystone auth .auth.identity.v3.Token`
Creating Authentication Plugins
@ -175,43 +175,43 @@ for the existing Identity mechanisms. As the V2 identity API is essentially
frozen, it is expected that new plugins are for the V3 API.
To implement a new V3 plugin that can be combined with others you should
implement the base :py:class: `keystone client .auth.identity.v3.AuthMethod` class
implement the base :py:class: `keystone auth .auth.identity.v3.AuthMethod` class
and implement the
:py:meth: `~keystone client .auth.identity.v3.AuthMethod.get_auth_data` function.
:py:meth: `~keystone auth .auth.identity.v3.AuthMethod.get_auth_data` function.
If your Plugin cannot be used in conjunction with existing
:py:class: `keystone client .auth.identity.v3.AuthMethod` then you should just
override :py:class: `keystone client .auth.identity.v3.Auth` directly.
:py:class: `keystone auth .auth.identity.v3.AuthMethod` then you should just
override :py:class: `keystone auth .auth.identity.v3.Auth` directly.
The new :py:class: `~keystone client .auth.identity.v3.AuthMethod` should take all
The new :py:class: `~keystone auth .auth.identity.v3.AuthMethod` should take all
the required parameters via
:py:meth: `~keystone client .auth.identity.v3.AuthMethod.__init__` and return from
:py:meth: `~keystone client .auth.identity.v3.AuthMethod.get_auth_data` a tuple
:py:meth: `~keystone auth .auth.identity.v3.AuthMethod.__init__` and return from
:py:meth: `~keystone auth .auth.identity.v3.AuthMethod.get_auth_data` a tuple
with the unique identifier of this plugin (e.g. *password* ) and a dictionary
containing the payload of values to send to the authentication server. The
session, calling auth object and request headers are also passed to this
function so that the plugin may use or manipulate them.
You should also provide a class that inherits from
:py:class: `keystone client .auth.identity.v3.Auth` with an instance of your new
:py:class: `~keystone client .auth.identity.v3.AuthMethod` as the `auth_methods`
parameter to :py:class: `keystone client .auth.identity.v3.Auth`.
:py:class: `keystone auth .auth.identity.v3.Auth` with an instance of your new
:py:class: `~keystone auth .auth.identity.v3.AuthMethod` as the `auth_methods`
parameter to :py:class: `keystone auth .auth.identity.v3.Auth`.
By convention (and like above) these are named `PluginType` and
`PluginTypeMethod` (for example
:py:class: `~keystone client .auth.identity.v3.Password` and
:py:class: `~keystone client .auth.identity.v3.PasswordMethod`).
:py:class: `~keystone auth .auth.identity.v3.Password` and
:py:class: `~keystone auth .auth.identity.v3.PasswordMethod`).
Creating a Custom Plugin
------------------------
To implement an entirely new plugin you should implement the base class
:py:class: `keystone client .auth.base.BaseAuthPlugin` and provide the
:py:meth: `~keystone client .auth.base.BaseAuthPlugin.get_endpoint`,
:py:meth: `~keystone client .auth.base.BaseAuthPlugin.get_token` and
:py:meth: `~keystone client .auth.base.BaseAuthPlugin.invalidate` functions.
:py:class: `keystone auth .auth.base.BaseAuthPlugin` and provide the
:py:meth: `~keystone auth .auth.base.BaseAuthPlugin.get_endpoint`,
:py:meth: `~keystone auth .auth.base.BaseAuthPlugin.get_token` and
:py:meth: `~keystone auth .auth.base.BaseAuthPlugin.invalidate` functions.
:py:meth: `~keystone client .auth.base.BaseAuthPlugin.get_token` is called to
:py:meth: `~keystone auth .auth.base.BaseAuthPlugin.get_token` is called to
retrieve the string token from a plugin. It is intended that a plugin will
cache a received token and so if the token is still valid then it should be
re-used rather than fetching a new one. A session object is provided with which
@ -219,19 +219,19 @@ the plugin can contact it's server. (Note: use `authenticated=False` when
making those requests or it will end up being called recursively). The return
value should be the token as a string.
:py:meth: `~keystone client .auth.base.BaseAuthPlugin.get_endpoint` is called to
:py:meth: `~keystone auth .auth.base.BaseAuthPlugin.get_endpoint` is called to
determine a base URL for a particular service's requests. The keyword arguments
provided to the function are those that are given by the `endpoint_filter`
variable in :py:meth: `keystone client .session.Session.request`. A session object
variable in :py:meth: `keystone auth .session.Session.request`. A session object
is also provided so that the plugin may contact an external source to determine
the endpoint. Again this will be generally be called once per request and so
it is up to the plugin to cache these responses if appropriate. The return
value should be the base URL to communicate with.
:py:meth: `~keystone client .auth.base.BaseAuthPlugin.invalidate` should also be
:py:meth: `~keystone auth .auth.base.BaseAuthPlugin.invalidate` should also be
implemented to clear the current user credentials so that on the next
:py:meth: `~keystone client .auth.base.BaseAuthPlugin.get_token` call a new token
:py:meth: `~keystone auth .auth.base.BaseAuthPlugin.get_token` call a new token
can be retrieved.
The most simple example of a plugin is the
:py:class: `keystone client .auth.token_endpoint.Token` plugin.
:py:class: `keystone auth .auth.token_endpoint.Token` plugin.