Files
ppq-private-mode-startos/startos/main.ts
T

118 lines
4.1 KiB
TypeScript

import { utils } from '@start9labs/start-sdk'
import { i18n } from './i18n'
import { sdk } from './sdk'
import { manifest } from './manifest'
import { apiHostId, apiPort, dataDir } from './utils'
import { configureApiKey } from './actions/configureApiKey'
import { configJson } from './fileModels/config.json'
import { storeJson } from './fileModels/store.json'
export const main = sdk.setupMain(async ({ effects }) => {
console.info(i18n('Starting PPQ Private Mode!'))
// The proxy reads config.json once at startup, so watching it is what makes a
// key saved by the Configure PPQ API Key action take effect: the write
// restarts the daemon, which reloads the file. PPQ_API_KEY is left unset so
// the proxy's own key store is the only thing that owns the key.
const apiKey = await configJson.read((c) => c.apiKey).const(effects)
const debug = await storeJson.read((s) => s.debug).const(effects)
// Running the action clears its own task, but a key saved on the Status Page
// never touches the action — so clear it here, on the restart that same save
// triggers. Otherwise StartOS keeps asking for a key the user already set.
if (apiKey) {
await sdk.action.clearTask(effects, `${manifest.id}:${configureApiKey.id}`)
}
// DNS-rebinding hardening. Upstream's proxy is bound to 0.0.0.0, and without
// PPQ_ALLOWED_HOSTS it accepts any Host header — a hostile web page could
// reach it as "same-origin" and even overwrite the stored API key via
// /setup/api-key. Pin the accepted Hosts to exactly the addresses StartOS
// serves this binding on, plus loopback and the bridge (what Open WebUI
// dials). Resolved reactively so an address added later is picked up on the
// next restart.
const servedHosts = await sdk.host
.getOwn(
effects,
apiHostId,
(host) =>
host
? utils
.filledAddress(host, {
hostId: apiHostId,
internalPort: apiPort,
username: null,
scheme: null,
sslScheme: null,
suffix: '',
})
.matchesAny([{ visibility: 'private' }, { visibility: 'public' }])
.filter({ exclude: { kind: ['localhost', 'link-local'] } })
.hostnames.map((h) => h.hostname)
: [],
)
.const()
const osIp = await sdk.getOsIp(effects)
const allowedHosts = Array.from(
new Set(['localhost', '127.0.0.1', osIp, ...servedHosts].filter(Boolean)),
).join(',')
const subcontainer = sdk.SubContainer.of(
effects,
{ imageId: 'proxy' },
sdk.Mounts.of().mountVolume({
volumeId: 'main',
subpath: 'proxy',
mountpoint: dataDir,
readonly: false,
}),
'proxy-sub',
)
return sdk.Daemons.of(effects)
.addOneshot('chown', {
subcontainer,
exec: {
command: ['chown', '-R', 'node:node', dataDir],
user: 'root',
},
requires: [],
})
.addDaemon('proxy', {
subcontainer,
exec: {
command: ['node', '/app/dist/bin/server.js'],
env: allowedHosts
? {
PPQ_DATA_DIR: dataDir,
HOST: '0.0.0.0',
PORT: apiPort.toString(),
DEBUG: debug ? 'true' : 'false',
PPQ_ALLOWED_HOSTS: allowedHosts,
}
: {
PPQ_DATA_DIR: dataDir,
HOST: '0.0.0.0',
PORT: apiPort.toString(),
DEBUG: debug ? 'true' : 'false',
},
},
// The proxy only binds its port after remote attestation of the enclave
// succeeds, so a listening port means the encrypted channel is verified
// and ready.
ready: {
display: i18n('Encrypted Proxy'),
fn: () =>
sdk.healthCheck.checkPortListening(effects, apiPort, {
successMessage: i18n(
'The proxy is ready — enclave attestation verified',
),
errorMessage: i18n(
'The proxy is not ready (enclave attestation pending)',
),
}),
},
requires: ['chown'],
})
})