cyphernetsecurity / cypherscan-laravelplus-driver

v0.1.0 2026-09-16 01:38 UTC

Requires

• php: ^8.5
• laravel/framework: ^13.0
• laravelplus/content-security: ^1.0

Requires (Dev)

• orchestra/testbench: ^11.0
• pestphp/pest: ^4.0

MIT

Published on Packagist.org on 2026-09-16 01:43 UTC

README

Standalone CypherScan malware scanner driver for laravelplus/content-security.

Requirements

• PHP 8.5+
• Laravel 13
• laravelplus/content-security 1.x
• A CypherScan API key

Installation

Once the package is available through Packagist:

composer require cyphernetsecurity/cypherscan-laravelplus-driver

Until then, the source repository can be used as a Composer VCS repository.

Configuration

Create a CypherScan API key and configure the host application:

CYPHERSCAN_API_KEY=cs_your_key
CYPHERSCAN_BASE_URL=https://cyphernetsecurity.com
CONTENT_SECURITY_MALWARE_DRIVER=cypherscan

Add the driver under content-security.malware.drivers:

'cypherscan' => [
    'driver' => 'cypherscan',
],

Laravel package discovery registers CypherScanServiceProvider automatically.

Security behavior

The integration is fail-closed:

• clean maps to LaravelPlus Clean
• suspicious maps to Suspicious
• malicious maps to Infected
• unavailable scanners, invalid responses, unknown verdicts, and unusable upload responses do not pass content as clean
• the SHA-256 returned by CypherScan must match the exact LaravelPlus FileReference::checksum() before a verdict is accepted

API flow

The driver uses CypherScan's canonical authenticated file workflow:

1. POST /api/v1/upload/presign
2. upload the exact file bytes to the returned temporary URL
3. POST /api/v1/scan with the returned object key
4. map the verified CypherScan verdict into a LaravelPlus CheckResult

Testing

composer test

The package includes contract coverage for clean, suspicious, malicious, fail-closed conditions, health reporting, SHA-256 binding, and LaravelPlus driver registration.

License

MIT