-
Notifications
You must be signed in to change notification settings - Fork 27
/
policy.py
1550 lines (1264 loc) · 58.9 KB
/
policy.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
#
# Copyright (c) 2012 OpenStack Foundation.
# All Rights Reserved.
#
# 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.
"""
Common Policy Engine Implementation
Policies are expressed as a target and an associated rule::
"<target>": <rule>
The `target` is specific to the service that is conducting policy
enforcement. Typically, the target refers to an API call.
For the `<rule>` part, see `Policy Rule Expressions`.
Policy Rule Expressions
~~~~~~~~~~~~~~~~~~~~~~~
Policy rules can be expressed in one of two forms: a string written in the new
policy language or a list of lists. The string format is preferred since it's
easier for most people to understand.
In the policy language, each check is specified as a simple "a:b" pair that is
matched to the correct class to perform that check:
+--------------------------------+------------------------------------------+
| TYPE | SYNTAX |
+================================+==========================================+
|User's Role | role:admin |
+--------------------------------+------------------------------------------+
|Rules already defined on policy | rule:admin_required |
+--------------------------------+------------------------------------------+
|Against URLs¹ | http://my-url.org/check |
+--------------------------------+------------------------------------------+
|User attributes² | project_id:%(target.project.id)s |
+--------------------------------+------------------------------------------+
|Strings | - <variable>:'xpto2035abc' |
| | - 'myproject':<variable> |
+--------------------------------+------------------------------------------+
| | - project_id:xpto2035abc |
|Literals | - domain_id:20 |
| | - True:%(user.enabled)s |
+--------------------------------+------------------------------------------+
¹URL checking must return ``True`` to be valid
²User attributes (obtained through the token): user_id, domain_id or project_id
Conjunction operators ``and`` and ``or`` are available, allowing for more
expressiveness in crafting policies. For example::
"role:admin or (project_id:%(project_id)s and role:projectadmin)"
The policy language also has the ``not`` operator, allowing a richer
policy rule::
"project_id:%(project_id)s and not role:dunce"
Operator precedence is below:
+------------+-------------+-------------+
| PRECEDENCE | TYPE | EXPRESSION |
+============+=============+=============+
| 4 | Grouping | (...) |
+------------+-------------+-------------+
| 3 | Logical NOT | not ... |
+------------+-------------+-------------+
| 2 | Logical AND | ... and ... |
+------------+-------------+-------------+
| 1 | Logical OR | ... or ... |
+------------+-------------+-------------+
Operator with larger precedence number precedes others with smaller numbers.
In the list-of-lists representation, each check inside the innermost
list is combined as with an "and" conjunction -- for that check to pass,
all the specified checks must pass. These innermost lists are then
combined as with an "or" conjunction. As an example, take the following
rule, expressed in the list-of-lists representation::
[["role:admin"], ["project_id:%(project_id)s", "role:projectadmin"]]
Finally, two special policy checks should be mentioned; the policy
check "@" will always accept an access, and the policy check "!" will
always reject an access. (Note that if a rule is either the empty
list (``[]``) or the empty string (``""``), this is equivalent to the "@"
policy check.) Of these, the "!" policy check is probably the most useful,
as it allows particular rules to be explicitly disabled.
Generic Checks
~~~~~~~~~~~~~~
A `generic` check is used to perform matching against attributes that are sent
along with the API calls. These attributes can be used by the policy engine
(on the right side of the expression), by using the following syntax::
<some_attribute>:%(user.id)s
The value on the right-hand side is either a string or resolves to a
string using regular Python string substitution. The available attributes
and values are dependent on the program that is using the common policy
engine.
All of these attributes (related to users, API calls, and context) can be
checked against each other or against constants. It is important to note
that these attributes are specific to the service that is conducting
policy enforcement.
Generic checks can be used to perform policy checks on the following user
attributes obtained through a token:
- user_id
- domain_id or project_id (depending on the token scope)
- list of roles held for the given token scope
.. note::
Some resources which are exposed by the API do not support policy
enforcement by user_id, and only support policy enforcement by project_id.
Some global resources do not support policy enforcement by combination of
user_id and project_id.
For example, a check on the user_id would be defined as::
user_id:<some_value>
Together with the previously shown example, a complete generic check
would be::
user_id:%(user.id)s
It is also possible to perform checks against other attributes that
represent the credentials. This is done by adding additional values to
the ``creds`` dict that is passed to the
:meth:`~oslo_policy.policy.Enforcer.enforce` method.
Special Checks
~~~~~~~~~~~~~~
Special checks allow for more flexibility than is possible using generic
checks. The built-in special check types are ``role``, ``rule``, and ``http``
checks.
Role Check
^^^^^^^^^^
A ``role`` check is used to check if a specific role is present in the supplied
credentials. A role check is expressed as::
"role:<role_name>"
Rule Check
^^^^^^^^^^
A :class:`rule check <oslo_policy.policy.RuleCheck>` is used to
reference another defined rule by its name. This allows for common
checks to be defined once as a reusable rule, which is then referenced
within other rules. It also allows one to define a set of checks as a
more descriptive name to aid in readability of policy. A rule check is
expressed as::
"rule:<rule_name>"
The following example shows a role check that is defined as a rule,
which is then used via a rule check::
"admin_required": "role:admin"
"<target>": "rule:admin_required"
HTTP Check
^^^^^^^^^^
An ``http`` check is used to make an HTTP request to a remote server to
determine the results of the check. The target and credentials are passed to
the remote server for evaluation. The action is authorized if the remote
server returns a response of ``True``. An http check is expressed as::
"http:<target URI>"
It is expected that the target URI contains a string formatting keyword,
where the keyword is a key from the target dictionary. An example of an
http check where the `name` key from the target is used to construct the
URL is would be defined as::
"http://server.test/%(name)s"
Registering New Special Checks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
It is also possible for additional special check types to be registered
using the :func:`~oslo_policy.policy.register` function.
The following classes can be used as parents for custom special check types:
* :class:`~oslo_policy.policy.AndCheck`
* :class:`~oslo_policy.policy.NotCheck`
* :class:`~oslo_policy.policy.OrCheck`
* :class:`~oslo_policy.policy.RuleCheck`
Default Rule
~~~~~~~~~~~~
A default rule can be defined, which will be enforced when a rule does
not exist for the target that is being checked. By default, the rule
associated with the rule name of ``default`` will be used as the default
rule. It is possible to use a different rule name as the default rule
by setting the ``policy_default_rule`` configuration setting to the
desired rule name.
"""
import collections.abc
import copy
import logging
import os
import typing as ty
import warnings
from oslo_config import cfg
from oslo_context import context
from oslo_serialization import jsonutils
from oslo_utils import strutils
import yaml
from oslo_policy import _cache_handler
from oslo_policy import _checks
from oslo_policy._i18n import _
from oslo_policy import _parser
from oslo_policy import opts
LOG = logging.getLogger(__name__)
register = _checks.register
"""Register a function or :class:`.Check` class as a policy check.
:param name: Gives the name of the check type, e.g., "rule",
"role", etc. If name is ``None``, a default check type
will be registered.
:param func: If given, provides the function or class to register.
If not given, returns a function taking one argument
to specify the function or class to register,
allowing use as a decorator.
"""
Check = _checks.Check
"""A base class to allow for user-defined policy checks.
:param kind: The kind of the check, i.e., the field before the ``:``.
:param match: The match of the check, i.e., the field after the ``:``.
"""
AndCheck = _checks.AndCheck
"""Implements the "and" logical operator.
A policy check that requires that a list of other checks all return True.
:param list rules: rules that will be tested.
"""
NotCheck = _checks.NotCheck
"""Implements the "not" logical operator.
A policy check that inverts the result of another policy check.
:param rule: The rule to negate.
"""
OrCheck = _checks.OrCheck
"""Implements the "or" operator.
A policy check that requires that at least one of a list of other
checks returns ``True``.
:param rules: A list of rules that will be tested.
"""
RuleCheck = _checks.RuleCheck
"""Recursively checks credentials based on the defined rules."""
WARN_JSON = ("JSON formatted policy_file support is deprecated since "
"Victoria release. You need to use YAML format which "
"will be default in future. You can use "
"``oslopolicy-convert-json-to-yaml`` tool to convert existing "
"JSON-formatted policy file to YAML-formatted in backward "
"compatible way: https://docs.openstack.org/oslo.policy/"
"latest/cli/oslopolicy-convert-json-to-yaml.html.")
class PolicyNotAuthorized(Exception):
"""Default exception raised for policy enforcement failure."""
def __init__(self, rule, target, creds):
msg = _("%(rule)s is disallowed by policy") % {'rule': rule}
super(PolicyNotAuthorized, self).__init__(msg)
class InvalidScope(Exception):
"""Raised when the scope of the request mismatches the policy scope."""
def __init__(self, rule, operation_scopes, token_scope):
msg = (
"%(rule)s requires a scope of %(operation_scopes)s, request "
"was made with %(token_scope)s scope." % {
'rule': rule,
'operation_scopes': operation_scopes,
'token_scope': token_scope
}
)
super(InvalidScope, self).__init__(msg)
class DuplicatePolicyError(Exception):
def __init__(self, name):
msg = _('Policy %(name)s is already registered') % {'name': name}
super(DuplicatePolicyError, self).__init__(msg)
class PolicyNotRegistered(Exception):
def __init__(self, name):
msg = _('Policy %(name)s has not been registered') % {'name': name}
super(PolicyNotRegistered, self).__init__(msg)
class InvalidDefinitionError(Exception):
def __init__(self, names):
msg = _('Policies %(names)s are not well defined. Check logs for '
'more details.') % {'names': names}
super(InvalidDefinitionError, self).__init__(msg)
class InvalidRuleDefault(Exception):
def __init__(self, error):
msg = (_('Invalid policy rule default: '
'%(error)s.') % {'error': error})
super(InvalidRuleDefault, self).__init__(msg)
class InvalidContextObject(Exception):
def __init__(self, error):
msg = (_('Invalid context object: '
'%(error)s.') % {'error': error})
super(InvalidContextObject, self).__init__(msg)
def pick_default_policy_file(conf, fallback_to_json_file=True):
# TODO(gmann): If service changed the default value of
# CONF.oslo_policy.policy_file option to 'policy.yaml' then to avoid
# breaking any deployment relying on default value, we need to add
# this is fallback logic to pick the old default policy file
# (policy.json) if exist. We can to remove this fallback logic once
# oslo_policy stop supporting the JSON formatted policy file.
new_default_policy_file = 'policy.yaml'
old_default_policy_file = 'policy.json'
if ((conf.oslo_policy.policy_file == new_default_policy_file) and
fallback_to_json_file):
location = conf.get_location('policy_file', 'oslo_policy').location
if conf.find_file(conf.oslo_policy.policy_file):
return conf.oslo_policy.policy_file
elif location in [cfg.Locations.opt_default,
cfg.Locations.set_default]:
if conf.find_file(old_default_policy_file):
return old_default_policy_file
# Return overridden policy file
return conf.oslo_policy.policy_file
def parse_file_contents(data):
"""Parse the raw contents of a policy file.
Parses the contents of a policy file which currently can be in either
yaml or json format. Both can be parsed as yaml.
:param data: A string containing the contents of a policy file.
:returns: A dict of the form ``{'policy_name1': 'policy1',
'policy_name2': 'policy2,...}``
"""
try:
# NOTE(snikitin): jsonutils.loads() is much faster than
# yaml.safe_load(). However jsonutils.loads() parses only JSON while
# yaml.safe_load() parses JSON and YAML. So here we try to parse data
# by jsonutils.loads() first. In case of failure yaml.safe_load()
# will be used instead.
parsed = jsonutils.loads(data)
# NOTE(gmann): If policy file is loaded in JSON format means
# policy_file is JSON formatted so log warning.
LOG.warning(WARN_JSON)
except ValueError:
try:
parsed = yaml.safe_load(data)
except yaml.YAMLError as e:
# For backwards-compatibility, convert yaml error to ValueError,
# which is what JSON loader raised.
raise ValueError(str(e))
return parsed or {}
class Rules(dict):
"""A store for rules. Handles the default_rule setting directly."""
@classmethod
def load(cls, data, default_rule=None):
"""Allow loading of YAML/JSON rule data.
.. versionadded:: 1.5.0
"""
parsed_file = parse_file_contents(data)
# Parse the rules
rules = {k: _parser.parse_rule(v) for k, v in parsed_file.items()}
return cls(rules, default_rule)
@classmethod
def load_json(cls, data, default_rule=None):
"""Allow loading of YAML/JSON rule data.
.. warning::
This method is deprecated as of the 1.5.0 release in favor of
:meth:`load` and may be removed in the 2.0 release.
"""
warnings.warn(
'The load_json() method is deprecated as of the 1.5.0 release in '
'favor of load() and may be removed in the 2.0 release.',
DeprecationWarning)
return cls.load(data, default_rule)
@classmethod
def from_dict(cls, rules_dict, default_rule=None):
"""Allow loading of rule data from a dictionary."""
# Parse the rules stored in the dictionary
rules = {k: _parser.parse_rule(v) for k, v in rules_dict.items()}
return cls(rules, default_rule)
def __init__(self, rules=None, default_rule=None):
"""Initialize the Rules store."""
super(Rules, self).__init__(rules or {})
self.default_rule = default_rule
def __missing__(self, key):
"""Implements the default rule handling."""
if isinstance(self.default_rule, dict):
raise KeyError(key)
# If the default rule isn't actually defined, do something
# reasonably intelligent
if not self.default_rule:
raise KeyError(key)
if isinstance(self.default_rule, _checks.BaseCheck):
return self.default_rule
# We need to check this or we can get infinite recursion
if self.default_rule not in self:
raise KeyError(key)
elif isinstance(self.default_rule, str):
return self[self.default_rule]
def __str__(self):
"""Dumps a string representation of the rules."""
# Start by building the canonical strings for the rules
out_rules = {}
for key, value in self.items():
# Use empty string for singleton TrueCheck instances
if isinstance(value, _checks.TrueCheck):
out_rules[key] = ''
else:
out_rules[key] = str(value)
# Dump a pretty-printed JSON representation
return jsonutils.dumps(out_rules, indent=4)
class Enforcer(object):
"""Responsible for loading and enforcing rules.
: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.
"""
def __init__(
self, conf, policy_file=None, rules=None,
default_rule=None, use_conf=True, overwrite=True,
fallback_to_json_file=True,
):
self.conf = conf
opts._register(conf)
self.default_rule = (default_rule or
self.conf.oslo_policy.policy_default_rule)
self.rules = Rules(rules, self.default_rule)
self.registered_rules = {}
self.file_rules = {}
self.policy_path = None
self.policy_file = policy_file or pick_default_policy_file(
self.conf, fallback_to_json_file=fallback_to_json_file)
self.use_conf = use_conf
self._need_check_rule = True
self.overwrite = overwrite
self._loaded_files = []
self._policy_dir_mtimes = {}
self._file_cache = {}
self._informed_no_policy_file = False
# NOTE(gmann): This flag will suppress the warning for
# policies changing their default check_str that have
# not been overridden by operators. This does not affect the
# warning for policy changed their name or deprecated
# for removal.
self.suppress_default_change_warnings = False
# FOR TESTING ONLY
self.suppress_deprecation_warnings = False
def set_rules(self, rules, overwrite=True, use_conf=False):
"""Create a new :class:`Rules` based on the provided dict of rules.
:param rules: New rules to use.
:param overwrite: Whether to overwrite current rules or update them
with the new rules.
:param use_conf: Whether to reload rules from cache or config file.
"""
if not isinstance(rules, dict):
raise TypeError(_('Rules must be an instance of dict or Rules, '
'got %s instead') % type(rules))
self.use_conf = use_conf
self._need_check_rule = True
if overwrite:
self.rules = Rules(rules, self.default_rule)
else:
self.rules.update(rules)
def clear(self):
"""Clears :class:`Enforcer` contents.
This will clear this instances rules, policy's cache, file cache
and policy's path.
"""
self.set_rules({})
self.default_rule = None
self.policy_path = None
self._loaded_files = []
self._policy_dir_mtimes = {}
self._file_cache.clear()
self.registered_rules = {}
self.file_rules = {}
self._informed_no_policy_file = False
self.suppress_default_change_warnings = False
self.suppress_deprecation_warnings = False
def load_rules(self, force_reload=False):
"""Loads policy_path's rules.
Policy file is cached and will be reloaded if modified.
:param force_reload: Whether to reload rules from config file.
"""
if force_reload:
self.use_conf = force_reload
policy_file_rules_changed = False
if self.use_conf:
if not self.policy_path:
try:
self.policy_path = self._get_policy_path(self.policy_file)
except cfg.ConfigFilesNotFoundError:
if not self._informed_no_policy_file:
LOG.debug('The policy file %s could not be found.',
self.policy_file)
self._informed_no_policy_file = True
if self.policy_path:
# If the policy file rules have changed any policy.d rules
# also need to be reapplied on top of that change.
policy_file_rules_changed = self._load_policy_file(
self.policy_path,
force_reload,
overwrite=self.overwrite
)
force_reload_policy_dir = force_reload
if policy_file_rules_changed:
force_reload_policy_dir = True
for path in self.conf.oslo_policy.policy_dirs:
try:
path = self._get_policy_path(path)
except cfg.ConfigFilesNotFoundError:
continue
if (self._is_directory_updated(self._policy_dir_mtimes, path)
or force_reload_policy_dir):
self._walk_through_policy_directory(
path,
self._load_policy_file,
force_reload_policy_dir, False
)
for default in self.registered_rules.values():
if default.deprecated_for_removal:
self._emit_deprecated_for_removal_warning(default)
if default.name in self.rules:
continue
check = default.check
if default.deprecated_rule:
check = self._handle_deprecated_rule(default)
self.rules[default.name] = check
# Detect and log obvious incorrect rule definitions
if self._need_check_rule:
self.check_rules()
self._need_check_rule = False
def check_rules(self, raise_on_violation=False):
"""Look for rule definitions that are obviously incorrect."""
undefined_checks = []
cyclic_checks = []
violation = False
for name, check in self.rules.items():
if self._undefined_check(check):
undefined_checks.append(name)
violation = True
if self._cycle_check(check):
cyclic_checks.append(name)
violation = True
if undefined_checks:
LOG.warning('Policies %(names)s reference a rule that is not '
'defined.', {'names': undefined_checks})
if cyclic_checks:
LOG.warning('Policies %(names)s are part of a cyclical '
'reference.', {'names': cyclic_checks})
if raise_on_violation and violation:
raise InvalidDefinitionError(undefined_checks + cyclic_checks)
return not violation
def _emit_deprecated_for_removal_warning(self, default):
# If the policy is being removed completely, we need to let operators
# know that the policy is going to be silently ignored in the future
# and they can remove it from their overrides since it isn't being
# replaced by another policy.
if not self.suppress_deprecation_warnings and \
default.name in self.file_rules:
warnings.warn(
'Policy "%(policy)s":"%(check_str)s" was deprecated for '
'removal in %(release)s. Reason: %(reason)s. Its value may be '
'silently ignored in the future.' % {
'policy': default.name,
'check_str': default.check_str,
'release': default.deprecated_since,
'reason': default.deprecated_reason
}
)
def _handle_deprecated_rule(self, default):
"""Handle cases where a policy rule has been deprecated.
:param default: an instance of RuleDefault that contains an instance of
DeprecatedRule
"""
deprecated_rule = default.deprecated_rule
deprecated_reason = (
deprecated_rule.deprecated_reason or default.deprecated_reason)
deprecated_since = (
deprecated_rule.deprecated_since or default.deprecated_since)
deprecated_msg = (
'Policy "%(old_name)s":"%(old_check_str)s" was deprecated in '
'%(release)s in favor of "%(name)s":"%(check_str)s". Reason: '
'%(reason)s. Either ensure your deployment is ready for the new '
'default or copy/paste the deprecated policy into your policy '
'file and maintain it manually.' % {
'old_name': deprecated_rule.name,
'old_check_str': deprecated_rule.check_str,
'release': deprecated_since,
'name': default.name,
'check_str': default.check_str,
'reason': deprecated_reason,
}
)
# Print a warning because the actual policy name is changing. If
# operators are relying on an override for foo:bar and it's getting
# renamed to foo:create_bar then they need to be able to see that
# before they roll out the next release. If the policy name is in
# self.file_rules, we know that it's being overridden.
if (
deprecated_rule.name != default.name and
deprecated_rule.name in self.file_rules
):
if not self.suppress_deprecation_warnings:
warnings.warn(deprecated_msg)
# If the deprecated policy is being overridden and doesn't match
# the default deprecated policy, override the new policy's default
# with the old check string. This should prevents unwanted exposure
# to APIs on upgrade.
# There's one exception to this: When we generate a sample policy,
# we set the deprecated rule name to reference the new rule. If we
# see that the deprecated override rule is just the new rule, then
# we shouldn't mess with it.
file_rule = self.file_rules[deprecated_rule.name]
if (
file_rule.check != deprecated_rule.check and
str(file_rule.check) != 'rule:%s' % default.name and
default.name not in self.file_rules.keys()
):
return self.file_rules[deprecated_rule.name].check
# In this case, the default check string is changing. We need to let
# operators know that this is going to change. If they don't want to
# override it, they are going to have to make sure the right
# infrastructure exists before they upgrade. This overrides the new
# check with an OrCheck that combines the new and old check_str
# attributes from the new and deprecated policies. This will make it so
# that deployments don't break on upgrade, but they receive log
# messages telling them stuff is going to change if they don't maintain
# the policy manually or add infrastructure to their deployment to
# support the new policy.
# If the enforce_new_defaults flag is True, do not add OrCheck to the
# old check_str and enforce only the new defaults.
if (
not self.conf.oslo_policy.enforce_new_defaults
and deprecated_rule.check_str != default.check_str
and default.name not in self.file_rules
):
if not (
self.suppress_deprecation_warnings
or self.suppress_default_change_warnings
):
warnings.warn(deprecated_msg)
return OrCheck([default.check, deprecated_rule.check])
return default.check
def _undefined_check(self, check):
"""Check if a RuleCheck references an undefined rule."""
if isinstance(check, RuleCheck):
if check.match not in self.rules:
# Undefined rule
return True
# An AndCheck or OrCheck is composed of multiple rules so check
# each of those.
rules = getattr(check, 'rules', None)
if rules:
for rule in rules:
if self._undefined_check(rule):
return True
return False
def _cycle_check(self, check, seen=None):
"""Check if RuleChecks cycle.
Looking for something like::
"foo": "rule:bar"
"bar": "rule:foo"
:param check: The check to search for.
:param seen: A set of previously seen rules, else None.
"""
if seen is None:
seen = set()
if isinstance(check, RuleCheck):
if check.match in seen:
# Cycle found
return True
seen.add(check.match)
if check.match in self.rules:
# There can only be a cycle if the referenced rule is defined.
if self._cycle_check(self.rules[check.match], seen):
return True
# An AndCheck or OrCheck is composed of multiple rules so check
# each of those.
rules = getattr(check, 'rules', None)
if rules:
for rule in rules:
# As there being an OrCheck or AndCheck, a copy of the father's
# seen should be called here. In order that the checks in
# different branchs are seperated.
if self._cycle_check(rule, seen.copy()):
return True
return False
@staticmethod
def _is_directory_updated(cache, path):
# Get the current modified time and compare it to what is in
# the cache and check if the new mtime is greater than what
# is in the cache
mtime = 0
if os.path.exists(path):
if not os.path.isdir(path):
raise ValueError('{} is not a directory'.format(path))
# Make a list of all the files
files = [path] + [os.path.join(path, file) for file in
os.listdir(path)]
# Pick the newest one, let's use its time.
mtime = os.path.getmtime(max(files, key=os.path.getmtime))
cache_info = cache.setdefault(path, {})
if mtime > cache_info.get('mtime', 0):
cache_info['mtime'] = mtime
return True
return False
@staticmethod
def _walk_through_policy_directory(path, func, *args):
if not os.path.isdir(path):
raise ValueError('%s is not a directory' % path)
# We do not iterate over sub-directories.
policy_files = next(os.walk(path))[2]
policy_files.sort()
for policy_file in [p for p in policy_files if not p.startswith('.')]:
func(os.path.join(path, policy_file), *args)
def _record_file_rules(self, data, overwrite=False):
"""Store a copy of rules loaded from a file.
It is useful to be able to distinguish between rules loaded from a file
and those registered by a consuming service. In order to do so we keep
a record of rules loaded from a file.
:param data: The raw contents of a policy file.
:param overwrite: If True clear out previously loaded rules.
"""
if overwrite:
self.file_rules = {}
parsed_file = parse_file_contents(data)
redundant_file_rules = []
for name, check_str in parsed_file.items():
file_rule = RuleDefault(name, check_str)
self.file_rules[name] = file_rule
reg_rule = self.registered_rules.get(name)
if (reg_rule and (file_rule == reg_rule)):
redundant_file_rules.append(name)
if redundant_file_rules:
# NOTE(gmann): Log warning for redundant file rules which
# can be detected via 'oslopolicy-list-redundant' tool too.
LOG.warning("Policy Rules %(names)s specified in policy files "
"are the same as the defaults provided by the "
"service. You can remove these rules from policy "
"files which will make maintenance easier. You can "
"detect these redundant rules by "
"``oslopolicy-list-redundant`` tool also.",
{'names': redundant_file_rules})
def _load_policy_file(self, path, force_reload, overwrite=True):
"""Load policy rules from the specified policy file.
:param path: A path of the policy file to load rules from.
:param force_reload: Forcefully reload the policy file content.
:param overwrite: Replace policy rules instead of updating them.
:return: A bool indicating whether rules have been changed or not.
"""
rules_changed = False
reloaded, data = _cache_handler.read_cached_file(
self._file_cache, path, force_reload=force_reload)
if reloaded or not self.rules:
rules = Rules.load(data, self.default_rule)
self.set_rules(rules, overwrite=overwrite, use_conf=True)
rules_changed = True
self._record_file_rules(data, overwrite)
self._loaded_files.append(path)
LOG.debug('Reloaded policy file: %(path)s', {'path': path})
return rules_changed
def _get_policy_path(self, path):
"""Locate the policy YAML/JSON data file/path.
:param path: It's value can be a full path or related path. When
full path specified, this function just returns the full path. When
related path specified, this function will search configuration
directories to find one that exists.
:returns: The policy path
:raises: ConfigFilesNotFoundError if the file/path couldn't be located.
"""
policy_path = self.conf.find_file(path)
if policy_path:
return policy_path
raise cfg.ConfigFilesNotFoundError((path,))
def enforce(
self, rule, target, creds, do_raise=False, exc=None, *args, **kwargs,
):
"""Checks authorization of a rule against the target and credentials.
:param rule: The rule to evaluate as a string or :class:`BaseCheck`.
:param target: As much information about the object being operated on
as possible. The target argument should be a dict instance or an
instance of a class that fully supports the Mapping abstract base
class.
:param creds: As much information about the user performing the action
as possible. This parameter can also be an instance of
``oslo_context.context.RequestContext``.
:param do_raise: Whether to raise an exception or not if check
fails.
:param exc: Class of the exception to raise if the check fails.
Any remaining arguments passed to :meth:`enforce` (both positional
and keyword arguments) will be passed to the exception class. If
not specified, :class:`PolicyNotAuthorized` will be used.
:return: ``False`` if the policy does not allow the action and ``exc``
is not provided; otherwise, returns a value that evaluates to
``True``. Note: for rules using the "case" expression, this
``True`` value will be the specified string from the expression.
"""
self.load_rules()
if isinstance(creds, context.RequestContext):
creds = self._map_context_attributes_into_creds(creds)
# NOTE(lbragstad): The oslo.context library exposes the ability to call
# a method on RequestContext objects that converts attributes of the
# context object to policy values. However, ``to_policy_values()``
# doesn't actually return a dictionary, it's a subclass of
# collections.abc.MutableMapping, which behaves like a dictionary but
# doesn't pass the type check.
elif not isinstance(creds, collections.abc.MutableMapping):
msg = (
'Expected type oslo_context.context.RequestContext, dict, or '
'the output of '
'oslo_context.context.RequestContext.to_policy_values but '
'got %(creds_type)s instead' % {'creds_type': type(creds)}
)
raise InvalidContextObject(msg)
if LOG.isEnabledFor(logging.DEBUG):
try:
creds_dict = strutils.mask_dict_password(creds)
creds_msg = jsonutils.dumps(creds_dict,
skipkeys=True, sort_keys=True)
except Exception as e:
creds_msg = ('cannot format data, exception: %(exp)s' %
{'exp': e})
try:
target_dict = strutils.mask_dict_password(target)
target_msg = jsonutils.dumps(target_dict,
skipkeys=True, sort_keys=True)
except Exception as e:
target_msg = ('cannot format data, exception: %(exp)s' %
{'exp': e})
LOG.debug('enforce: rule=%s creds=%s target=%s',
rule.__class__ if isinstance(rule, _checks.BaseCheck)
else '"%s"' % rule, creds_msg, target_msg)
# Allow the rule to be a Check tree
if isinstance(rule, _checks.BaseCheck):
# If the thing we're given is a Check, we don't know the
# name of the rule, so pass None for current_rule.
result = _checks._check(