ビュー:

Trend Vision OneCLIを使用したファイルセキュリティ

CI/CDパイプラインへの統合 親トピック

CI/CDパイプラインにFile Securityを組み込み、ファイルが本番環境のパイプラインまたはストレージに配信される前に不正プログラムを検出します。 File Security CLIを継続的インテグレーション (CI) または継続的デリバリー (CD) パイプラインに簡単に統合できます。たとえば、Jenkins®プロジェクトでは、ファイルやアプリケーションを自動的にビルド、テストし、本番環境にプッシュできます。これらのファイルに不正プログラムが存在する場合、そのファイルが実行されたとき、または本番パイプラインの他の部分に配布されたときに、不正プログラムがリスクとなります。
File Security CLIは用途が広く、サードパーティベンダーやサプライチェーンパートナーによってファイルがアップロードまたは配布される本番環境で使用できます。受信したファイルをスキャンして、企業の境界内での悪意のある内部活動がないことを確認してから、企業環境の他の部分に転送します。
File Security CLIを使用して検索できるファイルの例は次のとおりです。
  • バイナリファイル
  • さまざまなファイルタイプのディレクトリ
  • サイズの大きいメディアファイル
  • サードパーティまたはサプライチェーンパートナーから受信したファイル

File Security CLIのインストール 親トピック

最適なパフォーマンスを確保し、最新の機能を利用するには、最新バージョンのFile Security CLIをインストールすることをお勧めします。最新バージョンを確認するには、 metadata.json
注意
注意
File Security CLIの新しいバージョンにアップデートする場合は、次のいずれかを実行して、システムのバイナリパス設定を調整する必要があります。
  • 既存のFile Security CLIバイナリをアップデートされたファイルバイナリに置き換える
  • 新しいFile Security CLIのバイナリの場所を指すようにPATHを変更する
アーキテクチャ
Darwin_arm64 (MacOS - Apple Siliconチップセット)
Darwin_x86_64 (MacOS - Intelチップセット)

APIキーの取得 親トピック

File Security CLIでは、有効なAPIキーが環境変数に格納されている必要があります。 Trend Vision One APIキーを受け入れることができます。環境変数として呼び出すTrend Vision Oneリージョンに関連付けられたAPIキーを追加してください。
macOSおよびLinux
TMFS_API_KEY=<your_vision_one_api_key> をエクスポートします。
Windowsコマンドプロンプト (cmd)
TMFS_API_KEY=<your_vision_one_api_key> を設定します。
Windows PowerShell
$env:TMFS_API_KEY="<your_vision_one_api_key>"
注意
注意
APIキーを取得したら、 Trend Vision Oneリージョンに関連付けます。を使用します。 -- 地域フラグを使用して、File Security CLIの実行時にAPIキーのリージョンを指定し、適切な認証を受けていることを確認します。サポートされているTrend Vision Oneのリージョンのリストは、リージョンフラグの下に表示されます。

手順

  1. 新しいTrend Vision One APIキーを作成します。
    1. に移動します。 Trend Vision OneUser Rolesページ
    2. [SDKを使用してファイル検索を実行] 権限が有効になっている役割があることを確認します。作成されていない場合は、 [役割を追加] をクリックして役割を作成し、完了したら [保存] をクリックします。
    3. 「SDKを介したファイル検索の実行」権限を持つ役割を使用して、 Trend Vision One API Keysページで新しいキーを直接設定します。 APIキーの有効期限を設定し、後で参照できるように記録しておくことをお勧めします。これらのキーは、 Trend Vision One API Keysページ
  2. File Security CLIをPATHに追加します。
    • macOSおよびLinux:エクスポートPATH="/path/to/tmfs/binary/directory:$PATH"
    • Windowsコマンドプロンプト (cmd): setx PATH "%PATH%;C:\path\to\tmfs\binary\directory"
      注意
      注意
      変更を有効にするには、コマンドプロンプトを閉じてから再度開きます。
    • Windows PowerShell:
      $pathToAdd = "C:\path\to\tmfs\binary\directory" [System.Environment]::SetEnvironmentVariable("Path", "$($env:Path);$pathToAdd", [System.EnvironmentVariableTarget]::User)
      注意
      注意
      変更を有効にするには、PowerShellを閉じてから再度開きます。

一般的な使用法 親トピック

File Security CLIを使用したコマンドの例については、「例」セクションを参照してください。
tmfs scan [target] [flags]

使用可能なコマンド 親トピック

コマンド
説明
scan
対象 (ファイルまたはディレクトリ) を検索する
version
現在のCLIバージョンの取得 (long)
help
help

コマンドの例 親トピック

 // リージョンフラグとファイルターゲットを使用 tmfs scan --region us-east-1 file:/Users/XXX/Downloads/eicar.tar.gz --tag "owner=johndoe" --tag "stack=prod" // エンドポイントフラグとディレクトリーターゲットを使用 tmfs scan --endpoint antimalware.us-1.cloudone.trendmicro.com:443 dir:/ユーザ/XXX/Uploads --tag "owner=janedoe" --tag "stack=dev"

コマンドフラグの使用 親トピック

コマンドフラグ

範囲
フラグ
説明
検索コマンド
-r, -- region
(文字列)vision one region options=[us-east-1, eu-central-1, ap-northeast-1, ap-southeast-2, ap-southeast-1]
  • V1リージョン
    • ap-northeast-1
    • ap-south-1
    • ap-southeast-1
    • ap-southeast-2
    • eu-central-1
    • us-east-1
検索コマンド
-- timeoutInSecs
単一ファイル検索のタイムアウト (秒)
180
検索コマンド
-t, -- tag
検索に使用するタグ
  • タグの最大数は8です
  • 各タグの長さは63文字以内で指定してください
--tag "stack=production"
--tag "owner=johndoe"
--tag "type=OCR"
--tag "purpose=customer_upload"
検索コマンド
--pml
機械学習型検索 (PML) を有効にするように指定します。
--pml true
検索コマンド
--フィードバック
Trend Smart Protection Network (SPN) フィードバックを有効にするように指定します。
--feedback true
検索コマンド
--allResults
  • ディレクトリ検索のみ
  • 不正プログラム検索なしを含むすべての検索結果を表示します。
--allResults
グローバル
--verbose
詳細度を上げる (-v = info、-vv = debug
 
グローバル
-h, --help
ヘルプ
 

サポート対象 親トピック

File Security CLIは、ディレクトリターゲットとファイルターゲットの両方をサポートします。

サポート対象

対象
説明
備考
dir:path/to/yourproject
ディスク上のパス (任意のディレクトリ) から直接読み取ります。
  • File Security CLIは、このディレクトリ内のファイルを並行して検索します。同時実行数の初期設定は10です。
  • ディレクトリの第1レベルのみを検索します。
  • 通常ファイルのみを検索します。シンボリックリンク、デバイスファイル、サブディレクトリは除外されます。
  • プロセス全体の初期設定のタイムアウトは15分です。
file:path/to/yourproject/file
ディスク上のパスから直接読み取ります (任意のファイル)。
 
注意
注意
File Security Previewリリースでは、検索は1GB未満のファイルに制限されます。

File SecurityのCLI対応ペイロード 親トピック

File SecurityのCLI対応ペイロードには、ファイルとディレクトリの両方のパラメータが含まれます。

ファイル

パラメータ
種類
説明
スキャナのバージョン
文字列
スキャナのバージョン
スキーマバージョン
文字列
スキーマのバージョン
scanResult
整数
検出された不正プログラムファイルの数
scanID
文字列
検索の一意の識別子
scanTimestamp
文字列
検索が実行された日時を示すタイムスタンプ
ファイル名
文字列
検索されたファイルの名前
不正プログラムが見つかりました
オブジェクト
特定された不正プログラムの詳細を含む配列 (存在する場合)
fileSHA1
文字列
検索されたファイルのSHA-1ハッシュ
fileSHA256
文字列
検索されたファイルのSHA-256ハッシュ
foundMalware[].fileName
文字列
不正プログラムが検出されたファイルの名前
foundMalware[]malwareName
文字列
検出された不正プログラムの名前または識別子
 { "scannerVersion": "1.0.0-9271111", "schemaVersion": "1.0.0", "scanResult": 1, "scanId": "6a018277-f969-403d-aa63-eba1223337e1", "scanTimestamp": "2023-11-20T18:50:43.663Z", "fileName": "./test/eicar-alpine.tar", "foundMalwares": [ { "fileName": "malware/eicar.com", "malwareName": "Eicar_test_file" } ], "fileSHA1": "da39a3ee5e6b4b0d3255bfef95601890afd80709", "fileSHA256": "e5f24b4ac134a7d923ae0f9689b86f015f86edbc3cc95e4c9f9406412914de05" }

ディレクトリ

パラメータ
種類
説明
備考
開始時刻
文字列
検索処理の開始時刻を示すタイムスタンプ
終了時刻
文字列
検索処理の終了時刻を示すタイムスタンプ
不正プログラムの総数
整数
すべての検索結果の不正プログラムの総数
scanResults
オブジェクト
すべての検索結果を含む配列
不正プログラムを含むファイルのみを収集します
scanResults[].scannerVersion
文字列
スキャナのバージョン
scanResults[].schemaVersion
文字列
スキーマのバージョン
scanResults[].scanResults
整数
検出された不正プログラムの数
scanResults[].scanId
文字列
検索の一意の識別子
scanResults[].scanTimestamp
文字列
検索が実行された日時を示すタイムスタンプ
scanResults[].fileName
文字列
検索されたファイルの名前
scanResults[].foundMalwares
オブジェクト
特定された不正プログラムの詳細を含む配列 (存在する場合)
scanResults[].SHA1
文字列
検索されたファイルのSHA-1ハッシュ
scanResults[].SHA256
文字列
検索されたファイルのSHA-256ハッシュ
scanResults[].foundMalwares[].fileName
文字列
不正プログラムが検出されたファイルの名前
scanResults[].foundMalwares[].malwareName
文字列
検出された不正プログラムの名前または識別子
 { "startTime": "2023-11-20T18:36:05.926Z", "endTime": "2023-11-20T18:36:06.316Z", "totalMalwareCount": 1, "scanResults": [ { "scannerVersion": "1.0.0-9271111", "schemaVersion": "1.0.0", "scanResult": 1, "scanId": "c104229a-247c-4d0d-8fca-c27c33824ef5", "scanTimestamp": "2023-11-20T18:36:06.373Z", "fileName": "./test/eicar-alpine.tar", "foundMalwares": [ { "fileName": "malware/eicar.com", "malwareName": "Eicar_test_file" } ], "fileSHA1": "da39a3ee5e6b4b0d3255bfef95601890afd80709", "fileSHA256": "e5f24b4ac134a7d923ae0f9689b86f015f86edbc3cc95e4c9f9406412914de05" } ] }

プロキシ設定 親トピック

File Security CLIは、一連のオプションの環境変数からプロキシ設定をロードします。

環境変数

環境変数
必須/オプション
説明
NO_PROXY
オプションかどうか
ホスト名のカンマ区切りリストにFile Security Malware Scanning as a Serviceエンドポイントを追加します。 File Security CLIのプロキシ設定をスキップする場合に使用します。
注意
注意
すべてのホストに一致させるには、アスタリスク*を使用します。
HTTP_PROXY
オプションかどうか
http://proxy.example.com
HTTPS_PROXY
オプションかどうか
https://proxy.example.com
注意
注意
プロキシサーバがSOCKS5プロキシの場合は、URLにSOCKS5プロトコルを指定する必要があります。例:socks5://socks.proxy.com
PROXY_USER
オプションかどうか
で使用される認証ヘッダのユーザ名プロキシ認証
PROXY_PASS
オプションかどうか
で使用される認証ヘッダのパスワードプロキシ認証。 PROXY_USERが設定されている場合にのみ使用されます。