ローカルコードスキャン用のCLIオプション

Aikido Security Local Scannerは、Aikido Securityのスキャンを自社環境内で実行できるツールであり、コードが決して外部に出ないことを保証します。以下に、ローカルスキャナー実行時に指定できるオプションを示します。

リポジトリスキャン

使用法: aikido-local-scanner scan [options] <path>

スキャンを実行します。

引数:
  path                                     スキャンしたいパス。

オプション:
  --apikey <apikey>                        スキャン結果をAikdoに送信するためのAPIキー。 (env: AIKIDO_API_KEY)
  --repositoryname <repositoryname>        結果の作成先または送信先のリポジトリ名。
  --branchname <branchname>                スキャン対象のブランチ名。
  --tmpdirectory <tmpdirectory>            スキャン中に使用する一時ディレクトリ。(default: "./.aikidotmp")
  --debug                                  コマンド出力に追加のデバッグ情報を含めます。
  --disable-artifact-scanning              アーティファクトのスキャンを無効にします。jarファイルなどのアーティファクトをスキャンしない代わりに、スキャンを高速化するために使用します。
  --secrets-scanning-full-git-history      秘密情報に対してGit履歴全体のスキャンを有効にします。
  --scan-types [types...]                  実行するスキャンの種類を指定します。これにより --scanners フラグ（下記参照）は上書きされます。 (choices: "code", "dependencies", "iac", "secrets", default: [])
  --exclude <exclude_path>                 スキャンから除外するファイルまたはフォルダのパスを指定します。このオプションは複数回指定できます。 (default: [])
  --fail-on <severity>                     ゲーティングモードでスキャナーを実行し、指定した重大度以上で失敗させます。 (choices: "low", "medium", "high", "critical")
  --gating-mode <mode>                     スキャナーをreleaseまたはPRのゲーティングモードのどちらで実行するかを指定します。releaseゲーティングモードではメインブランチをスキャンし、リリースを妨げる可能性のある問題があるか確認するまで待機します。プルリクエストモードでは、Aikidoはブランチに新たに導入された脆弱性のみを探します（差分をスキャンします）。比較を機能させるには、baseおよびheadのコミットを指定する必要があります。--fail-onフラグと組み合わせて使用する必要があります。 (choices: "release", "pr", default: "release")
  --sla-mode                               releaseゲーティングモードでは、SLAを超過している問題のみでゲートを失敗させます。
  --base-commit-id <commit-id>             ベースコミットID。Aikidoが新しい検出結果かどうかを判断するために比較対象とするコミットです。PRゲーティングモードでのみ使用されます。
  --head-commit-id <commit-id>             ヘッドコミットID。スキャン対象のコミットです。PRゲーティングモードでは必須です。
  --gating-result-output <output>          ゲーティングモード実行時のみ、問題を書き出すJSONファイル
  --no-fail-on-timeout                     スキャン結果のポーリングがタイムアウトした場合でも、プロセスを失敗させません（ゲーティングモードのみ）
  --max-polling-attempts <amount>          スキャン結果のポーリング回数。デフォルト値の20回では足りない場合は増やしてください（ゲーティングモードのみ）
  --linked-team-name <name>                リポジトリを関連付けるチーム名。このオプションを複数回指定すると、複数のチームに関連付けられます。 (default: [])
  --no-snippets                            このモードを使用すると、Aikidoとコードスニペットを共有しません。
  --checkov-skip-extension <extension>     Checkovスキャンで特にスキップする拡張子を指定します。このオプションは複数回指定できます。例: JSONファイルを無視したい場合、このオプションの値として .json を指定します。 (default: [])
  --no-lockfiles-cache                     自動再スキャンを有効にするために、依存関係ファイルおよびロックファイルのキャッシュを許可しません
  --scan-timeout <timeout>                 各スキャンのタイムアウト（ミリ秒）。(defaults to 900000ms)。
  --force-create-repository-for-branch     ブランチごとにAikido内で新しいリポジトリを作成します。
  --enable-proxy                           HTTPS_PROXY環境変数を使用してリクエストをプロキシします。
  --ca-bundle <path>                       --enable-proxy使用時に信頼するカスタムルートCAを含むPEMファイルへのパス。 (env: AIKIDO_CA_BUNDLE)
  --include-dev-deps                       開発用依存関係のスキャンを有効にします（例: package.json の devDependencies など）
  -h, --help                               コマンドのヘルプを表示します

イメージスキャンのCLIオプションについては、こちらを参照してください こちら.

一般的な使用例

以下に、一般的な使用例の設定例をいくつか示します。

リポジトリでスキャンを実行したい

APIキーは環境変数として渡すこともできます AIKIDO_API_KEY

aikido-local-scanner scan ./ 
--apikey AIK_CI_xxx 
--repositoryname DemoApp 
--branchname main

リポジトリでSCAスキャンのみを実行したい

aikido-local-scanner scan ./ 
--apikey AIK_CI_xxx 
--repositoryname DemoApp 
--branchname main 
--scan-types dependencies

リポジトリで秘密情報スキャンのみを実行したい

aikido-local-scanner scan ./ 
--apikey AIK_CI_xxx 
--repositoryname DemoApp 
--branchname main 
--scan-types secrets

リポジトリでコードスキャンのみを実行したい

aikido-local-scanner scan ./ 
--apikey AIK_CI_xxx 
--repositoryname DemoApp 
--branchname main 
--scan-types code

リポジトリでIaCスキャンのみを実行したい

aikido-local-scanner scan ./ 
--apikey AIK_CI_xxx 
--repositoryname DemoApp 
--branchname main 
--scan-types iac

/staging と /development フォルダをスキャン対象から除外したい

aikido-local-scanner scan ./ 
--apikey AIK_CI_xxx 
--repositoryname DemoApp 
--branchname main 
--exclude staging 
--exclude development

秘密情報スキャンとコードスキャンのみを実行し、/staging フォルダを除外したい。

aikido-local-scanner scan ./ 
--apikey AIK_CI_xxx 
--repositoryname DemoApp 
--branchname main 
--scan-types secrets code
--exclude staging