@oxy.so/protocol 1.0.1 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +675 -201
- package/NOTICE +7 -2
- package/dist/cjs/.tsbuildinfo +1 -1
- package/dist/cjs/auth/registrationPow.js +149 -0
- package/dist/cjs/index.js +9 -1
- package/dist/cjs/platform/crypto.js +6 -10
- package/dist/cjs/platform/crypto.native.js +14 -46
- package/dist/cjs/platform/optionalPeer.js +22 -0
- package/dist/cjs/platform/random.js +18 -0
- package/dist/cjs/platform/random.native.js +52 -0
- package/dist/cjs/random.js +25 -0
- package/dist/esm/.tsbuildinfo +1 -1
- package/dist/esm/auth/registrationPow.js +143 -0
- package/dist/esm/index.js +4 -0
- package/dist/esm/platform/crypto.js +4 -9
- package/dist/esm/platform/crypto.native.js +10 -43
- package/dist/esm/platform/optionalPeer.js +19 -0
- package/dist/esm/platform/random.js +15 -0
- package/dist/esm/platform/random.native.js +48 -0
- package/dist/esm/random.js +19 -0
- package/dist/types/.tsbuildinfo +1 -1
- package/dist/types/auth/registrationPow.d.ts +102 -0
- package/dist/types/index.d.ts +1 -0
- package/dist/types/platform/crypto.d.ts +1 -7
- package/dist/types/platform/crypto.native.d.ts +2 -10
- package/dist/types/platform/optionalPeer.d.ts +9 -0
- package/dist/types/platform/random.d.ts +13 -0
- package/dist/types/platform/random.native.d.ts +33 -0
- package/dist/types/random.d.ts +19 -0
- package/package.json +21 -4
- package/src/__tests__/randomEntry.test.ts +107 -0
- package/src/__tests__/registrationPow.test.ts +73 -0
- package/src/auth/registrationPow.ts +146 -0
- package/src/index.ts +10 -0
- package/src/platform/crypto.native.ts +10 -48
- package/src/platform/crypto.ts +4 -9
- package/src/platform/optionalPeer.ts +23 -0
- package/src/platform/random.native.ts +56 -0
- package/src/platform/random.ts +18 -0
- package/src/random.ts +20 -0
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
* Those three RN modules are declared OPTIONAL peer dependencies in
|
|
25
25
|
* `package.json`. A static `import` contradicts that: an optional peer that is
|
|
26
26
|
* omitted does not degrade, it fails to RESOLVE, and Metro aborts the whole
|
|
27
|
-
* bundle. Because `@oxy.so/core`
|
|
27
|
+
* bundle. Because `@oxy.so/core` imports `@oxy.so/protocol`
|
|
28
28
|
* from its root entry, this file is in the eager graph of EVERY React Native
|
|
29
29
|
* app on `@oxy.so/core` — so a single undeclared optional peer broke the native
|
|
30
30
|
* bundle of every app that did not happen to install it, with a resolution
|
|
@@ -54,6 +54,8 @@
|
|
|
54
54
|
|
|
55
55
|
import { requireOptionalNativeModule } from 'expo-modules-core';
|
|
56
56
|
import type { ExpoCryptoLike, ExpoSecureStoreLike, SharedIdentityBridge } from './expoTypes';
|
|
57
|
+
import { missingOptionalPeerError } from './optionalPeer';
|
|
58
|
+
import { requireExpoCrypto } from './random.native';
|
|
57
59
|
|
|
58
60
|
// Re-export the interfaces so consumers can import them from the same
|
|
59
61
|
// entry-point they use for the loaders (mirrors the default variant).
|
|
@@ -77,14 +79,6 @@ type AsyncStorageLike = {
|
|
|
77
79
|
removeItem: (key: string) => Promise<void>;
|
|
78
80
|
};
|
|
79
81
|
|
|
80
|
-
let expoCryptoModule: ExpoCryptoLike | null = null;
|
|
81
|
-
let expoCryptoError: unknown;
|
|
82
|
-
try {
|
|
83
|
-
expoCryptoModule = require('expo-crypto') as ExpoCryptoLike;
|
|
84
|
-
} catch (error) {
|
|
85
|
-
expoCryptoError = error;
|
|
86
|
-
}
|
|
87
|
-
|
|
88
82
|
let secureStoreModule: ExpoSecureStoreLike | null = null;
|
|
89
83
|
let secureStoreError: unknown;
|
|
90
84
|
try {
|
|
@@ -107,23 +101,6 @@ try {
|
|
|
107
101
|
asyncStorageError = error;
|
|
108
102
|
}
|
|
109
103
|
|
|
110
|
-
/**
|
|
111
|
-
* Actionable error for a missing optional peer. Carries the underlying Metro
|
|
112
|
-
* resolution message so the failure is never silent — the `catch` above only
|
|
113
|
-
* defers the report to the point where the capability is actually needed.
|
|
114
|
-
*/
|
|
115
|
-
function missingOptionalPeerError(packageName: string, capability: string, cause: unknown): Error {
|
|
116
|
-
const sentences = [
|
|
117
|
-
`[oxy.protocol.crypto] '${packageName}' is not installed, so ${capability} is unavailable in this app.`,
|
|
118
|
-
'It is an optional peer dependency of @oxy.so/protocol that the React Native runtime needs —',
|
|
119
|
-
`install it with \`npx expo install ${packageName}\`.`,
|
|
120
|
-
];
|
|
121
|
-
if (cause instanceof Error) {
|
|
122
|
-
sentences.push(`Underlying error: ${cause.message}`);
|
|
123
|
-
}
|
|
124
|
-
return new Error(sentences.join(' '));
|
|
125
|
-
}
|
|
126
|
-
|
|
127
104
|
// ---------------------------------------------------------------------------
|
|
128
105
|
// Node `crypto` — never available in RN.
|
|
129
106
|
// ---------------------------------------------------------------------------
|
|
@@ -149,10 +126,7 @@ export async function loadNodeCrypto(): Promise<typeof import('crypto')> {
|
|
|
149
126
|
// ---------------------------------------------------------------------------
|
|
150
127
|
|
|
151
128
|
export async function loadExpoCrypto(): Promise<ExpoCryptoLike> {
|
|
152
|
-
|
|
153
|
-
throw missingOptionalPeerError('expo-crypto', 'React Native cryptography', expoCryptoError);
|
|
154
|
-
}
|
|
155
|
-
return expoCryptoModule;
|
|
129
|
+
return requireExpoCrypto('React Native cryptography');
|
|
156
130
|
}
|
|
157
131
|
|
|
158
132
|
// ---------------------------------------------------------------------------
|
|
@@ -188,24 +162,12 @@ export async function loadAsyncStorage(): Promise<{ default: AsyncStorageLike }>
|
|
|
188
162
|
return { default: asyncStorageModule };
|
|
189
163
|
}
|
|
190
164
|
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
* than a dynamic `import()`.
|
|
198
|
-
*/
|
|
199
|
-
export function getRandomBytesRN(byteCount: number): Uint8Array {
|
|
200
|
-
if (!expoCryptoModule) {
|
|
201
|
-
throw missingOptionalPeerError(
|
|
202
|
-
'expo-crypto',
|
|
203
|
-
'the React Native CSPRNG (crypto.getRandomValues)',
|
|
204
|
-
expoCryptoError,
|
|
205
|
-
);
|
|
206
|
-
}
|
|
207
|
-
return expoCryptoModule.getRandomBytes(byteCount);
|
|
208
|
-
}
|
|
165
|
+
// Synchronous random bytes (and the single `expo-crypto` resolution) live in
|
|
166
|
+
// the dependency-free `./random.native` module, so `@oxy.so/core`'s crypto
|
|
167
|
+
// polyfill can load them through `@oxy.so/protocol/random` without evaluating
|
|
168
|
+
// any crypto library first. The explicit `.native` specifier keeps tsc and
|
|
169
|
+
// Metro pointed at the same file.
|
|
170
|
+
export { getRandomBytesRN } from './random.native';
|
|
209
171
|
|
|
210
172
|
// ---------------------------------------------------------------------------
|
|
211
173
|
// Shared identity bridge — `@oxy.so/expo-oxy-identity` (native-only, OPTIONAL).
|
package/src/platform/crypto.ts
CHANGED
|
@@ -148,15 +148,10 @@ export async function loadAsyncStorage(): Promise<{
|
|
|
148
148
|
throw notReactNativeError('@react-native-async-storage/async-storage');
|
|
149
149
|
}
|
|
150
150
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
* `crypto.getRandomValues` respectively) — callers should use those.
|
|
156
|
-
*/
|
|
157
|
-
export function getRandomBytesRN(_byteCount: number): Uint8Array {
|
|
158
|
-
throw notReactNativeError('expo-crypto.getRandomBytes (sync)');
|
|
159
|
-
}
|
|
151
|
+
// Synchronous random bytes live in the dependency-free `./random` module so
|
|
152
|
+
// `@oxy.so/core`'s crypto polyfill can load them through the
|
|
153
|
+
// `@oxy.so/protocol/random` entry without evaluating any crypto library first.
|
|
154
|
+
export { getRandomBytesRN } from './random';
|
|
160
155
|
|
|
161
156
|
// ---------------------------------------------------------------------------
|
|
162
157
|
// Shared identity bridge — `@oxy.so/expo-oxy-identity` (native-only).
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Actionable error for a missing optional React Native peer.
|
|
3
|
+
*
|
|
4
|
+
* Shared by the React Native platform variants (`crypto.native.ts`,
|
|
5
|
+
* `random.native.ts`). It carries the underlying Metro resolution message so
|
|
6
|
+
* the failure is never silent: the variants' `try { require(...) } catch` only
|
|
7
|
+
* defers the report to the point where the capability is actually used.
|
|
8
|
+
*/
|
|
9
|
+
export function missingOptionalPeerError(
|
|
10
|
+
packageName: string,
|
|
11
|
+
capability: string,
|
|
12
|
+
cause: unknown,
|
|
13
|
+
): Error {
|
|
14
|
+
const sentences = [
|
|
15
|
+
`[oxy.protocol.crypto] '${packageName}' is not installed, so ${capability} is unavailable in this app.`,
|
|
16
|
+
'It is an optional peer dependency of @oxy.so/protocol that the React Native runtime needs —',
|
|
17
|
+
`install it with \`npx expo install ${packageName}\`.`,
|
|
18
|
+
];
|
|
19
|
+
if (cause instanceof Error) {
|
|
20
|
+
sentences.push(`Underlying error: ${cause.message}`);
|
|
21
|
+
}
|
|
22
|
+
return new Error(sentences.join(' '));
|
|
23
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Synchronous CSPRNG source — React Native variant.
|
|
3
|
+
*
|
|
4
|
+
* Companion to `./random.ts`; Metro substitutes this file on iOS / Android
|
|
5
|
+
* (see `./crypto.ts` for how the `.native` split works).
|
|
6
|
+
*
|
|
7
|
+
* This module is deliberately tiny and imports NOTHING but `expo-crypto`: it
|
|
8
|
+
* backs `@oxy.so/core`'s `globalThis.crypto.getRandomValues` polyfill, which
|
|
9
|
+
* must be fully installed before any module that captures `globalThis.crypto`
|
|
10
|
+
* at evaluation time (`@noble/hashes` 1.x's `crypto.js` does exactly that) is
|
|
11
|
+
* evaluated. Reaching a crypto library from here would let that library
|
|
12
|
+
* capture the missing global first and throw
|
|
13
|
+
* `crypto.getRandomValues must be defined` for the lifetime of the app.
|
|
14
|
+
*
|
|
15
|
+
* `expo-crypto` is an OPTIONAL peer, so it is resolved with a string-literal
|
|
16
|
+
* `require` inside a `try` (Metro's optional-dependency form; see
|
|
17
|
+
* `./crypto.native.ts`), and the load stays synchronous because
|
|
18
|
+
* `getRandomValues` cannot await.
|
|
19
|
+
*/
|
|
20
|
+
|
|
21
|
+
import type { ExpoCryptoLike } from './expoTypes';
|
|
22
|
+
import { missingOptionalPeerError } from './optionalPeer';
|
|
23
|
+
|
|
24
|
+
declare const require: (moduleName: string) => unknown;
|
|
25
|
+
|
|
26
|
+
let expoCryptoModule: ExpoCryptoLike | null = null;
|
|
27
|
+
let expoCryptoError: unknown;
|
|
28
|
+
try {
|
|
29
|
+
expoCryptoModule = require('expo-crypto') as ExpoCryptoLike;
|
|
30
|
+
} catch (error) {
|
|
31
|
+
expoCryptoError = error;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* The resolved `expo-crypto` module, or an actionable error naming the missing
|
|
36
|
+
* peer and the capability that needed it. Shared with `./crypto.native.ts` so
|
|
37
|
+
* the optional peer is resolved in exactly one place.
|
|
38
|
+
*/
|
|
39
|
+
export function requireExpoCrypto(capability: string): ExpoCryptoLike {
|
|
40
|
+
if (!expoCryptoModule) {
|
|
41
|
+
throw missingOptionalPeerError('expo-crypto', capability, expoCryptoError);
|
|
42
|
+
}
|
|
43
|
+
return expoCryptoModule;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Synchronous random bytes via `expo-crypto.getRandomBytes`.
|
|
48
|
+
*
|
|
49
|
+
* Synchronous by contract: `@oxy.so/core`'s crypto polyfill uses this to back
|
|
50
|
+
* `globalThis.crypto.getRandomValues`, which cannot await.
|
|
51
|
+
*/
|
|
52
|
+
export function getRandomBytesRN(byteCount: number): Uint8Array {
|
|
53
|
+
return requireExpoCrypto('the React Native CSPRNG (crypto.getRandomValues)').getRandomBytes(
|
|
54
|
+
byteCount,
|
|
55
|
+
);
|
|
56
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Synchronous CSPRNG source — default variant (Node.js, browsers, bundlers).
|
|
3
|
+
*
|
|
4
|
+
* Companion to `./random.native.ts`, which Metro substitutes on iOS / Android.
|
|
5
|
+
* Node and browsers own a native CSPRNG (`node:crypto`, `globalThis.crypto`),
|
|
6
|
+
* so `getRandomBytesRN` only exists here to keep both variants' surfaces
|
|
7
|
+
* identical, and throws if anything reaches it outside React Native.
|
|
8
|
+
*
|
|
9
|
+
* Like its sibling, this module imports nothing: it is part of the
|
|
10
|
+
* `@oxy.so/protocol/random` entry that `@oxy.so/core`'s crypto polyfill loads
|
|
11
|
+
* BEFORE any crypto library is evaluated.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
export function getRandomBytesRN(_byteCount: number): Uint8Array {
|
|
15
|
+
throw new Error(
|
|
16
|
+
"[oxy.protocol.crypto] Tried to load 'expo-crypto.getRandomBytes (sync)' outside React Native. This module is only available in a React Native runtime; bundling routed this consumer to the default (Node/web) variant. This indicates a missing platform gate (`isReactNative()`) in the calling code.",
|
|
17
|
+
);
|
|
18
|
+
}
|
package/src/random.ts
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `@oxy.so/protocol/random` — the platform randomness source, and nothing else.
|
|
3
|
+
*
|
|
4
|
+
* `@oxy.so/core`'s crypto polyfill installs `globalThis.crypto.getRandomValues`
|
|
5
|
+
* on hosts that lack it (React Native / Hermes). `@noble/hashes` 1.x captures
|
|
6
|
+
* `globalThis.crypto` ONCE, when its `crypto.js` is evaluated, so the polyfill
|
|
7
|
+
* has to be installed before any `@noble/*` module is evaluated. ES imports are
|
|
8
|
+
* evaluated before the importing module's body, so whatever the polyfill
|
|
9
|
+
* imports is evaluated first: importing the ROOT entry (which reaches
|
|
10
|
+
* `@noble/curves` through the envelope signer) let noble capture `undefined`
|
|
11
|
+
* and broke identity creation on Android.
|
|
12
|
+
*
|
|
13
|
+
* This entry therefore reaches no crypto library, no `@oxy.so/*` package and no
|
|
14
|
+
* third-party module other than the optional `expo-crypto` peer (RN variant
|
|
15
|
+
* only). `src/__tests__/randomEntry.test.ts` walks its module graph to keep it
|
|
16
|
+
* that way.
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
export { isNodeJS, isReactNative } from './platform/platform';
|
|
20
|
+
export { getRandomBytesRN } from './platform/random';
|