Page tree
Skip to end of metadata
Go to start of metadata

You can configure FileCloud to scan uploaded files using ClamAV, an open source antivirus software that is included with FileCloud.

ClamAV is available for:

  • Windows 
  • Linux

When a virus is detected in an uploaded file, the following actions occur:

  1. The incoming file is deleted.
  2. An alert will be displayed in the Admin Portal.
  3. A toast will be displayed in the User Portal.
  4. An entry will be added in the audit log about virus detection in the file and subsequent deletion of the file.

To Use ClamAV


(lightbulb) In the following section, to display more information, click on a step.


 1. Install ClamAV in Ubuntu

These instructions are for Ubuntu Linux, but they can be used for other Linux systems using equivalent commands.


To install ClamAV in Ubuntu:

  1. Install the ClamAV package

    sudo apt-get install clamav-daemon
    
  2. You might need to run 'freshclam' to update the antivirus database files

    sudo freshclam
    
  3. Update the ClamAV-Daemon mode to use TCP, by running the sudo dpkg-reconfigure clamav-base

    sudo dpkg-reconfigure clamav-daemon     
    
  4. In the reconfigure wizard, choose Socket Type TCP and Interface as localhost to listen to.


  5. After reconfigure finishes, verify the clamd.conf file is setup correctly (/etc/clamav/clamd.conf)  

    NOTE: TCPAddr localhost may not work. You can enter the filecloud URL in place of TCPAddr to make it work

    TCPSocket 3310
    TCPAddr localhost
    StreamMaxLength 100M  
    
  6. Additional commands for Ubuntu 16

    #The Socket Configuration changes are also required as below:
    
    
    #Edit the file /etc/systemd/system/clamav-daemon.service.d/extend.conf
    
    [Socket]
    SocketUser=clamav
    ListenStream=/var/run/clamav/clamd.ctl
    SocketGroup=clamav
    SocketMode=666
    ListenStream=xx.xx.xx.xx:3310
    
    
    # Note that xx.xx.xx.xx = IP address of server or 127.0.0.1
    
    
    #After that run:
    
    
    systemctl --system daemon-reload
    systemctl restart clamav-daemon.service
  7. Start ClamAV-Daemon

sudo /etc/init.d/clamav-daemon start

OR

 1. Install ClamAV on Windows
  • The native ClamAV version does not have a GUI.
  • The virus database definition can be updated using freshclam using a Windows task scheduler. 

To install ClamAV on Windows:

  1. Download the latest version of the ClamAV installer from:
    http://www.clamav.net/downloads/production/ClamAV-0.103.1.exe

  2. Install ClamAV by running the ClamAV-0.103.1.exe installer file.

  3. Download the nssm Service Manager from:
    https://patch.codelathe.com/tonidocloud/live/3rdparty/nssm/nssm.zip 
  4. Unzip the nssm folder and move the nssm folder to the C:\ drive or, if you are installing ClamAV in the FileCloud Server, to the C:\xampp folder.
  5. Navigate to the nssm folder in the command line and run the following command:

    C:\nssm>nssm install ClamD

    The nssm service install tool window opens:


  6. To install the service, select the clamd.exe file path in Application Path and click Install Service.
  7. Copy clamd.conf.sample and freshclam.conf.sample from C:\Program Files\ClamAV\conf_examples to C:\Program Files\ClamAV, and rename them clamd.conf and freshclam.conf
  8. In clamd.conf and freshclam.conf, comment out the line beginning with Example.
  9. If ClamAV is installed on a server other than the FileCloud server, bind the IP address of the server in clamd.conf by changing the IP address for TCPAddr.
  10. To update the ClamD database, enter:

    cd C:\Program Files\ClamAV
    freshclam.exe


    The console response should appear similar to:

  11. Start the service ClamD from Windows Services.

  12. Verify the service is running and bind it to the localhost IP address or the IP address of the ClamAV server by running the following command:

    netstat -ano |findstr 3310

  

 2. Integrate ClamAV with FileCloud

Once ClamAV is setup and started, the next step is to add details of the ClamAV service to FileCloud server.

To integrate ClamAV with FileCloud:

  1. Open a browser, log in to the Admin Portal, and from the left navigation panel, click Settings.
  2. On the Manage Settings  screen, select the Third Party Integrations tab.
  3. On the Third Party Integrations  tab, select the Anti-Virus sub-tab.
  4. On the Anti-Virus sub-tab, in Anti-Virus Type, select Clam AV.
  5. Select the Clam AV  sub-tab.
  6. On the Clam AV  tab, select the checkbox for Enable ClamAV Scan.
  7. Enter the following information:  

    SettingDescription
    Enable ClamAV ScanCheck this setting to enable AV scanning
    ClamAV Host

    Enter the URL or IP of the system where Clam AV is running. This can be local or remote system.

    ClamAV PortThe port used by ClamAV (This is set when ClamAV is installed in the previous section)
    Skip scanning for files greater thanThis is the file limit in bytes that will be scanned. For example, very large files can be excluded from scanning. Default value is 25MB
    Stream Chunk SizeThis is a advanced setting used to stream the file content to ClamAV for scanning. Default is 8KB.
  8. Click Save.

  9. To verify connectivity, click the ClamAV Test button.


Once the ClamAV configuration is set up, every file uploaded to FileCloud will be scanned before being added to FileCloud storage.
  • If a file fails AV check (i.e. a virus detected) then the file will be deleted and an entry will be added to the Audit log with the details of the file.

If scanning fails

If scanning fails because the ClamAV server is down, a message appears on your screen, and your Manage Alerts page displays the warning:
Unable to communicate with ClamAV Server. Check immediately.

By default, if ClamAV fails to scan a file because the ClamAV server is down, the file is not deleted.

To automatically delete files if ClamAV scan fails because the ClamAV server is unavailable:

  1. Open the configuration file:
    Windows: XAMPP DIRECTORY/htdocs/config/cloudconfig.php
    Linux: /var/www/config/cloudconfig.php
  2. Add the line:

    define("TONIDOCLOUD_CLAMAV_DELETE_ON_SCAN_FAIL", "1");

    Now, when scan fails, the file is deleted, and the audit log displays the message: ClamAV removed [FILE_PATH] due to scan fail.

    If TONIDOCLOUD_CLAMAV_DELETE_ON_SCAN_FAIL is enabled and the CLAMAV server is not available, FileCloud does not allow files to be uploaded.

  • No labels