X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Antivirus

Dieser Adapter stellt eine Verbindung zu einem Server der ClamAV, einer Open Source (GPL) Antivirus-Engine, her. Eingabedateien werden zur Laufzeit des Adapters auf Viren überprüft.

Eigenschaften (Properties)

Operation

Bestimmt, welche Operation der Adapter durchführt

Mögliche Werte:

Scan: Eingabedateien auf Viren überprüfen.

Parameter

Adapter

Hauptklasse des Adapters (nicht verändern!)

Mögliche Werte: de.softproject.integration.adapter.antivirus.AntiVirusAdapter: Hauptklasse (Standard)

host

IP-Adresse oder Host-Name des ClamAV-Servers

Mögliche Werte:

  • Beliebige gültige Zeichenkette, z. B. localhost, 127.0.0.1

  • localhost: ClamAV Host (Standard)

port

Portnummer des ClamAV-Servers

Mögliche Werte:

  • Jede beliebige Ganzzahl (Integer)

  • 3310: FTP-Port (Standard)

scanTimeoutInMs

Wartezeit auf einen Scan in Millisekunden. 

Mögliche Werte:

  • Jede beliebige Ganzzahl (Integer). Der Standardwert ist  500.

  • Bei einem Wert von 0 wird kein Timeout gesetzt. Das kann zu unendlichen Wartezeiten führen.

  • Negative Werte werden ignoriert, und der Standardwert 500 wird verwendet.

Statuswerte

1

Der Adapter gibt ein Ergebnisdokument aus. Die Operation war erfolgreich, es wurden keine Viren gefunden oder die Eingabedatei ist leer.

-1

Der Adapter gibt die Eingabedatei aus. Die Operation konnte nicht ausgeführt werden. Details zur Fehlermeldung können den Server-Logs entnommen werden.

400

Der Adapter gibt ein Ergebnisdokument aus. Die Operation war erfolgreich, es wurden Viren in der Eingabedatei gefunden.

Input

Der Adapter erwartet jede Eingabedatei, sowohl Binärdateien als auch Base64-kodierte Dokumente (Text- oder XML-Dateien).

Output

Wenn die Operation fehlschlug, gibt der Adapter die Eingabedatei aus.

Wenn die Operation erfolgreich war, gibt der Adapter ein UTF-8-kodiertes XML-Ergebnisdokument der nachfolgenden Struktur aus. Wurden Viren gefunden, wird der Wert auf true gesetzt, sonst wird der Wert false ausgegeben. 

XML
<?xml version="1.0" encoding="UTF-8"?>
<ScanResult>
	<!--Der Wert true wird ausgegeben, wenn in der Eingabedatei Viren gefunden wurden-->
	<!--Der Wert false wird ausgegeben, wenn in der Eingabedatei keine Viren gefunden wurden-->
	<VirusFound><!--Wert--></VirusFound>
</ScanResult>


Abhängigkeiten und Installationshinweise

Dieser Adapter verwendet folgende Bibliotheken: ClamAV Bibliothek clamav-client-1.0.1.jar

Installation ClamAV

Für eine einwandfreie Funktion des Adapters muss der ClamAV-Server auf derselben Maschine wie die X4 BPMS installiert sein und laufen. Eine ausführliche Installationsbeschreibung und Anpassungen an den Konfigurationsdateien finden Sie in dem offiziellen ClamAV Handbuch (siehe Kapitel 4 und 5). 

Download Intallationspakete

Eine Auflistung der verfügbaren Installationspakete finden Sie auf der Website des Anbieters: https://www.clamav.net/downloads#otherversions

  • Download-Version mit Installationsassistent für Windows (32 bit): clamav-<version_number>-x86.zip

  • Download-Version mit Installationsassistent für Windows (64 bit): clamav-<version-number>-win-x64.zip

Aktualisierung der Virendatenbank

Die Einstellungen zur automatischen Aktualisierung der Virendatenbank sind in dem offziellen ClamAV Handbuch (siehe Kapitel 4) beschrieben.