Aikido CLI: PRゲーティング

Aikido Security CLI クライアントを使用すると、Aikido Security のスキャンを Jenkins や CircleCI などのカスタム CI パイプラインに統合できます。これにより、セキュリティスキャンをビルドプロセスの一部として確実に組み込むことができます。

ユースケース

• プルリクエストチェック: プルリクエストに合格/不合格のチェックを自動的に追加します。

ステップバイステップガイド

ステップ 1: @aikidosec/ci-api-client パッケージをグローバルにインストールします。

# For npm users
$ npm install -g @aikidosec/ci-api-client

# For yarn users
$ yarn global add @aikidosec/ci-api-client

ステップ 2: Aikido API キーを設定します

1. Continuous Integration 設定ページから API キーを取得します。
2. API キーをグローバルに設定します:

$ aikido-api-client apikey <your-api-key-here>

ステップ 3: プルリクエストスキャンを実行します
scan コマンドはプルリクエストゲーティングに使用されます。

$ aikido-api-client scan <repository_id or repository_name> <base_commit_id> <head_commit_id>

オプション:

このコマンドのフラグは @aikidosec/ci-api-client パッケージに記載されています。次のコマンドでローカルに表示できます:

aikido-api-client help scan

ステップ 4: カスタムテスト結果をアップロードします（scan コマンドでのみサポート）
必要に応じて、次のコマンドを使用してカスタムテスト結果をアップロードできます:

$ aikido-api-client upload --repository-id <repository_id> --type checkov --file <path_to_payload_file>