From 16a8c6a683632e2db926ffe81950a4fdbe94364e Mon Sep 17 00:00:00 2001 From: mutao Date: Wed, 20 Dec 2023 17:55:09 +0900 Subject: [PATCH] =?UTF-8?q?README=E3=81=A8CODEOWNERS=E3=81=AE=E8=BF=BD?= =?UTF-8?q?=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CODEOWNERS.md | 1 + README.md | 17 ++++++++++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 CODEOWNERS.md diff --git a/CODEOWNERS.md b/CODEOWNERS.md new file mode 100644 index 0000000..fb78838 --- /dev/null +++ b/CODEOWNERS.md @@ -0,0 +1 @@ +* @globis-org/gdp-gsirt diff --git a/README.md b/README.md index 87c8415..9333136 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ -# secrets-scan \ No newline at end of file +# org-secrets-scan +`aquasecurity/trivy`を使用して秘匿情報を検出し。Pull Request にコメントを追加します。 + +この workflow は [Required workflows](https://docs.github.com/ja/actions/using-workflows/required-workflows) の機能を用いて GLOBIS Organization 配下の全てのリポジトリで動作されることを前提としています。 + +![image](https://github.com/globis-org/org-secrets-scan/assets/35423021/e5127c69-a45b-4024-99fd-4a646a67a8d1) + + +## カスタマイズ +必要に応じて、各リポジトリのルートディレクトリに `trivy-secret.yaml` を配置することで検知ルールの追加や検知対象から外すことができます。 + +詳細は [公式ドキュメント](https://aquasecurity.github.io/trivy/v0.48/docs/scanner/secret/#configuration) を参考にしてください + +`trivy-secret.yaml` が意図したように動くかはローカル環境で動作確認することが可能です。 + +trivy のインストール方法については [こちら](https://aquasecurity.github.io/trivy/v0.48/getting-started/installation/) を参考にしてください。