5d93e928d0
Fixes: bug #1175356 Future implementations of keystone API v3 will support server-side filtering using key/value attributes. See additional details: https://github.com/openstack/identity-api/blob/master/openstack-identity-api/src/markdown/identity-api-v3.md#list-entities-filtered-by-attribute To support this functionality **kwargs need to be passed from the v3 API classes to keystoneclient.base.CrudManager.list. This is not fully implemented server-side for all attributes so it's difficult to document exactly which attributes will work. An example of a working attribute is: keystone.users.list(name="someone") Change-Id: I148093fbe37700f890ed44148aa3f63f34ee5ff5
135 lines
4.8 KiB
Python
135 lines
4.8 KiB
Python
# Copyright 2011 OpenStack LLC.
|
|
# Copyright 2011 Nebula, Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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 import base
|
|
from keystoneclient import exceptions
|
|
|
|
|
|
class Role(base.Resource):
|
|
"""Represents an Identity role.
|
|
|
|
Attributes:
|
|
* id: a uuid that identifies the role
|
|
* name: user-facing identifier
|
|
|
|
"""
|
|
pass
|
|
|
|
|
|
class RoleManager(base.CrudManager):
|
|
"""Manager class for manipulating Identity roles."""
|
|
resource_class = Role
|
|
collection_key = 'roles'
|
|
key = 'role'
|
|
|
|
def _role_grants_base_url(self, user, group, domain, project):
|
|
# When called, we have already checked that only one of user & group
|
|
# and one of domain & project have been specified
|
|
params = {}
|
|
|
|
if project:
|
|
params['project_id'] = base.getid(project)
|
|
base_url = '/projects/%(project_id)s'
|
|
elif domain:
|
|
params['domain_id'] = base.getid(domain)
|
|
base_url = '/domains/%(domain_id)s'
|
|
|
|
if user:
|
|
params['user_id'] = base.getid(user)
|
|
base_url += '/users/%(user_id)s'
|
|
elif group:
|
|
params['group_id'] = base.getid(group)
|
|
base_url += '/groups/%(group_id)s'
|
|
|
|
return base_url % params
|
|
|
|
def _require_domain_xor_project(self, domain, project):
|
|
if (domain and project) or (not domain and not project):
|
|
msg = 'Specify either a domain or project, not both'
|
|
raise exceptions.ValidationError(msg)
|
|
|
|
def _require_user_xor_group(self, user, group):
|
|
if (user and group) or (not user and not group):
|
|
msg = 'Specify either a user or group, not both'
|
|
raise exceptions.ValidationError(msg)
|
|
|
|
def create(self, name):
|
|
return super(RoleManager, self).create(
|
|
name=name)
|
|
|
|
def get(self, role):
|
|
return super(RoleManager, self).get(
|
|
role_id=base.getid(role))
|
|
|
|
def list(self, user=None, group=None, domain=None, project=None, **kwargs):
|
|
"""Lists roles and role grants.
|
|
|
|
If no arguments are provided, all roles in the system will be
|
|
listed.
|
|
|
|
If a user or group is specified, you must also specify either a
|
|
domain or project to list role grants on that pair. And if
|
|
``**kwargs`` are provided, then also filter roles with
|
|
attributes matching ``**kwargs``.
|
|
"""
|
|
|
|
if user or group:
|
|
self._require_user_xor_group(user, group)
|
|
self._require_domain_xor_project(domain, project)
|
|
|
|
return super(RoleManager, self).list(
|
|
base_url=self._role_grants_base_url(user, group,
|
|
domain, project),
|
|
**kwargs)
|
|
|
|
return super(RoleManager, self).list()
|
|
|
|
def update(self, role, name=None):
|
|
return super(RoleManager, self).update(
|
|
role_id=base.getid(role),
|
|
name=name)
|
|
|
|
def delete(self, role):
|
|
return super(RoleManager, self).delete(
|
|
role_id=base.getid(role))
|
|
|
|
def grant(self, role, user=None, group=None, domain=None, project=None):
|
|
"""Grants a role to a user or group on a domain or project."""
|
|
self._require_domain_xor_project(domain, project)
|
|
self._require_user_xor_group(user, group)
|
|
|
|
return super(RoleManager, self).put(
|
|
base_url=self._role_grants_base_url(user, group, domain, project),
|
|
role_id=base.getid(role))
|
|
|
|
def check(self, role, user=None, group=None, domain=None, project=None):
|
|
"""Checks if a user or group has a role on a domain or project."""
|
|
self._require_domain_xor_project(domain, project)
|
|
self._require_user_xor_group(user, group)
|
|
|
|
return super(RoleManager, self).head(
|
|
base_url=self._role_grants_base_url(user, group, domain, project),
|
|
role_id=base.getid(role))
|
|
|
|
def revoke(self, role, user=None, group=None, domain=None, project=None):
|
|
"""Revokes a role from a user or group on a domain or project."""
|
|
self._require_domain_xor_project(domain, project)
|
|
self._require_user_xor_group(user, group)
|
|
|
|
return super(RoleManager, self).delete(
|
|
base_url=self._role_grants_base_url(user, group, domain, project),
|
|
role_id=base.getid(role))
|