keystoneauth/keystoneauth1/token_endpoint.py
Navid Pustchi e066afd4c0 Adding authentication compatibility for OpenStackClient
In ksa, plugins loading is managed by ksa.
OpenStackClient token_endpoint plugin expects get_auth_ref[1],
(a method consistent with ksa auth plugins) which is not implemented
in ksa token_endpoint.

This change will not change overall ksa behavior, as it only makes
OpenStackClient to be able to provide its token_endpoint plugin,
necessary for authentication migration in osc from ksc to ksa[2].

[1] https://github.com/openstack/python-openstackclient/blob/
master/openstackclient/api/auth_plugin.py#L48-L50
[2] http://docs.openstack.org/developer/keystoneauth/migrating.html

Change-Id: I7d8f9a9f071a0d37244f8985bd7d09d49ba79eb8
Closes-Bug: 1533369
2016-03-07 23:38:22 +00:00

49 lines
1.7 KiB
Python

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from keystoneauth1 import plugin
class Token(plugin.BaseAuthPlugin):
"""A provider that will always use the given token and endpoint.
This is really only useful for testing and in certain CLI cases where you
have a known endpoint and admin token that you want to use.
"""
def __init__(self, endpoint, token):
# NOTE(jamielennox): endpoint is reserved for when plugins
# can be used to provide that information
self.endpoint = endpoint
self.token = token
def get_token(self, session):
return self.token
def get_endpoint(self, session, **kwargs):
"""Return the supplied endpoint.
Using this plugin the same endpoint is returned regardless of the
parameters passed to the plugin.
"""
return self.endpoint
def get_auth_ref(self, session, **kwargs):
"""Return the authentication reference of an auth plugin.
:param session: A session object to be used for communication
:type session: keystoneauth1.session.session
"""
# token plugin does not have an auth ref, because it's a
# "static" authentication using a pre-existing token.
return None