14ecff0730596f8be147b255afc8acb99e9095e2 max Fri Sep 18 09:06:06 2026 -0700 hgHubConnect: an api key made on one geo mirror now works on all of them, behind syncHubApiKeys #Preview2 week - bugs introduced now will need a build patch to fix #Preview2 week - bugs introduced now will need a build patch to fix Api keys live in the hgcentral of whichever mirror issued them, so a key made on genome.ucsc.edu was rejected on genome-euro and genome-asia, and the botDelay error told the user to go and make a second one. hgHubConnect now tells the other nodes about a key as soon as it generates or revokes one: cjGenerateApiKey and cjRevokeApiKey call syncApiKeyToOtherNodes(), which posts a hgHubSyncApiKey cartJson request to each peer, and cjSyncApiKey() on the far side writes it into that mirror's own table. The peers come from hgcentral.gbNode via the new geoMirrorNotifyOtherNodes(), and the request is signed with login.cookieSalt, which all of a site's mirrors already share - it is what makes the login cookie verifiable on each of them. So neither a list of mirror addresses nor a new shared secret needs provisioning. The notify is best effort: a peer that is down is warn()ed about and skipped, never failing the local generate or revoke, which has already committed by then. All of it is off unless hg.conf says syncHubApiKeys=on. With the gate off the sender returns at once, the receiver refuses the request outright rather than merely being unreachable, and botDelay keeps printing the old server-specific wording, which off is still the truth. Registered in hgConfCatalog.py as a gate, to be flipped once this is released. refs #38323 diff --git src/hg/inc/hubSpaceKeys.h src/hg/inc/hubSpaceKeys.h index ff2a37d46c4..c09fd75e091 100644 --- src/hg/inc/hubSpaceKeys.h +++ src/hg/inc/hubSpaceKeys.h @@ -65,17 +65,29 @@ char *hubSpaceGetApiKey(char *userName); /* Grab the already created api key if it exists */ char *hubSpaceUserNameForApiKey(struct sqlConnection *conn, char *apiKey); /* Return userName associated with apiKey else NULL. If conn is NULL, will create a connection and free it. */ void hubSpaceRevokeApiKey(char *userName); /* Remove any api keys for userName. errAborts if userName is NULL. * Run in an errCatch to handle errors. */ char *hubSpaceGenerateApiKey(char *userName); /* Make a random (but not crypto-secure) api key for userName, for use of hubtools to upload * to hubspace or for bypassing cloudflare. errAborts if userName is NULL. * Run in an errCatch to handle errors. */ +void hubSpaceSetApiKey(char *userName, char *apiKey); +/* Set userName's api key to apiKey, replacing any existing key -- unlike hubSpaceGenerateApiKey, + * this does not make up a new key. Used to adopt a key that a peer geo mirror generated, so + * that a key works the same on every UCSC mirror. errAborts if userName or apiKey is NULL. */ + +char *hubSpaceApiKeySyncSig(char *userName, char *apiKey); +/* Return a signature over userName and apiKey (empty string for a revoke), made with the + * login.cookieSalt shared secret that is already required to be identical across all of a + * site's geo mirrors (it is what makes the login cookie itself verifiable on every mirror). + * A peer mirror recomputes this to check that a hubSpaceSetApiKey/revoke request genuinely + * came from another UCSC mirror acting for this user, not from an outside caller. */ + #endif /* HUBSPACEKEYS_H */