google.cloud.forseti.scanner.audit.bigquery_rules_engine module

Rules engine for Big Query data sets.

class BigqueryRuleBook(rule_defs=None)[source]

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

The RuleBook for Big Query dataset resources.

_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

classmethod _get_binding_from_old_syntax(rule_def)[source]

Get a binding for configs set with the old syntax.

Default fields to glob as default as that is what the fields used to be set.

Parameters:rule_def (dict) – raw rule definition.
Returns:
If an old style config field is set, returns a single binding
with a single member.
Return type:Binding
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_policy_violations(resource, bq_acl)[source]

Find acl violations in the rule book.

Parameters:
  • resource (gcp_type) – The GCP resource associated with the acl. This is where we start looking for rule violations and we move up the resource hierarchy (if permitted by the resource’s “inherit_from_parents” property).
  • bq_acl (BigqueryAccessControls) – The acl to compare the rules against.
Returns:

A generator of the rule violations.

Return type:

iterable

class BigqueryRulesEngine(rules_file_path, snapshot_timestamp=None)[source]

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

Rules engine for Big Query data sets

add_rules(rules)[source]

Add rules to the rule book.

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

Build BigqueryRuleBook from the rules definition file.

Parameters:global_configs (dict) – Global configurations.
find_policy_violations(parent_project, bq_acl, force_rebuild=False)[source]

Determine whether Big Query datasets violate rules.

Parameters:
  • parent_project (Project) – parent project the acl belongs to.
  • bq_acl (BigqueryAccessControls) – Object containing ACL data.
  • 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 Binding(role, members)

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 = ('role', 'members')
classmethod _make(iterable, new=<built-in method __new__ of type object>, len=<built-in function len>)

Make a new Binding object from a sequence or iterable

_replace(**kwds)

Return a new Binding object replacing specified fields with new values

members
role
class Member(domain, group_email, user_email, special_group)

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 = ('domain', 'group_email', 'user_email', 'special_group')
classmethod _make(iterable, new=<built-in method __new__ of type object>, len=<built-in function len>)

Make a new Member object from a sequence or iterable

_replace(**kwds)

Return a new Member object replacing specified fields with new values

domain
group_email
special_group
user_email
class Mode[source]

Bases: enum.Enum

Rule modes.

BLACKLIST = 'blacklist'
WHITELIST = 'whitelist'
class Rule(rule_name, rule_index, rule_reference)[source]

Bases: object

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

class RuleViolation(domain, resource_name, resource_data, resource_id, special_group, group_email, rule_name, role, user_email, full_name, rule_index, violation_type, dataset_id, resource_type, view)

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 = ('domain', 'resource_name', 'resource_data', 'resource_id', 'special_group', 'group_email', 'rule_name', 'role', 'user_email', 'full_name', 'rule_index', 'violation_type', 'dataset_id', 'resource_type', 'view')
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

dataset_id
domain
full_name
group_email
resource_data
resource_id
resource_name
resource_type
role
rule_index
rule_name
special_group
user_email
view
violation_type
_is_binding_applicable(binding, bigquery_acl)[source]

Determine whether the binding is applicable to the acl.

Parameters:
Returns:

True if the rules are applicable to the given acl, False

otherwise.

Return type:

bool

find_policy_violations(bigquery_acl)[source]

Find BigQuery acl violations in the rule book.

Parameters:bigquery_acl (BigqueryAccessControls) – BigQuery ACL resource.
Yields:namedtuple – Returns RuleViolation named tuple.
frozen_rule_attributes = frozenset(['domain', 'resource_name', 'resource_data', 'resource_id', 'special_group', 'group_email', 'rule_name', 'role', 'user_email', 'full_name', 'rule_index', 'violation_type', 'dataset_id', 'resource_type', 'view'])
rule_violation_attributes = ['resource_type', 'resource_id', 'resource_name', 'full_name', 'rule_name', 'rule_index', 'violation_type', 'dataset_id', 'role', 'special_group', 'user_email', 'domain', 'group_email', 'view', 'resource_data']
class RuleReference(mode, dataset_ids, bindings)

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 = ('mode', 'dataset_ids', 'bindings')
classmethod _make(iterable, new=<built-in method __new__ of type object>, len=<built-in function len>)

Make a new RuleReference object from a sequence or iterable

_replace(**kwds)

Return a new RuleReference object replacing specified fields with new values

bindings
dataset_ids
mode