diff --git a/.env.example b/.env.example index 2e923eb2d..c197b4468 100644 --- a/.env.example +++ b/.env.example @@ -87,7 +87,7 @@ GITHUB_EVENT_INTAKE_MODE=routing_websocket # without PROPR_UI_TUNNEL_TOKEN. Redundant when a token # is set, since a token alone already enables the tunnel # PROPR_INSTANCE_ID — this stack's instance id; must be a valid DNS label -# (letters, digits, hyphens; 1-63 chars). Derives the +# (letters, digits, hyphens; 1-61 chars). Derives the # public URL https://t-.propr.dev when no # explicit URL is set # PROPR_UI_PUBLIC_API_URL — explicit public API URL the hosted UI talks to (overrides the derived one) diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..749da8c10 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# The packaged Darwin ACL helper is hash-pinned; keep its source canonical. +packages/cli/native/darwin-authority-broker.c text eol=lf diff --git a/.github/workflows/desktop-connect-discovery-guard.yml b/.github/workflows/desktop-connect-discovery-guard.yml new file mode 100644 index 000000000..9148dfd1f --- /dev/null +++ b/.github/workflows/desktop-connect-discovery-guard.yml @@ -0,0 +1,131 @@ +name: Packaged Connect Discovery Guard + +on: + pull_request: + paths: + - '.github/workflows/desktop-connect-discovery-guard.yml' + - 'apps/desktop/**' + - 'packages/cli/**' + - 'packages/client/**' + - 'packages/shared/**' + - 'propr-ui/**' + - 'package.json' + - 'package-lock.json' + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: desktop-connect-discovery-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + +jobs: + packaged-connect-discovery: + name: Packaged Connect (${{ matrix.target }}) + runs-on: ${{ matrix.runner }} + timeout-minutes: 45 + strategy: + fail-fast: false + matrix: + include: + - target: darwin-x64 + runner: macos-15-intel + platform: darwin + arch: x64 + - target: darwin-arm64 + runner: macos-15 + platform: darwin + arch: arm64 + - target: linux-x64 + runner: ubuntu-24.04 + platform: linux + arch: x64 + - target: linux-arm64 + runner: ubuntu-24.04-arm + platform: linux + arch: arm64 + - target: win32-x64 + runner: windows-2025 + platform: win32 + arch: x64 + - target: win32-arm64 + runner: windows-11-arm + platform: win32 + arch: arm64 + + steps: + - name: Checkout repository + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + + - name: Set up target-native Node.js + uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6 + with: + node-version-file: '.nvmrc' + architecture: ${{ matrix.arch }} + cache: npm + cache-dependency-path: package-lock.json + + - name: Verify selected host architecture + shell: bash + run: | + test "$(node -p process.platform)" = "${{ matrix.platform }}" + test "$(node -p process.arch)" = "${{ matrix.arch }}" + + - name: Install locked dependencies + run: npm ci + + - name: Install native Linux package and credential tools + if: matrix.platform == 'linux' + run: | + sudo apt-get update + sudo apt-get install --yes cpio dbus-x11 fakeroot gnome-keyring libsecret-1-0 rpm zip + + - name: Verify encoded Windows PowerShell ACL helper success streams + if: matrix.platform == 'win32' + run: npm run test:windows-fixture-acl -w @propr/desktop + + - name: Verify Windows packaged launcher authority + if: matrix.platform == 'win32' + run: node --test apps/desktop/scripts/windows-packaged-connect-staging.test.mjs + + - name: Package the target-native desktop app + run: npm run desktop:package + + - name: Inspect the unsigned target-native desktop app + run: npm run desktop:smoke:inspect + + - name: Run packaged Linux main-to-renderer discovery + if: matrix.platform == 'linux' + shell: bash + run: | + sandbox="apps/desktop/out/propr-desktop-linux-${{ matrix.arch }}/chrome-sandbox" + sudo chown root:root "$sandbox" + sudo chmod 4755 "$sandbox" + test "$(stat -c '%U:%G:%a' "$sandbox")" = 'root:root:4755' + keyring_root="$(mktemp -d)" + trap 'rm -rf -- "$keyring_root"' EXIT + dbus-run-session -- bash -euo pipefail -c ' + export XDG_DATA_HOME="$1" + export PROPR_DESKTOP_SMOKE_KEYRING_ROOT="$1" + eval "$(printf "%s\n" "propr-packaged-smoke" | gnome-keyring-daemon --unlock --components=secrets)" + xvfb-run --auto-servernum npm run smoke:connect-package -w @propr/desktop + ' bash "$keyring_root" + + - name: Run packaged Darwin main-to-renderer discovery + if: matrix.platform == 'darwin' + shell: bash + run: >- + node apps/desktop/scripts/run-bounded-darwin-command.mjs + --timeout-ms 480000 + --termination-grace-ms 90000 + --max-output-bytes 1048576 + --forward-output true + -- bash apps/desktop/scripts/run-packaged-darwin-connect-smoke.sh '${{ matrix.arch }}' + + - name: Run packaged Windows main-to-renderer discovery as an ordinary user + if: matrix.platform == 'win32' + shell: powershell + run: >- + & apps/desktop/scripts/run-packaged-windows-connect-smoke.ps1 + -Architecture '${{ matrix.arch }}' diff --git a/.github/workflows/desktop-release-guard.yml b/.github/workflows/desktop-release-guard.yml index d121602e4..500ba1fd9 100644 --- a/.github/workflows/desktop-release-guard.yml +++ b/.github/workflows/desktop-release-guard.yml @@ -7,7 +7,9 @@ on: - 'apps/desktop/**' - 'package.json' - 'package-lock.json' + - 'packages/cli/**' - 'packages/client/**' + - 'packages/local-setup/**' - 'packages/shared/**' - 'propr-ui/**' push: @@ -22,6 +24,44 @@ concurrency: cancel-in-progress: ${{ github.ref_type != 'tag' }} jobs: + native-windows-durability: + name: Native Windows durability (x64) + if: github.event_name == 'pull_request' + runs-on: windows-latest + timeout-minutes: 30 + env: + PROPR_NATIVE_WINDOWS_DURABILITY_REQUIRED: '1' + + steps: + - name: Checkout repository + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + + - name: Set up x64 Node.js + uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6 + with: + node-version-file: '.nvmrc' + architecture: x64 + cache: npm + cache-dependency-path: package-lock.json + + - name: Install locked dependencies + run: npm ci + + - name: Run production Windows child-process durability matrix + run: npm run test:native-durability -w @propr/desktop + + - name: Typecheck desktop and renderer on Windows + run: npm run desktop:typecheck + + - name: Test desktop runtime on Windows + run: npm run desktop:test + + - name: Package Windows x64 desktop app + run: npm run desktop:package + + - name: Launch packaged Windows desktop transport smoke + run: npm run desktop:smoke + validation-version: name: Validate unsigned desktop package version if: github.event_name == 'pull_request' @@ -149,7 +189,7 @@ jobs: if: matrix.platform == 'linux' run: | sudo apt-get update - sudo apt-get install --yes cpio fakeroot rpm zip + sudo apt-get install --yes cpio dbus-x11 fakeroot gnome-keyring libsecret-1-0 rpm zip - name: Package desktop app from clean checkout shell: bash @@ -159,6 +199,10 @@ jobs: test ! -e apps/desktop/out npm run desktop:package + - name: Run Linux transaction durability parity + if: matrix.platform == 'linux' + run: npm run test:native-durability -w @propr/desktop + - name: Assert Windows MVP package excludes update authority if: matrix.platform == 'win32' shell: bash @@ -221,7 +265,14 @@ jobs: run: | sudo chown root:root "apps/desktop/out/propr-desktop-linux-${{ matrix.arch }}/chrome-sandbox" sudo chmod 4755 "apps/desktop/out/propr-desktop-linux-${{ matrix.arch }}/chrome-sandbox" - xvfb-run --auto-servernum npm run desktop:smoke + keyring_root="$(mktemp -d)" + trap 'rm -rf -- "$keyring_root"' EXIT + dbus-run-session -- bash -euo pipefail -c ' + export XDG_DATA_HOME="$1" + export PROPR_DESKTOP_SMOKE_KEYRING_ROOT="$1" + eval "$(printf "%s\n" "propr-packaged-smoke" | gnome-keyring-daemon --unlock --components=secrets)" + xvfb-run --auto-servernum npm run desktop:smoke + ' bash "$keyring_root" - name: Launch packaged Windows application and exercise MVP desktop flows if: matrix.platform == 'win32' @@ -497,7 +548,7 @@ jobs: if: matrix.platform == 'linux' run: | sudo apt-get update - sudo apt-get install --yes cpio fakeroot rpm zip + sudo apt-get install --yes cpio dbus-x11 fakeroot gnome-keyring libsecret-1-0 rpm zip - name: Configure required macOS signing and notarization if: matrix.platform == 'darwin' @@ -683,7 +734,14 @@ jobs: run: | sudo chown root:root "apps/desktop/out/propr-desktop-linux-${{ matrix.arch }}/chrome-sandbox" sudo chmod 4755 "apps/desktop/out/propr-desktop-linux-${{ matrix.arch }}/chrome-sandbox" - xvfb-run --auto-servernum npm run desktop:smoke + keyring_root="$(mktemp -d)" + trap 'rm -rf -- "$keyring_root"' EXIT + dbus-run-session -- bash -euo pipefail -c ' + export XDG_DATA_HOME="$1" + export PROPR_DESKTOP_SMOKE_KEYRING_ROOT="$1" + eval "$(printf "%s\n" "propr-packaged-smoke" | gnome-keyring-daemon --unlock --components=secrets)" + xvfb-run --auto-servernum npm run desktop:smoke + ' bash "$keyring_root" - name: Launch signed packaged Windows application and exercise MVP desktop flows if: matrix.platform == 'win32' diff --git a/.github/workflows/pr-build-check.yml b/.github/workflows/pr-build-check.yml index c7ab68dc5..0723b6f06 100644 --- a/.github/workflows/pr-build-check.yml +++ b/.github/workflows/pr-build-check.yml @@ -47,6 +47,8 @@ jobs: test -f packages/cli/dist/native/prebuilds/darwin-x64/directory-operations.node test -f packages/cli/dist/native/prebuilds/linux-arm64/directory-operations.node test -f packages/cli/dist/native/prebuilds/linux-x64/directory-operations.node + test -f packages/cli/dist/native/prebuilds/darwin-arm64/connect-authority-broker + test -f packages/cli/dist/native/prebuilds/darwin-x64/connect-authority-broker cli-agent-skill-glibc-231: name: CLI Agent Skill (Linux x64, glibc 2.31, Node 22) @@ -146,6 +148,135 @@ jobs: test ! -e "$skill_fixture/home/.gemini/antigravity-cli/skills/propr" test ! -e "$skill_fixture/xdg/opencode/skills/propr" + windows-connect-discovery: + name: Windows Connect Discovery (ordinary user, Node 22) + runs-on: windows-2025 + permissions: + contents: read + steps: + - name: Checkout repository + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + + - name: Set up Node.js 22 + uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6 + with: + node-version: 22 + cache: npm + + - name: Install dependencies + run: npm ci + + - name: Build discovery workspaces + shell: bash + run: | + npm run build -w @propr/shared + npm run build -w @propr/core + npm run build -w @propr/local-setup + npm run typecheck -w @propr/cli + npm run build -w @propr/cli + + - name: Run CLI and API discovery as a non-administrator + shell: powershell + run: | + $ErrorActionPreference = 'Stop' + $userName = 'propr-discovery' + $plainPassword = [Guid]::NewGuid().ToString('N') + 'aA1!' + $securePassword = ConvertTo-SecureString $plainPassword -AsPlainText -Force + New-LocalUser -Name $userName -Password $securePassword -PasswordNeverExpires | Out-Null + $administrators = Get-LocalGroupMember -Group 'Administrators' | ForEach-Object { $_.Name } + if ($administrators -contains "$env:COMPUTERNAME\$userName") { throw 'discovery test user is an administrator' } + $credential = [PSCredential]::new("$env:COMPUTERNAME\$userName", $securePassword) + $fixture = Join-Path $env:SystemDrive ("propr-discovery-" + [Guid]::NewGuid().ToString('N')) + $stackRoot = Join-Path $fixture 'stack-private-path-SENTINEL' + $dataRoot = Join-Path $stackRoot 'data' + $envFile = Join-Path $stackRoot '.env' + $identityFile = Join-Path $dataRoot 'public-instance-identity.json' + $fakePowerShell = Join-Path $fixture 'System32\WindowsPowerShell\v1.0\powershell.exe' + $stdout = Join-Path $env:RUNNER_TEMP 'propr-discovery.stdout' + $stderr = Join-Path $env:RUNNER_TEMP 'propr-discovery.stderr' + try { + New-Item -ItemType Directory -Path $fixture,$stackRoot,$dataRoot | Out-Null + $utf8 = [Text.UTF8Encoding]::new($false) + [IO.File]::WriteAllText($envFile, "PROPR_STACK=authorized`n", $utf8) + [IO.File]::WriteAllText($identityFile, "{`"schemaVersion`":1,`"publicInstanceIdentity`":`"aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa`"}`n", $utf8) + New-Item -ItemType Directory -Path (Split-Path -Parent $fakePowerShell) -Force | Out-Null + [IO.File]::WriteAllBytes($fakePowerShell, [byte[]]@(0x4d, 0x5a)) + $userIdentity = [Security.Principal.NTAccount]::new("$env:COMPUTERNAME\$userName") + $systemIdentity = [Security.Principal.SecurityIdentifier]::new('S-1-5-18') + $adminIdentity = [Security.Principal.SecurityIdentifier]::new('S-1-5-32-544') + function Set-DiscoveryAcl([string]$Path, [bool]$Directory, [Security.Principal.IdentityReference]$Owner) { + $acl = if ($Directory) { [Security.AccessControl.DirectorySecurity]::new() } else { [Security.AccessControl.FileSecurity]::new() } + $acl.SetOwner($Owner) + $acl.SetAccessRuleProtection($true, $false) + foreach ($identity in @($userIdentity, $systemIdentity, $adminIdentity)) { + $rights = [Security.AccessControl.FileSystemRights]::FullControl + $accessType = [Security.AccessControl.AccessControlType]::Allow + $rule = if ($Directory) { + $inheritance = [Security.AccessControl.InheritanceFlags]::ContainerInherit -bor [Security.AccessControl.InheritanceFlags]::ObjectInherit + $propagation = [Security.AccessControl.PropagationFlags]::None + [Security.AccessControl.FileSystemAccessRule]::new($identity, $rights, $inheritance, $propagation, $accessType) + } else { + [Security.AccessControl.FileSystemAccessRule]::new($identity, $rights, $accessType) + } + $acl.AddAccessRule($rule) | Out-Null + } + Set-Acl -LiteralPath $Path -AclObject $acl + } + Set-DiscoveryAcl $fixture $true $adminIdentity + Set-DiscoveryAcl $stackRoot $true $userIdentity + Set-DiscoveryAcl $dataRoot $true $userIdentity + Set-DiscoveryAcl $envFile $false $userIdentity + Set-DiscoveryAcl $identityFile $false $userIdentity + $node = (Get-Command node.exe).Source + $process = Start-Process -FilePath $node -ArgumentList @('scripts/verify-windows-standard-user-connect.mjs', $userName, $fixture) -WorkingDirectory $env:GITHUB_WORKSPACE -Credential $credential -LoadUserProfile -Wait -PassThru -RedirectStandardOutput $stdout -RedirectStandardError $stderr + Get-Content -LiteralPath $stdout + if ($process.ExitCode -ne 0) { + Get-Content -LiteralPath $stderr + throw "ordinary-user discovery proof exited $($process.ExitCode)" + } + if ((Get-Content -Raw -LiteralPath $stderr).Length -ne 0) { throw 'ordinary-user discovery proof wrote stderr' } + } finally { + Remove-Item -LiteralPath $fixture -Recurse -Force -ErrorAction SilentlyContinue + Remove-LocalUser -Name $userName -ErrorAction SilentlyContinue + Remove-Item -LiteralPath $stdout,$stderr -Force -ErrorAction SilentlyContinue + } + + connect-authority-darwin: + name: Connect Discovery and Darwin ACL (Node 22) + runs-on: macos-15 + permissions: + contents: read + steps: + - name: Checkout repository + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + + - name: Set up Node.js 22 + uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6 + with: + node-version: 22 + cache: npm + + - name: Install dependencies + run: npm ci + + - name: Build Connect discovery dependencies + shell: bash + run: | + set -euo pipefail + npm run build -w @propr/shared + npm run build -w @propr/core + npm run build -w @propr/local-setup + npm run typecheck -w @propr/cli + npm run build -w @propr/cli + + - name: Run platform-safe focused Connect suites + shell: bash + run: node scripts/verify-platform-safe-connect.mjs + + - name: Require complete native Connect authority proof + shell: bash + run: node scripts/verify-native-connect-authority.mjs + validate: name: Validate Changes runs-on: ubuntu-latest diff --git a/.github/workflows/pr-test-on-label.yml b/.github/workflows/pr-test-on-label.yml index 6c6fa4165..c9d2684e4 100644 --- a/.github/workflows/pr-test-on-label.yml +++ b/.github/workflows/pr-test-on-label.yml @@ -48,7 +48,12 @@ jobs: - name: Build workspace packages id: build - run: npm run test:prepare + run: | + test ! -e packages/shared/dist + test ! -e packages/client/dist + npm run test:prepare + test -f packages/shared/dist/index.js + test -f packages/client/dist/index.js - name: Validate docs site id: docs diff --git a/Dockerfile b/Dockerfile index 569793640..f6becd490 100644 --- a/Dockerfile +++ b/Dockerfile @@ -34,6 +34,7 @@ RUN apt-get update && apt-get install -y \ # Copy package files (including workspace packages) COPY package*.json ./ COPY packages/shared/package*.json ./packages/shared/ +COPY packages/local-setup/package*.json ./packages/local-setup/ COPY packages/core/package*.json ./packages/core/ COPY packages/api/package*.json ./packages/api/ @@ -44,6 +45,9 @@ COPY . . # Build shared package first (required for @propr/shared imports) RUN cd packages/shared && npm run build +# Build Node-local shared storage helpers used by the API and CLI. +RUN cd packages/local-setup && npm run build + # Build core package (required for @propr/core imports) RUN cd packages/core && npm run build diff --git a/Dockerfile.node b/Dockerfile.node index f56adf480..39736c4f5 100644 --- a/Dockerfile.node +++ b/Dockerfile.node @@ -24,6 +24,7 @@ WORKDIR /usr/src/app # Copy package files (including workspace packages) COPY package*.json ./ COPY packages/shared/package*.json ./packages/shared/ +COPY packages/local-setup/package*.json ./packages/local-setup/ COPY packages/core/package*.json ./packages/core/ COPY packages/api/package*.json ./packages/api/ @@ -36,6 +37,9 @@ COPY . . # Build shared package first (required for @propr/core imports) RUN cd packages/shared && npm run build +# Build Node-local shared storage helpers used by the API and CLI. +RUN cd packages/local-setup && npm run build + # Build core package (required for @propr/core imports) RUN cd packages/core && npm run build diff --git a/apps/desktop/README.md b/apps/desktop/README.md index c33d0488f..c68462b50 100644 --- a/apps/desktop/README.md +++ b/apps/desktop/README.md @@ -22,9 +22,9 @@ npm run make:rpm -w @propr/desktop npm run make:dmg -w @propr/desktop -- --arch=arm64 ``` -Desktop development, typecheck, package, and make commands build required renderer workspace dependencies through -`desktop:prepare`, in dependency order (`@propr/shared` then `@propr/client`). They do not depend on previously -generated workspace `dist` directories. +Desktop development, typecheck, package, and make commands build required renderer workspace dependencies through the +desktop workspace lifecycle, in dependency order (`@propr/shared`, `@propr/local-setup`, `@propr/cli`, then +`@propr/client`). They do not depend on previously generated workspace `dist` directories. Development renderer URLs are accepted only when Electron Forge supplies an HTTP loopback URL. Packaged builds load the generated renderer from the application ASAR through an app-owned protocol. @@ -34,14 +34,22 @@ flag. Its preferred window is 1280x820 with an 880x620 minimum, sourced from one runtime selects the cursor-relevant display with a primary-display fallback and clamps both sizes to that display's work area before native construction. Native evidence requires the actual window to equal that clamped size and derives the viewport from the actual native content bounds. The packaged smoke also constructs a hidden 800x560 -reduced-work-area window and verifies its real native bounds and clamped minimums. It retains the real title-bar logo, -connection-card, control containment, sizing, spacing, and footer checks on smaller responsive work areas. The child -receives only fixed smoke triggers, private profile/temp paths, and strictly validated platform launch inputs; it never -inherits the parent CI environment or `PATH`. The smoke -also rejects main-process uncaught exceptions and requires proof that `window.proprDesktop` is exposed before a clean -exit. `desktop:smoke:inspect` performs executable and fuse inspection without launching a window. Release CI launches -both Linux architectures under Xvfb, inspects macOS and Windows packages on their native runners, validates -DMG/ZIP/DEB/RPM/MSI packages, and validates configured OS signatures. +reduced-work-area window and verifies its real native bounds and clamped minimums. From the packaged custom-protocol +renderer it drives preload IPC, activation-scoped REST and Socket.IO upgrades through Electron session interception, +scope rotation, and same-ID origin editing. It also checks the real welcome-card and connection-control bounds, cookie +omission, both-origin storage cleanup, stale-scope fencing, renderer/main secret custody, uncaught exceptions, and a +clean exit. The child receives only fixed smoke triggers, private profile/temp paths, and strictly validated platform +launch inputs; it never broadly inherits the parent CI environment or `PATH`. `desktop:smoke:inspect` performs +executable and fuse inspection without launching a window. Release CI launches both Linux architectures under Xvfb, +inspects macOS and Windows packages on their native runners, validates DMG/ZIP/DEB/RPM/MSI packages, and validates +configured OS signatures. + +Darwin packaged Connect acceptance first inspects the normal unsigned package, then generates a one-run self-signed +CA:false code-signing leaf in an isolated default keychain and signs only that smoke artifact. The signature uses an +explicit certificate-bound designated requirement that is verified before the pair process and again after the +reprobe process. Chromium creates and reopens its real Safe Storage key in the same disposable keychain; the harness +does not pre-seed or widen access to that item. A signal-aware exit trap restores the runner's original keychain list +and default, deletes the disposable keychain, and removes all temporary signing material. The first-release Windows MVP packages only the normal desktop application. Native self-update installation authority is deferred to issue #2000: no broker, bootstrap, launcher, service, or authority custom action is built, copied into @@ -55,14 +63,26 @@ CI runs both checks directly from the committed lockfile before installing or ex ## Security boundary The renderer has no Node.js integration and receives only the typed `window.proprDesktop` bridge. It exposes metadata, -validated external-browser opening, profiles, encrypted credentials, lifecycle placeholders, and validated deep-link -events. It never exposes a shell, command runner, arbitrary IPC call, or filesystem path/API. +validated profiles, status-only pairing/probe/invalidation operations, lifecycle placeholders, and validated deep-link +events. Pairing, browser approval, credential persistence, authenticated probes, and revocation run in Electron main. +The bridge never exposes a credential value, shell, command runner, arbitrary IPC call, or filesystem path/API. Profile metadata is stored in an app-owned, permission-restricted JSON file. Credential values are encrypted with Electron `safeStorage` before they are written separately. If OS encryption is unavailable—or Linux selects the -`basic_text` backend—the app reports that state and refuses to persist or return credentials; there is no plaintext +`basic_text` backend—the app reports that state and refuses to persist credentials; there is no plaintext fallback. Profiles remain usable because they contain only a display label and validated API endpoint. +Opaque instance tokens and the strict-discovery public identity are bound to profile ID, normalized origin, and +credential generation in encrypted main-process storage. The renderer cannot provide or override the identity. +Launch, profile switch, pairing, revocation, and every Socket.IO reconnect perform credential-free strict discovery; +an absent, malformed, or changed identity sends no stored bearer and requires a fresh pairing generation. Electron's +session request boundary strips renderer-supplied Authorization and Cookie headers from every HTTP(S) and WS(S) +request, including inactive or mismatched profile origins, then injects the active bearer only for matching REST and +Socket.IO requests. Set-Cookie is stripped from remote responses, so the packaged renderer has no parallel cookie +identity. Tokens never enter renderer JavaScript, URLs, logs, localStorage, sessionStorage, or profile metadata. +Switching named profiles clears renderer and instance-origin state. Removing or changing a paired profile first +attempts current-token revocation at the old bound origin, then removes the credential. + `propr://connect` and `propr://open` are the only accepted deep-link actions. A single-instance lock routes later activations to the existing window. Local lifecycle methods intentionally return `not-implemented`; this scaffold does not download, install, start, or execute ProPR runtime components. diff --git a/apps/desktop/forge.config.ts b/apps/desktop/forge.config.ts index 16a29fb1c..363c1df5a 100644 --- a/apps/desktop/forge.config.ts +++ b/apps/desktop/forge.config.ts @@ -4,9 +4,9 @@ import { MakerRpm } from '@electron-forge/maker-rpm'; import { MakerZIP } from '@electron-forge/maker-zip'; import { VitePlugin } from '@electron-forge/plugin-vite'; import { flipFuses, FuseV1Options, FuseVersion } from '@electron/fuses'; -import { readFileSync } from 'node:fs'; +import { chmodSync, copyFileSync, mkdirSync, readFileSync, statSync } from 'node:fs'; import { rm } from 'node:fs/promises'; -import { dirname, resolve } from 'node:path'; +import { basename, dirname, resolve } from 'node:path'; import { fileURLToPath } from 'node:url'; import { readCompleteEnvironmentGroup, @@ -15,8 +15,23 @@ import { resolveDesktopVersion, resolveTrustedUpdateBuildConfig, } from './src/release-config'; + const DESKTOP_EXECUTABLE_NAME = 'propr-desktop'; +const connectNativePrebuilds = fileURLToPath(new URL('../../packages/cli/native/prebuilds', import.meta.url)); +const connectOrchestrator = fileURLToPath(new URL('../../packages/cli/dist/orchestrator', import.meta.url)); + +const packagedConnectNativeArtifacts = (platform: string, arch: string): string[] => { + if (platform === 'darwin' || platform === 'mas') { + return [ + `${platform === 'mas' ? 'darwin' : platform}-${arch}/directory-operations.node`, + `${platform === 'mas' ? 'darwin' : platform}-${arch}/connect-authority-broker`, + ]; + } + if (platform === 'linux') return [`linux-${arch}/directory-operations.node`]; + return []; +}; + const desktopPackage = JSON.parse( readFileSync(fileURLToPath(new URL('./package.json', import.meta.url)), 'utf8'), ) as { version: string }; @@ -73,7 +88,7 @@ const windowsSign = windowsSigning ? { const config: ForgeConfig = { packagerConfig: { - asar: true, + asar: { unpack: '**/.vite/native/prebuilds/**' }, appBundleId: 'dev.propr.desktop', appCategoryType: 'public.app-category.developer-tools', appVersion: releaseVersion, @@ -103,6 +118,18 @@ const config: ForgeConfig = { version: releaseVersion, }), packageAfterCopy: async (_forgeConfig, resourcesPath, _electronVersion, platform, arch) => { + for (const relativeArtifact of packagedConnectNativeArtifacts(platform, arch)) { + const target = resolve(resourcesPath, '.vite/native/prebuilds', relativeArtifact); + mkdirSync(dirname(target), { recursive: true }); + const source = resolve(connectNativePrebuilds, relativeArtifact); + copyFileSync(source, target); + if (platform !== 'win32') chmodSync(target, statSync(source).mode & 0o777); + } + const packagedOrchestrator = resolve(resourcesPath, '.vite/build'); + mkdirSync(packagedOrchestrator, { recursive: true }); + for (const asset of ['orchestrator.mjs', 'manifest.json']) { + copyFileSync(resolve(connectOrchestrator, asset), resolve(packagedOrchestrator, basename(asset))); + } const applePlatform = platform === 'darwin' || platform === 'mas'; const executableName = applePlatform ? 'Electron' : `electron${platform === 'win32' ? '.exe' : ''}`; await flipFuses(resolve(resourcesPath, '..', '..', applePlatform ? 'MacOS' : '', executableName), { diff --git a/apps/desktop/package.json b/apps/desktop/package.json index 840baec49..512483717 100644 --- a/apps/desktop/package.json +++ b/apps/desktop/package.json @@ -6,19 +6,29 @@ "description": "Secure ProPR desktop application", "author": "Unchained Development OÜ / Rinalds Uzkalns", "license": "Apache-2.0", + "dependencies": { + "@propr/cli": "*", + "@propr/client": "*", + "@propr/shared": "*" + }, "homepage": "https://github.com/integry/propr", "type": "module", "main": ".vite/build/main.cjs", "scripts": { - "prepare:renderer": "npm run build -w @propr/shared && npm run build -w @propr/client", + "prepare:renderer": "npm run build -w @propr/shared && npm run build -w @propr/local-setup && npm run build -w @propr/cli && npm run build -w @propr/client", "predev": "npm run prepare:renderer", "dev": "electron-forge start", "pretypecheck": "npm run prepare:renderer", "typecheck": "tsc --noEmit", + "pretest": "npm run prepare:renderer", "test": "tsx --test src/**/*.test.ts scripts/*.test.mjs", + "test:windows-fixture-acl": "node --test scripts/windows-fixture-acl.test.mjs", + "pretest:native-durability": "npm run prepare:renderer", + "test:native-durability": "node scripts/run-native-durability.mjs", "prepackage": "npm run prepare:renderer", "package": "electron-forge package", "smoke:package": "node scripts/smoke-packaged.mjs", + "smoke:connect-package": "node scripts/smoke-packaged-connect.mjs", "smoke:inspect": "node scripts/smoke-packaged.mjs --inspect-only", "premake": "npm run prepare:renderer", "make": "electron-forge make", @@ -42,6 +52,7 @@ "@types/node": "^22.10.0", "@vitejs/plugin-react": "^4.6.0", "electron": "^44.0.0", + "socket.io": "^4.8.1", "tsx": "^4.21.0", "typescript": "^5.9.3", "vite": "^7.3.5" diff --git a/apps/desktop/renderer.html b/apps/desktop/renderer.html index 374512fdf..3ebbceb83 100644 --- a/apps/desktop/renderer.html +++ b/apps/desktop/renderer.html @@ -4,7 +4,7 @@ diff --git a/apps/desktop/scripts/packaged-connect-evidence.mjs b/apps/desktop/scripts/packaged-connect-evidence.mjs new file mode 100644 index 000000000..5d6ab13f5 --- /dev/null +++ b/apps/desktop/scripts/packaged-connect-evidence.mjs @@ -0,0 +1,82 @@ +export const PACKAGED_CONNECT_EVIDENCE_FAILURE_EVENT = 'packaged_connect.journey_evidence_failed'; +export const PACKAGED_CONNECT_EXPECTED_DISCOVERY_COUNT = 10; + +export const PACKAGED_CONNECT_EVIDENCE_FAILURE_CODES = Object.freeze([ + 'DISCOVERY_COUNT_MISMATCH', + 'DISCOVERY_AUTHORIZATION_PRESENT', + 'PAIRING_START_MISSING', + 'PAIRING_START_DUPLICATE', + 'PAIRING_BROWSER_COUNT_MISMATCH', + 'PAIRING_POLL_COUNT_MISMATCH', + 'PAIRING_ACTIVATION_COUNT_MISMATCH', + 'PAIRING_METHOD_MISMATCH', + 'PAIRING_BROWSER_CREDENTIAL_PRESENT', + 'PAIRING_INTENT_SEQUENCE_MISMATCH', + 'PAIRING_LIFECYCLE_ISOLATION_FAILED', + 'PAIRING_REQUEST_AFTER_TERMINAL', + 'DELAYED_APPROVAL_READINESS_MISSING', + 'BOOTSTRAP_AUTHORIZATION_PRESENT', + 'AUTHENTICATED_REST_COUNT_MISMATCH', + 'AUTHENTICATED_SOCKET_COUNT_MISMATCH', + 'REST_SCOPE_MISMATCH', + 'SOCKET_SCOPE_MISSING', + 'SOCKET_SCOPE_BINDING_MISMATCH', + 'SOCKET_SCOPE_ROTATION_MISMATCH', + 'PLAINTEXT_CREDENTIAL_PERSISTED', + 'PUBLIC_IDENTITY_MISSING', + 'PUBLIC_IDENTITY_ORDER_MISMATCH', +]); + +export const collectAcceptedSocketEvidence = ({ requests, authorization }) => { + const authenticatedSockets = requests.filter(request => + request.socketIo === true + && request.accepted === true + && request.authorization === authorization); + const socketScopes = new Set(authenticatedSockets.map(request => request.transportScope)); + return { + authenticatedSocketCount: authenticatedSockets.length, + socketHasNullScope: socketScopes.has(null), + socketScopeBindingMismatch: authenticatedSockets.some(request => + request.socketQueryScopeCount !== 1 || request.socketAuthScope !== request.transportScope), + socketScopeCount: socketScopes.size, + }; +}; + +const failureChecks = Object.freeze([ + // Pair contributes eight discoveries. The fresh reprobe process contributes + // its profile probe plus the mandatory pre-Socket.IO identity gate. + ['DISCOVERY_COUNT_MISMATCH', evidence => + evidence.discoveryCount !== PACKAGED_CONNECT_EXPECTED_DISCOVERY_COUNT], + ['DISCOVERY_AUTHORIZATION_PRESENT', evidence => evidence.discoveryAuthorizationPresent], + ['PAIRING_START_MISSING', evidence => evidence.pairingStartCount < 3], + ['PAIRING_START_DUPLICATE', evidence => evidence.pairingStartCount > 3], + ['PAIRING_BROWSER_COUNT_MISMATCH', evidence => evidence.pairingBrowserCount !== 3], + ['PAIRING_POLL_COUNT_MISMATCH', evidence => evidence.pairingPollCount !== 1], + ['PAIRING_ACTIVATION_COUNT_MISMATCH', evidence => evidence.pairingActivationCount !== 1], + ['PAIRING_METHOD_MISMATCH', evidence => !evidence.pairingMethodBoundaryValid], + ['PAIRING_BROWSER_CREDENTIAL_PRESENT', evidence => evidence.pairingBrowserCredentialPresent], + ['PAIRING_INTENT_SEQUENCE_MISMATCH', evidence => !evidence.pairingIntentSequenceValid], + ['PAIRING_LIFECYCLE_ISOLATION_FAILED', evidence => !evidence.pairingLifecycleIsolated], + ['PAIRING_REQUEST_AFTER_TERMINAL', evidence => evidence.pairingRequestAfterTerminal], + ['DELAYED_APPROVAL_READINESS_MISSING', evidence => !evidence.delayedApprovalReadinessProven], + ['BOOTSTRAP_AUTHORIZATION_PRESENT', evidence => evidence.bootstrapAuthorizationPresent], + ['AUTHENTICATED_REST_COUNT_MISMATCH', evidence => evidence.authenticatedRestCount < 2], + ['AUTHENTICATED_SOCKET_COUNT_MISMATCH', evidence => evidence.authenticatedSocketCount < 2], + ['REST_SCOPE_MISMATCH', evidence => evidence.restScopeCount !== 1 || !evidence.restHasOnlyNullScope], + ['SOCKET_SCOPE_MISSING', evidence => evidence.socketHasNullScope], + ['SOCKET_SCOPE_BINDING_MISMATCH', evidence => evidence.socketScopeBindingMismatch], + ['SOCKET_SCOPE_ROTATION_MISMATCH', evidence => evidence.socketScopeCount < 2], + ['PLAINTEXT_CREDENTIAL_PERSISTED', evidence => evidence.plaintextCredentialPersisted], + ['PUBLIC_IDENTITY_MISSING', evidence => evidence.firstIdentityIndex < 0], + ['PUBLIC_IDENTITY_ORDER_MISMATCH', evidence => evidence.firstBearerIndex <= evidence.firstIdentityIndex], +]); + +/** Return only the first fixed, secret-free failed invariant in protocol order. */ +export const evaluatePackagedConnectEvidence = evidence => { + const failed = failureChecks.find(([, check]) => check(evidence)); + if (!failed) return null; + return { + event: PACKAGED_CONNECT_EVIDENCE_FAILURE_EVENT, + code: failed[0], + }; +}; diff --git a/apps/desktop/scripts/packaged-connect-evidence.test.mjs b/apps/desktop/scripts/packaged-connect-evidence.test.mjs new file mode 100644 index 000000000..3883cf3a7 --- /dev/null +++ b/apps/desktop/scripts/packaged-connect-evidence.test.mjs @@ -0,0 +1,141 @@ +import assert from 'node:assert/strict'; +import { describe, test } from 'node:test'; +import { + collectAcceptedSocketEvidence, + evaluatePackagedConnectEvidence, + PACKAGED_CONNECT_EVIDENCE_FAILURE_CODES, + PACKAGED_CONNECT_EVIDENCE_FAILURE_EVENT, + PACKAGED_CONNECT_EXPECTED_DISCOVERY_COUNT, +} from './packaged-connect-evidence.mjs'; + +const passingEvidence = () => ({ + discoveryCount: PACKAGED_CONNECT_EXPECTED_DISCOVERY_COUNT, + discoveryAuthorizationPresent: false, + pairingStartCount: 3, + pairingBrowserCount: 3, + pairingPollCount: 1, + pairingActivationCount: 1, + pairingMethodBoundaryValid: true, + pairingBrowserCredentialPresent: false, + pairingIntentSequenceValid: true, + pairingLifecycleIsolated: true, + pairingRequestAfterTerminal: false, + delayedApprovalReadinessProven: true, + bootstrapAuthorizationPresent: false, + authenticatedRestCount: 2, + authenticatedSocketCount: 2, + restScopeCount: 1, + restHasOnlyNullScope: true, + socketHasNullScope: false, + socketScopeBindingMismatch: false, + socketScopeCount: 2, + plaintextCredentialPersisted: false, + firstIdentityIndex: 1, + firstBearerIndex: 2, +}); + +const failingEvidence = Object.freeze({ + DISCOVERY_COUNT_MISMATCH: { discoveryCount: 8 }, + DISCOVERY_AUTHORIZATION_PRESENT: { discoveryAuthorizationPresent: true }, + PAIRING_START_MISSING: { pairingStartCount: 2 }, + PAIRING_START_DUPLICATE: { pairingStartCount: 4 }, + PAIRING_BROWSER_COUNT_MISMATCH: { pairingBrowserCount: 2 }, + PAIRING_POLL_COUNT_MISMATCH: { pairingPollCount: 2 }, + PAIRING_ACTIVATION_COUNT_MISMATCH: { pairingActivationCount: 2 }, + PAIRING_METHOD_MISMATCH: { pairingMethodBoundaryValid: false }, + PAIRING_BROWSER_CREDENTIAL_PRESENT: { pairingBrowserCredentialPresent: true }, + PAIRING_INTENT_SEQUENCE_MISMATCH: { pairingIntentSequenceValid: false }, + PAIRING_LIFECYCLE_ISOLATION_FAILED: { pairingLifecycleIsolated: false }, + PAIRING_REQUEST_AFTER_TERMINAL: { pairingRequestAfterTerminal: true }, + DELAYED_APPROVAL_READINESS_MISSING: { delayedApprovalReadinessProven: false }, + BOOTSTRAP_AUTHORIZATION_PRESENT: { bootstrapAuthorizationPresent: true }, + AUTHENTICATED_REST_COUNT_MISMATCH: { authenticatedRestCount: 1 }, + AUTHENTICATED_SOCKET_COUNT_MISMATCH: { authenticatedSocketCount: 1 }, + REST_SCOPE_MISMATCH: { restScopeCount: 2 }, + SOCKET_SCOPE_MISSING: { socketHasNullScope: true }, + SOCKET_SCOPE_BINDING_MISMATCH: { socketScopeBindingMismatch: true }, + SOCKET_SCOPE_ROTATION_MISMATCH: { socketScopeCount: 1 }, + PLAINTEXT_CREDENTIAL_PERSISTED: { plaintextCredentialPersisted: true }, + PUBLIC_IDENTITY_MISSING: { firstIdentityIndex: -1 }, + PUBLIC_IDENTITY_ORDER_MISMATCH: { firstBearerIndex: 1 }, +}); + +describe('packaged Connect aggregate evidence', () => { + test('accepts the complete fixed protocol evidence', () => { + assert.equal(evaluatePackagedConnectEvidence(passingEvidence()), null); + }); + + test('accepts valid rotated Socket.IO bindings alongside the expected stale-auth rejection', () => { + const socketEvidence = collectAcceptedSocketEvidence({ + authorization: 'Bearer fixture-token', + requests: [ + { + socketIo: true, + accepted: true, + authorization: 'Bearer fixture-token', + transportScope: 'scope-before-rotation', + socketQueryScopeCount: 1, + socketAuthScope: 'scope-before-rotation', + }, + { + socketIo: true, + accepted: true, + authorization: 'Bearer fixture-token', + transportScope: 'scope-after-rotation', + socketQueryScopeCount: 1, + socketAuthScope: 'scope-after-rotation', + }, + { + socketIo: true, + accepted: false, + authorization: 'Bearer fixture-token', + transportScope: 'scope-after-rotation', + socketQueryScopeCount: 1, + socketAuthScope: 'scope-before-rotation', + }, + ], + }); + + assert.deepEqual(socketEvidence, { + authenticatedSocketCount: 2, + socketHasNullScope: false, + socketScopeBindingMismatch: false, + socketScopeCount: 2, + }); + assert.equal(evaluatePackagedConnectEvidence({ + ...passingEvidence(), + ...socketEvidence, + }), null); + }); + + test('requires exactly eight pair discoveries and two fresh-process reprobe discoveries', () => { + assert.equal(PACKAGED_CONNECT_EXPECTED_DISCOVERY_COUNT, 10); + for (const discoveryCount of [8, 9, 11]) { + assert.deepEqual( + evaluatePackagedConnectEvidence({ ...passingEvidence(), discoveryCount }), + { + event: PACKAGED_CONNECT_EVIDENCE_FAILURE_EVENT, + code: 'DISCOVERY_COUNT_MISMATCH', + }, + ); + } + }); + + for (const code of PACKAGED_CONNECT_EVIDENCE_FAILURE_CODES) { + test(`reports only fixed evidence for ${code}`, () => { + const record = evaluatePackagedConnectEvidence({ + ...passingEvidence(), + ...failingEvidence[code], + hostileUrl: 'https://private.example.test/path', + hostileToken: 'secret-SENTINEL', + hostileCount: 9_999_999, + }); + assert.deepEqual(record, { + event: PACKAGED_CONNECT_EVIDENCE_FAILURE_EVENT, + code, + }); + assert.deepEqual(Object.keys(record).sort(), ['code', 'event']); + assert.doesNotMatch(JSON.stringify(record), /private|secret|999/u); + }); + } +}); diff --git a/apps/desktop/scripts/packaged-connect-launch.mjs b/apps/desktop/scripts/packaged-connect-launch.mjs new file mode 100644 index 000000000..bf2f16544 --- /dev/null +++ b/apps/desktop/scripts/packaged-connect-launch.mjs @@ -0,0 +1,13 @@ +export const createPackagedConnectLaunchArguments = ({ platform, userDataPath }) => Object.freeze([ + '--disable-gpu', + `--user-data-dir=${userDataPath}`, + ...(platform === 'linux' ? ['--password-store=gnome-libsecret'] : []), +]); + +/** Keep the tested lifecycle argv identical at the real packaged-binary spawn boundary. */ +export const spawnPackagedConnectBinary = ({ + binaryPath, + launchArguments, + options, + spawn, +}) => spawn(binaryPath, launchArguments, options); diff --git a/apps/desktop/scripts/packaged-connect-launch.test.mjs b/apps/desktop/scripts/packaged-connect-launch.test.mjs new file mode 100644 index 000000000..35fec5ec0 --- /dev/null +++ b/apps/desktop/scripts/packaged-connect-launch.test.mjs @@ -0,0 +1,55 @@ +import assert from 'node:assert/strict'; +import { readFile } from 'node:fs/promises'; +import { describe, test } from 'node:test'; +import { + createPackagedConnectLaunchArguments, + spawnPackagedConnectBinary, +} from './packaged-connect-launch.mjs'; + +describe('packaged Connect launch boundary', () => { + test('passes the one effective Linux argv through the actual binary spawn', () => { + const launchArguments = createPackagedConnectLaunchArguments({ + platform: 'linux', + userDataPath: '/tmp/propr-connect-smoke', + }); + let invocation; + const child = {}; + assert.equal(spawnPackagedConnectBinary({ + binaryPath: '/package/propr-desktop', + launchArguments, + options: { shell: false }, + spawn: (file, args, options) => { + invocation = { file, args, options }; + return child; + }, + }), child); + assert.deepEqual(invocation, { + file: '/package/propr-desktop', + args: [ + '--disable-gpu', + '--user-data-dir=/tmp/propr-connect-smoke', + '--password-store=gnome-libsecret', + ], + options: { shell: false }, + }); + assert.equal(invocation.args, launchArguments); + }); + + test('does not add the Linux password-store selection on Darwin', () => { + assert.deepEqual(createPackagedConnectLaunchArguments({ + platform: 'darwin', + userDataPath: '/tmp/propr-connect-smoke', + }), [ + '--disable-gpu', + '--user-data-dir=/tmp/propr-connect-smoke', + ]); + }); + + test('the lifecycle and real binary spawn share the derived argv source', async () => { + const source = await readFile(new URL('./smoke-packaged-connect.mjs', import.meta.url), 'utf8'); + assert.match(source, /const launchArguments = createPackagedConnectLaunchArguments\(\{/u); + assert.match(source, /spawnPackagedConnectBinary\(\{[\s\S]*?launchArguments: args,/u); + assert.match(source, /runPackagedConnectLifecycle\(\{[\s\S]*?args: launchArguments,/u); + assert.doesNotMatch(source, /spawn\(binaryPath, \['--disable-gpu'/u); + }); +}); diff --git a/apps/desktop/scripts/packaged-connect-lifecycle.mjs b/apps/desktop/scripts/packaged-connect-lifecycle.mjs new file mode 100644 index 000000000..77ca73c10 --- /dev/null +++ b/apps/desktop/scripts/packaged-connect-lifecycle.mjs @@ -0,0 +1,883 @@ +import { spawn as nodeSpawn } from 'node:child_process'; +import { lstat, realpath, rm } from 'node:fs/promises'; +import { basename, dirname, isAbsolute, relative } from 'node:path'; +import { TextDecoder } from 'node:util'; +import { fileURLToPath } from 'node:url'; + +export const CONNECT_READY_EVENT = 'desktop.renderer.connect_discovery.ready'; +export const CONNECT_DISCOVERY_MILESTONE_EVENT = 'desktop.renderer.connect_discovery.milestone'; +export const CONNECT_JOURNEY_STAGE_EVENT = 'desktop.renderer.connect_journey.stage'; +export const CONNECT_JOURNEY_FAILURE_EVENT = 'desktop.renderer.connect_journey.failure'; +export const CONNECT_NETWORK_PERMISSION_EVENT = 'desktop.renderer.connect_network_permission'; +export const CONNECT_JOURNEY_OPERATION_EVENT = 'desktop.renderer.connect_journey.operation'; +export const CONNECT_RENDERER_OWNERSHIP_EVENT = 'desktop.renderer.connect_request_ownership'; +export const CHILD_CAPTURE_MAX_BYTES = 64 * 1024; +export const CHILD_DIAGNOSTIC_MAX_RECORDS = 20; + +const RECORD_MAX_BYTES = 8 * 1024; +const RECORD_MAX_COUNT = 128; +const WINDOWS_PID_MAX = 0xffff_ffff; +const FIXTURE_LEAF_PATTERN = /^propr-desktop-connect-smoke-[A-Za-z0-9]{6}$/u; +const ISOLATED_CLEANUP_ARGUMENT = '--internal-isolated-connect-fixture-cleanup'; +const MODULE_PATH = fileURLToPath(import.meta.url); +const isIsolatedCleanupProcess = process.argv[1] === MODULE_PATH + && process.argv[2] === ISOLATED_CLEANUP_ARGUMENT; + +const diagnosticEvents = new Set([ + 'desktop.app.ready', + 'desktop.app.start_failed', + 'desktop.log.write_failed', + 'desktop.main_process.uncaught_exception', + CONNECT_READY_EVENT, + CONNECT_DISCOVERY_MILESTONE_EVENT, + CONNECT_JOURNEY_STAGE_EVENT, + CONNECT_JOURNEY_FAILURE_EVENT, + CONNECT_NETWORK_PERMISSION_EVENT, + CONNECT_JOURNEY_OPERATION_EVENT, + CONNECT_RENDERER_OWNERSHIP_EVENT, + 'desktop.renderer.connect_discovery.phase', + 'desktop.renderer.connect_discovery.status', + 'desktop.renderer.gone', + 'desktop.renderer.ready', +]); +const diagnosticCodes = new Set([ + 'CONNECT_STATUS_INCOMPATIBLE', + 'CONNECT_STATUS_INTERNAL_FAILURE', + 'CONNECT_STATUS_INVALID_CONFIG', + 'CONNECT_STATUS_NOT_READY', + 'CONNECT_STATUS_READY', + 'CONNECT_STATUS_TIMEOUT', + 'DETAIL_REDACTED', + 'LOG_WRITE_FAILED', + 'OPERATION_FAILED', + 'UNCAUGHT_EXCEPTION', +]); +const journeyStageCodes = new Set([ + 'JOURNEY_DISCOVERY_RENDERER', + 'JOURNEY_DISCOVERY_VALIDATED', + 'JOURNEY_STORAGE_BACKEND', + 'JOURNEY_NEGATIVE_MALFORMED', + 'JOURNEY_NEGATIVE_OVERSIZED', + 'JOURNEY_NEGATIVE_EXPIRY', + 'JOURNEY_NEGATIVE_CANCEL', + 'JOURNEY_NEGATIVE_STATE', + 'JOURNEY_PAIR_MANUAL_FORM', + 'JOURNEY_PAIR_BROWSER_APPROVAL', + 'JOURNEY_PAIR_ACTIVATION_DASHBOARD', + 'JOURNEY_PAIR_AUTHENTICATION_REQUIRED', + 'JOURNEY_PAIR_CREDENTIAL_COMMITTED', + 'JOURNEY_PAIR_AUTHENTICATED_REPROBE_READY', + 'JOURNEY_PAIR_ACTIVATION_COMMITTED', + 'JOURNEY_PAIR_ACTIVATION_PUBLISHED', + 'JOURNEY_PAIR_REACT_CONNECTED', + 'JOURNEY_PAIR_TRANSPORT', + 'JOURNEY_PAIR_COMPLETE', + 'JOURNEY_REPROBE_ACTIVATION_DASHBOARD', + 'JOURNEY_REPROBE_AUTHENTICATED_REPROBE_READY', + 'JOURNEY_REPROBE_ACTIVATION_COMMITTED', + 'JOURNEY_REPROBE_ACTIVATION_PUBLISHED', + 'JOURNEY_REPROBE_REACT_CONNECTED', + 'JOURNEY_REPROBE_TRANSPORT', + 'JOURNEY_REPROBE_COMPLETE', +]); +const journeyFailurePhases = new Set(['pair', 'reprobe']); +const journeyFailureReasons = new Set([ + 'APPROVAL_REJECTED', + 'JOURNEY_FAILED', + 'RENDERER_STAGE_TIMEOUT', + 'RENDERER_STATE_TIMEOUT', + 'TRANSPORT_EVIDENCE_TIMEOUT', +]); +const diagnosticPhases = new Set([ + 'config-read', + 'addon-integrity-type', + 'addon-load', + 'descriptor-operation', + 'authority-inspection', + 'status-resolution', +]); +const diagnosticPhaseCodes = new Set(['STARTED', 'PASSED', 'FAILED']); +const diagnosticSubsteps = new Set(['directory-open', 'addon-open', 'fstat-type']); +const diagnosticCategories = new Set([ + 'access-denied', + 'invalid-argument', + 'io-failure', + 'missing-entry', + 'not-directory', + 'symlink-refused', + 'type-mismatch', + 'unexpected', +]); +const networkPermissionCategories = new Set([ + 'local-network-access', + 'local-network', + 'loopback-network', +]); +const networkPermissionDecisions = new Set(['check', 'request']); +const networkPermissionBooleanFields = [ + 'activeBindingCurrent', + 'webContentsPresent', + 'webContentsEqualsMainWindow', + 'mainWindowPresent', + 'isMainFrame', + 'requestingUrlPresent', + 'requestingUrlTrusted', + 'rendererDocumentUrlTrusted', + 'requestingOriginAuthorityValid', + 'requestingOriginAuthorityEqual', +]; +const journeyOperations = new Set(['PROFILE_SAVE', 'PAIR', 'PROBE', 'ACTIVATE']); +const journeyOperationStatuses = new Set([ + 'COMPLETED', 'READY', 'AUTHENTICATION_REQUIRED', 'INCOMPATIBLE', 'OFFLINE', 'REJECTED', +]); +const rendererOwnershipResourceCategories = new Set(['xhr', 'webSocket', 'other']); +const rendererOwnershipBooleanFields = [ + 'mainRendererPresent', + 'mainRendererLive', + 'webContentsIdMatches', + 'webContentsAbsentOrMatches', + 'mainFrameLive', + 'rendererDocumentTrusted', + 'rendererDocumentAuthorityEqual', + 'frameOmitted', + 'framePresent', + 'frameMatchesMainFrame', + 'frameExplicitlyForeign', + 'rendererOwned', +]; + +const boundedNetworkPermissionEvidence = record => { + if (record.schemaVersion !== 1 + || !networkPermissionCategories.has(record.permissionCategory) + || !networkPermissionDecisions.has(record.decision) + || typeof record.allowed !== 'boolean' + || networkPermissionBooleanFields.some(field => typeof record[field] !== 'boolean')) return {}; + return { + schemaVersion: 1, + permissionCategory: record.permissionCategory, + decision: record.decision, + allowed: record.allowed, + ...Object.fromEntries(networkPermissionBooleanFields.map(field => [field, record[field]])), + }; +}; + +const boundedJourneyOperationEvidence = record => { + if (!journeyOperations.has(record.operation) || !journeyOperationStatuses.has(record.status)) return {}; + return { operation: record.operation, status: record.status }; +}; + +const boundedRendererOwnershipEvidence = record => { + if (record.schemaVersion !== 1 + || !rendererOwnershipResourceCategories.has(record.resourceCategory) + || rendererOwnershipBooleanFields.some(field => typeof record[field] !== 'boolean')) return {}; + return { + schemaVersion: 1, + resourceCategory: record.resourceCategory, + ...Object.fromEntries(rendererOwnershipBooleanFields.map(field => [field, record[field]])), + }; +}; + +export const boundedChildDiagnostics = records => { + const diagnostics = records.flatMap(record => { + if (!record || typeof record !== 'object' || !diagnosticEvents.has(record.event)) return []; + if (record.event === CONNECT_NETWORK_PERMISSION_EVENT) { + return [{ event: record.event, ...boundedNetworkPermissionEvidence(record) }]; + } + if (record.event === CONNECT_JOURNEY_OPERATION_EVENT) { + return [{ event: record.event, ...boundedJourneyOperationEvidence(record) }]; + } + if (record.event === CONNECT_JOURNEY_FAILURE_EVENT) { + return [{ + event: record.event, + ...(journeyFailurePhases.has(record.phase) + && (record.stage === 'JOURNEY_NOT_STARTED' || journeyStageCodes.has(record.stage)) + && journeyFailureReasons.has(record.reason) + ? { phase: record.phase, stage: record.stage, reason: record.reason } + : {}), + }]; + } + if (record.event === CONNECT_RENDERER_OWNERSHIP_EVENT) { + return [{ event: record.event, ...boundedRendererOwnershipEvidence(record) }]; + } + const nestedCode = record.error && typeof record.error === 'object' ? record.error.code : undefined; + const candidateCode = typeof record.code === 'string' ? record.code : nestedCode; + const phase = typeof record.phase === 'string' ? record.phase : undefined; + const substep = typeof record.substep === 'string' ? record.substep : undefined; + const category = typeof record.category === 'string' ? record.category : undefined; + return [{ + event: record.event, + ...(journeyStageCodes.has(candidateCode) + && (record.event === CONNECT_DISCOVERY_MILESTONE_EVENT + || record.event === CONNECT_JOURNEY_STAGE_EVENT) + ? { + code: candidateCode, + ...(candidateCode === 'JOURNEY_STORAGE_BACKEND' + && (record.storageBackend === 'gnome_libsecret' + || record.storageBackend === 'os-protected') + ? { storageBackend: record.storageBackend } + : {}), + } + : diagnosticPhases.has(phase) && diagnosticPhaseCodes.has(candidateCode) + ? { + phase, + code: candidateCode, + ...(candidateCode === 'FAILED' && diagnosticSubsteps.has(substep) ? { substep } : {}), + ...(candidateCode === 'FAILED' && diagnosticCategories.has(category) ? { category } : {}), + } + : diagnosticCodes.has(candidateCode) ? { code: candidateCode } : {}), + }]; + }); + const bounded = diagnostics.slice(0, CHILD_DIAGNOSTIC_MAX_RECORDS); + if (diagnostics.length > CHILD_DIAGNOSTIC_MAX_RECORDS) { + const latestCriticalEvidence = [ + diagnostics.findLast(record => record.event === CONNECT_JOURNEY_OPERATION_EVENT), + diagnostics.findLast(record => record.event === CONNECT_RENDERER_OWNERSHIP_EVENT), + diagnostics.findLast(record => typeof record.code === 'string' + && (record.event === CONNECT_DISCOVERY_MILESTONE_EVENT + || record.event === CONNECT_JOURNEY_STAGE_EVENT)), + diagnostics.findLast(record => record.event === CONNECT_JOURNEY_FAILURE_EVENT), + ].filter(Boolean); + const withoutLatestCriticalEvidence = bounded.filter(record => !latestCriticalEvidence.includes(record)); + return withoutLatestCriticalEvidence + .slice(0, CHILD_DIAGNOSTIC_MAX_RECORDS - latestCriticalEvidence.length) + .concat(latestCriticalEvidence); + } + return bounded; +}; + +const exactKeys = (record, expected) => { + const actual = Object.keys(record).sort(); + return actual.length === expected.length && actual.every((key, index) => key === expected[index]); +}; + +export const isExactReadyRecord = (record, { platform, arch, authorityMechanism }) => { + if (!record || typeof record !== 'object' || Array.isArray(record)) return false; + if (!exactKeys(record, [ + 'authorityMechanism', 'event', 'level', 'rendererSchemaValid', + 'selectedArch', 'selectedPlatform', 'timestamp', + ])) return false; + return record.event === CONNECT_READY_EVENT + && record.level === 'info' + && typeof record.timestamp === 'string' + && /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/u.test(record.timestamp) + && record.selectedPlatform === platform + && record.selectedArch === arch + && record.authorityMechanism === authorityMechanism + && record.rendererSchemaValid === true; +}; + +const createRecordCapture = ({ sensitiveNeedles, onRecord, onSensitiveOutput }) => { + let capturedBytes = 0; + let captureTruncated = false; + let recordCount = 0; + let sensitiveOutput = false; + const streams = new Map(); + const endedStreams = new Set(); + const normalizedNeedles = sensitiveNeedles.filter(value => typeof value === 'string' && value.length > 0); + const maximumNeedleLength = Math.max(1, ...normalizedNeedles.map(value => value.length)); + const reportSensitiveOutput = () => { + if (sensitiveOutput) return; + sensitiveOutput = true; + onSensitiveOutput(); + }; + + const parsedContentIsSensitive = parsed => { + const pending = [parsed]; + while (pending.length > 0) { + const value = pending.pop(); + if (typeof value === 'string') { + if (normalizedNeedles.some(needle => value.includes(needle))) return true; + } else if (Array.isArray(value)) { + pending.push(...value); + } else if (value && typeof value === 'object') { + for (const [key, nested] of Object.entries(value)) pending.push(key, nested); + } + } + return false; + }; + + const streamState = name => { + if (!streams.has(name)) streams.set(name, { + decoder: new TextDecoder('utf-8', { fatal: false }), + line: '', + lineBytes: 0, + discardingLine: false, + scanTail: '', + }); + return streams.get(name); + }; + + const inspectLine = line => { + const framed = line.endsWith('\r') ? line.slice(0, -1) : line; + if (!framed || recordCount >= RECORD_MAX_COUNT) { + if (recordCount >= RECORD_MAX_COUNT) captureTruncated = true; + return; + } + let record; + try { record = JSON.parse(framed); } catch { return; } + // JSON escaping can hide a decoded path (notably Windows backslashes) from + // the raw stream scan, so inspect every bounded parsed string before the + // record can contribute either readiness or diagnostics. + if (parsedContentIsSensitive(record)) reportSensitiveOutput(); + if (!record || typeof record !== 'object' || Array.isArray(record)) return; + recordCount += 1; + onRecord(record); + }; + + const scan = (state, text) => { + const candidate = `${state.scanTail}${text}`; + if (normalizedNeedles.some(needle => candidate.includes(needle))) reportSensitiveOutput(); + state.scanTail = maximumNeedleLength > 1 ? candidate.slice(-(maximumNeedleLength - 1)) : ''; + }; + + const write = (name, chunk) => { + const state = streamState(name); + const bytes = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk); + const remaining = Math.max(0, CHILD_CAPTURE_MAX_BYTES - capturedBytes); + const accepted = bytes.subarray(0, remaining); + capturedBytes += accepted.byteLength; + if (accepted.byteLength < bytes.byteLength) captureTruncated = true; + + // Secret detection continues with a constant-size tail even after structured capture is full. + scan(state, state.decoder.decode(bytes, { stream: true })); + if (accepted.byteLength === 0) return; + const text = new TextDecoder('utf-8', { fatal: false }).decode(accepted); + for (const character of text) { + if (character === '\n') { + if (!state.discardingLine) inspectLine(state.line); + state.line = ''; + state.lineBytes = 0; + state.discardingLine = false; + continue; + } + state.lineBytes += Buffer.byteLength(character, 'utf8'); + if (state.lineBytes > RECORD_MAX_BYTES) { + state.line = ''; + state.discardingLine = true; + captureTruncated = true; + } else if (!state.discardingLine) { + state.line += character; + } + } + }; + + const end = name => { + if (endedStreams.has(name)) return; + endedStreams.add(name); + const state = streamState(name); + scan(state, state.decoder.decode()); + if (state.line || state.discardingLine) captureTruncated = true; + state.line = ''; + state.discardingLine = false; + }; + + return { + write, + end, + finish: () => { + end('stdout'); + end('stderr'); + }, + result: () => ({ + capture: captureTruncated ? 'truncated' : 'complete', + sensitiveOutput, + }), + }; +}; + +const deferred = () => { + let resolvePromise; + const promise = new Promise(resolve => { resolvePromise = resolve; }); + return { promise, resolve: resolvePromise }; +}; + +const boundedDelay = milliseconds => new Promise(resolveDelay => { + setTimeout(resolveDelay, milliseconds); +}); + +const withTimeout = (promise, milliseconds) => new Promise(resolveBounded => { + let settled = false; + const finish = result => { + if (settled) return; + settled = true; + clearTimeout(timer); + resolveBounded(result); + }; + const timer = setTimeout(() => finish({ timedOut: true }), milliseconds); + promise.then(value => finish({ timedOut: false, value }), () => finish({ timedOut: false })); +}); + +const validPid = pid => Number.isSafeInteger(pid) && pid > 0 && pid <= WINDOWS_PID_MAX; + +const waitForClose = (child, milliseconds) => { + if (child.exitCode !== null || child.signalCode !== null) { + return Promise.resolve({ closed: true, code: child.exitCode, signal: child.signalCode }); + } + return new Promise(resolveWait => { + let finished = false; + const finish = result => { + if (finished) return; + finished = true; + clearTimeout(timer); + child.removeListener('close', onClose); + resolveWait(result); + }; + const onClose = (code, signal) => finish({ closed: true, code, signal }); + const timer = setTimeout(() => finish({ closed: false }), milliseconds); + child.once('close', onClose); + }); +}; + +const drainStream = (stream, milliseconds) => { + if (!stream || stream.destroyed || stream.readableEnded) return Promise.resolve(true); + return new Promise(resolveDrain => { + let finished = false; + const finish = value => { + if (finished) return; + finished = true; + clearTimeout(timer); + stream.removeListener('end', onDrain); + stream.removeListener('close', onDrain); + resolveDrain(value); + }; + const onDrain = () => finish(true); + const timer = setTimeout(() => finish(false), milliseconds); + stream.once('end', onDrain); + stream.once('close', onDrain); + }); +}; + +const drainChildStreams = async (child, milliseconds) => { + const drained = await Promise.all([ + drainStream(child.stdout, milliseconds), + drainStream(child.stderr, milliseconds), + ]); + return drained.every(Boolean); +}; + +const runWindowsTreeKiller = async ({ spawn, treeKillerPath, pid, timeoutMs }) => { + if (typeof treeKillerPath !== 'string' || !isAbsolute(treeKillerPath) || !validPid(pid)) return false; + let killer; + try { + killer = spawn(treeKillerPath, ['/PID', String(pid), '/T', '/F'], { + shell: false, + windowsHide: true, + stdio: ['ignore', 'pipe', 'pipe'], + }); + } catch { return false; } + let captured = 0; + const discard = chunk => { captured = Math.min(CHILD_CAPTURE_MAX_BYTES, captured + chunk.length); }; + killer.stdout?.on('data', discard); + killer.stderr?.on('data', discard); + const closePromise = new Promise(resolveKiller => { + killer.once('error', () => resolveKiller({ ok: false })); + killer.once('close', (code, signal) => resolveKiller({ ok: code === 0 && signal === null })); + }); + const boundedClose = await withTimeout(closePromise, timeoutMs); + if (boundedClose.timedOut) { + try { killer.kill('SIGKILL'); } catch { /* The bounded helper has already failed. */ } + const finalDrainBound = Math.min(1_000, timeoutMs); + await Promise.all([ + withTimeout(closePromise, finalDrainBound), + drainStream(killer.stdout, finalDrainBound), + drainStream(killer.stderr, finalDrainBound), + ]); + killer.stdout?.destroy(); + killer.stderr?.destroy(); + killer.unref?.(); + return false; + } + const streamsDrained = await Promise.all([ + drainStream(killer.stdout, timeoutMs), + drainStream(killer.stderr, timeoutMs), + ]); + return boundedClose.value?.ok === true && streamsDrained.every(Boolean); +}; + +const terminateOwnedProcess = async ({ child, platform, spawn, treeKillerPath, timeoutMs }) => { + if (!validPid(child.pid)) return false; + if (platform === 'win32') { + const treeKilled = await runWindowsTreeKiller({ spawn, treeKillerPath, pid: child.pid, timeoutMs }); + if (!treeKilled) { + // This cannot prove descendant termination, but it prevents a failed helper from + // leaving the directly owned Electron process alive while the fixed failure is reported. + try { child.kill('SIGKILL'); } catch { /* Preserve the tree-termination result. */ } + } + return treeKilled; + } + try { return child.kill('SIGKILL'); } catch { return false; } +}; + +const closeIsClean = close => close?.closed && close.code === 0 && close.signal === null; + +/** + * Own one packaged app from spawn through proof, shutdown, tree termination, and stream drain. + * The returned object contains only fixed categories and allowlisted child diagnostics. + */ +export const runPackagedConnectLifecycle = async ({ + binaryPath, + args, + env, + cwd, + platform, + arch, + authorityMechanism, + expectedStorageBackend, + sensitiveNeedles = [], + treeKillerPath, + spawn = nodeSpawn, + readyTimeoutMs = 240_000, + shutdownGraceMs = 5_000, + terminationTimeoutMs = 10_000, + streamDrainTimeoutMs = 5_000, + requestShutdown = () => undefined, +}) => { + const records = []; + const first = deferred(); + let firstSettled = false; + let invalidReadyObserved = false; + let reportedStorageBackend; + let child; + const settleFirst = value => { + if (firstSettled) return; + firstSettled = true; + first.resolve(value); + }; + const capture = createRecordCapture({ + sensitiveNeedles, + onSensitiveOutput: () => settleFirst({ category: 'output-rejected' }), + onRecord: record => { + if (records.length < RECORD_MAX_COUNT) records.push(record); + if (record.event === CONNECT_JOURNEY_STAGE_EVENT + && record.code === 'JOURNEY_STORAGE_BACKEND') { + reportedStorageBackend = record.storageBackend; + } + if (record.event !== CONNECT_READY_EVENT) return; + const valid = isExactReadyRecord(record, { platform, arch, authorityMechanism }) + && (expectedStorageBackend === undefined + || reportedStorageBackend === expectedStorageBackend); + if (!valid) invalidReadyObserved = true; + settleFirst(valid ? { category: 'ready' } : { category: 'ready-validation' }); + }, + }); + + try { + child = spawn(binaryPath, args, { + cwd, + env, + shell: false, + windowsHide: true, + stdio: ['ignore', 'pipe', 'pipe'], + }); + } catch { + return { ok: false, category: 'spawn-error', capture: 'complete', records: [] }; + } + + child.stdout?.on('data', chunk => capture.write('stdout', chunk)); + child.stderr?.on('data', chunk => capture.write('stderr', chunk)); + child.stdout?.once('end', () => capture.end('stdout')); + child.stderr?.once('end', () => capture.end('stderr')); + child.once('error', () => settleFirst({ category: 'spawn-error' })); + child.once('close', (code, signal) => settleFirst({ category: 'child-exit', close: { closed: true, code, signal } })); + + const readyTimer = setTimeout(() => settleFirst({ category: 'timeout-before-ready' }), readyTimeoutMs); + const trigger = await first.promise; + clearTimeout(readyTimer); + + let primary = trigger.category; + let close = trigger.close; + let terminationAttempted = false; + let terminationSucceeded = false; + let streamsDrained = false; + + if (primary === 'ready') { + try { requestShutdown(child); } catch { /* The app also self-requests quit after logging proof. */ } + close = await waitForClose(child, shutdownGraceMs); + if (closeIsClean(close)) { + primary = 'ready-clean-exit'; + } else if (close.closed) { + primary = 'child-exit-after-ready'; + } else { + terminationAttempted = true; + terminationSucceeded = await terminateOwnedProcess({ + child, platform, spawn, treeKillerPath, timeoutMs: terminationTimeoutMs, + }); + close = await waitForClose(child, streamDrainTimeoutMs); + streamsDrained = await drainChildStreams(child, streamDrainTimeoutMs); + primary = closeIsClean(close) && streamsDrained + ? 'ready-clean-exit' + : terminationSucceeded && close.closed && streamsDrained + ? 'ready-forced-exit' + : 'tree-termination'; + } + } else if (primary === 'child-exit') { + primary = 'child-exit-before-ready'; + } else { + const alreadyClosed = child.exitCode !== null || child.signalCode !== null; + if (!alreadyClosed && validPid(child.pid)) { + terminationAttempted = true; + terminationSucceeded = await terminateOwnedProcess({ + child, platform, spawn, treeKillerPath, timeoutMs: terminationTimeoutMs, + }); + } + close = await waitForClose(child, streamDrainTimeoutMs); + } + + if (!streamsDrained) streamsDrained = await drainChildStreams(child, streamDrainTimeoutMs); + capture.finish(); + const captureResult = capture.result(); + if (primary === 'ready-clean-exit' || primary === 'ready-forced-exit') { + if (captureResult.sensitiveOutput || captureResult.capture === 'truncated') { + primary = 'output-rejected'; + } else if (invalidReadyObserved) primary = 'ready-validation'; + } + const secondary = []; + if (terminationAttempted && !terminationSucceeded && primary !== 'ready-clean-exit') { + secondary.push('tree-termination-failed'); + } + if (!close?.closed) secondary.push('child-close-unconfirmed'); + if (!streamsDrained) secondary.push('stream-drain-failed'); + if (!close?.closed || !streamsDrained) { + child.stdout?.destroy(); + child.stderr?.destroy(); + child.unref?.(); + } + return { + ok: primary === 'ready-clean-exit' || primary === 'ready-forced-exit', + category: primary, + capture: captureResult.capture, + records: boundedChildDiagnostics(records), + ...(secondary.length ? { secondary } : {}), + }; +}; + +const createCleanupPhaseDeadline = milliseconds => { + let timedOut = false; + let timer; + const timeout = new Promise(resolveTimeout => { + timer = setTimeout(() => { + timedOut = true; + resolveTimeout({ status: 'timed-out' }); + }, Math.max(0, milliseconds)); + }); + return { + run: operation => { + if (timedOut) return Promise.resolve({ status: 'timed-out' }); + let pending; + try { pending = operation(); } catch (error) { + return Promise.resolve({ status: 'rejected', error }); + } + return Promise.race([ + Promise.resolve(pending).then( + value => ({ status: 'fulfilled', value }), + error => ({ status: 'rejected', error }), + ), + timeout, + ]); + }, + dispose: () => clearTimeout(timer), + }; +}; + +const fixtureIdentityIsAuthorized = async ({ + fixture, + canonicalTemporaryParent, + generatedLeaf, + lstatImpl, + realpathImpl, + runBeforeDeadline, +}) => { + if (typeof fixture !== 'string' || typeof canonicalTemporaryParent !== 'string' + || typeof generatedLeaf !== 'string' || !FIXTURE_LEAF_PATTERN.test(generatedLeaf) + || basename(fixture) !== generatedLeaf || dirname(fixture) !== canonicalTemporaryParent + || relative(canonicalTemporaryParent, fixture) !== generatedLeaf) return { authorized: false }; + const fixtureStats = await runBeforeDeadline(() => lstatImpl(fixture)); + if (fixtureStats.status === 'timed-out') return { timedOut: true }; + if (fixtureStats.status === 'rejected') { + return { authorized: fixtureStats.error?.code === 'ENOENT' }; + } + const identity = await Promise.all([ + runBeforeDeadline(() => realpathImpl(canonicalTemporaryParent)), + runBeforeDeadline(() => realpathImpl(fixture)), + runBeforeDeadline(() => lstatImpl(canonicalTemporaryParent)), + ]); + if (identity.some(result => result.status === 'timed-out')) return { timedOut: true }; + if (identity.some(result => result.status === 'rejected')) return { authorized: false }; + const [parentPath, fixturePath, parentStats] = identity.map(result => result.value); + const stats = fixtureStats.value; + try { + return { + authorized: parentPath === canonicalTemporaryParent + && fixturePath === fixture + && parentStats.isDirectory() + && !parentStats.isSymbolicLink() + && stats.isDirectory() + && !stats.isSymbolicLink(), + }; + } catch { return { authorized: false }; } +}; + +const isolatedCleanupResult = async ({ + fixture, + canonicalTemporaryParent, + generatedLeaf, + retryBoundMs, + retryDelayMs, + phase, +}) => { + if (!isAbsolute(process.execPath)) return { ok: false, category: 'fixture-cleanup-failed' }; + let child; + try { + child = nodeSpawn(process.execPath, [MODULE_PATH, ISOLATED_CLEANUP_ARGUMENT], { + shell: false, + windowsHide: true, + stdio: ['pipe', 'pipe', 'pipe'], + }); + } catch { return { ok: false, category: 'fixture-cleanup-failed' }; } + let stdout = ''; + let stdoutOverflow = false; + child.stdout.on('data', chunk => { + if (stdoutOverflow) return; + stdout += chunk.toString('utf8'); + if (Buffer.byteLength(stdout, 'utf8') > RECORD_MAX_BYTES) { + stdout = ''; + stdoutOverflow = true; + } + }); + child.stderr.on('data', () => undefined); + child.stdin.on('error', () => undefined); + const close = new Promise(resolveClose => { + let settled = false; + const finish = result => { + if (settled) return; + settled = true; + resolveClose(result); + }; + child.once('error', () => finish({ closed: false })); + child.once('close', (code, signal) => finish({ closed: true, code, signal })); + }); + child.stdin.end(JSON.stringify({ + fixture, canonicalTemporaryParent, generatedLeaf, retryBoundMs, retryDelayMs, + })); + const boundedClose = await phase.run(() => close); + if (boundedClose.status !== 'fulfilled' || !boundedClose.value.closed + || boundedClose.value.code !== 0 || boundedClose.value.signal !== null || stdoutOverflow) { + try { child.kill('SIGKILL'); } catch { /* The fixed cleanup failure is already selected. */ } + child.stdin.destroy(); + child.stdout.destroy(); + child.stderr.destroy(); + child.unref(); + return { ok: false, category: 'fixture-cleanup-failed' }; + } + try { + const result = JSON.parse(stdout); + const keys = Object.keys(result).sort(); + if (result.ok === true && keys.length === 1 && keys[0] === 'ok') return result; + if (result.ok === false && keys.length === 2 && keys[0] === 'category' && keys[1] === 'ok' + && ['fixture-cleanup-authorization-failed', 'fixture-cleanup-failed'].includes(result.category)) { + return result; + } + } catch { /* Return only the fixed failure below. */ } + return { ok: false, category: 'fixture-cleanup-failed' }; +}; + +export const removeAuthorizedConnectFixture = async ({ + fixture, + canonicalTemporaryParent, + generatedLeaf = basename(fixture), + platform = process.platform, + retryBoundMs = 10_000, + retryDelayMs = 100, + lstatImpl = lstat, + realpathImpl = realpath, + rmImpl = rm, +}) => { + const phase = createCleanupPhaseDeadline(retryBoundMs); + try { + if (platform === 'win32' && !isIsolatedCleanupProcess + && lstatImpl === lstat && realpathImpl === realpath && rmImpl === rm) { + return await isolatedCleanupResult({ + fixture, canonicalTemporaryParent, generatedLeaf, retryBoundMs, retryDelayMs, phase, + }); + } + const authorize = () => fixtureIdentityIsAuthorized({ + fixture, canonicalTemporaryParent, generatedLeaf, lstatImpl, realpathImpl, + runBeforeDeadline: phase.run, + }); + const initialAuthorization = await authorize(); + if (initialAuthorization.timedOut) { + return { ok: false, category: 'fixture-cleanup-failed' }; + } + if (!initialAuthorization.authorized) { + return { ok: false, category: 'fixture-cleanup-authorization-failed' }; + } + while (true) { + const removal = await phase.run(() => rmImpl(fixture, { + recursive: true, force: true, maxRetries: 0, + })); + if (removal.status === 'fulfilled') return { ok: true }; + if (removal.status === 'timed-out') { + return { ok: false, category: 'fixture-cleanup-failed' }; + } + const retryable = platform === 'win32' + && ['EBUSY', 'ENOTEMPTY', 'EPERM'].includes(removal.error?.code); + if (!retryable) return { ok: false, category: 'fixture-cleanup-failed' }; + const delay = await phase.run(() => boundedDelay(retryDelayMs)); + if (delay.status !== 'fulfilled') return { ok: false, category: 'fixture-cleanup-failed' }; + const retryAuthorization = await authorize(); + if (retryAuthorization.timedOut) { + return { ok: false, category: 'fixture-cleanup-failed' }; + } + if (!retryAuthorization.authorized) { + return { ok: false, category: 'fixture-cleanup-authorization-failed' }; + } + } + } finally { + phase.dispose(); + } +}; + +export const preservePrimaryWithCleanup = (outcome, cleanup) => cleanup.ok ? outcome : ({ + ...outcome, + secondary: [...new Set([...(outcome.secondary ?? []), cleanup.category])], +}); + +export const createIdempotentJourneyFixtureClose = ({ + closeSocketServer, + closeHttpServer, +}) => { + let closePromise; + return () => { + closePromise ??= (async () => { + await closeSocketServer(); + try { + await closeHttpServer(); + } catch (error) { + if (error?.code !== 'ERR_SERVER_NOT_RUNNING') throw error; + } + })(); + return closePromise; + }; +}; + +if (isIsolatedCleanupProcess) { + let input = ''; + try { + for await (const chunk of process.stdin) { + input += chunk; + if (Buffer.byteLength(input, 'utf8') > RECORD_MAX_BYTES) throw new Error('invalid cleanup input'); + } + const options = JSON.parse(input); + const result = await removeAuthorizedConnectFixture({ + fixture: options.fixture, + canonicalTemporaryParent: options.canonicalTemporaryParent, + generatedLeaf: options.generatedLeaf, + platform: 'win32', + retryBoundMs: options.retryBoundMs, + retryDelayMs: options.retryDelayMs, + }); + process.stdout.write(JSON.stringify(result)); + } catch { + process.stdout.write(JSON.stringify({ ok: false, category: 'fixture-cleanup-failed' })); + } +} diff --git a/apps/desktop/scripts/packaged-connect-lifecycle.test.mjs b/apps/desktop/scripts/packaged-connect-lifecycle.test.mjs new file mode 100644 index 000000000..8754d7261 --- /dev/null +++ b/apps/desktop/scripts/packaged-connect-lifecycle.test.mjs @@ -0,0 +1,828 @@ +import assert from 'node:assert/strict'; +import { EventEmitter } from 'node:events'; +import { lstat, mkdtemp, readFile, realpath, rm } from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import { PassThrough } from 'node:stream'; +import { describe, test } from 'node:test'; +import { + CHILD_CAPTURE_MAX_BYTES, + CONNECT_DISCOVERY_MILESTONE_EVENT, + CONNECT_JOURNEY_FAILURE_EVENT, + CONNECT_JOURNEY_STAGE_EVENT, + CONNECT_JOURNEY_OPERATION_EVENT, + CONNECT_NETWORK_PERMISSION_EVENT, + CONNECT_RENDERER_OWNERSHIP_EVENT, + CONNECT_READY_EVENT, + createIdempotentJourneyFixtureClose, + isExactReadyRecord, + preservePrimaryWithCleanup, + removeAuthorizedConnectFixture, + runPackagedConnectLifecycle, +} from './packaged-connect-lifecycle.mjs'; + +const expected = Object.freeze({ + platform: 'win32', + arch: 'x64', + authorityMechanism: 'inherited-standard-handle', +}); +const privateWindowsPath = String.raw`C:\Users\private-user\private-path-SENTINEL`; + +const readyRecord = (overrides = {}) => ({ + timestamp: '2026-09-01T22:00:00.000Z', + level: 'info', + event: CONNECT_READY_EVENT, + selectedPlatform: expected.platform, + selectedArch: expected.arch, + authorityMechanism: expected.authorityMechanism, + rendererSchemaValid: true, + ...overrides, +}); + +class FakeChild extends EventEmitter { + constructor(pid = 4242) { + super(); + this.pid = pid; + this.exitCode = null; + this.signalCode = null; + this.stdout = new PassThrough(); + this.stderr = new PassThrough(); + } + + write(record, stream = this.stdout) { + stream.write(typeof record === 'string' ? record : `${JSON.stringify(record)}\n`); + } + + close(code = 0, signal = null) { + if (this.exitCode !== null || this.signalCode !== null) return; + this.exitCode = code; + this.signalCode = signal; + this.stdout.end(); + this.stderr.end(); + queueMicrotask(() => this.emit('close', code, signal)); + } + + kill() { + this.close(null, 'SIGKILL'); + return true; + } +} + +const run = ({ app = new FakeChild(), onApp, onKiller, ...options } = {}) => { + const invocations = []; + const spawn = (file, args, spawnOptions) => { + invocations.push({ file, args, options: spawnOptions }); + if (file === '/system/taskkill.exe') { + const killer = new FakeChild(4343); + queueMicrotask(() => onKiller?.(killer, app)); + return killer; + } + queueMicrotask(() => onApp?.(app)); + return app; + }; + return runPackagedConnectLifecycle({ + binaryPath: '/package/propr-desktop.exe', + args: ['--disable-gpu'], + env: {}, + ...expected, + sensitiveNeedles: ['secret-SENTINEL', '/private/path-SENTINEL', privateWindowsPath], + treeKillerPath: '/system/taskkill.exe', + spawn, + readyTimeoutMs: 15, + shutdownGraceMs: 5, + terminationTimeoutMs: 5, + streamDrainTimeoutMs: 5, + ...options, + }).then(result => ({ result, invocations })); +}; + +describe('packaged Connect bounded child lifecycle', () => { + test('requires exact three starts, three browser approvals, one poll, and one activation', async () => { + const harness = await readFile(new URL('./smoke-packaged-connect.mjs', import.meta.url), 'utf8'); + const accounting = harness.slice( + harness.indexOf('const evidenceFailure = evaluatePackagedConnectEvidence'), + harness.indexOf('if (evidenceFailure)'), + ); + assert.match(accounting, /pairingStartCount: pairingStarts\.length/u); + assert.match(accounting, /pairingBrowserCount: pairingBrowsers\.length/u); + assert.match(accounting, /pairingPollCount: pairingPolls\.length/u); + assert.match(accounting, /pairingActivationCount: pairingActivations\.length/u); + + const evaluator = await readFile(new URL('./packaged-connect-evidence.mjs', import.meta.url), 'utf8'); + assert.match(evaluator, /evidence\.pairingStartCount < 3/u); + assert.match(evaluator, /evidence\.pairingStartCount > 3/u); + assert.match(evaluator, /evidence\.pairingBrowserCount !== 3/u); + assert.match(evaluator, /evidence\.pairingPollCount !== 1/u); + assert.match(evaluator, /evidence\.pairingActivationCount !== 1/u); + assert.match(harness, /request\.method === 'POST'[\s\S]*?request\.url === '\/api\/desktop\/pairings'/u); + assert.match(harness, /request\.method === 'GET'[\s\S]*?\/\\\/browser\$\//u); + assert.match(harness, /pairingBrowserCredentialPresent: pairingBrowsers\.some/u); + assert.doesNotMatch(evaluator, /pairingPollCount < 3/u); + assert.match(harness, /const approvalReadinessDelayMs = process\.platform === 'darwin' \? 300 : 0/u); + assert.match(harness, /pairingIntentSequenceValid: hasExactModes\(pairingStarts\) && hasExactModes\(pairingBrowsers\)/u); + assert.match(harness, /pairingRequestAfterTerminal: bootstrap\.length !== pairingRequestCountAtPairTerminal/u); + assert.match(harness, /delayedApprovalReadinessProven: process\.platform !== 'darwin'/u); + }); + + test('accepts an exact ready proof followed by a clean exit', async () => { + const { result, invocations } = await run({ + onApp: app => { + app.write(readyRecord()); + queueMicrotask(() => app.close(0, null)); + }, + }); + assert.deepEqual(result, { + ok: true, + category: 'ready-clean-exit', + capture: 'complete', + records: [{ event: CONNECT_READY_EVENT }], + }); + assert.equal(invocations.length, 1); + }); + + test('requires and preserves the expected fixed storage-backend report before readiness', async () => { + const accepted = await run({ + expectedStorageBackend: 'os-protected', + onApp: app => { + app.write({ + event: CONNECT_JOURNEY_STAGE_EVENT, + code: 'JOURNEY_STORAGE_BACKEND', + storageBackend: 'os-protected', + }); + app.write(readyRecord()); + queueMicrotask(() => app.close(0, null)); + }, + }); + assert.equal(accepted.result.ok, true); + assert.deepEqual(accepted.result.records, [ + { + event: CONNECT_JOURNEY_STAGE_EVENT, + code: 'JOURNEY_STORAGE_BACKEND', + storageBackend: 'os-protected', + }, + { event: CONNECT_READY_EVENT }, + ]); + + for (const storageBackend of [undefined, 'gnome_libsecret']) { + const rejected = await run({ + expectedStorageBackend: 'os-protected', + onApp: app => { + if (storageBackend) { + app.write({ + event: CONNECT_JOURNEY_STAGE_EVENT, + code: 'JOURNEY_STORAGE_BACKEND', + storageBackend, + }); + } + app.write(readyRecord()); + queueMicrotask(() => app.close(0, null)); + }, + }); + assert.equal(rejected.result.ok, false); + assert.equal(rejected.result.category, 'ready-validation'); + } + }); + + test('does not accept an intermediate discovery milestone as terminal readiness', async () => { + const { result } = await run({ + onApp: app => { + app.write({ + event: CONNECT_DISCOVERY_MILESTONE_EVENT, + code: 'JOURNEY_DISCOVERY_VALIDATED', + ignored: 'bounded-extra-field', + }); + app.close(0, null); + }, + }); + assert.deepEqual(result, { + ok: false, + category: 'child-exit-before-ready', + capture: 'complete', + records: [{ + event: CONNECT_DISCOVERY_MILESTONE_EVENT, + code: 'JOURNEY_DISCOVERY_VALIDATED', + }], + }); + }); + + test('returns only exact allowlisted journey stages', async () => { + const { result } = await run({ + onApp: app => { + app.write({ + event: CONNECT_JOURNEY_STAGE_EVENT, + code: 'JOURNEY_PAIR_TRANSPORT', + url: 'https://not-returned.example.test/private', + }); + app.write({ event: CONNECT_JOURNEY_STAGE_EVENT, code: 'UNBOUNDED_STAGE' }); + app.write({ + event: CONNECT_JOURNEY_OPERATION_EVENT, + operation: 'PROBE', + status: 'AUTHENTICATION_REQUIRED', + error: 'not-returned', + }); + app.write({ + event: CONNECT_RENDERER_OWNERSHIP_EVENT, + schemaVersion: 1, + resourceCategory: 'xhr', + mainRendererPresent: true, + mainRendererLive: true, + webContentsIdMatches: true, + webContentsAbsentOrMatches: true, + mainFrameLive: true, + rendererDocumentTrusted: true, + rendererDocumentAuthorityEqual: true, + frameOmitted: true, + framePresent: false, + frameMatchesMainFrame: false, + frameExplicitlyForeign: false, + rendererOwned: false, + url: 'not-returned', + }); + app.close(0, null); + }, + }); + assert.equal(result.category, 'child-exit-before-ready'); + assert.deepEqual(result.records, [ + { event: CONNECT_JOURNEY_STAGE_EVENT, code: 'JOURNEY_PAIR_TRANSPORT' }, + { event: CONNECT_JOURNEY_STAGE_EVENT }, + { + event: CONNECT_JOURNEY_OPERATION_EVENT, + operation: 'PROBE', + status: 'AUTHENTICATION_REQUIRED', + }, + { + event: CONNECT_RENDERER_OWNERSHIP_EVENT, + schemaVersion: 1, + resourceCategory: 'xhr', + mainRendererPresent: true, + mainRendererLive: true, + webContentsIdMatches: true, + webContentsAbsentOrMatches: true, + mainFrameLive: true, + rendererDocumentTrusted: true, + rendererDocumentAuthorityEqual: true, + frameOmitted: true, + framePresent: false, + frameMatchesMainFrame: false, + frameExplicitlyForeign: false, + rendererOwned: false, + }, + ]); + assert.doesNotMatch(JSON.stringify(result), /not-returned|UNBOUNDED_STAGE|url|error/u); + }); + + test('retains the latest bounded journey stage when earlier diagnostics fill the cap', async () => { + const { result } = await run({ + onApp: app => { + for (let index = 0; index < 20; index += 1) { + app.write({ event: 'desktop.app.ready', code: 'DETAIL_REDACTED' }); + } + app.write({ + event: CONNECT_JOURNEY_OPERATION_EVENT, + operation: 'ACTIVATE', + status: 'REJECTED', + error: 'not-returned', + }); + app.write({ event: CONNECT_JOURNEY_STAGE_EVENT, code: 'JOURNEY_PAIR_ACTIVATION_DASHBOARD' }); + app.close(0, null); + }, + }); + assert.equal(result.records.length, 20); + assert.deepEqual(result.records.at(-2), { + event: CONNECT_JOURNEY_OPERATION_EVENT, + operation: 'ACTIVATE', + status: 'REJECTED', + }); + assert.deepEqual(result.records.at(-1), { + event: CONNECT_JOURNEY_STAGE_EVENT, + code: 'JOURNEY_PAIR_ACTIVATION_DASHBOARD', + }); + assert.doesNotMatch(JSON.stringify(result), /not-returned/u); + }); + + test('retains only fixed terminal journey failure evidence when diagnostics fill the cap', async () => { + const { result } = await run({ + onApp: app => { + for (let index = 0; index < 20; index += 1) { + app.write({ event: 'desktop.app.ready', code: 'DETAIL_REDACTED' }); + } + app.write({ + event: CONNECT_JOURNEY_FAILURE_EVENT, + phase: 'pair', + stage: 'JOURNEY_PAIR_REACT_CONNECTED', + reason: 'RENDERER_STATE_TIMEOUT', + error: 'secret-SENTINEL', + url: 'https://not-returned.example.test/private', + responseBody: 'not-returned', + token: 'not-returned', + path: privateWindowsPath, + environment: 'not-returned', + }); + app.write({ event: 'desktop.app.start_failed', error: 'secret-SENTINEL' }); + app.close(1, null); + }, + }); + assert.equal(result.records.length, 20); + assert.deepEqual(result.records.at(-1), { + event: CONNECT_JOURNEY_FAILURE_EVENT, + phase: 'pair', + stage: 'JOURNEY_PAIR_REACT_CONNECTED', + reason: 'RENDERER_STATE_TIMEOUT', + }); + assert.doesNotMatch( + JSON.stringify(result), + /secret-SENTINEL|not-returned|private-user|url|responseBody|token|path|environment/u, + ); + }); + + test('drops non-allowlisted terminal journey failure fields', async () => { + const { result } = await run({ + onApp: app => { + app.write({ + event: CONNECT_JOURNEY_FAILURE_EVENT, + phase: 'hostile-phase', + stage: 'HOSTILE_STAGE', + reason: 'hostile-reason', + error: 'secret-SENTINEL', + }); + app.close(1, null); + }, + }); + assert.deepEqual(result.records, [{ event: CONNECT_JOURNEY_FAILURE_EVENT }]); + assert.doesNotMatch(JSON.stringify(result), /hostile|secret-SENTINEL/u); + }); + + test('returns only fixed secret-free Local Network Access decision evidence', async () => { + const fixed = { + event: CONNECT_NETWORK_PERMISSION_EVENT, + schemaVersion: 1, + permissionCategory: 'loopback-network', + decision: 'request', + allowed: true, + activeBindingCurrent: true, + webContentsPresent: true, + webContentsEqualsMainWindow: true, + mainWindowPresent: true, + isMainFrame: true, + requestingUrlPresent: true, + requestingUrlTrusted: true, + rendererDocumentUrlTrusted: true, + requestingOriginAuthorityValid: true, + requestingOriginAuthorityEqual: true, + }; + const { result } = await run({ + onApp: app => { + app.write({ ...fixed, url: 'not-returned' }); + app.write({ ...fixed, permissionCategory: 'notifications', requestingUrl: 'not-returned' }); + app.close(0, null); + }, + }); + assert.deepEqual(result.records, [ + fixed, + { event: CONNECT_NETWORK_PERMISSION_EVENT }, + ]); + assert.doesNotMatch(JSON.stringify(result), /not-returned|"url":|"requestingUrl":/u); + }); + + test('fails closed when an otherwise allowlisted journey stage contains a secret', async () => { + const { result } = await run({ + onApp: app => { + app.write({ + event: CONNECT_JOURNEY_STAGE_EVENT, + code: 'JOURNEY_REPROBE_TRANSPORT', + detail: 'secret-SENTINEL', + }); + app.close(0, null); + }, + }); + assert.equal(result.category, 'output-rejected'); + assert.deepEqual(result.records, [{ + event: CONNECT_JOURNEY_STAGE_EVENT, + code: 'JOURNEY_REPROBE_TRANSPORT', + }]); + assert.doesNotMatch(JSON.stringify(result), /SENTINEL|detail/u); + }); + + test('publishes the sole terminal READY only after each real journey phase', async () => { + const main = await readFile(new URL('../src/main.ts', import.meta.url), 'utf8'); + assert.equal((main.match(/'desktop\.renderer\.connect_discovery\.ready'/gu) ?? []).length, 1); + const connectBranch = main.slice( + main.indexOf('if (connectSmoke) {'), + main.indexOf('} else if (transportSmoke)'), + ); + const discovery = connectBranch.indexOf('await runPackagedConnectDiscoverySmoke'); + const journey = connectBranch.indexOf('await runPackagedConnectJourneySmoke'); + const ready = connectBranch.indexOf('await publishPackagedConnectReady'); + assert.ok(discovery >= 0 && discovery < journey && journey < ready); + + const harness = await readFile(new URL('./smoke-packaged-connect.mjs', import.meta.url), 'utf8'); + const pair = harness.indexOf("outcome = await runPhase('pair')"); + const reprobe = harness.indexOf("outcome = await runPhase('reprobe')"); + const persistedEvidence = harness.indexOf('const applicationRequests = journeyFixture.requests'); + assert.ok(pair >= 0 && pair < reprobe && reprobe < persistedEvidence); + + const manual = main.indexOf("'JOURNEY_PAIR_MANUAL_FORM'"); + const browser = main.indexOf("reportPackagedConnectJourneyStage('JOURNEY_PAIR_BROWSER_APPROVAL')"); + const credential = main.indexOf("'JOURNEY_PAIR_CREDENTIAL_COMMITTED'"); + const reprobeReady = main.indexOf("'JOURNEY_PAIR_AUTHENTICATED_REPROBE_READY'"); + const activation = main.indexOf("'JOURNEY_PAIR_ACTIVATION_COMMITTED'"); + const publication = main.indexOf("'JOURNEY_PAIR_ACTIVATION_PUBLISHED'"); + const react = main.indexOf("'JOURNEY_PAIR_REACT_CONNECTED'"); + assert.ok(manual >= 0 && browser >= 0 && credential >= 0 && reprobeReady >= 0 + && activation >= 0 && publication >= 0 && react >= 0); + assert.match(main, /await stages\.waitFor\('CREDENTIAL_COMMITTED'\)[\s\S]*?await stages\.waitFor\('AUTHENTICATED_REPROBE_READY'\)[\s\S]*?await stages\.waitFor\('ACTIVATION_COMMITTED'\)[\s\S]*?await stages\.waitFor\('ACTIVATION_PUBLISHED'\)[\s\S]*?await stages\.waitFor\('REACT_CONNECTED'\)/u); + assert.match(main, /Packaged pairing expiry classification failed[\s\S]*?await waitForApprovalIdle\(\)[\s\S]*?JOURNEY_NEGATIVE_CANCEL[\s\S]*?const approvalReady = waitForNextApproval\(\)[\s\S]*?await approvalReady[\s\S]*?Packaged pairing cancellation classification failed[\s\S]*?await waitForApprovalIdle\(\)/u); + assert.match(main, /await waitForApprovalIdle\(\);\s+reportPackagedConnectJourneyStage\(phase === 'pair'\s+\? 'JOURNEY_PAIR_COMPLETE'/u); + assert.match(main, /if \(packagedSmokeTest && !transportSmoke && !connectJourney\)/u); + assert.match(main, /if \(packagedSmokeTest && !connectJourney\) \{/u); + assert.doesNotMatch(main, /JOURNEY_PAIR_RENDERER|JOURNEY_REPROBE_RENDERER/u); + }); + + test('forces a ready app with a hung descendant through an exact bounded taskkill invocation', async () => { + const { result, invocations } = await run({ + onApp: app => app.write(readyRecord()), + onKiller: (killer, app) => { + app.close(null, 'SIGKILL'); + killer.close(0, null); + }, + }); + assert.equal(result.ok, true); + assert.equal(result.category, 'ready-forced-exit'); + assert.equal(invocations.length, 2); + assert.deepEqual(invocations[1].args, ['/PID', '4242', '/T', '/F']); + assert.equal(invocations[1].options.shell, false); + }); + + test('keeps timeout-before-ready primary while terminating and draining the tree', async () => { + const { result } = await run({ + onKiller: (killer, app) => { + app.close(null, 'SIGKILL'); + killer.close(0, null); + }, + }); + assert.equal(result.ok, false); + assert.equal(result.category, 'timeout-before-ready'); + assert.equal(result.secondary, undefined); + }); + + test('classifies asynchronous spawn errors without exposing their message', async () => { + const app = new FakeChild(undefined); + const { result } = await run({ + app, + onApp: child => { + child.emit('error', new Error('/private/path-SENTINEL secret-SENTINEL')); + child.close(null, null); + }, + }); + assert.equal(result.category, 'spawn-error'); + assert.doesNotMatch(JSON.stringify(result), /private|SENTINEL/u); + }); + + test('settles close/timeout races once and never upgrades an early exit to success', async () => { + const { result } = await run({ + readyTimeoutMs: 0, + onApp: app => app.close(0, null), + onKiller: (killer, app) => { + app.close(null, 'SIGKILL'); + killer.close(0, null); + }, + }); + assert.ok(['timeout-before-ready', 'child-exit-before-ready'].includes(result.category)); + assert.equal(result.ok, false); + }); + + test('accepts a clean post-proof close racing a taskkill no-process result', async () => { + const { result } = await run({ + onApp: app => app.write(readyRecord()), + onKiller: (killer, app) => { + app.close(0, null); + killer.close(128, null); + }, + }); + assert.deepEqual(result, { + ok: true, + category: 'ready-clean-exit', + capture: 'complete', + records: [{ event: CONNECT_READY_EVENT }], + }); + }); + + test('rejects malformed, partial, truncated, and extra-field ready records', async () => { + assert.equal(isExactReadyRecord(readyRecord(), expected), true); + for (const invalid of [ + readyRecord({ selectedArch: 'arm64' }), + readyRecord({ rendererSchemaValid: 'true' }), + readyRecord({ secret: 'secret-SENTINEL' }), + ]) assert.equal(isExactReadyRecord(invalid, expected), false); + + const { result } = await run({ + onApp: app => { + app.write(`${JSON.stringify(readyRecord()).slice(0, -2)}\n`); + app.write(`${'x'.repeat(70 * 1024)}\n`); + app.close(0, null); + }, + }); + assert.equal(result.ok, false); + assert.equal(result.category, 'child-exit-before-ready'); + assert.equal(result.capture, 'truncated'); + }); + + test('terminates an exact-event record whose platform proof is invalid', async () => { + const { result } = await run({ + onApp: app => app.write(readyRecord({ selectedPlatform: 'linux' })), + onKiller: (killer, app) => { + app.close(null, 'SIGKILL'); + killer.close(0, null); + }, + }); + assert.equal(result.ok, false); + assert.equal(result.category, 'ready-validation'); + assert.deepEqual(result.records, [{ event: CONNECT_READY_EVENT }]); + }); + + test('fails after proof when Windows tree termination cannot be proven', async () => { + const { result } = await run({ + onApp: app => app.write(readyRecord()), + onKiller: killer => killer.close(1, null), + }); + assert.equal(result.ok, false); + assert.equal(result.category, 'tree-termination'); + assert.deepEqual(result.secondary, ['tree-termination-failed']); + }); + + test('never returns secret-bearing raw output or non-allowlisted record fields', async () => { + const { result } = await run({ + onApp: app => app.write(JSON.stringify({ + event: 'desktop.app.start_failed', + error: { code: 'OPERATION_FAILED', message: '/private/path-SENTINEL secret-SENTINEL' }, + }) + '\n'), + onKiller: (killer, app) => { + app.close(null, 'SIGKILL'); + killer.close(0, null); + }, + }); + assert.equal(result.category, 'output-rejected'); + assert.deepEqual(result.records, [{ event: 'desktop.app.start_failed', code: 'OPERATION_FAILED' }]); + assert.doesNotMatch(JSON.stringify(result), /private|SENTINEL|message/u); + }); + + test('revokes success when sensitive output arrives after the exact ready proof', async () => { + const { result } = await run({ + onApp: app => { + app.write(readyRecord()); + queueMicrotask(() => { + app.write('late secret-SENTINEL\n'); + app.close(0, null); + }); + }, + }); + assert.equal(result.ok, false); + assert.equal(result.category, 'output-rejected'); + assert.doesNotMatch(JSON.stringify(result), /SENTINEL/u); + }); + + test('rejects a JSON-escaped Windows path in a non-allowlisted record before readiness', async () => { + const encoded = JSON.stringify({ event: 'untrusted.event', detail: { path: privateWindowsPath } }); + assert.equal(encoded.includes(privateWindowsPath), false); + const { result } = await run({ + onApp: app => { + app.write(`${encoded}\n`); + app.write(readyRecord()); + }, + onKiller: (killer, app) => { + app.close(null, 'SIGKILL'); + killer.close(0, null); + }, + }); + assert.equal(result.ok, false); + assert.equal(result.category, 'output-rejected'); + assert.deepEqual(result.records, [{ event: CONNECT_READY_EVENT }]); + assert.doesNotMatch(JSON.stringify(result), /private-user|private-path-SENTINEL/u); + }); + + test('revokes success for a JSON-escaped Windows path after the exact ready proof', async () => { + const { result } = await run({ + onApp: app => { + app.write(readyRecord()); + queueMicrotask(() => { + app.write({ event: 'untrusted.event', detail: { path: privateWindowsPath } }); + app.close(0, null); + }); + }, + }); + assert.equal(result.ok, false); + assert.equal(result.category, 'output-rejected'); + assert.deepEqual(result.records, [{ event: CONNECT_READY_EVENT }]); + assert.doesNotMatch(JSON.stringify(result), /private-user|private-path-SENTINEL/u); + }); + + test('revokes success when a JSON-escaped Windows path follows the record-count cap', async () => { + const encodedSensitiveRecord = JSON.stringify({ + event: 'untrusted.event', detail: { path: privateWindowsPath }, + }); + assert.equal(encodedSensitiveRecord.includes(privateWindowsPath), false); + const { result } = await run({ + onApp: app => { + app.write(readyRecord()); + queueMicrotask(() => { + for (let index = 1; index < 128; index += 1) { + app.write({ event: 'untrusted.event', index }); + } + app.write(`${encodedSensitiveRecord}\n`); + app.close(0, null); + }); + }, + }); + assert.equal(result.ok, false); + assert.equal(result.category, 'output-rejected'); + assert.equal(result.capture, 'truncated'); + assert.deepEqual(result.records, [{ event: CONNECT_READY_EVENT }]); + assert.doesNotMatch(JSON.stringify(result), /private-user|private-path-SENTINEL/u); + }); + + test('revokes success when a JSON-escaped Windows path follows the byte cap', async () => { + const encodedSensitiveRecord = JSON.stringify({ + event: 'untrusted.event', detail: { path: privateWindowsPath }, + }); + assert.equal(encodedSensitiveRecord.includes(privateWindowsPath), false); + const benignRecord = `${JSON.stringify({ + event: 'untrusted.event', detail: 'x'.repeat(7 * 1024), + })}\n`; + const recordsToExceedBudget = Math.ceil( + CHILD_CAPTURE_MAX_BYTES / Buffer.byteLength(benignRecord), + ) + 1; + const { result } = await run({ + onApp: app => { + app.write(readyRecord()); + queueMicrotask(() => { + app.write(benignRecord.repeat(recordsToExceedBudget)); + app.write(`${encodedSensitiveRecord}\n`); + app.close(0, null); + }); + }, + }); + assert.equal(result.ok, false); + assert.equal(result.category, 'output-rejected'); + assert.equal(result.capture, 'truncated'); + assert.deepEqual(result.records, [{ event: CONNECT_READY_EVENT }]); + assert.doesNotMatch(JSON.stringify(result), /private-user|private-path-SENTINEL/u); + }); +}); + +describe('packaged Connect fixture cleanup', () => { + const fixture = '/canonical-temp/propr-desktop-connect-smoke-AbC123'; + const stats = { isDirectory: () => true, isSymbolicLink: () => false }; + const identityOptions = { + fixture, + canonicalTemporaryParent: '/canonical-temp', + generatedLeaf: 'propr-desktop-connect-smoke-AbC123', + platform: 'win32', + retryBoundMs: 20, + retryDelayMs: 1, + lstatImpl: async () => stats, + realpathImpl: async value => value, + }; + const settlesWithin = async (promise, milliseconds = 250) => { + let timer; + try { + return await Promise.race([ + promise, + new Promise((resolve, reject) => { + timer = setTimeout(() => reject(new Error('cleanup exceeded its test bound')), milliseconds); + }), + ]); + } finally { + clearTimeout(timer); + } + }; + + test('closes the journey fixture once and tolerates only the already-stopped server condition', async () => { + let socketCloses = 0; + let httpCloses = 0; + const close = createIdempotentJourneyFixtureClose({ + closeSocketServer: async () => { socketCloses += 1; }, + closeHttpServer: async () => { + httpCloses += 1; + throw Object.assign(new Error('server already stopped'), { code: 'ERR_SERVER_NOT_RUNNING' }); + }, + }); + const first = close(); + const second = close(); + assert.equal(first, second); + await Promise.all([first, second, close()]); + assert.equal(socketCloses, 1); + assert.equal(httpCloses, 1); + + const failure = createIdempotentJourneyFixtureClose({ + closeSocketServer: async () => undefined, + closeHttpServer: async () => { + throw Object.assign(new Error('/private/path-SENTINEL'), { code: 'EIO' }); + }, + }); + await assert.rejects(failure(), { code: 'EIO' }); + assert.equal(failure(), failure()); + }); + + test('retries a transient Windows EBUSY only inside the authorized fixture', async () => { + let attempts = 0; + const result = await removeAuthorizedConnectFixture({ + ...identityOptions, + rmImpl: async removed => { + assert.equal(removed, fixture); + attempts += 1; + if (attempts === 1) throw Object.assign(new Error('busy private path'), { code: 'EBUSY' }); + }, + }); + assert.deepEqual(result, { ok: true }); + assert.equal(attempts, 2); + }); + + test('redacts cleanup failure and preserves the primary lifecycle outcome', async () => { + const cleanup = await removeAuthorizedConnectFixture({ + ...identityOptions, + retryBoundMs: 0, + rmImpl: async () => { throw Object.assign(new Error('/private/path-SENTINEL'), { code: 'EBUSY' }); }, + }); + const combined = preservePrimaryWithCleanup({ + ok: false, + category: 'timeout-before-ready', + capture: 'complete', + records: [], + }, cleanup); + assert.equal(combined.category, 'timeout-before-ready'); + assert.deepEqual(combined.secondary, ['fixture-cleanup-failed']); + assert.doesNotMatch(JSON.stringify(combined), /private|SENTINEL/u); + }); + + test('bounds a never-settling removal and preserves the primary result', async () => { + const cleanup = await settlesWithin(removeAuthorizedConnectFixture({ + ...identityOptions, + retryBoundMs: 10, + rmImpl: () => new Promise(() => {}), + })); + assert.deepEqual(cleanup, { ok: false, category: 'fixture-cleanup-failed' }); + const primary = { + ok: false, + category: 'timeout-before-ready', + capture: 'complete', + records: [], + }; + assert.deepEqual(preservePrimaryWithCleanup(primary, cleanup), { + ...primary, + secondary: ['fixture-cleanup-failed'], + }); + }); + + test('bounds a never-settling authorization call as a fixed cleanup failure', async () => { + let removalAttempted = false; + const cleanup = await settlesWithin(removeAuthorizedConnectFixture({ + ...identityOptions, + retryBoundMs: 10, + lstatImpl: () => new Promise(() => {}), + rmImpl: async () => { removalAttempted = true; }, + })); + assert.deepEqual(cleanup, { ok: false, category: 'fixture-cleanup-failed' }); + assert.equal(removalAttempted, false); + const primary = { ok: false, category: 'spawn-error', capture: 'complete', records: [] }; + assert.deepEqual(preservePrimaryWithCleanup(primary, cleanup), { + ...primary, + secondary: ['fixture-cleanup-failed'], + }); + }); + + test('isolates default Windows filesystem cleanup from the harness process', async () => { + const canonicalTemporaryParent = await realpath(tmpdir()); + const isolatedFixture = await mkdtemp(join( + canonicalTemporaryParent, 'propr-desktop-connect-smoke-', + )); + try { + const cleanup = await removeAuthorizedConnectFixture({ + fixture: isolatedFixture, + canonicalTemporaryParent, + platform: 'win32', + retryBoundMs: 2_000, + }); + assert.deepEqual(cleanup, { ok: true }); + await assert.rejects(lstat(isolatedFixture), { code: 'ENOENT' }); + } finally { + await rm(isolatedFixture, { recursive: true, force: true }); + } + }); + + test('refuses a link, renamed leaf, or fixture outside the canonical temporary parent', async () => { + for (const options of [ + { fixture: '/elsewhere/propr-desktop-connect-smoke-AbC123' }, + { generatedLeaf: 'propr-desktop-connect-smoke-Different' }, + { lstatImpl: async () => ({ isDirectory: () => true, isSymbolicLink: () => true }) }, + ]) { + let removed = false; + const result = await removeAuthorizedConnectFixture({ + ...identityOptions, + ...options, + rmImpl: async () => { removed = true; }, + }); + assert.deepEqual(result, { ok: false, category: 'fixture-cleanup-authorization-failed' }); + assert.equal(removed, false); + } + }); +}); diff --git a/apps/desktop/scripts/packaged-connect-platform.test.mjs b/apps/desktop/scripts/packaged-connect-platform.test.mjs new file mode 100644 index 000000000..2e24d3207 --- /dev/null +++ b/apps/desktop/scripts/packaged-connect-platform.test.mjs @@ -0,0 +1,248 @@ +import assert from 'node:assert/strict'; +import { execFile as nodeExecFile } from 'node:child_process'; +import { readFile } from 'node:fs/promises'; +import { describe, test } from 'node:test'; +import { promisify } from 'node:util'; + +const execFile = promisify(nodeExecFile); + +const workflow = await readFile( + new URL('../../../.github/workflows/desktop-connect-discovery-guard.yml', import.meta.url), + 'utf8', +); +const darwinRunner = await readFile( + new URL('./run-packaged-darwin-connect-smoke.sh', import.meta.url), + 'utf8', +); +const forgeConfig = await readFile(new URL('../forge.config.ts', import.meta.url), 'utf8'); +const darwinSigner = await readFile( + new URL('./sign-darwin-packaged-connect.mjs', import.meta.url), + 'utf8', +); +const darwinVerifier = await readFile( + new URL('./verify-darwin-packaged-connect-signature.mjs', import.meta.url), + 'utf8', +); +const packagedConnectSmoke = await readFile( + new URL('./smoke-packaged-connect.mjs', import.meta.url), + 'utf8', +); +const desktopMain = await readFile(new URL('../src/main.ts', import.meta.url), 'utf8'); +const boundedDarwinRunner = await readFile( + new URL('./run-bounded-darwin-command.mjs', import.meta.url), + 'utf8', +); + +describe('packaged Connect target-native credential setup', () => { + test('Linux retains one isolated unlocked libsecret session and rejects plaintext fallback', async () => { + const linux = workflow.slice( + workflow.indexOf('- name: Run packaged Linux main-to-renderer discovery'), + workflow.indexOf('- name: Run packaged Darwin main-to-renderer discovery'), + ); + assert.match(linux, /keyring_root="\$\(mktemp -d\)"/u); + assert.match(linux, /export XDG_DATA_HOME="\$1"/u); + assert.match(linux, /export PROPR_DESKTOP_SMOKE_KEYRING_ROOT="\$1"/u); + assert.match(linux, /gnome-keyring-daemon --unlock --components=secrets/u); + + const main = await readFile(new URL('../src/main.ts', import.meta.url), 'utf8'); + assert.match(main, /process\.platform === 'linux' \? 'gnome_libsecret' : 'os-protected'/u); + assert.match(main, /security\.backend !== requiredStorageBackend/u); + }); + + test('inspects the ordinary unsigned package before adding the Darwin-only acceptance identity', () => { + const darwin = workflow.slice( + workflow.indexOf('- name: Run packaged Darwin main-to-renderer discovery'), + workflow.indexOf('- name: Run packaged Windows main-to-renderer discovery'), + ); + const inspect = workflow.indexOf('- name: Inspect the unsigned target-native desktop app'); + const darwinLaunch = workflow.indexOf('- name: Run packaged Darwin main-to-renderer discovery'); + assert.ok(inspect >= 0 && inspect < darwinLaunch); + assert.match(workflow, /- name: Inspect the unsigned target-native desktop app\n\s+run: npm run desktop:smoke:inspect/u); + assert.match(darwin, /node apps\/desktop\/scripts\/run-bounded-darwin-command\.mjs[\s\S]*?--timeout-ms 480000[\s\S]*?-- bash apps\/desktop\/scripts\/run-packaged-darwin-connect-smoke\.sh '\$\{\{ matrix\.arch \}\}'/u); + assert.doesNotMatch(forgeConfig, /PACKAGED_CONNECT.*SIGN|SMOKE.*SIGN/iu); + assert.match(forgeConfig, /\.\.\.\(macSigning \? \{[\s\S]*?osxSign: \{[\s\S]*?identity: macSigning\.PROPR_DESKTOP_MAC_SIGNING_IDENTITY/u); + assert.doesNotMatch(`${forgeConfig}\n${darwinRunner}\n${darwinSigner}`, /Developer ID Application/u); + }); + + test('Darwin creates one ephemeral certificate-backed identity and proves it across both launches', () => { + assert.match(darwinRunner, /keychain_root="\$\(run_bounded_forward[^\n]*\/usr\/bin\/mktemp -d\)"/u); + assert.match(darwinRunner, /keychain_password="\$\(run_bounded_forward[\s\S]*?\/usr\/bin\/openssl rand -hex 32\)"/u); + assert.match(darwinRunner, /identity_password="\$\(run_bounded_forward[\s\S]*?\/usr\/bin\/openssl rand -hex 32\)"/u); + assert.match(darwinRunner, /x509_extensions = leaf_extensions/u); + assert.match(darwinRunner, /basicConstraints = critical,CA:FALSE/u); + assert.match(darwinRunner, /extendedKeyUsage = critical,codeSigning/u); + assert.match(darwinRunner, /openssl req -new -x509 -newkey rsa:2048[\s\S]*?-days 1[\s\S]*?-config "\$leaf_config"/u); + assert.doesNotMatch(darwinRunner, /root_(?:private_key|certificate|config)|leaf_request|-CA(?:key)?\b/u); + assert.doesNotMatch(darwinRunner, /add-trusted-cert|remove-trusted-cert|trustRoot/u); + assert.match(darwinRunner, /\/usr\/bin\/security import "\$identity_archive" \\[\s\S]*?-T \/usr\/bin\/codesign/u); + assert.match(darwinRunner, /\/usr\/bin\/security set-key-partition-list \\[\s\S]*?-S apple-tool:,apple:,codesign:/u); + assert.match(darwinRunner, /run_bounded_forward "\$SIGNING_TIMEOUT_MS" node "\$application_signer"/u); + assert.doesNotMatch(darwinSigner, /from '@electron\/osx-sign'/u); + assert.match(darwinSigner, /discoverDarwinSignablePaths/u); + assert.match(darwinSigner, /'--sign', certificateSha1/u); + assert.match(darwinSigner, /'--keychain', keychain/u); + assert.match(darwinSigner, /'--timestamp=none'/u); + assert.match(darwinVerifier, /'find-certificate', '-a', '-Z', keychain/u); + assert.match(darwinVerifier, /\['-d', '--verbose=4', application\]/u); + assert.doesNotMatch(darwinVerifier, /'--test-requirement'|['"`]?-R(?:=|['"`])/u); + assert.match(darwinVerifier, /fingerprints\.length !== 1 \|\| fingerprints\[0\] !== expectedSha1/u); + assert.match(darwinVerifier, /ADHOC_SIGNATURE_LINE = \/\^\\s\*signature\\s\*=\\s\*adhoc\\s\*\$\/iu/u); + assert.match(darwinVerifier, /identifiers\.length !== 1/u); + assert.match(darwinVerifier, /identifiers\[0\] !== REQUIRED_IDENTIFIER/u); + assert.match(darwinVerifier, /signatureSizes\.length !== 1/u); + assert.match(darwinVerifier, /POSITIVE_SIGNATURE_SIZE\.test\(signatureSizes\[0\]\)/u); + assert.match(darwinVerifier, /DESIGNATED_REQUIREMENT_PREFIX/u); + assert.match(darwinVerifier, /DESIGNATED_REQUIREMENT_GRAMMAR/u); + assert.match(darwinVerifier, /designatedLines\.length !== 1/u); + assert.match(darwinVerifier, /requirementMatch\[1\] !== REQUIRED_IDENTIFIER/u); + assert.match(darwinVerifier, /requirementMatch\[2\]\.toUpperCase\(\) !== expectedSha1/u); + assert.doesNotMatch(darwinVerifier, /Authority=/u); + assert.doesNotMatch(darwinVerifier, /extract-certificates/u); + assert.doesNotMatch(darwinVerifier, /find-identity/u); + assert.match(darwinSigner, /certificate leaf = H"\$\{certificateSha1\}"/u); + assert.match(darwinSigner, /filter\(filePath => !PACKAGED_CONNECT_NATIVE_ARTIFACTS\.test\(filePath\)\)/u); + assert.match(darwinSigner, /'--verify', '--deep', '--strict', application/u); + assert.match(darwinVerifier, /'--verify', '--deep', '--strict', application/u); + assert.match(darwinVerifier, /previousDesignatedRequirement !== normalizedRequirement/u); + assert.match(desktopMain, /storageBackend: requiredStorageBackend/u); + assert.match(packagedConnectSmoke, /expectedStorageBackend: 'os-protected'/u); + assert.match(packagedConnectSmoke, /outcome = await runPhase\('pair'\);[\s\S]*?outcome = await runPhase\('reprobe'\)/u); + assert.match(packagedConnectSmoke, /authenticatedRestCount: authenticatedRest\.length/u); + assert.match(packagedConnectSmoke, /authenticatedSocketCount: socketEvidence\.authenticatedSocketCount/u); + const establish = darwinRunner.indexOf('node "$signature_verifier" establish'); + const smoke = darwinRunner.indexOf('node "$script_directory/smoke-packaged-connect.mjs"'); + const stable = darwinRunner.indexOf('node "$signature_verifier" stable'); + assert.ok(establish >= 0 && establish < smoke && smoke < stable); + assert.match(packagedConnectSmoke, /const runPhase = async phase => await runPackagedConnectLifecycle\([\s\S]*?spawn: spawnLifecycleProcess/u); + assert.match(packagedConnectSmoke, /outcome = await runPhase\('pair'\);\s*if \(outcome\.ok && journeyFixture\) \{\s*const pairingRequestCountAtPairTerminal = journeyFixture\.requests\.filter\(request =>[^{};]+\)\.length;\s*outcome = await runPhase\('reprobe'\);/u); + assert.match(workflow, /target: darwin-x64\s+runner: macos-15-intel\s+platform: darwin\s+arch: x64/u); + assert.match(workflow, /target: darwin-arm64\s+runner: macos-15\s+platform: darwin\s+arch: arm64/u); + }); + + test('Darwin root signing sets, but never preserves, the required identifier', () => { + assert.match(darwinSigner, /isApplication \? \[\s*'--identifier', REQUIRED_IDENTIFIER,\s*'--preserve-metadata=entitlements,flags',\s*\] : \[\s*'--preserve-metadata=identifier,entitlements,flags',\s*\]/u); + const rootMetadataBranch = /isApplication \? \[([\s\S]*?)\] : \[/u.exec(darwinSigner)?.[1]; + assert.ok(rootMetadataBranch); + assert.match(rootMetadataBranch, /'--identifier', REQUIRED_IDENTIFIER/u); + assert.match(rootMetadataBranch, /'--preserve-metadata=entitlements,flags'/u); + assert.doesNotMatch(rootMetadataBranch, /--preserve-metadata=identifier,/u); + }); + + test('Darwin emits only allowlisted fixed stage markers around every blocking phase', async () => { + const expectedStages = [ + 'KEY_CERTIFICATE_GENERATION', + 'KEYCHAIN_CREATION_SELECTION', + 'IDENTITY_IMPORT', + 'PARTITION_LIST_UPDATE', + 'APPLICATION_SIGNING', + 'INITIAL_SIGNATURE_VERIFICATION', + 'PAIR_REPROBE_JOURNEY', + 'STABLE_SIGNATURE_VERIFICATION', + 'KEYCHAIN_RESTORATION_DELETION', + 'TEMPORARY_FILE_CLEANUP', + ]; + const invokedStages = [...darwinRunner.matchAll(/^\s*run_stage ([A-Z_]+)\b/gmu)] + .map(match => match[1]); + assert.deepEqual(new Set(invokedStages), new Set(expectedStages)); + assert.equal(invokedStages.length, expectedStages.length); + assert.match(darwinRunner, /case "\$code" in\n\s+STARTED\|PASSED\|FAILED\)/u); + assert.match(darwinRunner, /printf 'DARWIN_PACKAGED_CONNECT_SETUP:%s:%s\\n' "\$stage" "\$code"/u); + assert.doesNotMatch(darwinRunner, /stage_marker[^\n]*(?:password|certificate_serial|identity_sha1)/u); + + const markerFunction = darwinRunner.slice( + darwinRunner.indexOf('stage_marker() {'), + darwinRunner.indexOf('\n\nrun_bounded()'), + ); + const markerCalls = expectedStages + .flatMap(stage => ['STARTED', 'PASSED', 'FAILED'] + .map(code => `stage_marker ${stage} ${code}`)) + .join('\n'); + const { stdout } = await execFile('/bin/bash', ['-c', `${markerFunction}\n${markerCalls}`], { + encoding: 'utf8', timeout: 2_000, maxBuffer: 16 * 1024, + }); + assert.deepEqual(stdout.trim().split('\n'), expectedStages.flatMap(stage => [ + 'STARTED', 'PASSED', 'FAILED', + ].map(code => `DARWIN_PACKAGED_CONNECT_SETUP:${stage}:${code}`))); + await assert.rejects(execFile('/bin/bash', ['-c', `${markerFunction}\nstage_marker BAD SECRET`], { + encoding: 'utf8', timeout: 2_000, maxBuffer: 16 * 1024, + })); + }); + + test('Darwin bounds setup, nested signing, verification, journey, cleanup, and the wrapper', () => { + assert.match(boundedDarwinRunner, /case 'node': return spawn\(process\.execPath, arguments_, options\)/u); + assert.match(boundedDarwinRunner, /case 'security': return spawn\('\/usr\/bin\/security', arguments_, options\)/u); + assert.doesNotMatch(boundedDarwinRunner, /nodeSpawn\(argv\[1\]/u); + assert.match(boundedDarwinRunner, /detached: platform !== 'win32'/u); + assert.match(boundedDarwinRunner, /process\.kill\(-child\.pid, signal\)/u); + assert.match(boundedDarwinRunner, /GROUP_GUARD_RELEASE/u); + assert.match(boundedDarwinRunner, /prevents the PGID from being reused/u); + assert.match(boundedDarwinRunner, /signalProcessGroup\(child, 'SIGTERM'/u); + assert.match(boundedDarwinRunner, /signalProcessGroup\(child, 'SIGKILL'/u); + assert.match(boundedDarwinRunner, /maximumBytes - state\.bytes/u); + assert.match(darwinVerifier, /runBoundedProcess/u); + assert.match(darwinVerifier, /timeoutMs: VERIFICATION_TIMEOUT_MS/u); + assert.match(darwinVerifier, /maxOutputBytes: VERIFICATION_MAX_OUTPUT_BYTES/u); + assert.match(darwinSigner, /runBoundedProcess/u); + assert.match(darwinSigner, /timeoutMs: CODESIGN_TIMEOUT_MS/u); + assert.match(darwinSigner, /forwardOutput: false/u); + assert.match(darwinRunner, /run_bounded "\$COMMAND_TIMEOUT_MS" \/usr\/bin\/security/gmu); + assert.match(darwinRunner, /run_bounded "\$COMMAND_TIMEOUT_MS" \/usr\/bin\/openssl/gmu); + assert.match(darwinRunner, /run_bounded_forward "\$SIGNING_TIMEOUT_MS" node "\$application_signer"/u); + assert.match(darwinRunner, /cd "\$repository_root\/apps\/desktop"[\s\S]*?run_bounded_forward "\$JOURNEY_TIMEOUT_MS" node "\$script_directory\/smoke-packaged-connect\.mjs"/u); + }); + + test('Darwin failure diagnostics are fixed, classified, and secret-safe', () => { + for (const diagnostic of [ + 'MISSING_IDENTITY_OR_CHAIN', + 'TRUST_REJECTION', + 'REQUIREMENTS_FAILURE', + 'CODESIGN_FAILURE', + ]) { + assert.match(darwinSigner, new RegExp(`['"]${diagnostic}['"]`, 'u')); + } + for (const diagnostic of [ + 'CERTIFICATE_LOOKUP_FAILURE', + 'SIGNATURE_DISPLAY_FAILURE', + 'EMBEDDED_REQUIREMENT_FAILURE', + 'STRICT_VERIFY_FAILURE', + 'KEYCHAIN_EVIDENCE_FAILURE', + 'ADHOC_SIGNATURE_FAILURE', + 'IDENTIFIER_METADATA_FAILURE', + 'SIGNATURE_METADATA_FAILURE', + 'REQUIREMENT_EVIDENCE_FAILURE', + 'EVIDENCE_ASSERTION_FAILURE', + ]) { + assert.match(darwinVerifier, new RegExp(`['"]${diagnostic}['"]`, 'u')); + } + assert.match(darwinSigner, /DARWIN_PACKAGED_CONNECT_DIAGNOSTIC:\$\{classifyDarwinSigningFailure\(error\)\}/u); + assert.doesNotMatch(darwinSigner, /process\.stderr\.write\([^\n]*(?:application|keychain|certificateSha1|stderr|stdout)/u); + assert.match(darwinRunner, /run_bounded_forward "\$COMMAND_TIMEOUT_MS" node "\$signature_verifier" establish/u); + assert.match(darwinRunner, /run_bounded_forward "\$COMMAND_TIMEOUT_MS" node "\$signature_verifier" stable/u); + }); + + test('Darwin restores keychain state and deletes identity, credentials, and files on every exit', () => { + assert.match(darwinRunner, /trap cleanup_keychain EXIT/u); + assert.match(darwinRunner, /trap 'exit_for_signal 129' HUP/u); + assert.match(darwinRunner, /trap 'exit_for_signal 130' INT/u); + assert.match(darwinRunner, /trap 'exit_for_signal 143' TERM/u); + assert.match(darwinRunner, /if \[\[ -n "\$active_stage" \]\]; then\n\s+stage_marker "\$active_stage" FAILED/u); + assert.doesNotMatch(darwinRunner, /add-trusted-cert|remove-trusted-cert|trustRoot/u); + assert.match(darwinRunner, /\/usr\/bin\/security list-keychains -d user -s \\[\s\S]*?"\$\{original_keychains\[@\]\}"/u); + assert.match(darwinRunner, /\/usr\/bin\/security default-keychain -d user -s \\[\s\S]*?"\$original_default"/u); + assert.match(darwinRunner, /\/usr\/bin\/security delete-keychain "\$keychain_path"/u); + assert.doesNotMatch(darwinRunner, /certificate_prefix/u); + assert.match(darwinRunner, /"\$requirement_proof" "\$keychain_path"/u); + assert.match(darwinRunner, /run_bounded "\$CLEANUP_TIMEOUT_MS" \/bin\/rm -rf -- "\$keychain_root"/u); + assert.match(darwinRunner, /if \(\( cleanup_status != 0 \)\)[\s\S]*?primary_status=1/u); + }); + + test('Darwin smoke has no static or production identity and does not widen or pre-seed Safe Storage', async () => { + const main = await readFile(new URL('../src/main.ts', import.meta.url), 'utf8'); + assert.doesNotMatch(darwinRunner, /add-generic-password|Safe Storage|-A(?:\s|$)/u); + assert.doesNotMatch(darwinRunner, /Developer ID|notari|APPLE_|PROPR_DESKTOP_MAC_/iu); + assert.doesNotMatch(darwinRunner, /(?:keychain|identity)_password=['"][^$]/u); + assert.doesNotMatch(workflow, /secrets\.[^\n]*Packaged Connect|Packaged Connect[^\n]*secrets\./u); + assert.match(main, /const requiredStorageBackend = process\.platform === 'linux' \? 'gnome_libsecret' : 'os-protected'/u); + assert.match(main, /security\.backend !== requiredStorageBackend/u); + }); +}); diff --git a/apps/desktop/scripts/packaged-layout.d.mts b/apps/desktop/scripts/packaged-layout.d.mts new file mode 100644 index 000000000..4970d65ef --- /dev/null +++ b/apps/desktop/scripts/packaged-layout.d.mts @@ -0,0 +1,3 @@ +export const parseEventRecord: (smokeOutput: string, expectedEvent: string) => Record | undefined; +export const parseEventLayout: (smokeOutput: string, expectedEvent: string) => unknown; +export const assertPackagedLayout: (layout: unknown, platform?: NodeJS.Platform) => void; diff --git a/apps/desktop/scripts/packaged-layout.mjs b/apps/desktop/scripts/packaged-layout.mjs new file mode 100644 index 000000000..2d4658b38 --- /dev/null +++ b/apps/desktop/scripts/packaged-layout.mjs @@ -0,0 +1,128 @@ +const EXPECTED_WINDOW_SIZE = { width: 1280, height: 820 }; +const MINIMUM_WINDOW_SIZE = { width: 880, height: 620 }; + +export const parseEventRecord = (smokeOutput, expectedEvent) => { + for (const line of smokeOutput.split(/\r?\n/)) { + if (!line.includes(expectedEvent)) continue; + try { + const record = JSON.parse(line.slice(line.indexOf('{'))); + if (record.event === expectedEvent) return record; + } catch { + // Ignore non-JSON Chromium output that happens to mention the event name. + } + } + return undefined; +}; + +export const parseEventLayout = (smokeOutput, expectedEvent) => ( + parseEventRecord(smokeOutput, expectedEvent)?.layout +); + +const fail = message => { + throw new Error(message); +}; + +const assertPositiveDimensions = (name, bounds) => { + if (!bounds + || !Number.isFinite(bounds.width) || bounds.width <= 0 + || !Number.isFinite(bounds.height) || bounds.height <= 0) { + fail(`Packaged ${name} does not have positive bounds: ${JSON.stringify(bounds)}`); + } +}; + +const assertElementBounds = (name, bounds) => { + assertPositiveDimensions(name, bounds); + if (![bounds.left, bounds.top, bounds.right, bounds.bottom].every(Number.isFinite) + || bounds.right - bounds.left !== bounds.width + || bounds.bottom - bounds.top !== bounds.height) { + fail(`Packaged ${name} has inconsistent bounds: ${JSON.stringify(bounds)}`); + } +}; + +const contains = (outer, inner) => inner.left >= outer.left + && inner.top >= outer.top + && inner.right <= outer.right + && inner.bottom <= outer.bottom; + +export const assertPackagedLayout = (layout, platform = process.platform) => { + if (!layout) fail('Packaged desktop did not report renderer layout bounds'); + if (layout.missing?.length) { + fail(`Packaged renderer layout was missing: ${layout.missing.join(', ')}`); + } + + assertPositiveDimensions('window', layout.windowBounds); + assertPositiveDimensions('visible work area', layout.workArea); + if (![layout.windowBounds.x, layout.windowBounds.y, layout.workArea.x, layout.workArea.y].every(Number.isFinite)) { + fail(`Packaged window or visible work area has invalid coordinates: ${JSON.stringify({ + windowBounds: layout.windowBounds, + workArea: layout.workArea, + })}`); + } + + if (platform === 'linux') { + if (layout.windowBounds.width !== EXPECTED_WINDOW_SIZE.width + || layout.windowBounds.height !== EXPECTED_WINDOW_SIZE.height) { + fail(`Packaged Linux window was not 1280x820: ${JSON.stringify(layout.windowBounds)}`); + } + } else if (platform === 'win32') { + if (layout.windowBounds.width < MINIMUM_WINDOW_SIZE.width + || layout.windowBounds.height < MINIMUM_WINDOW_SIZE.height + || layout.windowBounds.width > EXPECTED_WINDOW_SIZE.width + || layout.windowBounds.height > EXPECTED_WINDOW_SIZE.height) { + fail(`Packaged Windows window was outside the safe clamped range: ${JSON.stringify(layout.windowBounds)}`); + } + } else { + fail(`Packaged layout assertion does not support ${platform}`); + } + + const windowRight = layout.windowBounds.x + layout.windowBounds.width; + const windowBottom = layout.windowBounds.y + layout.windowBounds.height; + const workAreaRight = layout.workArea.x + layout.workArea.width; + const workAreaBottom = layout.workArea.y + layout.workArea.height; + if (layout.windowBounds.x < layout.workArea.x + || layout.windowBounds.y < layout.workArea.y + || windowRight > workAreaRight + || windowBottom > workAreaBottom) { + fail(`Packaged window extends outside the visible work area: ${JSON.stringify({ + windowBounds: layout.windowBounds, + workArea: layout.workArea, + })}`); + } + + assertPositiveDimensions('renderer viewport', layout.viewport); + if (layout.viewport.width > layout.windowBounds.width || layout.viewport.height > layout.windowBounds.height) { + fail(`Packaged renderer viewport extends outside the window: ${JSON.stringify(layout.viewport)}`); + } + if (platform === 'linux' && (layout.viewport.width < 1200 || layout.viewport.height < 740)) { + fail(`Packaged Linux renderer viewport is unexpectedly small: ${JSON.stringify(layout.viewport)}`); + } + + const elementNames = ['entry', 'card', 'logo', 'heading', 'connectButton', 'connectDescription']; + for (const name of elementNames) assertElementBounds(name, layout[name]); + const viewportBounds = { + top: 0, + left: 0, + right: layout.viewport.width, + bottom: layout.viewport.height, + }; + if (elementNames.some(name => !contains(viewportBounds, layout[name]))) { + fail('Packaged welcome-card content extends outside the renderer viewport'); + } + if (!contains(layout.entry, layout.card) + || !contains(layout.card, layout.logo) + || !contains(layout.card, layout.heading) + || !contains(layout.card, layout.connectButton) + || !contains(layout.connectButton, layout.connectDescription)) { + fail('Packaged welcome-card content extends outside its layout container'); + } + + if (layout.logo.height < 30 || layout.logo.height > 34 || layout.logo.width < 30 || layout.logo.width > 34) { + fail(`Packaged welcome-card logo has unreasonable bounds: ${JSON.stringify(layout.logo)}`); + } + if (layout.card.width < 540 || layout.card.width > 620 || layout.connectButton.height < 60) { + fail(`Packaged welcome card or connection control has unreasonable bounds: ${JSON.stringify(layout)}`); + } + if (layout.heading.top <= layout.logo.bottom || layout.connectButton.top <= layout.heading.bottom) { + fail('Packaged welcome-card content is overlapping or out of order'); + } +}; diff --git a/apps/desktop/scripts/packaged-layout.test.mjs b/apps/desktop/scripts/packaged-layout.test.mjs new file mode 100644 index 000000000..d7a2b3aec --- /dev/null +++ b/apps/desktop/scripts/packaged-layout.test.mjs @@ -0,0 +1,93 @@ +import assert from 'node:assert/strict'; +import { describe, it } from 'node:test'; +import { assertPackagedLayout, parseEventRecord } from './packaged-layout.mjs'; + +const bounds = (left, top, width, height) => ({ + bottom: top + height, + height, + left, + right: left + width, + top, + width, +}); + +const layout = ({ + windowWidth = 1280, + windowHeight = 820, + viewportWidth = 1280, + viewportHeight = 780, + workAreaWidth = 1280, + workAreaHeight = 900, +} = {}) => ({ + windowBounds: { x: 0, y: 0, width: windowWidth, height: windowHeight }, + workArea: { x: 0, y: 0, width: workAreaWidth, height: workAreaHeight }, + viewport: { width: viewportWidth, height: viewportHeight }, + entry: bounds(0, 0, viewportWidth, viewportHeight), + card: bounds((viewportWidth - 580) / 2, 40, 580, 640), + logo: bounds((viewportWidth - 32) / 2, 72, 32, 32), + heading: bounds((viewportWidth - 420) / 2, 132, 420, 58), + connectButton: bounds((viewportWidth - 520) / 2, 230, 520, 76), + connectDescription: bounds((viewportWidth - 300) / 2, 270, 300, 18), +}); + +describe('packaged desktop event parsing', () => { + it('returns the first full record for the exact matching event', () => { + const firstProof = { + event: 'desktop.renderer.mvp_flows.ready', + localProfile: true, + remoteActiveProfile: true, + lifecycleBoundary: true, + connectUiPopulated: true, + }; + const output = [ + 'not JSON: desktop.renderer.mvp_flows.ready', + JSON.stringify({ event: 'desktop.renderer.mvp_flows.ready.extra', localProfile: false }), + JSON.stringify({ event: 'desktop.renderer.other', note: 'desktop.renderer.mvp_flows.ready' }), + JSON.stringify(firstProof), + JSON.stringify({ event: 'desktop.renderer.mvp_flows.ready', localProfile: false }), + ].join('\n'); + + assert.deepEqual(parseEventRecord(output, firstProof.event), firstProof); + }); + + it('returns undefined when the event is absent', () => { + const output = [ + '{malformed', + JSON.stringify({ event: 'desktop.renderer.other' }), + ].join('\n'); + + assert.equal(parseEventRecord(output, 'desktop.renderer.mvp_flows.ready'), undefined); + }); +}); + +describe('packaged desktop layout assertions', () => { + it('retains the exact 1280x820 Linux Xvfb proof', () => { + assert.doesNotThrow(() => assertPackagedLayout(layout(), 'linux')); + assert.throws( + () => assertPackagedLayout(layout({ windowWidth: 1279 }), 'linux'), + /Linux window was not 1280x820/, + ); + }); + + it('accepts a safe 1024x720 Windows display clamp with intact contained content', () => { + assert.doesNotThrow(() => assertPackagedLayout(layout({ + windowWidth: 1024, + windowHeight: 720, + viewportWidth: 1024, + viewportHeight: 681, + workAreaWidth: 1024, + workAreaHeight: 720, + }), 'win32')); + }); + + it('rejects unsafe Windows clamps and content outside the visible work area', () => { + assert.throws( + () => assertPackagedLayout(layout({ windowWidth: 879 }), 'win32'), + /outside the safe clamped range/, + ); + assert.throws( + () => assertPackagedLayout(layout({ workAreaWidth: 1024 }), 'win32'), + /outside the visible work area/, + ); + }); +}); diff --git a/apps/desktop/scripts/packaged-smoke-plan.mjs b/apps/desktop/scripts/packaged-smoke-plan.mjs new file mode 100644 index 000000000..b4bde6fcd --- /dev/null +++ b/apps/desktop/scripts/packaged-smoke-plan.mjs @@ -0,0 +1,83 @@ +export const READY_EVENT = 'desktop.renderer.ready'; +export const PRELOAD_BRIDGE_PROOF = '"preloadBridgeExposed":true'; +export const PROFILE_API_PROOF = 'desktop.renderer.profile_api.ready'; +export const TRANSPORT_PROOF = 'desktop.renderer.transport_smoke.ready'; +export const MVP_FLOWS_PROOF = 'desktop.renderer.mvp_flows.ready'; +export const LAYOUT_READY_EVENT = 'desktop.renderer.layout.ready'; +export const REDUCED_NATIVE_WINDOW_READY_EVENT = 'desktop.native.reduced_window.ready'; +export const CONNECT_DEEP_LINK = 'propr://connect?api=https%3A%2F%2Fconnect.propr.dev'; + +export const PACKAGED_SMOKE_LAUNCH_MODES = Object.freeze([ + 'release-guard', + 'success', + 'retry', + 'forced-timeout', +]); + +export const TRANSPORT_SMOKE_ENVIRONMENT_NAMES = Object.freeze([ + 'PROPR_DESKTOP_SMOKE_FIRST_ORIGIN', + 'PROPR_DESKTOP_SMOKE_SECOND_ORIGIN', + 'PROPR_DESKTOP_SMOKE_SHUTDOWN_MODE', +]); + +const releaseGuardMarkers = Object.freeze([ + READY_EVENT, + PRELOAD_BRIDGE_PROOF, + PROFILE_API_PROOF, + MVP_FLOWS_PROOF, + LAYOUT_READY_EVENT, + REDUCED_NATIVE_WINDOW_READY_EVENT, +]); +const transportMarkers = Object.freeze([ + READY_EVENT, + PRELOAD_BRIDGE_PROOF, + TRANSPORT_PROOF, + MVP_FLOWS_PROOF, + LAYOUT_READY_EVENT, + REDUCED_NATIVE_WINDOW_READY_EVENT, +]); + +export const createPackagedSmokeLaunch = ({ + mode, + platform, + userDataPath, + baseChildEnvironment, + firstOrigin, + secondOrigin, + dbusSessionAddress, +}) => { + if (!PACKAGED_SMOKE_LAUNCH_MODES.includes(mode)) { + throw new Error(`Unknown packaged smoke launch mode: ${mode}`); + } + const transport = mode !== 'release-guard'; + for (const name of TRANSPORT_SMOKE_ENVIRONMENT_NAMES) { + if (Object.hasOwn(baseChildEnvironment, name)) { + throw new Error(`Packaged smoke base environment unexpectedly contains ${name}`); + } + } + + const launchArguments = [ + '--disable-gpu', + '--propr-smoke-test', + `--user-data-dir=${userDataPath}`, + ...(platform === 'linux' ? ['--password-store=gnome-libsecret'] : []), + ...(!transport ? [CONNECT_DEEP_LINK] : []), + ]; + const childEnvironment = { + ...baseChildEnvironment, + ...(platform === 'linux' ? { DBUS_SESSION_BUS_ADDRESS: dbusSessionAddress } : {}), + ...(transport ? { + PROPR_DESKTOP_SMOKE_FIRST_ORIGIN: firstOrigin, + PROPR_DESKTOP_SMOKE_SECOND_ORIGIN: secondOrigin, + PROPR_DESKTOP_SMOKE_SHUTDOWN_MODE: mode, + } : {}), + }; + + return Object.freeze({ + mode, + transport, + launchArguments: Object.freeze(launchArguments), + childEnvironment: Object.freeze(childEnvironment), + requiredMarkers: transport ? transportMarkers : releaseGuardMarkers, + }); +}; diff --git a/apps/desktop/scripts/packaged-smoke-support.test.mjs b/apps/desktop/scripts/packaged-smoke-support.test.mjs index 93e2d3e91..5e7fba41d 100644 --- a/apps/desktop/scripts/packaged-smoke-support.test.mjs +++ b/apps/desktop/scripts/packaged-smoke-support.test.mjs @@ -12,6 +12,12 @@ import { removePrivateSmokeProfile, validateWindowsSystemRoot, } from './packaged-smoke-support.mjs'; +import { + CONNECT_DEEP_LINK, + createPackagedSmokeLaunch, + PACKAGED_SMOKE_LAUNCH_MODES, + TRANSPORT_SMOKE_ENVIRONMENT_NAMES, +} from './packaged-smoke-plan.mjs'; const assertPackagedSpawnOptions = (source) => { const normalizedSource = source.replace(/\r\n?/g, '\n'); @@ -103,6 +109,101 @@ describe('packaged smoke native window layout', () => { }); describe('packaged smoke child environment', () => { + test('defines four isolated launches with exact per-mode environment, argv, and marker contracts', () => { + const firstOrigin = 'http://127.0.0.1:41001'; + const secondOrigin = 'http://127.0.0.1:41002'; + const dbusSessionAddress = 'unix:path=/run/user/1000/bus'; + const connectDeepLink = 'propr://connect?api=https%3A%2F%2Fconnect.propr.dev'; + assert.equal(CONNECT_DEEP_LINK, connectDeepLink); + assert.deepEqual(TRANSPORT_SMOKE_ENVIRONMENT_NAMES, [ + 'PROPR_DESKTOP_SMOKE_FIRST_ORIGIN', + 'PROPR_DESKTOP_SMOKE_SECOND_ORIGIN', + 'PROPR_DESKTOP_SMOKE_SHUTDOWN_MODE', + ]); + const launches = PACKAGED_SMOKE_LAUNCH_MODES.map((mode, index) => { + const userDataPath = `/private/propr-desktop-smoke-${mode}`; + const baseChildEnvironment = { + HOME: `${userDataPath}/home`, + PROPR_DESKTOP_SMOKE_PROFILE_API_URL: `http://127.0.0.1:${42000 + index}`, + PROPR_DESKTOP_SMOKE_TEST: '1', + }; + return createPackagedSmokeLaunch({ + mode, + platform: 'linux', + userDataPath, + baseChildEnvironment, + firstOrigin, + secondOrigin, + dbusSessionAddress, + }); + }); + + assert.deepEqual(launches.map(launch => launch.mode), [ + 'release-guard', 'success', 'retry', 'forced-timeout', + ]); + for (const [index, launch] of launches.entries()) { + const mode = PACKAGED_SMOKE_LAUNCH_MODES[index]; + const userDataPath = `/private/propr-desktop-smoke-${mode}`; + const baseEnvironment = { + HOME: `${userDataPath}/home`, + PROPR_DESKTOP_SMOKE_PROFILE_API_URL: `http://127.0.0.1:${42000 + index}`, + PROPR_DESKTOP_SMOKE_TEST: '1', + }; + const commonMarkers = [ + 'desktop.renderer.ready', + '"preloadBridgeExposed":true', + ]; + const layoutMarkers = [ + 'desktop.renderer.mvp_flows.ready', + 'desktop.renderer.layout.ready', + 'desktop.native.reduced_window.ready', + ]; + if (mode === 'release-guard') { + assert.equal(launch.transport, false); + assert.deepEqual(launch.launchArguments, [ + '--disable-gpu', + '--propr-smoke-test', + `--user-data-dir=${userDataPath}`, + '--password-store=gnome-libsecret', + connectDeepLink, + ]); + assert.deepEqual(launch.childEnvironment, { + ...baseEnvironment, + DBUS_SESSION_BUS_ADDRESS: dbusSessionAddress, + }); + assert.deepEqual(launch.requiredMarkers, [ + ...commonMarkers, + 'desktop.renderer.profile_api.ready', + ...layoutMarkers, + ]); + for (const name of TRANSPORT_SMOKE_ENVIRONMENT_NAMES) { + assert.equal(Object.hasOwn(launch.childEnvironment, name), false); + } + } else { + assert.equal(launch.transport, true); + assert.deepEqual(launch.launchArguments, [ + '--disable-gpu', + '--propr-smoke-test', + `--user-data-dir=${userDataPath}`, + '--password-store=gnome-libsecret', + ]); + assert.deepEqual(launch.childEnvironment, { + ...baseEnvironment, + DBUS_SESSION_BUS_ADDRESS: dbusSessionAddress, + PROPR_DESKTOP_SMOKE_FIRST_ORIGIN: firstOrigin, + PROPR_DESKTOP_SMOKE_SECOND_ORIGIN: secondOrigin, + PROPR_DESKTOP_SMOKE_SHUTDOWN_MODE: mode, + }); + assert.deepEqual(launch.requiredMarkers, [ + ...commonMarkers, + 'desktop.renderer.transport_smoke.ready', + ...layoutMarkers, + ]); + assert.equal(launch.launchArguments.includes(connectDeepLink), false); + } + } + }); + test('passes only platform launch inputs and private profile paths from a hostile parent', async () => { const parent = await createPrivateSmokeProfile(tmpdir()); const xAuthority = join(parent.root, 'Xauthority'); @@ -251,6 +352,25 @@ describe('packaged smoke child environment', () => { assert.doesNotMatch(smokeSource, /env:\s*\{[\s\S]*process\.env/); }); + test('serves each named fixture identity paired with its persisted credential', async () => { + const smokeSource = await readFile(new URL('./smoke-packaged.mjs', import.meta.url), 'utf8'); + const mainSource = await readFile(new URL('../src/main.ts', import.meta.url), 'utf8'); + assert.match( + smokeSource, + /name === 'first'\s*\? 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa'\s*: 'bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb'/u, + ); + assert.match(smokeSource, /first = await listenFixture\('first'\);/u); + assert.match(smokeSource, /second = await listenFixture\('second'\);/u); + assert.match( + mainSource, + /origin: smoke\.firstOrigin,\s*publicInstanceIdentity: 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa'/u, + ); + assert.match( + mainSource, + /origin: smoke\.secondOrigin,\s*publicInstanceIdentity: 'bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb'/u, + ); + }); + test('requires the adjacent packaged spawn options with LF or CRLF source', () => { const options = [ ' cwd: smokeProfile.root,', diff --git a/apps/desktop/scripts/run-bounded-darwin-command.mjs b/apps/desktop/scripts/run-bounded-darwin-command.mjs new file mode 100644 index 000000000..0a1a53a23 --- /dev/null +++ b/apps/desktop/scripts/run-bounded-darwin-command.mjs @@ -0,0 +1,334 @@ +#!/usr/bin/env node + +import { spawn as nodeSpawn } from 'node:child_process'; +import { writeFile } from 'node:fs/promises'; +import { fileURLToPath } from 'node:url'; + +const DEFAULT_MAX_OUTPUT_BYTES = 256 * 1024; +const EXIT_FOR_SIGNAL = new Map([['SIGHUP', 129], ['SIGINT', 130], ['SIGTERM', 143]]); +const GROUP_GUARD_ARGUMENT = '--internal-process-group-guard'; +const GROUP_GUARD_RELEASE = 'release-process-group-guard'; +const GROUP_GUARD_RESULT = 'process-group-command-result'; + +const trustedCommandId = executable => { + switch (executable) { + case 'bash': + case '/bin/bash': return 'bash'; + case 'codesign': + case '/usr/bin/codesign': return 'codesign'; + case 'mktemp': + case '/usr/bin/mktemp': return 'mktemp'; + case 'node': return 'node'; + case 'openssl': + case '/usr/bin/openssl': return 'openssl'; + case 'rm': + case '/bin/rm': return 'rm'; + case 'security': + case '/usr/bin/security': return 'security'; + default: + if (executable === process.execPath) return 'node'; + throw new BoundedProcessError('invalid-input'); + } +}; + +// Keep every executable literal at the process-creation boundary. The identifier can come +// from the CLI or the guard's argv, but it can only select one of these fixed programs. +const spawnTrustedCommand = (spawn, commandId, arguments_, options) => { + switch (commandId) { + case 'bash': return spawn('/bin/bash', arguments_, options); + case 'codesign': return spawn('/usr/bin/codesign', arguments_, options); + case 'mktemp': return spawn('/usr/bin/mktemp', arguments_, options); + case 'node': return spawn(process.execPath, arguments_, options); + case 'openssl': return spawn('/usr/bin/openssl', arguments_, options); + case 'rm': return spawn('/bin/rm', arguments_, options); + case 'security': return spawn('/usr/bin/security', arguments_, options); + default: throw new BoundedProcessError('invalid-input'); + } +}; + +export class BoundedProcessError extends Error { + constructor(reason, result) { + super(`bounded-process-${reason}`); + this.name = 'BoundedProcessError'; + this.reason = reason; + this.result = result; + } +} + +const appendBounded = (chunks, chunk, state, maximumBytes, forward) => { + const value = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk); + const available = Math.max(0, maximumBytes - state.bytes); + const accepted = value.subarray(0, available); + if (accepted.length > 0) { + chunks.push(accepted); + state.bytes += accepted.length; + forward?.write(accepted); + } + if (accepted.length !== value.length) state.truncated = true; +}; + +const signalProcessGroup = (child, signal, platform) => { + if (!child?.pid) return; + try { + if (platform === 'win32') child.kill(signal); + else process.kill(-child.pid, signal); + } catch (error) { + if (error?.code !== 'ESRCH') throw error; + } +}; + +const runProcessGroupGuard = async argv => { + if (argv[0] !== '--' || typeof argv[1] !== 'string' || argv[1].length === 0) { + process.exitCode = 1; + return; + } + + // The guard is the process-group leader and deliberately survives TERM. Keeping its PID + // occupied until its supervisor releases or kills it prevents the PGID from being reused + // while a TERM-ignoring descendant may still belong to the group. + const ignoredSignals = [...EXIT_FOR_SIGNAL.keys()]; + const ignoreSignal = () => {}; + for (const signal of ignoredSignals) process.on(signal, ignoreSignal); + + let commandResult; + let resultPublished = false; + const publishResult = result => { + if (resultPublished) return; + resultPublished = true; + commandResult = result; + if (process.send) { + process.send({ type: GROUP_GUARD_RESULT, ...result }, () => {}); + } + }; + + let command; + try { + command = spawnTrustedCommand(nodeSpawn, argv[1], argv.slice(2), { + detached: false, + shell: false, + windowsHide: true, + stdio: ['ignore', 'inherit', 'inherit'], + }); + } catch { + publishResult({ exitCode: 1, signal: null, spawnError: true }); + return; + } + command.once('error', () => publishResult({ + exitCode: 1, signal: null, spawnError: true, + })); + command.once('close', (exitCode, signal) => publishResult({ exitCode, signal })); + + process.on('message', message => { + if (message?.type !== GROUP_GUARD_RELEASE || !commandResult) return; + process.exitCode = commandResult.exitCode ?? 1; + process.disconnect?.(); + }); +}; + +export const runBoundedProcess = async ({ + executable, + arguments: arguments_ = [], + timeoutMs, + terminationGraceMs = 5_000, + maxOutputBytes = DEFAULT_MAX_OUTPUT_BYTES, + forwardOutput = false, + spawn = nodeSpawn, + platform = process.platform, + onSpawn, + signalSource = process, +}) => { + if (typeof executable !== 'string' || executable.length === 0 + || !Array.isArray(arguments_) || !arguments_.every(argument => typeof argument === 'string') + || !Number.isInteger(timeoutMs) || timeoutMs <= 0 + || !Number.isInteger(terminationGraceMs) || terminationGraceMs <= 0 + || !Number.isInteger(maxOutputBytes) || maxOutputBytes <= 0) { + throw new BoundedProcessError('invalid-input'); + } + const commandId = trustedCommandId(executable); + + const stdoutChunks = []; + const stderrChunks = []; + const stdoutState = { bytes: 0, truncated: false }; + const stderrState = { bytes: 0, truncated: false }; + let primaryReason; + let requestedSignal; + let forceTimer; + let drainTimer; + let timeout; + let child; + let childClosed; + let commandResult; + let commandSpawnFailed = false; + let resolveForcedSettlement; + const forcedSettlement = new Promise(resolve => { resolveForcedSettlement = resolve; }); + + const requestTermination = reason => { + if (!primaryReason) primaryReason = reason; + try { + signalProcessGroup(child, 'SIGTERM', platform); + } catch { + // The primary failure remains the timeout/signal even if termination reports a race. + } + if (!forceTimer) { + forceTimer = setTimeout(() => { + try { + signalProcessGroup(child, 'SIGKILL', platform); + } catch { + // A failed final kill is reflected by the bounded supervisor exit, without arguments. + } + drainTimer = setTimeout(() => resolveForcedSettlement({ + exitCode: null, signal: 'SIGKILL', drainTimedOut: true, + }), 1_000); + }, terminationGraceMs); + } + }; + + const signalHandlers = new Map(); + for (const signal of EXIT_FOR_SIGNAL.keys()) { + const handler = () => { + requestedSignal ??= signal; + requestTermination('signal'); + }; + signalHandlers.set(signal, handler); + signalSource.on(signal, handler); + } + + try { + const guardProcessGroup = platform !== 'win32'; + const spawnOptions = { + detached: platform !== 'win32', + shell: false, + windowsHide: true, + stdio: guardProcessGroup + ? ['ignore', 'pipe', 'pipe', 'ipc'] + : ['ignore', 'pipe', 'pipe'], + }; + child = guardProcessGroup + ? spawn(process.execPath, [ + fileURLToPath(import.meta.url), GROUP_GUARD_ARGUMENT, '--', commandId, ...arguments_, + ], spawnOptions) + : spawnTrustedCommand(spawn, commandId, arguments_, spawnOptions); + const processError = new Promise(resolve => { + child.once('error', error => resolve({ operationError: error })); + }); + childClosed = new Promise(resolve => { + child.once('close', (exitCode, signal) => resolve(commandResult ?? { exitCode, signal })); + }); + if (guardProcessGroup) { + child.on('message', message => { + if (message?.type !== GROUP_GUARD_RESULT || commandResult) return; + commandResult = { exitCode: message.exitCode, signal: message.signal }; + commandSpawnFailed = message.spawnError === true; + if (primaryReason) return; + if (commandSpawnFailed) requestTermination('spawn-or-io'); + else if (commandResult.exitCode !== 0 || commandResult.signal) requestTermination('exit'); + else { + // Only success releases the guard. Every failure retains the PGID through SIGKILL. + child.send({ type: GROUP_GUARD_RELEASE }, () => {}); + } + }); + } + child.stdout?.on('data', chunk => appendBounded( + stdoutChunks, chunk, stdoutState, maxOutputBytes, + forwardOutput ? process.stdout : undefined, + )); + child.stderr?.on('data', chunk => appendBounded( + stderrChunks, chunk, stderrState, maxOutputBytes, + forwardOutput ? process.stderr : undefined, + )); + + onSpawn?.(child); + if (primaryReason) signalProcessGroup(child, 'SIGTERM', platform); + timeout = setTimeout(() => requestTermination('timeout'), timeoutMs); + const settlement = await Promise.race([ + childClosed, processError, forcedSettlement, + ]) + .finally(() => clearTimeout(timeout)); + if ('operationError' in settlement) throw settlement.operationError; + const result = settlement; + if (forceTimer) clearTimeout(forceTimer); + if (drainTimer) clearTimeout(drainTimer); + if (result.drainTimedOut) { + try { child.disconnect?.(); } catch { /* The IPC channel may already be closed. */ } + child.channel?.unref?.(); + child.stdout?.destroy(); + child.stderr?.destroy(); + child.unref(); + } + + const completed = { + ...result, + stdout: Buffer.concat(stdoutChunks).toString('utf8'), + stderr: Buffer.concat(stderrChunks).toString('utf8'), + stdoutTruncated: stdoutState.truncated, + stderrTruncated: stderrState.truncated, + requestedSignal, + }; + if (primaryReason) throw new BoundedProcessError(primaryReason, completed); + if (result.exitCode !== 0) throw new BoundedProcessError('exit', completed); + return completed; + } catch (error) { + if (child?.pid && !primaryReason) requestTermination('spawn-or-io'); + if (child?.pid && childClosed && forceTimer) { + // The guard ignores TERM, so this settles only after SIGKILL or the final drain bound. + await Promise.race([childClosed, forcedSettlement]); + } + if (error instanceof BoundedProcessError) throw error; + throw new BoundedProcessError('spawn-or-io', { cause: error }); + } finally { + if (timeout) clearTimeout(timeout); + if (forceTimer) clearTimeout(forceTimer); + if (drainTimer) clearTimeout(drainTimer); + for (const [signal, handler] of signalHandlers) signalSource.off(signal, handler); + } +}; + +const parseCli = argv => { + const separator = argv.indexOf('--'); + if (separator < 0 || separator === argv.length - 1) throw new Error('invalid-cli'); + const options = argv.slice(0, separator); + const command = argv.slice(separator + 1); + const parsed = { + timeoutMs: undefined, + terminationGraceMs: 5_000, + maxOutputBytes: DEFAULT_MAX_OUTPUT_BYTES, + forwardOutput: false, + stdoutFile: undefined, + }; + for (let index = 0; index < options.length; index += 2) { + const option = options[index]; + const value = options[index + 1]; + if (value === undefined) throw new Error('invalid-cli'); + if (option === '--timeout-ms') parsed.timeoutMs = Number(value); + else if (option === '--termination-grace-ms') parsed.terminationGraceMs = Number(value); + else if (option === '--max-output-bytes') parsed.maxOutputBytes = Number(value); + else if (option === '--forward-output') parsed.forwardOutput = value === 'true'; + else if (option === '--stdout-file') parsed.stdoutFile = value; + else throw new Error('invalid-cli'); + } + return { ...parsed, executable: command[0], arguments: command.slice(1) }; +}; + +const isMain = process.argv[1] && fileURLToPath(import.meta.url) === process.argv[1]; +if (isMain) { + if (process.argv[2] === GROUP_GUARD_ARGUMENT) { + await runProcessGroupGuard(process.argv.slice(3)); + } else try { + const options = parseCli(process.argv.slice(2)); + const result = await runBoundedProcess(options); + if (options.stdoutFile) { + await writeFile(options.stdoutFile, result.stdout, { encoding: 'utf8', mode: 0o600 }); + } + } catch (error) { + if (error instanceof BoundedProcessError && error.reason === 'timeout') { + process.stderr.write('Bounded Darwin operation timed out.\n'); + process.exitCode = 124; + } else if (error instanceof BoundedProcessError && error.reason === 'signal') { + process.exitCode = EXIT_FOR_SIGNAL.get(error.result?.requestedSignal) ?? 1; + } else { + process.stderr.write('Bounded Darwin operation failed.\n'); + process.exitCode = error instanceof BoundedProcessError && error.reason === 'exit' + ? (error.result.exitCode ?? 1) : 1; + } + } +} diff --git a/apps/desktop/scripts/run-bounded-darwin-command.test.mjs b/apps/desktop/scripts/run-bounded-darwin-command.test.mjs new file mode 100644 index 000000000..bef1a5db2 --- /dev/null +++ b/apps/desktop/scripts/run-bounded-darwin-command.test.mjs @@ -0,0 +1,283 @@ +import assert from 'node:assert/strict'; +import { execFile as nodeExecFile } from 'node:child_process'; +import { chmod, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { dirname, join } from 'node:path'; +import { test } from 'node:test'; +import { setTimeout as delay } from 'node:timers/promises'; +import { fileURLToPath } from 'node:url'; +import { BoundedProcessError, runBoundedProcess } from './run-bounded-darwin-command.mjs'; + +const helperPath = join(dirname(fileURLToPath(import.meta.url)), 'run-bounded-darwin-command.mjs'); + +const waitForProcessExit = async processId => { + for (let attempt = 0; attempt < 50; attempt += 1) { + try { + process.kill(processId, 0); + if (process.platform === 'linux') { + const processState = (await readFile(`/proc/${processId}/stat`, 'utf8')).split(' ')[2]; + if (processState === 'Z') return; + } + await delay(20); + } catch (error) { + if (error?.code === 'ESRCH') return; + throw error; + } + } + assert.fail('timed-out descendant process remained alive'); +}; + +test('bounds output while continuously draining both child streams', async () => { + const result = await runBoundedProcess({ + executable: process.execPath, + arguments: ['-e', 'process.stdout.write("A".repeat(8192)); process.stderr.write("B".repeat(8192));'], + timeoutMs: 2_000, + terminationGraceMs: 100, + maxOutputBytes: 1_024, + }); + assert.equal(Buffer.byteLength(result.stdout), 1_024); + assert.equal(Buffer.byteLength(result.stderr), 1_024); + assert.equal(result.stdoutTruncated, true); + assert.equal(result.stderrTruncated, true); +}); + +test('timeout terminates the owned process group including a descendant', async () => { + const fixtureRoot = await mkdtemp(join(tmpdir(), 'propr-darwin-bound-')); + const descendantPidPath = join(fixtureRoot, 'descendant.pid'); + try { + await assert.rejects(runBoundedProcess({ + executable: process.execPath, + arguments: ['-e', [ + 'const { spawn } = require("node:child_process");', + 'const { writeFileSync } = require("node:fs");', + 'const child = spawn(process.execPath, ["-e", "setInterval(() => {}, 1000)"], { stdio: "ignore" });', + 'writeFileSync(process.argv[1], String(child.pid));', + 'setInterval(() => {}, 1000);', + ].join(' '), descendantPidPath], + timeoutMs: 300, + terminationGraceMs: 100, + maxOutputBytes: 1_024, + }), error => error instanceof BoundedProcessError && error.reason === 'timeout'); + const descendantPid = Number(await readFile(descendantPidPath, 'utf8')); + assert.ok(Number.isInteger(descendantPid) && descendantPid > 0); + await waitForProcessExit(descendantPid); + } finally { + await rm(fixtureRoot, { recursive: true, force: true }); + } +}); + +test('SIGKILL escalation survives leader close and removes a TERM-ignoring descendant', async () => { + const fixtureRoot = await mkdtemp(join(tmpdir(), 'propr-darwin-escalation-')); + const descendantPidPath = join(fixtureRoot, 'descendant.pid'); + try { + await assert.rejects(runBoundedProcess({ + executable: process.execPath, + arguments: ['-e', [ + 'const { spawn } = require("node:child_process");', + 'process.on("SIGTERM", () => process.exit(0));', + 'spawn(process.execPath, ["-e", [', + ' "const { writeFileSync } = require(\\"node:fs\\");",', + ' "process.on(\\"SIGTERM\\", () => {});",', + ' "writeFileSync(process.argv[1], String(process.pid));",', + ' "setInterval(() => {}, 1000);",', + '].join(" "), process.argv[1]], { stdio: "ignore" });', + 'setInterval(() => {}, 1000);', + ].join(' '), descendantPidPath], + timeoutMs: 500, + terminationGraceMs: 150, + maxOutputBytes: 1_024, + }), error => error instanceof BoundedProcessError + && error.reason === 'timeout' + && error.result.exitCode === 0); + const descendantPid = Number(await readFile(descendantPidPath, 'utf8')); + assert.ok(Number.isInteger(descendantPid) && descendantPid > 0); + await waitForProcessExit(descendantPid); + } finally { + await rm(fixtureRoot, { recursive: true, force: true }); + } +}); + +test('timeout remains primary while TERM runs the wrapper cleanup', async () => { + const fixtureRoot = await mkdtemp(join(tmpdir(), 'propr-darwin-cleanup-')); + const cleanupPath = join(fixtureRoot, 'cleanup.txt'); + try { + await assert.rejects(runBoundedProcess({ + executable: '/bin/bash', + arguments: ['-c', [ + 'trap \"printf CLEANED > \\\"$1\\\"; exit 143\" TERM', + 'sleep 30 &', + 'wait', + ].join('\n'), 'bash', cleanupPath], + timeoutMs: 300, + terminationGraceMs: 1_000, + maxOutputBytes: 1_024, + }), error => error instanceof BoundedProcessError + && error.reason === 'timeout' + && error.result.exitCode === 143); + assert.equal(await readFile(cleanupPath, 'utf8'), 'CLEANED'); + } finally { + await rm(fixtureRoot, { recursive: true, force: true }); + } +}); + +test('a command failure is not replaced by timeout or cleanup status', async () => { + const fixtureRoot = await mkdtemp(join(tmpdir(), 'propr-darwin-primary-')); + const cleanupPath = join(fixtureRoot, 'cleanup.txt'); + try { + await assert.rejects(runBoundedProcess({ + executable: '/bin/bash', + arguments: ['-c', 'trap \"printf CLEANED > \\\"$1\\\"\" EXIT; exit 23', 'bash', cleanupPath], + timeoutMs: 2_000, + terminationGraceMs: 100, + maxOutputBytes: 1_024, + }), error => error instanceof BoundedProcessError + && error.reason === 'exit' + && error.result.exitCode === 23); + assert.equal(await readFile(cleanupPath, 'utf8'), 'CLEANED'); + } finally { + await rm(fixtureRoot, { recursive: true, force: true }); + } +}); + +test('nonzero exit escalates against a TERM-ignoring descendant before releasing the guard', async () => { + const fixtureRoot = await mkdtemp(join(tmpdir(), 'propr-darwin-nonzero-')); + const descendantPidPath = join(fixtureRoot, 'descendant.pid'); + try { + await assert.rejects(runBoundedProcess({ + executable: process.execPath, + arguments: ['-e', [ + 'const { existsSync } = require("node:fs");', + 'const { spawn } = require("node:child_process");', + 'spawn(process.execPath, ["-e", [', + ' "const { writeFileSync } = require(\\"node:fs\\");",', + ' "process.on(\\"SIGTERM\\", () => {});",', + ' "writeFileSync(process.argv[1], String(process.pid));",', + ' "setInterval(() => {}, 1000);",', + '].join(" "), process.argv[1]], { stdio: "ignore" });', + 'const waitState = new Int32Array(new SharedArrayBuffer(4));', + 'const deadline = Date.now() + 1000;', + 'while (!existsSync(process.argv[1]) && Date.now() < deadline) Atomics.wait(waitState, 0, 0, 10);', + 'process.exit(existsSync(process.argv[1]) ? 23 : 24);', + ].join(' '), descendantPidPath], + timeoutMs: 2_000, + terminationGraceMs: 150, + maxOutputBytes: 1_024, + }), error => error instanceof BoundedProcessError + && error.reason === 'exit' + && error.result.exitCode === 23); + const descendantPid = Number(await readFile(descendantPidPath, 'utf8')); + assert.ok(Number.isInteger(descendantPid) && descendantPid > 0); + await waitForProcessExit(descendantPid); + } finally { + await rm(fixtureRoot, { recursive: true, force: true }); + } +}); + +test('rejects executable substitution before creating a child process', async () => { + let spawnCalled = false; + await assert.rejects(runBoundedProcess({ + executable: join(tmpdir(), 'propr-command-that-does-not-exist'), + timeoutMs: 2_000, + terminationGraceMs: 100, + maxOutputBytes: 1_024, + spawn: () => { + spawnCalled = true; + throw new Error('unexpected-spawn'); + }, + }), error => error instanceof BoundedProcessError + && error.reason === 'invalid-input'); + assert.equal(spawnCalled, false); +}); + +test('passes shell metacharacters as one inert argument', async () => { + const fixtureRoot = await mkdtemp(join(tmpdir(), 'propr-darwin-metacharacters-')); + const injectedPath = join(fixtureRoot, 'injected.txt'); + const argument = `; touch ${injectedPath}; $(printf injected) &`; + try { + const result = await runBoundedProcess({ + executable: process.execPath, + arguments: ['-e', 'process.stdout.write(process.argv[1])', argument], + timeoutMs: 2_000, + terminationGraceMs: 100, + maxOutputBytes: 1_024, + }); + assert.equal(result.stdout, argument); + await assert.rejects(readFile(injectedPath, 'utf8'), { code: 'ENOENT' }); + } finally { + await rm(fixtureRoot, { recursive: true, force: true }); + } +}); + +test('CLI command selection ignores PATH and rejects non-allowlisted executables', async () => { + const fixtureRoot = await mkdtemp(join(tmpdir(), 'propr-darwin-environment-')); + const fakeNodePath = join(fixtureRoot, 'node'); + const maliciousMarker = join(fixtureRoot, 'malicious.txt'); + const intendedMarker = join(fixtureRoot, 'intended.txt'); + const substitutedExecutable = join(fixtureRoot, 'substituted'); + try { + await writeFile(fakeNodePath, [ + `#!${process.execPath}`, + `require('node:fs').writeFileSync(${JSON.stringify(maliciousMarker)}, 'MALICIOUS');`, + ].join('\n'), { mode: 0o700 }); + await chmod(fakeNodePath, 0o700); + + await new Promise((resolve, reject) => { + nodeExecFile(process.execPath, [ + helperPath, + '--timeout-ms', '2000', + '--termination-grace-ms', '100', + '--max-output-bytes', '1024', + '--forward-output', 'false', + '--', 'node', '-e', + `require('node:fs').writeFileSync(${JSON.stringify(intendedMarker)}, 'INTENDED')`, + ], { env: { ...process.env, PATH: fixtureRoot } }, error => { + if (error) reject(error); + else resolve(); + }); + }); + assert.equal(await readFile(intendedMarker, 'utf8'), 'INTENDED'); + await assert.rejects(readFile(maliciousMarker, 'utf8'), { code: 'ENOENT' }); + + await writeFile(substitutedExecutable, `#!${process.execPath}\n`, { mode: 0o700 }); + await assert.rejects(new Promise((resolve, reject) => { + nodeExecFile(process.execPath, [ + helperPath, + '--timeout-ms', '2000', + '--', substitutedExecutable, + ], { env: { ...process.env, PATH: fixtureRoot } }, (error, stdout, stderr) => { + if (error) reject(Object.assign(error, { stdout, stderr })); + else resolve(); + }); + }), error => { + assert.equal(error.code, 1); + assert.equal(error.stdout, ''); + assert.equal(error.stderr, 'Bounded Darwin operation failed.\n'); + return true; + }); + } finally { + await rm(fixtureRoot, { recursive: true, force: true }); + } +}); + +test('CLI timeout diagnostics never echo command arguments or secret values', async () => { + const secretArgument = 'DO_NOT_PRINT_THIS_SECRET'; + await assert.rejects(new Promise((resolve, reject) => { + nodeExecFile(process.execPath, [ + helperPath, + '--timeout-ms', '200', + '--termination-grace-ms', '100', + '--max-output-bytes', '1024', + '--forward-output', 'false', + '--', process.execPath, '-e', 'setInterval(() => {}, 1000)', secretArgument, + ], { encoding: 'utf8', timeout: 2_000 }, (error, stdout, stderr) => { + if (error) reject(Object.assign(error, { stdout, stderr })); + else resolve(); + }); + }), error => { + assert.equal(error.code, 124); + assert.equal(error.stdout, ''); + assert.equal(error.stderr, 'Bounded Darwin operation timed out.\n'); + assert.doesNotMatch(`${error.stdout}${error.stderr}`, new RegExp(secretArgument, 'u')); + return true; + }); +}); diff --git a/apps/desktop/scripts/run-native-durability.mjs b/apps/desktop/scripts/run-native-durability.mjs new file mode 100644 index 000000000..c4a5e1832 --- /dev/null +++ b/apps/desktop/scripts/run-native-durability.mjs @@ -0,0 +1,128 @@ +import { spawn } from 'node:child_process'; +import { fileURLToPath } from 'node:url'; + +const EXPECTED = Object.freeze({ + 'credential-service': 72, + 'profile-store': 37, + 'pairing-shutdown': 10, + 'pairing-browser': 1, +}); +const expectedTotal = Object.values(EXPECTED).reduce((total, count) => total + count, 0); +const tsxCli = fileURLToPath(import.meta.resolve('tsx/cli')); +const child = spawn(process.execPath, [ + tsxCli, + '--test', + '--test-concurrency=1', + 'src/profile-store.test.ts', + 'src/credential-service.test.ts', + 'src/pairing-response-lifecycle.test.ts', + 'src/credential-service.pairing-browser.test.ts', +], { + cwd: fileURLToPath(new URL('..', import.meta.url)), + env: process.env, + stdio: ['inherit', 'pipe', 'pipe'], +}); + +let output = ''; +const forward = (stream, destination) => { + stream.setEncoding('utf8'); + stream.on('data', chunk => { + output += chunk; + destination.write(chunk); + }); +}; +forward(child.stdout, process.stdout); +forward(child.stderr, process.stderr); + +const result = await new Promise((resolve, reject) => { + child.once('error', reject); + // close fires only after both TAP pipes are drained; exit can race the final + // summary on Windows and would make a complete run look like setup failure. + child.once('close', (code, signal) => resolve({ code, signal })); +}); + +const plannedForSuite = (suiteName) => { + const escaped = suiteName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); + const match = output.match(new RegExp( + `# Subtest: ${escaped}[\\s\\S]*?\\n 1\\.\\.(\\d+)\\n(?:ok|not ok) \\d+ - ${escaped}`, + )); + return match ? Number(match[1]) : 0; +}; + +const executed = { + 'credential-service': plannedForSuite('main-process desktop credential service'), + 'profile-store': plannedForSuite('desktop profile store'), + 'pairing-shutdown': plannedForSuite('desktop pairing service IPC native shutdown lifecycle'), + 'pairing-browser': plannedForSuite('DesktopCredentialService pairing browser sink'), +}; +const reportedCategory = (category) => { + const match = output.match(new RegExp( + `NATIVE_CATEGORY ${category} expected=(\\d+) executed=(\\d+)`, + )); + return match ? { expected: Number(match[1]), executed: Number(match[2]) } : { expected: -1, executed: -1 }; +}; +const countedCategory = (category, expected) => ({ + expected, + executed: output.match(new RegExp(`NATIVE_SCENARIO ${category}`, 'g'))?.length ?? 0, +}); +const pairingShutdownCategory = category => ({ + expected: 1, + executed: output.match(new RegExp(`NATIVE_PAIRING_SHUTDOWN ${category}(?:\\r?\\n|$)`, 'g'))?.length ?? 0, +}); +const scenarioCategories = { + barriers: reportedCategory('barriers'), + 'transaction-boundaries': reportedCategory('transaction-boundaries'), + 'bootstrap-migration': reportedCategory('bootstrap-migration'), + 'verified-handle-swap': reportedCategory('verified-handle-swap'), + 'reordered-visibility': reportedCategory('reordered-visibility'), + 'mirror-repair': countedCategory('mirror-repair', 6), + 'revocation-crash': countedCategory('revocation-crash', 2), + 'cancellation-switch': countedCategory('cancellation-switch', 4), + 'detach-crash': countedCategory('detach-crash', process.platform === 'win32' ? 12 : 13), + 'transient-revocation': countedCategory('transient-revocation', 4), + provisional: countedCategory('provisional', 1), + delivery: countedCategory('delivery', 1), + dispose: countedCategory('dispose', 1), + 'start-header': pairingShutdownCategory('start-header'), + 'start-body': pairingShutdownCategory('start-body'), + 'poll-header': pairingShutdownCategory('poll-header'), + 'poll-body': pairingShutdownCategory('poll-body'), + 'activate-header': pairingShutdownCategory('activate-header'), + 'activate-body': pairingShutdownCategory('activate-body'), + 'cancel-header': pairingShutdownCategory('cancel-header'), + 'cancel-body': pairingShutdownCategory('cancel-body'), + 'never-settling-reader-cancel': pairingShutdownCategory('never-settling-reader-cancel'), + 'never-settling-body-cancel': pairingShutdownCategory('never-settling-body-cancel'), +}; +const summary = Object.fromEntries( + ['tests', 'pass', 'fail', 'cancelled', 'skipped'].map(key => { + const match = output.match(new RegExp(`^# ${key} (\\d+)$`, 'm')); + return [key, match ? Number(match[1]) : -1]; + }), +); + +for (const [category, expected] of Object.entries(EXPECTED)) { + console.log(`Native durability category ${category}: expected=${expected} executed=${executed[category]}`); +} +for (const [category, counts] of Object.entries(scenarioCategories)) { + console.log(`Native durability category ${category}: expected=${counts.expected} executed=${counts.executed}`); +} +console.log( + `Native durability total: expected=${expectedTotal} executed=${summary.tests} ` + + `passed=${summary.pass} failed=${summary.fail} cancelled=${summary.cancelled} skipped=${summary.skipped}`, +); + +const complete = Object.entries(EXPECTED).every(([category, expected]) => executed[category] === expected) + && Object.values(scenarioCategories).every(({ expected, executed }) => expected >= 0 && executed === expected) + && summary.tests === expectedTotal + && summary.pass === expectedTotal + && summary.fail === 0 + && summary.cancelled === 0 + && summary.skipped === 0 + && result.code === 0 + && result.signal === null; +if (!complete) { + throw new Error( + `Native durability matrix incomplete (child code=${String(result.code)}, signal=${String(result.signal)})`, + ); +} diff --git a/apps/desktop/scripts/run-packaged-darwin-connect-smoke.sh b/apps/desktop/scripts/run-packaged-darwin-connect-smoke.sh new file mode 100644 index 000000000..955bfbfdb --- /dev/null +++ b/apps/desktop/scripts/run-packaged-darwin-connect-smoke.sh @@ -0,0 +1,260 @@ +#!/bin/bash + +set -euo pipefail + +if [[ "$(uname -s)" != 'Darwin' ]]; then + echo 'Packaged Darwin Connect acceptance requires macOS.' >&2 + exit 1 +fi + +architecture="${1:-}" +if [[ "$architecture" != 'arm64' && "$architecture" != 'x64' ]]; then + echo 'Packaged Darwin Connect acceptance requires an explicit supported architecture.' >&2 + exit 1 +fi + +script_directory="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)" +repository_root="$(cd "$script_directory/../../.." && pwd -P)" +application="$repository_root/apps/desktop/out/propr-desktop-darwin-$architecture/propr-desktop.app" +signature_verifier="$script_directory/verify-darwin-packaged-connect-signature.mjs" +application_signer="$script_directory/sign-darwin-packaged-connect.mjs" +bounded_runner="$script_directory/run-bounded-darwin-command.mjs" +if [[ ! -d "$application" || ! -f "$signature_verifier" || ! -f "$application_signer" + || ! -f "$bounded_runner" ]]; then + echo 'Packaged Darwin Connect acceptance artifact is missing.' >&2 + exit 1 +fi +cd "$repository_root" + +readonly COMMAND_TIMEOUT_MS=30000 +readonly CLEANUP_TIMEOUT_MS=10000 +readonly SIGNING_TIMEOUT_MS=180000 +readonly JOURNEY_TIMEOUT_MS=240000 +readonly TERMINATION_GRACE_MS=5000 +readonly MAX_OUTPUT_BYTES=262144 + +stage_marker() { + local stage="$1" + local code="$2" + case "$stage" in + KEY_CERTIFICATE_GENERATION|KEYCHAIN_CREATION_SELECTION|IDENTITY_IMPORT|PARTITION_LIST_UPDATE|APPLICATION_SIGNING|INITIAL_SIGNATURE_VERIFICATION|PAIR_REPROBE_JOURNEY|STABLE_SIGNATURE_VERIFICATION|KEYCHAIN_RESTORATION_DELETION|TEMPORARY_FILE_CLEANUP) ;; + *) return 1 ;; + esac + case "$code" in + STARTED|PASSED|FAILED) ;; + *) return 1 ;; + esac + printf 'DARWIN_PACKAGED_CONNECT_SETUP:%s:%s\n' "$stage" "$code" +} + +run_bounded() { + local timeout_ms="$1" + shift + node "$bounded_runner" --timeout-ms "$timeout_ms" \ + --termination-grace-ms "$TERMINATION_GRACE_MS" \ + --max-output-bytes "$MAX_OUTPUT_BYTES" --forward-output false -- "$@" +} + +run_bounded_forward() { + local timeout_ms="$1" + shift + node "$bounded_runner" --timeout-ms "$timeout_ms" \ + --termination-grace-ms "$TERMINATION_GRACE_MS" \ + --max-output-bytes "$MAX_OUTPUT_BYTES" --forward-output true -- "$@" +} + +run_stage() { + local stage="$1" + shift + active_stage="$stage" + stage_marker "$stage" STARTED + if "$@"; then + stage_marker "$stage" PASSED + active_stage='' + return 0 + else + local stage_status=$? + stage_marker "$stage" FAILED + active_stage='' + return "$stage_status" + fi +} + +umask 077 +keychain_root='' +keychain_path='' +leaf_private_key='' +leaf_certificate='' +identity_archive='' +leaf_config='' +requirement_proof='' +identity_sha1='' +original_default='' +original_keychains=() +keychain_created=0 +keychain_state_captured=0 +active_stage='' + +restore_and_delete_keychain() { + local restore_status=0 + if (( keychain_state_captured != 0 )); then + if (( ${#original_keychains[@]} > 0 )); then + run_bounded "$CLEANUP_TIMEOUT_MS" /usr/bin/security list-keychains -d user -s \ + "${original_keychains[@]}" || restore_status=1 + else + run_bounded "$CLEANUP_TIMEOUT_MS" /usr/bin/security list-keychains -d user -s \ + || restore_status=1 + fi + if [[ -n "$original_default" ]]; then + run_bounded "$CLEANUP_TIMEOUT_MS" /usr/bin/security default-keychain -d user -s \ + "$original_default" || restore_status=1 + fi + fi + if (( keychain_created != 0 )); then + run_bounded "$CLEANUP_TIMEOUT_MS" /usr/bin/security delete-keychain "$keychain_path" \ + || restore_status=1 + fi + return "$restore_status" +} + +remove_temporary_files() { + if [[ -z "$keychain_root" ]]; then return 0; fi + run_bounded "$CLEANUP_TIMEOUT_MS" /bin/rm -rf -- "$keychain_root" +} + +cleanup_keychain() { + local primary_status=$? + local cleanup_status=0 + trap - EXIT HUP INT TERM + set +e + run_stage KEYCHAIN_RESTORATION_DELETION restore_and_delete_keychain || cleanup_status=1 + run_stage TEMPORARY_FILE_CLEANUP remove_temporary_files || cleanup_status=1 + unset keychain_password identity_password + if (( cleanup_status != 0 )); then + echo 'Packaged Darwin Connect acceptance cleanup failed.' >&2 + if (( primary_status == 0 )); then primary_status=1; fi + fi + exit "$primary_status" +} + +exit_for_signal() { + local exit_code="$1" + if [[ -n "$active_stage" ]]; then + stage_marker "$active_stage" FAILED + active_stage='' + fi + exit "$exit_code" +} +trap cleanup_keychain EXIT +trap 'exit_for_signal 129' HUP +trap 'exit_for_signal 130' INT +trap 'exit_for_signal 143' TERM + +create_and_select_keychain() { + local original_keychain_output + original_keychain_output="$(run_bounded_forward "$COMMAND_TIMEOUT_MS" \ + /usr/bin/security list-keychains -d user)" || return $? + while IFS= read -r keychain; do + keychain="${keychain#"${keychain%%[![:space:]]*}"}" + keychain="${keychain#\"}" + keychain="${keychain%\"}" + if [[ -n "$keychain" ]]; then original_keychains+=("$keychain"); fi + done <<< "$original_keychain_output" + original_default="$(run_bounded_forward "$COMMAND_TIMEOUT_MS" \ + /usr/bin/security default-keychain -d user)" || return $? + original_default="${original_default#"${original_default%%[![:space:]]*}"}" + original_default="${original_default#\"}" + original_default="${original_default%\"}" + keychain_state_captured=1 + run_bounded "$COMMAND_TIMEOUT_MS" /usr/bin/security create-keychain \ + -p "$keychain_password" "$keychain_path" || return $? + keychain_created=1 + run_bounded "$COMMAND_TIMEOUT_MS" /usr/bin/security set-keychain-settings \ + -lut 21600 "$keychain_path" || return $? + run_bounded "$COMMAND_TIMEOUT_MS" /usr/bin/security unlock-keychain \ + -p "$keychain_password" "$keychain_path" || return $? + run_bounded "$COMMAND_TIMEOUT_MS" /usr/bin/security list-keychains \ + -d user -s "$keychain_path" || return $? + run_bounded "$COMMAND_TIMEOUT_MS" /usr/bin/security default-keychain \ + -d user -s "$keychain_path" +} + +generate_key_and_certificates() { + local fingerprint_output + keychain_root="$(run_bounded_forward "$COMMAND_TIMEOUT_MS" /usr/bin/mktemp -d)" || return $? + [[ -n "$keychain_root" ]] || return 1 + keychain_path="$keychain_root/propr-packaged-connect-smoke.keychain-db" + leaf_private_key="$keychain_root/leaf-private.pem" + leaf_certificate="$keychain_root/leaf-certificate.pem" + identity_archive="$keychain_root/identity.p12" + leaf_config="$keychain_root/leaf.cnf" + requirement_proof="$keychain_root/designated-requirement.txt" + keychain_password="$(run_bounded_forward "$COMMAND_TIMEOUT_MS" \ + /usr/bin/openssl rand -hex 32)" || return $? + identity_password="$(run_bounded_forward "$COMMAND_TIMEOUT_MS" \ + /usr/bin/openssl rand -hex 32)" || return $? + builtin printf '%s\n' '[req]' 'distinguished_name = leaf_name' \ + 'x509_extensions = leaf_extensions' 'prompt = no' '' '[leaf_name]' \ + 'CN = ProPR Packaged Connect CI' '' '[leaf_extensions]' \ + 'basicConstraints = critical,CA:FALSE' 'keyUsage = critical,digitalSignature' \ + 'extendedKeyUsage = critical,codeSigning' 'subjectKeyIdentifier = hash' \ + 'authorityKeyIdentifier = keyid:always,issuer' > "$leaf_config" || return $? + + # A self-signed leaf makes the disposable PKCS#12 chain complete without modifying trust. + run_bounded "$COMMAND_TIMEOUT_MS" /usr/bin/openssl req -new -x509 -newkey rsa:2048 \ + -sha256 -nodes -days 1 -config "$leaf_config" -keyout "$leaf_private_key" \ + -out "$leaf_certificate" || return $? + run_bounded "$COMMAND_TIMEOUT_MS" /usr/bin/openssl pkcs12 -export \ + -inkey "$leaf_private_key" -in "$leaf_certificate" -out "$identity_archive" \ + -passout "pass:$identity_password" || return $? + fingerprint_output="$(run_bounded_forward "$COMMAND_TIMEOUT_MS" /usr/bin/openssl x509 \ + -in "$leaf_certificate" -noout -fingerprint -sha1)" || return $? + identity_sha1="${fingerprint_output##*=}" + identity_sha1="${identity_sha1//:/}" + if [[ ! "$identity_sha1" =~ ^[A-F0-9]{40}$ ]]; then + echo 'Disposable Darwin signing certificate fingerprint is invalid.' >&2 + return 1 + fi +} + +import_identity() { + run_bounded "$COMMAND_TIMEOUT_MS" /usr/bin/security import "$identity_archive" \ + -k "$keychain_path" -P "$identity_password" -T /usr/bin/codesign +} + +update_partition_list() { + run_bounded "$COMMAND_TIMEOUT_MS" /usr/bin/security set-key-partition-list \ + -S apple-tool:,apple:,codesign: -s -k "$keychain_password" "$keychain_path" +} + +sign_application() { + run_bounded_forward "$SIGNING_TIMEOUT_MS" node "$application_signer" \ + "$application" "$keychain_path" "$identity_sha1" +} + +verify_initial_signature() { + run_bounded_forward "$COMMAND_TIMEOUT_MS" node "$signature_verifier" establish \ + "$application" "$identity_sha1" "$requirement_proof" "$keychain_path" +} + +run_pair_and_reprobe() { + ( + cd "$repository_root/apps/desktop" || exit 1 + run_bounded_forward "$JOURNEY_TIMEOUT_MS" node "$script_directory/smoke-packaged-connect.mjs" + ) +} + +verify_stable_signature() { + run_bounded_forward "$COMMAND_TIMEOUT_MS" node "$signature_verifier" stable \ + "$application" "$identity_sha1" "$requirement_proof" "$keychain_path" +} + +run_stage KEY_CERTIFICATE_GENERATION generate_key_and_certificates +run_stage KEYCHAIN_CREATION_SELECTION create_and_select_keychain +run_stage IDENTITY_IMPORT import_identity +run_stage PARTITION_LIST_UPDATE update_partition_list +unset keychain_password identity_password +run_stage APPLICATION_SIGNING sign_application +run_stage INITIAL_SIGNATURE_VERIFICATION verify_initial_signature +run_stage PAIR_REPROBE_JOURNEY run_pair_and_reprobe +run_stage STABLE_SIGNATURE_VERIFICATION verify_stable_signature diff --git a/apps/desktop/scripts/run-packaged-windows-connect-smoke.ps1 b/apps/desktop/scripts/run-packaged-windows-connect-smoke.ps1 new file mode 100644 index 000000000..b4d5d1da2 --- /dev/null +++ b/apps/desktop/scripts/run-packaged-windows-connect-smoke.ps1 @@ -0,0 +1,2584 @@ +param( + [Parameter(Mandatory=$true)] + [ValidateSet('x64','arm64')] + [string]$Architecture, + [ValidateSet('none','terminate-tree','cleanup-timeout','diagnostic-subphase','host-node-producer','launcher-authority','capture-parser','capture-redirection')] + [string]$LifecycleTestMode = 'none', + [ValidateRange(0,2147483647)] + [int]$LifecycleTestProcessId = 0, + [ValidateSet( + 'host-node-command-cardinality', + 'host-node-command-type', + 'host-node-source', + 'host-node-path-binding', + 'host-node-launcher-return-authority', + 'host-launcher-native-initialization', + 'host-launcher-selected-path-input', + 'host-launcher-selected-path-extra-colon', + 'host-launcher-selected-path-get-full-path', + 'host-launcher-selected-path-absolute-shape', + 'host-launcher-selected-path-canonical-equality', + 'host-launcher-source-open', + 'host-launcher-source-type', + 'host-launcher-source-identity', + 'host-launcher-source-final-path', + 'host-launcher-final-open', + 'host-launcher-final-type', + 'host-launcher-final-identity', + 'host-launcher-final-path', + 'host-launcher-final-match', + 'host-launcher-source-reopen', + 'host-launcher-source-reopen-type', + 'host-launcher-source-reopen-identity', + 'host-launcher-source-reopen-final-path', + 'host-launcher-source-reopen-match', + 'host-capture-contract', + 'host-staging-handoff' + )] + [string]$DiagnosticTestSubphase = 'host-node-command-cardinality', + [ValidateSet( + 'positive','zero','duplicate','multiple','mixed-types','case-collision', + 'non-application','missing-source','non-scalar-source' + )] + [string]$HostNodeProducerTestCase = 'positive', + [ValidateSet('normal','alias','retarget-alias','identity-mismatch')] + [string]$LauncherAuthorityTestCase = 'normal', + [string]$LauncherAuthorityTestPath = '', + [string]$LauncherAuthorityTestRetargetPath = '', + [string]$CaptureParserTestPath = '', + [ValidateSet( + 'administrators-owner','current-owner','foreign-owner','ordinary-owner', + 'ordinary-write','broad-write','unprotected-dacl','foreign-parent-owner', + 'identity-change','existing' + )] + [string]$CaptureParserAuthorityTestCase = 'existing', + [ValidateSet('success','nonzero','empty','hostile')] + [string]$CaptureRedirectionProducerTestCase = 'success' +) + +$ErrorActionPreference = 'Stop' +$ProgressPreference = 'SilentlyContinue' +$failureCategories = @( + 'artifact-missing', + 'artifact-inaccessible', + 'artifact-type', + 'architecture-mismatch', + 'spawn-failed' +) +$failurePhases = @( + 'source-layout', + 'runner-authority', + 'account-setup', + 'staging-copy', + 'staging-acl', + 'staged-contract', + 'staged-tree', + 'staged-architecture', + 'ordinary-user-preflight', + 'fixture-setup', + 'package-authority', + 'application-spawn', + 'application-runtime', + 'capture-parse', + 'result-verify', + 'cleanup' +) +$hostFailureSubphases = @( + 'host-node-command-cardinality', + 'host-node-command-type', + 'host-node-source', + 'host-node-path-binding', + 'host-node-launcher-return-authority', + 'host-launcher-native-initialization', + 'host-launcher-selected-path-input', + 'host-launcher-selected-path-extra-colon', + 'host-launcher-selected-path-get-full-path', + 'host-launcher-selected-path-absolute-shape', + 'host-launcher-selected-path-canonical-equality', + 'host-launcher-source-open', + 'host-launcher-source-type', + 'host-launcher-source-identity', + 'host-launcher-source-final-path', + 'host-launcher-final-open', + 'host-launcher-final-type', + 'host-launcher-final-identity', + 'host-launcher-final-path', + 'host-launcher-final-match', + 'host-launcher-source-reopen', + 'host-launcher-source-reopen-type', + 'host-launcher-source-reopen-identity', + 'host-launcher-source-reopen-final-path', + 'host-launcher-source-reopen-match', + 'host-capture-contract', + 'host-staging-handoff', + 'host-state-contract' +) +$childFailureSubphases = @( + 'preflight-invocation', + 'descendant-enumeration', + 'executable-read', + 'unexpected-exit', + 'authority-contract' +) +$childStagedContractSubphases = @( + 'runner-temp-input-shape', + 'staging-parent-input-shape', + 'parent-to-runner-binding', + 'fixed-parent-leaf', + 'generated-stage-leaf', + 'derived-root-to-parent-binding' +) +$captureParseSubphases = @( + 'capture-authority', + 'capture-size', + 'capture-read', + 'capture-utf8', + 'capture-json', + 'capture-line-cardinality', + 'capture-event-cardinality', + 'capture-schema-cardinality', + 'capture-lifecycle-category', + 'capture-lifecycle-phase', + 'capture-lifecycle-subphase', + 'capture-redaction' +) +$captureAuthorityPredicates = @( + 'parent-owner', + 'capture-owner', + 'dacl-canonicality', + 'unauthorized-writer', + 'link-path-type', + 'identity-replacement', + 'pre-create', + 'redirect-open', + 'redirect-timeout', + 'redirect-child-exit', + 'post-redirection-identity', + 'capture-content', + 'cleanup' +) +$captureProducerExitBuckets = @('zero','forced-23','other') +$captureProducerOutputStates = @('exact-expected','empty','other-bounded') +$captureProducerResultPredicates = @('redirect-child-exit','capture-content') +$lifecycleFailureSubphases = @( + 'fixture-setup', + 'package-validation', + 'lifecycle-internal', + 'spawn-error', + 'output-rejected', + 'ready-validation', + 'timeout-before-ready', + 'child-exit-before-ready', + 'child-exit-after-ready', + 'tree-termination', + 'ready-clean-exit', + 'ready-forced-exit', + 'ready-duplicate', + 'child-remained-alive' +) +$failureSubphases = @( + $hostFailureSubphases + + $childFailureSubphases + + $childStagedContractSubphases + + $captureParseSubphases + + $lifecycleFailureSubphases +) +$applicationTimeoutMilliseconds = 5 * 60 * 1000 +$terminationTimeoutMilliseconds = 30 * 1000 +$cleanupTimeoutMilliseconds = 60 * 1000 +$streamCloseTimeoutMilliseconds = 30 * 1000 +$taskkillExecutable = 'C:\Windows\System32\taskkill.exe' +$primaryFailure = $null +$primaryPhase = $null +$primarySubphase = $null +$failurePhase = 'source-layout' +$failureSubphase = $null +$cleanupSecondary = 'none' +$testUser = $null +$testUserSid = $null +$stageParent = $null +$stageRoot = $null +$stageLeaf = $null +$stdout = $null +$stderr = $null +$stdoutAuthority = $null +$stderrAuthority = $null +$privilegedSid = $null +$launcherAuthority = $null +$plainPassword = $null +$handoffArgument = $null +$captureAuthorityPredicate = $null +$captureProducerResultAttributed = $false +$captureProducerExitBucket = $null +$captureProducerStdoutState = $null +$captureProducerStderrState = $null + +function Stop-PackagedConnect { + param([Parameter(Mandatory=$true)][ValidateSet( + 'artifact-missing','artifact-inaccessible','artifact-type','architecture-mismatch','spawn-failed' + )][string]$Category) + throw [InvalidOperationException]::new("PROPR_PACKAGED_CONNECT_FAILURE:$Category") +} + +function Get-FixedFailureCategory { + param([Parameter(Mandatory=$true)][Exception]$Exception) + if ($Exception.Message -cmatch '^PROPR_PACKAGED_CONNECT_FAILURE:(artifact-missing|artifact-inaccessible|artifact-type|architecture-mismatch|spawn-failed)$') { + return $Matches[1] + } + if ($failurePhase -in @('application-spawn','application-runtime','result-verify')) { + return 'spawn-failed' + } + return 'artifact-inaccessible' +} + +function Set-FailurePhase { + param([Parameter(Mandatory=$true)][string]$Phase) + if ($failurePhases -cnotcontains $Phase) { + throw [InvalidOperationException]::new('invalid-fixed-failure-phase') + } + $script:failurePhase = $Phase + if ($Phase -cnotin @('staged-contract','ordinary-user-preflight','capture-parse','application-runtime')) { + $script:failureSubphase = $null + } +} + +function Set-CaptureParseSubphase { + param([Parameter(Mandatory=$true)][string]$Subphase) + if ($captureParseSubphases -cnotcontains $Subphase) { + throw [InvalidOperationException]::new('invalid-fixed-capture-subphase') + } + $script:failurePhase = 'capture-parse' + $script:failureSubphase = $Subphase +} + +function Set-CaptureAuthorityPredicate { + param([Parameter(Mandatory=$true)][string]$Predicate) + if ($captureAuthorityPredicates -cnotcontains $Predicate) { + throw [InvalidOperationException]::new('invalid-fixed-capture-authority-predicate') + } + $script:captureAuthorityPredicate = $Predicate +} + +function Get-TestOnlyCaptureProducerOutputState { + param( + [Parameter(Mandatory=$true)]$Authority, + [Parameter(Mandatory=$true)] + [Security.Principal.SecurityIdentifier]$CapturePrivilegedSid, + [Parameter(Mandatory=$true)][string]$Expected + ) + if ($LifecycleTestMode -cne 'capture-redirection') { + throw [InvalidOperationException]::new('capture-producer-state-outside-test-mode') + } + $captureReadHandle = $null + try { + $maximumAttributedBytes = 256 + if ($null -eq $Authority -or !($Authority.Path -is [string]) -or + !($Authority.Identity -is [string]) -or + !($Authority.SecurityDescriptor -is [string]) -or + !($Authority.Handle -is [Microsoft.Win32.SafeHandles.SafeFileHandle]) -or + $Authority.Handle.IsInvalid -or $Authority.Handle.IsClosed -or + ![String]::Equals( + [ProprHostLauncherNative]::GetIdentity($Authority.Handle), + $Authority.Identity, + [StringComparison]::Ordinal + )) { + return 'other-bounded' + } + + $captureReadHandle = [ProprHostLauncherNative]::OpenCapture($Authority.Path, $true) + $null = Assert-PrivilegedCaptureFile ` + $Authority.Path $captureReadHandle $CapturePrivilegedSid $Authority.Identity ` + -TestOnlyIdentityPredicate 'capture-content' + Set-CaptureAuthorityPredicate 'capture-content' + if ((Get-CaptureAuthorityDescriptor $Authority.Path) -cne + $Authority.SecurityDescriptor) { + return 'other-bounded' + } + + $state = 'other-bounded' + $length = [ProprHostLauncherNative]::GetLength($captureReadHandle) + if ($length -eq 0) { + $state = 'empty' + } elseif ($length -le $maximumAttributedBytes) { + $bytes = [ProprHostLauncherNative]::ReadBounded( + $captureReadHandle, $maximumAttributedBytes + ) + if ($bytes.Length -eq $length -and + [Text.Encoding]::UTF8.GetString($bytes) -ceq $Expected) { + $state = 'exact-expected' + } + } + + $null = Assert-PrivilegedCaptureFile ` + $Authority.Path $captureReadHandle $CapturePrivilegedSid $Authority.Identity ` + -TestOnlyIdentityPredicate 'capture-content' + Set-CaptureAuthorityPredicate 'capture-content' + if (![String]::Equals( + [ProprHostLauncherNative]::GetIdentity($Authority.Handle), + $Authority.Identity, + [StringComparison]::Ordinal + ) -or (Get-CaptureAuthorityDescriptor $Authority.Path) -cne + $Authority.SecurityDescriptor) { + return 'other-bounded' + } + return $state + } catch {} + finally { + if ($null -ne $captureReadHandle) { + try { $captureReadHandle.Dispose() } catch {} + } + } + return 'other-bounded' +} + +function Set-LifecycleFailureSubphase { + param([Parameter(Mandatory=$true)][string]$Subphase) + if ($lifecycleFailureSubphases -cnotcontains $Subphase) { + throw [InvalidOperationException]::new('invalid-fixed-lifecycle-subphase') + } + $script:failurePhase = 'application-runtime' + $script:failureSubphase = $Subphase +} + +function Set-StagedContractSubphase { + param([Parameter(Mandatory=$true)][string]$Subphase) + if ($childStagedContractSubphases -cnotcontains $Subphase) { + throw [InvalidOperationException]::new('invalid-fixed-failure-subphase') + } + $script:failureSubphase = $Subphase + $script:failurePhase = 'staged-contract' +} + +function Set-OrdinaryUserPreflightSubphase { + param([Parameter(Mandatory=$true)][string]$Subphase) + if ($failureSubphases -cnotcontains $Subphase) { + throw [InvalidOperationException]::new('invalid-fixed-failure-subphase') + } + $script:failureSubphase = $Subphase + $script:failurePhase = 'ordinary-user-preflight' +} + +function Set-PrimaryFailureFromException { + param([Parameter(Mandatory=$true)][Exception]$Exception) + $script:primaryFailure = Get-FixedFailureCategory $Exception + $script:primaryPhase = $failurePhase + $script:primarySubphase = $null + if ($script:primaryPhase -ceq 'ordinary-user-preflight') { + $script:primarySubphase = if ($failureSubphases -ccontains $failureSubphase) { + $failureSubphase + } else { + 'host-state-contract' + } + } elseif ($script:primaryPhase -ceq 'staged-contract' -and + $childStagedContractSubphases -ccontains $failureSubphase) { + $script:primarySubphase = $failureSubphase + } elseif ($script:primaryPhase -ceq 'capture-parse' -and + $captureParseSubphases -ccontains $failureSubphase) { + $script:primarySubphase = $failureSubphase + } elseif ($script:primaryPhase -ceq 'application-runtime' -and + $lifecycleFailureSubphases -ccontains $failureSubphase) { + $script:primarySubphase = $failureSubphase + } +} + +function Get-ValidatedHostNodePath { + param( + [switch]$UseTestOnlyCommandResults, + [AllowNull()][AllowEmptyCollection()][object[]]$TestOnlyCommandResults, + [scriptblock]$TestOnlySourceProducer + ) + Set-OrdinaryUserPreflightSubphase 'host-node-command-cardinality' + if ($UseTestOnlyCommandResults) { + $commandResults = @($TestOnlyCommandResults) + } else { + $commandResults = @( + Get-Command node.exe ` + -CommandType Application ` + -TotalCount 1 ` + -ErrorAction Stop + ) + } + if ($commandResults.Count -ne 1) { + Stop-PackagedConnect 'artifact-type' + } + + Set-OrdinaryUserPreflightSubphase 'host-node-command-type' + $candidate = $commandResults[0] + if (!($candidate -is [System.Management.Automation.ApplicationInfo])) { + Stop-PackagedConnect 'artifact-type' + } + + Set-OrdinaryUserPreflightSubphase 'host-node-source' + if ($null -eq $TestOnlySourceProducer) { + $sourceResults = @($candidate.Source) + } else { + $sourceResults = @(& $TestOnlySourceProducer $candidate) + } + if ($sourceResults.Count -ne 1 -or + !($sourceResults[0] -is [string]) -or + [String]::IsNullOrEmpty($sourceResults[0])) { + Stop-PackagedConnect 'artifact-type' + } + return $sourceResults[0] +} + +function Stop-SpawnedProcess { + param([Parameter(Mandatory=$true)][Diagnostics.Process]$Process) + try { + if ($Process.HasExited) { return } + $processId = $Process.Id + $processIdText = $processId.ToString([Globalization.CultureInfo]::InvariantCulture) + $validatedProcessId = 0 + if ($processIdText -cnotmatch '^[1-9][0-9]{0,9}$' -or + ![Int32]::TryParse( + $processIdText, + [Globalization.NumberStyles]::None, + [Globalization.CultureInfo]::InvariantCulture, + [ref]$validatedProcessId + ) -or $validatedProcessId -ne $processId) { + Stop-PackagedConnect 'spawn-failed' + } + + $taskkillStart = [Diagnostics.ProcessStartInfo]::new() + $taskkillStart.FileName = $taskkillExecutable + $taskkillStart.Arguments = [String]::Join(' ', [string[]]@('/PID', $processIdText, '/T', '/F')) + $taskkillStart.UseShellExecute = $false + $taskkillStart.CreateNoWindow = $true + $taskkillStart.RedirectStandardOutput = $true + $taskkillStart.RedirectStandardError = $true + $taskkillProcess = [Diagnostics.Process]::new() + $taskkillProcess.StartInfo = $taskkillStart + try { + if (!$taskkillProcess.Start()) { Stop-PackagedConnect 'spawn-failed' } + $taskkillOutputClose = $taskkillProcess.StandardOutput.BaseStream.CopyToAsync([IO.Stream]::Null) + $taskkillErrorClose = $taskkillProcess.StandardError.BaseStream.CopyToAsync([IO.Stream]::Null) + if (!$taskkillProcess.WaitForExit($terminationTimeoutMilliseconds)) { + try { $taskkillProcess.Kill() } catch {} + try { $null = $taskkillProcess.WaitForExit($terminationTimeoutMilliseconds) } catch {} + try { + $null = [Threading.Tasks.Task]::WaitAll( + [Threading.Tasks.Task[]]@($taskkillOutputClose, $taskkillErrorClose), + $streamCloseTimeoutMilliseconds + ) + } catch {} + Stop-PackagedConnect 'spawn-failed' + } + if (![Threading.Tasks.Task]::WaitAll( + [Threading.Tasks.Task[]]@($taskkillOutputClose, $taskkillErrorClose), + $streamCloseTimeoutMilliseconds + ) -or $taskkillOutputClose.IsFaulted -or $taskkillErrorClose.IsFaulted -or + $taskkillProcess.ExitCode -ne 0 -or !$Process.WaitForExit($terminationTimeoutMilliseconds) -or + !$Process.HasExited) { + Stop-PackagedConnect 'spawn-failed' + } + } finally { + $taskkillProcess.Dispose() + } + } catch { + if ($_.Exception.Message -clike 'PROPR_PACKAGED_CONNECT_FAILURE:*') { throw } + Stop-PackagedConnect 'spawn-failed' + } +} + +function Get-CanonicalItem { + param( + [Parameter(Mandatory=$true)][string]$Path, + [Parameter(Mandatory=$true)][ValidateSet('directory','file')][string]$Kind + ) + try { + if (![IO.Path]::IsPathRooted($Path) -or [IO.Path]::GetFullPath($Path) -cne $Path) { + Stop-PackagedConnect 'artifact-type' + } + $item = Get-Item -LiteralPath $Path -Force -ErrorAction Stop + } catch [Management.Automation.ItemNotFoundException] { + Stop-PackagedConnect 'artifact-missing' + } catch { + if ($_.Exception.Message -clike 'PROPR_PACKAGED_CONNECT_FAILURE:*') { throw } + Stop-PackagedConnect 'artifact-inaccessible' + } + if (($Kind -eq 'directory') -ne $item.PSIsContainer -or + ($item.Attributes -band [IO.FileAttributes]::ReparsePoint) -ne 0 -or + ![String]::Equals($item.FullName, $Path, [StringComparison]::OrdinalIgnoreCase)) { + Stop-PackagedConnect 'artifact-type' + } + return $item +} + +function Test-ExactJsonProperties { + param( + [AllowNull()][object]$Object, + [Parameter(Mandatory=$true)][string[]]$Expected + ) + if ($null -eq $Object -or $Object -is [Array] -or $Object -is [string] -or + $Object -is [ValueType]) { + return $false + } + $actual = @($Object.PSObject.Properties | ForEach-Object { $_.Name }) + if ($actual.Count -ne $Expected.Count) { return $false } + foreach ($name in $Expected) { + if ($actual -cnotcontains $name) { return $false } + } + return $true +} + +function Test-UniqueJsonPropertyNames { + param([Parameter(Mandatory=$true)][string]$Text) + $objectKeys = [Collections.ArrayList]::new() + $index = 0 + while ($index -lt $Text.Length) { + $character = $Text[$index] + if ($character -ceq '{') { + $keys = [Collections.Generic.HashSet[string]]::new([StringComparer]::Ordinal) + $null = $objectKeys.Add($keys) + $index++ + continue + } + if ($character -ceq '}') { + if ($objectKeys.Count -eq 0) { return $true } + $objectKeys.RemoveAt($objectKeys.Count - 1) + $index++ + continue + } + if ($character -cne '"') { + $index++ + continue + } + $start = $index + 1 + $escaped = $false + $containsEscape = $false + $index++ + while ($index -lt $Text.Length) { + $stringCharacter = $Text[$index] + if ($escaped) { + $escaped = $false + } elseif ($stringCharacter -ceq '\') { + $escaped = $true + $containsEscape = $true + } elseif ($stringCharacter -ceq '"') { + break + } + $index++ + } + if ($index -ge $Text.Length) { return $true } + $end = $index + $lookahead = $index + 1 + while ($lookahead -lt $Text.Length -and [Char]::IsWhiteSpace($Text[$lookahead])) { + $lookahead++ + } + if ($lookahead -lt $Text.Length -and $Text[$lookahead] -ceq ':') { + if ($objectKeys.Count -eq 0 -or $containsEscape) { return $false } + $propertyName = $Text.Substring($start, $end - $start) + $keys = $objectKeys[$objectKeys.Count - 1] + if (!$keys.Add($propertyName)) { return $false } + } + $index++ + } + return $true +} + +function Assert-CaptureAuthorityAcl { + param( + [Parameter(Mandatory=$true)][string]$Path, + [Parameter(Mandatory=$true)] + [Security.Principal.SecurityIdentifier]$CapturePrivilegedSid + ) + Set-CaptureAuthorityPredicate 'capture-owner' + try { + $sections = [Security.AccessControl.AccessControlSections]::Access -bor + [Security.AccessControl.AccessControlSections]::Owner + $acl = [IO.File]::GetAccessControl($Path, $sections) + $owner = $acl.GetOwner([Security.Principal.SecurityIdentifier]) + $rules = @($acl.GetAccessRules($true, $true, [Security.Principal.SecurityIdentifier])) + } catch { + Stop-PackagedConnect 'artifact-inaccessible' + } + $ownerValues = @($CapturePrivilegedSid.Value, $administratorsSid.Value) + if ($null -eq $owner -or + $ownerValues -cnotcontains $owner.Value -or + ($null -ne $testUserSid -and $owner.Value -ceq $testUserSid.Value)) { + Stop-PackagedConnect 'artifact-type' + } + Set-CaptureAuthorityPredicate 'dacl-canonicality' + if (!$acl.AreAccessRulesProtected -or !$acl.AreAccessRulesCanonical) { + Stop-PackagedConnect 'artifact-type' + } + + $systemSid = [Security.Principal.SecurityIdentifier]::new('S-1-5-18') + $authorizedWriters = [Collections.Generic.HashSet[string]]::new([StringComparer]::Ordinal) + foreach ($identity in @($CapturePrivilegedSid, $administratorsSid, $systemSid)) { + if ($null -ne $identity) { $null = $authorizedWriters.Add($identity.Value) } + } + $mutationRights = [Security.AccessControl.FileSystemRights]::Write -bor + [Security.AccessControl.FileSystemRights]::Delete -bor + [Security.AccessControl.FileSystemRights]::DeleteSubdirectoriesAndFiles -bor + [Security.AccessControl.FileSystemRights]::ChangePermissions -bor + [Security.AccessControl.FileSystemRights]::TakeOwnership + Set-CaptureAuthorityPredicate 'unauthorized-writer' + foreach ($rule in $rules) { + if ($rule.AccessControlType -eq [Security.AccessControl.AccessControlType]::Allow -and + ($rule.FileSystemRights -band $mutationRights) -ne 0 -and + !$authorizedWriters.Contains($rule.IdentityReference.Value)) { + Stop-PackagedConnect 'artifact-type' + } + } +} + +function Assert-PrivilegedCaptureFile { + param( + [Parameter(Mandatory=$true)][string]$Path, + [Parameter(Mandatory=$true)][Microsoft.Win32.SafeHandles.SafeFileHandle]$AuthorityHandle, + [Parameter(Mandatory=$true)][Security.Principal.SecurityIdentifier]$CapturePrivilegedSid, + [string]$ExpectedIdentity = '', + [string]$TestOnlyIdentityPredicate = 'identity-replacement', + [switch]$SkipAcl + ) + Set-CaptureAuthorityPredicate 'link-path-type' + $attributes = [ProprHostLauncherNative]::GetAttributes($AuthorityHandle) + $finalPath = Get-BoundedAbsoluteWindowsPath ( + ConvertFrom-NativeFinalPath ([ProprHostLauncherNative]::GetFinalPath($AuthorityHandle)) + ) + if ([ProprHostLauncherNative]::GetHandleType($AuthorityHandle) -ne + [ProprHostLauncherNative]::FILE_TYPE_DISK -or + ($attributes -band ( + [ProprHostLauncherNative]::FILE_ATTRIBUTE_DIRECTORY -bor + [ProprHostLauncherNative]::FILE_ATTRIBUTE_DEVICE -bor + [ProprHostLauncherNative]::FILE_ATTRIBUTE_REPARSE_POINT + )) -ne 0 -or + [ProprHostLauncherNative]::GetLinkCount($AuthorityHandle) -ne 1 -or + ![String]::Equals($finalPath, $Path, [StringComparison]::OrdinalIgnoreCase)) { + Stop-PackagedConnect 'artifact-type' + } + $identity = [ProprHostLauncherNative]::GetIdentity($AuthorityHandle) + Set-CaptureAuthorityPredicate $TestOnlyIdentityPredicate + if (![String]::IsNullOrEmpty($ExpectedIdentity) -and + ![String]::Equals($identity, $ExpectedIdentity, [StringComparison]::Ordinal)) { + Stop-PackagedConnect 'artifact-type' + } + if (!$SkipAcl) { Assert-CaptureAuthorityAcl $Path $CapturePrivilegedSid } + return $identity +} + +function Get-CaptureAuthorityDescriptor { + param([Parameter(Mandatory=$true)][string]$Path) + $sections = [Security.AccessControl.AccessControlSections]::Access -bor + [Security.AccessControl.AccessControlSections]::Owner + return [IO.File]::GetAccessControl($Path, $sections).GetSecurityDescriptorSddlForm($sections) +} + +function Initialize-PrivilegedCaptureFile { + param( + [Parameter(Mandatory=$true)][string]$Path, + [Parameter(Mandatory=$true)][Security.Principal.SecurityIdentifier]$CapturePrivilegedSid, + [switch]$NormalizeExisting + ) + $authorityHandle = $null + try { + Set-CaptureAuthorityPredicate 'link-path-type' + if ([String]::IsNullOrEmpty($authenticatedRunnerTemp) -or + ![IO.Path]::IsPathRooted($authenticatedRunnerTemp) -or + [IO.Path]::GetFullPath($authenticatedRunnerTemp).TrimEnd('\') -cne $authenticatedRunnerTemp -or + [IO.Path]::GetDirectoryName($Path) -cne $authenticatedRunnerTemp -or + [IO.Path]::GetFileName($Path) -cnotmatch '^propr-connect-[a-f0-9]{32}\.(stdout|stderr)$' -or + [IO.Path]::GetFullPath($Path) -cne $Path) { + Stop-PackagedConnect 'artifact-type' + } + + Initialize-HostLauncherNative + if ($NormalizeExisting) { + $authorityHandle = [ProprHostLauncherNative]::OpenRedirectCaptureAuthority($Path) + $null = Assert-PrivilegedCaptureFile ` + $Path $authorityHandle $CapturePrivilegedSid -SkipAcl + } elseif (Test-Path -LiteralPath $Path) { + Stop-PackagedConnect 'artifact-type' + } + + $systemSid = [Security.Principal.SecurityIdentifier]::new('S-1-5-18') + if ($LifecycleTestMode -ceq 'capture-redirection') { + Set-CaptureAuthorityPredicate 'pre-create' + } + $captureAcl = [Security.AccessControl.FileSecurity]::new() + $captureAcl.SetAccessRuleProtection($true, $false) + $captureAcl.SetOwner($CapturePrivilegedSid) + foreach ($identity in @($CapturePrivilegedSid, $administratorsSid, $systemSid)) { + $null = $captureAcl.AddAccessRule( + [Security.AccessControl.FileSystemAccessRule]::new( + $identity, + [Security.AccessControl.FileSystemRights]::FullControl, + [Security.AccessControl.AccessControlType]::Allow + ) + ) + } + + if ($NormalizeExisting) { + [IO.File]::SetAccessControl($Path, $captureAcl) + $authorityHandle.Dispose() + $authorityHandle = $null + } else { + $captureStream = [IO.FileStream]::new( + $Path, + [IO.FileMode]::CreateNew, + [Security.AccessControl.FileSystemRights]::FullControl, + [IO.FileShare]::Read, + 4096, + [IO.FileOptions]::None, + $captureAcl + ) + $captureStream.Dispose() + } + + $authorityHandle = [ProprHostLauncherNative]::OpenRedirectCaptureAuthority($Path) + $identity = Assert-PrivilegedCaptureFile $Path $authorityHandle $CapturePrivilegedSid + $result = [PSCustomObject]@{ + Path = $Path + Identity = $identity + SecurityDescriptor = (Get-CaptureAuthorityDescriptor $Path) + Handle = $authorityHandle + } + $authorityHandle = $null + return $result + } catch { + if ($_.Exception.Message -clike 'PROPR_PACKAGED_CONNECT_FAILURE:*') { throw } + Stop-PackagedConnect 'artifact-inaccessible' + } finally { + if ($null -ne $authorityHandle) { $authorityHandle.Dispose() } + } +} + +function Assert-PrivilegedCaptureIdentity { + param( + [Parameter(Mandatory=$true)]$Authority, + [Parameter(Mandatory=$true)][Security.Principal.SecurityIdentifier]$CapturePrivilegedSid, + [string]$TestOnlyIdentityPredicate = 'identity-replacement' + ) + $reopenHandle = $null + try { + Set-CaptureAuthorityPredicate $TestOnlyIdentityPredicate + if ($null -eq $Authority -or !($Authority.Path -is [string]) -or + !($Authority.Identity -is [string]) -or + !($Authority.SecurityDescriptor -is [string]) -or + !($Authority.Handle -is [Microsoft.Win32.SafeHandles.SafeFileHandle]) -or + $Authority.Handle.IsInvalid -or $Authority.Handle.IsClosed -or + ![String]::Equals( + [ProprHostLauncherNative]::GetIdentity($Authority.Handle), + $Authority.Identity, + [StringComparison]::Ordinal + )) { + Stop-PackagedConnect 'artifact-type' + } + $reopenHandle = [ProprHostLauncherNative]::OpenRedirectCaptureAuthority($Authority.Path) + $null = Assert-PrivilegedCaptureFile ` + $Authority.Path $reopenHandle $CapturePrivilegedSid $Authority.Identity ` + -TestOnlyIdentityPredicate $TestOnlyIdentityPredicate + Set-CaptureAuthorityPredicate 'dacl-canonicality' + if ((Get-CaptureAuthorityDescriptor $Authority.Path) -cne $Authority.SecurityDescriptor) { + Stop-PackagedConnect 'artifact-type' + } + } catch { + if ($_.Exception.Message -clike 'PROPR_PACKAGED_CONNECT_FAILURE:*') { throw } + Stop-PackagedConnect 'artifact-inaccessible' + } finally { + if ($null -ne $reopenHandle) { $reopenHandle.Dispose() } + } +} + +function Read-AuthorizedCaptureBytes { + param( + [Parameter(Mandatory=$true)][string]$Path, + [scriptblock]$TestOnlyBeforeReopen, + [switch]$TestOnlyAllowReplacement, + [Security.Principal.SecurityIdentifier]$TestOnlyCapturePrivilegedSid, + [Security.Principal.SecurityIdentifier]$TestOnlyExpectedParentOwnerSid, + [string]$ExpectedCaptureIdentity = '' + ) + $parentHandle = $null + $parentReopenHandle = $null + $captureHandle = $null + $captureReopenHandle = $null + $captureFinalHandle = $null + try { + Set-CaptureParseSubphase 'capture-authority' + Set-CaptureAuthorityPredicate 'link-path-type' + $capturePrivilegedSid = if ($null -eq $TestOnlyCapturePrivilegedSid) { + $privilegedSid + } else { + $TestOnlyCapturePrivilegedSid + } + if ([String]::IsNullOrEmpty($authenticatedRunnerTemp) -or + $null -eq $capturePrivilegedSid -or + ![IO.Path]::IsPathRooted($authenticatedRunnerTemp) -or + [IO.Path]::GetFullPath($authenticatedRunnerTemp).TrimEnd('\') -cne $authenticatedRunnerTemp -or + [IO.Path]::GetDirectoryName($Path) -cne $authenticatedRunnerTemp -or + [IO.Path]::GetFileName($Path) -cnotmatch '^propr-connect-[a-f0-9]{32}\.stderr$' -or + [IO.Path]::GetFullPath($Path) -cne $Path) { + Stop-PackagedConnect 'artifact-type' + } + + Initialize-HostLauncherNative + $parentHandle = [ProprHostLauncherNative]::Open($authenticatedRunnerTemp, $true) + $parentAttributes = [ProprHostLauncherNative]::GetAttributes($parentHandle) + $parentFinalPath = Get-BoundedAbsoluteWindowsPath ( + ConvertFrom-NativeFinalPath ([ProprHostLauncherNative]::GetFinalPath($parentHandle)) + ) + if ([ProprHostLauncherNative]::GetHandleType($parentHandle) -ne + [ProprHostLauncherNative]::FILE_TYPE_DISK -or + ($parentAttributes -band [ProprHostLauncherNative]::FILE_ATTRIBUTE_DIRECTORY) -eq 0 -or + ($parentAttributes -band [ProprHostLauncherNative]::FILE_ATTRIBUTE_DEVICE) -ne 0 -or + ($parentAttributes -band [ProprHostLauncherNative]::FILE_ATTRIBUTE_REPARSE_POINT) -ne 0 -or + ![String]::Equals( + $parentFinalPath, $authenticatedRunnerTemp, [StringComparison]::OrdinalIgnoreCase + )) { + Stop-PackagedConnect 'artifact-type' + } + $parentIdentity = [ProprHostLauncherNative]::GetIdentity($parentHandle) + try { + $parentAcl = [IO.Directory]::GetAccessControl( + $authenticatedRunnerTemp, + [Security.AccessControl.AccessControlSections]::Owner + ) + $parentOwner = $parentAcl.GetOwner([Security.Principal.SecurityIdentifier]) + } catch { + Stop-PackagedConnect 'artifact-inaccessible' + } + Set-CaptureAuthorityPredicate 'parent-owner' + if ($null -eq $parentOwner -or @( + $privilegedSid.Value, $administratorsSid.Value, 'S-1-5-18' + ) -cnotcontains $parentOwner.Value) { + Stop-PackagedConnect 'artifact-type' + } + if ($null -ne $TestOnlyExpectedParentOwnerSid -and + ($LifecycleTestMode -cne 'capture-parser' -or + $CaptureParserAuthorityTestCase -cne 'foreign-parent-owner')) { + Stop-PackagedConnect 'artifact-type' + } + if ($null -ne $TestOnlyExpectedParentOwnerSid -and + $parentOwner.Value -cne $TestOnlyExpectedParentOwnerSid.Value) { + Stop-PackagedConnect 'artifact-type' + } + + Set-CaptureAuthorityPredicate 'link-path-type' + $captureHandle = [ProprHostLauncherNative]::OpenCapture( + $Path, !$TestOnlyAllowReplacement.IsPresent + ) + $captureAttributes = [ProprHostLauncherNative]::GetAttributes($captureHandle) + $captureFinalPath = Get-BoundedAbsoluteWindowsPath ( + ConvertFrom-NativeFinalPath ([ProprHostLauncherNative]::GetFinalPath($captureHandle)) + ) + if ([ProprHostLauncherNative]::GetHandleType($captureHandle) -ne + [ProprHostLauncherNative]::FILE_TYPE_DISK -or + ($captureAttributes -band [ProprHostLauncherNative]::FILE_ATTRIBUTE_DIRECTORY) -ne 0 -or + ($captureAttributes -band [ProprHostLauncherNative]::FILE_ATTRIBUTE_DEVICE) -ne 0 -or + ($captureAttributes -band [ProprHostLauncherNative]::FILE_ATTRIBUTE_REPARSE_POINT) -ne 0 -or + [ProprHostLauncherNative]::GetLinkCount($captureHandle) -ne 1 -or + ![String]::Equals($captureFinalPath, $Path, [StringComparison]::OrdinalIgnoreCase)) { + Stop-PackagedConnect 'artifact-type' + } + $captureIdentity = [ProprHostLauncherNative]::GetIdentity($captureHandle) + Set-CaptureAuthorityPredicate 'identity-replacement' + if (![String]::IsNullOrEmpty($ExpectedCaptureIdentity) -and + ![String]::Equals($captureIdentity, $ExpectedCaptureIdentity, [StringComparison]::Ordinal)) { + Stop-PackagedConnect 'artifact-type' + } + Assert-CaptureAuthorityAcl $Path $capturePrivilegedSid + + if ($null -ne $TestOnlyBeforeReopen) { & $TestOnlyBeforeReopen } + $captureReopenHandle = [ProprHostLauncherNative]::OpenCapture($Path, $true) + $captureReopenAttributes = [ProprHostLauncherNative]::GetAttributes($captureReopenHandle) + $captureReopenIdentity = [ProprHostLauncherNative]::GetIdentity($captureReopenHandle) + $captureReopenFinalPath = Get-BoundedAbsoluteWindowsPath ( + ConvertFrom-NativeFinalPath ([ProprHostLauncherNative]::GetFinalPath($captureReopenHandle)) + ) + Set-CaptureAuthorityPredicate 'link-path-type' + if ([ProprHostLauncherNative]::GetHandleType($captureReopenHandle) -ne + [ProprHostLauncherNative]::FILE_TYPE_DISK -or + ($captureReopenAttributes -band ( + [ProprHostLauncherNative]::FILE_ATTRIBUTE_DIRECTORY -bor + [ProprHostLauncherNative]::FILE_ATTRIBUTE_DEVICE -bor + [ProprHostLauncherNative]::FILE_ATTRIBUTE_REPARSE_POINT + )) -ne 0 -or + [ProprHostLauncherNative]::GetLinkCount($captureReopenHandle) -ne 1 -or + ![String]::Equals($captureFinalPath, $captureReopenFinalPath, [StringComparison]::OrdinalIgnoreCase)) { + Stop-PackagedConnect 'artifact-type' + } + Set-CaptureAuthorityPredicate 'identity-replacement' + if (![String]::Equals($captureIdentity, $captureReopenIdentity, [StringComparison]::Ordinal)) { + Stop-PackagedConnect 'artifact-type' + } + Assert-CaptureAuthorityAcl $Path $capturePrivilegedSid + + Set-CaptureParseSubphase 'capture-size' + $captureLength = [ProprHostLauncherNative]::GetLength($captureReopenHandle) + if ($captureLength -lt 1 -or $captureLength -gt 65536) { + Stop-PackagedConnect 'artifact-type' + } + + Set-CaptureParseSubphase 'capture-read' + $captureBytes = [ProprHostLauncherNative]::ReadBounded($captureReopenHandle, 65536) + if ($captureBytes.Length -ne $captureLength) { Stop-PackagedConnect 'artifact-type' } + + Set-CaptureParseSubphase 'capture-authority' + Set-CaptureAuthorityPredicate 'identity-replacement' + if (![String]::Equals( + $captureReopenIdentity, + [ProprHostLauncherNative]::GetIdentity($captureReopenHandle), + [StringComparison]::Ordinal + )) { + Stop-PackagedConnect 'artifact-type' + } + $captureFinalHandle = [ProprHostLauncherNative]::OpenCapture($Path, $true) + if (![String]::Equals( + $captureReopenIdentity, + [ProprHostLauncherNative]::GetIdentity($captureFinalHandle), + [StringComparison]::Ordinal + ) -or [ProprHostLauncherNative]::GetLinkCount($captureFinalHandle) -ne 1) { + Stop-PackagedConnect 'artifact-type' + } + Assert-CaptureAuthorityAcl $Path $capturePrivilegedSid + $parentReopenHandle = [ProprHostLauncherNative]::Open($authenticatedRunnerTemp, $true) + if (![String]::Equals( + $parentIdentity, + [ProprHostLauncherNative]::GetIdentity($parentReopenHandle), + [StringComparison]::Ordinal + )) { + Stop-PackagedConnect 'artifact-type' + } + return ,$captureBytes + } catch { + if ($_.Exception.Message -clike 'PROPR_PACKAGED_CONNECT_FAILURE:*') { throw } + Stop-PackagedConnect 'artifact-inaccessible' + } finally { + foreach ($handle in @( + $captureFinalHandle, $captureReopenHandle, $captureHandle, + $parentReopenHandle, $parentHandle + )) { + if ($null -ne $handle) { $handle.Dispose() } + } + } +} + +function Read-PackagedConnectSmokeFailure { + param( + [Parameter(Mandatory=$true)][string]$Path, + [scriptblock]$TestOnlyBeforeReopen, + [switch]$TestOnlyAllowReplacement, + [Security.Principal.SecurityIdentifier]$TestOnlyCapturePrivilegedSid, + [Security.Principal.SecurityIdentifier]$TestOnlyExpectedParentOwnerSid, + [string]$ExpectedCaptureIdentity = '' + ) + + $captureBytes = Read-AuthorizedCaptureBytes ` + -Path $Path ` + -TestOnlyBeforeReopen $TestOnlyBeforeReopen ` + -TestOnlyAllowReplacement:$TestOnlyAllowReplacement ` + -TestOnlyCapturePrivilegedSid $TestOnlyCapturePrivilegedSid ` + -TestOnlyExpectedParentOwnerSid $TestOnlyExpectedParentOwnerSid ` + -ExpectedCaptureIdentity $ExpectedCaptureIdentity + + Set-CaptureParseSubphase 'capture-utf8' + try { + $captureText = [Text.UTF8Encoding]::new($false, $true).GetString($captureBytes) + } catch { + Stop-PackagedConnect 'artifact-type' + } + + Set-CaptureParseSubphase 'capture-redaction' + $sensitiveValues = @( + $stageRoot, $stageParent, $stageLeaf, $stdout, $stderr, $testUser, + $plainPassword, $handoffArgument, 'S-1-5-', 'SENTINEL' + ) + foreach ($sensitiveValue in $sensitiveValues) { + if ($sensitiveValue -is [string] -and $sensitiveValue.Length -gt 0 -and + $captureText.IndexOf($sensitiveValue, [StringComparison]::OrdinalIgnoreCase) -ge 0) { + Stop-PackagedConnect 'artifact-type' + } + } + + Set-CaptureParseSubphase 'capture-line-cardinality' + if (!$captureText.EndsWith("`n", [StringComparison]::Ordinal) -or + $captureText.IndexOf("`r", [StringComparison]::Ordinal) -ge 0) { + Stop-PackagedConnect 'artifact-type' + } + $jsonLine = $captureText.Substring(0, $captureText.Length - 1) + if ($jsonLine.Length -eq 0 -or $jsonLine.IndexOf("`n", [StringComparison]::Ordinal) -ge 0) { + Stop-PackagedConnect 'artifact-type' + } + + Set-CaptureParseSubphase 'capture-schema-cardinality' + if (!(Test-UniqueJsonPropertyNames $jsonLine)) { + Stop-PackagedConnect 'artifact-type' + } + Set-CaptureParseSubphase 'capture-json' + try { + $failureRecord = ConvertFrom-Json -InputObject $jsonLine -ErrorAction Stop + } catch { + Stop-PackagedConnect 'artifact-type' + } + + Set-CaptureParseSubphase 'capture-event-cardinality' + if ($null -eq $failureRecord -or $failureRecord -is [Array] -or + $failureRecord -is [string] -or $failureRecord -is [ValueType] -or + !($failureRecord.event -is [string]) -or + $failureRecord.event -cnotin @( + 'packaged_connect.artifact_failed','packaged_connect.smoke_failed' + )) { + Stop-PackagedConnect 'artifact-type' + } + + if ($failureRecord.event -ceq 'packaged_connect.artifact_failed') { + $artifactPhases = @( + 'staged-contract','staged-tree','staged-architecture','ordinary-user-preflight' + ) + Set-CaptureParseSubphase 'capture-lifecycle-phase' + if (!($failureRecord.phase -is [string]) -or + $artifactPhases -cnotcontains $failureRecord.phase) { + Stop-PackagedConnect 'artifact-type' + } + + $artifactRequiresSubphase = $failureRecord.phase -cin @( + 'staged-contract','ordinary-user-preflight' + ) + $artifactProperties = @('event','category','phase') + if ($artifactRequiresSubphase) { $artifactProperties += 'subphase' } + Set-CaptureParseSubphase 'capture-schema-cardinality' + if (!(Test-ExactJsonProperties $failureRecord $artifactProperties) -or + !($failureRecord.category -is [string])) { + Stop-PackagedConnect 'artifact-type' + } + + Set-CaptureParseSubphase 'capture-lifecycle-category' + $artifactCategories = if ($failureRecord.phase -ceq 'staged-contract') { + @('artifact-type') + } elseif ($failureRecord.phase -ceq 'staged-tree') { + @('artifact-missing','artifact-inaccessible','artifact-type') + } elseif ($failureRecord.phase -ceq 'staged-architecture') { + @('artifact-missing','artifact-inaccessible','artifact-type','architecture-mismatch') + } else { + @('artifact-inaccessible','artifact-type') + } + if ($artifactCategories -cnotcontains $failureRecord.category) { + Stop-PackagedConnect 'artifact-type' + } + + Set-CaptureParseSubphase 'capture-lifecycle-subphase' + if ($failureRecord.phase -ceq 'staged-contract') { + if (!($failureRecord.subphase -is [string]) -or + $childStagedContractSubphases -cnotcontains $failureRecord.subphase) { + Stop-PackagedConnect 'artifact-type' + } + } elseif ($failureRecord.phase -ceq 'ordinary-user-preflight') { + if (!($failureRecord.subphase -is [string]) -or + $childFailureSubphases -cnotcontains $failureRecord.subphase) { + Stop-PackagedConnect 'artifact-type' + } + } + + $script:failurePhase = $failureRecord.phase + $script:failureSubphase = if ($artifactRequiresSubphase) { + $failureRecord.subphase + } else { + $null + } + return $failureRecord.category + } + + Set-CaptureParseSubphase 'capture-schema-cardinality' + $hasSecondary = $null -ne $failureRecord -and + $null -ne $failureRecord.PSObject.Properties['secondary'] + $topLevelProperties = @('event','category','capture','records') + if ($hasSecondary) { $topLevelProperties += 'secondary' } + if (!(Test-ExactJsonProperties $failureRecord $topLevelProperties) -or + !($failureRecord.category -is [string]) -or + !($failureRecord.capture -is [string]) -or + !($failureRecord.records -is [Array])) { + Stop-PackagedConnect 'artifact-type' + } + + Set-CaptureParseSubphase 'capture-lifecycle-category' + if ($lifecycleFailureSubphases -cnotcontains $failureRecord.category) { + Stop-PackagedConnect 'artifact-type' + } + if ($failureRecord.capture -cnotin @('complete','truncated')) { + Stop-PackagedConnect 'artifact-type' + } + $diagnosticRecords = @($failureRecord.records) + if ($diagnosticRecords.Count -gt 20) { + Stop-PackagedConnect 'artifact-type' + } + + $diagnosticEvents = @( + 'desktop.app.ready', + 'desktop.app.start_failed', + 'desktop.log.write_failed', + 'desktop.main_process.uncaught_exception', + 'desktop.renderer.connect_discovery.ready', + 'desktop.renderer.connect_discovery.phase', + 'desktop.renderer.connect_discovery.proof', + 'desktop.renderer.connect_discovery.status', + 'desktop.renderer.gone', + 'desktop.renderer.ready' + ) + $diagnosticCodes = @( + 'CONNECT_STATUS_INCOMPATIBLE','CONNECT_STATUS_INTERNAL_FAILURE', + 'CONNECT_STATUS_INVALID_CONFIG','CONNECT_STATUS_NOT_READY','CONNECT_STATUS_READY', + 'CONNECT_STATUS_TIMEOUT','DETAIL_REDACTED','LOG_WRITE_FAILED','OPERATION_FAILED', + 'UNCAUGHT_EXCEPTION' + ) + $diagnosticPhases = @( + 'config-read','addon-integrity-type','addon-load','descriptor-operation', + 'authority-inspection','status-resolution' + ) + $diagnosticSubsteps = @('directory-open','addon-open','fstat-type') + $diagnosticCategories = @( + 'access-denied','invalid-argument','io-failure','missing-entry','not-directory', + 'symlink-refused','type-mismatch','unexpected' + ) + foreach ($diagnosticRecord in $diagnosticRecords) { + Set-CaptureParseSubphase 'capture-schema-cardinality' + if ($null -eq $diagnosticRecord -or $diagnosticRecord -is [Array] -or + $diagnosticRecord -is [string] -or $diagnosticRecord -is [ValueType]) { + Stop-PackagedConnect 'artifact-type' + } + $hasCode = $null -ne $diagnosticRecord.PSObject.Properties['code'] + $hasPhase = $null -ne $diagnosticRecord.PSObject.Properties['phase'] + $hasSubstep = $null -ne $diagnosticRecord.PSObject.Properties['substep'] + $hasCategory = $null -ne $diagnosticRecord.PSObject.Properties['category'] + $expectedProperties = @('event') + if ($hasCode) { $expectedProperties += 'code' } + if ($hasPhase) { $expectedProperties += 'phase' } + if ($hasSubstep) { $expectedProperties += 'substep' } + if ($hasCategory) { $expectedProperties += 'category' } + if (!(Test-ExactJsonProperties $diagnosticRecord $expectedProperties)) { + Stop-PackagedConnect 'artifact-type' + } + + Set-CaptureParseSubphase 'capture-event-cardinality' + if (!($diagnosticRecord.event -is [string]) -or + $diagnosticEvents -cnotcontains $diagnosticRecord.event) { + Stop-PackagedConnect 'artifact-type' + } + + Set-CaptureParseSubphase 'capture-lifecycle-phase' + if ($hasPhase) { + if (!$hasCode -or !($diagnosticRecord.phase -is [string]) -or + $diagnosticPhases -cnotcontains $diagnosticRecord.phase -or + !($diagnosticRecord.code -is [string]) -or + $diagnosticRecord.code -cnotin @('STARTED','PASSED','FAILED')) { + Stop-PackagedConnect 'artifact-type' + } + } elseif ($hasCode) { + if (!($diagnosticRecord.code -is [string]) -or + $diagnosticCodes -cnotcontains $diagnosticRecord.code) { + Stop-PackagedConnect 'artifact-type' + } + } + + Set-CaptureParseSubphase 'capture-lifecycle-subphase' + if (($hasSubstep -or $hasCategory) -and + (!$hasPhase -or $diagnosticRecord.code -cne 'FAILED')) { + Stop-PackagedConnect 'artifact-type' + } + if ($hasSubstep -and (!($diagnosticRecord.substep -is [string]) -or + $diagnosticSubsteps -cnotcontains $diagnosticRecord.substep)) { + Stop-PackagedConnect 'artifact-type' + } + if ($hasCategory -and (!($diagnosticRecord.category -is [string]) -or + $diagnosticCategories -cnotcontains $diagnosticRecord.category)) { + Stop-PackagedConnect 'artifact-type' + } + } + + Set-CaptureParseSubphase 'capture-lifecycle-subphase' + if ($hasSecondary) { + if (!($failureRecord.secondary -is [Array])) { + Stop-PackagedConnect 'artifact-type' + } + $secondaryValues = @($failureRecord.secondary) + if ($secondaryValues.Count -lt 1 -or $secondaryValues.Count -gt 5) { + Stop-PackagedConnect 'artifact-type' + } + $allowedSecondary = @( + 'tree-termination-failed','child-close-unconfirmed','stream-drain-failed', + 'fixture-cleanup-failed','fixture-cleanup-authorization-failed' + ) + $uniqueSecondary = [Collections.Generic.HashSet[string]]::new([StringComparer]::Ordinal) + foreach ($secondaryValue in $secondaryValues) { + if (!($secondaryValue -is [string]) -or + $allowedSecondary -cnotcontains $secondaryValue -or + !$uniqueSecondary.Add($secondaryValue)) { + Stop-PackagedConnect 'artifact-type' + } + } + } + Set-LifecycleFailureSubphase $failureRecord.category + return 'spawn-failed' +} + +$hostLauncherNativeSource = @' +using System; +using System.ComponentModel; +using System.Runtime.InteropServices; +using System.Text; +using Microsoft.Win32.SafeHandles; + +public static class ProprHostLauncherNative { + public const uint GENERIC_READ = 0x80000000; + public const uint READ_CONTROL = 0x00020000; + public const uint FILE_READ_ATTRIBUTES = 0x00000080; + public const uint FILE_SHARE_READ = 0x00000001; + public const uint FILE_SHARE_WRITE = 0x00000002; + public const uint FILE_SHARE_DELETE = 0x00000004; + public const uint OPEN_EXISTING = 3; + public const uint FILE_FLAG_OPEN_REPARSE_POINT = 0x00200000; + public const uint FILE_FLAG_BACKUP_SEMANTICS = 0x02000000; + public const uint FILE_ATTRIBUTE_DIRECTORY = 0x00000010; + public const uint FILE_ATTRIBUTE_DEVICE = 0x00000040; + public const uint FILE_ATTRIBUTE_REPARSE_POINT = 0x00000400; + public const uint FILE_TYPE_DISK = 0x0001; + + [StructLayout(LayoutKind.Sequential)] + private struct BY_HANDLE_FILE_INFORMATION { + public uint FileAttributes; + public System.Runtime.InteropServices.ComTypes.FILETIME CreationTime; + public System.Runtime.InteropServices.ComTypes.FILETIME LastAccessTime; + public System.Runtime.InteropServices.ComTypes.FILETIME LastWriteTime; + public uint VolumeSerialNumber; + public uint FileSizeHigh; + public uint FileSizeLow; + public uint NumberOfLinks; + public uint FileIndexHigh; + public uint FileIndexLow; + } + + [StructLayout(LayoutKind.Sequential)] + private struct FILE_ID_128 { + public ulong Low; + public ulong High; + } + + [StructLayout(LayoutKind.Sequential)] + private struct FILE_ID_INFO { + public ulong VolumeSerialNumber; + public FILE_ID_128 FileId; + } + + [DllImport("kernel32.dll", CharSet = CharSet.Unicode, ExactSpelling = true, SetLastError = true)] + private static extern SafeFileHandle CreateFileW( + string fileName, + uint desiredAccess, + uint shareMode, + IntPtr securityAttributes, + uint creationDisposition, + uint flagsAndAttributes, + IntPtr templateFile + ); + + [DllImport("kernel32.dll", SetLastError = true)] + private static extern bool GetFileInformationByHandle( + SafeFileHandle file, + out BY_HANDLE_FILE_INFORMATION information + ); + + [DllImport("kernel32.dll", SetLastError = true)] + private static extern bool GetFileInformationByHandleEx( + SafeFileHandle file, + int fileInformationClass, + out FILE_ID_INFO information, + uint bufferSize + ); + + [DllImport("kernel32.dll", SetLastError = true)] + private static extern uint GetFileType(SafeFileHandle file); + + [DllImport("kernel32.dll", ExactSpelling = true, SetLastError = true)] + private static extern bool ReadFile( + SafeFileHandle file, + byte[] buffer, + uint bytesToRead, + out uint bytesRead, + IntPtr overlapped + ); + + [DllImport("kernel32.dll", CharSet = CharSet.Unicode, ExactSpelling = true, SetLastError = true)] + private static extern uint GetFinalPathNameByHandleW( + SafeFileHandle file, + StringBuilder path, + uint pathLength, + uint flags + ); + + public static SafeFileHandle Open(string path, bool finalPathAuthority) { + uint share = finalPathAuthority + ? FILE_SHARE_READ + : FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE; + uint flags = FILE_FLAG_BACKUP_SEMANTICS; + if (finalPathAuthority) flags |= FILE_FLAG_OPEN_REPARSE_POINT; + SafeFileHandle handle = CreateFileW( + path, + FILE_READ_ATTRIBUTES, + share, + IntPtr.Zero, + OPEN_EXISTING, + flags, + IntPtr.Zero + ); + if (handle.IsInvalid) { + int error = Marshal.GetLastWin32Error(); + handle.Dispose(); + throw new Win32Exception(error); + } + return handle; + } + + public static SafeFileHandle OpenCapture(string path, bool lockAuthority) { + uint share = lockAuthority + ? FILE_SHARE_READ + : FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE; + SafeFileHandle handle = CreateFileW( + path, + GENERIC_READ | READ_CONTROL, + share, + IntPtr.Zero, + OPEN_EXISTING, + FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS, + IntPtr.Zero + ); + if (handle.IsInvalid) { + int error = Marshal.GetLastWin32Error(); + handle.Dispose(); + throw new Win32Exception(error); + } + return handle; + } + + public static SafeFileHandle OpenRedirectCaptureAuthority(string path) { + SafeFileHandle handle = CreateFileW( + path, + FILE_READ_ATTRIBUTES | READ_CONTROL, + FILE_SHARE_READ | FILE_SHARE_WRITE, + IntPtr.Zero, + OPEN_EXISTING, + FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS, + IntPtr.Zero + ); + if (handle.IsInvalid) { + int error = Marshal.GetLastWin32Error(); + handle.Dispose(); + throw new Win32Exception(error); + } + return handle; + } + + public static string GetIdentity(SafeFileHandle handle) { + const int FileIdInfo = 18; + FILE_ID_INFO information; + if (!GetFileInformationByHandleEx( + handle, + FileIdInfo, + out information, + (uint)Marshal.SizeOf(typeof(FILE_ID_INFO)) + )) { + throw new Win32Exception(Marshal.GetLastWin32Error()); + } + return String.Format( + System.Globalization.CultureInfo.InvariantCulture, + "{0:X16}:{1:X16}:{2:X16}", + information.VolumeSerialNumber, + information.FileId.High, + information.FileId.Low + ); + } + + public static uint GetAttributes(SafeFileHandle handle) { + BY_HANDLE_FILE_INFORMATION information; + if (!GetFileInformationByHandle(handle, out information)) { + throw new Win32Exception(Marshal.GetLastWin32Error()); + } + return information.FileAttributes; + } + + public static uint GetLinkCount(SafeFileHandle handle) { + BY_HANDLE_FILE_INFORMATION information; + if (!GetFileInformationByHandle(handle, out information)) { + throw new Win32Exception(Marshal.GetLastWin32Error()); + } + return information.NumberOfLinks; + } + + public static long GetLength(SafeFileHandle handle) { + BY_HANDLE_FILE_INFORMATION information; + if (!GetFileInformationByHandle(handle, out information)) { + throw new Win32Exception(Marshal.GetLastWin32Error()); + } + return ((long)information.FileSizeHigh << 32) | information.FileSizeLow; + } + + public static byte[] ReadBounded(SafeFileHandle handle, int maximumLength) { + if (maximumLength < 1) throw new ArgumentOutOfRangeException("maximumLength"); + using (System.IO.MemoryStream output = new System.IO.MemoryStream()) { + byte[] buffer = new byte[Math.Min(4096, maximumLength + 1)]; + while (output.Length <= maximumLength) { + int remaining = maximumLength + 1 - (int)output.Length; + uint requested = (uint)Math.Min(buffer.Length, remaining); + uint read; + if (!ReadFile(handle, buffer, requested, out read, IntPtr.Zero)) { + throw new Win32Exception(Marshal.GetLastWin32Error()); + } + if (read == 0) break; + output.Write(buffer, 0, (int)read); + } + return output.ToArray(); + } + } + + public static uint GetHandleType(SafeFileHandle handle) { + uint type = GetFileType(handle); + if (type == 0) { + int error = Marshal.GetLastWin32Error(); + if (error != 0) throw new Win32Exception(error); + } + return type; + } + + public static string GetFinalPath(SafeFileHandle handle) { + StringBuilder path = new StringBuilder(32768); + uint length = GetFinalPathNameByHandleW(handle, path, (uint)path.Capacity, 0); + if (length == 0) throw new Win32Exception(Marshal.GetLastWin32Error()); + if (length >= path.Capacity) throw new Win32Exception(206); + return path.ToString(); + } +} +'@ + +function Initialize-HostLauncherNative { + if ($null -eq ('ProprHostLauncherNative' -as [type])) { + Add-Type -TypeDefinition $hostLauncherNativeSource -Language CSharp -ErrorAction Stop + } +} + +function Get-BoundedAbsoluteWindowsPath { + param( + [Parameter(Mandatory=$true)][AllowEmptyString()][string]$Path, + [switch]$SelectedPathPredicates + ) + if ($SelectedPathPredicates) { + Set-OrdinaryUserPreflightSubphase 'host-launcher-selected-path-input' + } + if ([String]::IsNullOrEmpty($Path) -or $Path.Length -gt 259 -or $Path -cmatch '[\x00-\x1f\x7f]' -or + $Path.StartsWith('\\?\', [StringComparison]::Ordinal) -or + $Path.StartsWith('\\.\', [StringComparison]::Ordinal) -or + $Path.StartsWith('\??\', [StringComparison]::Ordinal)) { + Stop-PackagedConnect 'artifact-type' + } + if ($SelectedPathPredicates) { + Set-OrdinaryUserPreflightSubphase 'host-launcher-selected-path-extra-colon' + } + if ($Path.Length -gt 2 -and $Path.Substring(2).Contains(':')) { + Stop-PackagedConnect 'artifact-type' + } + if ($SelectedPathPredicates) { + Set-OrdinaryUserPreflightSubphase 'host-launcher-selected-path-get-full-path' + } + try { + $fullPath = [IO.Path]::GetFullPath($Path) + } catch { + Stop-PackagedConnect 'artifact-type' + } + if ($SelectedPathPredicates) { + Set-OrdinaryUserPreflightSubphase 'host-launcher-selected-path-absolute-shape' + } + $driveAbsolute = $fullPath -cmatch '^[A-Za-z]:\\' + $uncAbsolute = $fullPath -cmatch '^\\\\[^\\:]+\\[^\\:]+\\' + if (!$driveAbsolute -and !$uncAbsolute) { Stop-PackagedConnect 'artifact-type' } + if ($SelectedPathPredicates) { + Set-OrdinaryUserPreflightSubphase 'host-launcher-selected-path-canonical-equality' + } + if (![String]::Equals($fullPath, $Path, [StringComparison]::OrdinalIgnoreCase)) { + Stop-PackagedConnect 'artifact-type' + } + return $fullPath +} + +function ConvertFrom-NativeFinalPath { + param([Parameter(Mandatory=$true)][string]$Path) + if ($Path.StartsWith('\\?\UNC\', [StringComparison]::OrdinalIgnoreCase)) { + return '\\' + $Path.Substring(8) + } + if ($Path.StartsWith('\\?\', [StringComparison]::OrdinalIgnoreCase)) { + return $Path.Substring(4) + } + Stop-PackagedConnect 'artifact-type' +} + +function Assert-OrdinaryHostLauncherHandle { + param([Parameter(Mandatory=$true)]$Handle) + $attributes = [ProprHostLauncherNative]::GetAttributes($Handle) + if ([ProprHostLauncherNative]::GetHandleType($Handle) -ne [ProprHostLauncherNative]::FILE_TYPE_DISK -or + ($attributes -band [ProprHostLauncherNative]::FILE_ATTRIBUTE_DIRECTORY) -ne 0 -or + ($attributes -band [ProprHostLauncherNative]::FILE_ATTRIBUTE_DEVICE) -ne 0 -or + ($attributes -band [ProprHostLauncherNative]::FILE_ATTRIBUTE_REPARSE_POINT) -ne 0) { + Stop-PackagedConnect 'artifact-type' + } +} + +function Get-TrustedHostLauncher { + param( + [Parameter(Mandatory=$true)][AllowEmptyString()][string]$Path, + [scriptblock]$TestOnlyBeforeFinalReopen, + [scriptblock]$TestOnlyBeforeSourceReopen + ) + $sourceHandle = $null + $authorityHandle = $null + $sourceReopenHandle = $null + $authorityTransferred = $false + try { + Set-OrdinaryUserPreflightSubphase 'host-launcher-native-initialization' + Initialize-HostLauncherNative + $selectedPath = Get-BoundedAbsoluteWindowsPath -Path $Path -SelectedPathPredicates + Set-OrdinaryUserPreflightSubphase 'host-launcher-source-open' + $sourceHandle = [ProprHostLauncherNative]::Open($selectedPath, $false) + Set-OrdinaryUserPreflightSubphase 'host-launcher-source-type' + Assert-OrdinaryHostLauncherHandle $sourceHandle + Set-OrdinaryUserPreflightSubphase 'host-launcher-source-identity' + $sourceIdentity = [ProprHostLauncherNative]::GetIdentity($sourceHandle) + Set-OrdinaryUserPreflightSubphase 'host-launcher-source-final-path' + $finalPath = Get-BoundedAbsoluteWindowsPath ( + ConvertFrom-NativeFinalPath ([ProprHostLauncherNative]::GetFinalPath($sourceHandle)) + ) + + if ($null -ne $TestOnlyBeforeFinalReopen) { & $TestOnlyBeforeFinalReopen } + Set-OrdinaryUserPreflightSubphase 'host-launcher-final-open' + $authorityHandle = [ProprHostLauncherNative]::Open($finalPath, $true) + Set-OrdinaryUserPreflightSubphase 'host-launcher-final-type' + Assert-OrdinaryHostLauncherHandle $authorityHandle + Set-OrdinaryUserPreflightSubphase 'host-launcher-final-identity' + $authorityIdentity = [ProprHostLauncherNative]::GetIdentity($authorityHandle) + Set-OrdinaryUserPreflightSubphase 'host-launcher-final-path' + $authorityFinalPath = Get-BoundedAbsoluteWindowsPath ( + ConvertFrom-NativeFinalPath ([ProprHostLauncherNative]::GetFinalPath($authorityHandle)) + ) + Set-OrdinaryUserPreflightSubphase 'host-launcher-final-match' + if (![String]::Equals($sourceIdentity, $authorityIdentity, [StringComparison]::Ordinal) -or + ![String]::Equals($finalPath, $authorityFinalPath, [StringComparison]::OrdinalIgnoreCase)) { + Stop-PackagedConnect 'artifact-type' + } + + if ($null -ne $TestOnlyBeforeSourceReopen) { & $TestOnlyBeforeSourceReopen } + Set-OrdinaryUserPreflightSubphase 'host-launcher-source-reopen' + $sourceReopenHandle = [ProprHostLauncherNative]::Open($selectedPath, $false) + Set-OrdinaryUserPreflightSubphase 'host-launcher-source-reopen-type' + Assert-OrdinaryHostLauncherHandle $sourceReopenHandle + Set-OrdinaryUserPreflightSubphase 'host-launcher-source-reopen-identity' + $sourceReopenIdentity = [ProprHostLauncherNative]::GetIdentity($sourceReopenHandle) + Set-OrdinaryUserPreflightSubphase 'host-launcher-source-reopen-final-path' + $sourceReopenFinalPath = Get-BoundedAbsoluteWindowsPath ( + ConvertFrom-NativeFinalPath ([ProprHostLauncherNative]::GetFinalPath($sourceReopenHandle)) + ) + Set-OrdinaryUserPreflightSubphase 'host-launcher-source-reopen-match' + if (![String]::Equals($authorityIdentity, $sourceReopenIdentity, [StringComparison]::Ordinal) -or + ![String]::Equals($finalPath, $sourceReopenFinalPath, [StringComparison]::OrdinalIgnoreCase)) { + Stop-PackagedConnect 'artifact-type' + } + + $authorityTransferred = $true + return [PSCustomObject]@{ Path = $finalPath; Handle = $authorityHandle } + } catch { + if ($_.Exception.Message -clike 'PROPR_PACKAGED_CONNECT_FAILURE:*') { throw } + $nativeException = $_.Exception + while ($null -ne $nativeException.InnerException) { $nativeException = $nativeException.InnerException } + if ($nativeException -is [ComponentModel.Win32Exception] -and $nativeException.NativeErrorCode -in @(2,3)) { + Stop-PackagedConnect 'artifact-missing' + } + Stop-PackagedConnect 'artifact-inaccessible' + } finally { + if ($null -ne $sourceHandle) { $sourceHandle.Dispose() } + if ($null -ne $sourceReopenHandle) { $sourceReopenHandle.Dispose() } + if (!$authorityTransferred -and $null -ne $authorityHandle) { $authorityHandle.Dispose() } + } +} + +function Assert-PeArchitecture { + param( + [Parameter(Mandatory=$true)][string]$Executable, + [Parameter(Mandatory=$true)][ValidateSet('x64','arm64')][string]$ExpectedArchitecture + ) + try { + $stream = [IO.FileStream]::new($Executable, [IO.FileMode]::Open, [IO.FileAccess]::Read, [IO.FileShare]::Read) + try { + $header = New-Object byte[] 4096 + $length = $stream.Read($header, 0, $header.Length) + } finally { + $stream.Dispose() + } + } catch { + Stop-PackagedConnect 'artifact-inaccessible' + } + if ($length -lt 64 -or [Text.Encoding]::ASCII.GetString($header, 0, 2) -cne 'MZ') { + Stop-PackagedConnect 'artifact-type' + } + $pe = [BitConverter]::ToUInt32($header, 0x3c) + if ($pe -lt 0x40 -or $pe + 6 -gt $length -or + [Text.Encoding]::ASCII.GetString($header, [int]$pe, 4) -cne "PE`0`0") { + Stop-PackagedConnect 'artifact-type' + } + $expectedMachine = if ($ExpectedArchitecture -eq 'arm64') { 0xaa64 } else { 0x8664 } + if ([BitConverter]::ToUInt16($header, [int]$pe + 4) -ne $expectedMachine) { + Stop-PackagedConnect 'architecture-mismatch' + } +} + +function Assert-PackageTreeTypes { + param([Parameter(Mandatory=$true)][string]$Root) + try { + $entries = @(Get-ChildItem -LiteralPath $Root -Force -Recurse -ErrorAction Stop) + } catch { + Stop-PackagedConnect 'artifact-inaccessible' + } + if ($entries.Count -lt 1 -or $entries.Count -gt 20000) { Stop-PackagedConnect 'artifact-type' } + foreach ($entry in $entries) { + if (($entry.Attributes -band [IO.FileAttributes]::ReparsePoint) -ne 0 -or + (!$entry.PSIsContainer -and !($entry -is [IO.FileInfo]))) { + Stop-PackagedConnect 'artifact-type' + } + } + return $entries +} + +function Assert-CopiedPackageTree { + param( + [Parameter(Mandatory=$true)][string]$SourceRoot, + [Parameter(Mandatory=$true)][object[]]$SourceEntries, + [Parameter(Mandatory=$true)][string]$DestinationRoot, + [Parameter(Mandatory=$true)][object[]]$DestinationEntries + ) + if ($SourceEntries.Count -ne $DestinationEntries.Count) { Stop-PackagedConnect 'artifact-type' } + $destinationByRelativePath = @{} + foreach ($entry in $DestinationEntries) { + $relative = $entry.FullName.Substring($DestinationRoot.Length).TrimStart('\') + if ([String]::IsNullOrEmpty($relative) -or $destinationByRelativePath.ContainsKey($relative)) { + Stop-PackagedConnect 'artifact-type' + } + $destinationByRelativePath.Add($relative, $entry) + } + foreach ($source in $SourceEntries) { + $relative = $source.FullName.Substring($SourceRoot.Length).TrimStart('\') + if (!$destinationByRelativePath.ContainsKey($relative)) { Stop-PackagedConnect 'artifact-missing' } + $destination = $destinationByRelativePath[$relative] + if ($source.PSIsContainer -ne $destination.PSIsContainer -or + (!$source.PSIsContainer -and $source.Length -ne $destination.Length)) { + Stop-PackagedConnect 'artifact-type' + } + } +} + +function Set-StagedEntryAcl { + param( + [Parameter(Mandatory=$true)][IO.FileSystemInfo]$Item, + [Parameter(Mandatory=$true)][Security.Principal.SecurityIdentifier]$OrdinaryUser, + [Parameter(Mandatory=$true)][Security.Principal.SecurityIdentifier]$Administrators + ) + $system = [Security.Principal.SecurityIdentifier]::new('S-1-5-18') + $directory = $Item.PSIsContainer + try { + $acl = if ($directory) { + [Security.AccessControl.DirectorySecurity]::new() + } else { + [Security.AccessControl.FileSecurity]::new() + } + $acl.SetAccessRuleProtection($true, $false) + $acl.SetOwner($Administrators) + foreach ($identity in @($OrdinaryUser, $system, $Administrators)) { + $rights = if ($identity.Value -eq $OrdinaryUser.Value) { + [Security.AccessControl.FileSystemRights]::ReadAndExecute -bor [Security.AccessControl.FileSystemRights]::Synchronize + } else { + [Security.AccessControl.FileSystemRights]::FullControl + } + $rule = if ($directory) { + [Security.AccessControl.FileSystemAccessRule]::new( + $identity, + $rights, + [Security.AccessControl.InheritanceFlags]::ContainerInherit -bor [Security.AccessControl.InheritanceFlags]::ObjectInherit, + [Security.AccessControl.PropagationFlags]::None, + [Security.AccessControl.AccessControlType]::Allow + ) + } else { + [Security.AccessControl.FileSystemAccessRule]::new( + $identity, $rights, [Security.AccessControl.AccessControlType]::Allow + ) + } + $null = $acl.AddAccessRule($rule) + } + if ($directory) { + [IO.Directory]::SetAccessControl($Item.FullName, [Security.AccessControl.DirectorySecurity]$acl) + } else { + [IO.File]::SetAccessControl($Item.FullName, [Security.AccessControl.FileSecurity]$acl) + } + } catch { + Stop-PackagedConnect 'artifact-inaccessible' + } +} + +function Assert-StagedEntryAcl { + param( + [Parameter(Mandatory=$true)][IO.FileSystemInfo]$Item, + [Parameter(Mandatory=$true)][Security.Principal.SecurityIdentifier]$OrdinaryUser, + [Parameter(Mandatory=$true)][Security.Principal.SecurityIdentifier]$Administrators + ) + $system = [Security.Principal.SecurityIdentifier]::new('S-1-5-18') + try { + $sections = [Security.AccessControl.AccessControlSections]::Access -bor [Security.AccessControl.AccessControlSections]::Owner + $acl = if ($Item.PSIsContainer) { + [IO.Directory]::GetAccessControl($Item.FullName, $sections) + } else { + [IO.File]::GetAccessControl($Item.FullName, $sections) + } + $owner = $acl.GetOwner([Security.Principal.SecurityIdentifier]) + $rules = @($acl.GetAccessRules($true, $true, [Security.Principal.SecurityIdentifier])) + } catch { + Stop-PackagedConnect 'artifact-inaccessible' + } + if ($owner.Value -ne $Administrators.Value -or !$acl.AreAccessRulesProtected -or + !$acl.AreAccessRulesCanonical -or $rules.Count -ne 3) { + Stop-PackagedConnect 'artifact-type' + } + foreach ($identity in @($OrdinaryUser, $system, $Administrators)) { + $matches = @($rules | Where-Object { $_.IdentityReference.Value -eq $identity.Value }) + $expected = if ($identity.Value -eq $OrdinaryUser.Value) { + [Security.AccessControl.FileSystemRights]::ReadAndExecute -bor [Security.AccessControl.FileSystemRights]::Synchronize + } else { + [Security.AccessControl.FileSystemRights]::FullControl + } + $expectedInheritance = if ($Item.PSIsContainer) { + [Security.AccessControl.InheritanceFlags]::ContainerInherit -bor [Security.AccessControl.InheritanceFlags]::ObjectInherit + } else { + [Security.AccessControl.InheritanceFlags]::None + } + if ($matches.Count -ne 1 -or + $matches[0].AccessControlType -ne [Security.AccessControl.AccessControlType]::Allow -or + $matches[0].FileSystemRights -ne $expected -or + $matches[0].InheritanceFlags -ne $expectedInheritance -or + $matches[0].PropagationFlags -ne [Security.AccessControl.PropagationFlags]::None -or + $matches[0].IsInherited) { + Stop-PackagedConnect 'artifact-type' + } + } +} + +$boundedCleanupSource = @' +$ErrorActionPreference='Stop' +$ProgressPreference='SilentlyContinue' +try { + $runnerTemp=$env:PROPR_CLEANUP_RUNNER_TEMP + $parent=$env:PROPR_CLEANUP_STAGE_PARENT + $leaf=$env:PROPR_CLEANUP_STAGE_LEAF + $privileged=[Security.Principal.SecurityIdentifier]::new($env:PROPR_CLEANUP_PRIVILEGED_SID) + $admins=[Security.Principal.SecurityIdentifier]::new('S-1-5-32-544') + if([String]::IsNullOrEmpty($runnerTemp) -or ![IO.Path]::IsPathRooted($runnerTemp) -or + ![String]::Equals([IO.Path]::GetFullPath($runnerTemp),$runnerTemp,[StringComparison]::OrdinalIgnoreCase)){exit 91} + if(![String]::IsNullOrEmpty($parent) -or ![String]::IsNullOrEmpty($leaf)){ + if([IO.Path]::GetDirectoryName($parent) -cne $runnerTemp -or + [IO.Path]::GetFileName($parent) -cne 'propr-connect-packaged-stage' -or + $leaf -cnotmatch '^propr-connect-package-[a-f0-9]{32}$'){exit 91} + $root=[IO.Path]::Combine($parent,$leaf) + if([IO.Path]::GetDirectoryName($root) -cne $parent -or [IO.Path]::GetFileName($root) -cne $leaf){exit 91} + if(Test-Path -LiteralPath $root){ + $items=@((Get-Item -LiteralPath $root -Force -ErrorAction Stop)) + $items+=@(Get-ChildItem -LiteralPath $root -Force -Recurse -ErrorAction Stop) + if($items.Count -gt 20001){exit 91} + foreach($item in $items){ + $isRoot=[String]::Equals($item.FullName,$root,[StringComparison]::OrdinalIgnoreCase) + if(($item.Attributes -band [IO.FileAttributes]::ReparsePoint) -ne 0 -or + ![String]::Equals([IO.Path]::GetFullPath($item.FullName),$item.FullName,[StringComparison]::OrdinalIgnoreCase) -or + (!$isRoot -and !$item.FullName.StartsWith($root+'\',[StringComparison]::OrdinalIgnoreCase)) -or + ($isRoot -and !$item.PSIsContainer)){exit 91} + $sections=[Security.AccessControl.AccessControlSections]::Owner + $acl=if($item.PSIsContainer){[IO.Directory]::GetAccessControl($item.FullName,$sections)}else{[IO.File]::GetAccessControl($item.FullName,$sections)} + $owner=$acl.GetOwner([Security.Principal.SecurityIdentifier]) + if(@($privileged.Value,$admins.Value) -cnotcontains $owner.Value){exit 91} + } + Remove-Item -LiteralPath $root -Recurse -Force -ErrorAction Stop + if(Test-Path -LiteralPath $root){exit 92} + } + if(Test-Path -LiteralPath $parent){ + $parentItem=Get-Item -LiteralPath $parent -Force -ErrorAction Stop + if(!$parentItem.PSIsContainer -or ($parentItem.Attributes -band [IO.FileAttributes]::ReparsePoint) -ne 0 -or + @(Get-ChildItem -LiteralPath $parent -Force -ErrorAction Stop).Count -ne 0){exit 91} + $parentAcl=[IO.Directory]::GetAccessControl($parent,[Security.AccessControl.AccessControlSections]::Owner) + $parentOwner=$parentAcl.GetOwner([Security.Principal.SecurityIdentifier]) + if(@($privileged.Value,$admins.Value) -cnotcontains $parentOwner.Value){exit 91} + Remove-Item -LiteralPath $parent -Force -ErrorAction Stop + if(Test-Path -LiteralPath $parent){exit 92} + } + } + foreach($capture in @($env:PROPR_CLEANUP_STDOUT,$env:PROPR_CLEANUP_STDERR)){ + if(![String]::IsNullOrEmpty($capture)){ + if([IO.Path]::GetDirectoryName($capture) -cne $runnerTemp -or + [IO.Path]::GetFileName($capture) -cnotmatch '^propr-connect-[a-f0-9]{32}\.(stdout|stderr)$'){exit 91} + if(Test-Path -LiteralPath $capture){ + $captureItem=Get-Item -LiteralPath $capture -Force -ErrorAction Stop + if($captureItem.PSIsContainer -or ($captureItem.Attributes -band [IO.FileAttributes]::ReparsePoint) -ne 0){exit 91} + $captureAcl=[IO.File]::GetAccessControl($capture,[Security.AccessControl.AccessControlSections]::Owner) + $captureOwner=$captureAcl.GetOwner([Security.Principal.SecurityIdentifier]) + if(@($privileged.Value,$admins.Value) -cnotcontains $captureOwner.Value){exit 91} + Remove-Item -LiteralPath $capture -Force -ErrorAction Stop + if(Test-Path -LiteralPath $capture){exit 92} + } + } + } + $user=$env:PROPR_CLEANUP_USER + $userSid=$env:PROPR_CLEANUP_USER_SID + if(![String]::IsNullOrEmpty($user) -or ![String]::IsNullOrEmpty($userSid)){ + if($user -cnotmatch '^prpc[a-f0-9]{12}$' -or [String]::IsNullOrEmpty($userSid)){exit 91} + $account=Get-LocalUser -Name $user -ErrorAction Stop + if($account.SID.Value -cne $userSid){exit 91} + Remove-LocalUser -Name $user -ErrorAction Stop + if($null -ne (Get-LocalUser -Name $user -ErrorAction SilentlyContinue)){exit 92} + } + exit 0 +} catch { exit 93 } +'@ + +function Invoke-BoundedCleanup { + param( + [string]$CleanupSource = $boundedCleanupSource, + [ref]$ObservedProcessId + ) + $encoded=[Convert]::ToBase64String([Text.Encoding]::Unicode.GetBytes($CleanupSource)) + $start=[Diagnostics.ProcessStartInfo]::new() + $start.FileName=Join-Path $PSHOME 'powershell.exe' + $start.Arguments="-NoLogo -NoProfile -NonInteractive -EncodedCommand $encoded" + $start.UseShellExecute=$false + $start.CreateNoWindow=$true + $start.RedirectStandardOutput=$true + $start.RedirectStandardError=$true + $start.EnvironmentVariables['PROPR_CLEANUP_RUNNER_TEMP']=[string]$authenticatedRunnerTemp + $cleanupStageParent=if($null -eq $stageLeaf){''}else{[string]$stageParent} + $cleanupStageLeaf=if($null -eq $stageLeaf){''}else{[string]$stageLeaf} + $start.EnvironmentVariables['PROPR_CLEANUP_STAGE_PARENT']=$cleanupStageParent + $start.EnvironmentVariables['PROPR_CLEANUP_STAGE_LEAF']=$cleanupStageLeaf + $start.EnvironmentVariables['PROPR_CLEANUP_PRIVILEGED_SID']=if($null -eq $privilegedSid){''}else{$privilegedSid.Value} + $start.EnvironmentVariables['PROPR_CLEANUP_STDOUT']=[string]$stdout + $start.EnvironmentVariables['PROPR_CLEANUP_STDERR']=[string]$stderr + $start.EnvironmentVariables['PROPR_CLEANUP_USER']=[string]$testUser + $start.EnvironmentVariables['PROPR_CLEANUP_USER_SID']=if($null -eq $testUserSid){''}else{$testUserSid.Value} + $cleanupProcess=[Diagnostics.Process]::new() + $cleanupProcess.StartInfo=$start + $cleanupOutputBuffer=[IO.MemoryStream]::new() + $cleanupErrorBuffer=[IO.MemoryStream]::new() + try { + if(!$cleanupProcess.Start()){return 'failed'} + if($null -ne $ObservedProcessId){$ObservedProcessId.Value=$cleanupProcess.Id} + $cleanupOutputClose=$cleanupProcess.StandardOutput.BaseStream.CopyToAsync($cleanupOutputBuffer) + $cleanupErrorClose=$cleanupProcess.StandardError.BaseStream.CopyToAsync($cleanupErrorBuffer) + if(!$cleanupProcess.WaitForExit($cleanupTimeoutMilliseconds)){ + try{$cleanupProcess.Kill()}catch{return 'failed'} + try{if(!$cleanupProcess.WaitForExit($terminationTimeoutMilliseconds)){return 'failed'}}catch{return 'failed'} + try { + if(![Threading.Tasks.Task]::WaitAll( + [Threading.Tasks.Task[]]@($cleanupOutputClose,$cleanupErrorClose), + $streamCloseTimeoutMilliseconds + ) -or $cleanupOutputClose.IsFaulted -or $cleanupErrorClose.IsFaulted){return 'failed'} + } catch { return 'failed' } + return 'timeout' + } + if(![Threading.Tasks.Task]::WaitAll( + [Threading.Tasks.Task[]]@($cleanupOutputClose,$cleanupErrorClose), + $streamCloseTimeoutMilliseconds + ) -or $cleanupOutputClose.IsFaulted -or $cleanupErrorClose.IsFaulted -or + $cleanupProcess.ExitCode -ne 0 -or $cleanupOutputBuffer.Length -ne 0 -or + $cleanupErrorBuffer.Length -ne 0){return 'failed'} + return 'none' + } catch { + try{ + if(!$cleanupProcess.HasExited){ + $cleanupProcess.Kill() + $null=$cleanupProcess.WaitForExit($terminationTimeoutMilliseconds) + } + }catch{} + return 'failed' + } finally { + $cleanupProcess.Dispose() + $cleanupOutputBuffer.Dispose() + $cleanupErrorBuffer.Dispose() + } +} + +$authenticatedRunnerTemp = $null +$administratorsSid = [Security.Principal.SecurityIdentifier]::new('S-1-5-32-544') + +if ($LifecycleTestMode -eq 'capture-redirection') { + $redirectionProcess = $null + $redirectionAccepted = $false + $redirectionFailurePredicate = $null + try { + Set-CaptureParseSubphase 'capture-authority' + Set-CaptureAuthorityPredicate 'pre-create' + if ([String]::IsNullOrEmpty($env:RUNNER_TEMP) -or ![IO.Path]::IsPathRooted($env:RUNNER_TEMP)) { + Stop-PackagedConnect 'artifact-type' + } + $authenticatedRunnerTemp = [IO.Path]::GetFullPath($env:RUNNER_TEMP).TrimEnd('\') + if ($authenticatedRunnerTemp -cne $env:RUNNER_TEMP.TrimEnd('\')) { + Stop-PackagedConnect 'artifact-type' + } + $privilegedSid = [Security.Principal.WindowsIdentity]::GetCurrent().User + $stdout = Join-Path $authenticatedRunnerTemp ( + 'propr-connect-' + [Guid]::NewGuid().ToString('N') + '.stdout' + ) + $stderr = Join-Path $authenticatedRunnerTemp ( + 'propr-connect-' + [Guid]::NewGuid().ToString('N') + '.stderr' + ) + $stdoutAuthority = Initialize-PrivilegedCaptureFile $stdout $privilegedSid + $stderrAuthority = Initialize-PrivilegedCaptureFile $stderr $privilegedSid + Set-CaptureAuthorityPredicate 'redirect-open' + $captureProducerExitCode = if ( + $CaptureRedirectionProducerTestCase -ceq 'nonzero' + ) { 23 } elseif ($CaptureRedirectionProducerTestCase -in @('empty','hostile')) { + 71 + } else { 0 } + $captureProducerSource = if ($CaptureRedirectionProducerTestCase -ceq 'empty') { + "exit $captureProducerExitCode" + } elseif ($CaptureRedirectionProducerTestCase -ceq 'hostile') { + "[Console]::Out.Write('C:\hostile\capture stdout environment-secret');" + + "[Console]::Error.Write('S-1-5-21 stderr native-text');" + + "exit $captureProducerExitCode" + } else { + "[Console]::Out.Write('capture-stdout');" + + "[Console]::Error.Write('capture-stderr');" + + "exit $captureProducerExitCode" + } + $captureProducerArgument = [Convert]::ToBase64String( + [Text.Encoding]::Unicode.GetBytes($captureProducerSource) + ) + $captureProducerArguments = ( + '-NoLogo -NoProfile -NonInteractive -EncodedCommand "' + + $captureProducerArgument + '"' + ) + $redirectionProcess = Start-Process ` + -FilePath (Join-Path $PSHOME 'powershell.exe') ` + -ArgumentList $captureProducerArguments ` + -PassThru ` + -RedirectStandardOutput $stdout ` + -RedirectStandardError $stderr ` + -ErrorAction Stop + if ($null -eq $redirectionProcess -or + !($redirectionProcess -is [System.Diagnostics.Process])) { + Stop-PackagedConnect 'spawn-failed' + } + Set-CaptureAuthorityPredicate 'redirect-open' + # PS5.1 must acquire the redirected process handle before waiting or ExitCode can remain unset. + $redirectionProcessHandle = $redirectionProcess.Handle + if ($redirectionProcessHandle -eq [IntPtr]::Zero) { + Stop-PackagedConnect 'spawn-failed' + } + Set-CaptureAuthorityPredicate 'redirect-timeout' + if (!$redirectionProcess.WaitForExit($terminationTimeoutMilliseconds)) { + Stop-PackagedConnect 'spawn-failed' + } + Assert-PrivilegedCaptureIdentity ` + $stdoutAuthority $privilegedSid -TestOnlyIdentityPredicate 'post-redirection-identity' + Assert-PrivilegedCaptureIdentity ` + $stderrAuthority $privilegedSid -TestOnlyIdentityPredicate 'post-redirection-identity' + Set-CaptureAuthorityPredicate 'redirect-child-exit' + $captureProducerActualExit = try { $redirectionProcess.ExitCode } catch { $null } + $captureProducerExitBucket = if ($captureProducerActualExit -eq 0) { + 'zero' + } elseif ($CaptureRedirectionProducerTestCase -ceq 'nonzero' -and + $captureProducerActualExit -eq 23) { + 'forced-23' + } else { + 'other' + } + Set-CaptureAuthorityPredicate 'capture-content' + $captureProducerStdoutState = Get-TestOnlyCaptureProducerOutputState ` + $stdoutAuthority $privilegedSid 'capture-stdout' + $captureProducerStderrState = Get-TestOnlyCaptureProducerOutputState ` + $stderrAuthority $privilegedSid 'capture-stderr' + $captureProducerResultAttributed = $true + Set-CaptureAuthorityPredicate 'redirect-child-exit' + if ($CaptureRedirectionProducerTestCase -cne 'success' -or + $captureProducerExitBucket -cne 'zero') { + Stop-PackagedConnect 'spawn-failed' + } + Set-CaptureAuthorityPredicate 'capture-content' + if ($captureProducerStdoutState -cne 'exact-expected' -or + $captureProducerStderrState -cne 'exact-expected') { + Stop-PackagedConnect 'artifact-type' + } + $redirectionAccepted = $true + } catch { + $redirectionFailurePredicate = if ( + $captureAuthorityPredicates -ccontains $captureAuthorityPredicate + ) { $captureAuthorityPredicate } else { 'pre-create' } + } finally { + $redirectionCleanupFailed = $false + Set-CaptureAuthorityPredicate 'cleanup' + if ($null -ne $redirectionProcess) { + try { + if (!$redirectionProcess.HasExited) { Stop-SpawnedProcess $redirectionProcess } + } catch { $redirectionCleanupFailed = $true } + try { $redirectionProcess.Dispose() } catch { $redirectionCleanupFailed = $true } + } + foreach ($authority in @($stdoutAuthority, $stderrAuthority)) { + if ($null -ne $authority -and $null -ne $authority.Handle) { + try { $authority.Handle.Dispose() } catch { $redirectionCleanupFailed = $true } + } + } + foreach ($capture in @($stdout, $stderr)) { + if (![String]::IsNullOrEmpty($capture)) { + try { + if (Test-Path -LiteralPath $capture) { + Remove-Item -LiteralPath $capture -Force -ErrorAction Stop + } + if (Test-Path -LiteralPath $capture) { $redirectionCleanupFailed = $true } + } catch { $redirectionCleanupFailed = $true } + } + } + if ($redirectionCleanupFailed -and $null -eq $redirectionFailurePredicate) { + $redirectionFailurePredicate = 'cleanup' + } + } + if ($redirectionAccepted -and $null -eq $redirectionFailurePredicate) { + [Console]::Out.WriteLine('PROPR_WINDOWS_PACKAGED_CONNECT_CAPTURE_REDIRECTION_TEST:accepted') + exit 0 + } + $primaryFailure = 'artifact-type' + $primaryPhase = 'capture-parse' + $primarySubphase = 'capture-authority' + if ($captureAuthorityPredicates -cnotcontains $redirectionFailurePredicate) { + $redirectionFailurePredicate = 'pre-create' + } + Set-CaptureAuthorityPredicate $redirectionFailurePredicate +} + +if ($LifecycleTestMode -eq 'capture-parser') { + try { + if ([String]::IsNullOrEmpty($env:RUNNER_TEMP) -or ![IO.Path]::IsPathRooted($env:RUNNER_TEMP)) { + Set-CaptureParseSubphase 'capture-authority' + Stop-PackagedConnect 'artifact-type' + } + $authenticatedRunnerTemp = [IO.Path]::GetFullPath($env:RUNNER_TEMP).TrimEnd('\') + if ($authenticatedRunnerTemp -cne $env:RUNNER_TEMP.TrimEnd('\')) { + Set-CaptureParseSubphase 'capture-authority' + Stop-PackagedConnect 'artifact-type' + } + $privilegedSid = [Security.Principal.WindowsIdentity]::GetCurrent().User + $testUserSid = [Security.Principal.SecurityIdentifier]::new( + 'S-1-5-21-42424242-42424242-42424242-1001' + ) + $stderr = $CaptureParserTestPath + Set-CaptureParseSubphase 'capture-authority' + $fixtureAuthority = Initialize-PrivilegedCaptureFile ` + -Path $stderr ` + -CapturePrivilegedSid $privilegedSid ` + -NormalizeExisting + $fixtureAuthority.Handle.Dispose() + $beforeCaptureReopen = $null + $allowCaptureReplacement = $false + $captureExpectedPrivilegedSid = $null + $captureExpectedParentOwnerSid = $null + if ($CaptureParserAuthorityTestCase -in @( + 'administrators-owner','current-owner','foreign-owner','ordinary-owner' + )) { + $captureOwner = if ($CaptureParserAuthorityTestCase -eq 'administrators-owner') { + $administratorsSid + } else { + $privilegedSid + } + $captureAcl = [IO.File]::GetAccessControl($stderr) + $captureAcl.SetOwner($captureOwner) + [IO.File]::SetAccessControl($stderr, $captureAcl) + } + if ($CaptureParserAuthorityTestCase -eq 'foreign-owner') { + $captureExpectedPrivilegedSid = [Security.Principal.SecurityIdentifier]::new( + 'S-1-5-21-51515151-51515151-51515151-1001' + ) + } elseif ($CaptureParserAuthorityTestCase -eq 'ordinary-owner') { + $testUserSid = $privilegedSid + } elseif ($CaptureParserAuthorityTestCase -in @('ordinary-write','broad-write')) { + $writeSid = if ($CaptureParserAuthorityTestCase -eq 'ordinary-write') { + $testUserSid + } else { + [Security.Principal.SecurityIdentifier]::new('S-1-1-0') + } + $captureAcl = [IO.File]::GetAccessControl($stderr) + $null = $captureAcl.AddAccessRule( + [Security.AccessControl.FileSystemAccessRule]::new( + $writeSid, + [Security.AccessControl.FileSystemRights]::FullControl, + [Security.AccessControl.AccessControlType]::Allow + ) + ) + [IO.File]::SetAccessControl($stderr, $captureAcl) + } elseif ($CaptureParserAuthorityTestCase -eq 'unprotected-dacl') { + $captureAcl = [IO.File]::GetAccessControl($stderr) + $captureAcl.SetAccessRuleProtection($false, $true) + [IO.File]::SetAccessControl($stderr, $captureAcl) + } elseif ($CaptureParserAuthorityTestCase -eq 'foreign-parent-owner') { + $captureExpectedParentOwnerSid = [Security.Principal.SecurityIdentifier]::new( + 'S-1-5-21-61616161-61616161-61616161-1001' + ) + } elseif ($CaptureParserAuthorityTestCase -eq 'identity-change') { + $allowCaptureReplacement = $true + $beforeCaptureReopen = { + $captureBackup = $stderr + '.propr-replaced' + $captureContent = [IO.File]::ReadAllBytes($stderr) + Move-Item -LiteralPath $stderr -Destination $captureBackup -ErrorAction Stop + [IO.File]::WriteAllBytes($stderr, $captureContent) + } + } + $childFailureCategory = Read-PackagedConnectSmokeFailure ` + -Path $stderr ` + -TestOnlyBeforeReopen $beforeCaptureReopen ` + -TestOnlyAllowReplacement:$allowCaptureReplacement ` + -TestOnlyCapturePrivilegedSid $captureExpectedPrivilegedSid ` + -TestOnlyExpectedParentOwnerSid $captureExpectedParentOwnerSid + Stop-PackagedConnect $childFailureCategory + } catch { + Set-PrimaryFailureFromException $_.Exception + } +} + +if ($LifecycleTestMode -eq 'diagnostic-subphase') { + Set-OrdinaryUserPreflightSubphase $DiagnosticTestSubphase + try { + throw [InvalidOperationException]::new( + 'C:\hostile\package S-1-5-21-123 account-name stdout stderr exception environment-secret' + ) + } catch { + Set-PrimaryFailureFromException $_.Exception + } +} + +if ($LifecycleTestMode -eq 'terminate-tree') { + $lifecycleTarget = $null + try { + if ($LifecycleTestProcessId -lt 1) { Stop-PackagedConnect 'spawn-failed' } + $lifecycleTarget = [Diagnostics.Process]::GetProcessById($LifecycleTestProcessId) + if ($lifecycleTarget.HasExited) { Stop-PackagedConnect 'spawn-failed' } + if ($lifecycleTarget.WaitForExit(250)) { Stop-PackagedConnect 'spawn-failed' } + Stop-SpawnedProcess $lifecycleTarget + if (!$lifecycleTarget.HasExited) { Stop-PackagedConnect 'spawn-failed' } + [Console]::Out.WriteLine('PROPR_WINDOWS_PACKAGED_CONNECT_LIFECYCLE_TEST:tree-terminated') + exit 0 + } catch { + [Console]::Error.WriteLine('PROPR_WINDOWS_PACKAGED_CONNECT_LIFECYCLE_TEST:failed:category=spawn-failed') + exit 1 + } finally { + if ($null -ne $lifecycleTarget) { $lifecycleTarget.Dispose() } + } +} + +if ($LifecycleTestMode -eq 'host-node-producer') { + try { + if ($HostNodeProducerTestCase -eq 'positive') { + $node = Get-ValidatedHostNodePath + } elseif ($HostNodeProducerTestCase -eq 'zero') { + $node = Get-ValidatedHostNodePath ` + -UseTestOnlyCommandResults ` + -TestOnlyCommandResults ([object[]]@()) + } else { + $knownApplications = @(Get-Command ` + -Name ([Diagnostics.Process]::GetCurrentProcess().MainModule.FileName) ` + -CommandType Application ` + -TotalCount 1 ` + -ErrorAction Stop) + if ($knownApplications.Count -ne 1) { + Set-OrdinaryUserPreflightSubphase 'host-node-command-cardinality' + Stop-PackagedConnect 'artifact-type' + } + $knownApplication = $knownApplications[0] + if (!($knownApplication -is [System.Management.Automation.ApplicationInfo])) { + Set-OrdinaryUserPreflightSubphase 'host-node-command-type' + Stop-PackagedConnect 'artifact-type' + } + if ($HostNodeProducerTestCase -eq 'non-application') { + $node = Get-ValidatedHostNodePath ` + -UseTestOnlyCommandResults ` + -TestOnlyCommandResults ([object[]]@( + [PSCustomObject]@{ Source = 'C:\hostile\node.exe' } + )) + } elseif ($HostNodeProducerTestCase -eq 'duplicate') { + $node = Get-ValidatedHostNodePath ` + -UseTestOnlyCommandResults ` + -TestOnlyCommandResults ([object[]]@($knownApplication, $knownApplication)) + } elseif ($HostNodeProducerTestCase -eq 'mixed-types') { + $node = Get-ValidatedHostNodePath ` + -UseTestOnlyCommandResults ` + -TestOnlyCommandResults ([object[]]@( + $knownApplication, + [PSCustomObject]@{ Source = 'C:\hostile\node.exe' } + )) + } elseif ($HostNodeProducerTestCase -in @('multiple','case-collision')) { + $otherApplications = @(Get-Command ` + -Name $taskkillExecutable ` + -CommandType Application ` + -TotalCount 1 ` + -ErrorAction Stop) + if ($otherApplications.Count -ne 1) { + Set-OrdinaryUserPreflightSubphase 'host-node-command-cardinality' + Stop-PackagedConnect 'artifact-type' + } + $otherApplication = $otherApplications[0] + if (!($otherApplication -is [System.Management.Automation.ApplicationInfo])) { + Set-OrdinaryUserPreflightSubphase 'host-node-command-type' + Stop-PackagedConnect 'artifact-type' + } + if ($HostNodeProducerTestCase -eq 'multiple') { + $node = Get-ValidatedHostNodePath ` + -UseTestOnlyCommandResults ` + -TestOnlyCommandResults ([object[]]@($knownApplication, $otherApplication)) + } else { + $node = Get-ValidatedHostNodePath ` + -UseTestOnlyCommandResults ` + -TestOnlyCommandResults ([object[]]@($knownApplication, $otherApplication)) ` + -TestOnlySourceProducer { + if ([String]::Equals( + $args[0].Source, + $knownApplication.Source, + [StringComparison]::Ordinal + )) { + 'C:\hostile\node.exe' + } else { + 'c:\hostile\node.exe' + } + } + } + } elseif ($HostNodeProducerTestCase -eq 'missing-source') { + $node = Get-ValidatedHostNodePath ` + -UseTestOnlyCommandResults ` + -TestOnlyCommandResults ([object[]]@($knownApplication)) ` + -TestOnlySourceProducer { $null } + } else { + $node = Get-ValidatedHostNodePath ` + -UseTestOnlyCommandResults ` + -TestOnlyCommandResults ([object[]]@($knownApplication)) ` + -TestOnlySourceProducer { [object[]]@('C:\hostile\one.exe', 'C:\hostile\two.exe') } + } + } + if (!($node -is [string]) -or [String]::IsNullOrEmpty($node)) { + Set-OrdinaryUserPreflightSubphase 'host-node-source' + Stop-PackagedConnect 'artifact-type' + } + [Console]::Out.WriteLine('PROPR_WINDOWS_PACKAGED_CONNECT_HOST_NODE_PRODUCER_TEST:accepted') + exit 0 + } catch { + Set-PrimaryFailureFromException $_.Exception + } +} + +if ($LifecycleTestMode -eq 'launcher-authority') { + Set-OrdinaryUserPreflightSubphase 'host-node-path-binding' + try { + $beforeFinalReopen = $null + $beforeSourceReopen = $null + if ($LauncherAuthorityTestCase -eq 'identity-mismatch') { + $beforeFinalReopen = { + $replacementBackup = $LauncherAuthorityTestPath + '.propr-identity-' + [Guid]::NewGuid().ToString('N') + Move-Item -LiteralPath $LauncherAuthorityTestPath -Destination $replacementBackup -ErrorAction Stop + [IO.File]::WriteAllBytes($LauncherAuthorityTestPath, [byte[]]@(0x4d,0x5a)) + } + } elseif ($LauncherAuthorityTestCase -eq 'retarget-alias') { + $beforeSourceReopen = { + $null = Get-BoundedAbsoluteWindowsPath $LauncherAuthorityTestRetargetPath + Remove-Item -LiteralPath $LauncherAuthorityTestPath -Force -ErrorAction Stop + $null = New-Item ` + -ItemType SymbolicLink ` + -Path $LauncherAuthorityTestPath ` + -Target $LauncherAuthorityTestRetargetPath ` + -ErrorAction Stop + } + } + $launcherAuthority = Get-TrustedHostLauncher ` + -Path $LauncherAuthorityTestPath ` + -TestOnlyBeforeFinalReopen $beforeFinalReopen ` + -TestOnlyBeforeSourceReopen $beforeSourceReopen + $launcherAuthority.Handle.Dispose() + $launcherAuthority = $null + [Console]::Out.WriteLine('PROPR_WINDOWS_PACKAGED_CONNECT_LAUNCHER_AUTHORITY_TEST:accepted') + exit 0 + } catch { + Set-PrimaryFailureFromException $_.Exception + } finally { + if ($null -ne $launcherAuthority) { + $launcherAuthority.Handle.Dispose() + $launcherAuthority = $null + } + } +} + +if ($LifecycleTestMode -in @( + 'diagnostic-subphase','host-node-producer','launcher-authority','capture-parser','capture-redirection' + )) { + # The shared final diagnostic below emits the injected fixed state. +} elseif ($LifecycleTestMode -eq 'cleanup-timeout') { + $cleanupTimeoutMilliseconds = 750 + $terminationTimeoutMilliseconds = 3000 + $streamCloseTimeoutMilliseconds = 3000 + $primaryFailure = 'artifact-type' + $primaryPhase = 'staged-tree' + $neverSettlingCleanupSource = 'while($true){Start-Sleep -Seconds 1}' + $observedCleanupProcessId = 0 + $cleanupResult = Invoke-BoundedCleanup ` + -CleanupSource $neverSettlingCleanupSource ` + -ObservedProcessId ([ref]$observedCleanupProcessId) + $cleanupProcessStillRunning = $false + if ($observedCleanupProcessId -gt 0) { + try { + $observedCleanupProcess = [Diagnostics.Process]::GetProcessById($observedCleanupProcessId) + try { $cleanupProcessStillRunning = !$observedCleanupProcess.HasExited } finally { $observedCleanupProcess.Dispose() } + } catch {} + } + if ($cleanupResult -eq 'timeout' -and !$cleanupProcessStillRunning) { + $cleanupSecondary = 'cleanup-timeout' + } else { + $cleanupSecondary = 'cleanup-failed' + } +} else { +try { + try { + Set-FailurePhase 'source-layout' + $desktopDirectory = [IO.Path]::GetFullPath((Join-Path $PSScriptRoot '..')) + $sourceRoot = [IO.Path]::GetFullPath((Join-Path $desktopDirectory "out\propr-desktop-win32-$Architecture")) + if ([IO.Path]::GetDirectoryName($sourceRoot) -cne (Join-Path $desktopDirectory 'out') -or + [IO.Path]::GetFileName($sourceRoot) -cne "propr-desktop-win32-$Architecture") { + Stop-PackagedConnect 'artifact-type' + } + $null = Get-CanonicalItem $sourceRoot 'directory' + $sourceExecutable = Join-Path $sourceRoot 'propr-desktop.exe' + $sourceResources = Join-Path $sourceRoot 'resources' + $sourceArchive = Join-Path $sourceResources 'app.asar' + $sourceLocales = Join-Path $sourceRoot 'locales' + $null = Get-CanonicalItem $sourceExecutable 'file' + $null = Get-CanonicalItem $sourceResources 'directory' + $null = Get-CanonicalItem $sourceArchive 'file' + $null = Get-CanonicalItem $sourceLocales 'directory' + foreach ($requiredFile in @('chrome_100_percent.pak','chrome_200_percent.pak','icudtl.dat','resources.pak','v8_context_snapshot.bin')) { + $null = Get-CanonicalItem (Join-Path $sourceRoot $requiredFile) 'file' + } + $sourceEntries = @(Assert-PackageTreeTypes $sourceRoot) + Assert-PeArchitecture $sourceExecutable $Architecture + + Set-FailurePhase 'runner-authority' + if ([String]::IsNullOrEmpty($env:RUNNER_TEMP) -or ![IO.Path]::IsPathRooted($env:RUNNER_TEMP)) { + Stop-PackagedConnect 'artifact-type' + } + $authenticatedRunnerTemp = [IO.Path]::GetFullPath($env:RUNNER_TEMP) + if ($authenticatedRunnerTemp -cne $env:RUNNER_TEMP.TrimEnd('\')) { + Stop-PackagedConnect 'artifact-type' + } + $runnerTempItem = Get-CanonicalItem $authenticatedRunnerTemp 'directory' + $currentSid = [Security.Principal.WindowsIdentity]::GetCurrent().User + $privilegedSid = $currentSid + $runnerTempAcl = [IO.Directory]::GetAccessControl( + $authenticatedRunnerTemp, + [Security.AccessControl.AccessControlSections]::Owner + ) + $runnerTempOwner = $runnerTempAcl.GetOwner([Security.Principal.SecurityIdentifier]) + if ($null -eq $currentSid -or @($currentSid.Value, 'S-1-5-18', 'S-1-5-32-544') -cnotcontains $runnerTempOwner.Value) { + Stop-PackagedConnect 'artifact-type' + } + $privilegedPrincipal = [Security.Principal.WindowsPrincipal]::new([Security.Principal.WindowsIdentity]::GetCurrent()) + if (!$privilegedPrincipal.IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)) { + Stop-PackagedConnect 'artifact-inaccessible' + } + + $stageParent = Join-Path $authenticatedRunnerTemp 'propr-connect-packaged-stage' + if (Test-Path -LiteralPath $stageParent) { Stop-PackagedConnect 'artifact-type' } + + Set-FailurePhase 'account-setup' + $testUser = 'prpc' + [Guid]::NewGuid().ToString('N').Substring(0, 12) + $plainPassword = [Guid]::NewGuid().ToString('N') + 'aA1!' + $securePassword = ConvertTo-SecureString $plainPassword -AsPlainText -Force + $credential = [Management.Automation.PSCredential]::new("$env:COMPUTERNAME\$testUser", $securePassword) + $createdUser = New-LocalUser -Name $testUser -Password $securePassword -PasswordNeverExpires -ErrorAction Stop + $testUserSid = $createdUser.SID + if ($null -eq $testUserSid -or $testUser.Length -gt 20) { Stop-PackagedConnect 'artifact-type' } + $createdAccount = Get-LocalUser -Name $testUser -ErrorAction Stop + if ($createdAccount.SID.Value -cne $testUserSid.Value) { Stop-PackagedConnect 'artifact-type' } + $administratorsAccount = $administratorsSid.Translate([Security.Principal.NTAccount]).Value + $administratorsName = $administratorsAccount.Substring($administratorsAccount.IndexOf('\') + 1) + if ([String]::IsNullOrEmpty($administratorsName)) { Stop-PackagedConnect 'artifact-type' } + $administratorsGroup = [ADSI]("WinNT://$env:COMPUTERNAME/$administratorsName,group") + $ordinaryUserEntry = [ADSI]("WinNT://$env:COMPUTERNAME/$testUser,user") + if ([bool]$administratorsGroup.psbase.Invoke('IsMember', $ordinaryUserEntry.Path)) { + Stop-PackagedConnect 'artifact-type' + } + + Set-FailurePhase 'staging-copy' + $stageLeaf = 'propr-connect-package-' + [Guid]::NewGuid().ToString('N') + $stageRoot = Join-Path $stageParent $stageLeaf + $null = New-Item -ItemType Directory -Path $stageParent -ErrorAction Stop + $null = New-Item -ItemType Directory -Path $stageRoot -ErrorAction Stop + foreach ($entry in Get-ChildItem -LiteralPath $sourceRoot -Force -ErrorAction Stop) { + Copy-Item -LiteralPath $entry.FullName -Destination $stageRoot -Recurse -Force -ErrorAction Stop + } + $stagedEntries = @(Assert-PackageTreeTypes $stageRoot) + Assert-CopiedPackageTree $sourceRoot $sourceEntries $stageRoot $stagedEntries + $null = Get-CanonicalItem $stageRoot 'directory' + $stagedExecutable = Join-Path $stageRoot 'propr-desktop.exe' + $null = Get-CanonicalItem $stagedExecutable 'file' + $null = Get-CanonicalItem (Join-Path $stageRoot 'resources') 'directory' + $null = Get-CanonicalItem (Join-Path $stageRoot 'resources\app.asar') 'file' + Assert-PeArchitecture $stagedExecutable $Architecture + + Set-FailurePhase 'staging-acl' + $aclEntries = @((Get-Item -LiteralPath $stageParent -Force), (Get-Item -LiteralPath $stageRoot -Force)) + $aclEntries += @(Get-ChildItem -LiteralPath $stageRoot -Force -Recurse -ErrorAction Stop) + foreach ($item in $aclEntries) { Set-StagedEntryAcl $item $testUserSid $administratorsSid } + foreach ($item in $aclEntries) { Assert-StagedEntryAcl $item $testUserSid $administratorsSid } + + $node = Get-ValidatedHostNodePath + Set-OrdinaryUserPreflightSubphase 'host-node-path-binding' + $launcherAuthority = Get-TrustedHostLauncher -Path $node + Set-OrdinaryUserPreflightSubphase 'host-node-launcher-return-authority' + $launcherAuthorityResults = @($launcherAuthority) + if ($launcherAuthorityResults.Count -ne 1) { Stop-PackagedConnect 'artifact-type' } + $launcherAuthority = $launcherAuthorityResults[0] + $launcherPathProperty = $launcherAuthority.PSObject.Properties['Path'] + $launcherHandleProperty = $launcherAuthority.PSObject.Properties['Handle'] + if ($null -eq $launcherPathProperty -or $null -eq $launcherHandleProperty -or + !($launcherPathProperty.Value -is [string]) -or + [String]::IsNullOrEmpty($launcherPathProperty.Value) -or + !($launcherHandleProperty.Value -is [Microsoft.Win32.SafeHandles.SafeFileHandle]) -or + $launcherHandleProperty.Value.IsInvalid -or $launcherHandleProperty.Value.IsClosed) { + Stop-PackagedConnect 'artifact-type' + } + $node = $launcherPathProperty.Value + Set-OrdinaryUserPreflightSubphase 'host-capture-contract' + $stdout = Join-Path $authenticatedRunnerTemp ('propr-connect-' + [Guid]::NewGuid().ToString('N') + '.stdout') + $stderr = Join-Path $authenticatedRunnerTemp ('propr-connect-' + [Guid]::NewGuid().ToString('N') + '.stderr') + if ((Test-Path -LiteralPath $stdout) -or (Test-Path -LiteralPath $stderr)) { + Stop-PackagedConnect 'artifact-type' + } + $stdoutAuthority = Initialize-PrivilegedCaptureFile $stdout $privilegedSid + $stderrAuthority = Initialize-PrivilegedCaptureFile $stderr $privilegedSid + Set-OrdinaryUserPreflightSubphase 'host-staging-handoff' + $handoffText = [String]::Join("`n", [string[]]@($authenticatedRunnerTemp, $stageParent, $stageLeaf)) + $handoffBytes = [Text.Encoding]::UTF8.GetBytes($handoffText) + $handoffArgument = '--propr-windows-staged-contract=' + [Convert]::ToBase64String($handoffBytes) + if ($handoffArgument.Length -gt 16384 -or $handoffArgument -cnotmatch '^--propr-windows-staged-contract=[A-Za-z0-9+/]+={0,2}$') { + Stop-PackagedConnect 'artifact-type' + } + try { + Set-FailurePhase 'application-spawn' + try { + $process = Start-Process ` + -FilePath $node ` + -ArgumentList @('scripts/smoke-packaged-connect.mjs', $handoffArgument) ` + -WorkingDirectory $desktopDirectory ` + -Credential $credential ` + -LoadUserProfile ` + -PassThru ` + -RedirectStandardOutput $stdout ` + -RedirectStandardError $stderr ` + -ErrorAction Stop + Set-CaptureParseSubphase 'capture-authority' + Assert-PrivilegedCaptureIdentity $stdoutAuthority $privilegedSid + Assert-PrivilegedCaptureIdentity $stderrAuthority $privilegedSid + } finally { + $launcherAuthority.Handle.Dispose() + $launcherAuthority = $null + } + } catch { + if ($_.Exception.Message -clike 'PROPR_PACKAGED_CONNECT_FAILURE:*') { throw } + Stop-PackagedConnect 'spawn-failed' + } + Set-FailurePhase 'application-runtime' + try { + if (!$process.WaitForExit($applicationTimeoutMilliseconds)) { + Stop-SpawnedProcess $process + Stop-PackagedConnect 'spawn-failed' + } + } catch { + try { Stop-SpawnedProcess $process } catch {} + if ($_.Exception.Message -clike 'PROPR_PACKAGED_CONNECT_FAILURE:*') { throw } + Stop-PackagedConnect 'spawn-failed' + } + Set-CaptureParseSubphase 'capture-authority' + Assert-PrivilegedCaptureIdentity $stdoutAuthority $privilegedSid + Assert-PrivilegedCaptureIdentity $stderrAuthority $privilegedSid + if ($process.ExitCode -ne 0) { + try { + $childFailureCategory = Read-PackagedConnectSmokeFailure ` + -Path $stderr ` + -ExpectedCaptureIdentity $stderrAuthority.Identity + Stop-PackagedConnect $childFailureCategory + } catch { + if ($_.Exception.Message -clike 'PROPR_PACKAGED_CONNECT_FAILURE:*') { throw } + Stop-PackagedConnect 'artifact-type' + } + } + Set-FailurePhase 'result-verify' + foreach ($capture in @($stdout, $stderr)) { + $captureItem = Get-CanonicalItem $capture 'file' + if ($captureItem.Length -gt 65536) { Stop-PackagedConnect 'spawn-failed' } + } + $capturedStdout = [IO.File]::ReadAllText($stdout) + $capturedStderr = [IO.File]::ReadAllText($stderr) + $expectedSuccess = "Packaged Connect discovery passed for win32-$Architecture`: inherited-standard-handle." + if ($capturedStderr.Length -ne 0 -or $capturedStdout.TrimEnd("`r", "`n") -cne $expectedSuccess) { + Stop-PackagedConnect 'spawn-failed' + } + } catch { + Set-PrimaryFailureFromException $_.Exception + } +} finally { + if ($null -ne $launcherAuthority) { + try { $launcherAuthority.Handle.Dispose() } catch {} + $launcherAuthority = $null + } + foreach ($authority in @($stdoutAuthority, $stderrAuthority)) { + if ($null -ne $authority -and $null -ne $authority.Handle) { + try { $authority.Handle.Dispose() } catch {} + } + } + if ($null -ne $authenticatedRunnerTemp -and $null -ne $privilegedSid) { + $cleanupResult = Invoke-BoundedCleanup + if ($cleanupResult -eq 'timeout') { + $cleanupSecondary = 'cleanup-timeout' + } elseif ($cleanupResult -ne 'none') { + $cleanupSecondary = 'cleanup-failed' + } + } +} +} + +if ($null -eq $primaryFailure -and $cleanupSecondary -ne 'none') { + $primaryFailure = 'artifact-inaccessible' + $primaryPhase = 'cleanup' +} +if ($null -ne $primaryFailure) { + if ($failureCategories -cnotcontains $primaryFailure) { $primaryFailure = 'spawn-failed' } + if ($failurePhases -cnotcontains $primaryPhase) { $primaryPhase = 'application-runtime' } + $subphaseEvidence = '' + if ($primaryPhase -ceq 'ordinary-user-preflight') { + if ($failureSubphases -cnotcontains $primarySubphase) { + $primarySubphase = 'host-state-contract' + } + $subphaseEvidence = ":subphase=$primarySubphase" + } elseif ($primaryPhase -ceq 'staged-contract' -and + $childStagedContractSubphases -ccontains $primarySubphase) { + $subphaseEvidence = ":subphase=$primarySubphase" + } elseif ($primaryPhase -ceq 'capture-parse' -and + $captureParseSubphases -ccontains $primarySubphase) { + $subphaseEvidence = ":subphase=$primarySubphase" + if ($LifecycleTestMode -in @('capture-parser','capture-redirection') -and + $primarySubphase -ceq 'capture-authority' -and + $captureAuthorityPredicates -ccontains $captureAuthorityPredicate) { + $subphaseEvidence += ":predicate=$captureAuthorityPredicate" + if ($LifecycleTestMode -ceq 'capture-redirection' -and + $captureProducerResultPredicates -ccontains $captureAuthorityPredicate -and + $captureProducerResultAttributed -and + $captureProducerExitBuckets -ccontains $captureProducerExitBucket -and + $captureProducerOutputStates -ccontains $captureProducerStdoutState -and + $captureProducerOutputStates -ccontains $captureProducerStderrState) { + $subphaseEvidence += ":exit=$captureProducerExitBucket" + + ":out=$captureProducerStdoutState`:err=$captureProducerStderrState" + } + } + } elseif ($primaryPhase -ceq 'application-runtime' -and + $lifecycleFailureSubphases -ccontains $primarySubphase) { + $subphaseEvidence = ":subphase=$primarySubphase" + } + [Console]::Error.WriteLine("PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=$primaryFailure`:phase=$primaryPhase$subphaseEvidence`:cleanup=$cleanupSecondary") + exit 1 +} +[Console]::Out.WriteLine("PROPR_WINDOWS_PACKAGED_CONNECT:passed:$Architecture") diff --git a/apps/desktop/scripts/sign-darwin-packaged-connect.mjs b/apps/desktop/scripts/sign-darwin-packaged-connect.mjs new file mode 100644 index 000000000..b494d6076 --- /dev/null +++ b/apps/desktop/scripts/sign-darwin-packaged-connect.mjs @@ -0,0 +1,191 @@ +#!/usr/bin/env node + +import { lstat, open, readdir } from 'node:fs/promises'; +import { extname, join, sep } from 'node:path'; +import { fileURLToPath } from 'node:url'; +import { runBoundedProcess } from './run-bounded-darwin-command.mjs'; + +const CERTIFICATE_SHA1 = /^[A-F0-9]{40}$/u; +const CERTIFICATE_LINE = /^\s*SHA-1 hash:\s*([A-Fa-f0-9]{40})\s*$/gmu; +const PACKAGED_CONNECT_NATIVE_ARTIFACTS = /\/Resources\/app\.asar\.unpacked\/\.vite\/native\/prebuilds\//u; +const CODESIGN_TIMEOUT_MS = 30_000; +const CODESIGN_MAX_OUTPUT_BYTES = 256 * 1024; +const REQUIRED_IDENTIFIER = 'dev.propr.desktop'; +const MACH_O_MAGICS = new Set([ + 0xFEEDFACE, 0xFEEDFACF, 0xCEFAEDFE, 0xCFFAEDFE, + 0xCAFEBABE, 0xBEBAFECA, 0xCAFEBABF, 0xBFBAFECA, +]); + +export const DARWIN_SIGNING_DIAGNOSTICS = Object.freeze({ + missingIdentityOrChain: 'MISSING_IDENTITY_OR_CHAIN', + trustRejection: 'TRUST_REJECTION', + requirementsFailure: 'REQUIREMENTS_FAILURE', + codesignFailure: 'CODESIGN_FAILURE', +}); + +export class DarwinSigningDiagnosticError extends Error { + constructor(diagnostic, cause) { + super(`darwin-signing-${diagnostic.toLowerCase()}`, { cause }); + this.name = 'DarwinSigningDiagnosticError'; + this.diagnostic = diagnostic; + } +} + +const failureText = error => [ + error?.message, + error?.stdout, + error?.stderr, + error?.result?.stdout, + error?.result?.stderr, + error?.cause?.message, +].filter(value => typeof value === 'string').join('\n'); + +export const classifyDarwinSigningFailure = error => { + if (error instanceof DarwinSigningDiagnosticError) return error.diagnostic; + const details = failureText(error); + if (/CSSMERR_TP_NOT_TRUSTED|errSecNotTrusted|certificate (?:is )?not trusted|trust evaluation/iu.test(details)) { + return DARWIN_SIGNING_DIAGNOSTICS.trustRejection; + } + if (/unable to build chain|incomplete certificate chain|no identity found|identity[^\n]*not found|specified item could not be found in the keychain/iu.test(details)) { + return DARWIN_SIGNING_DIAGNOSTICS.missingIdentityOrChain; + } + if (/designated requirement|invalid requirement|code requirement|requirement compilation/iu.test(details)) { + return DARWIN_SIGNING_DIAGNOSTICS.requirementsFailure; + } + return DARWIN_SIGNING_DIAGNOSTICS.codesignFailure; +}; + +export const darwinSigningDiagnosticLine = error => ( + `DARWIN_PACKAGED_CONNECT_DIAGNOSTIC:${classifyDarwinSigningFailure(error)}\n` +); + +const signingRank = filePath => { + const depth = filePath.split(sep).length; + return depth * 2 + (/\.app\/Contents\/MacOS\/[^/]+$/u.test(filePath) ? 0 : 1); +}; + +const runSigningCommand = (runCommand, executable, arguments_) => runCommand({ + executable, + arguments: arguments_, + timeoutMs: CODESIGN_TIMEOUT_MS, + // Settle the nested command group before the outer signing wrapper's five-second escalation. + terminationGraceMs: 1_000, + maxOutputBytes: CODESIGN_MAX_OUTPUT_BYTES, + forwardOutput: false, +}); + +const assertExactImportedCertificate = (output, certificateSha1) => { + const fingerprints = [...output.matchAll(CERTIFICATE_LINE)] + .map(match => match[1].toUpperCase()); + if (fingerprints.length !== 1 || fingerprints[0] !== certificateSha1) { + throw new DarwinSigningDiagnosticError( + DARWIN_SIGNING_DIAGNOSTICS.missingIdentityOrChain, + ); + } +}; + +const isMachO = async filePath => { + const handle = await open(filePath, 'r'); + try { + const header = Buffer.alloc(4); + const { bytesRead } = await handle.read(header, 0, header.length, 0); + return bytesRead === header.length && MACH_O_MAGICS.has(header.readUInt32BE(0)); + } finally { + await handle.close(); + } +}; + +export const discoverDarwinSignablePaths = async root => { + const discovered = []; + const visit = async directory => { + const entries = await readdir(directory); + entries.sort(); + for (const entry of entries) { + const filePath = join(directory, entry); + const stats = await lstat(filePath); + if (stats.isSymbolicLink()) continue; + if (stats.isDirectory()) { + await visit(filePath); + if (extname(filePath) === '.app' || extname(filePath) === '.framework') { + discovered.push(filePath); + } + } else if (stats.isFile() && await isMachO(filePath)) { + discovered.push(filePath); + } + } + }; + await visit(root); + return discovered; +}; + +export const signDarwinPackagedConnectApplication = async ({ + application, + keychain, + certificateSha1, + discover = discoverDarwinSignablePaths, + runCommand = runBoundedProcess, +}) => { + if (!application.endsWith('.app') || !keychain.endsWith('.keychain-db') + || !CERTIFICATE_SHA1.test(certificateSha1)) { + throw new Error('invalid-acceptance-signing-input'); + } + const certificateResult = await runSigningCommand(runCommand, '/usr/bin/security', [ + 'find-certificate', '-a', '-Z', keychain, + ]).catch(error => { + throw new DarwinSigningDiagnosticError( + DARWIN_SIGNING_DIAGNOSTICS.missingIdentityOrChain, + error, + ); + }); + assertExactImportedCertificate( + `${certificateResult.stdout}\n${certificateResult.stderr}`, + certificateSha1, + ); + + const designatedRequirement = `designated => identifier "${REQUIRED_IDENTIFIER}" and certificate leaf = H"${certificateSha1}"`; + const discovered = (await discover(join(application, 'Contents'))) + .filter(filePath => !PACKAGED_CONNECT_NATIVE_ARTIFACTS.test(filePath)); + const targets = [...discovered, application] + .sort((left, right) => signingRank(right) - signingRank(left)); + const targetsByRank = new Map(); + for (const target of targets) { + const rank = signingRank(target); + targetsByRank.set(rank, [...(targetsByRank.get(rank) ?? []), target]); + } + + for (const targetGroup of targetsByRank.values()) { + const isApplication = targetGroup.length === 1 && targetGroup[0] === application; + const arguments_ = [ + '--sign', certificateSha1, + '--force', + '--keychain', keychain, + '--timestamp=none', + ...(isApplication ? [ + '--identifier', REQUIRED_IDENTIFIER, + '--preserve-metadata=entitlements,flags', + ] : [ + '--preserve-metadata=identifier,entitlements,flags', + ]), + ...(isApplication ? [`-r=${designatedRequirement}`] : []), + ...targetGroup, + ]; + await runSigningCommand(runCommand, '/usr/bin/codesign', arguments_); + } + await runSigningCommand(runCommand, '/usr/bin/codesign', [ + '--verify', '--deep', '--strict', application, + ]); +}; + +const isMain = process.argv[1] && fileURLToPath(import.meta.url) === process.argv[1]; +if (isMain) { + const [application, keychain, certificateSha1] = process.argv.slice(2); + try { + if (process.platform !== 'darwin' || !application || !keychain || !certificateSha1) { + throw new Error('invalid-invocation'); + } + await signDarwinPackagedConnectApplication({ application, keychain, certificateSha1 }); + } catch (error) { + process.stderr.write(darwinSigningDiagnosticLine(error)); + process.exitCode = 1; + } +} diff --git a/apps/desktop/scripts/sign-darwin-packaged-connect.test.mjs b/apps/desktop/scripts/sign-darwin-packaged-connect.test.mjs new file mode 100644 index 000000000..aea733459 --- /dev/null +++ b/apps/desktop/scripts/sign-darwin-packaged-connect.test.mjs @@ -0,0 +1,137 @@ +import assert from 'node:assert/strict'; +import { mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import { describe, test } from 'node:test'; +import { + DARWIN_SIGNING_DIAGNOSTICS, + classifyDarwinSigningFailure, + darwinSigningDiagnosticLine, + discoverDarwinSignablePaths, + signDarwinPackagedConnectApplication, +} from './sign-darwin-packaged-connect.mjs'; + +const fingerprint = 'A'.repeat(40); +const application = '/tmp/propr-desktop.app'; +const keychain = '/tmp/propr-smoke.keychain-db'; +const nativeArtifact = `${application}/Contents/Resources/app.asar.unpacked/.vite/native/prebuilds/darwin-arm64/directory-operations.node`; + +describe('Darwin packaged Connect direct signing', () => { + test('discovers Mach-O files and nested code bundles', async () => { + const root = await mkdtemp(join(tmpdir(), 'propr-darwin-signables-')); + try { + const helper = join(root, 'Helper.app'); + const executable = join(helper, 'Contents', 'MacOS', 'Helper'); + const framework = join(root, 'Library.framework'); + await mkdir(join(helper, 'Contents', 'MacOS'), { recursive: true }); + await mkdir(framework); + await writeFile(executable, Buffer.from([0xCF, 0xFA, 0xED, 0xFE, 0x00])); + await writeFile(join(root, 'data.bin'), Buffer.from('not executable code')); + assert.deepEqual(await discoverDarwinSignablePaths(root), [ + executable, + helper, + framework, + ]); + } finally { + await rm(root, { recursive: true, force: true }); + } + }); + + test('selects the exact certificate and signs inside-out with fixed noninteractive options', async () => { + const calls = []; + const framework = `${application}/Contents/Frameworks/Electron Framework.framework`; + const helper = `${application}/Contents/Frameworks/propr Helper.app`; + const helperExecutable = `${helper}/Contents/MacOS/propr Helper`; + const mainExecutable = `${application}/Contents/MacOS/propr-desktop`; + await signDarwinPackagedConnectApplication({ + application, + keychain, + certificateSha1: fingerprint, + discover: async () => [mainExecutable, framework, helper, helperExecutable, nativeArtifact], + runCommand: async options => { + calls.push(options); + if (options.executable === '/usr/bin/security') { + return { stdout: `SHA-1 hash: ${fingerprint}\n`, stderr: '' }; + } + return { stdout: '', stderr: '' }; + }, + }); + + assert.deepEqual(calls[0].arguments, ['find-certificate', '-a', '-Z', keychain]); + const signingCalls = calls.filter(call => call.arguments[0] === '--sign'); + const signedTargets = signingCalls.flatMap(call => call.arguments.filter(argument => ( + argument.startsWith(application) + ))); + assert.equal(signedTargets.includes(nativeArtifact), false); + assert.equal(signedTargets.at(-1), application); + assert.ok(signedTargets.indexOf(helperExecutable) < signedTargets.indexOf(helper)); + assert.ok(signedTargets.indexOf(helper) < signedTargets.indexOf(mainExecutable)); + for (const call of signingCalls) { + assert.equal(call.executable, '/usr/bin/codesign'); + assert.equal(call.forwardOutput, false); + assert.equal(call.timeoutMs, 30_000); + assert.equal(call.terminationGraceMs, 1_000); + } + const nestedArguments = targets => [ + '--sign', fingerprint, + '--force', + '--keychain', keychain, + '--timestamp=none', + '--preserve-metadata=identifier,entitlements,flags', + ...targets, + ]; + assert.deepEqual(signingCalls.map(call => call.arguments), [ + nestedArguments([helperExecutable]), + nestedArguments([framework, helper]), + nestedArguments([mainExecutable]), + [ + '--sign', fingerprint, + '--force', + '--keychain', keychain, + '--timestamp=none', + '--identifier', 'dev.propr.desktop', + '--preserve-metadata=entitlements,flags', + `-r=designated => identifier "dev.propr.desktop" and certificate leaf = H"${fingerprint}"`, + application, + ], + ]); + assert.deepEqual(calls.at(-1).arguments, [ + '--verify', '--deep', '--strict', application, + ]); + }); + + test('fails before codesign when the imported certificate is absent, duplicate, or wrong', async () => { + for (const stdout of [ + '', + `SHA-1 hash: ${fingerprint}\nSHA-1 hash: ${fingerprint}\n`, + `SHA-1 hash: ${fingerprint}\nSHA-1 hash: ${'B'.repeat(40)}\n`, + `SHA-1 hash: ${'B'.repeat(40)}\n`, + ]) { + await assert.rejects(signDarwinPackagedConnectApplication({ + application, + keychain, + certificateSha1: fingerprint, + discover: async () => [], + runCommand: async () => ({ stdout, stderr: '' }), + }), error => ( + classifyDarwinSigningFailure(error) + === DARWIN_SIGNING_DIAGNOSTICS.missingIdentityOrChain + )); + } + }); + + test('emits only fixed classified diagnostics for sensitive native failures', () => { + const secret = 'SECRET_PATH_PASSWORD_FINGERPRINT'; + const cases = [ + ['CSSMERR_TP_NOT_TRUSTED', DARWIN_SIGNING_DIAGNOSTICS.trustRejection], + ['unable to build chain to self-signed root', DARWIN_SIGNING_DIAGNOSTICS.missingIdentityOrChain], + ['invalid designated requirement', DARWIN_SIGNING_DIAGNOSTICS.requirementsFailure], + ['codesign failed', DARWIN_SIGNING_DIAGNOSTICS.codesignFailure], + ]; + for (const [stderr, diagnostic] of cases) { + const line = darwinSigningDiagnosticLine({ stderr: `${stderr} ${secret}` }); + assert.equal(line, `DARWIN_PACKAGED_CONNECT_DIAGNOSTIC:${diagnostic}\n`); + assert.doesNotMatch(line, new RegExp(secret, 'u')); + } + }); +}); diff --git a/apps/desktop/scripts/smoke-packaged-connect.mjs b/apps/desktop/scripts/smoke-packaged-connect.mjs new file mode 100644 index 000000000..b6cebc1bf --- /dev/null +++ b/apps/desktop/scripts/smoke-packaged-connect.mjs @@ -0,0 +1,723 @@ +import { spawn, spawnSync } from 'node:child_process'; +import { createHash } from 'node:crypto'; +import { once } from 'node:events'; +import { + chmod, lstat, mkdir, mkdtemp, readFile, readdir, realpath, writeFile, +} from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { createServer } from 'node:http'; +import { basename, dirname, join, relative, resolve } from 'node:path'; +import { Server as SocketIOServer } from 'socket.io'; +import { + DESKTOP_RENDERER_ORIGIN, + DESKTOP_TRANSPORT_SCOPE_HEADER, + DESKTOP_TRANSPORT_SCOPE_QUERY, + PROPR_API_COMPATIBILITY, + PROPR_UI_COMPATIBILITY, +} from '@propr/shared'; +import { + createIdempotentJourneyFixtureClose, + preservePrimaryWithCleanup, + removeAuthorizedConnectFixture, + runPackagedConnectLifecycle, +} from './packaged-connect-lifecycle.mjs'; +import { + createPackagedConnectLaunchArguments, + spawnPackagedConnectBinary, +} from './packaged-connect-launch.mjs'; +import { + collectAcceptedSocketEvidence, + evaluatePackagedConnectEvidence, +} from './packaged-connect-evidence.mjs'; +import { + canonicalizeWindowsFixtureEntry, + encodedWindowsFixtureAcl, + windowsPowerShell51Path, +} from './windows-fixture-acl.mjs'; +import { + describeWindowsArtifactFailure, + packagedConnectArtifactSensitiveNeedles, + parseWindowsStagedPackageHandoff, + validateWindowsStagedPackage, +} from './windows-packaged-connect-staging.mjs'; + +if (!['darwin', 'linux', 'win32'].includes(process.platform)) { + throw new Error('Packaged Connect discovery smoke requires Darwin, Linux, or Windows'); +} +if (process.arch !== 'x64' && process.arch !== 'arm64') { + throw new Error('Packaged Connect discovery smoke requires x64 or arm64'); +} + +let artifactRoot = resolve('out', `propr-desktop-${process.platform}-${process.arch}`); +let binaryPath = process.platform === 'darwin' + ? join(artifactRoot, 'propr-desktop.app', 'Contents', 'MacOS', 'propr-desktop') + : join(artifactRoot, process.platform === 'linux' ? 'propr-desktop' : 'propr-desktop.exe'); +let resourcesPath = process.platform === 'darwin' + ? join(artifactRoot, 'propr-desktop.app', 'Contents', 'Resources') + : join(artifactRoot, 'resources'); +let unpackedNative = join(resourcesPath, 'app.asar.unpacked', '.vite', 'native', 'prebuilds'); +const endpoint = 'https://t-packaged123.propr.dev'; +const identity = 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa'; +const secrets = [ + 'tunnel-secret-SENTINEL', 'connector-secret-SENTINEL', + 'relay-secret-SENTINEL', 'github-secret-SENTINEL', +]; +const nativeHashes = { + darwin: { + arm64: { + 'connect-authority-broker': '75fda2624bf093555e726b968401321fef61ea7ae0479f4c1892be0dfc6554c0', + 'directory-operations.node': '88f07c0c7a4371f4fb227a4691009d09517de582ba49297d28d03ac94e586615', + }, + x64: { + 'connect-authority-broker': 'e5a49be0db85655b9ff1d0614de9d61defd41a0a1b2eff8f11571407f10d809b', + 'directory-operations.node': '62183c0f4083cb8c98e09e2d2c688f8f81703e12b0f22320c335b51e927eaf53', + }, + }, + linux: { + arm64: { + 'directory-operations.node': '916679f413251c4b23c51167987a874bbbdd9d96991882bfac9093e0ea5fa051', + }, + x64: { + 'directory-operations.node': '7199378f1c7b443a05c596eae7c66f9a77cc01b4a493c07748df0df1083950f6', + }, + }, +}; +let packagedConnectPhase = 'fixture-setup'; +let windowsStagedContract; +let windowsStagedHandoff; + +const createPackagedJourneyFixture = async () => { + const pairingId = `dpr_${'P'.repeat(22)}`; + const deviceSecret = 'D'.repeat(43); + const activationTicket = 'A'.repeat(43); + const token = `propr_it_${'T'.repeat(43)}`; + const receipt = 'R'.repeat(22); + const requests = []; + let endpoint; + let approved = false; + let active = false; + let binding; + let mode = 'success'; + let modeGeneration = 0; + const approvalReadinessDelayMs = process.platform === 'darwin' ? 300 : 0; + const cors = { + 'Access-Control-Allow-Credentials': 'true', + 'Access-Control-Allow-Headers': 'Authorization, Content-Type, X-ProPR-Desktop-Transport-Scope', + 'Access-Control-Allow-Methods': 'GET, POST, OPTIONS', + 'Access-Control-Allow-Origin': DESKTOP_RENDERER_ORIGIN, + 'Access-Control-Allow-Private-Network': 'true', + 'Cache-Control': 'no-store', + 'Content-Type': 'application/json', + }; + const readJson = request => new Promise((resolveBody, rejectBody) => { + const chunks = []; + let bytes = 0; + request.on('data', chunk => { + bytes += chunk.length; + if (bytes > 16 * 1024) { + rejectBody(new Error('oversized request')); + request.destroy(); + } else chunks.push(chunk); + }); + request.on('end', () => { + try { resolveBody(JSON.parse(Buffer.concat(chunks).toString('utf8'))); } + catch (error) { rejectBody(error); } + }); + request.on('error', rejectBody); + }); + const server = createServer(async (request, response) => { + const record = { + method: request.method, + url: request.url, + authorization: request.headers.authorization ?? null, + origin: request.headers.origin ?? null, + transportScope: request.headers[DESKTOP_TRANSPORT_SCOPE_HEADER.toLowerCase()] ?? null, + credentialHeadersPresent: Object.keys(request.headers).some(name => + ['authorization', 'cookie', 'proxy-authorization'].includes(name.toLowerCase())), + socketIo: false, + fixtureMode: mode, + fixtureModeGeneration: modeGeneration, + }; + requests.push(record); + if (request.method === 'OPTIONS') { + response.writeHead(204, cors); + response.end(); + return; + } + try { + if (request.method === 'POST' && request.url?.startsWith('/__packaged/control/')) { + const requestedMode = request.url.slice('/__packaged/control/'.length); + if (!['success', 'malformed', 'oversized', 'expiry', 'cancel'].includes(requestedMode)) { + throw new Error('invalid fixture mode'); + } + mode = requestedMode; + modeGeneration += 1; + approved = false; + binding = undefined; + response.writeHead(204, cors); + response.end(); + return; + } + if (request.method === 'GET' && request.url === '/__packaged/evidence') { + const authenticatedRest = requests.filter(item => item.socketIo === false + && item.url === '/api/auth/user' + && item.authorization === `Bearer ${token}` + && item.transportScope === null); + const authenticatedSockets = requests.filter(item => item.socketIo === true + && item.accepted === true + && item.authorization === `Bearer ${token}` + && item.transportScope !== null + && item.socketAuthScope === item.transportScope); + response.writeHead(200, cors); + response.end(JSON.stringify({ + authenticatedRest: authenticatedRest.length, + authenticatedSockets: authenticatedSockets.length, + })); + return; + } + if (request.method === 'GET' && request.url === '/api/desktop/discovery') { + response.writeHead(200, cors); + if (mode === 'malformed') { + response.end('{"product":"ProPR"}'); + return; + } + if (mode === 'oversized') { + response.end(`{"ignored":"${'x'.repeat(9 * 1024)}"}`); + return; + } + response.end(JSON.stringify({ + schemaVersion: 1, + product: 'ProPR', + version: '0.8.15', + apiCompatibility: PROPR_API_COMPATIBILITY, + uiCompatibility: PROPR_UI_COMPATIBILITY, + canonicalEndpoint: null, + publicInstanceIdentity: identity, + desktopAuthentication: { + protocolVersion: 2, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, + })); + return; + } + if (request.method === 'POST' && request.url === '/api/desktop/pairings') { + binding = await readJson(request); + response.writeHead(201, cors); + response.end(JSON.stringify({ + pairingId, + deviceSecret, + approvalUrl: `${endpoint}/api/desktop/pairings/${pairingId}/browser`, + expiresAt: new Date(Date.now() + (mode === 'expiry' ? 200 : 60_000)).toISOString(), + interval: 1, + })); + return; + } + if (request.method === 'GET' && request.url === `/api/desktop/pairings/${pairingId}/browser`) { + if (approvalReadinessDelayMs > 0) { + await new Promise(resolve => setTimeout(resolve, approvalReadinessDelayMs)); + record.approvalReadinessDelayed = true; + } + record.fixtureModeStable = record.fixtureMode === mode + && record.fixtureModeGeneration === modeGeneration; + approved = true; + response.writeHead(200, { 'Cache-Control': 'no-store', 'Content-Type': 'text/html' }); + response.end('Desktop approved

Approved

'); + return; + } + if (request.method === 'POST' && request.url === `/api/desktop/pairings/${pairingId}/poll`) { + const body = await readJson(request); + if (body.deviceSecret !== deviceSecret || !approved || !binding) throw new Error('pairing not approved'); + if (mode === 'cancel' || mode === 'expiry') { + response.writeHead(202, cors); + response.end('{"status":"pending","interval":1}'); + return; + } + response.writeHead(200, cors); + response.end(JSON.stringify({ + status: 'provisional', token, tokenType: 'Bearer', activationTicket, + activationExpiresAt: new Date(Date.now() + 60_000).toISOString(), + instanceId: binding.instanceId, + origin: binding.origin, + scope: binding.scope, + credentialGeneration: binding.credentialGeneration, + })); + return; + } + if (request.method === 'POST' && request.url === `/api/desktop/pairings/${pairingId}/activate`) { + const body = await readJson(request); + if (body.deviceSecret !== deviceSecret || body.activationTicket !== activationTicket) { + throw new Error('activation binding rejected'); + } + active = true; + response.writeHead(200, cors); + response.end(JSON.stringify({ + status: 'active', receipt, activatedAt: new Date().toISOString(), expiresAt: null, + })); + return; + } + if (request.method === 'DELETE' && request.url === '/api/desktop/tokens/current') { + active = false; + response.writeHead(204, cors); + response.end(); + return; + } + if (request.method === 'GET' && request.url === '/api/auth/user' + && active && record.authorization === `Bearer ${token}`) { + response.writeHead(200, cors); + response.end(JSON.stringify({ + id: 'packaged-owner', login: 'packaged-owner', username: 'packaged-owner', + displayName: 'Packaged Owner', email: null, avatarUrl: null, + role: 'admin', permissions: [], authorizationSource: 'bootstrap', + })); + return; + } + if (request.method === 'GET' && record.authorization === `Bearer ${token}`) { + response.writeHead(200, cors); + response.end('{}'); + return; + } + } catch { + response.writeHead(400, cors); + response.end('{"code":"INVALID_SMOKE_REQUEST"}'); + return; + } + response.writeHead(401, cors); + response.end('{"code":"INVALID_INSTANCE_TOKEN"}'); + }); + const io = new SocketIOServer(server, { + path: '/socket.io/', + transports: ['websocket'], + cors: { origin: DESKTOP_RENDERER_ORIGIN, credentials: false }, + }); + io.of('/').use((socket, next) => { + const scopes = new URL(socket.handshake.url, 'http://fixture.invalid') + .searchParams.getAll(DESKTOP_TRANSPORT_SCOPE_QUERY); + const accepted = active + && socket.handshake.headers.authorization === `Bearer ${token}` + && scopes.length === 1 + && socket.handshake.auth?.[DESKTOP_TRANSPORT_SCOPE_QUERY] === scopes[0]; + requests.push({ + method: 'SOCKET.IO', + url: socket.handshake.url, + authorization: socket.handshake.headers.authorization ?? null, + origin: socket.handshake.headers.origin ?? null, + transportScope: scopes[0] ?? null, + socketQueryScopeCount: scopes.length, + socketAuthScope: socket.handshake.auth?.[DESKTOP_TRANSPORT_SCOPE_QUERY] ?? null, + socketIo: true, + accepted, + }); + if (!accepted) { + const error = new Error('INVALID_INSTANCE_TOKEN'); + error.data = { code: 'INVALID_INSTANCE_TOKEN' }; + next(error); + return; + } + next(); + }); + server.listen(0, '127.0.0.1'); + await once(server, 'listening'); + const address = server.address(); + if (!address || typeof address === 'string') throw new Error('Packaged journey fixture did not bind'); + endpoint = `http://127.0.0.1:${address.port}`; + const close = createIdempotentJourneyFixtureClose({ + closeSocketServer: () => io.close(), + closeHttpServer: () => new Promise((resolveClose, rejectClose) => { + server.close(error => error ? rejectClose(error) : resolveClose()); + }), + }); + return { + endpoint, + requests, + secrets: [deviceSecret, activationTicket, token], + close, + }; +}; + +const directoryContainsPlaintext = async (root, needles) => { + const visit = async path => { + const entries = await readdir(path, { withFileTypes: true }); + for (const entry of entries) { + const child = join(path, entry.name); + if (entry.isDirectory()) { + if (await visit(child)) return true; + } else if (entry.isFile()) { + const contents = await readFile(child); + if (needles.some(needle => contents.includes(Buffer.from(needle)))) return true; + } + } + return false; + }; + return visit(root); +}; + +if (process.platform === 'win32') { + try { + packagedConnectPhase = 'staged-contract'; + [windowsStagedHandoff] = process.argv.slice(2); + windowsStagedContract = parseWindowsStagedPackageHandoff(process.argv.slice(2)); + const staged = await validateWindowsStagedPackage({ + environment: { + RUNNER_TEMP: windowsStagedContract.runnerTemp, + PROPR_DESKTOP_CONNECT_STAGING_PARENT: windowsStagedContract.parent, + PROPR_DESKTOP_CONNECT_STAGING_LEAF: windowsStagedContract.leaf, + }, + expectedArchitecture: process.arch, + }); + artifactRoot = staged.root; + binaryPath = staged.executable; + resourcesPath = staged.resources; + unpackedNative = join(resourcesPath, 'app.asar.unpacked', '.vite', 'native', 'prebuilds'); + } catch (error) { + const failure = describeWindowsArtifactFailure(error, packagedConnectPhase); + process.stderr.write(`${JSON.stringify({ + event: 'packaged_connect.artifact_failed', + ...failure, + })}\n`); + process.exit(1); + } +} + +const authorityMechanism = () => { + if (process.platform === 'darwin') return 'packaged-broker'; + if (process.platform === 'linux') return 'in-process-native-addon'; + return 'inherited-standard-handle'; +}; + +const windowsTreeKiller = async () => { + if (process.platform !== 'win32') return undefined; + const powershell = windowsPowerShell51Path(); + const candidate = join(dirname(dirname(dirname(powershell))), 'taskkill.exe'); + const stats = await lstat(candidate); + if (!stats.isFile() || stats.isSymbolicLink()) { + throw new Error('Windows tree termination tool failed validation'); + } + const canonical = await realpath(candidate); + if (canonical.toLocaleLowerCase('en-US') !== candidate.toLocaleLowerCase('en-US')) { + throw new Error('Windows tree termination tool failed validation'); + } + return canonical; +}; + +const assertCanonicalParents = async candidate => { + let parent = dirname(candidate); + while (true) { + const named = await lstat(parent); + if (!named.isDirectory() || named.isSymbolicLink() || await realpath(parent) !== parent) { + throw new Error('Packaged native candidate has noncanonical parent ancestry'); + } + const next = dirname(parent); + if (next === parent) return; + parent = next; + } +}; + +const assertPackageAuthority = async () => { + if (process.platform === 'win32') { + try { + await lstat(unpackedNative); + throw new Error('Windows package unexpectedly contains an unused native authority helper'); + } catch (error) { + if (error?.code !== 'ENOENT') throw error; + } + return; + } + const selected = join(unpackedNative, `${process.platform}-${process.arch}`); + for (const [name, expected] of Object.entries(nativeHashes[process.platform][process.arch])) { + const candidate = join(selected, name); + await assertCanonicalParents(candidate); + const named = await lstat(candidate); + if (!named.isFile() + || named.isSymbolicLink() + || (named.mode & 0o022) !== 0 + || (name === 'connect-authority-broker' && (named.mode & 0o111) === 0)) { + throw new Error('Packaged native authority artifact failed type or mode verification'); + } + const digest = createHash('sha256').update(await readFile(candidate)).digest('hex'); + if (digest !== expected) throw new Error('Packaged native authority artifact failed integrity verification'); + } + const otherArch = process.arch === 'arm64' ? 'x64' : 'arm64'; + try { + await lstat(join(unpackedNative, `${process.platform}-${otherArch}`)); + throw new Error('Package contains unselected architecture authority artifacts'); + } catch (error) { + if (error?.code !== 'ENOENT') throw error; + } +}; + +const windowsFixtureFailure = (phase, category) => { + const error = new Error(`Could not prepare the ordinary-user Windows authority fixture [phase=${phase} category=${category}]`); + error.stack = error.message; + throw error; +}; + +const protectWindowsEntries = entries => { + const powershell = windowsPowerShell51Path(); + const membership = spawnSync(powershell, [ + '-NoLogo', '-NoProfile', '-NonInteractive', '-Command', + '[Console]::Out.Write(([Security.Principal.WindowsPrincipal][Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator))', + ], { shell: false, windowsHide: true, encoding: 'utf8', timeout: 10_000 }); + if (membership.error || membership.signal || membership.status !== 0 || membership.stderr) { + windowsFixtureFailure('membership', 'process-failed'); + } + if (membership.stdout !== 'False') windowsFixtureFailure('membership', 'administrator'); + for (const entry of entries) { + const canonicalEntry = canonicalizeWindowsFixtureEntry({ + entryKind: entry.kind, + entryPath: entry.path, + powershellPath: powershell, + }); + const result = spawnSync(powershell, [ + '-NoLogo', '-NoProfile', '-NonInteractive', '-EncodedCommand', encodedWindowsFixtureAcl, + ], { + shell: false, + windowsHide: true, + timeout: 30_000, + env: { + ...process.env, + PROPR_FIXTURE_ACL_KIND: entry.kind, + PROPR_FIXTURE_ACL_PATH: canonicalEntry.path, + }, + }); + if (result.error || result.signal) windowsFixtureFailure('powershell-invocation', 'process-failed'); + if (result.stdout.length !== 0) windowsFixtureFailure('powershell-invocation', 'powershell-stdout'); + if (result.stderr.length !== 0) windowsFixtureFailure('powershell-invocation', 'powershell-stderr'); + const failurePhase = new Map([ + [40, 'rooted-path'], + [41, 'item-type'], + [42, 'current-sid-lookup'], + [43, 'sid-construction'], + [44, 'access-control-read'], + [45, 'dacl-protection'], + [46, 'rule-create'], + [47, 'rule-apply'], + [48, 'full-path'], + [49, 'canonical-equality'], + [50, 'outer-invocation'], + ]).get(result.status); + if (failurePhase) windowsFixtureFailure(failurePhase, 'operation-failed'); + if (result.status !== 0) windowsFixtureFailure('powershell-invocation', 'unexpected-exit'); + } +}; + +let canonicalTemp; +let fixture; +let generatedFixtureLeaf; +let journeyFixture; +let outcome = { ok: false, category: 'fixture-setup', capture: 'complete', records: [] }; +let failurePhase = 'fixture-setup'; +try { + canonicalTemp = await realpath(tmpdir()); + fixture = await mkdtemp(join(canonicalTemp, 'propr-desktop-connect-smoke-')); + generatedFixtureLeaf = basename(fixture); + const configRoot = join(fixture, 'config'); + const stackRoot = join(fixture, 'stack-private-path-SENTINEL'); + const dataRoot = join(stackRoot, 'data'); + const identityPath = join(dataRoot, 'public-instance-identity.json'); + const envPath = join(stackRoot, '.env'); + const configPath = join(configRoot, 'config.json'); + const userDataPath = join(fixture, 'desktop-user-data'); + await mkdir(configRoot, { recursive: true, mode: 0o700 }); + await mkdir(dataRoot, { recursive: true, mode: 0o700 }); + await mkdir(userDataPath, { recursive: true, mode: 0o700 }); + await writeFile(configPath, `${JSON.stringify({ stackRoot })}\n`, { mode: 0o600 }); + await writeFile(envPath, [ + 'PROPR_STACK=packaged-connect-smoke', + 'PROPR_INSTANCE_ID=packaged123', + `PROPR_UI_PUBLIC_API_URL=${endpoint}`, + 'PROPR_UI_TUNNEL_ENABLED=true', + `PROPR_UI_TUNNEL_TOKEN=${secrets[0]}`, + '', + ].join('\n'), { mode: 0o600 }); + await writeFile(identityPath, `${JSON.stringify({ schemaVersion: 1, publicInstanceIdentity: identity })}\n`, { mode: 0o644 }); + if (process.platform !== 'win32') { + await Promise.all([ + chmod(fixture, 0o700), chmod(configRoot, 0o700), chmod(stackRoot, 0o700), + chmod(dataRoot, 0o700), chmod(userDataPath, 0o700), chmod(configPath, 0o600), + chmod(envPath, 0o600), chmod(identityPath, 0o644), + ]); + } else { + protectWindowsEntries([ + { path: stackRoot, kind: 'directory' }, + { path: dataRoot, kind: 'directory' }, + { path: envPath, kind: 'file' }, + { path: identityPath, kind: 'file' }, + ]); + } + if (relative(canonicalTemp, fixture) !== generatedFixtureLeaf + || relative(canonicalTemp, configRoot) !== join(generatedFixtureLeaf, 'config')) { + throw new Error('Connect smoke fixture escaped its fixed root'); + } + if (process.platform !== 'win32') journeyFixture = await createPackagedJourneyFixture(); + failurePhase = 'package-validation'; + await assertPackageAuthority(); + const treeKillerPath = await windowsTreeKiller(); + const sensitiveNeedles = [ + ...secrets, fixture, configRoot, stackRoot, identity, + ...(journeyFixture?.secrets ?? []), + ...packagedConnectArtifactSensitiveNeedles({ + platform: process.platform, + artifactRoot, + binaryPath, + stagedContract: windowsStagedContract, + stagedHandoff: windowsStagedHandoff, + }), + 'S-1-5-', 'volumeSerialNumber', 'fileId', 'authorityDiagnostic', + ]; + const childEnvironment = { + ...process.env, + PROPR_DESKTOP_CONNECT_SMOKE_TEST: '1', + PROPR_DESKTOP_CONNECT_SMOKE_CONFIG_ROOT: configRoot, + PROPR_CONNECTOR_TOKEN: secrets[1], + PROPR_RELAY_TOKEN: secrets[2], + GITHUB_TOKEN: secrets[3], + ...(journeyFixture ? { + PROPR_DESKTOP_CONNECT_JOURNEY_ENDPOINT: journeyFixture.endpoint, + } : {}), + }; + delete childEnvironment.PROPR_DESKTOP_CONNECT_STAGING_PARENT; + delete childEnvironment.PROPR_DESKTOP_CONNECT_STAGING_LEAF; + const launchArguments = createPackagedConnectLaunchArguments({ + platform: process.platform, + userDataPath, + }); + const spawnLifecycleProcess = (executable, args, options) => { + if (executable !== binaryPath) return spawn(executable, args, options); + const child = spawnPackagedConnectBinary({ + binaryPath, + launchArguments: args, + options: { + ...options, + env: options.env, + }, + spawn, + }); + return child; + }; + failurePhase = 'lifecycle-internal'; + const runPhase = async phase => await runPackagedConnectLifecycle({ + binaryPath, + args: launchArguments, + platform: process.platform, + arch: process.arch, + authorityMechanism: authorityMechanism(), + ...(process.platform === 'darwin' ? { expectedStorageBackend: 'os-protected' } : {}), + sensitiveNeedles, + treeKillerPath, + env: { + ...childEnvironment, + ...(journeyFixture ? { PROPR_DESKTOP_CONNECT_JOURNEY_PHASE: phase } : {}), + }, + spawn: spawnLifecycleProcess, + }); + outcome = await runPhase('pair'); + if (outcome.ok && journeyFixture) { + const pairingRequestCountAtPairTerminal = journeyFixture.requests.filter(request => + request.method !== 'OPTIONS' + && (request.url === '/api/desktop/pairings' + || /^\/api\/desktop\/pairings\/[^/]+\/(?:browser|poll|activate)$/u.test(request.url ?? ''))).length; + outcome = await runPhase('reprobe'); + if (outcome.ok) { + const applicationRequests = journeyFixture.requests.filter(request => request.method !== 'OPTIONS'); + const discoveries = applicationRequests.filter(request => request.url === '/api/desktop/discovery'); + const bootstrap = applicationRequests.filter(request => + request.url === '/api/desktop/pairings' + || /^\/api\/desktop\/pairings\/[^/]+\/(?:poll|activate)$/u.test(request.url ?? '') + || /\/browser$/u.test(request.url ?? '')); + const pairingStarts = bootstrap.filter(request => request.method === 'POST' + && request.url === '/api/desktop/pairings'); + const pairingBrowsers = bootstrap.filter(request => request.method === 'GET' + && /\/browser$/u.test(request.url ?? '')); + const pairingPolls = bootstrap.filter(request => request.method === 'POST' + && /\/poll$/u.test(request.url ?? '')); + const pairingActivations = bootstrap.filter(request => request.method === 'POST' + && /\/activate$/u.test(request.url ?? '')); + const intendedPairingModes = ['expiry', 'cancel', 'success']; + const hasExactModes = requests => requests.length === intendedPairingModes.length + && requests.every((request, index) => request.fixtureMode === intendedPairingModes[index]); + const authenticatedRest = applicationRequests.filter(request => + request.socketIo === false + && request.url === '/api/auth/user' + && request.authorization === `Bearer ${journeyFixture.secrets[2]}`); + const socketEvidence = collectAcceptedSocketEvidence({ + requests: applicationRequests, + authorization: `Bearer ${journeyFixture.secrets[2]}`, + }); + const restScopes = new Set(authenticatedRest.map(request => request.transportScope)); + const firstBearer = applicationRequests.findIndex(request => request.authorization !== null); + const firstIdentity = applicationRequests.findIndex(request => request.url === '/api/desktop/discovery'); + const plaintextPersisted = await directoryContainsPlaintext(userDataPath, journeyFixture.secrets); + const evidenceFailure = evaluatePackagedConnectEvidence({ + discoveryCount: discoveries.length, + discoveryAuthorizationPresent: discoveries.some(request => request.authorization !== null), + pairingStartCount: pairingStarts.length, + pairingBrowserCount: pairingBrowsers.length, + pairingPollCount: pairingPolls.length, + pairingActivationCount: pairingActivations.length, + pairingMethodBoundaryValid: bootstrap.length === pairingStarts.length + + pairingBrowsers.length + pairingPolls.length + pairingActivations.length, + pairingBrowserCredentialPresent: pairingBrowsers.some(request => + request.credentialHeadersPresent === true), + pairingIntentSequenceValid: hasExactModes(pairingStarts) && hasExactModes(pairingBrowsers), + pairingLifecycleIsolated: pairingBrowsers.every(request => request.fixtureModeStable === true) + && pairingPolls.every(request => request.fixtureMode === 'success') + && pairingActivations.every(request => request.fixtureMode === 'success'), + pairingRequestAfterTerminal: bootstrap.length !== pairingRequestCountAtPairTerminal, + delayedApprovalReadinessProven: process.platform !== 'darwin' + || pairingBrowsers.every(request => request.approvalReadinessDelayed === true), + bootstrapAuthorizationPresent: bootstrap.some(request => request.authorization !== null), + authenticatedRestCount: authenticatedRest.length, + authenticatedSocketCount: socketEvidence.authenticatedSocketCount, + restScopeCount: restScopes.size, + restHasOnlyNullScope: restScopes.has(null), + socketHasNullScope: socketEvidence.socketHasNullScope, + socketScopeBindingMismatch: socketEvidence.socketScopeBindingMismatch, + socketScopeCount: socketEvidence.socketScopeCount, + plaintextCredentialPersisted: plaintextPersisted, + firstIdentityIndex: firstIdentity, + firstBearerIndex: firstBearer, + }); + if (evidenceFailure) { + outcome = { + ok: false, + category: 'journey-evidence', + capture: 'complete', + records: [evidenceFailure], + }; + } + } + } +} catch { + outcome = { ok: false, category: failurePhase, capture: 'complete', records: [] }; +} finally { + let cleanup = { ok: true }; + if (journeyFixture) { + try { await journeyFixture.close(); } + catch { cleanup = { ok: false, category: 'fixture-cleanup-failed' }; } + } + if (fixture && canonicalTemp && generatedFixtureLeaf) { + const directoryCleanup = await removeAuthorizedConnectFixture({ + fixture, + canonicalTemporaryParent: canonicalTemp, + generatedLeaf: generatedFixtureLeaf, + }); + if (!directoryCleanup.ok) cleanup = directoryCleanup; + } + if (!cleanup.ok) { + outcome = preservePrimaryWithCleanup(outcome, cleanup); + } + if (outcome.ok && cleanup.ok) { + process.stdout.write(`Packaged Connect discovery passed for ${process.platform}-${process.arch}: ${authorityMechanism()}.\n`); + } else { + process.stderr.write(`${JSON.stringify({ + event: 'packaged_connect.smoke_failed', + category: outcome.category, + capture: outcome.capture, + records: outcome.records, + ...(outcome.secondary?.length ? { secondary: outcome.secondary } : {}), + })}\n`); + process.exitCode = 1; + } +} diff --git a/apps/desktop/scripts/smoke-packaged.mjs b/apps/desktop/scripts/smoke-packaged.mjs index eedb05654..40880661b 100644 --- a/apps/desktop/scripts/smoke-packaged.mjs +++ b/apps/desktop/scripts/smoke-packaged.mjs @@ -1,35 +1,46 @@ import { spawn } from 'node:child_process'; import { once } from 'node:events'; -import { access, readdir } from 'node:fs/promises'; +import { access, readFile, readdir } from 'node:fs/promises'; import { createServer } from 'node:http'; -import { resolve } from 'node:path'; -import { DESKTOP_RENDERER_ORIGIN } from '@propr/shared'; +import { join, resolve } from 'node:path'; +import { Server as SocketIOServer } from 'socket.io'; +import { + DESKTOP_RENDERER_ORIGIN, + DESKTOP_TRANSPORT_SCOPE_QUERY, + PROPR_API_COMPATIBILITY, + PROPR_UI_COMPATIBILITY, +} from '@propr/shared'; import { FuseState, FuseV1Options, FuseVersion, getCurrentFuseWire, } from '@electron/fuses'; +import { assertPackagedLayout, parseEventLayout, parseEventRecord } from './packaged-layout.mjs'; +import { + createPackagedSmokeLaunch, + LAYOUT_READY_EVENT, + MVP_FLOWS_PROOF, + PACKAGED_SMOKE_LAUNCH_MODES, + REDUCED_NATIVE_WINDOW_READY_EVENT, + TRANSPORT_PROOF, + TRANSPORT_SMOKE_ENVIRONMENT_NAMES, +} from './packaged-smoke-plan.mjs'; import { - assertPackagedLayout, assertPackagedNativeWindowSizing, createPrivateSmokeProfile, createSmokeChildEnvironment, removePrivateSmokeProfile, } from './packaged-smoke-support.mjs'; -const READY_EVENT = 'desktop.renderer.ready'; -const PRELOAD_BRIDGE_PROOF = '"preloadBridgeExposed":true'; -const PROFILE_API_PROOF = 'desktop.renderer.profile_api.ready'; -const MVP_FLOWS_PROOF = 'desktop.renderer.mvp_flows.ready'; -const LAYOUT_READY_EVENT = 'desktop.renderer.layout.ready'; -const REDUCED_NATIVE_WINDOW_READY_EVENT = 'desktop.native.reduced_window.ready'; const MAIN_PROCESS_ERROR_MARKERS = [ 'desktop.main_process.uncaught_exception', 'A JavaScript error occurred in the main process', 'Uncaught Exception:', ]; -const TIMEOUT_MS = 30_000; +const TIMEOUT_MS = 45_000; +const RELEASE_GUARD_TIMEOUT_MS = 30_000; +const INVALID_INSTANCE_TOKEN = 'INVALID_INSTANCE_TOKEN'; const binaryPath = process.platform === 'darwin' ? resolve('out', `propr-desktop-darwin-${process.arch}`, 'propr-desktop.app', 'Contents', 'MacOS', 'propr-desktop') : resolve( @@ -47,19 +58,6 @@ if (process.platform === 'win32') { } } -const parseEventLayout = (smokeOutput, expectedEvent) => { - for (const line of smokeOutput.split(/\r?\n/)) { - if (!line.includes(expectedEvent)) continue; - try { - const record = JSON.parse(line.slice(line.indexOf('{'))); - if (record.event === expectedEvent) return record.layout; - } catch { - // Ignore non-JSON Chromium output that happens to mention the event name. - } - } - return undefined; -}; - await access(binaryPath); const expectedFuses = new Map([ @@ -74,7 +72,6 @@ const expectedFuses = new Map([ [FuseV1Options.WasmTrapHandlers, FuseState.ENABLE], ]); const actualFuses = await getCurrentFuseWire(binaryPath); - if (actualFuses.version !== FuseVersion.V1) { throw new Error(`Expected fuse wire version ${FuseVersion.V1}, received ${actualFuses.version}`); } @@ -91,17 +88,49 @@ if (inspectOnly) { console.log(`Packaged ${process.platform}-${process.arch} desktop artifact passed executable and fuse inspection.`); process.exit(0); } +if (process.platform !== 'linux' && process.platform !== 'win32') { + throw new Error('The packaged transport smoke requires Linux or Windows'); +} + +const requests = []; +const fixtures = []; +const corsHeaders = { + 'Access-Control-Allow-Credentials': 'true', + 'Access-Control-Allow-Headers': 'Content-Type, X-ProPR-Desktop-Transport-Scope', + 'Access-Control-Allow-Methods': 'GET, DELETE, OPTIONS', + 'Access-Control-Allow-Origin': DESKTOP_RENDERER_ORIGIN, + 'Access-Control-Allow-Private-Network': 'true', + 'Cache-Control': 'no-store', + 'Content-Type': 'application/json', +}; +const discovery = publicInstanceIdentity => JSON.stringify({ + schemaVersion: 1, + product: 'ProPR', + version: '0.8.15', + apiCompatibility: PROPR_API_COMPATIBILITY, + uiCompatibility: PROPR_UI_COMPATIBILITY, + canonicalEndpoint: null, + publicInstanceIdentity, + desktopAuthentication: { + protocolVersion: 2, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, +}); -const smokeProfile = await createPrivateSmokeProfile(); -const userDataPath = smokeProfile.userData; -let output = ''; -let receivedProfileApiOrigin; +const profileApiRequests = []; const profileApiServer = createServer((request, response) => { - receivedProfileApiOrigin = request.headers.origin; + const record = { + method: request.method, + url: request.url, + origin: request.headers.origin ?? null, + }; + profileApiRequests.push(record); if ( - request.method !== 'GET' - || !['/api/compatibility', '/api/desktop/discovery'].includes(request.url ?? '') - || receivedProfileApiOrigin !== DESKTOP_RENDERER_ORIGIN + record.method !== 'GET' + || !['/api/compatibility', '/api/desktop/discovery'].includes(record.url ?? '') + || record.origin !== DESKTOP_RENDERER_ORIGIN ) { response.writeHead(403, { 'Content-Type': 'application/json' }); response.end('{"error":"CORS origin rejected"}'); @@ -112,57 +141,213 @@ const profileApiServer = createServer((request, response) => { 'Access-Control-Allow-Origin': DESKTOP_RENDERER_ORIGIN, 'Content-Type': 'application/json', }); - response.end(request.url === '/api/desktop/discovery' + response.end(record.url === '/api/desktop/discovery' ? '{"product":"ProPR","desktopAuthentication":{"protocolVersion":1}}' : '{"profileEndpoint":true}'); }); -try { - const launchArguments = [ - '--disable-gpu', - '--propr-smoke-test', - `--user-data-dir=${userDataPath}`, - 'propr://connect?api=https%3A%2F%2Fconnect.propr.dev', - ]; - if (launchArguments.some(argument => argument === '--no-sandbox' || argument === '--disable-sandbox')) { - throw new Error('The packaged-binary smoke test must not disable Electron sandboxing'); - } - +const listenProfileApiFixture = async () => { profileApiServer.listen(0, '127.0.0.1'); await once(profileApiServer, 'listening'); - const profileApiAddress = profileApiServer.address(); - if (!profileApiAddress || typeof profileApiAddress === 'string') { - throw new Error('Packaged desktop smoke profile API did not bind to a TCP port'); + const address = profileApiServer.address(); + if (!address || typeof address === 'string') { + throw new Error('Packaged desktop release-guard profile API did not bind to a TCP port'); } - const profileApiUrl = `http://127.0.0.1:${profileApiAddress.port}`; - const childEnvironment = await createSmokeChildEnvironment({ + return `http://127.0.0.1:${address.port}`; +}; + +const listenFixture = async name => { + const server = createServer((request, response) => { + const record = { + fixture: name, + method: request.method, + url: request.url, + authorization: request.headers.authorization ?? null, + cookie: request.headers.cookie ?? null, + origin: request.headers.origin ?? null, + socketIo: false, + }; + requests.push(record); + if (request.method === 'OPTIONS') { + response.writeHead(204, corsHeaders); + response.end(); + return; + } + if (request.url === '/smoke-storage') { + response.writeHead(200, { 'Content-Type': 'text/html', 'Cache-Control': 'no-store' }); + response.end('storage fixture'); + return; + } + if (request.url === '/smoke-sw.js') { + response.writeHead(200, { 'Content-Type': 'text/javascript', 'Cache-Control': 'no-store', 'Service-Worker-Allowed': '/' }); + response.end("self.addEventListener('fetch', () => undefined);"); + return; + } + if (request.url === '/api/desktop/discovery') { + response.writeHead(200, { ...corsHeaders, 'Set-Cookie': 'discovery=must-not-persist; HttpOnly; SameSite=None' }); + response.end(discovery(name === 'first' + ? 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa' + : 'bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb')); + return; + } + if (request.method === 'DELETE' && request.url === '/api/desktop/tokens/current') { + response.writeHead(204, corsHeaders); + response.end(); + return; + } + if ((request.url === '/api/auth/user' || request.url === '/api/smoke/rest') + && /^Bearer propr_it_[A-Za-z0-9_-]{43}$/.test(record.authorization ?? '')) { + response.writeHead(200, { ...corsHeaders, 'Set-Cookie': 'remote=must-not-persist; HttpOnly; SameSite=None' }); + response.end(request.url === '/api/auth/user' ? '{"username":"packaged-smoke"}' : '{"ok":true}'); + return; + } + response.writeHead(401, corsHeaders); + response.end('{"code":"INVALID_INSTANCE_TOKEN"}'); + }); + const io = new SocketIOServer(server, { + path: '/socket.io/', + transports: ['websocket'], + cors: { origin: DESKTOP_RENDERER_ORIGIN, credentials: false }, + }); + io.of('/').use((socket, next) => { + const queryScopes = new URL(socket.handshake.url, 'http://fixture.invalid') + .searchParams.getAll(DESKTOP_TRANSPORT_SCOPE_QUERY); + const activationScope = socket.handshake.auth?.[DESKTOP_TRANSPORT_SCOPE_QUERY]; + const record = { + fixture: name, + method: 'SOCKET.IO', + url: socket.handshake.url, + authorization: socket.handshake.headers.authorization ?? null, + cookie: socket.handshake.headers.cookie ?? null, + origin: socket.handshake.headers.origin ?? null, + socketIo: true, + namespace: socket.nsp.name, + engineProtocol: socket.conn.protocol, + }; + requests.push(record); + if (!/^Bearer propr_it_[A-Za-z0-9_-]{43}$/.test(record.authorization ?? '') + || queryScopes.length !== 1 || typeof activationScope !== 'string' + || activationScope !== queryScopes[0]) { + const error = new Error(INVALID_INSTANCE_TOKEN); + error.data = { code: INVALID_INSTANCE_TOKEN }; + next(error); + return; + } + next(); + }); + io.of('/').on('connection', socket => socket.emit('packaged-smoke:connected', { ok: true })); + server.listen(0, '127.0.0.1'); + await once(server, 'listening'); + const address = server.address(); + if (!address || typeof address === 'string') throw new Error(`Packaged ${name} fixture did not bind`); + const fixture = { server, io, origin: `http://127.0.0.1:${address.port}` }; + fixtures.push(fixture); + return fixture; +}; + +const scanPathsForSecrets = async (paths, secrets) => { + const visit = async path => { + let entries; + try { entries = await readdir(path, { withFileTypes: true }); } + catch (error) { + if (error?.code === 'ENOENT') return false; + throw error; + } + for (const entry of entries) { + const child = join(path, entry.name); + if (entry.isDirectory()) { + if (await visit(child)) return true; + } else { + const bytes = await readFile(child); + if (secrets.some(secret => bytes.includes(Buffer.from(secret)))) return true; + } + } + return false; + }; + for (const path of paths) if (await visit(path)) return true; + return false; +}; + +let first; +let second; +let profileApiOrigin; +const runs = []; +const smokeProfiles = []; +const shutdownSteps = [ + 'admission-closed', + 'ipc-closed', + 'session-closed', + 'protocol-disposed', + 'credentials-dispose-started', + 'authentication-cleared', + 'lifecycle-drain-started', + 'ipc-drain-started', + 'service-drain-finished', + 'profiles-close-started', + 'profiles-close-finished', + 'session-disposed', + 'ipc-disposed', + 'window-destroyed', + 'final-quit', +]; + +const launch = async mode => { + const smokeProfile = await createPrivateSmokeProfile(); + smokeProfiles.push(smokeProfile); + const userDataPath = smokeProfile.userData; + const transport = mode !== 'release-guard'; + const baseChildEnvironment = await createSmokeChildEnvironment({ profile: smokeProfile, - profileApiUrl, + profileApiUrl: transport ? first.origin : profileApiOrigin, + }); + const dbusSessionAddress = process.env.DBUS_SESSION_BUS_ADDRESS; + if (process.platform === 'linux' && ( + typeof dbusSessionAddress !== 'string' + || dbusSessionAddress.length > 4096 + || !/^unix:path=\/[^\0\r\n,]+(?:,guid=[0-9a-f]{32})?$/.test(dbusSessionAddress) + )) { + throw new Error('Packaged Linux smoke requires one validated D-Bus session address'); + } + const launchPlan = createPackagedSmokeLaunch({ + mode, + platform: process.platform, + userDataPath, + baseChildEnvironment, + firstOrigin: first.origin, + secondOrigin: second.origin, + dbusSessionAddress, }); + const { childEnvironment, launchArguments, requiredMarkers } = launchPlan; + if (launchArguments.some(argument => argument === '--no-sandbox' || argument === '--disable-sandbox')) { + throw new Error('The packaged-binary smoke test must not disable Electron sandboxing'); + } + if (!transport && TRANSPORT_SMOKE_ENVIRONMENT_NAMES.some(name => Object.hasOwn(childEnvironment, name))) { + throw new Error('Packaged desktop release-guard launch inherited a transport-smoke environment variable'); + } + const requestStart = requests.length; + const profileApiRequestStart = profileApiRequests.length; + let output = ''; const child = spawn(binaryPath, launchArguments, { cwd: smokeProfile.root, env: childEnvironment, shell: false, stdio: ['ignore', 'pipe', 'pipe'], + windowsHide: true, }); - const capture = chunk => { - const text = chunk.toString(); - output += text; - process.stdout.write(text); + const value = chunk.toString(); + output += value; + process.stdout.write(value); }; child.stdout.on('data', capture); child.stderr.on('data', capture); - const result = await new Promise((resolveResult, reject) => { + const timeoutMs = transport ? TIMEOUT_MS : RELEASE_GUARD_TIMEOUT_MS; const timeout = setTimeout(() => { child.kill('SIGKILL'); - reject(new Error(`Packaged desktop did not reach renderer-ready within ${TIMEOUT_MS / 1000} seconds`)); - }, TIMEOUT_MS); - child.once('error', error => { - clearTimeout(timeout); - reject(error); - }); + reject(new Error(`Packaged desktop ${mode} smoke exceeded ${timeoutMs / 1000} seconds`)); + }, timeoutMs); + child.once('error', error => { clearTimeout(timeout); reject(error); }); child.once('close', (code, signal) => { clearTimeout(timeout); resolveResult({ code, signal }); @@ -170,41 +355,143 @@ try { }); const mainProcessError = MAIN_PROCESS_ERROR_MARKERS.find(marker => output.includes(marker)); - if (mainProcessError) { - throw new Error(`Packaged desktop reported a main-process uncaught exception (${mainProcessError})`); - } + if (mainProcessError) throw new Error(`Packaged desktop reported an uncaught exception (${mainProcessError})`); if (result.code !== 0) { throw new Error(`Packaged desktop exited with code ${result.code ?? 'null'} (signal ${result.signal ?? 'none'})`); } - if (!output.includes(READY_EVENT)) { - throw new Error('Packaged desktop exited without reporting renderer-ready'); - } - if (!output.includes(PRELOAD_BRIDGE_PROOF)) { - throw new Error('Packaged desktop reported renderer-ready without proving window.proprDesktop is exposed'); + const missingMarkers = requiredMarkers.filter(marker => !output.includes(marker)); + if (missingMarkers.length !== 0) { + throw new Error(`Packaged desktop ${mode} smoke missed required markers: ${missingMarkers.join(', ')}`); } - if (!output.includes(PROFILE_API_PROOF) || receivedProfileApiOrigin !== DESKTOP_RENDERER_ORIGIN) { - throw new Error('Packaged desktop did not complete a profile API request from its exact renderer origin'); - } - if (!output.includes(MVP_FLOWS_PROOF)) { - throw new Error('Packaged desktop did not complete local/remote/API profile and Connect discovery flows'); + const runRequests = requests.slice(requestStart); + if (!transport) { + const releaseGuardRequests = profileApiRequests.slice(profileApiRequestStart); + const expectedProfileApiPaths = ['/api/compatibility', '/api/desktop/discovery']; + if (releaseGuardRequests.length !== expectedProfileApiPaths.length + || expectedProfileApiPaths.some(path => !releaseGuardRequests.some(request => request.url === path)) + || releaseGuardRequests.some(request => ( + request.method !== 'GET' || request.origin !== DESKTOP_RENDERER_ORIGIN + ))) { + throw new Error('Packaged desktop release guard did not make both profile API requests from its exact renderer origin'); + } + const mvpProof = parseEventRecord(output, MVP_FLOWS_PROOF); + if (mvpProof?.localProfile !== true + || mvpProof?.remoteActiveProfile !== true + || mvpProof?.lifecycleBoundary !== true + || mvpProof?.connectUiPopulated !== true) { + throw new Error('Packaged desktop release guard did not prove local/remote profiles, lifecycle, and Connect UI population'); + } + if (runRequests.length !== 0 || output.includes(TRANSPORT_PROOF)) { + throw new Error('Packaged desktop release guard unexpectedly entered the transport-smoke branch'); + } + } else { + const socketShutdownDeadline = Date.now() + 2_000; + while (fixtures.some(fixture => fixture.io.of('/').sockets.size !== 0) + && Date.now() < socketShutdownDeadline) { + await new Promise(resolveWait => setTimeout(resolveWait, 20)); + } + if (fixtures.some(fixture => fixture.io.of('/').sockets.size !== 0)) { + throw new Error(`Packaged ${mode} shutdown left late authenticated Socket.IO work alive`); + } + const expectedBackend = process.platform === 'linux' ? 'gnome_libsecret' : 'os-protected'; + if (!output.includes(`"storageBackend":"${expectedBackend}"`)) { + throw new Error(`Packaged desktop did not use ${expectedBackend} production credential protection`); + } + let previousStep = -1; + for (const step of shutdownSteps) { + const marker = `"step":"${step}"`; + if (output.split(marker).length - 1 !== 1 || output.indexOf(marker) <= previousStep) { + throw new Error(`Packaged ${mode} shutdown did not run ${step} exactly once in order`); + } + previousStep = output.indexOf(marker); + } + const forced = output.includes('desktop.app.shutdown_forced'); + if (forced !== (mode === 'forced-timeout')) { + throw new Error(`Packaged ${mode} forced-timeout evidence was incorrect`); + } + if (mode === 'retry' && (!output.includes('desktop.app.shutdown_retry_requested') + || !output.includes('desktop.app.shutdown_retry'))) { + throw new Error('Packaged retry did not exercise a repeated prevented before-quit event'); + } } - assertPackagedLayout(parseEventLayout(output, LAYOUT_READY_EVENT)); + const packagedLayout = parseEventLayout(output, LAYOUT_READY_EVENT); + assertPackagedLayout(packagedLayout); + assertPackagedNativeWindowSizing(packagedLayout); assertPackagedNativeWindowSizing( parseEventLayout(output, REDUCED_NATIVE_WINDOW_READY_EVENT), { requireReducedWorkArea: true }, ); - console.log(`Packaged ${process.platform}-${process.arch} desktop reached renderer-ready with compiled layout, sandboxing, profile API proof, and reduced native window bounds.`); + if (!transport) { + runs.push({ mode, userDataPath, output, launchArguments, secrets: [] }); + return; + } + const authenticated = runRequests.filter(request => request.authorization?.startsWith('Bearer propr_it_')); + const secrets = [...new Set(authenticated.map(request => request.authorization.slice('Bearer '.length)))]; + if (secrets.length !== 2) throw new Error(`Expected two ${mode} activation credentials, observed ${secrets.length}`); + for (const name of ['first', 'second']) { + const fixtureRequests = authenticated.filter(request => request.fixture === name); + const namespaceConnections = fixtureRequests.filter(request => request.socketIo); + if (!fixtureRequests.some(request => request.url === '/api/auth/user') + || !fixtureRequests.some(request => request.url === '/api/smoke/rest') + || namespaceConnections.length < (name === 'second' ? 2 : 1) + || namespaceConnections.some(request => request.namespace !== '/' || request.engineProtocol !== 4)) { + throw new Error(`Packaged ${mode} ${name} fixture missed REST, Engine.IO, namespace auth, or reconnect proof`); + } + if (new Set(fixtureRequests.map(request => request.authorization)).size !== 1) { + throw new Error(`Packaged ${mode} ${name} fixture observed cross-generation bearer use`); + } + } + if (runRequests.some(request => request.cookie !== null) + || runRequests.some(request => secrets.some(secret => request.url?.includes(secret)))) { + throw new Error('Packaged renderer transport sent cookies or placed a credential in a URL'); + } + if (secrets.some(secret => output.includes(secret) || launchArguments.some(argument => argument.includes(secret)))) { + throw new Error('Packaged credential entered stdout, stderr, or argv'); + } + const credentialFiles = await readdir(join(userDataPath, 'desktop', 'credentials')); + if (credentialFiles.length === 0 || await scanPathsForSecrets([userDataPath], secrets)) { + throw new Error('Packaged credential material was missing or plaintext anywhere under isolated userData'); + } + runs.push({ mode, userDataPath, output, launchArguments, secrets }); +}; + +try { + profileApiOrigin = await listenProfileApiFixture(); + first = await listenFixture('first'); + second = await listenFixture('second'); + for (const mode of PACKAGED_SMOKE_LAUNCH_MODES) await launch(mode); + const allSecrets = runs.flatMap(run => run.secrets); + const scanRoots = [ + ...runs.map(run => run.userDataPath), + ...(process.env.PROPR_DESKTOP_SMOKE_KEYRING_ROOT ? [resolve(process.env.PROPR_DESKTOP_SMOKE_KEYRING_ROOT)] : []), + ]; + if (await scanPathsForSecrets(scanRoots, allSecrets)) { + throw new Error('A packaged credential entered the isolated userData or OS keyring scan roots'); + } + console.log( + `Packaged ${process.platform} desktop smoke passed (4/4 isolated launches): release-guard protocol-1 profile ` + + 'and Connect UI proof; 3/3 protocol-2 transport shutdown modes with production OS credentials, real ' + + 'Socket.IO/Engine.IO namespace auth, scope rotation/reconnect/error handling, five-type both-origin ' + + `rollback cleanup, compiled welcome-card layout, no cookies, and byte scans of ${scanRoots.join(', ')}.`, + ); } finally { try { - if (profileApiServer.listening) { - profileApiServer.closeAllConnections(); - await new Promise((resolveClose, rejectClose) => profileApiServer.close(error => { - if (error) rejectClose(error); - else resolveClose(); - })); + for (const { io, server } of fixtures) { + await new Promise(resolveClose => io.close(resolveClose)); + if (server.listening) await new Promise(resolveClose => server.close(resolveClose)); } } finally { - await removePrivateSmokeProfile(smokeProfile); + try { + if (profileApiServer.listening) { + profileApiServer.closeAllConnections(); + await new Promise((resolveClose, rejectClose) => profileApiServer.close(error => { + if (error) rejectClose(error); + else resolveClose(); + })); + } + } finally { + for (const smokeProfile of smokeProfiles) await removePrivateSmokeProfile(smokeProfile); + } } } diff --git a/apps/desktop/scripts/verify-darwin-packaged-connect-signature.mjs b/apps/desktop/scripts/verify-darwin-packaged-connect-signature.mjs new file mode 100644 index 000000000..9de49e00e --- /dev/null +++ b/apps/desktop/scripts/verify-darwin-packaged-connect-signature.mjs @@ -0,0 +1,304 @@ +#!/usr/bin/env node + +import { readFile, writeFile } from 'node:fs/promises'; +import { fileURLToPath } from 'node:url'; +import { runBoundedProcess } from './run-bounded-darwin-command.mjs'; +import { + DarwinSigningDiagnosticError, + darwinSigningDiagnosticLine, +} from './sign-darwin-packaged-connect.mjs'; + +const REQUIRED_IDENTIFIER = 'dev.propr.desktop'; +const SHA1_PATTERN = /^[A-F0-9]{40}$/u; +const CERTIFICATE_LINE = /^\s*SHA-1 hash:\s*([A-Fa-f0-9]{40})\s*$/gmu; +const ADHOC_SIGNATURE_LINE = /^\s*signature\s*=\s*adhoc\s*$/iu; +const IDENTIFIER_LINE = /^\s*identifier\s*=\s*(.*?)\s*$/iu; +const SIGNATURE_SIZE_LINE = /^\s*signature\s+size\s*=\s*(.*?)\s*$/iu; +const POSITIVE_SIGNATURE_SIZE = /^[1-9][0-9]*$/u; +const DESIGNATED_REQUIREMENT_PREFIX = /^designated\s*=>/iu; +const DESIGNATED_REQUIREMENT_GRAMMAR = /^designated\s*=>\s*identifier\s+"([^"]+)"\s+and\s+certificate\s+leaf\s*=\s*H\s*"([A-F0-9]{40})"$/iu; +const VERIFICATION_TIMEOUT_MS = 20_000; +const VERIFICATION_TERMINATION_GRACE_MS = 1_000; +const VERIFICATION_MAX_OUTPUT_BYTES = 256 * 1024; + +export const DARWIN_VERIFICATION_DIAGNOSTICS = Object.freeze({ + certificateLookupFailure: 'CERTIFICATE_LOOKUP_FAILURE', + signatureDisplayFailure: 'SIGNATURE_DISPLAY_FAILURE', + embeddedRequirementFailure: 'EMBEDDED_REQUIREMENT_FAILURE', + strictVerifyFailure: 'STRICT_VERIFY_FAILURE', + keychainEvidenceFailure: 'KEYCHAIN_EVIDENCE_FAILURE', + adhocSignatureFailure: 'ADHOC_SIGNATURE_FAILURE', + identifierMetadataFailure: 'IDENTIFIER_METADATA_FAILURE', + signatureMetadataFailure: 'SIGNATURE_METADATA_FAILURE', + requirementEvidenceFailure: 'REQUIREMENT_EVIDENCE_FAILURE', + evidenceAssertionFailure: 'EVIDENCE_ASSERTION_FAILURE', +}); + +const verificationFailure = (diagnostic, cause) => new DarwinSigningDiagnosticError( + diagnostic, + cause, +); + +const runVerificationCommand = async (runCommand, executable, arguments_, diagnostic) => { + try { + return await runCommand({ + executable, + arguments: arguments_, + timeoutMs: VERIFICATION_TIMEOUT_MS, + terminationGraceMs: VERIFICATION_TERMINATION_GRACE_MS, + maxOutputBytes: VERIFICATION_MAX_OUTPUT_BYTES, + forwardOutput: false, + }); + } catch (cause) { + throw verificationFailure(diagnostic, cause); + } +}; + +const normalizeLines = value => value.replace(/\r\n?/gu, '\n').split('\n'); + +const expectedRequirementsFor = expectedCertificateSha1 => { + try { + const expectedSha1 = expectedCertificateSha1; + if (!SHA1_PATTERN.test(expectedSha1)) throw new Error('invalid-certificate-fingerprint'); + const expression = `identifier "${REQUIRED_IDENTIFIER}" and certificate leaf = H"${expectedSha1}"`; + return { + expectedSha1, + expression, + }; + } catch (cause) { + throw verificationFailure( + DARWIN_VERIFICATION_DIAGNOSTICS.evidenceAssertionFailure, + cause, + ); + } +}; + +const assertExactKeychainCertificate = (certificateDetails, expectedCertificateSha1) => { + const { expectedSha1 } = expectedRequirementsFor(expectedCertificateSha1); + try { + const fingerprints = [...certificateDetails.matchAll(CERTIFICATE_LINE)] + .map(match => match[1].toUpperCase()); + if (fingerprints.length !== 1 || fingerprints[0] !== expectedSha1) { + throw new Error('invalid-keychain-certificate-evidence'); + } + } catch (cause) { + throw verificationFailure( + DARWIN_VERIFICATION_DIAGNOSTICS.keychainEvidenceFailure, + cause, + ); + } +}; + +const assertNotAdhocSignature = signatureDetails => { + try { + if (normalizeLines(signatureDetails).some(line => ADHOC_SIGNATURE_LINE.test(line))) { + throw new Error('ad-hoc-signature-evidence'); + } + } catch (cause) { + throw verificationFailure( + DARWIN_VERIFICATION_DIAGNOSTICS.adhocSignatureFailure, + cause, + ); + } +}; + +const assertIdentifierMetadata = signatureDetails => { + try { + const identifiers = normalizeLines(signatureDetails) + .map(line => line.match(IDENTIFIER_LINE)) + .filter(match => match !== null) + .map(match => match[1]); + if (identifiers.length !== 1 || identifiers[0] !== REQUIRED_IDENTIFIER) { + throw new Error('invalid-identifier-display-evidence'); + } + } catch (cause) { + throw verificationFailure( + DARWIN_VERIFICATION_DIAGNOSTICS.identifierMetadataFailure, + cause, + ); + } +}; + +const assertSignatureMetadata = signatureDetails => { + try { + const signatureSizes = normalizeLines(signatureDetails) + .map(line => line.match(SIGNATURE_SIZE_LINE)) + .filter(match => match !== null) + .map(match => match[1]); + if (signatureSizes.length !== 1 || !POSITIVE_SIGNATURE_SIZE.test(signatureSizes[0])) { + throw new Error('invalid-signature-display-evidence'); + } + } catch (cause) { + throw verificationFailure( + DARWIN_VERIFICATION_DIAGNOSTICS.signatureMetadataFailure, + cause, + ); + } +}; + +const assertDesignatedRequirement = ( + designatedRequirement, + expectedSha1, + previousDesignatedRequirement, +) => { + try { + const designatedLines = normalizeLines(designatedRequirement) + .map(line => line.trim()) + .filter(line => DESIGNATED_REQUIREMENT_PREFIX.test(line)); + if (designatedLines.length !== 1) { + throw new Error('ambiguous-embedded-requirement-evidence'); + } + const requirementMatch = designatedLines[0].match(DESIGNATED_REQUIREMENT_GRAMMAR); + if (!requirementMatch + || requirementMatch[1] !== REQUIRED_IDENTIFIER + || requirementMatch[2].toUpperCase() !== expectedSha1) { + throw new Error('invalid-embedded-requirement-evidence'); + } + const normalizedRequirement = `${designatedLines[0]}\n`; + if (previousDesignatedRequirement !== undefined + && previousDesignatedRequirement !== normalizedRequirement) { + throw new Error('unstable-embedded-requirement-evidence'); + } + return normalizedRequirement; + } catch (cause) { + throw verificationFailure( + DARWIN_VERIFICATION_DIAGNOSTICS.requirementEvidenceFailure, + cause, + ); + } +}; + +export const assertDarwinSigningEvidence = ({ + expectedCertificateSha1, + signatureDetails, + designatedRequirement, + previousDesignatedRequirement, +}) => { + const expected = expectedRequirementsFor(expectedCertificateSha1); + assertNotAdhocSignature(signatureDetails); + assertIdentifierMetadata(signatureDetails); + assertSignatureMetadata(signatureDetails); + return assertDesignatedRequirement( + designatedRequirement, + expected.expectedSha1, + previousDesignatedRequirement, + ); +}; + +export const inspectDarwinSigningEvidence = async ({ + application, + keychain, + expectedCertificateSha1, + runCommand = runBoundedProcess, +}) => { + expectedRequirementsFor(expectedCertificateSha1); + const certificateResult = await runVerificationCommand( + runCommand, + '/usr/bin/security', + ['find-certificate', '-a', '-Z', keychain], + DARWIN_VERIFICATION_DIAGNOSTICS.certificateLookupFailure, + ); + assertExactKeychainCertificate( + `${certificateResult.stdout}\n${certificateResult.stderr}`, + expectedCertificateSha1, + ); + const signatureResult = await runVerificationCommand( + runCommand, + '/usr/bin/codesign', + ['-d', '--verbose=4', application], + DARWIN_VERIFICATION_DIAGNOSTICS.signatureDisplayFailure, + ); + const requirementResult = await runVerificationCommand( + runCommand, + '/usr/bin/codesign', + ['-d', '-r-', application], + DARWIN_VERIFICATION_DIAGNOSTICS.embeddedRequirementFailure, + ); + await runVerificationCommand( + runCommand, + '/usr/bin/codesign', + ['--verify', '--deep', '--strict', application], + DARWIN_VERIFICATION_DIAGNOSTICS.strictVerifyFailure, + ); + try { + return { + signatureDetails: `${signatureResult.stdout}\n${signatureResult.stderr}`, + designatedRequirement: `${requirementResult.stdout}\n${requirementResult.stderr}`, + }; + } catch (cause) { + throw verificationFailure( + DARWIN_VERIFICATION_DIAGNOSTICS.evidenceAssertionFailure, + cause, + ); + } +}; + +export const verifyDarwinPackagedConnectSignature = async ({ + mode, + application, + expectedCertificateSha1, + proofPath, + keychain, + runCommand = runBoundedProcess, +}) => { + if (mode !== 'establish' && mode !== 'stable') { + throw verificationFailure(DARWIN_VERIFICATION_DIAGNOSTICS.evidenceAssertionFailure); + } + if (!keychain || !keychain.endsWith('.keychain-db')) { + throw verificationFailure(DARWIN_VERIFICATION_DIAGNOSTICS.evidenceAssertionFailure); + } + let previousDesignatedRequirement; + if (mode === 'stable') { + try { + previousDesignatedRequirement = await readFile(proofPath, 'utf8'); + } catch (cause) { + throw verificationFailure( + DARWIN_VERIFICATION_DIAGNOSTICS.evidenceAssertionFailure, + cause, + ); + } + } + const evidence = await inspectDarwinSigningEvidence({ + application, + keychain, + expectedCertificateSha1, + runCommand, + }); + const requirement = assertDarwinSigningEvidence({ + expectedCertificateSha1, + previousDesignatedRequirement, + ...evidence, + }); + if (mode === 'establish') { + try { + await writeFile(proofPath, requirement, { + encoding: 'utf8', mode: 0o600, flag: 'wx', + }); + } catch (cause) { + throw verificationFailure( + DARWIN_VERIFICATION_DIAGNOSTICS.evidenceAssertionFailure, + cause, + ); + } + } +}; + +const isMain = process.argv[1] && fileURLToPath(import.meta.url) === process.argv[1]; +if (isMain) { + const [ + mode, application, expectedCertificateSha1, proofPath, keychain, + ] = process.argv.slice(2); + try { + if (process.platform !== 'darwin' + || !mode || !application || !expectedCertificateSha1 || !proofPath + || !keychain) { + throw verificationFailure(DARWIN_VERIFICATION_DIAGNOSTICS.evidenceAssertionFailure); + } + await verifyDarwinPackagedConnectSignature({ + mode, application, expectedCertificateSha1, proofPath, keychain, + }); + } catch (error) { + process.stderr.write(darwinSigningDiagnosticLine(error)); + process.exitCode = 1; + } +} diff --git a/apps/desktop/scripts/verify-darwin-packaged-connect-signature.test.mjs b/apps/desktop/scripts/verify-darwin-packaged-connect-signature.test.mjs new file mode 100644 index 000000000..490f4a4ae --- /dev/null +++ b/apps/desktop/scripts/verify-darwin-packaged-connect-signature.test.mjs @@ -0,0 +1,455 @@ +import assert from 'node:assert/strict'; +import { mkdtemp, readFile, rm } from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import { describe, test } from 'node:test'; +import { + classifyDarwinSigningFailure, + darwinSigningDiagnosticLine, +} from './sign-darwin-packaged-connect.mjs'; +import { + DARWIN_VERIFICATION_DIAGNOSTICS, + assertDarwinSigningEvidence, + inspectDarwinSigningEvidence, + verifyDarwinPackagedConnectSignature, +} from './verify-darwin-packaged-connect-signature.mjs'; + +const REQUIRED_IDENTIFIER = 'dev.propr.desktop'; +const application = '/private/tmp/propr-desktop.app'; +const keychain = '/private/tmp/propr-smoke.keychain-db'; +const fingerprint = 'A'.repeat(40); +const otherFingerprint = 'B'.repeat(40); +const requirementExpressionFor = certificateSha1 => ( + `identifier "${REQUIRED_IDENTIFIER}" and certificate leaf = H"${certificateSha1}"` +); +const requirementFor = certificateSha1 => ( + `designated => ${requirementExpressionFor(certificateSha1)}` +); + +const validEvidence = (overrides = {}) => ({ + expectedCertificateSha1: fingerprint, + signatureDetails: [ + 'Executable=/private/tmp/propr-desktop.app/Contents/MacOS/propr-desktop', + `Identifier=${REQUIRED_IDENTIFIER}`, + 'Signature size=1024', + ].join('\n'), + designatedRequirement: `${requirementFor(fingerprint)}\n`, + ...overrides, +}); + +const createVerifierSimulator = (overrides = {}) => { + const fixture = { + signed: true, + certificateFingerprints: [fingerprint], + identifierLine: `Identifier=${REQUIRED_IDENTIFIER}`, + signatureLine: 'Signature size=1024', + designatedRequirement: `${requirementFor(fingerprint)}\n`, + strictValid: true, + ...overrides, + }; + const calls = []; + const runCommand = async options => { + calls.push(options); + const arguments_ = options.arguments; + if (options.executable === '/usr/bin/security') { + assert.deepEqual(arguments_, ['find-certificate', '-a', '-Z', keychain]); + return { + stdout: fixture.certificateFingerprints + .map(value => `SHA-1 hash: ${value}`) + .join('\n'), + stderr: '', + }; + } + if (arguments_[0] === '-d' && arguments_[1] === '--verbose=4') { + if (!fixture.signed) throw new Error(`unsigned secret ${application}`); + return { + stdout: '', + stderr: [ + 'Executable=/private/tmp/propr-desktop.app/Contents/MacOS/propr-desktop', + fixture.identifierLine, + 'Format=app bundle with Mach-O universal (x86_64 arm64)', + fixture.signatureLine, + 'Info.plist entries=25', + ].filter(value => value !== null).join('\n'), + }; + } + if (arguments_[0] === '-d' && arguments_[1] === '-r-') { + return { stdout: '', stderr: fixture.designatedRequirement }; + } + if (arguments_.includes('--strict')) { + if (!fixture.strictValid) throw new Error(`strict failure ${application}`); + return { stdout: '', stderr: '' }; + } + throw new Error('unexpected simulated verifier invocation'); + }; + return { calls, runCommand }; +}; + +const withPrivateProofPath = async callback => { + const directory = await mkdtemp(join(tmpdir(), 'propr-signature-evidence-')); + try { + await callback(join(directory, 'designated-requirement.txt')); + } finally { + await rm(directory, { recursive: true, force: true }); + } +}; + +const isDiagnostic = diagnostic => error => { + assert.equal(classifyDarwinSigningFailure(error), diagnostic); + assert.equal( + darwinSigningDiagnosticLine(error), + `DARWIN_PACKAGED_CONNECT_DIAGNOSTIC:${diagnostic}\n`, + ); + assert.doesNotMatch(darwinSigningDiagnosticLine(error), /private|[A-F0-9]{40}/u); + return true; +}; + +const verifyEstablish = async (proofPath, fixture = {}) => { + const simulator = createVerifierSimulator(fixture); + await verifyDarwinPackagedConnectSignature({ + mode: 'establish', + application, + expectedCertificateSha1: fingerprint, + proofPath, + keychain, + runCommand: simulator.runCommand, + }); + return simulator; +}; + +describe('Darwin packaged Connect acceptance signature proof', () => { + test('uses the portable bounded certificate, display, requirement, and strict proof chain', async () => { + const simulator = createVerifierSimulator(); + const evidence = await inspectDarwinSigningEvidence({ + application, + keychain, + expectedCertificateSha1: fingerprint, + runCommand: simulator.runCommand, + }); + + assert.equal( + assertDarwinSigningEvidence({ expectedCertificateSha1: fingerprint, ...evidence }), + `${requirementFor(fingerprint)}\n`, + ); + assert.deepEqual(simulator.calls.map(call => [call.executable, call.arguments]), [ + ['/usr/bin/security', ['find-certificate', '-a', '-Z', keychain]], + ['/usr/bin/codesign', ['-d', '--verbose=4', application]], + ['/usr/bin/codesign', ['-d', '-r-', application]], + ['/usr/bin/codesign', ['--verify', '--deep', '--strict', application]], + ]); + assert.ok(!simulator.calls.some(call => call.arguments.some(argument => ( + argument === '-R' + || argument.startsWith('-R=') + || argument === '--extract-certificates' + )))); + for (const call of simulator.calls) { + assert.equal(call.timeoutMs, 20_000); + assert.equal(call.terminationGraceMs, 1_000); + assert.equal(call.maxOutputBytes, 256 * 1024); + assert.equal(call.forwardOutput, false); + } + }); + + test('accepts exactly the generated keychain fingerprint and stable normalized requirements', async () => { + await withPrivateProofPath(async proofPath => { + const displayedRequirement = `${requirementFor(fingerprint.toLowerCase())}\n`; + await verifyEstablish(proofPath, { designatedRequirement: displayedRequirement }); + assert.equal(await readFile(proofPath, 'utf8'), displayedRequirement); + await verifyDarwinPackagedConnectSignature({ + mode: 'stable', + application, + expectedCertificateSha1: fingerprint, + proofPath, + keychain, + runCommand: createVerifierSimulator({ + designatedRequirement: displayedRequirement, + }).runCommand, + }); + }); + }); + + test('rejects duplicate and wrong keychain fingerprints', async () => { + for (const certificateFingerprints of [ + [fingerprint, fingerprint], + [fingerprint, otherFingerprint], + [otherFingerprint], + ]) { + await withPrivateProofPath(async proofPath => { + await assert.rejects( + verifyEstablish(proofPath, { certificateFingerprints }), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.keychainEvidenceFailure), + ); + }); + } + }); + + test('rejects explicit ad-hoc signature metadata with spacing and case variants', async () => { + for (const signatureLine of [ + 'Signature=adhoc', + ' sIgNaTuRe = AdHoC ', + ]) { + await withPrivateProofPath(async proofPath => { + await assert.rejects( + verifyEstablish(proofPath, { signatureLine }), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.adhocSignatureFailure), + ); + }); + } + }); + + test('rejects empty signature details', () => { + assert.throws( + () => assertDarwinSigningEvidence(validEvidence({ signatureDetails: '' })), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.identifierMetadataFailure), + ); + }); + + test('rejects missing, wrong, duplicate, and conflicting identifier metadata distinctly', () => { + for (const signatureDetails of [ + 'Executable=/private/tmp/propr-desktop.app/Contents/MacOS/propr-desktop', + 'Signature size=1024', + 'Identifier=dev.other.desktop', + 'Identifier=DEV.PROPR.DESKTOP', + `Identifier=${REQUIRED_IDENTIFIER}\nIdentifier=${REQUIRED_IDENTIFIER}`, + `Identifier=${REQUIRED_IDENTIFIER}\nIDENTIFIER = dev.other.desktop`, + ]) { + assert.throws( + () => assertDarwinSigningEvidence(validEvidence({ signatureDetails })), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.identifierMetadataFailure), + ); + } + }); + + test('rejects missing, zero, duplicate, and conflicting signature-size metadata distinctly', () => { + for (const signatureDetails of [ + `Identifier=${REQUIRED_IDENTIFIER}`, + `Identifier=${REQUIRED_IDENTIFIER}\nSignature size=0`, + `Identifier=${REQUIRED_IDENTIFIER}\nSignature size=01`, + `Identifier=${REQUIRED_IDENTIFIER}\nSignature size=1024\nSignature size=1024`, + `Identifier=${REQUIRED_IDENTIFIER}\nSignature size=1024\nSIGNATURE SIZE = 2048`, + ]) { + assert.throws( + () => assertDarwinSigningEvidence(validEvidence({ signatureDetails })), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.signatureMetadataFailure), + ); + } + }); + + test('requires root identifier evidence during both initial and stable native inspections', async () => { + await withPrivateProofPath(async proofPath => { + await assert.rejects( + verifyEstablish(proofPath, { identifierLine: null }), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.identifierMetadataFailure), + ); + await verifyEstablish(proofPath); + await assert.rejects(verifyDarwinPackagedConnectSignature({ + mode: 'stable', + application, + expectedCertificateSha1: fingerprint, + proofPath, + keychain, + runCommand: createVerifierSimulator({ identifierLine: null }).runCommand, + }), isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.identifierMetadataFailure)); + }); + }); + + test('requires positive signature-size evidence during both native inspections', async () => { + await withPrivateProofPath(async proofPath => { + await assert.rejects( + verifyEstablish(proofPath, { signatureLine: null }), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.signatureMetadataFailure), + ); + await verifyEstablish(proofPath); + await assert.rejects(verifyDarwinPackagedConnectSignature({ + mode: 'stable', + application, + expectedCertificateSha1: fingerprint, + proofPath, + keychain, + runCommand: createVerifierSimulator({ signatureLine: 'Signature size=0' }).runCommand, + }), isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.signatureMetadataFailure)); + }); + }); + + test('rejects the wrong embedded requirement leaf distinctly', async () => { + await withPrivateProofPath(async proofPath => { + await assert.rejects( + verifyEstablish(proofPath, { + designatedRequirement: `${requirementFor(otherFingerprint)}\n`, + }), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.requirementEvidenceFailure), + ); + }); + }); + + test('requires byte-exact embedded designated-requirement stability after reprobe', async () => { + await withPrivateProofPath(async proofPath => { + await verifyEstablish(proofPath); + await assert.rejects(verifyDarwinPackagedConnectSignature({ + mode: 'stable', + application, + expectedCertificateSha1: fingerprint, + proofPath, + keychain, + runCommand: createVerifierSimulator({ + designatedRequirement: `${requirementFor(fingerprint.toLowerCase())}\n`, + }).runCommand, + }), isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.requirementEvidenceFailure)); + }); + }); + + test('strict verification failure has its fixed secret-safe subcode', async () => { + await withPrivateProofPath(async proofPath => { + await assert.rejects( + verifyEstablish(proofPath, { strictValid: false }), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.strictVerifyFailure), + ); + }); + }); + + test('wraps every native verifier operation in its distinct fixed subcode', async () => { + const diagnostics = [ + DARWIN_VERIFICATION_DIAGNOSTICS.certificateLookupFailure, + DARWIN_VERIFICATION_DIAGNOSTICS.signatureDisplayFailure, + DARWIN_VERIFICATION_DIAGNOSTICS.embeddedRequirementFailure, + DARWIN_VERIFICATION_DIAGNOSTICS.strictVerifyFailure, + ]; + for (const [failureIndex, diagnostic] of diagnostics.entries()) { + let invocation = 0; + const simulator = createVerifierSimulator(); + await assert.rejects(inspectDarwinSigningEvidence({ + application, + keychain, + expectedCertificateSha1: fingerprint, + runCommand: async options => { + if (invocation++ === failureIndex) { + throw new Error(`private failure ${application} ${fingerprint}`); + } + return simulator.runCommand(options); + }, + }), isDiagnostic(diagnostic)); + } + }); + + test('unsigned code fails at signature display with a fixed secret-safe subcode', async () => { + await assert.rejects(inspectDarwinSigningEvidence({ + application, + keychain, + expectedCertificateSha1: fingerprint, + runCommand: createVerifierSimulator({ signed: false }).runCommand, + }), isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.signatureDisplayFailure)); + }); + + test('accepts surrounding requirement metadata and CRLF, spacing, and keyword case variants', async () => { + await withPrivateProofPath(async proofPath => { + const selectedLine = [ + 'DeSiGnAtEd => IDENTIFIER "dev.propr.desktop" AnD', + `CERTIFICATE LEAF = h "${fingerprint.toLowerCase()}"`, + ].join(' '); + const requirementOutput = [ + 'Executable=/private/tmp/propr-desktop.app/Contents/MacOS/propr-desktop', + 'warning: using architecture arm64', + ` ${selectedLine} `, + 'Format=app bundle with Mach-O thin (arm64)', + ].join('\r\n'); + await verifyEstablish(proofPath, { designatedRequirement: requirementOutput }); + assert.equal(await readFile(proofPath, 'utf8'), `${selectedLine}\n`); + await verifyDarwinPackagedConnectSignature({ + mode: 'stable', + application, + expectedCertificateSha1: fingerprint, + proofPath, + keychain, + runCommand: createVerifierSimulator({ + designatedRequirement: requirementOutput, + }).runCommand, + }); + }); + }); + + test('accepts realistic verbose metadata with exactly one identifier and positive signature size', () => { + for (const signatureDetails of [ + `Identifier=${REQUIRED_IDENTIFIER}\nSignature size=1024`, + `Executable=/private/tmp/propr-desktop.app/Contents/MacOS/propr-desktop\nIdentifier=${REQUIRED_IDENTIFIER}\nSignature size=2048`, + `Executable=/private/tmp/propr-desktop.app/Contents/MacOS/propr-desktop\r\n IDENTIFIER = ${REQUIRED_IDENTIFIER} \r\nFormat=app bundle with Mach-O thin (arm64)\r\n SIGNATURE SIZE = 4096 `, + ]) { + assert.equal( + assertDarwinSigningEvidence(validEvidence({ signatureDetails })), + `${requirementFor(fingerprint)}\n`, + ); + } + }); + + test('rejects duplicate designated lines, wrong identifiers and leaves, and extra clauses', () => { + for (const designatedRequirement of [ + '', + [requirementFor(fingerprint), requirementFor(fingerprint)].join('\n'), + `${requirementFor(fingerprint)}\n${requirementFor(otherFingerprint)}\n`, + `${requirementFor(fingerprint).replace(REQUIRED_IDENTIFIER, 'dev.other.desktop')}\n`, + `${requirementFor(fingerprint).replace(REQUIRED_IDENTIFIER, 'DEV.PROPR.DESKTOP')}\n`, + `${requirementFor(otherFingerprint)}\n`, + `${requirementFor(fingerprint)} or anchor apple\n`, + `${requirementFor(fingerprint)} and certificate 1 trusted\n`, + `designated => (${requirementExpressionFor(fingerprint)})\n`, + ]) { + assert.throws( + () => assertDarwinSigningEvidence(validEvidence({ designatedRequirement })), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.requirementEvidenceFailure), + ); + } + }); + + test('ignores unrelated surrounding lines but requires exactly one designated line', () => { + for (const designatedRequirement of [ + [ + 'Executable=/private/tmp/propr-desktop.app/Contents/MacOS/propr-desktop', + 'Format=app bundle with Mach-O universal (x86_64 arm64)', + ].join('\n'), + [ + 'Executable=/private/tmp/propr-desktop.app/Contents/MacOS/propr-desktop', + requirementFor(fingerprint), + 'Format=app bundle with Mach-O thin (x86_64)', + requirementFor(fingerprint), + ].join('\n'), + ]) { + assert.throws( + () => assertDarwinSigningEvidence(validEvidence({ designatedRequirement })), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.requirementEvidenceFailure), + ); + } + }); + + test('normalizes only surrounding line whitespace when comparing stable requirements', () => { + const initial = validEvidence({ + designatedRequirement: `metadata\r\n ${requirementFor(fingerprint)} \r\nmore metadata\r\n`, + }); + assert.equal( + assertDarwinSigningEvidence(initial), + `${requirementFor(fingerprint)}\n`, + ); + assert.equal( + assertDarwinSigningEvidence({ + ...initial, + previousDesignatedRequirement: `${requirementFor(fingerprint)}\n`, + }), + `${requirementFor(fingerprint)}\n`, + ); + assert.throws( + () => assertDarwinSigningEvidence({ + ...initial, + designatedRequirement: `${requirementFor(fingerprint).replace(' and ', ' and ')}\n`, + previousDesignatedRequirement: `${requirementFor(fingerprint)}\n`, + }), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.requirementEvidenceFailure), + ); + }); + + test('retains EVIDENCE_ASSERTION_FAILURE for invalid verifier inputs', () => { + assert.throws( + () => assertDarwinSigningEvidence(validEvidence({ + expectedCertificateSha1: 'not-a-sha1', + })), + isDiagnostic(DARWIN_VERIFICATION_DIAGNOSTICS.evidenceAssertionFailure), + ); + }); +}); diff --git a/apps/desktop/scripts/windows-fixture-acl.mjs b/apps/desktop/scripts/windows-fixture-acl.mjs new file mode 100644 index 000000000..e935478f0 --- /dev/null +++ b/apps/desktop/scripts/windows-fixture-acl.mjs @@ -0,0 +1,212 @@ +import { spawnSync } from 'node:child_process'; +import { lstatSync } from 'node:fs'; +import { win32 } from 'node:path'; +import { TextDecoder } from 'node:util'; + +export const windowsFixtureAclSource = String.raw` +$ErrorActionPreference='Stop' +$ProgressPreference='SilentlyContinue' +function Set-ProprFixtureAcl { + [CmdletBinding()] + param( + [Parameter(Mandatory=$true)][ValidateSet('directory','file')][string]$EntryKind, + [Parameter(Mandatory=$true)][ValidateNotNullOrEmpty()][string]$EntryPath + ) + try { + if(-not [IO.Path]::IsPathRooted($EntryPath)){exit 40} + } catch { exit 40 } + try { + $canonicalPath=[IO.Path]::GetFullPath($EntryPath) + } catch { exit 48 } + try { + if(-not [String]::Equals($canonicalPath,$EntryPath,[StringComparison]::OrdinalIgnoreCase)){exit 49} + } catch { exit 49 } + try { + $item=Get-Item -LiteralPath $canonicalPath + $directory=$EntryKind -eq 'directory' + if($directory -ne $item.PSIsContainer){exit 41} + } catch { exit 41 } + try { + $current=[Security.Principal.WindowsIdentity]::GetCurrent().User + if($null -eq $current){exit 42} + } catch { exit 42 } + try { + $system=[Security.Principal.SecurityIdentifier]::new('S-1-5-18') + $admins=[Security.Principal.SecurityIdentifier]::new('S-1-5-32-544') + } catch { exit 43 } + try { + $sections=[System.Security.AccessControl.AccessControlSections]::Access + $acl=if($directory){ + [System.IO.Directory]::GetAccessControl($canonicalPath,$sections) + }else{[System.IO.File]::GetAccessControl($canonicalPath,$sections)} + } catch { exit 44 } + try { + $null=$acl.SetAccessRuleProtection($true,$false) + foreach($existing in @($acl.Access)){$null=$acl.RemoveAccessRuleSpecific($existing)} + } catch { exit 45 } + try { + foreach($identity in @($current,$system,$admins)){ + $rights=[Security.AccessControl.FileSystemRights]::FullControl + $accessType=[Security.AccessControl.AccessControlType]::Allow + $rule=if($directory){ + $inheritance=[Security.AccessControl.InheritanceFlags]::ContainerInherit -bor [Security.AccessControl.InheritanceFlags]::ObjectInherit + $propagation=[Security.AccessControl.PropagationFlags]::None + [Security.AccessControl.FileSystemAccessRule]::new($identity,$rights,$inheritance,$propagation,$accessType) + }else{[Security.AccessControl.FileSystemAccessRule]::new($identity,$rights,$accessType)} + $null=$acl.AddAccessRule($rule) + } + } catch { exit 46 } + try { + if($directory){ + $null=[System.IO.Directory]::SetAccessControl($canonicalPath,[System.Security.AccessControl.DirectorySecurity]$acl) + }else{ + $null=[System.IO.File]::SetAccessControl($canonicalPath,[System.Security.AccessControl.FileSecurity]$acl) + } + } catch { exit 47 } +} +try { + $null=Set-ProprFixtureAcl -EntryKind $env:PROPR_FIXTURE_ACL_KIND -EntryPath $env:PROPR_FIXTURE_ACL_PATH +} catch { + exit 50 +}`; + +export const encodedWindowsFixtureAcl = Buffer.from(windowsFixtureAclSource, 'utf16le').toString('base64'); + +const WINDOWS_FIXTURE_PATH_MAX_BYTES = 4 * 1024; +const WINDOWS_FIXTURE_PROCESS_MAX_BYTES = 8 * 1024; + +const windowsFixtureCanonicalPathSource = String.raw` +$ErrorActionPreference='Stop' +try { + $entryPath=$env:PROPR_FIXTURE_CANONICAL_PATH + if([String]::IsNullOrEmpty($entryPath) -or -not [IO.Path]::IsPathRooted($entryPath)){exit 60} +} catch { exit 60 } +try { + $canonicalPath=[IO.Path]::GetFullPath($entryPath) +} catch { exit 61 } +try { + $utf8=[Text.UTF8Encoding]::new($false) + $byteCount=$utf8.GetByteCount($canonicalPath) + if($byteCount -lt 1 -or $byteCount -gt 4096 -or $canonicalPath.IndexOf([char]0) -ge 0 -or $canonicalPath.IndexOf([char]13) -ge 0 -or $canonicalPath.IndexOf([char]10) -ge 0){exit 62} + [Console]::OutputEncoding=$utf8 + $null=[Console]::Out.Write($canonicalPath) +} catch { exit 63 } +`; + +const encodedWindowsFixtureCanonicalPath = Buffer.from( + windowsFixtureCanonicalPathSource, + 'utf16le', +).toString('base64'); + +const canonicalizationFailure = (phase, category) => { + const error = new Error(`Windows fixture canonicalization failed [phase=${phase} category=${category}]`); + error.stack = error.message; + throw error; +}; + +export const windowsPowerShell51Path = (environment = process.env) => { + const systemRoot = environment.SystemRoot; + if (typeof systemRoot !== 'string' + || systemRoot.length === 0 + || systemRoot.includes('\0') + || systemRoot.includes('\r') + || systemRoot.includes('\n') + || !win32.isAbsolute(systemRoot)) { + canonicalizationFailure('powershell-path', 'invalid-system-root'); + } + return win32.join(systemRoot, 'System32', 'WindowsPowerShell', 'v1.0', 'powershell.exe'); +}; + +const entryTypeMatches = (status, entryKind) => (entryKind === 'directory' + ? status.isDirectory() && !status.isSymbolicLink() + : status.isFile() && !status.isSymbolicLink()); + +const sameEntryIdentity = (left, right) => left.dev === right.dev && left.ino === right.ino; + +const normalizationCategory = (originalPath, canonicalPath) => { + if (originalPath === canonicalPath) return 'unchanged'; + if (originalPath.toUpperCase() === canonicalPath.toUpperCase()) return 'case-normalization'; + if (originalPath.split(/[\\/]/u).some(component => /~\d/u.test(component))) { + return 'short-name-expansion'; + } + if (originalPath.replaceAll('/', '\\').toUpperCase() === canonicalPath.toUpperCase()) { + return 'separator-normalization'; + } + return 'filesystem-path-normalization'; +}; + +const readEntry = (entryPath, phase) => { + try { + return lstatSync(entryPath, { bigint: true }); + } catch { + canonicalizationFailure(phase, 'entry-inspection-failed'); + } +}; + +export const canonicalizeWindowsFixtureEntry = ({ entryKind, entryPath, powershellPath }) => { + if ((entryKind !== 'directory' && entryKind !== 'file') || typeof entryPath !== 'string') { + canonicalizationFailure('input', 'invalid-entry'); + } + if (typeof powershellPath !== 'string' || powershellPath.length === 0) { + canonicalizationFailure('powershell-path', 'invalid-executable'); + } + + const before = readEntry(entryPath, 'original-before'); + if (!entryTypeMatches(before, entryKind)) canonicalizationFailure('original-before', 'type-mismatch'); + + const result = spawnSync(powershellPath, [ + '-NoLogo', '-NoProfile', '-NonInteractive', + '-EncodedCommand', encodedWindowsFixtureCanonicalPath, + ], { + shell: false, + windowsHide: true, + timeout: 10_000, + maxBuffer: WINDOWS_FIXTURE_PROCESS_MAX_BYTES, + env: { + ...process.env, + PROPR_FIXTURE_CANONICAL_PATH: entryPath, + }, + }); + if (result.error || result.signal) canonicalizationFailure('powershell-invocation', 'process-failed'); + if (!Buffer.isBuffer(result.stderr) || result.stderr.length !== 0) { + canonicalizationFailure('powershell-invocation', 'powershell-stderr'); + } + const failurePhase = new Map([ + [60, 'rooted-path'], + [61, 'full-path'], + [62, 'bounded-result'], + [63, 'result-write'], + ]).get(result.status); + if (failurePhase) canonicalizationFailure(failurePhase, 'operation-failed'); + if (result.status !== 0) canonicalizationFailure('powershell-invocation', 'unexpected-exit'); + if (!Buffer.isBuffer(result.stdout) + || result.stdout.length === 0 + || result.stdout.length > WINDOWS_FIXTURE_PATH_MAX_BYTES) { + canonicalizationFailure('result-validation', 'invalid-size'); + } + + let canonicalPath; + try { + canonicalPath = new TextDecoder('utf-8', { fatal: true }).decode(result.stdout); + } catch { + canonicalizationFailure('result-validation', 'invalid-encoding'); + } + if (canonicalPath.includes('\0') || canonicalPath.includes('\r') || canonicalPath.includes('\n')) { + canonicalizationFailure('result-validation', 'invalid-framing'); + } + if (!win32.isAbsolute(canonicalPath)) canonicalizationFailure('result-validation', 'unrooted-path'); + + const canonical = readEntry(canonicalPath, 'canonical-entry'); + const after = readEntry(entryPath, 'original-after'); + if (!entryTypeMatches(canonical, entryKind) || !entryTypeMatches(after, entryKind)) { + canonicalizationFailure('identity-proof', 'type-mismatch'); + } + if (!sameEntryIdentity(before, canonical) || !sameEntryIdentity(before, after)) { + canonicalizationFailure('identity-proof', 'identity-mismatch'); + } + + return { + path: canonicalPath, + normalization: normalizationCategory(entryPath, canonicalPath), + }; +}; diff --git a/apps/desktop/scripts/windows-fixture-acl.test.mjs b/apps/desktop/scripts/windows-fixture-acl.test.mjs new file mode 100644 index 000000000..c46767bc2 --- /dev/null +++ b/apps/desktop/scripts/windows-fixture-acl.test.mjs @@ -0,0 +1,334 @@ +import assert from 'node:assert/strict'; +import { spawnSync } from 'node:child_process'; +import { mkdirSync, mkdtempSync, realpathSync, rmSync, writeFileSync } from 'node:fs'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import { it } from 'node:test'; +import { + canonicalizeWindowsFixtureEntry, + encodedWindowsFixtureAcl, + windowsFixtureAclSource, + windowsPowerShell51Path, +} from './windows-fixture-acl.mjs'; + +const windowsIt = process.platform === 'win32' ? it : it.skip; + +const ownerClassifierSource = String.raw` +function Get-ProprOwnerCategoryToken { + param( + [Parameter(Mandatory=$true)][Security.Principal.SecurityIdentifier]$Owner, + [Parameter(Mandatory=$true)][Security.Principal.SecurityIdentifier]$Current + ) + if($Owner.Value -eq $Current.Value){return 1} + if($Owner.Value -eq 'S-1-5-32-544'){return 2} + if($Owner.Value -eq 'S-1-5-18'){return 3} + return 0 +}`; + +const exactDaclProofSource = String.raw` +$ErrorActionPreference='Stop' +$ProgressPreference='SilentlyContinue' +${ownerClassifierSource} +try { + $entryKind=$env:PROPR_FIXTURE_ACL_KIND + $entryPath=$env:PROPR_FIXTURE_ACL_PATH + $proofKind=$env:PROPR_FIXTURE_ACL_PROOF + $expectedOwnerCategory=$env:PROPR_FIXTURE_ACL_OWNER_CATEGORY + if(($entryKind -ne 'directory' -and $entryKind -ne 'file') -or + ($proofKind -ne 'owner' -and $proofKind -ne 'exact') -or + [String]::IsNullOrEmpty($entryPath)){exit 70} + if($proofKind -eq 'owner' -and -not [String]::IsNullOrEmpty($expectedOwnerCategory)){exit 70} + if($proofKind -eq 'exact' -and + $expectedOwnerCategory -ne 'current-user' -and + $expectedOwnerCategory -ne 'administrators' -and + $expectedOwnerCategory -ne 'system'){exit 70} +} catch { exit 70 } +try { + $sections=[System.Security.AccessControl.AccessControlSections]::Access -bor [System.Security.AccessControl.AccessControlSections]::Owner + $acl=if($entryKind -eq 'directory'){ + [System.IO.Directory]::GetAccessControl($entryPath,$sections) + }else{[System.IO.File]::GetAccessControl($entryPath,$sections)} +} catch { exit 71 } +try { + $current=[Security.Principal.WindowsIdentity]::GetCurrent().User + $owner=$acl.GetOwner([Security.Principal.SecurityIdentifier]) + if($null -eq $current -or $null -eq $owner){exit 72} + $ownerCategoryToken=Get-ProprOwnerCategoryToken -Owner $owner -Current $current +} catch { exit 72 } +if($ownerCategoryToken -eq 0){exit 78} +if($proofKind -eq 'owner'){ + if($ownerCategoryToken -eq 1){exit 75} + if($ownerCategoryToken -eq 2){exit 76} + if($ownerCategoryToken -eq 3){exit 77} + exit 72 +} +try { + $expectedOwnerCategoryToken=if($expectedOwnerCategory -eq 'current-user'){1} + elseif($expectedOwnerCategory -eq 'administrators'){2} + elseif($expectedOwnerCategory -eq 'system'){3} + else{exit 70} + if($ownerCategoryToken -ne $expectedOwnerCategoryToken){exit 79} +} catch { exit 72 } +try { + $rules=@($acl.GetAccessRules($true,$true,[Security.Principal.SecurityIdentifier])) + if(-not $acl.AreAccessRulesProtected -or -not $acl.AreAccessRulesCanonical -or + $rules.Count -ne 3 -or @($rules | Where-Object {$_.IsInherited}).Count -ne 0){exit 73} +} catch { exit 73 } +try { + $expectedSids=@($current.Value,'S-1-5-18','S-1-5-32-544') + $expectedInheritance=if($entryKind -eq 'directory'){ + [Security.AccessControl.InheritanceFlags]::ContainerInherit -bor [Security.AccessControl.InheritanceFlags]::ObjectInherit + }else{[Security.AccessControl.InheritanceFlags]::None} + foreach($sid in $expectedSids){ + $matches=@($rules | Where-Object {$_.IdentityReference.Value -eq $sid}) + if($matches.Count -ne 1){exit 74} + $rule=$matches[0] + if($rule.AccessControlType -ne [Security.AccessControl.AccessControlType]::Allow -or + $rule.FileSystemRights -ne [Security.AccessControl.FileSystemRights]::FullControl -or + $rule.InheritanceFlags -ne $expectedInheritance -or + $rule.PropagationFlags -ne [Security.AccessControl.PropagationFlags]::None -or + $rule.IsInherited){exit 74} + } +} catch { exit 74 } +`; + +const encodedExactDaclProof = Buffer.from(exactDaclProofSource, 'utf16le').toString('base64'); + +const ownerClassifierRegressionSource = String.raw` +$ErrorActionPreference='Stop' +$ProgressPreference='SilentlyContinue' +${ownerClassifierSource} +try { + $current=[Security.Principal.WindowsIdentity]::GetCurrent().User + $admins=[Security.Principal.SecurityIdentifier]::new('S-1-5-32-544') + $system=[Security.Principal.SecurityIdentifier]::new('S-1-5-18') + $unknown=[Security.Principal.SecurityIdentifier]::new('S-1-0-0') + if($null -eq $current -or + (Get-ProprOwnerCategoryToken -Owner $current -Current $current) -ne 1 -or + (Get-ProprOwnerCategoryToken -Owner $admins -Current $current) -ne 2 -or + (Get-ProprOwnerCategoryToken -Owner $system -Current $current) -ne 3){exit 80} + $unknownOwnerCategoryToken=Get-ProprOwnerCategoryToken -Owner $unknown -Current $current +} catch { exit 82 } +if($unknownOwnerCategoryToken -eq 0){exit 78} +exit 81 +`; + +const encodedOwnerClassifierRegression = Buffer.from( + ownerClassifierRegressionSource, + 'utf16le', +).toString('base64'); + +const baselineOwnerCategories = new Map([ + [75, 'current-user'], + [76, 'administrators'], + [77, 'system'], +]); + +const assertPowerShellStreamEmpty = (stream, category) => { + if (!Buffer.isBuffer(stream) || stream.length !== 0) { + const error = new Error(`Windows fixture ACL helper stream contract failed [category=${category}]`); + error.stack = error.message; + throw error; + } +}; + +const runAclProof = (powershell, entry, proofKind, ownerCategory = '') => spawnSync( + powershell, + [ + '-NoLogo', '-NoProfile', '-NonInteractive', '-EncodedCommand', encodedExactDaclProof, + ], + { + shell: false, + windowsHide: true, + timeout: 30_000, + env: { + ...process.env, + PROPR_FIXTURE_ACL_KIND: entry.kind, + PROPR_FIXTURE_ACL_PATH: entry.path, + PROPR_FIXTURE_ACL_PROOF: proofKind, + PROPR_FIXTURE_ACL_OWNER_CATEGORY: ownerCategory, + }, + }, +); + +const proofFailureCategory = status => new Map([ + [70, 'input'], + [71, 'access-control-read'], + [72, 'owner-lookup'], + [73, 'protection'], + [74, 'rules'], + [78, 'owner-not-allowlisted'], + [79, 'owner-category-mismatch'], +]).get(status) ?? 'unexpected-exit'; + +const assertProofProcess = result => { + assert.ifError(result.error); + assert.equal(result.signal, null); + assertPowerShellStreamEmpty(result.stdout, 'dacl-proof-stdout'); + assertPowerShellStreamEmpty(result.stderr, 'dacl-proof-stderr'); +}; + +const classifyBaselineOwner = (powershell, entry) => { + const result = runAclProof(powershell, entry, 'owner'); + assertProofProcess(result); + const ownerCategory = baselineOwnerCategories.get(result.status); + assert.ok( + ownerCategory, + `${entry.kind} owner ACL proof failed [category=${proofFailureCategory(result.status)}]`, + ); + return ownerCategory; +}; + +const assertExactAcl = (powershell, entry, ownerCategory) => { + const result = runAclProof(powershell, entry, 'exact', ownerCategory); + assertProofProcess(result); + assert.equal( + result.status, + 0, + `${entry.kind} exact ACL proof failed [category=${proofFailureCategory(result.status)}]`, + ); +}; + +const assertOwnerCategoryMismatch = (powershell, entry, ownerCategory) => { + const mismatchedCategory = ownerCategory === 'current-user' ? 'administrators' : 'current-user'; + const result = runAclProof(powershell, entry, 'exact', mismatchedCategory); + assertProofProcess(result); + assert.equal(result.status, 79, `${entry.kind} accepted a mismatched owner category`); +}; + +windowsIt('keeps the encoded Windows PowerShell 5.1 ACL helper fail-closed and byte-empty', t => { + const powershell = windowsPowerShell51Path(); + const version = spawnSync(powershell, [ + '-NoLogo', '-NoProfile', '-NonInteractive', '-Command', + '[Console]::Out.Write($PSVersionTable.PSVersion.ToString(2))', + ], { shell: false, windowsHide: true, encoding: 'utf8', timeout: 10_000 }); + assert.ifError(version.error); + assert.equal(version.status, 0); + assert.equal(version.stdout, '5.1'); + assert.equal(version.stderr, ''); + + assert.match( + windowsFixtureAclSource, + /AccessControlSections\]::Access\s*\r?\n/u, + 'production mutation must request the access-control section', + ); + assert.doesNotMatch( + windowsFixtureAclSource, + /AccessControlSections\]::Owner|\.SetOwner\s*\(/u, + 'production mutation must not request or set owner', + ); + + const classifierRegression = spawnSync(powershell, [ + '-NoLogo', '-NoProfile', '-NonInteractive', + '-EncodedCommand', encodedOwnerClassifierRegression, + ], { shell: false, windowsHide: true, timeout: 10_000 }); + assertProofProcess(classifierRegression); + const classifierCategory = new Map([ + [78, 'unknown-owner'], + [80, 'allowlisted-owner'], + [81, 'unknown-owner-accepted'], + [82, 'owner-lookup'], + ]).get(classifierRegression.status) ?? 'unexpected-exit'; + assert.equal( + classifierRegression.status, + 78, + `owner classifier regression failed [category=${classifierCategory}]`, + ); + + const temporaryDirectoryAlias = tmpdir(); + const canonicalTemporaryDirectory = realpathSync(temporaryDirectoryAlias); + const fixture = mkdtempSync(join(canonicalTemporaryDirectory, 'propr-fixture-acl-output-')); + const directory = join(fixture, 'data'); + const file = join(directory, 'identity.json'); + mkdirSync(directory); + writeFileSync(file, '{}\n'); + + try { + const canonicalDirectory = canonicalizeWindowsFixtureEntry({ + entryKind: 'directory', entryPath: directory, powershellPath: powershell, + }); + const canonicalFile = canonicalizeWindowsFixtureEntry({ + entryKind: 'file', entryPath: file, powershellPath: powershell, + }); + const canonicalizedEntries = [ + [directory, canonicalDirectory], + [file, canonicalFile], + ]; + const normalizationCategories = new Set(); + for (const [originalPath, entry] of canonicalizedEntries) { + if (entry.path.toUpperCase() !== originalPath.toUpperCase()) { + normalizationCategories.add(entry.normalization); + } + } + for (const category of [...normalizationCategories].sort()) { + t.diagnostic(`PS5.1 path normalization category=${category}`); + } + + const entriesWithBaselineOwner = [ + { kind: 'directory', path: canonicalDirectory.path }, + { kind: 'file', path: canonicalFile.path }, + ].map(entry => ({ ...entry, ownerCategory: classifyBaselineOwner(powershell, entry) })); + + const entries = [ + { label: 'relative path', kind: 'directory', path: 'data', status: 40 }, + { label: 'mismatched directory kind', kind: 'file', path: canonicalDirectory.path, status: 41 }, + { label: 'mismatched file kind', kind: 'directory', path: canonicalFile.path, status: 41 }, + // A server-only UNC is rooted, but PS5.1/.NET Framework rejects it because + // a valid UNC must also name a share. This reaches GetFullPath (phase 48). + { label: 'invalid full path', kind: 'file', path: '\\\\propr-invalid-unc\\', status: 48 }, + { label: 'canonical traversal alias', kind: 'directory', path: `${canonicalDirectory.path}\\..\\data`, status: 49 }, + { label: 'empty path', kind: 'directory', path: '', status: 50 }, + { label: 'invalid entry kind', kind: 'invalid', path: canonicalFile.path, status: 50 }, + { label: 'directory success', kind: 'directory', path: canonicalDirectory.path, status: 0 }, + { label: 'file success', kind: 'file', path: canonicalFile.path, status: 0 }, + ]; + + // Node realpath can retain a spelling that PS5.1 further canonicalizes. + // Keep that spelling uncanonicalized and prove the helper rejects it. + if (canonicalDirectory.path.toUpperCase() !== directory.toUpperCase()) { + entries.unshift( + { + label: 'precanonical directory spelling', + kind: 'directory', + path: directory, + status: 49, + }, + { + label: 'precanonical file spelling', + kind: 'file', + path: file, + status: 49, + }, + ); + } + + for (const entry of entries) { + const result = spawnSync(powershell, [ + '-NoLogo', '-NoProfile', '-NonInteractive', '-EncodedCommand', encodedWindowsFixtureAcl, + ], { + shell: false, + windowsHide: true, + timeout: 30_000, + env: { + ...process.env, + PROPR_FIXTURE_ACL_KIND: entry.kind, + PROPR_FIXTURE_ACL_PATH: entry.path, + }, + }); + + assert.ifError(result.error); + assert.equal(result.signal, null); + assertPowerShellStreamEmpty(result.stdout, 'powershell-stdout'); + assertPowerShellStreamEmpty(result.stderr, 'powershell-stderr'); + assert.equal(result.status, entry.status, `${entry.label} returned the wrong redacted phase code`); + if (entry.status === 0) { + const baseline = entriesWithBaselineOwner.find(candidate => candidate.kind === entry.kind); + assert.ok(baseline, `missing ${entry.kind} baseline owner category`); + assertExactAcl(powershell, entry, baseline.ownerCategory); + assertOwnerCategoryMismatch(powershell, entry, baseline.ownerCategory); + } + } + } finally { + rmSync(fixture, { recursive: true, force: true }); + } +}); diff --git a/apps/desktop/scripts/windows-packaged-connect-staging.mjs b/apps/desktop/scripts/windows-packaged-connect-staging.mjs new file mode 100644 index 000000000..87430d408 --- /dev/null +++ b/apps/desktop/scripts/windows-packaged-connect-staging.mjs @@ -0,0 +1,387 @@ +import { spawnSync } from 'node:child_process'; +import { open } from 'node:fs/promises'; +import { win32 } from 'node:path'; +import { + canonicalizeWindowsFixtureEntry, + windowsPowerShell51Path, +} from './windows-fixture-acl.mjs'; + +export const WINDOWS_ARTIFACT_FAILURE_CATEGORIES = Object.freeze([ + 'artifact-missing', + 'artifact-inaccessible', + 'artifact-type', + 'architecture-mismatch', + 'spawn-failed', +]); + +export const WINDOWS_ARTIFACT_FAILURE_PHASES = Object.freeze([ + 'staged-contract', + 'staged-tree', + 'staged-architecture', + 'ordinary-user-preflight', + 'fixture-setup', + 'package-authority', + 'application-spawn', + 'application-runtime', + 'result-verify', +]); + +export const WINDOWS_STAGED_CONTRACT_FAILURE_SUBPHASES = Object.freeze([ + 'runner-temp-input-shape', + 'staging-parent-input-shape', + 'parent-to-runner-binding', + 'fixed-parent-leaf', + 'generated-stage-leaf', + 'derived-root-to-parent-binding', +]); + +export const WINDOWS_ORDINARY_USER_PREFLIGHT_FAILURE_SUBPHASES = Object.freeze([ + 'preflight-invocation', + 'descendant-enumeration', + 'executable-read', + 'unexpected-exit', + 'authority-contract', +]); + +export const WINDOWS_ARTIFACT_FAILURE_SUBPHASES = Object.freeze([ + ...WINDOWS_STAGED_CONTRACT_FAILURE_SUBPHASES, + ...WINDOWS_ORDINARY_USER_PREFLIGHT_FAILURE_SUBPHASES, +]); + +const STAGING_PARENT_LEAF = 'propr-connect-packaged-stage'; +const STAGING_LEAF_PATTERN = /^propr-connect-package-[a-f0-9]{32}$/u; +const EXPECTED_MACHINES = Object.freeze({ x64: 0x8664, arm64: 0xaa64 }); +const MAX_CONTRACT_PATH_LENGTH = 4096; +const MAX_HANDOFF_LENGTH = 16_384; +const STAGED_CONTRACT_HANDOFF_PREFIX = '--propr-windows-staged-contract='; +const PE_HEADER_BYTES = 4096; + +const isAllowedSubphase = (phase, subphase) => ( + (phase === 'staged-contract' + && WINDOWS_STAGED_CONTRACT_FAILURE_SUBPHASES.includes(subphase)) + || (phase === 'ordinary-user-preflight' + && WINDOWS_ORDINARY_USER_PREFLIGHT_FAILURE_SUBPHASES.includes(subphase)) +); + +export const packagedConnectArtifactSensitiveNeedles = ({ + platform, + artifactRoot, + binaryPath, + stagedContract, + stagedHandoff, +}) => platform === 'win32' ? [ + artifactRoot, + binaryPath, + stagedContract.runnerTemp, + stagedContract.parent, + stagedContract.leaf, + stagedHandoff, +] : []; + +export class WindowsArtifactFailure extends Error { + constructor(category, phase = 'application-runtime', subphase) { + const fixedCategory = WINDOWS_ARTIFACT_FAILURE_CATEGORIES.includes(category) + ? category : 'artifact-inaccessible'; + const fixedPhase = WINDOWS_ARTIFACT_FAILURE_PHASES.includes(phase) + ? phase : 'application-runtime'; + const fixedSubphase = isAllowedSubphase(fixedPhase, subphase) + ? subphase : undefined; + super(`Packaged Connect Windows artifact failed [category=${fixedCategory} phase=${fixedPhase}` + + `${fixedSubphase ? ` subphase=${fixedSubphase}` : ''}]`); + this.name = 'WindowsArtifactFailure'; + this.category = fixedCategory; + this.phase = fixedPhase; + this.subphase = fixedSubphase; + this.stack = this.message; + } +} + +const fail = (category, phase, subphase) => { + throw new WindowsArtifactFailure(category, phase, subphase); +}; + +const isCanonicalAbsoluteWindowsPath = value => ( + typeof value === 'string' + && value.length > 3 + && value.length <= MAX_CONTRACT_PATH_LENGTH + && !value.includes('\0') + && !value.includes('\r') + && !value.includes('\n') + && !value.includes('/') + && /^[A-Za-z]:\\/u.test(value) + && win32.isAbsolute(value) + && win32.normalize(value) === value + && !value.endsWith('\\') +); + +export const parseWindowsStagedPackageContract = environment => { + const runnerTemp = environment?.RUNNER_TEMP; + const parent = environment?.PROPR_DESKTOP_CONNECT_STAGING_PARENT; + const leaf = environment?.PROPR_DESKTOP_CONNECT_STAGING_LEAF; + if (!isCanonicalAbsoluteWindowsPath(runnerTemp)) { + fail('artifact-type', 'staged-contract', 'runner-temp-input-shape'); + } + if (!isCanonicalAbsoluteWindowsPath(parent)) { + fail('artifact-type', 'staged-contract', 'staging-parent-input-shape'); + } + if (win32.dirname(parent) !== runnerTemp) { + fail('artifact-type', 'staged-contract', 'parent-to-runner-binding'); + } + if (win32.basename(parent) !== STAGING_PARENT_LEAF) { + fail('artifact-type', 'staged-contract', 'fixed-parent-leaf'); + } + if (!STAGING_LEAF_PATTERN.test(leaf ?? '')) { + fail('artifact-type', 'staged-contract', 'generated-stage-leaf'); + } + const root = win32.join(parent, leaf); + if (win32.dirname(root) !== parent || win32.basename(root) !== leaf) { + fail('artifact-type', 'staged-contract', 'derived-root-to-parent-binding'); + } + return Object.freeze({ + runnerTemp, + parent, + leaf, + root, + executable: win32.join(root, 'propr-desktop.exe'), + resources: win32.join(root, 'resources'), + applicationArchive: win32.join(root, 'resources', 'app.asar'), + }); +}; + +export const parseWindowsStagedPackageHandoff = arguments_ => { + if (!Array.isArray(arguments_) || arguments_.length !== 1 + || typeof arguments_[0] !== 'string' + || !arguments_[0].startsWith(STAGED_CONTRACT_HANDOFF_PREFIX)) { + fail('artifact-type', 'staged-contract', 'runner-temp-input-shape'); + } + const encoded = arguments_[0].slice(STAGED_CONTRACT_HANDOFF_PREFIX.length); + if (encoded.length < 4 || encoded.length > MAX_HANDOFF_LENGTH + || encoded.length % 4 !== 0 + || !/^[A-Za-z0-9+/]+={0,2}$/u.test(encoded)) { + fail('artifact-type', 'staged-contract', 'runner-temp-input-shape'); + } + const bytes = Buffer.from(encoded, 'base64'); + if (bytes.toString('base64') !== encoded) { + fail('artifact-type', 'staged-contract', 'runner-temp-input-shape'); + } + const decoded = bytes.toString('utf8'); + if (!Buffer.from(decoded, 'utf8').equals(bytes)) { + fail('artifact-type', 'staged-contract', 'runner-temp-input-shape'); + } + const fields = decoded.split('\n'); + if (fields.length !== 3) { + fail('artifact-type', 'staged-contract', 'runner-temp-input-shape'); + } + return parseWindowsStagedPackageContract({ + RUNNER_TEMP: fields[0], + PROPR_DESKTOP_CONNECT_STAGING_PARENT: fields[1], + PROPR_DESKTOP_CONNECT_STAGING_LEAF: fields[2], + }); +}; + +export const assertPackagedWindowsPeArchitecture = (bytes, expectedArchitecture) => { + if (!Buffer.isBuffer(bytes) || !Object.hasOwn(EXPECTED_MACHINES, expectedArchitecture)) { + fail('architecture-mismatch', 'staged-architecture'); + } + if (bytes.length < 0x40 || bytes.toString('ascii', 0, 2) !== 'MZ') { + fail('artifact-type', 'staged-architecture'); + } + const peOffset = bytes.readUInt32LE(0x3c); + if (peOffset < 0x40 + || peOffset + 6 > bytes.length + || bytes.toString('ascii', peOffset, peOffset + 4) !== 'PE\0\0') { + fail('artifact-type', 'staged-architecture'); + } + if (bytes.readUInt16LE(peOffset + 4) !== EXPECTED_MACHINES[expectedArchitecture]) { + fail('architecture-mismatch', 'staged-architecture'); + } +}; + +const readPeHeader = async path => { + let handle; + try { + handle = await open(path, 'r'); + const bytes = Buffer.alloc(PE_HEADER_BYTES); + const { bytesRead } = await handle.read(bytes, 0, bytes.length, 0); + return bytes.subarray(0, bytesRead); + } catch (error) { + if (error?.code === 'ENOENT') fail('artifact-missing', 'staged-architecture'); + fail('artifact-inaccessible', 'staged-architecture'); + } finally { + await handle?.close().catch(() => {}); + } +}; + +const windowsStagedPackagePreflightSource = String.raw` +$ErrorActionPreference='Stop' +$ProgressPreference='SilentlyContinue' +try { + $parent=$env:PROPR_DESKTOP_CONNECT_STAGING_PARENT + $leaf=$env:PROPR_DESKTOP_CONNECT_STAGING_LEAF + if([String]::IsNullOrEmpty($parent) -or [String]::IsNullOrEmpty($leaf)){exit 80} + $root=[IO.Path]::Combine($parent,$leaf) + $executable=[IO.Path]::Combine($root,'propr-desktop.exe') + $resources=[IO.Path]::Combine($root,'resources') + $archive=[IO.Path]::Combine($resources,'app.asar') + $current=[Security.Principal.WindowsIdentity]::GetCurrent().User + $principal=[Security.Principal.WindowsPrincipal]::new([Security.Principal.WindowsIdentity]::GetCurrent()) + if($null -eq $current -or $principal.IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)){exit 81} + $system=[Security.Principal.SecurityIdentifier]::new('S-1-5-18') + $admins=[Security.Principal.SecurityIdentifier]::new('S-1-5-32-544') +} catch { exit 80 } +try { + $entries=@( + @{Path=$parent;Directory=$true}, + @{Path=$root;Directory=$true}, + @{Path=$resources;Directory=$true}, + @{Path=$archive;Directory=$false}, + @{Path=$executable;Directory=$false} + ) + $descendants=@(Get-ChildItem -LiteralPath $root -Force -Recurse -ErrorAction Stop) + if($descendants.Count -lt 1 -or $descendants.Count -gt 20000){exit 82} + foreach($item in $descendants){$entries+=@{Path=$item.FullName;Directory=$item.PSIsContainer}} +} catch { exit 83 } +try { + foreach($entry in $entries){ + $item=Get-Item -LiteralPath $entry.Path -Force -ErrorAction Stop + if($item.PSIsContainer -ne $entry.Directory -or + ($item.Attributes -band [IO.FileAttributes]::ReparsePoint) -ne 0 -or + -not [String]::Equals($item.FullName,$entry.Path,[StringComparison]::OrdinalIgnoreCase)){exit 82} + $sections=[Security.AccessControl.AccessControlSections]::Access -bor [Security.AccessControl.AccessControlSections]::Owner + $acl=if($entry.Directory){[IO.Directory]::GetAccessControl($entry.Path,$sections)}else{[IO.File]::GetAccessControl($entry.Path,$sections)} + $owner=$acl.GetOwner([Security.Principal.SecurityIdentifier]) + $rules=@($acl.GetAccessRules($true,$true,[Security.Principal.SecurityIdentifier])) + if($owner.Value -ne $admins.Value -or -not $acl.AreAccessRulesProtected -or + -not $acl.AreAccessRulesCanonical -or $rules.Count -ne 3){exit 84} + foreach($identity in @($current,$system,$admins)){ + $matches=@($rules | Where-Object {$_.IdentityReference.Value -eq $identity.Value}) + if($matches.Count -ne 1 -or $matches[0].AccessControlType -ne [Security.AccessControl.AccessControlType]::Allow){exit 84} + $expected=if($identity.Value -eq $current.Value){[Security.AccessControl.FileSystemRights]::ReadAndExecute -bor [Security.AccessControl.FileSystemRights]::Synchronize}else{[Security.AccessControl.FileSystemRights]::FullControl} + $expectedInheritance=if($entry.Directory){[Security.AccessControl.InheritanceFlags]::ContainerInherit -bor [Security.AccessControl.InheritanceFlags]::ObjectInherit}else{[Security.AccessControl.InheritanceFlags]::None} + if($matches[0].FileSystemRights -ne $expected -or $matches[0].InheritanceFlags -ne $expectedInheritance -or + $matches[0].PropagationFlags -ne [Security.AccessControl.PropagationFlags]::None -or $matches[0].IsInherited){exit 84} + } + } +} catch { exit 84 } +try { + $stream=[IO.FileStream]::new($executable,[IO.FileMode]::Open,[IO.FileAccess]::Read,[IO.FileShare]::Read) + try { if($stream.ReadByte() -lt 0){exit 85} } finally { $stream.Dispose() } +} catch { exit 85 } +`; + +const encodedWindowsStagedPackagePreflight = Buffer.from( + windowsStagedPackagePreflightSource, + 'utf16le', +).toString('base64'); + +export const assertWindowsStagedPackagePreflightResult = result => { + if (result?.error || result?.signal || !Buffer.isBuffer(result?.stdout) + || result.stdout.length !== 0 || !Buffer.isBuffer(result?.stderr) + || result.stderr.length !== 0) { + fail('artifact-inaccessible', 'ordinary-user-preflight', 'preflight-invocation'); + } + if (result.status === 0) return; + if (result.status === 83) { + fail('artifact-inaccessible', 'ordinary-user-preflight', 'descendant-enumeration'); + } + if (result.status === 85) { + fail('artifact-inaccessible', 'ordinary-user-preflight', 'executable-read'); + } + if ([80, 81, 82, 84].includes(result.status)) { + fail('artifact-type', 'ordinary-user-preflight', 'authority-contract'); + } + fail('artifact-inaccessible', 'ordinary-user-preflight', 'unexpected-exit'); +}; + +const runWindowsStagedPackagePreflight = paths => { + const powershell = windowsPowerShell51Path(); + const result = spawnSync(powershell, [ + '-NoLogo', '-NoProfile', '-NonInteractive', '-EncodedCommand', encodedWindowsStagedPackagePreflight, + ], { + shell: false, + windowsHide: true, + timeout: 60_000, + maxBuffer: 1024, + env: { + SystemRoot: process.env.SystemRoot, + PROPR_DESKTOP_CONNECT_STAGING_PARENT: paths.parent, + PROPR_DESKTOP_CONNECT_STAGING_LEAF: paths.leaf, + }, + }); + assertWindowsStagedPackagePreflightResult(result); +}; + +const canonicalizeEntry = async (kind, path) => canonicalizeWindowsFixtureEntry({ + entryKind: kind, + entryPath: path, + powershellPath: windowsPowerShell51Path(), +}); + +export const validateWindowsStagedPackage = async ({ + environment = process.env, + expectedArchitecture = process.arch, + inspectPath, + canonicalize = canonicalizeEntry, + readHeader = readPeHeader, + preflight = runWindowsStagedPackagePreflight, +} = {}) => { + const paths = parseWindowsStagedPackageContract(environment); + const inspect = inspectPath ?? (await import('node:fs/promises')).lstat; + const entries = [ + ['directory', paths.runnerTemp], + ['directory', paths.parent], + ['directory', paths.root], + ['directory', paths.resources], + ['file', paths.applicationArchive], + ['file', paths.executable], + ]; + for (const [kind, path] of entries) { + let stats; + try { stats = await inspect(path); } catch (error) { + if (error?.code === 'ENOENT') fail('artifact-missing', 'staged-tree'); + fail('artifact-inaccessible', 'staged-tree'); + } + if (stats.isSymbolicLink() + || (kind === 'directory' ? !stats.isDirectory() : !stats.isFile())) { + fail('artifact-type', 'staged-tree'); + } + let canonical; + try { canonical = await canonicalize(kind, path); } catch { fail('artifact-type', 'staged-tree'); } + if (!canonical || typeof canonical.path !== 'string' + || canonical.path.toUpperCase() !== path.toUpperCase()) fail('artifact-type', 'staged-tree'); + } + assertPackagedWindowsPeArchitecture(await readHeader(paths.executable), expectedArchitecture); + try { await preflight(paths); } catch (error) { + if (error instanceof WindowsArtifactFailure) throw error; + fail('artifact-inaccessible', 'ordinary-user-preflight', 'preflight-invocation'); + } + return paths; +}; + +export const classifyWindowsArtifactFailure = error => { + if (error instanceof WindowsArtifactFailure + && WINDOWS_ARTIFACT_FAILURE_CATEGORIES.includes(error.category)) return error.category; + if (error?.code === 'ENOENT') return 'artifact-missing'; + if (error?.code === 'EACCES' || error?.code === 'EPERM') return 'artifact-inaccessible'; + return 'spawn-failed'; +}; + +export const describeWindowsArtifactFailure = (error, fallbackPhase = 'application-runtime') => { + const phase = error instanceof WindowsArtifactFailure + && WINDOWS_ARTIFACT_FAILURE_PHASES.includes(error.phase) + ? error.phase + : (WINDOWS_ARTIFACT_FAILURE_PHASES.includes(fallbackPhase) + ? fallbackPhase : 'application-runtime'); + const preSpawn = !['application-spawn', 'application-runtime', 'result-verify'].includes(phase); + const category = error instanceof WindowsArtifactFailure + ? classifyWindowsArtifactFailure(error) + : (preSpawn ? (error?.code === 'ENOENT' ? 'artifact-missing' : 'artifact-inaccessible') + : classifyWindowsArtifactFailure(error)); + const fixedErrorSubphase = error instanceof WindowsArtifactFailure + && isAllowedSubphase(phase, error.subphase) + ? error.subphase : undefined; + const subphase = phase === 'ordinary-user-preflight' + ? (fixedErrorSubphase ?? 'preflight-invocation') + : fixedErrorSubphase; + return Object.freeze({ category, phase, ...(subphase ? { subphase } : {}) }); +}; diff --git a/apps/desktop/scripts/windows-packaged-connect-staging.test.mjs b/apps/desktop/scripts/windows-packaged-connect-staging.test.mjs new file mode 100644 index 000000000..9baa63f5b --- /dev/null +++ b/apps/desktop/scripts/windows-packaged-connect-staging.test.mjs @@ -0,0 +1,1883 @@ +import assert from 'node:assert/strict'; +import { spawn, spawnSync } from 'node:child_process'; +import { randomBytes } from 'node:crypto'; +import { link, lstat, mkdir, mkdtemp, readFile, realpath, rm, symlink, writeFile } from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { join, win32 } from 'node:path'; +import { describe, test } from 'node:test'; +import { fileURLToPath } from 'node:url'; +import { + assertPackagedWindowsPeArchitecture, + assertWindowsStagedPackagePreflightResult, + classifyWindowsArtifactFailure, + describeWindowsArtifactFailure, + packagedConnectArtifactSensitiveNeedles, + parseWindowsStagedPackageContract, + parseWindowsStagedPackageHandoff, + validateWindowsStagedPackage, + WINDOWS_ARTIFACT_FAILURE_CATEGORIES, + WINDOWS_ARTIFACT_FAILURE_PHASES, + WINDOWS_ARTIFACT_FAILURE_SUBPHASES, + WINDOWS_ORDINARY_USER_PREFLIGHT_FAILURE_SUBPHASES, + WINDOWS_STAGED_CONTRACT_FAILURE_SUBPHASES, + WindowsArtifactFailure, +} from './windows-packaged-connect-staging.mjs'; +import { windowsPowerShell51Path } from './windows-fixture-acl.mjs'; + +const windowsTest = process.platform === 'win32' ? test : test.skip; +const orchestratorPath = fileURLToPath(new URL('./run-packaged-windows-connect-smoke.ps1', import.meta.url)); +const taskkillPath = String.raw`C:\Windows\System32\taskkill.exe`; +const hostPreflightSubphases = Object.freeze([ + 'host-node-command-cardinality', + 'host-node-command-type', + 'host-node-source', + 'host-node-path-binding', + 'host-node-launcher-return-authority', + 'host-capture-contract', + 'host-staging-handoff', +]); +const launcherAuthoritySubphases = Object.freeze([ + 'host-launcher-native-initialization', + 'host-launcher-selected-path-input', + 'host-launcher-selected-path-extra-colon', + 'host-launcher-selected-path-get-full-path', + 'host-launcher-selected-path-absolute-shape', + 'host-launcher-selected-path-canonical-equality', + 'host-launcher-source-open', + 'host-launcher-source-type', + 'host-launcher-source-identity', + 'host-launcher-source-final-path', + 'host-launcher-final-open', + 'host-launcher-final-type', + 'host-launcher-final-identity', + 'host-launcher-final-path', + 'host-launcher-final-match', + 'host-launcher-source-reopen', + 'host-launcher-source-reopen-type', + 'host-launcher-source-reopen-identity', + 'host-launcher-source-reopen-final-path', + 'host-launcher-source-reopen-match', +]); +const fixedHostDiagnosticSubphases = Object.freeze([ + ...hostPreflightSubphases, + ...launcherAuthoritySubphases, +]); +const launcherInvocationSubphases = Object.freeze([ + 'host-node-path-binding', + ...launcherAuthoritySubphases, +]); +const positiveHostNodeProducerSubphases = Object.freeze([ + 'host-node-command-cardinality', + 'host-node-command-type', + 'host-node-source', +]); +const captureRedirectionFailurePredicates = Object.freeze([ + 'pre-create', + 'redirect-open', + 'redirect-timeout', + 'redirect-child-exit', + 'post-redirection-identity', + 'capture-owner', + 'dacl-canonicality', + 'unauthorized-writer', + 'link-path-type', + 'identity-replacement', + 'capture-content', + 'cleanup', +]); +const captureRedirectionReportedPredicates = Object.freeze([ + ...captureRedirectionFailurePredicates, + 'diagnostic-contract', +]); +const captureProducerExitBuckets = Object.freeze(['zero', 'forced-23', 'other']); +const captureProducerOutputStates = Object.freeze(['exact-expected', 'empty', 'other-bounded']); +const captureRedirectionResultPredicates = Object.freeze([ + 'redirect-child-exit', + 'capture-content', +]); +const captureRedirectionDiagnosticPattern = new RegExp( + '^PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=capture-parse:subphase=capture-authority' + + ':predicate=([a-z-]+):cleanup=none\\r?\\n$', + 'u', +); +const captureRedirectionResultDiagnosticPattern = new RegExp( + '^PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=capture-parse:subphase=capture-authority' + + ':predicate=([a-z-]+):exit=([a-z0-9-]+)' + + ':out=([a-z-]+):err=([a-z-]+):cleanup=none\\r?\\n$', + 'u', +); +const captureRedirectionAcceptedPattern = + /^PROPR_WINDOWS_PACKAGED_CONNECT_CAPTURE_REDIRECTION_TEST:accepted\r?\n$/u; +const hostileDiagnosticPattern = /[A-Z]:\\|\\\\|S-1-5-|account-name|username|stdout|stderr|exception|native-text|command-line|sddl|exit-code|environment-secret/iu; +const uppercasePathDiagnosticPattern = /\bPATH\b/u; +const hasHostileDiagnosticEvidence = value => hostileDiagnosticPattern.test(value) + || uppercasePathDiagnosticPattern.test(value); +const assertNoHostileDiagnosticEvidence = value => { + assert.doesNotMatch(value, hostileDiagnosticPattern); + assert.doesNotMatch(value, uppercasePathDiagnosticPattern); +}; + +const parent = String.raw`C:\runner-temp\propr-connect-packaged-stage`; +const leaf = 'propr-connect-package-0123456789abcdef0123456789abcdef'; +const environment = { + RUNNER_TEMP: String.raw`C:\runner-temp`, + PROPR_DESKTOP_CONNECT_STAGING_PARENT: parent, + PROPR_DESKTOP_CONNECT_STAGING_LEAF: leaf, +}; +const handoffFor = ({ + RUNNER_TEMP = environment.RUNNER_TEMP, + PROPR_DESKTOP_CONNECT_STAGING_PARENT = environment.PROPR_DESKTOP_CONNECT_STAGING_PARENT, + PROPR_DESKTOP_CONNECT_STAGING_LEAF = environment.PROPR_DESKTOP_CONNECT_STAGING_LEAF, +} = {}) => '--propr-windows-staged-contract=' + Buffer.from([ + RUNNER_TEMP, + PROPR_DESKTOP_CONNECT_STAGING_PARENT, + PROPR_DESKTOP_CONNECT_STAGING_LEAF, +].join('\n'), 'utf8').toString('base64'); +const regularFile = { + isDirectory: () => false, + isFile: () => true, + isSymbolicLink: () => false, +}; +const regularDirectory = { + isDirectory: () => true, + isFile: () => false, + isSymbolicLink: () => false, +}; + +const peFixture = architecture => { + const bytes = Buffer.alloc(256); + bytes.write('MZ', 0, 'ascii'); + bytes.writeUInt32LE(0x80, 0x3c); + bytes.write('PE\0\0', 0x80, 'ascii'); + bytes.writeUInt16LE(architecture === 'arm64' ? 0xaa64 : 0x8664, 0x84); + return bytes; +}; + +const processExists = processId => { + try { + process.kill(processId, 0); + return true; + } catch (error) { + if (error?.code === 'ESRCH') return false; + throw error; + } +}; + +const waitForProcessExit = async (processId, timeoutMilliseconds = 5_000) => { + const deadline = Date.now() + timeoutMilliseconds; + while (processExists(processId) && Date.now() < deadline) { + await new Promise(resolve => setTimeout(resolve, 25)); + } + return !processExists(processId); +}; + +const startNativeNodeTree = async () => { + const rootSource = String.raw` +const { spawn } = require('node:child_process'); +const descendant = spawn(process.execPath, ['-e', 'setInterval(() => {}, 1000)'], { + shell: false, + windowsHide: true, + stdio: 'ignore', +}); +process.stdout.write(String(descendant.pid) + '\n'); +setInterval(() => {}, 1000); +`; + const root = spawn(process.execPath, ['-e', rootSource], { + shell: false, + windowsHide: true, + stdio: ['ignore', 'pipe', 'ignore'], + }); + const descendantProcessId = await new Promise((resolve, reject) => { + let output = ''; + const timeout = setTimeout(() => reject(new Error('native process tree did not start')), 5_000); + root.once('error', error => { + clearTimeout(timeout); + reject(error); + }); + root.stdout.on('data', chunk => { + output += chunk.toString('ascii'); + const newline = output.indexOf('\n'); + if (newline < 0) return; + clearTimeout(timeout); + const value = output.slice(0, newline).trim(); + if (!/^[1-9][0-9]{0,9}$/u.test(value)) reject(new Error('native descendant pid was invalid')); + else resolve(Number(value)); + }); + }); + return { root, descendantProcessId }; +}; + +const terminateTreeAfterTest = processId => { + if (!Number.isSafeInteger(processId) || processId < 1 || !processExists(processId)) return; + spawnSync(taskkillPath, ['/PID', String(processId), '/T', '/F'], { + shell: false, + windowsHide: true, + stdio: 'ignore', + timeout: 5_000, + }); +}; + +const runLauncherAuthorityTest = (path, testCase = 'normal', retargetPath) => { + const arguments_ = [ + '-NoLogo', + '-NoProfile', + '-NonInteractive', + '-File', + orchestratorPath, + '-Architecture', + process.arch, + '-LifecycleTestMode', + 'launcher-authority', + '-LauncherAuthorityTestCase', + testCase, + '-LauncherAuthorityTestPath', + path, + ]; + if (retargetPath !== undefined) { + arguments_.push('-LauncherAuthorityTestRetargetPath', retargetPath); + } + return spawnSync(windowsPowerShell51Path(), arguments_, { + shell: false, + windowsHide: true, + timeout: 15_000, + }); +}; + +const runHostNodeProducerTest = testCase => spawnSync(windowsPowerShell51Path(), [ + '-NoLogo', + '-NoProfile', + '-NonInteractive', + '-File', + orchestratorPath, + '-Architecture', + process.arch, + '-LifecycleTestMode', + 'host-node-producer', + '-HostNodeProducerTestCase', + testCase, +], { + shell: false, + windowsHide: true, + timeout: 10_000, +}); + +const runCaptureParserTest = ( + path, + authorityCase = 'existing', + environmentOverrides = {}, +) => spawnSync(windowsPowerShell51Path(), [ + '-NoLogo', '-NoProfile', '-NonInteractive', '-File', orchestratorPath, + '-Architecture', process.arch, + '-LifecycleTestMode', 'capture-parser', + '-CaptureParserTestPath', path, + '-CaptureParserAuthorityTestCase', authorityCase, +], { + shell: false, + windowsHide: true, + timeout: 10_000, + env: { ...process.env, ...environmentOverrides }, +}); + +const runCaptureRedirectionTest = (producerTestCase = 'success') => spawnSync(windowsPowerShell51Path(), [ + '-NoLogo', '-NoProfile', '-NonInteractive', '-File', orchestratorPath, + '-Architecture', process.arch, + '-LifecycleTestMode', 'capture-redirection', + '-CaptureRedirectionProducerTestCase', producerTestCase, +], { + shell: false, + windowsHide: true, + timeout: 45_000, +}); + +const failCaptureRedirectionTest = result => { + let evidence = 'predicate=diagnostic-contract'; + if (!result.error && result.signal === null && result.status === 1 + && Buffer.isBuffer(result.stdout) && result.stdout.length === 0 + && Buffer.isBuffer(result.stderr) && result.stderr.length <= 256) { + const diagnostic = result.stderr.toString('utf8'); + const resultMatch = captureRedirectionResultDiagnosticPattern.exec(diagnostic); + const predicateMatch = captureRedirectionDiagnosticPattern.exec(diagnostic); + if (resultMatch + && captureRedirectionResultPredicates.includes(resultMatch[1]) + && captureProducerExitBuckets.includes(resultMatch[2]) + && captureProducerOutputStates.includes(resultMatch[3]) + && captureProducerOutputStates.includes(resultMatch[4]) + && !hasHostileDiagnosticEvidence(diagnostic)) { + evidence = `predicate=${resultMatch[1]}:exit=${resultMatch[2]}` + + `:out=${resultMatch[3]}:err=${resultMatch[4]}`; + } else if (predicateMatch + && captureRedirectionFailurePredicates.includes(predicateMatch[1]) + && !captureRedirectionResultPredicates.includes(predicateMatch[1]) + && !hasHostileDiagnosticEvidence(diagnostic)) { + evidence = `predicate=${predicateMatch[1]}`; + } + } + assert.ok(captureRedirectionReportedPredicates.includes(evidence.slice('predicate='.length).split(':')[0])); + const error = new Error( + `PROPR_WINDOWS_PACKAGED_CONNECT_CAPTURE_REDIRECTION_TEST:failed:${evidence}`, + ); + error.stack = error.message; + throw error; +}; + +test('capture redirection mismatch reporting is total and redacted for each launch predicate', () => { + const resultFor = stderr => ({ + error: undefined, + signal: null, + status: 1, + stdout: Buffer.alloc(0), + stderr: Buffer.from(stderr), + }); + const assertDiagnosticContract = (result, label) => assert.throws( + () => failCaptureRedirectionTest(result), + error => error.message === 'PROPR_WINDOWS_PACKAGED_CONNECT_CAPTURE_REDIRECTION_TEST' + + ':failed:predicate=diagnostic-contract' + && error.stack === error.message + && !hasHostileDiagnosticEvidence(error.message), + label, + ); + for (const predicate of ['redirect-open', 'redirect-timeout']) { + const diagnostic = 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=capture-parse:subphase=capture-authority' + + `:predicate=${predicate}:cleanup=none\r\n`; + assert.throws( + () => failCaptureRedirectionTest(resultFor(diagnostic)), + error => error.message === 'PROPR_WINDOWS_PACKAGED_CONNECT_CAPTURE_REDIRECTION_TEST' + + `:failed:predicate=${predicate}` + && error.stack === error.message + && !hasHostileDiagnosticEvidence(error.message), + predicate, + ); + + assertDiagnosticContract(resultFor( + diagnostic + String.raw`C:\hostile\capture S-1-5-21 account-name username stdout stderr exception native-text command-line sddl exit-code environment-secret`, + ), `${predicate}-hostile-output`); + + assertDiagnosticContract({ + error: new Error(String.raw`C:\hostile\exception`), + signal: 'hostile-signal', + status: null, + stdout: Buffer.from('environment-secret'), + stderr: Buffer.from(diagnostic), + }, `${predicate}-totality`); + } + + for (const [predicate, exit, out, err] of [ + ['redirect-child-exit', 'zero', 'exact-expected', 'exact-expected'], + ['redirect-child-exit', 'forced-23', 'empty', 'other-bounded'], + ['capture-content', 'other', 'other-bounded', 'empty'], + ]) { + const diagnostic = 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=capture-parse:subphase=capture-authority' + + `:predicate=${predicate}:exit=${exit}:out=${out}:err=${err}:cleanup=none\r\n`; + assert.throws( + () => failCaptureRedirectionTest(resultFor(diagnostic)), + error => error.message === 'PROPR_WINDOWS_PACKAGED_CONNECT_CAPTURE_REDIRECTION_TEST' + + `:failed:predicate=${predicate}:exit=${exit}:out=${out}:err=${err}` + && error.stack === error.message + && !hasHostileDiagnosticEvidence(error.message), + `${predicate}-${exit}-${out}-${err}`, + ); + assertDiagnosticContract(resultFor( + diagnostic + String.raw`C:\hostile\capture S-1-5-21 environment-secret`, + ), `${predicate}-hostile-output`); + } + + for (const diagnostic of [ + 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=capture-parse:subphase=capture-authority' + + ':predicate=redirect-child-exit:cleanup=none\r\n', + 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=capture-parse:subphase=capture-authority' + + ':predicate=redirect-child-exit:exit=23:out=exact-expected:err=exact-expected' + + ':cleanup=none\r\n', + 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=capture-parse:subphase=capture-authority' + + ':predicate=redirect-child-exit:exit=other:out=raw-value:err=empty' + + ':cleanup=none\r\n', + ]) assertDiagnosticContract(resultFor(diagnostic), 'result-attribution-totality'); +}); + +const assertLauncherAuthorityRejected = (result, category, subphase) => { + const expected = `PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=${category}` + + `:phase=ordinary-user-preflight:subphase=${subphase}:cleanup=none`; + const diagnostic = Buffer.isBuffer(result.stderr) + && result.stderr.length <= 512 ? result.stderr.toString('utf8').trim() : ''; + if (result.error || result.signal !== null || result.status !== 1 + || !Buffer.isBuffer(result.stdout) || result.stdout.length !== 0 + || diagnostic !== expected || hasHostileDiagnosticEvidence(diagnostic)) { + const error = new Error( + `PROPR_WINDOWS_PACKAGED_CONNECT_LAUNCHER_AUTHORITY_TEST:rejection-diagnostic-failed` + + `:category=${category}:phase=ordinary-user-preflight:subphase=${subphase}`, + ); + error.stack = error.message; + throw error; + } +}; + +const failAcceptedLauncherCase = (caseName, result) => { + const fallback = 'category=artifact-inaccessible:phase=ordinary-user-preflight:subphase=host-state-contract'; + let evidence = fallback; + if (!result.error && result.signal === null && result.status === 1 + && Buffer.isBuffer(result.stdout) && result.stdout.length === 0 + && Buffer.isBuffer(result.stderr) && result.stderr.length <= 512) { + const diagnostic = result.stderr.toString('utf8').trim(); + const match = /^PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=(artifact-missing|artifact-inaccessible|artifact-type|architecture-mismatch|spawn-failed):phase=(ordinary-user-preflight):subphase=([a-z-]+):cleanup=none$/u.exec(diagnostic); + if (match && launcherInvocationSubphases.includes(match[3]) + && !hasHostileDiagnosticEvidence(diagnostic)) { + evidence = `category=${match[1]}:phase=${match[2]}:subphase=${match[3]}`; + } + } + const error = new Error( + `PROPR_WINDOWS_PACKAGED_CONNECT_LAUNCHER_AUTHORITY_TEST:accepted-case-failed:case=${caseName}:${evidence}`, + ); + error.stack = error.message; + throw error; +}; + +const assertLauncherAuthorityAccepted = (result, caseName) => { + if (result.error || result.signal !== null || result.status !== 0 + || !Buffer.isBuffer(result.stdout) || !Buffer.isBuffer(result.stderr) + || result.stdout.toString('utf8').trim() + !== 'PROPR_WINDOWS_PACKAGED_CONNECT_LAUNCHER_AUTHORITY_TEST:accepted' + || result.stderr.length !== 0) { + failAcceptedLauncherCase(caseName, result); + } +}; + +const failPositiveHostNodeProducer = result => { + const fallback = 'category=artifact-inaccessible:phase=ordinary-user-preflight' + + ':subphase=host-node-command-cardinality'; + let evidence = fallback; + if (!result.error && result.signal === null && result.status === 1 + && Buffer.isBuffer(result.stdout) && result.stdout.length === 0 + && Buffer.isBuffer(result.stderr) && result.stderr.length <= 512) { + const diagnostic = result.stderr.toString('utf8').trim(); + const match = /^PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=(artifact-inaccessible|artifact-type):phase=(ordinary-user-preflight):subphase=([a-z-]+):cleanup=none$/u.exec(diagnostic); + if (match && positiveHostNodeProducerSubphases.includes(match[3]) + && !hasHostileDiagnosticEvidence(diagnostic)) { + evidence = `category=${match[1]}:phase=${match[2]}:subphase=${match[3]}`; + } + } + const error = new Error( + `PROPR_WINDOWS_PACKAGED_CONNECT_HOST_NODE_PRODUCER_TEST:positive-case-failed:${evidence}`, + ); + error.stack = error.message; + throw error; +}; + +const assertPositiveHostNodeProducer = result => { + if (result.error || result.signal !== null || result.status !== 0 + || !Buffer.isBuffer(result.stdout) || !Buffer.isBuffer(result.stderr) + || result.stdout.toString('utf8').trim() + !== 'PROPR_WINDOWS_PACKAGED_CONNECT_HOST_NODE_PRODUCER_TEST:accepted' + || result.stderr.length !== 0) { + failPositiveHostNodeProducer(result); + } +}; + +test('positive host Node producer failures expose only fixed allowlisted evidence', () => { + for (const category of ['artifact-inaccessible', 'artifact-type']) { + for (const subphase of positiveHostNodeProducerSubphases) { + const result = { + error: undefined, + signal: null, + status: 1, + stdout: Buffer.alloc(0), + stderr: Buffer.from( + `PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=${category}` + + `:phase=ordinary-user-preflight:subphase=${subphase}:cleanup=none`, + ), + }; + assert.throws( + () => failPositiveHostNodeProducer(result), + { + message: 'PROPR_WINDOWS_PACKAGED_CONNECT_HOST_NODE_PRODUCER_TEST' + + `:positive-case-failed:category=${category}` + + `:phase=ordinary-user-preflight:subphase=${subphase}`, + }, + ); + } + } + + const fallback = 'PROPR_WINDOWS_PACKAGED_CONNECT_HOST_NODE_PRODUCER_TEST' + + ':positive-case-failed:category=artifact-inaccessible' + + ':phase=ordinary-user-preflight:subphase=host-node-command-cardinality'; + for (const stderr of [ + 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=spawn-failed' + + ':phase=ordinary-user-preflight:subphase=host-node-source:cleanup=none', + 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=application-spawn:subphase=host-node-source:cleanup=none', + 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=ordinary-user-preflight:subphase=host-node-path-binding:cleanup=none', + String.raw`C:\hostile\node.exe \\hostile PATH account-name S-1-5-21 stdout stderr exception native-text environment-secret`, + ]) { + assert.throws( + () => failPositiveHostNodeProducer({ + error: undefined, + signal: null, + status: 1, + stdout: Buffer.alloc(0), + stderr: Buffer.from(stderr), + }), + { message: fallback }, + ); + } + assertNoHostileDiagnosticEvidence(fallback); +}); + +test('hostile diagnostics reject uppercase PATH without matching fixed path subphases', () => { + assert.equal( + hasHostileDiagnosticEvidence( + 'category=artifact-type:phase=ordinary-user-preflight:subphase=host-node-path-binding', + ), + false, + ); + assert.equal(hasHostileDiagnosticEvidence('PATH'), true); +}); + +const validationOptions = overrides => ({ + environment, + expectedArchitecture: 'arm64', + inspectPath: async path => path.endsWith('.exe') || path.endsWith('.asar') + ? regularFile + : regularDirectory, + canonicalize: async (kind, path) => ({ path }), + readHeader: async () => peFixture('arm64'), + preflight: async () => {}, + ...overrides, +}); + +describe('packaged Windows Connect staging contract', () => { + test('accepts only the exact generated leaf below the fixed canonical staging parent', () => { + const contract = parseWindowsStagedPackageContract(environment); + assert.equal(contract.parent, parent); + assert.equal(contract.root, win32.join(parent, leaf)); + assert.equal(contract.executable, win32.join(parent, leaf, 'propr-desktop.exe')); + + for (const [invalid, subphase] of [ + [{}, 'runner-temp-input-shape'], + [{ PROPR_DESKTOP_CONNECT_STAGED_ROOT: contract.root }, 'runner-temp-input-shape'], + [{ ...environment, RUNNER_TEMP: 'runner-temp' }, 'runner-temp-input-shape'], + [{ ...environment, PROPR_DESKTOP_CONNECT_STAGING_PARENT: `${parent}\\` }, 'staging-parent-input-shape'], + [{ ...environment, PROPR_DESKTOP_CONNECT_STAGING_PARENT: String.raw`\\server\share\propr-connect-packaged-stage` }, 'staging-parent-input-shape'], + [{ ...environment, PROPR_DESKTOP_CONNECT_STAGING_PARENT: String.raw`C:\runner-temp\x\propr-connect-packaged-stage` }, 'parent-to-runner-binding'], + [{ ...environment, PROPR_DESKTOP_CONNECT_STAGING_PARENT: String.raw`C:\runner-temp\other` }, 'fixed-parent-leaf'], + [{ ...environment, PROPR_DESKTOP_CONNECT_STAGING_LEAF: '../package' }, 'generated-stage-leaf'], + [{ ...environment, PROPR_DESKTOP_CONNECT_STAGING_LEAF: 'propr-connect-package-ABCDEF0123456789abcdef0123456789' }, 'generated-stage-leaf'], + [{ ...environment, PROPR_DESKTOP_CONNECT_STAGING_LEAF: 'propr-connect-package-0123' }, 'generated-stage-leaf'], + ]) { + assert.throws( + () => parseWindowsStagedPackageContract(invalid), + error => error instanceof WindowsArtifactFailure + && error.category === 'artifact-type' + && error.phase === 'staged-contract' + && error.subphase === subphase, + ); + } + }); + + test('accepts one bounded parent-owned handoff and rejects every other input shape', () => { + const contract = parseWindowsStagedPackageHandoff([handoffFor()]); + assert.equal(contract.runnerTemp, environment.RUNNER_TEMP); + assert.equal(contract.parent, parent); + assert.equal(contract.leaf, leaf); + for (const arguments_ of [ + [], + [handoffFor(), handoffFor()], + ['--propr-windows-staged-contract=not-base64'], + ['--different-contract=AAAA'], + [`--propr-windows-staged-contract=${'A'.repeat(16_388)}`], + ['--propr-windows-staged-contract=' + Buffer.from('one\ntwo', 'utf8').toString('base64')], + ]) { + assert.throws( + () => parseWindowsStagedPackageHandoff(arguments_), + error => error instanceof WindowsArtifactFailure + && error.category === 'artifact-type' + && error.phase === 'staged-contract' + && error.subphase === 'runner-temp-input-shape', + ); + } + }); + + test('emits only fixed staged-contract predicate evidence', () => { + const diagnostics = WINDOWS_STAGED_CONTRACT_FAILURE_SUBPHASES.map(subphase => { + const failure = new WindowsArtifactFailure('artifact-type', 'staged-contract', subphase); + return JSON.stringify({ + event: 'packaged_connect.artifact_failed', + ...describeWindowsArtifactFailure(failure, 'application-spawn'), + }); + }); + assert.deepEqual(diagnostics, WINDOWS_STAGED_CONTRACT_FAILURE_SUBPHASES.map(subphase => ( + `{"event":"packaged_connect.artifact_failed","category":"artifact-type",` + + `"phase":"staged-contract","subphase":"${subphase}"}` + ))); + assertNoHostileDiagnosticEvidence(diagnostics.join('\n')); + + const hostileSubphase = new WindowsArtifactFailure( + 'artifact-type', + 'staged-contract', + String.raw`C:\secret\account-name-S-1-5-21-123`, + ); + assert.equal(hostileSubphase.subphase, undefined); + assert.deepEqual(describeWindowsArtifactFailure(hostileSubphase, 'staged-contract'), { + category: 'artifact-type', + phase: 'staged-contract', + }); + assertNoHostileDiagnosticEvidence(hostileSubphase.message); + }); + + test('rejects missing, inaccessible, reparse, wrong-type, and noncanonical entries before preflight', async () => { + let preflightCalls = 0; + const assertCategory = async (inspectPath, canonicalize, category) => { + await assert.rejects( + validateWindowsStagedPackage(validationOptions({ + inspectPath, + canonicalize: canonicalize ?? (async (kind, path) => ({ path })), + preflight: async () => { preflightCalls += 1; }, + })), + error => error instanceof WindowsArtifactFailure && error.category === category, + ); + }; + await assertCategory(async () => { const error = new Error('sensitive path'); error.code = 'ENOENT'; throw error; }, null, 'artifact-missing'); + await assertCategory(async () => { const error = new Error('sensitive path'); error.code = 'EACCES'; throw error; }, null, 'artifact-inaccessible'); + await assertCategory(async () => ({ ...regularDirectory, isSymbolicLink: () => true }), null, 'artifact-type'); + await assertCategory(async () => regularFile, null, 'artifact-type'); + await assertCategory( + async path => path.endsWith('.exe') || path.endsWith('.asar') ? regularFile : regularDirectory, + async (kind, path) => ({ path: `${path}-alias` }), + 'artifact-type', + ); + assert.equal(preflightCalls, 0, 'a rejected package must fail before the access preflight'); + }); + + test('proves target PE architecture and ordinary-user access before returning the executable', async () => { + let preflightCalls = 0; + const result = await validateWindowsStagedPackage(validationOptions({ + preflight: async paths => { + preflightCalls += 1; + assert.equal(paths.executable, win32.join(parent, leaf, 'propr-desktop.exe')); + }, + })); + assert.equal(result.root, win32.join(parent, leaf)); + assert.equal(preflightCalls, 1); + + await assert.rejects( + validateWindowsStagedPackage(validationOptions({ readHeader: async () => peFixture('x64') })), + error => error instanceof WindowsArtifactFailure && error.category === 'architecture-mismatch', + ); + }); + + test('maps a hostile preflight callback throw totally and redacts all supplied evidence', async () => { + const hostile = new Error( + String.raw`hostile exception C:\secret\package S-1-5-21-123 account-name raw stdout raw stderr environment-secret`, + ); + hostile.stdout = 'raw stdout'; + hostile.stderr = 'raw stderr'; + hostile.environment = { SECRET: 'environment-secret' }; + await assert.rejects( + validateWindowsStagedPackage(validationOptions({ + preflight: async () => { throw hostile; }, + })), + error => { + assert.ok(error instanceof WindowsArtifactFailure); + assert.equal(error.category, 'artifact-inaccessible'); + assert.equal(error.phase, 'ordinary-user-preflight'); + assert.equal(error.subphase, 'preflight-invocation'); + const diagnostic = JSON.stringify({ + event: 'packaged_connect.artifact_failed', + ...describeWindowsArtifactFailure(error, 'ordinary-user-preflight'), + }); + assert.equal( + diagnostic, + '{"event":"packaged_connect.artifact_failed","category":"artifact-inaccessible","phase":"ordinary-user-preflight","subphase":"preflight-invocation"}', + ); + assertNoHostileDiagnosticEvidence(`${error.message}\n${diagnostic}`); + return true; + }, + ); + }); + + test('keeps PE type and architecture failures distinct', () => { + assert.doesNotThrow(() => assertPackagedWindowsPeArchitecture(peFixture('arm64'), 'arm64')); + assert.throws( + () => assertPackagedWindowsPeArchitecture(Buffer.from('not a PE'), 'arm64'), + error => error.category === 'artifact-type', + ); + assert.throws( + () => assertPackagedWindowsPeArchitecture(peFixture('x64'), 'arm64'), + error => error.category === 'architecture-mismatch', + ); + }); + + test('maps hostile exceptions to a fixed path-free allowlist', () => { + assert.deepEqual(WINDOWS_ARTIFACT_FAILURE_CATEGORIES, [ + 'artifact-missing', + 'artifact-inaccessible', + 'artifact-type', + 'architecture-mismatch', + 'spawn-failed', + ]); + const hostile = new Error(String.raw`spawn C:\secret\propr-desktop.exe ENOENT --token=secret`); + hostile.code = 'ENOENT'; + assert.equal(classifyWindowsArtifactFailure(hostile), 'artifact-missing'); + assert.equal(classifyWindowsArtifactFailure(new Error('username SID environment stack')), 'spawn-failed'); + for (const category of WINDOWS_ARTIFACT_FAILURE_CATEGORIES) { + const failure = new WindowsArtifactFailure(category, 'staged-tree'); + assert.equal(classifyWindowsArtifactFailure(failure), category); + assert.doesNotMatch(failure.message, /[A-Z]:\\|S-1-5-|--|username|environment|stack/iu); + } + const invalidSubphase = new WindowsArtifactFailure( + 'artifact-inaccessible', + 'ordinary-user-preflight', + String.raw`C:\secret\account-name-S-1-5-21-123`, + ); + assert.equal(invalidSubphase.subphase, undefined); + assert.doesNotMatch(invalidSubphase.message, /[A-Z]:\\|S-1-5-|account-name/iu); + }); + + test('classifies fixed phases without collapsing pre-spawn failures into spawn', () => { + assert.deepEqual(WINDOWS_ARTIFACT_FAILURE_PHASES, [ + 'staged-contract', + 'staged-tree', + 'staged-architecture', + 'ordinary-user-preflight', + 'fixture-setup', + 'package-authority', + 'application-spawn', + 'application-runtime', + 'result-verify', + ]); + assert.deepEqual(WINDOWS_STAGED_CONTRACT_FAILURE_SUBPHASES, [ + 'runner-temp-input-shape', + 'staging-parent-input-shape', + 'parent-to-runner-binding', + 'fixed-parent-leaf', + 'generated-stage-leaf', + 'derived-root-to-parent-binding', + ]); + assert.deepEqual( + describeWindowsArtifactFailure(new Error(String.raw`C:\secret\account`), 'fixture-setup'), + { category: 'artifact-inaccessible', phase: 'fixture-setup' }, + ); + assert.deepEqual( + describeWindowsArtifactFailure( + new WindowsArtifactFailure( + 'artifact-type', + 'ordinary-user-preflight', + 'authority-contract', + ), + 'application-spawn', + ), + { + category: 'artifact-type', + phase: 'ordinary-user-preflight', + subphase: 'authority-contract', + }, + ); + assert.deepEqual( + describeWindowsArtifactFailure(new Error('--token secret'), 'application-spawn'), + { category: 'spawn-failed', phase: 'application-spawn' }, + ); + }); + + test('maps every preflight transport and exit result to fixed subphase evidence', () => { + assert.deepEqual(WINDOWS_ORDINARY_USER_PREFLIGHT_FAILURE_SUBPHASES, [ + 'preflight-invocation', + 'descendant-enumeration', + 'executable-read', + 'unexpected-exit', + 'authority-contract', + ]); + assert.deepEqual(WINDOWS_ARTIFACT_FAILURE_SUBPHASES, [ + ...WINDOWS_STAGED_CONTRACT_FAILURE_SUBPHASES, + ...WINDOWS_ORDINARY_USER_PREFLIGHT_FAILURE_SUBPHASES, + ]); + const clean = status => ({ + status, + error: undefined, + signal: null, + stdout: Buffer.alloc(0), + stderr: Buffer.alloc(0), + }); + assert.doesNotThrow(() => assertWindowsStagedPackagePreflightResult(clean(0))); + + for (const [status, category, subphase] of [ + [80, 'artifact-type', 'authority-contract'], + [81, 'artifact-type', 'authority-contract'], + [82, 'artifact-type', 'authority-contract'], + [83, 'artifact-inaccessible', 'descendant-enumeration'], + [84, 'artifact-type', 'authority-contract'], + [85, 'artifact-inaccessible', 'executable-read'], + [1, 'artifact-inaccessible', 'unexpected-exit'], + [86, 'artifact-inaccessible', 'unexpected-exit'], + [null, 'artifact-inaccessible', 'unexpected-exit'], + ]) { + assert.throws( + () => assertWindowsStagedPackagePreflightResult(clean(status)), + error => error instanceof WindowsArtifactFailure + && error.category === category + && error.phase === 'ordinary-user-preflight' + && error.subphase === subphase, + ); + } + + const invocationFailures = [ + { ...clean(null), error: new Error(String.raw`C:\secret\invoke.exe`) }, + { ...clean(null), signal: 'SIGTERM' }, + { ...clean(0), stdout: Buffer.from('raw stdout account-name') }, + { ...clean(0), stderr: Buffer.from('raw stderr S-1-5-21-123') }, + { ...clean(0), stdout: 'not-a-buffer' }, + { ...clean(0), stderr: 'not-a-buffer' }, + ]; + for (const result of invocationFailures) { + assert.throws( + () => assertWindowsStagedPackagePreflightResult(result), + error => error instanceof WindowsArtifactFailure + && error.category === 'artifact-inaccessible' + && error.phase === 'ordinary-user-preflight' + && error.subphase === 'preflight-invocation', + ); + } + }); + + test('preflight diagnostics exclude path, SID, account name, stdout, and stderr evidence', () => { + const clean = status => ({ + status, + error: undefined, + signal: null, + stdout: Buffer.alloc(0), + stderr: Buffer.alloc(0), + }); + const hostileResult = { + status: 85, + error: new Error(String.raw`C:\runner-temp\secret\propr-desktop.exe account-name S-1-5-21-123`), + signal: null, + stdout: Buffer.from('raw stdout account-name'), + stderr: Buffer.from(String.raw`raw stderr C:\secret S-1-5-21-123`), + }; + const diagnosticFor = result => { + try { + assertWindowsStagedPackagePreflightResult(result); + assert.fail('the preflight result must fail'); + } catch (error) { + return JSON.stringify({ + event: 'packaged_connect.artifact_failed', + ...describeWindowsArtifactFailure(error, 'ordinary-user-preflight'), + }); + } + }; + const diagnostics = [ + diagnosticFor(hostileResult), + diagnosticFor(clean(83)), + diagnosticFor(clean(85)), + diagnosticFor(clean(86)), + diagnosticFor(clean(84)), + ]; + assert.deepEqual( + diagnostics.map(diagnostic => JSON.parse(diagnostic).subphase), + [ + 'preflight-invocation', + 'descendant-enumeration', + 'executable-read', + 'unexpected-exit', + 'authority-contract', + ], + ); + assertNoHostileDiagnosticEvidence(diagnostics.join('\n')); + }); + + test('scopes staged-root and executable leak needles to Windows', () => { + const options = { + artifactRoot: String.raw`C:\runner-temp\stage\leaf`, + binaryPath: String.raw`C:\runner-temp\stage\leaf\propr-desktop.exe`, + stagedContract: { + runnerTemp: String.raw`C:\runner-temp`, + parent: String.raw`C:\runner-temp\stage`, + leaf: 'leaf', + }, + stagedHandoff: handoffFor(), + }; + assert.deepEqual(packagedConnectArtifactSensitiveNeedles({ platform: 'darwin', ...options }), []); + assert.deepEqual(packagedConnectArtifactSensitiveNeedles({ platform: 'linux', ...options }), []); + assert.deepEqual(packagedConnectArtifactSensitiveNeedles({ platform: 'win32', ...options }), [ + options.artifactRoot, + options.binaryPath, + options.stagedContract.runnerTemp, + options.stagedContract.parent, + options.stagedContract.leaf, + options.stagedHandoff, + ]); + }); +}); + +test('the workflow stages before alternate credentials and the harness preflights before application spawn', async () => { + const workflow = await readFile(new URL('../../../.github/workflows/desktop-connect-discovery-guard.yml', import.meta.url), 'utf8'); + const orchestrator = await readFile(new URL('./run-packaged-windows-connect-smoke.ps1', import.meta.url), 'utf8'); + const harness = await readFile(new URL('./smoke-packaged-connect.mjs', import.meta.url), 'utf8'); + const main = await readFile(new URL('../src/main.ts', import.meta.url), 'utf8'); + assert.match(workflow, /run-packaged-windows-connect-smoke\.ps1\s+-Architecture '\$\{\{ matrix\.arch \}\}'/u); + assert.doesNotMatch(workflow, /Start-Process|Get-Content|New-LocalUser/u); + + const copy = orchestrator.indexOf('Copy-Item -LiteralPath $entry.FullName'); + const acl = orchestrator.indexOf('Set-StagedEntryAcl $item'); + const alternateLaunch = orchestrator.indexOf('$process = Start-Process'); + const nativeAuthorityTests = workflow.indexOf( + 'node --test apps/desktop/scripts/windows-packaged-connect-staging.test.mjs', + ); + const packageStep = workflow.indexOf('npm run desktop:package'); + const packagedLaunch = workflow.indexOf('run-packaged-windows-connect-smoke.ps1'); + assert.ok(copy >= 0 && copy < acl && acl < alternateLaunch); + assert.ok(nativeAuthorityTests >= 0 + && nativeAuthorityTests < packageStep + && packageStep < packagedLaunch); + assert.doesNotMatch(orchestrator.slice(alternateLaunch, alternateLaunch + 700), /\s-Wait(?:\s|`)/u); + assert.match(orchestrator, /Assert-PeArchitecture \$sourceExecutable \$Architecture/u); + assert.match(orchestrator, /Assert-PeArchitecture \$stagedExecutable \$Architecture/u); + assert.match(orchestrator, /FileSystemRights\]::ReadAndExecute/u); + assert.match(orchestrator, /FileSystemRights\]::FullControl/u); + assert.match(orchestrator, /SetAccessRuleProtection\(\$true, \$false\)/u); + assert.match(orchestrator, /SetOwner\(\$Administrators\)/u); + assert.match(orchestrator, /\[Diagnostics\.Process\]::new\(\)/u); + assert.match(orchestrator, /\$taskkillExecutable = 'C:\\Windows\\System32\\taskkill\.exe'/u); + assert.match( + orchestrator, + /\$taskkillStart\.Arguments = \[String\]::Join\(' ', \[string\[\]\]@\('\/PID', \$processIdText, '\/T', '\/F'\)\)/u, + ); + assert.match(orchestrator, /\$taskkillStart\.UseShellExecute = \$false/u); + assert.match(orchestrator, /\$processIdText -cnotmatch '\^\[1-9\]\[0-9\]\{0,9\}\$'/u); + assert.match(orchestrator, /\$taskkillProcess\.WaitForExit\(\$terminationTimeoutMilliseconds\)/u); + assert.match(orchestrator, /Task\]::WaitAll\([\s\S]*?\$streamCloseTimeoutMilliseconds/u); + assert.doesNotMatch(orchestrator, /(?:cmd(?:\.exe)?|powershell(?:\.exe)?)['"]?\s+\/c[\s\S]*?taskkill/iu); + assert.match(orchestrator, /WaitForExit\(\$cleanupTimeoutMilliseconds\)/u); + assert.match(orchestrator, /if\(!\$cleanupProcess\.WaitForExit[\s\S]*?\$cleanupProcess\.Kill\(\)[\s\S]*?WaitForExit\(\$terminationTimeoutMilliseconds\)/u); + assert.match(orchestrator, /Remove-Item -LiteralPath \$root -Recurse/u); + assert.doesNotMatch(orchestrator, /Remove-Item -LiteralPath \$parent -Recurse/u); + assert.match(orchestrator, /\$createdAccount\.SID\.Value -cne \$testUserSid\.Value/u); + assert.match(orchestrator, /\$administratorsSid\.Translate\(\[Security\.Principal\.NTAccount\]\)/u); + assert.match(orchestrator, /\.psbase\.Invoke\('IsMember', \$ordinaryUserEntry\.Path\)/u); + assert.doesNotMatch(orchestrator, /Get-LocalGroupMember/u); + assert.doesNotMatch(orchestrator, /Get-Content|Write-(?:Host|Error|Verbose|Debug|Information)|GITHUB_WORKSPACE/u); + const hostNodeProducer = orchestrator.slice( + orchestrator.indexOf('function Get-ValidatedHostNodePath'), + orchestrator.indexOf('function Stop-SpawnedProcess'), + ); + const producerTransitions = [ + ['host-node-command-cardinality', 'Get-Command node.exe'], + ['host-node-command-type', '$candidate -is [System.Management.Automation.ApplicationInfo]'], + ['host-node-source', '@($candidate.Source)'], + ]; + for (let index = 0; index < producerTransitions.length; index += 1) { + const [subphase, operation] = producerTransitions[index]; + const transition = hostNodeProducer.indexOf(`Set-OrdinaryUserPreflightSubphase '${subphase}'`); + const operationIndex = hostNodeProducer.indexOf(operation); + const nextTransition = index + 1 < producerTransitions.length + ? hostNodeProducer.indexOf( + `Set-OrdinaryUserPreflightSubphase '${producerTransitions[index + 1][0]}'`, + ) + : hostNodeProducer.length; + assert.ok(transition >= 0 && transition < operationIndex && operationIndex < nextTransition, + `${subphase} must cover exactly its producer operation boundary`); + } + assert.match(hostNodeProducer, /Get-Command node\.exe[\s\S]*?-CommandType Application[\s\S]*?-TotalCount 1[\s\S]*?-ErrorAction Stop/u); + assert.match(hostNodeProducer, /\$commandResults\.Count -ne 1[\s\S]*?host-node-command-type[\s\S]*?\$candidate = \$commandResults\[0\][\s\S]*?System\.Management\.Automation\.ApplicationInfo/u); + assert.match(hostNodeProducer, /\$sourceResults\.Count -ne 1[\s\S]*?\$sourceResults\[0\] -is \[string\]/u); + assert.match(hostNodeProducer, /return \$sourceResults\[0\]/u); + assert.doesNotMatch(hostNodeProducer, /validatedSources|StringComparison|foreach \(\$candidate in \$commandResults\)/u); + assert.doesNotMatch(hostNodeProducer, /PSObject\.Properties\['Source'\]/u); + assert.doesNotMatch(hostNodeProducer, /\$env:PATH|Select-Object\s+-First|where(?:\.exe)?/iu); + assert.doesNotMatch(orchestrator, /\$node\s*=\s*['"]node(?:\.exe)?['"]/iu); + const hostBoundary = orchestrator.slice( + orchestrator.indexOf('$node = Get-ValidatedHostNodePath', orchestrator.indexOf("Set-FailurePhase 'staging-acl'")), + orchestrator.indexOf("Set-FailurePhase 'application-spawn'"), + ); + const hostTransitions = [ + ['host-node-path-binding', '$launcherAuthority = Get-TrustedHostLauncher -Path $node'], + ['host-node-launcher-return-authority', '$launcherAuthorityResults = @($launcherAuthority)'], + ['host-capture-contract', '$stdout = Join-Path $authenticatedRunnerTemp'], + ['host-staging-handoff', '$handoffText = [String]::Join'], + ]; + for (let index = 0; index < hostTransitions.length; index += 1) { + const [subphase, operation] = hostTransitions[index]; + const transition = hostBoundary.indexOf(`Set-OrdinaryUserPreflightSubphase '${subphase}'`); + const operationIndex = hostBoundary.indexOf(operation); + const nextTransition = index + 1 < hostTransitions.length + ? hostBoundary.indexOf(`Set-OrdinaryUserPreflightSubphase '${hostTransitions[index + 1][0]}'`) + : hostBoundary.length; + assert.ok(transition >= 0 && transition < operationIndex && operationIndex < nextTransition, + `${subphase} must cover exactly its host operation boundary`); + } + assert.match(orchestrator, /function Set-PrimaryFailureFromException[\s\S]*?\$script:primaryPhase = \$failurePhase[\s\S]*?\$script:primarySubphase = if \(\$failureSubphases -ccontains \$failureSubphase\)/u); + assert.match(orchestrator, /function Get-TrustedHostLauncher[\s\S]*?GetFinalPath\(\$sourceHandle\)[\s\S]*?Open\(\$finalPath, \$true\)[\s\S]*?GetIdentity\(\$authorityHandle\)[\s\S]*?Open\(\$selectedPath, \$false\)/u); + assert.doesNotMatch(hostBoundary, /Get-TrustedHostLauncher \$node/u); + assert.match(orchestrator, /\$node = \$launcherPathProperty\.Value[\s\S]*?-FilePath \$node/u); + assert.match(hostBoundary, /SafeFileHandle[\s\S]*?\.IsInvalid[\s\S]*?\.IsClosed/u); + assert.match(orchestrator, /Start-Process[\s\S]*?finally \{\s*\$launcherAuthority\.Handle\.Dispose\(\)/u); + assert.match(orchestrator, /\$handoffArgument = '--propr-windows-staged-contract=' \+ \[Convert\]::ToBase64String\(\$handoffBytes\)/u); + assert.match(orchestrator, /-ArgumentList @\('scripts\/smoke-packaged-connect\.mjs', \$handoffArgument\)[\s\S]*?-Credential \$credential[\s\S]*?-LoadUserProfile/u); + assert.doesNotMatch(orchestrator, /SetEnvironmentVariable\('PROPR_DESKTOP_CONNECT_STAGING_/u); + assert.match(orchestrator, /FILE_FLAG_OPEN_REPARSE_POINT/u); + assert.match( + orchestrator, + /\[DllImport\("kernel32\.dll", CharSet = CharSet\.Unicode, ExactSpelling = true, SetLastError = true\)\]\s*private static extern SafeFileHandle CreateFileW/u, + ); + assert.match( + orchestrator, + /\[DllImport\("kernel32\.dll", CharSet = CharSet\.Unicode, ExactSpelling = true, SetLastError = true\)\]\s*private static extern uint GetFinalPathNameByHandleW/u, + ); + assert.match(orchestrator, /FILE_ID_INFO[\s\S]*?GetFileInformationByHandleEx[\s\S]*?FileIdInfo = 18/u); + assert.match(orchestrator, /FILE_SHARE_READ\s*\n\s*: FILE_SHARE_READ \| FILE_SHARE_WRITE \| FILE_SHARE_DELETE/u); + assert.match(orchestrator, /\$Path\.Length -gt 259[\s\S]*?\[\\x00-\\x1f\\x7f\]/u); + const selectedPathValidation = orchestrator.slice( + orchestrator.indexOf('function Get-BoundedAbsoluteWindowsPath'), + orchestrator.indexOf('function ConvertFrom-NativeFinalPath'), + ); + const selectedPathPredicateTransitions = [ + ['host-launcher-selected-path-input', '[String]::IsNullOrEmpty($Path)'], + ['host-launcher-selected-path-extra-colon', "$Path.Substring(2).Contains(':')"], + ['host-launcher-selected-path-get-full-path', '$fullPath = [IO.Path]::GetFullPath($Path)'], + ['host-launcher-selected-path-absolute-shape', "$driveAbsolute = $fullPath -cmatch '^[A-Za-z]:\\\\'"], + ['host-launcher-selected-path-canonical-equality', '[String]::Equals($fullPath, $Path'], + ]; + let previousSelectedPathPredicate = -1; + for (const [subphase, predicate] of selectedPathPredicateTransitions) { + const transition = selectedPathValidation.indexOf( + `Set-OrdinaryUserPreflightSubphase '${subphase}'`, + ); + const predicateIndex = selectedPathValidation.indexOf(predicate); + assert.ok(previousSelectedPathPredicate < transition && transition < predicateIndex, + `${subphase} must identify only its selected-path predicate`); + previousSelectedPathPredicate = predicateIndex; + } + assert.match(orchestrator, /function Get-CanonicalItem[\s\S]*?FileAttributes\]::ReparsePoint/u); + assert.match(orchestrator, /function Assert-PackageTreeTypes[\s\S]*?FileAttributes\]::ReparsePoint/u); + const captureAuthority = orchestrator.slice( + orchestrator.indexOf('function Assert-CaptureAuthorityAcl'), + orchestrator.indexOf('function Read-PackagedConnectSmokeFailure'), + ); + const captureParser = orchestrator.slice( + orchestrator.indexOf('function Read-PackagedConnectSmokeFailure'), + orchestrator.indexOf('$hostLauncherNativeSource'), + ); + assert.match(captureParser, /packaged_connect\.artifact_failed/u); + assert.match(captureParser, /packaged_connect\.smoke_failed/u); + assert.doesNotMatch(captureParser, /packaged_connect\.child_failed/u); + const nestedDiagnosticEvents = captureParser.slice( + captureParser.indexOf('$diagnosticEvents = @('), + captureParser.indexOf('$diagnosticCodes = @('), + ); + assert.match(nestedDiagnosticEvents, /'desktop\.renderer\.connect_discovery\.proof'/u); + assert.equal( + (orchestrator.match(/desktop\.renderer\.connect_discovery\.proof/gu) ?? []).length, + 1, + ); + assert.match(captureParser, /Test-UniqueJsonPropertyNames \$jsonLine/u); + assert.match(captureParser, /\[Text\.UTF8Encoding\]::new\(\$false, \$true\)/u); + assert.match(captureAuthority, /\$captureLength -lt 1 -or \$captureLength -gt 65536/u); + assert.match(captureParser, /\$diagnosticRecords\.Count -gt 20/u); + assert.match(captureAuthority, /\$ownerValues -cnotcontains \$owner\.Value/u); + assert.match(captureAuthority, /\$acl\.AreAccessRulesProtected/u); + assert.match(captureAuthority, /\$acl\.AreAccessRulesCanonical/u); + assert.match(captureAuthority, /\$authorizedWriters\.Contains\(\$rule\.IdentityReference\.Value\)/u); + assert.match(captureAuthority, /function Initialize-PrivilegedCaptureFile/u); + assert.match(captureAuthority, /GetSecurityDescriptorSddlForm\(\$sections\)/u); + assert.match( + captureAuthority, + /SecurityDescriptor = \(Get-CaptureAuthorityDescriptor \$Path\)[\s\S]*?Get-CaptureAuthorityDescriptor \$Authority\.Path\) -cne \$Authority\.SecurityDescriptor/u, + ); + assert.match(captureAuthority, /SetAccessRuleProtection\(\$true, \$false\)/u); + assert.match(captureAuthority, /SetOwner\(\$CapturePrivilegedSid\)/u); + assert.match( + captureAuthority, + /foreach \(\$identity in @\(\$CapturePrivilegedSid, \$administratorsSid, \$systemSid\)\)/u, + ); + assert.match( + captureAuthority, + /\[IO\.FileStream\]::new\([\s\S]*?FileMode\]::CreateNew[\s\S]*?\$captureAcl/u, + ); + assert.doesNotMatch(captureAuthority, /S-1-1-0|S-1-5-11|S-1-5-32-545/u); + assert.match(captureAuthority, /GetLinkCount\(\$captureHandle\) -ne 1/u); + assert.match(captureAuthority, /GetIdentity\(\$captureHandle\)[\s\S]*?GetIdentity\(\$captureReopenHandle\)/u); + assert.match(captureAuthority, /ReadBounded\(\$captureReopenHandle, 65536\)/u); + assert.doesNotMatch(captureAuthority, /ReadAllBytes\(\$Path\)/u); + assert.match( + captureAuthority, + /\$privilegedSid\.Value, \$administratorsSid\.Value, 'S-1-5-18'[\s\S]*?-cnotcontains \$parentOwner\.Value[\s\S]*?\$TestOnlyExpectedParentOwnerSid[\s\S]*?\$parentOwner\.Value -cne \$TestOnlyExpectedParentOwnerSid\.Value/u, + ); + const topLevelParameters = orchestrator.slice(0, orchestrator.indexOf('$ErrorActionPreference')); + assert.doesNotMatch(topLevelParameters, /TestOnlyExpectedParentOwnerSid/u); + const captureParserTestMode = orchestrator.slice( + orchestrator.indexOf("if ($LifecycleTestMode -eq 'capture-parser')"), + orchestrator.indexOf("if ($LifecycleTestMode -eq 'diagnostic-subphase')"), + ); + assert.match( + captureParserTestMode, + /foreign-parent-owner'[\s\S]*?\$captureExpectedParentOwnerSid = \[Security\.Principal\.SecurityIdentifier\]::new\([\s\S]*?-TestOnlyExpectedParentOwnerSid \$captureExpectedParentOwnerSid/u, + ); + assert.doesNotMatch( + captureParserTestMode, + /\[IO\.Directory\]::SetAccessControl\(\$authenticatedRunnerTemp|\$parentAcl\.SetOwner/u, + ); + const captureReadOpen = orchestrator.slice( + orchestrator.indexOf('public static SafeFileHandle OpenCapture'), + orchestrator.indexOf('public static SafeFileHandle OpenRedirectCaptureAuthority'), + ); + assert.match( + captureReadOpen, + /lockAuthority\s*\? FILE_SHARE_READ\s*:\s*FILE_SHARE_READ \| FILE_SHARE_WRITE \| FILE_SHARE_DELETE/u, + ); + assert.match(captureReadOpen, /GENERIC_READ \| READ_CONTROL/u); + const redirectCaptureAuthorityOpen = orchestrator.slice( + orchestrator.indexOf('public static SafeFileHandle OpenRedirectCaptureAuthority'), + orchestrator.indexOf('public static string GetIdentity'), + ); + assert.match( + redirectCaptureAuthorityOpen, + /FILE_READ_ATTRIBUTES \| READ_CONTROL,[\s\S]*?FILE_SHARE_READ \| FILE_SHARE_WRITE,[\s\S]*?OPEN_EXISTING/u, + ); + assert.doesNotMatch(redirectCaptureAuthorityOpen, /GENERIC_READ/u); + assert.match(orchestrator, /public static uint GetLinkCount/u); + assert.match( + orchestrator, + /Initialize-PrivilegedCaptureFile \$stdout \$privilegedSid[\s\S]*?Initialize-PrivilegedCaptureFile \$stderr \$privilegedSid[\s\S]*?Start-Process/u, + ); + assert.match( + orchestrator, + /Start-Process[\s\S]*?Assert-PrivilegedCaptureIdentity \$stdoutAuthority \$privilegedSid[\s\S]*?Assert-PrivilegedCaptureIdentity \$stderrAuthority \$privilegedSid/u, + ); + const captureRedirectionTestMode = orchestrator.slice( + orchestrator.indexOf("if ($LifecycleTestMode -eq 'capture-redirection')"), + orchestrator.indexOf("if ($LifecycleTestMode -eq 'capture-parser')"), + ); + const captureProducerOutputClassifier = orchestrator.slice( + orchestrator.indexOf('function Get-TestOnlyCaptureProducerOutputState'), + orchestrator.indexOf('function Set-LifecycleFailureSubphase'), + ); + assert.match( + captureProducerOutputClassifier, + /\$captureReadHandle = \[ProprHostLauncherNative\]::OpenCapture\(\$Authority\.Path, \$true\)/u, + ); + assert.doesNotMatch( + captureProducerOutputClassifier, + /(?:GetLength|ReadBounded)\(\s*\$Authority\.Handle/u, + ); + assert.match( + captureProducerOutputClassifier, + /\$maximumAttributedBytes = 256[\s\S]*?GetLength\(\$captureReadHandle\)[\s\S]*?\$length -le \$maximumAttributedBytes[\s\S]*?ReadBounded\(\s*\$captureReadHandle, \$maximumAttributedBytes\s*\)/u, + ); + assert.equal( + (captureProducerOutputClassifier.match(/GetIdentity\(\$Authority\.Handle\)/gu) ?? []).length, + 2, + 'the retained non-readable authority identity must be unchanged across classification', + ); + assert.equal( + (captureProducerOutputClassifier.match(/Assert-PrivilegedCaptureFile/gu) ?? []).length, + 2, + 'the temporary read handle must be exact-bound before and after classification', + ); + assert.match( + captureProducerOutputClassifier, + /Assert-PrivilegedCaptureFile[\s\S]*?\$Authority\.Identity[\s\S]*?Get-CaptureAuthorityDescriptor \$Authority\.Path\) -cne[\s\S]*?\$Authority\.SecurityDescriptor[\s\S]*?ReadBounded[\s\S]*?Assert-PrivilegedCaptureFile[\s\S]*?GetIdentity\(\$Authority\.Handle\)[\s\S]*?\$Authority\.SecurityDescriptor/u, + ); + assert.match( + captureProducerOutputClassifier, + /finally \{\s*if \(\$null -ne \$captureReadHandle\) \{\s*try \{ \$captureReadHandle\.Dispose\(\) \} catch \{\}\s*\}\s*\}/u, + ); + for (const predicate of [ + 'pre-create', + 'redirect-open', + 'redirect-timeout', + 'redirect-child-exit', + 'capture-content', + 'cleanup', + ]) { + assert.match( + captureRedirectionTestMode, + new RegExp(`Set-CaptureAuthorityPredicate '${predicate}'`, 'u'), + ); + } + assert.match( + captureRedirectionTestMode, + /Set-CaptureAuthorityPredicate 'redirect-open'[\s\S]*?Start-Process[\s\S]*?!\(\$redirectionProcess -is \[System\.Diagnostics\.Process\]\)/u, + ); + assert.match( + captureRedirectionTestMode, + /CaptureRedirectionProducerTestCase -ceq 'nonzero'[\s\S]*?\{ 23 \}[\s\S]*?\$captureProducerSource = if[\s\S]*?capture-stdout[\s\S]*?capture-stderr[\s\S]*?exit \$captureProducerExitCode[\s\S]*?\[Text\.Encoding\]::Unicode\.GetBytes\(\$captureProducerSource\)/u, + ); + assert.match( + captureRedirectionTestMode, + /\$captureProducerArguments = \(\s*'-NoLogo -NoProfile -NonInteractive -EncodedCommand "' \+\s*\$captureProducerArgument \+ '"'\s*\)\s*\$redirectionProcess = Start-Process[\s\S]*?-ArgumentList \$captureProducerArguments/u, + ); + assert.doesNotMatch(captureRedirectionTestMode, /-ArgumentList @\(|StartInfo\.Arguments/u); + assert.match( + captureRedirectionTestMode, + /\$redirectionProcessHandle = \$redirectionProcess\.Handle[\s\S]*?Set-CaptureAuthorityPredicate 'redirect-timeout'[\s\S]*?WaitForExit\(\$terminationTimeoutMilliseconds\)[\s\S]*?Assert-PrivilegedCaptureIdentity[\s\S]*?Assert-PrivilegedCaptureIdentity[\s\S]*?Get-TestOnlyCaptureProducerOutputState/u, + ); + assert.match( + captureRedirectionTestMode, + /Get-TestOnlyCaptureProducerOutputState\s*`\s*\$stdoutAuthority \$privilegedSid 'capture-stdout'[\s\S]*?Get-TestOnlyCaptureProducerOutputState\s*`\s*\$stderrAuthority \$privilegedSid 'capture-stderr'/u, + ); + assert.match( + captureRedirectionTestMode, + /CaptureRedirectionProducerTestCase -cne 'success' -or\s*\$captureProducerExitBucket -cne 'zero'[\s\S]*?\$captureProducerStdoutState -cne 'exact-expected' -or\s*\$captureProducerStderrState -cne 'exact-expected'[\s\S]*?\$redirectionAccepted = \$true/u, + ); + assert.doesNotMatch( + captureRedirectionTestMode.slice( + captureRedirectionTestMode.indexOf('WaitForExit($terminationTimeoutMilliseconds)'), + captureRedirectionTestMode.indexOf('Assert-PrivilegedCaptureIdentity'), + ), + /ReadAllText|ReadAllBytes|ReadBounded/u, + ); + assert.doesNotMatch(captureRedirectionTestMode, /start-process-launch/u); + assert.match( + captureRedirectionTestMode, + /-TestOnlyIdentityPredicate 'post-redirection-identity'/u, + ); + assert.match( + captureRedirectionTestMode, + /\$primaryFailure = 'artifact-type'[\s\S]*?\$primaryPhase = 'capture-parse'[\s\S]*?\$primarySubphase = 'capture-authority'[\s\S]*?Set-CaptureAuthorityPredicate \$redirectionFailurePredicate/u, + ); + assert.match(captureParser, /Set-LifecycleFailureSubphase \$failureRecord\.category[\s\S]*?return 'spawn-failed'/u); + assert.doesNotMatch(captureParser, /lastMilestone/u); + assert.match(captureParser, /\$script:failurePhase = \$failureRecord\.phase/u); + assert.match( + orchestrator, + /Read-PackagedConnectSmokeFailure[\s\S]*?-Path \$stderr[\s\S]*?-ExpectedCaptureIdentity \$stderrAuthority\.Identity[\s\S]*?Stop-PackagedConnect \$childFailureCategory/u, + ); + assert.match(orchestrator, /catch \{\s*Set-PrimaryFailureFromException \$_\.Exception\s*\}/u); + assert.match(orchestrator, /\$primaryPhase -ceq 'ordinary-user-preflight'[\s\S]*?\$primarySubphase = 'host-state-contract'/u); + assert.match(orchestrator, /\$subphaseEvidence = ":subphase=\$primarySubphase"/u); + assert.match(orchestrator, /PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=\$primaryFailure`:phase=\$primaryPhase\$subphaseEvidence`:cleanup=\$cleanupSecondary/u); + + const cleanupFinally = orchestrator.slice(orchestrator.lastIndexOf('} finally {')); + assert.match(cleanupFinally, /\$cleanupResult = Invoke-BoundedCleanup/u); + assert.doesNotMatch(cleanupFinally, /Get-ChildItem|GetAccessControl|Remove-Item|Test-Path|Remove-LocalUser/u); + assert.match(cleanupFinally, /if \(\$null -eq \$primaryFailure -and \$cleanupSecondary -ne 'none'\)/u); + assert.doesNotMatch( + cleanupFinally.slice(0, cleanupFinally.indexOf("if ($null -eq $primaryFailure")), + /\$primaryFailure\s*=/u, + 'a cleanup timeout must not replace an existing primary failure', + ); + + const preflight = harness.indexOf('const staged = await validateWindowsStagedPackage'); + const spawn = harness.indexOf('const child = spawnPackagedConnectBinary'); + assert.ok(preflight >= 0 && preflight < spawn, 'ordinary-user package preflight must complete before spawn'); + assert.equal((harness.match(/await validateWindowsStagedPackage\(/gu) ?? []).length, 1); + assert.equal((harness.match(/await runPackagedConnectLifecycle\(/gu) ?? []).length, 1); + assert.match(harness, /shell: false/u); + assert.match(harness, /parseWindowsStagedPackageHandoff\(process\.argv\.slice\(2\)\)/u); + assert.match(harness, /delete childEnvironment\.PROPR_DESKTOP_CONNECT_STAGING_PARENT/u); + assert.match(harness, /delete childEnvironment\.PROPR_DESKTOP_CONNECT_STAGING_LEAF/u); + assert.match(harness, /describeWindowsArtifactFailure\(error, packagedConnectPhase\)/u); + assert.match(harness, /packagedConnectArtifactSensitiveNeedles\(\{\s*platform: process\.platform,\s*artifactRoot,\s*binaryPath,/u); + assert.doesNotMatch(harness, /identity, artifactRoot, binaryPath,/u); + assert.doesNotMatch(harness, /child\.once\('error', error/u); + const readyProducer = main.slice( + main.indexOf('const runPackagedConnectDiscoverySmoke'), + main.indexOf('const runPackagedTransportSmoke'), + ); + assert.match(readyProducer, /await window\.webContents\.executeJavaScript/u); + assert.match(readyProducer, /process\.stdout\.write\(`\$\{JSON\.stringify\(\{/u); + assert.match(readyProducer, /const readyFields = \{[\s\S]*?selectedPlatform: process\.platform[\s\S]*?selectedArch: process\.arch[\s\S]*?authorityMechanism:[\s\S]*?rendererSchemaValid: true/u); + assert.match(readyProducer, /timestamp: new Date\(\)\.toISOString\(\)[\s\S]*?level: 'info'[\s\S]*?event: 'desktop\.renderer\.connect_discovery\.ready'[\s\S]*?\.\.\.readyFields/u); + assert.ok( + readyProducer.indexOf("throw new Error('Packaged Connect renderer discovery proof was invalid')") + < readyProducer.indexOf('process.stdout.write'), + 'READY must be emitted only after the renderer discovery proof succeeds', + ); +}); + +windowsTest('the PS5.1 child-failure parser accepts only the two exact bounded producer schemas', async context => { + const runnerTemp = process.env.RUNNER_TEMP; + assert.equal(typeof runnerTemp, 'string'); + const smokeRecord = { + event: 'packaged_connect.smoke_failed', + category: 'timeout-before-ready', + capture: 'complete', + records: [{ + event: 'desktop.renderer.connect_discovery.phase', + phase: 'config-read', + code: 'FAILED', + substep: 'directory-open', + category: 'access-denied', + }], + secondary: ['tree-termination-failed'], + }; + const stagedContractRecord = { + event: 'packaged_connect.artifact_failed', + category: 'artifact-type', + phase: 'staged-contract', + subphase: 'parent-to-runner-binding', + }; + const stagedTreeRecord = { + event: 'packaged_connect.artifact_failed', + category: 'artifact-inaccessible', + phase: 'staged-tree', + }; + const stagedArchitectureRecord = { + event: 'packaged_connect.artifact_failed', + category: 'architecture-mismatch', + phase: 'staged-architecture', + }; + const ordinaryPreflightRecord = { + event: 'packaged_connect.artifact_failed', + category: 'artifact-inaccessible', + phase: 'ordinary-user-preflight', + subphase: 'executable-read', + }; + const smokeLine = `${JSON.stringify(smokeRecord)}\n`; + const artifactLine = `${JSON.stringify(stagedContractRecord)}\n`; + const cases = [ + ['valid-smoke', smokeLine, + 'category=spawn-failed:phase=application-runtime:subphase=timeout-before-ready'], + ['valid-record-contained-ready-milestone', `${JSON.stringify({ + ...smokeRecord, + records: [{ event: 'desktop.renderer.connect_discovery.ready' }], + })}\n`, 'category=spawn-failed:phase=application-runtime:subphase=timeout-before-ready'], + ['valid-record-contained-proof-milestone', `${JSON.stringify({ + ...smokeRecord, + records: [{ event: 'desktop.renderer.connect_discovery.proof' }], + })}\n`, 'category=spawn-failed:phase=application-runtime:subphase=timeout-before-ready'], + ['valid-ready-duplicate', `${JSON.stringify({ + ...smokeRecord, category: 'ready-duplicate', + })}\n`, 'category=spawn-failed:phase=application-runtime:subphase=ready-duplicate'], + ['valid-child-remained-alive', `${JSON.stringify({ + ...smokeRecord, category: 'child-remained-alive', + })}\n`, 'category=spawn-failed:phase=application-runtime:subphase=child-remained-alive'], + ['valid-staged-contract', artifactLine, + 'category=artifact-type:phase=staged-contract:subphase=parent-to-runner-binding'], + ['valid-staged-tree', `${JSON.stringify(stagedTreeRecord)}\n`, + 'category=artifact-inaccessible:phase=staged-tree'], + ['valid-staged-architecture', `${JSON.stringify(stagedArchitectureRecord)}\n`, + 'category=architecture-mismatch:phase=staged-architecture'], + ['valid-ordinary-user-preflight', `${JSON.stringify(ordinaryPreflightRecord)}\n`, + 'category=artifact-inaccessible:phase=ordinary-user-preflight:subphase=executable-read'], + ['malformed', '{"event":\n', + 'category=artifact-type:phase=capture-parse:subphase=capture-json'], + ['smoke-duplicate-field', smokeLine.replace( + '{"event":"packaged_connect.smoke_failed",', + '{"event":"packaged_connect.smoke_failed","event":"packaged_connect.smoke_failed",', + ), 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['artifact-duplicate-field', artifactLine.replace( + '"phase":"staged-contract",', + '"phase":"staged-contract","phase":"staged-contract",', + ), 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['smoke-extra-field', `${JSON.stringify({ ...smokeRecord, detail: 'fixed' })}\n`, + 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['smoke-top-level-last-milestone', `${JSON.stringify({ + ...smokeRecord, lastMilestone: 'desktop.app.ready', + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['artifact-extra-field', `${JSON.stringify({ ...stagedContractRecord, detail: 'fixed' })}\n`, + 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['smoke-missing-field', `${JSON.stringify({ + event: smokeRecord.event, category: smokeRecord.category, records: smokeRecord.records, + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['artifact-missing-field', `${JSON.stringify({ + event: stagedContractRecord.event, + category: stagedContractRecord.category, + phase: stagedContractRecord.phase, + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['smoke-cross-schema-phase', `${JSON.stringify({ + ...smokeRecord, phase: 'staged-tree', + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['smoke-cross-schema-subphase', `${JSON.stringify({ + ...smokeRecord, subphase: 'fixed-parent-leaf', + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['artifact-cross-schema-capture', `${JSON.stringify({ + ...stagedContractRecord, capture: 'complete', + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['artifact-cross-schema-records', `${JSON.stringify({ + ...stagedContractRecord, records: [], + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['artifact-cross-schema-secondary', `${JSON.stringify({ + ...stagedContractRecord, secondary: ['tree-termination-failed'], + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['smoke-multiline', `${smokeLine}${smokeLine}`, + 'category=artifact-type:phase=capture-parse:subphase=capture-line-cardinality'], + ['artifact-multiline', `${artifactLine}${artifactLine}`, + 'category=artifact-type:phase=capture-parse:subphase=capture-line-cardinality'], + ['oversized', Buffer.alloc(65_537, 0x61), + 'category=artifact-type:phase=capture-parse:subphase=capture-size'], + ['wrong-event', `${JSON.stringify({ ...smokeRecord, event: 'packaged_connect.child_failed' })}\n`, + 'category=artifact-type:phase=capture-parse:subphase=capture-event-cardinality'], + ['wrong-nested-event', `${JSON.stringify({ + ...smokeRecord, records: [{ event: 'desktop.renderer.connect_discovery.arbitrary' }], + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-event-cardinality'], + ['proof-extra-field', `${JSON.stringify({ + ...smokeRecord, + records: [{ event: 'desktop.renderer.connect_discovery.proof', milestone: 'connect-proof' }], + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['smoke-wrong-category', `${JSON.stringify({ + ...smokeRecord, category: 'arbitrary-runtime-error', + })}\n`, + 'category=artifact-type:phase=capture-parse:subphase=capture-lifecycle-category'], + ['artifact-wrong-category', `${JSON.stringify({ + ...stagedContractRecord, category: 'artifact-inaccessible', + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-lifecycle-category'], + ['artifact-wrong-phase', `${JSON.stringify({ + ...stagedContractRecord, phase: 'application-runtime', + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-lifecycle-phase'], + ['artifact-wrong-required-subphase', `${JSON.stringify({ + ...stagedContractRecord, subphase: 'executable-read', + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-lifecycle-subphase'], + ['artifact-forbidden-subphase', `${JSON.stringify({ + ...stagedTreeRecord, subphase: 'executable-read', + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-schema-cardinality'], + ['smoke-wrong-record-category', `${JSON.stringify({ + ...smokeRecord, + records: [{ ...smokeRecord.records[0], category: 'arbitrary-category' }], + })}\n`, 'category=artifact-type:phase=capture-parse:subphase=capture-lifecycle-subphase'], + ['smoke-sensitive', `${JSON.stringify({ ...smokeRecord, category: 'environment-secret-SENTINEL' })}\n`, + 'category=artifact-type:phase=capture-parse:subphase=capture-redaction'], + ['artifact-sensitive', `${JSON.stringify({ + ...stagedContractRecord, subphase: 'environment-secret-SENTINEL', + })}\n`, + 'category=artifact-type:phase=capture-parse:subphase=capture-redaction'], + ['invalid-utf8', Buffer.from([0xc3, 0x28, 0x0a]), + 'category=artifact-type:phase=capture-parse:subphase=capture-utf8'], + ]; + + for (let index = 0; index < cases.length; index += 1) { + const [name, content, evidence] = cases[index]; + const capturePath = join( + runnerTemp, + `propr-connect-${randomBytes(16).toString('hex')}.stderr`, + ); + await writeFile(capturePath, content, { flag: 'wx' }); + context.after(() => rm(capturePath, { force: true })); + const result = runCaptureParserTest(capturePath); + assert.ifError(result.error, name); + assert.equal(result.signal, null, name); + assert.equal(result.status, 1, name); + assert.equal(result.stdout.length, 0, name); + const diagnostic = result.stderr.toString('utf8').trim(); + assert.equal( + diagnostic, + `PROPR_WINDOWS_PACKAGED_CONNECT:failed:${evidence}:cleanup=none`, + name, + ); + assert.ok(diagnostic.length <= 256, name); + assertNoHostileDiagnosticEvidence(diagnostic); + assert.doesNotMatch(diagnostic, /SENTINEL|arbitrary|fixed/iu, name); + } +}); + +windowsTest('the PS5.1 capture parser enforces native owner ACL path and identity authority', async context => { + const runnerTemp = process.env.RUNNER_TEMP; + assert.equal(typeof runnerTemp, 'string'); + const content = `${JSON.stringify({ + event: 'packaged_connect.artifact_failed', + category: 'artifact-type', + phase: 'staged-contract', + subphase: 'parent-to-runner-binding', + })}\n`; + const expectedAccepted = 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=staged-contract:subphase=parent-to-runner-binding:cleanup=none'; + const expectedRejected = predicate => 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + `:phase=capture-parse:subphase=capture-authority:predicate=${predicate}:cleanup=none`; + const trackedPaths = []; + context.after(async () => { + await Promise.all(trackedPaths.map(path => rm(path, { force: true, recursive: true }))); + }); + const newCapturePath = async (parent = runnerTemp, leaf) => { + const path = join( + parent, + leaf ?? `propr-connect-${randomBytes(16).toString('hex')}.stderr`, + ); + await writeFile(path, content, { flag: 'wx' }); + trackedPaths.push(path); + return path; + }; + const assertResult = (name, result, expected) => { + assert.ifError(result.error, name); + assert.equal(result.signal, null, name); + assert.equal(result.status, 1, name); + assert.equal(result.stdout.length, 0, name); + const diagnostic = result.stderr.toString('utf8').trim(); + assert.equal(diagnostic, expected, name); + assertNoHostileDiagnosticEvidence(diagnostic); + }; + + for (const authorityCase of ['current-owner', 'administrators-owner']) { + const path = await newCapturePath(); + assertResult(authorityCase, runCaptureParserTest(path, authorityCase), expectedAccepted); + } + + for (const [authorityCase, predicate] of [ + ['foreign-owner', 'capture-owner'], + ['ordinary-owner', 'capture-owner'], + ['ordinary-write', 'unauthorized-writer'], + ['broad-write', 'unauthorized-writer'], + ['unprotected-dacl', 'dacl-canonicality'], + ]) { + const path = await newCapturePath(); + assertResult(authorityCase, runCaptureParserTest(path, authorityCase), expectedRejected(predicate)); + } + + const isolatedParent = await mkdtemp(join(runnerTemp, 'propr-capture-parent-owner-')); + trackedPaths.push(isolatedParent); + const isolatedParentCapture = await newCapturePath(isolatedParent); + assertResult( + 'foreign-parent-owner', + runCaptureParserTest( + isolatedParentCapture, + 'foreign-parent-owner', + { RUNNER_TEMP: isolatedParent }, + ), + expectedRejected('parent-owner'), + ); + + const wrongLeaf = await newCapturePath( + runnerTemp, + `propr-connect-${randomBytes(16).toString('hex')}.txt`, + ); + assertResult('wrong-leaf', runCaptureParserTest(wrongLeaf), expectedRejected('link-path-type')); + + const escapeParent = await mkdtemp(join(runnerTemp, 'propr-capture-escape-')); + trackedPaths.push(escapeParent); + const escapedCapture = await newCapturePath(escapeParent); + assertResult( + 'parent-escape', + runCaptureParserTest(escapedCapture), + expectedRejected('link-path-type'), + ); + + const hardlinkCapture = await newCapturePath(); + const hardlinkAlias = join( + runnerTemp, + `propr-connect-${randomBytes(16).toString('hex')}.stderr`, + ); + await link(hardlinkCapture, hardlinkAlias); + trackedPaths.push(hardlinkAlias); + assertResult( + 'hardlink', + runCaptureParserTest(hardlinkAlias, 'existing'), + expectedRejected('link-path-type'), + ); + + const directoryCapture = join( + runnerTemp, + `propr-connect-${randomBytes(16).toString('hex')}.stderr`, + ); + await mkdir(directoryCapture); + trackedPaths.push(directoryCapture); + assertResult( + 'non-regular-file', + runCaptureParserTest(directoryCapture), + expectedRejected('link-path-type'), + ); + + const reparseTarget = await newCapturePath( + runnerTemp, + `propr-capture-target-${randomBytes(8).toString('hex')}.txt`, + ); + const reparseCapture = join( + runnerTemp, + `propr-connect-${randomBytes(16).toString('hex')}.stderr`, + ); + await symlink(reparseTarget, reparseCapture, 'file'); + trackedPaths.push(reparseCapture); + assertResult( + 'reparse-file', + runCaptureParserTest(reparseCapture, 'existing'), + expectedRejected('link-path-type'), + ); + + const reparseParentTarget = await mkdtemp(join(runnerTemp, 'propr-capture-parent-target-')); + trackedPaths.push(reparseParentTarget); + const reparseParent = join(runnerTemp, `propr-capture-parent-${randomBytes(8).toString('hex')}`); + await symlink(reparseParentTarget, reparseParent, 'junction'); + trackedPaths.push(reparseParent); + const reparseParentCapture = await newCapturePath(reparseParentTarget); + const captureThroughReparseParent = join(reparseParent, reparseParentCapture.slice( + reparseParentTarget.length + 1, + )); + assertResult( + 'reparse-parent', + runCaptureParserTest(captureThroughReparseParent, 'existing', { RUNNER_TEMP: reparseParent }), + expectedRejected('link-path-type'), + ); + + const identityChangeCapture = await newCapturePath(); + trackedPaths.push(`${identityChangeCapture}.propr-replaced`); + assertResult( + 'identity-change', + runCaptureParserTest(identityChangeCapture, 'identity-change'), + expectedRejected('identity-replacement'), + ); +}); + +windowsTest('nominal reaches zero with exact protected stdout and stderr capture', () => { + const result = runCaptureRedirectionTest(); + const accepted = !result.error && result.signal === null && result.status === 0 + && Buffer.isBuffer(result.stdout) && result.stdout.length <= 128 + && captureRedirectionAcceptedPattern.test(result.stdout.toString('utf8')) + && Buffer.isBuffer(result.stderr) && result.stderr.length === 0; + if (!accepted) failCaptureRedirectionTest(result); +}); + +windowsTest('a forced nonzero capture producer maps only to redirect-child-exit', () => { + const result = runCaptureRedirectionTest('nonzero'); + assert.equal(result.error, undefined); + assert.equal(result.signal, null); + assert.equal(result.status, 1); + assert.equal(result.stdout.length, 0); + const diagnostic = result.stderr.toString('utf8'); + assert.equal( + diagnostic, + 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=capture-parse:subphase=capture-authority' + + ':predicate=redirect-child-exit:exit=forced-23' + + ':out=exact-expected:err=exact-expected:cleanup=none\r\n', + ); + assertNoHostileDiagnosticEvidence(diagnostic); +}); + +windowsTest('empty and hostile producer results map only to fixed bounded buckets', () => { + for (const [producerTestCase, expectedResult] of [ + ['empty', 'exit=other:out=empty:err=empty'], + ['hostile', 'exit=other:out=other-bounded:err=other-bounded'], + ]) { + const result = runCaptureRedirectionTest(producerTestCase); + assert.equal(result.error, undefined, producerTestCase); + assert.equal(result.signal, null, producerTestCase); + assert.equal(result.status, 1, producerTestCase); + assert.equal(result.stdout.length, 0, producerTestCase); + const diagnostic = result.stderr.toString('utf8'); + assert.equal( + diagnostic, + 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type' + + ':phase=capture-parse:subphase=capture-authority' + + `:predicate=redirect-child-exit:${expectedResult}:cleanup=none\r\n`, + producerTestCase, + ); + assertNoHostileDiagnosticEvidence(diagnostic); + } +}); + +windowsTest('each host preflight failure transition emits one fixed redacted subphase', () => { + for (const subphase of fixedHostDiagnosticSubphases) { + const result = spawnSync(windowsPowerShell51Path(), [ + '-NoLogo', + '-NoProfile', + '-NonInteractive', + '-File', + orchestratorPath, + '-Architecture', + process.arch, + '-LifecycleTestMode', + 'diagnostic-subphase', + '-DiagnosticTestSubphase', + subphase, + ], { + shell: false, + windowsHide: true, + timeout: 10_000, + }); + + assert.ifError(result.error); + assert.equal(result.signal, null); + assert.equal(result.status, 1); + assert.equal(result.stdout.length, 0); + const diagnostic = result.stderr.toString('utf8').trim(); + assert.equal( + diagnostic, + `PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-inaccessible:phase=ordinary-user-preflight:subphase=${subphase}:cleanup=none`, + ); + assert.equal((diagnostic.match(/:subphase=/gu) ?? []).length, 1); + assertNoHostileDiagnosticEvidence(diagnostic); + } +}); + +for (const [testCase, subphase] of [ + ['zero', 'host-node-command-cardinality'], + ['duplicate', 'host-node-command-cardinality'], + ['multiple', 'host-node-command-cardinality'], + ['mixed-types', 'host-node-command-cardinality'], + ['case-collision', 'host-node-command-cardinality'], + ['non-application', 'host-node-command-type'], + ['missing-source', 'host-node-source'], + ['non-scalar-source', 'host-node-source'], +]) { + windowsTest(`the PS5.1 host Node producer rejects ${testCase} command evidence`, () => { + const result = runHostNodeProducerTest(testCase); + assert.ifError(result.error); + assert.equal(result.signal, null); + assert.equal(result.status, 1); + assert.equal(result.stdout.length, 0); + const diagnostic = result.stderr.toString('utf8').trim(); + assert.equal( + diagnostic, + `PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type` + + `:phase=ordinary-user-preflight:subphase=${subphase}:cleanup=none`, + ); + assert.equal((diagnostic.match(/:subphase=/gu) ?? []).length, 1); + assertNoHostileDiagnosticEvidence(diagnostic); + }); +} + +windowsTest('the PS5.1 host Node producer returns one validated scalar Source', () => { + const result = runHostNodeProducerTest('positive'); + assertPositiveHostNodeProducer(result); +}); + +windowsTest('the host launcher accepts only a stable final ordinary-file identity', async context => { + const producedRoot = await mkdtemp(join(tmpdir(), 'propr-launcher-authority-')); + context.after(() => rm(producedRoot, { force: true, recursive: true })); + // PowerShell 5.1 expands an existing 8.3 path in GetFullPath, so join fixtures only below this final spelling. + const root = await realpath(producedRoot); + const rootEntry = await lstat(root); + assert.equal(rootEntry.isDirectory(), true); + assert.equal(rootEntry.isSymbolicLink(), false); + assert.equal(await realpath(root), root, 'the native fixture producer must return its canonical root'); + const target = join(root, 'node-target.exe'); + const otherTarget = join(root, 'node-other.exe'); + const alias = join(root, 'node-alias.exe'); + const brokenAlias = join(root, 'node-broken.exe'); + const retargetedAlias = join(root, 'node-retargeted.exe'); + const identityTarget = join(root, 'node-identity.exe'); + const directory = join(root, 'node-directory.exe'); + await Promise.all([ + writeFile(target, Buffer.from('ordinary launcher target')), + writeFile(otherTarget, Buffer.from('other ordinary launcher target')), + writeFile(identityTarget, Buffer.from('identity launcher target')), + ]); + await symlink(target, alias, 'file'); + await symlink(join(root, 'missing-target.exe'), brokenAlias, 'file'); + await symlink(target, retargetedAlias, 'file'); + await mkdir(directory); + + if (producedRoot.toUpperCase() !== root.toUpperCase()) { + assertLauncherAuthorityRejected( + runLauncherAuthorityTest(join(producedRoot, 'node-target.exe')), + 'artifact-type', + 'host-launcher-selected-path-canonical-equality', + ); + } + + for (const [caseName, acceptedPath] of [['normal', target], ['alias', alias]]) { + const result = runLauncherAuthorityTest(acceptedPath, caseName); + assertLauncherAuthorityAccepted(result, caseName); + } + + assertLauncherAuthorityRejected( + runLauncherAuthorityTest(brokenAlias), + 'artifact-missing', + 'host-launcher-source-open', + ); + assertLauncherAuthorityRejected( + runLauncherAuthorityTest(retargetedAlias, 'retarget-alias', otherTarget), + 'artifact-type', + 'host-launcher-source-reopen-match', + ); + assertLauncherAuthorityRejected( + runLauncherAuthorityTest(identityTarget, 'identity-mismatch'), + 'artifact-type', + 'host-launcher-final-match', + ); + assertLauncherAuthorityRejected( + runLauncherAuthorityTest(directory), + 'artifact-type', + 'host-launcher-source-type', + ); + const selectedPathRejections = [ + ['', 'host-launcher-selected-path-input'], + [String.raw`\\.\NUL`, 'host-launcher-selected-path-input'], + [String.raw`\\?\C:\ordinary.exe`, 'host-launcher-selected-path-input'], + [String.raw`\??\C:\ordinary.exe`, 'host-launcher-selected-path-input'], + [`${root}\\${'x'.repeat(260)}`, 'host-launcher-selected-path-input'], + [`${root}\\control-${String.fromCharCode(1)}.exe`, 'host-launcher-selected-path-input'], + [String.raw`C:\invalid|path.exe`, 'host-launcher-selected-path-get-full-path'], + [String.raw`\\server\share`, 'host-launcher-selected-path-absolute-shape'], + [String.raw`C:\ordinary.exe:alternate-stream`, 'host-launcher-selected-path-extra-colon'], + ['node.exe', 'host-launcher-selected-path-canonical-equality'], + [String.raw`C:\ordinary\..\ordinary.exe`, 'host-launcher-selected-path-canonical-equality'], + ]; + for (const [rejectedPath, subphase] of selectedPathRejections) { + assertLauncherAuthorityRejected(runLauncherAuthorityTest(rejectedPath), 'artifact-type', subphase); + } +}); + +test('the bounded cleanup source requires proven child exit and bounded stream closure', async () => { + const orchestrator = await readFile(new URL('./run-packaged-windows-connect-smoke.ps1', import.meta.url), 'utf8'); + const boundedCleanup = orchestrator.slice( + orchestrator.indexOf('function Invoke-BoundedCleanup'), + orchestrator.indexOf('$authenticatedRunnerTemp = $null'), + ); + assert.match(boundedCleanup, /\$cleanupProcess=\[Diagnostics\.Process\]::new\(\)/u); + assert.match( + boundedCleanup, + /if\(!\$cleanupProcess\.WaitForExit\(\$cleanupTimeoutMilliseconds\)\)\{[\s\S]*?\$cleanupProcess\.Kill\(\)[\s\S]*?if\(!\$cleanupProcess\.WaitForExit\(\$terminationTimeoutMilliseconds\)\)\{return 'failed'\}[\s\S]*?Task\]::WaitAll[\s\S]*?return 'timeout'/u, + ); + assert.match(boundedCleanup, /\$cleanupOutputClose=\$cleanupProcess\.StandardOutput\.BaseStream\.CopyToAsync/u); + assert.match(boundedCleanup, /\$cleanupErrorClose=\$cleanupProcess\.StandardError\.BaseStream\.CopyToAsync/u); +}); + +windowsTest('the native timeout path terminates an actual child and descendant tree', async context => { + const { root, descendantProcessId } = await startNativeNodeTree(); + context.after(() => terminateTreeAfterTest(root.pid)); + context.after(() => terminateTreeAfterTest(descendantProcessId)); + assert.equal(processExists(root.pid), true); + assert.equal(processExists(descendantProcessId), true); + + const result = spawnSync(windowsPowerShell51Path(), [ + '-NoLogo', + '-NoProfile', + '-NonInteractive', + '-File', + orchestratorPath, + '-Architecture', + process.arch, + '-LifecycleTestMode', + 'terminate-tree', + '-LifecycleTestProcessId', + String(root.pid), + ], { + shell: false, + windowsHide: true, + timeout: 15_000, + }); + + assert.ifError(result.error); + assert.equal(result.signal, null); + assert.equal(result.status, 0); + assert.equal(result.stdout.toString('utf8').trim(), + 'PROPR_WINDOWS_PACKAGED_CONNECT_LIFECYCLE_TEST:tree-terminated'); + assert.equal(result.stderr.length, 0); + assert.equal(await waitForProcessExit(root.pid), true, 'the native harness root must terminate'); + assert.equal(await waitForProcessExit(descendantProcessId), true, + 'the native harness descendant must terminate'); +}); + +windowsTest('a real never-settling cleanup is bounded, terminated, and remains secondary', () => { + const startedAt = Date.now(); + const result = spawnSync(windowsPowerShell51Path(), [ + '-NoLogo', + '-NoProfile', + '-NonInteractive', + '-File', + orchestratorPath, + '-Architecture', + process.arch, + '-LifecycleTestMode', + 'cleanup-timeout', + ], { + shell: false, + windowsHide: true, + timeout: 10_000, + }); + const elapsedMilliseconds = Date.now() - startedAt; + + assert.ifError(result.error); + assert.equal(result.signal, null); + assert.equal(result.status, 1); + assert.equal(result.stdout.length, 0); + assert.equal( + result.stderr.toString('utf8').trim(), + 'PROPR_WINDOWS_PACKAGED_CONNECT:failed:category=artifact-type:phase=staged-tree:cleanup=cleanup-timeout', + ); + assert.ok(elapsedMilliseconds >= 750, 'the injected cleanup must reach its deadline'); + assert.ok(elapsedMilliseconds < 8_000, 'the cleanup deadline and termination must remain bounded'); +}); diff --git a/apps/desktop/src/connect-discovery.test.ts b/apps/desktop/src/connect-discovery.test.ts new file mode 100644 index 000000000..9fb0c65ea --- /dev/null +++ b/apps/desktop/src/connect-discovery.test.ts @@ -0,0 +1,261 @@ +import assert from 'node:assert/strict'; +import { describe, it } from 'node:test'; +import type { ConnectStatusDocument } from '@propr/cli/desktop-discovery'; +import { DesktopConnectDiscoveryService } from './connect-discovery'; + +const readyStatus = (endpoint = 'https://t-discovered123.propr.dev'): ConnectStatusDocument => ({ + schemaVersion: 1, + status: 'ready', + canonicalEndpoint: endpoint, + publicInstanceIdentity: '123e4567-e89b-42d3-a456-426614174000', + configured: true, + enabled: true, + sidecarRunning: true, + apiReady: true, + restartRequired: false, + compatibility: '2026-08-01', + version: '0.8.15', + reasonCodes: [], +}); + +const deferred = () => { + let resolve!: (value: T) => void; + let reject!: (reason?: unknown) => void; + const promise = new Promise((resolvePromise, rejectPromise) => { + resolve = resolvePromise; + reject = rejectPromise; + }); + return { promise, resolve, reject }; +}; + +describe('desktop fixed-root Connect discovery', () => { + it('projects only a stable opaque profile and canonical endpoint', async () => { + const service = new DesktopConnectDiscoveryService({ + list: async () => ({ profiles: [], activeProfileId: null }), + }, { + supported: true, + discover: async () => readyStatus(), + }); + + const unclaimed = service.snapshotIdentityClaim( + 'propr-connect-discovered', 'https://t-discovered123.propr.dev', + ); + assert.equal(unclaimed.status, 'unclaimed'); + assert.equal(unclaimed.isCurrent(), true); + const candidates = await service.discover(); + assert.deepEqual(candidates, [{ + id: 'propr-connect-discovered', + label: 'ProPR Connect', + apiBaseUrl: 'https://t-discovered123.propr.dev', + }]); + const serialized = JSON.stringify(candidates); + assert.doesNotMatch(serialized, /123e4567|root|path|environment|executable|credential|authority/i); + const claim = service.snapshotIdentityClaim( + 'propr-connect-discovered', 'https://t-discovered123.propr.dev', + ); + assert.equal(claim.status, 'claimed'); + if (claim.status === 'claimed') { + assert.equal(claim.publicInstanceIdentity, readyStatus().publicInstanceIdentity); + assert.equal(claim.isCurrent(), true); + } + assert.equal(unclaimed.isCurrent(), false); + }); + + it('fences rediscovery to an existing managed profile and preserves its id and label', async () => { + const saved = { + id: 'saved-profile', + label: 'Managed workspace', + apiBaseUrl: 'https://t-stale123.propr.dev', + createdAt: '2026-08-01T00:00:00.000Z', + updatedAt: '2026-08-01T00:00:00.000Z', + }; + const service = new DesktopConnectDiscoveryService({ + list: async () => ({ profiles: [saved], activeProfileId: saved.id }), + }, { + supported: true, + discover: async () => readyStatus('https://t-recovered456.propr.dev'), + }); + + assert.deepEqual(await service.rediscover(saved.id), { + id: saved.id, + label: saved.label, + apiBaseUrl: 'https://t-recovered456.propr.dev', + }); + const staleOrigin = service.snapshotIdentityClaim(saved.id, saved.apiBaseUrl); + assert.equal(staleOrigin.status, 'origin-mismatch'); + assert.equal(staleOrigin.isCurrent(), true); + const current = service.snapshotIdentityClaim(saved.id, 'https://t-recovered456.propr.dev'); + assert.equal(current.status, 'claimed'); + if (current.status === 'claimed') { + assert.equal(current.publicInstanceIdentity, readyStatus().publicInstanceIdentity); + assert.equal(current.isCurrent(), true); + } + const firstGeneration = current.status === 'claimed' ? current.generation : -1; + const releaseCommit = current.beginCommit(); + assert.ok(releaseCommit); + let rediscoverySettled = false; + const rediscovery = service.rediscover(saved.id).then(result => { + rediscoverySettled = true; + return result; + }); + await Promise.resolve(); + assert.equal(rediscoverySettled, false); + assert.equal(current.isCurrent(), false); + const pending = service.snapshotIdentityClaim(saved.id, 'https://t-recovered456.propr.dev'); + assert.equal(pending.status, 'pending'); + assert.equal(pending.isCurrent(), false); + assert.equal(pending.beginCommit(), null); + releaseCommit(); + assert.deepEqual(await rediscovery, { + id: saved.id, + label: saved.label, + apiBaseUrl: 'https://t-recovered456.propr.dev', + }); + const rotated = service.snapshotIdentityClaim(saved.id, 'https://t-recovered456.propr.dev'); + assert.equal(rotated.status, 'claimed'); + if (rotated.status === 'claimed') assert.ok(rotated.generation > firstGeneration); + assert.equal(current.isCurrent(), false); + assert.equal(await service.rediscover('missing-profile'), null); + }); + + it('discards rediscovery when the exact saved profile changes while native discovery awaits', async () => { + const saved = { + id: 'saved-profile', label: 'Managed workspace', + apiBaseUrl: 'https://t-stale123.propr.dev', + createdAt: '2026-08-01T00:00:00.000Z', updatedAt: '2026-08-01T00:00:00.000Z', + }; + const replacements = [ + null, + { ...saved, label: 'Edited workspace', updatedAt: '2026-08-02T00:00:00.000Z' }, + { ...saved, apiBaseUrl: 'https://t-replaced999.propr.dev', updatedAt: '2026-08-02T00:00:00.000Z' }, + { ...saved, createdAt: '2026-08-02T00:00:00.000Z', updatedAt: '2026-08-02T00:00:00.000Z' }, + ]; + for (const replacement of replacements) { + let reads = 0; + let resolveDiscovery!: (status: ConnectStatusDocument) => void; + const discovery = new Promise(resolve => { resolveDiscovery = resolve; }); + const service = new DesktopConnectDiscoveryService({ + list: async () => { + const currentRead = reads++; + return { + profiles: currentRead === 0 ? [saved] : replacement ? [replacement] : [], + activeProfileId: saved.id, + }; + }, + }, { supported: true, discover: () => discovery }); + const result = service.rediscover(saved.id); + await Promise.resolve(); + resolveDiscovery(readyStatus('https://t-recovered456.propr.dev')); + assert.equal(await result, null); + } + }); + + it('fails closed for unsupported hosts and malformed native results', async () => { + const profiles = { list: async () => ({ profiles: [], activeProfileId: null }) }; + await assert.rejects( + new DesktopConnectDiscoveryService(profiles, { + supported: false, + discover: async () => readyStatus(), + }).discover(), + /unavailable/, + ); + assert.deepEqual(await new DesktopConnectDiscoveryService(profiles, { + supported: true, + discover: async () => ({ ...readyStatus(), canonicalEndpoint: 'https://T-bad.propr.dev' }), + }).discover(), []); + }); + + it('generation-conditionally clears failed intents while keeping prior activations fenced', async () => { + const failed = deferred(); + let calls = 0; + const service = new DesktopConnectDiscoveryService({ + list: async () => ({ profiles: [], activeProfileId: null }), + }, { + supported: true, + discover: async () => calls++ === 0 ? readyStatus() : failed.promise, + }); + await service.discover(); + const active = service.snapshotIdentityClaim( + 'propr-connect-discovered', 'https://t-discovered123.propr.dev', + ); + const rejected = service.discover(); + assert.equal(active.isCurrent(), false); + assert.equal(service.snapshotIdentityClaim( + 'propr-connect-discovered', 'https://t-discovered123.propr.dev', + ).status, 'pending'); + failed.reject(new Error('native discovery failed')); + await assert.rejects(rejected, /native discovery failed/); + const recovered = service.snapshotIdentityClaim( + 'propr-connect-discovered', 'https://t-discovered123.propr.dev', + ); + assert.equal(recovered.status, 'claimed'); + assert.equal(recovered.isCurrent(), true); + assert.equal(active.isCurrent(), false); + + const invalid = new DesktopConnectDiscoveryService({ + list: async () => ({ profiles: [], activeProfileId: null }), + }, { + supported: true, + discover: async () => ({ ...readyStatus(), apiReady: false }), + }); + assert.deepEqual(await invalid.discover(), []); + const manual = invalid.snapshotIdentityClaim('manual-profile', 'https://example.test'); + assert.equal(manual.status, 'unclaimed'); + assert.equal(manual.isCurrent(), true); + + const missingOrManual = new DesktopConnectDiscoveryService({ + list: async () => ({ + profiles: [{ + id: 'manual-profile', label: 'Manual', apiBaseUrl: 'https://example.test', + createdAt: '2026-08-01T00:00:00.000Z', updatedAt: '2026-08-01T00:00:00.000Z', + }], + activeProfileId: null, + }), + }, { supported: true, discover: async () => readyStatus() }); + assert.equal(await missingOrManual.rediscover('missing-profile'), null); + assert.equal(await missingOrManual.rediscover('manual-profile'), null); + for (const profileId of ['missing-profile', 'manual-profile']) { + const claim = missingOrManual.snapshotIdentityClaim(profileId, 'https://example.test'); + assert.equal(claim.status, 'unclaimed'); + assert.equal(claim.isCurrent(), true); + } + }); + + it('scopes discovery freshness per profile and only discards stale same-profile completions', async () => { + const profile = (id: string) => ({ + id, label: id, apiBaseUrl: `https://t-${id}123.propr.dev`, + createdAt: '2026-08-01T00:00:00.000Z', updatedAt: '2026-08-01T00:00:00.000Z', + }); + const profiles = [profile('alpha'), profile('bravo')]; + const calls: Array>> = []; + const service = new DesktopConnectDiscoveryService({ + list: async () => ({ profiles, activeProfileId: null }), + }, { + supported: true, + discover: () => { + const call = deferred(); + calls.push(call); + return call.promise; + }, + }); + + const alpha = service.rediscover('alpha'); + await Promise.resolve(); + const bravo = service.rediscover('bravo'); + await Promise.resolve(); + calls[1].resolve(readyStatus('https://t-bravo456.propr.dev')); + calls[0].resolve(readyStatus('https://t-alpha456.propr.dev')); + assert.equal((await alpha)?.apiBaseUrl, 'https://t-alpha456.propr.dev'); + assert.equal((await bravo)?.apiBaseUrl, 'https://t-bravo456.propr.dev'); + + const stale = service.rediscover('alpha'); + await Promise.resolve(); + const current = service.rediscover('alpha'); + await Promise.resolve(); + calls[2].resolve(readyStatus('https://t-alpha789.propr.dev')); + assert.equal(await stale, null); + assert.equal(service.snapshotIdentityClaim('alpha', 'https://t-alpha456.propr.dev').status, 'pending'); + calls[3].resolve(readyStatus('https://t-alpha999.propr.dev')); + assert.equal((await current)?.apiBaseUrl, 'https://t-alpha999.propr.dev'); + }); +}); diff --git a/apps/desktop/src/connect-discovery.ts b/apps/desktop/src/connect-discovery.ts new file mode 100644 index 000000000..c7f9462ae --- /dev/null +++ b/apps/desktop/src/connect-discovery.ts @@ -0,0 +1,241 @@ +import { isPublicInstanceIdentity, parseProprConnectEndpoint } from '@propr/shared'; +import type { ConnectStatusDocument } from '@propr/cli/desktop-discovery'; +import type { ProfileStore } from './profile-store'; +import type { DesktopDiscoveryCandidate } from './shared/contract'; + +const PROFILE_ID_PATTERN = /^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$/; + +type RediscoveryProfile = Awaited['list']>>['profiles'][number]; + +export type DesktopConnectIdentityClaimSnapshot = Readonly< + | { status: 'unclaimed'; isCurrent(): boolean; beginCommit(): (() => void) | null } + | { + status: 'pending'; + generation: number; + isCurrent(): false; + beginCommit(): null; + } + | { + status: 'origin-mismatch'; + generation: number; + isCurrent(): boolean; + beginCommit(): (() => void) | null; + } + | { + status: 'claimed'; + generation: number; + publicInstanceIdentity: string; + isCurrent(): boolean; + beginCommit(): (() => void) | null; + } +>; + +export interface ConnectDiscoverySource { + readonly supported: boolean; + discover(): Promise; +} + +const candidateFromStatus = (status: ConnectStatusDocument): DesktopDiscoveryCandidate | null => { + const endpoint = status.canonicalEndpoint === null + ? null + : parseProprConnectEndpoint(status.canonicalEndpoint); + if ( + status.status !== 'ready' + || !status.apiReady + || !endpoint + || !isPublicInstanceIdentity(status.publicInstanceIdentity) + ) return null; + return { + // One fixed main-owned CLI configuration selects one native stack root. + // A constant UI identity avoids projecting even a hash of native evidence. + id: 'propr-connect-discovered', + label: 'ProPR Connect', + apiBaseUrl: endpoint.origin, + }; +}; + +const sameRediscoveryProfile = (left: RediscoveryProfile, right: RediscoveryProfile): boolean => + left.id === right.id + && left.label === right.label + && left.apiBaseUrl === right.apiBaseUrl + && left.createdAt === right.createdAt + && left.updatedAt === right.updatedAt; + +export class DesktopConnectDiscoveryService { + readonly #identityClaims = new Map(); + #identityClaimGeneration = 0; + readonly #claimIntentGenerations = new Map(); + readonly #pendingClaimIntents = new Map(); + readonly #claimCommitLocks = new Set(); + readonly #claimCommitWaiters = new Map void>>(); + + constructor( + private readonly profiles: Pick, + private readonly source: ConnectDiscoverySource, + ) {} + + get supported(): boolean { + return this.source.supported; + } + + async discover(): Promise { + if (!this.source.supported) throw new Error('Connect discovery is unavailable'); + const profileId = 'propr-connect-discovered'; + const intentGeneration = this.#beginClaimIntent(profileId); + try { + const pendingCommit = this.#waitForClaimCommit(profileId); + if (pendingCommit) await pendingCommit; + const status = await this.source.discover(); + const candidate = candidateFromStatus(status); + if (!this.#claimIntentIsCurrent(profileId, intentGeneration)) return []; + if (candidate) this.#publishIdentityClaim( + candidate.id, candidate.apiBaseUrl, status.publicInstanceIdentity!, intentGeneration, + ); + return candidate ? [candidate] : []; + } finally { + this.#finishClaimIntent(profileId, intentGeneration); + } + } + + async rediscover(profileId: unknown): Promise { + if (!this.source.supported || typeof profileId !== 'string' || !PROFILE_ID_PATTERN.test(profileId)) { + throw new Error('Connect rediscovery is unavailable'); + } + const intentGeneration = this.#beginClaimIntent(profileId); + try { + const pendingCommit = this.#waitForClaimCommit(profileId); + if (pendingCommit) await pendingCommit; + const current = (await this.profiles.list()).profiles.find(profile => profile.id === profileId); + const currentEndpoint = current ? parseProprConnectEndpoint(current.apiBaseUrl) : null; + if (!current || !currentEndpoint) return null; + const status = await this.source.discover(); + const candidate = candidateFromStatus(status); + if (!candidate) return null; + const revalidated = (await this.profiles.list()).profiles.find(profile => profile.id === profileId); + const revalidatedEndpoint = revalidated ? parseProprConnectEndpoint(revalidated.apiBaseUrl) : null; + if (!revalidated + || !revalidatedEndpoint + || revalidatedEndpoint.origin !== currentEndpoint.origin + || !sameRediscoveryProfile(current, revalidated) + || !this.#claimIntentIsCurrent(profileId, intentGeneration)) return null; + this.#publishIdentityClaim( + current.id, candidate.apiBaseUrl, status.publicInstanceIdentity!, intentGeneration, + ); + return { + id: current.id, + label: current.label, + apiBaseUrl: candidate.apiBaseUrl, + }; + } finally { + this.#finishClaimIntent(profileId, intentGeneration); + } + } + + snapshotIdentityClaim(profileId: string, origin: string): DesktopConnectIdentityClaimSnapshot { + const claim = this.#identityClaims.get(profileId); + const intentGeneration = this.#claimIntentGeneration(profileId); + const isCurrent = () => this.#identityClaims.get(profileId) === claim + && this.#claimIntentGeneration(profileId) === intentGeneration + && !this.#pendingClaimIntents.has(profileId); + const beginCommit = () => this.#beginClaimCommit(profileId, isCurrent); + const pendingIntent = this.#pendingClaimIntents.get(profileId); + if (pendingIntent !== undefined) { + return Object.freeze({ + status: 'pending' as const, + generation: pendingIntent, + isCurrent: () => false as const, + beginCommit: () => null, + }); + } + if (!claim) { + return Object.freeze({ + status: 'unclaimed' as const, + isCurrent, + beginCommit, + }); + } + if (claim.origin !== origin) { + return Object.freeze({ + status: 'origin-mismatch' as const, + generation: claim.generation, + isCurrent, + beginCommit, + }); + } + return Object.freeze({ + status: 'claimed' as const, + generation: claim.generation, + publicInstanceIdentity: claim.publicInstanceIdentity, + isCurrent, + beginCommit, + }); + } + + #claimIntentGeneration(profileId: string): number { + return this.#claimIntentGenerations.get(profileId) ?? 0; + } + + #beginClaimIntent(profileId: string): number { + const generation = this.#claimIntentGeneration(profileId) + 1; + this.#claimIntentGenerations.set(profileId, generation); + // Publish pending synchronously before the first await. Existing active + // snapshots become stale immediately, and no later pairing can acquire the + // commit gate while native discovery is unresolved. + this.#pendingClaimIntents.set(profileId, generation); + return generation; + } + + #claimIntentIsCurrent(profileId: string, generation: number): boolean { + return this.#claimIntentGeneration(profileId) === generation + && this.#pendingClaimIntents.get(profileId) === generation; + } + + #finishClaimIntent(profileId: string, generation: number): void { + if (this.#pendingClaimIntents.get(profileId) === generation) { + this.#pendingClaimIntents.delete(profileId); + } + } + + #waitForClaimCommit(profileId: string): Promise | null { + if (!this.#claimCommitLocks.has(profileId)) return null; + return new Promise(resolve => { + const waiters = this.#claimCommitWaiters.get(profileId) ?? []; + waiters.push(resolve); + this.#claimCommitWaiters.set(profileId, waiters); + }); + } + + #beginClaimCommit(profileId: string, isCurrent: () => boolean): (() => void) | null { + if (!isCurrent() || this.#claimCommitLocks.has(profileId)) return null; + this.#claimCommitLocks.add(profileId); + let released = false; + return () => { + if (released) return; + released = true; + this.#claimCommitLocks.delete(profileId); + const waiters = this.#claimCommitWaiters.get(profileId) ?? []; + this.#claimCommitWaiters.delete(profileId); + waiters.forEach(resolve => resolve()); + }; + } + + #publishIdentityClaim( + profileId: string, + origin: string, + publicInstanceIdentity: string, + intentGeneration: number, + ): void { + if (!this.#claimIntentIsCurrent(profileId, intentGeneration) + || this.#claimCommitLocks.has(profileId)) return; + this.#identityClaims.set(profileId, { + origin, + publicInstanceIdentity, + generation: ++this.#identityClaimGeneration, + }); + this.#pendingClaimIntents.delete(profileId); + } +} diff --git a/apps/desktop/src/credential-service.pairing-browser.test.ts b/apps/desktop/src/credential-service.pairing-browser.test.ts new file mode 100644 index 000000000..e732d32cc --- /dev/null +++ b/apps/desktop/src/credential-service.pairing-browser.test.ts @@ -0,0 +1,174 @@ +import assert from 'node:assert/strict'; +import { mkdtemp, rm } from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import { afterEach, describe, it } from 'node:test'; +import { + DESKTOP_TRANSPORT_SCOPE_HEADER, + PROPR_API_COMPATIBILITY, + PROPR_UI_COMPATIBILITY, +} from '@propr/shared'; +import { DesktopCredentialService, type DesktopPairingBrowserRequest } from './credential-service'; +import { openApprovedDesktopPairingUrl } from './pairing-browser'; +import { ProfileStore, type EncryptionProvider } from './profile-store'; + +const pairingId = `dpr_${'A'.repeat(22)}`; +const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); +const origin = 'https://api.example.test'; +const approvalUrl = `${origin}/api/desktop/pairings/${pairingId}/browser`; +const instanceToken = `propr_it_${'T'.repeat(43)}`; +const temporaryDirectories: string[] = []; +const services: DesktopCredentialService[] = []; + +const encryption: EncryptionProvider = { + isEncryptionAvailable: () => true, + backend: () => 'keychain', + encrypt: value => Buffer.from(value, 'utf8'), + decrypt: value => value.toString('utf8'), +}; + +const json = (body: unknown, status = 200): Response => new Response(JSON.stringify(body), { + status, headers: { 'Content-Type': 'application/json' }, +}); + +const discovery = { + schemaVersion: 1 as const, + product: 'ProPR', + version: '0.8.15', + apiCompatibility: PROPR_API_COMPATIBILITY, + uiCompatibility: PROPR_UI_COMPATIBILITY, + canonicalEndpoint: null, + publicInstanceIdentity: '123e4567-e89b-42d3-a456-426614174000', + desktopAuthentication: { + protocolVersion: 2 as const, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, +}; + +interface PairingProofOptions { + beforeProvisional?(): void; + onRequest?(request: { url: string; authorization: string | null }): void; +} + +const createService = async ( + openPairingBrowser: (request: DesktopPairingBrowserRequest) => Promise, + proof: PairingProofOptions = {}, +): Promise => { + const directory = await mkdtemp(join(tmpdir(), 'propr-pairing-sink-')); + temporaryDirectories.push(directory); + let binding: Record = {}; + const service = new DesktopCredentialService({ + profiles: new ProfileStore(directory, encryption), + clientName: 'Pairing sink test', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser, + fetch: async (input, init) => { + const url = input.toString(); + proof.onRequest?.({ + url, + authorization: new Headers(init?.headers).get('Authorization'), + }); + if (url === `${origin}/api/desktop/discovery`) return json(discovery); + if (url === `${origin}/api/desktop/pairings`) { + const request = JSON.parse(String(init?.body)) as Record; + binding = { + instanceId: request.instanceId, + origin: request.origin, + scope: request.scope, + credentialGeneration: request.credentialGeneration, + }; + return json({ + pairingId, deviceSecret: 'D'.repeat(43), approvalUrl, + expiresAt: new Date(pairingNow + 10_000).toISOString(), interval: 1, + }, 201); + } + if (url.endsWith('/poll')) { + proof.beforeProvisional?.(); + return json({ + status: 'provisional', token: instanceToken, tokenType: 'Bearer', + activationTicket: 'K'.repeat(43), + activationExpiresAt: new Date(pairingNow + 10_000).toISOString(), ...binding, + }); + } + if (url.endsWith('/activate')) return json({ + status: 'active', receipt: 'R'.repeat(22), + activatedAt: '2026-01-01T00:00:01.000Z', expiresAt: null, + }); + if (url === `${origin}/api/auth/user`) { + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${instanceToken}`); + return json({ username: 'remote-owner' }); + } + throw new Error('Unexpected pairing request'); + }, + }); + services.push(service); + return service; +}; + +afterEach(async () => { + await Promise.all(services.splice(0).map(service => service.dispose())); + await Promise.all(temporaryDirectories.splice(0).map(path => rm(path, { recursive: true, force: true }))); +}); + +describe('DesktopCredentialService pairing browser sink', () => { + it('pairs through the browser journey and rejects a response URL replacement', async () => { + const opened: string[] = []; + const requests: Array<{ url: string; authorization: string | null }> = []; + let browserApproved = false; + const service = await createService(request => openApprovedDesktopPairingUrl(request, { + openExternal: async url => { + opened.push(url); + // Models the explicit approval click in the independently authenticated + // system browser. The polling fixture refuses to issue a provisional + // credential until this manual browser step has completed. + browserApproved = true; + }, + }), { + beforeProvisional: () => assert.equal(browserApproved, true), + onRequest: request => requests.push(request), + }); + + const profile = { id: 'profile-a', label: 'Remote ProPR', apiBaseUrl: origin }; + const initialProbe = await service.probe(profile); + assert.equal(initialProbe.status, 'authentication-required'); + const paired = await service.pair(profile); + const probed = await service.probe(profile); + assert.equal(probed.status, 'ready'); + if (probed.status !== 'ready') return; + const activated = await service.activate(probed.activationTicket); + + assert.deepEqual(paired, { paired: true }); + assert.deepEqual(opened, [approvalUrl]); + assert.deepEqual(requests.map(request => request.url), [ + `${origin}/api/desktop/discovery`, + `${origin}/api/desktop/discovery`, + `${origin}/api/desktop/pairings`, + `${origin}/api/desktop/pairings/${pairingId}/poll`, + `${origin}/api/desktop/pairings/${pairingId}/activate`, + `${origin}/api/desktop/discovery`, + `${origin}/api/auth/user`, + ]); + assert.deepEqual(requests.map(request => request.authorization), [ + null, null, null, null, null, null, `Bearer ${instanceToken}`, + ]); + assert.deepEqual(service.prepareRequest( + `${origin}/api/tasks`, + { [DESKTOP_TRANSPORT_SCOPE_HEADER]: activated.transportScope }, + ).requestHeaders, { Authorization: `Bearer ${instanceToken}` }); + assert.equal(JSON.stringify([initialProbe, paired, probed, activated, opened]).includes(instanceToken), false); + + const replacedOpened: string[] = []; + const replacedService = await createService(request => openApprovedDesktopPairingUrl({ + ...request, + approvalUrl: `${origin}/api/desktop/pairings/dpr_${'B'.repeat(22)}/browser`, + }, { openExternal: async url => { replacedOpened.push(url); } })); + + await assert.rejects( + replacedService.pair({ id: 'profile-a', label: 'A', apiBaseUrl: origin }), + /Desktop pairing browser request was rejected/, + ); + assert.deepEqual(replacedOpened, []); + }); +}); diff --git a/apps/desktop/src/credential-service.test.ts b/apps/desktop/src/credential-service.test.ts new file mode 100644 index 000000000..39b1b00e3 --- /dev/null +++ b/apps/desktop/src/credential-service.test.ts @@ -0,0 +1,2669 @@ +import assert from 'node:assert/strict'; +import { spawn } from 'node:child_process'; +import { mkdir, mkdtemp, rm } from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import { afterEach, describe, it } from 'node:test'; +import { + DESKTOP_RENDERER_ORIGIN, + DESKTOP_REVOCATION_BINDING_HEADER, + DESKTOP_TOKEN_REVOCATION_ENDPOINT, + DESKTOP_TOKEN_REVOCATION_SCHEMA, + DESKTOP_TOKEN_REVOCATION_VERSION, + PROPR_API_COMPATIBILITY, + PROPR_UI_COMPATIBILITY, +} from '@propr/shared'; +import type { ConnectStatusDocument } from '@propr/cli/desktop-discovery'; +import { DesktopCredentialService } from './credential-service'; +import { DesktopConnectDiscoveryService } from './connect-discovery'; +import { ProfileStore, type EncryptionProvider, type StoredCredential } from './profile-store'; + +const temporaryDirectories: string[] = []; +const credentialServices: DesktopCredentialService[] = []; +const encryption: EncryptionProvider = { + isEncryptionAvailable: () => true, + backend: () => 'keychain', + encrypt: value => Buffer.from(value, 'utf8'), + decrypt: value => value.toString('utf8'), +}; +const json = (body: unknown, status = 200): Response => new Response(JSON.stringify(body), { + status, + headers: { 'Content-Type': 'application/json' }, +}); +const testPairingBindings = new Map>(); +const pairingStartResponse = ( + url: string, + init: RequestInit | undefined, + body: Record, + status = 201, +): Response => { + const request = JSON.parse(String(init?.body)) as Record; + testPairingBindings.set(new URL(url).origin, { + instanceId: request.instanceId, + origin: request.origin, + scope: request.scope, + credentialGeneration: request.credentialGeneration, + activationExpiresAt: body.expiresAt, + }); + return json(body, status); +}; +const provisionalPairingResponse = (url: string, credentialToken: string): Response => json({ + status: 'provisional', + token: credentialToken, + tokenType: 'Bearer', + activationTicket: 'T'.repeat(43), + ...testPairingBindings.get(new URL(url).origin), +}); +const pairingActivationReceipt = (): Response => json({ + status: 'active', + receipt: 'R'.repeat(22), + activatedAt: '2026-01-01T00:00:01.000Z', + expiresAt: null, +}); +const terminalRevocationBody = ( + init: RequestInit | undefined, + code: 'TOKEN_NOT_FOUND' | 'INSTANCE_TOKEN_REVOKED' | 'INSTANCE_TOKEN_EXPIRED' = 'TOKEN_NOT_FOUND', +): Record => ({ + schema: DESKTOP_TOKEN_REVOCATION_SCHEMA, + version: DESKTOP_TOKEN_REVOCATION_VERSION, + endpoint: DESKTOP_TOKEN_REVOCATION_ENDPOINT, + terminal: true, + code, + credentialGeneration: new Headers(init?.headers).get(DESKTOP_REVOCATION_BINDING_HEADER), +}); +const terminalRevocation = ( + init: RequestInit | undefined, + code: 'TOKEN_NOT_FOUND' | 'INSTANCE_TOKEN_REVOKED' | 'INSTANCE_TOKEN_EXPIRED' = 'TOKEN_NOT_FOUND', +): Response => json(terminalRevocationBody(init, code), code === 'TOKEN_NOT_FOUND' ? 404 : 401); +const discovery = { + schemaVersion: 1 as const, + product: 'ProPR', + version: '0.8.15', + apiCompatibility: PROPR_API_COMPATIBILITY, + uiCompatibility: PROPR_UI_COMPATIBILITY, + canonicalEndpoint: null, + publicInstanceIdentity: '123e4567-e89b-42d3-a456-426614174000', + desktopAuthentication: { + protocolVersion: 2 as const, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, +}; +const token = (character: string) => `propr_it_${character.repeat(43)}`; +const credential = (profileId: string, origin: string, character: string): StoredCredential => ({ + version: 2, + profileId, + origin, + publicInstanceIdentity: discovery.publicInstanceIdentity, + token: token(character), +}); +const connectStatus = ( + endpoint: string, + publicInstanceIdentity: string, +): ConnectStatusDocument => ({ + schemaVersion: 1, + status: 'ready', + canonicalEndpoint: endpoint, + publicInstanceIdentity, + configured: true, + enabled: true, + sidecarRunning: true, + apiReady: true, + restartRequired: false, + compatibility: '2026-08-01', + version: '0.8.15', + reasonCodes: [], +}); +const deferred = () => { + let resolve!: (value: T) => void; + const promise = new Promise(settle => { resolve = settle; }); + return { promise, resolve }; +}; +const transportHeaders = (transportScope: string, headers: Record = {}) => ({ + ...headers, + 'X-ProPR-Desktop-Transport-Scope': transportScope, +}); + +const createStore = async (): Promise => { + const directory = await mkdtemp(join(tmpdir(), 'propr-credential-service-')); + temporaryDirectories.push(directory); + return new ProfileStore(directory, encryption); +}; + +const createCredentialService = ( + dependencies: ConstructorParameters[0], +): DesktopCredentialService => { + const suppliedFetch = dependencies.fetch; + const service = new DesktopCredentialService({ + ...dependencies, + fetch: async (input, init) => { + if (!input.toString().endsWith('/api/desktop/discovery')) return suppliedFetch(input, init); + try { + const response = await suppliedFetch(input, init); + if (response.status === 200 + && response.headers.get('content-type')?.includes('application/json')) return response; + } catch (error) { + if (init?.signal?.aborted) throw error; + // Legacy fixtures below model only the post-discovery operation. They + // still cross the real strict parser using this complete document. + } + return json(discovery); + }, + }); + credentialServices.push(service); + return service; +}; + +afterEach(async () => { + await Promise.all(credentialServices.splice(0).map(service => service.dispose())); + await Promise.all(temporaryDirectories.splice(0).map(directory => rm(directory, { recursive: true, force: true }))); +}); + +describe('main-process desktop credential service', () => { + it('fails a relaunched same-origin replacement closed before sending the stored bearer', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-replaced', label: 'A', apiBaseUrl: 'https://a.example.test' }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + const requests: Array<{ url: string; authorization: string | null }> = []; + const replacementDiscovery = { + ...discovery, + publicInstanceIdentity: 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa', + }; + const service = new DesktopCredentialService({ + profiles: store, + clientName: 'Relaunch identity test', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + requests.push({ + url: input.toString(), + authorization: new Headers(init?.headers).get('Authorization'), + }); + return json(replacementDiscovery); + }, + }); + credentialServices.push(service); + + const result = await service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + + assert.equal(result.status, 'authentication-required'); + assert.ok(requests.length >= 1); + assert.equal(requests[0].url, `${profile.apiBaseUrl}/api/desktop/discovery`); + assert.equal(requests.some(request => request.authorization !== null), false); + assert.equal(await store.readCredential(profile.id), null); + }); + + it('fails malformed identity closed and classifies legacy public-discovery 401 safely', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-malformed', label: 'A', apiBaseUrl: 'https://a.example.test' }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + const authorizations: Array = []; + const service = new DesktopCredentialService({ + profiles: store, + clientName: 'Malformed relaunch test', + openPairingBrowser: async () => undefined, + fetch: async (_input, init) => { + authorizations.push(new Headers(init?.headers).get('Authorization')); + const { publicInstanceIdentity: _missing, ...malformed } = discovery; + return json(malformed); + }, + }); + credentialServices.push(service); + + const result = await service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + + assert.equal(result.status, 'authentication-required'); + assert.equal(authorizations.some(Boolean), false); + assert.equal(await store.readCredential(profile.id), null); + + const legacyStore = await createStore(); + const requests: Array<{ url: string; authorization: string | null }> = []; + const legacyService = new DesktopCredentialService({ + profiles: legacyStore, + clientName: 'Legacy remote test', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + requests.push({ + url: input.toString(), + authorization: new Headers(init?.headers).get('Authorization'), + }); + return json({ error: 'Unauthorized' }, 401); + }, + }); + credentialServices.push(legacyService); + + const legacyResult = await legacyService.probe({ + id: 'legacy-remote', + label: 'Legacy remote', + apiBaseUrl: 'https://legacy.example.test', + }); + + assert.deepEqual(legacyResult, { + status: 'incompatible', + message: 'This instance requires authentication for public desktop discovery. Check its proxy configuration or update ProPR, then try again.', + }); + assert.deepEqual(requests, [{ + url: 'https://legacy.example.test/api/desktop/discovery', + authorization: null, + }]); + assert.doesNotMatch(JSON.stringify(legacyResult), /Unauthorized|AUTHENTICATION_REQUIRED/); + + const rejectedLegacyBodies = [ + '{"error":"Unauthorized","policy":"private policy detail"}', + '{"error":"Unauthorized","error":"Unauthorized"}', + '{"code":"AUTHENTICATION_REQUIRED"}', + ]; + for (const [index, body] of rejectedLegacyBodies.entries()) { + const adversarialStore = await createStore(); + let adversarialRequests = 0; + const adversarialService = new DesktopCredentialService({ + profiles: adversarialStore, + clientName: 'Adversarial legacy remote test', + openPairingBrowser: async () => undefined, + fetch: async (_input, init) => { + adversarialRequests += 1; + assert.equal(new Headers(init?.headers).get('Authorization'), null); + return new Response(body, { + status: 401, headers: { 'Content-Type': 'application/json' }, + }); + }, + }); + credentialServices.push(adversarialService); + + const rejected = await adversarialService.probe({ + id: `rejected-legacy-${index}`, + label: 'Rejected legacy remote', + apiBaseUrl: `https://rejected-${index}.example.test`, + }); + + assert.equal(rejected.status, 'authentication-required'); + assert.equal(adversarialRequests, 1); + assert.doesNotMatch(JSON.stringify(rejected), /private policy detail|Unauthorized|AUTHENTICATION_REQUIRED/); + } + }); + + it('revalidates an old Socket.IO reconnect and sends zero bearer requests after identity rotation', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-socket-rotation', label: 'A', apiBaseUrl: 'https://a.example.test' }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + let rotated = false; + const requests: Array<{ url: string; authorization: string | null }> = []; + const service = new DesktopCredentialService({ + profiles: store, + clientName: 'Socket rotation test', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + const authorization = new Headers(init?.headers).get('Authorization'); + requests.push({ url, authorization }); + if (url.endsWith('/api/desktop/discovery')) return json(rotated + ? { ...discovery, publicInstanceIdentity: 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa' } + : discovery); + return json({ username: 'octocat' }); + }, + }); + credentialServices.push(service); + const ready = await service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + assert.equal(ready.status, 'ready'); + if (ready.status !== 'ready') return; + const active = await service.activate(ready.activationTicket); + rotated = true; + const beforeReconnect = requests.length; + const result = await service.prepareRequestAsync( + `wss://a.example.test/socket.io/?transport=websocket&proprDesktopTransportScope=${active.transportScope}`, + {}, { resourceType: 'webSocket' }, + ); + + assert.deepEqual(result, { cancel: true }); + assert.equal(requests[beforeReconnect].url, `${profile.apiBaseUrl}/api/desktop/discovery`); + assert.equal(requests[beforeReconnect].authorization, null); + assert.equal(requests.slice(beforeReconnect).some(request => request.authorization !== null), false); + assert.equal(await store.readCredential(profile.id), null); + assert.deepEqual(service.prepareRequest( + `${profile.apiBaseUrl}/api/tasks`, transportHeaders(active.transportScope), + ), { cancel: true }); + }); + + it('fences old and concurrently rotated Connect claims through pairing, commit, and transport activation', async () => { + const store = await createStore(); + const origins = { + old: 'https://t-old123.propr.dev', + current: 'https://t-current456.propr.dev', + replacement: 'https://t-replacement789.propr.dev', + } as const; + const identities = { + old: discovery.publicInstanceIdentity, + current: 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa', + replacement: 'bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb', + } as const; + const profile = await store.save({ + id: 'connect-saved', label: 'Saved Connect', apiBaseUrl: origins.old, + }); + const oldCredential: StoredCredential = { + ...credential(profile.id, origins.old, 'A'), + publicInstanceIdentity: identities.old, + }; + await store.writeCredential(oldCredential); + await store.setActive(profile.id); + + let nativeStatus = connectStatus(origins.old, identities.old); + const connect = new DesktopConnectDiscoveryService(store, { + supported: true, + discover: async () => nativeStatus, + }); + assert.deepEqual(await connect.rediscover(profile.id), { + id: profile.id, label: profile.label, apiBaseUrl: origins.old, + }); + const oldClaim = connect.snapshotIdentityClaim(profile.id, origins.old); + assert.equal(oldClaim.status, 'claimed'); + + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + const stalePollStarted = deferred(); + const releaseStalePoll = deferred(); + const requests: Array<{ + url: string; + authorization: string | null; + transportScope: string | null; + body: string | null; + }> = []; + let pairingNumber = 0; + const service = createCredentialService({ + profiles: store, + clientName: 'Connect claim test', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + snapshotConnectIdentityClaim: (profileId, origin) => connect.snapshotIdentityClaim(profileId, origin), + fetch: async (input, init) => { + const url = input.toString(); + const headers = new Headers(init?.headers); + requests.push({ + url, + authorization: headers.get('Authorization'), + transportScope: headers.get('X-ProPR-Desktop-Transport-Scope'), + body: typeof init?.body === 'string' ? init.body : null, + }); + const origin = new URL(url).origin; + const identity = origin === origins.old + ? identities.old + : origin === origins.current ? identities.current : identities.replacement; + if (url.endsWith('/api/desktop/discovery')) { + return json({ ...discovery, publicInstanceIdentity: identity }); + } + if (url.endsWith('/api/auth/user')) return json({ username: 'connect-user' }); + if (url.endsWith('/api/desktop/pairings')) { + pairingNumber += 1; + const pairingCharacter = pairingNumber === 1 ? 'B' : pairingNumber === 2 ? 'C' : 'D'; + return pairingStartResponse(url, init, { + pairingId: `dpr_${pairingCharacter.repeat(22)}`, + deviceSecret: pairingCharacter.repeat(43), + approvalUrl: `${origin}/approve`, + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + } + if (url.includes(`/dpr_${'B'.repeat(22)}/poll`)) { + return provisionalPairingResponse(url, token('B')); + } + if (url.includes(`/dpr_${'C'.repeat(22)}/poll`)) { + stalePollStarted.resolve(); + return releaseStalePoll.promise; + } + if (url.includes(`/dpr_${'D'.repeat(22)}/poll`)) { + return provisionalPairingResponse(url, token('D')); + } + if (url.includes('/activate')) return pairingActivationReceipt(); + if (url.includes(`/dpr_${'C'.repeat(22)}/cancel`)) { + return json({ status: 'cancelled', cancelledAt: '2026-01-01T00:00:02.000Z' }); + } + if (url.endsWith('/api/desktop/tokens/current')) { + const committed = await store.readCredential(profile.id); + if (origin === origins.old) { + assert.equal(committed?.origin, origins.current); + assert.equal(committed?.token, token('B')); + assert.equal(headers.get('Authorization'), `Bearer ${oldCredential.token}`); + } else { + assert.equal(origin, origins.current); + assert.equal(committed?.origin, origins.replacement); + assert.equal(committed?.token, token('D')); + assert.equal(headers.get('Authorization'), `Bearer ${token('B')}`); + } + return new Response(null, { status: 204 }); + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + + const oldReady = await service.probe({ + id: profile.id, label: profile.label, apiBaseUrl: origins.old, + }); + assert.equal(oldReady.status, 'ready'); + if (oldReady.status !== 'ready') return; + const oldActivation = await service.activate(oldReady.activationTicket); + + nativeStatus = connectStatus(origins.current, identities.current); + assert.deepEqual(await connect.rediscover(profile.id), { + id: profile.id, label: profile.label, apiBaseUrl: origins.current, + }); + const currentClaim = connect.snapshotIdentityClaim(profile.id, origins.current); + assert.equal(currentClaim.status, 'claimed'); + assert.equal(oldClaim.isCurrent(), false); + if (oldClaim.status === 'claimed' && currentClaim.status === 'claimed') { + assert.ok(currentClaim.generation > oldClaim.generation); + } + + const beforeDetachedTransport = requests.length; + assert.deepEqual(service.prepareRequest( + `${origins.old}/api/tasks`, transportHeaders(oldActivation.transportScope), + ), { cancel: true }); + assert.deepEqual(await service.prepareRequestAsync( + `wss://${new URL(origins.old).host}/socket.io/?transport=websocket&proprDesktopTransportScope=${oldActivation.transportScope}`, + {}, { resourceType: 'webSocket' }, + ), { cancel: true }); + assert.equal(requests.slice(beforeDetachedTransport) + .some(request => request.authorization !== null), false); + + const beforeStaleOrigin = requests.length; + await assert.rejects(service.pair({ + id: profile.id, label: profile.label, apiBaseUrl: origins.old, + }), /Connect origin changed/i); + assert.equal(requests.length, beforeStaleOrigin); + assert.deepEqual(await store.readCredential(profile.id), oldCredential); + + const currentPairingStart = requests.length; + await service.pair({ id: profile.id, label: 'Current Connect', apiBaseUrl: origins.current }); + await service.awaitIdle(); + const currentBinding = testPairingBindings.get(origins.current); + assert.match(String(currentBinding?.credentialGeneration), /^[A-Za-z0-9_-]{22}$/); + assert.deepEqual(await store.readCredential(profile.id), { + version: 2, + profileId: profile.id, + origin: origins.current, + publicInstanceIdentity: identities.current, + token: token('B'), + }); + const currentIdentityMatch = requests.findIndex((request, index) => index >= currentPairingStart + && request.url === `${origins.current}/api/desktop/discovery`); + const oldRevocation = requests.findIndex(request => request.url === `${origins.old}/api/desktop/tokens/current` + && request.authorization === `Bearer ${oldCredential.token}`); + assert.ok(currentIdentityMatch >= currentPairingStart); + assert.ok(oldRevocation > currentIdentityMatch); + assert.equal(requests.slice(currentPairingStart, currentIdentityMatch + 1) + .some(request => request.authorization !== null), false); + assert.equal(requests.slice(currentPairingStart) + .some(request => request.authorization === `Bearer ${oldCredential.token}` + && !request.url.endsWith('/api/desktop/tokens/current')), false); + + const currentReady = await service.probe({ + id: profile.id, label: 'Current Connect', apiBaseUrl: origins.current, + }); + assert.equal(currentReady.status, 'ready'); + if (currentReady.status !== 'ready') return; + const currentActivation = await service.activate(currentReady.activationTicket); + assert.equal(currentActivation.identityEpoch, currentBinding?.credentialGeneration); + assert.notEqual(currentActivation.identityEpoch, oldActivation.identityEpoch); + assert.notEqual(currentActivation.transportScope, oldActivation.transportScope); + assert.deepEqual(service.prepareRequest( + `${origins.old}/api/tasks`, transportHeaders(oldActivation.transportScope), + ), { cancel: true }); + assert.deepEqual(service.prepareRequest( + `wss://${new URL(origins.old).host}/socket.io/?transport=websocket&proprDesktopTransportScope=${oldActivation.transportScope}`, + {}, { resourceType: 'webSocket' }, + ), { cancel: true }); + assert.deepEqual((await service.prepareRequestAsync( + `${origins.current}/api/tasks`, transportHeaders(currentActivation.transportScope), + )).requestHeaders, { Authorization: `Bearer ${token('B')}` }); + assert.deepEqual((await service.prepareRequestAsync( + `wss://${new URL(origins.current).host}/socket.io/?transport=websocket&proprDesktopTransportScope=${currentActivation.transportScope}`, + {}, { resourceType: 'webSocket' }, + )).requestHeaders, { Authorization: `Bearer ${token('B')}` }); + + const concurrentPairingStart = requests.length; + const stalePairing = service.pair({ + id: profile.id, label: 'Stale current Connect', apiBaseUrl: origins.current, + }); + await stalePollStarted.promise; + nativeStatus = connectStatus(origins.replacement, identities.replacement); + assert.deepEqual(await connect.rediscover(profile.id), { + id: profile.id, label: 'Current Connect', apiBaseUrl: origins.replacement, + }); + const replacementClaim = connect.snapshotIdentityClaim(profile.id, origins.replacement); + assert.equal(replacementClaim.status, 'claimed'); + assert.equal(currentClaim.isCurrent(), false); + if (currentClaim.status === 'claimed' && replacementClaim.status === 'claimed') { + assert.ok(replacementClaim.generation > currentClaim.generation); + } + releaseStalePoll.resolve(provisionalPairingResponse( + `${origins.current}/api/desktop/pairings/dpr_${'C'.repeat(22)}/poll`, token('C'), + )); + await assert.rejects(stalePairing, /cancelled/i); + await service.awaitIdle(); + const concurrentRequests = requests.slice(concurrentPairingStart); + assert.equal(concurrentRequests.some(request => request.url.includes('/activate')), false); + assert.equal(concurrentRequests.filter(request => request.url.includes(`/dpr_${'C'.repeat(22)}/cancel`)).length, 1); + assert.equal(concurrentRequests.some(request => request.authorization !== null), false); + assert.equal(concurrentRequests.some(request => request.body?.includes(token('B')) + || request.body?.includes(token('C'))), false); + assert.deepEqual(await store.readCredential(profile.id), { + version: 2, + profileId: profile.id, + origin: origins.current, + publicInstanceIdentity: identities.current, + token: token('B'), + }); + assert.deepEqual(await store.pendingRevocations(), []); + + const replacementPairingStart = requests.length; + await service.pair({ + id: profile.id, label: 'Replacement Connect', apiBaseUrl: origins.replacement, + }); + await service.awaitIdle(); + const replacementBinding = testPairingBindings.get(origins.replacement); + assert.match(String(replacementBinding?.credentialGeneration), /^[A-Za-z0-9_-]{22}$/); + assert.notEqual(replacementBinding?.credentialGeneration, currentBinding?.credentialGeneration); + const replacementIdentityMatch = requests.findIndex((request, index) => index >= replacementPairingStart + && request.url === `${origins.replacement}/api/desktop/discovery`); + const currentRevocation = requests.findIndex((request, index) => index >= replacementPairingStart + && request.url === `${origins.current}/api/desktop/tokens/current` + && request.authorization === `Bearer ${token('B')}`); + assert.ok(replacementIdentityMatch >= replacementPairingStart); + assert.ok(currentRevocation > replacementIdentityMatch); + assert.equal(requests.slice(concurrentPairingStart, replacementIdentityMatch + 1) + .some(request => request.authorization !== null), false); + assert.equal(requests.some(request => request.authorization === `Bearer ${token('C')}`), false); + assert.deepEqual(await store.readCredential(profile.id), { + version: 2, + profileId: profile.id, + origin: origins.replacement, + publicInstanceIdentity: identities.replacement, + token: token('D'), + }); + + const replacementReady = await service.probe({ + id: profile.id, label: 'Replacement Connect', apiBaseUrl: origins.replacement, + }); + assert.equal(replacementReady.status, 'ready'); + if (replacementReady.status !== 'ready') return; + const replacementActivation = await service.activate(replacementReady.activationTicket); + assert.equal(replacementActivation.identityEpoch, replacementBinding?.credentialGeneration); + assert.notEqual(replacementActivation.transportScope, currentActivation.transportScope); + assert.deepEqual(service.prepareRequest( + `${origins.current}/api/tasks`, transportHeaders(currentActivation.transportScope), + ), { cancel: true }); + assert.deepEqual(service.prepareRequest( + `wss://${new URL(origins.current).host}/socket.io/?transport=websocket&proprDesktopTransportScope=${currentActivation.transportScope}`, + {}, { resourceType: 'webSocket' }, + ), { cancel: true }); + assert.deepEqual((await service.prepareRequestAsync( + `${origins.replacement}/api/tasks`, transportHeaders(replacementActivation.transportScope), + )).requestHeaders, { Authorization: `Bearer ${token('D')}` }); + assert.deepEqual((await service.prepareRequestAsync( + `wss://${new URL(origins.replacement).host}/socket.io/?transport=websocket&proprDesktopTransportScope=${replacementActivation.transportScope}`, + {}, { resourceType: 'webSocket' }, + )).requestHeaders, { Authorization: `Bearer ${token('D')}` }); + assert.equal(requests.some(request => request.url.includes(oldActivation.transportScope) + || request.url.includes(currentActivation.transportScope) + || request.transportScope === oldActivation.transportScope + || request.transportScope === currentActivation.transportScope), false); + }); + + it('injects the active bearer only for its bound profile origin and strips renderer identity', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + const wireRequests: Array<{ url: string; headers: Record }> = []; + let service!: DesktopCredentialService; + service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + const requestHeaders: Record = {}; + new Headers(init?.headers).forEach((value, key) => { requestHeaders[key] = value; }); + // Simulate a session cookie Electron might otherwise append after the + // main-process fetch has applied its unforgeable request marker. + requestHeaders.Cookie = 'main-process=session'; + const decision = service.prepareRequest(url, requestHeaders); + assert.equal(decision.cancel, undefined); + wireRequests.push({ url, headers: decision.requestHeaders ?? {} }); + return url.endsWith('/api/desktop/discovery') ? json(discovery) : json({ username: 'octocat' }); + }, + }); + + const result = await service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + assert.equal(result.status, 'ready'); + if (result.status !== 'ready') return; + assert.match(result.activationTicket, /^[A-Za-z0-9_-]{43}$/); + assert.equal('transportScope' in result, false); + const activated = await service.activate(result.activationTicket); + assert.deepEqual((await service.prepareRequestAsync('https://a.example.test/api/tasks', transportHeaders(activated.transportScope, { + Cookie: 'legacy=session', Authorization: 'Bearer renderer-controlled', Accept: 'application/json', + }))).requestHeaders, { + Accept: 'application/json', + Authorization: `Bearer ${token('A')}`, + }); + assert.deepEqual(service.prepareRequest('https://attacker.example.test/api/tasks', transportHeaders(activated.transportScope, { + Cookie: 'inactive=session', Authorization: 'Bearer renderer-controlled', + })), { cancel: true }); + assert.deepEqual(service.prepareRequest('https://a.example.test/assets/app.js', transportHeaders(activated.transportScope, { + Cookie: 'active=session', Authorization: 'Bearer renderer-controlled', + })), { cancel: true }); + assert.deepEqual((await service.prepareRequestAsync(`wss://a.example.test/socket.io/?transport=websocket&proprDesktopTransportScope=${activated.transportScope}`, { + Cookie: 'socket=session', Authorization: 'Bearer renderer-controlled', + }, { resourceType: 'webSocket' })).requestHeaders, { Authorization: `Bearer ${token('A')}` }); + assert.deepEqual((await service.prepareRequestAsync('https://a.example.test/api/tasks', transportHeaders(activated.transportScope, { + Cookie: 'legacy=session', + Authorization: 'Bearer renderer-controlled', + 'X-ProPR-Desktop-Main-Request': 'renderer-forgery', + }))).requestHeaders, { Authorization: `Bearer ${token('A')}` }); + assert.deepEqual(service.prepareRequest('https://a.example.test/api/desktop/pairings', {}), { + cancel: true, + }); + assert.deepEqual(service.prepareRequest('https://a.example.test/api/desktop/tokens/current', {}), { + cancel: true, + }); + assert.deepEqual(service.prepareRequest('http://remote.example.test/api/tasks', {}), { cancel: true }); + assert.deepEqual(service.prepareRequest('http://127.1:3000/api/tasks', {}), { cancel: true }); + assert.deepEqual(service.prepareRequest('http://local%68ost:3000/api/tasks', {}), { cancel: true }); + assert.deepEqual(wireRequests.find(request => request.url.endsWith('/api/auth/user')), { + url: 'https://a.example.test/api/auth/user', + headers: { authorization: `Bearer ${token('A')}` }, + }); + assert.deepEqual(service.sanitizeResponseHeaders('https://a.example.test/api/tasks', { + 'Set-Cookie': ['active=session'], 'X-Test': ['preserved'], + }), { 'X-Test': ['preserved'] }); + assert.deepEqual(service.sanitizeResponseHeaders('https://inactive.example.test/api/tasks', { + 'set-cookie': ['inactive=session'], + }), {}); + assert.deepEqual(service.sanitizeResponseHeaders('wss://inactive.example.test/socket.io/', { + 'SET-COOKIE': ['socket=session'], + }), {}); + assert.deepEqual(await service.discardActivation({ + profileId: profile.id, transportScope: 'wrong-scope', + }), { discarded: false }); + assert.deepEqual(await service.discardActivation(activated), { discarded: true }); + assert.equal((await store.list()).activeProfileId, null); + assert.deepEqual(await store.readCredential(profile.id), credential(profile.id, profile.apiBaseUrl, 'A')); + assert.deepEqual(service.prepareRequest( + profile.apiBaseUrl + '/api/tasks', transportHeaders(activated.transportScope), + ), { cancel: true }); + }); + + it('uses only the active bearer when profiles share an origin and never a cookie identity', async () => { + const store = await createStore(); + const profileA = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://same.example.test' }); + const profileB = await store.save({ id: 'profile-b', label: 'B', apiBaseUrl: 'https://same.example.test' }); + await store.writeCredential(credential(profileA.id, profileA.apiBaseUrl, 'A')); + await store.writeCredential(credential(profileB.id, profileB.apiBaseUrl, 'B')); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async input => input.toString().endsWith('/api/desktop/discovery') + ? json(discovery) + : json({ username: 'octocat' }), + }); + + assert.equal((await service.probe({ + id: profileA.id, label: profileA.label, apiBaseUrl: profileA.apiBaseUrl, + })).status, 'ready'); + const readyB = await service.probe({ + id: profileB.id, label: profileB.label, apiBaseUrl: profileB.apiBaseUrl, + }); + assert.equal(readyB.status, 'ready'); + if (readyB.status !== 'ready') return; + const activatedB = await service.activate(readyB.activationTicket); + + assert.deepEqual((await service.prepareRequestAsync('https://same.example.test/api/tasks', transportHeaders(activatedB.transportScope, { + Cookie: 'profile-a=session', Authorization: `Bearer ${token('A')}`, + }))).requestHeaders, { Authorization: `Bearer ${token('B')}` }); + }); + + it('detaches origin and identity mismatches before bearer use or early protocol exits', async () => { + const store = await createStore(); + const profileB = await store.save({ id: 'profile-b', label: 'B', apiBaseUrl: 'https://b.example.test' }); + await store.writeCredential(credential(profileB.id, 'https://a.example.test', 'A')); + const requests: Array<{ url: string; authorization: string | null }> = []; + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + requests.push({ url, authorization: new Headers(init?.headers).get('Authorization') }); + return json(discovery); + }, + }); + + const result = await service.probe({ + id: profileB.id, label: profileB.label, apiBaseUrl: profileB.apiBaseUrl, + }); + + assert.equal(result.status, 'authentication-required'); + assert.equal('activationTicket' in result, false); + assert.deepEqual(requests, [{ + url: 'https://b.example.test/api/desktop/discovery', + authorization: null, + }]); + assert.equal(requests.some(request => request.url.startsWith('https://a.example.test/')), false); + assert.equal(await store.readCredential(profileB.id), null); + assert.equal((await store.list()).activeProfileId, null); + + const replacementIdentity = '123e4567-e89b-42d3-a456-426614174001'; + for (const [name, replacementDiscovery, expectedStatus] of [ + ['incompatible', { + ...discovery, + version: '99.0.0', + apiCompatibility: '9999-12-31', + publicInstanceIdentity: replacementIdentity, + }, 'incompatible'], + ['capability', { + ...discovery, + publicInstanceIdentity: replacementIdentity, + desktopAuthentication: { + ...discovery.desktopAuthentication, + socketIoBearerAuthentication: false, + }, + }, 'authentication-required'], + ] as const) { + const store = await createStore(); + const profile = await store.save({ + id: `identity-${name}`, label: name, apiBaseUrl: `https://${name}.example.test`, + }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + const requests: Array<{ url: string; authorization: string | null }> = []; + const service = createCredentialService({ + profiles: store, + clientName: 'Identity early-exit test', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + requests.push({ + url: input.toString(), + authorization: new Headers(init?.headers).get('Authorization'), + }); + return json(replacementDiscovery); + }, + }); + + const result = await service.probe({ + id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl, + }); + assert.equal(result.status, expectedStatus); + assert.equal(await store.readCredential(profile.id), null); + assert.ok(requests.length >= 1); + assert.equal(requests.every(request => request.url === `${profile.apiBaseUrl}/api/desktop/discovery` + && request.authorization === null), true); + } + }); + + it('does not mint a ticket when a delayed B probe observes credential replacement with origin A', async () => { + const store = await createStore(); + const profileB = await store.save({ id: 'profile-b', label: 'B', apiBaseUrl: 'https://b.example.test' }); + await store.writeCredential(credential(profileB.id, profileB.apiBaseUrl, 'B')); + const response = deferred(); + const authenticatedRequestStarted = deferred(); + const requests: Array<{ url: string; authorization: string | null }> = []; + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + const authorization = new Headers(init?.headers).get('Authorization'); + requests.push({ url, authorization }); + if (url.endsWith('/api/desktop/discovery')) return json(discovery); + authenticatedRequestStarted.resolve(); + return response.promise; + }, + }); + + const probe = service.probe({ + id: profileB.id, label: profileB.label, apiBaseUrl: profileB.apiBaseUrl, + }); + await authenticatedRequestStarted.promise; + const replacement = credential(profileB.id, 'https://a.example.test', 'A'); + await store.writeCredential(replacement); + response.resolve(json({ username: 'b' })); + const result = await probe; + + assert.equal(result.status, 'offline'); + assert.match(result.message, /connection changed/i); + assert.equal('activationTicket' in result, false); + assert.equal(requests.some(request => request.url.startsWith('https://a.example.test/')), false); + assert.deepEqual(requests.at(-1), { + url: 'https://b.example.test/api/auth/user', + authorization: `Bearer ${token('B')}`, + }); + assert.deepEqual(await store.readCredential(profileB.id), replacement); + assert.equal((await store.list()).activeProfileId, null); + }); + + it('atomically rejects a ticket when delayed activation races with profile B credential A', async () => { + const store = await createStore(); + const profileB = await store.save({ id: 'profile-b', label: 'B', apiBaseUrl: 'https://b.example.test' }); + await store.writeCredential(credential(profileB.id, profileB.apiBaseUrl, 'B')); + const activationStarted = deferred(); + const releaseActivation = deferred(); + const delayedProfiles = new Proxy(store, { + get(target, property, receiver) { + if (property === 'activateProfile') { + return async (...args: Parameters) => { + activationStarted.resolve(); + await releaseActivation.promise; + return target.activateProfile(...args); + }; + } + const value = Reflect.get(target, property, receiver) as unknown; + return typeof value === 'function' ? value.bind(target) : value; + }, + }); + const requests: Array<{ url: string; authorization: string | null }> = []; + const service = createCredentialService({ + profiles: delayedProfiles, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + requests.push({ url, authorization: new Headers(init?.headers).get('Authorization') }); + return url.endsWith('/api/desktop/discovery') ? json(discovery) : json({ username: 'b' }); + }, + }); + const ready = await service.probe({ + id: profileB.id, label: profileB.label, apiBaseUrl: profileB.apiBaseUrl, + }); + assert.equal(ready.status, 'ready'); + if (ready.status !== 'ready') return; + + const activation = service.activate(ready.activationTicket); + await activationStarted.promise; + const staleCredential = credential(profileB.id, 'https://a.example.test', 'A'); + await store.writeCredential(staleCredential); + releaseActivation.resolve(); + + await assert.rejects(activation, /expired/i); + assert.equal(requests.some(request => request.url.startsWith('https://a.example.test/')), false); + assert.deepEqual(await store.readCredential(profileB.id), staleCredential); + assert.equal((await store.list()).activeProfileId, null); + }); + + it('keeps a slow successful same-origin A probe status-only after fast B activates', async () => { + const store = await createStore(); + const profileA = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://same.example.test' }); + const profileB = await store.save({ id: 'profile-b', label: 'B', apiBaseUrl: 'https://same.example.test' }); + await store.writeCredential(credential(profileA.id, profileA.apiBaseUrl, 'A')); + await store.writeCredential(credential(profileB.id, profileB.apiBaseUrl, 'B')); + const releaseA = deferred(); + const startedA = deferred(); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url.endsWith('/api/desktop/discovery')) return json(discovery); + const authorization = new Headers(init?.headers).get('Authorization'); + if (authorization === `Bearer ${token('A')}`) { + startedA.resolve(); + return releaseA.promise; + } + assert.equal(authorization, `Bearer ${token('B')}`); + return json({ username: 'b' }); + }, + }); + + const slowA = service.probe({ id: profileA.id, label: profileA.label, apiBaseUrl: profileA.apiBaseUrl }); + await startedA.promise; + const readyB = await service.probe({ id: profileB.id, label: profileB.label, apiBaseUrl: profileB.apiBaseUrl }); + assert.equal(readyB.status, 'ready'); + if (readyB.status !== 'ready') return; + const activatedB = await service.activate(readyB.activationTicket); + releaseA.resolve(json({ username: 'a' })); + const staleA = await slowA; + + assert.equal(staleA.status, 'offline'); + assert.match(staleA.message, /connection changed/i); + assert.deepEqual((await service.prepareRequestAsync( + 'https://same.example.test/api/tasks', + transportHeaders(activatedB.transportScope), + )).requestHeaders, { Authorization: `Bearer ${token('B')}` }); + }); + + it('keeps A active while B is only probed and if B selection persistence fails', async () => { + const directory = await mkdtemp(join(tmpdir(), 'propr-credential-service-')); + temporaryDirectories.push(directory); + let failActivationState = false; + const store = new ProfileStore(directory, encryption, { + afterDurabilityStep: step => { + if (failActivationState && step === 'state-fsynced') throw new Error('injected activation persistence failure'); + }, + }); + const profileA = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://same.example.test' }); + const profileB = await store.save({ id: 'profile-b', label: 'B', apiBaseUrl: 'https://same.example.test' }); + await store.writeCredential(credential(profileA.id, profileA.apiBaseUrl, 'A')); + await store.writeCredential(credential(profileB.id, profileB.apiBaseUrl, 'B')); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async input => input.toString().endsWith('/api/desktop/discovery') + ? json(discovery) + : json({ username: 'octocat' }), + }); + const probeA = await service.probe({ id: profileA.id, label: profileA.label, apiBaseUrl: profileA.apiBaseUrl }); + assert.equal(probeA.status, 'ready'); + if (probeA.status !== 'ready') return; + const activeA = await service.activate(probeA.activationTicket); + const probeB = await service.probe({ id: profileB.id, label: profileB.label, apiBaseUrl: profileB.apiBaseUrl }); + assert.equal(probeB.status, 'ready'); + if (probeB.status !== 'ready') return; + + assert.equal((await store.list()).activeProfileId, profileA.id); + assert.deepEqual((await service.prepareRequestAsync( + profileA.apiBaseUrl + '/api/tasks', transportHeaders(activeA.transportScope), + )).requestHeaders, { Authorization: `Bearer ${token('A')}` }); + + failActivationState = true; + await assert.rejects(service.activate(probeB.activationTicket)); + failActivationState = false; + assert.notEqual((await store.list()).activeProfileId, profileB.id); + assert.deepEqual((await service.prepareRequestAsync( + profileA.apiBaseUrl + '/api/tasks', transportHeaders(activeA.transportScope), + )).requestHeaders, { Authorization: `Bearer ${token('A')}` }); + }); + + it('keeps B active during a direct same-origin A probe and rejects replayed activation tickets', async () => { + const store = await createStore(); + const profileA = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://same.example.test' }); + const profileB = await store.save({ id: 'profile-b', label: 'B', apiBaseUrl: 'https://same.example.test' }); + await store.writeCredential(credential(profileA.id, profileA.apiBaseUrl, 'A')); + await store.writeCredential(credential(profileB.id, profileB.apiBaseUrl, 'B')); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async input => input.toString().endsWith('/api/desktop/discovery') + ? json(discovery) + : json({ username: 'octocat' }), + }); + const probeB = await service.probe({ id: profileB.id, label: profileB.label, apiBaseUrl: profileB.apiBaseUrl }); + assert.equal(probeB.status, 'ready'); + if (probeB.status !== 'ready') return; + const activeB = await service.activate(probeB.activationTicket); + await assert.rejects(service.activate(probeB.activationTicket), /expired/i); + + const probeA = await service.probe({ id: profileA.id, label: profileA.label, apiBaseUrl: profileA.apiBaseUrl }); + assert.equal(probeA.status, 'ready'); + assert.equal((await store.list()).activeProfileId, profileB.id); + assert.deepEqual((await service.prepareRequestAsync( + profileB.apiBaseUrl + '/api/tasks', transportHeaders(activeB.transportScope), + )).requestHeaders, { Authorization: `Bearer ${token('B')}` }); + }); + + it('rejects activation after candidate removal, selection drift, or exact credential replacement', async () => { + for (const race of ['remove', 'selection', 'credential', 'credential-origin'] as const) { + const store = await createStore(); + const profileA = await store.save({ id: `profile-a-${race}`, label: 'A', apiBaseUrl: 'https://a.example.test' }); + const profileB = await store.save({ id: `profile-b-${race}`, label: 'B', apiBaseUrl: 'https://b.example.test' }); + await store.setActive(profileA.id); + await store.writeCredential(credential(profileB.id, profileB.apiBaseUrl, 'B')); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async input => input.toString().endsWith('/api/desktop/discovery') + ? json(discovery) + : json({ username: 'octocat' }), + }); + const probeB = await service.probe({ id: profileB.id, label: profileB.label, apiBaseUrl: profileB.apiBaseUrl }); + assert.equal(probeB.status, 'ready'); + if (probeB.status !== 'ready') continue; + if (race === 'remove') await service.removeProfile(profileB.id); + else if (race === 'selection') await store.setActive(null); + else if (race === 'credential') { + await store.writeCredential(credential(profileB.id, profileB.apiBaseUrl, 'C')); + } else { + await store.writeCredential(credential(profileB.id, profileA.apiBaseUrl, 'A')); + } + + await assert.rejects(service.activate(probeB.activationTicket), /expired/i); + assert.notEqual((await store.list()).activeProfileId, profileB.id); + if (race === 'credential') { + assert.deepEqual(await store.readCredential(profileB.id), credential(profileB.id, profileB.apiBaseUrl, 'C')); + } else if (race === 'credential-origin') { + assert.deepEqual(await store.readCredential(profileB.id), credential(profileB.id, profileA.apiBaseUrl, 'A')); + } + } + }); + + it('binds REST and Socket.IO work to one fresh scope and rejects stale or malformed markers', async () => { + const store = await createStore(); + const profileA = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://same.example.test' }); + const profileB = await store.save({ id: 'profile-b', label: 'B', apiBaseUrl: 'https://same.example.test' }); + await store.writeCredential(credential(profileA.id, profileA.apiBaseUrl, 'A')); + await store.writeCredential(credential(profileB.id, profileB.apiBaseUrl, 'B')); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async input => input.toString().endsWith('/api/desktop/discovery') + ? json(discovery) + : json({ username: 'octocat' }), + }); + const readyA = await service.probe({ id: profileA.id, label: profileA.label, apiBaseUrl: profileA.apiBaseUrl }); + assert.equal(readyA.status, 'ready'); + if (readyA.status !== 'ready') return; + const activatedA = await service.activate(readyA.activationTicket); + const capturedRestA = transportHeaders(activatedA.transportScope, { + Cookie: 'renderer=session', + Authorization: 'Bearer renderer', + }); + const capturedSocketA = `wss://same.example.test/socket.io/?EIO=4&transport=websocket&proprDesktopTransportScope=${activatedA.transportScope}`; + + const readyB = await service.probe({ id: profileB.id, label: profileB.label, apiBaseUrl: profileB.apiBaseUrl }); + assert.equal(readyB.status, 'ready'); + if (readyB.status !== 'ready') return; + const activatedB = await service.activate(readyB.activationTicket); + + assert.deepEqual(service.prepareRequest('https://same.example.test/api/side-effect', capturedRestA), { cancel: true }); + assert.deepEqual(service.prepareRequest( + 'https://same.example.test/api/planner/drafts/draft-a/attachments/image-a', capturedRestA, + ), { cancel: true }); + assert.deepEqual(service.prepareRequest(capturedSocketA, { Cookie: 'socket=a' }, { resourceType: 'webSocket' }), { cancel: true }); + assert.deepEqual((await service.prepareRequestAsync( + 'https://same.example.test/api/side-effect', + transportHeaders(activatedB.transportScope), + )).requestHeaders, { Authorization: `Bearer ${token('B')}` }); + const currentSocket = `wss://same.example.test/socket.io/?EIO=4&transport=websocket&proprDesktopTransportScope=${activatedB.transportScope}`; + assert.equal((await service.prepareRequestAsync(currentSocket, {}, { resourceType: 'webSocket' })).cancel, undefined); + assert.equal((await service.prepareRequestAsync(currentSocket, {}, { resourceType: 'webSocket' })).cancel, undefined); + assert.deepEqual(service.prepareRequest('wss://same.example.test/socket.io/?transport=websocket', {}, { + resourceType: 'webSocket', + }), { cancel: true }); + assert.deepEqual(service.prepareRequest(`${currentSocket}&proprDesktopTransportScope=${activatedB.transportScope}`, {}, { + resourceType: 'webSocket', + }), { cancel: true }); + assert.deepEqual(service.prepareRequest( + 'https://same.example.test/api/tasks', + { 'X-ProPR-Desktop-Transport-Scope': ['bad', activatedB.transportScope], Cookie: 'x', Authorization: 'Bearer x' }, + ), { cancel: true }); + assert.deepEqual(service.prepareRequest( + 'https://same.example.test/api/tasks', + { 'X-ProPR-Desktop-Transport-Scope': 'not-a-scope', Cookie: 'x', Authorization: 'Bearer x' }, + ), { cancel: true }); + assert.deepEqual(service.prepareRequest('https://same.example.test/api/tasks', { + Cookie: 'x', Authorization: 'Bearer x', Accept: 'application/json', + }).requestHeaders, { Accept: 'application/json' }); + assert.deepEqual(service.prepareRequest('https://same.example.test/api/tasks', transportHeaders(activatedB.transportScope, { + Cookie: 'x', Authorization: 'Bearer x', + 'Access-Control-Request-Headers': 'x-propr-desktop-transport-scope,content-type', + }), { method: 'OPTIONS' }).requestHeaders, { + 'Access-Control-Request-Headers': 'x-propr-desktop-transport-scope,content-type', + }); + }); + + it('passes through a realistic packaged-origin CORS preflight without renderer identity or bearer injection', () => { + const service = createCredentialService({ + profiles: { awaitIdle: async () => undefined } as unknown as ProfileStore, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async () => { throw new Error('Network is not expected'); }, + }); + + assert.deepEqual(service.prepareRequest('https://same.example.test/api/tasks', { + Origin: DESKTOP_RENDERER_ORIGIN, + Cookie: 'renderer=session', + Authorization: 'Bearer renderer-controlled', + 'Access-Control-Request-Method': 'POST', + 'Access-Control-Request-Headers': 'X-ProPR-Desktop-Transport-Scope, Content-Type', + }, { method: 'OPTIONS' }), { + requestHeaders: { + Origin: DESKTOP_RENDERER_ORIGIN, + 'Access-Control-Request-Method': 'POST', + 'Access-Control-Request-Headers': 'X-ProPR-Desktop-Transport-Scope, Content-Type', + }, + }); + }); + + it('rotates scope on every same-profile reprobe and rejects a cold reconnect from the old activation', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'http://localhost:3000' }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async input => input.toString().endsWith('/api/desktop/discovery') + ? json(discovery) + : json({ username: 'octocat' }), + }); + const first = await service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + assert.equal(first.status, 'ready'); + if (first.status !== 'ready') return; + const firstActivation = await service.activate(first.activationTicket); + const second = await service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + assert.equal(second.status, 'ready'); + if (second.status !== 'ready') return; + const secondActivation = await service.activate(second.activationTicket); + assert.notEqual(firstActivation.transportScope, secondActivation.transportScope); + assert.equal(firstActivation.identityEpoch, secondActivation.identityEpoch); + assert.match(firstActivation.identityEpoch, /^[A-Za-z0-9_-]{22}$/); + assert.match(firstActivation.transportScope, /^[A-Za-z0-9_-]{22}$/); + assert.deepEqual(service.prepareRequest( + 'http://localhost:3000/api/tasks', transportHeaders(firstActivation.transportScope), + ), { cancel: true }); + assert.deepEqual(service.prepareRequest( + `ws://localhost:3000/socket.io/?transport=websocket&proprDesktopTransportScope=${firstActivation.transportScope}`, + {}, { resourceType: 'webSocket' }, + ), { cancel: true }); + assert.equal((await service.prepareRequestAsync( + `ws://localhost:3000/socket.io/?transport=websocket&proprDesktopTransportScope=${secondActivation.transportScope}`, + {}, { resourceType: 'webSocket' }, + )).requestHeaders?.Authorization, `Bearer ${token('A')}`); + }); + + it('never sends an A-origin bearer after the profile URL is edited to an attacker origin', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + const attackerOrigin = 'https://attacker.example.test'; + const requests: Array<{ url: string; authorization: string | null }> = []; + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + requests.push({ url, authorization: new Headers(init?.headers).get('Authorization') }); + if (url.endsWith('/api/desktop/discovery')) return json(discovery); + return new Response(null, { status: 204 }); + }, + }); + + const result = await service.probe({ + id: profile.id, + label: profile.label, + apiBaseUrl: attackerOrigin, + }); + + const attackerRequests = requests.filter(request => new URL(request.url).origin === attackerOrigin); + assert.equal(result.status, 'authentication-required'); + assert.notEqual(attackerRequests.length, 0); + assert.equal(attackerRequests.every(request => request.authorization === null), true); + assert.equal(requests.some(request => request.url === 'https://a.example.test/api/desktop/tokens/current'), false); + assert.deepEqual(await store.readCredential(profile.id), credential(profile.id, profile.apiBaseUrl, 'A')); + }); + + it('preserves a re-paired credential and current connection after a stale definitive probe response', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const oldCredential = credential(profile.id, profile.apiBaseUrl, 'A'); + const replacement = credential(profile.id, profile.apiBaseUrl, 'B'); + await store.writeCredential(oldCredential); + const oldProbeResponse = deferred(); + const oldProbePending = deferred(); + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + const authorization = new Headers(init?.headers).get('Authorization'); + if (url.endsWith('/api/desktop/discovery')) return json(discovery); + if (url.endsWith('/api/desktop/pairings')) return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'C'.repeat(43), + approvalUrl: 'https://a.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + if (url.endsWith('/poll')) return provisionalPairingResponse(url, replacement.token); + if (url.endsWith('/activate')) return pairingActivationReceipt(); + if (url.endsWith('/api/auth/user') && authorization === `Bearer ${oldCredential.token}`) { + oldProbePending.resolve(); + return oldProbeResponse.promise; + } + if (url.endsWith('/api/auth/user') && authorization === `Bearer ${replacement.token}`) { + return json({ username: 'replacement' }); + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + + const staleProbe = service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + await oldProbePending.promise; + await service.pair({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + const current = await service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + assert.equal(current.status, 'ready'); + const currentActivation = current.status === 'ready' ? await service.activate(current.activationTicket) : null; + + oldProbeResponse.resolve(json({ code: 'INVALID_INSTANCE_TOKEN' }, 401)); + const staleResult = await staleProbe; + + assert.equal(staleResult.status, 'offline'); + assert.match(staleResult.message, /connection changed.*try again/i); + assert.deepEqual(await store.readCredential(profile.id), replacement); + if (!currentActivation) return; + assert.deepEqual((await service.prepareRequestAsync('https://a.example.test/api/tasks', transportHeaders(currentActivation.transportScope, {}))).requestHeaders, { + Authorization: `Bearer ${replacement.token}`, + }); + }); + + it('preserves a replacement credential at a changed origin after a stale definitive probe response', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const oldCredential = credential(profile.id, profile.apiBaseUrl, 'A'); + const replacement = credential(profile.id, 'https://b.example.test', 'B'); + await store.writeCredential(oldCredential); + const oldProbeResponse = deferred(); + const oldProbePending = deferred(); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + const authorization = new Headers(init?.headers).get('Authorization'); + if (url.endsWith('/api/desktop/discovery')) return json(discovery); + if (url === 'https://a.example.test/api/desktop/tokens/current') return new Response(null, { status: 204 }); + if (url.endsWith('/api/auth/user') && authorization === `Bearer ${oldCredential.token}`) { + oldProbePending.resolve(); + return oldProbeResponse.promise; + } + if (url === 'https://b.example.test/api/auth/user' + && authorization === `Bearer ${replacement.token}`) return json({ username: 'replacement' }); + throw new Error(`Unexpected request: ${url}`); + }, + }); + + const staleProbe = service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + await oldProbePending.promise; + const changed = await service.saveProfile({ + id: profile.id, + label: profile.label, + apiBaseUrl: replacement.origin, + }); + await store.writeCredential(replacement); + const current = await service.probe({ id: changed.id, label: changed.label, apiBaseUrl: changed.apiBaseUrl }); + assert.equal(current.status, 'ready'); + const currentActivation = current.status === 'ready' ? await service.activate(current.activationTicket) : null; + + oldProbeResponse.resolve(json({ code: 'INVALID_INSTANCE_TOKEN' }, 401)); + const staleResult = await staleProbe; + + assert.equal(staleResult.status, 'offline'); + assert.match(staleResult.message, /connection changed.*try again/i); + assert.deepEqual(await store.readCredential(profile.id), replacement); + if (!currentActivation) return; + assert.deepEqual((await service.prepareRequestAsync('https://b.example.test/api/tasks', transportHeaders(currentActivation.transportScope, {}))).requestHeaders, { + Authorization: `Bearer ${replacement.token}`, + }); + }); + + for (const failure of ['browser-launch', 'cancellation', 'expiry', 'polling', 'secure-storage'] as const) { + it(`preserves the active profile and credential when an origin edit fails during ${failure}`, async () => { + const directory = await mkdtemp(join(tmpdir(), 'propr-credential-service-')); + temporaryDirectories.push(directory); + let rejectReplacementEncryption = false; + const provider: EncryptionProvider = { + ...encryption, + encrypt: value => { + const stored = JSON.parse(value) as StoredCredential; + if (rejectReplacementEncryption && stored.token === token('B')) { + throw new Error('keychain encrypt failed'); + } + return Buffer.from(value, 'utf8'); + }, + }; + const store = new ProfileStore(directory, provider); + const profile = await store.save({ + id: 'profile-a', label: 'Working A', apiBaseUrl: 'https://a.example.test', + }); + const oldCredential = credential(profile.id, profile.apiBaseUrl, 'A'); + await store.writeCredential(oldCredential); + await store.setActive(profile.id); + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + const requests: Array<{ url: string; authorization: string | null }> = []; + let service!: DesktopCredentialService; + service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => { + if (failure === 'browser-launch') throw new Error('Browser launch failed.'); + if (failure === 'cancellation') service.cancelPairing(profile.id); + }, + fetch: async (input, init) => { + const url = input.toString(); + const authorization = new Headers(init?.headers).get('Authorization'); + requests.push({ url, authorization }); + if (url === 'https://a.example.test/api/desktop/discovery') return json(discovery); + if (url === 'https://a.example.test/api/auth/user') return json({ username: 'working-a' }); + if (url === 'https://b.example.test/api/desktop/pairings') return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'C'.repeat(43), + approvalUrl: 'https://b.example.test/approve', + expiresAt: new Date(pairingNow + (failure === 'expiry' ? -1 : 10_000)).toISOString(), + interval: 1, + }, 201); + if (url.endsWith('/poll')) { + if (failure === 'polling') throw new Error('Pairing poll failed.'); + return provisionalPairingResponse(url, token('B')); + } + if (url.endsWith('/activate')) return pairingActivationReceipt(); + if (url === 'https://b.example.test/api/desktop/tokens/current') { + return new Response(null, { status: 204 }); + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + const ready = await service.probe({ + id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl, + }); + assert.equal(ready.status, 'ready'); + if (ready.status !== 'ready') return; + const activated = await service.activate(ready.activationTicket); + rejectReplacementEncryption = failure === 'secure-storage'; + + await assert.rejects(service.pair({ + id: profile.id, + label: 'Proposed B', + apiBaseUrl: 'https://b.example.test', + })); + + assert.deepEqual(await store.list(), { profiles: [profile], activeProfileId: profile.id }); + assert.deepEqual(await store.readCredential(profile.id), oldCredential); + assert.deepEqual((await service.prepareRequestAsync( + 'https://a.example.test/api/tasks', + transportHeaders(activated.transportScope), + )).requestHeaders, { Authorization: `Bearer ${oldCredential.token}` }); + assert.equal(requests.some(request => request.url === 'https://a.example.test/api/desktop/tokens/current' + && request.authorization === `Bearer ${oldCredential.token}`), false); + }); + } + + it('commits an edited profile and replacement credential before revoking the old token', async () => { + const store = await createStore(); + const profile = await store.save({ + id: 'profile-a', label: 'Working A', apiBaseUrl: 'https://a.example.test', + }); + const oldCredential = credential(profile.id, profile.apiBaseUrl, 'A'); + const replacement = credential(profile.id, 'https://b.example.test', 'B'); + await store.writeCredential(oldCredential); + await store.setActive(profile.id); + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + const revocationSnapshot = deferred<{ + state: Awaited>; + credential: StoredCredential | null; + }>(); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url === 'https://b.example.test/api/desktop/pairings') return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'C'.repeat(43), + approvalUrl: 'https://b.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + if (url.endsWith('/poll')) return provisionalPairingResponse(url, replacement.token); + if (url.endsWith('/activate')) return pairingActivationReceipt(); + if (url === 'https://a.example.test/api/desktop/tokens/current') { + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${oldCredential.token}`); + revocationSnapshot.resolve({ + state: await store.list(), + credential: await store.readCredential(profile.id), + }); + return new Response(null, { status: 204 }); + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + + await service.pair({ + id: profile.id, + label: 'Connected B', + apiBaseUrl: replacement.origin, + }); + + const stateAtRevocation = await revocationSnapshot.promise; + assert.equal(stateAtRevocation.state.profiles[0]?.label, 'Connected B'); + assert.equal(stateAtRevocation.state.profiles[0]?.apiBaseUrl, replacement.origin); + assert.equal(stateAtRevocation.state.activeProfileId, null); + assert.deepEqual(stateAtRevocation.credential, replacement); + assert.deepEqual(await store.readCredential(profile.id), replacement); + }); + + it('durably journals a provisional delivery before server activation and local publication', async () => { + const store = await createStore(); + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + const replacement = credential('profile-delivery', 'https://a.example.test', 'B'); + let activationChecked = false; + const service = createCredentialService({ + profiles: store, + clientName: 'Delivery ordering test', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url.endsWith('/api/desktop/pairings')) return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'C'.repeat(43), + approvalUrl: 'https://a.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }); + if (url.endsWith('/poll')) return provisionalPairingResponse(url, replacement.token); + if (url.endsWith('/activate')) { + const pending = await store.pendingRevocations(); + assert.equal(pending.length, 1); + assert.equal(pending[0]?.deferred, true); + assert.deepEqual(pending[0]?.credential, replacement); + assert.equal(await store.readCredential(replacement.profileId), null); + activationChecked = true; + return pairingActivationReceipt(); + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + + await service.pair({ + id: replacement.profileId, + label: 'Delivered B', + apiBaseUrl: replacement.origin, + }); + assert.equal(activationChecked, true); + assert.deepEqual(await store.readCredential(replacement.profileId), replacement); + assert.deepEqual(await store.pendingRevocations(), []); + console.log('NATIVE_SCENARIO delivery'); + }); + + it('retries an encrypted pending A revocation across failure, restart, remote success, and local cleanup failure', async () => { + const store = await createStore(); + const profile = await store.save({ + id: 'profile-a', label: 'Working A', apiBaseUrl: 'https://a.example.test', + }); + const credentialA = credential(profile.id, profile.apiBaseUrl, 'A'); + const credentialB = credential(profile.id, profile.apiBaseUrl, 'B'); + await store.writeCredential(credentialA); + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + const diagnostics: Array<{ code: string; status?: number }> = []; + let expectedProbeToken = credentialA.token; + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + reportRevocationFailure: value => diagnostics.push(value), + fetch: async (input, init) => { + const url = input.toString(); + if (url.endsWith('/api/desktop/pairings')) return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'C'.repeat(43), + approvalUrl: 'https://a.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + if (url.endsWith('/poll')) return provisionalPairingResponse(url, credentialB.token); + if (url.endsWith('/activate')) return pairingActivationReceipt(); + if (url.endsWith('/api/desktop/tokens/current')) { + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${credentialA.token}`); + return json({ error: 'offline' }, 503); + } + if (url.endsWith('/api/desktop/discovery')) return json(discovery); + if (url.endsWith('/api/auth/user')) { + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${expectedProbeToken}`); + return json({ username: 'credential-b' }); + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + + const readyA = await service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + assert.equal(readyA.status, 'ready'); + if (readyA.status !== 'ready') return; + const activeA = await service.activate(readyA.activationTicket); + await service.pair({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + assert.deepEqual(await store.readCredential(profile.id), credentialB); + assert.equal((await store.pendingRevocations()).length, 1); + assert.deepEqual(diagnostics, [{ code: 'http', status: 503 }]); + assert.equal(JSON.stringify(diagnostics).includes(credentialA.token), false); + assert.deepEqual(service.prepareRequest( + `${profile.apiBaseUrl}/api/tasks`, transportHeaders(activeA.transportScope), + ), { cancel: true }); + expectedProbeToken = credentialB.token; + const ready = await service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + assert.equal(ready.status, 'ready'); + if (ready.status !== 'ready') return; + const activeB = await service.activate(ready.activationTicket); + assert.deepEqual((await service.prepareRequestAsync( + `${profile.apiBaseUrl}/api/tasks`, transportHeaders(activeB.transportScope), + )).requestHeaders, { Authorization: `Bearer ${credentialB.token}` }); + + const offlineDiagnostics: Array<{ code: string; status?: number }> = []; + const offlineRestart = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + reportRevocationFailure: value => offlineDiagnostics.push(value), + fetch: async () => { throw new Error('offline'); }, + }); + await offlineRestart.initialize(); + assert.deepEqual(offlineDiagnostics, [{ code: 'network' }]); + assert.equal((await store.pendingRevocations()).length, 1); + + let failCleanup = true; + const cleanupFailingProfiles = new Proxy(store, { + get(target, property) { + if (property === 'completePendingRevocation') return async () => { + if (failCleanup) { + failCleanup = false; + throw new Error('injected cleanup failure'); + } + return false; + }; + const value = Reflect.get(target, property); + return typeof value === 'function' ? value.bind(target) : value; + }, + }); + const cleanupDiagnostics: Array<{ code: string; status?: number }> = []; + const remoteSucceeded = createCredentialService({ + profiles: cleanupFailingProfiles, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + reportRevocationFailure: value => cleanupDiagnostics.push(value), + fetch: async () => new Response(null, { status: 204 }), + }); + await remoteSucceeded.initialize(); + assert.deepEqual(cleanupDiagnostics, [{ code: 'local-cleanup' }]); + assert.equal((await store.pendingRevocations()).length, 1); + + let terminalRetries = 0; + const onlineRestart = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + if (input.toString().endsWith('/api/desktop/discovery')) return json(discovery); + terminalRetries += 1; + return terminalRevocation(init); + }, + }); + await onlineRestart.initialize(); + await onlineRestart.initialize(); + assert.equal(terminalRetries, 1); + assert.deepEqual(await store.pendingRevocations(), []); + assert.deepEqual(await store.readCredential(profile.id), credentialB); + + const uncertainDirectory = await mkdtemp(join(tmpdir(), 'propr-credential-service-')); + temporaryDirectories.push(uncertainDirectory); + let failCommitFlush = false; + let armedCommitFlushes = 0; + const uncertainStore = new ProfileStore(uncertainDirectory, encryption, { + beforeIO: operation => { + if (failCommitFlush && operation === 'journal-commit-flush') { + armedCommitFlushes += 1; + if (armedCommitFlushes === 2) throw new Error('injected journal commit flush failure'); + } + }, + }); + const uncertainProfile = await uncertainStore.save({ + id: 'profile-uncertain', label: 'A', apiBaseUrl: 'https://a.example.test', + }); + const uncertainA = credential(uncertainProfile.id, uncertainProfile.apiBaseUrl, 'A'); + const uncertainB = credential(uncertainProfile.id, uncertainProfile.apiBaseUrl, 'B'); + await uncertainStore.writeCredential(uncertainA); + const uncertainRevocations: string[] = []; + const uncertainService = createCredentialService({ + profiles: uncertainStore, + clientName: 'Test desktop', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url.endsWith('/api/desktop/pairings')) return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'C'.repeat(43), + approvalUrl: 'https://a.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + if (url.endsWith('/poll')) return provisionalPairingResponse(url, uncertainB.token); + if (url.endsWith('/activate')) return pairingActivationReceipt(); + if (url.endsWith('/api/desktop/tokens/current')) { + uncertainRevocations.push(new Headers(init?.headers).get('Authorization') ?? ''); + return new Response(null, { status: 204 }); + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + failCommitFlush = true; + await assert.rejects( + uncertainService.pair({ + id: uncertainProfile.id, + label: 'B', + apiBaseUrl: uncertainProfile.apiBaseUrl, + }), + /injected journal commit flush failure/, + ); + failCommitFlush = false; + assert.deepEqual(uncertainRevocations, [], 'verified B must not be revoked after C becomes observable'); + const uncertainRestart = new ProfileStore(uncertainDirectory, encryption); + assert.deepEqual(await uncertainRestart.readCredential(uncertainProfile.id), uncertainB); + assert.equal((await uncertainRestart.pendingRevocations()).length, 1); + }); + + const nativeRevocationCrashModes = ['during-revoke', 'after-remote-success'] as const; + assert.equal(nativeRevocationCrashModes.length, 2); + for (const crashMode of nativeRevocationCrashModes) { + it(`recovers B and retries idempotently after a real process crash ${crashMode}`, async () => { + const directory = await mkdtemp(join(tmpdir(), 'propr-credential-service-')); + temporaryDirectories.push(directory); + const setup = new ProfileStore(directory, encryption); + const profile = await setup.save({ + id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test', + }); + const credentialA = credential(profile.id, profile.apiBaseUrl, 'A'); + const credentialB = credential(profile.id, profile.apiBaseUrl, 'B'); + await setup.writeCredential(credentialA); + const baseline = await setup.readProfileCredential(profile.id); + await setup.commitPairedProfile( + { id: profile.id, label: 'B', apiBaseUrl: profile.apiBaseUrl }, + credentialB, baseline, () => true, + ); + assert.equal((await setup.pendingRevocations()).length, 1); + + const child = spawn(process.execPath, [ + '--import', 'tsx', join(import.meta.dirname, 'pending-revocation-crash-fixture.ts'), + directory, crashMode, + ], { stdio: 'ignore' }); + const result = await new Promise<{ code: number | null; signal: NodeJS.Signals | null }>(resolve => { + child.once('exit', (code, signal) => resolve({ code, signal })); + }); + assert.equal( + result.signal === 'SIGKILL' || (process.platform === 'win32' && result.code !== 0), + true, + `${crashMode}: child did not terminate at the requested revocation boundary`, + ); + + const restarted = new ProfileStore(directory, encryption); + assert.deepEqual(await restarted.readCredential(profile.id), credentialB); + assert.equal((await restarted.pendingRevocations()).length, 1); + let retries = 0; + const retryingService = createCredentialService({ + profiles: restarted, + clientName: 'Restarted desktop', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + if (input.toString().endsWith('/api/desktop/discovery')) return json(discovery); + retries += 1; + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${credentialA.token}`); + return terminalRevocation(init); + }, + }); + await retryingService.initialize(); + await retryingService.initialize(); + assert.equal(retries, 1); + assert.deepEqual(await restarted.pendingRevocations(), []); + assert.deepEqual(await restarted.readCredential(profile.id), credentialB); + console.log('NATIVE_SCENARIO revocation-crash'); + }); + } + + for (const [name, response] of [ + ['204 success', (_init: RequestInit | undefined) => new Response(null, { status: 204 })], + ['404 TOKEN_NOT_FOUND', (init: RequestInit | undefined) => terminalRevocation(init)], + ['401 INSTANCE_TOKEN_REVOKED', (init: RequestInit | undefined) => terminalRevocation(init, 'INSTANCE_TOKEN_REVOKED')], + ['401 INSTANCE_TOKEN_EXPIRED', (init: RequestInit | undefined) => terminalRevocation(init, 'INSTANCE_TOKEN_EXPIRED')], + ] as const) { + it(`cleans durable retry material only for endpoint-bound terminal ${name}`, async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-terminal', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const old = credential(profile.id, profile.apiBaseUrl, 'A'); + await store.writeCredential(old); + await store.removeCredential(profile.id); + const pending = await store.pendingRevocations(); + assert.equal(pending.length, 1); + const service = createCredentialService({ + profiles: store, + clientName: 'Terminal contract test', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + assert.equal(input.toString(), `${old.origin}${DESKTOP_TOKEN_REVOCATION_ENDPOINT}`); + assert.equal(new Headers(init?.headers).get(DESKTOP_REVOCATION_BINDING_HEADER), pending[0].credentialGeneration); + return response(init); + }, + }); + await service.initialize(); + assert.deepEqual(await store.pendingRevocations(), []); + }); + } + + const retryableRevocationResponses: ReadonlyArray<[ + string, + (init: RequestInit | undefined) => Response, + ]> = [ + ['empty 401', () => new Response(null, { status: 401 })], + ['empty 404', () => new Response(null, { status: 404 })], + ['HTML route 404', () => new Response('

not found

', { status: 404, headers: { 'Content-Type': 'text/html' } })], + ['malformed JSON', () => new Response('{', { status: 404, headers: { 'Content-Type': 'application/json' } })], + ['wrong content type', init => new Response(JSON.stringify(terminalRevocationBody(init)), { + status: 404, headers: { 'Content-Type': 'text/plain' }, + })], + ['wrong schema version', init => json({ ...terminalRevocationBody(init), version: 2 }, 404)], + ['wrong credential generation', init => json({ + ...terminalRevocationBody(init), credentialGeneration: 'Z'.repeat(22), + }, 404)], + ['unknown terminal code', init => json({ ...terminalRevocationBody(init), code: 'INVALID_INSTANCE_TOKEN' }, 404)], + ['status/code mismatch', init => json(terminalRevocationBody(init), 401)], + ['redirect', () => Response.redirect('https://proxy.example.test/moved', 302)], + ['redirected 204', () => { + const result = new Response(null, { status: 204 }); + Object.defineProperty(result, 'redirected', { value: true }); + return result; + }], + ['wrong endpoint 204', () => { + const result = new Response(null, { status: 204 }); + Object.defineProperty(result, 'url', { value: 'https://proxy.example.test/api/desktop/tokens/current' }); + return result; + }], + ['server failure', () => json({ code: 'DESKTOP_AUTH_FAILED' }, 503)], + ['oversized JSON', init => json({ ...terminalRevocationBody(init), padding: 'x'.repeat(2_048) }, 404)], + ]; + for (const [name, response] of retryableRevocationResponses) { + it(`retains encrypted retry material for ${name}`, async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-retryable', label: 'A', apiBaseUrl: 'https://a.example.test' }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + await store.removeCredential(profile.id); + const diagnostics: Array<{ code: string; status?: number }> = []; + const service = createCredentialService({ + profiles: store, + clientName: 'Retryable contract test', + openPairingBrowser: async () => undefined, + reportRevocationFailure: diagnostic => diagnostics.push(diagnostic), + fetch: async (_input, init) => response(init), + }); + await service.initialize(); + assert.equal((await store.pendingRevocations()).length, 1); + assert.deepEqual(diagnostics, [{ code: 'http', status: response(undefined).status }]); + assert.equal(JSON.stringify(diagnostics).includes(token('A')), false); + }); + } + + const streamingRevocationCases: ReadonlyArray<[ + string, + boolean, + (init: RequestInit | undefined) => Response, + ]> = [ + ['chunked 2048-byte terminal JSON', true, init => { + const jsonBody = JSON.stringify(terminalRevocationBody(init)); + const body = new TextEncoder().encode(jsonBody + ' '.repeat(2_048 - Buffer.byteLength(jsonBody))); + return new Response(new ReadableStream({ + start(controller) { + controller.enqueue(body.slice(0, 1_024)); + controller.enqueue(body.slice(1_024)); + controller.close(); + }, + }), { status: 404, headers: { 'Content-Type': 'application/json' } }); + }], + ['chunked 2049-byte terminal JSON', false, init => { + const jsonBody = JSON.stringify(terminalRevocationBody(init)); + const body = new TextEncoder().encode(jsonBody + ' '.repeat(2_049 - Buffer.byteLength(jsonBody))); + return new Response(new ReadableStream({ + start(controller) { + controller.enqueue(body.slice(0, 2_048)); + controller.enqueue(body.slice(2_048)); + controller.close(); + }, + }), { status: 404, headers: { 'Content-Type': 'application/json' } }); + }], + ['terminal JSON without Content-Length', true, init => { + const body = new TextEncoder().encode(JSON.stringify(terminalRevocationBody(init))); + return new Response(new ReadableStream({ + start(controller) { + controller.enqueue(body.slice(0, 7)); + controller.enqueue(body.slice(7)); + controller.close(); + }, + }), { status: 404, headers: { 'Content-Type': 'application/json' } }); + }], + ['deceptive short Content-Length', false, init => { + const body = JSON.stringify(terminalRevocationBody(init)); + return new Response(body, { + status: 404, + headers: { 'Content-Type': 'application/json', 'Content-Length': String(Buffer.byteLength(body) - 1) }, + }); + }], + ['extra chunk after declared Content-Length', false, init => { + const body = new TextEncoder().encode(JSON.stringify(terminalRevocationBody(init))); + return new Response(new ReadableStream({ + start(controller) { + controller.enqueue(body); + controller.enqueue(new TextEncoder().encode(' ')); + controller.close(); + }, + }), { + status: 404, + headers: { 'Content-Type': 'application/json', 'Content-Length': String(body.byteLength) }, + }); + }], + ['malformed UTF-8', false, () => new Response(new ReadableStream({ + start(controller) { + controller.enqueue(Uint8Array.from([0xc3, 0x28])); + controller.close(); + }, + }), { status: 404, headers: { 'Content-Type': 'application/json' } })], + ['premature body error', false, () => new Response(new ReadableStream({ + start(controller) { + controller.enqueue(new TextEncoder().encode('{')); + controller.error(new Error('injected body failure')); + }, + }), { status: 404, headers: { 'Content-Type': 'application/json' } })], + ]; + + for (const [name, completes, response] of streamingRevocationCases) { + it(`${completes ? 'accepts' : 'retains'} encrypted retry material for ${name}`, async () => { + const store = await createStore(); + const profile = await store.save({ + id: 'profile-streaming', label: 'A', apiBaseUrl: 'https://a.example.test', + }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + await store.removeCredential(profile.id); + const service = createCredentialService({ + profiles: store, + clientName: 'Streaming terminal contract test', + openPairingBrowser: async () => undefined, + fetch: async (_input, init) => response(init), + }); + + const initialized = await service.initialize(); + + assert.equal((await store.pendingRevocations()).length, completes ? 0 : 1); + assert.equal(initialized.status, completes ? 'ready' : 'degraded'); + }); + } + + it('bounds a one-byte slowloris body and retains its encrypted retry material', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-slowloris', label: 'A', apiBaseUrl: 'https://a.example.test' }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + await store.removeCredential(profile.id); + let bodyCancelled = false; + const service = createCredentialService({ + profiles: store, + clientName: 'Slowloris terminal contract test', + openPairingBrowser: async () => undefined, + revocationDeadlines: { headerMs: 50, bodyMs: 25, recordMs: 75, aggregateMs: 100 }, + fetch: async () => new Response(new ReadableStream({ + start(controller) { controller.enqueue(new TextEncoder().encode('{')); }, + cancel() { bodyCancelled = true; }, + }), { status: 404, headers: { 'Content-Type': 'application/json' } }), + }); + + const initialized = await service.initialize(); + + assert.deepEqual(initialized, { status: 'degraded', retryPending: true }); + assert.equal(bodyCancelled, true); + assert.equal((await store.pendingRevocations()).length, 1); + }); + + it('dispose aborts a stalled header fetch, deduplicates its generation, and leaves no later activity', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-dispose-fetch', label: 'A', apiBaseUrl: 'https://a.example.test' }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + await store.removeCredential(profile.id); + const fetchStarted = deferred(); + let fetchCalls = 0; + let fetchAborted = false; + const service = createCredentialService({ + profiles: store, + clientName: 'Dispose fetch barrier test', + openPairingBrowser: async () => undefined, + fetch: async (_input, init) => await new Promise((_resolve, reject) => { + fetchCalls += 1; + fetchStarted.resolve(); + const signal = init?.signal; + assert.ok(signal); + const abort = () => { + fetchAborted = true; + reject(Object.assign(new Error('aborted'), { name: 'AbortError' })); + }; + if (signal.aborted) abort(); + else signal.addEventListener('abort', abort, { once: true }); + }), + }); + + const first = service.initialize(); + const duplicate = service.initialize(); + await fetchStarted.promise; + await service.dispose(); + await Promise.all([first, duplicate]); + const callsAtDispose = fetchCalls; + await new Promise(resolve => setTimeout(resolve, 20)); + + assert.equal(fetchAborted, true); + assert.equal(fetchCalls, 1); + assert.equal(fetchCalls, callsAtDispose); + assert.equal((await store.pendingRevocations()).length, 1); + await assert.rejects( + service.removeProfile(profile.id), + /credential service is closed/i, + ); + }); + + it('dispose cancels a headers-then-stall body and retains exact encrypted material', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-dispose-body', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const old = credential(profile.id, profile.apiBaseUrl, 'A'); + await store.writeCredential(old); + await store.removeCredential(profile.id); + const bodyStarted = deferred(); + let bodyCancelled = false; + let networkCalls = 0; + const service = createCredentialService({ + profiles: store, + clientName: 'Dispose body barrier test', + openPairingBrowser: async () => undefined, + fetch: async () => { + networkCalls += 1; + return new Response(new ReadableStream({ + start(controller) { + controller.enqueue(new TextEncoder().encode('{')); + }, + pull() { + bodyStarted.resolve(); + }, + cancel() { bodyCancelled = true; }, + }), { status: 404, headers: { 'Content-Type': 'application/json' } }); + }, + }); + + const initialization = service.initialize(); + await bodyStarted.promise; + await service.dispose(); + await initialization; + const callsAtDispose = networkCalls; + await new Promise(resolve => setTimeout(resolve, 20)); + + const pending = await store.pendingRevocations(); + assert.equal(bodyCancelled, true); + assert.equal(networkCalls, callsAtDispose); + assert.equal(pending.length, 1); + assert.deepEqual(pending[0].credential, old); + }); + + it('dispose waits for terminal journal cleanup and no file operation runs afterward', async () => { + const directory = await mkdtemp(join(tmpdir(), 'propr-credential-service-')); + temporaryDirectories.push(directory); + const journalWriteStarted = deferred(); + const releaseJournalWrite = deferred(); + let barrierArmed = false; + let ioOperations = 0; + const store = new ProfileStore(directory, encryption, { + beforeIO: operation => { + ioOperations += 1; + if (barrierArmed && operation === 'journal-write') { + barrierArmed = false; + journalWriteStarted.resolve(); + return releaseJournalWrite.promise; + } + }, + }); + const profile = await store.save({ id: 'profile-dispose-journal', label: 'A', apiBaseUrl: 'https://a.example.test' }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + await store.removeCredential(profile.id); + barrierArmed = true; + let networkCalls = 0; + const service = createCredentialService({ + profiles: store, + clientName: 'Dispose journal barrier test', + openPairingBrowser: async () => undefined, + fetch: async () => { + networkCalls += 1; + return new Response(null, { status: 204 }); + }, + }); + + const initialization = service.initialize(); + await journalWriteStarted.promise; + let disposed = false; + const disposal = service.dispose().then(() => { disposed = true; }); + await Promise.resolve(); + assert.equal(disposed, false); + releaseJournalWrite.resolve(); + await Promise.all([initialization, disposal]); + const ioAtDispose = ioOperations; + const networkAtDispose = networkCalls; + await new Promise(resolve => setTimeout(resolve, 20)); + + assert.equal(ioOperations, ioAtDispose); + assert.equal(networkCalls, networkAtDispose); + assert.deepEqual(await store.pendingRevocations(), []); + console.log('NATIVE_SCENARIO dispose'); + }); + + it('bounds aggregate startup across stalled records and recovers all encrypted records later', async () => { + const store = await createStore(); + for (const [id, character] of [['profile-startup-a', 'A'], ['profile-startup-b', 'B']] as const) { + const profile = await store.save({ id, label: id, apiBaseUrl: `https://${character.toLowerCase()}.example.test` }); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, character)); + await store.removeCredential(profile.id); + } + let stalledCalls = 0; + const offline = createCredentialService({ + profiles: store, + clientName: 'Bounded startup test', + openPairingBrowser: async () => undefined, + revocationDeadlines: { headerMs: 100, bodyMs: 50, recordMs: 125, aggregateMs: 500 }, + fetch: async (_input, init) => await new Promise((_resolve, reject) => { + stalledCalls += 1; + const signal = init?.signal; + assert.ok(signal); + const abort = () => reject(Object.assign(new Error('aborted'), { name: 'AbortError' })); + if (signal.aborted) abort(); + else signal.addEventListener('abort', abort, { once: true }); + }), + }); + const startedAt = Date.now(); + + const initialization = await offline.initialize(); + + assert.deepEqual(initialization, { status: 'degraded', retryPending: true }); + assert.ok(Date.now() - startedAt < 1_500); + assert.equal(stalledCalls, 2); + assert.equal((await store.pendingRevocations()).length, 2); + await offline.dispose(); + + let recoveryCalls = 0; + const online = createCredentialService({ + profiles: store, + clientName: 'Later online recovery test', + openPairingBrowser: async () => undefined, + fetch: async () => { + recoveryCalls += 1; + return new Response(null, { status: 204 }); + }, + }); + assert.deepEqual(await online.initialize(), { status: 'ready', retryPending: false }); + assert.equal(recoveryCalls, 4, 'each revocation is preceded by one unauthenticated discovery'); + assert.deepEqual(await store.pendingRevocations(), []); + }); + + it('retries a crash-left provisional pairing credential on startup', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-provisional', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const provisional = await store.journalPendingRevocation( + credential(profile.id, profile.apiBaseUrl, 'C'), + ); + assert.equal('stored' in provisional, false); + if ('stored' in provisional) return; + assert.equal(provisional.deferred, true); + let calls = 0; + const restarted = createCredentialService({ + profiles: store, + clientName: 'Restarted after provisional crash', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + if (input.toString().endsWith('/api/desktop/discovery')) return json(discovery); + calls += 1; + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${token('C')}`); + return new Response(null, { status: 204 }); + }, + }); + await restarted.initialize(); + assert.equal(calls, 1); + assert.deepEqual(await store.pendingRevocations(), []); + console.log('NATIVE_SCENARIO transient-revocation'); + console.log('NATIVE_SCENARIO provisional'); + }); + + it('ignores delayed A invalidation after B connects and preserves tokens for authorization/transient codes', async () => { + const store = await createStore(); + const profileA = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const profileB = await store.save({ id: 'profile-b', label: 'B', apiBaseUrl: 'https://b.example.test' }); + await store.writeCredential(credential(profileA.id, profileA.apiBaseUrl, 'A')); + await store.writeCredential(credential(profileB.id, profileB.apiBaseUrl, 'B')); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async input => input.toString().endsWith('/api/desktop/discovery') + ? json(discovery) + : json({ username: 'octocat' }), + }); + const readyA = await service.probe({ id: profileA.id, label: profileA.label, apiBaseUrl: profileA.apiBaseUrl }); + const activatedA = readyA.status === 'ready' ? await service.activate(readyA.activationTicket) : null; + const readyB = await service.probe({ id: profileB.id, label: profileB.label, apiBaseUrl: profileB.apiBaseUrl }); + assert.equal(readyA.status, 'ready'); + assert.equal(readyB.status, 'ready'); + if (readyA.status !== 'ready' || readyB.status !== 'ready') return; + const activatedB = await service.activate(readyB.activationTicket); + if (!activatedA) return; + + assert.deepEqual(await service.invalidate({ + profileId: profileA.id, + transportScope: activatedA.transportScope, + code: 'INVALID_INSTANCE_TOKEN', + }), { invalidated: false }); + assert.deepEqual(await service.invalidate({ + profileId: profileB.id, + transportScope: activatedB.transportScope, + code: 'AUTHORIZATION_CHANGED', + }), { invalidated: false }); + assert.deepEqual(await service.invalidate({ + profileId: profileB.id, + transportScope: activatedB.transportScope, + code: 'AUTHENTICATION_FAILED', + }), { invalidated: false }); + assert.ok(await store.readCredential(profileA.id)); + assert.ok(await store.readCredential(profileB.id)); + + assert.deepEqual(await service.invalidate({ + profileId: profileB.id, + transportScope: activatedB.transportScope, + code: 'INVALID_INSTANCE_TOKEN', + }), { invalidated: true }); + await service.initialize(); + assert.ok(await store.readCredential(profileA.id)); + assert.equal(await store.readCredential(profileB.id), null); + }); + + it('preserves a replacement written while an old transient token revocation is pending', async () => { + const directory = await mkdtemp(join(tmpdir(), 'propr-credential-service-')); + temporaryDirectories.push(directory); + let service!: DesktopCredentialService; + let cancelOldPairingOnWrite = true; + const cancellingEncryption: EncryptionProvider = { + ...encryption, + encrypt: value => { + const stored = JSON.parse(value) as StoredCredential; + if (cancelOldPairingOnWrite && stored.token === token('C')) { + cancelOldPairingOnWrite = false; + service.cancelPairing(stored.profileId); + } + return Buffer.from(value, 'utf8'); + }, + }; + const store = new ProfileStore(directory, cancellingEncryption); + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const revocationStarted = deferred(); + const releaseRevocation = deferred(); + let pairingNumber = 0; + let currentPairing = 0; + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url.endsWith('/api/desktop/pairings')) { + currentPairing = ++pairingNumber; + return pairingStartResponse(url, init, { + pairingId: `dpr_${String.fromCharCode(64 + currentPairing).repeat(22)}`, + deviceSecret: String.fromCharCode(66 + currentPairing).repeat(43), + approvalUrl: 'https://a.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + } + if (url.endsWith('/poll')) { + const character = currentPairing === 1 ? 'C' : 'D'; + return provisionalPairingResponse(url, token(character)); + } + if (url.endsWith('/activate')) return pairingActivationReceipt(); + if (url.endsWith('/api/desktop/tokens/current')) { + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${token('C')}`); + revocationStarted.resolve(); + return releaseRevocation.promise; + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + + const oldPairing = assert.rejects( + service.pair({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }), + /cancelled/i, + ); + await revocationStarted.promise; + await service.pair({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + releaseRevocation.resolve(new Response(null, { status: 204 })); + await oldPairing; + + assert.deepEqual(await store.readCredential(profile.id), credential(profile.id, profile.apiBaseUrl, 'D')); + }); + + it('keeps an exactly persisted cancelled pairing token pending when revocation fails', async () => { + const directory = await mkdtemp(join(tmpdir(), 'propr-credential-service-')); + temporaryDirectories.push(directory); + let service!: DesktopCredentialService; + const cancellingEncryption: EncryptionProvider = { + ...encryption, + encrypt: value => { + const stored = JSON.parse(value) as StoredCredential; + if (stored.token === token('C')) service.cancelPairing(stored.profileId); + return Buffer.from(value, 'utf8'); + }, + }; + const store = new ProfileStore(directory, cancellingEncryption); + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url.endsWith('/api/desktop/pairings')) return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://a.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + if (url.endsWith('/poll')) { + return provisionalPairingResponse(url, token('C')); + } + if (url.endsWith('/activate')) return pairingActivationReceipt(); + if (url.endsWith('/api/desktop/tokens/current')) return json({ error: 'unavailable' }, 500); + throw new Error(`Unexpected request: ${url}`); + }, + }); + + await assert.rejects( + service.pair({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }), + /cancelled/i, + ); + assert.equal(await store.readCredential(profile.id), null); + const pending = await store.pendingRevocations(); + assert.equal(pending.length, 1); + assert.equal(pending[0].credential.token, token('C')); + console.log('NATIVE_SCENARIO transient-revocation'); + }); + + it('detaches a removed profile locally before deferred revoke and preserves a later replacement', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const storedCredential = credential(profile.id, profile.apiBaseUrl, 'A'); + await store.writeCredential(storedCredential); + await store.setActive(profile.id); + const revocationStarted = deferred(); + const releaseRevocation = deferred(); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url.endsWith('/api/desktop/discovery')) return json(discovery); + if (url.endsWith('/api/auth/user')) { + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${storedCredential.token}`); + return json({ username: 'octocat' }); + } + if (url.endsWith('/api/desktop/tokens/current')) { + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${storedCredential.token}`); + revocationStarted.resolve(); + return releaseRevocation.promise; + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + + const ready = await service.probe(profile); + assert.equal(ready.status, 'ready'); + if (ready.status !== 'ready') return; + const active = await service.activate(ready.activationTicket); + const pending = await service.probe(profile); + assert.equal(pending.status, 'ready'); + if (pending.status !== 'ready') return; + + let rendererSuccessPublished = false; + let removalError: unknown; + const failedRemoval = service.removeProfile(profile.id, async origin => { + assert.equal(origin, profile.apiBaseUrl); + throw new Error('origin storage clear failed'); + }).then(result => { + rendererSuccessPublished = true; + return result; + }); + await assert.rejects(failedRemoval, error => { + removalError = error; + return error instanceof Error && /origin storage clear failed/.test(error.message); + }); + + assert.equal(rendererSuccessPublished, false); + assert.doesNotMatch(String(removalError), new RegExp(storedCredential.token)); + assert.deepEqual(await store.list(), { profiles: [profile], activeProfileId: profile.id }); + assert.deepEqual(await store.readCredential(profile.id), storedCredential); + assert.deepEqual(await store.pendingRevocations(), []); + assert.deepEqual(service.prepareRequest( + `${profile.apiBaseUrl}/api/tasks`, transportHeaders(active.transportScope), + ), { cancel: true }); + await assert.rejects( + service.activate(pending.activationTicket), + /Desktop activation expired/, + ); + + const reconstructedReady = await service.probe(profile); + assert.equal(reconstructedReady.status, 'ready'); + if (reconstructedReady.status !== 'ready') return; + const reconstructed = await service.activate(reconstructedReady.activationTicket); + assert.equal(reconstructed.profileId, profile.id); + assert.notEqual(reconstructed.transportScope, active.transportScope); + assert.equal('token' in reconstructed, false); + assert.deepEqual(await store.readCredential(profile.id), storedCredential); + + const removal = service.removeProfile(profile.id); + await revocationStarted.promise; + assert.equal((await store.list()).profiles.some(item => item.id === profile.id), false); + assert.equal(await store.readCredential(profile.id), null); + assert.deepEqual(service.prepareRequest( + `${profile.apiBaseUrl}/api/tasks`, transportHeaders(reconstructed.transportScope), + ), { cancel: true }); + + const replacementProfile = await service.saveProfile({ + id: profile.id, + label: 'Replacement', + apiBaseUrl: profile.apiBaseUrl, + }); + const replacementCredential = credential(profile.id, profile.apiBaseUrl, 'B'); + await store.writeCredential(replacementCredential); + releaseRevocation.resolve(new Response(null, { status: 204 })); + await removal; + // Drain the serialized retry queue before the test removes its keychain + // directory; removeProfile intentionally does not wait on the network. + await service.initialize(); + + assert.equal((await store.list()).profiles.find(item => item.id === profile.id)?.label, replacementProfile.label); + assert.deepEqual(await store.readCredential(profile.id), replacementCredential); + }); + + it('never lets a delayed A-to-B revoke overwrite a later C save, pairing, selection, or credential', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + await store.setActive(profile.id); + await store.writeCredential(credential(profile.id, profile.apiBaseUrl, 'A')); + const revokeStarted = deferred(); + const releaseRevoke = deferred(); + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url === 'https://a.example.test/api/desktop/tokens/current') { + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${token('A')}`); + revokeStarted.resolve(); + return releaseRevoke.promise; + } + if (url.endsWith('/api/desktop/pairings')) return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://c.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + if (url.endsWith('/poll')) { + return provisionalPairingResponse(url, token('C')); + } + if (url.endsWith('/activate')) return pairingActivationReceipt(); + if (url.endsWith('/api/desktop/discovery')) return json(discovery); + if (url.endsWith('/api/auth/user')) return json({ username: 'c' }); + throw new Error(`Unexpected request: ${url}`); + }, + }); + + const staleBSave = service.saveProfile({ + id: profile.id, label: 'B', apiBaseUrl: 'https://b.example.test', + }); + await revokeStarted.promise; + const profileC = await service.saveProfile({ + id: profile.id, label: 'C', apiBaseUrl: 'https://c.example.test', + }); + await service.pair({ id: profile.id, label: 'C', apiBaseUrl: profileC.apiBaseUrl }); + const probeC = await service.probe({ id: profile.id, label: 'C', apiBaseUrl: profileC.apiBaseUrl }); + assert.equal(probeC.status, 'ready'); + if (probeC.status !== 'ready') return; + await service.activate(probeC.activationTicket); + + releaseRevoke.resolve(new Response(null, { status: 204 })); + await staleBSave; + + const finalState = await store.list(); + assert.equal(finalState.profiles.find(item => item.id === profile.id)?.label, 'C'); + assert.equal(finalState.profiles.find(item => item.id === profile.id)?.apiBaseUrl, 'https://c.example.test'); + assert.equal(finalState.activeProfileId, profile.id); + assert.deepEqual(await store.readCredential(profile.id), credential(profile.id, 'https://c.example.test', 'C')); + }); + + it('returns connection-changed and preserves a re-paired credential for an old ready invalidation', async () => { + const store = await createStore(); + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const oldCredential = credential(profile.id, profile.apiBaseUrl, 'A'); + const replacement = credential(profile.id, profile.apiBaseUrl, 'B'); + await store.writeCredential(oldCredential); + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url.endsWith('/api/desktop/discovery')) return json(discovery); + if (url.endsWith('/api/auth/user')) { + assert.equal(new Headers(init?.headers).get('Authorization'), `Bearer ${oldCredential.token}`); + return json({ username: 'old-user' }); + } + if (url.endsWith('/api/desktop/pairings')) return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'C'.repeat(43), + approvalUrl: 'https://a.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + if (url.endsWith('/poll')) { + return provisionalPairingResponse(url, replacement.token); + } + if (url.endsWith('/activate')) return pairingActivationReceipt(); + throw new Error(`Unexpected request: ${url}`); + }, + }); + const ready = await service.probe({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + assert.equal(ready.status, 'ready'); + if (ready.status !== 'ready') return; + const activated = await service.activate(ready.activationTicket); + + await service.pair({ id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl }); + assert.deepEqual(await service.invalidate({ + profileId: profile.id, + transportScope: activated.transportScope, + code: 'INVALID_INSTANCE_TOKEN', + }), { invalidated: false }); + + assert.deepEqual(await store.readCredential(profile.id), replacement); + }); + + for (const race of ['delete', 'switch'] as const) { + it(`revokes a transient completion instead of persisting when pairing races with ${race}`, async () => { + const store = await createStore(); + const profileA = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }); + const profileB = await store.save({ id: 'profile-b', label: 'B', apiBaseUrl: 'https://b.example.test' }); + let service!: DesktopCredentialService; + let raced = false; + let raceOperation: Promise = Promise.resolve(); + const revocations: string[] = []; + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + let listCalls = 0; + const profiles = { + list: async () => { + const result = await store.list(); + listCalls += 1; + if (listCalls === 2 && !raced) { + raced = true; + raceOperation = race === 'delete' + ? service.removeProfile(profileA.id) + : service.setActiveProfile(profileB.id); + } + return result; + }, + saveAndDetachCredential: (input: Parameters[0]) => + store.saveAndDetachCredential(input), + commitPairedProfile: (...args: Parameters) => { + if (!raced) { + raced = true; + raceOperation = race === 'delete' + ? service.removeProfile(profileA.id) + : service.setActiveProfile(profileB.id); + } + return store.commitPairedProfile(...args); + }, + detachProfile: (profileId: string) => store.detachProfile(profileId), + setActive: (profileId: string | null) => store.setActive(profileId), + activateProfile: (...args: Parameters) => store.activateProfile(...args), + security: () => store.security(), + readCredential: (profileId: string) => store.readCredential(profileId), + readProfileCredential: (profileId: string) => store.readProfileCredential(profileId), + writeCredential: (value: StoredCredential) => store.writeCredential(value), + removeCredential: (profileId: string) => store.removeCredential(profileId), + removeCredentialIfCurrent: (...args: Parameters) => + store.removeCredentialIfCurrent(...args), + journalPendingRevocation: (value: StoredCredential) => store.journalPendingRevocation(value), + releasePendingRevocation: (...args: Parameters) => + store.releasePendingRevocation(...args), + pendingRevocations: () => store.pendingRevocations(), + completePendingRevocation: (...args: Parameters) => + store.completePendingRevocation(...args), + awaitIdle: () => store.awaitIdle(), + }; + service = createCredentialService({ + profiles, + clientName: 'Test desktop', + pairingTiming: { + now: () => pairingNow, + sleep: async () => undefined, + }, + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url.endsWith('/api/desktop/pairings')) return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://a.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + if (url.endsWith('/poll')) { + return provisionalPairingResponse(url, token('C')); + } + if (url.endsWith('/activate')) return pairingActivationReceipt(); + if (url.endsWith('/api/desktop/tokens/current')) { + revocations.push(new Headers(init?.headers).get('Authorization') ?? ''); + return new Response(null, { status: 204 }); + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + + await assert.rejects( + service.pair({ id: profileA.id, label: profileA.label, apiBaseUrl: profileA.apiBaseUrl }), + /cancelled/i, + ); + await raceOperation; + assert.equal(await store.readCredential(profileA.id), null); + assert.deepEqual(revocations, [`Bearer ${token('C')}`]); + console.log('NATIVE_SCENARIO transient-revocation'); + }); + } + + const pairedPublishBoundaries = ['state-written', 'state-fsynced'] as const; + const pairedPublishRaces = ['cancel', 'switch'] as const; + assert.equal(pairedPublishBoundaries.length * pairedPublishRaces.length, 4); + for (const boundary of pairedPublishBoundaries) { + for (const race of pairedPublishRaces) { + it(`keeps durable A when ${race} linearizes at paired ${boundary} before publish`, async () => { + const directory = await mkdtemp(join(tmpdir(), 'propr-credential-service-')); + temporaryDirectories.push(directory); + const reached = deferred(); + const release = deferred(); + let armed = false; + const store = new ProfileStore(directory, encryption, { + afterDurabilityStep: async step => { + if (!armed || step !== boundary) return; + armed = false; + reached.resolve(); + await release.promise; + }, + }); + const profileA = await store.save({ + id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test', + }); + const profileB = await store.save({ + id: 'profile-b', label: 'Other', apiBaseUrl: 'https://b.example.test', + }); + const credentialA = credential(profileA.id, profileA.apiBaseUrl, 'A'); + await store.writeCredential(credentialA); + await store.setActive(profileA.id); + const pairingNow = Date.parse('2026-01-01T00:00:00.000Z'); + const revocations: string[] = []; + const service = createCredentialService({ + profiles: store, + clientName: 'Test desktop', + pairingTiming: { now: () => pairingNow, sleep: async () => undefined }, + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + const url = input.toString(); + if (url.endsWith('/api/desktop/pairings')) return pairingStartResponse(url, init, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'C'.repeat(43), + approvalUrl: 'https://a.example.test/approve', + expiresAt: new Date(pairingNow + 10_000).toISOString(), + interval: 1, + }, 201); + if (url.endsWith('/poll')) { + return provisionalPairingResponse(url, token('C')); + } + if (url.endsWith('/activate')) return pairingActivationReceipt(); + if (url.endsWith('/api/desktop/tokens/current')) { + revocations.push(new Headers(init?.headers).get('Authorization') ?? ''); + return new Response(null, { status: 204 }); + } + throw new Error(`Unexpected request: ${url}`); + }, + }); + armed = true; + const pairing = service.pair({ + id: profileA.id, label: 'Proposed B', apiBaseUrl: profileA.apiBaseUrl, + }); + await reached.promise; + const raced = race === 'cancel' + ? Promise.resolve(service.cancelPairing(profileA.id)) + : service.setActiveProfile(profileB.id); + release.resolve(); + + await assert.rejects(pairing, /cancelled/i); + await raced; + const restarted = new ProfileStore(directory, encryption); + const snapshot = await restarted.readProfileCredential(profileA.id); + assert.equal(snapshot.profile?.label, 'A'); + assert.deepEqual(snapshot.credential, credentialA); + assert.equal((await restarted.list()).activeProfileId, race === 'cancel' ? profileA.id : profileB.id); + assert.deepEqual(revocations, [`Bearer ${token('C')}`]); + assert.deepEqual(service.prepareRequest( + `${profileA.apiBaseUrl}/api/tasks`, transportHeaders('AAAAAAAAAAAAAAAAAAAAAA'), + ), { cancel: true }); + console.log('NATIVE_SCENARIO cancellation-switch'); + }); + } + } +}); diff --git a/apps/desktop/src/credential-service.ts b/apps/desktop/src/credential-service.ts new file mode 100644 index 000000000..9e6aa97d2 --- /dev/null +++ b/apps/desktop/src/credential-service.ts @@ -0,0 +1,1519 @@ +import { randomBytes } from 'node:crypto'; +import { + DESKTOP_DISCOVERY_AUTHENTICATION_REQUIRED, + ProprClient, + ProprClientError, + type PairingProtocolRequestOptions, + type ProprDesktopPairingOptions, +} from '@propr/client'; +import { + DESKTOP_REVOCATION_BINDING_HEADER, + DESKTOP_TOKEN_REVOCATION_ENDPOINT, + DESKTOP_TOKEN_REVOCATION_SCHEMA, + DESKTOP_TOKEN_REVOCATION_VERSION, + DESKTOP_TOKEN_TERMINAL_CODES, + DESKTOP_TRANSPORT_SCOPE_HEADER, + DESKTOP_TRANSPORT_SCOPE_QUERY, + canonicalProprHttpUrlOrigin, + isPublicInstanceIdentity, +} from '@propr/shared'; +import { + type DesktopProfileInput, + type DesktopConnectionResult, + type DesktopActivatedConnection, + type DesktopAccessInvalidation, + type DesktopConnectionScope, +} from './shared/contract'; +import { normalizeApiBaseUrl } from './security'; +import type { PendingCredentialRevocation, ProfileStore, StoredCredential } from './profile-store'; +import type { DesktopConnectIdentityClaimSnapshot } from './connect-discovery'; + +const DEFINITIVE_INVALID_CODES = new Set([ + 'INVALID_INSTANCE_TOKEN', + 'INSTANCE_TOKEN_EXPIRED', + 'INSTANCE_TOKEN_REVOKED', +]); + +export interface CredentialServiceDependencies { + profiles: Pick; + fetch: typeof globalThis.fetch; + openPairingBrowser(request: DesktopPairingBrowserRequest): Promise; + clientName: string; + /** Deterministic pairing timing for protocol tests. Production uses the client defaults. */ + pairingTiming?: Pick; + /** Deterministic service/native lifecycle proof; production uses fixed protocol defaults. */ + pairingProtocol?: PairingProtocolRequestOptions; + /** Tests may shorten, but never enlarge, the production revocation deadlines. */ + revocationDeadlines?: Partial; + reportRevocationFailure?(diagnostic: { + code: 'network' | 'http' | 'local-cleanup'; + status?: number; + }): void; + /** Main-owned Connect evidence; renderer input can never provide this snapshot. */ + snapshotConnectIdentityClaim?(profileId: string, origin: string): DesktopConnectIdentityClaimSnapshot; +} + +export interface DesktopPairingBrowserRequest { + apiBaseUrl: string; + pairingId: string; + approvalUrl: string; +} + +export interface CredentialServiceInitialization { + status: 'ready' | 'degraded'; + retryPending: boolean; +} + +interface RevocationDeadlines { + headerMs: number; + bodyMs: number; + recordMs: number; + aggregateMs: number; +} + +interface ActiveCredential extends StoredCredential { + identityEpoch: string; + profileGeneration: number; + selectionGeneration: number; + transportScope: string; + connectClaim: DesktopConnectIdentityClaimSnapshot; +} + +interface PendingActivation { + ticket: string; + probeTicket: number; + profileId: string; + origin: string; + profileGeneration: number; + selectionGeneration: number; + activeProfileId: string | null; + credential: StoredCredential; + identityEpoch: string; + connectClaim: DesktopConnectIdentityClaimSnapshot; +} + +type RequestHeaders = Record; +export interface DesktopRequestDecision { + cancel?: true; + requestHeaders?: RequestHeaders; +} + +const headerName = (headers: RequestHeaders, name: string): string | undefined => + Object.keys(headers).find(key => key.toLowerCase() === name.toLowerCase()); + +const removeHeader = (headers: RequestHeaders, name: string): void => { + for (const existing of Object.keys(headers)) { + if (existing.toLowerCase() === name.toLowerCase()) delete headers[existing]; + } +}; + +const headerValues = (headers: RequestHeaders, name: string): string[] => { + const values: string[] = []; + for (const [key, value] of Object.entries(headers)) { + if (key.toLowerCase() !== name.toLowerCase()) continue; + if (Array.isArray(value)) values.push(...value); + else values.push(value); + } + return values; +}; + +const TRANSPORT_SCOPE_PATTERN = /^[A-Za-z0-9_-]{22}$/; +const MAX_REVOCATION_RESPONSE_BYTES = 2_048; +const TERMINAL_REVOCATION_CODES = new Set(DESKTOP_TOKEN_TERMINAL_CODES); +const REVOCATION_DEADLINES: RevocationDeadlines = { + headerMs: 8_000, + bodyMs: 2_000, + recordMs: 10_000, + aggregateMs: 12_000, +}; + +const boundedRevocationDeadlines = ( + requested: Partial | undefined, +): RevocationDeadlines => Object.fromEntries( + Object.entries(REVOCATION_DEADLINES).map(([key, maximum]) => { + const value = requested?.[key as keyof RevocationDeadlines] ?? maximum; + if (!Number.isSafeInteger(value) || value < 1 || value > maximum) { + throw new Error('Invalid desktop revocation deadline'); + } + return [key, value]; + }), +) as unknown as RevocationDeadlines; + +const linkedAbortController = (signals: readonly AbortSignal[]): { + controller: AbortController; + dispose: () => void; +} => { + const controller = new AbortController(); + const onAbort = (event: Event): void => { + const signal = event.target as AbortSignal; + if (!controller.signal.aborted) controller.abort(signal.reason); + }; + for (const signal of signals) { + if (signal.aborted) { + controller.abort(signal.reason); + break; + } + signal.addEventListener('abort', onAbort, { once: true }); + } + return { + controller, + dispose: () => signals.forEach(signal => signal.removeEventListener('abort', onAbort)), + }; +}; + +const requestOrigin = (value: string): { origin: string; pathname: string; url: URL } | null => { + try { + const httpValue = value.replace(/^ws:/i, 'http:').replace(/^wss:/i, 'https:'); + const url = new URL(value); + if (url.protocol === 'ws:') url.protocol = 'http:'; + if (url.protocol === 'wss:') url.protocol = 'https:'; + if (url.username || url.password || !['http:', 'https:'].includes(url.protocol)) return null; + if (canonicalProprHttpUrlOrigin(httpValue) !== url.origin) return null; + return { origin: url.origin, pathname: url.pathname, url }; + } catch { + return null; + } +}; + +const parseCode = async (response: Response): Promise => { + try { + const value = await response.clone().json() as { code?: unknown }; + return typeof value.code === 'string' ? value.code : undefined; + } catch { + return undefined; + } +}; + +const isEndpointBoundTerminalRevocation = async ( + response: Response, + credential: StoredCredential, + credentialGeneration: string, + signal: AbortSignal, + abortNetwork: () => void, + bodyDeadlineMs: number, +): Promise => { + if (response.redirected) return false; + if (response.url) { + try { + const url = new URL(response.url); + if (url.href !== `${credential.origin}${DESKTOP_TOKEN_REVOCATION_ENDPOINT}`) return false; + } catch { + return false; + } + } + if (response.ok) return true; + if (response.status !== 401 && response.status !== 404) return false; + const contentType = response.headers.get('content-type')?.split(';', 1)[0]?.trim().toLowerCase(); + if (contentType !== 'application/json') return false; + const declaredLength = response.headers.get('content-length'); + if (declaredLength !== null + && (!/^(?:0|[1-9][0-9]*)$/.test(declaredLength) + || Number(declaredLength) > MAX_REVOCATION_RESPONSE_BYTES)) return false; + if (!response.body) return false; + const reader = response.body.getReader(); + const chunks: Uint8Array[] = []; + let received = 0; + let deadline: ReturnType | undefined; + let rejectAbort!: (reason: unknown) => void; + const aborted = new Promise((_resolve, reject) => { rejectAbort = reject; }); + const onAbort = (): void => rejectAbort(signal.reason ?? new Error('Desktop revocation body was cancelled')); + if (signal.aborted) onAbort(); + else signal.addEventListener('abort', onAbort, { once: true }); + deadline = setTimeout(() => { + abortNetwork(); + rejectAbort(new Error('Desktop revocation body timed out')); + }, bodyDeadlineMs); + let text: string; + try { + while (true) { + const part = await Promise.race([reader.read(), aborted]); + if (part.done) break; + if (!(part.value instanceof Uint8Array) || part.value.byteLength === 0) { + abortNetwork(); + return false; + } + received += part.value.byteLength; + if (received > MAX_REVOCATION_RESPONSE_BYTES) { + abortNetwork(); + return false; + } + chunks.push(Uint8Array.from(part.value)); + } + if (declaredLength !== null && Number(declaredLength) !== received) { + abortNetwork(); + return false; + } + const bytes = new Uint8Array(received); + let offset = 0; + for (const chunk of chunks) { + bytes.set(chunk, offset); + offset += chunk.byteLength; + } + text = new TextDecoder('utf-8', { fatal: true }).decode(bytes); + } catch { + abortNetwork(); + return false; + } finally { + if (deadline) clearTimeout(deadline); + signal.removeEventListener('abort', onAbort); + if (signal.aborted) { + // Invoking both primitives is important for native fetch and deterministic + // ReadableStream tests. Network abort is the authoritative bounded wait. + let cancelDeadline: ReturnType | undefined; + try { + await Promise.race([ + reader.cancel(), + new Promise(resolve => { + cancelDeadline = setTimeout(resolve, Math.min(bodyDeadlineMs, 100)); + }), + ]); + } catch { + // The owning network controller is already aborted. + } finally { + if (cancelDeadline) clearTimeout(cancelDeadline); + } + } + try { reader.releaseLock(); } catch { /* A hostile stream may retain a pending read. */ } + } + let raw: unknown; + try { + raw = JSON.parse(text) as unknown; + } catch { + abortNetwork(); + return false; + } + if (!raw || typeof raw !== 'object' || Array.isArray(raw)) { + abortNetwork(); + return false; + } + const body = raw as Record; + const expectedKeys = [ + 'schema', 'version', 'endpoint', 'terminal', 'code', 'credentialGeneration', + ]; + if (Object.keys(body).length !== expectedKeys.length + || expectedKeys.some(key => !(key in body))) { + abortNetwork(); + return false; + } + if (body.schema !== DESKTOP_TOKEN_REVOCATION_SCHEMA + || body.version !== DESKTOP_TOKEN_REVOCATION_VERSION + || body.endpoint !== DESKTOP_TOKEN_REVOCATION_ENDPOINT + || body.terminal !== true + || body.credentialGeneration !== credentialGeneration + || typeof body.code !== 'string' + || !TERMINAL_REVOCATION_CODES.has(body.code)) { + abortNetwork(); + return false; + } + const terminal = response.status === 404 + ? body.code === 'TOKEN_NOT_FOUND' + : body.code === 'INSTANCE_TOKEN_REVOKED' || body.code === 'INSTANCE_TOKEN_EXPIRED'; + if (!terminal) abortNetwork(); + return terminal; +}; + +const authenticationSummary = (capabilities: { + browserPairing: boolean; + instanceBearerTokens: boolean; + socketIoBearerAuthentication: boolean; +}): string => capabilities.browserPairing + && capabilities.instanceBearerTokens + && capabilities.socketIoBearerAuthentication + ? 'Browser approval · REST and Socket.IO bearer access' + : 'Secure desktop pairing is unavailable'; + +export class DesktopCredentialService { + readonly #profiles: CredentialServiceDependencies['profiles']; + readonly #fetch: typeof globalThis.fetch; + readonly #openPairingBrowser: (request: DesktopPairingBrowserRequest) => Promise; + readonly #clientName: string; + readonly #pairingTiming: Pick; + readonly #pairingProtocol: PairingProtocolRequestOptions; + readonly #reportRevocationFailure: NonNullable; + readonly #revocationDeadlines: RevocationDeadlines; + readonly #snapshotConnectIdentityClaim: NonNullable; + readonly #internalRequestKey = randomBytes(32).toString('base64url'); + readonly #lifecycleController = new AbortController(); + readonly #profileGenerations = new Map(); + readonly #pairingControllers = new Map(); + #selectionGeneration = 0; + #latestProbeTicket = 0; + #pendingActivation: PendingActivation | null = null; + #active: ActiveCredential | null = null; + #publishingPair = false; + #publishWaiters: Array<() => void> = []; + #retryRequested = false; + #retryIncludeDeferred = false; + #revocationWorker: Promise | null = null; + readonly #backgroundTasks = new Set>(); + readonly #operationTasks = new Set>(); + readonly #operationControllers = new Set(); + #closed = false; + #disposePromise: Promise | null = null; + + constructor(dependencies: CredentialServiceDependencies) { + this.#profiles = dependencies.profiles; + this.#fetch = dependencies.fetch; + this.#openPairingBrowser = dependencies.openPairingBrowser; + this.#clientName = dependencies.clientName; + this.#pairingTiming = dependencies.pairingTiming ?? {}; + this.#pairingProtocol = dependencies.pairingProtocol ?? {}; + this.#reportRevocationFailure = dependencies.reportRevocationFailure ?? (() => undefined); + this.#revocationDeadlines = boundedRevocationDeadlines(dependencies.revocationDeadlines); + this.#snapshotConnectIdentityClaim = dependencies.snapshotConnectIdentityClaim ?? (() => ({ + status: 'unclaimed', + isCurrent: () => true, + beginCommit: () => () => undefined, + })); + } + + async initialize(): Promise { + const operation = this.#beginOperation(); + try { + const worker = this.#requestPendingRevocationRetry(true); + let startupTimer: ReturnType | undefined; + try { + return await Promise.race([ + worker, + new Promise(resolve => { + startupTimer = setTimeout( + () => resolve({ status: 'degraded', retryPending: true }), + this.#revocationDeadlines.aggregateMs, + ); + }), + ]); + } finally { + if (startupTimer) clearTimeout(startupTimer); + } + } finally { + operation.done(); + } + } + + awaitIdle(): Promise { + return this.#awaitIdle(); + } + + async listProfiles() { + const operation = this.#beginOperation(); + try { + return await this.#profiles.list(); + } finally { + operation.done(); + } + } + + async storageSecurity() { + const operation = this.#beginOperation(); + try { + return this.#profiles.security(); + } finally { + operation.done(); + } + } + + async retryPendingRevocations(): Promise { + const operation = this.#beginOperation(); + try { + return await this.#requestPendingRevocationRetry(true); + } finally { + operation.done(); + } + } + + dispose(): Promise { + if (this.#disposePromise) return this.#disposePromise; + this.#closed = true; + this.#active = null; + this.#pendingActivation = null; + this.#lifecycleController.abort(new Error('Desktop credential service disposed')); + for (const controller of this.#operationControllers) controller.abort(new Error('Desktop credential service disposed')); + for (const controller of this.#pairingControllers.values()) controller.abort(); + this.#pairingControllers.clear(); + this.#disposePromise = (async () => { + await this.#awaitIdle(); + await this.#profiles.awaitIdle(); + })(); + return this.#disposePromise; + } + + async saveProfile( + input: DesktopProfileInput, + beforeOriginChangeCommit?: (previousOrigin: string, nextOrigin: string) => Promise, + ) { + const operation = this.#beginOperation(); + try { + await this.#waitForPairPublish(); + this.#schedulePendingRevocationRetry(); + const before = input.id + ? (await this.#profiles.list()).profiles.find(profile => profile.id === input.id) + : undefined; + const nextOrigin = normalizeApiBaseUrl(input.apiBaseUrl ?? ''); + if (!nextOrigin) throw new Error('Invalid desktop API URL'); + let invalidatedBeforeSave = false; + if (before && before.apiBaseUrl !== nextOrigin) { + this.#invalidateProfileOperations(before.id); + invalidatedBeforeSave = true; + } + const transaction = await this.#profiles.saveAndDetachCredential(input, beforeOriginChangeCommit); + if (transaction.originChanged && !invalidatedBeforeSave) { + this.#invalidateProfileOperations(transaction.profile.id); + } + if (transaction.detachedCredential) this.#clearActiveIfCredential(transaction.detachedCredential); + if (transaction.originChanged && this.#active?.profileId === transaction.profile.id) this.#active = null; + this.#schedulePendingRevocationRetry(); + return transaction.profile; + } finally { + operation.done(); + } + } + + async removeProfile( + profileId: string, + beforeCommit?: (origin: string) => Promise, + ): Promise { + const operation = this.#beginOperation(); + try { + if (this.#publishingPair) await this.#waitForPairPublish(); + this.#invalidateProfileOperations(profileId); + this.#schedulePendingRevocationRetry(); + const detached = await this.#profiles.detachProfile(profileId, beforeCommit); + if (!detached) return null; + if (detached.credential) this.#clearActiveIfCredential(detached.credential); + this.#schedulePendingRevocationRetry(); + return detached.profile.apiBaseUrl; + } finally { + operation.done(); + } + } + + async setActiveProfile(profileId: string | null): Promise { + const operation = this.#beginOperation(); + try { + if (this.#publishingPair) await this.#waitForPairPublish(); + this.#selectionGeneration += 1; + this.#latestProbeTicket += 1; + this.#pendingActivation = null; + for (const controller of this.#pairingControllers.values()) controller.abort(); + this.#pairingControllers.clear(); + this.#active = null; + this.#schedulePendingRevocationRetry(); + await this.#profiles.setActive(profileId); + } finally { + operation.done(); + } + } + + async cancelPairing(profileId: string): Promise { + const operation = this.#beginOperation(); + try { + if (this.#publishingPair) await this.#waitForPairPublish(); + this.#cancelPairingNow(profileId); + } finally { + operation.done(); + } + } + + #cancelPairingNow(profileId: string): void { + const generation = this.#bumpGeneration(profileId); + // Cancelling an in-progress edit must not disable the still-committed + // credential for an active profile. + if (this.#active?.profileId === profileId) this.#active.profileGeneration = generation; + this.#pairingControllers.get(profileId)?.abort(); + this.#pairingControllers.delete(profileId); + } + + async pair(input: DesktopProfileInput): Promise<{ paired: true }> { + const operation = this.#beginOperation(); + try { + await this.#waitForPairPublish(); + this.#schedulePendingRevocationRetry(); + if (!input.id) throw new Error('Desktop profile id is required'); + if (!this.#profiles.security().available) { + throw new Error('OS-backed secure storage is required for desktop pairing.'); + } + const origin = normalizeApiBaseUrl(input.apiBaseUrl ?? ''); + if (!origin) throw new Error('Invalid desktop API URL'); + const label = input.label?.trim(); + if (!label || label.length > 80) throw new Error('Profile label must contain 1 to 80 characters'); + const proposed = { ...input, id: input.id, label, apiBaseUrl: origin }; + const connectClaim = this.#snapshotConnectIdentityClaim(proposed.id, proposed.apiBaseUrl); + if (connectClaim.status === 'origin-mismatch' || connectClaim.status === 'pending') { + throw new Error('The ProPR Connect origin changed. Use the currently discovered instance.'); + } + const baseline = await this.#profiles.readProfileCredential(proposed.id); + this.#cancelPairingNow(proposed.id); + if (this.#pendingActivation?.profileId === proposed.id) this.#pendingActivation = null; + const controller = new AbortController(); + this.#pairingControllers.set(proposed.id, controller); + const profileGeneration = this.#generation(proposed.id); + const selectionGeneration = this.#selectionGeneration; + const credentialGeneration = randomBytes(16).toString('base64url'); + let transient: StoredCredential | null = null; + let transientRevocation: PendingCredentialRevocation | null = null; + let provisional: Awaited> | null = null; + let publicationStarted = false; + const client = this.#client(proposed.apiBaseUrl); + + try { + const discovery = await client.discoverDesktop(8_000, controller.signal); + if (!discovery.compatibility.compatible + || !discovery.desktopAuthentication.browserPairing + || !discovery.desktopAuthentication.instanceBearerTokens + || !discovery.desktopAuthentication.socketIoBearerAuthentication + || (connectClaim.status === 'claimed' + && connectClaim.publicInstanceIdentity !== discovery.publicInstanceIdentity)) { + throw new Error('The ProPR instance identity or desktop protocol changed. Approve the new instance again.'); + } + this.#assertPairingCurrent( + proposed.id, proposed.apiBaseUrl, profileGeneration, selectionGeneration, controller.signal, connectClaim, + ); + const completed = await client.pairDesktop(this.#clientName, { + ...this.#pairingTiming, + binding: { + instanceId: proposed.id, + origin: proposed.apiBaseUrl, + scope: 'desktop-instance', + credentialGeneration, + }, + signal: controller.signal, + onApprovalRequired: async (approvalUrl, _expiresAt, pairingId) => { + this.#assertPairingCurrent( + proposed.id, proposed.apiBaseUrl, profileGeneration, selectionGeneration, controller.signal, connectClaim, + ); + await this.#openPairingBrowser({ + apiBaseUrl: proposed.apiBaseUrl, + pairingId, + approvalUrl, + }); + }, + }); + provisional = completed; + transient = { + version: 2, + profileId: proposed.id, + origin: proposed.apiBaseUrl, + publicInstanceIdentity: discovery.publicInstanceIdentity, + token: completed.token, + }; + this.#assertPairingCurrent( + proposed.id, proposed.apiBaseUrl, profileGeneration, selectionGeneration, controller.signal, connectClaim, + ); + const journaled = await this.#profiles.journalPendingRevocation(transient, credentialGeneration); + if ('stored' in journaled) { + throw new Error('OS-backed secure storage is required for desktop pairing.'); + } + transientRevocation = journaled; + this.#assertPairingCurrent( + proposed.id, proposed.apiBaseUrl, profileGeneration, selectionGeneration, controller.signal, connectClaim, + ); + let activationError: unknown; + for (let attempt = 0; attempt < 2; attempt += 1) { + try { + this.#assertPairingCurrent( + proposed.id, proposed.apiBaseUrl, profileGeneration, selectionGeneration, controller.signal, connectClaim, + ); + await client.activateDesktopPairing(completed, controller.signal); + activationError = undefined; + break; + } catch (error) { + activationError = error; + if (controller.signal.aborted) break; + } + } + if (activationError) throw activationError; + this.#assertPairingCurrent( + proposed.id, proposed.apiBaseUrl, profileGeneration, selectionGeneration, controller.signal, connectClaim, + ); + const committed = await this.#profiles.commitPairedProfile( + proposed, + transient, + baseline, + () => !controller.signal.aborted + && this.#generation(proposed.id) === profileGeneration + && this.#selectionGeneration === selectionGeneration + && connectClaim.isCurrent(), + () => this.#beginPairPublish( + proposed.id, profileGeneration, selectionGeneration, controller.signal, connectClaim, + ), + () => { + publicationStarted = true; + if (this.#active?.profileId === proposed.id) this.#active = null; + }, + transientRevocation.id, + ); + if (committed && 'stored' in committed) { + throw new Error('OS-backed secure storage is required for desktop pairing.'); + } + if (!committed) throw new ProprClientError('Desktop pairing was cancelled.', { kind: 'aborted' }); + transient = null; + transientRevocation = null; + this.#schedulePendingRevocationRetry(); + return { paired: true }; + } catch (error) { + if (transient && !transientRevocation && !publicationStarted) { + try { + const journaled = await this.#profiles.journalPendingRevocation(transient, credentialGeneration); + if (!('stored' in journaled)) transientRevocation = journaled; + } catch { + // Preserve the original pairing/storage error. A retry is attempted + // below whenever durable material was established. + } + } + if (transientRevocation && !publicationStarted) { + let cancelled = false; + if (provisional) { + try { + await client.cancelDesktopPairing(provisional, operation.signal); + cancelled = await this.#profiles.completePendingRevocation( + transientRevocation.id, + transientRevocation.credential, + transientRevocation.credentialGeneration, + ); + } catch { + // The encrypted rollback remains authoritative until either exact + // cancellation or the endpoint-bound revocation worker confirms it. + } + } + if (!cancelled) { + const released = await this.#profiles.releasePendingRevocation( + transientRevocation.id, + transientRevocation.credentialGeneration, + ); + if (released) await this.#requestPendingRevocationRetry(); + } + } + if (controller.signal.aborted || operation.signal.aborted + || (error instanceof ProprClientError && error.kind === 'aborted')) { + throw new Error('Desktop pairing was cancelled.'); + } + throw error; + } finally { + if (this.#pairingControllers.get(proposed.id) === controller) this.#pairingControllers.delete(proposed.id); + } + } finally { + operation.done(); + } + } + + async probe(input: DesktopProfileInput): Promise { + const operation = this.#beginOperation(); + try { + await this.#waitForPairPublish(); + this.#schedulePendingRevocationRetry(); + if (!input.id) throw new Error('Desktop profile id is required'); + const origin = normalizeApiBaseUrl(input.apiBaseUrl ?? ''); + if (!origin || origin !== input.apiBaseUrl) throw new Error('Invalid desktop API URL'); + const connectClaim = this.#snapshotConnectIdentityClaim(input.id, origin); + if (connectClaim.status === 'origin-mismatch' || connectClaim.status === 'pending') { + return { + status: 'authentication-required', + message: 'The ProPR Connect instance changed. Use the currently discovered instance and approve it again.', + }; + } + const probeTicket = ++this.#latestProbeTicket; + this.#pendingActivation = null; + const operationGeneration = this.#generation(input.id); + const operationSelection = this.#selectionGeneration; + const discoveryClient = this.#client(origin); + let discovery; + try { + discovery = await discoveryClient.discoverDesktop(8_000, operation.signal); + } catch (error) { + // Only the client's typed signal for the exact credential-free public + // discovery request is actionable here. Generic HTTP 401s, malformed + // identity, redirects, and authenticated operation failures stay strict. + if (error instanceof ProprClientError + && error.kind === 'invalid_response' + && error.code === DESKTOP_DISCOVERY_AUTHENTICATION_REQUIRED) { + return { + status: 'incompatible', + message: 'This instance requires authentication for public desktop discovery. Check its proxy configuration or update ProPR, then try again.', + }; + } + if (error instanceof ProprClientError && error.kind === 'invalid_response') { + try { + const current = await this.#profiles.readProfileCredential(input.id); + if (current.profile?.apiBaseUrl === origin && current.credential?.origin === origin) { + const removed = await this.#detachIdentityFailedCredential( + current.credential, + operationGeneration, + operationSelection, + probeTicket, + ); + if (!removed) { + return { status: 'offline', message: 'This connection changed while it was being checked. Try again.' }; + } + } + } catch { + return { status: 'offline', message: 'ProPR could not safely invalidate this instance credential.' }; + } + return { + status: 'authentication-required', + message: 'This endpoint returned invalid identity metadata. Approve it again to continue.', + }; + } + return { + status: 'offline', + message: error instanceof Error + ? `ProPR could not discover this instance. ${error.message}` + : 'ProPR could not discover this instance.', + }; + } + const authentication = authenticationSummary(discovery.desktopAuthentication); + if (!connectClaim.isCurrent()) { + return { + status: 'authentication-required', + message: 'The ProPR Connect instance changed. Use the currently discovered instance and approve it again.', + version: discovery.version, + authentication, + }; + } + const initial = await this.#profiles.readProfileCredential(input.id); + if (this.#generation(input.id) !== operationGeneration + || this.#selectionGeneration !== operationSelection + || this.#latestProbeTicket !== probeTicket) { + return { status: 'offline', message: 'This connection changed while it was being checked. Try again.' }; + } + const identityMismatched = initial.profile?.apiBaseUrl === origin + && initial.credential?.origin === origin + && (!isPublicInstanceIdentity(initial.credential.publicInstanceIdentity) + || initial.credential.publicInstanceIdentity !== discovery.publicInstanceIdentity); + if (identityMismatched) { + const removed = await this.#detachIdentityFailedCredential( + initial.credential!, + operationGeneration, + operationSelection, + probeTicket, + ); + if (!removed) { + return { status: 'offline', message: 'This connection changed while it was being checked. Try again.' }; + } + } + if (!discovery.compatibility.compatible) { + return { status: 'incompatible', message: discovery.compatibility.message, version: discovery.version }; + } + if (!discovery.desktopAuthentication.browserPairing + || !discovery.desktopAuthentication.instanceBearerTokens + || !discovery.desktopAuthentication.socketIoBearerAuthentication) { + return { + status: 'authentication-required', + message: 'This instance does not support the complete secure desktop authentication protocol.', + version: discovery.version, + authentication, + }; + } + if (!this.#profiles.security().available) { + return { + status: 'authentication-required', + message: 'OS-backed secure storage is unavailable. Enable your system keychain before pairing.', + version: discovery.version, + authentication, + }; + } + + if (connectClaim.status === 'claimed' + && connectClaim.publicInstanceIdentity !== discovery.publicInstanceIdentity) { + return { + status: 'authentication-required', + message: 'The ProPR Connect instance changed. Use the currently discovered instance and approve it again.', + version: discovery.version, + authentication, + }; + } + if (identityMismatched) { + return { + status: 'authentication-required', + message: 'This endpoint now identifies as a different ProPR instance. Approve it again to continue.', + version: discovery.version, + authentication, + }; + } + if (initial.profile?.apiBaseUrl !== origin) { + return { + status: 'authentication-required', + message: discovery.desktopAuthentication.browserPairing + ? 'Approve this desktop in your browser to continue.' + : 'This instance does not support secure desktop pairing.', + version: discovery.version, + authentication, + }; + } + const credential = initial.credential; + if (!credential) { + return { + status: 'authentication-required', + message: discovery.desktopAuthentication.browserPairing + ? 'Approve this desktop in your browser to continue.' + : 'This instance does not support secure desktop pairing.', + version: discovery.version, + authentication, + }; + } + if (credential.origin !== origin) { + const removed = await this.#profiles.removeCredentialIfCurrent( + credential, + origin, + () => this.#generation(input.id!) === operationGeneration + && this.#selectionGeneration === operationSelection + && this.#latestProbeTicket === probeTicket, + ); + if (!removed) { + return { status: 'offline', message: 'This connection changed while it was being checked. Try again.' }; + } + this.#clearActiveIfCredential(credential); + this.#schedulePendingRevocationRetry(); + return { + status: 'authentication-required', + message: discovery.desktopAuthentication.browserPairing + ? 'Approve this desktop in your browser to continue.' + : 'This instance does not support secure desktop pairing.', + version: discovery.version, + authentication, + }; + } + let response: Response; + try { + if (!connectClaim.isCurrent()) { + return { status: 'offline', message: 'This connection changed while it was being checked. Try again.' }; + } + response = await this.#authenticatedFetch( + credential, '/api/auth/user', { cache: 'no-store', signal: operation.signal }, 8_000, + ); + } catch { + return { status: 'offline', message: 'The instance was discovered but authentication could not be checked.' }; + } + if (response.ok) { + const current = await this.#profiles.readProfileCredential(input.id); + if (this.#generation(input.id) !== operationGeneration + || this.#selectionGeneration !== operationSelection + || this.#latestProbeTicket !== probeTicket + || !connectClaim.isCurrent() + || current.profile?.apiBaseUrl !== origin + || current.credential?.origin !== origin) { + return { status: 'offline', message: 'This connection changed while it was being checked. Try again.' }; + } + if (!current.credential + || current.credential.version !== credential.version + || current.credential.profileId !== credential.profileId + || current.credential.origin !== credential.origin + || current.credential.publicInstanceIdentity !== credential.publicInstanceIdentity + || current.credential.token !== credential.token) { + return { status: 'offline', message: 'This connection changed while it was being checked. Try again.' }; + } + const activationTicket = randomBytes(32).toString('base64url'); + this.#pendingActivation = { + ticket: activationTicket, + probeTicket, + profileId: input.id, + origin, + profileGeneration: operationGeneration, + selectionGeneration: operationSelection, + activeProfileId: current.activeProfileId, + credential: { ...credential }, + identityEpoch: current.identityEpoch!, + connectClaim, + }; + return { status: 'ready', version: discovery.version, authentication, activationTicket }; + } + + const code = await parseCode(response); + if (code && DEFINITIVE_INVALID_CODES.has(code)) { + const removed = await this.#profiles.removeCredentialIfCurrent( + credential, + origin, + () => this.#generation(input.id!) === operationGeneration + && this.#selectionGeneration === operationSelection + && this.#latestProbeTicket === probeTicket, + ); + if (!removed) { + return { status: 'offline', message: 'This connection changed while it was being checked. Try again.' }; + } + this.#clearActiveIfCredential(credential); + this.#schedulePendingRevocationRetry(); + return { + status: 'authentication-required', + message: 'Access to this instance was revoked or expired. Pair again to continue.', + version: discovery.version, + authentication, + }; + } + if (response.status === 401 || response.status === 403) { + return { + status: 'offline', + message: 'The credential is still paired, but current authorization could not be confirmed. Try again.', + }; + } + return { status: 'offline', message: `The instance returned HTTP ${response.status} while checking authentication.` }; + } finally { + operation.done(); + } + } + + async activate(activationTicket: unknown): Promise { + const operation = this.#beginOperation(); + try { + await this.#waitForPairPublish(); + this.#schedulePendingRevocationRetry(); + if (typeof activationTicket !== 'string' || !/^[A-Za-z0-9_-]{43}$/.test(activationTicket)) { + throw new Error('Invalid desktop activation ticket'); + } + const pending = this.#pendingActivation; + // Consume before awaiting so concurrent calls and replays can never share a + // credential-bearing activation decision. + this.#pendingActivation = null; + if (!pending || pending.ticket !== activationTicket || !this.#pendingIsCurrent(pending)) { + throw new Error('Desktop activation expired. Check the connection again.'); + } + + const activated = await this.#profiles.activateProfile( + pending.credential, + pending.identityEpoch, + pending.origin, + pending.activeProfileId, + () => this.#pendingIsCurrent(pending), + ); + if (activated !== pending.identityEpoch || !this.#pendingIsCurrent(pending)) { + this.#active = null; + throw new Error('Desktop activation expired. Check the connection again.'); + } + + const transportScope = randomBytes(16).toString('base64url'); + this.#selectionGeneration += 1; + for (const controller of this.#pairingControllers.values()) controller.abort(); + this.#pairingControllers.clear(); + this.#active = { + ...pending.credential, + identityEpoch: pending.identityEpoch, + profileGeneration: pending.profileGeneration, + selectionGeneration: this.#selectionGeneration, + transportScope, + connectClaim: pending.connectClaim, + }; + return { + status: 'ready', + profileId: pending.profileId, + transportScope, + identityEpoch: pending.identityEpoch, + }; + } finally { + operation.done(); + } + } + + async invalidate(value: DesktopAccessInvalidation): Promise<{ invalidated: boolean }> { + const operation = this.#beginOperation(); + try { + await this.#waitForPairPublish(); + this.#schedulePendingRevocationRetry(); + if (!DEFINITIVE_INVALID_CODES.has(value.code)) return { invalidated: false }; + const active = this.#active; + if (!active || active.profileId !== value.profileId + || active.transportScope !== value.transportScope + || this.#generation(active.profileId) !== active.profileGeneration + || this.#selectionGeneration !== active.selectionGeneration) return { invalidated: false }; + this.#active = null; + const invalidationGeneration = this.#bumpGeneration(active.profileId); + const removed = await this.#profiles.removeCredentialIfCurrent( + active, + active.origin, + () => this.#generation(active.profileId) === invalidationGeneration, + ); + if (removed) this.#schedulePendingRevocationRetry(); + return { invalidated: removed }; + } finally { + operation.done(); + } + } + + async discardActivation(value: DesktopConnectionScope): Promise<{ discarded: boolean }> { + const operation = this.#beginOperation(); + try { + await this.#waitForPairPublish(); + this.#schedulePendingRevocationRetry(); + const active = this.#active; + if (!active || typeof value?.profileId !== 'string' || typeof value?.transportScope !== 'string' + || active.profileId !== value.profileId || active.transportScope !== value.transportScope + || this.#generation(active.profileId) !== active.profileGeneration + || this.#selectionGeneration !== active.selectionGeneration) return { discarded: false }; + this.#active = null; + this.#selectionGeneration += 1; + this.#latestProbeTicket += 1; + this.#pendingActivation = null; + await this.#profiles.setActive(null); + return { discarded: true }; + } finally { + operation.done(); + } + } + + /** Whether main still owns the complete binding required by renderer transport and LNA. */ + hasActiveRendererBinding(): boolean { + const active = this.#active; + return active !== null + && this.#generation(active.profileId) === active.profileGeneration + && this.#selectionGeneration === active.selectionGeneration + && active.connectClaim.isCurrent(); + } + + prepareRequest( + url: string, + originalHeaders: RequestHeaders, + details: { method?: string; rendererOwned?: boolean; resourceType?: string } = {}, + verifiedSocketCredential?: ActiveCredential, + ): DesktopRequestDecision { + if (this.#closed) return { cancel: true }; + const headers = { ...originalHeaders }; + if (/^(?:https?|wss?):/i.test(url)) { + const httpUrl = url.replace(/^ws:/i, 'http:').replace(/^wss:/i, 'https:'); + if (!canonicalProprHttpUrlOrigin(httpUrl)) return { cancel: true }; + } + const internalHeader = headerName(headers, 'x-propr-desktop-main-request'); + const trustedMainRequest = internalHeader !== undefined + && headers[internalHeader] === this.#internalRequestKey; + if (internalHeader) delete headers[internalHeader]; + + const scopeValues = headerValues(headers, DESKTOP_TRANSPORT_SCOPE_HEADER); + removeHeader(headers, DESKTOP_TRANSPORT_SCOPE_HEADER); + + // The packaged renderer has no cookie identity on any remote HTTP(S) or + // WS(S) origin. It also cannot supply its own bearer. Main-process bearer + // requests are distinguished by the per-process secret marker above. + removeHeader(headers, 'cookie'); + if (!trustedMainRequest) removeHeader(headers, 'authorization'); + + const target = requestOrigin(url); + if (target && target.url.protocol === 'http:' && !normalizeApiBaseUrl(target.origin)) { + return { cancel: true }; + } + if (trustedMainRequest) return { requestHeaders: headers }; + + const markedRestRequest = scopeValues.length > 0; + if (markedRestRequest && (scopeValues.length !== 1 || !TRANSPORT_SCOPE_PATTERN.test(scopeValues[0]))) { + return { cancel: true }; + } + if (!trustedMainRequest && target + && (target.pathname.startsWith('/api/desktop/pairings') + || target.pathname.startsWith('/api/desktop/tokens'))) return { cancel: true }; + + const active = this.#active; + const activeIsCurrent = active !== null + && this.#generation(active.profileId) === active.profileGeneration + && this.#selectionGeneration === active.selectionGeneration + && active.connectClaim.isCurrent(); + const isApiRequest = target?.pathname.startsWith('/api/') === true; + const socketScopeValues = target?.url.searchParams.getAll(DESKTOP_TRANSPORT_SCOPE_QUERY) ?? []; + const isSocketCandidate = target?.pathname === '/socket.io/' || socketScopeValues.length > 0; + const isSocketUpgrade = target?.pathname === '/socket.io/' + && target.url.searchParams.get('transport') === 'websocket' + && (details.resourceType === 'webSocket' + || headerValues(originalHeaders, 'upgrade').some(value => value.toLowerCase() === 'websocket')); + + // Session security supplies this ownership bit at the actual WebContents + // boundary. A foreign renderer may load only unmarked credentialless + // resources; it can never exercise a REST/Socket scope or receive a bearer. + if (details.rendererOwned === false) { + if (markedRestRequest || isSocketCandidate) return { cancel: true }; + return { requestHeaders: headers }; + } + + // Chromium can cache Local Network Access after activation is discarded. + // The live main renderer must therefore remain pinned to the exact current + // origin even for sanitized traffic that does not carry a transport scope. + if (details.rendererOwned === true && target + && (!activeIsCurrent || target.origin !== active.origin)) return { cancel: true }; + + if (isSocketUpgrade && target) { + if (socketScopeValues.length !== 1 || !TRANSPORT_SCOPE_PATTERN.test(socketScopeValues[0]) + || !activeIsCurrent || active !== verifiedSocketCredential || target.origin !== active.origin + || socketScopeValues[0] !== active.transportScope) return { cancel: true }; + headers.Authorization = `Bearer ${active.token}`; + return { requestHeaders: headers }; + } + + if (!markedRestRequest) return { requestHeaders: headers }; + if (!target || !isApiRequest || !activeIsCurrent || target.origin !== active.origin + || scopeValues[0] !== active.transportScope) return { cancel: true }; + if (details.method?.toUpperCase() === 'OPTIONS') return { requestHeaders: headers }; + headers.Authorization = `Bearer ${active.token}`; + return { requestHeaders: headers }; + } + + /** Socket reconnects cross a fresh asynchronous identity gate before main attaches a bearer. */ + async prepareRequestAsync( + url: string, + originalHeaders: RequestHeaders, + details: { method?: string; rendererOwned?: boolean; resourceType?: string } = {}, + ): Promise { + const target = requestOrigin(url); + const isSocketUpgrade = target?.pathname === '/socket.io/' + && target.url.searchParams.get('transport') === 'websocket' + && (details.resourceType === 'webSocket' + || headerValues(originalHeaders, 'upgrade').some(value => value.toLowerCase() === 'websocket')); + if (!isSocketUpgrade || details.rendererOwned === false) { + return this.prepareRequest(url, originalHeaders, details); + } + const active = this.#active; + if (!active || target.origin !== active.origin) return this.prepareRequest(url, originalHeaders, details); + try { + const discovery = await this.#client(active.origin).discoverDesktop(8_000, this.#lifecycleController.signal); + const stillCurrent = this.#active === active + && this.#generation(active.profileId) === active.profileGeneration + && this.#selectionGeneration === active.selectionGeneration + && active.connectClaim.isCurrent(); + if (!stillCurrent) return { cancel: true }; + const supportsRequest = discovery.compatibility.compatible + && discovery.desktopAuthentication.instanceBearerTokens + && discovery.desktopAuthentication.socketIoBearerAuthentication; + if (discovery.publicInstanceIdentity !== active.publicInstanceIdentity || !supportsRequest) { + await this.#detachIdentityFailedCredential( + active, + active.profileGeneration, + active.selectionGeneration, + ); + return { cancel: true }; + } + return this.prepareRequest(url, originalHeaders, details, active); + } catch (error) { + if (error instanceof ProprClientError && error.kind === 'invalid_response' && this.#active === active) { + await this.#detachIdentityFailedCredential( + active, + active.profileGeneration, + active.selectionGeneration, + ).catch(() => undefined); + } + return { cancel: true }; + } + } + + authorizeRequest(url: string, originalHeaders: RequestHeaders): RequestHeaders { + return this.prepareRequest(url, originalHeaders).requestHeaders ?? {}; + } + + sanitizeResponseHeaders(url: string, originalHeaders: RequestHeaders): RequestHeaders { + const headers = { ...originalHeaders }; + const target = requestOrigin(url); + if (target) removeHeader(headers, 'set-cookie'); + return headers; + } + + #client(origin: string): ProprClient { + return new ProprClient({ + baseUrl: origin, + authentication: { type: 'none' }, + fetch: this.#mainFetch, + defaultTimeoutMs: 8_000, + pairingProtocol: this.#pairingProtocol, + }); + } + + #authenticatedFetch( + credential: StoredCredential, + path: string, + init: RequestInit, + timeoutMs: number, + ): Promise { + const client = new ProprClient({ + baseUrl: credential.origin, + authentication: { type: 'bearer', getAccessToken: () => credential.token }, + fetch: this.#mainFetch, + }); + return client.fetch(client.url(path), { ...init, redirect: 'manual' }, { timeoutMs }); + } + + readonly #mainFetch: typeof globalThis.fetch = (input, init) => { + const headers = new Headers(init?.headers); + headers.set('X-ProPR-Desktop-Main-Request', this.#internalRequestKey); + return this.#fetch(input, { ...init, headers }); + }; + + #schedulePendingRevocationRetry(includeDeferred = false): void { + this.#requestPendingRevocationRetry(includeDeferred); + } + + #requestPendingRevocationRetry( + includeDeferred = false, + ): Promise { + if (this.#closed) return Promise.resolve({ status: 'degraded', retryPending: true }); + this.#retryRequested = true; + this.#retryIncludeDeferred ||= includeDeferred; + if (this.#revocationWorker) return this.#revocationWorker; + const worker = this.#runPendingRevocationWorker(); + this.#revocationWorker = worker; + this.#backgroundTasks.add(worker); + const settled = (): void => { + this.#backgroundTasks.delete(worker); + if (this.#revocationWorker === worker) this.#revocationWorker = null; + }; + worker.then(settled, settled); + return worker; + } + + async #runPendingRevocationWorker(): Promise { + const aggregate = linkedAbortController([this.#lifecycleController.signal]); + const aggregateTimer = setTimeout( + () => aggregate.controller.abort(new Error('Desktop revocation aggregate deadline exceeded')), + this.#revocationDeadlines.aggregateMs, + ); + const attemptedGenerations = new Set(); + let retryPending = false; + try { + while (this.#retryRequested && !this.#closed && !aggregate.controller.signal.aborted) { + this.#retryRequested = false; + const includeDeferred = this.#retryIncludeDeferred; + this.#retryIncludeDeferred = false; + let pending: PendingCredentialRevocation[]; + try { + pending = await this.#profiles.pendingRevocations(includeDeferred); + } catch { + retryPending = true; + this.#reportFixedRevocationFailure({ code: 'local-cleanup' }); + continue; + } + for (const entry of pending) { + if (attemptedGenerations.has(entry.credentialGeneration)) continue; + if (this.#closed || aggregate.controller.signal.aborted) { + retryPending = true; + this.#reportFixedRevocationFailure({ code: 'network' }); + break; + } + attemptedGenerations.add(entry.credentialGeneration); + const result = await this.#retryPendingRevocation(entry, aggregate.controller.signal); + if (result === 'complete') continue; + retryPending = true; + if (result === 'network') { + this.#reportFixedRevocationFailure({ code: 'network' }); + } else if (typeof result === 'object') { + this.#reportFixedRevocationFailure({ code: 'http', status: result.status }); + } else { + this.#reportFixedRevocationFailure({ code: 'local-cleanup' }); + } + } + } + if (aggregate.controller.signal.aborted || this.#closed) retryPending = true; + return { status: retryPending ? 'degraded' : 'ready', retryPending }; + } finally { + clearTimeout(aggregateTimer); + aggregate.dispose(); + } + } + + async #retryPendingRevocation( + entry: PendingCredentialRevocation, + aggregateSignal: AbortSignal, + ): Promise<'complete' | 'network' | 'local-cleanup' | { status: number; type: 'http' }> { + const record = linkedAbortController([ + this.#lifecycleController.signal, + aggregateSignal, + ]); + const recordTimer = setTimeout( + () => record.controller.abort(new Error('Desktop revocation record deadline exceeded')), + this.#revocationDeadlines.recordMs, + ); + try { + try { + const discovery = await this.#client(entry.credential.origin) + .discoverDesktop(Math.min(8_000, this.#revocationDeadlines.recordMs), record.controller.signal); + if (discovery.publicInstanceIdentity !== entry.credential.publicInstanceIdentity) return 'network'; + } catch { + return 'network'; + } + const headers = new Headers({ + Authorization: `Bearer ${entry.credential.token}`, + [DESKTOP_REVOCATION_BINDING_HEADER]: entry.credentialGeneration, + }); + let response: Response; + const headerTimer = setTimeout( + () => record.controller.abort(new Error('Desktop revocation header deadline exceeded')), + this.#revocationDeadlines.headerMs, + ); + try { + response = await this.#mainFetch( + `${entry.credential.origin}${DESKTOP_TOKEN_REVOCATION_ENDPOINT}`, + { + method: 'DELETE', + headers, + credentials: 'omit', + cache: 'no-store', + redirect: 'manual', + signal: record.controller.signal, + }, + ); + } catch { + return 'network'; + } finally { + clearTimeout(headerTimer); + } + if (!await isEndpointBoundTerminalRevocation( + response, + entry.credential, + entry.credentialGeneration, + record.controller.signal, + () => record.controller.abort(new Error('Desktop revocation response rejected')), + this.#revocationDeadlines.bodyMs, + )) { + return { type: 'http', status: response.status }; + } + record.controller.abort(); + try { + const completed = await this.#profiles.completePendingRevocation( + entry.id, entry.credential, entry.credentialGeneration, + ); + return completed ? 'complete' : 'local-cleanup'; + } catch { + return 'local-cleanup'; + } + } finally { + record.controller.abort(); + clearTimeout(recordTimer); + record.dispose(); + } + } + + async #awaitIdle(): Promise { + while (this.#backgroundTasks.size > 0 || this.#operationTasks.size > 0) { + await Promise.allSettled([...this.#backgroundTasks, ...this.#operationTasks]); + } + } + + #reportFixedRevocationFailure(diagnostic: { + code: 'network' | 'http' | 'local-cleanup'; + status?: number; + }): void { + try { + this.#reportRevocationFailure(diagnostic); + } catch { + // Diagnostics must never alter durable retry state or task settlement. + } + } + + #assertOpen(): void { + if (this.#closed) throw new Error('Desktop credential service is closed'); + } + + #beginOperation(): { signal: AbortSignal; done: () => void } { + this.#assertOpen(); + const linked = linkedAbortController([this.#lifecycleController.signal]); + const controller = linked.controller; + let settle!: () => void; + const task = new Promise(resolve => { settle = resolve; }); + this.#operationTasks.add(task); + this.#operationControllers.add(controller); + let finished = false; + return { + signal: controller.signal, + done: () => { + if (finished) return; + finished = true; + linked.dispose(); + this.#operationControllers.delete(controller); + this.#operationTasks.delete(task); + settle(); + }, + }; + } + + #beginPairPublish( + profileId: string, + profileGeneration: number, + selectionGeneration: number, + signal: AbortSignal, + connectClaim: DesktopConnectIdentityClaimSnapshot, + ): (() => void) | null { + if (this.#publishingPair || signal.aborted + || this.#generation(profileId) !== profileGeneration + || this.#selectionGeneration !== selectionGeneration + || !connectClaim.isCurrent()) return null; + const releaseConnectClaim = connectClaim.beginCommit(); + if (!releaseConnectClaim) return null; + this.#publishingPair = true; + let released = false; + return () => { + if (released) return; + released = true; + this.#publishingPair = false; + releaseConnectClaim(); + const waiters = this.#publishWaiters.splice(0); + waiters.forEach(waiter => waiter()); + }; + } + + #waitForPairPublish(): Promise { + if (!this.#publishingPair) return Promise.resolve(); + return new Promise(resolve => this.#publishWaiters.push(resolve)); + } + + #generation(profileId: string): number { + return this.#profileGenerations.get(profileId) ?? 0; + } + + #pendingIsCurrent(pending: PendingActivation): boolean { + return this.#latestProbeTicket === pending.probeTicket + && this.#generation(pending.profileId) === pending.profileGeneration + && this.#selectionGeneration === pending.selectionGeneration + && pending.connectClaim.isCurrent(); + } + + #clearActiveIfCredential(credential: StoredCredential): void { + if (this.#active?.profileId === credential.profileId + && this.#active.origin === credential.origin + && this.#active.token === credential.token) this.#active = null; + } + + async #detachIdentityFailedCredential( + credential: StoredCredential, + expectedProfileGeneration: number, + expectedSelectionGeneration: number, + expectedProbeTicket?: number, + ): Promise { + if (this.#generation(credential.profileId) !== expectedProfileGeneration + || this.#selectionGeneration !== expectedSelectionGeneration + || (expectedProbeTicket !== undefined && this.#latestProbeTicket !== expectedProbeTicket)) return false; + this.#invalidateProfileOperations(credential.profileId); + const invalidationGeneration = this.#generation(credential.profileId); + const removed = await this.#profiles.removeCredentialIfCurrent( + credential, + credential.origin, + () => this.#generation(credential.profileId) === invalidationGeneration + && this.#selectionGeneration === expectedSelectionGeneration + && (expectedProbeTicket === undefined || this.#latestProbeTicket === expectedProbeTicket), + ); + if (removed) this.#schedulePendingRevocationRetry(); + return removed; + } + + #bumpGeneration(profileId: string): number { + const generation = this.#generation(profileId) + 1; + this.#profileGenerations.set(profileId, generation); + return generation; + } + + #invalidateProfileOperations(profileId: string): void { + this.#bumpGeneration(profileId); + if (this.#pendingActivation?.profileId === profileId) this.#pendingActivation = null; + if (this.#active?.profileId === profileId) this.#active = null; + this.#pairingControllers.get(profileId)?.abort(); + this.#pairingControllers.delete(profileId); + } + + #assertPairingCurrent( + profileId: string, + origin: string, + profileGeneration: number, + selectionGeneration: number, + signal: AbortSignal, + connectClaim: DesktopConnectIdentityClaimSnapshot, + ): void { + if (signal.aborted || this.#generation(profileId) !== profileGeneration + || this.#selectionGeneration !== selectionGeneration + || !connectClaim.isCurrent()) { + throw new ProprClientError('Desktop pairing was cancelled.', { kind: 'aborted' }); + } + if (normalizeApiBaseUrl(origin) !== origin) throw new Error('Invalid desktop API URL'); + } + +} diff --git a/apps/desktop/src/desktop-session.ts b/apps/desktop/src/desktop-session.ts index 1beb2fd79..0e0eadfb2 100644 --- a/apps/desktop/src/desktop-session.ts +++ b/apps/desktop/src/desktop-session.ts @@ -16,3 +16,21 @@ export const logoutDesktopSession = async ( throw new Error(`Desktop logout failed with HTTP ${response.status}`); } }; + +/** Remove legacy browser identity/state so named bearer profiles cannot inherit it. */ +export const clearDesktopInstanceCookies = async ( + desktopSession: Pick, + apiBaseUrls: readonly unknown[], +): Promise => { + const origins = new Set(); + for (const value of apiBaseUrls) { + if (typeof value !== 'string') throw new Error('Invalid desktop API URL'); + const normalized = normalizeApiBaseUrl(value); + if (!normalized || normalized !== value) throw new Error('Invalid desktop API URL'); + origins.add(normalized); + } + await Promise.all([...origins].map(origin => desktopSession.clearStorageData({ + origin, + storages: ['cookies', 'localstorage', 'indexdb', 'cachestorage', 'serviceworkers'], + }))); +}; diff --git a/apps/desktop/src/discovery-ipc.test.ts b/apps/desktop/src/discovery-ipc.test.ts new file mode 100644 index 000000000..2fb5ff64c --- /dev/null +++ b/apps/desktop/src/discovery-ipc.test.ts @@ -0,0 +1,72 @@ +import assert from 'node:assert/strict'; +import { describe, it } from 'node:test'; +import type { App, IpcMain, IpcMainInvokeEvent, Session } from 'electron'; +import type { DesktopCredentialService } from './credential-service'; +import { registerIpcHandlers } from './ipc'; +import type { LocalLifecycleController } from './lifecycle'; +import type { DesktopLogger } from './logger'; +import { createDesktopBridge, type PreloadIpc } from './preload-bridge'; +import type { ProfileStore } from './profile-store'; + +const rendererUrl = 'propr-app://renderer/renderer.html'; + +describe('main-to-preload Connect discovery IPC', () => { + it('returns only typed candidates and redacts underlying discovery failures', async () => { + const handlers = new Map unknown>(); + let fail = false; + const registered = registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain: { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: {} as ProfileStore, + credentials: {} as DesktopCredentialService, + connectDiscovery: { + discover: async () => { + if (fail) throw new Error('token-sentinel at /private/native/root'); + return [{ + id: 'connect-candidate', + label: 'ProPR Connect', + apiBaseUrl: 'https://t-discovered123.propr.dev', + }]; + }, + rediscover: async profileId => ({ + id: String(profileId), + label: 'Saved connection', + apiBaseUrl: 'https://t-recovered456.propr.dev', + }), + }, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession: {} as Session, + devServerUrl: undefined, + packagedRendererUrl: rendererUrl, + openExternal: async () => undefined, + }); + const event = { senderFrame: { url: rendererUrl } } as unknown as IpcMainInvokeEvent; + const ipc: PreloadIpc = { + invoke: (channel, ...args) => Promise.resolve(handlers.get(channel)!(event, ...args)), + on: () => undefined, + removeListener: () => undefined, + }; + const bridge = createDesktopBridge(ipc, true); + + assert.deepEqual(await bridge.discovery.discover(), [{ + id: 'connect-candidate', + label: 'ProPR Connect', + apiBaseUrl: 'https://t-discovered123.propr.dev', + }]); + assert.deepEqual(await bridge.discovery.rediscover('saved-profile'), { + id: 'saved-profile', + label: 'Saved connection', + apiBaseUrl: 'https://t-recovered456.propr.dev', + }); + fail = true; + await assert.rejects( + bridge.discovery.discover(), + (error: unknown) => String(error) === 'Error: Desktop operation failed [IPC_OPERATION_FAILED]', + ); + registered.dispose(); + }); +}); diff --git a/apps/desktop/src/ipc-lifecycle.test.ts b/apps/desktop/src/ipc-lifecycle.test.ts new file mode 100644 index 000000000..bf5b2a599 --- /dev/null +++ b/apps/desktop/src/ipc-lifecycle.test.ts @@ -0,0 +1,866 @@ +import assert from 'node:assert/strict'; +import { describe, it } from 'node:test'; +import type { App, IpcMain, IpcMainInvokeEvent, Session } from 'electron'; +import type { DesktopCredentialService } from './credential-service'; +import { registerIpcHandlers } from './ipc'; +import type { LocalLifecycleController } from './lifecycle'; +import type { DesktopLogger } from './logger'; +import type { ProfileStore } from './profile-store'; +import { rendererContentSecurityPolicy } from './security'; +import { IPC_CHANNELS } from './shared/contract'; +import { createDesktopShutdownCoordinator } from './shutdown'; + +const deferred = () => { + let resolve!: (value: T) => void; + let reject!: (error: unknown) => void; + const promise = new Promise((settle, fail) => { + resolve = settle; + reject = fail; + }); + return { promise, resolve, reject }; +}; + +const connectDiscovery = { + discover: async () => [], + rediscover: async () => null, +}; + +describe('desktop IPC shutdown gate', () => { + it('clears old and new origin storage through the real save IPC before a same-ID URL commit', async () => { + const handlers = new Map unknown>(); + const cleared: Array[0]> = []; + let cleanupObservedBeforeSave = false; + let reconciledOrigin: string | null | undefined; + const credentials = { + saveProfile: async ( + input: { id: string; label: string; apiBaseUrl: string }, + beforeCommit: (previousOrigin: string, nextOrigin: string) => Promise, + ) => { + await beforeCommit('https://old.example.test', input.apiBaseUrl); + cleanupObservedBeforeSave = cleared.length === 2; + return input; + }, + listProfiles: async () => ({ + profiles: [{ + id: 'profile-a', label: 'A edited', apiBaseUrl: 'http://localhost:4100', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:01:00.000Z', + }], + activeProfileId: null, + }), + } as unknown as DesktopCredentialService; + registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain: { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession: { + clearStorageData: async (options: Parameters[0]) => { cleared.push(options); }, + } as unknown as Session, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + onRendererActiveProfileChanged: origin => { reconciledOrigin = origin; }, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + + await Promise.resolve(handlers.get(IPC_CHANNELS.profilesSave)!(event, { + id: 'profile-a', label: 'A edited', apiBaseUrl: 'http://localhost:4100', + })); + + assert.equal(cleanupObservedBeforeSave, true); + assert.equal(reconciledOrigin, null); + assert.deepEqual(cleared, [ + { + origin: 'https://old.example.test', + storages: ['cookies', 'localstorage', 'indexdb', 'cachestorage', 'serviceworkers'], + }, + { + origin: 'http://localhost:4100', + storages: ['cookies', 'localstorage', 'indexdb', 'cachestorage', 'serviceworkers'], + }, + ]); + }); + + it('clears the renderer policy when the authoritative profile read fails after a save commit', async () => { + const handlers = new Map unknown>(); + let saveCommitted = false; + const credentials = { + saveProfile: async (input: { id: string; label: string; apiBaseUrl: string }) => { + saveCommitted = true; + return input; + }, + listProfiles: async () => { throw new Error('post-save profile read failed'); }, + } as unknown as DesktopCredentialService; + const reconciledOrigins: Array = []; + registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain: { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession: {} as Session, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + onRendererActiveProfileChanged: origin => { reconciledOrigins.push(origin); }, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + + await assert.rejects( + Promise.resolve(handlers.get(IPC_CHANNELS.profilesSave)!(event, { + id: 'profile-a', label: 'A edited', apiBaseUrl: 'http://localhost:4100', + })), + /Desktop operation failed \[IPC_OPERATION_FAILED\]/, + ); + + assert.equal(saveCommitted, true); + assert.deepEqual(reconciledOrigins, [null]); + }); + + for (const staleReadOutcome of ['resolve', 'reject'] as const) { + it(`does not publish a stale reconciliation when its profile read ${staleReadOutcome}s`, async () => { + const handlers = new Map unknown>(); + const firstRead = deferred<{ + profiles: Array<{ + id: string; + label: string; + apiBaseUrl: string; + createdAt: string; + updatedAt: string; + }>; + activeProfileId: string | null; + }>(); + const firstReadStarted = deferred(); + const oldProfile = { + id: 'profile-a', label: 'A', apiBaseUrl: 'http://localhost:4000', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }; + const currentProfile = { + id: 'profile-b', label: 'B', apiBaseUrl: 'http://127.0.0.1:4100', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:01:00.000Z', + }; + let listCalls = 0; + const credentials = { + saveProfile: async (input: typeof oldProfile) => input, + listProfiles: async () => { + listCalls += 1; + if (listCalls === 1) { + firstReadStarted.resolve(undefined); + return firstRead.promise; + } + return { profiles: [currentProfile], activeProfileId: currentProfile.id }; + }, + } as unknown as DesktopCredentialService; + const reconciledOrigins: Array = []; + registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain: { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession: {} as Session, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + onRendererActiveProfileChanged: origin => { reconciledOrigins.push(origin); }, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + const save = (profile: typeof oldProfile) => Promise.resolve( + handlers.get(IPC_CHANNELS.profilesSave)!(event, profile), + ); + + const staleSave = save(oldProfile); + await firstReadStarted.promise; + await save(currentProfile); + assert.deepEqual(reconciledOrigins, [currentProfile.apiBaseUrl]); + + if (staleReadOutcome === 'resolve') { + firstRead.resolve({ profiles: [oldProfile], activeProfileId: oldProfile.id }); + await staleSave; + } else { + firstRead.reject(new Error('stale profile read failed')); + await assert.rejects(staleSave, /Desktop operation failed \[IPC_OPERATION_FAILED\]/); + } + + assert.equal(listCalls, 2); + assert.deepEqual(reconciledOrigins, [currentProfile.apiBaseUrl]); + }); + } + + it('clears the renderer policy after re-pairing an active profile at a changed local origin', async () => { + const handlers = new Map unknown>(); + const activeProfile = { + id: 'profile-a', label: 'A', apiBaseUrl: 'http://localhost:4000', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }; + const pairedProfile = { + id: 'profile-a', label: 'A edited', apiBaseUrl: 'http://localhost:4100', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:01:00.000Z', + }; + let profiles = [activeProfile]; + let activeProfileId: string | null = activeProfile.id; + let listCalls = 0; + let pairedInput: { id: string; label: string; apiBaseUrl: string } | undefined; + const credentials = { + pair: async (input: { id: string; label: string; apiBaseUrl: string }) => { + pairedInput = input; + profiles = [pairedProfile]; + activeProfileId = null; + return { paired: true as const }; + }, + listProfiles: async () => { + listCalls += 1; + return { profiles, activeProfileId }; + }, + } as unknown as DesktopCredentialService; + let reconciledOrigin: string | null | undefined; + registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain: { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession: {} as Session, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + onRendererActiveProfileChanged: origin => { reconciledOrigin = origin; }, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + + const result = await Promise.resolve(handlers.get(IPC_CHANNELS.authenticationPair)!(event, { + id: pairedProfile.id, label: pairedProfile.label, apiBaseUrl: pairedProfile.apiBaseUrl, + })); + + assert.deepEqual(result, { paired: true }); + assert.deepEqual(pairedInput, { + id: pairedProfile.id, label: pairedProfile.label, apiBaseUrl: pairedProfile.apiBaseUrl, + }); + assert.equal(listCalls, 1); + assert.equal(reconciledOrigin, null); + }); + + it('reconciles the renderer policy after setting a different active profile', async () => { + const handlers = new Map unknown>(); + const profiles = [ + { + id: 'profile-a', label: 'A', apiBaseUrl: 'http://localhost:4000', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }, + { + id: 'profile-b', label: 'B', apiBaseUrl: 'http://127.0.0.1:4100', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }, + ]; + let activeProfileId: string | null = 'profile-a'; + const credentials = { + listProfiles: async () => ({ profiles, activeProfileId }), + setActiveProfile: async (profileId: string | null) => { activeProfileId = profileId; }, + } as unknown as DesktopCredentialService; + let reconciledOrigin: string | null | undefined; + registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain: { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession: { clearStorageData: async () => undefined } as unknown as Session, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + onRendererActiveProfileChanged: origin => { reconciledOrigin = origin; }, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + + await Promise.resolve(handlers.get(IPC_CHANNELS.profilesSetActive)!(event, 'profile-b')); + + assert.equal(reconciledOrigin, profiles[1].apiBaseUrl); + }); + + it('clears the renderer policy after removing the active profile', async () => { + const handlers = new Map unknown>(); + let removed = false; + const credentials = { + removeProfile: async ( + _profileId: string, + beforeCommit: (origin: string) => Promise, + ) => { + await beforeCommit('http://localhost:4000'); + removed = true; + return 'http://localhost:4000'; + }, + listProfiles: async () => ({ profiles: [], activeProfileId: null }), + } as unknown as DesktopCredentialService; + let reconciledOrigin: string | null | undefined; + registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain: { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession: { clearStorageData: async () => undefined } as unknown as Session, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + onRendererActiveProfileChanged: origin => { reconciledOrigin = origin; }, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + + await Promise.resolve(handlers.get(IPC_CHANNELS.profilesRemove)!(event, 'profile-a')); + + assert.equal(removed, true); + assert.equal(reconciledOrigin, null); + }); + + it('removes cleartext renderer sources after discarding the active loopback connection', async () => { + const handlers = new Map unknown>(); + const profile = { + id: 'profile-a', label: 'A', apiBaseUrl: 'http://localhost:4000', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }; + let activeProfileId: string | null = profile.id; + let policy = rendererContentSecurityPolicy(false, [profile.apiBaseUrl]); + let listCalls = 0; + const credentials = { + discardActivation: async () => { + activeProfileId = null; + return { discarded: true }; + }, + listProfiles: async () => { + listCalls += 1; + return { profiles: [profile], activeProfileId }; + }, + } as unknown as DesktopCredentialService; + registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain: { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession: {} as Session, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + onRendererActiveProfileChanged: origin => { + policy = rendererContentSecurityPolicy(false, origin ? [origin] : []); + }, + }); + const event = { senderFrame: { url: 'propr-renderer://app/index.html' } } as unknown as IpcMainInvokeEvent; + + const result = await Promise.resolve(handlers.get(IPC_CHANNELS.connectionDiscard)!(event, { + profileId: profile.id, + transportScope: 'scope-a', + })); + + assert.deepEqual(result, { discarded: true }); + assert.equal(listCalls, 1); + assert.equal(policy.includes(profile.apiBaseUrl), false); + assert.equal(policy.includes('ws://localhost:4000'), false); + }); + + it('clears both origins when activation edits the active profile URL without changing its ID', async () => { + const handlers = new Map unknown>(); + const ipcMain = { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain; + const before = { + id: 'profile-a', label: 'A', apiBaseUrl: 'https://old.example.test', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }; + const after = { + ...before, + apiBaseUrl: 'https://new.example.test', + updatedAt: '2026-08-30T00:01:00.000Z', + }; + let listCalls = 0; + const credentials = { + listProfiles: async () => ({ + profiles: [listCalls++ === 0 ? before : after], + activeProfileId: 'profile-a', + }), + activate: async () => ({ + status: 'ready', profileId: 'profile-a', transportScope: 'scope-b', identityEpoch: 'B'.repeat(22), + }), + } as unknown as DesktopCredentialService; + const cleared: Array[0]> = []; + const desktopSession = { + clearStorageData: async (options: Parameters[0]) => { + cleared.push(options); + }, + } as unknown as Session; + let reconciledOrigin: string | null | undefined; + registerIpcHandlers({ + app: { + getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true, + } as unknown as App, + ipcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + onRendererActiveProfileChanged: origin => { reconciledOrigin = origin; }, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + + const activated = await Promise.resolve( + handlers.get(IPC_CHANNELS.connectionActivate)!(event, 'T'.repeat(43)), + ); + + assert.deepEqual(activated, { + status: 'ready', profileId: 'profile-a', transportScope: 'scope-b', identityEpoch: 'B'.repeat(22), + }); + assert.equal(listCalls, 3); + assert.equal(reconciledOrigin, after.apiBaseUrl); + assert.deepEqual(cleared, [ + { + origin: 'https://old.example.test', + storages: ['cookies', 'localstorage', 'indexdb', 'cachestorage', 'serviceworkers'], + }, + { + origin: 'https://new.example.test', + storages: ['cookies', 'localstorage', 'indexdb', 'cachestorage', 'serviceworkers'], + }, + ]); + }); + + it('publishes the current active profile when another mutation completes during activation cleanup', async () => { + const handlers = new Map unknown>(); + const profiles = [ + { + id: 'profile-a', label: 'A', apiBaseUrl: 'http://localhost:4000', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }, + { + id: 'profile-b', label: 'B', apiBaseUrl: 'http://127.0.0.1:4100', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }, + { + id: 'profile-c', label: 'C', apiBaseUrl: 'http://[::1]:4200', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }, + ]; + let activeProfileId: string | null = profiles[0].id; + const credentials = { + listProfiles: async () => ({ profiles, activeProfileId }), + activate: async () => { + activeProfileId = profiles[1].id; + return { + status: 'ready', profileId: profiles[1].id, + transportScope: 'scope-b', identityEpoch: 'B'.repeat(22), + }; + }, + setActiveProfile: async (profileId: string | null) => { activeProfileId = profileId; }, + } as unknown as DesktopCredentialService; + const activationCleanupStarted = deferred(); + const finishActivationCleanup = deferred(); + let profileBClearCalls = 0; + const desktopSession = { + clearStorageData: async (options: Parameters[0]) => { + if (options?.origin !== profiles[1].apiBaseUrl || ++profileBClearCalls !== 1) return; + activationCleanupStarted.resolve(undefined); + await finishActivationCleanup.promise; + }, + } as unknown as Session; + const reconciledOrigins: Array = []; + registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain: { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + onRendererActiveProfileChanged: origin => { reconciledOrigins.push(origin); }, + }); + const event = { senderFrame: { url: 'propr-renderer://app/index.html' } } as unknown as IpcMainInvokeEvent; + + const activation = Promise.resolve( + handlers.get(IPC_CHANNELS.connectionActivate)!(event, 'T'.repeat(43)), + ); + await activationCleanupStarted.promise; + await Promise.resolve(handlers.get(IPC_CHANNELS.profilesSetActive)!(event, profiles[2].id)); + finishActivationCleanup.resolve(undefined); + await activation; + + assert.deepEqual(reconciledOrigins, [profiles[2].apiBaseUrl, profiles[2].apiBaseUrl]); + }); + + it('rejects activation and discards its exact scope when origin storage clearing fails', async () => { + const handlers = new Map unknown>(); + const ipcMain = { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain; + const profiles = [ + { + id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }, + { + id: 'profile-b', label: 'B', apiBaseUrl: 'https://b.example.test', + createdAt: '2026-08-30T00:00:00.000Z', updatedAt: '2026-08-30T00:00:00.000Z', + }, + ]; + let listCalls = 0; + let activeProfileId: string | null = 'profile-a'; + const discarded: Array<{ profileId: string; transportScope: string }> = []; + const credentials = { + listProfiles: async () => { + listCalls += 1; + return { profiles, activeProfileId }; + }, + activate: async () => { + activeProfileId = 'profile-b'; + return { + status: 'ready', profileId: 'profile-b', transportScope: 'scope-b', identityEpoch: 'B'.repeat(22), + }; + }, + discardActivation: async (scope: { profileId: string; transportScope: string }) => { + discarded.push(scope); + activeProfileId = null; + return { discarded: true }; + }, + } as unknown as DesktopCredentialService; + let clearCalls = 0; + const desktopSession = { + clearStorageData: async () => { + clearCalls += 1; + if (clearCalls === 2) throw new Error('storage clear failed'); + }, + } as unknown as Session; + let reconciledOrigin: string | null | undefined; + registerIpcHandlers({ + app: { + getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true, + } as unknown as App, + ipcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + onRendererActiveProfileChanged: origin => { reconciledOrigin = origin; }, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + + await assert.rejects( + Promise.resolve(handlers.get(IPC_CHANNELS.connectionActivate)!(event, 'T'.repeat(43))), + /Desktop operation failed \[IPC_OPERATION_FAILED\]/, + ); + assert.equal(clearCalls, 2); + assert.equal(listCalls, 3); + assert.deepEqual(discarded, [{ profileId: 'profile-b', transportScope: 'scope-b' }]); + assert.equal(reconciledOrigin, null); + }); + + it('discards the exact activation when the post-commit profile read fails', async () => { + const handlers = new Map unknown>(); + const ipcMain = { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain; + let listCalls = 0; + let discardCalls = 0; + const discardActivation = async (scope: { profileId: string; transportScope: string }) => { + discardCalls += 1; + assert.deepEqual(scope, { profileId: 'profile-b', transportScope: 'scope-b' }); + return { discarded: true }; + }; + const credentials = { + listProfiles: async () => { + listCalls += 1; + if (listCalls === 2) throw new Error('post-activation profile read failed'); + return { profiles: [], activeProfileId: null }; + }, + activate: async () => ({ + status: 'ready', profileId: 'profile-b', transportScope: 'scope-b', identityEpoch: 'B'.repeat(22), + }), + discardActivation, + } as unknown as DesktopCredentialService; + const desktopSession = { + clearStorageData: async () => { throw new Error('storage clearing should not start'); }, + } as unknown as Session; + registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + }); + const event = { senderFrame: { url: 'propr-renderer://app/index.html' } } as unknown as IpcMainInvokeEvent; + + await assert.rejects( + Promise.resolve(handlers.get(IPC_CHANNELS.connectionActivate)!(event, 'T'.repeat(43))), + /Desktop operation failed \[IPC_OPERATION_FAILED\]/, + ); + assert.equal(listCalls, 2); + assert.equal(discardCalls, 1); + }); + + it('clears a profile origin before committing removal and retains it when cleanup fails', async () => { + const handlers = new Map unknown>(); + const ipcMain = { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain; + let removalCommitted = false; + const credentials = { + removeProfile: async ( + _profileId: string, + beforeCommit: (origin: string) => Promise, + ) => { + await beforeCommit('https://a.example.test'); + removalCommitted = true; + return 'https://a.example.test'; + }, + } as unknown as DesktopCredentialService; + const desktopSession = { + clearStorageData: async () => { throw new Error('origin storage clear failed'); }, + } as unknown as Session; + registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + }); + const event = { senderFrame: { url: 'propr-renderer://app/index.html' } } as unknown as IpcMainInvokeEvent; + + await assert.rejects( + Promise.resolve(handlers.get(IPC_CHANNELS.profilesRemove)!(event, 'profile-a')), + /Desktop operation failed \[IPC_OPERATION_FAILED\]/, + ); + assert.equal(removalCommitted, false); + }); + + it('replaces every handler with a fixed closing failure and drains admitted work before disposal', async () => { + const handlers = new Map unknown>(); + const ipcMain = { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain; + const listResult = deferred<{ profiles: []; activeProfileId: null }>(); + let listCalls = 0; + const credentials = { + listProfiles: async () => { + listCalls += 1; + return listResult.promise; + }, + } as unknown as DesktopCredentialService; + const registered = registerIpcHandlers({ + app: { + getName: () => 'ProPR', + getVersion: () => '0.8.15', + isPackaged: true, + } as unknown as App, + ipcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession: {} as Session, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + const invoke = (channel: string) => Promise.resolve(handlers.get(channel)!(event)); + + const admitted = invoke(IPC_CHANNELS.profilesList); + await Promise.resolve(); + registered.close(); + await assert.rejects(invoke(IPC_CHANNELS.profilesList), /DESKTOP_CLOSING/); + assert.equal(listCalls, 1); + + let idle = false; + const draining = registered.awaitIdle().then(() => { idle = true; }); + await Promise.resolve(); + assert.equal(idle, false); + listResult.resolve({ profiles: [], activeProfileId: null }); + await admitted; + await draining; + + registered.dispose(); + assert.equal(handlers.size, 0); + }); + + for (const category of ['profile', 'pairing', 'session'] as const) { + it(`runs an admitted ${category} handler through the production before-quit drain`, async () => { + const handlers = new Map unknown>(); + const ipcMain = { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain; + const barrier = deferred(); + const started = deferred(); + let underlyingCalls = 0; + const begin = (): Promise => { + underlyingCalls += 1; + started.resolve(undefined); + return barrier.promise; + }; + const credentials = { + listProfiles: category === 'profile' ? begin : async () => ({ profiles: [], activeProfileId: null }), + pair: category === 'pairing' ? begin : async () => ({ paired: true }), + dispose: async () => undefined, + } as unknown as DesktopCredentialService; + const desktopSession = { + fetch: category === 'session' + ? async () => await begin() as Response + : async () => new Response(null, { status: 204 }), + } as unknown as Session; + const registered = registerIpcHandlers({ + app: { + getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true, + } as unknown as App, + ipcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + const invoke = (channel: string, ...args: unknown[]) => + Promise.resolve(handlers.get(channel)!(event, ...args)); + const channel = category === 'profile' + ? IPC_CHANNELS.profilesList + : category === 'pairing' + ? IPC_CHANNELS.authenticationPair + : IPC_CHANNELS.authLogout; + const args = category === 'pairing' + ? [{ id: 'profile-a', label: 'A', apiBaseUrl: 'https://a.example.test' }] + : category === 'session' ? ['https://a.example.test'] : []; + const admitted = invoke(channel, ...args); + await started.promise; + + const order: string[] = []; + const shutdown = createDesktopShutdownCoordinator({ + credentials: { dispose: async () => { order.push('credentials-dispose'); } }, + lifecycle: { shutdown: async () => { order.push('lifecycle-shutdown'); } }, + ipc: { + close: () => { order.push('ipc-close'); registered.close(); }, + awaitIdle: () => { order.push('ipc-drain'); return registered.awaitIdle(); }, + dispose: () => { order.push('ipc-dispose'); registered.dispose(); }, + }, + profiles: { close: async () => { order.push('profiles-close'); } }, + sessionSecurity: { + close: () => { order.push('session-close'); }, + dispose: () => { order.push('session-dispose'); }, + }, + disposeRendererProtocol: () => { order.push('protocol-dispose'); }, + getWindow: () => ({ + isDestroyed: () => false, + destroy: () => { order.push('window-destroy'); }, + }), + quit: () => { order.push('app-quit'); }, + onStarted: () => { order.push('shutdown-started'); }, + log: () => undefined, + }); + shutdown.beforeQuit({ preventDefault: () => undefined }); + await assert.rejects(invoke(channel, ...args), /DESKTOP_CLOSING/); + assert.equal(underlyingCalls, 1); + + if (category === 'profile') barrier.resolve({ profiles: [], activeProfileId: null }); + else if (category === 'pairing') barrier.resolve({ paired: true }); + else barrier.resolve(new Response(null, { status: 204 })); + await admitted; + await shutdown.awaitFinished(); + + assert.equal(handlers.size, 0); + assert.equal(order.indexOf('profiles-close') > order.indexOf('ipc-drain'), true); + assert.equal(order.indexOf('session-dispose') > order.indexOf('profiles-close'), true); + assert.deepEqual(order.slice(-3), ['ipc-dispose', 'window-destroy', 'app-quit']); + }); + } +}); diff --git a/apps/desktop/src/ipc.test.ts b/apps/desktop/src/ipc.test.ts index 8ac15b68b..fea2b754e 100644 --- a/apps/desktop/src/ipc.test.ts +++ b/apps/desktop/src/ipc.test.ts @@ -1,7 +1,7 @@ import assert from 'node:assert/strict'; import { describe, it } from 'node:test'; import type { Session } from 'electron'; -import { logoutDesktopSession } from './desktop-session'; +import { clearDesktopInstanceCookies, logoutDesktopSession } from './desktop-session'; describe('desktop session IPC operations', () => { it('logs out through the active Electron session with credentials and without following redirects', async () => { @@ -34,4 +34,26 @@ describe('desktop session IPC operations', () => { await assert.rejects(logoutDesktopSession(desktopSession, 'https://user:secret@example.com'), /Invalid desktop API URL/); assert.equal(requested, false); }); + + it('clears browser identity and origin storage for normalized profile origins when profiles switch', async () => { + const calls: Array[0]> = []; + const desktopSession: Pick = { + clearStorageData: async options => { calls.push(options ?? {}); }, + }; + + await clearDesktopInstanceCookies(desktopSession, [ + 'https://first.example.test', + 'https://second.example.test', + 'https://first.example.test', + ]); + + assert.deepEqual(calls, [ + { origin: 'https://first.example.test', storages: ['cookies', 'localstorage', 'indexdb', 'cachestorage', 'serviceworkers'] }, + { origin: 'https://second.example.test', storages: ['cookies', 'localstorage', 'indexdb', 'cachestorage', 'serviceworkers'] }, + ]); + await assert.rejects( + clearDesktopInstanceCookies(desktopSession, ['http://remote.example.test']), + /Invalid desktop API URL/, + ); + }); }); diff --git a/apps/desktop/src/ipc.ts b/apps/desktop/src/ipc.ts index 93245534b..924421b26 100644 --- a/apps/desktop/src/ipc.ts +++ b/apps/desktop/src/ipc.ts @@ -1,44 +1,137 @@ import type { App, IpcMain, IpcMainInvokeEvent, Session } from 'electron'; -import { shell } from 'electron'; -import { logoutDesktopSession } from './desktop-session'; +import { clearDesktopInstanceCookies, logoutDesktopSession } from './desktop-session'; +import type { DesktopCredentialService } from './credential-service'; +import type { DesktopConnectDiscoveryService } from './connect-discovery'; import type { DesktopLogger } from './logger'; import type { LocalLifecycleController } from './lifecycle'; import type { ProfileStore } from './profile-store'; import { isSafeExternalUrl, isTrustedRendererUrl } from './security'; import { IPC_CHANNELS } from './shared/contract'; +import type { DesktopAcceptanceJourneyStage } from './shared/contract'; + +export type DesktopAcceptanceOperation = 'PROFILE_SAVE' | 'PAIR' | 'PROBE' | 'ACTIVATE'; +export type DesktopAcceptanceOperationStatus = + | 'COMPLETED' + | 'READY' + | 'AUTHENTICATION_REQUIRED' + | 'INCOMPATIBLE' + | 'OFFLINE' + | 'REJECTED'; interface RegisterIpcOptions { app: App; ipcMain: IpcMain; profiles: ProfileStore; + credentials: DesktopCredentialService; + connectDiscovery: Pick; lifecycle: LocalLifecycleController; logger: DesktopLogger; desktopSession: Session; devServerUrl: string | undefined; packagedRendererUrl: string; + openExternal(url: string): Promise; + onRendererActiveProfileChanged?(origin: string | null): void; + /** @internal Deterministic admitted-work accounting for lifecycle proof. */ + observeInvocation?(phase: 'entry' | 'exit', channel: string): void; + /** @internal Fixed, secret-free packaged Connect acceptance evidence. */ + reportAcceptanceJourneyStage?(stage: DesktopAcceptanceJourneyStage): void; + /** @internal Fixed, secret-free packaged Connect operation evidence. */ + reportAcceptanceOperation?( + operation: DesktopAcceptanceOperation, + status: DesktopAcceptanceOperationStatus, + ): void; } type Handler = (event: IpcMainInvokeEvent, ...args: any[]) => unknown; -export const registerIpcHandlers = (options: RegisterIpcOptions): void => { +export interface RegisteredIpcHandlers { + close(): void; + awaitIdle(): Promise; + dispose(): void; +} + +const closingError = (): Error => new Error('DESKTOP_CLOSING'); +const acceptanceStages = new Set([ + 'AUTHENTICATION_REQUIRED', + 'CREDENTIAL_COMMITTED', + 'AUTHENTICATED_REPROBE_READY', + 'ACTIVATION_COMMITTED', + 'ACTIVATION_PUBLISHED', + 'REACT_CONNECTED', +]); +const acceptanceOperations = new Map([ + [IPC_CHANNELS.profilesSave, 'PROFILE_SAVE'], + [IPC_CHANNELS.authenticationPair, 'PAIR'], + [IPC_CHANNELS.connectionProbe, 'PROBE'], + [IPC_CHANNELS.connectionActivate, 'ACTIVATE'], +]); + +const acceptanceStatus = (result: unknown): DesktopAcceptanceOperationStatus => { + if (!result || typeof result !== 'object' || Array.isArray(result) || !('status' in result)) { + return 'COMPLETED'; + } + const status = (result as { status?: unknown }).status; + if (status === 'ready') return 'READY'; + if (status === 'authentication-required') return 'AUTHENTICATION_REQUIRED'; + if (status === 'incompatible') return 'INCOMPATIBLE'; + if (status === 'offline') return 'OFFLINE'; + return 'COMPLETED'; +}; + +export const registerIpcHandlers = (options: RegisterIpcOptions): RegisteredIpcHandlers => { + const channels = new Set(); + const active = new Set>(); + let closing = false; + let rendererActiveProfileReconciliationGeneration = 0; const trusted = (event: IpcMainInvokeEvent): boolean => { const senderUrl = event.senderFrame?.url ?? ''; return isTrustedRendererUrl(senderUrl, options.devServerUrl, options.packagedRendererUrl); }; const handle = (channel: string, handler: Handler): void => { + channels.add(channel); options.ipcMain.handle(channel, async (event, ...args) => { + if (closing) throw closingError(); if (!trusted(event)) { options.logger.log('warn', 'desktop.ipc.rejected', { channel }); throw new Error('Untrusted desktop IPC sender'); } + options.observeInvocation?.('entry', channel); + const invocation = Promise.resolve().then(() => handler(event, ...args)); + active.add(invocation); try { - return await handler(event, ...args); + const result = await invocation; + const operation = acceptanceOperations.get(channel); + if (operation) options.reportAcceptanceOperation?.(operation, acceptanceStatus(result)); + return result; } catch (error) { - options.logger.log('error', 'desktop.ipc.failed', { channel, error }); - throw error; + const operation = acceptanceOperations.get(channel); + if (operation) options.reportAcceptanceOperation?.(operation, 'REJECTED'); + options.logger.log('error', 'desktop.ipc.failed', { channel, code: 'IPC_OPERATION_FAILED' }); + throw new Error('Desktop operation failed [IPC_OPERATION_FAILED]'); + } finally { + active.delete(invocation); + options.observeInvocation?.('exit', channel); } }); }; + const reconcileRendererActiveProfile = async (): Promise => { + if (!options.onRendererActiveProfileChanged) return; + const generation = ++rendererActiveProfileReconciliationGeneration; + let current; + try { + current = await options.credentials.listProfiles(); + } catch (error) { + if (generation === rendererActiveProfileReconciliationGeneration) { + options.onRendererActiveProfileChanged(null); + } + throw error; + } + const activeOrigin = current.profiles + .find(profile => profile.id === current.activeProfileId)?.apiBaseUrl ?? null; + if (generation === rendererActiveProfileReconciliationGeneration) { + options.onRendererActiveProfileChanged(activeOrigin); + } + }; handle(IPC_CHANNELS.appMetadata, () => ({ name: options.app.getName(), @@ -50,18 +143,109 @@ export const registerIpcHandlers = (options: RegisterIpcOptions): void => { handle(IPC_CHANNELS.authLogout, (_event, apiBaseUrl) => logoutDesktopSession(options.desktopSession, apiBaseUrl)); handle(IPC_CHANNELS.openExternal, async (_event, value: unknown) => { if (typeof value !== 'string' || !isSafeExternalUrl(value)) throw new Error('External URL is not allowed'); - await shell.openExternal(value); + await options.openExternal(value); + }); + handle(IPC_CHANNELS.storageSecurity, () => options.credentials.storageSecurity()); + handle(IPC_CHANNELS.profilesList, () => options.credentials.listProfiles()); + handle(IPC_CHANNELS.profilesSave, async (_event, input) => { + const profile = await options.credentials.saveProfile( + input, + (previousOrigin, nextOrigin) => clearDesktopInstanceCookies( + options.desktopSession, + [previousOrigin, nextOrigin], + ), + ); + await reconcileRendererActiveProfile(); + return profile; + }); + handle(IPC_CHANNELS.profilesRemove, async (_event, profileId) => { + await options.credentials.removeProfile( + profileId, + origin => clearDesktopInstanceCookies(options.desktopSession, [origin]), + ); + await reconcileRendererActiveProfile(); }); - handle(IPC_CHANNELS.storageSecurity, () => options.profiles.security()); - handle(IPC_CHANNELS.profilesList, () => options.profiles.list()); - handle(IPC_CHANNELS.profilesSave, (_event, input) => options.profiles.save(input)); - handle(IPC_CHANNELS.profilesRemove, (_event, profileId) => options.profiles.remove(profileId)); - handle(IPC_CHANNELS.profilesSetActive, (_event, profileId) => options.profiles.setActive(profileId)); - handle(IPC_CHANNELS.credentialsRead, (_event, profileId) => options.profiles.readCredential(profileId)); - handle(IPC_CHANNELS.credentialsWrite, (_event, profileId, value) => options.profiles.writeCredential(profileId, value)); - handle(IPC_CHANNELS.credentialsRemove, (_event, profileId) => options.profiles.removeCredential(profileId)); + handle(IPC_CHANNELS.profilesSetActive, async (_event, profileId) => { + const current = await options.credentials.listProfiles(); + const previous = current.profiles.find(profile => profile.id === current.activeProfileId); + const next = current.profiles.find(profile => profile.id === profileId); + if (profileId !== null && !next) throw new Error('Desktop profile does not exist'); + await clearDesktopInstanceCookies(options.desktopSession, [ + ...(previous ? [previous.apiBaseUrl] : []), + ...(next ? [next.apiBaseUrl] : []), + ]); + await options.credentials.setActiveProfile(profileId); + await reconcileRendererActiveProfile(); + }); + handle(IPC_CHANNELS.authenticationPair, async (_event, profile) => { + const paired = await options.credentials.pair(profile); + await reconcileRendererActiveProfile(); + return paired; + }); + handle(IPC_CHANNELS.authenticationCancel, (_event, profileId) => options.credentials.cancelPairing(profileId)); + handle(IPC_CHANNELS.connectionProbe, (_event, profile) => options.credentials.probe(profile)); + handle(IPC_CHANNELS.connectionActivate, async (_event, activationTicket) => { + const before = await options.credentials.listProfiles(); + const activated = await options.credentials.activate(activationTicket); + try { + const after = await options.credentials.listProfiles(); + const previousOrigin = before.profiles + .find(profile => profile.id === before.activeProfileId)?.apiBaseUrl; + const activatedOrigin = after.profiles + .find(profile => profile.id === after.activeProfileId)?.apiBaseUrl; + const origins = [previousOrigin, activatedOrigin].filter(origin => origin !== undefined); + await clearDesktopInstanceCookies(options.desktopSession, origins); + if (!activatedOrigin) throw new Error('Desktop activation did not establish a renderer origin'); + await reconcileRendererActiveProfile(); + return activated; + } catch (error) { + const discarded = await options.credentials.discardActivation({ + profileId: activated.profileId, + transportScope: activated.transportScope, + }); + if (discarded.discarded) await reconcileRendererActiveProfile(); + throw error; + } + }); + handle(IPC_CHANNELS.connectionDiscard, async (_event, value) => { + const discarded = await options.credentials.discardActivation(value); + if (discarded.discarded) await reconcileRendererActiveProfile(); + return discarded; + }); + handle(IPC_CHANNELS.connectionInvalidate, (_event, value) => options.credentials.invalidate(value)); + handle(IPC_CHANNELS.connectDiscover, (_event, ...args) => { + if (args.length) throw new Error('Invalid Connect discovery request'); + return options.connectDiscovery.discover(); + }); + handle(IPC_CHANNELS.connectRediscover, (_event, profileId, ...args) => { + if (args.length) throw new Error('Invalid Connect rediscovery request'); + return options.connectDiscovery.rediscover(profileId); + }); + if (options.reportAcceptanceJourneyStage) { + handle(IPC_CHANNELS.acceptanceJourneyStage, (_event, stage, ...args) => { + if (args.length || !acceptanceStages.has(stage)) throw new Error('Invalid acceptance journey stage'); + options.reportAcceptanceJourneyStage!(stage); + }); + } handle(IPC_CHANNELS.lifecycleStatus, () => options.lifecycle.status()); handle(IPC_CHANNELS.lifecycleStart, () => options.lifecycle.start()); handle(IPC_CHANNELS.lifecycleStop, () => options.lifecycle.stop()); handle(IPC_CHANNELS.lifecycleRestart, () => options.lifecycle.restart()); + return { + close() { + if (closing) return; + closing = true; + for (const channel of channels) { + options.ipcMain.removeHandler(channel); + options.ipcMain.handle(channel, () => Promise.reject(closingError())); + } + }, + async awaitIdle() { + while (active.size > 0) await Promise.allSettled([...active]); + }, + dispose() { + closing = true; + for (const channel of channels) options.ipcMain.removeHandler(channel); + }, + }; }; diff --git a/apps/desktop/src/logger.test.ts b/apps/desktop/src/logger.test.ts new file mode 100644 index 000000000..12d2a1908 --- /dev/null +++ b/apps/desktop/src/logger.test.ts @@ -0,0 +1,143 @@ +import assert from 'node:assert/strict'; +import { describe, it } from 'node:test'; +import { assertPackagedLayout, parseEventLayout } from '../scripts/packaged-layout.mjs'; +import { formatDesktopLogRecord, sanitizeDesktopLogFields } from './logger'; + +const bounds = (left: number, top: number, width: number, height: number) => ({ + bottom: top + height, + height, + left, + right: left + width, + top, + width, +}); + +const completePackagedLayout = () => ({ + screen: { height: 1080, width: 1920 }, + viewport: { height: 780, width: 1280 }, + entry: bounds(0, 0, 1280, 780), + card: bounds(350, 40, 580, 640), + logo: bounds(624, 72, 32, 32), + heading: bounds(430, 132, 420, 58), + connectButton: bounds(380, 230, 520, 76), + connectDescription: bounds(490, 270, 300, 18), + windowBounds: { x: 0, y: 0, width: 1280, height: 820 }, + contentBounds: { x: 0, y: 0, width: 1280, height: 780 }, + minimumSize: { width: 880, height: 620 }, + workArea: { x: 0, y: 0, width: 1920, height: 1040 }, +}); + +describe('desktop logger field schemas', () => { + it('logs the complete successful packaged layout for the smoke parser and assertion', () => { + const inspectedLayout = completePackagedLayout(); + const record = formatDesktopLogRecord( + 'info', + 'desktop.renderer.layout.ready', + { layout: inspectedLayout }, + '2026-09-02T00:00:00.000Z', + ); + assert.equal(record, JSON.stringify({ + timestamp: '2026-09-02T00:00:00.000Z', + level: 'info', + event: 'desktop.renderer.layout.ready', + layout: inspectedLayout, + })); + + const parsedLayout = parseEventLayout(`Chromium prefix\n${record}\n`, 'desktop.renderer.layout.ready'); + assert.deepEqual(parsedLayout, inspectedLayout); + assert.doesNotThrow(() => assertPackagedLayout(parsedLayout, 'linux')); + assert.deepEqual( + sanitizeDesktopLogFields('desktop.renderer.layout.ready', { + layout: { ...inspectedLayout, missing: [] }, + }), + { layout: inspectedLayout }, + ); + }); + + it('preserves the exact reduced native window geometry schema', () => { + const layout = { + displayWorkArea: { x: -1600, y: 0, width: 1600, height: 900 }, + workArea: { x: -1200, y: 170, width: 800, height: 560 }, + windowBounds: { x: -1200, y: 170, width: 800, height: 560, visible: true }, + minimumSize: { width: 800, height: 560 }, + }; + assert.deepEqual(sanitizeDesktopLogFields('desktop.native.reduced_window.ready', { layout }), { layout }); + }); + + it('requires own layout and geometry keys despite inherited keys and a shadowed hasOwnProperty', () => { + const valid = completePackagedLayout(); + const { workArea, ...layoutWithoutOwnWorkArea } = valid; + const inheritedLayoutKey = Object.assign(Object.create({ workArea }), layoutWithoutOwnWorkArea); + const inheritedGeometryKey = Object.assign( + Object.create({ width: valid.windowBounds.width }) as Record, + { x: 0, y: 0, height: valid.windowBounds.height, visible: true }, + ); + Object.defineProperty(inheritedGeometryKey, 'hasOwnProperty', { + value: () => true, + }); + + for (const layout of [ + inheritedLayoutKey, + { ...valid, windowBounds: inheritedGeometryKey }, + ]) { + assert.deepEqual(sanitizeDesktopLogFields('desktop.renderer.layout.ready', { layout }), { + layout: { code: 'DETAIL_REDACTED' }, + }); + } + }); + + it('redacts malformed, secret, path-bearing, array, error, and over-broad layouts', () => { + const valid = completePackagedLayout(); + const rejectedLayouts: unknown[] = [ + { ...valid, unknown: { width: 1, height: 1 } }, + { ...valid, windowBounds: { ...valid.windowBounds, width: '1280' } }, + { ...valid, windowBounds: [0, 0, 1280, 820] }, + { ...valid, windowBounds: { ...valid.windowBounds, width: Number.POSITIVE_INFINITY } }, + { ...valid, windowBounds: { ...valid.windowBounds, token: 'secret-SENTINEL' } }, + { ...valid, windowBounds: { ...valid.windowBounds, path: '/private/path-SENTINEL' } }, + { ...valid, windowBounds: new Error('/private/path-SENTINEL') }, + { ...valid, windowBounds: { width: 1280, height: 820 } }, + { ...valid, missing: ['connectDescription'] }, + Object.fromEntries(Array.from({ length: 64 }, (_, index) => [ + `geometry${index}`, + { width: index + 1, height: index + 1 }, + ])), + ]; + + for (const layout of rejectedLayouts) { + const sanitized = sanitizeDesktopLogFields('desktop.renderer.layout.ready', { layout }); + assert.deepEqual(sanitized, { layout: { code: 'DETAIL_REDACTED' } }); + const serialized = JSON.stringify(sanitized); + assert.doesNotMatch(serialized, /secret-SENTINEL|private\/path-SENTINEL|connectDescription/u); + } + }); + + it('redacts a non-empty missing-selector result and leaves layout assertion failed closed', () => { + const record = formatDesktopLogRecord( + 'info', + 'desktop.renderer.layout.ready', + { layout: { missing: ['connectButton', 'connectDescription'] } }, + '2026-09-02T00:00:00.000Z', + ); + assert.doesNotMatch(record, /connectButton|connectDescription/u); + assert.match(record, /DETAIL_REDACTED/u); + + const parsedLayout = parseEventLayout(record, 'desktop.renderer.layout.ready'); + assert.deepEqual(parsedLayout, { code: 'DETAIL_REDACTED' }); + assert.throws( + () => assertPackagedLayout(parsedLayout, 'linux'), + /does not have positive bounds/, + ); + }); + + it('does not weaken general object or error redaction', () => { + const secret = { token: 'secret-SENTINEL', path: '/private/path-SENTINEL' }; + assert.deepEqual(sanitizeDesktopLogFields('desktop.other', { + detail: secret, + error: new Error('/private/path-SENTINEL'), + }), { + detail: { code: 'DETAIL_REDACTED' }, + error: { code: 'OPERATION_FAILED' }, + }); + }); +}); diff --git a/apps/desktop/src/logger.ts b/apps/desktop/src/logger.ts index ff6396db1..f63c89f90 100644 --- a/apps/desktop/src/logger.ts +++ b/apps/desktop/src/logger.ts @@ -7,9 +7,112 @@ export interface DesktopLogger { log(level: LogLevel, event: string, fields?: Record): void; } -const serializeError = (value: unknown): unknown => value instanceof Error - ? { name: value.name, message: value.message, stack: value.stack } - : value; +const safeField = (value: unknown): unknown => { + if (value instanceof Error) return { code: 'OPERATION_FAILED' }; + if (typeof value === 'string') return value.length <= 128 ? value : value.slice(0, 128); + if (typeof value === 'number' || typeof value === 'boolean' || value === null) return value; + return { code: 'DETAIL_REDACTED' }; +}; + +const LAYOUT_EVENT = 'desktop.renderer.layout.ready'; +const REDUCED_NATIVE_WINDOW_EVENT = 'desktop.native.reduced_window.ready'; +const RENDERER_LAYOUT_KEYS = new Set([ + 'windowBounds', 'contentBounds', 'minimumSize', 'workArea', 'screen', 'viewport', + 'entry', 'card', 'logo', 'heading', 'connectButton', 'connectDescription', +]); +const REDUCED_NATIVE_WINDOW_LAYOUT_KEYS = new Set([ + 'windowBounds', 'minimumSize', 'workArea', 'displayWorkArea', +]); +const RECTANGLE_NUMBER_KEYS = new Set(['x', 'y', 'width', 'height']); +const DIMENSION_NUMBER_KEYS = new Set(['width', 'height']); +const ELEMENT_NUMBER_KEYS = new Set(['top', 'right', 'bottom', 'left', 'width', 'height']); +const LAYOUT_NUMBER_KEYS = new Map>([ + ['windowBounds', RECTANGLE_NUMBER_KEYS], + ['contentBounds', RECTANGLE_NUMBER_KEYS], + ['minimumSize', DIMENSION_NUMBER_KEYS], + ['workArea', RECTANGLE_NUMBER_KEYS], + ['displayWorkArea', RECTANGLE_NUMBER_KEYS], + ['screen', DIMENSION_NUMBER_KEYS], + ['viewport', DIMENSION_NUMBER_KEYS], + ['entry', ELEMENT_NUMBER_KEYS], + ['card', ELEMENT_NUMBER_KEYS], + ['logo', ELEMENT_NUMBER_KEYS], + ['heading', ELEMENT_NUMBER_KEYS], + ['connectButton', ELEMENT_NUMBER_KEYS], + ['connectDescription', ELEMENT_NUMBER_KEYS], +]); +const WINDOW_BOOLEAN_KEYS = new Set(['visible', 'maximized', 'fullScreen']); + +const boundedLayout = ( + event: string, + value: unknown, +): Record> | null => { + if (!value || typeof value !== 'object' || Array.isArray(value)) return null; + const entries = Object.entries(value); + const expectedLayoutKeys = event === LAYOUT_EVENT + ? RENDERER_LAYOUT_KEYS + : REDUCED_NATIVE_WINDOW_LAYOUT_KEYS; + const normalizedEntries: Array<[string, unknown]> = []; + for (const entry of entries) { + if (entry[0] !== 'missing') { + normalizedEntries.push(entry); + continue; + } + if (event !== LAYOUT_EVENT || !Array.isArray(entry[1]) || entry[1].length !== 0) return null; + } + if (normalizedEntries.length !== expectedLayoutKeys.size) return null; + const result: Record> = {}; + for (const [name, rawGeometry] of normalizedEntries) { + if (!expectedLayoutKeys.has(name) + || !rawGeometry + || typeof rawGeometry !== 'object' + || Array.isArray(rawGeometry)) { + return null; + } + const geometry = Object.entries(rawGeometry); + const expectedNumberKeys = LAYOUT_NUMBER_KEYS.get(name); + if (!expectedNumberKeys) return null; + const allowedBooleanKeys = name === 'windowBounds' ? WINDOW_BOOLEAN_KEYS : undefined; + if (geometry.length < expectedNumberKeys.size + || geometry.length > expectedNumberKeys.size + (allowedBooleanKeys?.size ?? 0)) return null; + const safeGeometry: Record = {}; + for (const [key, measurement] of geometry) { + const validNumber = expectedNumberKeys.has(key) + && typeof measurement === 'number' + && Number.isFinite(measurement); + const validBoolean = allowedBooleanKeys?.has(key) === true && typeof measurement === 'boolean'; + if (!validNumber && !validBoolean) return null; + safeGeometry[key] = measurement; + } + if ([...expectedNumberKeys].some( + key => !Object.prototype.hasOwnProperty.call(safeGeometry, key), + )) return null; + result[name] = safeGeometry; + } + return result; +}; + +export const sanitizeDesktopLogFields = ( + event: string, + fields: Record, +): Record => Object.fromEntries(Object.entries(fields).map(([key, value]) => { + if ((event === LAYOUT_EVENT || event === REDUCED_NATIVE_WINDOW_EVENT) && key === 'layout') { + return [key, boundedLayout(event, value) ?? { code: 'DETAIL_REDACTED' }]; + } + return [key, safeField(value)]; +})); + +export const formatDesktopLogRecord = ( + level: LogLevel, + event: string, + fields: Record = {}, + timestamp = new Date().toISOString(), +): string => JSON.stringify({ + timestamp, + level, + event, + ...sanitizeDesktopLogFields(event, fields), +}); export const createDesktopLogger = ( logPath: string, @@ -17,12 +120,7 @@ export const createDesktopLogger = ( ): DesktopLogger => { let pending = Promise.resolve(); const log = (level: LogLevel, event: string, fields: Record = {}) => { - const record = JSON.stringify({ - timestamp: new Date().toISOString(), - level, - event, - ...Object.fromEntries(Object.entries(fields).map(([key, value]) => [key, serializeError(value)])), - }); + const record = formatDesktopLogRecord(level, event, fields); const consoleMethod = level === 'error' ? console.error : level === 'warn' ? console.warn : console.log; consoleMethod(record); pending = pending @@ -30,13 +128,13 @@ export const createDesktopLogger = ( await mkdir(dirname(logPath), { recursive: true, mode: 0o700 }); await appendFile(logPath, `${record}\n`, { encoding: 'utf8', mode: 0o600 }); }) - .catch(error => { + .catch(() => { try { onWriteFailure?.(); } catch { // Keep the fixed logger diagnostic available even if the smoke-only sink also fails. } - console.error(JSON.stringify({ level: 'error', event: 'desktop.log.write_failed', error: serializeError(error) })); + console.error(JSON.stringify({ level: 'error', event: 'desktop.log.write_failed', code: 'LOG_WRITE_FAILED' })); }); }; return { log }; diff --git a/apps/desktop/src/main.ts b/apps/desktop/src/main.ts index 910c57b46..480f93474 100644 --- a/apps/desktop/src/main.ts +++ b/apps/desktop/src/main.ts @@ -1,15 +1,41 @@ -import { lstatSync } from 'node:fs'; -import { isAbsolute, join, relative, resolve } from 'node:path'; +import { randomBytes } from 'node:crypto'; +import { lstatSync, realpathSync } from 'node:fs'; +import { basename, isAbsolute, join, relative, resolve } from 'node:path'; import { pathToFileURL } from 'node:url'; -import { app, BrowserWindow, ipcMain, net, protocol, safeStorage, screen, session, shell } from 'electron'; +import { app, BrowserWindow, crashReporter, ipcMain, net, protocol, safeStorage, screen, session, shell } from 'electron'; import type { Rectangle } from 'electron'; -import { DESKTOP_RENDERER_ORIGIN } from '@propr/shared'; +import { + DESKTOP_RENDERER_ORIGIN, + DESKTOP_TRANSPORT_SCOPE_HEADER, + PROPR_API_COMPATIBILITY, + PROPR_UI_COMPATIBILITY, +} from '@propr/shared'; +import { + DESKTOP_CONNECT_DISCOVERY_PLATFORMS, + discoverConfiguredConnect, +} from '@propr/cli/desktop-discovery'; +import { DesktopConnectDiscoveryService } from './connect-discovery'; import { DeepLinkDelivery } from './deep-link-delivery'; -import { registerIpcHandlers } from './ipc'; +import { clearDesktopInstanceCookies } from './desktop-session'; +import { DesktopCredentialService, type DesktopPairingBrowserRequest } from './credential-service'; +import { + registerIpcHandlers, + type DesktopAcceptanceOperation, + type DesktopAcceptanceOperationStatus, +} from './ipc'; import { LocalLifecycleController } from './lifecycle'; import { createDesktopLogger, type DesktopLogger } from './logger'; import { ProfileStore, type EncryptionProvider } from './profile-store'; +import { openApprovedDesktopPairingUrl } from './pairing-browser'; import { + clearPackagedApprovalStorage, + createPackagedApprovalNavigation, + createPackagedApprovalTaskTracker, + packagedApprovalPartition, +} from './packaged-approval-session'; +import { createDesktopShutdownCoordinator } from './shutdown'; +import { + createLatestRendererReloader, deepLinkFromArguments, isSafeExternalUrl, isTrustedRendererUrl, @@ -18,10 +44,19 @@ import { rendererContentSecurityPolicy, validatedDevServerUrl, } from './security'; -import { DESKTOP_PROTOCOL, IPC_CHANNELS } from './shared/contract'; +import { + DESKTOP_PROTOCOL, + IPC_CHANNELS, + type DesktopAcceptanceJourneyStage, +} from './shared/contract'; import { checkForSignedUpdates } from './signed-updates'; import { authorizePackagedSmokeTest } from './smoke-test-authorization'; import { createPackagedSmokeEvidenceSink } from './smoke-test-evidence'; +import { + configureDesktopSessionSecurity, + type DesktopNetworkPermissionEvidence, + type DesktopRendererOwnershipEvidence, +} from './session-security'; import { createBrowserWindowOptions, MINIMUM_BROWSER_WINDOW_SIZE, @@ -35,6 +70,49 @@ const PACKAGED_RENDERER_SCHEME = 'propr-app'; const PACKAGED_RENDERER_HOST = 'renderer'; const PACKAGED_LAYOUT_READY_EVENT = 'desktop.renderer.layout.ready'; const PACKAGED_REDUCED_NATIVE_WINDOW_READY_EVENT = 'desktop.native.reduced_window.ready'; +const PACKAGED_CONNECT_DISCOVERY_MILESTONE_EVENT = 'desktop.renderer.connect_discovery.milestone'; +const PACKAGED_CONNECT_JOURNEY_STAGE_EVENT = 'desktop.renderer.connect_journey.stage'; +const PACKAGED_CONNECT_JOURNEY_FAILURE_EVENT = 'desktop.renderer.connect_journey.failure'; +const PACKAGED_CONNECT_JOURNEY_OPERATION_EVENT = 'desktop.renderer.connect_journey.operation'; +const PACKAGED_CONNECT_RENDERER_OWNERSHIP_EVENT = 'desktop.renderer.connect_request_ownership'; +type PackagedConnectJourneyStage = + | 'JOURNEY_DISCOVERY_RENDERER' + | 'JOURNEY_DISCOVERY_VALIDATED' + | 'JOURNEY_STORAGE_BACKEND' + | 'JOURNEY_NEGATIVE_MALFORMED' + | 'JOURNEY_NEGATIVE_OVERSIZED' + | 'JOURNEY_NEGATIVE_EXPIRY' + | 'JOURNEY_NEGATIVE_CANCEL' + | 'JOURNEY_NEGATIVE_STATE' + | 'JOURNEY_PAIR_MANUAL_FORM' + | 'JOURNEY_PAIR_BROWSER_APPROVAL' + | 'JOURNEY_PAIR_ACTIVATION_DASHBOARD' + | 'JOURNEY_PAIR_AUTHENTICATION_REQUIRED' + | 'JOURNEY_PAIR_CREDENTIAL_COMMITTED' + | 'JOURNEY_PAIR_AUTHENTICATED_REPROBE_READY' + | 'JOURNEY_PAIR_ACTIVATION_COMMITTED' + | 'JOURNEY_PAIR_ACTIVATION_PUBLISHED' + | 'JOURNEY_PAIR_REACT_CONNECTED' + | 'JOURNEY_PAIR_TRANSPORT' + | 'JOURNEY_PAIR_COMPLETE' + | 'JOURNEY_REPROBE_ACTIVATION_DASHBOARD' + | 'JOURNEY_REPROBE_AUTHENTICATED_REPROBE_READY' + | 'JOURNEY_REPROBE_ACTIVATION_COMMITTED' + | 'JOURNEY_REPROBE_ACTIVATION_PUBLISHED' + | 'JOURNEY_REPROBE_REACT_CONNECTED' + | 'JOURNEY_REPROBE_TRANSPORT' + | 'JOURNEY_REPROBE_COMPLETE'; +type PackagedConnectJourneyFailureReason = + | 'APPROVAL_REJECTED' + | 'JOURNEY_FAILED' + | 'RENDERER_STAGE_TIMEOUT' + | 'RENDERER_STATE_TIMEOUT' + | 'TRANSPORT_EVIDENCE_TIMEOUT'; +interface PackagedConnectJourneyDiagnosticState { + phase: 'pair' | 'reprobe'; + stage: PackagedConnectJourneyStage | 'JOURNEY_NOT_STARTED'; +} +let packagedConnectJourneyDiagnosticState: PackagedConnectJourneyDiagnosticState | null = null; const packagedRendererRoot = join(__dirname, `../renderer/${MAIN_WINDOW_VITE_NAME}`); const packagedRendererUrl = `${DESKTOP_RENDERER_ORIGIN}/renderer.html`; let packagedSmokeUserDataDirectory: string | null = null; @@ -72,17 +150,185 @@ if (process.platform === 'win32') { app.setAppUserModelId('dev.propr.desktop'); } +interface PackagedTransportSmoke { + firstOrigin: string; + secondOrigin: string; + shutdownMode: 'success' | 'retry' | 'forced-timeout'; +} +let activePackagedTransportSmoke: PackagedTransportSmoke | null = null; +let activePackagedConnectJourney = false; + +interface PackagedConnectSmoke { + configRoot: string; + fetch: typeof globalThis.fetch; + journeyEndpoint?: string; + journeyPhase?: 'pair' | 'reprobe'; +} + +const packagedConnectSmoke = (): PackagedConnectSmoke | null => { + if (!app.isPackaged || process.env.PROPR_DESKTOP_CONNECT_SMOKE_TEST !== '1') return null; + const suppliedRoot = process.env.PROPR_DESKTOP_CONNECT_SMOKE_CONFIG_ROOT; + if (!suppliedRoot || !isAbsolute(suppliedRoot)) throw new Error('Packaged Connect smoke requires an isolated config root'); + const configRoot = realpathSync.native(suppliedRoot); + const temporaryRoot = realpathSync.native(app.getPath('temp')); + const contained = relative(temporaryRoot, configRoot); + if (!contained || contained.startsWith('..') || isAbsolute(contained)) { + throw new Error('Packaged Connect smoke config root is outside the temporary directory'); + } + const suppliedJourneyEndpoint = process.env.PROPR_DESKTOP_CONNECT_JOURNEY_ENDPOINT; + const suppliedJourneyPhase = process.env.PROPR_DESKTOP_CONNECT_JOURNEY_PHASE; + let journeyEndpoint: string | undefined; + let journeyPhase: 'pair' | 'reprobe' | undefined; + if (suppliedJourneyEndpoint !== undefined || suppliedJourneyPhase !== undefined) { + const normalized = normalizeApiBaseUrl(suppliedJourneyEndpoint ?? ''); + if (!normalized) throw new Error('Packaged Connect journey requires a bounded non-Windows loopback fixture'); + const parsed = new URL(normalized); + if (process.platform === 'win32' || parsed.protocol !== 'http:' || parsed.hostname !== '127.0.0.1' + || (suppliedJourneyPhase !== 'pair' && suppliedJourneyPhase !== 'reprobe')) { + throw new Error('Packaged Connect journey requires a bounded non-Windows loopback fixture'); + } + journeyEndpoint = normalized; + journeyPhase = suppliedJourneyPhase; + } + const endpoint = 'https://t-packaged123.propr.dev'; + const publicInstanceIdentity = 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa'; + const fetch: typeof globalThis.fetch = async input => { + if (input.toString() !== `${endpoint}/api/desktop/discovery`) { + throw new Error('Packaged Connect smoke rejected an unexpected network request'); + } + return new Response(JSON.stringify({ + schemaVersion: 1, + product: 'ProPR', + version: app.getVersion(), + apiCompatibility: PROPR_API_COMPATIBILITY, + uiCompatibility: PROPR_UI_COMPATIBILITY, + canonicalEndpoint: endpoint, + publicInstanceIdentity, + desktopAuthentication: { + protocolVersion: 2, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, + }), { status: 200, headers: { 'Content-Type': 'application/json' } }); + }; + return { configRoot, fetch, journeyEndpoint, journeyPhase }; +}; + +const packagedTransportSmoke = (): PackagedTransportSmoke | null => { + if (!app.isPackaged || process.env.PROPR_DESKTOP_SMOKE_TEST !== '1') return null; + const transportRequested = [ + process.env.PROPR_DESKTOP_SMOKE_FIRST_ORIGIN, + process.env.PROPR_DESKTOP_SMOKE_SECOND_ORIGIN, + process.env.PROPR_DESKTOP_SMOKE_SHUTDOWN_MODE, + ].some(value => value !== undefined); + if (!transportRequested) return null; + const firstOrigin = normalizeApiBaseUrl(process.env.PROPR_DESKTOP_SMOKE_FIRST_ORIGIN ?? ''); + const secondOrigin = normalizeApiBaseUrl(process.env.PROPR_DESKTOP_SMOKE_SECOND_ORIGIN ?? ''); + const shutdownMode = process.env.PROPR_DESKTOP_SMOKE_SHUTDOWN_MODE; + const isolatedUserData = basename(app.getPath('userData')).startsWith('propr-desktop-smoke-'); + const loopback = (origin: string | null): origin is string => origin !== null + && new URL(origin).hostname === '127.0.0.1'; + if (!isolatedUserData || !loopback(firstOrigin) || !loopback(secondOrigin) || firstOrigin === secondOrigin + || (shutdownMode !== 'success' && shutdownMode !== 'retry' && shutdownMode !== 'forced-timeout')) { + throw new Error('Packaged desktop transport smoke requires two distinct loopback fixtures and isolated user data'); + } + return { firstOrigin, secondOrigin, shutdownMode }; +}; + const log = (level: 'debug' | 'info' | 'warn' | 'error', event: string, fields?: Record) => { packagedSmokeEvidence?.write(event); if (logger) { logger.log(level, event, fields); } else { - console.error(JSON.stringify({ timestamp: new Date().toISOString(), level, event, ...fields })); + console.error(JSON.stringify({ + timestamp: new Date().toISOString(), + level, + event, + code: fields ? 'DETAIL_REDACTED' : undefined, + })); } }; -process.on('uncaughtExceptionMonitor', error => { - log('error', 'desktop.main_process.uncaught_exception', { error }); +const reportPackagedConnectJourneyStage = ( + code: PackagedConnectJourneyStage, + evidence: { storageBackend: 'gnome_libsecret' | 'os-protected' } | undefined = undefined, +): void => { + if (packagedConnectJourneyDiagnosticState) packagedConnectJourneyDiagnosticState.stage = code; + log('info', PACKAGED_CONNECT_JOURNEY_STAGE_EVENT, { code, ...evidence }); +}; + +const packagedConnectJourneyFailureReason = (error: unknown): PackagedConnectJourneyFailureReason => { + if (!(error instanceof Error)) return 'JOURNEY_FAILED'; + if (error.message === 'Packaged pairing browser approval was rejected') return 'APPROVAL_REJECTED'; + if (error.message === 'Packaged Connect journey renderer stage timed out') { + return 'RENDERER_STAGE_TIMEOUT'; + } + if (error.message === 'Packaged Connect journey renderer state timed out') { + return 'RENDERER_STATE_TIMEOUT'; + } + if (error.message === 'Packaged Connect authenticated transport proof timed out') { + return 'TRANSPORT_EVIDENCE_TIMEOUT'; + } + return 'JOURNEY_FAILED'; +}; + +interface PackagedJourneyStageTracker { + record(stage: DesktopAcceptanceJourneyStage): void; + waitFor(stage: DesktopAcceptanceJourneyStage): Promise; +} + +const createPackagedJourneyStageTracker = ( + phase: 'pair' | 'reprobe', +): PackagedJourneyStageTracker => { + const seen = new Set(); + const waiters = new Map void>>(); + const stageCodes: Partial> = phase === 'pair' + ? { + AUTHENTICATION_REQUIRED: 'JOURNEY_PAIR_AUTHENTICATION_REQUIRED', + CREDENTIAL_COMMITTED: 'JOURNEY_PAIR_CREDENTIAL_COMMITTED', + AUTHENTICATED_REPROBE_READY: 'JOURNEY_PAIR_AUTHENTICATED_REPROBE_READY', + ACTIVATION_COMMITTED: 'JOURNEY_PAIR_ACTIVATION_COMMITTED', + ACTIVATION_PUBLISHED: 'JOURNEY_PAIR_ACTIVATION_PUBLISHED', + REACT_CONNECTED: 'JOURNEY_PAIR_REACT_CONNECTED', + } + : { + AUTHENTICATED_REPROBE_READY: 'JOURNEY_REPROBE_AUTHENTICATED_REPROBE_READY', + ACTIVATION_COMMITTED: 'JOURNEY_REPROBE_ACTIVATION_COMMITTED', + ACTIVATION_PUBLISHED: 'JOURNEY_REPROBE_ACTIVATION_PUBLISHED', + REACT_CONNECTED: 'JOURNEY_REPROBE_REACT_CONNECTED', + }; + return { + record(stage) { + const code = stageCodes[stage]; + if (!code) throw new Error('Packaged Connect journey reported an invalid phase stage'); + if (seen.has(stage)) return; + seen.add(stage); + reportPackagedConnectJourneyStage(code); + for (const resolveWaiter of waiters.get(stage) ?? []) resolveWaiter(); + waiters.delete(stage); + }, + waitFor(stage) { + if (seen.has(stage)) return Promise.resolve(); + return new Promise((resolveStage, rejectStage) => { + const timer = setTimeout(() => { + waiters.get(stage)?.delete(resolve); + rejectStage(new Error('Packaged Connect journey renderer stage timed out')); + }, 15_000); + const resolve = () => { + clearTimeout(timer); + resolveStage(); + }; + const current = waiters.get(stage) ?? new Set(); + current.add(resolve); + waiters.set(stage, current); + }); + }, + }; +}; + +process.on('uncaughtExceptionMonitor', () => { + log('error', 'desktop.main_process.uncaught_exception', { code: 'UNCAUGHT_EXCEPTION' }); }); protocol.registerSchemesAsPrivileged([{ @@ -107,22 +353,10 @@ const deliverDeepLink = (value: string): void => { deepLinkDelivery.deliver(value); }; -const configureSessionSecurity = (): void => { - const desktopSession = session.defaultSession; - desktopSession.setPermissionCheckHandler(() => false); - desktopSession.setPermissionRequestHandler((_webContents, _permission, callback) => callback(false)); - desktopSession.webRequest.onHeadersReceived((details, callback) => { - callback({ - responseHeaders: { - ...details.responseHeaders, - 'Content-Security-Policy': [rendererContentSecurityPolicy(!app.isPackaged)], - }, - }); - }); -}; - -const configurePackagedRendererProtocol = (): void => { - protocol.handle(PACKAGED_RENDERER_SCHEME, request => { +const configurePackagedRendererProtocol = ( + contentSecurityPolicy: () => string, +): (() => void) => { + protocol.handle(PACKAGED_RENDERER_SCHEME, async request => { const requestUrl = new URL(request.url); if (requestUrl.hostname !== PACKAGED_RENDERER_HOST) { return new Response(null, { status: 404 }); @@ -139,11 +373,28 @@ const configurePackagedRendererProtocol = (): void => { if (relativePath.startsWith('..') || isAbsolute(relativePath)) { return new Response(null, { status: 403 }); } - return net.fetch(pathToFileURL(filePath).href); + const response = await net.fetch(pathToFileURL(filePath).href); + if (requestedPath !== 'renderer.html' || !response.ok) return response; + + const packagedPolicy = rendererContentSecurityPolicy(); + const html = await response.text(); + if (!html.includes(packagedPolicy)) { + return new Response(null, { status: 500 }); + } + const headers = new Headers(response.headers); + headers.delete('content-length'); + headers.set('content-type', 'text/html; charset=UTF-8'); + return new Response(html.replace(packagedPolicy, contentSecurityPolicy()), { + status: response.status, + statusText: response.statusText, + headers, + }); }); + return () => { void protocol.unhandle(PACKAGED_RENDERER_SCHEME); }; }; const openAllowedExternalUrl = async (url: string): Promise => { + if (shutdownStarted) return; if (!isSafeExternalUrl(url)) { log('warn', 'desktop.external_url.rejected'); return; @@ -156,20 +407,17 @@ const inspectPackagedLayout = async (window: BrowserWindow): Promise label')) : []; + const card = document.querySelector('.desktop-welcome-card'); + const connectButton = card?.querySelector('.desktop-choice-button'); elements = { - titlebar: document.querySelector('.desktop-titlebar'), - logo: document.querySelector('.desktop-titlebar img[alt="ProPR"]'), + entry: document.querySelector('.desktop-entry'), card, - connectionName: labels[0]?.querySelector('input'), - apiUrl: labels[1]?.querySelector('input'), - apiHelp: labels[1]?.querySelector('span'), - submit: form?.querySelector(':scope > button[type="submit"]'), - footer: card?.lastElementChild, + logo: card?.querySelector('.desktop-brand img'), + heading: card?.querySelector('.desktop-welcome-copy h1'), + connectButton, + connectDescription: connectButton?.querySelector('small'), }; - if (Object.values(elements).every(Boolean) && elements.footer.textContent.includes('Runtime:')) break; + if (Object.values(elements).every(Boolean)) break; await new Promise(resolve => setTimeout(resolve, 25)); } while (performance.now() < deadline); @@ -194,15 +442,55 @@ const inspectPackagedLayout = async (window: BrowserWindow): Promise [name, bounds(element)])), }; })()`); + const windowBounds = window.getBounds(); const [minimumWidth, minimumHeight] = window.getMinimumSize(); return { - windowBounds: window.getBounds(), + ...rendererLayout, + windowBounds, contentBounds: window.getContentBounds(), minimumSize: { width: minimumWidth, height: minimumHeight }, - ...rendererLayout, + workArea: screen.getDisplayMatching(windowBounds).workArea, }; }; +const closePackagedProfileEditorAndWaitForWelcomeChooser = async (window: BrowserWindow): Promise => { + const chooserReady = await window.webContents.executeJavaScript(`(async () => { + const editor = document.querySelector('.desktop-welcome-card form.desktop-profile-form'); + const backButton = editor?.querySelector('button.desktop-back-button'); + if (!(backButton instanceof HTMLButtonElement)) return false; + backButton.click(); + + const deadline = performance.now() + 5000; + do { + const card = document.querySelector('.desktop-welcome-card'); + const connectButton = card?.querySelector('.desktop-choice-button'); + const elements = { + entry: document.querySelector('.desktop-entry'), + card, + logo: card?.querySelector('.desktop-brand img'), + heading: card?.querySelector('.desktop-welcome-copy h1'), + connectButton, + connectDescription: connectButton?.querySelector('small'), + }; + const visiblyReady = Object.values(elements).every(element => { + if (!(element instanceof HTMLElement)) return false; + const bounds = element.getBoundingClientRect(); + const style = getComputedStyle(element); + return bounds.width > 0 && bounds.height > 0 + && bounds.right > 0 && bounds.bottom > 0 + && bounds.left < window.innerWidth && bounds.top < window.innerHeight + && style.display !== 'none' && style.visibility === 'visible' && style.opacity !== '0'; + }); + if (visiblyReady) return true; + await new Promise(resolve => setTimeout(resolve, 25)); + } while (performance.now() < deadline); + return false; + })()`); + if (chooserReady !== true) { + throw new Error('Packaged desktop welcome chooser was not restored after the profile flow'); + } +}; + const createReducedSmokeWorkArea = (displayWorkArea: Rectangle): Rectangle => { const width = Math.min(displayWorkArea.width, MINIMUM_BROWSER_WINDOW_SIZE.width - 80); const height = Math.min(displayWorkArea.height, MINIMUM_BROWSER_WINDOW_SIZE.height - 60); @@ -233,7 +521,475 @@ const inspectPackagedReducedNativeWindow = (): Record => { } }; -const createMainWindow = async (): Promise => { +const runPackagedConnectDiscoverySmoke = async (window: BrowserWindow): Promise<{ + selectedPlatform: string; + selectedArch: string; + authorityMechanism: string; + rendererSchemaValid: true; +}> => { + const proof = await window.webContents.executeJavaScript(`(async () => { + const bridge = window.proprDesktop; + const metadata = await bridge.app.getMetadata(); + const candidates = await bridge.discovery.discover(); + return { supported: bridge.discovery.supported, metadata, candidates }; + })()`); + const candidate = proof?.candidates?.[0]; + if (proof?.supported !== true + || proof.metadata?.packaged !== true + || proof.metadata?.platform !== process.platform + || proof.metadata?.arch !== process.arch + || !Array.isArray(proof.candidates) + || proof.candidates.length !== 1 + || !candidate + || Object.keys(candidate).sort().join(',') !== 'apiBaseUrl,id,label' + || candidate.id !== 'propr-connect-discovered' + || candidate.label !== 'ProPR Connect' + || candidate.apiBaseUrl !== 'https://t-packaged123.propr.dev') { + throw new Error('Packaged Connect renderer discovery proof was invalid'); + } + const readyFields = { + selectedPlatform: process.platform, + selectedArch: process.arch, + authorityMechanism: process.platform === 'darwin' + ? 'packaged-broker' + : process.platform === 'linux' + ? 'in-process-native-addon' + : 'inherited-standard-handle', + rendererSchemaValid: true, + } as const; + log('info', PACKAGED_CONNECT_DISCOVERY_MILESTONE_EVENT, { + code: 'JOURNEY_DISCOVERY_VALIDATED', + }); + return readyFields; +}; + +const publishPackagedConnectReady = async (readyFields: Awaited< + ReturnType +>): Promise => { + await new Promise((resolveReady, rejectReady) => { + process.stdout.write(`${JSON.stringify({ + timestamp: new Date().toISOString(), + level: 'info', + event: 'desktop.renderer.connect_discovery.ready', + ...readyFields, + })}\n`, error => { + if (error) rejectReady(new Error('Packaged Connect READY publication failed')); + else resolveReady(); + }); + }); +}; + +const openPackagedJourneyApproval = async (request: DesktopPairingBrowserRequest): Promise => { + reportPackagedConnectJourneyStage('JOURNEY_PAIR_BROWSER_APPROVAL'); + await openApprovedDesktopPairingUrl(request, { + openExternal: async url => { + const approvalSession = session.fromPartition( + packagedApprovalPartition(randomBytes(16).toString('hex')), + { cache: false }, + ); + let approvalWindow: BrowserWindow | null = null; + let navigation: ReturnType | null = null; + try { + approvalWindow = new BrowserWindow({ + show: false, + webPreferences: { + contextIsolation: true, + nodeIntegration: false, + sandbox: true, + session: approvalSession, + webSecurity: true, + }, + }); + navigation = createPackagedApprovalNavigation({ + approvalUrl: url, + approvalSession, + approvalWindow, + defaultSession: session.defaultSession, + }); + await navigation.navigate(); + } finally { + if (navigation) { + await navigation.cleanup(); + } else { + if (approvalWindow && !approvalWindow.isDestroyed()) approvalWindow.destroy(); + await clearPackagedApprovalStorage(approvalSession); + } + } + }, + }); +}; + +const runPackagedConnectJourneySmoke = async ( + window: BrowserWindow, + profiles: ProfileStore, + credentials: DesktopCredentialService, + waitForNextApproval: () => Promise, + waitForApprovalIdle: () => Promise, + endpoint: string, + phase: 'pair' | 'reprobe', + stages: PackagedJourneyStageTracker, +): Promise => { + const security = profiles.security(); + const requiredStorageBackend = process.platform === 'linux' ? 'gnome_libsecret' : 'os-protected'; + if (!security.available || security.backend !== requiredStorageBackend) { + throw new Error('Packaged Connect journey requires the production OS credential backend'); + } + reportPackagedConnectJourneyStage('JOURNEY_STORAGE_BACKEND', { + storageBackend: requiredStorageBackend, + }); + if (phase === 'pair') { + const setMode = async (mode: 'success' | 'malformed' | 'oversized' | 'expiry' | 'cancel') => { + const response = await session.defaultSession.fetch(`${endpoint}/__packaged/control/${mode}`, { + method: 'POST', redirect: 'manual', + }); + if (response.status !== 204) throw new Error('Packaged Connect fixture control failed'); + }; + for (const mode of ['malformed', 'oversized'] as const) { + reportPackagedConnectJourneyStage(mode === 'malformed' + ? 'JOURNEY_NEGATIVE_MALFORMED' + : 'JOURNEY_NEGATIVE_OVERSIZED'); + await setMode(mode); + const result = await credentials.probe({ + id: `negative-${mode}`, + label: `Packaged ${mode}`, + apiBaseUrl: endpoint, + }); + if (result.status === 'ready' || result.status === 'incompatible') { + throw new Error('Strict packaged discovery accepted invalid identity'); + } + } + reportPackagedConnectJourneyStage('JOURNEY_NEGATIVE_EXPIRY'); + await setMode('expiry'); + await credentials.pair({ + id: 'negative-expiry', label: 'Packaged expiry', apiBaseUrl: endpoint, + }).then( + () => { throw new Error('Packaged pairing expiry unexpectedly succeeded'); }, + error => { + if (!(error instanceof Error) || !/expired/i.test(error.message)) { + throw new Error('Packaged pairing expiry classification failed'); + } + }, + ); + await waitForApprovalIdle(); + reportPackagedConnectJourneyStage('JOURNEY_NEGATIVE_CANCEL'); + await setMode('cancel'); + const approvalReady = waitForNextApproval(); + const cancelledPairing = credentials.pair({ + id: 'negative-cancel', label: 'Packaged cancel', apiBaseUrl: endpoint, + }); + await approvalReady; + await new Promise(resolve => setTimeout(resolve, 50)); + credentials.cancelPairing('negative-cancel'); + await cancelledPairing.then( + () => { throw new Error('Packaged pairing cancellation unexpectedly succeeded'); }, + error => { + if (!(error instanceof Error) || !/cancelled/i.test(error.message)) { + throw new Error('Packaged pairing cancellation classification failed'); + } + }, + ); + await waitForApprovalIdle(); + reportPackagedConnectJourneyStage('JOURNEY_NEGATIVE_STATE'); + const failedProfiles = await profiles.list(); + if (failedProfiles.profiles.some(profile => profile.id.startsWith('negative-'))) { + throw new Error('Failed packaged pairing left stale profile or credential state'); + } + await setMode('success'); + } + reportPackagedConnectJourneyStage(phase === 'pair' + ? 'JOURNEY_PAIR_MANUAL_FORM' + : 'JOURNEY_REPROBE_ACTIVATION_DASHBOARD'); + if (phase === 'pair') { + const submitted = await window.webContents.executeJavaScript(`(async () => { + const waitFor = async predicate => { + const deadline = performance.now() + 15000; + do { + const value = predicate(); + if (value) return value; + await new Promise(resolve => setTimeout(resolve, 25)); + } while (performance.now() < deadline); + throw new Error('Packaged Connect journey renderer state timed out'); + }; + const setInput = (input, value) => { + const setter = Object.getOwnPropertyDescriptor(HTMLInputElement.prototype, 'value')?.set; + setter.call(input, value); + input.dispatchEvent(new Event('input', { bubbles: true })); + }; + const chooser = await waitFor(() => document.querySelector('.desktop-welcome-card')); + const connect = Array.from(chooser.querySelectorAll('button.desktop-choice-button')) + .find(button => button.textContent?.includes('Connect to an existing instance')); + if (!(connect instanceof HTMLButtonElement)) return false; + connect.click(); + const form = await waitFor(() => document.querySelector('form.desktop-profile-form')); + const inputs = form.querySelectorAll('input'); + if (inputs.length !== 2) return false; + setInput(inputs[0], 'Packaged remote'); + setInput(inputs[1], ${JSON.stringify(endpoint)}); + form.requestSubmit(); + await waitFor(() => Array.from(document.querySelectorAll('.desktop-connection-card button')) + .find(button => button.textContent?.includes('Sign in in browser'))); + return true; + })()`); + if (submitted !== true) throw new Error('Packaged Connect manual profile submission failed'); + await stages.waitFor('AUTHENTICATION_REQUIRED'); + const clicked = await window.webContents.executeJavaScript(`(() => { + const authenticate = Array.from(document.querySelectorAll('.desktop-connection-card button')) + .find(button => button.textContent?.includes('Sign in in browser')); + if (!(authenticate instanceof HTMLButtonElement)) return false; + authenticate.click(); + return true; + })()`); + if (clicked !== true) throw new Error('Packaged Connect authentication action was missing'); + await stages.waitFor('CREDENTIAL_COMMITTED'); + } + await stages.waitFor('AUTHENTICATED_REPROBE_READY'); + await stages.waitFor('ACTIVATION_COMMITTED'); + await stages.waitFor('ACTIVATION_PUBLISHED'); + await stages.waitFor('REACT_CONNECTED'); + const proof = await window.webContents.executeJavaScript(`(() => { + const dashboard = document.querySelector('.desktop-app'); + const connection = document.querySelector('.desktop-connection-pill.desktop-connection-ready'); + const titlebar = document.querySelector('.desktop-titlebar'); + return { + connected: dashboard instanceof HTMLElement + && connection instanceof HTMLButtonElement + && titlebar instanceof HTMLElement, + rendererContractsContainSecret: JSON.stringify([ + window.proprDesktop, + dashboard instanceof HTMLElement ? dashboard.dataset : null, + ]).includes('propr_it_'), + title: connection instanceof HTMLButtonElement ? connection.getAttribute('aria-label') : null, + }; + })()`); + if (proof?.connected !== true || proof?.rendererContractsContainSecret !== false + || !proof?.title?.startsWith('Connected: Packaged remote')) { + throw new Error('Packaged Connect dashboard did not reach its connected state'); + } + reportPackagedConnectJourneyStage(phase === 'pair' + ? 'JOURNEY_PAIR_TRANSPORT' + : 'JOURNEY_REPROBE_TRANSPORT'); + const requiredAuthenticatedRequests = phase === 'pair' ? 1 : 2; + const evidenceDeadline = Date.now() + 10_000; + let transportEvidence = { authenticatedRest: 0, authenticatedSockets: 0 }; + do { + const response = await session.defaultSession.fetch(`${endpoint}/__packaged/evidence`, { + credentials: 'omit', + redirect: 'manual', + }); + if (response.status !== 200) throw new Error('Packaged Connect transport evidence was unavailable'); + const candidate: unknown = await response.json(); + if (candidate !== null && typeof candidate === 'object') { + const record = candidate as Record; + if (Number.isInteger(record.authenticatedRest) && Number.isInteger(record.authenticatedSockets)) { + transportEvidence = { + authenticatedRest: record.authenticatedRest as number, + authenticatedSockets: record.authenticatedSockets as number, + }; + } + } + if (transportEvidence.authenticatedRest >= requiredAuthenticatedRequests + && transportEvidence.authenticatedSockets >= requiredAuthenticatedRequests) break; + await new Promise(resolve => setTimeout(resolve, 25)); + } while (Date.now() < evidenceDeadline); + if (transportEvidence.authenticatedRest < requiredAuthenticatedRequests + || transportEvidence.authenticatedSockets < requiredAuthenticatedRequests) { + throw new Error('Packaged Connect authenticated transport proof timed out'); + } + await waitForApprovalIdle(); + reportPackagedConnectJourneyStage(phase === 'pair' + ? 'JOURNEY_PAIR_COMPLETE' + : 'JOURNEY_REPROBE_COMPLETE'); +}; + +const runPackagedTransportSmoke = async ( + window: BrowserWindow, + profiles: ProfileStore, + credentials: DesktopCredentialService, + smoke: PackagedTransportSmoke, +): Promise => { + const profileId = 'packaged-transport-smoke'; + const tokenA = `propr_it_${randomBytes(32).toString('base64url')}`; + const tokenB = `propr_it_${randomBytes(32).toString('base64url')}`; + const security = profiles.security(); + if (!security.available || security.backend === 'basic_text') { + throw new Error('Packaged transport smoke requires the production OS credential backend'); + } + const profileA = await profiles.save({ + id: profileId, label: 'Packaged transport A', apiBaseUrl: smoke.firstOrigin, + }); + const storedA = await profiles.writeCredential({ + version: 2, profileId, origin: smoke.firstOrigin, + publicInstanceIdentity: 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa', token: tokenA, + }); + if (!storedA.stored) throw new Error('Production credential encryption was unavailable'); + + const storageWindows = await Promise.all([smoke.firstOrigin, smoke.secondOrigin].map(async origin => { + const storageWindow = new BrowserWindow({ + show: false, + webPreferences: { contextIsolation: true, nodeIntegration: false, sandbox: true, webSecurity: true }, + }); + await storageWindow.loadURL(`${origin}/smoke-storage`); + return { origin, window: storageWindow }; + })); + const seedStorage = async (): Promise => { + await Promise.all(storageWindows.map(item => item.window.webContents.executeJavaScript(`(async () => { + document.cookie = 'packaged-smoke-cookie=present; SameSite=Lax'; + localStorage.setItem('packaged-smoke-local', 'present'); + await new Promise((resolve, reject) => { + const request = indexedDB.open('packaged-smoke-indexeddb', 1); + request.onupgradeneeded = () => request.result.createObjectStore('proof'); + request.onsuccess = () => { request.result.close(); resolve(true); }; + request.onerror = () => reject(request.error); + }); + const cache = await caches.open('packaged-smoke-cache'); + await cache.put('/packaged-smoke-cache-entry', new Response('present')); + await navigator.serviceWorker.register('/smoke-sw.js'); + await navigator.serviceWorker.ready; + return true; + })()`))); + }; + const storageState = async (expected: 'present' | 'absent'): Promise => { + const states = await Promise.all(storageWindows.map(async item => { + const rendererState = await item.window.webContents.executeJavaScript(`(async () => ({ + cookie: document.cookie.includes('packaged-smoke-cookie=present'), + localStorage: localStorage.getItem('packaged-smoke-local') === 'present', + indexedDB: (await indexedDB.databases()).some(database => database.name === 'packaged-smoke-indexeddb'), + cacheStorage: (await caches.keys()).includes('packaged-smoke-cache'), + serviceWorker: (await navigator.serviceWorker.getRegistrations()).some(registration => registration.scope.startsWith(location.origin)), + }))()`); + const cookies = await session.defaultSession.cookies.get({ url: item.origin }); + return { ...rendererState, cookie: rendererState.cookie || cookies.length > 0 } as Record; + })); + return states.every(state => Object.values(state).every(value => value === (expected === 'present'))); + }; + + try { + await window.webContents.executeJavaScript(`new Promise((resolve, reject) => { + const started = Date.now(); + const poll = () => { + if (window.__proprPackagedTransportSmoke) return resolve(true); + if (Date.now() - started > 5000) return reject(new Error('Packaged renderer smoke harness timed out')); + setTimeout(poll, 20); + }; + poll(); + })`); + const profileForRendererA = { id: profileId, name: profileA.label, baseUrl: smoke.firstOrigin, kind: 'local' }; + const first = await window.webContents.executeJavaScript(`(async () => { + const smoke = window.__proprPackagedTransportSmoke; + const first = await smoke.activate(${JSON.stringify(profileForRendererA)}); + await smoke.rest(); + const socketId = await smoke.connectSocket(); + const rotated = await smoke.activate(${JSON.stringify(profileForRendererA)}); + let staleRestRejected = false; + try { + const response = await fetch(${JSON.stringify(smoke.firstOrigin + '/api/smoke/rest')}, { + headers: { ${JSON.stringify(DESKTOP_TRANSPORT_SCOPE_HEADER)}: first.transportScope }, + credentials: 'include', + }); + staleRestRejected = !response.ok; + } catch { staleRestRejected = true; } + await smoke.expectSocketRejected(socketId); + await smoke.rest(); + localStorage.setItem('packaged-smoke-local', 'non-secret sentinel'); + sessionStorage.setItem('packaged-smoke-session', 'non-secret sentinel'); + return { first, rotated, socketId, staleRestRejected, rendererOrigin: location.origin }; + })()`); + if (first?.rendererOrigin !== DESKTOP_RENDERER_ORIGIN || first?.first?.profileId !== profileId + || first?.first?.transportScope === first?.rotated?.transportScope + || first?.first?.contractsContainSecret !== false || first?.rotated?.contractsContainSecret !== false + || first?.staleRestRejected !== true) { + throw new Error('Packaged renderer protocol or A transport smoke proof failed'); + } + await seedStorage(); + if (!await storageState('present')) throw new Error('Packaged origin storage fixture was incomplete'); + + let cleanupFailed = false; + try { + await credentials.saveProfile({ + id: profileId, label: 'Packaged transport B', apiBaseUrl: smoke.secondOrigin, + }, async () => { throw new Error('packaged cleanup failure'); }); + } catch (error) { + cleanupFailed = error instanceof Error && error.message === 'packaged cleanup failure'; + } + const rollback = await profiles.readProfileCredential(profileId); + if (!cleanupFailed || rollback.profile?.apiBaseUrl !== smoke.firstOrigin + || rollback.credential?.origin !== smoke.firstOrigin || rollback.credential.token !== tokenA + || !await storageState('present')) { + throw new Error('Origin cleanup failure did not preserve complete durable A'); + } + let precommitStorageCleared = false; + await credentials.saveProfile({ + id: profileId, label: 'Packaged transport B', apiBaseUrl: smoke.secondOrigin, + }, async (previousOrigin, nextOrigin) => { + await clearDesktopInstanceCookies(session.defaultSession, [previousOrigin, nextOrigin]); + precommitStorageCleared = await storageState('absent'); + if (!precommitStorageCleared) throw new Error('Complete origin storage was not cleared before commit'); + }); + if (!precommitStorageCleared || !await storageState('absent')) { + throw new Error('Same-ID URL edit did not clear both complete Electron origin stores'); + } + const storedB = await profiles.writeCredential({ + version: 2, profileId, origin: smoke.secondOrigin, + publicInstanceIdentity: 'bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb', token: tokenB, + }); + if (!storedB.stored) throw new Error('Replacement credential encryption was unavailable'); + + const profileForRendererB = { id: profileId, name: 'Packaged transport B', baseUrl: smoke.secondOrigin, kind: 'local' }; + const second = await window.webContents.executeJavaScript(`(async () => { + const smoke = window.__proprPackagedTransportSmoke; + const activated = await smoke.activate(${JSON.stringify(profileForRendererB)}); + const socketId = await smoke.connectSocket(); + await smoke.reconnectSocket(socketId); + const staleClassification = await smoke.handleStaleInvalidation( + ${JSON.stringify(profileId)}, ${JSON.stringify(first.rotated.transportScope)} + ); + smoke.disconnectSocket(${JSON.stringify(first.socketId)}); + await smoke.rest(); + const persisted = await window.proprDesktop.profiles.list(); + const rendererEvidence = smoke.rendererEvidence(); + return { + activated, + staleClassification, + persisted, + rendererEvidence, + rendererPersistenceContainsSecret: JSON.stringify([persisted, rendererEvidence]).includes('propr_it_'), + }; + })()`); + const secretInMainMetadata = [tokenA, tokenB].some(secret => + process.argv.some(argument => argument.includes(secret)) + || JSON.stringify(crashReporter.getParameters()).includes(secret)); + if (second?.staleClassification !== 'retryable' || second?.activated?.profileId !== profileId + || second?.activated?.contractsContainSecret !== false + || second?.rendererPersistenceContainsSecret !== false + || secretInMainMetadata) { + throw new Error('Packaged replacement scope or secret-custody smoke proof failed'); + } + log('info', 'desktop.renderer.transport_smoke.ready', { + customProtocol: true, + restBearer: true, + socketIo: true, + engineIoHandshake: true, + namespaceAuthentication: true, + reconnectAndErrorHandling: true, + scopeRotation: true, + allOriginStorageCleared: true, + cleanupRollbackAndRetry: true, + staleScopeRejected: true, + secretCustody: true, + productionCredentialRoundTrip: true, + storageBackend: security.backend, + }); + } finally { + for (const item of storageWindows) { + if (!item.window.isDestroyed()) item.window.destroy(); + } + } +}; + +const createMainWindow = async ( + transportSmoke: PackagedTransportSmoke | null = activePackagedTransportSmoke, + connectJourney = activePackagedConnectJourney, +): Promise => { const workArea = selectInitialWindowWorkArea(screen); const window = new BrowserWindow( createBrowserWindowOptions(join(__dirname, 'preload.cjs'), !app.isPackaged, workArea), @@ -268,7 +1024,9 @@ const createMainWindow = async (): Promise => { if (validatedDevUrl) { await window.loadURL(new URL('renderer.html', validatedDevUrl).href); } else { - await window.loadURL(packagedRendererUrl); + const rendererUrl = new URL(packagedRendererUrl); + if (transportSmoke) rendererUrl.hash = 'packaged-transport-smoke'; + await window.loadURL(rendererUrl.href); } await readyToShow; @@ -280,7 +1038,7 @@ const createMainWindow = async (): Promise => { } deepLinkDelivery.setWindow(window); const smokeProfileApiUrl = process.env.PROPR_DESKTOP_SMOKE_PROFILE_API_URL; - if (packagedSmokeTest && smokeProfileApiUrl) { + if (packagedSmokeTest && !transportSmoke && smokeProfileApiUrl) { const normalizedSmokeApiUrl = normalizeApiBaseUrl(smokeProfileApiUrl); if (!normalizedSmokeApiUrl || normalizedSmokeApiUrl !== smokeProfileApiUrl) { throw new Error('Packaged desktop smoke profile API URL is invalid'); @@ -304,7 +1062,8 @@ const createMainWindow = async (): Promise => { } log('info', 'desktop.renderer.profile_api.ready', { origin: DESKTOP_RENDERER_ORIGIN }); } - if (packagedSmokeTest) { + let mvpFlowProof: Record = { connectDiscovery: true }; + if (packagedSmokeTest && !transportSmoke && !connectJourney) { const profileFlow = await window.webContents.executeJavaScript(`(async () => { const bridge = window.proprDesktop; const local = await bridge.profiles.save({ label: 'Local setup', apiBaseUrl: 'http://localhost:4000' }); @@ -315,7 +1074,7 @@ const createMainWindow = async (): Promise => { const deadline = performance.now() + 2000; let connectDeepLink = false; do { - const labels = Array.from(document.querySelectorAll('.desktop-connection-card form > label')); + const labels = Array.from(document.querySelectorAll('.desktop-welcome-card form > label')); connectDeepLink = labels[1]?.querySelector('input')?.value === 'https://connect.propr.dev'; if (connectDeepLink) break; await new Promise(resolve => setTimeout(resolve, 25)); @@ -332,23 +1091,44 @@ const createMainWindow = async (): Promise => { || !profileFlow?.lifecycleBoundary || !profileFlow?.connectDeepLink) { throw new Error('Packaged desktop local/remote/API profile flow failed'); } - log('info', 'desktop.renderer.mvp_flows.ready', { connectDiscovery: true }); + mvpFlowProof = { + connectDiscovery: true, + localProfile: profileFlow.local, + remoteActiveProfile: profileFlow.active && profileFlow.remote, + lifecycleBoundary: profileFlow.lifecycleBoundary, + connectUiPopulated: profileFlow.connectDeepLink, + }; + await closePackagedProfileEditorAndWaitForWelcomeChooser(window); + } else if (packagedSmokeTest) { + const boundary = await window.webContents.executeJavaScript(`(async () => { + const bridge = window.proprDesktop; + const metadata = await bridge.app.getMetadata(); + const profiles = await bridge.profiles.list(); + const lifecycle = await bridge.lifecycle.start(); + return { + packaged: metadata.packaged, + profiles: Array.isArray(profiles.profiles), + lifecycleBoundary: lifecycle.ok === false && lifecycle.code === 'not-implemented', + }; + })()`); + if (!boundary?.packaged || !boundary?.profiles || !boundary?.lifecycleBoundary) { + throw new Error('Packaged desktop transport smoke did not preserve the MVP bridge boundaries'); + } + } + if (packagedSmokeTest && !connectJourney) { + log('info', 'desktop.renderer.mvp_flows.ready', mvpFlowProof); log('info', PACKAGED_LAYOUT_READY_EVENT, { layout: await inspectPackagedLayout(window) }); log('info', PACKAGED_REDUCED_NATIVE_WINDOW_READY_EVENT, { layout: inspectPackagedReducedNativeWindow(), }); } log('info', 'desktop.renderer.ready', { preloadBridgeExposed: true }); - if (packagedSmokeTest) { - app.quit(); - } else { - window.show(); - } return window; }; app.on('open-url', (event, url) => { event.preventDefault(); + if (shutdownStarted) return; const normalized = normalizeDeepLink(url); if (normalized) deliverDeepLink(normalized); }); @@ -358,6 +1138,7 @@ if (!hasSingleInstanceLock) { app.quit(); } else { app.on('second-instance', (_event, argv) => { + if (shutdownStarted) return; const deepLink = deepLinkFromArguments(argv); if (deepLink) deliverDeepLink(deepLink); if (mainWindow) { @@ -374,10 +1155,40 @@ if (!hasSingleInstanceLock) { () => packagedSmokeEvidence?.write('desktop.log.write_failed'), ); log('info', 'desktop.app.ready', { version: app.getVersion(), platform: process.platform }); - configureSessionSecurity(); - configurePackagedRendererProtocol(); + const transportSmoke = packagedTransportSmoke(); + activePackagedTransportSmoke = transportSmoke; + const connectSmoke = packagedConnectSmoke(); + activePackagedConnectJourney = Boolean(connectSmoke?.journeyEndpoint); + packagedConnectJourneyDiagnosticState = connectSmoke?.journeyEndpoint && connectSmoke.journeyPhase + ? { phase: connectSmoke.journeyPhase, stage: 'JOURNEY_NOT_STARTED' } + : null; + if (transportSmoke && connectSmoke) throw new Error('Packaged desktop smoke modes are mutually exclusive'); + const smokeProfileOrigin = packagedSmokeTest + ? normalizeApiBaseUrl(process.env.PROPR_DESKTOP_SMOKE_PROFILE_API_URL ?? '') + : null; + let rendererPolicyOrigins: readonly string[] = transportSmoke + ? [transportSmoke.firstOrigin, transportSmoke.secondOrigin] + : connectSmoke?.journeyEndpoint + ? [connectSmoke.journeyEndpoint] + : smokeProfileOrigin + ? [smokeProfileOrigin] + : []; + const rendererPolicyPinnedForSmoke = transportSmoke !== null + || connectSmoke?.journeyEndpoint !== undefined + || (packagedSmokeTest && smokeProfileOrigin !== null); + const reloadCurrentRendererForPolicyChange = createLatestRendererReloader( + () => mainWindow?.webContents ?? null, + ); + const contentSecurityPolicy = (): string => rendererContentSecurityPolicy( + !app.isPackaged, + rendererPolicyOrigins, + ); + const disposeRendererProtocol = configurePackagedRendererProtocol(contentSecurityPolicy); + const journeyStages = connectSmoke?.journeyPhase + ? createPackagedJourneyStageTracker(connectSmoke.journeyPhase) + : null; - const encryption: EncryptionProvider = { + const productionEncryption: EncryptionProvider = { isEncryptionAvailable: () => safeStorage.isEncryptionAvailable(), backend: () => { if (process.platform !== 'linux') return 'os-protected'; @@ -390,31 +1201,173 @@ if (!hasSingleInstanceLock) { encrypt: value => safeStorage.encryptString(value), decrypt: value => safeStorage.decryptString(value), }; - const profiles = new ProfileStore(app.getPath('userData'), encryption); + const profiles = new ProfileStore(app.getPath('userData'), productionEncryption); + const connectDiscovery = new DesktopConnectDiscoveryService(profiles, { + supported: DESKTOP_CONNECT_DISCOVERY_PLATFORMS.has(process.platform), + discover: async () => { + const status = await discoverConfiguredConnect({ + configRoot: connectSmoke?.configRoot ?? join(app.getPath('home'), '.propr'), + statusDependencies: connectSmoke ? { + fetchImpl: connectSmoke.fetch, + inspectTunnel: () => ({ kind: 'ok', running: true }), + } : undefined, + reportSmokeDiagnostic: connectSmoke + ? diagnostic => log('info', 'desktop.renderer.connect_discovery.phase', { + phase: diagnostic.phase, + code: diagnostic.code, + ...(diagnostic.substep ? { substep: diagnostic.substep } : {}), + ...(diagnostic.category ? { category: diagnostic.category } : {}), + }) + : undefined, + }); + if (connectSmoke) { + const statusCode = { + incompatible: 'CONNECT_STATUS_INCOMPATIBLE', + internalFailure: 'CONNECT_STATUS_INTERNAL_FAILURE', + invalidConfig: 'CONNECT_STATUS_INVALID_CONFIG', + notReady: 'CONNECT_STATUS_NOT_READY', + ready: 'CONNECT_STATUS_READY', + timeout: 'CONNECT_STATUS_TIMEOUT', + }[status.status]; + log('info', 'desktop.renderer.connect_discovery.status', { code: statusCode }); + } + return status; + }, + }); + const packagedJourneyApprovals = connectSmoke?.journeyEndpoint + ? createPackagedApprovalTaskTracker(openPackagedJourneyApproval) + : null; + const credentials = new DesktopCredentialService({ + profiles, + fetch: session.defaultSession.fetch.bind(session.defaultSession) as typeof globalThis.fetch, + openPairingBrowser: packagedJourneyApprovals + ? packagedJourneyApprovals.open + : request => openApprovedDesktopPairingUrl(request, shell), + clientName: `ProPR Desktop (${process.platform})`, + reportRevocationFailure: diagnostic => { + log('warn', 'desktop.credential_revocation.retry_pending', diagnostic); + }, + snapshotConnectIdentityClaim: (profileId, origin) => + connectDiscovery.snapshotIdentityClaim(profileId, origin), + }); + const sessionSecurity = configureDesktopSessionSecurity({ + contentSecurityPolicy, + credentials, + desktopSession: session.defaultSession, + enableRendererNetworkBoundary: process.platform !== 'win32', + getMainRenderer: () => mainWindow?.webContents ?? null, + isTrustedRendererUrl: value => isTrustedRendererUrl(value, devServerUrl, packagedRendererUrl), + ...(connectSmoke?.journeyEndpoint ? { + reportNetworkPermissionDecision: (evidence: DesktopNetworkPermissionEvidence) => { + log('info', 'desktop.renderer.connect_network_permission', { ...evidence }); + }, + reportRendererOwnershipDecision: (evidence: DesktopRendererOwnershipEvidence) => { + log('info', PACKAGED_CONNECT_RENDERER_OWNERSHIP_EVENT, { ...evidence }); + }, + } : {}), + }); + const credentialInitialization = await credentials.initialize(); + if (credentialInitialization.status === 'degraded') { + log('warn', 'desktop.credential_revocation.startup_degraded', { + retryPending: credentialInitialization.retryPending, + }); + } + if (app.isPackaged && !rendererPolicyPinnedForSmoke) { + const current = await credentials.listProfiles(); + const activeOrigin = current.profiles + .find(profile => profile.id === current.activeProfileId)?.apiBaseUrl; + rendererPolicyOrigins = activeOrigin?.startsWith('http://') ? [activeOrigin] : []; + } const lifecycle = new LocalLifecycleController(); - registerIpcHandlers({ + const registeredIpc = registerIpcHandlers({ app, ipcMain, profiles, + credentials, + connectDiscovery, lifecycle, logger, desktopSession: session.defaultSession, devServerUrl, packagedRendererUrl, + openExternal: openAllowedExternalUrl, + ...(app.isPackaged && !rendererPolicyPinnedForSmoke ? { + onRendererActiveProfileChanged: (origin: string | null) => { + const nextOrigins = origin?.startsWith('http://') ? [origin] : []; + if (rendererPolicyOrigins.length === nextOrigins.length + && rendererPolicyOrigins.every((value, index) => value === nextOrigins[index])) return; + rendererPolicyOrigins = nextOrigins; + // The next document receives the exact policy in both its meta tag and + // response header. Until then, the existing CSP and request boundary + // both fail closed for the new active endpoint. + reloadCurrentRendererForPolicyChange(); + }, + } : {}), + ...(journeyStages ? { + reportAcceptanceJourneyStage: (stage: DesktopAcceptanceJourneyStage) => { + journeyStages.record(stage); + }, + reportAcceptanceOperation: ( + operation: DesktopAcceptanceOperation, + status: DesktopAcceptanceOperationStatus, + ) => { + log('info', PACKAGED_CONNECT_JOURNEY_OPERATION_EVENT, { operation, status }); + }, + } : {}), }); - - app.on('before-quit', event => { - if (shutdownStarted) return; - event.preventDefault(); - shutdownStarted = true; - void lifecycle.shutdown().finally(() => { - log('info', 'desktop.app.shutdown'); - app.quit(); - }); - }); + const shutdownLifecycle = transportSmoke?.shutdownMode === 'forced-timeout' + ? { shutdown: () => new Promise(() => undefined) } + : lifecycle; + const shutdown = createDesktopShutdownCoordinator({ + credentials, + lifecycle: shutdownLifecycle, + ipc: registeredIpc, + profiles, + sessionSecurity, + disposeRendererProtocol, + getWindow: () => mainWindow, + quit: () => app.quit(), + onStarted: () => { shutdownStarted = true; }, + log, + }, transportSmoke?.shutdownMode === 'forced-timeout' ? { drainTimeoutMs: 250 } : undefined); + app.on('before-quit', event => shutdown.beforeQuit(event)); mainWindow = await createMainWindow(); + if (connectSmoke) { + reportPackagedConnectJourneyStage('JOURNEY_DISCOVERY_RENDERER'); + const readyFields = await runPackagedConnectDiscoverySmoke(mainWindow); + if (connectSmoke.journeyEndpoint && connectSmoke.journeyPhase) { + if (!journeyStages || !packagedJourneyApprovals) { + throw new Error('Packaged Connect journey stage tracker was unavailable'); + } + await runPackagedConnectJourneySmoke( + mainWindow, + profiles, + credentials, + packagedJourneyApprovals.waitForNextOpen, + packagedJourneyApprovals.waitForIdle, + connectSmoke.journeyEndpoint, + connectSmoke.journeyPhase, + journeyStages, + ); + } + await publishPackagedConnectReady(readyFields); + packagedConnectJourneyDiagnosticState = null; + app.quit(); + } else if (transportSmoke) { + await runPackagedTransportSmoke(mainWindow, profiles, credentials, transportSmoke); + app.quit(); + if (transportSmoke.shutdownMode === 'retry') { + log('info', 'desktop.app.shutdown_retry_requested'); + app.quit(); + } + } else if (packagedSmokeTest) { + app.quit(); + } else { + mainWindow.show(); + } + const updateConfig = __PROPR_DESKTOP_UPDATE_MANIFEST_URL__ ? { manifestUrl: __PROPR_DESKTOP_UPDATE_MANIFEST_URL__, @@ -439,14 +1392,21 @@ if (!hasSingleInstanceLock) { } app.on('activate', () => { + if (shutdownStarted) return; if (BrowserWindow.getAllWindows().length === 0) { - void createMainWindow().then(window => { + void createMainWindow(null).then(window => { mainWindow = window; }); } }); - }).catch(error => { + if (packagedConnectJourneyDiagnosticState) { + log('error', PACKAGED_CONNECT_JOURNEY_FAILURE_EVENT, { + phase: packagedConnectJourneyDiagnosticState.phase, + stage: packagedConnectJourneyDiagnosticState.stage, + reason: packagedConnectJourneyFailureReason(error), + }); + } log('error', 'desktop.app.start_failed', { error }); app.exit(1); }); diff --git a/apps/desktop/src/packaged-approval-session.test.ts b/apps/desktop/src/packaged-approval-session.test.ts new file mode 100644 index 000000000..07de6bc20 --- /dev/null +++ b/apps/desktop/src/packaged-approval-session.test.ts @@ -0,0 +1,395 @@ +import assert from 'node:assert/strict'; +import { EventEmitter } from 'node:events'; +import { describe, it } from 'node:test'; +import type { BrowserWindow, Session } from 'electron'; +import { + clearPackagedApprovalStorage, + createPackagedApprovalNavigation, + createPackagedApprovalTaskTracker, + packagedApprovalPartition, +} from './packaged-approval-session'; + +const approvalUrl = `http://127.0.0.1:41731/api/desktop/pairings/dpr_${'A'.repeat(22)}/browser`; + +type Callback = (decision: T) => void; +type RequestHandler = (details: Record, callback: Callback>) => void; +type RedirectHandler = (details: Record) => void; +type CompletedHandler = (details: Record) => void; + +class FakeWebRequest { + beforeRequest: RequestHandler | null = null; + beforeSendHeaders: RequestHandler | null = null; + sendHeaders: RedirectHandler | null = null; + headersReceived: RequestHandler | null = null; + beforeRedirect: RedirectHandler | null = null; + completed: CompletedHandler | null = null; + + onBeforeRequest(handler: RequestHandler | null): void { this.beforeRequest = handler; } + onBeforeSendHeaders(handler: RequestHandler | null): void { this.beforeSendHeaders = handler; } + onSendHeaders(handler: RedirectHandler | null): void { this.sendHeaders = handler; } + onHeadersReceived(handler: RequestHandler | null): void { this.headersReceived = handler; } + onBeforeRedirect(handler: RedirectHandler | null): void { this.beforeRedirect = handler; } + onCompleted(handler: CompletedHandler | null): void { this.completed = handler; } +} + +class FakeSession extends EventEmitter { + readonly webRequest = new FakeWebRequest(); + permissionCheck: ((...values: unknown[]) => boolean) | null = null; + permissionRequest: ((...values: unknown[]) => void) | null = null; + clearCount = 0; + + setPermissionCheckHandler(handler: ((...values: unknown[]) => boolean) | null): void { + this.permissionCheck = handler; + } + + setPermissionRequestHandler(handler: ((...values: unknown[]) => void) | null): void { + this.permissionRequest = handler; + } + + async clearStorageData(): Promise { this.clearCount += 1; } +} + +class FakeContents extends EventEmitter { + readonly id = 91; + readonly mainFrame = { detached: false, parent: null }; + currentUrl = ''; + openHandler: (() => { action: 'deny' }) | null = null; + + constructor(readonly session: FakeSession) { super(); } + + setWindowOpenHandler(handler: () => { action: 'deny' }): void { this.openHandler = handler; } + getURL(): string { return this.currentUrl; } +} + +class FakeWindow { + readonly webContents: FakeContents; + destroyed = false; + destroyCount = 0; + load: (url: string) => Promise = async () => undefined; + + constructor(approvalSession: FakeSession) { + this.webContents = new FakeContents(approvalSession); + } + + loadURL(url: string): Promise { return this.load(url); } + isDestroyed(): boolean { return this.destroyed; } + destroy(): void { this.destroyed = true; this.destroyCount += 1; } +} + +const event = () => { + let prevented = false; + return { + preventDefault: () => { prevented = true; }, + get prevented() { return prevented; }, + }; +}; + +const decision = async ( + handler: RequestHandler | null, + details: Record, +): Promise> => { + assert.ok(handler); + return await new Promise(resolve => handler(details, resolve)); +}; + +interface Harness { + approvalSession: FakeSession; + defaultSession: FakeSession; + window: FakeWindow; + requestHeaders: Record; + responseHeaders: Record; +} + +const harness = (statusCode = 200): Harness => { + const approvalSession = new FakeSession(); + const defaultSession = new FakeSession(); + const window = new FakeWindow(approvalSession); + const requestHeaders: Record = { Accept: 'text/html' }; + const responseHeaders: Record = { + 'Content-Type': ['text/html'], + 'Set-Cookie': ['approval=secret'], + }; + window.load = async url => { + const details = { + id: 7, + url, + method: 'GET', + webContentsId: window.webContents.id, + webContents: window.webContents, + frame: window.webContents.mainFrame, + resourceType: 'mainFrame', + }; + const start = await decision(approvalSession.webRequest.beforeRequest, details); + if (start.cancel === true) throw new Error('cancelled'); + const outgoing = await decision(approvalSession.webRequest.beforeSendHeaders, { + ...details, + requestHeaders, + }); + if (outgoing.cancel === true) throw new Error('cancelled'); + Object.assign(requestHeaders, outgoing.requestHeaders); + approvalSession.webRequest.sendHeaders?.({ + ...details, + requestHeaders, + }); + const incoming = await decision(approvalSession.webRequest.headersReceived, { + ...details, + statusCode, + responseHeaders, + }); + if (incoming.cancel === true) throw new Error('cancelled'); + for (const name of Object.keys(responseHeaders)) delete responseHeaders[name]; + Object.assign(responseHeaders, incoming.responseHeaders); + window.webContents.currentUrl = url; + window.webContents.emit('did-frame-navigate', event(), url, statusCode, 'OK', true, 1, 1); + approvalSession.webRequest.completed?.({ ...details, statusCode }); + }; + return { approvalSession, defaultSession, window, requestHeaders, responseHeaders }; +}; + +const controllerFor = (value: Harness) => createPackagedApprovalNavigation({ + approvalUrl, + approvalSession: value.approvalSession as unknown as Session, + approvalWindow: value.window as unknown as BrowserWindow, + defaultSession: value.defaultSession as unknown as Session, +}); + +describe('packaged pairing approval isolated session', () => { + it('uses non-persistent unique partition names and rejects invalid entropy', () => { + const first = packagedApprovalPartition('a'.repeat(32)); + const second = packagedApprovalPartition('b'.repeat(32)); + assert.notEqual(first, second); + assert.equal(first.startsWith('persist:'), false); + assert.throws(() => packagedApprovalPartition('../shared')); + }); + + it('allows one exact credentialless main-frame GET and strips response cookies', async () => { + const value = harness(); + const controller = controllerFor(value); + assert.equal(value.approvalSession.permissionCheck?.(), false); + let permissionAllowed = true; + value.approvalSession.permissionRequest?.(null, 'notifications', (allowed: boolean) => { + permissionAllowed = allowed; + }); + assert.equal(permissionAllowed, false); + + await controller.navigate(); + + assert.equal(Object.keys(value.requestHeaders).some(name => /^(authorization|cookie)$/iu.test(name)), false); + assert.equal(Object.keys(value.responseHeaders).some(name => /^set-cookie2?$/iu.test(name)), false); + await controller.cleanup(); + }); + + it('waits for an exact completion event that arrives after loadURL resolves', async () => { + const value = harness(); + const controller = controllerFor(value); + const originalLoad = value.window.load; + let finishCompletion: (() => void) | undefined; + value.window.load = async url => { + const onCompleted = value.approvalSession.webRequest.completed; + assert.ok(onCompleted); + value.approvalSession.webRequest.completed = details => { + finishCompletion = () => onCompleted(details); + }; + await originalLoad(url); + }; + + const navigation = controller.navigate(); + let settled = false; + void navigation.finally(() => { settled = true; }); + await new Promise(resolve => setImmediate(resolve)); + assert.ok(finishCompletion); + assert.equal(settled, false); + finishCompletion(); + await navigation; + assert.equal(settled, true); + await controller.cleanup(); + }); + + it('reports owned approval readiness and drains delayed work before the next pairing case', async () => { + const requested: string[] = []; + const releases: Array<() => void> = []; + const tracker = createPackagedApprovalTaskTracker(async request => { + requested.push(request); + await new Promise(resolve => { releases.push(resolve); }); + }); + + for (const request of ['expiry', 'cancel', 'success']) { + let ready = false; + const readiness = tracker.waitForNextOpen().then(() => { ready = true; }); + const concurrentReadiness = tracker.waitForNextOpen(); + await new Promise(resolve => setImmediate(resolve)); + assert.equal(ready, false); + const opened = tracker.open(request); + await Promise.all([readiness, concurrentReadiness]); + assert.equal(ready, true); + let idle = false; + const drained = tracker.waitForIdle().then(() => { idle = true; }); + await new Promise(resolve => setImmediate(resolve)); + assert.equal(idle, false); + assert.equal(requested.filter(value => value === request).length, 1); + releases.shift()?.(); + await Promise.all([opened, drained]); + assert.equal(idle, true); + } + + assert.deepEqual(requested, ['expiry', 'cancel', 'success']); + }); + + it('cancels an incidental resource without invalidating the exact main-frame approval', async () => { + const value = harness(); + const originalLoad = value.window.load; + value.window.load = async url => { + const incidental = await decision(value.approvalSession.webRequest.beforeRequest, { + id: 6, + url: 'http://127.0.0.1:41731/favicon.ico', + method: 'GET', + webContentsId: value.window.webContents.id, + webContents: value.window.webContents, + frame: value.window.webContents.mainFrame, + resourceType: 'image', + }); + assert.deepEqual(incidental, { cancel: true }); + await originalLoad(url); + }; + + const controller = controllerFor(value); + await controller.navigate(); + await controller.cleanup(); + }); + + it('rejects redirects, alternate origins and paths, methods, subframes, and credential headers', async t => { + for (const scenario of [ + 'redirect', + 'off-origin', + 'path', + 'method', + 'subframe', + 'status', + 'authorization', + 'cookie', + ] as const) { + await t.test(scenario, async () => { + const value = harness(scenario === 'status' ? 204 : 200); + const original = value.window.load; + if (scenario === 'redirect') { + value.window.load = async url => { + value.approvalSession.webRequest.beforeRedirect?.({ + id: 7, + url, + method: 'GET', + redirectURL: 'https://attacker.example.test/', + }); + const redirect = event(); + value.window.webContents.emit('will-redirect', redirect); + assert.equal(redirect.prevented, true); + throw new Error('redirect cancelled'); + }; + } else if (scenario === 'status') { + // The default loader supplies a non-exact successful response status. + } else if (scenario === 'authorization' || scenario === 'cookie') { + value.requestHeaders[scenario === 'authorization' ? 'Authorization' : 'Cookie'] = 'secret'; + } else { + value.window.load = async () => { + const changed = { + id: 7, + url: scenario === 'off-origin' + ? 'http://127.0.0.2:41731/api/desktop/pairings/other/browser' + : scenario === 'path' + ? `${approvalUrl}/extra` + : approvalUrl, + method: scenario === 'method' ? 'POST' : 'GET', + webContentsId: value.window.webContents.id, + webContents: value.window.webContents, + frame: scenario === 'subframe' ? { parent: value.window.webContents.mainFrame } : value.window.webContents.mainFrame, + resourceType: scenario === 'subframe' ? 'subFrame' : 'mainFrame', + }; + const result = await decision(value.approvalSession.webRequest.beforeRequest, changed); + assert.deepEqual(result, { cancel: true }); + throw new Error('cancelled'); + }; + } + const controller = controllerFor(value); + await assert.rejects(controller.navigate(), { message: 'Packaged pairing browser approval was rejected' }); + await controller.cleanup(); + value.window.load = original; + }); + } + }); + + it('rejects popups, downloads, webviews, and external renderer navigation', async t => { + for (const scenario of ['popup', 'download', 'webview', 'navigation'] as const) { + await t.test(scenario, async () => { + const value = harness(); + const original = value.window.load; + value.window.load = async url => { + await original(url); + const blocked = event(); + if (scenario === 'popup') { + assert.deepEqual(value.window.webContents.openHandler?.(), { action: 'deny' }); + } else if (scenario === 'download') { + value.approvalSession.emit('will-download', blocked); + } else if (scenario === 'webview') { + value.window.webContents.emit('will-attach-webview', blocked); + } else { + value.window.webContents.emit('will-navigate', blocked); + } + if (scenario !== 'popup') assert.equal(blocked.prevented, true); + }; + const controller = controllerFor(value); + await assert.rejects(controller.navigate(), { message: 'Packaged pairing browser approval was rejected' }); + await controller.cleanup(); + }); + } + }); + + it('rejects default/mismatched/reused sessions and cleans up idempotently', async () => { + const defaultValue = harness(); + assert.throws(() => createPackagedApprovalNavigation({ + approvalUrl, + approvalSession: defaultValue.defaultSession as unknown as Session, + approvalWindow: defaultValue.window as unknown as BrowserWindow, + defaultSession: defaultValue.defaultSession as unknown as Session, + }), { message: 'Packaged pairing browser approval was rejected' }); + + const value = harness(); + const controller = controllerFor(value); + assert.throws(() => controllerFor(value), { message: 'Packaged pairing browser approval was rejected' }); + await controller.navigate(); + await assert.rejects(controller.navigate(), { message: 'Packaged pairing browser approval was rejected' }); + const firstCleanup = controller.cleanup(); + const secondCleanup = controller.cleanup(); + assert.equal(firstCleanup, secondCleanup); + await Promise.all([firstCleanup, secondCleanup]); + + assert.equal(value.window.destroyCount, 1); + assert.equal(value.approvalSession.clearCount, 1); + assert.equal(value.approvalSession.permissionCheck, null); + assert.equal(value.approvalSession.permissionRequest, null); + assert.equal(value.approvalSession.listenerCount('will-download'), 0); + assert.equal(value.window.webContents.listenerCount('will-navigate'), 0); + assert.equal(value.approvalSession.webRequest.beforeRequest, null); + assert.equal(value.approvalSession.webRequest.beforeSendHeaders, null); + assert.equal(value.approvalSession.webRequest.sendHeaders, null); + assert.equal(value.approvalSession.webRequest.headersReceived, null); + assert.equal(value.approvalSession.webRequest.beforeRedirect, null); + assert.equal(value.approvalSession.webRequest.completed, null); + }); + + it('bounds storage cleanup, reports failures, and never makes the session reusable', async () => { + const stalled = new FakeSession(); + stalled.clearStorageData = () => new Promise(() => undefined); + await assert.rejects( + clearPackagedApprovalStorage(stalled as unknown as Session, 5), + { message: 'Packaged pairing browser approval cleanup failed' }, + ); + + const value = harness(); + value.approvalSession.clearStorageData = async () => { throw new Error('private cleanup detail'); }; + const controller = controllerFor(value); + await controller.navigate(); + const firstCleanup = controller.cleanup(); + assert.equal(firstCleanup, controller.cleanup()); + await assert.rejects(firstCleanup, { message: 'Packaged pairing browser approval cleanup failed' }); + assert.throws(() => controllerFor(value), { message: 'Packaged pairing browser approval was rejected' }); + }); +}); diff --git a/apps/desktop/src/packaged-approval-session.ts b/apps/desktop/src/packaged-approval-session.ts new file mode 100644 index 000000000..230d0283c --- /dev/null +++ b/apps/desktop/src/packaged-approval-session.ts @@ -0,0 +1,389 @@ +import type { + BrowserWindow, + Event as ElectronEvent, + OnBeforeRedirectListenerDetails, + OnBeforeRequestListenerDetails, + OnBeforeSendHeadersListenerDetails, + OnCompletedListenerDetails, + OnHeadersReceivedListenerDetails, + OnSendHeadersListenerDetails, + Session, + WebContentsWillNavigateEventParams, + WebContentsWillRedirectEventParams, +} from 'electron'; + +const APPROVAL_REJECTED = 'Packaged pairing browser approval was rejected'; +const APPROVAL_CLEANUP_REJECTED = 'Packaged pairing browser approval cleanup failed'; +const APPROVAL_STATUS = 200; +const APPROVAL_COMPLETION_TIMEOUT_MS = 5_000; +const APPROVAL_CLEANUP_TIMEOUT_MS = 5_000; +const claimedSessions = new WeakSet(); + +export const packagedApprovalPartition = (nonce: string): string => { + if (!/^[a-f0-9]{32}$/u.test(nonce)) throw rejected(); + return `propr-packaged-approval-${nonce}`; +}; + +export interface PackagedApprovalNavigation { + navigate(): Promise; + cleanup(): Promise; +} + +export interface PackagedApprovalTaskTracker { + open(request: Request): Promise; + waitForNextOpen(): Promise; + waitForIdle(): Promise; +} + +interface PackagedApprovalNavigationOptions { + approvalUrl: string; + approvalSession: Session; + approvalWindow: BrowserWindow; + defaultSession: Session; +} + +function rejected(): Error { + return new Error(APPROVAL_REJECTED); +} + +function cleanupRejected(): Error { + return new Error(APPROVAL_CLEANUP_REJECTED); +} + +/** + * Keep acceptance-only browser work owned after pairing expiry/cancellation. + * The pairing protocol deliberately stops awaiting a browser callback once its + * lifetime ends, but a packaged smoke must still observe the one HTTP approval + * that it started before advancing the shared fixture or publishing READY. + */ +export const createPackagedApprovalTaskTracker = ( + open: (request: Request) => Promise, +): PackagedApprovalTaskTracker => { + const active = new Set>(); + const nextOpenWaiters = new Set<{ after: number; resolve(): void }>(); + let openGeneration = 0; + let rejectedTask = false; + + return { + open(request) { + const task = Promise.resolve().then(() => open(request)); + active.add(task); + openGeneration += 1; + for (const waiter of nextOpenWaiters) { + if (waiter.after >= openGeneration) continue; + nextOpenWaiters.delete(waiter); + waiter.resolve(); + } + void task.then( + () => active.delete(task), + () => { + rejectedTask = true; + active.delete(task); + }, + ); + return task; + }, + waitForNextOpen() { + const after = openGeneration; + return new Promise(resolve => nextOpenWaiters.add({ after, resolve })); + }, + async waitForIdle() { + while (active.size > 0) { + await Promise.all(Array.from(active, task => task.then( + () => undefined, + () => undefined, + ))); + } + if (rejectedTask) throw rejected(); + }, + }; +}; + +export const clearPackagedApprovalStorage = async ( + approvalSession: Pick, + timeoutMs = APPROVAL_CLEANUP_TIMEOUT_MS, +): Promise => { + if (!Number.isInteger(timeoutMs) || timeoutMs <= 0 || timeoutMs > APPROVAL_CLEANUP_TIMEOUT_MS) { + throw cleanupRejected(); + } + let timeout: ReturnType | undefined; + try { + await Promise.race([ + approvalSession.clearStorageData(), + new Promise((_resolve, reject) => { + timeout = setTimeout(() => reject(cleanupRejected()), timeoutMs); + }), + ]); + } catch { + throw cleanupRejected(); + } finally { + if (timeout) clearTimeout(timeout); + } +}; + +const containsCredentialHeaders = (headers: Record): boolean => + Object.keys(headers).some(name => { + const normalized = name.toLowerCase(); + return normalized === 'authorization' || normalized === 'cookie' || normalized === 'proxy-authorization'; + }); + +const withoutSetCookie = ( + headers: Record | undefined, +): Record => Object.fromEntries( + Object.entries(headers ?? {}).filter(([name]) => { + const normalized = name.toLowerCase(); + return normalized !== 'set-cookie' && normalized !== 'set-cookie2'; + }), +); + +/** + * Constrain the packaged acceptance harness to one isolated, credentialless browser + * navigation. This session is deliberately unrelated to the production renderer + * and credential transport session. + */ +export const createPackagedApprovalNavigation = ({ + approvalUrl, + approvalSession, + approvalWindow, + defaultSession, +}: PackagedApprovalNavigationOptions): PackagedApprovalNavigation => { + const contents = approvalWindow.webContents; + if (approvalSession === defaultSession + || contents.session !== approvalSession + || claimedSessions.has(approvalSession)) { + throw rejected(); + } + claimedSessions.add(approvalSession); + + let active = true; + let navigated = false; + let allowedRequestId: number | null = null; + let responseStatus: number | null = null; + let requestSent = false; + let committedStatus: number | null = null; + let committedUrl: string | null = null; + let completedStatus: number | null = null; + let boundaryRejected = false; + let completionResolve: (() => void) | null = null; + let cleanupPromise: Promise | null = null; + + const releaseCompletionWait = (): void => { + completionResolve?.(); + completionResolve = null; + }; + const rejectBoundary = (): void => { + boundaryRejected = true; + releaseCompletionWait(); + }; + const ownsMainFrame = (details: { + webContentsId?: number; + webContents?: Electron.WebContents; + frame?: Electron.WebFrameMain | null; + resourceType: string; + }): boolean => details.webContentsId === contents.id + && (details.webContents === undefined || details.webContents === contents) + && details.resourceType === 'mainFrame' + && (details.frame === undefined || details.frame === contents.mainFrame); + + const exactAllowedRequest = (details: { + id: number; + url: string; + method: string; + webContentsId?: number; + webContents?: Electron.WebContents; + frame?: Electron.WebFrameMain | null; + resourceType: string; + }): boolean => active + && details.id === allowedRequestId + && details.url === approvalUrl + && details.method === 'GET' + && ownsMainFrame(details); + + approvalSession.setPermissionCheckHandler(() => false); + approvalSession.setPermissionRequestHandler((_webContents, _permission, callback) => callback(false)); + + const onBeforeRequest = (details: OnBeforeRequestListenerDetails, callback: (decision: { + cancel?: boolean; + }) => void): void => { + if (details.resourceType !== 'mainFrame') { + if (details.resourceType === 'subFrame') rejectBoundary(); + callback({ cancel: true }); + return; + } + const allowed = active + && allowedRequestId === null + && details.url === approvalUrl + && details.method === 'GET' + && ownsMainFrame(details); + if (!allowed) { + rejectBoundary(); + callback({ cancel: true }); + return; + } + allowedRequestId = details.id; + callback({}); + }; + + const onBeforeSendHeaders = ( + details: OnBeforeSendHeadersListenerDetails, + callback: (decision: { cancel?: boolean; requestHeaders?: Record }) => void, + ): void => { + if (!exactAllowedRequest(details) || containsCredentialHeaders(details.requestHeaders)) { + rejectBoundary(); + callback({ cancel: true }); + return; + } + callback({ requestHeaders: details.requestHeaders }); + }; + + const onHeadersReceived = ( + details: OnHeadersReceivedListenerDetails, + callback: (decision: { cancel?: boolean; responseHeaders?: Record }) => void, + ): void => { + if (!exactAllowedRequest(details) || details.statusCode !== APPROVAL_STATUS) { + rejectBoundary(); + callback({ cancel: true }); + return; + } + responseStatus = details.statusCode; + callback({ responseHeaders: withoutSetCookie(details.responseHeaders) }); + }; + + const onSendHeaders = (details: OnSendHeadersListenerDetails): void => { + if (!exactAllowedRequest(details) || containsCredentialHeaders(details.requestHeaders)) { + rejectBoundary(); + return; + } + requestSent = true; + }; + + const onBeforeRedirect = (_details: OnBeforeRedirectListenerDetails): void => { + rejectBoundary(); + }; + const onCompleted = (details: OnCompletedListenerDetails): void => { + if (!exactAllowedRequest(details) || details.statusCode !== responseStatus) { + rejectBoundary(); + return; + } + completedStatus = details.statusCode; + releaseCompletionWait(); + }; + approvalSession.webRequest.onBeforeRequest(onBeforeRequest); + approvalSession.webRequest.onBeforeSendHeaders(onBeforeSendHeaders); + approvalSession.webRequest.onSendHeaders(onSendHeaders); + approvalSession.webRequest.onHeadersReceived(onHeadersReceived); + approvalSession.webRequest.onBeforeRedirect(onBeforeRedirect); + approvalSession.webRequest.onCompleted(onCompleted); + + const onWillNavigate = (event: ElectronEvent): void => { + rejectBoundary(); + event.preventDefault(); + }; + const onWillRedirect = (event: ElectronEvent): void => { + rejectBoundary(); + event.preventDefault(); + }; + const onDidFrameNavigate = ( + _event: ElectronEvent, + url: string, + status: number, + _statusText: string, + isMainFrame: boolean, + ): void => { + if (!isMainFrame || url !== approvalUrl || status !== responseStatus) { + rejectBoundary(); + return; + } + committedUrl = url; + committedStatus = status; + }; + const onDidNavigateInPage = ( + _event: ElectronEvent, + url: string, + isMainFrame: boolean, + ): void => { + // An exact no-op history replacement is the only same-document behavior allowed. + if (!isMainFrame || url !== approvalUrl) rejectBoundary(); + }; + const onWillAttachWebview = (event: ElectronEvent): void => { + rejectBoundary(); + event.preventDefault(); + }; + const onWillDownload = (event: ElectronEvent): void => { + rejectBoundary(); + event.preventDefault(); + }; + + contents.setWindowOpenHandler(() => { + rejectBoundary(); + return { action: 'deny' }; + }); + contents.on('will-navigate', onWillNavigate); + contents.on('will-redirect', onWillRedirect); + contents.on('did-frame-navigate', onDidFrameNavigate); + contents.on('did-navigate-in-page', onDidNavigateInPage); + contents.on('will-attach-webview', onWillAttachWebview); + approvalSession.on('will-download', onWillDownload); + + return { + async navigate() { + if (!active || navigated) throw rejected(); + navigated = true; + const completion = completedStatus !== null || boundaryRejected + ? Promise.resolve() + : new Promise(resolve => { completionResolve = resolve; }); + let timeout: ReturnType | undefined; + try { + await Promise.race([ + (async () => { + await approvalWindow.loadURL(approvalUrl); + await completion; + })(), + new Promise((_resolve, reject) => { + timeout = setTimeout(() => reject(rejected()), APPROVAL_COMPLETION_TIMEOUT_MS); + }), + ]); + } catch { + throw rejected(); + } finally { + if (timeout) clearTimeout(timeout); + completionResolve = null; + } + if (!active + || boundaryRejected + || allowedRequestId === null + || !requestSent + || responseStatus === null + || responseStatus !== committedStatus + || responseStatus !== completedStatus + || committedUrl !== approvalUrl + || contents.getURL() !== approvalUrl) { + throw rejected(); + } + }, + cleanup() { + if (cleanupPromise) return cleanupPromise; + cleanupPromise = (async () => { + active = false; + releaseCompletionWait(); + if (!approvalWindow.isDestroyed()) approvalWindow.destroy(); + contents.off('will-navigate', onWillNavigate); + contents.off('will-redirect', onWillRedirect); + contents.off('did-frame-navigate', onDidFrameNavigate); + contents.off('did-navigate-in-page', onDidNavigateInPage); + contents.off('will-attach-webview', onWillAttachWebview); + approvalSession.off('will-download', onWillDownload); + approvalSession.setPermissionCheckHandler(null); + approvalSession.setPermissionRequestHandler(null); + approvalSession.webRequest.onBeforeRequest(null); + approvalSession.webRequest.onBeforeSendHeaders(null); + approvalSession.webRequest.onSendHeaders(null); + approvalSession.webRequest.onHeadersReceived(null); + approvalSession.webRequest.onBeforeRedirect(null); + approvalSession.webRequest.onCompleted(null); + await clearPackagedApprovalStorage(approvalSession); + })(); + return cleanupPromise; + }, + }; +}; diff --git a/apps/desktop/src/pairing-browser.test.ts b/apps/desktop/src/pairing-browser.test.ts new file mode 100644 index 000000000..8d0c7c873 --- /dev/null +++ b/apps/desktop/src/pairing-browser.test.ts @@ -0,0 +1,54 @@ +import assert from 'node:assert/strict'; +import { describe, it } from 'node:test'; +import { openApprovedDesktopPairingUrl } from './pairing-browser'; + +const pairingId = `dpr_${'A'.repeat(22)}`; +const fallback = `https://api.example.test/api/desktop/pairings/${pairingId}/browser`; + +describe('desktop pairing browser final sink', () => { + it('opens only the exact canonical API browser route', async () => { + const opened: string[] = []; + await openApprovedDesktopPairingUrl({ + apiBaseUrl: 'https://api.example.test', + pairingId, + approvalUrl: fallback, + }, { openExternal: async url => { opened.push(url); } }); + + assert.deepEqual(opened, [fallback]); + }); + + it('opens the exact hosted Connect approval bound to the verified tunnel', async () => { + const approvalUrl = `https://app.propr.dev/desktop/pairing?pairing_id=${pairingId}&tunnel=t-instance123.propr.dev`; + const opened: string[] = []; + await openApprovedDesktopPairingUrl({ + apiBaseUrl: 'https://t-instance123.propr.dev', + pairingId, + approvalUrl, + }, { openExternal: async url => { opened.push(url); } }); + + assert.deepEqual(opened, [approvalUrl]); + }); + + it('rejects replacement, mutation, noncanonical, and reserved-host values without opening', async () => { + const opened: string[] = []; + for (const approvalUrl of [ + `https://api.example.test/api/desktop/pairings/dpr_${'B'.repeat(22)}/browser`, + `${fallback}?next=https://attacker.example`, + `https://api.example.test:443/api/desktop/pairings/${pairingId}/browser`, + `https://x.t-instance123.propr.dev/api/desktop/pairings/${pairingId}/browser`, + `https://app.propr.dev/desktop/pairing?pairing_id=${pairingId}&tunnel=t-replaced456.propr.dev`, + ]) { + await assert.rejects( + openApprovedDesktopPairingUrl({ + apiBaseUrl: approvalUrl.includes('app.propr.dev') + ? 'https://t-instance123.propr.dev' + : 'https://api.example.test', + pairingId, + approvalUrl, + }, { openExternal: async url => { opened.push(url); } }), + (error: unknown) => (error as Error).message === 'Desktop pairing browser request was rejected', + ); + } + assert.deepEqual(opened, []); + }); +}); diff --git a/apps/desktop/src/pairing-browser.ts b/apps/desktop/src/pairing-browser.ts new file mode 100644 index 000000000..d3e5f92f1 --- /dev/null +++ b/apps/desktop/src/pairing-browser.ts @@ -0,0 +1,20 @@ +import { normalizeDesktopPairingApprovalUrl } from '@propr/shared'; +import type { DesktopPairingBrowserRequest } from './credential-service'; + +const REJECTED_PAIRING_URL_ERROR = 'Desktop pairing browser request was rejected'; + +interface ExternalShell { + openExternal(url: string): Promise; +} + +/** Revalidate the exact API response at the final host sink before navigation. */ +export async function openApprovedDesktopPairingUrl( + request: DesktopPairingBrowserRequest, + shell: ExternalShell, +): Promise { + const approved = normalizeDesktopPairingApprovalUrl(request); + if (approved === null || approved !== request.approvalUrl) { + throw new Error(REJECTED_PAIRING_URL_ERROR); + } + await shell.openExternal(approved); +} diff --git a/apps/desktop/src/pairing-response-lifecycle.test.ts b/apps/desktop/src/pairing-response-lifecycle.test.ts new file mode 100644 index 000000000..da6a7c738 --- /dev/null +++ b/apps/desktop/src/pairing-response-lifecycle.test.ts @@ -0,0 +1,493 @@ +import assert from 'node:assert/strict'; +import { mkdtemp, readFile, readdir, rm } from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { join, relative } from 'node:path'; +import { describe, it } from 'node:test'; +import type { App, IpcMain, IpcMainInvokeEvent, Session } from 'electron'; +import type { PairingProtocolRequestOptions } from '@propr/client'; +import { PROPR_API_COMPATIBILITY, PROPR_UI_COMPATIBILITY } from '@propr/shared'; +import { DesktopCredentialService } from './credential-service'; +import { registerIpcHandlers } from './ipc'; +import type { LocalLifecycleController } from './lifecycle'; +import type { DesktopLogger } from './logger'; +import { ProfileStore, type EncryptionProvider } from './profile-store'; +import { IPC_CHANNELS } from './shared/contract'; +import { createDesktopShutdownCoordinator } from './shutdown'; + +type Endpoint = 'start' | 'poll' | 'activate' | 'cancel'; +type BarrierPhase = 'header' | 'body' | 'reader-cancel' | 'body-cancel'; + +interface Scenario { + name: string; + endpoint: Endpoint; + phase: BarrierPhase; +} + +const scenarios: readonly Scenario[] = [ + { name: 'start-header', endpoint: 'start', phase: 'header' }, + { name: 'start-body', endpoint: 'start', phase: 'body' }, + { name: 'poll-header', endpoint: 'poll', phase: 'header' }, + { name: 'poll-body', endpoint: 'poll', phase: 'body' }, + { name: 'activate-header', endpoint: 'activate', phase: 'header' }, + { name: 'activate-body', endpoint: 'activate', phase: 'body' }, + { name: 'cancel-header', endpoint: 'cancel', phase: 'header' }, + { name: 'cancel-body', endpoint: 'cancel', phase: 'body' }, + { name: 'never-settling-reader-cancel', endpoint: 'activate', phase: 'reader-cancel' }, + { name: 'never-settling-body-cancel', endpoint: 'activate', phase: 'body-cancel' }, +]; + +const encryption: EncryptionProvider = { + isEncryptionAvailable: () => true, + backend: () => 'keychain', + encrypt: value => Buffer.from(Buffer.from(value, 'utf8').toString('base64url'), 'utf8'), + decrypt: value => Buffer.from(value.toString(), 'base64url').toString('utf8'), +}; + +const json = (body: unknown, status = 200): Response => new Response(JSON.stringify(body), { + status, + headers: { 'Content-Type': 'application/json' }, +}); + +const deferred = () => { + let resolve!: (value: T | PromiseLike) => void; + let reject!: (reason?: unknown) => void; + const promise = new Promise((settle, fail) => { resolve = settle; reject = fail; }); + return { promise, resolve, reject }; +}; + +class ProtocolClock { + #now = 0; + #nextId = 1; + readonly #timers = new Map void }>(); + + readonly source: NonNullable = { + now: () => this.#now, + setTimeout: (callback, milliseconds) => { + const id = this.#nextId++; + this.#timers.set(id, { at: this.#now + milliseconds, callback }); + return id as unknown as ReturnType; + }, + clearTimeout: timer => { this.#timers.delete(timer as unknown as number); }, + }; + + get pending(): number { return this.#timers.size; } + + async advance(milliseconds: number): Promise { + const target = this.#now + milliseconds; + while (true) { + const due = [...this.#timers.entries()] + .filter(([, timer]) => timer.at <= target) + .sort(([leftId, left], [rightId, right]) => left.at - right.at || leftId - rightId)[0]; + if (!due) break; + this.#now = due[1].at; + this.#timers.delete(due[0]); + due[1].callback(); + await Promise.resolve(); + await Promise.resolve(); + } + this.#now = target; + await Promise.resolve(); + await Promise.resolve(); + } +} + +const bounded = async (promise: Promise, milliseconds = 1_000): Promise => { + let timer: ReturnType | undefined; + try { + return await Promise.race([ + promise, + new Promise((_resolve, reject) => { + timer = setTimeout(() => reject(new Error('desktop shutdown did not settle')), milliseconds); + }), + ]); + } finally { + if (timer) clearTimeout(timer); + } +}; + +const durableBytes = async (root: string): Promise> => { + const snapshot: Record = {}; + const visit = async (directory: string): Promise => { + for (const entry of await readdir(directory, { withFileTypes: true })) { + const path = join(directory, entry.name); + if (entry.isDirectory()) await visit(path); + else snapshot[relative(root, path)] = (await readFile(path)).toString('base64'); + } + }; + await visit(root); + return Object.fromEntries(Object.entries(snapshot).sort(([left], [right]) => left.localeCompare(right))); +}; + +const immediate = (): Promise => new Promise(resolve => setImmediate(resolve)); + +describe('desktop pairing service IPC native shutdown lifecycle', () => { + assert.equal(scenarios.length, 10); + + for (const scenario of scenarios) { + it(`${scenario.name} drains through the real service, IPC gate, and before-quit order`, async () => { + const directory = await mkdtemp(join(tmpdir(), `propr-${scenario.name}-`)); + const clock = new ProtocolClock(); + const barrier = deferred(); + const lateHeader = deferred(); + const lateCancellation = deferred(); + const cancellationStarted = deferred(); + const protocolNow = Date.parse('2026-01-01T00:00:00.000Z'); + const expiresAt = new Date(protocolNow + 10_000).toISOString(); + const profileId = `profile-${scenario.name}`; + const origin = 'https://a.example.test'; + const provisionalToken = `propr_it_${'C'.repeat(43)}`; + const counts = { + fetchStart: 0, + fetchAbort: 0, + bodyPull: 0, + bodyCancel: 0, + profileRead: 0, + profileWrite: 0, + profileIO: 0, + ipcEntry: 0, + ipcExit: 0, + rendererPublication: 0, + sessionNetwork: 0, + }; + const order: string[] = []; + const unhandled: unknown[] = []; + const onUnhandled = (error: unknown): void => { unhandled.push(error); }; + process.on('unhandledRejection', onUnhandled); + + const rawStore = new ProfileStore(directory, encryption, { + beforeIO: () => { counts.profileIO += 1; }, + }); + const readMethods = new Set([ + 'list', 'readCredential', 'readProfileCredential', 'pendingRevocations', 'security', + ]); + const store = new Proxy(rawStore, { + get(target, property) { + const value = Reflect.get(target, property, target) as unknown; + if (typeof value !== 'function') return value; + return (...args: unknown[]) => { + if (readMethods.has(String(property))) counts.profileRead += 1; + else counts.profileWrite += 1; + return (value as (...values: unknown[]) => unknown).apply(target, args); + }; + }, + }) as ProfileStore; + + let targetSignal: AbortSignal | undefined; + let pairingBinding: Record = {}; + let activationFailures = 0; + let cancellationCanSettle = false; + const stalledBody = (beforeReader: boolean): Response => new Response( + new ReadableStream({ + pull() { + counts.bodyPull += 1; + if (!beforeReader) barrier.resolve(undefined); + }, + cancel() { + counts.bodyCancel += 1; + if (beforeReader) barrier.resolve(undefined); + cancellationStarted.resolve(undefined); + return lateCancellation.promise; + }, + }), + { + headers: { + 'Content-Type': 'application/json', + ...(beforeReader ? { 'Content-Length': '4097' } : {}), + }, + }, + ); + + const fetchImplementation: typeof globalThis.fetch = async (input, init) => { + if (input.toString().endsWith('/api/desktop/discovery')) return json({ + schemaVersion: 1, + product: 'ProPR', + version: '0.8.15', + apiCompatibility: PROPR_API_COMPATIBILITY, + uiCompatibility: PROPR_UI_COMPATIBILITY, + canonicalEndpoint: null, + publicInstanceIdentity: '123e4567-e89b-42d3-a456-426614174000', + desktopAuthentication: { + protocolVersion: 2, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, + }); + counts.fetchStart += 1; + const url = input.toString(); + const signal = init?.signal ?? undefined; + signal?.addEventListener('abort', () => { counts.fetchAbort += 1; }, { once: true }); + const endpoint: Endpoint = url.endsWith('/poll') + ? 'poll' + : url.endsWith('/activate') + ? 'activate' + : url.endsWith('/cancel') + ? 'cancel' + : 'start'; + if (endpoint === scenario.endpoint) { + targetSignal = signal; + if (scenario.phase === 'header') { + barrier.resolve(undefined); + return lateHeader.promise; + } + if (scenario.phase === 'body-cancel') return stalledBody(true); + return stalledBody(false); + } + if (endpoint === 'start') { + const request = JSON.parse(String(init?.body)) as Record; + pairingBinding = { + instanceId: request.instanceId, + origin: request.origin, + scope: request.scope, + credentialGeneration: request.credentialGeneration, + }; + return json({ + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: `${origin}/api/desktop/pairings/dpr_${'A'.repeat(22)}/browser`, + expiresAt, + interval: 1, + }, 201); + } + if (endpoint === 'poll') { + return json({ + status: 'provisional', + token: provisionalToken, + tokenType: 'Bearer', + activationTicket: 'T'.repeat(43), + activationExpiresAt: expiresAt, + ...pairingBinding, + }); + } + if (endpoint === 'activate') { + if (scenario.endpoint === 'cancel') { + activationFailures += 1; + return json({ code: 'ACTIVATION_FAILED', error: 'activation failed' }, 500); + } + return json({ + status: 'active', + receipt: 'R'.repeat(22), + activatedAt: '2026-01-01T00:00:01.000Z', + expiresAt: null, + }); + } + return json({ status: 'cancelled', cancelledAt: '2026-01-01T00:00:01.000Z' }); + }; + + const handlers = new Map unknown>(); + let service!: DesktopCredentialService; + try { + const profile = await store.save({ id: profileId, label: scenario.name, apiBaseUrl: origin }); + service = new DesktopCredentialService({ + profiles: store, + clientName: `Native ${scenario.name}`, + openPairingBrowser: async () => undefined, + fetch: fetchImplementation, + pairingTiming: { now: () => protocolNow, sleep: async () => undefined }, + pairingProtocol: { + overallTimeoutMs: 1_000, + deadlines: { headerMs: 500, bodyMs: 500, cancellationMs: 100 }, + clock: clock.source, + reportDiagnostic: () => undefined, + }, + }); + assert.deepEqual(await service.initialize(), { status: 'ready', retryPending: false }); + + const desktopSession = { + fetch: async () => { counts.sessionNetwork += 1; return new Response(null, { status: 204 }); }, + clearStorageData: async () => undefined, + } as unknown as Session; + const registered = registerIpcHandlers({ + app: { + getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true, + } as unknown as App, + ipcMain: { + handle: (channel: string, handler: (...args: any[]) => unknown) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: store, + credentials: service, + connectDiscovery: { + discover: async () => [], + rediscover: async () => null, + }, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession, + devServerUrl: undefined, + packagedRendererUrl: 'propr-renderer://app/index.html', + openExternal: async () => undefined, + observeInvocation: phase => { counts[phase === 'entry' ? 'ipcEntry' : 'ipcExit'] += 1; }, + }); + const event = { + senderFrame: { url: 'propr-renderer://app/index.html' }, + } as unknown as IpcMainInvokeEvent; + const invoke = (channel: string, ...args: unknown[]): Promise => + Promise.resolve(handlers.get(channel)!(event, ...args)); + + const admitted = invoke(IPC_CHANNELS.authenticationPair, { + id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl, + }).then(value => { + counts.rendererPublication += 1; + return { status: 'fulfilled' as const, value }; + }, error => ({ status: 'rejected' as const, error })); + await bounded(barrier.promise); + + const provisionalCouldExist = ['activate', 'cancel'].includes(scenario.endpoint); + const pendingBeforeShutdown = await store.pendingRevocations(); + assert.equal(pendingBeforeShutdown.length, provisionalCouldExist ? 1 : 0); + if (provisionalCouldExist) { + assert.deepEqual(pendingBeforeShutdown[0].credential, { + version: 2, + profileId, + origin, + publicInstanceIdentity: '123e4567-e89b-42d3-a456-426614174000', + token: provisionalToken, + }); + } + assert.equal(await store.readCredential(profileId), null); + + let windowDestroyed = false; + let shutdownFinished = false; + let finalQuitCalls = 0; + let allowedFinalQuits = 0; + let shutdown!: ReturnType; + shutdown = createDesktopShutdownCoordinator({ + credentials: { + dispose: () => { order.push('credentials-dispose'); return service.dispose(); }, + }, + lifecycle: { + shutdown: async () => { order.push('lifecycle-shutdown'); }, + }, + ipc: { + close: () => { order.push('ipc-close'); registered.close(); }, + awaitIdle: () => { order.push('ipc-drain'); return registered.awaitIdle(); }, + dispose: () => { order.push('ipc-dispose'); registered.dispose(); }, + }, + profiles: { + close: () => { order.push('profiles-close'); return store.close(); }, + }, + sessionSecurity: { + close: () => { order.push('session-close'); }, + dispose: () => { order.push('session-dispose'); }, + }, + disposeRendererProtocol: () => { order.push('protocol-dispose'); }, + getWindow: () => ({ + isDestroyed: () => windowDestroyed, + destroy: () => { windowDestroyed = true; order.push('window-destroy'); }, + }), + quit: () => { + finalQuitCalls += 1; + order.push('app-quit'); + let finalQuitPrevented = false; + shutdown.beforeQuit({ preventDefault: () => { finalQuitPrevented = true; } }); + if (!finalQuitPrevented) { + allowedFinalQuits += 1; + shutdownFinished = true; + } + }, + onStarted: () => { order.push('shutdown-started'); }, + log: () => undefined, + }); + let prevented = 0; + shutdown.beforeQuit({ preventDefault: () => { prevented += 1; } }); + assert.equal(prevented, 1); + assert.equal(shutdown.started, true); + assert.deepEqual(order.slice(0, 4), [ + 'shutdown-started', 'ipc-close', 'session-close', 'protocol-dispose', + ]); + + const callsBeforeLate = { + fetchStart: counts.fetchStart, + profileRead: counts.profileRead, + profileWrite: counts.profileWrite, + sessionNetwork: counts.sessionNetwork, + }; + await Promise.all([ + assert.rejects(invoke(IPC_CHANNELS.profilesList), /DESKTOP_CLOSING/), + assert.rejects(invoke(IPC_CHANNELS.authenticationPair, { + id: profile.id, label: profile.label, apiBaseUrl: profile.apiBaseUrl, + }), /DESKTOP_CLOSING/), + assert.rejects(invoke(IPC_CHANNELS.authLogout, origin), /DESKTOP_CLOSING/), + ]); + assert.deepEqual({ + fetchStart: counts.fetchStart, + profileRead: counts.profileRead, + profileWrite: counts.profileWrite, + sessionNetwork: counts.sessionNetwork, + }, callsBeforeLate); + + const cancellationExpected = scenario.phase !== 'header'; + if (cancellationExpected) { + await bounded(cancellationStarted.promise); + shutdown.beforeQuit({ preventDefault: () => { prevented += 1; } }); + assert.equal(prevented, 2, 'repeated before-quit was not prevented during cancellation'); + cancellationCanSettle = true; + await clock.advance(99); + await Promise.resolve(); + assert.equal(shutdownFinished, false, 'untrusted cancellation escaped its 100ms budget'); + await clock.advance(1); + } else { + shutdown.beforeQuit({ preventDefault: () => { prevented += 1; } }); + assert.equal(prevented, 2, 'repeated before-quit was not prevented during header drain'); + } + await bounded(shutdown.awaitFinished()); + const original = await bounded(admitted); + assert.equal(original.status, 'rejected'); + if (original.status === 'rejected') { + assert.match(String(original.error), /Desktop operation failed \[IPC_OPERATION_FAILED\]/); + assert.doesNotMatch(String(original.error), /Desktop pairing was cancelled/i); + } + assert.equal(targetSignal?.aborted, true); + assert.equal(counts.rendererPublication, 0); + assert.equal(counts.ipcEntry, 1); + assert.equal(counts.ipcExit, 1); + assert.equal(handlers.size, 0); + assert.equal(windowDestroyed, true); + assert.equal(shutdownFinished, true); + assert.equal(finalQuitCalls, 1); + assert.equal(allowedFinalQuits, 1); + assert.equal(activationFailures, scenario.endpoint === 'cancel' ? 2 : 0); + for (const step of [ + 'shutdown-started', 'ipc-close', 'session-close', 'protocol-dispose', + 'credentials-dispose', 'lifecycle-shutdown', 'ipc-drain', 'profiles-close', + 'session-dispose', 'ipc-dispose', 'window-destroy', 'app-quit', + ]) { + assert.equal(order.filter(entry => entry === step).length, 1, `${step} ran more than once`); + } + assert.equal(order.indexOf('profiles-close') > order.indexOf('ipc-drain'), true); + assert.equal(order.indexOf('session-dispose') > order.indexOf('profiles-close'), true); + assert.equal(order.indexOf('window-destroy') > order.indexOf('ipc-dispose'), true); + assert.equal(order.at(-1), 'app-quit'); + await bounded(service.awaitIdle()); + await bounded(registered.awaitIdle()); + assert.deepEqual(service.prepareRequest(`${origin}/api/tasks`, {}), { cancel: true }); + assert.equal(clock.pending, 0); + + let extraQuitPrevented = false; + shutdown.beforeQuit({ preventDefault: () => { extraQuitPrevented = true; } }); + assert.equal(extraQuitPrevented, true, 'more than the deliberate final quit was allowed'); + assert.equal(finalQuitCalls, 1); + assert.equal(allowedFinalQuits, 1); + + const countsAtDispose = { ...counts }; + const bytesAtDispose = await durableBytes(directory); + if (scenario.phase === 'header') lateHeader.reject(new Error('late private header failure')); + if (cancellationCanSettle) lateCancellation.reject(new Error('late private cancellation failure')); + await clock.advance(2_000); + await immediate(); + await immediate(); + + assert.deepEqual(counts, countsAtDispose); + assert.deepEqual(await durableBytes(directory), bytesAtDispose); + assert.deepEqual(unhandled, []); + assert.equal(clock.pending, 0); + console.log(`NATIVE_PAIRING_SHUTDOWN ${scenario.name}`); + } finally { + process.removeListener('unhandledRejection', onUnhandled); + await service?.dispose().catch(() => undefined); + await rm(directory, { recursive: true, force: true }); + } + }); + } +}); diff --git a/apps/desktop/src/pending-revocation-crash-fixture.ts b/apps/desktop/src/pending-revocation-crash-fixture.ts new file mode 100644 index 000000000..6710aee21 --- /dev/null +++ b/apps/desktop/src/pending-revocation-crash-fixture.ts @@ -0,0 +1,54 @@ +import { DesktopCredentialService } from './credential-service'; +import { ProfileStore, type EncryptionProvider } from './profile-store'; + +const [directory, mode] = process.argv.slice(2) as [string, 'during-revoke' | 'after-remote-success']; +const encryption: EncryptionProvider = { + isEncryptionAvailable: () => true, + backend: () => 'keychain', + encrypt: value => Buffer.from(value, 'utf8'), + decrypt: value => value.toString('utf8'), +}; +const store = new ProfileStore(directory, encryption); +const profiles = mode === 'after-remote-success' + ? new Proxy(store, { + get(target, property) { + if (property === 'completePendingRevocation') return async () => { + process.kill(process.pid, 'SIGKILL'); + return false; + }; + const value = Reflect.get(target, property); + return typeof value === 'function' ? value.bind(target) : value; + }, + }) + : store; +const service = new DesktopCredentialService({ + profiles, + clientName: 'Crash fixture', + openPairingBrowser: async () => undefined, + fetch: async (input, init) => { + if (input.toString().endsWith('/api/desktop/discovery')) { + return new Response(JSON.stringify({ + schemaVersion: 1, + product: 'ProPR', + version: '0.8.15', + apiCompatibility: '2026-08-01', + uiCompatibility: '2026-08-01', + canonicalEndpoint: null, + publicInstanceIdentity: '123e4567-e89b-42d3-a456-426614174000', + desktopAuthentication: { + protocolVersion: 2, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, + }), { headers: { 'Content-Type': 'application/json' } }); + } + const authorization = new Headers(init?.headers).get('Authorization'); + if (authorization !== `Bearer propr_it_${'A'.repeat(43)}`) { + throw new Error('Pending revocation used the wrong credential'); + } + if (mode === 'during-revoke') process.kill(process.pid, 'SIGKILL'); + return new Response(null, { status: 204 }); + }, +}); +await service.initialize(); diff --git a/apps/desktop/src/preload-bridge.test.ts b/apps/desktop/src/preload-bridge.test.ts index 81db36bef..1da9cfa34 100644 --- a/apps/desktop/src/preload-bridge.test.ts +++ b/apps/desktop/src/preload-bridge.test.ts @@ -24,19 +24,23 @@ class FakeIpc implements PreloadIpc { describe('desktop preload bridge', () => { it('exposes only the narrow frozen namespaces', () => { const bridge = createDesktopBridge(new FakeIpc()); - assert.deepEqual(Object.keys(bridge).sort(), ['app', 'auth', 'credentials', 'external', 'lifecycle', 'profiles', 'storage']); + assert.deepEqual(Object.keys(bridge).sort(), ['app', 'auth', 'authentication', 'connection', 'discovery', 'external', 'lifecycle', 'profiles', 'storage']); assert.equal(Object.isFrozen(bridge), true); assert.equal(Object.values(bridge).every(Object.isFrozen), true); assert.equal('fs' in bridge, false); assert.equal('exec' in bridge, false); }); - it('maps profile and credential operations to fixed channels', async () => { + it('maps profile and main-process authentication operations to fixed channels', async () => { const ipc = new FakeIpc(); const bridge = createDesktopBridge(ipc); await bridge.auth.logout('http://localhost:4000'); await bridge.profiles.save({ label: 'Local', apiBaseUrl: 'http://localhost:4000' }); - await bridge.credentials.write('profile-1', 'secret'); + await bridge.authentication.pair({ id: 'profile-1', label: 'Local', apiBaseUrl: 'http://localhost:4000' }); + await bridge.connection.activate('activation-ticket'); + await bridge.connection.discard({ profileId: 'profile-1', transportScope: 'transport-scope' }); + await bridge.discovery.discover(); + await bridge.discovery.rediscover('profile-1'); await bridge.lifecycle.start(); assert.deepEqual(ipc.invocations, [ { channel: IPC_CHANNELS.authLogout, args: ['http://localhost:4000'] }, @@ -44,9 +48,37 @@ describe('desktop preload bridge', () => { channel: IPC_CHANNELS.profilesSave, args: [{ label: 'Local', apiBaseUrl: 'http://localhost:4000' }], }, - { channel: IPC_CHANNELS.credentialsWrite, args: ['profile-1', 'secret'] }, + { + channel: IPC_CHANNELS.authenticationPair, + args: [{ id: 'profile-1', label: 'Local', apiBaseUrl: 'http://localhost:4000' }], + }, + { channel: IPC_CHANNELS.connectionActivate, args: ['activation-ticket'] }, + { + channel: IPC_CHANNELS.connectionDiscard, + args: [{ profileId: 'profile-1', transportScope: 'transport-scope' }], + }, + { channel: IPC_CHANNELS.connectDiscover, args: [] }, + { channel: IPC_CHANNELS.connectRediscover, args: ['profile-1'] }, { channel: IPC_CHANNELS.lifecycleStart, args: [] }, ]); + assert.equal(bridge.discovery.supported, true); + }); + + it('can advertise an unsupported host without exposing a renderer-selected root', () => { + const bridge = createDesktopBridge(new FakeIpc(), false); + assert.equal(bridge.discovery.supported, false); + assert.deepEqual(Object.keys(bridge.discovery).sort(), ['discover', 'rediscover', 'supported']); + }); + + it('exposes only a fixed stage reporter when packaged Connect acceptance is authorized', async () => { + const ipc = new FakeIpc(); + const bridge = createDesktopBridge(ipc, true, true); + assert.deepEqual(Object.keys(bridge.acceptance ?? {}), ['reportJourneyStage']); + await bridge.acceptance?.reportJourneyStage('CREDENTIAL_COMMITTED'); + assert.deepEqual(ipc.invocations, [{ + channel: IPC_CHANNELS.acceptanceJourneyStage, + args: ['CREDENTIAL_COMMITTED'], + }]); }); it('does not expose Electron event objects to deep-link listeners', () => { diff --git a/apps/desktop/src/preload-bridge.ts b/apps/desktop/src/preload-bridge.ts index 3bba8300e..3a6e6e3d3 100644 --- a/apps/desktop/src/preload-bridge.ts +++ b/apps/desktop/src/preload-bridge.ts @@ -10,7 +10,13 @@ export interface PreloadIpc { const invoke = (ipc: PreloadIpc, channel: string, ...args: unknown[]): Promise => ipc.invoke(channel, ...args) as Promise; -export const createDesktopBridge = (ipc: PreloadIpc): DesktopBridge => { +export const createDesktopBridge = ( + ipc: PreloadIpc, + connectDiscoverySupported = process.platform === 'darwin' + || process.platform === 'linux' + || process.platform === 'win32', + connectJourneyAcceptance = false, +): DesktopBridge => { const deepLinkListeners = new Set<(url: string) => void>(); const pendingDeepLinks: string[] = []; ipc.on(IPC_CHANNELS.deepLink, (_event, value) => { @@ -45,10 +51,20 @@ export const createDesktopBridge = (ipc: PreloadIpc): DesktopBridge => { remove: (profileId) => invoke(ipc, IPC_CHANNELS.profilesRemove, profileId), setActive: (profileId) => invoke(ipc, IPC_CHANNELS.profilesSetActive, profileId), }, - credentials: { - read: (profileId) => invoke(ipc, IPC_CHANNELS.credentialsRead, profileId), - write: (profileId, value) => invoke(ipc, IPC_CHANNELS.credentialsWrite, profileId, value), - remove: (profileId) => invoke(ipc, IPC_CHANNELS.credentialsRemove, profileId), + authentication: { + pair: (profile) => invoke(ipc, IPC_CHANNELS.authenticationPair, profile), + cancel: (profileId) => invoke(ipc, IPC_CHANNELS.authenticationCancel, profileId), + }, + connection: { + probe: (profile) => invoke(ipc, IPC_CHANNELS.connectionProbe, profile), + activate: (activationTicket) => invoke(ipc, IPC_CHANNELS.connectionActivate, activationTicket), + discard: (value) => invoke(ipc, IPC_CHANNELS.connectionDiscard, value), + invalidate: (value) => invoke(ipc, IPC_CHANNELS.connectionInvalidate, value), + }, + discovery: { + supported: connectDiscoverySupported, + discover: () => invoke(ipc, IPC_CHANNELS.connectDiscover), + rediscover: (profileId) => invoke(ipc, IPC_CHANNELS.connectRediscover, profileId), }, lifecycle: { status: () => invoke(ipc, IPC_CHANNELS.lifecycleStatus), @@ -56,6 +72,11 @@ export const createDesktopBridge = (ipc: PreloadIpc): DesktopBridge => { stop: () => invoke(ipc, IPC_CHANNELS.lifecycleStop), restart: () => invoke(ipc, IPC_CHANNELS.lifecycleRestart), }, + ...(connectJourneyAcceptance ? { + acceptance: { + reportJourneyStage: (stage) => invoke(ipc, IPC_CHANNELS.acceptanceJourneyStage, stage), + }, + } : {}), }; Object.values(bridge).forEach(Object.freeze); diff --git a/apps/desktop/src/preload.ts b/apps/desktop/src/preload.ts index ba4f4d45b..165e7f187 100644 --- a/apps/desktop/src/preload.ts +++ b/apps/desktop/src/preload.ts @@ -1,4 +1,11 @@ import { contextBridge, ipcRenderer } from 'electron'; import { createDesktopBridge } from './preload-bridge'; -contextBridge.exposeInMainWorld('proprDesktop', createDesktopBridge(ipcRenderer)); +const connectJourneyAcceptance = process.env.PROPR_DESKTOP_CONNECT_SMOKE_TEST === '1' + && (process.env.PROPR_DESKTOP_CONNECT_JOURNEY_PHASE === 'pair' + || process.env.PROPR_DESKTOP_CONNECT_JOURNEY_PHASE === 'reprobe'); + +contextBridge.exposeInMainWorld( + 'proprDesktop', + createDesktopBridge(ipcRenderer, undefined, connectJourneyAcceptance), +); diff --git a/apps/desktop/src/profile-store-crash-fixture.ts b/apps/desktop/src/profile-store-crash-fixture.ts new file mode 100644 index 000000000..ded27579c --- /dev/null +++ b/apps/desktop/src/profile-store-crash-fixture.ts @@ -0,0 +1,94 @@ +import { readFile, unlink, writeFile } from 'node:fs/promises'; +import { join } from 'node:path'; +import { ProfileStore, type EncryptionProvider, type ProfileStoreDurabilityStep } from './profile-store'; + +const [directory, requestedStep] = process.argv.slice(2) as [string, string]; +const crashStep = requestedStep.split(':').at(-1) as ProfileStoreDurabilityStep; +const encryption: EncryptionProvider = { + isEncryptionAvailable: () => true, + backend: () => 'keychain', + encrypt: value => Buffer.from(Buffer.from(value, 'utf8').toString('base64url'), 'utf8'), + decrypt: value => Buffer.from(value.toString(), 'base64url').toString('utf8'), +}; +const store = new ProfileStore(directory, encryption, { + afterDurabilityStep: step => { + if (!requestedStep.startsWith('visibility:') && step === crashStep) process.kill(process.pid, 'SIGKILL'); + }, +}); +if (requestedStep.startsWith('recovery:')) { + await store.list(); + throw new Error(`Recovery fixture did not reach ${crashStep}`); +} +const desktop = join(directory, 'desktop'); +const stateA = requestedStep.startsWith('visibility:') + ? await readFile(join(desktop, 'profiles.json')) + : null; +const journalsA = requestedStep.startsWith('visibility:') + ? await Promise.all([0, 1].map(async index => { + try { return await readFile(join(desktop, `profiles.journal.${index}`)); } catch { return null; } + })) + : []; +const baseline = await store.readProfileCredential('profile-1'); +if (requestedStep.startsWith('detach:')) { + await store.detachProfile('profile-1'); + throw new Error(`Detach fixture did not reach ${crashStep}`); +} +await store.commitPairedProfile( + { id: 'profile-1', label: 'Replacement', apiBaseUrl: 'https://propr.example.com' }, + { + version: 2, + profileId: 'profile-1', + origin: 'https://propr.example.com', + publicInstanceIdentity: '123e4567-e89b-42d3-a456-426614174000', + token: `propr_it_${'B'.repeat(43)}`, + }, + baseline, + () => true, +); +if (requestedStep.startsWith('visibility:')) { + const mode = requestedStep.slice('visibility:'.length); + const stateB = JSON.parse(await readFile(join(desktop, 'profiles.json'), 'utf8')) as { + credentialSlots: Record; + }; + if (mode === 'pointer-rollback' && stateA) { + await writeFile(join(desktop, 'profiles.json'), stateA); + } else if (mode === 'pointer-corruption' || mode === 'mirror-malformed') { + await writeFile(join(desktop, 'profiles.json'), '{corrupt'); + } else if (mode === 'mirror-missing') { + await unlink(join(desktop, 'profiles.json')); + } else if (mode === 'mirror-truncated') { + await writeFile(join(desktop, 'profiles.json'), '{"version":3'); + } else if (mode === 'mirror-stale' && stateA) { + await writeFile(join(desktop, 'profiles.json'), stateA); + } else if (mode === 'mirror-schema-invalid') { + const contents = JSON.parse(await readFile(join(desktop, 'profiles.json'), 'utf8')) as Record; + await writeFile(join(desktop, 'profiles.json'), JSON.stringify({ + ...contents, version: 99, + })); + } else if (mode === 'mirror-attacker') { + const contents = JSON.parse(await readFile(join(desktop, 'profiles.json'), 'utf8')) as Record; + const profiles = contents.profiles as Array>; + await writeFile(join(desktop, 'profiles.json'), JSON.stringify({ + ...contents, profiles: profiles.map(profile => ({ ...profile, label: 'Attacker' })), + })); + } else if (mode === 'missing-target') { + await unlink(join(desktop, 'credentials', stateB.credentialSlots['profile-1'])); + } else if (mode === 'state-before-journal') { + for (const [index, bytes] of journalsA.entries()) { + const path = join(desktop, `profiles.journal.${index}`); + if (bytes) await writeFile(path, bytes); + else await unlink(path).catch(() => undefined); + } + } else if (mode === 'alternate-slot-rollback') { + const state = JSON.parse(await readFile(join(desktop, 'profiles.json'), 'utf8')) as { generation: string }; + const newest = Number(BigInt(state.generation) % 2n); + const older = (newest + 1) % 2; + await writeFile( + join(desktop, `profiles.journal.${newest}`), + await readFile(join(desktop, `profiles.journal.${older}`)), + ); + } else { + throw new Error(`Unknown visibility mode: ${mode}`); + } + process.kill(process.pid, 'SIGKILL'); +} diff --git a/apps/desktop/src/profile-store.test.ts b/apps/desktop/src/profile-store.test.ts index c4807df05..5c486350d 100644 --- a/apps/desktop/src/profile-store.test.ts +++ b/apps/desktop/src/profile-store.test.ts @@ -1,11 +1,33 @@ import assert from 'node:assert/strict'; -import { mkdtemp, readFile, rm } from 'node:fs/promises'; +import { spawn } from 'node:child_process'; +import { createHash } from 'node:crypto'; +import { mkdir, mkdtemp, readFile, readdir, rename, rm, unlink, writeFile } from 'node:fs/promises'; import { tmpdir } from 'node:os'; import { join } from 'node:path'; import { afterEach, describe, it } from 'node:test'; -import { ProfileStore, type EncryptionProvider } from './profile-store'; +import { PROPR_API_ORIGIN_PARITY_CASES } from '@propr/shared'; +import { + flushFileData, + ProfileStore, + type EncryptionProvider, + type ProfileStoreDurabilityStep, + type ProfileStoreIOOperation, +} from './profile-store'; const temporaryDirectories: string[] = []; +const NATIVE_VISIBILITY_SCENARIOS = [ + 'pointer-rollback', 'pointer-corruption', 'missing-target', 'state-before-journal', + 'mirror-missing', 'mirror-truncated', 'mirror-malformed', 'mirror-stale', + 'mirror-schema-invalid', 'mirror-attacker', 'alternate-slot-rollback', +] as const; +const RECOVERY_KILL_STEPS: ProfileStoreDurabilityStep[] = [ + 'state-written', 'state-fsynced', + 'journal-written', 'journal-fsynced', 'journal-closed', 'journal-reopened', + 'journal-prepared-verified', 'journal-committed', 'journal-commit-fsynced', + 'journal-commit-verified', 'journal-commit-closed', 'state-renamed', + ...(process.platform === 'win32' ? [] : ['state-directory-fsynced'] as const), +]; +const RECOVERY_KILL_MODES = ['bootstrap', 'migration-v1', 'migration-v2'] as const; const createDirectory = async (): Promise => { const directory = await mkdtemp(join(tmpdir(), 'propr-desktop-test-')); @@ -20,15 +42,81 @@ const encryption = (available = true, backend = 'keychain'): EncryptionProvider decrypt: value => Buffer.from(value.toString(), 'base64url').toString('utf8'), }); +const credential = (profileId: string, tokenCharacter = 'A') => ({ + version: 2 as const, + profileId, + origin: 'https://propr.example.com', + publicInstanceIdentity: '123e4567-e89b-42d3-a456-426614174000', + token: `propr_it_${tokenCharacter.repeat(43)}`, +}); +const legacyCredential = (profileId: string, tokenCharacter = 'A') => ({ + version: 1 as const, + profileId, + origin: 'https://propr.example.com', + token: `propr_it_${tokenCharacter.repeat(43)}`, +}); + +const bounded = (promise: Promise, milliseconds = 1_000): Promise => { + let timer: ReturnType | undefined; + const timeout = new Promise((_resolve, reject) => { + timer = setTimeout(() => reject(new Error('Profile store operation did not settle')), milliseconds); + }); + return Promise.race([promise, timeout]).finally(() => { + if (timer) clearTimeout(timer); + }); +}; + +const legacyProfile = { + id: 'profile-1', label: 'Legacy', apiBaseUrl: 'https://propr.example.com', + createdAt: '2026-08-29T00:00:00.000Z', updatedAt: '2026-08-29T00:00:00.000Z', +}; + +const seedRecoveryMode = async ( + directory: string, + mode: (typeof RECOVERY_KILL_MODES)[number], +): Promise => { + if (mode === 'bootstrap') return; + const desktop = join(directory, 'desktop'); + const credentials = join(desktop, 'credentials'); + await mkdir(credentials, { recursive: true }); + if (mode === 'migration-v1') { + await writeFile(join(desktop, 'profiles.json'), JSON.stringify({ + version: 1, activeProfileId: legacyProfile.id, profiles: [legacyProfile], + })); + await writeFile( + join(credentials, `${legacyProfile.id}.bin`), + encryption().encrypt(JSON.stringify(legacyCredential(legacyProfile.id))), + ); + return; + } + const slot = `${legacyProfile.id}.00000000-0000-4000-8000-000000000001.bin`; + await writeFile(join(credentials, slot), encryption().encrypt(JSON.stringify(legacyCredential(legacyProfile.id)))); + await writeFile(join(desktop, 'profiles.json'), JSON.stringify({ + version: 2, + activeProfileId: legacyProfile.id, + profiles: [legacyProfile], + credentialSlots: { [legacyProfile.id]: slot }, + })); +}; + afterEach(async () => { await Promise.all(temporaryDirectories.splice(0).map(directory => rm(directory, { recursive: true, force: true }))); }); describe('desktop profile store', () => { + it('matches the shared canonical origin parity table at the persistence boundary', async () => { + const store = new ProfileStore(await createDirectory(), encryption()); + let index = 0; + for (const [name, input, expected] of PROPR_API_ORIGIN_PARITY_CASES) { + const save = store.save({ id: `parity-${index++}`, label: name, apiBaseUrl: input }); + if (expected === null) await assert.rejects(save, /HTTPS|URL/, name); + else assert.equal((await save).apiBaseUrl, expected, name); + } + }); it('persists validated profiles and active selection', async () => { const directory = await createDirectory(); const store = new ProfileStore(directory, encryption()); - const profile = await store.save({ label: ' Local ', apiBaseUrl: 'http://localhost:4000///' }); + const profile = await store.save({ label: ' Local ', apiBaseUrl: 'http://localhost:4000/' }); const ipv6Profile = await store.save({ label: 'IPv6', apiBaseUrl: 'http://[::1]:4000/' }); await store.setActive(profile.id); assert.deepEqual(await store.list(), { profiles: [profile, ipv6Profile], activeProfileId: profile.id }); @@ -39,39 +127,210 @@ describe('desktop profile store', () => { it('encrypts credentials before writing app-owned storage', async () => { const directory = await createDirectory(); + const barrierProof = join(directory, 'writable-file-barrier-proof'); + const barrierBytes = Buffer.from('native writable fsync proof'); + await writeFile(barrierProof, barrierBytes); + await flushFileData(barrierProof); + assert.deepEqual(await readFile(barrierProof), barrierBytes); + const store = new ProfileStore(directory, encryption()); const profile = await store.save({ label: 'Secure', apiBaseUrl: 'https://propr.example.com' }); - assert.deepEqual(await store.writeCredential(profile.id, 'top-secret'), { stored: true }); - assert.deepEqual(await store.readCredential(profile.id), { available: true, value: 'top-secret' }); - const onDisk = await readFile(join(directory, 'desktop', 'credentials', `${profile.id}.bin`), 'utf8'); - assert.equal(onDisk, Buffer.from('top-secret', 'utf8').toString('base64url')); - assert.equal(onDisk.includes('top-secret'), false); - assert.notEqual(onDisk, 'top-secret'); + const storedCredential = credential(profile.id); + assert.deepEqual(await store.writeCredential(storedCredential), { stored: true }); + assert.deepEqual(await store.readCredential(profile.id), storedCredential); + const files = await readdir(join(directory, 'desktop', 'credentials')); + assert.equal(files.length, 1); + const onDisk = await readFile(join(directory, 'desktop', 'credentials', files[0]), 'utf8'); + assert.equal(onDisk.includes(storedCredential.token), false); + }); + + it('atomically refuses activation when the credential origin differs from the profile origin', async () => { + const store = new ProfileStore(await createDirectory(), encryption()); + const profile = await store.save({ + id: 'profile-b', label: 'B', apiBaseUrl: 'https://b.example.test', + }); + const staleCredential = { + ...credential(profile.id), + origin: 'https://a.example.test', + }; + await store.writeCredential(staleCredential); + + const activated = await store.activateProfile( + staleCredential, + (await store.readProfileCredential(profile.id)).identityEpoch!, + profile.apiBaseUrl, + null, + () => true, + ); + + assert.equal(activated, null); + assert.equal((await store.list()).activeProfileId, null); + assert.deepEqual(await store.readCredential(profile.id), staleCredential); }); it('serializes concurrent credential writes with last-write semantics', async () => { const store = new ProfileStore(await createDirectory(), encryption()); - const first = store.writeCredential('profile-1', 'first'); - const second = store.writeCredential('profile-1', 'second'); + const first = store.writeCredential(credential('profile-1', 'A')); + const secondCredential = credential('profile-1', 'B'); + const second = store.writeCredential(secondCredential); assert.deepEqual(await Promise.all([first, second]), [{ stored: true }, { stored: true }]); - assert.deepEqual(await store.readCredential('profile-1'), { available: true, value: 'second' }); + assert.deepEqual(await store.readCredential('profile-1'), secondCredential); }); it('orders concurrent credential writes and removals by invocation', async () => { const store = new ProfileStore(await createDirectory(), encryption()); await Promise.all([ - store.writeCredential('profile-1', 'remove-me'), + store.writeCredential(credential('profile-1')), store.removeCredential('profile-1'), ]); - assert.deepEqual(await store.readCredential('profile-1'), { available: true, value: null }); + assert.equal(await store.readCredential('profile-1'), null); await Promise.all([ store.removeCredential('profile-1'), - store.writeCredential('profile-1', 'keep-me'), + store.writeCredential(credential('profile-1', 'B')), + ]); + assert.deepEqual(await store.readCredential('profile-1'), credential('profile-1', 'B')); + }); + + it('serializes concurrent paired replacements without mixing profile and credential generations', async () => { + const store = new ProfileStore(await createDirectory(), encryption()); + const profile = await store.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + await store.writeCredential(credential(profile.id, 'A')); + const baseline = await store.readProfileCredential(profile.id); + const [first, second] = await Promise.all([ + store.commitPairedProfile( + { id: profile.id, label: 'Replacement B', apiBaseUrl: profile.apiBaseUrl }, + credential(profile.id, 'B'), baseline, () => true, + ), + store.commitPairedProfile( + { id: profile.id, label: 'Replacement C', apiBaseUrl: profile.apiBaseUrl }, + credential(profile.id, 'C'), baseline, () => true, + ), ]); - assert.deepEqual(await store.readCredential('profile-1'), { available: true, value: 'keep-me' }); + assert.equal(first && !('stored' in first) ? first.profile.label : null, 'Replacement B'); + assert.equal(second, null); + assert.equal((await store.list()).profiles[0].label, 'Replacement B'); + assert.deepEqual(await store.readCredential(profile.id), credential(profile.id, 'B')); + }); + + it('commits encrypted pending revocation material atomically with B and unlinks A only after durable completion', async () => { + const directory = await createDirectory(); + const store = new ProfileStore(directory, encryption()); + const profile = await store.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + const credentialA = credential(profile.id, 'A'); + await store.writeCredential(credentialA); + const baseline = await store.readProfileCredential(profile.id); + + const committed = await store.commitPairedProfile( + { id: profile.id, label: 'Replacement', apiBaseUrl: profile.apiBaseUrl }, + credential(profile.id, 'B'), baseline, () => true, + ); + assert.ok(committed && !('stored' in committed)); + if (!committed || 'stored' in committed) return; + assert.notEqual(committed.identityEpoch, baseline.identityEpoch); + + const pending = await store.pendingRevocations(); + assert.equal(pending.length, 1); + assert.deepEqual(pending[0].credential, credentialA); + assert.equal(pending[0].credentialGeneration, baseline.identityEpoch); + assert.notEqual(pending[0].credentialGeneration, committed.identityEpoch); + assert.deepEqual(await store.readCredential(profile.id), credential(profile.id, 'B')); + const desktop = join(directory, 'desktop'); + for (const file of await readdir(desktop)) { + if (!file.startsWith('profiles.')) continue; + const contents = await readFile(join(desktop, file), 'utf8'); + assert.equal(contents.includes(credentialA.token), false); + assert.equal(contents.includes(credential(profile.id, 'B').token), false); + } + assert.equal((await readdir(join(desktop, 'credentials'))).length, 2); + + assert.equal(await store.completePendingRevocation( + pending[0].id, credentialA, pending[0].credentialGeneration, + ), true); + assert.deepEqual(await store.readCredential(profile.id), credential(profile.id, 'B')); + assert.deepEqual(await store.pendingRevocations(), []); + assert.equal((await readdir(join(desktop, 'credentials'))).length, 1); + }); + + it('fails legacy unbound credentials closed while preserving profile metadata', async () => { + const directory = await createDirectory(); + const desktop = join(directory, 'desktop'); + const credentials = join(desktop, 'credentials'); + await mkdir(credentials, { recursive: true }); + const profile = { + id: 'profile-1', label: 'Legacy', apiBaseUrl: 'https://propr.example.com', + createdAt: '2026-08-29T00:00:00.000Z', updatedAt: '2026-08-29T00:00:00.000Z', + }; + await writeFile(join(desktop, 'profiles.json'), JSON.stringify({ + version: 1, activeProfileId: profile.id, profiles: [profile], + })); + const oldCredential = legacyCredential(profile.id, 'A'); + await writeFile(join(credentials, `${profile.id}.bin`), encryption().encrypt(JSON.stringify(oldCredential))); + + const store = new ProfileStore(directory, encryption()); + const migrated = await store.readProfileCredential(profile.id); + assert.deepEqual(migrated, { + profile, credential: null, identityEpoch: null, activeProfileId: null, + }); + const state = JSON.parse(await readFile(join(desktop, 'profiles.json'), 'utf8')) as { + version: number; credentialSlots: Record; + }; + assert.equal(state.version, 3); + assert.deepEqual(state.credentialSlots, {}); + assert.deepEqual(await readdir(credentials), []); + }); + + it('migrates the exact-head numeric unsealed journal only when its valid mirror matches exactly', async () => { + const directory = await createDirectory(); + const desktop = join(directory, 'desktop'); + await mkdir(join(desktop, 'credentials'), { recursive: true }); + const profile = { + id: 'profile-1', label: 'Legacy journal', apiBaseUrl: 'https://propr.example.com', + createdAt: '2026-08-29T00:00:00.000Z', updatedAt: '2026-08-29T00:00:00.000Z', + }; + const state = { + version: 3, generation: 7, activeProfileId: null, profiles: [profile], + credentialSlots: {}, credentialEpochs: {}, pendingRevocations: {}, + }; + const payload = { version: 1, state, encryptedSlots: {} }; + const checksum = createHash('sha256').update(JSON.stringify(payload)).digest('base64url'); + await writeFile(join(desktop, 'profiles.json'), JSON.stringify(state)); + await writeFile(join(desktop, 'profiles.journal.1'), JSON.stringify({ ...payload, checksum })); + + const restarted = new ProfileStore(directory, encryption()); + assert.deepEqual(await restarted.list(), { profiles: [profile], activeProfileId: null }); + const migrated = await readFile(join(desktop, 'profiles.journal.0'), 'utf8'); + assert.equal(migrated.startsWith('C{"version":2'), true); + assert.equal(migrated.includes(profile.label), false); + }); + + it('settles conditional credential removal and profile removal in the former lock-order interleaving', async () => { + const store = new ProfileStore(await createDirectory(), encryption()); + const profile = await store.save({ + id: 'profile-1', label: 'Remote', apiBaseUrl: 'https://propr.example.com', + }); + const storedCredential = credential(profile.id); + await store.writeCredential(storedCredential); + + // Both calls are deliberately made in one turn. Previously the conditional + // removal could own the state queue while remove() owned the credential + // queue and awaited the state operation queued behind it. + const conditional = store.removeCredentialIfCurrent( + storedCredential, + profile.apiBaseUrl, + () => true, + ); + const removal = store.remove(profile.id); + + assert.deepEqual(await bounded(Promise.all([conditional, removal])), [true, undefined]); + assert.deepEqual(await store.list(), { profiles: [], activeProfileId: null }); + assert.equal(await store.readCredential(profile.id), null); }); it('refuses plaintext fallback when encryption is unavailable or basic_text', async () => { @@ -79,11 +338,11 @@ describe('desktop profile store', () => { const directory = await createDirectory(); const store = new ProfileStore(directory, provider); assert.equal(store.security().available, false); - assert.deepEqual(await store.writeCredential('profile-1', 'secret'), { + assert.deepEqual(await store.writeCredential(credential('profile-1')), { stored: false, reason: 'encryption-unavailable', }); - assert.deepEqual(await store.readCredential('profile-1'), { available: false, value: null }); + assert.equal(await store.readCredential('profile-1'), null); } }); @@ -99,8 +358,702 @@ describe('desktop profile store', () => { store.save({ id: profile.id, label: 'Path bearing', apiBaseUrl: 'https://propr.example.com/base' }), /HTTPS/, ); + await assert.rejects( + store.save({ label: 'Encoded Connect', apiBaseUrl: 'https://t-%69nstance123.propr.dev' }), + /HTTPS/, + ); + await assert.rejects( + store.save({ label: 'Port Connect', apiBaseUrl: 'https://t-instance123.propr.dev:443' }), + /HTTPS/, + ); assert.deepEqual((await store.list()).profiles, [profile]); assert.doesNotMatch(await readFile(join(directory, 'desktop', 'profiles.json'), 'utf8'), /\/base/); - await assert.rejects(store.writeCredential('../escape', 'secret'), /Invalid desktop profile id/); + await assert.rejects(store.writeCredential(credential('../escape')), /Invalid desktop profile id/); + }); + + for (const failure of ['corrupt-json', 'decrypt'] as const) { + it(`removes an active profile despite a ${failure} credential failure`, async () => { + const directory = await createDirectory(); + let rejectCredential = false; + const provider: EncryptionProvider = { + ...encryption(), + decrypt: value => { + const plaintext = Buffer.from(value.toString(), 'base64url').toString('utf8'); + if (rejectCredential && plaintext.includes('"token":"propr_it_')) { + if (failure === 'decrypt') throw new Error('keychain decrypt failed'); + return '{not-json'; + } + return plaintext; + }, + }; + const store = new ProfileStore(directory, provider); + const profile = await store.save({ id: 'profile-1', label: 'Remote', apiBaseUrl: 'https://propr.example.com' }); + await store.writeCredential(credential(profile.id)); + await store.setActive(profile.id); + rejectCredential = true; + + const detached = await store.detachProfile(profile.id); + + assert.equal(detached?.profile.id, profile.id); + assert.equal(detached?.credential, null); + assert.deepEqual(await store.list(), { profiles: [], activeProfileId: null }); + assert.equal(await store.readCredential(profile.id), null); + }); + } + + it('preserves the complete profile and credential when state publication fails before commit', async () => { + const directory = await createDirectory(); + let failStateFsync = false; + const store = new ProfileStore(directory, encryption(), { + afterDurabilityStep: step => { + if (failStateFsync && step === 'state-fsynced') throw new Error('injected state fsync failure'); + }, + }); + const profile = await store.save({ id: 'profile-1', label: 'Remote', apiBaseUrl: 'https://propr.example.com' }); + const storedCredential = credential(profile.id); + await store.writeCredential(storedCredential); + await store.setActive(profile.id); + failStateFsync = true; + + await assert.rejects(store.detachProfile(profile.id), /injected state fsync failure/); + failStateFsync = false; + assert.deepEqual(await store.list(), { profiles: [profile], activeProfileId: profile.id }); + assert.deepEqual(await store.readCredential(profile.id), storedCredential); + }); + + it('preserves the complete profile and credential when precommit origin cleanup fails', async () => { + const directory = await createDirectory(); + const store = new ProfileStore(directory, encryption()); + const profile = await store.save({ id: 'profile-1', label: 'Remote', apiBaseUrl: 'https://propr.example.com' }); + const storedCredential = credential(profile.id); + await store.writeCredential(storedCredential); + await store.setActive(profile.id); + + await assert.rejects( + store.detachProfile(profile.id, async origin => { + assert.equal(origin, profile.apiBaseUrl); + throw new Error('origin storage clear failed'); + }), + /origin storage clear failed/, + ); + + assert.deepEqual(await store.list(), { profiles: [profile], activeProfileId: profile.id }); + assert.deepEqual(await store.readCredential(profile.id), storedCredential); + + const observed: string[][] = []; + await assert.rejects(store.saveAndDetachCredential({ + id: profile.id, label: 'Edited', apiBaseUrl: 'https://edited.example.com', + }, async (previousOrigin, nextOrigin) => { + observed.push([previousOrigin, nextOrigin]); + throw new Error('origin edit storage clear failed'); + }), /origin edit storage clear failed/); + assert.deepEqual(observed, [[profile.apiBaseUrl, 'https://edited.example.com']]); + assert.deepEqual(await store.list(), { profiles: [profile], activeProfileId: profile.id }); + assert.deepEqual(await store.readCredential(profile.id), storedCredential); + assert.deepEqual(await store.pendingRevocations(), []); + }); + + it('keeps A authoritative across every injected pre-commit paired replacement failure', async () => { + const directory = await createDirectory(); + let failure: string | null = null; + const store = new ProfileStore(directory, encryption(), { + afterDurabilityStep: step => { + if (step === failure) throw new Error(`injected ${step}`); + }, + }); + const profile = await store.save({ id: 'profile-1', label: 'Remote', apiBaseUrl: 'https://propr.example.com' }); + const credentialA = credential(profile.id, 'A'); + await store.writeCredential(credentialA); + await store.setActive(profile.id); + const baseline = await store.readProfileCredential(profile.id); + for (const step of [ + 'credential-encrypted', 'credential-written', 'credential-fsynced', + 'credential-renamed', + ...(process.platform === 'win32' ? [] : ['credential-directory-fsynced'] as const), + 'state-written', 'state-fsynced', + 'journal-written', 'journal-fsynced', 'journal-closed', 'journal-reopened', + 'journal-prepared-verified', + ]) { + failure = step; + await assert.rejects(store.commitPairedProfile( + { id: profile.id, label: 'Replacement', apiBaseUrl: profile.apiBaseUrl }, + credential(profile.id, 'B'), baseline, () => true, + ), /injected/); + failure = null; + const restarted = new ProfileStore(directory, encryption()); + assert.deepEqual(await restarted.readCredential(profile.id), credentialA, step); + assert.deepEqual(await restarted.list(), { profiles: [profile], activeProfileId: profile.id }, step); + } + }); + + it('fails closed before C and preserves fully verified B when the C flush fails', async () => { + const failures: ProfileStoreIOOperation[] = [ + 'credential-write', 'credential-flush', 'credential-replace', + 'mirror-write', 'mirror-flush', 'metadata-flush', + 'journal-write', 'journal-flush', 'journal-reopen', 'journal-verify', 'journal-commit', + ]; + let completedFailures = 0; + for (const operation of failures) { + const directory = await createDirectory(); + let injected: ProfileStoreIOOperation | null = null; + let published = false; + const store = new ProfileStore(directory, encryption(), { + beforeIO: current => { + if (current === injected) throw new Error(`injected ${current} failure`); + }, + }); + const profile = await store.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + const credentialA = credential(profile.id, 'A'); + await store.writeCredential(credentialA); + await store.setActive(profile.id); + const baseline = await store.readProfileCredential(profile.id); + injected = operation; + await assert.rejects(store.commitPairedProfile( + { id: profile.id, label: 'Replacement', apiBaseUrl: profile.apiBaseUrl }, + credential(profile.id, 'B'), baseline, () => true, undefined, () => { published = true; }, + ), /injected/); + injected = null; + assert.equal(published, false, operation); + const restarted = new ProfileStore(directory, encryption()); + assert.equal((await restarted.list()).profiles[0].label, 'Original', operation); + assert.deepEqual(await restarted.readCredential(profile.id), credentialA, operation); + assert.deepEqual(await restarted.pendingRevocations(), [], operation); + completedFailures += 1; + } + + const directory = await createDirectory(); + let injected: ProfileStoreIOOperation | null = null; + let published = false; + const store = new ProfileStore(directory, encryption(), { + beforeIO: current => { + if (current === injected) throw new Error(`injected ${current} failure`); + }, + }); + const profile = await store.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + await store.writeCredential(credential(profile.id, 'A')); + const baseline = await store.readProfileCredential(profile.id); + injected = 'journal-commit-flush'; + await assert.rejects(store.commitPairedProfile( + { id: profile.id, label: 'Replacement', apiBaseUrl: profile.apiBaseUrl }, + credential(profile.id, 'B'), baseline, () => true, undefined, () => { published = true; }, + ), /injected journal-commit-flush/); + injected = null; + assert.equal(published, true); + const restarted = new ProfileStore(directory, encryption()); + assert.equal((await restarted.list()).profiles[0].label, 'Replacement'); + assert.deepEqual(await restarted.readCredential(profile.id), credential(profile.id, 'B')); + assert.equal((await restarted.pendingRevocations()).length, 1); + completedFailures += 1; + + const corruptDirectory = await createDirectory(); + const corruptDesktop = join(corruptDirectory, 'desktop'); + let corruptPrepared = false; + const corruptingStore = new ProfileStore(corruptDirectory, encryption(), { + afterDurabilityStep: async step => { + if (!corruptPrepared || step !== 'journal-closed') return; + corruptPrepared = false; + for (const name of ['profiles.journal.0', 'profiles.journal.1']) { + const path = join(corruptDesktop, name); + try { + const bytes = await readFile(path); + if (bytes[0] !== 'P'.charCodeAt(0)) continue; + bytes[Math.min(20, bytes.length - 1)] ^= 1; + await writeFile(path, bytes); + return; + } catch (error) { + if ((error as NodeJS.ErrnoException).code !== 'ENOENT') throw error; + } + } + throw new Error('prepared journal was not found'); + }, + }); + const corruptProfile = await corruptingStore.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + const corruptA = credential(corruptProfile.id, 'A'); + await corruptingStore.writeCredential(corruptA); + const corruptBaseline = await corruptingStore.readProfileCredential(corruptProfile.id); + corruptPrepared = true; + await assert.rejects(corruptingStore.commitPairedProfile( + { id: corruptProfile.id, label: 'Replacement', apiBaseUrl: corruptProfile.apiBaseUrl }, + credential(corruptProfile.id, 'B'), corruptBaseline, () => true, + ), /Desktop profile recovery state is unavailable/); + const corruptRestart = new ProfileStore(corruptDirectory, encryption()); + assert.equal((await corruptRestart.list()).profiles[0].label, 'Original'); + assert.deepEqual(await corruptRestart.readCredential(corruptProfile.id), corruptA); + completedFailures += 1; + console.log(`NATIVE_CATEGORY barriers expected=${failures.length + 2} executed=${completedFailures}`); + }); + + it('treats mirror replace and directory-flush failures after the journal commit as recoverable mirror failures', async () => { + for (const operation of ['mirror-replace', 'metadata-flush'] as const) { + const directory = await createDirectory(); + let injected: ProfileStoreIOOperation | null = null; + let journalCommitted = false; + const store = new ProfileStore(directory, encryption(), { + afterDurabilityStep: step => { if (step === 'journal-commit-fsynced') journalCommitted = true; }, + beforeIO: current => { + if (journalCommitted && current === injected) throw new Error(`injected ${current} failure`); + }, + }); + const profile = await store.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + await store.writeCredential(credential(profile.id, 'A')); + const baseline = await store.readProfileCredential(profile.id); + journalCommitted = false; + injected = operation; + const result = await store.commitPairedProfile( + { id: profile.id, label: 'Replacement', apiBaseUrl: profile.apiBaseUrl }, + credential(profile.id, 'B'), baseline, () => true, + ); + assert.ok(result && !('stored' in result), operation); + injected = null; + const restarted = new ProfileStore(directory, encryption()); + assert.equal((await restarted.list()).profiles[0].label, 'Replacement', operation); + assert.deepEqual(await restarted.readCredential(profile.id), credential(profile.id, 'B'), operation); + } + }); + + it('recovers real process crashes as complete A before the pointer commit and complete B after it', async () => { + const steps: ProfileStoreDurabilityStep[] = [ + 'credential-encrypted', 'credential-written', 'credential-fsynced', 'credential-renamed', + ...(process.platform === 'win32' ? [] : ['credential-directory-fsynced'] as const), + 'state-written', 'state-fsynced', 'journal-written', 'journal-fsynced', + 'journal-closed', 'journal-reopened', 'journal-prepared-verified', + 'journal-committed', 'journal-commit-fsynced', 'journal-commit-verified', + 'journal-commit-closed', 'state-renamed', + ...(process.platform === 'win32' ? [] : ['state-directory-fsynced'] as const), + ]; + assert.equal(steps.length, process.platform === 'win32' ? 16 : 18); + let completed = 0; + for (const step of steps) { + const directory = await createDirectory(); + const setup = new ProfileStore(directory, encryption()); + const profileA = await setup.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + const credentialA = credential(profileA.id, 'A'); + await setup.writeCredential(credentialA); + const child = spawn(process.execPath, [ + '--import', 'tsx', join(import.meta.dirname, 'profile-store-crash-fixture.ts'), directory, step, + ], { stdio: 'ignore' }); + const result = await new Promise<{ code: number | null; signal: NodeJS.Signals | null }>(resolve => { + child.once('exit', (code, signal) => resolve({ code, signal })); + }); + assert.equal( + result.signal === 'SIGKILL' || (process.platform === 'win32' && result.code !== 0), + true, + `${step}: child did not crash at the requested boundary`, + ); + + const restarted = new ProfileStore(directory, encryption()); + const snapshot = await restarted.readProfileCredential(profileA.id); + const committed = step === 'journal-committed' + || step === 'journal-commit-fsynced' + || step === 'journal-commit-verified' + || step === 'journal-commit-closed' + || step === 'state-renamed' + || step === 'state-directory-fsynced'; + assert.equal(snapshot.profile?.label, committed ? 'Replacement' : 'Original', step); + assert.deepEqual(snapshot.credential, credential(profileA.id, committed ? 'B' : 'A'), step); + assert.equal((await restarted.pendingRevocations()).length, committed ? 1 : 0, step); + const files = await readdir(join(directory, 'desktop', 'credentials')); + assert.equal(files.length, committed ? 2 : 1, `${step}: recovery did not retain exactly the authoritative and pending slots`); + const desktopFiles = await readdir(join(directory, 'desktop')); + assert.equal(desktopFiles.some(file => file.endsWith('.tmp')), false, `${step}: recovery left staging files`); + completed += 1; + } + assert.equal(completed, steps.length, 'a native durability boundary fixture was skipped'); + console.log(`NATIVE_CATEGORY transaction-boundaries expected=${steps.length} executed=${completed}`); + }); + + it('recovers profile deletion crashes as active A or detached pending A at the journal commit', async () => { + const steps = RECOVERY_KILL_STEPS; + let completed = 0; + for (const step of steps) { + const directory = await createDirectory(); + const setup = new ProfileStore(directory, encryption()); + const profile = await setup.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + const credentialA = credential(profile.id, 'A'); + await setup.writeCredential(credentialA); + await setup.setActive(profile.id); + const child = spawn(process.execPath, [ + '--import', 'tsx', join(import.meta.dirname, 'profile-store-crash-fixture.ts'), + directory, `detach:${step}`, + ], { stdio: 'ignore' }); + const result = await new Promise<{ code: number | null; signal: NodeJS.Signals | null }>(resolve => { + child.once('exit', (code, signal) => resolve({ code, signal })); + }); + assert.equal( + result.signal === 'SIGKILL' || (process.platform === 'win32' && result.code !== 0), + true, + `${step}: detach child did not crash at the requested boundary`, + ); + const committed = step === 'journal-committed' + || step === 'journal-commit-fsynced' + || step === 'journal-commit-verified' + || step === 'journal-commit-closed' + || step === 'state-renamed' + || step === 'state-directory-fsynced'; + const restarted = new ProfileStore(directory, encryption()); + const snapshot = await restarted.readProfileCredential(profile.id); + assert.equal(snapshot.profile?.id ?? null, committed ? null : profile.id, step); + assert.deepEqual(snapshot.credential, committed ? null : credentialA, step); + const pending = await restarted.pendingRevocations(); + assert.equal(pending.length, committed ? 1 : 0, step); + if (committed) assert.deepEqual(pending[0].credential, credentialA, step); + console.log('NATIVE_SCENARIO detach-crash'); + completed += 1; + } + assert.equal(completed, steps.length); + }); + + it('recovers every first bootstrap and v1/v2 migration child-process kill without activating prepared B', async () => { + let completed = 0; + for (const mode of RECOVERY_KILL_MODES) { + for (const step of RECOVERY_KILL_STEPS) { + const directory = await createDirectory(); + await seedRecoveryMode(directory, mode); + const child = spawn(process.execPath, [ + '--import', 'tsx', join(import.meta.dirname, 'profile-store-crash-fixture.ts'), + directory, `recovery:${mode}:${step}`, + ], { stdio: 'ignore' }); + const result = await new Promise<{ code: number | null; signal: NodeJS.Signals | null }>(resolve => { + child.once('exit', (code, signal) => resolve({ code, signal })); + }); + assert.equal( + result.signal === 'SIGKILL' || (process.platform === 'win32' && result.code !== 0), + true, + `${mode}/${step}: child did not crash at the requested boundary`, + ); + + const desktop = join(directory, 'desktop'); + const committed = step === 'journal-committed' + || step === 'journal-commit-fsynced' + || step === 'journal-commit-verified' + || step === 'journal-commit-closed' + || step === 'state-renamed' + || step === 'state-directory-fsynced'; + const journals = await Promise.all([0, 1].map(async index => { + try { return await readFile(join(desktop, `profiles.journal.${index}`), 'utf8'); } catch { return null; } + })); + if (committed) assert.equal(journals.some(value => value?.startsWith('C')), true, `${mode}/${step}`); + else assert.equal(journals.some(value => value?.startsWith('C')), false, `${mode}/${step}`); + + for (let restart = 0; restart < 3; restart += 1) { + const recovered = new ProfileStore(directory, encryption()); + if (mode === 'bootstrap') { + assert.deepEqual(await recovered.list(), { profiles: [], activeProfileId: null }, `${mode}/${step}/${restart}`); + } else { + const snapshot = await recovered.readProfileCredential(legacyProfile.id); + assert.deepEqual(snapshot.profile, legacyProfile, `${mode}/${step}/${restart}`); + assert.equal(snapshot.credential, null, `${mode}/${step}/${restart}`); + assert.equal(snapshot.activeProfileId, null, `${mode}/${step}/${restart}`); + assert.equal(snapshot.identityEpoch, null, `${mode}/${step}/${restart}`); + } + const state = JSON.parse(await readFile(join(desktop, 'profiles.json'), 'utf8')) as { version: number }; + assert.equal(state.version, 3, `${mode}/${step}/${restart}`); + } + completed += 1; + } + } + assert.equal(completed, RECOVERY_KILL_MODES.length * RECOVERY_KILL_STEPS.length); + console.log(`NATIVE_CATEGORY bootstrap-migration expected=${completed} executed=${completed}`); + }); + + it('binds verified prepared bytes to one handle across same-size swaps and path-restoration ABA', async () => { + let completed = 0; + for (const restoreOriginalPath of [false, true]) { + const directory = await createDirectory(); + const desktop = join(directory, 'desktop'); + let swapPrepared = false; + let attackerPath = ''; + const store = new ProfileStore(directory, encryption(), { + afterDurabilityStep: async step => { + if (!swapPrepared || step !== 'journal-prepared-verified') return; + swapPrepared = false; + const state = JSON.parse(await readFile(join(desktop, 'profiles.json'), 'utf8')) as { generation: string }; + const preparedPath = join(desktop, `profiles.journal.${Number((BigInt(state.generation) + 1n) % 2n)}`); + const preparedContents = await readFile(preparedPath, 'utf8'); + assert.equal(preparedContents[0], 'P'); + const envelope = JSON.parse(preparedContents.slice(1)) as { + version: 2; generation: string; encryptedPayload: string; checksum: string; + }; + const payload = JSON.parse(encryption().decrypt(Buffer.from(envelope.encryptedPayload, 'base64url'))) as { + state: { profiles: Array<{ label: string }>; credentialSlots: Record }; + encryptedSlots: Record; + }; + payload.state.profiles[0].label = 'Attacker!!!'; + const slot = payload.state.credentialSlots['profile-1']; + const attackerCredential = JSON.parse( + encryption().decrypt(Buffer.from(payload.encryptedSlots[slot], 'base64url')), + ) as ReturnType; + attackerCredential.token = `propr_it_${'X'.repeat(43)}`; + payload.encryptedSlots[slot] = encryption().encrypt(JSON.stringify(attackerCredential)).toString('base64url'); + const encryptedPayload = encryption().encrypt(JSON.stringify(payload)).toString('base64url'); + const attackerContents = `P${JSON.stringify({ + ...envelope, + encryptedPayload, + checksum: createHash('sha256').update(encryptedPayload).digest('base64url'), + })}\n`; + assert.equal(Buffer.byteLength(attackerContents), Buffer.byteLength(preparedContents)); + const heldPath = `${preparedPath}.held`; + attackerPath = restoreOriginalPath ? `${preparedPath}.attacker` : preparedPath; + await rename(preparedPath, heldPath); + await writeFile(preparedPath, attackerContents, { mode: 0o600 }); + if (restoreOriginalPath) { + await rename(preparedPath, attackerPath); + await rename(heldPath, preparedPath); + } + }, + }); + const profile = await store.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + const credentialA = credential(profile.id, 'A'); + await store.writeCredential(credentialA); + const baseline = await store.readProfileCredential(profile.id); + swapPrepared = true; + const transaction = store.commitPairedProfile( + { id: profile.id, label: 'Replacement', apiBaseUrl: profile.apiBaseUrl }, + credential(profile.id, 'B'), baseline, () => true, + ); + if (restoreOriginalPath) { + const committed = await transaction; + assert.ok(committed && !('stored' in committed)); + } else { + await assert.rejects(transaction, /Desktop profile recovery state is unavailable/); + } + assert.equal((await readFile(attackerPath, 'utf8')).startsWith('P'), true); + + const restarted = new ProfileStore(directory, encryption()); + const snapshot = await restarted.readProfileCredential(profile.id); + assert.equal(snapshot.profile?.label, restoreOriginalPath ? 'Replacement' : 'Original'); + assert.deepEqual(snapshot.credential, credential(profile.id, restoreOriginalPath ? 'B' : 'A')); + assert.notEqual(snapshot.profile?.label, 'Attacker!!!'); + assert.notDeepEqual(snapshot.credential, credential(profile.id, 'X')); + completed += 1; + } + assert.equal(completed, 2); + console.log(`NATIVE_CATEGORY verified-handle-swap expected=2 executed=${completed}`); + }); + + for (const visibility of ['pointer-rollback', 'missing-target', 'state-before-journal'] as const) { + it(`recovers a ${visibility} durability view as complete A or complete B`, async () => { + const directory = await createDirectory(); + const desktop = join(directory, 'desktop'); + const credentialsDirectory = join(desktop, 'credentials'); + const store = new ProfileStore(directory, encryption()); + const profileA = await store.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + const credentialA = credential(profileA.id, 'A'); + await store.writeCredential(credentialA); + const stateA = await readFile(join(desktop, 'profiles.json')); + const journalsA = await Promise.all([0, 1].map(async index => { + try { return await readFile(join(desktop, `profiles.journal.${index}`)); } catch { return null; } + })); + const baseline = await store.readProfileCredential(profileA.id); + await store.commitPairedProfile( + { id: profileA.id, label: 'Replacement', apiBaseUrl: profileA.apiBaseUrl }, + credential(profileA.id, 'B'), baseline, () => true, + ); + const stateB = JSON.parse(await readFile(join(desktop, 'profiles.json'), 'utf8')) as { + credentialSlots: Record; + }; + + if (visibility === 'pointer-rollback') { + await writeFile(join(desktop, 'profiles.json'), stateA); + } else if (visibility === 'missing-target') { + await unlink(join(credentialsDirectory, stateB.credentialSlots[profileA.id])); + } else { + for (const [index, bytes] of journalsA.entries()) { + const path = join(desktop, `profiles.journal.${index}`); + if (bytes) await writeFile(path, bytes); + else await unlink(path).catch(() => undefined); + } + } + + const restarted = new ProfileStore(directory, encryption()); + const recovered = await restarted.readProfileCredential(profileA.id); + const expectsB = visibility !== 'state-before-journal'; + assert.equal(recovered.profile?.label, expectsB ? 'Replacement' : 'Original'); + assert.deepEqual(recovered.credential, credential(profileA.id, expectsB ? 'B' : 'A')); + const activeSlotFiles = (await readdir(credentialsDirectory)).filter(file => file.endsWith('.bin')); + assert.equal(activeSlotFiles.length, expectsB ? 2 : 1); + }); + } + + for (const mirrorView of [ + 'missing', 'truncated', 'malformed', 'stale', 'schema-invalid', 'attacker-modified', + ] as const) { + it(`recovers the authoritative encrypted journal before a ${mirrorView} mirror`, async () => { + const directory = await createDirectory(); + const desktop = join(directory, 'desktop'); + const mirror = join(desktop, 'profiles.json'); + const store = new ProfileStore(directory, encryption()); + const profile = await store.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + await store.writeCredential(credential(profile.id, 'A')); + const stale = await readFile(mirror); + const baseline = await store.readProfileCredential(profile.id); + await store.commitPairedProfile( + { id: profile.id, label: 'Replacement', apiBaseUrl: profile.apiBaseUrl }, + credential(profile.id, 'B'), baseline, () => true, + ); + const current = JSON.parse(await readFile(mirror, 'utf8')) as Record; + if (mirrorView === 'missing') await unlink(mirror); + else if (mirrorView === 'truncated') await writeFile(mirror, '{"version":3'); + else if (mirrorView === 'malformed') await writeFile(mirror, 'not-json'); + else if (mirrorView === 'stale') await writeFile(mirror, stale); + else if (mirrorView === 'schema-invalid') { + await writeFile(mirror, JSON.stringify({ + ...current, version: 99, + })); + } else { + const profiles = current.profiles as Array>; + await writeFile(mirror, JSON.stringify({ + ...current, + profiles: profiles.map(value => ({ ...value, label: 'Attacker' })), + })); + } + + const restarted = new ProfileStore(directory, encryption()); + assert.equal((await restarted.list()).profiles[0].label, 'Replacement', mirrorView); + assert.deepEqual(await restarted.readCredential(profile.id), credential(profile.id, 'B'), mirrorView); + assert.equal((await restarted.pendingRevocations()).length, 1, mirrorView); + assert.equal((await readFile(mirror, 'utf8')).includes('Attacker'), false, mirrorView); + console.log('NATIVE_SCENARIO mirror-repair'); + }); + } + + it('fails with one fixed redacted error when neither mirror nor journal authenticates', async () => { + const directory = await createDirectory(); + const desktop = join(directory, 'desktop'); + const store = new ProfileStore(directory, encryption()); + const profile = await store.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + await store.writeCredential(credential(profile.id, 'A')); + for (const name of ['profiles.journal.0', 'profiles.journal.1']) { + const path = join(desktop, name); + try { + const bytes = await readFile(path); + if (bytes[0] === 'C'.charCodeAt(0)) bytes[Math.min(20, bytes.length - 1)] ^= 1; + await writeFile(path, bytes); + } catch (error) { + if ((error as NodeJS.ErrnoException).code !== 'ENOENT') throw error; + } + } + await assert.rejects( + new ProfileStore(directory, encryption()).list(), + error => (error as Error).message === 'Desktop profile recovery state is unavailable', + ); + await writeFile(join(desktop, 'profiles.json'), '{attacker'); + const restarted = new ProfileStore(directory, encryption()); + await assert.rejects(restarted.list(), error => { + assert.equal((error as Error).message, 'Desktop profile recovery state is unavailable'); + assert.equal((error as Error).message.includes(profile.id), false); + return true; + }); + + const ioDirectory = await createDirectory(); + const ioStore = new ProfileStore(ioDirectory, encryption()); + await ioStore.save({ + id: 'profile-io', label: 'I/O failure', apiBaseUrl: 'https://propr.example.com', + }); + const ioMirror = join(ioDirectory, 'desktop', 'profiles.json'); + await unlink(ioMirror); + await mkdir(ioMirror); + await assert.rejects(new ProfileStore(ioDirectory, encryption()).list(), error => { + assert.equal((error as Error).message, 'Desktop profile recovery state is unavailable'); + assert.equal((error as Error).message.includes('EISDIR'), false); + assert.equal((error as Error).message.includes(ioMirror), false); + return true; + }); + }); + + it('selects a lossless newest valid generation and survives alternate-slot rollback', async () => { + const directory = await createDirectory(); + const desktop = join(directory, 'desktop'); + const store = new ProfileStore(directory, encryption()); + const profile = await store.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + await store.writeCredential(credential(profile.id, 'A')); + const baseline = await store.readProfileCredential(profile.id); + await store.commitPairedProfile( + { id: profile.id, label: 'Replacement', apiBaseUrl: profile.apiBaseUrl }, + credential(profile.id, 'B'), baseline, () => true, + ); + const mirror = JSON.parse(await readFile(join(desktop, 'profiles.json'), 'utf8')) as { generation: string }; + const newest = Number(BigInt(mirror.generation) % 2n); + const older = (newest + 1) % 2; + await writeFile( + join(desktop, `profiles.journal.${newest}`), + await readFile(join(desktop, `profiles.journal.${older}`)), + ); + const restarted = new ProfileStore(directory, encryption()); + const recovered = await restarted.readProfileCredential(profile.id); + assert.equal(recovered.profile?.label, 'Original'); + assert.deepEqual(recovered.credential, credential(profile.id, 'A')); + }); + + it('runs every native child-termination visibility fixture with an explicit scenario count', async () => { + assert.equal(NATIVE_VISIBILITY_SCENARIOS.length, 11); + if (process.env.PROPR_NATIVE_WINDOWS_DURABILITY_REQUIRED === '1') { + assert.equal(process.platform, 'win32', 'native Windows durability cannot run on a non-Windows host'); + assert.equal(process.arch, 'x64', 'native Windows durability must execute x64 production Node'); + } + let completed = 0; + for (const visibility of NATIVE_VISIBILITY_SCENARIOS) { + const directory = await createDirectory(); + const setup = new ProfileStore(directory, encryption()); + const profileA = await setup.save({ + id: 'profile-1', label: 'Original', apiBaseUrl: 'https://propr.example.com', + }); + await setup.writeCredential(credential(profileA.id, 'A')); + const child = spawn(process.execPath, [ + '--import', 'tsx', join(import.meta.dirname, 'profile-store-crash-fixture.ts'), + directory, `visibility:${visibility}`, + ], { stdio: 'ignore' }); + const result = await new Promise<{ code: number | null; signal: NodeJS.Signals | null }>(resolve => { + child.once('exit', (code, signal) => resolve({ code, signal })); + }); + assert.equal(result.code === 0, false, `${visibility}: Windows child did not terminate`); + + const restarted = new ProfileStore(directory, encryption()); + const snapshot = await restarted.readProfileCredential(profileA.id); + const expectsB = visibility !== 'state-before-journal' && visibility !== 'alternate-slot-rollback'; + assert.equal(snapshot.profile?.label, expectsB ? 'Replacement' : 'Original', visibility); + assert.deepEqual(snapshot.credential, credential(profileA.id, expectsB ? 'B' : 'A'), visibility); + assert.equal((await restarted.pendingRevocations()).length, expectsB ? 1 : 0, visibility); + completed += 1; + } + assert.equal(completed, NATIVE_VISIBILITY_SCENARIOS.length, 'a native visibility fixture was skipped'); + console.log( + `NATIVE_CATEGORY reordered-visibility expected=${NATIVE_VISIBILITY_SCENARIOS.length} executed=${completed}`, + ); + }); + + it('removes an orphan credential before allowing same-ID recreation', async () => { + const directory = await createDirectory(); + const store = new ProfileStore(directory, encryption()); + await store.writeCredential(credential('profile-1')); + + assert.equal(await store.detachProfile('profile-1'), null); + const recreated = await store.save({ id: 'profile-1', label: 'Recreated', apiBaseUrl: 'https://propr.example.com' }); + + assert.equal(recreated.id, 'profile-1'); + assert.equal(await store.readCredential('profile-1'), null); }); + }); diff --git a/apps/desktop/src/profile-store.ts b/apps/desktop/src/profile-store.ts index 4115c1f92..c76f0916b 100644 --- a/apps/desktop/src/profile-store.ts +++ b/apps/desktop/src/profile-store.ts @@ -1,9 +1,21 @@ -import { randomUUID } from 'node:crypto'; -import { chmod, mkdir, readFile, rename, unlink, writeFile } from 'node:fs/promises'; +import { createHash, randomBytes, randomUUID } from 'node:crypto'; +import { constants } from 'node:fs'; +import { + chmod, + lstat, + mkdir, + open, + readFile, + readdir, + rename, + stat, + unlink, + writeFile, + type FileHandle, +} from 'node:fs/promises'; import { join } from 'node:path'; +import { isPublicInstanceIdentity } from '@propr/shared'; import type { - CredentialReadResult, - CredentialWriteResult, DesktopProfile, DesktopProfileInput, DesktopProfileList, @@ -14,10 +26,98 @@ import { normalizeApiBaseUrl } from './security'; const PROFILE_ID_PATTERN = /^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$/; const MAX_CREDENTIAL_LENGTH = 65_536; -interface PersistedState { +export interface StoredCredential { + version: 2; + profileId: string; + origin: string; + publicInstanceIdentity: string; + token: string; +} + +export interface DetachedProfile { + profile: DesktopProfile; + credential: StoredCredential | null; +} + +export interface SavedProfileTransaction { + profile: DesktopProfile; + detachedCredential: StoredCredential | null; + originChanged: boolean; +} + +export interface PairedProfileTransaction { + profile: DesktopProfile; + identityEpoch: string; + originChanged: boolean; +} + +export interface ProfileCredentialSnapshot { + profile: DesktopProfile | null; + credential: StoredCredential | null; + identityEpoch: string | null; + activeProfileId: string | null; +} + +interface LegacyPersistedState { + version: 1; + activeProfileId: string | null; + profiles: DesktopProfile[]; +} + +interface VersionTwoPersistedState { + version: 2; + activeProfileId: string | null; + profiles: DesktopProfile[]; + credentialSlots: Record; +} + +interface PendingRevocationRecord { version: 1; + profileId: string; + origin: string; + slot: string; + credentialGeneration: string; + deferred: boolean; +} + +interface PersistedState { + version: 3; + generation: string; activeProfileId: string | null; profiles: DesktopProfile[]; + credentialSlots: Record; + credentialEpochs: Record; + pendingRevocations: Record; +} + +interface JournalPayload { + version: 1; + state: PersistedState; + encryptedSlots: Record; +} + +interface LegacyJournalRecord extends JournalPayload { + checksum: string; +} + +interface JournalRecord { + version: 2; + generation: string; + encryptedPayload: string; + checksum: string; +} + +interface AuthenticatedJournal { + generation: bigint; + state: PersistedState; + encryptedSlots: Record; +} + +export interface PendingCredentialRevocation { + id: string; + credential: StoredCredential; + credentialGeneration: string; + deferred: boolean; } export interface EncryptionProvider { @@ -27,12 +127,77 @@ export interface EncryptionProvider { decrypt(value: Buffer): string; } +export type ProfileStoreDurabilityStep = + | 'credential-encrypted' + | 'credential-written' + | 'credential-fsynced' + | 'credential-renamed' + | 'credential-directory-fsynced' + | 'state-written' + | 'state-fsynced' + | 'journal-written' + | 'journal-fsynced' + | 'journal-closed' + | 'journal-reopened' + | 'journal-prepared-verified' + | 'journal-committed' + | 'journal-commit-fsynced' + | 'journal-commit-verified' + | 'journal-commit-closed' + | 'state-renamed' + | 'state-directory-fsynced' + | 'old-credential-removed'; + +export interface ProfileStoreOptions { + afterDurabilityStep?(step: ProfileStoreDurabilityStep): void | Promise; + beforeIO?(operation: ProfileStoreIOOperation): void | Promise; +} + +export type ProfileStoreIOOperation = + | 'credential-write' + | 'credential-flush' + | 'credential-replace' + | 'journal-write' + | 'journal-flush' + | 'journal-reopen' + | 'journal-commit' + | 'journal-commit-flush' + | 'journal-verify' + | 'mirror-write' + | 'mirror-flush' + | 'mirror-replace' + | 'metadata-flush'; + const emptyState = (): PersistedState => ({ - version: 1, + version: 3, + generation: '0', activeProfileId: null, profiles: [], + credentialSlots: {}, + credentialEpochs: {}, + pendingRevocations: {}, }); +const SLOT_PATTERN = /^([a-zA-Z0-9][a-zA-Z0-9_-]{0,63})\.[0-9a-f-]{36}\.bin$/i; +const IDENTITY_EPOCH_PATTERN = /^[A-Za-z0-9_-]{22}$/; +const MAX_PENDING_REVOCATIONS = 64; +const MAX_JOURNAL_BYTES = (MAX_PENDING_REVOCATIONS + 1) * (MAX_CREDENTIAL_LENGTH * 2 + 4_096); +const RECOVERY_ERROR = 'Desktop profile recovery state is unavailable'; + +/** + * Flush an existing file through a writable handle. Windows rejects fsync on + * the read-only handle Node creates for `open(path, 'r')`; O_WRONLY is the + * minimum access libuv needs for FlushFileBuffers and works on POSIX too. + */ +export const flushFileData = async (path: string): Promise => { + const handle = await open(path, constants.O_WRONLY); + try { + await handle.sync(); + } finally { + await handle.close(); + } +}; + const validDate = (value: unknown): value is string => typeof value === 'string' && !Number.isNaN(Date.parse(value)); @@ -50,11 +215,23 @@ const validProfile = (value: unknown): value is DesktopProfile => { && validDate(profile.updatedAt); }; -const parseState = (contents: string): PersistedState => { +const validCredentialSlots = (value: unknown): value is Record => { + if (!value || typeof value !== 'object' || Array.isArray(value)) return false; + const slots = new Set(); + for (const [profileId, slot] of Object.entries(value as Record)) { + if (!PROFILE_ID_PATTERN.test(profileId) || typeof slot !== 'string' + || SLOT_PATTERN.exec(slot)?.[1] !== profileId || slots.has(slot)) return false; + slots.add(slot); + } + return true; +}; + +const parseState = (contents: string): PersistedState | VersionTwoPersistedState | LegacyPersistedState => { const value = JSON.parse(contents) as unknown; if (!value || typeof value !== 'object') throw new Error('Desktop profile store is invalid'); const state = value as Record; - if (state.version !== 1 || !Array.isArray(state.profiles) || !state.profiles.every(validProfile)) { + if ((state.version !== 1 && state.version !== 2 && state.version !== 3) + || !Array.isArray(state.profiles) || !state.profiles.every(validProfile)) { throw new Error('Desktop profile store is invalid'); } if (state.activeProfileId !== null && ( @@ -63,7 +240,96 @@ const parseState = (contents: string): PersistedState => { )) { throw new Error('Desktop active profile is invalid'); } - return state as unknown as PersistedState; + if (state.version === 2 && !validCredentialSlots(state.credentialSlots)) { + throw new Error('Desktop credential state is invalid'); + } + if (state.version === 3) { + if (!((typeof state.generation === 'string' && /^(?:0|[1-9][0-9]{0,30})$/.test(state.generation)) + || (Number.isSafeInteger(state.generation) && (state.generation as number) >= 0)) + || !validCredentialSlots(state.credentialSlots) + || !state.credentialEpochs || typeof state.credentialEpochs !== 'object' + || Array.isArray(state.credentialEpochs) + || !state.pendingRevocations || typeof state.pendingRevocations !== 'object' + || Array.isArray(state.pendingRevocations)) throw new Error('Desktop credential state is invalid'); + const slots = state.credentialSlots as Record; + const epochs = state.credentialEpochs as Record; + if (Object.keys(slots).length !== Object.keys(epochs).length + || Object.entries(epochs).some(([profileId, epoch]) => !(profileId in slots) + || typeof epoch !== 'string' || !IDENTITY_EPOCH_PATTERN.test(epoch))) { + throw new Error('Desktop credential identity state is invalid'); + } + const pending = Object.entries(state.pendingRevocations as Record); + if (pending.length > MAX_PENDING_REVOCATIONS) throw new Error('Desktop revocation state is invalid'); + const pendingSlots = new Set(); + for (const [id, raw] of pending) { + if (!/^[0-9a-f-]{36}$/i.test(id) || !raw || typeof raw !== 'object' || Array.isArray(raw)) { + throw new Error('Desktop revocation state is invalid'); + } + const record = raw as Record; + if (record.credentialGeneration === undefined && typeof record.slot === 'string') { + record.credentialGeneration = createHash('sha256') + .update(record.slot) + .digest() + .subarray(0, 16) + .toString('base64url'); + } + if (record.deferred === undefined) record.deferred = false; + if (record.version !== 1 || typeof record.profileId !== 'string' + || !PROFILE_ID_PATTERN.test(record.profileId) || typeof record.origin !== 'string' + || normalizeApiBaseUrl(record.origin) !== record.origin || typeof record.slot !== 'string' + || typeof record.credentialGeneration !== 'string' + || !IDENTITY_EPOCH_PATTERN.test(record.credentialGeneration) + || typeof record.deferred !== 'boolean' + || SLOT_PATTERN.exec(record.slot)?.[1] !== record.profileId + || Object.values(slots).includes(record.slot) || pendingSlots.has(record.slot)) { + throw new Error('Desktop revocation state is invalid'); + } + pendingSlots.add(record.slot); + } + state.generation = String(state.generation); + } + return state as unknown as PersistedState | VersionTwoPersistedState | LegacyPersistedState; +}; + +const journalChecksum = (value: string | Buffer): string => + createHash('sha256').update(value).digest('base64url'); + +const parseLegacyJournal = (contents: string): LegacyJournalRecord => { + const value = JSON.parse(contents) as unknown; + if (!value || typeof value !== 'object') throw new Error('Desktop transaction journal is invalid'); + const record = value as LegacyJournalRecord; + const rawPayload = { version: 1 as const, state: record.state, encryptedSlots: record.encryptedSlots }; + if (record.checksum !== journalChecksum(JSON.stringify(rawPayload))) { + throw new Error('Desktop transaction journal checksum failed'); + } + const state = parseState(JSON.stringify(record.state)); + if (record.version !== 1 || state.version !== 3 || !record.encryptedSlots + || typeof record.encryptedSlots !== 'object' || Array.isArray(record.encryptedSlots) + || Object.entries(record.encryptedSlots).some(([slot, bytes]) => !SLOT_PATTERN.test(slot) + || typeof bytes !== 'string' || !/^[A-Za-z0-9_-]*$/.test(bytes))) { + throw new Error('Desktop transaction journal is invalid'); + } + const payload: JournalPayload = { version: 1, state, encryptedSlots: record.encryptedSlots }; + return { ...payload, checksum: record.checksum }; +}; + +const parseJournalEnvelope = (contents: string): JournalRecord => { + if (Buffer.byteLength(contents) > MAX_JOURNAL_BYTES) throw new Error('Desktop transaction journal is invalid'); + const value = JSON.parse(contents) as unknown; + if (!value || typeof value !== 'object' || Array.isArray(value)) { + throw new Error('Desktop transaction journal is invalid'); + } + const record = value as Record; + if (record.version !== 2 || typeof record.generation !== 'string' + || !/^(?:0|[1-9][0-9]{0,30})$/.test(record.generation) + || typeof record.encryptedPayload !== 'string' + || record.encryptedPayload.length === 0 + || !/^[A-Za-z0-9_-]+$/.test(record.encryptedPayload) + || typeof record.checksum !== 'string' + || record.checksum !== journalChecksum(record.encryptedPayload)) { + throw new Error('Desktop transaction journal is invalid'); + } + return record as unknown as JournalRecord; }; const encryptionStatus = (encryption: EncryptionProvider): StorageSecurity => { @@ -97,35 +363,74 @@ const normalizedProfileInput = (input: DesktopProfileInput): Omit(); #mutation = Promise.resolve(); - readonly #credentialMutations = new Map>(); + #closed = false; + #closePromise: Promise | null = null; - constructor(userDataPath: string, encryption: EncryptionProvider) { + constructor(userDataPath: string, encryption: EncryptionProvider, options: ProfileStoreOptions = {}) { this.#directory = join(userDataPath, 'desktop'); this.#statePath = join(this.#directory, 'profiles.json'); + this.#journalPaths = [ + join(this.#directory, 'profiles.journal.0'), + join(this.#directory, 'profiles.journal.1'), + ]; this.#credentialsDirectory = join(this.#directory, 'credentials'); this.#encryption = encryption; + this.#options = options; } security(): StorageSecurity { return encryptionStatus(this.#encryption); } - async list(): Promise { - const state = await this.#readState(); - return { - profiles: state.profiles.map(profile => ({ ...profile })), - activeProfileId: state.activeProfileId, - }; + /** Resolves after every queued recovery, mutation, and cleanup operation has settled. */ + awaitIdle(): Promise { + return this.#mutation; + } + + close(): Promise { + if (this.#closePromise) return this.#closePromise; + this.#closed = true; + this.#closePromise = this.awaitIdle(); + return this.#closePromise; + } + + list(): Promise { + return this.#mutate(async () => { + const state = await this.#readState(); + return { + profiles: state.profiles.map(profile => ({ ...profile })), + activeProfileId: state.activeProfileId, + }; + }); } save(input: DesktopProfileInput): Promise { + return this.saveAndDetachCredential(input).then(result => result.profile); + } + + saveAndDetachCredential( + input: DesktopProfileInput, + beforeOriginChangeCommit?: (previousOrigin: string, nextOrigin: string) => Promise, + ): Promise { return this.#mutate(async () => { const normalized = normalizedProfileInput(input); const state = await this.#readState(); const existing = state.profiles.find(profile => profile.id === normalized.id); + const originChanged = existing !== undefined && existing.apiBaseUrl !== normalized.apiBaseUrl; + if (originChanged) { + await beforeOriginChangeCommit?.(existing.apiBaseUrl, normalized.apiBaseUrl); + } + let detachedCredential: StoredCredential | null = null; + if (!existing || originChanged) { + detachedCredential = (await this.#moveCredentialToPending(state, normalized.id))?.credential ?? null; + if (originChanged && state.activeProfileId === normalized.id) state.activeProfileId = null; + } const now = new Date().toISOString(); const profile: DesktopProfile = { ...normalized, @@ -133,22 +438,153 @@ export class ProfileStore { updatedAt: now, }; state.profiles = [...state.profiles.filter(item => item.id !== profile.id), profile]; - await this.#writeState(state); - return { ...profile }; + const durable = await this.#writeState(state); + return { profile: { ...profile }, detachedCredential: durable ? detachedCredential : null, originChanged }; + }); + } + + commitPairedProfile( + input: DesktopProfileInput, + credential: StoredCredential, + expected: ProfileCredentialSnapshot, + isCurrent: () => boolean, + beginPublish?: () => (() => void) | null, + onPublished?: () => void, + pendingRevocationId?: string, + ): Promise { + const normalized = normalizedProfileInput(input); + if (credential.version !== 2 + || credential.profileId !== normalized.id + || credential.origin !== normalized.apiBaseUrl + || !isPublicInstanceIdentity(credential.publicInstanceIdentity) + || typeof credential.token !== 'string' + || credential.token.length > MAX_CREDENTIAL_LENGTH + || !/^propr_it_[A-Za-z0-9_-]{43}$/.test(credential.token)) { + throw new Error('Credential does not match the paired desktop profile'); + } + if (!this.security().available) return Promise.resolve({ stored: false, reason: 'encryption-unavailable' }); + + return this.#mutate(async () => { + const state = await this.#readState(); + const existing = state.profiles.find(profile => profile.id === normalized.id) ?? null; + const existingCredential = await this.#readCredentialFile(state, normalized.id); + const existingEpoch = state.credentialEpochs[normalized.id] ?? null; + if (!isCurrent() + || state.activeProfileId !== expected.activeProfileId + || !this.#sameProfile(existing, expected.profile) + || !this.#sameOptionalCredential(existingCredential, expected.credential) + || existingEpoch !== expected.identityEpoch) return null; + + const now = new Date().toISOString(); + const profile: DesktopProfile = { + ...normalized, + createdAt: existing?.createdAt ?? now, + updatedAt: now, + }; + const originChanged = existing !== null && existing.apiBaseUrl !== profile.apiBaseUrl; + + const previousSlot = state.credentialSlots[profile.id]; + const pending = pendingRevocationId ? state.pendingRevocations[pendingRevocationId] : undefined; + if (pendingRevocationId && !pending) return null; + const stagedSlot = pending?.slot ?? await this.#stageCredential(credential); + const identityEpoch = pending?.credentialGeneration ?? randomBytes(16).toString('base64url'); + const stagedByThisCall = !pending; + if (pending) { + const pendingCredential = await this.#readCredentialSlot(pending.slot, pending.profileId); + if (pending.profileId !== credential.profileId || pending.origin !== credential.origin + || !this.#sameCredential(pendingCredential, credential)) { + throw new Error('Pending desktop credential does not match the paired profile'); + } + } + let committed = false; + try { + if (!isCurrent()) return null; + // Promote B and detach A through the same pending transition used by + // deletion, origin edits and explicit credential replacement. These + // are only in-memory changes until the single journal commit below. + if (pendingRevocationId) delete state.pendingRevocations[pendingRevocationId]; + if (previousSlot) await this.#moveCredentialToPending(state, profile.id); + state.profiles = [...state.profiles.filter(item => item.id !== profile.id), profile]; + if (originChanged && state.activeProfileId === profile.id) state.activeProfileId = null; + // The staged slot is durable while the old state still names A. This + // single atomic state-file rename is the only A -> B commit point. + state.credentialSlots[profile.id] = stagedSlot; + state.credentialEpochs[profile.id] = identityEpoch; + const durable = await this.#writeState(state, isCurrent, beginPublish, onPublished); + if (durable === null) return null; + committed = true; + return { + profile: { ...profile }, + identityEpoch, + originChanged, + }; + } finally { + if (!committed && stagedByThisCall) { + await this.#unlinkSlot(stagedSlot).catch(() => undefined); + } + } }); } remove(profileId: string): Promise { + return this.detachProfile(profileId).then(() => undefined); + } + + detachProfile( + profileId: string, + beforeCommit?: (origin: string) => Promise, + ): Promise { assertProfileId(profileId); - const stateMutation = this.#mutate(async () => { + return this.#mutate(async () => { const state = await this.#readState(); + const profile = state.profiles.find(item => item.id === profileId); + if (profile) await beforeCommit?.(profile.apiBaseUrl); + const previousSlot = state.credentialSlots[profileId]; + const credential = (await this.#moveCredentialToPending(state, profileId))?.credential ?? null; + if (!profile && !previousSlot) return null; state.profiles = state.profiles.filter(profile => profile.id !== profileId); if (state.activeProfileId === profileId) state.activeProfileId = null; - await this.#writeState(state); + const durable = await this.#writeState(state); + if (!profile) return null; + return { profile: { ...profile }, credential: durable ? credential : null }; }); - return this.#mutateCredential(profileId, async () => { - await stateMutation; - await this.#removeCredentialFile(profileId); + } + + activateProfile( + expected: StoredCredential, + expectedIdentityEpoch: string, + expectedProfileOrigin: string, + expectedActiveProfileId: string | null, + isCurrent: () => boolean, + ): Promise { + const profileId = expected?.profileId; + assertProfileId(profileId); + if (normalizeApiBaseUrl(expectedProfileOrigin) !== expectedProfileOrigin) { + throw new Error('Invalid desktop API URL'); + } + if (expectedActiveProfileId !== null) assertProfileId(expectedActiveProfileId); + return this.#mutate(async () => { + const state = await this.#readState(); + const profile = state.profiles.find(item => item.id === profileId); + const credential = await this.#readCredentialFile(state, profileId); + if (!isCurrent() + || state.activeProfileId !== expectedActiveProfileId + || profile?.apiBaseUrl !== expectedProfileOrigin + || expected.origin !== expectedProfileOrigin + || credential?.origin !== profile.apiBaseUrl + || state.credentialEpochs[profileId] !== expectedIdentityEpoch + || !this.#sameCredential(credential, expected)) return null; + + const previousActiveProfileId = state.activeProfileId; + state.activeProfileId = profileId; + await this.#writeState(state); + if (isCurrent()) return expectedIdentityEpoch; + + // A generation/selection change that occurred during the atomic file + // replacement must not leave the candidate selected. + state.activeProfileId = previousActiveProfileId; + await this.#writeState(state); + return null; }); } @@ -164,61 +600,910 @@ export class ProfileStore { }); } - async readCredential(profileId: string): Promise { + readCredential(profileId: string): Promise { + assertProfileId(profileId); + if (!this.security().available) return Promise.resolve(null); + return this.#mutate(async () => this.#readCredentialFile(await this.#readState(), profileId)); + } + + readProfileCredential(profileId: string): Promise { assertProfileId(profileId); - if (!this.security().available) return { available: false, value: null }; + return this.#mutate(async () => { + const state = await this.#readState(); + const profile = state.profiles.find(item => item.id === profileId) ?? null; + const credential = this.security().available + ? await this.#readCredentialFile(state, profileId) + : null; + return { + profile: profile ? { ...profile } : null, + credential, + identityEpoch: state.credentialEpochs[profileId] ?? null, + activeProfileId: state.activeProfileId, + }; + }); + } + + async #readCredentialFile(state: PersistedState, profileId: string): Promise { + const slot = state.credentialSlots[profileId]; + if (!slot) return null; + return this.#readCredentialSlot(slot, profileId); + } + + async #readCredentialSlot(slot: string, profileId: string): Promise { try { - const encrypted = await readFile(this.#credentialPath(profileId)); - return { available: true, value: this.#encryption.decrypt(encrypted) }; + const encrypted = await readFile(join(this.#credentialsDirectory, slot)); + const value = JSON.parse(this.#encryption.decrypt(encrypted)) as unknown; + if (!value || typeof value !== 'object') return null; + const credential = value as Record; + if (credential.version !== 2 || credential.profileId !== profileId + || typeof credential.origin !== 'string' + || normalizeApiBaseUrl(credential.origin) !== credential.origin + || !isPublicInstanceIdentity(credential.publicInstanceIdentity) + || typeof credential.token !== 'string' + || !/^propr_it_[A-Za-z0-9_-]{43}$/.test(credential.token)) return null; + return credential as unknown as StoredCredential; } catch (error) { - if ((error as NodeJS.ErrnoException).code === 'ENOENT') return { available: true, value: null }; + if ((error as NodeJS.ErrnoException).code === 'ENOENT') return null; + if (error instanceof SyntaxError) return null; throw error; } } - async writeCredential(profileId: string, value: string): Promise { + async #moveCredentialToPending( + state: PersistedState, + profileId: string, + ): Promise<(Omit & { credential: StoredCredential | null }) | null> { + const slot = state.credentialSlots[profileId]; + if (!slot) return null; + if (Object.keys(state.pendingRevocations).length >= MAX_PENDING_REVOCATIONS) { + throw new Error('Pending desktop credential revocations must complete before changing profiles.'); + } + let credential: StoredCredential | null = null; + try { + credential = await this.#readCredentialSlot(slot, profileId); + } catch { + // The slot bytes were authenticated by the prior committed journal. Keep + // them durable even while a keychain/backend read is temporarily failing. + } + const credentialGeneration = state.credentialEpochs[profileId]; + const profile = state.profiles.find(item => item.id === profileId); + if (!credentialGeneration || (!credential && !profile)) { + throw new Error('Desktop credential cannot be safely detached for revocation.'); + } + const id = randomUUID(); + state.pendingRevocations[id] = { + version: 1, + profileId, + origin: credential?.origin ?? profile!.apiBaseUrl, + slot, + credentialGeneration, + deferred: false, + }; + delete state.credentialSlots[profileId]; + delete state.credentialEpochs[profileId]; + return { id, credential, credentialGeneration, deferred: false }; + } + + #sameCredential(actual: StoredCredential | null, expected: StoredCredential): boolean { + return actual !== null + && actual.version === expected.version + && actual.profileId === expected.profileId + && actual.origin === expected.origin + && actual.publicInstanceIdentity === expected.publicInstanceIdentity + && actual.token === expected.token; + } + + #sameOptionalCredential(actual: StoredCredential | null, expected: StoredCredential | null): boolean { + return expected === null ? actual === null : this.#sameCredential(actual, expected); + } + + #sameProfile(actual: DesktopProfile | null, expected: DesktopProfile | null): boolean { + return expected === null ? actual === null : actual !== null + && actual.id === expected.id + && actual.label === expected.label + && actual.apiBaseUrl === expected.apiBaseUrl + && actual.createdAt === expected.createdAt + && actual.updatedAt === expected.updatedAt; + } + + async writeCredential(credential: StoredCredential): Promise<{ stored: true } | { stored: false; reason: 'encryption-unavailable' }> { + const profileId = credential?.profileId; assertProfileId(profileId); - if (typeof value !== 'string' || value.length === 0 || value.length > MAX_CREDENTIAL_LENGTH) { + if (credential.version !== 2 || normalizeApiBaseUrl(credential.origin) !== credential.origin + || !isPublicInstanceIdentity(credential.publicInstanceIdentity) + || typeof credential.token !== 'string' || credential.token.length > MAX_CREDENTIAL_LENGTH + || !/^propr_it_[A-Za-z0-9_-]{43}$/.test(credential.token)) { throw new Error('Credential must contain 1 to 65536 characters'); } if (!this.security().available) return { stored: false, reason: 'encryption-unavailable' }; - return this.#mutateCredential(profileId, async () => { - await this.#ensureDirectories(); - const target = this.#credentialPath(profileId); - const temporary = `${target}.${process.pid}.tmp`; - await writeFile(temporary, this.#encryption.encrypt(value), { mode: 0o600 }); - await rename(temporary, target); - await chmod(target, 0o600).catch(() => undefined); + return this.#mutate(async () => { + const state = await this.#readState(); + const previousSlot = state.credentialSlots[profileId]; + if (previousSlot) await this.#moveCredentialToPending(state, profileId); + const stagedSlot = await this.#stageCredential(credential); + let committed = false; + try { + state.credentialSlots[profileId] = stagedSlot; + state.credentialEpochs[profileId] = randomBytes(16).toString('base64url'); + const durable = await this.#writeState(state); + committed = true; + if (!durable) return { stored: true }; + } finally { + if (!committed) { + await this.#unlinkSlot(stagedSlot).catch(() => undefined); + } + } return { stored: true }; }); } removeCredential(profileId: string): Promise { assertProfileId(profileId); - return this.#mutateCredential(profileId, () => this.#removeCredentialFile(profileId)); + return this.#mutate(async () => { + const state = await this.#readState(); + if (!await this.#moveCredentialToPending(state, profileId)) return; + await this.#writeState(state); + }); } - async #removeCredentialFile(profileId: string): Promise { - await unlink(this.#credentialPath(profileId)).catch(error => { - if ((error as NodeJS.ErrnoException).code !== 'ENOENT') throw error; + removeCredentialIfCurrent( + expected: StoredCredential, + expectedProfileOrigin: string, + isCurrent: () => boolean, + ): Promise { + const profileId = expected?.profileId; + assertProfileId(profileId); + if (normalizeApiBaseUrl(expectedProfileOrigin) !== expectedProfileOrigin) { + throw new Error('Invalid desktop API URL'); + } + return this.#mutate(async () => { + const state = await this.#readState(); + const profile = state.profiles.find(item => item.id === profileId); + const credential = await this.#readCredentialFile(state, profileId); + if (!isCurrent() + || profile?.apiBaseUrl !== expectedProfileOrigin + || !credential + || credential.version !== expected.version + || credential.profileId !== expected.profileId + || credential.origin !== expected.origin + || credential.publicInstanceIdentity !== expected.publicInstanceIdentity + || credential.token !== expected.token) return false; + await this.#moveCredentialToPending(state, profileId); + await this.#writeState(state); + return true; + }); + } + + journalPendingRevocation( + credential: StoredCredential, + credentialGeneration?: string, + ): Promise { + const profileId = credential?.profileId; + assertProfileId(profileId); + if (credential.version !== 2 || normalizeApiBaseUrl(credential.origin) !== credential.origin + || !isPublicInstanceIdentity(credential.publicInstanceIdentity) + || typeof credential.token !== 'string' || credential.token.length > MAX_CREDENTIAL_LENGTH + || !/^propr_it_[A-Za-z0-9_-]{43}$/.test(credential.token)) { + throw new Error('Invalid desktop credential revocation material'); + } + if (credentialGeneration !== undefined && !IDENTITY_EPOCH_PATTERN.test(credentialGeneration)) { + throw new Error('Invalid desktop credential generation'); + } + if (!this.security().available) return Promise.resolve({ stored: false, reason: 'encryption-unavailable' }); + return this.#mutate(async () => { + const state = await this.#readState(); + for (const [id, record] of Object.entries(state.pendingRevocations)) { + if (record.profileId !== profileId || record.origin !== credential.origin) continue; + const existing = await this.#readCredentialSlot(record.slot, record.profileId); + if (this.#sameCredential(existing, credential)) { + return { + id, + credential: { ...credential }, + credentialGeneration: record.credentialGeneration, + deferred: record.deferred, + }; + } + } + if (Object.keys(state.pendingRevocations).length >= MAX_PENDING_REVOCATIONS) { + throw new Error('Pending desktop credential revocations must complete before pairing again.'); + } + const slot = await this.#stageCredential(credential); + const id = randomUUID(); + const generation = credentialGeneration ?? randomBytes(16).toString('base64url'); + let committed = false; + try { + state.pendingRevocations[id] = { + version: 1, + profileId, + origin: credential.origin, + slot, + credentialGeneration: generation, + deferred: true, + }; + await this.#writeState(state); + committed = true; + return { id, credential: { ...credential }, credentialGeneration: generation, deferred: true }; + } finally { + if (!committed) await this.#unlinkSlot(slot).catch(() => undefined); + } + }); + } + + releasePendingRevocation(id: string, credentialGeneration: string): Promise { + if (!/^[0-9a-f-]{36}$/i.test(id) || !IDENTITY_EPOCH_PATTERN.test(credentialGeneration)) { + throw new Error('Invalid desktop revocation release'); + } + return this.#mutate(async () => { + const state = await this.#readState(); + const record = state.pendingRevocations[id]; + if (!record || record.credentialGeneration !== credentialGeneration) return false; + if (!record.deferred) return true; + record.deferred = false; + await this.#writeState(state); + return true; + }); + } + + pendingRevocations(includeDeferred = true): Promise { + if (!this.security().available) return Promise.resolve([]); + return this.#mutate(async () => { + const state = await this.#readState(); + const pending: PendingCredentialRevocation[] = []; + for (const [id, record] of Object.entries(state.pendingRevocations)) { + if (record.deferred && !includeDeferred) continue; + const credential = await this.#readCredentialSlot(record.slot, record.profileId); + if (!credential || credential.origin !== record.origin) { + throw new Error('Desktop pending revocation material is unavailable'); + } + pending.push({ + id, + credential, + credentialGeneration: record.credentialGeneration, + deferred: record.deferred, + }); + } + return pending; + }); + } + + completePendingRevocation( + id: string, + expected: StoredCredential, + expectedCredentialGeneration?: string, + ): Promise { + if (!/^[0-9a-f-]{36}$/i.test(id)) throw new Error('Invalid desktop revocation id'); + return this.#mutate(async () => { + const state = await this.#readState(); + const record = state.pendingRevocations[id]; + if (!record || record.profileId !== expected.profileId || record.origin !== expected.origin + || (expectedCredentialGeneration !== undefined + && record.credentialGeneration !== expectedCredentialGeneration)) return false; + const actual = await this.#readCredentialSlot(record.slot, record.profileId); + if (!this.#sameCredential(actual, expected)) return false; + delete state.pendingRevocations[id]; + await this.#writeState(state); + await this.#unlinkSlot(record.slot); + await this.#step('old-credential-removed').catch(() => undefined); + return true; }); } async #readState(): Promise { try { - return parseState(await readFile(this.#statePath, 'utf8')); + const state = parseState(await readFile(this.#statePath, 'utf8')); + if (state.version !== 3) throw new Error('Desktop profile store recovery was not completed'); + return state; } catch (error) { if ((error as NodeJS.ErrnoException).code === 'ENOENT') return emptyState(); throw error; } } - async #writeState(state: PersistedState): Promise { + async #writeState( + state: PersistedState, + isCurrent?: () => boolean, + beginPublish?: () => (() => void) | null, + onPublished?: () => void, + ): Promise { + await this.#ensureDirectories(); + const previousGeneration = state.generation; + state.generation = (BigInt(state.generation) + 1n).toString(); + const temporary = `${this.#statePath}.${process.pid}.${randomUUID()}.tmp`; + let releasePublish: (() => void) | undefined; + try { + await this.#io('mirror-write'); + await writeFile(temporary, `${JSON.stringify(state, null, 2)}\n`, { encoding: 'utf8', mode: 0o600 }); + await this.#step('state-written'); + await this.#io('mirror-flush'); + await this.#fsyncFile(temporary); + await this.#step('state-fsynced'); + if (beginPublish) { + const release = beginPublish(); + if (!release) { + state.generation = previousGeneration; + return null; + } + releasePublish = release; + } else if (isCurrent && !isCurrent()) { + state.generation = previousGeneration; + return null; + } + + // The alternating, self-contained journal is the durable commit point. + // It uses a write-through file handle supported by Windows and embeds only + // already OS-encrypted credential bytes, so recovery does not depend on a + // directory flush, rename visibility, or the new slot directory entry. + await this.#writeJournal(state, onPublished); + + // profiles.json is a convenient atomic mirror. Once the journal is synced, + // failure or rollback of this rename cannot make the prior state authoritative. + try { + await this.#io('mirror-replace'); + await rename(temporary, this.#statePath); + await this.#step('state-renamed').catch(() => undefined); + const directoryDurable = await this.#flushDirectoryIfSupported(this.#directory); + if (directoryDurable) await this.#step('state-directory-fsynced').catch(() => undefined); + } catch { + // The journal is authoritative and #recover repairs this mirror before + // the next read or mutation. + } + await chmod(this.#statePath, 0o600).catch(() => undefined); + return true; + } finally { + releasePublish?.(); + await unlink(temporary).catch(() => undefined); + } + } + + async #writeJournal(state: PersistedState, onPublished?: () => void): Promise { + const referenced = new Set([ + ...Object.values(state.credentialSlots), + ...Object.values(state.pendingRevocations).map(record => record.slot), + ]); + const encryptedSlots: Record = {}; + for (const slot of referenced) { + encryptedSlots[slot] = (await readFile(join(this.#credentialsDirectory, slot))).toString('base64url'); + } + const payload: JournalPayload = { + version: 1, + state: JSON.parse(JSON.stringify(state)) as PersistedState, + encryptedSlots, + }; + const encryptedPayload = this.#encryption.encrypt(JSON.stringify(payload)).toString('base64url'); + const record: JournalRecord = { + version: 2, + generation: String(state.generation), + encryptedPayload, + checksum: journalChecksum(encryptedPayload), + }; + const path = this.#journalPaths[Number(BigInt(state.generation) % BigInt(this.#journalPaths.length))]; + const preparedContents = `P${JSON.stringify(record)}\n`; + if (Buffer.byteLength(preparedContents) > MAX_JOURNAL_BYTES) { + throw new Error('Desktop transaction journal exceeds its bounded size'); + } + const preparationHandle = await open( + path, + constants.O_WRONLY | constants.O_CREAT | constants.O_TRUNC, + 0o600, + ); + try { + await this.#io('journal-write'); + await preparationHandle.writeFile(preparedContents, 'utf8'); + await this.#step('journal-written'); + + await this.#io('journal-flush'); + await preparationHandle.sync(); + await this.#step('journal-fsynced'); + } finally { + await preparationHandle.close(); + } + await this.#step('journal-closed'); + + // Verification deliberately reopens the prepared slot through a writable + // handle and does not use an in-memory authentication cache. The same held + // handle remains bound to the verified bytes through C publication. + await this.#io('journal-reopen'); + const verificationHandle = await open(path, constants.O_RDWR); + try { + await this.#step('journal-reopened'); + const verifiedContents = await this.#readHandleContents(verificationHandle); + await this.#io('journal-verify'); + if (verifiedContents !== preparedContents) throw new Error(RECOVERY_ERROR); + const prepared = await this.#authenticateJournal(verifiedContents, false, false); + if (prepared.generation !== BigInt(state.generation) + || JSON.stringify(prepared.state) !== JSON.stringify(state) + || JSON.stringify(prepared.encryptedSlots) !== JSON.stringify(encryptedSlots)) { + throw new Error(RECOVERY_ERROR); + } + await this.#step('journal-prepared-verified'); + + // Refuse a pathname replacement before the authority transition. The + // marker is nevertheless written through the already verified handle, + // so a same-user same-size/generation replacement can never receive C. + await this.#io('journal-commit'); + await this.#assertHandleStillNamesPath(verificationHandle, path, preparedContents.length); + const written = await verificationHandle.write(Buffer.from('C'), 0, 1, 0); + if (written.bytesWritten !== 1) throw new Error('Desktop transaction journal commit failed'); + // From this point B may be observed after a crash even if the explicit + // flush reports failure. Notify the shared gate before anything fallible + // so the fully verified B credential is never revoked as transient. + onPublished?.(); + await this.#step('journal-committed'); + await this.#io('journal-commit-flush'); + await verificationHandle.sync(); + await this.#step('journal-commit-fsynced'); + const committedContents = await this.#readHandleContents(verificationHandle); + if (committedContents !== `C${preparedContents.slice(1)}`) throw new Error(RECOVERY_ERROR); + const committed = await this.#authenticateJournal(committedContents, true, false); + if (committed.generation !== prepared.generation + || JSON.stringify(committed.state) !== JSON.stringify(prepared.state) + || JSON.stringify(committed.encryptedSlots) !== JSON.stringify(prepared.encryptedSlots)) { + throw new Error(RECOVERY_ERROR); + } + await this.#step('journal-commit-verified'); + } finally { + await verificationHandle.close(); + } + await this.#step('journal-commit-closed'); + await chmod(path, 0o600).catch(() => undefined); + } + + async #readHandleContents(handle: FileHandle): Promise { + const info = await handle.stat({ bigint: true }); + if (info.size > BigInt(MAX_JOURNAL_BYTES) || info.size > BigInt(Number.MAX_SAFE_INTEGER)) { + throw new Error(RECOVERY_ERROR); + } + const bytes = Buffer.alloc(Number(info.size)); + let offset = 0; + while (offset < bytes.length) { + const result = await handle.read(bytes, offset, bytes.length - offset, offset); + if (result.bytesRead === 0) throw new Error(RECOVERY_ERROR); + offset += result.bytesRead; + } + return bytes.toString('utf8'); + } + + async #assertHandleStillNamesPath(handle: FileHandle, path: string, expectedSize: number): Promise { + const [held, named] = await Promise.all([ + handle.stat({ bigint: true }), + lstat(path, { bigint: true }), + ]); + if (named.isSymbolicLink() || !named.isFile() + || held.dev !== named.dev || held.ino !== named.ino + || held.size !== BigInt(expectedSize) || named.size !== held.size + || held.mode !== named.mode || held.uid !== named.uid || held.gid !== named.gid + || held.nlink !== named.nlink || held.nlink !== 1n) { + throw new Error(RECOVERY_ERROR); + } + } + + async #stageCredential(credential: StoredCredential): Promise { + await this.#ensureDirectories(); + const slot = `${credential.profileId}.${randomUUID()}.bin`; + const target = join(this.#credentialsDirectory, slot); + const temporary = `${target}.${process.pid}.${randomUUID()}.tmp`; + try { + const encrypted = this.#encryption.encrypt(JSON.stringify(credential)); + await this.#step('credential-encrypted'); + await this.#io('credential-write'); + await writeFile(temporary, encrypted, { mode: 0o600 }); + await this.#step('credential-written'); + await this.#io('credential-flush'); + await this.#fsyncFile(temporary); + await this.#step('credential-fsynced'); + await this.#io('credential-replace'); + await rename(temporary, target); + await this.#step('credential-renamed'); + const directoryDurable = await this.#flushDirectoryIfSupported(this.#credentialsDirectory); + if (directoryDurable) await this.#step('credential-directory-fsynced'); + await chmod(target, 0o600).catch(() => undefined); + return slot; + } finally { + await unlink(temporary).catch(() => undefined); + } + } + + async #authenticateJournal( + contents: string, + committedOnly: boolean, + useCache = true, + ): Promise { + const marker = contents[0]; + if ((committedOnly && marker !== 'C') || (!committedOnly && marker !== 'P' && marker !== 'C')) { + throw new Error('Desktop transaction journal is incomplete'); + } + const envelope = parseJournalEnvelope(contents.slice(1)); + const cached = useCache ? this.#authenticatedJournalCache.get(envelope.checksum) : undefined; + if (cached) { + if (cached.generation !== BigInt(envelope.generation)) throw new Error(RECOVERY_ERROR); + return { + generation: cached.generation, + state: JSON.parse(JSON.stringify(cached.state)) as PersistedState, + encryptedSlots: { ...cached.encryptedSlots }, + }; + } + let plaintext: string; + try { + plaintext = this.#encryption.decrypt(Buffer.from(envelope.encryptedPayload, 'base64url')); + } catch { + throw new Error('Desktop transaction journal authentication failed'); + } + let raw: unknown; + try { + raw = JSON.parse(plaintext) as unknown; + } catch { + throw new Error('Desktop transaction journal authentication failed'); + } + if (!raw || typeof raw !== 'object' || Array.isArray(raw)) throw new Error(RECOVERY_ERROR); + const candidate = raw as Record; + const state = parseState(JSON.stringify(candidate.state)); + if (candidate.version !== 1 || state.version !== 3 + || typeof candidate.encryptedSlots !== 'object' || candidate.encryptedSlots === null + || Array.isArray(candidate.encryptedSlots) + || envelope.generation !== String(state.generation)) throw new Error(RECOVERY_ERROR); + const encryptedSlots = candidate.encryptedSlots as Record; + const referenced = new Set([ + ...Object.values(state.credentialSlots), + ...Object.values(state.pendingRevocations).map(record => record.slot), + ]); + if (Object.keys(encryptedSlots).length !== referenced.size + || Object.keys(encryptedSlots).some(slot => !referenced.has(slot))) throw new Error(RECOVERY_ERROR); + + const authenticatedSlots: Record = {}; + for (const slot of referenced) { + const encoded = encryptedSlots[slot]; + if (typeof encoded !== 'string' || encoded.length === 0 + || encoded.length > Math.ceil(MAX_CREDENTIAL_LENGTH * 2) + || !/^[A-Za-z0-9_-]+$/.test(encoded)) throw new Error(RECOVERY_ERROR); + const bytes = Buffer.from(encoded, 'base64url'); + if (bytes.toString('base64url') !== encoded) throw new Error(RECOVERY_ERROR); + let credential: (StoredCredential & Record) | Record | null = null; + try { + credential = JSON.parse(this.#encryption.decrypt(bytes)) as Record; + } catch { + if (!this.#wasPreviouslyAuthenticatedSlot(state, slot, encoded)) throw new Error(RECOVERY_ERROR); + } + const profileId = SLOT_PATTERN.exec(slot)?.[1]; + const isLegacyCredential = credential?.version === 1 + && credential.profileId === profileId + && typeof credential.origin === 'string' + && normalizeApiBaseUrl(credential.origin) === credential.origin + && typeof credential.token === 'string' + && /^propr_it_[A-Za-z0-9_-]{43}$/.test(credential.token); + if (credential && !isLegacyCredential && (credential.version !== 2 || credential.profileId !== profileId + || typeof credential.origin !== 'string' + || normalizeApiBaseUrl(credential.origin) !== credential.origin + || !isPublicInstanceIdentity(credential.publicInstanceIdentity) + || typeof credential.token !== 'string' + || !/^propr_it_[A-Za-z0-9_-]{43}$/.test(credential.token))) throw new Error(RECOVERY_ERROR); + const pending = Object.values(state.pendingRevocations).find(record => record.slot === slot); + if (credential && !isLegacyCredential && pending + && (pending.profileId !== credential.profileId || pending.origin !== credential.origin)) { + throw new Error(RECOVERY_ERROR); + } + authenticatedSlots[slot] = encoded; + } + const authenticated = { generation: BigInt(envelope.generation), state, encryptedSlots: authenticatedSlots }; + this.#authenticatedJournalCache.set(envelope.checksum, { + generation: authenticated.generation, + state: JSON.parse(JSON.stringify(state)) as PersistedState, + encryptedSlots: { ...authenticatedSlots }, + }); + return authenticated; + } + + #wasPreviouslyAuthenticatedSlot(state: PersistedState, slot: string, encoded: string): boolean { + const currentPending = Object.values(state.pendingRevocations).find(record => record.slot === slot); + const currentProfileId = SLOT_PATTERN.exec(slot)?.[1]; + for (const cached of this.#authenticatedJournalCache.values()) { + if (cached.encryptedSlots[slot] !== encoded) continue; + const priorPending = Object.values(cached.state.pendingRevocations).find(record => record.slot === slot); + if (currentPending && priorPending + && currentPending.profileId === priorPending.profileId + && currentPending.origin === priorPending.origin + && currentPending.credentialGeneration === priorPending.credentialGeneration) return true; + if (currentPending && currentProfileId + && cached.state.credentialSlots[currentProfileId] === slot + && cached.state.credentialEpochs[currentProfileId] === currentPending.credentialGeneration + && cached.state.profiles.find(profile => profile.id === currentProfileId)?.apiBaseUrl + === currentPending.origin) return true; + if (!currentPending && currentProfileId + && state.credentialSlots[currentProfileId] === slot + && cached.state.credentialSlots[currentProfileId] === slot + && state.credentialEpochs[currentProfileId] === cached.state.credentialEpochs[currentProfileId]) return true; + } + return false; + } + + async #recover(): Promise { await this.#ensureDirectories(); - const temporary = `${this.#statePath}.${process.pid}.tmp`; - await writeFile(temporary, `${JSON.stringify(state, null, 2)}\n`, { encoding: 'utf8', mode: 0o600 }); - await rename(temporary, this.#statePath); - await chmod(this.#statePath, 0o600).catch(() => undefined); + const journalRecords: AuthenticatedJournal[] = []; + const legacyJournalRecords: LegacyJournalRecord[] = []; + const preparedJournalRecords: AuthenticatedJournal[] = []; + let invalidCommittedJournal = false; + let invalidPreparedJournal = false; + let sawPreparedJournal = false; + let sawNonPreparedJournal = false; + for (const path of this.#journalPaths) { + try { + const info = await stat(path); + if (info.size > MAX_JOURNAL_BYTES) throw new Error('Desktop transaction journal is invalid'); + const contents = await readFile(path, 'utf8'); + if (contents.startsWith('C') || contents.startsWith('P')) { + if (contents.startsWith('C')) { + sawNonPreparedJournal = true; + try { + journalRecords.push(await this.#authenticateJournal(contents, true)); + } catch { + invalidCommittedJournal = true; + } + } else { + sawPreparedJournal = true; + try { + preparedJournalRecords.push(await this.#authenticateJournal(contents, false, false)); + } catch { + invalidPreparedJournal = true; + } + } + // A prepared record is deliberately not authoritative. The other + // alternating slot (or the legacy mirror before the first commit) + // remains the complete recovery point. + } else { + sawNonPreparedJournal = true; + legacyJournalRecords.push(parseLegacyJournal(contents)); + } + } catch (error) { + const code = (error as NodeJS.ErrnoException).code; + if (code === 'ENOENT') continue; + if (error instanceof SyntaxError + || (error instanceof Error && error.message.startsWith('Desktop transaction journal'))) { + sawNonPreparedJournal = true; + continue; + } + throw new Error(RECOVERY_ERROR); + } + } + journalRecords.sort((left, right) => left.generation < right.generation ? -1 : left.generation > right.generation ? 1 : 0); + const authoritativeJournal = journalRecords.at(-1); + + let parsed: PersistedState | VersionTwoPersistedState | LegacyPersistedState | null = null; + let mirrorMissing = false; + try { + parsed = parseState(await readFile(this.#statePath, 'utf8')); + } catch (error) { + const code = (error as NodeJS.ErrnoException).code; + mirrorMissing = code === 'ENOENT'; + if (code && code !== 'ENOENT') throw new Error(RECOVERY_ERROR); + if (!(error instanceof SyntaxError) + && !(error instanceof Error && error.message.startsWith('Desktop ')) + && !mirrorMissing) throw new Error(RECOVERY_ERROR); + } + + let state: PersistedState; + if (authoritativeJournal) { + state = authoritativeJournal.state; + for (const [slot, encoded] of Object.entries(authoritativeJournal.encryptedSlots)) { + const expectedBytes = Buffer.from(encoded, 'base64url'); + try { + const actualBytes = await readFile(join(this.#credentialsDirectory, slot)); + if (actualBytes.equals(expectedBytes)) continue; + } catch (error) { + if ((error as NodeJS.ErrnoException).code !== 'ENOENT') throw new Error(RECOVERY_ERROR); + } + try { + await this.#writeThroughFile(join(this.#credentialsDirectory, slot), expectedBytes); + } catch { + throw new Error(RECOVERY_ERROR); + } + } + const mirrorMatches = parsed?.version === 3 + && JSON.stringify(parsed) === JSON.stringify(state); + if (!mirrorMatches) { + try { + await this.#writeStateMirror(state); + } catch { + throw new Error(RECOVERY_ERROR); + } + } + } else { + if (!parsed) { + const preparedIsOnlyCanonicalEmptyBootstrap = sawPreparedJournal + && !invalidPreparedJournal + && preparedJournalRecords.length > 0 + && preparedJournalRecords.every(record => record.generation === 1n + && JSON.stringify(record.state) === JSON.stringify({ ...emptyState(), generation: '1' }) + && Object.keys(record.encryptedSlots).length === 0); + if (mirrorMissing && !invalidCommittedJournal && legacyJournalRecords.length === 0 + && (!sawPreparedJournal || preparedIsOnlyCanonicalEmptyBootstrap)) { + // An authenticated generation-1 empty P is the one narrow prepared + // bootstrap exception. It is never made authoritative: recovery + // reconstructs empty A and retries publication. Any A-to-B P remains + // ignored and cannot manufacture a missing mirror authority. + parsed = { version: 1, activeProfileId: null, profiles: [] }; + } else { + throw new Error(RECOVERY_ERROR); + } + } + if (invalidCommittedJournal || (sawNonPreparedJournal && legacyJournalRecords.length === 0)) { + throw new Error(RECOVERY_ERROR); + } + if (legacyJournalRecords.length > 0) { + legacyJournalRecords.sort((left, right) => { + const leftGeneration = BigInt(left.state.generation); + const rightGeneration = BigInt(right.state.generation); + return leftGeneration < rightGeneration ? -1 : leftGeneration > rightGeneration ? 1 : 0; + }); + const legacy = legacyJournalRecords.at(-1)!; + if (parsed.version !== 3 || JSON.stringify(parsed) !== JSON.stringify(legacy.state)) { + throw new Error(RECOVERY_ERROR); + } + state = legacy.state; + for (const [slot, encoded] of Object.entries(legacy.encryptedSlots)) { + await this.#writeThroughFile(join(this.#credentialsDirectory, slot), Buffer.from(encoded, 'base64url')); + } + await this.#writeState(state); + } else if (parsed.version === 1) { + state = { + version: 3, + generation: '0', + activeProfileId: parsed.activeProfileId, + profiles: parsed.profiles.map(profile => ({ ...profile })), + credentialSlots: {}, + credentialEpochs: {}, + pendingRevocations: {}, + }; + // Pre-identity credentials cannot safely be presented to any endpoint. + // Keep profiles, but deliberately migrate without their bearer slots. + state.activeProfileId = null; + await this.#writeState(state); + } else if (parsed.version === 2) { + state = { + version: 3, + generation: '0', + activeProfileId: parsed.activeProfileId, + profiles: parsed.profiles.map(profile => ({ ...profile })), + credentialSlots: {}, + credentialEpochs: {}, + pendingRevocations: {}, + }; + if (Object.keys(parsed.credentialSlots).length > 0) state.activeProfileId = null; + await this.#writeState(state); + } else { + state = parsed; + // A v3 file predating journal creation is migrated into the durable + // write-through protocol before any unreferenced slot cleanup. + await this.#writeState(state); + } + } + + // Version-3 stores created before public identity binding authenticate at + // the journal layer, but their credential payloads are intentionally not + // usable. Remove those references locally before any caller can read a + // bearer; re-pairing creates a fresh identity-bound generation. + let removedUnboundCredential = false; + for (const [profileId, slot] of Object.entries(state.credentialSlots)) { + let credential: StoredCredential | null; + try { credential = await this.#readCredentialSlot(slot, profileId); } + catch { continue; } // Preserve material while the OS credential backend is temporarily unavailable. + if (credential) continue; + delete state.credentialSlots[profileId]; + delete state.credentialEpochs[profileId]; + if (state.activeProfileId === profileId) state.activeProfileId = null; + removedUnboundCredential = true; + } + for (const [id, pending] of Object.entries(state.pendingRevocations)) { + let credential: StoredCredential | null; + try { credential = await this.#readCredentialSlot(pending.slot, pending.profileId); } + catch { continue; } + if (credential) continue; + delete state.pendingRevocations[id]; + removedUnboundCredential = true; + } + if (removedUnboundCredential) await this.#writeState(state); + + const referenced = new Set([ + ...Object.values(state.credentialSlots), + ...Object.values(state.pendingRevocations).map(record => record.slot), + ]); + const entries = await readdir(this.#credentialsDirectory, { withFileTypes: true }); + for (const entry of entries) { + if (entry.isFile() && entry.name.endsWith('.tmp')) { + await unlink(join(this.#credentialsDirectory, entry.name)); + } + } + const stateEntries = await readdir(this.#directory, { withFileTypes: true }); + for (const entry of stateEntries) { + if (entry.isFile() && /^profiles\.json\..+\.tmp$/.test(entry.name)) { + await unlink(join(this.#directory, entry.name)); + } + } + await this.#flushDirectoryIfSupported(this.#credentialsDirectory); + await this.#flushDirectoryIfSupported(this.#directory); + for (const slot of referenced) { + try { + await readFile(join(this.#credentialsDirectory, slot)); + } catch (error) { + if ((error as NodeJS.ErrnoException).code === 'ENOENT') { + throw new Error('Desktop credential state is incomplete'); + } + throw error; + } + } + for (const entry of entries) { + if (!entry.isFile() || referenced.has(entry.name)) continue; + if (/^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}(?:\.[0-9a-f-]{36})?\.bin$/i.test(entry.name)) { + await unlink(join(this.#credentialsDirectory, entry.name)); + } + } + await this.#flushDirectoryIfSupported(this.#credentialsDirectory); + await this.#flushDirectoryIfSupported(this.#directory); + } + + async #writeStateMirror(state: PersistedState): Promise { + const temporary = `${this.#statePath}.${process.pid}.${randomUUID()}.recovery.tmp`; + try { + await this.#io('mirror-write'); + await writeFile(temporary, `${JSON.stringify(state, null, 2)}\n`, { encoding: 'utf8', mode: 0o600 }); + await this.#io('mirror-flush'); + await this.#fsyncFile(temporary); + await this.#io('mirror-replace'); + await rename(temporary, this.#statePath); + await this.#flushDirectoryIfSupported(this.#directory); + } finally { + await unlink(temporary).catch(() => undefined); + } + } + + async #writeThroughFile(path: string, bytes: Buffer): Promise { + const handle = await open( + path, + constants.O_WRONLY | constants.O_CREAT | constants.O_TRUNC, + 0o600, + ); + try { + await this.#io('journal-write'); + await handle.writeFile(bytes); + await this.#io('journal-flush'); + await handle.sync(); + } finally { + await handle.close(); + } + await this.#io('journal-verify'); + if (!(await readFile(path)).equals(bytes)) throw new Error(RECOVERY_ERROR); + } + + async #fsyncFile(path: string): Promise { + await flushFileData(path); + } + + async #fsyncDirectory(path: string): Promise { + const handle = await open(path, 'r'); + try { await handle.sync(); } finally { await handle.close(); } + } + + async #flushDirectoryIfSupported(path: string): Promise { + await this.#io('metadata-flush'); + // Node does not expose a supported Windows directory FlushFileBuffers + // handle. No authority transition depends on it: the committed journal is + // self-contained and can recreate both renamed credential entries and the + // profiles.json mirror. POSIX platforms still require and perform fsync. + if (process.platform === 'win32') return false; + await this.#fsyncDirectory(path); + return true; + } + + async #unlinkSlot(slot: string): Promise { + await unlink(join(this.#credentialsDirectory, slot)).catch(error => { + if ((error as NodeJS.ErrnoException).code !== 'ENOENT') throw error; + }); + } + + #step(step: ProfileStoreDurabilityStep): Promise { + return Promise.resolve(this.#options.afterDurabilityStep?.(step)); + } + + #io(operation: ProfileStoreIOOperation): Promise { + return Promise.resolve(this.#options.beforeIO?.(operation)); } async #ensureDirectories(): Promise { @@ -227,24 +1512,15 @@ export class ProfileStore { await chmod(this.#credentialsDirectory, 0o700).catch(() => undefined); } - #credentialPath(profileId: string): string { - return join(this.#credentialsDirectory, `${profileId}.bin`); - } - #mutate(operation: () => Promise): Promise { - const result = this.#mutation.then(operation, operation); + if (this.#closed) return Promise.reject(new Error('Desktop profile store is closed')); + const recoveredOperation = async () => { + await this.#recover(); + return operation(); + }; + const result = this.#mutation.then(recoveredOperation, recoveredOperation); this.#mutation = result.then(() => undefined, () => undefined); return result; } - #mutateCredential(profileId: string, operation: () => Promise): Promise { - const previous = this.#credentialMutations.get(profileId) ?? Promise.resolve(); - const result = previous.then(operation, operation); - const settled = result.then(() => undefined, () => undefined); - this.#credentialMutations.set(profileId, settled); - void settled.then(() => { - if (this.#credentialMutations.get(profileId) === settled) this.#credentialMutations.delete(profileId); - }); - return result; - } } diff --git a/apps/desktop/src/security.test.ts b/apps/desktop/src/security.test.ts index 0a88499f1..37c695b31 100644 --- a/apps/desktop/src/security.test.ts +++ b/apps/desktop/src/security.test.ts @@ -1,8 +1,11 @@ import assert from 'node:assert/strict'; import { describe, it } from 'node:test'; +import { PROPR_API_ORIGIN_PARITY_CASES } from '@propr/shared'; import { + createLatestRendererReloader, deepLinkFromArguments, applyDevelopmentRendererCsp, + connectApiBaseUrlFromDeepLink, dashboardPathFromDeepLink, isSafeExternalUrl, isTrustedRendererUrl, @@ -14,9 +17,16 @@ import { } from './security'; describe('desktop URL security', () => { + it('matches the shared canonical origin parity table', () => { + for (const [name, input, expected] of PROPR_API_ORIGIN_PARITY_CASES) { + assert.equal(normalizeApiBaseUrl(input), expected, name); + } + }); it('only accepts HTTPS and loopback HTTP API endpoints', () => { - assert.equal(normalizeApiBaseUrl('https://propr.example.com///'), 'https://propr.example.com'); + assert.equal(normalizeApiBaseUrl('https://propr.example.com/'), 'https://propr.example.com'); assert.equal(normalizeApiBaseUrl('http://localhost:4000/'), 'http://localhost:4000'); + assert.equal(normalizeApiBaseUrl('http://team.localhost:4000'), 'http://team.localhost:4000'); + assert.equal(normalizeApiBaseUrl('http://127.99.2.3:4000'), 'http://127.99.2.3:4000'); assert.equal(normalizeApiBaseUrl('http://127.0.0.1:4000'), 'http://127.0.0.1:4000'); assert.equal(normalizeApiBaseUrl('http://[::1]:4000/'), 'http://[::1]:4000'); assert.equal(normalizeApiBaseUrl('https://propr.example.com/base'), null); @@ -24,7 +34,28 @@ describe('desktop URL security', () => { assert.equal(normalizeApiBaseUrl('http://propr.example.com'), null); assert.equal(normalizeApiBaseUrl('http://[2001:db8::1]:4000'), null); assert.equal(normalizeApiBaseUrl('https://user:secret@propr.example.com'), null); + assert.equal(normalizeApiBaseUrl('https://t-instance123.propr.dev'), 'https://t-instance123.propr.dev'); + assert.equal(normalizeApiBaseUrl(' https://t-instance123.propr.dev'), null); + assert.equal(normalizeApiBaseUrl('https://t-instance123.propr.dev '), null); + assert.equal(normalizeApiBaseUrl('https://t-instance123.propr.dev/'), null); + assert.equal(normalizeApiBaseUrl('HTTPS://t-instance123.propr.dev'), null); + assert.equal(normalizeApiBaseUrl('https://T-instance123.propr.dev'), null); + assert.equal(normalizeApiBaseUrl('https://t-instance123.propr.dev:443'), null); + assert.equal(normalizeApiBaseUrl('https://t-instance123.propr.dev:8443'), null); + assert.equal(normalizeApiBaseUrl('https://t-%69nstance123.propr.dev'), null); + assert.equal(normalizeApiBaseUrl('https://t-instance123.propr%2edev'), null); + assert.equal(normalizeApiBaseUrl('https://t-instance123.foo.propr.dev'), null); + assert.equal(normalizeApiBaseUrl('https://x.t-instance123.propr.dev'), null); + assert.equal(normalizeApiBaseUrl('https://t-instance123.propr.dev.'), null); + assert.equal(normalizeApiBaseUrl(`https://example.com/${'private'.repeat(400)}`), null); + assert.equal(normalizeApiBaseUrl('https://t-instance123.propr.dev.example.com'), 'https://t-instance123.propr.dev.example.com'); assert.equal(normalizeApiBaseUrl('file:///tmp/propr'), null); + assert.equal(normalizeApiBaseUrl('http://localhost.:4000'), null); + assert.equal(normalizeApiBaseUrl('http://127.1:4000'), null); + assert.equal(normalizeApiBaseUrl('http://0177.0.0.1:4000'), null); + assert.equal(normalizeApiBaseUrl('http://0x7f000001:4000'), null); + assert.equal(normalizeApiBaseUrl('http://[::ffff:127.0.0.1]:4000'), null); + assert.equal(normalizeApiBaseUrl('https://propr.example.com///'), 'https://propr.example.com'); }); it('denies unsafe external browser schemes and credential-bearing URLs', () => { @@ -54,6 +85,10 @@ describe('desktop URL security', () => { isTrustedRendererUrl('http://127.0.0.1:5173/renderer.html', 'http://localhost:5173/', '/unused'), false, ); + assert.equal( + isTrustedRendererUrl('http://127.1:5173/renderer.html', 'http://127.0.0.1:5173/', '/unused'), + false, + ); }); it('retains IPC trust for hash-routed packaged renderer URLs only', () => { @@ -75,6 +110,67 @@ describe('desktop URL security', () => { assert.equal(normalizeDeepLink('propr://user:secret@connect'), null); }); + it('accepts only one bounded canonical Connect API candidate', () => { + const link = 'propr://connect?api=https%3A%2F%2Fconnect.propr.dev'; + assert.equal(connectApiBaseUrlFromDeepLink(link), 'https://connect.propr.dev'); + assert.equal(normalizeDeepLink(link), link); + + const rejected = [ + 'propr://connect', + 'propr://connect?api=', + 'propr://connect?api=https%3A%2F%2Fconnect.propr.dev&api=https%3A%2F%2Fother.example', + 'propr://connect?api=https%3A%2F%2Fconnect.propr.dev&token=secret', + 'propr://connect?url=https%3A%2F%2Fconnect.propr.dev', + 'propr://user:secret@connect?api=https%3A%2F%2Fconnect.propr.dev', + 'propr://connect:443?api=https%3A%2F%2Fconnect.propr.dev', + 'propr://connect/path?api=https%3A%2F%2Fconnect.propr.dev', + 'propr://connect?api=https%3A%2F%2Fconnect.propr.dev#fragment', + 'propr://connect?api=http%3A%2F%2Fconnect.propr.dev', + 'propr://connect?api=https%3A%2F%2Fuser%3Asecret%40connect.propr.dev', + 'propr://connect?api=https%3A%2F%2Fconnect.propr.dev%2Fapi', + 'propr://connect?api=https%3A%2F%2Fconnect.propr.dev%3Ftoken%3Dsecret', + 'propr://connect?api=https%3A%2F%2Fconnect.propr.dev%23secret', + 'propr://connect?api=https%253A%252F%252Fconnect.propr.dev', + ]; + rejected.forEach(candidate => { + assert.equal(connectApiBaseUrlFromDeepLink(candidate), null, candidate); + assert.equal(normalizeDeepLink(candidate), null, candidate); + }); + + const oversized = `propr://connect?api=https%3A%2F%2Fexample.com&${'x'.repeat(2_048)}`; + assert.ok(oversized.length > 2_048); + assert.equal(connectApiBaseUrlFromDeepLink(oversized), null); + assert.equal(normalizeDeepLink(oversized), null); + + const expandedApi = `https://${Array(300).fill('é').join('.')}.example`; + const rawLink = `propr://connect?api=${expandedApi}`; + const expandedCanonicalLink = new URL(rawLink).href; + assert.ok(rawLink.length < 2_048); + assert.ok(expandedCanonicalLink.length > 2_048); + assert.notEqual(connectApiBaseUrlFromDeepLink(rawLink), null); + assert.equal(normalizeDeepLink(rawLink), null); + }); + + it('does not canonicalize malformed reserved Connect origins into trusted candidates', () => { + const rejectedOrigins = [ + 'https://t-instance123.propr.dev/', + 'HTTPS://t-instance123.propr.dev', + 'https://T-instance123.propr.dev', + 'https://t-instance123.propr.dev:443', + 'https://t-instance123.propr.dev:8443', + 'https://t-%69nstance123.propr.dev', + 'https://t-instance123.propr%2edev', + 'https://t-instance123.foo.propr.dev', + 'https://x.t-instance123.propr.dev', + 'https://t-instance123.propr.dev.', + ]; + rejectedOrigins.forEach(origin => { + const link = `propr://connect?api=${encodeURIComponent(origin)}`; + assert.equal(connectApiBaseUrlFromDeepLink(link), null, origin); + assert.equal(normalizeDeepLink(link), null, origin); + }); + }); + it('accepts a normal internal dashboard route from an open deep link', () => { const link = 'propr://open?path=%2Ftasks'; const queryAndHashLink = 'propr://open?path=%2Ftasks%3Fstatus%3Dopen%23recent'; @@ -150,8 +246,83 @@ describe('desktop URL security', () => { assert.match(policy, /frame-src 'none'/); assert.doesNotMatch(policy, /unsafe-eval/); assert.match(policy, /script-src 'self'(?:;|$)/); - assert.match(policy, /http:\/\/\[::1\]:\*/); - assert.match(policy, /ws:\/\/\[::1\]:\*/); + assert.match(policy, /connect-src 'self' https: wss:/); + assert.doesNotMatch(policy, /(?:^|\s)http:(?:\s|;|$)/); + assert.doesNotMatch(policy, /(?:^|\s)ws:(?:\s|;|$)/); + }); + + it('scopes packaged cleartext connections to exact normalized loopback profiles', () => { + const connectSources = (candidate: string): string[] => { + const policy = rendererContentSecurityPolicy(false, [candidate]); + const directive = policy.split('; ').find(value => value.startsWith('connect-src ')); + assert.ok(directive); + return directive.slice('connect-src '.length).split(' '); + }; + + for (const origin of [ + 'http://localhost:4000', + 'http://team.localhost:5173', + 'http://127.0.0.1:3000', + 'http://127.99.2.3:49152', + 'http://[::1]:4000', + ]) { + const sources = connectSources(origin); + assert.ok(sources.includes(origin), origin); + assert.ok(sources.includes(origin.replace(/^http:/, 'ws:')), origin); + assert.ok(sources.includes('https:'), origin); + assert.ok(sources.includes('wss:'), origin); + } + }); + + it('does not admit non-loopback or deceptive cleartext CSP sources', () => { + const rejected = [ + 'http://192.168.1.20:4000', + 'http://example.test:4000', + 'http://localhost.example.test:4000', + 'http://localhost.:4000', + 'http://127.1:4000', + 'http://0177.0.0.1:4000', + 'http://0x7f000001:4000', + 'http://[::ffff:127.0.0.1]:4000', + ]; + const policy = rendererContentSecurityPolicy(false, rejected); + assert.match(policy, /connect-src 'self' https: wss:/); + assert.equal(rejected.some(candidate => policy.includes(candidate)), false); + assert.doesNotMatch(policy, /(?:^|\s)http:(?:\s|;|$)/); + assert.doesNotMatch(policy, /(?:^|\s)ws:(?:\s|;|$)/); + }); + + it('keeps remote HTTPS and WSS scheme support without adding cleartext sources', () => { + const policy = rendererContentSecurityPolicy(false, [ + 'https://propr.example.test', + 'https://t-instance123.propr.dev', + ]); + assert.match(policy, /connect-src 'self' https: wss:/); + assert.doesNotMatch(policy, /(?:^|\s)http:(?:\s|;|$)/); + assert.doesNotMatch(policy, /(?:^|\s)ws:(?:\s|;|$)/); + }); + + it('reloads only the latest current renderer across replacement and overlapping policy changes', () => { + const scheduled: Array<() => void> = []; + const reloads: string[] = []; + const renderer = (name: string) => ({ + isDestroyed: () => false, + reload: () => { reloads.push(name); }, + }); + let currentRenderer = renderer('first'); + const reloadLatest = createLatestRendererReloader( + () => currentRenderer, + callback => { scheduled.push(callback); }, + ); + + reloadLatest(); + currentRenderer = renderer('replacement'); + reloadLatest(); + currentRenderer = renderer('current'); + scheduled[0](); + scheduled[1](); + + assert.deepEqual(reloads, ['current']); }); it('relaxes inline scripts only while Vite serves the development renderer', () => { diff --git a/apps/desktop/src/security.ts b/apps/desktop/src/security.ts index 8b1695840..01bfba16c 100644 --- a/apps/desktop/src/security.ts +++ b/apps/desktop/src/security.ts @@ -1,7 +1,14 @@ +import { + canonicalProprHttpUrlOrigin, + isProprConnectReservedHostAttempt, + MAX_PROPR_API_BASE_URL_LENGTH, + parseProprConnectEndpoint, +} from '@propr/shared'; import { DESKTOP_PROTOCOL } from './shared/contract'; +import { + isProprLoopbackHostname, +} from '@propr/shared'; -// WHATWG URL.hostname retains brackets around IPv6 literals. -const LOOPBACK_HOSTS = new Set(['127.0.0.1', '[::1]', 'localhost']); const DEEP_LINK_ACTIONS = new Set(['connect', 'open']); const DESKTOP_DASHBOARD_ORIGIN = 'https://desktop.propr.invalid'; const RESERVED_DASHBOARD_PARAMETERS = new Set([ @@ -93,27 +100,45 @@ export const dashboardPathFromDeepLink = (value: string): string | null => { return normalizeDesktopDashboardPath(entries[0][1]); }; +export const connectApiBaseUrlFromDeepLink = (value: string): string | null => { + if (value.length > 2_048 || /[\u0000-\u001F\u007F]/.test(value)) return null; + const url = parseUrl(value); + if ( + !url + || url.protocol !== `${DESKTOP_PROTOCOL}:` + || url.hostname !== 'connect' + || hasCredentials(url) + || url.port + || url.hash + || (url.pathname !== '' && url.pathname !== '/') + ) return null; + const entries = [...url.searchParams.entries()]; + if (entries.length !== 1 || entries[0][0] !== 'api') return null; + return normalizeApiBaseUrl(entries[0][1]); +}; + export const normalizeApiBaseUrl = (value: string): string | null => { - const url = parseUrl(value.trim()); + if (value.length > MAX_PROPR_API_BASE_URL_LENGTH) return null; + const candidate = value.trim(); + const url = parseUrl(candidate); if (!url || hasCredentials(url) || url.hash || url.search) return null; - if (url.protocol === 'http:' && !LOOPBACK_HOSTS.has(url.hostname)) return null; - if (url.protocol !== 'http:' && url.protocol !== 'https:') return null; if (url.pathname.replace(/\//g, '') !== '') return null; - return url.origin; + if (isProprConnectReservedHostAttempt(value) && !parseProprConnectEndpoint(value)) return null; + return canonicalProprHttpUrlOrigin(candidate); }; export const isSafeExternalUrl = (value: string): boolean => { const url = parseUrl(value); if (!url || hasCredentials(url)) return false; - return url.protocol === 'https:' - || (url.protocol === 'http:' && LOOPBACK_HOSTS.has(url.hostname)); + return canonicalProprHttpUrlOrigin(value) === url.origin; }; export const validatedDevServerUrl = (value: string | undefined): URL | null => { if (!value) return null; const url = parseUrl(value); - if (!url || url.protocol !== 'http:' || !LOOPBACK_HOSTS.has(url.hostname) || hasCredentials(url)) return null; + if (!url || url.protocol !== 'http:' || !isProprLoopbackHostname(url.hostname) || hasCredentials(url)) return null; if (url.pathname !== '/' || url.search || url.hash) return null; + if (canonicalProprHttpUrlOrigin(value) !== url.origin) return null; return url; }; @@ -125,7 +150,11 @@ export const isTrustedRendererUrl = ( const candidateUrl = parseUrl(candidate); if (!candidateUrl) return false; const devUrl = validatedDevServerUrl(devServerUrl); - if (devUrl) return candidateUrl.origin === devUrl.origin; + if (devUrl) { + return !hasCredentials(candidateUrl) + && canonicalProprHttpUrlOrigin(candidate) === candidateUrl.origin + && candidateUrl.origin === devUrl.origin; + } const packagedUrl = parseUrl(packagedRendererUrl); if (!packagedUrl || hasCredentials(candidateUrl) || candidateUrl.search) return false; return candidateUrl.protocol === packagedUrl.protocol @@ -140,6 +169,8 @@ export const normalizeDeepLink = (value: string): string | null => { if (!DEEP_LINK_ACTIONS.has(url.hostname) || url.port || url.hash) return null; const dashboardPath = url.hostname === 'open' ? dashboardPathFromDeepLink(value) : null; if (url.hostname === 'open' && dashboardPath === null) return null; + const connectApiBaseUrl = url.hostname === 'connect' ? connectApiBaseUrlFromDeepLink(value) : null; + if (url.hostname === 'connect' && connectApiBaseUrl === null) return null; const canonicalCandidate = url.href; if (canonicalCandidate.length > 2_048 || /[\u0000-\u001F\u007F]/.test(canonicalCandidate)) return null; @@ -147,6 +178,10 @@ export const normalizeDeepLink = (value: string): string | null => { url.hostname === 'open' && dashboardPathFromDeepLink(canonicalCandidate) !== dashboardPath ) return null; + if ( + url.hostname === 'connect' + && connectApiBaseUrlFromDeepLink(canonicalCandidate) !== connectApiBaseUrl + ) return null; return canonicalCandidate; }; @@ -158,19 +193,64 @@ export const deepLinkFromArguments = (argv: readonly string[]): string | null => return null; }; -export const rendererContentSecurityPolicy = (development = false): string => [ +const rendererConnectSources = ( + development: boolean, + apiBaseUrls: readonly string[], +): string => { + const sources = new Set(["'self'", 'https:', 'wss:']); + if (development) { + sources.add('http:'); + sources.add('ws:'); + } else { + for (const candidate of apiBaseUrls) { + const origin = normalizeApiBaseUrl(candidate); + if (!origin || !origin.startsWith('http://')) continue; + sources.add(origin); + sources.add(`ws://${origin.slice('http://'.length)}`); + } + } + return [...sources].join(' '); +}; + +export const rendererContentSecurityPolicy = ( + development = false, + apiBaseUrls: readonly string[] = [], +): string => [ "default-src 'self'", `script-src 'self'${development ? " 'unsafe-inline'" : ''}`, "style-src 'self' 'unsafe-inline'", "img-src 'self' data: blob: https:", "font-src 'self' data:", - "connect-src 'self' https: http://127.0.0.1:* http://[::1]:* http://localhost:* ws://127.0.0.1:* ws://[::1]:* ws://localhost:* wss:", + // HTTPS/WSS support remote instances and ProPR Connect. Cleartext sources + // are exact, main-validated active profile origins because CSP has no IPv4 + // CIDR syntax with which to express the normalizer's complete 127/8 range. + `connect-src ${rendererConnectSources(development, apiBaseUrls)}`, "object-src 'none'", "base-uri 'none'", "form-action 'none'", "frame-src 'none'", ].join('; '); +interface ReloadableRenderer { + isDestroyed(): boolean; + reload(): void; +} + +export const createLatestRendererReloader = ( + getCurrentRenderer: () => ReloadableRenderer | null, + schedule: (callback: () => void) => void = callback => { setTimeout(callback, 0); }, +): (() => void) => { + let generation = 0; + return () => { + const scheduledGeneration = ++generation; + schedule(() => { + if (generation !== scheduledGeneration) return; + const renderer = getCurrentRenderer(); + if (renderer && !renderer.isDestroyed()) renderer.reload(); + }); + }; +}; + export const applyDevelopmentRendererCsp = (html: string): string => { const packagedPolicy = rendererContentSecurityPolicy(); if (!html.includes(packagedPolicy)) { diff --git a/apps/desktop/src/session-security.test.ts b/apps/desktop/src/session-security.test.ts new file mode 100644 index 000000000..efbdc9d74 --- /dev/null +++ b/apps/desktop/src/session-security.test.ts @@ -0,0 +1,349 @@ +import assert from 'node:assert/strict'; +import { mkdtemp, rm } from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import { describe, it } from 'node:test'; +import type { Session, WebContents, WebFrameMain } from 'electron'; +import { + DESKTOP_RENDERER_ORIGIN, + DESKTOP_TRANSPORT_SCOPE_HEADER, + PROPR_API_COMPATIBILITY, + PROPR_UI_COMPATIBILITY, +} from '@propr/shared'; +import { DesktopCredentialService } from './credential-service'; +import { ProfileStore, type EncryptionProvider } from './profile-store'; +import { + configureDesktopSessionSecurity, + desktopNetworkPermissionAllowed, + type DesktopNetworkPermissionEvidence, + type DesktopRendererOwnershipEvidence, +} from './session-security'; + +const RENDERER_URL = `${DESKTOP_RENDERER_ORIGIN}/renderer.html`; +const ACTIVE_ORIGIN = 'http://127.0.0.2:41731'; +const TOKEN = `propr_it_${'T'.repeat(43)}`; +const IDENTITY = 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa'; + +const encryption: EncryptionProvider = { + isEncryptionAvailable: () => true, + backend: () => 'keychain', + encrypt: value => Buffer.from(value, 'utf8'), + decrypt: value => value.toString('utf8'), +}; + +const discovery = { + schemaVersion: 1, + product: 'ProPR', + version: '0.8.15', + apiCompatibility: PROPR_API_COMPATIBILITY, + uiCompatibility: PROPR_UI_COMPATIBILITY, + canonicalEndpoint: null, + publicInstanceIdentity: IDENTITY, + desktopAuthentication: { + protocolVersion: 2, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, +}; + +describe('production desktop session security', () => { + it('denies every permission except active trusted-main-frame local network access', () => { + const accepted = { + activeBindingCurrent: true, + decision: 'check' as const, + isMainFrame: true, + mainWindowPresent: true, + permission: 'loopback-network', + rendererDocumentUrlTrusted: true, + requestingOriginAuthorityEqual: true, + requestingOriginAuthorityValid: true, + requestingUrlAuthorityEqual: true, + requestingUrlPresent: false, + requestingUrlTrusted: false, + webContentsEqualsMainWindow: false, + webContentsPresent: false, + }; + assert.equal(desktopNetworkPermissionAllowed(accepted), true); + for (const rejected of [ + { activeBindingCurrent: false }, + { isMainFrame: false }, + { mainWindowPresent: false }, + { permission: 'notifications' }, + { rendererDocumentUrlTrusted: false }, + { requestingOriginAuthorityEqual: false }, + { requestingOriginAuthorityValid: false }, + { webContentsPresent: true }, + ]) { + assert.equal(desktopNetworkPermissionAllowed({ ...accepted, ...rejected }), false); + } + assert.equal(desktopNetworkPermissionAllowed({ ...accepted, permission: 'local-network' }), true); + assert.equal(desktopNetworkPermissionAllowed({ ...accepted, permission: 'local-network-access' }), true); + assert.equal(desktopNetworkPermissionAllowed({ + ...accepted, + decision: 'request', + requestingUrlPresent: true, + requestingUrlTrusted: true, + webContentsEqualsMainWindow: true, + webContentsPresent: true, + }), true); + }); + + it('pins permission and concrete credential transport to the live main renderer and current origin', async () => { + const directory = await mkdtemp(join(tmpdir(), 'propr-session-security-')); + const store = new ProfileStore(directory, encryption); + let connectClaimCurrent = true; + const service = new DesktopCredentialService({ + profiles: store, + clientName: 'Session security test', + openPairingBrowser: async () => undefined, + fetch: async input => input.toString().endsWith('/api/desktop/discovery') + ? new Response(JSON.stringify(discovery), { + status: 200, + headers: { 'Content-Type': 'application/json' }, + }) + : new Response(JSON.stringify({ username: 'octocat' }), { + status: 200, + headers: { 'Content-Type': 'application/json' }, + }), + snapshotConnectIdentityClaim: () => ({ + status: 'unclaimed', + isCurrent: () => connectClaimCurrent, + beginCommit: () => () => undefined, + }), + }); + try { + const profile = await store.save({ id: 'profile-a', label: 'A', apiBaseUrl: ACTIVE_ORIGIN }); + await store.writeCredential({ + version: 2, + profileId: profile.id, + origin: ACTIVE_ORIGIN, + publicInstanceIdentity: IDENTITY, + token: TOKEN, + }); + const ready = await service.probe(profile); + assert.equal(ready.status, 'ready'); + if (ready.status !== 'ready') return; + + type PermissionCheck = ( + webContents: WebContents | null, + permission: string, + requestingOrigin: string, + details: { requestingUrl?: string; isMainFrame: boolean }, + ) => boolean; + type PermissionRequest = ( + webContents: WebContents, + permission: string, + callback: (allowed: boolean) => void, + details: { requestingUrl?: string; isMainFrame: boolean }, + ) => void; + type BeforeSendHeaders = ( + details: { + url: string; + method: string; + resourceType: string; + requestHeaders: Record; + webContentsId: number; + webContents?: WebContents; + frame?: WebFrameMain | null; + }, + callback: (decision: Record) => void, + ) => void; + let permissionCheck: PermissionCheck = () => false; + let permissionRequest: PermissionRequest = () => undefined; + let beforeSendHeaders: BeforeSendHeaders = () => undefined; + const evidence: DesktopNetworkPermissionEvidence[] = []; + const ownershipEvidence: DesktopRendererOwnershipEvidence[] = []; + const desktopSession = { + setPermissionCheckHandler: (handler: PermissionCheck | null) => { + if (handler) permissionCheck = handler; + }, + setPermissionRequestHandler: (handler: PermissionRequest | null) => { + if (handler) permissionRequest = handler; + }, + webRequest: { + onBeforeSendHeaders: (handler: BeforeSendHeaders | null) => { + if (handler) beforeSendHeaders = handler; + }, + onHeadersReceived: () => undefined, + }, + } as unknown as Session; + let destroyed = false; + let rendererUrl = RENDERER_URL; + const mainFrame = { + detached: false, + parent: null, + url: RENDERER_URL, + } as unknown as WebFrameMain; + const mainRenderer = { + id: 41, + getURL: () => rendererUrl, + isDestroyed: () => destroyed, + mainFrame, + } as unknown as WebContents; + const foreignRenderer = { + id: 42, + getURL: () => RENDERER_URL, + isDestroyed: () => false, + } as unknown as WebContents; + configureDesktopSessionSecurity({ + contentSecurityPolicy: () => "default-src 'self'", + credentials: service, + desktopSession, + getMainRenderer: () => mainRenderer, + isTrustedRendererUrl: value => value === RENDERER_URL, + reportNetworkPermissionDecision: record => evidence.push(record), + reportRendererOwnershipDecision: record => ownershipEvidence.push(record), + }); + + const check = ( + webContents: WebContents | null = null, + origin = DESKTOP_RENDERER_ORIGIN, + details: { requestingUrl?: string; isMainFrame: boolean } = { isMainFrame: true }, + ) => permissionCheck(webContents, 'loopback-network', origin, details); + assert.equal(check(), false); + const activated = await service.activate(ready.activationTicket); + assert.equal(check(), true); + assert.equal(check(foreignRenderer, DESKTOP_RENDERER_ORIGIN, { + requestingUrl: RENDERER_URL, + isMainFrame: true, + }), false); + assert.equal(check(null, 'https://attacker.example.test'), false); + assert.equal(check(null, DESKTOP_RENDERER_ORIGIN, { isMainFrame: false }), false); + rendererUrl = 'https://attacker.example.test/renderer.html'; + assert.equal(check(), false); + rendererUrl = RENDERER_URL; + destroyed = true; + assert.equal(check(), false); + destroyed = false; + + let requested = false; + permissionRequest(mainRenderer, 'local-network-access', value => { requested = value; }, { + requestingUrl: RENDERER_URL, + isMainFrame: true, + }); + assert.equal(requested, true); + permissionRequest(foreignRenderer, 'local-network-access', value => { requested = value; }, { + requestingUrl: RENDERER_URL, + isMainFrame: true, + }); + assert.equal(requested, false); + + const intercepted = async ( + url: string, + headers: Record, + webContentsId = mainRenderer.id, + resourceType = 'xhr', + frame: WebFrameMain | null = mainFrame, + omitFrame = false, + ) => await new Promise>(resolve => beforeSendHeaders({ + url, + method: 'GET', + resourceType, + requestHeaders: headers, + webContentsId, + ...(!omitFrame ? { frame } : {}), + }, resolve)); + const scopeHeaders = { + Origin: DESKTOP_RENDERER_ORIGIN, + Authorization: 'Bearer renderer-controlled', + Cookie: 'renderer=must-not-cross', + [DESKTOP_TRANSPORT_SCOPE_HEADER]: activated.transportScope, + }; + assert.deepEqual(await intercepted(`${ACTIVE_ORIGIN}/api/auth/user`, scopeHeaders), { + requestHeaders: { + Origin: DESKTOP_RENDERER_ORIGIN, + Authorization: `Bearer ${TOKEN}`, + }, + }); + assert.deepEqual(await intercepted( + `${ACTIVE_ORIGIN}/api/auth/user`, scopeHeaders, mainRenderer.id, 'xhr', mainFrame, true, + ), { cancel: true }); + assert.equal(ownershipEvidence.at(-1)?.frameOmitted, true); + assert.equal(ownershipEvidence.at(-1)?.rendererOwned, false); + assert.deepEqual(await intercepted( + `${ACTIVE_ORIGIN}/api/auth/user`, scopeHeaders, mainRenderer.id, 'other', mainFrame, true, + ), { cancel: true }); + assert.deepEqual(await intercepted( + `${ACTIVE_ORIGIN}/api/auth/user`, scopeHeaders, mainRenderer.id, 'xhr', null, + ), { cancel: true }); + assert.deepEqual(await intercepted( + `${ACTIVE_ORIGIN}/api/desktop/pairings/dpr_${'A'.repeat(22)}/browser`, + scopeHeaders, + mainRenderer.id, + 'mainFrame', + ), { cancel: true }); + assert.deepEqual(await intercepted(`${ACTIVE_ORIGIN}/api/auth/user`, scopeHeaders, foreignRenderer.id), { + cancel: true, + }); + const childFrame = { + detached: false, + parent: mainFrame, + url: RENDERER_URL, + } as unknown as WebFrameMain; + assert.deepEqual(await intercepted( + `${ACTIVE_ORIGIN}/api/auth/user`, scopeHeaders, mainRenderer.id, 'xhr', childFrame, + ), { cancel: true }); + const foreignDocument = { + detached: false, + parent: null, + url: 'https://attacker.example.test/renderer.html', + } as unknown as WebFrameMain; + assert.deepEqual(await intercepted( + `${ACTIVE_ORIGIN}/api/auth/user`, scopeHeaders, mainRenderer.id, 'xhr', foreignDocument, + ), { cancel: true }); + for (const target of [ + 'http://127.0.0.1:41731/api/side-effect', + 'http://127.0.0.3:41731/api/side-effect', + 'https://192.168.1.10/api/side-effect', + ]) { + assert.deepEqual(await intercepted(target, { + Authorization: 'Bearer renderer-controlled', + Cookie: 'renderer=must-not-cross', + }), { cancel: true }, target); + } + connectClaimCurrent = false; + assert.equal(check(), false); + assert.deepEqual(await intercepted(`${ACTIVE_ORIGIN}/api/auth/user`, scopeHeaders), { cancel: true }); + connectClaimCurrent = true; + assert.equal(check(), true); + destroyed = true; + assert.deepEqual(await intercepted(`${ACTIVE_ORIGIN}/api/auth/user`, scopeHeaders), { cancel: true }); + destroyed = false; + + assert.deepEqual(await service.discardActivation(activated), { discarded: true }); + assert.equal(check(), false); + assert.deepEqual(await intercepted(`${ACTIVE_ORIGIN}/api/side-effect`, { + Authorization: 'Bearer renderer-controlled', + Cookie: 'renderer=must-not-cross', + }), { cancel: true }); + + const revokedReady = await service.probe(profile); + assert.equal(revokedReady.status, 'ready'); + if (revokedReady.status !== 'ready') return; + const revoked = await service.activate(revokedReady.activationTicket); + assert.deepEqual(await service.invalidate({ + profileId: profile.id, + transportScope: revoked.transportScope, + code: 'INSTANCE_TOKEN_REVOKED', + }), { invalidated: true }); + assert.equal(check(), false); + assert.deepEqual(await intercepted(`${ACTIVE_ORIGIN}/api/side-effect`, {}), { cancel: true }); + + assert.ok(evidence.length >= 10); + assert.doesNotMatch( + JSON.stringify(evidence), + /attacker|renderer\.html|127\.0\.0\.2|192\.168|propr_it_/u, + ); + assert.ok(evidence.every(record => Object.keys(record).sort().join(',') === [ + 'activeBindingCurrent', 'allowed', 'decision', 'isMainFrame', 'mainWindowPresent', + 'permissionCategory', 'rendererDocumentUrlTrusted', 'requestingOriginAuthorityEqual', + 'requestingOriginAuthorityValid', 'requestingUrlPresent', 'requestingUrlTrusted', + 'schemaVersion', 'webContentsEqualsMainWindow', 'webContentsPresent', + ].sort().join(','))); + } finally { + await service.dispose(); + await rm(directory, { recursive: true, force: true }); + } + }); +}); diff --git a/apps/desktop/src/session-security.ts b/apps/desktop/src/session-security.ts new file mode 100644 index 000000000..a13e6a0e6 --- /dev/null +++ b/apps/desktop/src/session-security.ts @@ -0,0 +1,292 @@ +import type { Session, WebContents } from 'electron'; +import type { DesktopCredentialService } from './credential-service'; + +const DESKTOP_NETWORK_PERMISSIONS = new Set([ + // Chromium split the original permission into address-space-specific + // permissions. Keep the original spelling for older supported runtimes. + 'local-network-access', + 'local-network', + 'loopback-network', +]); + +export type DesktopNetworkPermissionCategory = + | 'local-network-access' + | 'local-network' + | 'loopback-network'; + +export interface DesktopNetworkPermissionEvidence { + schemaVersion: 1; + permissionCategory: DesktopNetworkPermissionCategory; + decision: 'check' | 'request'; + allowed: boolean; + activeBindingCurrent: boolean; + webContentsPresent: boolean; + webContentsEqualsMainWindow: boolean; + mainWindowPresent: boolean; + isMainFrame: boolean; + requestingUrlPresent: boolean; + requestingUrlTrusted: boolean; + rendererDocumentUrlTrusted: boolean; + requestingOriginAuthorityValid: boolean; + requestingOriginAuthorityEqual: boolean; +} + +export interface DesktopRendererOwnershipEvidence { + schemaVersion: 1; + resourceCategory: 'xhr' | 'webSocket' | 'other'; + mainRendererPresent: boolean; + mainRendererLive: boolean; + webContentsIdMatches: boolean; + webContentsAbsentOrMatches: boolean; + mainFrameLive: boolean; + rendererDocumentTrusted: boolean; + rendererDocumentAuthorityEqual: boolean; + frameOmitted: boolean; + framePresent: boolean; + frameMatchesMainFrame: boolean; + frameExplicitlyForeign: boolean; + rendererOwned: boolean; +} + +const rendererAuthority = (value: string): string | null => { + try { + const url = new URL(value); + if (!url.protocol || !url.hostname || url.username || url.password) return null; + return `${url.protocol}//${url.host}`; + } catch { + return null; + } +}; + +export interface DesktopNetworkPermissionContext extends Omit { + permission: string; + requestingUrlAuthorityEqual: boolean; +} + +/** Local Network Access is available only to the live trusted main frame with a current binding. */ +export const desktopNetworkPermissionAllowed = ({ + activeBindingCurrent, + decision, + isMainFrame, + mainWindowPresent, + permission, + rendererDocumentUrlTrusted, + requestingOriginAuthorityEqual, + requestingOriginAuthorityValid, + requestingUrlAuthorityEqual, + requestingUrlPresent, + requestingUrlTrusted, + webContentsEqualsMainWindow, + webContentsPresent, +}: DesktopNetworkPermissionContext): boolean => DESKTOP_NETWORK_PERMISSIONS.has(permission) + && activeBindingCurrent + && mainWindowPresent + && isMainFrame + && rendererDocumentUrlTrusted + && (!requestingUrlPresent || (requestingUrlTrusted && requestingUrlAuthorityEqual)) + && requestingOriginAuthorityValid + && requestingOriginAuthorityEqual + && (decision === 'check' + ? !webContentsPresent || webContentsEqualsMainWindow + : webContentsPresent && webContentsEqualsMainWindow && requestingUrlPresent); + +interface ConfigureDesktopSessionSecurityOptions { + contentSecurityPolicy(): string; + credentials: DesktopCredentialService; + desktopSession: Session; + enableRendererNetworkBoundary?: boolean; + getMainRenderer(): WebContents | null; + isTrustedRendererUrl(value: string): boolean; + reportNetworkPermissionDecision?(evidence: DesktopNetworkPermissionEvidence): void; + reportRendererOwnershipDecision?(evidence: DesktopRendererOwnershipEvidence): void; +} + +/** Install the production permission, concrete-request, and response boundary on one session. */ +export const configureDesktopSessionSecurity = ({ + contentSecurityPolicy, + credentials, + desktopSession, + enableRendererNetworkBoundary = true, + getMainRenderer, + isTrustedRendererUrl, + reportNetworkPermissionDecision = () => undefined, + reportRendererOwnershipDecision = () => undefined, +}: ConfigureDesktopSessionSecurityOptions): { + close(): void; + dispose(): void; +} => { + const allowNetworkPermission = ( + decision: 'check' | 'request', + webContents: WebContents | null, + permission: string, + requestingOrigin: string, + isMainFrame: boolean, + requestingUrl?: string, + ): boolean => { + const candidate = getMainRenderer(); + const mainRenderer = candidate !== null && !candidate.isDestroyed() ? candidate : null; + const rendererDocumentUrl = mainRenderer?.getURL() ?? ''; + const rendererDocumentAuthority = rendererAuthority(rendererDocumentUrl); + const requestingUrlPresent = typeof requestingUrl === 'string' && requestingUrl.length > 0; + const requestingUrlAuthority = requestingUrlPresent ? rendererAuthority(requestingUrl) : null; + const requestingOriginAuthority = rendererAuthority(requestingOrigin); + const context: DesktopNetworkPermissionContext = { + activeBindingCurrent: credentials.hasActiveRendererBinding(), + decision, + isMainFrame: isMainFrame === true, + mainWindowPresent: mainRenderer !== null, + permission, + rendererDocumentUrlTrusted: mainRenderer !== null && isTrustedRendererUrl(rendererDocumentUrl), + requestingOriginAuthorityEqual: rendererDocumentAuthority !== null + && requestingOriginAuthority === rendererDocumentAuthority, + requestingOriginAuthorityValid: requestingOriginAuthority !== null + && requestingOrigin === requestingOriginAuthority, + requestingUrlAuthorityEqual: !requestingUrlPresent || (rendererDocumentAuthority !== null + && requestingUrlAuthority === rendererDocumentAuthority), + requestingUrlPresent, + requestingUrlTrusted: requestingUrlPresent && isTrustedRendererUrl(requestingUrl), + webContentsEqualsMainWindow: webContents !== null && webContents === mainRenderer, + webContentsPresent: webContents !== null, + }; + const allowed = desktopNetworkPermissionAllowed(context); + if (DESKTOP_NETWORK_PERMISSIONS.has(permission)) { + try { + reportNetworkPermissionDecision({ + schemaVersion: 1, + permissionCategory: permission as DesktopNetworkPermissionCategory, + decision, + allowed, + activeBindingCurrent: context.activeBindingCurrent, + webContentsPresent: context.webContentsPresent, + webContentsEqualsMainWindow: context.webContentsEqualsMainWindow, + mainWindowPresent: context.mainWindowPresent, + isMainFrame: context.isMainFrame, + requestingUrlPresent: context.requestingUrlPresent, + requestingUrlTrusted: context.requestingUrlTrusted, + rendererDocumentUrlTrusted: context.rendererDocumentUrlTrusted, + requestingOriginAuthorityValid: context.requestingOriginAuthorityValid, + requestingOriginAuthorityEqual: context.requestingOriginAuthorityEqual, + }); + } catch { + // Fixed diagnostics cannot alter the permission decision. + } + } + return allowed; + }; + + if (enableRendererNetworkBoundary) { + desktopSession.setPermissionCheckHandler((webContents, permission, requestingOrigin, details) => + allowNetworkPermission( + 'check', + webContents, + String(permission), + requestingOrigin, + details.isMainFrame, + details.requestingUrl, + )); + desktopSession.setPermissionRequestHandler((webContents, permission, callback, details) => { + const requestingUrl = 'requestingUrl' in details && typeof details.requestingUrl === 'string' + ? details.requestingUrl + : undefined; + callback(allowNetworkPermission( + 'request', + webContents, + String(permission), + requestingUrl ? rendererAuthority(requestingUrl) ?? '' : '', + details.isMainFrame, + requestingUrl, + )); + }); + } else { + desktopSession.setPermissionCheckHandler(() => false); + desktopSession.setPermissionRequestHandler((_webContents, _permission, callback) => callback(false)); + } + desktopSession.webRequest.onBeforeSendHeaders((details, callback) => { + const mainRenderer = getMainRenderer(); + const requestingFrame = details.frame; + const mainFrame = mainRenderer?.mainFrame; + const mainRendererLive = mainRenderer !== null && !mainRenderer.isDestroyed(); + const mainFrameLive = mainRendererLive + && mainFrame !== undefined + && mainFrame !== null + && !mainFrame.detached + && mainFrame.parent === null; + const rendererDocumentUrl = mainRendererLive ? mainRenderer.getURL() : ''; + const mainFrameUrl = mainFrameLive ? mainFrame.url : ''; + const rendererDocumentTrusted = mainFrameLive + && isTrustedRendererUrl(rendererDocumentUrl) + && isTrustedRendererUrl(mainFrameUrl); + const rendererDocumentAuthorityEqual = rendererDocumentTrusted + && rendererAuthority(rendererDocumentUrl) !== null + && rendererAuthority(rendererDocumentUrl) === rendererAuthority(mainFrameUrl) + && rendererDocumentUrl === mainFrameUrl; + const webContentsIdMatches = mainRendererLive && details.webContentsId === mainRenderer.id; + const webContentsAbsentOrMatches = mainRendererLive + && (details.webContents === undefined || details.webContents === mainRenderer); + const frameOmitted = requestingFrame === undefined; + const framePresent = requestingFrame !== undefined && requestingFrame !== null; + const frameMatchesMainFrame = framePresent + && mainFrame !== undefined + && mainFrame !== null + && requestingFrame === mainFrame + && !requestingFrame.detached + && isTrustedRendererUrl(requestingFrame.url); + const resourceCategory = details.resourceType === 'xhr' + ? 'xhr' + : details.resourceType === 'webSocket' + ? 'webSocket' + : 'other'; + const rendererOwned = mainRendererLive + && webContentsIdMatches + && webContentsAbsentOrMatches + && frameMatchesMainFrame; + if (details.webContentsId !== undefined) { + try { + reportRendererOwnershipDecision({ + schemaVersion: 1, + resourceCategory, + mainRendererPresent: mainRenderer !== null, + mainRendererLive, + webContentsIdMatches, + webContentsAbsentOrMatches, + mainFrameLive, + rendererDocumentTrusted, + rendererDocumentAuthorityEqual, + frameOmitted, + framePresent, + frameMatchesMainFrame, + frameExplicitlyForeign: framePresent && !frameMatchesMainFrame, + rendererOwned, + }); + } catch { + // Fixed diagnostics cannot alter the renderer ownership decision. + } + } + void credentials.prepareRequestAsync(details.url, details.requestHeaders, { + method: details.method, + ...(enableRendererNetworkBoundary ? { rendererOwned } : {}), + resourceType: details.resourceType, + }).then(callback, () => callback({ cancel: true })); + }); + desktopSession.webRequest.onHeadersReceived((details, callback) => { + callback({ + responseHeaders: { + ...credentials.sanitizeResponseHeaders(details.url, details.responseHeaders ?? {}), + 'Content-Security-Policy': [contentSecurityPolicy()], + }, + }); + }); + return { + close() { + desktopSession.webRequest.onBeforeSendHeaders((_details, callback) => callback({ cancel: true })); + desktopSession.webRequest.onHeadersReceived((_details, callback) => callback({ cancel: true })); + }, + dispose() { + desktopSession.setPermissionCheckHandler(null); + desktopSession.setPermissionRequestHandler(null); + desktopSession.webRequest.onBeforeSendHeaders(null); + desktopSession.webRequest.onHeadersReceived(null); + }, + }; +}; diff --git a/apps/desktop/src/shared/contract.ts b/apps/desktop/src/shared/contract.ts index f34d23298..2fe16b87e 100644 --- a/apps/desktop/src/shared/contract.ts +++ b/apps/desktop/src/shared/contract.ts @@ -9,16 +9,30 @@ export const IPC_CHANNELS = Object.freeze({ profilesSave: 'desktop:profiles-save', profilesRemove: 'desktop:profiles-remove', profilesSetActive: 'desktop:profiles-set-active', - credentialsRead: 'desktop:credentials-read', - credentialsWrite: 'desktop:credentials-write', - credentialsRemove: 'desktop:credentials-remove', + authenticationPair: 'desktop:authentication-pair', + authenticationCancel: 'desktop:authentication-cancel', + connectionProbe: 'desktop:connection-probe', + connectionActivate: 'desktop:connection-activate', + connectionDiscard: 'desktop:connection-discard', + connectionInvalidate: 'desktop:connection-invalidate', + connectDiscover: 'desktop:connect-discover', + connectRediscover: 'desktop:connect-rediscover', lifecycleStatus: 'desktop:lifecycle-status', lifecycleStart: 'desktop:lifecycle-start', lifecycleStop: 'desktop:lifecycle-stop', lifecycleRestart: 'desktop:lifecycle-restart', deepLink: 'desktop:deep-link', + acceptanceJourneyStage: 'desktop:acceptance-journey-stage', } as const); +export type DesktopAcceptanceJourneyStage = + | 'AUTHENTICATION_REQUIRED' + | 'CREDENTIAL_COMMITTED' + | 'AUTHENTICATED_REPROBE_READY' + | 'ACTIVATION_COMMITTED' + | 'ACTIVATION_PUBLISHED' + | 'REACT_CONNECTED'; + export type DesktopPlatform = 'aix' | 'android' | 'darwin' | 'freebsd' | 'haiku' | 'linux' | 'openbsd' | 'sunos' | 'win32' | 'cygwin' | 'netbsd'; @@ -44,6 +58,13 @@ export interface DesktopProfileInput { apiBaseUrl: string; } +/** Secret-free candidate projected by the trusted main-process discovery service. */ +export interface DesktopDiscoveryCandidate { + id: string; + label: string; + apiBaseUrl: string; +} + export interface DesktopProfileList { profiles: DesktopProfile[]; activeProfileId: string | null; @@ -58,13 +79,25 @@ export type StorageSecurity = { reason: 'os-encryption-unavailable' | 'insecure-basic-text-backend'; }; -export type CredentialReadResult = - | { available: false; value: null } - | { available: true; value: string | null }; +export type DesktopConnectionResult = + | { status: 'ready'; version?: string; authentication?: string; activationTicket: string } + | { status: 'authentication-required'; message?: string; version?: string; authentication?: string } + | { status: 'incompatible'; message: string; version?: string } + | { status: 'offline'; message: string }; -export type CredentialWriteResult = - | { stored: true } - | { stored: false; reason: 'encryption-unavailable' }; +export interface DesktopConnectionScope { + profileId: string; + transportScope: string; +} + +export interface DesktopActivatedConnection extends DesktopConnectionScope { + status: 'ready'; + identityEpoch: string; +} + +export interface DesktopAccessInvalidation extends DesktopConnectionScope { + code: string; +} export type LocalLifecycleState = 'disconnected' | 'starting' | 'connected' | 'stopping' | 'error'; @@ -97,10 +130,20 @@ export interface DesktopBridge { remove(profileId: string): Promise; setActive(profileId: string | null): Promise; }; - credentials: { - read(profileId: string): Promise; - write(profileId: string, value: string): Promise; - remove(profileId: string): Promise; + authentication: { + pair(profile: DesktopProfileInput): Promise<{ paired: true }>; + cancel(profileId: string): Promise; + }; + connection: { + probe(profile: DesktopProfileInput): Promise; + activate(activationTicket: string): Promise; + discard(value: DesktopConnectionScope): Promise<{ discarded: boolean }>; + invalidate(value: DesktopAccessInvalidation): Promise<{ invalidated: boolean }>; + }; + discovery: { + supported: boolean; + discover(): Promise; + rediscover(profileId: string): Promise; }; lifecycle: { status(): Promise; @@ -108,4 +151,8 @@ export interface DesktopBridge { stop(): Promise; restart(): Promise; }; + /** @internal Present only in an authorized packaged Connect acceptance process. */ + acceptance?: { + reportJourneyStage(stage: DesktopAcceptanceJourneyStage): Promise; + }; } diff --git a/apps/desktop/src/shutdown.ts b/apps/desktop/src/shutdown.ts new file mode 100644 index 000000000..7ca53e081 --- /dev/null +++ b/apps/desktop/src/shutdown.ts @@ -0,0 +1,117 @@ +import type { RegisteredIpcHandlers } from './ipc'; + +interface ShutdownEvent { + preventDefault(): void; +} + +interface DestructibleWindow { + isDestroyed(): boolean; + destroy(): void; +} + +interface ShutdownOptions { + credentials: { dispose(): Promise }; + lifecycle: { shutdown(): Promise }; + ipc: RegisteredIpcHandlers; + profiles: { close(): Promise }; + sessionSecurity: { close(): void; dispose(): void }; + disposeRendererProtocol(): void; + getWindow(): DestructibleWindow | null; + quit(): void; + onStarted(): void; + log(level: 'info' | 'error', event: string, fields?: Record): void; +} + +interface ShutdownCoordinatorOptions { + drainTimeoutMs?: number; +} + +export interface DesktopShutdownCoordinator { + beforeQuit(event: ShutdownEvent): void; + readonly started: boolean; + awaitFinished(): Promise; +} + +/** + * The single production shutdown order used by Electron and lifecycle tests. + * Admission closes synchronously; admitted service/IPC work drains before the + * profile store, session hooks, handlers, and renderer window are destroyed. + */ +export const createDesktopShutdownCoordinator = ( + options: ShutdownOptions, + coordinatorOptions: ShutdownCoordinatorOptions = {}, +): DesktopShutdownCoordinator => { + let state: 'idle' | 'draining' | 'allow-final-quit' | 'finished' = 'idle'; + let completion: Promise | null = null; + const drainTimeoutMs = coordinatorOptions.drainTimeoutMs ?? 15_000; + const step = (name: string): void => options.log('info', 'desktop.app.shutdown_step', { step: name }); + const bounded = async (promise: Promise, phase: string): Promise => { + let timer: ReturnType | undefined; + const timedOut = await Promise.race([ + promise.then(() => false, error => { + options.log('error', 'desktop.app.shutdown_failed', { phase, error }); + return false; + }), + new Promise(resolve => { + timer = setTimeout(() => resolve(true), drainTimeoutMs); + }), + ]); + if (timer) clearTimeout(timer); + if (timedOut) options.log('error', 'desktop.app.shutdown_forced', { phase, drainTimeoutMs }); + }; + + return { + beforeQuit(event) { + if (state === 'allow-final-quit') { + state = 'finished'; + return; + } + event.preventDefault(); + if (state !== 'idle') { + if (state === 'draining') options.log('info', 'desktop.app.shutdown_retry'); + return; + } + state = 'draining'; + options.onStarted(); + step('admission-closed'); + options.ipc.close(); + step('ipc-closed'); + options.sessionSecurity.close(); + step('session-closed'); + options.disposeRendererProtocol(); + step('protocol-disposed'); + step('credentials-dispose-started'); + const credentialDrain = options.credentials.dispose(); + step('authentication-cleared'); + const lifecycleDrain = options.lifecycle.shutdown(); + step('lifecycle-drain-started'); + const ipcDrain = options.ipc.awaitIdle(); + step('ipc-drain-started'); + completion = bounded(Promise.allSettled([ + credentialDrain, + lifecycleDrain, + ipcDrain, + ]).then(results => { + for (const result of results) if (result.status === 'rejected') throw result.reason; + }), 'service-drain').then(async () => { + step('service-drain-finished'); + step('profiles-close-started'); + await bounded(options.profiles.close(), 'profile-store'); + step('profiles-close-finished'); + options.sessionSecurity.dispose(); + step('session-disposed'); + options.ipc.dispose(); + step('ipc-disposed'); + const window = options.getWindow(); + if (window && !window.isDestroyed()) window.destroy(); + step('window-destroyed'); + options.log('info', 'desktop.app.shutdown'); + state = 'allow-final-quit'; + step('final-quit'); + options.quit(); + }); + }, + get started() { return state !== 'idle'; }, + awaitFinished() { return completion ?? Promise.resolve(); }, + }; +}; diff --git a/apps/desktop/src/smoke-test-authorization.test.ts b/apps/desktop/src/smoke-test-authorization.test.ts index 39058a3c1..49b9cc89f 100644 --- a/apps/desktop/src/smoke-test-authorization.test.ts +++ b/apps/desktop/src/smoke-test-authorization.test.ts @@ -109,7 +109,7 @@ describe('packaged smoke profile authorization', () => { assert.ok(authorization < main.indexOf('new LocalLifecycleController(')); }); - it('registers one-shot lifecycle shutdown before smoke window creation and preserves required evidence order', () => { + it('registers coordinated shutdown before smoke window creation and preserves required evidence order', () => { const main = readFileSync(fileURLToPath(new URL('./main.ts', import.meta.url)), 'utf8'); const installedWindowsAppTest = readFileSync( fileURLToPath(new URL('../scripts/test-installed-windows-app.ps1', import.meta.url)), @@ -119,29 +119,26 @@ describe('packaged smoke profile authorization', () => { const sink = main.indexOf('createPackagedSmokeEvidenceSink(packagedSmokeUserDataDirectory)'); const authorized = main.indexOf("packagedSmokeEvidence?.write('desktop.smoke.authorized')"); const appReady = main.indexOf("log('info', 'desktop.app.ready'"); - const beforeQuit = main.indexOf("app.on('before-quit'"); + const shutdownCoordinator = main.indexOf('const shutdown = createDesktopShutdownCoordinator({'); + const beforeQuit = main.indexOf("app.on('before-quit', event => shutdown.beforeQuit(event));"); const createWindow = main.indexOf('mainWindow = await createMainWindow()'); const mvpReady = main.indexOf("log('info', 'desktop.renderer.mvp_flows.ready'"); + const chooserRestore = main.lastIndexOf('await closePackagedProfileEditorAndWaitForWelcomeChooser(window);'); const layoutReady = main.indexOf("log('info', PACKAGED_LAYOUT_READY_EVENT"); const reducedWindowReady = main.indexOf("log('info', PACKAGED_REDUCED_NATIVE_WINDOW_READY_EVENT"); const rendererReady = main.indexOf("log('info', 'desktop.renderer.ready'"); - const shutdownGuard = main.indexOf('if (shutdownStarted) return;', beforeQuit); - const preventQuit = main.indexOf('event.preventDefault();', beforeQuit); - const startShutdown = main.indexOf('shutdownStarted = true;', beforeQuit); - const lifecycleShutdown = main.indexOf('lifecycle.shutdown()', beforeQuit); - const shutdown = main.indexOf("log('info', 'desktop.app.shutdown'", beforeQuit); - const finalQuit = main.indexOf('app.quit();', shutdown); const willQuit = main.indexOf("app.on('will-quit'"); const sinkClose = main.indexOf('packagedSmokeEvidence?.close()', willQuit); const requiredEvents = installedWindowsAppTest.match(/\$requiredSmokeEvents = @\(([\s\S]*?)\r?\n\)/)?.[1]; assert.ok(isolation < sink && sink < authorized); - assert.ok(authorized < appReady && appReady < beforeQuit && beforeQuit < createWindow); - assert.ok(mvpReady < layoutReady && layoutReady < reducedWindowReady && reducedWindowReady < rendererReady); - assert.ok(beforeQuit < shutdownGuard && shutdownGuard < preventQuit && preventQuit < startShutdown); - assert.ok(startShutdown < lifecycleShutdown && lifecycleShutdown < shutdown && shutdown < finalQuit); - assert.ok(finalQuit < willQuit && willQuit < sinkClose); - assert.equal(main.match(/lifecycle\.shutdown\(\)/g)?.length, 1); + assert.ok(authorized < appReady && appReady < shutdownCoordinator); + assert.ok(shutdownCoordinator < beforeQuit && beforeQuit < createWindow); + assert.equal(main.match(/app\.on\('before-quit', event => shutdown\.beforeQuit\(event\)\);/g)?.length, 1); + assert.notEqual(chooserRestore, -1); + assert.ok(chooserRestore < mvpReady && mvpReady < layoutReady + && layoutReady < reducedWindowReady && reducedWindowReady < rendererReady); + assert.ok(beforeQuit < willQuit && willQuit < sinkClose); assert.deepEqual(Array.from(requiredEvents?.matchAll(/'([^']+)'/g) ?? [], match => match[1]), [ 'desktop.smoke.authorized', 'desktop.app.ready', @@ -152,4 +149,55 @@ describe('packaged smoke profile authorization', () => { 'desktop.app.shutdown', ]); }); + + it('loads the persisted active profile into the packaged policy before creating the first window', () => { + const main = readFileSync(fileURLToPath(new URL('./main.ts', import.meta.url)), 'utf8'); + const initialization = main.indexOf('const credentialInitialization = await credentials.initialize();'); + const persistedProfileRead = main.indexOf('const current = await credentials.listProfiles();', initialization); + const policyInitialization = main.indexOf( + "rendererPolicyOrigins = activeOrigin?.startsWith('http://') ? [activeOrigin] : [];", + persistedProfileRead, + ); + const createWindow = main.indexOf('mainWindow = await createMainWindow()'); + + assert.notEqual(initialization, -1); + assert.notEqual(persistedProfileRead, -1); + assert.notEqual(policyInitialization, -1); + assert.notEqual(createWindow, -1); + assert.ok(initialization < persistedProfileRead); + assert.ok(persistedProfileRead < policyInitialization); + assert.ok(policyInitialization < createWindow); + }); + + it('keeps transport and Connect journey smoke policies pinned without dynamic profile reads', () => { + const main = readFileSync(fileURLToPath(new URL('./main.ts', import.meta.url)), 'utf8'); + const pinning = main.indexOf('const rendererPolicyPinnedForSmoke = transportSmoke !== null'); + const connectJourneyPin = main.indexOf("|| connectSmoke?.journeyEndpoint !== undefined", pinning); + const authorizedProfilePin = main.indexOf( + '|| (packagedSmokeTest && smokeProfileOrigin !== null);', + connectJourneyPin, + ); + const initialization = main.indexOf('const credentialInitialization = await credentials.initialize();'); + const persistedReadGuard = main.indexOf( + 'if (app.isPackaged && !rendererPolicyPinnedForSmoke) {', + initialization, + ); + const persistedProfileRead = main.indexOf( + 'const current = await credentials.listProfiles();', + persistedReadGuard, + ); + const persistedReadGuardEnd = main.indexOf('\n }', persistedProfileRead); + const callbackGuard = main.indexOf('...(app.isPackaged && !rendererPolicyPinnedForSmoke ? {'); + const callback = main.indexOf('onRendererActiveProfileChanged:', callbackGuard); + const callbackGuardEnd = main.indexOf('} : {}),', callback); + const registrationEnd = main.indexOf('});', callbackGuardEnd); + + assert.notEqual(pinning, -1); + assert.ok(pinning < connectJourneyPin && connectJourneyPin < authorizedProfilePin); + assert.ok(authorizedProfilePin < initialization); + assert.ok(initialization < persistedReadGuard && persistedReadGuard < persistedProfileRead); + assert.ok(persistedProfileRead < persistedReadGuardEnd && persistedReadGuardEnd < callbackGuard); + assert.ok(callbackGuard < callback && callback < callbackGuardEnd); + assert.ok(callbackGuardEnd < registrationEnd); + }); }); diff --git a/apps/desktop/src/window-options.test.ts b/apps/desktop/src/window-options.test.ts index 27cd1d0aa..304478136 100644 --- a/apps/desktop/src/window-options.test.ts +++ b/apps/desktop/src/window-options.test.ts @@ -11,6 +11,14 @@ import { const normalWorkArea = { x: 0, y: 0, width: 1920, height: 1040 }; describe('desktop BrowserWindow security', () => { + it('uses the production 1280x820 size with safe minimum dimensions', () => { + const options = createBrowserWindowOptions('/app/preload.cjs', false, normalWorkArea, 'win32'); + assert.deepEqual( + { width: options.width, height: options.height, minWidth: options.minWidth, minHeight: options.minHeight }, + { width: 1280, height: 820, minWidth: 880, minHeight: 620 }, + ); + }); + it('isolates and sandboxes the renderer without Node or webviews', () => { const options = createBrowserWindowOptions('/app/preload.cjs', true, normalWorkArea, 'linux'); assert.deepEqual(options.webPreferences, { diff --git a/docker/Dockerfile.app.prod b/docker/Dockerfile.app.prod index 29c22d511..79d8e3cd9 100644 --- a/docker/Dockerfile.app.prod +++ b/docker/Dockerfile.app.prod @@ -15,6 +15,7 @@ RUN apk add --no-cache python3 make g++ git # Copy workspace manifests first so npm ci layer caches when source changes. COPY package*.json ./ COPY packages/shared/package*.json ./packages/shared/ +COPY packages/local-setup/package*.json ./packages/local-setup/ COPY packages/core/package*.json ./packages/core/ COPY packages/api/package*.json ./packages/api/ @@ -29,11 +30,13 @@ COPY config ./config COPY scripts ./scripts COPY knexfile.ts ./ COPY packages/shared ./packages/shared +COPY packages/local-setup ./packages/local-setup COPY packages/core ./packages/core COPY packages/api ./packages/api # Build workspace packages in dependency order, then root. RUN cd packages/shared && npm run build \ + && cd ../local-setup && npm run build \ && cd ../core && npm run build \ && cd ../.. && npm run build @@ -79,6 +82,8 @@ COPY --from=builder /build/package*.json ./ COPY --from=builder /build/dist ./dist COPY --from=builder /build/packages/shared/package.json ./packages/shared/ COPY --from=builder /build/packages/shared/dist ./packages/shared/dist +COPY --from=builder /build/packages/local-setup/package.json ./packages/local-setup/ +COPY --from=builder /build/packages/local-setup/dist ./packages/local-setup/dist COPY --from=builder /build/packages/core/package.json ./packages/core/ COPY --from=builder /build/packages/core/dist ./packages/core/dist COPY --from=builder /build/packages/api/package.json ./packages/api/ diff --git a/docker/launcher/orchestrator.mjs b/docker/launcher/orchestrator.mjs index 311e458d8..e6e64b9fe 100644 --- a/docker/launcher/orchestrator.mjs +++ b/docker/launcher/orchestrator.mjs @@ -43,11 +43,11 @@ export const DEFAULT_CLOUDFLARED_IMAGE = 'cloudflare/cloudflared:2024.12.2'; export const DEFAULT_PROPR_UI_ORIGIN = 'https://app.propr.dev'; // Whether an instance id is a valid single DNS label for the proxy hostname -// (t-.propr.dev): 1–63 chars, ASCII letters/digits/hyphens only, no -// leading/trailing hyphen. Mirrors isValidProprInstanceId() in the shared pkg. +// (t-.propr.dev): 1–61 chars (leaving room for `t-`), ASCII +// letters/digits/hyphens only, no leading/trailing hyphen. export function isValidProprInstanceId(instanceId) { const id = (instanceId ?? '').trim(); - return /^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$/i.test(id); + return /^[a-z0-9]([a-z0-9-]{0,59}[a-z0-9])?$/i.test(id); } // Derive the per-instance public API/UI URL (https://t-.propr.dev) @@ -61,36 +61,40 @@ export function proprInstanceProxyUrl(instanceId) { return isValidProprInstanceId(id) ? `https://${PROPR_UI_PROXY_LABEL_PREFIX}${id.toLowerCase()}.${PROPR_UI_PROXY_SUFFIX}` : undefined; } +export function canonicalProprProxyUrl(url) { + if (!url || url !== url.trim() || /[^\x20-\x7e]/.test(url)) return undefined; + try { + const parsed = new URL(url); + if (parsed.protocol !== 'https:' || parsed.username !== '' || parsed.password !== '' + || parsed.port !== '' || parsed.pathname !== '/' || parsed.search !== '' || parsed.hash !== '') return undefined; + const suffix = `.${PROPR_UI_PROXY_SUFFIX}`; + if (!parsed.hostname.endsWith(suffix)) return undefined; + const label = parsed.hostname.slice(0, -suffix.length); + if (label.length > 63 || label.includes('.') || !label.startsWith(PROPR_UI_PROXY_LABEL_PREFIX)) return undefined; + const id = label.slice(PROPR_UI_PROXY_LABEL_PREFIX.length); + if (!isValidProprInstanceId(id)) return undefined; + const canonical = `https://${PROPR_UI_PROXY_LABEL_PREFIX}${id.toLowerCase()}.${PROPR_UI_PROXY_SUFFIX}`; + return url === canonical ? canonical : undefined; + } catch { + return undefined; + } +} + // Whether a URL is a hosted per-instance proxy URL (https://t-.propr.dev). // propr-routing only forwards /api/* and /socket.io/* on these hosts, so the // tunnel base URL must be one of them. Requires exactly one t- // label before the suffix (other propr.dev hosts and nested hosts are rejected) -// and a bare origin (a non-root path/query/fragment is rejected so +// and the exact lowercase ASCII bare origin (a slash/path/query/fragment is rejected so // proprTunnelEndpoints does not double up the /api prefix). Mirrors // isProprProxyUrl() in the shared pkg. export function isProprProxyUrl(url) { - if (!url) return false; - try { - const { protocol, hostname, pathname, search, hash } = new URL(url); - if (protocol !== 'https:') return false; - // Trailing slashes are tolerated; any real path segment/query/fragment - // is rejected so a base path can't double up the appended /api prefix. - if (/[^/]/.test(pathname) || search || hash) return false; - const suffix = `.${PROPR_UI_PROXY_SUFFIX}`; - if (!hostname.endsWith(suffix)) return false; - const label = hostname.slice(0, -suffix.length); - if (label.includes('.') || !label.startsWith(PROPR_UI_PROXY_LABEL_PREFIX)) { - return false; - } - return isValidProprInstanceId(label.slice(PROPR_UI_PROXY_LABEL_PREFIX.length)); - } catch { - return false; - } + return typeof url === 'string' + && /^https:\/\/t-(?:[a-z0-9]|[a-z0-9][a-z0-9-]{0,59}[a-z0-9])\.propr\.dev$/.test(url); } function normalizeProprInstanceId(instanceId) { const id = (instanceId ?? '').trim(); - return id.startsWith(PROPR_UI_PROXY_LABEL_PREFIX) + return id.toLowerCase().startsWith(PROPR_UI_PROXY_LABEL_PREFIX) ? id.slice(PROPR_UI_PROXY_LABEL_PREFIX.length) : id; } @@ -216,9 +220,14 @@ function envFileValueFrom(envFileLocal, name) { * `check`/`init` commands to inspect HOST_*_DIR settings without re-reading. */ export function readEnvFile(envFilePath) { + if (!envFilePath || !isReadableFile(envFilePath)) return {}; + return parseEnvFileContents(readFileSync(envFilePath, 'utf8')); +} + +/** Parse already-authorized env bytes without reopening their pathname. */ +export function parseEnvFileContents(contents) { const out = {}; - if (!envFilePath || !isReadableFile(envFilePath)) return out; - for (const rawLine of readFileSync(envFilePath, 'utf8').split(/\r?\n/)) { + for (const rawLine of contents.split(/\r?\n/)) { const parsed = parseEnvAssignment(rawLine); if (parsed) out[parsed.name] = parsed.value; } @@ -251,10 +260,15 @@ export function resolveConfig(env = process.env, overrides = {}) { // from the CLI/launcher process environment. Inspect that exact source so a // developer's shell NODE_ENV cannot accidentally describe (or alter) the // packaged container runtime. - const nodeEnv = readEnvFile(envFileLocal).NODE_ENV || undefined; + const authorizedEnvFileValues = overrides.envFileValues; + const nodeEnv = (authorizedEnvFileValues ?? readEnvFile(envFileLocal)).NODE_ENV || undefined; // value precedence: explicit override → process env → .env file - const get = (name) => env[name] !== undefined ? env[name] : envFileValueFrom(envFileLocal, name) || undefined; + const get = (name) => env[name] !== undefined + ? env[name] + : authorizedEnvFileValues + ? authorizedEnvFileValues[name] || undefined + : envFileValueFrom(envFileLocal, name) || undefined; const hostData = overrides.hostData ?? env.PROPR_DATA_DIR; const hostLogs = overrides.hostLogs ?? env.PROPR_LOGS_DIR; @@ -338,12 +352,10 @@ export function resolveConfig(env = process.env, overrides = {}) { const cloudflaredImage = get('PROPR_CLOUDFLARED_IMAGE') || manifest.images.cloudflared || DEFAULT_CLOUDFLARED_IMAGE; // Explicit URL wins; otherwise derive from the instance id's proxy hostname. // Falls back to undefined for local development (no instance id), where - // API_PUBLIC_URL / FRONTEND_URL keep their localhost defaults below. Trailing - // slashes are stripped once here so every consumer (API/worker/UI env, status - // output, endpoint rendering) sees one canonical form — the derived URL never - // has one, but an explicit PROPR_UI_PUBLIC_API_URL might. - const uiPublicApiUrl = - (get('PROPR_UI_PUBLIC_API_URL') || proprInstanceProxyUrl(proprInstanceId))?.replace(/\/+$/, '') || undefined; + // API_PUBLIC_URL / FRONTEND_URL keep their localhost defaults below. Preserve + // explicit raw spelling so validation cannot turn an alternate reserved + // Connect spelling into a trusted canonical endpoint. + const uiPublicApiUrl = get('PROPR_UI_PUBLIC_API_URL') || proprInstanceProxyUrl(proprInstanceId) || undefined; return Object.freeze({ stack, network, envFileLocal, envFileHost, nodeEnv, @@ -507,11 +519,13 @@ export function validateDockerBindPath(name, value, { containerPath = false } = const REMOTE_IMAGE_CHECK_TIMEOUT_MS = 5000; -export function docker(args, { capture = false, timeout } = {}) { +export function docker(args, { capture = false, timeout, env, maxBuffer } = {}) { const res = spawnSync('docker', args, { stdio: capture ? ['ignore', 'pipe', 'pipe'] : 'inherit', encoding: 'utf8', timeout, + env, + maxBuffer, }); if (res.status !== 0 && !capture) { const detail = res.error?.message || (res.signal ? `signal ${res.signal}` : `code ${res.status}`); @@ -1474,7 +1488,7 @@ export async function runMigrationPhaseAsync(cfg, { onLog, freshnessCache } = {} /** Async mirror of getStackStatus. */ export async function getStackStatusAsync(cfg) { - const res = await dockerAsync(STACK_STATUS_PS_ARGS); + const res = await dockerAsync(stackStatusPsArgs(cfg)); return parseStackStatus(cfg, res.stdout); } @@ -1565,16 +1579,76 @@ export function parseStackStatus(cfg, stdout) { return { stack: cfg.stack, network: cfg.network, running: anyRunning, services }; } -const STACK_STATUS_PS_ARGS = ['ps', '-a', '--format', '{{.Names}}\t{{.State}}\t{{.Status}}\t{{.Ports}}']; +const STACK_STATUS_MAX_BYTES = 64 * 1024; + +function stackStatusPsArgs(cfg) { + // `cfg.stack` has already passed the Docker-name validation before Connect + // reaches this boundary. Keep the label expression in one argv element so + // neither a shell nor Docker's fuzzy name matching can broaden discovery. + if (typeof cfg?.stack !== 'string' || cfg.stack.length > 128 || !/^[A-Za-z0-9][A-Za-z0-9_.-]*$/.test(cfg.stack)) { + throw new Error('Docker stack status scope is invalid'); + } + return [ + 'ps', + '-a', + '--filter', + `label=propr.stack=${cfg.stack}`, + '--format', + '{{.Names}}\t{{.State}}\t{{.Status}}\t{{.Ports}}', + ]; +} + +/** + * Run and strictly validate one bounded Docker status inspection. The command + * result is retained so callers can distinguish an absent service (a successful + * empty inspection) from a missing binary, daemon error, timeout, signal, or + * truncated/malformed output. + */ +export function inspectStackStatus(cfg, { timeout, env } = {}) { + let args; + try { + args = stackStatusPsArgs(cfg); + } catch (error) { + return { result: { status: null, stdout: '', stderr: '', error } }; + } + const result = docker(args, { + capture: true, + timeout, + env, + maxBuffer: STACK_STATUS_MAX_BYTES, + }); + if (result.status !== 0 || result.error || result.signal || typeof result.stdout !== 'string') { + return { result }; + } + + const expectedNames = new Set(SERVICES.map((service) => `${cfg.stack}-${service}`)); + const seenExpectedNames = new Set(); + const validStates = new Set(['created', 'running', 'paused', 'restarting', 'removing', 'exited', 'dead']); + for (const line of result.stdout.split('\n')) { + if (line === '') continue; + const fields = line.endsWith('\r') ? line.slice(0, -1).split('\t') : line.split('\t'); + if (fields.length !== 4) return { result }; + const [name, state, status] = fields; + if (!/^[A-Za-z0-9][A-Za-z0-9_.-]*$/.test(name) || !validStates.has(state) || status.length === 0) { + return { result }; + } + // The daemon-side label filter is a scope reduction, not an authority + // assertion. Every row returned for the target label must still be one + // of this stack's canonical service containers, exactly once. + if (!expectedNames.has(name) || seenExpectedNames.has(name)) return { result }; + seenExpectedNames.add(name); + } + return { result, status: parseStackStatus(cfg, result.stdout) }; +} /** Per-service state for the whole stack, discovered by canonical container name. */ -export function getStackStatus(cfg) { - const res = docker(STACK_STATUS_PS_ARGS, { capture: true }); +export function getStackStatus(cfg, { timeout } = {}) { + const res = docker(stackStatusPsArgs(cfg), { capture: true, timeout }); return parseStackStatus(cfg, res.stdout); } -export function getServiceState(cfg, service) { - return getStackStatus(cfg).services.find((s) => s.service === service); +export function getServiceState(cfg, service, opts) { + return getStackStatus(cfg, opts).services.find((s) => s.service === service); } // Best-effort GET /api/status behind a hard timeout. propr-routing diff --git a/docs/docs/features/propr-cli.md b/docs/docs/features/propr-cli.md index f16973ddc..869049414 100644 --- a/docs/docs/features/propr-cli.md +++ b/docs/docs/features/propr-cli.md @@ -104,6 +104,7 @@ The hosted ProPR UI at `https://app.propr.dev` can drive a locally-running stack | `propr tunnel on` | Start the cloudflared sidecar; requires a configured token and a running stack (`--force` starts it ahead of the stack) | | `propr tunnel off` | Stop the sidecar; the token and env values are left untouched | | `propr tunnel verify` | Check the sidecar plus the public `/api/status` (expects OK/auth), `/` (expects 404), and `/socket.io/` (expects reachable) | +| `propr connect status --json --root ` | Emit the bounded secret-free desktop discovery contract and verify that the remote API origin and public stack identity match | Architecture, the full configuration, enablement semantics, verification, and troubleshooting live on the dedicated [Hosted UI Tunnel](../operations/hosted-ui-tunnel.md) page — including the two facts that catch operators most often: `PROPR_UI_TUNNEL_TOKEN` is a live Cloudflare credential to keep out of source control and logs, and enabling the tunnel on an already-running stack requires `propr start --restart` (or `propr tunnel setup --start`) before OAuth redirects and cookies use the hosted URLs. diff --git a/docs/docs/operations/configuration-reference.md b/docs/docs/operations/configuration-reference.md index e5674d91a..30d2ef989 100644 --- a/docs/docs/operations/configuration-reference.md +++ b/docs/docs/operations/configuration-reference.md @@ -133,7 +133,7 @@ Optional: expose a local stack's API to the hosted control plane at `https://app |---|---|---|---| | `PROPR_UI_TUNNEL_TOKEN` | Unset | Cloudflare Tunnel token; setting it enables the tunnel on the next `propr start` (unless you ran `propr tunnel off`). This is a **live credential** — anyone with it can route traffic through your tunnel. Keep it in `.env` only; never commit, log, or share it. | Tunnel mode. | | `PROPR_UI_TUNNEL_ENABLED` | Unset | `true`/`1` explicitly enables the tunnel. A token is still required — `propr check` fails without one. Redundant when a token is set. | Optional. | -| `PROPR_INSTANCE_ID` | Unset | This stack's instance id — a valid DNS label (letters, digits, hyphens; 1–63 chars). Derives the public URL `https://t-.propr.dev`. | Tunnel mode, unless an explicit URL is set. | +| `PROPR_INSTANCE_ID` | Unset | This stack's instance id — letters, digits, and hyphens; 1–61 characters so the full `t-` DNS label remains valid. Derives the public URL `https://t-.propr.dev`. | Tunnel mode, unless an explicit URL is set. | | `PROPR_UI_PUBLIC_API_URL` | Derived from `PROPR_INSTANCE_ID` | Explicit public API URL the hosted UI talks to; overrides the derived one. | Override only. | | `PROPR_CLOUDFLARED_IMAGE` | `cloudflare/cloudflared:2024.12.2` (pinned) | The cloudflared sidecar image. | Override only. | diff --git a/docs/docs/operations/desktop-pairing.md b/docs/docs/operations/desktop-pairing.md index 5d2e035a7..baafeac4c 100644 --- a/docs/docs/operations/desktop-pairing.md +++ b/docs/docs/operations/desktop-pairing.md @@ -2,24 +2,30 @@ Packaged desktop clients authenticate to one ProPR instance with an opaque instance token. They never receive or persist a GitHub access or refresh token. -Protocol version 1 is designed for the Electron main process (or another trusted -native process); renderer code must communicate with it through a narrow IPC -bridge and must not read the device secret or instance token. +Desktop authentication protocol version 2 is designed for the Electron main +process (or another trusted native process); renderer code must communicate with +it through a narrow IPC bridge and must not read the device secret or instance +token. ## Discovery -Before login, call `GET /api/desktop/discovery` (or the existing -`GET /api/compatibility`). The dedicated response is deliberately limited to -the product name, release/API/UI compatibility values, and this capability: +Before login, call `GET /api/desktop/discovery`. The discovery document retains +schema version 1 and advertises desktop authentication protocol version 2. It is +deliberately limited to the exact product, release/API/UI compatibility, +canonical managed endpoint, random public installation identity, and +authentication capabilities: ```json { + "schemaVersion": 1, "product": "ProPR", "version": "0.8.15", "apiCompatibility": "2026-06-27", "uiCompatibility": "2026-06-27", + "canonicalEndpoint": "https://t-abc123.propr.dev", + "publicInstanceIdentity": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa", "desktopAuthentication": { - "protocolVersion": 1, + "protocolVersion": 2, "browserPairing": true, "instanceBearerTokens": true, "socketIoBearerAuthentication": true @@ -27,14 +33,38 @@ the product name, release/API/UI compatibility values, and this capability: } ``` +Consumers must parse the entire schema-v1 document and require desktop +authentication protocol version 2 before using any field. The version is +canonical SemVer; both compatibility values are canonical `YYYY-MM-DD` versions; +the identity is an exact lowercase UUIDv4; and the endpoint is either `null` +during restart/configuration or the bare canonical +`https://t-.propr.dev` origin. Every capability key is required and every +capability value is a JSON boolean. Missing, extra, duplicate, oversized, +coerced, malformed, or non-canonical fields are incompatible discovery, never +partial readiness. Native and shared-client consumers use the same bounded wire +parser. + +The public identity is not a credential. It is randomly created in the stack's +private durable `data/` directory and is shared by the host CLI and root-running +API container. The directory remains owned by the host caller with mode `0700`. +The single-link regular identity file may be owned by that host caller or by the +root API container account; it is never group/world writable, and a root-owned +file remains host-readable. Creation writes and fsyncs a private same-directory +temporary, publishes without replacing a concurrent winner, and fsyncs the +directory. Normal restarts, upgrades, and tunnel rotation preserve the value; +replacing the durable data directory creates a new identity. + Discovery is rate limited per trusted network address. A `false` capability -means the deployment (for example, public demo mode) must not be paired. +means the deployment (for example, public demo mode) must not be paired. The +legacy `GET /api/compatibility` metadata is not a substitute for the schema-v1 +discovery and identity contract. ## Pairing sequence -1. The trusted desktop process sends `POST /api/desktop/pairings` with - `{"clientName":"Alice's MacBook"}`. `clientName` is printable text from 1 - through 80 characters. +1. The trusted desktop process repeats strict unauthenticated discovery at the + exact candidate origin. It then sends `POST /api/desktop/pairings` with the + client name and its main-owned profile/origin/scope/credential-generation + binding. `clientName` is printable text from 1 through 80 characters. 2. A `201` response contains `pairingId`, `deviceSecret`, `approvalUrl`, `expiresAt`, and `interval` (seconds). Both identifiers have at least 128 bits of entropy; the device secret has 256 bits. Store the secret only in trusted @@ -75,7 +105,15 @@ Keychain, Windows Credential Manager, or Linux Secret Service. Never put it in `localStorage`, IndexedDB, renderer state, a pairing URL, logs, crash reports, or analytics. Keep the instance origin with the credential and refuse to send it to another origin. Treat TLS certificate failures as terminal; HTTP is accepted -only for loopback development. +only for loopback development. Persist the discovery `publicInstanceIdentity` +with the encrypted credential and bind it atomically to the profile ID, +canonical origin, and credential generation. Before a stored token is used +after launch, reconnect, profile switch, or tunnel rotation, repeat +unauthenticated strict discovery at that exact origin. An absent, malformed, or +different identity produces no bearer-, cookie-, or socket-authenticated +request, durably detaches the old credential, and requires a new pairing +generation. Legacy credentials without this binding fail closed and are removed +locally during migration. The server stores SHA-256 token and device-secret hashes, never plaintext. Token rows retain the owner GitHub ID/profile snapshot, creation and last-use times, diff --git a/docs/docs/operations/hosted-ui-tunnel.md b/docs/docs/operations/hosted-ui-tunnel.md index f271b46d1..ae81fce1f 100644 --- a/docs/docs/operations/hosted-ui-tunnel.md +++ b/docs/docs/operations/hosted-ui-tunnel.md @@ -46,7 +46,7 @@ The hosted PWA's manifest, service worker, installation, notification permission ### Compatibility check -Before the hosted UI starts its normal auth/session checks, it calls the public `/api/compatibility` endpoint on the selected API origin. The endpoint returns the local stack version plus the API/UI compatibility contract. If the hosted UI cannot support that contract, it stops at a clear version-mismatch screen instead of running against incompatible endpoints or Socket.IO events. `/api/status` includes the same metadata for authenticated diagnostics. +Before the hosted UI starts its normal auth/session checks, it calls the public `/api/compatibility` endpoint on the selected API origin. Desktop discovery uses the separately bounded, rate-limited, cache-disabled `/api/desktop/discovery` response. That response adds only the canonical managed endpoint and the stack's random public installation identity to version/capability metadata; it contains no credential or account state. Desktop main preserves that identity through Connect confirmation and encrypted profile persistence, then revalidates it without credentials before stored REST or Socket.IO authentication. Tunnel endpoint or identity rotation therefore creates a fresh pairing generation; no prior-origin credential, socket, or cookie state is carried across. If the hosted UI cannot support the compatibility contract, it stops at a clear version-mismatch screen instead of running against incompatible endpoints or Socket.IO events. `/api/status` includes the same version metadata for authenticated diagnostics. Only a **definitive** mismatch (the API reports a contract the UI knows it is too old or too new for) hard-blocks. A v1 rollout exception applies when the metadata is simply *absent* — an older API that predates `/api/compatibility` (returns 404) or returns no contract: the UI logs a console warning and continues, so an otherwise-working stack is never trapped mid-upgrade. This soft-warning fallback is temporary; once publishing the compatibility contract is a baseline expectation, missing metadata is intended to become a hard block like any other mismatch. @@ -62,7 +62,7 @@ This writes the tunnel `.env` values for you (`PROPR_UI_TUNNEL_TOKEN`, `PROPR_IN ### Manual `.env` fallback -For older CLI versions or manual recovery, set the same values in the stack `.env`. Replace `abc123` with your instance id (a valid DNS label: letters, digits, hyphens; 1-63 chars): +For older CLI versions or manual recovery, set the same values in the stack `.env`. Replace `abc123` with your instance id (letters, digits, and hyphens; 1-61 chars so the complete `t-` DNS label stays within 63 characters): ```bash # --- Hosted UI tunnel (v1, optional) --- @@ -123,6 +123,20 @@ propr tunnel verify It exits non-zero if any check fails. `propr status` probes `/api/status` for tunnel reachability for the same reason — the root `/` and the legacy `/health` path are unrouted through the tunnel. +### Secret-free desktop discovery + +Desktop invokes an explicit stack root; the CLI never scans for installations: + +```bash +propr connect status --json --root /explicit/stack/root +``` + +Stdout is exactly one schema-versioned JSON document. It reports only the canonical endpoint, public installation identity, configured/enabled/sidecar/API readiness, restart requirement, compatibility/version, and bounded reason codes. `configured` means that a valid canonical endpoint exists; it deliberately says nothing about whether any credential is present. Diagnostics go to stderr. It never reports token presence or values, GitHub/account/repository identity, host details, environment contents, or filesystem paths. Exit codes are stable: `0` ready, `2` known not ready, `3` incompatible discovery/API, `4` invalid configuration/root, `5` probe timeout, and `1` internal failure. + +The public identity is generated randomly in the stack's durable `data/` boundary. It survives normal restart, image upgrade, and tunnel rotation. Replacing/reinitializing that durable stack data generates a new identity. A sidecar is not `apiReady` until the remote discovery response matches both the expected canonical origin and this identity; consequently, `propr tunnel on` without an API restart reports `restartRequired` instead of a false-ready endpoint. + +ProPR Connect permanently retires a deleted managed tunnel hostname and does not reassign it to another installation. Identity matching remains mandatory defense in depth against stale DNS, proxy configuration, restore mistakes, and any failure of that allocation guarantee. + ## Troubleshooting The most common failures, in the order to check them: diff --git a/package-lock.json b/package-lock.json index 3ccd7e824..d52857bea 100644 --- a/package-lock.json +++ b/package-lock.json @@ -23,6 +23,7 @@ "@octokit/core": "^7.0.2", "@octokit/plugin-paginate-rest": "^13.1.1", "@propr/core": "^0.8.15", + "@propr/local-setup": "^0.8.15", "better-sqlite3": "^11.7.0", "bullmq": "^5.81.3", "cors": "^2.8.5", @@ -75,6 +76,11 @@ "name": "@propr/desktop", "version": "0.8.15", "license": "Apache-2.0", + "dependencies": { + "@propr/cli": "*", + "@propr/client": "*", + "@propr/shared": "*" + }, "devDependencies": { "@electron-forge/cli": "8.0.0-alpha.10", "@electron-forge/maker-deb": "8.0.0-alpha.10", @@ -87,6 +93,7 @@ "@types/node": "^22.10.0", "@vitejs/plugin-react": "^4.6.0", "electron": "^44.0.0", + "socket.io": "^4.8.1", "tsx": "^4.21.0", "typescript": "^5.9.3", "vite": "^7.3.5" @@ -14798,6 +14805,7 @@ "version": "0.8.15", "dependencies": { "@propr/core": "^0.8.15", + "@propr/local-setup": "^0.8.15", "@propr/shared": "^0.8.15", "@types/multer": "^2.0.0", "bullmq": "^5.81.3", diff --git a/package.json b/package.json index 022e63099..8e6a6e4b0 100644 --- a/package.json +++ b/package.json @@ -19,14 +19,15 @@ "lint": "eslint src/", "typecheck": "tsc --noEmit", "test": "node --test", - "test:prepare": "npm run build --workspace=packages/shared && npm run build --workspace=packages/core && npm run build --workspace=packages/local-setup && npm run build --workspace=packages/cli", + "test:prepare": "npm run build --workspace=packages/shared && npm run build --workspace=packages/client && npm run build --workspace=packages/core && npm run build --workspace=packages/local-setup && npm run build --workspace=packages/cli", "test:server": "node scripts/run-test-suite.mjs", "test:full:prepared": "npm run test:server", "test:full": "npm run test:prepare && npm run test:full:prepared", "test:notifications:server": "node scripts/run-test-suite.mjs test/notificationSchema.test.ts test/notificationPreferenceMigration.test.ts packages/core/test/notificationService.test.ts packages/core/test/planNotificationActionsMigration.test.ts packages/core/test/pushSubscriptionExpiration.test.ts packages/api/test/notificationRoutes.test.ts packages/api/test/notificationManagementRoutes.test.ts packages/api/test/notificationProjectionService.test.ts packages/api/test/webPushDispatcher.test.ts", "test:notifications:ui": "npm --workspace propr-ui test -- src/api/notificationApi.test.ts src/serviceWorker.test.ts src/serviceWorkerRegistration.test.ts src/hooks/useBrowserPush.test.tsx src/pages/SettingsPage/NotificationSettingsSection.test.tsx src/pages/InboxPage.test.tsx src/pages/inboxUtils.test.ts src/components/Inbox/NotificationActions.test.tsx src/components/MobileBottomNavigation.test.tsx src/contexts/NotificationCenterContext.test.tsx src/utils/notificationIntents.test.ts src/pages/PlanStudioPage.notificationIntent.test.tsx src/components/TaskPlanner/PlanEditor.notificationIntent.test.tsx src/components/TaskPlanner/PlanIssuesManager.notificationIntent.test.tsx src/components/TaskPlanner/PlanEditor.responsive.test.tsx", "test:notifications": "npm run build -w @propr/shared && npm run build -w @propr/core && npm run test:notifications:server && npm run test:notifications:ui", - "test:unit": "NODE_ENV=test npx tsx --experimental-test-module-mocks --test test/minimal.test.ts test/modelName.test.ts test/agentContainerResources.test.ts test/agentDockerfileSupplyChain.test.ts test/agentImagePreparation.test.ts test/daemonEventIntake.test.ts test/databaseMigrationGate.test.ts test/deployPrPreview.test.mjs test/generateContext.test.ts test/githubEventIntakeMode.test.ts test/intakeModePrerequisites.test.ts test/orchestratorMigrationPhase.test.mjs test/validateRoutingUrl.test.ts test/routingWebSocketProtocol.test.ts test/routingWebSocketIntakeService.test.ts test/routingStatusPublisher.test.ts test/releaseValidation.test.mjs test/sessionSecret.test.ts test/testSuiteRunner.test.mjs packages/api/test/connectAuth.test.ts packages/api/test/attachmentUploadCleanup.test.ts packages/api/test/configReloadSubscription.test.ts packages/api/test/dockerCommandSafety.test.ts packages/api/test/listenAddress.test.ts packages/api/test/oauthState.test.ts packages/api/test/requestRateLimits.test.ts packages/api/test/statusRoutes.test.ts packages/api/test/agentRuntimeRoutes.test.ts packages/api/test/instanceAuthorization.test.ts packages/api/test/routeAuthorization.test.ts", + "pretest:unit": "npm run build -w @propr/shared && npm run build -w @propr/local-setup", + "test:unit": "NODE_ENV=test npx tsx --experimental-test-module-mocks --test test/minimal.test.ts test/modelName.test.ts test/agentContainerResources.test.ts test/agentDockerfileSupplyChain.test.ts test/agentImagePreparation.test.ts test/daemonEventIntake.test.ts test/databaseMigrationGate.test.ts test/deployPrPreview.test.mjs test/generateContext.test.ts test/githubEventIntakeMode.test.ts test/intakeModePrerequisites.test.ts test/orchestratorMigrationPhase.test.mjs test/validateRoutingUrl.test.ts test/routingWebSocketProtocol.test.ts test/routingWebSocketIntakeService.test.ts test/routingStatusPublisher.test.ts test/releaseValidation.test.mjs test/sessionSecret.test.ts test/testSuiteRunner.test.mjs packages/api/test/connectAuth.test.ts packages/api/test/attachmentUploadCleanup.test.ts packages/api/test/configReloadSubscription.test.ts packages/api/test/desktopApiBoundary.test.ts packages/api/test/dockerCommandSafety.test.ts packages/api/test/listenAddress.test.ts packages/api/test/oauthState.test.ts packages/api/test/requestRateLimits.test.ts packages/api/test/statusRoutes.test.ts packages/api/test/agentRuntimeRoutes.test.ts packages/api/test/instanceAuthorization.test.ts packages/api/test/routeAuthorization.test.ts", "test:e2e": "npx tsx --test test/e2e.test.ts", "test:docker": "docker-compose run --rm -e REDIS_HOST=redis -e NODE_ENV=test worker npx tsx --test test/*.test.ts", "test:docker:single": "docker-compose run --rm -e REDIS_HOST=redis -e NODE_ENV=test worker npx tsx --test", @@ -105,6 +106,7 @@ "@octokit/core": "^7.0.2", "@octokit/plugin-paginate-rest": "^13.1.1", "@propr/core": "^0.8.15", + "@propr/local-setup": "^0.8.15", "better-sqlite3": "^11.7.0", "bullmq": "^5.81.3", "cors": "^2.8.5", diff --git a/packages/api/apiCacheControl.ts b/packages/api/apiCacheControl.ts new file mode 100644 index 000000000..ee223ea38 --- /dev/null +++ b/packages/api/apiCacheControl.ts @@ -0,0 +1,11 @@ +import type { RequestHandler } from 'express'; + +/** + * Attach the API discovery cache prohibition at the first `/api` boundary so + * limiters, route handlers, and error handlers all inherit the same headers. + */ +export const prohibitApiResponseCaching: RequestHandler = (_request, response, next) => { + response.set('Cache-Control', 'no-store, max-age=0'); + response.set('Pragma', 'no-cache'); + next(); +}; diff --git a/packages/api/authRedirect.ts b/packages/api/authRedirect.ts index 2679c2094..f473b6c49 100644 --- a/packages/api/authRedirect.ts +++ b/packages/api/authRedirect.ts @@ -1,4 +1,5 @@ import { isIP } from 'net'; +import { canonicalProprHttpUrlOrigin, isProprLoopbackHostname } from '@propr/shared'; import type { AllowedRedirectHost } from './authTypes.js'; function isValidHostname(hostname: string): boolean { @@ -59,8 +60,8 @@ function isAllowedRedirectHost(hostname: string): boolean { } function isLocalHttpRedirectHost(hostname: string): boolean { - const normalized = normalizeHostname(hostname); - return normalized === 'localhost' || normalized === '127.0.0.1' || normalized === '::1'; + const normalized = hostname.includes(':') ? `[${normalizeHostname(hostname)}]` : normalizeHostname(hostname); + return isProprLoopbackHostname(normalized); } // HTTPS is required for all non-local redirect targets by default. HTTP is only @@ -79,6 +80,7 @@ export function getValidatedRedirectTo(redirectTo: string | undefined): string | try { const url = new URL(redirectTo); const hostname = normalizeHostname(url.hostname); + if (canonicalProprHttpUrlOrigin(redirectTo, { allowInsecureHttp: allowHttp }) !== url.origin) return undefined; if (url.protocol === 'https:' && isAllowedRedirectHost(hostname)) return url.toString(); if (url.protocol === 'http:' && isAllowedRedirectHost(hostname) && (allowHttp || isLocalHttpRedirectHost(hostname))) return url.toString(); } catch { diff --git a/packages/api/authSession.ts b/packages/api/authSession.ts index 10d347fce..28c419458 100644 --- a/packages/api/authSession.ts +++ b/packages/api/authSession.ts @@ -1,5 +1,6 @@ import type session from 'express-session'; import type { Request, Response } from 'express'; +import { isProprLoopbackHostname, normalizeProprApiOrigin } from '@propr/shared'; import { getDefaultRedirectUrl } from './authRedirect.js'; import { isUserWhitelisted } from './userWhitelist.js'; @@ -16,9 +17,13 @@ export function getSessionCookieDomain(): string | undefined { export function shouldUseSecureSessionCookie(cookieDomain: string | undefined): boolean { try { if (process.env.API_PUBLIC_URL) { - const url = new URL(process.env.API_PUBLIC_URL); + const raw = process.env.API_PUBLIC_URL; + const url = new URL(raw); if (url.protocol === 'https:') return true; - if (url.protocol === 'http:' && (url.hostname === 'localhost' || url.hostname === '127.0.0.1' || url.hostname === '[::1]')) return false; + if (normalizeProprApiOrigin(raw) !== url.origin) { + return process.env.NODE_ENV === 'production' || Boolean(cookieDomain); + } + if (url.protocol === 'http:' && isProprLoopbackHostname(url.hostname)) return false; } return process.env.NODE_ENV === 'production' || Boolean(cookieDomain); } catch { diff --git a/packages/api/connectAuth.ts b/packages/api/connectAuth.ts index 720e2d837..79ef22c70 100644 --- a/packages/api/connectAuth.ts +++ b/packages/api/connectAuth.ts @@ -1,5 +1,10 @@ import type { GitHubUser } from './authTypes.js'; -import { DEFAULT_PROPR_GH_RELAY_URL } from '@propr/shared'; +import { + DEFAULT_PROPR_GH_RELAY_URL, + canonicalProprHttpUrlOrigin, + isProprLoopbackHostname, + normalizeProprApiOrigin, +} from '@propr/shared'; export const DEFAULT_PROPR_CONNECT_ORIGIN = 'https://connect.propr.dev'; const CONNECT_REDEEM_TIMEOUT_MS = 20_000; @@ -35,7 +40,10 @@ export function buildConnectAuthorizationUrl(options: { installationId?: string; }): string { const origin = new URL(options.connectOrigin || DEFAULT_PROPR_CONNECT_ORIGIN); - if (origin.protocol !== 'https:' || origin.username || origin.password || origin.search || origin.hash) { + if (origin.protocol !== 'https:' + || origin.search + || origin.hash + || normalizeProprApiOrigin(options.connectOrigin || DEFAULT_PROPR_CONNECT_ORIGIN) !== origin.origin) { throw new Error('PROPR_CONNECT_URL must be a bare HTTPS origin'); } const url = new URL('/instance-login', origin); @@ -54,9 +62,12 @@ export async function redeemConnectAuthorizationCode(options: { fetchImpl?: typeof fetch; }): Promise { const fetchImpl = options.fetchImpl ?? fetch; - const relayBase = options.relayUrl.trim().replace(/\/+$/, ''); + const relayRaw = options.relayUrl.trim(); + const relayBase = relayRaw.replace(/\/+$/, ''); const endpoint = new URL(`${relayBase}/auth/instance-grants/redeem`); - if (endpoint.protocol !== 'https:' && endpoint.hostname !== 'localhost' && endpoint.hostname !== '127.0.0.1') { + const canonicalRelayOrigin = canonicalProprHttpUrlOrigin(relayRaw); + if (!canonicalRelayOrigin + || (endpoint.protocol === 'http:' && !isProprLoopbackHostname(endpoint.hostname))) { throw new Error('PROPR_GH_RELAY_URL must use HTTPS'); } @@ -143,7 +154,9 @@ function isHostedConnectPath(env: NodeJS.ProcessEnv): boolean { function normalizeServiceUrl(value: string | undefined): string | undefined { try { if (!value?.trim()) return undefined; - const url = new URL(value.trim()); + const raw = value.trim(); + const url = new URL(raw); + if (canonicalProprHttpUrlOrigin(raw) !== url.origin) return undefined; if (url.username || url.password || url.search || url.hash) return undefined; const path = url.pathname.replace(/\/+$/, ''); return `${url.origin}${path}`; @@ -155,11 +168,12 @@ function normalizeServiceUrl(value: string | undefined): string | undefined { function isSupportedLoopbackCallback(value: string | undefined): boolean { try { if (!value?.trim()) return false; - const url = new URL(value.trim()); - const hostname = url.hostname.toLowerCase(); + const raw = value.trim(); + const url = new URL(raw); return ( url.protocol === 'http:' && - (hostname === 'localhost' || hostname === '127.0.0.1' || hostname === '[::1]') && + canonicalProprHttpUrlOrigin(raw) === url.origin && + isProprLoopbackHostname(url.hostname) && url.username === '' && url.password === '' && url.pathname === '/api/auth/github/callback' && diff --git a/packages/api/corsValidation.ts b/packages/api/corsValidation.ts index 5a35823a1..c34fa5570 100644 --- a/packages/api/corsValidation.ts +++ b/packages/api/corsValidation.ts @@ -7,7 +7,12 @@ // allowed for local development. import type { ErrorRequestHandler } from 'express'; -import { DESKTOP_RENDERER_ORIGIN } from '@propr/shared'; +import { + DESKTOP_RENDERER_ORIGIN, + canonicalProprHttpUrlOrigin, + isProprLoopbackHostname, + normalizeProprApiOrigin, +} from '@propr/shared'; export type CorsOriginCallback = (err: Error | null, allow?: boolean) => void; export type CorsOriginValidator = (origin: string | undefined, callback: CorsOriginCallback) => void; @@ -38,7 +43,8 @@ export const corsRejectionHandler: ErrorRequestHandler = (error, _req, res, next export function createCorsOriginValidator(frontendUrl: string, cookieDomain: string | undefined): CorsOriginValidator { // Remove leading dot if present for hostname matching const baseDomain = cookieDomain?.startsWith('.') ? cookieDomain.slice(1) : cookieDomain; - const frontendOrigin = new URL(frontendUrl).origin; + const frontendOrigin = canonicalProprHttpUrlOrigin(frontendUrl, { allowInsecureHttp: true }); + if (!frontendOrigin) throw new Error('FRONTEND_URL must contain a canonical HTTP(S) URL'); return function validateCorsOrigin(origin: string | undefined, callback: CorsOriginCallback): void { // Allow requests with no origin (e.g., mobile apps, curl, etc.) @@ -54,7 +60,9 @@ export function createCorsOriginValidator(frontendUrl: string, cookieDomain: str return; } try { - const url = new URL(origin); + const canonicalOrigin = normalizeProprApiOrigin(origin, { allowInsecureHttp: true }); + if (!canonicalOrigin) throw new CorsOriginError(); + const url = new URL(canonicalOrigin); // Allow the base domain and any subdomain. The previous inline validator // allowed both http and https here, and some non-tunnel PR-preview // deployments still use http://.. Keep that existing @@ -68,7 +76,7 @@ export function createCorsOriginValidator(frontendUrl: string, cookieDomain: str } else if (url.origin === frontendOrigin) { callback(null, true); } else if ( - (url.hostname === 'localhost' || url.hostname === '127.0.0.1' || url.hostname === '[::1]') && + isProprLoopbackHostname(url.hostname) && (url.protocol === 'http:' || url.protocol === 'https:') ) { // Allow loopback hosts for development, but only over http/https so an diff --git a/packages/api/desktopApiBoundary.ts b/packages/api/desktopApiBoundary.ts new file mode 100644 index 000000000..71a0cf69f --- /dev/null +++ b/packages/api/desktopApiBoundary.ts @@ -0,0 +1,39 @@ +import type { Express, RequestHandler } from 'express'; +import { ensureAuthenticated } from './auth.js'; +import { resolveAuthorization } from './authorization.js'; +import { + createDiscoveryRequestRateLimiter, + createPairingPollRateLimiter, + createPairingStartRateLimiter, +} from './requestRateLimits.js'; + +export interface DesktopApiBoundaryRoutes { + discovery: RequestHandler; + startPairing: RequestHandler; + pollPairing: RequestHandler; + activatePairing: RequestHandler; + cancelPairing: RequestHandler; + openPairingApproval: RequestHandler; + revokeCurrentToken: RequestHandler; +} + +/** + * Register the complete public desktop bootstrap boundary and then close it + * with the generic API authentication/authorization guard. Operational routes + * must be registered only after this function returns. + */ +export function registerDesktopApiBoundary( + app: Express, + routes: DesktopApiBoundaryRoutes, +): void { + app.get('/api/desktop/discovery', createDiscoveryRequestRateLimiter(), routes.discovery); + app.post('/api/desktop/pairings', createPairingStartRateLimiter(), routes.startPairing); + app.post('/api/desktop/pairings/:pairingId/poll', createPairingPollRateLimiter(), routes.pollPairing); + app.post('/api/desktop/pairings/:pairingId/activate', createPairingPollRateLimiter(), routes.activatePairing); + app.post('/api/desktop/pairings/:pairingId/cancel', createPairingPollRateLimiter(), routes.cancelPairing); + app.get('/api/desktop/pairings/:pairingId/browser', createPairingStartRateLimiter(), routes.openPairingApproval); + // Token possession authorizes only this exact self-revocation route. It must + // precede generic auth so inactive tokens receive a stable terminal contract. + app.delete('/api/desktop/tokens/current', routes.revokeCurrentToken); + app.use('/api', ensureAuthenticated, resolveAuthorization); +} diff --git a/packages/api/desktopAuthService.ts b/packages/api/desktopAuthService.ts index 8ef5bf756..d804157bb 100644 --- a/packages/api/desktopAuthService.ts +++ b/packages/api/desktopAuthService.ts @@ -1,21 +1,41 @@ /* eslint-disable max-lines -- pairing and token state transitions are kept together for transactional review */ -import { createHash, randomBytes, randomUUID } from 'node:crypto'; +import { createHash, createHmac, randomBytes, randomUUID } from 'node:crypto'; import type { Knex } from 'knex'; import { db } from '@propr/core'; +import { + canonicalProprHttpUrlOrigin, + canonicalProprProxyUrl, + isProprConnectReservedHostAttempt, + MAX_PROPR_API_BASE_URL_LENGTH, + normalizeProprApiOrigin, + parseProprConnectEndpoint, +} from '@propr/shared'; import type { GitHubUser } from './authTypes.js'; const DEFAULT_PAIRING_TTL_MS = 10 * 60_000; const DEFAULT_POLL_INTERVAL_SECONDS = 5; +const DEFAULT_PROVISIONAL_TTL_MS = 2 * 60_000; const RETAIN_FINISHED_PAIRINGS_MS = 24 * 60 * 60_000; export const INSTANCE_TOKEN_PREFIX = 'propr_it_'; +export const DESKTOP_INSTANCE_SCOPE = 'desktop-instance'; -type PairingStatus = 'pending' | 'approved' | 'consumed'; +type PairingStatus = 'pending' | 'approved' | 'consumed' | 'cancelled'; interface PairingRow { id: string; device_secret_hash: string; client_name: string; status: PairingStatus; + requested_instance_id: string; + requested_origin: string; + requested_scope: string; + credential_generation: string; + provisional_token_id: string | null; + activation_ticket_hash: string | null; + activation_receipt: string | null; + activation_expires_at: string | null; + activated_at: string | null; + cancelled_at: string | null; approved_by_user_id: string | null; approved_by_username: string | null; approved_by_display_name: string | null; @@ -42,6 +62,19 @@ interface TokenRow { expires_at: string | null; revoked_at: string | null; revoked_by_user_id: string | null; + activation_state: 'provisional' | 'active'; + pairing_id: string; + bound_instance_id: string; + bound_origin: string; + bound_scope: string; + credential_generation: string; +} + +export interface DesktopPairingBinding { + instanceId: string; + origin: string; + scope: typeof DESKTOP_INSTANCE_SCOPE; + credentialGeneration: string; } export interface DesktopPairingStart { @@ -62,7 +95,25 @@ export interface DesktopPairingApproval { export type DesktopPairingPoll = | { status: 'pending'; interval: number } - | { status: 'complete'; token: string; tokenType: 'Bearer'; expiresAt: string | null }; + | ({ + status: 'provisional'; + token: string; + tokenType: 'Bearer'; + activationTicket: string; + activationExpiresAt: string; + } & DesktopPairingBinding); + +export interface DesktopPairingActivation extends DesktopPairingBinding { + deviceSecret: string; + activationTicket: string; +} + +export interface DesktopPairingActivationReceipt { + status: 'active'; + receipt: string; + activatedAt: string; + expiresAt: string | null; +} export interface DesktopTokenSummary { id: string; @@ -79,6 +130,10 @@ export interface InstanceTokenIdentity { user: GitHubUser; } +export type PresentedTokenRevocation = + | { revoked: true } + | { revoked: false; code: 'TOKEN_NOT_FOUND' | 'INSTANCE_TOKEN_REVOKED' | 'INSTANCE_TOKEN_EXPIRED' }; + export class DesktopAuthError extends Error { constructor( public readonly code: string, @@ -95,6 +150,7 @@ export interface DesktopAuthServiceOptions { now?: () => Date; pairingTtlMs?: number; tokenTtlMs?: number | null; + provisionalTtlMs?: number; approvalBaseUrl?: string; publicApiUrl?: string; } @@ -107,6 +163,17 @@ function opaqueValue(bytes = 32): string { return randomBytes(bytes).toString('base64url'); } +function derivePairingValue(secret: string, purpose: string, row: PairingRow): string { + return createHmac('sha256', secret).update(JSON.stringify({ + purpose, + pairingId: row.id, + instanceId: row.requested_instance_id, + origin: row.requested_origin, + scope: row.requested_scope, + credentialGeneration: row.credential_generation, + })).digest('base64url'); +} + function validClientName(value: unknown): string { if (typeof value !== 'string') { throw new DesktopAuthError('INVALID_CLIENT_NAME', 400, 'clientName must be a string'); @@ -137,28 +204,110 @@ function requireDeviceSecret(value: unknown): string { return value; } +function validBinding(value: unknown): DesktopPairingBinding { + if (!value || typeof value !== 'object' || Array.isArray(value)) { + throw new DesktopAuthError('INVALID_PAIRING_BINDING', 400, 'Desktop pairing binding is invalid'); + } + const input = value as Record; + const origin = typeof input.origin === 'string' ? normalizeProprApiOrigin(input.origin) : null; + if (typeof input.instanceId !== 'string' || !/^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$/.test(input.instanceId) + || origin === null || origin !== input.origin + || input.scope !== DESKTOP_INSTANCE_SCOPE + || typeof input.credentialGeneration !== 'string' + || !/^[A-Za-z0-9_-]{22}$/.test(input.credentialGeneration)) { + throw new DesktopAuthError('INVALID_PAIRING_BINDING', 400, 'Desktop pairing binding is invalid'); + } + return { + instanceId: input.instanceId, + origin, + scope: DESKTOP_INSTANCE_SCOPE, + credentialGeneration: input.credentialGeneration, + }; +} + +function rowBinding(row: PairingRow): DesktopPairingBinding { + return { + instanceId: row.requested_instance_id, + origin: row.requested_origin, + scope: DESKTOP_INSTANCE_SCOPE, + credentialGeneration: row.credential_generation, + }; +} + +function sameBinding(row: PairingRow, binding: DesktopPairingBinding): boolean { + return row.requested_instance_id === binding.instanceId + && row.requested_origin === binding.origin + && row.requested_scope === binding.scope + && row.credential_generation === binding.credentialGeneration; +} + function frontendApprovalBase(configured?: string): URL { const raw = configured ?? process.env.FRONTEND_URL; if (!raw) throw new Error('FRONTEND_URL is required for desktop pairing'); const url = new URL(raw); - if (url.protocol !== 'https:' && !(url.protocol === 'http:' && ['localhost', '127.0.0.1', '::1', '[::1]'].includes(url.hostname))) { + if (canonicalProprHttpUrlOrigin(raw) !== url.origin) { throw new Error('Desktop pairing approval requires HTTPS except on loopback hosts'); } if (url.username || url.password) throw new Error('FRONTEND_URL must not contain credentials'); return url; } -function publicApiBase(configured?: string): URL | null { - const raw = configured ?? process.env.API_PUBLIC_URL; - if (!raw) return null; - const url = new URL(raw); - if (url.protocol !== 'https:' && !(url.protocol === 'http:' && ['localhost', '127.0.0.1', '::1', '[::1]'].includes(url.hostname))) { +interface PublicApiBase { + url: URL; + managedSelector: string | null; +} + +function invalidPublicApiConfiguration(): DesktopAuthError { + return new DesktopAuthError( + 'PAIRING_CONFIGURATION_INVALID', + 503, + 'Desktop pairing is unavailable because the public API URL is invalid', + ); +} + +function rawPublicApiHostname(raw: string): string { + const authority = raw.slice(raw.indexOf('://') + 3).split(/[/?#]/, 1)[0]?.split('@').pop()?.toLowerCase() ?? ''; + return authority.replace(/:\d+$/, '').replace(/\.$/, ''); +} + +function claimsManagedPublicApiNamespace(raw: string, url: URL): boolean { + const normalizedHostname = url.hostname.toLowerCase().replace(/\.$/, ''); + const managedLabelInProprNamespace = normalizedHostname.endsWith('.propr.dev') + && normalizedHostname.split('.').slice(0, -2).some(label => label.startsWith('t-')); + const rawHostnameLabels = rawPublicApiHostname(raw).split('.'); + const rawManagedLabelInProprNamespace = rawHostnameLabels[0]?.startsWith('t-') === true + && rawHostnameLabels.at(-2) === 'propr' + && rawHostnameLabels.at(-1) === 'dev'; + return managedLabelInProprNamespace || rawManagedLabelInProprNamespace; +} + +function validatePublicApiOrigin(raw: string, url: URL): void { + if (normalizeProprApiOrigin(raw) !== url.origin) { throw new Error('Desktop pairing browser entry requires HTTPS except on loopback hosts'); } if (url.username || url.password || url.pathname !== '/' || url.search || url.hash) { throw new Error('API_PUBLIC_URL must be an origin without credentials, a path, query, or fragment'); } - return url; +} + +function publicApiBase(configured?: string): PublicApiBase | null { + const raw = configured ?? process.env.API_PUBLIC_URL; + if (!raw) return null; + if (raw.length > MAX_PROPR_API_BASE_URL_LENGTH) throw invalidPublicApiConfiguration(); + const canonicalConnectEndpoint = parseProprConnectEndpoint(raw); + if (isProprConnectReservedHostAttempt(raw) && !canonicalConnectEndpoint) { + throw invalidPublicApiConfiguration(); + } + const url = new URL(raw); + validatePublicApiOrigin(raw, url); + const canonicalManagedUrl = canonicalProprProxyUrl(raw); + if (claimsManagedPublicApiNamespace(raw, url) && !canonicalManagedUrl) { + throw new Error('API_PUBLIC_URL uses a noncanonical reserved ProPR tunnel host'); + } + return { + url, + managedSelector: canonicalManagedUrl ? canonicalManagedUrl.slice('https://'.length) : null, + }; } function tokenSummary(row: TokenRow): DesktopTokenSummary { @@ -188,6 +337,7 @@ export class DesktopAuthService { private readonly now: () => Date; private readonly pairingTtlMs: number; private readonly tokenTtlMs: number | null; + private readonly provisionalTtlMs: number; private readonly approvalBaseUrl?: string; private readonly publicApiUrl?: string; @@ -196,19 +346,25 @@ export class DesktopAuthService { this.now = options.now ?? (() => new Date()); this.pairingTtlMs = options.pairingTtlMs ?? DEFAULT_PAIRING_TTL_MS; this.tokenTtlMs = options.tokenTtlMs === undefined ? configuredTokenTtlMs() : options.tokenTtlMs; + this.provisionalTtlMs = options.provisionalTtlMs ?? DEFAULT_PROVISIONAL_TTL_MS; + if (!Number.isSafeInteger(this.provisionalTtlMs) || this.provisionalTtlMs < 1_000 + || this.provisionalTtlMs > DEFAULT_PROVISIONAL_TTL_MS) { + throw new Error('Desktop provisional TTL must be from 1000 to 120000 milliseconds'); + } this.approvalBaseUrl = options.approvalBaseUrl; this.publicApiUrl = options.publicApiUrl; } - async startPairing(clientNameInput: unknown): Promise { + async startPairing(clientNameInput: unknown, bindingInput: unknown): Promise { const clientName = validClientName(clientNameInput); + const binding = validBinding(bindingInput); const pairingId = `dpr_${opaqueValue(16)}`; const deviceSecret = opaqueValue(); const createdAt = this.now(); const expiresAt = new Date(createdAt.getTime() + this.pairingTtlMs); - const apiApprovalUrl = publicApiBase(this.publicApiUrl); - const approvalUrl = apiApprovalUrl ?? this.getFrontendApprovalUrl(pairingId); - if (apiApprovalUrl) { + const apiApprovalBase = publicApiBase(this.publicApiUrl); + const approvalUrl = apiApprovalBase?.url ?? this.getFrontendApprovalUrl(pairingId); + if (apiApprovalBase) { approvalUrl.pathname = `${approvalUrl.pathname.replace(/\/$/, '')}/api/desktop/pairings/${pairingId}/browser`; approvalUrl.search = ''; approvalUrl.hash = ''; @@ -219,6 +375,10 @@ export class DesktopAuthService { device_secret_hash: digest(deviceSecret), client_name: clientName, status: 'pending', + requested_instance_id: binding.instanceId, + requested_origin: binding.origin, + requested_scope: binding.scope, + credential_generation: binding.credentialGeneration, created_at: createdAt.toISOString(), expires_at: expiresAt.toISOString(), }); @@ -240,9 +400,9 @@ export class DesktopAuthService { approvalUrl.search = ''; approvalUrl.hash = ''; approvalUrl.searchParams.set('pairing_id', pairingId); - const apiUrl = publicApiBase(this.publicApiUrl); - if (approvalUrl.hostname === 'app.propr.dev' && apiUrl?.hostname.startsWith('t-') && apiUrl.hostname.endsWith('.propr.dev')) { - approvalUrl.searchParams.set('tunnel', apiUrl.hostname); + const apiBase = publicApiBase(this.publicApiUrl); + if (approvalUrl.origin === 'https://app.propr.dev' && apiBase?.managedSelector) { + approvalUrl.searchParams.set('tunnel', apiBase.managedSelector); } return approvalUrl; } @@ -301,48 +461,190 @@ export class DesktopAuthService { return this.database.transaction(async transaction => { const row = await transaction('desktop_pairing_requests') .where({ id: pairingId, device_secret_hash: digest(deviceSecret) }) + .forUpdate() .first(); if (!row) throw new DesktopAuthError('PAIRING_NOT_FOUND', 404, 'Pairing request was not found'); if (row.expires_at <= nowIso) throw new DesktopAuthError('PAIRING_EXPIRED', 410, 'Pairing request has expired'); if (row.status === 'pending') return { status: 'pending', interval: DEFAULT_POLL_INTERVAL_SECONDS }; if (row.status === 'consumed') { + if (row.cancelled_at) throw new DesktopAuthError('PAIRING_CANCELLED', 410, 'Pairing request was cancelled'); throw new DesktopAuthError('PAIRING_ALREADY_CONSUMED', 409, 'Pairing request was already used'); } + if (row.status === 'cancelled') { + throw new DesktopAuthError('PAIRING_CANCELLED', 410, 'Pairing request was cancelled'); + } if (!row.approved_by_user_id || !row.approved_by_username) { throw new DesktopAuthError('PAIRING_INVALID_STATE', 409, 'Pairing request cannot be completed'); } - const token = `${INSTANCE_TOKEN_PREFIX}${opaqueValue()}`; - const tokenId = randomUUID(); - const tokenExpiresAt = this.tokenTtlMs === null - ? null - : new Date(now.getTime() + this.tokenTtlMs).toISOString(); - await transaction('instance_api_tokens').insert({ - id: tokenId, - token_hash: digest(token), - token_hint: token.slice(-8), - name: row.client_name, - owner_github_user_id: row.approved_by_user_id, - owner_github_username: row.approved_by_username, - owner_display_name: row.approved_by_display_name || row.approved_by_username, - owner_email: row.approved_by_email, - owner_avatar_url: row.approved_by_avatar_url, - created_at: nowIso, - expires_at: tokenExpiresAt, - }); - const consumed = await transaction('desktop_pairing_requests') - .where({ id: pairingId, status: 'approved', device_secret_hash: digest(deviceSecret) }) - .update({ status: 'consumed', consumed_at: nowIso }); - if (consumed !== 1) { - throw new DesktopAuthError('PAIRING_ALREADY_CONSUMED', 409, 'Pairing request was already used'); + const token = `${INSTANCE_TOKEN_PREFIX}${derivePairingValue(deviceSecret, 'credential', row)}`; + const activationTicket = derivePairingValue(deviceSecret, 'activation-ticket', row); + let activationExpiresAt = row.activation_expires_at; + let tokenId = row.provisional_token_id; + if (!tokenId) { + tokenId = randomUUID(); + activationExpiresAt = new Date(Math.min( + Date.parse(row.expires_at), + now.getTime() + this.provisionalTtlMs, + )).toISOString(); + await transaction('instance_api_tokens').insert({ + id: tokenId, + token_hash: digest(token), + token_hint: token.slice(-8), + name: row.client_name, + owner_github_user_id: row.approved_by_user_id, + owner_github_username: row.approved_by_username, + owner_display_name: row.approved_by_display_name || row.approved_by_username, + owner_email: row.approved_by_email, + owner_avatar_url: row.approved_by_avatar_url, + created_at: nowIso, + expires_at: activationExpiresAt, + activation_state: 'provisional', + pairing_id: row.id, + bound_instance_id: row.requested_instance_id, + bound_origin: row.requested_origin, + bound_scope: row.requested_scope, + credential_generation: row.credential_generation, + }); + await transaction('desktop_pairing_requests').where({ id: row.id, status: 'approved' }).update({ + provisional_token_id: tokenId, + activation_ticket_hash: digest(activationTicket), + activation_expires_at: activationExpiresAt, + }); + await this.audit('token_provisioned', { + pairingId, + tokenId, + clientName: row.client_name, + actor: { id: row.approved_by_user_id, username: row.approved_by_username }, + }, transaction); + } else { + const existing = await transaction('instance_api_tokens').where({ id: tokenId }).first(); + if (!existing || existing.token_hash !== digest(token) + || row.activation_ticket_hash !== digest(activationTicket) + || !activationExpiresAt || activationExpiresAt <= nowIso) { + throw new DesktopAuthError('PAIRING_EXPIRED', 410, 'Pairing activation has expired'); + } + } + return { + status: 'provisional', + token, + tokenType: 'Bearer', + activationTicket, + activationExpiresAt: activationExpiresAt!, + ...rowBinding(row), + }; + }); + } + + async cancelPairing(pairingId: string, input: unknown): Promise<{ status: 'cancelled'; cancelledAt: string }> { + validPairingId(pairingId); + if (!input || typeof input !== 'object' || Array.isArray(input)) { + throw new DesktopAuthError('PAIRING_NOT_FOUND', 404, 'Pairing request was not found'); + } + const request = input as Record; + const deviceSecret = requireDeviceSecret(request.deviceSecret); + const binding = validBinding(request); + const activationTicket = typeof request.activationTicket === 'string' + && /^[A-Za-z0-9_-]{43}$/.test(request.activationTicket) + ? request.activationTicket + : null; + if (!activationTicket) throw new DesktopAuthError('PAIRING_NOT_FOUND', 404, 'Pairing request was not found'); + const nowIso = this.now().toISOString(); + return this.database.transaction(async transaction => { + const row = await transaction('desktop_pairing_requests') + .where({ id: pairingId, device_secret_hash: digest(deviceSecret) }) + .forUpdate() + .first(); + if (!row || !sameBinding(row, binding) || row.activation_ticket_hash !== digest(activationTicket)) { + throw new DesktopAuthError('PAIRING_NOT_FOUND', 404, 'Pairing request was not found'); } - await this.audit('token_issued', { + if (row.cancelled_at) return { status: 'cancelled', cancelledAt: row.cancelled_at }; + if (!row.provisional_token_id) { + throw new DesktopAuthError('PAIRING_INVALID_STATE', 409, 'Pairing credential was not provisioned'); + } + await transaction('instance_api_tokens') + .where({ id: row.provisional_token_id }) + .whereNull('revoked_at') + .update({ revoked_at: nowIso, revoked_by_user_id: row.approved_by_user_id }); + await transaction('desktop_pairing_requests').where({ id: row.id }).update({ + status: 'consumed', + consumed_at: nowIso, + cancelled_at: nowIso, + }); + await this.audit('pairing_cancelled', { pairingId, - tokenId, + tokenId: row.provisional_token_id, clientName: row.client_name, - actor: { id: row.approved_by_user_id, username: row.approved_by_username }, + actor: row.approved_by_user_id && row.approved_by_username + ? { id: row.approved_by_user_id, username: row.approved_by_username } + : undefined, + }, transaction); + return { status: 'cancelled', cancelledAt: nowIso }; + }); + } + + async activatePairing(pairingId: string, input: unknown): Promise { + validPairingId(pairingId); + if (!input || typeof input !== 'object' || Array.isArray(input)) { + throw new DesktopAuthError('PAIRING_NOT_FOUND', 404, 'Pairing request was not found'); + } + const request = input as Record; + const deviceSecret = requireDeviceSecret(request.deviceSecret); + const binding = validBinding(request); + const activationTicket = typeof request.activationTicket === 'string' + && /^[A-Za-z0-9_-]{43}$/.test(request.activationTicket) + ? request.activationTicket + : null; + if (!activationTicket) throw new DesktopAuthError('PAIRING_NOT_FOUND', 404, 'Pairing request was not found'); + const now = this.now(); + const nowIso = now.toISOString(); + return this.database.transaction(async transaction => { + const row = await transaction('desktop_pairing_requests') + .where({ id: pairingId, device_secret_hash: digest(deviceSecret) }) + .forUpdate() + .first(); + if (!row || !sameBinding(row, binding) || row.activation_ticket_hash !== digest(activationTicket)) { + throw new DesktopAuthError('PAIRING_NOT_FOUND', 404, 'Pairing request was not found'); + } + const tokenId = row.provisional_token_id; + if (!tokenId) throw new DesktopAuthError('PAIRING_INVALID_STATE', 409, 'Pairing credential was not provisioned'); + if (row.status === 'consumed') { + if (row.cancelled_at) throw new DesktopAuthError('PAIRING_CANCELLED', 410, 'Pairing request was cancelled'); + if (!row.activation_receipt || !row.activated_at) { + throw new DesktopAuthError('PAIRING_ALREADY_CONSUMED', 409, 'Pairing request was already used'); + } + const token = await transaction('instance_api_tokens').where({ id: tokenId }).first(); + if (!token || token.activation_state !== 'active') { + throw new DesktopAuthError('PAIRING_ALREADY_CONSUMED', 409, 'Pairing request was already used'); + } + return { + status: 'active', receipt: row.activation_receipt, activatedAt: row.activated_at, expiresAt: token.expires_at, + }; + } + if (row.status === 'cancelled') throw new DesktopAuthError('PAIRING_CANCELLED', 410, 'Pairing request was cancelled'); + if (row.status !== 'approved' || row.expires_at <= nowIso + || !row.activation_expires_at || row.activation_expires_at <= nowIso) { + throw new DesktopAuthError('PAIRING_EXPIRED', 410, 'Pairing activation has expired'); + } + const finalExpiresAt = this.tokenTtlMs === null + ? null + : new Date(now.getTime() + this.tokenTtlMs).toISOString(); + const activated = await transaction('instance_api_tokens') + .where({ id: tokenId, activation_state: 'provisional' }) + .whereNull('revoked_at') + .andWhere('expires_at', '>', nowIso) + .update({ activation_state: 'active', expires_at: finalExpiresAt }); + if (activated !== 1) throw new DesktopAuthError('PAIRING_EXPIRED', 410, 'Pairing activation has expired'); + const receipt = opaqueValue(16); + const consumed = await transaction('desktop_pairing_requests') + .where({ id: row.id, status: 'approved' }) + .update({ status: 'consumed', consumed_at: nowIso, activated_at: nowIso, activation_receipt: receipt }); + if (consumed !== 1) throw new DesktopAuthError('PAIRING_ALREADY_CONSUMED', 409, 'Pairing request was already used'); + await this.audit('token_activated', { + pairingId, tokenId, clientName: row.client_name, + actor: { id: row.approved_by_user_id!, username: row.approved_by_username! }, }, transaction); - return { status: 'complete', token, tokenType: 'Bearer', expiresAt: tokenExpiresAt }; + return { status: 'active', receipt, activatedAt: nowIso, expiresAt: finalExpiresAt }; }); } @@ -351,6 +653,7 @@ export class DesktopAuthService { const nowIso = this.now().toISOString(); const row = await this.database('instance_api_tokens') .where({ token_hash: digest(token) }) + .andWhere({ activation_state: 'active' }) .whereNull('revoked_at') .andWhere(builder => builder.whereNull('expires_at').orWhere('expires_at', '>', nowIso)) .first(); @@ -376,6 +679,7 @@ export class DesktopAuthService { async listTokens(ownerUserId: string): Promise { const rows = await this.database('instance_api_tokens') .where({ owner_github_user_id: ownerUserId }) + .andWhere({ activation_state: 'active' }) .orderBy('created_at', 'desc'); return rows.map(tokenSummary); } @@ -393,11 +697,52 @@ export class DesktopAuthService { await this.audit('token_revoked', { tokenId, actor }); } + async revokePresentedToken(token: string): Promise { + if (!token.startsWith(INSTANCE_TOKEN_PREFIX) + || token.length !== INSTANCE_TOKEN_PREFIX.length + 43) { + return { revoked: false, code: 'TOKEN_NOT_FOUND' }; + } + return this.database.transaction(async transaction => { + const row = await transaction('instance_api_tokens') + .where({ token_hash: digest(token) }) + .first(); + if (!row) return { revoked: false, code: 'TOKEN_NOT_FOUND' }; + if (row.revoked_at) return { revoked: false, code: 'INSTANCE_TOKEN_REVOKED' }; + const now = this.now(); + if (row.expires_at && Date.parse(row.expires_at) <= now.getTime()) { + return { revoked: false, code: 'INSTANCE_TOKEN_EXPIRED' }; + } + const actor: GitHubUser = { + id: row.owner_github_user_id, + login: row.owner_github_username, + username: row.owner_github_username, + displayName: row.owner_display_name, + email: row.owner_email, + avatarUrl: row.owner_avatar_url, + }; + const updated = await transaction('instance_api_tokens') + .where({ id: row.id }) + .whereNull('revoked_at') + .update({ revoked_at: now.toISOString(), revoked_by_user_id: actor.id }); + if (updated !== 1) return { revoked: false, code: 'INSTANCE_TOKEN_REVOKED' }; + await this.audit('token_revoked', { tokenId: row.id, actor }, transaction); + return { revoked: true }; + }); + } + async cleanupPairings(): Promise { const cutoff = new Date(this.now().getTime() - RETAIN_FINISHED_PAIRINGS_MS).toISOString(); - return this.database('desktop_pairing_requests') - .where('expires_at', '<', cutoff) - .delete(); + const nowIso = this.now().toISOString(); + return this.database.transaction(async transaction => { + await transaction('instance_api_tokens') + .where({ activation_state: 'provisional' }) + .andWhere('expires_at', '<=', nowIso) + .delete(); + const deleted = await transaction('desktop_pairing_requests') + .where('expires_at', '<', cutoff) + .delete(); + return typeof deleted === 'number' ? deleted : 0; + }); } private async activePairing(pairingId: string): Promise { diff --git a/packages/api/package.json b/packages/api/package.json index f6232ed4a..4e125b4bd 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -16,6 +16,7 @@ }, "dependencies": { "@propr/core": "^0.8.15", + "@propr/local-setup": "^0.8.15", "@propr/shared": "^0.8.15", "@types/multer": "^2.0.0", "bullmq": "^5.81.3", diff --git a/packages/api/publicInstanceIdentity.ts b/packages/api/publicInstanceIdentity.ts new file mode 100644 index 000000000..1c67a01bb --- /dev/null +++ b/packages/api/publicInstanceIdentity.ts @@ -0,0 +1,14 @@ +import { randomUUID } from 'node:crypto'; +import { join } from 'node:path'; +import { getOrCreatePublicInstanceIdentity as getOrCreateSharedIdentity } from '@propr/local-setup'; + +/** API access to the same validated, durable creation algorithm as the host CLI. */ +export async function getOrCreatePublicInstanceIdentity( + dataDir = process.env.DATA_DIR ?? join(process.cwd(), 'data'), + generate: () => string = randomUUID, +): Promise { + return await getOrCreateSharedIdentity(dataDir, { + generate, + role: 'root-container', + }); +} diff --git a/packages/api/routes/desktopAuthRoutes.ts b/packages/api/routes/desktopAuthRoutes.ts index 972435b1f..0e07b7c57 100644 --- a/packages/api/routes/desktopAuthRoutes.ts +++ b/packages/api/routes/desktopAuthRoutes.ts @@ -5,6 +5,14 @@ import { desktopAuthService, } from '../desktopAuthService.js'; import { isUserWhitelisted } from '../userWhitelist.js'; +import { + DESKTOP_REVOCATION_BINDING_HEADER, + DESKTOP_TOKEN_REVOCATION_ENDPOINT, + DESKTOP_TOKEN_REVOCATION_SCHEMA, + DESKTOP_TOKEN_REVOCATION_VERSION, + canonicalProprHttpUrlOrigin, + normalizeProprApiOrigin, +} from '@propr/shared'; interface DesktopAuthRoutesOptions { service?: DesktopAuthService; @@ -26,15 +34,9 @@ function sendDesktopAuthError(error: unknown, res: Response): void { export function isTrustedPairingApprovalOrigin(origin: string | undefined, frontendUrl: string | undefined): boolean { if (!origin || !frontendUrl) return false; - try { - const expected = new URL(frontendUrl); - const supplied = new URL(origin); - return supplied.origin === expected.origin - && (supplied.protocol === 'https:' - || (supplied.protocol === 'http:' && ['localhost', '127.0.0.1', '::1', '[::1]'].includes(supplied.hostname))); - } catch { - return false; - } + const expected = canonicalProprHttpUrlOrigin(frontendUrl); + const supplied = normalizeProprApiOrigin(origin); + return expected !== null && supplied === expected; } /** Pairing approval is intentionally session-only. */ @@ -69,13 +71,30 @@ export function createDesktopAuthRoutes(options: DesktopAuthRoutesOptions = {}) async function startPairing(req: Request, res: Response): Promise { try { - const result = await service.startPairing((req.body as { clientName?: unknown } | undefined)?.clientName); + const body = req.body as Record | undefined; + const result = await service.startPairing(body?.clientName, body); res.status(201).json(result); } catch (error) { sendDesktopAuthError(error, res); } } + async function activatePairing(req: Request, res: Response): Promise { + try { + res.json(await service.activatePairing(pathParameter(req.params.pairingId), req.body)); + } catch (error) { + sendDesktopAuthError(error, res); + } + } + + async function cancelPairing(req: Request, res: Response): Promise { + try { + res.json(await service.cancelPairing(pathParameter(req.params.pairingId), req.body)); + } catch (error) { + sendDesktopAuthError(error, res); + } + } + async function pollPairing(req: Request, res: Response): Promise { try { const result = await service.pollPairing( @@ -148,15 +167,49 @@ export function createDesktopAuthRoutes(options: DesktopAuthRoutesOptions = {}) } } + async function revokeCurrentToken(req: Request, res: Response): Promise { + const authorization = req.header('authorization'); + const credentialGeneration = req.header(DESKTOP_REVOCATION_BINDING_HEADER); + if (!authorization || !/^Bearer propr_it_[A-Za-z0-9_-]{43}$/.test(authorization) + || !credentialGeneration + || !/^[A-Za-z0-9_-]{22}$/.test(credentialGeneration)) { + res.status(403).json({ + code: 'INSTANCE_TOKEN_REQUIRED', + error: 'The current desktop token is required', + }); + return; + } + try { + const result = await service.revokePresentedToken(authorization.slice(7).trim()); + if (result.revoked) { + res.status(204).end(); + return; + } + res.status(result.code === 'TOKEN_NOT_FOUND' ? 404 : 401).json({ + schema: DESKTOP_TOKEN_REVOCATION_SCHEMA, + version: DESKTOP_TOKEN_REVOCATION_VERSION, + endpoint: DESKTOP_TOKEN_REVOCATION_ENDPOINT, + terminal: true, + code: result.code, + credentialGeneration, + }); + } catch (error) { + sendDesktopAuthError(error, res); + } + } + return { browserSessionGuard, approvalOriginGuard, startPairing, pollPairing, + activatePairing, + cancelPairing, getPairingApproval, openPairingApproval, approvePairing, listTokens, + revokeCurrentToken, revokeToken, }; } diff --git a/packages/api/routes/statusRoutes.ts b/packages/api/routes/statusRoutes.ts index 01d414806..2ee6c9820 100644 --- a/packages/api/routes/statusRoutes.ts +++ b/packages/api/routes/statusRoutes.ts @@ -3,6 +3,8 @@ import { Request, Response } from 'express'; import { RedisClientType } from 'redis'; import { isDemoMode } from '../demoMode.js'; import { + PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION, + canonicalProprProxyUrl, getProprCompatibilityMetadata, AGENT_DEFAULTS, resolveGithubAuthMode, @@ -22,6 +24,7 @@ import type { SyntheticAgentConfig } from '@propr/shared'; import path from 'node:path'; import os from 'node:os'; import { applyRoutingStatus, parseConnectAccountStatus, type RoutingState } from './connectAccountStatus.js'; +import { getOrCreatePublicInstanceIdentity } from '../publicInstanceIdentity.js'; interface StatusRoutesDeps { redisClient: RedisClientType; @@ -37,6 +40,7 @@ interface StatusRoutesDeps { snapshot: Record & { timestamp: string }, additionalAdministratorIds: readonly string[], ) => Promise; + getPublicInstanceIdentity?: () => string | Promise; } interface IndexingStatusQueue { @@ -68,7 +72,8 @@ export function createStatusRoutes(deps: StatusRoutesDeps) { agentHealthTimeoutMs = 1500, now = Date.now, loadSummarizationRuntimeState: loadSummarizationRuntimeStateDep = loadSummarizationRuntimeState, - projectSystemSnapshot + projectSystemSnapshot, + getPublicInstanceIdentity: loadPublicInstanceIdentity = getOrCreatePublicInstanceIdentity, } = deps; // Unit/integration callers that replace the direct config loader predate // synthetic pools. Treat that fixture as an empty synthetic document unless @@ -81,11 +86,29 @@ export function createStatusRoutes(deps: StatusRoutesDeps) { res.json(getProprCompatibilityMetadata(!isDemoMode())); } - function getDesktopDiscovery(_req: Request, res: Response): void { - res.json({ - product: 'ProPR', - ...getProprCompatibilityMetadata(!isDemoMode()), + async function getDesktopDiscovery(_req: Request, res: Response): Promise { + // This endpoint is intentionally unauthenticated. Keep it cache-safe and + // bounded, and never include environment/account/credential state. + res.set({ + 'Cache-Control': 'no-store, max-age=0', + Pragma: 'no-cache', + 'X-Content-Type-Options': 'nosniff', }); + try { + res.json({ + schemaVersion: PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION, + product: 'ProPR', + canonicalEndpoint: canonicalProprProxyUrl(process.env.API_PUBLIC_URL) ?? null, + publicInstanceIdentity: await loadPublicInstanceIdentity(), + ...getProprCompatibilityMetadata(!isDemoMode()), + }); + } catch { + // Do not expose a persistence path or parse error through public discovery. + res.status(503).json({ + schemaVersion: PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION, + code: 'IDENTITY_UNAVAILABLE', + }); + } } async function getStatus(req: Request, res: Response): Promise { diff --git a/packages/api/server.ts b/packages/api/server.ts index d36d6a2dc..33561d9e5 100644 --- a/packages/api/server.ts +++ b/packages/api/server.ts @@ -6,7 +6,7 @@ import { createClient, RedisClientType } from 'redis'; import { Queue } from 'bullmq'; import 'dotenv/config'; import { Redis, RedisOptions } from 'ioredis'; -import { authenticateSocketRequest, setupAuth, ensureAuthenticated } from './auth.js'; +import { authenticateSocketRequest, setupAuth } from './auth.js'; import { configureDemoMode, createDemoRedisClient, demoModeReadOnlyMiddleware } from './demoMode.js'; import { resolveGithubAuthMode, resolveGithubEventIntakeMode, validateIntakeModePrerequisites } from '@propr/shared'; import { initSocketService, closeSocketService } from './services/socketService.js'; @@ -62,17 +62,16 @@ import { stopTaskExecution } from './routes/dockerRoutes.js'; import { initializePushSubscriptionMaintenance } from './services/pushSubscriptionMaintenance.js'; import { NotificationProjectionService } from './services/notificationProjectionService.js'; import { WebPushDispatcher } from './services/webPushDispatcher.js'; -import { assertInstanceAdministratorConfigured, resolveAuthorization } from './authorization.js'; +import { assertInstanceAdministratorConfigured } from './authorization.js'; import { resolveApiListenHost } from './listenAddress.js'; import { configureApiProxyTrust, createApiRequestRateLimiter, createDiscoveryRequestRateLimiter, - createPairingPollRateLimiter, - createPairingStartRateLimiter, createWebhookRequestRateLimiter, } from './requestRateLimits.js'; import { desktopAuthService } from './desktopAuthService.js'; +import { prohibitApiResponseCaching } from './apiCacheControl.js'; import { startConfigReloadSubscription, type ConfigReloadSubscription } from './services/configReloadSubscription.js'; import { assertNoDuplicateRoutes, @@ -82,6 +81,7 @@ import { type RouteEntry } from './routeRegistry.js'; import { createTaskDeleteRouteEntries } from './taskDeleteRouteRegistry.js'; +import { registerDesktopApiBoundary } from './desktopApiBoundary.js'; import { startVisualPreviewOAuthRefreshScheduler, type VisualPreviewOAuthRefreshScheduler, @@ -155,6 +155,11 @@ const HOST = resolveApiListenHost(); configureApiProxyTrust(app); +// This is the earliest `/api` response boundary. Keep it before CORS and every +// global or route limiter so success, failure, and saturation responses cannot +// be cached by a browser or intermediary. +app.use('/api', prohibitApiResponseCaching); + if (!process.env.FRONTEND_URL) { console.error('FRONTEND_URL environment variable is required'); process.exit(1); @@ -181,14 +186,6 @@ app.use(corsRejectionHandler); app.use('/api', createApiRequestRateLimiter()); setupWebhookRoute(); -// Prevent caching of API responses to avoid stale CORS issues -app.use('/api', (_req, res, next) => { - res.set('Cache-Control', 'no-store, no-cache, must-revalidate, proxy-revalidate'); - res.set('Pragma', 'no-cache'); - res.set('Expires', '0'); - next(); -}); - app.use(express.json({ limit: '1mb' })); // Register demo read-only protection before routes so future mutating /api routes, @@ -264,11 +261,15 @@ function setupRoutes(): void { // They return only compatibility/capability metadata or pairing state gated by // a high-entropy secret; all operational routes below remain authenticated. app.get('/api/compatibility', createDiscoveryRequestRateLimiter(), statusRoutes.getCompatibility); - app.get('/api/desktop/discovery', createDiscoveryRequestRateLimiter(), statusRoutes.getDesktopDiscovery); - app.post('/api/desktop/pairings', createPairingStartRateLimiter(), desktopAuthRoutes.startPairing); - app.post('/api/desktop/pairings/:pairingId/poll', createPairingPollRateLimiter(), desktopAuthRoutes.pollPairing); - app.get('/api/desktop/pairings/:pairingId/browser', createPairingStartRateLimiter(), desktopAuthRoutes.openPairingApproval); - app.use('/api', ensureAuthenticated, resolveAuthorization); + registerDesktopApiBoundary(app, { + discovery: statusRoutes.getDesktopDiscovery, + startPairing: desktopAuthRoutes.startPairing, + pollPairing: desktopAuthRoutes.pollPairing, + activatePairing: desktopAuthRoutes.activatePairing, + cancelPairing: desktopAuthRoutes.cancelPairing, + openPairingApproval: desktopAuthRoutes.openPairingApproval, + revokeCurrentToken: desktopAuthRoutes.revokeCurrentToken, + }); app.get('/api/desktop/pairings/:pairingId/approval', desktopAuthRoutes.browserSessionGuard, desktopAuthRoutes.getPairingApproval); app.post('/api/desktop/pairings/:pairingId/approve', desktopAuthRoutes.browserSessionGuard, desktopAuthRoutes.approvalOriginGuard, desktopAuthRoutes.approvePairing); app.get('/api/desktop/tokens', desktopAuthRoutes.listTokens); diff --git a/packages/api/services/socketAuthentication.ts b/packages/api/services/socketAuthentication.ts index b0c02141f..b11f60416 100644 --- a/packages/api/services/socketAuthentication.ts +++ b/packages/api/services/socketAuthentication.ts @@ -102,6 +102,8 @@ export function configureSocketAuthentication( io: SocketIOServer, options: SocketAuthenticationOptions, ): void { + const synthesizedAuthorizationRequests = new WeakSet(); + for (const middleware of options.engineMiddleware) { io.engine.use(( request: IncomingMessage, @@ -118,6 +120,15 @@ export function configureSocketAuthentication( io.use(async (socket, next) => { const request = socket.request as unknown as Request; + if (synthesizedAuthorizationRequests.delete(request)) { + delete request.headers.authorization; + } + const handshakeToken = (socket.handshake.auth as { token?: unknown } | undefined)?.token; + if (!request.headers.authorization && typeof handshakeToken === 'string' + && handshakeToken.trim() && !/[\r\n]/.test(handshakeToken)) { + request.headers.authorization = `Bearer ${handshakeToken.trim()}`; + synthesizedAuthorizationRequests.add(request); + } const usesPassportSession = Boolean(request.isAuthenticated?.() && request.user); try { const initialPrincipal = await options.authenticate(request); @@ -154,6 +165,7 @@ export function configureSocketAuthentication( `[SocketAuthentication] Disconnecting socket ${socket.id} after revalidation failed (${code})`, ); delete data.principal; + socket.emit('authentication:error', { code }); socket.disconnect(true); return false; } diff --git a/packages/api/test/connectAuth.test.ts b/packages/api/test/connectAuth.test.ts index a7c7fd44a..c9e6290f3 100644 --- a/packages/api/test/connectAuth.test.ts +++ b/packages/api/test/connectAuth.test.ts @@ -32,11 +32,27 @@ test('local relay mode uses Connect without a per-instance OAuth App', () => { }), 'connect'); }); -test('off-tunnel relay inference rejects callbacks outside the exact loopback allowlist', () => { +test('off-tunnel relay inference uses the shared canonical loopback rule', () => { + for (const callbackUrl of [ + 'http://api.dev.localhost:4000/api/auth/github/callback', + 'http://127.0.0.2:4000/api/auth/github/callback', + 'http://127.42.7.9:4000/api/auth/github/callback', + 'http://[::1]:4000/api/auth/github/callback', + ]) { + assert.equal(resolveBrowserAuthMode({ + PROPR_UI_TUNNEL_ENABLED: 'false', + PROPR_GH_RELAY_URL: 'https://webhook.propr.dev/v1', + PROPR_GH_RELAY_TOKEN: 'prt_secret', + GH_OAUTH_CALLBACK_URL: callbackUrl, + }), 'connect', callbackUrl); + } + for (const callbackUrl of [ 'https://api.example.com/api/auth/github/callback', 'https://localhost:4000/api/auth/github/callback', - 'http://127.0.0.2:4000/api/auth/github/callback', + 'http://127.1:4000/api/auth/github/callback', + 'http://0177.0.0.1:4000/api/auth/github/callback', + 'http://localhost.:4000/api/auth/github/callback', 'http://localhost:4000/not-the-auth-callback', ]) { assert.equal(resolveBrowserAuthMode({ @@ -93,6 +109,19 @@ test('Connect authorization URL carries the exact callback and CSRF state', () = assert.equal(url.searchParams.get('installation_id'), '123'); }); +test('Connect authorization URL rejects configured query strings and fragments', () => { + for (const connectOrigin of [ + 'https://connect.propr.dev?tenant=attacker', + 'https://connect.propr.dev#attacker', + ]) { + assert.throws(() => buildConnectAuthorizationUrl({ + connectOrigin, + callbackUrl: 'https://t-abc.propr.dev/api/auth/github/callback', + state: 'random-state', + }), /PROPR_CONNECT_URL must be a bare HTTPS origin/); + } +}); + test('redeems a Connect code server-to-server without exposing the relay token in the body', async () => { let relayRequest: Request | undefined; let githubRequest: Request | undefined; diff --git a/packages/api/test/corsValidation.test.ts b/packages/api/test/corsValidation.test.ts index 2e960b693..552e9a53b 100644 --- a/packages/api/test/corsValidation.test.ts +++ b/packages/api/test/corsValidation.test.ts @@ -55,7 +55,9 @@ test('CORS allows HTTP(S) loopback origins for development', () => { const validate = createCorsOriginValidator('https://app.propr.dev', undefined); assert.equal(isAllowed(validate, 'http://localhost:5173'), true); + assert.equal(isAllowed(validate, 'http://api.dev.localhost:5173'), true); assert.equal(isAllowed(validate, 'http://127.0.0.1:5173'), true); + assert.equal(isAllowed(validate, 'http://127.42.7.9:5173'), true); assert.equal(isAllowed(validate, 'http://[::1]:5173'), true); assert.equal(isAllowed(validate, 'https://localhost:5173'), true); assert.equal(isAllowed(validate, 'https://[::1]:5173'), true); @@ -70,6 +72,9 @@ test('CORS rejects unsafe schemes and non-loopback hosts', () => { assert.equal(isAllowed(validate, 'file://localhost'), false); assert.equal(isAllowed(validate, 'file://[::1]/tmp/propr'), false); assert.equal(isAllowed(validate, 'http://[2001:db8::1]:5173'), false); + assert.equal(isAllowed(validate, 'http://127.1:5173'), false); + assert.equal(isAllowed(validate, 'http://0177.0.0.1:5173'), false); + assert.equal(isAllowed(validate, 'http://localhost.:5173'), false); }); test('CORS allows COOKIE_DOMAIN subdomains for preview environments', () => { @@ -167,12 +172,19 @@ for (const runtimeMode of ['development', 'production'] as const) { const allowedPreflight = await fetch(`${baseUrl}/api/protected`, { method: 'OPTIONS', headers: { - Origin: 'https://app.propr.dev', + Origin: DESKTOP_RENDERER_ORIGIN, 'Access-Control-Request-Method': 'GET', + 'Access-Control-Request-Headers': 'X-ProPR-Desktop-Transport-Scope, Content-Type', }, }); assert.equal(allowedPreflight.status, 204); - assert.equal(allowedPreflight.headers.get('access-control-allow-origin'), 'https://app.propr.dev'); + // This is the browser's real preflight shape: the requested desktop + // marker is named here, but the marker value itself is not sent on OPTIONS. + assert.equal(allowedPreflight.headers.get('access-control-allow-origin'), DESKTOP_RENDERER_ORIGIN); + assert.equal( + allowedPreflight.headers.get('access-control-allow-headers'), + 'X-ProPR-Desktop-Transport-Scope, Content-Type', + ); }); }); } diff --git a/packages/api/test/demoMode.test.ts b/packages/api/test/demoMode.test.ts index 11a265efd..a05f25523 100644 --- a/packages/api/test/demoMode.test.ts +++ b/packages/api/test/demoMode.test.ts @@ -16,6 +16,7 @@ import { createQueueRoutes } from '../routes/queueRoutes.js'; import { createStatusRoutes } from '../routes/statusRoutes.js'; import { normalizeRepoConfig } from '../routes/configRepoValidation.js'; import type { FlatRequest } from '../requestTypes.js'; +import { createRequestRateLimiter } from '../requestRateLimits.js'; const originalDemoMode = process.env.PROPR_DEMO_MODE; const originalFrontendUrl = process.env.FRONTEND_URL; @@ -170,7 +171,7 @@ test('demo Redis facade covers read-only route Redis usage', async () => { ); }); -test('demo Express GET routes work with the in-memory Redis facade', async () => { +test('demo Express routes work through the test-fixture limiter and remain read-only', async () => { process.env.PROPR_DEMO_MODE = 'true'; process.env.FRONTEND_URL = 'http://localhost:5173'; configureDemoMode(); @@ -185,7 +186,7 @@ test('demo Express GET routes work with the in-memory Redis facade', async () => getDelayedCount: async () => 0, } as never; const app = express(); - app.use(express.json()); + app.use('/api', createRequestRateLimiter({ identifier: 'demo-mode-test-fixture', limit: 100, windowMs: 60_000 }), express.json()); app.use('/api', demoModeReadOnlyMiddleware); setupAuth(app); app.use('/api', ensureAuthenticated); @@ -197,7 +198,7 @@ test('demo Express GET routes work with the in-memory Redis facade', async () => app.post('/api/activity', (_req, res) => res.json({ ok: true })); const statusResponse = await fetchFromApp(app, '/api/status'); - assert.equal(statusResponse.status, 200); + assert.deepEqual([statusResponse.status, statusResponse.headers.get('ratelimit')?.includes('"demo-mode-test-fixture"')], [200, true]); const statusBody = await statusResponse.json() as { redis: string; worker: string; workerCount: number }; assert.equal(statusBody.redis, 'connected'); assert.equal(statusBody.worker, 'running'); diff --git a/packages/api/test/desktopApiBoundary.test.ts b/packages/api/test/desktopApiBoundary.test.ts new file mode 100644 index 000000000..fe1dd2811 --- /dev/null +++ b/packages/api/test/desktopApiBoundary.test.ts @@ -0,0 +1,69 @@ +import assert from 'node:assert/strict'; +import type { AddressInfo } from 'node:net'; +import { after, describe, test } from 'node:test'; +import express, { type RequestHandler } from 'express'; +import { closeConnection } from '@propr/core'; +import { registerDesktopApiBoundary, type DesktopApiBoundaryRoutes } from '../desktopApiBoundary.js'; + +after(async () => closeConnection()); + +const reached = (name: string): RequestHandler => (_req, res) => { + res.status(204).set('X-ProPR-Route', name).end(); +}; + +const publicRoutes: DesktopApiBoundaryRoutes = { + discovery: reached('discovery'), + startPairing: reached('start'), + pollPairing: reached('poll'), + activatePairing: reached('activate'), + cancelPairing: reached('cancel'), + openPairingApproval: reached('browser'), + revokeCurrentToken: reached('revoke'), +}; + +const fetchFromApp = async ( + app: express.Express, + path: string, + init?: RequestInit, +): Promise => { + const server = app.listen(0, '127.0.0.1'); + try { + await new Promise(resolve => server.once('listening', resolve)); + const { port } = server.address() as AddressInfo; + return await fetch(`http://127.0.0.1:${port}${path}`, init); + } finally { + await new Promise((resolve, reject) => { + server.close(error => error ? reject(error) : resolve()); + }); + } +}; + +describe('assembled desktop API authentication boundary', () => { + test('keeps discovery and bounded pairing bootstrap ahead of the operational API guard', async () => { + const app = express(); + app.use(express.json()); + app.use((req, _res, next) => { + req.isAuthenticated = () => false; + next(); + }); + registerDesktopApiBoundary(app, publicRoutes); + app.get('/api/status', (_req, res) => res.json({ operational: true })); + + for (const [method, path, expected] of [ + ['GET', '/api/desktop/discovery', 'discovery'], + ['POST', '/api/desktop/pairings', 'start'], + ['POST', '/api/desktop/pairings/dpr_AAAAAAAAAAAAAAAAAAAAAA/poll', 'poll'], + ['POST', '/api/desktop/pairings/dpr_AAAAAAAAAAAAAAAAAAAAAA/activate', 'activate'], + ['POST', '/api/desktop/pairings/dpr_AAAAAAAAAAAAAAAAAAAAAA/cancel', 'cancel'], + ['GET', '/api/desktop/pairings/dpr_AAAAAAAAAAAAAAAAAAAAAA/browser', 'browser'], + ] as const) { + const response = await fetchFromApp(app, path, { method }); + assert.equal(response.status, 204, `${method} ${path}`); + assert.equal(response.headers.get('x-propr-route'), expected, `${method} ${path}`); + } + + const protectedResponse = await fetchFromApp(app, '/api/status'); + assert.equal(protectedResponse.status, 401); + assert.deepEqual(await protectedResponse.json(), { error: 'Unauthorized' }); + }); +}); diff --git a/packages/api/test/desktopAuth.connectAuthority.test.ts b/packages/api/test/desktopAuth.connectAuthority.test.ts new file mode 100644 index 000000000..2b861308a --- /dev/null +++ b/packages/api/test/desktopAuth.connectAuthority.test.ts @@ -0,0 +1,152 @@ +import assert from 'node:assert/strict'; +import { after, afterEach, beforeEach, describe, test } from 'node:test'; +import knex, { type Knex } from 'knex'; +import { closeConnection } from '@propr/core'; +import { PROPR_API_ORIGIN_PARITY_CASES } from '@propr/shared'; +import { up as createDesktopAuthTables } from '../../core/src/db/migrations/20260829000000_create_desktop_auth.js'; +import { up as addTwoPhaseDesktopPairing } from '../../core/src/db/migrations/20260830000000_add_two_phase_desktop_pairing.js'; +import { DesktopAuthError, DesktopAuthService } from '../desktopAuthService.js'; + +let database: Knex; +let now: Date; + +const pairingBinding = (origin = 'https://app.example.test') => ({ + instanceId: 'profile-a', + origin, + scope: 'desktop-instance' as const, + credentialGeneration: 'G'.repeat(22), +}); + +const startPairing = ( + target: DesktopAuthService, + name: string, + origin = 'https://app.example.test', +) => target.startPairing(name, pairingBinding(origin)); + +beforeEach(async () => { + database = knex({ + client: 'better-sqlite3', + connection: { filename: ':memory:' }, + useNullAsDefault: true, + }); + await createDesktopAuthTables(database); + await addTwoPhaseDesktopPairing(database); + now = new Date('2026-08-29T14:00:00.000Z'); +}); + +afterEach(async () => database.destroy()); +after(async () => closeConnection()); + +describe('desktop managed Connect pairing authority', () => { + test('uses the configured API browser entry and preserves only a managed hosted tunnel selector', async () => { + const hosted = new DesktopAuthService({ + database, + now: () => new Date(now), + approvalBaseUrl: 'https://app.propr.dev', + publicApiUrl: 'https://t-instance123.propr.dev', + }); + const pairing = await startPairing(hosted, 'Windows desktop', 'https://t-instance123.propr.dev'); + + assert.equal( + pairing.approvalUrl, + `https://t-instance123.propr.dev/api/desktop/pairings/${pairing.pairingId}/browser`, + ); + assert.equal( + hosted.getFrontendApprovalUrl(pairing.pairingId).toString(), + `https://app.propr.dev/desktop/pairing?pairing_id=${pairing.pairingId}&tunnel=t-instance123.propr.dev`, + ); + const selfManaged = new DesktopAuthService({ + database, + approvalBaseUrl: 'https://app.propr.dev', + publicApiUrl: 'https://t-tenant.propr.dev.example.com', + }); + assert.equal( + selfManaged.getFrontendApprovalUrl(pairing.pairingId).toString(), + `https://app.propr.dev/desktop/pairing?pairing_id=${pairing.pairingId}`, + ); + }); + + test('does not place a Connect selector in hosted approval URLs for lookalike API hosts', async () => { + const lookalike = new DesktopAuthService({ + database, + now: () => new Date(now), + approvalBaseUrl: 'https://app.propr.dev', + publicApiUrl: 'https://t-instance123.propr.dev.example.com', + }); + const pairing = await startPairing(lookalike, 'Lookalike test'); + + assert.equal( + lookalike.getFrontendApprovalUrl(pairing.pairingId).toString(), + `https://app.propr.dev/desktop/pairing?pairing_id=${pairing.pairingId}`, + ); + }); + + test('rejects noncanonical reserved API_PUBLIC_URL spellings before starting pairing', async () => { + for (const publicApiUrl of [ + ' https://t-instance123.propr.dev', + 'https://t-instance123.propr.dev ', + 'https://t-instance123.propr.dev/', + 'https://t-instance123.propr.dev//', + 'HTTPS://t-instance123.propr.dev', + 'https://T-instance123.propr.dev', + 'https://user:secret@t-instance123.propr.dev', + 'https://t-instance123.propr.dev:443', + 'https://t-instance123.propr.dev?query=secret', + 'https://t-instance123.propr.dev#fragment', + 'https://t-%69nstance123.propr.dev', + 'https://t-%zz.propr.dev', + 'https://x.t-instance123.propr.dev', + 'https://nested.t-instance123.propr.dev', + 'https://t-instance123.propr.dev.', + 'https://t-instance123.extra.propr.dev', + 'https://extra.t-instance123.propr.dev', + 'https://t-аbc.propr.dev', + `https://t-instance123.propr.dev${' '.repeat(2049)}`, + ]) { + const invalidConnect = new DesktopAuthService({ + database, + now: () => new Date(now), + approvalBaseUrl: 'https://app.propr.dev', + publicApiUrl, + }); + + await assert.rejects( + startPairing(invalidConnect, 'Invalid Connect test'), + (error: unknown) => error instanceof DesktopAuthError + && error.code === 'PAIRING_CONFIGURATION_INVALID' + && error.status === 503 + && error.message === 'Desktop pairing is unavailable because the public API URL is invalid', + ); + } + + assert.equal(await database('desktop_pairing_requests').count<{ count: number }>('* as count').first() + .then(result => Number(result?.count)), 0); + }); + + test('pairing rejects mixed-case managed tunnel DNS before URL normalization', () => { + const pairingId = 'dpr_' + 'A'.repeat(22); + const hosted = new DesktopAuthService({ + database, + approvalBaseUrl: 'https://app.propr.dev', + publicApiUrl: 'https://T-Instance123.ProPR.dev', + }); + assert.throws(() => hosted.getFrontendApprovalUrl(pairingId), (error: unknown) => + error instanceof DesktopAuthError + && error.code === 'PAIRING_CONFIGURATION_INVALID' + && !error.message.includes('T-Instance123')); + }); + + test('matches the shared canonical origin parity table for the public REST and Socket origin', async () => { + let index = 0; + for (const [name, input, expected] of PROPR_API_ORIGIN_PARITY_CASES) { + const candidate = new DesktopAuthService({ + database, + approvalBaseUrl: 'https://app.example.test', + publicApiUrl: input, + }); + const start = startPairing(candidate, `Parity ${index++}`, expected ?? 'https://invalid.example.test'); + if (expected === null) await assert.rejects(start, undefined, name); + else assert.equal(new URL((await start).approvalUrl).origin, expected, name); + } + }); +}); diff --git a/packages/api/test/desktopAuth.test.ts b/packages/api/test/desktopAuth.test.ts index 7753ff5be..4b1bef161 100644 --- a/packages/api/test/desktopAuth.test.ts +++ b/packages/api/test/desktopAuth.test.ts @@ -4,14 +4,14 @@ import type { NextFunction, Request, Response } from 'express'; import knex, { type Knex } from 'knex'; import { closeConnection } from '@propr/core'; import { up as createDesktopAuthTables } from '../../core/src/db/migrations/20260829000000_create_desktop_auth.js'; +import { up as addTwoPhaseDesktopPairing } from '../../core/src/db/migrations/20260830000000_add_two_phase_desktop_pairing.js'; import { DesktopAuthError, DesktopAuthService, INSTANCE_TOKEN_PREFIX, } from '../desktopAuthService.js'; import { - isTrustedPairingApprovalOrigin, - requireBrowserPairingSession, + createDesktopAuthRoutes, } from '../routes/desktopAuthRoutes.js'; import type { GitHubUser } from '../authTypes.js'; import { ensureAuthenticated } from '../auth.js'; @@ -29,6 +29,17 @@ const owner: GitHubUser = { let database: Knex; let now: Date; let service: DesktopAuthService; +const pairingBinding = (origin = 'https://app.example.test') => ({ + instanceId: 'profile-a', + origin, + scope: 'desktop-instance' as const, + credentialGeneration: 'G'.repeat(22), +}); +const startPairing = ( + target: DesktopAuthService, + name: string, + origin = 'https://app.example.test', +) => target.startPairing(name, pairingBinding(origin)); beforeEach(async () => { database = knex({ @@ -37,6 +48,7 @@ beforeEach(async () => { useNullAsDefault: true, }); await createDesktopAuthTables(database); + await addTwoPhaseDesktopPairing(database); now = new Date('2026-08-29T14:00:00.000Z'); service = new DesktopAuthService({ database, @@ -50,7 +62,7 @@ after(async () => closeConnection()); describe('desktop browser pairing', () => { test('stores only a device-secret hash and builds a fixed trusted approval URL', async () => { - const pairing = await service.startPairing(' Work Laptop '); + const pairing = await startPairing(service, ' Work Laptop '); const row = await database('desktop_pairing_requests').where({ id: pairing.pairingId }).first(); const audit = await database('desktop_auth_audit').first(); @@ -59,32 +71,15 @@ describe('desktop browser pairing', () => { assert.equal(pairing.approvalUrl, `https://app.example.test/base/desktop/pairing?pairing_id=${pairing.pairingId}`); assert.equal(pairing.approvalUrl.includes(pairing.deviceSecret), false); assert.equal(row.client_name, 'Work Laptop'); + assert.equal(row.requested_origin, 'https://app.example.test'); assert.notEqual(row.device_secret_hash, pairing.deviceSecret); assert.equal(JSON.stringify(row).includes(pairing.deviceSecret), false); assert.equal(JSON.stringify(audit).includes(pairing.deviceSecret), false); }); - test('uses the configured API browser entry and preserves only a managed hosted tunnel selector', async () => { - const hosted = new DesktopAuthService({ - database, - now: () => new Date(now), - approvalBaseUrl: 'https://app.propr.dev', - publicApiUrl: 'https://t-instance123.propr.dev', - }); - const pairing = await hosted.startPairing('Windows desktop'); - - assert.equal( - pairing.approvalUrl, - `https://t-instance123.propr.dev/api/desktop/pairings/${pairing.pairingId}/browser`, - ); - assert.equal( - hosted.getFrontendApprovalUrl(pairing.pairingId).toString(), - `https://app.propr.dev/desktop/pairing?pairing_id=${pairing.pairingId}&tunnel=t-instance123.propr.dev`, - ); - }); - - test('issues an opaque token once, resolves its owner, and never stores plaintext credentials', async () => { - const pairing = await service.startPairing('MacBook Pro'); + test('provisions one unusable credential, then activates it exactly once without storing plaintext', async () => { + const binding = pairingBinding(); + const pairing = await startPairing(service, 'MacBook Pro'); assert.deepEqual(await service.pollPairing(pairing.pairingId, pairing.deviceSecret), { status: 'pending', interval: 5, @@ -92,10 +87,19 @@ describe('desktop browser pairing', () => { await service.approvePairing(pairing.pairingId, owner); const completed = await service.pollPairing(pairing.pairingId, pairing.deviceSecret); - assert.equal(completed.status, 'complete'); - if (completed.status !== 'complete') return; + assert.equal(completed.status, 'provisional'); + if (completed.status !== 'provisional') return; assert.match(completed.token, new RegExp(`^${INSTANCE_TOKEN_PREFIX}[A-Za-z0-9_-]{43}$`)); - assert.equal(completed.expiresAt, null); + assert.equal(await service.validateToken(completed.token), null); + assert.deepEqual(await service.pollPairing(pairing.pairingId, pairing.deviceSecret), completed); + + const activation = { + ...binding, + deviceSecret: pairing.deviceSecret, + activationTicket: completed.activationTicket, + }; + const receipt = await service.activatePairing(pairing.pairingId, activation); + assert.deepEqual(await service.activatePairing(pairing.pairingId, activation), receipt); const tokenRow = await database('instance_api_tokens').first(); const pairingRow = await database('desktop_pairing_requests').first(); @@ -118,7 +122,7 @@ describe('desktop browser pairing', () => { }); test('rejects the wrong secret without revealing pairing state', async () => { - const pairing = await service.startPairing('Linux workstation'); + const pairing = await startPairing(service, 'Linux workstation'); await service.approvePairing(pairing.pairingId, owner); await assert.rejects( @@ -130,6 +134,57 @@ describe('desktop browser pairing', () => { assert.equal((await database('desktop_pairing_requests').first()).status, 'approved'); }); + test('binds activation and cancellation exactly and keeps cancellation idempotent', async () => { + const binding = pairingBinding(); + const pairing = await startPairing(service, 'Cancelled desktop'); + await service.approvePairing(pairing.pairingId, owner); + const provisional = await service.pollPairing(pairing.pairingId, pairing.deviceSecret); + assert.equal(provisional.status, 'provisional'); + if (provisional.status !== 'provisional') return; + const exact = { + ...binding, + deviceSecret: pairing.deviceSecret, + activationTicket: provisional.activationTicket, + }; + await assert.rejects( + service.activatePairing(pairing.pairingId, { ...exact, instanceId: 'wrong-profile' }), + (error: unknown) => error instanceof DesktopAuthError && error.code === 'PAIRING_NOT_FOUND', + ); + assert.equal(await service.validateToken(provisional.token), null); + + const cancelled = await service.cancelPairing(pairing.pairingId, exact); + assert.deepEqual(await service.cancelPairing(pairing.pairingId, exact), cancelled); + await assert.rejects( + service.activatePairing(pairing.pairingId, exact), + (error: unknown) => error instanceof DesktopAuthError && error.code === 'PAIRING_CANCELLED', + ); + assert.equal(await service.validateToken(provisional.token), null); + }); + + test('reuses one provisional across a database restart and cleans it after fixed expiry', async () => { + const expiring = new DesktopAuthService({ + database, + now: () => new Date(now), + provisionalTtlMs: 1_000, + approvalBaseUrl: 'https://app.example.test', + }); + const pairing = await startPairing(expiring, 'Restarted desktop'); + await expiring.approvePairing(pairing.pairingId, owner); + const first = await expiring.pollPairing(pairing.pairingId, pairing.deviceSecret); + const restarted = new DesktopAuthService({ + database, + now: () => new Date(now), + provisionalTtlMs: 1_000, + approvalBaseUrl: 'https://app.example.test', + }); + assert.deepEqual(await restarted.pollPairing(pairing.pairingId, pairing.deviceSecret), first); + assert.equal(await database('instance_api_tokens').where({ activation_state: 'provisional' }).count({ count: '*' }).first() + .then(row => Number(row?.count)), 1); + now = new Date(now.getTime() + 1_001); + await restarted.cleanupPairings(); + assert.equal(await database('instance_api_tokens').count({ count: '*' }).first().then(row => Number(row?.count)), 0); + }); + test('expires unapproved pairings and cleans retained expired records', async () => { const expiringService = new DesktopAuthService({ database, @@ -137,7 +192,7 @@ describe('desktop browser pairing', () => { pairingTtlMs: 1_000, approvalBaseUrl: 'https://app.example.test', }); - const pairing = await expiringService.startPairing('Old laptop'); + const pairing = await startPairing(expiringService, 'Old laptop'); now = new Date(now.getTime() + 1_001); await assert.rejects( @@ -150,20 +205,27 @@ describe('desktop browser pairing', () => { }); test('rejects unsafe names and non-HTTPS approval origins', async () => { - await assert.rejects(service.startPairing('bad\nname'), /printable characters/); - await assert.rejects(service.startPairing('x'.repeat(81)), /1 to 80/); + await assert.rejects(startPairing(service, 'bad\nname'), /printable characters/); + await assert.rejects(startPairing(service, 'x'.repeat(81)), /1 to 80/); const insecure = new DesktopAuthService({ database, approvalBaseUrl: 'http://remote.example.test' }); - await assert.rejects(insecure.startPairing('Laptop'), /requires HTTPS/); + await assert.rejects(startPairing(insecure, 'Laptop'), /requires HTTPS/); }); + }); describe('instance token ownership and revocation', () => { async function issueToken(): Promise<{ token: string; tokenId: string }> { - const pairing = await service.startPairing('Desktop app'); + const binding = pairingBinding(); + const pairing = await startPairing(service, 'Desktop app'); await service.approvePairing(pairing.pairingId, owner); const completed = await service.pollPairing(pairing.pairingId, pairing.deviceSecret); - assert.equal(completed.status, 'complete'); - if (completed.status !== 'complete') throw new Error('token was not issued'); + assert.equal(completed.status, 'provisional'); + if (completed.status !== 'provisional') throw new Error('token was not issued'); + await service.activatePairing(pairing.pairingId, { + ...binding, + deviceSecret: pairing.deviceSecret, + activationTicket: completed.activationTicket, + }); const tokenId = (await service.listTokens(owner.id))[0].id; return { token: completed.token, tokenId }; } @@ -198,6 +260,74 @@ describe('instance token ownership and revocation', () => { assert.equal(await service.validateToken(token), null); }); + test('lets a desktop revoke only the instance token authenticating its request', async () => { + const { token, tokenId } = await issueToken(); + const routes = createDesktopAuthRoutes({ service, frontendUrl: 'https://app.example.test' }); + let statusCode = 200; + let ended = false; + const response = { + status(value: number) { statusCode = value; return response; }, + json() { return response; }, + end() { ended = true; return response; }, + } as unknown as Response; + + await routes.revokeCurrentToken({ + user: owner, + authenticationMethod: 'instance_token', + instanceTokenId: tokenId, + header(name: string) { + if (name.toLowerCase() === 'authorization') return `Bearer ${token}`; + if (name.toLowerCase() === 'x-propr-desktop-revocation-binding') return 'A'.repeat(22); + return undefined; + }, + } as unknown as Request, response); + + assert.equal(statusCode, 204); + assert.equal(ended, true); + assert.equal(await service.validateToken(token), null); + }); + + test('returns the versioned endpoint-bound terminal contract on repeated self-revocation', async () => { + const { token } = await issueToken(); + const routes = createDesktopAuthRoutes({ service, frontendUrl: 'https://app.example.test' }); + const binding = 'G'.repeat(22); + const request = { + header(name: string) { + if (name.toLowerCase() === 'authorization') return `Bearer ${token}`; + if (name.toLowerCase() === 'x-propr-desktop-revocation-binding') return binding; + return undefined; + }, + } as unknown as Request; + const replies: Array<{ status: number; body?: unknown }> = []; + const makeResponse = () => { + const reply: { status: number; body?: unknown } = { status: 200 }; + replies.push(reply); + const response = { + status(value: number) { reply.status = value; return response; }, + json(value: unknown) { reply.body = value; return response; }, + end() { return response; }, + } as unknown as Response; + return response; + }; + + await routes.revokeCurrentToken(request, makeResponse()); + await routes.revokeCurrentToken(request, makeResponse()); + assert.deepEqual(replies, [ + { status: 204 }, + { + status: 401, + body: { + schema: 'propr.desktop-token-revocation', + version: 1, + endpoint: '/api/desktop/tokens/current', + terminal: true, + code: 'INSTANCE_TOKEN_REVOKED', + credentialGeneration: binding, + }, + }, + ]); + }); + test('REST authentication accepts instance tokens while optional GitHub bearer auth is disabled', async () => { const original = process.env.ENABLE_BEARER_AUTH; process.env.ENABLE_BEARER_AUTH = 'false'; @@ -223,39 +353,3 @@ describe('instance token ownership and revocation', () => { assert.equal(request.user?.id, owner.id); }); }); - -describe('pairing approval request protection', () => { - test('accepts only the exact HTTPS frontend origin', () => { - assert.equal(isTrustedPairingApprovalOrigin('https://app.example.test', 'https://app.example.test/path'), true); - assert.equal(isTrustedPairingApprovalOrigin('https://preview.app.example.test', 'https://app.example.test'), false); - assert.equal(isTrustedPairingApprovalOrigin('http://app.example.test', 'https://app.example.test'), false); - assert.equal(isTrustedPairingApprovalOrigin(undefined, 'https://app.example.test'), false); - }); - - test('requires a browser session even when another authentication method supplied the user', () => { - const guard = requireBrowserPairingSession(); - const calls: Array<{ status?: number; body?: unknown }> = []; - const response = { - status(value: number) { calls.push({ status: value }); return response; }, - json(value: unknown) { calls[calls.length - 1].body = value; return response; }, - } as unknown as Response; - let nextCalls = 0; - const next = (() => { nextCalls++; }) as NextFunction; - - guard({ - authenticationMethod: 'instance_token', - user: owner, - isAuthenticated: () => false, - header: () => 'https://app.example.test', - } as unknown as Request, response, next); - assert.equal(calls[0].status, 403); - - guard({ - authenticationMethod: 'session', - user: owner, - isAuthenticated: () => true, - header: () => 'https://app.example.test', - } as unknown as Request, response, next); - assert.equal(nextCalls, 1); - }); -}); diff --git a/packages/api/test/desktopAuthRoutes.test.ts b/packages/api/test/desktopAuthRoutes.test.ts new file mode 100644 index 000000000..9eede097d --- /dev/null +++ b/packages/api/test/desktopAuthRoutes.test.ts @@ -0,0 +1,59 @@ +import assert from 'node:assert/strict'; +import { after, describe, test } from 'node:test'; +import type { NextFunction, Request, Response } from 'express'; +import { closeConnection } from '@propr/core'; +import { + isTrustedPairingApprovalOrigin, + requireBrowserPairingSession, +} from '../routes/desktopAuthRoutes.js'; +import type { GitHubUser } from '../authTypes.js'; + +const owner: GitHubUser = { + id: '101', + login: 'desktop-owner', + username: 'desktop-owner', + displayName: 'Desktop Owner', + email: 'owner@example.test', + avatarUrl: 'https://avatars.example.test/101', + accessToken: 'github-secret-that-must-not-be-stored', +}; + +after(async () => closeConnection()); + +describe('pairing approval request protection', () => { + test('accepts only the exact HTTPS frontend origin', () => { + assert.equal(isTrustedPairingApprovalOrigin('https://app.example.test', 'https://app.example.test/path'), true); + assert.equal(isTrustedPairingApprovalOrigin('https://preview.app.example.test', 'https://app.example.test'), false); + assert.equal(isTrustedPairingApprovalOrigin('http://app.example.test', 'https://app.example.test'), false); + assert.equal(isTrustedPairingApprovalOrigin('http://127.1:3000', 'http://127.0.0.1:3000'), false); + assert.equal(isTrustedPairingApprovalOrigin('http://local%68ost:3000', 'http://localhost:3000'), false); + assert.equal(isTrustedPairingApprovalOrigin(undefined, 'https://app.example.test'), false); + }); + + test('requires a browser session even when another authentication method supplied the user', () => { + const guard = requireBrowserPairingSession(); + const calls: Array<{ status?: number; body?: unknown }> = []; + const response = { + status(value: number) { calls.push({ status: value }); return response; }, + json(value: unknown) { calls[calls.length - 1].body = value; return response; }, + } as unknown as Response; + let nextCalls = 0; + const next = (() => { nextCalls++; }) as NextFunction; + + guard({ + authenticationMethod: 'instance_token', + user: owner, + isAuthenticated: () => false, + header: () => 'https://app.example.test', + } as unknown as Request, response, next); + assert.equal(calls[0].status, 403); + + guard({ + authenticationMethod: 'session', + user: owner, + isAuthenticated: () => true, + header: () => 'https://app.example.test', + } as unknown as Request, response, next); + assert.equal(nextCalls, 1); + }); +}); diff --git a/packages/api/test/requestRateLimits.test.ts b/packages/api/test/requestRateLimits.test.ts index 0920d3562..6799757ce 100644 --- a/packages/api/test/requestRateLimits.test.ts +++ b/packages/api/test/requestRateLimits.test.ts @@ -5,9 +5,12 @@ import express from 'express'; import session from 'express-session'; import { configureApiProxyTrust, + createApiRequestRateLimiter, + createDiscoveryRequestRateLimiter, createRequestRateLimiter, resolveRequestRateLimitPolicies, } from '../requestRateLimits.js'; +import { prohibitApiResponseCaching } from '../apiCacheControl.js'; interface TestAppOptions { proxyEnvironment?: Record; @@ -77,6 +80,56 @@ test('returns a standard 429 response after the configured quota', async () => { }); }); +test('the real global API limiter keeps no-store headers when saturated', async () => { + const app = express(); + app.use('/api', prohibitApiResponseCaching); + app.use('/api', createApiRequestRateLimiter({ + PROPR_API_RATE_LIMIT_MAX: '1', + PROPR_API_RATE_LIMIT_WINDOW_MS: '60000', + })); + app.get('/api/resource', (_request, response) => response.json({ ok: true })); + const server = await listenTestApp(app); + openServers.push(server.close); + + const success = await fetch(`${server.origin}/api/resource`); + const limited = await fetch(`${server.origin}/api/resource`); + assert.equal(success.status, 200); + assert.equal(limited.status, 429); + for (const response of [success, limited]) { + assert.equal(response.headers.get('cache-control'), 'no-store, max-age=0'); + assert.equal(response.headers.get('pragma'), 'no-cache'); + } +}); + +test('route limiting, 503, and errors inherit the earliest API no-store boundary', async () => { + const app = express(); + app.use('/api', prohibitApiResponseCaching); + app.get('/api/discovery', createDiscoveryRequestRateLimiter({ + PROPR_DISCOVERY_RATE_LIMIT_MAX: '1', + PROPR_DISCOVERY_RATE_LIMIT_WINDOW_MS: '60000', + }), (_request, response) => response.json({ ok: true })); + app.get('/api/unavailable', (_request, response) => response.status(503).json({ unavailable: true })); + app.get('/api/error', () => { throw new Error('private failure'); }); + app.use((_error: unknown, _request: express.Request, response: express.Response, _next: express.NextFunction) => { + void _next; + response.status(500).json({ error: 'Internal server error' }); + }); + const server = await listenTestApp(app); + openServers.push(server.close); + + const responses = [ + await fetch(`${server.origin}/api/discovery`), + await fetch(`${server.origin}/api/discovery`), + await fetch(`${server.origin}/api/unavailable`), + await fetch(`${server.origin}/api/error`), + ]; + assert.deepEqual(responses.map(response => response.status), [200, 429, 503, 500]); + for (const response of responses) { + assert.equal(response.headers.get('cache-control'), 'no-store, max-age=0'); + assert.equal(response.headers.get('pragma'), 'no-cache'); + } +}); + test('does not charge CORS preflight requests against the quota', async () => { const app = await startTestApp(1); openServers.push(app.close); diff --git a/packages/api/test/sessionCookie.test.ts b/packages/api/test/sessionCookie.test.ts index 5f3d3c085..c12c9950d 100644 --- a/packages/api/test/sessionCookie.test.ts +++ b/packages/api/test/sessionCookie.test.ts @@ -43,6 +43,23 @@ test('secure session cookie follows API_PUBLIC_URL protocol for HTTPS and localh process.env.API_PUBLIC_URL = 'http://[::1]:4000'; assert.equal(shouldUseSecureSessionCookie('.example.com'), false); + + process.env.API_PUBLIC_URL = 'http://api.dev.localhost:4000'; + assert.equal(shouldUseSecureSessionCookie('.example.com'), false); + + process.env.API_PUBLIC_URL = 'http://127.42.7.9:4000'; + assert.equal(shouldUseSecureSessionCookie('.example.com'), false); + + process.env.API_PUBLIC_URL = 'http://127.1:4000'; + assert.equal(shouldUseSecureSessionCookie('.example.com'), true); +}); + +test('noncanonical HTTPS public URL keeps the session cookie secure in development', () => { + process.env.NODE_ENV = 'development'; + delete process.env.COOKIE_DOMAIN; + process.env.API_PUBLIC_URL = 'https://api.example.test/path'; + + assert.equal(shouldUseSecureSessionCookie(undefined), true); }); test('secure session cookie does not downgrade for non-localhost HTTP public URL', () => { diff --git a/packages/api/test/socketAuthentication.test.ts b/packages/api/test/socketAuthentication.test.ts index d1bc5a3a3..d93da195e 100644 --- a/packages/api/test/socketAuthentication.test.ts +++ b/packages/api/test/socketAuthentication.test.ts @@ -172,7 +172,7 @@ describe('Socket.IO authentication', () => { ); }); - test('runs Engine.IO middleware before the mandatory identity gate', async () => { + test('runs Engine.IO middleware and maps browser Socket.IO auth into the shared bearer gate', async () => { const httpServer = createServer(); const io = new SocketIOServer(httpServer, { transports: ['websocket'] }); const markerMiddleware: RequestHandler = (req, _res, next) => { @@ -196,7 +196,7 @@ describe('Socket.IO authentication', () => { const port = (httpServer.address() as AddressInfo).port; const client = createSocketClient(`http://127.0.0.1:${port}`, { transports: ['websocket'], - extraHeaders: { Authorization: 'Bearer test-token' }, + auth: { token: 'test-token' }, reconnection: false, }); @@ -210,6 +210,112 @@ describe('Socket.IO authentication', () => { } }); + test('refreshes synthesized bearer auth on namespace reconnects over the same Engine.IO connection', async () => { + const httpServer = createServer(); + const io = new SocketIOServer(httpServer, { transports: ['websocket'] }); + const seenAuthorization: Array = []; + configureSocketAuthentication(io, { + engineMiddleware: [], + authenticate: async req => { + const authorization = req.headers.authorization; + seenAuthorization.push(authorization); + if (authorization === 'Bearer initial-token') return principal(user({ id: '1' })); + if (authorization === 'Bearer replacement-token') return principal(user({ id: '2' })); + throw new SocketAuthenticationError('AUTHENTICATION_REQUIRED', 'missing bearer'); + }, + }); + let serverSocket: ServerSocket | undefined; + io.on('connection', socket => { + serverSocket = socket; + }); + io.of('/anchor').on('connection', () => undefined); + await new Promise(resolve => httpServer.listen(0, '127.0.0.1', resolve)); + const port = (httpServer.address() as AddressInfo).port; + const client = createSocketClient(`http://127.0.0.1:${port}`, { + transports: ['websocket'], + auth: { token: 'initial-token' }, + autoConnect: false, + reconnection: false, + }); + const anchor = client.io.socket('/anchor'); + + try { + client.connect(); + anchor.connect(); + await waitFor( + () => client.connected && anchor.connected, + 'Initial namespaces did not connect', + ); + const engineId = client.io.engine?.id; + assert(engineId); + + const initialServerSocket = serverSocket; + assert(initialServerSocket); + const initiallyDisconnected = new Promise(resolve => { + initialServerSocket.once('disconnect', () => resolve()); + }); + client.disconnect(); + await initiallyDisconnected; + client.auth = { token: 'replacement-token' }; + const reconnected = waitForConnect(client); + client.connect(); + await reconnected; + assert.equal(client.io.engine?.id, engineId); + + const replacementServerSocket = serverSocket; + assert(replacementServerSocket); + const replacementDisconnected = new Promise(resolve => { + replacementServerSocket.once('disconnect', () => resolve()); + }); + client.disconnect(); + await replacementDisconnected; + client.auth = {}; + const rejected = waitForConnectError(client); + client.connect(); + const error = await rejected; + assert.equal(error.data?.code, 'AUTHENTICATION_REQUIRED'); + assert.equal(client.io.engine?.id, engineId); + assert.deepEqual(seenAuthorization, [ + 'Bearer initial-token', + 'Bearer replacement-token', + undefined, + ]); + } finally { + client.disconnect(); + anchor.disconnect(); + await io.close(); + await new Promise(resolve => httpServer.close(() => resolve())); + } + }); + + test('preserves transport-level Authorization instead of Socket.IO auth', async () => { + const httpServer = createServer(); + const io = new SocketIOServer(httpServer, { transports: ['websocket'] }); + configureSocketAuthentication(io, { + engineMiddleware: [], + authenticate: async req => { + assert.equal(req.headers.authorization, 'Bearer transport-token'); + return principal(); + }, + }); + await new Promise(resolve => httpServer.listen(0, '127.0.0.1', resolve)); + const port = (httpServer.address() as AddressInfo).port; + const client = createSocketClient(`http://127.0.0.1:${port}`, { + transports: ['websocket'], + extraHeaders: { Authorization: 'Bearer transport-token' }, + auth: { token: 'socket-token' }, + reconnection: false, + }); + + try { + await waitForConnect(client); + } finally { + client.disconnect(); + await io.close(); + await new Promise(resolve => httpServer.close(() => resolve())); + } + }); + test('surfaces a stable authentication error code to rejected clients', async () => { const httpServer = createServer(); const io = new SocketIOServer(httpServer, { transports: ['websocket'] }); diff --git a/packages/api/test/statusRoutes.test.ts b/packages/api/test/statusRoutes.test.ts index e3b0a3d97..b1c37a15b 100644 --- a/packages/api/test/statusRoutes.test.ts +++ b/packages/api/test/statusRoutes.test.ts @@ -4,7 +4,12 @@ import { after, afterEach, test } from 'node:test'; import type { Request, Response as ExpressResponse } from 'express'; import type { Agent, AgentConfig } from '@propr/core'; import type { RedisClientType } from 'redis'; -import { PROPR_API_COMPATIBILITY, PROPR_UI_COMPATIBILITY, PROPR_VERSION } from '@propr/shared'; +import { + PROPR_API_COMPATIBILITY, + PROPR_UI_COMPATIBILITY, + PROPR_VERSION, + parseProprDesktopDiscovery, +} from '@propr/shared'; import type { SyntheticAgentConfig } from '@propr/shared'; type StatusRoutesDeps = { @@ -26,6 +31,7 @@ type StatusRoutesDeps = { snapshot: Record & { timestamp: string }, additionalAdministratorIds: readonly string[], ) => Promise; + getPublicInstanceIdentity?: () => string; }; type StatusAgentRegistry = { @@ -59,15 +65,22 @@ const MANAGED_ENV_VARS = [ 'PROPR_GH_RELAY_TOKEN', 'GITHUB_EVENT_INTAKE_MODE', 'ENABLE_GITHUB_WEBHOOKS', + 'API_PUBLIC_URL', ] as const; const originalEnv: Record = Object.fromEntries( MANAGED_ENV_VARS.map((key) => [key, process.env[key]]), ); -function createJsonResponse(): { response: ExpressResponse; status: () => number; body: () => Record } { +function createJsonResponse(): { + response: ExpressResponse; + status: () => number; + body: () => Record; + headers: () => Record; +} { let statusCode = 200; let payload: Record = {}; + let responseHeaders: Record = {}; const response = { status(code: number) { statusCode = code; @@ -76,9 +89,18 @@ function createJsonResponse(): { response: ExpressResponse; status: () => number json(body: Record) { payload = body; return response; - } + }, + set(headers: Record) { + responseHeaders = { ...responseHeaders, ...headers }; + return response; + }, } as unknown as ExpressResponse; - return { response, status: () => statusCode, body: () => payload }; + return { + response, + status: () => statusCode, + body: () => payload, + headers: () => responseHeaders, + }; } function createRedisClient() { @@ -208,7 +230,7 @@ test('/api/compatibility returns public version contract metadata', async () => apiCompatibility: PROPR_API_COMPATIBILITY, uiCompatibility: PROPR_UI_COMPATIBILITY, desktopAuthentication: { - protocolVersion: 1, + protocolVersion: 2, browserPairing: true, instanceBearerTokens: true, socketIoBearerAuthentication: true, @@ -216,25 +238,55 @@ test('/api/compatibility returns public version contract metadata', async () => }); }); -test('/api/desktop/discovery adds only the stable product name to compatibility metadata', async () => { +test('/api/desktop/discovery returns the bounded public identity and runtime origin', async () => { configureStatusEnv(); - const { response, body } = createJsonResponse(); - const routes = await createRoutes({ redisClient: createRedisClient() as never }); + process.env.API_PUBLIC_URL = 'https://t-abc123.propr.dev'; + const { response, body, headers } = createJsonResponse(); + const routes = await createRoutes({ + redisClient: createRedisClient() as never, + getPublicInstanceIdentity: () => 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa', + }); - routes.getDesktopDiscovery({} as Request, response); + await routes.getDesktopDiscovery({} as Request, response); assert.deepEqual(body(), { + schemaVersion: 1, product: 'ProPR', + canonicalEndpoint: 'https://t-abc123.propr.dev', + publicInstanceIdentity: 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa', version: PROPR_VERSION, apiCompatibility: PROPR_API_COMPATIBILITY, uiCompatibility: PROPR_UI_COMPATIBILITY, desktopAuthentication: { - protocolVersion: 1, + protocolVersion: 2, browserPairing: true, instanceBearerTokens: true, socketIoBearerAuthentication: true, }, }); + assert.equal(headers()['Cache-Control'], 'no-store, max-age=0'); + assert.equal(JSON.stringify(body()).includes('SENTINEL'), false); + assert.deepEqual(parseProprDesktopDiscovery(body()), body()); +}); + +test('/api/desktop/discovery redacts identity persistence failures', async () => { + configureStatusEnv(); + process.env.API_PUBLIC_URL = 'https://t-abc123.propr.dev'; + const { response, status, body, headers } = createJsonResponse(); + const routes = await createRoutes({ + redisClient: createRedisClient() as never, + getPublicInstanceIdentity: () => { + throw new Error('/private/path includes connector-token-SENTINEL'); + }, + }); + + await routes.getDesktopDiscovery({} as Request, response); + + assert.equal(status(), 503); + assert.deepEqual(body(), { schemaVersion: 1, code: 'IDENTITY_UNAVAILABLE' }); + assert.equal(headers()['Cache-Control'], 'no-store, max-age=0'); + assert.equal(headers().Pragma, 'no-cache'); + assert.equal(JSON.stringify(body()).includes('SENTINEL'), false); }); test('/api/status returns default Claude fallback when no agents are configured', async () => { diff --git a/packages/api/test/webPushDispatcher.test.ts b/packages/api/test/webPushDispatcher.test.ts index d6cb6b89d..41cd78f34 100644 --- a/packages/api/test/webPushDispatcher.test.ts +++ b/packages/api/test/webPushDispatcher.test.ts @@ -14,11 +14,39 @@ import { WebPushDispatcher } from '../services/webPushDispatcher.js'; const success: SendResult = { statusCode: 201, body: '', headers: {} }; const HISTORICAL_FIXTURE_TIME = Date.parse('2020-01-01T00:00:00.000Z'); +const DISPATCH_FIXTURE_TIME = HISTORICAL_FIXTURE_TIME + 60_000; +const ISO_TIMESTAMP_FORMAT = '%Y-%m-%dT%H:%M:%fZ'; + +interface TestSqliteConnection extends BetterSqliteConnection { + function( + name: string, + options: { varargs: true }, + callback: (...values: unknown[]) => string | null, + ): void; +} function historicalFixtureTime(): Date { return new Date(HISTORICAL_FIXTURE_TIME); } +function dispatchFixtureTime(): Date { + return new Date(DISPATCH_FIXTURE_TIME); +} + +function fixtureStrftime(format: unknown, value: unknown, ...modifiers: unknown[]): string | null { + if (format !== ISO_TIMESTAMP_FORMAT) return null; + let timestamp = value === 'now' + ? DISPATCH_FIXTURE_TIME + : Date.parse(String(value)); + if (!Number.isFinite(timestamp)) return null; + for (const modifier of modifiers) { + const seconds = /^([+-]\d+(?:\.\d+)?) seconds$/.exec(String(modifier)); + if (!seconds) return null; + timestamp += Number(seconds[1]) * 1_000; + } + return new Date(timestamp).toISOString(); +} + function createDatabase(): Knex { return knex({ client: 'better-sqlite3', @@ -26,9 +54,11 @@ function createDatabase(): Knex { useNullAsDefault: true, pool: { afterCreate( - connection: BetterSqliteConnection, - done: (error: Error | null, connection: BetterSqliteConnection) => void, + connection: TestSqliteConnection, + done: (error: Error | null, connection: TestSqliteConnection) => void, ) { + // Keep SQLite claim/lease checks on the dispatcher's fixed fixture clock. + connection.function('strftime', { varargs: true }, fixtureStrftime); connection.pragma('foreign_keys = ON'); connection.pragma('recursive_triggers = ON'); done(null, connection); @@ -38,7 +68,7 @@ function createDatabase(): Knex { } function vapidConfiguration() { - // Keep the fixture exactly 32 bytes; getPrivateKey() can omit leading zeroes. + // Keep the fixture full-width because getPrivateKey() can omit leading zero bytes. const privateKey = Buffer.alloc(32); privateKey[31] = 1; const ecdh = createECDH('prime256v1'); @@ -127,6 +157,7 @@ function dispatcher(sender: { apiBaseUrl: 'https://api.example.com', leaseMs: 5_000, requestTimeoutMs: 1_000, + now: dispatchFixtureTime, ...overrides, }); } @@ -262,7 +293,7 @@ describe('Web Push dispatcher', { concurrency: false }, () => { }); test('does not claim work during quiet hours', async () => { - const now = new Date(); + const now = dispatchFixtureTime(); const start = `${String(now.getUTCHours()).padStart(2, '0')}:${String(now.getUTCMinutes()).padStart(2, '0')}`; const endDate = new Date(now.getTime() + 60_000); const end = `${String(endDate.getUTCHours()).padStart(2, '0')}:${String(endDate.getUTCMinutes()).padStart(2, '0')}`; @@ -278,7 +309,7 @@ describe('Web Push dispatcher', { concurrency: false }, () => { }); test('paginates past a quiet-hour prefix larger than the scan window', async () => { - const fixtureBaseTime = Date.now() - 30_000; + const fixtureBaseTime = HISTORICAL_FIXTURE_TIME; let fixtureTick = 0; const fixtureService = new NotificationService({ database, @@ -293,7 +324,7 @@ describe('Web Push dispatcher', { concurrency: false }, () => { quietUsers.push(queued.userId); } const eligible = await queuedEvent({ service: fixtureService }); - const dispatchAt = new Date(); + const dispatchAt = dispatchFixtureTime(); const currentMinute = dispatchAt.getUTCHours() * 60 + dispatchAt.getUTCMinutes(); const formatMinute = (minute: number) => { const normalized = (minute + 24 * 60) % (24 * 60); @@ -429,6 +460,7 @@ describe('Web Push dispatcher', { concurrency: false }, () => { apiBaseUrl: 'http://127.0.0.1:4000', leaseMs: 5_000, requestTimeoutMs: 1_000, + now: dispatchFixtureTime, }); assert.equal(await worker.runOnce(), 1); @@ -545,7 +577,7 @@ describe('Web Push dispatcher', { concurrency: false }, () => { test('renews the current claim to cover the request timeout and safety margin', async () => { await queuedEvent(); - const baseTime = Date.now() - 4_000; + const baseTime = DISPATCH_FIXTURE_TIME - 4_000; let nowCalls = 0; let lastNow = baseTime; const requestTimeoutMs = 4_999; @@ -571,7 +603,7 @@ describe('Web Push dispatcher', { concurrency: false }, () => { test('skips network I/O when the claim expires during delivery preparation', async () => { await queuedEvent(); - const baseTime = Date.now() - 1_000; + const baseTime = DISPATCH_FIXTURE_TIME - 1_000; const leaseMs = 30_000; let nowCalls = 0; let sends = 0; @@ -580,7 +612,7 @@ describe('Web Push dispatcher', { concurrency: false }, () => { }, { leaseMs, requestTimeoutMs: leaseMs - 1, - // Keep the initial claim ahead of SQLite's real clock, then expire it before renewal. + // Keep the initial claim ahead of SQLite's fixture clock, then expire it before renewal. now: () => new Date(baseTime + (nowCalls++ >= 3 ? leaseMs + 1_000 : 0)), }); diff --git a/packages/cli/README.md b/packages/cli/README.md index 4ae41d4ed..e5dd1217f 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -97,8 +97,14 @@ Useful follow-up commands: propr tunnel verify # check cloudflared + /api/status, /, /socket.io/ propr tunnel off # stop only the sidecar; token/env values stay in .env propr tunnel on # restart the sidecar later +propr connect status --json --root /path/to/stack # secret-free desktop discovery ``` +`connect status` requires an explicit caller-owned stack root and never scans the +filesystem. Its JSON stdout contains no tokens, account/repository/host identity, +environment values, or paths. Exit codes are 0 ready, 2 known not ready, 3 +incompatible, 4 invalid configuration/root, 5 timeout, and 1 internal failure. + `propr tunnel off` intentionally leaves the Connect-written `.env` values in place. If you are switching the same stack back to a local or custom self-hosted UI, remove or replace `PROPR_UI_PUBLIC_API_URL`, `API_PUBLIC_URL`, diff --git a/packages/cli/native/README.md b/packages/cli/native/README.md index ec45d45c1..99213ab3e 100644 --- a/packages/cli/native/README.md +++ b/packages/cli/native/README.md @@ -1,21 +1,20 @@ -# Native directory operations +# Native directory and Darwin ACL operations `directory-operations.c` is the complete source for the small N-API helper used by the Agent Skill installer on macOS and for atomic sibling moves on Linux. It -exposes only audited, dirfd-relative POSIX operations. Sibling moves use -`renameatx_np(..., RENAME_EXCL)` on Darwin and -`renameat2(..., RENAME_NOREPLACE)` on Linux. The CLI ships prebuilt N-API -binaries for arm64 and x64, so installing or running `propr` never invokes +exposes only audited, dirfd-relative POSIX operations. The CLI ships prebuilt +N-API binaries for arm64 and x64, so installing or running `propr` never invokes Python, a compiler, `node-gyp`, or another host build tool. -The runtime loader selects the artifact by `process.platform` and -`process.arch`, verifies its hard-coded SHA-256 digest before loading it, and -fails closed if the architecture is unsupported, the artifact is absent, or -its bytes do not match. N-API 8 keeps the artifacts compatible with all Node -versions supported by this package (Node 22 and newer). +`darwin-authority-broker.c` is the macOS Connect ACL diagnostic helper. It +receives the caller's already-held object as inherited fd 3 and uses `fstat`, +`acl_extended_fd_np`, `acl_get_fd_np`, and `acl_to_text` on that same descriptor. +It emits one bounded versioned document, and the CLI verifies the packaged +binary's SHA-256 before running it from a private staged path. -The checked-in binaries are built from this source with hidden symbols and -runtime lookup for Node's N-API and operating-system symbols. Release CI runs -the real lifecycle and detached-parent race proof on native Linux and arm64 -macOS hosts. Linux continues to use its traversable `/proc/self/fd` -implementation for operations other than the atomic move. +Windows Connect status deliberately has no native helper in this package. It +retains descriptor, reparse-point, replacement, and identity checks, but fails +closed with `invalidConfig` and `ACL_DIAGNOSTIC_UNAVAILABLE` when Node cannot +safely obtain a same-handle DACL diagnostic. Windows operations that would need +DACL mutation or privileged launch authority return `WINDOWS_AUTHORITY_REQUIRED` +until #1997 lands. diff --git a/packages/cli/native/darwin-authority-broker.c b/packages/cli/native/darwin-authority-broker.c new file mode 100644 index 000000000..f6c9c7b77 --- /dev/null +++ b/packages/cli/native/darwin-authority-broker.c @@ -0,0 +1,120 @@ +#include +#include +#include + +#include +#include +#include +#include +#include + +#define PROPR_AUTHORITY_FD 3 +#define PROPR_MAX_ACL_TEXT 24576 +#define PROPR_MAX_JSON 32768 + +static int append_bytes(char *output, size_t *length, const char *value, size_t value_length) { + if (value_length > PROPR_MAX_JSON - *length) return -1; + memcpy(output + *length, value, value_length); + *length += value_length; + return 0; +} + +static int append_json_string(char *output, size_t *length, const char *value, size_t value_length) { + static const char hex[] = "0123456789abcdef"; + if (append_bytes(output, length, "\"", 1) != 0) return -1; + for (size_t index = 0; index < value_length; index += 1) { + unsigned char byte = (unsigned char)value[index]; + if (byte == '"' || byte == '\\') { + char escaped[2] = {'\\', (char)byte}; + if (append_bytes(output, length, escaped, sizeof(escaped)) != 0) return -1; + } else if (byte == '\n') { + if (append_bytes(output, length, "\\n", 2) != 0) return -1; + } else if (byte == '\r') { + if (append_bytes(output, length, "\\r", 2) != 0) return -1; + } else if (byte == '\t') { + if (append_bytes(output, length, "\\t", 2) != 0) return -1; + } else if (byte < 0x20) { + char escaped[6] = {'\\', 'u', '0', '0', hex[byte >> 4], hex[byte & 15]}; + if (append_bytes(output, length, escaped, sizeof(escaped)) != 0) return -1; + } else if (append_bytes(output, length, (const char *)&value[index], 1) != 0) { + return -1; + } + } + return append_bytes(output, length, "\"", 1); +} + +static int same_identity(const struct stat *left, const struct stat *right) { + return left->st_dev == right->st_dev && left->st_ino == right->st_ino; +} + +int main(void) { + struct stat before; + struct stat after; + if (fstat(PROPR_AUTHORITY_FD, &before) != 0) return 10; + + /* Apple's descriptor implementation reports an absent FILESEC_ACL property + as NULL/ENOENT. Every other NULL/errno pair is a real allocation, + descriptor, filesystem, or inspection failure and remains fatal. */ + errno = 0; + acl_t acl = NULL; + char *allocated_acl_text = NULL; + const char *acl_text = "!#acl 1\n"; + ssize_t acl_length = 8; + acl = acl_get_fd_np(PROPR_AUTHORITY_FD, ACL_TYPE_EXTENDED); + if (acl == NULL) { + if (errno != ENOENT) return 11; + } else { + allocated_acl_text = acl_to_text(acl, &acl_length); + if (allocated_acl_text == NULL) { + acl_free(acl); + return 12; + } + acl_text = allocated_acl_text; + } + if (acl_length < 0 || acl_length > PROPR_MAX_ACL_TEXT || + memchr(acl_text, '\0', (size_t)acl_length) != NULL) { + if (allocated_acl_text != NULL) acl_free(allocated_acl_text); + if (acl != NULL) acl_free(acl); + return 13; + } + if (fstat(PROPR_AUTHORITY_FD, &after) != 0 || !same_identity(&before, &after)) { + if (allocated_acl_text != NULL) acl_free(allocated_acl_text); + if (acl != NULL) acl_free(acl); + return 14; + } + + char device[32]; + char file[32]; + int device_length = snprintf(device, sizeof(device), "%llu", (unsigned long long)(uint64_t)before.st_dev); + int file_length = snprintf(file, sizeof(file), "%llu", (unsigned long long)(uint64_t)before.st_ino); + if (device_length <= 0 || (size_t)device_length >= sizeof(device) || + file_length <= 0 || (size_t)file_length >= sizeof(file)) { + if (allocated_acl_text != NULL) acl_free(allocated_acl_text); + if (acl != NULL) acl_free(acl); + return 15; + } + + char output[PROPR_MAX_JSON]; + size_t length = 0; + if (append_bytes(output, &length, "{\"version\":1,\"device\":", 22) != 0 || + append_json_string(output, &length, device, (size_t)device_length) != 0 || + append_bytes(output, &length, ",\"file\":", 8) != 0 || + append_json_string(output, &length, file, (size_t)file_length) != 0 || + append_bytes(output, &length, ",\"acl\":", 7) != 0 || + append_json_string(output, &length, acl_text, (size_t)acl_length) != 0 || + append_bytes(output, &length, "}\n", 2) != 0) { + if (allocated_acl_text != NULL) acl_free(allocated_acl_text); + if (acl != NULL) acl_free(acl); + return 16; + } + if (allocated_acl_text != NULL) acl_free(allocated_acl_text); + if (acl != NULL) acl_free(acl); + + size_t written = 0; + while (written < length) { + ssize_t count = write(STDOUT_FILENO, output + written, length - written); + if (count <= 0) return 17; + written += (size_t)count; + } + return 0; +} diff --git a/packages/cli/native/directory-operations.c b/packages/cli/native/directory-operations.c index 530e57881..47ba96d1f 100644 --- a/packages/cli/native/directory-operations.c +++ b/packages/cli/native/directory-operations.c @@ -83,8 +83,19 @@ static napi_value open_at(napi_env env, napi_callback_info info) { } char path[4096]; if (!path_argument(env, arguments[1], path, sizeof(path))) return NULL; - int result = openat(int32_argument(env, arguments[0]), path, int32_argument(env, arguments[2]), - (mode_t)uint32_argument(env, arguments[3])); + int result; +#if defined(__linux__) && defined(__aarch64__) + /* + * The arm64 prebuild is cross-compiled. Invoke the fixed Linux syscall ABI + * instead of crossing the libc variadic openat boundary from that artifact. + */ + result = (int)syscall(SYS_openat, int32_argument(env, arguments[0]), path, + int32_argument(env, arguments[2]), + (mode_t)uint32_argument(env, arguments[3])); +#else + result = openat(int32_argument(env, arguments[0]), path, int32_argument(env, arguments[2]), + (mode_t)uint32_argument(env, arguments[3])); +#endif if (result == -1) return throw_errno(env, "openat"); napi_value value; napi_create_int32(env, result, &value); @@ -196,7 +207,15 @@ static napi_value lstat_at(napi_env env, napi_callback_info info) { char path[4096]; if (!path_argument(env, arguments[1], path, sizeof(path))) return NULL; struct stat status; - if (fstatat(int32_argument(env, arguments[0]), path, &status, AT_SYMLINK_NOFOLLOW) == -1) { + int syscall_result; +#if defined(__linux__) && defined(__aarch64__) + /* Avoid the cross-toolchain libc stat-version wrapper on Linux arm64. */ + syscall_result = (int)syscall(SYS_newfstatat, int32_argument(env, arguments[0]), path, + &status, AT_SYMLINK_NOFOLLOW); +#else + syscall_result = fstatat(int32_argument(env, arguments[0]), path, &status, AT_SYMLINK_NOFOLLOW); +#endif + if (syscall_result == -1) { return throw_errno(env, "fstatat"); } diff --git a/packages/cli/native/prebuilds/darwin-arm64/connect-authority-broker b/packages/cli/native/prebuilds/darwin-arm64/connect-authority-broker new file mode 100755 index 000000000..c06b288ff Binary files /dev/null and b/packages/cli/native/prebuilds/darwin-arm64/connect-authority-broker differ diff --git a/packages/cli/native/prebuilds/darwin-x64/connect-authority-broker b/packages/cli/native/prebuilds/darwin-x64/connect-authority-broker new file mode 100755 index 000000000..25e796f5e Binary files /dev/null and b/packages/cli/native/prebuilds/darwin-x64/connect-authority-broker differ diff --git a/packages/cli/native/prebuilds/linux-arm64/directory-operations.node b/packages/cli/native/prebuilds/linux-arm64/directory-operations.node index cc476e5f0..dc8f096d3 100755 Binary files a/packages/cli/native/prebuilds/linux-arm64/directory-operations.node and b/packages/cli/native/prebuilds/linux-arm64/directory-operations.node differ diff --git a/packages/cli/package.json b/packages/cli/package.json index 89b70ae9c..44f058bc7 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -5,6 +5,16 @@ "type": "module", "main": "dist/index.js", "types": "dist/index.d.ts", + "exports": { + ".": { + "types": "./dist/index.d.ts", + "import": "./dist/index.js" + }, + "./desktop-discovery": { + "types": "./dist/desktopDiscovery.d.ts", + "import": "./dist/desktopDiscovery.js" + } + }, "bin": { "propr": "./dist/index.js" }, diff --git a/packages/cli/scripts/build-publish.mjs b/packages/cli/scripts/build-publish.mjs index ff2f68262..4ee9e765f 100644 --- a/packages/cli/scripts/build-publish.mjs +++ b/packages/cli/scripts/build-publish.mjs @@ -38,7 +38,6 @@ const sharedDir = join(repoRoot, "packages", "shared"); const localSetupDir = join(repoRoot, "packages", "local-setup"); const stageDir = join(repoRoot, "dist-publish", "propr-cli"); const CLOUDFLARED_IMAGE = "cloudflare/cloudflared:2024.12.2"; - const run = (cmd, cmdArgs, cwd = repoRoot) => execFileSync(cmd, cmdArgs, { cwd, stdio: "inherit" }); @@ -77,6 +76,10 @@ const buildLauncherManifest = (version) => { // 1. Build the workspace packages we depend on. run("npm", ["run", "build", "-w", "@propr/shared"]); run("npm", ["run", "build", "-w", "@propr/local-setup"]); +// TypeScript does not remove outputs for deleted source files. Start the +// publishable CLI build from an empty output directory so retired authority +// implementations cannot survive as stale package-controlled executables or JS. +rmSync(join(cliDir, "dist"), { recursive: true, force: true }); run("npm", ["run", "build", "-w", "@propr/cli"]); // 2. Stage the CLI dist + README. @@ -91,7 +94,7 @@ for (const requiredSkillFile of ["SKILL.md", join("agents", "openai.yaml")]) { const nativeArtifacts = { "darwin-arm64": "88f07c0c7a4371f4fb227a4691009d09517de582ba49297d28d03ac94e586615", "darwin-x64": "62183c0f4083cb8c98e09e2d2c688f8f81703e12b0f22320c335b51e927eaf53", - "linux-arm64": "29b28b76ed8781f2567897ad9ba576798bbb669937048218e0416601788e0f1c", + "linux-arm64": "916679f413251c4b23c51167987a874bbbdd9d96991882bfac9093e0ea5fa051", "linux-x64": "7199378f1c7b443a05c596eae7c66f9a77cc01b4a493c07748df0df1083950f6", }; for (const [platformArch, expected] of Object.entries(nativeArtifacts)) { @@ -100,7 +103,21 @@ for (const [platformArch, expected] of Object.entries(nativeArtifacts)) { const actual = createHash("sha256").update(readFileSync(artifact)).digest("hex"); if (actual !== expected) throw new Error(`${platformArch} directory-operations artifact failed integrity verification`); } -for (const auditedFile of ["directory-operations.c", "README.md"]) { +const authorityArtifacts = { + "darwin-arm64/connect-authority-broker": "75fda2624bf093555e726b968401321fef61ea7ae0479f4c1892be0dfc6554c0", + "darwin-x64/connect-authority-broker": "e5a49be0db85655b9ff1d0614de9d61defd41a0a1b2eff8f11571407f10d809b", +}; +for (const [relativeArtifact, expected] of Object.entries(authorityArtifacts)) { + const artifact = join(stageDir, "dist", "native", "prebuilds", relativeArtifact); + if (!existsSync(artifact)) throw new Error(`Native authority broker is missing: ${artifact}`); + const actual = createHash("sha256").update(readFileSync(artifact)).digest("hex"); + if (actual !== expected) throw new Error(`${relativeArtifact} failed integrity verification`); +} +for (const auditedFile of [ + "directory-operations.c", + "darwin-authority-broker.c", + "README.md", +]) { const bundled = join(stageDir, "dist", "native", auditedFile); if (!existsSync(bundled)) throw new Error(`Audited native helper file is missing: ${bundled}`); } diff --git a/packages/cli/src/agentSkill.test.ts b/packages/cli/src/agentSkill.test.ts index cee98e01d..6c834251e 100644 --- a/packages/cli/src/agentSkill.test.ts +++ b/packages/cli/src/agentSkill.test.ts @@ -37,12 +37,16 @@ import { import { DARWIN_DIRECTORY_OPERATION_SHA256, LINUX_DIRECTORY_OPERATION_SHA256, + assertNativeDirectoryEntry, directoryDescriptorAccess, + openAuthorityDirectoryNoFollow, + setNativeDirectoryOpenTestHook, verifyDirectoryOperationArtifact, } from "./utils/directoryDescriptor.js"; const roots: string[] = []; afterEach(() => { + setNativeDirectoryOpenTestHook(); for (const root of roots.splice(0)) rmSync(root, { recursive: true, force: true }); }); @@ -126,6 +130,218 @@ test("native Linux x64 helper loads, stats, and atomically refuses replacement", } }); +test("native descriptor smoke failures expose only fixed substeps and categories", { + skip: process.platform !== "linux" || process.arch !== "x64" + ? "requires the real Linux x64 addon" + : false, +}, () => { + const root = temporaryRoot(); + const file = join(root, "entry"); + writeFileSync(file, "entry\n"); + + const directoryDiagnostics: unknown[] = []; + assert.throws(() => assertNativeDirectoryEntry( + join(root, "absent"), + "entry", + "file", + (phase, code, failure) => directoryDiagnostics.push({ phase, code, ...failure }), + )); + assert.deepEqual(directoryDiagnostics.at(-1), { + phase: "descriptor-operation", + code: "FAILED", + substep: "directory-open", + category: "missing-entry", + }); + + const missingDiagnostics: unknown[] = []; + assert.throws(() => assertNativeDirectoryEntry( + root, + "missing", + "file", + (phase, code, failure) => missingDiagnostics.push({ phase, code, ...failure }), + )); + assert.deepEqual(missingDiagnostics.at(-1), { + phase: "descriptor-operation", + code: "FAILED", + substep: "addon-open", + category: "missing-entry", + }); + + const typeDiagnostics: unknown[] = []; + assert.throws(() => assertNativeDirectoryEntry( + root, + "entry", + "directory", + (phase, code, failure) => typeDiagnostics.push({ phase, code, ...failure }), + )); + assert.deepEqual(typeDiagnostics.at(-1), { + phase: "descriptor-operation", + code: "FAILED", + substep: "fstat-type", + category: "type-mismatch", + }); +}); + +test("Linux EINVAL directory open fallback retains the native descriptor-relative entry proof", { + skip: process.platform !== "linux" || (process.arch !== "x64" && process.arch !== "arm64") + ? "requires a real Linux kernel and packaged Linux addon" + : false, +}, () => { + const root = temporaryRoot(); + writeFileSync(join(root, "config.json"), "{}\n"); + setNativeDirectoryOpenTestHook(phase => { + if (phase === "before-primary-open") { + throw Object.assign(new Error("injected strict-open failure"), { code: "EINVAL" }); + } + }, true); + + assert.doesNotThrow(() => assertNativeDirectoryEntry(root, "config.json", "file")); +}); + +test("Linux consecutive EINVAL directory opens reach the read-only pinned fallback", { + skip: process.platform !== "linux" || (process.arch !== "x64" && process.arch !== "arm64") + ? "requires a real Linux kernel and packaged Linux addon" + : false, +}, () => { + const root = temporaryRoot(); + writeFileSync(join(root, "config.json"), "{}\n"); + let readOnlyFallbacks = 0; + setNativeDirectoryOpenTestHook(phase => { + if (phase === "before-primary-open") { + throw Object.assign(new Error("injected strict-open failure"), { code: "EINVAL" }); + } + if (phase === "before-directory-fallback-open") { + throw Object.assign(new Error("injected directory-open failure"), { code: "EINVAL" }); + } + if (phase === "before-readonly-fallback-open") readOnlyFallbacks += 1; + }, true); + + assert.doesNotThrow(() => assertNativeDirectoryEntry(root, "config.json", "file")); + assert.equal(readOnlyFallbacks, 1); +}); + +test("Linux EINVAL directory open fallback rejects named-directory replacement", { + skip: process.platform !== "linux" || (process.arch !== "x64" && process.arch !== "arm64") + ? "requires a real Linux kernel and packaged Linux addon" + : false, +}, () => { + const parent = temporaryRoot(); + const root = join(parent, "config"); + const detached = join(parent, "detached"); + mkdirSync(root); + writeFileSync(join(root, "config.json"), "{}\n"); + setNativeDirectoryOpenTestHook(phase => { + if (phase === "before-primary-open") { + throw Object.assign(new Error("injected strict-open failure"), { code: "EINVAL" }); + } + if (phase === "before-directory-fallback-open") { + throw Object.assign(new Error("injected directory-open failure"), { code: "EINVAL" }); + } + if (phase === "after-fallback-open") { + renameSync(root, detached); + mkdirSync(root); + writeFileSync(join(root, "config.json"), "{}\n"); + } + }, true); + + assert.throws( + () => assertNativeDirectoryEntry(root, "config.json", "file"), + /entry changed during descriptor fallback/, + ); +}); + +test("Linux EINVAL directory open fallback rejects a symlink substituted after open", { + skip: process.platform !== "linux" || (process.arch !== "x64" && process.arch !== "arm64") + ? "requires a real Linux kernel and packaged Linux addon" + : false, +}, () => { + const parent = temporaryRoot(); + const root = join(parent, "config"); + const detached = join(parent, "detached"); + mkdirSync(root); + writeFileSync(join(root, "config.json"), "{}\n"); + setNativeDirectoryOpenTestHook(phase => { + if (phase === "before-primary-open") { + throw Object.assign(new Error("injected strict-open failure"), { code: "EINVAL" }); + } + if (phase === "before-directory-fallback-open") { + throw Object.assign(new Error("injected directory-open failure"), { code: "EINVAL" }); + } + if (phase === "after-fallback-open") { + renameSync(root, detached); + symlinkSync(detached, root, "dir"); + } + }, true); + + assert.throws( + () => assertNativeDirectoryEntry(root, "config.json", "file"), + /entry changed during descriptor fallback/, + ); +}); + +test("native directory open does not accept non-EINVAL errors through the fallback", { + skip: process.platform !== "linux" || (process.arch !== "x64" && process.arch !== "arm64") + ? "requires a real Linux kernel and packaged Linux addon" + : false, +}, () => { + const root = temporaryRoot(); + writeFileSync(join(root, "config.json"), "{}\n"); + let phases = 0; + setNativeDirectoryOpenTestHook(phase => { + phases += 1; + if (phase === "before-primary-open") { + throw Object.assign(new Error("injected denied open"), { code: "EACCES" }); + } + }, true); + + assert.throws(() => assertNativeDirectoryEntry(root, "config.json", "file"), /injected denied open/); + assert.equal(phases, 1); +}); + +test("non-EINVAL directory fallback failures never reach the read-only fallback", { + skip: process.platform !== "linux" || (process.arch !== "x64" && process.arch !== "arm64") + ? "requires a real Linux kernel and packaged Linux addon" + : false, +}, () => { + const root = temporaryRoot(); + writeFileSync(join(root, "config.json"), "{}\n"); + let readOnlyFallbackObserved = false; + setNativeDirectoryOpenTestHook(phase => { + if (phase === "before-primary-open") { + throw Object.assign(new Error("injected strict-open failure"), { code: "EINVAL" }); + } + if (phase === "before-directory-fallback-open") { + throw Object.assign(new Error("injected denied directory open"), { code: "EACCES" }); + } + if (phase === "before-readonly-fallback-open") readOnlyFallbackObserved = true; + }, true); + + assert.throws( + () => assertNativeDirectoryEntry(root, "config.json", "file"), + /injected denied directory open/, + ); + assert.equal(readOnlyFallbackObserved, false); +}); + +test("read-only fallback rejects a non-directory descriptor", { + skip: process.platform !== "linux" ? "requires Linux directory open flags" : false, +}, () => { + const root = temporaryRoot(); + const file = join(root, "config.json"); + writeFileSync(file, "{}\n"); + setNativeDirectoryOpenTestHook(() => undefined, true); + + assert.throws(() => openAuthorityDirectoryNoFollow(root, flags => { + if (flags === (constants.O_RDONLY | constants.O_DIRECTORY | constants.O_NOFOLLOW)) { + throw Object.assign(new Error("injected strict-open failure"), { code: "EINVAL" }); + } + if (flags === (constants.O_RDONLY | constants.O_DIRECTORY)) { + throw Object.assign(new Error("injected directory-open failure"), { code: "EINVAL" }); + } + return openSync(file, flags); + }), /entry changed during descriptor fallback/); +}); + test("native Darwin child uses inherited fd 3 without changing either cwd", { skip: process.platform !== "darwin" ? "requires a real Darwin kernel and packaged Darwin addon" : false, }, () => { diff --git a/packages/cli/src/commands/connectCommand.test.ts b/packages/cli/src/commands/connectCommand.test.ts new file mode 100644 index 000000000..2420b7d5e --- /dev/null +++ b/packages/cli/src/commands/connectCommand.test.ts @@ -0,0 +1,401 @@ +import assert from "node:assert/strict"; +import { test } from "node:test"; +import { parseProprDesktopDiscovery } from "@propr/shared"; +import { + CONNECT_STATUS_EXIT, + probeConnectDiscovery, + readBoundedBody, + resolveConnectStatus, + unavailableRootAuthorityStatus, +} from "./connectCommand.js"; +import type { OrchestratorConfig } from "../orchestrator/types.js"; + +const IDENTITY = "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa"; +const ENDPOINT = "https://t-abc123.propr.dev"; + +function cfg(overrides: Partial = {}): OrchestratorConfig { + return { + uiPublicApiUrl: ENDPOINT, + proprInstanceId: "abc123", + uiTunnelEnabled: true, + ...overrides, + } as OrchestratorConfig; +} + +function discovery(overrides: Record = {}): Record { + return { + schemaVersion: 1, + product: "ProPR", + canonicalEndpoint: ENDPOINT, + publicInstanceIdentity: IDENTITY, + version: "0.8.15", + apiCompatibility: "2026-06-27", + uiCompatibility: "2026-06-27", + desktopAuthentication: { + protocolVersion: 2, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, + ...overrides, + }; +} + +function jsonFetch(body = discovery()): typeof fetch { + return async () => new Response(JSON.stringify(body), { + status: 200, + headers: { "content-type": "application/json" }, + }); +} + +test("Connect status exposes stable exit semantics", () => { + assert.deepEqual(CONNECT_STATUS_EXIT, { + ready: 0, + internalFailure: 1, + notReady: 0, + incompatible: 2, + invalidConfig: 1, + timeout: 0, + }); +}); + +test("unavailable root authority fails closed before API readiness", () => { + const status = unavailableRootAuthorityStatus(); + assert.equal(status.status, "invalidConfig"); + assert.equal(status.apiReady, false); + assert.equal(status.configured, false); + assert.equal(status.publicInstanceIdentity, null); + assert.deepEqual(status.reasonCodes, ["ACL_DIAGNOSTIC_UNAVAILABLE"]); +}); + +test("missing, disabled, and stopped tunnel states do not probe", async () => { + let probes = 0; + const fetchImpl = (async () => { + probes += 1; + throw new Error("must not probe"); + }) as typeof fetch; + + const missing = await resolveConnectStatus({ + cfg: cfg({ uiPublicApiUrl: undefined, proprInstanceId: undefined, uiTunnelEnabled: false }), + sidecarRunning: false, + publicInstanceIdentity: IDENTITY, + fetchImpl, + }); + assert.equal(missing.status, "notReady"); + assert.deepEqual(missing.reasonCodes, ["NOT_CONFIGURED", "TUNNEL_DISABLED"]); + + const disabled = await resolveConnectStatus({ + cfg: cfg({ uiTunnelEnabled: false }), sidecarRunning: false, publicInstanceIdentity: IDENTITY, fetchImpl, + }); + assert.deepEqual(disabled.reasonCodes, ["TUNNEL_DISABLED"]); + + const stopped = await resolveConnectStatus({ + cfg: cfg(), sidecarRunning: false, publicInstanceIdentity: IDENTITY, fetchImpl, + }); + assert.deepEqual(stopped.reasonCodes, ["SIDECAR_NOT_RUNNING"]); + assert.equal(probes, 0); +}); + +test("ready requires matching canonical origin, identity, and compatibility", async () => { + const status = await resolveConnectStatus({ + cfg: cfg(), sidecarRunning: true, publicInstanceIdentity: IDENTITY, fetchImpl: jsonFetch(), + }); + assert.equal(status.status, "ready"); + assert.equal(status.apiReady, true); + assert.equal(status.restartRequired, false); + assert.equal(status.compatibility, "2026-06-27"); + assert.equal(status.version, "0.8.15"); + assert.deepEqual(status.reasonCodes, []); +}); + +test("same API identity with stale incompatible runtime origin requires restart", async () => { + const status = await resolveConnectStatus({ + cfg: cfg(), + sidecarRunning: true, + publicInstanceIdentity: IDENTITY, + fetchImpl: jsonFetch(discovery({ + canonicalEndpoint: null, + apiCompatibility: "2025-01-01", + desktopAuthentication: { + protocolVersion: 2, + browserPairing: false, + instanceBearerTokens: false, + socketIoBearerAuthentication: false, + }, + })), + }); + assert.equal(status.status, "notReady"); + assert.equal(status.apiReady, false); + assert.equal(status.restartRequired, true); + assert.deepEqual(status.reasonCodes, ["ENDPOINT_MISMATCH", "RESTART_REQUIRED"]); +}); + +test("a reassigned or stale endpoint cannot pass an identity mismatch", async () => { + const status = await resolveConnectStatus({ + cfg: cfg(), + sidecarRunning: true, + publicInstanceIdentity: IDENTITY, + fetchImpl: jsonFetch(discovery({ + canonicalEndpoint: null, + publicInstanceIdentity: "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb", + apiCompatibility: "2025-01-01", + desktopAuthentication: { + protocolVersion: 2, + browserPairing: false, + instanceBearerTokens: false, + socketIoBearerAuthentication: false, + }, + })), + }); + assert.equal(status.status, "notReady"); + assert.equal(status.apiReady, false); + assert.equal(status.restartRequired, false); + assert.deepEqual(status.reasonCodes, ["IDENTITY_MISMATCH"]); +}); + +test("old discovery compatibility has an incompatible result", async () => { + const status = await resolveConnectStatus({ + cfg: cfg(), + sidecarRunning: true, + publicInstanceIdentity: IDENTITY, + fetchImpl: jsonFetch(discovery({ apiCompatibility: "2025-01-01" })), + }); + assert.equal(status.status, "incompatible"); + assert.deepEqual(status.reasonCodes, ["API_INCOMPATIBLE"]); +}); + +test("ready requires every desktop authentication capability", async () => { + for (const capability of [ + "browserPairing", + "instanceBearerTokens", + "socketIoBearerAuthentication", + ] as const) { + const status = await resolveConnectStatus({ + cfg: cfg(), + sidecarRunning: true, + publicInstanceIdentity: IDENTITY, + fetchImpl: jsonFetch(discovery({ + desktopAuthentication: { + protocolVersion: 2, + browserPairing: capability !== "browserPairing", + instanceBearerTokens: capability !== "instanceBearerTokens", + socketIoBearerAuthentication: capability !== "socketIoBearerAuthentication", + }, + })), + }); + + assert.equal(status.status, "incompatible", capability); + assert.equal(status.apiReady, false, capability); + assert.deepEqual(status.reasonCodes, ["DESKTOP_AUTHENTICATION_UNSUPPORTED"], capability); + } +}); + +test("probe distinguishes timeout, non-JSON, and capped output", async () => { + const never = (() => new Promise(() => undefined)) as typeof fetch; + assert.deepEqual(await probeConnectDiscovery(ENDPOINT, never, 10), { kind: "timeout" }); + + const nonJson = (async () => new Response("no", { + headers: { "content-type": "text/html" }, + })) as typeof fetch; + assert.deepEqual(await probeConnectDiscovery(ENDPOINT, nonJson, 100), { kind: "invalid" }); + + const oversized = (async () => new Response("{}", { + headers: { + "content-type": "application/json", + "content-length": "9000", + }, + })) as typeof fetch; + assert.deepEqual(await probeConnectDiscovery(ENDPOINT, oversized, 100), { kind: "tooLarge" }); +}); + +test("the shared discovery parser requires every exact canonical field and capability", () => { + const parsed = parseProprDesktopDiscovery(discovery()); + assert.ok(parsed); + assert.equal(parsed.desktopAuthentication.protocolVersion, 2); + const topLevelKeys = Object.keys(discovery()); + for (const key of topLevelKeys) { + const candidate = discovery(); + delete candidate[key]; + assert.equal(parseProprDesktopDiscovery(candidate), null, `missing ${key}`); + } + for (const key of [ + "protocolVersion", + "browserPairing", + "instanceBearerTokens", + "socketIoBearerAuthentication", + ]) { + const candidate = discovery(); + const capabilities = { ...(candidate.desktopAuthentication as Record) }; + delete capabilities[key]; + candidate.desktopAuthentication = capabilities; + assert.equal(parseProprDesktopDiscovery(candidate), null, `missing desktopAuthentication.${key}`); + } + + for (const invalid of [ + discovery({ extra: true }), + discovery({ version: "v0.8.15" }), + discovery({ version: "00.8.15" }), + discovery({ version: "0.8" }), + discovery({ apiCompatibility: "2026-6-27" }), + discovery({ apiCompatibility: "2026-02-30" }), + discovery({ uiCompatibility: "" }), + discovery({ canonicalEndpoint: `${ENDPOINT}/` }), + discovery({ publicInstanceIdentity: IDENTITY.toUpperCase() }), + discovery({ desktopAuthentication: { + protocolVersion: 2, + browserPairing: 1, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + } }), + discovery({ desktopAuthentication: { + protocolVersion: 2, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + omittedCapabilityReplacement: true, + } }), + ]) assert.equal(parseProprDesktopDiscovery(invalid), null); + + assert.equal(parseProprDesktopDiscovery(discovery({ desktopAuthentication: { + protocolVersion: 1, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + } })), null, "legacy desktop authentication protocol v1 must fail closed"); +}); + +function neverEndingResponse( + status: number, + headers: Readonly>, + onCancel: () => void, +): Response { + return new Response(new ReadableStream({ + start(controller) { + controller.enqueue(new TextEncoder().encode("{")); + }, + cancel() { + onCancel(); + }, + }), { + status, + headers: Object.fromEntries(Object.entries(headers).filter((entry): entry is [string, string] => ( + entry[1] !== undefined + ))), + }); +} + +test("every early response rejection cancels a never-ending body", async () => { + for (const branch of [ + { status: 404, headers: { "content-type": "application/json" }, kind: "unsupported" }, + { status: 503, headers: { "content-type": "application/json" }, kind: "unreachable" }, + { status: 200, headers: { "content-type": "text/html" }, kind: "invalid" }, + { + status: 200, + headers: { "content-type": "application/json", "content-length": "9000" }, + kind: "tooLarge", + }, + ] as const) { + let canceled = 0; + const fetchImpl = (async () => neverEndingResponse( + branch.status, + branch.headers, + () => { canceled += 1; }, + )) as typeof fetch; + assert.deepEqual(await probeConnectDiscovery(ENDPOINT, fetchImpl, 100), { kind: branch.kind }); + assert.equal(canceled, 1, branch.kind); + } +}); + +test("fatal UTF-8, malformed JSON, and incomplete schema are invalid rather than unreachable", async () => { + const invalidUtf8 = (async () => new Response(Uint8Array.from([0xc3, 0x28]), { + headers: { "content-type": "application/json" }, + })) as typeof fetch; + assert.deepEqual(await probeConnectDiscovery(ENDPOINT, invalidUtf8, 100), { kind: "invalid" }); + + for (const body of ["{", JSON.stringify({ schemaVersion: 1, product: "ProPR" })]) { + let signal: AbortSignal | undefined; + const fetchImpl = (async (_url, init) => { + signal = init?.signal ?? undefined; + return new Response(body, { headers: { "content-type": "application/json" } }); + }) as typeof fetch; + assert.deepEqual(await probeConnectDiscovery(ENDPOINT, fetchImpl, 100), { kind: "invalid" }); + assert.equal(signal?.aborted, true); + } +}); + +test("timeout cancels an active body and late-settling responses are canceled on arrival", async () => { + let activeCanceled = 0; + const active = (async () => neverEndingResponse( + 200, + { "content-type": "application/json" }, + () => { activeCanceled += 1; }, + )) as typeof fetch; + assert.deepEqual(await probeConnectDiscovery(ENDPOINT, active, 10), { kind: "timeout" }); + assert.equal(activeCanceled, 1); + + for (const status of [200, 404, 503]) { + let settle!: (response: Response) => void; + let lateCanceled = 0; + const late = (() => new Promise((resolve) => { settle = resolve; })) as typeof fetch; + assert.deepEqual(await probeConnectDiscovery(ENDPOINT, late, 10), { kind: "timeout" }); + settle(neverEndingResponse(status, { "content-type": "text/html" }, () => { lateCanceled += 1; })); + await new Promise((resolve) => setImmediate(resolve)); + assert.equal(lateCanceled, 1, `late status ${status}`); + } +}); + +test("abort between reader acquisition and listener installation cancels without reading or leaking", async () => { + const controller = new AbortController(); + let reads = 0; + let cancellations = 0; + let releases = 0; + let listeners = 0; + const originalAdd = controller.signal.addEventListener.bind(controller.signal); + const originalRemove = controller.signal.removeEventListener.bind(controller.signal); + controller.signal.addEventListener = ((...args: Parameters) => { + listeners += 1; + return originalAdd(...args); + }) as AbortSignal["addEventListener"]; + controller.signal.removeEventListener = ((...args: Parameters) => { + listeners -= 1; + return originalRemove(...args); + }) as AbortSignal["removeEventListener"]; + + const response = { + headers: new Headers({ "content-type": "application/json" }), + body: { + getReader() { + controller.abort(); + return { + cancel: async () => { cancellations += 1; }, + read: async () => { reads += 1; return { done: true, value: undefined }; }, + releaseLock: () => { releases += 1; }, + }; + }, + }, + } as unknown as Response; + + await assert.rejects(() => readBoundedBody(response, controller.signal), /aborted/); + assert.equal(reads, 0); + assert.equal(cancellations, 1); + assert.equal(releases, 1); + assert.equal(listeners, 0); +}); + +test("serialized JSON is bounded and cannot include local secret sentinels", async () => { + const secret = "cloudflare-token-SENTINEL"; + const status = await resolveConnectStatus({ + cfg: cfg({ uiTunnelToken: secret }), + sidecarRunning: true, + publicInstanceIdentity: IDENTITY, + fetchImpl: jsonFetch(), + }); + const output = JSON.stringify(status); + assert.ok(output.length < 2048); + assert.equal(output.includes(secret), false); + assert.deepEqual(Object.keys(status), [ + "schemaVersion", "status", "canonicalEndpoint", "publicInstanceIdentity", + "configured", "enabled", "sidecarRunning", "apiReady", "restartRequired", + "compatibility", "version", "reasonCodes", + ]); +}); diff --git a/packages/cli/src/commands/connectCommand.ts b/packages/cli/src/commands/connectCommand.ts new file mode 100644 index 000000000..4d17cc92d --- /dev/null +++ b/packages/cli/src/commands/connectCommand.ts @@ -0,0 +1,453 @@ +import { Command } from "commander"; +import { + PROPR_CONNECT_DISCOVERY_MAX_BYTES, + PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION, + canonicalProprProxyUrl, + evaluateProprApiCompatibility, + parseProprDesktopDiscoveryJson, + type ProprDesktopDiscovery, +} from "@propr/shared"; +import { prepareConnectHostConfig } from "../orchestrator/index.js"; +import type { OrchestratorConfig } from "../orchestrator/types.js"; +import { + ConnectRootError, + PublicInstanceIdentityError, + readTrustedConnectTunnelOverride, + readSnapshotPublicInstanceIdentity, + withOwnedConnectRootSnapshot, +} from "../connectIdentity.js"; +import { WindowsAuthorityInspectionError } from "../connectRootAuthority.js"; + +export const CONNECT_STATUS_EXIT = { + ready: 0, + internalFailure: 1, + notReady: 0, + incompatible: 2, + invalidConfig: 1, + timeout: 0, +} as const; + +export type ConnectStatusKind = keyof typeof CONNECT_STATUS_EXIT; +export type ConnectStatusReasonCode = + | "NOT_CONFIGURED" + | "TUNNEL_DISABLED" + | "SIDECAR_NOT_RUNNING" + | "API_UNREACHABLE" + | "API_TIMEOUT" + | "DISCOVERY_UNSUPPORTED" + | "DISCOVERY_INVALID" + | "DISCOVERY_TOO_LARGE" + | "API_INCOMPATIBLE" + | "DESKTOP_AUTHENTICATION_UNSUPPORTED" + | "IDENTITY_MISMATCH" + | "ENDPOINT_MISMATCH" + | "RESTART_REQUIRED" + | "INVALID_ROOT" + | "INVALID_ENDPOINT" + | "IDENTITY_UNAVAILABLE" + | "INTERNAL_FAILURE" + | "ACL_DIAGNOSTIC_UNAVAILABLE"; + +export interface ConnectStatusDocument { + schemaVersion: typeof PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION; + status: ConnectStatusKind; + canonicalEndpoint: string | null; + publicInstanceIdentity: string | null; + configured: boolean; + enabled: boolean; + sidecarRunning: boolean; + apiReady: boolean; + restartRequired: boolean; + compatibility: string | null; + version: string | null; + reasonCodes: ConnectStatusReasonCode[]; +} + +/** An unavailable root-authority diagnostic is a hard readiness boundary. */ +export function unavailableRootAuthorityStatus(): ConnectStatusDocument { + return baseDocument("invalidConfig", { reasonCodes: ["ACL_DIAGNOSTIC_UNAVAILABLE"] }); +} + +type DiscoveryProbeResult = + | { kind: "ok"; discovery: ProprDesktopDiscovery } + | { kind: "timeout" } + | { kind: "unreachable" } + | { kind: "unsupported" } + | { kind: "invalid" } + | { kind: "tooLarge" }; + +function baseDocument( + status: ConnectStatusKind, + overrides: Partial = {}, +): ConnectStatusDocument { + return { + schemaVersion: PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION, + status, + canonicalEndpoint: null, + publicInstanceIdentity: null, + configured: false, + enabled: false, + sidecarRunning: false, + apiReady: false, + restartRequired: false, + compatibility: null, + version: null, + reasonCodes: [], + ...overrides, + }; +} + +/** The fixed failure document for a missing, empty, or ambiguous explicit root. */ +export function invalidConnectRootStatus(): ConnectStatusDocument { + return baseDocument("invalidConfig", { reasonCodes: ["INVALID_ROOT"] }); +} + +function parseContentLength(response: Response): number | null { + const raw = response.headers.get("content-length"); + if (raw === null) return null; + if (!/^\d{1,10}$/.test(raw)) return Number.POSITIVE_INFINITY; + return Number(raw); +} + +function cancelResponseBody(response: Response): void { + try { + const cancellation = response.body?.cancel(); + if (cancellation) void cancellation.catch(() => undefined); + } catch { + // Cancellation is best-effort at the transport adapter boundary; the + // owning AbortController is also aborted before probe return. + } +} + +export type BoundedBodyResult = + | { kind: "ok"; body: string } + | { kind: "tooLarge" } + | { kind: "invalid" }; + +export async function readBoundedBody(response: Response, signal: AbortSignal): Promise { + const declaredLength = parseContentLength(response); + if (declaredLength !== null && declaredLength > PROPR_CONNECT_DISCOVERY_MAX_BYTES) { + cancelResponseBody(response); + return { kind: "tooLarge" }; + } + if (!response.body) return { kind: "ok", body: "" }; + + if (signal.aborted) { + cancelResponseBody(response); + throw new Error("Connect discovery response was aborted"); + } + const reader = response.body.getReader(); + let canceled = false; + const abort = () => { + if (canceled) return; + canceled = true; + try { + void reader.cancel().catch(() => undefined); + } catch { + // The stream may already be closed or errored. + } + }; + // Check on both sides of listener installation. AbortSignal dispatch is + // synchronous, so after the second check either this listener observed the + // abort or it remains installed for the subsequent body read. + if (signal.aborted) abort(); + signal.addEventListener("abort", abort, { once: true }); + if (signal.aborted) abort(); + const chunks: Uint8Array[] = []; + let length = 0; + try { + if (signal.aborted) throw new Error("Connect discovery response was aborted"); + while (true) { + const { done, value } = await reader.read(); + if (signal.aborted) throw new Error("Connect discovery response was aborted"); + if (done) break; + if (!value) continue; + length += value.byteLength; + if (length > PROPR_CONNECT_DISCOVERY_MAX_BYTES) { + abort(); + return { kind: "tooLarge" }; + } + chunks.push(value); + } + const bytes = new Uint8Array(length); + let offset = 0; + for (const chunk of chunks) { + bytes.set(chunk, offset); + offset += chunk.byteLength; + } + try { + return { kind: "ok", body: new TextDecoder("utf-8", { fatal: true }).decode(bytes) }; + } catch { + cancelResponseBody(response); + return { kind: "invalid" }; + } + } finally { + signal.removeEventListener("abort", abort); + try { + reader.releaseLock(); + } catch { + // A transport may keep cancellation pending briefly; the listener is + // already detached and cancellation remains owned by the reader. + } + } +} + +async function performDiscoveryFetch( + canonicalEndpoint: string, + fetchImpl: typeof fetch, + signal: AbortSignal, +): Promise { + try { + const response = await fetchImpl(`${canonicalEndpoint}/api/desktop/discovery`, { + signal, + redirect: "manual", + headers: { Accept: "application/json" }, + }); + if (signal.aborted) { + cancelResponseBody(response); + return { kind: "timeout" }; + } + if (response.status === 404) { + cancelResponseBody(response); + return { kind: "unsupported" }; + } + if (!response.ok) { + cancelResponseBody(response); + return { kind: "unreachable" }; + } + const contentType = response.headers.get("content-type")?.split(";", 1)[0]?.trim().toLowerCase(); + if (contentType !== "application/json") { + cancelResponseBody(response); + return { kind: "invalid" }; + } + const bodyResult = await readBoundedBody(response, signal); + if (bodyResult.kind !== "ok") return { kind: bodyResult.kind }; + const discovery = parseProprDesktopDiscoveryJson(bodyResult.body); + if (!discovery) cancelResponseBody(response); + return discovery ? { kind: "ok", discovery } : { kind: "invalid" }; + } catch { + return signal.aborted ? { kind: "timeout" } : { kind: "unreachable" }; + } +} + +/** One bounded, redirect-free probe with a deadline that does not trust fetch to abort itself. */ +export async function probeConnectDiscovery( + canonicalEndpoint: string, + fetchImpl: typeof fetch = fetch, + timeoutMs = 5000, +): Promise { + const controller = new AbortController(); + let timer: ReturnType | undefined; + const timeout = new Promise((resolve) => { + timer = setTimeout(() => { + controller.abort(); + resolve({ kind: "timeout" }); + }, timeoutMs); + }); + try { + return await Promise.race([ + performDiscoveryFetch(canonicalEndpoint, fetchImpl, controller.signal), + timeout, + ]); + } finally { + if (timer !== undefined) clearTimeout(timer); + controller.abort(); + } +} + +export interface ResolveConnectStatusOptions { + cfg: Pick; + sidecarRunning: boolean; + publicInstanceIdentity: string; + fetchImpl?: typeof fetch; + timeoutMs?: number; +} + +export interface LocalConnectStatusDependencies { + fetchImpl?: typeof fetch; + inspectTunnel?: ( + cfg: OrchestratorConfig, + ) => { kind: 'ok'; running: boolean } | { kind: 'internalFailure' }; + /** @internal Fixed smoke-only phase outcomes; never carries errors or native evidence. */ + reportSmokeDiagnostic?: ( + phase: 'authority-inspection' | 'status-resolution', + code: 'STARTED' | 'PASSED' | 'FAILED', + ) => void; +} + +/** Pure status state machine used by the CLI wiring and deterministic tests. */ +export async function resolveConnectStatus({ + cfg, + sidecarRunning, + publicInstanceIdentity, + fetchImpl = fetch, + timeoutMs = 5000, +}: ResolveConnectStatusOptions): Promise { + const configuredValue = cfg.uiPublicApiUrl; + const canonicalEndpoint = canonicalProprProxyUrl(configuredValue) ?? null; + const enabled = Boolean(cfg.uiTunnelEnabled); + const common = { + canonicalEndpoint, + publicInstanceIdentity, + configured: canonicalEndpoint !== null, + enabled, + sidecarRunning, + }; + + if ((configuredValue && !canonicalEndpoint) || (cfg.proprInstanceId && !canonicalEndpoint)) { + return baseDocument("invalidConfig", { ...common, reasonCodes: ["INVALID_ENDPOINT"] }); + } + + const reasons: ConnectStatusReasonCode[] = []; + if (!canonicalEndpoint) reasons.push("NOT_CONFIGURED"); + if (!enabled) reasons.push("TUNNEL_DISABLED"); + if (enabled && !sidecarRunning) reasons.push("SIDECAR_NOT_RUNNING"); + if (reasons.length > 0 || !canonicalEndpoint) { + return baseDocument("notReady", { ...common, reasonCodes: reasons }); + } + + const probe = await probeConnectDiscovery(canonicalEndpoint, fetchImpl, timeoutMs); + if (probe.kind === "timeout") { + return baseDocument("timeout", { ...common, reasonCodes: ["API_TIMEOUT"] }); + } + if (probe.kind === "unreachable") { + return baseDocument("notReady", { ...common, reasonCodes: ["API_UNREACHABLE"] }); + } + if (probe.kind === "unsupported") { + return baseDocument("incompatible", { ...common, reasonCodes: ["DISCOVERY_UNSUPPORTED"] }); + } + if (probe.kind === "invalid" || probe.kind === "tooLarge") { + return baseDocument("incompatible", { + ...common, + reasonCodes: [probe.kind === "tooLarge" ? "DISCOVERY_TOO_LARGE" : "DISCOVERY_INVALID"], + }); + } + + const remoteMetadata = { + compatibility: probe.discovery.apiCompatibility, + version: probe.discovery.version, + }; + if (probe.discovery.publicInstanceIdentity !== publicInstanceIdentity) { + return baseDocument("notReady", { + ...common, + ...remoteMetadata, + reasonCodes: ["IDENTITY_MISMATCH"], + }); + } + if (probe.discovery.canonicalEndpoint !== canonicalEndpoint) { + return baseDocument("notReady", { + ...common, + ...remoteMetadata, + restartRequired: true, + reasonCodes: ["ENDPOINT_MISMATCH", "RESTART_REQUIRED"], + }); + } + const compatibility = evaluateProprApiCompatibility(probe.discovery); + if (!compatibility.compatible) { + return baseDocument("incompatible", { + ...common, + ...remoteMetadata, + reasonCodes: ["API_INCOMPATIBLE"], + }); + } + const authentication = probe.discovery.desktopAuthentication; + if ( + !authentication.browserPairing + || !authentication.instanceBearerTokens + || !authentication.socketIoBearerAuthentication + ) { + return baseDocument("incompatible", { + ...common, + ...remoteMetadata, + reasonCodes: ["DESKTOP_AUTHENTICATION_UNSUPPORTED"], + }); + } + return baseDocument("ready", { ...common, ...remoteMetadata, apiReady: true }); +} + +export async function getLocalConnectStatus( + root: string | undefined, + dependencies: LocalConnectStatusDependencies = {}, +): Promise { + let phase: 'authority-inspection' | 'status-resolution' = 'authority-inspection'; + dependencies.reportSmokeDiagnostic?.(phase, 'STARTED'); + try { + const prepared = await prepareConnectHostConfig(); + const local = await withOwnedConnectRootSnapshot(root, async (snapshot) => { + const cfg = prepared.resolveSnapshot(snapshot); + const tunnelEnabledOverride = await readTrustedConnectTunnelOverride(snapshot.requestedRoot); + const effectiveCfg = tunnelEnabledOverride === undefined + ? cfg + : { ...cfg, uiTunnelEnabled: tunnelEnabledOverride }; + // Status is discovery, not setup: never create/repair identity state or + // invoke a privileged Windows protection operation from this path. + const publicInstanceIdentity = await readSnapshotPublicInstanceIdentity(snapshot.identityDirectory); + const sidecarInspection = (dependencies.inspectTunnel ?? prepared.inspectTunnel)(effectiveCfg); + return { + kind: "verified" as const, + cfg: { + uiPublicApiUrl: effectiveCfg.uiPublicApiUrl, + proprInstanceId: effectiveCfg.proprInstanceId, + uiTunnelEnabled: effectiveCfg.uiTunnelEnabled, + }, + publicInstanceIdentity, + sidecarInspection, + }; + }, { parseEnvFile: prepared.parseEnvFile }); + dependencies.reportSmokeDiagnostic?.(phase, 'PASSED'); + phase = 'status-resolution'; + dependencies.reportSmokeDiagnostic?.(phase, 'STARTED'); + if (local.sidecarInspection.kind === "internalFailure") { + const result = baseDocument("internalFailure", { reasonCodes: ["INTERNAL_FAILURE"] }); + dependencies.reportSmokeDiagnostic?.(phase, 'PASSED'); + return result; + } + const result = await resolveConnectStatus({ + cfg: local.cfg, + sidecarRunning: local.sidecarInspection.running, + publicInstanceIdentity: local.publicInstanceIdentity, + fetchImpl: dependencies.fetchImpl, + }); + dependencies.reportSmokeDiagnostic?.(phase, 'PASSED'); + return result; + } catch (error) { + dependencies.reportSmokeDiagnostic?.(phase, 'FAILED'); + if (error instanceof WindowsAuthorityInspectionError) return unavailableRootAuthorityStatus(); + if (error instanceof ConnectRootError) { + return invalidConnectRootStatus(); + } + if (error instanceof PublicInstanceIdentityError) { + return baseDocument("invalidConfig", { reasonCodes: ["IDENTITY_UNAVAILABLE"] }); + } + return baseDocument("internalFailure", { reasonCodes: ["INTERNAL_FAILURE"] }); + } +} + +function printHumanStatus(document: ConnectStatusDocument): void { + console.log(`Connect status: ${document.status}`); + console.log(` endpoint: ${document.canonicalEndpoint ?? "not configured"}`); + console.log(` enabled: ${document.enabled ? "yes" : "no"}`); + console.log(` sidecar: ${document.sidecarRunning ? "running" : "stopped"}`); + console.log(` API ready: ${document.apiReady ? "yes" : "no"}`); + if (document.restartRequired) console.log(" restart required: yes"); + if (document.reasonCodes.length > 0) console.log(` reasons: ${document.reasonCodes.join(", ")}`); +} + +export function createConnectCommand(): Command { + const command = new Command("connect").description("Discover the local ProPR Connect endpoint safely"); + command + .command("status") + .description("Print the versioned secret-free desktop discovery contract") + .option("--root ", "Explicit caller-owned stack root (required)") + .option("-j, --json", "Emit one bounded JSON document on stdout") + .action(async (options: { root?: string; json?: boolean }) => { + const document = await getLocalConnectStatus(options.root); + if (options.json) console.log(JSON.stringify(document)); + else printHumanStatus(document); + if (document.status !== "ready") { + console.error(`ProPR Connect discovery: ${document.status}.`); + } + process.exitCode = CONNECT_STATUS_EXIT[document.status]; + }); + return command; +} diff --git a/packages/cli/src/commands/index.ts b/packages/cli/src/commands/index.ts index f105b390a..8ce767dd1 100644 --- a/packages/cli/src/commands/index.ts +++ b/packages/cli/src/commands/index.ts @@ -25,6 +25,7 @@ export { createStartCommand } from "./startCommand.js"; export { createStackStatusCommand, createStopCommand } from "./stackCommands.js"; export { createUiCommand, createDocsCommand } from "./uiDocsCommands.js"; export { createTunnelCommand } from "./tunnelCommand.js"; +export { createConnectCommand } from "./connectCommand.js"; export { createTankCommand } from "./tankCommands.js"; export { createRelayCommand } from "./relayCommands.js"; export { createRuntimeCommand } from "./runtimeCommands.js"; diff --git a/packages/cli/src/commands/initStack.test.ts b/packages/cli/src/commands/initStack.test.ts index 470be49a6..e6904e618 100644 --- a/packages/cli/src/commands/initStack.test.ts +++ b/packages/cli/src/commands/initStack.test.ts @@ -5,6 +5,7 @@ import { mkdirSync, mkdtempSync, readFileSync, + realpathSync, rmSync, symlinkSync, writeFileSync, @@ -58,13 +59,15 @@ test("stack scaffolding does not change the chosen project root mode", async () } }); -test("stack generation includes detected credentials in the published environment", async () => { - const root = mkdtempSync(join(tmpdir(), "propr-private-stack-")); - const home = mkdtempSync(join(tmpdir(), "propr-private-home-")); +test("stack generation remains operational and publishes its environment and identity", async () => { + const root = realpathSync.native(mkdtempSync(join(tmpdir(), "propr-private-stack-"))); + const home = realpathSync.native(mkdtempSync(join(tmpdir(), "propr-private-home-"))); const originalHome = process.env.HOME; + const originalUserProfile = process.env.USERPROFILE; try { mkdirSync(join(home, ".claude")); process.env.HOME = home; + process.env.USERPROFILE = home; const result = await scaffoldStack( { root }, @@ -77,14 +80,43 @@ test("stack generation includes detected credentials in the published environmen assert.ok(envLines.includes("NODE_ENV=production")); assert.ok(!envLines.includes("NODE_ENV=development")); assert.ok(envLines.includes(`HOST_CLAUDE_DIR=${join(home, ".claude")}`)); + assert.match( + readFileSync(join(root, "data", "public-instance-identity.json"), "utf-8"), + /"publicInstanceIdentity"/, + ); } finally { if (originalHome === undefined) delete process.env.HOME; else process.env.HOME = originalHome; + if (originalUserProfile === undefined) delete process.env.USERPROFILE; + else process.env.USERPROFILE = originalUserProfile; rmSync(root, { recursive: true, force: true }); rmSync(home, { recursive: true, force: true }); } }); +test("Windows stack scaffolding does not require discovery authority", async () => { + if (process.platform !== "win32") return; + const root = realpathSync.native(mkdtempSync(join(tmpdir(), "propr-windows-stack-"))); + try { + writeFileSync(join(root, ".env"), "SESSION_SECRET=existing\nNODE_ENV=production\n"); + const result = await scaffoldStack( + { root }, + { persistStackRoot: async () => undefined }, + ); + + assert.equal(result.envSkipped, true); + assert.deepEqual(result.dirsCreated.filter((name) => ["data", "logs", "repos"].includes(name)), [ + "data", "logs", "repos", + ]); + assert.match( + readFileSync(join(root, "data", "public-instance-identity.json"), "utf-8"), + /"publicInstanceIdentity"/, + ); + } finally { + rmSync(root, { recursive: true, force: true }); + } +}); + test("packaged runtime materialization leaves the source template reusable", () => { const sourceTemplate = "LOG_LEVEL=debug\nNODE_ENV=development\n"; diff --git a/packages/cli/src/commands/initStack.ts b/packages/cli/src/commands/initStack.ts index 71fa7ea37..bd2d6e326 100644 --- a/packages/cli/src/commands/initStack.ts +++ b/packages/cli/src/commands/initStack.ts @@ -9,7 +9,7 @@ import { Command } from "commander"; import { randomBytes } from "node:crypto"; -import { existsSync, chmodSync, mkdirSync, readFileSync } from "node:fs"; +import { existsSync, chmodSync, mkdirSync, readFileSync, realpathSync } from "node:fs"; import { fileURLToPath } from "node:url"; import { dirname, isAbsolute, join, resolve } from "node:path"; import { homedir } from "node:os"; @@ -20,6 +20,7 @@ import { secureExistingPrivateFile, writePrivateFileAtomic, } from "../utils/privateFilesystem.js"; +import { getOrCreatePublicInstanceIdentity } from "../connectIdentity.js"; export function materializeSessionSecret( template: string, @@ -171,16 +172,26 @@ export async function scaffoldStack( for (const sub of ["data", "logs", "repos"]) { const dir = join(rootDir, sub); const created = !existsSync(dir); - ensurePrivateDirectory(dir); + await ensurePrivateDirectory(dir); (created ? result.dirsCreated : result.dirsSkipped).push(sub); } + // The public installation identity belongs to the durable data boundary, not + // .env or a tunnel credential. Re-scaffolding/upgrading preserves it; replacing + // the stack data creates a fresh identity on the next initialization. + // macOS commonly spells its temporary-directory ancestor as /var even + // though the already-created root is canonically beneath /private/var. + // Canonicalize the root, then append the literal data entry so the identity + // layer still observes and rejects a symlink at data itself. + const canonicalRootDir = realpathSync.native(rootDir); + await getOrCreatePublicInstanceIdentity(join(canonicalRootDir, "data")); + // 2. Load the environment content that will be used below. const envExists = existsSync(envPath); let envContent: string; let shouldWriteEnv = false; if (envExists && !options.force) { - secureExistingPrivateFile(envPath); + await secureExistingPrivateFile(envPath); envContent = readFileSync(envPath, "utf-8"); result.envSkipped = true; const nodeEnv = envContent.match(/^\s*(?:export\s+)?NODE_ENV\s*=\s*([^#\r\n]*)/m)?.[1] @@ -202,9 +213,9 @@ export async function scaffoldStack( materializeSessionSecret(readFileSync(example, "utf-8")), ); if (options.force && envExists) { - secureExistingPrivateFile(envPath); + await secureExistingPrivateFile(envPath); const bakPath = `${envPath}.bak`; - writePrivateFileAtomic(bakPath, readFileSync(envPath), { secureParent: false }); + await writePrivateFileAtomic(bakPath, readFileSync(envPath), { secureParent: false }); result.envBackedUp = true; } shouldWriteEnv = true; @@ -234,10 +245,9 @@ export async function scaffoldStack( result.pendingCredentials = toAppend; if (shouldWriteEnv) { - writePrivateFileAtomic(envPath, envContent, { secureParent: false }); + await writePrivateFileAtomic(envPath, envContent, { secureParent: false }); result.envCreated = true; } - // 3b. When Vibe is in play, pre-create its prompt-cache dir so spawned Vibe // agent containers can bind-mount a writable host directory. Creating it // here (owned by the invoking user) avoids Docker auto-creating it as diff --git a/packages/cli/src/commands/tunnelCommand.test.ts b/packages/cli/src/commands/tunnelCommand.test.ts index f19828d86..9f0a499bc 100644 --- a/packages/cli/src/commands/tunnelCommand.test.ts +++ b/packages/cli/src/commands/tunnelCommand.test.ts @@ -89,11 +89,11 @@ function emptyStackStatus(): ReturnType { const sink = () => {}; -test("tunnel setup builds env from the Connect proxy URL", () => { +test("tunnel setup builds env from the exact Connect proxy URL", () => { assert.deepEqual( buildTunnelSetupEnv({ token: "secret-token", - url: "https://t-abc123.propr.dev/", + url: "https://t-abc123.propr.dev", }), { PROPR_UI_TUNNEL_TOKEN: "secret-token", @@ -108,6 +108,25 @@ test("tunnel setup builds env from the Connect proxy URL", () => { ); }); +test("tunnel setup rejects every noncanonical raw URL spelling", () => { + for (const url of [ + "https://t-abc123.propr.dev/", + "https://t-abc123.propr.dev////", + "https://T-AbC123.ProPR.dev", + " https://t-abc123.propr.dev", + "https://user@t-abc123.propr.dev///", + "https://t-abc123.propr.dev:443///", + "https://t-abc123.propr.dev/path///", + "https://t-abc123.propr.dev?query=1///", + "https://t-abc123.propr.dev#fragment///", + "https://t%2dabc123.propr.dev///", + "https://t-abc123.propr.dev.///", + "https://t-\u00e4bc.propr.dev///", + ]) { + assert.throws(() => buildTunnelSetupEnv({ token: "secret-token", url }), /hosted proxy URL/); + } +}); + test("tunnel setup builds env from an instance id", () => { assert.deepEqual( buildTunnelSetupEnv({ @@ -163,6 +182,25 @@ test("tunnel setup rejects a proxy URL carrying a path", () => { ); }); +test("tunnel setup rejects alternate raw Connect URL spellings", () => { + for (const url of [ + " https://t-abc123.propr.dev", + "https://t-abc123.propr.dev ", + "https://t-abc123.propr.dev/", + "https://t-abc123.propr.dev//", + "HTTPS://t-abc123.propr.dev", + "https://T-abc123.propr.dev", + "https://t-abc123.propr.dev:443", + "https://x.t-abc123.propr.dev", + ]) { + assert.throws( + () => buildTunnelSetupEnv({ token: "secret-token", url }), + /hosted proxy URL/, + url, + ); + } +}); + test("tunnel setup rejects --force because it only applies to tunnel on", () => { assert.throws( () => validateTunnelCommandOptions("setup", { force: true }), @@ -192,6 +230,15 @@ test("tunnel setup canonicalizes a mixed-case instance id", () => { ); }); +test("tunnel setup removes a mixed-case existing t- prefix exactly once", () => { + const env = buildTunnelSetupEnv({ + token: "secret-token", + instanceId: "T-AbC123", + }); + assert.equal(env.PROPR_INSTANCE_ID, "abc123"); + assert.equal(env.PROPR_UI_PUBLIC_API_URL, "https://t-abc123.propr.dev"); +}); + test("tunnel setup --start starts a stopped stack with tunnel settings", async () => { const calls: Array<{ fn: string; uiTunnelEnabled?: boolean }> = []; const { configManager, value } = fakeConfigManager(undefined); diff --git a/packages/cli/src/commands/tunnelCommand.ts b/packages/cli/src/commands/tunnelCommand.ts index 3daddf673..c970b97e3 100644 --- a/packages/cli/src/commands/tunnelCommand.ts +++ b/packages/cli/src/commands/tunnelCommand.ts @@ -23,6 +23,7 @@ import { proprInstanceProxyUrl, proprTunnelEndpoints, isProprProxyUrl, + canonicalProprProxyUrl, PROPR_UI_PROXY_SUFFIX, PROPR_UI_PROXY_LABEL_PREFIX, } from "@propr/shared"; @@ -418,7 +419,9 @@ export function buildTunnelSetupEnv(input: TunnelSetupInput): TunnelSetupEnv { const token = input.token.trim(); if (!token) throw new Error("--token is required"); - const explicitUrl = input.url?.trim().replace(/\/+$/, ""); + // URL authority is exact raw input: do not trim, fold case, or remove slashes + // before the shared canonical parser sees it. + const explicitUrl = input.url; const explicitInstanceId = input.instanceId?.trim(); if (!explicitUrl && !explicitInstanceId) { throw new Error("provide --url https://t-.propr.dev or --instance-id "); @@ -428,17 +431,17 @@ export function buildTunnelSetupEnv(input: TunnelSetupInput): TunnelSetupEnv { if (!candidateUrl) { throw new Error(`could not derive a hosted proxy URL from --instance-id (${explicitInstanceId})`); } - if (!isProprProxyUrl(candidateUrl)) { + const canonicalUrl = canonicalProprProxyUrl(candidateUrl); + if (!canonicalUrl) { throw new Error(`tunnel URL must be a bare hosted proxy URL such as https://${PROPR_UI_PROXY_LABEL_PREFIX}.${PROPR_UI_PROXY_SUFFIX} (no path/query/fragment)`); } - // Canonicalize: URL parsing already lowercases the host, and `.origin` drops - // any (validated-absent) path so the persisted value matches what the launcher - // resolves. DNS is case-insensitive, so the instance id is lowercased too — a - // mixed-case --instance-id would otherwise diverge from the launcher's value. - const publicUrl = new URL(candidateUrl).origin; + // candidateUrl has already passed the exact raw Connect-origin contract. + // Instance-id input remains a derivation input and is lowercased before its + // canonical endpoint is generated. + const publicUrl = candidateUrl; const derivedInstanceId = instanceIdFromProxyUrl(publicUrl); - const normalizedExplicitInstanceId = explicitInstanceId?.startsWith(PROPR_UI_PROXY_LABEL_PREFIX) + const normalizedExplicitInstanceId = explicitInstanceId?.toLowerCase().startsWith(PROPR_UI_PROXY_LABEL_PREFIX) ? explicitInstanceId.slice(PROPR_UI_PROXY_LABEL_PREFIX.length) : explicitInstanceId; const instanceId = (normalizedExplicitInstanceId ?? derivedInstanceId)?.toLowerCase(); @@ -658,7 +661,7 @@ async function runTunnelSetup(options: { console.log(` hosted UI: ${vars.FRONTEND_URL}`); console.log(` OAuth callback: ${vars.GH_OAUTH_CALLBACK_URL}`); console.log(" GitHub OAuth: register the callback URL above in your GitHub OAuth App"); - console.log(` Hosted UI link: ${vars.FRONTEND_URL}?tunnel=${encodeURIComponent(vars.PROPR_UI_PUBLIC_API_URL)}`); + console.log(` Hosted UI link: ${vars.FRONTEND_URL}?tunnel=${new URL(vars.PROPR_UI_PUBLIC_API_URL).hostname}`); console.log(""); if (options.start) { diff --git a/packages/cli/src/config/ConfigManager.test.ts b/packages/cli/src/config/ConfigManager.test.ts index 662712804..6bf4fc5c7 100644 --- a/packages/cli/src/config/ConfigManager.test.ts +++ b/packages/cli/src/config/ConfigManager.test.ts @@ -54,6 +54,25 @@ test("getRemoteProfiles returns copied profiles and includes an empty default pr } }); +test("read-only configuration inspection never repairs permissions or writes", async () => { + if (process.platform === "win32") return; + const tempDir = createTempDir(); + const configPath = join(tempDir, "config.json"); + try { + writeFileSync(configPath, JSON.stringify({ tunnelEnabledByRoot: { "/trusted/root": false } })); + chmodSync(configPath, 0o644); + const manager = new ConfigManager(tempDir, { readOnly: true, warn: () => undefined }); + await manager.init(); + + assert.equal(manager.getTunnelEnabled("/trusted/root"), undefined); + assert.equal(lstatSync(configPath).mode & 0o777, 0o644); + await assert.rejects(manager.setTunnelEnabled("/trusted/root", true), /read-only/); + assert.equal(lstatSync(configPath).mode & 0o777, 0o644); + } finally { + cleanupTempDir(tempDir); + } +}); + test("setRemoteProfile updates a named profile without changing the active profile", async () => { const tempDir = createTempDir(); try { @@ -380,39 +399,47 @@ test("root-specific tunnel toggles do not alter another stack", async () => { } }); -test("configuration tokens are persisted atomically under private modes", async () => { - if (process.platform === "win32") return; +test("configuration save remains operational on Windows and uses private modes elsewhere", { timeout: 20_000 }, async () => { + const started = Date.now(); const tempDir = createTempDir(); try { - chmodSync(tempDir, 0o755); + if (process.platform !== "win32") chmodSync(tempDir, 0o755); const manager = new ConfigManager(tempDir); await manager.init(); await manager.setGithubToken("private-token"); const configPath = join(tempDir, "config.json"); - assert.equal(lstatSync(tempDir).mode & 0o777, 0o700); - assert.equal(lstatSync(configPath).mode & 0o777, 0o600); + if (process.platform !== "win32") { + assert.equal(lstatSync(tempDir).mode & 0o777, 0o700); + assert.equal(lstatSync(configPath).mode & 0o777, 0o600); + } assert.match(readFileSync(configPath, "utf8"), /private-token/); assert.deepEqual(readdirSync(tempDir).filter(name => name.includes(".tmp-")), []); + assert.ok(Date.now() - started < 20_000, "configuration save exceeded its Windows aggregate deadline"); } finally { cleanupTempDir(tempDir); } }); -test("loading an existing token file tightens permissive directory and file modes", async () => { - if (process.platform === "win32") return; +test("loading an existing token file tightens permissive directory and file modes", { timeout: 20_000 }, async () => { + const started = Date.now(); const tempDir = createTempDir(); try { writeProfileConfig(tempDir); - chmodSync(tempDir, 0o755); - chmodSync(join(tempDir, "config.json"), 0o644); + if (process.platform !== "win32") { + chmodSync(tempDir, 0o755); + chmodSync(join(tempDir, "config.json"), 0o644); + } const manager = new ConfigManager(tempDir); await manager.init(); assert.equal(manager.getGithubToken(), "stored-token"); - assert.equal(lstatSync(tempDir).mode & 0o777, 0o700); - assert.equal(lstatSync(join(tempDir, "config.json")).mode & 0o777, 0o600); + if (process.platform !== "win32") { + assert.equal(lstatSync(tempDir).mode & 0o777, 0o700); + assert.equal(lstatSync(join(tempDir, "config.json")).mode & 0o777, 0o600); + } + assert.ok(Date.now() - started < 20_000, "configuration load exceeded its Windows aggregate deadline"); } finally { cleanupTempDir(tempDir); } diff --git a/packages/cli/src/config/ConfigManager.ts b/packages/cli/src/config/ConfigManager.ts index c6a79439a..b69c30d86 100644 --- a/packages/cli/src/config/ConfigManager.ts +++ b/packages/cli/src/config/ConfigManager.ts @@ -19,8 +19,11 @@ import { ensurePrivateDirectory, secureExistingPrivateDirectory, secureExistingPrivateFile, + validateExistingPrivateDirectory, + validateExistingPrivateFile, writePrivateFileAtomic, } from "../utils/privateFilesystem.js"; +import { canonicalRootKey } from "./rootKey.js"; /** * Default configuration directory name. @@ -62,6 +65,8 @@ export class ConfigManager { private configFilePath: string; private config: CLIConfig; private initialized: boolean = false; + private readonly warn: (message: string) => void; + private readonly readOnly: boolean; /** * Creates a new ConfigManager instance. @@ -69,10 +74,15 @@ export class ConfigManager { * @param customConfigDir - Optional custom configuration directory path. * Defaults to ~/.propr */ - constructor(customConfigDir?: string) { + constructor( + customConfigDir?: string, + options: { warn?: (message: string) => void; readOnly?: boolean } = {}, + ) { this.configDir = customConfigDir ?? path.join(os.homedir(), CONFIG_DIR_NAME); this.configFilePath = path.join(this.configDir, CONFIG_FILE_NAME); this.config = { ...DEFAULT_CONFIG }; + this.warn = options.warn ?? ((message) => console.warn(message)); + this.readOnly = options.readOnly ?? false; } /** @@ -99,15 +109,19 @@ export class ConfigManager { */ async load(): Promise { try { - if (secureExistingPrivateDirectory(this.configDir)) { - secureExistingPrivateFile(this.configFilePath); + const directoryExists = this.readOnly + ? validateExistingPrivateDirectory(this.configDir) + : await secureExistingPrivateDirectory(this.configDir); + if (directoryExists) { + if (this.readOnly) validateExistingPrivateFile(this.configFilePath); + else await secureExistingPrivateFile(this.configFilePath); } const data = await fs.promises.readFile(this.configFilePath, "utf-8"); const parsed = JSON.parse(data); // Validate that parsed data is an object if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) { - console.warn( + this.warn( `Warning: Configuration file at ${this.configFilePath} contains invalid data. Using defaults.` ); this.config = { ...DEFAULT_CONFIG }; @@ -132,7 +146,7 @@ export class ConfigManager { if (err instanceof SyntaxError) { // JSON parsing error - corrupted file - console.warn( + this.warn( `Warning: Configuration file at ${this.configFilePath} is corrupted (invalid JSON). Using defaults.` ); this.config = { ...DEFAULT_CONFIG }; @@ -140,7 +154,7 @@ export class ConfigManager { } // Other errors (permission issues, etc.) - console.warn( + this.warn( `Warning: Could not read configuration file at ${this.configFilePath}: ${err.message}. Using defaults.` ); this.config = { ...DEFAULT_CONFIG }; @@ -207,7 +221,7 @@ export class ConfigManager { ) { for (const [root, enabled] of Object.entries(data.tunnelEnabledByRoot as Record)) { if (path.isAbsolute(root) && typeof enabled === "boolean") { - tunnelEnabledByRoot[path.resolve(root)] = enabled; + tunnelEnabledByRoot[canonicalRootKey(root)] = enabled; } } } @@ -218,7 +232,7 @@ export class ConfigManager { // If no stackRoot was recorded, there is no safe root to associate with the // flag, so leave it unset and fall back to that stack's own .env default. if (typeof data.tunnelEnabled === "boolean" && typeof data.stackRoot === "string") { - const legacyRoot = path.resolve(data.stackRoot); + const legacyRoot = canonicalRootKey(path.resolve(data.stackRoot)); if (!(legacyRoot in tunnelEnabledByRoot)) { tunnelEnabledByRoot[legacyRoot] = data.tunnelEnabled; } @@ -274,7 +288,8 @@ export class ConfigManager { * @returns A promise that resolves when the configuration is saved. */ async save(): Promise { - ensurePrivateDirectory(this.configDir); + if (this.readOnly) throw new Error("Configuration manager is read-only"); + await ensurePrivateDirectory(this.configDir); // Only write non-undefined values const dataToWrite: Record = {}; @@ -285,7 +300,7 @@ export class ConfigManager { } const content = JSON.stringify(dataToWrite, null, 2); - writePrivateFileAtomic(this.configFilePath, content); + await writePrivateFileAtomic(this.configFilePath, content); } /** @@ -515,7 +530,7 @@ export class ConfigManager { * it to false. */ getTunnelEnabled(root: string): boolean | undefined { - return this.config.tunnelEnabledByRoot?.[path.resolve(root)]; + return this.config.tunnelEnabledByRoot?.[canonicalRootKey(path.resolve(root))]; } /** @@ -524,7 +539,7 @@ export class ConfigManager { * applies again (used to roll back a failed toggle). */ async setTunnelEnabled(root: string, enabled: boolean | undefined): Promise { - const normalizedRoot = path.resolve(root); + const normalizedRoot = canonicalRootKey(path.resolve(root)); const states = { ...(this.config.tunnelEnabledByRoot ?? {}) }; if (enabled === undefined) { delete states[normalizedRoot]; @@ -616,9 +631,10 @@ export class ConfigManager { * @returns A promise that resolves to an initialized ConfigManager. */ export async function createConfigManager( - customConfigDir?: string + customConfigDir?: string, + options: { warn?: (message: string) => void; readOnly?: boolean } = {}, ): Promise { - const manager = new ConfigManager(customConfigDir); + const manager = new ConfigManager(customConfigDir, options); await manager.init(); return manager; } diff --git a/packages/cli/src/config/rootKey.test.ts b/packages/cli/src/config/rootKey.test.ts new file mode 100644 index 000000000..f764a14d7 --- /dev/null +++ b/packages/cli/src/config/rootKey.test.ts @@ -0,0 +1,12 @@ +import assert from "node:assert/strict"; +import { test } from "node:test"; +import { canonicalRootKey } from "./rootKey.js"; + +test("Windows root keys keep distinct case-sensitive directory names separate", () => { + const upperCaseRoot = canonicalRootKey("C:\\Stacks\\CaseSensitive", "win32"); + const lowerCaseRoot = canonicalRootKey("C:\\Stacks\\casesensitive", "win32"); + + assert.equal(upperCaseRoot, "C:\\Stacks\\CaseSensitive"); + assert.equal(lowerCaseRoot, "C:\\Stacks\\casesensitive"); + assert.notEqual(upperCaseRoot, lowerCaseRoot); +}); diff --git a/packages/cli/src/config/rootKey.ts b/packages/cli/src/config/rootKey.ts new file mode 100644 index 000000000..30aa1d2de --- /dev/null +++ b/packages/cli/src/config/rootKey.ts @@ -0,0 +1,20 @@ +import path from "node:path"; + +/** Canonical key for persisted settings scoped to one exact stack root. */ +export function canonicalRootKey(root: string, platform: NodeJS.Platform = process.platform): string { + if (typeof root !== "string" || root.length === 0 || root.includes("\0")) { + throw new Error("Invalid stack root key"); + } + if (platform === "win32") { + if (!path.win32.isAbsolute(root)) throw new Error("Invalid stack root key"); + // Windows directories can opt into case-sensitive name lookup. Without a + // filesystem identity proving equivalence, folding case here can merge + // settings for two distinct roots. + return path.win32.normalize(path.win32.resolve(root)); + } + if (platform === "linux" || platform === "darwin") { + if (!path.posix.isAbsolute(root)) throw new Error("Invalid stack root key"); + return path.posix.normalize(path.posix.resolve(root)); + } + throw new Error("Invalid stack root key"); +} diff --git a/packages/cli/src/connectIdentity.ts b/packages/cli/src/connectIdentity.ts new file mode 100644 index 000000000..c0831d108 --- /dev/null +++ b/packages/cli/src/connectIdentity.ts @@ -0,0 +1,1040 @@ +import { randomUUID } from "node:crypto"; +import { + closeSync, + constants, + fchmodSync, + fstatSync, + linkSync, + lstatSync, + openSync, + readSync, + realpathSync, + unlinkSync, +} from "node:fs"; +import type { Stats } from "node:fs"; +import { basename, dirname, join, parse, resolve, sep } from "node:path"; +import { userInfo } from "node:os"; +import { + getOrCreatePublicInstanceIdentityPinned, + readPublicInstanceIdentityPinned, + type PinnedPublicIdentityDirectory, +} from "@propr/local-setup"; +import { + directoryDescriptorAccess, + mkdirAt, + lstatAt, + openAuthorityDirectoryNoFollow, + openAt, + renameAt, + unlinkAt, +} from "./utils/directoryDescriptor.js"; +import { + assertNativeEntryAuthority, + assertNativeWindowsEntriesAuthority, + nativeConnectRootAuthorityInspector, + WindowsAuthorityInspectionError, + WindowsAuthorityPolicyError, + type ConnectAuthorityEntryKind, + type ConnectRootAuthorityInspector, +} from "./connectRootAuthority.js"; +import { canonicalRootKey } from "./config/rootKey.js"; + +const MAX_ENV_FILE_BYTES = 1024 * 1024; +const MAX_CONNECT_CONFIG_BYTES = 1024 * 1024; + +export class ConnectRootError extends Error { + constructor(readonly reason = "INVALID_ROOT") { + super(`the explicit stack root is unavailable or is not owned by the caller [reason=${reason}]`); + this.name = "ConnectRootError"; + } +} + +export class PublicInstanceIdentityError extends Error { + constructor() { + super("the public instance identity is unavailable or invalid"); + this.name = "PublicInstanceIdentityError"; + } +} + +export class TrustedConnectConfigError extends Error { + constructor(readonly reason = "UNSAFE_CONFIG") { + super(`the persisted Connect configuration is unavailable or unsafe [reason=${reason}]`); + this.name = "TrustedConnectConfigError"; + } +} + +export interface TrustedConnectConfigOptions { + platform?: NodeJS.Platform; + authorityInspector?: ConnectRootAuthorityInspector; + /** Explicit only for deterministic/native tests; production uses OS userInfo. */ + trustedHome?: string; + onBoundary?: (boundary: + | "home-before-open" + | "home-opened" + | "config-directory-before-open" + | "config-directory-opened" + | "config-before-open" + | "config-opened" + | "config-read" + ) => void | Promise; +} + +export type ConnectRootSnapshotBoundary = "acquired" | "env-read" | "before-identity" | "identity-read"; + +export interface ConnectRootSnapshot { + /** Parsed bytes from the held, identity-checked .env file. */ + readonly envFileValues: Readonly>; + readonly identityDirectory: PinnedPublicIdentityDirectory; + /** Original caller input key; never treated as authority or reopened here. */ + readonly requestedRoot: string; + readonly authorityDiagnostic: "verified"; +} + +export interface ConnectRootSnapshotOptions { + platform?: NodeJS.Platform; + /** Structured native authority source; deterministic fixtures use this same policy path. */ + authorityInspector?: ConnectRootAuthorityInspector; + onBoundary?: (boundary: ConnectRootSnapshotBoundary) => void | Promise; + parseEnvFile?: (contents: string) => Record; +} + +interface HeldDirectory { + fd: number; + visiblePath: string; + openChild(name: string, flags: number, mode?: number): number; +} + +interface AcquiredRoot { + root: HeldDirectory; + ancestry: Array<{ path: string; stat: Stats; fd: number }>; +} + +class ConnectSnapshotOperationError extends Error { + constructor(readonly operationCause: unknown) { + super("Connect snapshot operation failed"); + } +} + +type IdentityValue = number | bigint | string; + +function exactIdentityValue(value: IdentityValue): bigint { + if (typeof value === "bigint") return value; + if (typeof value === "number") { + if (!Number.isSafeInteger(value) || value < 0) throw new ConnectRootError(); + return BigInt(value); + } + if (!/^(?:0|[1-9]\d{0,19})$/.test(value)) throw new ConnectRootError(); + return BigInt(value); +} + +function sameIdentity( + left: { readonly dev?: IdentityValue; readonly ino?: IdentityValue; readonly device?: IdentityValue; readonly file?: IdentityValue }, + right: { readonly dev?: IdentityValue; readonly ino?: IdentityValue; readonly device?: IdentityValue; readonly file?: IdentityValue }, +): boolean { + const leftDevice = left.device ?? left.dev; + const leftFile = left.file ?? left.ino; + const rightDevice = right.device ?? right.dev; + const rightFile = right.file ?? right.ino; + if (leftDevice === undefined || leftFile === undefined || rightDevice === undefined || rightFile === undefined) { + throw new ConnectRootError(); + } + return exactIdentityValue(leftDevice) === exactIdentityValue(rightDevice) + && exactIdentityValue(leftFile) === exactIdentityValue(rightFile); +} + +function descriptorRoot(): string { + const root = "/proc/self/fd"; + if (!lstatSync(root).isDirectory()) throw new ConnectRootError(); + return root; +} + +function heldDirectory(fd: number, platform: NodeJS.Platform, visiblePath: string): HeldDirectory { + if (platform === "linux") { + const path = join(descriptorRoot(), String(fd)); + return { + fd, + visiblePath, + openChild: (name, flags, mode = 0) => openSync(join(path, name), flags, mode), + }; + } + if (platform === "darwin") { + return { + fd, + visiblePath, + openChild: (name, flags, mode = 0) => openAt(fd, name, flags, mode), + }; + } + if (platform === "win32") { + return { + fd, + visiblePath, + openChild: (name, flags, mode = 0) => openSync(join(visiblePath, name), flags, mode), + }; + } + throw new ConnectRootError(); +} + +function assertSafeAncestry(ancestry: Stats[], callerUid: number): void { + for (const stat of ancestry) { + if (!stat.isDirectory() || stat.isSymbolicLink()) throw new ConnectRootError(); + if (stat.uid !== 0 && stat.uid !== callerUid) throw new ConnectRootError(); + const writableByOthers = (stat.mode & 0o022) !== 0; + const sticky = (stat.mode & 0o1000) !== 0; + if (writableByOthers && !sticky) throw new ConnectRootError(); + } +} + +function assertPrivateRoot(stat: Stats, callerUid: number | undefined, platform: NodeJS.Platform): void { + if ( + !stat.isDirectory() + || stat.isSymbolicLink() + || (platform !== "win32" && (stat.uid !== callerUid || (stat.mode & 0o022) !== 0)) + ) { + throw new ConnectRootError(); + } +} + +function assertPrivateData(stat: Stats, callerUid: number | undefined, platform: NodeJS.Platform): void { + if ( + !stat.isDirectory() + || stat.isSymbolicLink() + || (platform !== "win32" && (stat.uid !== callerUid || (stat.mode & 0o777) !== 0o700)) + ) throw new ConnectRootError(); +} + +function assertPrivateEnv(stat: Stats, callerUid: number | undefined, platform: NodeJS.Platform): void { + if ( + !stat.isFile() + || stat.isSymbolicLink() + || stat.nlink !== 1 + || (platform !== "win32" && (stat.uid !== callerUid || (stat.mode & 0o777) !== 0o600)) + || stat.size > MAX_ENV_FILE_BYTES + ) throw new ConnectRootError(); +} + +function openRootNoFollow(rootDir: string, platform: NodeJS.Platform): AcquiredRoot { + if (platform !== "win32") directoryDescriptorAccess(platform); + const parsed = parse(rootDir); + let fd = openAuthorityDirectoryNoFollow(parsed.root); + const ancestry: Array<{ path: string; stat: Stats; fd: number }> = []; + let visible = parsed.root; + try { + for (const component of rootDir.slice(parsed.root.length).split(sep).filter(Boolean)) { + const current = heldDirectory(fd, platform, visible); + const nextVisible = join(visible, component); + const next = openAuthorityDirectoryNoFollow( + nextVisible, + flags => current.openChild(component, flags), + ); + if (visible === parsed.root) closeSync(fd); + fd = next; + visible = nextVisible; + const named = lstatSync(visible); + const pinned = fstatSync(fd); + if (named.isSymbolicLink() || !sameIdentity(named, pinned)) throw new ConnectRootError(); + ancestry.push({ path: visible, stat: named, fd }); + } + return { root: heldDirectory(fd, platform, visible), ancestry }; + } catch (error) { + for (const descriptor of new Set([fd, ...ancestry.map((entry) => entry.fd)])) { + try { closeSync(descriptor); } catch { /* Preserve the authority error. */ } + } + throw error; + } +} + +function closeAcquired(acquired: AcquiredRoot): void { + for (const descriptor of new Set([acquired.root.fd, ...acquired.ancestry.map((entry) => entry.fd)])) closeSync(descriptor); +} + +function closeAcquiredAncestors(acquired: AcquiredRoot): void { + for (const entry of acquired.ancestry.slice(0, -1)) closeSync(entry.fd); +} + +function readHeldEnv(fd: number, platform: NodeJS.Platform): string { + const before = fstatSync(fd); + if (before.size < 0 || before.size > MAX_ENV_FILE_BYTES) throw new ConnectRootError(); + const bytes = Buffer.allocUnsafe(MAX_ENV_FILE_BYTES + 1); + let length = 0; + while (length < bytes.byteLength) { + const count = readSync(fd, bytes, length, bytes.byteLength - length, null); + if (count === 0) break; + length += count; + } + const after = fstatSync(fd); + assertPrivateEnv(after, before.uid, platform); + if ( + !sameIdentity(before, after) + || before.size !== after.size + || length !== before.size + || length > MAX_ENV_FILE_BYTES + ) { + throw new ConnectRootError(); + } + try { + return new TextDecoder("utf-8", { fatal: true }).decode(bytes.subarray(0, length)); + } catch { + throw new ConnectRootError(); + } +} + +function readBoundedPrivateFile(fd: number, maximum: number, validate: (stat: Stats) => void): string { + const before = fstatSync(fd); + validate(before); + if (before.size <= 0 || before.size > maximum) throw new TrustedConnectConfigError(); + const bytes = Buffer.allocUnsafe(maximum + 1); + let length = 0; + while (length < bytes.byteLength) { + const count = readSync(fd, bytes, length, bytes.byteLength - length, null); + if (count === 0) break; + length += count; + } + const after = fstatSync(fd); + validate(after); + if (!sameIdentity(before, after) || before.size !== after.size || length !== before.size || length > maximum) { + throw new TrustedConnectConfigError(); + } + try { + return new TextDecoder("utf-8", { fatal: true }).decode(bytes.subarray(0, length)); + } catch { + throw new TrustedConnectConfigError(); + } +} + +function parseTrustedTunnelOverride(contents: string, requestedRoot: string, platform: NodeJS.Platform): boolean | undefined { + let parsed: unknown; + try { parsed = JSON.parse(contents); } catch { throw new TrustedConnectConfigError(); } + if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) throw new TrustedConnectConfigError(); + const data = parsed as Record; + const states = new Map(); + if (data.tunnelEnabledByRoot !== undefined) { + if (!data.tunnelEnabledByRoot || typeof data.tunnelEnabledByRoot !== "object" || Array.isArray(data.tunnelEnabledByRoot)) { + throw new TrustedConnectConfigError(); + } + for (const [root, enabled] of Object.entries(data.tunnelEnabledByRoot as Record)) { + if (typeof enabled !== "boolean") throw new TrustedConnectConfigError(); + let key: string; + try { key = canonicalRootKey(root, platform); } catch { throw new TrustedConnectConfigError(); } + const existing = states.get(key); + if (existing !== undefined && existing !== enabled) throw new TrustedConnectConfigError(); + states.set(key, enabled); + } + } + if (data.tunnelEnabled !== undefined) { + if (typeof data.tunnelEnabled !== "boolean" || typeof data.stackRoot !== "string") { + throw new TrustedConnectConfigError(); + } + let legacyKey: string; + try { legacyKey = canonicalRootKey(data.stackRoot, platform); } catch { throw new TrustedConnectConfigError(); } + const existing = states.get(legacyKey); + if (existing !== undefined && existing !== data.tunnelEnabled) throw new TrustedConnectConfigError(); + if (existing === undefined) states.set(legacyKey, data.tunnelEnabled); + } + let requestedKey: string; + try { requestedKey = canonicalRootKey(requestedRoot, platform); } catch { throw new TrustedConnectConfigError(); } + return states.get(requestedKey); +} + +/** + * Read only the root-specific tunnel intent from an OS-selected home. The + * directory and file stay pinned throughout a bounded synchronous read; no + * ambient HOME/cwd, profile, token, or unrelated setting is consumed. + */ +export async function readTrustedConnectTunnelOverride( + requestedRoot: string, + options: TrustedConnectConfigOptions = {}, +): Promise { + const platform = options.platform ?? process.platform; + const ioPlatform = platform === process.platform ? platform : process.platform; + if ( + (platform !== "linux" && platform !== "darwin" && platform !== "win32") + || (ioPlatform !== "linux" && ioPlatform !== "darwin" && ioPlatform !== "win32") + ) throw new TrustedConnectConfigError(); + const inspector = options.authorityInspector ?? nativeConnectRootAuthorityInspector; + const callerUid = process.getuid?.(); + const homePath = resolve(options.trustedHome ?? userInfo().homedir); + let home: AcquiredRoot | undefined; + let homeAncestorsClosed = false; + let configDir: HeldDirectory | undefined; + let configFd: number | undefined; + try { + if (!sameResolvedPath(realpathSync.native(homePath), homePath, platform)) { + throw new TrustedConnectConfigError("REPARSE_POINT"); + } + const namedHomeBefore = lstatSync(homePath); + if (namedHomeBefore.isSymbolicLink()) throw new TrustedConnectConfigError("REPARSE_POINT"); + await options.onBoundary?.("home-before-open"); + home = openRootNoFollow(homePath, ioPlatform); + await options.onBoundary?.("home-opened"); + if (!sameIdentity(namedHomeBefore, fstatSync(home.root.fd))) throw new TrustedConnectConfigError(); + if (platform !== "win32") { + await assertTrustedHomeAuthority(home, platform, inspector, callerUid); + closeAcquiredAncestors(home); + homeAncestorsClosed = true; + } + assertPrivateRoot(fstatSync(home.root.fd), callerUid, platform); + const verifyNamedHome = () => { + const held = fstatSync(home!.root.fd); + const named = lstatSync(homePath); + if (named.isSymbolicLink() || !sameIdentity(named, held)) throw new TrustedConnectConfigError(); + return held; + }; + + verifyNamedHome(); + let namedConfigDirectoryBefore: ReturnType | undefined; + try { + namedConfigDirectoryBefore = lstatSync(join(homePath, ".propr")); + if (namedConfigDirectoryBefore.isSymbolicLink()) { + throw new TrustedConnectConfigError("CONFIG_DIRECTORY_REPARSE"); + } + } catch (error) { + if ((error as NodeJS.ErrnoException).code !== "ENOENT") throw error; + // The pathname precheck is not authoritative. Authenticate absence only + // through the child open anchored at the already-held home descriptor. + verifyNamedHome(); + } + await options.onBoundary?.("config-directory-before-open"); + let configDirectoryFd: number; + try { + configDirectoryFd = openAuthorityDirectoryNoFollow( + join(homePath, ".propr"), + flags => home!.root.openChild(".propr", flags), + ); + } catch (error) { + if ((error as NodeJS.ErrnoException).code !== "ENOENT") throw error; + verifyNamedHome(); + if (namedConfigDirectoryBefore !== undefined) throw new TrustedConnectConfigError(); + if (platform === "win32") { + await authorityEntries(inspector, [ + ...home.ancestry.slice(0, -1).map((entry) => ({ + path: entry.path, kind: "ancestor" as const, pinnedFd: entry.fd, + })), + { path: home.root.visiblePath, kind: "home", pinnedFd: home.root.fd }, + ]); + verifyNamedHome(); + closeAcquiredAncestors(home); + homeAncestorsClosed = true; + } + return undefined; + } + configDir = heldDirectory(configDirectoryFd, ioPlatform, join(homePath, ".propr")); + await options.onBoundary?.("config-directory-opened"); + verifyNamedHome(); + if ( + namedConfigDirectoryBefore === undefined + || !sameIdentity(namedConfigDirectoryBefore, fstatSync(configDir.fd)) + ) throw new TrustedConnectConfigError(); + const directoryStat = fstatSync(configDir.fd); + assertPrivateData(directoryStat, callerUid, platform); + assertNamedEntry(homePath, ".propr", directoryStat); + if (platform === "darwin") await authorityEntry(inspector, platform, configDir.visiblePath, "data", configDir.fd); + const verifyNamedConfigDirectory = () => { + verifyNamedHome(); + const held = fstatSync(configDir!.fd); + assertNamedEntry(homePath, ".propr", held); + return held; + }; + + verifyNamedConfigDirectory(); + let namedConfigBefore: ReturnType | undefined; + try { + namedConfigBefore = lstatSync(join(configDir.visiblePath, "config.json")); + if (namedConfigBefore.isSymbolicLink()) throw new TrustedConnectConfigError(); + } catch (error) { + if ((error as NodeJS.ErrnoException).code !== "ENOENT") throw error; + // Do not decide absence from this precheck. Only the anchored child open + // below can authenticate an absent config entry. + verifyNamedConfigDirectory(); + } + await options.onBoundary?.("config-before-open"); + try { + configFd = configDir.openChild("config.json", constants.O_RDONLY | constants.O_NOFOLLOW); + } catch (error) { + if ((error as NodeJS.ErrnoException).code === "ENOENT") { + // Absence is authoritative only for this exact child-open failure, and + // only while the already-held/named parent still denotes one object. + verifyNamedConfigDirectory(); + if (namedConfigBefore !== undefined) throw new TrustedConnectConfigError(); + if (platform === "win32") { + await authorityEntries(inspector, [ + ...home.ancestry.slice(0, -1).map((entry) => ({ + path: entry.path, kind: "ancestor" as const, pinnedFd: entry.fd, + })), + { path: home.root.visiblePath, kind: "home", pinnedFd: home.root.fd }, + { path: configDir.visiblePath, kind: "data", pinnedFd: configDir.fd }, + ]); + closeAcquiredAncestors(home); + homeAncestorsClosed = true; + } + return undefined; + } + throw error; + } + verifyNamedConfigDirectory(); + if (namedConfigBefore === undefined || !sameIdentity(namedConfigBefore, fstatSync(configFd))) { + throw new TrustedConnectConfigError(); + } + const validateConfig = (stat: Stats) => { + if ( + !stat.isFile() + || stat.isSymbolicLink() + || stat.nlink !== 1 + || (platform !== "win32" && (stat.uid !== callerUid || (stat.mode & 0o777) !== 0o600)) + ) throw new TrustedConnectConfigError(); + }; + validateConfig(fstatSync(configFd)); + assertNamedEntry(configDir.visiblePath, "config.json", fstatSync(configFd)); + if (platform === "darwin") { + await authorityEntry(inspector, platform, join(configDir.visiblePath, "config.json"), "env", configFd); + } else if (platform === "win32") { + await authorityEntries(inspector, [ + ...home.ancestry.slice(0, -1).map((entry) => ({ + path: entry.path, kind: "ancestor" as const, pinnedFd: entry.fd, + })), + { path: home.root.visiblePath, kind: "home", pinnedFd: home.root.fd }, + { path: configDir.visiblePath, kind: "data", pinnedFd: configDir.fd }, + { path: join(configDir.visiblePath, "config.json"), kind: "env", pinnedFd: configFd }, + ]); + closeAcquiredAncestors(home); + homeAncestorsClosed = true; + } + verifyNamedConfigDirectory(); + await options.onBoundary?.("config-opened"); + const contents = readBoundedPrivateFile(configFd, MAX_CONNECT_CONFIG_BYTES, validateConfig); + await options.onBoundary?.("config-read"); + + const fileAfter = fstatSync(configFd); + assertNamedEntry(configDir.visiblePath, "config.json", fileAfter); + const directoryAfter = fstatSync(configDir.fd); + assertPrivateData(directoryAfter, callerUid, platform); + assertNamedEntry(homePath, ".propr", directoryAfter); + const homeAfter = fstatSync(home.root.fd); + assertPrivateRoot(homeAfter, callerUid, platform); + const namedHome = lstatSync(homePath); + if (namedHome.isSymbolicLink() || !sameIdentity(namedHome, homeAfter)) throw new TrustedConnectConfigError(); + if (platform === "darwin") { + await authorityEntry(inspector, platform, configDir.visiblePath, "data", configDir.fd); + await authorityEntry(inspector, platform, join(configDir.visiblePath, "config.json"), "env", configFd); + } else if (platform === "win32") { + await authorityEntries(inspector, [ + { path: home.root.visiblePath, kind: "home", pinnedFd: home.root.fd }, + { path: configDir.visiblePath, kind: "data", pinnedFd: configDir.fd }, + { path: join(configDir.visiblePath, "config.json"), kind: "env", pinnedFd: configFd }, + ]); + } + return parseTrustedTunnelOverride(contents, requestedRoot, platform); + } catch (error) { + if (error instanceof TrustedConnectConfigError) throw error; + if (error instanceof WindowsAuthorityPolicyError) { + throw new TrustedConnectConfigError(`NATIVE_ENTRY_${error.entryIndex}_${error.policyReason}`); + } + if (error instanceof ConnectRootError) throw new TrustedConnectConfigError(error.reason); + throw new TrustedConnectConfigError(); + } finally { + if (configFd !== undefined) closeSync(configFd); + if (configDir !== undefined) closeSync(configDir.fd); + if (home !== undefined) { + if (!homeAncestorsClosed) closeAcquiredAncestors(home); + closeSync(home.root.fd); + } + } +} + +async function authorityEntry( + inspector: ConnectRootAuthorityInspector, + platform: NodeJS.Platform, + path: string, + kind: ConnectAuthorityEntryKind, + pinnedFd: number, +): Promise { + try { + await assertNativeEntryAuthority(inspector, platform, path, kind, pinnedFd); + } catch (error) { + if (error instanceof WindowsAuthorityInspectionError) throw error; + if (error instanceof WindowsAuthorityPolicyError) throw error; + throw new ConnectRootError(); + } +} + +async function authorityEntries( + inspector: ConnectRootAuthorityInspector, + entries: readonly { path: string; kind: ConnectAuthorityEntryKind; pinnedFd: number }[], +): Promise { + await assertNativeWindowsEntriesAuthority(inspector, entries); +} + +async function assertPlatformAuthority( + acquired: AcquiredRoot, + platform: NodeJS.Platform, + inspector: ConnectRootAuthorityInspector, + callerUid: number | undefined, +): Promise { + if (platform === "win32") { + await authorityEntries(inspector, [ + ...acquired.ancestry.slice(0, -1).map((entry) => ({ + path: entry.path, kind: "ancestor" as const, pinnedFd: entry.fd, + })), + { path: acquired.root.visiblePath, kind: "root", pinnedFd: acquired.root.fd }, + ]); + return; + } + if (callerUid === undefined) throw new ConnectRootError(); + assertSafeAncestry(acquired.ancestry.slice(0, -1).map((entry) => entry.stat), callerUid); + assertPrivateRoot(fstatSync(acquired.root.fd), callerUid, platform); + if (platform === "darwin") { + for (const entry of acquired.ancestry.slice(0, -1)) { + await authorityEntry(inspector, platform, entry.path, "ancestor", entry.fd); + } + await authorityEntry(inspector, platform, acquired.root.visiblePath, "root", acquired.root.fd); + } +} + +async function assertTrustedHomeAuthority( + acquired: AcquiredRoot, + platform: NodeJS.Platform, + inspector: ConnectRootAuthorityInspector, + callerUid: number | undefined, +): Promise { + if (platform === "win32") { + await authorityEntries(inspector, [ + ...acquired.ancestry.slice(0, -1).map((entry) => ({ + path: entry.path, kind: "ancestor" as const, pinnedFd: entry.fd, + })), + { path: acquired.root.visiblePath, kind: "home", pinnedFd: acquired.root.fd }, + ]); + return; + } + if (callerUid === undefined) throw new TrustedConnectConfigError(); + assertSafeAncestry(acquired.ancestry.slice(0, -1).map((entry) => entry.stat), callerUid); + assertPrivateRoot(fstatSync(acquired.root.fd), callerUid, platform); + if (platform === "darwin") { + for (const entry of acquired.ancestry.slice(0, -1)) { + await authorityEntry(inspector, platform, entry.path, "ancestor", entry.fd); + } + await authorityEntry(inspector, platform, acquired.root.visiblePath, "home", acquired.root.fd); + } +} + +function sameResolvedPath(left: string, right: string, platform: NodeJS.Platform): boolean { + return platform === "win32" ? left.toLowerCase() === right.toLowerCase() : left === right; +} + +function assertNamedEntry(rootDir: string, name: string, held: Stats): void { + const named = lstatSync(join(rootDir, name)); + if (named.isSymbolicLink() || !sameIdentity(named, held)) throw new ConnectRootError("NAMED_REPLACED"); +} + +function identifyHeldChild(directory: HeldDirectory, platform: NodeJS.Platform, name: string) { + if (platform === "darwin") { + const stat = lstatAt(directory.fd, name); + return { + device: exactIdentityValue(stat.dev).toString(10), + file: exactIdentityValue(stat.ino).toString(10), + kind: stat.kind, + }; + } + const stat = lstatSync(platform === "linux" + ? join(descriptorRoot(), String(directory.fd), name) + : join(directory.visiblePath, name), { bigint: true }); + return { + device: stat.dev.toString(10), + file: stat.ino.toString(10), + kind: stat.isFile() + ? "file" as const + : stat.isDirectory() + ? "directory" as const + : stat.isSymbolicLink() + ? "symbolic-link" as const + : "other" as const, + }; +} + +/** + * Run all root-dependent work inside one descriptor-anchored snapshot. + * No trusted pathname escapes the callback, and every named identity is checked again. + */ +export async function withOwnedConnectRootSnapshot( + flagRoot: string | undefined, + operation: (snapshot: ConnectRootSnapshot) => T | Promise, + options: ConnectRootSnapshotOptions, +): Promise { + if (!flagRoot || !options.parseEnvFile) throw new ConnectRootError(); + const platform = options.platform ?? process.platform; + if (platform !== "linux" && platform !== "darwin" && platform !== "win32") throw new ConnectRootError(); + const ioPlatform = platform === process.platform + ? platform + : (process.platform === "linux" || process.platform === "darwin") && options.authorityInspector + ? process.platform + : undefined; + if (!ioPlatform) throw new ConnectRootError(); + const inspector = options.authorityInspector ?? nativeConnectRootAuthorityInspector; + const callerUid = process.getuid?.(); + if (platform !== "win32" && callerUid === undefined) throw new ConnectRootError(); + const requestedRoot = resolve(flagRoot); + try { + if (!sameResolvedPath(realpathSync.native(requestedRoot), requestedRoot, platform)) { + throw new ConnectRootError("REPARSE_POINT"); + } + } catch (error) { + if (error instanceof ConnectRootError) throw error; + throw new ConnectRootError("REALPATH_UNAVAILABLE"); + } + + let root: HeldDirectory | undefined; + let data: HeldDirectory | undefined; + let envFd: number | undefined; + let acquiredRoot: AcquiredRoot | undefined; + let acquiredAncestorsClosed = false; + try { + const acquired = openRootNoFollow(requestedRoot, ioPlatform); + acquiredRoot = acquired; + root = acquired.root; + if (platform !== "win32") { + await assertPlatformAuthority(acquired, platform, inspector, callerUid); + closeAcquiredAncestors(acquired); + acquiredAncestorsClosed = true; + } + assertPrivateRoot(fstatSync(root.fd), callerUid, platform); + + const verifyNamedRoot = () => { + const held = fstatSync(root!.fd); + const named = lstatSync(requestedRoot); + if (named.isSymbolicLink() || !sameIdentity(named, held)) throw new ConnectRootError(); + return held; + }; + verifyNamedRoot(); + const dataFd = openAuthorityDirectoryNoFollow( + join(requestedRoot, "data"), + flags => root!.openChild("data", flags), + ); + data = heldDirectory(dataFd, ioPlatform, join(requestedRoot, "data")); + verifyNamedRoot(); + const initialDataStat = fstatSync(data.fd); + assertPrivateData(initialDataStat, callerUid, platform); + assertNamedEntry(requestedRoot, "data", initialDataStat); + if (platform === "darwin") await authorityEntry(inspector, platform, data.visiblePath, "data", data.fd); + verifyNamedRoot(); + envFd = root.openChild(".env", constants.O_RDONLY | constants.O_NOFOLLOW); + verifyNamedRoot(); + const initialEnvStat = fstatSync(envFd); + assertPrivateEnv(initialEnvStat, callerUid, platform); + assertNamedEntry(requestedRoot, ".env", initialEnvStat); + if (platform === "darwin") { + await authorityEntry(inspector, platform, join(requestedRoot, ".env"), "env", envFd); + } else if (platform === "win32") { + await authorityEntries(inspector, [ + ...acquired.ancestry.slice(0, -1).map((entry) => ({ + path: entry.path, kind: "ancestor" as const, pinnedFd: entry.fd, + })), + { path: root.visiblePath, kind: "root", pinnedFd: root.fd }, + { path: data.visiblePath, kind: "data", pinnedFd: data.fd }, + { path: join(requestedRoot, ".env"), kind: "env", pinnedFd: envFd }, + ]); + closeAcquiredAncestors(acquired); + acquiredAncestorsClosed = true; + } + await options.onBoundary?.("acquired"); + + const envFileValues = options.parseEnvFile(readHeldEnv(envFd, platform)); + await options.onBoundary?.("env-read"); + const verifyNamedData = (): Stats => { + const held = fstatSync(data!.fd); + assertPrivateData(held, callerUid, platform); + // Unix child operations remain anchored to the held descriptor even if + // the visible name is concurrently replaced; final revalidation rejects + // the snapshot. Windows child operations are pathname-based and must + // therefore prove the visible data identity before every use. + if (platform === "win32") { + assertNamedEntry(requestedRoot, "data", held); + } + return held; + }; + const identityDirectory: PinnedPublicIdentityDirectory = { + fd: data.fd, + ownerUid: initialDataStat.uid, + open: (name, flags, mode = 0) => { + verifyNamedData(); + const childFd = data!.openChild(name, flags, mode); + if (platform === "win32") { + try { + verifyNamedData(); + const child = fstatSync(childFd); + const named = lstatSync(join(data!.visiblePath, name)); + if (named.isSymbolicLink() || !sameIdentity(named, child)) throw new ConnectRootError(); + verifyNamedData(); + } catch (error) { + closeSync(childFd); + throw error; + } + } + return childFd; + }, + identify: (name) => { + verifyNamedData(); + const identity = identifyHeldChild(data!, ioPlatform, name); + verifyNamedData(); + return identity; + }, + validateEntry: async (name, fd) => { + const entryPath = join(data!.visiblePath, name); + if (platform !== "linux") { + await authorityEntry(inspector, platform, entryPath, "env", fd); + } + }, + publishNoReplace: (oldName, newName) => { + verifyNamedData(); + if (platform === "win32") { + linkSync(join(data!.visiblePath, oldName), join(data!.visiblePath, newName)); + unlinkSync(join(data!.visiblePath, oldName)); + } else { + renameAt(data!.fd, oldName, newName); + } + verifyNamedData(); + }, + unlink: (name) => { + verifyNamedData(); + if (platform === "win32") unlinkSync(join(data!.visiblePath, name)); + else unlinkAt(data!.fd, name); + verifyNamedData(); + }, + }; + + let result: T | undefined; + let operationError: unknown; + try { + result = await operation({ + envFileValues, + identityDirectory, + requestedRoot, + authorityDiagnostic: "verified", + }); + } catch (error) { + operationError = error; + } + const namedRoot = lstatSync(requestedRoot); + const heldRootStat = fstatSync(root.fd); + if (namedRoot.isSymbolicLink() || !sameIdentity(namedRoot, heldRootStat)) throw new ConnectRootError(); + assertPrivateRoot(heldRootStat, callerUid, platform); + const heldDataStat = fstatSync(data.fd); + const heldEnvStat = fstatSync(envFd); + assertPrivateData(heldDataStat, callerUid, platform); + assertPrivateEnv(heldEnvStat, callerUid, platform); + assertNamedEntry(requestedRoot, "data", heldDataStat); + assertNamedEntry(requestedRoot, ".env", heldEnvStat); + if (platform === "darwin") { + await authorityEntry(inspector, platform, data.visiblePath, "data", data.fd); + await authorityEntry(inspector, platform, join(requestedRoot, ".env"), "env", envFd); + } + const reacquired = openRootNoFollow(requestedRoot, ioPlatform); + try { + const before = acquired.ancestry; + const after = reacquired.ancestry; + if ( + before.length !== after.length + || before.some((entry, index) => !sameIdentity(entry.stat, after[index].stat)) + ) throw new ConnectRootError(); + if (platform === "win32") { + await authorityEntries(inspector, [ + ...reacquired.ancestry.slice(0, -1).map((entry) => ({ + path: entry.path, kind: "ancestor" as const, pinnedFd: entry.fd, + })), + { path: reacquired.root.visiblePath, kind: "root", pinnedFd: reacquired.root.fd }, + { path: data.visiblePath, kind: "data", pinnedFd: data.fd }, + { path: join(requestedRoot, ".env"), kind: "env", pinnedFd: envFd }, + ]); + } else { + await assertPlatformAuthority(reacquired, platform, inspector, callerUid); + } + } finally { + closeAcquired(reacquired); + } + if (operationError !== undefined) throw new ConnectSnapshotOperationError(operationError); + return result as T; + } catch (error) { + if (error instanceof ConnectSnapshotOperationError) throw error.operationCause; + if (error instanceof PublicInstanceIdentityError) throw error; + if (error instanceof WindowsAuthorityInspectionError) throw error; + if (error instanceof ConnectRootError) throw error; + if (error instanceof WindowsAuthorityPolicyError) { + throw new ConnectRootError(`NATIVE_ENTRY_${error.entryIndex}_${error.policyReason}`); + } + throw new ConnectRootError(); + } finally { + if (acquiredRoot !== undefined && !acquiredAncestorsClosed) closeAcquiredAncestors(acquiredRoot); + if (envFd !== undefined) closeSync(envFd); + if (data !== undefined) closeSync(data.fd); + if (root !== undefined) closeSync(root.fd); + } +} + +/** Host-side access used by stack initialization outside the Connect snapshot. */ +export async function getOrCreatePublicInstanceIdentity( + dataDir: string, + generate: () => string = randomUUID, +): Promise { + const platform = process.platform; + const requestedDataPath = resolve(dataDir); + const dataPath = platform === "win32" ? realpathSync.native(requestedDataPath) : requestedDataPath; + if (platform === "win32") { + let held: HeldDirectory | undefined; + try { + const acquired = openRootNoFollow(dataPath, platform); + held = acquired.root; + // Windows stack initialization and configuration persistence predate + // Connect discovery. Keep this mutation path independent from the + // read-only DACL diagnostic that is deferred to #1997. + closeAcquiredAncestors(acquired); + const terminal = fstatSync(held.fd); + assertPrivateData(terminal, undefined, platform); + const verifyVisible = () => { + const visible = lstatSync(dataPath); + const pinned = fstatSync(held!.fd); + if (visible.isSymbolicLink() || !sameIdentity(visible, pinned)) throw new PublicInstanceIdentityError(); + assertPrivateData(pinned, undefined, platform); + }; + const directory: PinnedPublicIdentityDirectory = { + fd: held.fd, + ownerUid: terminal.uid, + open: (name, flags, mode = 0) => { + verifyVisible(); + const fd = held!.openChild(name, flags, mode); + try { + verifyVisible(); + const opened = fstatSync(fd); + const named = lstatSync(join(dataPath, name)); + if (named.isSymbolicLink() || !sameIdentity(opened, named)) throw new PublicInstanceIdentityError(); + verifyVisible(); + return fd; + } catch (error) { + closeSync(fd); + throw error; + } + }, + identify: (name) => { + verifyVisible(); + const identity = identifyHeldChild(held!, platform, name); + verifyVisible(); + return identity; + }, + validateEntry: () => undefined, + publishNoReplace: (oldName, newName) => { + verifyVisible(); + linkSync(join(dataPath, oldName), join(dataPath, newName)); + unlinkSync(join(dataPath, oldName)); + verifyVisible(); + }, + unlink: (name) => { + verifyVisible(); + unlinkSync(join(dataPath, name)); + verifyVisible(); + }, + }; + const identity = await getOrCreatePublicInstanceIdentityPinned(directory, { generate, role: "host" }); + verifyVisible(); + return identity; + } catch (error) { + if (error instanceof PublicInstanceIdentityError) throw error; + throw new PublicInstanceIdentityError(); + } finally { + if (held !== undefined) closeSync(held.fd); + } + } + if (platform !== "linux" && platform !== "darwin") throw new PublicInstanceIdentityError(); + let held: HeldDirectory | undefined; + try { + try { + lstatSync(dataPath); + } catch (error) { + if ((error as NodeJS.ErrnoException).code !== "ENOENT") throw error; + const parentPath = dirname(dataPath); + if (realpathSync.native(parentPath) !== parentPath) throw new PublicInstanceIdentityError(); + const callerUid = process.getuid?.(); + if (callerUid === undefined) throw new PublicInstanceIdentityError(); + const acquiredParent = openRootNoFollow(parentPath, platform); + try { + try { + await assertPlatformAuthority(acquiredParent, platform, nativeConnectRootAuthorityInspector, callerUid); + } finally { + closeAcquiredAncestors(acquiredParent); + } + assertPrivateRoot(fstatSync(acquiredParent.root.fd), callerUid, platform); + try { + mkdirAt(acquiredParent.root.fd, basename(dataPath), 0o700); + } catch (mkdirError) { + if ((mkdirError as NodeJS.ErrnoException).code !== "EEXIST") throw mkdirError; + } + const createdFd = openAuthorityDirectoryNoFollow( + dataPath, + flags => acquiredParent.root.openChild(basename(dataPath), flags), + ); + try { + fchmodSync(createdFd, 0o700); + } finally { + closeSync(createdFd); + } + } finally { + closeSync(acquiredParent.root.fd); + } + } + if (realpathSync.native(dataPath) !== dataPath) throw new PublicInstanceIdentityError(); + const callerUid = process.getuid?.(); + if (callerUid === undefined) throw new PublicInstanceIdentityError(); + const acquired = openRootNoFollow(dataPath, platform); + held = acquired.root; + try { + await assertPlatformAuthority(acquired, platform, nativeConnectRootAuthorityInspector, callerUid); + } finally { + closeAcquiredAncestors(acquired); + } + assertPrivateData(fstatSync(held.fd), callerUid, platform); + const directory: PinnedPublicIdentityDirectory = { + fd: held.fd, + ownerUid: callerUid, + open: (name, flags, mode = 0) => held!.openChild(name, flags, mode), + identify: (name) => identifyHeldChild(held!, platform, name), + validateEntry: async (name, fd) => { + if (platform === "darwin") { + await authorityEntry(nativeConnectRootAuthorityInspector, platform, join(dataPath, name), "env", fd); + } + }, + publishNoReplace: (oldName, newName) => renameAt(held!.fd, oldName, newName), + unlink: (name) => unlinkAt(held!.fd, name), + }; + const identity = await getOrCreatePublicInstanceIdentityPinned(directory, { generate, role: "host" }); + const named = lstatSync(dataPath); + const pinned = fstatSync(held.fd); + if (named.isSymbolicLink() || !sameIdentity(named, pinned)) throw new PublicInstanceIdentityError(); + assertPrivateData(pinned, callerUid, platform); + return identity; + } catch (error) { + if (error instanceof PublicInstanceIdentityError) throw error; + throw new PublicInstanceIdentityError(); + } finally { + if (held !== undefined) closeSync(held.fd); + } +} + +export async function getOrCreateSnapshotPublicInstanceIdentity( + directory: PinnedPublicIdentityDirectory, + generate: () => string = randomUUID, +): Promise { + try { + return await getOrCreatePublicInstanceIdentityPinned(directory, { generate, role: "host" }); + } catch (error) { + if (error instanceof WindowsAuthorityInspectionError) throw error; + if (error instanceof PublicInstanceIdentityError) throw error; + throw new PublicInstanceIdentityError(); + } +} + +export async function readSnapshotPublicInstanceIdentity( + directory: PinnedPublicIdentityDirectory, +): Promise { + try { + return await readPublicInstanceIdentityPinned(directory); + } catch (error) { + if (error instanceof WindowsAuthorityInspectionError) throw error; + if (error instanceof PublicInstanceIdentityError) throw error; + throw new PublicInstanceIdentityError(); + } +} diff --git a/packages/cli/src/connectRootAuthority.test.ts b/packages/cli/src/connectRootAuthority.test.ts new file mode 100644 index 000000000..7839adbaf --- /dev/null +++ b/packages/cli/src/connectRootAuthority.test.ts @@ -0,0 +1,498 @@ +import assert from "node:assert/strict"; +import { closeSync, mkdtempSync, openSync, rmSync, writeFileSync } from "node:fs"; +import { tmpdir } from "node:os"; +import { join } from "node:path"; +import { test } from "node:test"; +import { + assertNativeWindowsEntriesAuthority, + assertSafeWindowsAuthority, + assertWindowsInspectionShape, + isConnectAuthorityBrokerModeSafe, + parseWindowsInspectionDocument, + stableAuthorityIdentity, + WindowsAuthorityInspectionError, + WindowsAuthorityPolicyError, + type ConnectRootAuthorityInspector, + type WindowsAuthorityInspection, +} from "./connectRootAuthority.js"; +import { + parseWindowsNativeProbeOutput, + WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS, + WINDOWS_INSPECTION_SOURCE, + WINDOWS_INSPECTION_TIMEOUT_MS, + WINDOWS_INSPECTOR_CREATES_CHILD_PROCESSES, + WINDOWS_INSPECTOR_TRANSPORT, + WINDOWS_INSPECTOR_WRITES_FILESYSTEM, + WINDOWS_NATIVE_TIMING_PROBE_SOURCE, + WINDOWS_NATIVE_TIMING_PROBE_TIMEOUT_MS, + WINDOWS_NATIVE_STAGE_CODES, + WINDOWS_UINT64_COMPOSER_SOURCE, + WINDOWS_UNSIGNED_FIELD_DECODER_SOURCE, + windowsBrokerFailureStage, + windowsInspectionTimeoutForElapsed, + WindowsNativeStageError, + windowsNativeTimingBucket, + windowsPowerShellEnvironment, +} from "./connectWindowsAuthority.js"; + +const USER = "S-1-5-21-100-200-300-1001"; +const SYSTEM = "S-1-5-18"; +const ADMINISTRATORS = "S-1-5-32-544"; + +test("unpackaged Connect authority brokers reject group/other-writable modes", () => { + assert.equal(isConnectAuthorityBrokerModeSafe(0o644n, false), true); + assert.equal(isConnectAuthorityBrokerModeSafe(0o755n, false), true); + assert.equal(isConnectAuthorityBrokerModeSafe(0o775n, false), false); + assert.equal(isConnectAuthorityBrokerModeSafe(0o757n, false), false); + assert.equal(isConnectAuthorityBrokerModeSafe(0o644n, true), false); + assert.equal(isConnectAuthorityBrokerModeSafe(0o755n, true), true); + assert.equal(isConnectAuthorityBrokerModeSafe(0o775n, true), false); +}); + +function inspection(overrides: Partial = {}): WindowsAuthorityInspection { + return { + index: 0, + kind: "directory", + authorityKind: "root", + currentUserSid: USER, + ownerSid: USER, + daclProtected: true, + reparsePoint: false, + volumeSerialNumber: "1", + fileId: "2", + verifiedVolumeSerialNumber: "1", + verifiedFileId: "2", + rules: [ + { identitySid: USER, inherited: false, accessType: "allow", appliesToSelf: true, rights: "2032127" }, + { identitySid: SYSTEM, inherited: false, accessType: "allow", appliesToSelf: true, rights: "2032127" }, + { identitySid: ADMINISTRATORS, inherited: false, accessType: "allow", appliesToSelf: true, rights: "2032127" }, + ], + ...overrides, + }; +} + +function policyFailure( + value: WindowsAuthorityInspection, + kind: Parameters[1], + reason: string, +): void { + assert.throws( + () => assertSafeWindowsAuthority(value, kind), + (error) => error instanceof WindowsAuthorityPolicyError && error.policyReason === reason, + ); +} + +test("Windows protected entries allow only explicit trusted mutation authority", () => { + assert.doesNotThrow(() => assertSafeWindowsAuthority(inspection(), "root")); + policyFailure(inspection({ + rules: [{ identitySid: "S-1-1-0", inherited: false, accessType: "allow", appliesToSelf: true, rights: "2" }], + }), "root", "BROAD_WRITE"); + policyFailure(inspection({ + rules: [{ identitySid: USER, inherited: true, accessType: "allow", appliesToSelf: true, rights: "2" }], + }), "root", "INHERITED_WRITE"); + policyFailure(inspection({ daclProtected: false }), "data", "DACL_NOT_PROTECTED"); + policyFailure(inspection({ ownerSid: SYSTEM }), "env", "OWNER_MISMATCH"); + policyFailure(inspection({ reparsePoint: true }), "root", "REPARSE_POINT"); + policyFailure(inspection({ + rules: [{ identitySid: USER, inherited: false, accessType: "deny", appliesToSelf: true, rights: "4294967295" }], + }), "root", "UNKNOWN_RIGHTS"); +}); + +test("Windows ancestors narrowly allow OS ownership and inherited traversal", () => { + assert.doesNotThrow(() => assertSafeWindowsAuthority(inspection({ + authorityKind: "ancestor", + ownerSid: SYSTEM, + daclProtected: false, + rules: [{ identitySid: "S-1-5-32-545", inherited: true, accessType: "allow", appliesToSelf: true, rights: "1179785" }], + }), "ancestor")); + assert.doesNotThrow(() => assertSafeWindowsAuthority(inspection({ + authorityKind: "home", + ownerSid: ADMINISTRATORS, + daclProtected: false, + rules: [{ identitySid: USER, inherited: true, accessType: "allow", appliesToSelf: true, rights: "2032127" }], + }), "home")); + policyFailure(inspection({ + authorityKind: "ancestor", + ownerSid: SYSTEM, + daclProtected: false, + rules: [{ identitySid: "S-1-5-32-545", inherited: true, accessType: "allow", appliesToSelf: true, rights: "2" }], + }), "ancestor", "BROAD_WRITE"); + policyFailure(inspection({ authorityKind: "ancestor", ownerSid: "S-1-5-80-123" }), "ancestor", "OWNER_MISMATCH"); +}); + +test("Windows broker JSON is canonical, exact-keyed, and bounded", () => { + const valid = JSON.stringify({ version: 1, entries: [inspection()] }); + assert.deepEqual(parseWindowsInspectionDocument(valid), [inspection()]); + assertWindowsInspectionShape(parseWindowsInspectionDocument(valid)[0]); + const stageFailure = (document: string, stage: string): void => assert.throws( + () => parseWindowsInspectionDocument(document), + (error) => error instanceof WindowsNativeStageError && error.stage === stage, + ); + stageFailure("{", "parent:json-parse"); + stageFailure(`${valid}\n`, "parent:json-canonical"); + stageFailure(`{"version":1,"version":1,"entries":[]}`, "parent:json-canonical"); + for (const malformed of [ + "[]", + JSON.stringify({ version: 1, entries: [], extra: true }), + JSON.stringify({ version: 2, entries: [] }), + JSON.stringify({ version: 1, entries: {} }), + JSON.stringify({ version: 1, entries: Array.from({ length: 33 }, () => inspection()) }), + ]) stageFailure(malformed, "parent:document-shape"); + assert.throws( + () => parseWindowsInspectionDocument("x".repeat(128 * 1024 + 1)), + (error) => error instanceof WindowsNativeStageError && error.stage === "parent:utf8", + ); + assert.throws(() => assertWindowsInspectionShape({ ...inspection(), extra: true })); + assert.throws(() => assertWindowsInspectionShape({ ...inspection(), rules: [ + { identitySid: USER, inherited: false, accessType: "audit", appliesToSelf: true, rights: "1" }, + ] })); +}); + +test("Windows native timing milestones are strict, ordered, bounded, and redacted", () => { + const valid = [ + "PROPR_NATIVE_PROBE_V1|entry-ps51-desktop-x64|under-5s", + "PROPR_NATIVE_PROBE_V1|constant-json|under-5s", + "PROPR_NATIVE_PROBE_V1|reflection-emit|5-to-15s", + "PROPR_NATIVE_PROBE_V1|harmless-win32|5-to-15s", + "PROPR_NATIVE_PROBE_V1|standard-handle-identity|15-to-30s", + "", + ].join("\r\n"); + assert.deepEqual(parseWindowsNativeProbeOutput(valid), [ + { milestone: "entry-ps51-desktop-x64", timingBucket: "under-5s" }, + { milestone: "constant-json", timingBucket: "under-5s" }, + { milestone: "reflection-emit", timingBucket: "5-to-15s" }, + { milestone: "harmless-win32", timingBucket: "5-to-15s" }, + { milestone: "standard-handle-identity", timingBucket: "15-to-30s" }, + ]); + assert.deepEqual(parseWindowsNativeProbeOutput(valid.split("\r\n").slice(0, 3).join("\r\n") + "\r\n"), [ + { milestone: "entry-ps51-desktop-x64", timingBucket: "under-5s" }, + { milestone: "constant-json", timingBucket: "under-5s" }, + { milestone: "reflection-emit", timingBucket: "5-to-15s" }, + ]); + assert.deepEqual(parseWindowsNativeProbeOutput( + "PROPR_NATIVE_PROBE_V1|entry-ps51-desktop-x64|under-5s\r\npartial-SENTINEL", + true, + ), [{ milestone: "entry-ps51-desktop-x64", timingBucket: "under-5s" }]); + for (const hostile of [ + "PROPR_NATIVE_PROBE_V1|constant-json|under-5s\r\n", + "PROPR_NATIVE_PROBE_V1|entry-ps51-desktop-x64|arbitrary-12345ms\r\n", + "C:\\private-path-SENTINEL S-1-5-21-999 raw-error-SENTINEL\r\n", + "PROPR_NATIVE_PROBE_V1|entry-ps51-desktop-x64|under-5s", + "x".repeat(2 * 1024 + 1), + ]) assert.throws( + () => parseWindowsNativeProbeOutput(hostile), + (error) => error instanceof WindowsNativeStageError + && error.stage === "probe:output" + && !error.message.includes("SENTINEL"), + ); +}); + +test("Windows native timing uses only coarse fixed buckets", () => { + assert.deepEqual([ + 0, 4_999, 5_000, 14_999, 15_000, 29_999, 30_000, 44_999, 45_000, 59_999, 60_000, + ].map(windowsNativeTimingBucket), [ + "under-5s", "under-5s", "5-to-15s", "5-to-15s", "15-to-30s", "15-to-30s", + "30-to-45s", "30-to-45s", "45-to-60s", "45-to-60s", "at-least-60s", + ]); + assert.throws(() => windowsNativeTimingBucket(Number.NaN), WindowsNativeStageError); +}); + +test("Windows production inspection has one cold-start deadline and a cumulative batch cap", () => { + assert.equal(WINDOWS_INSPECTION_TIMEOUT_MS, 60_000); + assert.equal(WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS, 240_000); + assert.equal(WINDOWS_NATIVE_TIMING_PROBE_TIMEOUT_MS, 60_000); + assert.equal(WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS, 4 * WINDOWS_INSPECTION_TIMEOUT_MS); + assert.notEqual( + WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS / WINDOWS_INSPECTION_TIMEOUT_MS, + 32, + ); + assert.equal(windowsInspectionTimeoutForElapsed(0), 60_000); + assert.equal(windowsInspectionTimeoutForElapsed(60_000), 60_000); + assert.equal(windowsInspectionTimeoutForElapsed(120_000), 60_000); + assert.equal(windowsInspectionTimeoutForElapsed(180_000), 60_000); + assert.equal(windowsInspectionTimeoutForElapsed(180_001), 59_999); + assert.equal(windowsInspectionTimeoutForElapsed(210_000), 30_000); + assert.equal(windowsInspectionTimeoutForElapsed(225_000), 15_000); + assert.equal(windowsInspectionTimeoutForElapsed(239_999.9), 1); + assert.throws( + () => windowsInspectionTimeoutForElapsed(240_000), + (error) => error instanceof WindowsNativeStageError && error.stage === "spawn:cumulative-timeout", + ); + assert.throws( + () => windowsInspectionTimeoutForElapsed(240_001), + (error) => error instanceof WindowsNativeStageError && error.stage === "spawn:cumulative-timeout", + ); +}); + +test("Windows production isolates entry fields and retains private handle lifetime", () => { + assert.ok(WINDOWS_NATIVE_STAGE_CODES.includes("broker:fd-duplicate")); + assert.ok(WINDOWS_NATIVE_STAGE_CODES.includes("broker:index-info-initial")); + assert.ok(WINDOWS_NATIVE_STAGE_CODES.includes("broker:current-user-sid")); + assert.ok(WINDOWS_NATIVE_STAGE_CODES.includes("broker:index-info-revalidation")); + assert.ok(WINDOWS_NATIVE_STAGE_CODES.includes("broker:index-info-decode")); + assert.ok(WINDOWS_NATIVE_STAGE_CODES.includes("broker:index-info-compose")); + assert.ok(WINDOWS_NATIVE_STAGE_CODES.includes("broker:entry-format")); + assert.ok(WINDOWS_NATIVE_STAGE_CODES.includes("broker:entry-flags")); + assert.ok(WINDOWS_NATIVE_STAGE_CODES.includes("broker:entry-rules")); + assert.ok(WINDOWS_NATIVE_STAGE_CODES.includes("broker:entry-build")); + assert.equal((WINDOWS_NATIVE_STAGE_CODES as readonly string[]).includes("broker:index-info"), false); + assert.equal(windowsBrokerFailureStage(79), "broker:index-info-revalidation"); + assert.equal(windowsBrokerFailureStage(81), "broker:index-info-decode"); + assert.equal(windowsBrokerFailureStage(82), "broker:index-info-compose"); + assert.equal(windowsBrokerFailureStage(83), "broker:entry-build"); + assert.equal(windowsBrokerFailureStage(84), "broker:entry-format"); + assert.equal(windowsBrokerFailureStage(85), "broker:entry-flags"); + assert.equal(windowsBrokerFailureStage(86), "broker:entry-rules"); + + const duplicate = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=80"); + const initial = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=74"); + const sid = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=78"); + const revalidation = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=79"); + const decode = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=81", revalidation); + const compose = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=82", decode); + const entryFormat = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=84", compose); + const entryFlags = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=85", entryFormat); + const entryRules = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=86", entryFlags); + const entryBuild = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=83", entryRules); + const json = WINDOWS_INSPECTION_SOURCE.indexOf("$stage=77", entryBuild); + assert.ok(duplicate >= 0 && duplicate < initial && initial < sid && sid < revalidation + && revalidation < decode && decode < compose && compose < entryFormat + && entryFormat < entryFlags && entryFlags < entryRules && entryRules < entryBuild + && entryBuild < json); + assert.match(WINDOWS_INSPECTION_SOURCE.slice(duplicate, initial), + /DuplicateHandle\(\s*\[ProprReadOnlyAuthority\]::GetCurrentProcess\(\),\$originalHandle,\s*\[ProprReadOnlyAuthority\]::GetCurrentProcess\(\),\[ref\]\$privateHandle,0,\$false,2\)\)\{exit \$stage\}/); + assert.match(WINDOWS_INSPECTION_SOURCE.slice(initial, sid), + /^\$stage=74\n \$before=.*AllocHGlobal\(52\)\n if\(-not .*GetFileInformationByHandle\(\$privateHandle,\$before\)\)\{exit \$stage\}\n $/s); + assert.match(WINDOWS_INSPECTION_SOURCE.slice(sid, WINDOWS_INSPECTION_SOURCE.indexOf("$stage=75", sid)), + /^\$stage=78\n \$current=.*WindowsIdentity\]::GetCurrent\(\)\.User\n if\(\$null-eq \$current\)\{exit \$stage\}\n \$currentSid=\$current\.Value\n $/s); + assert.match(WINDOWS_INSPECTION_SOURCE.slice(revalidation, decode), + /^\$stage=79\n \$after=.*AllocHGlobal\(52\)\n if\(-not .*GetFileInformationByHandle\(\$privateHandle,\$after\)\)\{exit \$stage\}\n $/s); + const decodedIdentity = WINDOWS_INSPECTION_SOURCE.slice(decode, compose); + assert.match(decodedIdentity, /^\$stage=81\n \$beforeVolume=/); + for (const [field, structure, offset] of [ + ["beforeVolume", "before", 28], ["afterVolume", "after", 28], + ["beforeHigh", "before", 44], ["beforeLow", "before", 48], + ["afterHigh", "after", 44], ["afterLow", "after", 48], + ] as const) { + assert.match(decodedIdentity, new RegExp(`\\$${field}=Read-ProprUInt32 \\$${structure} ${offset}`)); + } + assert.equal(WINDOWS_INSPECTION_SOURCE.match(/function Read-ProprUInt32/g)?.length, 1); + assert.equal(WINDOWS_INSPECTION_SOURCE.match(/Read-ProprUInt32 \$(?:before|after) (?:28|44|48)/g)?.length, 6); + assert.match(decodedIdentity, + /\$afterHigh=Read-ProprUInt32 \$after 44;\$afterLow=Read-ProprUInt32 \$after 48\n $/); + assert.doesNotMatch(WINDOWS_INSPECTION_SOURCE, + /\[uint32\]\[Runtime\.InteropServices\.Marshal\]::ReadInt32/); + assert.match(WINDOWS_UNSIGNED_FIELD_DECODER_SOURCE, + /if\(-not \[BitConverter\]::IsLittleEndian\)\{exit \$stage\}\n \$signed=\[int32\]\[Runtime\.InteropServices\.Marshal\]::ReadInt32\(\$pointer,\$offset\)\n \$bytes=\[BitConverter\]::GetBytes\(\$signed\)\n \[BitConverter\]::ToUInt32\(\$bytes,0\)/); + const composedIdentity = WINDOWS_INSPECTION_SOURCE.slice( + compose, entryFormat, + ); + assert.match(composedIdentity, + /^\$stage=82\n \$beforeId=Join-ProprUInt64 \$beforeLow \$beforeHigh\n if\(\$beforeId-isnot \[uint64\]\)\{exit \$stage\}\n \$afterId=Join-ProprUInt64 \$afterLow \$afterHigh\n if\(\$afterId-isnot \[uint64\]\)\{exit \$stage\}\n $/); + const formattedIdentity = WINDOWS_INSPECTION_SOURCE.slice(entryFormat, entryFlags); + assert.equal(formattedIdentity, [ + "$stage=84", + " $beforeVolumeDecimal=$beforeVolume.ToString([Globalization.CultureInfo]::InvariantCulture)", + " $afterVolumeDecimal=$afterVolume.ToString([Globalization.CultureInfo]::InvariantCulture)", + " $beforeIdDecimal=$beforeId.ToString([Globalization.CultureInfo]::InvariantCulture)", + " $afterIdDecimal=$afterId.ToString([Globalization.CultureInfo]::InvariantCulture)", + " if($beforeVolumeDecimal-isnot [string]-or $beforeVolumeDecimal.Length-eq 0-or $beforeVolumeDecimal.Length-gt 10-or $beforeVolumeDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage}", + " if($afterVolumeDecimal-isnot [string]-or $afterVolumeDecimal.Length-eq 0-or $afterVolumeDecimal.Length-gt 10-or $afterVolumeDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage}", + " if($beforeIdDecimal-isnot [string]-or $beforeIdDecimal.Length-eq 0-or $beforeIdDecimal.Length-gt 20-or $beforeIdDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage}", + " if($afterIdDecimal-isnot [string]-or $afterIdDecimal.Length-eq 0-or $afterIdDecimal.Length-gt 20-or $afterIdDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage}", + " ", + ].join("\n")); + assert.equal(formattedIdentity.match(/\.ToString\(\[Globalization\.CultureInfo\]::InvariantCulture\)/g)?.length, 4); + assert.doesNotMatch(formattedIdentity, /\$entry=|Console|Write-|Out\./); + const entryFlagValidation = WINDOWS_INSPECTION_SOURCE.slice(entryFlags, entryRules); + assert.equal(entryFlagValidation, [ + "$stage=85", + " $daclProtected=[bool](($control-band 0x1000)-ne 0)", + " $reparsePoint=[bool](([Runtime.InteropServices.Marshal]::ReadInt32($before,0)-band 0x400)-ne 0)", + " if($daclProtected-isnot [bool]-or $reparsePoint-isnot [bool]){exit $stage}", + " ", + ].join("\n")); + assert.doesNotMatch(entryFlagValidation, /Console|Write-|Out\./); + const entryRuleValidation = WINDOWS_INSPECTION_SOURCE.slice(entryRules, entryBuild); + assert.equal(entryRuleValidation, [ + "$stage=86", + " [object[]]$rulesArray=$rules.ToArray()", + " if($rulesArray-isnot [object[]]-or $rulesArray.Count-ne $rules.Count-or $rulesArray.Count-gt 128){exit $stage}", + " for($ruleIndex=0;$ruleIndex-lt $rulesArray.Count;$ruleIndex++){", + " if(-not [object]::ReferenceEquals($rulesArray[$ruleIndex],$rules[$ruleIndex])){exit $stage}", + " }", + " ", + ].join("\n")); + assert.equal(WINDOWS_INSPECTION_SOURCE.match(/\[object\[\]\]\$rulesArray=\$rules\.ToArray\(\)/g)?.length, 1); + assert.doesNotMatch(WINDOWS_INSPECTION_SOURCE, /@\(\s*\$rules\s*\)/); + assert.doesNotMatch(entryRuleValidation, /ConvertTo-Json|\.ToString|Console|Write-|Out\./); + const entryConstruction = WINDOWS_INSPECTION_SOURCE.slice(entryBuild, json); + assert.equal(entryConstruction, [ + "$stage=83", + " $entry=[pscustomobject][ordered]@{", + " index=__PROPR_INDEX__;kind='__PROPR_ENTRY_KIND__';authorityKind='__PROPR_AUTHORITY_KIND__';currentUserSid=$currentSid;ownerSid=$ownerSid", + " daclProtected=$daclProtected;reparsePoint=$reparsePoint", + " volumeSerialNumber=$beforeVolumeDecimal", + " fileId=$beforeIdDecimal", + " verifiedVolumeSerialNumber=$afterVolumeDecimal", + " verifiedFileId=$afterIdDecimal;rules=$rulesArray", + " }", + " ", + ].join("\n")); + assert.doesNotMatch(entryConstruction, + /Marshal|\.ToString|InvariantCulture|@\(\$rules\)|ReferenceEquals|-band|\bfor\s*\(/); + assert.doesNotMatch(composedIdentity, /ToString|\$entry=/); + assert.doesNotMatch(WINDOWS_INSPECTION_SOURCE, /4294967296|\[uint64\]\$(?:before|after)High\*/); + assert.match(WINDOWS_UINT64_COMPOSER_SOURCE, + /function Join-ProprUInt64\(\[uint32\]\$low,\[uint32\]\$high\)\{\n if\(-not \[BitConverter\]::IsLittleEndian\)\{exit \$stage\}\n \$bytes=New-Object byte\[\] 8\n \[Array\]::Copy\(\[BitConverter\]::GetBytes\(\[uint32\]\$low\),0,\$bytes,0,4\)\n \[Array\]::Copy\(\[BitConverter\]::GetBytes\(\[uint32\]\$high\),0,\$bytes,4,4\)\n \[BitConverter\]::ToUInt64\(\$bytes,0\)\n\}/); + const unsignedDecimal = (value: number): string => { + const bytes = Buffer.alloc(4); + bytes.writeInt32LE(value, 0); + return bytes.readUInt32LE(0).toString(10); + }; + const highBit = unsignedDecimal(-2_147_483_648); + const allBits = unsignedDecimal(-1); + assert.equal(highBit, "2147483648"); + assert.equal(allBits, "4294967295"); + const composedDecimal = (low: number, high: number): string => { + const bytes = Buffer.alloc(8); + bytes.writeUInt32LE(low, 0); + bytes.writeUInt32LE(high, 4); + return bytes.readBigUInt64LE(0).toString(10); + }; + const highBitFileId = composedDecimal(Number(allBits), Number(highBit)); + const allBitsFileId = composedDecimal(Number(allBits), Number(allBits)); + assert.equal(highBitFileId, "9223372041149743103"); + assert.equal(allBitsFileId, "18446744073709551615"); + assert.match(JSON.stringify({ highBit, allBits, highBitFileId, allBitsFileId }), + /^\{"highBit":"\d+","allBits":"\d+","highBitFileId":"\d+","allBitsFileId":"\d+"\}$/); + assert.match(WINDOWS_INSPECTION_SOURCE, + /GetSecurityInfo\(\$privateHandle,1,5,\[ref\]\$owner,\[ref\]\$group,\[ref\]\$dacl,\[ref\]\$sacl,\[ref\]\$descriptor\)/); + assert.equal(WINDOWS_INSPECTION_SOURCE.match(/::CloseHandle\(\$privateHandle\)/g)?.length, 1); + assert.match(WINDOWS_INSPECTION_SOURCE, + /finally \{if\(\$privateHandleOwned\)\{\$null=\[ProprReadOnlyAuthority\]::CloseHandle\(\$privateHandle\)\}\}/); + assert.doesNotMatch(WINDOWS_INSPECTION_SOURCE, /CloseHandle\(\$originalHandle\)/); + assert.doesNotMatch(WINDOWS_INSPECTION_SOURCE.slice(initial), /\$originalHandle/); +}); + +test("Windows PowerShell boundary retains a derived minimal environment and no filesystem writes", () => { + assert.deepEqual(windowsPowerShellEnvironment("C:\\Windows"), { + SystemRoot: "C:\\Windows", + WINDIR: "C:\\Windows", + }); + assert.throws(() => windowsPowerShellEnvironment("relative\\Windows"), WindowsNativeStageError); + for (const forbidden of [ + "PATH", "PATHEXT", "PSModulePath", "TEMP", "TMP", "USERPROFILE", "HOMEDRIVE", "HOMEPATH", + ]) assert.equal(forbidden in windowsPowerShellEnvironment("C:\\Windows"), false); + assert.equal(WINDOWS_INSPECTOR_CREATES_CHILD_PROCESSES, false); + assert.equal(WINDOWS_INSPECTOR_WRITES_FILESYSTEM, false); + assert.equal(WINDOWS_INSPECTOR_TRANSPORT, "inherited-standard-handle"); + for (const source of [WINDOWS_INSPECTION_SOURCE, WINDOWS_NATIVE_TIMING_PROBE_SOURCE]) { + assert.doesNotMatch(source, /Add-Type|Start-Process|Set-Content|Out-File|New-Item|Remove-Item|Invoke-Expression/i); + } +}); + +test("Windows timing probe isolates baseline, Reflection.Emit, Win32, and standard-handle identity", () => { + const milestones = [ + "Write-ProprMilestone 'entry-ps51-desktop-x64'", + "Write-ProprMilestone 'constant-json'", + "Write-ProprMilestone 'reflection-emit'", + "Write-ProprMilestone 'harmless-win32'", + "Write-ProprMilestone 'standard-handle-identity'", + ].map((token) => WINDOWS_NATIVE_TIMING_PROBE_SOURCE.indexOf(token)); + assert.ok(milestones.every((offset) => offset >= 0)); + assert.deepEqual([...milestones].sort((left, right) => left - right), milestones); + assert.ok(milestones[1] < WINDOWS_NATIVE_TIMING_PROBE_SOURCE.indexOf("DefineDynamicAssembly")); + assert.ok(milestones[2] < WINDOWS_NATIVE_TIMING_PROBE_SOURCE.indexOf("::GetCurrentProcessId()")); + assert.ok(milestones[3] < WINDOWS_NATIVE_TIMING_PROBE_SOURCE.indexOf("::GetStdHandle(-10)")); + assert.ok(WINDOWS_NATIVE_TIMING_PROBE_SOURCE.indexOf("::GetFileInformationByHandle") < milestones[4]); + const populated = WINDOWS_NATIVE_TIMING_PROBE_SOURCE.indexOf("GetFileInformationByHandle($handle,$info)"); + const probeDecode = WINDOWS_NATIVE_TIMING_PROBE_SOURCE.indexOf("Read-ProprUInt32 $info", populated); + const probeCompose = WINDOWS_NATIVE_TIMING_PROBE_SOURCE.indexOf( + "Join-ProprUInt64 $probeLow $probeHigh", probeDecode, + ); + const probeFormat = WINDOWS_NATIVE_TIMING_PROBE_SOURCE.indexOf("$probeVolumeDecimal=", probeCompose); + assert.ok(populated >= 0 && populated < probeDecode && probeDecode < probeCompose + && probeCompose < probeFormat && probeFormat < milestones[4]); + assert.equal(WINDOWS_NATIVE_TIMING_PROBE_SOURCE.match(/function Read-ProprUInt32/g)?.length, 1); + assert.equal(WINDOWS_NATIVE_TIMING_PROBE_SOURCE.match(/Read-ProprUInt32 \$info (?:28|44|48)/g)?.length, 3); + assert.match(WINDOWS_NATIVE_TIMING_PROBE_SOURCE.slice(probeCompose, probeFormat), + /^Join-ProprUInt64 \$probeLow \$probeHigh\n if\(\$probeId-isnot \[uint64\]\)\{exit \$stage\}\n $/); + assert.equal(WINDOWS_NATIVE_TIMING_PROBE_SOURCE.slice(probeFormat, milestones[4]), [ + "$probeVolumeDecimal=$probeVolume.ToString([Globalization.CultureInfo]::InvariantCulture)", + " $probeIdDecimal=$probeId.ToString([Globalization.CultureInfo]::InvariantCulture)", + " if($probeVolumeDecimal-isnot [string]-or $probeVolumeDecimal.Length-eq 0-or $probeVolumeDecimal.Length-gt 10-or $probeVolumeDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage}", + " if($probeIdDecimal-isnot [string]-or $probeIdDecimal.Length-eq 0-or $probeIdDecimal.Length-gt 20-or $probeIdDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage}", + " ", + ].join("\n")); +}); + +test("Windows batch results remain bound to descriptor index, kind, identity, and user", async () => { + const directory = mkdtempSync(join(tmpdir(), "propr-windows-authority-test-")); + const firstPath = join(directory, "first"); + const secondPath = join(directory, "second"); + writeFileSync(firstPath, "a"); + writeFileSync(secondPath, "b"); + const firstFd = openSync(firstPath, "r"); + const secondFd = openSync(secondPath, "r"); + const firstIdentity = stableAuthorityIdentity(firstFd); + const secondIdentity = stableAuthorityIdentity(secondFd); + const entries = [ + { path: firstPath, kind: "env" as const, pinnedFd: firstFd }, + { path: secondPath, kind: "env" as const, pinnedFd: secondFd }, + ]; + const validEntries = [firstIdentity, secondIdentity].map((identity, index) => inspection({ + index, + kind: "file", + authorityKind: "env", + volumeSerialNumber: identity.device, + verifiedVolumeSerialNumber: identity.device, + fileId: identity.file, + verifiedFileId: identity.file, + })); + const inspector = (results: readonly WindowsAuthorityInspection[]): ConnectRootAuthorityInspector => ({ + inspectDarwinAcl: () => { throw new Error("unused"); }, + inspectWindowsAcl: async () => { throw new Error("unused"); }, + inspectWindowsAcls: async () => results, + }); + const diagnosticSymbol = Symbol.for("propr.test.windowsNativeDiagnostic"); + const globals = globalThis as Record; + const originalDiagnostic = globals[diagnosticSymbol]; + const diagnosticStages: string[] = []; + globals[diagnosticSymbol] = (stage: string): void => { diagnosticStages.push(stage); }; + try { + await assertNativeWindowsEntriesAuthority(inspector(validEntries), entries); + const noEntries = parseWindowsInspectionDocument('{"version":1,"entries":[]}'); + await assert.rejects( + assertNativeWindowsEntriesAuthority(inspector(noEntries), entries), + WindowsAuthorityInspectionError, + ); + assert.equal(diagnosticStages.pop(), "parent:entry-count"); + const malformedEntries = parseWindowsInspectionDocument('{"version":1,"entries":[{},{}]}'); + await assert.rejects( + assertNativeWindowsEntriesAuthority( + inspector(malformedEntries as readonly WindowsAuthorityInspection[]), entries, + ), + WindowsAuthorityInspectionError, + ); + assert.equal(diagnosticStages.pop(), "parent:entry-shape"); + for (const bad of [ + [{ ...validEntries[0], index: 1 }, validEntries[1]], + [{ ...validEntries[0], kind: "directory" as const }, validEntries[1]], + [{ ...validEntries[0], authorityKind: "data" as const }, validEntries[1]], + [{ ...validEntries[0], fileId: (BigInt(validEntries[0].fileId) + 1n).toString() }, validEntries[1]], + [validEntries[0], { ...validEntries[1], currentUserSid: "S-1-5-21-9" }], + ]) { + await assert.rejects( + assertNativeWindowsEntriesAuthority(inspector(bad), entries), + WindowsAuthorityInspectionError, + ); + } + } finally { + if (originalDiagnostic === undefined) delete globals[diagnosticSymbol]; + else globals[diagnosticSymbol] = originalDiagnostic; + closeSync(firstFd); + closeSync(secondFd); + rmSync(directory, { recursive: true, force: true }); + } +}); diff --git a/packages/cli/src/connectRootAuthority.ts b/packages/cli/src/connectRootAuthority.ts new file mode 100644 index 000000000..0f21ab92e --- /dev/null +++ b/packages/cli/src/connectRootAuthority.ts @@ -0,0 +1,663 @@ +import { spawnSync } from "node:child_process"; +import { createHash, randomUUID } from "node:crypto"; +import { + chmodSync, + closeSync, + constants, + fchmodSync, + fsyncSync, + fstatSync, + lstatSync, + mkdtempSync, + openSync, + readSync, + rmSync, + writeSync, +} from "node:fs"; +import { tmpdir } from "node:os"; +import { dirname, join } from "node:path"; +import { fileURLToPath } from "node:url"; +import { + parseWindowsInspectionDocument, + reportWindowsNativeStage, + runWindowsReadOnlyInspection, + WindowsNativeStageError, + windowsInspectionEntryKind, +} from "./connectWindowsAuthority.js"; +import { + assertCanonicalNativeArtifactParents, + isPackagedNativeArtifactResolution, + physicalNativeArtifactCandidate, +} from "./utils/nativeArtifact.js"; + +const NATIVE_INSPECTION_MAX_BYTES = 128 * 1024; +const WINDOWS_SID = /^S-\d(?:-\d+)+$/; +const WINDOWS_TRUSTED_MUTATORS = new Set([ + "S-1-5-18", // NT AUTHORITY\\SYSTEM + "S-1-5-32-544", // BUILTIN\\Administrators +]); + +// FileSystemRights values which can alter an entry, its children, or its ACL. +const WINDOWS_MUTATING_RIGHTS = BigInt( + 0x00000002 // WriteData / CreateFiles + | 0x00000004 // AppendData / CreateDirectories + | 0x00000010 // WriteExtendedAttributes + | 0x00000040 // DeleteSubdirectoriesAndFiles + | 0x00000100 // WriteAttributes + | 0x00010000 // Delete + | 0x00040000 // ChangePermissions + | 0x00080000 // TakeOwnership +); +const WINDOWS_GENERIC_MUTATING_RIGHTS = 0x50000000n; // GENERIC_WRITE | GENERIC_ALL +const WINDOWS_KNOWN_ALLOW_RIGHTS = 0xf01f01ffn; +const WINDOWS_AUTHORITY_MAX_ENTRIES = 32; +const WINDOWS_AUTHORITY_MAX_ACES_PER_ENTRY = 128; +const WINDOWS_AUTHORITY_MAX_TOTAL_ACES = 512; + +export const WINDOWS_AUTHORITY_REQUIRED_CODE = "WINDOWS_AUTHORITY_REQUIRED" as const; + +/** + * Windows mutation/protection is intentionally deferred to #1997. Callers must + * surface this result; there is no package broker, service, elevation, or + * best-effort fallback in this discovery-only change. + */ +export class WindowsAuthorityRequiredError extends Error { + readonly code = WINDOWS_AUTHORITY_REQUIRED_CODE; + + constructor() { + super("Windows authority is required for this operation and is not available yet; use discovery-only status or retry after #1997 lands"); + this.name = "WindowsAuthorityRequiredError"; + } +} + +export type ConnectAuthorityEntryKind = "ancestor" | "home" | "root" | "data" | "env"; + +export interface WindowsAclRuleInspection { + readonly identitySid: string; + readonly inherited: boolean; + readonly accessType: "allow" | "deny"; + readonly appliesToSelf: boolean; + /** Canonical base-10 representation of the unsigned 32-bit access mask. */ + readonly rights: string; +} + +export interface WindowsAuthorityInspection { + readonly index: number; + readonly kind: "directory" | "file"; + readonly authorityKind: ConnectAuthorityEntryKind; + readonly currentUserSid: string; + readonly ownerSid: string; + readonly daclProtected: boolean; + readonly reparsePoint: boolean; + readonly volumeSerialNumber: string; + readonly fileId: string; + readonly verifiedVolumeSerialNumber: string; + readonly verifiedFileId: string; + readonly rules: readonly WindowsAclRuleInspection[]; +} + +export interface DarwinAuthorityInspection { + readonly version: 1; + readonly device: string; + readonly file: string; + readonly acl: string; +} + +export interface StableAuthorityIdentity { + readonly device: string; + readonly file: string; +} + +export interface WindowsAuthorityTarget { + readonly path: string; + readonly kind: ConnectAuthorityEntryKind; + readonly expectedIdentity: StableAuthorityIdentity; + readonly pinnedFd: number; +} + +export interface ConnectRootAuthorityInspector { + inspectDarwinAcl( + path: string, + pinnedFd: number, + expectedIdentity: StableAuthorityIdentity, + ): DarwinAuthorityInspection; + inspectWindowsAcl( + path: string, + expectedIdentity: StableAuthorityIdentity, + pinnedFd?: number, + kind?: ConnectAuthorityEntryKind, + ): Promise; + inspectWindowsAcls?(entries: readonly WindowsAuthorityTarget[]): Promise; +} + +export type WindowsAuthorityPolicyReason = + | "OWNER_MISMATCH" + | "DACL_NOT_PROTECTED" + | "REPARSE_POINT" + | "UNKNOWN_RIGHTS" + | "BROAD_WRITE" + | "INHERITED_WRITE"; + +/** Redacted policy diagnostic used by deterministic authority fixtures. */ +export class WindowsAuthorityPolicyError extends Error { + constructor( + readonly entryIndex: number, + readonly policyReason: WindowsAuthorityPolicyReason, + ) { + super(`Windows native authority rejected entry ${entryIndex}: ${policyReason}`); + this.name = "WindowsAuthorityPolicyError"; + } +} + +/** Fixed, redacted boundary for a failed read-only Windows ACL inspection. */ +export class WindowsAuthorityInspectionError extends Error { + constructor() { + super("Windows ACL authority inspection is unavailable"); + this.name = "WindowsAuthorityInspectionError"; + } +} + +export function stableAuthorityIdentity(fd: number): StableAuthorityIdentity { + const stat = fstatSync(fd, { bigint: true }); + return { device: stat.dev.toString(10), file: stat.ino.toString(10) }; +} + +function decodeBoundedUtf8(value: Buffer | string | null | undefined): string { + const bytes = typeof value === "string" ? Buffer.from(value, "utf8") : (value ?? Buffer.alloc(0)); + if (bytes.byteLength > NATIVE_INSPECTION_MAX_BYTES) throw new Error("native authority inspection exceeded its limit"); + return new TextDecoder("utf-8", { fatal: true }).decode(bytes); +} + +const DARWIN_AUTHORITY_BROKER_SHA256: Readonly> = { + arm64: "75fda2624bf093555e726b968401321fef61ea7ae0479f4c1892be0dfc6554c0", + x64: "e5a49be0db85655b9ff1d0614de9d61defd41a0a1b2eff8f11571407f10d809b", +}; + +/** Writable rejection is universal; execution is required only at the packaged source boundary. */ +export function isConnectAuthorityBrokerModeSafe(mode: bigint, packaged: boolean): boolean { + return (mode & 0o022n) === 0n && (!packaged || (mode & 0o111n) !== 0n); +} + +function readExactDescriptor(fd: number, size: number): Buffer { + if (!Number.isSafeInteger(size) || size <= 0 || size > 512 * 1024) { + throw new Error("packaged native authority broker failed integrity verification"); + } + const bytes = Buffer.allocUnsafe(size); + let offset = 0; + while (offset < size) { + const count = readSync(fd, bytes, offset, size - offset, offset); + if (count <= 0) throw new Error("packaged native authority broker failed integrity verification"); + offset += count; + } + return bytes; +} + +function darwinAuthorityBrokerArtifact(): { + path: string; + fd: number; + identity: StableAuthorityIdentity; + digest: string; + bytes: Buffer; +} { + const expected = DARWIN_AUTHORITY_BROKER_SHA256[process.arch]; + if (!expected) throw new Error(`native authority inspection is not packaged for darwin-${process.arch}`); + const moduleDirectory = dirname(fileURLToPath(import.meta.url)); + const relative = join("prebuilds", `darwin-${process.arch}`, "connect-authority-broker"); + const candidates = [ + join(moduleDirectory, "native", relative), + join(moduleDirectory, "..", "native", relative), + join(moduleDirectory, "..", "..", "native", relative), + ].map((logicalPath) => { + const path = physicalNativeArtifactCandidate(logicalPath); + return { path, packaged: isPackagedNativeArtifactResolution(logicalPath, path) }; + }); + for (const { path, packaged } of candidates) { + let fd: number | undefined; + try { + if (packaged) assertCanonicalNativeArtifactParents(path); + fd = openSync(path, constants.O_RDONLY | constants.O_NOFOLLOW); + const stat = fstatSync(fd, { bigint: true }); + const named = lstatSync(path, { bigint: true }); + if ( + !stat.isFile() + || named.isSymbolicLink() + || stat.dev !== named.dev + || stat.ino !== named.ino + || stat.size <= 0n + || stat.size > BigInt(512 * 1024) + || (typeof process.getuid === "function" && stat.uid !== 0n && stat.uid !== BigInt(process.getuid())) + || !isConnectAuthorityBrokerModeSafe(stat.mode, packaged) + ) { + closeSync(fd); + fd = undefined; + continue; + } + const bytes = readExactDescriptor(fd, Number(stat.size)); + const digest = createHash("sha256").update(bytes).digest("hex"); + if (digest !== expected) throw new Error("packaged native authority broker failed integrity verification"); + return { + path, + fd, + identity: { device: stat.dev.toString(10), file: stat.ino.toString(10) }, + digest, + bytes, + }; + } catch (error) { + if (fd !== undefined) closeSync(fd); + if ((error as NodeJS.ErrnoException).code !== "ENOENT") throw error; + } + } + throw new Error(`packaged native authority broker is missing for darwin-${process.arch}`); +} + +function revalidateDarwinAuthorityBroker( + artifact: { fd: number; identity: StableAuthorityIdentity; digest: string; bytes: Buffer }, +): void { + const stat = fstatSync(artifact.fd, { bigint: true }); + if ( + !stat.isFile() + || stat.dev.toString(10) !== artifact.identity.device + || stat.ino.toString(10) !== artifact.identity.file + || Number(stat.size) !== artifact.bytes.byteLength + || createHash("sha256").update(readExactDescriptor(artifact.fd, artifact.bytes.byteLength)).digest("hex") !== artifact.digest + ) throw new Error("packaged native authority broker was replaced"); +} + +function stageDarwinAuthorityBroker(artifact: ReturnType): { + path: string; + fd: number; + directory: string; +} { + const directory = mkdtempSync(join(tmpdir(), "propr-authority-capability-")); + try { + chmodSync(directory, 0o700); + const path = join(directory, `broker-${randomUUID()}`); + const writableFd = openSync(path, constants.O_CREAT | constants.O_EXCL | constants.O_RDWR, 0o500); + try { + let offset = 0; + while (offset < artifact.bytes.byteLength) { + const count = writeSync(writableFd, artifact.bytes, offset, artifact.bytes.byteLength - offset, offset); + if (count <= 0) throw new Error("Darwin ACL authority inspection is unavailable"); + offset += count; + } + fsyncSync(writableFd); + fchmodSync(writableFd, 0o500); + const staged = fstatSync(writableFd, { bigint: true }); + if (!staged.isFile() || staged.size !== BigInt(artifact.bytes.byteLength)) { + throw new Error("Darwin ACL authority inspection is unavailable"); + } + closeSync(writableFd); + const fd = openSync(path, constants.O_RDONLY | constants.O_NOFOLLOW); + const readable = fstatSync(fd, { bigint: true }); + if (readable.dev !== staged.dev || readable.ino !== staged.ino) { + closeSync(fd); + throw new Error("Darwin ACL authority inspection is unavailable"); + } + return { path, fd, directory }; + } catch (error) { + try { closeSync(writableFd); } catch { /* It was closed before the read-only reopen. */ } + throw error; + } + } catch (error) { + rmSync(directory, { recursive: true, force: true }); + throw error; + } +} + +function exactKeys(value: object, expected: readonly string[]): boolean { + return Object.keys(value).sort().join(",") === [...expected].sort().join(","); +} + +function canonicalUint64(value: unknown): value is string { + return typeof value === "string" + && /^(?:0|[1-9]\d{0,19})$/.test(value) + && BigInt(value) <= 0xffffffffffffffffn; +} + +function assertDarwinInspectionShape(value: unknown): asserts value is DarwinAuthorityInspection { + if ( + !value + || typeof value !== "object" + || Array.isArray(value) + || !exactKeys(value, ["version", "device", "file", "acl"]) + ) throw new Error("Darwin ACL authority inspection was malformed"); + const record = value as Record; + if ( + record.version !== 1 + || !canonicalUint64(record.device) + || !canonicalUint64(record.file) + || typeof record.acl !== "string" + || Buffer.byteLength(record.acl, "utf8") > 24 * 1024 + ) throw new Error("Darwin ACL authority inspection was malformed"); +} + +function nativeDarwinAcl( + _path: string, + pinnedFd: number, + _expectedIdentity: StableAuthorityIdentity, +): DarwinAuthorityInspection { + if (!Number.isInteger(pinnedFd) || pinnedFd < 0) throw new Error("Darwin ACL authority inspection is unavailable"); + const artifact = darwinAuthorityBrokerArtifact(); + let capability: ReturnType; + try { + capability = stageDarwinAuthorityBroker(artifact); + } catch (error) { + closeSync(artifact.fd); + throw error; + } + let result: ReturnType; + try { + result = spawnSync(capability.path, [], { + shell: false, + windowsHide: true, + encoding: "buffer", + env: {}, + timeout: 5000, + maxBuffer: NATIVE_INSPECTION_MAX_BYTES, + stdio: ["ignore", "pipe", "pipe", pinnedFd], + }); + const staged = fstatSync(capability.fd, { bigint: true }); + if ( + !staged.isFile() + || staged.size !== BigInt(artifact.bytes.byteLength) + || createHash("sha256").update(readExactDescriptor(capability.fd, artifact.bytes.byteLength)).digest("hex") !== artifact.digest + ) throw new Error("packaged native authority broker was replaced"); + revalidateDarwinAuthorityBroker(artifact); + } finally { + closeSync(capability.fd); + rmSync(capability.directory, { recursive: true, force: true }); + closeSync(artifact.fd); + } + if (result.status !== 0 || result.error || result.signal || decodeBoundedUtf8(result.stderr).length !== 0) { + throw new Error("Darwin ACL authority inspection is unavailable"); + } + let parsed: unknown; + try { + parsed = JSON.parse(decodeBoundedUtf8(result.stdout).trim()); + } catch { + throw new Error("Darwin ACL authority inspection was malformed"); + } + assertDarwinInspectionShape(parsed); + return parsed; +} + +async function nativeWindowsAcls( + entries: readonly WindowsAuthorityTarget[], +): Promise { + try { + return runWindowsReadOnlyInspection(entries); + } catch (error) { + if (error instanceof WindowsNativeStageError) reportWindowsNativeStage(error.stage); + throw new WindowsAuthorityInspectionError(); + } +} + +async function nativeWindowsAcl( + path: string, + expectedIdentity: StableAuthorityIdentity, + pinnedFd?: number, + kind: ConnectAuthorityEntryKind = "root", +): Promise { + if (pinnedFd === undefined) throw new WindowsAuthorityInspectionError(); + const inspections = await nativeWindowsAcls([{ path, expectedIdentity, pinnedFd, kind }]); + if (inspections.length !== 1) { + reportWindowsNativeStage("parent:entry-count"); + throw new WindowsAuthorityInspectionError(); + } + return inspections[0]; +} + +export const nativeConnectRootAuthorityInspector: ConnectRootAuthorityInspector = { + inspectDarwinAcl: nativeDarwinAcl, + inspectWindowsAcl: nativeWindowsAcl, + inspectWindowsAcls: nativeWindowsAcls, +}; + +/** Windows mutation is unsupported until the separately reviewed authority work lands. */ +export async function protectWindowsSetupEntry(_path: string, _kind: "directory" | "file"): Promise { + if (process.platform === "win32") throw new WindowsAuthorityRequiredError(); +} + +/** Windows mutation is unsupported until the separately reviewed authority work lands. */ +export async function protectWindowsSetupEntries( + entries: readonly { readonly path: string; readonly kind: "directory" | "file" }[], +): Promise { + if (process.platform === "win32" && entries.length > 0) throw new WindowsAuthorityRequiredError(); +} + +export function assertWindowsInspectionShape(value: unknown): asserts value is WindowsAuthorityInspection { + if ( + !value + || typeof value !== "object" + || Array.isArray(value) + || !exactKeys(value, [ + "index", "kind", "authorityKind", "currentUserSid", "ownerSid", "daclProtected", "reparsePoint", + "volumeSerialNumber", "fileId", "verifiedVolumeSerialNumber", "verifiedFileId", "rules", + ]) + ) throw new Error("Windows ACL authority inspection was malformed"); + const record = value as Record; + if ( + !Number.isInteger(record.index) + || (record.index as number) < 0 + || (record.index as number) >= WINDOWS_AUTHORITY_MAX_ENTRIES + || (record.kind !== "directory" && record.kind !== "file") + || !["ancestor", "home", "root", "data", "env"].includes(record.authorityKind as string) + || typeof record.currentUserSid !== "string" || !WINDOWS_SID.test(record.currentUserSid) + || typeof record.ownerSid !== "string" || !WINDOWS_SID.test(record.ownerSid) + || typeof record.daclProtected !== "boolean" + || typeof record.reparsePoint !== "boolean" + || !canonicalUint64(record.volumeSerialNumber) + || typeof record.fileId !== "string" || !/^(?:0|[1-9]\d{0,38})$/.test(record.fileId) + || BigInt(record.fileId) > 0xffffffffffffffffffffffffffffffffn + || !canonicalUint64(record.verifiedVolumeSerialNumber) + || typeof record.verifiedFileId !== "string" || !/^(?:0|[1-9]\d{0,38})$/.test(record.verifiedFileId) + || BigInt(record.verifiedFileId) > 0xffffffffffffffffffffffffffffffffn + || !Array.isArray(record.rules) || record.rules.length > WINDOWS_AUTHORITY_MAX_ACES_PER_ENTRY + ) throw new Error("Windows ACL authority inspection was malformed"); + for (const rule of record.rules) { + if ( + !rule || typeof rule !== "object" || Array.isArray(rule) + || !exactKeys(rule, ["identitySid", "inherited", "accessType", "appliesToSelf", "rights"]) + ) throw new Error("Windows ACL authority inspection was malformed"); + const item = rule as Record; + if ( + typeof item.identitySid !== "string" || !WINDOWS_SID.test(item.identitySid) + || typeof item.inherited !== "boolean" + || (item.accessType !== "allow" && item.accessType !== "deny") + || typeof item.appliesToSelf !== "boolean" + || typeof item.rights !== "string" || !/^(?:0|[1-9]\d{0,9})$/.test(item.rights) + || BigInt(item.rights) > 0xffffffffn + ) throw new Error("Windows ACL authority inspection was malformed"); + } +} + +/** Apply the fail-closed policy to deterministic Windows ACL fixtures. */ +export function assertSafeWindowsAuthority( + inspection: WindowsAuthorityInspection, + kind: ConnectAuthorityEntryKind, +): void { + assertWindowsInspectionShape(inspection); + const protectedEntry = kind === "root" || kind === "data" || kind === "env"; + const trustedOwner = WINDOWS_TRUSTED_MUTATORS.has(inspection.ownerSid) + || inspection.ownerSid === "S-1-5-80-956008885-3418522649-1831038044-1853292631-2271478464"; + if (inspection.ownerSid !== inspection.currentUserSid + && !((kind === "ancestor" || kind === "home") && trustedOwner)) { + throw new WindowsAuthorityPolicyError(inspection.index, "OWNER_MISMATCH"); + } + if (inspection.reparsePoint) throw new WindowsAuthorityPolicyError(inspection.index, "REPARSE_POINT"); + for (const rule of inspection.rules) { + const rights = BigInt(rule.rights); + if ((rights & ~WINDOWS_KNOWN_ALLOW_RIGHTS) !== 0n) { + throw new WindowsAuthorityPolicyError(inspection.index, "UNKNOWN_RIGHTS"); + } + if (rule.accessType !== "allow" || !rule.appliesToSelf) continue; + const mutating = (rights & (WINDOWS_MUTATING_RIGHTS | WINDOWS_GENERIC_MUTATING_RIGHTS)) !== 0n; + if (!mutating) continue; + if (rule.identitySid !== inspection.currentUserSid && !WINDOWS_TRUSTED_MUTATORS.has(rule.identitySid)) { + throw new WindowsAuthorityPolicyError(inspection.index, "BROAD_WRITE"); + } + if (rule.inherited && protectedEntry) { + throw new WindowsAuthorityPolicyError(inspection.index, "INHERITED_WRITE"); + } + } + if (protectedEntry && !inspection.daclProtected) { + throw new WindowsAuthorityPolicyError(inspection.index, "DACL_NOT_PROTECTED"); + } +} + +const DARWIN_READ_ONLY_ACL_PERMISSIONS = new Set([ + "execute", "list", "read", "readattr", "readextattr", "readsecurity", "search", "synchronize", +]); +const DARWIN_MUTATING_ACL_PERMISSIONS = new Set([ + "write", "append", "delete", "delete_child", "add_file", "add_subdirectory", + "writeattr", "writeextattr", "writesecurity", "chown", +]); +const DARWIN_ACL_FLAGS = new Set(["directory_inherit", "file_inherit", "inherited", "limit_inherit", "only_inherit"]); + +/** Reject malformed ACL output and every ACL allow entry carrying mutation authority. */ +export function assertSafeDarwinAclOutput(output: string): void { + // acl_to_text() may represent a valid empty extended ACL as an empty string + // on APFS. Canonicalize only that exact representation to the audited empty + // document; every non-empty malformed spelling remains rejected. + const canonicalOutput = output === "" ? "!#acl 1\n" : output; + if (Buffer.byteLength(canonicalOutput, "utf8") > 24 * 1024 || canonicalOutput.includes("\0")) { + throw new Error("Darwin ACL authority inspection was malformed"); + } + const lines = canonicalOutput.replace(/\n$/, "").split("\n"); + if (!/^!#acl 1(?: (?:defer_inherit|no_inherit)(?:,(?:defer_inherit|no_inherit))*)?$/.test(lines[0])) { + throw new Error("Darwin ACL authority inspection was malformed"); + } + for (const line of lines.slice(1)) { + const fields = line.split(":"); + if ( + fields.length !== 6 + || (fields[0] !== "user" && fields[0] !== "group") + || !/^[0-9A-F]{8}(?:-[0-9A-F]{4}){3}-[0-9A-F]{12}$/.test(fields[1]) + || fields[2].length > 255 + || !/^(?:|0|[1-9]\d{0,9})$/.test(fields[3]) + ) throw new Error("Darwin ACL authority inspection was malformed"); + const disposition = fields[4].split(","); + if (disposition[0] !== "allow" && disposition[0] !== "deny") { + throw new Error("Darwin ACL authority inspection was malformed"); + } + if (disposition.slice(1).some((flag) => !DARWIN_ACL_FLAGS.has(flag))) { + throw new Error("Darwin ACL authority inspection was malformed"); + } + for (const permission of fields[5].split(",")) { + if (disposition[0] === "allow" && DARWIN_MUTATING_ACL_PERMISSIONS.has(permission)) { + throw new Error("Darwin ACL grants unexpected write authority"); + } + if (!DARWIN_READ_ONLY_ACL_PERMISSIONS.has(permission) && !DARWIN_MUTATING_ACL_PERMISSIONS.has(permission)) { + throw new Error("Darwin ACL authority inspection was malformed"); + } + } + } +} + +export async function assertNativeEntryAuthority( + inspector: ConnectRootAuthorityInspector, + platform: NodeJS.Platform, + path: string, + kind: ConnectAuthorityEntryKind, + pinnedFd: number, +): Promise { + const before = stableAuthorityIdentity(pinnedFd); + if (platform === "darwin") { + const inspection = inspector.inspectDarwinAcl(path, pinnedFd, before); + assertDarwinInspectionShape(inspection); + if (inspection.device !== before.device || inspection.file !== before.file) { + throw new Error("Darwin authority inspection did not match the pinned object"); + } + assertSafeDarwinAclOutput(inspection.acl); + } else if (platform === "win32") { + const inspection = await inspector.inspectWindowsAcl(path, before, pinnedFd, kind); + try { + assertWindowsInspectionShape(inspection); + } catch { + reportWindowsNativeStage("parent:entry-shape"); + throw new WindowsAuthorityInspectionError(); + } + try { + if ( + inspection.index !== 0 + || inspection.authorityKind !== kind + || inspection.kind !== windowsInspectionEntryKind(kind) + || inspection.currentUserSid.length === 0 + || BigInt(inspection.volumeSerialNumber) !== BigInt(before.device) + || BigInt(inspection.fileId) !== BigInt(before.file) + || BigInt(inspection.volumeSerialNumber) !== BigInt(inspection.verifiedVolumeSerialNumber) + || BigInt(inspection.fileId) !== BigInt(inspection.verifiedFileId) + ) throw new Error(); + } catch { + throw new WindowsAuthorityInspectionError(); + } + assertSafeWindowsAuthority(inspection, kind); + } + const after = stableAuthorityIdentity(pinnedFd); + if (before.device !== after.device || before.file !== after.file) { + throw new Error("native authority target changed during inspection"); + } +} + +/** Inspect and bind one Windows descriptor batch before applying entry policy. */ +export async function assertNativeWindowsEntriesAuthority( + inspector: ConnectRootAuthorityInspector, + entries: readonly { path: string; kind: ConnectAuthorityEntryKind; pinnedFd: number }[], +): Promise { + const targets = entries.map((entry) => ({ + path: entry.path, + kind: entry.kind, + expectedIdentity: stableAuthorityIdentity(entry.pinnedFd), + pinnedFd: entry.pinnedFd, + })); + const batched = inspector.inspectWindowsAcls !== undefined; + const inspections = inspector.inspectWindowsAcls + ? await inspector.inspectWindowsAcls(targets) + : await Promise.all(targets.map((target) => inspector.inspectWindowsAcl( + target.path, target.expectedIdentity, target.pinnedFd, target.kind, + ))); + if (inspections.length !== targets.length) { + reportWindowsNativeStage("parent:entry-count"); + throw new WindowsAuthorityInspectionError(); + } + for (let index = 0; index < targets.length; index += 1) { + const after = stableAuthorityIdentity(entries[index].pinnedFd); + if (after.device !== targets[index].expectedIdentity.device || after.file !== targets[index].expectedIdentity.file) { + reportWindowsNativeStage("parent:post-bind"); + throw new WindowsAuthorityInspectionError(); + } + } + let currentUserSid: string | undefined; + let totalAces = 0; + for (let index = 0; index < targets.length; index += 1) { + const target = targets[index]; + const inspection = inspections[index]; + try { + assertWindowsInspectionShape(inspection); + } catch { + reportWindowsNativeStage("parent:entry-shape"); + throw new WindowsAuthorityInspectionError(); + } + try { + totalAces += inspection.rules.length; + if ( + inspection.index !== (batched ? index : 0) + || inspection.authorityKind !== target.kind + || inspection.kind !== windowsInspectionEntryKind(target.kind) + || (currentUserSid !== undefined && inspection.currentUserSid !== currentUserSid) + || BigInt(inspection.volumeSerialNumber) !== BigInt(target.expectedIdentity.device) + || BigInt(inspection.fileId) !== BigInt(target.expectedIdentity.file) + || BigInt(inspection.volumeSerialNumber) !== BigInt(inspection.verifiedVolumeSerialNumber) + || BigInt(inspection.fileId) !== BigInt(inspection.verifiedFileId) + || totalAces > WINDOWS_AUTHORITY_MAX_TOTAL_ACES + ) throw new Error(); + currentUserSid = inspection.currentUserSid; + } catch { + reportWindowsNativeStage("parent:descriptor-bind"); + throw new WindowsAuthorityInspectionError(); + } + assertSafeWindowsAuthority(inspection, target.kind); + } +} + +export { parseWindowsInspectionDocument }; diff --git a/packages/cli/src/connectWindowsAuthority.ts b/packages/cli/src/connectWindowsAuthority.ts new file mode 100644 index 000000000..0ff26064e --- /dev/null +++ b/packages/cli/src/connectWindowsAuthority.ts @@ -0,0 +1,663 @@ +import { spawnSync } from "node:child_process"; +import { + closeSync, + constants, + fstatSync, + lstatSync, + openSync, + realpathSync, +} from "node:fs"; +import { win32 } from "node:path"; +import { performance } from "node:perf_hooks"; +import type { + ConnectAuthorityEntryKind, + WindowsAuthorityInspection, + WindowsAuthorityTarget, +} from "./connectRootAuthority.js"; + +// Hosted alternate-user Windows can spend more than fifteen seconds entering +// the fixed PowerShell/Reflection.Emit boundary. Each production call gets one +// bounded cold-start allowance. The cumulative cap is a fixed four-process +// proof ceiling and is independent of the 32-entry input-schema bound. +export const WINDOWS_INSPECTION_TIMEOUT_MS = 60_000; +export const WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS = 240_000; +export const WINDOWS_NATIVE_TIMING_PROBE_TIMEOUT_MS = 60_000; +const WINDOWS_INSPECTION_MAX_BYTES = 128 * 1024; +const WINDOWS_NATIVE_PROBE_MAX_BYTES = 2 * 1024; +const WINDOWS_INSPECTION_MAX_ENTRIES = 32; +const GLOBAL_SYSTEM_ROOT = String.raw`\\?\GLOBALROOT\SystemRoot`; + +export const WINDOWS_NATIVE_STAGE_CODES = Object.freeze([ + "resolver:env", "resolver:canonical", "resolver:global-open", "resolver:global-id", + "spawn:create", "spawn:error", "spawn:timeout", "spawn:cumulative-timeout", "spawn:status", "spawn:stderr", + "probe:entry", "probe:baseline", "probe:reflection-emit", "probe:win32", "probe:standard-handle", "probe:output", + "broker:ps-version", "broker:job", "broker:fd", "broker:fd-duplicate", "broker:index-info-initial", + "broker:security-info", "broker:acl", "broker:json", "broker:current-user-sid", + "broker:index-info-revalidation", "broker:index-info-decode", "broker:index-info-compose", "broker:entry-format", + "broker:entry-flags", "broker:entry-rules", "broker:entry-build", + "parent:utf8", "parent:json-parse", "parent:json-canonical", "parent:document-shape", + "parent:entry-count", "parent:entry-shape", "parent:json-shape", "parent:descriptor-bind", "parent:post-bind", +] as const); + +export type WindowsNativeStageCode = (typeof WINDOWS_NATIVE_STAGE_CODES)[number]; + +const WINDOWS_NATIVE_STAGE_SET: ReadonlySet = new Set(WINDOWS_NATIVE_STAGE_CODES); +const WINDOWS_NATIVE_DIAGNOSTIC_HOOK = Symbol.for("propr.test.windowsNativeDiagnostic"); + +export class WindowsNativeStageError extends Error { + constructor(readonly stage: WindowsNativeStageCode) { + super("Windows native authority inspection failed"); + this.name = "WindowsNativeStageError"; + } +} + +export function reportWindowsNativeStage(stage: WindowsNativeStageCode): void { + if (!WINDOWS_NATIVE_STAGE_SET.has(stage)) return; + const hook = (globalThis as Record)[WINDOWS_NATIVE_DIAGNOSTIC_HOOK]; + if (typeof hook !== "function") return; + try { (hook as (value: string) => void)(stage); } catch { /* Diagnostics never alter production status. */ } +} + +function stageError(stage: WindowsNativeStageCode): WindowsNativeStageError { + return new WindowsNativeStageError(stage); +} + +// Each production inspector receives exactly one already-open target as its +// standard-input HANDLE. Unlike Node extra stdio slots, STARTF_USESTDHANDLES is +// a documented Windows process boundary and GetStdHandle returns the inherited +// HANDLE directly. The script contains no process-creation API or external +// command; terminating powershell.exe therefore terminates the complete tree. +export const WINDOWS_INSPECTOR_CREATES_CHILD_PROCESSES = false; +export const WINDOWS_INSPECTOR_WRITES_FILESYSTEM = false; +export const WINDOWS_INSPECTOR_TRANSPORT = "inherited-standard-handle" as const; + +export const WINDOWS_UNSIGNED_FIELD_DECODER_SOURCE = String.raw` +function Read-ProprUInt32([IntPtr]$pointer,[int]$offset){ + if(-not [BitConverter]::IsLittleEndian){exit $stage} + $signed=[int32][Runtime.InteropServices.Marshal]::ReadInt32($pointer,$offset) + $bytes=[BitConverter]::GetBytes($signed) + [BitConverter]::ToUInt32($bytes,0) +}`; + +export const WINDOWS_UINT64_COMPOSER_SOURCE = String.raw` +function Join-ProprUInt64([uint32]$low,[uint32]$high){ + if(-not [BitConverter]::IsLittleEndian){exit $stage} + $bytes=New-Object byte[] 8 + [Array]::Copy([BitConverter]::GetBytes([uint32]$low),0,$bytes,0,4) + [Array]::Copy([BitConverter]::GetBytes([uint32]$high),0,$bytes,4,4) + [BitConverter]::ToUInt64($bytes,0) +}`; + +// Reflection.Emit keeps the fixed P/Invoke surface in memory. Add-Type and its +// writable compiler workspace are deliberately absent. +export const WINDOWS_INSPECTION_SOURCE = String.raw` +$ErrorActionPreference='Stop' +$ProgressPreference='SilentlyContinue' +Set-StrictMode -Version 2 +${WINDOWS_UNSIGNED_FIELD_DECODER_SOURCE} +${WINDOWS_UINT64_COMPOSER_SOURCE} +$stage=71 +$privateHandle=[IntPtr]::Zero +$privateHandleOwned=$false +try { + if($PSVersionTable.PSVersion.Major-ne 5-or $PSVersionTable.PSVersion.Minor-ne 1-or + $PSVersionTable.PSEdition-ne 'Desktop'-or -not [Environment]::Is64BitProcess){exit $stage} + $assembly=[AppDomain]::CurrentDomain.DefineDynamicAssembly( + (New-Object Reflection.AssemblyName('ProprReadOnlyAuthorityAssembly')), + [Reflection.Emit.AssemblyBuilderAccess]::Run) + $module=$assembly.DefineDynamicModule('ProprReadOnlyAuthorityModule') + $builder=$module.DefineType('ProprReadOnlyAuthority',[Reflection.TypeAttributes]'Public,Abstract,Sealed') + function Add-NativeMethod($name,$library,$returnType,[Type[]]$parameters,$nativeConvention){ + $method=$builder.DefinePInvokeMethod($name,$library, + [Reflection.MethodAttributes]'Public,Static,PinvokeImpl',[Reflection.CallingConventions]::Standard, + $returnType,$parameters,$nativeConvention,[Runtime.InteropServices.CharSet]::Unicode) + $method.SetImplementationFlags($method.GetMethodImplementationFlags()-bor [Reflection.MethodImplAttributes]::PreserveSig) + } + $winapi=[Runtime.InteropServices.CallingConvention]::Winapi + $intptr=[IntPtr];$intptrRef=$intptr.MakeByRefType();$uint=[uint32];$uintRef=$uint.MakeByRefType();$ushortRef=([uint16]).MakeByRefType();$boolRef=([bool]).MakeByRefType() + Add-NativeMethod 'GetStdHandle' 'kernel32.dll' $intptr @([int]) $winapi + Add-NativeMethod 'DuplicateHandle' 'kernel32.dll' ([bool]) @($intptr,$intptr,$intptr,$intptrRef,$uint,[bool],$uint) $winapi + Add-NativeMethod 'CloseHandle' 'kernel32.dll' ([bool]) @($intptr) $winapi + Add-NativeMethod 'GetFileInformationByHandle' 'kernel32.dll' ([bool]) @($intptr,$intptr) $winapi + Add-NativeMethod 'GetSecurityInfo' 'advapi32.dll' $uint @($intptr,$uint,$uint,$intptrRef,$intptrRef,$intptrRef,$intptrRef,$intptrRef) $winapi + Add-NativeMethod 'GetSecurityDescriptorControl' 'advapi32.dll' ([bool]) @($intptr,$ushortRef,$uintRef) $winapi + Add-NativeMethod 'GetAclInformation' 'advapi32.dll' ([bool]) @($intptr,$intptr,$uint,$uint) $winapi + Add-NativeMethod 'GetAce' 'advapi32.dll' ([bool]) @($intptr,$uint,$intptrRef) $winapi + Add-NativeMethod 'LocalFree' 'kernel32.dll' $intptr @($intptr) $winapi + Add-NativeMethod 'IsProcessInJob' 'kernel32.dll' ([bool]) @($intptr,$intptr,$boolRef) $winapi + Add-NativeMethod 'GetCurrentProcess' 'kernel32.dll' $intptr @() $winapi + $null=$builder.CreateType() + $stage=72 + $inJob=$false + if(-not [ProprReadOnlyAuthority]::IsProcessInJob([ProprReadOnlyAuthority]::GetCurrentProcess(),[IntPtr]::Zero,[ref]$inJob)){exit $stage} + $stage=73 + $originalHandle=[ProprReadOnlyAuthority]::GetStdHandle(-10) + if($originalHandle-eq [IntPtr](-1)-or $originalHandle-eq [IntPtr](-2)-or $originalHandle-eq [IntPtr]::Zero){exit $stage} + $stage=80 + if(-not [ProprReadOnlyAuthority]::DuplicateHandle( + [ProprReadOnlyAuthority]::GetCurrentProcess(),$originalHandle, + [ProprReadOnlyAuthority]::GetCurrentProcess(),[ref]$privateHandle,0,$false,2)){exit $stage} + $privateHandleOwned=$true + if($privateHandle-eq [IntPtr](-1)-or $privateHandle-eq [IntPtr](-2)-or $privateHandle-eq [IntPtr]::Zero){exit $stage} + $stage=74 + $before=[Runtime.InteropServices.Marshal]::AllocHGlobal(52) + if(-not [ProprReadOnlyAuthority]::GetFileInformationByHandle($privateHandle,$before)){exit $stage} + $stage=78 + $current=[Security.Principal.WindowsIdentity]::GetCurrent().User + if($null-eq $current){exit $stage} + $currentSid=$current.Value + $stage=75 + $owner=[IntPtr]::Zero;$group=[IntPtr]::Zero;$dacl=[IntPtr]::Zero;$sacl=[IntPtr]::Zero;$descriptor=[IntPtr]::Zero + try { + if([ProprReadOnlyAuthority]::GetSecurityInfo($privateHandle,1,5,[ref]$owner,[ref]$group,[ref]$dacl,[ref]$sacl,[ref]$descriptor)-ne 0){exit $stage} + if($owner-eq [IntPtr]::Zero-or $dacl-eq [IntPtr]::Zero-or $descriptor-eq [IntPtr]::Zero){exit $stage} + $ownerSid=(New-Object Security.Principal.SecurityIdentifier($owner)).Value + $control=[uint16]0;$revision=[uint32]0 + if(-not [ProprReadOnlyAuthority]::GetSecurityDescriptorControl($descriptor,[ref]$control,[ref]$revision)){exit $stage} + $stage=76 + $aclInfo=[Runtime.InteropServices.Marshal]::AllocHGlobal(12) + if(-not [ProprReadOnlyAuthority]::GetAclInformation($dacl,$aclInfo,12,2)){exit $stage} + $aceCount=Read-ProprUInt32 $aclInfo 0 + $aclBytes=Read-ProprUInt32 $aclInfo 4 + if($aceCount-gt 128-or $aclBytes-lt 8-or $aclBytes-gt 65535){exit $stage} + $aclRevision=[Runtime.InteropServices.Marshal]::ReadByte($dacl,0) + if(($aclRevision-ne 2-and $aclRevision-ne 4)-or [Runtime.InteropServices.Marshal]::ReadByte($dacl,1)-ne 0){exit $stage} + $rules=New-Object Collections.Generic.List[object] + for($aceIndex=0;$aceIndex-lt $aceCount;$aceIndex++){ + $ace=[IntPtr]::Zero + if(-not [ProprReadOnlyAuthority]::GetAce($dacl,$aceIndex,[ref]$ace)-or $ace-eq [IntPtr]::Zero){exit $stage} + $aceType=[Runtime.InteropServices.Marshal]::ReadByte($ace,0);$flags=[Runtime.InteropServices.Marshal]::ReadByte($ace,1) + $aceSize=[uint16][Runtime.InteropServices.Marshal]::ReadInt16($ace,2) + if(($aceType-ne 0-and $aceType-ne 1)-or ($flags-band 0xE0)-ne 0-or $aceSize-lt 16-or $aceSize-gt 4096){exit $stage} + $mask=Read-ProprUInt32 $ace 4 + $sidPointer=[IntPtr]::Add($ace,8);$sid=New-Object Security.Principal.SecurityIdentifier($sidPointer) + if($sid.BinaryLength-gt ($aceSize-8)){exit $stage} + $rules.Add([pscustomobject][ordered]@{ + identitySid=$sid.Value;inherited=[bool](($flags-band 0x10)-ne 0) + accessType=$(if($aceType-eq 0){'allow'}else{'deny'});appliesToSelf=[bool](($flags-band 8)-eq 0) + rights=$mask.ToString([Globalization.CultureInfo]::InvariantCulture) + }) + } + } finally {if($descriptor-ne [IntPtr]::Zero){$null=[ProprReadOnlyAuthority]::LocalFree($descriptor)}} + $stage=79 + $after=[Runtime.InteropServices.Marshal]::AllocHGlobal(52) + if(-not [ProprReadOnlyAuthority]::GetFileInformationByHandle($privateHandle,$after)){exit $stage} + $stage=81 + $beforeVolume=Read-ProprUInt32 $before 28 + $afterVolume=Read-ProprUInt32 $after 28 + $beforeHigh=Read-ProprUInt32 $before 44;$beforeLow=Read-ProprUInt32 $before 48 + $afterHigh=Read-ProprUInt32 $after 44;$afterLow=Read-ProprUInt32 $after 48 + $stage=82 + $beforeId=Join-ProprUInt64 $beforeLow $beforeHigh + if($beforeId-isnot [uint64]){exit $stage} + $afterId=Join-ProprUInt64 $afterLow $afterHigh + if($afterId-isnot [uint64]){exit $stage} + $stage=84 + $beforeVolumeDecimal=$beforeVolume.ToString([Globalization.CultureInfo]::InvariantCulture) + $afterVolumeDecimal=$afterVolume.ToString([Globalization.CultureInfo]::InvariantCulture) + $beforeIdDecimal=$beforeId.ToString([Globalization.CultureInfo]::InvariantCulture) + $afterIdDecimal=$afterId.ToString([Globalization.CultureInfo]::InvariantCulture) + if($beforeVolumeDecimal-isnot [string]-or $beforeVolumeDecimal.Length-eq 0-or $beforeVolumeDecimal.Length-gt 10-or $beforeVolumeDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage} + if($afterVolumeDecimal-isnot [string]-or $afterVolumeDecimal.Length-eq 0-or $afterVolumeDecimal.Length-gt 10-or $afterVolumeDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage} + if($beforeIdDecimal-isnot [string]-or $beforeIdDecimal.Length-eq 0-or $beforeIdDecimal.Length-gt 20-or $beforeIdDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage} + if($afterIdDecimal-isnot [string]-or $afterIdDecimal.Length-eq 0-or $afterIdDecimal.Length-gt 20-or $afterIdDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage} + $stage=85 + $daclProtected=[bool](($control-band 0x1000)-ne 0) + $reparsePoint=[bool](([Runtime.InteropServices.Marshal]::ReadInt32($before,0)-band 0x400)-ne 0) + if($daclProtected-isnot [bool]-or $reparsePoint-isnot [bool]){exit $stage} + $stage=86 + [object[]]$rulesArray=$rules.ToArray() + if($rulesArray-isnot [object[]]-or $rulesArray.Count-ne $rules.Count-or $rulesArray.Count-gt 128){exit $stage} + for($ruleIndex=0;$ruleIndex-lt $rulesArray.Count;$ruleIndex++){ + if(-not [object]::ReferenceEquals($rulesArray[$ruleIndex],$rules[$ruleIndex])){exit $stage} + } + $stage=83 + $entry=[pscustomobject][ordered]@{ + index=__PROPR_INDEX__;kind='__PROPR_ENTRY_KIND__';authorityKind='__PROPR_AUTHORITY_KIND__';currentUserSid=$currentSid;ownerSid=$ownerSid + daclProtected=$daclProtected;reparsePoint=$reparsePoint + volumeSerialNumber=$beforeVolumeDecimal + fileId=$beforeIdDecimal + verifiedVolumeSerialNumber=$afterVolumeDecimal + verifiedFileId=$afterIdDecimal;rules=$rulesArray + } + $stage=77 + $json=ConvertTo-Json ([pscustomobject][ordered]@{version=1;entries=@($entry)}) -Compress -Depth 5 + if([Text.Encoding]::UTF8.GetByteCount($json)-gt 131072){exit $stage} + [Console]::OutputEncoding=New-Object Text.UTF8Encoding($false,$true) + [Console]::Out.Write($json) + exit 0 +}catch{exit $stage} +finally {if($privateHandleOwned){$null=[ProprReadOnlyAuthority]::CloseHandle($privateHandle)}} +`; + +export const WINDOWS_NATIVE_PROBE_MILESTONES = Object.freeze([ + "entry-ps51-desktop-x64", + "constant-json", + "reflection-emit", + "harmless-win32", + "standard-handle-identity", +] as const); + +export type WindowsNativeProbeMilestone = (typeof WINDOWS_NATIVE_PROBE_MILESTONES)[number]; + +export const WINDOWS_NATIVE_TIMING_BUCKETS = Object.freeze([ + "under-5s", "5-to-15s", "15-to-30s", "30-to-45s", "45-to-60s", "at-least-60s", +] as const); + +export type WindowsNativeTimingBucket = (typeof WINDOWS_NATIVE_TIMING_BUCKETS)[number]; + +export const WINDOWS_NATIVE_TIMING_PROBE_SOURCE = String.raw` +$ErrorActionPreference='Stop' +$ProgressPreference='SilentlyContinue' +Set-StrictMode -Version 2 +${WINDOWS_UNSIGNED_FIELD_DECODER_SOURCE} +${WINDOWS_UINT64_COMPOSER_SOURCE} +$clock=[Diagnostics.Stopwatch]::StartNew() +function Write-ProprMilestone([string]$name){ + $elapsed=$clock.ElapsedMilliseconds + $bucket=if($elapsed-lt 5000){'under-5s'}elseif($elapsed-lt 15000){'5-to-15s'}elseif($elapsed-lt 30000){'15-to-30s'}elseif($elapsed-lt 45000){'30-to-45s'}elseif($elapsed-lt 60000){'45-to-60s'}else{'at-least-60s'} + [Console]::Out.WriteLine(('PROPR_NATIVE_PROBE_V1|{0}|{1}' -f $name,$bucket)) + [Console]::Out.Flush() +} +$stage=91 +try { + if($PSVersionTable.PSVersion.Major-ne 5-or $PSVersionTable.PSVersion.Minor-ne 1-or + $PSVersionTable.PSEdition-ne 'Desktop'-or -not [Environment]::Is64BitProcess){exit $stage} + Write-ProprMilestone 'entry-ps51-desktop-x64' + $stage=92 + $baseline='{"version":1,"baseline":"constant"}' + if($baseline-ne '{"version":1,"baseline":"constant"}'){exit $stage} + Write-ProprMilestone 'constant-json' + $stage=93 + $assembly=[AppDomain]::CurrentDomain.DefineDynamicAssembly( + (New-Object Reflection.AssemblyName('ProprNativeTimingProbeAssembly')), + [Reflection.Emit.AssemblyBuilderAccess]::Run) + $module=$assembly.DefineDynamicModule('ProprNativeTimingProbeModule') + $builder=$module.DefineType('ProprNativeTimingProbe',[Reflection.TypeAttributes]'Public,Abstract,Sealed') + function Add-ProprNativeMethod($name,$returnType,[Type[]]$parameters){ + $method=$builder.DefinePInvokeMethod($name,'kernel32.dll', + [Reflection.MethodAttributes]'Public,Static,PinvokeImpl',[Reflection.CallingConventions]::Standard, + $returnType,$parameters,[Runtime.InteropServices.CallingConvention]::Winapi,[Runtime.InteropServices.CharSet]::Unicode) + $method.SetImplementationFlags($method.GetMethodImplementationFlags()-bor [Reflection.MethodImplAttributes]::PreserveSig) + } + $intptr=[IntPtr] + Add-ProprNativeMethod 'GetCurrentProcessId' ([uint32]) @() + Add-ProprNativeMethod 'GetStdHandle' $intptr @([int]) + Add-ProprNativeMethod 'GetFileInformationByHandle' ([bool]) @($intptr,$intptr) + $null=$builder.CreateType() + Write-ProprMilestone 'reflection-emit' + $stage=94 + if([ProprNativeTimingProbe]::GetCurrentProcessId()-eq 0){exit $stage} + Write-ProprMilestone 'harmless-win32' + $stage=95 + $handle=[ProprNativeTimingProbe]::GetStdHandle(-10) + if($handle-eq [IntPtr](-1)-or $handle-eq [IntPtr](-2)-or $handle-eq [IntPtr]::Zero){exit $stage} + $info=[Runtime.InteropServices.Marshal]::AllocHGlobal(52) + if(-not [ProprNativeTimingProbe]::GetFileInformationByHandle($handle,$info)){exit $stage} + $probeVolume=Read-ProprUInt32 $info 28 + $probeHigh=Read-ProprUInt32 $info 44;$probeLow=Read-ProprUInt32 $info 48 + $probeId=Join-ProprUInt64 $probeLow $probeHigh + if($probeId-isnot [uint64]){exit $stage} + $probeVolumeDecimal=$probeVolume.ToString([Globalization.CultureInfo]::InvariantCulture) + $probeIdDecimal=$probeId.ToString([Globalization.CultureInfo]::InvariantCulture) + if($probeVolumeDecimal-isnot [string]-or $probeVolumeDecimal.Length-eq 0-or $probeVolumeDecimal.Length-gt 10-or $probeVolumeDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage} + if($probeIdDecimal-isnot [string]-or $probeIdDecimal.Length-eq 0-or $probeIdDecimal.Length-gt 20-or $probeIdDecimal-cnotmatch '^(0|[1-9][0-9]*)$'){exit $stage} + Write-ProprMilestone 'standard-handle-identity' + exit 0 +}catch{exit $stage} +`; + +interface HeldExecutable { + readonly path: string; + readonly systemRoot: string; + readonly fd: number; + readonly device: string; + readonly file: string; +} + +function sameWindowsPath(left: string, right: string): boolean { + return win32.normalize(left).toLowerCase() === win32.normalize(right).toLowerCase(); +} + +function ordinaryDosPath(value: string): boolean { + return value.length >= 4 + && value.length < 32_768 + && /^[A-Za-z]:\\[^\0\r\n]+$/.test(value) + && !value.split("\\").some((part) => part === "." || part === ".."); +} + +function resolveWindowsPowerShell(): HeldExecutable { + if (process.platform !== "win32" || process.arch === "ia32") throw stageError("resolver:env"); + const suppliedRoot = process.env.SystemRoot; + const suppliedWindir = process.env.WINDIR; + if (!suppliedRoot || !suppliedWindir || !ordinaryDosPath(suppliedRoot) || !ordinaryDosPath(suppliedWindir)) { + throw stageError("resolver:env"); + } + let canonicalSupplied: string; + let canonicalWindir: string; + try { + canonicalSupplied = realpathSync.native(suppliedRoot); + canonicalWindir = realpathSync.native(suppliedWindir); + } catch { throw stageError("resolver:canonical"); } + if ( + !ordinaryDosPath(canonicalSupplied) + || !sameWindowsPath(canonicalSupplied, canonicalWindir) + || !sameWindowsPath(suppliedRoot, canonicalSupplied) + || !sameWindowsPath(suppliedWindir, canonicalWindir) + ) throw stageError("resolver:canonical"); + const path = win32.join(canonicalSupplied, "System32", "WindowsPowerShell", "v1.0", "powershell.exe"); + let canonicalPath: string; + try { canonicalPath = realpathSync.native(path); } catch { throw stageError("resolver:canonical"); } + let named: ReturnType; + try { named = lstatSync(path, { bigint: true }); } catch { throw stageError("resolver:canonical"); } + if (!sameWindowsPath(path, canonicalPath) || !named.isFile() || named.isSymbolicLink()) { + throw stageError("resolver:canonical"); + } + let fd: number; + try { fd = openSync(path, constants.O_RDONLY | constants.O_NOFOLLOW); } catch { throw stageError("resolver:canonical"); } + let globalFd: number | undefined; + try { + const held = fstatSync(fd, { bigint: true }); + try { + globalFd = openSync( + `${GLOBAL_SYSTEM_ROOT}\\System32\\WindowsPowerShell\\v1.0\\powershell.exe`, + constants.O_RDONLY | constants.O_NOFOLLOW, + ); + } catch { throw stageError("resolver:global-open"); } + const global = fstatSync(globalFd, { bigint: true }); + if (!held.isFile() || !global.isFile() || held.dev !== named.dev || held.ino !== named.ino + || held.dev !== global.dev || held.ino !== global.ino) throw stageError("resolver:global-id"); + return { path, systemRoot: canonicalSupplied, fd, device: held.dev.toString(10), file: held.ino.toString(10) }; + } catch (error) { + closeSync(fd); + throw error; + } finally { + if (globalFd !== undefined) closeSync(globalFd); + } +} + +function revalidateWindowsPowerShell(executable: HeldExecutable): void { + let namedFd: number | undefined; + try { + try { namedFd = openSync(executable.path, constants.O_RDONLY | constants.O_NOFOLLOW); } catch { + throw stageError("resolver:global-id"); + } + const held = fstatSync(executable.fd, { bigint: true }); + const named = fstatSync(namedFd, { bigint: true }); + if ( + !held.isFile() || !named.isFile() + || held.dev.toString(10) !== executable.device || held.ino.toString(10) !== executable.file + || named.dev.toString(10) !== executable.device || named.ino.toString(10) !== executable.file + ) throw stageError("resolver:global-id"); + } finally { + if (namedFd !== undefined) closeSync(namedFd); + } +} + +function strictUtf8(value: Buffer | string | null | undefined): string { + const bytes = typeof value === "string" ? Buffer.from(value, "utf8") : (value ?? Buffer.alloc(0)); + if (bytes.byteLength === 0 || bytes.byteLength > WINDOWS_INSPECTION_MAX_BYTES) { + throw stageError("parent:utf8"); + } + try { return new TextDecoder("utf-8", { fatal: true }).decode(bytes); } catch { + throw stageError("parent:utf8"); + } +} + +export function parseWindowsInspectionDocument(value: Buffer | string): readonly WindowsAuthorityInspection[] { + const text = strictUtf8(value); + let parsed: unknown; + try { parsed = JSON.parse(text); } catch { throw stageError("parent:json-parse"); } + if (JSON.stringify(parsed) !== text) throw stageError("parent:json-canonical"); + if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) { + throw stageError("parent:document-shape"); + } + const document = parsed as Record; + if (Object.keys(document).sort().join(",") !== "entries,version" || document.version !== 1 + || !Array.isArray(document.entries) || document.entries.length > WINDOWS_INSPECTION_MAX_ENTRIES) { + throw stageError("parent:document-shape"); + } + return document.entries as WindowsAuthorityInspection[]; +} + +export function windowsBrokerFailureStage(status: number | null): WindowsNativeStageCode { + const stages: Readonly> = { + 71: "broker:ps-version", 72: "broker:job", 73: "broker:fd", 74: "broker:index-info-initial", + 75: "broker:security-info", 76: "broker:acl", 77: "broker:json", + 78: "broker:current-user-sid", 79: "broker:index-info-revalidation", 80: "broker:fd-duplicate", + 81: "broker:index-info-decode", 82: "broker:index-info-compose", 83: "broker:entry-build", + 84: "broker:entry-format", 85: "broker:entry-flags", 86: "broker:entry-rules", + }; + return status === null ? "spawn:status" : (stages[status] ?? "spawn:status"); +} + +function inspectionSource(target: WindowsAuthorityTarget, index: number): string { + const entryKind = target.kind === "env" ? "file" : "directory"; + return WINDOWS_INSPECTION_SOURCE + .replace("__PROPR_INDEX__", String(index)) + .replace("__PROPR_ENTRY_KIND__", entryKind) + .replace("__PROPR_AUTHORITY_KIND__", target.kind); +} + +/** The fixed inspector receives no caller-controlled executable/module/profile/temp authority. */ +export function windowsPowerShellEnvironment(systemRoot: string): Readonly> { + if (!ordinaryDosPath(systemRoot)) throw stageError("resolver:env"); + return Object.freeze({ SystemRoot: systemRoot, WINDIR: systemRoot }); +} + +function spawnPowerShell( + executable: HeldExecutable, + source: string, + stdin: "ignore" | number, + timeout = WINDOWS_INSPECTION_TIMEOUT_MS, + maxBuffer = WINDOWS_INSPECTION_MAX_BYTES, +) { + const encoded = Buffer.from(source, "utf16le").toString("base64"); + if (encoded.length > 28_000) throw stageError("spawn:create"); + try { + return spawnSync(executable.path, [ + "-NoLogo", "-NoProfile", "-NonInteractive", "-ExecutionPolicy", "Bypass", "-EncodedCommand", encoded, + ], { + shell: false, + windowsHide: true, + encoding: "buffer", + cwd: win32.dirname(executable.path), + env: windowsPowerShellEnvironment(executable.systemRoot), + timeout, + killSignal: "SIGKILL", + maxBuffer, + stdio: [stdin, "pipe", "pipe"], + }); + } catch { throw stageError("spawn:create"); } +} + +export interface WindowsNativeProbeRecord { + readonly milestone: WindowsNativeProbeMilestone; + readonly timingBucket: WindowsNativeTimingBucket; +} + +export interface WindowsNativeTimingProof { + readonly version: 1; + readonly outcome: "complete" | "timeout"; + readonly lastMilestone: WindowsNativeProbeMilestone | "none"; + readonly timingBucket: WindowsNativeTimingBucket; + /** Present only after complete strict-prefix validation; timeout diagnostics retain only the last token. */ + readonly milestones: readonly WindowsNativeProbeRecord[]; +} + +export function windowsNativeTimingBucket(elapsedMs: number): WindowsNativeTimingBucket { + if (!Number.isFinite(elapsedMs) || elapsedMs < 0) throw stageError("probe:output"); + if (elapsedMs < 5_000) return "under-5s"; + if (elapsedMs < 15_000) return "5-to-15s"; + if (elapsedMs < 30_000) return "15-to-30s"; + if (elapsedMs < 45_000) return "30-to-45s"; + if (elapsedMs < 60_000) return "45-to-60s"; + return "at-least-60s"; +} + +export function parseWindowsNativeProbeOutput( + value: Buffer | string | null | undefined, + allowTruncatedFinalToken = false, +): readonly WindowsNativeProbeRecord[] { + const bytes = typeof value === "string" + ? Buffer.from(value, "utf8") + : (value ?? Buffer.alloc(0)); + if (bytes.byteLength > WINDOWS_NATIVE_PROBE_MAX_BYTES) throw stageError("probe:output"); + let text: string; + try { text = new TextDecoder("utf-8", { fatal: true }).decode(bytes); } catch { + throw stageError("probe:output"); + } + if (text.length === 0) return []; + const lines = text.split(/\r?\n/); + if (lines.at(-1) === "") lines.pop(); + else if (allowTruncatedFinalToken) lines.pop(); + else throw stageError("probe:output"); + if (lines.length > WINDOWS_NATIVE_PROBE_MILESTONES.length) throw stageError("probe:output"); + const records: WindowsNativeProbeRecord[] = []; + let priorBucket = -1; + for (let index = 0; index < lines.length; index += 1) { + const milestone = WINDOWS_NATIVE_PROBE_MILESTONES[index]; + const prefix = `PROPR_NATIVE_PROBE_V1|${milestone}|`; + if (!lines[index].startsWith(prefix)) throw stageError("probe:output"); + const timingBucket = lines[index].slice(prefix.length); + const bucketIndex = (WINDOWS_NATIVE_TIMING_BUCKETS as readonly string[]).indexOf(timingBucket); + if (bucketIndex < priorBucket || bucketIndex < 0) throw stageError("probe:output"); + priorBucket = bucketIndex; + records.push({ milestone, timingBucket: timingBucket as WindowsNativeTimingBucket }); + } + return records; +} + +function assertSpawnSuccess(result: ReturnType): void { + if (result.error) { + if ((result.error as NodeJS.ErrnoException).code === "ETIMEDOUT") throw stageError("spawn:timeout"); + throw stageError("spawn:error"); + } + if (result.signal) throw stageError(result.signal === "SIGKILL" ? "spawn:timeout" : "spawn:status"); + if (result.status !== 0) throw stageError(windowsBrokerFailureStage(result.status)); + const stderrBytes = typeof result.stderr === "string" + ? Buffer.byteLength(result.stderr, "utf8") + : (result.stderr?.byteLength ?? 0); + if (stderrBytes !== 0) throw stageError("spawn:stderr"); +} + +export function windowsInspectionTimeoutForElapsed(elapsedMs: number): number { + if (!Number.isFinite(elapsedMs) || elapsedMs < 0) throw stageError("spawn:cumulative-timeout"); + const remaining = WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS - Math.floor(elapsedMs); + if (remaining <= 0) throw stageError("spawn:cumulative-timeout"); + return Math.min(WINDOWS_INSPECTION_TIMEOUT_MS, remaining); +} + +export function runWindowsReadOnlyInspection( + targets: readonly WindowsAuthorityTarget[], +): readonly WindowsAuthorityInspection[] { + if (targets.length < 1 || targets.length > WINDOWS_INSPECTION_MAX_ENTRIES) { + throw stageError("parent:entry-count"); + } + const executable = resolveWindowsPowerShell(); + const inspections: WindowsAuthorityInspection[] = []; + let totalOutputBytes = 0; + const inspectionStarted = performance.now(); + try { + for (let index = 0; index < targets.length; index += 1) { + const target = targets[index]; + const timeout = windowsInspectionTimeoutForElapsed(performance.now() - inspectionStarted); + const result = spawnPowerShell(executable, inspectionSource(target, index), target.pinnedFd, timeout); + assertSpawnSuccess(result); + totalOutputBytes += typeof result.stdout === "string" + ? Buffer.byteLength(result.stdout, "utf8") + : (result.stdout?.byteLength ?? 0); + if (totalOutputBytes > WINDOWS_INSPECTION_MAX_BYTES) throw stageError("parent:utf8"); + const entries = parseWindowsInspectionDocument(result.stdout ?? Buffer.alloc(0)); + if (entries.length !== 1) throw stageError("parent:entry-count"); + const entry = entries[0]; + try { + if ( + entry.index !== index + || entry.kind !== (target.kind === "env" ? "file" : "directory") + || entry.authorityKind !== target.kind + || BigInt(entry.volumeSerialNumber) !== BigInt(target.expectedIdentity.device) + || BigInt(entry.fileId) !== BigInt(target.expectedIdentity.file) + || BigInt(entry.volumeSerialNumber) !== BigInt(entry.verifiedVolumeSerialNumber) + || BigInt(entry.fileId) !== BigInt(entry.verifiedFileId) + ) throw new Error(); + } catch { throw stageError("parent:descriptor-bind"); } + const after = fstatSync(target.pinnedFd, { bigint: true }); + if (after.dev.toString(10) !== target.expectedIdentity.device || after.ino.toString(10) !== target.expectedIdentity.file) { + throw stageError("parent:post-bind"); + } + inspections.push(entry); + } + revalidateWindowsPowerShell(executable); + return inspections; + } finally { + closeSync(executable.fd); + } +} + +function probeFailureStage(status: number | null): WindowsNativeStageCode { + const stages: Readonly> = { + 91: "probe:entry", + 92: "probe:baseline", + 93: "probe:reflection-emit", + 94: "probe:win32", + 95: "probe:standard-handle", + }; + return status === null ? "spawn:status" : (stages[status] ?? "spawn:status"); +} + +export function runWindowsNativeTimingProbe(targetFd: number): WindowsNativeTimingProof { + const executable = resolveWindowsPowerShell(); + try { + const started = performance.now(); + const result = spawnPowerShell( + executable, + WINDOWS_NATIVE_TIMING_PROBE_SOURCE, + targetFd, + WINDOWS_NATIVE_TIMING_PROBE_TIMEOUT_MS, + WINDOWS_NATIVE_PROBE_MAX_BYTES, + ); + const elapsed = performance.now() - started; + const timedOut = (result.error as NodeJS.ErrnoException | undefined)?.code === "ETIMEDOUT"; + const records = parseWindowsNativeProbeOutput(result.stdout, timedOut); + const stderrBytes = typeof result.stderr === "string" + ? Buffer.byteLength(result.stderr, "utf8") + : (result.stderr?.byteLength ?? 0); + if (stderrBytes !== 0) throw stageError("spawn:stderr"); + if (timedOut) { + const proof: WindowsNativeTimingProof = { + version: 1, + outcome: "timeout", + lastMilestone: records.at(-1)?.milestone ?? "none", + timingBucket: windowsNativeTimingBucket(elapsed), + milestones: [], + }; + revalidateWindowsPowerShell(executable); + return proof; + } + if (result.error) throw stageError("spawn:error"); + if (result.signal) throw stageError("spawn:status"); + if (result.status !== 0) throw stageError(probeFailureStage(result.status)); + if ( + records.length !== WINDOWS_NATIVE_PROBE_MILESTONES.length + || records.some((record, index) => record.milestone !== WINDOWS_NATIVE_PROBE_MILESTONES[index]) + ) throw stageError("probe:output"); + const proof: WindowsNativeTimingProof = { + version: 1, + outcome: "complete", + lastMilestone: "standard-handle-identity", + // Script buckets separate the in-process stages; this parent bucket also + // includes executable startup before the first token can be written. + timingBucket: windowsNativeTimingBucket(elapsed), + milestones: records, + }; + revalidateWindowsPowerShell(executable); + return proof; + } finally { + closeSync(executable.fd); + } +} + +export function windowsInspectionEntryKind(kind: ConnectAuthorityEntryKind): "directory" | "file" { + return kind === "env" ? "file" : "directory"; +} diff --git a/packages/cli/src/desktopDiscovery.test.ts b/packages/cli/src/desktopDiscovery.test.ts new file mode 100644 index 000000000..f1ad66039 --- /dev/null +++ b/packages/cli/src/desktopDiscovery.test.ts @@ -0,0 +1,105 @@ +import assert from 'node:assert/strict'; +import { mkdtemp, rm } from 'node:fs/promises'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import { after, describe, test } from 'node:test'; +import { ConfigManager } from './config/ConfigManager.js'; +import { discoverConfiguredConnect } from './desktopDiscovery.js'; +import type { DesktopConnectDiscoverySmokeDiagnostic } from './desktopDiscovery.js'; +import type { ConnectStatusDocument } from './commands/connectCommand.js'; + +const directories: string[] = []; + +after(async () => { + await Promise.all(directories.splice(0).map(directory => rm(directory, { recursive: true, force: true }))); +}); + +describe('fixed desktop Connect discovery entry point', () => { + test('Linux configured discovery executes the target-native directory authority addon', { + skip: process.platform !== 'linux' || (process.arch !== 'x64' && process.arch !== 'arm64') + ? 'requires a packaged Linux native addon target' + : false, + }, async () => { + const parent = await mkdtemp(join(tmpdir(), 'propr-desktop-discovery-linux-')); + directories.push(parent); + const configRoot = join(parent, '.propr'); + const nativeRoot = join(parent, 'stack'); + const config = new ConfigManager(configRoot, { warn: () => undefined }); + await config.init(); + await config.setStackRoot(nativeRoot); + let receivedRoot: string | undefined; + const status: ConnectStatusDocument = { + schemaVersion: 1, + status: 'notReady', + canonicalEndpoint: null, + publicInstanceIdentity: null, + configured: false, + enabled: false, + sidecarRunning: false, + apiReady: false, + restartRequired: false, + compatibility: null, + version: null, + reasonCodes: ['NOT_CONFIGURED'], + }; + const diagnostics: DesktopConnectDiscoverySmokeDiagnostic[] = []; + + assert.equal(await discoverConfiguredConnect({ + configRoot, + platform: 'linux', + reportSmokeDiagnostic: diagnostic => diagnostics.push(diagnostic), + readStatus: async root => { + receivedRoot = root; + return status; + }, + }), status); + assert.equal(receivedRoot, nativeRoot); + assert.deepEqual(diagnostics, [ + { phase: 'config-read', code: 'STARTED' }, + { phase: 'config-read', code: 'PASSED' }, + { phase: 'addon-integrity-type', code: 'STARTED' }, + { phase: 'addon-integrity-type', code: 'PASSED' }, + { phase: 'addon-load', code: 'STARTED' }, + { phase: 'addon-load', code: 'PASSED' }, + { phase: 'descriptor-operation', code: 'STARTED' }, + { phase: 'descriptor-operation', code: 'PASSED' }, + { phase: 'status-resolution', code: 'STARTED' }, + { phase: 'status-resolution', code: 'PASSED' }, + ]); + }); + + test('ordinary Windows discovery reads only the saved native root from fixed config', async () => { + const parent = await mkdtemp(join(tmpdir(), 'propr-desktop-discovery-')); + directories.push(parent); + const configRoot = join(parent, '.propr'); + const nativeRoot = String.raw`C:\Users\standard\propr-stack`; + const config = new ConfigManager(configRoot, { warn: () => undefined }); + await config.init(); + await config.setStackRoot(nativeRoot); + let receivedRoot: string | undefined; + const status: ConnectStatusDocument = { + schemaVersion: 1, + status: 'notReady', + canonicalEndpoint: null, + publicInstanceIdentity: null, + configured: false, + enabled: false, + sidecarRunning: false, + apiReady: false, + restartRequired: false, + compatibility: null, + version: null, + reasonCodes: ['NOT_CONFIGURED'], + }; + + assert.equal(await discoverConfiguredConnect({ + configRoot, + platform: 'win32', + readStatus: async root => { + receivedRoot = root; + return status; + }, + }), status); + assert.equal(receivedRoot, nativeRoot); + }); +}); diff --git a/packages/cli/src/desktopDiscovery.ts b/packages/cli/src/desktopDiscovery.ts new file mode 100644 index 000000000..c189fd678 --- /dev/null +++ b/packages/cli/src/desktopDiscovery.ts @@ -0,0 +1,98 @@ +import { + getLocalConnectStatus, + type ConnectStatusDocument, + type LocalConnectStatusDependencies, +} from './commands/connectCommand.js'; +import { createConfigManager } from './config/index.js'; +import { + assertNativeDirectoryEntry, + type NativeDirectorySmokeFailureCategory, + type NativeDirectorySmokeSubstep, +} from './utils/directoryDescriptor.js'; + +export const DESKTOP_CONNECT_DISCOVERY_PLATFORMS: ReadonlySet = new Set([ + 'darwin', + 'linux', + 'win32', +]); + +export interface FixedConnectDiscoveryOptions { + /** Fixed CLI configuration directory selected by the trusted desktop main process. */ + configRoot: string; + platform?: NodeJS.Platform; + readStatus?: (root: string | undefined) => Promise; + /** @internal Packaged smoke keeps native authority real while replacing external network/process probes. */ + statusDependencies?: LocalConnectStatusDependencies; + /** @internal Packaged smoke emits only these fixed phase/code pairs. */ + reportSmokeDiagnostic?: (diagnostic: DesktopConnectDiscoverySmokeDiagnostic) => void; +} + +export type DesktopConnectDiscoverySmokePhase = + | 'config-read' + | 'addon-integrity-type' + | 'addon-load' + | 'descriptor-operation' + | 'authority-inspection' + | 'status-resolution'; + +export interface DesktopConnectDiscoverySmokeDiagnostic { + readonly phase: DesktopConnectDiscoverySmokePhase; + readonly code: 'STARTED' | 'PASSED' | 'FAILED'; + readonly substep?: NativeDirectorySmokeSubstep; + readonly category?: NativeDirectorySmokeFailureCategory; +} + +/** + * Read the configured native stack root from the fixed private CLI config and + * run the same authority-checked, secret-free discovery used by `propr connect + * status`. Neither root is returned to the caller. + */ +export async function discoverConfiguredConnect({ + configRoot, + platform = process.platform, + readStatus, + statusDependencies, + reportSmokeDiagnostic, +}: FixedConnectDiscoveryOptions): Promise { + if (!DESKTOP_CONNECT_DISCOVERY_PLATFORMS.has(platform)) { + throw new Error('Connect discovery is unavailable on this host'); + } + reportSmokeDiagnostic?.({ phase: 'config-read', code: 'STARTED' }); + let root: string | undefined; + try { + const config = await createConfigManager(configRoot, { + readOnly: true, + warn: () => undefined, + }); + root = config.getStackRoot(); + reportSmokeDiagnostic?.({ phase: 'config-read', code: 'PASSED' }); + } catch (error) { + reportSmokeDiagnostic?.({ phase: 'config-read', code: 'FAILED' }); + throw error; + } + if (platform === 'linux' && root !== undefined) { + assertNativeDirectoryEntry(configRoot, 'config.json', 'file', (phase, code, failure) => { + reportSmokeDiagnostic?.({ phase, code, ...failure }); + }); + } + if (readStatus) { + reportSmokeDiagnostic?.({ phase: 'status-resolution', code: 'STARTED' }); + try { + const result = await readStatus(root); + reportSmokeDiagnostic?.({ phase: 'status-resolution', code: 'PASSED' }); + return result; + } catch (error) { + reportSmokeDiagnostic?.({ phase: 'status-resolution', code: 'FAILED' }); + throw error; + } + } + return getLocalConnectStatus(root, { + ...statusDependencies, + reportSmokeDiagnostic: (phase, code) => { + statusDependencies?.reportSmokeDiagnostic?.(phase, code); + reportSmokeDiagnostic?.({ phase, code }); + }, + }); +} + +export type { ConnectStatusDocument } from './commands/connectCommand.js'; diff --git a/packages/cli/src/index.test.ts b/packages/cli/src/index.test.ts index aa1ae5f11..cd449d234 100644 --- a/packages/cli/src/index.test.ts +++ b/packages/cli/src/index.test.ts @@ -1,8 +1,49 @@ import assert from 'node:assert/strict'; import { spawnSync } from 'node:child_process'; -import { readFileSync } from 'node:fs'; +import { mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; import { fileURLToPath } from 'node:url'; import test from 'node:test'; +import { + hasExactlyOneExplicitConnectStatusRoot, + isExplicitConnectStatusInvocation, +} from './index.js'; + +test('every Connect status argument shape is identified before dotenv or option validation', () => { + for (const args of [ + ['connect', 'status', '--json'], + ['connect', 'status', '--json', '--root'], + ['connect', 'status', '--json', '--root='], + ['connect', 'status', '--root', '/one', '--root', '/two', '--json'], + ['--project', 'owner/repo', 'connect', 'status', '--root=/one', '-j'], + ['connect', 'status', '--json', '--', '--root', '/ignored'], + ['connect', 'status', '--root=/one', '--', '--root=/ignored'], + ]) assert.equal(isExplicitConnectStatusInvocation(['node', 'propr', ...args]), true, args.join(' ')); + + for (const args of [ + ['connect', '--', 'status', '--json', '--root=/ignored'], + ['--', 'connect', 'status', '--json', '--root=/ignored'], + ]) assert.equal(isExplicitConnectStatusInvocation(['node', 'propr', ...args]), false, args.join(' ')); + + for (const args of [ + ['connect', 'status', '--json'], + ['connect', 'status', '--json', '--root'], + ['connect', 'status', '--json', '--root='], + ['connect', 'status', '--json', '--root', ''], + ['connect', 'status', '--root', '/one', '--root', '/two', '--json'], + ['connect', 'status', '--root=/one', '--root=/two', '--json'], + ['connect', 'status', '--json', '--', '--root', '/ignored'], + ['connect', 'status', '--json', '--', '--root=/ignored'], + ]) assert.equal(hasExactlyOneExplicitConnectStatusRoot(['node', 'propr', ...args]), false, args.join(' ')); + + for (const args of [ + ['connect', 'status', '--json', '--root', '/one'], + ['--project', 'owner/repo', 'connect', 'status', '--root=/one', '-j'], + ['connect', 'status', '--json', '--root', '/one', '--', '--root', '/ignored'], + ['connect', 'status', '--root=/one', '--', '--root=/ignored', '--help'], + ]) assert.equal(hasExactlyOneExplicitConnectStatusRoot(['node', 'propr', ...args]), true, args.join(' ')); +}); test('direct CLI execution is not disabled by test environment variables', () => { const entryPoint = fileURLToPath(new URL('./index.ts', import.meta.url)); @@ -18,4 +59,38 @@ test('direct CLI execution is not disabled by test environment variables', () => assert.equal(result.status, 0, result.stderr); const packageVersion = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8')).version; assert.equal(result.stdout.trim(), packageVersion); + + const builtEntryPoint = fileURLToPath(new URL('../dist/index.js', import.meta.url)); + const hostileCwd = mkdtempSync(join(tmpdir(), 'propr-connect-help-')); + writeFileSync(join(hostileCwd, '.env'), [ + 'PROPR_STACK=help-cwd-stack-SENTINEL', + 'HOST_DATA_DIR=${HELP_CWD_SECRET_SENTINEL}', + ].join('\n')); + try { + for (const args of [ + ['connect', 'status', '--help'], + ['connect', 'status', '-h'], + ['connect', 'status', '--help', '--json', '--root'], + ['connect', 'status', '--json', '--root', '--help'], + ['connect', 'status', '--root=/one', '-h', '--root=/two', '--json'], + ['--project', 'owner/repo', 'connect', 'status', '--root=', '--json', '-h'], + ['connect', 'status', '--json', '--help', '--', '--root=/ignored'], + ]) { + const help = spawnSync(process.execPath, [builtEntryPoint, ...args], { + cwd: hostileCwd, + encoding: 'utf8', + env: { ...process.env, HELP_CWD_SECRET_SENTINEL: 'never-print-this-SENTINEL' }, + }); + assert.equal(help.status, 0, `${args.join(' ')}\n${help.stderr}`); + assert.equal(help.stderr, '', args.join(' ')); + assert.match(help.stdout, /^Usage: propr connect status \[options\]$/m, args.join(' ')); + assert.match(help.stdout, /Print the versioned secret-free desktop discovery contract/, args.join(' ')); + assert.match(help.stdout, /-h, --help\s+display help for command/, args.join(' ')); + assert.equal(help.stdout.includes('"schemaVersion"'), false, args.join(' ')); + assert.equal(help.stdout.includes('INVALID_ROOT'), false, args.join(' ')); + assert.equal(help.stdout.includes('SENTINEL'), false, args.join(' ')); + } + } finally { + rmSync(hostileCwd, { recursive: true, force: true }); + } }); diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts index e88da6066..d80c4a96d 100644 --- a/packages/cli/src/index.ts +++ b/packages/cli/src/index.ts @@ -37,6 +37,7 @@ import { createUiCommand, createDocsCommand, createTunnelCommand, + createConnectCommand, createTankCommand, createRelayCommand, createRuntimeCommand, @@ -44,6 +45,10 @@ import { printChecks, STACK_CONFIG_CHECK_NAME, } from "./commands/index.js"; +import { + CONNECT_STATUS_EXIT, + invalidConnectRootStatus, +} from "./commands/connectCommand.js"; // Re-export completion generation for programmatic use export { completionScript, buildCompletionMetadata } from "./completion.js"; @@ -111,8 +116,72 @@ export type { FormatOutputOptions, } from "./utils/index.js"; -// Load environment variables -config(); +/** Return only raw CLI arguments which precede the POSIX end-of-options marker. */ +function argsBeforeEndOfOptions(argv: readonly string[]): readonly string[] { + const args = argv.slice(2); + const delimiterIndex = args.indexOf("--"); + return delimiterIndex === -1 ? args : args.slice(0, delimiterIndex); +} + +/** Parse the discovery shape without depending on option order or spelling. */ +export function isExplicitConnectStatusInvocation(argv: readonly string[]): boolean { + const args = argsBeforeEndOfOptions(argv); + const positionals: string[] = []; + for (let index = 0; index < args.length; index += 1) { + const arg = args[index]; + if (arg === "--root") { + const value = args[index + 1]; + if (value !== undefined && value !== "" && !value.startsWith("-")) { + index += 1; + } + continue; + } + if (arg.startsWith("--root=")) { + continue; + } + if (arg === "--project" || arg === "-p") { + index += 1; + continue; + } + if (arg.startsWith("--project=") || arg === "--json" || arg === "-j") continue; + if (!arg.startsWith("-")) positionals.push(arg); + } + return positionals[0] === "connect" && positionals[1] === "status"; +} + +/** Require one non-empty raw root option before Commander can reject or overwrite it. */ +export function hasExactlyOneExplicitConnectStatusRoot(argv: readonly string[]): boolean { + if (!isExplicitConnectStatusInvocation(argv)) return false; + const args = argsBeforeEndOfOptions(argv); + let rootCount = 0; + let rootIsValid = true; + for (let index = 0; index < args.length; index += 1) { + const arg = args[index]; + if (arg === "--root") { + rootCount += 1; + const value = args[index + 1]; + if (value === undefined || value === "" || value.startsWith("-")) { + rootIsValid = false; + } else { + index += 1; + } + } else if (arg.startsWith("--root=")) { + rootCount += 1; + if (arg.slice("--root=".length).length === 0) rootIsValid = false; + } + } + return rootCount === 1 && rootIsValid; +} + +// Identify the command shape before Commander validates required, malformed, or +// duplicate root options. Every Connect status invocation (and therefore every +// --json failure shape) must avoid pre-reading a replaceable cwd/.env. +const connectStatusInvocation = isExplicitConnectStatusInvocation(process.argv); +const connectStatusHelpRequested = connectStatusInvocation + && argsBeforeEndOfOptions(process.argv).some((arg) => arg === "--help" || arg === "-h"); +const malformedConnectStatusRoot = connectStatusInvocation + && !hasExactlyOneExplicitConnectStatusRoot(process.argv); +if (!connectStatusInvocation) config(); const packageJson = JSON.parse( readFileSync(join(dirname(fileURLToPath(import.meta.url)), "..", "package.json"), "utf8") @@ -342,6 +411,7 @@ program.addCommand(createStopCommand()); program.addCommand(createUiCommand()); program.addCommand(createDocsCommand()); program.addCommand(createTunnelCommand()); +program.addCommand(createConnectCommand()); program.addCommand(createTankCommand()); program.addCommand(createRelayCommand()); program.addCommand(createRuntimeCommand()); @@ -394,6 +464,15 @@ if (isCliEntryPoint() && !process.argv.slice(2).length) { process.exit(1); } })(); +} else if (isCliEntryPoint() && connectStatusHelpRequested) { + // Parse a canonical help shape so a malformed `--root` cannot consume the + // help flag as its required value. Commander remains the help authority. + program.parse([...process.argv.slice(0, 2), "connect", "status", "--help"]); +} else if (isCliEntryPoint() && malformedConnectStatusRoot) { + const document = invalidConnectRootStatus(); + process.stdout.write(`${JSON.stringify(document)}\n`); + process.stderr.write(`ProPR Connect discovery: ${document.status}.\n`); + process.exitCode = CONNECT_STATUS_EXIT[document.status]; } else if (isCliEntryPoint()) { program.parse(); } diff --git a/packages/cli/src/orchestrator/index.test.ts b/packages/cli/src/orchestrator/index.test.ts index a079ec281..129adb49b 100644 --- a/packages/cli/src/orchestrator/index.test.ts +++ b/packages/cli/src/orchestrator/index.test.ts @@ -4,7 +4,7 @@ import { tmpdir } from "node:os"; import { join } from "node:path"; import { test } from "node:test"; import { ConfigManager } from "../config/ConfigManager.js"; -import { getHostConfig } from "./index.js"; +import { connectExecutionEnvironment, getHostConfig } from "./index.js"; function createStackRoot(parent: string, name: string): string { const root = join(parent, name); @@ -47,3 +47,68 @@ test("explicit new root does not inherit legacy tunnel intent during start prefl rmSync(tempDir, { recursive: true, force: true }); } }); + +test("Connect forwards only validated Docker transport and process bootstrap variables", () => { + const windows = process.platform === "win32"; + const platform = windows ? "win32" : process.platform; + const path = windows ? "C:\\trusted\\bin" : "/trusted/bin"; + const certPath = windows ? "C:\\private\\certs" : "/private/certs"; + const configPath = windows ? "C:\\private\\docker-config" : "/private/docker-config"; + const sshSocket = windows ? "\\\\.\\pipe\\trusted-ssh-agent" : "/trusted/ssh-agent"; + const platformHome = windows ? { USERPROFILE: "C:\\Users\\trusted" } : { HOME: "/trusted/home" }; + const environment = connectExecutionEnvironment({ + PATH: path, + DOCKER_HOST: "ssh://docker.example.test", + DOCKER_CONTEXT: "remote-context", + DOCKER_TLS: "1", + DOCKER_TLS_VERIFY: "1", + DOCKER_CERT_PATH: certPath, + DOCKER_CONFIG: configPath, + PROPR_UI_TUNNEL_TOKEN: "must-not-cross", + ...platformHome, + HOME: windows ? "/must/not/cross" : platformHome.HOME, + SSH_AUTH_SOCK: sshSocket, + DOCKER_AUTH_CONFIG: "must-not-cross", + NODE_OPTIONS: "must-not-cross", + HTTPS_PROXY: "must-not-cross", + }, platform); + assert.deepEqual(environment, { + PATH: path, + DOCKER_HOST: "ssh://docker.example.test", + DOCKER_CONTEXT: "remote-context", + DOCKER_TLS: "1", + DOCKER_TLS_VERIFY: "1", + DOCKER_CERT_PATH: certPath, + DOCKER_CONFIG: configPath, + ...platformHome, + SSH_AUTH_SOCK: sshSocket, + }); + for (const invalid of [ + { DOCKER_HOST: "x".repeat(4097) }, + { DOCKER_CONTEXT: "x".repeat(256) }, + { DOCKER_CONTEXT: "é".repeat(128) }, + { DOCKER_TLS: "" }, + { DOCKER_TLS: "x".repeat(17) }, + { DOCKER_CERT_PATH: "private\0path" }, + { DOCKER_CONFIG: 42 }, + { DOCKER_TLS_VERIFY: "" }, + ]) assert.throws(() => connectExecutionEnvironment(invalid, platform), /environment/); + + assert.deepEqual(connectExecutionEnvironment({ + PATH: "C:\\trusted\\bin", + HOMEDRIVE: "C:", + HOMEPATH: "\\Users\\trusted", + HOME: "/must/not/cross", + }, "win32"), { + PATH: "C:\\trusted\\bin", + HOMEDRIVE: "C:", + HOMEPATH: "\\Users\\trusted", + }); + for (const invalidHome of [ + { USERPROFILE: "relative" }, + { HOMEDRIVE: "C:" }, + { HOMEPATH: "\\Users\\trusted" }, + { HOMEDRIVE: "relative", HOMEPATH: "\\Users\\trusted" }, + { HOMEDRIVE: "C:", HOMEPATH: "relative" }, + ]) assert.throws(() => connectExecutionEnvironment(invalidHome, "win32"), /platform environment/); +}); diff --git a/packages/cli/src/orchestrator/index.ts b/packages/cli/src/orchestrator/index.ts index 5d1a9b86a..0cdaffea7 100644 --- a/packages/cli/src/orchestrator/index.ts +++ b/packages/cli/src/orchestrator/index.ts @@ -9,7 +9,7 @@ import { existsSync } from "node:fs"; import { fileURLToPath, pathToFileURL } from "node:url"; -import { dirname, join, resolve } from "node:path"; +import { delimiter, dirname, join, posix, resolve, win32 } from "node:path"; import type { OrchestratorConfig, OrchestratorModule } from "./types.js"; import type { ConfigManager } from "../config/index.js"; @@ -130,3 +130,191 @@ export async function getHostConfig(opts: { const cfg = orch.resolveHostConfig({ rootDir, env: process.env, manifestPath, cliOverrides }); return { orch, cfg, rootDir }; } + +export interface ConnectHostConfigSnapshotInput { + requestedRoot: string; + envFileValues: Readonly>; +} + +/** + * Load all code/manifest state before Connect acquires root authority. The + * returned resolver is synchronous so authorized root bytes never cross an + * await boundary. + */ +const CONNECT_DOCKER_ENV_LIMITS = { + DOCKER_HOST: 4096, + DOCKER_CONTEXT: 255, + // Docker treats any non-empty value as enabling TLS. Keep the value bounded + // while preserving that documented transport-selection behavior. + DOCKER_TLS: 16, + DOCKER_TLS_VERIFY: 16, + DOCKER_CERT_PATH: 4096, + DOCKER_CONFIG: 4096, +} as const; + +function environmentString(source: Readonly>, name: string, maximum = 4096): string | undefined { + const value = source[name]; + if (value === undefined) return undefined; + if ( + typeof value !== "string" + || value.length === 0 + || value.includes("\0") + || /[\r\n]/.test(value) + || Buffer.byteLength(value, "utf8") > maximum + ) throw new Error("Connect process environment is invalid"); + return value; +} + +function platformPath(value: string, platform: NodeJS.Platform): boolean { + return platform === "win32" ? win32.isAbsolute(value) : posix.isAbsolute(value); +} + +function validateSearchPath(value: string, platform: NodeJS.Platform): void { + const separator = platform === "win32" ? ";" : delimiter; + const entries = value.split(separator); + if (entries.length === 0 || entries.some((entry) => !entry || !platformPath(entry, platform))) { + throw new Error("Connect executable search environment is invalid"); + } +} + +function validateDockerHost(value: string, platform: NodeJS.Platform): void { + try { + const parsed = new URL(value); + if (parsed.password || parsed.search || parsed.hash) throw new Error(); + if (parsed.protocol === "unix:") { + if (platform === "win32" || parsed.hostname || !posix.isAbsolute(parsed.pathname)) throw new Error(); + return; + } + if (parsed.protocol === "npipe:") { + if (platform !== "win32" || !/^\/\/\.\/pipe\/[A-Za-z0-9_.-]+$/.test(parsed.pathname)) throw new Error(); + return; + } + if (parsed.protocol === "tcp:" || parsed.protocol === "http:" || parsed.protocol === "https:") { + if (parsed.username || !parsed.hostname || (parsed.pathname !== "" && parsed.pathname !== "/")) throw new Error(); + return; + } + if (parsed.protocol === "ssh:") { + if (!parsed.hostname || parsed.pathname !== "" && parsed.pathname !== "/") throw new Error(); + return; + } + } catch { + // Fall through to the single fixed redacted validation error below. + } + throw new Error("Connect Docker transport environment is invalid"); +} + +/** + * Discovery needs executable lookup, OS bootstrap variables, and the trusted + * parent process's documented Docker transport selection. ProPR/configuration + * variables remain absent: the explicit root snapshot is their sole authority. + */ +export function connectExecutionEnvironment( + source: Readonly>, + platform: NodeJS.Platform = process.platform, +): NodeJS.ProcessEnv { + if (platform !== "linux" && platform !== "darwin" && platform !== "win32") { + throw new Error("Connect process environment is invalid"); + } + const allowed: NodeJS.ProcessEnv = {}; + const bootstrap = platform === "win32" + ? ["PATH", "PATHEXT", "SYSTEMROOT", "WINDIR", "COMSPEC", "TMP", "TEMP"] as const + : ["PATH", "TMPDIR", "TMP", "TEMP", "HOME"] as const; + for (const name of bootstrap) { + const value = environmentString(source, name); + if (value === undefined) continue; + if (name === "PATH") validateSearchPath(value, platform); + else if (name === "PATHEXT") { + if (!value.split(";").every((entry) => /^\.[A-Za-z0-9]{1,16}$/.test(entry))) { + throw new Error("Connect executable search environment is invalid"); + } + } else if (!platformPath(value, platform)) { + throw new Error("Connect platform environment is invalid"); + } + allowed[name] = value; + } + if (platform === "win32") { + const userProfile = environmentString(source, "USERPROFILE"); + const homeDrive = environmentString(source, "HOMEDRIVE"); + const homePath = environmentString(source, "HOMEPATH"); + if (userProfile !== undefined) { + if (!win32.isAbsolute(userProfile)) throw new Error("Connect platform environment is invalid"); + allowed.USERPROFILE = userProfile; + } else if (homeDrive !== undefined || homePath !== undefined) { + if (!homeDrive || !/^[A-Za-z]:$/.test(homeDrive) || !homePath || !win32.isAbsolute(homePath)) { + throw new Error("Connect platform environment is invalid"); + } + allowed.HOMEDRIVE = homeDrive; + allowed.HOMEPATH = homePath; + } + } + for (const [name, maximum] of Object.entries(CONNECT_DOCKER_ENV_LIMITS)) { + const value = environmentString(source, name, maximum); + if (value === undefined) continue; + if (name === "DOCKER_HOST") validateDockerHost(value, platform); + else if (name === "DOCKER_CONTEXT" && !/^[A-Za-z0-9][A-Za-z0-9_.-]{0,254}$/.test(value)) { + throw new Error("Connect Docker transport environment is invalid"); + } else if (name === "DOCKER_TLS_VERIFY" && value !== "0" && value !== "1") { + throw new Error("Connect Docker transport environment is invalid"); + } else if ((name === "DOCKER_CERT_PATH" || name === "DOCKER_CONFIG") && !platformPath(value, platform)) { + throw new Error("Connect Docker transport environment is invalid"); + } + allowed[name] = value; + } + // A named context may itself select an ssh endpoint; without opening Docker's + // config here, preserving the socket when a context is explicit is the + // narrowest way to keep those documented contexts functional. + if (allowed.DOCKER_HOST?.startsWith("ssh://") || allowed.DOCKER_CONTEXT !== undefined) { + const socket = environmentString(source, "SSH_AUTH_SOCK"); + if (socket !== undefined) { + const valid = platform === "win32" + ? win32.isAbsolute(socket) || /^\\\\\.\\pipe\\[A-Za-z0-9_.-]+$/.test(socket) + : posix.isAbsolute(socket); + if (!valid) throw new Error("Connect SSH transport environment is invalid"); + allowed.SSH_AUTH_SOCK = socket; + } + } + return allowed; +} + +export async function prepareConnectHostConfig(): Promise<{ + orch: OrchestratorModule; + parseEnvFile(contents: string): Record; + resolveSnapshot(input: ConnectHostConfigSnapshotInput): OrchestratorConfig; + inspectTunnel(cfg: OrchestratorConfig): { kind: "ok"; running: boolean } | { kind: "internalFailure" }; +}> { + const orch = await loadOrchestrator(); + const orchPath = cachedPath ?? resolveOrchestratorPath(); + const manifestPath = resolveManifestPath(orchPath); + if (!manifestPath) { + throw new Error("Connect host configuration manifest is unavailable"); + } + const executionEnv = connectExecutionEnvironment(process.env); + return { + orch, + parseEnvFile: (contents) => orch.parseEnvFileContents(contents), + resolveSnapshot: ({ requestedRoot, envFileValues }) => { + return orch.resolveConfig(executionEnv, { + envFileValues, + stack: envFileValues.PROPR_STACK || "propr", + network: envFileValues.PROPR_NETWORK + || `${envFileValues.PROPR_STACK || "propr"}-net`, + envFileLocal: join(requestedRoot, ".env"), + envFileHost: join(requestedRoot, ".env"), + hostData: join(requestedRoot, "data"), + hostLogs: join(requestedRoot, "logs"), + hostRepos: join(requestedRoot, "repos"), + managedCredentialsDir: join(requestedRoot, "data", "agent-credentials"), + validateHostPaths: true, + manifestPath, + }); + }, + inspectTunnel: (cfg) => { + const inspection = orch.inspectStackStatus(cfg, { timeout: 3000, env: executionEnv }); + if (!inspection.status) return { kind: "internalFailure" }; + return { + kind: "ok", + running: Boolean(inspection.status.services.find((service) => service.service === "tunnel")?.running), + }; + }, + }; +} diff --git a/packages/cli/src/orchestrator/types.ts b/packages/cli/src/orchestrator/types.ts index 2a1160d7c..b4e660fe6 100644 --- a/packages/cli/src/orchestrator/types.ts +++ b/packages/cli/src/orchestrator/types.ts @@ -54,12 +54,15 @@ export interface OrchestratorConfig { readonly cloudflaredImage: string; /** Immediate socket peers whose forwarded client/protocol headers the API trusts. */ readonly trustedProxyPeers?: string; + /** Public origin injected into the running API container. */ + readonly apiPublicUrl: string; /** * Hosted UI origin allowed by CORS/redirects. Always resolves to a value: * an explicit FRONTEND_URL, the hosted origin in tunnel mode, or the * localhost UI default for local development. */ readonly frontendUrl: string; + readonly ghOauthCallbackUrl: string; readonly mistralApiKey?: string; readonly vibeConfigPath?: string; readonly manifest: { version: string; images: Record } & Record; @@ -116,6 +119,8 @@ export type ImageFreshnessResult = export interface DockerCommandOptions { capture?: boolean; timeout?: number; + env?: NodeJS.ProcessEnv; + maxBuffer?: number; } export interface DockerCommandResult { @@ -126,6 +131,11 @@ export interface DockerCommandResult { signal?: NodeJS.Signals | null; } +export interface StackStatusInspection { + result: DockerCommandResult; + status?: StackStatus; +} + export interface ResolveHostConfigOptions { rootDir?: string; env?: NodeJS.ProcessEnv; @@ -133,6 +143,10 @@ export interface ResolveHostConfigOptions { cliOverrides?: Record; } +export interface ResolveConfigOverrides extends Partial { + envFileValues?: Readonly>; +} + export interface OnLogOption { onLog?: (line: string) => void; pull?: boolean; @@ -141,9 +155,10 @@ export interface OnLogOption { /** Public surface of orchestrator.mjs consumed by the CLI. */ export interface OrchestratorModule { - resolveConfig(env?: NodeJS.ProcessEnv, overrides?: Partial): OrchestratorConfig; + resolveConfig(env?: NodeJS.ProcessEnv, overrides?: ResolveConfigOverrides): OrchestratorConfig; resolveHostConfig(opts?: ResolveHostConfigOptions): OrchestratorConfig; readEnvFile(envFilePath: string): Record; + parseEnvFileContents(contents: string): Record; validateEnv(cfg: OrchestratorConfig): ValidationResult; validateDockerBindPath(name: string, value?: string, opts?: { containerPath?: boolean }): string | null; @@ -195,12 +210,16 @@ export interface OrchestratorModule { opts?: { remove?: boolean; removeNetwork?: boolean; onLog?: (line: string) => void } ): { failed: string[] }; - getStackStatus(cfg: OrchestratorConfig): StackStatus; + getStackStatus(cfg: OrchestratorConfig, opts?: { timeout?: number }): StackStatus; + inspectStackStatus( + cfg: OrchestratorConfig, + opts?: { timeout?: number; env?: NodeJS.ProcessEnv } + ): StackStatusInspection; getStackStatusAsync(cfg: OrchestratorConfig): Promise; /** Pure parse of `docker ps` tab-separated output into per-service state. */ parseStackStatus(cfg: OrchestratorConfig, stdout: string): StackStatus; getTunnelStatus(cfg: OrchestratorConfig, stackStatus?: StackStatus): Promise; - getServiceState(cfg: OrchestratorConfig, service: string): ServiceState | undefined; + getServiceState(cfg: OrchestratorConfig, service: string, opts?: { timeout?: number }): ServiceState | undefined; getServiceLogs( cfg: OrchestratorConfig, service: string, diff --git a/packages/cli/src/utils/directoryDescriptor.ts b/packages/cli/src/utils/directoryDescriptor.ts index aa5a78515..3b564fa7c 100644 --- a/packages/cli/src/utils/directoryDescriptor.ts +++ b/packages/cli/src/utils/directoryDescriptor.ts @@ -1,8 +1,13 @@ import { createHash } from "node:crypto"; -import { existsSync, readFileSync } from "node:fs"; +import { closeSync, constants, existsSync, fstatSync, lstatSync, openSync, readFileSync } from "node:fs"; import { createRequire } from "node:module"; import { dirname, join } from "node:path"; import { fileURLToPath } from "node:url"; +import { + assertCanonicalNativeArtifactParents, + isPackagedNativeArtifactResolution, + physicalNativeArtifactCandidate, +} from "./nativeArtifact.js"; export type DirectoryDescriptorAccess = "child-paths" | "native-at"; @@ -32,26 +37,82 @@ export interface NativeDirectoryOperationTestEvent { result?: number; } +export type NativeDirectorySmokePhase = "addon-integrity-type" | "addon-load" | "descriptor-operation"; +export type NativeDirectorySmokeCode = "STARTED" | "PASSED" | "FAILED"; +export type NativeDirectorySmokeSubstep = "directory-open" | "addon-open" | "fstat-type"; +export type NativeDirectorySmokeFailureCategory = + | "access-denied" + | "invalid-argument" + | "io-failure" + | "missing-entry" + | "not-directory" + | "symlink-refused" + | "type-mismatch" + | "unexpected"; +export type NativeDirectorySmokeDiagnostic = ( + phase: NativeDirectorySmokePhase, + code: NativeDirectorySmokeCode, + failure?: Readonly<{ + substep: NativeDirectorySmokeSubstep; + category: NativeDirectorySmokeFailureCategory; + }>, +) => void; + type NativeDirectoryOperationTestHook = (event: NativeDirectoryOperationTestEvent) => void; +export type NativeDirectoryOpenTestPhase = + | "before-primary-open" + | "after-fallback-before-lstat" + | "before-directory-fallback-open" + | "before-readonly-fallback-open" + | "after-fallback-open" + | "after-fallback-fstat" + | "after-fallback-after-lstat"; + +type NativeDirectoryOpenTestHook = (phase: NativeDirectoryOpenTestPhase, directory: string) => void; + export const DARWIN_DIRECTORY_OPERATION_SHA256: Readonly> = { arm64: "88f07c0c7a4371f4fb227a4691009d09517de582ba49297d28d03ac94e586615", x64: "62183c0f4083cb8c98e09e2d2c688f8f81703e12b0f22320c335b51e927eaf53", }; export const LINUX_DIRECTORY_OPERATION_SHA256: Readonly> = { - arm64: "29b28b76ed8781f2567897ad9ba576798bbb669937048218e0416601788e0f1c", + arm64: "916679f413251c4b23c51167987a874bbbdd9d96991882bfac9093e0ea5fa051", x64: "7199378f1c7b443a05c596eae7c66f9a77cc01b4a493c07748df0df1083950f6", }; let nativeOperations: NativeDirectoryOperations | undefined; let nativeOperationTestHook: NativeDirectoryOperationTestHook | undefined; +let nativeDirectoryOpenTestHook: NativeDirectoryOpenTestHook | undefined; +let nativeDirectoryOpenFallbackTestEnabled = false; + +function smokeFailureCategory(error: unknown): NativeDirectorySmokeFailureCategory { + const code = error && typeof error === "object" && "code" in error + ? (error as { code?: unknown }).code + : undefined; + if (code === "EACCES" || code === "EPERM") return "access-denied"; + if (code === "EINVAL") return "invalid-argument"; + if (code === "EIO") return "io-failure"; + if (code === "ENOENT") return "missing-entry"; + if (code === "ENOTDIR") return "not-directory"; + if (code === "ELOOP") return "symlink-refused"; + return "unexpected"; +} /** Install a deterministic race injector around a native descriptor-operation boundary. */ export function setNativeDirectoryOperationTestHook(hook?: NativeDirectoryOperationTestHook): void { nativeOperationTestHook = hook; } +/** Install a deterministic test-only injector around the native authority directory open. */ +export function setNativeDirectoryOpenTestHook( + hook?: NativeDirectoryOpenTestHook, + enableLinuxArm64Fallback = false, +): void { + nativeDirectoryOpenTestHook = hook; + nativeDirectoryOpenFallbackTestEnabled = hook !== undefined && enableLinuxArm64Fallback; +} + /** Linux has traversable procfs dirfds; Darwin uses the packaged *at addon. */ export function directoryDescriptorAccess(platform: NodeJS.Platform = process.platform): DirectoryDescriptorAccess { if (platform === "linux") return "child-paths"; @@ -72,11 +133,19 @@ function nativeArtifactPath(platform: NodeJS.Platform, arch: string): string { const candidates = [ join(moduleDirectory, "..", "native", relativeArtifact), join(moduleDirectory, "..", "..", "native", relativeArtifact), - ]; - const artifact = candidates.find((candidate) => existsSync(candidate)); + ].map((logicalPath) => { + const path = physicalNativeArtifactCandidate(logicalPath); + return { path, packaged: isPackagedNativeArtifactResolution(logicalPath, path) }; + }); + const artifact = candidates.find((candidate) => existsSync(candidate.path)); if (!artifact) throw new Error(`packaged ${platform} directory-operations artifact is missing for ${arch}`); - verifyDirectoryOperationArtifact(artifact, expected, `${platform}-${arch}`); - return artifact; + if (artifact.packaged) assertCanonicalNativeArtifactParents(artifact.path); + const named = lstatSync(artifact.path); + if (!named.isFile() || named.isSymbolicLink() || (artifact.packaged && (named.mode & 0o022) !== 0)) { + throw new Error(`packaged directory-operations artifact failed type verification for ${platform}-${arch}`); + } + verifyDirectoryOperationArtifact(artifact.path, expected, `${platform}-${arch}`); + return artifact.path; } export function verifyDirectoryOperationArtifact(artifact: string, expected: string, arch: string): void { @@ -86,14 +155,160 @@ export function verifyDirectoryOperationArtifact(artifact: string, expected: str } } -function hostOperations(): NativeDirectoryOperations { +function hostOperations(reportSmokeDiagnostic?: NativeDirectorySmokeDiagnostic): NativeDirectoryOperations { if (process.platform !== "darwin" && process.platform !== "linux") { throw new Error(`native directory operations were requested on unsupported platform ${process.platform}`); } - nativeOperations ??= createRequire(import.meta.url)(nativeArtifactPath(process.platform, process.arch)) as NativeDirectoryOperations; + reportSmokeDiagnostic?.("addon-integrity-type", "STARTED"); + let artifact: string; + try { + artifact = nativeArtifactPath(process.platform, process.arch); + reportSmokeDiagnostic?.("addon-integrity-type", "PASSED"); + } catch (error) { + reportSmokeDiagnostic?.("addon-integrity-type", "FAILED"); + throw error; + } + reportSmokeDiagnostic?.("addon-load", "STARTED"); + try { + nativeOperations ??= createRequire(import.meta.url)(artifact) as NativeDirectoryOperations; + reportSmokeDiagnostic?.("addon-load", "PASSED"); + } catch (error) { + reportSmokeDiagnostic?.("addon-load", "FAILED"); + throw error; + } return nativeOperations; } +function errorCode(error: unknown): unknown { + return error && typeof error === "object" && "code" in error + ? (error as { code?: unknown }).code + : undefined; +} + +function sameDirectoryIdentity( + left: Readonly<{ dev: number | bigint; ino: number | bigint }>, + right: Readonly<{ dev: number | bigint; ino: number | bigint }>, +): boolean { + return left.dev === right.dev && left.ino === right.ino; +} + +/** + * Open and pin the authority directory. Some Linux ARM64 hosts reject the + * strict directory/no-follow flag combination with EINVAL, and some also + * reject O_DIRECTORY before inspecting the authority. Only those consecutive + * EINVAL failures on Linux ARM64 may progressively drop O_NOFOLLOW and then + * O_DIRECTORY. Every compatibility descriptor must identify the exact same + * non-link directory before and after it is opened. + */ +export function openAuthorityDirectoryNoFollow( + directory: string, + openDirectory: (flags: number) => number = flags => openSync(directory, flags), +): number { + try { + nativeDirectoryOpenTestHook?.("before-primary-open", directory); + return openDirectory(constants.O_RDONLY | constants.O_DIRECTORY | constants.O_NOFOLLOW); + } catch (error) { + const isLinuxArm64 = process.platform === "linux" && process.arch === "arm64"; + if ((!isLinuxArm64 && !nativeDirectoryOpenFallbackTestEnabled) || errorCode(error) !== "EINVAL") throw error; + } + + nativeDirectoryOpenTestHook?.("after-fallback-before-lstat", directory); + const before = lstatSync(directory, { bigint: true }); + if (!before.isDirectory() || before.isSymbolicLink()) { + throw new Error("directory authority entry was not a non-link directory before open"); + } + + let directoryFd: number | undefined; + try { + try { + nativeDirectoryOpenTestHook?.("before-directory-fallback-open", directory); + directoryFd = openDirectory(constants.O_RDONLY | constants.O_DIRECTORY); + } catch (error) { + if (errorCode(error) !== "EINVAL") throw error; + nativeDirectoryOpenTestHook?.("before-readonly-fallback-open", directory); + directoryFd = openDirectory(constants.O_RDONLY); + } + nativeDirectoryOpenTestHook?.("after-fallback-open", directory); + const opened = fstatSync(directoryFd, { bigint: true }); + nativeDirectoryOpenTestHook?.("after-fallback-fstat", directory); + const after = lstatSync(directory, { bigint: true }); + nativeDirectoryOpenTestHook?.("after-fallback-after-lstat", directory); + if (!opened.isDirectory() + || !after.isDirectory() + || after.isSymbolicLink() + || !sameDirectoryIdentity(before, opened) + || !sameDirectoryIdentity(before, after) + || !sameDirectoryIdentity(opened, after)) { + throw new Error("directory authority entry changed during descriptor fallback"); + } + const result = directoryFd; + directoryFd = undefined; + return result; + } finally { + if (directoryFd !== undefined) closeSync(directoryFd); + } +} + +/** + * Load the integrity-pinned host addon and perform one descriptor-relative + * operation. Packaged desktop discovery uses this on Linux so acceptance binds + * the selected native artifact to the running main process, rather than merely + * inspecting a file copied into the package. + */ +export function assertNativeDirectoryEntry( + directory: string, + name: string, + expectedKind: DirectoryEntryIdentity['kind'], + reportSmokeDiagnostic?: NativeDirectorySmokeDiagnostic, +): void { + if (!/^[A-Za-z0-9._-]{1,128}$/.test(name) || name === '.' || name === '..') { + throw new Error('native directory authority entry name is invalid'); + } + const operations = hostOperations(reportSmokeDiagnostic); + reportSmokeDiagnostic?.("descriptor-operation", "STARTED"); + let directoryFd: number | undefined; + let entryFd: number | undefined; + let substep: NativeDirectorySmokeSubstep = "directory-open"; + let failureReported = false; + try { + directoryFd = openAuthorityDirectoryNoFollow(directory); + // Pin through the addon's descriptor-relative open, then let the host + // runtime inspect that descriptor. This avoids architecture-specific C + // stat ABI wrappers while retaining no-follow and exact-type authority. + substep = "addon-open"; + entryFd = operations.openAt(directoryFd, name, constants.O_RDONLY | constants.O_NOFOLLOW, 0); + substep = "fstat-type"; + const entry = fstatSync(entryFd); + const kind = entry.isFile() + ? "file" + : entry.isDirectory() + ? "directory" + : entry.isSymbolicLink() + ? "symbolic-link" + : "other"; + if (kind !== expectedKind) { + reportSmokeDiagnostic?.("descriptor-operation", "FAILED", { + substep, + category: "type-mismatch", + }); + failureReported = true; + throw new Error('native directory authority entry type did not match'); + } + reportSmokeDiagnostic?.("descriptor-operation", "PASSED"); + } catch (error) { + if (!failureReported) { + reportSmokeDiagnostic?.("descriptor-operation", "FAILED", { + substep, + category: smokeFailureCategory(error), + }); + } + throw error; + } finally { + if (entryFd !== undefined) closeSync(entryFd); + if (directoryFd !== undefined) closeSync(directoryFd); + } +} + export function openAt(dirfd: number, name: string, flags: number, mode = 0): number { const operations = hostOperations(); nativeOperationTestHook?.({ operation: "openAt", phase: "before", dirfd, name, flags, mode }); diff --git a/packages/cli/src/utils/nativeArtifact.test.ts b/packages/cli/src/utils/nativeArtifact.test.ts new file mode 100644 index 000000000..327559bfb --- /dev/null +++ b/packages/cli/src/utils/nativeArtifact.test.ts @@ -0,0 +1,42 @@ +import assert from 'node:assert/strict'; +import { mkdirSync, mkdtempSync, realpathSync, rmSync, symlinkSync, writeFileSync } from 'node:fs'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import { test } from 'node:test'; +import { + assertCanonicalNativeArtifactParents, + isPackagedNativeArtifactResolution, + physicalNativeArtifactCandidate, +} from './nativeArtifact.js'; + +test('packaged native artifact candidates resolve to the physical non-ASAR resource', () => { + const logical = join('/Applications/ProPR.app/Contents/Resources/app.asar', '.vite/native/broker'); + const physical = join('/Applications/ProPR.app/Contents/Resources/app.asar.unpacked', '.vite/native/broker'); + assert.equal( + physicalNativeArtifactCandidate(logical), + physical, + ); + assert.equal(isPackagedNativeArtifactResolution(logical, physical), true); + assert.equal(isPackagedNativeArtifactResolution(physical, physical), false); + assert.equal(isPackagedNativeArtifactResolution(join('/workspace', 'native', 'broker'), join('/workspace', 'native', 'broker')), false); +}); + +test('packaged native artifact candidates require canonical non-link parent ancestry', () => { + const fixture = mkdtempSync(join(realpathSync.native(tmpdir()), 'propr-native-artifact-')); + try { + const canonical = join(fixture, 'native', 'prebuilds', 'darwin-arm64'); + mkdirSync(canonical, { recursive: true }); + const artifact = join(canonical, 'broker'); + writeFileSync(artifact, 'fixture'); + assert.doesNotThrow(() => assertCanonicalNativeArtifactParents(artifact)); + + const linked = join(fixture, 'linked'); + symlinkSync(join(fixture, 'native'), linked, 'dir'); + assert.throws( + () => assertCanonicalNativeArtifactParents(join(linked, 'prebuilds', 'darwin-arm64', 'broker')), + /ancestry failed verification/, + ); + } finally { + rmSync(fixture, { recursive: true, force: true }); + } +}); diff --git a/packages/cli/src/utils/nativeArtifact.ts b/packages/cli/src/utils/nativeArtifact.ts new file mode 100644 index 000000000..04192d733 --- /dev/null +++ b/packages/cli/src/utils/nativeArtifact.ts @@ -0,0 +1,32 @@ +import { lstatSync, realpathSync } from 'node:fs'; +import { dirname, resolve, sep } from 'node:path'; + +/** Resolve an ASAR-relative native path to the physical, executable unpacked resource. */ +export function physicalNativeArtifactCandidate(candidate: string): string { + const marker = `${sep}app.asar${sep}`; + const index = candidate.indexOf(marker); + if (index === -1) return candidate; + return `${candidate.slice(0, index)}${sep}app.asar.unpacked${sep}${candidate.slice(index + marker.length)}`; +} + +/** True only when an ASAR logical path was remapped to its physical unpacked resource. */ +export function isPackagedNativeArtifactResolution(logicalCandidate: string, physicalCandidate: string): boolean { + const marker = `${sep}app.asar${sep}`; + return logicalCandidate.includes(marker) + && physicalCandidate !== logicalCandidate + && physicalCandidate === physicalNativeArtifactCandidate(logicalCandidate); +} + +/** Require every existing parent of a packaged native candidate to be canonical and non-link. */ +export function assertCanonicalNativeArtifactParents(candidate: string): void { + let parent = dirname(resolve(candidate)); + while (true) { + const named = lstatSync(parent); + if (!named.isDirectory() || named.isSymbolicLink() || realpathSync.native(parent) !== parent) { + throw new Error('packaged native artifact ancestry failed verification'); + } + const next = dirname(parent); + if (next === parent) return; + parent = next; + } +} diff --git a/packages/cli/src/utils/privateFilesystem.ts b/packages/cli/src/utils/privateFilesystem.ts index e1dd10146..b63372721 100644 --- a/packages/cli/src/utils/privateFilesystem.ts +++ b/packages/cli/src/utils/privateFilesystem.ts @@ -33,7 +33,7 @@ function assertOwned(stat: Stats, targetPath: string): void { } } -export function secureExistingPrivateDirectory(directoryPath: string): boolean { +export async function secureExistingPrivateDirectory(directoryPath: string): Promise { const stat = lstatIfPresent(directoryPath); if (!stat) return false; if (stat.isSymbolicLink()) throw new Error(`Refusing to use symbolic-link directory ${directoryPath}`); @@ -45,14 +45,33 @@ export function secureExistingPrivateDirectory(directoryPath: string): boolean { return true; } -export function ensurePrivateDirectory(directoryPath: string): void { +/** + * Validate an existing private directory without changing it. Read-only + * consumers use this so inspecting configuration cannot repair or otherwise + * mutate the authority boundary as a side effect. + */ +export function validateExistingPrivateDirectory(directoryPath: string): boolean { + const stat = lstatIfPresent(directoryPath); + if (!stat) return false; + if (stat.isSymbolicLink()) throw new Error(`Refusing to use symbolic-link directory ${directoryPath}`); + if (!stat.isDirectory()) throw new Error(`Expected a directory at ${directoryPath}`); + assertOwned(stat, directoryPath); + if (process.platform !== "win32" && (stat.mode & 0o777) !== PRIVATE_DIRECTORY_MODE) { + throw new Error(`Refusing to use non-private directory ${directoryPath}`); + } + return true; +} + +export async function ensurePrivateDirectory( + directoryPath: string, +): Promise { if (!lstatIfPresent(directoryPath)) { mkdirSync(directoryPath, { recursive: true, mode: PRIVATE_DIRECTORY_MODE }); } - secureExistingPrivateDirectory(directoryPath); + await secureExistingPrivateDirectory(directoryPath); } -export function secureExistingPrivateFile(filePath: string): boolean { +export async function secureExistingPrivateFile(filePath: string): Promise { const stat = lstatIfPresent(filePath); if (!stat) return false; if (stat.isSymbolicLink()) throw new Error(`Refusing to use symbolic-link file ${filePath}`); @@ -64,17 +83,30 @@ export function secureExistingPrivateFile(filePath: string): boolean { return true; } +/** Validate an existing private file without chmod or any other mutation. */ +export function validateExistingPrivateFile(filePath: string): boolean { + const stat = lstatIfPresent(filePath); + if (!stat) return false; + if (stat.isSymbolicLink()) throw new Error(`Refusing to use symbolic-link file ${filePath}`); + if (!stat.isFile()) throw new Error(`Expected a regular file at ${filePath}`); + assertOwned(stat, filePath); + if (process.platform !== "win32" && (stat.mode & 0o777) !== PRIVATE_FILE_MODE) { + throw new Error(`Refusing to use non-private file ${filePath}`); + } + return true; +} + export interface PrivateFileWriteOptions { secureParent?: boolean; } -export function writePrivateFileAtomic( +export async function writePrivateFileAtomic( filePath: string, content: string | Buffer, options: PrivateFileWriteOptions = {}, -): void { - if (options.secureParent !== false) ensurePrivateDirectory(dirname(filePath)); - secureExistingPrivateFile(filePath); +): Promise { + if (options.secureParent !== false) await ensurePrivateDirectory(dirname(filePath)); + await secureExistingPrivateFile(filePath); const tempPath = `${filePath}.tmp-${process.pid}-${randomUUID()}`; let descriptor: number | undefined; try { @@ -83,8 +115,8 @@ export function writePrivateFileAtomic( fsyncSync(descriptor); closeSync(descriptor); descriptor = undefined; + if (process.platform !== "win32") chmodSync(tempPath, PRIVATE_FILE_MODE); renameSync(tempPath, filePath); - if (process.platform !== "win32") chmodSync(filePath, PRIVATE_FILE_MODE); } finally { if (descriptor !== undefined) closeSync(descriptor); try { unlinkSync(tempPath); } catch { /* Best-effort cleanup after success or failure. */ } diff --git a/packages/client/src/baseUrl.ts b/packages/client/src/baseUrl.ts index e32444fe7..34628d058 100644 --- a/packages/client/src/baseUrl.ts +++ b/packages/client/src/baseUrl.ts @@ -1,3 +1,10 @@ +import { + canonicalProprHttpUrlOrigin, + isProprConnectReservedHostAttempt, + isProprLoopbackHostname, + MAX_PROPR_API_BASE_URL_LENGTH, + parseProprConnectEndpoint, +} from '@propr/shared'; import { ProprClientError } from './errors.js'; declare const normalizedApiBaseUrl: unique symbol; @@ -10,24 +17,30 @@ export interface NormalizeApiBaseUrlOptions { allowInsecureHttp?: boolean; } -const isLoopbackHostname = (hostname: string): boolean => { - const normalized = hostname.toLowerCase().replace(/\.$/, ''); - if (normalized === 'localhost' || normalized.endsWith('.localhost') || normalized === '[::1]') return true; - const parts = normalized.split('.'); - return parts.length === 4 - && parts.every(part => /^\d{1,3}$/.test(part) && Number(part) <= 255) - && Number(parts[0]) === 127; -}; +export type ProprApiEndpointKind = 'same-origin' | 'loopback' | 'remote' | 'propr-connect'; + +export interface ProprApiEndpointClassification { + baseUrl: ProprApiBaseUrl; + kind: ProprApiEndpointKind; + /** Present only after exact ProPR Connect hostname verification. */ + connectInstanceId?: string; +} const configurationError = (message: string): never => { - throw new ProprClientError(message, { kind: 'configuration' }); + throw new ProprClientError(message, { kind: 'configuration', code: 'INVALID_API_BASE_URL' }); }; +const invalidApiBaseUrl = (): never => + configurationError('The configured ProPR API URL is invalid.'); + /** Validate and normalize a REST/Socket.IO endpoint without retaining credentials. */ export const normalizeApiBaseUrl = ( value?: string | null, options: NormalizeApiBaseUrlOptions = {} ): ProprApiBaseUrl => { + if (typeof value === 'string' && value.length > MAX_PROPR_API_BASE_URL_LENGTH) { + return invalidApiBaseUrl(); + } const candidate = value?.trim() ?? ''; if (!candidate) return '' as ProprApiBaseUrl; @@ -35,30 +48,53 @@ export const normalizeApiBaseUrl = ( try { parsed = new URL(candidate); } catch { - return configurationError('The ProPR API URL must be an absolute HTTP(S) URL.'); + return invalidApiBaseUrl(); } if (parsed.protocol !== 'http:' && parsed.protocol !== 'https:') { - return configurationError('The ProPR API URL must use HTTP or HTTPS.'); + return invalidApiBaseUrl(); } if (parsed.username || parsed.password) { - return configurationError('The ProPR API URL must not contain embedded credentials.'); + return invalidApiBaseUrl(); } if (parsed.search || parsed.hash) { - return configurationError('The ProPR API URL must not contain a query string or fragment.'); + return invalidApiBaseUrl(); } if (parsed.pathname.replace(/\//g, '') !== '') { - return configurationError('The ProPR API URL must be an origin without a path.'); + return invalidApiBaseUrl(); + } + if (isProprConnectReservedHostAttempt(value) && !parseProprConnectEndpoint(value)) { + return invalidApiBaseUrl(); } - if ( - parsed.protocol === 'http:' - && !isLoopbackHostname(parsed.hostname) - && options.allowInsecureHttp !== true - ) { - return configurationError('Plain HTTP is only allowed for loopback ProPR API URLs.'); + + const normalized = canonicalProprHttpUrlOrigin(candidate, { + allowInsecureHttp: options.allowInsecureHttp, + }); + if (!normalized) { + return invalidApiBaseUrl(); } + return normalized as ProprApiBaseUrl; +}; + +/** Normalize an API origin and identify only the exact ProPR Connect shape. */ +export const classifyApiBaseUrl = ( + value?: string | null, + options: NormalizeApiBaseUrlOptions = {} +): ProprApiEndpointClassification => { + const baseUrl = normalizeApiBaseUrl(value, options); + if (!baseUrl) return { baseUrl, kind: 'same-origin' }; - return parsed.origin as ProprApiBaseUrl; + // Classify the original spelling, not the normalized origin. Otherwise an + // encoded or Unicode authority could acquire the trusted Connect label only + // after WHATWG URL canonicalization. + const connect = parseProprConnectEndpoint(value); + if (connect) { + return { baseUrl, kind: 'propr-connect', connectInstanceId: connect.instanceId }; + } + return { + baseUrl, + kind: isProprLoopbackHostname(new URL(baseUrl).hostname) ? 'loopback' : 'remote', + }; }; export const apiUrl = (baseUrl: ProprApiBaseUrl, path: string): string => { diff --git a/packages/client/src/client.ts b/packages/client/src/client.ts index 9458f36fc..2eb48f10d 100644 --- a/packages/client/src/client.ts +++ b/packages/client/src/client.ts @@ -1,5 +1,7 @@ import { evaluateProprApiCompatibility, + parseProprDesktopDiscoveryJson, + PROPR_CONNECT_DISCOVERY_MAX_BYTES, type ProprApiCompatibilityResult, type ProprCompatibilityMetadata, } from '@propr/shared'; @@ -9,7 +11,10 @@ import { type NormalizeApiBaseUrlOptions, type ProprApiBaseUrl, } from './baseUrl.js'; -import { ProprClientError } from './errors.js'; +import { + DESKTOP_DISCOVERY_AUTHENTICATION_REQUIRED, + ProprClientError, +} from './errors.js'; import { buildSocketConnection, connectProprSocket, @@ -17,12 +22,29 @@ import { type ProprSocketOptions, type Socket, } from './socket.js'; +import { + completeDesktopPairing, + parseDesktopDiscovery, + parseDesktopPairingStart, + parseDesktopPairingActivationReceipt, + type ProprDesktopDiscovery, + type ProprDesktopPairingComplete, + type ProprDesktopPairingActivationReceipt, + type ProprDesktopPairingOptions, + type ProprDesktopPairingStart, +} from './desktopPairing.js'; +import { + requestPairingProtocol, + type PairingProtocolRequestOptions, +} from './pairingProtocol.js'; export interface ProprClientOptions extends NormalizeApiBaseUrlOptions { baseUrl?: string | null; authentication?: ProprAuthentication; defaultTimeoutMs?: number; fetch?: typeof globalThis.fetch; + /** @internal Deterministic response-lifecycle proof; production uses fixed protocol defaults. */ + pairingProtocol?: PairingProtocolRequestOptions; } export interface ProprFetchOptions { @@ -61,6 +83,45 @@ const isCompatibilityMetadata = (value: unknown): value is Partial { + let offset = 0; + const whitespace = (): void => { + while (offset < contents.length && /[\x20\t\r\n]/.test(contents[offset])) offset += 1; + }; + const stringToken = (): string | null => { + if (contents[offset] !== '"') return null; + const start = offset; + offset += 1; + while (offset < contents.length) { + const character = contents[offset++]; + if (character === '"') { + try { return JSON.parse(contents.slice(start, offset)) as string; } catch { return null; } + } + if (character === '\\') { + const escape = contents[offset++]; + if (escape === 'u') { + if (!/^[0-9a-fA-F]{4}$/.test(contents.slice(offset, offset + 4))) return null; + offset += 4; + } else if (!escape || !'"\\/bfnrt'.includes(escape)) return null; + } else if (character.charCodeAt(0) < 0x20) return null; + } + return null; + }; + + whitespace(); + if (contents[offset++] !== '{') return false; + whitespace(); + if (stringToken() !== 'error') return false; + whitespace(); + if (contents[offset++] !== ':') return false; + whitespace(); + if (stringToken() !== 'Unauthorized') return false; + whitespace(); + if (contents[offset++] !== '}') return false; + whitespace(); + return offset === contents.length; +}; + const assertTimeout = (timeoutMs: number): void => { if (!Number.isFinite(timeoutMs) || timeoutMs < 0) { throw new ProprClientError('Request timeouts must be finite, non-negative numbers.', { @@ -69,12 +130,86 @@ const assertTimeout = (timeoutMs: number): void => { } }; +const createDesktopDiscoveryDeadline = (timeoutMs: number, callerSignal?: AbortSignal) => { + assertTimeout(timeoutMs); + const controller = new AbortController(); + let rejectDeadline!: (reason: unknown) => void; + let timedOut = false; + let deadlineSettled = false; + let deadlineReason: unknown; + const deadline = new Promise((_resolve, reject) => { rejectDeadline = reject; }); + // A caller may already be aborted before any operation is raced. + void deadline.catch(() => undefined); + const timeoutReason = new Error('desktop discovery timed out'); + const abortReason = new Error('desktop discovery was cancelled'); + const settleDeadline = (reason: unknown): boolean => { + if (deadlineSettled) return false; + deadlineSettled = true; + deadlineReason = reason; + rejectDeadline(reason); + return true; + }; + const timeout = setTimeout(() => { + if (!settleDeadline(timeoutReason)) return; + timedOut = true; + controller.abort(timeoutReason); + }, Math.max(1, timeoutMs)); + const onAbort = (): void => { + if (!settleDeadline(abortReason)) return; + controller.abort(callerSignal?.reason); + }; + if (callerSignal?.aborted) onAbort(); + else callerSignal?.addEventListener('abort', onAbort, { once: true }); + return { + signal: controller.signal, + race: (operation: Promise, disposeLateValue?: (value: T) => void): Promise => { + const observed = Promise.resolve(operation); + if (deadlineSettled) { + observed.then( + value => { try { disposeLateValue?.(value); } catch { /* best-effort ownership cleanup */ } }, + () => undefined, + ); + return Promise.reject(deadlineReason); + } + return new Promise((resolve, reject) => { + let settled = false; + deadline.catch(error => { + if (settled) return; + settled = true; + reject(error); + }); + observed.then( + value => { + if (settled || deadlineSettled) { + try { disposeLateValue?.(value); } catch { /* best-effort ownership cleanup */ } + return; + } + settled = true; + resolve(value); + }, + error => { + if (settled) return; + settled = true; + reject(error); + }, + ); + }); + }, + timedOut: (): boolean => timedOut, + dispose: (): void => { + clearTimeout(timeout); + callerSignal?.removeEventListener('abort', onAbort); + }, + }; +}; + export class ProprClient { readonly baseUrl: ProprApiBaseUrl; readonly authentication: ProprAuthentication; readonly defaultTimeoutMs: number; private readonly fetchImplementation: typeof globalThis.fetch; + private readonly pairingProtocolOptions: PairingProtocolRequestOptions; constructor(options: ProprClientOptions = {}) { this.baseUrl = normalizeApiBaseUrl(options.baseUrl, options); @@ -82,6 +217,7 @@ export class ProprClient { this.defaultTimeoutMs = options.defaultTimeoutMs ?? 0; assertTimeout(this.defaultTimeoutMs); this.fetchImplementation = options.fetch ?? ((input, init) => globalThis.fetch(input, init)); + this.pairingProtocolOptions = options.pairingProtocol ?? {}; } url(path: string): string { @@ -213,6 +349,238 @@ export class ProprClient { return result; } + async discoverDesktop(timeoutMs = 8000, signal?: AbortSignal): Promise { + const deadline = createDesktopDiscoveryDeadline(timeoutMs, signal); + if (signal?.aborted) { + deadline.dispose(); + throw new ProprClientError('Desktop discovery was cancelled.', { + kind: 'aborted', cause: signal.reason, + }); + } + let response: Response; + try { + response = await deadline.race( + this.fetchImplementation(this.resolveRequestTarget(this.url('/api/desktop/discovery')), { + cache: 'no-store', + credentials: 'omit', + headers: { Accept: 'application/json' }, + redirect: 'manual', + signal: deadline.signal, + }), + lateResponse => { + try { void lateResponse.body?.cancel().catch(() => undefined); } catch { /* hostile late response */ } + }, + ); + } catch (cause) { + deadline.dispose(); + if (deadline.timedOut()) { + throw new ProprClientError('Desktop discovery timed out.', { kind: 'timeout', cause }); + } + if (signal?.aborted) { + throw new ProprClientError('Desktop discovery was cancelled.', { kind: 'aborted', cause }); + } + if (cause instanceof ProprClientError) throw cause; + throw new ProprClientError('The ProPR API could not be reached.', { kind: 'network', cause }); + } + try { + const discoveryContentType = response.headers.get('content-type') + ?.split(';', 1)[0]?.trim().toLowerCase(); + const legacyAuthenticationCandidate = response.status === 401 + && !response.redirected + && discoveryContentType === 'application/json'; + if ((!response.ok && !legacyAuthenticationCandidate) + || response.redirected + || discoveryContentType !== 'application/json') { + try { void response.body?.cancel().catch(() => undefined); } catch { /* best-effort response disposal */ } + throw new ProprClientError('The ProPR instance returned invalid desktop discovery metadata.', { + kind: 'invalid_response', + status: response.status, + }); + } + const declaredLength = response.headers.get('content-length'); + if (declaredLength !== null && (!/^(?:0|[1-9]\d*)$/.test(declaredLength) + || Number(declaredLength) > PROPR_CONNECT_DISCOVERY_MAX_BYTES)) { + try { void response.body?.cancel().catch(() => undefined); } catch { /* best-effort response disposal */ } + throw new ProprClientError('The ProPR instance returned oversized desktop discovery metadata.', { + kind: 'invalid_response', status: response.status, + }); + } + const reader = response.body?.getReader(); + const chunks: Uint8Array[] = []; + let received = 0; + try { + if (reader) { + while (true) { + const part = await deadline.race(reader.read()); + if (part.done) break; + received += part.value.byteLength; + if (received > PROPR_CONNECT_DISCOVERY_MAX_BYTES) throw new Error('oversized'); + chunks.push(part.value); + } + } + } catch (cause) { + try { void reader?.cancel().catch(() => undefined); } catch { /* best-effort body cancellation */ } + if (deadline.timedOut()) { + throw new ProprClientError('Desktop discovery timed out.', { kind: 'timeout', cause }); + } + if (signal?.aborted) { + throw new ProprClientError('Desktop discovery was cancelled.', { kind: 'aborted', cause }); + } + throw new ProprClientError('The ProPR instance returned invalid desktop discovery metadata.', { + kind: 'invalid_response', status: response.status, + ...(legacyAuthenticationCandidate ? {} : { cause }), + }); + } finally { try { reader?.releaseLock(); } catch { /* hostile streams may retain a pending read */ } } + const contentEncoding = response.headers.get('content-encoding')?.trim().toLowerCase(); + if (declaredLength !== null && (!contentEncoding || contentEncoding === 'identity') + && Number(declaredLength) !== received) { + throw new ProprClientError('The ProPR instance returned invalid desktop discovery metadata.', { + kind: 'invalid_response', status: response.status, + }); + } + const bytes = new Uint8Array(received); + let cursor = 0; + for (const chunk of chunks) { bytes.set(chunk, cursor); cursor += chunk.byteLength; } + let contents: string; + try { contents = new TextDecoder('utf-8', { fatal: true }).decode(bytes); } + catch (cause) { + throw new ProprClientError('The ProPR instance returned invalid desktop discovery metadata.', { + kind: 'invalid_response', status: response.status, + ...(legacyAuthenticationCandidate ? {} : { cause }), + }); + } + if (legacyAuthenticationCandidate) { + throw new ProprClientError('The ProPR instance returned invalid desktop discovery metadata.', { + kind: 'invalid_response', + status: response.status, + ...(isExactLegacyDiscoveryAuthenticationBody(contents) + ? { code: DESKTOP_DISCOVERY_AUTHENTICATION_REQUIRED } + : {}), + }); + } + const metadata = parseProprDesktopDiscoveryJson(contents); + if (!metadata) { + throw new ProprClientError('The ProPR instance returned invalid desktop discovery metadata.', { + kind: 'invalid_response', status: response.status, + }); + } + const compatibility = evaluateProprApiCompatibility( + metadata, + ); + return parseDesktopDiscovery(metadata, compatibility); + } finally { + deadline.dispose(); + } + } + + async startDesktopPairing( + clientName: string, + options: Pick, + ): Promise { + const path = '/api/desktop/pairings'; + const expectedOrigin = this.resolveRequestOrigin(this.url(path)); + return parseDesktopPairingStart(await this.requestDesktopPairing(path, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ clientName, ...options.binding }), + redirect: 'manual', + signal: options.signal, + }), expectedOrigin, options.now); + } + + async pairDesktop( + clientName: string, + options: ProprDesktopPairingOptions, + ): Promise { + const start = await this.startDesktopPairing(clientName, options); + return completeDesktopPairing(this, start, options); + } + + async activateDesktopPairing( + pairing: ProprDesktopPairingComplete, + signal?: AbortSignal, + ): Promise { + return parseDesktopPairingActivationReceipt(await this.requestDesktopPairing( + `/api/desktop/pairings/${encodeURIComponent(pairing.pairingId)}/activate`, + { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ + deviceSecret: pairing.deviceSecret, + activationTicket: pairing.activationTicket, + instanceId: pairing.instanceId, + origin: pairing.origin, + scope: pairing.scope, + credentialGeneration: pairing.credentialGeneration, + }), + redirect: 'manual', + signal, + }, + )); + } + + async cancelDesktopPairing( + pairing: ProprDesktopPairingComplete, + signal?: AbortSignal, + ): Promise<{ status: 'cancelled'; cancelledAt: string }> { + const value = await this.requestDesktopPairing( + `/api/desktop/pairings/${encodeURIComponent(pairing.pairingId)}/cancel`, + { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ + deviceSecret: pairing.deviceSecret, + activationTicket: pairing.activationTicket, + instanceId: pairing.instanceId, + origin: pairing.origin, + scope: pairing.scope, + credentialGeneration: pairing.credentialGeneration, + }), + redirect: 'manual', + signal, + }, + ); + if (!value || typeof value !== 'object' || Array.isArray(value)) { + throw new ProprClientError('The ProPR instance returned an invalid pairing cancellation receipt.', { + kind: 'invalid_response', + }); + } + const receipt = value as Record; + if (receipt.status !== 'cancelled' || typeof receipt.cancelledAt !== 'string' + || !Number.isFinite(Date.parse(receipt.cancelledAt)) + || Object.keys(receipt).some(key => !['status', 'cancelledAt'].includes(key))) { + throw new ProprClientError('The ProPR instance returned an invalid pairing cancellation receipt.', { + kind: 'invalid_response', + }); + } + return receipt as unknown as { status: 'cancelled'; cancelledAt: string }; + } + + /** @internal Pairing keeps transport ownership through the complete body. */ + async requestDesktopPairing( + path: string, + init: RequestInit, + overallTimeoutMs?: number, + overallTimeoutError?: PairingProtocolRequestOptions['overallTimeoutError'], + ): Promise { + const target = this.resolveRequestTarget(this.url(path)); + const authentication = this.authenticate(init); + const authenticatedInit = authentication instanceof Promise + ? await authentication + : authentication; + return requestPairingProtocol( + this.fetchImplementation, + target, + authenticatedInit ?? {}, + { + ...this.pairingProtocolOptions, + overallTimeoutMs: overallTimeoutMs ?? this.pairingProtocolOptions.overallTimeoutMs, + overallTimeoutError: overallTimeoutError + ?? this.pairingProtocolOptions.overallTimeoutError, + }, + ); + } + connectSocket(options: ProprSocketOptions = {}): Socket { return connectProprSocket(buildSocketConnection(this.baseUrl, this.authentication, options)); } @@ -246,6 +614,22 @@ export class ProprClient { return input; } + private resolveRequestOrigin(input: RequestInfo | URL): string { + const raw = input instanceof Request ? input.url : input.toString(); + const browserOrigin = typeof globalThis.location !== 'undefined' + ? globalThis.location.origin + : undefined; + try { + const origin = new URL(raw, browserOrigin).origin; + if (origin === 'null') throw new Error(); + return origin; + } catch { + throw new ProprClientError('The ProPR instance origin could not be established.', { + kind: 'configuration', + }); + } + } + private authenticate(init?: RequestInit): RequestInit | undefined | Promise { if (this.authentication.type === 'none') return init; if (this.authentication.type === 'session') { @@ -276,6 +660,8 @@ export class ProprClient { } headers.set('Authorization', `Bearer ${token}`); } - return { ...init, headers }; + // Bearer profiles must never accidentally inherit a browser/Electron cookie + // identity from another named profile on the same origin. + return { ...init, credentials: 'omit', headers }; } } diff --git a/packages/client/src/desktopPairing.ts b/packages/client/src/desktopPairing.ts new file mode 100644 index 000000000..c261af7e3 --- /dev/null +++ b/packages/client/src/desktopPairing.ts @@ -0,0 +1,367 @@ +import type { + ProprApiCompatibilityResult, + ProprDesktopDiscovery as SharedProprDesktopDiscovery, +} from '@propr/shared'; +import { canonicalProprHttpUrlOrigin, parseProprDesktopDiscovery } from '@propr/shared'; +import type { ProprClient } from './client.js'; +import { ProprClientError } from './errors.js'; + +export interface ProprDesktopDiscovery extends SharedProprDesktopDiscovery { + compatibility: ProprApiCompatibilityResult; +} + +export interface ProprDesktopPairingStart { + pairingId: string; + deviceSecret: string; + approvalUrl: string; + expiresAt: string; + interval: number; +} + +export interface ProprDesktopPairingComplete { + token: string; + tokenType: 'Bearer'; + pairingId: string; + deviceSecret: string; + activationTicket: string; + activationExpiresAt: string; + instanceId: string; + origin: string; + scope: 'desktop-instance'; + credentialGeneration: string; +} + +export interface ProprDesktopPairingBinding { + instanceId: string; + origin: string; + scope: 'desktop-instance'; + credentialGeneration: string; +} + +export interface ProprDesktopPairingActivationReceipt { + status: 'active'; + receipt: string; + activatedAt: string; + expiresAt: string | null; +} + +export interface ProprDesktopPairingOptions { + signal?: AbortSignal; + binding: ProprDesktopPairingBinding; + onApprovalRequired?(approvalUrl: string, expiresAt: string, pairingId: string): void | Promise; + /** Injectable only to make protocol tests deterministic. */ + sleep?: (milliseconds: number, signal?: AbortSignal) => Promise; + /** Injectable only to make expiry tests deterministic. */ + now?: () => number; + /** @internal Deterministic monotonic deadline source for protocol tests. */ + clock?: { + now(): number; + setTimeout(callback: () => void, milliseconds: number): ReturnType; + clearTimeout(timer: ReturnType): void; + }; +} + +const MIN_POLL_INTERVAL_SECONDS = 1; +const MAX_POLL_INTERVAL_SECONDS = 60; +const MAX_PAIRING_LIFETIME_MS = 30 * 60 * 1000; +const PAIRING_REQUEST_TIMEOUT_MS = 8_000; +const exactKeys = (body: Record, keys: readonly string[]): boolean => + Object.keys(body).length === keys.length && Object.keys(body).every(key => keys.includes(key)); + +const record = (value: unknown): Record => { + if (!value || typeof value !== 'object' || Array.isArray(value)) { + throw new ProprClientError('The ProPR desktop protocol returned an invalid response.', { + kind: 'invalid_response', + }); + } + return value as Record; +}; + +const string = (value: unknown): value is string => typeof value === 'string' && value.length > 0; +const validPollInterval = (value: unknown): value is number => typeof value === 'number' + && Number.isInteger(value) + && value >= MIN_POLL_INTERVAL_SECONDS + && value <= MAX_POLL_INTERVAL_SECONDS; + +const validPairingDeadline = (value: unknown, now: number): value is string => { + if (!string(value)) return false; + const deadline = Date.parse(value); + return Number.isFinite(deadline) + && Number.isFinite(now) + && deadline > now + && deadline - now <= MAX_PAIRING_LIFETIME_MS; +}; + +const validBinding = (value: unknown): value is ProprDesktopPairingBinding => { + if (!value || typeof value !== 'object' || Array.isArray(value)) return false; + const binding = value as Record; + return typeof binding.instanceId === 'string' + && /^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$/.test(binding.instanceId) + && typeof binding.origin === 'string' + && canonicalProprHttpUrlOrigin(binding.origin) === binding.origin + && binding.scope === 'desktop-instance' + && typeof binding.credentialGeneration === 'string' + && /^[A-Za-z0-9_-]{22}$/.test(binding.credentialGeneration); +}; + +export const parseDesktopDiscovery = ( + value: unknown, + compatibility: ProprApiCompatibilityResult, +): ProprDesktopDiscovery => { + const body = parseProprDesktopDiscovery(value); + if (!body) { + throw new ProprClientError('The ProPR instance returned invalid desktop discovery metadata.', { + kind: 'invalid_response', + }); + } + return { ...body, compatibility }; +}; + +export const parseDesktopPairingStart = ( + value: unknown, + expectedOrigin: string, + now: () => number = Date.now, +): ProprDesktopPairingStart => { + const body = record(value); + if (!exactKeys(body, ['pairingId', 'deviceSecret', 'approvalUrl', 'expiresAt', 'interval']) + || !string(body.pairingId) || !/^dpr_[A-Za-z0-9_-]{22}$/.test(body.pairingId) + || !string(body.deviceSecret) || !/^[A-Za-z0-9_-]{43}$/.test(body.deviceSecret) + || !string(body.approvalUrl) + || !validPollInterval(body.interval) + || !validPairingDeadline(body.expiresAt, now())) { + throw new ProprClientError('The ProPR instance returned an invalid pairing request.', { + kind: 'invalid_response', + }); + } + try { + const approvalUrl = new URL(body.approvalUrl); + if (canonicalProprHttpUrlOrigin(body.approvalUrl) !== approvalUrl.origin) throw new Error(); + if (approvalUrl.username || approvalUrl.password) throw new Error(); + // Device approval is intentionally same-origin. A future hosted approval + // service must define and validate a narrow trust contract here first. + if (!expectedOrigin || approvalUrl.origin !== expectedOrigin) throw new Error(); + } catch { + throw new ProprClientError('The ProPR instance returned an unsafe pairing approval URL.', { + kind: 'invalid_response', + }); + } + return { + pairingId: body.pairingId, + deviceSecret: body.deviceSecret, + approvalUrl: body.approvalUrl, + expiresAt: body.expiresAt, + interval: body.interval, + }; +}; + +const cancelled = (cause?: unknown): ProprClientError => + new ProprClientError('Desktop pairing was cancelled.', { kind: 'aborted', cause }); + +const expired = (cause?: unknown): ProprClientError => + new ProprClientError('Desktop pairing expired before it was approved.', { + kind: 'authentication', code: 'PAIRING_EXPIRED', cause, + }); + +const safeDelay = (milliseconds: number): number => Math.max(1, Math.ceil(milliseconds)); + +const defaultSleep = (milliseconds: number, signal?: AbortSignal): Promise => new Promise((resolve, reject) => { + const aborted = () => { + clearTimeout(timer); + reject(cancelled()); + }; + const timer = setTimeout(() => { + signal?.removeEventListener('abort', aborted); + resolve(); + }, milliseconds); + if (signal?.aborted) aborted(); + else signal?.addEventListener('abort', aborted, { once: true }); +}); + +export const completeDesktopPairing = async ( + client: ProprClient, + start: ProprDesktopPairingStart, + options: ProprDesktopPairingOptions, +): Promise => { + const sleep = options.sleep ?? defaultSleep; + const now = options.now ?? Date.now; + const clock = options.clock ?? { + now: () => performance.now(), + setTimeout: (callback: () => void, milliseconds: number) => setTimeout(callback, milliseconds), + clearTimeout: (timer: ReturnType) => clearTimeout(timer), + }; + if (options.signal?.aborted) throw cancelled(options.signal.reason); + const deadline = Date.parse(start.expiresAt); + const startedAt = now(); + const lifetimeMs = deadline - startedAt; + if (!validPollInterval(start.interval) + || !Number.isFinite(deadline) + || !Number.isFinite(startedAt) + || lifetimeMs > MAX_PAIRING_LIFETIME_MS) { + throw new ProprClientError('The ProPR instance returned an invalid pairing deadline.', { + kind: 'invalid_response', + }); + } + if (lifetimeMs <= 0) throw expired(); + + const lifetimeController = new AbortController(); + const monotonicStartedAt = clock.now(); + let terminal: 'caller' | 'deadline' | undefined; + const abortForCaller = () => { + if (terminal) return; + terminal = 'caller'; + lifetimeController.abort(options.signal?.reason); + }; + const abortForDeadline = () => { + if (terminal) return; + terminal = 'deadline'; + lifetimeController.abort(expired()); + }; + const deadlineTimer = clock.setTimeout(abortForDeadline, safeDelay(lifetimeMs)); + if (options.signal?.aborted) abortForCaller(); + else options.signal?.addEventListener('abort', abortForCaller, { once: true }); + + const terminalError = (cause?: unknown): ProprClientError => terminal === 'caller' + ? cancelled(cause ?? options.signal?.reason) + : expired(cause); + const remainingLifetime = (): number => Math.min( + deadline - now(), + lifetimeMs - (clock.now() - monotonicStartedAt), + ); + const requireRemainingLifetime = (): number => { + if (terminal) throw terminalError(); + const remaining = remainingLifetime(); + if (remaining <= 0) { + abortForDeadline(); + throw terminalError(); + } + return remaining; + }; + const raceLifetime = (operation: PromiseLike): Promise => { + let removeAbortListener: () => void = () => undefined; + const result = new Promise((resolve, reject) => { + const rejectForAbort = () => reject(terminalError()); + removeAbortListener = () => { + lifetimeController.signal.removeEventListener('abort', rejectForAbort); + }; + if (lifetimeController.signal.aborted) rejectForAbort(); + else lifetimeController.signal.addEventListener('abort', rejectForAbort, { once: true }); + // Always attach both handlers, even if the lifetime already ended, so a + // callback or transport that settles late cannot become unhandled. + Promise.resolve(operation).then(resolve, error => { + reject(terminal ? terminalError(error) : error); + }); + }); + return result.finally(() => removeAbortListener()); + }; + + try { + let intervalSeconds = start.interval; + if (options.onApprovalRequired) { + const approval = Promise.resolve().then(() => + options.onApprovalRequired?.(start.approvalUrl, start.expiresAt, start.pairingId)); + await raceLifetime(approval); + requireRemainingLifetime(); + } + + while (true) { + const remainingBeforeSleep = requireRemainingLifetime(); + const delay = safeDelay(Math.min(intervalSeconds * 1000, remainingBeforeSleep)); + await raceLifetime(sleep(delay, lifetimeController.signal)); + const remaining = requireRemainingLifetime(); + + let value: unknown; + const requestUsesPairingDeadline = remaining <= PAIRING_REQUEST_TIMEOUT_MS; + let pairingDeadlineTimedOut = false; + try { + // The pairing reader owns cancellation through body drain/cancel. Do + // not race it with a faster outer rejection: completion here is the + // operation's guarantee that no response task survives this poll. + value = await client.requestDesktopPairing( + `/api/desktop/pairings/${encodeURIComponent(start.pairingId)}/poll`, + { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ deviceSecret: start.deviceSecret }), + redirect: 'manual', + signal: lifetimeController.signal, + }, + Math.min(PAIRING_REQUEST_TIMEOUT_MS, safeDelay(remaining)), + requestUsesPairingDeadline ? cause => { + pairingDeadlineTimedOut = true; + return expired(cause); + } : undefined, + ); + } catch (error) { + // A request clamped to the remaining lifetime owns the same boundary + // as the pairing deadline. Its timer can run first when the pairing + // timer's task is delayed, but that must not change expiry into a + // transport timeout at the exact boundary. + if (terminal) throw terminalError(error); + if (pairingDeadlineTimedOut) { + abortForDeadline(); + throw error; + } + if (remainingLifetime() <= 0) { + abortForDeadline(); + throw terminalError(error); + } + throw error; + } + requireRemainingLifetime(); + const body = record(value); + if (body.status === 'pending' + && exactKeys(body, ['status', 'interval']) + && validPollInterval(body.interval)) { + intervalSeconds = body.interval; + continue; + } + if (body.status === 'provisional' + && exactKeys(body, [ + 'status', 'token', 'tokenType', 'activationTicket', 'activationExpiresAt', + 'instanceId', 'origin', 'scope', 'credentialGeneration', + ]) + && string(body.token) + && /^propr_it_[A-Za-z0-9_-]{43}$/.test(body.token) && body.tokenType === 'Bearer' + && string(body.activationTicket) && /^[A-Za-z0-9_-]{43}$/.test(body.activationTicket) + && validPairingDeadline(body.activationExpiresAt, now()) + && validBinding(body) + && body.instanceId === options.binding.instanceId + && body.origin === options.binding.origin + && body.scope === options.binding.scope + && body.credentialGeneration === options.binding.credentialGeneration) { + requireRemainingLifetime(); + return { + token: body.token, + tokenType: 'Bearer', + pairingId: start.pairingId, + deviceSecret: start.deviceSecret, + activationTicket: body.activationTicket, + activationExpiresAt: body.activationExpiresAt, + instanceId: body.instanceId, + origin: body.origin, + scope: body.scope, + credentialGeneration: body.credentialGeneration, + }; + } + throw new ProprClientError('The ProPR instance returned an invalid pairing status.', { + kind: 'invalid_response', + }); + } + } finally { + clock.clearTimeout(deadlineTimer); + options.signal?.removeEventListener('abort', abortForCaller); + } +}; + +export const parseDesktopPairingActivationReceipt = (value: unknown): ProprDesktopPairingActivationReceipt => { + const body = record(value); + if (body.status !== 'active' || !string(body.receipt) || !/^[A-Za-z0-9_-]{22}$/.test(body.receipt) + || !string(body.activatedAt) || !Number.isFinite(Date.parse(body.activatedAt)) + || !(body.expiresAt === null || (string(body.expiresAt) && Number.isFinite(Date.parse(body.expiresAt)))) + || Object.keys(body).some(key => !['status', 'receipt', 'activatedAt', 'expiresAt'].includes(key))) { + throw new ProprClientError('The ProPR instance returned an invalid pairing activation receipt.', { + kind: 'invalid_response', + }); + } + return body as unknown as ProprDesktopPairingActivationReceipt; +}; diff --git a/packages/client/src/errors.ts b/packages/client/src/errors.ts index 6a5af7ae1..75ed8fa8b 100644 --- a/packages/client/src/errors.ts +++ b/packages/client/src/errors.ts @@ -8,6 +8,10 @@ export type ProprClientErrorKind = | 'invalid_response' | 'compatibility'; +/** The exact credential-free public discovery request was authentication-gated. */ +export const DESKTOP_DISCOVERY_AUTHENTICATION_REQUIRED = + 'DESKTOP_DISCOVERY_AUTHENTICATION_REQUIRED' as const; + export interface ProprClientErrorOptions { kind: ProprClientErrorKind; status?: number; diff --git a/packages/client/src/index.ts b/packages/client/src/index.ts index 2d3bf4aea..84f5a37ab 100644 --- a/packages/client/src/index.ts +++ b/packages/client/src/index.ts @@ -1,7 +1,10 @@ export { apiUrl, + classifyApiBaseUrl, normalizeApiBaseUrl, type NormalizeApiBaseUrlOptions, + type ProprApiEndpointClassification, + type ProprApiEndpointKind, type ProprApiBaseUrl, } from './baseUrl.js'; export { @@ -12,11 +15,25 @@ export { type ProprRequestOptions, } from './client.js'; export { + DESKTOP_DISCOVERY_AUTHENTICATION_REQUIRED, isProprClientError, ProprClientError, type ProprClientErrorKind, type ProprClientErrorOptions, } from './errors.js'; +export { + completeDesktopPairing, + parseDesktopDiscovery, + parseDesktopPairingStart, + parseDesktopPairingActivationReceipt, + type ProprDesktopPairingActivationReceipt, + type ProprDesktopPairingBinding, + type ProprDesktopDiscovery, + type ProprDesktopPairingComplete, + type ProprDesktopPairingOptions, + type ProprDesktopPairingStart, +} from './desktopPairing.js'; +export type { PairingProtocolRequestOptions } from './pairingProtocol.js'; export { normalizeInstanceProfile, type NormalizedProprInstanceProfile, diff --git a/packages/client/src/pairingProtocol.ts b/packages/client/src/pairingProtocol.ts new file mode 100644 index 000000000..bbb8ba49b --- /dev/null +++ b/packages/client/src/pairingProtocol.ts @@ -0,0 +1,349 @@ +import { ProprClientError } from './errors.js'; + +const CONNECT_HEADER_TIMEOUT_MS = 8_000; +const BODY_TIMEOUT_MS = 8_000; +const OVERALL_TIMEOUT_MS = CONNECT_HEADER_TIMEOUT_MS + BODY_TIMEOUT_MS; +const CANCELLATION_TIMEOUT_MS = 100; +const MAX_RESPONSE_BYTES = 4_096; +const MAX_ENCODED_RESPONSE_BYTES = 4_096; +const CANCELLATION_TIMEOUT_DIAGNOSTIC = 'ProPR pairing response cancellation exceeded its fixed deadline.'; + +type TimeoutPhase = 'connect-header' | 'body' | 'overall'; +type ContentEncoding = 'identity' | 'gzip' | 'br'; + +export interface PairingProtocolRequestOptions { + overallTimeoutMs?: number; + /** @internal Reclassifies only the overall boundary owned by a caller. */ + overallTimeoutError?: (cause?: unknown) => ProprClientError; + /** @internal Deterministic protocol-test deadlines may only shorten production limits. */ + deadlines?: Partial<{ + headerMs: number; + bodyMs: number; + cancellationMs: number; + }>; + /** @internal Receives only a fixed, redacted cancellation diagnostic. */ + reportDiagnostic?: (message: string) => void; + /** @internal Deterministic monotonic timer source for protocol tests. */ + clock?: { + now(): number; + setTimeout(callback: () => void, milliseconds: number): ReturnType; + clearTimeout(timer: ReturnType): void; + }; +} + +const timeoutError = (cause?: unknown): ProprClientError => + new ProprClientError('The ProPR desktop pairing request timed out.', { kind: 'timeout', cause }); + +const cancelledError = (cause?: unknown): ProprClientError => + new ProprClientError('Desktop pairing was cancelled.', { kind: 'aborted', cause }); + +const invalidResponse = (status?: number, cause?: unknown): ProprClientError => + new ProprClientError('The ProPR desktop pairing service returned an invalid response.', { + kind: 'invalid_response', + status, + cause, + }); + +const networkError = (cause?: unknown): ProprClientError => + new ProprClientError('The ProPR desktop pairing service could not be reached.', { + kind: 'network', + cause, + }); + +const errorCode = (value: unknown): string | undefined => { + if (!value || typeof value !== 'object' || Array.isArray(value)) return undefined; + const body = value as Record; + if (Object.keys(body).some(key => !['code', 'error'].includes(key)) + || typeof body.code !== 'string' + || !/^[A-Z][A-Z0-9_]{0,63}$/.test(body.code) + || typeof body.error !== 'string' + || body.error.length < 1 + || body.error.length > 256) return undefined; + return body.code; +}; + +const positiveTimeout = (value: number | undefined): number => { + const timeout = value ?? OVERALL_TIMEOUT_MS; + if (!Number.isSafeInteger(timeout) || timeout < 1 || timeout > OVERALL_TIMEOUT_MS) { + throw new ProprClientError('Desktop pairing request deadlines are invalid.', { + kind: 'configuration', + }); + } + return timeout; +}; + +const boundedDeadline = (value: number | undefined, maximum: number): number => { + const deadline = value ?? maximum; + if (!Number.isSafeInteger(deadline) || deadline < 1 || deadline > maximum) { + throw new ProprClientError('Desktop pairing request deadlines are invalid.', { + kind: 'configuration', + }); + } + return deadline; +}; + +const contentLength = (response: Response): number | undefined => { + const raw = response.headers.get('content-length'); + if (raw === null) return undefined; + if (!/^(?:0|[1-9][0-9]*)$/.test(raw)) throw invalidResponse(response.status); + const value = Number(raw); + if (!Number.isSafeInteger(value)) throw invalidResponse(response.status); + return value; +}; + +const contentEncoding = (response: Response): ContentEncoding => { + const raw = response.headers.get('content-encoding'); + if (raw === null) return 'identity'; + const encoding = raw.trim().toLowerCase(); + if (encoding !== 'identity' && encoding !== 'gzip' && encoding !== 'br') { + // A comma also makes duplicate and stacked encodings fail closed. Fetch + // exposes transparently decoded bytes, so only one known wire encoding can + // be related safely to the remaining response metadata. + throw invalidResponse(response.status); + } + return encoding; +}; + +/** + * Reads one pairing response under a single cancellation owner. The caller's + * signal and all timers remain installed until the response stream is complete + * or has been cancelled, so receiving headers never releases the operation. + */ +export const requestPairingProtocol = async ( + fetchImplementation: typeof globalThis.fetch, + target: RequestInfo | URL, + init: RequestInit, + options: PairingProtocolRequestOptions = {}, +): Promise => { + const callerSignal = init.signal; + const overallTimeoutMs = positiveTimeout(options.overallTimeoutMs); + const headerTimeoutMs = boundedDeadline(options.deadlines?.headerMs, CONNECT_HEADER_TIMEOUT_MS); + const bodyTimeoutMs = boundedDeadline(options.deadlines?.bodyMs, BODY_TIMEOUT_MS); + const cancellationTimeoutMs = boundedDeadline( + options.deadlines?.cancellationMs, + CANCELLATION_TIMEOUT_MS, + ); + const reportDiagnostic = options.reportDiagnostic ?? ((message: string) => console.warn(message)); + const clock = options.clock ?? { + now: () => performance.now(), + setTimeout: (callback: () => void, milliseconds: number) => setTimeout(callback, milliseconds), + clearTimeout: (timer: ReturnType) => clearTimeout(timer), + }; + const reportCancellationTimeout = (): void => { + try { + reportDiagnostic(CANCELLATION_TIMEOUT_DIAGNOSTIC); + } catch { + // A diagnostic hook must never change transport or shutdown settlement. + } + }; + const controller = new AbortController(); + const startedAt = clock.now(); + let timeoutPhase: TimeoutPhase | undefined; + let headerTimer: ReturnType | undefined; + let bodyTimer: ReturnType | undefined; + let overallTimer: ReturnType | undefined; + let response: Response | undefined; + let reader: ReadableStreamDefaultReader | undefined; + + const abortForCaller = (): void => controller.abort(callerSignal?.reason); + const abortForTimeout = (phase: TimeoutPhase): void => { + if (controller.signal.aborted) return; + timeoutPhase = phase; + controller.abort(new DOMException('Desktop pairing deadline exceeded', 'TimeoutError')); + }; + const raceCancellation = (operation: PromiseLike): Promise => new Promise((resolve, reject) => { + let settled = false; + const finish = (callback: () => void): void => { + if (settled) return; + settled = true; + controller.signal.removeEventListener('abort', aborted); + callback(); + }; + const aborted = () => finish(() => reject( + controller.signal.reason ?? new DOMException('Aborted', 'AbortError'), + )); + if (controller.signal.aborted) aborted(); + else controller.signal.addEventListener('abort', aborted, { once: true }); + // Both handlers remain attached to the foreign promise after our abort + // wins. A later resolve/reject is deliberately consumed and cannot alter + // endpoint state or become an unhandled rejection. + Promise.resolve(operation).then( + value => finish(() => resolve(value)), + error => finish(() => reject(error)), + ); + }); + const remainingOverall = (): number => Math.max( + 0, + overallTimeoutMs - (clock.now() - startedAt), + ); + const cancelResponse = async (): Promise => { + const cancelTarget = reader ?? response?.body; + if (!cancelTarget) return; + let cancellation: Promise; + try { + cancellation = Promise.resolve(cancelTarget.cancel()); + } catch { + return; + } + // Attach a rejection handler before doing anything else. The underlying + // stream controls this promise and may reject long after local shutdown. + let cancellationSettled = false; + const settled = cancellation.then( + () => { cancellationSettled = true; return true; }, + () => { cancellationSettled = true; return true; }, + ); + const budget = Math.min(cancellationTimeoutMs, remainingOverall()); + if (budget <= 0) { + // Give an already-settled cancellation its queued promise reaction, but + // never install or await a foreign task beyond the overall boundary. + await Promise.resolve(); + if (!cancellationSettled) reportCancellationTimeout(); + return; + } + let cancellationTimer: ReturnType | undefined; + const cancelledInBudget = await Promise.race([ + settled, + new Promise(resolve => { + cancellationTimer = clock.setTimeout(() => resolve(false), budget); + }), + ]); + if (cancellationTimer) clock.clearTimeout(cancellationTimer); + if (!cancelledInBudget) reportCancellationTimeout(); + }; + + if (callerSignal?.aborted) abortForCaller(); + else callerSignal?.addEventListener('abort', abortForCaller, { once: true }); + if (!controller.signal.aborted) { + overallTimer = clock.setTimeout(() => abortForTimeout('overall'), overallTimeoutMs); + headerTimer = clock.setTimeout( + () => abortForTimeout('connect-header'), + Math.min(headerTimeoutMs, overallTimeoutMs), + ); + } + + try { + // Promise argument evaluation would otherwise call an untrusted fetch even + // when disposal/caller cancellation was already complete. + if (controller.signal.aborted) { + throw controller.signal.reason ?? new DOMException('Aborted', 'AbortError'); + } + response = await raceCancellation(fetchImplementation(target, { + ...init, + redirect: 'manual', + signal: controller.signal, + })); + if (headerTimer) clock.clearTimeout(headerTimer); + headerTimer = undefined; + + // Browsers may expose a manual cross-origin redirect as opaqueredirect + // rather than preserving its 3xx status. Both forms are terminal and their + // bodies are never parsed. + if ((response.status >= 300 && response.status < 400) + || response.type === 'opaqueredirect' + || response.status === 0) { + throw invalidResponse(response.status || undefined); + } + + const encoding = contentEncoding(response); + const declaredLength = contentLength(response); + // Content-Length describes the encoded wire representation. Bound it for + // every supported encoding before reading Fetch's decoded response stream. + const maximumDeclaredLength = encoding === 'identity' + ? MAX_RESPONSE_BYTES + : MAX_ENCODED_RESPONSE_BYTES; + if (declaredLength !== undefined && declaredLength > maximumDeclaredLength) { + throw invalidResponse(response.status); + } + if (!response.body) { + if (!response.ok) { + throw new ProprClientError(`Desktop pairing request failed with HTTP ${response.status}.`, { + kind: 'http', + status: response.status, + }); + } + throw invalidResponse(response.status); + } + + reader = response.body.getReader(); + bodyTimer = clock.setTimeout( + () => abortForTimeout('body'), + Math.min(bodyTimeoutMs, overallTimeoutMs), + ); + const chunks: Uint8Array[] = []; + let byteLength = 0; + while (true) { + const part = await raceCancellation(reader.read()); + if (part.done) break; + if (!(part.value instanceof Uint8Array) || part.value.byteLength === 0) { + throw invalidResponse(response.status); + } + byteLength += part.value.byteLength; + if (byteLength > MAX_RESPONSE_BYTES) throw invalidResponse(response.status); + chunks.push(part.value); + } + // For gzip and Brotli, Fetch retains the wire Content-Length while exposing + // transparently decoded stream chunks. It is not meaningful to compare the + // compressed length with byteLength; the decoded cap above remains the + // authoritative bound. Identity responses still require an exact match. + if (encoding === 'identity' + && declaredLength !== undefined + && declaredLength !== byteLength) { + throw invalidResponse(response.status); + } + + const bytes = new Uint8Array(byteLength); + let offset = 0; + for (const chunk of chunks) { + bytes.set(chunk, offset); + offset += chunk.byteLength; + } + let text: string; + try { + text = new TextDecoder('utf-8', { fatal: true }).decode(bytes); + } catch (cause) { + throw invalidResponse(response.status, cause); + } + + let value: unknown; + try { + value = JSON.parse(text) as unknown; + } catch (cause) { + if (!response.ok) value = undefined; + else throw invalidResponse(response.status, cause); + } + if (!response.ok) { + throw new ProprClientError(`Desktop pairing request failed with HTTP ${response.status}.`, { + kind: 'http', + status: response.status, + code: errorCode(value), + }); + } + const contentType = response.headers.get('content-type')?.split(';', 1)[0]?.trim().toLowerCase(); + if (contentType !== 'application/json') throw invalidResponse(response.status); + return value; + } catch (cause) { + if (cause instanceof ProprClientError) throw cause; + if (callerSignal?.aborted) throw cancelledError(cause); + if (timeoutPhase) { + if (timeoutPhase === 'overall' && options.overallTimeoutError) { + throw options.overallTimeoutError(cause); + } + throw timeoutError(cause); + } + if (cause instanceof Error && cause.name === 'AbortError') throw cancelledError(cause); + throw networkError(cause); + } finally { + // Network ownership ends before touching the untrusted stream primitive. + // All local timers/listeners are detached first; cancellation then gets a + // separate short budget which is also clamped to the endpoint deadline. + if (!controller.signal.aborted) controller.abort(); + if (headerTimer) clock.clearTimeout(headerTimer); + if (bodyTimer) clock.clearTimeout(bodyTimer); + if (overallTimer) clock.clearTimeout(overallTimer); + callerSignal?.removeEventListener('abort', abortForCaller); + await cancelResponse(); + try { reader?.releaseLock(); } catch { /* The stream may already be errored. */ } + reader = undefined; + response = undefined; + } +}; diff --git a/packages/client/src/socket.ts b/packages/client/src/socket.ts index b59d6f342..b6bdefc50 100644 --- a/packages/client/src/socket.ts +++ b/packages/client/src/socket.ts @@ -20,17 +20,43 @@ export interface ProprSocketConnection { options: ProprSocketOptions; } -const bearerSocketAuth = (getAccessToken: AccessTokenProvider): SocketOptions['auth'] => - (callback: (data: Record) => void): void => { +type SocketAuthPayload = Record; +type SocketAuthCallback = (data: SocketAuthPayload) => void; + +const metadataWithoutToken = (value: unknown): SocketAuthPayload => { + if (!value || typeof value !== 'object' || Array.isArray(value)) return {}; + const { token: _untrustedToken, ...metadata } = value as SocketAuthPayload; + return metadata; +}; + +const bearerSocketAuth = ( + getAccessToken: AccessTokenProvider, + configuredAuth: SocketOptions['auth'], +): SocketOptions['auth'] => (callback: SocketAuthCallback): void => { + const resolveBearer = (metadataValue: unknown): void => { + const metadata = metadataWithoutToken(metadataValue); Promise.resolve(getAccessToken()).then( token => { const normalized = token?.trim(); - callback(normalized && !/\r|\n/.test(normalized) ? { token: normalized } : {}); + callback(normalized && !/\r|\n/.test(normalized) + ? { ...metadata, token: normalized } + : metadata); }, - () => callback({}) + () => callback(metadata), ); }; + if (typeof configuredAuth === 'function') { + try { + configuredAuth(resolveBearer); + } catch { + resolveBearer({}); + } + return; + } + resolveBearer(configuredAuth); +}; + /** Build the complete, explicit reconnect policy used by every ProPR surface. */ export const buildSocketConnection = ( baseUrl: ProprApiBaseUrl, @@ -38,7 +64,7 @@ export const buildSocketConnection = ( overrides: ProprSocketOptions = {} ): ProprSocketConnection => { const auth = authentication.type === 'bearer' - ? bearerSocketAuth(authentication.getAccessToken) + ? bearerSocketAuth(authentication.getAccessToken, overrides.auth) : undefined; return { @@ -55,7 +81,7 @@ export const buildSocketConnection = ( randomizationFactor: 0.5, timeout: 20_000, ...overrides, - ...(auth && overrides.auth === undefined ? { auth } : {}), + ...(auth ? { auth } : {}), }, }; }; diff --git a/packages/client/test/client.test.ts b/packages/client/test/client.test.ts index dae6a6b7a..7f331678f 100644 --- a/packages/client/test/client.test.ts +++ b/packages/client/test/client.test.ts @@ -1,7 +1,8 @@ import assert from 'node:assert/strict'; import { describe, it } from 'node:test'; -import { PROPR_API_COMPATIBILITY } from '@propr/shared'; +import { PROPR_API_COMPATIBILITY, PROPR_API_ORIGIN_PARITY_CASES } from '@propr/shared'; import { + classifyApiBaseUrl, ProprClient, ProprClientError, normalizeApiBaseUrl, @@ -9,9 +10,17 @@ import { } from '../src/index.js'; describe('Propr API base URLs and instance profiles', () => { + it('matches the shared canonical origin parity table', () => { + for (const [name, input, expected] of PROPR_API_ORIGIN_PARITY_CASES) { + if (expected === null) assert.throws(() => normalizeApiBaseUrl(input), ProprClientError, name); + else assert.equal(normalizeApiBaseUrl(input), expected, name); + } + }); it('supports browser same-origin, loopback, and secure remote instances', () => { assert.equal(normalizeApiBaseUrl(), ''); - assert.equal(normalizeApiBaseUrl(' http://localhost:4000/// '), 'http://localhost:4000'); + assert.equal(normalizeApiBaseUrl(' http://localhost:4000/ '), 'http://localhost:4000'); + assert.equal(normalizeApiBaseUrl('http://api.dev.localhost:3000'), 'http://api.dev.localhost:3000'); + assert.equal(normalizeApiBaseUrl('http://127.42.7.9:3000'), 'http://127.42.7.9:3000'); assert.equal(normalizeApiBaseUrl('http://127.0.0.1:3000'), 'http://127.0.0.1:3000'); assert.equal(normalizeApiBaseUrl('http://[::1]:3000'), 'http://[::1]:3000'); assert.equal(normalizeApiBaseUrl('https://propr.example.com/'), 'https://propr.example.com'); @@ -34,13 +43,94 @@ describe('Propr API base URLs and instance profiles', () => { 'https://propr.example.com/api', 'https://propr.example.com?token=secret', 'http://propr.example.com', + 'https://t-instance123.propr.dev:443', + 'https://t-instance123.propr.dev:8443', + ' https://t-instance123.propr.dev', + 'https://t-instance123.propr.dev ', + 'https://t-instance123.propr.dev/', + 'https://t-instance123.propr.dev//', + 'HTTPS://t-instance123.propr.dev', + 'https://T-instance123.propr.dev', + 'https://t-%69nstance123.propr.dev', + 'https://t-instance123.propr%2edev', + 'https://x.t-instance123.propr.dev', + 'https://nested.t-instance123.propr.dev', + 'http://localhost.:3000', + 'http://127.1:3000', + 'http://0177.0.0.1:3000', + 'http://0x7f000001:3000', + 'http://[::ffff:127.0.0.1]:3000', ]) { assert.throws(() => normalizeApiBaseUrl(value), ProprClientError); } }); + + it('classifies only the canonical hosted ProPR Connect origin as verified', () => { + assert.deepEqual(classifyApiBaseUrl('https://t-instance-123.propr.dev'), { + baseUrl: 'https://t-instance-123.propr.dev', + kind: 'propr-connect', + connectInstanceId: 'instance-123', + }); + assert.equal(classifyApiBaseUrl('http://127.0.0.1:4000').kind, 'loopback'); + assert.equal(classifyApiBaseUrl('https://propr.example.com').kind, 'remote'); + + for (const rejectedReserved of [ + 'https://t-instance-123.foo.propr.dev', + 'https://x.t-instance-123.propr.dev', + 'https://t-\u0430bc.propr.dev', + ]) { + assert.throws(() => classifyApiBaseUrl(rejectedReserved), (error: unknown) => + error instanceof ProprClientError + && error.code === 'INVALID_API_BASE_URL' + && !error.message.includes(rejectedReserved)); + } + + for (const lookalike of [ + 'https://t-instance-123.propr.dev.example.com', + 'https://t-abc.pr\u03bfpr.dev', + ]) { + assert.notEqual(classifyApiBaseUrl(lookalike).kind, 'propr-connect', lookalike); + } + }); + + it('bounds malformed configuration and reports only a fixed safe code and message', () => { + const unsafeValues = [ + 'https://user:password-sentinel@t-instance123.propr.dev', + 'https://t-instance123.propr.dev?token=query-token-sentinel', + `https://example.com/${'private-path-sentinel'.repeat(200)}`, + ]; + for (const value of unsafeValues) { + assert.throws(() => normalizeApiBaseUrl(value), (error: unknown) => { + assert.ok(error instanceof ProprClientError); + assert.equal(error.code, 'INVALID_API_BASE_URL'); + assert.equal(error.message, 'The configured ProPR API URL is invalid.'); + assert.doesNotMatch(JSON.stringify(error), /password-sentinel|query-token-sentinel|private-path-sentinel/); + return true; + }); + } + }); }); describe('ProprClient REST transport', () => { + it('routes Connect status and REST calls directly to the verified origin', async () => { + const calls: string[] = []; + const client = new ProprClient({ + baseUrl: 'https://t-instance123.propr.dev', + authentication: { type: 'none' }, + fetch: async input => { + calls.push(input.toString()); + return new Response('{}', { status: 200, headers: { 'Content-Type': 'application/json' } }); + }, + }); + + await client.request('/api/status'); + await client.request('/api/tasks'); + assert.deepEqual(calls, [ + 'https://t-instance123.propr.dev/api/status', + 'https://t-instance123.propr.dev/api/tasks', + ]); + }); + it('adds a fresh bearer token without exposing it in the endpoint', async () => { const calls: Array<[RequestInfo | URL, RequestInit | undefined]> = []; const client = new ProprClient({ @@ -52,10 +142,11 @@ describe('ProprClient REST transport', () => { }, }); - await client.request('/api/status'); + await client.request('/api/status', { credentials: 'include' }); assert.equal(calls[0][0], 'https://propr.example.com/api/status'); assert.equal(new Headers(calls[0][1]?.headers).get('Authorization'), 'Bearer secret-token'); + assert.equal(calls[0][1]?.credentials, 'omit'); assert.doesNotMatch(String(calls[0][0]), /secret-token/); }); diff --git a/packages/client/test/connectPairing.test.ts b/packages/client/test/connectPairing.test.ts new file mode 100644 index 000000000..53a41401a --- /dev/null +++ b/packages/client/test/connectPairing.test.ts @@ -0,0 +1,106 @@ +import assert from 'node:assert/strict'; +import { describe, it } from 'node:test'; +import { normalizeDesktopPairingApprovalUrl } from '@propr/shared'; + +const pairingId = 'dpr_ABCDEFGHIJKLMNOPQRSTUV'; +const apiBaseUrl = 'https://t-instance123.propr.dev'; + +describe('ProPR Connect desktop pairing approval URLs', () => { + it('accepts the API-returned hosted approval and exact tunnel browser fallback', () => { + assert.equal(normalizeDesktopPairingApprovalUrl({ + apiBaseUrl, + pairingId, + approvalUrl: `https://app.propr.dev/desktop/pairing?pairing_id=${pairingId}&tunnel=t-instance123.propr.dev`, + }), `https://app.propr.dev/desktop/pairing?pairing_id=${pairingId}&tunnel=t-instance123.propr.dev`); + + assert.equal(normalizeDesktopPairingApprovalUrl({ + apiBaseUrl, + pairingId, + approvalUrl: `${apiBaseUrl}/api/desktop/pairings/${pairingId}/browser`, + }), `${apiBaseUrl}/api/desktop/pairings/${pairingId}/browser`); + }); + + it('rejects synthesized, cross-origin, private, and secret-bearing approval URLs', () => { + for (const approvalUrl of [ + `https://app.propr.dev/desktop/pairing?pairing_id=${pairingId}`, + `https://app.propr.dev/desktop/pairing?pairing_id=${pairingId}&tunnel=t-other.propr.dev`, + `https://app.propr.dev/desktop/pairing?pairing_id=${pairingId}&tunnel=t-instance123.propr.dev&token=secret`, + `https://app.propr.dev/desktop/pairing?pairing_id=dpr_1234567890123456789012&tunnel=t-instance123.propr.dev`, + `https://evil.example/desktop/pairing?pairing_id=${pairingId}&tunnel=t-instance123.propr.dev`, + `${apiBaseUrl}/api/desktop/pairings/${pairingId}/approval`, + `${apiBaseUrl}/api/desktop/pairings/${pairingId}/browser?device_secret=secret`, + `https://user:secret@t-instance123.propr.dev/api/desktop/pairings/${pairingId}/browser`, + `https://t-%69nstance123.propr.dev/api/desktop/pairings/${pairingId}/browser`, + `https://t-instance123.propr.dev:443/api/desktop/pairings/${pairingId}/browser`, + ]) { + assert.equal(normalizeDesktopPairingApprovalUrl({ apiBaseUrl, pairingId, approvalUrl }), null, approvalUrl); + } + }); + + it('matches the hosted UI raw query contract for approval parameters', () => { + for (const approvalUrl of [ + `https://app.propr.dev/desktop/pairing?pairing_id=${pairingId}&tunnel=t%2Dinstance123.propr.dev`, + `https://app.propr.dev/desktop/pairing?pairing_id=${pairingId}&%74unnel=t-instance123.propr.dev`, + `https://app.propr.dev/desktop/pairing?pairing%5Fid=${pairingId}&tunnel=t-instance123.propr.dev`, + `https://app.propr.dev/desktop/pairing?pairing_id=dpr%5FABCDEFGHIJKLMNOPQRSTUV&tunnel=t-instance123.propr.dev`, + ]) { + assert.equal(normalizeDesktopPairingApprovalUrl({ apiBaseUrl, pairingId, approvalUrl }), null, approvalUrl); + } + }); + + it('requires a normalized, validated API origin', () => { + const approvalUrl = `${apiBaseUrl}/api/desktop/pairings/${pairingId}/browser`; + for (const untrustedBase of [ + `${apiBaseUrl}/`, + 'https://t-instance123.propr.dev:443', + 'https://t-%69nstance123.propr.dev', + 'http://remote.example.com', + ]) { + assert.equal(normalizeDesktopPairingApprovalUrl({ + apiBaseUrl: untrustedBase, + pairingId, + approvalUrl, + }), null); + } + }); + + it('does not grant the hosted approval contract to Connect lookalikes', () => { + assert.equal(normalizeDesktopPairingApprovalUrl({ + apiBaseUrl: 'https://t-instance123.foo.propr.dev', + pairingId, + approvalUrl: `https://app.propr.dev/desktop/pairing?pairing_id=${pairingId}&tunnel=t-instance123.foo.propr.dev`, + }), null); + }); + + it('rejects every noncanonical reserved-host base before generic HTTPS fallback', () => { + for (const untrustedBase of [ + 'https://t-instance123.propr.dev:443', + 'https://t-instance123.propr.dev:8443', + 'https://user:secret@t-instance123.propr.dev', + 'https://t-%69nstance123.propr.dev', + 'https://t-instance123.propr.dev.', + 'https://t-instance123.foo.propr.dev', + 'http://localhost.:4000', + 'http://api.dev.localhost.:4000', + ]) { + assert.equal(normalizeDesktopPairingApprovalUrl({ + apiBaseUrl: untrustedBase, + pairingId, + approvalUrl: `${untrustedBase}/api/desktop/pairings/${pairingId}/browser`, + }), null, untrustedBase); + } + }); + + it('preserves unrelated HTTPS remotes, outside lookalikes, and loopback HTTP', () => { + for (const baseUrl of [ + 'https://remote.example.com', + 'https://t-instance123.propr.dev.example.com', + 'http://127.0.0.1:4000', + 'http://localhost:4000', + 'http://api.dev.localhost:4000', + ]) { + const approvalUrl = `${baseUrl}/api/desktop/pairings/${pairingId}/browser`; + assert.equal(normalizeDesktopPairingApprovalUrl({ apiBaseUrl: baseUrl, pairingId, approvalUrl }), approvalUrl); + } + }); +}); diff --git a/packages/client/test/desktopPairing.test.ts b/packages/client/test/desktopPairing.test.ts new file mode 100644 index 000000000..cdd59a678 --- /dev/null +++ b/packages/client/test/desktopPairing.test.ts @@ -0,0 +1,739 @@ +import assert from 'node:assert/strict'; +import { describe, it } from 'node:test'; +import { PROPR_API_COMPATIBILITY, PROPR_UI_COMPATIBILITY } from '@propr/shared'; +import { + DESKTOP_DISCOVERY_AUTHENTICATION_REQUIRED, + ProprClient, + ProprClientError, +} from '../src/index.js'; + +const json = (body: unknown, status = 200): Response => new Response(JSON.stringify(body), { + status, + headers: { 'Content-Type': 'application/json' }, +}); + +const discovery = { + schemaVersion: 1 as const, + product: 'ProPR', + version: '0.8.15', + apiCompatibility: PROPR_API_COMPATIBILITY, + uiCompatibility: PROPR_UI_COMPATIBILITY, + canonicalEndpoint: null, + publicInstanceIdentity: '123e4567-e89b-42d3-a456-426614174000', + desktopAuthentication: { + protocolVersion: 2 as const, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, +}; +const protocolNow = Date.parse('2026-01-01T00:00:00.000Z'); +const protocolDeadline = new Date(protocolNow + 10 * 60 * 1000).toISOString(); +const binding = { + instanceId: 'profile-a', + origin: 'https://propr.example.test', + scope: 'desktop-instance' as const, + credentialGeneration: 'G'.repeat(22), +}; +const bounded = (promise: Promise, milliseconds = 1_000): Promise => { + let timer: ReturnType | undefined; + const timeout = new Promise((_resolve, reject) => { + timer = setTimeout(() => reject(new Error('Pairing did not settle within the test timeout')), milliseconds); + }); + return Promise.race([promise, timeout]).finally(() => { + if (timer) clearTimeout(timer); + }); +}; + +class PairingClock { + #now = 0; + #nextId = 1; + readonly #timers = new Map void }>(); + + readonly source = { + now: (): number => this.#now, + setTimeout: (callback: () => void, milliseconds: number): ReturnType => { + const id = this.#nextId++; + this.#timers.set(id, { at: this.#now + milliseconds, callback }); + return id as unknown as ReturnType; + }, + clearTimeout: (timer: ReturnType): void => { + this.#timers.delete(timer as unknown as number); + }, + }; + + async advanceAfterSchedulerDelay(milliseconds: number): Promise { + this.#now += milliseconds; + while (true) { + const due = [...this.#timers.entries()] + .filter(([, timer]) => timer.at <= this.#now) + .sort(([leftId, left], [rightId, right]) => left.at - right.at || leftId - rightId)[0]; + if (!due) break; + this.#timers.delete(due[0]); + due[1].callback(); + await Promise.resolve(); + await Promise.resolve(); + } + } +} + +describe('desktop instance protocol', () => { + it('strictly classifies only the credential-free public discovery 401', async () => { + const legacy = new ProprClient({ + baseUrl: 'https://propr.example.test', + authentication: { type: 'none' }, + fetch: async (_input, init) => { + assert.equal(init?.credentials, 'omit'); + assert.equal(init?.redirect, 'manual'); + return new Response('{ "error": "Unauthorized" }', { + status: 401, headers: { 'Content-Type': 'application/json' }, + }); + }, + }); + await assert.rejects(legacy.discoverDesktop(), (error: unknown) => + error instanceof ProprClientError + && error.kind === 'invalid_response' + && error.status === 401 + && error.code === DESKTOP_DISCOVERY_AUTHENTICATION_REQUIRED); + + const oversized = `{"error":"Unauthorized","padding":"${'x'.repeat(8 * 1024)}"}`; + const invalidResponses = [ + new Response(null, { status: 401, headers: { 'Content-Type': 'application/json' } }), + new Response('

Policy login required

', { + status: 401, headers: { 'Content-Type': 'text/html' }, + }), + new Response('{"error":', { + status: 401, headers: { 'Content-Type': 'application/json' }, + }), + new Response('{"error":"Unauthorized","error":"Unauthorized"}', { + status: 401, headers: { 'Content-Type': 'application/json' }, + }), + new Response('{"error":"Unauthorized","code":"PROXY_POLICY"}', { + status: 401, headers: { 'Content-Type': 'application/json' }, + }), + new Response('{"code":"AUTHENTICATION_REQUIRED"}', { + status: 401, headers: { 'Content-Type': 'application/json' }, + }), + new Response('{"error":"private proxy policy detail"}', { + status: 401, headers: { 'Content-Type': 'application/json' }, + }), + new Response('{"error":"Unauthorized"}', { + status: 401, + headers: { 'Content-Type': 'application/json', 'Content-Length': '8193' }, + }), + new Response(oversized, { + status: 401, headers: { 'Content-Type': 'application/json' }, + }), + new Response(new Uint8Array([0x7b, 0x22, 0xff, 0x22, 0x7d]), { + status: 401, headers: { 'Content-Type': 'application/json' }, + }), + new Response('{"error":"Unauthorized"}', { + status: 401, + headers: { 'Content-Type': 'application/json', 'Content-Length': '1' }, + }), + new Response('{"error":"Unauthorized"}', { + status: 401, headers: { 'Content-Type': 'application/problem+json' }, + }), + ]; + const redirected = new Response('{"error":"Unauthorized"}', { + status: 401, headers: { 'Content-Type': 'application/json' }, + }); + Object.defineProperty(redirected, 'redirected', { value: true }); + invalidResponses.push(redirected); + + for (const response of invalidResponses) { + const client = new ProprClient({ + baseUrl: 'https://propr.example.test', + authentication: { type: 'none' }, + fetch: async () => response, + }); + await assert.rejects(client.discoverDesktop(), (error: unknown) => { + assert.ok(error instanceof ProprClientError); + assert.equal(error.kind, 'invalid_response'); + assert.equal(error.status, 401); + assert.equal(error.code, undefined); + assert.equal(error.body, undefined); + assert.equal(error.cause, undefined); + assert.doesNotMatch(JSON.stringify(error), /private proxy policy detail|Unauthorized/u); + return true; + }); + } + + const operational = new ProprClient({ + baseUrl: 'https://propr.example.test', + authentication: { type: 'none' }, + fetch: async () => json({ code: 'AUTHENTICATION_REQUIRED' }, 401), + }); + await assert.rejects(operational.request('/api/tasks'), (error: unknown) => + error instanceof ProprClientError + && error.kind === 'http' + && error.status === 401 + && error.code === 'AUTHENTICATION_REQUIRED'); + + }); + + it('uses the shared strict wire parser for missing, extra, malformed, duplicate, and oversized discovery', async () => { + const valid = JSON.stringify(discovery); + const invalidBodies = [ + JSON.stringify((({ publicInstanceIdentity: _omitted, ...rest }) => rest)(discovery)), + JSON.stringify({ ...discovery, account: 'must-not-be-present' }), + '{', + valid.replace('"product":"ProPR"', '"product":"ProPR","product":"ProPR"'), + `${valid}${' '.repeat(8 * 1024)}`, + JSON.stringify({ ...discovery, publicInstanceIdentity: discovery.publicInstanceIdentity.toUpperCase() }), + JSON.stringify({ ...discovery, desktopAuthentication: { + ...discovery.desktopAuthentication, protocolVersion: 1, + } }), + ]; + for (const body of invalidBodies) { + const client = new ProprClient({ + baseUrl: 'https://propr.example.test', + authentication: { type: 'none' }, + fetch: async () => new Response(body, { headers: { 'Content-Type': 'application/json' } }), + }); + await assert.rejects(client.discoverDesktop(), (error: unknown) => + error instanceof ProprClientError && error.kind === 'invalid_response'); + } + }); + + it('bounds discovery headers and body with one deadline and preserves caller cancellation', async () => { + let headerSignal: AbortSignal | null = null; + let resolveLateTimeout!: (response: Response) => void; + const stalledHeaders = new ProprClient({ + baseUrl: 'https://propr.example.test', + authentication: { type: 'none' }, + fetch: async (_input, init) => { + headerSignal = init?.signal ?? null; + return new Promise(resolve => { resolveLateTimeout = resolve; }); + }, + }); + await assert.rejects(bounded(stalledHeaders.discoverDesktop(20), 500), (error: unknown) => + error instanceof ProprClientError && error.kind === 'timeout'); + assert.equal(headerSignal?.aborted, true); + let timedOutBodyCancelled = 0; + resolveLateTimeout(new Response(new ReadableStream({ + start(controller) { controller.enqueue(new Uint8Array([1])); }, + cancel() { timedOutBodyCancelled += 1; }, + }))); + await new Promise(resolve => setImmediate(resolve)); + assert.equal(timedOutBodyCancelled, 1); + + let bodyCancelled = 0; + const stalledBody = new ProprClient({ + baseUrl: 'https://propr.example.test', + authentication: { type: 'none' }, + fetch: async () => new Response(new ReadableStream({ + start(controller) { + controller.enqueue(new TextEncoder().encode('{"error":"Unauthor')); + }, + cancel() { bodyCancelled += 1; }, + }), { status: 401, headers: { 'Content-Type': 'application/json' } }), + }); + await assert.rejects(bounded(stalledBody.discoverDesktop(20), 500), (error: unknown) => + error instanceof ProprClientError && error.kind === 'timeout'); + await new Promise(resolve => setImmediate(resolve)); + assert.equal(bodyCancelled, 1); + + const controller = new AbortController(); + let resolveLateCancellation!: (response: Response) => void; + const cancelled = new ProprClient({ + baseUrl: 'https://propr.example.test', + authentication: { type: 'none' }, + fetch: async () => new Promise(resolve => { resolveLateCancellation = resolve; }), + }).discoverDesktop(1_000, controller.signal); + controller.abort('caller cancelled'); + await assert.rejects(bounded(cancelled, 500), (error: unknown) => + error instanceof ProprClientError && error.kind === 'aborted'); + let abortedBodyCancelled = 0; + resolveLateCancellation(new Response(new ReadableStream({ + start(streamController) { streamController.enqueue(new Uint8Array([1])); }, + cancel() { abortedBodyCancelled += 1; }, + }))); + await new Promise(resolve => setImmediate(resolve)); + assert.equal(abortedBodyCancelled, 1); + + const preAborted = new AbortController(); + preAborted.abort('already cancelled'); + let preAbortedRequests = 0; + await assert.rejects(new ProprClient({ + baseUrl: 'https://propr.example.test', + authentication: { type: 'none' }, + fetch: async () => { + preAbortedRequests += 1; + return json(discovery); + }, + }).discoverDesktop(1_000, preAborted.signal), (error: unknown) => + error instanceof ProprClientError && error.kind === 'aborted'); + assert.equal(preAbortedRequests, 0); + + const synchronouslyCancelled = new AbortController(); + let synchronousBodyCancelled = 0; + const synchronousCancellation = new ProprClient({ + baseUrl: 'https://propr.example.test', + authentication: { type: 'none' }, + fetch: async () => { + synchronouslyCancelled.abort('cancelled during fetch'); + return new Response(new ReadableStream({ + start(streamController) { streamController.enqueue(new Uint8Array([1])); }, + cancel() { synchronousBodyCancelled += 1; }, + })); + }, + }).discoverDesktop(1_000, synchronouslyCancelled.signal); + await assert.rejects(synchronousCancellation, (error: unknown) => + error instanceof ProprClientError && error.kind === 'aborted'); + await new Promise(resolve => setImmediate(resolve)); + assert.equal(synchronousBodyCancelled, 1); + }); + + it('discovers capabilities, opens approval, and polls to a single opaque token', async () => { + const requests: Array<{ url: string; init?: RequestInit }> = []; + let polls = 0; + const client = new ProprClient({ + baseUrl: 'https://propr.example.test', + authentication: { type: 'none' }, + fetch: async (input, init) => { + const url = input.toString(); + requests.push({ url, init }); + if (url.endsWith('/api/desktop/discovery')) return json(discovery); + if (url.endsWith('/api/desktop/pairings')) return json({ + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: `https://propr.example.test/api/desktop/pairings/dpr_${'A'.repeat(22)}/browser`, + expiresAt: protocolDeadline, + interval: 2, + }, 201); + polls += 1; + return polls === 1 + ? json({ status: 'pending', interval: 3 }, 202) + : json({ + status: 'provisional', + token: `propr_it_${'C'.repeat(43)}`, + tokenType: 'Bearer', + activationTicket: 'T'.repeat(43), + activationExpiresAt: protocolDeadline, + ...binding, + }); + }, + }); + + const metadata = await client.discoverDesktop(); + assert.equal(metadata.compatibility.compatible, true); + assert.equal(metadata.desktopAuthentication.browserPairing, true); + + const opened: string[] = []; + const sleeps: number[] = []; + const complete = await client.pairDesktop('Test desktop', { + binding, + now: () => protocolNow, + sleep: async milliseconds => { sleeps.push(milliseconds); }, + onApprovalRequired: url => { opened.push(url); }, + }); + + assert.deepEqual(complete, { + token: `propr_it_${'C'.repeat(43)}`, + tokenType: 'Bearer', + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + activationTicket: 'T'.repeat(43), + activationExpiresAt: protocolDeadline, + ...binding, + }); + assert.deepEqual(opened, [`https://propr.example.test/api/desktop/pairings/dpr_${'A'.repeat(22)}/browser`]); + assert.deepEqual(sleeps, [2000, 3000]); + assert.equal(requests.every(request => !request.url.includes('B'.repeat(43))), true); + assert.equal(requests.filter(request => request.url.endsWith('/poll')).every(request => + String(request.init?.body).includes('B'.repeat(43))), true); + }); + + it('cancels and expires without another poll request', async () => { + const client = new ProprClient({ fetch: async () => { throw new Error('must not request'); } }); + const start = { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://propr.example.test/approve', + expiresAt: '2026-01-01T00:00:00.000Z', + interval: 1, + }; + await assert.rejects( + // Importing through the client keeps the public helper covered separately + // from the start endpoint. + import('../src/index.js').then(({ completeDesktopPairing }) => completeDesktopPairing(client, start, { + now: () => Date.parse('2026-01-01T00:00:00.000Z'), + })), + (error: unknown) => error instanceof ProprClientError && error.code === 'PAIRING_EXPIRED', + ); + + const controller = new AbortController(); + controller.abort(); + await assert.rejects( + import('../src/index.js').then(({ completeDesktopPairing }) => completeDesktopPairing(client, { + ...start, + expiresAt: protocolDeadline, + }, { signal: controller.signal })), + (error: unknown) => error instanceof ProprClientError && error.kind === 'aborted', + ); + }); + + it('expires while the approval callback is still pending and ignores its late completion', async () => { + const { completeDesktopPairing } = await import('../src/index.js'); + let finishApproval!: () => void; + let polls = 0; + const approvalStarted = new Promise(resolve => { finishApproval = resolve; }); + let completeApproval!: () => void; + const client = new ProprClient({ fetch: async () => { + polls += 1; + throw new Error('must not poll after approval expiry'); + } }); + const pairing = completeDesktopPairing(client, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://propr.example.test/approve', + expiresAt: new Date(Date.now() + 50).toISOString(), + interval: 1, + }, { + onApprovalRequired: () => new Promise(resolve => { + completeApproval = resolve; + finishApproval(); + }), + }); + + await approvalStarted; + await assert.rejects(bounded(pairing), (error: unknown) => + error instanceof ProprClientError && error.code === 'PAIRING_EXPIRED'); + completeApproval(); + await new Promise(resolve => setImmediate(resolve)); + assert.equal(polls, 0); + }); + + it('aborts while the approval callback is pending and handles a late callback rejection', async () => { + const { completeDesktopPairing } = await import('../src/index.js'); + const controller = new AbortController(); + let approvalStarted!: () => void; + const started = new Promise(resolve => { approvalStarted = resolve; }); + let rejectApproval!: (error: Error) => void; + const client = new ProprClient({ fetch: async () => { throw new Error('must not poll'); } }); + const pairing = completeDesktopPairing(client, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://propr.example.test/approve', + expiresAt: new Date(Date.now() + 60_000).toISOString(), + interval: 1, + }, { + signal: controller.signal, + onApprovalRequired: () => new Promise((_resolve, reject) => { + rejectApproval = reject; + approvalStarted(); + }), + }); + + await started; + controller.abort('test cancellation'); + await assert.rejects(bounded(pairing), (error: unknown) => + error instanceof ProprClientError && error.kind === 'aborted'); + rejectApproval(new Error('late approval failure')); + await new Promise(resolve => setImmediate(resolve)); + }); + + it('rejects an unsafe approval URL', async () => { + const client = new ProprClient({ + baseUrl: 'https://propr.example.test', + fetch: async () => json({ + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'http://remote.example.test/approve', + expiresAt: protocolDeadline, + interval: 2, + }, 201), + }); + await assert.rejects(client.startDesktopPairing('Desktop', { now: () => protocolNow }), (error: unknown) => + error instanceof ProprClientError && error.kind === 'invalid_response'); + }); + + it('enforces the browser request origin for same-origin pairing clients', async () => { + const locationDescriptor = Object.getOwnPropertyDescriptor(globalThis, 'location'); + Object.defineProperty(globalThis, 'location', { + configurable: true, + value: { origin: 'https://propr.example.test' }, + }); + try { + for (const [approvalUrl, accepted] of [ + ['https://propr.example.test/approve', true], + ['https://attacker.example.test/approve', false], + ] as const) { + const client = new ProprClient({ + fetch: async () => json({ + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl, + expiresAt: protocolDeadline, + interval: 2, + }, 201), + }); + if (accepted) { + await assert.doesNotReject(client.startDesktopPairing('Desktop', { now: () => protocolNow })); + } else { + await assert.rejects( + client.startDesktopPairing('Desktop', { now: () => protocolNow }), + (error: unknown) => error instanceof ProprClientError && error.kind === 'invalid_response', + ); + } + } + } finally { + if (locationDescriptor) Object.defineProperty(globalThis, 'location', locationDescriptor); + else Reflect.deleteProperty(globalThis, 'location'); + } + }); + + it('fails closed before pairing when a same-origin request has no browser origin', async () => { + const locationDescriptor = Object.getOwnPropertyDescriptor(globalThis, 'location'); + Reflect.deleteProperty(globalThis, 'location'); + let requests = 0; + try { + const client = new ProprClient({ fetch: async () => { + requests += 1; + throw new Error('must not request without a trusted origin'); + } }); + await assert.rejects( + client.startDesktopPairing('Desktop', { now: () => protocolNow }), + (error: unknown) => error instanceof ProprClientError && error.kind === 'configuration', + ); + assert.equal(requests, 0); + } finally { + if (locationDescriptor) Object.defineProperty(globalThis, 'location', locationDescriptor); + } + }); + + it('rejects cross-origin, credentialed, malformed, and invalid-deadline approval responses', async () => { + for (const override of [ + { approvalUrl: 'https://attacker.example.test/approve' }, + { approvalUrl: 'https://user:secret@propr.example.test/approve' }, + { approvalUrl: 'not a URL' }, + { expiresAt: 'not a deadline' }, + ]) { + const client = new ProprClient({ + baseUrl: 'https://propr.example.test', + fetch: async () => json({ + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://propr.example.test/approve', + expiresAt: protocolDeadline, + interval: 2, + ...override, + }, 201), + }); + await assert.rejects(client.startDesktopPairing('Desktop', { now: () => protocolNow }), (error: unknown) => + error instanceof ProprClientError && error.kind === 'invalid_response'); + } + }); + + it('cancels while the pairing start request is in flight', async () => { + const controller = new AbortController(); + let started!: () => void; + const requestStarted = new Promise(resolve => { started = resolve; }); + const client = new ProprClient({ + baseUrl: 'https://propr.example.test', + fetch: async (_input, init) => new Promise((_resolve, reject) => { + started(); + init?.signal?.addEventListener('abort', () => reject(new DOMException('cancelled', 'AbortError')), { once: true }); + }), + }); + + const pairing = client.pairDesktop('Desktop', { signal: controller.signal }); + await requestStarted; + controller.abort(); + await assert.rejects(pairing, (error: unknown) => + error instanceof ProprClientError && error.kind === 'aborted'); + }); + + it('aborts a hung poll at the advertised deadline and reports expiry', async () => { + const expiresAt = new Date(protocolNow + 40).toISOString(); + const sleeps: number[] = []; + const client = new ProprClient({ + baseUrl: 'https://propr.example.test', + fetch: async (input, init) => { + if (input.toString().endsWith('/api/desktop/pairings')) return json({ + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://propr.example.test/approve', + expiresAt, + interval: 1, + }, 201); + return new Promise((_resolve, reject) => { + init?.signal?.addEventListener('abort', () => reject(new DOMException('expired', 'AbortError')), { once: true }); + }); + }, + }); + + await assert.rejects(client.pairDesktop('Desktop', { + now: () => protocolNow, + sleep: async milliseconds => { sleeps.push(milliseconds); }, + }), (error: unknown) => + error instanceof ProprClientError && error.code === 'PAIRING_EXPIRED'); + assert.deepEqual(sleeps, [40]); + }); + + for (const lateSettlement of ['microtask', 'next-task'] as const) { + it(`expires when a scheduler-delayed token response settles in the ${lateSettlement}`, async () => { + const { completeDesktopPairing } = await import('../src/index.js'); + const pairingClock = new PairingClock(); + const transportClock = new PairingClock(); + const expiresAt = new Date(protocolNow + 40).toISOString(); + let lateResponseResolved = false; + let pollStarted!: () => void; + const polling = new Promise(resolve => { pollStarted = resolve; }); + const client = new ProprClient({ + baseUrl: 'https://propr.example.test', + pairingProtocol: { clock: transportClock.source }, + fetch: async (_input, init) => new Promise(resolve => { + pollStarted(); + init?.signal?.addEventListener('abort', () => { + const settle = () => { + lateResponseResolved = true; + resolve(json({ + status: 'provisional', + token: `propr_it_${'C'.repeat(43)}`, + tokenType: 'Bearer', + activationTicket: 'T'.repeat(43), + activationExpiresAt: protocolDeadline, + ...binding, + })); + }; + if (lateSettlement === 'microtask') queueMicrotask(settle); + else setImmediate(settle); + }, { once: true }); + }), + }); + + const pairing = completeDesktopPairing(client, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://propr.example.test/approve', + expiresAt, + interval: 1, + }, { + binding, + clock: pairingClock.source, + now: () => protocolNow + pairingClock.source.now(), + sleep: async () => undefined, + }); + + await polling; + // The transport scheduler reaches the shared boundary while the pairing + // scheduler remains stalled. This deterministically reproduces hosted + // load without relying on a real 40 ms timer race. + await transportClock.advanceAfterSchedulerDelay(75); + await assert.rejects(bounded(pairing), (error: unknown) => + error instanceof ProprClientError && error.code === 'PAIRING_EXPIRED'); + await new Promise(resolve => setImmediate(resolve)); + assert.equal(lateResponseResolved, true); + }); + } + + it('aborts an in-flight poll when the caller cancels', async () => { + const controller = new AbortController(); + let pollStarted!: () => void; + const polling = new Promise(resolve => { pollStarted = resolve; }); + const client = new ProprClient({ + baseUrl: 'https://propr.example.test', + fetch: async (input, init) => { + if (input.toString().endsWith('/api/desktop/pairings')) return json({ + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://propr.example.test/approve', + expiresAt: protocolDeadline, + interval: 1, + }, 201); + pollStarted(); + return new Promise((_resolve, reject) => { + init?.signal?.addEventListener( + 'abort', + () => reject(new DOMException('cancelled', 'AbortError')), + { once: true }, + ); + }); + }, + }); + + const pairing = client.pairDesktop('Desktop', { + signal: controller.signal, + now: () => protocolNow, + sleep: async () => undefined, + }); + await polling; + controller.abort(); + await assert.rejects(pairing, (error: unknown) => + error instanceof ProprClientError && error.kind === 'aborted'); + }); + + it('rejects invalid start intervals and deadlines instead of scheduling them', async () => { + const invalidOverrides: Array> = [ + { interval: 0 }, + { interval: 0.5 }, + { interval: 61 }, + { interval: Number.MAX_VALUE }, + { interval: Number.NaN }, + { interval: Number.POSITIVE_INFINITY }, + { expiresAt: 'not a deadline' }, + { expiresAt: new Date(protocolNow).toISOString() }, + { expiresAt: new Date(protocolNow + 30 * 60 * 1000 + 1).toISOString() }, + ]; + for (const override of invalidOverrides) { + const client = new ProprClient({ + baseUrl: 'https://propr.example.test', + fetch: async () => json({ + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://propr.example.test/approve', + expiresAt: protocolDeadline, + interval: 2, + ...override, + }, 201), + }); + await assert.rejects( + client.startDesktopPairing('Desktop', { now: () => protocolNow }), + (error: unknown) => error instanceof ProprClientError && error.kind === 'invalid_response', + ); + } + }); + + it('rejects invalid intervals returned by every pending response', async () => { + const { completeDesktopPairing } = await import('../src/index.js'); + const start = { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://propr.example.test/approve', + expiresAt: protocolDeadline, + interval: 1, + }; + for (const interval of [0, 0.5, 61, Number.MAX_VALUE, Number.NaN, Number.POSITIVE_INFINITY]) { + const client = new ProprClient({ + fetch: async () => json({ status: 'pending', interval }, 202), + }); + await assert.rejects(completeDesktopPairing(client, start, { + now: () => protocolNow, + sleep: async () => undefined, + }), (error: unknown) => error instanceof ProprClientError && error.kind === 'invalid_response'); + } + }); + + it('clamps a valid polling interval to the remaining advertised deadline', async () => { + const { completeDesktopPairing } = await import('../src/index.js'); + let now = protocolNow; + const sleeps: number[] = []; + const client = new ProprClient({ fetch: async () => { throw new Error('must not poll after deadline'); } }); + await assert.rejects(completeDesktopPairing(client, { + pairingId: `dpr_${'A'.repeat(22)}`, + deviceSecret: 'B'.repeat(43), + approvalUrl: 'https://propr.example.test/approve', + expiresAt: new Date(protocolNow + 500).toISOString(), + interval: 60, + }, { + now: () => now, + sleep: async milliseconds => { + sleeps.push(milliseconds); + now += milliseconds; + }, + }), (error: unknown) => error instanceof ProprClientError && error.code === 'PAIRING_EXPIRED'); + assert.deepEqual(sleeps, [500]); + }); +}); diff --git a/packages/client/test/pairingContentEncoding.test.ts b/packages/client/test/pairingContentEncoding.test.ts new file mode 100644 index 000000000..0f7bac517 --- /dev/null +++ b/packages/client/test/pairingContentEncoding.test.ts @@ -0,0 +1,166 @@ +import assert from 'node:assert/strict'; +import { createServer, type Server } from 'node:http'; +import type { AddressInfo } from 'node:net'; +import { brotliCompressSync, gzipSync } from 'node:zlib'; +import { afterEach, describe, it } from 'node:test'; +import { ProprClientError } from '../src/index.js'; +import { requestPairingProtocol } from '../src/pairingProtocol.js'; + +const servers: Server[] = []; + +afterEach(async () => { + await Promise.all(servers.splice(0).map(server => new Promise((resolve, reject) => { + server.close(error => error ? reject(error) : resolve()); + }))); +}); + +const jsonBytes = (byteLength: number): Buffer => { + const prefix = '{"value":"'; + const suffix = '"}'; + const padding = byteLength - Buffer.byteLength(prefix) - Buffer.byteLength(suffix); + assert.ok(padding >= 0); + const result = Buffer.from(`${prefix}${'A'.repeat(padding)}${suffix}`); + assert.equal(result.byteLength, byteLength); + return result; +}; + +type Encoding = 'identity' | 'gzip' | 'br'; + +const encode = (body: Buffer, encoding: Encoding): Buffer => { + if (encoding === 'gzip') return gzipSync(body); + if (encoding === 'br') return brotliCompressSync(body); + return body; +}; + +const listen = async ( + fixtures: Record, +): Promise => { + const server = createServer((request, response) => { + const fixture = fixtures[request.url ?? '']; + if (!fixture) { + response.writeHead(404).end(); + return; + } + response.writeHead(200, { + 'Content-Type': 'application/json', + 'Content-Encoding': fixture.encoding, + 'Content-Length': String(fixture.body.byteLength), + }); + response.end(fixture.body); + }); + servers.push(server); + await new Promise((resolve, reject) => { + server.once('error', reject); + server.listen(0, '127.0.0.1', resolve); + }); + const address = server.address() as AddressInfo; + return `http://127.0.0.1:${address.port}`; +}; + +const request = ( + target: string, + fetchImplementation: typeof globalThis.fetch = globalThis.fetch, +): Promise => requestPairingProtocol(fetchImplementation, target, { method: 'POST' }); + +const invalidResponse = (error: unknown): boolean => + error instanceof ProprClientError && error.kind === 'invalid_response'; + +describe('pairing response Content-Encoding', () => { + it('accepts deterministic identity, gzip, and Brotli proxy responses at the decoded limit', async () => { + const decoded = jsonBytes(4_096); + const fixtures = Object.fromEntries( + (['identity', 'gzip', 'br'] as const).map(encoding => { + const body = encode(decoded, encoding); + if (encoding !== 'identity') assert.notEqual(body.byteLength, decoded.byteLength); + return [`/${encoding}`, { body, encoding }]; + }), + ); + const origin = await listen(fixtures); + const expected = JSON.parse(decoded.toString('utf8')) as unknown; + + for (const encoding of ['identity', 'gzip', 'br'] as const) { + assert.deepEqual(await request(`${origin}/${encoding}`), expected); + } + }); + + it('enforces the decoded 4 KiB cap for identity, gzip, and Brotli proxy responses', async () => { + const decoded = jsonBytes(4_097); + const fixtures = Object.fromEntries( + (['identity', 'gzip', 'br'] as const).map(encoding => [ + `/${encoding}`, + { body: encode(decoded, encoding), encoding }, + ]), + ); + const origin = await listen(fixtures); + + for (const encoding of ['identity', 'gzip', 'br'] as const) { + await assert.rejects(request(`${origin}/${encoding}`), invalidResponse); + } + }); + + it('fails closed on truncated gzip and Brotli proxy responses without exposing decoder details', async () => { + const decoded = jsonBytes(128); + const gzip = encode(decoded, 'gzip'); + const br = encode(decoded, 'br'); + const origin = await listen({ + '/gzip': { body: gzip.subarray(0, Math.floor(gzip.byteLength / 2)), encoding: 'gzip' }, + '/br': { body: br.subarray(0, Math.floor(br.byteLength / 2)), encoding: 'br' }, + }); + + for (const encoding of ['gzip', 'br'] as const) { + await assert.rejects(request(`${origin}/${encoding}`), (error: unknown) => + error instanceof ProprClientError + && ['invalid_response', 'network'].includes(error.kind) + && !error.message.toLowerCase().includes('decompress')); + } + }); + + it('rejects duplicate, stacked, empty, and unsupported Content-Encoding metadata', async () => { + const body = jsonBytes(32); + const values = ['', 'gzip, gzip', 'gzip, br', 'deflate']; + + for (const value of values) { + await assert.rejects(request('https://propr.example.test/pair', async () => new Response(body, { + headers: { + 'Content-Type': 'application/json', + 'Content-Encoding': value, + 'Content-Length': String(body.byteLength), + }, + })), invalidResponse); + } + }); + + it('validates encoded Content-Length syntax without comparing it to decoded bytes', async () => { + const body = jsonBytes(32); + const response = (length: string): Response => new Response(body, { + headers: { + 'Content-Type': 'application/json', + 'Content-Encoding': 'gzip', + 'Content-Length': length, + }, + }); + + assert.deepEqual( + await request('https://propr.example.test/pair', async () => response('17')), + JSON.parse(body.toString('utf8')), + ); + for (const length of ['', '01', '-1', '17, 17', '9007199254740992']) { + await assert.rejects( + request('https://propr.example.test/pair', async () => response(length)), + invalidResponse, + ); + } + }); + + it('rejects an encoded Content-Length above the wire limit', async () => { + const body = jsonBytes(32); + + await assert.rejects(request('https://propr.example.test/pair', async () => new Response(body, { + headers: { + 'Content-Type': 'application/json', + 'Content-Encoding': 'gzip', + 'Content-Length': '4097', + }, + })), invalidResponse); + }); +}); diff --git a/packages/client/test/pairingTransport.test.ts b/packages/client/test/pairingTransport.test.ts new file mode 100644 index 000000000..7e7257797 --- /dev/null +++ b/packages/client/test/pairingTransport.test.ts @@ -0,0 +1,552 @@ +import assert from 'node:assert/strict'; +import { createServer, type Server } from 'node:http'; +import type { AddressInfo } from 'node:net'; +import { afterEach, describe, it } from 'node:test'; +import { completeDesktopPairing, ProprClient, ProprClientError } from '../src/index.js'; +import { requestPairingProtocol, type PairingProtocolRequestOptions } from '../src/pairingProtocol.js'; + +const protocolNow = Date.parse('2026-01-01T00:00:00.000Z'); +const deadline = new Date(protocolNow + 60_000).toISOString(); +const pairingId = `dpr_${'P'.repeat(22)}`; +const deviceSecret = 'D'.repeat(43); +const activationTicket = 'A'.repeat(43); +const token = `propr_it_${'T'.repeat(43)}`; +const binding = { + instanceId: 'profile-transport', + origin: 'https://propr.example.test', + scope: 'desktop-instance' as const, + credentialGeneration: 'G'.repeat(22), +}; +const completedPairing = { + token, + tokenType: 'Bearer' as const, + pairingId, + deviceSecret, + activationTicket, + activationExpiresAt: deadline, + ...binding, +}; + +type EndpointName = 'start' | 'poll' | 'activate' | 'cancel'; + +const successBody = (endpoint: EndpointName, origin = binding.origin): Record => { + if (endpoint === 'start') return { + pairingId, + deviceSecret, + approvalUrl: `${origin}/api/desktop/pairings/${pairingId}/browser`, + expiresAt: deadline, + interval: 1, + }; + if (endpoint === 'poll') return { + status: 'provisional', + token, + tokenType: 'Bearer', + activationTicket, + activationExpiresAt: deadline, + ...binding, + origin, + }; + if (endpoint === 'activate') return { + status: 'active', + receipt: 'R'.repeat(22), + activatedAt: '2026-01-01T00:00:01.000Z', + expiresAt: null, + }; + return { status: 'cancelled', cancelledAt: '2026-01-01T00:00:01.000Z' }; +}; + +const jsonResponse = ( + value: unknown, + status = 200, + headers: Record = {}, +): Response => new Response(JSON.stringify(value), { + status, + headers: { 'Content-Type': 'application/json', ...headers }, +}); + +const streamResponse = ( + chunks: Uint8Array[], + options: { status?: number; headers?: Record; error?: Error } = {}, +): Response => new Response(new ReadableStream({ + start(controller) { + chunks.forEach(chunk => controller.enqueue(chunk)); + if (options.error) controller.error(options.error); + else controller.close(); + }, +}), { + status: options.status ?? 200, + headers: { 'Content-Type': 'application/json', ...options.headers }, +}); + +const runEndpoint = async ( + endpoint: EndpointName, + fetchImplementation: typeof globalThis.fetch, + signal?: AbortSignal, + baseUrl = binding.origin, +): Promise => { + const client = new ProprClient({ + baseUrl, + authentication: { type: 'none' }, + fetch: fetchImplementation, + }); + if (endpoint === 'start') { + return client.startDesktopPairing('Transport test', { + signal, + now: () => protocolNow, + binding: { ...binding, origin: baseUrl }, + }); + } + const pairing = { ...completedPairing, origin: baseUrl }; + if (endpoint === 'activate') return client.activateDesktopPairing(pairing, signal); + if (endpoint === 'cancel') return client.cancelDesktopPairing(pairing, signal); + return completeDesktopPairing(client, { + pairingId, + deviceSecret, + approvalUrl: `${baseUrl}/approve`, + expiresAt: deadline, + interval: 1, + }, { + signal, + now: () => protocolNow, + sleep: async () => undefined, + binding: { ...binding, origin: baseUrl }, + }); +}; + +const bounded = async (promise: Promise, milliseconds = 1_000): Promise => { + let timer: ReturnType | undefined; + try { + return await Promise.race([ + promise, + new Promise((_resolve, reject) => { + timer = setTimeout(() => reject(new Error('transport operation did not settle')), milliseconds); + }), + ]); + } finally { + if (timer) clearTimeout(timer); + } +}; + +class ProtocolClock { + #now = 0; + #nextId = 1; + readonly #timers = new Map void }>(); + + readonly source: NonNullable = { + now: () => this.#now, + setTimeout: (callback, milliseconds) => { + const id = this.#nextId++; + this.#timers.set(id, { at: this.#now + milliseconds, callback }); + return id as unknown as ReturnType; + }, + clearTimeout: timer => { this.#timers.delete(timer as unknown as number); }, + }; + + get now(): number { return this.#now; } + get pending(): number { return this.#timers.size; } + + async advance(milliseconds: number): Promise { + const target = this.#now + milliseconds; + while (true) { + const due = [...this.#timers.entries()] + .filter(([, timer]) => timer.at <= target) + .sort(([leftId, left], [rightId, right]) => left.at - right.at || leftId - rightId)[0]; + if (!due) break; + this.#now = due[1].at; + this.#timers.delete(due[0]); + due[1].callback(); + await Promise.resolve(); + await Promise.resolve(); + } + this.#now = target; + await Promise.resolve(); + await Promise.resolve(); + } +} + +const protocolRequest = ( + path: EndpointName, + fetchImplementation: typeof globalThis.fetch, + clock: ProtocolClock, + options: Omit = {}, +): Promise => requestPairingProtocol( + fetchImplementation, + `https://propr.example.test/${path}`, + { method: 'POST' }, + { ...options, clock: clock.source }, +); + +const timeoutKind = (error: unknown): boolean => + error instanceof ProprClientError && error.kind === 'timeout'; + +describe('bounded pairing protocol response transport', () => { + for (const endpoint of ['start', 'poll', 'activate', 'cancel'] as const) { + it(`${endpoint} accepts exact-limit and absent-length bodies but rejects deceptive Content-Length`, async () => { + const json = JSON.stringify(successBody(endpoint)); + const exact = new TextEncoder().encode(json + ' '.repeat(4_096 - Buffer.byteLength(json))); + assert.equal(exact.byteLength, 4_096); + await runEndpoint(endpoint, async () => streamResponse([ + exact.slice(0, 1), + exact.slice(1, 2_049), + exact.slice(2_049), + ])); + await assert.rejects(runEndpoint(endpoint, async () => streamResponse([ + new TextEncoder().encode(json), + ], { headers: { 'Content-Length': '1' } })), (error: unknown) => + error instanceof ProprClientError && error.kind === 'invalid_response'); + }); + + it(`${endpoint} cancels over-limit, stalled, malformed, errored, and late-extra bodies`, async () => { + const valid = JSON.stringify(successBody(endpoint)); + const over = new TextEncoder().encode(valid + ' '.repeat(4_097 - Buffer.byteLength(valid))); + let cancelled = 0; + const failures: Array<() => Promise> = [ + () => runEndpoint(endpoint, async () => streamResponse([over.slice(0, 4_096), over.slice(4_096)])), + () => runEndpoint(endpoint, async () => streamResponse([new Uint8Array([0xff])])), + () => runEndpoint(endpoint, async () => jsonResponse({ broken: true })), + () => runEndpoint(endpoint, async () => streamResponse([ + new TextEncoder().encode(valid), + new TextEncoder().encode('{"late":true}'), + ])), + () => runEndpoint(endpoint, async () => streamResponse([ + new TextEncoder().encode(valid.slice(0, 2)), + ], { error: new Error('private premature stream detail') })), + ]; + for (const failure of failures) { + await assert.rejects(bounded(failure()), (error: unknown) => + error instanceof ProprClientError + && ['invalid_response', 'network'].includes(error.kind) + && !error.message.includes('private')); + } + + const controller = new AbortController(); + let bodyStarted!: () => void; + const started = new Promise(resolve => { bodyStarted = resolve; }); + let streamCancelled = false; + const stalled = runEndpoint(endpoint, async () => new Response(new ReadableStream({ + start(streamController) { + setImmediate(() => { + if (!streamCancelled) streamController.enqueue(new TextEncoder().encode('{')); + bodyStarted(); + }); + }, + cancel() { streamCancelled = true; cancelled += 1; }, + }), { headers: { 'Content-Type': 'application/json' } }), controller.signal); + await started; + controller.abort('caller stopped operation'); + await assert.rejects(bounded(stalled), (error: unknown) => + error instanceof ProprClientError && error.kind === 'aborted'); + assert.equal(cancelled, 1); + }); + + it(`${endpoint} aborts a headers stall and redacts empty or HTML HTTP errors`, async () => { + const controller = new AbortController(); + let headerStarted!: () => void; + const started = new Promise(resolve => { headerStarted = resolve; }); + const stalled = runEndpoint(endpoint, async (_input, init) => new Promise((_resolve, reject) => { + headerStarted(); + init?.signal?.addEventListener('abort', () => reject(new DOMException('secret', 'AbortError')), { once: true }); + }), controller.signal); + await started; + controller.abort(); + await assert.rejects(bounded(stalled), (error: unknown) => + error instanceof ProprClientError && error.kind === 'aborted'); + + for (const response of [ + new Response(null, { status: 502 }), + new Response('

private upstream detail

', { + status: 502, + headers: { 'Content-Type': 'text/html' }, + }), + new Response('{', { status: 502, headers: { 'Content-Type': 'application/json' } }), + ]) { + await assert.rejects(runEndpoint(endpoint, async () => response), (error: unknown) => + error instanceof ProprClientError + && error.kind === 'http' + && error.status === 502 + && error.code === undefined + && !error.message.includes('private')); + } + }); + } + + for (const endpoint of ['start', 'poll', 'activate', 'cancel'] as const) { + it(`${endpoint} enforces automatic header, body, slowloris, and overall deadlines`, async () => { + { + const clock = new ProtocolClock(); + let networkSignal: AbortSignal | undefined; + const operation = protocolRequest(endpoint, async (_input, init) => { + networkSignal = init?.signal ?? undefined; + return new Promise(() => undefined); + }, clock, { + overallTimeoutMs: 40, + deadlines: { headerMs: 10, bodyMs: 10, cancellationMs: 5 }, + }); + await clock.advance(9); + assert.equal(networkSignal?.aborted, false); + await clock.advance(1); + await assert.rejects(operation, timeoutKind); + assert.equal(networkSignal?.aborted, true); + assert.equal(clock.pending, 0); + } + + for (const firstChunk of [undefined, new Uint8Array([0x7b])]) { + const clock = new ProtocolClock(); + let networkSignal: AbortSignal | undefined; + let cancelled = 0; + const operation = protocolRequest(endpoint, async (_input, init) => { + networkSignal = init?.signal ?? undefined; + return new Response(new ReadableStream({ + start(controller) { if (firstChunk) controller.enqueue(firstChunk); }, + cancel() { cancelled += 1; }, + }), { headers: { 'Content-Type': 'application/json' } }); + }, clock, { + overallTimeoutMs: 40, + deadlines: { headerMs: 20, bodyMs: 10, cancellationMs: 5 }, + }); + await clock.advance(0); + await clock.advance(10); + await assert.rejects(operation, timeoutKind); + assert.equal(networkSignal?.aborted, true); + assert.equal(cancelled, 1); + assert.equal(clock.pending, 0); + } + + { + const clock = new ProtocolClock(); + let networkSignal: AbortSignal | undefined; + const operation = protocolRequest(endpoint, async (_input, init) => { + networkSignal = init?.signal ?? undefined; + return new Promise(() => undefined); + }, clock, { + overallTimeoutMs: 10, + deadlines: { headerMs: 20, bodyMs: 20, cancellationMs: 5 }, + }); + await clock.advance(10); + await assert.rejects(operation, timeoutKind); + assert.equal(networkSignal?.aborted, true); + assert.equal(clock.pending, 0); + } + }); + + it(`${endpoint} bounds never-settling reader cancellation and ignores every late callback`, async () => { + const clock = new ProtocolClock(); + let networkSignal: AbortSignal | undefined; + let cancelReject!: (error: Error) => void; + const cancellation = new Promise((_resolve, reject) => { cancelReject = reject; }); + let cancelCalls = 0; + const diagnostics: string[] = []; + const unhandled: unknown[] = []; + const onUnhandled = (error: unknown): void => { unhandled.push(error); }; + process.on('unhandledRejection', onUnhandled); + try { + const operation = protocolRequest(endpoint, async (_input, init) => { + networkSignal = init?.signal ?? undefined; + return new Response(new ReadableStream({ + cancel() { + cancelCalls += 1; + return cancellation; + }, + }), { headers: { 'Content-Type': 'application/json' } }); + }, clock, { + overallTimeoutMs: 40, + deadlines: { headerMs: 20, bodyMs: 10, cancellationMs: 5 }, + reportDiagnostic: message => { diagnostics.push(message); }, + }); + await clock.advance(0); + await clock.advance(10); + assert.equal(clock.pending, 1); + await clock.advance(5); + await assert.rejects(operation, timeoutKind); + assert.equal(networkSignal?.aborted, true); + assert.equal(cancelCalls, 1); + assert.deepEqual(diagnostics, [ + 'ProPR pairing response cancellation exceeded its fixed deadline.', + ]); + assert.equal(clock.pending, 0); + + cancelReject(new Error('private late cancellation failure')); + await new Promise(resolve => setImmediate(resolve)); + assert.equal(cancelCalls, 1); + assert.equal(clock.pending, 0); + assert.equal(diagnostics.length, 1); + assert.deepEqual(unhandled, []); + } finally { + process.removeListener('unhandledRejection', onUnhandled); + } + }); + } + + it('bounds a never-settling response.body.cancel before a reader exists', async () => { + const clock = new ProtocolClock(); + let networkSignal: AbortSignal | undefined; + let rejectCancellation!: (error: Error) => void; + const diagnostics: string[] = []; + const response = new Response(new ReadableStream({ + cancel() { + return new Promise((_resolve, reject) => { rejectCancellation = reject; }); + }, + }), { + headers: { + 'Content-Type': 'application/json', + 'Content-Length': '4097', + }, + }); + const operation = protocolRequest('activate', async (_input, init) => { + networkSignal = init?.signal ?? undefined; + return response; + }, clock, { + overallTimeoutMs: 40, + deadlines: { headerMs: 20, bodyMs: 20, cancellationMs: 5 }, + reportDiagnostic: message => { diagnostics.push(message); }, + }); + await clock.advance(0); + assert.equal(clock.pending, 1); + await clock.advance(5); + await assert.rejects(operation, (error: unknown) => + error instanceof ProprClientError && error.kind === 'invalid_response'); + assert.equal(networkSignal?.aborted, true); + assert.equal(clock.pending, 0); + assert.equal(diagnostics.length, 1); + rejectCancellation(new Error('private late body cancellation failure')); + await new Promise(resolve => setImmediate(resolve)); + }); + + it('makes exact header, body, overall, and cancellation boundaries terminal', async () => { + { + const clock = new ProtocolClock(); + let signal: AbortSignal | undefined; + const operation = protocolRequest('start', async (_input, init) => { + signal = init?.signal ?? undefined; + return new Promise(resolve => { + clock.source.setTimeout(() => resolve(jsonResponse(successBody('start'))), 10); + }); + }, clock, { + overallTimeoutMs: 40, + deadlines: { headerMs: 10, bodyMs: 20, cancellationMs: 5 }, + }); + await clock.advance(10); + await assert.rejects(operation, timeoutKind); + assert.equal(signal?.aborted, true); + assert.equal(clock.pending, 0); + } + + for (const overallWins of [false, true]) { + const clock = new ProtocolClock(); + let signal: AbortSignal | undefined; + let bodyController!: ReadableStreamDefaultController; + const operation = protocolRequest('activate', async (_input, init) => { + signal = init?.signal ?? undefined; + return new Response(new ReadableStream({ + start(controller) { bodyController = controller; }, + }), { headers: { 'Content-Type': 'application/json' } }); + }, clock, { + overallTimeoutMs: overallWins ? 10 : 40, + deadlines: { headerMs: 20, bodyMs: overallWins ? 20 : 10, cancellationMs: 5 }, + }); + await clock.advance(0); + clock.source.setTimeout(() => { + if (signal?.aborted) return; + bodyController.enqueue(new TextEncoder().encode(JSON.stringify(successBody('activate')))); + bodyController.close(); + }, 10); + await clock.advance(10); + await assert.rejects(operation, timeoutKind); + assert.equal(signal?.aborted, true); + assert.equal(clock.pending, 0); + } + + { + const clock = new ProtocolClock(); + const diagnostics: string[] = []; + const operation = protocolRequest('cancel', async () => new Response( + new ReadableStream({ cancel: () => new Promise(() => undefined) }), + { headers: { 'Content-Type': 'application/json' } }, + ), clock, { + overallTimeoutMs: 10, + deadlines: { headerMs: 20, bodyMs: 8, cancellationMs: 5 }, + reportDiagnostic: message => { diagnostics.push(message); }, + }); + await clock.advance(0); + await clock.advance(8); + assert.equal(clock.pending, 1); + await clock.advance(2); + await assert.rejects(operation, timeoutKind); + assert.equal(clock.now, 10); + assert.equal(clock.pending, 0); + assert.equal(diagnostics.length, 1); + } + }); +}); + +const servers: Server[] = []; +afterEach(async () => { + await Promise.all(servers.splice(0).map(server => new Promise((resolve, reject) => { + server.close(error => error ? reject(error) : resolve()); + }))); +}); + +const listen = async (handler: Parameters[0]): Promise<{ server: Server; origin: string }> => { + const server = createServer(handler); + servers.push(server); + await new Promise((resolve, reject) => { + server.once('error', reject); + server.listen(0, '127.0.0.1', resolve); + }); + const address = server.address() as AddressInfo; + return { server, origin: `http://127.0.0.1:${address.port}` }; +}; + +describe('pairing redirect fencing', () => { + it('never replays any pairing endpoint across origins on 307 or 308', async () => { + const received: string[] = []; + const receiver = await listen((request, response) => { + let body = ''; + request.setEncoding('utf8'); + request.on('data', chunk => { body += String(chunk); }); + request.on('end', () => { + received.push(`${request.url}\n${JSON.stringify(request.headers)}\n${body}`); + response.end(); + }); + }); + let redirectStatus = 307; + const source = await listen((_request, response) => { + response.writeHead(redirectStatus, { Location: `${receiver.origin}/captured` }); + response.end(); + }); + + for (redirectStatus of [307, 308]) { + for (const endpoint of ['start', 'poll', 'activate', 'cancel'] as const) { + await assert.rejects(runEndpoint(endpoint, globalThis.fetch, undefined, source.origin), (error: unknown) => + error instanceof ProprClientError && error.kind === 'invalid_response'); + } + } + await new Promise(resolve => setImmediate(resolve)); + assert.deepEqual(received, []); + const receiverDump = received.join('\n'); + for (const material of [deviceSecret, pairingId, activationTicket, token, 'Bearer', binding.instanceId]) { + assert.equal(receiverDump.includes(material), false); + } + }); + + it('rejects absolute, relative, missing, and looping same-origin redirects without replay', async () => { + let requests = 0; + let location: string | undefined; + let origin = ''; + const source = await listen((_request, response) => { + requests += 1; + const headers = location === undefined ? {} : { Location: location }; + response.writeHead(307, headers); + response.end(); + }); + origin = source.origin; + + for (const nextLocation of [`${origin}/absolute`, '/relative', undefined, '/loop']) { + location = nextLocation; + const before = requests; + await assert.rejects(runEndpoint('activate', globalThis.fetch, undefined, origin), (error: unknown) => + error instanceof ProprClientError && error.kind === 'invalid_response'); + assert.equal(requests, before + 1); + } + }); +}); diff --git a/packages/client/test/socket.test.ts b/packages/client/test/socket.test.ts index 105d1c249..c970bc096 100644 --- a/packages/client/test/socket.test.ts +++ b/packages/client/test/socket.test.ts @@ -37,4 +37,38 @@ describe('Socket.IO connection configuration', () => { token = 'refreshed-token'; assert.deepEqual(await resolveAuth(), { token: 'refreshed-token' }); }); + + it('preserves handshake metadata while only the fresh provider can supply the bearer token', async () => { + let token = 'first-token'; + const connection = buildSocketConnection( + normalizeApiBaseUrl('https://propr.example.com'), + { type: 'bearer', getAccessToken: () => token }, + { auth: { proprDesktopTransportScope: 'scope-a', token: 'metadata-token' } } + ); + + const resolveAuth = (): Promise => new Promise(resolve => { + (connection.options.auth as (callback: (data: unknown) => void) => void)(resolve); + }); + assert.deepEqual(await resolveAuth(), { + proprDesktopTransportScope: 'scope-a', + token: 'first-token', + }); + token = 'refreshed-token'; + assert.deepEqual(await resolveAuth(), { + proprDesktopTransportScope: 'scope-a', + token: 'refreshed-token', + }); + }); + + it('routes Connect Socket.IO to the same origin and fixed proxy path', () => { + const connection = buildSocketConnection( + normalizeApiBaseUrl('https://t-instance123.propr.dev'), + { type: 'none' } + ); + + assert.equal(connection.url, 'https://t-instance123.propr.dev'); + assert.equal(connection.options.path, '/socket.io/'); + assert.equal(connection.options.reconnection, true); + assert.equal(connection.options.reconnectionAttempts, Infinity); + }); }); diff --git a/packages/core/src/db/migrations/20260830000000_add_two_phase_desktop_pairing.js b/packages/core/src/db/migrations/20260830000000_add_two_phase_desktop_pairing.js new file mode 100644 index 000000000..ec00d8358 --- /dev/null +++ b/packages/core/src/db/migrations/20260830000000_add_two_phase_desktop_pairing.js @@ -0,0 +1,56 @@ +/** + * Make desktop credentials unusable until the desktop confirms that encrypted + * rollback material is durable. Existing active credentials remain active; + * only credentials issued by the new pairing protocol begin provisional. + */ +export async function up(knex) { + await knex.schema.alterTable('desktop_pairing_requests', (table) => { + table.text('requested_instance_id').nullable(); + table.text('requested_origin').nullable(); + table.text('requested_scope').nullable(); + table.text('credential_generation').nullable(); + table.text('provisional_token_id').nullable(); + table.text('activation_ticket_hash').nullable(); + table.text('activation_receipt').nullable(); + table.timestamp('activation_expires_at').nullable(); + table.timestamp('activated_at').nullable(); + table.timestamp('cancelled_at').nullable(); + }); + await knex.schema.alterTable('instance_api_tokens', (table) => { + table.text('activation_state').notNullable().defaultTo('active'); + table.text('pairing_id').nullable(); + table.text('bound_instance_id').nullable(); + table.text('bound_origin').nullable(); + table.text('bound_scope').nullable(); + table.text('credential_generation').nullable(); + table.index(['activation_state', 'expires_at']); + }); +} + +export async function down(knex) { + await knex.schema.alterTable('instance_api_tokens', (table) => { + table.dropIndex(['activation_state', 'expires_at']); + table.dropColumns( + 'activation_state', + 'pairing_id', + 'bound_instance_id', + 'bound_origin', + 'bound_scope', + 'credential_generation', + ); + }); + await knex.schema.alterTable('desktop_pairing_requests', (table) => { + table.dropColumns( + 'requested_instance_id', + 'requested_origin', + 'requested_scope', + 'credential_generation', + 'provisional_token_id', + 'activation_ticket_hash', + 'activation_receipt', + 'activation_expires_at', + 'activated_at', + 'cancelled_at', + ); + }); +} diff --git a/packages/core/test/desktopTwoPhaseAuthMigration.test.ts b/packages/core/test/desktopTwoPhaseAuthMigration.test.ts new file mode 100644 index 000000000..384673168 --- /dev/null +++ b/packages/core/test/desktopTwoPhaseAuthMigration.test.ts @@ -0,0 +1,42 @@ +import assert from 'node:assert/strict'; +import test from 'node:test'; +import knex from 'knex'; +import { up as createDesktopAuth } from '../src/db/migrations/20260829000000_create_desktop_auth.js'; +import { + down as rollbackTwoPhaseDesktopAuth, + up as addTwoPhaseDesktopAuth, +} from '../src/db/migrations/20260830000000_add_two_phase_desktop_pairing.js'; + +test('adds two-phase state without changing existing active credentials and rolls it back', async () => { + const database = knex({ + client: 'better-sqlite3', + connection: { filename: ':memory:' }, + useNullAsDefault: true, + }); + try { + await createDesktopAuth(database); + await database('instance_api_tokens').insert({ + id: 'token-id', + token_hash: 'hash', + token_hint: 'hint', + name: 'Existing desktop', + owner_github_user_id: '1', + owner_github_username: 'owner', + owner_display_name: 'Owner', + created_at: '2026-08-30T00:00:00.000Z', + }); + + await addTwoPhaseDesktopAuth(database); + const migrated = await database('instance_api_tokens').where({ id: 'token-id' }).first(); + assert.equal(migrated.activation_state, 'active'); + assert.equal(migrated.pairing_id, null); + assert.equal(await database.schema.hasColumn('desktop_pairing_requests', 'activation_ticket_hash'), true); + + await rollbackTwoPhaseDesktopAuth(database); + assert.equal(await database.schema.hasColumn('instance_api_tokens', 'activation_state'), false); + assert.equal(await database.schema.hasColumn('desktop_pairing_requests', 'activation_ticket_hash'), false); + assert.notEqual(await database('instance_api_tokens').where({ id: 'token-id' }).first(), undefined); + } finally { + await database.destroy(); + } +}); diff --git a/packages/local-setup/src/index.ts b/packages/local-setup/src/index.ts index b0599dc8d..fe3c12fb6 100644 --- a/packages/local-setup/src/index.ts +++ b/packages/local-setup/src/index.ts @@ -1,5 +1,6 @@ export * from "./agents.js"; export * from "./engine.js"; export * from "./github.js"; +export * from "./publicInstanceIdentity.js"; export * from "./state.js"; export * from "./types.js"; diff --git a/packages/local-setup/src/publicInstanceIdentity.ts b/packages/local-setup/src/publicInstanceIdentity.ts new file mode 100644 index 000000000..19c15de64 --- /dev/null +++ b/packages/local-setup/src/publicInstanceIdentity.ts @@ -0,0 +1,654 @@ +import { randomUUID } from "node:crypto"; +import { + chmodSync, + closeSync, + constants, + fchmodSync, + fstatSync, + fsyncSync, + linkSync, + lstatSync, + mkdirSync, + opendirSync, + openSync, + readSync, + realpathSync, + unlinkSync, + writeFileSync, +} from "node:fs"; +import type { Stats } from "node:fs"; +import { dirname, join, parse, resolve, sep } from "node:path"; +import { + PUBLIC_INSTANCE_IDENTITY_FILENAME, + PUBLIC_INSTANCE_IDENTITY_SCHEMA_VERSION, + parsePublicInstanceIdentityDocument, +} from "@propr/shared"; + +export const PUBLIC_IDENTITY_DIRECTORY_MODE = 0o700; +export const PUBLIC_IDENTITY_FILE_MODE = 0o644; +const PUBLIC_IDENTITY_TEMPORARY_MODE = 0o600; +export const PUBLIC_IDENTITY_MAX_BYTES = 1024; + +const READY_NAME = `.${PUBLIC_INSTANCE_IDENTITY_FILENAME}.ready-v1`; +const TEMP_PREFIX = `.${PUBLIC_INSTANCE_IDENTITY_FILENAME}.creating-v1-`; +const MAX_DIRECTORY_ENTRIES = 4096; + +export type PublicIdentityRole = "host" | "root-container"; +export type PublicIdentityBoundary = + | "temporary-opened" + | "temporary-written" + | "temporary-synced" + | "recovery-published" + | "identity-published" + | "identity-read-statted" + | "directory-synced"; + +export interface PublicIdentityOptions { + generate?: () => string; + role?: PublicIdentityRole; + onBoundary?: (boundary: PublicIdentityBoundary) => void | Promise; +} + +export interface PinnedPublicIdentityDirectory { + readonly fd: number; + readonly ownerUid: number; + open(name: string, flags: number, mode?: number): number; + identify(name: string): { + device: string; + file: string; + kind: "file" | "directory" | "symbolic-link" | "other"; + }; + /** Validate native owner/ACL/no-reparse authority for this exact open file. */ + validateEntry(name: string, fd: number, newlyCreated?: boolean): void | Promise; + /** Bounded names in this exact pinned directory, when crash recovery needs them. */ + listNames?(): readonly string[]; + publishNoReplace(oldName: string, newName: string): void; + unlink(name: string): void; +} + +class IdentityBusyError extends Error {} + +function errno(error: unknown): string | undefined { + return (error as NodeJS.ErrnoException).code; +} + +export interface ExactPublicFileIdentity { + readonly device: string; + readonly file: string; +} + +function exactIdentity(fd: number): ExactPublicFileIdentity { + const stat = fstatSync(fd, { bigint: true }); + return { device: stat.dev.toString(10), file: stat.ino.toString(10) }; +} + +function canonicalIdentityPart(value: string): bigint { + if (!/^(?:0|[1-9]\d{0,19})$/.test(value) || BigInt(value) > 0xffffffffffffffffn) { + throw new Error("public instance identity metadata is not a canonical 64-bit identity"); + } + return BigInt(value); +} + +export function samePublicFileIdentity( + left: ExactPublicFileIdentity, + right: ExactPublicFileIdentity, +): boolean { + return canonicalIdentityPart(left.device) === canonicalIdentityPart(right.device) + && canonicalIdentityPart(left.file) === canonicalIdentityPart(right.file); +} + +function sameIdentity(left: ExactPublicFileIdentity, right: ExactPublicFileIdentity): boolean { + return samePublicFileIdentity(left, right); +} + +function validateDirectoryMode(stat: Stats): void { + if (!stat.isDirectory() || stat.isSymbolicLink()) throw new Error("public identity data directory is invalid"); + if (process.platform !== "win32" && (stat.mode & 0o777) !== PUBLIC_IDENTITY_DIRECTORY_MODE) { + throw new Error("public identity data directory is not private"); + } +} + +export function publicIdentityFilePermissionsAllowed( + metadata: { uid: number; mode: number }, + directoryOwnerUid: number, + platform: NodeJS.Platform = process.platform, +): boolean { + if (platform === "win32") return false; + return (metadata.uid === directoryOwnerUid || metadata.uid === 0) + && (metadata.mode & 0o777) === PUBLIC_IDENTITY_FILE_MODE; +} + +function validateFileStat(stat: Stats, directoryOwnerUid: number, allowedLinks = 1): void { + if (!stat.isFile() || stat.isSymbolicLink() || stat.nlink !== allowedLinks) { + if (stat.isFile() && stat.nlink === 2) throw new IdentityBusyError(); + throw new Error("public instance identity file is not a private single-link regular file"); + } + if (stat.size <= 0 || stat.size > PUBLIC_IDENTITY_MAX_BYTES) { + throw new Error("public instance identity file has an invalid size"); + } + if (process.platform !== "win32") { + if (!publicIdentityFilePermissionsAllowed(stat, directoryOwnerUid)) { + throw new Error("public instance identity file has an unexpected owner or unsafe permissions"); + } + } +} + +async function readIdentity( + directory: PinnedPublicIdentityDirectory, + name: string, + options: Pick = {}, + allowedLinks = 1, +): Promise { + let fd: number | undefined; + try { + fd = directory.open(name, constants.O_RDONLY | constants.O_NOFOLLOW); + const before = fstatSync(fd); + const beforeIdentity = exactIdentity(fd); + validateFileStat(before, directory.ownerUid, allowedLinks); + await directory.validateEntry(name, fd); + await options.onBoundary?.("identity-read-statted"); + const bytes = Buffer.allocUnsafe(PUBLIC_IDENTITY_MAX_BYTES + 1); + let length = 0; + while (length < bytes.byteLength) { + const count = readSync(fd, bytes, length, bytes.byteLength - length, null); + if (count === 0) break; + length += count; + } + const after = fstatSync(fd); + const afterIdentity = exactIdentity(fd); + validateFileStat(after, directory.ownerUid, allowedLinks); + await directory.validateEntry(name, fd); + const namedAfter = directory.identify(name); + if ( + !sameIdentity(beforeIdentity, afterIdentity) + || before.size !== after.size + || length !== before.size + || length > PUBLIC_IDENTITY_MAX_BYTES + || namedAfter.kind !== "file" + || !sameIdentity(afterIdentity, namedAfter) + ) { + throw new Error("public instance identity changed while it was read"); + } + const value = JSON.parse( + new TextDecoder("utf-8", { fatal: true }).decode(bytes.subarray(0, length)), + ) as unknown; + if ( + !value + || typeof value !== "object" + || Array.isArray(value) + || Object.keys(value as Record).sort().join(",") + !== "publicInstanceIdentity,schemaVersion" + ) throw new Error("public instance identity document is invalid"); + const parsed = parsePublicInstanceIdentityDocument(value); + if (!parsed) throw new Error("public instance identity document is invalid"); + return parsed.publicInstanceIdentity; + } finally { + if (fd !== undefined) closeSync(fd); + } +} + +async function readIdentityIfPresent( + directory: PinnedPublicIdentityDirectory, + name: string, + options: Pick = {}, +): Promise { + try { + return await readIdentity(directory, name, options); + } catch (error) { + if (errno(error) === "ENOENT") return undefined; + throw error; + } +} + +/** + * Repair only the exact Darwin/Windows link-then-unlink crash remnant. The + * fixed recovery slot and final name must be the only two links to one valid + * inode; a hardlink at any other name is deliberately indistinguishable from + * an attack and remains rejected. + */ +async function recoverPublishedLinkRemnant( + directory: PinnedPublicIdentityDirectory, + options: Pick = {}, +): Promise { + let finalFd: number | undefined; + let recoveryFd: number | undefined; + try { + try { + finalFd = directory.open(PUBLIC_INSTANCE_IDENTITY_FILENAME, constants.O_RDONLY | constants.O_NOFOLLOW); + recoveryFd = directory.open(READY_NAME, constants.O_RDONLY | constants.O_NOFOLLOW); + } catch (error) { + if (errno(error) === "ENOENT") return undefined; + throw error; + } + const finalStat = fstatSync(finalFd); + const recoveryStat = fstatSync(recoveryFd); + const finalIdentity = exactIdentity(finalFd); + const recoveryIdentity = exactIdentity(recoveryFd); + validateFileStat(finalStat, directory.ownerUid, 2); + validateFileStat(recoveryStat, directory.ownerUid, 2); + await directory.validateEntry(PUBLIC_INSTANCE_IDENTITY_FILENAME, finalFd); + await directory.validateEntry(READY_NAME, recoveryFd); + if (!sameIdentity(finalIdentity, recoveryIdentity)) { + throw new Error("public identity hardlink state is ambiguous"); + } + const recovered = await readIdentity(directory, PUBLIC_INSTANCE_IDENTITY_FILENAME, options, 2); + // Revalidate both held handles immediately before removing the private name. + const finalAfter = fstatSync(finalFd); + const recoveryAfter = fstatSync(recoveryFd); + const finalAfterIdentity = exactIdentity(finalFd); + const recoveryAfterIdentity = exactIdentity(recoveryFd); + const namedFinal = directory.identify(PUBLIC_INSTANCE_IDENTITY_FILENAME); + const namedRecovery = directory.identify(READY_NAME); + if ( + !sameIdentity(finalIdentity, finalAfterIdentity) + || !sameIdentity(recoveryIdentity, recoveryAfterIdentity) + || !sameIdentity(finalAfterIdentity, recoveryAfterIdentity) + || finalAfter.nlink !== 2 + || recoveryAfter.nlink !== 2 + || namedFinal.kind !== "file" + || namedRecovery.kind !== "file" + || !sameIdentity(finalAfterIdentity, namedFinal) + || !sameIdentity(recoveryAfterIdentity, namedRecovery) + ) throw new Error("public identity hardlink state changed during recovery"); + directory.unlink(READY_NAME); + syncDirectory(directory.fd); + await options.onBoundary?.("directory-synced"); + return await readIdentity(directory, PUBLIC_INSTANCE_IDENTITY_FILENAME, options) ?? recovered; + } finally { + if (recoveryFd !== undefined) closeSync(recoveryFd); + if (finalFd !== undefined) closeSync(finalFd); + } +} + +function isCreationTemporaryName(name: string): boolean { + if (!name.startsWith(TEMP_PREFIX)) return false; + return /^[1-9]\d{0,19}-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.test( + name.slice(TEMP_PREFIX.length), + ); +} + +/** + * Repair the exact link-then-unlink remnant left when temporary publication + * reached READY but the process stopped before removing its private source + * name. Both names must be the only links to one valid identity inode. + */ +async function recoverTemporaryLinkRemnant( + directory: PinnedPublicIdentityDirectory, + options: Pick = {}, +): Promise { + if (!directory.listNames) throw new Error("public identity recovery state is ambiguous"); + const names = directory.listNames(); + if (names.length > MAX_DIRECTORY_ENTRIES) { + throw new Error("public identity recovery directory is too large"); + } + + let readyFd: number | undefined; + let temporaryFd: number | undefined; + try { + readyFd = directory.open(READY_NAME, constants.O_RDONLY | constants.O_NOFOLLOW); + const readyStat = fstatSync(readyFd); + const readyIdentity = exactIdentity(readyFd); + validateFileStat(readyStat, directory.ownerUid, 2); + await directory.validateEntry(READY_NAME, readyFd); + + let temporaryName: string | undefined; + for (const name of names) { + if (!isCreationTemporaryName(name)) continue; + let candidateFd: number | undefined; + try { + candidateFd = directory.open(name, constants.O_RDONLY | constants.O_NOFOLLOW); + if (!sameIdentity(readyIdentity, exactIdentity(candidateFd))) continue; + if (temporaryName !== undefined) { + throw new Error("public identity recovery state is ambiguous"); + } + validateFileStat(fstatSync(candidateFd), directory.ownerUid, 2); + await directory.validateEntry(name, candidateFd); + temporaryName = name; + temporaryFd = candidateFd; + candidateFd = undefined; + } finally { + if (candidateFd !== undefined) closeSync(candidateFd); + } + } + if (temporaryName === undefined || temporaryFd === undefined) { + throw new Error("public identity recovery state is ambiguous"); + } + + await readIdentity(directory, READY_NAME, options, 2); + const readyAfter = fstatSync(readyFd); + const temporaryAfter = fstatSync(temporaryFd); + const namedReady = directory.identify(READY_NAME); + const namedTemporary = directory.identify(temporaryName); + if ( + readyAfter.nlink !== 2 + || temporaryAfter.nlink !== 2 + || !sameIdentity(readyIdentity, exactIdentity(readyFd)) + || !sameIdentity(readyIdentity, exactIdentity(temporaryFd)) + || namedReady.kind !== "file" + || namedTemporary.kind !== "file" + || !sameIdentity(readyIdentity, namedReady) + || !sameIdentity(readyIdentity, namedTemporary) + ) throw new Error("public identity hardlink state changed during recovery"); + + directory.unlink(temporaryName); + syncDirectory(directory.fd); + await options.onBoundary?.("directory-synced"); + await readIdentity(directory, READY_NAME, options); + } finally { + if (temporaryFd !== undefined) closeSync(temporaryFd); + if (readyFd !== undefined) closeSync(readyFd); + } +} + +function unlinkIfPresent(directory: PinnedPublicIdentityDirectory, name: string): void { + try { + directory.unlink(name); + } catch (error) { + if (errno(error) !== "ENOENT") throw error; + } +} + +function syncDirectory(fd: number): void { + // FlushFileBuffers does not support directory handles on Windows. The + // identity file itself is flushed before publication; retain directory + // syncing on platforms where the operation is supported. + if (process.platform !== "win32") fsyncSync(fd); +} + +async function publishRecovery( + directory: PinnedPublicIdentityDirectory, + onBoundary?: PublicIdentityOptions["onBoundary"], +): Promise { + let recovered: string; + try { + recovered = await readIdentity(directory, READY_NAME, { onBoundary }); + } catch (error) { + if (errno(error) === "ENOENT") return undefined; + if (error instanceof IdentityBusyError) return undefined; + // Only the fixed, fully-written recovery slot is eligible for cleanup. + // An unsafe owner/type/link is deliberately left untouched and rejected. + let recoveryFd: number | undefined; + try { + recoveryFd = directory.open(READY_NAME, constants.O_RDONLY | constants.O_NOFOLLOW); + const stat = fstatSync(recoveryFd); + if (!stat.isFile() || stat.isSymbolicLink() || stat.nlink !== 1) throw error; + if (!publicIdentityFilePermissionsAllowed(stat, directory.ownerUid)) throw error; + await directory.validateEntry(READY_NAME, recoveryFd); + } finally { + if (recoveryFd !== undefined) closeSync(recoveryFd); + } + unlinkIfPresent(directory, READY_NAME); + syncDirectory(directory.fd); + return undefined; + } + + try { + directory.publishNoReplace(READY_NAME, PUBLIC_INSTANCE_IDENTITY_FILENAME); + await onBoundary?.("identity-published"); + } catch (error) { + if (errno(error) !== "EEXIST") throw error; + unlinkIfPresent(directory, READY_NAME); + } + syncDirectory(directory.fd); + await onBoundary?.("directory-synced"); + try { + return await readIdentity(directory, PUBLIC_INSTANCE_IDENTITY_FILENAME, { onBoundary }) ?? recovered; + } catch (error) { + if (error instanceof IdentityBusyError) return undefined; + throw error; + } +} + +/** Central CLI/API creation algorithm operating only through a held data-directory handle. */ +export async function getOrCreatePublicInstanceIdentityPinned( + directory: PinnedPublicIdentityDirectory, + options: PublicIdentityOptions = {}, +): Promise { + for (let attempt = 0; attempt < 8; attempt += 1) { + let recoveryEntryBusy = false; + try { + // READY is public state in the same authority boundary as the final + // identity. Validate it even when a healthy final file already exists; + // otherwise a hostile stale entry could remain outside the policy. + await readIdentityIfPresent(directory, READY_NAME, options); + } catch (error) { + if (!(error instanceof IdentityBusyError)) throw error; + recoveryEntryBusy = true; + } + try { + const existing = await readIdentityIfPresent(directory, PUBLIC_INSTANCE_IDENTITY_FILENAME, options); + if (existing) { + if (recoveryEntryBusy) throw new Error("public identity recovery state is ambiguous"); + return existing; + } + } catch (error) { + if (!(error instanceof IdentityBusyError)) throw error; + const repaired = await recoverPublishedLinkRemnant(directory, options); + if (repaired) return repaired; + } + if (recoveryEntryBusy) { + await recoverTemporaryLinkRemnant(directory, options); + } + + const recovered = await publishRecovery(directory, options.onBoundary); + if (recovered) return recovered; + + const generated = (options.generate ?? randomUUID)(); + const parsedGenerated = parsePublicInstanceIdentityDocument({ + schemaVersion: PUBLIC_INSTANCE_IDENTITY_SCHEMA_VERSION, + publicInstanceIdentity: generated, + }); + if (!parsedGenerated) throw new Error("identity generator returned an invalid UUIDv4"); + const document = Buffer.from(`${JSON.stringify(parsedGenerated)}\n`, "utf8"); + if (document.byteLength > PUBLIC_IDENTITY_MAX_BYTES) throw new Error("public identity document is too large"); + + const temporaryName = `${TEMP_PREFIX}${process.pid}-${randomUUID()}`; + let temporaryFd: number | undefined; + let temporaryPresent = false; + try { + temporaryFd = directory.open( + temporaryName, + constants.O_WRONLY | constants.O_CREAT | constants.O_EXCL | constants.O_NOFOLLOW, + PUBLIC_IDENTITY_TEMPORARY_MODE, + ); + temporaryPresent = true; + if (process.platform !== "win32") fchmodSync(temporaryFd, PUBLIC_IDENTITY_TEMPORARY_MODE); + await options.onBoundary?.("temporary-opened"); + writeFileSync(temporaryFd, document); + await options.onBoundary?.("temporary-written"); + fsyncSync(temporaryFd); + if (process.platform !== "win32") { + fchmodSync(temporaryFd, PUBLIC_IDENTITY_FILE_MODE); + fsyncSync(temporaryFd); + } + await directory.validateEntry(temporaryName, temporaryFd, true); + await options.onBoundary?.("temporary-synced"); + closeSync(temporaryFd); + temporaryFd = undefined; + + try { + directory.publishNoReplace(temporaryName, READY_NAME); + temporaryPresent = false; + await options.onBoundary?.("recovery-published"); + } catch (error) { + if (errno(error) !== "EEXIST") throw error; + } + } finally { + if (temporaryFd !== undefined) closeSync(temporaryFd); + if (temporaryPresent) unlinkIfPresent(directory, temporaryName); + } + + const winner = await publishRecovery(directory, options.onBoundary); + if (winner) return winner; + } + throw new Error("public instance identity remained a non-single-link file or creation did not settle"); +} + +/** Read the existing public identity without creating, repairing, or unlinking anything. */ +export async function readPublicInstanceIdentityPinned( + directory: PinnedPublicIdentityDirectory, + options: Pick = {}, +): Promise { + const value = await readIdentityIfPresent(directory, PUBLIC_INSTANCE_IDENTITY_FILENAME, options); + if (!value) throw new Error("public instance identity is absent"); + return value; +} + +function descriptorRoot(): string { + for (const candidate of ["/proc/self/fd", "/dev/fd"]) { + try { + if (lstatSync(candidate).isDirectory()) return candidate; + } catch { + // Try the next platform descriptor filesystem. + } + } + throw new Error("safe directory-handle access is unavailable"); +} + +function validateAncestorOwnership(stats: Stats[], terminalOwner: number, role: PublicIdentityRole): void { + const caller = process.getuid?.(); + if (role === "host" && caller !== undefined && terminalOwner !== caller) { + throw new Error("public identity data directory is not owned by the host caller"); + } + for (let index = 0; index < stats.length; index += 1) { + const stat = stats[index]; + const terminal = index === stats.length - 1; + if (terminal) { + validateDirectoryMode(stat); + continue; + } + if (process.platform === "win32") throw new Error("Windows directory ACL authority is unavailable"); + if (stat.uid !== 0 && stat.uid !== terminalOwner) { + throw new Error("public identity ancestry has an unexpected owner"); + } + const writableByOthers = (stat.mode & 0o022) !== 0; + const sticky = (stat.mode & 0o1000) !== 0; + if (writableByOthers && !sticky) throw new Error("public identity ancestry is replaceable"); + } +} + +function openPinnedDataDirectory(dataDir: string, role: PublicIdentityRole): { + directory: PinnedPublicIdentityDirectory; + close(): void; + validateVisible(): void; +} { + if (process.platform !== "linux") { + throw new Error(`safe public identity directory access is not supported on ${process.platform}`); + } + const absolute = resolve(dataDir); + if (absolute === parse(absolute).root) { + throw new Error("public identity data directory cannot be the filesystem root"); + } + const parent = dirname(absolute); + try { + lstatSync(absolute); + } catch (error) { + if (errno(error) !== "ENOENT") throw error; + if (role === "root-container") { + throw new Error("root container cannot establish the host-owned public identity directory"); + } + mkdirSync(absolute, { recursive: false, mode: PUBLIC_IDENTITY_DIRECTORY_MODE }); + chmodSync(absolute, PUBLIC_IDENTITY_DIRECTORY_MODE); + } + + const flags = constants.O_RDONLY | constants.O_DIRECTORY | constants.O_NOFOLLOW; + const fdRoot = descriptorRoot(); + let fd = openSync(parse(absolute).root, flags); + const ancestry: Stats[] = []; + try { + let visible = parse(absolute).root; + for (const component of absolute.slice(parse(absolute).root.length).split(sep).filter(Boolean)) { + const next = openSync(join(fdRoot, String(fd), component), flags); + closeSync(fd); + fd = next; + visible = join(visible, component); + const visibleStat = lstatSync(visible); + const visibleIdentityStat = lstatSync(visible, { bigint: true }); + if (visibleStat.isSymbolicLink() || !sameIdentity( + { device: visibleIdentityStat.dev.toString(10), file: visibleIdentityStat.ino.toString(10) }, + exactIdentity(fd), + )) { + throw new Error("public identity directory changed during acquisition"); + } + ancestry.push(visibleStat); + } + const terminal = fstatSync(fd); + validateAncestorOwnership(ancestry, terminal.uid, role); + if (realpathSync.native(absolute) !== absolute) throw new Error("public identity directory uses a symbolic-link ancestor"); + const anchor = join(fdRoot, String(fd)); + const listNames = (): readonly string[] => { + const names: string[] = []; + const entries = opendirSync(anchor); + try { + for (;;) { + const entry = entries.readSync(); + if (entry === null) return names; + names.push(entry.name); + if (names.length > MAX_DIRECTORY_ENTRIES) { + throw new Error("public identity recovery directory is too large"); + } + } + } finally { + entries.closeSync(); + } + }; + const directory: PinnedPublicIdentityDirectory = { + fd, + ownerUid: terminal.uid, + open: (name, openFlags, mode = 0) => openSync(join(anchor, name), openFlags, mode), + identify: (name) => { + const stat = lstatSync(join(anchor, name), { bigint: true }); + return { + device: stat.dev.toString(10), + file: stat.ino.toString(10), + kind: stat.isFile() + ? "file" + : stat.isDirectory() + ? "directory" + : stat.isSymbolicLink() + ? "symbolic-link" + : "other", + }; + }, + validateEntry: () => undefined, + listNames, + publishNoReplace: (oldName, newName) => { + linkSync(join(anchor, oldName), join(anchor, newName)); + unlinkSync(join(anchor, oldName)); + }, + unlink: (name) => unlinkSync(join(anchor, name)), + }; + return { + directory, + close: () => closeSync(fd), + validateVisible: () => { + const visible = lstatSync(absolute); + const visibleIdentity = lstatSync(absolute, { bigint: true }); + if (visible.isSymbolicLink() || !sameIdentity( + { device: visibleIdentity.dev.toString(10), file: visibleIdentity.ino.toString(10) }, + exactIdentity(fd), + )) { + throw new Error("public identity data directory was replaced"); + } + }, + }; + } catch (error) { + closeSync(fd); + throw error; + } +} + +/** Path entry point used by both host initialization and the root API container. */ +export async function getOrCreatePublicInstanceIdentity( + dataDir: string, + options: PublicIdentityOptions = {}, +): Promise { + const pinned = openPinnedDataDirectory(dataDir, options.role ?? "host"); + try { + const identity = await getOrCreatePublicInstanceIdentityPinned(pinned.directory, options); + pinned.validateVisible(); + return identity; + } finally { + pinned.close(); + } +} diff --git a/packages/shared/src/apiOrigin.ts b/packages/shared/src/apiOrigin.ts new file mode 100644 index 000000000..5899f2bc1 --- /dev/null +++ b/packages/shared/src/apiOrigin.ts @@ -0,0 +1,115 @@ +export interface NormalizeProprApiOriginOptions { + /** Browser-hosted development may deliberately opt into non-loopback HTTP. */ + allowInsecureHttp?: boolean; + /** The browser client uses an empty value to mean same-origin. */ + allowEmpty?: boolean; +} + +/** One documented parity table consumed by client, Electron, store and UI tests. */ +export const PROPR_API_ORIGIN_PARITY_CASES = [ + ['https origin', 'https://propr.example.test', 'https://propr.example.test'], + ['https trailing slash', 'https://propr.example.test/', 'https://propr.example.test'], + ['localhost', 'http://localhost:3000', 'http://localhost:3000'], + ['localhost subdomain', 'http://api.dev.localhost:3000', 'http://api.dev.localhost:3000'], + ['IPv4 127/8', 'http://127.42.7.9:3000', 'http://127.42.7.9:3000'], + ['IPv6 loopback', 'http://[::1]:3000', 'http://[::1]:3000'], + ['credentials', 'https://user:secret@propr.example.test', null], + ['path', 'https://propr.example.test/api', null], + ['query', 'https://propr.example.test?token=x', null], + ['fragment', 'https://propr.example.test#x', null], + ['encoded host', 'http://local%68ost:3000', null], + ['trailing dot', 'http://localhost.:3000', null], + ['localhost subdomain trailing dot', 'http://api.dev.localhost.:3000', null], + ['short IPv4', 'http://127.1:3000', null], + ['octal IPv4', 'http://0177.0.0.1:3000', null], + ['hex IPv4', 'http://0x7f000001:3000', null], + ['mapped IPv6', 'http://[::ffff:127.0.0.1]:3000', null], + ['mapped IPv6 over HTTPS', 'https://[::ffff:127.0.0.1]:3000', null], + ['alternate IPv6 spelling', 'https://[0:0:0:0:0:0:0:1]:3000', null], + ['localhost lookalike', 'http://localhost.example.test:3000', null], + ['non-loopback HTTP', 'http://192.168.1.20:3000', null], +] as const; + +const DECIMAL_IPV4 = /^(0|[1-9][0-9]{0,2})(?:\.(0|[1-9][0-9]{0,2})){3}$/; + +const rawHostname = (authority: string): string | null => { + if (!authority || authority.includes('@') || authority.includes('%') || authority.includes('\\')) return null; + if (authority.startsWith('[')) { + const close = authority.indexOf(']'); + if (close < 0 || (authority.slice(close + 1) !== '' && !/^:[0-9]+$/.test(authority.slice(close + 1)))) { + return null; + } + return authority.slice(0, close + 1); + } + if ((authority.match(/:/g) ?? []).length > 1) return null; + return authority.split(':', 1)[0] ?? null; +}; + +/** True only for the deliberately supported, canonical HTTP loopback names. */ +export const isProprLoopbackHostname = (hostname: string): boolean => { + const normalized = hostname.toLowerCase(); + if (normalized === 'localhost' || normalized === '[::1]') return true; + if (normalized.endsWith('.localhost')) { + return normalized.slice(0, -'.localhost'.length).split('.').every(label => + /^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$/i.test(label) + ); + } + if (!DECIMAL_IPV4.test(normalized)) return false; + const octets = normalized.split('.').map(Number); + return octets[0] === 127 && octets.every(octet => octet <= 255); +}; + +/** + * Return one canonical HTTP(S) origin, or null. The lexical authority checks + * deliberately run before WHATWG URL parsing so numeric and encoded host + * aliases cannot be canonicalized into a broader credential scope. + */ +export const canonicalProprHttpUrlOrigin = ( + value: string | null | undefined, + options: NormalizeProprApiOriginOptions = {}, +): string | null => { + const candidate = value?.trim() ?? ''; + if (!candidate) return options.allowEmpty ? '' : null; + if (candidate.length > 2_048 || candidate.includes('\\')) return null; + + const lexical = /^([A-Za-z][A-Za-z0-9+.-]*):\/\/([^/?#]*)(?:[/?#]|$)/.exec(candidate); + if (!lexical) return null; + const authorityHostname = rawHostname(lexical[2]); + if (!authorityHostname || authorityHostname.endsWith('.')) return null; + + let parsed: URL; + try { + parsed = new URL(candidate); + } catch { + return null; + } + if (parsed.protocol !== 'http:' && parsed.protocol !== 'https:') return null; + if (parsed.username || parsed.password) return null; + + const rawLower = authorityHostname.toLowerCase(); + const parsedLower = parsed.hostname.toLowerCase(); + const rawLooksNumeric = /^[0-9]/.test(rawLower) || rawLower.startsWith('0x') || rawLower.startsWith('['); + if (rawLooksNumeric && parsedLower !== rawLower) return null; + if (parsedLower.startsWith('[::ffff:')) return null; + + if (parsed.protocol === 'http:' + && options.allowInsecureHttp !== true + && !isProprLoopbackHostname(parsed.hostname)) return null; + + // For HTTP, require the exact supported lexical spelling too. This rejects + // expanded/mapped IPv6 and every WHATWG alternate IPv4 representation. + if (parsed.protocol === 'http:' && options.allowInsecureHttp !== true) { + if (rawLower !== parsedLower || !isProprLoopbackHostname(rawLower)) return null; + } + return parsed.origin; +}; + +export const normalizeProprApiOrigin = ( + value: string | null | undefined, + options: NormalizeProprApiOriginOptions = {}, +): string | null => { + const candidate = value?.trim() ?? ''; + if (!candidate) return options.allowEmpty ? '' : null; + if (!/^[A-Za-z][A-Za-z0-9+.-]*:\/\/[^/?#]*\/?$/.test(candidate)) return null; + return canonicalProprHttpUrlOrigin(candidate, options); +}; diff --git a/packages/shared/src/connectDiscovery.ts b/packages/shared/src/connectDiscovery.ts new file mode 100644 index 000000000..30498e241 --- /dev/null +++ b/packages/shared/src/connectDiscovery.ts @@ -0,0 +1,210 @@ +import type { ProprCompatibilityMetadata } from './proprCompatibility.js'; +import { canonicalProprProxyUrl } from './proprServiceUrls.js'; + +export const PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION = 1 as const; +export const PUBLIC_INSTANCE_IDENTITY_SCHEMA_VERSION = 1 as const; +export const PUBLIC_INSTANCE_IDENTITY_FILENAME = 'public-instance-identity.json'; +export const PROPR_CONNECT_DISCOVERY_MAX_BYTES = 8 * 1024; + +export interface PublicInstanceIdentityDocument { + schemaVersion: typeof PUBLIC_INSTANCE_IDENTITY_SCHEMA_VERSION; + publicInstanceIdentity: string; +} + +export interface ProprDesktopDiscovery extends ProprCompatibilityMetadata { + schemaVersion: typeof PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION; + product: 'ProPR'; + canonicalEndpoint: string | null; + publicInstanceIdentity: string; +} + +/** UUIDv4 is random, non-secret, bounded, and contains no installation data. */ +export function isPublicInstanceIdentity(value: unknown): value is string { + return typeof value === 'string' + && /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.test(value); +} + +export function parsePublicInstanceIdentityDocument(value: unknown): PublicInstanceIdentityDocument | null { + if (!value || typeof value !== 'object' || Array.isArray(value)) return null; + const candidate = value as Record; + if ( + candidate.schemaVersion !== PUBLIC_INSTANCE_IDENTITY_SCHEMA_VERSION + || !isPublicInstanceIdentity(candidate.publicInstanceIdentity) + ) return null; + return { + schemaVersion: PUBLIC_INSTANCE_IDENTITY_SCHEMA_VERSION, + publicInstanceIdentity: candidate.publicInstanceIdentity, + }; +} + +const DISCOVERY_KEYS = [ + 'schemaVersion', + 'product', + 'version', + 'apiCompatibility', + 'uiCompatibility', + 'desktopAuthentication', + 'canonicalEndpoint', + 'publicInstanceIdentity', +] as const; +const DESKTOP_AUTHENTICATION_KEYS = [ + 'protocolVersion', + 'browserPairing', + 'instanceBearerTokens', + 'socketIoBearerAuthentication', +] as const; +const MAX_DISCOVERY_SCALAR_LENGTH = 64; +const CANONICAL_SEMVER = /^(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)(?:-(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\+[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?$/; +const CANONICAL_COMPATIBILITY = /^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$/; + +function hasExactKeys(value: Record, expected: readonly string[]): boolean { + const actual = Object.keys(value).sort(); + return actual.length === expected.length + && actual.every((key, index) => key === [...expected].sort()[index]); +} + +function isCanonicalCompatibility(value: unknown): value is string { + if ( + typeof value !== 'string' + || value.length === 0 + || value.length > MAX_DISCOVERY_SCALAR_LENGTH + || !CANONICAL_COMPATIBILITY.test(value) + ) return false; + const parsed = new Date(`${value}T00:00:00.000Z`); + return !Number.isNaN(parsed.valueOf()) && parsed.toISOString().slice(0, 10) === value; +} + +/** Strictly parse the schema-v1 discovery document with desktop-auth protocol v2. */ +export function parseProprDesktopDiscovery(value: unknown): ProprDesktopDiscovery | null { + if (!value || typeof value !== 'object' || Array.isArray(value)) return null; + const candidate = value as Record; + if (!hasExactKeys(candidate, DISCOVERY_KEYS)) return null; + + const authentication = candidate.desktopAuthentication; + if (!authentication || typeof authentication !== 'object' || Array.isArray(authentication)) return null; + const capabilities = authentication as Record; + if (!hasExactKeys(capabilities, DESKTOP_AUTHENTICATION_KEYS)) return null; + + const endpoint = candidate.canonicalEndpoint; + if ( + candidate.schemaVersion !== PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION + || candidate.product !== 'ProPR' + || typeof candidate.version !== 'string' + || candidate.version.length === 0 + || candidate.version.length > MAX_DISCOVERY_SCALAR_LENGTH + || !CANONICAL_SEMVER.test(candidate.version) + || !isCanonicalCompatibility(candidate.apiCompatibility) + || !isCanonicalCompatibility(candidate.uiCompatibility) + || !isPublicInstanceIdentity(candidate.publicInstanceIdentity) + || (endpoint !== null && ( + typeof endpoint !== 'string' + || canonicalProprProxyUrl(endpoint) !== endpoint + )) + || capabilities.protocolVersion !== 2 + || typeof capabilities.browserPairing !== 'boolean' + || typeof capabilities.instanceBearerTokens !== 'boolean' + || typeof capabilities.socketIoBearerAuthentication !== 'boolean' + ) return null; + + return { + schemaVersion: PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION, + product: 'ProPR', + version: candidate.version, + apiCompatibility: candidate.apiCompatibility, + uiCompatibility: candidate.uiCompatibility, + canonicalEndpoint: endpoint as string | null, + publicInstanceIdentity: candidate.publicInstanceIdentity, + desktopAuthentication: { + protocolVersion: 2, + browserPairing: capabilities.browserPairing, + instanceBearerTokens: capabilities.instanceBearerTokens, + socketIoBearerAuthentication: capabilities.socketIoBearerAuthentication, + }, + }; +} + +/** + * Parse discovery from its bounded wire representation. JSON.parse silently + * accepts duplicate object members, so discovery uses this small structural + * pass before the schema parser. Keeping it here makes CLI, client and desktop + * consumers agree on duplicate, size and schema rejection. + */ +export function parseProprDesktopDiscoveryJson(contents: string): ProprDesktopDiscovery | null { + if (typeof contents !== 'string' + || new TextEncoder().encode(contents).byteLength > PROPR_CONNECT_DISCOVERY_MAX_BYTES) return null; + + let offset = 0; + const whitespace = (): void => { + while (offset < contents.length && /[\x20\t\r\n]/.test(contents[offset])) offset += 1; + }; + const stringToken = (): string | null => { + if (contents[offset] !== '"') return null; + const start = offset; + offset += 1; + while (offset < contents.length) { + const character = contents[offset++]; + if (character === '"') { + try { return JSON.parse(contents.slice(start, offset)) as string; } catch { return null; } + } + if (character === '\\') { + const escape = contents[offset++]; + if (escape === 'u') { + if (!/^[0-9a-fA-F]{4}$/.test(contents.slice(offset, offset + 4))) return null; + offset += 4; + } else if (!escape || !'"\\/bfnrt'.includes(escape)) return null; + } else if (character.charCodeAt(0) < 0x20) return null; + } + return null; + }; + const value = (): boolean => { + whitespace(); + if (contents[offset] === '{') { + offset += 1; + whitespace(); + const keys = new Set(); + if (contents[offset] === '}') { offset += 1; return true; } + while (offset < contents.length) { + const key = stringToken(); + if (key === null || keys.has(key)) return false; + keys.add(key); + whitespace(); + if (contents[offset++] !== ':') return false; + if (!value()) return false; + whitespace(); + const separator = contents[offset++]; + if (separator === '}') return true; + if (separator !== ',') return false; + whitespace(); + } + return false; + } + if (contents[offset] === '[') { + offset += 1; + whitespace(); + if (contents[offset] === ']') { offset += 1; return true; } + while (offset < contents.length) { + if (!value()) return false; + whitespace(); + const separator = contents[offset++]; + if (separator === ']') return true; + if (separator !== ',') return false; + } + return false; + } + if (contents[offset] === '"') return stringToken() !== null; + const primitive = /^(?:true|false|null|-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?)/ + .exec(contents.slice(offset))?.[0]; + if (!primitive) return false; + offset += primitive.length; + return true; + }; + + if (!value()) return null; + whitespace(); + if (offset !== contents.length) return null; + try { + return parseProprDesktopDiscovery(JSON.parse(contents) as unknown); + } catch { + return null; + } +} diff --git a/packages/shared/src/desktopPairing.ts b/packages/shared/src/desktopPairing.ts new file mode 100644 index 000000000..fb78067fd --- /dev/null +++ b/packages/shared/src/desktopPairing.ts @@ -0,0 +1,117 @@ +import { normalizeProprApiOrigin } from './apiOrigin.js'; +import { + DEFAULT_PROPR_UI_ORIGIN, + isProprConnectReservedHostAttempt, + parseProprConnectEndpoint, +} from './proprServiceUrls.js'; + +const DESKTOP_PAIRING_ID_PATTERN = /^dpr_[A-Za-z0-9_-]{22}$/; + +export interface DesktopPairingApprovalUrlInput { + /** Canonical API origin returned by endpoint discovery. */ + apiBaseUrl: string; + /** Pairing id returned by the same pairing bootstrap response. */ + pairingId: string; + /** Approval URL returned by the API. Renderer input must never be used here. */ + approvalUrl: string; +} + +const rawAuthority = (value: string): string | null => + /^[a-z][a-z\d+.-]*:\/\/([^/?#]*)/i.exec(value)?.[1] ?? null; + +const bareHttpOrigin = (value: string): URL | null => { + const connectEndpoint = parseProprConnectEndpoint(value); + if (isProprConnectReservedHostAttempt(value) && !connectEndpoint) return null; + const normalized = normalizeProprApiOrigin(value); + if (normalized === null || normalized !== value) return null; + try { + const url = new URL(normalized); + // Callers must supply the already-normalized discovery origin. Binding an + // approval response to a second spelling would reintroduce encoded-host or + // explicit-default-port ambiguity at the browser boundary. + if (value !== url.origin || rawAuthority(value)?.toLowerCase() !== url.host.toLowerCase()) return null; + return url; + } catch { + return null; + } +}; + +const hasExactSearchParameters = (url: URL, names: readonly string[]): boolean => { + const actual = [...url.searchParams.keys()]; + return actual.length === names.length + && names.every(name => actual.filter(candidate => candidate === name).length === 1); +}; + +const hasCanonicalRawSearchParameters = ( + url: URL, + expected: Readonly>, +): boolean => { + const query = url.search.startsWith('?') ? url.search.slice(1) : url.search; + const parameters = query.split('&'); + const names = Object.keys(expected); + if (parameters.length !== names.length) return false; + + const actual = new Map(); + for (const parameter of parameters) { + const separator = parameter.indexOf('='); + if (separator === -1) return false; + const name = parameter.slice(0, separator); + if (!Object.hasOwn(expected, name) || actual.has(name)) return false; + actual.set(name, parameter.slice(separator + 1)); + } + return names.every(name => actual.get(name) === expected[name]); +}; + +/** + * Validate an API-returned browser approval URL against the pairing bootstrap + * that supplied it. Two existing server contracts are accepted: + * + * - the hosted approval page on `https://app.propr.dev/desktop/pairing`, bound + * to the exact verified Connect hostname; and + * - the exact `/api/desktop/pairings//browser` route on the API origin. + * + * No URL is synthesized. Unknown query parameters, fragments, credentials, + * alternate origins, private paths, and pairing ids are rejected. + */ +export function normalizeDesktopPairingApprovalUrl( + input: DesktopPairingApprovalUrlInput, +): string | null { + if (!DESKTOP_PAIRING_ID_PATTERN.test(input.pairingId)) return null; + const apiBase = bareHttpOrigin(input.apiBaseUrl); + if (!apiBase) return null; + + let approval: URL; + try { + approval = new URL(input.approvalUrl); + } catch { + return null; + } + if (approval.username || approval.password || approval.hash) return null; + const approvalAuthority = rawAuthority(input.approvalUrl)?.toLowerCase(); + + const fallbackPath = `/api/desktop/pairings/${input.pairingId}/browser`; + if ( + approval.origin === apiBase.origin + && approvalAuthority === apiBase.host.toLowerCase() + && approval.pathname === fallbackPath + && !approval.search + ) { + return approval.toString(); + } + + const connectEndpoint = parseProprConnectEndpoint(input.apiBaseUrl); + if ( + !connectEndpoint + || approval.origin !== DEFAULT_PROPR_UI_ORIGIN + || approvalAuthority !== new URL(DEFAULT_PROPR_UI_ORIGIN).host + ) return null; + if (approval.pathname !== '/desktop/pairing') return null; + if (!hasExactSearchParameters(approval, ['pairing_id', 'tunnel'])) return null; + if (approval.searchParams.get('pairing_id') !== input.pairingId) return null; + if (approval.searchParams.get('tunnel') !== connectEndpoint.hostname) return null; + if (!hasCanonicalRawSearchParameters(approval, { + pairing_id: input.pairingId, + tunnel: connectEndpoint.hostname, + })) return null; + return approval.toString(); +} diff --git a/packages/shared/src/desktopTokenRevocation.ts b/packages/shared/src/desktopTokenRevocation.ts new file mode 100644 index 000000000..7012d40f6 --- /dev/null +++ b/packages/shared/src/desktopTokenRevocation.ts @@ -0,0 +1,21 @@ +export const DESKTOP_TOKEN_REVOCATION_ENDPOINT = '/api/desktop/tokens/current'; +export const DESKTOP_REVOCATION_BINDING_HEADER = 'X-ProPR-Desktop-Revocation-Binding'; +export const DESKTOP_TOKEN_REVOCATION_SCHEMA = 'propr.desktop-token-revocation'; +export const DESKTOP_TOKEN_REVOCATION_VERSION = 1; + +export const DESKTOP_TOKEN_TERMINAL_CODES = [ + 'TOKEN_NOT_FOUND', + 'INSTANCE_TOKEN_REVOKED', + 'INSTANCE_TOKEN_EXPIRED', +] as const; + +export type DesktopTokenTerminalCode = typeof DESKTOP_TOKEN_TERMINAL_CODES[number]; + +export interface DesktopTokenTerminalRevocation { + schema: typeof DESKTOP_TOKEN_REVOCATION_SCHEMA; + version: typeof DESKTOP_TOKEN_REVOCATION_VERSION; + endpoint: typeof DESKTOP_TOKEN_REVOCATION_ENDPOINT; + terminal: true; + code: DesktopTokenTerminalCode; + credentialGeneration: string; +} diff --git a/packages/shared/src/index.ts b/packages/shared/src/index.ts index 57524a5a6..0d15fde8d 100644 --- a/packages/shared/src/index.ts +++ b/packages/shared/src/index.ts @@ -58,6 +58,24 @@ export { DEMO_MODE_READ_ONLY_CODE, parseTruthyEnvValue } from './demoMode.js'; export { MIN_SESSION_SECRET_LENGTH, validateSessionSecret } from './sessionSecret.js'; +export { + canonicalProprHttpUrlOrigin, + isProprLoopbackHostname, + normalizeProprApiOrigin, + PROPR_API_ORIGIN_PARITY_CASES, + type NormalizeProprApiOriginOptions, +} from './apiOrigin.js'; + +export { + DESKTOP_REVOCATION_BINDING_HEADER, + DESKTOP_TOKEN_REVOCATION_ENDPOINT, + DESKTOP_TOKEN_REVOCATION_SCHEMA, + DESKTOP_TOKEN_REVOCATION_VERSION, + DESKTOP_TOKEN_TERMINAL_CODES, + type DesktopTokenTerminalCode, + type DesktopTokenTerminalRevocation, +} from './desktopTokenRevocation.js'; + export { INSTANCE_PERMISSIONS, type AuthenticatedInstanceUser, @@ -113,15 +131,42 @@ export { DEFAULT_PROPR_GH_RELAY_URL, DEFAULT_PROPR_UI_ORIGIN, DESKTOP_RENDERER_ORIGIN, + DESKTOP_TRANSPORT_SCOPE_HEADER, + DESKTOP_TRANSPORT_SCOPE_QUERY, PROPR_UI_PROXY_SUFFIX, PROPR_UI_PROXY_LABEL_PREFIX, + MAX_PROPR_API_BASE_URL_LENGTH, DEFAULT_CLOUDFLARED_IMAGE, proprInstanceProxyUrl, + canonicalProprProxySelector, + canonicalProprProxyUrl, isValidProprInstanceId, + parseProprConnectEndpoint, + isCanonicalProprConnectHostname, + isProprConnectReservedHostAttempt, + type ProprConnectEndpoint, isProprProxyUrl, proprTunnelEndpoints, } from './proprServiceUrls.js'; +export { + normalizeDesktopPairingApprovalUrl, + type DesktopPairingApprovalUrlInput, +} from './desktopPairing.js'; + +export { + PROPR_CONNECT_DISCOVERY_SCHEMA_VERSION, + PROPR_CONNECT_DISCOVERY_MAX_BYTES, + PUBLIC_INSTANCE_IDENTITY_SCHEMA_VERSION, + PUBLIC_INSTANCE_IDENTITY_FILENAME, + isPublicInstanceIdentity, + parseProprDesktopDiscovery, + parseProprDesktopDiscoveryJson, + parsePublicInstanceIdentityDocument, + type PublicInstanceIdentityDocument, + type ProprDesktopDiscovery, +} from './connectDiscovery.js'; + // Export routing URL validation (shared by intake prerequisites and the daemon // routing service so the boot/CLI checks and the dialer agree on one policy) export { validateRoutingUrl } from './validateRoutingUrl.js'; diff --git a/packages/shared/src/proprCompatibility.ts b/packages/shared/src/proprCompatibility.ts index 0110aae11..ba6348137 100644 --- a/packages/shared/src/proprCompatibility.ts +++ b/packages/shared/src/proprCompatibility.ts @@ -22,7 +22,7 @@ export interface ProprCompatibilityMetadata { } export interface ProprDesktopAuthenticationCapabilities { - protocolVersion: 1; + protocolVersion: 2; browserPairing: boolean; instanceBearerTokens: boolean; socketIoBearerAuthentication: boolean; @@ -53,7 +53,7 @@ export function getProprCompatibilityMetadata(desktopAuthenticationEnabled = tru apiCompatibility: PROPR_API_COMPATIBILITY, uiCompatibility: PROPR_UI_COMPATIBILITY, desktopAuthentication: { - protocolVersion: 1, + protocolVersion: 2, browserPairing: desktopAuthenticationEnabled, instanceBearerTokens: desktopAuthenticationEnabled, socketIoBearerAuthentication: desktopAuthenticationEnabled, diff --git a/packages/shared/src/proprServiceUrls.ts b/packages/shared/src/proprServiceUrls.ts index b06cec385..670616e23 100644 --- a/packages/shared/src/proprServiceUrls.ts +++ b/packages/shared/src/proprServiceUrls.ts @@ -41,6 +41,12 @@ export const DEFAULT_PROPR_UI_ORIGIN = 'https://app.propr.dev'; */ export const DESKTOP_RENDERER_ORIGIN = 'propr-app://renderer'; +/** Opaque activation binding carried by packaged renderer REST requests. */ +export const DESKTOP_TRANSPORT_SCOPE_HEADER = 'X-ProPR-Desktop-Transport-Scope'; + +/** Opaque activation binding carried by packaged renderer Socket.IO upgrades. */ +export const DESKTOP_TRANSPORT_SCOPE_QUERY = 'proprDesktopTransportScope'; + /** * DNS suffix and label prefix for per-instance UI/API tunnel hostnames. Each * local stack with an instance id is reachable at @@ -49,6 +55,18 @@ export const DESKTOP_RENDERER_ORIGIN = 'propr-app://renderer'; */ export const PROPR_UI_PROXY_SUFFIX = 'propr.dev'; export const PROPR_UI_PROXY_LABEL_PREFIX = 't-'; +export const MAX_PROPR_API_BASE_URL_LENGTH = 2048; + +const CANONICAL_PROPR_CONNECT_HOST_PATTERN = + /^(t-([a-z0-9]|[a-z0-9][a-z0-9-]{0,59}[a-z0-9]))\.propr\.dev$/; + +/** A verified, canonical ProPR Connect API origin. */ +export interface ProprConnectEndpoint { + kind: 'propr-connect'; + origin: string; + hostname: string; + instanceId: string; +} /** * Default Cloudflare Tunnel image used to expose the local stack's UI/API to @@ -62,13 +80,13 @@ export const DEFAULT_CLOUDFLARED_IMAGE = 'cloudflare/cloudflared:2024.12.2'; /** * Whether an instance id is usable as a single DNS label in the per-instance * proxy hostname (`t-.propr.dev`). Enforces the standard label rules: - * 1–63 characters, ASCII letters/digits/hyphens only, and no leading or - * trailing hyphen. This rejects spaces, slashes, dots, underscores, and other - * characters that would produce an invalid or ambiguous hostname. + * 1–61 characters (leaving room for the `t-` prefix), ASCII + * letters/digits/hyphens only, and no leading or trailing hyphen. This rejects + * values that would produce an invalid or ambiguous complete DNS label. */ export function isValidProprInstanceId(instanceId: string | undefined | null): boolean { const id = (instanceId ?? '').trim(); - return /^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$/i.test(id); + return /^[a-z0-9]([a-z0-9-]{0,59}[a-z0-9])?$/i.test(id); } /** @@ -88,42 +106,161 @@ export function proprInstanceProxyUrl(instanceId: string | undefined | null): st return `https://${PROPR_UI_PROXY_LABEL_PREFIX}${id.toLowerCase()}.${PROPR_UI_PROXY_SUFFIX}`; } +/** + * Normalize one scheme-less Connect tunnel selector. Connect deep links carry + * only the DNS hostname (`t-.propr.dev`), never a URL or a bare instance + * id. Every spelling must already be exact, including lowercase DNS case: + * no whitespace, percent encoding, userinfo, port, path, query, fragment, + * trailing dot, extra label, or non-ASCII character is accepted. + */ +export function canonicalProprProxySelector(selector: string | undefined | null): string | undefined { + if (!selector || selector !== selector.trim() || /[^\x20-\x7e]/.test(selector)) return undefined; + const normalized = selector.toLowerCase(); + const suffix = `.${PROPR_UI_PROXY_SUFFIX}`; + if (!normalized.startsWith(PROPR_UI_PROXY_LABEL_PREFIX) || !normalized.endsWith(suffix)) { + return undefined; + } + const label = normalized.slice(0, -suffix.length); + if (label.length > 63 || label.includes('.')) return undefined; + const id = label.slice(PROPR_UI_PROXY_LABEL_PREFIX.length); + return isValidProprInstanceId(id) + && /^[a-z0-9.-]+$/.test(selector) + && selector === normalized + ? selector + : undefined; +} + +/** + * Return the one canonical Connect proxy origin, or undefined for anything + * else. The raw value must be ASCII and carry no userinfo, port, path, query, + * fragment, IDNA spelling, or alternate DNS representation. This is the + * authority parser used by setup, local discovery, and remote identity checks. + */ +export function canonicalProprProxyUrl(url: string | undefined | null): string | undefined { + if (!url || url !== url.trim() || /[^\x20-\x7e]/.test(url)) return undefined; + try { + const parsed = new URL(url); + if ( + parsed.protocol !== 'https:' + || parsed.username !== '' + || parsed.password !== '' + || parsed.port !== '' + || parsed.pathname !== '/' + || parsed.search !== '' + || parsed.hash !== '' + ) return undefined; + + const suffix = `.${PROPR_UI_PROXY_SUFFIX}`; + if (!parsed.hostname.endsWith(suffix)) return undefined; + const label = parsed.hostname.slice(0, -suffix.length); + if ( + label.length > 63 + || label.includes('.') + || !label.startsWith(PROPR_UI_PROXY_LABEL_PREFIX) + ) return undefined; + const id = label.slice(PROPR_UI_PROXY_LABEL_PREFIX.length); + if (!isValidProprInstanceId(id)) return undefined; + + const canonical = `https://${PROPR_UI_PROXY_LABEL_PREFIX}${id.toLowerCase()}.${PROPR_UI_PROXY_SUFFIX}`; + // Compare the raw spelling: URL parsing must not normalize case or any + // number of trailing slashes into authority at this trust boundary. + return url === canonical ? canonical : undefined; + } catch { + return undefined; + } +} + /** * Whether a URL is a hosted per-instance proxy URL (`https://t-.propr.dev`). * propr-routing only forwards `/api/*` and `/socket.io/*` on these hosts, so the * tunnel base URL must be one of them. Requires https and *exactly one* valid * `t-` label in front of the shared {@link PROPR_UI_PROXY_SUFFIX}. * Other propr.dev hosts like `app.propr.dev` and nested hosts are rejected. It - * must also be a bare origin: a non-root path, query, or fragment (e.g. + * must also be the exact raw bare origin: a slash, path, query, or fragment (e.g. * `https://t-abc.propr.dev/api`) is rejected because * {@link proprTunnelEndpoints} appends `/api/...` itself and a base path would * double it up (`.../api/api/status`). Returns false for a malformed URL. */ -export function isProprProxyUrl(url: string | undefined | null): boolean { - if (!url) return false; - try { - const { protocol, hostname, pathname, search, hash } = new URL(url); - if (protocol !== 'https:') return false; - // Must be a bare origin — the tunnel endpoint helpers own the path suffix. - // Trailing slashes (`/`, `//`) are tolerated (callers trim them); any real - // path segment, query, or fragment is rejected so a base path can't double - // up the appended `/api/...`. - if (/[^/]/.test(pathname) || search || hash) return false; +export function parseProprConnectEndpoint(url: string | undefined | null): ProprConnectEndpoint | null { + if (typeof url !== 'string' || url.length > MAX_PROPR_API_BASE_URL_LENGTH) return null; + // Trust only one byte-for-byte spelling. Avoid URL parsing before this match: + // WHATWG normalization would erase case, default ports, escapes, IDNA input, + // repeated slashes, and other distinctions that are security-significant for + // the reserved Connect namespace. + const match = /^https:\/\/(t-(?:[a-z0-9]|[a-z0-9][a-z0-9-]{0,59}[a-z0-9])\.propr\.dev)$/.exec(url); + if (!match) return null; + const hostname = match[1]; + const hostMatch = CANONICAL_PROPR_CONNECT_HOST_PATTERN.exec(hostname); + if (!hostMatch) return null; + return { + kind: 'propr-connect', + origin: url, + hostname, + instanceId: hostMatch[2], + }; +} + +/** Whether a raw host is the exact lowercase ASCII Connect shorthand. */ +export function isCanonicalProprConnectHostname(hostname: string | undefined | null): boolean { + return typeof hostname === 'string' + && hostname.length <= 253 + && CANONICAL_PROPR_CONNECT_HOST_PATTERN.test(hostname); +} + +/** + * Whether an absolute URL is trying to address the reserved ProPR Connect DNS + * namespace. This deliberately recognizes noncanonical spellings so a failed + * strict Connect parse cannot fall through and acquire ordinary remote-origin + * behavior. It does not reserve suffix lookalikes outside `*.propr.dev`. + */ +export function isProprConnectReservedHostAttempt(url: string | undefined | null): boolean { + if (typeof url !== 'string' || !url || url.length > MAX_PROPR_API_BASE_URL_LENGTH) return false; + if (parseProprConnectEndpoint(url)) return true; + + const isReservedHostname = (hostname: string): boolean => { + const normalized = hostname.toLowerCase().replace(/\.+$/, ''); const suffix = `.${PROPR_UI_PROXY_SUFFIX}`; - if (!hostname.endsWith(suffix)) return false; - const label = hostname.slice(0, -suffix.length); - if (label.includes('.') || !label.startsWith(PROPR_UI_PROXY_LABEL_PREFIX)) { - return false; - } - return isValidProprInstanceId(label.slice(PROPR_UI_PROXY_LABEL_PREFIX.length)); + if (!normalized.endsWith(suffix)) return false; + const labels = normalized.slice(0, -suffix.length).split('.'); + return labels.some(label => label.startsWith(PROPR_UI_PROXY_LABEL_PREFIX)); + }; + + try { + if (isReservedHostname(new URL(url).hostname)) return true; + } catch { + // Raw authority inspection below still catches malformed reserved attempts. + } + + const authority = /^[a-z][a-z\d+.-]*:\/\/([^/?#]*)/i.exec(url)?.[1]; + if (!authority) return false; + const spellings = [authority]; + try { + const decoded = decodeURIComponent(authority); + if (decoded !== authority) spellings.push(decoded); } catch { - return false; + // A malformed escape cannot become a canonical endpoint, but the literal + // spelling can still identify an attempted reserved hostname. } + return spellings.some(spelling => spelling + .split('@') + .flatMap(part => part.split('\\')) + .some(part => isReservedHostname(part.replace(/:\d+$/, '')))); +} + +/** + * Whether a URL is the exact hosted endpoint shape used by ProPR Connect. + * + * The legacy function name remains part of the tunnel configuration contract; + * new desktop-facing code should prefer {@link parseProprConnectEndpoint} so + * user-visible copy can consistently use the ProPR Connect name. + */ +export function isProprProxyUrl(url: string | undefined | null): boolean { + return parseProprConnectEndpoint(url) !== null; } function normalizeProprInstanceId(instanceId: string | undefined | null): string { const id = (instanceId ?? '').trim(); - return id.startsWith(PROPR_UI_PROXY_LABEL_PREFIX) + return id.toLowerCase().startsWith(PROPR_UI_PROXY_LABEL_PREFIX) ? id.slice(PROPR_UI_PROXY_LABEL_PREFIX.length) : id; } diff --git a/propr-ui/src/App.hostedCompletion.test.tsx b/propr-ui/src/App.hostedCompletion.test.tsx index 191c8b078..32bc79ce0 100644 --- a/propr-ui/src/App.hostedCompletion.test.tsx +++ b/propr-ui/src/App.hostedCompletion.test.tsx @@ -3,6 +3,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; import App from './App'; const runtimeConfigMock = vi.hoisted(() => ({ + getRuntimeApiBaseUrlState: vi.fn(() => ({ apiBaseUrl: '', issue: null })), hostedUiConnectionIssue: vi.fn(), isHostedOAuthCompletionRoute: vi.fn(), })); @@ -23,6 +24,7 @@ const ioMock = vi.hoisted(() => vi.fn(() => ({ vi.mock('./config/runtimeConfig', () => ({ getApiBaseUrl: vi.fn(() => ''), + getRuntimeApiBaseUrlState: runtimeConfigMock.getRuntimeApiBaseUrlState, hostedUiConnectionIssue: runtimeConfigMock.hostedUiConnectionIssue, isHostedOAuthCompletionRoute: runtimeConfigMock.isHostedOAuthCompletionRoute, isHostedUiOrigin: vi.fn(() => true), @@ -53,6 +55,7 @@ describe('hosted OAuth completion route', () => { pathname === '/login' && new URLSearchParams(search).get('oauth_complete') === 'true' ); runtimeConfigMock.hostedUiConnectionIssue.mockReturnValue({ + code: 'HOSTED_STACK_REQUIRED', title: 'Connect a ProPR stack', message: 'This hosted UI needs a selected local stack before it can make API calls.', }); diff --git a/propr-ui/src/App.invalidConfiguration.test.tsx b/propr-ui/src/App.invalidConfiguration.test.tsx new file mode 100644 index 000000000..914c95c5c --- /dev/null +++ b/propr-ui/src/App.invalidConfiguration.test.tsx @@ -0,0 +1,50 @@ +import { cleanup, render, screen } from '@testing-library/react'; +import { afterEach, describe, expect, it, vi } from 'vitest'; + +const sentinels = [ + 'https://user:password-sentinel@t-invalid.propr.dev', + 'https://t-invalid.propr.dev?token=query-token-sentinel', + `https://example.test/${'private-path-sentinel'.repeat(200)}`, + 'this is not a URL malformed-url-sentinel', +]; + +describe('invalid eager API configuration', () => { + afterEach(() => { + cleanup(); + delete window.__PROPR_CONFIG__; + vi.restoreAllMocks(); + vi.resetModules(); + }); + + it.each(sentinels)('renders a bounded safe connection screen without leaking configured input', async configured => { + vi.resetModules(); + const warn = vi.spyOn(console, 'warn').mockImplementation(() => undefined); + const error = vi.spyOn(console, 'error').mockImplementation(() => undefined); + window.__PROPR_CONFIG__ = { apiBaseUrl: configured }; + + const runtimeConfig = await import('./config/runtimeConfig'); + console.warn(runtimeConfig.runtimeConfigWarning('app.propr.dev', window.__PROPR_CONFIG__)); + const apiClient = await import('./api/apiClient'); + expect(apiClient.proprClient).toBeNull(); + let thrown: unknown; + try { apiClient.getProprClient(); } catch (error) { thrown = error; } + expect(thrown).toBeInstanceOf(Error); + expect((thrown as Error).message).toBe('The ProPR connection configuration is invalid.'); + + const { default: App } = await import('./App'); + render(); + + expect(screen.getByRole('heading', { name: 'Invalid ProPR configuration' })).toBeInTheDocument(); + const visible = document.body.textContent || ''; + const diagnostics = JSON.stringify([ + ...warn.mock.calls, + ...error.mock.calls, + thrown, + ]); + for (const secret of ['password-sentinel', 'query-token-sentinel', 'private-path-sentinel', 'malformed-url-sentinel']) { + expect(visible).not.toContain(secret); + expect(diagnostics).not.toContain(secret); + } + expect(visible.length).toBeLessThan(1000); + }); +}); diff --git a/propr-ui/src/App.tsx b/propr-ui/src/App.tsx index dd427691d..5f64329be 100644 --- a/propr-ui/src/App.tsx +++ b/propr-ui/src/App.tsx @@ -11,6 +11,7 @@ import { getCurrentUser, INSTANCE_AUTHORIZATION_CHANGED_EVENT } from './api/prop import { checkProprApiCompatibility, ProprCompatibilityCheckError } from './api/compatibility' import { hostedUiConnectionIssue, + getRuntimeApiBaseUrlState, isHostedOAuthCompletionRoute, isHostedUiOrigin, pathWithActiveHostedTunnelFlow, @@ -41,8 +42,7 @@ const SettingsPage = lazy(() => import('./pages/SettingsPage')) const SummaryBrowserPage = lazy(() => import('./pages/SummaryBrowserPage')) const TasksPage = lazy(() => import('./pages/TasksPage')) -type CompatibilityState = { status: 'checking' } | { status: 'ready' } - | { status: 'blocked'; title: string; message: string }; +type CompatibilityState = { status: 'checking' } | { status: 'ready' } | { status: 'blocked'; title: string; message: string }; const AUTHORIZATION_REFRESH_INTERVAL_MS = 60_000; @@ -378,7 +378,7 @@ const WebApp: React.FC = () => { ); const connectionIssue = isHostedOAuthCompletion ? null - : hostedUiConnectionIssue( + : getRuntimeApiBaseUrlState().issue ?? hostedUiConnectionIssue( window.location.hostname, window.__PROPR_CONFIG__, window.location.search @@ -386,7 +386,6 @@ const WebApp: React.FC = () => { const [compatibility, setCompatibility] = useState( isHosted && !isHostedOAuthCompletion && !connectionIssue ? { status: 'checking' } : { status: 'ready' } ); - useEffect(() => { if (!isHosted || isHostedOAuthCompletion || connectionIssue) return; let cancelled = false; diff --git a/propr-ui/src/api/apiClient.ts b/propr-ui/src/api/apiClient.ts index 32cf33f2f..b12397f58 100644 --- a/propr-ui/src/api/apiClient.ts +++ b/propr-ui/src/api/apiClient.ts @@ -1,24 +1,84 @@ -import { DEMO_MODE_READ_ONLY_CODE } from '@propr/shared'; -import { ProprClient } from '@propr/client'; -import { getApiBaseUrl, pathWithActiveHostedTunnelFlow } from '../config/runtimeConfig'; -import { currentUiPathname, navigateToUiPath } from '../config/runtimeMode'; +import { DEMO_MODE_READ_ONLY_CODE, DESKTOP_TRANSPORT_SCOPE_HEADER } from '@propr/shared'; +import { normalizeApiBaseUrl, ProprClient, ProprClientError } from '@propr/client'; +import type { DesktopBridge } from '../../../apps/desktop/src/shared/contract'; +import { getRuntimeApiBaseUrlState, pathWithActiveHostedTunnelFlow } from '../config/runtimeConfig'; +import { currentUiPathname, isDesktopRuntime, navigateToUiPath } from '../config/runtimeMode'; +import { DESKTOP_ACCESS_INVALID_EVENT } from '../desktop/types'; + +export interface DesktopConnectionScope { + bridge: DesktopBridge; + profileId: string; + transportScope: string; +} + +let desktopConnectionScope: DesktopConnectionScope | null = null; +const desktopScopeListeners = new Set<() => void>(); +const responseScopes = new WeakMap(); +const DEFINITIVE_INSTANCE_TOKEN_CODES = new Set([ + 'INVALID_INSTANCE_TOKEN', + 'INSTANCE_TOKEN_EXPIRED', + 'INSTANCE_TOKEN_REVOKED', +]); +const AUTHORIZATION_CHANGE_CODES = new Set([ + 'AUTHORIZATION_CHANGED', + 'USER_NOT_WHITELISTED', + 'INSUFFICIENT_INSTANCE_PERMISSION', +]); const createProprClient = (baseUrl: string): ProprClient => new ProprClient({ baseUrl, - // Domain modules already opt into cookies route-by-route. Preserve their - // exact RequestInit behavior while sharing the session transport policy. - authentication: { type: 'session', applyByDefault: false }, + authentication: isDesktopRuntime() + ? { type: 'none' } + : { type: 'session', applyByDefault: false }, }); -export let API_BASE_URL = getApiBaseUrl(); -export let proprClient = createProprClient(API_BASE_URL); +const initialApiConfiguration = getRuntimeApiBaseUrlState(); + +export let API_BASE_URL = initialApiConfiguration.apiBaseUrl; +// This live binding is null only while hosted runtime configuration is blocked; +// callers that can run in that state must use getProprClient(). Packaged desktop +// transport is initialized only after a valid activation and can use the binding. +export let proprClient: ProprClient = initialApiConfiguration.issue + ? null as never + : createProprClient(API_BASE_URL); + +export const getProprClient = (): ProprClient => { + if (proprClient) return proprClient; + throw new ProprClientError('The ProPR connection configuration is invalid.', { + kind: 'configuration', + code: 'INVALID_RUNTIME_CONFIGURATION', + }); +}; /** Update the live bindings used by existing API modules when desktop profiles switch. */ export const setApiBaseUrl = (value: string): void => { - const nextApiBaseUrl = value.trim().replace(/\/+$/, ''); + const nextApiBaseUrl = normalizeApiBaseUrl(value); const nextProprClient = createProprClient(nextApiBaseUrl); API_BASE_URL = nextApiBaseUrl; proprClient = nextProprClient; + desktopScopeListeners.forEach(listener => listener()); +}; + +export const setDesktopConnectionScope = ( + scope: DesktopConnectionScope | null, + apiBaseUrl?: string, +): void => { + const nextApiBaseUrl = apiBaseUrl === undefined ? API_BASE_URL : normalizeApiBaseUrl(apiBaseUrl); + const nextProprClient = createProprClient(nextApiBaseUrl); + API_BASE_URL = nextApiBaseUrl; + desktopConnectionScope = scope; + proprClient = nextProprClient; + desktopScopeListeners.forEach(listener => listener()); +}; + +export const getDesktopConnectionScope = (): DesktopConnectionScope | null => desktopConnectionScope; +export const subscribeDesktopConnectionScope = (listener: () => void): (() => void) => { + desktopScopeListeners.add(listener); + return () => desktopScopeListeners.delete(listener); +}; +export const getDesktopSocketConfigurationKey = (): string => { + const scope = desktopConnectionScope; + return `${isDesktopRuntime() ? 'desktop' : 'browser'}\u0000${API_BASE_URL}\u0000${scope?.profileId ?? ''}\u0000${scope?.transportScope ?? ''}`; }; export const INSTANCE_AUTHORIZATION_CHANGED_EVENT = 'propr:instance-authorization-changed'; const TOKEN_REFRESHED_CODE = 'TOKEN_REFRESHED'; @@ -112,10 +172,57 @@ const parseApiErrorBody = async (response: Response): Promise data?.message || data?.error; -const throwUnauthorizedResponse = (data: ApiErrorBody | null): never => { +const isCurrentDesktopScope = (scope: DesktopConnectionScope | null): boolean => { + if (!scope) return !isDesktopRuntime(); + return desktopConnectionScope?.profileId === scope.profileId + && desktopConnectionScope.transportScope === scope.transportScope; +}; + +const scopeForResponse = (response: Response): DesktopConnectionScope | null => + responseScopes.has(response) ? responseScopes.get(response) ?? null : desktopConnectionScope; + +export const handleDesktopAccessCode = async ( + code: string | undefined, + scope: DesktopConnectionScope | null, +): Promise<'invalidated' | 'authorization-changed' | 'retryable'> => { + if (!code) return 'retryable'; + if (AUTHORIZATION_CHANGE_CODES.has(code)) { + if (!isCurrentDesktopScope(scope)) return 'retryable'; + window.dispatchEvent(new Event(INSTANCE_AUTHORIZATION_CHANGED_EVENT)); + return 'authorization-changed'; + } + if (!scope) return 'retryable'; + if (DEFINITIVE_INSTANCE_TOKEN_CODES.has(code)) { + const result = await scope.bridge.connection.invalidate({ + profileId: scope.profileId, + transportScope: scope.transportScope, + code, + }); + if (result.invalidated && isCurrentDesktopScope(scope)) { + window.dispatchEvent(new CustomEvent(DESKTOP_ACCESS_INVALID_EVENT, { + detail: { + profileId: scope.profileId, + transportScope: scope.transportScope, + code, + }, + })); + return 'invalidated'; + } + return 'retryable'; + } + return 'retryable'; +}; + +const throwUnauthorizedResponse = async (data: ApiErrorBody | null, response: Response): Promise => { if (data?.code === TOKEN_REFRESHED_CODE) { throw new TokenRefreshRetryRequiredError(getApiErrorMessage(data)); } + if (isDesktopRuntime()) { + await handleDesktopAccessCode(data?.code, scopeForResponse(response)); + throw new Error(data?.code === 'INVALID_INSTANCE_TOKEN' + ? 'This desktop connection was revoked or expired.' + : 'Desktop authentication is required.'); + } if (currentUiPathname() === '/login') throw new Error('Authentication required'); // Preserve only the validated active flow so login/OAuth cannot be driven by // arbitrary raw URL input or copied sessionStorage. @@ -143,14 +250,36 @@ const isReplayableApiRequest = ( && (init?.body == null || typeof init.body === 'string'); }; +const scopedRequestInit = ( + input: RequestInfo | URL, + init: RequestInit | undefined, + scope: DesktopConnectionScope | null, +): RequestInit | undefined => { + if (!scope) return init; + const headers = new Headers(typeof Request !== 'undefined' && input instanceof Request + ? input.headers + : undefined); + new Headers(init?.headers).forEach((value, name) => headers.set(name, value)); + headers.set(DESKTOP_TRANSPORT_SCOPE_HEADER, scope.transportScope); + return { ...init, headers }; +}; + export const apiFetch = async ( input: RequestInfo | URL, init?: RequestInit, options: ApiFetchOptions = {} ): Promise => { - const response = await proprClient.fetch(input, init); - if (isReplayableApiRequest(input, init, options) && await shouldRetryAfterTokenRefresh(response)) { - return proprClient.fetch(input, init); + const requestScope = desktopConnectionScope; + const requestClient = getProprClient(); + const requestInit = scopedRequestInit(input, init, requestScope); + const response = await requestClient.fetch(input, requestInit); + responseScopes.set(response, requestScope); + if (isReplayableApiRequest(input, init, options) + && await shouldRetryAfterTokenRefresh(response) + && isCurrentDesktopScope(requestScope)) { + const retried = await requestClient.fetch(input, requestInit); + responseScopes.set(retried, requestScope); + return retried; } return response; }; @@ -159,14 +288,14 @@ export const handleApiResponse = async (response: Response): Promise = if (response.ok) return response; const data = await parseApiErrorBody(response); - if (response.status === 401) throwUnauthorizedResponse(data); + if (response.status === 401) return await throwUnauthorizedResponse(data, response); const errorMessage = getApiErrorMessage(data); if (data?.code === DEMO_MODE_READ_ONLY_CODE) { throw new DemoModeReadOnlyError(errorMessage); } if (data?.code === 'INSUFFICIENT_INSTANCE_PERMISSION') { - window.dispatchEvent(new Event(INSTANCE_AUTHORIZATION_CHANGED_EVENT)); + await handleDesktopAccessCode(data.code, scopeForResponse(response)); } if (data?.committed === true) { throw new CommittedConfigWriteError(response.status, { diff --git a/propr-ui/src/api/compatibility.ts b/propr-ui/src/api/compatibility.ts index c71931fa7..d3c332eec 100644 --- a/propr-ui/src/api/compatibility.ts +++ b/propr-ui/src/api/compatibility.ts @@ -2,7 +2,7 @@ import { type ProprApiCompatibilityResult, } from '@propr/shared'; import { isProprClientError } from '@propr/client'; -import { proprClient } from './apiClient'; +import { getProprClient } from './apiClient'; // Bound the pre-render compatibility probe so a slow/unreachable API can't trap // the user on a spinner waiting out the browser's default fetch timeout. On @@ -19,7 +19,7 @@ export class ProprCompatibilityCheckError extends Error { export async function checkProprApiCompatibility(): Promise { try { - return await proprClient.negotiateCompatibility({ + return await getProprClient().negotiateCompatibility({ timeoutMs: COMPATIBILITY_CHECK_TIMEOUT_MS, }); } catch (error) { diff --git a/propr-ui/src/api/demoMode.test.ts b/propr-ui/src/api/demoMode.test.ts index ceca3043b..316a2ec0c 100644 --- a/propr-ui/src/api/demoMode.test.ts +++ b/propr-ui/src/api/demoMode.test.ts @@ -1,19 +1,35 @@ import { afterEach, describe, expect, it, vi } from 'vitest'; -import { DEMO_MODE_READ_ONLY_CODE } from '@propr/shared'; +import { DEMO_MODE_READ_ONLY_CODE, PROPR_API_ORIGIN_PARITY_CASES } from '@propr/shared'; import { apiFetch, CommittedConfigWriteError, getDemoModeStatus, handleApiResponse, + handleDesktopAccessCode, INSTANCE_AUTHORIZATION_CHANGED_EVENT, + API_BASE_URL, + setApiBaseUrl, + setDesktopConnectionScope, TokenRefreshRetryRequiredError, } from './proprApi'; describe('demo mode API helpers', () => { afterEach(() => { + setDesktopConnectionScope(null); + setApiBaseUrl(''); vi.restoreAllMocks(); }); + it('applies the shared canonical origin parity table to REST and Socket.IO client configuration', () => { + for (const [name, input, expected] of PROPR_API_ORIGIN_PARITY_CASES) { + if (expected === null) expect(() => setApiBaseUrl(input), name).toThrow(); + else { + setApiBaseUrl(input); + expect(API_BASE_URL, name).toBe(expected); + } + } + }); + it('discovers demo mode from the backend metadata endpoint', async () => { const fetchMock = vi.spyOn(globalThis, 'fetch').mockResolvedValue( new Response(JSON.stringify({ demoMode: true }), { @@ -95,6 +111,42 @@ describe('demo mode API helpers', () => { expect(fetchMock).toHaveBeenCalledTimes(2); }); + it('does not replay profile A work with profile B after a same-origin scope switch', async () => { + let parsingStarted!: () => void; + let releaseParsing!: () => void; + const started = new Promise(resolve => { parsingStarted = resolve; }); + const released = new Promise(resolve => { releaseParsing = resolve; }); + const refreshed = new Response(JSON.stringify({ code: 'TOKEN_REFRESHED' }), { + status: 401, + headers: { 'Content-Type': 'application/json' }, + }); + vi.spyOn(refreshed, 'clone').mockReturnValue({ + json: async () => { + parsingStarted(); + await released; + return { code: 'TOKEN_REFRESHED' }; + }, + } as Response); + const fetchMock = vi.spyOn(globalThis, 'fetch').mockResolvedValue(refreshed); + setDesktopConnectionScope({ + bridge: {} as never, + profileId: 'profile-a', + transportScope: 'AAAAAAAAAAAAAAAAAAAAAA', + }); + + const pending = apiFetch('/api/tasks'); + await started; + setDesktopConnectionScope({ + bridge: {} as never, + profileId: 'profile-b', + transportScope: 'BBBBBBBBBBBBBBBBBBBBBB', + }); + releaseParsing(); + + await expect(pending).resolves.toBe(refreshed); + expect(fetchMock).toHaveBeenCalledOnce(); + }); + it('surfaces an unreplayed token refresh as retry-required without logging out', async () => { const response = new Response(JSON.stringify({ code: 'TOKEN_REFRESHED', @@ -133,6 +185,39 @@ describe('demo mode API helpers', () => { expect(fetchMock).toHaveBeenNthCalledWith(2, request, undefined); }); + it('preserves Request and init headers plus the captured scope on retry', async () => { + const fetchMock = vi.spyOn(globalThis, 'fetch') + .mockResolvedValueOnce(new Response(JSON.stringify({ code: 'TOKEN_REFRESHED' }), { + status: 401, + headers: { 'Content-Type': 'application/json' }, + })) + .mockResolvedValueOnce(new Response('{}', { status: 200 })); + setDesktopConnectionScope({ + bridge: {} as never, + profileId: 'profile-a', + transportScope: 'SSSSSSSSSSSSSSSSSSSSSS', + }); + const request = new Request(new URL('/api/tasks', window.location.origin), { + headers: { 'X-From-Request': 'request', Authorization: 'Bearer renderer' }, + }); + + await apiFetch(request, { + credentials: 'include', + headers: { 'X-From-Init': 'init', Cookie: 'renderer=session' }, + }); + + expect(fetchMock).toHaveBeenCalledTimes(2); + for (const [input, init] of fetchMock.mock.calls) { + expect(input).toBe(request); + const headers = new Headers(init?.headers); + expect(headers.get('X-From-Request')).toBe('request'); + expect(headers.get('X-From-Init')).toBe('init'); + expect(headers.get('X-ProPR-Desktop-Transport-Scope')).toBe('SSSSSSSSSSSSSSSSSSSSSS'); + expect(headers.get('Authorization')).toBe('Bearer renderer'); + expect(headers.get('Cookie')).toBe('renderer=session'); + } + }); + it('does not retry GitHub re-authentication failures', async () => { const fetchMock = vi.spyOn(globalThis, 'fetch').mockResolvedValue(new Response(JSON.stringify({ code: 'GITHUB_REAUTH_REQUIRED', @@ -181,6 +266,57 @@ describe('demo mode API helpers', () => { window.removeEventListener(INSTANCE_AUTHORIZATION_CHANGED_EVENT, listener); }); + it('does not dispatch a stale authorization change after the desktop profile generation switches', async () => { + const listener = vi.fn(); + const scopeA = { + bridge: { connection: { invalidate: vi.fn() } } as never, + profileId: 'profile-a', + transportScope: 'DDDDDDDDDDDDDDDDDDDDDD', + }; + const scopeB = { + bridge: { connection: { invalidate: vi.fn() } } as never, + profileId: 'profile-b', + transportScope: 'EEEEEEEEEEEEEEEEEEEEEE', + }; + setDesktopConnectionScope(scopeA); + window.addEventListener(INSTANCE_AUTHORIZATION_CHANGED_EVENT, listener); + const response = new Response(JSON.stringify({ + code: 'INSUFFICIENT_INSTANCE_PERMISSION', + message: 'Forbidden', + }), { + status: 403, + headers: { 'Content-Type': 'application/json' }, + }); + const fetchMock = vi.spyOn(globalThis, 'fetch').mockResolvedValue(response); + + const scopedResponse = await apiFetch('/api/tasks'); + setDesktopConnectionScope(scopeB); + await expect(handleApiResponse(scopedResponse)).rejects.toThrow('Forbidden'); + + expect(fetchMock).toHaveBeenCalledOnce(); + expect(listener).not.toHaveBeenCalled(); + window.removeEventListener(INSTANCE_AUTHORIZATION_CHANGED_EVENT, listener); + }); + + it('preserves desktop credentials for authorization changes and transient authentication failures', async () => { + const invalidate = vi.fn(async () => ({ invalidated: false })); + const scope = { + bridge: { connection: { invalidate } } as never, + profileId: 'profile-a', + transportScope: 'IIIIIIIIIIIIIIIIIIIIII', + }; + const listener = vi.fn(); + window.addEventListener(INSTANCE_AUTHORIZATION_CHANGED_EVENT, listener); + setDesktopConnectionScope(scope); + + await expect(handleDesktopAccessCode('AUTHORIZATION_CHANGED', scope)).resolves.toBe('authorization-changed'); + await expect(handleDesktopAccessCode('AUTHENTICATION_FAILED', scope)).resolves.toBe('retryable'); + + expect(listener).toHaveBeenCalledOnce(); + expect(invalidate).not.toHaveBeenCalled(); + window.removeEventListener(INSTANCE_AUTHORIZATION_CHANGED_EVENT, listener); + }); + it.each([ { status: 409, lockLostAfterCommit: true }, { status: 500, lockLostAfterCommit: false }, diff --git a/propr-ui/src/components/Layout.tsx b/propr-ui/src/components/Layout.tsx index 52e52ddf1..b419c804f 100644 --- a/propr-ui/src/components/Layout.tsx +++ b/propr-ui/src/components/Layout.tsx @@ -169,7 +169,7 @@ const Layout: React.FC = ({ children }) => { return (
- {desktop && } + {desktop && }
{/* Mobile Overlay */} {isSidebarOpen && ( diff --git a/propr-ui/src/components/TaskPlanner/AttachmentUploader.test.tsx b/propr-ui/src/components/TaskPlanner/AttachmentUploader.test.tsx new file mode 100644 index 000000000..32ffa75e4 --- /dev/null +++ b/propr-ui/src/components/TaskPlanner/AttachmentUploader.test.tsx @@ -0,0 +1,85 @@ +import { act, cleanup, render, screen, waitFor } from '@testing-library/react'; +import { afterEach, describe, expect, it, vi } from 'vitest'; +import { setDesktopConnectionScope } from '../../api/apiClient'; +import { AttachmentUploader } from './AttachmentUploader'; + +vi.mock('../../config/runtimeMode', async importOriginal => ({ + ...await importOriginal(), + isDesktopRuntime: () => true, +})); + +describe('AttachmentUploader previews', () => { + afterEach(() => { + cleanup(); + setDesktopConnectionScope(null); + vi.restoreAllMocks(); + }); + + it('clears and reloads a text preview when the desktop scope changes', async () => { + let fetchCalls = 0; + let resolveSecondFetch!: (response: Response) => void; + vi.spyOn(globalThis, 'fetch').mockImplementation(() => { + fetchCalls += 1; + if (fetchCalls === 1) return Promise.resolve(new Response('profile A preview', { status: 200 })); + return new Promise(resolve => { resolveSecondFetch = resolve; }); + }); + setDesktopConnectionScope({ + bridge: {} as never, + profileId: 'profile-a', + transportScope: 'AAAAAAAAAAAAAAAAAAAAAA', + }); + render( undefined} + onRemove={async () => undefined} + />); + + const filename = screen.getByText('notes.txt'); + await waitFor(() => expect(filename).toHaveAttribute('title', 'profile A preview')); + + await act(async () => { + setDesktopConnectionScope({ + bridge: {} as never, + profileId: 'profile-b', + transportScope: 'BBBBBBBBBBBBBBBBBBBBBB', + }); + }); + + await waitFor(() => expect(fetchCalls).toBe(2)); + expect(filename).toHaveAttribute('title', 'Loading preview…'); + await act(async () => { resolveSecondFetch(new Response('profile B preview', { status: 200 })); }); + await waitFor(() => expect(filename).toHaveAttribute('title', 'profile B preview')); + }); + + it('invalidates a revoked desktop credential and uses the preview error fallback', async () => { + const invalidate = vi.fn(async () => ({ invalidated: true })); + vi.spyOn(globalThis, 'fetch').mockResolvedValue(new Response(JSON.stringify({ + code: 'INSTANCE_TOKEN_REVOKED', + }), { + status: 401, + headers: { 'Content-Type': 'application/json' }, + })); + setDesktopConnectionScope({ + bridge: { connection: { invalidate } } as never, + profileId: 'profile-a', + transportScope: 'AAAAAAAAAAAAAAAAAAAAAA', + }); + + render( undefined} + onRemove={async () => undefined} + />); + + await waitFor(() => expect(invalidate).toHaveBeenCalledWith({ + profileId: 'profile-a', + transportScope: 'AAAAAAAAAAAAAAAAAAAAAA', + code: 'INSTANCE_TOKEN_REVOKED', + })); + await waitFor(() => expect(screen.getByText('notes.txt')).toHaveAttribute('title', 'Unable to load preview')); + }); +}); diff --git a/propr-ui/src/components/TaskPlanner/AttachmentUploader.tsx b/propr-ui/src/components/TaskPlanner/AttachmentUploader.tsx index dbd24c745..e0b124b29 100644 --- a/propr-ui/src/components/TaskPlanner/AttachmentUploader.tsx +++ b/propr-ui/src/components/TaskPlanner/AttachmentUploader.tsx @@ -1,7 +1,14 @@ -import React, { useRef, useState, useEffect } from 'react'; +import React, { useRef, useState, useEffect, useSyncExternalStore } from 'react'; import { PlannerAttachment, getAttachmentUrl } from '../../api/proprApi'; import { X, FileText, Loader2, Paperclip } from 'lucide-react'; import { resizeImage } from './imageUtils'; +import { + apiFetch, + getDesktopConnectionScope, + handleApiResponse, + subscribeDesktopConnectionScope, +} from '../../api/apiClient'; +import { AuthenticatedAttachmentImage } from './AuthenticatedAttachmentImage'; interface AttachmentPreviewProps { file: PlannerAttachment; @@ -12,38 +19,56 @@ interface AttachmentPreviewProps { const AttachmentPreview: React.FC = ({ file, draftId, onRemove }) => { const [textPreview, setTextPreview] = useState(null); const [isLoadingPreview, setIsLoadingPreview] = useState(false); + const desktopScopeKey = useSyncExternalStore( + subscribeDesktopConnectionScope, + () => { + const scope = getDesktopConnectionScope(); + return `${scope?.profileId ?? ''}\u0000${scope?.transportScope ?? ''}`; + }, + () => '', + ); const isImage = file.type === 'image' || file.mimeType?.startsWith('image/') || /\.(jpg|jpeg|png|gif|webp|bmp)$/i.test(file.originalName); useEffect(() => { - if (!isImage && !textPreview && !isLoadingPreview) { - setIsLoadingPreview(true); - fetch(getAttachmentUrl(draftId, file.id), { credentials: 'include' }) - .then(res => res.text()) - .then(text => { - const preview = text.length > 100 ? text.slice(0, 100) + '...' : text; - setTextPreview(preview); - }) - .catch(() => setTextPreview('Unable to load preview')) - .finally(() => setIsLoadingPreview(false)); - } - }, [file.id, draftId, isImage, textPreview, isLoadingPreview]); + if (isImage) return; + const controller = new AbortController(); + setTextPreview(null); + setIsLoadingPreview(true); + void apiFetch(getAttachmentUrl(draftId, file.id), { credentials: 'include', signal: controller.signal }) + .then(handleApiResponse) + .then(res => res.text()) + .then(text => { + if (controller.signal.aborted) return; + const preview = text.length > 100 ? text.slice(0, 100) + '...' : text; + setTextPreview(preview); + }) + .catch(() => { if (!controller.signal.aborted) setTextPreview('Unable to load preview'); }) + .finally(() => { if (!controller.signal.aborted) setIsLoadingPreview(false); }); + return () => { + controller.abort(); + setTextPreview(null); + setIsLoadingPreview(false); + }; + }, [file.id, draftId, isImage, desktopScopeKey]); return (
{isImage ? (
- {file.originalName}
) : ( )} - + {file.originalName} {file.tokenEstimate}t diff --git a/propr-ui/src/components/TaskPlanner/AuthenticatedAttachmentImage.test.tsx b/propr-ui/src/components/TaskPlanner/AuthenticatedAttachmentImage.test.tsx new file mode 100644 index 000000000..f8bc4032e --- /dev/null +++ b/propr-ui/src/components/TaskPlanner/AuthenticatedAttachmentImage.test.tsx @@ -0,0 +1,89 @@ +import { act, cleanup, render, screen, waitFor } from '@testing-library/react'; +import { afterEach, describe, expect, it, vi } from 'vitest'; +import { setDesktopConnectionScope } from '../../api/apiClient'; +import { AuthenticatedAttachmentImage } from './AuthenticatedAttachmentImage'; + +describe('AuthenticatedAttachmentImage', () => { + afterEach(() => { + cleanup(); + setDesktopConnectionScope(null); + vi.restoreAllMocks(); + }); + + it('clears the previous image and fetches it again under the new scope', async () => { + let fetchCalls = 0; + let resolveSecondFetch!: (response: Response) => void; + vi.spyOn(globalThis, 'fetch').mockImplementation(() => { + fetchCalls += 1; + if (fetchCalls === 1) return Promise.resolve(new Response('image-a', { status: 200 })); + return new Promise(resolve => { resolveSecondFetch = resolve; }); + }); + const createObjectURL = vi.spyOn(URL, 'createObjectURL') + .mockReturnValueOnce('blob:attachment-a') + .mockReturnValueOnce('blob:attachment-b'); + const revokeObjectURL = vi.spyOn(URL, 'revokeObjectURL').mockImplementation(() => undefined); + setDesktopConnectionScope({ + bridge: {} as never, + profileId: 'profile-a', + transportScope: 'AAAAAAAAAAAAAAAAAAAAAA', + }); + const { unmount } = render(); + + expect(await screen.findByRole('img', { name: 'attachment' })).toHaveAttribute('src', 'blob:attachment-a'); + expect(createObjectURL).toHaveBeenCalledOnce(); + await act(async () => { + setDesktopConnectionScope({ + bridge: {} as never, + profileId: 'profile-b', + transportScope: 'BBBBBBBBBBBBBBBBBBBBBB', + }); + }); + + await waitFor(() => expect(fetchCalls).toBe(2)); + expect(screen.queryByRole('img', { name: 'attachment' })).not.toBeInTheDocument(); + expect(revokeObjectURL).toHaveBeenCalledExactlyOnceWith('blob:attachment-a'); + await act(async () => { resolveSecondFetch(new Response('image-b', { status: 200 })); }); + expect(await screen.findByRole('img', { name: 'attachment' })).toHaveAttribute('src', 'blob:attachment-b'); + unmount(); + expect(revokeObjectURL).toHaveBeenNthCalledWith(2, 'blob:attachment-b'); + expect(revokeObjectURL).toHaveBeenCalledTimes(2); + expect(createObjectURL).toHaveBeenCalledTimes(2); + }); + + it('aborts the old request on scope change and the replacement request on unmount', async () => { + const requestSignals: AbortSignal[] = []; + const resolveFetches: Array<(response: Response) => void> = []; + vi.spyOn(globalThis, 'fetch').mockImplementation((_input, init) => { + if (init?.signal) requestSignals.push(init.signal); + return new Promise(resolve => { resolveFetches.push(resolve); }); + }); + vi.spyOn(URL, 'createObjectURL').mockReturnValue('blob:late'); + const revokeObjectURL = vi.spyOn(URL, 'revokeObjectURL').mockImplementation(() => undefined); + setDesktopConnectionScope({ + bridge: {} as never, + profileId: 'profile-a', + transportScope: 'AAAAAAAAAAAAAAAAAAAAAA', + }); + const { unmount } = render(); + await waitFor(() => expect(requestSignals).toHaveLength(1)); + const requestSignal = requestSignals[0]; + if (!requestSignal) throw new Error('Expected attachment fetch to capture an AbortSignal'); + + await act(async () => { + setDesktopConnectionScope({ + bridge: {} as never, + profileId: 'profile-b', + transportScope: 'BBBBBBBBBBBBBBBBBBBBBB', + }); + }); + await waitFor(() => expect(requestSignals).toHaveLength(2)); + expect(requestSignal.aborted).toBe(true); + expect(requestSignals[1]?.aborted).toBe(false); + resolveFetches[0]?.(new Response('late', { status: 200 })); + await Promise.resolve(); + expect(screen.queryByRole('img', { name: 'attachment' })).not.toBeInTheDocument(); + unmount(); + expect(requestSignals[1]?.aborted).toBe(true); + expect(revokeObjectURL).not.toHaveBeenCalled(); + }); +}); diff --git a/propr-ui/src/components/TaskPlanner/AuthenticatedAttachmentImage.tsx b/propr-ui/src/components/TaskPlanner/AuthenticatedAttachmentImage.tsx new file mode 100644 index 000000000..bdd6653ce --- /dev/null +++ b/propr-ui/src/components/TaskPlanner/AuthenticatedAttachmentImage.tsx @@ -0,0 +1,56 @@ +import React, { useEffect, useState, useSyncExternalStore } from 'react'; +import { + apiFetch, + getDesktopConnectionScope, + handleApiResponse, + subscribeDesktopConnectionScope, +} from '../../api/apiClient'; + +interface AuthenticatedAttachmentImageProps extends Omit, 'src'> { + src: string; +} + +export const AuthenticatedAttachmentImage: React.FC = ({ src, ...props }) => { + const [objectUrl, setObjectUrl] = useState(null); + const desktopScopeKey = useSyncExternalStore( + subscribeDesktopConnectionScope, + () => { + const scope = getDesktopConnectionScope(); + return `${scope?.profileId ?? ''}\u0000${scope?.transportScope ?? ''}`; + }, + () => '', + ); + + useEffect(() => { + const controller = new AbortController(); + let disposed = false; + let loadedObjectUrl: string | null = null; + setObjectUrl(null); + const release = (): void => { + controller.abort(); + if (loadedObjectUrl) { + URL.revokeObjectURL(loadedObjectUrl); + loadedObjectUrl = null; + } + if (!disposed) setObjectUrl(null); + }; + void apiFetch(src, { credentials: 'include', signal: controller.signal }) + .then(handleApiResponse) + .then(response => response.blob()) + .then(blob => { + if (disposed || controller.signal.aborted) return; + loadedObjectUrl = URL.createObjectURL(blob); + setObjectUrl(loadedObjectUrl); + }) + .catch(() => { + if (!disposed && !controller.signal.aborted) setObjectUrl(null); + }); + + return () => { + release(); + disposed = true; + }; + }, [src, desktopScopeKey]); + + return objectUrl ? : null; +}; diff --git a/propr-ui/src/components/TaskPlanner/ComposerControls.tsx b/propr-ui/src/components/TaskPlanner/ComposerControls.tsx index 82a828054..0e83e4eac 100644 --- a/propr-ui/src/components/TaskPlanner/ComposerControls.tsx +++ b/propr-ui/src/components/TaskPlanner/ComposerControls.tsx @@ -1,6 +1,7 @@ import React from 'react'; import { X, FileText, Square, Layers, LayoutGrid } from 'lucide-react'; import { Granularity } from '../../api/proprApi'; +import { AuthenticatedAttachmentImage } from './AuthenticatedAttachmentImage'; // Helper to estimate issue count based on granularity // Single: always exactly 1 issue @@ -129,11 +130,10 @@ export const RemoteAttachmentChip: React.FC<{
{isImage && previewUrl ? (
- {name}
) : isImage ? ( diff --git a/propr-ui/src/components/TaskPlanner/PlanIssueRowComponents.tsx b/propr-ui/src/components/TaskPlanner/PlanIssueRowComponents.tsx index f8ce0923d..5693bf08d 100644 --- a/propr-ui/src/components/TaskPlanner/PlanIssueRowComponents.tsx +++ b/propr-ui/src/components/TaskPlanner/PlanIssueRowComponents.tsx @@ -10,6 +10,7 @@ import { ProviderLogo } from '../ui/ProviderLogo'; import AgentModelSelector from './AgentModelSelector'; import MarkdownRenderer from '../TaskDetails/MarkdownRenderer'; import { getModelName, getImplementButtonClassName, getImplementButtonTitle } from './planIssueRowUtils'; +import { AuthenticatedAttachmentImage } from './AuthenticatedAttachmentImage'; interface UltrafixSettingsControlsProps { enabled: boolean; goal: number | null | undefined; maxCycles: number | null | undefined; onGoalChange: (value: number | null) => void; onMaxCyclesChange: (value: number | null) => void; goalPlaceholder: string; maxPlaceholder: string; inputClassName: string; goalInputWidthClassName: string; maxInputWidthClassName: string; containerClassName?: string; errorClassName?: string; } @@ -311,7 +312,7 @@ export const ExpandedContent: React.FC = ({ task, draftId return (
- {isImage ?
{attachment.originalName}
: renderAttachmentIcon()} + {isImage ?
: renderAttachmentIcon()} {attachment.originalName} diff --git a/propr-ui/src/config/hostedTunnelConfig.ts b/propr-ui/src/config/hostedTunnelConfig.ts new file mode 100644 index 000000000..9a7df521d --- /dev/null +++ b/propr-ui/src/config/hostedTunnelConfig.ts @@ -0,0 +1,160 @@ +import { + DEFAULT_PROPR_UI_ORIGIN, + isCanonicalProprConnectHostname, + isProprProxyUrl, + MAX_PROPR_API_BASE_URL_LENGTH, +} from '@propr/shared'; + +export const HOSTED_TUNNEL_API_BASE_STORAGE_KEY = 'propr.hostedTunnelApiBaseUrl'; +export const HOSTED_TUNNEL_FLOW_ID_KEY = 'propr.hostedTunnelFlowId'; +export const HOSTED_TUNNEL_CONTEXT_ID_KEY = 'propr.hostedTunnelContextId'; + +const WINDOW_NAME_CONTEXT_PREFIX = 'propr-hosted-flow-context:'; +const WINDOW_NAME_CONTEXT_SEPARATOR = '|'; +const MAX_HOSTED_QUERY_LENGTH = 4096; +const MAX_HOSTED_FLOW_ID_LENGTH = 128; +const HOSTED_UI_HOSTNAME = new URL(DEFAULT_PROPR_UI_ORIGIN).hostname; + +export type HostedTunnelStorage = Pick; + +export const isHostedUiOrigin = (hostname: string): boolean => hostname === HOSTED_UI_HOSTNAME; + +export const hostedTunnelQueryApiBaseUrl = (hostname: string, search: string): string | null => { + if (!isHostedUiOrigin(hostname) || search.length > MAX_HOSTED_QUERY_LENGTH) return null; + const query = search.startsWith('?') ? search.slice(1) : search; + const rawValues = query.split('&').flatMap(parameter => { + const separator = parameter.indexOf('='); + const name = separator === -1 ? parameter : parameter.slice(0, separator); + return name === 'tunnel' ? [separator === -1 ? '' : parameter.slice(separator + 1)] : []; + }); + const decodedValues = new URLSearchParams(search).getAll('tunnel'); + if (rawValues.length !== 1 || decodedValues.length !== 1) return null; + + const rawComponent = rawValues[0]; + const value = decodedValues[0]; + if (!value || value.length > MAX_PROPR_API_BASE_URL_LENGTH || /[^\x21-\x7e]/.test(value)) return null; + if (rawComponent !== value) return null; + if (/^https:\/\//.test(value)) return isProprProxyUrl(value) ? value : null; + if (!isCanonicalProprConnectHostname(value)) return null; + return `https://${value}`; +}; + +export const hasHostedTunnelQueryParameter = (search: string): boolean => { + if (search.length > MAX_HOSTED_QUERY_LENGTH) return true; + return new URLSearchParams(search).has('tunnel'); +}; + +export const storageForWindow = (): HostedTunnelStorage | undefined => { + if (typeof window === 'undefined') return undefined; + try { return window.sessionStorage; } catch { return undefined; } +}; + +const generateFlowId = (): string => { + try { return crypto.randomUUID(); } catch { return Math.random().toString(36).slice(2) + Date.now().toString(36); } +}; + +const isValidHostedFlowToken = (value: string | null | undefined): value is string => + typeof value === 'string' && /^[A-Za-z0-9-]{1,128}$/.test(value); + +const contextIdFromWindowName = (name: string): string | null => { + if (!name.startsWith(WINDOW_NAME_CONTEXT_PREFIX)) return null; + const rest = name.slice(WINDOW_NAME_CONTEXT_PREFIX.length); + const separatorIndex = rest.indexOf(WINDOW_NAME_CONTEXT_SEPARATOR); + const contextId = separatorIndex === -1 ? rest : rest.slice(0, separatorIndex); + return isValidHostedFlowToken(contextId) ? contextId : null; +}; + +const currentHostedTunnelContextId = (): string | null => { + if (typeof window === 'undefined') return null; + try { return contextIdFromWindowName(window.name); } catch { return null; } +}; + +const setHostedTunnelContextId = (contextId: string): string | null => { + if (typeof window === 'undefined') return contextId; + try { + const existing = window.name || ''; + const separatorIndex = existing.indexOf(WINDOW_NAME_CONTEXT_SEPARATOR); + const preservedName = existing.startsWith(WINDOW_NAME_CONTEXT_PREFIX) + ? (separatorIndex === -1 ? '' : existing.slice(separatorIndex + 1)) + : existing; + window.name = `${WINDOW_NAME_CONTEXT_PREFIX}${contextId}${WINDOW_NAME_CONTEXT_SEPARATOR}${preservedName}`; + return contextId; + } catch { + return null; + } +}; + +const ensureHostedTunnelContextId = (): string | null => + currentHostedTunnelContextId() || setHostedTunnelContextId(generateFlowId()); + +export const flowIdFromSearch = (search: string): string | null => { + if (search.length > MAX_HOSTED_QUERY_LENGTH) return null; + const value = new URLSearchParams(search).get('flow'); + return isValidHostedFlowToken(value) ? value : null; +}; + +export const rememberHostedTunnelApiBaseUrl = ( + hostname: string, + apiBaseUrl: string, + storage: HostedTunnelStorage | undefined = storageForWindow(), + contextId: string | null = ensureHostedTunnelContextId(), +): string | null => { + if (!isHostedUiOrigin(hostname) || !storage || !contextId || !isValidHostedFlowToken(contextId)) return null; + if (apiBaseUrl.length > MAX_PROPR_API_BASE_URL_LENGTH || !isProprProxyUrl(apiBaseUrl)) return null; + try { + const flowId = generateFlowId(); + storage.setItem(HOSTED_TUNNEL_API_BASE_STORAGE_KEY, apiBaseUrl); + storage.setItem(HOSTED_TUNNEL_FLOW_ID_KEY, flowId); + storage.setItem(HOSTED_TUNNEL_CONTEXT_ID_KEY, contextId); + return flowId; + } catch { + return null; + } +}; + +interface StoredFlowBinding { + flowId: string; + contextId: string; +} + +const readStoredFlowBinding = (storage: HostedTunnelStorage): StoredFlowBinding | null => { + const flowId = storage.getItem(HOSTED_TUNNEL_FLOW_ID_KEY); + const contextId = storage.getItem(HOSTED_TUNNEL_CONTEXT_ID_KEY); + if ((flowId?.length ?? 0) > MAX_HOSTED_FLOW_ID_LENGTH) return null; + if ((contextId?.length ?? 0) > MAX_HOSTED_FLOW_ID_LENGTH) return null; + if (!isValidHostedFlowToken(flowId) || !isValidHostedFlowToken(contextId)) return null; + return { flowId, contextId }; +}; + +const currentContextMatches = (storedContextId: string, contextId: string | null | undefined): boolean => { + const currentContextId = contextId === undefined ? currentHostedTunnelContextId() : contextId; + return Boolean(currentContextId && currentContextId === storedContextId); +}; + +const readCanonicalStoredEndpoint = (storage: HostedTunnelStorage): string | null => { + const stored = storage.getItem(HOSTED_TUNNEL_API_BASE_STORAGE_KEY); + if ((stored?.length ?? 0) > MAX_PROPR_API_BASE_URL_LENGTH || stored !== stored?.trim()) { + storage.removeItem(HOSTED_TUNNEL_API_BASE_STORAGE_KEY); + return null; + } + if (stored && isProprProxyUrl(stored)) return stored; + if (stored) storage.removeItem(HOSTED_TUNNEL_API_BASE_STORAGE_KEY); + return null; +}; + +export const readStoredHostedTunnelApiBaseUrl = ( + hostname: string, + flowId: string | null, + storage: HostedTunnelStorage | undefined = storageForWindow(), + contextId?: string | null, +): string | null => { + if (!isHostedUiOrigin(hostname) || !storage) return null; + try { + const binding = readStoredFlowBinding(storage); + if (!binding || binding.flowId !== flowId) return null; + if (!currentContextMatches(binding.contextId, contextId)) return null; + return readCanonicalStoredEndpoint(storage); + } catch { + return null; + } +}; diff --git a/propr-ui/src/config/runtimeConfig.test.ts b/propr-ui/src/config/runtimeConfig.test.ts index 953724d02..ea7fd8415 100644 --- a/propr-ui/src/config/runtimeConfig.test.ts +++ b/propr-ui/src/config/runtimeConfig.test.ts @@ -114,16 +114,16 @@ describe('getApiBaseUrl', () => { expect(getApiBaseUrl()).toBe(''); }); - it('strips a trailing slash from the runtime value so paths do not double up', async () => { + it('rejects a trailing slash on a reserved Connect runtime value', async () => { window.__PROPR_CONFIG__ = { apiBaseUrl: 'https://t-abc123.propr.dev/' }; const getApiBaseUrl = await loadGetApiBaseUrl(); - expect(getApiBaseUrl()).toBe('https://t-abc123.propr.dev'); + expect(getApiBaseUrl()).toBe(''); }); - it('strips multiple trailing slashes', async () => { + it('rejects repeated trailing slashes on a reserved Connect runtime value', async () => { window.__PROPR_CONFIG__ = { apiBaseUrl: 'https://t-abc123.propr.dev///' }; const getApiBaseUrl = await loadGetApiBaseUrl(); - expect(getApiBaseUrl()).toBe('https://t-abc123.propr.dev'); + expect(getApiBaseUrl()).toBe(''); }); it('strips a trailing slash from the build-time env var', async () => { @@ -138,6 +138,45 @@ describe('getApiBaseUrl', () => { expect(getApiBaseUrl()).toBe('https://app.propr.dev'); }); + it('does not normalize noncanonical managed origins into hosted authority', async () => { + const { resolveApiBaseUrl } = await import('./runtimeConfig'); + for (const apiBaseUrl of [ + 'https://t-abc123.propr.dev/', + 'https://t-abc123.propr.dev//', + ' https://t-abc123.propr.dev', + 'https://T-AbC123.ProPR.dev', + 'http://t-abc123.propr.dev', + 'https://t-abc123.propr.dev:444', + 'https://user:password@t-abc123.propr.dev', + 'https://t-abc123.propr.dev/api', + 'https://extra.t-abc123.propr.dev', + 'https://t-é.propr.dev', + 'https://t-é.propr.dev:443', + 'https://t-é.propr.dev:444', + 'https://user:password@t-é.propr.dev/api', + 'https://t-é.nested.propr.dev', + ]) { + expect(resolveApiBaseUrl( + 'app.propr.dev', + '', + { apiBaseUrl }, + undefined, + )).toBe(''); + } + + for (const unrelated of [ + 'https://t-x.propr.dev.example.com', + 'https://nested.t-x.propr.dev.example.com', + ]) { + expect(resolveApiBaseUrl( + 'app.propr.dev', + '', + { apiBaseUrl: unrelated }, + undefined, + )).toBe(unrelated); + } + }); + it('returns empty on the hosted OAuth completion route with a tunnel without touching hosted session state', async () => { const hostedWindow = stubHostedWindow({ search: '?oauth_complete=true&tunnel=t-attacker.propr.dev', @@ -189,10 +228,16 @@ describe('getApiBaseUrl', () => { search: '?oauth_complete=true', }); - const { getActiveHostedTunnelFlowId, getApiBaseUrl, HOSTED_TUNNEL_API_BASE_STORAGE_KEY } = + const { + getActiveHostedTunnelFlowId, + getApiBaseUrl, + getRuntimeApiBaseUrlState, + HOSTED_TUNNEL_API_BASE_STORAGE_KEY, + } = await import('./runtimeConfig'); expect(getApiBaseUrl()).toBe(''); + expect(getRuntimeApiBaseUrlState()).toEqual({ apiBaseUrl: '', issue: null }); expectNoSessionStorageAccess(hostedWindow.sessionStorage); expect(hostedWindow.localStorage.getItem).not.toHaveBeenCalled(); expect(hostedWindow.localStorage.setItem).not.toHaveBeenCalled(); @@ -216,6 +261,37 @@ describe('getApiBaseUrl', () => { expect(hostedWindow.name).not.toBe('original-window-name'); expect(getActiveHostedTunnelFlowId()).toBeTruthy(); }); + + it('blocks API client construction when the hosted UI has no selected stack', async () => { + stubHostedWindow({ search: '', pathname: '/' }); + + const { getRuntimeApiBaseUrlState } = await import('./runtimeConfig'); + expect(getRuntimeApiBaseUrlState()).toMatchObject({ + apiBaseUrl: '', + issue: { code: 'HOSTED_STACK_REQUIRED' }, + }); + + const { getProprClient, proprClient } = await import('../api/apiClient'); + expect(proprClient).toBeNull(); + expect(() => getProprClient()).toThrow('The ProPR connection configuration is invalid.'); + }); + + it('blocks API client construction for a non-Connect hosted runtime URL', async () => { + stubHostedWindow({ + config: { apiBaseUrl: 'https://custom.example.com' }, + search: '', + pathname: '/', + }); + + const { getRuntimeApiBaseUrlState } = await import('./runtimeConfig'); + expect(getRuntimeApiBaseUrlState()).toMatchObject({ + apiBaseUrl: '', + issue: { code: 'INVALID_RUNTIME_CONFIGURATION' }, + }); + + const { proprClient } = await import('../api/apiClient'); + expect(proprClient).toBeNull(); + }); }); describe('hosted tunnel query API base', () => { @@ -225,6 +301,10 @@ describe('hosted tunnel query API base', () => { vi.resetModules(); }); + afterEach(() => { + vi.unstubAllGlobals(); + }); + it('accepts the Connect tunnel hostname on the hosted UI origin', async () => { const { hostedTunnelQueryApiBaseUrl } = await load(); expect( @@ -232,18 +312,91 @@ describe('hosted tunnel query API base', () => { ).toBe('https://t-abc123.propr.dev'); }); - it('accepts a full hosted proxy URL and strips trailing slashes', async () => { + it('accepts only a literal exact full hosted proxy URL', async () => { const { hostedTunnelQueryApiBaseUrl } = await load(); expect( - hostedTunnelQueryApiBaseUrl('app.propr.dev', '?tunnel=https%3A%2F%2Ft-abc123.propr.dev%2F%2F') + hostedTunnelQueryApiBaseUrl('app.propr.dev', '?tunnel=https://t-abc123.propr.dev') ).toBe('https://t-abc123.propr.dev'); + expect(hostedTunnelQueryApiBaseUrl( + 'app.propr.dev', + '?tunnel=https%3A%2F%2Ft-abc123.propr.dev', + )).toBeNull(); }); - it('accepts an instance id for manually built hosted UI links', async () => { + it('rejects a bare instance id because shorthand must include the complete canonical host', async () => { const { hostedTunnelQueryApiBaseUrl } = await load(); - expect(hostedTunnelQueryApiBaseUrl('app.propr.dev', '?tunnel=abc123')).toBe( - 'https://t-abc123.propr.dev' - ); + expect(hostedTunnelQueryApiBaseUrl('app.propr.dev', '?tunnel=abc123')).toBeNull(); + }); + + it('rejects every slash on scheme-less shorthand', async () => { + const { hostedTunnelQueryApiBaseUrl } = await load(); + expect(hostedTunnelQueryApiBaseUrl('app.propr.dev', '?tunnel=t-abc123.propr.dev%2F%2F')).toBeNull(); + expect(hostedTunnelQueryApiBaseUrl('app.propr.dev', '?tunnel=t-abc123.propr.dev//')).toBeNull(); + }); + + it('rejects exact noncanonical Connect shorthand reproductions without storing flow state', async () => { + const { hostedTunnelQueryApiBaseUrl, resolveApiBaseUrl } = await load(); + for (const search of [ + '?tunnel=user:secret@t-abc123.propr.dev', + '?tunnel=t-abc123.propr.dev:443', + '?tunnel=t-abc123.propr.dev:8443', + '?tunnel=t-%61bc123.propr.dev', + '?tunnel=t%2Dabc123.propr.dev', + '?%74unnel=t-abc123.propr.dev', + '?tunnel=T-abc123.propr.dev', + '?tunnel=t-abc123.propr.dev.', + '?tunnel=t-abc123.propr.dev.evil.example', + '?tunnel=t-abc123.foo.propr.dev', + '?tunnel=t-abc123.propr.dev%5Cpath', + '?tunnel=t-abc123.propr.dev%2Fpath', + '?tunnel=t-abc123.propr.dev%3Ftoken%3Dsecret', + '?tunnel=t-abc123.propr.dev%23fragment', + '?tunnel=%20t-abc123.propr.dev', + '?tunnel=t-%C3%A1bc123.propr.dev', + '?tunnel=xn--t-bca123.propr.dev', + ]) { + const storage = memoryStorage(); + expect(hostedTunnelQueryApiBaseUrl('app.propr.dev', search), search).toBeNull(); + expect(resolveApiBaseUrl('app.propr.dev', search, undefined, undefined, storage), search).toBe(''); + expect(storage.setItem, search).not.toHaveBeenCalled(); + } + }); + + it('does not let an encoded tunnel name fall through to valid runtime configuration', async () => { + stubHostedWindow({ + config: { apiBaseUrl: 'https://t-configured.propr.dev' }, + pathname: '/', + search: '?%74unnel=t-selected.propr.dev', + }); + const { getRuntimeApiBaseUrlState, hostedTunnelQueryApiBaseUrl } = await load(); + + expect(hostedTunnelQueryApiBaseUrl( + 'app.propr.dev', + '?%74unnel=t-selected.propr.dev', + )).toBeNull(); + expect(getRuntimeApiBaseUrlState()).toMatchObject({ + apiBaseUrl: '', + issue: { code: 'INVALID_RUNTIME_CONFIGURATION' }, + }); + }); + + it('does not let an encoded tunnel name fall through to a valid stored endpoint', async () => { + stubHostedWindow({ + name: 'propr-hosted-flow-context:stored-context|preserved', + pathname: '/', + search: '?%74unnel=t-selected.propr.dev&flow=stored-flow', + sessionInitial: { + 'propr.hostedTunnelApiBaseUrl': 'https://t-stored.propr.dev', + 'propr.hostedTunnelContextId': 'stored-context', + 'propr.hostedTunnelFlowId': 'stored-flow', + }, + }); + const { getRuntimeApiBaseUrlState } = await load(); + + expect(getRuntimeApiBaseUrlState()).toMatchObject({ + apiBaseUrl: '', + issue: { code: 'INVALID_RUNTIME_CONFIGURATION' }, + }); }); it('ignores tunnel query params off the hosted UI origin', async () => { @@ -262,6 +415,11 @@ describe('hosted tunnel query API base', () => { '?tunnel=t-abc123.propr.dev%2Fapi', '?tunnel=t-abc123.propr.dev%3Ffrom%3Dconnect', '?tunnel=t-abc123.propr.dev%23fragment', + '?tunnel=user%40t-abc123.propr.dev', + '?tunnel=t-abc123.propr.dev%3A443', + '?tunnel=t-%D0%B0bc.propr.dev', + '?tunnel=t-abc123%2Epropr.dev', + '?tunnel=%20t-abc123.propr.dev', '?tunnel=%2Fapi' ]) { expect(hostedTunnelQueryApiBaseUrl('app.propr.dev', bad)).toBeNull(); @@ -287,7 +445,7 @@ describe('stored hosted tunnel API base (flow-token-gated sessionStorage)', () = const flowId = rememberHostedTunnelApiBaseUrl( 'app.propr.dev', - 'https://t-abc123.propr.dev/', + 'https://t-abc123.propr.dev', storage, 'tab-context' ); @@ -310,7 +468,7 @@ describe('stored hosted tunnel API base (flow-token-gated sessionStorage)', () = readStoredHostedTunnelApiBaseUrl, } = await load(); const storage = memoryStorage({ - [HOSTED_TUNNEL_API_BASE_STORAGE_KEY]: 'https://t-abc123.propr.dev/', + [HOSTED_TUNNEL_API_BASE_STORAGE_KEY]: 'https://t-abc123.propr.dev', [HOSTED_TUNNEL_CONTEXT_ID_KEY]: 'test-context-id', [HOSTED_TUNNEL_FLOW_ID_KEY]: 'test-flow-id', }); @@ -709,7 +867,7 @@ describe('runtimeConfigWarning', () => { it('warns on the hosted UI origin when config.js did not load', async () => { const runtimeConfigWarning = await loadWarning(); - expect(runtimeConfigWarning('app.propr.dev', undefined)).toContain('config.js did not load'); + expect(runtimeConfigWarning('app.propr.dev', undefined)).toBe('[propr] HOSTED_STACK_REQUIRED'); }); it('does not warn about missing config when a valid Connect tunnel deep link is present', async () => { @@ -750,8 +908,8 @@ describe('runtimeConfigWarning', () => { it('warns on the hosted UI origin when apiBaseUrl is empty', async () => { const runtimeConfigWarning = await loadWarning(); - expect(runtimeConfigWarning('app.propr.dev', { apiBaseUrl: '' })).toContain('apiBaseUrl is empty'); - expect(runtimeConfigWarning('app.propr.dev', { apiBaseUrl: ' ' })).toContain('apiBaseUrl is empty'); + expect(runtimeConfigWarning('app.propr.dev', { apiBaseUrl: '' })).toBe('[propr] HOSTED_STACK_REQUIRED'); + expect(runtimeConfigWarning('app.propr.dev', { apiBaseUrl: ' ' })).toBe('[propr] INVALID_RUNTIME_CONFIGURATION'); }); it('does not warn when apiBaseUrl is configured', async () => { @@ -762,14 +920,14 @@ describe('runtimeConfigWarning', () => { it('warns on the hosted UI origin when apiBaseUrl is not a valid http(s) URL', async () => { const runtimeConfigWarning = await loadWarning(); for (const bad of ['t-abc123.propr.dev', '/api', 'ftp://t-abc123.propr.dev', 'not a url']) { - expect(runtimeConfigWarning('app.propr.dev', { apiBaseUrl: bad })).toContain('not a valid http(s) URL'); + expect(runtimeConfigWarning('app.propr.dev', { apiBaseUrl: bad })).toBe('[propr] INVALID_RUNTIME_CONFIGURATION'); } }); it('warns on the hosted UI origin when apiBaseUrl is a valid URL but not a ProPR proxy URL', async () => { const runtimeConfigWarning = await loadWarning(); for (const notProxy of ['https://custom.example.com', 'http://t-abc123.propr.dev', 'https://t-a.b.propr.dev']) { - expect(runtimeConfigWarning('app.propr.dev', { apiBaseUrl: notProxy })).toContain('not a hosted ProPR proxy URL'); + expect(runtimeConfigWarning('app.propr.dev', { apiBaseUrl: notProxy })).toBe('[propr] INVALID_RUNTIME_CONFIGURATION'); } }); @@ -838,11 +996,11 @@ describe('hosted UI connection issue', () => { it('blocks invalid hosted runtime API URLs', async () => { const hostedUiConnectionIssue = await loadIssue(); expect(hostedUiConnectionIssue('app.propr.dev', { apiBaseUrl: '/api' })?.title).toBe( - 'Invalid hosted UI configuration' + 'Invalid ProPR configuration' ); expect( hostedUiConnectionIssue('app.propr.dev', { apiBaseUrl: 'https://custom.example.com' })?.title - ).toBe('Invalid hosted UI tunnel'); + ).toBe('Invalid ProPR configuration'); }); it('does not block local or self-hosted origins', async () => { diff --git a/propr-ui/src/config/runtimeConfig.ts b/propr-ui/src/config/runtimeConfig.ts index da9985e9c..b89e82aa9 100644 --- a/propr-ui/src/config/runtimeConfig.ts +++ b/propr-ui/src/config/runtimeConfig.ts @@ -30,8 +30,35 @@ // - A new tab opened to app.propr.dev (no tunnel/flow in URL) never has URL // authority, even if sessionStorage was copied from an existing tab. -import { DEFAULT_PROPR_UI_ORIGIN, isProprProxyUrl, proprInstanceProxyUrl } from '@propr/shared'; +import { + canonicalProprProxyUrl, + DEFAULT_PROPR_UI_ORIGIN, + isProprProxyUrl, + MAX_PROPR_API_BASE_URL_LENGTH, + PROPR_UI_PROXY_LABEL_PREFIX, + PROPR_UI_PROXY_SUFFIX, +} from '@propr/shared'; import { normalizeApiBaseUrl } from '@propr/client'; +import { + flowIdFromSearch, + hasHostedTunnelQueryParameter, + HOSTED_TUNNEL_API_BASE_STORAGE_KEY, + hostedTunnelQueryApiBaseUrl, + isHostedUiOrigin, + readStoredHostedTunnelApiBaseUrl, + rememberHostedTunnelApiBaseUrl, + storageForWindow, + type HostedTunnelStorage, +} from './hostedTunnelConfig'; +export { + HOSTED_TUNNEL_API_BASE_STORAGE_KEY, + HOSTED_TUNNEL_CONTEXT_ID_KEY, + HOSTED_TUNNEL_FLOW_ID_KEY, + hostedTunnelQueryApiBaseUrl, + isHostedUiOrigin, + readStoredHostedTunnelApiBaseUrl, + rememberHostedTunnelApiBaseUrl, +} from './hostedTunnelConfig'; export interface ProprRuntimeConfig { /** Base URL for REST and Socket.IO. Empty string means same-origin. */ @@ -39,10 +66,16 @@ export interface ProprRuntimeConfig { } export interface HostedUiConnectionIssue { + code: 'HOSTED_STACK_REQUIRED' | 'INVALID_RUNTIME_CONFIGURATION'; title: string; message: string; } +export interface RuntimeApiBaseUrlState { + apiBaseUrl: string; + issue: HostedUiConnectionIssue | null; +} + declare global { interface Window { __PROPR_CONFIG__?: ProprRuntimeConfig; @@ -52,24 +85,17 @@ declare global { const runtimeConfig: ProprRuntimeConfig = (typeof window !== 'undefined' && window.__PROPR_CONFIG__) || {}; -export const HOSTED_TUNNEL_API_BASE_STORAGE_KEY = 'propr.hostedTunnelApiBaseUrl'; -/** Paired with HOSTED_TUNNEL_API_BASE_STORAGE_KEY; must match the URL ?flow= param to be trusted. */ -export const HOSTED_TUNNEL_FLOW_ID_KEY = 'propr.hostedTunnelFlowId'; -/** Paired with HOSTED_TUNNEL_FLOW_ID_KEY; must match this browsing context's window.name token. */ -export const HOSTED_TUNNEL_CONTEXT_ID_KEY = 'propr.hostedTunnelContextId'; +export const INVALID_RUNTIME_CONFIGURATION_CODE = 'INVALID_RUNTIME_CONFIGURATION'; -const WINDOW_NAME_CONTEXT_PREFIX = 'propr-hosted-flow-context:'; -const WINDOW_NAME_CONTEXT_SEPARATOR = '|'; +const invalidRuntimeConfigurationIssue = (): HostedUiConnectionIssue => ({ + code: INVALID_RUNTIME_CONFIGURATION_CODE, + title: 'Invalid ProPR configuration', + message: 'ProPR cannot use the configured connection. Re-enter or rediscover the instance, then try again.', +}); let activeHostedTunnelFlowId: string | null = null; let desktopApiBaseUrl: string | null = null; -/** - * Hostname of the managed hosted UI (e.g. `app.propr.dev`), derived from the - * shared origin constant so there is a single source of truth. - */ -const HOSTED_UI_HOSTNAME = new URL(DEFAULT_PROPR_UI_ORIGIN).hostname; - /** * Whether the page is being served from the managed hosted UI origin * (`app.propr.dev`) — the single static bundle that serves many per-instance @@ -79,9 +105,6 @@ const HOSTED_UI_HOSTNAME = new URL(DEFAULT_PROPR_UI_ORIGIN).hostname; * ships the UI and API together and is NOT a hosted-UI origin, so it is exempt * from both — only the actual hosted UI is gated. Exported for unit testing. */ -export const isHostedUiOrigin = (hostname: string): boolean => - hostname === HOSTED_UI_HOSTNAME; - export const isHostedOAuthCompletionRoute = ( hostname: string, pathname: string, @@ -98,174 +121,45 @@ export const isHostedOAuthCompletionRoute = ( * unit testing. */ export const isValidHttpUrl = (value: string): boolean => { + if (value.length > MAX_PROPR_API_BASE_URL_LENGTH) return false; try { - return normalizeApiBaseUrl(value, { allowInsecureHttp: true }) !== ''; + const url = new URL(value); + return url.protocol === 'http:' || url.protocol === 'https:'; } catch { return false; } }; -/** - * Resolve the Connect deep-link API base from `?tunnel=`. Connect opens the - * hosted UI as `https://app.propr.dev?tunnel=t-.propr.dev` after a - * tunnel passes health checks. Accept only hosted ProPR proxy targets and only - * on the managed hosted UI origin so arbitrary self-hosted pages cannot smuggle - * a cross-origin API base through the query string. - */ -export const hostedTunnelQueryApiBaseUrl = ( - hostname: string, - search: string -): string | null => { - if (!isHostedUiOrigin(hostname)) return null; - - const raw = new URLSearchParams(search).get('tunnel')?.trim(); - if (!raw) return null; - - if (isProprProxyUrl(raw)) return raw.replace(/\/+$/, ''); - - const instanceUrl = proprInstanceProxyUrl(raw); - if (instanceUrl) return instanceUrl; - - try { - const url = new URL(`https://${raw}`); - if (/[^/]/.test(url.pathname) || url.search || url.hash) return null; - const normalized = `https://${url.hostname}`; - return isProprProxyUrl(normalized) ? normalized : null; - } catch { - return null; - } -}; - -type HostedTunnelStorage = Pick; - -const storageForWindow = (): HostedTunnelStorage | undefined => { - if (typeof window === 'undefined') return undefined; - try { - return window.sessionStorage; - } catch { - return undefined; - } -}; - -/** Generate a random per-tab flow token. */ -const generateFlowId = (): string => { - try { - return crypto.randomUUID(); - } catch { - return Math.random().toString(36).slice(2) + Date.now().toString(36); - } -}; - -const generateHostedTunnelContextId = (): string => generateFlowId(); - -const contextIdFromWindowName = (name: string): string | null => { - if (!name.startsWith(WINDOW_NAME_CONTEXT_PREFIX)) return null; - const rest = name.slice(WINDOW_NAME_CONTEXT_PREFIX.length); - const separatorIndex = rest.indexOf(WINDOW_NAME_CONTEXT_SEPARATOR); - const contextId = (separatorIndex === -1 ? rest : rest.slice(0, separatorIndex)).trim(); - return contextId || null; -}; - -const currentHostedTunnelContextId = (): string | null => { - if (typeof window === 'undefined') return null; - try { - return contextIdFromWindowName(window.name); - } catch { - return null; - } -}; - -const setHostedTunnelContextId = (contextId: string): string | null => { - if (typeof window === 'undefined') return contextId; - try { - const existing = window.name || ''; - const separatorIndex = existing.indexOf(WINDOW_NAME_CONTEXT_SEPARATOR); - const preservedName = existing.startsWith(WINDOW_NAME_CONTEXT_PREFIX) - ? (separatorIndex === -1 ? '' : existing.slice(separatorIndex + 1)) - : existing; - window.name = `${WINDOW_NAME_CONTEXT_PREFIX}${contextId}${WINDOW_NAME_CONTEXT_SEPARATOR}${preservedName}`; - return contextId; - } catch { - return null; - } -}; - -const ensureHostedTunnelContextId = (): string | null => { - const existing = currentHostedTunnelContextId(); - if (existing) return existing; - return setHostedTunnelContextId(generateHostedTunnelContextId()); -}; - -/** Extract the `?flow=` token from a URL search string. */ -const flowIdFromSearch = (search: string): string | null => - new URLSearchParams(search).get('flow') || null; - -const effectiveHostedTunnelContextId = ( - _flowId: string, - _storedContextId: string, - contextId: string | null | undefined -): string | null => { - const currentContextId = contextId === undefined ? currentHostedTunnelContextId() : contextId; - if (currentContextId) return currentContextId; - return null; -}; - -/** - * Store the selected hosted tunnel URL in sessionStorage together with a - * per-tab flow token. Returns the generated flow token (to be embedded in the - * page URL by the caller), or null if nothing was stored. - */ -export const rememberHostedTunnelApiBaseUrl = ( - hostname: string, - apiBaseUrl: string, - storage: HostedTunnelStorage | undefined = storageForWindow(), - contextId: string | null = ensureHostedTunnelContextId() -): string | null => { - if (!isHostedUiOrigin(hostname) || !storage || !contextId || !isProprProxyUrl(apiBaseUrl)) return null; - try { - const flowId = generateFlowId(); - storage.setItem(HOSTED_TUNNEL_API_BASE_STORAGE_KEY, apiBaseUrl.replace(/\/+$/, '')); - storage.setItem(HOSTED_TUNNEL_FLOW_ID_KEY, flowId); - storage.setItem(HOSTED_TUNNEL_CONTEXT_ID_KEY, contextId); - return flowId; - } catch { - // sessionStorage can be disabled or full. - return null; - } -}; +/** Whether a raw URL places a managed-looking tunnel label under propr.dev. */ +const claimsManagedTunnelNamespace = (value: string): boolean => { + // Inspect the literal authority before URL applies IDNA conversion. This is + // deliberately the same raw-authority classification used by the API: the + // first label starts with t- and the terminal labels are exactly propr.dev. + const rawAuthority = value + .slice(value.indexOf('://') + 3) + .split(/[/?#]/, 1)[0] + ?.split('@') + .pop() + ?.toLowerCase() ?? ''; + const rawHostname = rawAuthority.replace(/:\d+$/, '').replace(/\.$/, ''); + const rawLabels = rawHostname.split('.'); + if ( + rawLabels[0]?.startsWith(PROPR_UI_PROXY_LABEL_PREFIX) === true + && rawLabels.at(-2) === 'propr' + && rawLabels.at(-1) === 'dev' + ) return true; -/** - * Read the previously stored hosted tunnel URL from sessionStorage, but only - * when the supplied `flowId` matches the stored per-tab token. A new browsing - * context whose sessionStorage was copied from another tab (window.open(), - * duplicate-tab) but whose URL carries no valid flow token is rejected here, - * preventing silent cross-tab tunnel inheritance. - */ -export const readStoredHostedTunnelApiBaseUrl = ( - hostname: string, - flowId: string | null, - storage: HostedTunnelStorage | undefined = storageForWindow(), - contextId?: string | null -): string | null => { - if (!isHostedUiOrigin(hostname) || !storage) return null; try { - const storedFlowId = storage.getItem(HOSTED_TUNNEL_FLOW_ID_KEY)?.trim() || null; - const storedContextId = storage.getItem(HOSTED_TUNNEL_CONTEXT_ID_KEY)?.trim() || null; - // Reject if storage has no flow token (never legitimately set by this tab) - // or context token, or if the URL/current tab tokens do not match storage. - if (!storedFlowId || storedFlowId !== flowId || !storedContextId) { - return null; - } - if (effectiveHostedTunnelContextId(storedFlowId, storedContextId, contextId) !== storedContextId) { - return null; - } - const stored = storage.getItem(HOSTED_TUNNEL_API_BASE_STORAGE_KEY)?.trim(); - if (stored && isProprProxyUrl(stored)) return stored.replace(/\/+$/, ''); - if (stored) storage.removeItem(HOSTED_TUNNEL_API_BASE_STORAGE_KEY); + const hostname = new URL(value.trim()).hostname.toLowerCase().replace(/\.$/, ''); + const suffix = `.${PROPR_UI_PROXY_SUFFIX}`; + if (!hostname.endsWith(suffix)) return false; + return hostname + .slice(0, -suffix.length) + .split('.') + .some(label => label.startsWith(PROPR_UI_PROXY_LABEL_PREFIX)); } catch { - return null; + return false; } - return null; }; /** @@ -287,20 +181,21 @@ export const runtimeConfigWarning = ( ): string | null => { if (!isHostedUiOrigin(hostname)) return null; if (hostedTunnelQueryApiBaseUrl(hostname, search)) return null; + if (hasHostedTunnelQueryParameter(search)) return `[propr] ${INVALID_RUNTIME_CONFIGURATION_CODE}`; if (readStoredHostedTunnelApiBaseUrl(hostname, flowIdFromSearch(search), storage, contextId)) return null; if (!config) { - return ( - '[propr] window.__PROPR_CONFIG__ is not set — config.js did not load. ' + - 'The hosted UI needs a selected tunnel before it can reach a per-instance proxy.' - ); + return '[propr] HOSTED_STACK_REQUIRED'; } - const apiBaseUrl = config.apiBaseUrl?.trim(); + const configured = config.apiBaseUrl; + if (configured !== undefined && typeof configured !== 'string') { + return `[propr] ${INVALID_RUNTIME_CONFIGURATION_CODE}`; + } + if ((configured?.length ?? 0) > MAX_PROPR_API_BASE_URL_LENGTH) { + return `[propr] ${INVALID_RUNTIME_CONFIGURATION_CODE}`; + } + const apiBaseUrl = configured; if (!apiBaseUrl) { - return ( - '[propr] window.__PROPR_CONFIG__.apiBaseUrl is empty — config.js loaded but ' + - 'PROPR_UI_PUBLIC_API_URL was not set at container start. ' + - 'The hosted UI needs a selected tunnel before it can reach a per-instance proxy.' - ); + return '[propr] HOSTED_STACK_REQUIRED'; } // The launcher validates PROPR_UI_PUBLIC_API_URL before injecting it, but a // hand-served config.js or vendor-hosted injection can still provide a @@ -308,25 +203,17 @@ export const runtimeConfigWarning = ( // that is not an absolute http(s) URL (a path, a host with no scheme, junk) // produces broken requests — warn so hosted misconfiguration is diagnosable. if (!isValidHttpUrl(apiBaseUrl)) { - return ( - `[propr] window.__PROPR_CONFIG__.apiBaseUrl is not a valid http(s) URL: "${apiBaseUrl}". ` + - 'Expected an absolute per-instance proxy URL like https://t-abc123.propr.dev. ' + - 'API calls built from this base will fail.' - ); + return `[propr] ${INVALID_RUNTIME_CONFIGURATION_CODE}`; } // Hosted UI tunnel mode is explicitly limited to per-instance proxy hosts: // propr-routing only forwards /api/* and /socket.io/* on // https://t-.propr.dev. A well-formed http(s) URL pointing anywhere // else (e.g. https://custom.example.com) parses fine but requests will not be // routed to the local stack, so warn rather than letting it fail silently at - // request time. This is a warning, not a hard block — a future hosting setup - // could legitimately front a different proxy domain. + // request time. The same condition is also returned as a blocked connection + // issue before the hosted API client is constructed. if (!isProprProxyUrl(apiBaseUrl)) { - return ( - `[propr] window.__PROPR_CONFIG__.apiBaseUrl is not a hosted ProPR proxy URL: "${apiBaseUrl}". ` + - 'Hosted UI tunnel mode only routes https://t-.propr.dev, so API calls built ' + - 'from this base may not reach the local stack.' - ); + return `[propr] ${INVALID_RUNTIME_CONFIGURATION_CODE}`; } return null; }; @@ -340,31 +227,26 @@ export const hostedUiConnectionIssue = ( ): HostedUiConnectionIssue | null => { if (!isHostedUiOrigin(hostname)) return null; if (hostedTunnelQueryApiBaseUrl(hostname, search)) return null; + if (hasHostedTunnelQueryParameter(search)) return invalidRuntimeConfigurationIssue(); if (readStoredHostedTunnelApiBaseUrl(hostname, flowIdFromSearch(search), storage, contextId)) return null; - const apiBaseUrl = config?.apiBaseUrl?.trim(); + const configured = config?.apiBaseUrl; + if (configured !== undefined && typeof configured !== 'string') return invalidRuntimeConfigurationIssue(); + if ((configured?.length ?? 0) > MAX_PROPR_API_BASE_URL_LENGTH) return invalidRuntimeConfigurationIssue(); + const apiBaseUrl = configured; if (!apiBaseUrl) { return { + code: 'HOSTED_STACK_REQUIRED', title: 'Connect a ProPR stack', message: 'This hosted UI needs a selected local stack before it can make API calls. Open ProPR Connect and choose a tunnel, or use the hosted UI link shown after tunnel setup.', }; } if (!isValidHttpUrl(apiBaseUrl)) { - return { - title: 'Invalid hosted UI configuration', - message: - `The configured API URL is not a valid http(s) URL: "${apiBaseUrl}". ` + - 'Restart the stack after setting a hosted proxy URL such as https://t-abc123.propr.dev.', - }; + return invalidRuntimeConfigurationIssue(); } if (!isProprProxyUrl(apiBaseUrl)) { - return { - title: 'Invalid hosted UI tunnel', - message: - `The configured API URL is not a hosted ProPR proxy URL: "${apiBaseUrl}". ` + - 'Hosted UI tunnel mode requires a bare https://t-.propr.dev URL.', - }; + return invalidRuntimeConfigurationIssue(); } return null; }; @@ -425,10 +307,13 @@ export const resolveApiBaseUrl = ( const selectedApiBaseUrl = ( queryApiBaseUrl || storedApiBaseUrl || - config?.apiBaseUrl?.trim() || - buildTimeApiBaseUrl?.trim() || + config?.apiBaseUrl || + buildTimeApiBaseUrl || '' ); + if (isHostedUiOrigin(hostname) && claimsManagedTunnelNamespace(selectedApiBaseUrl)) { + return canonicalProprProxyUrl(selectedApiBaseUrl) ?? ''; + } return normalizeApiBaseUrl(selectedApiBaseUrl); }; /* eslint-enable max-params */ @@ -485,13 +370,17 @@ if (typeof window !== 'undefined') { * connection so they always target the same origin. Returns an empty string * for same-origin requests. * - * Trailing slashes are stripped here, once, so the many callers that build - * paths as `${API_BASE_URL}/api/...` never produce a double slash (e.g. - * `https://t-abc.propr.dev//api/compatibility`). The orchestrator already - * normalizes the values it injects, but a hand-served `public/config.js`, - * `VITE_API_BASE_URL`, or manually set apiBaseUrl can still carry one. + * Generic/self-managed URL spellings are normalized here so callers that build + * paths as `${API_BASE_URL}/api/...` never produce a double slash. Hosted + * managed tunnel origins are checked before that normalization and must already + * use their exact lowercase, slash-free canonical spelling. */ export const getApiBaseUrl = (): string => { + return getRuntimeApiBaseUrlState().apiBaseUrl; +}; + +/** Resolve configuration without allowing malformed injected values to throw at import time. */ +export const getRuntimeApiBaseUrlState = (): RuntimeApiBaseUrlState => { if ( typeof window !== 'undefined' && isHostedOAuthCompletionRoute( @@ -500,18 +389,31 @@ export const getApiBaseUrl = (): string => { window.location.search ) ) { - return ''; + return { apiBaseUrl: '', issue: null }; } - if (desktopApiBaseUrl !== null) return desktopApiBaseUrl; + if (desktopApiBaseUrl !== null) return { apiBaseUrl: desktopApiBaseUrl, issue: null }; - return resolveApiBaseUrl( - typeof window !== 'undefined' ? window.location.hostname : '', - typeof window !== 'undefined' ? window.location.search : '', - runtimeConfig, - import.meta.env.VITE_API_BASE_URL, - storageForWindow() - ); + const hostname = typeof window !== 'undefined' ? window.location.hostname : ''; + const search = typeof window !== 'undefined' ? window.location.search : ''; + const storage = storageForWindow(); + const hostedIssue = hostedUiConnectionIssue(hostname, runtimeConfig, search, storage); + if (hostedIssue) return { apiBaseUrl: '', issue: hostedIssue }; + + try { + return { + apiBaseUrl: resolveApiBaseUrl( + hostname, + search, + runtimeConfig, + import.meta.env.VITE_API_BASE_URL, + storage + ), + issue: null, + }; + } catch { + return { apiBaseUrl: '', issue: invalidRuntimeConfigurationIssue() }; + } }; /** Set by the desktop presentation boundary after a profile has passed its probe. */ @@ -520,7 +422,9 @@ export const setDesktopApiBaseUrl = (value: string | null): void => { desktopApiBaseUrl = null; return; } - const normalized = value.trim().replace(/\/+$/, ''); - if (normalized && !isValidHttpUrl(normalized)) throw new Error('Desktop API base URL must use http(s).'); - desktopApiBaseUrl = normalized; + try { + desktopApiBaseUrl = normalizeApiBaseUrl(value); + } catch { + throw new Error('The ProPR connection configuration is invalid.'); + } }; diff --git a/propr-ui/src/contexts/SocketProvider.test.tsx b/propr-ui/src/contexts/SocketProvider.test.tsx index 1a7b5cb9f..ee96e4ab6 100644 --- a/propr-ui/src/contexts/SocketProvider.test.tsx +++ b/propr-ui/src/contexts/SocketProvider.test.tsx @@ -1,60 +1,228 @@ -import { cleanup, render } from '@testing-library/react'; +import { act, cleanup, render } from '@testing-library/react'; import { afterEach, describe, expect, it, vi } from 'vitest'; import { SocketProvider } from './SocketProvider'; +import { useSocket } from './useSocket'; -const socketMock = vi.hoisted(() => ({ - disconnect: vi.fn(), - emit: vi.fn(), - on: vi.fn(), +type Handler = (value?: unknown) => void; +const sockets = vi.hoisted(() => [] as Array<{ + handlers: Map; + connect: ReturnType; + disconnect: ReturnType; + emit: ReturnType; + on: ReturnType; + off: ReturnType; +}>); +const connectSocketMock = vi.hoisted(() => vi.fn(() => { + const handlers = new Map(); + const socket = { + handlers, + connect: vi.fn(), + disconnect: vi.fn(), + emit: vi.fn(), + on: vi.fn((event: string, handler: Handler) => { handlers.set(event, handler); }), + off: vi.fn((event: string, handler?: Handler) => { + if (!handler || handlers.get(event) === handler) handlers.delete(event); + }), + }; + sockets.push(socket); + return socket; +})); +const scopeListeners = vi.hoisted(() => new Set<() => void>()); +const handleDesktopAccessCode = vi.hoisted(() => vi.fn(async () => 'retryable')); +const runtime = vi.hoisted(() => ({ desktop: true })); +const state = vi.hoisted(() => ({ + origin: 'https://a.example.test', + scope: null as null | { bridge: never; profileId: string; transportScope: string }, })); - -const connectSocketMock = vi.hoisted(() => vi.fn(() => socketMock)); vi.mock('../api/apiClient', () => ({ - proprClient: { connectSocket: connectSocketMock }, + getProprClient: () => ({ connectSocket: connectSocketMock }), + getDesktopConnectionScope: () => state.scope, + getDesktopSocketConfigurationKey: () => + `${runtime.desktop ? 'desktop' : 'browser'}\u0000${state.origin}\u0000${state.scope?.profileId ?? ''}\u0000${state.scope?.transportScope ?? ''}`, + subscribeDesktopConnectionScope: (listener: () => void) => { + scopeListeners.add(listener); + return () => scopeListeners.delete(listener); + }, + handleDesktopAccessCode, })); +vi.mock('../config/runtimeMode', () => ({ isDesktopRuntime: () => runtime.desktop })); + +const scope = (profileId: string, transportScope: string) => ({ + bridge: {} as never, + profileId, + transportScope, +}); +const publish = (next: typeof state.scope, origin = state.origin) => { + act(() => { + state.scope = next; + state.origin = origin; + scopeListeners.forEach(listener => listener()); + }); +}; describe('SocketProvider', () => { afterEach(() => { cleanup(); + sockets.splice(0); connectSocketMock.mockClear(); - socketMock.disconnect.mockClear(); - socketMock.emit.mockClear(); - socketMock.on.mockClear(); + scopeListeners.clear(); + handleDesktopAccessCode.mockReset(); + handleDesktopAccessCode.mockResolvedValue('retryable'); + runtime.desktop = true; + state.origin = 'https://a.example.test'; + state.scope = null; }); - it('does not connect when disabled for demo mode', () => { - render( - -
demo
- - ); + it('does not connect when disabled or when desktop has no activation scope', () => { + const { rerender } = render(
demo
); + rerender(
desktop
); expect(connectSocketMock).not.toHaveBeenCalled(); }); - it('connects when real-time updates are enabled', () => { - const { unmount } = render( - -
app
- - ); + it('creates one force-new scoped Manager on null-to-A activation', () => { + render(
app
); + publish(scope('profile-a', 'AAAAAAAAAAAAAAAAAAAAAA')); expect(connectSocketMock).toHaveBeenCalledOnce(); - unmount(); - expect(socketMock.disconnect).toHaveBeenCalledOnce(); + expect(connectSocketMock).toHaveBeenCalledWith(expect.objectContaining({ + forceNew: true, + auth: { proprDesktopTransportScope: 'AAAAAAAAAAAAAAAAAAAAAA' }, + query: { proprDesktopTransportScope: 'AAAAAAAAAAAAAAAAAAAAAA' }, + })); }); - it('uses the shared client Socket.IO policy', () => { - const { unmount } = render( - -
app
- - ); + it.each([ + ['scope rotation', scope('profile-a', 'BBBBBBBBBBBBBBBBBBBBBB')], + ['same-origin A-to-B', scope('profile-b', 'BBBBBBBBBBBBBBBBBBBBBB')], + ])('fully detaches A before creating a distinct Manager for %s', (_name, nextScope) => { + state.scope = scope('profile-a', 'AAAAAAAAAAAAAAAAAAAAAA'); + render(
app
); + const socketA = sockets[0]; + + publish(nextScope); + + expect(sockets).toHaveLength(2); + expect(socketA.disconnect).toHaveBeenCalledOnce(); + expect(socketA.off).toHaveBeenCalledWith('connect', expect.any(Function)); + expect(socketA.off).toHaveBeenCalledWith('authentication:error', expect.any(Function)); + expect(socketA.disconnect.mock.invocationCallOrder[0]) + .toBeLessThan(connectSocketMock.mock.invocationCallOrder[1]); + expect(sockets[1]).not.toBe(socketA); + }); + + it('reports a replacement Manager as disconnected until its own connect event', () => { + const connectedStates: boolean[] = []; + const ConnectionState = () => { + connectedStates.push(useSocket().isConnected); + return null; + }; + state.scope = scope('profile-a', 'AAAAAAAAAAAAAAAAAAAAAA'); + render(); + + act(() => { sockets[0].handlers.get('connect')?.(); }); + expect(connectedStates.at(-1)).toBe(true); + + publish(scope('profile-b', 'BBBBBBBBBBBBBBBBBBBBBB')); + expect(connectedStates.at(-1)).toBe(false); + act(() => { sockets[1].handlers.get('connect_error')?.(new Error('not connected')); }); + expect(connectedStates.at(-1)).toBe(false); + act(() => { sockets[1].handlers.get('connect')?.(); }); + expect(connectedStates.at(-1)).toBe(true); + }); + + it('rotates the Manager when the effective API origin changes', () => { + state.scope = scope('profile-a', 'AAAAAAAAAAAAAAAAAAAAAA'); + render(
app
); + const socketA = sockets[0]; + + publish(state.scope, 'https://b.example.test'); + + expect(sockets).toHaveLength(2); + expect(socketA.disconnect).toHaveBeenCalledOnce(); + }); + + it('disconnects on deactivate and creates no replacement', () => { + state.scope = scope('profile-a', 'AAAAAAAAAAAAAAAAAAAAAA'); + render(
app
); + const socketA = sockets[0]; + + publish(null); + + expect(socketA.disconnect).toHaveBeenCalledOnce(); + expect(connectSocketMock).toHaveBeenCalledOnce(); + }); + + it('keeps the hosted browser cookie socket without a desktop marker', () => { + runtime.desktop = false; + render(
app
); + + expect(connectSocketMock).toHaveBeenCalledOnce(); + expect(connectSocketMock).toHaveBeenCalledWith(expect.objectContaining({ forceNew: true })); + expect(connectSocketMock).toHaveBeenCalledWith(expect.not.objectContaining({ auth: expect.anything() })); + expect(connectSocketMock).toHaveBeenCalledWith(expect.not.objectContaining({ query: expect.anything() })); + }); + + it('classifies authentication errors against the immutable activation scope', async () => { + state.scope = scope('profile-a', 'AAAAAAAAAAAAAAAAAAAAAA'); + handleDesktopAccessCode.mockResolvedValueOnce('invalidated'); + render(
app
); + + sockets[0].handlers.get('authentication:error')?.({ code: 'INVALID_INSTANCE_TOKEN' }); + await vi.waitFor(() => expect(handleDesktopAccessCode).toHaveBeenCalledWith( + 'INVALID_INSTANCE_TOKEN', state.scope, + )); + expect(sockets[0].connect).not.toHaveBeenCalled(); + }); + + it('reconnects the current Manager when authorization changes without invalidating its token', async () => { + state.scope = scope('profile-a', 'AAAAAAAAAAAAAAAAAAAAAA'); + handleDesktopAccessCode.mockResolvedValueOnce('authorization-changed'); + render(
app
); + const socketA = sockets[0]; + + socketA.handlers.get('authentication:error')?.({ code: 'AUTHORIZATION_CHANGED' }); + + await vi.waitFor(() => expect(socketA.connect).toHaveBeenCalledOnce()); + expect(handleDesktopAccessCode).toHaveBeenCalledWith('AUTHORIZATION_CHANGED', state.scope); + expect(socketA.disconnect).toHaveBeenCalledOnce(); + }); + + it('never reconnects a stale same-origin Manager after deferred authorization work resolves', async () => { + state.scope = scope('profile-a', 'AAAAAAAAAAAAAAAAAAAAAA'); + let resolveClassification!: (value: 'authorization-changed') => void; + handleDesktopAccessCode.mockReturnValueOnce(new Promise(resolve => { resolveClassification = resolve; })); + render(
app
); + const socketA = sockets[0]; + const staleAuthenticationHandler = socketA.handlers.get('authentication:error'); + + staleAuthenticationHandler?.({ code: 'AUTHORIZATION_CHANGED' }); + await vi.waitFor(() => expect(handleDesktopAccessCode).toHaveBeenCalledWith( + 'AUTHORIZATION_CHANGED', state.scope, + )); + publish(scope('profile-b', 'BBBBBBBBBBBBBBBBBBBBBB')); + const socketB = sockets[1]; + resolveClassification('authorization-changed'); + await Promise.resolve(); + + expect(socketA.connect).not.toHaveBeenCalled(); + expect(socketA.disconnect).toHaveBeenCalledOnce(); + expect(socketA.off).toHaveBeenCalledWith('authentication:error', staleAuthenticationHandler); + expect(socketA.handlers.size).toBe(0); + expect(socketB.disconnect).not.toHaveBeenCalled(); + expect(socketB.connect).not.toHaveBeenCalled(); + }); + + it('fully detaches listeners and disconnects on unmount', () => { + state.scope = scope('profile-a', 'AAAAAAAAAAAAAAAAAAAAAA'); + const { unmount } = render(
app
); + const socketA = sockets[0]; - expect(connectSocketMock).toHaveBeenCalledWith(expect.objectContaining({ - withCredentials: true, - })); unmount(); + + expect(socketA.disconnect).toHaveBeenCalledOnce(); + expect(socketA.handlers.size).toBe(0); + expect(scopeListeners.size).toBe(0); }); }); diff --git a/propr-ui/src/contexts/SocketProvider.tsx b/propr-ui/src/contexts/SocketProvider.tsx index 458fa4280..0c6ef8459 100644 --- a/propr-ui/src/contexts/SocketProvider.tsx +++ b/propr-ui/src/contexts/SocketProvider.tsx @@ -1,8 +1,15 @@ -import React, { useEffect, useState, useCallback, useRef } from 'react'; +import React, { useEffect, useState, useCallback, useRef, useSyncExternalStore } from 'react'; import type { Socket } from '@propr/client'; -import { TASK_UPDATE, DRAFT_UPDATE, INDEXING_UPDATE, QUEUE_STATS_UPDATE, TASK_LIVE_UPDATE, TaskUpdatePayload, DraftUpdatePayload, IndexingUpdatePayload, QueueStatsUpdatePayload, TaskLiveUpdatePayload } from '@propr/shared'; +import { DESKTOP_TRANSPORT_SCOPE_QUERY, TASK_UPDATE, DRAFT_UPDATE, INDEXING_UPDATE, QUEUE_STATS_UPDATE, TASK_LIVE_UPDATE, TaskUpdatePayload, DraftUpdatePayload, IndexingUpdatePayload, QueueStatsUpdatePayload, TaskLiveUpdatePayload } from '@propr/shared'; import { SocketContext, SocketContextValue } from './SocketContext'; -import { proprClient } from '../api/apiClient'; +import { + getDesktopConnectionScope, + getDesktopSocketConfigurationKey, + getProprClient, + handleDesktopAccessCode, + subscribeDesktopConnectionScope, +} from '../api/apiClient'; +import { isDesktopRuntime } from '../config/runtimeMode'; interface SocketProviderProps { children: React.ReactNode; @@ -17,6 +24,11 @@ export const SocketProvider: React.FC = ({ children, disabl const indexingUpdateCallbacksRef = useRef void>>(new Set()); const queueStatsUpdateCallbacksRef = useRef void>>(new Set()); const taskLiveUpdateCallbacksRef = useRef void>>(new Set()); + const socketConfigurationKey = useSyncExternalStore( + subscribeDesktopConnectionScope, + getDesktopSocketConfigurationKey, + getDesktopSocketConfigurationKey, + ); useEffect(() => { if (disabled) { @@ -25,26 +37,70 @@ export const SocketProvider: React.FC = ({ children, disabl return; } - const newSocket = proprClient.connectSocket({ + const desktopScope = getDesktopConnectionScope(); + if (isDesktopRuntime() && !desktopScope) { + setSocket(null); + setIsConnected(false); + return; + } + setIsConnected(false); + const newSocket = getProprClient().connectSocket({ transports: ['websocket'], - withCredentials: true, autoConnect: true, path: '/socket.io/', + forceNew: true, + ...(desktopScope ? { + auth: { [DESKTOP_TRANSPORT_SCOPE_QUERY]: desktopScope.transportScope }, + query: { [DESKTOP_TRANSPORT_SCOPE_QUERY]: desktopScope.transportScope }, + } : {}), }); + let disposed = false; + const isCurrentScope = (): boolean => { + if (disposed) return false; + const current = getDesktopConnectionScope(); + return current?.profileId === desktopScope?.profileId + && current?.transportScope === desktopScope?.transportScope; + }; + const handleAuthenticationCode = (code: string | undefined, reconnect = false): void => { + if (!isCurrentScope()) return; + void handleDesktopAccessCode(code, desktopScope).then(classification => { + if (!isCurrentScope()) return; + if (classification === 'authorization-changed' && reconnect) { + newSocket.disconnect(); + if (!isCurrentScope()) return; + newSocket.connect(); + } + }); + }; - newSocket.on('connect', () => { + const connected = () => { + if (!isCurrentScope()) return; console.log('[SocketContext] Connected to WebSocket server'); setIsConnected(true); - }); + }; - newSocket.on('disconnect', (reason) => { + const disconnected = (reason: string) => { + if (!isCurrentScope()) return; console.log('[SocketContext] Disconnected from WebSocket server:', reason); setIsConnected(false); - }); + }; - newSocket.on('connect_error', (error) => { + const connectionError = (error: Error) => { + if (!isCurrentScope()) return; + setIsConnected(false); console.error('[SocketContext] Connection error:', error.message); - }); + const code = (error as Error & { data?: { code?: string } }).data?.code; + handleAuthenticationCode(code); + }; + + const authenticationError = (value: { code?: string } | undefined) => { + handleAuthenticationCode(value?.code, true); + }; + + newSocket.on('connect', connected); + newSocket.on('disconnect', disconnected); + newSocket.on('connect_error', connectionError); + newSocket.on('authentication:error', authenticationError); // Set up global event listeners newSocket.on(TASK_UPDATE, (payload: TaskUpdatePayload) => { @@ -76,9 +132,20 @@ export const SocketProvider: React.FC = ({ children, disabl return () => { console.log('[SocketContext] Cleaning up socket connection'); + setIsConnected(false); + disposed = true; + newSocket.off('connect', connected); + newSocket.off('disconnect', disconnected); + newSocket.off('connect_error', connectionError); + newSocket.off('authentication:error', authenticationError); + newSocket.off(TASK_UPDATE); + newSocket.off(DRAFT_UPDATE); + newSocket.off(INDEXING_UPDATE); + newSocket.off(QUEUE_STATS_UPDATE); + newSocket.off(TASK_LIVE_UPDATE); newSocket.disconnect(); }; - }, [disabled]); + }, [disabled, socketConfigurationKey]); const subscribeToTask = useCallback((taskId: string) => { if (socket && isConnected) { diff --git a/propr-ui/src/desktop-deep-link.test.ts b/propr-ui/src/desktop-deep-link.test.ts index b431da2ff..29ab7ec85 100644 --- a/propr-ui/src/desktop-deep-link.test.ts +++ b/propr-ui/src/desktop-deep-link.test.ts @@ -1,15 +1,15 @@ import { describe, expect, it, vi } from 'vitest'; -import { DesktopDeepLinkNavigation } from './desktop-deep-link'; +import { DesktopDeepLinkInbox, DesktopDeepLinkNavigation } from './desktop-deep-link'; describe('desktop open deep-link navigation', () => { it('preserves a startup-buffered link until the dashboard is ready', () => { const navigate = vi.fn(); const navigation = new DesktopDeepLinkNavigation(navigate); - expect(navigation.receive('propr://open?path=%2Ftasks')).toBe(true); + expect(navigation.receive('propr://open?path=%2Ftasks', 'profile-a')).toBe(true); expect(navigate).not.toHaveBeenCalled(); - navigation.setDashboardReady(); + navigation.setDashboardReady('profile-a'); expect(navigate).toHaveBeenCalledOnce(); expect(navigate).toHaveBeenCalledWith('/tasks'); }); @@ -18,9 +18,9 @@ describe('desktop open deep-link navigation', () => { const navigate = vi.fn(); const navigation = new DesktopDeepLinkNavigation(navigate); - navigation.receive('propr://open?path=%2Fplans'); - navigation.receive('propr://open?path=%2Ftasks'); - navigation.setDashboardReady(); + navigation.receive('propr://open?path=%2Fplans', 'profile-a'); + navigation.receive('propr://open?path=%2Ftasks', 'profile-a'); + navigation.setDashboardReady('profile-a'); expect(navigate.mock.calls).toEqual([['/plans'], ['/tasks']]); }); @@ -28,30 +28,30 @@ describe('desktop open deep-link navigation', () => { it('delivers a valid link received after the dashboard has loaded', () => { const navigate = vi.fn(); const navigation = new DesktopDeepLinkNavigation(navigate); - navigation.setDashboardReady(); + navigation.setDashboardReady('profile-a'); - expect(navigation.receive('propr://open?path=%2Ftasks%3Fstatus%3Dopen%23recent')).toBe(true); + expect(navigation.receive('propr://open?path=%2Ftasks%3Fstatus%3Dopen%23recent', 'profile-a')).toBe(true); expect(navigate).toHaveBeenCalledWith('/tasks?status=open#recent'); }); it('rejects an expanded canonical link and accepts one at the length limit', () => { const navigate = vi.fn(); const navigation = new DesktopDeepLinkNavigation(navigate); - navigation.setDashboardReady(); + navigation.setDashboardReady('profile-a'); const rawPath = `/tasks/${'é '.repeat(300)}end`; const rawLink = `propr://open?path=${rawPath}`; const expandedCanonicalLink = new URL(rawLink).href; expect(rawLink.length).toBeLessThan(2_048); expect(expandedCanonicalLink.length).toBeGreaterThan(2_048); - expect(navigation.receive(expandedCanonicalLink)).toBe(false); + expect(navigation.receive(expandedCanonicalLink, 'profile-a')).toBe(false); const canonicalPrefix = 'propr://open?path=%2Ftasks%2F'; const suffix = 'a'.repeat(2_048 - canonicalPrefix.length); const boundaryCanonicalLink = `${canonicalPrefix}${suffix}`; expect(boundaryCanonicalLink).toHaveLength(2_048); expect(new URL(boundaryCanonicalLink).href).toBe(boundaryCanonicalLink); - expect(navigation.receive(boundaryCanonicalLink)).toBe(true); + expect(navigation.receive(boundaryCanonicalLink, 'profile-a')).toBe(true); expect(navigate).toHaveBeenCalledOnce(); expect(navigate).toHaveBeenCalledWith(`/tasks/${suffix}`); }); @@ -74,9 +74,51 @@ describe('desktop open deep-link navigation', () => { 'propr://open?path=%2Ftasks%3Ftunnel%3Dt-attacker.propr.dev', ]; - rejected.forEach(link => expect(navigation.receive(link), link).toBe(false)); - navigation.setDashboardReady(); - rejected.forEach(link => expect(navigation.receive(link), link).toBe(false)); + rejected.forEach(link => expect(navigation.receive(link, 'profile-a'), link).toBe(false)); + navigation.setDashboardReady('profile-a'); + rejected.forEach(link => expect(navigation.receive(link, 'profile-a'), link).toBe(false)); expect(navigate).not.toHaveBeenCalled(); }); + + it('rejects a queued route when a different profile becomes active', () => { + const navigate = vi.fn(); + const reject = vi.fn(); + const navigation = new DesktopDeepLinkNavigation(navigate, reject); + + expect(navigation.receive('propr://open?path=%2Ftasks', 'profile-a')).toBe(true); + navigation.setDashboardReady('profile-b'); + + expect(navigate).not.toHaveBeenCalled(); + expect(reject).toHaveBeenCalledOnce(); + }); +}); + +describe('desktop deep-link inbox', () => { + it('delivers values received before a consumer subscribes exactly once', () => { + const inbox = new DesktopDeepLinkInbox(); + const first = vi.fn(); + const second = vi.fn(); + inbox.receive('propr://connect?api=https%3A%2F%2Ffirst.example'); + + const unsubscribe = inbox.subscribe(first); + expect(first).toHaveBeenCalledOnce(); + unsubscribe(); + const unsubscribeSecond = inbox.subscribe(second); + expect(second).not.toHaveBeenCalled(); + + inbox.receive('propr://connect?api=https%3A%2F%2Fsecond.example'); + expect(second).toHaveBeenCalledOnce(); + unsubscribeSecond(); + }); + + it('fails closed when a competing consumer subscribes', () => { + const inbox = new DesktopDeepLinkInbox(); + const first = vi.fn(); + const unsubscribe = inbox.subscribe(first); + + expect(() => inbox.subscribe(vi.fn())).toThrow('already has a consumer'); + inbox.receive('propr://connect?api=https%3A%2F%2Fonly.example'); + expect(first).toHaveBeenCalledOnce(); + unsubscribe(); + }); }); diff --git a/propr-ui/src/desktop-deep-link.ts b/propr-ui/src/desktop-deep-link.ts index 6972698d1..a81070ed7 100644 --- a/propr-ui/src/desktop-deep-link.ts +++ b/propr-ui/src/desktop-deep-link.ts @@ -1,26 +1,75 @@ import { dashboardPathFromDeepLink } from '../../apps/desktop/src/security'; -/** Holds an accepted dashboard route until the shared hash router can observe it. */ +const validProfileId = (value: string): boolean => value.length > 0 && value.length <= 128 && !/[\u0000-\u001F\u007F]/.test(value); + +interface PendingNavigation { + path: string; + profileId: string; +} + +/** Holds accepted routes while binding each one to the profile active when it arrived. */ export class DesktopDeepLinkNavigation { - private dashboardReady = false; - private readonly pendingPaths: string[] = []; + private activeProfileId: string | null = null; + private readonly pending: PendingNavigation[] = []; - constructor(private readonly navigate: (path: string) => void) {} + constructor( + private readonly navigate: (path: string) => void, + private readonly reject: () => void = () => undefined, + ) {} - receive(value: string): boolean { + receive(value: string, profileId: string): boolean { const path = dashboardPathFromDeepLink(value); - if (!path) return false; - if (this.dashboardReady) this.navigate(path); - else this.pendingPaths.push(path); + if (!path || !validProfileId(profileId)) { + this.reject(); + return false; + } + if (this.activeProfileId === profileId) this.navigate(path); + else if (this.activeProfileId === null) this.pending.push({ path, profileId }); + else { + this.reject(); + return false; + } return true; } - setDashboardReady(): void { - this.dashboardReady = true; - this.pendingPaths.splice(0).forEach(path => this.navigate(path)); + setDashboardReady(profileId: string): void { + if (!validProfileId(profileId)) { + this.rejectPending(); + return; + } + this.activeProfileId = profileId; + this.pending.splice(0).forEach(item => { + if (item.profileId === profileId) this.navigate(item.path); + else this.reject(); + }); } setDashboardUnavailable(): void { - this.dashboardReady = false; + this.activeProfileId = null; + } + + rejectPending(): void { + const rejected = this.pending.splice(0).length; + if (rejected > 0) this.reject(); + } +} + +/** One-consumer handoff between the desktop bridge and presentation experience. */ +export class DesktopDeepLinkInbox { + private listener: ((value: string) => void) | null = null; + private readonly pending: string[] = []; + + receive(value: string): void { + if (this.listener) this.listener(value); + else this.pending.push(value); + } + + subscribe(listener: (value: string) => void): () => void { + if (this.listener) throw new Error('Desktop deep-link inbox already has a consumer'); + this.listener = listener; + this.pending.splice(0).forEach(value => listener(value)); + return () => { + if (this.listener === listener) this.listener = null; + }; } } diff --git a/propr-ui/src/desktop.tsx b/propr-ui/src/desktop.tsx index 7bfee062f..2bf17953f 100644 --- a/propr-ui/src/desktop.tsx +++ b/propr-ui/src/desktop.tsx @@ -1,249 +1,15 @@ -import { StrictMode, type ComponentType, useCallback, useEffect, useState } from 'react'; +import { StrictMode } from 'react'; import { createRoot } from 'react-dom/client'; -import type { - DesktopAppMetadata, - DesktopProfile, - StorageSecurity, -} from '../../apps/desktop/src/shared/contract'; -import { activateDesktopProfile } from './desktop-profile'; -import { DesktopDeepLinkNavigation } from './desktop-deep-link'; +import App from './App'; import './index.css'; -import './desktop.css'; - -const logoUrl = new URL('./media/logo-and-name.png', window.location.href).href; - -export const DesktopTitleBar = ({ - metadata, - profile, - onDisconnect, -}: { - metadata: DesktopAppMetadata | null; - profile: DesktopProfile | null; - onDisconnect?: () => void; -}) => ( -
-
- ProPR - - {profile ? profile.label : 'Desktop'} - -
-
- {metadata && v{metadata.version} · {metadata.platform}} - {onDisconnect && ( - - )} -
-
-); - -export const ConnectionPlaceholder = ({ - metadata, - security, - initialApiUrl, - onConnect, -}: { - metadata: DesktopAppMetadata | null; - security: StorageSecurity | null; - initialApiUrl: string; - onConnect: (label: string, apiBaseUrl: string) => Promise; -}) => { - const [label, setLabel] = useState('Local ProPR'); - const [apiBaseUrl, setApiBaseUrl] = useState(initialApiUrl); - const [error, setError] = useState(null); - const [saving, setSaving] = useState(false); - - useEffect(() => setApiBaseUrl(initialApiUrl), [initialApiUrl]); - - const submit = async (event: React.FormEvent) => { - event.preventDefault(); - setError(null); - setSaving(true); - try { - await onConnect(label, apiBaseUrl); - } catch (caught) { - setError(caught instanceof Error ? caught.message : 'Could not save this connection.'); - } finally { - setSaving(false); - } - }; - - return ( -
-
-
-
-

ProPR Desktop

-

- Connect to your ProPR instance -

-
-
- Not connected -
-
-

- Add an existing instance to open the same dashboard you use on the web. The desktop app will not - install, download, or start runtime components. -

-
- - - {security && !security.available && ( -
- OS-backed encryption is unavailable ({security.backend}). Profiles can still be saved, but this - app will refuse to persist credentials until secure storage is available. -
- )} - {error &&
{error}
} - -
-
- Local lifecycle controls and secure pairing will appear here in a later setup flow. - {metadata && Runtime: Electron on {metadata.platform} ({metadata.arch})} -
-
-
- ); -}; - -export const DesktopRoot = () => { - const bridge = window.proprDesktop; - const [metadata, setMetadata] = useState(null); - const [security, setSecurity] = useState(null); - const [profile, setProfile] = useState(null); - const [DashboardApp, setDashboardApp] = useState(null); - const [initialApiUrl, setInitialApiUrl] = useState('http://localhost:4000'); - const [loading, setLoading] = useState(true); - const [fatalError, setFatalError] = useState(null); - const [deepLinkNavigation] = useState(() => new DesktopDeepLinkNavigation(path => { - window.location.hash = path; - })); - - const loadDashboard = useCallback(async (activeProfile: DesktopProfile) => { - window.__PROPR_CONFIG__ = { apiBaseUrl: activeProfile.apiBaseUrl }; - const application = await import('./App'); - setProfile(activeProfile); - setDashboardApp(() => application.default); - deepLinkNavigation.setDashboardReady(); - }, [deepLinkNavigation]); - - useEffect(() => { - if (!bridge) { - setFatalError('The secure desktop bridge did not load. Restart ProPR Desktop.'); - setLoading(false); - return; - } - let cancelled = false; - const unsubscribe = bridge.app.onDeepLink(value => { - try { - const deepLink = new URL(value); - if (deepLink.hostname === 'connect') { - const apiUrl = deepLink.searchParams.get('api'); - if (apiUrl) setInitialApiUrl(apiUrl); - } else if (deepLink.hostname === 'open') { - deepLinkNavigation.receive(value); - } - } catch { - // Main validates protocol input; ignore malformed values defensively. - } - }); - void Promise.all([bridge.app.getMetadata(), bridge.storage.security(), bridge.profiles.list()]) - .then(async ([appMetadata, storageSecurity, profiles]) => { - if (cancelled) return; - setMetadata(appMetadata); - setSecurity(storageSecurity); - const active = profiles.profiles.find(item => item.id === profiles.activeProfileId); - if (active) await loadDashboard(active); - }) - .catch(error => { - if (!cancelled) setFatalError(error instanceof Error ? error.message : 'Desktop startup failed.'); - }) - .finally(() => { - if (!cancelled) setLoading(false); - }); - return () => { - cancelled = true; - unsubscribe(); - }; - }, [bridge, deepLinkNavigation, loadDashboard]); - - const connect = async (label: string, apiBaseUrl: string) => { - if (!bridge) return; - const saved = await bridge.profiles.save({ label, apiBaseUrl }); - await activateDesktopProfile(bridge.profiles, saved); - }; - - const disconnect = async () => { - if (!bridge) return; - await bridge.profiles.setActive(null); - setProfile(null); - setDashboardApp(null); - deepLinkNavigation.setDashboardUnavailable(); - window.__PROPR_CONFIG__ = undefined; - window.location.hash = ''; - }; - - if (loading) { - return ( -
- -
Starting ProPR Desktop…
-
- ); - } - - if (fatalError) { - return ( -
- -
-
- {fatalError} -
-
-
- ); - } - - return ( -
- -
- {profile && DashboardApp - ? - : } -
-
- ); -}; const container = document.getElementById('root'); if (!container) throw new Error('Root container missing in renderer.html'); -createRoot(container).render(); + +if (location.hash === '#packaged-transport-smoke') { + void import('./desktop/packagedTransportSmoke').then(({ installPackagedTransportSmokeHarness }) => { + installPackagedTransportSmokeHarness(); + }); +} + +createRoot(container).render(); diff --git a/propr-ui/src/desktop/DesktopConnectedExperience.tsx b/propr-ui/src/desktop/DesktopConnectedExperience.tsx new file mode 100644 index 000000000..9e769cdaf --- /dev/null +++ b/propr-ui/src/desktop/DesktopConnectedExperience.tsx @@ -0,0 +1,90 @@ +import React, { useEffect, useState } from 'react'; +import type { RefObject } from 'react'; +import { Plus, X } from 'lucide-react'; +import { DesktopContext } from './DesktopContext'; +import { ProfileEditor, ProfileList } from './DesktopExperiencePanels'; +import type { DesktopAdapters, DesktopConnectionResult, DesktopProfile } from './types'; + +interface DesktopConnectedExperienceProps { + adapters: DesktopAdapters; + profile: DesktopProfile; + result: Extract; + profiles: DesktopProfile[]; + managerOpen: boolean; + managerRef: RefObject; + editing: DesktopProfile | 'new' | null; + operationError: string | null; + deepLinkError: string | null; + editorNotice: string | null; + hasPendingConnectCandidate: boolean; + children: React.ReactNode; + openManager(): void; + closeManager(): void; + closeEditor(): void; + openEditor(profile: DesktopProfile | 'new'): void; + connect(profile: DesktopProfile): Promise; + removeProfile(profile: DesktopProfile): Promise; + saveProfile(profile: DesktopProfile, shouldConnect?: boolean): Promise; + retry(): void; + setManagerOpen(open: boolean): void; +} + +export const DesktopConnectedExperience: React.FC = ({ + adapters, profile, result, profiles, managerOpen, managerRef, editing, + operationError, deepLinkError, editorNotice, hasPendingConnectCandidate, + children, openManager, closeManager, closeEditor, openEditor, connect, + removeProfile, saveProfile, retry, setManagerOpen, +}) => { + const [networkOffline, setNetworkOffline] = useState(!navigator.onLine); + + useEffect(() => { + const online = () => setNetworkOffline(false); + const offline = () => setNetworkOffline(true); + window.addEventListener('online', online); + window.addEventListener('offline', offline); + return () => { + window.removeEventListener('online', online); + window.removeEventListener('offline', offline); + }; + }, []); + + const displayedConnection: DesktopConnectionResult = networkOffline + ? { status: 'offline', message: 'This computer is offline.' } + : result; + const contextValue = { + isDesktop: true as const, + platform: adapters.platform, + profile, + connection: displayedConnection, + openProfileManager: openManager, + authenticate: () => adapters.authentication.authenticate(profile), + openConnectionHelp: () => adapters.externalBrowser.open('https://propr.dev'), + retry, + ...(adapters.acceptance ? { + reportConnectedRendererReady: () => adapters.acceptance!.reportJourneyStage('REACT_CONNECTED'), + } : {}), + }; + + return ( + + {deepLinkError &&
{deepLinkError}
} +
{children}
+ {managerOpen && ( +
{ if (event.target === event.currentTarget) closeManager(); }}> +
+
Desktop

Manage instances

+ {editing ? ( + void saveProfile(editedProfile, hasPendingConnectCandidate || editing === 'new' || profile.id === editedProfile.id)} /> + ) : ( + <> + {operationError &&
{operationError}
} + { setManagerOpen(false); void connect(nextProfile); }} onEdit={openEditor} onRemove={nextProfile => void removeProfile(nextProfile)} /> + + + )} +
+
+ )} + + ); +}; diff --git a/propr-ui/src/desktop/DesktopContext.tsx b/propr-ui/src/desktop/DesktopContext.tsx index 8113b5d88..86c1db8b0 100644 --- a/propr-ui/src/desktop/DesktopContext.tsx +++ b/propr-ui/src/desktop/DesktopContext.tsx @@ -11,6 +11,8 @@ export interface DesktopContextValue { authenticate(): Promise; openConnectionHelp(): Promise; retry(): void; + /** @internal Packaged acceptance signal owned by the committed connected renderer. */ + reportConnectedRendererReady?(): Promise; } export const DesktopContext = createContext(null); diff --git a/propr-ui/src/desktop/DesktopExperience.authentication.test.tsx b/propr-ui/src/desktop/DesktopExperience.authentication.test.tsx new file mode 100644 index 000000000..a42fb1fe7 --- /dev/null +++ b/propr-ui/src/desktop/DesktopExperience.authentication.test.tsx @@ -0,0 +1,87 @@ +import { act, fireEvent, render, screen, waitFor } from '@testing-library/react'; +import { beforeEach, describe, expect, it, vi } from 'vitest'; +import { DesktopExperience } from './DesktopExperience'; +import { DesktopTitleBar } from './DesktopTitleBar'; +import { adaptersFor, remoteProfile } from './DesktopExperience.testSupport'; + +const apiMock = vi.hoisted(() => ({ setApiBaseUrl: vi.fn() })); +const runtimeMock = vi.hoisted(() => ({ setDesktopApiBaseUrl: vi.fn() })); + +vi.mock('../api/apiClient', () => ({ setApiBaseUrl: apiMock.setApiBaseUrl })); +vi.mock('../config/runtimeConfig', () => ({ setDesktopApiBaseUrl: runtimeMock.setDesktopApiBaseUrl })); + +describe('DesktopExperience authentication', () => { + beforeEach(() => { + vi.clearAllMocks(); + }); + + it('publishes the connected renderer only after its authenticated transport is ready', async () => { + const probe = vi.fn() + .mockResolvedValueOnce({ status: 'authentication-required', message: 'Please sign in.' }) + .mockResolvedValueOnce({ status: 'ready', version: '0.8.15' }); + const adapters = adaptersFor([remoteProfile], remoteProfile.id, probe); + const stages: string[] = []; + adapters.acceptance = { + reportJourneyStage: vi.fn(async stage => { + if (stage === 'REACT_CONNECTED') { + expect(document.querySelector('.desktop-connection-pill.desktop-connection-ready')).toBeInstanceOf(HTMLButtonElement); + } + stages.push(stage); + }), + }; + const connectedApp = (transportReady: boolean) => ( + + +
Connected app
+ + ); + const view = render(connectedApp(false)); + + fireEvent.click(await screen.findByRole('button', { name: /Sign in in browser/i })); + + expect(await screen.findByText('Connected app')).toBeInTheDocument(); + expect(adapters.authentication.authenticate).toHaveBeenCalledWith(remoteProfile); + expect(probe).toHaveBeenCalledTimes(2); + await act(async () => { await new Promise(resolve => setTimeout(resolve, 0)); }); + expect(stages).toEqual([ + 'AUTHENTICATION_REQUIRED', + 'CREDENTIAL_COMMITTED', + 'AUTHENTICATED_REPROBE_READY', + 'ACTIVATION_COMMITTED', + 'ACTIVATION_PUBLISHED', + ]); + + // Model the slower ARM64 ordering: React has committed the connected shell, + // but authenticated REST and the scoped Socket.IO handshake complete later. + view.rerender(connectedApp(true)); + await waitFor(() => expect(stages).toEqual([ + 'AUTHENTICATION_REQUIRED', + 'CREDENTIAL_COMMITTED', + 'AUTHENTICATED_REPROBE_READY', + 'ACTIVATION_COMMITTED', + 'ACTIVATION_PUBLISHED', + 'REACT_CONNECTED', + ])); + }); + + it('reports rejected authentication and connection-help operations in the blocked panel', async () => { + const adapters = adaptersFor( + [remoteProfile], + remoteProfile.id, + async () => ({ status: 'authentication-required', message: 'Please sign in.' }) + ); + vi.mocked(adapters.authentication.authenticate).mockRejectedValueOnce(new Error('Browser launch failed.')); + vi.mocked(adapters.externalBrowser.open).mockRejectedValueOnce(new Error('No browser is configured.')); + render(
Connected app
); + + fireEvent.click(await screen.findByRole('button', { name: /Sign in in browser/i })); + expect(await screen.findByText(/could not open sign in.*try again/i)).toBeInTheDocument(); + expect(screen.queryByText(/browser launch failed/i)).not.toBeInTheDocument(); + expect(screen.getByRole('button', { name: /Sign in in browser/i })).toBeInTheDocument(); + + fireEvent.click(screen.getByRole('button', { name: /Open connection help/i })); + expect(await screen.findByText(/could not open connection help.*try again/i)).toBeInTheDocument(); + expect(screen.queryByText(/no browser is configured/i)).not.toBeInTheDocument(); + expect(screen.getByRole('button', { name: /Open connection help/i })).toBeInTheDocument(); + }); +}); diff --git a/propr-ui/src/desktop/DesktopExperience.discovery.test.tsx b/propr-ui/src/desktop/DesktopExperience.discovery.test.tsx new file mode 100644 index 000000000..8f8468cd5 --- /dev/null +++ b/propr-ui/src/desktop/DesktopExperience.discovery.test.tsx @@ -0,0 +1,161 @@ +import { act, fireEvent, render, screen, waitFor } from '@testing-library/react'; +import { describe, expect, it, vi } from 'vitest'; +import type { App, IpcMain, IpcMainInvokeEvent, Session } from 'electron'; +import type { ConnectStatusDocument } from '@propr/cli/desktop-discovery'; +import { DesktopConnectDiscoveryService } from '../../../apps/desktop/src/connect-discovery'; +import type { DesktopCredentialService } from '../../../apps/desktop/src/credential-service'; +import { registerIpcHandlers } from '../../../apps/desktop/src/ipc'; +import type { LocalLifecycleController } from '../../../apps/desktop/src/lifecycle'; +import type { DesktopLogger } from '../../../apps/desktop/src/logger'; +import { createDesktopBridge, type PreloadIpc } from '../../../apps/desktop/src/preload-bridge'; +import type { ProfileStore } from '../../../apps/desktop/src/profile-store'; +import { IPC_CHANNELS } from '../../../apps/desktop/src/shared/contract'; +import { DesktopExperience } from './DesktopExperience'; +import { createElectronDesktopAdapters } from './electronAdapters'; +import type { DesktopAdapters, DesktopConnectionResult, DesktopProfile } from './types'; + +vi.mock('../api/apiClient', () => ({ + getDesktopConnectionScope: () => null, + setApiBaseUrl: vi.fn(), + setDesktopConnectionScope: vi.fn(), +})); +vi.mock('../config/runtimeConfig', () => ({ setDesktopApiBaseUrl: vi.fn() })); + +const rendererUrl = 'propr-app://renderer/renderer.html'; + +const readyStatus: ConnectStatusDocument = { + schemaVersion: 1, + status: 'ready', + canonicalEndpoint: 'https://t-discovered123.propr.dev', + publicInstanceIdentity: '123e4567-e89b-42d3-a456-426614174000', + configured: true, + enabled: true, + sidecarRunning: true, + apiReady: true, + restartRequired: false, + compatibility: '2026-08-01', + version: '0.8.15', + reasonCodes: [], +}; + +const savedProfile: DesktopProfile = { + id: 'saved', name: 'Saved instance', baseUrl: 'https://saved.example.test', kind: 'remote', +}; + +const deferred = () => { + let resolve!: (value: T) => void; + let reject!: (reason?: unknown) => void; + const promise = new Promise((resolvePromise, rejectPromise) => { + resolve = resolvePromise; reject = rejectPromise; + }); + return { promise, resolve, reject }; +}; + +const adaptersWithDiscovery = (discover: DesktopAdapters['discovery']['discover']): DesktopAdapters => ({ + platform: 'linux', + app: { onDeepLink: () => () => undefined }, + profiles: { + list: vi.fn(async () => [savedProfile]), save: vi.fn(async () => undefined), + remove: vi.fn(async () => undefined), getActiveId: vi.fn(async () => null), + setActiveId: vi.fn(async () => undefined), + }, + discovery: { supported: true, discover }, + authentication: { authenticate: vi.fn(async () => undefined) }, + externalBrowser: { open: vi.fn(async () => undefined) }, + localSetup: { supported: false, setup: vi.fn(async () => savedProfile) }, + connection: { probe: vi.fn(async (): Promise => ({ status: 'ready' })) }, +}); + +describe('DesktopExperience production Connect discovery pipeline', () => { + it('flows fixed-root main discovery through IPC, preload, and Electron adapters without persistence', async () => { + type InvokeHandler = (event: IpcMainInvokeEvent, ...args: unknown[]) => unknown; + const handlers = new Map(); + const invocations: Array<{ channel: string; args: unknown[] }> = []; + const credentials = { + listProfiles: vi.fn(async () => ({ profiles: [], activeProfileId: null })), + saveProfile: vi.fn(), + } as unknown as DesktopCredentialService; + const connectDiscovery = new DesktopConnectDiscoveryService({ + list: async () => ({ profiles: [], activeProfileId: null }), + }, { + supported: true, + discover: async () => readyStatus, + }); + const registered = registerIpcHandlers({ + app: { getName: () => 'ProPR', getVersion: () => '0.8.15', isPackaged: true } as unknown as App, + ipcMain: { + handle: (channel: string, handler: InvokeHandler) => { handlers.set(channel, handler); }, + removeHandler: (channel: string) => { handlers.delete(channel); }, + } as unknown as IpcMain, + profiles: {} as ProfileStore, + credentials, + connectDiscovery, + lifecycle: {} as LocalLifecycleController, + logger: { log: () => undefined } as unknown as DesktopLogger, + desktopSession: {} as Session, + devServerUrl: undefined, + packagedRendererUrl: rendererUrl, + openExternal: async () => undefined, + }); + const event = { senderFrame: { url: rendererUrl } } as unknown as IpcMainInvokeEvent; + const ipc: PreloadIpc = { + invoke: (channel, ...args) => { + invocations.push({ channel, args }); + return Promise.resolve(handlers.get(channel)!(event, ...args)); + }, + on: () => undefined, + removeListener: () => undefined, + }; + const adapters = createElectronDesktopAdapters(createDesktopBridge(ipc, true)); + + render(
Connected app
); + fireEvent.click(await screen.findByRole('button', { name: /Search for instances on this network/i })); + + expect(await screen.findByRole('heading', { name: 'Edit instance' })).toBeInTheDocument(); + expect(screen.getByRole('status')).toHaveTextContent('Verified ProPR Connect endpoint'); + expect(screen.getByLabelText('Instance URL')).toHaveValue('https://t-discovered123.propr.dev'); + expect(credentials.saveProfile).not.toHaveBeenCalled(); + await waitFor(() => expect(invocations).toContainEqual({ + channel: IPC_CHANNELS.connectDiscover, + args: [], + })); + expect(invocations.find(item => item.channel === IPC_CHANNELS.connectDiscover)?.args).toEqual([]); + registered.dispose(); + }); + + it('discards a late discovery success after an editor action', async () => { + const pending = deferred(); + const adapters = adaptersWithDiscovery(() => pending.promise); + render(
Connected app
); + + fireEvent.click(await screen.findByRole('button', { name: /Search for instances on this network/i })); + fireEvent.click(screen.getByRole('button', { name: 'Edit Saved instance' })); + expect(await screen.findByRole('heading', { name: 'Edit instance' })).toBeInTheDocument(); + expect(screen.getByLabelText('Instance URL')).toHaveValue(savedProfile.baseUrl); + + await act(() => { + pending.resolve([{ + id: 'late', name: 'Late discovery', + baseUrl: 'https://t-late123.propr.dev', kind: 'remote', + }]); + return pending.promise; + }); + expect(screen.getByLabelText('Instance URL')).toHaveValue(savedProfile.baseUrl); + expect(screen.queryByText('Late discovery')).not.toBeInTheDocument(); + fireEvent.click(screen.getByRole('button', { name: 'Back' })); + expect(await screen.findByRole('button', { name: /Search for instances on this network/i })).toBeEnabled(); + }); + + it('discards a late discovery error after a competing connection action', async () => { + const pending = deferred(); + const adapters = adaptersWithDiscovery(() => pending.promise); + render(
Connected app
); + + fireEvent.click(await screen.findByRole('button', { name: /Search for instances on this network/i })); + fireEvent.click(screen.getByRole('button', { name: /^Saved instance/ })); + await act(async () => { pending.reject(new Error('native path SENTINEL')); await Promise.resolve(); }); + + expect(await screen.findByText('Connected app')).toBeInTheDocument(); + expect(screen.queryByText(/Network discovery is unavailable/)).not.toBeInTheDocument(); + }); +}); diff --git a/propr-ui/src/desktop/DesktopExperience.management.test.tsx b/propr-ui/src/desktop/DesktopExperience.management.test.tsx new file mode 100644 index 000000000..fdc0fa2f8 --- /dev/null +++ b/propr-ui/src/desktop/DesktopExperience.management.test.tsx @@ -0,0 +1,263 @@ +import { act, fireEvent, render, screen } from '@testing-library/react'; +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; +import { DesktopExperience } from './DesktopExperience'; +import { DesktopTitleBar } from './DesktopTitleBar'; +import type { DesktopAdapters, DesktopConnectionResult, DesktopProfile } from './types'; + +const apiMock = vi.hoisted(() => ({ setApiBaseUrl: vi.fn() })); +const runtimeMock = vi.hoisted(() => ({ setDesktopApiBaseUrl: vi.fn() })); + +vi.mock('../api/apiClient', () => ({ setApiBaseUrl: apiMock.setApiBaseUrl })); +vi.mock('../config/runtimeConfig', () => ({ setDesktopApiBaseUrl: runtimeMock.setDesktopApiBaseUrl })); + +const localProfile: DesktopProfile = { + id: 'local', + name: 'This computer', + baseUrl: 'http://127.0.0.1:3000', + kind: 'local', +}; + +const remoteProfile: DesktopProfile = { + id: 'remote', + name: 'Team server', + baseUrl: 'https://propr.example.com', + kind: 'remote', +}; + +const connectedApp = <>
Connected app
; +const deferred = () => { + let resolve!: (value: T) => void; + const promise = new Promise(settle => { resolve = settle; }); + return { promise, resolve }; +}; + +const adaptersFor = ( + profiles: DesktopProfile[] = [], + activeId: string | null = null, + probe: (profile: DesktopProfile) => Promise = + async () => ({ status: 'ready', version: '0.8.15' }), +): DesktopAdapters => ({ + platform: 'linux', + app: { onDeepLink: () => () => undefined }, + profiles: { + list: vi.fn(async () => profiles), + save: vi.fn(async () => undefined), + remove: vi.fn(async () => undefined), + getActiveId: vi.fn(async () => activeId), + setActiveId: vi.fn(async () => undefined), + }, + discovery: { supported: true, discover: vi.fn(async () => []) }, + authentication: { authenticate: vi.fn(async () => undefined) }, + externalBrowser: { open: vi.fn(async () => undefined) }, + localSetup: { supported: true, setup: vi.fn(async () => localProfile) }, + connection: { probe: vi.fn(probe) }, +}); + +describe('DesktopExperience profile management', () => { + beforeEach(() => { + vi.clearAllMocks(); + vi.spyOn(window, 'confirm').mockReturnValue(true); + }); + + afterEach(() => { + vi.restoreAllMocks(); + }); + + it('reconnects an edited active instance but saves an inactive edit without connecting', async () => { + const adapters = adaptersFor([localProfile, remoteProfile], localProfile.id); + render({connectedApp}); + + expect(await screen.findByRole('button', { name: 'Connected: This computer' })).toBeInTheDocument(); + vi.clearAllMocks(); + fireEvent.keyDown(document, { key: ',', ctrlKey: true }); + fireEvent.click(await screen.findByRole('button', { name: 'Edit This computer' })); + fireEvent.change(screen.getByLabelText('Instance URL'), { target: { value: 'https://active.example.com/' } }); + fireEvent.click(screen.getByRole('button', { name: 'Save changes' })); + + expect(await screen.findByRole('button', { name: 'Connected: This computer' })).toBeInTheDocument(); + expect(adapters.connection.probe).toHaveBeenCalledWith(expect.objectContaining({ baseUrl: 'https://active.example.com' })); + expect(adapters.profiles.save).toHaveBeenCalledWith(expect.objectContaining({ baseUrl: 'https://active.example.com' })); + expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); + expect(apiMock.setApiBaseUrl).toHaveBeenLastCalledWith('https://active.example.com'); + + vi.clearAllMocks(); + fireEvent.keyDown(document, { key: ',', ctrlKey: true }); + fireEvent.click(await screen.findByRole('button', { name: 'Edit Team server' })); + fireEvent.change(screen.getByLabelText('Display name'), { target: { value: 'Renamed team server' } }); + fireEvent.click(screen.getByRole('button', { name: 'Save changes' })); + + expect(await screen.findByText('Renamed team server')).toBeInTheDocument(); + expect(adapters.profiles.save).toHaveBeenCalledWith(expect.objectContaining({ id: 'remote', name: 'Renamed team server' })); + expect(adapters.connection.probe).not.toHaveBeenCalled(); + expect(apiMock.setApiBaseUrl).not.toHaveBeenCalled(); + }); + + it('does not persist an active profile edit until the updated connection is ready', async () => { + const probe = vi.fn() + .mockResolvedValueOnce({ status: 'ready', version: '0.8.15' }) + .mockResolvedValueOnce({ status: 'offline', message: 'The updated server is unavailable.' }); + const adapters = adaptersFor([localProfile], localProfile.id, probe); + render({connectedApp}); + + expect(await screen.findByRole('button', { name: 'Connected: This computer' })).toBeInTheDocument(); + vi.clearAllMocks(); + fireEvent.keyDown(document, { key: ',', ctrlKey: true }); + fireEvent.click(await screen.findByRole('button', { name: 'Edit This computer' })); + fireEvent.change(screen.getByLabelText('Instance URL'), { target: { value: 'https://unavailable.example.com/' } }); + fireEvent.click(screen.getByRole('button', { name: 'Save changes' })); + + expect(await screen.findByText(/could not reach this instance.*try again/i)).toBeInTheDocument(); + expect(document.body).not.toHaveTextContent('The updated server is unavailable.'); + expect(adapters.profiles.save).not.toHaveBeenCalled(); + expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); + expect(runtimeMock.setDesktopApiBaseUrl).not.toHaveBeenCalled(); + expect(apiMock.setApiBaseUrl).not.toHaveBeenCalled(); + }); + + it('keeps a failed save in the manager editor so it can be retried', async () => { + const adapters = adaptersFor([localProfile, remoteProfile], localProfile.id); + vi.mocked(adapters.profiles.save) + .mockResolvedValueOnce(undefined) + .mockRejectedValueOnce(new Error('Profile storage is locked.')) + .mockResolvedValueOnce(undefined); + render(
Connected app
); + + expect(await screen.findByText('Connected app')).toBeInTheDocument(); + fireEvent.keyDown(document, { key: ',', ctrlKey: true }); + fireEvent.click(await screen.findByRole('button', { name: 'Edit Team server' })); + fireEvent.change(screen.getByLabelText('Display name'), { target: { value: 'Retryable edit' } }); + fireEvent.click(screen.getByRole('button', { name: 'Save changes' })); + + expect(await screen.findByRole('alert')).toHaveTextContent(/could not save this instance.*try again/i); + expect(document.body).not.toHaveTextContent('Profile storage is locked.'); + expect(screen.getByLabelText('Display name')).toHaveValue('Retryable edit'); + fireEvent.click(screen.getByRole('button', { name: 'Save changes' })); + expect(await screen.findByText('Retryable edit')).toBeInTheDocument(); + }); + + it('keeps a profile visible and reports a rejected removal', async () => { + const adapters = adaptersFor([remoteProfile]); + vi.mocked(adapters.profiles.remove).mockRejectedValueOnce(new Error('Profile storage is locked.')); + render(
Connected app
); + + expect(await screen.findByText('Team server')).toBeInTheDocument(); + fireEvent.click(screen.getByRole('button', { name: 'Remove Team server' })); + + expect(await screen.findByRole('alert')).toHaveTextContent(/could not remove this instance.*try again/i); + expect(document.body).not.toHaveTextContent('Profile storage is locked.'); + expect(screen.getByText('Team server')).toBeInTheDocument(); + expect(adapters.profiles.remove).toHaveBeenCalledWith(remoteProfile.id); + }); + + it('reconnects after authentication completes and advances to the connected app', async () => { + const probe = vi.fn() + .mockResolvedValueOnce({ status: 'authentication-required', message: 'Please sign in.' }) + .mockResolvedValueOnce({ status: 'ready', version: '0.8.15' }); + const adapters = adaptersFor([remoteProfile], remoteProfile.id, probe); + render(
Connected app
); + + fireEvent.click(await screen.findByRole('button', { name: /Sign in in browser/i })); + + expect(await screen.findByText('Connected app')).toBeInTheDocument(); + expect(adapters.authentication.authenticate).toHaveBeenCalledWith(remoteProfile); + expect(probe).toHaveBeenCalledTimes(2); + }); + + it('reports rejected authentication and connection-help operations in the blocked panel', async () => { + const adapters = adaptersFor( + [remoteProfile], + remoteProfile.id, + async () => ({ status: 'authentication-required', message: 'Please sign in.' }), + ); + vi.mocked(adapters.authentication.authenticate).mockRejectedValueOnce(new Error('Browser launch failed.')); + vi.mocked(adapters.externalBrowser.open).mockRejectedValueOnce(new Error('No browser is configured.')); + render(
Connected app
); + + fireEvent.click(await screen.findByRole('button', { name: /Sign in in browser/i })); + expect(await screen.findByText(/could not open sign in.*try again/i)).toBeInTheDocument(); + expect(document.body).not.toHaveTextContent('Browser launch failed.'); + expect(screen.getByRole('button', { name: /Sign in in browser/i })).toBeInTheDocument(); + + fireEvent.click(screen.getByRole('button', { name: /Open connection help/i })); + expect(await screen.findByText(/could not open connection help.*try again/i)).toBeInTheDocument(); + expect(document.body).not.toHaveTextContent('No browser is configured.'); + expect(screen.getByRole('button', { name: /Open connection help/i })).toBeInTheDocument(); + }); + + it.each(['macos', 'windows'] as const)('offers remote connection guidance instead of local setup on %s', async platform => { + const adapters = adaptersFor(); + adapters.platform = platform; + adapters.localSetup.supported = false; + render(
Connected app
); + + expect(await screen.findByRole('heading', { name: 'Connect to ProPR' })).toBeInTheDocument(); + expect(screen.queryByRole('button', { name: /Set up this computer/i })).not.toBeInTheDocument(); + expect(screen.getByText(/local setup is currently available on Linux/i)).toBeInTheDocument(); + expect(screen.getByRole('button', { name: /Connect to an existing instance/i })).toBeInTheDocument(); + }); + + it('hides unsupported local setup when the adapter reports Linux', async () => { + const adapters = adaptersFor(); + adapters.localSetup.supported = false; + render(
Connected app
); + + expect(await screen.findByRole('heading', { name: 'Connect to ProPR' })).toBeInTheDocument(); + expect(screen.queryByRole('button', { name: /Set up this computer/i })).not.toBeInTheDocument(); + expect(adapters.localSetup.setup).not.toHaveBeenCalled(); + }); + + it('keeps management ready after out-of-order profile loading and a concurrent status refresh', async () => { + const listed = deferred(); + const selected = deferred(); + const probed = deferred(); + const adapters = adaptersFor(); + vi.mocked(adapters.profiles.list).mockImplementation(() => listed.promise); + vi.mocked(adapters.profiles.getActiveId).mockImplementation(() => selected.promise); + vi.mocked(adapters.connection.probe).mockImplementation(() => probed.promise); + render({connectedApp}); + + await act(async () => { selected.resolve(localProfile.id); }); + expect(screen.getByText('Opening ProPR…')).toBeInTheDocument(); + await act(async () => { listed.resolve([localProfile, remoteProfile]); }); + expect(await screen.findByRole('heading', { name: 'Connecting to This computer' })).toBeInTheDocument(); + await act(async () => { probed.resolve({ status: 'ready', version: '0.8.15' }); }); + + expect(await screen.findByRole('button', { name: 'Connected: This computer' })).toBeInTheDocument(); + fireEvent(window, new Event('offline')); + expect(await screen.findByRole('button', { name: 'Offline: This computer' })).toBeInTheDocument(); + fireEvent(window, new Event('online')); + expect(await screen.findByRole('button', { name: 'Connected: This computer' })).toBeInTheDocument(); + fireEvent.keyDown(document, { key: ',', ctrlKey: true }); + fireEvent.click(await screen.findByRole('button', { name: 'Edit This computer' })); + expect(screen.getByLabelText('Display name')).toHaveValue('This computer'); + expect(screen.queryByText('Opening ProPR…')).not.toBeInTheDocument(); + }); + + it('ignores late profile and status resolutions after unmount without stale publication', async () => { + const listed = deferred(); + const selected = deferred(); + const adapters = adaptersFor(); + vi.mocked(adapters.profiles.list).mockImplementation(() => listed.promise); + vi.mocked(adapters.profiles.getActiveId).mockImplementation(() => selected.promise); + const error = vi.spyOn(console, 'error').mockImplementation(() => undefined); + const first = render({connectedApp}); + first.unmount(); + await act(async () => { + listed.resolve([localProfile]); + selected.resolve(localProfile.id); + await Promise.resolve(); + }); + expect(adapters.connection.probe).not.toHaveBeenCalled(); + + const probe = deferred(); + const probingAdapters = adaptersFor([localProfile], localProfile.id, () => probe.promise); + const second = render({connectedApp}); + expect(await screen.findByRole('heading', { name: 'Connecting to This computer' })).toBeInTheDocument(); + second.unmount(); + await act(async () => { probe.resolve({ status: 'ready', version: '0.8.15' }); }); + expect(probingAdapters.profiles.save).not.toHaveBeenCalled(); + expect(apiMock.setApiBaseUrl).not.toHaveBeenCalled(); + expect(runtimeMock.setDesktopApiBaseUrl).not.toHaveBeenCalled(); + expect(error).not.toHaveBeenCalled(); + }); +}); diff --git a/propr-ui/src/desktop/DesktopExperience.recovery.test.tsx b/propr-ui/src/desktop/DesktopExperience.recovery.test.tsx new file mode 100644 index 000000000..15ff7d425 --- /dev/null +++ b/propr-ui/src/desktop/DesktopExperience.recovery.test.tsx @@ -0,0 +1,225 @@ +import { act, fireEvent, render, screen, waitFor } from '@testing-library/react'; +import { beforeEach, describe, expect, it, vi } from 'vitest'; +import { DesktopExperience } from './DesktopExperience'; +import type { DesktopAdapters, DesktopConnectionResult, DesktopProfile } from './types'; + +const apiMock = vi.hoisted(() => ({ setApiBaseUrl: vi.fn() })); +const runtimeMock = vi.hoisted(() => ({ setDesktopApiBaseUrl: vi.fn() })); + +vi.mock('../api/apiClient', () => ({ setApiBaseUrl: apiMock.setApiBaseUrl })); +vi.mock('../config/runtimeConfig', () => ({ setDesktopApiBaseUrl: runtimeMock.setDesktopApiBaseUrl })); + +const savedProfile: DesktopProfile = { + id: 'opaque-profile-id', + name: 'Managed workspace', + baseUrl: 'https://t-stale123.propr.dev', + kind: 'remote', +}; + +const replacement: DesktopProfile = { + ...savedProfile, + baseUrl: 'https://t-restarted456.propr.dev', +}; + +const adaptersFor = ( + probe: (profile: DesktopProfile) => Promise = async () => ({ status: 'offline', message: 'offline' }), +): DesktopAdapters => ({ + platform: 'linux', + app: { onDeepLink: () => () => undefined }, + profiles: { + list: vi.fn(async () => [savedProfile]), + save: vi.fn(async () => undefined), + remove: vi.fn(async () => undefined), + getActiveId: vi.fn(async () => savedProfile.id), + setActiveId: vi.fn(async () => undefined), + }, + discovery: { supported: false, discover: vi.fn(async () => []) }, + authentication: { authenticate: vi.fn(async () => undefined) }, + externalBrowser: { open: vi.fn(async () => undefined) }, + localSetup: { supported: false, setup: vi.fn(async () => savedProfile) }, + connection: { probe: vi.fn(probe) }, +}); + +const deferred = () => { + let resolve!: (value: T) => void; + const promise = new Promise(complete => { resolve = complete; }); + return { promise, resolve }; +}; + +const renderOfflineProfile = async (adapters: DesktopAdapters) => { + render(
Dashboard content
); + return await screen.findByRole('button', { name: 'Rediscover Connect endpoint' }); +}; + +describe('DesktopExperience managed Connect recovery', () => { + beforeEach(() => vi.clearAllMocks()); + + it('shows bounded recovery guidance without endpoint or raw failure details', async () => { + const adapters = adaptersFor(async () => ({ + status: 'offline', + message: 'Failed at https://t-stale123.propr.dev?token=secret-sentinel', + })); + await renderOfflineProfile(adapters); + + expect(screen.getByText(/endpoint may be stale or the local stack may have restarted/i)).toBeInTheDocument(); + expect(screen.getByRole('button', { name: 'Retry' })).toBeInTheDocument(); + expect(screen.getByRole('button', { name: 'Re-enter Connect address' })).toBeInTheDocument(); + expect(document.body).not.toHaveTextContent('t-stale123.propr.dev'); + expect(document.body).not.toHaveTextContent('secret-sentinel'); + }); + + it('does not give renderer network discovery authority when the trusted adapter is absent', async () => { + const adapters = adaptersFor(); + vi.mocked(adapters.discovery.discover).mockResolvedValue([ + { ...savedProfile, id: 'unrelated', baseUrl: 'https://t-unrelated.propr.dev' }, + replacement, + ]); + fireEvent.click(await renderOfflineProfile(adapters)); + + expect(await screen.findByText(/rediscovery is unavailable.*re-enter/i)).toBeInTheDocument(); + expect(adapters.discovery.discover).not.toHaveBeenCalled(); + expect(adapters.profiles.save).not.toHaveBeenCalled(); + }); + + it.each([ + ['null result', null], + ['mismatched profile', { ...replacement, id: 'other-profile' }], + ['trailing slash', { ...replacement, baseUrl: `${replacement.baseUrl}/` }], + ['mixed case', { ...replacement, baseUrl: 'https://T-restarted456.propr.dev' }], + ['nested reserved host', { ...replacement, baseUrl: 'https://x.t-restarted456.propr.dev' }], + ['missing endpoint', { ...replacement, baseUrl: undefined } as unknown as DesktopProfile], + ])('keeps the saved profile untouched for a %s candidate', async (_case, candidate) => { + const adapters = adaptersFor(); + adapters.managedTunnelRecovery = { rediscover: vi.fn(async () => candidate) }; + fireEvent.click(await renderOfflineProfile(adapters)); + + expect(await screen.findByText(/rediscovery is unavailable.*re-enter/i)).toBeInTheDocument(); + expect(adapters.profiles.save).not.toHaveBeenCalled(); + expect(adapters.connection.probe).toHaveBeenCalledTimes(1); + }); + + it('keeps the saved profile untouched when trusted rediscovery rejects', async () => { + const adapters = adaptersFor(); + adapters.managedTunnelRecovery = { + rediscover: vi.fn(async () => { throw new Error('token-sentinel at /private/path'); }), + }; + fireEvent.click(await renderOfflineProfile(adapters)); + + expect(await screen.findByText(/rediscovery is unavailable.*re-enter/i)).toBeInTheDocument(); + expect(document.body).not.toHaveTextContent(/token-sentinel|private\/path/i); + expect(adapters.profiles.save).not.toHaveBeenCalled(); + }); + + it('identifies the bounded saved label, hides both endpoints, and requires confirmation', async () => { + const probe = vi.fn() + .mockResolvedValueOnce({ status: 'offline', message: 'offline' }) + .mockResolvedValueOnce({ status: 'ready', version: '0.8.15' }); + const adapters = adaptersFor(probe); + adapters.managedTunnelRecovery = { rediscover: vi.fn(async () => replacement) }; + fireEvent.click(await renderOfflineProfile(adapters)); + + expect(await screen.findByRole('heading', { name: 'Use the rediscovered endpoint?' })).toBeInTheDocument(); + expect(screen.getByText(/replacement endpoint was discovered for the saved connection “Managed workspace”/i)).toBeInTheDocument(); + expect(adapters.managedTunnelRecovery.rediscover).toHaveBeenCalledWith(savedProfile.id); + expect(adapters.profiles.save).not.toHaveBeenCalled(); + expect(document.body).not.toHaveTextContent(savedProfile.baseUrl); + expect(document.body).not.toHaveTextContent(replacement.baseUrl); + + fireEvent.click(screen.getByRole('button', { name: 'Connect to rediscovered endpoint' })); + expect(await screen.findByText('Dashboard content')).toBeInTheDocument(); + expect(adapters.profiles.save).toHaveBeenCalledWith(expect.objectContaining({ + id: savedProfile.id, + name: savedProfile.name, + baseUrl: replacement.baseUrl, + lastConnectedAt: expect.any(String), + })); + }); + + it('cancels confirmation without saving and preserves Retry and Re-enter recovery', async () => { + const adapters = adaptersFor(); + adapters.managedTunnelRecovery = { rediscover: vi.fn(async () => replacement) }; + fireEvent.click(await renderOfflineProfile(adapters)); + fireEvent.click(await screen.findByRole('button', { name: 'Keep saved connection' })); + + expect(await screen.findByRole('button', { name: 'Retry' })).toBeInTheDocument(); + expect(screen.getByRole('button', { name: 'Re-enter Connect address' })).toBeInTheDocument(); + expect(adapters.profiles.save).not.toHaveBeenCalled(); + }); + + it('falls back from an unsafe saved label without exposing label contents', async () => { + const unsafeLabel = 'https://old-host.example/private?token=label-secret'; + const adapters = adaptersFor(); + vi.mocked(adapters.profiles.list).mockResolvedValue([{ ...savedProfile, name: unsafeLabel }]); + adapters.managedTunnelRecovery = { rediscover: vi.fn(async () => replacement) }; + fireEvent.click(await renderOfflineProfile(adapters)); + + expect(await screen.findByText(/saved connection “Saved connection”/)).toBeInTheDocument(); + expect(document.body).not.toHaveTextContent(/old-host|private|label-secret/i); + }); + + it('fences a stale concurrent rediscovery result from the current confirmation', async () => { + const first = deferred(); + const second = deferred(); + const secondReplacement = { ...replacement, baseUrl: 'https://t-current789.propr.dev' }; + const probe = vi.fn() + .mockResolvedValueOnce({ status: 'offline', message: 'offline' }) + .mockResolvedValueOnce({ status: 'ready', version: '0.8.15' }); + const adapters = adaptersFor(probe); + adapters.managedTunnelRecovery = { + rediscover: vi.fn() + .mockImplementationOnce(() => first.promise) + .mockImplementationOnce(() => second.promise), + }; + const button = await renderOfflineProfile(adapters); + fireEvent.click(button); + fireEvent.click(button); + await act(async () => second.resolve(secondReplacement)); + expect(await screen.findByRole('heading', { name: 'Use the rediscovered endpoint?' })).toBeInTheDocument(); + await act(async () => first.resolve(replacement)); + + fireEvent.click(screen.getByRole('button', { name: 'Connect to rediscovered endpoint' })); + await waitFor(() => expect(probe).toHaveBeenLastCalledWith(expect.objectContaining({ + id: savedProfile.id, + baseUrl: secondReplacement.baseUrl, + }))); + expect(adapters.profiles.save).toHaveBeenCalledWith(expect.objectContaining({ baseUrl: secondReplacement.baseUrl })); + }); + + it('re-enters a managed address without exposing or overwriting the stale value', async () => { + const adapters = adaptersFor(); + const reenter = await renderOfflineProfile(adapters); + fireEvent.click(screen.getByRole('button', { name: 'Re-enter Connect address' })); + + expect(reenter).not.toBeInTheDocument(); + expect(screen.getByLabelText('Instance URL')).toHaveValue(''); + expect(document.body).not.toHaveTextContent(savedProfile.baseUrl); + expect(adapters.profiles.save).not.toHaveBeenCalled(); + }); + + it('turns a managed pairing failure into recovery without leaking the failure', async () => { + const adapters = adaptersFor(async () => ({ + status: 'authentication-required', + message: 'pair at private-path-sentinel', + })); + vi.mocked(adapters.authentication.authenticate).mockRejectedValueOnce( + new Error('password-sentinel at /Users/private/config'), + ); + render(
Dashboard content
); + fireEvent.click(await screen.findByRole('button', { name: 'Sign in in browser' })); + + expect(await screen.findByText(/pairing could not be completed.*try again/i)).toBeInTheDocument(); + expect(document.body).not.toHaveTextContent(/password-sentinel|Users\/private/i); + }); + + it('reports a managed connection-help failure as a bounded help error', async () => { + const adapters = adaptersFor(); + vi.mocked(adapters.externalBrowser.open).mockRejectedValueOnce( + new Error('browser-sentinel at /Users/private/config'), + ); + await renderOfflineProfile(adapters); + fireEvent.click(screen.getByRole('button', { name: 'Open connection help' })); + + expect(await screen.findByText(/could not open connection help.*try again/i)).toBeInTheDocument(); + expect(document.body).not.toHaveTextContent(/pairing could not be completed|browser-sentinel|Users\/private/i); + }); +}); diff --git a/propr-ui/src/desktop/DesktopExperience.test.tsx b/propr-ui/src/desktop/DesktopExperience.test.tsx index 24ff3e8a8..f5545dcb8 100644 --- a/propr-ui/src/desktop/DesktopExperience.test.tsx +++ b/propr-ui/src/desktop/DesktopExperience.test.tsx @@ -1,8 +1,9 @@ import { act, fireEvent, render, screen, waitFor } from '@testing-library/react'; import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; +import { DesktopDeepLinkInbox } from '../desktop-deep-link'; import { DesktopExperience } from './DesktopExperience'; -import { DesktopTitleBar } from './DesktopTitleBar'; -import type { DesktopAdapters, DesktopConnectionResult, DesktopProfile } from './types'; +import { adaptersFor, deferred, localProfile, remoteProfile, renderConnectedExperience } from './DesktopExperience.testSupport'; +import type { DesktopConnectionResult } from './types'; const apiMock = vi.hoisted(() => ({ setApiBaseUrl: vi.fn() })); const runtimeMock = vi.hoisted(() => ({ setDesktopApiBaseUrl: vi.fn() })); @@ -10,53 +11,6 @@ const runtimeMock = vi.hoisted(() => ({ setDesktopApiBaseUrl: vi.fn() })); vi.mock('../api/apiClient', () => ({ setApiBaseUrl: apiMock.setApiBaseUrl })); vi.mock('../config/runtimeConfig', () => ({ setDesktopApiBaseUrl: runtimeMock.setDesktopApiBaseUrl })); -const localProfile: DesktopProfile = { - id: 'local', - name: 'This computer', - baseUrl: 'http://127.0.0.1:3000', - kind: 'local', -}; - -const remoteProfile: DesktopProfile = { - id: 'remote', - name: 'Team server', - baseUrl: 'https://propr.example.com', - kind: 'remote', -}; - -const adaptersFor = ( - profiles: DesktopProfile[] = [], - activeId: string | null = null, - probe: (profile: DesktopProfile) => Promise = async () => ({ status: 'ready', version: '0.8.15' }) -): DesktopAdapters => ({ - platform: 'linux', - profiles: { - list: vi.fn(async () => profiles), - save: vi.fn(async () => undefined), - remove: vi.fn(async () => undefined), - getActiveId: vi.fn(async () => activeId), - setActiveId: vi.fn(async () => undefined), - }, - discovery: { discover: vi.fn(async () => []) }, - authentication: { authenticate: vi.fn(async () => undefined) }, - externalBrowser: { open: vi.fn(async () => undefined) }, - localSetup: { setup: vi.fn(async () => localProfile) }, - connection: { probe: vi.fn(probe) }, -}); - -function deferred() { - let resolve!: (value: T) => void; - const promise = new Promise(complete => { resolve = complete; }); - return { promise, resolve }; -} - -const renderConnectedExperience = (adapters: DesktopAdapters, content?: string) => render( - - - {content &&
{content}
} - -); - describe('DesktopExperience', () => { beforeEach(() => { vi.clearAllMocks(); @@ -67,6 +21,24 @@ describe('DesktopExperience', () => { vi.restoreAllMocks(); }); + it('offers network search only when the adapter has a real discovery provider', async () => { + const capable = adaptersFor(); + const { unmount } = render( +
Capable app
 + ); + const search = await screen.findByRole('button', { name: /Search for instances on this network/i }); + fireEvent.click(search); + await waitFor(() => expect(capable.discovery.discover).toHaveBeenCalledOnce()); + unmount(); + + const incapable = adaptersFor(); + incapable.discovery.supported = false; + render(
Incapable app
); + expect(await screen.findByRole('heading', { name: 'Let’s set up this computer' })).toBeInTheDocument(); + expect(screen.queryByRole('button', { name: /Search for instances on this network/i })).not.toBeInTheDocument(); + expect(incapable.discovery.discover).not.toHaveBeenCalled(); + }); + it('runs first-time local setup through adapters before mounting the shared app', async () => { const adapters = adaptersFor(); render(
Shared route tree
); @@ -85,128 +57,105 @@ describe('DesktopExperience', () => { expect(apiMock.setApiBaseUrl).toHaveBeenCalledWith(localProfile.baseUrl); }); - it('shows a retryable offline state and recovers without reloading', async () => { - const probe = vi.fn() - .mockResolvedValueOnce({ status: 'offline', message: 'The instance is offline.' }) - .mockResolvedValueOnce({ status: 'ready', version: '0.8.15' }); - const adapters = adaptersFor([localProfile], localProfile.id, probe); - render(
Dashboard content
); - - expect(await screen.findByRole('heading', { name: 'This computer' })).toBeInTheDocument(); - expect(screen.getByText('The instance is offline.')).toBeInTheDocument(); - fireEvent.click(screen.getByRole('button', { name: /Try again/i })); - - expect(await screen.findByText('Dashboard content')).toBeInTheDocument(); - expect(probe).toHaveBeenCalledTimes(2); - }); + it('stages a Connect deep link for confirmation with zero pre-confirmation effects', async () => { + const adapters = adaptersFor(); + adapters.connection.activate = vi.fn(async (_profile, result) => result); + adapters.connection.deactivate = vi.fn(); + const deepLinks = new DesktopDeepLinkInbox(); + render(
Shared route tree
); - it('shows a retryable failure when the connection adapter rejects', async () => { - const probe = vi.fn() - .mockRejectedValueOnce(new Error('The desktop host did not respond.')) - .mockResolvedValueOnce({ status: 'ready', version: '0.8.15' }); - const adapters = adaptersFor([localProfile], localProfile.id, probe); - render(
Dashboard content
); + expect(await screen.findByRole('heading', { name: 'Let’s set up this computer' })).toBeInTheDocument(); + vi.clearAllMocks(); + act(() => deepLinks.receive('propr://connect?api=https%3A%2F%2Fconnect.propr.dev')); - expect(await screen.findByText(/could not check this instance/i)).toBeInTheDocument(); - expect(screen.getByText(/desktop host did not respond/i)).toBeInTheDocument(); - fireEvent.click(screen.getByRole('button', { name: /Try again/i })); + expect(await screen.findByRole('status')).toHaveTextContent(/untrusted instance address/i); + expect(screen.getByLabelText('Instance URL')).toHaveValue('https://connect.propr.dev'); + expect(screen.getByRole('button', { name: 'Connect' })).toBeInTheDocument(); + expect(adapters.discovery.discover).not.toHaveBeenCalled(); + expect(adapters.connection.probe).not.toHaveBeenCalled(); + expect(adapters.connection.activate).not.toHaveBeenCalled(); + expect(adapters.authentication.authenticate).not.toHaveBeenCalled(); + expect(adapters.profiles.save).not.toHaveBeenCalled(); + expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); + expect(adapters.connection.deactivate).not.toHaveBeenCalled(); + expect(runtimeMock.setDesktopApiBaseUrl).not.toHaveBeenCalled(); + expect(apiMock.setApiBaseUrl).not.toHaveBeenCalled(); - expect(await screen.findByText('Dashboard content')).toBeInTheDocument(); - expect(probe).toHaveBeenCalledTimes(2); + fireEvent.click(screen.getByRole('button', { name: 'Connect' })); + await waitFor(() => expect(adapters.connection.probe).toHaveBeenCalledOnce()); + expect(adapters.profiles.save).toHaveBeenCalledOnce(); + expect(adapters.connection.activate).toHaveBeenCalledOnce(); }); - it('reports persistence failures distinctly and allows retrying', async () => { - const adapters = adaptersFor([localProfile], localProfile.id); - vi.mocked(adapters.profiles.save) - .mockRejectedValueOnce(new Error('Profile storage is unavailable.')) - .mockResolvedValueOnce(undefined); - render(
Dashboard content
); + it('returns from the prefilled profile editor to every packaged-layout chooser element', async () => { + const adapters = adaptersFor(); + const deepLinks = new DesktopDeepLinkInbox(); + render(
Shared route tree
); - expect(await screen.findByText(/could not save this connection/i)).toBeInTheDocument(); - expect(screen.getByText(/profile storage is unavailable/i)).toBeInTheDocument(); - expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); - fireEvent.click(screen.getByRole('button', { name: /Try again/i })); + expect(await screen.findByRole('heading', { name: 'Let’s set up this computer' })).toBeInTheDocument(); + act(() => deepLinks.receive('propr://connect?api=https%3A%2F%2Fconnect.propr.dev')); + expect(await screen.findByLabelText('Instance URL')).toHaveValue('https://connect.propr.dev'); - expect(await screen.findByText('Dashboard content')).toBeInTheDocument(); - expect(adapters.profiles.save).toHaveBeenCalledTimes(2); - expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); + fireEvent.click(screen.getByRole('button', { name: 'Back' })); + await screen.findByRole('heading', { name: 'Let’s set up this computer' }); + + for (const selector of [ + '.desktop-entry', + '.desktop-welcome-card', + '.desktop-welcome-card .desktop-brand img', + '.desktop-welcome-card .desktop-welcome-copy h1', + '.desktop-welcome-card .desktop-choice-button', + '.desktop-welcome-card .desktop-choice-button small', + ]) { + expect(document.querySelector(selector), selector).toBeVisible(); + } + expect(screen.queryByRole('button', { name: 'Back' })).not.toBeInTheDocument(); }); - it('ignores a stale connection result after the adapters change', async () => { - let resolveFirstProbe: ((result: DesktopConnectionResult) => void) | undefined; - const firstProbe = vi.fn(() => new Promise(resolve => { - resolveFirstProbe = resolve; - })); - const firstAdapters = adaptersFor([localProfile], localProfile.id, firstProbe); - const replacementProfile = { ...localProfile, id: 'replacement', name: 'Replacement instance' }; - const replacementAdapters = adaptersFor( - [replacementProfile], - replacementProfile.id, - async () => ({ status: 'offline', message: 'The replacement instance is unavailable.' }) - ); - const { rerender } = render( -
Stale dashboard
 - ); - - await waitFor(() => expect(firstProbe).toHaveBeenCalledOnce()); - rerender(
Replacement dashboard
); - expect(await screen.findByText('The replacement instance is unavailable.')).toBeInTheDocument(); + it('keeps Open deep-link navigation separate and bound to the active profile', async () => { + const adapters = adaptersFor([localProfile], localProfile.id); + const deepLinks = new DesktopDeepLinkInbox(); + window.location.hash = ''; + render(
Connected app
); - await act(async () => { - resolveFirstProbe?.({ status: 'ready', version: '0.8.15' }); - }); + expect(await screen.findByText('Connected app')).toBeInTheDocument(); + act(() => deepLinks.receive('propr://open?path=%2Ftasks%3Fstatus%3Dopen')); - expect(screen.getByText('The replacement instance is unavailable.')).toBeInTheDocument(); - expect(screen.queryByText('Stale dashboard')).not.toBeInTheDocument(); - expect(firstAdapters.profiles.save).not.toHaveBeenCalled(); + expect(window.location.hash).toBe('#/tasks?status=open'); + expect(screen.queryByLabelText('Instance URL')).not.toBeInTheDocument(); }); - it('serializes deferred persistence so the latest connection owns the stored profile and active ID', async () => { - const firstSave = deferred(); - let storedProfile: DesktopProfile | null = null; - let storedActiveId: string | null = null; - const adapters = adaptersFor([localProfile, remoteProfile]); - vi.mocked(adapters.profiles.save).mockImplementation(async profile => { - if (vi.mocked(adapters.profiles.save).mock.calls.length === 1) { - await firstSave.promise; - } - storedProfile = profile; - }); - vi.mocked(adapters.profiles.setActiveId).mockImplementation(async id => { storedActiveId = id; }); - render(
Latest dashboard
); - - expect(await screen.findByText('Recent instances')).toBeInTheDocument(); - fireEvent.click(screen.getByText('This computer').closest('button')!); - await waitFor(() => expect(adapters.profiles.save).toHaveBeenCalledOnce()); - - fireEvent.click(screen.getByRole('button', { name: 'Back' })); - fireEvent.click((await screen.findByText('Team server')).closest('button')!); - await waitFor(() => expect(adapters.connection.probe).toHaveBeenCalledWith(remoteProfile)); - expect(adapters.profiles.save).toHaveBeenCalledOnce(); + it('rejects malformed desktop links with a fixed redacted message and no effects', async () => { + const adapters = adaptersFor(); + const deepLinks = new DesktopDeepLinkInbox(); + render(
Shared route tree
); - await act(async () => { firstSave.resolve(); }); + expect(await screen.findByRole('heading', { name: 'Let’s set up this computer' })).toBeInTheDocument(); + vi.clearAllMocks(); + act(() => deepLinks.receive('propr://connect?api=SENTINEL_ATTACKER_VALUE&token=secret')); - expect(await screen.findByText('Latest dashboard')).toBeInTheDocument(); - expect(storedProfile).toMatchObject({ id: remoteProfile.id, baseUrl: remoteProfile.baseUrl }); - expect(storedActiveId).toBe(remoteProfile.id); - expect(adapters.profiles.setActiveId).toHaveBeenCalledTimes(1); + const alert = await screen.findByRole('alert'); + expect(alert).toHaveTextContent('ProPR Desktop could not use that link. Choose an instance and try again.'); + expect(alert).not.toHaveTextContent('SENTINEL_ATTACKER_VALUE'); + expect(adapters.connection.probe).not.toHaveBeenCalled(); + expect(adapters.authentication.authenticate).not.toHaveBeenCalled(); + expect(adapters.profiles.save).not.toHaveBeenCalled(); + expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); }); - it('offers Back while probing and prevents a cancelled probe from committing', async () => { - const pendingProbe = deferred(); - const adapters = adaptersFor([localProfile], null, () => pendingProbe.promise); - render(
Cancelled dashboard
); - - fireEvent.click((await screen.findByText('This computer')).closest('button')!); - expect(await screen.findByRole('heading', { name: 'Connecting to This computer' })).toBeInTheDocument(); - fireEvent.click(screen.getByRole('button', { name: 'Back' })); - expect(await screen.findByText('Recent instances')).toBeInTheDocument(); + it('identifies only a verified ProPR Connect endpoint while adding a profile', async () => { + const adapters = adaptersFor(); + render(
Shared route tree
); + fireEvent.click(await screen.findByRole('button', { name: /Connect to an existing instance/i })); - await act(async () => { pendingProbe.resolve({ status: 'ready', version: '0.8.15' }); }); + const input = screen.getByLabelText('Instance URL'); + fireEvent.change(input, { target: { value: 'https://t-instance123.propr.dev' } }); + expect(screen.getByRole('status')).toHaveTextContent('Verified ProPR Connect endpoint'); - expect(screen.queryByText('Cancelled dashboard')).not.toBeInTheDocument(); - expect(adapters.profiles.save).not.toHaveBeenCalled(); - expect(adapters.profiles.setActiveId).toHaveBeenCalledWith(null); + fireEvent.change(input, { target: { value: 'https://t-instance123.propr.dev:8443' } }); + expect(screen.queryByText('Verified ProPR Connect endpoint')).not.toBeInTheDocument(); + fireEvent.change(input, { target: { value: 'https://t-instance123.foo.propr.dev' } }); + expect(screen.queryByText('Verified ProPR Connect endpoint')).not.toBeInTheDocument(); }); it('supports editing a recent profile and connecting to the updated URL', async () => { @@ -224,6 +173,24 @@ describe('DesktopExperience', () => { id: 'local', name: 'Office ProPR', baseUrl: 'https://office.example.com', + kind: 'remote', + })); + }); + + it('derives a remote-to-loopback edit kind from the normalized submitted URL', async () => { + const adapters = adaptersFor([remoteProfile]); + render(
Connected app
); + + expect(await screen.findByText('Recent instances')).toBeInTheDocument(); + fireEvent.click(screen.getByRole('button', { name: 'Edit Team server' })); + fireEvent.change(screen.getByLabelText('Instance URL'), { target: { value: 'HTTP://LOCALHOST:3000/' } }); + fireEvent.click(screen.getByRole('button', { name: 'Save changes' })); + + expect(await screen.findByText('Connected app')).toBeInTheDocument(); + expect(adapters.profiles.save).toHaveBeenCalledWith(expect.objectContaining({ + id: remoteProfile.id, + baseUrl: 'http://localhost:3000', + kind: 'local', })); }); @@ -362,7 +329,7 @@ describe('DesktopExperience', () => { fireEvent.change(screen.getByLabelText('Instance URL'), { target: { value: 'https://unavailable.example.com/' } }); fireEvent.click(screen.getByRole('button', { name: 'Save changes' })); - expect(await screen.findByText('The updated server is unavailable.')).toBeInTheDocument(); + expect(await screen.findByText(/could not reach this instance/i)).toBeInTheDocument(); expect(adapters.profiles.save).not.toHaveBeenCalled(); expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); expect(runtimeMock.setDesktopApiBaseUrl).not.toHaveBeenCalled(); @@ -383,7 +350,8 @@ describe('DesktopExperience', () => { fireEvent.change(screen.getByLabelText('Display name'), { target: { value: 'Retryable edit' } }); fireEvent.click(screen.getByRole('button', { name: 'Save changes' })); - expect(await screen.findByRole('alert')).toHaveTextContent(/could not save this instance.*storage is locked.*try again/i); + expect(await screen.findByRole('alert')).toHaveTextContent(/could not save this instance.*try again/i); + expect(screen.getByRole('alert')).not.toHaveTextContent(/storage is locked/i); expect(screen.getByLabelText('Display name')).toHaveValue('Retryable edit'); fireEvent.click(screen.getByRole('button', { name: 'Save changes' })); expect(await screen.findByText('Retryable edit')).toBeInTheDocument(); @@ -397,44 +365,12 @@ describe('DesktopExperience', () => { expect(await screen.findByText('Team server')).toBeInTheDocument(); fireEvent.click(screen.getByRole('button', { name: 'Remove Team server' })); - expect(await screen.findByRole('alert')).toHaveTextContent(/could not remove this instance.*storage is locked.*try again/i); + expect(await screen.findByRole('alert')).toHaveTextContent(/could not remove this instance.*try again/i); + expect(screen.getByRole('alert')).not.toHaveTextContent(/storage is locked/i); expect(screen.getByText('Team server')).toBeInTheDocument(); expect(adapters.profiles.remove).toHaveBeenCalledWith(remoteProfile.id); }); - it('reconnects after authentication completes and advances to the connected app', async () => { - const probe = vi.fn() - .mockResolvedValueOnce({ status: 'authentication-required', message: 'Please sign in.' }) - .mockResolvedValueOnce({ status: 'ready', version: '0.8.15' }); - const adapters = adaptersFor([remoteProfile], remoteProfile.id, probe); - render(
Connected app
); - - fireEvent.click(await screen.findByRole('button', { name: /Sign in in browser/i })); - - expect(await screen.findByText('Connected app')).toBeInTheDocument(); - expect(adapters.authentication.authenticate).toHaveBeenCalledWith(remoteProfile); - expect(probe).toHaveBeenCalledTimes(2); - }); - - it('reports rejected authentication and connection-help operations in the blocked panel', async () => { - const adapters = adaptersFor( - [remoteProfile], - remoteProfile.id, - async () => ({ status: 'authentication-required', message: 'Please sign in.' }) - ); - vi.mocked(adapters.authentication.authenticate).mockRejectedValueOnce(new Error('Browser launch failed.')); - vi.mocked(adapters.externalBrowser.open).mockRejectedValueOnce(new Error('No browser is configured.')); - render(
Connected app
); - - fireEvent.click(await screen.findByRole('button', { name: /Sign in in browser/i })); - expect(await screen.findByText(/could not open sign in.*browser launch failed.*try again/i)).toBeInTheDocument(); - expect(screen.getByRole('button', { name: /Sign in in browser/i })).toBeInTheDocument(); - - fireEvent.click(screen.getByRole('button', { name: /Open connection help/i })); - expect(await screen.findByText(/could not open connection help.*no browser is configured.*try again/i)).toBeInTheDocument(); - expect(screen.getByRole('button', { name: /Open connection help/i })).toBeInTheDocument(); - }); - it.each(['macos', 'windows'] as const)('offers remote connection guidance instead of local setup on %s', async platform => { const adapters = adaptersFor(); adapters.platform = platform; diff --git a/propr-ui/src/desktop/DesktopExperience.testSupport.tsx b/propr-ui/src/desktop/DesktopExperience.testSupport.tsx new file mode 100644 index 000000000..193019a20 --- /dev/null +++ b/propr-ui/src/desktop/DesktopExperience.testSupport.tsx @@ -0,0 +1,53 @@ +import { render } from '@testing-library/react'; +import { vi } from 'vitest'; +import { DesktopExperience } from './DesktopExperience'; +import { DesktopTitleBar } from './DesktopTitleBar'; +import type { DesktopAdapters, DesktopConnectionResult, DesktopProfile } from './types'; + +export const localProfile: DesktopProfile = { + id: 'local', + name: 'This computer', + baseUrl: 'http://127.0.0.1:3000', + kind: 'local', +}; + +export const remoteProfile: DesktopProfile = { + id: 'remote', + name: 'Team server', + baseUrl: 'https://propr.example.com', + kind: 'remote', +}; + +export const adaptersFor = ( + profiles: DesktopProfile[] = [], + activeId: string | null = null, + probe: (profile: DesktopProfile) => Promise = async () => ({ status: 'ready', version: '0.8.15' }) +): DesktopAdapters => ({ + platform: 'linux', + app: { onDeepLink: () => () => undefined }, + profiles: { + list: vi.fn(async () => profiles), + save: vi.fn(async () => undefined), + remove: vi.fn(async () => undefined), + getActiveId: vi.fn(async () => activeId), + setActiveId: vi.fn(async () => undefined), + }, + discovery: { supported: true, discover: vi.fn(async () => []) }, + authentication: { authenticate: vi.fn(async () => undefined) }, + externalBrowser: { open: vi.fn(async () => undefined) }, + localSetup: { supported: true, setup: vi.fn(async () => localProfile) }, + connection: { probe: vi.fn(probe) }, +}); + +export function deferred() { + let resolve!: (value: T) => void; + const promise = new Promise(complete => { resolve = complete; }); + return { promise, resolve }; +} + +export const renderConnectedExperience = (adapters: DesktopAdapters, content?: string) => render( + + + {content &&
{content}
} + +); diff --git a/propr-ui/src/desktop/DesktopExperience.transport.test.tsx b/propr-ui/src/desktop/DesktopExperience.transport.test.tsx new file mode 100644 index 000000000..b183b1030 --- /dev/null +++ b/propr-ui/src/desktop/DesktopExperience.transport.test.tsx @@ -0,0 +1,276 @@ +import { act, fireEvent, render, screen, waitFor } from '@testing-library/react'; +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; +import { DesktopExperience } from './DesktopExperience'; +import { DESKTOP_ACCESS_INVALID_EVENT, type DesktopAdapters, type DesktopConnectionResult, type DesktopProfile } from './types'; + +const apiMock = vi.hoisted(() => ({ setApiBaseUrl: vi.fn() })); +const runtimeMock = vi.hoisted(() => ({ setDesktopApiBaseUrl: vi.fn() })); + +vi.mock('../api/apiClient', () => ({ setApiBaseUrl: apiMock.setApiBaseUrl })); +vi.mock('../config/runtimeConfig', () => ({ setDesktopApiBaseUrl: runtimeMock.setDesktopApiBaseUrl })); + +const localProfile: DesktopProfile = { + id: 'local', + name: 'This computer', + baseUrl: 'http://127.0.0.1:3000', + kind: 'local', +}; + +const remoteProfile: DesktopProfile = { + id: 'remote', + name: 'Team server', + baseUrl: 'https://propr.example.com', + kind: 'remote', +}; + +const adaptersFor = ( + profiles: DesktopProfile[] = [], + activeId: string | null = null, + probe: (profile: DesktopProfile) => Promise = async () => ({ status: 'ready', version: '0.8.15' }) +): DesktopAdapters => ({ + platform: 'linux', + app: { onDeepLink: () => () => undefined }, + profiles: { + list: vi.fn(async () => profiles), + save: vi.fn(async () => undefined), + remove: vi.fn(async () => undefined), + getActiveId: vi.fn(async () => activeId), + setActiveId: vi.fn(async () => undefined), + }, + discovery: { supported: true, discover: vi.fn(async () => []) }, + authentication: { authenticate: vi.fn(async () => undefined) }, + externalBrowser: { open: vi.fn(async () => undefined) }, + localSetup: { supported: true, setup: vi.fn(async () => localProfile) }, + connection: { probe: vi.fn(probe) }, +}); + +function deferred() { + let resolve!: (value: T) => void; + const promise = new Promise(complete => { resolve = complete; }); + return { promise, resolve }; +} + +describe('DesktopExperience transport and fencing', () => { + beforeEach(() => { + vi.clearAllMocks(); + vi.spyOn(window, 'confirm').mockReturnValue(true); + }); + + afterEach(() => { + vi.restoreAllMocks(); + }); + + it('shows a retryable offline state and recovers without reloading', async () => { + const probe = vi.fn() + .mockResolvedValueOnce({ status: 'offline', message: 'The instance is offline.' }) + .mockResolvedValueOnce({ status: 'ready', version: '0.8.15' }); + const adapters = adaptersFor([localProfile], localProfile.id, probe); + render(
Dashboard content
); + + expect(await screen.findByRole('heading', { name: 'This computer' })).toBeInTheDocument(); + expect(screen.getByText(/could not reach this instance/i)).toBeInTheDocument(); + fireEvent.click(screen.getByRole('button', { name: /Try again/i })); + + expect(await screen.findByText('Dashboard content')).toBeInTheDocument(); + expect(probe).toHaveBeenCalledTimes(2); + }); + + it('shows a retryable failure when the connection adapter rejects', async () => { + const probe = vi.fn() + .mockRejectedValueOnce(new Error('The desktop host did not respond.')) + .mockResolvedValueOnce({ status: 'ready', version: '0.8.15' }); + const adapters = adaptersFor([localProfile], localProfile.id, probe); + render(
Dashboard content
); + + expect(await screen.findByText(/could not check this instance/i)).toBeInTheDocument(); + expect(screen.queryByText(/desktop host did not respond/i)).not.toBeInTheDocument(); + fireEvent.click(screen.getByRole('button', { name: /Try again/i })); + + expect(await screen.findByText('Dashboard content')).toBeInTheDocument(); + expect(probe).toHaveBeenCalledTimes(2); + }); + + it('reports persistence failures distinctly and allows retrying', async () => { + const adapters = adaptersFor([localProfile], localProfile.id); + vi.mocked(adapters.profiles.save) + .mockRejectedValueOnce(new Error('Profile storage is unavailable.')) + .mockResolvedValueOnce(undefined); + render(
Dashboard content
); + + expect(await screen.findByText(/could not save this connection/i)).toBeInTheDocument(); + expect(screen.queryByText(/profile storage is unavailable/i)).not.toBeInTheDocument(); + expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); + fireEvent.click(screen.getByRole('button', { name: /Try again/i })); + + expect(await screen.findByText('Dashboard content')).toBeInTheDocument(); + expect(adapters.profiles.save).toHaveBeenCalledTimes(2); + expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); + }); + + it('uses one activation commit instead of renderer setActive and never publishes a failed B selection', async () => { + const probe = vi.fn(async (profile: DesktopProfile): Promise => ({ + status: 'ready', + version: '0.8.15', + activationTicket: `ticket-${profile.id}`, + })); + const adapters = adaptersFor([localProfile, remoteProfile], localProfile.id, probe); + adapters.connection.activate = vi.fn() + .mockResolvedValueOnce({ status: 'ready', transportScope: 'scope-a' }) + .mockRejectedValueOnce(new Error('Profile selection could not be written.')); + adapters.connection.publishActivation = vi.fn(); + render(
Connected app
); + + expect(await screen.findByText('Connected app')).toBeInTheDocument(); + expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); + expect(adapters.connection.publishActivation).toHaveBeenCalledTimes(1); + + fireEvent.keyDown(document, { key: ',', ctrlKey: true }); + fireEvent.click((await screen.findByText('Team server')).closest('button')!); + + expect(await screen.findByText(/could not save this connection/i)).toBeInTheDocument(); + expect(screen.queryByText(/selection could not be written/i)).not.toBeInTheDocument(); + expect(adapters.profiles.setActiveId).not.toHaveBeenCalled(); + expect(adapters.connection.publishActivation).toHaveBeenCalledTimes(1); + }); + + it('does not publish ready state when main activation reports a changed profile binding', async () => { + const adapters = adaptersFor([localProfile], localProfile.id); + adapters.connection.activate = vi.fn(async () => ({ + status: 'authentication-required' as const, + message: 'This connection changed while it was being activated.', + })); + adapters.connection.publishActivation = vi.fn(); + + render(
Wrong profile app
); + + expect(await screen.findByText(/connection changed while it was being activated/i)).toBeInTheDocument(); + expect(screen.queryByText('Wrong profile app')).not.toBeInTheDocument(); + expect(adapters.connection.publishActivation).not.toHaveBeenCalled(); + expect(runtimeMock.setDesktopApiBaseUrl).not.toHaveBeenCalled(); + expect(apiMock.setApiBaseUrl).not.toHaveBeenCalled(); + }); + + it('ignores a stale connection result after the adapters change', async () => { + let resolveFirstProbe: ((result: DesktopConnectionResult) => void) | undefined; + const firstProbe = vi.fn(() => new Promise(resolve => { + resolveFirstProbe = resolve; + })); + const firstAdapters = adaptersFor([localProfile], localProfile.id, firstProbe); + const replacementProfile = { ...localProfile, id: 'replacement', name: 'Replacement instance' }; + const replacementAdapters = adaptersFor( + [replacementProfile], + replacementProfile.id, + async () => ({ status: 'offline', message: 'The replacement instance is unavailable.' }) + ); + const { rerender } = render( +
Stale dashboard
 + ); + + await waitFor(() => expect(firstProbe).toHaveBeenCalledOnce()); + rerender(
Replacement dashboard
); + expect(await screen.findByText(/could not reach this instance/i)).toBeInTheDocument(); + + await act(async () => { + resolveFirstProbe?.({ status: 'ready', version: '0.8.15' }); + }); + + expect(screen.getByText(/could not reach this instance/i)).toBeInTheDocument(); + expect(screen.queryByText('Stale dashboard')).not.toBeInTheDocument(); + expect(firstAdapters.profiles.save).not.toHaveBeenCalled(); + }); + + it('serializes deferred persistence so the latest connection owns the stored profile and active ID', async () => { + const firstSave = deferred(); + let storedProfile: DesktopProfile | null = null; + let storedActiveId: string | null = null; + const adapters = adaptersFor([localProfile, remoteProfile]); + vi.mocked(adapters.profiles.save).mockImplementation(async profile => { + if (vi.mocked(adapters.profiles.save).mock.calls.length === 1) { + await firstSave.promise; + } + storedProfile = profile; + }); + vi.mocked(adapters.profiles.setActiveId).mockImplementation(async id => { storedActiveId = id; }); + render(
Latest dashboard
); + + expect(await screen.findByText('Recent instances')).toBeInTheDocument(); + fireEvent.click(screen.getByText('This computer').closest('button')!); + await waitFor(() => expect(adapters.profiles.save).toHaveBeenCalledOnce()); + + fireEvent.click(screen.getByRole('button', { name: 'Back' })); + fireEvent.click((await screen.findByText('Team server')).closest('button')!); + await waitFor(() => expect(adapters.connection.probe).toHaveBeenCalledWith(remoteProfile)); + expect(adapters.profiles.save).toHaveBeenCalledOnce(); + + await act(async () => { firstSave.resolve(); }); + + expect(await screen.findByText('Latest dashboard')).toBeInTheDocument(); + expect(storedProfile).toMatchObject({ id: remoteProfile.id, baseUrl: remoteProfile.baseUrl }); + expect(storedActiveId).toBe(remoteProfile.id); + expect(adapters.profiles.setActiveId).toHaveBeenCalledTimes(1); + }); + + it('offers Back while probing and prevents a cancelled probe from committing', async () => { + const pendingProbe = deferred(); + const adapters = adaptersFor([localProfile], null, () => pendingProbe.promise); + render(
Cancelled dashboard
); + + fireEvent.click((await screen.findByText('This computer')).closest('button')!); + expect(await screen.findByRole('heading', { name: 'Connecting to This computer' })).toBeInTheDocument(); + fireEvent.click(screen.getByRole('button', { name: 'Back' })); + expect(await screen.findByText('Recent instances')).toBeInTheDocument(); + + await act(async () => { pendingProbe.resolve({ status: 'ready', version: '0.8.15' }); }); + + expect(screen.queryByText('Cancelled dashboard')).not.toBeInTheDocument(); + expect(adapters.profiles.save).not.toHaveBeenCalled(); + expect(adapters.profiles.setActiveId).toHaveBeenCalledWith(null); + }); + + it('settles a rejected fire-and-forget authentication cancellation during shutdown', async () => { + const adapters = adaptersFor([localProfile], null, async () => ({ + status: 'authentication-required', message: 'Sign in required.', + })); + adapters.authentication.cancel = vi.fn(async () => { throw new Error('private IPC cancellation failure'); }); + const unhandled = vi.fn(); + window.addEventListener('unhandledrejection', unhandled); + const { unmount } = render( +
Cancelled app
 + ); + + fireEvent.click((await screen.findByText('This computer')).closest('button')!); + expect(await screen.findByText('Sign in to continue to this instance.')).toBeInTheDocument(); + fireEvent.click(screen.getByRole('button', { name: 'Choose another instance' })); + unmount(); + await act(async () => { await Promise.resolve(); await Promise.resolve(); }); + + expect(adapters.authentication.cancel).toHaveBeenCalledWith(localProfile.id); + expect(unhandled).not.toHaveBeenCalled(); + window.removeEventListener('unhandledrejection', unhandled); + }); + + it('ignores a delayed access-invalid event from A after B has connected', async () => { + const probe = vi.fn(async (profile: DesktopProfile): Promise => ({ + status: 'ready', + version: '0.8.15', + transportScope: profile.id === localProfile.id ? 'scope-11' : 'scope-12', + })); + const adapters = adaptersFor([localProfile, remoteProfile], localProfile.id, probe); + adapters.connection.deactivate = vi.fn(); + render(
Connected app
); + + expect(await screen.findByText('Connected app')).toBeInTheDocument(); + fireEvent.keyDown(document, { key: ',', ctrlKey: true }); + fireEvent.click((await screen.findByText('Team server')).closest('button')!); + await waitFor(() => expect(probe).toHaveBeenCalledWith(remoteProfile)); + expect(await screen.findByText('Connected app')).toBeInTheDocument(); + + window.dispatchEvent(new CustomEvent(DESKTOP_ACCESS_INVALID_EVENT, { + detail: { profileId: localProfile.id, transportScope: 'scope-11', code: 'INVALID_INSTANCE_TOKEN' }, + })); + + expect(screen.getByText('Connected app')).toBeInTheDocument(); + expect(adapters.connection.deactivate).not.toHaveBeenCalled(); + }); + +}); diff --git a/propr-ui/src/desktop/DesktopExperience.tsx b/propr-ui/src/desktop/DesktopExperience.tsx index d2c8239d6..30e9c099e 100644 --- a/propr-ui/src/desktop/DesktopExperience.tsx +++ b/propr-ui/src/desktop/DesktopExperience.tsx @@ -1,255 +1,138 @@ import React, { useCallback, useEffect, useRef, useState } from 'react'; -import { AlertTriangle, ArrowLeft, ChevronRight, Cloud, Computer, LoaderCircle, Pencil, Plus, RefreshCw, Search, Server, Trash2, X } from 'lucide-react'; +import { parseProprConnectEndpoint } from '@propr/shared'; +import { LoaderCircle } from 'lucide-react'; import { setApiBaseUrl } from '../api/apiClient'; import * as runtimeConfig from '../config/runtimeConfig'; -import { DesktopContext } from './DesktopContext'; -import { normalizeBaseUrl } from './browserAdapters'; -import { useDesktopModal, useSerializedMutationQueue } from './desktopExperienceHooks'; -import type { DesktopAdapters, DesktopConnectionResult, DesktopProfile } from './types'; +import type { DesktopDeepLinkInbox } from '../desktop-deep-link'; +import { DesktopConnectedExperience } from './DesktopConnectedExperience'; +import { useAttemptFence, useDesktopModal, useSerializedMutationQueue } from './desktopExperienceHooks'; +import { ConnectionPanel, DesktopBrand, InstanceChooser, ManagedRecoveryReview, ProfileEditor } from './DesktopExperiencePanels'; +import { managedRecoveryMessage, managedRediscoveryUnavailableMessage, safeConnectionMessage } from './desktopExperienceMessages'; +import { mergeProfiles, recoverableError, settleAuthenticationCancellation, type ExperienceState } from './desktopExperienceState'; +import { DESKTOP_ACCESS_INVALID_EVENT, type DesktopAccessInvalidEventDetail, type DesktopAdapters, type DesktopConnectionResult, type DesktopProfile } from './types'; +import { useDesktopDeepLinks } from './useDesktopDeepLinks'; import './desktop.css'; -type ExperienceState = - | { phase: 'loading' } - | { phase: 'choose' } - | { phase: 'connecting'; profile: DesktopProfile } - | { phase: 'blocked'; profile: DesktopProfile; result: Exclude } - | { phase: 'connected'; profile: DesktopProfile; result: Extract }; - interface DesktopExperienceProps { adapters: DesktopAdapters; + deepLinks?: DesktopDeepLinkInbox; children: React.ReactNode; } -const profileId = (): string => { - try { return crypto.randomUUID(); } catch { return `profile-${Date.now()}`; } -}; - -const mergeProfiles = (current: DesktopProfile[], incoming: DesktopProfile[]): DesktopProfile[] => { - const profiles = new Map(current.map(profile => [profile.id, profile])); - incoming.forEach(profile => profiles.set(profile.id, profile)); - return [...profiles.values()].sort((a, b) => (b.lastConnectedAt || '').localeCompare(a.lastConnectedAt || '')); -}; - -const connectionLabel = (result: DesktopConnectionResult): string => { - if (result.status === 'incompatible') return 'Update required'; - if (result.status === 'authentication-required') return 'Sign in required'; - if (result.status === 'offline') return 'Instance unavailable'; - return 'Connected'; -}; - -const recoverableError = (message: string, error: unknown): string => - `${message}${error instanceof Error && error.message ? ` ${error.message}` : ''} Try again.`; - -const DesktopBrand: React.FC = () => ( -
- - ProPR -
-); - -interface ProfileEditorProps { - initial?: DesktopProfile; - operationError?: string | null; - onCancel(): void; - onSave(profile: DesktopProfile): void; -} - -const ProfileEditor: React.FC = ({ initial, operationError, onCancel, onSave }) => { - const [name, setName] = useState(initial?.name || 'My ProPR'); - const [baseUrl, setBaseUrl] = useState(initial?.baseUrl || 'http://127.0.0.1:3000'); - const [validationError, setValidationError] = useState(null); - - const submit = (event: React.FormEvent) => { - event.preventDefault(); - try { - onSave({ - id: initial?.id || profileId(), - name: name.trim() || 'My ProPR', - baseUrl: normalizeBaseUrl(baseUrl), - kind: initial?.kind || (new URL(baseUrl).hostname === '127.0.0.1' || new URL(baseUrl).hostname === 'localhost' ? 'local' : 'remote'), - lastConnectedAt: initial?.lastConnectedAt, - }); - } catch (caught) { - setValidationError(caught instanceof Error ? caught.message : 'Enter a valid instance URL.'); - } - }; - - const error = validationError || operationError; - - return ( -
- -

{initial ? 'Edit instance' : 'Connect to an instance'}

-

Enter the address shown by your ProPR server.

- - - {error && } - -
- ); -}; - -interface ProfileListProps { - profiles: DesktopProfile[]; - onConnect(profile: DesktopProfile): void; - onEdit(profile: DesktopProfile): void; - onRemove(profile: DesktopProfile): void; -} - -const ProfileList: React.FC = ({ profiles, onConnect, onEdit, onRemove }) => ( -
-

Recent instances

-
- {profiles.map(profile => ( -
- - - -
- ))} -
-
-); - -interface ChooserProps extends ProfileListProps { - busy: boolean; - error: string | null; - localSetupSupported: boolean; - onLocalSetup(): void; - onConnectNew(): void; - onDiscover(): void; -} - -const InstanceChooser: React.FC = ({ profiles, busy, error, localSetupSupported, onLocalSetup, onConnectNew, onDiscover, ...listProps }) => ( -
- -
- ProPR Desktop -

{profiles.length ? 'Choose an instance' : localSetupSupported ? 'Let’s set up this computer' : 'Connect to ProPR'}

-

{localSetupSupported - ? 'Keep your repositories and coding agents close, or connect securely to a ProPR instance you already use.' - : 'Local setup is currently available on Linux. Connect securely to a ProPR instance hosted elsewhere.'}

-
-
- {localSetupSupported && ( - - )} - -
- {error &&
{error}
} - {profiles.length > 0 && } - -
-); - -const ConnectionPanel: React.FC<{ - profile: DesktopProfile; - result?: Exclude; - onBack(): void; - onRetry(): void; - onAuthenticate(): void; - onHelp(): void; -}> = ({ profile, result, onBack, onRetry, onAuthenticate, onHelp }) => ( -
- - {!result ? ( - <> -
-

Connecting to {profile.name}

-

Checking the instance and desktop compatibility…

-
- - ) : ( - <> -
- {connectionLabel(result)} -

{profile.name}

-

{result.message || 'This instance needs authentication before ProPR Desktop can connect.'}

- {result.status === 'incompatible' && result.version &&
Instance version {result.version} · Desktop {__APP_VERSION__}
} -
- {result.status === 'authentication-required' && } - - - -
- - )} -
-); - -export const DesktopExperience: React.FC = ({ adapters, children }) => { +export const DesktopExperience: React.FC = ({ adapters, deepLinks, children }) => { const [profiles, setProfiles] = useState([]); const [state, setState] = useState({ phase: 'loading' }); const [editing, setEditing] = useState(null); const [managerOpen, setManagerOpen] = useState(false); const [operationError, setOperationError] = useState(null); const [busy, setBusy] = useState(false); - const [networkOffline, setNetworkOffline] = useState(!navigator.onLine); const connectionAttempt = useRef(0); const activeProfileId = useRef(null); + const stateRef = useRef(state); + stateRef.current = state; + const { begin: beginDiscoveryAttempt, invalidate: invalidateDiscovery } = useAttemptFence(); + const cancelDiscovery = useCallback(() => { + invalidateDiscovery(); + setBusy(false); + }, [invalidateDiscovery]); + const stageConnectCandidate = useCallback((candidate: DesktopProfile, phase: ExperienceState['phase']) => { + cancelDiscovery(); + setOperationError(null); + setEditing(candidate); + if (phase === 'connected') setManagerOpen(true); + else if (phase !== 'loading') { + connectionAttempt.current += 1; + setState({ phase: 'choose' }); + } + }, [cancelDiscovery]); + const { + deepLinkError, + editorNotice, + clearConnectCandidate, + hasPendingConnectCandidate, + } = useDesktopDeepLinks({ + deepLinks, + phase: state.phase, + profileId: state.phase === 'connecting' || state.phase === 'connected' ? state.profile.id : null, + activeProfileId, + onStageConnectCandidate: stageConnectCandidate, + }); const enqueueProfileMutation = useSerializedMutationQueue(); - const closeManager = useCallback(() => { setManagerOpen(false); setEditing(null); }, []); + const closeManager = useCallback(() => { + cancelDiscovery(); + clearConnectCandidate(); + setManagerOpen(false); + setEditing(null); + }, [cancelDiscovery, clearConnectCandidate]); const { dialogRef: managerRef, openModal: openManager } = useDesktopModal(managerOpen, setManagerOpen, closeManager); + const reportAcceptanceStage = useCallback(async ( + stage: Parameters['reportJourneyStage']>[0], + ): Promise => { + try { + await adapters.acceptance?.reportJourneyStage(stage); + } catch { + // Acceptance diagnostics must never alter the renderer lifecycle they observe. + } + }, [adapters]); const connect = useCallback(async (profile: DesktopProfile) => { + cancelDiscovery(); const attempt = ++connectionAttempt.current; const isCurrentAttempt = () => connectionAttempt.current === attempt; setOperationError(null); setState({ phase: 'connecting', profile }); let operation: 'probe' | 'persist' = 'probe'; try { - const result = await adapters.connection.probe(profile); + const probeResult = await adapters.connection.probe(profile); if (!isCurrentAttempt()) return; - if (result.status !== 'ready') { setState({ phase: 'blocked', profile, result }); return; } + if (probeResult.status !== 'ready') { + if (probeResult.status === 'authentication-required') { + await reportAcceptanceStage('AUTHENTICATION_REQUIRED'); + } + setState({ + phase: 'blocked', + profile, + result: { ...probeResult, message: safeConnectionMessage(probeResult, Boolean(parseProprConnectEndpoint(profile.baseUrl))) }, + }); + return; + } + await reportAcceptanceStage('AUTHENTICATED_REPROBE_READY'); operation = 'persist'; const connectedProfile = { ...profile, lastConnectedAt: new Date().toISOString() }; + let result: DesktopConnectionResult = probeResult; await enqueueProfileMutation(async () => { if (!isCurrentAttempt()) return; await adapters.profiles.save(connectedProfile); if (!isCurrentAttempt()) return; - if (activeProfileId.current !== profile.id) await adapters.profiles.setActiveId(profile.id); - activeProfileId.current = profile.id; + if (adapters.connection.activate) { + result = await adapters.connection.activate(connectedProfile, probeResult, isCurrentAttempt); + } + else if (activeProfileId.current !== profile.id) await adapters.profiles.setActiveId(profile.id); + if (result.status === 'ready') { + activeProfileId.current = profile.id; + await reportAcceptanceStage('ACTIVATION_COMMITTED'); + } }); if (!isCurrentAttempt()) return; setProfiles(current => mergeProfiles(current, [connectedProfile])); + if (result.status !== 'ready') { + setState({ phase: 'blocked', profile: connectedProfile, result }); + return; + } runtimeConfig.setDesktopApiBaseUrl(connectedProfile.baseUrl); - setApiBaseUrl(connectedProfile.baseUrl); + if (adapters.connection.publishActivation) adapters.connection.publishActivation(connectedProfile, result); + else setApiBaseUrl(connectedProfile.baseUrl); + await reportAcceptanceStage('ACTIVATION_PUBLISHED'); setState({ phase: 'connected', profile: connectedProfile, result }); - } catch (error) { + } catch { if (!isCurrentAttempt()) return; - const detail = error instanceof Error && error.message ? ` ${error.message}` : ''; const message = operation === 'persist' - ? `The instance is reachable, but ProPR Desktop could not save this connection.${detail} Try again.` - : `ProPR Desktop could not check this instance.${detail} Try again.`; + ? 'The instance is reachable, but ProPR Desktop could not save this connection. Try again.' + : 'ProPR Desktop could not check this instance. Try again.'; setState({ phase: 'blocked', profile, result: { status: 'offline', message } }); } - }, [adapters, enqueueProfileMutation]); + }, [adapters, cancelDiscovery, enqueueProfileMutation, reportAcceptanceStage]); useEffect(() => { let cancelled = false; @@ -258,61 +141,82 @@ export const DesktopExperience: React.FC = ({ adapters, if (cancelled) return; activeProfileId.current = activeId; setProfiles(stored); + if (hasPendingConnectCandidate()) { + setState({ phase: 'choose' }); + return; + } const active = stored.find(profile => profile.id === activeId); if (active) void connect(active); else setState({ phase: 'choose' }); - }).catch(error => { + }).catch(() => { if (!cancelled) { - setOperationError(error instanceof Error ? error.message : 'Profiles could not be loaded.'); + setOperationError('Profiles could not be loaded. Try again.'); setState({ phase: 'choose' }); } }); return () => { cancelled = true; connectionAttempt.current += 1; + invalidateDiscovery(); }; - }, [adapters, connect]); + }, [adapters, connect, hasPendingConnectCandidate, invalidateDiscovery]); useEffect(() => { - const online = () => setNetworkOffline(false); - const offline = () => setNetworkOffline(true); - window.addEventListener('online', online); - window.addEventListener('offline', offline); - return () => { - window.removeEventListener('online', online); - window.removeEventListener('offline', offline); + const accessInvalid = (event: Event) => { + const detail = (event as CustomEvent).detail; + setState(current => { + if (current.phase !== 'connected') return current; + if (!detail || detail.profileId !== current.profile.id || detail.transportScope !== current.result.transportScope) return current; + adapters.connection.deactivate?.(); + return { + phase: 'blocked', + profile: current.profile, + result: { status: 'authentication-required', + message: 'Access to this instance was revoked or expired. Pair again to continue.', + version: current.result.version, authentication: current.result.authentication }, + }; + }); }; - }, []); + window.addEventListener(DESKTOP_ACCESS_INVALID_EVENT, accessInvalid); + return () => window.removeEventListener(DESKTOP_ACCESS_INVALID_EVENT, accessInvalid); + }, [adapters]); useEffect(() => { const handleKeyboard = (event: KeyboardEvent) => { - if (state.phase !== 'connected') return; + const current = stateRef.current; + if (current.phase !== 'connected') return; if ((event.metaKey || event.ctrlKey) && event.key === ',') { event.preventDefault(); openManager(); } else if ((event.metaKey || event.ctrlKey) && event.shiftKey && event.key.toLowerCase() === 'r') { event.preventDefault(); - void connect(state.profile); + void connect(current.profile); } }; document.addEventListener('keydown', handleKeyboard); return () => document.removeEventListener('keydown', handleKeyboard); - }, [connect, openManager, state]); + }, [connect, openManager]); const removeProfile = async (profile: DesktopProfile) => { + cancelDiscovery(); if (!window.confirm(`Remove “${profile.name}” from this computer?`)) return; setOperationError(null); try { await enqueueProfileMutation(() => adapters.profiles.remove(profile.id)); setProfiles(current => current.filter(item => item.id !== profile.id)); if (activeProfileId.current === profile.id) activeProfileId.current = null; - if (state.phase === 'connected' && state.profile.id === profile.id) setState({ phase: 'choose' }); - } catch (error) { - setOperationError(recoverableError('ProPR Desktop could not remove this instance.', error)); + if (state.phase === 'connected' && state.profile.id === profile.id) { + adapters.connection.deactivate?.(); + setState({ phase: 'choose' }); + } + } catch { + setOperationError(recoverableError('ProPR Desktop could not remove this instance.')); } }; const saveProfile = async (profile: DesktopProfile, shouldConnect = true) => { + cancelDiscovery(); + clearConnectCandidate(); setOperationError(null); if (shouldConnect) { closeManager(); @@ -324,46 +228,58 @@ export const DesktopExperience: React.FC = ({ adapters, await enqueueProfileMutation(() => adapters.profiles.save(profile)); setProfiles(current => mergeProfiles(current, [profile])); setEditing(null); - } catch (error) { - setOperationError(recoverableError('ProPR Desktop could not save this instance.', error)); + } catch { + setOperationError(recoverableError('ProPR Desktop could not save this instance.')); } }; const setupLocal = async () => { + cancelDiscovery(); setBusy(true); setOperationError(null); try { const profile = await adapters.localSetup.setup(); await saveProfile(profile); - } catch (error) { - setOperationError(error instanceof Error ? error.message : 'Local setup could not be started.'); + } catch { + setOperationError('Local setup could not be started. Try again.'); } finally { setBusy(false); } }; const discover = async () => { + const isCurrentAttempt = beginDiscoveryAttempt(); setBusy(true); setOperationError(null); try { const discovered = await adapters.discovery.discover(); - setProfiles(current => mergeProfiles(current, discovered)); - if (!discovered.length) setOperationError('No new ProPR instances were found on this network.'); - } catch (error) { - setOperationError(error instanceof Error ? error.message : 'Network discovery is unavailable.'); + if (!isCurrentAttempt()) return; + const candidate = discovered[0]; + if (candidate) { + // Discovery is evidence for a proposed endpoint, never permission to + // persist, pair, or activate it. The editor owns explicit confirmation. + setEditing(candidate); + } else { + setOperationError('No new ProPR instances were found on this network.'); + } + } catch { + if (isCurrentAttempt()) setOperationError('Network discovery is unavailable. Try again.'); } finally { - setBusy(false); + if (isCurrentAttempt()) setBusy(false); } }; const choose = () => { + cancelDiscovery(); + if ('profile' in state) settleAuthenticationCancellation(adapters, state.profile.id); + adapters.connection.deactivate?.(); const attempt = ++connectionAttempt.current; void enqueueProfileMutation(async () => { if (connectionAttempt.current !== attempt) return; await adapters.profiles.setActiveId(null); activeProfileId.current = null; - }).catch(error => { - if (connectionAttempt.current === attempt) setOperationError(recoverableError('ProPR Desktop could not clear the active instance.', error)); + }).catch(() => { + if (connectionAttempt.current === attempt) setOperationError(recoverableError('ProPR Desktop could not clear the active instance.')); }); setManagerOpen(false); setEditing(null); @@ -372,62 +288,108 @@ export const DesktopExperience: React.FC = ({ adapters, const retry = () => { if ('profile' in state) void connect(state.profile); }; - const runBlockedAction = async (profile: DesktopProfile, action: () => Promise, failureMessage: string, onSuccess?: () => Promise) => { + const runBlockedAction = async ( + profile: DesktopProfile, + action: () => Promise, + failureMessage: string, + connectFailureMessage?: string, + onSuccess?: () => Promise, + ) => { + cancelDiscovery(); const attempt = connectionAttempt.current; try { await action(); if (connectionAttempt.current === attempt) await onSuccess?.(); - } catch (error) { - const message = recoverableError(failureMessage, error); + } catch { + const message = recoverableError(failureMessage); setState(current => current.phase === 'blocked' && current.profile.id === profile.id - ? { ...current, result: { ...current.result, message } } + ? { + ...current, + result: parseProprConnectEndpoint(profile.baseUrl) && connectFailureMessage + ? { status: 'offline', message: recoverableError(connectFailureMessage) } + : { ...current.result, message }, + } : current); } }; - const openEditor = (profile: DesktopProfile | 'new') => { setOperationError(null); setEditing(profile); }; + const openEditor = (profile: DesktopProfile | 'new') => { + cancelDiscovery(); + clearConnectCandidate(); + setOperationError(null); + setEditing(profile); + }; - const content = () => { - if (state.phase === 'loading') return
Opening ProPR…
; - if (state.phase === 'connecting') return undefined} onHelp={() => undefined} />; - if (state.phase === 'blocked') return void runBlockedAction(state.profile, () => adapters.authentication.authenticate(state.profile), 'ProPR Desktop could not open sign in.', () => connect(state.profile))} onHelp={() => void runBlockedAction(state.profile, () => adapters.externalBrowser.open('https://propr.dev'), 'ProPR Desktop could not open connection help.')} />; - if (editing) return
setEditing(null)} onSave={profile => void saveProfile(profile)} />
; - return void setupLocal()} onConnectNew={() => openEditor('new')} onDiscover={() => void discover()} onConnect={profile => void connect(profile)} onEdit={openEditor} onRemove={profile => void removeProfile(profile)} />; + const closeEditor = () => { + cancelDiscovery(); + clearConnectCandidate(); + setEditing(null); }; - if (state.phase !== 'connected') return
{content()}
; + const reenterManagedEndpoint = (profile: DesktopProfile) => { + cancelDiscovery(); + connectionAttempt.current += 1; + setOperationError(null); + setState({ phase: 'choose' }); + setEditing({ ...profile, baseUrl: '' }); + }; - const displayedConnection: DesktopConnectionResult = networkOffline ? { status: 'offline', message: 'This computer is offline.' } : state.result; - const contextValue = { - isDesktop: true as const, - platform: adapters.platform, - profile: state.profile, - connection: displayedConnection, - openProfileManager: openManager, - authenticate: () => adapters.authentication.authenticate(state.profile), - openConnectionHelp: () => adapters.externalBrowser.open('https://propr.dev'), - retry, + const rediscoverManagedEndpoint = async (profile: DesktopProfile) => { + const isCurrentDiscovery = beginDiscoveryAttempt(); + const attempt = ++connectionAttempt.current; + const showUnavailable = () => { + if (connectionAttempt.current !== attempt || !isCurrentDiscovery()) return; + setState(current => current.phase === 'blocked' && current.profile.id === profile.id + ? { + phase: 'blocked', + profile, + result: { status: 'offline', message: managedRediscoveryUnavailableMessage }, + } + : current); + }; + if (!adapters.managedTunnelRecovery) { + showUnavailable(); + return; + } + try { + const discovered = await adapters.managedTunnelRecovery.rediscover(profile.id); + if (connectionAttempt.current !== attempt || !isCurrentDiscovery()) return; + if (!discovered || discovered.id !== profile.id) return showUnavailable(); + const endpoint = parseProprConnectEndpoint(discovered.baseUrl); + if (!endpoint) return showUnavailable(); + setState({ + phase: 'recovery-review', + profile, + candidate: { ...profile, baseUrl: endpoint.origin, kind: 'remote' }, + }); + } catch { + showUnavailable(); + } + }; + + const content = () => { + if (state.phase === 'loading') return
Opening ProPR…
; + if (state.phase === 'connecting') return undefined} onHelp={() => undefined} onReenter={() => undefined} onRediscover={() => undefined} />; + if (state.phase === 'recovery-review') return { cancelDiscovery(); setState({ phase: 'blocked', profile: state.profile, result: { status: 'offline', message: managedRecoveryMessage } }); }} onConfirm={() => void connect(state.candidate)} />; + if (state.phase === 'blocked') return void runBlockedAction(state.profile, async () => { + await adapters.authentication.authenticate(state.profile); + await reportAcceptanceStage('CREDENTIAL_COMMITTED'); + }, 'ProPR Desktop could not open sign in.', 'ProPR Connect pairing could not be completed.', () => connect(state.profile))} onHelp={() => void runBlockedAction(state.profile, () => adapters.externalBrowser.open('https://propr.dev'), 'ProPR Desktop could not open connection help.')} onReenter={() => reenterManagedEndpoint(state.profile)} onRediscover={() => void rediscoverManagedEndpoint(state.profile)} />; + if (editing) return
void saveProfile(profile)} />
; + return void setupLocal()} onConnectNew={() => openEditor('new')} onDiscover={() => void discover()} onConnect={profile => void connect(profile)} onEdit={openEditor} onRemove={profile => void removeProfile(profile)} />; }; + if (state.phase !== 'connected') return
{deepLinkError &&
{deepLinkError}
}{content()}
; + return ( - -
{children}
- {managerOpen && ( -
{ if (event.target === event.currentTarget) closeManager(); }}> -
-
Desktop

Manage instances

- {editing ? ( - setEditing(null)} onSave={profile => void saveProfile(profile, editing === 'new' || state.profile.id === profile.id)} /> - ) : ( - <> - {operationError &&
{operationError}
} - { setManagerOpen(false); void connect(profile); }} onEdit={openEditor} onRemove={profile => void removeProfile(profile)} /> - - - )} -
-
- )} - + {children} ); }; diff --git a/propr-ui/src/desktop/DesktopExperiencePanels.tsx b/propr-ui/src/desktop/DesktopExperiencePanels.tsx new file mode 100644 index 000000000..8288beba8 --- /dev/null +++ b/propr-ui/src/desktop/DesktopExperiencePanels.tsx @@ -0,0 +1,236 @@ +import React, { useState } from 'react'; +import { isProprLoopbackHostname, parseProprConnectEndpoint } from '@propr/shared'; +import { + AlertTriangle, + ArrowLeft, + ChevronRight, + Cloud, + Computer, + LoaderCircle, + Pencil, + RefreshCw, + Search, + Server, + Trash2, +} from 'lucide-react'; +import { normalizeBaseUrl } from './browserAdapters'; +import type { DesktopConnectionResult, DesktopProfile } from './types'; + +const createProfileId = (): string => { + try { return crypto.randomUUID(); } catch { return `profile-${Date.now()}`; } +}; + +const safeVersion = (version: string | undefined): string | null => + version && /^[A-Za-z0-9][A-Za-z0-9._-]{0,31}$/.test(version) ? version : null; + +const safeProfileDisplayLabel = (name: string): string => { + const normalized = name.replace(/[\p{Cc}\p{Cf}]/gu, ' ').trim(); + const bounded = Array.from(normalized).slice(0, 80).join(''); + if (!bounded || /https?:|\.propr\.dev\b|[/?#@\\]|token|secret|password/i.test(bounded)) { + return 'Saved connection'; + } + return bounded; +}; + +const connectionLabel = (result: DesktopConnectionResult): string => { + if (result.status === 'incompatible') return 'Update required'; + if (result.status === 'authentication-required') return 'Sign in required'; + if (result.status === 'offline') return 'Instance unavailable'; + return 'Connected'; +}; + +export const DesktopBrand: React.FC = () => ( +
+ + ProPR +
+); + +interface ProfileEditorProps { + initial?: DesktopProfile; + candidate?: boolean; + notice?: string | null; + operationError?: string | null; + onCancel(): void; + onSave(profile: DesktopProfile): void; +} + +export const ProfileEditor: React.FC = ({ initial, candidate = false, notice, operationError, onCancel, onSave }) => { + const [name, setName] = useState(initial?.name || 'My ProPR'); + const [baseUrl, setBaseUrl] = useState(initial ? initial.baseUrl : 'http://127.0.0.1:3000'); + const [validationError, setValidationError] = useState(null); + const connectEndpoint = parseProprConnectEndpoint(baseUrl); + + const submit = (event: React.FormEvent) => { + event.preventDefault(); + try { + const normalizedBaseUrl = normalizeBaseUrl(baseUrl); + const hostname = new URL(normalizedBaseUrl).hostname; + onSave({ + id: initial?.id || createProfileId(), + name: name.trim() || 'My ProPR', + baseUrl: normalizedBaseUrl, + kind: isProprLoopbackHostname(hostname) ? 'local' : 'remote', + lastConnectedAt: initial?.lastConnectedAt, + }); + } catch (caught) { + setValidationError(caught instanceof Error ? caught.message : 'Enter a valid instance URL.'); + } + }; + + const error = validationError || operationError; + return ( +
+ +

{candidate || !initial ? 'Connect to an instance' : 'Edit instance'}

+

Enter the address shown by your ProPR server.

+ {notice &&
{notice}
} + + + {connectEndpoint &&
} + {error && } + +
+ ); +}; + +interface ProfileListProps { + profiles: DesktopProfile[]; + onConnect(profile: DesktopProfile): void; + onEdit(profile: DesktopProfile): void; + onRemove(profile: DesktopProfile): void; +} + +export const ProfileList: React.FC = ({ profiles, onConnect, onEdit, onRemove }) => ( +
+

Recent instances

+
+ {profiles.map(profile => ( +
+ + + +
+ ))} +
+
+); + +interface ChooserProps extends ProfileListProps { + busy: boolean; + error: string | null; + localSetupSupported: boolean; + networkDiscoverySupported: boolean; + onLocalSetup(): void; + onConnectNew(): void; + onDiscover(): void; +} + +export const InstanceChooser: React.FC = ({ + profiles, busy, error, localSetupSupported, networkDiscoverySupported, + onLocalSetup, onConnectNew, onDiscover, ...listProps +}) => ( +
+ +
+ ProPR Desktop +

{profiles.length ? 'Choose an instance' : localSetupSupported ? 'Let’s set up this computer' : 'Connect to ProPR'}

+

{localSetupSupported + ? 'Keep your repositories and coding agents close, or connect securely to a ProPR instance you already use.' + : 'Local setup is currently available on Linux. Connect securely to a ProPR instance hosted elsewhere.'}

+
+
+ {localSetupSupported && ( + + )} + +
+ {error &&
{error}
} + {profiles.length > 0 && } + {networkDiscoverySupported && ( + + )} +
+); + +interface ConnectionPanelProps { + profile: DesktopProfile; + result?: Exclude; + onBack(): void; + onRetry(): void; + onAuthenticate(): void; + onHelp(): void; + onReenter(): void; + onRediscover(): void; +} + +export const ConnectionPanel = ({ profile, result, onBack, onRetry, onAuthenticate, onHelp, onReenter, onRediscover }: ConnectionPanelProps) => { + const managed = Boolean(result && parseProprConnectEndpoint(profile.baseUrl)); + return ( +
+ + {!result ? ( + <>

Connecting to {profile.name}

Checking the instance and desktop compatibility…

+ ) : ( + <> +
+ {connectionLabel(result)}

{profile.name}

+

{result.message}

+ {result.status === 'incompatible' && safeVersion(result.version) &&
Instance version {safeVersion(result.version)} · Desktop {__APP_VERSION__}
} + {'authentication' in result && result.authentication &&
{result.authentication}
} +
+ {result.status === 'authentication-required' && } + + {managed && } + {managed && } + + +
+ + )} +
+ ); +}; + +export const ManagedRecoveryReview = ({ profile, onCancel, onConfirm }: { + profile: DesktopProfile; + onCancel(): void; + onConfirm(): void; +}) => ( +
+ +
+ ProPR Connect rediscovered +

Use the rediscovered endpoint?

+

A replacement endpoint was discovered for the saved connection “{safeProfileDisplayLabel(profile.name)}”. Confirm before updating that connection.

+
+ + +
+
+); diff --git a/propr-ui/src/desktop/DesktopPresentationBoundary.test.tsx b/propr-ui/src/desktop/DesktopPresentationBoundary.test.tsx new file mode 100644 index 000000000..5cad17759 --- /dev/null +++ b/propr-ui/src/desktop/DesktopPresentationBoundary.test.tsx @@ -0,0 +1,60 @@ +import { act, render, screen } from '@testing-library/react'; +import { afterEach, describe, expect, it, vi } from 'vitest'; +import { DesktopPresentationBoundary } from './DesktopPresentationBoundary'; +import type { ProprDesktopBridge } from './types'; + +const bridgeWithDeepLinks = () => { + const listeners = new Set<(value: string) => void>(); + const onDeepLink = vi.fn((listener: (value: string) => void) => { + listeners.add(listener); + return vi.fn(() => listeners.delete(listener)); + }); + const bridge: ProprDesktopBridge = { + isDesktop: true, + platform: 'linux', + app: { onDeepLink }, + profiles: { + list: async () => [], + save: async () => undefined, + remove: async () => undefined, + getActiveId: async () => null, + setActiveId: async () => undefined, + }, + discovery: { supported: false, discover: async () => [] }, + authentication: { authenticate: async () => undefined }, + externalBrowser: { open: async () => undefined }, + localSetup: { supported: false, setup: async () => { throw new Error('not used'); } }, + connection: { probe: async () => ({ status: 'ready' }) }, + }; + return { bridge, listeners, onDeepLink }; +}; + +describe('DesktopPresentationBoundary deep-link subscription', () => { + afterEach(() => { + delete window.__PROPR_DESKTOP__; + vi.restoreAllMocks(); + }); + + it('subscribes once, tears down, and does not replay a consumed candidate after remount', async () => { + const { bridge, listeners, onDeepLink } = bridgeWithDeepLinks(); + window.__PROPR_DESKTOP__ = bridge; + const first = render(Desktop app
} fallback={
Web app
} />); + + expect(await screen.findByRole('heading', { name: 'Connect to ProPR' })).toBeInTheDocument(); + expect(onDeepLink).toHaveBeenCalledOnce(); + first.rerender(Desktop app
} fallback={
Web app
} />); + expect(onDeepLink).toHaveBeenCalledOnce(); + act(() => listeners.forEach(listener => listener('propr://connect?api=https%3A%2F%2Ffirst.example'))); + expect(await screen.findByDisplayValue('https://first.example')).toBeInTheDocument(); + + const unsubscribe = onDeepLink.mock.results[0]?.value; + first.unmount(); + expect(unsubscribe).toHaveBeenCalledOnce(); + expect(listeners.size).toBe(0); + + render(Desktop app
} fallback={
Web app
} />); + expect(await screen.findByRole('heading', { name: 'Connect to ProPR' })).toBeInTheDocument(); + expect(screen.queryByDisplayValue('https://first.example')).not.toBeInTheDocument(); + expect(onDeepLink).toHaveBeenCalledTimes(2); + }); +}); diff --git a/propr-ui/src/desktop/DesktopPresentationBoundary.tsx b/propr-ui/src/desktop/DesktopPresentationBoundary.tsx index 9e85ddab2..1c0cc0383 100644 --- a/propr-ui/src/desktop/DesktopPresentationBoundary.tsx +++ b/propr-ui/src/desktop/DesktopPresentationBoundary.tsx @@ -1,4 +1,5 @@ -import React, { useState } from 'react'; +import React, { useEffect, useState } from 'react'; +import { DesktopDeepLinkInbox } from '../desktop-deep-link'; import { resolveDesktopAdapters } from './browserAdapters'; import { DesktopExperience } from './DesktopExperience'; @@ -10,5 +11,12 @@ interface DesktopPresentationBoundaryProps { /** Keeps desktop detection at the application edge and leaves the route tree shared. */ export const DesktopPresentationBoundary: React.FC = ({ desktop, fallback }) => { const adapters = useState(resolveDesktopAdapters)[0]; - return adapters ? {desktop} : fallback; + const inbox = useState(() => new DesktopDeepLinkInbox())[0]; + + useEffect(() => { + if (!adapters) return; + return adapters.app.onDeepLink(value => inbox.receive(value)); + }, [adapters, inbox]); + + return adapters ? {desktop} : fallback; }; diff --git a/propr-ui/src/desktop/DesktopTitleBar.tsx b/propr-ui/src/desktop/DesktopTitleBar.tsx index a94705464..c8c766917 100644 --- a/propr-ui/src/desktop/DesktopTitleBar.tsx +++ b/propr-ui/src/desktop/DesktopTitleBar.tsx @@ -1,12 +1,24 @@ -import React from 'react'; +import React, { useEffect } from 'react'; import { ChevronDown, CircleAlert, CloudOff, RefreshCw, Wifi } from 'lucide-react'; import { useDesktop } from './DesktopContext'; -export const DesktopTitleBar: React.FC = () => { +interface DesktopTitleBarProps { + /** Authenticated REST and Socket.IO are ready for the published desktop scope. */ + transportReady?: boolean; +} + +export const DesktopTitleBar: React.FC = ({ transportReady = false }) => { const desktop = useDesktop(); - if (!desktop) return null; + const connected = desktop?.connection.status === 'ready'; - const connected = desktop.connection.status === 'ready'; + useEffect(() => { + if (!connected || !transportReady) return; + void desktop?.reportConnectedRendererReady?.().catch(() => { + // Acceptance diagnostics must never alter the renderer lifecycle they observe. + }); + }, [connected, desktop, transportReady]); + + if (!desktop) return null; const incompatible = desktop.connection.status === 'incompatible'; const label = connected ? 'Connected' : incompatible ? 'Update required' : 'Offline'; diff --git a/propr-ui/src/desktop/browserAdapters.test.ts b/propr-ui/src/desktop/browserAdapters.test.ts index fa25aec3c..5e7c291e1 100644 --- a/propr-ui/src/desktop/browserAdapters.test.ts +++ b/propr-ui/src/desktop/browserAdapters.test.ts @@ -1,4 +1,5 @@ import { afterEach, describe, expect, it, vi } from 'vitest'; +import { PROPR_API_ORIGIN_PARITY_CASES } from '@propr/shared'; import { normalizeBaseUrl, resolveDesktopAdapters } from './browserAdapters'; import { DESKTOP_AUTHENTICATION_COMPLETE_EVENT } from './types'; @@ -19,6 +20,7 @@ describe('desktop browser fixtures', () => { const adapters = resolveDesktopAdapters(); expect(adapters).not.toBeNull(); await expect(adapters?.profiles.list()).resolves.toHaveLength(2); + expect(adapters?.discovery.supported).toBe(false); }); it('does not enable query-driven fixtures in production mode', () => { @@ -28,10 +30,23 @@ describe('desktop browser fixtures', () => { expect(resolveDesktopAdapters()).toBeNull(); }); - it('normalizes safe instance origins and rejects non-http protocols', () => { + it('normalizes safe instance origins and rejects unsafe URL components', () => { expect(normalizeBaseUrl(' https://propr.example.com/// ')).toBe('https://propr.example.com'); - expect(() => normalizeBaseUrl('file:///tmp/propr')).toThrow(/http/); - expect(() => normalizeBaseUrl('https://user:secret@example.com')).toThrow(/credentials/); + for (const unsafe of [ + 'file:///tmp/propr', + 'https://user:secret@example.com', + 'https://propr.example.com/api', + 'https://propr.example.com?token=secret', + ]) { + expect(() => normalizeBaseUrl(unsafe)).toThrow('The configured ProPR API URL is invalid.'); + } + }); + + it('matches the shared canonical origin parity table', () => { + for (const [, input, expected] of PROPR_API_ORIGIN_PARITY_CASES) { + if (expected === null) expect(() => normalizeBaseUrl(input)).toThrow(); + else expect(normalizeBaseUrl(input)).toBe(expected); + } }); it('resolves fixture authentication only after the matching desktop completion signal', async () => { diff --git a/propr-ui/src/desktop/browserAdapters.ts b/propr-ui/src/desktop/browserAdapters.ts index ba47a324c..a85a57ff1 100644 --- a/propr-ui/src/desktop/browserAdapters.ts +++ b/propr-ui/src/desktop/browserAdapters.ts @@ -1,4 +1,6 @@ +import { normalizeApiBaseUrl, ProprClientError } from '@propr/client'; import { evaluateProprApiCompatibility } from '@propr/shared'; +import { createElectronDesktopAdapters } from './electronAdapters'; import type { DesktopAdapters, DesktopAuthenticationCompleteEventDetail, @@ -25,15 +27,14 @@ const fixtureProfile: DesktopProfile = { }; const normalizeBaseUrl = (value: string): string => { - const url = new URL(value.trim()); - if (url.protocol !== 'http:' && url.protocol !== 'https:') { - throw new Error('Instance URLs must use http:// or https://.'); + try { + const normalized = normalizeApiBaseUrl(value); + if (!normalized) throw new Error('Enter an instance URL.'); + return normalized; + } catch (error) { + if (error instanceof ProprClientError) throw new Error(error.message); + throw error; } - if (url.username || url.password) throw new Error('Instance URLs cannot contain credentials.'); - url.pathname = url.pathname.replace(/\/+$/, ''); - url.search = ''; - url.hash = ''; - return url.toString().replace(/\/+$/, ''); }; const readProfiles = (): DesktopProfile[] => { @@ -48,9 +49,17 @@ const readProfiles = (): DesktopProfile[] => { const isDesktopProfile = (value: unknown): value is DesktopProfile => { if (!value || typeof value !== 'object') return false; const profile = value as Partial; + if (typeof profile.baseUrl !== 'string') return false; + let normalizedBaseUrl: string; + try { normalizedBaseUrl = normalizeBaseUrl(profile.baseUrl); } catch { return false; } return typeof profile.id === 'string' + && profile.id.length > 0 + && profile.id.length <= 64 && typeof profile.name === 'string' + && profile.name.length > 0 + && profile.name.length <= 80 && typeof profile.baseUrl === 'string' + && normalizedBaseUrl === profile.baseUrl && (profile.kind === 'local' || profile.kind === 'remote'); }; @@ -133,6 +142,7 @@ const authenticateBrowserFixture = (profile: DesktopProfile): Promise => n const createBrowserAdapters = (fixture: DesktopFixture | null): DesktopAdapters => ({ platform: detectPlatform(), + app: { onDeepLink: () => () => undefined }, profiles: { async list() { if (fixture === 'first-run') return []; @@ -158,12 +168,13 @@ const createBrowserAdapters = (fixture: DesktopFixture | null): DesktopAdapters else window.localStorage.removeItem(ACTIVE_PROFILE_KEY); }, }, - discovery: { async discover() { return fixture ? [fixtureProfile] : []; } }, + discovery: { supported: false, async discover() { return fixture ? [fixtureProfile] : []; } }, externalBrowser: { async open(url) { window.open(url, '_blank', 'noopener,noreferrer'); } }, authentication: { authenticate: authenticateBrowserFixture, }, localSetup: { + supported: true, async setup() { if (fixture) return fixtureProfile; throw new Error('Local setup will be available when the desktop host adapter is connected.'); @@ -182,6 +193,7 @@ const createBrowserAdapters = (fixture: DesktopFixture | null): DesktopAdapters export const resolveDesktopAdapters = (): DesktopAdapters | null => { const bridge: ProprDesktopBridge | undefined = window.__PROPR_DESKTOP__; if (bridge?.isDesktop) return bridge; + if (window.proprDesktop) return createElectronDesktopAdapters(window.proprDesktop); const fixture = import.meta.env.DEV ? fixtureFromLocation() : null; return fixture ? createBrowserAdapters(fixture) : null; }; diff --git a/propr-ui/src/desktop/desktop.css b/propr-ui/src/desktop/desktop.css index 8151f8a73..6f039d878 100644 --- a/propr-ui/src/desktop/desktop.css +++ b/propr-ui/src/desktop/desktop.css @@ -156,6 +156,8 @@ .desktop-profile-form label { display: grid; gap: .4rem; margin-top: .8rem; color: #435555; font-size: .76rem; font-weight: 650; } .desktop-profile-form input { width: 100%; border: 1px solid #cdd9d9; border-radius: .55rem; padding: .68rem .75rem; color: #192c2c; font-size: .86rem; font-weight: 450; outline: none; } .desktop-profile-form input:focus { border-color: #16827c; box-shadow: 0 0 0 3px rgba(22, 130, 124, .15); } +.desktop-connect-verified { display: flex; align-items: center; gap: .4rem; margin-top: .65rem; color: #0f766e; font-size: .74rem; font-weight: 700; } +.desktop-connect-verified svg { width: .9rem; height: .9rem; } .desktop-primary-button, .desktop-secondary-button { diff --git a/propr-ui/src/desktop/desktopExperienceHooks.ts b/propr-ui/src/desktop/desktopExperienceHooks.ts index 731850f18..721398cbc 100644 --- a/propr-ui/src/desktop/desktopExperienceHooks.ts +++ b/propr-ui/src/desktop/desktopExperienceHooks.ts @@ -19,6 +19,20 @@ export const useSerializedMutationQueue = () => { }, []); }; +export const useAttemptFence = (): { + begin(): () => boolean; + invalidate(): void; +} => { + const generation = useRef(0); + const invalidate = useCallback(() => { generation.current += 1; }, []); + const begin = useCallback(() => { + const attempt = ++generation.current; + return () => generation.current === attempt; + }, []); + useEffect(() => invalidate, [invalidate]); + return { begin, invalidate }; +}; + export const useDesktopModal = ( open: boolean, setOpen: Dispatch>, diff --git a/propr-ui/src/desktop/desktopExperienceMessages.ts b/propr-ui/src/desktop/desktopExperienceMessages.ts new file mode 100644 index 000000000..c8253b693 --- /dev/null +++ b/propr-ui/src/desktop/desktopExperienceMessages.ts @@ -0,0 +1,17 @@ +import type { DesktopConnectionResult } from './types'; + +export const managedRecoveryMessage = + 'This ProPR Connect endpoint may be stale or the local stack may have restarted. Restart Connect if needed, then retry, re-enter, or rediscover the connection.'; + +export const managedRediscoveryUnavailableMessage = + 'Connect rediscovery is unavailable. Retry the saved connection or re-enter its Connect address.'; + +export const safeConnectionMessage = ( + result: Exclude, + managed: boolean, +): string => { + if (managed && result.status === 'offline') return managedRecoveryMessage; + if (result.status === 'authentication-required') return 'Sign in to continue to this instance.'; + if (result.status === 'incompatible') return 'This instance is not compatible with this version of ProPR Desktop.'; + return 'ProPR Desktop could not reach this instance. Check that it is running and try again.'; +}; diff --git a/propr-ui/src/desktop/desktopExperienceState.ts b/propr-ui/src/desktop/desktopExperienceState.ts new file mode 100644 index 000000000..cc13dd001 --- /dev/null +++ b/propr-ui/src/desktop/desktopExperienceState.ts @@ -0,0 +1,27 @@ +import type { DesktopAdapters, DesktopConnectionResult, DesktopProfile } from './types'; + +export type ExperienceState = + | { phase: 'loading' } + | { phase: 'choose' } + | { phase: 'connecting'; profile: DesktopProfile } + | { phase: 'blocked'; profile: DesktopProfile; result: Exclude } + | { phase: 'recovery-review'; profile: DesktopProfile; candidate: DesktopProfile } + | { phase: 'connected'; profile: DesktopProfile; result: Extract }; + +export const mergeProfiles = (current: DesktopProfile[], incoming: DesktopProfile[]): DesktopProfile[] => { + const profiles = new Map(current.map(profile => [profile.id, profile])); + incoming.forEach(profile => profiles.set(profile.id, profile)); + return [...profiles.values()].sort((a, b) => + (b.lastConnectedAt || '').localeCompare(a.lastConnectedAt || '')); +}; + +export const recoverableError = (message: string): string => `${message} Try again.`; + +export const settleAuthenticationCancellation = (adapters: DesktopAdapters, profileId: string): void => { + // Back/navigation must remain synchronous. Cancellation is best effort and + // its rejection is deliberately consumed so shutdown cannot create an + // unhandled promise containing host-specific IPC details. + void Promise.resolve() + .then(() => adapters.authentication.cancel?.(profileId)) + .catch(() => undefined); +}; diff --git a/propr-ui/src/desktop/electronAdapters.test.ts b/propr-ui/src/desktop/electronAdapters.test.ts new file mode 100644 index 000000000..711cab66f --- /dev/null +++ b/propr-ui/src/desktop/electronAdapters.test.ts @@ -0,0 +1,420 @@ +import { beforeEach, describe, expect, it, vi } from 'vitest'; +import { PROPR_API_ORIGIN_PARITY_CASES } from '@propr/shared'; +import type { DesktopBridge, DesktopProfile as StoredProfile } from '../../../apps/desktop/src/shared/contract'; +import { createElectronDesktopAdapters } from './electronAdapters'; + +const desktopConnectionState = vi.hoisted(() => ({ + scope: null as null | { bridge: DesktopBridge; profileId: string; transportScope: string }, +})); +const setDesktopConnectionScope = vi.hoisted(() => vi.fn((scope: typeof desktopConnectionState.scope) => { + desktopConnectionState.scope = scope; +})); +vi.mock('../api/apiClient', () => ({ + getDesktopConnectionScope: () => desktopConnectionState.scope, + setDesktopConnectionScope, +})); + +const storedProfile: StoredProfile = { + id: 'profile-1', + label: 'Team server', + apiBaseUrl: 'https://propr.example.test', + createdAt: '2026-08-29T00:00:00.000Z', + updatedAt: '2026-08-29T00:00:00.000Z', +}; + +const bridgeFixture = () => { + let profiles = [storedProfile]; + let activeProfileId: string | null = null; + const pair = vi.fn(async () => ({ paired: true as const })); + const onDeepLink = vi.fn(() => () => undefined); + const probe = vi.fn(async () => ({ + status: 'ready' as const, + version: '0.8.15', + activationTicket: 'ticket-7', + })); + const activate = vi.fn(async () => ({ + status: 'ready' as const, + profileId: storedProfile.id, + transportScope: 'scope-7', + identityEpoch: 'AAAAAAAAAAAAAAAAAAAAAA', + })); + const discard = vi.fn(async () => ({ discarded: true })); + const discover = vi.fn(async () => [{ + id: 'connect-candidate', + label: 'ProPR Connect', + apiBaseUrl: 'https://t-discovered123.propr.dev', + }]); + const rediscover = vi.fn(async (profileId: string) => ({ + id: profileId, + label: 'Team server', + apiBaseUrl: 'https://t-recovered456.propr.dev', + })); + const bridge: DesktopBridge = { + app: { + getMetadata: async () => ({ + name: 'ProPR Desktop', version: '0.8.15', platform: 'linux', arch: 'x64', packaged: true, + }), + onDeepLink, + }, + auth: { logout: async () => undefined }, + external: { open: async () => undefined }, + storage: { security: async () => ({ available: true, backend: 'keychain' }) }, + profiles: { + list: async () => ({ profiles, activeProfileId }), + save: async input => { + const saved = { ...storedProfile, id: input.id ?? 'new', label: input.label, apiBaseUrl: input.apiBaseUrl }; + profiles = [...profiles.filter(profile => profile.id !== saved.id), saved]; + return saved; + }, + remove: async profileId => { profiles = profiles.filter(profile => profile.id !== profileId); }, + setActive: async profileId => { activeProfileId = profileId; }, + }, + authentication: { pair, cancel: vi.fn(async () => undefined) }, + connection: { probe, activate, discard, invalidate: vi.fn(async () => ({ invalidated: false })) }, + discovery: { supported: true, discover, rediscover }, + lifecycle: { + status: async () => ({ state: 'disconnected' }), + start: async () => ({ ok: false, code: 'not-implemented', status: { state: 'disconnected' } }), + stop: async () => ({ ok: false, code: 'not-implemented', status: { state: 'disconnected' } }), + restart: async () => ({ ok: false, code: 'not-implemented', status: { state: 'disconnected' } }), + }, + }; + return { bridge, onDeepLink, pair, probe, activate, discard, discover, rediscover, profiles: () => profiles }; +}; + +describe('Electron remote instance adapters', () => { + beforeEach(() => { + window.localStorage.clear(); + window.sessionStorage.clear(); + desktopConnectionState.scope = null; + setDesktopConnectionScope.mockClear(); + }); + it('reports local setup as unavailable in the production Electron adapter', () => { + const adapters = createElectronDesktopAdapters(bridgeFixture().bridge); + + expect(adapters.localSetup.supported).toBe(false); + expect(adapters.discovery.supported).toBe(true); + }); + + it('forwards the renderer deep-link subscription through the Electron adapter once', () => { + const fixture = bridgeFixture(); + const adapters = createElectronDesktopAdapters(fixture.bridge); + const listener = vi.fn(); + + const unsubscribe = adapters.app.onDeepLink(listener); + + expect(fixture.onDeepLink).toHaveBeenCalledOnce(); + expect(fixture.onDeepLink).toHaveBeenCalledWith(listener); + unsubscribe(); + }); + + it('projects typed main discovery and managed recovery without renderer authority inputs', async () => { + const fixture = bridgeFixture(); + const adapters = createElectronDesktopAdapters(fixture.bridge); + + await expect(adapters.discovery.discover()).resolves.toEqual([{ + id: 'connect-candidate', + name: 'ProPR Connect', + baseUrl: 'https://t-discovered123.propr.dev', + kind: 'remote', + }]); + await expect(adapters.managedTunnelRecovery?.rediscover('profile-1')).resolves.toEqual({ + id: 'profile-1', + name: 'Team server', + baseUrl: 'https://t-recovered456.propr.dev', + kind: 'remote', + }); + expect(fixture.discover).toHaveBeenCalledWith(); + expect(fixture.rediscover).toHaveBeenCalledWith('profile-1'); + }); + + it('returns authentication cancellation rejection to the explicit UI settlement path', async () => { + const fixture = bridgeFixture(); + vi.mocked(fixture.bridge.authentication.cancel).mockRejectedValueOnce(new Error('private IPC detail')); + const adapters = createElectronDesktopAdapters(fixture.bridge); + + await expect(adapters.authentication.cancel?.('profile-1')).rejects.toThrow('private IPC detail'); + expect(fixture.bridge.authentication.cancel).toHaveBeenCalledWith('profile-1'); + }); + it('matches the shared canonical origin parity table before profile IPC', async () => { + const fixture = bridgeFixture(); + const adapters = createElectronDesktopAdapters(fixture.bridge); + let index = 0; + for (const [name, input, expected] of PROPR_API_ORIGIN_PARITY_CASES) { + const save = adapters.profiles.save({ + id: `parity-${index++}`, + name, + baseUrl: input, + kind: expected?.startsWith('http:') ? 'local' : 'remote', + }); + if (expected === null) await expect(save, name).rejects.toThrow(); + else { + await expect(save, name).resolves.toBeUndefined(); + expect(fixture.profiles().at(-1)?.apiBaseUrl).toBe(expected); + } + } + }); + it('uses status-only main-process pairing and probe APIs', async () => { + const fixture = bridgeFixture(); + const adapters = createElectronDesktopAdapters(fixture.bridge); + const profile = (await adapters.profiles.list())[0]; + window.localStorage.setItem('profile-state', 'A'); + window.sessionStorage.setItem('profile-session', 'A'); + + await adapters.authentication.authenticate(profile); + const result = await adapters.connection.probe(profile); + expect(fixture.pair).toHaveBeenCalledWith({ + id: profile.id, + label: profile.name, + apiBaseUrl: profile.baseUrl, + }); + expect(result).toEqual({ status: 'ready', version: '0.8.15', activationTicket: 'ticket-7' }); + expect('credentials' in fixture.bridge).toBe(false); + + if (result.status !== 'ready') return; + const activated = await adapters.connection.activate?.(profile, result); + expect(fixture.activate).toHaveBeenCalledWith('ticket-7'); + expect(activated).toEqual({ + status: 'ready', + version: '0.8.15', + authentication: undefined, + profileId: profile.id, + transportScope: 'scope-7', + identityEpoch: 'AAAAAAAAAAAAAAAAAAAAAA', + }); + if (activated?.status === 'ready') adapters.connection.publishActivation?.(profile, activated); + expect(setDesktopConnectionScope).toHaveBeenCalledWith({ + bridge: fixture.bridge, + profileId: storedProfile.id, + transportScope: 'scope-7', + }, profile.baseUrl); + }); + + it('rejects a main-bound profile mismatch without publishing the returned scope', async () => { + const fixture = bridgeFixture(); + fixture.activate.mockResolvedValueOnce({ + status: 'ready', + profileId: 'profile-2', + transportScope: 'wrong-profile-scope', + identityEpoch: 'BBBBBBBBBBBBBBBBBBBBBB', + }); + const adapters = createElectronDesktopAdapters(fixture.bridge); + const profile = (await adapters.profiles.list())[0]; + window.localStorage.setItem('profile-state', 'A'); + window.sessionStorage.setItem('profile-session', 'A'); + const probe = await adapters.connection.probe(profile); + if (probe.status !== 'ready') return; + + const activated = await adapters.connection.activate?.(profile, probe); + + expect(activated).toEqual(expect.objectContaining({ + status: 'authentication-required', + message: expect.stringMatching(/connection changed/i), + })); + expect(setDesktopConnectionScope).not.toHaveBeenCalled(); + expect(window.localStorage.getItem('profile-state')).toBe('A'); + expect(window.sessionStorage.getItem('profile-session')).toBe('A'); + expect(fixture.discard).toHaveBeenCalledWith({ + profileId: 'profile-2', transportScope: 'wrong-profile-scope', + }); + }); + + it('clears renderer storage after a successful same-origin profile switch', async () => { + const fixture = bridgeFixture(); + await fixture.bridge.profiles.save({ + id: 'profile-a', label: 'Profile A', apiBaseUrl: storedProfile.apiBaseUrl, + }); + await fixture.bridge.profiles.setActive('profile-a'); + const adapters = createElectronDesktopAdapters(fixture.bridge); + const profile = (await adapters.profiles.list())[0]; + window.localStorage.setItem('profile-state', 'profile-a-local-sentinel'); + window.sessionStorage.setItem('profile-session', 'profile-a-session-sentinel'); + const clear = vi.spyOn(Storage.prototype, 'clear'); + + const activated = await adapters.connection.activate?.(profile, { + status: 'ready', + version: '0.8.15', + activationTicket: 'ticket-7', + }); + + expect(activated?.status).toBe('ready'); + expect(window.localStorage.getItem('profile-state')).toBeNull(); + expect(window.sessionStorage.getItem('profile-session')).toBeNull(); + expect(clear).toHaveBeenCalledTimes(2); + if (activated?.status === 'ready') adapters.connection.publishActivation?.(profile, activated); + expect(clear.mock.invocationCallOrder.at(-1)).toBeLessThan(setDesktopConnectionScope.mock.invocationCallOrder[0]); + clear.mockRestore(); + }); + + it('retains state for the same credential and clears exactly once for a same-profile identity change', async () => { + const fixture = bridgeFixture(); + const adapters = createElectronDesktopAdapters(fixture.bridge); + const profile = (await adapters.profiles.list())[0]; + const activateAndPublish = async () => { + const activated = await adapters.connection.activate?.(profile, { + status: 'ready', activationTicket: 'ticket-7', + }); + if (activated?.status === 'ready') adapters.connection.publishActivation?.(profile, activated); + return activated; + }; + + await activateAndPublish(); + await fixture.bridge.profiles.setActive(profile.id); + window.localStorage.setItem('profile-state', 'credential-a-local'); + window.sessionStorage.setItem('profile-session', 'credential-a-session'); + const clear = vi.spyOn(Storage.prototype, 'clear'); + + const reconnect = await activateAndPublish(); + expect(reconnect).toEqual(expect.objectContaining({ + status: 'ready', identityEpoch: 'AAAAAAAAAAAAAAAAAAAAAA', + })); + expect(window.localStorage.getItem('profile-state')).toBe('credential-a-local'); + expect(window.sessionStorage.getItem('profile-session')).toBe('credential-a-session'); + expect(clear).not.toHaveBeenCalled(); + + fixture.activate.mockResolvedValueOnce({ + status: 'ready', + profileId: profile.id, + transportScope: 'scope-b', + identityEpoch: 'BBBBBBBBBBBBBBBBBBBBBB', + }); + const replacement = await activateAndPublish(); + expect(replacement).toEqual(expect.objectContaining({ + status: 'ready', identityEpoch: 'BBBBBBBBBBBBBBBBBBBBBB', + })); + expect(window.localStorage.getItem('profile-state')).toBeNull(); + expect(window.sessionStorage.getItem('profile-session')).toBeNull(); + expect(clear).toHaveBeenCalledTimes(2); + expect(clear.mock.invocationCallOrder.at(-1)).toBeLessThan(setDesktopConnectionScope.mock.invocationCallOrder.at(-1)!); + clear.mockRestore(); + }); + + it('cancels pairing and removes profiles entirely through main-process IPC', async () => { + const fixture = bridgeFixture(); + const adapters = createElectronDesktopAdapters(fixture.bridge); + + await adapters.profiles.remove('profile-1'); + + expect(fixture.bridge.authentication.cancel).toHaveBeenCalledWith('profile-1'); + expect(fixture.profiles()).toEqual([]); + }); + + it('leaves renderer state untouched while probing an edited profile origin', async () => { + const fixture = bridgeFixture(); + const adapters = createElectronDesktopAdapters(fixture.bridge); + window.localStorage.setItem('profile-state', 'A'); + window.sessionStorage.setItem('profile-session', 'A'); + + await adapters.connection.probe({ + ...fromProfile(storedProfile), + baseUrl: 'https://attacker.example.test', + }); + + expect(window.localStorage.getItem('profile-state')).toBe('A'); + expect(window.sessionStorage.getItem('profile-session')).toBe('A'); + expect(setDesktopConnectionScope).not.toHaveBeenCalled(); + }); + + it('leaves renderer state untouched when an origin edit save or pairing fails', async () => { + const fixture = bridgeFixture(); + const adapters = createElectronDesktopAdapters(fixture.bridge); + const edited = { ...fromProfile(storedProfile), baseUrl: 'https://edited.example.test' }; + window.localStorage.setItem('profile-state', 'A-local'); + window.sessionStorage.setItem('profile-session', 'A-session'); + vi.spyOn(fixture.bridge.profiles, 'save').mockRejectedValueOnce(new Error('save failed')); + await expect(adapters.profiles.save(edited)).rejects.toThrow('save failed'); + fixture.pair.mockRejectedValueOnce(new Error('pairing cancelled')); + await expect(adapters.authentication.authenticate(edited)).rejects.toThrow('pairing cancelled'); + expect(window.localStorage.getItem('profile-state')).toBe('A-local'); + expect(window.sessionStorage.getItem('profile-session')).toBe('A-session'); + }); + + it('does not clear on thrown or stale activation and discards only a stale main result', async () => { + const fixture = bridgeFixture(); + const adapters = createElectronDesktopAdapters(fixture.bridge); + const profile = (await adapters.profiles.list())[0]; + window.localStorage.setItem('profile-state', 'A'); + window.sessionStorage.setItem('profile-session', 'A'); + fixture.activate.mockRejectedValueOnce(new Error('activation failed')); + + await expect(adapters.connection.activate?.(profile, { + status: 'ready', activationTicket: 'ticket-throw', + })).rejects.toThrow('activation failed'); + expect(window.localStorage.getItem('profile-state')).toBe('A'); + expect(window.sessionStorage.getItem('profile-session')).toBe('A'); + + fixture.activate.mockResolvedValueOnce({ + status: 'ready', profileId: profile.id, transportScope: 'stale-scope', + identityEpoch: 'AAAAAAAAAAAAAAAAAAAAAA', + }); + const stale = await adapters.connection.activate?.(profile, { + status: 'ready', activationTicket: 'ticket-stale', + }, () => false); + expect(stale?.status).toBe('authentication-required'); + expect(window.localStorage.getItem('profile-state')).toBe('A'); + expect(window.sessionStorage.getItem('profile-session')).toBe('A'); + expect(fixture.discard).toHaveBeenCalledWith({ profileId: profile.id, transportScope: 'stale-scope' }); + }); + + it('does not clear a newer scope while a stale activation discard is pending', async () => { + const fixture = bridgeFixture(); + let finishDiscard!: (value: { discarded: boolean }) => void; + fixture.discard.mockReturnValueOnce(new Promise(resolve => { finishDiscard = resolve; })); + const adapters = createElectronDesktopAdapters(fixture.bridge); + const profile = (await adapters.profiles.list())[0]; + const staleActivation = adapters.connection.activate?.(profile, { + status: 'ready', activationTicket: 'ticket-stale', + }, () => false); + await vi.waitFor(() => expect(fixture.discard).toHaveBeenCalledWith({ + profileId: profile.id, transportScope: 'scope-7', + })); + + adapters.connection.publishActivation?.(profile, { + status: 'ready', + profileId: profile.id, + transportScope: 'newer-scope', + identityEpoch: 'BBBBBBBBBBBBBBBBBBBBBB', + }); + finishDiscard({ discarded: true }); + await staleActivation; + + expect(desktopConnectionState.scope).toEqual(expect.objectContaining({ + profileId: profile.id, + transportScope: 'newer-scope', + })); + expect(setDesktopConnectionScope).not.toHaveBeenCalledWith(null); + }); + + it('publishes no B scope and restores sentinels when storage clearing fails', async () => { + const fixture = bridgeFixture(); + await fixture.bridge.profiles.setActive('profile-a'); + const adapters = createElectronDesktopAdapters(fixture.bridge); + const profile = (await adapters.profiles.list())[0]; + window.localStorage.setItem('profile-state', 'A-local'); + window.sessionStorage.setItem('profile-session', 'A-session'); + const clear = vi.spyOn(Storage.prototype, 'clear').mockImplementationOnce(() => { + throw new Error('storage disabled'); + }); + + const activated = await adapters.connection.activate?.(profile, { + status: 'ready', activationTicket: 'ticket-7', + }); + + expect(activated).toEqual({ + status: 'offline', + message: 'Desktop storage isolation failed. Restart ProPR Desktop before connecting again.', + }); + expect(window.localStorage.getItem('profile-state')).toBe('A-local'); + expect(window.sessionStorage.getItem('profile-session')).toBe('A-session'); + expect(fixture.discard).toHaveBeenCalledWith({ profileId: profile.id, transportScope: 'scope-7' }); + expect(setDesktopConnectionScope).not.toHaveBeenCalled(); + clear.mockRestore(); + }); +}); + +const fromProfile = (profile: StoredProfile) => ({ + id: profile.id, + name: profile.label, + baseUrl: profile.apiBaseUrl, + kind: 'remote' as const, +}); diff --git a/propr-ui/src/desktop/electronAdapters.ts b/propr-ui/src/desktop/electronAdapters.ts new file mode 100644 index 000000000..f98cc53ea --- /dev/null +++ b/propr-ui/src/desktop/electronAdapters.ts @@ -0,0 +1,229 @@ +import { normalizeApiBaseUrl } from '@propr/client'; +import { isProprLoopbackHostname, parseProprConnectEndpoint } from '@propr/shared'; +import type { DesktopBridge, DesktopDiscoveryCandidate, DesktopProfile as StoredDesktopProfile } from '../../../apps/desktop/src/shared/contract'; +import { getDesktopConnectionScope, setDesktopConnectionScope } from '../api/apiClient'; +import type { DesktopAdapters, DesktopPlatform, DesktopProfile } from './types'; + +const platform = (value: string): DesktopPlatform => { + const normalized = value.toLowerCase(); + if (normalized.includes('mac')) return 'macos'; + if (normalized.includes('win')) return 'windows'; + return 'linux'; +}; + +const isLocal = (baseUrl: string): boolean => { + return isProprLoopbackHostname(new URL(baseUrl).hostname); +}; + +const fromStoredProfile = (profile: StoredDesktopProfile): DesktopProfile => ({ + id: profile.id, + name: profile.label, + baseUrl: profile.apiBaseUrl, + kind: isLocal(profile.apiBaseUrl) ? 'local' : 'remote', + lastConnectedAt: profile.updatedAt, +}); + +const toStoredProfile = (profile: DesktopProfile) => ({ + id: profile.id, + label: profile.name, + apiBaseUrl: normalizeApiBaseUrl(profile.baseUrl), +}); + +const fromDiscoveryCandidate = (candidate: DesktopDiscoveryCandidate): DesktopProfile | null => { + const endpoint = parseProprConnectEndpoint(candidate.apiBaseUrl); + if ( + !endpoint + || !/^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$/.test(candidate.id) + || candidate.label.length === 0 + || candidate.label.length > 80 + ) return null; + return { + id: candidate.id, + name: candidate.label, + baseUrl: endpoint.origin, + kind: 'remote', + }; +}; + +const snapshotStorage = (storage: Storage): [string, string][] => { + const snapshot: [string, string][] = []; + for (let index = 0; index < storage.length; index += 1) { + const key = storage.key(index); + if (key !== null) snapshot.push([key, storage.getItem(key) ?? '']); + } + return snapshot; +}; + +const restoreStorage = (storage: Storage, snapshot: [string, string][]): void => { + const expected = new Set(snapshot.map(([key]) => key)); + for (let index = storage.length - 1; index >= 0; index -= 1) { + const key = storage.key(index); + if (key !== null && !expected.has(key)) storage.removeItem(key); + } + snapshot.forEach(([key, value]) => storage.setItem(key, value)); +}; + +const clearRendererProfileState = (): boolean => { + let localSnapshot: [string, string][] = []; + let sessionSnapshot: [string, string][] = []; + try { + localSnapshot = snapshotStorage(window.localStorage); + sessionSnapshot = snapshotStorage(window.sessionStorage); + window.localStorage.clear(); + if (window.localStorage.length !== 0) throw new Error('Local storage was not cleared'); + window.sessionStorage.clear(); + if (window.sessionStorage.length !== 0) throw new Error('Session storage was not cleared'); + return true; + } catch { + try { restoreStorage(window.localStorage, localSnapshot); } catch { /* fail closed below */ } + try { restoreStorage(window.sessionStorage, sessionSnapshot); } catch { /* fail closed below */ } + return false; + } +}; + +export const createElectronDesktopAdapters = (bridge: DesktopBridge): DesktopAdapters => { + let publishedProfile: { id: string; origin: string; identityEpoch: string } | null = null; + return { + platform: platform(navigator.platform || navigator.userAgent), + app: { onDeepLink: listener => bridge.app.onDeepLink(listener) }, + profiles: { + async list() { + return (await bridge.profiles.list()).profiles.map(fromStoredProfile); + }, + async save(profile) { + await bridge.profiles.save(toStoredProfile(profile)); + }, + async remove(profileId) { + await bridge.authentication.cancel(profileId); + await bridge.profiles.remove(profileId); + }, + async getActiveId() { + return (await bridge.profiles.list()).activeProfileId; + }, + async setActiveId(profileId) { + await bridge.profiles.setActive(profileId); + if (profileId === null) { + setDesktopConnectionScope(null); + } + }, + }, + discovery: { + supported: bridge.discovery.supported, + async discover() { + return (await bridge.discovery.discover()) + .map(fromDiscoveryCandidate) + .filter((profile): profile is DesktopProfile => profile !== null); + }, + }, + managedTunnelRecovery: { + async rediscover(profileId) { + const candidate = await bridge.discovery.rediscover(profileId); + if (!candidate || candidate.id !== profileId) return null; + return fromDiscoveryCandidate(candidate); + }, + }, + ...(bridge.acceptance ? { + acceptance: { + reportJourneyStage: stage => bridge.acceptance!.reportJourneyStage(stage), + }, + } : {}), + authentication: { + async authenticate(profile) { + const security = await bridge.storage.security(); + if (!security.available) throw new Error('OS-backed secure storage is required for desktop pairing.'); + await bridge.authentication.pair(toStoredProfile(profile)); + }, + cancel(profileId) { + return bridge.authentication.cancel(profileId); + }, + }, + externalBrowser: { open: url => bridge.external.open(url) }, + localSetup: { + supported: false, + async setup() { + throw new Error('Local setup is not available in this desktop build. Connect to a running local instance instead.'); + }, + }, + connection: { + async probe(profile) { + return bridge.connection.probe(toStoredProfile(profile)); + }, + async activate(profile, result, isCurrent = () => true) { + if (result.activationTicket === undefined) throw new Error('Desktop activation ticket is missing.'); + const previousProfileId = (await bridge.profiles.list()).activeProfileId; + const activated = await bridge.connection.activate(result.activationTicket); + const discard = async () => { + await bridge.connection.discard({ + profileId: activated.profileId, + transportScope: activated.transportScope, + }).catch(() => undefined); + const currentScope = getDesktopConnectionScope(); + if (currentScope?.profileId === activated.profileId + && currentScope.transportScope === activated.transportScope) { + setDesktopConnectionScope(null); + } + }; + if (activated.profileId !== profile.id || !isCurrent()) { + await discard(); + return { + status: 'authentication-required', + message: 'This connection changed while it was being activated. Check it again to continue.', + version: result.version, + authentication: result.authentication, + }; + } + const intendedOrigin = normalizeApiBaseUrl(profile.baseUrl); + if (!/^[A-Za-z0-9_-]{22}$/.test(activated.identityEpoch)) { + await discard(); + return { + status: 'authentication-required', + message: 'This connection changed while it was being activated. Check it again to continue.', + version: result.version, + authentication: result.authentication, + }; + } + const isReplacement = publishedProfile === null + || previousProfileId !== profile.id + || publishedProfile.id !== profile.id + || publishedProfile.origin !== intendedOrigin + || publishedProfile.identityEpoch !== activated.identityEpoch; + if (isReplacement && !clearRendererProfileState()) { + await discard(); + return { + status: 'offline', + message: 'Desktop storage isolation failed. Restart ProPR Desktop before connecting again.', + }; + } + return { + status: 'ready', + version: result.version, + authentication: result.authentication, + profileId: activated.profileId, + transportScope: activated.transportScope, + identityEpoch: activated.identityEpoch, + }; + }, + publishActivation(profile, result) { + if (result.transportScope === undefined) throw new Error('Desktop transport scope is missing.'); + if (result.identityEpoch === undefined) throw new Error('Desktop credential identity is missing.'); + if (result.profileId === undefined || result.profileId !== profile.id) { + setDesktopConnectionScope(null); + throw new Error('Desktop activation profile changed before publication.'); + } + setDesktopConnectionScope({ + bridge, + profileId: result.profileId, + transportScope: result.transportScope, + }, profile.baseUrl); + publishedProfile = { + id: profile.id, + origin: normalizeApiBaseUrl(profile.baseUrl), + identityEpoch: result.identityEpoch, + }; + }, + deactivate() { + setDesktopConnectionScope(null); + }, + }, + }; +}; diff --git a/propr-ui/src/desktop/packagedTransportSmoke.ts b/propr-ui/src/desktop/packagedTransportSmoke.ts new file mode 100644 index 000000000..dda4d28fd --- /dev/null +++ b/propr-ui/src/desktop/packagedTransportSmoke.ts @@ -0,0 +1,186 @@ +import type { Socket } from '@propr/client'; +import { DESKTOP_TRANSPORT_SCOPE_QUERY } from '@propr/shared'; +import type { DesktopBridge } from '../../../apps/desktop/src/shared/contract'; +import { + apiFetch, + getDesktopConnectionScope, + handleDesktopAccessCode, + proprClient, +} from '../api/apiClient'; +import { createElectronDesktopAdapters } from './electronAdapters'; +import type { DesktopProfile } from './types'; + +interface SocketRecord { + socket: Socket; + profileId: string; + transportScope: string; +} + +interface SocketConnectionError extends Error { + data?: { code?: unknown }; +} + +const INVALID_INSTANCE_TOKEN = 'INVALID_INSTANCE_TOKEN'; + +interface PackagedTransportSmokeHarness { + activate(profile: DesktopProfile): Promise<{ + profileId: string; + transportScope: string; + identityEpoch: string; + contractsContainSecret: boolean; + }>; + rest(): Promise; + connectSocket(): Promise; + reconnectSocket(id: number): Promise; + expectSocketRejected(id: number): Promise; + disconnectSocket(id: number): void; + handleStaleInvalidation(profileId: string, transportScope: string): Promise; + rendererEvidence(): unknown; +} + +declare global { + interface Window { + __proprPackagedTransportSmoke?: PackagedTransportSmokeHarness; + } +} + +const waitForSocket = (socket: Socket, expected: 'connect' | 'connect_error'): Promise => + new Promise((resolve, reject) => { + const timer = window.setTimeout(() => { + cleanup(); + reject(new Error(`Packaged Socket.IO ${expected} timed out`)); + }, 5_000); + const connected = () => { + cleanup(); + if (expected === 'connect') { + resolve(); + return; + } + reject(new Error('Stale Socket.IO scope unexpectedly connected')); + }; + const failed = (error: SocketConnectionError) => { + cleanup(); + if (expected !== 'connect_error') { + reject(new Error(`Packaged Socket.IO connection failed: ${error.message}`)); + return; + } + if (error.message !== INVALID_INSTANCE_TOKEN || error.data?.code !== INVALID_INSTANCE_TOKEN) { + reject(new Error('Packaged stale Socket.IO rejection was not INVALID_INSTANCE_TOKEN')); + return; + } + resolve(); + }; + const cleanup = () => { + window.clearTimeout(timer); + socket.off('connect', connected); + socket.off('connect_error', failed); + }; + socket.once('connect', connected); + socket.once('connect_error', failed); + }); + +/** + * Packaged-only E2E driver. It deliberately composes the same adapter, + * apiFetch, ProprClient Socket.IO transport, scope rotation, and invalidation + * handling as the desktop application; it never receives a credential. + */ +export const installPackagedTransportSmokeHarness = (): void => { + const bridge = window.proprDesktop as DesktopBridge | undefined; + if (!bridge) throw new Error('Packaged preload bridge is unavailable'); + const adapters = createElectronDesktopAdapters(bridge); + const sockets = new Map(); + let nextSocketId = 1; + + const harness: PackagedTransportSmokeHarness = { + async activate(profile) { + const probed = await adapters.connection.probe(profile); + if (probed.status !== 'ready' || !adapters.connection.activate || !adapters.connection.publishActivation) { + throw new Error('Packaged desktop profile was not ready'); + } + const activated = await adapters.connection.activate(profile, probed); + if (activated.status !== 'ready' || !activated.profileId || !activated.transportScope || !activated.identityEpoch) { + throw new Error('Packaged desktop activation failed'); + } + adapters.connection.publishActivation(profile, activated); + return { + profileId: activated.profileId, + transportScope: activated.transportScope, + identityEpoch: activated.identityEpoch, + contractsContainSecret: JSON.stringify([probed, activated]).includes('propr_it_'), + }; + }, + async rest() { + const response = await apiFetch('/api/smoke/rest', { credentials: 'include' }); + if (!response.ok || (await response.json() as { ok?: boolean }).ok !== true) { + throw new Error('Packaged REST fixture failed'); + } + }, + async connectSocket() { + const scope = getDesktopConnectionScope(); + if (!scope) throw new Error('Packaged Socket.IO scope is unavailable'); + const socket = proprClient.connectSocket({ + transports: ['websocket'], + forceNew: true, + reconnection: true, + auth: { [DESKTOP_TRANSPORT_SCOPE_QUERY]: scope.transportScope }, + query: { [DESKTOP_TRANSPORT_SCOPE_QUERY]: scope.transportScope }, + }); + const id = nextSocketId++; + sockets.set(id, { socket, profileId: scope.profileId, transportScope: scope.transportScope }); + await waitForSocket(socket, 'connect'); + return id; + }, + async reconnectSocket(id) { + const record = sockets.get(id); + if (!record) throw new Error('Packaged Socket.IO connection is unavailable'); + record.socket.disconnect(); + const connected = waitForSocket(record.socket, 'connect'); + record.socket.connect(); + await connected; + }, + async expectSocketRejected(id) { + const record = sockets.get(id); + if (!record) throw new Error('Packaged Socket.IO connection is unavailable'); + const currentScope = getDesktopConnectionScope(); + if (!currentScope || currentScope.profileId !== record.profileId + || currentScope.transportScope === record.transportScope) { + throw new Error('Packaged stale Socket.IO activation was not rotated'); + } + record.socket.disconnect(); + record.socket.io.opts.query = { + [DESKTOP_TRANSPORT_SCOPE_QUERY]: currentScope.transportScope, + }; + const rejected = waitForSocket(record.socket, 'connect_error'); + try { + record.socket.connect(); + await rejected; + } finally { + record.socket.disconnect(); + } + }, + disconnectSocket(id) { + sockets.get(id)?.socket.disconnect(); + }, + handleStaleInvalidation(profileId, transportScope) { + return handleDesktopAccessCode('INVALID_INSTANCE_TOKEN', { bridge, profileId, transportScope }); + }, + rendererEvidence() { + return { + origin: location.origin, + href: location.href, + localStorage: Object.entries(localStorage), + sessionStorage: Object.entries(sessionStorage), + scope: getDesktopConnectionScope() && { + profileId: getDesktopConnectionScope()!.profileId, + transportScope: getDesktopConnectionScope()!.transportScope, + }, + }; + }, + }; + Object.defineProperty(window, '__proprPackagedTransportSmoke', { + configurable: false, + enumerable: false, + value: Object.freeze(harness), + writable: false, + }); +}; diff --git a/propr-ui/src/desktop/types.ts b/propr-ui/src/desktop/types.ts index 1bcab4343..c6b3f3cbe 100644 --- a/propr-ui/src/desktop/types.ts +++ b/propr-ui/src/desktop/types.ts @@ -9,8 +9,8 @@ export interface DesktopProfile { } export type DesktopConnectionResult = - | { status: 'ready'; version?: string } - | { status: 'authentication-required'; message?: string } + | { status: 'ready'; version?: string; authentication?: string; activationTicket?: string; transportScope?: string; profileId?: string; identityEpoch?: string } + | { status: 'authentication-required'; message?: string; version?: string; authentication?: string } | { status: 'incompatible'; message: string; version?: string } | { status: 'offline'; message: string }; @@ -23,6 +23,8 @@ export interface DesktopProfileAdapter { } export interface DesktopDiscoveryAdapter { + /** Whether this host has a real network-wide discovery provider. */ + supported: boolean; discover(): Promise; } @@ -33,34 +35,75 @@ export interface DesktopAuthenticationAdapter { * Opening the system browser alone is not successful authentication. */ authenticate(profile: DesktopProfile): Promise; + cancel?(profileId: string): Promise; } export const DESKTOP_AUTHENTICATION_COMPLETE_EVENT = 'propr:desktop-authentication-complete'; +export const DESKTOP_ACCESS_INVALID_EVENT = 'propr:desktop-access-invalid'; export interface DesktopAuthenticationCompleteEventDetail { profileId: string; } +export interface DesktopAccessInvalidEventDetail { + profileId: string; + transportScope: string; + code: string; +} + export interface DesktopExternalBrowserAdapter { open(url: string): Promise; } export interface DesktopLocalSetupAdapter { + supported: boolean; setup(): Promise; } export interface DesktopConnectionAdapter { probe(profile: DesktopProfile): Promise; + activate?( + profile: DesktopProfile, + result: Extract, + isCurrent?: () => boolean, + ): Promise; + publishActivation?(profile: DesktopProfile, result: Extract): void; + deactivate?(): void; +} + +export type DesktopAcceptanceJourneyStage = + | 'AUTHENTICATION_REQUIRED' + | 'CREDENTIAL_COMMITTED' + | 'AUTHENTICATED_REPROBE_READY' + | 'ACTIVATION_COMMITTED' + | 'ACTIVATION_PUBLISHED' + | 'REACT_CONNECTED'; + +export interface DesktopManagedTunnelRecoveryAdapter { + /** + * Request a secret-free Connect endpoint refresh for an existing profile. + * The renderer supplies only the opaque profile id and must explicitly + * confirm a returned candidate before it can replace the saved endpoint. + */ + rediscover(profileId: string): Promise; } export interface DesktopAdapters { platform: DesktopPlatform; + app: { + onDeepLink(listener: (url: string) => void): () => void; + }; profiles: DesktopProfileAdapter; discovery: DesktopDiscoveryAdapter; authentication: DesktopAuthenticationAdapter; externalBrowser: DesktopExternalBrowserAdapter; localSetup: DesktopLocalSetupAdapter; connection: DesktopConnectionAdapter; + managedTunnelRecovery?: DesktopManagedTunnelRecoveryAdapter; + /** @internal Authorized packaged-journey evidence; absent in production use. */ + acceptance?: { + reportJourneyStage(stage: DesktopAcceptanceJourneyStage): Promise; + }; } /** diff --git a/propr-ui/src/desktop/useDesktopDeepLinks.ts b/propr-ui/src/desktop/useDesktopDeepLinks.ts new file mode 100644 index 000000000..0e8a7a745 --- /dev/null +++ b/propr-ui/src/desktop/useDesktopDeepLinks.ts @@ -0,0 +1,138 @@ +import { useCallback, useEffect, useRef, useState } from 'react'; +import type { RefObject } from 'react'; +import { isProprLoopbackHostname } from '@propr/shared'; +import { connectApiBaseUrlFromDeepLink } from '../../../apps/desktop/src/security'; +import { DesktopDeepLinkNavigation, type DesktopDeepLinkInbox } from '../desktop-deep-link'; +import type { DesktopProfile } from './types'; + +const REJECTED_DEEP_LINK_MESSAGE = 'ProPR Desktop could not use that link. Choose an instance and try again.'; +const CONNECT_CANDIDATE_NOTICE = 'Review this untrusted instance address, then choose Connect to continue.'; + +type DesktopDeepLinkPhase = 'loading' | 'choose' | 'connecting' | 'blocked' | 'recovery-review' | 'connected'; + +interface UseDesktopDeepLinksOptions { + deepLinks?: DesktopDeepLinkInbox; + phase: DesktopDeepLinkPhase; + profileId: string | null; + activeProfileId: RefObject; + onStageConnectCandidate(candidate: DesktopProfile, phase: DesktopDeepLinkPhase): void; +} + +interface DesktopDeepLinkState { + deepLinkError: string | null; + editorNotice: string | null; + clearConnectCandidate(): void; + hasPendingConnectCandidate(): boolean; +} + +const createProfileId = (): string => { + try { return crypto.randomUUID(); } catch { return `profile-${Date.now()}`; } +}; + +/** Owns the one-consumer renderer handoff and stages Connect links without performing connection work. */ +export const useDesktopDeepLinks = ({ + deepLinks, + phase, + profileId, + activeProfileId, + onStageConnectCandidate, +}: UseDesktopDeepLinksOptions): DesktopDeepLinkState => { + const [deepLinkError, setDeepLinkError] = useState(null); + const [editorNotice, setEditorNotice] = useState(null); + const pendingConnectCandidate = useRef(false); + const startupOpenLinks = useRef([]); + const phaseRef = useRef(phase); + const profileIdRef = useRef(profileId); + const stageCandidateRef = useRef(onStageConnectCandidate); + phaseRef.current = phase; + profileIdRef.current = profileId; + stageCandidateRef.current = onStageConnectCandidate; + + const [navigation] = useState(() => new DesktopDeepLinkNavigation( + path => { + window.location.hash = path; + setDeepLinkError(null); + }, + () => setDeepLinkError(REJECTED_DEEP_LINK_MESSAGE), + )); + const handler = useRef<(value: string) => void>(() => undefined); + + handler.current = value => { + let action: string | null = null; + try { + const url = new URL(value); + if (url.protocol === 'propr:') action = url.hostname; + } catch { + // The fixed rejection below deliberately omits attacker-controlled input. + } + + if (action === 'connect') { + const baseUrl = connectApiBaseUrlFromDeepLink(value); + if (!baseUrl) { + setDeepLinkError(REJECTED_DEEP_LINK_MESSAGE); + return; + } + const candidate: DesktopProfile = { + id: createProfileId(), + name: 'Discovered ProPR instance', + baseUrl, + kind: isProprLoopbackHostname(new URL(baseUrl).hostname) ? 'local' : 'remote', + }; + pendingConnectCandidate.current = true; + setDeepLinkError(null); + setEditorNotice(CONNECT_CANDIDATE_NOTICE); + stageCandidateRef.current(candidate, phaseRef.current); + return; + } + + if (action === 'open') { + const currentPhase = phaseRef.current; + const currentProfileId = profileIdRef.current; + if (currentPhase === 'loading') { + startupOpenLinks.current.push(value); + return; + } + if ((currentPhase === 'connecting' || currentPhase === 'connected') && currentProfileId) { + if (activeProfileId.current !== currentProfileId + || !navigation.receive(value, currentProfileId)) { + setDeepLinkError(REJECTED_DEEP_LINK_MESSAGE); + } + return; + } + } + + setDeepLinkError(REJECTED_DEEP_LINK_MESSAGE); + }; + + useEffect(() => deepLinks?.subscribe(value => handler.current(value)), [deepLinks]); + + useEffect(() => { + if (phase === 'connecting' && profileId) { + navigation.setDashboardUnavailable(); + if (activeProfileId.current === profileId) { + startupOpenLinks.current.splice(0).forEach(value => navigation.receive(value, profileId)); + } else if (startupOpenLinks.current.splice(0).length > 0) { + setDeepLinkError(REJECTED_DEEP_LINK_MESSAGE); + } + return; + } + if (phase === 'connected' && profileId) { + if (activeProfileId.current === profileId) navigation.setDashboardReady(profileId); + else setDeepLinkError(REJECTED_DEEP_LINK_MESSAGE); + return; + } + navigation.setDashboardUnavailable(); + if (phase !== 'loading') { + if (startupOpenLinks.current.splice(0).length > 0) setDeepLinkError(REJECTED_DEEP_LINK_MESSAGE); + navigation.rejectPending(); + } + }, [activeProfileId, navigation, phase, profileId]); + + const clearConnectCandidate = useCallback(() => { + pendingConnectCandidate.current = false; + setEditorNotice(null); + }, []); + const hasPendingConnectCandidate = useCallback(() => pendingConnectCandidate.current, []); + + return { deepLinkError, editorNotice, clearConnectCandidate, hasPendingConnectCandidate }; +}; diff --git a/scripts/verify-native-connect-authority.mjs b/scripts/verify-native-connect-authority.mjs new file mode 100644 index 000000000..5ae5185e3 --- /dev/null +++ b/scripts/verify-native-connect-authority.mjs @@ -0,0 +1,44 @@ +#!/usr/bin/env node +import { spawnSync } from "node:child_process"; +import { join, resolve } from "node:path"; + +if (process.platform !== "darwin") { + process.stderr.write("Native Connect authority verification requires macOS.\n"); + process.exit(1); +} + +const root = resolve(import.meta.dirname, ".."); +const result = spawnSync(process.execPath, [ + "--import", "tsx", "--test", join(root, "test", "nativeConnectAuthority.test.ts"), +], { + cwd: root, + shell: false, + windowsHide: true, + encoding: "utf8", + env: process.env, + timeout: 30_000, + maxBuffer: 2 * 1024 * 1024, +}); + +const stdout = result.stdout ?? ""; +const stderr = result.stderr ?? ""; +process.stdout.write(stdout); +process.stderr.write(stderr); + +const tapValue = (name) => { + const matches = [...stdout.matchAll(new RegExp(`^# ${name} (\\d+)$`, "gm"))]; + return matches.length === 0 ? undefined : Number(matches.at(-1)[1]); +}; +const valid = result.status === 0 + && !result.error + && !result.signal + && tapValue("tests") === 6 + && tapValue("pass") === 6 + && tapValue("fail") === 0 + && tapValue("skipped") === 0; + +if (!valid) { + process.stderr.write("Native Darwin Connect authority proof was incomplete.\n"); + process.exit(1); +} +process.stdout.write("Native Darwin authority proof: tests=6 pass=6 fail=0 skipped=0\n"); diff --git a/scripts/verify-platform-safe-connect.mjs b/scripts/verify-platform-safe-connect.mjs new file mode 100644 index 000000000..7ffa2f4f8 --- /dev/null +++ b/scripts/verify-platform-safe-connect.mjs @@ -0,0 +1,50 @@ +#!/usr/bin/env node +import { spawnSync } from 'node:child_process'; +import { join, resolve } from 'node:path'; + +const root = resolve(import.meta.dirname, '..'); +const files = [ + 'packages/cli/src/commands/connectCommand.test.ts', + 'packages/cli/src/connectRootAuthority.test.ts', + 'packages/cli/src/commands/initStack.test.ts', + 'packages/cli/src/config/ConfigManager.test.ts', + 'packages/cli/src/index.test.ts', + 'packages/cli/src/orchestrator/index.test.ts', + 'packages/api/test/statusRoutes.test.ts', +].map((file) => join(root, file)); + +const result = spawnSync(process.execPath, [ + '--import', 'tsx', '--experimental-test-module-mocks', '--test', ...files, +], { + cwd: root, + shell: false, + windowsHide: true, + encoding: 'utf8', + env: process.env, + timeout: 90_000, + maxBuffer: 16 * 1024 * 1024, +}); + +const stdout = result.stdout ?? ''; +const stderr = result.stderr ?? ''; +process.stdout.write(stdout); +process.stderr.write(stderr); + +const tapValue = (name) => { + const matches = [...stdout.matchAll(new RegExp(`^# ${name} (\\d+)$`, 'gm'))]; + return matches.length === 0 ? undefined : Number(matches.at(-1)[1]); +}; +const valid = result.status === 0 + && !result.error + && !result.signal + && tapValue('tests') === 86 + && tapValue('pass') === 86 + && tapValue('fail') === 0 + && tapValue('skipped') === 0; + +if (!valid) { + process.stderr.write('Platform-safe Connect proof did not complete 86/86 within 90000ms.\n'); + process.exitCode = 1; +} else { + process.stdout.write('Platform-safe Connect proof: tests=86 pass=86 fail=0 skipped=0 budgetMs=90000\n'); +} diff --git a/scripts/verify-windows-standard-user-connect.mjs b/scripts/verify-windows-standard-user-connect.mjs new file mode 100644 index 000000000..010d7c4f0 --- /dev/null +++ b/scripts/verify-windows-standard-user-connect.mjs @@ -0,0 +1,480 @@ +#!/usr/bin/env node +import assert from "node:assert/strict"; +import { spawnSync } from "node:child_process"; +import { closeSync, constants, mkdtempSync, openSync, readFileSync, realpathSync, writeFileSync } from "node:fs"; +import { userInfo } from "node:os"; +import { dirname, join, resolve } from "node:path"; +import { pathToFileURL } from "node:url"; + +if (process.platform !== "win32") { + process.stderr.write("Ordinary-user Windows Connect discovery proof requires Windows.\n"); + process.exit(1); +} + +const expectedUser = process.argv[2]; +const preparedFixture = process.argv[3]; +const actualUser = userInfo().username; + +const repo = resolve(import.meta.dirname, ".."); +const cli = join(repo, "packages", "cli", "dist", "index.js"); +const fetchFixture = pathToFileURL(join(repo, "test", "fixtures", "connectFetchMock.mjs")).href; +const processFixture = pathToFileURL(join(repo, "test", "fixtures", "windowsConnectProcessMock.mjs")).href; +const authorityModule = pathToFileURL(join(repo, "packages", "cli", "dist", "connectRootAuthority.js")).href; +const windowsAuthorityModule = pathToFileURL(join(repo, "packages", "cli", "dist", "connectWindowsAuthority.js")).href; +const initStackModule = pathToFileURL(join(repo, "packages", "cli", "dist", "commands", "initStack.js")).href; +const configManagerModule = pathToFileURL(join(repo, "packages", "cli", "dist", "config", "ConfigManager.js")).href; +const fixtureNodeArgs = Object.freeze([ + "--no-warnings", + "--import", processFixture, + "--import", fetchFixture, +]); +assert.deepEqual(fixtureNodeArgs, [ + "--no-warnings", + "--import", processFixture, + "--import", fetchFixture, +]); +const fixture = realpathSync.native(preparedFixture); +const root = realpathSync.native(join(fixture, "stack-private-path-SENTINEL")); +const endpoint = "https://t-abc123.propr.dev"; +const identity = "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa"; + +function tunnelFixtureEnvLines({ enabled }) { + return [ + `PROPR_UI_TUNNEL_ENABLED=${enabled ? "true" : "false"}`, + ...(enabled ? ["PROPR_UI_TUNNEL_TOKEN=root-token-SENTINEL"] : []), + ]; +} + +function windowsRootEnvironment(systemRootMode, systemRoot, windir, untrustedRoot) { + if (systemRootMode === "missing") return {}; + return { + SYSTEMROOT: systemRoot, + WINDIR: systemRootMode === "mismatched" ? untrustedRoot : windir, + }; +} + +const WINDOWS_ROOT_MISSING_MARKER = "PROPR_TEST_WINDOWS_ROOT_MISSING"; +const WINDOWS_ROOT_MISSING_MARKER_VALUE = "windows-root-missing-v1"; + +function missingWindowsRootFixtureEnvironment(systemRootMode) { + return systemRootMode === "missing" + ? { [WINDOWS_ROOT_MISSING_MARKER]: WINDOWS_ROOT_MISSING_MARKER_VALUE } + : {}; +} + +const WINDOWS_ROOT_UNTRUSTED_MARKER = "PROPR_TEST_WINDOWS_ROOT_UNTRUSTED"; +const WINDOWS_ROOT_UNTRUSTED_MARKER_VALUE = "windows-root-untrusted-v1"; +const WINDOWS_ROOT_UNTRUSTED_PATH = "PROPR_TEST_WINDOWS_ROOT_UNTRUSTED_PATH"; + +function untrustedWindowsRootFixtureEnvironment(systemRootMode, untrustedRoot) { + return systemRootMode === "untrusted" + ? { + [WINDOWS_ROOT_UNTRUSTED_MARKER]: WINDOWS_ROOT_UNTRUSTED_MARKER_VALUE, + [WINDOWS_ROOT_UNTRUSTED_PATH]: untrustedRoot, + } + : {}; +} + +const scenarioAllowlist = Object.freeze([ + "ready", "down", "disabled", "restart-required", "malformed", "oversized", "timeout", + "identity-mismatch", "secret-sentinel", "api", "path-aba", "authority-malformed", "authority-oversized", + "authority-extra-key", "authority-duplicate", "authority-entry-count", "authority-entry-shape", + "authority-stderr", "authority-nonzero", + "authority-timeout", "authority-descriptor-mismatch", "authority-index-mismatch", + "authority-kind-mismatch", "authority-authority-kind-mismatch", "authority-identity-mismatch", + "authority-sid-mismatch", "authority-broad-write", "authority-inherited-write", + "authority-unprotected", "authority-owner-mismatch", "authority-reparse", + "authority-missing-system-root", "authority-mismatched-system-root", "authority-untrusted-system-root", +]); +const assertionStageAllowlist = Object.freeze([ + "native-timing", "authority-probe", "scaffold", "identity-assertion", "config-init", "config-save", + "config-assertion", + "write-env", "spawn", "signal", "exit", "bounds", "schema", "status", "endpoint", + "identity", "reasons", "api-ready", "restart", "stderr", "sentinel", "api-spawn", + "api-exit", "api-count", +]); +const statusKindAllowlist = Object.freeze([ + "ready", "internalFailure", "notReady", "incompatible", "invalidConfig", "timeout", +]); +const reasonCodeAllowlist = Object.freeze([ + "NOT_CONFIGURED", "TUNNEL_DISABLED", "SIDECAR_NOT_RUNNING", "API_UNREACHABLE", "API_TIMEOUT", + "DISCOVERY_UNSUPPORTED", "DISCOVERY_INVALID", "DISCOVERY_TOO_LARGE", "API_INCOMPATIBLE", + "DESKTOP_AUTHENTICATION_UNSUPPORTED", + "IDENTITY_MISMATCH", "ENDPOINT_MISMATCH", "RESTART_REQUIRED", "INVALID_ROOT", "INVALID_ENDPOINT", + "IDENTITY_UNAVAILABLE", "INTERNAL_FAILURE", "ACL_DIAGNOSTIC_UNAVAILABLE", +]); +const nativeStageAllowlist = Object.freeze([ + "resolver:env", "resolver:canonical", "resolver:global-open", "resolver:global-id", + "spawn:create", "spawn:error", "spawn:timeout", "spawn:cumulative-timeout", "spawn:status", "spawn:stderr", + "probe:entry", "probe:baseline", "probe:reflection-emit", "probe:win32", "probe:standard-handle", "probe:output", + "broker:ps-version", "broker:job", "broker:fd", "broker:fd-duplicate", "broker:index-info-initial", + "broker:security-info", "broker:acl", "broker:json", "broker:current-user-sid", + "broker:index-info-revalidation", "broker:index-info-decode", "broker:index-info-compose", "broker:entry-format", + "broker:entry-flags", "broker:entry-rules", "broker:entry-build", + "parent:utf8", "parent:json-parse", "parent:json-canonical", "parent:document-shape", + "parent:entry-count", "parent:entry-shape", "parent:json-shape", "parent:descriptor-bind", "parent:post-bind", +]); +const probeMilestoneAllowlist = Object.freeze([ + "none", "entry-ps51-desktop-x64", "constant-json", "reflection-emit", "harmless-win32", + "standard-handle-identity", +]); +const probeTimingAllowlist = Object.freeze([ + "under-5s", "5-to-15s", "15-to-30s", "30-to-45s", "45-to-60s", "at-least-60s", +]); +const WINDOWS_PRODUCT_AUTHORITY_PHASE_COUNT = 2; +const WINDOWS_PRODUCT_SCENARIO_OVERHEAD_MS = 15_000; +const scenarioNames = new Set(scenarioAllowlist); +const assertionStages = new Set(assertionStageAllowlist); +const statusKinds = new Set(statusKindAllowlist); +const diagnosticStatuses = new Set([null, ...statusKindAllowlist]); +const reasonCodes = new Set(reasonCodeAllowlist); +const nativeStages = new Set(nativeStageAllowlist); +const probeMilestones = new Set(probeMilestoneAllowlist); +const probeTimings = new Set(probeTimingAllowlist); + +function parseBoundedFailureStatus(stdout) { + if (typeof stdout !== "string" || stdout.length === 0 || Buffer.byteLength(stdout, "utf8") >= 2048) return null; + const lines = stdout.trim().split(/\r?\n/); + if (lines.length !== 1) return null; + try { + const document = JSON.parse(lines[0]); + if (!document || typeof document !== "object" || !statusKinds.has(document.status) + || !Array.isArray(document.reasonCodes) || document.reasonCodes.length > reasonCodes.size + || new Set(document.reasonCodes).size !== document.reasonCodes.length + || document.reasonCodes.some((code) => !reasonCodes.has(code))) return null; + return { status: document.status, reasonCodes: document.reasonCodes }; + } catch { + return null; + } +} + +function createFailureDiagnostic(scenario, stage, failureStatus, nativeStage, probe) { + const status = failureStatus?.status ?? null; + const codes = failureStatus?.reasonCodes ?? []; + if (!scenarioNames.has(scenario) || !assertionStages.has(stage) || !diagnosticStatuses.has(status) + || (nativeStage !== null && !nativeStages.has(nativeStage)) + || (probe.milestone !== null && !probeMilestones.has(probe.milestone)) + || (probe.timing !== null && !probeTimings.has(probe.timing)) + || !Array.isArray(codes) || codes.length > reasonCodes.size + || new Set(codes).size !== codes.length || codes.some((code) => !reasonCodes.has(code))) { + return { + scenario: "ready", stage: "write-env", nativeStage: null, status: null, reasonCodes: [], + probeMilestone: null, probeTiming: null, + }; + } + return { + scenario, stage, nativeStage, status, reasonCodes: [...codes], + probeMilestone: probe.milestone, + probeTiming: probe.timing, + }; +} + +function extractNativeDiagnostic(stderr) { + let nativeStage = null; + const applicationStderr = stderr.replace(/^\[propr-windows-native-stage:([^\]]+)\]\r?\n/gm, (_line, stage) => { + nativeStage = nativeStages.has(stage) ? stage : "parent:json-shape"; + return ""; + }); + return { applicationStderr, nativeStage }; +} + +const cases = [ + { name: "ready", fetch: "ready", docker: "ready", enabled: true, status: "ready", exit: 0, reasons: [] }, + { name: "down", fetch: "ready", docker: "down", authorityMode: "valid-authority", enabled: true, status: "notReady", exit: 0, reasons: ["SIDECAR_NOT_RUNNING"] }, + { name: "disabled", fetch: "ready", docker: "ready", authorityMode: "valid-authority", enabled: false, status: "notReady", exit: 0, reasons: ["TUNNEL_DISABLED"] }, + { name: "restart-required", fetch: "restart-required", docker: "ready", authorityMode: "valid-authority", enabled: true, status: "notReady", exit: 0, reasons: ["ENDPOINT_MISMATCH", "RESTART_REQUIRED"] }, + { name: "malformed", fetch: "invalid", docker: "ready", authorityMode: "valid-authority", enabled: true, status: "incompatible", exit: 2, reasons: ["DISCOVERY_INVALID"] }, + { name: "oversized", fetch: "oversized", docker: "ready", authorityMode: "valid-authority", enabled: true, status: "incompatible", exit: 2, reasons: ["DISCOVERY_TOO_LARGE"] }, + { name: "timeout", fetch: "timeout", docker: "ready", authorityMode: "valid-authority", enabled: true, status: "timeout", exit: 0, reasons: ["API_TIMEOUT"] }, + { name: "identity-mismatch", fetch: "identity-mismatch", docker: "ready", authorityMode: "valid-authority", enabled: true, status: "notReady", exit: 0, reasons: ["IDENTITY_MISMATCH"] }, + { name: "secret-sentinel", fetch: "secret-sentinel", docker: "ready", authorityMode: "valid-authority", enabled: true, status: "notReady", exit: 0, reasons: ["API_UNREACHABLE"] }, +]; +const authorityFailures = [ + { name: "path-aba", mode: "path-aba", reason: "INVALID_ROOT" }, + { name: "authority-malformed", mode: "malformed", nativeStage: "parent:json-parse" }, + { name: "authority-oversized", mode: "oversized" }, + { name: "authority-extra-key", mode: "extra-key", nativeStage: "parent:document-shape" }, + { name: "authority-duplicate", mode: "duplicate", nativeStage: "parent:json-canonical" }, + { name: "authority-entry-count", mode: "entry-count", nativeStage: "parent:entry-count" }, + { name: "authority-entry-shape", mode: "entry-shape", nativeStage: "parent:entry-shape" }, + { name: "authority-stderr", mode: "stderr" }, + { name: "authority-nonzero", mode: "nonzero" }, + { name: "authority-timeout", mode: "timeout" }, + { name: "authority-descriptor-mismatch", mode: "descriptor-mismatch" }, + { name: "authority-index-mismatch", mode: "index-mismatch" }, + { name: "authority-kind-mismatch", mode: "kind-mismatch" }, + { name: "authority-authority-kind-mismatch", mode: "authority-kind-mismatch" }, + { name: "authority-identity-mismatch", mode: "identity-mismatch" }, + { name: "authority-sid-mismatch", mode: "sid-mismatch" }, + { name: "authority-broad-write", mode: "broad-write", reason: "INVALID_ROOT" }, + { name: "authority-inherited-write", mode: "inherited-write", reason: "INVALID_ROOT" }, + { name: "authority-unprotected", mode: "unprotected", reason: "INVALID_ROOT" }, + { name: "authority-owner-mismatch", mode: "owner-mismatch", reason: "INVALID_ROOT" }, + { name: "authority-reparse", mode: "reparse", reason: "INVALID_ROOT" }, + { name: "authority-missing-system-root", systemRootMode: "missing", nativeStage: "resolver:env" }, + { name: "authority-mismatched-system-root", systemRootMode: "mismatched" }, + { name: "authority-untrusted-system-root", systemRootMode: "untrusted", nativeStage: "resolver:global-id" }, +]; + +let currentScenario = "ready"; +let currentStage = "write-env"; +let failureStatus = null; +let currentNativeStage = null; +const nativeProbe = { milestone: null, timing: null, evidence: null }; +try { + assert.ok(expectedUser && actualUser.toLowerCase() === expectedUser.toLowerCase(), "proof did not run as the limited user"); + currentStage = "native-timing"; + const nativeAuthority = await import(windowsAuthorityModule); + const WINDOWS_PRODUCT_SCENARIO_TIMEOUT_MS = ( + WINDOWS_PRODUCT_AUTHORITY_PHASE_COUNT + * nativeAuthority.WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS + ) + WINDOWS_PRODUCT_SCENARIO_OVERHEAD_MS; + const probeFd = openSync( + fixture, + constants.O_RDONLY | constants.O_DIRECTORY | constants.O_NOFOLLOW, + ); + try { + try { + const proof = nativeAuthority.runWindowsNativeTimingProbe(probeFd); + assert.equal(proof.version, 1); + nativeProbe.milestone = proof.lastMilestone; + nativeProbe.timing = proof.timingBucket; + if (proof.outcome === "timeout") currentNativeStage = "spawn:timeout"; + assert.equal(proof.outcome, "complete"); + assert.deepEqual(proof.milestones.map(({ milestone }) => milestone), [ + "entry-ps51-desktop-x64", "constant-json", "reflection-emit", "harmless-win32", + "standard-handle-identity", + ]); + assert.ok(proof.milestones.every(({ milestone, timingBucket }) => ( + probeMilestones.has(milestone) && probeTimings.has(timingBucket) + ))); + nativeProbe.evidence = proof.milestones.map( + ({ milestone, timingBucket }) => `${milestone}:${timingBucket}`, + ).join(","); + } catch (error) { + currentNativeStage = nativeStages.has(error?.stage) + ? error.stage + : (currentNativeStage ?? "parent:json-shape"); + throw error; + } + } finally { + closeSync(probeFd); + } + currentStage = "authority-probe"; + const authority = await import(authorityModule); + await assert.rejects( + authority.protectWindowsSetupEntries([{ path: root, kind: "directory" }]), + (error) => error?.code === authority.WINDOWS_AUTHORITY_REQUIRED_CODE + && /authority is required/i.test(error.message) + && /#1997/.test(error.message), + "privileged Windows mutation did not return the actionable follow-up result", + ); + + // Privileged mutation stays deferred even though read-only discovery now + // inspects the already-open descriptors through the OS PowerShell boundary. + currentStage = "scaffold"; + const { scaffoldStack } = await import(initStackModule); + const mutationRoot = realpathSync.native(mkdtempSync(join(fixture, "stack-"))); + writeFileSync(join(mutationRoot, ".env"), "SESSION_SECRET=existing\nNODE_ENV=production\n"); + const scaffold = await scaffoldStack( + { root: mutationRoot }, + { persistStackRoot: async () => undefined }, + ); + currentStage = "identity-assertion"; + assert.equal(scaffold.envSkipped, true); + assert.ok(readFileSync(join(mutationRoot, "data", "public-instance-identity.json"), "utf8").length > 0); + + currentStage = "config-init"; + const { ConfigManager } = await import(configManagerModule); + const configDirectory = join(fixture, "config"); + const manager = new ConfigManager(configDirectory, { warn: () => undefined }); + await manager.init(); + currentStage = "config-save"; + await manager.save(); + currentStage = "config-assertion"; + assert.deepEqual(JSON.parse(readFileSync(join(configDirectory, "config.json"), "utf8")), {}); + + for (const scenario of cases) { + currentScenario = scenario.name; + currentStage = "write-env"; + failureStatus = null; + currentNativeStage = null; + writeFileSync(join(root, ".env"), [ + "PROPR_STACK=authorized", + "PROPR_INSTANCE_ID=abc123", + `PROPR_UI_PUBLIC_API_URL=${endpoint}`, + ...tunnelFixtureEnvLines(scenario), + "", + ].join("\n")); + currentStage = "spawn"; + const result = spawnSync(process.execPath, [ + ...fixtureNodeArgs, + cli, + "connect", "status", "--json", "--root", root, + ], { + cwd: fixture, + shell: false, + windowsHide: true, + encoding: "utf8", + timeout: WINDOWS_PRODUCT_SCENARIO_TIMEOUT_MS, + maxBuffer: 16 * 1024, + env: { + PATH: dirname(process.execPath), + PATHEXT: process.env.PATHEXT, + SYSTEMROOT: process.env.SystemRoot, + WINDIR: process.env.WINDIR, + COMSPEC: process.env.ComSpec, + USERPROFILE: process.env.USERPROFILE, + HOMEDRIVE: process.env.HOMEDRIVE, + HOMEPATH: process.env.HOMEPATH, + PROPR_TEST_DISCOVERY_MODE: scenario.fetch, + PROPR_TEST_DOCKER_MODE: scenario.docker, + PROPR_TEST_PUBLIC_IDENTITY: identity, + ...(scenario.authorityMode ? { + PROPR_TEST_AUTHORITY_MODE: scenario.authorityMode, + PROPR_TEST_AUTHORITY_ROOT: root, + } : {}), + PROPR_CONNECTOR_TOKEN: "connector-token-SENTINEL", + PROPR_RELAY_TOKEN: "relay-token-SENTINEL", + GITHUB_TOKEN: "github-token-SENTINEL", + }, + }); + const nativeDiagnostic = extractNativeDiagnostic(result.stderr); + currentNativeStage = nativeDiagnostic.nativeStage; + currentStage = "bounds"; + failureStatus = parseBoundedFailureStatus(result.stdout); + currentStage = "signal"; + assert.equal(result.signal, null, scenario.name); + currentStage = "exit"; + assert.equal(result.status, scenario.exit, scenario.name); + currentStage = "bounds"; + assert.ok(result.stdout.length > 0 && result.stdout.length < 2048, scenario.name); + currentStage = "schema"; + assert.equal(result.stdout.trim().split(/\r?\n/).length, 1, scenario.name); + const document = JSON.parse(result.stdout); + currentStage = "status"; + assert.equal(document.status, scenario.status, scenario.name); + currentStage = "endpoint"; + assert.equal(document.canonicalEndpoint, endpoint, scenario.name); + currentStage = "identity"; + assert.equal(document.publicInstanceIdentity, identity, scenario.name); + currentStage = "reasons"; + assert.deepEqual(document.reasonCodes, scenario.reasons, scenario.name); + currentStage = "api-ready"; + assert.equal(document.apiReady, scenario.status === "ready", scenario.name); + currentStage = "restart"; + assert.equal(document.restartRequired, scenario.name === "restart-required", scenario.name); + currentStage = "stderr"; + const expectedStderr = scenario.status === "ready" ? "" : `ProPR Connect discovery: ${scenario.status}.\n`; + assert.equal(nativeDiagnostic.applicationStderr, expectedStderr, scenario.name); + currentStage = "sentinel"; + for (const sentinel of [ + "root-token-SENTINEL", "connector-token-SENTINEL", "relay-token-SENTINEL", + "github-token-SENTINEL", "docker-secret-SENTINEL", "private-path-SENTINEL", fixture, + ]) { + assert.equal(result.stdout.includes(sentinel), false, `${scenario.name} stdout leaked ${sentinel}`); + assert.equal(nativeDiagnostic.applicationStderr.includes(sentinel), false, `${scenario.name} stderr leaked ${sentinel}`); + } + } + + for (const scenario of authorityFailures) { + currentScenario = scenario.name; + currentStage = "spawn"; + failureStatus = null; + currentNativeStage = null; + const result = spawnSync(process.execPath, [ + ...fixtureNodeArgs, + cli, + "connect", "status", "--json", "--root", root, + ], { + cwd: fixture, + shell: false, + windowsHide: true, + encoding: "utf8", + timeout: WINDOWS_PRODUCT_SCENARIO_TIMEOUT_MS, + maxBuffer: 16 * 1024, + env: { + PATH: dirname(process.execPath), + PATHEXT: process.env.PATHEXT, + ...windowsRootEnvironment( + scenario.systemRootMode, + process.env.SystemRoot, + process.env.WINDIR, + fixture, + ), + ...missingWindowsRootFixtureEnvironment(scenario.systemRootMode), + ...untrustedWindowsRootFixtureEnvironment(scenario.systemRootMode, fixture), + COMSPEC: process.env.ComSpec, + USERPROFILE: process.env.USERPROFILE, + HOMEDRIVE: process.env.HOMEDRIVE, + HOMEPATH: process.env.HOMEPATH, + PROPR_TEST_DISCOVERY_MODE: "ready", + PROPR_TEST_DOCKER_MODE: "ready", + PROPR_TEST_PUBLIC_IDENTITY: identity, + PROPR_TEST_AUTHORITY_MODE: scenario.mode, + ...(scenario.mode === "path-aba" ? { PROPR_TEST_AUTHORITY_ROOT: root } : {}), + }, + }); + const nativeDiagnostic = extractNativeDiagnostic(result.stderr); + currentNativeStage = nativeDiagnostic.nativeStage; + if (scenario.nativeStage !== undefined) { + assert.equal(currentNativeStage, scenario.nativeStage, scenario.name); + } + currentStage = "bounds"; + failureStatus = parseBoundedFailureStatus(result.stdout); + currentStage = "signal"; + assert.equal(result.signal, null, scenario.name); + currentStage = "exit"; + assert.equal(result.status, 1, scenario.name); + currentStage = "schema"; + const document = JSON.parse(result.stdout); + currentStage = "status"; + assert.equal(document.status, "invalidConfig", scenario.name); + currentStage = "reasons"; + assert.deepEqual(document.reasonCodes, [scenario.reason ?? "ACL_DIAGNOSTIC_UNAVAILABLE"], scenario.name); + currentStage = "stderr"; + assert.equal(nativeDiagnostic.applicationStderr, "ProPR Connect discovery: invalidConfig.\n", scenario.name); + currentStage = "sentinel"; + for (const sentinel of [ + fixture, "private-path-SENTINEL", "attacker-replacement-SENTINEL", + "S-1-5-21-999", "raw-error-SENTINEL", + ]) { + assert.equal(result.stdout.includes(sentinel), false, scenario.name); + assert.equal(nativeDiagnostic.applicationStderr.includes(sentinel), false, scenario.name); + } + } + + currentScenario = "api"; + currentStage = "api-spawn"; + failureStatus = null; + const api = spawnSync(process.execPath, [ + "--import", "tsx", "--test", join(repo, "packages", "api", "test", "statusRoutes.test.ts"), + ], { + cwd: repo, + shell: false, + windowsHide: true, + encoding: "utf8", + timeout: 30_000, + maxBuffer: 4 * 1024 * 1024, + env: process.env, + }); + currentStage = "api-exit"; + assert.equal(api.status, 0, api.stderr || api.stdout); + currentStage = "api-count"; + const pass = [...api.stdout.matchAll(/^# pass (\d+)$/gm)].at(-1); + const fail = [...api.stdout.matchAll(/^# fail (\d+)$/gm)].at(-1); + assert.ok(pass && Number(pass[1]) > 0, "API discovery tests did not report passes"); + assert.equal(Number(fail?.[1]), 0, "API discovery tests reported failures"); + process.stdout.write(`Windows ordinary-user discovery proof: ready=standard-handle-passed native-timing=${nativeProbe.evidence};total:${nativeProbe.timing} cli=${cases.length} api=${pass[1]} authority=${authorityFailures.length}\n`); +} catch { + const diagnostic = createFailureDiagnostic( + currentScenario, currentStage, failureStatus, currentNativeStage, nativeProbe, + ); + process.stderr.write(`Windows ordinary-user discovery assertion failed: ${JSON.stringify( + diagnostic, + )}\n`); + process.exitCode = 1; +} finally { + // The elevated workflow owner removes the prepared fixture after the + // limited-user process exits. +} diff --git a/test/config-followup.test.ts b/test/config-followup.test.ts index a4d008e94..fe48af4be 100644 --- a/test/config-followup.test.ts +++ b/test/config-followup.test.ts @@ -64,7 +64,7 @@ test('saveSettingsWithRollback returns a specific failure without partial-commit database: testDb, settings: { planner_context_model: 'gpt-5', - pr_review_model: 'claude-sonnet-4-6' + pr_review_model: '' }, publishConfigUpdate: async () => { published += 1; diff --git a/test/connectCliIntegration.test.ts b/test/connectCliIntegration.test.ts new file mode 100644 index 000000000..9e509db98 --- /dev/null +++ b/test/connectCliIntegration.test.ts @@ -0,0 +1,520 @@ +import assert from 'node:assert/strict'; +import { spawnSync } from 'node:child_process'; +import { createHash } from 'node:crypto'; +import { + chmodSync, + closeSync, + constants, + cpSync, + existsSync, + fstatSync, + lstatSync, + mkdtempSync, + mkdirSync, + openSync, + readFileSync, + readlinkSync, + rmSync, + symlinkSync, + writeFileSync, +} from 'node:fs'; +import { tmpdir, userInfo } from 'node:os'; +import { join } from 'node:path'; +import { test } from 'node:test'; +import { getOrCreatePublicInstanceIdentity } from '../packages/cli/src/connectIdentity.js'; + +const CLI = join(process.cwd(), 'packages', 'cli', 'dist', 'index.js'); +const FETCH_FIXTURE = join(process.cwd(), 'test', 'fixtures', 'connectFetchMock.mjs'); +const OS_HOME_FIXTURE = join(process.cwd(), 'test', 'fixtures', 'connectOsHomeMock.mjs'); +const IDENTITY = 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa'; +const ENDPOINT = 'https://t-abc123.propr.dev'; +const FIXTURE_NODE_ARGS = Object.freeze([ + '--no-warnings', + '--import', + OS_HOME_FIXTURE, + '--import', + FETCH_FIXTURE, +]); + +assert.deepEqual(FIXTURE_NODE_ARGS, [ + '--no-warnings', + '--import', + OS_HOME_FIXTURE, + '--import', + FETCH_FIXTURE, +]); + +interface PathSnapshot { + kind: 'absent' | 'directory' | 'file' | 'other' | 'symlink'; + metadata?: { + birthtimeMs: number; + ctimeMs: number; + dev: number; + gid: number; + ino: number; + mode: number; + mtimeMs: number; + nlink: number; + size: number; + uid: number; + }; + sha256?: string; + target?: string; +} + +function snapshotPath(path: string): PathSnapshot { + let named: ReturnType; + try { + named = lstatSync(path); + } catch (error) { + if ((error as NodeJS.ErrnoException).code === 'ENOENT') return { kind: 'absent' }; + throw error; + } + const metadata = { + birthtimeMs: named.birthtimeMs, + ctimeMs: named.ctimeMs, + dev: named.dev, + gid: named.gid, + ino: named.ino, + mode: named.mode, + mtimeMs: named.mtimeMs, + nlink: named.nlink, + size: named.size, + uid: named.uid, + }; + if (named.isSymbolicLink()) return { kind: 'symlink', metadata, target: readlinkSync(path) }; + if (named.isDirectory()) return { kind: 'directory', metadata }; + if (!named.isFile()) return { kind: 'other', metadata }; + + const fd = openSync(path, constants.O_RDONLY | constants.O_NOFOLLOW); + try { + const held = fstatSync(fd); + assert.equal(held.dev, named.dev, 'OS config changed while its bytes were snapshotted'); + assert.equal(held.ino, named.ino, 'OS config changed while its bytes were snapshotted'); + return { + kind: 'file', + metadata, + sha256: createHash('sha256').update(readFileSync(fd)).digest('hex'), + }; + } finally { + closeSync(fd); + } +} + +function makeRoot( + parent: string, + name: string, + endpoint = ENDPOINT, + tunnel: { token?: string; enabled?: string } = { + token: 'relay-token-in-root-SENTINEL', + enabled: 'true', + }, +): string { + const root = join(parent, name); + mkdirSync(join(root, 'data'), { recursive: true, mode: 0o700 }); + chmodSync(root, 0o700); + chmodSync(join(root, 'data'), 0o700); + writeFileSync(join(root, '.env'), [ + 'PROPR_STACK=authorized', + 'PROPR_INSTANCE_ID=abc123', + `PROPR_UI_PUBLIC_API_URL=${endpoint}`, + ...(tunnel.enabled === undefined ? [] : [`PROPR_UI_TUNNEL_ENABLED=${tunnel.enabled}`]), + ...(tunnel.token === undefined ? [] : [`PROPR_UI_TUNNEL_TOKEN=${tunnel.token}`]), + '', + ].join('\n'), { mode: 0o600 }); + chmodSync(join(root, '.env'), 0o600); + return root; +} + +function persistTunnelOverride(home: string, root: string, enabled: boolean): void { + const configDir = join(home, '.propr'); + mkdirSync(configDir, { recursive: true, mode: 0o700 }); + chmodSync(configDir, 0o700); + const configPath = join(configDir, 'config.json'); + writeFileSync(configPath, JSON.stringify({ + tunnelEnabledByRoot: { [root]: enabled }, + }), { mode: 0o600 }); + chmodSync(configPath, 0o600); +} + +function installFakeDocker(parent: string): string { + const bin = join(parent, 'bin'); + mkdirSync(bin, { mode: 0o700 }); + const docker = join(bin, 'docker'); + writeFileSync(docker, `#!${process.execPath} +const fs = require('node:fs'); +const path = require('node:path'); +const behaviorPath = path.join(__dirname, 'docker-behavior'); +const behavior = fs.existsSync(behaviorPath) ? fs.readFileSync(behaviorPath, 'utf8') : 'ready'; +const expectationsPath = path.join(__dirname, 'docker-env-expectations'); +if (fs.existsSync(expectationsPath)) { + const expected = JSON.parse(fs.readFileSync(expectationsPath, 'utf8')); + if (Object.entries(expected).some(([name, value]) => process.env[name] !== value)) process.exit(8); +} +const denied = ['DOCKER_AUTH_CONFIG', 'REGISTRY_PASSWORD', 'PROPR_CONNECTOR_TOKEN', 'PROPR_RELAY_TOKEN', 'GITHUB_TOKEN', 'NODE_OPTIONS', 'HTTP_PROXY', 'HTTPS_PROXY', 'NO_PROXY', 'UNTRUSTED_AMBIENT']; +if (denied.some((name) => process.env[name] !== undefined)) process.exit(8); +const expectedArgs = ['ps', '-a', '--filter', 'label=propr.stack=authorized', '--format', '{{.Names}}\\t{{.State}}\\t{{.Status}}\\t{{.Ports}}']; +const exactFilter = JSON.stringify(process.argv.slice(2)) === JSON.stringify(expectedArgs); +const replacementPath = path.join(__dirname, 'replace-root'); +if (fs.existsSync(replacementPath)) { + const root = fs.readFileSync(replacementPath, 'utf8'); + const detached = root + '.detached'; + fs.renameSync(root, detached); + fs.mkdirSync(path.join(root, 'data'), { recursive: true, mode: 0o700 }); + fs.chmodSync(root, 0o700); + fs.chmodSync(path.join(root, 'data'), 0o700); + fs.writeFileSync(path.join(root, '.env'), 'REPLACEMENT_BYTES_SENTINEL=never-read\\n', { mode: 0o600 }); +} +process.stderr.write('docker-private-output-SENTINEL\\n'); +if (behavior === 'nonzero') process.exit(9); +if (behavior === 'timeout') setInterval(() => {}, 60_000); +if (behavior === 'signal') process.kill(process.pid, 'SIGTERM'); +if (behavior === 'large-unrelated') process.stdout.write(exactFilter ? 'authorized-tunnel\\trunning\\tUp 1 second\\t\\n' : 'unrelated-api\\trunning\\tUp\\t\\n'.repeat(5000)); +else if (behavior === 'duplicate') process.stdout.write('authorized-tunnel\\trunning\\tUp\\t\\nauthorized-tunnel\\trunning\\tUp\\t\\n'); +else if (behavior === 'unknown') process.stdout.write('authorized-hostile\\trunning\\tUp\\t\\n'); +else if (behavior === 'malformed') process.stdout.write('authorized-tunnel running malformed-output-SENTINEL\\n'); +else if (behavior === 'truncated') process.stdout.write('x'.repeat(70 * 1024)); +else if (behavior === 'absent') process.stdout.write(''); +else if (behavior === 'stopped') process.stdout.write('authorized-tunnel\\texited\\tExited (0) 1 second ago\\t\\n'); +else process.stdout.write('authorized-tunnel\\trunning\\tUp 1 second\\t\\n'); +`, { mode: 0o700 }); + chmodSync(docker, 0o700); + return bin; +} + +interface InvocationOptions { + cli?: string; + dockerBehavior?: 'ready' | 'absent' | 'stopped' | 'nonzero' | 'timeout' | 'signal' | 'malformed' | 'truncated' | 'large-unrelated' | 'duplicate' | 'unknown'; + replaceRoot?: boolean; + windowsSemantics?: boolean; + arguments?: string[]; + environment?: Record; + dockerEnvironmentExpectations?: Record; +} + +function invoke( + root: string, + mode: string, + bin: string, + privateParent: string, + options: InvocationOptions = {}, +): { status: number | null; stdout: string; stderr: string; document: Record } { + const credentialPath = join(privateParent, 'credential-path-SENTINEL'); + const behaviorPath = join(bin, 'docker-behavior'); + const replacementPath = join(bin, 'replace-root'); + const expectationsPath = join(bin, 'docker-env-expectations'); + if (options.dockerBehavior) writeFileSync(behaviorPath, options.dockerBehavior, { mode: 0o600 }); + if (options.replaceRoot) writeFileSync(replacementPath, root, { mode: 0o600 }); + if (options.dockerEnvironmentExpectations) { + writeFileSync(expectationsPath, JSON.stringify(options.dockerEnvironmentExpectations), { mode: 0o600 }); + } + const result = spawnSync(process.execPath, [ + ...FIXTURE_NODE_ARGS, + options.cli ?? CLI, + ...(options.arguments ?? ['connect', 'status', '--json', '--root', root]), + ], { + shell: false, + cwd: join(privateParent, 'hostile-cwd'), + encoding: 'utf8', + timeout: 10_000, + env: { + ...process.env, + PATH: bin, + HOME: join(privateParent, 'home-private-SENTINEL'), + PROPR_TEST_OS_HOME: join(privateParent, 'isolated-os-home'), + PROPR_TEST_DISCOVERY_MODE: mode, + PROPR_TEST_PUBLIC_IDENTITY: IDENTITY, + PROPR_TEST_PLATFORM: options.windowsSemantics ? 'win32' : '', + PROPR_STACK: 'ambient-stack-SENTINEL', + PROPR_NETWORK: 'ambient-network-SENTINEL', + PROPR_ROOT: join(privateParent, 'ambient-root-SENTINEL'), + PROPR_INSTANCE_ID: 'ambient-instance-SENTINEL', + PROPR_UI_PUBLIC_API_URL: 'https://t-ambient.propr.dev', + PROPR_UI_TUNNEL_ENABLED: 'false', + PROPR_UI_TUNNEL_TOKEN: 'ambient-tunnel-token-SENTINEL', + API_PUBLIC_URL: 'https://t-ambient-api.propr.dev', + API_PORT: '4999', + UI_PORT: '5999', + DOCS_PORT: '6999', + HOST_DATA_DIR: join(privateParent, 'ambient-data-SENTINEL'), + HOST_LOGS_DIR: join(privateParent, 'ambient-logs-SENTINEL'), + HOST_REPOS_DIR: join(privateParent, 'ambient-repos-SENTINEL'), + PROPR_CONNECTOR_TOKEN: 'connector-token-SENTINEL', + PROPR_RELAY_TOKEN: 'relay-token-SENTINEL', + GITHUB_TOKEN: 'github-token-SENTINEL', + GH_PRIVATE_KEY_PATH: credentialPath, + UNTRUSTED_RAW_URL: 'https://userinfo:secret@raw-url-SENTINEL.invalid/path', + DOCKER_AUTH_CONFIG: 'docker-auth-SENTINEL', + REGISTRY_PASSWORD: 'registry-password-SENTINEL', + HTTP_PROXY: 'http://proxy-SENTINEL.invalid', + HTTPS_PROXY: 'http://proxy-SENTINEL.invalid', + NO_PROXY: 'no-proxy-SENTINEL', + UNTRUSTED_AMBIENT: 'ambient-SENTINEL', + ...options.environment, + NODE_OPTIONS: undefined, + }, + stdio: ['ignore', 'pipe', 'pipe'], + }); + rmSync(behaviorPath, { force: true }); + rmSync(replacementPath, { force: true }); + rmSync(expectationsPath, { force: true }); + assert.equal(result.signal, null); + assert.ok( + result.stdout.length > 0 && result.stdout.length < 2048, + `status=${result.status} stderr=${result.stderr}`, + ); + assert.equal(result.stdout.trim().split(/\r?\n/).length, 1); + const document = JSON.parse(result.stdout) as Record; + const expectedStderr = document.status === 'ready' + ? '' + : `ProPR Connect discovery: ${document.status}.\n`; + assert.equal(result.stderr, expectedStderr); + assert.ok(result.stderr.length < 128); + for (const sentinel of [ + 'connector-token-SENTINEL', + 'relay-token-SENTINEL', + 'github-token-SENTINEL', + credentialPath, + privateParent, + 'docker-private-output-SENTINEL', + 'raw-url-SENTINEL', + 'REPLACEMENT_BYTES_SENTINEL', + 'transport-SENTINEL', + 'ambient-stack-SENTINEL', + 'ambient-instance-SENTINEL', + 'INTERPOLATION_SECRET_PATH_SENTINEL', + ]) { + assert.equal(result.stdout.includes(sentinel), false, `stdout leaked ${sentinel}`); + assert.equal(result.stderr.includes(sentinel), false, `stderr leaked ${sentinel}`); + } + return { status: result.status, stdout: result.stdout, stderr: result.stderr, document }; +} + +test('the built CLI emits one bounded secret-free JSON document for every exit class', async () => { + const parent = mkdtempSync(join(tmpdir(), 'propr-built-connect-cli-')); + chmodSync(parent, 0o700); + const bin = installFakeDocker(parent); + const isolatedOsHome = join(parent, 'isolated-os-home'); + mkdirSync(isolatedOsHome, { mode: 0o700 }); + mkdirSync(join(parent, 'home-private-SENTINEL'), { mode: 0o700 }); + mkdirSync(join(parent, 'hostile-cwd'), { mode: 0o700 }); + const osConfigDir = join(userInfo().homedir, '.propr'); + const osConfigPath = join(osConfigDir, 'config.json'); + const osConfigDirBefore = snapshotPath(osConfigDir); + const osConfigBefore = osConfigDirBefore.kind === 'directory' + ? snapshotPath(osConfigPath) + : undefined; + writeFileSync(join(parent, 'hostile-cwd', '.env'), [ + 'PROPR_STACK=cwd-stack-SENTINEL', + 'PROPR_UI_PUBLIC_API_URL=https://t-cwd-SENTINEL.propr.dev', + 'HOST_DATA_DIR=${INTERPOLATION_SECRET_PATH_SENTINEL}', + ].join('\n'), { mode: 0o600 }); + try { + const readyRoot = makeRoot(parent, 'ready-private-root-SENTINEL'); + assert.equal(await getOrCreatePublicInstanceIdentity(join(readyRoot, 'data'), () => IDENTITY), IDENTITY); + const ready = invoke(readyRoot, 'ready', bin, parent); + assert.equal(ready.status, 0, JSON.stringify(ready.document)); + assert.equal(ready.document.status, 'ready'); + assert.equal(ready.document.canonicalEndpoint, ENDPOINT); + assert.equal( + existsSync(join(isolatedOsHome, '.propr')), + false, + 'an absent isolated OS config directory must not be created', + ); + + persistTunnelOverride(isolatedOsHome, readyRoot, false); + const persistedOff = invoke(readyRoot, 'ready', bin, parent); + assert.equal(persistedOff.status, 0); + assert.equal(persistedOff.document.enabled, false); + assert.deepEqual(persistedOff.document.reasonCodes, ['TUNNEL_DISABLED']); + + const envDisabledRoot = makeRoot(parent, 'env-disabled-root', ENDPOINT, { enabled: 'false' }); + assert.equal(await getOrCreatePublicInstanceIdentity(join(envDisabledRoot, 'data'), () => IDENTITY), IDENTITY); + persistTunnelOverride(isolatedOsHome, envDisabledRoot, true); + const persistedOn = invoke(envDisabledRoot, 'ready', bin, parent); + assert.equal(persistedOn.status, 0, JSON.stringify(persistedOn.document)); + assert.equal(persistedOn.document.status, 'ready'); + assert.equal(persistedOn.document.enabled, true); + + const dockerTransport = { + DOCKER_HOST: 'ssh://docker.example.test', + DOCKER_CONTEXT: 'trusted-context', + DOCKER_TLS_VERIFY: '1', + DOCKER_CERT_PATH: join(parent, 'private-cert-path-SENTINEL'), + DOCKER_CONFIG: join(parent, 'private-docker-config-SENTINEL'), + HOME: join(parent, 'docker-home-SENTINEL'), + SSH_AUTH_SOCK: join(parent, 'ssh-agent-SENTINEL'), + }; + const customDocker = invoke(readyRoot, 'ready', bin, parent, { + environment: dockerTransport, + dockerEnvironmentExpectations: dockerTransport, + }); + assert.equal(customDocker.status, 0); + const tlsOnlyTransport = { DOCKER_TLS: '1' }; + const tlsOnlyDocker = invoke(readyRoot, 'ready', bin, parent, { + environment: tlsOnlyTransport, + dockerEnvironmentExpectations: tlsOnlyTransport, + }); + assert.equal(tlsOnlyDocker.status, 0); + const unrelatedInventory = invoke(readyRoot, 'ready', bin, parent, { dockerBehavior: 'large-unrelated' }); + assert.equal(unrelatedInventory.status, 0); + for (const dockerBehavior of ['duplicate', 'unknown'] as const) { + const hostile = invoke(readyRoot, 'ready', bin, parent, { dockerBehavior }); + assert.equal(hostile.status, 1, dockerBehavior); + assert.deepEqual(hostile.document.reasonCodes, ['INTERNAL_FAILURE']); + } + const oversizedDocker = invoke(readyRoot, 'ready', bin, parent, { + environment: { DOCKER_HOST: 'x'.repeat(4097) }, + }); + assert.equal(oversizedDocker.status, 1); + assert.deepEqual(oversizedDocker.document.reasonCodes, ['INTERNAL_FAILURE']); + + persistTunnelOverride(join(parent, 'home-private-SENTINEL'), readyRoot, false); + const hostileAmbientHomeIgnored = invoke(readyRoot, 'ready', bin, parent); + assert.equal(hostileAmbientHomeIgnored.status, 0); + persistTunnelOverride(join(parent, 'home-private-SENTINEL'), readyRoot, true); + assert.equal(invoke(readyRoot, 'ready', bin, parent).status, 0); + + const tokenlessRoot = makeRoot(parent, 'tokenless-root', ENDPOINT, {}); + assert.equal(await getOrCreatePublicInstanceIdentity(join(tokenlessRoot, 'data'), () => IDENTITY), IDENTITY); + persistTunnelOverride(join(parent, 'home-private-SENTINEL'), tokenlessRoot, false); + const tokenlessOff = invoke(tokenlessRoot, 'ready', bin, parent); + assert.deepEqual(tokenlessOff.document.reasonCodes, ['TUNNEL_DISABLED']); + + const equalsRoot = invoke(readyRoot, 'ready', bin, parent, { + arguments: ['--project', 'owner/repo', 'connect', 'status', `--root=${readyRoot}`, '--json'], + }); + assert.equal(equalsRoot.status, 0); + assert.equal(equalsRoot.document.canonicalEndpoint, ENDPOINT); + + for (const dockerBehavior of ['absent', 'stopped'] as const) { + const notReady = invoke(readyRoot, 'ready', bin, parent, { dockerBehavior }); + assert.equal(notReady.status, 0, dockerBehavior); + assert.equal(notReady.document.status, 'notReady', dockerBehavior); + assert.deepEqual(notReady.document.reasonCodes, ['SIDECAR_NOT_RUNNING'], dockerBehavior); + } + + for (const [name, failureBin, dockerBehavior] of [ + ['ENOENT', join(parent, 'missing-docker-bin'), undefined], + ['daemon nonzero', bin, 'nonzero'], + ['timeout', bin, 'timeout'], + ['signal', bin, 'signal'], + ['malformed output', bin, 'malformed'], + ['truncated output', bin, 'truncated'], + ] as const) { + mkdirSync(failureBin, { recursive: true, mode: 0o700 }); + const failure = invoke(readyRoot, 'ready', failureBin, parent, { dockerBehavior }); + assert.equal(failure.status, 1, name); + assert.equal(failure.document.status, 'internalFailure', name); + assert.deepEqual(failure.document.reasonCodes, ['INTERNAL_FAILURE'], name); + } + + const unreachable = invoke(readyRoot, 'unreachable', bin, parent); + assert.equal(unreachable.status, 0); + assert.deepEqual(unreachable.document.reasonCodes, ['API_UNREACHABLE']); + + for (const mode of ['unsupported', 'invalid', 'invalid-utf8']) { + const incompatible = invoke(readyRoot, mode, bin, parent); + assert.equal(incompatible.status, 2, mode); + assert.equal(incompatible.document.status, 'incompatible'); + } + + const invalidEndpointRoot = makeRoot(parent, 'invalid-endpoint-root', `${ENDPOINT}/path`); + assert.equal(await getOrCreatePublicInstanceIdentity(join(invalidEndpointRoot, 'data'), () => IDENTITY), IDENTITY); + const invalidEndpoint = invoke(invalidEndpointRoot, 'ready', bin, parent); + assert.equal(invalidEndpoint.status, 1); + assert.deepEqual(invalidEndpoint.document.reasonCodes, ['INVALID_ENDPOINT']); + + const missingRoot = invoke(join(parent, 'missing-private-root'), 'ready', bin, parent); + assert.equal(missingRoot.status, 1, JSON.stringify(missingRoot.document)); + assert.deepEqual(missingRoot.document.reasonCodes, ['INVALID_ROOT']); + + let malformedRootDocument: Record | undefined; + for (const arguments_ of [ + ['connect', 'status', '--json'], + ['connect', 'status', '--json', '--root'], + ['connect', 'status', '--json', '--root='], + ['connect', 'status', '--json', '--root', ''], + ['connect', 'status', '--json', '--root', readyRoot, '--root', readyRoot], + ['connect', 'status', '--json', `--root=${readyRoot}`, `--root=${readyRoot}`], + ['connect', 'status', '--json', '--', '--root', '/x'], + ['connect', 'status', '--json', '--', '--root=/x'], + ['connect', 'status', '--json', '--', '--help'], + ['connect', 'status', '--json', '--', '-h'], + ]) { + const malformedRoot = invoke(readyRoot, 'ready', bin, parent, { arguments: arguments_ }); + assert.equal(malformedRoot.status, 1, arguments_.join(' ')); + assert.equal(malformedRoot.document.status, 'invalidConfig', arguments_.join(' ')); + assert.deepEqual(malformedRoot.document.reasonCodes, ['INVALID_ROOT'], arguments_.join(' ')); + assert.doesNotMatch(malformedRoot.stdout, /(?:^|\n)(?:Usage:|error:)/i, arguments_.join(' ')); + assert.doesNotMatch(malformedRoot.stderr, /(?:Usage:|error:)/i, arguments_.join(' ')); + malformedRootDocument ??= malformedRoot.document; + assert.deepEqual(malformedRoot.document, malformedRootDocument, arguments_.join(' ')); + } + + const timeout = invoke(readyRoot, 'timeout', bin, parent); + assert.equal(timeout.status, 0); + assert.equal(timeout.document.status, 'timeout'); + + const replacedRoot = makeRoot(parent, 'replaced-private-root'); + assert.equal(await getOrCreatePublicInstanceIdentity(join(replacedRoot, 'data'), () => IDENTITY), IDENTITY); + const replaced = invoke(replacedRoot, 'ready', bin, parent, { replaceRoot: true }); + assert.equal(replaced.status, 1); + assert.deepEqual(replaced.document.reasonCodes, ['INVALID_ROOT']); + + const copiedPackage = join(parent, 'copied-built-cli'); + cpSync(join(process.cwd(), 'packages', 'cli'), copiedPackage, { recursive: true }); + symlinkSync(join(process.cwd(), 'node_modules'), join(parent, 'node_modules'), 'dir'); + rmSync(join(copiedPackage, 'dist', 'orchestrator', 'manifest.json')); + const internal = invoke( + readyRoot, + 'ready', + bin, + parent, + { cli: join(copiedPackage, 'dist', 'index.js') }, + ); + assert.equal(internal.status, 1); + assert.equal(internal.document.status, 'internalFailure'); + } finally { + try { + assert.deepEqual(snapshotPath(osConfigDir), osConfigDirBefore, 'the actual OS config directory changed'); + if (osConfigBefore) { + assert.deepEqual(snapshotPath(osConfigPath), osConfigBefore, 'the actual OS config bytes or metadata changed'); + } + } finally { + rmSync(parent, { recursive: true, force: true }); + } + } +}); + +test('the built CLI rejects malformed Unix roots and reports unavailable Windows ACL diagnostics', async () => { + const parent = mkdtempSync(join(tmpdir(), 'propr-built-connect-root-')); + chmodSync(parent, 0o700); + const bin = installFakeDocker(parent); + mkdirSync(join(parent, 'isolated-os-home'), { mode: 0o700 }); + mkdirSync(join(parent, 'home-private-SENTINEL'), { mode: 0o700 }); + mkdirSync(join(parent, 'hostile-cwd'), { mode: 0o700 }); + writeFileSync(join(parent, 'hostile-cwd', '.env'), 'PROPR_STACK=cwd-stack-SENTINEL\n', { mode: 0o600 }); + try { + const root = makeRoot(parent, 'real-root'); + const alias = join(parent, 'root-alias'); + symlinkSync(root, alias, 'dir'); + const symlink = invoke(alias, 'ready', bin, parent); + assert.equal(symlink.status, 1); + assert.deepEqual(symlink.document.reasonCodes, ['INVALID_ROOT']); + + chmodSync(join(root, 'data'), 0o777); + const unsafe = invoke(root, 'ready', bin, parent); + assert.equal(unsafe.status, 1); + assert.deepEqual(unsafe.document.reasonCodes, ['INVALID_ROOT']); + + chmodSync(join(root, 'data'), 0o700); + assert.equal(await getOrCreatePublicInstanceIdentity(join(root, 'data'), () => IDENTITY), IDENTITY); + const windows = invoke(root, 'ready', bin, parent, { windowsSemantics: true }); + assert.equal(windows.status, 1); + assert.equal(windows.document.status, 'invalidConfig'); + assert.deepEqual(windows.document.reasonCodes, ['ACL_DIAGNOSTIC_UNAVAILABLE']); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); diff --git a/test/fixtures/connectFetchMock.mjs b/test/fixtures/connectFetchMock.mjs new file mode 100644 index 000000000..c71c4de5b --- /dev/null +++ b/test/fixtures/connectFetchMock.mjs @@ -0,0 +1,71 @@ +const realSetTimeout = globalThis.setTimeout; +if (process.env.PROPR_TEST_PLATFORM === 'win32') { + Object.defineProperty(process, 'platform', { value: 'win32' }); +} +globalThis.setTimeout = (callback, delay, ...args) => realSetTimeout( + callback, + delay === 5000 ? 20 : delay, + ...args, +); + +const endpoint = 'https://t-abc123.propr.dev'; +const identity = process.env.PROPR_TEST_PUBLIC_IDENTITY; +const discovery = { + schemaVersion: 1, + product: 'ProPR', + canonicalEndpoint: endpoint, + publicInstanceIdentity: identity, + version: '0.8.15', + apiCompatibility: '2026-06-27', + uiCompatibility: '2026-06-27', + desktopAuthentication: { + protocolVersion: 2, + browserPairing: true, + instanceBearerTokens: true, + socketIoBearerAuthentication: true, + }, +}; + +const endless = (status, contentType = 'application/json') => new Response(new ReadableStream({ + start(controller) { + controller.enqueue(new TextEncoder().encode('{')); + }, +}), { status, headers: { 'content-type': contentType } }); + +globalThis.fetch = async () => { + switch (process.env.PROPR_TEST_DISCOVERY_MODE) { + case 'ready': + return new Response(JSON.stringify(discovery), { headers: { 'content-type': 'application/json' } }); + case 'restart-required': + return new Response(JSON.stringify({ ...discovery, canonicalEndpoint: null }), { + headers: { 'content-type': 'application/json' }, + }); + case 'identity-mismatch': + return new Response(JSON.stringify({ + ...discovery, + publicInstanceIdentity: 'bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb', + }), { headers: { 'content-type': 'application/json' } }); + case 'oversized': + return new Response('{}', { + headers: { 'content-type': 'application/json', 'content-length': '9000' }, + }); + case 'invalid': + return new Response(JSON.stringify({ ...discovery, desktopAuthentication: {} }), { + headers: { 'content-type': 'application/json' }, + }); + case 'invalid-utf8': + return new Response(Uint8Array.from([0xc3, 0x28]), { + headers: { 'content-type': 'application/json' }, + }); + case 'unsupported': + return endless(404); + case 'unreachable': + throw new Error('transport-SENTINEL must remain private'); + case 'secret-sentinel': + throw new Error('connector-token-SENTINEL relay-token-SENTINEL private-path-SENTINEL'); + case 'timeout': + return endless(200); + default: + throw new Error('unexpected discovery fixture mode'); + } +}; diff --git a/test/fixtures/connectOsHomeMock.mjs b/test/fixtures/connectOsHomeMock.mjs new file mode 100644 index 000000000..1626bdbe3 --- /dev/null +++ b/test/fixtures/connectOsHomeMock.mjs @@ -0,0 +1,10 @@ +import os from 'node:os'; +import { syncBuiltinESMExports } from 'node:module'; + +const isolatedHome = process.env.PROPR_TEST_OS_HOME; +if (!isolatedHome) throw new Error('PROPR_TEST_OS_HOME is required'); +delete process.env.PROPR_TEST_OS_HOME; + +const realUserInfo = os.userInfo; +os.userInfo = (...args) => ({ ...realUserInfo(...args), homedir: isolatedHome }); +syncBuiltinESMExports(); diff --git a/test/fixtures/publicIdentityCreator.ts b/test/fixtures/publicIdentityCreator.ts new file mode 100644 index 000000000..47afff78f --- /dev/null +++ b/test/fixtures/publicIdentityCreator.ts @@ -0,0 +1,9 @@ +import { getOrCreatePublicInstanceIdentity as getCliIdentity } from '../../packages/cli/src/connectIdentity.js'; +import { getOrCreatePublicInstanceIdentity as getApiIdentity } from '../../packages/api/publicInstanceIdentity.js'; + +const [kind, data, identity] = process.argv.slice(2); +if ((kind !== 'cli' && kind !== 'api') || !data || !identity) process.exit(64); +const value = await (kind === 'cli' + ? getCliIdentity(data, () => identity) + : getApiIdentity(data, () => identity)); +process.stdout.write(`${value}\n`); diff --git a/test/fixtures/windowsConnectProcessMock.mjs b/test/fixtures/windowsConnectProcessMock.mjs new file mode 100644 index 000000000..a9405c0b9 --- /dev/null +++ b/test/fixtures/windowsConnectProcessMock.mjs @@ -0,0 +1,189 @@ +import childProcess from "node:child_process"; +import { fstatSync, renameSync, rmSync, writeFileSync } from "node:fs"; +import { syncBuiltinESMExports } from "node:module"; +import { join, resolve } from "node:path"; + +const WINDOWS_ROOT_MISSING_MARKER = "PROPR_TEST_WINDOWS_ROOT_MISSING"; +const WINDOWS_ROOT_MISSING_MARKER_VALUE = "windows-root-missing-v1"; + +function consumeMissingWindowsRootFixtureMarker(environment = process.env) { + const marker = Object.keys(environment).find((name) => name === WINDOWS_ROOT_MISSING_MARKER); + if (marker === undefined || environment[marker] !== WINDOWS_ROOT_MISSING_MARKER_VALUE) return; + delete environment[marker]; + for (const name of Object.keys(environment)) { + if (/^(?:systemroot|windir)$/i.test(name)) delete environment[name]; + } +} + +const WINDOWS_ROOT_UNTRUSTED_MARKER = "PROPR_TEST_WINDOWS_ROOT_UNTRUSTED"; +const WINDOWS_ROOT_UNTRUSTED_MARKER_VALUE = "windows-root-untrusted-v1"; +const WINDOWS_ROOT_UNTRUSTED_PATH = "PROPR_TEST_WINDOWS_ROOT_UNTRUSTED_PATH"; + +function consumeUntrustedWindowsRootFixtureMarker(environment = process.env, fixtureRoot = process.cwd()) { + const marker = Object.keys(environment).find((name) => name === WINDOWS_ROOT_UNTRUSTED_MARKER); + const rootPath = Object.keys(environment).find((name) => name === WINDOWS_ROOT_UNTRUSTED_PATH); + if ( + marker === undefined + || environment[marker] !== WINDOWS_ROOT_UNTRUSTED_MARKER_VALUE + || rootPath === undefined + || typeof environment[rootPath] !== "string" + || resolve(environment[rootPath]).toLowerCase() !== resolve(fixtureRoot).toLowerCase() + ) return; + const untrustedRoot = environment[rootPath]; + delete environment[marker]; + delete environment[rootPath]; + for (const name of Object.keys(environment)) { + if (/^(?:systemroot|windir)$/i.test(name)) delete environment[name]; + } + environment.SystemRoot = untrustedRoot; + environment.WINDIR = untrustedRoot; +} + +consumeMissingWindowsRootFixtureMarker(); +consumeUntrustedWindowsRootFixtureMarker(); + +const originalSpawnSync = childProcess.spawnSync; +const forbidden = /(?:connect-authority|ProPRConnectAuthority|pwsh|csc|msiexec)(?:\.exe)?$/i; +let abaPerformed = false; +const nativeStages = new Set([ + "resolver:env", "resolver:canonical", "resolver:global-open", "resolver:global-id", + "spawn:create", "spawn:error", "spawn:timeout", "spawn:cumulative-timeout", "spawn:status", "spawn:stderr", + "probe:entry", "probe:baseline", "probe:reflection-emit", "probe:win32", "probe:standard-handle", "probe:output", + "broker:ps-version", "broker:job", "broker:fd", "broker:fd-duplicate", "broker:index-info-initial", + "broker:security-info", "broker:acl", "broker:json", "broker:current-user-sid", + "broker:index-info-revalidation", "broker:index-info-decode", "broker:index-info-compose", "broker:entry-format", + "broker:entry-flags", "broker:entry-rules", "broker:entry-build", + "parent:utf8", "parent:json-parse", "parent:json-canonical", "parent:document-shape", + "parent:entry-count", "parent:entry-shape", "parent:json-shape", "parent:descriptor-bind", "parent:post-bind", +]); +globalThis[Symbol.for("propr.test.windowsNativeDiagnostic")] = (stage) => { + const fixed = nativeStages.has(stage) ? stage : "parent:json-shape"; + process.stderr.write(`[propr-windows-native-stage:${fixed}]\n`); +}; + +function authorityDocument(args, options, mode) { + const encodedIndex = args.indexOf("-EncodedCommand") + 1; + const source = Buffer.from(args[encodedIndex], "base64").toString("utf16le"); + const specs = [...source.matchAll(/index=(\d+);kind='(directory|file)';authorityKind='(ancestor|home|root|data|env)'/g)]; + const identities = [options.stdio[0]].map((fd) => { + const stat = fstatSync(fd, { bigint: true }); + return { device: stat.dev.toString(10), file: stat.ino.toString(10) }; + }); + const userSid = "S-1-5-21-100-200-300-1001"; + const entries = specs.map((spec, index) => ({ + index: Number(spec[1]), + kind: spec[2], + authorityKind: spec[3], + currentUserSid: userSid, + ownerSid: userSid, + daclProtected: true, + reparsePoint: false, + volumeSerialNumber: identities[index].device, + fileId: identities[index].file, + verifiedVolumeSerialNumber: identities[index].device, + verifiedFileId: identities[index].file, + rules: [{ + identitySid: userSid, + inherited: false, + accessType: "allow", + appliesToSelf: true, + rights: "2032127", + }], + })); + const protectedEntry = entries.find((entry) => ["root", "data", "env"].includes(entry.authorityKind)); + if (mode === "descriptor-mismatch") { + entries[0].fileId = (BigInt(entries[0].fileId) + 1n).toString(10); + entries[0].verifiedFileId = entries[0].fileId; + } else if (mode === "index-mismatch") entries[0].index += 1; + else if (mode === "kind-mismatch") entries[0].kind = entries[0].kind === "file" ? "directory" : "file"; + else if (mode === "authority-kind-mismatch") entries[0].authorityKind = entries[0].authorityKind === "root" ? "data" : "root"; + else if (mode === "identity-mismatch") { + entries[0].fileId = (BigInt(entries[0].fileId) + 1n).toString(10); + } else if (mode === "sid-mismatch" && entries[0].index > 0) { + entries[0].currentUserSid = "S-1-5-21-100-200-300-1002"; + } else if (mode === "broad-write" && protectedEntry) { + protectedEntry.rules = [{ + identitySid: "S-1-1-0", inherited: false, accessType: "allow", appliesToSelf: true, rights: "2", + }]; + } else if (mode === "inherited-write" && protectedEntry) { + protectedEntry.rules[0].inherited = true; + } else if (mode === "unprotected" && protectedEntry) { + protectedEntry.daclProtected = false; + } else if (mode === "owner-mismatch" && protectedEntry) { + protectedEntry.ownerSid = "S-1-5-18"; + } else if (mode === "reparse" && protectedEntry) { + protectedEntry.reparsePoint = true; + } + return JSON.stringify({ version: 1, entries }); +} + +childProcess.spawnSync = (command, args, options) => { + const executable = String(command); + if (forbidden.test(executable)) throw new Error("forbidden Windows authority executable"); + if (/powershell\.exe$/i.test(executable)) { + const mode = process.env.PROPR_TEST_AUTHORITY_MODE; + const result = (status, stdout = "", stderr = "", error = undefined, signal = null) => ({ + status, signal, error, stdout: Buffer.from(stdout), stderr: Buffer.from(stderr), + }); + if (mode === "malformed") return result(0, "{"); + if (mode === "oversized") return result(0, "x".repeat(128 * 1024 + 1)); + if (mode === "extra-key") return result(0, '{"version":1,"entries":[],"extra":true}'); + if (mode === "duplicate") return result(0, '{"version":1,"version":1,"entries":[]}'); + if (mode === "entry-count") return result(0, '{"version":1,"entries":[]}'); + if (mode === "entry-shape") { + const document = JSON.parse(authorityDocument(args, options, mode)); + document.entries[0].extra = true; + return result(0, JSON.stringify(document)); + } + if (mode === "stderr") return result(0, "{}", "private-path-SENTINEL S-1-5-21-999 raw-error-SENTINEL"); + if (mode === "nonzero") return result(70, "", ""); + if (mode === "timeout") { + return result(null, "", "", Object.assign(new Error("private-path-SENTINEL"), { code: "ETIMEDOUT" }), "SIGKILL"); + } + if (mode === "valid-authority") return result(0, authorityDocument(args, options, mode)); + if ([ + "descriptor-mismatch", "index-mismatch", "kind-mismatch", "authority-kind-mismatch", + "identity-mismatch", "sid-mismatch", "broad-write", "inherited-write", "unprotected", + "owner-mismatch", "reparse", + ].includes(mode)) return result(0, authorityDocument(args, options, mode)); + if (mode === "path-aba" && !abaPerformed) { + abaPerformed = true; + const envPath = join(process.env.PROPR_TEST_AUTHORITY_ROOT, ".env"); + const detached = `${envPath}-aba-detached`; + renameSync(envPath, detached); + writeFileSync(envPath, [ + "PROPR_STACK=attacker-replacement-SENTINEL", + "PROPR_INSTANCE_ID=attacker", + "PROPR_UI_PUBLIC_API_URL=https://t-attacker.propr.dev", + "PROPR_UI_TUNNEL_ENABLED=true", + "PROPR_UI_TUNNEL_TOKEN=attacker-replacement-SENTINEL", + "", + ].join("\n")); + process.once("exit", () => { + rmSync(envPath, { force: true }); + renameSync(detached, envPath); + }); + return originalSpawnSync(command, args, options); + } + return originalSpawnSync(command, args, options); + } + if (executable.toLowerCase() !== "docker") return originalSpawnSync(command, args, options); + const expected = [ + "ps", "-a", "--filter", "label=propr.stack=authorized", "--format", + "{{.Names}}\t{{.State}}\t{{.Status}}\t{{.Ports}}", + ]; + if (JSON.stringify(args) !== JSON.stringify(expected)) { + return { status: 9, signal: null, error: undefined, stdout: "", stderr: "docker-argv-SENTINEL" }; + } + const stdout = process.env.PROPR_TEST_DOCKER_MODE === "down" + ? "" + : "authorized-tunnel\trunning\tUp 1 second\t\r\n"; + return { + status: 0, + signal: null, + error: undefined, + stdout, + stderr: "docker-secret-SENTINEL", + }; +}; +syncBuiltinESMExports(); diff --git a/test/nativeConnectAuthority.test.ts b/test/nativeConnectAuthority.test.ts new file mode 100644 index 000000000..225b2b693 --- /dev/null +++ b/test/nativeConnectAuthority.test.ts @@ -0,0 +1,94 @@ +import assert from "node:assert/strict"; +import { closeSync, mkdtempSync, openSync, rmSync, writeFileSync } from "node:fs"; +import { tmpdir } from "node:os"; +import { join } from "node:path"; +import { test } from "node:test"; +import { + assertNativeEntryAuthority, + assertSafeDarwinAclOutput, + nativeConnectRootAuthorityInspector, + stableAuthorityIdentity, + type ConnectRootAuthorityInspector, +} from "../packages/cli/src/connectRootAuthority.js"; + +const EMPTY_ACL = "!#acl 1\n"; +const READ_ONLY_ACL = [ + "!#acl 1", + "user:AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE:reader:501:allow:read,readattr,readsecurity", + "", +].join("\n"); + +test("Darwin ACL contract accepts bounded empty and read-only documents", () => { + assert.doesNotThrow(() => assertSafeDarwinAclOutput("")); + assert.doesNotThrow(() => assertSafeDarwinAclOutput(EMPTY_ACL)); + assert.doesNotThrow(() => assertSafeDarwinAclOutput(READ_ONLY_ACL)); +}); + +test("Darwin ACL contract rejects mutation grants", () => { + const writable = [ + "!#acl 1", + "group:AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE:writers:20:allow:read,write", + "", + ].join("\n"); + assert.throws(() => assertSafeDarwinAclOutput(writable), /unexpected write authority/); +}); + +test("Darwin ACL contract rejects malformed and oversized output", () => { + for (const malformed of [ + "\n", + "user supplied path", + "!#acl 1 extra\n", + "!#acl 2\n", + "!#acl 1\nunknown\n", + `${"x".repeat(25 * 1024)}\n`, + ]) assert.throws(() => assertSafeDarwinAclOutput(malformed), /malformed/); +}); + +function withPinnedFile(run: (path: string, fd: number) => Promise): Promise { + const directory = mkdtempSync(join(tmpdir(), "propr-darwin-contract-")); + const path = join(directory, "entry"); + writeFileSync(path, "fixture"); + const fd = openSync(path, "r"); + return run(path, fd).finally(() => { + closeSync(fd); + rmSync(directory, { recursive: true, force: true }); + }); +} + +test("Darwin authority binds an inspection to the held descriptor identity", async () => { + await withPinnedFile(async (path, fd) => { + const identity = stableAuthorityIdentity(fd); + const inspector: ConnectRootAuthorityInspector = { + inspectDarwinAcl: () => ({ version: 1, ...identity, acl: EMPTY_ACL }), + inspectWindowsAcl: async () => { throw new Error("unused"); }, + }; + await assert.doesNotReject(assertNativeEntryAuthority(inspector, "darwin", path, "env", fd)); + }); +}); + +test("Darwin authority rejects an inspection for another object", async () => { + await withPinnedFile(async (path, fd) => { + const inspector: ConnectRootAuthorityInspector = { + inspectDarwinAcl: () => ({ version: 1, device: "0", file: "0", acl: EMPTY_ACL }), + inspectWindowsAcl: async () => { throw new Error("unused"); }, + }; + await assert.rejects( + assertNativeEntryAuthority(inspector, "darwin", path, "env", fd), + /did not match the pinned object/, + ); + }); +}); + +test("packaged Darwin broker inspects an ordinary held file without path re-resolution", { + skip: process.platform !== "darwin" ? "requires native Darwin ACL APIs" : false, +}, async () => { + await withPinnedFile(async (path, fd) => { + await assert.doesNotReject(assertNativeEntryAuthority( + nativeConnectRootAuthorityInspector, + "darwin", + path, + "env", + fd, + )); + }); +}); diff --git a/test/orchestratorConfig.test.mjs b/test/orchestratorConfig.test.mjs index ae2a42526..b1ce191d8 100644 --- a/test/orchestratorConfig.test.mjs +++ b/test/orchestratorConfig.test.mjs @@ -409,15 +409,13 @@ test('api container receives explicit request rate-limit overrides', () => { } }); -test('an explicit PROPR_UI_PUBLIC_API_URL is normalized (trailing slash stripped) once at resolve time', () => { +test('an alternate explicit Connect URL remains raw and fails validation', () => { const cfg = resolveConfig({ PROPR_UI_TUNNEL_TOKEN: 'secret-token', PROPR_UI_PUBLIC_API_URL: 'https://t-abc123.propr.dev/', }, { manifestPath }); - assert.equal(cfg.uiPublicApiUrl, 'https://t-abc123.propr.dev'); - // and every consumer sees the canonical (no trailing slash) form. - assert.deepEqual(envValues(buildServiceSpec(cfg, 'api').args, 'PROPR_UI_PUBLIC_API_URL'), ['https://t-abc123.propr.dev']); - assert.deepEqual(envValues(buildServiceSpec(cfg, 'ui').args, 'PROPR_UI_PUBLIC_API_URL'), ['https://t-abc123.propr.dev']); + assert.equal(cfg.uiPublicApiUrl, 'https://t-abc123.propr.dev/'); + assert.match(validateEnv(cfg).errors.join('\n'), /not a hosted proxy URL/); }); test('ui container receives the tunnel public API URL (no /api appended) when set', () => { diff --git a/test/orchestratorProprUrlsDrift.test.ts b/test/orchestratorProprUrlsDrift.test.ts index 78b74a001..550f91967 100644 --- a/test/orchestratorProprUrlsDrift.test.ts +++ b/test/orchestratorProprUrlsDrift.test.ts @@ -13,6 +13,8 @@ import { PROPR_UI_COMPATIBILITY, PROPR_UI_SUPPORTED_API_COMPATIBILITY, proprInstanceProxyUrl as sharedProxyUrl, + canonicalProprProxySelector, + canonicalProprProxyUrl as sharedCanonicalProxyUrl, isValidProprInstanceId as sharedIsValidId, isProprProxyUrl as sharedIsProxyUrl, proprTunnelEndpoints as sharedTunnelEndpoints, @@ -28,6 +30,7 @@ import { DEFAULT_CLOUDFLARED_IMAGE as LAUNCHER_CLOUDFLARED_IMAGE, DEFAULT_PROPR_UI_ORIGIN as LAUNCHER_PROPR_UI_ORIGIN, proprInstanceProxyUrl as launcherProxyUrl, + canonicalProprProxyUrl as launcherCanonicalProxyUrl, isValidProprInstanceId as launcherIsValidId, isProprProxyUrl as launcherIsProxyUrl, proprTunnelEndpoints as launcherTunnelEndpoints, @@ -42,7 +45,7 @@ describe('launcher hosted-UI constants stay in sync with @propr/shared', () => { }); test('proprInstanceProxyUrl agrees for valid, blank, and invalid ids', () => { - const cases = ['abc123', 'a', 'with-hyphen', '', ' ', null, undefined, 'bad id', 'has/slash', 'under_score', 'has.dot', '-leading', 'trailing-']; + const cases = ['abc123', 'a', 'with-hyphen', 't-Abc', 'T-Abc', '', ' ', null, undefined, 'bad id', 'has/slash', 'under_score', 'has.dot', '-leading', 'trailing-']; for (const id of cases) { assert.equal( launcherProxyUrl(id as string | undefined), @@ -52,6 +55,11 @@ describe('launcher hosted-UI constants stay in sync with @propr/shared', () => { } }); + test('mixed-case existing prefixes are removed before adding the canonical prefix', () => { + assert.equal(sharedProxyUrl('T-Abc'), 'https://t-abc.propr.dev'); + assert.equal(launcherProxyUrl('T-Abc'), 'https://t-abc.propr.dev'); + }); + test('isValidProprInstanceId agrees across the same cases', () => { const cases = ['abc123', 'a', 'with-hyphen', '', ' ', 'bad id', 'has/slash', 'under_score', 'has.dot', '-leading', 'trailing-', 'A'.repeat(63), 'A'.repeat(64)]; for (const id of cases) { @@ -67,29 +75,83 @@ describe('launcher hosted-UI constants stay in sync with @propr/shared', () => { const cases = [ 'https://t-abc123.propr.dev', 'https://t-abc123.propr.dev/', + ' https://t-abc123.propr.dev', + 'https://t-abc123.propr.dev ', + 'https://t-abc123.propr.dev//', + 'HTTPS://t-abc123.propr.dev', + 'https://T-abc123.propr.dev', 'https://app.propr.dev', 'http://t-abc123.propr.dev', 'https://abc123.example.com', 'https://propr.dev', 'https://t-foo.bar.propr.dev', + 'https://x.t-abc123.propr.dev', + 'https://nested.t-abc123.propr.dev', 'https://t-.propr.dev', 'https://t-abc123.propr.dev/api', 'https://t-abc123.propr.dev?x=1', 'https://t-abc123.propr.dev/#frag', + 'https://user:secret@t-abc123.propr.dev', + 'https://t-abc123.propr.dev:443', + 'https://t-abc123.propr.dev:8443', + 'https://t-%61bc123.propr.dev', + 'https://t-abc123.propr%2edev', + 'https://t-abc123.propr.dev.example.com', + 'https://t-abc123.pr\u03bfpr.dev', 'not a url', '', null, undefined, ]; for (const url of cases) { + const expected = url === 'https://t-abc123.propr.dev'; + assert.equal(sharedIsProxyUrl(url as string | undefined), expected); assert.equal( launcherIsProxyUrl(url as string | undefined), - sharedIsProxyUrl(url as string | undefined), + expected, `isProprProxyUrl diverged for ${JSON.stringify(url)}`, ); } }); + test('canonical proxy parsing agrees and rejects authority lookalikes', () => { + const cases = [ + 'https://t-abc123.propr.dev', + 'https://t-abc123.propr.dev/', + 'https://T-AbC123.ProPR.dev/', + 'HTTPS://t-abc123.propr.dev', + ' https://t-abc123.propr.dev', + 'https://user@t-abc123.propr.dev', + 'https://t-abc123.propr.dev:443', + 'https://t-abc123.propr.dev.', + 'https://t-abc123.propr.dev//', + 'https://t-аbc.propr.dev', + `https://t-${'a'.repeat(62)}.propr.dev`, + ]; + for (const url of cases) { + assert.equal(launcherCanonicalProxyUrl(url), sharedCanonicalProxyUrl(url)); + } + }); + + test('scheme-less Connect selectors accept only one canonical host spelling', () => { + assert.equal(canonicalProprProxySelector('t-abc123.propr.dev'), 't-abc123.propr.dev'); + assert.equal(canonicalProprProxySelector('T-AbC123.ProPR.dev'), undefined); + for (const selector of [ + 'abc123', + 'https://t-abc123.propr.dev', + 'user@t-abc123.propr.dev', + 't-abc123.propr.dev:443', + 't-abc123.propr.dev/', + 't-abc123.propr.dev?x=1', + 't-abc123.propr.dev#x', + ' t-abc123.propr.dev', + 't-abc123%2epropr.dev', + 't-abc123.propr.dev.', + 't-a.b.propr.dev', + 't-аbc.propr.dev', + ]) assert.equal(canonicalProprProxySelector(selector), undefined, selector); + }); + test('proprTunnelEndpoints agrees, including trailing-slash normalization', () => { const cases = ['https://t-abc123.propr.dev', 'https://t-abc123.propr.dev/', 'https://t-abc123.propr.dev///']; for (const url of cases) { diff --git a/test/publicInstanceIdentity.test.ts b/test/publicInstanceIdentity.test.ts new file mode 100644 index 000000000..a8d3e7a3b --- /dev/null +++ b/test/publicInstanceIdentity.test.ts @@ -0,0 +1,1047 @@ +import assert from 'node:assert/strict'; +import { spawn } from 'node:child_process'; +import { + appendFileSync, + chmodSync, + closeSync, + constants, + existsSync, + linkSync, + lstatSync, + mkdtempSync, + mkdirSync, + openSync, + readFileSync, + realpathSync, + renameSync, + rmSync, + symlinkSync, + writeFileSync, +} from 'node:fs'; +import { tmpdir } from 'node:os'; +import { join } from 'node:path'; +import { afterEach, test } from 'node:test'; +import { + ConnectRootError, + getOrCreatePublicInstanceIdentity as getCliIdentity, + getOrCreateSnapshotPublicInstanceIdentity, + readSnapshotPublicInstanceIdentity, + readTrustedConnectTunnelOverride, + TrustedConnectConfigError, + withOwnedConnectRootSnapshot, +} from '../packages/cli/src/connectIdentity.js'; +import { getOrCreatePublicInstanceIdentity as getApiIdentity } from '../packages/api/publicInstanceIdentity.js'; +import { + PUBLIC_IDENTITY_DIRECTORY_MODE, + PUBLIC_IDENTITY_FILE_MODE, + getOrCreatePublicInstanceIdentity, + publicIdentityFilePermissionsAllowed, + samePublicFileIdentity, + type PublicIdentityBoundary, +} from '../packages/local-setup/src/publicInstanceIdentity.js'; +import { PUBLIC_INSTANCE_IDENTITY_FILENAME } from '@propr/shared'; +import { + assertNativeWindowsEntriesAuthority, + assertSafeDarwinAclOutput, + assertSafeWindowsAuthority, + stableAuthorityIdentity, + type ConnectRootAuthorityInspector, + type WindowsAuthorityInspection, +} from '../packages/cli/src/connectRootAuthority.js'; +import { setNativeDirectoryOpenTestHook } from '../packages/cli/src/utils/directoryDescriptor.js'; + +afterEach(() => setNativeDirectoryOpenTestHook()); + +const IDS = { + first: 'aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa', + second: 'bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb', + third: 'cccccccc-cccc-4ccc-8ccc-cccccccccccc', + fourth: 'dddddddd-dddd-4ddd-8ddd-dddddddddddd', +} as const; + +test('exact identity comparison does not collapse adjacent values above Number.MAX_SAFE_INTEGER', () => { + assert.equal(samePublicFileIdentity( + { device: '7', file: '9007199254740992' }, + { device: '7', file: '9007199254740993' }, + ), false); + assert.equal(samePublicFileIdentity( + { device: '18446744073709551614', file: '18446744073709551615' }, + { device: '18446744073709551614', file: '18446744073709551615' }, + ), true); + assert.throws(() => samePublicFileIdentity( + { device: '7', file: '09007199254740992' }, + { device: '7', file: '9007199254740992' }, + ), /canonical/); +}); + +function temporaryRoot(prefix: string): string { + return realpathSync(mkdtempSync(join(tmpdir(), prefix))); +} + +function privateDirectory(path: string): void { + mkdirSync(path, { recursive: true, mode: PUBLIC_IDENTITY_DIRECTORY_MODE }); + chmodSync(path, PUBLIC_IDENTITY_DIRECTORY_MODE); +} + +function connectRoot(parent: string, env = 'PROPR_INSTANCE_ID=abc123\n'): string { + const root = join(parent, 'stack'); + privateDirectory(join(root, 'data')); + writeFileSync(join(root, '.env'), env, { mode: 0o600 }); + chmodSync(join(root, '.env'), 0o600); + return root; +} + +function identityPath(data: string): string { + return join(data, PUBLIC_INSTANCE_IDENTITY_FILENAME); +} + +test('public identity persists across CLI/API restart and changes with replaced stack data', async () => { + const root = temporaryRoot('propr-public-identity-'); + const data = join(root, 'data'); + privateDirectory(data); + try { + const first = await getCliIdentity(data, () => IDS.first); + assert.equal(await getApiIdentity(data, () => IDS.second), first); + assert.equal(await getCliIdentity(data, () => IDS.third), first); + + rmSync(data, { recursive: true }); + privateDirectory(data); + const replacement = await getApiIdentity(data, () => IDS.fourth); + assert.notEqual(replacement, first); + } finally { + rmSync(root, { recursive: true, force: true }); + } +}); + +function runCreator(kind: 'cli' | 'api', data: string, id: string): Promise { + return new Promise((resolve, reject) => { + const child = spawn(process.execPath, [ + '--import', + 'tsx', + 'test/fixtures/publicIdentityCreator.ts', + kind, + data, + id, + ], { cwd: process.cwd(), shell: false, stdio: ['ignore', 'pipe', 'pipe'] }); + let stdout = ''; + let stderr = ''; + child.stdout.setEncoding('utf8').on('data', (chunk) => { stdout += chunk; }); + child.stderr.setEncoding('utf8').on('data', (chunk) => { stderr += chunk; }); + child.once('error', reject); + child.once('exit', (code) => { + if (code === 0) resolve(stdout.trim()); + else reject(new Error(`creator exited ${code}: ${stderr}`)); + }); + }); +} + +test('concurrent CLI and API creators publish one complete durable winner', async () => { + const root = temporaryRoot('propr-public-identity-concurrent-'); + const data = join(root, 'data'); + privateDirectory(data); + try { + const [cli, api] = await Promise.all([ + runCreator('cli', data, IDS.first), + runCreator('api', data, IDS.second), + ]); + assert.equal(cli, api); + assert.ok(cli === IDS.first || cli === IDS.second); + assert.equal(await getCliIdentity(data, () => IDS.third), cli); + const bytes = readFileSync(identityPath(data), 'utf8'); + assert.ok(bytes.length > 0); + assert.equal(JSON.parse(bytes).publicInstanceIdentity, cli); + assert.equal(lstatSync(identityPath(data)).nlink, 1); + } finally { + rmSync(root, { recursive: true, force: true }); + } +}); + +for (const boundary of [ + 'temporary-opened', + 'temporary-written', + 'temporary-synced', + 'recovery-published', + 'identity-published', + 'directory-synced', +] as const satisfies readonly PublicIdentityBoundary[]) { + test(`identity restart is durable after interruption at ${boundary}`, async () => { + const root = temporaryRoot(`propr-public-identity-${boundary}-`); + const data = join(root, 'data'); + privateDirectory(data); + let interrupted = false; + try { + await assert.rejects(getOrCreatePublicInstanceIdentity(data, { + generate: () => IDS.first, + role: 'host', + onBoundary: (current) => { + if (!interrupted && current === boundary) { + interrupted = true; + throw new Error('simulated interruption'); + } + }, + }), /simulated interruption/); + const winner = await getApiIdentity(data, () => IDS.second); + assert.ok(winner === IDS.first || winner === IDS.second); + assert.equal(await getCliIdentity(data, () => IDS.third), winner); + assert.ok(lstatSync(identityPath(data)).size > 0); + assert.equal(lstatSync(identityPath(data)).nlink, 1); + } finally { + rmSync(root, { recursive: true, force: true }); + } + }); +} + +test('creation modes are independent of umask', async () => { + const root = temporaryRoot('propr-public-identity-umask-'); + const data = join(root, 'data'); + const previous = process.umask(0); + try { + assert.equal(await getCliIdentity(data, () => IDS.first), IDS.first); + assert.equal(lstatSync(data).mode & 0o777, PUBLIC_IDENTITY_DIRECTORY_MODE); + assert.equal(lstatSync(identityPath(data)).mode & 0o777, PUBLIC_IDENTITY_FILE_MODE); + } finally { + process.umask(previous); + rmSync(root, { recursive: true, force: true }); + } +}); + +test('identity storage rejects the filesystem root before creating state', async () => { + await assert.rejects(getApiIdentity('/', () => IDS.first), /filesystem root/); +}); + +test('identity storage rejects replaceable directories, symlinks, hardlinks, and unsafe modes', async () => { + const root = temporaryRoot('propr-public-identity-malicious-'); + try { + const unsafe = join(root, 'unsafe'); + mkdirSync(unsafe, { mode: 0o777 }); + chmodSync(unsafe, 0o777); + await assert.rejects(getCliIdentity(unsafe), /identity/); + + const real = join(root, 'real'); + privateDirectory(real); + const alias = join(root, 'alias'); + symlinkSync(real, alias, 'dir'); + await assert.rejects(getCliIdentity(alias), /identity/); + + assert.equal(await getCliIdentity(real, () => IDS.first), IDS.first); + chmodSync(identityPath(real), 0o666); + await assert.rejects(getApiIdentity(real), /permissions/); + chmodSync(identityPath(real), PUBLIC_IDENTITY_FILE_MODE); + linkSync(identityPath(real), join(real, 'identity-hardlink')); + await assert.rejects(getApiIdentity(real), /single-link/); + + const special = join(root, 'special'); + privateDirectory(special); + mkdirSync(identityPath(special), { mode: 0o700 }); + await assert.rejects(getApiIdentity(special), /regular file|identity file/); + } finally { + rmSync(root, { recursive: true, force: true }); + } +}); + +test('identity repairs only the exact recovery/final same-inode crash remnant', async () => { + const root = temporaryRoot('propr-public-identity-link-crash-'); + const data = join(root, 'data'); + privateDirectory(data); + const recovery = join(data, `.${PUBLIC_INSTANCE_IDENTITY_FILENAME}.ready-v1`); + try { + assert.equal(await getCliIdentity(data, () => IDS.first), IDS.first); + linkSync(identityPath(data), recovery); + assert.equal(lstatSync(identityPath(data)).nlink, 2); + assert.equal(await getApiIdentity(data, () => IDS.second), IDS.first); + assert.equal(lstatSync(identityPath(data)).nlink, 1); + assert.throws(() => lstatSync(recovery), /ENOENT/); + + linkSync(identityPath(data), join(data, 'hostile-unknown-hardlink')); + await assert.rejects(getApiIdentity(data), /identity|single-link/); + assert.equal(lstatSync(identityPath(data)).nlink, 2); + } finally { + rmSync(root, { recursive: true, force: true }); + } +}); + +test('identity restart repairs interruption between temporary-to-READY link and unlink', { + skip: process.platform !== 'linux', +}, async () => { + const root = temporaryRoot('propr-public-identity-temporary-link-crash-'); + const data = join(root, 'data'); + privateDirectory(data); + const temporary = join( + data, + `.${PUBLIC_INSTANCE_IDENTITY_FILENAME}.creating-v1-123-${IDS.first}`, + ); + const recovery = join(data, `.${PUBLIC_INSTANCE_IDENTITY_FILENAME}.ready-v1`); + try { + writeFileSync(temporary, `${JSON.stringify({ + schemaVersion: 1, + publicInstanceIdentity: IDS.second, + })}\n`, { mode: PUBLIC_IDENTITY_FILE_MODE }); + chmodSync(temporary, PUBLIC_IDENTITY_FILE_MODE); + linkSync(temporary, recovery); + assert.equal(lstatSync(temporary).nlink, 2); + + assert.equal(await getApiIdentity(data, () => IDS.third), IDS.second); + assert.equal(lstatSync(identityPath(data)).nlink, 1); + assert.throws(() => lstatSync(temporary), /ENOENT/); + assert.throws(() => lstatSync(recovery), /ENOENT/); + } finally { + rmSync(root, { recursive: true, force: true }); + } +}); + +test('identity bounded reads reject growth and named replacement after the initial stat', async () => { + const root = temporaryRoot('propr-public-identity-read-race-'); + const data = join(root, 'data'); + privateDirectory(data); + try { + assert.equal(await getCliIdentity(data, () => IDS.first), IDS.first); + let grew = false; + await assert.rejects(getOrCreatePublicInstanceIdentity(data, { + role: 'host', + onBoundary: (boundary) => { + if (boundary === 'identity-read-statted' && !grew) { + grew = true; + appendFileSync(identityPath(data), 'growth'); + } + }, + }), /changed|size|identity/); + + writeFileSync(identityPath(data), `${JSON.stringify({ + schemaVersion: 1, + publicInstanceIdentity: IDS.first, + })}\n`, { mode: PUBLIC_IDENTITY_FILE_MODE }); + let replaced = false; + await assert.rejects(getOrCreatePublicInstanceIdentity(data, { + role: 'host', + onBoundary: (boundary) => { + if (boundary !== 'identity-read-statted' || replaced) return; + replaced = true; + renameSync(identityPath(data), join(data, 'detached-identity')); + writeFileSync(identityPath(data), `${JSON.stringify({ + schemaVersion: 1, + publicInstanceIdentity: IDS.second, + })}\n`, { mode: PUBLIC_IDENTITY_FILE_MODE }); + }, + }), /changed|identity|ENOENT/); + } finally { + rmSync(root, { recursive: true, force: true }); + } +}); + +test('the cross-container model accepts a host-readable root-owned file only', () => { + const hostOwner = 1000; + assert.equal(publicIdentityFilePermissionsAllowed({ uid: 0, mode: 0o100644 }, hostOwner, 'linux'), true); + assert.equal(publicIdentityFilePermissionsAllowed({ uid: 0, mode: 0o100600 }, hostOwner, 'linux'), false); + assert.equal(publicIdentityFilePermissionsAllowed({ uid: hostOwner, mode: 0o100644 }, hostOwner, 'linux'), true); + assert.equal(publicIdentityFilePermissionsAllowed({ uid: hostOwner, mode: 0o100600 }, hostOwner, 'linux'), false); + assert.equal(publicIdentityFilePermissionsAllowed({ uid: 2000, mode: 0o100644 }, hostOwner, 'linux'), false); + assert.equal(publicIdentityFilePermissionsAllowed({ uid: 0, mode: 0o100666 }, hostOwner, 'linux'), false); +}); + +test('status identity reads neither create nor repair snapshot state', async () => { + const parent = temporaryRoot('propr-connect-read-only-identity-'); + const root = connectRoot(parent); + try { + await withOwnedConnectRootSnapshot(root, async (snapshot) => { + await assert.rejects(readSnapshotPublicInstanceIdentity(snapshot.identityDirectory)); + assert.throws(() => lstatSync(identityPath(join(root, 'data'))), /ENOENT/); + assert.equal(await getOrCreateSnapshotPublicInstanceIdentity(snapshot.identityDirectory, () => IDS.first), IDS.first); + assert.equal(await readSnapshotPublicInstanceIdentity(snapshot.identityDirectory), IDS.first); + }, { parseEnvFile: () => ({}) }); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('Connect root replacement never redirects env/data reads and fails closed', async () => { + const parent = temporaryRoot('propr-connect-root-race-'); + const root = connectRoot(parent, 'ORIGINAL=value\n'); + const detached = join(parent, 'detached'); + let parsedBytes = ''; + try { + await assert.rejects(withOwnedConnectRootSnapshot(root, async (snapshot) => { + assert.equal(snapshot.envFileValues.ORIGINAL, 'value'); + assert.equal(await getOrCreateSnapshotPublicInstanceIdentity(snapshot.identityDirectory, () => IDS.first), IDS.first); + }, { + parseEnvFile: (contents) => { + parsedBytes = contents; + return { ORIGINAL: 'value' }; + }, + onBoundary: (boundary) => { + if (boundary !== 'acquired') return; + renameSync(root, detached); + connectRoot(parent, 'REPLACEMENT_SENTINEL=never-read\n'); + }, + }), ConnectRootError); + assert.equal(parsedBytes, 'ORIGINAL=value\n'); + assert.equal(parsedBytes.includes('REPLACEMENT_SENTINEL'), false); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('Linux authority walk accepts the pinned read-only fallback after consecutive EINVAL opens', { + skip: process.platform !== 'linux' ? 'requires Linux descriptor-relative child opens' : false, +}, async () => { + const parent = temporaryRoot('propr-connect-authority-fallback-'); + const root = connectRoot(parent); + let fallbackOpens = 0; + try { + setNativeDirectoryOpenTestHook((phase, directory) => { + if (directory !== root) return; + if (phase === 'before-primary-open') { + throw Object.assign(new Error('injected strict-open failure'), { code: 'EINVAL' }); + } + if (phase === 'before-directory-fallback-open') { + throw Object.assign(new Error('injected directory-open failure'), { code: 'EINVAL' }); + } + if (phase === 'after-fallback-open') fallbackOpens += 1; + }, true); + await withOwnedConnectRootSnapshot(root, () => undefined, { parseEnvFile: () => ({}) }); + assert.equal(fallbackOpens, 2, 'initial and final authority walks both use the pinned fallback'); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('Linux authority walk fallback rejects named-directory replacement', { + skip: process.platform !== 'linux' ? 'requires Linux descriptor-relative child opens' : false, +}, async () => { + const parent = temporaryRoot('propr-connect-authority-replacement-'); + const root = connectRoot(parent); + const detached = join(parent, 'detached'); + let replaced = false; + try { + setNativeDirectoryOpenTestHook((phase, directory) => { + if (directory !== root) return; + if (phase === 'before-primary-open') { + throw Object.assign(new Error('injected strict-open failure'), { code: 'EINVAL' }); + } + if (phase === 'before-directory-fallback-open') { + throw Object.assign(new Error('injected directory-open failure'), { code: 'EINVAL' }); + } + if (phase === 'after-fallback-open' && !replaced) { + replaced = true; + renameSync(root, detached); + connectRoot(parent, 'REPLACEMENT_SENTINEL=never-read\n'); + } + }, true); + await assert.rejects( + withOwnedConnectRootSnapshot(root, () => undefined, { parseEnvFile: () => ({}) }), + ConnectRootError, + ); + assert.equal(replaced, true); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('Linux authority walk fallback rejects a symlink substituted after open', { + skip: process.platform !== 'linux' ? 'requires Linux descriptor-relative child opens' : false, +}, async () => { + const parent = temporaryRoot('propr-connect-authority-symlink-'); + const root = connectRoot(parent); + const detached = join(parent, 'detached'); + let replaced = false; + try { + setNativeDirectoryOpenTestHook((phase, directory) => { + if (directory !== root) return; + if (phase === 'before-primary-open') { + throw Object.assign(new Error('injected strict-open failure'), { code: 'EINVAL' }); + } + if (phase === 'before-directory-fallback-open') { + throw Object.assign(new Error('injected directory-open failure'), { code: 'EINVAL' }); + } + if (phase === 'after-fallback-open' && !replaced) { + replaced = true; + renameSync(root, detached); + symlinkSync(detached, root, 'dir'); + } + }, true); + await assert.rejects( + withOwnedConnectRootSnapshot(root, () => undefined, { parseEnvFile: () => ({}) }), + ConnectRootError, + ); + assert.equal(replaced, true); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('Linux authority walk never reaches the read-only fallback after a non-EINVAL directory-open failure', { + skip: process.platform !== 'linux' ? 'requires Linux descriptor-relative child opens' : false, +}, async () => { + const parent = temporaryRoot('propr-connect-authority-non-einval-'); + const root = connectRoot(parent); + let fallbackObserved = false; + try { + setNativeDirectoryOpenTestHook((phase, directory) => { + if (directory !== root) return; + if (phase === 'before-primary-open') { + throw Object.assign(new Error('injected strict-open failure'), { code: 'EINVAL' }); + } + if (phase === 'before-directory-fallback-open') { + throw Object.assign(new Error('injected denied directory open'), { code: 'EACCES' }); + } + if (phase === 'before-readonly-fallback-open') fallbackObserved = true; + }, true); + await assert.rejects( + withOwnedConnectRootSnapshot(root, () => undefined, { parseEnvFile: () => ({}) }), + ConnectRootError, + ); + assert.equal(fallbackObserved, false); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +type AuthorityChildCallsite = 'trusted-home .propr' | 'existing identity data' | 'new identity data'; + +function authorityChildFixture(callsite: AuthorityChildCallsite): { + parent: string; + target: string; + run: () => Promise; +} { + const parent = temporaryRoot(`propr-connect-child-authority-${callsite.replaceAll(' ', '-')}-`); + if (callsite === 'trusted-home .propr') { + const home = join(parent, 'home'); + const target = join(home, '.propr'); + privateDirectory(target); + writeFileSync(join(target, 'config.json'), JSON.stringify({ + tunnelEnabledByRoot: { '/trusted/stack': false }, + }), { mode: 0o600 }); + chmodSync(join(target, 'config.json'), 0o600); + return { + parent, + target, + run: () => readTrustedConnectTunnelOverride('/trusted/stack', { trustedHome: home }), + }; + } + if (callsite === 'existing identity data') { + const root = connectRoot(parent); + return { + parent, + target: join(root, 'data'), + run: () => withOwnedConnectRootSnapshot(root, () => undefined, { parseEnvFile: () => ({}) }), + }; + } + const target = join(parent, 'data'); + return { + parent, + target, + run: () => getCliIdentity(target, () => IDS.first), + }; +} + +for (const callsite of [ + 'trusted-home .propr', + 'existing identity data', + 'new identity data', +] as const satisfies readonly AuthorityChildCallsite[]) { + test(`Linux ${callsite} authority child is opened through the full pinned fallback`, { + skip: process.platform !== 'linux' ? 'requires Linux descriptor-relative child opens' : false, + }, async () => { + for (const scenario of [ + 'second-stage EINVAL', + 'replacement', + 'symlink', + 'non-directory', + 'non-EINVAL', + ] as const) { + const fixture = authorityChildFixture(callsite); + const detached = `${fixture.target}.detached`; + let targetOpen = 0; + let directoryFallbackObserved = false; + let readOnlyFallbackObserved = false; + try { + setNativeDirectoryOpenTestHook((phase, directory) => { + if (directory !== fixture.target) return; + if (phase === 'before-primary-open') { + targetOpen += 1; + if (targetOpen !== 1) return; + if (scenario === 'non-EINVAL') { + throw Object.assign(new Error('injected denied child open'), { code: 'EACCES' }); + } + if (scenario === 'non-directory') { + renameSync(fixture.target, detached); + writeFileSync(fixture.target, 'not a directory\n', { mode: 0o600 }); + } + throw Object.assign(new Error('injected strict child-open failure'), { code: 'EINVAL' }); + } + if (targetOpen !== 1) return; + if (phase === 'before-directory-fallback-open') { + directoryFallbackObserved = true; + throw Object.assign(new Error('injected directory child-open failure'), { code: 'EINVAL' }); + } + if (phase === 'before-readonly-fallback-open') readOnlyFallbackObserved = true; + if (phase === 'after-fallback-open' && (scenario === 'replacement' || scenario === 'symlink')) { + renameSync(fixture.target, detached); + if (scenario === 'replacement') privateDirectory(fixture.target); + else symlinkSync(detached, fixture.target, 'dir'); + } + }, true); + + if (scenario === 'second-stage EINVAL') { + await assert.doesNotReject(fixture.run(), `${callsite}: ${scenario}`); + assert.equal(directoryFallbackObserved, true, `${callsite}: ${scenario}`); + assert.equal(readOnlyFallbackObserved, true, `${callsite}: ${scenario}`); + } else { + await assert.rejects(fixture.run(), undefined, `${callsite}: ${scenario}`); + if (scenario === 'non-EINVAL') { + assert.equal(directoryFallbackObserved, false, `${callsite}: ${scenario}`); + assert.equal(readOnlyFallbackObserved, false, `${callsite}: ${scenario}`); + } + } + } finally { + setNativeDirectoryOpenTestHook(); + rmSync(fixture.parent, { recursive: true, force: true }); + } + } + }); +} + +test('trusted-home absence is translated only after the authority helper returns final ENOENT', { + skip: process.platform !== 'linux' ? 'requires Linux descriptor-relative child opens' : false, +}, async () => { + const parent = temporaryRoot('propr-connect-child-authority-absent-'); + const home = join(parent, 'home'); + const target = join(home, '.propr'); + privateDirectory(home); + let strictFailures = 0; + try { + setNativeDirectoryOpenTestHook((phase, directory) => { + if (directory === target && phase === 'before-primary-open') { + strictFailures += 1; + throw Object.assign(new Error('injected strict child-open failure'), { code: 'EINVAL' }); + } + }, true); + assert.equal(await readTrustedConnectTunnelOverride('/trusted/stack', { trustedHome: home }), undefined); + assert.equal(strictFailures, 1); + assert.equal(existsSync(target), false); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('Connect data replacement before identity access never reads the replacement winner', async () => { + const parent = temporaryRoot('propr-connect-data-race-'); + const root = connectRoot(parent); + const data = join(root, 'data'); + const detachedData = join(root, 'data-detached'); + let observedIdentity = ''; + try { + await assert.rejects(withOwnedConnectRootSnapshot(root, async (snapshot) => { + observedIdentity = await getOrCreateSnapshotPublicInstanceIdentity(snapshot.identityDirectory, () => IDS.first); + }, { + parseEnvFile: () => ({}), + onBoundary: (boundary) => { + if (boundary !== 'env-read') return; + renameSync(data, detachedData); + privateDirectory(data); + writeFileSync(identityPath(data), `${JSON.stringify({ + schemaVersion: 1, + publicInstanceIdentity: IDS.second, + })}\n`, { mode: PUBLIC_IDENTITY_FILE_MODE }); + }, + }), ConnectRootError); + assert.equal(observedIdentity, IDS.first); + assert.notEqual(observedIdentity, IDS.second); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('Connect root authority rejects symlinks, unsafe modes, and Windows pathname simulation', async () => { + const parent = temporaryRoot('propr-connect-root-validation-'); + const root = connectRoot(parent); + const alias = join(parent, 'stack-alias'); + symlinkSync(root, alias, 'dir'); + const parseEnvFile = () => ({}); + try { + await assert.rejects(withOwnedConnectRootSnapshot(undefined, () => undefined, { parseEnvFile }), ConnectRootError); + await assert.rejects(withOwnedConnectRootSnapshot(alias, () => undefined, { parseEnvFile }), ConnectRootError); + await assert.rejects( + withOwnedConnectRootSnapshot(root, () => undefined, { parseEnvFile, platform: 'win32' }), + ConnectRootError, + ); + chmodSync(join(root, 'data'), 0o777); + await assert.rejects(withOwnedConnectRootSnapshot(root, () => undefined, { parseEnvFile }), ConnectRootError); + chmodSync(join(root, 'data'), 0o700); + chmodSync(parent, 0o777); + await assert.rejects(withOwnedConnectRootSnapshot(root, () => undefined, { parseEnvFile }), ConnectRootError); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +const WINDOWS_USER_SID = 'S-1-5-21-1000-1000-1000-1001'; +const safeWindowsAuthority = ( + identity = { device: '1', file: '1' }, + kind: 'ancestor' | 'home' | 'root' | 'data' | 'env' = 'root', + index = 0, +): WindowsAuthorityInspection => ({ + index, + kind: kind === 'env' ? 'file' : 'directory', + authorityKind: kind, + currentUserSid: WINDOWS_USER_SID, + ownerSid: WINDOWS_USER_SID, + daclProtected: true, + reparsePoint: false, + volumeSerialNumber: identity.device, + fileId: identity.file, + verifiedVolumeSerialNumber: identity.device, + verifiedFileId: identity.file, + rules: [ + { identitySid: WINDOWS_USER_SID, inherited: false, accessType: 'allow', appliesToSelf: true, rights: '2032127' }, + { identitySid: 'S-1-5-18', inherited: false, accessType: 'allow', appliesToSelf: true, rights: '2032127' }, + { identitySid: 'S-1-5-32-544', inherited: false, accessType: 'allow', appliesToSelf: true, rights: '2032127' }, + { identitySid: 'S-1-1-0', inherited: true, accessType: 'allow', appliesToSelf: true, rights: '1179785' }, + ], +}); + +test('Windows DACL policy accepts only explicit narrow mutators and rejects inherited or broad writes', () => { + assert.doesNotThrow(() => assertSafeWindowsAuthority(safeWindowsAuthority(), 'root')); + for (const rule of [ + { identitySid: WINDOWS_USER_SID, inherited: true, accessType: 'allow' as const, appliesToSelf: true, rights: '2' }, + { identitySid: 'S-1-1-0', inherited: false, accessType: 'allow' as const, appliesToSelf: true, rights: '2' }, + { identitySid: 'S-1-5-11', inherited: false, accessType: 'allow' as const, appliesToSelf: true, rights: '268435456' }, + ]) { + assert.throws(() => assertSafeWindowsAuthority({ + ...safeWindowsAuthority(), + rules: [rule], + }, 'root'), /authority|grant/); + } + assert.throws(() => assertSafeWindowsAuthority({ + ...safeWindowsAuthority(), + ownerSid: 'S-1-5-18', + }, 'root'), /authority/); + assert.throws(() => assertSafeWindowsAuthority({ + ...safeWindowsAuthority(), + daclProtected: false, + }, 'data'), /authority/); + assert.throws(() => assertSafeWindowsAuthority({ + ...safeWindowsAuthority(), + reparsePoint: true, + }, 'root'), /authority/); +}); + +test('Windows batch binding keeps descriptor identities, indexes, and types exact', async () => { + const parent = temporaryRoot('propr-windows-full-identity-'); + const firstPath = join(parent, 'first'); + const secondPath = join(parent, 'second'); + writeFileSync(firstPath, 'A', { mode: 0o600 }); + writeFileSync(secondPath, 'B', { mode: 0o600 }); + const firstFd = openSync(firstPath, constants.O_RDONLY); + const secondFd = openSync(secondPath, constants.O_RDONLY); + const entries = [ + { path: firstPath, kind: 'env' as const, pinnedFd: firstFd }, + { path: secondPath, kind: 'env' as const, pinnedFd: secondFd }, + ]; + const firstIdentity = stableAuthorityIdentity(firstFd); + const secondIdentity = stableAuthorityIdentity(secondFd); + const exactInspector: ConnectRootAuthorityInspector = { + inspectDarwinAcl: (_path, _fd, identity) => ({ version: 1, ...identity, acl: '!#acl 1\n' }), + inspectWindowsAcl: async (_path, identity, _fd, kind = 'env') => safeWindowsAuthority(identity, kind), + inspectWindowsAcls: async () => [ + safeWindowsAuthority(firstIdentity, 'env', 0), + safeWindowsAuthority(secondIdentity, 'env', 1), + ], + }; + try { + await assert.doesNotReject(assertNativeWindowsEntriesAuthority(exactInspector, entries)); + await assert.rejects(assertNativeWindowsEntriesAuthority({ + ...exactInspector, + inspectWindowsAcls: async () => [ + safeWindowsAuthority(secondIdentity, 'env', 1), + safeWindowsAuthority(firstIdentity, 'env', 0), + ], + }, entries), /unavailable/); + await assert.rejects(assertNativeWindowsEntriesAuthority({ + ...exactInspector, + inspectWindowsAcls: async () => [{ + ...safeWindowsAuthority(firstIdentity, 'env', 0), + verifiedFileId: (BigInt(firstIdentity.file) + 1n).toString(), + }, safeWindowsAuthority(secondIdentity, 'env', 1)], + }, entries), /unavailable/); + await assert.rejects(assertNativeWindowsEntriesAuthority({ + ...exactInspector, + inspectWindowsAcls: async () => [{ + ...safeWindowsAuthority(firstIdentity, 'env', 0), + unexpected: 'unbounded-schema-extension', + } as WindowsAuthorityInspection, safeWindowsAuthority(secondIdentity, 'env', 1)], + }, entries), /unavailable/); + } finally { + closeSync(secondFd); + closeSync(firstFd); + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('Darwin ACL parser accepts absent/read-only ACLs and rejects write or unknown authority', () => { + const uuid = 'AAAAAAAA-AAAA-4AAA-8AAA-AAAAAAAAAAAA'; + assert.doesNotThrow(() => assertSafeDarwinAclOutput('!#acl 1\n')); + assert.doesNotThrow(() => assertSafeDarwinAclOutput([ + '!#acl 1', + `group:${uuid}:everyone:12:deny:delete`, + `user:${uuid}:auditor:501:allow:read,readattr,readextattr,readsecurity`, + '', + ].join('\n'))); + assert.throws(() => assertSafeDarwinAclOutput([ + '!#acl 1', + `group:${uuid}:staff:20:allow:write,append`, + ].join('\n')), /write authority/); + assert.throws(() => assertSafeDarwinAclOutput('!#acl 1\nunparseable acl'), /malformed/); +}); + +test('injected Windows and Darwin inspectors exercise the real root policy path', async () => { + const parent = temporaryRoot('propr-connect-platform-authority-'); + const root = connectRoot(parent); + const calls: string[] = []; + const inspector: ConnectRootAuthorityInspector = { + inspectDarwinAcl: (path, _fd, expectedIdentity) => { + calls.push(`darwin:${path}`); + return { version: 1, ...expectedIdentity, acl: '!#acl 1\n' }; + }, + inspectWindowsAcl: async (path, expectedIdentity, _fd, kind = 'env') => { + calls.push(`win32:${path}`); + return safeWindowsAuthority(expectedIdentity, kind); + }, + }; + try { + assert.equal(await withOwnedConnectRootSnapshot(root, (snapshot) => ( + getOrCreateSnapshotPublicInstanceIdentity(snapshot.identityDirectory, () => IDS.first) + ), { platform: 'win32', authorityInspector: inspector, parseEnvFile: () => ({}) }), IDS.first); + assert.ok(calls.some((entry) => entry.endsWith('/stack'))); + calls.length = 0; + assert.equal((await withOwnedConnectRootSnapshot(root, (snapshot) => snapshot.envFileValues, { + platform: 'darwin', + authorityInspector: inspector, + parseEnvFile: () => ({ safe: 'yes' }), + })).safe, 'yes'); + assert.ok(calls.some((entry) => entry.startsWith('darwin:'))); + + const rejecting: ConnectRootAuthorityInspector = { + ...inspector, + inspectWindowsAcl: async (_path, expectedIdentity, _fd, kind = 'env') => ({ + ...safeWindowsAuthority(expectedIdentity, kind), + rules: [{ identitySid: 'S-1-1-0', inherited: true, accessType: 'allow', appliesToSelf: true, rights: '2' }], + }), + }; + await assert.rejects(withOwnedConnectRootSnapshot(root, () => undefined, { + platform: 'win32', authorityInspector: rejecting, parseEnvFile: () => ({}), + }), ConnectRootError); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('read-only Windows snapshot fails closed when native inspection cannot complete', async () => { + const parent = temporaryRoot('propr-connect-windows-read-only-'); + const root = connectRoot(parent, 'PROPR_STACK=readonly\n'); + const data = join(root, 'data'); + writeFileSync(identityPath(data), `${JSON.stringify({ + schemaVersion: 1, + publicInstanceIdentity: IDS.first, + })}\n`, { mode: PUBLIC_IDENTITY_FILE_MODE }); + let nativeCalls = 0; + const forbiddenInspector: ConnectRootAuthorityInspector = { + inspectDarwinAcl: () => { nativeCalls += 1; throw new Error('native inspector executed'); }, + inspectWindowsAcl: async () => { nativeCalls += 1; throw new Error('native inspector executed'); }, + inspectWindowsAcls: async () => { nativeCalls += 1; throw new Error('native inspector executed'); }, + }; + try { + await assert.rejects(withOwnedConnectRootSnapshot(root, async (snapshot) => ({ + diagnostic: snapshot.authorityDiagnostic, + identity: await readSnapshotPublicInstanceIdentity(snapshot.identityDirectory), + stack: snapshot.envFileValues.PROPR_STACK, + }), { + platform: 'win32', + authorityInspector: forbiddenInspector, + parseEnvFile: () => ({ PROPR_STACK: 'readonly' }), + }), ConnectRootError); + assert.ok(nativeCalls > 0); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('trusted Connect config read is bounded, root-specific, replacement-safe, and Windows-case distinct', async () => { + const parent = temporaryRoot('propr-connect-trusted-config-'); + const home = join(parent, 'os-home'); + const configDir = join(home, '.propr'); + privateDirectory(configDir); + const configPath = join(configDir, 'config.json'); + const root = '/trusted/stack'; + const writeConfig = (value: unknown) => { + writeFileSync(configPath, JSON.stringify(value), { mode: 0o600 }); + chmodSync(configPath, 0o600); + }; + try { + writeConfig({ + githubToken: 'must-never-cross', + tunnelEnabledByRoot: { [root]: false, '/other/stack': true }, + }); + assert.equal(await readTrustedConnectTunnelOverride(root, { trustedHome: home }), false); + assert.equal(await readTrustedConnectTunnelOverride('/other/stack', { trustedHome: home }), true); + assert.equal(await readTrustedConnectTunnelOverride('/unset/stack', { trustedHome: home }), undefined); + writeConfig({ githubToken: 'must-never-cross', tunnelEnabledByRoot: { [root]: true } }); + assert.equal(await readTrustedConnectTunnelOverride(root, { trustedHome: home }), true); + + writeConfig({ tunnelEnabledByRoot: { 'C:\\Work\\Stack': false, 'c:\\work\\stack': true } }); + const inspector: ConnectRootAuthorityInspector = { + inspectDarwinAcl: (_path, _fd, identity) => ({ version: 1, ...identity, acl: '!#acl 1\n' }), + inspectWindowsAcl: async (_path, identity, _fd, kind = 'env') => safeWindowsAuthority(identity, kind), + }; + assert.equal(await readTrustedConnectTunnelOverride('C:\\Work\\Stack', { + platform: 'win32', trustedHome: home, authorityInspector: inspector, + }), false); + assert.equal(await readTrustedConnectTunnelOverride('c:\\work\\stack', { + platform: 'win32', trustedHome: home, authorityInspector: inspector, + }), true); + assert.equal(await readTrustedConnectTunnelOverride('c:\\WORK\\STACK', { + platform: 'win32', trustedHome: home, authorityInspector: inspector, + }), undefined); + + writeConfig({ tunnelEnabledByRoot: { [root]: false } }); + let swapped = false; + await assert.rejects(readTrustedConnectTunnelOverride(root, { + trustedHome: home, + onBoundary: (boundary) => { + if (boundary !== 'config-opened' || swapped) return; + swapped = true; + renameSync(configPath, `${configPath}.detached`); + writeConfig({ tunnelEnabledByRoot: { [root]: true } }); + }, + }), TrustedConnectConfigError); + + writeFileSync(configPath, '{malformed', { mode: 0o600 }); + await assert.rejects(readTrustedConnectTunnelOverride(root, { trustedHome: home }), TrustedConnectConfigError); + writeConfig({ tunnelEnabledByRoot: { [root]: false } }); + chmodSync(configPath, 0o666); + await assert.rejects(readTrustedConnectTunnelOverride(root, { trustedHome: home }), TrustedConnectConfigError); + chmodSync(configPath, 0o000); + await assert.rejects(readTrustedConnectTunnelOverride(root, { trustedHome: home }), TrustedConnectConfigError); + } finally { + rmSync(parent, { recursive: true, force: true }); + } +}); + +test('trusted config authenticates absence only at the exact config child open', async () => { + const root = '/trusted/stack'; + const boundaries = [ + 'home-before-open', + 'home-opened', + 'config-directory-before-open', + 'config-directory-opened', + 'config-before-open', + 'config-opened', + ] as const; + for (const boundary of boundaries) { + const parent = temporaryRoot(`propr-config-barrier-${boundary}-`); + const home = join(parent, 'home'); + const configDir = join(home, '.propr'); + const configPath = join(configDir, 'config.json'); + privateDirectory(configDir); + writeFileSync(configPath, JSON.stringify({ tunnelEnabledByRoot: { [root]: false } }), { mode: 0o600 }); + chmodSync(configPath, 0o600); + let replaced = false; + try { + await assert.rejects(readTrustedConnectTunnelOverride(root, { + trustedHome: home, + onBoundary: (current) => { + if (current !== boundary || replaced) return; + replaced = true; + if (current.startsWith('home-')) { + renameSync(home, `${home}.detached`); + privateDirectory(join(home, '.propr')); + writeFileSync(configPath, JSON.stringify({ tunnelEnabledByRoot: { [root]: true } }), { mode: 0o600 }); + } else if (current.startsWith('config-directory-')) { + renameSync(configDir, `${configDir}.detached`); + privateDirectory(configDir); + writeFileSync(configPath, JSON.stringify({ tunnelEnabledByRoot: { [root]: true } }), { mode: 0o600 }); + } else { + renameSync(configPath, `${configPath}.detached`); + writeFileSync(configPath, JSON.stringify({ tunnelEnabledByRoot: { [root]: true } }), { mode: 0o600 }); + chmodSync(configPath, 0o600); + } + }, + }), TrustedConnectConfigError, boundary); + assert.equal(replaced, true, boundary); + } finally { + rmSync(parent, { recursive: true, force: true }); + } + } + + const parent = temporaryRoot('propr-config-absence-'); + const home = join(parent, 'home'); + const configDir = join(home, '.propr'); + try { + privateDirectory(home); + assert.equal(lstatSync(home).isDirectory(), true); + assert.equal(existsSync(configDir), false); + assert.equal(await readTrustedConnectTunnelOverride(root, { trustedHome: home }), undefined); + assert.equal(existsSync(configDir), false, 'an absent .propr directory is never created'); + + privateDirectory(configDir); + assert.equal(await readTrustedConnectTunnelOverride(root, { trustedHome: home }), undefined); + rmSync(configDir, { recursive: true }); + assert.equal(await readTrustedConnectTunnelOverride(root, { trustedHome: home }), undefined); + assert.equal(existsSync(configDir), false); + } finally { + rmSync(parent, { recursive: true, force: true }); + } + + const windowsParent = temporaryRoot('propr-config-absence-windows-'); + const windowsHome = join(windowsParent, 'home'); + privateDirectory(windowsHome); + const inspectedKinds: string[] = []; + const windowsInspector: ConnectRootAuthorityInspector = { + inspectDarwinAcl: (_path, _fd, identity) => ({ version: 1, ...identity, acl: '!#acl 1\n' }), + inspectWindowsAcl: async (_path, identity, _fd, kind = 'env') => { + inspectedKinds.push(kind); + return safeWindowsAuthority(identity, kind); + }, + }; + try { + assert.equal(await readTrustedConnectTunnelOverride(root, { + platform: 'win32', + trustedHome: windowsHome, + authorityInspector: windowsInspector, + }), undefined); + assert.ok(inspectedKinds.includes('home')); + assert.equal(existsSync(join(windowsHome, '.propr')), false); + } finally { + rmSync(windowsParent, { recursive: true, force: true }); + } + + for (const race of ['home-aba', 'config-directory-aba', 'config-directory-symlink'] as const) { + const raceParent = temporaryRoot(`propr-config-absence-${race}-`); + const raceHome = join(raceParent, 'home'); + const raceConfigDir = join(raceHome, '.propr'); + const detachedHome = join(raceParent, 'home-detached'); + const detachedConfigDir = join(raceHome, '.propr-detached'); + privateDirectory(raceHome); + if (race !== 'home-aba') privateDirectory(raceConfigDir); + let raced = false; + try { + await assert.rejects(readTrustedConnectTunnelOverride(root, { + trustedHome: raceHome, + onBoundary: (current) => { + if (current !== 'config-directory-before-open' || raced) return; + raced = true; + if (race === 'home-aba') { + renameSync(raceHome, detachedHome); + privateDirectory(raceHome); + } else { + renameSync(raceConfigDir, detachedConfigDir); + if (race === 'config-directory-aba') privateDirectory(raceConfigDir); + else symlinkSync(detachedConfigDir, raceConfigDir, 'dir'); + } + }, + }), TrustedConnectConfigError, race); + assert.equal(raced, true, race); + } finally { + rmSync(raceParent, { recursive: true, force: true }); + } + } +}); diff --git a/test/testSuiteRunner.test.mjs b/test/testSuiteRunner.test.mjs index 7b0c02581..d66569c62 100644 --- a/test/testSuiteRunner.test.mjs +++ b/test/testSuiteRunner.test.mjs @@ -1,5 +1,5 @@ import assert from 'node:assert/strict'; -import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'; +import { mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs'; import { tmpdir } from 'node:os'; import { join } from 'node:path'; import { describe, test } from 'node:test'; @@ -15,6 +15,36 @@ import { } from '../scripts/run-test-suite.mjs'; describe('release test-suite runner', () => { + test('prepares desktop runtime dependencies before clean desktop and full-suite tests', () => { + const rootPackage = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8')); + const desktopPackageUrl = new URL('../apps/desktop/package.json', import.meta.url); + const desktopPackage = JSON.parse(readFileSync(desktopPackageUrl, 'utf8')); + const workflow = readFileSync(new URL('../.github/workflows/pr-test-on-label.yml', import.meta.url), 'utf8'); + const sharedBuild = 'npm run build --workspace=packages/shared'; + const clientBuild = 'npm run build --workspace=packages/client'; + const fullSuitePreparation = rootPackage.scripts['test:prepare']; + const desktopPreparation = desktopPackage.scripts['prepare:renderer']; + + assert.ok(fullSuitePreparation.indexOf(sharedBuild) >= 0); + assert.ok(fullSuitePreparation.indexOf(clientBuild) > fullSuitePreparation.indexOf(sharedBuild)); + assert.equal(desktopPackage.scripts.pretest, 'npm run prepare:renderer'); + assert.ok(desktopPreparation.indexOf('npm run build -w @propr/client') + > desktopPreparation.indexOf('npm run build -w @propr/shared')); + + const cleanSharedDist = workflow.indexOf('test ! -e packages/shared/dist'); + const cleanClientDist = workflow.indexOf('test ! -e packages/client/dist'); + const prepareFullSuite = workflow.indexOf('npm run test:prepare', cleanClientDist); + const assertSharedBuilt = workflow.indexOf('test -f packages/shared/dist/index.js', prepareFullSuite); + const assertClientBuilt = workflow.indexOf('test -f packages/client/dist/index.js', prepareFullSuite); + const runFullSuite = workflow.indexOf('npm run test:full:prepared', assertClientBuilt); + assert.ok(cleanSharedDist >= 0); + assert.ok(cleanClientDist > cleanSharedDist); + assert.ok(prepareFullSuite > cleanClientDist); + assert.ok(assertSharedBuilt > prepareFullSuite); + assert.ok(assertClientBuilt > prepareFullSuite); + assert.ok(runFullSuite > assertClientBuilt); + }); + test('selects supported test files deterministically and excludes live E2E', () => { assert.deepEqual(selectTestFiles([ '/repo/test/z.test.ts', diff --git a/test/windowsStandardUserConnectHarness.test.ts b/test/windowsStandardUserConnectHarness.test.ts new file mode 100644 index 000000000..856705bde --- /dev/null +++ b/test/windowsStandardUserConnectHarness.test.ts @@ -0,0 +1,579 @@ +import assert from 'node:assert/strict'; +import { readFileSync, readdirSync } from 'node:fs'; +import { resolve } from 'node:path'; +import { runInNewContext } from 'node:vm'; +import { test } from 'node:test'; +import { + parseWindowsNativeProbeOutput, + WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS, + WINDOWS_INSPECTION_TIMEOUT_MS, + WINDOWS_NATIVE_TIMING_PROBE_TIMEOUT_MS, + windowsInspectionTimeoutForElapsed, + WindowsNativeStageError, + windowsNativeTimingBucket, +} from '../packages/cli/src/connectWindowsAuthority.js'; + +const harness = readFileSync('scripts/verify-windows-standard-user-connect.mjs', 'utf8'); +const processMock = readFileSync('test/fixtures/windowsConnectProcessMock.mjs', 'utf8'); +const windowsAuthority = readFileSync('packages/cli/src/connectWindowsAuthority.ts', 'utf8'); + +function diagnosticDefinitions(): { + scenarioAllowlist: string[]; + assertionStageAllowlist: string[]; + statusKindAllowlist: string[]; + reasonCodeAllowlist: string[]; + nativeStageAllowlist: string[]; + probeMilestoneAllowlist: string[]; + probeTimingAllowlist: string[]; + createFailureDiagnostic: ( + scenario: string, + stage: string, + failureStatus: { status?: unknown; reasonCodes?: unknown } | null, + nativeStage: string | null, + probe: { milestone: string | null; timing: string | null }, + ) => Record; +} { + const start = harness.indexOf('const scenarioAllowlist ='); + const end = harness.indexOf('const cases = [', start); + assert.notEqual(start, -1); + assert.notEqual(end, -1); + return runInNewContext(`${harness.slice(start, end)}\n({ + scenarioAllowlist, + assertionStageAllowlist, + statusKindAllowlist, + reasonCodeAllowlist, + nativeStageAllowlist, + probeMilestoneAllowlist, + probeTimingAllowlist, + createFailureDiagnostic, + })`) as ReturnType; +} + +type FixtureScenario = { name: string; enabled: boolean; authorityMode?: string }; +type SystemRootMode = 'missing' | 'mismatched' | 'untrusted' | undefined; + +function tunnelFixtureEnvLines(scenario: FixtureScenario): string[] { + const start = harness.indexOf('function tunnelFixtureEnvLines('); + const end = harness.indexOf('\n\nconst scenarioAllowlist =', start); + assert.notEqual(start, -1); + assert.notEqual(end, -1); + const definitions = runInNewContext(`${harness.slice(start, end)}\n({ tunnelFixtureEnvLines })`) as { + tunnelFixtureEnvLines: (value: FixtureScenario) => string[]; + }; + return [...definitions.tunnelFixtureEnvLines(scenario)]; +} + +function windowsRootEnvironment(systemRootMode: SystemRootMode): Record { + const start = harness.indexOf('function windowsRootEnvironment('); + const end = harness.indexOf('\n\nconst scenarioAllowlist =', start); + assert.notEqual(start, -1); + assert.notEqual(end, -1); + const definitions = runInNewContext(`${harness.slice(start, end)}\n({ windowsRootEnvironment })`) as { + windowsRootEnvironment: ( + mode: SystemRootMode, + systemRoot: string, + windir: string, + untrustedRoot: string, + ) => Record; + }; + return { ...definitions.windowsRootEnvironment( + systemRootMode, + 'C:\\canonical-system-root', + 'C:\\canonical-windir', + 'D:\\untrusted-fixture', + ) }; +} + +function missingWindowsRootFixtureEnvironment(systemRootMode: SystemRootMode): Record { + const start = harness.indexOf('const WINDOWS_ROOT_MISSING_MARKER ='); + const end = harness.indexOf('\n\nconst scenarioAllowlist =', start); + assert.notEqual(start, -1); + assert.notEqual(end, -1); + const definitions = runInNewContext(`${harness.slice(start, end)}\n({ missingWindowsRootFixtureEnvironment })`) as { + missingWindowsRootFixtureEnvironment: (mode: SystemRootMode) => Record; + }; + return { ...definitions.missingWindowsRootFixtureEnvironment(systemRootMode) }; +} + +function untrustedWindowsRootFixtureEnvironment(systemRootMode: SystemRootMode): Record { + const start = harness.indexOf('const WINDOWS_ROOT_MISSING_MARKER ='); + const end = harness.indexOf('\n\nconst scenarioAllowlist =', start); + assert.notEqual(start, -1); + assert.notEqual(end, -1); + const definitions = runInNewContext(`${harness.slice(start, end)}\n({ untrustedWindowsRootFixtureEnvironment })`) as { + untrustedWindowsRootFixtureEnvironment: ( + mode: SystemRootMode, + root: string, + ) => Record; + }; + return { ...definitions.untrustedWindowsRootFixtureEnvironment(systemRootMode, '/fixture-root') }; +} + +function consumeWindowsRootFixtureEnvironment( + environment: Record, + fixtureRoot = '/fixture-root', +): Record { + const start = processMock.indexOf('const WINDOWS_ROOT_MISSING_MARKER ='); + const end = processMock.indexOf('\n\nconst originalSpawnSync =', start); + assert.notEqual(start, -1); + assert.notEqual(end, -1); + const context = { process: { env: { ...environment }, cwd: () => fixtureRoot }, resolve }; + return runInNewContext( + `${processMock.slice(start, end)}\nprocess.env`, + context, + ) as Record; +} + +function fixtureScenarios(): FixtureScenario[] { + const start = harness.indexOf('const cases = ['); + const end = harness.indexOf('\n];', start); + assert.notEqual(start, -1); + assert.notEqual(end, -1); + return runInNewContext(`${harness.slice(start, end + 3)}\ncases`) as FixtureScenario[]; +} + +test('the disabled Windows scenario omits its token while enabled scenarios retain the sentinel', () => { + const scenarios = fixtureScenarios(); + const disabled = scenarios.find((scenario) => scenario.name === 'disabled'); + assert.ok(disabled); + assert.equal(disabled.enabled, false); + assert.deepEqual(tunnelFixtureEnvLines(disabled), [ + 'PROPR_UI_TUNNEL_ENABLED=false', + ]); + for (const scenario of scenarios.filter(({ name }) => name !== 'disabled')) { + assert.equal(scenario.enabled, true, scenario.name); + assert.deepEqual(tunnelFixtureEnvLines(scenario), [ + 'PROPR_UI_TUNNEL_ENABLED=true', + 'PROPR_UI_TUNNEL_TOKEN=root-token-SENTINEL', + ], scenario.name); + } +}); + +test('the Windows authority fixtures isolate pre-import root injection markers', () => { + const missing = windowsRootEnvironment('missing'); + assert.deepEqual(missing, {}); + assert.equal(Object.hasOwn(missing, 'SYSTEMROOT'), false); + assert.equal(Object.hasOwn(missing, 'WINDIR'), false); + assert.deepEqual(windowsRootEnvironment('mismatched'), { + SYSTEMROOT: 'C:\\canonical-system-root', + WINDIR: 'D:\\untrusted-fixture', + }); + assert.deepEqual(windowsRootEnvironment('untrusted'), { + SYSTEMROOT: 'C:\\canonical-system-root', + WINDIR: 'C:\\canonical-windir', + }); + assert.deepEqual(windowsRootEnvironment(undefined), { + SYSTEMROOT: 'C:\\canonical-system-root', + WINDIR: 'C:\\canonical-windir', + }); + assert.match( + harness, + /\.\.\.windowsRootEnvironment\(\s*scenario\.systemRootMode,\s*process\.env\.SystemRoot,\s*process\.env\.WINDIR,\s*fixture,\s*\),/, + ); + assert.deepEqual(missingWindowsRootFixtureEnvironment('missing'), { + PROPR_TEST_WINDOWS_ROOT_MISSING: 'windows-root-missing-v1', + }); + for (const mode of ['mismatched', 'untrusted', undefined] as const) { + assert.deepEqual(missingWindowsRootFixtureEnvironment(mode), {}, String(mode)); + } + assert.match( + harness, + /\.\.\.missingWindowsRootFixtureEnvironment\(scenario\.systemRootMode\),/, + ); + assert.deepEqual(untrustedWindowsRootFixtureEnvironment('untrusted'), { + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED: 'windows-root-untrusted-v1', + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED_PATH: '/fixture-root', + }); + for (const mode of ['missing', 'mismatched', undefined] as const) { + assert.deepEqual(untrustedWindowsRootFixtureEnvironment(mode), {}, String(mode)); + } + assert.match( + harness, + /\.\.\.untrustedWindowsRootFixtureEnvironment\(scenario\.systemRootMode, fixture\),/, + ); + + const consumed = consumeWindowsRootFixtureEnvironment({ + PROPR_TEST_WINDOWS_ROOT_MISSING: 'windows-root-missing-v1', + SystemRoot: 'C:\\Windows', + SYSTEMROOT: 'D:\\Windows', + windir: 'C:\\Windows', + WiNdIr: 'D:\\Windows', + SAFE_FIXTURE_VALUE: 'retained', + }); + assert.deepEqual({ ...consumed }, { SAFE_FIXTURE_VALUE: 'retained' }); + + for (const mode of ['mismatched', 'untrusted', undefined] as const) { + const untouched = windowsRootEnvironment(mode); + assert.deepEqual( + { ...consumeWindowsRootFixtureEnvironment(untouched) }, + untouched, + String(mode), + ); + } + for (const untouchedMarker of [ + { + PROPR_TEST_WINDOWS_ROOT_MISSING: 'not-the-fixed-marker', + SYSTEMROOT: 'C:\\Windows', + WINDIR: 'D:\\untrusted-fixture', + }, + { + propr_test_windows_root_missing: 'windows-root-missing-v1', + SYSTEMROOT: 'D:\\untrusted-fixture', + WINDIR: 'D:\\untrusted-fixture', + }, + ]) { + assert.deepEqual( + { ...consumeWindowsRootFixtureEnvironment(untouchedMarker) }, + untouchedMarker, + ); + } + + const untrusted = consumeWindowsRootFixtureEnvironment({ + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED: 'windows-root-untrusted-v1', + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED_PATH: '/fixture-root', + SystemRoot: 'C:\\Windows', + SYSTEMROOT: 'D:\\Windows', + systemroot: 'E:\\Windows', + windir: 'C:\\Windows', + WiNdIr: 'D:\\Windows', + SAFE_FIXTURE_VALUE: 'retained', + }); + assert.deepEqual({ ...untrusted }, { + SAFE_FIXTURE_VALUE: 'retained', + SystemRoot: '/fixture-root', + WINDIR: '/fixture-root', + }); + assert.equal(Object.hasOwn(untrusted, 'PROPR_TEST_WINDOWS_ROOT_UNTRUSTED'), false); + assert.equal(Object.hasOwn(untrusted, 'PROPR_TEST_WINDOWS_ROOT_UNTRUSTED_PATH'), false); + + for (const untouchedMarker of [ + { + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED: 'not-the-fixed-marker', + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED_PATH: '/fixture-root', + SystemRoot: 'C:\\Windows', + WINDIR: 'C:\\Windows', + }, + { + propr_test_windows_root_untrusted: 'windows-root-untrusted-v1', + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED_PATH: '/fixture-root', + SystemRoot: 'C:\\Windows', + WINDIR: 'C:\\Windows', + }, + { + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED: 'windows-root-untrusted-v1', + SystemRoot: 'C:\\Windows', + WINDIR: 'C:\\Windows', + }, + { + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED: 'windows-root-untrusted-v1', + propr_test_windows_root_untrusted_path: '/fixture-root', + SystemRoot: 'C:\\Windows', + WINDIR: 'C:\\Windows', + }, + { + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED: 'windows-root-untrusted-v1', + PROPR_TEST_WINDOWS_ROOT_UNTRUSTED_PATH: '/outside-fixture', + SystemRoot: 'C:\\Windows', + WINDIR: 'C:\\Windows', + }, + ]) { + assert.deepEqual( + { ...consumeWindowsRootFixtureEnvironment(untouchedMarker) }, + untouchedMarker, + ); + } + + const missingFixtureConsumer = processMock.indexOf('consumeMissingWindowsRootFixtureMarker();'); + const untrustedFixtureConsumer = processMock.indexOf('consumeUntrustedWindowsRootFixtureMarker();'); + const fixtureMockInstall = processMock.indexOf('const originalSpawnSync ='); + const processFixtureImport = harness.indexOf('"--import", processFixture'); + const fetchFixtureImport = harness.indexOf('"--import", fetchFixture'); + assert.ok(missingFixtureConsumer !== -1 && missingFixtureConsumer < fixtureMockInstall); + assert.ok(untrustedFixtureConsumer !== -1 && untrustedFixtureConsumer < fixtureMockInstall); + assert.ok(processFixtureImport !== -1 && processFixtureImport < fetchFixtureImport); + assert.match(harness, /spawnSync\(process\.execPath, \[\s*\.\.\.fixtureNodeArgs,\s*cli,/); + + const productionSource = readdirSync('packages/cli/src', { recursive: true }) + .filter((entry): entry is string => typeof entry === 'string' && entry.endsWith('.ts')) + .map((entry) => readFileSync(`packages/cli/src/${entry}`, 'utf8')) + .join('\n'); + assert.doesNotMatch( + productionSource, + /PROPR_TEST_WINDOWS_ROOT_(?:MISSING|UNTRUSTED)|windows-root-(?:missing|untrusted)-v1/, + ); + + assert.match(harness, /const configDirectory = join\(fixture, "config"\);/); + assert.equal(harness.match(/new ConfigManager\(/g)?.length, 1); + assert.doesNotMatch(harness, /userInfo\(\)\.homedir|(?:writeFileSync|new ConfigManager)\([^\n]*(?:USERPROFILE|\.propr)/); +}); + +test('the ordinary-user Windows proof retains native security paths and bounds result-matrix reuse', () => { + assert.match(harness, /await scaffoldStack\(/); + assert.match(harness, /await manager\.save\(\)/); + assert.match(harness, /public-instance-identity\.json/); + assert.match(harness, /config\.json/); + const scenarios = fixtureScenarios(); + const ready = scenarios.find((scenario) => scenario.name === 'ready'); + assert.ok(ready); + assert.equal(ready.authorityMode, undefined); + for (const scenario of scenarios.filter(({ name }) => name !== 'ready')) { + assert.equal(scenario.authorityMode, 'valid-authority', scenario.name); + } + assert.match( + processMock, + /if \(mode === "valid-authority"\) return result\(0, authorityDocument\(args, options, mode\)\);/, + ); + assert.match(harness, /\{ name: "path-aba", mode: "path-aba", reason: "INVALID_ROOT" \}/); + assert.match(harness, /\{ name: "authority-missing-system-root", systemRootMode: "missing", nativeStage: "resolver:env" \}/); + assert.match(harness, /\{ name: "authority-untrusted-system-root", systemRootMode: "untrusted", nativeStage: "resolver:global-id" \}/); +}); + +test('the ordinary-user Windows diagnostic has fixed allowlists and redacts all other values', () => { + const definitions = diagnosticDefinitions(); + assert.deepEqual([...definitions.scenarioAllowlist], [ + 'ready', 'down', 'disabled', 'restart-required', 'malformed', 'oversized', 'timeout', + 'identity-mismatch', 'secret-sentinel', 'api', 'path-aba', 'authority-malformed', 'authority-oversized', + 'authority-extra-key', 'authority-duplicate', 'authority-entry-count', 'authority-entry-shape', + 'authority-stderr', 'authority-nonzero', + 'authority-timeout', 'authority-descriptor-mismatch', 'authority-index-mismatch', + 'authority-kind-mismatch', 'authority-authority-kind-mismatch', 'authority-identity-mismatch', + 'authority-sid-mismatch', 'authority-broad-write', 'authority-inherited-write', + 'authority-unprotected', 'authority-owner-mismatch', 'authority-reparse', + 'authority-missing-system-root', 'authority-mismatched-system-root', 'authority-untrusted-system-root', + ]); + assert.deepEqual([...definitions.assertionStageAllowlist], [ + 'native-timing', 'authority-probe', 'scaffold', 'identity-assertion', 'config-init', 'config-save', + 'config-assertion', + 'write-env', 'spawn', 'signal', 'exit', 'bounds', 'schema', 'status', 'endpoint', + 'identity', 'reasons', 'api-ready', 'restart', 'stderr', 'sentinel', 'api-spawn', + 'api-exit', 'api-count', + ]); + assert.deepEqual([...definitions.statusKindAllowlist], [ + 'ready', 'internalFailure', 'notReady', 'incompatible', 'invalidConfig', 'timeout', + ]); + assert.deepEqual([...definitions.reasonCodeAllowlist], [ + 'NOT_CONFIGURED', 'TUNNEL_DISABLED', 'SIDECAR_NOT_RUNNING', 'API_UNREACHABLE', 'API_TIMEOUT', + 'DISCOVERY_UNSUPPORTED', 'DISCOVERY_INVALID', 'DISCOVERY_TOO_LARGE', 'API_INCOMPATIBLE', + 'DESKTOP_AUTHENTICATION_UNSUPPORTED', + 'IDENTITY_MISMATCH', 'ENDPOINT_MISMATCH', 'RESTART_REQUIRED', 'INVALID_ROOT', 'INVALID_ENDPOINT', + 'IDENTITY_UNAVAILABLE', 'INTERNAL_FAILURE', 'ACL_DIAGNOSTIC_UNAVAILABLE', + ]); + assert.deepEqual([...definitions.nativeStageAllowlist], [ + 'resolver:env', 'resolver:canonical', 'resolver:global-open', 'resolver:global-id', + 'spawn:create', 'spawn:error', 'spawn:timeout', 'spawn:cumulative-timeout', 'spawn:status', 'spawn:stderr', + 'probe:entry', 'probe:baseline', 'probe:reflection-emit', 'probe:win32', 'probe:standard-handle', 'probe:output', + 'broker:ps-version', 'broker:job', 'broker:fd', 'broker:fd-duplicate', 'broker:index-info-initial', + 'broker:security-info', 'broker:acl', 'broker:json', 'broker:current-user-sid', + 'broker:index-info-revalidation', 'broker:index-info-decode', 'broker:index-info-compose', 'broker:entry-format', + 'broker:entry-flags', 'broker:entry-rules', 'broker:entry-build', + 'parent:utf8', 'parent:json-parse', 'parent:json-canonical', 'parent:document-shape', + 'parent:entry-count', 'parent:entry-shape', 'parent:json-shape', 'parent:descriptor-bind', 'parent:post-bind', + ]); + assert.deepEqual([...definitions.probeMilestoneAllowlist], [ + 'none', 'entry-ps51-desktop-x64', 'constant-json', 'reflection-emit', 'harmless-win32', + 'standard-handle-identity', + ]); + assert.deepEqual([...definitions.probeTimingAllowlist], [ + 'under-5s', '5-to-15s', '15-to-30s', '30-to-45s', '45-to-60s', 'at-least-60s', + ]); + const assignedStages = [...harness.matchAll(/currentStage = "([^"]+)";/g)] + .map((match) => match[1]); + assert.deepEqual(new Set(assignedStages), new Set(definitions.assertionStageAllowlist)); + + const diagnostic = definitions.createFailureDiagnostic('ready', 'stderr', { + status: 'ready', + reasonCodes: ['ACL_DIAGNOSTIC_UNAVAILABLE'], + path: 'private-path-SENTINEL', + argv: 'argv-SENTINEL', + stdout: 'raw-stdout-SENTINEL', + stderr: 'raw-stderr-SENTINEL', + message: 'assertion-message-SENTINEL', + environment: 'environment-SENTINEL', + config: 'config-SENTINEL', + identity: 'identity-SENTINEL', + endpoint: 'endpoint-SENTINEL', + secret: 'secret-SENTINEL', + } as { status: string; reasonCodes: string[] }, 'broker:fd', { + milestone: 'standard-handle-identity', timing: '15-to-30s', + }); + assert.deepEqual(Object.keys(diagnostic), [ + 'scenario', 'stage', 'nativeStage', 'status', 'reasonCodes', + 'probeMilestone', 'probeTiming', + ]); + assert.deepEqual(JSON.parse(JSON.stringify(diagnostic)), { + scenario: 'ready', + stage: 'stderr', + nativeStage: 'broker:fd', + status: 'ready', + reasonCodes: ['ACL_DIAGNOSTIC_UNAVAILABLE'], + probeMilestone: 'standard-handle-identity', + probeTiming: '15-to-30s', + }); + assert.equal(JSON.stringify(diagnostic).includes('SENTINEL'), false); + + assert.deepEqual(JSON.parse(JSON.stringify(definitions.createFailureDiagnostic( + 'ready', 'native-timing', null, 'spawn:timeout', + { milestone: 'reflection-emit', timing: 'at-least-60s' }, + ))), { + scenario: 'ready', + stage: 'native-timing', + nativeStage: 'spawn:timeout', + status: null, + reasonCodes: [], + probeMilestone: 'reflection-emit', + probeTiming: 'at-least-60s', + }); + + const rejected = definitions.createFailureDiagnostic( + 'private-scenario-SENTINEL', + 'raw-output-SENTINEL', + { status: 'secret-status-SENTINEL', reasonCodes: ['secret-reason-SENTINEL'] }, + 'raw-native-stage-SENTINEL', + { milestone: 'secret-SENTINEL', timing: '12345ms-SENTINEL' }, + ); + assert.deepEqual(JSON.parse(JSON.stringify(rejected)), { + scenario: 'ready', + stage: 'write-env', + nativeStage: null, + status: null, + reasonCodes: [], + probeMilestone: null, + probeTiming: null, + }); + + const catchStart = harness.lastIndexOf('} catch {'); + const catchEnd = harness.indexOf('} finally {', catchStart); + const catchBody = harness.slice(catchStart, catchEnd); + assert.match(catchBody, /createFailureDiagnostic\(\s*currentScenario, currentStage, failureStatus, currentNativeStage, nativeProbe,/); + assert.match(catchBody, /JSON\.stringify\(\s*diagnostic,\s*\)/); + assert.doesNotMatch(catchBody, /(?:result|api|error)\.(?:stdout|stderr|message|path|argv|env|config)/i); +}); + +test('the staged hosted probe and production inspector both use the inherited standard handle', () => { + assert.doesNotMatch(windowsAuthority, /_get_osfhandle|AssignProcessToJobObject|CreateJobObject/); + assert.match(harness, /runWindowsNativeTimingProbe\(probeFd\)/); + assert.match(harness, /openSync\(\s*fixture,\s*constants\.O_RDONLY \| constants\.O_DIRECTORY \| constants\.O_NOFOLLOW,\s*\)/); + assert.match(harness, /native-timing=\$\{nativeProbe\.evidence\}/); + assert.match(harness, /;total:\$\{nativeProbe\.timing\}/); + assert.match(harness, /ready=standard-handle-passed/); + + const productionSourceStart = windowsAuthority.indexOf('export const WINDOWS_INSPECTION_SOURCE'); + const productionSourceEnd = windowsAuthority.indexOf('export const WINDOWS_NATIVE_PROBE_MILESTONES', productionSourceStart); + const productionSource = windowsAuthority.slice(productionSourceStart, productionSourceEnd); + assert.match(productionSource, /GetStdHandle\(-10\)/); + assert.doesNotMatch(productionSource, /_get_osfhandle|AssignProcessToJobObject|CreateJobObject|Start-Process|CreateProcess/); + assert.match(windowsAuthority, /stdio: \[stdin, "pipe", "pipe"\]/); + assert.match(windowsAuthority, /WINDOWS_INSPECTOR_CREATES_CHILD_PROCESSES = false/); + assert.match(windowsAuthority, /WINDOWS_INSPECTOR_WRITES_FILESYSTEM = false/); +}); + +test('the production inspector duplicates its standard handle before the split native operations', () => { + const productionSourceStart = windowsAuthority.indexOf('export const WINDOWS_INSPECTION_SOURCE'); + const productionSourceEnd = windowsAuthority.indexOf('export const WINDOWS_NATIVE_PROBE_MILESTONES', productionSourceStart); + const productionSource = windowsAuthority.slice(productionSourceStart, productionSourceEnd); + assert.match(productionSource, /\$stage=80\s+if\(-not \[ProprReadOnlyAuthority\]::DuplicateHandle\(\s*\[ProprReadOnlyAuthority\]::GetCurrentProcess\(\),\$originalHandle,\s*\[ProprReadOnlyAuthority\]::GetCurrentProcess\(\),\[ref\]\$privateHandle,0,\$false,2\)\)\{exit \$stage\}/); + assert.match(productionSource, /\$stage=74\s+\$before=\[Runtime\.InteropServices\.Marshal\]::AllocHGlobal\(52\)\s+if\(-not \[ProprReadOnlyAuthority\]::GetFileInformationByHandle\(\$privateHandle,\$before\)\)\{exit \$stage\}/); + assert.match(productionSource, /\$stage=78\s+\$current=\[Security\.Principal\.WindowsIdentity\]::GetCurrent\(\)\.User\s+if\(\$null-eq \$current\)\{exit \$stage\}\s+\$currentSid=\$current\.Value/); + assert.match(productionSource, /GetSecurityInfo\(\$privateHandle,1,5,\[ref\]\$owner,\[ref\]\$group,\[ref\]\$dacl,\[ref\]\$sacl,\[ref\]\$descriptor\)/); + assert.match(productionSource, /\$stage=79\s+\$after=\[Runtime\.InteropServices\.Marshal\]::AllocHGlobal\(52\)\s+if\(-not \[ProprReadOnlyAuthority\]::GetFileInformationByHandle\(\$privateHandle,\$after\)\)\{exit \$stage\}/); + assert.equal(productionSource.match(/::CloseHandle\(\$privateHandle\)/g)?.length, 1); + assert.match(productionSource, /finally \{if\(\$privateHandleOwned\)\{\$null=\[ProprReadOnlyAuthority\]::CloseHandle\(\$privateHandle\)\}\}/); + assert.doesNotMatch(productionSource, /CloseHandle\(\$originalHandle\)/); + assert.doesNotMatch(windowsAuthority, /"broker:index-info"/); + assert.match(windowsAuthority, /74: "broker:index-info-initial"/); + assert.match(windowsAuthority, /78: "broker:current-user-sid", 79: "broker:index-info-revalidation", 80: "broker:fd-duplicate"/); +}); + +test('the staged probe accepts only ordered milestone tokens and coarse timing buckets', () => { + const prefix = [ + 'PROPR_NATIVE_PROBE_V1|entry-ps51-desktop-x64|under-5s', + 'PROPR_NATIVE_PROBE_V1|constant-json|5-to-15s', + 'PROPR_NATIVE_PROBE_V1|reflection-emit|15-to-30s', + '', + ].join('\r\n'); + assert.deepEqual(parseWindowsNativeProbeOutput(prefix).map(({ milestone }) => milestone), [ + 'entry-ps51-desktop-x64', 'constant-json', 'reflection-emit', + ]); + assert.deepEqual([4_999, 5_000, 15_000, 30_000, 45_000, 60_000].map(windowsNativeTimingBucket), [ + 'under-5s', '5-to-15s', '15-to-30s', '30-to-45s', '45-to-60s', 'at-least-60s', + ]); + assert.throws( + () => parseWindowsNativeProbeOutput('private-path-SENTINEL raw-exception-SENTINEL\r\n'), + (error) => error instanceof WindowsNativeStageError + && error.stage === 'probe:output' + && !error.message.includes('SENTINEL'), + ); + assert.match(windowsAuthority, /\$baseline='\{"version":1,"baseline":"constant"\}'/); + assert.match(windowsAuthority, /DefineDynamicAssembly/); + assert.match(windowsAuthority, /GetCurrentProcessId/); + assert.match(windowsAuthority, /GetStdHandle\(-10\)/); + assert.match(windowsAuthority, /GetFileInformationByHandle/); +}); + +test('the diagnostic allowance precedes a cumulatively bounded production standard-handle proof', () => { + assert.equal(WINDOWS_NATIVE_TIMING_PROBE_TIMEOUT_MS, 60_000); + assert.equal(WINDOWS_INSPECTION_TIMEOUT_MS, 60_000); + assert.equal(WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS, 240_000); + assert.match( + windowsAuthority, + /export const WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS = 240_000;/, + ); + assert.match(harness, /const WINDOWS_PRODUCT_AUTHORITY_PHASE_COUNT = 2;/); + assert.match(harness, /const WINDOWS_PRODUCT_SCENARIO_OVERHEAD_MS = 15_000;/); + assert.match( + harness, + /const WINDOWS_PRODUCT_SCENARIO_TIMEOUT_MS = \(\s*WINDOWS_PRODUCT_AUTHORITY_PHASE_COUNT\s*\* nativeAuthority\.WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS\s*\) \+ WINDOWS_PRODUCT_SCENARIO_OVERHEAD_MS;/, + ); + const windowsProductScenarioTimeoutMs = ( + 2 * WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS + ) + 15_000; + assert.equal(windowsProductScenarioTimeoutMs, 495_000); + assert.equal(Number.isFinite(windowsProductScenarioTimeoutMs), true); + assert.equal(Number.isSafeInteger(windowsProductScenarioTimeoutMs), true); + assert.equal(WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS, 4 * WINDOWS_INSPECTION_TIMEOUT_MS); + assert.notEqual( + WINDOWS_INSPECTION_CUMULATIVE_TIMEOUT_MS / WINDOWS_INSPECTION_TIMEOUT_MS, + 32, + ); + assert.equal(windowsInspectionTimeoutForElapsed(0), 60_000); + assert.equal(windowsInspectionTimeoutForElapsed(60_000), 60_000); + assert.equal(windowsInspectionTimeoutForElapsed(120_000), 60_000); + assert.equal(windowsInspectionTimeoutForElapsed(180_000), 60_000); + assert.equal(windowsInspectionTimeoutForElapsed(180_001), 59_999); + assert.equal(windowsInspectionTimeoutForElapsed(210_000), 30_000); + assert.equal(windowsInspectionTimeoutForElapsed(225_000), 15_000); + assert.equal(windowsInspectionTimeoutForElapsed(239_999.9), 1); + assert.throws( + () => windowsInspectionTimeoutForElapsed(240_000), + (error) => error instanceof WindowsNativeStageError && error.stage === 'spawn:cumulative-timeout', + ); + assert.throws( + () => windowsInspectionTimeoutForElapsed(240_001), + (error) => error instanceof WindowsNativeStageError && error.stage === 'spawn:cumulative-timeout', + ); + const probeCall = harness.indexOf('runWindowsNativeTimingProbe(probeFd)'); + const productionMatrix = harness.indexOf('for (const scenario of cases)', probeCall); + const productionSpawn = harness.indexOf('const result = spawnSync(process.execPath', productionMatrix); + assert.ok(probeCall < productionMatrix && productionMatrix < productionSpawn); + const probeStart = windowsAuthority.indexOf('export function runWindowsNativeTimingProbe'); + const probeEnd = windowsAuthority.indexOf('\n}\n\nexport function windowsInspectionEntryKind', probeStart); + const probe = windowsAuthority.slice(probeStart, probeEnd); + assert.match(probe, /const executable = resolveWindowsPowerShell\(\);/); + assert.doesNotMatch(probe, /catch\s*\{/); + assert.doesNotMatch(harness, /extraStdio|alreadyContained|nestedJob|runWindowsHostedAssumptionProbe/); +}); + +test('the hostile path ABA remains replaced through validation and is rejected as INVALID_ROOT', () => { + assert.match(harness, /\{ name: "path-aba", mode: "path-aba", reason: "INVALID_ROOT" \}/); + assert.doesNotMatch(harness, /name: "path-aba"[^\n]+status: "ready"/); + assert.match(processMock, /attacker-replacement-SENTINEL/); + assert.match(processMock, /process\.once\("exit", \(\) => \{/); + const replacement = processMock.indexOf('writeFileSync(envPath'); + const exitHook = processMock.indexOf('process.once("exit"', replacement); + const spawn = processMock.indexOf('return originalSpawnSync(command, args, options);', replacement); + const restore = processMock.indexOf('renameSync(detached, envPath);', replacement); + assert.ok( + replacement < exitHook && exitHook < restore && restore < spawn, + 'restoration must be registered only for process exit before the CLI resumes', + ); +});