Ansichten:

Verwenden Sie das TrendAI Vision One™™ File Security Python SDK, um Dateien auf Malware zu DURCHSUCHEN.

Das Python SDK für TrendAI Vision One™™ Dateisicherheit ermöglicht es Ihnen, Anwendungen zu erstellen, die nahtlos mit der Dateisicherheit integriert sind. Mit diesem SDK können Sie eine gründliche DURCHSUCHEN von Daten und Artefakten innerhalb Ihrer Anwendungen durchführen, um potenziell bösartige Elemente zu identifizieren.
Befolgen Sie die unten stehenden Schritte, um Ihre Entwicklungsumgebung einzurichten und Ihr Projekt zu konfigurieren, und legen Sie damit den Grundstein für die effektive Nutzung der Dateisicherheit.

Voraussetzungen Übergeordnetes Thema

Stellen Sie vor der Installation des SDK sicher, dass Sie Folgendes haben:

Erstellen eines API-Schlüssels Übergeordnetes Thema

Das File Security SDK erfordert einen gültigen API-Schlüssel, der als Parameter an das SDK-Client-Objekt übergeben wird. TrendAI Vision One™ API-Schlüssel sind mit verschiedenen Regionen verknüpft. Beziehen Sie sich auf die untenstehende Regionsflagge, um ein besseres Verständnis der mit dem API-Schlüssel verknüpften gültigen Regionen zu erhalten.

Prozedur

  1. Navigieren Sie zu Administrations → API Keys.
  2. Klicken Sie auf Add API Key.
  3. Konfigurieren Sie den API-Schlüssel, um die Rolle mit der Run file scan via SDK-Berechtigung zu verwenden.
  4. Überprüfen Sie, ob der API-Schlüssel mit der Region verknüpft ist, die Sie verwenden möchten.
  5. Legen Sie eine Ablaufzeit für den API-Schlüssel fest und machen Sie eine Aufzeichnung davon für zukünftige Referenz.

Installieren Sie das SDK Übergeordnetes Thema

Prozedur

  • Installieren Sie das File Security SDK-Paket mit pip:
    python -m pip install visionone-filesecurity

SDK ausführen Übergeordnetes Thema

Prozedur

  1. Gehen Sie zum Beispielordner auf GitHub.
  2. Überprüfen Sie die Python-Beispiele im Ordner:
    • Das client.py-Beispiel verwendet reguläre Datei-Ein-/Ausgabe (i/o).
    • Das client_aio.py-Beispiel verwendet asynchrones I/O.
    Die Python-Beispiele unterstützen die Befehlszeilenargumente in der folgenden Tabelle.

    Python-Beispiele

    Befehlszeilenargumente Wert Optional
    --region or -r Der Bereich für Ihren API-Schlüssel. Der Wert muss einer der folgenden TrendAI Vision One™ Regionen sein:
    • ap-northeast-1
    • ap-south-1
    • ap-southeast-1
    • ap-southeast-2
    • eu-central-1
    • us-east-1
    		 Ja, entweder -r oder -a
    --addr or -a Dateiserver für Sicherheit, zum Beispiel: antimalware.REGION.cloudone.trendmicro.com:443 Ja, entweder -r oder -a
    --api_key TrendAI Vision One™ API-Schlüssel No
    --filename or -f Zu scannende Datei No
    --pml Vorausschauendes Maschinenlernen Ja
    --tags or -f Liste der Tags Ja
  3. Führen Sie eines der Beispiele aus. Sie können diese Beispiele auch verwenden, um Ihr eigenes Programm zu schreiben.

Beispiele anpassen Übergeordnetes Thema

Sie können eines der Beispielprogramme anpassen, indem Sie es mit dem API-Schlüssel konfigurieren. Für benutzerdefinierte Programme übergeben Sie den Regionsparameter, um die Region des API-Schlüssels anzugeben und zu überprüfen, ob Sie die entsprechende Berechtigung haben.

Prozedur

  1. Weisen Sie den Wert von API_KEY der Variablen zu.
  2. Setzen Sie FILENAME auf die gewünschte Zieldatei.
    python3 client.py -f FILENAME -r us-1 --api_key API_KEY
    Sie können die File Security Server-Adresse -a anstelle der Region -r verwenden.
    python3 client.py -f FILENAME -a antimalware._REGION_.cloudone.trendmicro.com:443 --api_key API_KEY
    Sie können auch das asynchrone IO-Beispielprogramm verwenden.
    python3 client_aio.py -f FILENAME -a antimalware._REGION_.cloudone.trendmicro.com:443 --api_key API_KEY

Deaktivieren des Cache-Digests Übergeordnetes Thema

Wenn Sie das SDK mit Python verwenden, um große Dateien zu durchsuchen, möchten Sie möglicherweise den Cache-Digest deaktivieren. Es gibt einen Parameter namens "digest in der scan_file API. Ändern Sie "digest: bool = True" zu "digest: bool = False".