Fabric Connect: seal proxied operations end-to-end with the cluster secrets key (`encrypted_operation`), starting with the token mint (blocked on harper#3288)

Aperta
#1,982 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
typescript

Direzione di ricerca

Start with src/config/getInstanceClient.ts and trace the proxy client setup, then read src/lib/crypto/envSecret.ts, src/integrations/api/instance/secrets/secrets.ts, and authStore.establishFabricConnectAuth. The issue depends on Harper's encrypted_operation support and the control-plane relay, so confirm those interfaces before implementation. Done means the listed acceptance criteria pass, including interceptor tests, retry and fallback behavior, badge state, and logging redaction.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Studio leg of end-to-end encrypted Fabric Connect operations. Blocked on HarperFast/harper#3288 (encrypted_operation in core) and on the control-plane leg that relays it opaquely (linked as a dependency on this issue).

Context

When a cluster or instance is reached through Fabric Connect, getInstanceClient points the axios client at the proxy URL (src/config/getInstanceClient.ts:58-77) and every operation, request and response, crosses the proxy in plaintext. The first one in every session is createInstanceAuthenticationTokens (src/integrations/api/instance/auth/createInstanceAuthenticationTokens.ts, called from authStore.establishFabricConnectAuth), whose response is the operation token and refresh token the rest of the session uses; sessions whose direct connection fails (studio#1635 measured network-level direct failures across 11 organizations in a day) keep using the proxy for everything.

Studio already seals values to a cluster's secrets public key for set_secret: src/lib/crypto/envSecret.ts (encryptEnvelope, WebCrypto RSA-OAEP + AES-GCM, enc:v1 output) and secretsPublicKeyQueryOptions({ managedClusterId }) in src/integrations/api/instance/secrets/secrets.ts, which fetches the key from the control plane for managed clusters. harper#3288 lets the same envelope carry a whole operation and answers with a response sealed under a per-request key.

Changes

  1. Transparent sealing on the proxy client. In getInstanceClient, when fabricConnect is true and the target supports it, install a request interceptor that replaces the body with { operation: 'encrypted_operation', envelope } where envelope = encryptEnvelope(JSON.stringify({ v: 1, op: body, rk, nonce, ts: Date.now(), actor }), publicKey, fingerprint) with fresh random rk (32 bytes) and nonce (16 bytes); and a response interceptor that decrypts encrypted_response with WebCrypto AES-GCM under rk, AAD "harper.encrypted_operation.response:" + nonce, then resolves with the inner body or rejects with an AxiosError whose response.status / data are the inner ones. Existing callers and react-query hooks see the same shapes as today. connectsThroughProxy(id) stays the single switch.
  2. Self-heal paths. On a plaintext 409 with custody_fingerprint, invalidate the public-key query and retry once (same pattern as the KID_MISMATCH_ERROR_PHRASE handling in secrets.ts). On a staleness error carrying server_time, retry once with the clock offset applied.
  3. Capability gate. MIN_ENCRYPTED_OPERATION_VERSION checked with wasAReleasedBeforeB against getRegistrationInfoQueryOptions' version, the pattern in useSupportsDeploymentSSE.ts; the constant is set when the core release is cut.
  4. No custody key. Self-hosted clusters (the control plane answers 400 for the key), clusters below the minimum version, or a node answering 503 "custody is not initialized": fall back to plaintext proxying and show a persistent indicator on the Fabric Connect badge ("not end-to-end encrypted; operations are visible to the control plane"). A "require encrypted proxying" preference is a follow-up, not this issue.
  5. Mode policy. harper#3288 has two modes: whole-body sealed, and fields (keys in the clear, values sealed, inner status visible) so the control plane can audit what was attempted. Proposed default: fields, sealing every leaf except operation and the structural keys database, schema, table, with whole-body sealed as a per-call override for operations whose structure is sensitive. In fields mode the interceptor serializes op to JSON text, puts its SHA-256 in the sealed header as oph, and binds each sealed leaf to its JSON Pointer; the helper lives beside envSecret.ts. Both modes must be selectable per call; the default is left open until the core issue has had feedback (Devin, 2026-10-19).
  6. First consumer is the token mint over the proxy; the proxy-fallback mode in resolveFabricConnectAuth is covered by the same interceptor.
  7. Never log the sealed request, rk, or the unsealed response; the existing rule of logging only error.message (axios configs carry bearer tokens) applies.

Acceptance criteria

  1. With a capable managed cluster, every operation sent through the proxy leaves the browser as encrypted_operation with an enc:v1 envelope sealed to the cluster key the secrets page uses, and the caller receives the inner response or error with unchanged shape (unit tests on the interceptors with a mocked proxy; one test proves the plaintext operation name never appears in the request body).

  2. The token mint over the proxy is sealed; the minted token is unsealed in the browser only.

  3. Key-mismatch and clock-skew answers self-heal with one retry; a second failure surfaces as the inner error.

  4. Without a key or below the minimum version, operations still work in plaintext and the badge shows the plaintext state; the secrets page's "no custody" copy mentions that proxied operations are affected too.

  5. No sealed material or key bytes reach console, Datadog RUM actions, or error tracking (assert on the RUM wrapper's redaction as existing tests do).

  6. In fields mode the request body shows operation and the structural keys in plaintext and every other leaf as { $sealed }; a test proves oph matches the sent op bytes and that a sealed leaf moved to another path is rejected by the node.

Links

  • Core: HarperFast/harper#3288 (mechanism, threat model). Related: studio#1635 (direct-connect reachability), studio#1974 (sign-out through the proxy).

🤖 Generated by Anthropic Claude (Mythos 5.1) as devain; posted via @Devin-Holland.

Lingua principale
TypeScript
Stelle
5
Fork
4
Merge medio
1g 20h
PR unite (30g)
140

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di HarperFast/studio

Tutte le issue di HarperFast/studio

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.