docs: cryptify api-key tier validates against pkg, not local allowlist - #51
Merged
Conversation
Reflects the change in encryption4all/postguard#167 (new /v2/api-key/validate endpoint), encryption4all/cryptify#139 (cryptify calls it), and encryption4all/postguard-js#43 (SDK forwards the bearer). repos/cryptify.md - Upload-limits table: rename "Anonymous senders" to "Default tier" / "API-key tier" so the column meaning matches the auth header you send. - Note that API-key tier accounts on the tenant id, not sender email. - New "Authentication for the higher tier" section: bearer flow, per-init validation, retry budget, the four validation outcomes, and the 503- vs-413 distinction when pkg is unreachable. - Note that GET /usage returns the per-tenant bucket when called with Authorization: Bearer PG-... - Note that the legacy X-Api-Key header is no longer recognised. guide/architecture.md - Add /v2/api-key/validate to the PKG endpoints table. - Cryptify endpoints: note that init/PUT carry an optional Authorization: Bearer PG-..., and link to the cryptify page for the full breakdown. guide/concepts.md - "API key signing" section: a sentence on the higher upload-quota tier the same key unlocks via Cryptify, with a link. repos/postguard-js.md - Inline comment on pg.sign.apiKey(): the SDK forwards the key to Cryptify uploads automatically; link to the Cryptify upload-limits.
rubenhensen
marked this pull request as ready for review
May 6, 2026 12:25
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reflects the change in:
The user-facing docs change is small but specific: the higher upload-quota tier on Cryptify is now unlocked by a validated `Authorization: Bearer PG-…`, not by mere presence of an `X-Api-Key` header. This PR pins the new behaviour, the failure modes (especially 503 when PKG is unreachable for over-default uploads), and updates the API-endpoint tables.
Pages touched
Build
`npx vitepress build docs` → clean. No broken links.
Deploy ordering
This doc PR can merge whenever, but the described behaviour ships in the order: postguard#167 → cryptify#139 → postguard-js#43. Until those PRs land in production, the page describes the future state. If that's a concern, hold this PR on the gh draft until cryptify#139 is at least in staging.
Test plan