MetaDefender™ TeamCity Plugin
一般にリリースする前に、TeamCity ビルドにマルウェアや誤検知のウイルス対策アラートがないかをチェックして、評判を保護します。 MetaDefender プラグインを使用すると、30 以上の主要なマルウェア対策エンジンでビルドをすばやくスキャンして、マルウェアの可能性を検出するだけでなく、ウイルス対策エンジンがソフトウェアまたはアプリケーションに悪意のあるものとして誤ってフラグを立て、損害を引き起こす可能性がある場合に警告することもできます。
MetaDefender TeamCity プラグインの実装手順
次の手順に従って、OPSWAT MetaDefender プラグインの使用を開始してください：
プラグインをインストールする
プラグインをインストールするには、TeamCity でServer Administration > Plugins List に進みます。Upload Plugin Zip]ボタンをクリックし、metadefender-plugin.zipファイルを選択します。TeamCity サービスを再起動します。プラグインリストに'OPSWAT MetaDefender ' が表示されます。
プラグインとグローバル設定の設定
まず、MetaDefender プラグインを設定する必要があります。Server 管理」から「OPSWAT MetaDefender 」に進みます。以下のオプションが利用可能です：
- Enter the MetaDefender URL. If you are using MetaDefender Cloud, enter https://api.metadefender.com/v4/file. If you have an on-premises MetaDefender Core v4 installation, enter http://<MetaDefender Core IP address>:8008/file.
- MetaDefender API キーを入力してください。(無料のMetaDefender API キーは、一定の限度までしか使用できないことにご注意ください。商用版のご利用を希望される場合は、以下のページをご覧ください。 エンタープライズライセンスオプション。)
- MetaDefender Cloud:無料のMetaDefender Cloud キーをリクエストするには、metadefender.comでアカウントを作成する必要があります。アカウントを作成したら、右上の名前をクリックし、「アカウント情報」を選択してください。あなたのMetaDefender Cloud API キーが表示されます。
- MetaDefender オンプレミス：MetaDefender の 15 日間オンプレミス キーをリクエストするには、OPSWAT ポータルから MetaDefender をダウンロードしてインストールします。インストール後、MetaDefender ウェブコンソールにサインインし、「Settings（設定）」>「License（ライセンス）」に進みます。アクティベート」ボタンをクリックします。API キーが電子メールで送信されます。
ビルド パラメータのシステム プロパティを変更しない限り、すべてのビルドに適用される多数のグローバル オプションを設定できます (手順 3 を参照)。 次のオプションが利用可能です。
- Scan timeout」に、MetaDefender ファイルスキャンが自動的にタイムアウトするまでの分数を入力する。デフォルトは30分です。
- スキャン結果のリンクを表示」を有効にすると、MetaDefender スキャン結果の詳細へのリンクが表示され、どのマルウェア対策エンジンが脅威を検出したかを確認できます。
- ビルド実行時に自動的にスキャンする」オプションを有効にすると、ビルド実行時にアーティファクトが自動的にスキャンされます。
ビルド設定の構成
注：グローバル・オプションを上書きしたい場合のみ、ビルド設定を行う必要があります。
特定のビルドに対して異なるオプションを設定したい場合は、「Build Configuration（ビルド構成）」>「Parameters（パラメータ）」>「Add new parameter（新規パラメータを追加）」（「Kind（種類）」で「System Property（システムプロパティ）」を選択）で、以下のシステムプロパティのいずれかを設定できます：
| システム・プロパティ名 | 説明 |
|---|---|
metadefender_scan_artifact
| デフォルト値は0である。 |
metadefender_scan_log
|
1に設定すると、スキャンログmetadefender_scan_log.txtが成果物フォルダに作成されます。 デフォルト値は0です。 |
metadefender_fail_build
| デフォルト値は1である。 |
metadefender_scan_timeout
|
ファイルがタイムアウトするまでの分数を入力する。
|
ビルドパラメータにシステムプロパティを指定すると、グローバルオプションが上書きされることに注意。ビルドにグローバル設定を使用したい場合は、システム・プロパティを入力しないでください。
ビルドの実行とスキャン結果の確認
ビルドを実行した後、MetaDefender が脅威を検出した場合、ビルドは失敗し、Found x threat(s) + blocked result(s)と表示されます。
Found x threat(s) + blocked result(s )をクリックすると、スキャン結果が表示されます：
If the build is successful, you can check the MetaDefender scan results in your Build Log. If a threat was found, it will be listed in the following format: <file name> process result: Blocked | Infected. To check which anti-malware engines detected a threat, go to the link in the scan results.
問題が見つからなかった場合、ログファイルにメッセージは表示されない。
プラグインをアンインストールするには
TeamCity データフォルダに移動します：C:︙ProgramDataJetBrains︙TeamCity︙pluginsフォルダに移動し、metadefender-plugin.zipと.unpacked︙metadefender-pluginを削除します。TeamCity サービスを再起動します。
偽陽性の場合の対処法
MetaDefender があなたのビルドで脅威を検出したが、それが誤検出であることが分かっている場合は、次の手順に従ってください：
- 以下の手順に従って、AVベンダーに誤検出のケースを提出してください：opswat
- 一方、TeamCityで'Mute in'を選択してissueをミュートします。
- これで、ビルドを再度実行したときにパスします。スキャン結果に変更があった場合、たとえばブロックされたファイルが変更された場合や、脅威を検出したエンジンの数が異なる場合は、新しいエラーが発生します。上書きするには、この問題を再度ミュートします。
