CxConsole: CxSAST CLI (jp)

概要

CxConsoleは、開発するアプリケーションのセキュリティ違反を監視/評価するためのCheckmarxソリューションのコンポーネントです。開発者、監査担当者、セキュリティ専門家向けに提供されています。

CxConsoleは、CxSASTスキャンを実行するCheckmarxスキャンエンジン用のコマンドラインインターフェース（CLI）です。CLIは、たとえばソフトウェア開発サイクルで継続的インテグレーションをサポートする場合などに、ソフトウェア管理ツールの機能を呼び出す際に有用です。 

CxConsoleを有効にするには、ここからCLIをダウンロードのうえ、Javaがインストールされているコンピュータ上に展開してください。

CLIにはscanコマンドが含まれています。

scanコマンドの実行

スクリプトからコマンドを実行する場合の完全なコマンド構文は以下のとおりです。

<path>\runCxConsole.cmd scan <arguments>

<path>には、runCxConsole.cmdファイルのフルパスを記述してください。<arguments>については、このページの下にあるリンク先を参照してください。また、引数を記述する順序は任意ですが、一部の引数は指定が必須です。

scanコマンドの引数

scanコマンドはスキャンを実行し、その結果を新規/既存のCxSASTプロジェクトに保存します。ソースコードは、必ず指定しなければなりません。既存プロジェクトのソースコードの保存先は、使用されないためです。

コマンドの実行中は、その進捗状況がコンソールに表示され、1分ごとに更新されます。スキャンが完了（あるいは失敗）すると、次の3つのファイルが生成されます。

• Logファイル： デフォルトで\CxConsole\Logに作成される。コマンド引数に-logを指定することで、別の場所を指定することが可能

  Logフォルダには、読み込み/書き込み権限を必ず付与してください

• XMLレポート（自動削除向け）： コマンド引数に-xmlを指定することで、別の場所を指定することが可能
• PDFレポート： コマンド引数に-pdfを指定した場合に限り、生成される

CLIの引数に関する詳しい説明については、こちらを参照してください。