Source code for google.cloud.forseti.scanner.scanners.blacklist_scanner

# Copyright 2017 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
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Blacklist scanner."""

from google.cloud.forseti.common.gcp_type.instance import Instance
from google.cloud.forseti.common.util import logger
from google.cloud.forseti.scanner.audit import blacklist_rules_engine
from google.cloud.forseti.scanner.scanners import base_scanner


LOGGER = logger.get_logger(__name__)


[docs]class BlacklistScanner(base_scanner.BaseScanner): """Blacklist scanner.""" 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(BlacklistScanner, self).__init__( global_configs, scanner_configs, service_config, model_name, snapshot_timestamp, rules) self.rules_engine = ( blacklist_rules_engine .BlacklistRulesEngine( 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: violation_data = {'project': violation.project, 'full_name': violation.full_name, 'network': violation.network, 'ip': violation.ip} yield { 'resource_id': 'instance_network_interface', 'full_name': violation.full_name, 'resource_name': violation.resource_name, 'resource_type': violation.resource_type, 'rule_index': violation.rule_index, 'rule_name': violation.rule_name, 'violation_type': violation.violation_type, 'violation_data': 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)
# pylint: disable=invalid-name
[docs] def get_instance_networks_interfaces(self): """Get network info from a particular snapshot. Returns: list: A list that contains nested lists of per-instance InstanceNetworksInterface objects. """ model_manager = self.service_config.model_manager scoped_session, data_access = model_manager.get(self.model_name) with scoped_session as session: network_interfaces = [] for instance_from_data_model in data_access.scanner_iter( session, 'instance'): instance = Instance.from_json( instance_from_data_model.full_name, instance_from_data_model.data, instance_from_data_model.parent.name) network_interfaces.append(instance.create_network_interfaces()) if not network_interfaces: LOGGER.warn('No VM network interfaces found. Exiting.') return None, 0 return network_interfaces
[docs] def _retrieve(self): """Run the data collection. Return: list: A list that contains nested lists of per-instance InstanceNetworksInterface objects. """ return self.get_instance_networks_interfaces()
[docs] def _find_violations(self, instances_networks_data): """Find violations in the policies. Args: instances_networks_data (list): instance networks data to find violations in Returns: list: A list of violations """ all_violations = [] LOGGER.info('Finding blacklisted ip addresses...') for instance_network_interface in instances_networks_data: LOGGER.debug('%s', instance_network_interface) violations = self.rules_engine.find_violations( instance_network_interface) LOGGER.debug(violations) all_violations.extend(violations) return all_violations
[docs] def run(self): """Runs scanning.""" instances_network_interface_data = self._retrieve() all_violations = ( self._find_violations(instances_network_interface_data)) self._output_results(all_violations)