quantumshield-proxy
v1.0.1
Published
Zero-code-change Post-Quantum Security Reverse Proxy (NIST FIPS 203 ML-KEM-768)
Maintainers
Readme
⚡ QuantumShield Reverse Proxy (npm/npx)
Zero-Code-Change Post-Quantum Cryptography (PQC) Security Gateway
Implementing NIST FIPS 203 (ML-KEM-768 / CRYSTALS-Kyber) key encapsulation mechanism for web applications & payment APIs.
🌟 Key Features
- Instant
npxExecution: No installation or build steps required. Run pure JavaScript ML-KEM-768 PQC proxy directly vianpx quantumshield-proxy. - Zero Code Modification: Intercepts HTTP payment traffic on port
8443and transparently forwards decrypted payloads to your upstream target application (e.g.http://localhost:3001). - NIST FIPS 203 ML-KEM-768 Standard: Uses
@noble/post-quantumfor pure JS key generation, encapsulation, and decapsulation. - Harvest Vault Interception: Intercepts and logs classical RSA and post-quantum Kyber ciphertexts for live quantum threat analysis.
- Interactive Setup Wizard: Run without flags to launch an interactive CLI configuration wizard.
🚀 Quick Start
1. Instant Execution via npx
npx quantumshield-proxy2. Custom Port & Upstream App Flags
npx quantumshield-proxy --upstream http://localhost:3001 --port 8443 --mode KYBER_PQC⚙️ CLI Options
| Flag / Option | Short | Default | Description |
|---|---|---|---|
| --port | -p | 8443 | Port for the QuantumShield Proxy to listen on |
| --upstream | -u | http://localhost:3001 | Upstream target web application URL |
| --mode | -m | KYBER_PQC | Protection mode (KYBER_PQC or RSA_ONLY) |
| --help | -h | - | Display help menu and CLI parameters |
📡 REST API Endpoints Exposed
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/proxy/status | Current proxy state, active algorithm, and uptime |
| POST | /api/proxy/activate | Dynamically toggle protection mode (KYBER_PQC ↔ RSA_ONLY) |
| GET | /api/proxy/pubkey | Fetch ML-KEM-768 Public Key (1184-byte hex) |
| POST | /api/proxy/pay/kyber | Decapsulate ML-KEM-768 ciphertext, decrypt payload & forward to upstream |
| POST | /proxy/pay | Legacy RSA payment endpoint (intercepted & logged in vault) |
| GET | /api/proxy/vault | Intercepted transaction vault records |
| POST | /api/proxy/vault/clear | Reset harvest vault |
🔒 Security Specifications
- Algorithm: NIST FIPS 203 (ML-KEM-768)
- Security Level: Category 3 (Equivalent to AES-192 against Quantum Attacks)
- Public Key Size: 1,184 Bytes
- Ciphertext Size: 1,088 Bytes
- Secret Key Size: 2,400 Bytes
