neutron/neutron/tests/unit/conf/policies/test_base.py
Slawek Kaplonski 2d099c4396 Update secure RBAC policies accordingly to the new guidelines
According to discussions during the PTG and to the updated community
goal which is in [1] we need to modify new default RBAC rules to reflect
what was agreed there.
Basically what this patch is doing is:
* modify scope_types for most of the API rules to be available only in one
  scope, either "project" or "system" and not in both,
* allow PROJECT_ADMIN to do things which are "infrastructure related"
  like e.g. creating provider networks. Previously it was possible for
  SYSTEM_ADMIN users only,
* Modify all policies UT to reflect changes made in the default rules,
* Additionally this patch adds unit test which ensures that rules have
  no more than 1 scope. In case when rules needs to be available in more
  than one scope, that needs to be explicitly added to the exceptions
  list.

[1] https://governance.openstack.org/tc/goals/selected/consistent-and-secure-rbac.html

Change-Id: I8f0eab0973d73d7c632944418431b1cd3c44e15b
2022-01-19 12:00:53 +00:00

126 lines
4.8 KiB
Python

# Copyright (c) 2021 Red Hat Inc.
#
# 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 warnings
from neutron_lib import context
from oslo_config import cfg
from oslo_utils import uuidutils
from neutron import policy
from neutron.tests import base as tests_base
# According to the community goal guidelines
# https://governance.openstack.org/tc/goals/selected/consistent-and-secure-rbac.html#re-evaluate-project-specific-api-policies
# each rule should have only one scope type,
# If for any reason, rule needs to have more than one scope, it should be
# listed in that list of exceptions.
# This is dictionary where key is the rule name and value is list of the
# rule scopes, like e.g.:
#
# {
# 'rule_name': ["system", "project"],
# 'rule_name_2': ["system", "domain"]
# }
SCOPE_TYPES_EXCEPTIONS = {
'get_flavor_service_profile': ['system', 'project'],
'get_flavor': ['system', 'project'],
'get_rule_type': ['system', 'project'],
'get_service_provider': ['system', 'project'],
}
class PolicyBaseTestCase(tests_base.BaseTestCase):
def setUp(self):
# NOTE(slaweq): Because of issue with stestr and Python3, we need
# to avoid too much output to be produced during tests, so we will
# ignore python warnings in the tests policy tests
warnings.simplefilter("ignore")
# NOTE(slaweq): Enforcing new policies has to be done before calling
# super() as in BaseTestCase policies are initialized and config
# options has to be set properly at that point already.
# That tests are testing only new default policies.
cfg.CONF.set_override(
'enforce_new_defaults', True, group='oslo_policy')
# TODO(slaweq): Remove that override once fix
# https://review.opendev.org/c/openstack/oslo.policy/+/804980 will be
# merged and released in oslo_policy
cfg.CONF.set_override(
'enforce_scope', True, group='oslo_policy')
super(PolicyBaseTestCase, self).setUp()
self.project_id = uuidutils.generate_uuid()
self.system_user_id = uuidutils.generate_uuid()
self.user_id = uuidutils.generate_uuid()
self._prepare_system_scope_personas()
self._prepare_project_scope_personas()
self.alt_project_id = uuidutils.generate_uuid()
def _prepare_system_scope_personas(self):
self.system_admin_ctx = context.Context(
user_id=self.system_user_id,
roles=['admin', 'member', 'reader'],
system_scope='all')
self.system_member_ctx = context.Context(
user_id=self.system_user_id,
roles=['member', 'reader'],
system_scope='all')
self.system_reader_ctx = context.Context(
user_id=self.system_user_id,
roles=['reader'],
system_scope='all')
def _prepare_project_scope_personas(self):
self.project_admin_ctx = context.Context(
user_id=self.user_id,
roles=['admin', 'member', 'reader'],
project_id=self.project_id)
self.project_member_ctx = context.Context(
user_id=self.user_id,
roles=['member', 'reader'],
project_id=self.project_id)
self.project_reader_ctx = context.Context(
user_id=self.user_id,
roles=['reader'],
project_id=self.project_id)
class RuleScopesTestCase(PolicyBaseTestCase):
def setUp(self):
super(RuleScopesTestCase, self).setUp()
policy.init()
def test_rules_are_single_scoped(self):
for rule_name, rule in policy._ENFORCER.registered_rules.items():
if not rule.scope_types:
# If scope types are not set for rule, that's ok
continue
if len(rule.scope_types) == 1:
# If rule has only one scope, it's fine
continue
else:
expected_scope_types = SCOPE_TYPES_EXCEPTIONS.get(
rule_name, [])
fail_msg = (
"Rule %s have scope types %s which are not defined "
"in the exceptions list: %s" % (
rule_name, rule.scope_types, expected_scope_types))
self.assertListEqual(expected_scope_types,
rule.scope_types,
fail_msg)