Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
nClam allows you to scan files, directories, or streams for viruses with a ClamAV server using a simple API!
C#
branch: master

README.md

nClam Build status NuGet version

nClam is a library which helps you scan files or directories using a ClamAV server. It contains a simple API which encapsulates the communication with the ClamAV server as well as the parsing of its results. The library is licensed under the Apache License 2.0.

Dependencies

ClamAV Server, also known as clamd. It is a free, open-source virus scanner. Win32 ports can be obtained here: http://oss.netfarm.it/clamav/

NuGet Package

Install-Package nClam

Directions

  1. Add the nuget package to your project.
  2. Create a nClam.ClamClient object, passing it the hostname and port of the ClamAV server.
  3. Scan!

Code Example

using System;
using System.Linq;
using nClam;

class Program
{
    static void Main(string[] args)
    {

        var clam = new ClamClient("localhost", 3310);
        var scanResult = clam.ScanFileOnServer("C:\\test.txt");  //any file you would like!

        switch(scanResult.Result)
        {
            case ClamScanResults.Clean:
                Console.WriteLine("The file is clean!");
                break;
            case ClamScanResults.VirusDetected:
                Console.WriteLine("Virus Found!");
                Console.WriteLine("Virus name: {0}", scanResult.InfectedFiles.First().VirusName);
                break;
            case ClamScanResults.Error:
                Console.WriteLine("Woah an error occured! Error: {0}", scanResult.RawResult);
                break;
        }
    }
}

ClamAV Setup for Windows

For directions on setting up ClamAV as a Windows Service, check out this blog post.

Test Application

For more information about how to use nClam, you can look at the nClam.ConsoleTest project's Program.cs. The nClam.ConsoleTest console application takes a file path as an argument, and then uses nClam to scan the file using nClam's various Scan methods.

Something went wrong with that request. Please try again.