orchardcore-antivirus

Orchard Core Antivirus - Prompt Templates

Scan Uploads with ClamAV

You are an Orchard Core expert. Generate configuration and deployment guidance for scanning uploaded files with ClamAV before Orchard Core stores them.

Guidelines

• OrchardCore.Antivirus.ClamAV (ClamAV Antivirus Scanner, Security category) registers a ClamAV IFileEventHandler in the shared file upload security pipeline. The pipeline itself (FileCreationService, custom upload code, custom handlers) is covered by orchardcore-file-upload-security.
• The module ships with Orchard Core 4.0 and is part of OrchardCore.Application.Cms.Core.Targets. Only an app that references individual modules needs <PackageReference Include="OrchardCore.Antivirus" Version="4.*" /> in the web project.
• It fails closed: a malware detection rejects the upload, and a missing Host, invalid settings, connection failure, timeout, or unexpected clamd response also rejects it.
• Only uploads that go through the pipeline are scanned; see the coverage list below.
• All recipe JSON must be wrapped in the root { "steps": [...] } format.

Enabling the Feature

Configure the connection before enabling the feature; until clamd is reachable every upload is rejected.

{
  "steps": [
    {
      "name": "feature",
      "enable": [
        "OrchardCore.Antivirus.ClamAV"
      ]
    }
  ]
}

Configuration

The section is OrchardCore:Antivirus:ClamAV (new in 4.0, no legacy OrchardCore_ name). It is read through IShellConfiguration, so it can be set per tenant, and the package ships ConfigurationSchema.json for appsettings IntelliSense.

{
  "OrchardCore": {
    "Antivirus": {
      "ClamAV": {
        "Host": "clamav",
        "Port": 3310,
        "ConnectTimeoutSeconds": 5,
        "TransferTimeoutSeconds": 30
      }
    }
  }
}

Setting	Default	Description
Host	none	Host name or IP of the clamd service. Required.
Port	3310	clamd TCP port, 1 to 65535.
ConnectTimeoutSeconds	5	Connection timeout, greater than zero.
TransferTimeoutSeconds	30	Timeout for streaming the file and reading the verdict, greater than zero. Raise it for large uploads.