keystone/keystone/common/policies/token.py
Colleen Murphy 0526718fee Make policy deprecation reasons less verbose
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
2019-09-20 08:58:52 -07:00

83 lines
2.9 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
DEPRECATED_REASON = (
"The token API is now aware of system scope and default roles."
)
deprecated_check_token = policy.DeprecatedRule(
name=base.IDENTITY % 'check_token',
check_str=base.RULE_ADMIN_OR_TOKEN_SUBJECT
)
deprecated_validate_token = policy.DeprecatedRule(
name=base.IDENTITY % 'validate_token',
check_str=base.RULE_SERVICE_ADMIN_OR_TOKEN_SUBJECT
)
deprecated_revoke_token = policy.DeprecatedRule(
name=base.IDENTITY % 'revoke_token',
check_str=base.RULE_ADMIN_OR_TOKEN_SUBJECT
)
SYSTEM_ADMIN_OR_TOKEN_SUBJECT = (
'(role:admin and system_scope:all) or rule:token_subject' # nosec
)
SYSTEM_USER_OR_TOKEN_SUBJECT = (
'(role:reader and system_scope:all) or rule:token_subject' # nosec
)
SYSTEM_USER_OR_SERVICE_OR_TOKEN_SUBJECT = (
'(role:reader and system_scope:all) ' # nosec
'or rule:service_role or rule:token_subject' # nosec
)
token_policies = [
policy.DocumentedRuleDefault(
name=base.IDENTITY % 'check_token',
check_str=SYSTEM_USER_OR_TOKEN_SUBJECT,
scope_types=['system', 'domain', 'project'],
description='Check a token.',
operations=[{'path': '/v3/auth/tokens',
'method': 'HEAD'}],
deprecated_rule=deprecated_check_token,
deprecated_reason=DEPRECATED_REASON,
deprecated_since=versionutils.deprecated.TRAIN),
policy.DocumentedRuleDefault(
name=base.IDENTITY % 'validate_token',
check_str=SYSTEM_USER_OR_SERVICE_OR_TOKEN_SUBJECT,
scope_types=['system', 'domain', 'project'],
description='Validate a token.',
operations=[{'path': '/v3/auth/tokens',
'method': 'GET'}],
deprecated_rule=deprecated_validate_token,
deprecated_reason=DEPRECATED_REASON,
deprecated_since=versionutils.deprecated.TRAIN),
policy.DocumentedRuleDefault(
name=base.IDENTITY % 'revoke_token',
check_str=SYSTEM_ADMIN_OR_TOKEN_SUBJECT,
scope_types=['system', 'domain', 'project'],
description='Revoke a token.',
operations=[{'path': '/v3/auth/tokens',
'method': 'DELETE'}],
deprecated_rule=deprecated_revoke_token,
deprecated_reason=DEPRECATED_REASON,
deprecated_since=versionutils.deprecated.TRAIN)
]
def list_rules():
return token_policies