python-openstackclient/openstackclient/identity/v3/unscoped_saml.py
Matthieu Huin 631ed3c802 Unscoped federated user-specific commands
A federated user can authenticate with the v3unscopedsaml plugin and
list the domains and projects she is allowed to scope to.
This patch introduces the new commands 'federation domain list' and
'federation project list'.
Note that for these commands -and plugin- to be available, the lxml
library must be installed.

Change-Id: I2707b624befcfb0a01b40a094e12fd68a3ee7773
Co-Authored-By: Florent Flament <florent.flament-ext@cloudwatt.com>
2014-10-30 17:27:28 +01:00

80 lines
2.8 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.
#
"""Identity v3 unscoped SAML auth action implementations.
The first step of federated auth is to fetch an unscoped token. From there,
the user can list domains and projects they are allowed to access, and request
a scoped token."""
import logging
from cliff import lister
from openstackclient.common import exceptions
from openstackclient.common import utils
UNSCOPED_AUTH_PLUGINS = ['v3unscopedsaml', 'v3unscopedadfs']
def auth_with_unscoped_saml(func):
"""Check the unscoped federated context"""
def _decorated(self, parsed_args):
auth_plugin_name = self.app.client_manager.auth_plugin_name
if auth_plugin_name in UNSCOPED_AUTH_PLUGINS:
return func(self, parsed_args)
else:
msg = ('This command requires the use of an unscoped SAML '
'authentication plugin. Please use argument '
'--os-auth-plugin with one of the following '
'plugins: ' + ', '.join(UNSCOPED_AUTH_PLUGINS))
raise exceptions.CommandError(msg)
return _decorated
class ListAccessibleDomains(lister.Lister):
"""List accessible domains"""
log = logging.getLogger(__name__ + '.ListAccessibleDomains')
@auth_with_unscoped_saml
def take_action(self, parsed_args):
self.log.debug('take_action(%s)', parsed_args)
columns = ('ID', 'Enabled', 'Name', 'Description')
identity_client = self.app.client_manager.identity
data = identity_client.federation.domains.list()
return (columns,
(utils.get_item_properties(
s, columns,
formatters={},
) for s in data))
class ListAccessibleProjects(lister.Lister):
"""List accessible projects"""
log = logging.getLogger(__name__ + '.ListAccessibleProjects')
@auth_with_unscoped_saml
def take_action(self, parsed_args):
self.log.debug('take_action(%s)', parsed_args)
columns = ('ID', 'Domain ID', 'Enabled', 'Name')
identity_client = self.app.client_manager.identity
data = identity_client.federation.projects.list()
return (columns,
(utils.get_item_properties(
s, columns,
formatters={},
) for s in data))