3c8d35247e
When the docs are rendered to HTML, any docs on __init__ are not displayed. The parameters to the constructor have to be documented on the class rather than on the __init__ method. Also, corrected other minor issues in the same areas. Change-Id: Ic56da33f6b99fe5efb636c289e3c4e1569f0c84c
56 lines
2.0 KiB
Python
56 lines
2.0 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 keystoneclient.auth.identity import v3
|
|
|
|
try:
|
|
from oauthlib import oauth1
|
|
except ImportError:
|
|
oauth1 = None
|
|
|
|
|
|
class OAuthMethod(v3.AuthMethod):
|
|
"""OAuth based authentication method.
|
|
|
|
:param string consumer_key: Consumer key.
|
|
:param string consumer_secret: Consumer secret.
|
|
:param string access_key: Access token key.
|
|
:param string access_secret: Access token secret.
|
|
"""
|
|
|
|
_method_parameters = ['consumer_key', 'consumer_secret',
|
|
'access_key', 'access_secret']
|
|
|
|
def __init__(self, **kwargs):
|
|
super(OAuthMethod, self).__init__(**kwargs)
|
|
if oauth1 is None:
|
|
raise NotImplementedError('optional package oauthlib'
|
|
' is not installed')
|
|
|
|
def get_auth_data(self, session, auth, headers, **kwargs):
|
|
# Add the oauth specific content into the headers
|
|
oauth_client = oauth1.Client(self.consumer_key,
|
|
client_secret=self.consumer_secret,
|
|
resource_owner_key=self.access_key,
|
|
resource_owner_secret=self.access_secret,
|
|
signature_method=oauth1.SIGNATURE_HMAC)
|
|
o_url, o_headers, o_body = oauth_client.sign(auth.token_url,
|
|
http_method='POST')
|
|
|
|
headers.update(o_headers)
|
|
return 'oauth1', {}
|
|
|
|
|
|
class OAuth(v3.AuthConstructor):
|
|
_auth_method_class = OAuthMethod
|