オープンソースを使った .NET でのファイルのウイルススキャン
アプリケーションが所有する一時保管ファイルを、受け入れる前に ClamAV でスキャンします。この .NET 10 コンソールプログラムはファイルをローカルデーモンに送り、未検出、感染、スキャナーエラーを個別に判定して返します。入力の駆除、変更、削除は一切行いません。
はじめに
スキャンが完了し、未検出と判定された場合にのみ、次の処理に進めます。ファイルの不在、サイズ制限、デーモンへの接続不可、不正な応答、タイムアウト、キャンセルが発生した場合、ファイルを受け入れてはいけません。未検出の判定は、現在の設定とシグネチャによるエンジンのスキャン結果を示すもので、ファイルが無害であることを保証するものではありません。
.NET 向けのオープンソースウイルス対策ツール
スキャナーには ClamAV を使います。.NET の組み込み TCP クライアントで、文書化された INSTREAM プロトコルを利用できるため、この例では NuGet のスキャナーラッパーは不要です。TCP インターフェースには認証がないため、デーモンは同じホスト上で実行してください。
ClamAV のセットアップ
以下のコマンドは Linux の Bash で実行します。現行の .NET 10 SDK(.NET 10 系の 10.0.111 以降)と、ClamAV 1.5.4 をプラットフォーム別の手順に従ってインストールします。このプログラムは SDK 10.0.111 と ClamAV 1.5.4 でテスト済みです。このリリースをデプロイする前に、ClamAV のサポートポリシーを確認してください。
clamd と freshclam が同じデータベースディレクトリを使うように設定し、初回のシグネチャダウンロードが完了するまで待ちます。ディストリビューションで FreshClam サービスが稼働している場合は、別の更新プログラムを起動せず、そのサービスに更新を任せてください。clamd.conf 内のパッケージのデータベース、ユーザー、ログ設定は維持します。以下の設定断片で該当ディレクティブの既存値を置き換え、競合する設定を追記しないでください。
TCPAddr 127.0.0.1
TCPSocket 3310
StreamMaxLength 25M
MaxFileSize 26M
MaxScanSize 26M
AlertExceedsMax yes
ストリームの上限は、クライアントの上限である 25 MiB に合わせています。エンジンの制限は展開後のコンテンツにも適用されます。AlertExceedsMax を指定すると、対応する制限への到達時にアラートが発生し、このプログラムはそれをスキャナーエラーとして扱います。ワークロードに応じて、アーカイブのその他の制限と暗号化ファイルのポリシーも確認してください。バージョン別の設定リファレンスを参照してください。編集した設定を使い、プラットフォームのサービスマネージャーから
clamd を起動または再起動します。
既存の .NET ビルドツリーの外にある、書き込み可能なディレクトリにアプリケーションを作成します。以下の Bash ブロックは全体をまとめて貼り付けてください。上位ディレクトリに SDK やビルドの設定がある場合、または
FileScan ディレクトリがすでに存在する場合は処理を拒否し、作成と復元が成功した場合にのみプロジェクトに移動します。
(
cd -P . || exit 1
scanner_parent=$PWD
while :; do
for scanner_config in global.json Directory.Build.props Directory.Build.targets; do
if [ -e "$scanner_parent/$scanner_config" ] || [ -L "$scanner_parent/$scanner_config" ]; then
printf 'Choose a directory outside an existing .NET build tree.\n' >&2
exit 1
fi
done
[ "$scanner_parent" = / ] && break
scanner_parent=${scanner_parent%/*}
scanner_parent=${scanner_parent:-/}
done
command -v dotnet >/dev/null &&
mkdir FileScan &&
dotnet new console --framework net10.0 --name FileScan --output FileScan --no-restore &&
dotnet restore FileScan/FileScan.csproj
) && cd FileScan
作成または復元に失敗すると、シェルは元のディレクトリにとどまったまま、不完全な FileScan ディレクトリが残ることがあります。エラーを確認し、既存のファイルは保持してください。このブロックでプロジェクトの作成には成功したものの復元に失敗した場合は、SDK またはパッケージソースの問題を修正し、元のディレクトリから再試行します。
dotnet restore FileScan/FileScan.csproj && cd FileScan
プロジェクトの作成自体に失敗した場合は、新しい空の場所を選んでからセットアップをやり直します。--force を使って既存のプロジェクトを上書きしないでください。
C# でのファイルスキャンの実装
Program.cs を以下の完全なプログラムで置き換えます。最大 25 MiB を 64 KiB のチャンクでストリーミングし、デーモンの応答サイズにも上限を設けます。30 秒経過するか Ctrl+C が押されると、すべてのネットワーク操作とファイル操作をキャンセルします。
using System.Buffers.Binary;
using System.Net;
using System.Net.Sockets;
using System.Text;
public enum Verdict { Clean, Infected, ScannerError }
public static class Program
{
public static async Task<int> Main(string[] args)
{
using var deadline = new CancellationTokenSource(TimeSpan.FromSeconds(30));
Console.CancelKeyPress += (_, e) => { e.Cancel = true; deadline.Cancel(); };
if (args.Length != 1) { Console.Error.WriteLine("Pass one local file."); return 2; }
var verdict = await FileScanner.ScanAsync(args[0], 3310, deadline.Token);
Console.WriteLine(verdict);
return verdict switch { Verdict.Clean => 0, Verdict.Infected => 1, _ => 2 };
}
}
public static class FileScanner
{
private const int MaxBytes = 25 * 1024 * 1024;
public static async Task<Verdict> ScanAsync(string path, int port, CancellationToken ct)
{
try
{
await using var file = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read);
if (file.Length > MaxBytes) return Verdict.ScannerError;
using var client = new TcpClient();
await client.ConnectAsync(IPAddress.Loopback, port, ct);
using var stream = client.GetStream();
await stream.WriteAsync(Encoding.ASCII.GetBytes("zINSTREAM\0"), ct);
var buffer = new byte[64 * 1024];
var header = new byte[4];
long sent = 0;
int count;
while ((count = await file.ReadAsync(buffer, ct)) != 0)
{
sent += count;
if (sent > MaxBytes) return Verdict.ScannerError;
BinaryPrimitives.WriteUInt32BigEndian(header, (uint)count);
await stream.WriteAsync(header, ct);
await stream.WriteAsync(buffer.AsMemory(0, count), ct);
}
BinaryPrimitives.WriteUInt32BigEndian(header, 0);
await stream.WriteAsync(header, ct);
var reply = new List<byte>();
var next = new byte[1];
while (reply.Count < 4096)
{
if (await stream.ReadAsync(next, ct) != 1) return Verdict.ScannerError;
if (next[0] == 0)
{
if (await stream.ReadAsync(next, ct) != 0) return Verdict.ScannerError;
string result = Encoding.UTF8.GetString(reply.ToArray());
if (result == "stream: OK") return Verdict.Clean;
if (result.StartsWith("stream: ", StringComparison.Ordinal) &&
result.EndsWith(" FOUND", StringComparison.Ordinal) && result.Length > 14 &&
!result.Contains("Heuristics.Limits.Exceeded", StringComparison.Ordinal))
return Verdict.Infected;
return Verdict.ScannerError;
}
reply.Add(next[0]);
}
return Verdict.ScannerError;
}
catch (Exception) { return Verdict.ScannerError; }
}
}
プロジェクトディレクトリで、テスト用のテキストファイルを作成してスキャンします。この操作は sample.txt を上書きするため、この名前は破棄してよいテストデータにのみ使用してください。書き込みに失敗した場合、スキャンは実行されません。
printf 'ordinary test text\n' > sample.txt &&
dotnet run -- sample.txt
デーモンが正常に動作していれば、Clean が出力されます。終了コードは、未検出なら 0、感染なら 1、スキャナーエラーなら 2 です。ファイルを受け入れる前に終了コードを確認してください。接続を拒否された場合は、必ず ScannerError となり、Clean となってはいけません。
非破壊スキャンの維持
このプログラムは入力を読み取り専用で開きます。一時保管ファイルはアプリケーションが所有するディレクトリに置き、同時書き込みを防いで、スキャンしたものと同じバイト列を処理してください。元のファイルを保持する必要があるアプリケーションでは、スキャンと修復を一体で行うウイルス対策 API は適していません。
未検出、感染、スキャン失敗のテスト
公式の EICAR テストファイルを
eicar.com.txt としてプロジェクトディレクトリにダウンロードし、次を実行します。
dotnet run -- eicar.com.txt
Infected と終了コード 1 が期待されます。EICAR は無害なウイルス対策テストファイルです。マシン上の別のウイルス対策ソフトウェアが、このプログラムとは無関係に隔離することがあります。ローカルデーモンを停止して dotnet run -- sample.txt を再実行すると、ScannerError と終了コード 2 が期待されます。
ファイルが存在しない場合、入力が 25 MiB を超える場合、アーカイブの展開後のコンテンツがエンジンの設定上限を超える場合もテストしてください。これらの場合は、ScannerError を返す必要があり、Clean を返してはいけません。空のファイルと、サイズがちょうど 25 MiB の通常のファイルは、クライアントの上限内です。各スキャンの前後で入力のハッシュを比較してください。テスト専用のシグネチャデータベースを使う専用デーモンでは連携を検証できますが、本番用マルウェアデータベースの検出範囲を確認することはできません。
ベストプラクティス
本番環境のシグネチャを最新に保ち、エンジンの制限を見直し、一時保管ファイルをアプリケーションの保持ポリシーに従って保持してください。スキャンエラーが発生した場合は、再試行するか拒否するかを判断する必要があり、公開を許可する根拠にはなりません。ユーザーに表示する応答に、認証情報やスキャナーの診断情報を含めないでください。
まとめ
ファイル処理パイプライン内でのスキャンについては、Transloadit の Virus Scan Robotを参照してください。
