google.cloud.forseti.scanner.audit.location_rules_engine module

Rules engine for resource locations.

class LocationData(resource, locations)

Bases: tuple

__getnewargs__()

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

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

_asdict()

Return a new OrderedDict which maps field names to their values

_fields = ('resource', 'locations')
classmethod _make(iterable, new=<built-in method __new__ of type object>, len=<built-in function len>)

Make a new LocationData object from a sequence or iterable

_replace(**kwds)

Return a new LocationData object replacing specified fields with new values

locations
resource
class LocationRuleBook(rule_defs=None)[source]

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

The RuleBook for resource locations.

_abc_cache = <_weakrefset.WeakSet object>
_abc_negative_cache = <_weakrefset.WeakSet object>
_abc_negative_cache_version = 186
_abc_registry = <_weakrefset.WeakSet object>
classmethod _build_rule(rule_def, rule_index)[source]

Build a rule.

Parameters:
  • rule_def (dict) – A dictionary containing rule definition properties.
  • rule_index (int) – The index of the rule from the rule definitions. Assigned automatically when the rule book is built.
Returns:

rule for the given definition.

Return type:

Rule

add_rule(rule_def, rule_index)[source]

Add a rule to the rule book.

Parameters:
  • rule_def (dict) – A dictionary containing rule definition properties.
  • rule_index (int) – The 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 (dict) – rule definitions dictionary.
find_violations(resource)[source]

Find resource locations violations in the rule book.

Parameters:resource (Resource) – The GCP resource to check locations for. This is where we start looking for rule violations and we move up the resource hierarchy.
Yields:RuleViolation – resource locations rule violations.
class LocationRulesEngine(rules_file_path, snapshot_timestamp=None)[source]

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

Rules engine for resource locations.

add_rules(rule_defs)[source]

Add rules to the rule book.

Parameters:rule_defs (dict) – rule definitions dictionary
build_rule_book(global_configs=None)[source]

Build LocationRuleBook from the rules definition file.

Parameters:global_configs (dict) – Global configurations.
find_violations(resource, force_rebuild=False)[source]

Determine whether resources violate rules.

Parameters:
  • resource (Resource) – resource to check locations for.
  • force_rebuild (bool) – If True, rebuilds the rule book. This will reload the rules definition file and add the rules to the book.
Returns:

A generator of rule violations.

Return type:

generator

class Mode[source]

Bases: enum.Enum

Rule modes.

BLACKLIST = 'blacklist'
WHITELIST = 'whitelist'
class Rule(name, index, mode, applies_to, location_patterns)[source]

Bases: object

Rule properties from the rule definition file. Also finds violations.

find_violations(resource)[source]

Find violations for this rule against the given resource.

Parameters:resource (Resource) – The resource to check for violations.
Yields:RuleViolation – location rule violation.
class RuleViolation(resource_id, resource_name, resource_type, full_name, rule_index, rule_name, violation_type, violation_data, resource_data)

Bases: tuple

__getnewargs__()

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

__getstate__()

Exclude the OrderedDict from pickling

__repr__()

Return a nicely formatted representation string

_asdict()

Return a new OrderedDict which maps field names to their values

_fields = ('resource_id', 'resource_name', 'resource_type', 'full_name', 'rule_index', 'rule_name', 'violation_type', 'violation_data', '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

full_name
resource_data
resource_id
resource_name
resource_type
rule_index
rule_name
violation_data
violation_type