@twin.org/standards-w3c-did 0.0.1-next.29 → 0.0.1-next.30

package/dist/cjs/index.cjs

@@ -2,8 +2,8 @@
 
 var core = require('@twin.org/core');
 var crypto = require('@twin.org/crypto');
-var web = require('@twin.org/web');
 var dataJsonLd = require('@twin.org/data-json-ld');
+var web = require('@twin.org/web');
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -172,9 +172,12 @@ class DataIntegrityProofSignerVerifier {
         if (!core.Is.uint8Array(rawKeys.privateKey)) {
             throw new core.GeneralError(this.CLASS_NAME, "missingPrivateKey");
         }
+        const unsecuredDocumentClone = core.ObjectHelper.clone(unsecuredDocument);
+        const signedProof = core.ObjectHelper.clone(unsignedProof);
+        unsecuredDocumentClone["@context"] = dataJsonLd.JsonLdProcessor.combineContexts(unsecuredDocumentClone["@context"], DidContexts.ContextDataIntegrity);
+        signedProof["@context"] = unsecuredDocumentClone["@context"];
         const combinedHash = await this.createHash(unsecuredDocument, unsignedProof);
         const signature = crypto.Ed25519.sign(rawKeys.privateKey, combinedHash);
-        const signedProof = core.ObjectHelper.clone(unsignedProof);
         signedProof.proofValue = `z${core.Converter.bytesToBase58(signature)}`;
         return signedProof;
     }
@@ -217,9 +220,8 @@ class DataIntegrityProofSignerVerifier {
                 cryptoSuite: proofOptionsClone.cryptosuite
             });
         }
-        if (!core.Is.empty(unsecuredDocumentClone["@context"])) {
-            proofOptionsClone["@context"] = unsecuredDocumentClone["@context"];
-        }
+        unsecuredDocumentClone["@context"] = dataJsonLd.JsonLdProcessor.combineContexts(unsecuredDocumentClone["@context"], DidContexts.ContextDataIntegrity);
+        proofOptionsClone["@context"] = unsecuredDocumentClone["@context"];
         const transformedDocument = core.JsonHelper.canonicalize(unsecuredDocumentClone);
         const transformedDocumentHash = crypto.Sha256.sum256(core.Converter.utf8ToBytes(transformedDocument));
         const transformedProofOptions = core.JsonHelper.canonicalize(proofOptionsClone);
@@ -249,10 +251,13 @@ class JsonWebSignature2020SignerVerifier {
         core.Guards.object(this.CLASS_NAME, "unsecuredDocument", unsecuredDocument);
         core.Guards.object(this.CLASS_NAME, "unsignedProof", unsignedProof);
         core.Guards.object(this.CLASS_NAME, "signKey", signKey);
+        const unsecuredDocumentClone = core.ObjectHelper.clone(unsecuredDocument);
+        unsecuredDocumentClone["@context"] = dataJsonLd.JsonLdProcessor.combineContexts(unsecuredDocumentClone["@context"], DidContexts.ContextSecurityJws2020);
         const hash = await this.createHash(unsecuredDocument, unsignedProof);
         const cryptoKey = await web.Jwk.toCryptoKey(signKey);
         const signature = await web.Jws.create(cryptoKey, hash);
         const signedProof = core.ObjectHelper.clone(unsignedProof);
+        signedProof["@context"] = unsecuredDocumentClone["@context"];
         signedProof.jws = signature;
         return signedProof;
     }
@@ -470,6 +475,44 @@ class ProofHelper {
         const signerVerifier = ProofHelper.createSignerVerifier(signedProof.type);
         return signerVerifier.verifyProof(securedDocument, signedProof, verifyKey);
     }
+    /**
+     * Create an unsigned proof.
+     * @param proofType The type of proof to create.
+     * @param verificationMethodId The verification method id.
+     * @param otherParams Other parameters for the proof.
+     * @returns The created proof.
+     * @throws GeneralError if the proof type is not supported.
+     */
+    static createUnsignedProof(proofType, verificationMethodId, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    otherParams) {
+        let proof;
+        if (proofType === ProofTypes.DataIntegrityProof) {
+            proof = {
+                "@context": DidContexts.ContextDataIntegrity,
+                type: ProofTypes.DataIntegrityProof,
+                cryptosuite: DidCryptoSuites.EdDSAJcs2022,
+                created: new Date(Date.now()).toISOString(),
+                verificationMethod: verificationMethodId,
+                proofPurpose: "assertionMethod",
+                ...otherParams
+            };
+        }
+        else if (proofType === ProofTypes.JsonWebSignature2020) {
+            proof = {
+                "@context": DidContexts.ContextSecurityJws2020,
+                type: ProofTypes.JsonWebSignature2020,
+                created: new Date(Date.now()).toISOString(),
+                verificationMethod: verificationMethodId,
+                proofPurpose: "assertionMethod",
+                ...otherParams
+            };
+        }
+        if (core.Is.empty(proof)) {
+            throw new core.GeneralError(ProofHelper.CLASS_NAME, "unsupportedProofType", { proofType });
+        }
+        return proof;
+    }
 }
 
 exports.DataIntegrityProofSignerVerifier = DataIntegrityProofSignerVerifier;

package/dist/esm/index.mjs

@@ -1,7 +1,7 @@
 import { Guards, Is, GeneralError, ObjectHelper, Converter, JsonHelper, Uint8ArrayHelper } from '@twin.org/core';
 import { Ed25519, Sha256 } from '@twin.org/crypto';
-import { Jwk, Jws } from '@twin.org/web';
 import { JsonLdProcessor } from '@twin.org/data-json-ld';
+import { Jwk, Jws } from '@twin.org/web';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -170,9 +170,12 @@ class DataIntegrityProofSignerVerifier {
         if (!Is.uint8Array(rawKeys.privateKey)) {
             throw new GeneralError(this.CLASS_NAME, "missingPrivateKey");
         }
+        const unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);
+        const signedProof = ObjectHelper.clone(unsignedProof);
+        unsecuredDocumentClone["@context"] = JsonLdProcessor.combineContexts(unsecuredDocumentClone["@context"], DidContexts.ContextDataIntegrity);
+        signedProof["@context"] = unsecuredDocumentClone["@context"];
         const combinedHash = await this.createHash(unsecuredDocument, unsignedProof);
         const signature = Ed25519.sign(rawKeys.privateKey, combinedHash);
-        const signedProof = ObjectHelper.clone(unsignedProof);
         signedProof.proofValue = `z${Converter.bytesToBase58(signature)}`;
         return signedProof;
     }
@@ -215,9 +218,8 @@ class DataIntegrityProofSignerVerifier {
                 cryptoSuite: proofOptionsClone.cryptosuite
             });
         }
-        if (!Is.empty(unsecuredDocumentClone["@context"])) {
-            proofOptionsClone["@context"] = unsecuredDocumentClone["@context"];
-        }
+        unsecuredDocumentClone["@context"] = JsonLdProcessor.combineContexts(unsecuredDocumentClone["@context"], DidContexts.ContextDataIntegrity);
+        proofOptionsClone["@context"] = unsecuredDocumentClone["@context"];
         const transformedDocument = JsonHelper.canonicalize(unsecuredDocumentClone);
         const transformedDocumentHash = Sha256.sum256(Converter.utf8ToBytes(transformedDocument));
         const transformedProofOptions = JsonHelper.canonicalize(proofOptionsClone);
@@ -247,10 +249,13 @@ class JsonWebSignature2020SignerVerifier {
         Guards.object(this.CLASS_NAME, "unsecuredDocument", unsecuredDocument);
         Guards.object(this.CLASS_NAME, "unsignedProof", unsignedProof);
         Guards.object(this.CLASS_NAME, "signKey", signKey);
+        const unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);
+        unsecuredDocumentClone["@context"] = JsonLdProcessor.combineContexts(unsecuredDocumentClone["@context"], DidContexts.ContextSecurityJws2020);
         const hash = await this.createHash(unsecuredDocument, unsignedProof);
         const cryptoKey = await Jwk.toCryptoKey(signKey);
         const signature = await Jws.create(cryptoKey, hash);
         const signedProof = ObjectHelper.clone(unsignedProof);
+        signedProof["@context"] = unsecuredDocumentClone["@context"];
         signedProof.jws = signature;
         return signedProof;
     }
@@ -468,6 +473,44 @@ class ProofHelper {
         const signerVerifier = ProofHelper.createSignerVerifier(signedProof.type);
         return signerVerifier.verifyProof(securedDocument, signedProof, verifyKey);
     }
+    /**
+     * Create an unsigned proof.
+     * @param proofType The type of proof to create.
+     * @param verificationMethodId The verification method id.
+     * @param otherParams Other parameters for the proof.
+     * @returns The created proof.
+     * @throws GeneralError if the proof type is not supported.
+     */
+    static createUnsignedProof(proofType, verificationMethodId, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    otherParams) {
+        let proof;
+        if (proofType === ProofTypes.DataIntegrityProof) {
+            proof = {
+                "@context": DidContexts.ContextDataIntegrity,
+                type: ProofTypes.DataIntegrityProof,
+                cryptosuite: DidCryptoSuites.EdDSAJcs2022,
+                created: new Date(Date.now()).toISOString(),
+                verificationMethod: verificationMethodId,
+                proofPurpose: "assertionMethod",
+                ...otherParams
+            };
+        }
+        else if (proofType === ProofTypes.JsonWebSignature2020) {
+            proof = {
+                "@context": DidContexts.ContextSecurityJws2020,
+                type: ProofTypes.JsonWebSignature2020,
+                created: new Date(Date.now()).toISOString(),
+                verificationMethod: verificationMethodId,
+                proofPurpose: "assertionMethod",
+                ...otherParams
+            };
+        }
+        if (Is.empty(proof)) {
+            throw new GeneralError(ProofHelper.CLASS_NAME, "unsupportedProofType", { proofType });
+        }
+        return proof;
+    }
 }
 
 export { DataIntegrityProofSignerVerifier, DidContexts, DidCryptoSuites, DidTypes, DidVerificationMethodType, JsonWebSignature2020SignerVerifier, MultikeyHelper, ProofHelper, ProofTypes };

package/dist/types/signerVerifiers/dataIntegrityProofSignerVerifier.d.ts

@@ -1,4 +1,4 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IJwk } from "@twin.org/web";
 import type { IDataIntegrityProof } from "../models/IDataIntegrityProof";
 import type { IProof } from "../models/IProof";

package/dist/types/utils/proofHelper.d.ts

@@ -35,4 +35,13 @@ export declare class ProofHelper {
      * @returns True if the credential was verified.
      */
     static verifyProof(securedDocument: IJsonLdNodeObject, signedProof: IProof, verifyKey: IJwk): Promise<boolean>;
+    /**
+     * Create an unsigned proof.
+     * @param proofType The type of proof to create.
+     * @param verificationMethodId The verification method id.
+     * @param otherParams Other parameters for the proof.
+     * @returns The created proof.
+     * @throws GeneralError if the proof type is not supported.
+     */
+    static createUnsignedProof(proofType: ProofTypes, verificationMethodId: string, otherParams?: any): IProof;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/standards-w3c-did - Changelog
 
-## v0.0.1-next.29
+## v0.0.1-next.30
 
 - Initial Release

package/docs/reference/classes/ProofHelper.md

@@ -119,3 +119,41 @@ The public key to verify the proof with.
 `Promise`\<`boolean`\>
 
 True if the credential was verified.
+
+***
+
+### createUnsignedProof()
+
+> `static` **createUnsignedProof**(`proofType`, `verificationMethodId`, `otherParams`?): [`IProof`](../type-aliases/IProof.md)
+
+Create an unsigned proof.
+
+#### Parameters
+
+##### proofType
+
+[`ProofTypes`](../type-aliases/ProofTypes.md)
+
+The type of proof to create.
+
+##### verificationMethodId
+
+`string`
+
+The verification method id.
+
+##### otherParams?
+
+`any`
+
+Other parameters for the proof.
+
+#### Returns
+
+[`IProof`](../type-aliases/IProof.md)
+
+The created proof.
+
+#### Throws
+
+GeneralError if the proof type is not supported.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/standards-w3c-did",
-	"version": "0.0.1-next.29",
+	"version": "0.0.1-next.30",
 	"description": "Models which define the structure of W3C DID Standard",
 	"repository": {
 		"type": "git",