Node.jsエージェントでAssess CLIを使用する
ContrastのNode.jsエージェントを使用しており、APIまたはエンドツーエンドのテストを実行中にCLIを使用して脆弱性を検出したい場合は、この手順を使用してください。
開始する前に
Node.jsエージェントのサポート対象テクノロジを確認して、お使いのアプリケーションでAssess CLIを利用できるか確認してください。
Contrast Assessは、サーバサイドのアプリケーションのみを対象としています。クライアントサイドのコードの脆弱性は検出されません。
Node.jsエージェントは、JavaScriptアプリケーションのみに組み込み可能です。サーバサイドのコードにTypeScriptを使用している場合は、JavaScriptにトランスパイルしてください。
手順
以下のコマンドを使用して、アプリケーションのルートディレクトリから最新バージョンのエージェントをインストールします。
npm install @contrast/agent
yarnを使用する場合は、以下のコマンドを使用してください。
yarn add @contrast/agent
重要
エージェントの設定ファイル(YAML)は作成しないでください。設定ファイルは、Assess CLIによって自動的に作成されます。
ターミナルウィンドウを開き、Assess CLIコマンドを入力します。
contrast assess
このコマンドによって、Assess CLIとContrastエージェントの両方で共有するエージェント設定ファイルが作成されます。Contrast CLIコマンドにて、設定ファイルのパスを含め、このコマンドの各オプションについて説明しています。
以下のような出力が表示されます。
✔Configuration file found at "user_path" ("user_path"で設定ファイルが見つかりました)⠼ Waiting for the session to be created. (セッションが作成されるのを待っています。)IDEまたは2つ目のターミナルウィンドウで、以下のようなコマンドを使用してアプリケーションを実行します。
node -r @contrast/agent <server.js>
<server.js>をNode.jsアプリケーションのサーバ起動コマンドに置き換えます。アプリケーションの仕様に合わせて、コマンドを調整してください。このコマンドでNode.jsのContrastエージェントが必須になり、 Node.jsエンジンによって読み取られるアプリケーションのソースコードにContrastエージェントが組み込まれます。
アプリケーションを対話的に実行するか、APIやエンドツーエンドのテストを使用して、アプリケーションを疎通します。
Assess CLIコマンドを入力したターミナルウィンドウに検出結果が表示されます。