@serfab/cadre-host 0.10.0 → 0.12.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 (158) hide show
  1. package/README.md +406 -296
  2. package/dist/bin/host.d.ts +11 -7
  3. package/dist/bin/host.js +40 -12
  4. package/dist/bin/host.js.map +1 -1
  5. package/dist/installer/config.d.ts +4 -4
  6. package/dist/installer/config.js +5 -39
  7. package/dist/installer/config.js.map +1 -1
  8. package/dist/installer/identity.d.ts +8 -1
  9. package/dist/installer/identity.js +8 -1
  10. package/dist/installer/identity.js.map +1 -1
  11. package/dist/orchestrator/host-process-orchestrator.d.ts +2 -2
  12. package/dist/orchestrator/host-process-orchestrator.js +9 -4
  13. package/dist/orchestrator/host-process-orchestrator.js.map +1 -1
  14. package/dist/server/settings-store.d.ts +1 -1
  15. package/dist/server/settings-store.js +5 -1
  16. package/dist/server/settings-store.js.map +1 -1
  17. package/dist/server/static.js +38 -38
  18. package/dist/ui/assets/index-C-iks41M.js.map +1 -1
  19. package/dist/ui/index.html +12 -12
  20. package/package.json +4 -4
  21. package/service/cadre-host.service.tmpl +16 -16
  22. package/service/com.serfab.cadre-host.plist.tmpl +35 -35
  23. package/service/install-service.ps1 +98 -98
  24. package/service/uninstall-service.ps1 +19 -19
  25. package/src/__tests__/build-targets.test.ts +26 -26
  26. package/src/__tests__/cli-invite.smoke.test.ts +192 -192
  27. package/src/__tests__/cli-nat.smoke.test.ts +212 -212
  28. package/src/__tests__/cli.smoke.test.ts +51 -46
  29. package/src/__tests__/global-setup.ts +56 -51
  30. package/src/__tests__/host-owner.smoke.test.ts +123 -123
  31. package/src/__tests__/orchestrator-env-scrub.test.ts +140 -140
  32. package/src/__tests__/orchestrator-node-identity.test.ts +5 -5
  33. package/src/__tests__/orchestrator-owner.test.ts +198 -198
  34. package/src/__tests__/orchestrator-pin-keys.test.ts +153 -153
  35. package/src/__tests__/orchestrator-push.test.ts +145 -145
  36. package/src/__tests__/orchestrator.test.ts +951 -951
  37. package/src/auth/__tests__/duration.test.ts +28 -28
  38. package/src/auth/__tests__/self-label.test.ts +85 -85
  39. package/src/auth/__tests__/trust-circle-store.test.ts +115 -115
  40. package/src/auth/__tests__/trust-circle.test.ts +445 -445
  41. package/src/auth/duration.ts +33 -33
  42. package/src/auth/index.ts +21 -21
  43. package/src/auth/self-label.ts +74 -74
  44. package/src/auth/trust-circle-store.ts +155 -155
  45. package/src/auth/types.ts +99 -99
  46. package/src/bin/__tests__/cli-reference.test.ts +167 -0
  47. package/src/bin/host.ts +1326 -1299
  48. package/src/donation/__tests__/donation-service.test.ts +1068 -1068
  49. package/src/donation/__tests__/donation-supervisor.test.ts +510 -510
  50. package/src/donation/__tests__/fake-orchestrator.test.ts +168 -168
  51. package/src/donation/__tests__/fake-orchestrator.ts +225 -225
  52. package/src/donation/__tests__/grant-service.test.ts +213 -213
  53. package/src/donation/__tests__/grant-store.test.ts +113 -113
  54. package/src/donation/donation-service.ts +962 -962
  55. package/src/donation/donation-store.ts +171 -171
  56. package/src/donation/donation-supervisor.ts +388 -388
  57. package/src/donation/grant-service.ts +200 -200
  58. package/src/donation/grant-store.ts +152 -152
  59. package/src/donation/index.ts +64 -64
  60. package/src/donation/types.ts +243 -243
  61. package/src/installer/__tests__/config.test.ts +134 -112
  62. package/src/installer/__tests__/identity.test.ts +34 -34
  63. package/src/installer/__tests__/paths.test.ts +47 -47
  64. package/src/installer/__tests__/service-host.test.ts +62 -62
  65. package/src/installer/__tests__/wizard.test.ts +64 -64
  66. package/src/installer/config.ts +5 -43
  67. package/src/installer/identity.ts +56 -49
  68. package/src/installer/paths.ts +109 -109
  69. package/src/installer/platform.ts +27 -27
  70. package/src/installer/service-host/index.ts +21 -21
  71. package/src/installer/service-host/template.ts +21 -21
  72. package/src/installer/wizard.ts +103 -103
  73. package/src/nat/__tests__/address-resolver.test.ts +82 -82
  74. package/src/nat/__tests__/ddns-duckdns.test.ts +83 -83
  75. package/src/nat/__tests__/ddns-updater.test.ts +253 -253
  76. package/src/nat/__tests__/external-ip.test.ts +124 -124
  77. package/src/nat/__tests__/nat-service.test.ts +18 -0
  78. package/src/nat/__tests__/nat-store.test.ts +93 -93
  79. package/src/nat/__tests__/port-mapper.test.ts +191 -191
  80. package/src/nat/__tests__/reachability.test.ts +24 -24
  81. package/src/nat/__tests__/secrets.test.ts +178 -178
  82. package/src/nat/address-resolver.ts +51 -51
  83. package/src/nat/ddns/duckdns.ts +76 -76
  84. package/src/nat/ddns/index.ts +55 -55
  85. package/src/nat/ddns/updater.ts +243 -243
  86. package/src/nat/external-ip.ts +154 -154
  87. package/src/nat/index.ts +71 -71
  88. package/src/nat/nat-service.ts +501 -501
  89. package/src/nat/nat-store.ts +154 -154
  90. package/src/nat/port-mapper.ts +329 -329
  91. package/src/nat/reachability.ts +34 -34
  92. package/src/nat/secrets/file-store.ts +130 -130
  93. package/src/nat/secrets/index.ts +112 -112
  94. package/src/nat/secrets/keytar-store.ts +67 -67
  95. package/src/nat/types.ts +159 -159
  96. package/src/orchestrator/__tests__/node-identity.test.ts +62 -62
  97. package/src/orchestrator/host-process-orchestrator.ts +9 -4
  98. package/src/orchestrator/index.ts +10 -10
  99. package/src/orchestrator/log-rotator.ts +53 -53
  100. package/src/orchestrator/node-identity.ts +40 -40
  101. package/src/orchestrator/pid-liveness.ts +24 -24
  102. package/src/orchestrator/port-allocator.ts +91 -91
  103. package/src/orchestrator/state-store.ts +90 -90
  104. package/src/orchestrator/types.ts +141 -141
  105. package/src/owner/__tests__/owner-node-client.test.ts +194 -194
  106. package/src/owner/index.ts +12 -12
  107. package/src/owner/owner-node-client.ts +259 -259
  108. package/src/push/__tests__/push.test.ts +90 -90
  109. package/src/push/index.ts +146 -146
  110. package/src/server/__tests__/bus.test.ts +38 -38
  111. package/src/server/__tests__/error-handler.test.ts +118 -118
  112. package/src/server/__tests__/grants-admin-route.test.ts +73 -73
  113. package/src/server/__tests__/grants-route.test.ts +263 -263
  114. package/src/server/__tests__/nodes-route.test.ts +259 -259
  115. package/src/server/__tests__/origin-guard.test.ts +72 -72
  116. package/src/server/__tests__/publishers.test.ts +216 -216
  117. package/src/server/__tests__/server.smoke.test.ts +253 -253
  118. package/src/server/__tests__/settings-route.test.ts +195 -194
  119. package/src/server/__tests__/sse-route.test.ts +119 -119
  120. package/src/server/__tests__/static.test.ts +145 -145
  121. package/src/server/__tests__/status-route.test.ts +134 -134
  122. package/src/server/__tests__/strands-route.test.ts +233 -233
  123. package/src/server/error-handler.ts +178 -178
  124. package/src/server/events/bus.ts +42 -42
  125. package/src/server/events/sse-route.ts +81 -81
  126. package/src/server/events/types.ts +23 -23
  127. package/src/server/index.ts +267 -267
  128. package/src/server/origin-guard.ts +84 -84
  129. package/src/server/routes/grants-admin.ts +41 -41
  130. package/src/server/routes/grants.ts +210 -210
  131. package/src/server/routes/nat.ts +63 -63
  132. package/src/server/routes/nodes.ts +170 -170
  133. package/src/server/routes/settings.ts +123 -123
  134. package/src/server/routes/status.ts +118 -118
  135. package/src/server/routes/strands.ts +54 -54
  136. package/src/server/routes/trust-circle.ts +49 -49
  137. package/src/server/routes/update.ts +43 -43
  138. package/src/server/server.ts +122 -122
  139. package/src/server/settings-store.ts +5 -1
  140. package/src/server/static.ts +207 -207
  141. package/src/strands/__tests__/strand-service.test.ts +165 -165
  142. package/src/strands/index.ts +14 -14
  143. package/src/strands/strand-service.ts +135 -135
  144. package/src/strands/types.ts +102 -102
  145. package/src/update/__tests__/apply.test.ts +158 -158
  146. package/src/update/__tests__/manifest.test.ts +128 -128
  147. package/src/update/__tests__/release-key.test.ts +42 -42
  148. package/src/update/__tests__/sign.test.ts +78 -78
  149. package/src/update/__tests__/store.test.ts +81 -81
  150. package/src/update/__tests__/update-service.integration.test.ts +256 -256
  151. package/src/update/__tests__/version.test.ts +31 -31
  152. package/src/update/apply.ts +190 -190
  153. package/src/update/index.ts +341 -341
  154. package/src/update/release-key.ts +71 -71
  155. package/src/update/sign.ts +74 -74
  156. package/src/update/store.ts +101 -101
  157. package/src/update/types.ts +109 -109
  158. package/src/update/version.ts +80 -80
@@ -1,90 +1,90 @@
1
- import { describe, it, expect } from 'vitest';
2
-
3
- import type { SecretsStore } from '../../nat/secrets/index.js';
4
- import type { PushSettings } from '../../installer/config.js';
5
- import {
6
- resolvePushCredentials,
7
- setFcmSecret,
8
- setApnsSecret,
9
- clearPushSecret,
10
- pushAccount,
11
- pushStatus,
12
- } from '../index.js';
13
-
14
- /** In-memory SecretsStore for tests. */
15
- function fakeStore(): SecretsStore {
16
- const map = new Map<string, string>();
17
- return {
18
- async set(account, value) { map.set(account, value); },
19
- async get(account) { return map.get(account) ?? null; },
20
- async delete(account) { return map.delete(account); },
21
- async list() { return [...map.keys()]; },
22
- };
23
- }
24
-
25
- const FCM = { projectId: 'proj', clientEmail: 'svc@proj.iam', privateKey: 'FCM-PEM' };
26
- const APNS = { keyId: 'KID', teamId: 'TEAM', privateKey: 'P8-PEM' };
27
-
28
- describe('resolvePushCredentials', () => {
29
- it('returns undefined when no platform is configured (opt-in default)', async () => {
30
- const store = fakeStore();
31
- expect(await resolvePushCredentials(store, undefined)).toBeUndefined();
32
- });
33
-
34
- it('resolves an FCM-only bundle from the secret store', async () => {
35
- const store = fakeStore();
36
- await setFcmSecret(store, FCM);
37
- const push = await resolvePushCredentials(store, undefined);
38
- expect(push).toEqual({ fcm: FCM });
39
- });
40
-
41
- it('merges the APNs secret with non-secret bundleId/production from settings', async () => {
42
- const store = fakeStore();
43
- await setApnsSecret(store, APNS);
44
- const settings: PushSettings = { apns: { bundleId: 'com.example.app', production: true }, cooldownMs: 1000, debounceMs: 50 };
45
- const push = await resolvePushCredentials(store, settings);
46
- expect(push).toEqual({
47
- apns: { keyId: 'KID', teamId: 'TEAM', bundleId: 'com.example.app', privateKey: 'P8-PEM', production: true },
48
- cooldownMs: 1000,
49
- debounceMs: 50,
50
- });
51
- });
52
-
53
- it('combines both platforms when both secrets are present', async () => {
54
- const store = fakeStore();
55
- await setFcmSecret(store, FCM);
56
- await setApnsSecret(store, APNS);
57
- const push = await resolvePushCredentials(store, { apns: { bundleId: 'com.example.app' } });
58
- expect(push?.fcm).toEqual(FCM);
59
- expect(push?.apns?.bundleId).toBe('com.example.app');
60
- });
61
-
62
- it('throws on a partial APNs config (secret present but bundleId unset)', async () => {
63
- const store = fakeStore();
64
- await setApnsSecret(store, APNS);
65
- // No settings.apns.bundleId → bundleId resolves to '' → validation rejects.
66
- await expect(resolvePushCredentials(store, undefined)).rejects.toThrow(/push\.apns\.bundleId/);
67
- });
68
-
69
- it('keeps the FCM private key out of the secret-store account name', async () => {
70
- const store = fakeStore();
71
- await setFcmSecret(store, FCM);
72
- const accounts = await store.list();
73
- expect(accounts).toContain(pushAccount('fcm'));
74
- expect(accounts.join()).not.toContain('FCM-PEM');
75
- });
76
- });
77
-
78
- describe('clearPushSecret / pushStatus', () => {
79
- it('reports configured platforms and clears them', async () => {
80
- const store = fakeStore();
81
- await setFcmSecret(store, FCM);
82
- await setApnsSecret(store, APNS);
83
- expect(await pushStatus(store)).toEqual({ fcm: true, apns: true });
84
-
85
- expect(await clearPushSecret(store, 'fcm')).toBe(true);
86
- expect(await pushStatus(store)).toEqual({ fcm: false, apns: true });
87
-
88
- expect(await clearPushSecret(store, 'fcm')).toBe(false);
89
- });
90
- });
1
+ import { describe, it, expect } from 'vitest';
2
+
3
+ import type { SecretsStore } from '../../nat/secrets/index.js';
4
+ import type { PushSettings } from '../../installer/config.js';
5
+ import {
6
+ resolvePushCredentials,
7
+ setFcmSecret,
8
+ setApnsSecret,
9
+ clearPushSecret,
10
+ pushAccount,
11
+ pushStatus,
12
+ } from '../index.js';
13
+
14
+ /** In-memory SecretsStore for tests. */
15
+ function fakeStore(): SecretsStore {
16
+ const map = new Map<string, string>();
17
+ return {
18
+ async set(account, value) { map.set(account, value); },
19
+ async get(account) { return map.get(account) ?? null; },
20
+ async delete(account) { return map.delete(account); },
21
+ async list() { return [...map.keys()]; },
22
+ };
23
+ }
24
+
25
+ const FCM = { projectId: 'proj', clientEmail: 'svc@proj.iam', privateKey: 'FCM-PEM' };
26
+ const APNS = { keyId: 'KID', teamId: 'TEAM', privateKey: 'P8-PEM' };
27
+
28
+ describe('resolvePushCredentials', () => {
29
+ it('returns undefined when no platform is configured (opt-in default)', async () => {
30
+ const store = fakeStore();
31
+ expect(await resolvePushCredentials(store, undefined)).toBeUndefined();
32
+ });
33
+
34
+ it('resolves an FCM-only bundle from the secret store', async () => {
35
+ const store = fakeStore();
36
+ await setFcmSecret(store, FCM);
37
+ const push = await resolvePushCredentials(store, undefined);
38
+ expect(push).toEqual({ fcm: FCM });
39
+ });
40
+
41
+ it('merges the APNs secret with non-secret bundleId/production from settings', async () => {
42
+ const store = fakeStore();
43
+ await setApnsSecret(store, APNS);
44
+ const settings: PushSettings = { apns: { bundleId: 'com.example.app', production: true }, cooldownMs: 1000, debounceMs: 50 };
45
+ const push = await resolvePushCredentials(store, settings);
46
+ expect(push).toEqual({
47
+ apns: { keyId: 'KID', teamId: 'TEAM', bundleId: 'com.example.app', privateKey: 'P8-PEM', production: true },
48
+ cooldownMs: 1000,
49
+ debounceMs: 50,
50
+ });
51
+ });
52
+
53
+ it('combines both platforms when both secrets are present', async () => {
54
+ const store = fakeStore();
55
+ await setFcmSecret(store, FCM);
56
+ await setApnsSecret(store, APNS);
57
+ const push = await resolvePushCredentials(store, { apns: { bundleId: 'com.example.app' } });
58
+ expect(push?.fcm).toEqual(FCM);
59
+ expect(push?.apns?.bundleId).toBe('com.example.app');
60
+ });
61
+
62
+ it('throws on a partial APNs config (secret present but bundleId unset)', async () => {
63
+ const store = fakeStore();
64
+ await setApnsSecret(store, APNS);
65
+ // No settings.apns.bundleId → bundleId resolves to '' → validation rejects.
66
+ await expect(resolvePushCredentials(store, undefined)).rejects.toThrow(/push\.apns\.bundleId/);
67
+ });
68
+
69
+ it('keeps the FCM private key out of the secret-store account name', async () => {
70
+ const store = fakeStore();
71
+ await setFcmSecret(store, FCM);
72
+ const accounts = await store.list();
73
+ expect(accounts).toContain(pushAccount('fcm'));
74
+ expect(accounts.join()).not.toContain('FCM-PEM');
75
+ });
76
+ });
77
+
78
+ describe('clearPushSecret / pushStatus', () => {
79
+ it('reports configured platforms and clears them', async () => {
80
+ const store = fakeStore();
81
+ await setFcmSecret(store, FCM);
82
+ await setApnsSecret(store, APNS);
83
+ expect(await pushStatus(store)).toEqual({ fcm: true, apns: true });
84
+
85
+ expect(await clearPushSecret(store, 'fcm')).toBe(true);
86
+ expect(await pushStatus(store)).toEqual({ fcm: false, apns: true });
87
+
88
+ expect(await clearPushSecret(store, 'fcm')).toBe(false);
89
+ });
90
+ });
package/src/push/index.ts CHANGED
@@ -1,146 +1,146 @@
1
- /**
2
- * Push (FCM/APNs) credential storage + resolution for cadre-host.
3
- *
4
- * The platform-push secrets a self-hosted deployment provisions live in the host
5
- * secret store (keytar with file-store fallback — the same store DDNS tokens use);
6
- * the non-secret app-config bits (APNs bundle id / sandbox toggle, cooldown /
7
- * debounce) live in `host.config.json` (`PushSettings`). At node-spawn time the
8
- * orchestrator's `pushResolver` calls {@link resolvePushCredentials}, which reads
9
- * BOTH and merges them into the `PushCredentials` block written into the spawned
10
- * node's `cadre.json`.
11
- *
12
- * Secret hygiene: the FCM service-account fields and the APNs `.p8` key are stored
13
- * ONLY in the secret store, never in `host.config.json` and never in `state.json`.
14
- * They are re-read on every spawn so a restart picks up rotated keys, and the
15
- * resolver redacts on any log line. A partial credential set (a present platform
16
- * missing required fields) is rejected — fail fast, not at first push.
17
- */
18
-
19
- import debug from 'debug';
20
-
21
- import type { PushCredentials, FcmCredentials, ApnsCredentials } from '@serfab/cadre-core';
22
- import { validatePushCredentials } from '@serfab/cadre-core';
23
-
24
- import type { SecretsStore } from '../nat/secrets/index.js';
25
- import type { PushSettings } from '../installer/config.js';
26
-
27
- const log = debug('cadre:host:push');
28
-
29
- /** Push platform whose secret bundle lives in the secret store. */
30
- export type PushSecretPlatform = 'fcm' | 'apns';
31
-
32
- /** Build the secret-store account key for a platform's credential bundle. */
33
- export function pushAccount(platform: PushSecretPlatform): string {
34
- return `push:${platform}`;
35
- }
36
-
37
- /** FCM secret bundle persisted in the secret store (the whole set is sensitive). */
38
- export interface FcmSecret {
39
- projectId: string;
40
- clientEmail: string;
41
- /** Service-account RSA private key, PEM. */
42
- privateKey: string;
43
- }
44
-
45
- /**
46
- * APNs secret bundle persisted in the secret store. `bundleId` / `production` are
47
- * NOT here — they are non-secret app-config in {@link PushSettings}.
48
- */
49
- export interface ApnsSecret {
50
- keyId: string;
51
- teamId: string;
52
- /** `.p8` ES256 private key, PEM. */
53
- privateKey: string;
54
- }
55
-
56
- /** Store (or replace) the FCM service-account secret bundle. */
57
- export async function setFcmSecret(secrets: SecretsStore, secret: FcmSecret): Promise<void> {
58
- await secrets.set(pushAccount('fcm'), JSON.stringify(secret));
59
- }
60
-
61
- /** Store (or replace) the APNs auth-key secret bundle. */
62
- export async function setApnsSecret(secrets: SecretsStore, secret: ApnsSecret): Promise<void> {
63
- await secrets.set(pushAccount('apns'), JSON.stringify(secret));
64
- }
65
-
66
- /** Remove a platform's secret bundle. Returns true if one was present. */
67
- export async function clearPushSecret(secrets: SecretsStore, platform: PushSecretPlatform): Promise<boolean> {
68
- return secrets.delete(pushAccount(platform));
69
- }
70
-
71
- /** Read a platform's stored secret bundle, or null when unset. */
72
- async function readSecret<T>(secrets: SecretsStore, platform: PushSecretPlatform): Promise<T | null> {
73
- const raw = await secrets.get(pushAccount(platform));
74
- if (raw === null) return null;
75
- try {
76
- return JSON.parse(raw) as T;
77
- } catch (err) {
78
- throw new Error(`Stored ${platform} push secret is not valid JSON: ${(err as Error).message}`, { cause: err });
79
- }
80
- }
81
-
82
- /**
83
- * Resolve the full {@link PushCredentials} block to inject into a spawned node,
84
- * merging the secret-store bundles with the non-secret {@link PushSettings}.
85
- *
86
- * Returns `undefined` when NO platform is configured (push is opt-in — the node
87
- * then constructs no fan-out). Throws when a configured platform is incomplete
88
- * (e.g. APNs secret present but `bundleId` unset), so a misconfig surfaces at the
89
- * spawn boundary rather than silently at first push.
90
- */
91
- export async function resolvePushCredentials(
92
- secrets: SecretsStore,
93
- settings: PushSettings | undefined,
94
- ): Promise<PushCredentials | undefined> {
95
- const fcmSecret = await readSecret<FcmSecret>(secrets, 'fcm');
96
- const apnsSecret = await readSecret<ApnsSecret>(secrets, 'apns');
97
-
98
- if (!fcmSecret && !apnsSecret) return undefined;
99
-
100
- const push: PushCredentials = {};
101
- if (fcmSecret) {
102
- const fcm: FcmCredentials = {
103
- projectId: fcmSecret.projectId,
104
- clientEmail: fcmSecret.clientEmail,
105
- privateKey: fcmSecret.privateKey,
106
- };
107
- push.fcm = fcm;
108
- }
109
- if (apnsSecret) {
110
- const apns: ApnsCredentials = {
111
- keyId: apnsSecret.keyId,
112
- teamId: apnsSecret.teamId,
113
- bundleId: settings?.apns?.bundleId ?? '',
114
- privateKey: apnsSecret.privateKey,
115
- ...(settings?.apns?.production !== undefined ? { production: settings.apns.production } : {}),
116
- };
117
- push.apns = apns;
118
- }
119
- if (settings?.cooldownMs !== undefined) push.cooldownMs = settings.cooldownMs;
120
- if (settings?.debounceMs !== undefined) push.debounceMs = settings.debounceMs;
121
-
122
- const errors = validatePushCredentials(push);
123
- if (errors.length > 0) {
124
- throw new Error(`Invalid push credentials: ${errors.join('; ')}`);
125
- }
126
- log('resolved push credentials (fcm=%s apns=%s)', !!push.fcm, !!push.apns);
127
- return push;
128
- }
129
-
130
- /**
131
- * A description of which push platforms are configured, for the `push status` CLI
132
- * and any UI — derived without exposing any secret material.
133
- */
134
- export interface PushStatus {
135
- fcm: boolean;
136
- apns: boolean;
137
- }
138
-
139
- /** Report which platforms have a stored secret bundle (no secret material). */
140
- export async function pushStatus(secrets: SecretsStore): Promise<PushStatus> {
141
- const accounts = await secrets.list();
142
- return {
143
- fcm: accounts.includes(pushAccount('fcm')),
144
- apns: accounts.includes(pushAccount('apns')),
145
- };
146
- }
1
+ /**
2
+ * Push (FCM/APNs) credential storage + resolution for cadre-host.
3
+ *
4
+ * The platform-push secrets a self-hosted deployment provisions live in the host
5
+ * secret store (keytar with file-store fallback — the same store DDNS tokens use);
6
+ * the non-secret app-config bits (APNs bundle id / sandbox toggle, cooldown /
7
+ * debounce) live in `host.config.json` (`PushSettings`). At node-spawn time the
8
+ * orchestrator's `pushResolver` calls {@link resolvePushCredentials}, which reads
9
+ * BOTH and merges them into the `PushCredentials` block written into the spawned
10
+ * node's `cadre.json`.
11
+ *
12
+ * Secret hygiene: the FCM service-account fields and the APNs `.p8` key are stored
13
+ * ONLY in the secret store, never in `host.config.json` and never in `state.json`.
14
+ * They are re-read on every spawn so a restart picks up rotated keys, and the
15
+ * resolver redacts on any log line. A partial credential set (a present platform
16
+ * missing required fields) is rejected — fail fast, not at first push.
17
+ */
18
+
19
+ import debug from 'debug';
20
+
21
+ import type { PushCredentials, FcmCredentials, ApnsCredentials } from '@serfab/cadre-core';
22
+ import { validatePushCredentials } from '@serfab/cadre-core';
23
+
24
+ import type { SecretsStore } from '../nat/secrets/index.js';
25
+ import type { PushSettings } from '../installer/config.js';
26
+
27
+ const log = debug('cadre:host:push');
28
+
29
+ /** Push platform whose secret bundle lives in the secret store. */
30
+ export type PushSecretPlatform = 'fcm' | 'apns';
31
+
32
+ /** Build the secret-store account key for a platform's credential bundle. */
33
+ export function pushAccount(platform: PushSecretPlatform): string {
34
+ return `push:${platform}`;
35
+ }
36
+
37
+ /** FCM secret bundle persisted in the secret store (the whole set is sensitive). */
38
+ export interface FcmSecret {
39
+ projectId: string;
40
+ clientEmail: string;
41
+ /** Service-account RSA private key, PEM. */
42
+ privateKey: string;
43
+ }
44
+
45
+ /**
46
+ * APNs secret bundle persisted in the secret store. `bundleId` / `production` are
47
+ * NOT here — they are non-secret app-config in {@link PushSettings}.
48
+ */
49
+ export interface ApnsSecret {
50
+ keyId: string;
51
+ teamId: string;
52
+ /** `.p8` ES256 private key, PEM. */
53
+ privateKey: string;
54
+ }
55
+
56
+ /** Store (or replace) the FCM service-account secret bundle. */
57
+ export async function setFcmSecret(secrets: SecretsStore, secret: FcmSecret): Promise<void> {
58
+ await secrets.set(pushAccount('fcm'), JSON.stringify(secret));
59
+ }
60
+
61
+ /** Store (or replace) the APNs auth-key secret bundle. */
62
+ export async function setApnsSecret(secrets: SecretsStore, secret: ApnsSecret): Promise<void> {
63
+ await secrets.set(pushAccount('apns'), JSON.stringify(secret));
64
+ }
65
+
66
+ /** Remove a platform's secret bundle. Returns true if one was present. */
67
+ export async function clearPushSecret(secrets: SecretsStore, platform: PushSecretPlatform): Promise<boolean> {
68
+ return secrets.delete(pushAccount(platform));
69
+ }
70
+
71
+ /** Read a platform's stored secret bundle, or null when unset. */
72
+ async function readSecret<T>(secrets: SecretsStore, platform: PushSecretPlatform): Promise<T | null> {
73
+ const raw = await secrets.get(pushAccount(platform));
74
+ if (raw === null) return null;
75
+ try {
76
+ return JSON.parse(raw) as T;
77
+ } catch (err) {
78
+ throw new Error(`Stored ${platform} push secret is not valid JSON: ${(err as Error).message}`, { cause: err });
79
+ }
80
+ }
81
+
82
+ /**
83
+ * Resolve the full {@link PushCredentials} block to inject into a spawned node,
84
+ * merging the secret-store bundles with the non-secret {@link PushSettings}.
85
+ *
86
+ * Returns `undefined` when NO platform is configured (push is opt-in — the node
87
+ * then constructs no fan-out). Throws when a configured platform is incomplete
88
+ * (e.g. APNs secret present but `bundleId` unset), so a misconfig surfaces at the
89
+ * spawn boundary rather than silently at first push.
90
+ */
91
+ export async function resolvePushCredentials(
92
+ secrets: SecretsStore,
93
+ settings: PushSettings | undefined,
94
+ ): Promise<PushCredentials | undefined> {
95
+ const fcmSecret = await readSecret<FcmSecret>(secrets, 'fcm');
96
+ const apnsSecret = await readSecret<ApnsSecret>(secrets, 'apns');
97
+
98
+ if (!fcmSecret && !apnsSecret) return undefined;
99
+
100
+ const push: PushCredentials = {};
101
+ if (fcmSecret) {
102
+ const fcm: FcmCredentials = {
103
+ projectId: fcmSecret.projectId,
104
+ clientEmail: fcmSecret.clientEmail,
105
+ privateKey: fcmSecret.privateKey,
106
+ };
107
+ push.fcm = fcm;
108
+ }
109
+ if (apnsSecret) {
110
+ const apns: ApnsCredentials = {
111
+ keyId: apnsSecret.keyId,
112
+ teamId: apnsSecret.teamId,
113
+ bundleId: settings?.apns?.bundleId ?? '',
114
+ privateKey: apnsSecret.privateKey,
115
+ ...(settings?.apns?.production !== undefined ? { production: settings.apns.production } : {}),
116
+ };
117
+ push.apns = apns;
118
+ }
119
+ if (settings?.cooldownMs !== undefined) push.cooldownMs = settings.cooldownMs;
120
+ if (settings?.debounceMs !== undefined) push.debounceMs = settings.debounceMs;
121
+
122
+ const errors = validatePushCredentials(push);
123
+ if (errors.length > 0) {
124
+ throw new Error(`Invalid push credentials: ${errors.join('; ')}`);
125
+ }
126
+ log('resolved push credentials (fcm=%s apns=%s)', !!push.fcm, !!push.apns);
127
+ return push;
128
+ }
129
+
130
+ /**
131
+ * A description of which push platforms are configured, for the `push status` CLI
132
+ * and any UI — derived without exposing any secret material.
133
+ */
134
+ export interface PushStatus {
135
+ fcm: boolean;
136
+ apns: boolean;
137
+ }
138
+
139
+ /** Report which platforms have a stored secret bundle (no secret material). */
140
+ export async function pushStatus(secrets: SecretsStore): Promise<PushStatus> {
141
+ const accounts = await secrets.list();
142
+ return {
143
+ fcm: accounts.includes(pushAccount('fcm')),
144
+ apns: accounts.includes(pushAccount('apns')),
145
+ };
146
+ }
@@ -1,38 +1,38 @@
1
- import { describe, it, expect } from 'vitest';
2
-
3
- import { EventBus } from '../events/bus.js';
4
- import type { LocalUiEvent } from '../events/types.js';
5
-
6
- describe('EventBus', () => {
7
- it('delivers events to subscribers in order', () => {
8
- const bus = new EventBus();
9
- const received: LocalUiEvent[] = [];
10
- bus.subscribe((e) => received.push(e));
11
- bus.publish({ type: 'trust-circle-changed', kind: 'invited' });
12
- bus.publish({ type: 'trust-circle-changed', kind: 'revoked' });
13
- expect(received).toEqual([
14
- { type: 'trust-circle-changed', kind: 'invited' },
15
- { type: 'trust-circle-changed', kind: 'revoked' },
16
- ]);
17
- });
18
-
19
- it('unsubscribe stops further deliveries', () => {
20
- const bus = new EventBus();
21
- const received: LocalUiEvent[] = [];
22
- const unsub = bus.subscribe((e) => received.push(e));
23
- bus.publish({ type: 'trust-circle-changed', kind: 'invited' });
24
- unsub();
25
- bus.publish({ type: 'trust-circle-changed', kind: 'redeemed' });
26
- expect(received).toHaveLength(1);
27
- expect(bus.listenerCount()).toBe(0);
28
- });
29
-
30
- it('one listener throwing does not block others', () => {
31
- const bus = new EventBus();
32
- const received: LocalUiEvent[] = [];
33
- bus.subscribe(() => { throw new Error('bad listener'); });
34
- bus.subscribe((e) => received.push(e));
35
- bus.publish({ type: 'trust-circle-changed', kind: 'invited' });
36
- expect(received).toHaveLength(1);
37
- });
38
- });
1
+ import { describe, it, expect } from 'vitest';
2
+
3
+ import { EventBus } from '../events/bus.js';
4
+ import type { LocalUiEvent } from '../events/types.js';
5
+
6
+ describe('EventBus', () => {
7
+ it('delivers events to subscribers in order', () => {
8
+ const bus = new EventBus();
9
+ const received: LocalUiEvent[] = [];
10
+ bus.subscribe((e) => received.push(e));
11
+ bus.publish({ type: 'trust-circle-changed', kind: 'invited' });
12
+ bus.publish({ type: 'trust-circle-changed', kind: 'revoked' });
13
+ expect(received).toEqual([
14
+ { type: 'trust-circle-changed', kind: 'invited' },
15
+ { type: 'trust-circle-changed', kind: 'revoked' },
16
+ ]);
17
+ });
18
+
19
+ it('unsubscribe stops further deliveries', () => {
20
+ const bus = new EventBus();
21
+ const received: LocalUiEvent[] = [];
22
+ const unsub = bus.subscribe((e) => received.push(e));
23
+ bus.publish({ type: 'trust-circle-changed', kind: 'invited' });
24
+ unsub();
25
+ bus.publish({ type: 'trust-circle-changed', kind: 'redeemed' });
26
+ expect(received).toHaveLength(1);
27
+ expect(bus.listenerCount()).toBe(0);
28
+ });
29
+
30
+ it('one listener throwing does not block others', () => {
31
+ const bus = new EventBus();
32
+ const received: LocalUiEvent[] = [];
33
+ bus.subscribe(() => { throw new Error('bad listener'); });
34
+ bus.subscribe((e) => received.push(e));
35
+ bus.publish({ type: 'trust-circle-changed', kind: 'invited' });
36
+ expect(received).toHaveLength(1);
37
+ });
38
+ });