yamory の使い方

yamory へようこそ! yamory の基礎知識と使い方をご紹介します。

PHP のプロジェクトをスキャンする

yamory では、Composer によって管理されている PHP プロジェクトの脆弱性をスキャンできます。
PHP プロジェクトのスキャンでは、composer.jsoncomposer.lock ファイルを使用して脆弱性を可視化します。(テストスコープのライブラリはスキャン対象外です)

スキャンは、GitHub リポジトリスキャンまたはコマンドラインスキャンで行えます。用途に応じてお選びください。

GitHub リポジトリから Composer プロジェクトをスキャンする

GitHub リポジトリスキャン の手順に沿って、「スキャン候補リポジトリ選択画面」にて、Composer プロジェクトが含まれているリポジトリを選択してください。

コマンドラインから Composer プロジェクトをスキャンする

Composer プロジェクトをスキャンする場合、コマンドライン上で、該当プロジェクトのルートに移動し、下記を実行してください。

PROJECT_GROUP_KEY=<yamory 上のプロジェクトグループ識別キー> YAMORY_API_KEY=xxxxxxxxxxxxxxxxx bash -c "$(curl -sSf -L https://yamory/script/...)"

コマンドラインで実行する際、以下の箇所を設定してください。

<yamory 上のプロジェクトグループ識別キー>:サービス名称などを設定してください。(例: yamory )(半角英数記号のみ、半角スペースは入力不可)