Gradle プロジェクト用の IRX ファイルの生成

ファイルの分析を開始するには、クラウドに送信する IRX ファイルを生成する必要があります。HCL AppScan on Cloud Gradle プラグインは、Gradle で Java と Java Web プロジェクトのスキャンを自動化するために使用されます。このプラグインは、「java」プラグインまたは「war」プラグインが適用されている Gradle プロジェクト用の IRX ファイルを生成します。また、生成された IRX ファイルを分析のために ASoC サービスに自動的に送信することもできます。プラグインの適用と最新のプラグイン・バージョンの確認についての詳細は、Gradle プラグインを参照してください。

手順

IRX ファイルを生成する方法:
  1. コマンド・プロンプトで、コマンドを実行して、Gradle プロジェクトが含まれる位置にディレクトリーを変更します。
  2. 以下のいずれかのコマンドを実行します。
    • IRX ファイルのみを生成するには、appscan-prepare を実行します。

      このコマンドは、ビルド内のすべての Java および War プロジェクト用として IRX ファイルを 1 つ生成します。この IRX ファイルは、デフォルトではルート・プロジェクトのビルド・ディレクトリーに生成されます。この IRX ファイルは、後で ASoC に送信できます。

    • IRX ファイルを生成し、分析のために ASoC サービスに送信するには、appscan-analyze を実行します。

      このコマンドは、IRX ファイルを生成し、分析のために ASoC サービスに送信します。このタスクは、API 鍵、秘密、およびアプリケーション ID が必要です。

    構成可能なオプション

    コマンド行で構文 -Doption=value を使用して JVM パラメーターを指定するか、またはビルド・スクリプトの「appscansettings」ブロックを使用し、以下のオプションを設定できます。

    表 1. 構成可能な Gradle プラグイン・オプション
    オプション デフォルト値 説明
    irxName ルート・プロジェクトの名前。 生成する .irx ファイルの名前。
    irxDir ルート・プロジェクトのビルド・ディレクトリー。 生成する .irx ファイルの位置。
    appID Null。appscan-analyze に必要 ASoC サービスにおけるアプリケーションの ID。
    appscanKey Null。appscan-analyze に必要 ユーザーの認証用の API 鍵。
    appscan秘密鍵 Null。appscan-analyze に必要 ユーザーの認証用の API 鍵の秘密。
    例 1: コマンド行でのオプションの指定:
    gradle appscan-prepare -DirxName=MyApp
    例 2: ビルド・スクリプトでのオプションの指定:
    appscansettings {
    	irxName="MyApp"
    	irxDir="/myApplication/sample"
    }
    
    注: appscanKey オプションと appscanSecret オプションは、ユーザーの gradle.properties ファイルで指定できます。このファイルで指定する場合、ビルド・スクリプトまたはコマンド行で認証情報を指定する必要はありません。例えば、次の行を ~/.gradle/gradle.properties に追加します (このファイルが存在しない場合は作成します)。
    appscanKey="2358cd02-3fs3-322c-62c9-b5cc63c61f2a"
    appscanSecret="qU939siTXgF7csk3jSig+Vza7ilWLu/Uy/ReWye5E/c="
    
    API 鍵とキーの秘密はこちらで生成できます。
    注: このプラグインに独自の変更を加えたい場合は、ソースをこちらで見つけることができます。