# octavia.common.policy

# Source code for octavia.common.policy

    #    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.

    """Policy Engine For Octavia."""
    from oslo_config import cfg
    from oslo_log import log as logging
    from oslo_policy import opts
    from oslo_policy import policy as oslo_policy
    from oslo_utils import excutils

    from octavia.common import exceptions
    from octavia import policies

    LOG = logging.getLogger(__name__)
    OCTAVIA_POLICY = None

    # TODO(gmann): Remove setting the default value of config policy_file
    # once oslo_policy change the default value to 'policy.yaml'.
    # https://github.com/openstack/oslo.policy/blob/a626ad12fe5a3abd49d70e3e5b95589d279ab578/oslo_policy/opts.py#L49
    DEFAULT_POLICY_FILE = 'policy.yaml'
    opts.set_defaults(cfg.CONF, DEFAULT_POLICY_FILE)

    def get_enforcer():
        global OCTAVIA_POLICY
        if OCTAVIA_POLICY is None:
            LOG.debug('Loading octavia policy object.')
            OCTAVIA_POLICY = Policy()
        return OCTAVIA_POLICY

    def reset():
        global OCTAVIA_POLICY
        if OCTAVIA_POLICY:
            OCTAVIA_POLICY.clear()
            OCTAVIA_POLICY = None

    class Policy(oslo_policy.Enforcer):

        def __init__(self, conf=cfg.CONF, policy_file=None, rules=None,
                     default_rule=None, use_conf=True, overwrite=True):
            """Init an Enforcer class.

                :param context: A context object.
                :param conf: A configuration object.
                :param policy_file: Custom policy file to use, if none is
                                    specified, ``conf.oslo_policy.policy_file``
                                    will be used.
                :param rules: Default dictionary / Rules to use. It will be
                              considered just in the first instantiation. If
                              :meth:`load_rules` with ``force_reload=True``,
                              :meth:`clear` or :meth:`set_rules` with
                              ``overwrite=True`` is called this will be
                              overwritten.
                :param default_rule: Default rule to use, conf.default_rule will
                                     be used if none is specified.
                :param use_conf: Whether to load rules from cache or config file.
                :param overwrite: Whether to overwrite existing rules when reload
                                  rules from config file.
            """

            super().__init__(conf, policy_file, rules, default_rule, use_conf,
                             overwrite)

            self.register_defaults(policies.list_rules())

        def authorize(self, action, target, context, do_raise=True, exc=None):
            """Verifies that the action is valid on the target in this context.

               :param context: The oslo context for this request.
               :param action: string representing the action to be checked
                   this should be colon separated for clarity.
                   i.e. ``compute:create_instance``,
                   ``compute:attach_volume``,
                   ``volume:attach_volume``
               :param target: dictionary representing the object of the action
                   for object creation this should be a dictionary representing the
                   location of the object e.g.
                   ``{'project_id': context.project_id}``
               :param do_raise: if True (the default), raises PolicyForbidden;
                   if False, returns False
               :param exc: Class of the exceptions to raise if the check fails.
                           Any remaining arguments passed to :meth:`enforce` (both
                           positional and keyword arguments) will be passed to
                           the exceptions class. If not specified,
                           :class:`PolicyForbidden` will be used.

               :raises PolicyForbidden: if verification fails
                   and do_raise is True. Or if 'exc' is specified it will raise an
                   exceptions of that type.

               :return: returns a non-False value (not necessarily "True") if
                   authorized, and the exact value False if not authorized and
                   do_raise is False.
            """
            credentials = context.to_policy_values()
            # Inject is_admin into the credentials to allow override via
            # config auth_strategy = constants.NOAUTH
            credentials['is_admin'] = (
                credentials.get('is_admin') or context.is_admin)

            if not exc:
                exc = exceptions.PolicyForbidden

            try:
                return super().authorize(
                    action, target, credentials, do_raise=do_raise, exc=exc)
            except oslo_policy.PolicyNotRegistered:
                with excutils.save_and_reraise_exception():
                    LOG.exception('Policy not registered')
            except Exception:
                credentials.pop('auth_token', None)
                with excutils.save_and_reraise_exception():
                    LOG.debug('Policy check for %(action)s failed with '
                              'credentials %(credentials)s',
                              {'action': action, 'credentials': credentials})
            return None

        def check_is_admin(self, context):
            """Does roles contains 'admin' role according to policy setting.

            """
            credentials = context.to_dict()
            result = False
            try:
                result = self.enforce('context_is_admin', credentials, credentials)
            except oslo_policy.InvalidScope as e:
                # This will happen if the token being used is not system scoped
                # which is required for the admin roles when scope checking is
                # enabled.
                LOG.warning(str(e))
                return False
            return result

        def get_rules(self):
            return self.rules

    @oslo_policy.register('is_admin')
    class IsAdminCheck(oslo_policy.Check):
        """An explicit check for is_admin."""

        def __init__(self, kind, match):
            """Initialize the check."""

            self.expected = match.lower() == 'true'

            super().__init__(kind, str(self.expected))

        def __call__(self, target, creds, enforcer):
            """Determine whether is_admin matches the requested value."""

            return creds['is_admin'] == self.expected

    # This is used for the oslopolicy-policy-generator tool
    def get_no_context_enforcer():
        return Policy()

this page last updated: 2025-07-16 18:40:57

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug