Skip to content

docs(backup): document attestation request-hash contract - #15

Draft
SeanROlszewski wants to merge 1 commit into
toolsforhumanity:mainfrom
SeanROlszewski:seanolszewski/backup-attestation-request-hash-docs
Draft

SeanROlszewski wants to merge 1 commit into
toolsforhumanity:mainfrom
SeanROlszewski:seanolszewski/backup-attestation-request-hash-docs

Conversation

@SeanROlszewski

Copy link
Copy Markdown

Summary

Adds a Request attestation section to the Backup Service components page (world-app/backup/components.mdx). This contract was previously undocumented, which is what let World App and the Backup Service drift on the hashed request path.

Covers:

  • The attestation-gateway token (attestation-token header) and the jti = request-hash binding on the three attestation-gated endpoints.
  • The canonical {body, method, pathUri} request-hash format, shared via Oxide's AttestRequestHasher.
  • The enforcement toggle and the attestation-failure response header used while enforcement is disabled.

Why now

Pins the invariant that pathUri is the full request path including the /v1 prefix. The Backup Service was hashing the axum .nest("/v1", …)-stripped path while both clients hash the full path, so attestation validation failed for every iOS & Android client. Fixed server-side in worldcoin/backup-service#227; this documents the contract so a future routing refactor or new client doesn't reintroduce the drift.

Notes for reviewers

  • Draft — opened from a fork (no write access to this repo). Please sanity-check the <Warning> / <Note> component usage renders as intended on this page.
  • Content verified against the shipped Oxide hasher and backup-service/src/attestation_gateway.rs.

🤖 Generated with Claude Code

Adds a "Request attestation" section to the Backup Service components page
covering the attestation-gateway token, the canonical {body, method, pathUri}
request-hash format shared via Oxide, and the enforcement toggle.

Pins the invariant that `pathUri` is the full request path including the `/v1`
prefix (the drift that broke attestation validation for iOS & Android when the
server hashed the axum nest-stripped path). See worldcoin/backup-service#227.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant