@serfab/cadre-host 0.7.1
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 +101 -0
- package/dist/auth/duration.d.ts +1 -0
- package/dist/auth/duration.js +32 -0
- package/dist/auth/duration.js.map +1 -0
- package/dist/auth/index.d.ts +9 -0
- package/dist/auth/index.js +8 -0
- package/dist/auth/index.js.map +1 -0
- package/dist/auth/trust-circle-store.d.ts +26 -0
- package/dist/auth/trust-circle-store.js +129 -0
- package/dist/auth/trust-circle-store.js.map +1 -0
- package/dist/auth/trust-circle.d.ts +91 -0
- package/dist/auth/trust-circle.js +230 -0
- package/dist/auth/trust-circle.js.map +1 -0
- package/dist/auth/types.d.ts +81 -0
- package/dist/auth/types.js +24 -0
- package/dist/auth/types.js.map +1 -0
- package/dist/bin/host.d.ts +13 -0
- package/dist/bin/host.js +826 -0
- package/dist/bin/host.js.map +1 -0
- package/dist/index.d.ts +32 -0
- package/dist/index.js +27 -0
- package/dist/index.js.map +1 -0
- package/dist/installer/browser.d.ts +14 -0
- package/dist/installer/browser.js +35 -0
- package/dist/installer/browser.js.map +1 -0
- package/dist/installer/config.d.ts +43 -0
- package/dist/installer/config.js +113 -0
- package/dist/installer/config.js.map +1 -0
- package/dist/installer/identity.d.ts +23 -0
- package/dist/installer/identity.js +36 -0
- package/dist/installer/identity.js.map +1 -0
- package/dist/installer/index.d.ts +83 -0
- package/dist/installer/index.js +204 -0
- package/dist/installer/index.js.map +1 -0
- package/dist/installer/paths.d.ts +33 -0
- package/dist/installer/paths.js +84 -0
- package/dist/installer/paths.js.map +1 -0
- package/dist/installer/platform.d.ts +9 -0
- package/dist/installer/platform.js +21 -0
- package/dist/installer/platform.js.map +1 -0
- package/dist/installer/service-host/index.d.ts +11 -0
- package/dist/installer/service-host/index.js +16 -0
- package/dist/installer/service-host/index.js.map +1 -0
- package/dist/installer/service-host/launchd.d.ts +16 -0
- package/dist/installer/service-host/launchd.js +79 -0
- package/dist/installer/service-host/launchd.js.map +1 -0
- package/dist/installer/service-host/nssm.d.ts +20 -0
- package/dist/installer/service-host/nssm.js +88 -0
- package/dist/installer/service-host/nssm.js.map +1 -0
- package/dist/installer/service-host/systemd.d.ts +16 -0
- package/dist/installer/service-host/systemd.js +78 -0
- package/dist/installer/service-host/systemd.js.map +1 -0
- package/dist/installer/service-host/template.d.ts +6 -0
- package/dist/installer/service-host/template.js +20 -0
- package/dist/installer/service-host/template.js.map +1 -0
- package/dist/installer/service-host/types.d.ts +40 -0
- package/dist/installer/service-host/types.js +6 -0
- package/dist/installer/service-host/types.js.map +1 -0
- package/dist/installer/wizard.d.ts +31 -0
- package/dist/installer/wizard.js +67 -0
- package/dist/installer/wizard.js.map +1 -0
- package/dist/nat/address-resolver.d.ts +22 -0
- package/dist/nat/address-resolver.js +31 -0
- package/dist/nat/address-resolver.js.map +1 -0
- package/dist/nat/ddns/duckdns.d.ts +12 -0
- package/dist/nat/ddns/duckdns.js +57 -0
- package/dist/nat/ddns/duckdns.js.map +1 -0
- package/dist/nat/ddns/index.d.ts +30 -0
- package/dist/nat/ddns/index.js +21 -0
- package/dist/nat/ddns/index.js.map +1 -0
- package/dist/nat/ddns/updater.d.ts +68 -0
- package/dist/nat/ddns/updater.js +194 -0
- package/dist/nat/ddns/updater.js.map +1 -0
- package/dist/nat/external-ip.d.ts +62 -0
- package/dist/nat/external-ip.js +114 -0
- package/dist/nat/external-ip.js.map +1 -0
- package/dist/nat/index.d.ts +22 -0
- package/dist/nat/index.js +16 -0
- package/dist/nat/index.js.map +1 -0
- package/dist/nat/nat-service.d.ts +101 -0
- package/dist/nat/nat-service.js +284 -0
- package/dist/nat/nat-service.js.map +1 -0
- package/dist/nat/nat-store.d.ts +19 -0
- package/dist/nat/nat-store.js +136 -0
- package/dist/nat/nat-store.js.map +1 -0
- package/dist/nat/port-mapper.d.ts +98 -0
- package/dist/nat/port-mapper.js +226 -0
- package/dist/nat/port-mapper.js.map +1 -0
- package/dist/nat/reachability.d.ts +19 -0
- package/dist/nat/reachability.js +29 -0
- package/dist/nat/reachability.js.map +1 -0
- package/dist/nat/secrets/file-store.d.ts +23 -0
- package/dist/nat/secrets/file-store.js +102 -0
- package/dist/nat/secrets/file-store.js.map +1 -0
- package/dist/nat/secrets/index.d.ts +36 -0
- package/dist/nat/secrets/index.js +56 -0
- package/dist/nat/secrets/index.js.map +1 -0
- package/dist/nat/secrets/keytar-store.d.ts +18 -0
- package/dist/nat/secrets/keytar-store.js +52 -0
- package/dist/nat/secrets/keytar-store.js.map +1 -0
- package/dist/nat/types.d.ts +120 -0
- package/dist/nat/types.js +24 -0
- package/dist/nat/types.js.map +1 -0
- package/dist/orchestrator/host-process-orchestrator.d.ts +87 -0
- package/dist/orchestrator/host-process-orchestrator.js +557 -0
- package/dist/orchestrator/host-process-orchestrator.js.map +1 -0
- package/dist/orchestrator/index.d.ts +3 -0
- package/dist/orchestrator/index.js +2 -0
- package/dist/orchestrator/index.js.map +1 -0
- package/dist/orchestrator/log-rotator.d.ts +25 -0
- package/dist/orchestrator/log-rotator.js +56 -0
- package/dist/orchestrator/log-rotator.js.map +1 -0
- package/dist/orchestrator/pid-liveness.d.ts +11 -0
- package/dist/orchestrator/pid-liveness.js +26 -0
- package/dist/orchestrator/pid-liveness.js.map +1 -0
- package/dist/orchestrator/port-allocator.d.ts +16 -0
- package/dist/orchestrator/port-allocator.js +38 -0
- package/dist/orchestrator/port-allocator.js.map +1 -0
- package/dist/orchestrator/state-store.d.ts +32 -0
- package/dist/orchestrator/state-store.js +44 -0
- package/dist/orchestrator/state-store.js.map +1 -0
- package/dist/orchestrator/types.d.ts +85 -0
- package/dist/orchestrator/types.js +31 -0
- package/dist/orchestrator/types.js.map +1 -0
- package/dist/server/error-handler.d.ts +26 -0
- package/dist/server/error-handler.js +95 -0
- package/dist/server/error-handler.js.map +1 -0
- package/dist/server/events/bus.d.ts +17 -0
- package/dist/server/events/bus.js +36 -0
- package/dist/server/events/bus.js.map +1 -0
- package/dist/server/events/sse-route.d.ts +22 -0
- package/dist/server/events/sse-route.js +65 -0
- package/dist/server/events/sse-route.js.map +1 -0
- package/dist/server/events/types.d.ts +25 -0
- package/dist/server/events/types.js +8 -0
- package/dist/server/events/types.js.map +1 -0
- package/dist/server/index.d.ts +67 -0
- package/dist/server/index.js +149 -0
- package/dist/server/index.js.map +1 -0
- package/dist/server/origin-guard.d.ts +24 -0
- package/dist/server/origin-guard.js +72 -0
- package/dist/server/origin-guard.js.map +1 -0
- package/dist/server/routes/nat.d.ts +16 -0
- package/dist/server/routes/nat.js +42 -0
- package/dist/server/routes/nat.js.map +1 -0
- package/dist/server/routes/nodes.d.ts +23 -0
- package/dist/server/routes/nodes.js +128 -0
- package/dist/server/routes/nodes.js.map +1 -0
- package/dist/server/routes/settings.d.ts +26 -0
- package/dist/server/routes/settings.js +97 -0
- package/dist/server/routes/settings.js.map +1 -0
- package/dist/server/routes/status.d.ts +42 -0
- package/dist/server/routes/status.js +76 -0
- package/dist/server/routes/status.js.map +1 -0
- package/dist/server/routes/trust-circle.d.ts +17 -0
- package/dist/server/routes/trust-circle.js +35 -0
- package/dist/server/routes/trust-circle.js.map +1 -0
- package/dist/server/routes/update.d.ts +16 -0
- package/dist/server/routes/update.js +29 -0
- package/dist/server/routes/update.js.map +1 -0
- package/dist/server/server.d.ts +40 -0
- package/dist/server/server.js +90 -0
- package/dist/server/server.js.map +1 -0
- package/dist/server/settings-store.d.ts +24 -0
- package/dist/server/settings-store.js +27 -0
- package/dist/server/settings-store.js.map +1 -0
- package/dist/server/static.d.ts +25 -0
- package/dist/server/static.js +177 -0
- package/dist/server/static.js.map +1 -0
- package/dist/ui/assets/index-BwU5mJGF.css +1 -0
- package/dist/ui/assets/index-C9uChk2P.js +14 -0
- package/dist/ui/assets/index-C9uChk2P.js.map +1 -0
- package/dist/ui/index.html +14 -0
- package/dist/update/apply.d.ts +37 -0
- package/dist/update/apply.js +102 -0
- package/dist/update/apply.js.map +1 -0
- package/dist/update/index.d.ts +101 -0
- package/dist/update/index.js +228 -0
- package/dist/update/index.js.map +1 -0
- package/dist/update/manifest.d.ts +48 -0
- package/dist/update/manifest.js +152 -0
- package/dist/update/manifest.js.map +1 -0
- package/dist/update/release-key.d.ts +24 -0
- package/dist/update/release-key.js +52 -0
- package/dist/update/release-key.js.map +1 -0
- package/dist/update/store.d.ts +22 -0
- package/dist/update/store.js +81 -0
- package/dist/update/store.js.map +1 -0
- package/dist/update/types.d.ts +90 -0
- package/dist/update/types.js +22 -0
- package/dist/update/types.js.map +1 -0
- package/dist/update/version.d.ts +18 -0
- package/dist/update/version.js +76 -0
- package/dist/update/version.js.map +1 -0
- package/package.json +80 -0
- package/service/README.md +86 -0
- package/service/cadre-host.service.tmpl +16 -0
- package/service/com.serfab.cadre-host.plist.tmpl +35 -0
- package/service/install-service.ps1 +98 -0
- package/service/uninstall-service.ps1 +19 -0
- package/src/__tests__/cli-invite.smoke.test.ts +187 -0
- package/src/__tests__/cli-nat.smoke.test.ts +207 -0
- package/src/__tests__/cli.smoke.test.ts +41 -0
- package/src/__tests__/orchestrator.test.ts +570 -0
- package/src/auth/__tests__/duration.test.ts +28 -0
- package/src/auth/__tests__/trust-circle-integration.test.ts +128 -0
- package/src/auth/__tests__/trust-circle-store.test.ts +115 -0
- package/src/auth/__tests__/trust-circle.test.ts +334 -0
- package/src/auth/duration.ts +33 -0
- package/src/auth/index.ts +19 -0
- package/src/auth/trust-circle-store.ts +155 -0
- package/src/auth/trust-circle.ts +304 -0
- package/src/auth/types.ts +96 -0
- package/src/bin/host.ts +905 -0
- package/src/index.ts +167 -0
- package/src/installer/__tests__/config.test.ts +86 -0
- package/src/installer/__tests__/identity.test.ts +34 -0
- package/src/installer/__tests__/installer.smoke.test.ts +124 -0
- package/src/installer/__tests__/paths.test.ts +47 -0
- package/src/installer/__tests__/service-host.test.ts +62 -0
- package/src/installer/__tests__/wizard.test.ts +60 -0
- package/src/installer/browser.ts +42 -0
- package/src/installer/config.ts +153 -0
- package/src/installer/identity.ts +49 -0
- package/src/installer/index.ts +303 -0
- package/src/installer/paths.ts +109 -0
- package/src/installer/platform.ts +27 -0
- package/src/installer/service-host/index.ts +21 -0
- package/src/installer/service-host/launchd.ts +90 -0
- package/src/installer/service-host/nssm.ts +100 -0
- package/src/installer/service-host/systemd.ts +88 -0
- package/src/installer/service-host/template.ts +21 -0
- package/src/installer/service-host/types.ts +48 -0
- package/src/installer/wizard.ts +92 -0
- package/src/nat/__tests__/address-resolver.test.ts +82 -0
- package/src/nat/__tests__/ddns-duckdns.test.ts +83 -0
- package/src/nat/__tests__/ddns-updater.test.ts +253 -0
- package/src/nat/__tests__/external-ip.test.ts +124 -0
- package/src/nat/__tests__/nat-service.test.ts +305 -0
- package/src/nat/__tests__/nat-store.test.ts +93 -0
- package/src/nat/__tests__/port-mapper.test.ts +191 -0
- package/src/nat/__tests__/reachability.test.ts +24 -0
- package/src/nat/__tests__/secrets.test.ts +156 -0
- package/src/nat/address-resolver.ts +51 -0
- package/src/nat/ddns/duckdns.ts +76 -0
- package/src/nat/ddns/index.ts +55 -0
- package/src/nat/ddns/updater.ts +243 -0
- package/src/nat/external-ip.ts +154 -0
- package/src/nat/index.ts +71 -0
- package/src/nat/nat-service.ts +375 -0
- package/src/nat/nat-store.ts +154 -0
- package/src/nat/port-mapper.ts +329 -0
- package/src/nat/reachability.ts +34 -0
- package/src/nat/secrets/file-store.ts +130 -0
- package/src/nat/secrets/index.ts +82 -0
- package/src/nat/secrets/keytar-store.ts +67 -0
- package/src/nat/types.ts +157 -0
- package/src/orchestrator/host-process-orchestrator.ts +626 -0
- package/src/orchestrator/index.ts +3 -0
- package/src/orchestrator/log-rotator.ts +53 -0
- package/src/orchestrator/pid-liveness.ts +24 -0
- package/src/orchestrator/port-allocator.ts +43 -0
- package/src/orchestrator/state-store.ts +72 -0
- package/src/orchestrator/types.ts +95 -0
- package/src/server/__tests__/bus.test.ts +38 -0
- package/src/server/__tests__/error-handler.test.ts +96 -0
- package/src/server/__tests__/nodes-route.test.ts +179 -0
- package/src/server/__tests__/origin-guard.test.ts +72 -0
- package/src/server/__tests__/publishers.test.ts +216 -0
- package/src/server/__tests__/server.smoke.test.ts +178 -0
- package/src/server/__tests__/settings-route.test.ts +177 -0
- package/src/server/__tests__/sse-route.test.ts +119 -0
- package/src/server/__tests__/status-route.test.ts +113 -0
- package/src/server/error-handler.ts +108 -0
- package/src/server/events/bus.ts +42 -0
- package/src/server/events/sse-route.ts +81 -0
- package/src/server/events/types.ts +22 -0
- package/src/server/index.ts +209 -0
- package/src/server/origin-guard.ts +84 -0
- package/src/server/routes/nat.ts +63 -0
- package/src/server/routes/nodes.ts +147 -0
- package/src/server/routes/settings.ts +115 -0
- package/src/server/routes/status.ts +108 -0
- package/src/server/routes/trust-circle.ts +49 -0
- package/src/server/routes/update.ts +43 -0
- package/src/server/server.ts +122 -0
- package/src/server/settings-store.ts +37 -0
- package/src/server/static.ts +191 -0
- package/src/update/__tests__/apply.test.ts +101 -0
- package/src/update/__tests__/manifest.test.ts +93 -0
- package/src/update/__tests__/store.test.ts +81 -0
- package/src/update/__tests__/update-service.integration.test.ts +221 -0
- package/src/update/__tests__/version.test.ts +31 -0
- package/src/update/apply.ts +148 -0
- package/src/update/index.ts +303 -0
- package/src/update/manifest.ts +172 -0
- package/src/update/release-key.ts +55 -0
- package/src/update/store.ts +101 -0
- package/src/update/types.ts +109 -0
- package/src/update/version.ts +80 -0
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
import debug from 'debug';
|
|
2
|
+
import { NatError } from './types.js';
|
|
3
|
+
const log = debug('cadre:host:nat-port-mapper');
|
|
4
|
+
/** Default lease TTL: 1 hour. The router must keep our mapping at least this long. */
|
|
5
|
+
export const DEFAULT_LEASE_TTL_MS = 60 * 60 * 1000;
|
|
6
|
+
/** Default refresh cadence: half the TTL, so two refreshes per lease. */
|
|
7
|
+
export const DEFAULT_REFRESH_MS = 30 * 60 * 1000;
|
|
8
|
+
/**
|
|
9
|
+
* Default factory: loads @achingbrain/nat-port-mapper. Wrapped in dynamic
|
|
10
|
+
* import so a missing dep at install time doesn't crash the package.
|
|
11
|
+
*/
|
|
12
|
+
export async function createDefaultPortMapper(opts = {}) {
|
|
13
|
+
let mod;
|
|
14
|
+
try {
|
|
15
|
+
mod = (await import('@achingbrain/nat-port-mapper'));
|
|
16
|
+
}
|
|
17
|
+
catch (err) {
|
|
18
|
+
throw new NatError('mapping_failed', `@achingbrain/nat-port-mapper is not installed: ${err.message}`);
|
|
19
|
+
}
|
|
20
|
+
let client;
|
|
21
|
+
try {
|
|
22
|
+
client = await mod.upnpNat({
|
|
23
|
+
description: opts.description ?? 'sereus-cadre-host',
|
|
24
|
+
ttl: Math.round((opts.ttlMs ?? DEFAULT_LEASE_TTL_MS) / 1000),
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
catch (err) {
|
|
28
|
+
throw new NatError('mapping_failed', `upnpNat() failed: ${err.message}`);
|
|
29
|
+
}
|
|
30
|
+
return new NatPortMapperAdapter(client, opts.ttlMs ?? DEFAULT_LEASE_TTL_MS);
|
|
31
|
+
}
|
|
32
|
+
class NatPortMapperAdapter {
|
|
33
|
+
constructor(client, defaultTtlMs) {
|
|
34
|
+
this.client = client;
|
|
35
|
+
this.defaultTtlMs = defaultTtlMs;
|
|
36
|
+
}
|
|
37
|
+
async map(opts) {
|
|
38
|
+
const ttlMs = opts.ttlMs ?? this.defaultTtlMs;
|
|
39
|
+
const protocol = opts.protocol ?? 'tcp';
|
|
40
|
+
let externalIp = null;
|
|
41
|
+
try {
|
|
42
|
+
externalIp = await this.client.externalIp();
|
|
43
|
+
}
|
|
44
|
+
catch (err) {
|
|
45
|
+
log('externalIp() failed: %s', err.message);
|
|
46
|
+
}
|
|
47
|
+
try {
|
|
48
|
+
await this.client.map({
|
|
49
|
+
localPort: opts.internalPort,
|
|
50
|
+
externalPort: opts.externalPort,
|
|
51
|
+
protocol,
|
|
52
|
+
ttl: Math.round(ttlMs / 1000),
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
catch (err) {
|
|
56
|
+
throw new NatError('mapping_failed', `router refused mapping for port ${opts.externalPort}: ${err.message}`);
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
mode: 'auto-upnp',
|
|
60
|
+
externalIp,
|
|
61
|
+
externalPort: opts.externalPort,
|
|
62
|
+
internalPort: opts.internalPort,
|
|
63
|
+
protocol,
|
|
64
|
+
leaseExpiresAt: new Date(Date.now() + ttlMs),
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
async verify(externalPort, protocol = 'tcp') {
|
|
68
|
+
void externalPort;
|
|
69
|
+
void protocol;
|
|
70
|
+
// The current library doesn't expose an introspection API. Treat a
|
|
71
|
+
// working externalIp() as a proxy for "router still reachable" — refresh
|
|
72
|
+
// failures will surface via re-running map().
|
|
73
|
+
try {
|
|
74
|
+
await this.client.externalIp();
|
|
75
|
+
return true;
|
|
76
|
+
}
|
|
77
|
+
catch (err) {
|
|
78
|
+
log('verify() failed: %s', err.message);
|
|
79
|
+
return false;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
async externalIp() {
|
|
83
|
+
try {
|
|
84
|
+
return await this.client.externalIp();
|
|
85
|
+
}
|
|
86
|
+
catch (err) {
|
|
87
|
+
log('externalIp() failed: %s', err.message);
|
|
88
|
+
return null;
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
async unmap(externalPort, protocol = 'tcp') {
|
|
92
|
+
try {
|
|
93
|
+
await this.client.unmap({ externalPort, protocol });
|
|
94
|
+
}
|
|
95
|
+
catch (err) {
|
|
96
|
+
log('unmap(%d) failed: %s', externalPort, err.message);
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
async stop() {
|
|
100
|
+
try {
|
|
101
|
+
await this.client.stop();
|
|
102
|
+
}
|
|
103
|
+
catch (err) {
|
|
104
|
+
log('stop() failed: %s', err.message);
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Long-running orchestrator over a PortMapper. Owns the refresh timer and
|
|
110
|
+
* surfaces the latest state for the NatService snapshot.
|
|
111
|
+
*/
|
|
112
|
+
export class PortMapperService {
|
|
113
|
+
constructor(opts) {
|
|
114
|
+
this.refreshHandle = null;
|
|
115
|
+
this.started = false;
|
|
116
|
+
this.mapper = opts.mapper;
|
|
117
|
+
this.externalPort = opts.externalPort;
|
|
118
|
+
this.internalPort = opts.internalPort;
|
|
119
|
+
this.protocol = opts.protocol ?? 'tcp';
|
|
120
|
+
this.ttlMs = opts.ttlMs ?? DEFAULT_LEASE_TTL_MS;
|
|
121
|
+
this.refreshMs = opts.refreshMs ?? DEFAULT_REFRESH_MS;
|
|
122
|
+
this.nowFn = opts.now ?? (() => new Date());
|
|
123
|
+
this.setTimer = opts.setTimer ?? ((fn, ms) => setTimeout(fn, ms));
|
|
124
|
+
this.clearTimer = opts.clearTimer ?? ((h) => clearTimeout(h));
|
|
125
|
+
this.state = {
|
|
126
|
+
mode: 'disabled',
|
|
127
|
+
externalPort: this.externalPort,
|
|
128
|
+
internalPort: this.internalPort,
|
|
129
|
+
routerExternalIp: null,
|
|
130
|
+
leaseExpiresAt: null,
|
|
131
|
+
lastError: null,
|
|
132
|
+
};
|
|
133
|
+
}
|
|
134
|
+
getState() {
|
|
135
|
+
return { ...this.state };
|
|
136
|
+
}
|
|
137
|
+
/** Install the mapping and schedule periodic refresh. */
|
|
138
|
+
async start() {
|
|
139
|
+
if (this.started)
|
|
140
|
+
return;
|
|
141
|
+
this.started = true;
|
|
142
|
+
await this.installMapping();
|
|
143
|
+
this.scheduleRefresh();
|
|
144
|
+
}
|
|
145
|
+
/** Release the mapping and clear timers. Idempotent. */
|
|
146
|
+
async stop() {
|
|
147
|
+
if (!this.started)
|
|
148
|
+
return;
|
|
149
|
+
this.started = false;
|
|
150
|
+
if (this.refreshHandle) {
|
|
151
|
+
this.clearTimer(this.refreshHandle);
|
|
152
|
+
this.refreshHandle = null;
|
|
153
|
+
}
|
|
154
|
+
try {
|
|
155
|
+
await this.mapper.unmap(this.externalPort, this.protocol);
|
|
156
|
+
}
|
|
157
|
+
catch (err) {
|
|
158
|
+
log('unmap during stop failed: %s', err.message);
|
|
159
|
+
}
|
|
160
|
+
try {
|
|
161
|
+
await this.mapper.stop();
|
|
162
|
+
}
|
|
163
|
+
catch (err) {
|
|
164
|
+
log('mapper.stop() failed: %s', err.message);
|
|
165
|
+
}
|
|
166
|
+
this.state = {
|
|
167
|
+
...this.state,
|
|
168
|
+
mode: 'disabled',
|
|
169
|
+
routerExternalIp: null,
|
|
170
|
+
leaseExpiresAt: null,
|
|
171
|
+
};
|
|
172
|
+
}
|
|
173
|
+
/** Force an immediate verify+refresh cycle (used by testReachability). */
|
|
174
|
+
async refresh() {
|
|
175
|
+
if (!this.started)
|
|
176
|
+
return this.getState();
|
|
177
|
+
const ok = await this.mapper.verify(this.externalPort, this.protocol).catch(() => false);
|
|
178
|
+
if (!ok) {
|
|
179
|
+
log('verify() returned false; re-mapping');
|
|
180
|
+
await this.installMapping();
|
|
181
|
+
return this.getState();
|
|
182
|
+
}
|
|
183
|
+
// Refresh: re-issue the mapping to extend the lease.
|
|
184
|
+
await this.installMapping();
|
|
185
|
+
return this.getState();
|
|
186
|
+
}
|
|
187
|
+
scheduleRefresh() {
|
|
188
|
+
if (this.refreshHandle)
|
|
189
|
+
this.clearTimer(this.refreshHandle);
|
|
190
|
+
this.refreshHandle = this.setTimer(() => {
|
|
191
|
+
void this.refresh().catch((err) => log('refresh timer error: %s', err.message));
|
|
192
|
+
// Re-arm after the call to avoid drift.
|
|
193
|
+
this.scheduleRefresh();
|
|
194
|
+
}, this.refreshMs);
|
|
195
|
+
}
|
|
196
|
+
async installMapping() {
|
|
197
|
+
try {
|
|
198
|
+
const r = await this.mapper.map({
|
|
199
|
+
externalPort: this.externalPort,
|
|
200
|
+
internalPort: this.internalPort,
|
|
201
|
+
protocol: this.protocol,
|
|
202
|
+
ttlMs: this.ttlMs,
|
|
203
|
+
});
|
|
204
|
+
this.state = {
|
|
205
|
+
mode: r.mode,
|
|
206
|
+
externalPort: r.externalPort,
|
|
207
|
+
internalPort: r.internalPort,
|
|
208
|
+
routerExternalIp: r.externalIp,
|
|
209
|
+
leaseExpiresAt: r.leaseExpiresAt,
|
|
210
|
+
lastError: null,
|
|
211
|
+
};
|
|
212
|
+
log('mapped port %d (mode=%s, externalIp=%s)', r.externalPort, r.mode, r.externalIp ?? '?');
|
|
213
|
+
}
|
|
214
|
+
catch (err) {
|
|
215
|
+
const message = err.message;
|
|
216
|
+
this.state = {
|
|
217
|
+
...this.state,
|
|
218
|
+
mode: 'failed',
|
|
219
|
+
leaseExpiresAt: null,
|
|
220
|
+
lastError: message,
|
|
221
|
+
};
|
|
222
|
+
log('mapping failed: %s', message);
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
}
|
|
226
|
+
//# sourceMappingURL=port-mapper.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"port-mapper.js","sourceRoot":"","sources":["../../src/nat/port-mapper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAwB,MAAM,YAAY,CAAC;AAE5D,MAAM,GAAG,GAAG,KAAK,CAAC,4BAA4B,CAAC,CAAC;AAEhD,sFAAsF;AACtF,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEnD,yEAAyE;AACzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAmDjD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,OAG1C,EAAE;IACJ,IAAI,GAAwB,CAAC;IAC7B,IAAI,CAAC;QACH,GAAG,GAAG,CAAC,MAAM,MAAM,CAAC,8BAAwC,CAAC,CAAwB,CAAC;IACxF,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,QAAQ,CAChB,gBAAgB,EAChB,kDAAmD,GAAa,CAAC,OAAO,EAAE,CAC3E,CAAC;IACJ,CAAC;IAED,IAAI,MAA2B,CAAC;IAChC,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,mBAAmB;YACpD,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,IAAI,oBAAoB,CAAC,GAAG,IAAI,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,QAAQ,CAChB,gBAAgB,EAChB,qBAAsB,GAAa,CAAC,OAAO,EAAE,CAC9C,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,IAAI,oBAAoB,CAAC,CAAC;AAC9E,CAAC;AAED,MAAM,oBAAoB;IACxB,YACmB,MAA2B,EAC3B,YAAoB;QADpB,WAAM,GAAN,MAAM,CAAqB;QAC3B,iBAAY,GAAZ,YAAY,CAAQ;IACpC,CAAC;IAEJ,KAAK,CAAC,GAAG,CAAC,IAAoB;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC;QACxC,IAAI,UAAU,GAAkB,IAAI,CAAC;QACrC,IAAI,CAAC;YACH,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,yBAAyB,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;gBACpB,SAAS,EAAE,IAAI,CAAC,YAAY;gBAC5B,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,QAAQ;gBACR,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;aAC9B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,QAAQ,CAChB,gBAAgB,EAChB,mCAAmC,IAAI,CAAC,YAAY,KAAM,GAAa,CAAC,OAAO,EAAE,CAClF,CAAC;QACJ,CAAC;QACD,OAAO;YACL,IAAI,EAAE,WAAW;YACjB,UAAU;YACV,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,QAAQ;YACR,cAAc,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;SAC7C,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,YAAoB,EAAE,WAA0B,KAAK;QAChE,KAAK,YAAY,CAAC;QAClB,KAAK,QAAQ,CAAC;QACd,mEAAmE;QACnE,yEAAyE;QACzE,8CAA8C;QAC9C,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,qBAAqB,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;YACnD,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACxC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,yBAAyB,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;YACvD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,YAAoB,EAAE,WAA0B,KAAK;QAC/D,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,sBAAsB,EAAE,YAAY,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,mBAAmB,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;CACF;AA2BD;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAe5B,YAAY,IAA8B;QAHlC,kBAAa,GAA0B,IAAI,CAAC;QAC5C,YAAO,GAAG,KAAK,CAAC;QAGtB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,oBAAoB,CAAC;QAChD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,kBAAkB,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAClE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QAE9D,IAAI,CAAC,KAAK,GAAG;YACX,IAAI,EAAE,UAAU;YAChB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,gBAAgB,EAAE,IAAI;YACtB,cAAc,EAAE,IAAI;YACpB,SAAS,EAAE,IAAI;SAChB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED,wDAAwD;IACxD,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAC1B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACpC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,8BAA8B,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,GAAG,CAAC,0BAA0B,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,KAAK,GAAG;YACX,GAAG,IAAI,CAAC,KAAK;YACb,IAAI,EAAE,UAAU;YAChB,gBAAgB,EAAE,IAAI;YACtB,cAAc,EAAE,IAAI;SACrB,CAAC;IACJ,CAAC;IAED,0EAA0E;IAC1E,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC1C,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QACzF,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,GAAG,CAAC,qCAAqC,CAAC,CAAC;YAC3C,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;QACzB,CAAC;QACD,qDAAqD;QACrD,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAEO,eAAe;QACrB,IAAI,IAAI,CAAC,aAAa;YAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC5D,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YACtC,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,yBAAyB,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC,CAAC;YAC3F,wCAAwC;YACxC,IAAI,CAAC,eAAe,EAAE,CAAC;QACzB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,cAAc;QAC1B,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;gBAC9B,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,KAAK,EAAE,IAAI,CAAC,KAAK;aAClB,CAAC,CAAC;YACH,IAAI,CAAC,KAAK,GAAG;gBACX,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,YAAY,EAAE,CAAC,CAAC,YAAY;gBAC5B,YAAY,EAAE,CAAC,CAAC,YAAY;gBAC5B,gBAAgB,EAAE,CAAC,CAAC,UAAU;gBAC9B,cAAc,EAAE,CAAC,CAAC,cAAc;gBAChC,SAAS,EAAE,IAAI;aAChB,CAAC;YACF,GAAG,CAAC,yCAAyC,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC;QAC9F,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,OAAO,GAAI,GAAa,CAAC,OAAO,CAAC;YACvC,IAAI,CAAC,KAAK,GAAG;gBACX,GAAG,IAAI,CAAC,KAAK;gBACb,IAAI,EAAE,QAAQ;gBACd,cAAc,EAAE,IAAI;gBACpB,SAAS,EAAE,OAAO;aACnB,CAAC;YACF,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;CACF"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { DirectReachability, PortForwardMode } from './types.js';
|
|
2
|
+
export interface ReachabilityInput {
|
|
3
|
+
portMode: PortForwardMode;
|
|
4
|
+
cgnatDetected: boolean;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* v1 reachability heuristic.
|
|
8
|
+
*
|
|
9
|
+
* Returns:
|
|
10
|
+
* - 'cgnat' when CGNAT was detected (highest signal — UPnP succeeded but our
|
|
11
|
+
* external IP isn't actually reachable from the open internet).
|
|
12
|
+
* - 'unreachable' when port mapping failed.
|
|
13
|
+
* - 'reachable' when an auto mapping succeeded.
|
|
14
|
+
* - 'unknown' otherwise (manual config, disabled UPnP, etc).
|
|
15
|
+
*
|
|
16
|
+
* A future ticket will replace this with libp2p AutoNAT or a sereus-owned
|
|
17
|
+
* dial-back probe (see the follow-up section of `6.3-cadre-host-nat`).
|
|
18
|
+
*/
|
|
19
|
+
export declare function evaluateReachability(input: ReachabilityInput): DirectReachability;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* v1 reachability heuristic.
|
|
3
|
+
*
|
|
4
|
+
* Returns:
|
|
5
|
+
* - 'cgnat' when CGNAT was detected (highest signal — UPnP succeeded but our
|
|
6
|
+
* external IP isn't actually reachable from the open internet).
|
|
7
|
+
* - 'unreachable' when port mapping failed.
|
|
8
|
+
* - 'reachable' when an auto mapping succeeded.
|
|
9
|
+
* - 'unknown' otherwise (manual config, disabled UPnP, etc).
|
|
10
|
+
*
|
|
11
|
+
* A future ticket will replace this with libp2p AutoNAT or a sereus-owned
|
|
12
|
+
* dial-back probe (see the follow-up section of `6.3-cadre-host-nat`).
|
|
13
|
+
*/
|
|
14
|
+
export function evaluateReachability(input) {
|
|
15
|
+
if (input.cgnatDetected)
|
|
16
|
+
return 'cgnat';
|
|
17
|
+
switch (input.portMode) {
|
|
18
|
+
case 'auto-upnp':
|
|
19
|
+
case 'auto-natpmp':
|
|
20
|
+
return 'reachable';
|
|
21
|
+
case 'failed':
|
|
22
|
+
return 'unreachable';
|
|
23
|
+
case 'manual':
|
|
24
|
+
case 'disabled':
|
|
25
|
+
default:
|
|
26
|
+
return 'unknown';
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=reachability.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reachability.js","sourceRoot":"","sources":["../../src/nat/reachability.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAwB;IAC3D,IAAI,KAAK,CAAC,aAAa;QAAE,OAAO,OAAO,CAAC;IACxC,QAAQ,KAAK,CAAC,QAAQ,EAAE,CAAC;QACvB,KAAK,WAAW,CAAC;QACjB,KAAK,aAAa;YAChB,OAAO,WAAW,CAAC;QACrB,KAAK,QAAQ;YACX,OAAO,aAAa,CAAC;QACvB,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { SecretsStore } from './index.js';
|
|
2
|
+
/**
|
|
3
|
+
* Filesystem fallback for `SecretsStore`. Writes to `<rootDir>/nat-secrets.json`
|
|
4
|
+
* with mode 0o600.
|
|
5
|
+
*
|
|
6
|
+
* This is NOT a substitute for the OS keychain — the file is plain JSON, only
|
|
7
|
+
* protected by POSIX permissions. We use it only when keytar is unavailable
|
|
8
|
+
* and the caller has been warned (see `createSecretsStore`).
|
|
9
|
+
*
|
|
10
|
+
* Windows: chmod is a no-op (mode bits don't apply), so the file is readable
|
|
11
|
+
* by any user on the same machine. This is documented.
|
|
12
|
+
*/
|
|
13
|
+
export declare class FileSecretsStore implements SecretsStore {
|
|
14
|
+
private readonly path;
|
|
15
|
+
constructor(rootDir: string);
|
|
16
|
+
filePath(): string;
|
|
17
|
+
set(account: string, value: string): Promise<void>;
|
|
18
|
+
get(account: string): Promise<string | null>;
|
|
19
|
+
delete(account: string): Promise<boolean>;
|
|
20
|
+
list(): Promise<string[]>;
|
|
21
|
+
private load;
|
|
22
|
+
private save;
|
|
23
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { chmodSync, existsSync, mkdirSync, readFileSync, renameSync, writeFileSync, } from 'node:fs';
|
|
2
|
+
import { dirname, join } from 'node:path';
|
|
3
|
+
import debug from 'debug';
|
|
4
|
+
import { NatError } from '../types.js';
|
|
5
|
+
const log = debug('cadre:host:nat-secrets:file');
|
|
6
|
+
const FILE_VERSION = 1;
|
|
7
|
+
/**
|
|
8
|
+
* Filesystem fallback for `SecretsStore`. Writes to `<rootDir>/nat-secrets.json`
|
|
9
|
+
* with mode 0o600.
|
|
10
|
+
*
|
|
11
|
+
* This is NOT a substitute for the OS keychain — the file is plain JSON, only
|
|
12
|
+
* protected by POSIX permissions. We use it only when keytar is unavailable
|
|
13
|
+
* and the caller has been warned (see `createSecretsStore`).
|
|
14
|
+
*
|
|
15
|
+
* Windows: chmod is a no-op (mode bits don't apply), so the file is readable
|
|
16
|
+
* by any user on the same machine. This is documented.
|
|
17
|
+
*/
|
|
18
|
+
export class FileSecretsStore {
|
|
19
|
+
constructor(rootDir) {
|
|
20
|
+
mkdirSync(rootDir, { recursive: true });
|
|
21
|
+
this.path = join(rootDir, 'nat-secrets.json');
|
|
22
|
+
}
|
|
23
|
+
filePath() {
|
|
24
|
+
return this.path;
|
|
25
|
+
}
|
|
26
|
+
async set(account, value) {
|
|
27
|
+
const data = this.load();
|
|
28
|
+
data.entries[account] = value;
|
|
29
|
+
this.save(data);
|
|
30
|
+
}
|
|
31
|
+
async get(account) {
|
|
32
|
+
const data = this.load();
|
|
33
|
+
return Object.prototype.hasOwnProperty.call(data.entries, account)
|
|
34
|
+
? data.entries[account]
|
|
35
|
+
: null;
|
|
36
|
+
}
|
|
37
|
+
async delete(account) {
|
|
38
|
+
const data = this.load();
|
|
39
|
+
if (!Object.prototype.hasOwnProperty.call(data.entries, account))
|
|
40
|
+
return false;
|
|
41
|
+
delete data.entries[account];
|
|
42
|
+
this.save(data);
|
|
43
|
+
return true;
|
|
44
|
+
}
|
|
45
|
+
async list() {
|
|
46
|
+
return Object.keys(this.load().entries);
|
|
47
|
+
}
|
|
48
|
+
load() {
|
|
49
|
+
if (!existsSync(this.path)) {
|
|
50
|
+
return { version: FILE_VERSION, entries: {} };
|
|
51
|
+
}
|
|
52
|
+
let raw;
|
|
53
|
+
try {
|
|
54
|
+
raw = readFileSync(this.path, 'utf8');
|
|
55
|
+
}
|
|
56
|
+
catch (err) {
|
|
57
|
+
throw new NatError('storage_error', `failed to read nat-secrets file at ${this.path}: ${err.message}`);
|
|
58
|
+
}
|
|
59
|
+
let parsed;
|
|
60
|
+
try {
|
|
61
|
+
parsed = JSON.parse(raw);
|
|
62
|
+
}
|
|
63
|
+
catch (err) {
|
|
64
|
+
throw new NatError('storage_error', `nat-secrets file at ${this.path} is not valid JSON: ${err.message}`);
|
|
65
|
+
}
|
|
66
|
+
if (!isFileShape(parsed)) {
|
|
67
|
+
throw new NatError('storage_error', `nat-secrets file at ${this.path} has unexpected shape`);
|
|
68
|
+
}
|
|
69
|
+
return parsed;
|
|
70
|
+
}
|
|
71
|
+
save(data) {
|
|
72
|
+
mkdirSync(dirname(this.path), { recursive: true });
|
|
73
|
+
const payload = JSON.stringify({ ...data, version: FILE_VERSION }, null, 2);
|
|
74
|
+
const tmp = `${this.path}.tmp`;
|
|
75
|
+
writeFileSync(tmp, payload, { encoding: 'utf8', mode: 0o600 });
|
|
76
|
+
renameSync(tmp, this.path);
|
|
77
|
+
// chmod again after rename — some platforms reset perms on rename.
|
|
78
|
+
if (process.platform !== 'win32') {
|
|
79
|
+
try {
|
|
80
|
+
chmodSync(this.path, 0o600);
|
|
81
|
+
}
|
|
82
|
+
catch (err) {
|
|
83
|
+
log('chmod 0600 on %s failed: %s', this.path, err.message);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
function isFileShape(v) {
|
|
89
|
+
if (!v || typeof v !== 'object')
|
|
90
|
+
return false;
|
|
91
|
+
const obj = v;
|
|
92
|
+
if (obj.version !== FILE_VERSION)
|
|
93
|
+
return false;
|
|
94
|
+
if (!obj.entries || typeof obj.entries !== 'object')
|
|
95
|
+
return false;
|
|
96
|
+
for (const val of Object.values(obj.entries)) {
|
|
97
|
+
if (typeof val !== 'string')
|
|
98
|
+
return false;
|
|
99
|
+
}
|
|
100
|
+
return true;
|
|
101
|
+
}
|
|
102
|
+
//# sourceMappingURL=file-store.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"file-store.js","sourceRoot":"","sources":["../../../src/nat/secrets/file-store.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,UAAU,EACV,aAAa,GACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,MAAM,GAAG,GAAG,KAAK,CAAC,6BAA6B,CAAC,CAAC;AAEjD,MAAM,YAAY,GAAG,CAAC,CAAC;AAQvB;;;;;;;;;;GAUG;AACH,MAAM,OAAO,gBAAgB;IAG3B,YAAY,OAAe;QACzB,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;IAChD,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,OAAe,EAAE,KAAa;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,OAAe;QACvB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC;YAChE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAE;YACxB,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAe;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC;YAAE,OAAO,KAAK,CAAC;QAC/E,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,IAAI;QACR,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAEO,IAAI;QACV,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAChD,CAAC;QACD,IAAI,GAAW,CAAC;QAChB,IAAI,CAAC;YACH,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,QAAQ,CAChB,eAAe,EACf,sCAAsC,IAAI,CAAC,IAAI,KAAM,GAAa,CAAC,OAAO,EAAE,CAC7E,CAAC;QACJ,CAAC;QACD,IAAI,MAAe,CAAC;QACpB,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,QAAQ,CAChB,eAAe,EACf,uBAAuB,IAAI,CAAC,IAAI,uBAAwB,GAAa,CAAC,OAAO,EAAE,CAChF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,QAAQ,CAChB,eAAe,EACf,uBAAuB,IAAI,CAAC,IAAI,uBAAuB,CACxD,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,IAAI,CAAC,IAAe;QAC1B,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC5E,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,MAAM,CAAC;QAC/B,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/D,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3B,mEAAmE;QACnE,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YACjC,IAAI,CAAC;gBACH,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC9B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,GAAG,CAAC,6BAA6B,EAAE,IAAI,CAAC,IAAI,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED,SAAS,WAAW,CAAC,CAAU;IAC7B,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC9C,MAAM,GAAG,GAAG,CAA4B,CAAC;IACzC,IAAI,GAAG,CAAC,OAAO,KAAK,YAAY;QAAE,OAAO,KAAK,CAAC;IAC/C,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAClE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,OAAkC,CAAC,EAAE,CAAC;QACxE,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;IAC5C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { KeytarSecretsStore } from './keytar-store.js';
|
|
2
|
+
import { FileSecretsStore } from './file-store.js';
|
|
3
|
+
/** Service name used as the keytar collection. */
|
|
4
|
+
export declare const KEYTAR_SERVICE = "sereus-cadre-host";
|
|
5
|
+
/**
|
|
6
|
+
* Abstract credential store. Keys are opaque to the store
|
|
7
|
+
* (e.g. "ddns:duckdns:token").
|
|
8
|
+
*/
|
|
9
|
+
export interface SecretsStore {
|
|
10
|
+
set(account: string, value: string): Promise<void>;
|
|
11
|
+
get(account: string): Promise<string | null>;
|
|
12
|
+
delete(account: string): Promise<boolean>;
|
|
13
|
+
list(): Promise<string[]>;
|
|
14
|
+
}
|
|
15
|
+
export { KeytarSecretsStore, FileSecretsStore };
|
|
16
|
+
/**
|
|
17
|
+
* Try the OS keychain (keytar) first; fall back to a 0600 JSON file in the
|
|
18
|
+
* cadre-host rootDir. The fallback path is documented in `docs/cadre-host.md`.
|
|
19
|
+
*
|
|
20
|
+
* `keytar` is loaded via dynamic import inside a try/catch so a missing native
|
|
21
|
+
* dependency never crashes package import. The same applies to runtime errors
|
|
22
|
+
* (some Linux desktops have keytar installed but no DBus secret service).
|
|
23
|
+
*/
|
|
24
|
+
export declare function createSecretsStore(rootDir: string): Promise<SecretsStore>;
|
|
25
|
+
/** Subset of keytar's surface that KeytarSecretsStore uses. */
|
|
26
|
+
export interface KeytarLike {
|
|
27
|
+
setPassword(service: string, account: string, password: string): Promise<void>;
|
|
28
|
+
getPassword(service: string, account: string): Promise<string | null>;
|
|
29
|
+
deletePassword(service: string, account: string): Promise<boolean>;
|
|
30
|
+
findCredentials(service: string): Promise<Array<{
|
|
31
|
+
account: string;
|
|
32
|
+
password: string;
|
|
33
|
+
}>>;
|
|
34
|
+
}
|
|
35
|
+
/** Build the keytar account key for a DDNS credential. */
|
|
36
|
+
export declare function ddnsAccount(providerId: string, fieldKey: string): string;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import debug from 'debug';
|
|
2
|
+
import { NatError } from '../types.js';
|
|
3
|
+
import { KeytarSecretsStore } from './keytar-store.js';
|
|
4
|
+
import { FileSecretsStore } from './file-store.js';
|
|
5
|
+
const log = debug('cadre:host:nat-secrets');
|
|
6
|
+
/** Service name used as the keytar collection. */
|
|
7
|
+
export const KEYTAR_SERVICE = 'sereus-cadre-host';
|
|
8
|
+
export { KeytarSecretsStore, FileSecretsStore };
|
|
9
|
+
/**
|
|
10
|
+
* Try the OS keychain (keytar) first; fall back to a 0600 JSON file in the
|
|
11
|
+
* cadre-host rootDir. The fallback path is documented in `docs/cadre-host.md`.
|
|
12
|
+
*
|
|
13
|
+
* `keytar` is loaded via dynamic import inside a try/catch so a missing native
|
|
14
|
+
* dependency never crashes package import. The same applies to runtime errors
|
|
15
|
+
* (some Linux desktops have keytar installed but no DBus secret service).
|
|
16
|
+
*/
|
|
17
|
+
export async function createSecretsStore(rootDir) {
|
|
18
|
+
// First, try to load keytar.
|
|
19
|
+
let keytarMod;
|
|
20
|
+
try {
|
|
21
|
+
keytarMod = await import('keytar');
|
|
22
|
+
}
|
|
23
|
+
catch (err) {
|
|
24
|
+
log('keytar unavailable (%s); using file fallback', err.message);
|
|
25
|
+
return makeFileFallback(rootDir, `keytar not installed: ${err.message}`);
|
|
26
|
+
}
|
|
27
|
+
// Probe with a sentinel write — some installs load but throw at runtime.
|
|
28
|
+
const ks = new KeytarSecretsStore(KEYTAR_SERVICE, keytarMod);
|
|
29
|
+
const probeAccount = '__cadre_host_probe__';
|
|
30
|
+
try {
|
|
31
|
+
await ks.set(probeAccount, '1');
|
|
32
|
+
await ks.delete(probeAccount);
|
|
33
|
+
log('using keytar for DDNS credentials (service=%s)', KEYTAR_SERVICE);
|
|
34
|
+
return ks;
|
|
35
|
+
}
|
|
36
|
+
catch (err) {
|
|
37
|
+
log('keytar probe failed (%s); using file fallback', err.message);
|
|
38
|
+
return makeFileFallback(rootDir, `keytar runtime error: ${err.message}`);
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
function makeFileFallback(rootDir, reason) {
|
|
42
|
+
const store = new FileSecretsStore(rootDir);
|
|
43
|
+
// eslint-disable-next-line no-console
|
|
44
|
+
console.warn(`[cadre-host] DDNS credentials will be stored UNENCRYPTED at ` +
|
|
45
|
+
`${store.filePath()} (${reason}). Install keytar's native dependencies ` +
|
|
46
|
+
`for OS keychain protection.`);
|
|
47
|
+
return store;
|
|
48
|
+
}
|
|
49
|
+
/** Build the keytar account key for a DDNS credential. */
|
|
50
|
+
export function ddnsAccount(providerId, fieldKey) {
|
|
51
|
+
if (!providerId || !fieldKey) {
|
|
52
|
+
throw new NatError('invalid_config', 'providerId and fieldKey are required');
|
|
53
|
+
}
|
|
54
|
+
return `ddns:${providerId}:${fieldKey}`;
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/nat/secrets/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD,MAAM,GAAG,GAAG,KAAK,CAAC,wBAAwB,CAAC,CAAC;AAE5C,kDAAkD;AAClD,MAAM,CAAC,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAalD,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,OAAe;IACtD,6BAA6B;IAC7B,IAAI,SAAkB,CAAC;IACvB,IAAI,CAAC;QACH,SAAS,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,GAAG,CAAC,8CAA8C,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;QAC5E,OAAO,gBAAgB,CAAC,OAAO,EAAE,yBAA0B,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,yEAAyE;IACzE,MAAM,EAAE,GAAG,IAAI,kBAAkB,CAAC,cAAc,EAAE,SAAuB,CAAC,CAAC;IAC3E,MAAM,YAAY,GAAG,sBAAsB,CAAC;IAC5C,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QAChC,MAAM,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC9B,GAAG,CAAC,gDAAgD,EAAE,cAAc,CAAC,CAAC;QACtE,OAAO,EAAE,CAAC;IACZ,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,GAAG,CAAC,+CAA+C,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;QAC7E,OAAO,gBAAgB,CAAC,OAAO,EAAE,yBAA0B,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAe,EAAE,MAAc;IACvD,MAAM,KAAK,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC5C,sCAAsC;IACtC,OAAO,CAAC,IAAI,CACV,8DAA8D;QAC9D,GAAG,KAAK,CAAC,QAAQ,EAAE,KAAK,MAAM,0CAA0C;QACxE,6BAA6B,CAC9B,CAAC;IACF,OAAO,KAAK,CAAC;AACf,CAAC;AAUD,0DAA0D;AAC1D,MAAM,UAAU,WAAW,CAAC,UAAkB,EAAE,QAAgB;IAC9D,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC7B,MAAM,IAAI,QAAQ,CAAC,gBAAgB,EAAE,sCAAsC,CAAC,CAAC;IAC/E,CAAC;IACD,OAAO,QAAQ,UAAU,IAAI,QAAQ,EAAE,CAAC;AAC1C,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { KeytarLike, SecretsStore } from './index.js';
|
|
2
|
+
/**
|
|
3
|
+
* SecretsStore backed by the OS keychain via the `keytar` npm package.
|
|
4
|
+
*
|
|
5
|
+
* The keytar module is injected (rather than imported here) so:
|
|
6
|
+
* - The native dependency is loaded lazily by `createSecretsStore` and
|
|
7
|
+
* unavailable platforms fall through cleanly to the file store.
|
|
8
|
+
* - Unit tests can stub the entire keytar surface.
|
|
9
|
+
*/
|
|
10
|
+
export declare class KeytarSecretsStore implements SecretsStore {
|
|
11
|
+
private readonly service;
|
|
12
|
+
private readonly keytar;
|
|
13
|
+
constructor(service: string, keytar: KeytarLike);
|
|
14
|
+
set(account: string, value: string): Promise<void>;
|
|
15
|
+
get(account: string): Promise<string | null>;
|
|
16
|
+
delete(account: string): Promise<boolean>;
|
|
17
|
+
list(): Promise<string[]>;
|
|
18
|
+
}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import debug from 'debug';
|
|
2
|
+
import { NatError } from '../types.js';
|
|
3
|
+
const log = debug('cadre:host:nat-secrets:keytar');
|
|
4
|
+
/**
|
|
5
|
+
* SecretsStore backed by the OS keychain via the `keytar` npm package.
|
|
6
|
+
*
|
|
7
|
+
* The keytar module is injected (rather than imported here) so:
|
|
8
|
+
* - The native dependency is loaded lazily by `createSecretsStore` and
|
|
9
|
+
* unavailable platforms fall through cleanly to the file store.
|
|
10
|
+
* - Unit tests can stub the entire keytar surface.
|
|
11
|
+
*/
|
|
12
|
+
export class KeytarSecretsStore {
|
|
13
|
+
constructor(service, keytar) {
|
|
14
|
+
this.service = service;
|
|
15
|
+
this.keytar = keytar;
|
|
16
|
+
}
|
|
17
|
+
async set(account, value) {
|
|
18
|
+
try {
|
|
19
|
+
await this.keytar.setPassword(this.service, account, value);
|
|
20
|
+
}
|
|
21
|
+
catch (err) {
|
|
22
|
+
throw new NatError('secrets_unavailable', `keytar setPassword failed: ${err.message}`);
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
async get(account) {
|
|
26
|
+
try {
|
|
27
|
+
return await this.keytar.getPassword(this.service, account);
|
|
28
|
+
}
|
|
29
|
+
catch (err) {
|
|
30
|
+
throw new NatError('secrets_unavailable', `keytar getPassword failed: ${err.message}`);
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
async delete(account) {
|
|
34
|
+
try {
|
|
35
|
+
return await this.keytar.deletePassword(this.service, account);
|
|
36
|
+
}
|
|
37
|
+
catch (err) {
|
|
38
|
+
throw new NatError('secrets_unavailable', `keytar deletePassword failed: ${err.message}`);
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
async list() {
|
|
42
|
+
try {
|
|
43
|
+
const creds = await this.keytar.findCredentials(this.service);
|
|
44
|
+
log('keytar findCredentials returned %d entries', creds.length);
|
|
45
|
+
return creds.map((c) => c.account);
|
|
46
|
+
}
|
|
47
|
+
catch (err) {
|
|
48
|
+
throw new NatError('secrets_unavailable', `keytar findCredentials failed: ${err.message}`);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
//# sourceMappingURL=keytar-store.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"keytar-store.js","sourceRoot":"","sources":["../../../src/nat/secrets/keytar-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,MAAM,GAAG,GAAG,KAAK,CAAC,+BAA+B,CAAC,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,OAAO,kBAAkB;IAC7B,YACmB,OAAe,EACf,MAAkB;QADlB,YAAO,GAAP,OAAO,CAAQ;QACf,WAAM,GAAN,MAAM,CAAY;IAClC,CAAC;IAEJ,KAAK,CAAC,GAAG,CAAC,OAAe,EAAE,KAAa;QACtC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,8BAA+B,GAAa,CAAC,OAAO,EAAE,CACvD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,OAAe;QACvB,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,8BAA+B,GAAa,CAAC,OAAO,EAAE,CACvD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAe;QAC1B,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACjE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,iCAAkC,GAAa,CAAC,OAAO,EAAE,CAC1D,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9D,GAAG,CAAC,4CAA4C,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAChE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,QAAQ,CAChB,qBAAqB,EACrB,kCAAmC,GAAa,CAAC,OAAO,EAAE,CAC3D,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}
|