From db3b293cdea31b5a2b4fab1108d905832ee15550 Mon Sep 17 00:00:00 2001 From: Lance Bragstad Date: Fri, 22 Mar 2019 21:08:25 +0000 Subject: [PATCH] Implement system reader functionality for grants This commit opens up the assignment API for system readers and system members to list and check grants for users and groups on projects and domains. Subsequent patches will: - refactor system admin policy checks - implement domain reader and member support - implement domain admin support - introduce test coverage for project users and the grants API - remove redundant policies from policy.v3cloudsample.json Change-Id: I04bafe2f7c83addddf18591eaeba80277321139b Related-Bug: 1805368 Related-Bug: 1750669 Related-Bug: 1806762 (cherry picked from commit d1cfa3ab3f87f15f61c5387670d3b75ee2ba93ba) --- keystone/common/policies/grant.py | 24 +- .../tests/unit/protection/v3/test_grants.py | 462 ++++++++++++++++++ 2 files changed, 480 insertions(+), 6 deletions(-) create mode 100644 keystone/tests/unit/protection/v3/test_grants.py diff --git a/keystone/common/policies/grant.py b/keystone/common/policies/grant.py index c5f22da57e..57a8593e64 100644 --- a/keystone/common/policies/grant.py +++ b/keystone/common/policies/grant.py @@ -47,10 +47,16 @@ deprecated_revoke_system_grant_for_group = policy.DeprecatedRule( name=base.IDENTITY % 'revoke_system_grant_for_group', check_str=base.RULE_ADMIN_REQUIRED ) +deprecated_list_grants = policy.DeprecatedRule( + name=base.IDENTITY % 'list_grants', check_str=base.RULE_ADMIN_REQUIRED +) +deprecated_check_grant = policy.DeprecatedRule( + name=base.IDENTITY % 'check_grant', check_str=base.RULE_ADMIN_REQUIRED +) DEPRECATED_REASON = """ -As of the Stein release, the system assignment API now understands default -roles and system-scoped tokens, making the API more granular by default without +As of the Stein release, the assignment API now understands default roles and +system-scoped tokens, making the API more granular by default without compromising security. The new policy defaults account for these changes automatically. Be sure to take these new defaults into consideration if you are relying on overrides in your deployment for the system assignment API. @@ -99,7 +105,7 @@ list_grants_operations = ( grant_policies = [ policy.DocumentedRuleDefault( name=base.IDENTITY % 'check_grant', - check_str=base.RULE_ADMIN_REQUIRED, + check_str=base.SYSTEM_READER, # FIXME(lbragstad): A system administrator should be able to grant role # assignments from any actor to any target in the deployment. Domain # administrators should only be able to grant access to the domain they @@ -113,10 +119,13 @@ grant_policies = [ 'to the OS-INHERIT APIs, where grants on the target ' 'are inherited to all projects in the subtree, if ' 'applicable.'), - operations=list_operations(resource_paths, ['HEAD', 'GET'])), + operations=list_operations(resource_paths, ['HEAD', 'GET']), + deprecated_rule=deprecated_check_grant, + deprecated_reason=DEPRECATED_REASON, + deprecated_since=versionutils.deprecated.STEIN), policy.DocumentedRuleDefault( name=base.IDENTITY % 'list_grants', - check_str=base.RULE_ADMIN_REQUIRED, + check_str=base.SYSTEM_READER, # FIXME(lbragstad): See the above comment about scope_types before # adding 'project' to scope_types below. scope_types=['system'], @@ -126,7 +135,10 @@ grant_policies = [ 'is possible to list inherited role grants for actors on ' 'domains, where grants are inherited to all projects ' 'in the specified domain.'), - operations=list_grants_operations), + operations=list_grants_operations, + deprecated_rule=deprecated_list_grants, + deprecated_reason=DEPRECATED_REASON, + deprecated_since=versionutils.deprecated.STEIN), policy.DocumentedRuleDefault( name=base.IDENTITY % 'create_grant', check_str=base.RULE_ADMIN_REQUIRED, diff --git a/keystone/tests/unit/protection/v3/test_grants.py b/keystone/tests/unit/protection/v3/test_grants.py new file mode 100644 index 0000000000..9f9be8bf45 --- /dev/null +++ b/keystone/tests/unit/protection/v3/test_grants.py @@ -0,0 +1,462 @@ +# 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. + +import uuid + +from six.moves import http_client + +from keystone.common import provider_api +import keystone.conf +from keystone.tests.common import auth as common_auth +from keystone.tests import unit +from keystone.tests.unit import base_classes +from keystone.tests.unit import ksfixtures + +CONF = keystone.conf.CONF +PROVIDERS = provider_api.ProviderAPIs + + +class _SystemUserGrantTests(object): + + def test_user_can_list_grants_for_user_on_project(self): + user = PROVIDERS.identity_api.create_user( + unit.new_user_ref(domain_id=CONF.identity.default_domain_id) + ) + + project = PROVIDERS.resource_api.create_project( + uuid.uuid4().hex, unit.new_project_ref( + domain_id=CONF.identity.default_domain_id + ) + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, user_id=user['id'], + project_id=project['id'] + ) + + with self.test_client() as c: + r = c.get( + '/v3/projects/%s/users/%s/roles' % (project['id'], user['id']), + headers=self.headers + ) + self.assertEqual(1, len(r.json['roles'])) + + def test_user_can_list_grants_for_user_on_domain(self): + user = PROVIDERS.identity_api.create_user( + unit.new_user_ref(domain_id=CONF.identity.default_domain_id) + ) + + domain = PROVIDERS.resource_api.create_domain( + uuid.uuid4().hex, unit.new_domain_ref() + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, user_id=user['id'], + domain_id=domain['id'] + ) + + with self.test_client() as c: + r = c.get( + '/v3/domains/%s/users/%s/roles' % (domain['id'], user['id']), + headers=self.headers + ) + self.assertEqual(1, len(r.json['roles'])) + + def test_user_can_list_grants_for_group_on_project(self): + group = PROVIDERS.identity_api.create_group( + unit.new_group_ref(domain_id=CONF.identity.default_domain_id) + ) + + project = PROVIDERS.resource_api.create_project( + uuid.uuid4().hex, unit.new_project_ref( + domain_id=CONF.identity.default_domain_id + ) + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, group_id=group['id'], + project_id=project['id'] + ) + + with self.test_client() as c: + r = c.get( + '/v3/projects/%s/groups/%s/roles' % ( + project['id'], group['id']), + headers=self.headers + ) + self.assertEqual(1, len(r.json['roles'])) + + def test_user_can_list_grants_for_group_on_domain(self): + group = PROVIDERS.identity_api.create_group( + unit.new_group_ref(domain_id=CONF.identity.default_domain_id) + ) + + domain = PROVIDERS.resource_api.create_domain( + uuid.uuid4().hex, unit.new_domain_ref() + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, group_id=group['id'], + domain_id=domain['id'] + ) + + with self.test_client() as c: + r = c.get( + '/v3/domains/%s/groups/%s/roles' % (domain['id'], group['id']), + headers=self.headers + ) + self.assertEqual(1, len(r.json['roles'])) + + def test_user_can_check_grant_for_user_on_project(self): + user = PROVIDERS.identity_api.create_user( + unit.new_user_ref(domain_id=CONF.identity.default_domain_id) + ) + + project = PROVIDERS.resource_api.create_project( + uuid.uuid4().hex, unit.new_project_ref( + domain_id=CONF.identity.default_domain_id + ) + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, user_id=user['id'], + project_id=project['id'] + ) + + with self.test_client() as c: + c.get( + '/v3/projects/%s/users/%s/roles/%s' % ( + project['id'], user['id'], self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.NO_CONTENT + ) + + def test_user_can_check_grant_for_user_on_domain(self): + user = PROVIDERS.identity_api.create_user( + unit.new_user_ref(domain_id=CONF.identity.default_domain_id) + ) + + domain = PROVIDERS.resource_api.create_domain( + uuid.uuid4().hex, unit.new_domain_ref() + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, user_id=user['id'], + domain_id=domain['id'] + ) + + with self.test_client() as c: + c.get( + '/v3/domains/%s/users/%s/roles/%s' % ( + domain['id'], user['id'], self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.NO_CONTENT + ) + + def test_user_can_check_grant_for_group_on_project(self): + group = PROVIDERS.identity_api.create_group( + unit.new_group_ref(domain_id=CONF.identity.default_domain_id) + ) + + project = PROVIDERS.resource_api.create_project( + uuid.uuid4().hex, unit.new_project_ref( + domain_id=CONF.identity.default_domain_id + ) + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, group_id=group['id'], + project_id=project['id'] + ) + + with self.test_client() as c: + c.get( + '/v3/projects/%s/groups/%s/roles/%s' % ( + project['id'], + group['id'], + self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.NO_CONTENT + ) + + def test_user_can_check_grant_for_group_on_domain(self): + group = PROVIDERS.identity_api.create_group( + unit.new_group_ref(domain_id=CONF.identity.default_domain_id) + ) + + domain = PROVIDERS.resource_api.create_domain( + uuid.uuid4().hex, unit.new_domain_ref() + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, group_id=group['id'], + domain_id=domain['id'] + ) + + with self.test_client() as c: + c.get( + '/v3/domains/%s/groups/%s/roles/%s' % ( + domain['id'], group['id'], self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.NO_CONTENT + ) + + +class _SystemMemberAndReaderGrantTests(object): + + def test_user_cannot_create_grant_for_user_on_project(self): + user = PROVIDERS.identity_api.create_user( + unit.new_user_ref(domain_id=CONF.identity.default_domain_id) + ) + + project = PROVIDERS.resource_api.create_project( + uuid.uuid4().hex, unit.new_project_ref( + domain_id=CONF.identity.default_domain_id + ) + ) + + with self.test_client() as c: + c.put( + '/v3/projects/%s/users/%s/roles/%s' % ( + project['id'], user['id'], self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.FORBIDDEN + ) + + def test_user_cannot_create_grant_for_user_on_domain(self): + user = PROVIDERS.identity_api.create_user( + unit.new_user_ref(domain_id=CONF.identity.default_domain_id) + ) + + domain = PROVIDERS.resource_api.create_domain( + uuid.uuid4().hex, unit.new_domain_ref() + ) + + with self.test_client() as c: + c.put( + '/v3/domains/%s/users/%s/roles/%s' % ( + domain['id'], user['id'], self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.FORBIDDEN + ) + + def test_user_cannot_create_grant_for_group_on_project(self): + group = PROVIDERS.identity_api.create_group( + unit.new_group_ref(domain_id=CONF.identity.default_domain_id) + ) + + project = PROVIDERS.resource_api.create_project( + uuid.uuid4().hex, unit.new_project_ref( + domain_id=CONF.identity.default_domain_id + ) + ) + + with self.test_client() as c: + c.put( + '/v3/projects/%s/groups/%s/roles/%s' % ( + project['id'], + group['id'], + self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.FORBIDDEN + ) + + def test_user_cannot_create_grant_for_group_on_domain(self): + group = PROVIDERS.identity_api.create_group( + unit.new_group_ref(domain_id=CONF.identity.default_domain_id) + ) + + domain = PROVIDERS.resource_api.create_domain( + uuid.uuid4().hex, unit.new_domain_ref() + ) + + with self.test_client() as c: + c.put( + '/v3/domains/%s/groups/%s/roles/%s' % ( + domain['id'], group['id'], self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.FORBIDDEN + ) + + def test_user_cannot_revoke_grant_from_user_on_project(self): + user = PROVIDERS.identity_api.create_user( + unit.new_user_ref(domain_id=CONF.identity.default_domain_id) + ) + + project = PROVIDERS.resource_api.create_project( + uuid.uuid4().hex, unit.new_project_ref( + domain_id=CONF.identity.default_domain_id + ) + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, user_id=user['id'], + project_id=project['id'] + ) + + with self.test_client() as c: + c.delete( + '/v3/projects/%s/users/%s/roles/%s' % ( + project['id'], user['id'], self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.FORBIDDEN + ) + + def test_user_cannot_revoke_grant_from_user_on_domain(self): + user = PROVIDERS.identity_api.create_user( + unit.new_user_ref(domain_id=CONF.identity.default_domain_id) + ) + + domain = PROVIDERS.resource_api.create_domain( + uuid.uuid4().hex, unit.new_domain_ref() + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, user_id=user['id'], + domain_id=domain['id'] + ) + + with self.test_client() as c: + c.delete( + '/v3/domains/%s/users/%s/roles/%s' % ( + domain['id'], user['id'], self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.FORBIDDEN + ) + + def test_user_cannot_revoke_grant_from_group_on_project(self): + group = PROVIDERS.identity_api.create_group( + unit.new_group_ref(domain_id=CONF.identity.default_domain_id) + ) + + project = PROVIDERS.resource_api.create_project( + uuid.uuid4().hex, unit.new_project_ref( + domain_id=CONF.identity.default_domain_id + ) + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, group_id=group['id'], + project_id=project['id'] + ) + + with self.test_client() as c: + c.delete( + '/v3/projects/%s/groups/%s/roles/%s' % ( + project['id'], + group['id'], + self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.FORBIDDEN + ) + + def test_user_cannot_revoke_grant_from_group_on_domain(self): + group = PROVIDERS.identity_api.create_group( + unit.new_group_ref(domain_id=CONF.identity.default_domain_id) + ) + + domain = PROVIDERS.resource_api.create_domain( + uuid.uuid4().hex, unit.new_domain_ref() + ) + + PROVIDERS.assignment_api.create_grant( + self.bootstrapper.reader_role_id, group_id=group['id'], + domain_id=domain['id'] + ) + + with self.test_client() as c: + c.delete( + '/v3/domains/%s/groups/%s/roles/%s' % ( + domain['id'], group['id'], self.bootstrapper.reader_role_id + ), + headers=self.headers, + expected_status_code=http_client.FORBIDDEN + ) + + +class SystemReaderTests(base_classes.TestCaseWithBootstrap, + common_auth.AuthTestMixin, + _SystemUserGrantTests, + _SystemMemberAndReaderGrantTests): + + def setUp(self): + super(SystemReaderTests, self).setUp() + self.loadapp() + self.useFixture(ksfixtures.Policy(self.config_fixture)) + self.config_fixture.config(group='oslo_policy', enforce_scope=True) + + system_reader = unit.new_user_ref( + domain_id=CONF.identity.default_domain_id + ) + self.user_id = PROVIDERS.identity_api.create_user( + system_reader + )['id'] + PROVIDERS.assignment_api.create_system_grant_for_user( + self.user_id, self.bootstrapper.reader_role_id + ) + + auth = self.build_authentication_request( + user_id=self.user_id, password=system_reader['password'], + system=True + ) + + # Grab a token using the persona we're testing and prepare headers + # for requests we'll be making in the tests. + with self.test_client() as c: + r = c.post('/v3/auth/tokens', json=auth) + self.token_id = r.headers['X-Subject-Token'] + self.headers = {'X-Auth-Token': self.token_id} + + +class SystemMemberTests(base_classes.TestCaseWithBootstrap, + common_auth.AuthTestMixin, + _SystemUserGrantTests, + _SystemMemberAndReaderGrantTests): + + def setUp(self): + super(SystemMemberTests, self).setUp() + self.loadapp() + self.useFixture(ksfixtures.Policy(self.config_fixture)) + self.config_fixture.config(group='oslo_policy', enforce_scope=True) + + system_member = unit.new_user_ref( + domain_id=CONF.identity.default_domain_id + ) + self.user_id = PROVIDERS.identity_api.create_user( + system_member + )['id'] + PROVIDERS.assignment_api.create_system_grant_for_user( + self.user_id, self.bootstrapper.member_role_id + ) + + auth = self.build_authentication_request( + user_id=self.user_id, password=system_member['password'], + system=True + ) + + # Grab a token using the persona we're testing and prepare headers + # for requests we'll be making in the tests. + with self.test_client() as c: + r = c.post('/v3/auth/tokens', json=auth) + self.token_id = r.headers['X-Subject-Token'] + self.headers = {'X-Auth-Token': self.token_id}