Configure anti-virus scanning for imported files

You can use Clam AntiVirus (ClamAV) to scan files for viruses and malware before the files are imported into OpenPages®. Files that fail the scan are not uploaded.

ClamAV is an open source, cross-platform, anti-virus toolkit. ClamAV is the only anti-virus software that is supported by OpenPages for the scanning of files.

ClamAV has the following features:

  • It is available for Linux®, Windows, Mac OS X, and Docker.
  • The ClamAV virus database is frequently updated.
  • It supports many file formats.

For more information about ClamAV, see the ClamAV documentation at https://docs.clamav.net/.

Before you begin

A ClamAV server is not provided with an OpenPages installation. You must install ClamAV on a server that OpenPages can access.

About this task

To ensure that files are scanned before they are uploaded, you must specify the ClamAV server and port and you must enable anti-virus scanning.

File uploads are not affected when anti-virus scanning is disabled.

You can configure OpenPages to perform the following tasks:
  • Block all uploads if the anti-virus server is unreachable.
  • Time out when an anti-virus scan request to the remote server has not been answered after a set number of milliseconds.
  • Only scan files up to a set maximum size.
  • Perform a set number of retry attempts when a file is being scanned.

Procedure

  1. Click Open Administration menu Administration menu > System Configuration > Settings.
  2. Set Platform > Security > Antivirus Scan > Enabled to true.
  3. Set Platform > Security > Antivirus Scan > ClamAV Server to the hostname or IP address where the ClamAV server is located.
    The default value is http://localhost.
  4. Set Platform > Security > Antivirus Scan > ClamAV Port to the port number of the ClamAV server.
    The default value is 3310.
  5. Optional: To block all files from being uploaded if the ClamAV server is unavailable, set Platform > Security > Antivirus Scan > Block Uploads if Unreachable to true.
    The default value is false.
  6. Optional: To specify a timeout for anti-virus scan requests to the remote server, set Platform > Security > Antivirus Scan > ClamAV Timeout to a value in milliseconds. A value of 0 means the request will not time out.
    The default value is 5000.

    You might need to increase this value if you are importing complex files, such as compressed files, that are bigger than 100 MB.

  7. Optional: To specify a maximum size of file for scanning, set Platform > Security > Antivirus Scan > Maximum File Size to a size in MiB. A value of 0 means there is no maximum.
    When you set this value to be greater than 0, larger files are skipped.

    The default value is 0.

  8. Optional: To specify the number of retry attempts to make when scanning a file, set Platform > Security > Antivirus Scan > Retry Attempts to an integer value.
    The default value is 3.

    You might need to increase the number of retry attempts if you are importing complex files, such as compressed files, that are bigger than 100 MB.