/usr/lib/python2.6/site-packages/keystoneclient/auth
Edit: /usr/lib/python2.6/site-packages/keystoneclient/auth/base.pyc (14951B)
7 s ( R R R t TrueR t dictt map( R ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt get_available_plugin_classes, s c
C sN y" t i d t d | d t } Wn" t j
o t i | n X| i S( sY Retrieve a plugin class by its entrypoint name.
:param str name: The name of the object to get.
:returns: An auth plugin class.
:rtype: :py:class:`keystoneclient.auth.BaseAuthPlugin`
:raises keystoneclient.exceptions.NoMatchingPlugin: if a plugin cannot be
created.
R R
R ( R t
DriverManagerR R t RuntimeErrorR t NoMatchingPlugint driver( R
R ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt get_plugin_class: s
t BaseAuthPluginc B s e Z d Z d Z d Z d Z d Z d Z d Z d Z e
d Z e
d Z e
d
Z
e
d Z e
d Z e
d
Z e
d Z RS( s0 The basic structure of an authentication plugin.c K s d S( s; 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: keystoneclient.session.Session
:return: A token to use.
:rtype: string
N( t None( t selft sessiont kwargs( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt get_tokenR 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: 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
N( R R t IDENTITY_AUTH_HEADER_NAME( R R R t token( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt get_headerso 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: keystoneclient.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 ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.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 ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt get_connection_params 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
( R ( R ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.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: keystoneclient.session.Session
:returns: A user identifier or None if one is not available.
:rtype: str
N( R ( R R R ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.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: keystoneclient.session.Session
:returns: A project identifier or None if one is not available.
:rtype: str
N( R ( R R R ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt get_project_id s
c C s g S( s Return the list of parameters associated with the auth plugin.
This list may be used to generate CLI or config arguments.
:returns: A list of Param objects describing available plugin
parameters.
:rtype: list
( ( t cls( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt get_options s
c K s
| | S( s Create a plugin from the arguments retrieved from get_options.
A client can override this function to do argument validation or to
handle differences between the registered options and what is required
to create the plugin.
( ( R( R ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt load_from_options s c
C s x | i D] } g } g } xR | g | i D]@ } | i d | i | i d | i i d d i q0 Wd | D } t i t i i d | d } | i d | p | i d | i
d | i d d
| i | q
Wd S( s Register the CLI options provided by a specific plugin.
Given a plugin class convert it's options into argparse arguments and
add them to a parser.
:param parser: the parser to attach argparse options.
:type parser: argparse.ArgumentParser
s --os-%ss OS_%st -t _c s s% x | ] } t i i | Vq Wd S( N( t ost environt get( t .0t e( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pys s t defaultt metavart helpt dests os_%sN( R) t deprecated_optst appendR
t replacet uppert sixt nextt movest filterR t add_argumentR2 R3 R4 R5 ( R( t parsert optt argst envst ot env_varsR2 ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt register_argparse_arguments s
*! c s f d } | i | | S( sk Load a specific plugin object from an argparse result.
Convert the results of a parse into the specified plugin.
:param namespace: The result from CLI parsing.
:type namespace: argparse.Namespace
:returns: An auth plugin, or None if a name is not provided.
:rtype: :py:class:`keystoneclient.auth.BaseAuthPlugin`
c s t d | i S( Ns os_%s( t getattrR5 ( R@ ( R ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt _getter, s ( t load_from_options_getter( R( R R RG ( ( R sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt load_from_argparse_arguments s
c C s# | i } | i | d | d S( s Register the oslo_config options that are needed for a plugin.
:param conf: A config object.
:type conf: oslo_config.cfg.ConfigOpts
:param string group: The group name that options should be read from.
t groupN( R) t
register_opts( R( t confRJ t plugin_opts( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt register_conf_options1 s c s" f d } | i | | S( s Load the plugin from a CONF object.
Convert the options already registered into a real plugin.
:param conf: A config object.
:type conf: oslo_config.cfg.ConfigOpts
:param string group: The group name that options should be read from.
:returns: An authentication Plugin.
:rtype: :py:class:`keystoneclient.auth.BaseAuthPlugin`
c s | i S( N( R5 ( R@ ( RJ RL ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyRG J s ( RH ( R( RL RJ R RG ( ( RJ RL sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt load_from_conf_options< s c K si | i } xM | D]E } | | } | d j o | i | } n | i | i | q W| i | S( sR Load a plugin from a getter function that returns appropriate values
To handle cases other than the provided CONF and CLI loading you can
specify a custom loader function that will be queried for the option
value.
The getter is a function that takes one value, an
:py:class:`oslo_config.cfg.Opt` and returns a value to load with.
:param getter: A function that returns a value for the given opt.
:type getter: callable
:returns: An authentication Plugin.
:rtype: :py:class:`keystoneclient.auth.BaseAuthPlugin`
N( R) R t typet
setdefaultR5 R* ( R( t getterR RM R@ t val( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyRH O s
( t __name__t
__module__t __doc__R R" R# R$ R% R& R' t classmethodR) R* RE RI RN RO RH ( ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyR O s &
# (
R- R: R t keystoneclientR t objectt AUTH_INTERFACER R R
R R R ( ( ( sG /tmp/pip-build-cD3xZi/python-keystoneclient/keystoneclient/auth/base.pyt
s