# Copyright 2012-2013 OpenStack Foundation # # 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 v2.0 User action implementations""" import functools import logging from cliff import columns as cliff_columns from keystoneauth1 import exceptions as ks_exc from osc_lib.command import command from osc_lib import exceptions from osc_lib import utils from openstackclient.i18n import _ LOG = logging.getLogger(__name__) class ProjectColumn(cliff_columns.FormattableColumn): """Formattable column for project column. Unlike the parent FormattableColumn class, the initializer of the class takes project_cache as the second argument. osc_lib.utils.get_item_properties instantiate cliff FormattableColumn object with a single parameter "column value", so you need to pass a partially initialized class like ``functools.partial(ProjectColumn, project_cache)``. """ def __init__(self, value, project_cache=None): super(ProjectColumn, self).__init__(value) self.project_cache = project_cache or {} def human_readable(self): project = self._value if not project: return "" if project in self.project_cache.keys(): return self.project_cache[project].name else: return project class CreateUser(command.ShowOne): _description = _("Create new user") def get_parser(self, prog_name): parser = super(CreateUser, self).get_parser(prog_name) parser.add_argument( 'name', metavar='', help=_('New user name'), ) parser.add_argument( '--project', metavar='', help=_('Default project (name or ID)'), ) parser.add_argument( '--password', metavar='', help=_('Set user password'), ) parser.add_argument( '--password-prompt', dest="password_prompt", action="store_true", help=_('Prompt interactively for password'), ) parser.add_argument( '--email', metavar='', help=_('Set user email address'), ) enable_group = parser.add_mutually_exclusive_group() enable_group.add_argument( '--enable', action='store_true', help=_('Enable user (default)'), ) enable_group.add_argument( '--disable', action='store_true', help=_('Disable user'), ) parser.add_argument( '--or-show', action='store_true', help=_('Return existing user'), ) return parser def take_action(self, parsed_args): identity_client = self.app.client_manager.identity if parsed_args.project: project_id = utils.find_resource( identity_client.tenants, parsed_args.project, ).id else: project_id = None enabled = True if parsed_args.disable: enabled = False if parsed_args.password_prompt: parsed_args.password = utils.get_password(self.app.stdin) if not parsed_args.password: LOG.warning(_("No password was supplied, authentication will fail " "when a user does not have a password.")) try: user = identity_client.users.create( parsed_args.name, parsed_args.password, parsed_args.email, tenant_id=project_id, enabled=enabled, ) except ks_exc.Conflict: if parsed_args.or_show: user = utils.find_resource( identity_client.users, parsed_args.name, ) LOG.info(_('Returning existing user %s'), user.name) else: raise # NOTE(dtroyer): The users.create() method wants 'tenant_id' but # the returned resource has 'tenantId'. Sigh. # We're using project_id now inside OSC so there. if 'tenantId' in user._info: user._info.update( {'project_id': user._info.pop('tenantId')} ) info = {} info.update(user._info) return zip(*sorted(info.items())) class DeleteUser(command.Command): _description = _("Delete user(s)") def get_parser(self, prog_name): parser = super(DeleteUser, self).get_parser(prog_name) parser.add_argument( 'users', metavar='', nargs="+", help=_('User(s) to delete (name or ID)'), ) return parser def take_action(self, parsed_args): identity_client = self.app.client_manager.identity errors = 0 for user in parsed_args.users: try: user_obj = utils.find_resource( identity_client.users, user, ) identity_client.users.delete(user_obj.id) except Exception as e: errors += 1 LOG.error(_("Failed to delete user with " "name or ID '%(user)s': %(e)s"), {'user': user, 'e': e}) if errors > 0: total = len(parsed_args.users) msg = (_("%(errors)s of %(total)s users failed " "to delete.") % {'errors': errors, 'total': total}) raise exceptions.CommandError(msg) class ListUser(command.Lister): _description = _("List users") def get_parser(self, prog_name): parser = super(ListUser, self).get_parser(prog_name) parser.add_argument( '--project', metavar='', help=_('Filter users by project (name or ID)'), ) parser.add_argument( '--long', action='store_true', default=False, help=_('List additional fields in output'), ) return parser def take_action(self, parsed_args): identity_client = self.app.client_manager.identity formatters = {} project = None if parsed_args.project: project = utils.find_resource( identity_client.tenants, parsed_args.project, ) project = project.id if parsed_args.long: columns = ( 'ID', 'Name', 'tenantId', 'Email', 'Enabled', ) column_headers = ( 'ID', 'Name', 'Project', 'Email', 'Enabled', ) # Cache the project list project_cache = {} try: for p in identity_client.tenants.list(): project_cache[p.id] = p except Exception: # Just forget it if there's any trouble pass formatters['tenantId'] = functools.partial( ProjectColumn, project_cache=project_cache) else: columns = column_headers = ('ID', 'Name') data = identity_client.users.list(tenant_id=project) if parsed_args.project: d = {} for s in data: d[s.id] = s data = d.values() if parsed_args.long: # FIXME(dtroyer): Sometimes user objects have 'tenant_id' instead # of 'tenantId'. Why? Dunno yet, but until that # is fixed we need to handle it; auth_token.py # only looks for 'tenantId'. for d in data: if 'tenant_id' in d._info: d._info['tenantId'] = d._info.pop('tenant_id') d._add_details(d._info) return (column_headers, (utils.get_item_properties( s, columns, mixed_case_fields=('tenantId',), formatters=formatters, ) for s in data)) class SetUser(command.Command): _description = _("Set user properties") def get_parser(self, prog_name): parser = super(SetUser, self).get_parser(prog_name) parser.add_argument( 'user', metavar='', help=_('User to modify (name or ID)'), ) parser.add_argument( '--name', metavar='', help=_('Set user name'), ) parser.add_argument( '--project', metavar='', help=_('Set default project (name or ID)'), ) parser.add_argument( '--password', metavar='', help=_('Set user password'), ) parser.add_argument( '--password-prompt', dest="password_prompt", action="store_true", help=_('Prompt interactively for password'), ) parser.add_argument( '--email', metavar='', help=_('Set user email address'), ) enable_group = parser.add_mutually_exclusive_group() enable_group.add_argument( '--enable', action='store_true', help=_('Enable user (default)'), ) enable_group.add_argument( '--disable', action='store_true', help=_('Disable user'), ) return parser def take_action(self, parsed_args): identity_client = self.app.client_manager.identity if parsed_args.password_prompt: parsed_args.password = utils.get_password(self.app.stdin) if '' == parsed_args.password: LOG.warning(_("No password was supplied, authentication will fail " "when a user does not have a password.")) user = utils.find_resource( identity_client.users, parsed_args.user, ) if parsed_args.password: identity_client.users.update_password( user.id, parsed_args.password, ) if parsed_args.project: project = utils.find_resource( identity_client.tenants, parsed_args.project, ) identity_client.users.update_tenant( user.id, project.id, ) kwargs = {} if parsed_args.name: kwargs['name'] = parsed_args.name if parsed_args.email: kwargs['email'] = parsed_args.email kwargs['enabled'] = user.enabled if parsed_args.enable: kwargs['enabled'] = True if parsed_args.disable: kwargs['enabled'] = False identity_client.users.update(user.id, **kwargs) class ShowUser(command.ShowOne): _description = _("Display user details") def get_parser(self, prog_name): parser = super(ShowUser, self).get_parser(prog_name) parser.add_argument( 'user', metavar='', help=_('User to display (name or ID)'), ) return parser def take_action(self, parsed_args): identity_client = self.app.client_manager.identity info = {} try: user = utils.find_resource( identity_client.users, parsed_args.user, ) info.update(user._info) except ks_exc.Forbidden: auth_ref = self.app.client_manager.auth_ref if ( parsed_args.user == auth_ref.user_id or parsed_args.user == auth_ref.username ): # Ask for currently auth'ed project so return it info = { 'id': auth_ref.user_id, 'name': auth_ref.username, 'project_id': auth_ref.project_id, # True because we don't get this far if it is disabled 'enabled': True, } else: raise if 'tenantId' in info: info.update( {'project_id': info.pop('tenantId')} ) if 'tenant_id' in info: info.update( {'project_id': info.pop('tenant_id')} ) return zip(*sorted(info.items()))