PHPackages                             arachnid/shield - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Security](/categories/security)
4. /
5. arachnid/shield

ActiveLibrary[Security](/categories/security)

arachnid/shield
===============

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

2312↓14.3%PHP

Since Nov 24Pushed 7mo ago1 watchersCompare

[ Source](https://github.com/CdnCentreForChildProtection/arachnid-shield-sdk-php)[ Packagist](https://packagist.org/packages/arachnid/shield)[ RSS](/packages/arachnid-shield/feed)WikiDiscussions main Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

Arachnid Shield PHP Client
==========================

[](#arachnid-shield-php-client)

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
============

[](#installation)

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

```
composer require arachnid/shield

```

Usage
-----

[](#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";
}
```

###  Health Score

22

—

LowBetter than 21% of packages

Maintenance45

Moderate activity, may be stable

Popularity19

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity13

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/14a021a7c938bcadcde3221cd06e77a4c94fbc69b8bef5446038abf834e3714b?d=identicon)[CdnCentreForChildProtection](/maintainers/CdnCentreForChildProtection)

---

Top Contributors

[![CdnCentreForChildProtection](https://avatars.githubusercontent.com/u/166165190?v=4)](https://github.com/CdnCentreForChildProtection "CdnCentreForChildProtection (5 commits)")

---

Tags

arachnid-shieldarachnid-shield-sdkprojectarachnid

### Embed Badge

![Health badge](/badges/arachnid-shield/health.svg)

```
[![Health](https://phpackages.com/badges/arachnid-shield/health.svg)](https://phpackages.com/packages/arachnid-shield)
```

###  Alternatives

[mews/purifier

Laravel 5/6/7/8/9/10 HtmlPurifier Package

2.0k18.7M143](/packages/mews-purifier)[paragonie/ecc

PHP Elliptic Curve Cryptography library

24820.0k37](/packages/paragonie-ecc)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)