@open-e2ee/signal-protocol-sdk 13.4.0 → 13.5.0
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/CHANGELOG.md +417 -0
- package/README.md +1 -1
- package/SECURITY.md +2 -2
- package/dist/client/binary-send.d.ts +28 -0
- package/dist/client/binary-send.d.ts.map +1 -0
- package/dist/client/binary-send.js +26 -0
- package/dist/client/binary-send.js.map +1 -0
- package/dist/client/client.d.ts +46 -6
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +181 -66
- package/dist/client/client.js.map +1 -1
- package/dist/client/content-adapter.d.ts +18 -0
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/device-set-reconciliation.d.ts +23 -8
- package/dist/client/device-set-reconciliation.d.ts.map +1 -1
- package/dist/client/device-set-reconciliation.js +25 -11
- package/dist/client/device-set-reconciliation.js.map +1 -1
- package/dist/client/event-hooks.d.ts +88 -8
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +1 -0
- package/dist/client/event-hooks.js.map +1 -1
- package/dist/client/group-outbox.d.ts +45 -10
- package/dist/client/group-outbox.d.ts.map +1 -1
- package/dist/client/group-outbox.js +246 -154
- package/dist/client/group-outbox.js.map +1 -1
- package/dist/client/group-receive-authorization.d.ts +10 -1
- package/dist/client/group-receive-authorization.d.ts.map +1 -1
- package/dist/client/group-receive-authorization.js.map +1 -1
- package/dist/client/hosted-anonymous-delivery.d.ts +18 -1
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
- package/dist/client/hosted-anonymous-delivery.js +84 -12
- package/dist/client/hosted-anonymous-delivery.js.map +1 -1
- package/dist/client/hosted-connection.js +1 -1
- package/dist/client/hosted-connection.js.map +1 -1
- package/dist/client/hosted-group-authority.d.ts +6 -2
- package/dist/client/hosted-group-authority.d.ts.map +1 -1
- package/dist/client/hosted-group-authority.js +11 -7
- package/dist/client/hosted-group-authority.js.map +1 -1
- package/dist/client/hosted-groups.d.ts +5 -1
- package/dist/client/hosted-groups.d.ts.map +1 -1
- package/dist/client/hosted-groups.js +8 -4
- package/dist/client/hosted-groups.js.map +1 -1
- package/dist/client/hosted-http-error.d.ts +5 -1
- package/dist/client/hosted-http-error.d.ts.map +1 -1
- package/dist/client/hosted-http-error.js +5 -1
- package/dist/client/hosted-http-error.js.map +1 -1
- package/dist/client/hosted-mailbox-subscription.d.ts +2 -0
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
- package/dist/client/hosted-mailbox-subscription.js +5 -5
- package/dist/client/hosted-mailbox-subscription.js.map +1 -1
- package/dist/client/hosted-transport.d.ts +11 -1
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +75 -30
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +1 -1
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/receive-queue.d.ts +5 -2
- package/dist/client/receive-queue.d.ts.map +1 -1
- package/dist/client/receive-queue.js +55 -18
- package/dist/client/receive-queue.js.map +1 -1
- package/dist/client/relay-acceptance.d.ts +49 -6
- package/dist/client/relay-acceptance.d.ts.map +1 -1
- package/dist/client/relay-acceptance.js +49 -3
- package/dist/client/relay-acceptance.js.map +1 -1
- package/dist/client/relay-protocol.d.ts +37 -7
- package/dist/client/relay-protocol.d.ts.map +1 -1
- package/dist/client/relay-protocol.js +53 -10
- package/dist/client/relay-protocol.js.map +1 -1
- package/dist/client/retry-family.d.ts +3 -3
- package/dist/client/retry-family.js +1 -1
- package/dist/client/retry-family.js.map +1 -1
- package/dist/client/retry-request-envelope.d.ts +18 -8
- package/dist/client/retry-request-envelope.d.ts.map +1 -1
- package/dist/client/retry-request-envelope.js +57 -29
- package/dist/client/retry-request-envelope.js.map +1 -1
- package/dist/client/retry-request-lifecycle.d.ts +24 -11
- package/dist/client/retry-request-lifecycle.d.ts.map +1 -1
- package/dist/client/retry-request-lifecycle.js +46 -20
- package/dist/client/retry-request-lifecycle.js.map +1 -1
- package/dist/client/retry-terminal-recovery.d.ts +11 -8
- package/dist/client/retry-terminal-recovery.d.ts.map +1 -1
- package/dist/client/retry-terminal-recovery.js +18 -12
- package/dist/client/retry-terminal-recovery.js.map +1 -1
- package/dist/client/retry.d.ts +8 -7
- package/dist/client/retry.d.ts.map +1 -1
- package/dist/client/retry.js +30 -22
- package/dist/client/retry.js.map +1 -1
- package/dist/client/send-deadline.d.ts +308 -0
- package/dist/client/send-deadline.d.ts.map +1 -0
- package/dist/client/send-deadline.js +914 -0
- package/dist/client/send-deadline.js.map +1 -0
- package/dist/client/send-intent-driver.d.ts +116 -0
- package/dist/client/send-intent-driver.d.ts.map +1 -0
- package/dist/client/send-intent-driver.js +373 -0
- package/dist/client/send-intent-driver.js.map +1 -0
- package/dist/client/signal-service-cipher.d.ts +257 -27
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +1274 -283
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +48 -5
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/local/store/conformance/cases/metadata.d.ts +3 -2
- package/dist/local/store/conformance/cases/metadata.d.ts.map +1 -1
- package/dist/local/store/conformance/cases/metadata.js +153 -2
- package/dist/local/store/conformance/cases/metadata.js.map +1 -1
- package/dist/local/store/key-value/adapter.d.ts +2 -1
- package/dist/local/store/key-value/adapter.d.ts.map +1 -1
- package/dist/local/store/key-value/adapter.js +9 -0
- package/dist/local/store/key-value/adapter.js.map +1 -1
- package/dist/local/store/memory/adapter.d.ts +2 -1
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +4 -0
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/metadata-keys.d.ts +13 -0
- package/dist/local/store/metadata-keys.d.ts.map +1 -0
- package/dist/local/store/metadata-keys.js +20 -0
- package/dist/local/store/metadata-keys.js.map +1 -0
- package/dist/local/store/receive-work.d.ts.map +1 -1
- package/dist/local/store/receive-work.js +12 -1
- package/dist/local/store/receive-work.js.map +1 -1
- package/dist/local/store/reliability.d.ts +482 -33
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +690 -48
- package/dist/local/store/reliability.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/index.d.ts +2 -1
- package/dist/local/store/sqlite/key-storage/index.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/index.js +3 -0
- package/dist/local/store/sqlite/key-storage/index.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/metadata.d.ts +9 -0
- package/dist/local/store/sqlite/key-storage/metadata.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/metadata.js +12 -0
- package/dist/local/store/sqlite/key-storage/metadata.js.map +1 -1
- package/dist/local/store/sqlite/store.d.ts +2 -1
- package/dist/local/store/sqlite/store.d.ts.map +1 -1
- package/dist/local/store/sqlite/store.js +3 -0
- package/dist/local/store/sqlite/store.js.map +1 -1
- package/dist/local/store/web/adapter.d.ts +8 -1
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +18 -0
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/remote/relay/request-admission.d.ts +49 -0
- package/dist/remote/relay/request-admission.d.ts.map +1 -0
- package/dist/remote/relay/request-admission.js +74 -0
- package/dist/remote/relay/request-admission.js.map +1 -0
- package/dist/types/api.d.ts +77 -0
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +144 -1
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +146 -1
- package/dist/types/errors.js.map +1 -1
- package/docs/ASSURANCE.md +5 -5
- package/docs/DEVIATIONS.md +34 -4
- package/docs/ERROR_HANDLING.md +134 -7
- package/package.json +1 -1
|
@@ -2,13 +2,15 @@ import { EncryptionError, EncryptionErrorCode } from '../types/index.js';
|
|
|
2
2
|
import { SealedSenderAuthError } from '../types/errors.js';
|
|
3
3
|
import { ContentHint } from '../types/messages.js';
|
|
4
4
|
import * as CryptoUtils from '../internal/crypto/index.js';
|
|
5
|
-
import { completeOutgoingMessageIntent, completeOutgoingSyncPhase, confirmOutgoingPreMessages, getOutgoingMessageIntent, outgoingMessageIntentResult, reconcileOutgoingGroupDeviceSet, reconcileOutgoingSyncMessages, repairOutgoingDeviceSet, replaceOutgoingGroupPreMessages,
|
|
5
|
+
import { completeOutgoingMessageIntent, completeOutgoingSyncPhase, confirmOutgoingPreMessages, getOutgoingMessageIntent, outgoingDestinationProgressKey, outgoingMessageDeadlineAt, outgoingMessageIntentResult, reconcileOutgoingGroupDeviceSet, reconcileOutgoingSyncMessages, repairOutgoingDeviceSet, replaceOutgoingGroupPreMessages, storeOutgoingMessageIntent, withOutgoingMessageIntentLock, } from '../local/store/reliability.js';
|
|
6
6
|
import { deviceSetRefusal, markDeviceSetRefusal } from '../remote/relay/device-set.js';
|
|
7
7
|
import { runDeviceSetPhase, syncPostReceipts, } from './device-set-reconciliation.js';
|
|
8
8
|
import { isStaleDeviceRefusal } from './relay-device-refusal.js';
|
|
9
9
|
import { newSendClientTimestamp } from './send-timestamp.js';
|
|
10
|
+
import { intentBinaryAttachment } from './binary-send.js';
|
|
10
11
|
import { groupDeviceKey, listedGroupDeviceChange, listedOwnDeviceChange, sharedBodyDevices, } from './group-device-set.js';
|
|
11
|
-
import { aggregateRelayAcceptance } from './relay-acceptance.js';
|
|
12
|
+
import { aggregateRelayAcceptance, isConflictAcceptance, sendResultAcceptance, } from './relay-acceptance.js';
|
|
13
|
+
import { SEND_END_REPORT, sendDestinations, storedSendEndError, } from './send-deadline.js';
|
|
12
14
|
/**
|
|
13
15
|
* Post one stored device message. With a declaration, an identified post
|
|
14
16
|
* and an access-key sealed post declare the devices of the account. A
|
|
@@ -42,7 +44,7 @@ async function sendStoredDeviceMessage(context, intent, message, forceIdentified
|
|
|
42
44
|
}),
|
|
43
45
|
...(intent.contentHint !== undefined && { contentHint: intent.contentHint }),
|
|
44
46
|
...(declaration && { declaredDeviceIds: declaration.deviceIds }),
|
|
45
|
-
}), false);
|
|
47
|
+
}), false, sendDestinations(intent.clientMessageId, [message])[0]);
|
|
46
48
|
declaration?.routes.set(acceptance, 'identified-direct');
|
|
47
49
|
return acceptance;
|
|
48
50
|
}
|
|
@@ -94,19 +96,39 @@ async function sendGroupDeviceMessage(context, intent, message, forceIdentified,
|
|
|
94
96
|
}
|
|
95
97
|
}
|
|
96
98
|
const repair = await context.repairStaleDevice(intent, message);
|
|
97
|
-
|
|
99
|
+
// The write marks the repaired device, so a RETRY_CONFLICT of its repost
|
|
100
|
+
// is not an acceptance.
|
|
101
|
+
const repaired = await reconcileOutgoingGroupDeviceSet(context.storage, intent.clientMessageId, {
|
|
98
102
|
removed: [{ userId: message.recipientUserId, deviceId: message.recipientDeviceId }],
|
|
99
103
|
preMessages: repair.preMessages,
|
|
100
104
|
deviceMessages: [repair.deviceMessage],
|
|
101
105
|
syncMessages: [],
|
|
102
106
|
});
|
|
103
|
-
|
|
107
|
+
refreshAppendedEntries(context, repaired, repair.preMessages);
|
|
108
|
+
const dispatched = await dispatchPreMessages(context, repaired, repair.preMessages, required);
|
|
104
109
|
const device = { userId: message.recipientUserId, deviceId: message.recipientDeviceId };
|
|
105
110
|
if (dispatched.removed.some((removed) => groupDeviceKey(removed) === groupDeviceKey(device))) {
|
|
106
111
|
return undefined;
|
|
107
112
|
}
|
|
108
|
-
const
|
|
109
|
-
|
|
113
|
+
const renewal = await renewRefreshedDeviceMessages(context, dispatched.intent, dispatched.refreshed, [repair.deviceMessage]);
|
|
114
|
+
const repost = renewal.renewed[0] ?? repair.deviceMessage;
|
|
115
|
+
refreshAppendedEntries(context, renewal.intent, [repost]);
|
|
116
|
+
return sendStoredDeviceMessage(context, repaired, repost, forceIdentified);
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Give the evidence of the call the stored entry of each message that a
|
|
120
|
+
* write of this call appended, before the message posts. A reconcile or a
|
|
121
|
+
* repair writes the repair mark of the device, and a replay reads the same
|
|
122
|
+
* entry from the intent. So a RETRY_CONFLICT of the post gets the same
|
|
123
|
+
* class in the call and in a replay. A message with no stored entry keeps
|
|
124
|
+
* the entry that the call has.
|
|
125
|
+
*/
|
|
126
|
+
function refreshAppendedEntries(context, intent, messages) {
|
|
127
|
+
for (const destination of sendDestinations(intent.clientMessageId, messages)) {
|
|
128
|
+
const entry = intent.destinationProgress?.[outgoingDestinationProgressKey(destination.postMessageId, destination.device)];
|
|
129
|
+
if (entry)
|
|
130
|
+
context.refreshEntry(destination.device, entry);
|
|
131
|
+
}
|
|
110
132
|
}
|
|
111
133
|
/**
|
|
112
134
|
* Post stored pre-messages. Each one is authorized before any post, and a
|
|
@@ -243,6 +265,7 @@ async function renewRefreshedDeviceMessages(context, intent, refreshed, messages
|
|
|
243
265
|
deviceMessages: renewed,
|
|
244
266
|
syncMessages: [],
|
|
245
267
|
});
|
|
268
|
+
refreshAppendedEntries(context, written, [...preMessages, ...renewed]);
|
|
246
269
|
return { intent: written, renewed };
|
|
247
270
|
}
|
|
248
271
|
async function sendStoredGroupIntent(context, initialIntent, plaintextBytes) {
|
|
@@ -280,131 +303,139 @@ async function sendStoredGroupIntent(context, initialIntent, plaintextBytes) {
|
|
|
280
303
|
const required = context.deliveryMode === 'required' ||
|
|
281
304
|
intent.transportMode === 'sealed_sender_required' ||
|
|
282
305
|
preMessages.some((message) => message.sealedSenderDeliveryMode === 'required');
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
// A device that a pre-message repair refreshed, or whose session no longer
|
|
296
|
-
// has the registration that the shared body names, leaves the shared body
|
|
297
|
-
// of this attempt. It gets the key of the send when it has no handoff row,
|
|
298
|
-
// and its own post under its current registration.
|
|
299
|
-
const leaving = await leaveStaleSharedBody(context, intent, dispatched.refreshed, groupCiphertext, required);
|
|
300
|
-
intent = leaving.intent;
|
|
301
|
-
if (intent.groupSharedMessage?.deliveryMode === 'required' &&
|
|
302
|
-
!relay.sendMultiRecipientUnidentified) {
|
|
303
|
-
throw new EncryptionError('Required group sealed-sender transport is unavailable', EncryptionErrorCode.SEALED_SENDER_REQUIRED, { groupId: intent.recipientId });
|
|
304
|
-
}
|
|
305
|
-
if (intent.groupSharedMessage && relay.sendMultiRecipientUnidentified) {
|
|
306
|
-
const auth = await context.resolveGroupAuthorization(intent.groupSharedMessage.groupId, intent.groupSharedMessage.recipientUserIds);
|
|
307
|
-
if (!auth) {
|
|
308
|
-
if (intent.groupSharedMessage.deliveryMode === 'required') {
|
|
309
|
-
throw new Error('Required group sealed-sender authorization is unavailable');
|
|
310
|
-
}
|
|
306
|
+
// The recipient phase ends here when it fails at or after the posting
|
|
307
|
+
// deadline with an open destination, or when every open destination got
|
|
308
|
+
// OPERATION_EXPIRED. Before that, the error is thrown with the deadline.
|
|
309
|
+
try {
|
|
310
|
+
if (preMessages.length > 0) {
|
|
311
|
+
// One refresh covers the pre-messages and the group message.
|
|
312
|
+
await context.refreshPreMessageEndorsements(intent.recipientId, [
|
|
313
|
+
...new Set([
|
|
314
|
+
...preMessages.map((message) => message.recipientUserId),
|
|
315
|
+
...(intent.groupSharedMessage?.recipientUserIds ?? []),
|
|
316
|
+
]),
|
|
317
|
+
]);
|
|
311
318
|
}
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
319
|
+
// Every pre-message is accepted or dropped before the group message.
|
|
320
|
+
const dispatched = await dispatchPreMessages(context, intent, preMessages, required);
|
|
321
|
+
intent = dispatched.intent;
|
|
322
|
+
// A device that a pre-message repair refreshed, or whose session no longer
|
|
323
|
+
// has the registration that the shared body names, leaves the shared body
|
|
324
|
+
// of this attempt. It gets the key of the send when it has no handoff row,
|
|
325
|
+
// and its own post under its current registration.
|
|
326
|
+
const leaving = await leaveStaleSharedBody(context, intent, dispatched.refreshed, groupCiphertext, required);
|
|
327
|
+
intent = leaving.intent;
|
|
328
|
+
if (intent.groupSharedMessage?.deliveryMode === 'required' &&
|
|
329
|
+
!relay.sendMultiRecipientUnidentified) {
|
|
330
|
+
throw new EncryptionError('Required group sealed-sender transport is unavailable', EncryptionErrorCode.SEALED_SENDER_REQUIRED, { groupId: intent.recipientId });
|
|
331
|
+
}
|
|
332
|
+
if (intent.groupSharedMessage && relay.sendMultiRecipientUnidentified) {
|
|
333
|
+
const auth = await context.resolveGroupAuthorization(intent.groupSharedMessage.groupId, intent.groupSharedMessage.recipientUserIds);
|
|
334
|
+
if (!auth) {
|
|
335
|
+
if (intent.groupSharedMessage.deliveryMode === 'required') {
|
|
336
|
+
throw new Error('Required group sealed-sender authorization is unavailable');
|
|
337
|
+
}
|
|
323
338
|
}
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
339
|
+
else {
|
|
340
|
+
const shared = intent.groupSharedMessage;
|
|
341
|
+
try {
|
|
342
|
+
const result = await context.postToRelay(() => relay.sendMultiRecipientUnidentified(shared.sentMessageBase64, auth, intent.clientTimestamp, 'user-visible', shared.recipientUserIds, intent.clientMessageId), true, sharedBodyDestinations(intent.clientMessageId, sharedBodyDevices(shared)));
|
|
343
|
+
skippedUsers = result.uuids404;
|
|
344
|
+
refusedDestinationCount = result.refusedDestinationCount;
|
|
345
|
+
sharedRefusals = result.refusals ?? [];
|
|
346
|
+
sharedSucceeded = true;
|
|
347
|
+
acceptances.push(result);
|
|
348
|
+
}
|
|
349
|
+
catch (error) {
|
|
350
|
+
if (!(error instanceof SealedSenderAuthError))
|
|
351
|
+
throw error;
|
|
352
|
+
if (intent.groupSharedMessage.deliveryMode === 'required')
|
|
353
|
+
throw error;
|
|
354
|
+
await context.prepareEach(intent.groupSharedMessage.recipientUserIds, (recipientUserId) => context.reportIdentifiedFallback(recipientUserId));
|
|
355
|
+
}
|
|
330
356
|
}
|
|
331
357
|
}
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
// and the key of the send, so its device message names the
|
|
371
|
-
// registration of that session, and the device can decrypt it.
|
|
372
|
-
const handoffs = await context.prepareSenderKeyHandoffs(intent, refreshed);
|
|
373
|
-
const additions = await context.prepareEach(added, (member) => context.prepareDeviceMessage(member, intent.recipientId, groupCiphertext, intent.clientTimestamp, intent.contentHint));
|
|
374
|
-
// A device that the repair adds gets a send log row before its post.
|
|
375
|
-
if (isLoggedSend(intent)) {
|
|
376
|
-
await context.storage.appendSendLogRecipients(intent.clientMessageId, sendLogDevices(additions));
|
|
377
|
-
}
|
|
378
|
-
intent = await reconcileOutgoingGroupDeviceSet(context.storage, intent.clientMessageId, {
|
|
379
|
-
removed: [],
|
|
380
|
-
preMessages: handoffs,
|
|
381
|
-
deviceMessages: additions,
|
|
382
|
-
syncMessages: [],
|
|
358
|
+
// A device that the shared body does not name gets its own post. A replay
|
|
359
|
+
// keeps the stored body, so a device that the replay added is one. A
|
|
360
|
+
// device that left the shared body of this attempt is one too.
|
|
361
|
+
const sharedDevices = sharedSucceeded
|
|
362
|
+
? sharedBodyDevices(intent.groupSharedMessage)
|
|
363
|
+
: new Map();
|
|
364
|
+
for (const device of leaving.left)
|
|
365
|
+
sharedDevices.delete(device);
|
|
366
|
+
// The group-token receipt names each refused destination with its code. A
|
|
367
|
+
// destination that the Relay refused as STALE_DEVICE leaves the shared set
|
|
368
|
+
// and gets the device repair once. The refused count alone names no
|
|
369
|
+
// device, so the send infers nothing from it.
|
|
370
|
+
const refusedDevices = new Set(sharedRefusals
|
|
371
|
+
.filter((refusal) => refusal.code === 'STALE_DEVICE')
|
|
372
|
+
.map(groupDeviceKey)
|
|
373
|
+
.filter((key) => sharedDevices.has(key)));
|
|
374
|
+
for (const key of refusedDevices)
|
|
375
|
+
sharedDevices.delete(key);
|
|
376
|
+
const usersToRepair = new Set(skippedUsers);
|
|
377
|
+
const forceIdentified = Boolean(intent.groupSharedMessage && !sharedSucceeded);
|
|
378
|
+
const devicePosts = intent.deviceMessages.filter((message) => !sharedDevices.has(groupDeviceKey({ userId: message.recipientUserId, deviceId: message.recipientDeviceId })) || usersToRepair.has(message.recipientUserId));
|
|
379
|
+
const posting = intent;
|
|
380
|
+
const results = await context.sendPhase(devicePosts, (message) => sendGroupDeviceMessage(context, posting, message, forceIdentified, required, refusedDevices.has(groupDeviceKey({ userId: message.recipientUserId, deviceId: message.recipientDeviceId }))), 'device');
|
|
381
|
+
const posted = results.filter((result) => result !== undefined);
|
|
382
|
+
acceptances.push(...posted);
|
|
383
|
+
// The shared body gives the message ID and time, else the first device
|
|
384
|
+
// post. An acceptance that a RETRY_CONFLICT or a version 2
|
|
385
|
+
// DELIVERY_ALREADY_ACCEPTED gave has no Relay receipt, so a post with a
|
|
386
|
+
// receipt comes first.
|
|
387
|
+
const first = sendResultAcceptance(acceptances);
|
|
388
|
+
if (first) {
|
|
389
|
+
messageId = first.messageId;
|
|
390
|
+
timestamp = first.serverTimestamp;
|
|
391
|
+
}
|
|
392
|
+
if (skippedUsers.length > 0) {
|
|
393
|
+
const refreshed = await context.resolveMemberDevices(intent.recipientId, {
|
|
394
|
+
clientMessageId: intent.clientMessageId,
|
|
395
|
+
groupMemberUserIds: skippedUsers,
|
|
383
396
|
});
|
|
384
|
-
const
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
userId: message.recipientUserId,
|
|
401
|
-
deviceId: message.recipientDeviceId,
|
|
397
|
+
const { added } = listedGroupDeviceChange(intent, refreshed, context.senderUserId);
|
|
398
|
+
if (added.length > 0) {
|
|
399
|
+
// The pre-messages come first. They give each added device a session
|
|
400
|
+
// and the key of the send, so its device message names the
|
|
401
|
+
// registration of that session, and the device can decrypt it.
|
|
402
|
+
const handoffs = await context.prepareSenderKeyHandoffs(intent, refreshed);
|
|
403
|
+
const additions = await context.prepareEach(added, (member) => context.prepareDeviceMessage(member, intent.recipientId, groupCiphertext, intent.clientTimestamp, intent.contentHint));
|
|
404
|
+
// A device that the repair adds gets a send log row before its post.
|
|
405
|
+
if (isLoggedSend(intent)) {
|
|
406
|
+
await context.storage.appendSendLogRecipients(intent.clientMessageId, sendLogDevices(additions));
|
|
407
|
+
}
|
|
408
|
+
intent = await reconcileOutgoingGroupDeviceSet(context.storage, intent.clientMessageId, {
|
|
409
|
+
removed: [],
|
|
410
|
+
preMessages: handoffs,
|
|
411
|
+
deviceMessages: additions,
|
|
412
|
+
syncMessages: [],
|
|
402
413
|
});
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
414
|
+
const dispatchedHandoffs = await dispatchPreMessages(context, intent, handoffs, required);
|
|
415
|
+
// A device that a repair of its pre-message refreshed gets a device
|
|
416
|
+
// message under its new session before its post.
|
|
417
|
+
const renewal = await renewRefreshedDeviceMessages(context, dispatchedHandoffs.intent, dispatchedHandoffs.refreshed, additions, groupCiphertext);
|
|
418
|
+
intent = renewal.intent;
|
|
419
|
+
// The confirmation of the pre-messages removed the device message of
|
|
420
|
+
// each device that the device list no longer shows. Only the additions
|
|
421
|
+
// that the intent still holds get a post.
|
|
422
|
+
const removedKeys = new Set(dispatchedHandoffs.removed.map(groupDeviceKey));
|
|
423
|
+
const renewedOf = new Map(renewal.renewed.map((message) => [groupDeviceKey(messageDevice(message)), message]));
|
|
424
|
+
const extended = intent;
|
|
425
|
+
const additionResults = await context.sendPhase(additions.flatMap((message) => {
|
|
426
|
+
const key = groupDeviceKey({
|
|
427
|
+
userId: message.recipientUserId,
|
|
428
|
+
deviceId: message.recipientDeviceId,
|
|
429
|
+
});
|
|
430
|
+
return removedKeys.has(key) ? [] : [renewedOf.get(key) ?? message];
|
|
431
|
+
}), (message) => sendGroupDeviceMessage(context, extended, message, false, required), 'device');
|
|
432
|
+
acceptances.push(...additionResults.filter((result) => result !== undefined));
|
|
433
|
+
}
|
|
406
434
|
}
|
|
407
435
|
}
|
|
436
|
+
catch (error) {
|
|
437
|
+
return context.endRecipientPhase(intent, error);
|
|
438
|
+
}
|
|
408
439
|
// The sync copies start after every device post settles. They go to the
|
|
409
440
|
// sender's own devices, so they are identified in every privacy mode: the
|
|
410
441
|
// relay already knows the account that owns the destination mailbox.
|
|
@@ -413,7 +444,10 @@ async function sendStoredGroupIntent(context, initialIntent, plaintextBytes) {
|
|
|
413
444
|
const [message] = await context.prepareSyncMessages(syncing.recipientId, await transcriptContent(context, syncing, plaintextBytes), syncing.clientTimestamp, syncing.clientMessageId, [{ userId: context.senderUserId, deviceId }]);
|
|
414
445
|
return message;
|
|
415
446
|
};
|
|
416
|
-
|
|
447
|
+
// A sync copy that the posting deadline stopped keeps the sync phase
|
|
448
|
+
// pending.
|
|
449
|
+
const stopped = await context.sendPhase(intent.syncMessages, (message) => context.postSyncMessage(syncing, message, rebuildSyncMessage), 'sync');
|
|
450
|
+
const syncPending = stopped.some(Boolean);
|
|
417
451
|
const result = {
|
|
418
452
|
clientMessageId: intent.clientMessageId,
|
|
419
453
|
messageId,
|
|
@@ -423,9 +457,21 @@ async function sendStoredGroupIntent(context, initialIntent, plaintextBytes) {
|
|
|
423
457
|
...(refusedDestinationCount !== undefined && { refusedDestinationCount }),
|
|
424
458
|
groupId: intent.recipientId,
|
|
425
459
|
};
|
|
426
|
-
await completeOutgoingMessageIntent(context.storage, intent.clientMessageId, result
|
|
460
|
+
await completeOutgoingMessageIntent(context.storage, intent.clientMessageId, result, {
|
|
461
|
+
syncPending,
|
|
462
|
+
});
|
|
427
463
|
await completeSendLog(context, intent);
|
|
428
|
-
return result;
|
|
464
|
+
return syncPending ? { ...result, syncPending: true } : result;
|
|
465
|
+
}
|
|
466
|
+
/**
|
|
467
|
+
* The destinations of a shared body: each device that the body names, under
|
|
468
|
+
* the client message ID of the send, which the shared post sends.
|
|
469
|
+
*/
|
|
470
|
+
function sharedBodyDestinations(clientMessageId, devices) {
|
|
471
|
+
return [...devices.keys()].map((key) => {
|
|
472
|
+
const [userId, deviceId] = key.split('\u0000');
|
|
473
|
+
return { device: { userId, deviceId: Number(deviceId) }, postMessageId: clientMessageId };
|
|
474
|
+
});
|
|
429
475
|
}
|
|
430
476
|
/** The device of a stored device message. */
|
|
431
477
|
function messageDevice(message) {
|
|
@@ -561,6 +607,7 @@ async function sendDeclaredGroupIntent(context, deviceSets, initialIntent, plain
|
|
|
561
607
|
syncMessages: [],
|
|
562
608
|
...(groupSharedMessage !== undefined && { groupSharedMessage }),
|
|
563
609
|
});
|
|
610
|
+
refreshAppendedEntries(context, intent, renewed);
|
|
564
611
|
}
|
|
565
612
|
}
|
|
566
613
|
}
|
|
@@ -605,7 +652,7 @@ async function sendDeclaredGroupIntent(context, deviceSets, initialIntent, plain
|
|
|
605
652
|
deviceIds: deviceIds.sort((a, b) => a - b),
|
|
606
653
|
}));
|
|
607
654
|
try {
|
|
608
|
-
const receipt = await context.postToRelay(() => relay.sendMultiRecipientUnidentified(body.sentMessageBase64, auth, intent.clientTimestamp, 'user-visible', body.recipientUserIds, clientMessageId, undefined, undefined, deviceSetsOfBody), true);
|
|
655
|
+
const receipt = await context.postToRelay(() => relay.sendMultiRecipientUnidentified(body.sentMessageBase64, auth, intent.clientTimestamp, 'user-visible', body.recipientUserIds, clientMessageId, undefined, undefined, deviceSetsOfBody), true, sharedBodyDestinations(clientMessageId, bodyDevices));
|
|
609
656
|
sharedReceipt = receipt;
|
|
610
657
|
routes.set(receipt, 'anonymous-group');
|
|
611
658
|
bodyPosts({ ok: true, value: receipt });
|
|
@@ -719,24 +766,43 @@ async function sendDeclaredGroupIntent(context, deviceSets, initialIntent, plain
|
|
|
719
766
|
deviceMessages,
|
|
720
767
|
...(groupSharedMessage !== undefined && { groupSharedMessage }),
|
|
721
768
|
});
|
|
769
|
+
// The store wrote `repairedFor` on each appended device, and `repaired`
|
|
770
|
+
// on a device that the repair removed and appended again, as for a stale
|
|
771
|
+
// device: the Relay can hold its replaced message. The evidence of the
|
|
772
|
+
// call takes the entry of each appended device before the next pass
|
|
773
|
+
// posts it, so the call and a replay give a RETRY_CONFLICT of that post
|
|
774
|
+
// the same class.
|
|
775
|
+
refreshAppendedEntries(context, intent, [...preMessages, ...deviceMessages]);
|
|
722
776
|
unposted = bundleMissing;
|
|
723
777
|
return { bundleMissing };
|
|
724
778
|
};
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
779
|
+
// The recipient phase ends here when it fails at or after the posting
|
|
780
|
+
// deadline with an open destination, or when every open destination got
|
|
781
|
+
// OPERATION_EXPIRED. Before that, the error is thrown with the deadline.
|
|
782
|
+
let posts;
|
|
783
|
+
try {
|
|
784
|
+
posts = await runDeviceSetPhase({
|
|
785
|
+
phase: 'recipient',
|
|
786
|
+
clientMessageId,
|
|
787
|
+
restarts: intent.deviceSetRestarts?.recipient ?? 0,
|
|
788
|
+
pass,
|
|
789
|
+
repair,
|
|
790
|
+
unresolve: (unresolved) => deviceSets.unresolve(clientMessageId, unresolved),
|
|
791
|
+
wait: (milliseconds) => deviceSets.wait(milliseconds),
|
|
792
|
+
logFailure: (device, error) => deviceSets.logFailure(device, error),
|
|
793
|
+
});
|
|
794
|
+
}
|
|
795
|
+
catch (error) {
|
|
796
|
+
return context.endRecipientPhase(intent, error);
|
|
797
|
+
}
|
|
735
798
|
// The body receipt answers each device of the body, so it counts once.
|
|
736
799
|
const accepted = [
|
|
737
800
|
...new Set(posts.flatMap((post) => (post.outcome.ok ? [post.outcome.value] : []))),
|
|
738
801
|
];
|
|
739
|
-
|
|
802
|
+
// An acceptance that a RETRY_CONFLICT or a version 2
|
|
803
|
+
// DELIVERY_ALREADY_ACCEPTED gave has no Relay receipt, so a post with a
|
|
804
|
+
// receipt gives the message ID and time.
|
|
805
|
+
const first = sendResultAcceptance(sharedReceipt ? [sharedReceipt, ...accepted] : accepted);
|
|
740
806
|
const result = {
|
|
741
807
|
clientMessageId,
|
|
742
808
|
messageId: first?.messageId ?? `group-${groupId}-${String(intent.clientTimestamp)}`,
|
|
@@ -749,13 +815,23 @@ async function sendDeclaredGroupIntent(context, deviceSets, initialIntent, plain
|
|
|
749
815
|
groupId,
|
|
750
816
|
};
|
|
751
817
|
// The sync phase runs when the intent holds a sync copy, or when a
|
|
752
|
-
// receipt sets needsSync.
|
|
753
|
-
//
|
|
754
|
-
//
|
|
818
|
+
// receipt sets needsSync. An acceptance that a RETRY_CONFLICT, a version 2
|
|
819
|
+
// DELIVERY_ALREADY_ACCEPTED or the stored progress gave has no receipt,
|
|
820
|
+
// and the lost receipt can have set needsSync, so it counts as needsSync
|
|
821
|
+
// too. With needsSync and no own record, the send reads the own list
|
|
822
|
+
// once. When that read fails, the sync phase stays pending with no sync
|
|
823
|
+
// messages, and a replay reads it.
|
|
755
824
|
let current = (await getOutgoingMessageIntent(context.storage, clientMessageId)) ?? intent;
|
|
825
|
+
// Another process can complete the send while this one posts. The Relay
|
|
826
|
+
// then answers the body of this process with RETRY_CONFLICT, which counts
|
|
827
|
+
// as acceptance, and the stored result holds the Relay receipt.
|
|
828
|
+
if (current.result) {
|
|
829
|
+
await completeSendLog(context, current);
|
|
830
|
+
return outgoingMessageIntentResult(current);
|
|
831
|
+
}
|
|
756
832
|
let syncUnread = false;
|
|
757
833
|
if (current.syncMessages.length === 0 &&
|
|
758
|
-
accepted.some((acceptance) => acceptance.needsSync === true)) {
|
|
834
|
+
accepted.some((acceptance) => acceptance.needsSync === true || isConflictAcceptance(acceptance))) {
|
|
759
835
|
const added = await addDeclaredGroupSync(context, deviceSets, current, plaintextBytes);
|
|
760
836
|
current = added.intent;
|
|
761
837
|
syncUnread = added.unread;
|
|
@@ -823,8 +899,9 @@ function runDeclaredGroupSync(context, deviceSets, intent, plaintextBytes) {
|
|
|
823
899
|
});
|
|
824
900
|
}
|
|
825
901
|
/**
|
|
826
|
-
* Replay a stored group send on a relay that compares device sets. A
|
|
827
|
-
*
|
|
902
|
+
* Replay a stored group send on a relay that compares device sets. A later
|
|
903
|
+
* `send()` after a recipient-phase end throws the stored-end class of its
|
|
904
|
+
* outcome and posts nothing. A completed send with a
|
|
828
905
|
* pending sync phase posts only its sync messages. A send that is not
|
|
829
906
|
* terminal resumes with its stored restart count. The replay reads no device
|
|
830
907
|
* list: the Relay comparison finds each change. The one exception is a
|
|
@@ -834,7 +911,7 @@ function runDeclaredGroupSync(context, deviceSets, intent, plaintextBytes) {
|
|
|
834
911
|
* refuses it as missing and retries it as the live run does.
|
|
835
912
|
*/
|
|
836
913
|
async function replayDeclaredGroupIntent(context, deviceSets, existing, plaintextBytes) {
|
|
837
|
-
const intent =
|
|
914
|
+
const intent = existing;
|
|
838
915
|
const stored = outgoingMessageIntentResult(intent);
|
|
839
916
|
if (!stored)
|
|
840
917
|
return sendDeclaredGroupIntent(context, deviceSets, intent, plaintextBytes);
|
|
@@ -892,11 +969,14 @@ async function rereadStoredGroupDevices(context, intent, plaintextBytes) {
|
|
|
892
969
|
*
|
|
893
970
|
* Signal encrypts the message again for the devices of each attempt. The
|
|
894
971
|
* replay here keeps the stored ciphertext. The Relay keys each delivery
|
|
895
|
-
* operation by
|
|
896
|
-
*
|
|
897
|
-
*
|
|
898
|
-
*
|
|
899
|
-
*
|
|
972
|
+
* operation by message ID, class, destination device, generation and epoch.
|
|
973
|
+
* It refuses a changed request under the same operation with RETRY_CONFLICT.
|
|
974
|
+
* It also refuses a new operation whose message ID a row or journal entry of
|
|
975
|
+
* that mailbox holds. The message ID alone is not the ring key or the
|
|
976
|
+
* operation key. So a new group ciphertext under the clientMessageId of the
|
|
977
|
+
* send would conflict with the posts that the Relay already holds. A device
|
|
978
|
+
* that the replay adds therefore gets the content only when the send is
|
|
979
|
+
* `Resendable`.
|
|
900
980
|
*/
|
|
901
981
|
async function rereadMemberDevices(context, intent) {
|
|
902
982
|
const groupCiphertext = intent.groupCiphertext;
|
|
@@ -1007,6 +1087,7 @@ async function completeSendLog(context, intent) {
|
|
|
1007
1087
|
await context.storage.markSendLogComplete(intent.clientMessageId);
|
|
1008
1088
|
}
|
|
1009
1089
|
export async function sendGroupWithExactOutbox(context, groupId, plaintextBytes, options) {
|
|
1090
|
+
const report = options[SEND_END_REPORT];
|
|
1010
1091
|
return withOutgoingMessageIntentLock(context.storage, options.clientMessageId, async () => {
|
|
1011
1092
|
const plaintextDigest = CryptoUtils.bytesToBase64(await CryptoUtils.sha256(plaintextBytes));
|
|
1012
1093
|
const groupMemberUserIds = [...new Set(options.groupMemberUserIds ?? [])].sort();
|
|
@@ -1019,12 +1100,18 @@ export async function sendGroupWithExactOutbox(context, groupId, plaintextBytes,
|
|
|
1019
1100
|
JSON.stringify(existing.groupMemberUserIds) !== JSON.stringify(groupMemberUserIds)) {
|
|
1020
1101
|
throw new Error('A clientMessageId cannot identify two different logical sends');
|
|
1021
1102
|
}
|
|
1103
|
+
// A send that ended at its posting deadline posts nothing again.
|
|
1104
|
+
if (!existing.result && existing.outcome)
|
|
1105
|
+
throw storedSendEndError(existing);
|
|
1106
|
+
context.bindEvidence(existing);
|
|
1022
1107
|
if (context.deviceSets && context.relay) {
|
|
1023
1108
|
return replayDeclaredGroupIntent(context, context.deviceSets, existing, plaintextBytes);
|
|
1024
1109
|
}
|
|
1110
|
+
// An undeclared intent completes with syncPending only when the posting
|
|
1111
|
+
// deadline stopped its sync posts, so a replay posts nothing.
|
|
1025
1112
|
if (existing.result) {
|
|
1026
1113
|
await completeSendLog(context, existing);
|
|
1027
|
-
return existing
|
|
1114
|
+
return outgoingMessageIntentResult(existing);
|
|
1028
1115
|
}
|
|
1029
1116
|
return sendStoredGroupIntent(context, await rereadStoredGroupDevices(context, existing, plaintextBytes), plaintextBytes);
|
|
1030
1117
|
}
|
|
@@ -1046,13 +1133,16 @@ export async function sendGroupWithExactOutbox(context, groupId, plaintextBytes,
|
|
|
1046
1133
|
const syncMessages = context.relay
|
|
1047
1134
|
? await context.prepareSyncMessages(groupId, contentBytes, clientTimestamp, options.clientMessageId, await context.resolveOwnDevices())
|
|
1048
1135
|
: [];
|
|
1136
|
+
const createdAt = Date.now();
|
|
1049
1137
|
const intent = {
|
|
1050
1138
|
kind: 'group',
|
|
1051
1139
|
clientMessageId: options.clientMessageId,
|
|
1052
1140
|
recipientId: groupId,
|
|
1053
1141
|
plaintextDigest,
|
|
1054
1142
|
clientTimestamp,
|
|
1055
|
-
createdAt
|
|
1143
|
+
createdAt,
|
|
1144
|
+
deadlineAt: outgoingMessageDeadlineAt({ createdAt, clientTimestamp }),
|
|
1145
|
+
progressFromStart: true,
|
|
1056
1146
|
transportMode: groupSharedMessage
|
|
1057
1147
|
? context.deliveryMode === 'required'
|
|
1058
1148
|
? 'sealed_sender_required'
|
|
@@ -1071,13 +1161,15 @@ export async function sendGroupWithExactOutbox(context, groupId, plaintextBytes,
|
|
|
1071
1161
|
}),
|
|
1072
1162
|
...(groupSharedMessage && { groupSharedMessage }),
|
|
1073
1163
|
...(options.contentHint !== undefined && { contentHint: options.contentHint }),
|
|
1164
|
+
...intentBinaryAttachment(options),
|
|
1074
1165
|
};
|
|
1075
1166
|
await storeSendLog(context, intent, contentBytes);
|
|
1076
1167
|
await storeOutgoingMessageIntent(context.storage, intent);
|
|
1168
|
+
context.bindEvidence(intent);
|
|
1077
1169
|
if (context.deviceSets && context.relay) {
|
|
1078
1170
|
return sendDeclaredGroupIntent(context, context.deviceSets, intent, plaintextBytes);
|
|
1079
1171
|
}
|
|
1080
1172
|
return sendStoredGroupIntent(context, intent, plaintextBytes);
|
|
1081
|
-
});
|
|
1173
|
+
}, report);
|
|
1082
1174
|
}
|
|
1083
1175
|
//# sourceMappingURL=group-outbox.js.map
|