通知ターゲット
Shisho Cloud 上でポリシー違反が検出された際には、Shisho Cloud 上のダッシュボード 上での閲覧はもちろんのこと、外部サービスへの 通知も可能です。
Shisho Cloud から各種サービスへの通知
前提として、すべての通知はワークフローにより制御されています。
具体的に通知を制御するのは、ワークフローのジョブが含む notify
ブロックです。
例えば以下のマニフェストで定義されるワークフローは、ID が NGFOO
である通知グループに対して通知を送出します:
jobs:
- name: check-with-foobar
id: check-with-foobar
decide:
# ...
notify:
rego: |
import data.shisho
notifications[n] {
n := shisho.notification.to_group(
"NGFOO",
"test"
)
}
通知ターゲット
ここで、Shisho Cloud から通知を送ることができる対象は、通知ターゲット(Notification Target) と呼ばれています。
現在サポートされている通知ターゲット
現在、Shisho Cloud では、以下を通知ターゲットとして指定できます:
- Slack チャンネル
- GitHub Issue / GitHub Pull Request のコメント
- メールアドレス
通知ターゲットを指定する際に、個別で設定が必要になる場合があります。詳しくは次のセクションをご確認ください。
通知ターゲットの追加設定を行う
通知ターゲットの種類によっては、実際に通知を受け取るために、追加で設 定が必要になる場合があります。
Slack 通知の設定をする
Slack チャンネルで通知を受け取るには、Slack ワークスペースの連携手順 に加えて、以下の操作が必要です:
- Slack ワークスペース側にて、Shisho Cloud の Slack App を通知を受け取りたい Slack チャンネルに追加する
この設定は Slack 側 にて行う必要があります。
まずは Slack での通知を希望するチャンネルを右クリックし、"View Channel Details" を選択してください。
すると下記の画面へ遷移します。 そこで、Integrations タブを選択し "Add an App" をクリックしてください。
すると Slack App 一覧が表示されます。 "Add" をクリックしShisho Cloud なる Slack App を Slack チャンネルに招待してください。
Shisho Cloud という名称の Slack App が表示されない場合、該当の Slack ワークスペースと Shisho Cloud との連携が完了していない可能性があります。 Slack ワークスペースの連携手順 に設定してください。
Shisho Cloud と Slack ワークスペースの連携時に、Slack 側該当のメニューが見つからない場合は、Slack 側の UI 変更の可能性や、Slack ワークスペースのオーナー(管理者)が当該メニューへのアクセスを制限している可能性などが考えられます。 このような問題 で、Shisho Cloud と Slack ワークスペースが連携できない場合は、サービス運営元(Flatt Security)にお問い合わせください。
Slack チャンネルへテストメッセージを送信する
実際にワークフローで通知機能を利用する前に、必要な設定が完了しているか確認したい場合は、下記のテストメッセージの送信(Send test message)機能を利用して該当の Slack チャンネルにメッセージを送信してみてください:
設定が正常に完了している場合、下記のようなテストメッセージが確認できるはずです:
もし確認できない場合は、Slack ワークスペースの連携手順 と、Slack App の通知先 Slack チャンネルへの招待が完了していない可能性があります。 両方とも完了しているのに、それでもテストメッセージが受信できない場合は、サービス運営元(Flatt Security)にお問い合わせください。