https://github.com/selective-php/archive-bomb-scanner

Archive bomb scanner
https://github.com/selective-php/archive-bomb-scanner

archive-bomb-scanner php png png-bomb-scanner png-bombs rar-bomb rar-bomb-scanner security zip-bomb zip-bomb-scanner

Last synced: about 2 months ago
JSON representation

Archive bomb scanner

• Host: GitHub
• URL: https://github.com/selective-php/archive-bomb-scanner
• Owner: selective-php
• License: mit
• Created: 2019-07-27T09:17:31.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-09-09T12:31:54.000Z (over 1 year ago)
• Last Synced: 2024-10-12T20:22:03.867Z (3 months ago)
• Topics: archive-bomb-scanner, php, png, png-bomb-scanner, png-bombs, rar-bomb, rar-bomb-scanner, security, zip-bomb, zip-bomb-scanner
• Language: PHP
• Size: 1.43 MB
• Stars: 19
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# selective/archive-bomb-scanner

ZIP and PNG bomb scanner for PHP.

[![Latest Version on Packagist](https://img.shields.io/github/release/selective-php/archive-bomb-scanner.svg?style=flat-square)](https://packagist.org/packages/selective/archive-bomb-scanner)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)

[![Build Status](https://github.com/selective-php/archive-bomb-scanner/workflows/build/badge.svg)](https://github.com/selective-php/archive-bomb-scanner/actions)

[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/selective-php/archive-bomb-scanner.svg?style=flat-square)](https://scrutinizer-ci.com/g/selective-php/archive-bomb-scanner/code-structure)

[![Quality Score](https://img.shields.io/scrutinizer/quality/g/selective-php/archive-bomb-scanner.svg?style=flat-square)](https://scrutinizer-ci.com/g/selective-php/archive-bomb-scanner/?branch=master)

[![Total Downloads](https://img.shields.io/packagist/dt/selective/archive-bomb-scanner.svg?style=flat-square)](https://packagist.org/packages/selective/archive-bomb-scanner/stats)

## Features

* Detection of ZIP archive bombs

* Detection of RAR archive bombs

* Detection of PNG bombs

* No dependencies

* Very fast

## Requirements

* PHP 8.1+

## Installation

```

composer require selective/archive-bomb-scanner

```

## Usage

### Scan ZIP file

```php

use Selective\ArchiveBomb\Scanner\BombScanner;

use Selective\ArchiveBomb\Engine\ZipBombEngine;

use SplFileObject;

$file = new SplFileObject('42.zip');

$scanner = new BombScanner();

$scanner->addEngine(new ZipBombEngine());

$scannerResult = $scanner->scanFile($file);

if ($scannerResult->isBomb()) {

    echo 'Archive bomb detected!';

} else {

    echo 'File is clean';

}

```

### Scan in-memory ZIP file

```php

use Selective\ArchiveBomb\BombScanner;

use Selective\ArchiveBomb\Engine\ZipBombEngine;

use SplTempFileObject;

$file = new SplTempFileObject();

$file->fwrite('my file content');

$scanner = new BombScanner();

$scanner->addEngine(new ZipBombEngine());

$isBomb = $detector->scanFile($file)->isBomb(); // true or false

```

### Scan RAR file

```php

use Selective\ArchiveBomb\Scanner\BombScanner;

use Selective\ArchiveBomb\Engine\RarBombEngine;

use SplFileObject;

$file = new SplFileObject('10GB.rar');

$scanner = new BombScanner();

$scanner->addEngine(new RarBombEngine());

$scannerResult = $scanner->scanFile($file);

if ($scannerResult->isBomb()) {

    echo 'Archive bomb detected!';

} else {

    echo 'File is clean';

}

```

### Scan PNG file

```php

use Selective\ArchiveBomb\Scanner\BombScanner;

use Selective\ArchiveBomb\Engine\PngBombEngine;

use SplFileObject;

$file = new SplFileObject('example.png');

$scanner = new BombScanner();

$scanner->addEngine(new PngBombEngine());

$scannerResult = $scanner->scanFile($file);

if ($scannerResult->isBomb()) {

    echo 'PNG bomb detected!';

} else {

    echo 'File is clean';

}

```

## License

MIT