diff --git a/README.md b/README.md index e580eab..4c68871 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,16 @@ Two interfaces on one HTTP host, port 8787, both served by the proxy: Availability on LAN/Tor is decided by the user from the interface panel. +**No endpoint is authenticated.** Upstream ships no auth on any route, so +whoever can reach the port can spend the user's PPQ.AI balance via +`/v1/chat/completions`, and — because this package sets `PPQ_DATA_DIR` — can +also replace the stored key via `POST /setup/api-key` +([upstream #23](https://github.com/PayPerQ/ppq-private-mode-proxy/issues/23)). +The billing exposure predates that endpoint and is inherent to the proxy; the +key-replacement one is enabled by our `PPQ_DATA_DIR` choice, and closes when +upstream's patch lands and this package bumps to it. `instructions.md` warns +the user to expose the interface accordingly. + ## Actions (StartOS UI) - **Configure PPQ API Key** (`configure-api-key`) — visible and enabled at any diff --git a/TODO.md b/TODO.md deleted file mode 100644 index 3ef3ade..0000000 --- a/TODO.md +++ /dev/null @@ -1,8 +0,0 @@ -# TODO — remaining work before release - -- [ ] Run one live inference request with a funded PPQ.AI key. Everything up to - the enclave is verified (attestation, encrypted forward, error handling), - but no request has yet been billed end-to-end against a real key. -- [ ] Re-run backup and restore on a StartOS box: back up, uninstall, restore, - and confirm the service comes back with its key and raises no - configuration task. diff --git a/instructions.md b/instructions.md index a0d44f6..6afbf8c 100644 --- a/instructions.md +++ b/instructions.md @@ -74,5 +74,12 @@ you already saved. ## Limitations +**The proxy has no login of its own, so only expose it to people you trust.** +Anyone who can reach the address can send requests that are billed to your +PPQ.AI key, and can replace the stored key from the Status Page. On a LAN-only +address that means everyone on your network; if you enable a Tor or public +address, it means anyone with the address. Keeping it on the LAN, or on Tor with +the address kept private, is the safe default. + Backups of this service include your saved API key, and restoring a backup restores it — keep that in mind when handling backup drives.