ClamClient.Net 1.0.0

ClamClient.Net

Async .NET client library for ClamAV (clamd) with TCP and Unix socket support.

Features

• Scan files and arbitrary byte streams via INSTREAM
• TCP and Unix domain socket endpoints
• Full async/await with CancellationToken support
• Microsoft DI integration (AddClamClient)
• No external runtime dependencies beyond Microsoft.Extensions.DependencyInjection.Abstractions

Requirements

• .NET Standard 2.0 or .NET 8+
• A running clamd daemon

Quick way to get a daemon running locally:

docker run -p 3310:3310 clamav/clamav:latest

Installation

dotnet add package ClamClient.Net

Quick start

Direct instantiation

using ClamClient.Net;
using ClamClient.Net.Configuration;
using ClamClient.Net.Results;

var options = new ClamClientOptions
{
    Endpoint = ClamEndpoint.Tcp("localhost", 3310),
};

var client = new ClamAVClient(options);

bool alive = await client.PingAsync();
string version = await client.GetVersionAsync();

// Scan a stream
using var stream = File.OpenRead("/path/to/upload");
ScanResult result = await client.ScanStreamAsync(stream);

if (result.Status == ScanStatus.ThreatFound)
{
    foreach (var threat in result.Threats)
        Console.WriteLine($"Threat detected: {threat.ThreatName}");
}

Dependency Injection (ASP.NET Core / Generic Host)

// Program.cs
builder.Services.AddClamClient(options =>
{
    options.Endpoint = ClamEndpoint.Tcp("localhost", 3310);
    options.Timeout = TimeSpan.FromSeconds(15);
});

Inject IClamClient wherever you need it:

public class UploadService(IClamClient clamClient)
{
    public async Task<bool> IsSafeAsync(Stream file, CancellationToken ct = default)
    {
        var result = await clamClient.ScanStreamAsync(file, ct);
        return result.Status == ScanStatus.Clean;
    }
}

Unix domain socket (Linux / macOS)

var options = new ClamClientOptions
{
    Endpoint = ClamEndpoint.UnixSocket("/var/run/clamav/clamd.sock"),
};

Unix domain sockets require .NET 5 or later.

API reference

IClamClient

ClamClientOptions

ScanResult

Exceptions

License

MIT

ClamClient.Net（中文说明）

适用于 ClamAV（clamd）的异步 .NET 客户端库，支持 TCP 和 Unix 套接字。

功能特性

• 通过 INSTREAM 扫描文件及任意字节流
• 支持 TCP 和 Unix 域套接字端点
• 完整的 async/await 支持，含 CancellationToken
• Microsoft DI 集成（AddClamClient）
• 除 Microsoft.Extensions.DependencyInjection.Abstractions 外无额外运行时依赖

环境要求

• .NET Standard 2.0 或 .NET 8+
• 正在运行的 clamd 守护进程

本地快速启动守护进程：

docker run -p 3310:3310 clamav/clamav:latest

安装

dotnet add package ClamClient.Net

快速入门

直接实例化

using ClamClient.Net;
using ClamClient.Net.Configuration;
using ClamClient.Net.Results;

var options = new ClamClientOptions
{
    Endpoint = ClamEndpoint.Tcp("localhost", 3310),
};

var client = new ClamAVClient(options);

bool alive = await client.PingAsync();
string version = await client.GetVersionAsync();

// 扫描流
using var stream = File.OpenRead("/path/to/upload");
ScanResult result = await client.ScanStreamAsync(stream);

if (result.Status == ScanStatus.ThreatFound)
{
    foreach (var threat in result.Threats)
        Console.WriteLine($"检测到威胁：{threat.ThreatName}");
}

依赖注入（ASP.NET Core / Generic Host）

// Program.cs
builder.Services.AddClamClient(options =>
{
    options.Endpoint = ClamEndpoint.Tcp("localhost", 3310);
    options.Timeout = TimeSpan.FromSeconds(15);
});

在需要的地方注入 IClamClient：

public class UploadService(IClamClient clamClient)
{
    public async Task<bool> IsSafeAsync(Stream file, CancellationToken ct = default)
    {
        var result = await clamClient.ScanStreamAsync(file, ct);
        return result.Status == ScanStatus.Clean;
    }
}

Unix 域套接字（Linux / macOS）

var options = new ClamClientOptions
{
    Endpoint = ClamEndpoint.UnixSocket("/var/run/clamav/clamd.sock"),
};

Unix 域套接字需要 .NET 5 或更高版本。

API 参考

IClamClient

ClamClientOptions

ScanResult

异常

许可证

MIT