ビュー:

TrendAI Vision One™™ File Security Python SDKを使用してファイルを検索し、不正プログラムを検出します。

TrendAI Vision One™™ File Security用Python SDKは、File Securityとシームレスに統合するアプリケーションを作成することを可能にします。このSDKを使用すると、アプリケーション内のデータやアーティファクトを徹底的に検索し、潜在的な悪意のある要素を特定することができます。
次の手順に従って、開発環境とプロジェクトを設定し、ファイルセキュリティを効果的に使用するための基礎を築きます。

前提条件 親トピック

SDKをインストールする前に、次のものが揃っていることを確認してください。

APIキーを作成する 親トピック

File Security SDKは、SDKクライアントオブジェクトにパラメータとして提供される有効なAPIキーを必要とします。TrendAI Vision One™ APIキーは異なる地域に関連付けられています。APIキーに関連する有効な地域をよりよく理解するために、以下の地域フラグを参照してください。

手順

  1. [Administrations] → [APIキー]に移動します。
  2. [Add API Key]をクリックします。
  3. [Run file scan via SDK] 権限を持つロールを使用するようにAPIキーを設定します。
  4. APIキーが使用するリージョンに関連付けられていることを確認します。
  5. APIキーの有効期限を設定し、後で参照できるように記録します。

SDKをインストール 親トピック

手順

  • pipを使用してFile Security SDKパッケージをインストールします。
    python -m pip install visionone-filesecurity

SDKを実行 親トピック

手順

  1. GitHubのExamplesフォルダに移動します。
  2. フォルダ内のPythonの例を確認します。
    • client.pyの例では、通常のファイル入出力 (i/o) を使用します。
    • client_aio.pyの例では非同期I/Oを使用します。
    Pythonの例では、次の表のコマンドライン引数がサポートされています。

    Pythonの例

    コマンドライン引数 値 オプションかどうか
    --region or -r APIキーのリージョン。値は次のTrendAI Vision One™リージョンのいずれかでなければなりません:
    • ap-northeast-1
    • ap-south-1
    • ap-southeast-1
    • ap-southeast-2
    • eu-central-1
    • us-east-1
    		 はい-rまたは-a
    --addr or -a ファイルセキュリティサーバ (例: antimalware.REGION.cloudone.trendmicro.com:443) はい-rまたは-a
    --api_key TrendAI Vision One™ API キー いいえ
    --filename or -f 検索するファイル いいえ
    --pml 機械学習型検索 はい
    --tagsまたは-f タグのリスト はい
  3. 例の1つを実行してください。また、これらの例を使用して独自のプログラムを書くこともできます。

例をカスタマイズ 親トピック

次のいずれかをカスタマイズできます。サンプルプログラムで設定します。 APIキー。カスタムプログラムの場合は、regionパラメータを渡してAPIキーのリージョンを指定し、適切な認証があることを確認します。

手順

  1. の値を割り当てます。 API_KEYを変数に追加します。
  2. 設定ファイル名をクリックします。
    python3 client.py -f FILENAME -r us-1 --api_key API_KEY
    File Securityサーバのアドレスを使用できます。 -a地域の代わりに-r 。
    python3 client.py -f FILENAME -a antimalware._REGION_.cloudone.trendmicro.com:443 --api_key API_KEY
    非同期IOのサンプルプログラムを使用することもできます。
    python3 client_aio.py -f FILENAME -a antimalware._REGION_.cloudone.trendmicro.com:443 --api_key API_KEY

キャッシュダイジェストを無効にする 親トピック

SDKをPythonで使用して大きなファイルを検索する場合、キャッシュダイジェストを無効にすることをお勧めします。scan_file APIの「digest」というパラメータがあります。"digest: bool = True"を"digest: bool = False"に変更してください。