@did-btcr2/method 0.60.0 → 0.61.0

package/src/core/resolver.ts

@@ -20,6 +20,7 @@ import type {
   SignedBTCR2Update,
   UnsignedBTCR2Update
 } from './btcr2-update.js';
+import { BTCR2_UPDATE_CONTEXT, isBtcr2UpdateContext } from './btcr2-update.js';
 import {
   BIP340Cryptosuite,
   BIP340DataIntegrityProof,
@@ -608,7 +609,8 @@ export class Resolver {
   }
 
   /**
-   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#apply-update | 7.2.f.3 Apply Update}.
+   * Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#apply-update | 7.2.f.3 Apply Update}
+   * and its step {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#check-update-proof | Check update.proof}.
    * @param {DidDocument} currentDocument The current DID Document to apply the update to.
    * @param {SignedBTCR2Update} update The BTCR2 Signed Update to apply.
    * @returns {DidDocument} The updated DID Document after applying the update.
@@ -618,6 +620,24 @@ export class Resolver {
     currentDocument: DidDocument,
     update: SignedBTCR2Update
   ): DidDocument {
+    // Spec "Check update.proof": the update @context must be the array that the BTCR2
+    // Unsigned Update data structure pins, and the proof @context must equal it, member
+    // for member and in order. The array is inside the hashed and signed bytes, so an
+    // update with another array is a different update. The check runs before signature
+    // verification so that the failure names the array and not the signature.
+    if(!isBtcr2UpdateContext(update['@context'])) {
+      throw new ResolveError(
+        'Invalid update: @context is not the array the specification pins for a BTCR2 Update',
+        INVALID_DID_UPDATE, { context: update['@context'], expected: [ ...BTCR2_UPDATE_CONTEXT ] }
+      );
+    }
+    if(!isBtcr2UpdateContext(update.proof?.['@context'], update['@context'])) {
+      throw new ResolveError(
+        'Invalid update: proof @context does not equal the update @context',
+        INVALID_DID_UPDATE, { proofContext: update.proof?.['@context'], context: update['@context'] }
+      );
+    }
+
     // Get the capability id from the to update proof.
     const capabilityId = update.proof?.capability;
     // Since this field is optional, check that it exists

package/src/core/updater.ts

@@ -4,6 +4,7 @@ import { canonicalHash, INVALID_DID_UPDATE, JSONPatch, UpdateError } from '@did-
 import { SchnorrMultikey } from '@did-btcr2/cryptosuite';
 import type { Signer } from '@did-btcr2/keypair';
 import type { Btcr2DataIntegrityConfig, SignedBTCR2Update, UnsignedBTCR2Update } from './btcr2-update.js';
+import { BTCR2_UPDATE_CONTEXT } from './btcr2-update.js';
 import { DidDocument, type Btcr2DidDocument, type DidVerificationMethod } from '../utils/did-document.js';
 import type { BroadcastResult } from './beacon/beacon.js';
 import type { CASBroadcastOptions } from './beacon/cas-beacon.js';
@@ -214,12 +215,9 @@ export class Updater {
     sourceVersionId: number,
   ): UnsignedBTCR2Update {
     const unsignedUpdate: UnsignedBTCR2Update = {
-      '@context'      : [
-        'https://w3id.org/security/v2',
-        'https://w3id.org/zcap/v1',
-        'https://w3id.org/json-ld-patch/v1',
-        'https://btcr2.dev/context/v1'
-      ],
+      // The array the specification pins, as a fresh copy: the update is a plain JSON
+      // object that callers may edit, and the shared constant is frozen.
+      '@context'      : [ ...BTCR2_UPDATE_CONTEXT ],
       patch           : patches,
       targetHash      : '',
       targetVersionId : sourceVersionId + 1,
@@ -311,12 +309,10 @@ export class Updater {
     }
 
     const config: Btcr2DataIntegrityConfig = {
-      '@context' : [
-        'https://w3id.org/security/v2',
-        'https://w3id.org/zcap/v1',
-        'https://w3id.org/json-ld-patch/v1',
-        'https://btcr2.dev/context/v1'
-      ],
+      // The proof must carry the same array as the update. The cryptosuite copies the
+      // document @context into the proof when the document has one, so the two arrays
+      // are equal by construction; this value is the fallback for a document without one.
+      '@context'         : [ ...BTCR2_UPDATE_CONTEXT ],
       cryptosuite        : 'bip340-jcs-2025',
       type               : 'DataIntegrityProof',
       // The proof names the signing method by absolute DID URL, even when the document

package/src/utils/appendix.ts

@@ -161,9 +161,10 @@ export class Appendix {
    * ```
    * {
    *  "@context": [
+   *   "https://w3id.org/json-ld-patch/v1",
    *   "https://w3id.org/zcap/v1",
    *   "https://w3id.org/security/data-integrity/v2",
-   *   "https://w3id.org/json-ld-patch/v1"
+   *   "https://btcr2.dev/context/v1"
    *  ],
    *  "patch": [
    *   {