# 通知を設定する

Shisho Cloud では、**リアルタイム通知** と **プロジェクトレポート通知** という二つの通知機能が利用できます。

- **リアルタイム通知**: 検出事項の発見・トリアージなど、状態が変化したタイミングで通知されます。
- **プロジェクトレポート通知**: [プロジェクト](https://cloud.shisho.dev/*/projects)単位で、定期的に現在のセキュリティ状況をまとめて通知します。

本ページでは、それぞれの通知の設定方法を説明します。

## 通知機能の比較

以下の表は、それぞれの通知機能の特徴をまとめたものです。用途に応じて使い分けてください。

| 機能               | リアルタイム通知                                  | プロジェクトレポート通知             |
| :----------------- | :------------------------------------------------ | :----------------------------------- |
| **主な用途**       | 検出事項の発見・トリアージ時の通知                | 定期的なセキュリティ状況の把握・報告 |
| **通知トリガー**   | 検出事項の発見・トリアージ時                      | 定期的                               |
| **通知内容**       | 個別の検出事項                                    | プロジェクト全体のサマリーと内訳     |
| **設定方法**       | [ワークフロー](/docs/ja/g/concepts/workflow.md)による制御 | プロジェクト設定画面による設定       |
| **カスタマイズ性** | 高い（ワークフローで柔軟に制御可能）              | 中程度（設定項目で制御可能）         |

**使い分けの例**:

- **リアルタイム通知**: Critical / High の検出事項が見つかった際に Slack で通知する、またはチケット管理システムに起票する。
- **プロジェクトレポート通知**: 毎日、プロジェクト全体のセキュリティ状況をメールで受信し、定例会で確認する。

## リアルタイム通知を設定する

リアルタイム通知は、検出事項の発見やトリアージなど、状態が変化したタイミングで通知される機能です。

Shisho Cloud では、通知のタイミングや内容を [ワークフロー](/docs/ja/g/concepts/workflow.md) として柔軟に制御できます。複雑な設定をせずとも利用できるよう、標準で **通知ワークフロー** が用意されており、検出事項の **深刻度 (Severity)** に応じて通知されます。

**Slack 通知の例**

![](/docs/ja/_md-assets/149b4d470c-notification-default-slack.png)

**メール通知の例**

![](/docs/ja/_md-assets/d22fc520f6-notification-default-email.png)

### 通知ワークフロー

通知ワークフローには、組織全体のリソースを対象にした通知と、特定のプロジェクト内のリソースを対象にした通知の2種類があります。どちらも、問題の発見やトリアージ時に通知されます。

<Tabs groupId="notification-workflows" queryString>
  <TabItem value="notification_workflow" label="通知ワークフロー" default>

[通知ワークフロー](https://cloud.shisho.dev/*/workflows/edit?wfid=notification-security)は標準で含まれているワークフローの一つで、組織内の全リソースを対象とした問題の発見・トリアージ時に下記の方法で通知します。

- Slack チャンネルへ通知
- 指定のメールアドレスへ送信
- 通知グループに紐付けられた送信先へ通知

:::warning
一部のお客様において、**Slack 通知**のみに対応したワークフローが配布されているケースがございます。その場合はお手数ですが、標準の[通知ワークフロー](https://cloud.shisho.dev/*/workflows/edit?wfid=notification-security)ページを開き、下記の新しいワークフローをコピー＆ペーストし置換して下さい。また、置換した場合、送信先の指定が改めて必要となります。標準の[通知ワークフロー](https://cloud.shisho.dev/*/workflows/edit?wfid=notification-security)ページの[パラメーター設定](/docs/ja/g/getting-started/setup-notification.md#edit-notification-parameter)にてご指定いただくようお願いします。
:::

<CodeBlock language="yaml">{ManifestNotificationSecurity}</CodeBlock>

  </TabItem>
  <TabItem value="notification_workflow_per_project" label="プロジェクトごとの通知ワークフロー">

**プロジェクトごとの通知ワークフロー**はプロジェクトのスコープ（リソース）を対象とした問題の発見・トリアージ時に各種通知先へ通知します。このワークフローは標準では含まれていないため、必要に応じて下記のYAMLをコピーし新規作成してください。

<CodeBlock language="yaml">{ManifestNotificationProjectSecurity}</CodeBlock>

  </TabItem>
</Tabs>

では、順に設定方法を見ていきましょう。

### 通知ワークフローの設定

ここでは通知ワークフローの設定を変更し、問題の発見・トリアージ時の通知を設定してみましょう。

#### 通知ワークフローの設定ページにアクセスする

[通知ワークフローの編集画面](https://cloud.shisho.dev/*/workflows/edit?wfid=notification-security)にアクセスすると、以下のような画面が開くはずです。

![](/docs/ja/_md-assets/a931eef048-notification-workflow.png)

#### パラメータを編集する {#edit-notification-parameter}

画面右上を確認すると、各種通知先の設定項目と、どの緊急度（severity）の検出事項からを通知するかの 2 つの設定項目が確認できます。それぞれの項目を設定し、**保存** を押下してください。

![](/docs/ja/_md-assets/bdd2a6e877-notification-workflow-2.png)

:::warning
通知を設定するには、事前に各種**通知ターゲット**の設定が必要となります。詳細は [こちら](/docs/ja/g/concepts/notification.md) を参照してください。
:::

#### Slack 通知をテストする

Slack チャンネルへの通知を利用する場合、**テスト通知を送信** ボタンを押下することで、実際にテスト通知を送信できます。もし以下のようなメッセージが確認できれば、通知設定は完了です。

![](/docs/ja/_md-assets/e658d23787-notification-default-test.png)

### プロジェクトごとの通知ワークフローの設定

一律、同じ通知先に送信したいケースもあれば、プロジェクトごとに異なる通知先に送信したいケースもあるでしょう。上記の[プロジェクトごとの通知ワークフロー](/docs/ja/g/getting-started/setup-notification.md?notification-workflows=notification_workflow_per_project)を利用してください。

#### 対象のプロジェクトの設定ページにアクセスする

最初に[プロジェクトの一覧画面](https://cloud.shisho.dev/*/projects)から通知先を設定したいプロジェクトを選択し、設定ページにアクセスしてください。

![](/docs/ja/_md-assets/36cd02e46c-notification-default-project-channels-1.png)

#### 通知先を設定する

設定ページにて、ご希望の通知先を選択し追加・更新してください。

![](/docs/ja/_md-assets/5fc29b3038-notification-project-channels.png)

なお、現在プロジェクトの通知先として追加できるのは下記となります。また、それぞれ事前に設定が必要となりますので、ご希望の通知先が選択肢として表示されない場合はご確認ください。

- Slack チャンネル：[通知ターゲット](/docs/ja/g/concepts/notification.md)の「 Slack 通知の設定をする」をご覧ください。
- 通知グループ：[通知グループの設定](/docs/ja/g/concepts/notification-group.md)をご覧ください。
- Email：[通知ターゲット](/docs/ja/g/concepts/notification.md)の「 Email 通知の設定をする」をご覧ください。

#### プロジェクトごとの通知ワークフローの設定ページにアクセスする

すでにプロジェクトの設定ページにて**通知先の設定**を終えたので、改めてパラメータを通じ設定する必要はありません。なお、緊急度（severity）の検出事項を変更したい場合は、**プロジェクトごとの通知ワークフロー**の編集ページにアクセスし、パラメータを編集してください。

![](/docs/ja/_md-assets/01190ec8ff-notification-default-project-channels-3.png)

## プロジェクトレポート通知を設定する

プロジェクトレポート通知は、プロジェクト内のセキュリティ状況を定期的に送信する機能です。[プロジェクト一覧](https://cloud.shisho.dev/*/projects)から対象のプロジェクトを選択し、設定ページを開いてください。

**Slack による通知の例**

![](/docs/ja/_md-assets/3d55eabde9-notification-project-report-slack.png)

**メールによる通知の例**

![](/docs/ja/_md-assets/e964f06489-notification-project-report-email.png)

### 通知先を設定

通知はプロジェクトごとのデフォルト通知先に送信されます。まだ、未登録の場合は通知先を登録してください。

![](/docs/ja/_md-assets/5fc29b3038-notification-project-channels.png)

:::warning
通知先が一つも設定されていない場合、本機能を有効化していても送信されません。少なくとも、一つの通知先を登録してください。
:::

### プロジェクトレポート通知の有効化・設定

通知設定で、受信したい通知のトグルをオンにしてください。現在は、**リソース種別**ごとに検出事項を集計した「リソース種別ごとのセキュリティ状況レポート」を提供しています。

**リソース種別ごとのセキュリティ状況レポートの設定**

下記の項目を設定可能です。必要に応じて変更し、保存ボタンを押下してください。

![](/docs/ja/_md-assets/64aeb84bea-notification-project-report-configs.png)

:::info
現在は**日次レポート**のみサポートしています。今後、週次、月次レポートも対応予定です。
:::

:::info
レポートには対応状況が **レビュー待ち** または **要対応** の検出事項のみ含まれます。
:::

:::warning
メールによる通知において、HTMLメールが一定サイズを超える場合、自動的にプレーンテキスト形式で送信されます。あらかじめ、ご了承ください。
:::