@rapidmx/web-client 0.19.0 → 0.20.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.
Files changed (131) hide show
  1. package/README.md +381 -381
  2. package/apps/admin/branding/index.tsx +39 -39
  3. package/apps/admin/data-requests/index.tsx +482 -482
  4. package/apps/admin/domains/[uid].tsx +166 -166
  5. package/apps/admin/escrow-scopes/[uid].tsx +350 -350
  6. package/apps/admin/index.tsx +129 -129
  7. package/apps/admin/mailboxes/[uid].tsx +271 -271
  8. package/apps/admin/mailboxes/new/index.tsx +30 -30
  9. package/apps/admin/plugins/index.tsx +15 -15
  10. package/apps/admin/retention-policy/index.tsx +39 -39
  11. package/apps/admin/signing-certificates/index.tsx +343 -343
  12. package/apps/escrow/audit-log/index.tsx +196 -196
  13. package/apps/escrow/matters/[uid].tsx +621 -621
  14. package/apps/shared/auth/adminAccess.ts +99 -99
  15. package/apps/shared/components/admin/diagnostics/HostCard.tsx +2 -0
  16. package/apps/shared/components/admin/diagnostics/PressureTiles.tsx +108 -0
  17. package/apps/shared/components/admin/diagnostics/PvcTable.tsx +20 -6
  18. package/apps/shared/components/admin/diagnostics/diagnosticsApi.ts +21 -2
  19. package/apps/shared/components/admin/layout/AdminShell.tsx +384 -384
  20. package/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.tsx +238 -238
  21. package/apps/shared/components/admin/mailboxes/EscrowScopeCard.tsx +152 -152
  22. package/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.tsx +194 -194
  23. package/apps/shared/components/admin/settings/BrandingForm.tsx +423 -423
  24. package/apps/shared/components/admin/settings/EncryptionPolicyForm.tsx +119 -119
  25. package/apps/shared/components/admin/settings/MailboxPolicyForm.tsx +198 -198
  26. package/apps/shared/components/admin/settings/PluginsManager.tsx +2093 -1620
  27. package/apps/shared/components/admin/settings/RetentionPolicyForm.tsx +182 -182
  28. package/apps/shared/components/admin/settings/pluginPreferences.ts +34 -0
  29. package/apps/shared/components/admin/setup/EscrowSetupStep.tsx +288 -288
  30. package/apps/shared/components/admin/setup/SetupWizard.tsx +446 -446
  31. package/apps/shared/components/admin/usePagedList.tsx +129 -129
  32. package/apps/shared/components/calendar/EventModal.tsx +206 -206
  33. package/apps/shared/components/calendar/MonthView.tsx +185 -185
  34. package/apps/shared/components/calendar/RecurrenceEditor.tsx +227 -227
  35. package/apps/shared/components/calendar/SplitDayView.tsx +144 -144
  36. package/apps/shared/components/calendar/TimeGridView.tsx +246 -246
  37. package/apps/shared/components/calendar/allDay.ts +124 -124
  38. package/apps/shared/components/contacts/ContactForm.tsx +383 -383
  39. package/apps/shared/components/contacts/ContactsToolbar.tsx +103 -103
  40. package/apps/shared/components/escrow/layout/EscrowShell.tsx +155 -155
  41. package/apps/shared/components/layout/AppShell.tsx +461 -461
  42. package/apps/shared/components/layout/KeyEnrollmentGate.tsx +398 -398
  43. package/apps/shared/components/layout/MailboxProvisioning.tsx +168 -168
  44. package/apps/shared/components/layout/ResponsiveToolbar.tsx +315 -315
  45. package/apps/shared/components/layout/ThemeSwitch.tsx +84 -84
  46. package/apps/shared/components/layout/UserMenu.tsx +439 -439
  47. package/apps/shared/components/mail/ConversationList.tsx +332 -323
  48. package/apps/shared/components/mail/ConversationThreadPane.tsx +613 -613
  49. package/apps/shared/components/mail/MailSelectionBar.tsx +240 -240
  50. package/apps/shared/components/mail/MenuButton.tsx +404 -404
  51. package/apps/shared/components/mail/MessageDetailPane.tsx +1757 -1757
  52. package/apps/shared/components/mail/compose/ComposeContext.tsx +312 -312
  53. package/apps/shared/components/mail/compose/ComposeToolbar.tsx +422 -422
  54. package/apps/shared/components/mail/compose/ComposeWindow.tsx +1681 -1681
  55. package/apps/shared/components/mail/compose/RichTextEditor.tsx +147 -147
  56. package/apps/shared/components/mail/compose/composeFlushRegistry.ts +60 -60
  57. package/apps/shared/components/mail/compose/quotedBody.ts +161 -161
  58. package/apps/shared/components/mail/listPreferences.ts +3 -3
  59. package/apps/shared/components/mail/reading/MessageMoreMenu.tsx +258 -258
  60. package/apps/shared/components/mail/reading/MessageSourceDialog.tsx +79 -79
  61. package/apps/shared/components/mail/reading/messageExport.ts +59 -59
  62. package/apps/shared/components/mail/reading/printMessage.ts +99 -99
  63. package/apps/shared/components/mail/reading/useMessageActions.ts +443 -443
  64. package/apps/shared/components/mail/verificationSeals.ts +125 -125
  65. package/apps/shared/components/rules/RuleBuilder.tsx +311 -311
  66. package/apps/shared/components/settings/SigningCertificateCard.tsx +344 -344
  67. package/apps/shared/keyboard/GlobalShortcuts.tsx +51 -51
  68. package/apps/shared/keyboard/ShortcutProvider.tsx +62 -62
  69. package/apps/shared/keyboard/ShortcutsDialog.tsx +84 -84
  70. package/apps/shared/keyboard/dispatch.ts +124 -124
  71. package/apps/shared/keyboard/format.ts +89 -89
  72. package/apps/shared/keyboard/keymap.ts +114 -114
  73. package/apps/shared/keyboard/registry.ts +65 -65
  74. package/apps/shared/keyboard/targets.ts +79 -79
  75. package/apps/shared/mail/folderOfType.ts +49 -49
  76. package/apps/shared/mail/folderTree.ts +143 -143
  77. package/apps/shared/mail/listAllPages.ts +39 -39
  78. package/apps/shared/mail/newMailNotifications.ts +171 -171
  79. package/apps/shared/mail/outbox/sendJob.ts +445 -445
  80. package/apps/shared/mail/outbox/sendOutcomes.ts +155 -155
  81. package/apps/shared/mail/reportNotices.ts +66 -66
  82. package/apps/shared/mail/senderBlocking.ts +141 -141
  83. package/apps/shared/mail/useMailConnection.ts +205 -205
  84. package/apps/shared/mail/useMailLiveUpdates.ts +277 -277
  85. package/apps/shared/mail/useMailboxUpdateAccess.ts +60 -60
  86. package/apps/shared/mail/useMarkMessageRead.ts +47 -47
  87. package/apps/shared/mail/useNewMailNotifications.ts +178 -178
  88. package/apps/shared/notifications/store.ts +560 -560
  89. package/apps/shared/search/LocalIndexLifecycle.tsx +114 -114
  90. package/apps/shared/search/localIndexBuilder.ts +481 -481
  91. package/apps/shared/signing/enrollmentStorage.ts +33 -33
  92. package/apps/shared/signing/enrollmentTracker.ts +385 -385
  93. package/apps/shared/signing/enrollmentView.ts +251 -251
  94. package/apps/shared/signing/useNow.ts +19 -19
  95. package/apps/shared/signing/useSigningEnrollmentWatcher.ts +90 -90
  96. package/apps/shared/styles/app.css +396 -396
  97. package/apps/www/calendar/index.tsx +581 -581
  98. package/apps/www/contacts/[uid].tsx +112 -112
  99. package/apps/www/index.tsx +3012 -2962
  100. package/apps/www/messages/[uid].tsx +139 -139
  101. package/apps/www/settings/auto-reply/index.tsx +136 -136
  102. package/apps/www/settings/blocked-senders/index.tsx +303 -303
  103. package/apps/www/settings/encryption/index.tsx +1290 -1290
  104. package/apps/www/settings/filters/[uid].tsx +179 -179
  105. package/apps/www/settings/filters/index.tsx +105 -105
  106. package/apps/www/settings/filters/new/index.tsx +165 -165
  107. package/apps/www/settings/labels/index.tsx +207 -207
  108. package/apps/www/settings/privacy/index.tsx +495 -495
  109. package/apps/www/settings/profile/index.tsx +251 -251
  110. package/apps/www/settings/read-receipts/index.tsx +150 -150
  111. package/apps/www/settings/sharing/index.tsx +259 -259
  112. package/apps/www/settings/signatures/[uid].tsx +175 -175
  113. package/apps/www/settings/signatures/index.tsx +91 -91
  114. package/apps/www/settings/signatures/new/index.tsx +138 -138
  115. package/apps/www/tasks/index.tsx +654 -654
  116. package/dist/apps/shared/components/admin/diagnostics/HostCard.js +2 -1
  117. package/dist/apps/shared/components/admin/diagnostics/PressureTiles.d.ts +22 -0
  118. package/dist/apps/shared/components/admin/diagnostics/PressureTiles.js +52 -0
  119. package/dist/apps/shared/components/admin/diagnostics/PvcTable.js +9 -4
  120. package/dist/apps/shared/components/admin/diagnostics/diagnosticsApi.d.ts +35 -2
  121. package/dist/apps/shared/components/admin/settings/BrandingForm.js +3 -3
  122. package/dist/apps/shared/components/admin/settings/PluginsManager.js +267 -35
  123. package/dist/apps/shared/components/admin/settings/pluginPreferences.d.ts +2 -0
  124. package/dist/apps/shared/components/admin/settings/pluginPreferences.js +35 -0
  125. package/dist/apps/shared/components/mail/ConversationList.d.ts +10 -3
  126. package/dist/apps/shared/components/mail/ConversationList.js +9 -5
  127. package/dist/apps/shared/components/mail/listPreferences.d.ts +1 -1
  128. package/dist/apps/shared/components/mail/reading/printMessage.js +11 -11
  129. package/dist/apps/shared/styles/app.css +396 -396
  130. package/dist/apps/www/index.js +51 -10
  131. package/package.json +2 -2
@@ -1,288 +1,288 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2026 Jean-Philippe Steinmetz
3
- // SPDX-License-Identifier: MPL-2.0
4
- ///////////////////////////////////////////////////////////////////////////////
5
- import React, { FormEvent, useEffect, useState } from "react";
6
- import { ApiRequestError } from "@rapidmx/react-shared/util/api.js";
7
- import { createEscrowScope, EscrowScope, listEscrowScopes } from "@rapidmx/react-shared/admin/escrowScopesApi.js";
8
- import { generateEscrowKeyPair, GeneratedEscrowKeys } from "@rapidmx/react-shared/crypto/escrowKeys.js";
9
- import { toDatetimeLocal } from "@rapidmx/react-shared/util/dateInput.js";
10
- import Alert from "@rapidmx/react-shared/components/feedback/Alert.js";
11
- import Button from "@rapidmx/react-shared/components/buttons/Button.js";
12
- import FormField from "@rapidmx/react-shared/components/forms/FormField.js";
13
- import EscrowScopeKeyAndHoldersFields, {
14
- emptyEscrowScopeKeyAndHoldersValue,
15
- EscrowScopeKeyAndHoldersValue,
16
- selfAsHolderError,
17
- } from "../escrowScopes/EscrowScopeKeyAndHoldersFields.js";
18
-
19
- const INPUT_CLASS =
20
- "w-full text-sm py-2.5 px-3 border border-border rounded-sm bg-surface text-text focus:outline-none focus:border-primary";
21
-
22
- type Mode = "none" | "generate" | "existing";
23
-
24
- /** How long a download's object URL is kept, since some browsers are still reading it after the click returns. */
25
- export const DOWNLOAD_URL_LIFETIME_MS = 60_000;
26
-
27
- /** Offers `text` to the browser as a file download. */
28
- export function downloadTextFile(filename: string, text: string, type: string = "application/x-pem-file"): void {
29
- const url = URL.createObjectURL(new Blob([text], { type }));
30
- const link = document.createElement("a");
31
- link.href = url;
32
- link.download = filename;
33
- document.body.appendChild(link);
34
- link.click();
35
- link.remove();
36
- setTimeout(() => URL.revokeObjectURL(url), DOWNLOAD_URL_LIFETIME_MS);
37
- }
38
-
39
- function fileSafe(name: string): string {
40
- return name.trim().replace(/[^A-Za-z0-9._-]+/g, "-").replace(/^-+|-+$/g, "") || "escrow";
41
- }
42
-
43
- /**
44
- * The setup wizard's escrow step. Escrow lets a separate group of holders recover a mailbox's encrypted mail (for
45
- * example for legal discovery) using a key this server never has. It's optional, and the administrator can either
46
- * generate the key pair here (downloading the private key, which never leaves the browser), paste in an existing
47
- * certificate, or go without escrow.
48
- */
49
- export default function EscrowSetupStep({ adminUid }: { adminUid?: string }) {
50
- const [scopes, setScopes] = useState<EscrowScope[] | null>(null);
51
- const [mode, setMode] = useState<Mode>("none");
52
- const [name, setName] = useState("Escrow");
53
- const [validYears, setValidYears] = useState(5);
54
- const [generated, setGenerated] = useState<GeneratedEscrowKeys | null>(null);
55
- const [downloadedPrivateKey, setDownloadedPrivateKey] = useState(false);
56
- const [savedPrivateKey, setSavedPrivateKey] = useState(false);
57
- const [keyAndHolders, setKeyAndHolders] = useState<EscrowScopeKeyAndHoldersValue>(emptyEscrowScopeKeyAndHoldersValue());
58
- const [error, setError] = useState<string | null>(null);
59
- const [busy, setBusy] = useState(false);
60
-
61
- useEffect(() => {
62
- listEscrowScopes({ limit: 100 })
63
- .then(setScopes)
64
- .catch(() => setScopes([]));
65
- }, []);
66
-
67
- function chooseMode(next: Mode) {
68
- setMode(next);
69
- setError(null);
70
- setGenerated(null);
71
- setDownloadedPrivateKey(false);
72
- setSavedPrivateKey(false);
73
- setKeyAndHolders(emptyEscrowScopeKeyAndHoldersValue());
74
- }
75
-
76
- async function generate() {
77
- if (!name.trim()) {
78
- setError("Give the escrow scope a name first.");
79
- return;
80
- }
81
- setBusy(true);
82
- setError(null);
83
- try {
84
- const keys = await generateEscrowKeyPair({ name: name.trim(), validDays: validYears * 365 });
85
- setGenerated(keys);
86
- setKeyAndHolders({
87
- ...emptyEscrowScopeKeyAndHoldersValue(),
88
- publicKey: keys.publicKey.publicKey,
89
- keyType: keys.publicKey.type,
90
- fingerprint: keys.publicKey.fingerprint,
91
- notBefore: toDatetimeLocal(new Date(keys.publicKey.notBefore).toISOString()),
92
- notAfter: toDatetimeLocal(new Date(keys.publicKey.notAfter).toISOString()),
93
- });
94
- } catch {
95
- setError("This browser couldn't generate the escrow keys.");
96
- } finally {
97
- setBusy(false);
98
- }
99
- }
100
-
101
- async function create(e: FormEvent) {
102
- e.preventDefault();
103
- setError(null);
104
- if (!name.trim()) {
105
- setError("A name is required.");
106
- return;
107
- }
108
- // Generated keys are used exactly as generated; only a pasted-in certificate's fields come from the form.
109
- const publicKey = generated
110
- ? generated.publicKey
111
- : {
112
- publicKey: keyAndHolders.publicKey.trim(),
113
- type: keyAndHolders.keyType.trim(),
114
- fingerprint: keyAndHolders.fingerprint.trim(),
115
- notBefore: new Date(keyAndHolders.notBefore).getTime(),
116
- notAfter: new Date(keyAndHolders.notAfter).getTime(),
117
- };
118
- if (!publicKey.publicKey || !publicKey.type || !publicKey.fingerprint) {
119
- setError("The public key, its type, and its fingerprint are all required.");
120
- return;
121
- }
122
- if (keyAndHolders.holderUserUids.length === 0) {
123
- setError("At least one holder is required.");
124
- return;
125
- }
126
- if (keyAndHolders.requiredHolders < 1 || keyAndHolders.requiredHolders > keyAndHolders.holderUserUids.length) {
127
- setError("Required holders must be between 1 and the number of holders.");
128
- return;
129
- }
130
- const selfError = selfAsHolderError(keyAndHolders.holderUserUids, adminUid);
131
- if (selfError) {
132
- setError(selfError);
133
- return;
134
- }
135
- setBusy(true);
136
- try {
137
- const created = await createEscrowScope({
138
- name: name.trim(),
139
- publicKey,
140
- holderUserUids: keyAndHolders.holderUserUids,
141
- requiredHolders: keyAndHolders.requiredHolders,
142
- notifySubjectOnAccess: keyAndHolders.notifySubjectOnAccess,
143
- });
144
- setScopes((prev) => [...(prev ?? []), created]);
145
- chooseMode("none");
146
- setName("Escrow");
147
- } catch (err) {
148
- setError(err instanceof ApiRequestError ? err.message : "Could not create the escrow scope.");
149
- } finally {
150
- setBusy(false);
151
- }
152
- }
153
-
154
- const scopeForm = (
155
- <form onSubmit={create} className="flex flex-col gap-5">
156
- <EscrowScopeKeyAndHoldersFields
157
- value={keyAndHolders}
158
- onChange={setKeyAndHolders}
159
- disabled={mode === "generate" && busy}
160
- keyReadOnly={mode === "generate"}
161
- />
162
- <div>
163
- <Button type="submit" loading={busy} disabled={busy} className="!w-auto">
164
- Create escrow scope
165
- </Button>
166
- </div>
167
- </form>
168
- );
169
-
170
- return (
171
- <div className="flex flex-col gap-5 max-w-3xl">
172
- {/* The setup wizard heads this step, so it only explains what escrow is. */}
173
- <p className="text-sm text-text-muted">
174
- Escrow lets a group of trusted holders - for example your legal or compliance team - recover a
175
- mailbox&rsquo;s encrypted mail when they all agree to. It&rsquo;s optional. Without it, mail that someone
176
- encrypts can&rsquo;t be recovered if they lose their keys, by anyone.
177
- </p>
178
-
179
- {scopes && scopes.length > 0 && (
180
- <div role="status" className="text-sm py-2 px-3 rounded-sm bg-surface-alt text-text">
181
- Escrow scopes set up: {scopes.map((scope) => scope.name).join(", ")}.
182
- </div>
183
- )}
184
-
185
- {error && <Alert>{error}</Alert>}
186
-
187
- <fieldset className="flex flex-col gap-2 text-sm">
188
- <legend className="font-semibold mb-1">How do you want to set up escrow?</legend>
189
- <label className="flex items-center gap-2">
190
- <input type="radio" name="escrow-mode" checked={mode === "generate"} onChange={() => chooseMode("generate")} />
191
- Generate new escrow keys in this browser
192
- </label>
193
- <label className="flex items-center gap-2">
194
- <input type="radio" name="escrow-mode" checked={mode === "existing"} onChange={() => chooseMode("existing")} />
195
- Use a certificate I already have
196
- </label>
197
- <label className="flex items-center gap-2">
198
- <input type="radio" name="escrow-mode" checked={mode === "none"} onChange={() => chooseMode("none")} />
199
- {scopes && scopes.length > 0 ? "Don't add another escrow scope" : "Don't use escrow"}
200
- </label>
201
- </fieldset>
202
-
203
- {mode !== "none" && (
204
- <div className="bg-surface border border-border rounded-md p-6">
205
- <FormField label="Escrow scope name" htmlFor="escrowName">
206
- <input
207
- id="escrowName"
208
- type="text"
209
- className={INPUT_CLASS}
210
- value={name}
211
- disabled={!!generated}
212
- onChange={(e) => setName(e.target.value)}
213
- />
214
- </FormField>
215
- {mode === "generate" && !generated && (
216
- <>
217
- <FormField label="Keys valid for" htmlFor="escrowValidYears">
218
- <select
219
- id="escrowValidYears"
220
- className={INPUT_CLASS}
221
- value={validYears}
222
- onChange={(e) => setValidYears(Number(e.target.value))}
223
- >
224
- {[1, 2, 5, 10].map((years) => (
225
- <option key={years} value={years}>
226
- {years} {years === 1 ? "year" : "years"}
227
- </option>
228
- ))}
229
- </select>
230
- </FormField>
231
- <Button type="button" className="!w-auto" loading={busy} disabled={busy} onClick={() => void generate()}>
232
- Generate keys
233
- </Button>
234
- </>
235
- )}
236
- {mode === "generate" && generated && (
237
- <div className="flex flex-col gap-3 text-sm">
238
- <Alert>
239
- Download the private key now and give it to your escrow holders. It isn&rsquo;t stored
240
- anywhere else - if it&rsquo;s lost, no escrowed mail can ever be recovered.
241
- </Alert>
242
- <Alert>
243
- You&rsquo;re downloading this private key, so you must not also be one of its holders:
244
- pick holders other than yourself, hand the key over, and delete your copy once they
245
- have it. Otherwise one person could both configure escrow and recover mail with it.
246
- </Alert>
247
- <div className="flex flex-wrap gap-2">
248
- <Button
249
- type="button"
250
- className="!w-auto"
251
- onClick={() => {
252
- downloadTextFile(`${fileSafe(name)}-private-key.pem`, generated.privateKeyPem);
253
- setDownloadedPrivateKey(true);
254
- }}
255
- >
256
- Download private key
257
- </Button>
258
- <Button
259
- type="button"
260
- variant="secondary"
261
- className="!w-auto"
262
- onClick={() => downloadTextFile(`${fileSafe(name)}-certificate.pem`, generated.certificatePem)}
263
- >
264
- Download certificate
265
- </Button>
266
- </div>
267
- <label className="flex items-center gap-2">
268
- <input
269
- type="checkbox"
270
- checked={savedPrivateKey}
271
- disabled={!downloadedPrivateKey}
272
- onChange={(e) => setSavedPrivateKey(e.target.checked)}
273
- />
274
- I&rsquo;ve saved the private key somewhere safe
275
- </label>
276
- {!downloadedPrivateKey && (
277
- <p className="text-xs text-text-muted">Download the private key before continuing.</p>
278
- )}
279
- </div>
280
- )}
281
- </div>
282
- )}
283
-
284
- {mode === "existing" && scopeForm}
285
- {mode === "generate" && generated && savedPrivateKey && scopeForm}
286
- </div>
287
- );
288
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2026 Jean-Philippe Steinmetz
3
+ // SPDX-License-Identifier: MPL-2.0
4
+ ///////////////////////////////////////////////////////////////////////////////
5
+ import React, { FormEvent, useEffect, useState } from "react";
6
+ import { ApiRequestError } from "@rapidmx/react-shared/util/api.js";
7
+ import { createEscrowScope, EscrowScope, listEscrowScopes } from "@rapidmx/react-shared/admin/escrowScopesApi.js";
8
+ import { generateEscrowKeyPair, GeneratedEscrowKeys } from "@rapidmx/react-shared/crypto/escrowKeys.js";
9
+ import { toDatetimeLocal } from "@rapidmx/react-shared/util/dateInput.js";
10
+ import Alert from "@rapidmx/react-shared/components/feedback/Alert.js";
11
+ import Button from "@rapidmx/react-shared/components/buttons/Button.js";
12
+ import FormField from "@rapidmx/react-shared/components/forms/FormField.js";
13
+ import EscrowScopeKeyAndHoldersFields, {
14
+ emptyEscrowScopeKeyAndHoldersValue,
15
+ EscrowScopeKeyAndHoldersValue,
16
+ selfAsHolderError,
17
+ } from "../escrowScopes/EscrowScopeKeyAndHoldersFields.js";
18
+
19
+ const INPUT_CLASS =
20
+ "w-full text-sm py-2.5 px-3 border border-border rounded-sm bg-surface text-text focus:outline-none focus:border-primary";
21
+
22
+ type Mode = "none" | "generate" | "existing";
23
+
24
+ /** How long a download's object URL is kept, since some browsers are still reading it after the click returns. */
25
+ export const DOWNLOAD_URL_LIFETIME_MS = 60_000;
26
+
27
+ /** Offers `text` to the browser as a file download. */
28
+ export function downloadTextFile(filename: string, text: string, type: string = "application/x-pem-file"): void {
29
+ const url = URL.createObjectURL(new Blob([text], { type }));
30
+ const link = document.createElement("a");
31
+ link.href = url;
32
+ link.download = filename;
33
+ document.body.appendChild(link);
34
+ link.click();
35
+ link.remove();
36
+ setTimeout(() => URL.revokeObjectURL(url), DOWNLOAD_URL_LIFETIME_MS);
37
+ }
38
+
39
+ function fileSafe(name: string): string {
40
+ return name.trim().replace(/[^A-Za-z0-9._-]+/g, "-").replace(/^-+|-+$/g, "") || "escrow";
41
+ }
42
+
43
+ /**
44
+ * The setup wizard's escrow step. Escrow lets a separate group of holders recover a mailbox's encrypted mail (for
45
+ * example for legal discovery) using a key this server never has. It's optional, and the administrator can either
46
+ * generate the key pair here (downloading the private key, which never leaves the browser), paste in an existing
47
+ * certificate, or go without escrow.
48
+ */
49
+ export default function EscrowSetupStep({ adminUid }: { adminUid?: string }) {
50
+ const [scopes, setScopes] = useState<EscrowScope[] | null>(null);
51
+ const [mode, setMode] = useState<Mode>("none");
52
+ const [name, setName] = useState("Escrow");
53
+ const [validYears, setValidYears] = useState(5);
54
+ const [generated, setGenerated] = useState<GeneratedEscrowKeys | null>(null);
55
+ const [downloadedPrivateKey, setDownloadedPrivateKey] = useState(false);
56
+ const [savedPrivateKey, setSavedPrivateKey] = useState(false);
57
+ const [keyAndHolders, setKeyAndHolders] = useState<EscrowScopeKeyAndHoldersValue>(emptyEscrowScopeKeyAndHoldersValue());
58
+ const [error, setError] = useState<string | null>(null);
59
+ const [busy, setBusy] = useState(false);
60
+
61
+ useEffect(() => {
62
+ listEscrowScopes({ limit: 100 })
63
+ .then(setScopes)
64
+ .catch(() => setScopes([]));
65
+ }, []);
66
+
67
+ function chooseMode(next: Mode) {
68
+ setMode(next);
69
+ setError(null);
70
+ setGenerated(null);
71
+ setDownloadedPrivateKey(false);
72
+ setSavedPrivateKey(false);
73
+ setKeyAndHolders(emptyEscrowScopeKeyAndHoldersValue());
74
+ }
75
+
76
+ async function generate() {
77
+ if (!name.trim()) {
78
+ setError("Give the escrow scope a name first.");
79
+ return;
80
+ }
81
+ setBusy(true);
82
+ setError(null);
83
+ try {
84
+ const keys = await generateEscrowKeyPair({ name: name.trim(), validDays: validYears * 365 });
85
+ setGenerated(keys);
86
+ setKeyAndHolders({
87
+ ...emptyEscrowScopeKeyAndHoldersValue(),
88
+ publicKey: keys.publicKey.publicKey,
89
+ keyType: keys.publicKey.type,
90
+ fingerprint: keys.publicKey.fingerprint,
91
+ notBefore: toDatetimeLocal(new Date(keys.publicKey.notBefore).toISOString()),
92
+ notAfter: toDatetimeLocal(new Date(keys.publicKey.notAfter).toISOString()),
93
+ });
94
+ } catch {
95
+ setError("This browser couldn't generate the escrow keys.");
96
+ } finally {
97
+ setBusy(false);
98
+ }
99
+ }
100
+
101
+ async function create(e: FormEvent) {
102
+ e.preventDefault();
103
+ setError(null);
104
+ if (!name.trim()) {
105
+ setError("A name is required.");
106
+ return;
107
+ }
108
+ // Generated keys are used exactly as generated; only a pasted-in certificate's fields come from the form.
109
+ const publicKey = generated
110
+ ? generated.publicKey
111
+ : {
112
+ publicKey: keyAndHolders.publicKey.trim(),
113
+ type: keyAndHolders.keyType.trim(),
114
+ fingerprint: keyAndHolders.fingerprint.trim(),
115
+ notBefore: new Date(keyAndHolders.notBefore).getTime(),
116
+ notAfter: new Date(keyAndHolders.notAfter).getTime(),
117
+ };
118
+ if (!publicKey.publicKey || !publicKey.type || !publicKey.fingerprint) {
119
+ setError("The public key, its type, and its fingerprint are all required.");
120
+ return;
121
+ }
122
+ if (keyAndHolders.holderUserUids.length === 0) {
123
+ setError("At least one holder is required.");
124
+ return;
125
+ }
126
+ if (keyAndHolders.requiredHolders < 1 || keyAndHolders.requiredHolders > keyAndHolders.holderUserUids.length) {
127
+ setError("Required holders must be between 1 and the number of holders.");
128
+ return;
129
+ }
130
+ const selfError = selfAsHolderError(keyAndHolders.holderUserUids, adminUid);
131
+ if (selfError) {
132
+ setError(selfError);
133
+ return;
134
+ }
135
+ setBusy(true);
136
+ try {
137
+ const created = await createEscrowScope({
138
+ name: name.trim(),
139
+ publicKey,
140
+ holderUserUids: keyAndHolders.holderUserUids,
141
+ requiredHolders: keyAndHolders.requiredHolders,
142
+ notifySubjectOnAccess: keyAndHolders.notifySubjectOnAccess,
143
+ });
144
+ setScopes((prev) => [...(prev ?? []), created]);
145
+ chooseMode("none");
146
+ setName("Escrow");
147
+ } catch (err) {
148
+ setError(err instanceof ApiRequestError ? err.message : "Could not create the escrow scope.");
149
+ } finally {
150
+ setBusy(false);
151
+ }
152
+ }
153
+
154
+ const scopeForm = (
155
+ <form onSubmit={create} className="flex flex-col gap-5">
156
+ <EscrowScopeKeyAndHoldersFields
157
+ value={keyAndHolders}
158
+ onChange={setKeyAndHolders}
159
+ disabled={mode === "generate" && busy}
160
+ keyReadOnly={mode === "generate"}
161
+ />
162
+ <div>
163
+ <Button type="submit" loading={busy} disabled={busy} className="!w-auto">
164
+ Create escrow scope
165
+ </Button>
166
+ </div>
167
+ </form>
168
+ );
169
+
170
+ return (
171
+ <div className="flex flex-col gap-5 max-w-3xl">
172
+ {/* The setup wizard heads this step, so it only explains what escrow is. */}
173
+ <p className="text-sm text-text-muted">
174
+ Escrow lets a group of trusted holders - for example your legal or compliance team - recover a
175
+ mailbox&rsquo;s encrypted mail when they all agree to. It&rsquo;s optional. Without it, mail that someone
176
+ encrypts can&rsquo;t be recovered if they lose their keys, by anyone.
177
+ </p>
178
+
179
+ {scopes && scopes.length > 0 && (
180
+ <div role="status" className="text-sm py-2 px-3 rounded-sm bg-surface-alt text-text">
181
+ Escrow scopes set up: {scopes.map((scope) => scope.name).join(", ")}.
182
+ </div>
183
+ )}
184
+
185
+ {error && <Alert>{error}</Alert>}
186
+
187
+ <fieldset className="flex flex-col gap-2 text-sm">
188
+ <legend className="font-semibold mb-1">How do you want to set up escrow?</legend>
189
+ <label className="flex items-center gap-2">
190
+ <input type="radio" name="escrow-mode" checked={mode === "generate"} onChange={() => chooseMode("generate")} />
191
+ Generate new escrow keys in this browser
192
+ </label>
193
+ <label className="flex items-center gap-2">
194
+ <input type="radio" name="escrow-mode" checked={mode === "existing"} onChange={() => chooseMode("existing")} />
195
+ Use a certificate I already have
196
+ </label>
197
+ <label className="flex items-center gap-2">
198
+ <input type="radio" name="escrow-mode" checked={mode === "none"} onChange={() => chooseMode("none")} />
199
+ {scopes && scopes.length > 0 ? "Don't add another escrow scope" : "Don't use escrow"}
200
+ </label>
201
+ </fieldset>
202
+
203
+ {mode !== "none" && (
204
+ <div className="bg-surface border border-border rounded-md p-6">
205
+ <FormField label="Escrow scope name" htmlFor="escrowName">
206
+ <input
207
+ id="escrowName"
208
+ type="text"
209
+ className={INPUT_CLASS}
210
+ value={name}
211
+ disabled={!!generated}
212
+ onChange={(e) => setName(e.target.value)}
213
+ />
214
+ </FormField>
215
+ {mode === "generate" && !generated && (
216
+ <>
217
+ <FormField label="Keys valid for" htmlFor="escrowValidYears">
218
+ <select
219
+ id="escrowValidYears"
220
+ className={INPUT_CLASS}
221
+ value={validYears}
222
+ onChange={(e) => setValidYears(Number(e.target.value))}
223
+ >
224
+ {[1, 2, 5, 10].map((years) => (
225
+ <option key={years} value={years}>
226
+ {years} {years === 1 ? "year" : "years"}
227
+ </option>
228
+ ))}
229
+ </select>
230
+ </FormField>
231
+ <Button type="button" className="!w-auto" loading={busy} disabled={busy} onClick={() => void generate()}>
232
+ Generate keys
233
+ </Button>
234
+ </>
235
+ )}
236
+ {mode === "generate" && generated && (
237
+ <div className="flex flex-col gap-3 text-sm">
238
+ <Alert>
239
+ Download the private key now and give it to your escrow holders. It isn&rsquo;t stored
240
+ anywhere else - if it&rsquo;s lost, no escrowed mail can ever be recovered.
241
+ </Alert>
242
+ <Alert>
243
+ You&rsquo;re downloading this private key, so you must not also be one of its holders:
244
+ pick holders other than yourself, hand the key over, and delete your copy once they
245
+ have it. Otherwise one person could both configure escrow and recover mail with it.
246
+ </Alert>
247
+ <div className="flex flex-wrap gap-2">
248
+ <Button
249
+ type="button"
250
+ className="!w-auto"
251
+ onClick={() => {
252
+ downloadTextFile(`${fileSafe(name)}-private-key.pem`, generated.privateKeyPem);
253
+ setDownloadedPrivateKey(true);
254
+ }}
255
+ >
256
+ Download private key
257
+ </Button>
258
+ <Button
259
+ type="button"
260
+ variant="secondary"
261
+ className="!w-auto"
262
+ onClick={() => downloadTextFile(`${fileSafe(name)}-certificate.pem`, generated.certificatePem)}
263
+ >
264
+ Download certificate
265
+ </Button>
266
+ </div>
267
+ <label className="flex items-center gap-2">
268
+ <input
269
+ type="checkbox"
270
+ checked={savedPrivateKey}
271
+ disabled={!downloadedPrivateKey}
272
+ onChange={(e) => setSavedPrivateKey(e.target.checked)}
273
+ />
274
+ I&rsquo;ve saved the private key somewhere safe
275
+ </label>
276
+ {!downloadedPrivateKey && (
277
+ <p className="text-xs text-text-muted">Download the private key before continuing.</p>
278
+ )}
279
+ </div>
280
+ )}
281
+ </div>
282
+ )}
283
+
284
+ {mode === "existing" && scopeForm}
285
+ {mode === "generate" && generated && savedPrivateKey && scopeForm}
286
+ </div>
287
+ );
288
+ }