Implement system reader role in domains API

This commit introduces the system reader role to the API, making it
easier for administrators to delegate subsets of responsibilities to
the API by default.

Subsequent patches will include domain support for:

  - system members test coverage
  - system admins functionality
  - domain user test coverage
  - project user test coverage

Change-Id: I2e0a5de931049627e6ceb48b1c0e44205f3388e1
Partial-Bug: 1794376
Partial-Bug: 968696
This commit is contained in:
Lance Bragstad 2018-09-26 16:47:39 +00:00
parent e287f58fbb
commit 9e8849561b
3 changed files with 191 additions and 5 deletions

View File

@ -29,6 +29,7 @@ RULE_REVOKE_EVENT_OR_ADMIN = 'rule:revoke_event_or_admin'
RULE_SERVICE_ADMIN_OR_TOKEN_SUBJECT = 'rule:service_admin_or_token_subject'
RULE_SERVICE_OR_ADMIN = 'rule:service_or_admin'
RULE_TRUST_OWNER = 'user_id:%(trust.trustor_user_id)s'
READER_ROLE = 'role:reader'
rules = [

View File

@ -10,25 +10,56 @@
# License for the specific language governing permissions and limitations
# under the License.
from oslo_log import versionutils
from oslo_policy import policy
from keystone.common.policies import base
DEPRECATED_REASON = """
As of the Stein release, the domain API now understands how to handle
system-scoped tokens in addition to project-scoped tokens, making the API more
accessible to users without compromising security or manageability for
administrators. The new default policies for this API account for these changes
automatically
"""
deprecated_list_domains = policy.DeprecatedRule(
name=base.IDENTITY % 'list_domains',
check_str=base.RULE_ADMIN_REQUIRED
)
deprecated_get_domain = policy.DeprecatedRule(
name=base.IDENTITY % 'get_domain',
check_str=base.RULE_ADMIN_OR_TARGET_DOMAIN
)
domain_policies = [
policy.DocumentedRuleDefault(
name=base.IDENTITY % 'get_domain',
check_str=base.RULE_ADMIN_OR_TARGET_DOMAIN,
scope_types=['system'],
check_str=(
'(role:reader and system_scope:all) or '
'token.project.domain.id:%(target.domain.id)s'
),
# NOTE(lbragstad): This policy allows system-scope and project-scoped
# tokens because it should be possible for users who have a token
# scoped to a project within a domain to list the domain itself, at
# least according to the legacy policy.
scope_types=['system', 'project'],
description='Show domain details.',
operations=[{'path': '/v3/domains/{domain_id}',
'method': 'GET'}]),
'method': 'GET'}],
deprecated_rule=deprecated_get_domain,
deprecated_reason=DEPRECATED_REASON,
deprecated_since=versionutils.deprecated.STEIN),
policy.DocumentedRuleDefault(
name=base.IDENTITY % 'list_domains',
check_str=base.RULE_ADMIN_REQUIRED,
check_str=base.READER_ROLE,
scope_types=['system'],
description='List domains.',
operations=[{'path': '/v3/domains',
'method': 'GET'}]),
'method': 'GET'}],
deprecated_rule=deprecated_list_domains,
deprecated_reason=DEPRECATED_REASON,
deprecated_since=versionutils.deprecated.STEIN),
policy.DocumentedRuleDefault(
name=base.IDENTITY % 'create_domain',
check_str=base.RULE_ADMIN_REQUIRED,

View File

@ -0,0 +1,154 @@
# 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 _SystemUserDomainTests(object):
def test_user_can_list_domains(self):
domain = PROVIDERS.resource_api.create_domain(
uuid.uuid4().hex, unit.new_domain_ref()
)
with self.test_client() as c:
r = c.get('/v3/domains', headers=self.headers)
domain_ids = []
for domain in r.json['domains']:
domain_ids.append(domain['id'])
self.assertIn(domain['id'], domain_ids)
def test_user_can_filter_domains_by_name(self):
domain_name = uuid.uuid4().hex
domain = unit.new_domain_ref(name=domain_name)
domain = PROVIDERS.resource_api.create_domain(domain['id'], domain)
PROVIDERS.resource_api.create_domain(
uuid.uuid4().hex, unit.new_domain_ref()
)
with self.test_client() as c:
r = c.get(
'/v3/domains?name=%s' % domain_name,
headers=self.headers
)
self.assertEqual(1, len(r.json['domains']))
self.assertEqual(domain['id'], r.json['domains'][0]['id'])
def test_user_can_filter_domains_by_enabled(self):
enabled_domain = PROVIDERS.resource_api.create_domain(
uuid.uuid4().hex, unit.new_domain_ref()
)
disabled_domain = PROVIDERS.resource_api.create_domain(
uuid.uuid4().hex, unit.new_domain_ref(enabled=False)
)
with self.test_client() as c:
r = c.get('/v3/domains?enabled=true', headers=self.headers)
enabled_domain_ids = []
for domain in r.json['domains']:
enabled_domain_ids.append(domain['id'])
self.assertIn(enabled_domain['id'], enabled_domain_ids)
self.assertNotIn(disabled_domain['id'], enabled_domain_ids)
r = c.get('/v3/domains?enabled=false', headers=self.headers)
disabled_domain_ids = []
for domain in r.json['domains']:
disabled_domain_ids.append(domain['id'])
self.assertIn(disabled_domain['id'], disabled_domain_ids)
self.assertNotIn(enabled_domain['id'], disabled_domain_ids)
def test_user_can_get_a_domain(self):
domain = PROVIDERS.resource_api.create_domain(
uuid.uuid4().hex, unit.new_domain_ref()
)
with self.test_client() as c:
r = c.get('/v3/domains/%s' % domain['id'], headers=self.headers)
self.assertEqual(domain['id'], r.json['domain']['id'])
class SystemReaderTests(base_classes.TestCaseWithBootstrap,
common_auth.AuthTestMixin):
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.system_reader_id = PROVIDERS.identity_api.create_user(
system_reader
)['id']
PROVIDERS.assignment_api.create_system_grant_for_user(
self.system_reader_id, self.bootstrapper.reader_role_id
)
auth = self.build_authentication_request(
user_id=self.system_reader_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}
def test_user_cannot_create_a_domain(self):
create = {'domain': {'name': uuid.uuid4().hex}}
with self.test_client() as c:
c.post(
'/v3/domains', json=create, headers=self.headers,
expected_status_code=http_client.FORBIDDEN
)
def test_user_cannot_update_a_domain(self):
domain = PROVIDERS.resource_api.create_domain(
uuid.uuid4().hex, unit.new_domain_ref()
)
update = {'domain': {'description': uuid.uuid4().hex}}
with self.test_client() as c:
c.patch(
'/v3/domains/%s' % domain['id'], json=update,
headers=self.headers,
expected_status_code=http_client.FORBIDDEN
)
def test_user_cannot_delete_a_domain(self):
domain = PROVIDERS.resource_api.create_domain(
uuid.uuid4().hex, unit.new_domain_ref()
)
with self.test_client() as c:
c.delete(
'/v3/domains/%s' % domain['id'], headers=self.headers,
expected_status_code=http_client.FORBIDDEN
)