Rules engine for external project access.
ExternalProjectAccessRuleBook(rule_defs=None)[source]¶Bases: google.cloud.forseti.scanner.audit.base_rules_engine.BaseRuleBook
The RuleBook for ExternalProjectAccess 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: |
|
|---|
add_rules(rule_defs)[source]¶Add rules to the rule book.
| Parameters: | rule_defs (dict) – rule definitions dictionary |
|---|
ancestor_pattern = re.compile('^organizations/\\d+$|^folders/\\d+$')¶email_pattern = re.compile('(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$)')¶find_violations(user_email, project_ancestry)[source]¶Determine whether project ancestry violates rules.
| Parameters: |
|
|---|---|
| Returns: | A list of rule violations. |
| Return type: | list |
process_rule(rule_def, rule_index)[source]¶Process a rule.
| Parameters: |
|
|---|---|
| Returns: |
|
| Return type: | processed_rule |
validate_ancestor(ancestor, rule_index)[source]¶Validate the ancestor in a rule.
| Parameters: |
|
|---|
validate_ancestors(ancestors, rule_index)[source]¶Validate a list of ancestors in a rule.
| Parameters: |
|
|---|
ExternalProjectAccessRulesEngine(rules_file_path, snapshot_timestamp=None)[source]¶Bases: google.cloud.forseti.scanner.audit.base_rules_engine.BaseRulesEngine
Rules engine for External Project Access.
build_rule_book(global_configs=None)[source]¶Build ExternalProjectAccess rule book from the rules definition file.
| Parameters: | global_configs (dict) – Inventory configurations. |
|---|
find_violations(user_email, project_ancestry, force_rebuild=False)[source]¶Determine whether project ancestry violates rules.
| Parameters: |
|
|---|---|
| Returns: | A generator of rule violations. |
| Return type: | generator |
Rule(rule_name, rule_index, rules)[source]¶Bases: object
Rule properties from the rule definition file.
Also finds violations.
RuleViolation(resource_type, resource_id, rule_name, rule_index, rule_data, full_name, violation_type, member, resource_data)¶Bases: tuple
__getnewargs__()¶Return self as a plain tuple. Used by copy and pickle.
__new__(_cls, resource_type, resource_id, rule_name, rule_index, rule_data, full_name, violation_type, member, resource_data)¶Create new instance of RuleViolation(resource_type, resource_id, rule_name, rule_index, rule_data, full_name, violation_type, member, resource_data)
__repr__()¶Return a nicely formatted representation string
_asdict()¶Return a new OrderedDict which maps field names to their values.
_fields = ('resource_type', 'resource_id', 'rule_name', 'rule_index', 'rule_data', 'full_name', 'violation_type', 'member', 'resource_data')¶_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_type, resource_id, rule_name, rule_index, rule_data, full_name, violation_type, member, resource_data)'\n\n __slots__ = ()\n\n _fields = ('resource_type', 'resource_id', 'rule_name', 'rule_index', 'rule_data', 'full_name', 'violation_type', 'member', 'resource_data')\n\n def __new__(_cls, resource_type, resource_id, rule_name, rule_index, rule_data, full_name, violation_type, member, resource_data):\n 'Create new instance of RuleViolation(resource_type, resource_id, rule_name, rule_index, rule_data, full_name, violation_type, member, resource_data)'\n return _tuple.__new__(_cls, (resource_type, resource_id, rule_name, rule_index, rule_data, full_name, violation_type, member, resource_data))\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_type', 'resource_id', 'rule_name', 'rule_index', 'rule_data', 'full_name', 'violation_type', 'member', 'resource_data'), _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_type=%r, resource_id=%r, rule_name=%r, rule_index=%r, rule_data=%r, full_name=%r, violation_type=%r, member=%r, resource_data=%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_type = _property(_itemgetter(0), doc='Alias for field number 0')\n\n resource_id = _property(_itemgetter(1), doc='Alias for field number 1')\n\n rule_name = _property(_itemgetter(2), doc='Alias for field number 2')\n\n rule_index = _property(_itemgetter(3), doc='Alias for field number 3')\n\n rule_data = _property(_itemgetter(4), doc='Alias for field number 4')\n\n full_name = _property(_itemgetter(5), doc='Alias for field number 5')\n\n violation_type = _property(_itemgetter(6), doc='Alias for field number 6')\n\n member = _property(_itemgetter(7), doc='Alias for field number 7')\n\n resource_data = _property(_itemgetter(8), doc='Alias for field number 8')\n\n"¶full_name¶member¶resource_data¶resource_id¶resource_type¶rule_data¶rule_index¶rule_name¶violation_type¶find_violation(user_email, ancestry)[source]¶Find external project access policy acl violations in the rule book.
| Parameters: |
|
|---|---|
| Returns: |
|
| Return type: | namedtuple |