google.cloud.forseti.scanner.audit.iap_rules_engine module

Rules engine for IAP policies on backend services.

class IapRuleBook(global_configs, rule_defs=None, snapshot_timestamp=None)[source]

Bases: google.cloud.forseti.scanner.audit.base_rules_engine.BaseRuleBook

The RuleBook for enforcing IAP policy on backend service 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:
  • rule_def (dict) – rule definition properties
  • rule_index (int) – index of the rule from the rule definitions, assigned automatically when the rule book is built
add_rules(rule_defs)[source]

Add rules to the rule book.

Parameters:rule_defs (list) – rule definition property dicts
find_violations(iap_resource)[source]

Find violations in the rule book.

Parameters:iap_resource (IapResource) – IAP data
Returns:RuleViolation
Return type:list
get_resource_rules(resource)[source]

Get all the resource rules for (resource, RuleAppliesTo.*).

Parameters:resource (Resource) – The gcp_type Resource find in the map.
Returns:ResourceRules
Return type:list
class IapRulesEngine(rules_file_path, snapshot_timestamp=None)[source]

Bases: google.cloud.forseti.scanner.audit.base_rules_engine.BaseRulesEngine

Rules engine for applying IAP policies to backend services

add_rules(rules)[source]

Add rules to the rule book.

Parameters:rules (list) – dicts defining the rules to add
build_rule_book(global_configs)[source]

Build IapRuleBook from the rules definition file.

Parameters:global_configs (dict) – Global configurations.
find_violations(iap_resource)[source]

Determine whether IAP-related settings violate rules.

Parameters:iap_resource (IapResource) – IAP resource data
Returns:RuleViolation
Return type:list
class ResourceRules(resource=None, rules=None, applies_to='self', inherit_from_parents=False)[source]

Bases: object

An association of a resource to rules.

__eq__(other)[source]

Compare == with another object.

Parameters:other (ResourceRules) – object to compare with
Returns:comparison result
Return type:int
__ne__(other)[source]

Compare != with another object.

Parameters:other (object) – object to compare with
Returns:comparison result
Return type:int
__repr__()[source]

String representation of this node.

Returns:debug string
Return type:str
find_mismatches(resource, iap_resource)[source]

Determine if the policy binding matches this rule’s criteria.

Parameters:
Returns:

RuleViolation

Return type:

list

class Rule(rule_name, rule_index, allowed_alternate_services, allowed_direct_access_sources, allowed_iap_enabled)[source]

Bases: object

Rule properties from the rule definition file.

Also finds violations.

__eq__(other)[source]

Test whether Rule equals other Rule.

Parameters:other (Rule) – object to compare to
Returns:comparison result
Return type:int
__hash__()[source]

Make a hash of the rule index.

For now, this will suffice since the rule index is assigned automatically when the rules map is built, and the scanner only handles one rule file at a time. Later on, we’ll need to revisit this hash method when we process multiple rule files.

Returns:The hash of the rule index.
Return type:int
__ne__(other)[source]

Test whether Rule is not equal to another Rule.

Parameters:other (object) – object to compare to
Returns:comparison result
Return type:int
__repr__()[source]

String representation of this node.

Returns:debug string
Return type:str
find_mismatches(resource, iap_resource)[source]

Find IAP policy violations in the rule book.

Parameters:
Returns:

IAP violations

Return type:

RuleViolation

class RuleViolation(resource_type, resource_id, full_name, resource_name, rule_name, rule_index, violation_type, alternate_services_violations, iap_enabled_violation, direct_access_sources_violations, resource_data)

Bases: tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

static __new__(_cls, resource_type, resource_id, full_name, resource_name, rule_name, rule_index, violation_type, alternate_services_violations, iap_enabled_violation, direct_access_sources_violations, resource_data)

Create new instance of RuleViolation(resource_type, resource_id, full_name, resource_name, rule_name, rule_index, violation_type, alternate_services_violations, iap_enabled_violation, direct_access_sources_violations, 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', 'full_name', 'resource_name', 'rule_name', 'rule_index', 'violation_type', 'alternate_services_violations', 'iap_enabled_violation', 'direct_access_sources_violations', 'resource_data')
classmethod _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, full_name, resource_name, rule_name, rule_index, violation_type, alternate_services_violations, iap_enabled_violation, direct_access_sources_violations, resource_data)'\n\n __slots__ = ()\n\n _fields = ('resource_type', 'resource_id', 'full_name', 'resource_name', 'rule_name', 'rule_index', 'violation_type', 'alternate_services_violations', 'iap_enabled_violation', 'direct_access_sources_violations', 'resource_data')\n\n def __new__(_cls, resource_type, resource_id, full_name, resource_name, rule_name, rule_index, violation_type, alternate_services_violations, iap_enabled_violation, direct_access_sources_violations, resource_data):\n 'Create new instance of RuleViolation(resource_type, resource_id, full_name, resource_name, rule_name, rule_index, violation_type, alternate_services_violations, iap_enabled_violation, direct_access_sources_violations, resource_data)'\n return _tuple.__new__(_cls, (resource_type, resource_id, full_name, resource_name, rule_name, rule_index, violation_type, alternate_services_violations, iap_enabled_violation, direct_access_sources_violations, 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) != 11:\n raise TypeError('Expected 11 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', 'full_name', 'resource_name', 'rule_name', 'rule_index', 'violation_type', 'alternate_services_violations', 'iap_enabled_violation', 'direct_access_sources_violations', '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, full_name=%r, resource_name=%r, rule_name=%r, rule_index=%r, violation_type=%r, alternate_services_violations=%r, iap_enabled_violation=%r, direct_access_sources_violations=%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 full_name = _property(_itemgetter(2), doc='Alias for field number 2')\n\n resource_name = _property(_itemgetter(3), doc='Alias for field number 3')\n\n rule_name = _property(_itemgetter(4), doc='Alias for field number 4')\n\n rule_index = _property(_itemgetter(5), doc='Alias for field number 5')\n\n violation_type = _property(_itemgetter(6), doc='Alias for field number 6')\n\n alternate_services_violations = _property(_itemgetter(7), doc='Alias for field number 7')\n\n iap_enabled_violation = _property(_itemgetter(8), doc='Alias for field number 8')\n\n direct_access_sources_violations = _property(_itemgetter(9), doc='Alias for field number 9')\n\n resource_data = _property(_itemgetter(10), doc='Alias for field number 10')\n\n"
alternate_services_violations
direct_access_sources_violations
full_name
iap_enabled_violation
resource_data
resource_id
resource_name
resource_type
rule_index
rule_name
violation_type