@oxy.so/core 7.28.0 → 7.30.0

package/dist/cjs/crypto/organizationKeys.js

@@ -9,8 +9,10 @@
  * other Oxy apps reach it the way they reach the personal identity, by
  * derivation and never by the key:
  *
- * - iOS: the keychain access group `group.so.oxy.shared`, like the personal
- *   shared slot. Only Commons writes it.
+ * - iOS: the pair in the wallet keychain group (`<TEAM>.so.oxy.wallet`), which
+ *   only Commons and the Peable wallet hold; the phrase and the index in the
+ *   identity group, Commons only (docs/identity/ios-keychain-access-groups.md).
+ *   Only Commons writes them; every other app reads nothing.
  * - Android: Commons' own expo-secure-store slot, mirrored into the identity
  *   signer store (`./identitySigner`) that Commons' identity host answers
  *   `accountId` requests from. Every other app asks Commons over IPC
@@ -18,13 +20,13 @@
  *
  * The phrase is kept only in Commons, on the device that created or imported
  * it, so an owner can show it to another owner (ADR 0061 D5); it never reaches
- * the keychain group, an IPC answer or a log.
+ * the wallet or shared group, an IPC answer or a log.
  *
  * This module imports nothing from `./keyManager` (which imports it): the
  * signer store comes from `./identitySigner`'s registry.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isOrganizationAccountId = isOrganizationAccountId;
+exports.isOrganizationAccountId = void 0;
 exports.isHealthyOrganizationKeyPair = isHealthyOrganizationKeyPair;
 exports.generateOrganizationKey = generateOrganizationKey;
 exports.organizationKeyFromPhrase = organizationKeyFromPhrase;
@@ -40,29 +42,18 @@ const english_js_1 = require("@scure/bip39/wordlists/english.js");
 const protocol_1 = require("@oxy.so/protocol");
 const secp256k1_1 = require("@oxy.so/protocol/secp256k1");
 const logger_1 = require("../logger");
+const keychainAccessGroups_1 = require("../utils/keychainAccessGroups");
 const platform_1 = require("../utils/platform");
 const identitySigner_1 = require("./identitySigner");
-/** Same set the server's account ids come from: a legacy 24-hex id or a lowercase uuid. */
-const ACCOUNT_ID = /^(?:[0-9a-f]{24}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$/;
-const IOS_KEYCHAIN_GROUP = 'group.so.oxy.shared';
-/** Android, Commons-local: its own Keystore key, shared with no personal slot. */
-const ANDROID_KEYCHAIN_SERVICE = 'oxy_org_identity';
-const MNEMONIC_KEYCHAIN_SERVICE = 'oxy_org_identity_mnemonic';
-const INDEX_KEYCHAIN_SERVICE = 'oxy_org_identity_index';
-const INDEX_STORAGE_KEY = 'oxy_org_identity_index_v1';
+const keychainGroupMigration_1 = require("./keychainGroupMigration");
+const keychainItems_1 = require("./keychainItems");
+Object.defineProperty(exports, "isOrganizationAccountId", { enumerable: true, get: function () { return keychainItems_1.isOrganizationAccountId; } });
 const ORGANIZATION_PHRASE_WORDS = 24;
-/** Whether `value` is an account id an organization key can be stored under. */
-function isOrganizationAccountId(value) {
-    return ACCOUNT_ID.test(value);
-}
 function assertAccountId(accountId) {
-    if (!isOrganizationAccountId(accountId)) {
+    if (!(0, keychainItems_1.isOrganizationAccountId)(accountId)) {
         throw new Error('organization key: accountId must be a 24-hex or uuid account id');
     }
 }
-const privateKeyName = (accountId) => `oxy_org_identity_private_key.${accountId}`;
-const publicKeyName = (accountId) => `oxy_org_identity_public_key.${accountId}`;
-const mnemonicName = (accountId) => `oxy_org_identity_mnemonic.${accountId}`;
 function toHex(bytes) {
     return Array.from(bytes, (b) => b.toString(16).padStart(2, '0')).join('');
 }
@@ -115,19 +106,33 @@ async function generateOrganizationKey() {
 async function organizationKeyFromPhrase(phrase) {
     return pairFromPhrase(phrase);
 }
-async function secureStore() {
-    return (0, protocol_1.loadSecureStore)();
+/**
+ * The secure store for one class of organization item: on iOS the pair is a
+ * `spending-key` (wallet group), the phrase and the index `identity-secret`
+ * (identity group); see `../utils/keychainAccessGroups`. In Commons every
+ * access first awaits the access-group migration. Android is unchanged.
+ */
+async function secureStore(item) {
+    const raw = await (0, protocol_1.loadSecureStore)();
+    const access = await (0, keychainAccessGroups_1.resolveKeychainAccess)();
+    if (access.mode === 'grouped' && access.role === 'holder') {
+        await (0, keychainGroupMigration_1.ensureKeychainGroupsMigrated)();
+    }
+    return (0, keychainAccessGroups_1.groupedKeychainStore)(raw, access, item);
 }
+const pairStore = () => secureStore('spending-key');
+const phraseStore = () => secureStore('identity-secret');
+const indexStore = () => secureStore('identity-secret');
 async function readIndex(store) {
-    const raw = await store.getItemAsync(INDEX_STORAGE_KEY, {
-        keychainService: INDEX_KEYCHAIN_SERVICE,
+    const raw = await store.getItemAsync(keychainItems_1.ORGANIZATION_INDEX_STORAGE_KEY, {
+        keychainService: keychainItems_1.ORGANIZATION_INDEX_KEYCHAIN_SERVICE,
     });
     if (!raw)
         return [];
     try {
         const parsed = JSON.parse(raw);
         return Array.isArray(parsed)
-            ? parsed.filter((id) => typeof id === 'string' && isOrganizationAccountId(id))
+            ? parsed.filter((id) => typeof id === 'string' && (0, keychainItems_1.isOrganizationAccountId)(id))
             : [];
     }
     catch (error) {
@@ -139,26 +144,24 @@ async function readIndex(store) {
     }
 }
 async function writeIndex(store, ids) {
-    await store.setItemAsync(INDEX_STORAGE_KEY, JSON.stringify([...new Set(ids)].sort()), {
-        keychainService: INDEX_KEYCHAIN_SERVICE,
+    await store.setItemAsync(keychainItems_1.ORGANIZATION_INDEX_STORAGE_KEY, (0, keychainItems_1.serializeOrganizationIndex)(ids), {
+        keychainService: keychainItems_1.ORGANIZATION_INDEX_KEYCHAIN_SERVICE,
     });
 }
-/** Where this platform keeps the pair: the iOS keychain group, or Commons' own Android slot. */
+/**
+ * The options of the pair on this platform: on iOS no keychain service (the
+ * wallet group comes from {@link pairStore}), on Android Commons' own slot.
+ */
 function pairOptions(store, forPrivateWrite) {
     if ((0, platform_1.isIOS)()) {
-        return forPrivateWrite
-            ? {
-                keychainAccessible: store.WHEN_UNLOCKED_THIS_DEVICE_ONLY,
-                keychainAccessGroup: IOS_KEYCHAIN_GROUP,
-            }
-            : { keychainAccessGroup: IOS_KEYCHAIN_GROUP };
+        return forPrivateWrite ? { keychainAccessible: store.WHEN_UNLOCKED_THIS_DEVICE_ONLY } : {};
     }
     return forPrivateWrite
         ? {
             keychainAccessible: store.WHEN_UNLOCKED_THIS_DEVICE_ONLY,
-            keychainService: ANDROID_KEYCHAIN_SERVICE,
+            keychainService: keychainItems_1.ORGANIZATION_ANDROID_KEYCHAIN_SERVICE,
         }
-        : { keychainService: ANDROID_KEYCHAIN_SERVICE };
+        : { keychainService: keychainItems_1.ORGANIZATION_ANDROID_KEYCHAIN_SERVICE };
 }
 /** The pair from this app's own storage (iOS group; Android Commons slot, then signer store). */
 async function readLocalPair(accountId) {
@@ -168,10 +171,10 @@ async function readLocalPair(accountId) {
         const signer = (0, identitySigner_1.registeredIdentitySignerStore)();
         if (!signer)
             return null; // Only Commons holds organization keys on Android.
-        const store = await secureStore();
+        const store = await pairStore();
         const options = pairOptions(store, false);
-        const privateKey = await store.getItemAsync(privateKeyName(accountId), options);
-        const publicKey = await store.getItemAsync(publicKeyName(accountId), options);
+        const privateKey = await store.getItemAsync((0, keychainItems_1.organizationPrivateKeyName)(accountId), options);
+        const publicKey = await store.getItemAsync((0, keychainItems_1.organizationPublicKeyName)(accountId), options);
         if (privateKey && publicKey && isHealthyOrganizationKeyPair(privateKey, publicKey)) {
             return {
                 privateKey: (0, secp256k1_1.normalizeSecp256k1PrivateKey)(privateKey),
@@ -186,10 +189,12 @@ async function readLocalPair(accountId) {
     }
     if (!(0, platform_1.isIOS)())
         return null;
-    const store = await secureStore();
+    // The wallet group: `null` without a keychain read in every app but Commons
+    // and the Peable wallet.
+    const store = await pairStore();
     const options = pairOptions(store, false);
-    const privateKey = await store.getItemAsync(privateKeyName(accountId), options);
-    const publicKey = await store.getItemAsync(publicKeyName(accountId), options);
+    const privateKey = await store.getItemAsync((0, keychainItems_1.organizationPrivateKeyName)(accountId), options);
+    const publicKey = await store.getItemAsync((0, keychainItems_1.organizationPublicKeyName)(accountId), options);
     return privateKey && publicKey && isHealthyOrganizationKeyPair(privateKey, publicKey)
         ? {
             privateKey: (0, secp256k1_1.normalizeSecp256k1PrivateKey)(privateKey),
@@ -200,7 +205,7 @@ async function readLocalPair(accountId) {
 /**
  * Keep an organization key on this device. Commons only: on Android it needs
  * the identity signer store Commons registers, so the identity host can serve
- * it; on iOS only Commons calls it (the keychain group is shared).
+ * it; on iOS only Commons holds the groups it writes (any other app throws).
  *
  * Refuses a pair whose public key does not derive from its private key, and a
  * phrase that does not derive the pair. Overwrites whatever this device held for
@@ -225,34 +230,36 @@ async function storeOrganizationKey(accountId, key) {
     if ((0, platform_1.isAndroid)() && !signer?.writeOrganization) {
         throw new Error('On Android only Commons holds organization keys; this app has no identity signer store for them.');
     }
-    const store = await secureStore();
-    await store.setItemAsync(privateKeyName(accountId), privateKey, pairOptions(store, true));
-    await store.setItemAsync(publicKeyName(accountId), publicKey, pairOptions(store, false));
+    const store = await pairStore();
+    await store.setItemAsync((0, keychainItems_1.organizationPrivateKeyName)(accountId), privateKey, pairOptions(store, true));
+    await store.setItemAsync((0, keychainItems_1.organizationPublicKeyName)(accountId), publicKey, pairOptions(store, false));
     if (signer?.writeOrganization &&
         !(await signer.writeOrganization(accountId, privateKey, publicKey))) {
         throw new Error(`The identity signer store (${signer.name}) did not confirm the organization key.`);
     }
+    const phrases = await phraseStore();
     if (key.mnemonic !== undefined) {
-        await store.setItemAsync(mnemonicName(accountId), normalizePhrase(key.mnemonic), {
-            keychainService: MNEMONIC_KEYCHAIN_SERVICE,
-            keychainAccessible: store.WHEN_UNLOCKED_THIS_DEVICE_ONLY,
+        await phrases.setItemAsync((0, keychainItems_1.organizationMnemonicName)(accountId), normalizePhrase(key.mnemonic), {
+            keychainService: keychainItems_1.ORGANIZATION_MNEMONIC_KEYCHAIN_SERVICE,
+            keychainAccessible: phrases.WHEN_UNLOCKED_THIS_DEVICE_ONLY,
         });
     }
     else {
-        await store.deleteItemAsync(mnemonicName(accountId), {
-            keychainService: MNEMONIC_KEYCHAIN_SERVICE,
+        await phrases.deleteItemAsync((0, keychainItems_1.organizationMnemonicName)(accountId), {
+            keychainService: keychainItems_1.ORGANIZATION_MNEMONIC_KEYCHAIN_SERVICE,
         });
     }
-    await writeIndex(store, [...(await readIndex(store)), accountId]);
+    const index = await indexStore();
+    await writeIndex(index, [...(await readIndex(index)), accountId]);
 }
 /**
  * The organization's public key as THIS device can reach it, or `null`.
- * iOS: the keychain group. Android: Commons' own slot inside Commons, and
+ * iOS: the wallet keychain group (Commons, the Peable wallet). Android: Commons' own slot inside Commons, and
  * Commons' identity host (`describe` with `accountId`) everywhere else. Compare
  * it with the organization's DID `#key-1` before receiving (Peable ADR 0002).
  */
 async function getOrganizationPublicKey(accountId) {
-    if (!isOrganizationAccountId(accountId) || (0, platform_1.isWeb)())
+    if (!(0, keychainItems_1.isOrganizationAccountId)(accountId) || (0, platform_1.isWeb)())
         return null;
     try {
         if ((0, platform_1.isAndroid)() && !(0, identitySigner_1.registeredIdentitySignerStore)()) {
@@ -272,11 +279,11 @@ async function getOrganizationPublicKey(accountId) {
 }
 /**
  * The organization's private key, where this app may hold it: Commons (both
- * platforms) and, on iOS, the keychain group. `null` on Android outside
- * Commons. Use it to sign within the app only; never transmit it.
+ * platforms) and, on iOS, the Peable wallet through the wallet keychain group.
+ * `null` everywhere else. Use it to sign within the app only; never transmit it.
  */
 async function getOrganizationPrivateKey(accountId) {
-    if (!isOrganizationAccountId(accountId))
+    if (!(0, keychainItems_1.isOrganizationAccountId)(accountId))
         return null;
     try {
         return (await readLocalPair(accountId))?.privateKey ?? null;
@@ -291,34 +298,35 @@ async function getOrganizationPrivateKey(accountId) {
 }
 /** The organization's phrase, if this device created or imported it with one. Commons only. */
 async function getOrganizationRecoveryPhrase(accountId) {
-    if (!isOrganizationAccountId(accountId) || (0, platform_1.isWeb)())
+    if (!(0, keychainItems_1.isOrganizationAccountId)(accountId) || (0, platform_1.isWeb)())
         return null;
-    const store = await secureStore();
-    return store.getItemAsync(mnemonicName(accountId), {
-        keychainService: MNEMONIC_KEYCHAIN_SERVICE,
+    const store = await phraseStore();
+    return store.getItemAsync((0, keychainItems_1.organizationMnemonicName)(accountId), {
+        keychainService: keychainItems_1.ORGANIZATION_MNEMONIC_KEYCHAIN_SERVICE,
     });
 }
 /** The organizations this device keeps a key for (Commons' own index). */
 async function listOrganizationKeys() {
     if ((0, platform_1.isWeb)())
         return [];
-    return readIndex(await secureStore());
+    return readIndex(await indexStore());
 }
 /** Forget an organization key on this device: its pair, its phrase, its signer copy and its index entry. */
 async function deleteOrganizationKey(accountId) {
     assertAccountId(accountId);
     if ((0, platform_1.isWeb)())
         return;
-    const store = await secureStore();
+    const store = await pairStore();
     const options = pairOptions(store, false);
-    await store.deleteItemAsync(privateKeyName(accountId), options);
-    await store.deleteItemAsync(publicKeyName(accountId), options);
-    await store.deleteItemAsync(mnemonicName(accountId), {
-        keychainService: MNEMONIC_KEYCHAIN_SERVICE,
+    await store.deleteItemAsync((0, keychainItems_1.organizationPrivateKeyName)(accountId), options);
+    await store.deleteItemAsync((0, keychainItems_1.organizationPublicKeyName)(accountId), options);
+    await (await phraseStore()).deleteItemAsync((0, keychainItems_1.organizationMnemonicName)(accountId), {
+        keychainService: keychainItems_1.ORGANIZATION_MNEMONIC_KEYCHAIN_SERVICE,
     });
     const signer = (0, platform_1.isAndroid)() ? (0, identitySigner_1.registeredIdentitySignerStore)() : null;
     await signer?.clearOrganization?.(accountId);
-    await writeIndex(store, (await readIndex(store)).filter((id) => id !== accountId));
+    const index = await indexStore();
+    await writeIndex(index, (await readIndex(index)).filter((id) => id !== accountId));
 }
 /**
  * Commons on Android: copy every held organization key into the identity
@@ -330,12 +338,12 @@ async function syncOrganizationKeys() {
     const signer = (0, platform_1.isAndroid)() ? (0, identitySigner_1.registeredIdentitySignerStore)() : null;
     if (!signer?.writeOrganization || !signer.readOrganization)
         return 0;
-    const store = await secureStore();
+    const store = await pairStore();
     let mirrored = 0;
-    for (const accountId of await readIndex(store)) {
+    for (const accountId of await readIndex(await indexStore())) {
         const options = pairOptions(store, false);
-        const privateKey = await store.getItemAsync(privateKeyName(accountId), options);
-        const publicKey = await store.getItemAsync(publicKeyName(accountId), options);
+        const privateKey = await store.getItemAsync((0, keychainItems_1.organizationPrivateKeyName)(accountId), options);
+        const publicKey = await store.getItemAsync((0, keychainItems_1.organizationPublicKeyName)(accountId), options);
         if (!privateKey || !publicKey || !isHealthyOrganizationKeyPair(privateKey, publicKey))
             continue;
         const current = await signer.readOrganization(accountId);