Protect Payload uploads before they reach production.
CypherScan securely scans every uploaded file using a presigned upload workflow and can automatically block suspicious or malicious files before they become available inside Payload CMS.
- Secure presigned upload workflow
- Malware detection
- Secret detection
- Automatic malicious file blocking
- Configurable fail-open / fail-closed behavior
- Native Payload CMS integration
- Collection targeting
- Payload CMS 3+
- Node.js 20+
- CypherScan API key
Install the plugin:
npm install cypherscan-payloadConfigure the plugin inside your Payload configuration:
import { cypherScanPayload } from "cypherscan-payload";
export default buildConfig({
plugins: [
cypherScanPayload({
apiKey: process.env.CYPHERSCAN_API_KEY!,
apiUrl: "https://cyphernetsecurity.com",
failOpen: true,
}),
],
});| Option | Description |
|---|---|
apiKey |
CypherScan API key |
apiUrl |
CypherScan API base URL |
collections |
Restrict scanning to specific upload collections |
blockVerdicts |
Verdicts that should block uploads |
failOpen |
Enable Fail Open mode |
When a file is uploaded:
- The plugin requests a presigned upload URL from the CypherScan API.
- The file is uploaded securely to temporary object storage.
- CypherScan scans the uploaded object.
- A scan verdict is returned.
- Clean files remain available.
- Suspicious or malicious files are automatically blocked.
User Upload
│
▼
Payload Upload Hook
│
▼
Request Presigned Upload URL
│
▼
Temporary Secure Upload
│
▼
CypherScan Scan
│
▼
Verdict
│
├── Clean ─────► Upload allowed
│
└── Blocked ───► Upload rejected
Upload detected
│
▼
Presigned Upload
│
▼
CypherScan Scan
│
▼
Verdict: Clean
│
▼
File available inside Payload CMS
CypherScan supports two operating modes.
Uploads continue if the scanning service is temporarily unavailable.
Recommended for development environments.
Uploads are rejected when the scan cannot be completed.
Recommended for production environments requiring strict upload enforcement.
The plugin logs scan activity through the Payload logger.
Validated with:
- Clean uploads
- Malware detection (EICAR)
- API unavailable (
failOpen=true) - API unavailable (
failOpen=false) - Collection targeting
- Payload CMS 3.x
Payload plugin scans use the canonical CypherScan API workflow:
POST /api/v1/upload/presign- Upload the file to the returned temporary URL
POST /api/v1/scanwith the returnedobjectKey
The plugin sends a stable client identity:
x-cypherscan-client: payload-plugin
With an active CypherScan Agent subscription, successful authenticated scans
automatically become API_INTEGRATION Agent observations. No second Agent
event call is required for normal Payload plugin scans.
Agent can then use those observations for meaningful-change detection, bounded verification, Controller attention decisions, alerts, and activity history.
- Scan history
- Detailed scan reports
- Quarantine support
- Policy-based upload rules
MIT License
Copyright (c) 2026 CypherNet Security Inc.
See the LICENSE file for details.
- Website: https://cyphernetsecurity.com
- GitHub: https://github.com/cyphernetsecurity/cypherscan-payload
Built by CypherNet Security Inc.