0526718fee
oslo.policy emits a deprecation warning for every single rule that we have deprecated at least once when a request comes in, and possibly subsequent times if keystone is running in multiple processes, and even more after keystone is reloaded. It's not useful to repeat nearly identical multi-line messages for each policy every time: logs aren't meant to justify our reasoning, they're just meant to be informative. The relevant information and rationalization can be found in the release notes. Repeating these identical multi-line messages starts to use up space quickly and makes the logs unreadable. This patch reduces the DEPRECATED_REASON for each policy to one brief line, which should help make the logs more readable in general and especially when run in a multiprocess environment, reduce the disk footprint of the logs, and help with log indexing. Change-Id: I98a0c06586b18dbd2f6681a24a5af1ea2de70951 Partial-bug: #1836568
209 lines
8.2 KiB
Python
209 lines
8.2 KiB
Python
# 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 oslo_log import versionutils
|
|
from oslo_policy import policy
|
|
|
|
from keystone.common.policies import base
|
|
|
|
SYSTEM_READER_OR_DOMAIN_READER_FOR_TARGET_USER_OR_OWNER = (
|
|
'(role:reader and system_scope:all) or '
|
|
'(role:reader and domain_id:%(target.user.domain_id)s) or '
|
|
'user_id:%(user_id)s'
|
|
)
|
|
|
|
SYSTEM_READER_OR_DOMAIN_READER_FOR_TARGET_GROUP_USER = (
|
|
'(role:reader and system_scope:all) or '
|
|
'(role:reader and '
|
|
'domain_id:%(target.group.domain_id)s and '
|
|
'domain_id:%(target.user.domain_id)s)'
|
|
)
|
|
|
|
SYSTEM_ADMIN_OR_DOMAIN_ADMIN_FOR_TARGET_GROUP_USER = (
|
|
'(role:admin and system_scope:all) or '
|
|
'(role:admin and '
|
|
'domain_id:%(target.group.domain_id)s and '
|
|
'domain_id:%(target.user.domain_id)s)'
|
|
)
|
|
|
|
SYSTEM_READER_OR_DOMAIN_READER = (
|
|
'(role:reader and system_scope:all) or '
|
|
'(role:reader and domain_id:%(target.group.domain_id)s)'
|
|
)
|
|
|
|
SYSTEM_ADMIN_OR_DOMAIN_ADMIN = (
|
|
'(role:admin and system_scope:all) or '
|
|
'(role:admin and domain_id:%(target.group.domain_id)s)'
|
|
)
|
|
|
|
DEPRECATED_REASON = (
|
|
"The group API is now aware of system scope and default roles."
|
|
)
|
|
|
|
deprecated_get_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'get_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_list_groups = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'list_groups',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_list_groups_for_user = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'list_groups_for_user',
|
|
check_str=base.RULE_ADMIN_OR_OWNER
|
|
)
|
|
deprecated_list_users_in_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'list_users_in_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_check_user_in_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'check_user_in_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_create_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'create_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_update_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'update_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_delete_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'delete_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_remove_user_from_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'remove_user_from_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_add_user_to_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'add_user_to_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
|
|
group_policies = [
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'get_group',
|
|
check_str=SYSTEM_READER_OR_DOMAIN_READER,
|
|
scope_types=['system', 'domain'],
|
|
description='Show group details.',
|
|
operations=[{'path': '/v3/groups/{group_id}',
|
|
'method': 'GET'},
|
|
{'path': '/v3/groups/{group_id}',
|
|
'method': 'HEAD'}],
|
|
deprecated_rule=deprecated_get_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'list_groups',
|
|
check_str=SYSTEM_READER_OR_DOMAIN_READER,
|
|
scope_types=['system', 'domain'],
|
|
description='List groups.',
|
|
operations=[{'path': '/v3/groups',
|
|
'method': 'GET'},
|
|
{'path': '/v3/groups',
|
|
'method': 'HEAD'}],
|
|
deprecated_rule=deprecated_list_groups,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'list_groups_for_user',
|
|
check_str=SYSTEM_READER_OR_DOMAIN_READER_FOR_TARGET_USER_OR_OWNER,
|
|
scope_types=['system', 'domain', 'project'],
|
|
description='List groups to which a user belongs.',
|
|
operations=[{'path': '/v3/users/{user_id}/groups',
|
|
'method': 'GET'},
|
|
{'path': '/v3/users/{user_id}/groups',
|
|
'method': 'HEAD'}],
|
|
deprecated_rule=deprecated_list_groups_for_user,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'create_group',
|
|
check_str=SYSTEM_ADMIN_OR_DOMAIN_ADMIN,
|
|
scope_types=['system', 'domain'],
|
|
description='Create group.',
|
|
operations=[{'path': '/v3/groups',
|
|
'method': 'POST'}],
|
|
deprecated_rule=deprecated_create_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'update_group',
|
|
check_str=SYSTEM_ADMIN_OR_DOMAIN_ADMIN,
|
|
scope_types=['system', 'domain'],
|
|
description='Update group.',
|
|
operations=[{'path': '/v3/groups/{group_id}',
|
|
'method': 'PATCH'}],
|
|
deprecated_rule=deprecated_update_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'delete_group',
|
|
check_str=SYSTEM_ADMIN_OR_DOMAIN_ADMIN,
|
|
scope_types=['system', 'domain'],
|
|
description='Delete group.',
|
|
operations=[{'path': '/v3/groups/{group_id}',
|
|
'method': 'DELETE'}],
|
|
deprecated_rule=deprecated_delete_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'list_users_in_group',
|
|
check_str=SYSTEM_READER_OR_DOMAIN_READER,
|
|
scope_types=['system', 'domain'],
|
|
description='List members of a specific group.',
|
|
operations=[{'path': '/v3/groups/{group_id}/users',
|
|
'method': 'GET'},
|
|
{'path': '/v3/groups/{group_id}/users',
|
|
'method': 'HEAD'}],
|
|
deprecated_rule=deprecated_list_users_in_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'remove_user_from_group',
|
|
check_str=SYSTEM_ADMIN_OR_DOMAIN_ADMIN_FOR_TARGET_GROUP_USER,
|
|
scope_types=['system', 'domain'],
|
|
description='Remove user from group.',
|
|
operations=[{'path': '/v3/groups/{group_id}/users/{user_id}',
|
|
'method': 'DELETE'}],
|
|
deprecated_rule=deprecated_remove_user_from_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'check_user_in_group',
|
|
check_str=SYSTEM_READER_OR_DOMAIN_READER_FOR_TARGET_GROUP_USER,
|
|
scope_types=['system', 'domain'],
|
|
description='Check whether a user is a member of a group.',
|
|
operations=[{'path': '/v3/groups/{group_id}/users/{user_id}',
|
|
'method': 'HEAD'},
|
|
{'path': '/v3/groups/{group_id}/users/{user_id}',
|
|
'method': 'GET'}],
|
|
deprecated_rule=deprecated_check_user_in_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'add_user_to_group',
|
|
check_str=SYSTEM_ADMIN_OR_DOMAIN_ADMIN_FOR_TARGET_GROUP_USER,
|
|
scope_types=['system', 'domain'],
|
|
description='Add user to group.',
|
|
operations=[{'path': '/v3/groups/{group_id}/users/{user_id}',
|
|
'method': 'PUT'}],
|
|
deprecated_rule=deprecated_add_user_to_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN)
|
|
]
|
|
|
|
|
|
def list_rules():
|
|
return group_policies
|