@oxy.so/protocol 1.7.0 → 1.8.0

package/dist/cjs/index.js

@@ -11,7 +11,7 @@
  * subpath so they never enter React Native / web bundles.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadCommonsIdentityBridge = exports.getRandomBytesRN = exports.loadAsyncStorage = exports.loadSecureStore = exports.loadExpoCrypto = exports.loadNodeCrypto = exports.isNodeJS = exports.isReactNative = exports.isAuthorizedKey = exports.REGISTRATION_POW_DIFFICULTY_BITS = exports.meetsRegistrationPowDifficulty = exports.countLeadingZeroBits = exports.registrationPowMessage = exports.verifyCheckpointSignature = exports.signCheckpoint = exports.checkpointHash = exports.checkpointSigningInput = exports.verifyInclusionProof = exports.inclusionProof = exports.buildTransparencyTreeFromHeads = exports.buildTransparencyTree = exports.transparencyLeafHash = exports.EMPTY_TRANSPARENCY_ROOT = exports.verifyAndAppend = exports.DEFAULT_CLOCK_SKEW_MS = exports.verifyEnvelope = exports.checkContinuity = exports.UNCHAINED_SEQ = exports.verifyEnvelopeSignature = exports.signEnvelope = exports.verifySignature = exports.signMessage = exports.computeRecordId = exports.sha256 = exports.signedRecordSigningInput = exports.canonicalize = void 0;
+exports.loadKeychainDefaultAccessGroup = exports.loadCommonsIdentityBridge = exports.getRandomBytesRN = exports.loadAsyncStorage = exports.loadSecureStore = exports.loadExpoCrypto = exports.loadNodeCrypto = exports.isNodeJS = exports.isReactNative = exports.isAuthorizedKey = exports.REGISTRATION_POW_DIFFICULTY_BITS = exports.meetsRegistrationPowDifficulty = exports.countLeadingZeroBits = exports.registrationPowMessage = exports.verifyCheckpointSignature = exports.signCheckpoint = exports.checkpointHash = exports.checkpointSigningInput = exports.verifyInclusionProof = exports.inclusionProof = exports.buildTransparencyTreeFromHeads = exports.buildTransparencyTree = exports.transparencyLeafHash = exports.EMPTY_TRANSPARENCY_ROOT = exports.verifyAndAppend = exports.DEFAULT_CLOCK_SKEW_MS = exports.verifyEnvelope = exports.checkContinuity = exports.UNCHAINED_SEQ = exports.verifyEnvelopeSignature = exports.signEnvelope = exports.verifySignature = exports.signMessage = exports.computeRecordId = exports.sha256 = exports.signedRecordSigningInput = exports.canonicalize = void 0;
 // ---------------------------------------------------------------------------
 // Envelope — canonical JSON, signing input, content address, signing/verify
 // ---------------------------------------------------------------------------
@@ -77,3 +77,4 @@ Object.defineProperty(exports, "loadSecureStore", { enumerable: true, get: funct
 Object.defineProperty(exports, "loadAsyncStorage", { enumerable: true, get: function () { return crypto_1.loadAsyncStorage; } });
 Object.defineProperty(exports, "getRandomBytesRN", { enumerable: true, get: function () { return crypto_1.getRandomBytesRN; } });
 Object.defineProperty(exports, "loadCommonsIdentityBridge", { enumerable: true, get: function () { return crypto_1.loadCommonsIdentityBridge; } });
+Object.defineProperty(exports, "loadKeychainDefaultAccessGroup", { enumerable: true, get: function () { return crypto_1.loadKeychainDefaultAccessGroup; } });

package/dist/cjs/platform/crypto.js

@@ -112,6 +112,7 @@ exports.loadExpoCrypto = loadExpoCrypto;
 exports.loadSecureStore = loadSecureStore;
 exports.loadAsyncStorage = loadAsyncStorage;
 exports.loadCommonsIdentityBridge = loadCommonsIdentityBridge;
+exports.loadKeychainDefaultAccessGroup = loadKeychainDefaultAccessGroup;
 const platform_1 = require("./platform");
 // ---------------------------------------------------------------------------
 // Node `crypto` — Node built-in
@@ -177,3 +178,9 @@ Object.defineProperty(exports, "getRandomBytesRN", { enumerable: true, get: func
 function loadCommonsIdentityBridge() {
     return Promise.resolve(null);
 }
+// ---------------------------------------------------------------------------
+// iOS keychain default access group — native-only; off RN there is no keychain.
+// ---------------------------------------------------------------------------
+function loadKeychainDefaultAccessGroup() {
+    return Promise.resolve({ state: 'unsupported' });
+}

package/dist/cjs/platform/crypto.native.js

@@ -59,6 +59,7 @@ exports.loadExpoCrypto = loadExpoCrypto;
 exports.loadSecureStore = loadSecureStore;
 exports.loadAsyncStorage = loadAsyncStorage;
 exports.loadCommonsIdentityBridge = loadCommonsIdentityBridge;
+exports.loadKeychainDefaultAccessGroup = loadKeychainDefaultAccessGroup;
 const expo_modules_core_1 = require("expo-modules-core");
 const optionalPeer_1 = require("./optionalPeer");
 const random_native_1 = require("./random.native");
@@ -237,3 +238,45 @@ function loadCommonsIdentityBridge() {
     }
     return commonsIdentityBridgePromise;
 }
+// ---------------------------------------------------------------------------
+// iOS keychain default access group (docs/identity/ios-keychain-access-groups.md).
+//
+// Resolved once the native module answers; an `unavailable` probe (a thrown
+// call: before first unlock, or the keychain refused) is not memoized, so the
+// next caller asks again. The answer is narrowed to a plain string — it crossed
+// the native boundary.
+// ---------------------------------------------------------------------------
+/** `<prefix>.<group>`: an App ID prefix (no dots) then a non-empty group. */
+const ACCESS_GROUP = /^[A-Za-z0-9]+\.[A-Za-z0-9.-]+$/;
+let keychainDefaultAccessGroup = null;
+async function loadKeychainDefaultAccessGroup() {
+    if (keychainDefaultAccessGroup) {
+        return keychainDefaultAccessGroup;
+    }
+    const native = (0, expo_modules_core_1.requireOptionalNativeModule)('OxyIdentity');
+    const probe = native?.keychainDefaultAccessGroup;
+    if (!native || typeof probe !== 'function') {
+        keychainDefaultAccessGroup = { state: 'unsupported' };
+        return keychainDefaultAccessGroup;
+    }
+    let answer;
+    try {
+        answer = await probe.call(native);
+    }
+    catch (cause) {
+        return { state: 'unavailable', cause };
+    }
+    if (answer === null || answer === undefined) {
+        // The native side runs only on iOS; anything else answers nothing.
+        keychainDefaultAccessGroup = { state: 'unsupported' };
+        return keychainDefaultAccessGroup;
+    }
+    if (typeof answer !== 'string' || !ACCESS_GROUP.test(answer)) {
+        return {
+            state: 'unavailable',
+            cause: new Error('keychain probe answered something that is not an access group'),
+        };
+    }
+    keychainDefaultAccessGroup = { state: 'resolved', accessGroup: answer };
+    return keychainDefaultAccessGroup;
+}

package/dist/esm/index.js

@@ -37,4 +37,4 @@ export { isAuthorizedKey } from './identity/resolver.js';
 // Platform — runtime predicates + lazy crypto/storage loaders
 // ---------------------------------------------------------------------------
 export { isReactNative, isNodeJS } from './platform/platform.js';
-export { loadNodeCrypto, loadExpoCrypto, loadSecureStore, loadAsyncStorage, getRandomBytesRN, loadCommonsIdentityBridge, } from './platform/crypto.js';
+export { loadNodeCrypto, loadExpoCrypto, loadSecureStore, loadAsyncStorage, getRandomBytesRN, loadCommonsIdentityBridge, loadKeychainDefaultAccessGroup, } from './platform/crypto.js';

package/dist/esm/platform/crypto.js

@@ -135,3 +135,9 @@ export { getRandomBytesRN } from './random.js';
 export function loadCommonsIdentityBridge() {
     return Promise.resolve(null);
 }
+// ---------------------------------------------------------------------------
+// iOS keychain default access group — native-only; off RN there is no keychain.
+// ---------------------------------------------------------------------------
+export function loadKeychainDefaultAccessGroup() {
+    return Promise.resolve({ state: 'unsupported' });
+}

package/dist/esm/platform/crypto.native.js

@@ -228,3 +228,45 @@ export function loadCommonsIdentityBridge() {
     }
     return commonsIdentityBridgePromise;
 }
+// ---------------------------------------------------------------------------
+// iOS keychain default access group (docs/identity/ios-keychain-access-groups.md).
+//
+// Resolved once the native module answers; an `unavailable` probe (a thrown
+// call: before first unlock, or the keychain refused) is not memoized, so the
+// next caller asks again. The answer is narrowed to a plain string — it crossed
+// the native boundary.
+// ---------------------------------------------------------------------------
+/** `<prefix>.<group>`: an App ID prefix (no dots) then a non-empty group. */
+const ACCESS_GROUP = /^[A-Za-z0-9]+\.[A-Za-z0-9.-]+$/;
+let keychainDefaultAccessGroup = null;
+export async function loadKeychainDefaultAccessGroup() {
+    if (keychainDefaultAccessGroup) {
+        return keychainDefaultAccessGroup;
+    }
+    const native = requireOptionalNativeModule('OxyIdentity');
+    const probe = native?.keychainDefaultAccessGroup;
+    if (!native || typeof probe !== 'function') {
+        keychainDefaultAccessGroup = { state: 'unsupported' };
+        return keychainDefaultAccessGroup;
+    }
+    let answer;
+    try {
+        answer = await probe.call(native);
+    }
+    catch (cause) {
+        return { state: 'unavailable', cause };
+    }
+    if (answer === null || answer === undefined) {
+        // The native side runs only on iOS; anything else answers nothing.
+        keychainDefaultAccessGroup = { state: 'unsupported' };
+        return keychainDefaultAccessGroup;
+    }
+    if (typeof answer !== 'string' || !ACCESS_GROUP.test(answer)) {
+        return {
+            state: 'unavailable',
+            cause: new Error('keychain probe answered something that is not an access group'),
+        };
+    }
+    keychainDefaultAccessGroup = { state: 'resolved', accessGroup: answer };
+    return keychainDefaultAccessGroup;
+}

package/dist/types/index.d.ts

@@ -29,5 +29,5 @@ export { registrationPowMessage, countLeadingZeroBits, meetsRegistrationPowDiffi
 export { isAuthorizedKey } from './identity/resolver';
 export type { VerificationMethodResolver, ResolvedVerificationMethods, KeyAuthorization, } from './identity/resolver';
 export { isReactNative, isNodeJS } from './platform/platform';
-export { loadNodeCrypto, loadExpoCrypto, loadSecureStore, loadAsyncStorage, getRandomBytesRN, loadCommonsIdentityBridge, } from './platform/crypto';
-export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, } from './platform/expoTypes';
+export { loadNodeCrypto, loadExpoCrypto, loadSecureStore, loadAsyncStorage, getRandomBytesRN, loadCommonsIdentityBridge, loadKeychainDefaultAccessGroup, } from './platform/crypto';
+export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainDefaultAccessGroup, } from './platform/expoTypes';

package/dist/types/platform/crypto.d.ts

@@ -71,8 +71,8 @@
  * see a file containing only specifiers it can understand — no tricks, no
  * runtime parsing risks.
  */
-import type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike } from './expoTypes';
-export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, };
+import type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainDefaultAccessGroup } from './expoTypes';
+export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainDefaultAccessGroup, };
 export declare function loadNodeCrypto(): Promise<typeof import('crypto')>;
 export declare function loadExpoCrypto(): Promise<ExpoCryptoLike>;
 export declare function loadSecureStore(): Promise<ExpoSecureStoreLike>;
@@ -85,3 +85,4 @@ export declare function loadAsyncStorage(): Promise<{
 }>;
 export { getRandomBytesRN } from './random';
 export declare function loadCommonsIdentityBridge(): Promise<CommonsIdentityBridge | null>;
+export declare function loadKeychainDefaultAccessGroup(): Promise<KeychainDefaultAccessGroup>;

package/dist/types/platform/crypto.native.d.ts

@@ -51,8 +51,8 @@
  * `expo-modules-core` is a NON-optional peer (every RN app has it via `expo`),
  * so it stays a plain static import.
  */
-import type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike } from './expoTypes';
-export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, };
+import type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainDefaultAccessGroup } from './expoTypes';
+export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainDefaultAccessGroup, };
 /** Persistent KV storage surface used from `@react-native-async-storage/async-storage`. */
 type AsyncStorageLike = {
     getItem: (key: string) => Promise<string | null>;
@@ -67,3 +67,4 @@ export declare function loadAsyncStorage(): Promise<{
 }>;
 export { getRandomBytesRN } from './random.native';
 export declare function loadCommonsIdentityBridge(): Promise<CommonsIdentityBridge | null>;
+export declare function loadKeychainDefaultAccessGroup(): Promise<KeychainDefaultAccessGroup>;

package/dist/types/platform/expoTypes.d.ts

@@ -115,8 +115,8 @@ export interface CommonsSocialReceiveSignature {
  * resolves `null` when Commons is not installed, holds no identity, or refuses
  * the caller.
  *
- * On iOS the module is a stub that resolves `null`: the Keychain Access Group
- * path in `@oxy.so/core`'s `KeyManager` owns iOS sharing.
+ * On iOS these methods resolve `null`: the keychain access groups in
+ * `@oxy.so/core`'s `KeyManager` own iOS sharing (docs/identity/ios-keychain-access-groups.md).
  */
 export interface CommonsIdentityBridge {
     /**
@@ -140,3 +140,27 @@ export interface CommonsIdentityBridge {
      */
     signSocialReceive(index: number, digest: string, accountId?: string): Promise<CommonsSocialReceiveSignature | null>;
 }
+/**
+ * What the iOS keychain says about this app's DEFAULT access group: the first
+ * entry of its `keychain-access-groups` entitlement, team prefix included
+ * (`ABCDE12345.so.oxy.identity`). The value is read back from a probe item the
+ * native module writes without a group, because JavaScript cannot see the
+ * entitlements or the team prefix (`$(AppIdentifierPrefix)` expands at build
+ * time), and `kSecAttrAccessGroup` must equal an entitlement value exactly.
+ *
+ * - `resolved`: the group string, as the keychain reported it.
+ * - `unsupported`: not iOS, or a native build whose `OxyIdentity` module
+ *   predates the probe. Callers keep the single-group behaviour that build was
+ *   made for.
+ * - `unavailable`: the probe threw (before first unlock, keychain refused).
+ *   Transient; never cached.
+ */
+export type KeychainDefaultAccessGroup = {
+    state: 'resolved';
+    accessGroup: string;
+} | {
+    state: 'unsupported';
+} | {
+    state: 'unavailable';
+    cause: unknown;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxy.so/protocol",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Oxy Protocol — the app-agnostic base substrate: signed-record envelope, canonical JSON, signature/verification, and platform crypto. Reused by any Oxy app to decentralize its own content.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/__tests__/keychainDefaultAccessGroup.test.ts

@@ -0,0 +1,65 @@
+/**
+ * The iOS keychain probe (docs/identity/ios-keychain-access-groups.md): its
+ * answer crossed the native boundary, so only a `<prefix>.<group>` string is a
+ * group; a thrown probe is `unavailable` and asked again, never cached.
+ */
+function mockNative(native: unknown): void {
+  jest.doMock('expo-modules-core', () => ({ requireOptionalNativeModule: () => native }), {
+    virtual: true,
+  });
+}
+
+async function probe() {
+  const mod = await import('../platform/crypto.native');
+  return mod.loadKeychainDefaultAccessGroup();
+}
+
+describe('loadKeychainDefaultAccessGroup (native)', () => {
+  beforeEach(() => {
+    jest.resetModules();
+  });
+
+  test('a native module without the probe is unsupported', async () => {
+    mockNative({ describe: async () => null });
+    await expect(probe()).resolves.toEqual({ state: 'unsupported' });
+    jest.resetModules();
+    mockNative(null);
+    await expect(probe()).resolves.toEqual({ state: 'unsupported' });
+  });
+
+  test('passes a team-prefixed group through, and remembers it', async () => {
+    const keychainDefaultAccessGroup = jest.fn(async () => 'ABCDE12345.so.oxy.identity');
+    mockNative({ keychainDefaultAccessGroup });
+    const mod = await import('../platform/crypto.native');
+    await expect(mod.loadKeychainDefaultAccessGroup()).resolves.toEqual({
+      state: 'resolved',
+      accessGroup: 'ABCDE12345.so.oxy.identity',
+    });
+    await mod.loadKeychainDefaultAccessGroup();
+    expect(keychainDefaultAccessGroup).toHaveBeenCalledTimes(1);
+  });
+
+  test('a throw is unavailable and asked again; junk is unavailable', async () => {
+    let locked = true;
+    mockNative({
+      keychainDefaultAccessGroup: async () => {
+        if (locked) throw new Error('errSecInteractionNotAllowed');
+        return 'ABCDE12345.group.so.oxy.shared';
+      },
+    });
+    const mod = await import('../platform/crypto.native');
+    expect((await mod.loadKeychainDefaultAccessGroup()).state).toBe('unavailable');
+    locked = false;
+    expect((await mod.loadKeychainDefaultAccessGroup()).state).toBe('resolved');
+    for (const junk of [42, 'nodot', '.leading', { group: 'x' }]) {
+      jest.resetModules();
+      mockNative({ keychainDefaultAccessGroup: async () => junk });
+      expect((await probe()).state).toBe('unavailable');
+    }
+  });
+
+  test('the web / Node variant is unsupported', async () => {
+    const mod = await import('../platform/crypto');
+    await expect(mod.loadKeychainDefaultAccessGroup()).resolves.toEqual({ state: 'unsupported' });
+  });
+});

package/src/index.ts

@@ -99,6 +99,7 @@ export {
   loadAsyncStorage,
   getRandomBytesRN,
   loadCommonsIdentityBridge,
+  loadKeychainDefaultAccessGroup,
 } from './platform/crypto';
 
 // ---------------------------------------------------------------------------
@@ -115,4 +116,5 @@ export type {
   CommonsSocialReceiveSignature,
   ExpoCryptoLike,
   ExpoSecureStoreLike,
+  KeychainDefaultAccessGroup,
 } from './platform/expoTypes';

package/src/platform/crypto.native.ts

@@ -60,6 +60,7 @@ import type {
   CommonsSocialReceiveSignature,
   ExpoCryptoLike,
   ExpoSecureStoreLike,
+  KeychainDefaultAccessGroup,
 } from './expoTypes';
 import { missingOptionalPeerError } from './optionalPeer';
 import { requireExpoCrypto } from './random.native';
@@ -73,6 +74,7 @@ export type {
   CommonsSocialReceiveSignature,
   ExpoCryptoLike,
   ExpoSecureStoreLike,
+  KeychainDefaultAccessGroup,
 };
 
 // ---------------------------------------------------------------------------
@@ -217,6 +219,12 @@ interface OxyIdentityNativeModule {
     digest: string,
     accountId: string,
   ): Promise<unknown>;
+  /**
+   * iOS only, added with the keychain access-group split: the access group a
+   * probe item written WITHOUT a group landed in (the app's default group).
+   * Older native modules and Android lack it.
+   */
+  keychainDefaultAccessGroup?(): Promise<unknown>;
 }
 
 const LOWER_HEX = /^[0-9a-f]+$/;
@@ -344,3 +352,48 @@ export function loadCommonsIdentityBridge(): Promise<CommonsIdentityBridge | nul
   }
   return commonsIdentityBridgePromise;
 }
+
+// ---------------------------------------------------------------------------
+// iOS keychain default access group (docs/identity/ios-keychain-access-groups.md).
+//
+// Resolved once the native module answers; an `unavailable` probe (a thrown
+// call: before first unlock, or the keychain refused) is not memoized, so the
+// next caller asks again. The answer is narrowed to a plain string — it crossed
+// the native boundary.
+// ---------------------------------------------------------------------------
+
+/** `<prefix>.<group>`: an App ID prefix (no dots) then a non-empty group. */
+const ACCESS_GROUP = /^[A-Za-z0-9]+\.[A-Za-z0-9.-]+$/;
+
+let keychainDefaultAccessGroup: KeychainDefaultAccessGroup | null = null;
+
+export async function loadKeychainDefaultAccessGroup(): Promise<KeychainDefaultAccessGroup> {
+  if (keychainDefaultAccessGroup) {
+    return keychainDefaultAccessGroup;
+  }
+  const native = requireOptionalNativeModule<Partial<OxyIdentityNativeModule>>('OxyIdentity');
+  const probe = native?.keychainDefaultAccessGroup;
+  if (!native || typeof probe !== 'function') {
+    keychainDefaultAccessGroup = { state: 'unsupported' };
+    return keychainDefaultAccessGroup;
+  }
+  let answer: unknown;
+  try {
+    answer = await probe.call(native);
+  } catch (cause) {
+    return { state: 'unavailable', cause };
+  }
+  if (answer === null || answer === undefined) {
+    // The native side runs only on iOS; anything else answers nothing.
+    keychainDefaultAccessGroup = { state: 'unsupported' };
+    return keychainDefaultAccessGroup;
+  }
+  if (typeof answer !== 'string' || !ACCESS_GROUP.test(answer)) {
+    return {
+      state: 'unavailable',
+      cause: new Error('keychain probe answered something that is not an access group'),
+    };
+  }
+  keychainDefaultAccessGroup = { state: 'resolved', accessGroup: answer };
+  return keychainDefaultAccessGroup;
+}

package/src/platform/crypto.ts

@@ -80,6 +80,7 @@ import type {
   CommonsSocialReceiveSignature,
   ExpoCryptoLike,
   ExpoSecureStoreLike,
+  KeychainDefaultAccessGroup,
 } from './expoTypes';
 
 // Re-export the interfaces so consumers can import them from the same
@@ -91,6 +92,7 @@ export type {
   CommonsSocialReceiveSignature,
   ExpoCryptoLike,
   ExpoSecureStoreLike,
+  KeychainDefaultAccessGroup,
 };
 
 // ---------------------------------------------------------------------------
@@ -176,3 +178,11 @@ export { getRandomBytesRN } from './random';
 export function loadCommonsIdentityBridge(): Promise<CommonsIdentityBridge | null> {
   return Promise.resolve(null);
 }
+
+// ---------------------------------------------------------------------------
+// iOS keychain default access group — native-only; off RN there is no keychain.
+// ---------------------------------------------------------------------------
+
+export function loadKeychainDefaultAccessGroup(): Promise<KeychainDefaultAccessGroup> {
+  return Promise.resolve({ state: 'unsupported' });
+}

package/src/platform/expoTypes.ts

@@ -121,8 +121,8 @@ export interface CommonsSocialReceiveSignature {
  * resolves `null` when Commons is not installed, holds no identity, or refuses
  * the caller.
  *
- * On iOS the module is a stub that resolves `null`: the Keychain Access Group
- * path in `@oxy.so/core`'s `KeyManager` owns iOS sharing.
+ * On iOS these methods resolve `null`: the keychain access groups in
+ * `@oxy.so/core`'s `KeyManager` own iOS sharing (docs/identity/ios-keychain-access-groups.md).
  */
 export interface CommonsIdentityBridge {
   /**
@@ -150,3 +150,23 @@ export interface CommonsIdentityBridge {
     accountId?: string,
   ): Promise<CommonsSocialReceiveSignature | null>;
 }
+
+/**
+ * What the iOS keychain says about this app's DEFAULT access group: the first
+ * entry of its `keychain-access-groups` entitlement, team prefix included
+ * (`ABCDE12345.so.oxy.identity`). The value is read back from a probe item the
+ * native module writes without a group, because JavaScript cannot see the
+ * entitlements or the team prefix (`$(AppIdentifierPrefix)` expands at build
+ * time), and `kSecAttrAccessGroup` must equal an entitlement value exactly.
+ *
+ * - `resolved`: the group string, as the keychain reported it.
+ * - `unsupported`: not iOS, or a native build whose `OxyIdentity` module
+ *   predates the probe. Callers keep the single-group behaviour that build was
+ *   made for.
+ * - `unavailable`: the probe threw (before first unlock, keychain refused).
+ *   Transient; never cached.
+ */
+export type KeychainDefaultAccessGroup =
+  | { state: 'resolved'; accessGroup: string }
+  | { state: 'unsupported' }
+  | { state: 'unavailable'; cause: unknown };