arachnid/shield

A client for scanning media for CSAM using the Arachnid Shield API.

dev-main 2024-07-19 15:28 UTC

Requires

• php: ^8.1
• ext-fileinfo: *
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• mockery/mockery: ^1.5
• phpunit/php-code-coverage: ^10.1@dev
• phpunit/phpunit: ^10.0

MIT

• Aalekh Patel
• Mark Johnston

• arachnid-shield
• projectarachnid

README

This library is a PHP Client for the Arachnid Shield API.

The Arachnid Shield API is a free HTTP API that implements the scanning of media (images or videos) for proactive detection of known CSAM and harmful/abusive images of children. Maintained by the Canadian Centre for Child Protection, it offers API endpoints to scan media (images or videos) against an existing database of known CSAM images.

Installation

You may install the client in your PHP project using composer:

composer require arachnid/shield

Usage

An example of scanning a media file on disk for CSAM:

use ArachnidShield\ArachnidShield;

include __DIR__ . "/../vendor/autoload.php";

$shield = new ArachnidShield("username", "password");
$scannedMedia = $shield->scanMediaFromFile("path/to/image.jpeg");
if ($scannedMedia->matchesKnownMedia()) {
    echo "Scanned media has matches to known material";
}

An example of scanning a media file hosted at a website you own:

use ArachnidShield\ArachnidShield;

include __DIR__ . "/../vendor/autoload.php";

$shield = new ArachnidShield("username", "password");
$scannedMedia = $shield->scanMediaFromUrl("https://example.com/path/to/image.jpeg");
if ($scannedMedia->matchesKnownMedia()) {
    echo "Scanned media has matches to known material";
}