@open-e2ee/signal-protocol-sdk 0.1.0-alpha.6 → 0.1.0-alpha.7

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.
Files changed (179) hide show
  1. package/ARCHITECTURE.md +1 -1
  2. package/CHANGELOG.md +196 -1
  3. package/dist/client/client.d.ts +32 -28
  4. package/dist/client/client.d.ts.map +1 -1
  5. package/dist/client/client.js +120 -72
  6. package/dist/client/client.js.map +1 -1
  7. package/dist/client/compose.d.ts +6 -1
  8. package/dist/client/compose.d.ts.map +1 -1
  9. package/dist/client/compose.js +2 -0
  10. package/dist/client/compose.js.map +1 -1
  11. package/dist/client/config.d.ts +41 -17
  12. package/dist/client/config.d.ts.map +1 -1
  13. package/dist/client/config.js.map +1 -1
  14. package/dist/client/endorsement-manager.d.ts +4 -0
  15. package/dist/client/endorsement-manager.d.ts.map +1 -1
  16. package/dist/client/endorsement-manager.js +9 -0
  17. package/dist/client/endorsement-manager.js.map +1 -1
  18. package/dist/client/groups.d.ts +29 -29
  19. package/dist/client/groups.d.ts.map +1 -1
  20. package/dist/client/groups.js +54 -37
  21. package/dist/client/groups.js.map +1 -1
  22. package/dist/client/signal-service-cipher.d.ts +5 -1
  23. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  24. package/dist/client/signal-service-cipher.js +7 -1
  25. package/dist/client/signal-service-cipher.js.map +1 -1
  26. package/dist/groups/index.d.ts +4 -4
  27. package/dist/groups/index.d.ts.map +1 -1
  28. package/dist/groups/index.js +3 -3
  29. package/dist/groups/index.js.map +1 -1
  30. package/dist/index.d.ts +5 -5
  31. package/dist/index.d.ts.map +1 -1
  32. package/dist/index.js +3 -3
  33. package/dist/index.js.map +1 -1
  34. package/dist/internal/groups/access-control.d.ts +170 -0
  35. package/dist/internal/groups/access-control.d.ts.map +1 -0
  36. package/dist/internal/groups/access-control.js +284 -0
  37. package/dist/internal/groups/access-control.js.map +1 -0
  38. package/dist/internal/groups/change-actions.d.ts +57 -0
  39. package/dist/internal/groups/change-actions.d.ts.map +1 -0
  40. package/dist/internal/groups/change-actions.js +827 -0
  41. package/dist/internal/groups/change-actions.js.map +1 -0
  42. package/dist/internal/groups/change-authorization.d.ts +16 -0
  43. package/dist/internal/groups/change-authorization.d.ts.map +1 -0
  44. package/dist/internal/groups/change-authorization.js +120 -0
  45. package/dist/internal/groups/change-authorization.js.map +1 -0
  46. package/dist/internal/{groups-v2 → groups}/encrypted-state.d.ts +12 -2
  47. package/dist/internal/groups/encrypted-state.d.ts.map +1 -0
  48. package/dist/internal/{groups-v2 → groups}/encrypted-state.js +122 -22
  49. package/dist/internal/groups/encrypted-state.js.map +1 -0
  50. package/dist/internal/groups/group-id.d.ts +9 -9
  51. package/dist/internal/groups/group-id.d.ts.map +1 -1
  52. package/dist/internal/groups/group-id.js +11 -12
  53. package/dist/internal/groups/group-id.js.map +1 -1
  54. package/dist/internal/groups/index.d.ts +16 -6
  55. package/dist/internal/groups/index.d.ts.map +1 -1
  56. package/dist/internal/groups/index.js +9 -1
  57. package/dist/internal/groups/index.js.map +1 -1
  58. package/dist/internal/groups/invite-link.d.ts.map +1 -0
  59. package/dist/internal/groups/invite-link.js.map +1 -0
  60. package/dist/internal/{groups-v2 → groups}/manager.d.ts +175 -40
  61. package/dist/internal/groups/manager.d.ts.map +1 -0
  62. package/dist/internal/groups/manager.js +1862 -0
  63. package/dist/internal/groups/manager.js.map +1 -0
  64. package/dist/internal/groups/sdk-store.d.ts +32 -0
  65. package/dist/internal/groups/sdk-store.d.ts.map +1 -0
  66. package/dist/internal/groups/sdk-store.js +111 -0
  67. package/dist/internal/groups/sdk-store.js.map +1 -0
  68. package/dist/internal/groups/server-engine.d.ts +52 -0
  69. package/dist/internal/groups/server-engine.d.ts.map +1 -0
  70. package/dist/internal/groups/server-engine.js +1126 -0
  71. package/dist/internal/groups/server-engine.js.map +1 -0
  72. package/dist/internal/groups/trust-root.d.ts +32 -0
  73. package/dist/internal/groups/trust-root.d.ts.map +1 -0
  74. package/dist/internal/groups/trust-root.js +91 -0
  75. package/dist/internal/groups/trust-root.js.map +1 -0
  76. package/dist/internal/{groups-v2 → groups}/types.d.ts +188 -46
  77. package/dist/internal/groups/types.d.ts.map +1 -0
  78. package/dist/internal/{groups-v2 → groups}/types.js +3 -2
  79. package/dist/internal/groups/types.js.map +1 -0
  80. package/dist/internal/groups/wire.d.ts +68 -0
  81. package/dist/internal/groups/wire.d.ts.map +1 -0
  82. package/dist/internal/groups/wire.js +708 -0
  83. package/dist/internal/groups/wire.js.map +1 -0
  84. package/dist/internal/protocol/sender-keys/index.d.ts +1 -1
  85. package/dist/internal/protocol/sender-keys/manager.d.ts +1 -1
  86. package/dist/internal/protocol/sender-keys/manager.js +1 -1
  87. package/dist/internal/protocol/zk/groups/auth-credential.d.ts +9 -7
  88. package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
  89. package/dist/internal/protocol/zk/groups/auth-credential.js +68 -29
  90. package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
  91. package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
  92. package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
  93. package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
  94. package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -0
  95. package/dist/internal/protocol/zk/groups/uid-struct.d.ts.map +1 -1
  96. package/dist/internal/protocol/zk/groups/uid-struct.js +4 -0
  97. package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
  98. package/dist/layers.d.ts +1 -1
  99. package/dist/layers.js +3 -3
  100. package/dist/layers.js.map +1 -1
  101. package/dist/remote/relay/convex/group-server.d.ts +23 -21
  102. package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
  103. package/dist/remote/relay/convex/group-server.js +49 -21
  104. package/dist/remote/relay/convex/group-server.js.map +1 -1
  105. package/dist/remote/relay/convex/relay.d.ts +16 -8
  106. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  107. package/dist/remote/relay/convex/relay.js +72 -13
  108. package/dist/remote/relay/convex/relay.js.map +1 -1
  109. package/dist/remote/relay/convex/server/index.d.ts +2 -0
  110. package/dist/remote/relay/convex/server/index.d.ts.map +1 -0
  111. package/dist/remote/relay/convex/server/index.js +2 -0
  112. package/dist/remote/relay/convex/server/index.js.map +1 -0
  113. package/dist/remote/relay/convex/server.d.ts +150 -0
  114. package/dist/remote/relay/convex/server.d.ts.map +1 -0
  115. package/dist/remote/relay/convex/server.js +506 -0
  116. package/dist/remote/relay/convex/server.js.map +1 -0
  117. package/dist/remote/relay/index.d.ts +1 -1
  118. package/dist/remote/relay/index.d.ts.map +1 -1
  119. package/dist/remote/relay/index.js.map +1 -1
  120. package/dist/remote/relay/mock/adapter.d.ts +31 -13
  121. package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
  122. package/dist/remote/relay/mock/adapter.js +66 -61
  123. package/dist/remote/relay/mock/adapter.js.map +1 -1
  124. package/dist/remote/relay/mock/group-server.d.ts +9 -0
  125. package/dist/remote/relay/mock/group-server.d.ts.map +1 -0
  126. package/dist/remote/relay/mock/group-server.js +9 -0
  127. package/dist/remote/relay/mock/group-server.js.map +1 -0
  128. package/dist/remote/relay/types.d.ts +45 -14
  129. package/dist/remote/relay/types.d.ts.map +1 -1
  130. package/dist/types/api.d.ts +2 -2
  131. package/dist/types/api.d.ts.map +1 -1
  132. package/docs/DEVIATIONS.md +35 -32
  133. package/docs/PACKAGE_SURFACE.md +5 -0
  134. package/docs/api/classes/EndorsementManager.md +18 -0
  135. package/docs/api/classes/SignalProtocolClient.md +77 -77
  136. package/docs/api/functions/createGroupId.md +1 -1
  137. package/docs/api/functions/decodeGroupTrustRoot.md +21 -0
  138. package/docs/api/functions/encodeGroupTrustRoot.md +28 -0
  139. package/docs/api/functions/extractGroupId.md +2 -2
  140. package/docs/api/functions/isGroupId.md +1 -1
  141. package/docs/api/interfaces/GroupTrustRoot.md +33 -0
  142. package/docs/api/interfaces/IRelayGroupServer.md +60 -0
  143. package/docs/api/interfaces/ISignalProtocolClient.md +1 -1
  144. package/docs/api/interfaces/ISignalProtocolRelayServer.md +8 -0
  145. package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +66 -28
  146. package/docs/api/interfaces/SignalProtocolClientConfig.md +82 -26
  147. package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +16 -0
  148. package/docs/api/type-aliases/GroupId.md +2 -2
  149. package/docs/api/variables/GROUP_ID_PREFIX.md +11 -0
  150. package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +11 -0
  151. package/groups/README.md +16 -5
  152. package/package.json +13 -2
  153. package/remote/relay/convex/README.md +6 -0
  154. package/remote/relay/convex/server/README.md +146 -0
  155. package/scripts/oe-groups.mjs +142 -0
  156. package/dist/internal/groups-v2/access-control.d.ts +0 -108
  157. package/dist/internal/groups-v2/access-control.d.ts.map +0 -1
  158. package/dist/internal/groups-v2/access-control.js +0 -191
  159. package/dist/internal/groups-v2/access-control.js.map +0 -1
  160. package/dist/internal/groups-v2/change-actions.d.ts +0 -40
  161. package/dist/internal/groups-v2/change-actions.d.ts.map +0 -1
  162. package/dist/internal/groups-v2/change-actions.js +0 -363
  163. package/dist/internal/groups-v2/change-actions.js.map +0 -1
  164. package/dist/internal/groups-v2/encrypted-state.d.ts.map +0 -1
  165. package/dist/internal/groups-v2/encrypted-state.js.map +0 -1
  166. package/dist/internal/groups-v2/index.d.ts +0 -19
  167. package/dist/internal/groups-v2/index.d.ts.map +0 -1
  168. package/dist/internal/groups-v2/index.js +0 -11
  169. package/dist/internal/groups-v2/index.js.map +0 -1
  170. package/dist/internal/groups-v2/invite-link.d.ts.map +0 -1
  171. package/dist/internal/groups-v2/invite-link.js.map +0 -1
  172. package/dist/internal/groups-v2/manager.d.ts.map +0 -1
  173. package/dist/internal/groups-v2/manager.js +0 -1095
  174. package/dist/internal/groups-v2/manager.js.map +0 -1
  175. package/dist/internal/groups-v2/types.d.ts.map +0 -1
  176. package/dist/internal/groups-v2/types.js.map +0 -1
  177. package/docs/api/variables/GROUP_V2_PREFIX.md +0 -11
  178. /package/dist/internal/{groups-v2 → groups}/invite-link.d.ts +0 -0
  179. /package/dist/internal/{groups-v2 → groups}/invite-link.js +0 -0
@@ -0,0 +1,708 @@
1
+ /**
2
+ * Group wire serialization
3
+ *
4
+ * The group transport uses JSON with explicit byte markers. These helpers are
5
+ * shared by clients and the executable reference server so accepted Actions
6
+ * can be stored and signed byte-for-byte.
7
+ *
8
+ * @module groups/wire
9
+ */
10
+ import { bytesToHex, hexToBytes } from '../../encoding/hex.js';
11
+ import { EnabledState, } from './types.js';
12
+ import { isInviteLinkAccessRequirement, isRoleAccessRequirement, isStoredMemberRole, satisfiesLiveGroupAdministratorInvariant, } from './access-control.js';
13
+ import { SERVICE_ID_ACI, SERVICE_ID_PNI, } from '../protocol/zk/groups/uid-struct.js';
14
+ import { RistrettoPoint } from '../protocol/zk/proofs/sho.js';
15
+ const ENCRYPTED_CHANGE_ARRAY_ACTION_KEYS = [
16
+ 'newMembers',
17
+ 'deleteMembers',
18
+ 'modifyMemberRoles',
19
+ 'modifiedProfileKeys',
20
+ 'newPendingMembers',
21
+ 'deletePendingMembers',
22
+ 'promotePendingMembers',
23
+ 'newRequestingMembers',
24
+ 'deleteRequestingMembers',
25
+ 'promoteRequestingMembers',
26
+ 'newBannedMembers',
27
+ 'deleteBannedMembers',
28
+ 'promotePendingPniAciMembers',
29
+ 'modifyMemberLabels',
30
+ ];
31
+ const ENCRYPTED_CHANGE_SCALAR_ACTION_KEYS = [
32
+ 'newTitle',
33
+ 'newAvatar',
34
+ 'newTimer',
35
+ 'newAttributeAccess',
36
+ 'newMemberAccess',
37
+ 'newInviteLinkAccess',
38
+ 'newMemberLabelAccess',
39
+ 'newInviteLinkPassword',
40
+ 'newDescription',
41
+ 'newIsAnnouncementGroup',
42
+ 'terminate',
43
+ ];
44
+ const ENCRYPTED_CHANGE_MINIMUM_EPOCH = {
45
+ newMembers: 0,
46
+ deleteMembers: 0,
47
+ modifyMemberRoles: 0,
48
+ modifiedProfileKeys: 0,
49
+ newPendingMembers: 0,
50
+ deletePendingMembers: 0,
51
+ promotePendingMembers: 0,
52
+ newRequestingMembers: 0,
53
+ deleteRequestingMembers: 0,
54
+ promoteRequestingMembers: 0,
55
+ newBannedMembers: 0,
56
+ deleteBannedMembers: 0,
57
+ promotePendingPniAciMembers: 5,
58
+ modifyMemberLabels: 6,
59
+ newTitle: 0,
60
+ newAvatar: 0,
61
+ newTimer: 0,
62
+ newAttributeAccess: 0,
63
+ newMemberAccess: 0,
64
+ newInviteLinkAccess: 0,
65
+ newMemberLabelAccess: 0,
66
+ newInviteLinkPassword: 0,
67
+ newDescription: 0,
68
+ newIsAnnouncementGroup: 0,
69
+ terminate: 0,
70
+ };
71
+ const ENCRYPTED_CHANGE_KEYS = new Set([
72
+ 'sourceUserId',
73
+ 'groupId',
74
+ 'revision',
75
+ ...ENCRYPTED_CHANGE_ARRAY_ACTION_KEYS,
76
+ ...ENCRYPTED_CHANGE_SCALAR_ACTION_KEYS,
77
+ ]);
78
+ export function serializeGroupWire(value) {
79
+ const json = JSON.stringify(value, (_key, item) => item instanceof Uint8Array ? { __bytes: bytesToHex(item) } : item);
80
+ return new TextEncoder().encode(json);
81
+ }
82
+ export function deserializeGroupWire(bytes) {
83
+ return JSON.parse(new TextDecoder().decode(bytes), (_key, item) => {
84
+ if (item && typeof item === 'object' && '__bytes' in item) {
85
+ if (Object.keys(item).length !== 1 ||
86
+ typeof item.__bytes !== 'string') {
87
+ throw new Error('Byte marker must contain exactly one hexadecimal string');
88
+ }
89
+ return hexToBytes(item.__bytes);
90
+ }
91
+ return item;
92
+ });
93
+ }
94
+ export function serializeEncryptedGroup(group) {
95
+ return serializeGroupWire(group);
96
+ }
97
+ export function deserializeEncryptedGroup(bytes) {
98
+ return deserializeGroupWire(bytes);
99
+ }
100
+ export function serializeEncryptedGroupCreationSubmission(group) {
101
+ return serializeGroupWire(group);
102
+ }
103
+ export function deserializeEncryptedGroupCreationSubmission(bytes) {
104
+ return deserializeGroupWire(bytes);
105
+ }
106
+ /**
107
+ * Remove server-derived creation fields from an encrypted candidate state.
108
+ *
109
+ * Callers cannot smuggle pre-existing requesting or banned entries into
110
+ * version zero.
111
+ */
112
+ export function toEncryptedGroupCreationSubmission(group) {
113
+ if (group.membersPendingAdminApproval.length !== 0) {
114
+ throw new Error('Group creation submission must not contain requesting members');
115
+ }
116
+ if (group.membersBanned.length !== 0) {
117
+ throw new Error('Group creation submission must not contain banned members');
118
+ }
119
+ return {
120
+ ...group,
121
+ membersPendingProfileKey: group.membersPendingProfileKey.map(({ member }) => ({
122
+ userId: member.userId,
123
+ role: member.role,
124
+ })),
125
+ membersPendingAdminApproval: [],
126
+ membersBanned: [],
127
+ };
128
+ }
129
+ /**
130
+ * Serialize the exact S14 commitment signed for a full-state response.
131
+ *
132
+ * `canonicalGroupState` is already the canonical serialized EncryptedGroup.
133
+ * Wrapping the tuple in the group wire format makes the three variable-width
134
+ * values unambiguous while preserving the state bytes exactly as served.
135
+ */
136
+ export function serializeGroupBaseline(groupId, version, canonicalGroupState) {
137
+ if (!Number.isSafeInteger(version) || version < 0) {
138
+ throw new Error('Baseline version must be a non-negative safe integer');
139
+ }
140
+ return serializeGroupWire({
141
+ groupId,
142
+ version,
143
+ canonicalGroupState,
144
+ });
145
+ }
146
+ /** Serialize Revision 16's exact S7 signature commitment. */
147
+ export function serializeGroupChangeCommitment(changeEpoch, actions) {
148
+ if (!Number.isInteger(changeEpoch) ||
149
+ changeEpoch < 0 ||
150
+ changeEpoch > 0xffffffff) {
151
+ throw new Error('Change epoch must be an unsigned 32-bit integer');
152
+ }
153
+ if (!(actions instanceof Uint8Array)) {
154
+ throw new Error('Committed Actions must be bytes');
155
+ }
156
+ return serializeGroupWire({
157
+ changeEpoch,
158
+ actions,
159
+ });
160
+ }
161
+ export function serializeEncryptedGroupChange(change) {
162
+ return serializeGroupWire(change);
163
+ }
164
+ export function deserializeEncryptedGroupChange(bytes) {
165
+ return deserializeGroupWire(bytes);
166
+ }
167
+ /** Compute Revision 19's authoritative compatibility epoch from populated actions. */
168
+ export function requiredGroupChangeEpoch(change) {
169
+ let required = 0;
170
+ for (const key of ENCRYPTED_CHANGE_ARRAY_ACTION_KEYS) {
171
+ if (change[key].length > 0) {
172
+ required = Math.max(required, ENCRYPTED_CHANGE_MINIMUM_EPOCH[key]);
173
+ }
174
+ }
175
+ for (const key of ENCRYPTED_CHANGE_SCALAR_ACTION_KEYS) {
176
+ if (change[key] !== undefined) {
177
+ required = Math.max(required, ENCRYPTED_CHANGE_MINIMUM_EPOCH[key]);
178
+ }
179
+ }
180
+ return required;
181
+ }
182
+ /** Count populated actions, including every element of repeated action fields. */
183
+ export function countGroupChangeActions(change) {
184
+ let count = 0;
185
+ for (const key of ENCRYPTED_CHANGE_ARRAY_ACTION_KEYS) {
186
+ count += change[key].length;
187
+ }
188
+ for (const key of ENCRYPTED_CHANGE_SCALAR_ACTION_KEYS) {
189
+ count += Number(change[key] !== undefined);
190
+ }
191
+ return count;
192
+ }
193
+ /**
194
+ * Reject unknown, missing-array, and actionless signed Actions values.
195
+ *
196
+ * This representation-level check is shared by the server and client so an
197
+ * unknown field cannot be applied by one side and silently discarded by the
198
+ * other.
199
+ */
200
+ export function assertRecognizedEncryptedGroupChange(change) {
201
+ if (typeof change !== 'object' || change === null) {
202
+ throw new Error('Actions must be an object');
203
+ }
204
+ for (const key of Object.keys(change)) {
205
+ if (!ENCRYPTED_CHANGE_KEYS.has(key)) {
206
+ throw new Error(`Actions contain unsupported field ${key}`);
207
+ }
208
+ }
209
+ for (const key of ENCRYPTED_CHANGE_ARRAY_ACTION_KEYS) {
210
+ if (!Array.isArray(change[key])) {
211
+ throw new Error(`Actions.${key} must be an array`);
212
+ }
213
+ }
214
+ const hasArrayAction = ENCRYPTED_CHANGE_ARRAY_ACTION_KEYS.some((key) => change[key].length > 0);
215
+ const hasScalarAction = ENCRYPTED_CHANGE_SCALAR_ACTION_KEYS.some((key) => change[key] !== undefined);
216
+ if (!hasArrayAction && !hasScalarAction) {
217
+ throw new Error('Actions contain no action');
218
+ }
219
+ }
220
+ function assertExactActionFields(value, label, expectedFields) {
221
+ if (typeof value !== 'object' ||
222
+ value === null ||
223
+ Array.isArray(value) ||
224
+ value instanceof Uint8Array) {
225
+ throw new Error(`${label} must be an action object`);
226
+ }
227
+ const actual = Object.keys(value).sort();
228
+ const expected = [...expectedFields].sort();
229
+ if (actual.length !== expected.length ||
230
+ actual.some((field, index) => field !== expected[index])) {
231
+ throw new Error(`${label} has non-canonical fields: expected ${expected.join(', ')}, got ${actual.join(', ')}`);
232
+ }
233
+ }
234
+ /**
235
+ * Enforce §7.8's exact action surfaces.
236
+ *
237
+ * Server-derived fields must be absent in submissions and present in signed
238
+ * canonical Actions. Every other action field has one exact surface.
239
+ */
240
+ export function assertEncryptedGroupChangeForm(change, form) {
241
+ const canonical = form === 'canonical';
242
+ const check = (entries, label, fields) => {
243
+ entries.forEach((entry, index) => assertExactActionFields(entry, `${label}[${index}]`, fields));
244
+ };
245
+ check(change.newMembers, 'Actions.newMembers', [
246
+ 'aciCiphertext',
247
+ 'role',
248
+ 'profileKeyCiphertext',
249
+ 'presentation',
250
+ ...(canonical ? ['joinedAtRevision'] : []),
251
+ ]);
252
+ check(change.modifyMemberRoles, 'Actions.modifyMemberRoles', [
253
+ 'aciCiphertext',
254
+ 'role',
255
+ ]);
256
+ check(change.modifiedProfileKeys, 'Actions.modifiedProfileKeys', [
257
+ 'aciCiphertext',
258
+ 'profileKeyCiphertext',
259
+ 'presentation',
260
+ ]);
261
+ check(change.newPendingMembers, 'Actions.newPendingMembers', [
262
+ 'serviceIdCiphertext',
263
+ 'role',
264
+ ...(canonical ? ['addedByAciCiphertext', 'timestamp'] : []),
265
+ ]);
266
+ check(change.deletePendingMembers, 'Actions.deletePendingMembers', [
267
+ 'serviceIdCiphertext',
268
+ ]);
269
+ check(change.promotePendingMembers, 'Actions.promotePendingMembers', [
270
+ 'aciCiphertext',
271
+ 'profileKeyCiphertext',
272
+ 'presentation',
273
+ ...(canonical ? ['role', 'joinedAtRevision'] : []),
274
+ ]);
275
+ check(change.newRequestingMembers, 'Actions.newRequestingMembers', [
276
+ 'aciCiphertext',
277
+ 'profileKeyCiphertext',
278
+ 'presentation',
279
+ ...(canonical ? ['timestamp'] : []),
280
+ ]);
281
+ check(change.promoteRequestingMembers, 'Actions.promoteRequestingMembers', [
282
+ 'aciCiphertext',
283
+ 'role',
284
+ ]);
285
+ check(change.newBannedMembers, 'Actions.newBannedMembers', [
286
+ 'serviceIdCiphertext',
287
+ ...(canonical ? ['timestamp'] : []),
288
+ ]);
289
+ check(change.deleteBannedMembers, 'Actions.deleteBannedMembers', [
290
+ 'serviceIdCiphertext',
291
+ ]);
292
+ check(change.promotePendingPniAciMembers, 'Actions.promotePendingPniAciMembers', [
293
+ 'pniCiphertext',
294
+ 'aciCiphertext',
295
+ 'profileKeyCiphertext',
296
+ 'presentation',
297
+ ...(canonical ? ['role', 'joinedAtRevision'] : []),
298
+ ]);
299
+ check(change.modifyMemberLabels, 'Actions.modifyMemberLabels', [
300
+ 'aciCiphertext',
301
+ 'labelEmojiCiphertext',
302
+ 'labelStringCiphertext',
303
+ ]);
304
+ if (change.newAvatar !== undefined) {
305
+ assertExactActionFields(change.newAvatar, 'Actions.newAvatar', ['value']);
306
+ }
307
+ }
308
+ function assertByteArray(value, label, length) {
309
+ if (!(value instanceof Uint8Array) ||
310
+ (length !== undefined && value.length !== length)) {
311
+ throw new Error(`${label} must be ${length === undefined ? 'bytes' : `${length}-byte data`}`);
312
+ }
313
+ }
314
+ function assertCiphertextEncoding(value, label, kind) {
315
+ assertByteArray(value, label, 65);
316
+ if (kind === 'aci' && value[0] !== SERVICE_ID_ACI) {
317
+ throw new Error(`${label} must carry an ACI ciphertext`);
318
+ }
319
+ if (kind === 'pni' && value[0] !== SERVICE_ID_PNI) {
320
+ throw new Error(`${label} must carry a PNI ciphertext`);
321
+ }
322
+ if (kind === 'service-id' &&
323
+ value[0] !== SERVICE_ID_ACI &&
324
+ value[0] !== SERVICE_ID_PNI) {
325
+ throw new Error(`${label} must carry an ACI or PNI ciphertext`);
326
+ }
327
+ if (kind === 'profile-key' && value[0] !== 0) {
328
+ throw new Error(`${label} has an invalid reserved byte`);
329
+ }
330
+ try {
331
+ RistrettoPoint.fromBytes(value.slice(1, 33));
332
+ RistrettoPoint.fromBytes(value.slice(33, 65));
333
+ }
334
+ catch {
335
+ throw new Error(`${label} contains an invalid Ristretto ciphertext point`);
336
+ }
337
+ }
338
+ function assertBlobEncoding(value, label, allowEmpty = true) {
339
+ assertByteArray(value, label);
340
+ if (allowEmpty && value.length === 0)
341
+ return;
342
+ if (value.length < 65 ||
343
+ (value.length - 65) % 32 !== 0 ||
344
+ value[value.length - 1] !== 0) {
345
+ throw new Error(`${label} has an invalid encrypted-blob envelope`);
346
+ }
347
+ }
348
+ function assertTimestamp(value, label) {
349
+ if (!Number.isSafeInteger(value) || value < 0) {
350
+ throw new Error(`${label} is outside its §7.8 domain`);
351
+ }
352
+ }
353
+ /**
354
+ * Enforce Revision 16's complete encrypted Actions wire domain.
355
+ *
356
+ * This validator is shared by the accepting server and receiving client.
357
+ */
358
+ export function assertValidEncryptedGroupChangeWire(change, form) {
359
+ assertRecognizedEncryptedGroupChange(change);
360
+ assertEncryptedGroupChangeForm(change, form);
361
+ const canonical = form === 'canonical';
362
+ if (!Number.isSafeInteger(change.revision) || change.revision < 1) {
363
+ throw new Error('Actions.revision must be a positive safe integer');
364
+ }
365
+ if (change.sourceUserId !== undefined) {
366
+ assertCiphertextEncoding(change.sourceUserId, 'Actions.sourceUserId', 'service-id');
367
+ }
368
+ else if (canonical) {
369
+ throw new Error('Actions.sourceUserId is required in canonical form');
370
+ }
371
+ if (change.groupId !== undefined) {
372
+ assertByteArray(change.groupId, 'Actions.groupId', 32);
373
+ }
374
+ else if (canonical) {
375
+ throw new Error('Actions.groupId is required in canonical form');
376
+ }
377
+ if (change.terminate !== undefined && change.terminate !== true) {
378
+ throw new Error('Actions.terminate must be true when present');
379
+ }
380
+ const assertProfileKeyAction = (member, label) => {
381
+ assertCiphertextEncoding(member.aciCiphertext, `${label}.aciCiphertext`, 'aci');
382
+ assertCiphertextEncoding(member.profileKeyCiphertext, `${label}.profileKeyCiphertext`, 'profile-key');
383
+ assertByteArray(member.presentation, `${label}.presentation`);
384
+ };
385
+ for (const [index, member] of change.newMembers.entries()) {
386
+ const label = `Actions.newMembers[${index}]`;
387
+ assertProfileKeyAction(member, label);
388
+ if (!isStoredMemberRole(member.role)) {
389
+ throw new Error(`${label}.role is outside its stored-role domain`);
390
+ }
391
+ if (canonical && member.joinedAtRevision !== change.revision) {
392
+ throw new Error(`${label}.joinedAtRevision must equal the change revision`);
393
+ }
394
+ }
395
+ for (const [index, ciphertext] of change.deleteMembers.entries()) {
396
+ assertCiphertextEncoding(ciphertext, `Actions.deleteMembers[${index}]`, 'aci');
397
+ }
398
+ for (const [index, member] of change.modifyMemberRoles.entries()) {
399
+ const label = `Actions.modifyMemberRoles[${index}]`;
400
+ assertCiphertextEncoding(member.aciCiphertext, `${label}.aciCiphertext`, 'aci');
401
+ if (!isStoredMemberRole(member.role)) {
402
+ throw new Error(`${label}.role is outside its stored-role domain`);
403
+ }
404
+ }
405
+ for (const [index, member] of change.modifiedProfileKeys.entries()) {
406
+ assertProfileKeyAction(member, `Actions.modifiedProfileKeys[${index}]`);
407
+ }
408
+ for (const [index, member] of change.newPendingMembers.entries()) {
409
+ const label = `Actions.newPendingMembers[${index}]`;
410
+ assertCiphertextEncoding(member.serviceIdCiphertext, `${label}.serviceIdCiphertext`, 'service-id');
411
+ if (!isStoredMemberRole(member.role)) {
412
+ throw new Error(`${label}.role is outside its stored-role domain`);
413
+ }
414
+ if (canonical) {
415
+ assertCiphertextEncoding(member.addedByAciCiphertext, `${label}.addedByAciCiphertext`, 'aci');
416
+ assertTimestamp(member.timestamp, `${label}.timestamp`);
417
+ }
418
+ }
419
+ for (const [index, member] of change.deletePendingMembers.entries()) {
420
+ assertCiphertextEncoding(member.serviceIdCiphertext, `Actions.deletePendingMembers[${index}].serviceIdCiphertext`, 'service-id');
421
+ }
422
+ for (const [index, member] of change.promotePendingMembers.entries()) {
423
+ const label = `Actions.promotePendingMembers[${index}]`;
424
+ assertProfileKeyAction(member, label);
425
+ if (canonical &&
426
+ (!isStoredMemberRole(member.role) ||
427
+ member.joinedAtRevision !== change.revision)) {
428
+ throw new Error(`${label} has invalid server-derived fields`);
429
+ }
430
+ }
431
+ for (const [index, member] of change.newRequestingMembers.entries()) {
432
+ const label = `Actions.newRequestingMembers[${index}]`;
433
+ assertProfileKeyAction(member, label);
434
+ if (canonical) {
435
+ assertTimestamp(member.timestamp, `${label}.timestamp`);
436
+ }
437
+ }
438
+ for (const [index, ciphertext] of change.deleteRequestingMembers.entries()) {
439
+ assertCiphertextEncoding(ciphertext, `Actions.deleteRequestingMembers[${index}]`, 'aci');
440
+ }
441
+ for (const [index, member] of change.promoteRequestingMembers.entries()) {
442
+ const label = `Actions.promoteRequestingMembers[${index}]`;
443
+ assertCiphertextEncoding(member.aciCiphertext, `${label}.aciCiphertext`, 'aci');
444
+ if (!isStoredMemberRole(member.role)) {
445
+ throw new Error(`${label}.role is outside its stored-role domain`);
446
+ }
447
+ }
448
+ for (const [index, member] of change.newBannedMembers.entries()) {
449
+ const label = `Actions.newBannedMembers[${index}]`;
450
+ assertCiphertextEncoding(member.serviceIdCiphertext, `${label}.serviceIdCiphertext`, 'service-id');
451
+ if (canonical) {
452
+ assertTimestamp(member.timestamp, `${label}.timestamp`);
453
+ }
454
+ }
455
+ for (const [index, member] of change.deleteBannedMembers.entries()) {
456
+ assertCiphertextEncoding(member.serviceIdCiphertext, `Actions.deleteBannedMembers[${index}].serviceIdCiphertext`, 'service-id');
457
+ }
458
+ for (const [index, member] of change.promotePendingPniAciMembers.entries()) {
459
+ const label = `Actions.promotePendingPniAciMembers[${index}]`;
460
+ assertProfileKeyAction(member, label);
461
+ assertCiphertextEncoding(member.pniCiphertext, `${label}.pniCiphertext`, 'pni');
462
+ if (canonical &&
463
+ (!isStoredMemberRole(member.role) ||
464
+ member.joinedAtRevision !== change.revision)) {
465
+ throw new Error(`${label} has invalid server-derived fields`);
466
+ }
467
+ }
468
+ for (const [index, member] of change.modifyMemberLabels.entries()) {
469
+ const label = `Actions.modifyMemberLabels[${index}]`;
470
+ assertCiphertextEncoding(member.aciCiphertext, `${label}.aciCiphertext`, 'aci');
471
+ assertBlobEncoding(member.labelEmojiCiphertext, `${label}.labelEmojiCiphertext`);
472
+ assertBlobEncoding(member.labelStringCiphertext, `${label}.labelStringCiphertext`);
473
+ }
474
+ for (const [value, label] of [
475
+ [change.newTitle, 'Actions.newTitle'],
476
+ [change.newTimer, 'Actions.newTimer'],
477
+ [change.newDescription, 'Actions.newDescription'],
478
+ ]) {
479
+ if (value !== undefined) {
480
+ assertBlobEncoding(value, label, false);
481
+ }
482
+ }
483
+ if (change.newAvatar !== undefined &&
484
+ typeof change.newAvatar.value !== 'string') {
485
+ throw new Error('Actions.newAvatar.value must be a string');
486
+ }
487
+ for (const [value, label] of [
488
+ [change.newAttributeAccess, 'Actions.newAttributeAccess'],
489
+ [change.newMemberAccess, 'Actions.newMemberAccess'],
490
+ [change.newMemberLabelAccess, 'Actions.newMemberLabelAccess'],
491
+ ]) {
492
+ if (value !== undefined && !isRoleAccessRequirement(value)) {
493
+ throw new Error(`${label} is outside its access-control domain`);
494
+ }
495
+ }
496
+ if (change.newInviteLinkAccess !== undefined &&
497
+ !isInviteLinkAccessRequirement(change.newInviteLinkAccess)) {
498
+ throw new Error('Actions.newInviteLinkAccess is outside its access-control domain');
499
+ }
500
+ if (change.newIsAnnouncementGroup !== undefined &&
501
+ change.newIsAnnouncementGroup !== EnabledState.ENABLED &&
502
+ change.newIsAnnouncementGroup !== EnabledState.DISABLED) {
503
+ throw new Error('newIsAnnouncementGroup is outside its §7.8 domain');
504
+ }
505
+ if (change.newInviteLinkPassword !== undefined) {
506
+ if (!(change.newInviteLinkPassword instanceof Uint8Array)) {
507
+ throw new Error('Actions.newInviteLinkPassword must be bytes');
508
+ }
509
+ if (change.newInviteLinkPassword.length !== 16) {
510
+ throw new Error('newInviteLinkPassword must be exactly 16 bytes');
511
+ }
512
+ }
513
+ }
514
+ const ENCRYPTED_GROUP_FIELDS = [
515
+ 'publicKey',
516
+ 'title',
517
+ 'description',
518
+ 'avatarUrl',
519
+ 'disappearingMessagesTimer',
520
+ 'accessControl',
521
+ 'version',
522
+ 'members',
523
+ 'membersPendingProfileKey',
524
+ 'membersPendingAdminApproval',
525
+ 'inviteLinkPassword',
526
+ 'announcementsOnly',
527
+ 'membersBanned',
528
+ 'terminated',
529
+ ];
530
+ function assertValidEncryptedGroupWireForm(group, form) {
531
+ assertExactActionFields(group, 'Group', ENCRYPTED_GROUP_FIELDS);
532
+ if (!Number.isSafeInteger(group.version) || group.version < 0) {
533
+ throw new Error('Group.version must be a non-negative safe integer');
534
+ }
535
+ if (form === 'creation-submission' && group.version !== 0) {
536
+ throw new Error('Group creation submission version must be zero');
537
+ }
538
+ if (!Array.isArray(group.members) ||
539
+ !Array.isArray(group.membersPendingProfileKey) ||
540
+ !Array.isArray(group.membersPendingAdminApproval) ||
541
+ !Array.isArray(group.membersBanned)) {
542
+ throw new Error('Group membership fields must be arrays');
543
+ }
544
+ if (group.members.length > 1000) {
545
+ throw new Error('Group exceeds the 1000-member limit');
546
+ }
547
+ if (group.membersPendingProfileKey.length > 1000) {
548
+ throw new Error('Group exceeds the 1000-pending-member limit');
549
+ }
550
+ if (group.membersPendingAdminApproval.length > 1000) {
551
+ throw new Error('Group exceeds the 1000-requesting-member limit');
552
+ }
553
+ if (group.membersBanned.length > 1000) {
554
+ throw new Error('Group exceeds the 1000-banned-member limit');
555
+ }
556
+ assertByteArray(group.publicKey, 'Group.publicKey', 96);
557
+ assertBlobEncoding(group.title, 'Group.title');
558
+ assertBlobEncoding(group.description, 'Group.description');
559
+ assertBlobEncoding(group.disappearingMessagesTimer, 'Group.disappearingMessagesTimer');
560
+ if (typeof group.avatarUrl !== 'string') {
561
+ throw new Error('Group.avatarUrl must be a string');
562
+ }
563
+ if (typeof group.announcementsOnly !== 'boolean') {
564
+ throw new Error('Group.announcementsOnly must be a boolean');
565
+ }
566
+ if (typeof group.terminated !== 'boolean') {
567
+ throw new Error('Group.terminated must be a boolean');
568
+ }
569
+ assertByteArray(group.inviteLinkPassword, 'Group.inviteLinkPassword');
570
+ if (group.inviteLinkPassword.length !== 0 &&
571
+ group.inviteLinkPassword.length !== 16) {
572
+ throw new Error('Group.inviteLinkPassword must be empty or 16 bytes');
573
+ }
574
+ assertExactActionFields(group.accessControl, 'Group.accessControl', [
575
+ 'attributes',
576
+ 'members',
577
+ 'addFromInviteLink',
578
+ 'memberLabel',
579
+ ]);
580
+ if (!isRoleAccessRequirement(group.accessControl.attributes) ||
581
+ !isRoleAccessRequirement(group.accessControl.members) ||
582
+ !isRoleAccessRequirement(group.accessControl.memberLabel) ||
583
+ !isInviteLinkAccessRequirement(group.accessControl.addFromInviteLink)) {
584
+ throw new Error('Group.accessControl is outside its domain');
585
+ }
586
+ const occupied = new Set();
587
+ const occupy = (ciphertext, label) => {
588
+ const key = bytesToHex(ciphertext);
589
+ if (occupied.has(key)) {
590
+ throw new Error(`Principal appears in multiple group-state entries (${label})`);
591
+ }
592
+ occupied.add(key);
593
+ };
594
+ for (const [index, member] of group.members.entries()) {
595
+ const label = `Group.members[${index}]`;
596
+ assertExactActionFields(member, label, [
597
+ 'userId',
598
+ 'role',
599
+ 'profileKey',
600
+ 'presentation',
601
+ 'joinedAtVersion',
602
+ 'labelEmoji',
603
+ 'labelString',
604
+ ]);
605
+ assertCiphertextEncoding(member.userId, `${label}.userId`, 'aci');
606
+ assertCiphertextEncoding(member.profileKey, `${label}.profileKey`, 'profile-key');
607
+ assertByteArray(member.presentation, `${label}.presentation`);
608
+ assertBlobEncoding(member.labelEmoji, `${label}.labelEmoji`);
609
+ assertBlobEncoding(member.labelString, `${label}.labelString`);
610
+ if (!isStoredMemberRole(member.role)) {
611
+ throw new Error(`${label}.role is outside its stored-role domain`);
612
+ }
613
+ if (!Number.isSafeInteger(member.joinedAtVersion) ||
614
+ member.joinedAtVersion < 0 ||
615
+ member.joinedAtVersion > group.version) {
616
+ throw new Error(`${label}.joinedAtVersion is outside its domain`);
617
+ }
618
+ occupy(member.userId, label);
619
+ }
620
+ for (const [index, pending] of group.membersPendingProfileKey.entries()) {
621
+ const label = `Group.membersPendingProfileKey[${index}]`;
622
+ if (form === 'creation-submission') {
623
+ const submitted = pending;
624
+ assertExactActionFields(submitted, label, ['userId', 'role']);
625
+ assertCiphertextEncoding(submitted.userId, `${label}.userId`, 'service-id');
626
+ if (!isStoredMemberRole(submitted.role)) {
627
+ throw new Error(`${label}.role is outside its stored-role domain`);
628
+ }
629
+ occupy(submitted.userId, label);
630
+ continue;
631
+ }
632
+ const canonical = pending;
633
+ assertExactActionFields(canonical, label, [
634
+ 'member',
635
+ 'addedByUserId',
636
+ 'timestamp',
637
+ ]);
638
+ assertExactActionFields(canonical.member, `${label}.member`, [
639
+ 'userId',
640
+ 'role',
641
+ 'profileKey',
642
+ 'presentation',
643
+ 'joinedAtVersion',
644
+ 'labelEmoji',
645
+ 'labelString',
646
+ ]);
647
+ assertCiphertextEncoding(canonical.member.userId, `${label}.member.userId`, 'service-id');
648
+ assertCiphertextEncoding(canonical.addedByUserId, `${label}.addedByUserId`, 'aci');
649
+ assertTimestamp(canonical.timestamp, `${label}.timestamp`);
650
+ if (!isStoredMemberRole(canonical.member.role)) {
651
+ throw new Error(`${label}.member.role is outside its stored-role domain`);
652
+ }
653
+ assertByteArray(canonical.member.profileKey, `${label}.member.profileKey`, 0);
654
+ assertByteArray(canonical.member.presentation, `${label}.member.presentation`, 0);
655
+ assertByteArray(canonical.member.labelEmoji, `${label}.member.labelEmoji`, 0);
656
+ assertByteArray(canonical.member.labelString, `${label}.member.labelString`, 0);
657
+ if (canonical.member.joinedAtVersion !== 0) {
658
+ throw new Error(`${label}.member.joinedAtVersion must be zero`);
659
+ }
660
+ occupy(canonical.member.userId, label);
661
+ }
662
+ if (form === 'creation-submission' &&
663
+ group.membersPendingAdminApproval.length !== 0) {
664
+ throw new Error('Group creation submission must not contain requesting members');
665
+ }
666
+ for (const [index, requesting] of group.membersPendingAdminApproval.entries()) {
667
+ const label = `Group.membersPendingAdminApproval[${index}]`;
668
+ assertExactActionFields(requesting, label, [
669
+ 'userId',
670
+ 'profileKey',
671
+ 'presentation',
672
+ 'timestamp',
673
+ ]);
674
+ assertCiphertextEncoding(requesting.userId, `${label}.userId`, 'aci');
675
+ assertCiphertextEncoding(requesting.profileKey, `${label}.profileKey`, 'profile-key');
676
+ assertByteArray(requesting.presentation, `${label}.presentation`);
677
+ assertTimestamp(requesting.timestamp, `${label}.timestamp`);
678
+ occupy(requesting.userId, label);
679
+ }
680
+ if (form === 'creation-submission' && group.membersBanned.length !== 0) {
681
+ throw new Error('Group creation submission must not contain banned members');
682
+ }
683
+ for (const [index, banned] of group.membersBanned.entries()) {
684
+ const label = `Group.membersBanned[${index}]`;
685
+ assertExactActionFields(banned, label, ['userId', 'timestamp']);
686
+ assertCiphertextEncoding(banned.userId, `${label}.userId`, 'service-id');
687
+ assertTimestamp(banned.timestamp, `${label}.timestamp`);
688
+ occupy(banned.userId, label);
689
+ }
690
+ if (!satisfiesLiveGroupAdministratorInvariant(group)) {
691
+ throw new Error('Every non-terminated group must have at least one administrator');
692
+ }
693
+ }
694
+ /** Enforce Revision 16's complete encrypted S14 baseline wire domain. */
695
+ export function assertValidEncryptedGroupWire(group) {
696
+ assertValidEncryptedGroupWireForm(group, 'canonical');
697
+ }
698
+ /** Enforce Revision 18's provenance-free creation submission domain. */
699
+ export function assertValidEncryptedGroupCreationSubmissionWire(group) {
700
+ assertValidEncryptedGroupWireForm(group, 'creation-submission');
701
+ }
702
+ export function serializeEncryptedGroupJoinInfo(info) {
703
+ return serializeGroupWire(info);
704
+ }
705
+ export function deserializeEncryptedGroupJoinInfo(bytes) {
706
+ return deserializeGroupWire(bytes);
707
+ }
708
+ //# sourceMappingURL=wire.js.map