Source code for

# Copyright 2019 The Forseti Security Authors. All rights reserved.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.

"""Scanner for the role rules engine."""

from import logger
from import role_rules_engine as rre
from import base_scanner
from import resource_util

LOGGER = logger.get_logger(__name__)

[docs]class RoleScanner(base_scanner.BaseScanner): """Scanner for role.""" def __init__(self, global_configs, scanner_configs, service_config, model_name, snapshot_timestamp, rules): """Initialization. Args: global_configs (dict): Global configurations. scanner_configs (dict): Scanner configurations. service_config (ServiceConfig): Forseti 2.0 service configs. model_name (str): name of the data model. snapshot_timestamp (str): Timestamp, formatted as YYYYMMDDTHHMMSSZ. rules (str): Fully-qualified path and filename of the rules file. """ super(RoleScanner, self).__init__( global_configs, scanner_configs, service_config, model_name, snapshot_timestamp, rules) self.rules_engine = rre.RoleRulesEngine( rules_file_path=self.rules, snapshot_timestamp=self.snapshot_timestamp) self.rules_engine.build_rule_book(self.global_configs)
[docs] @staticmethod def _flatten_violations(violations): """Flatten RuleViolations into a dict for each RuleViolation member. Args: violations (list): The RuleViolations to flatten. Yields: dict: Iterator of RuleViolations as a dict per member. """ for violation in violations: yield { 'resource_name': violation.resource_name, 'resource_id': violation.resource_id, 'resource_type': violation.resource_type, 'full_name': violation.full_name, 'rule_index': violation.rule_index, 'rule_name': violation.rule_name, 'violation_type': violation.violation_type, 'violation_data': violation.violation_data, 'resource_data': violation.resource_data }
[docs] def _output_results(self, all_violations): """Output results. Args: all_violations (list): All violations. """ all_violations = self._flatten_violations(all_violations) self._output_results_to_db(all_violations)
[docs] def _find_violations(self, resources): """Find violations in the resources with role policies. Args: resources (list): List of custom roles. Returns: list: All violations. """'Finding role violations...') all_violations = [] for resource in resources: violations = self.rules_engine.find_violations(resource) LOGGER.debug(violations) all_violations.extend(violations) return all_violations
[docs] def _retrieve(self): """Retrieves the data for scanner. Returns: list: a list of custom Roles, no curated roles. """ model_manager = self.service_config.model_manager scoped_session, data_access = model_manager.get(self.model_name) role_res = [] with scoped_session as session: for resource in data_access.scanner_iter( session, 'role'): parent = resource_util.create_resource(, resource_type=resource.parent.type ) parent.full_name = resource.parent.full_name new_res = resource_util.create_resource_from_json( 'role', parent, role_res.append(new_res) return role_res
[docs] def run(self): """Run, the entry point for this scanner.""" role_info = self._retrieve() all_violations = self._find_violations(role_info) self._output_results(all_violations)