cypherscan-directus
v0.1.1
Published
Directus extension for scanning uploaded files with CypherScan.
Maintainers
Readme
CypherScan Directus
Directus extension for scanning uploaded files with CypherScan before they reach production workflows.
Links
- npm: https://www.npmjs.com/package/cypherscan-directus
- GitHub: https://github.com/cyphernetsecurity/cypherscan-directus
- CypherScan: https://cyphernetsecurity.com
Features
- Malware scanning
- ClamAV detection
- Upload security
- S3-based scanning pipeline
- Optional blocking of infected files
- Directus hook integration
- CypherScan API support
Installation
Install the package:
npm install cypherscan-directusBuild the extension:
npm run buildCopy the built extension into your Directus project:
extensions/directus-extension-cypherscanRestart Directus.
Configuration
Environment variables:
CYPHERSCAN_API_KEY=your_api_key
CYPHERSCAN_API_BASE_URL=https://cyphernetsecurity.com
CYPHERSCAN_BLOCK_INFECTED=trueCYPHERSCAN_API_KEY
API key generated from the CypherScan dashboard.
CYPHERSCAN_API_BASE_URL
CypherScan API endpoint.
Default:
https://cyphernetsecurity.comCYPHERSCAN_BLOCK_INFECTED
When enabled:
trueinfected uploads are automatically deleted.
When disabled:
falseuploads are scanned but retained.
How It Works
- User uploads a file to Directus
- Extension receives the upload event
- File is uploaded to CypherScan secure scanning storage
- CypherScan scans the file
- A verdict is returned
- Optional blocking removes infected files
Example Log
[cypherscan-directus] scanning: invoice.pdf
[cypherscan-directus] result: invoice.pdf verdict=clean blocked=falseExample Scan Response
{
"verdict": "clean",
"blocked": false,
"scanId": "sc_xxxxxxxxxxxxxxxxx",
"riskLevel": "low"
}Requirements
- Directus
- CypherScan API Key
- Internet access for scan requests
License
MIT
Copyright (c) CypherNet Security
