X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Antivirus

This adapter connects to a ClamAV server, an open source (GPL) antivirus engine. Input files are checked for viruses at adapter runtime.

Properties

Operation

Defines the operation executed by the adapter

Possible values: Scan: Check input files for viruses

Parameters

host

IP address or host name of the ClamAV server.

Possible values:

  • any valid string, e. g. localhost, 127.0.0.1

  • localhost: ClamAV host (default)

port

Port number of the ClamAV server

Possible values:

  • any integer number

  • 3310: FTP port (default)

scanTimeoutInMs

Waiting time for a scan in milliseconds. 

Possible values:


    • Any integer number. The default value is 500.

  • A value of 0 does not set a timeout. Please be aware that this may lead to infinite wait times.

  • Negative values will be ignored and the default value of 500 will be used.

Status values

1

The adapter outputs a result document. The operation was successful, no viruses were found or the input file is empty.

-1

The adapter outputs the input file. The operation could not be executed. Details of the error message can be found in the server logs.

400

The adapter outputs a result document. The operation was successful, viruses were found in the input file.

Input

The adapter expects any input file, both binary files and Base64-encoded documents (text or XML files).

Output

If the operation failed, the adapter outputs the input file.

If the operation was successful, the adapter outputs a UTF-8-encoded XML result document of the following structure. If viruses have been found, the value is set to true, otherwise the value is set to false.

XML
<?xml version="1.0" encoding="UTF-8"?>
<ScanResult>
	<!--The value true is output if viruses were found in the input file-->
	<!--The value false is output if no viruses were found in the input file-->
	<VirusFound><!--value--></VirusFound>
</ScanResult>


Dependencies and Setup instructions

This adapter uses the following libraries: ClamAV library clamav-client-1.0.1.jar

Setup ClamAV

For the adapter to work properly, the ClamAV server must be installed and running on the same machine as the X4 BPMS. A detailed installation description and adjustments to the configuration files can be found in the official ClamAV manual (see chapters 4 and 5). 

Download setup packages

A list of available installation packages can be found on the provider's website: https://www.clamav.net/downloads#otherversions

  • Download version with setup wizard for Windows (32 bit): clamav-<version_number>-x86.zip

  • Download version with setup wizard for Windows (64 bit): clamav-<version-number>-win-x64.zip

Updating the virus database

The settings for automatically updating the virus database are described in the official ClamAV manual (see chapter 4).