Contrast CLIのインストール

Contrast CLIをインストールするには:

  1. Node.jsをインストールします。Contrast CLIはNode.jsパッケージとして実行されるため、これは必須です。現在、バージョン 10、12、14に対応しています。

  2. 検査対象のアプリケーションにContrastエージェントを組み込んで起動します。これによって、Contrast CLIで参照するためのアプリケーションIDを取得できます。

    注記

    まだエージェントが組み込まれていないアプリケーションも、Contrast CLIで登録することができます。ただし、アプリケーションのライブラリスコアを評価して、ライブラリ一覧を作成するには、エージェントを組み込んでアプリケーションを起動する必要があります。

  3. プロキシ経由でContrastと通信を行うには、エージェントの設定でcli_proxyプロパティを使用してください。

    認証が必要な場合は、ユーザ名とパスワード、プロトコル、ホスト、ポートを以下の例のように指定します。例:

    http://username:password@<host>:<port>
  4. Contrast CLIで解析を行うには、対象アプリケーションのソースコードがローカルで利用できる必要があります。アプリケーション言語に応じて、以下の要件に従ってください。

    • Java:

      • Maven:Mavenプロジェクトはpom.xmlファイルで定義し、Apache Maven Dependencyプラグインが必要です。 CLIがプロジェクトで動作するかをテストするには、mvn dependency:treeを実行して依存関係ツリーを表示します。

      • Gradle(バージョン4.8以上) :CLIがプロジェクトで動作するかをテストするには、Gradleのdependencies タスクを実行して、依存関係ツリーを表示します。gradle dependenciesを実行してください。もしくは、Gradle Wrapperを使用している場合、./gradlew dependenciesを実行してください。

    • Node.jspackage-lock.jsonまたは.yarn.lockファイルのいずれかが必要です。

      (脆弱性の報告はReactやAngularなどのフロントエンド技術に対してサポートされます。)

    • Pythonpipfileファイルおよびpipfile.lockファイルが必要です。

    • Rubygemfileファイルおよびgemfile.lockファイルが必要です。

    • Gogo.modファイルが必要です。

    注記

    現時点では、アプリケーションは単一の言語でのみサポートされます。

  5. 以下のコマンドを実行して、Contrast CLIをインストールします。

    npm install -g @contrast/contrast-cli

    または、以下のコマンドでyarnを使用してContrast CLIをインストールすることもできます。

    yarn global add @contrast/contrast-cli

    注記

    Contrast CLIのインストールは、グローバルインストールで行う必要があります。

  6. Contrast CLIのインストールが完了したら、アプリケーションを登録して、コードの解析を始めることができます。