Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sunspikes/clamav-validator
Laravel virus validator based on ClamAV anti-virus scanner
https://github.com/sunspikes/clamav-validator
clamav laravel laravel-package php validator
Last synced: about 1 month ago
JSON representation
Laravel virus validator based on ClamAV anti-virus scanner
- Host: GitHub
- URL: https://github.com/sunspikes/clamav-validator
- Owner: sunspikes
- License: mit
- Created: 2014-12-04T13:39:00.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-18T09:14:13.000Z (9 months ago)
- Last Synced: 2024-04-25T11:20:43.162Z (8 months ago)
- Topics: clamav, laravel, laravel-package, php, validator
- Language: PHP
- Homepage:
- Size: 81.1 KB
- Stars: 302
- Watchers: 10
- Forks: 69
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ClamAV Virus Validator For Laravel
[](https://insight.sensiolabs.com/projects/80f28825-1385-4daa-aaad-0e4c6b6b3910)
[](https://scrutinizer-ci.com/g/sunspikes/clamav-validator/?branch=master)
[](https://scrutinizer-ci.com/g/sunspikes/clamav-validator)
[](https://travis-ci.org/sunspikes/clamav-validator)
[](https://packagist.org/packages/sunspikes/clamav-validator)
[](https://packagist.org/packages/sunspikes/clamav-validator)
A custom Laravel virus validator based on ClamAV anti-virus scanner for file uploads.
* [Requirements](#requirements)
* [Installation](#installation)
* [Usage](#usage)
* [Author](#author)
You must have ClamAV anti-virus scanner running on the server to make this package work.
You can see the ClamAV installation instructions on the official [ClamAV documentation](http://www.clamav.net/documents/installing-clamav).
For example on an Ubuntu machine, you can do:
```sh
# Install clamav virus scanner
sudo apt-get update && sudo apt-get install -y clamav-daemon
# Update virus definitions
sudo freshclam
# Start the scanner service
sudo systemctl enable --now clamav-daemon clamav-freshclam
```
This package is not tested on Windows, but if you have ClamAV running (usually on port 3310) it should work.
You will also need to have `sockets` extension installed and enabled (all executions without this module will fail with this error - `"Use of undefined constant 'AF_INET'"`).
#### 1. Install the package through [Composer](http://getcomposer.org).
```bash
$ composer require sunspikes/clamav-validator
```
#### 2. Add the service provider (for Laravel 5.4 or below)
This package supports Laravel new [Package Discovery](https://laravel.com/docs/5.5/packages#package-discovery).
If you are using Laravel < 5.5, you need to add `Sunspikes\ClamavValidator\ClamavValidatorServiceProvider::class` to your `providers` array in `config/app.php`:
```php
'providers' => [
// ...
Sunspikes\ClamavValidator\ClamavValidatorServiceProvider::class,
],
```
#### 3. Publish assets from the vendor package
##### Config file
The default configuration file does use `ENV` to override the defaults. If you want to change the configuration file
anyway you run the following command to publish the package config file:
php artisan vendor:publish --provider="Sunspikes\ClamavValidator\ClamavValidatorServiceProvider" --tag=config
Once the command is finished you should have a `config/clamav.php` file that will be used as well.
##### Language files
If you want to customize the translation or add your own language you can run the following command to
publish the language files to a folder you maintain:
php artisan vendor:publish --provider="Sunspikes\ClamavValidator\ClamavValidatorServiceProvider" --tag=lang
This will copy the language files to `resources/lang/vendor/clamav-validator` for Laravel >= 5.1
Use it like any `Validator` rule:
```php
$rules = [
'file' => 'clamav',
];
```
`ClamavValidator` will automatically run multiple files one-by-one through ClamAV in case `file` represent multiple uploaded files.
Krishnaprasad MG [@sunspikes] and other [awesome contributors](https://github.com/sunspikes/clamav-validator/graphs/contributors)