fadekey-api

library0.2.12jsnpmunverified

Stateless, Redis-backed zero-knowledge secret sharing engine for FadeKey. Current stable version is 0.2.12. It provides a REST API to store and retrieve encrypted blobs with TTL and view limits, leveraging client-side AES-GCM encryption so the server never sees keys or plaintext. Designed for CI/CD, DevOps, and team automation. No database required beyond Redis. Ideal for self-hosted ephemeral secret sharing, contrasting with SaaS-only alternatives.

security devops

npm install fadekey-api

package ↗

INSTALL

IMPORT

SIG · FADEKEY-API

fadekey-api

securityjavascriptv0.2.12

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import FadeKeyAPI from 'fadekey-api'

✗ const FadeKeyAPI = require('fadekey-api')

Package exports a default class constructor. Named exports not provided.

createItem

✓ import { createItem } from 'fadekey-api'

✗ import { createItem } from 'fadekey-api' (actually not exported)

Do not import this; it is an internal function. Use the default class method 'store'.

FadeKeyAPI

✓ import FadeKeyAPI from 'fadekey-api'; const api = new FadeKeyAPI({ redisUrl: 'redis://localhost:6379' })

✗ import { FadeKeyAPI } from 'fadekey-api'

Named import is incorrect; use default import.

Debug

Known issues

gotchaAPI expects ciphertext in base64url format, not standard base64. Ensure client-side encoding matches.

fix

Use base64url encoding for ciphertext and iv fields.

affects: >=0.1.0

deprecatedThe env var REDIS_URL is deprecated. Use REDIS_HOST and REDIS_PORT instead.

fix

Set REDIS_HOST and REDIS_PORT in .env.

affects: >=0.2.0

gotchamaxViews cannot be greater than 100 for playground mode. Production mode value is ignored?

fix

Check FadeKey playground vs production mode limits.

affects: >=0.2.5

breakingIn version 0.2.0, the endpoint changed from POST /secrets to POST /api/items. Old endpoint no longer exists.

fix

Update API calls to /api/items.

affects: >=0.2.0

gotchaServer expects X-Password-Hash header for password-protected secrets, but in some versions it also accepts body field passwordHash. Consistency is key.

fix

Always send X-Password-Hash header for password checks.

affects: >=0.1.5

Errors

Common errors & fixes

Error: connect ECONNREFUSED ::1:6379

Redis is not running or unreachable at default localhost:6379

fix

Ensure Redis is started (e.g., docker run -p 6379:6379 redis) or set REDIS_HOST/REDIS_PORT env vars.

Input validation failed: ciphertext must be a base64url encoded string

ciphertext sent as standard base64 instead of base64url

fix

Use Buffer.from(ciphertext).toString('base64url') on Node.js or replacement characters for +/ to -_.

Secret not found or expired

The item ID doesn't exist or TTL expired

fix

Check that the ID is correct and the secret hasn't been viewed or timed out.

Upgrade

Version history

0.2.12latest on npm

Audit

Dependencies

redisrequiredRequired as the backing store for ciphertexts and metadata

Agent activity

20 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

packagefadekey-api ↗