Information for: DEVELOPERS   PARTNERS   SUPPORT

Enabling virus scanning for file uploads

You can enable virus scanning of file uploads for your Cloud Platform applications. Cloud Platform virus scanning uses ClamAV, an open source antivirus engine. Cloud Platform updates the ClamAV virus definitions daily. After you enable virus scanning, ClamAV protects your application from viruses uploaded by form file uploads and prevents uploaded files from being saved if it detects a virus.

To enable virus scanning, using ClamAV, for file uploads to your website, install, enable, and configure the ClamAV module, which connects to the ClamAV executable on your Cloud Platform infrastructure.

Note

Cloud Platform does not include or support the use of ClamAV as a daemon.

Configuring the ClamAV module

The ClamAV module (available for Drupal 7 and Drupal 9) connects with ClamAV to scan files uploaded with CCK’s filefield widget, CCK’s imagefield widget, and normal Drupal form file uploads.

To configure the ClamAV module:

  1. In Configuration, select ClamAV.
  2. In Scan method, select Executable.
  3. In Executable mode configuration, in the Executable path field, enter /usr/bin/clamscan.
  4. In Verbosity, select the verbose checkbox.
  5. Click Save configuration.

ClamAV thereafter scans all files uploaded to your application for viruses. If ClamAV finds a virus, it displays a message to the user reporting that the file could not be uploaded, and then logs the event to stdout and stderr, with the file name and virus name. You can then find the entry in the Acquia Cloud drupal-watchdog.log.

Note

Clamscan does not scan the database because it does not read binary data.

Even with a regular scan, malware may exist in the database or in your /tmp directory.

Scanning files that are already present

If you have uploaded files to your application using methods that differ from the normal Drupal upload methods, you can still use ClamAV to scan these files. Since this method uses CPU resources, Acquia recommends that you copy the files to your development or staging environment and scan files there, rather than in production. To scan files on your infrastructure, open a command prompt window and enter the following command:

clamscan -ri

The r parameter causes ClamAV to scan all files recursively, in the current directory and subdirectories, and the i parameter displays only the infected files, if any.

You can also use the following cron command to run regular scans for your website:

--any--  0 * * * *   /usr/bin/clamscan -ri /mnt/tmp/ | mail -s "hourly website clam results" [email protected]

This command scans files if run in /sites/default/files. To scan code, the command must be run from the code directory.

For a more configurable and extensible version of this command, you can download and use the clam_av_script.sh.inc script, which provides configurable notification emails, in a cron command.

If you have uploaded files to your application using methods that differ from the normal Drupal upload methods, you can still use ClamAV to scan these files. To scan files on your infrastructure, open a command prompt window and enter the following command:

clamscan <file_path>

The preceding command scans the file specified as input and returns scan results.

clamscan -i <folder_path>

ClamAV scans all files recursively in the directory path provided as input in the preceding command and subdirectories. Use i parameter to display only the infected files, if any.

For more information on creating cron commands that perform regular scans for your website, see Creating scheduled jobs.

Note

The system does not support executable parameters and displays the following warning message in the CLI:

WARNING: Ignoring unsupported option --recursive (-r)