🔹 DefectDojo Community版 on DefectDojo Documentation

インストール

Mon, 01 Jan 0001 00:00:00 +0000

推奨オプション

Docker Compose

手順はDOCKER.mdをご覧ください

SaaS(サポートを含み、プロジェクトを支援)

SaaSリンク

Dockerイメージのバリエーション

DefectDojoは、複数のバリエーションでDockerイメージを公開しています。

	AMD64	ARM64
Debian	✅ サポート対象	⚠️ ユニットテスト済み
Alpine	⚠️ コミュニティ	⚠️ コミュニティ

AMD64上のDebianは、公式にサポートおよびテストされている構成です。すべてのCIテスト(ユニット、統合、パフォーマンス)がこの組み合わせに対して実行されます。

システムアーキテクチャ

Mon, 01 Jan 0001 00:00:00 +0000

NGINX

WebサーバーであるNGINXは、画像、JavaScriptファイル、CSSファイルなど、すべての静的コンテンツを配信します。

uWSGI

uWSGIは、Python/Djangoで書かれたDefectDojoプラットフォームを実行し、すべての動的コンテンツを提供するアプリケーションサーバーです。

メッセージブローカー

アプリケーションサーバーは、非同期実行のためにタスクをメッセージブローカーに送信します。現在、docker compose構成ではブローカーとしてValkeyのみがサポートされています。 Helmチャートは引き続きブローカーとしてRedisを使用していますが、間もなくValkeyに移行される予定です。

Celery Worker

重複排除やJIRA同期などのタスクは、Celery Workerによってバックグラウンドで非同期に実行されます。

Celery Beat

今後予定されているエンゲージメントなどについてユーザーに識別・通知するために、DefectDojoはスケジュールされたタスクを実行します。これらのタスクは、Celery Beatを使用してスケジュール・実行されます。

Initializer

Initializerは、データベースをセットアップ・維持し、バージョンアップグレード後にマイグレーションを同期・実行します。すべてのタスクが完了すると、自動的にシャットダウンします。

設定

Mon, 01 Jan 0001 00:00:00 +0000

dojo/settings/settings.dist.py

主要な設定はdojo/settings/settings.dist.pyに保存されています。このファイルは、何を設定できるかを確認するための参考として使用するには最適ですが、DefectDojoの更新時に変更が上書きされてしまうため、直接編集すべきではありません。デフォルト設定を変更する方法はいくつかあります。

環境変数

ほとんどのパラメータは環境変数で設定できます。

Docker Composeを使ってDefectDojoをデプロイする場合、docker-compose.ymlで環境変数を設定できます。uwsgi、celerybeat、celeryworkerという3つのサービスすべてに対して変数を設定する必要がある点に注意してください。

KubernetesクラスターにDefectDojoをデプロイする場合、helm/defectdojo/values.yaml内のextraConfigsおよびextraSecretsとして環境変数を設定できます。

環境ファイル(Docker ComposeまたはKubernetesを使用しない場合)

settings.dist.pyは、環境変数DD_ENV_PATHで指定された名前のファイルから環境変数を読み込みます。この変数が設定されていない場合、デフォルトの.env.prodが使用されます。このファイルはdojo/settingsディレクトリに配置する必要があります。

例はtemplate_envにあります。

local_settings.py

local_settings.pyには、MIDDLEWAREやINSTALLED_APPのエントリの追加など、より複雑なカスタマイズを含めることができます。このファイルはsettings.dist.pyが処理された後に処理されるため、DefectDojoが標準で提供する設定を変更できます。このファイルはdojo/settingsディレクトリに配置する必要があります。このファイル内の環境変数にはDD_プレフィックスを付けてはいけません。ファイルが存在しない場合は、自由に作成してください。settings.dist.pyを直接編集しないでください。

例はdojo/settings/template-local_settingsにあります。

Docker Composeのリリースモードでは、docker/extra_settings/(docker-compose.ymlファイルからの相対パス)内のファイルが、起動時にdockerコンテナ内のdojo/settings/にコピーされます。

local_settings.pyはKubernetesでも使用できます。変数localsettingspyはConfigMapとして保存され、コンテナの該当する場所にマウントされます。

本番環境での実行

Mon, 01 Jan 0001 00:00:00 +0000

本番環境での使用(Docker Composeを使用)

このリポジトリのdocker-compose.ymlファイルは、ローカル環境でDefectDojoを評価するために完全に機能します。

Docker Composeは、コンテナ化されたDefectDojoを本番環境にデプロイするためのサポートされたインストール方法の1つですが、docker-compose.ymlファイルは、お使いの状況に合わせて事前にカスタマイズすることなく本番環境で使用することは想定されていません。

Docker ComposeでDefectDojoを実行する方法の詳細については、Docker Composeでの実行を参照してください。

システム要件

事前設定されたPostgreSQLデータベースではなく、専用のデータベースサーバーを使用することをお勧めします。これにより、DefectDojoのパフォーマンスが大幅に向上します。

インスタンスサイズ

データベースを分離した場合、DefectDojoを実行するための最小推奨要件は次のとおりです。

2 vCPU
8GBのRAM
10GBのディスク容量(データベースはここには含まれないため、OS用に用意した容量で足りるはずです)。パフォーマンス向上のため、 OS用とは別のディスクを割り当てることもできます。

セキュリティ

コンプライアンス要件を満たすために、nginxの設定やセキュリティヘッダーなどの実行時の側面を確認してください。 docker-compose.yml内のAES256暗号化キー&91a*agLqesc*0DJ+2*bAbsUZfR*4nLwを、お使いのインスタンス固有のものに変更してください。この暗号化キーは、SonarQubeなど外部ツールに接続するためにDefect Dojoに保存されるAPIキーやその他の認証情報を暗号化するために使用されます。キーは、パスワードマネージャーやopensslを使用するなど、さまざまな方法で生成できます。