LATEST VERSION: 1.3 - CHANGELOG
ClamAV Add-on for PCF v1.2

ClamAV Add-on for PCF

Page last updated:

This topic describes how to add ClamAV to your Pivotal Cloud Foundry (PCF) deployment.

About ClamAV Add-on for PCF

This add-on may be necessary for regulatory purposes if your compliance auditor requires antivirus protection within the PCF environment. For example, auditors sometimes expect that antivirus protection be present in an environment that must comply with standards such as Payment Card Industry Data Security Standard (PCI DSS) or Health Insurance Portability and Accountability Act (HIPAA).

Prerequisites

Note: ClamAV Add-on for PCF does not work on Windows.

To complete the ClamAV Add-on installation:

  • You must be a PCF operator with admin rights. For more information, see Understanding Pivotal Cloud Foundry User Types.

  • You must have Pivotal Operations Manager (Ops Manager) v1.7 or later.

  • ClamAV Add-on uses 610 MB of memory. Ensure you have at least 1 GB of memory free on each VM before deploying ClamAV Add-on.

  • You must set up a local mirror to get ClamAV virus updates. For instructions on how to set up a local mirror, see Private Local Mirrors in the ClamAV documentation.

Create the ClamAV Manifest

The ClamAV manifest is a YML file that contains runtime configuration information for ClamAV Add-on. Follow the steps below to create the ClamAV manifest for your deployment:

  1. Create a file named clamav.yml, using the following code as a template.

    releases:
    - name: clamav 
      version: 1.0.0
    addons:
    - name: clamav
      jobs:
      - name: clamav
        release: clamav
      properties:
        clamav:
          database_mirror: 192.0.2.1
    

  2. (Required) Provide the hostname or IP address of a private ClamAV update mirror. Environments that cannot connect to the internet normally use an update mirror. If you do not specify a value, ClamAV defaults to an S3-based mirror for updates. For compliance reasons, only use the S3-based mirror in non-production environments. For how to set up a local mirror, see Private Local Mirrors.

  3. (Optional) If you have to use a proxy server to connect to the internet, do the following:

    • Add the proxy_host and proxy_port properties.
    • If the proxy server needs authentication, add proxy_user and proxy_password properties.

    Replace the example text shown in bold:

    releases:
    - name: clamav
      version: 1.1.1
    addons:
    name: clamav
      jobs:
        - name: clamav
          release: clamav
      properties:
        clamav:
          on_access: no
          scheduled: yes
          proxy_host: proxy.localdomain
          proxy_port: 3128
          proxy_user: clamav
          proxy_password: secret
    ...
    

Download and Deploy ClamAV Add-on

  1. Download ClamAV Add-on software binary from the Pivotal Network to your local machine.

  2. Copy the software binary to your Ops Manager virtual machine (VM).

    $ scp -i PATH/TO/PRIVATE/KEY clamav-release.tar.gz ubuntu@YOUR-OPS-MANAGER-VM-IP:

  3. Copy the ClamAV manifest, clamav.yml file, to your Ops Manager instance.

    $ scp -i PATH/TO/PRIVATE/KEY clamav.yml ubuntu@YOUR-OPS-MANAGER-VM-IP:

  4. SSH into Ops Manager.

    $ ssh -i PATH-TO-PRIVATE-KEY ubuntu@YOUR-OPS-MANAGER-VM-IP

  5. On the Ops Manager VM, navigate to the software binary location.

    $ cd PATH-TO-BINARY

If you are using PCF v1.11 or later, follow the BOSH CLI v2 procedures to deploy the ClamAV Add-on.

If you are using PCF v1.10 or earlier, follow the BOSH CLI v1 procedures to deploy the ClamAV Add-on.

Deploy the ClamAV Add-on with the BOSH CLI v2

  1. On the Ops Manager VM, create an alias in the BOSH CLI for your Ops Manager Director IP address. For example:
    $ bosh2 alias-env my-env -e 10.0.0.3
    
  2. Log in to the BOSH Director, specifying the newly created alias. For example:
    $ bosh2 -e my-env log-in
    
  3. Upload your release, specifying the path to the tarballed ClamAV binary. For example:
    $ bosh2 -e my-env upload-release clamav-release.tar.gz
    
  4. List the releases and confirm that ClamAV appears. For example:
    $ bosh2 -e my-env releases
    
  5. Update your runtime configuration to include ClamAV, specifying the path to the clamav.yml file you created above. For example:

    Note: If you installed other BOSH add-ons, you must merge the ClamAV manifest into your existing add-on manifest. Append the contents of clamav.yml to your existing add-on YML file.

    $ bosh2 -e my-env update-runtime-config clamav.yml
  6. Verify that your runtime configuration changes match what you specified in the ClamAV manifest. For example:
    $ bosh2 -my-env runtime-config
    Acting as user 'admin' on 'micro'
    releases:
    - name: clamav
        version: 1.0.0
    
    addons: name: clamav jobs: - name: clamav release: clamav ...
  7. Navigate to your Installation Dashboard in Ops Manager.
  8. Click Apply Changes.

Deploy the ClamAV Add-on with the BOSH CLI v1

  1. On the Ops Manager VM, target your BOSH director instance.

    $ bosh target YOUR-OPS-MANAGER-DIRECTOR-IP
    Target set to 'Ops Manager'
    Your username: director
    Enter password: ******************
    Logged in as 'director'
    

  2. Upload your release.

    $ bosh upload release PATH-TO-BINARY/BINARY-NAME.tar

  3. From the command line, confirm that the upload of the ClamAV software binary completed. You should see the ClamAV release.

    $ bosh releases

  4. Update your runtime configuration to include ClamAV.

    Note: If you installed other BOSH add-ons, you must merge the ClamAV manifest into your existing add-on manifest. Append the contents of clamav.yml to your existing add-on YML file.

    $ bosh update runtime-config PATH/YOUR-ADD-ON-YML.yml
  5. Verify your runtime configuration changes match what you specified in the ClamAV manifest.

    $ bosh runtime-config
    Acting as user 'admin' on 'micro'
    releases:
    - name: clamav
      version: 1.0.0
    
    addons: name: clamav jobs: - name: clamav release: clamav ...

  6. Navigate to your Installation Dashboard in Ops Manager.

  7. Click Apply Changes.

Configure Forwarding for ClamAV Alerts

The ClamAV BOSH release writes all alerts to the syslogs of the VMs in your deployment. You can use syslog forwarding to forward the alerts to a syslog aggregator.

  • Using the Elastic Runtime tile: Follow the steps to Configure System Logging in the Elastic Runtime tile. The syslog aggregator that you specify receives all alerts generated on Elastic Runtime VMs, including the ClamAV alerts.
  • Using the BOSH syslog release: You can use the syslog BOSH release to forward system logs. For instructions, see the syslog-release.

Note: When you configure syslog forwarding, ensure enough disk space for the logs. Make sure that log rotation is frequent enough. If in doubt, rotate the logs hourly or when they reach a certain size. Pivotal recommends forwarding logs to a remote syslog aggregation system.

Verify Your ClamAV Add-on Installation

  1. BOSH ssh into one of the VMs in your deployment.

  2. Run monit summary. Look for the following processes in the output:

    The Monit daemon 5.2.4 uptime: 3d 0h 56m
    Process 'clamd'                     running
    Process 'freshclam'                 running
  3. If monit summary does not list freshclamd and clamd, perform the following steps:

    1. Try to start the ClamAV processes by running the following commands:
      $ monit start clamd
      $ monit start freshclam
      
    2. Run monit summary again. If you do not see the processes mentioned above, check /var/vcap/sys/log/clamav logs for errors.
  4. If monit summary does list freshclamd and clamd, create a file on the VM with the following contents:

    X5O!P%@AP[4\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*
    

    This is a virus signature used to test anti-virus software.

After clamdscan completes, a notification should appear in /var/log/syslog.

ClamAV Log Format

ClamAV log format is unstructured. On virus detection, the following text is sent to syslog:

Jul 11 17:36:35 k2lam76scmb clamd[3022]: SelfCheck: Database status OK.
Jul 11 17:42:34 k2lam76scmb clamd[3022]: /bin/infected-file: Eicar-Test-Signature FOUND

The logline can be generalized as follows:

clamd[PID]: <infected-file-path>: <virus name> FOUND

Enable On-Access Scan

ClamAV offers immediate file scanning upon file modification. This feature might reduce the time it takes to detect and report malware. Enable the feature through the on_access runtime config property, as follows.

  1. In the clamav.yml file, add the on_access property under the clamav property, set on_access to yes:

    releases:
    - name: clamav
      version: 1.1.1
    
    addons: name: clamav jobs: - name: clamav release: clamav properties: clamav: on_access: yes scheduled: yes ...

  2. Apply this configuration change by following the instructions from step 9, Update your…, in the Download and Deploy ClamAV Add-on section above.

Disable Scheduled Scan

By default, ClamAV runs a virus scan every hour. You can disable the scan, but you cannot change the frequency.

To disable the scheduled scan, follow the steps below.

  1. In the runtime-config, set the property scheduled to no

  2. Apply the changes.

Choose the Action on Infected Files

You can configure ClamAV to take action when infected files are found. By default, a notification is sent to the syslog when an infected file is found. However, you can specify other actions, as listed in step 2 below.

  1. In the clamav.yml file, add the action property under the clamav property and, optionally, the action_destination property:

    releases:
    - name: clamav
      version: 1.1.7
    
    addons: name: clamav jobs: - name: clamav release: clamav properties: clamav: action: ACTION action_destination: PATH ...

  2. Replace ACTION with one of the following values:

    • notify — The default, only send a notification to syslog
    • remove — Delete the infected file from the filesystem
    • move — Move the infected file to the directory location specified by action_destination
    • copy — Copy the infected file to the directory location specified by action_destination

    If you don’t supply an action, the function fails.

  3. Replace PATH with the directory location where you want the infected files moved or copied to.

    The system does not scan the moved-to or copied-to location. If the directory path is not valid, the function fails.

Example configuration:

  releases:
  - name: clamav
      version: 1.1.7
  
addons: name: clamav jobs: - name: clamav release: clamav properties: clamav: action: move action_destination: /var/vcap/data/clamav/found ...

Create a pull request or raise an issue on the source for this page in GitHub