@oxy.so/protocol 1.10.0 → 1.11.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.loadKeychainApplicationAccessGroup = 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;
+exports.loadKeychainReadWithoutInteraction = exports.loadKeychainApplicationAccessGroup = 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
 // ---------------------------------------------------------------------------
@@ -79,3 +79,4 @@ Object.defineProperty(exports, "getRandomBytesRN", { enumerable: true, get: func
 Object.defineProperty(exports, "loadCommonsIdentityBridge", { enumerable: true, get: function () { return crypto_1.loadCommonsIdentityBridge; } });
 Object.defineProperty(exports, "loadKeychainDefaultAccessGroup", { enumerable: true, get: function () { return crypto_1.loadKeychainDefaultAccessGroup; } });
 Object.defineProperty(exports, "loadKeychainApplicationAccessGroup", { enumerable: true, get: function () { return crypto_1.loadKeychainApplicationAccessGroup; } });
+Object.defineProperty(exports, "loadKeychainReadWithoutInteraction", { enumerable: true, get: function () { return crypto_1.loadKeychainReadWithoutInteraction; } });

package/dist/cjs/platform/crypto.js

@@ -114,6 +114,7 @@ exports.loadAsyncStorage = loadAsyncStorage;
 exports.loadCommonsIdentityBridge = loadCommonsIdentityBridge;
 exports.loadKeychainDefaultAccessGroup = loadKeychainDefaultAccessGroup;
 exports.loadKeychainApplicationAccessGroup = loadKeychainApplicationAccessGroup;
+exports.loadKeychainReadWithoutInteraction = loadKeychainReadWithoutInteraction;
 const platform_1 = require("./platform");
 // ---------------------------------------------------------------------------
 // Node `crypto` — Node built-in
@@ -188,3 +189,6 @@ function loadKeychainDefaultAccessGroup() {
 function loadKeychainApplicationAccessGroup(_prefix) {
     return Promise.resolve({ state: 'unsupported' });
 }
+function loadKeychainReadWithoutInteraction() {
+    return Promise.resolve(null);
+}

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

@@ -61,6 +61,7 @@ exports.loadAsyncStorage = loadAsyncStorage;
 exports.loadCommonsIdentityBridge = loadCommonsIdentityBridge;
 exports.loadKeychainDefaultAccessGroup = loadKeychainDefaultAccessGroup;
 exports.loadKeychainApplicationAccessGroup = loadKeychainApplicationAccessGroup;
+exports.loadKeychainReadWithoutInteraction = loadKeychainReadWithoutInteraction;
 const expo_modules_core_1 = require("expo-modules-core");
 const optionalPeer_1 = require("./optionalPeer");
 const random_native_1 = require("./random.native");
@@ -383,3 +384,24 @@ async function loadKeychainApplicationAccessGroup(prefix) {
     keychainApplicationAccessGroup = { state: 'resolved', accessGroup: answer };
     return keychainApplicationAccessGroup;
 }
+// ---------------------------------------------------------------------------
+// iOS keychain read without user interaction (R5-9). `null` when the native
+// module predates it (or off iOS): the caller then reads through
+// expo-secure-store, as before. The answer crossed the native boundary, so only
+// a string or `null` is accepted.
+// ---------------------------------------------------------------------------
+async function loadKeychainReadWithoutInteraction() {
+    const native = (0, expo_modules_core_1.requireOptionalNativeModule)('OxyIdentity');
+    const read = native?.readKeychainItemWithoutInteraction;
+    if (!native || typeof read !== 'function')
+        return null;
+    return async (key, service, accessGroup) => {
+        const answer = await read.call(native, key, service ?? null, accessGroup);
+        if (answer === null || answer === undefined)
+            return null;
+        if (typeof answer !== 'string') {
+            throw new Error('keychain read answered something that is not a string');
+        }
+        return answer;
+    };
+}

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, loadKeychainDefaultAccessGroup, loadKeychainApplicationAccessGroup, } from './platform/crypto.js';
+export { loadNodeCrypto, loadExpoCrypto, loadSecureStore, loadAsyncStorage, getRandomBytesRN, loadCommonsIdentityBridge, loadKeychainDefaultAccessGroup, loadKeychainApplicationAccessGroup, loadKeychainReadWithoutInteraction, } from './platform/crypto.js';

package/dist/esm/platform/crypto.js

@@ -144,3 +144,6 @@ export function loadKeychainDefaultAccessGroup() {
 export function loadKeychainApplicationAccessGroup(_prefix) {
     return Promise.resolve({ state: 'unsupported' });
 }
+export function loadKeychainReadWithoutInteraction() {
+    return Promise.resolve(null);
+}

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

@@ -372,3 +372,24 @@ export async function loadKeychainApplicationAccessGroup(prefix) {
     keychainApplicationAccessGroup = { state: 'resolved', accessGroup: answer };
     return keychainApplicationAccessGroup;
 }
+// ---------------------------------------------------------------------------
+// iOS keychain read without user interaction (R5-9). `null` when the native
+// module predates it (or off iOS): the caller then reads through
+// expo-secure-store, as before. The answer crossed the native boundary, so only
+// a string or `null` is accepted.
+// ---------------------------------------------------------------------------
+export async function loadKeychainReadWithoutInteraction() {
+    const native = requireOptionalNativeModule('OxyIdentity');
+    const read = native?.readKeychainItemWithoutInteraction;
+    if (!native || typeof read !== 'function')
+        return null;
+    return async (key, service, accessGroup) => {
+        const answer = await read.call(native, key, service ?? null, accessGroup);
+        if (answer === null || answer === undefined)
+            return null;
+        if (typeof answer !== 'string') {
+            throw new Error('keychain read answered something that is not a string');
+        }
+        return answer;
+    };
+}

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, loadKeychainDefaultAccessGroup, loadKeychainApplicationAccessGroup, } from './platform/crypto';
-export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainApplicationAccessGroup, KeychainDefaultAccessGroup, } from './platform/expoTypes';
+export { loadNodeCrypto, loadExpoCrypto, loadSecureStore, loadAsyncStorage, getRandomBytesRN, loadCommonsIdentityBridge, loadKeychainDefaultAccessGroup, loadKeychainApplicationAccessGroup, loadKeychainReadWithoutInteraction, } from './platform/crypto';
+export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainApplicationAccessGroup, KeychainDefaultAccessGroup, KeychainReadWithoutInteraction, } 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, KeychainApplicationAccessGroup, KeychainDefaultAccessGroup } from './expoTypes';
-export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainApplicationAccessGroup, KeychainDefaultAccessGroup, };
+import type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainApplicationAccessGroup, KeychainDefaultAccessGroup, KeychainReadWithoutInteraction } from './expoTypes';
+export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainApplicationAccessGroup, KeychainDefaultAccessGroup, KeychainReadWithoutInteraction, };
 export declare function loadNodeCrypto(): Promise<typeof import('crypto')>;
 export declare function loadExpoCrypto(): Promise<ExpoCryptoLike>;
 export declare function loadSecureStore(): Promise<ExpoSecureStoreLike>;
@@ -87,3 +87,4 @@ export { getRandomBytesRN } from './random';
 export declare function loadCommonsIdentityBridge(): Promise<CommonsIdentityBridge | null>;
 export declare function loadKeychainDefaultAccessGroup(): Promise<KeychainDefaultAccessGroup>;
 export declare function loadKeychainApplicationAccessGroup(_prefix: string): Promise<KeychainApplicationAccessGroup>;
+export declare function loadKeychainReadWithoutInteraction(): Promise<KeychainReadWithoutInteraction | null>;

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, KeychainApplicationAccessGroup, KeychainDefaultAccessGroup } from './expoTypes';
-export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainApplicationAccessGroup, KeychainDefaultAccessGroup, };
+import type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainApplicationAccessGroup, KeychainDefaultAccessGroup, KeychainReadWithoutInteraction } from './expoTypes';
+export type { CommonsIdentityBridge, CommonsIdentityDescription, CommonsIdentityProof, CommonsSocialReceiveSignature, ExpoCryptoLike, ExpoSecureStoreLike, KeychainApplicationAccessGroup, KeychainDefaultAccessGroup, KeychainReadWithoutInteraction, };
 /** Persistent KV storage surface used from `@react-native-async-storage/async-storage`. */
 type AsyncStorageLike = {
     getItem: (key: string) => Promise<string | null>;
@@ -69,3 +69,4 @@ export { getRandomBytesRN } from './random.native';
 export declare function loadCommonsIdentityBridge(): Promise<CommonsIdentityBridge | null>;
 export declare function loadKeychainDefaultAccessGroup(): Promise<KeychainDefaultAccessGroup>;
 export declare function loadKeychainApplicationAccessGroup(prefix: string): Promise<KeychainApplicationAccessGroup>;
+export declare function loadKeychainReadWithoutInteraction(): Promise<KeychainReadWithoutInteraction | null>;

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

@@ -220,3 +220,17 @@ export type KeychainApplicationAccessGroup = {
     state: 'unavailable';
     cause: unknown;
 };
+/**
+ * iOS: read one `expo-secure-store` item WITHOUT ever asking the user
+ * (round-5 review R5-9). `expo-secure-store`'s own read tries the item's
+ * `<service>:no-auth` copy, then its `<service>:auth` copy (an item stored
+ * with `requireAuthentication`, which shows a Face ID / passcode prompt),
+ * then the legacy `<service>` copy. Any app in a shared access group can plant
+ * an `:auth` copy, so a read of that group could stall Commons behind prompts.
+ * This reader tries `<service>:no-auth` then `<service>`, both with an
+ * `LAContext` whose `interactionNotAllowed` is set, and never the `:auth`
+ * copy: an item that needs the user answers `null`. `service` defaults to
+ * expo-secure-store's `app`. A keychain error other than "not found" or
+ * "interaction not allowed" throws.
+ */
+export type KeychainReadWithoutInteraction = (key: string, service: string | undefined, accessGroup: string) => Promise<string | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxy.so/protocol",
-  "version": "1.10.0",
+  "version": "1.11.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",
@@ -133,7 +133,7 @@
   },
   "dependencies": {
     "@noble/curves": "^2.4.0",
-    "@oxy.so/contracts": "^6.12.0"
+    "@oxy.so/contracts": "^6.13.0"
   },
   "peerDependencies": {
     "@react-native-async-storage/async-storage": "<4.0.0",

package/src/__tests__/keychainDefaultAccessGroup.test.ts

@@ -128,3 +128,39 @@ describe('loadKeychainApplicationAccessGroup (native, ADR 0062 D6)', () => {
     });
   });
 });
+
+describe('loadKeychainReadWithoutInteraction (native, R5-9)', () => {
+  beforeEach(() => {
+    jest.resetModules();
+  });
+
+  test('a native module without it answers null: the caller reads as before', async () => {
+    mockNative({ describe: async () => null });
+    const mod = await import('../platform/crypto.native');
+    await expect(mod.loadKeychainReadWithoutInteraction()).resolves.toBeNull();
+  });
+
+  test('passes the key, service and group through; only a string or null crosses back', async () => {
+    const readKeychainItemWithoutInteraction = jest.fn(async (key: string) =>
+      key === 'present' ? 'value' : key === 'junk' ? 42 : null,
+    );
+    mockNative({ readKeychainItemWithoutInteraction });
+    const mod = await import('../platform/crypto.native');
+    const read = await mod.loadKeychainReadWithoutInteraction();
+    expect(read).not.toBeNull();
+    await expect(read?.('present', 'svc', 'ABCDE12345.group.so.oxy.shared')).resolves.toBe('value');
+    expect(readKeychainItemWithoutInteraction).toHaveBeenCalledWith(
+      'present',
+      'svc',
+      'ABCDE12345.group.so.oxy.shared',
+    );
+    await expect(read?.('absent', undefined, 'g')).resolves.toBeNull();
+    expect(readKeychainItemWithoutInteraction).toHaveBeenLastCalledWith('absent', null, 'g');
+    await expect(read?.('junk', undefined, 'g')).rejects.toThrow('not a string');
+  });
+
+  test('the web / Node variant has none', async () => {
+    const mod = await import('../platform/crypto');
+    await expect(mod.loadKeychainReadWithoutInteraction()).resolves.toBeNull();
+  });
+});

package/src/index.ts

@@ -101,6 +101,7 @@ export {
   loadCommonsIdentityBridge,
   loadKeychainDefaultAccessGroup,
   loadKeychainApplicationAccessGroup,
+  loadKeychainReadWithoutInteraction,
 } from './platform/crypto';
 
 // ---------------------------------------------------------------------------
@@ -119,4 +120,5 @@ export type {
   ExpoSecureStoreLike,
   KeychainApplicationAccessGroup,
   KeychainDefaultAccessGroup,
+  KeychainReadWithoutInteraction,
 } from './platform/expoTypes';

package/src/platform/crypto.native.ts

@@ -62,6 +62,7 @@ import type {
   ExpoSecureStoreLike,
   KeychainApplicationAccessGroup,
   KeychainDefaultAccessGroup,
+  KeychainReadWithoutInteraction,
 } from './expoTypes';
 import { missingOptionalPeerError } from './optionalPeer';
 import { requireExpoCrypto } from './random.native';
@@ -77,6 +78,7 @@ export type {
   ExpoSecureStoreLike,
   KeychainApplicationAccessGroup,
   KeychainDefaultAccessGroup,
+  KeychainReadWithoutInteraction,
 };
 
 // ---------------------------------------------------------------------------
@@ -234,6 +236,16 @@ interface OxyIdentityNativeModule {
    * modules and Android lack it.
    */
   keychainApplicationAccessGroup?(prefix: string): Promise<unknown>;
+  /**
+   * iOS only, added in round 5 (R5-9): read one expo-secure-store item without
+   * user interaction, never its `:auth` copy. Older native modules and Android
+   * lack it.
+   */
+  readKeychainItemWithoutInteraction?(
+    key: string,
+    service: string | null,
+    accessGroup: string,
+  ): Promise<unknown>;
   /**
    * Retired keys (Commons protocol 4), added after the organization methods and
    * just as absent on an older native module. `accountId` is `null` for the
@@ -545,3 +557,24 @@ export async function loadKeychainApplicationAccessGroup(
   keychainApplicationAccessGroup = { state: 'resolved', accessGroup: answer };
   return keychainApplicationAccessGroup;
 }
+
+// ---------------------------------------------------------------------------
+// iOS keychain read without user interaction (R5-9). `null` when the native
+// module predates it (or off iOS): the caller then reads through
+// expo-secure-store, as before. The answer crossed the native boundary, so only
+// a string or `null` is accepted.
+// ---------------------------------------------------------------------------
+
+export async function loadKeychainReadWithoutInteraction(): Promise<KeychainReadWithoutInteraction | null> {
+  const native = requireOptionalNativeModule<Partial<OxyIdentityNativeModule>>('OxyIdentity');
+  const read = native?.readKeychainItemWithoutInteraction;
+  if (!native || typeof read !== 'function') return null;
+  return async (key, service, accessGroup) => {
+    const answer: unknown = await read.call(native, key, service ?? null, accessGroup);
+    if (answer === null || answer === undefined) return null;
+    if (typeof answer !== 'string') {
+      throw new Error('keychain read answered something that is not a string');
+    }
+    return answer;
+  };
+}

package/src/platform/crypto.ts

@@ -82,6 +82,7 @@ import type {
   ExpoSecureStoreLike,
   KeychainApplicationAccessGroup,
   KeychainDefaultAccessGroup,
+  KeychainReadWithoutInteraction,
 } from './expoTypes';
 
 // Re-export the interfaces so consumers can import them from the same
@@ -95,6 +96,7 @@ export type {
   ExpoSecureStoreLike,
   KeychainApplicationAccessGroup,
   KeychainDefaultAccessGroup,
+  KeychainReadWithoutInteraction,
 };
 
 // ---------------------------------------------------------------------------
@@ -194,3 +196,7 @@ export function loadKeychainApplicationAccessGroup(
 ): Promise<KeychainApplicationAccessGroup> {
   return Promise.resolve({ state: 'unsupported' });
 }
+
+export function loadKeychainReadWithoutInteraction(): Promise<KeychainReadWithoutInteraction | null> {
+  return Promise.resolve(null);
+}

package/src/platform/expoTypes.ts

@@ -231,3 +231,22 @@ export type KeychainApplicationAccessGroup =
   | { state: 'resolved'; accessGroup: string }
   | { state: 'unsupported' }
   | { state: 'unavailable'; cause: unknown };
+
+/**
+ * iOS: read one `expo-secure-store` item WITHOUT ever asking the user
+ * (round-5 review R5-9). `expo-secure-store`'s own read tries the item's
+ * `<service>:no-auth` copy, then its `<service>:auth` copy (an item stored
+ * with `requireAuthentication`, which shows a Face ID / passcode prompt),
+ * then the legacy `<service>` copy. Any app in a shared access group can plant
+ * an `:auth` copy, so a read of that group could stall Commons behind prompts.
+ * This reader tries `<service>:no-auth` then `<service>`, both with an
+ * `LAContext` whose `interactionNotAllowed` is set, and never the `:auth`
+ * copy: an item that needs the user answers `null`. `service` defaults to
+ * expo-secure-store's `app`. A keychain error other than "not found" or
+ * "interaction not allowed" throws.
+ */
+export type KeychainReadWithoutInteraction = (
+  key: string,
+  service: string | undefined,
+  accessGroup: string,
+) => Promise<string | null>;