@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.
- package/README.md +406 -296
- package/dist/bin/host.d.ts +11 -7
- package/dist/bin/host.js +40 -12
- package/dist/bin/host.js.map +1 -1
- package/dist/installer/config.d.ts +4 -4
- package/dist/installer/config.js +5 -39
- package/dist/installer/config.js.map +1 -1
- package/dist/installer/identity.d.ts +8 -1
- package/dist/installer/identity.js +8 -1
- package/dist/installer/identity.js.map +1 -1
- package/dist/orchestrator/host-process-orchestrator.d.ts +2 -2
- package/dist/orchestrator/host-process-orchestrator.js +9 -4
- package/dist/orchestrator/host-process-orchestrator.js.map +1 -1
- package/dist/server/settings-store.d.ts +1 -1
- package/dist/server/settings-store.js +5 -1
- package/dist/server/settings-store.js.map +1 -1
- package/dist/server/static.js +38 -38
- package/dist/ui/assets/index-C-iks41M.js.map +1 -1
- package/dist/ui/index.html +12 -12
- package/package.json +4 -4
- package/service/cadre-host.service.tmpl +16 -16
- package/service/com.serfab.cadre-host.plist.tmpl +35 -35
- package/service/install-service.ps1 +98 -98
- package/service/uninstall-service.ps1 +19 -19
- package/src/__tests__/build-targets.test.ts +26 -26
- package/src/__tests__/cli-invite.smoke.test.ts +192 -192
- package/src/__tests__/cli-nat.smoke.test.ts +212 -212
- package/src/__tests__/cli.smoke.test.ts +51 -46
- package/src/__tests__/global-setup.ts +56 -51
- package/src/__tests__/host-owner.smoke.test.ts +123 -123
- package/src/__tests__/orchestrator-env-scrub.test.ts +140 -140
- package/src/__tests__/orchestrator-node-identity.test.ts +5 -5
- package/src/__tests__/orchestrator-owner.test.ts +198 -198
- package/src/__tests__/orchestrator-pin-keys.test.ts +153 -153
- package/src/__tests__/orchestrator-push.test.ts +145 -145
- package/src/__tests__/orchestrator.test.ts +951 -951
- package/src/auth/__tests__/duration.test.ts +28 -28
- package/src/auth/__tests__/self-label.test.ts +85 -85
- package/src/auth/__tests__/trust-circle-store.test.ts +115 -115
- package/src/auth/__tests__/trust-circle.test.ts +445 -445
- package/src/auth/duration.ts +33 -33
- package/src/auth/index.ts +21 -21
- package/src/auth/self-label.ts +74 -74
- package/src/auth/trust-circle-store.ts +155 -155
- package/src/auth/types.ts +99 -99
- package/src/bin/__tests__/cli-reference.test.ts +167 -0
- package/src/bin/host.ts +1326 -1299
- package/src/donation/__tests__/donation-service.test.ts +1068 -1068
- package/src/donation/__tests__/donation-supervisor.test.ts +510 -510
- package/src/donation/__tests__/fake-orchestrator.test.ts +168 -168
- package/src/donation/__tests__/fake-orchestrator.ts +225 -225
- package/src/donation/__tests__/grant-service.test.ts +213 -213
- package/src/donation/__tests__/grant-store.test.ts +113 -113
- package/src/donation/donation-service.ts +962 -962
- package/src/donation/donation-store.ts +171 -171
- package/src/donation/donation-supervisor.ts +388 -388
- package/src/donation/grant-service.ts +200 -200
- package/src/donation/grant-store.ts +152 -152
- package/src/donation/index.ts +64 -64
- package/src/donation/types.ts +243 -243
- package/src/installer/__tests__/config.test.ts +134 -112
- package/src/installer/__tests__/identity.test.ts +34 -34
- package/src/installer/__tests__/paths.test.ts +47 -47
- package/src/installer/__tests__/service-host.test.ts +62 -62
- package/src/installer/__tests__/wizard.test.ts +64 -64
- package/src/installer/config.ts +5 -43
- package/src/installer/identity.ts +56 -49
- package/src/installer/paths.ts +109 -109
- package/src/installer/platform.ts +27 -27
- package/src/installer/service-host/index.ts +21 -21
- package/src/installer/service-host/template.ts +21 -21
- package/src/installer/wizard.ts +103 -103
- package/src/nat/__tests__/address-resolver.test.ts +82 -82
- package/src/nat/__tests__/ddns-duckdns.test.ts +83 -83
- package/src/nat/__tests__/ddns-updater.test.ts +253 -253
- package/src/nat/__tests__/external-ip.test.ts +124 -124
- package/src/nat/__tests__/nat-service.test.ts +18 -0
- package/src/nat/__tests__/nat-store.test.ts +93 -93
- package/src/nat/__tests__/port-mapper.test.ts +191 -191
- package/src/nat/__tests__/reachability.test.ts +24 -24
- package/src/nat/__tests__/secrets.test.ts +178 -178
- package/src/nat/address-resolver.ts +51 -51
- package/src/nat/ddns/duckdns.ts +76 -76
- package/src/nat/ddns/index.ts +55 -55
- package/src/nat/ddns/updater.ts +243 -243
- package/src/nat/external-ip.ts +154 -154
- package/src/nat/index.ts +71 -71
- package/src/nat/nat-service.ts +501 -501
- package/src/nat/nat-store.ts +154 -154
- package/src/nat/port-mapper.ts +329 -329
- package/src/nat/reachability.ts +34 -34
- package/src/nat/secrets/file-store.ts +130 -130
- package/src/nat/secrets/index.ts +112 -112
- package/src/nat/secrets/keytar-store.ts +67 -67
- package/src/nat/types.ts +159 -159
- package/src/orchestrator/__tests__/node-identity.test.ts +62 -62
- package/src/orchestrator/host-process-orchestrator.ts +9 -4
- package/src/orchestrator/index.ts +10 -10
- package/src/orchestrator/log-rotator.ts +53 -53
- package/src/orchestrator/node-identity.ts +40 -40
- package/src/orchestrator/pid-liveness.ts +24 -24
- package/src/orchestrator/port-allocator.ts +91 -91
- package/src/orchestrator/state-store.ts +90 -90
- package/src/orchestrator/types.ts +141 -141
- package/src/owner/__tests__/owner-node-client.test.ts +194 -194
- package/src/owner/index.ts +12 -12
- package/src/owner/owner-node-client.ts +259 -259
- package/src/push/__tests__/push.test.ts +90 -90
- package/src/push/index.ts +146 -146
- package/src/server/__tests__/bus.test.ts +38 -38
- package/src/server/__tests__/error-handler.test.ts +118 -118
- package/src/server/__tests__/grants-admin-route.test.ts +73 -73
- package/src/server/__tests__/grants-route.test.ts +263 -263
- package/src/server/__tests__/nodes-route.test.ts +259 -259
- package/src/server/__tests__/origin-guard.test.ts +72 -72
- package/src/server/__tests__/publishers.test.ts +216 -216
- package/src/server/__tests__/server.smoke.test.ts +253 -253
- package/src/server/__tests__/settings-route.test.ts +195 -194
- package/src/server/__tests__/sse-route.test.ts +119 -119
- package/src/server/__tests__/static.test.ts +145 -145
- package/src/server/__tests__/status-route.test.ts +134 -134
- package/src/server/__tests__/strands-route.test.ts +233 -233
- package/src/server/error-handler.ts +178 -178
- package/src/server/events/bus.ts +42 -42
- package/src/server/events/sse-route.ts +81 -81
- package/src/server/events/types.ts +23 -23
- package/src/server/index.ts +267 -267
- package/src/server/origin-guard.ts +84 -84
- package/src/server/routes/grants-admin.ts +41 -41
- package/src/server/routes/grants.ts +210 -210
- package/src/server/routes/nat.ts +63 -63
- package/src/server/routes/nodes.ts +170 -170
- package/src/server/routes/settings.ts +123 -123
- package/src/server/routes/status.ts +118 -118
- package/src/server/routes/strands.ts +54 -54
- package/src/server/routes/trust-circle.ts +49 -49
- package/src/server/routes/update.ts +43 -43
- package/src/server/server.ts +122 -122
- package/src/server/settings-store.ts +5 -1
- package/src/server/static.ts +207 -207
- package/src/strands/__tests__/strand-service.test.ts +165 -165
- package/src/strands/index.ts +14 -14
- package/src/strands/strand-service.ts +135 -135
- package/src/strands/types.ts +102 -102
- package/src/update/__tests__/apply.test.ts +158 -158
- package/src/update/__tests__/manifest.test.ts +128 -128
- package/src/update/__tests__/release-key.test.ts +42 -42
- package/src/update/__tests__/sign.test.ts +78 -78
- package/src/update/__tests__/store.test.ts +81 -81
- package/src/update/__tests__/update-service.integration.test.ts +256 -256
- package/src/update/__tests__/version.test.ts +31 -31
- package/src/update/apply.ts +190 -190
- package/src/update/index.ts +341 -341
- package/src/update/release-key.ts +71 -71
- package/src/update/sign.ts +74 -74
- package/src/update/store.ts +101 -101
- package/src/update/types.ts +109 -109
- package/src/update/version.ts +80 -80
|
@@ -1,67 +1,67 @@
|
|
|
1
|
-
import debug from 'debug';
|
|
2
|
-
|
|
3
|
-
import { NatError } from '../types.js';
|
|
4
|
-
import type { KeytarLike, SecretsStore } from './index.js';
|
|
5
|
-
|
|
6
|
-
const log = debug('cadre:host:nat-secrets:keytar');
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
* SecretsStore backed by the OS keychain via the `keytar` npm package.
|
|
10
|
-
*
|
|
11
|
-
* The keytar module is injected (rather than imported here) so:
|
|
12
|
-
* - The native dependency is loaded lazily by `createSecretsStore` and
|
|
13
|
-
* unavailable platforms fall through cleanly to the file store.
|
|
14
|
-
* - Unit tests can stub the entire keytar surface.
|
|
15
|
-
*/
|
|
16
|
-
export class KeytarSecretsStore implements SecretsStore {
|
|
17
|
-
constructor(
|
|
18
|
-
private readonly service: string,
|
|
19
|
-
private readonly keytar: KeytarLike,
|
|
20
|
-
) {}
|
|
21
|
-
|
|
22
|
-
async set(account: string, value: string): Promise<void> {
|
|
23
|
-
try {
|
|
24
|
-
await this.keytar.setPassword(this.service, account, value);
|
|
25
|
-
} catch (err) {
|
|
26
|
-
throw new NatError(
|
|
27
|
-
'secrets_unavailable',
|
|
28
|
-
`keytar setPassword failed: ${(err as Error).message}`,
|
|
29
|
-
);
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
async get(account: string): Promise<string | null> {
|
|
34
|
-
try {
|
|
35
|
-
return await this.keytar.getPassword(this.service, account);
|
|
36
|
-
} catch (err) {
|
|
37
|
-
throw new NatError(
|
|
38
|
-
'secrets_unavailable',
|
|
39
|
-
`keytar getPassword failed: ${(err as Error).message}`,
|
|
40
|
-
);
|
|
41
|
-
}
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
async delete(account: string): Promise<boolean> {
|
|
45
|
-
try {
|
|
46
|
-
return await this.keytar.deletePassword(this.service, account);
|
|
47
|
-
} catch (err) {
|
|
48
|
-
throw new NatError(
|
|
49
|
-
'secrets_unavailable',
|
|
50
|
-
`keytar deletePassword failed: ${(err as Error).message}`,
|
|
51
|
-
);
|
|
52
|
-
}
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
async list(): Promise<string[]> {
|
|
56
|
-
try {
|
|
57
|
-
const creds = await this.keytar.findCredentials(this.service);
|
|
58
|
-
log('keytar findCredentials returned %d entries', creds.length);
|
|
59
|
-
return creds.map((c) => c.account);
|
|
60
|
-
} catch (err) {
|
|
61
|
-
throw new NatError(
|
|
62
|
-
'secrets_unavailable',
|
|
63
|
-
`keytar findCredentials failed: ${(err as Error).message}`,
|
|
64
|
-
);
|
|
65
|
-
}
|
|
66
|
-
}
|
|
67
|
-
}
|
|
1
|
+
import debug from 'debug';
|
|
2
|
+
|
|
3
|
+
import { NatError } from '../types.js';
|
|
4
|
+
import type { KeytarLike, SecretsStore } from './index.js';
|
|
5
|
+
|
|
6
|
+
const log = debug('cadre:host:nat-secrets:keytar');
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* SecretsStore backed by the OS keychain via the `keytar` npm package.
|
|
10
|
+
*
|
|
11
|
+
* The keytar module is injected (rather than imported here) so:
|
|
12
|
+
* - The native dependency is loaded lazily by `createSecretsStore` and
|
|
13
|
+
* unavailable platforms fall through cleanly to the file store.
|
|
14
|
+
* - Unit tests can stub the entire keytar surface.
|
|
15
|
+
*/
|
|
16
|
+
export class KeytarSecretsStore implements SecretsStore {
|
|
17
|
+
constructor(
|
|
18
|
+
private readonly service: string,
|
|
19
|
+
private readonly keytar: KeytarLike,
|
|
20
|
+
) {}
|
|
21
|
+
|
|
22
|
+
async set(account: string, value: string): Promise<void> {
|
|
23
|
+
try {
|
|
24
|
+
await this.keytar.setPassword(this.service, account, value);
|
|
25
|
+
} catch (err) {
|
|
26
|
+
throw new NatError(
|
|
27
|
+
'secrets_unavailable',
|
|
28
|
+
`keytar setPassword failed: ${(err as Error).message}`,
|
|
29
|
+
);
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
async get(account: string): Promise<string | null> {
|
|
34
|
+
try {
|
|
35
|
+
return await this.keytar.getPassword(this.service, account);
|
|
36
|
+
} catch (err) {
|
|
37
|
+
throw new NatError(
|
|
38
|
+
'secrets_unavailable',
|
|
39
|
+
`keytar getPassword failed: ${(err as Error).message}`,
|
|
40
|
+
);
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
async delete(account: string): Promise<boolean> {
|
|
45
|
+
try {
|
|
46
|
+
return await this.keytar.deletePassword(this.service, account);
|
|
47
|
+
} catch (err) {
|
|
48
|
+
throw new NatError(
|
|
49
|
+
'secrets_unavailable',
|
|
50
|
+
`keytar deletePassword failed: ${(err as Error).message}`,
|
|
51
|
+
);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
async list(): Promise<string[]> {
|
|
56
|
+
try {
|
|
57
|
+
const creds = await this.keytar.findCredentials(this.service);
|
|
58
|
+
log('keytar findCredentials returned %d entries', creds.length);
|
|
59
|
+
return creds.map((c) => c.account);
|
|
60
|
+
} catch (err) {
|
|
61
|
+
throw new NatError(
|
|
62
|
+
'secrets_unavailable',
|
|
63
|
+
`keytar findCredentials failed: ${(err as Error).message}`,
|
|
64
|
+
);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
package/src/nat/types.ts
CHANGED
|
@@ -1,159 +1,159 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* NAT/DDNS types for cadre-host.
|
|
3
|
-
*
|
|
4
|
-
* cadre-host runs on home/SMB machines that are typically behind NAT. To be
|
|
5
|
-
* dialable from the open internet the host must:
|
|
6
|
-
* 1. Punch a port forward on the upstream router (UPnP/NAT-PMP).
|
|
7
|
-
* 2. Detect its external IP (and whether it's behind CGNAT).
|
|
8
|
-
* 3. Optionally publish a stable hostname via dynamic DNS.
|
|
9
|
-
*
|
|
10
|
-
* State for these three concerns lives in `<rootDir>/nat.json` (user settings)
|
|
11
|
-
* and is exposed as a single `NatStatusSnapshot` to the management UI.
|
|
12
|
-
*
|
|
13
|
-
* Credentials for DDNS providers are NOT stored in `nat.json`. They go through
|
|
14
|
-
* the SecretsStore (keytar, with a 0600 file fallback).
|
|
15
|
-
*/
|
|
16
|
-
|
|
17
|
-
/** Port-forwarding mode currently in effect. */
|
|
18
|
-
export type PortForwardMode =
|
|
19
|
-
| 'auto-upnp'
|
|
20
|
-
| 'auto-natpmp'
|
|
21
|
-
| 'manual'
|
|
22
|
-
| 'failed'
|
|
23
|
-
| 'disabled';
|
|
24
|
-
|
|
25
|
-
/** Reachability verdict — best-effort heuristic until AutoNAT lands. */
|
|
26
|
-
export type DirectReachability = 'reachable' | 'unreachable' | 'unknown' | 'cgnat';
|
|
27
|
-
|
|
28
|
-
/** Snapshot returned to the management UI / CLI. */
|
|
29
|
-
export interface NatStatusSnapshot {
|
|
30
|
-
// Port forwarding
|
|
31
|
-
portMode: PortForwardMode;
|
|
32
|
-
externalPort: number;
|
|
33
|
-
internalPort: number;
|
|
34
|
-
/** IP the router reports as its WAN address. Null when not auto-mapped. */
|
|
35
|
-
routerExternalIp: string | null;
|
|
36
|
-
/** ISO timestamp when the current mapping lease expires. */
|
|
37
|
-
mappingLeaseExpiresAt: string | null;
|
|
38
|
-
|
|
39
|
-
// External IP (from public probe; may differ from routerExternalIp under CGNAT)
|
|
40
|
-
externalIp: string | null;
|
|
41
|
-
externalIpDetectedAt: string | null;
|
|
42
|
-
cgnatDetected: boolean;
|
|
43
|
-
|
|
44
|
-
// Reachability verdict
|
|
45
|
-
directReachability: DirectReachability;
|
|
46
|
-
lastTestedAt: string | null;
|
|
47
|
-
|
|
48
|
-
// DDNS
|
|
49
|
-
ddns: NatDdnsStatus;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
/** DDNS sub-section of the status snapshot. */
|
|
53
|
-
export interface NatDdnsStatus {
|
|
54
|
-
/** Provider ID (e.g. "duckdns"), null when no DDNS is configured. */
|
|
55
|
-
providerId: string | null;
|
|
56
|
-
/** Configured hostname (e.g. "foo.duckdns.org"), null when unconfigured. */
|
|
57
|
-
hostname: string | null;
|
|
58
|
-
/** True when the user opted out of cadre-host updating the record. */
|
|
59
|
-
externallyManaged: boolean;
|
|
60
|
-
/** Last attempt timestamp (ISO), null until first attempt. */
|
|
61
|
-
lastUpdateAt: string | null;
|
|
62
|
-
/** Whether the most recent attempt succeeded. */
|
|
63
|
-
lastUpdateOk: boolean | null;
|
|
64
|
-
/** Most recent error message, null when last attempt succeeded. */
|
|
65
|
-
lastError: string | null;
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* On-disk shape of `nat.json`. NEVER contains DDNS credentials — those live
|
|
70
|
-
* in the SecretsStore.
|
|
71
|
-
*/
|
|
72
|
-
export interface NatSettingsFile {
|
|
73
|
-
version: 1;
|
|
74
|
-
/** External port to map (and announce). Default 4001. */
|
|
75
|
-
externalPort: number;
|
|
76
|
-
/** Internal libp2p port. Default 4001. */
|
|
77
|
-
internalPort: number;
|
|
78
|
-
/** Whether to attempt UPnP/NAT-PMP at all. */
|
|
79
|
-
upnpEnabled: boolean;
|
|
80
|
-
ddns: NatDdnsSettings;
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
/** DDNS sub-section of `nat.json`. */
|
|
84
|
-
export interface NatDdnsSettings {
|
|
85
|
-
/** Provider ID (e.g. "duckdns"). Null = unconfigured. */
|
|
86
|
-
providerId: string | null;
|
|
87
|
-
/** Hostname to publish. Null = unconfigured. */
|
|
88
|
-
hostname: string | null;
|
|
89
|
-
/**
|
|
90
|
-
* True means the user maintains the DNS record themselves (e.g. via the
|
|
91
|
-
* provider's own auto-update agent on the router). cadre-host shows the
|
|
92
|
-
* hostname but never tries to update it.
|
|
93
|
-
*/
|
|
94
|
-
externallyManaged: boolean;
|
|
95
|
-
/** DDNS update interval in milliseconds. Default 5 min. */
|
|
96
|
-
intervalMs: number;
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
/** Typed error codes for NatError. */
|
|
100
|
-
export type NatErrorCode =
|
|
101
|
-
| 'mapping_failed'
|
|
102
|
-
| 'router_unreachable'
|
|
103
|
-
| 'ip_detection_failed'
|
|
104
|
-
| 'ddns_provider_unknown'
|
|
105
|
-
| 'ddns_credentials_missing'
|
|
106
|
-
| 'ddns_update_failed'
|
|
107
|
-
| 'secrets_unavailable'
|
|
108
|
-
| 'storage_error'
|
|
109
|
-
| 'invalid_config'
|
|
110
|
-
/** The owner node's admin channel is unreachable / not ready. */
|
|
111
|
-
| 'node_unavailable';
|
|
112
|
-
|
|
113
|
-
/** Typed error carrying a stable `code` for HTTP mapping in the local-ui. */
|
|
114
|
-
export class NatError extends Error {
|
|
115
|
-
readonly code: NatErrorCode;
|
|
116
|
-
|
|
117
|
-
constructor(code: NatErrorCode, message: string) {
|
|
118
|
-
super(message);
|
|
119
|
-
this.name = 'NatError';
|
|
120
|
-
this.code = code;
|
|
121
|
-
}
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
/** Description of a configurable field on a DDNS provider. */
|
|
125
|
-
export interface DdnsConfigField {
|
|
126
|
-
/** Field key (e.g. "token"). */
|
|
127
|
-
key: string;
|
|
128
|
-
/** Human-readable label (e.g. "DuckDNS token"). */
|
|
129
|
-
label: string;
|
|
130
|
-
/** True if the value is a credential that must be stored in the SecretsStore. */
|
|
131
|
-
secret: boolean;
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
/** Summary of a DDNS provider for UI / CLI listing. */
|
|
135
|
-
export interface DdnsProviderInfo {
|
|
136
|
-
id: string;
|
|
137
|
-
displayName: string;
|
|
138
|
-
configFields: ReadonlyArray<DdnsConfigField>;
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
/**
|
|
142
|
-
* Typed HTTP handlers exposed to `cadre-host-local-ui` for Fastify wiring.
|
|
143
|
-
*
|
|
144
|
-
* Like TrustCircleHandlers, these take typed objects and either return typed
|
|
145
|
-
* results or throw a `NatError` whose `.code` the UI ticket maps to an HTTP
|
|
146
|
-
* status code.
|
|
147
|
-
*/
|
|
148
|
-
export interface NatHandlers {
|
|
149
|
-
getStatus(): Promise<NatStatusSnapshot>;
|
|
150
|
-
testReachability(): Promise<NatStatusSnapshot>;
|
|
151
|
-
listDdnsProviders(): Promise<DdnsProviderInfo[]>;
|
|
152
|
-
putDdns(body: {
|
|
153
|
-
providerId: string;
|
|
154
|
-
hostname: string;
|
|
155
|
-
config: Record<string, string>;
|
|
156
|
-
externallyManaged?: boolean;
|
|
157
|
-
}): Promise<NatStatusSnapshot>;
|
|
158
|
-
putSettings(body: Partial<Omit<NatSettingsFile, 'version'>>): Promise<NatStatusSnapshot>;
|
|
159
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* NAT/DDNS types for cadre-host.
|
|
3
|
+
*
|
|
4
|
+
* cadre-host runs on home/SMB machines that are typically behind NAT. To be
|
|
5
|
+
* dialable from the open internet the host must:
|
|
6
|
+
* 1. Punch a port forward on the upstream router (UPnP/NAT-PMP).
|
|
7
|
+
* 2. Detect its external IP (and whether it's behind CGNAT).
|
|
8
|
+
* 3. Optionally publish a stable hostname via dynamic DNS.
|
|
9
|
+
*
|
|
10
|
+
* State for these three concerns lives in `<rootDir>/nat.json` (user settings)
|
|
11
|
+
* and is exposed as a single `NatStatusSnapshot` to the management UI.
|
|
12
|
+
*
|
|
13
|
+
* Credentials for DDNS providers are NOT stored in `nat.json`. They go through
|
|
14
|
+
* the SecretsStore (keytar, with a 0600 file fallback).
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
/** Port-forwarding mode currently in effect. */
|
|
18
|
+
export type PortForwardMode =
|
|
19
|
+
| 'auto-upnp'
|
|
20
|
+
| 'auto-natpmp'
|
|
21
|
+
| 'manual'
|
|
22
|
+
| 'failed'
|
|
23
|
+
| 'disabled';
|
|
24
|
+
|
|
25
|
+
/** Reachability verdict — best-effort heuristic until AutoNAT lands. */
|
|
26
|
+
export type DirectReachability = 'reachable' | 'unreachable' | 'unknown' | 'cgnat';
|
|
27
|
+
|
|
28
|
+
/** Snapshot returned to the management UI / CLI. */
|
|
29
|
+
export interface NatStatusSnapshot {
|
|
30
|
+
// Port forwarding
|
|
31
|
+
portMode: PortForwardMode;
|
|
32
|
+
externalPort: number;
|
|
33
|
+
internalPort: number;
|
|
34
|
+
/** IP the router reports as its WAN address. Null when not auto-mapped. */
|
|
35
|
+
routerExternalIp: string | null;
|
|
36
|
+
/** ISO timestamp when the current mapping lease expires. */
|
|
37
|
+
mappingLeaseExpiresAt: string | null;
|
|
38
|
+
|
|
39
|
+
// External IP (from public probe; may differ from routerExternalIp under CGNAT)
|
|
40
|
+
externalIp: string | null;
|
|
41
|
+
externalIpDetectedAt: string | null;
|
|
42
|
+
cgnatDetected: boolean;
|
|
43
|
+
|
|
44
|
+
// Reachability verdict
|
|
45
|
+
directReachability: DirectReachability;
|
|
46
|
+
lastTestedAt: string | null;
|
|
47
|
+
|
|
48
|
+
// DDNS
|
|
49
|
+
ddns: NatDdnsStatus;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/** DDNS sub-section of the status snapshot. */
|
|
53
|
+
export interface NatDdnsStatus {
|
|
54
|
+
/** Provider ID (e.g. "duckdns"), null when no DDNS is configured. */
|
|
55
|
+
providerId: string | null;
|
|
56
|
+
/** Configured hostname (e.g. "foo.duckdns.org"), null when unconfigured. */
|
|
57
|
+
hostname: string | null;
|
|
58
|
+
/** True when the user opted out of cadre-host updating the record. */
|
|
59
|
+
externallyManaged: boolean;
|
|
60
|
+
/** Last attempt timestamp (ISO), null until first attempt. */
|
|
61
|
+
lastUpdateAt: string | null;
|
|
62
|
+
/** Whether the most recent attempt succeeded. */
|
|
63
|
+
lastUpdateOk: boolean | null;
|
|
64
|
+
/** Most recent error message, null when last attempt succeeded. */
|
|
65
|
+
lastError: string | null;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* On-disk shape of `nat.json`. NEVER contains DDNS credentials — those live
|
|
70
|
+
* in the SecretsStore.
|
|
71
|
+
*/
|
|
72
|
+
export interface NatSettingsFile {
|
|
73
|
+
version: 1;
|
|
74
|
+
/** External port to map (and announce). Default 4001. */
|
|
75
|
+
externalPort: number;
|
|
76
|
+
/** Internal libp2p port. Default 4001. */
|
|
77
|
+
internalPort: number;
|
|
78
|
+
/** Whether to attempt UPnP/NAT-PMP at all. */
|
|
79
|
+
upnpEnabled: boolean;
|
|
80
|
+
ddns: NatDdnsSettings;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/** DDNS sub-section of `nat.json`. */
|
|
84
|
+
export interface NatDdnsSettings {
|
|
85
|
+
/** Provider ID (e.g. "duckdns"). Null = unconfigured. */
|
|
86
|
+
providerId: string | null;
|
|
87
|
+
/** Hostname to publish. Null = unconfigured. */
|
|
88
|
+
hostname: string | null;
|
|
89
|
+
/**
|
|
90
|
+
* True means the user maintains the DNS record themselves (e.g. via the
|
|
91
|
+
* provider's own auto-update agent on the router). cadre-host shows the
|
|
92
|
+
* hostname but never tries to update it.
|
|
93
|
+
*/
|
|
94
|
+
externallyManaged: boolean;
|
|
95
|
+
/** DDNS update interval in milliseconds. Default 5 min. */
|
|
96
|
+
intervalMs: number;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/** Typed error codes for NatError. */
|
|
100
|
+
export type NatErrorCode =
|
|
101
|
+
| 'mapping_failed'
|
|
102
|
+
| 'router_unreachable'
|
|
103
|
+
| 'ip_detection_failed'
|
|
104
|
+
| 'ddns_provider_unknown'
|
|
105
|
+
| 'ddns_credentials_missing'
|
|
106
|
+
| 'ddns_update_failed'
|
|
107
|
+
| 'secrets_unavailable'
|
|
108
|
+
| 'storage_error'
|
|
109
|
+
| 'invalid_config'
|
|
110
|
+
/** The owner node's admin channel is unreachable / not ready. */
|
|
111
|
+
| 'node_unavailable';
|
|
112
|
+
|
|
113
|
+
/** Typed error carrying a stable `code` for HTTP mapping in the local-ui. */
|
|
114
|
+
export class NatError extends Error {
|
|
115
|
+
readonly code: NatErrorCode;
|
|
116
|
+
|
|
117
|
+
constructor(code: NatErrorCode, message: string) {
|
|
118
|
+
super(message);
|
|
119
|
+
this.name = 'NatError';
|
|
120
|
+
this.code = code;
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
/** Description of a configurable field on a DDNS provider. */
|
|
125
|
+
export interface DdnsConfigField {
|
|
126
|
+
/** Field key (e.g. "token"). */
|
|
127
|
+
key: string;
|
|
128
|
+
/** Human-readable label (e.g. "DuckDNS token"). */
|
|
129
|
+
label: string;
|
|
130
|
+
/** True if the value is a credential that must be stored in the SecretsStore. */
|
|
131
|
+
secret: boolean;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
/** Summary of a DDNS provider for UI / CLI listing. */
|
|
135
|
+
export interface DdnsProviderInfo {
|
|
136
|
+
id: string;
|
|
137
|
+
displayName: string;
|
|
138
|
+
configFields: ReadonlyArray<DdnsConfigField>;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Typed HTTP handlers exposed to `cadre-host-local-ui` for Fastify wiring.
|
|
143
|
+
*
|
|
144
|
+
* Like TrustCircleHandlers, these take typed objects and either return typed
|
|
145
|
+
* results or throw a `NatError` whose `.code` the UI ticket maps to an HTTP
|
|
146
|
+
* status code.
|
|
147
|
+
*/
|
|
148
|
+
export interface NatHandlers {
|
|
149
|
+
getStatus(): Promise<NatStatusSnapshot>;
|
|
150
|
+
testReachability(): Promise<NatStatusSnapshot>;
|
|
151
|
+
listDdnsProviders(): Promise<DdnsProviderInfo[]>;
|
|
152
|
+
putDdns(body: {
|
|
153
|
+
providerId: string;
|
|
154
|
+
hostname: string;
|
|
155
|
+
config: Record<string, string>;
|
|
156
|
+
externallyManaged?: boolean;
|
|
157
|
+
}): Promise<NatStatusSnapshot>;
|
|
158
|
+
putSettings(body: Partial<Omit<NatSettingsFile, 'version'>>): Promise<NatStatusSnapshot>;
|
|
159
|
+
}
|
|
@@ -1,62 +1,62 @@
|
|
|
1
|
-
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
|
2
|
-
import { mkdtempSync, readFileSync, rmSync, statSync, writeFileSync } from 'node:fs';
|
|
3
|
-
import { tmpdir } from 'node:os';
|
|
4
|
-
import { join } from 'node:path';
|
|
5
|
-
|
|
6
|
-
import { ensureNodeIdentity, nodeIdentityPath } from '../node-identity.js';
|
|
7
|
-
|
|
8
|
-
describe('ensureNodeIdentity', () => {
|
|
9
|
-
let tmp: string;
|
|
10
|
-
|
|
11
|
-
beforeEach(() => {
|
|
12
|
-
tmp = mkdtempSync(join(tmpdir(), 'cadre-node-id-'));
|
|
13
|
-
});
|
|
14
|
-
|
|
15
|
-
afterEach(() => {
|
|
16
|
-
rmSync(tmp, { recursive: true, force: true });
|
|
17
|
-
});
|
|
18
|
-
|
|
19
|
-
it('generates an identity inside the workdir on first call', async () => {
|
|
20
|
-
const { path, peerId } = await ensureNodeIdentity(tmp);
|
|
21
|
-
expect(path).toBe(nodeIdentityPath(tmp));
|
|
22
|
-
expect(path).toBe(join(tmp, 'identity.key'));
|
|
23
|
-
expect(peerId).toMatch(/^12D3Koo/);
|
|
24
|
-
expect(statSync(path).size).toBeGreaterThan(0);
|
|
25
|
-
});
|
|
26
|
-
|
|
27
|
-
// Reuse — not rotation — is the load-bearing property: a re-spawn of the same
|
|
28
|
-
// container must land on the same peer id or the cadre that admitted it sees a
|
|
29
|
-
// stranger.
|
|
30
|
-
it('reuses the existing key on a second call', async () => {
|
|
31
|
-
const first = await ensureNodeIdentity(tmp);
|
|
32
|
-
const bytesBefore = readFileSync(first.path);
|
|
33
|
-
|
|
34
|
-
const second = await ensureNodeIdentity(tmp);
|
|
35
|
-
expect(second.peerId).toBe(first.peerId);
|
|
36
|
-
expect(readFileSync(second.path).equals(bytesBefore)).toBe(true);
|
|
37
|
-
});
|
|
38
|
-
|
|
39
|
-
it('creates the workdir when it does not exist yet', async () => {
|
|
40
|
-
const workdir = join(tmp, 'nested', 'donated-1');
|
|
41
|
-
const { path, peerId } = await ensureNodeIdentity(workdir);
|
|
42
|
-
expect(path).toBe(join(workdir, 'identity.key'));
|
|
43
|
-
expect(peerId).toMatch(/^12D3Koo/);
|
|
44
|
-
});
|
|
45
|
-
|
|
46
|
-
// A key that is present but unreadable must FAIL the spawn, not fall through
|
|
47
|
-
// to `generateIdentity`. Regenerating would hand the cadre a stranger under
|
|
48
|
-
// the same containerId — silently reproducing the bug this module exists to
|
|
49
|
-
// fix — where a throw surfaces the damaged file to the operator.
|
|
50
|
-
it('throws rather than re-keying when the existing file does not decode', async () => {
|
|
51
|
-
const path = nodeIdentityPath(tmp);
|
|
52
|
-
writeFileSync(path, 'not a protobuf private key', 'utf8');
|
|
53
|
-
|
|
54
|
-
await expect(ensureNodeIdentity(tmp)).rejects.toThrow();
|
|
55
|
-
expect(readFileSync(path, 'utf8')).toBe('not a protobuf private key');
|
|
56
|
-
});
|
|
57
|
-
|
|
58
|
-
it.runIf(process.platform !== 'win32')('persists with mode 0600 on POSIX', async () => {
|
|
59
|
-
const { path } = await ensureNodeIdentity(tmp);
|
|
60
|
-
expect(statSync(path).mode & 0o777).toBe(0o600);
|
|
61
|
-
});
|
|
62
|
-
});
|
|
1
|
+
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
|
2
|
+
import { mkdtempSync, readFileSync, rmSync, statSync, writeFileSync } from 'node:fs';
|
|
3
|
+
import { tmpdir } from 'node:os';
|
|
4
|
+
import { join } from 'node:path';
|
|
5
|
+
|
|
6
|
+
import { ensureNodeIdentity, nodeIdentityPath } from '../node-identity.js';
|
|
7
|
+
|
|
8
|
+
describe('ensureNodeIdentity', () => {
|
|
9
|
+
let tmp: string;
|
|
10
|
+
|
|
11
|
+
beforeEach(() => {
|
|
12
|
+
tmp = mkdtempSync(join(tmpdir(), 'cadre-node-id-'));
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
afterEach(() => {
|
|
16
|
+
rmSync(tmp, { recursive: true, force: true });
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
it('generates an identity inside the workdir on first call', async () => {
|
|
20
|
+
const { path, peerId } = await ensureNodeIdentity(tmp);
|
|
21
|
+
expect(path).toBe(nodeIdentityPath(tmp));
|
|
22
|
+
expect(path).toBe(join(tmp, 'identity.key'));
|
|
23
|
+
expect(peerId).toMatch(/^12D3Koo/);
|
|
24
|
+
expect(statSync(path).size).toBeGreaterThan(0);
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
// Reuse — not rotation — is the load-bearing property: a re-spawn of the same
|
|
28
|
+
// container must land on the same peer id or the cadre that admitted it sees a
|
|
29
|
+
// stranger.
|
|
30
|
+
it('reuses the existing key on a second call', async () => {
|
|
31
|
+
const first = await ensureNodeIdentity(tmp);
|
|
32
|
+
const bytesBefore = readFileSync(first.path);
|
|
33
|
+
|
|
34
|
+
const second = await ensureNodeIdentity(tmp);
|
|
35
|
+
expect(second.peerId).toBe(first.peerId);
|
|
36
|
+
expect(readFileSync(second.path).equals(bytesBefore)).toBe(true);
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it('creates the workdir when it does not exist yet', async () => {
|
|
40
|
+
const workdir = join(tmp, 'nested', 'donated-1');
|
|
41
|
+
const { path, peerId } = await ensureNodeIdentity(workdir);
|
|
42
|
+
expect(path).toBe(join(workdir, 'identity.key'));
|
|
43
|
+
expect(peerId).toMatch(/^12D3Koo/);
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
// A key that is present but unreadable must FAIL the spawn, not fall through
|
|
47
|
+
// to `generateIdentity`. Regenerating would hand the cadre a stranger under
|
|
48
|
+
// the same containerId — silently reproducing the bug this module exists to
|
|
49
|
+
// fix — where a throw surfaces the damaged file to the operator.
|
|
50
|
+
it('throws rather than re-keying when the existing file does not decode', async () => {
|
|
51
|
+
const path = nodeIdentityPath(tmp);
|
|
52
|
+
writeFileSync(path, 'not a protobuf private key', 'utf8');
|
|
53
|
+
|
|
54
|
+
await expect(ensureNodeIdentity(tmp)).rejects.toThrow();
|
|
55
|
+
expect(readFileSync(path, 'utf8')).toBe('not a protobuf private key');
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it.runIf(process.platform !== 'win32')('persists with mode 0600 on POSIX', async () => {
|
|
59
|
+
const { path } = await ensureNodeIdentity(tmp);
|
|
60
|
+
expect(statSync(path).mode & 0o777).toBe(0o600);
|
|
61
|
+
});
|
|
62
|
+
});
|
|
@@ -289,7 +289,7 @@ export class HostProcessOrchestrator implements Orchestrator {
|
|
|
289
289
|
ports,
|
|
290
290
|
owner: false,
|
|
291
291
|
buildConfig: () => this.buildChildConfig(request, workdir, push),
|
|
292
|
-
extraArgs: ['--identity-
|
|
292
|
+
extraArgs: ['--identity-file', identity.path],
|
|
293
293
|
...(extraEnv ? { extraEnv } : {}),
|
|
294
294
|
...(request.resources?.memoryLimit ? { memoryLimit: request.resources.memoryLimit } : {}),
|
|
295
295
|
});
|
|
@@ -399,7 +399,7 @@ export class HostProcessOrchestrator implements Orchestrator {
|
|
|
399
399
|
* orchestrator restart) can re-spawn it without re-supplying them.
|
|
400
400
|
*
|
|
401
401
|
* The owner node is spawned as `cadre-cli start --owner
|
|
402
|
-
* --admin-port <p> --identity-
|
|
402
|
+
* --admin-port <p> --identity-file <identityPath>` so it carries the
|
|
403
403
|
* host's libp2p identity, founds/joins the control network, and exposes the
|
|
404
404
|
* loopback admin channel the manager delegates to.
|
|
405
405
|
*/
|
|
@@ -441,7 +441,7 @@ export class HostProcessOrchestrator implements Orchestrator {
|
|
|
441
441
|
ports,
|
|
442
442
|
owner: true,
|
|
443
443
|
buildConfig: (workdir) => this.buildOwnerChildConfig(config, profile, workdir, push),
|
|
444
|
-
extraArgs: ['--owner', '--admin-port', String(ports.admin), '--identity-
|
|
444
|
+
extraArgs: ['--owner', '--admin-port', String(ports.admin), '--identity-file', config.identityPath],
|
|
445
445
|
});
|
|
446
446
|
const handle = this.handles.get(result.dockerId)!;
|
|
447
447
|
return toNodeInfo(handle);
|
|
@@ -564,6 +564,11 @@ export class HostProcessOrchestrator implements Orchestrator {
|
|
|
564
564
|
CADRE_HEALTH_PORT: String(ports.health),
|
|
565
565
|
CADRE_METRICS_PORT: String(ports.metrics),
|
|
566
566
|
CADRE_LISTEN_ADDRS: `/ip4/0.0.0.0/tcp/${ports.p2p}`,
|
|
567
|
+
// NOTE: the scrub above drops every CADRE_* var and `extraEnv` is built only from
|
|
568
|
+
// pinnedOwnerKeys, so a managed child advertises only the port assigned to it here
|
|
569
|
+
// — `CADRE_ANNOUNCE_ADDRS`/`CADRE_APPEND_ANNOUNCE_ADDRS` cannot reach it. Fine while
|
|
570
|
+
// children are reached at that port or through a relay; if a host is ever fronted by
|
|
571
|
+
// a proxy or DNS name, plumb an announce var through from host config.
|
|
567
572
|
CADRE_SEED_TOKEN: seedToken,
|
|
568
573
|
// Pin each child's node-local state (trusted-owner anchor, retained
|
|
569
574
|
// cold-start dial targets) to its OWN workdir. This is the same value the
|
|
@@ -950,7 +955,7 @@ export class HostProcessOrchestrator implements Orchestrator {
|
|
|
950
955
|
* docs/cadre-host.md § Two roles: donor and founder). It founds/joins the
|
|
951
956
|
* control network for the host's own `partyId` (no bootstrap peers — it is the
|
|
952
957
|
* founding node of the host's *own* cadre) and carries the host identity via
|
|
953
|
-
* `--identity-
|
|
958
|
+
* `--identity-file` (passed as a spawn arg).
|
|
954
959
|
*
|
|
955
960
|
* This is NOT the node cadre-host donates to a requester. Donated nodes are
|
|
956
961
|
* generic (`createContainer` / `buildChildConfig`): they join the
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
export { HostProcessOrchestrator, OWNER_CONTAINER_ID } from './host-process-orchestrator.js';
|
|
2
|
-
export type { OwnerAdminEndpoint } from './host-process-orchestrator.js';
|
|
3
|
-
export type {
|
|
4
|
-
HostProcessConfig,
|
|
5
|
-
ManagedNodeInfo,
|
|
6
|
-
NodeStateListener,
|
|
7
|
-
NodePorts,
|
|
8
|
-
OwnerSpawnConfig,
|
|
9
|
-
} from './types.js';
|
|
10
|
-
export type { PersistedHandle } from './state-store.js';
|
|
1
|
+
export { HostProcessOrchestrator, OWNER_CONTAINER_ID } from './host-process-orchestrator.js';
|
|
2
|
+
export type { OwnerAdminEndpoint } from './host-process-orchestrator.js';
|
|
3
|
+
export type {
|
|
4
|
+
HostProcessConfig,
|
|
5
|
+
ManagedNodeInfo,
|
|
6
|
+
NodeStateListener,
|
|
7
|
+
NodePorts,
|
|
8
|
+
OwnerSpawnConfig,
|
|
9
|
+
} from './types.js';
|
|
10
|
+
export type { PersistedHandle } from './state-store.js';
|