keystoneauth/doc/source/authentication-plugins.rst

Authentication Plugins

Introduction

Authentication plugins provide a generic means by which to extend the authentication mechanisms known to OpenStack clients.

In the vast majority of cases the authentication plugins used will be those written for use with the OpenStack Identity Service (Keystone), however this is not the only possible case, and the mechanisms by which authentication plugins are used and implemented should be generic enough to cover completely customized authentication solutions.

The subset of authentication plugins intended for use with an OpenStack Identity server (such as Keystone) are called Identity Plugins.

Available Plugins

Keystoneclient ships with a number of plugins and particularly Identity Plugins.

V2 Identity Plugins

Standard V2 identity plugins are defined in the module: :pykeystoneauth1.auth.identity.v2

They include:

• :py~keystoneauth1.auth.identity.v2.Password: Authenticate against a V2 identity service using a username and password.
• :py~keystoneauth1.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 identity server URL, i.e.: http://hostname:5000/v2.0.

V3 Identity Plugins

Standard V3 identity plugins are defined in the module :pykeystoneauth1.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~keystoneauth1.auth.identity.v3.AuthMethod classes:

• :py~keystoneauth1.auth.identity.v3.PasswordMethod: Authenticate against a V3 identity service using a username and password.
• :py~keystoneauth1.auth.identity.v3.TokenMethod: Authenticate against a V2 identity service using an existing token.

The :py~keystoneauth1.auth.identity.v3.AuthMethod objects are then passed to the :py~keystoneauth1.auth.identity.v3.Auth plugin:

>>> from keystoneauth1 import session
>>> from keystoneauth1.auth.identity import v3
>>> password = v3.PasswordMethod(username='user',
...                              password='password')
>>> auth = v3.Auth(auth_url='http://my.keystone.com:5000/v3',
...                auth_methods=[password],
...                project_id='projectid')
>>> sess = session.Session(auth=auth)

As in the majority of cases you will only want to use one :py~keystoneauth1.auth.identity.v3.AuthMethod there are also helper authentication plugins for the various :py~keystoneauth1.auth.identity.v3.AuthMethod which can be used more like the V2 plugins:

• :py~keystoneauth1.auth.identity.v3.Password: Authenticate using only a :py~keystoneauth1.auth.identity.v3.PasswordMethod.
• :py~keystoneauth1.auth.identity.v3.Token: Authenticate using only a :py~keystoneauth1.auth.identity.v3.TokenMethod.

>>> auth = v3.Password(auth_url='http://my.keystone.com:5000/v3',
...                    username='username',
...                    password='password',
...                    project_id='projectid')
>>> sess = session.Session(auth=auth)

This will have exactly the same effect as using the single :py~keystoneauth1.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.

Version Independent Identity Plugins

Standard version independent identity plugins are defined in the module :pykeystoneauth1.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 APIs are supported by the server and use the most appropriate API.

These plugins are:

• :py~keystoneauth1.auth.identity.generic.Password: Authenticate using a user/password against either v2 or v3 API.
• :py~keystoneauth1.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 versions and so the auth_url used with the plugins should point to the base URL of the identity server to use. If the auth_url points to either a V2 or V3 endpoint it will restrict the plugin to only working with that version of the API.

Simple Plugins

In addition to the Identity plugins a simple plugin that will always use the 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 :pykeystoneauth1.auth.token_endpoint.Token.

V3 OAuth 1.0a Plugins

There also exists a plugin for OAuth 1.0a authentication. We provide a helper authentication plugin at: :py~keystoneauth1.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 keystoneauth1.v3.contrib.oauth1 import auth
>>> from keystoneauth1 import session
>>> from keystoneauth1.v3 import client
>>> a = auth.OAuth('http://my.keystone.com:5000/v3',
...                consumer_key=consumer_id,
...                consumer_secret=consumer_secret,
...                access_key=access_token_key,
...                access_secret=access_token_secret)
>>> s = session.Session(auth=a)

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 keystoneauth are:

• password: :pykeystoneauth1.auth.identity.generic.Password
• token: :pykeystoneauth1.auth.identity.generic.Token
• v2password: :pykeystoneauth1.auth.identity.v2.Password
• v2token: :pykeystoneauth1.auth.identity.v2.Token
• v3password: :pykeystoneauth1.auth.identity.v3.Password
• v3token: :pykeystoneauth1.auth.identity.v3.Token

Creating Authentication Plugins

Creating an Identity Plugin

If you have implemented a new authentication mechanism into the Identity service then you will be able to reuse a lot of the infrastructure available 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 :pykeystoneauth1.auth.identity.v3.AuthMethod class and implement the :py~keystoneauth1.auth.identity.v3.AuthMethod.get_auth_data function. If your Plugin cannot be used in conjunction with existing :pykeystoneauth1.auth.identity.v3.AuthMethod then you should just override :pykeystoneauth1.auth.identity.v3.Auth directly.

The new :py~keystoneauth1.auth.identity.v3.AuthMethod should take all the required parameters via :py~keystoneauth1.auth.identity.v3.AuthMethod.__init__ and return from :py~keystoneauth1.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 :pykeystoneauth1.auth.identity.v3.Auth with an instance of your new :py~keystoneauth1.auth.identity.v3.AuthMethod as the auth_methods parameter to :pykeystoneauth1.auth.identity.v3.Auth.

By convention (and like above) these are named PluginType and PluginTypeMethod (for example :py~keystoneauth1.auth.identity.v3.Password and :py~keystoneauth1.auth.identity.v3.PasswordMethod).

Creating a Custom Plugin

To implement an entirely new plugin you should implement the base class :pykeystoneauth1.auth.base.BaseAuthPlugin and provide the :py~keystoneauth1.auth.base.BaseAuthPlugin.get_endpoint, :py~keystoneauth1.auth.base.BaseAuthPlugin.get_token and :py~keystoneauth1.auth.base.BaseAuthPlugin.invalidate functions.

:py~keystoneauth1.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 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~keystoneauth1.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 :pykeystoneauth1.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~keystoneauth1.auth.base.BaseAuthPlugin.invalidate should also be implemented to clear the current user credentials so that on the next :py~keystoneauth1.auth.base.BaseAuthPlugin.get_token call a new token can be retrieved.

The most simple example of a plugin is the :pykeystoneauth1.auth.token_endpoint.Token plugin.