Configure Antivirus in Mattermost with ClamAV

The ClamAV antivirus application is a popular, open-source security application for various use cases. It’s great for desktop operating system security, VPS antivirus solutions, and even connecting to web applications with file sharing capabilities.

By connecting ClamAV Antivirus with Mattermost, all files are scanned for malicious signatures before being uploaded to Mattermost. You can connect to a ClamAV instance on a local or remote server. You simply need to ensure the instance accepts remote requests for virus scans.

The Antivirus Mattermost plugin is not available for Mattermost Cloud at this time.

• Install the Antivirus Mattermost Plugin
  • Mattermost Marketplace
  • Manual Upload with System Console
  • Manual Upload with FTP or SSH
• Integrating ClamAV Antivirus with Mattermost
  • Configure ClamAV
  • Configure Antivirus in Mattermost
• Prevent Malicious Mattermost Downloads
  • ClamAV Testing with the EICAR Standard Antivirus Test String
  • Scanning Mattermost Uploads

Install the Antivirus Mattermost Plugin

There are three ways to install plugins in the Mattermost app.

We recommend notifying teammates before enabling the plugin. If you enable the plugin now, users will not be able to upload media until you successfully configure ClamAV.

Mattermost Marketplace

1. Visit your Mattermost domain and login. Ensure that the user you login as has Mattermost system admin privileges.
2. In the upper-left corner, select your username, then Marketplace.
3. Beside Antivirus, select Install.
4. Beside Antivirus, select Configure.
5. Leave the configuration page for the Antivirus plugin open while you configure ClamAV below.

Manual Upload with System Console

1. Download the compressed plugin file from Mattermost.com/Marketplace. If you’re redirected to GitHub, select Releases on the right. Then select the antivirus-x.x.x.tar.gz file for the latest release under Assets.
2. Visit your Mattermost domain and login. Ensure that the user you login as has Mattermost system admin privileges.
3. In the upper-left corner, select your username, then System Console.
4. On the left, select Plugin Management.
5. Beside Upload Plugin, select Choose File.
6. Select the compressed (tar.gz) plugin file from your computer.
7. Select Upload. Then you should see a notice stating “Successfully uploaded plugin [plugin name].”
8. Leave the configuration page for the Antivirus plugin open while you configure ClamAV below.

Manual Upload with FTP or SSH

This method requires root FTP or SSH access to your server.

1. Download the Mattermost Antivirus plugin from Mattermost.com/Marketplace.
2. Upload the compressed file to your server with FileZilla (or another FTP program) or SCP (if using SSH).
3. Extract the plugin to your plugins directory:

   tar -xvzf filename.tar.gz -C /opt/mattermost/plugins

   To search for your plugins directory, run:

   find / -wholename *mattermost/plugins 

4. Visit your Mattermost domain and login. Ensure that the user you login as has Mattermost system admin privileges.
5. In the upper-left corner, select your username, then System Console.
6. On the left, select Plugin Management.
7. Leave the configuration page for the Antivirus plugin open while you configure ClamAV below.

Integrating ClamAV Antivirus with Mattermost

Carefully read the following sections as certain steps may not apply to you for connecting ClamAV Antivirus with Mattermost.

Configure ClamAV

Next, you need to configure your ClamAV installation to listen for requests from a specific port number. If you’ll be integrating ClamAV from a remote server that’s already configured to listen on a specific port, ensure you know the port number and continue to the next section: Configure Antivirus in Mattermost. If you’re not sure if the remote server is already configured, or what the port number is, follow the steps below.

1. Ensure ClamAV is installed on your server. For cPanel servers, search for ClamAV from cPanel or WebHost Manager (WHM). On cloud and bare metal dedicated servers, run the following command in Secure Shell (SSH):

   clamscan -V

   If it is not installed, we have guides on how to install ClamAV on cPanel servers and Ubuntu.
2. Log into SSH as root. cPanel users can log into WHM Terminal instead.
3. Edit your ClamAV configuration file.
   For cPanel servers:

   nano +107 /user/local/cpanel/3rdparty/etc/clamd.conf

   For non-cPanel servers:

   nano +107 /etc/clamav/clamd.conf

   If the file is not located in the default locations above, search for the Clamd file with the following command:

   find / -name clamd.conf

4. Remove the “#” before TCPSocket 3310 to enable listening for scan requests on port 3310.

   

5. (Optional) Change the port number to another unused port if 3310 is already in use or otherwise desired. You can test this quickly by browsing to your server hostname followed by “:3310” (or another potential open port number) in a web browser (e.g. example.com:3310). You may need to check with your hosting provider to learn which ports you can use. You cannot use 8065 as it is the default Mattermost port.
6. Ensure port 3310 (or other specified port) is permanently open in your firewall – ConfigServer Security & Firewall (CSF), Firewalld, UncomplicatedFirewall (UFW), etc.
7. Restart Apache.
   cPanel and CentOS servers:

   systemctl restart httpd

   Debian/Ubuntu:

   systemctl restart apache2

   cPanel administrators can restart Apache using WHM.
   
   Afterwards, your remote server will be capable of executing remote scan requests.

Configure Antivirus in Mattermost

Enable and configure ClamAV Antivirus with Mattermost.

1. Open your Mattermost Antivirus configuration page from the plugin installation process. Or reopen System Console, then Antivirus.
2. Change Enable Plugin to true.
3. Change ClamAV – Host and Port to “localhost:3310” if ClamAV is on the same server. If using a remote server, replace “localhost” with the other specified ClamAV hostname and port number.
4. Change the Scan Timeout (seconds) from 10 seconds if desired.
5. Save changes.

Prevent Malicious Mattermost Downloads

After configuring the Mattermost plugin, you need to test your settings to ensure everything works as expected.

ClamAV Testing with the EICAR Standard Antivirus Test String

European Institute for Computer Anti-Virus Research (EICAR) is an organization dedicated to cybersecurity and trusted by some of the most popular AV solution vendors including McAfee, Kaspersky, and Trend Micro. EICAR has a test file free to use for testing antivirus software. The text string will create a false positive response (falsely states a virus is present) in the scanner but is not malicious. The text string was registered specifically for testing AV solutions.

1. Create a text (.txt) file on your local computer with Notepad or a similar program.
2. Visit the antivirus test website: https://www.eicar.org/?page_id=3950.
3. Add the text string from the bottom of the EICAR page to the new text file. It will resemble this:

   

4. Save and close the file.
5. In a Mattermost channel, select the attachment icon beside the text box. Try to upload the text file.
   
   It shouldn’t upload but prompt an error at the bottom:
   “Unable to upload file [file-name].txt. Rejected by plugin: The antivirus service did not allow you to attach this file.”

Scanning Mattermost Uploads

Attempt to upload a regular file. Mattermost should scan the file, then allow you to send your message without any error. If you’re able to send a message with a regular file, congratulations integrating ClamAV Antivirus with Mattermost. If you encounter an error, check your Clamd configuration file or contact us for additional Mattermost support. Congrats on integrating ClamAV Antivirus with Mattermost.

Learn more server administration tasks from our Cloud Server Hosting Product Guide.