SAMMY オープンソース v2

このリポジトリは、SAMMY（OWASP SAMM ツール）のオープンソース版をホストしています。

https://owasp.org/www-project-open-sammy/

ライセンス

このプロジェクトは、クリエイティブ・コモンズ表示-継承 4.0 国際ライセンスの下でライセンスされています。詳細は LICENSE ファイルを参照してください。

SAMMY v2

セットアップには、データベースにあらかじめ定義されたユーザーが含まれています:
- ユーザー名: [email protected]
- パスワード: admin
- MFA キー: AB4FHDUHYVGW7IAB (このキーを認証アプリに手動で追加してください)

Docker なしで実行する方法

必要条件

MySQL または MariaDB
Redis (APP_ENV=prod で実行する場合のみ)
php8.2+
composer

オプション

Symfony CLI (https://symfony.com/download)

実行方法

ローカル設定を記述した .env.local ファイルを作成します。MariaDB の例:
- 他のデータベースの場合は、適切な接続文字列はこちらで確認できます - https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url

DATABASE_URL=mysql://root:[email protected]:3306/sammy?serverVersion=11.3.2-MariaDB
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
APP_ENV=dev
APP_DEBUG=1

インストールと実行

composer install
./scripts/setup_database.sh
# if you have symfony cli
symfony server:start --allow-http
# else
php -S 0.0.0.0:8000 -t ./public
open http://127.0.0.1:8000

Docker で実行する方法

# 1. start DB and Redis
docker compose up -d db redis
# 2. now we can start our application
docker compose up -d --build app
# 3. sync SAMM model. Note, this step syncs the SAMM model from the core GitHub repo. You only have to run this the very first time and upon every SAMM model update.
docker compose exec app ./scripts/sync_samm.sh
# 4. sync DSOMM model. Note, this step syncs the DSOMM model from the core GitHub repo. You only have to run this the very first time and upon every DSOMM model update.
docker compose exec app ./scripts/sync_dsomm.sh
# 5. Enjoy
open http://127.0.0.1:8000

メーリング

メーリング機能を使用する場合は、以下を .env.local または compose.yaml ファイルに追加する必要があります。すべてのフィールドは必須です。また、サーバーはデフォルトで適切な SSL を使用する必要があります。

.env.lcoal の場合

  PHPMAILER_SMTP_HOST=
  PHPMAILER_SMTP_PORT=
  PHPMAILER_SMTP_USERNAME=
  PHPMAILER_SMTP_PASSWORD=
  PHPMAILER_SMTP_DEFAULT_SENDER=
  PHPMAILER_SMTP_USE_AUTH=
  PHPMAILER_SMTP_DEFAULT_ENCRYPTION=
  PHPMAILER_SMTP_AUTO_TLS=

compose.yaml の app セクション内の environment の場合

- PHPMAILER_SMTP_HOST=
- PHPMAILER_SMTP_PORT=
- PHPMAILER_SMTP_USERNAME=
- PHPMAILER_SMTP_PASSWORD=
- PHPMAILER_SMTP_DEFAULT_SENDER=
- PHPMAILER_SMTP_USE_AUTH=
- PHPMAILER_SMTP_DEFAULT_ENCRYPTION=

Docker を使用している場合は、他に何もする必要はありません。2 分ごとに実行される cron ジョブがあります。
ローカルで実行している場合は、以下のコマンドを手動で実行する必要があります:

php ./bin/console app:process-mailing

DSOMM サポート

DSOMM モデルのアセスメントをサポートしています。デフォルトでは、必要なものを備えた DSOMM モデルがデータベースに含まれています。必要に応じて、カスタム DSOMM バリエーションをインポートできます。例えば、ドメインやプラクティスが多い/少ないモデルを持つことができます。複数の DSOMM バリエーションを同時に持つこともできます。

php ./bin/console app:sync-from-dsomm --source="path/to/dsomm-file.yaml"

既存の DSOMM バリエーションを更新したい場合は、オプションでメタモデル ID を渡すことができます。

php ./bin/console app:sync-from-dsomm --source="path/to/dsomm-file.yaml" --metamodel=33

以下のようなデータ構造を持つ単一の YAML ファイルを想定しています。デフォルトでは、このファイルを使用します https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel-data/blob/main/src/assets/YAML/generated/generated.yaml

open-sammy

人気