- new exception when an auth receipt is returned. - a new method for auth receipt. - support to existing v3 Auth plugins to add additional methods. - Added a new MultiFactor plugin with loading support which takes method names as strings. Change-Id: Ie6601a50011118e3a07be9752f747c2298ff5230 Closes-Bug: #1839748changes/49/675049/14
Adrian Turjak
4 years ago
parent
bca9ee7d3c
commit
6a69e4dfbd
@ -0,0 +1,59 @@
|
||||
# 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.identity.v3 import base
|
||||
from keystoneauth1 import loading
|
||||
|
||||
|
||||
__all__ = ('MultiFactor', )
|
||||
|
||||
|
||||
class MultiFactor(base.Auth):
|
||||
"""A plugin for authenticating with multiple auth methods.
|
||||
|
||||
:param string auth_url: Identity service endpoint for authentication.
|
||||
:param string auth_methods: names of the methods to authenticate with.
|
||||
:param string trust_id: Trust ID for trust scoping.
|
||||
:param string system_scope: System information to scope to.
|
||||
:param string domain_id: Domain ID for domain scoping.
|
||||
:param string domain_name: Domain name for domain scoping.
|
||||
:param string project_id: Project ID for project scoping.
|
||||
:param string project_name: Project name for project scoping.
|
||||
:param string project_domain_id: Project's domain ID for project.
|
||||
:param string project_domain_name: Project's domain name for project.
|
||||
:param bool reauthenticate: Allow fetching a new token if the current one
|
||||
is going to expire. (optional) default True
|
||||
|
||||
Also accepts various keyword args based on which methods are specified.
|
||||
"""
|
||||
|
||||
def __init__(self, auth_url, auth_methods, **kwargs):
|
||||
method_instances = []
|
||||
method_keys = set()
|
||||
for method in auth_methods:
|
||||
# Using the loaders we pull the related auth method class
|
||||
method_class = loading.get_plugin_loader(
|
||||
method).plugin_class._auth_method_class
|
||||
# We build some new kwargs for the method from required parameters
|
||||
method_kwargs = {}
|
||||
for key in method_class._method_parameters:
|
||||
# we add them to method_keys to pop later from global kwargs
|
||||
# rather than here as other methods may need them too
|
||||
method_keys.add(key)
|
||||
method_kwargs[key] = kwargs.get(key, None)
|
||||
# We initialize the method class using just required kwargs
|
||||
method_instances.append(method_class(**method_kwargs))
|
||||
# We now pop all the keys used for methods as otherwise they get passed
|
||||
# to the super class and throw errors
|
||||
for key in method_keys:
|
||||
kwargs.pop(key, None)
|
||||
super(MultiFactor, self).__init__(auth_url, method_instances, **kwargs)
|
||||
@ -0,0 +1,37 @@
|
||||
# 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.identity.v3 import base
|
||||
|
||||
|
||||
__all__ = ('ReceiptMethod', )
|
||||
|
||||
|
||||
class ReceiptMethod(base.AuthMethod):
|
||||
"""Construct an Auth plugin to continue authentication with a receipt.
|
||||
|
||||
:param string receipt: Receipt for authentication.
|
||||
"""
|
||||
|
||||
_method_parameters = ['receipt']
|
||||
|
||||
def get_auth_data(self, session, auth, headers, **kwargs):
|
||||
"""Add the auth receipt to the headers.
|
||||
|
||||
We explicitly return None to avoid being added to the request
|
||||
methods, or body.
|
||||
"""
|
||||
headers['Openstack-Auth-Receipt'] = self.receipt
|
||||
return (None, None)
|
||||
|
||||
def get_cache_id_elements(self):
|
||||
return {'receipt_receipt': self.receipt}
|
||||
@ -0,0 +1,10 @@
|
||||
---
|
||||
features:
|
||||
- |
|
||||
[`bug 1839748 <https://bugs.launchpad.net/keystoneauth/+bug/1839748>`_]
|
||||
Keystoneauth now supports MFA authentication and Auth Receipts.
|
||||
Responses from Keystone containing and auth receipt will now
|
||||
raise a ``MissingAuthMethods`` exception which will contain the
|
||||
auth receipt itself, and information about the missing methods.
|
||||
There are now also ways to easily do more than one method when
|
||||
authenticating to Keystone and those have been documented.
|
||||
Loading…
Reference in new issue