分析コマンド (Linux™ と macOS)

分析コマンドは、分析のためのスキャン要求を送信するために、または既に送信されているスキャン要求を操作するために使用します。これらのコマンドを使用して、スキャンに関する情報を取得することもできます。この情報は、自動化スクリプトに役立ちます。

これらのコマンドを使用する前に、分析サービスにログインしていることを確認します (認証コマンドを参照)。

appscan.sh status

構文:

appscan.sh status -i <job_id>

説明:

分析ジョブの以下のステータス・コードのいずれかを返します。

0 = Pending
1 = Starting
2 = Running
3 = FinishedRunning
4 = FinishedRunningWithErrors
5 = PendingSupport
6 = Ready
7 = ReadyIncomplete
8 = FailedToScan
9 = ManuallyStopped
10 = None
11 = Initiating
12 = MissingConfiguration
13 = PossibleMissingConfiguration

必須指定のオプション:

  • -i: -i <job_id> と指定します。<job_id> には分析ジョブの ID が入ります。
ヒント: すべてのコマンドで、オプションは任意の順序で使用できます。

例:

ジョブ ID 12345 のステータスを確認するには、次のように指定します。

appscan.sh status -i 12345

戻りコードが 0 の場合、ジョブは保留中です。戻りコードが 1 の場合、ジョブは開始中以降の状態です。

appscan.sh list

構文:

appscan.sh list

説明:

分析ジョブをすべて一覧表示します。この一覧には、待機、実行中、および完了済みのジョブが含まれます。各ジョブの ID が返され、他のコマンドにその ID を使用することができます。例えば、その ID は、コマンド・プロンプトやスクリプト中の info コマンドで使用できます。

appscan.sh list_apps

構文:

appscan.sh list_apps

説明:

HCL Cloud Marketplace のみ: HCL Cloud Marketplace で AppScan on Cloud サービスに接続している場合は、クラウドに送信する IRX ファイルを既存の AppScan on Cloud アプリケーションに関連付ける必要があります。

このコマンドにより、アクセスできる AppScan on Cloud アプリケーションを確認できます。このコマンドを使用するには、サービスの認証を受ける必要があります。コマンドを発行すると、AppScan on Cloud アプリケーションのリストにアプリケーション名が表示され、その後に括弧内の ID が続きます。queue_analysis コマンドで -a オプションを使用する場合、このリストの ID 値を使用します。

appscan.sh cancel

構文:

appscan.sh cancel -i <job_id>

説明:

実行中または待機中の分析ジョブをキャンセルします。

必須指定のオプション:

  • -i: -i <job_id> と指定します。<job_id> には分析ジョブの ID が入ります。
ヒント: すべてのコマンドで、オプションは任意の順序で使用できます。

例:

ジョブ ID 12345 をキャンセルするには、次のように指定します。

appscan.sh cancel -i 12345

appscan.sh queue_analysis

構文:

appscan.sh queue_analysis -a <app_id> -f <file> -di -n <scan_name> -nen -oso -ps -sao

説明:

分析のためにファイルを送信します (IRX または非 IRX アーカイブ)。スキャンの完了時に、メール通知が届きます (分析サービスへのログインに使用したアカウントに関連付けられた E メール・アドレス宛て)。E メールには、ログインしてスキャンをダウンロードできるようにリンクが含まれています。
注: コードをスキャンするか、IRX ファイルを生成する際に、最新の Static Analyzer コマンド行ユーティリティー への更新に関するメッセージを受け取ることがあります。「コマンド行ユーティリティー (CLI) のサポート」を参照してください。
注: コードをスキャンするか、IRX ファイルを生成する際に、最新の Static Analyzer コマンド行ユーティリティー への更新に関するメッセージを受け取ることがあります。「コマンド行ユーティリティー (CLI) のサポート」を参照してください。

必須指定のオプション:

  • -a: 分析用に送信するファイル (IRX ファイルまたは非 IRX ファイル) は、既存の AppScan on Cloud アプリケーションに関連付けられている必要があります。このオプションを使用する場合は、-a <app_id> と指定します。<app_id> には、関連付けるアプリケーションの ID が入ります。ID を確認するには、list_apps コマンドを使用します。
  • -f: -f <file> と指定します。<file> は、スキャン用に送信する IRX ファイル、または非 IRX です。ファイルが現行ディレクトリーにない場合、このオプションを使用して ファイル・パスおよびファイル名を指定します。
    注: このオプションが必要なのは、以下の記述のいずれかまたは両方が当てはまる場合のみです。
    • 複数のアセスメント・ファイルが含まれているディレクトリーから、コマンドが発行されています。ディレクトリーに含まれているターゲット・ファイルが 1 つのみで、-f オプションが使用されていない場合は、そのファイルが送信されます。
    • ターゲット・ファイルが 1 つも含まれていないディレクトリーから、コマンドが発行されています。この場合、-f オプションを使用して、送信するファイルのパスとファイル名を指定する必要があります。
オプションのフラグ/設定:
  • -di: 介入を無効にします。何らかの理由でスキャンが失敗した場合に、構成を改善しようとしてスキャン有効化チームが介入することはありません。デフォルトでは、スキャンが失敗すると、レビュー中ステータスに入り、スキャン有効化チームによる介入を待機します。-di を指定してこの介入を無効にします。スキャンは単純に失敗します。
  • -n: -n <scan_name> と指定します。<scan_name> は送信済みスキャンの名前です。
  • -nen: 分析完了時の E メール通知を無効にします。このフラグを指定しない場合、デフォルトでメール通知が行われます。
    注: -e フラグは非推奨となり、-nen に代わりました。
  • -oso: SCA パッケージで既知の脆弱性のみを探すには、-oso を指定します。-oso を指定した場合、AppScan on Cloud はパッケージでの静的分析を実行しません。
    注: ユーザーがオープン・ソース・ライセンスを持っている場合、SCA 分析はデフォルトで静的スキャンに含まれます。このオプションでは、分析が SCA の脆弱性に限定されます。SCA のみの分析を利用するには、オープン・ソース・ライセンスを持っている必要があります。
  • -ps: 個人スキャンとしてスキャンを実行します。このフラグを指定しない場合、デフォルトで通常のスキャンが実行されます。
  • -sao: 静的分析のみを実行する場合は -sao を指定します。-sao を指定した場合、AppScan on Cloud はパッケージでのオープン・ソース分析を実行しません。
ヒント: すべてのコマンドで、オプションは任意の順序で使用できます。

例:

現行ディレクトリーにある my_irx.irx をスキャン用に送信するには、次のコマンドを使用します。
appscan queue_analysis -f my_irx.irx -a 12345 -n my_scan
12345 には、スキャンを関連付けるアプリケーションの ID が入ります (アプリケーション ID は list_appsコマンドで確認できます)。ユーザー・インターフェースまたは list コマンドを使用してすべての現行スキャンを表示すると、リストに my_scan が表示されます。
オープン・ソースのみ (SCA) または静的分析のみを指定せずに IRX を作成した場合、これらのオプションは appscan queue_analysis.で -oso または -sao オプションを使用して分析時に適用できます。この例では、次のコマンドを使用して、オープン・ソースと静的分析の両方についてファイルを送信します。
appscan queue_analysis -a <application> -f my_irx.irx
次のコマンドは、静的分析のファイルのみを送信します。
appscan queue_analysis -a <application> -f <file> -sao
次のコマンドは、オープン・ソース分析 (SCA) のファイルのみを送信します。
appscan queue_analysis -a <application> -f <file> -os
逆に、ファイルが作成され、オープン・ソースのみ (SCA) または静的分析のみが appscan prepare で指定されている 場合は、基本コマンド
appscan queue_analysis -a <application> -f my_irx.irx
は、appscan prepare コマンドで指定された分析タイプのファイルのみを送信します。

appscan.sh info

構文:

appscan.sh info -i <job_id>

説明:

指定した分析ジョブの情報を表示します。

この情報は自動化スクリプトに使用できます。

必須指定のオプション:

  • -i: -i <job_id> と指定します。<job_id> には分析ジョブの ID が入ります。
ヒント: すべてのコマンドで、オプションは任意の順序で使用できます。

例:

ジョブ ID 12345 に関する情報を取得するには、次のように指定します。

appscan.sh info -i 12345

返される情報の例:

NLowIssues=0
ReadStatus=2
NHighIssues=0
Name=appscan.zip
ScanEndTime=2014-11-20T13:56:04.497Z
Progress=0
RemainingFreeRescanMinutes=0
ParentJobId=00000000-0000-0000-0000-000000000000
EnableMailNotifications=false
JobStatus=6
NInfoIssues=0
JobId=9b344fc7-bc70-e411-b922-005056924f9b
NIssuesFound=0
CreatedAt=2014-11-20T13:54:49.597Z
UserMessage=Scan completed successfully. The report is ready.
NMediumIssues=0
Result=1