@phala/dstack-verifier-wasm 0.0.0-stage → 0.1.0-beta.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,181 @@
-# Temporary Holding Version
+# @phala/dstack-verifier-wasm
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This package checks a dstack 0.6.x Intel TDX CVM's OS locally. Given MRTD and
+RTMR0-2 from a quote you already verified, plus the guest's `event_log` and
+`vm_config`, it checks `vm_config.tdx_measurement` against `os_image_hash`,
+regenerates the three RTMR0 ACPI digests from the declared VM shape, recomputes
+MRTD/RTMR0-2, and compares them with the quote.
+
+It does **not** verify the DCAP quote, apply TCB policy, bind `report_data` /
+a nonce, replay RTMR3 (app/compose), or decide whether `osImageHash` is an
+approved OS release. Those are the caller's job. `ok: true` means only that
+the lite OS check passed. It does not mean the CVM is trusted.
+
+## Scope
+
+dstack 0.6.x Intel TDX CVMs whose `vm_config.tdx_attestation_variant` is
+`lite`. The legacy TDX variant (full image download) and other platforms
+(AMD SEV-SNP, GCP TDX, AWS Nitro) are out of scope.
+
+A non-lite `vm_config` returns `ok: false` with reason
+`vm_config is not a TDX lite attestation` (the default variant is `legacy`).
+Lite without `tdx_measurement` returns
+`tdx lite attestation requires vm_config.tdx_measurement`.
+
+## Install
+
+```bash
+npm install @phala/dstack-verifier-wasm@0.1.0-beta.0
+```
+
+Requires Node `>=20.19.0`. The wasm bytes are embedded in the JS module: no
+separate `.wasm` file, no wasm imports.
+
+## Quick start
+
+Inside the CVM, `GetQuote` returns the quote, event log, and vm_config.
+`report_data` is at most 64 bytes (hex in JSON; shorter values are zero-padded).
+
+```bash
+curl --unix-socket /var/run/dstack.sock -X POST \
+  http://dstack/GetQuote \
+  -H 'Content-Type: application/json' \
+  -d '{"report_data": "<64-byte nonce as hex>"}'
+```
+
+Response fields: `quote` (hex), `event_log` (JSON array as a string),
+`report_data` (hex), `vm_config` (JSON object as a string). The JS SDK's
+frozen v0 client is the same RPC: `DstackClientV0.getQuote(reportData)`.
+v1 `DstackClient` has no `GetQuote`; it uses `attest()`.
+
+Verify the quote with a DCAP library, then pass MRs from the **verified**
+report into this package:
+
+```js
+import { getCollateralAndVerify } from '@phala/dcap-qvl'
+import { verifyTdxLiteOs } from '@phala/dstack-verifier-wasm'
+
+const quoteBytes = Buffer.from(getQuote.quote, 'hex')
+const verified = await getCollateralAndVerify(quoteBytes)
+// Caller applies TCB policy (verified.status, verified.advisory_ids)
+// and checks verified.report's reportData against the nonce.
+
+const td = verified.report.asTd10()
+  ?? verified.report.asTd15()?.base
+  ?? null
+if (!td) {
+  throw new Error('quote is not a TDX report')
+}
+
+const hex = (bytes) => Buffer.from(bytes).toString('hex')
+const result = verifyTdxLiteOs({
+  mrtd: hex(td.mrTd),
+  rtmr0: hex(td.rtMr0),
+  rtmr1: hex(td.rtMr1),
+  rtmr2: hex(td.rtMr2),
+  eventLog: getQuote.event_log,
+  vmConfig: getQuote.vm_config,
+})
+if (!result.ok) {
+  throw new Error(result.reason)
+}
+if (!approvedOsImageHashes.has(result.osImageHash)) {
+  throw new Error(`unapproved OS ${result.osImageHash}`)
+}
+// Still replay RTMR3 (app/compose) yourself.
+```
+
+`getCollateralAndVerify` / `VerifiedReport.report.asTd10` are the public
+`@phala/dcap-qvl` 0.7.x API. A different DCAP library is fine as long as MRs
+come from a quote whose signature and collateral you verified.
+
+## API
+
+```ts
+verifyTdxLiteOs(input: {
+  mrtd: string
+  rtmr0: string
+  rtmr1: string
+  rtmr2: string
+  eventLog: string
+  vmConfig: string
+}): {
+  ok: boolean
+  osImageHash: string | null
+  reason: string | null
+}
+```
+
+MRs are hex, any case, optional `0x` prefix, 48 bytes after decoding.
+`eventLog` and `vmConfig` are the GetQuote `event_log` / `vm_config` strings
+verbatim.
+
+The call is synchronous. It never throws: bad input and wasm traps return
+`{ ok: false, reason }`. A trap recreates the wasm instance before returning.
+The module compiles on first import; the first `verifyTdxLiteOs` call is
+typically a few milliseconds, later calls about 1 ms.
+
+## Result reasons
+
+`reason` is an anyhow chain (`outer: inner`). The main classes:
+
+| `reason` contains | Meaning |
+| --- | --- |
+| `vm_config is not a TDX lite attestation` | `tdx_attestation_variant` is not `lite` (legacy, other platforms, missing field). |
+| `tdx lite attestation requires vm_config.tdx_measurement` | Lite without measurement material. |
+| `tdx lite measurement material does not match os_image_hash` | Attached CBOR does not commit to `os_image_hash`. |
+| `TDX lite acpi-loader\|acpi-rsdp\|acpi-tables digest mismatch` | Regenerated ACPI digest disagrees with the named RTMR0 event. |
+| `failed to recompute expected TDX lite ACPI table digests` | VM shape the generator cannot model (`swtpm`; QEMU older than 8.0). |
+| `MRs do not match: MRTD\|RTMR0\|RTMR1\|RTMR2 mismatch` | Recomputed register disagrees with the quote. |
+
+`osImageHash` is the hex OS identity only when `ok` is true. On any failure
+it is `null`, including when `vm_config` names a hash that did not verify.
+
+## Runtimes
+
+CI on this repo runs the same accept/tamper cases on Node 20.19.0, 22, 24,
+Bun 1.x, Electron 31 and current stable (main process, no renderer), and
+Chromium / Firefox / WebKit (page main thread and a module worker). The wasm
+module has zero imports.
+
+## Versioning
+
+The package version is independent of dstack's. Each release notes the dstack
+commit it was built from. Pin an **exact** version.
+
+Bump the package when dstack models new QEMU ACPI behaviour or VM topology, or
+when the measurement-material format changes. A new OS image only needs the
+caller to approve a new `osImageHash`; it does not require a new package
+version.
+
+## Verifying the build
+
+The published wasm is built in a digest-pinned `linux/amd64` container
+(`rust:1.92.0-bookworm@sha256:5c38a9e735664861e84ce6918e98ce7f05dbac210230d45381bcf870b2d58083`)
+so the host toolchain binaries (LLVM codegen and/or rust-lld) cannot affect
+it. Rebuild with `scripts/build-in-container.sh` on a **linux/amd64** host
+(native or an x86_64 VM) and compare the sha256 of the decoded wasm. They
+must match.
+
+Emulated amd64 on arm64 hosts is not verified: qemu-user crashes rustc 1.92.0.
+Docker on Apple Silicon is untested; do not assume it matches.
+
+```bash
+git clone https://github.com/Dstack-TEE/dstack
+cd dstack
+git checkout <tag-matching-the-package-version>
+bash sdk/verifier-wasm/scripts/build-in-container.sh
+python3 -c "import base64,hashlib,pathlib,re; t=pathlib.Path('sdk/verifier-wasm/src/wasm-bytes.js').read_text(); b=re.search(r\"wasmBase64 = '([^']+)'\", t).group(1); print(hashlib.sha256(base64.b64decode(b)).hexdigest())"
+```
+
+Unpack the published tarball (`npm pack @phala/dstack-verifier-wasm@<version>`)
+and hash its `package/src/wasm-bytes.js` the same way. Once CI publishes with
+provenance, check signatures:
+
+```bash
+npm audit signatures
+```
+
+`npm audit signatures` verifies [ECDSA registry signatures](https://docs.npmjs.com/about-ecdsa-registry-signatures).
+Provenance, when present, is also on the version page at npmjs.com
+(`dist.attestations` in `npm view @phala/dstack-verifier-wasm@<version>`).

package/package.json

@@ -1,6 +1,38 @@
 {
   "name": "@phala/dstack-verifier-wasm",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-beta.0",
+  "description": "Local TDX lite OS verification for dstack 0.6.x CVMs",
+  "type": "module",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "files": [
+    "src",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "bash scripts/build.sh",
+    "build:container": "bash scripts/build-in-container.sh",
+    "test": "node test/run-cases.mjs",
+    "test:node": "node --test test/verify.test.mjs"
+  },
+  "keywords": [
+    "dstack",
+    "tdx",
+    "attestation"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Dstack-TEE/dstack",
+    "directory": "sdk/verifier-wasm"
+  },
+  "license": "Apache-2.0"
+}

package/src/index.d.ts

@@ -0,0 +1,29 @@
+// SPDX-FileCopyrightText: © 2026 Phala Network <dstack@phala.network>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+export interface VerifyTdxLiteOsInput {
+  mrtd: string
+  rtmr0: string
+  rtmr1: string
+  rtmr2: string
+  eventLog: string
+  vmConfig: string
+}
+
+export interface VerifyTdxLiteOsResult {
+  ok: boolean
+  osImageHash: string | null
+  reason: string | null
+}
+
+/**
+ * Verify a dstack TDX lite CVM's OS against already-verified MRTD/RTMR0-2.
+ *
+ * MRs are hex (any case). `eventLog` and `vmConfig` are the GetQuote
+ * `event_log` / `vm_config` strings verbatim. Does not judge os_image_hash
+ * approval, DCAP quote validity, or RTMR3.
+ *
+ * Never throws: bad input and wasm traps return `{ ok: false, ... }`.
+ */
+export function verifyTdxLiteOs(input: VerifyTdxLiteOsInput): VerifyTdxLiteOsResult

package/src/index.js

@@ -0,0 +1,94 @@
+// SPDX-FileCopyrightText: © 2026 Phala Network <dstack@phala.network>
+//
+// SPDX-License-Identifier: Apache-2.0
+
+import { wasmBase64 } from './wasm-bytes.js'
+
+const encoder = new TextEncoder()
+const decoder = new TextDecoder()
+
+function decodeBase64(value) {
+  if (typeof Buffer !== 'undefined') {
+    return Buffer.from(value, 'base64')
+  }
+  const binary = atob(value)
+  const bytes = new Uint8Array(binary.length)
+  for (let i = 0; i < binary.length; i += 1) {
+    bytes[i] = binary.charCodeAt(i)
+  }
+  return bytes
+}
+
+const wasmBytes = decodeBase64(wasmBase64)
+const wasmModule = new WebAssembly.Module(wasmBytes)
+
+let instance = null
+
+function instantiate() {
+  instance = new WebAssembly.Instance(wasmModule, {})
+  return instance
+}
+
+function getExports() {
+  if (instance === null) {
+    instantiate()
+  }
+  return instance.exports
+}
+
+function failed(reason) {
+  return {
+    ok: false,
+    osImageHash: null,
+    reason: reason == null ? 'verification failed' : String(reason),
+  }
+}
+
+function readOutput(exports, raw) {
+  const result = BigInt(raw)
+  const ptr = Number(result >> 32n)
+  const len = Number(result & 0xffffffffn)
+  const json = JSON.parse(decoder.decode(new Uint8Array(exports.memory.buffer, ptr, len)))
+  exports.dealloc(ptr, len)
+  return {
+    ok: Boolean(json.ok),
+    osImageHash: json.ok ? (json.os_image_hash ?? null) : null,
+    reason: json.reason ?? null,
+  }
+}
+
+function call(input) {
+  const payload = encoder.encode(
+    JSON.stringify({
+      mrtd: input.mrtd,
+      rtmr0: input.rtmr0,
+      rtmr1: input.rtmr1,
+      rtmr2: input.rtmr2,
+      event_log: input.eventLog,
+      vm_config: input.vmConfig,
+    }),
+  )
+  const exports = getExports()
+  const ptr = exports.alloc(payload.length)
+  new Uint8Array(exports.memory.buffer, ptr, payload.length).set(payload)
+  const raw = exports.verify_tdx_lite(ptr, payload.length)
+  exports.dealloc(ptr, payload.length)
+  return readOutput(exports, raw)
+}
+
+export function verifyTdxLiteOs(input) {
+  try {
+    if (input == null || typeof input !== 'object') {
+      return failed('input must be an object')
+    }
+    return call(input)
+  } catch (err) {
+    instance = null
+    try {
+      instantiate()
+    } catch (instantiateErr) {
+      return failed(instantiateErr && instantiateErr.message ? instantiateErr.message : instantiateErr)
+    }
+    return failed(err && err.message ? err.message : err)
+  }
+}