ylly/clamav

A simple PHP library for scanning files with ClamAV

2.0.2 2024-09-04 14:25 UTC

Requires

• php: ^8.0
• ext-sockets: *
• symfony/yaml: ^2.2 || ^3.0 || ^4.0 || ^5.0 || ^6.0

Requires (Dev)

• mikey179/vfsstream: ^1.6
• phpunit/phpunit: ^4.0 || ^5.0 || ^6.0

MIT

• Samuel Queniart

README

This library allows you to easily scan file with ClamAv into you project

Require

• PHP 5.6+
• PHP Socket

Installation

$ composer req ylly/php-clamav-scan

Usage

Create Clamav object :

$clamav = ClamavFactory::createFromYamlFile('/some/config/file.yaml');

Clamav Available

You can check if clamav is available with PING command.

$clamav->isAvailable();

Clamav Version

Get version of clamav

$clamav->getVersion();

Note : if clamav is unavailable, the function throw an FailedSocketConnectionException

Clamav scan

// scan path
$result = $clamav->scanPath($path);

$result is instance of ScanResponse

Status combine with binary or ( | ) :

1. Clamav::CLAMAV_INFECT
2. Clamav::CLAMAV_ERROR
3. Clamav::CLAMAV_CLEAN

Use helper for check status

• isInfected()
• isUnckeck()
• isClean()
• hasSomeProblems()

Note : if clamav is unavailable, the function throw an FailedSocketConnectionException

Configuration file

address: '/var/run/clamav/clamd.sock' # Unix socket or IPv4 / IPv6
port: 3310 # optional for IP
socket_length: 200000 # optionnal