Source code for

# 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
# 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.
"""Slack webhook notifier to perform notifications."""

from builtins import str
import requests

from import logger
from import base_notification

LOGGER = logger.get_logger(__name__)

TEMP_DIR = '/tmp'

[docs]class SlackWebhook(base_notification.BaseNotification): """Slack webhook notifier to perform notifications"""
[docs] def _dump_slack_output(self, data, indent=0): """Iterate over a dictionary and output a custom formatted string Args: data (dict): a dictionary of violation data indent (int): number of spaces for indentation Returns: output: a string formatted violation """ output = '' if not isinstance(data, dict): LOGGER.debug('Violation data is not a dictionary type. ' f'Violation data: {data}') return '\t' * (indent + 1) + '`' + str(data) + '`\n' for key, value in sorted(data.items()): output += '\t' * indent + '*' + str(key) + '*:' if isinstance(value, dict): output += '\n' + self._dump_slack_output(value, indent + 1) + '\n' else: if not value: value = 'n/a' output += '\t' * (indent + 1) + '`' + str(value) + '`\n' return output
[docs] def _compose(self, violation): """Composes the slack webhook content Args: violation (object): Violation to transform to ascii output. Returns: webhook_payload: a string formatted violation """ return ('*type*:\t`{}`\n*details*:\n'.format(self.resource) + self._dump_slack_output(violation.get('violation_data'), 1))
[docs] def _send(self, payload): """Sends a post to a Slack webhook url Args: payload (str): Payload data to send to slack. """ url = self.notification_config.get('webhook_url') request =, json={'text': payload})
[docs] def run(self): """Run the slack webhook notifier""" if not self.notification_config.get('webhook_url'): LOGGER.warning('No url found, not running Slack notifier.') return for violation in self.violations: webhook_payload = self._compose(violation=violation) self._send(payload=webhook_payload)