/usr/lib/python2.6/site-packages/keystoneauth1
Edit: /usr/lib/python2.6/site-packages/keystoneauth1/plugin.pyc (8305B)
DVc @ s) e Z d Z d e f d YZ d S( s X-Auth-Tokent BaseAuthPluginc B s_ e Z d Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z RS(
s0 The basic structure of an authentication plugin.c K s d S( s8 Obtain a token.
How the token is obtained is up to the plugin. If it is still valid
it may be re-used, retrieved from cache or invoke an authentication
request against a server.
There are no required kwargs. They are passed directly to the auth
plugin and they are implementation specific.
Returning None will indicate that no token was able to be retrieved.
This function is misplaced as it should only be required for auth
plugins that use the 'X-Auth-Token' header. However due to the way
plugins evolved this method is required and often called to trigger an
authentication request on a new plugin.
When implementing a new plugin it is advised that you implement this
method, however if you don't require the 'X-Auth-Token' header override
the `get_headers` method instead.
:param session: A session object so the plugin can make HTTP calls.
:type session: keystonauth.session.Session
:return: A token to use.
:rtype: string
N( t None( t selft sessiont kwargs( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyt get_token s c K s& | i | } | p d Sh | t 6S( s Fetch authentication headers for message.
This is a more generalized replacement of the older get_token to allow
plugins to specify different or additional authentication headers to
the OpenStack standard 'X-Auth-Token' header.
How the authentication headers are obtained is up to the plugin. If the
headers are still valid they may be re-used, retrieved from cache or
the plugin may invoke an authentication request against a server.
The default implementation of get_headers calls the `get_token` method
to enable older style plugins to continue functioning unchanged.
Subclasses should feel free to completely override this function to
provide the headers that they want.
There are no required kwargs. They are passed directly to the auth
plugin and they are implementation specific.
Returning None will indicate that no token was able to be retrieved and
that authorization was a failure. Adding no authentication data can be
achieved by returning an empty dictionary.
:param session: The session object that the auth_plugin belongs to.
:type session: keystonauth.session.Session
:returns: Headers that are set to authenticate a message or None for
failure. Note that when checking this value that the empty
dict is a valid, non-failure response.
:rtype: dict
N( R R t IDENTITY_AUTH_HEADER_NAME( R R R t token( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyt get_headers5 s c K s d S( s} Return an endpoint for the client.
There are no required keyword arguments to ``get_endpoint`` as a plugin
implementation should use best effort with the information available to
determine the endpoint. However there are certain standard options that
will be generated by the clients and should be used by plugins:
- ``service_type``: what sort of service is required.
- ``service_name``: the name of the service in the catalog.
- ``interface``: what visibility the endpoint should have.
- ``region_name``: the region the endpoint exists in.
:param session: The session object that the auth_plugin belongs to.
:type session: keystonauth.session.Session
:returns: The base URL that will be used to talk to the required
service or None if not available.
:rtype: string
N( R ( R R R ( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyt get_endpoint[ s c K s h S( s Return any additional connection parameters required for the plugin.
:param session: The session object that the auth_plugin belongs to.
:type session: keystoneclient.session.Session
:returns: Headers that are set to authenticate a message or None for
failure. Note that when checking this value that the empty
dict is a valid, non-failure response.
:rtype: dict
( ( R R R ( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyt get_connection_paramsq s c C s t S( s Invalidate the current authentication data.
This should result in fetching a new token on next call.
A plugin may be invalidated if an Unauthorized HTTP response is
returned to indicate that the token may have been revoked or is
otherwise now invalid.
:returns: True if there was something that the plugin did to
invalidate. This means that it makes sense to try again. If
nothing happens returns False to indicate give up.
:rtype: bool
( t False( R ( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyt
invalidate~ s c K s d S( s Return a unique user identifier of the plugin.
Wherever possible the user id should be inferred from the token however
there are certain URLs and other places that require access to the
currently authenticated user id.
:param session: A session object so the plugin can make HTTP calls.
:type session: keystonauth.session.Session
:returns: A user identifier or None if one is not available.
:rtype: str
N( R ( R R R ( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyt get_user_id s
c K s d S( s Return the project id that we are authenticated to.
Wherever possible the project id should be inferred from the token
however there are certain URLs and other places that require access to
the currently authenticated project id.
:param session: A session object so the plugin can make HTTP calls.
:type session: keystonauth.session.Session
:returns: A project identifier or None if one is not available.
:rtype: str
N( R ( R R R ( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyt get_project_id s
c K s d S( sW Return auth_url from the Service Provider object
This url is used for obtaining unscoped federated token from remote
cloud.
:param sp_id: ID of the Service Provider to be queried.
:type sp_id: string
:returns: A Service Provider auth_url or None if one is not available.
:rtype: str
N( R ( R R t sp_idR ( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyt get_sp_auth_url s
c K s d S( s? Return sp_url from the Service Provider object
This url is used for passing SAML2 assertion to the remote cloud.
:param sp_id: ID of the Service Provider to be queried.
:type sp_id: str
:returns: A Service Provider sp_url or None if one is not available.
:rtype: str
N( R ( R R R R ( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyt
get_sp_url s ( t __name__t
__module__t __doc__R R R R
R R
R R R ( ( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyR s &
N( t objectt AUTH_INTERFACER R ( ( ( s; /tmp/pip-build-lt8jXN/keystoneauth1/keystoneauth1/plugin.pyt
s