NinjaKnox RTFM
◆ All manuals →
Read the manual — 庫

NinjaKnox — the vault manual

NinjaKnox (金庫 kinko, "the vault") is a single web GUI over six security primitives — an encrypted secrets vault, a full crypto toolkit, a PII privacy engine, a password/passphrase generator, a TOTP authenticator and a tamper-evident audit log. It is the lightest app in the estate: no graph database, SQLite only for the audit chain. This manual walks each surface and how to use it.

What NinjaKnox is

ninjaknox.ninja · login-gated

A Next.js front end over a FastAPI service (knox_app.py, ~50 endpoints) that wraps the NinjaClaw CLI's vault, crypto, privacy and audit modules. Everything you do lands in an append-only, chain-hashed audit log you can verify. It installs as a PWA — "Add to Home Screen" on iPhone gives you an authenticator and vault in your pocket.

Single sign-on with Ninja Signal (ninja-knox-token cookie); no Neo4j — the whole app is a thin, auditable wrapper around proven crypto.

The secrets vault

/pam/* · encrypted storage

Store secrets encrypted at rest with versioning, TTL (expiry), tags and rotation. The PAM dashboard (/pam/dashboard) lists credentials; search by name or tag (/pam/search); reveal a value on demand (/pam/credentials/{name}/reveal) — and every reveal is an audited event. Secrets never appear in a listing response; you fetch the value explicitly, which is what makes the reveal auditable.

The crypto toolkit

/crypto/* · AEAD, signatures, KEM

A hands-on cryptography bench: encrypt/decrypt with AES-GCM or ChaCha20, hash with SHA3, sign/verify with Ed25519, derive shared keys with X25519, and run a hybrid KEM encapsulate/decapsulate (/crypto/kem/*) that is PQC-ready. /crypto/keygen and /crypto/keypair mint fresh keys; /crypto/info tells you exactly which primitive and parameters were used, so it doubles as a teaching tool.

The privacy engine

/privacy/* · 13 PII types

Paste text and detect personally-identifiable information across 13 types (/privacy/detect), then anonymise it (/privacy/anonymise) with a reversible lookup so an authorised holder can re-identify later (/privacy/reidentify). Clear the lookup table (/privacy/clear-lookup) when the job is done. Useful for scrubbing logs, tickets or datasets before they leave your control.

Passwords & the authenticator

/passwords/* · /totp/*

Generate secure passwords, diceware passphrases and batches (/passwords/generate, /passphrase, /batch), and score any candidate with a strength analyser (/passwords/strength). The TOTP authenticator (RFC 6238) stores accounts encrypted, shows an animated countdown code (/totp/accounts/{aid}/code), imports via QR (/qr) and exports plain or encrypted (/totp/export/encrypted) so you can migrate without exposing seeds.

The tamper-evident audit log

/audit/* · chain-hashed

Every action writes an event into a chain-hashed log — each entry binds the hash of the previous one, so any edit or deletion breaks the chain. Browse events (/audit/events), read stats (/audit/stats), verify integrity end-to-end (/audit/verify) and export the log (/audit/export). This is what lets you prove, after the fact, that a secret was revealed exactly when and by whom the record says.

Availability

manual ready · app pre-deployment

This manual is complete and staged. NinjaKnox is not yet publicly deployed (ninjaknox.ninja has no live DNS at time of writing) — the manual goes live at ninjaknox.ninja/RTFM the moment the app ships. Until then it lives in the Tribal Knowledge Base as reference for what Knox does and how its endpoints are shaped.