Rules engine for Roles.
RoleRuleBook(rule_defs=None)[source]¶Bases: google.cloud.forseti.scanner.audit.base_rules_engine.BaseRuleBook
The RuleBook for Role resources.
_abc_cache = <_weakrefset.WeakSet object>¶_abc_negative_cache = <_weakrefset.WeakSet object>¶_abc_negative_cache_version = 214¶_abc_registry = <_weakrefset.WeakSet object>¶add_rule(rule_def, rule_index)[source]¶Add a rule to the rule book.
| Parameters: |
|
|---|
RoleRulesEngine(rules_file_path, snapshot_timestamp=None)[source]¶Bases: google.cloud.forseti.scanner.audit.base_rules_engine.BaseRulesEngine
Rules engine for roles.
build_rule_book(global_configs=None)[source]¶Build RoleRuleBook from the rules definition file.
| Parameters: | global_configs (dict) – Global configurations. |
|---|
find_violations(role, force_rebuild=False)[source]¶Determine whether the role violates rules.
| Parameters: |
|
|---|---|
| Returns: | A generator of rule violations. |
| Return type: | generator |
Rule(rule_index, rule_name, permissions, res)[source]¶Bases: object
Rule properties from the rule definition file. Also finds violations.
find_violations(res)[source]¶Get a generator for violations.
| Parameters: | res (Resource) – A class derived from Resource. |
|---|---|
| Returns: | All violations of the resource breaking the rule. |
| Return type: | Generator |
| Raises: | ValueError – Raised if the resource type is bucket. |
find_violations_by_ancestor(ancestor, role)[source]¶Get a generator on a given ancestor of the role.
| Parameters: |
|
|---|---|
| Yields: | RuleViolation – All violations of the role breaking the rule. |
generate_violation(role)[source]¶Generate a violation.
| Parameters: | role (Role) – The role that triggers the violation. |
|---|---|
| Returns: | The violation. |
| Return type: | RuleViolation |
RuleViolation(resource_name, resource_type, full_name, rule_name, rule_index, violation_type, violation_data, resource_data, resource_id)¶Bases: tuple
__getnewargs__()¶Return self as a plain tuple. Used by copy and pickle.
__new__(_cls, resource_name, resource_type, full_name, rule_name, rule_index, violation_type, violation_data, resource_data, resource_id)¶Create new instance of RuleViolation(resource_name, resource_type, full_name, rule_name, rule_index, violation_type, violation_data, resource_data, resource_id)
__repr__()¶Return a nicely formatted representation string
_asdict()¶Return a new OrderedDict which maps field names to their values.
_fields = ('resource_name', 'resource_type', 'full_name', 'rule_name', 'rule_index', 'violation_type', 'violation_data', 'resource_data', 'resource_id')¶_make(iterable, new=<built-in method __new__ of type object>, len=<built-in function len>)¶Make a new RuleViolation object from a sequence or iterable
_replace(**kwds)¶Return a new RuleViolation object replacing specified fields with new values
_source = "from builtins import property as _property, tuple as _tuple\nfrom operator import itemgetter as _itemgetter\nfrom collections import OrderedDict\n\nclass RuleViolation(tuple):\n 'RuleViolation(resource_name, resource_type, full_name, rule_name, rule_index, violation_type, violation_data, resource_data, resource_id)'\n\n __slots__ = ()\n\n _fields = ('resource_name', 'resource_type', 'full_name', 'rule_name', 'rule_index', 'violation_type', 'violation_data', 'resource_data', 'resource_id')\n\n def __new__(_cls, resource_name, resource_type, full_name, rule_name, rule_index, violation_type, violation_data, resource_data, resource_id):\n 'Create new instance of RuleViolation(resource_name, resource_type, full_name, rule_name, rule_index, violation_type, violation_data, resource_data, resource_id)'\n return _tuple.__new__(_cls, (resource_name, resource_type, full_name, rule_name, rule_index, violation_type, violation_data, resource_data, resource_id))\n\n @classmethod\n def _make(cls, iterable, new=tuple.__new__, len=len):\n 'Make a new RuleViolation object from a sequence or iterable'\n result = new(cls, iterable)\n if len(result) != 9:\n raise TypeError('Expected 9 arguments, got %d' % len(result))\n return result\n\n def _replace(_self, **kwds):\n 'Return a new RuleViolation object replacing specified fields with new values'\n result = _self._make(map(kwds.pop, ('resource_name', 'resource_type', 'full_name', 'rule_name', 'rule_index', 'violation_type', 'violation_data', 'resource_data', 'resource_id'), _self))\n if kwds:\n raise ValueError('Got unexpected field names: %r' % list(kwds))\n return result\n\n def __repr__(self):\n 'Return a nicely formatted representation string'\n return self.__class__.__name__ + '(resource_name=%r, resource_type=%r, full_name=%r, rule_name=%r, rule_index=%r, violation_type=%r, violation_data=%r, resource_data=%r, resource_id=%r)' % self\n\n def _asdict(self):\n 'Return a new OrderedDict which maps field names to their values.'\n return OrderedDict(zip(self._fields, self))\n\n def __getnewargs__(self):\n 'Return self as a plain tuple. Used by copy and pickle.'\n return tuple(self)\n\n resource_name = _property(_itemgetter(0), doc='Alias for field number 0')\n\n resource_type = _property(_itemgetter(1), doc='Alias for field number 1')\n\n full_name = _property(_itemgetter(2), doc='Alias for field number 2')\n\n rule_name = _property(_itemgetter(3), doc='Alias for field number 3')\n\n rule_index = _property(_itemgetter(4), doc='Alias for field number 4')\n\n violation_type = _property(_itemgetter(5), doc='Alias for field number 5')\n\n violation_data = _property(_itemgetter(6), doc='Alias for field number 6')\n\n resource_data = _property(_itemgetter(7), doc='Alias for field number 7')\n\n resource_id = _property(_itemgetter(8), doc='Alias for field number 8')\n\n"¶full_name¶resource_data¶resource_id¶resource_name¶resource_type¶rule_index¶rule_name¶violation_data¶violation_type¶