Documentation

You can view the documentation below, or browse our GitHub Repository, where you can contribute to FAQ Documents. For complete documentation, download the ClamAV Manual.

Introduction

Clam AntiVirus is an open source (GPLv2) anti-virus toolkit, designed especially for e-mail scanning on mail gateways. It provides a number of utilities including a flexible and scalable multi-threaded daemon, a command line scanner and advanced tool for automatic database updates. The core of the package is an anti-virus engine available in a form of shared library.

Features

Capabilities

  • ClamAV is designed to scan files quickly.
  • Real time protection (Linux only). Our scanning daemon supports on-access scanning on modern versions of Linux, including the ability to block file access until a file has been scanned.
  • ClamAV detects over 1 million viruses, worms and trojans, including Microsoft Office macro viruses, mobile malware, and other threats.
  • The built-in bytecode interpreter allows the ClamAV signature writers to create and distribute very complex detection routines and remotely enhance the scanner’s functionality.
  • Signed signature databases ensure that ClamAV will only execute trusted signature definitions.
  • ClamAV scans within archives and compressed files but also protects against archive bombs. Built-in archive extraction capabilities include:
    • Zip (including SFX)
    • RAR (including SFX)
    • 7Zip
    • ARJ (including SFX)
    • Tar
    • CPIO
    • Gzip
    • Bzip2
    • DMG
    • IMG
    • ISO 9660
    • PKG
    • HFS+ partition
    • HFSX partition
    • APM disk image
    • GPT disk image
    • MBR disk image
    • XAR
    • XZ
    • MS OLE2
    • MS Cabinet Files (including SFX)
    • MS CHM (Compiled HTML)
    • MS SZDD compression format
    • BinHex
    • SIS (SymbianOS packages)
    • AutoIt
    • InstallShield
  • Supports Windows executable file parsing, also known as Portable Executables (PE) both 32/64-bit, including PE files that are compressed or obfuscated with:
    • AsPack
    • UPX
    • FSG
    • Petite
    • PeSpin
    • NsPack
    • wwpack32
    • MEW
    • Upack
    • Y0da Cryptor
  • Supports ELF and Mach-O files (both 32- and 64-bit)
  • Supports almost all mail file formats
  • Support for other special files/formats includes:
    • HTML
    • RTF
    • PDF
    • Files encrypted with CryptFF and ScrEnc
    • uuencode
    • TNEF (winmail.dat)
  • Advanced database updater with support for scripted updates, digital signatures and DNS based database version queries

License

ClamAV is licensed under the GNU General Public License, Version 2.

Supported platforms

Clam AntiVirus is highly cross-platform. The development team cannot test every OS, so we have chosen to test ClamAV using the two most recent Long Term Support (LTS) versions of each of the most popular desktop operating systems. Our regularly tested operating systems include:

  • GNU/Linux
    • Ubuntu
      • 16.04
      • 18.04
    • Debian
      • 7
      • 8
    • CentOS
      • 6
      • 7
  • UNIX
    • Solaris
      • 11
    • FreeBSD
      • 10
      • 11
    • macOS
      • 10.13 (High Sierra)
      • 10.14 (Mojave)
  • Windows
    • 7
    • 10

The following minimum recommended system requirements are for using clamscan or clamd and clamdscan binaries with the standard ClamAV signature database provided by Cisco.

Minimum recommended RAM:

  • FreeBSD and Linux server edition: 1 GiB+
  • Linux non-server edition: 2 GiB+
  • Windows 7 & 10 32-bit: 2 GiB+
  • Windows 7 & 10 64-bit: 3 GiB+
  • macOS: 3 GiB+

Minimum recommended CPU:

  • FreeBSD and Linux systems: 1 CPU 2.0 Ghz+
  • Windows 7 & 10: 1 CPU 2.0 Ghz+
  • OSX: 2 CPUs at 2.0 Ghz+

Minimum available hard disk space required:

For the ClamAV application we recommend having 5 GB of free space available. This recommendation is in addition to the recommended disk space for each OS.

Please note: The tests to determine these minimum requirements were performed on systems that were not running other applications. If other applications are being run on the system, additional resources will be required in addition to our recommended minimums.

Mailing lists and IRC channel

If you have a trouble installing or using ClamAV try asking on our mailing lists. There are four lists available:

  • clamav-announce (at) lists.clamav.net
    • info about new versions, moderated.
    • Subscribers are not allowed to post to this mailing list.
  • clamav-users (at) lists.clamav.net
    • user questions
  • clamav-devel (at) lists.clamav.net
    • technical discussions
  • clamav-virusdb (at) lists.clamav.net
    • database update announcements, moderated

You can subscribe and search the mailing list archives here.

Alternatively you can try asking on the #clamav IRC channel - launch your favourite irc client and type:

    /server irc.freenode.net
    /join #clamav

Submitting New or Otherwise Undetected Malware

If you’ve got a virus which is not detected by the current version of ClamAV using the latest signature databases, please submit the sample for review at our website:

https://www.clamav.net/reports/malware

Likewise, if you have a benign file that is flagging as a virus and you wish to report a False Positive, please submit the sample for review at our website:

https://www.clamav.net/reports/fp