cakedc/cakephp-clamav

cakedc/cakephp-clamav plugin for CakePHP

3.0.0-RC1 2023-12-11 13:16 UTC

Requires

• php: >=8.1
• cakephp/cakephp: ^5.0

Requires (Dev)

• cakephp/cakephp-codesniffer: ^4.0
• phpunit/phpunit: ^10.0

MIT

README

ClamAV integration with CakePHP via Validator

Requirements

• CakePHP 3.8.0+
• PHP 7.2+
• Clamd (daemon) up and running, connection via socket

Setup

composer require cakedc/cakephp-clamav

• Ensure clamav is up and running as daemon
• Configure the plugin using

\Cake\Core\Configure::write('CakeDC/Clamav', [
    // WARNING, disabling will SKIP virus check in validation rules
    'enabled' => true,
    // clamd listening in this socket, defaults to unix file socket
    'socketConfig' => [
        'host' => 'unix:///var/run/clamav/clamd.ctl',
        'port' => null,
        'persistent' => true
    ],
]);

Usage

For example, if you are using the attachment field to upload a file in a form, you can check for viruses using this code snippet in the related Table validationDefault method.

if (Configure::read('CakeDC/Clamav.enabled')) {
            if (!$validator->getProvider('clamd')) {
                $validator->setProvider('clamd', new ClamdValidation());
            }
            $validator->add(
                'attachment',
                'noVirus',
                [
                    'rule' => 'fileHasNoVirusesFound',
                    'provider' => 'clamd',
                ]
            );
        }

Support

For bugs and feature requests, please use the issues section of this repository.

Commercial support is also available, contact us for more information.

Contributing

This repository follows the CakeDC Plugin Standard. If you'd like to contribute new features, enhancements or bug fixes to the plugin, please read our Contribution Guidelines for detailed instructions.

License

Copyright 2018 Cake Development Corporation (CakeDC). All rights reserved.

Licensed under the MIT License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.