Skip to main content

Contrast Scanローカルエンジンのダウンロード

Contrastでは、Contrast Scanローカルエンジンアプリケーションの最新バージョンをダウンロードできる再利用可能なスクリプトを提供しています。ダウンロードされるアプリケーションは、JavaのJARファイルです。

開始する前に

  • 本項で提供するスクリプトは、ターミナルウィンドウでbash スクリプトとして実行するように設計されています。

  • このスクリプトでは、以下の環境変数を使用します。

    • CONTRAST__API__ORGANIZATION

    • CONTRAST__API__URL

    • CONTRAST__API__USER_NAME

    • CONTRAST__API__API_KEY

    • CONTRAST__API__SERVICE_KEY

    これらのキーは、Contrast Webインターフェイスでユーザ名 > ユーザの設定 > プロファイルを選択すると「あなたのキー」の下に表示されています。

手順

  1. 以下のコードを含むdownload-release.shという名前のスクリプトを作成します。

    #!/bin/bash
    
    RELEASE=latest
    
    if [ -n "$1" ]
    then
      RELEASE=$1
    fi
    
    OUTPUT_FILE=sast-local-scanner-$RELEASE.zip
    AUTH_TOKEN=$(echo -n $CONTRAST__API__USER_NAME:$CONTRAST__API__SERVICE_KEY | base64)
    
    curl \
      -H "api-key: $CONTRAST__API__API_KEY" \
      -H "authorization: $AUTH_TOKEN" \
      -L \
      -o $OUTPUT_FILE \
      $CONTRAST__API__URL/organizations/$CONTRAST__API__ORGANIZATION/release-artifacts/local-scanner/$RELEASE?download=true
    
  2. ターミナルウィンドウで、以下のようにコマンドを使用して環境変数を設定します。

    export CONTRAST__API__ORGANIZATION=<Contrast_organization_ID>
    export CONTRAST__API__URL=https://<your_teamserver_environment>/Contrast/api/sast                  
    export CONTRAST__API__USER_NAME=<Contrast_user_name>
    export CONTRAST__API__API_KEY=<Contrast_API_key>
    export CONTRAST__API__SERVICE_KEY=<Contrast_service_key>
    
    • <Contrast_organization_ID>は、組織IDに置き換えます。

    • <your_teamserver_environment>は、スキャン結果を報告するContrastサーバのアドレスに置き換えます。例:https://teamserver-mycompany/Contrast/api/sast

    • <Contrast_user_name>は、Contrastアカウント(通常、自分のログインID)に置き換えます。

    • <Contrast_API_key>は、ContrastでのあなたのAPIキーに置き換えます。

    • <Contrast_service_key>は、Contrastのサービスキーに置き換えます。

  3. bashを使ってスクリプトを実行します(例、bash download-release.sh)

    以下のような出力結果が表示されます。

    LocalScanEngineScript.png

    スクリプトによって、最新バージョンのContrast Scanローカルエンジンが含まれたsast-local-scanner-latest.zipがダウンロードされます。ZIPファイルのサイズは、約145MBです。

    LocalScanFiles.png
  4. Contrast Scanローカルエンジンを適当な場所に解凍してください。

  5. カスタムスクリプトをお使いの場合は、カスタムスクリプトをContrast Scanローカルエンジンの正しいバージョンに更新してください。

関連項目

ローカルスキャンの実行