檢視次數:

使用 TrendAI Vision One™™ File Security Python SDK 掃瞄檔案以檢測惡意程式。

Python SDK for TrendAI Vision One™™ File Security 讓您能夠打造與 File Security 無縫整合的應用程式。使用此 SDK，您可以對應用程式中的資料和檔案進行全面掃瞄，以識別潛在的惡意元素。
按照以下步驟設置您的開發環境並配置您的項目，為有效使用文件安全奠定基礎。

先決條件 上層主題

在安裝 SDK 之前，請確保您具備以下條件：

建立 API 金鑰 上層主題

File Security SDK 需要提供有效的 API 金鑰作為 SDK 客戶端物件的參數。TrendAI Vision One™ API 金鑰與不同地區相關聯。請參閱下方的地區標誌以更好地了解與 API 金鑰相關的有效地區。

步驟

  1. 前往Administrations → API Keys。
  2. 點選Add API Key。
  3. 配置 API 金鑰以使用具有Run file scan via SDK權限的角色。
  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 或 -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 或 -a 檔案安全伺服器，例如： antimalware.REGION.cloudone.trendmicro.com:443 是的，可以使用 -r 或 -a
    --api_key TrendAI Vision One™ API 金鑰 否
    --filename 或 -f 要掃描的檔案 否
    --pml Machine Learning 是
    --tags 或 -f 標籤列表 是
  3. 運行其中一個範例。您也可以使用這些範例來編寫您自己的程式。

自訂範例 上層主題

您可以透過配置 API 金鑰 來自訂其中一個 範例程式。對於自訂程式，請傳入區域參數以指定 API 金鑰的區域並驗證您是否具有適當的授權。

步驟

  1. 將 API_KEY 的值指派給變數。
  2. 將 FILENAME 設定為所需的目標檔案。
    python3 client.py -f FILENAME -r us-1 --api_key API_KEY
    您可以使用檔案安全伺服器地址 -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 來掃瞄大型檔案，您可能想要關閉快取摘要。有一個參數稱為掃瞄檔案 API 中的 "digest。將 "digest: bool = True" 更改為 "digest: bool = False"。