ExClamav

ExClamav is an Elixir library providing native bindings to the ClamAV antivirus engine. It enables Elixir applications to scan files and data buffers for viruses and malware using ClamAV's robust detection capabilities.

This library is intended for developers who need to integrate virus scanning into their Elixir projects, such as file upload services, content moderation pipelines, or any system where security and malware detection are required. ExClamav offers both low-level access to the ClamAV engine and convenient helper functions for common scanning tasks.

Installation

If available in Hex, the package can be installed by adding ex_clamav to your list of dependencies in mix.exs:

def deps do
  [
    {:ex_clamav, "~> 0.1.5"}
  ]
end

Install ClamAV development libraries

# Ubuntu/Debian
sudo apt-get install libclamav-dev clamav

# RHEL/CentOS
sudo yum install clamav-devel clamav

# macOS
brew install clamav

Usage

# Initialize library
:ok = ExClamav.Engine.init()

# Create an engine
{:ok, engine} = ExClamav.new_engine()

# Load database
{:ok, signatures} = ExClamav.Engine.load_database(engine, "/var/lib/clamav")
# => {:ok, 1234567}

# Compile engine
:ok = ExClamav.Engine.compile(engine)

# Scan a file
case ExClamav.Engine.scan_file(engine, "/path/to/file") do
  {:ok, :clean} ->
    IO.puts("File is clean")
    
  {:ok, :virus, virus_name} ->
    IO.puts("Virus found: #{virus_name}")
    
  {:error, reason} ->
    IO.puts("Error: #{reason}")
end

# Scan a buffer
data = File.read!("/path/to/file")
case ExClamav.Engine.scan_buffer(engine, data) do
  {:ok, :clean} -> IO.puts("Buffer is clean")
  {:ok, :virus, name} -> IO.puts("Found #{name}")
end

# Quick scan using helper function
case ExClamav.scan_file("/path/to/file") do
  {:ok, :clean} -> :safe
  {:ok, :virus, name} -> {:virus, name}
  {:error, reason} -> {:error, reason}
end

# Check if file is clean
if ExClamav.Engine.clean?(engine, "/path/to/file") do
  IO.puts("File is safe to use")
end

# Get versions
ExClamav.version()
ExClamav.Engine.get_database_version(engine)

# Clean up
ExClamav.Engine.free(engine)

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/ex_clamav.