@twin.org/standards-w3c-did 0.0.3-next.9 → 0.9.0

package/dist/es/signerVerifiers/dataIntegrityProofAsyncSignerVerifier.js

@@ -0,0 +1,73 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Converter, Guards, ObjectHelper } from "@twin.org/core";
+import { JsonLdProcessor } from "@twin.org/data-json-ld";
+import { DataIntegrityProofSignerVerifier } from "./dataIntegrityProofSignerVerifier.js";
+import { DidContexts } from "../models/didContexts.js";
+import { JwsAlgorithms } from "../models/jwsAlgorithms.js";
+/**
+ * Helper methods for creating and verifying Data Integrity proofs with async signing callbacks.
+ * @see https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022
+ */
+export class DataIntegrityProofAsyncSignerVerifier {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "DataIntegrityProofAsyncSignerVerifier";
+    /**
+     * The underlying sync signer verifier for hash and verify operations.
+     * @internal
+     */
+    _syncSignerVerifier;
+    /**
+     * Create a new instance of DataIntegrityProofAsyncSignerVerifier.
+     */
+    constructor() {
+        this._syncSignerVerifier = new DataIntegrityProofSignerVerifier();
+    }
+    /**
+     * Create a proof with an async signing callback.
+     * @param unsecuredDocument The data to create the proof for.
+     * @param unsignedProof The proof options.
+     * @param signCallback Async callback that signs data with a private key from secure storage.
+     * @returns The created proof.
+     */
+    async createProofWithSigner(unsecuredDocument, unsignedProof, signCallback) {
+        Guards.object(DataIntegrityProofAsyncSignerVerifier.CLASS_NAME, "unsecuredDocument", unsecuredDocument);
+        Guards.object(DataIntegrityProofAsyncSignerVerifier.CLASS_NAME, "unsignedProof", unsignedProof);
+        Guards.function(DataIntegrityProofAsyncSignerVerifier.CLASS_NAME, "signCallback", signCallback);
+        const unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);
+        const signedProof = ObjectHelper.clone(unsignedProof);
+        unsecuredDocumentClone["@context"] = JsonLdProcessor.combineContexts(unsecuredDocumentClone["@context"], DidContexts.ContextDataIntegrity);
+        signedProof["@context"] = unsecuredDocumentClone["@context"];
+        // Use the sync verifier to create the hash
+        const combinedHash = await this.createHash(unsecuredDocument, unsignedProof);
+        // Sign with the callback (key stays in secure storage)
+        // Pass JWS algorithm for vault validation
+        const signature = await signCallback(combinedHash, JwsAlgorithms.EdDSA);
+        signedProof.proofValue = `z${Converter.bytesToBase58(signature)}`;
+        return signedProof;
+    }
+    /**
+     * Verify a proof for the given data.
+     * @param securedDocument The credential to verify.
+     * @param signedProof The proof to verify.
+     * @param verifyKey The public key to verify the proof with.
+     * @returns True if the credential was verified.
+     */
+    async verifyProof(securedDocument, signedProof, verifyKey) {
+        // Delegate to the sync implementation
+        return this._syncSignerVerifier.verifyProof(securedDocument, signedProof, verifyKey);
+    }
+    /**
+     * Create a hash for the given data.
+     * @param unsecuredDocument The data to create the proof for.
+     * @param unsignedProof The unsigned proof.
+     * @returns The created hash.
+     */
+    async createHash(unsecuredDocument, unsignedProof) {
+        // Delegate to the sync implementation
+        return this._syncSignerVerifier.createHash(unsecuredDocument, unsignedProof);
+    }
+}
+//# sourceMappingURL=dataIntegrityProofAsyncSignerVerifier.js.map

package/dist/es/signerVerifiers/dataIntegrityProofAsyncSignerVerifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataIntegrityProofAsyncSignerVerifier.js","sourceRoot":"","sources":["../../../src/signerVerifiers/dataIntegrityProofAsyncSignerVerifier.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,eAAe,EAA0B,MAAM,wBAAwB,CAAC;AAGjF,OAAO,EAAE,gCAAgC,EAAE,MAAM,uCAAuC,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAIvD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D;;;GAGG;AACH,MAAM,OAAO,qCAAqC;IACjD;;OAEG;IACI,MAAM,CAAU,UAAU,2CAA2D;IAE5F;;;OAGG;IACc,mBAAmB,CAAmC;IAEvE;;OAEG;IACH;QACC,IAAI,CAAC,mBAAmB,GAAG,IAAI,gCAAgC,EAAE,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,qBAAqB,CACjC,iBAAoC,EACpC,aAAkC,EAClC,YAA0E;QAE1E,MAAM,CAAC,MAAM,CACZ,qCAAqC,CAAC,UAAU,uBAEhD,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,qCAAqC,CAAC,UAAU,mBAEhD,aAAa,CACb,CAAC;QACF,MAAM,CAAC,QAAQ,CACd,qCAAqC,CAAC,UAAU,kBAEhD,YAAY,CACZ,CAAC;QAEF,MAAM,sBAAsB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAErE,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAEtD,sBAAsB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,eAAe,CACnE,sBAAsB,CAAC,UAAU,CAAC,EAClC,WAAW,CAAC,oBAAoB,CAChC,CAAC;QAEF,WAAW,CAAC,UAAU,CAAC,GAAG,sBAAsB,CAAC,UAAU,CAAoC,CAAC;QAEhG,2CAA2C;QAC3C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAE7E,uDAAuD;QACvD,0CAA0C;QAC1C,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,YAAY,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;QAExE,WAAW,CAAC,UAAU,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;QAElE,OAAO,WAAW,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,eAAkC,EAClC,WAAgC,EAChC,SAAe;QAEf,sCAAsC;QACtC,OAAO,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,eAAe,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IACtF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CACtB,iBAAoC,EACpC,aAAkC;QAElC,sCAAsC;QACtC,OAAO,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;IAC9E,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Converter, Guards, ObjectHelper } from \"@twin.org/core\";\nimport { JsonLdProcessor, type IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IJwk } from \"@twin.org/web\";\nimport { DataIntegrityProofSignerVerifier } from \"./dataIntegrityProofSignerVerifier.js\";\nimport { DidContexts } from \"../models/didContexts.js\";\nimport type { IDataIntegrityProof } from \"../models/IDataIntegrityProof.js\";\nimport type { IProof } from \"../models/IProof.js\";\nimport type { IProofSignerVerifierAsync } from \"../models/IProofSignerVerifierAsync.js\";\nimport { JwsAlgorithms } from \"../models/jwsAlgorithms.js\";\n\n/**\n * Helper methods for creating and verifying Data Integrity proofs with async signing callbacks.\n * @see https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022\n */\nexport class DataIntegrityProofAsyncSignerVerifier implements IProofSignerVerifierAsync {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<DataIntegrityProofAsyncSignerVerifier>();\n\n\t/**\n\t * The underlying sync signer verifier for hash and verify operations.\n\t * @internal\n\t */\n\tprivate readonly _syncSignerVerifier: DataIntegrityProofSignerVerifier;\n\n\t/**\n\t * Create a new instance of DataIntegrityProofAsyncSignerVerifier.\n\t */\n\tconstructor() {\n\t\tthis._syncSignerVerifier = new DataIntegrityProofSignerVerifier();\n\t}\n\n\t/**\n\t * Create a proof with an async signing callback.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The proof options.\n\t * @param signCallback Async callback that signs data with a private key from secure storage.\n\t * @returns The created proof.\n\t */\n\tpublic async createProofWithSigner(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IDataIntegrityProof,\n\t\tsignCallback: (data: Uint8Array, algorithm: string) => Promise<Uint8Array>\n\t): Promise<IProof> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tDataIntegrityProofAsyncSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IProof>(\n\t\t\tDataIntegrityProofAsyncSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof),\n\t\t\tunsignedProof\n\t\t);\n\t\tGuards.function(\n\t\t\tDataIntegrityProofAsyncSignerVerifier.CLASS_NAME,\n\t\t\tnameof(signCallback),\n\t\t\tsignCallback\n\t\t);\n\n\t\tconst unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);\n\n\t\tconst signedProof = ObjectHelper.clone(unsignedProof);\n\n\t\tunsecuredDocumentClone[\"@context\"] = JsonLdProcessor.combineContexts(\n\t\t\tunsecuredDocumentClone[\"@context\"],\n\t\t\tDidContexts.ContextDataIntegrity\n\t\t);\n\n\t\tsignedProof[\"@context\"] = unsecuredDocumentClone[\"@context\"] as IDataIntegrityProof[\"@context\"];\n\n\t\t// Use the sync verifier to create the hash\n\t\tconst combinedHash = await this.createHash(unsecuredDocument, unsignedProof);\n\n\t\t// Sign with the callback (key stays in secure storage)\n\t\t// Pass JWS algorithm for vault validation\n\t\tconst signature = await signCallback(combinedHash, JwsAlgorithms.EdDSA);\n\n\t\tsignedProof.proofValue = `z${Converter.bytesToBase58(signature)}`;\n\n\t\treturn signedProof;\n\t}\n\n\t/**\n\t * Verify a proof for the given data.\n\t * @param securedDocument The credential to verify.\n\t * @param signedProof The proof to verify.\n\t * @param verifyKey The public key to verify the proof with.\n\t * @returns True if the credential was verified.\n\t */\n\tpublic async verifyProof(\n\t\tsecuredDocument: IJsonLdNodeObject,\n\t\tsignedProof: IDataIntegrityProof,\n\t\tverifyKey: IJwk\n\t): Promise<boolean> {\n\t\t// Delegate to the sync implementation\n\t\treturn this._syncSignerVerifier.verifyProof(securedDocument, signedProof, verifyKey);\n\t}\n\n\t/**\n\t * Create a hash for the given data.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The unsigned proof.\n\t * @returns The created hash.\n\t */\n\tpublic async createHash(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IDataIntegrityProof\n\t): Promise<Uint8Array> {\n\t\t// Delegate to the sync implementation\n\t\treturn this._syncSignerVerifier.createHash(unsecuredDocument, unsignedProof);\n\t}\n}\n"]}

package/dist/es/signerVerifiers/dataIntegrityProofSignerVerifier.js

@@ -7,8 +7,8 @@ import { Jwk } from "@twin.org/web";
 import { DidContexts } from "../models/didContexts.js";
 import { DidCryptoSuites } from "../models/didCryptoSuites.js";
 /**
- * Helper methods for creating and verifying proofs.
- * https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022
+ * Helper methods for creating and verifying Data Integrity proofs using EdDSA-JCS-2022.
+ * @see https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022
  */
 export class DataIntegrityProofSignerVerifier {
     /**
@@ -40,7 +40,7 @@ export class DataIntegrityProofSignerVerifier {
         return signedProof;
     }
     /**
-     * Verify a proof for the given data in format.
+     * Verify a proof for the given data.
      * @param securedDocument The credential to verify.
      * @param signedProof The proof to verify.
      * @param verifyKey The public key to verify the proof with.

package/dist/es/signerVerifiers/dataIntegrityProofSignerVerifier.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataIntegrityProofSignerVerifier.js","sourceRoot":"","sources":["../../../src/signerVerifiers/dataIntegrityProofSignerVerifier.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,SAAS,EACT,YAAY,EACZ,MAAM,EACN,EAAE,EACF,UAAU,EACV,YAAY,EACZ,gBAAgB,EAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,eAAe,EAA0B,MAAM,wBAAwB,CAAC;AAEjF,OAAO,EAAE,GAAG,EAAa,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAK/D;;;GAGG;AACH,MAAM,OAAO,gCAAgC;IAC5C;;OAEG;IACI,MAAM,CAAU,UAAU,sCAAsD;IAEvF;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,iBAAoC,EACpC,aAAkC,EAClC,OAAa;QAEb,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,uBAE3C,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,mBAE3C,aAAa,CACb,CAAC;QACF,MAAM,CAAC,MAAM,CAAO,gCAAgC,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAE3F,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,YAAY,CAAC,gCAAgC,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;QAC1F,CAAC;QAED,MAAM,sBAAsB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAErE,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAEtD,sBAAsB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,eAAe,CACnE,sBAAsB,CAAC,UAAU,CAAC,EAClC,WAAW,CAAC,oBAAoB,CAChC,CAAC;QAEF,WAAW,CAAC,UAAU,CAAC,GAAG,sBAAsB,CAAC,UAAU,CAAoC,CAAC;QAEhG,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAE7E,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAEjE,WAAW,CAAC,UAAU,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;QAElE,OAAO,WAAW,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,eAAkC,EAClC,WAAgC,EAChC,SAAe;QAEf,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,qBAE3C,eAAe,CACf,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,iBAE3C,WAAW,CACX,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,gCAAgC,CAAC,UAAU,4BAE3C,WAAW,CAAC,UAAU,CACtB,CAAC;QACF,MAAM,CAAC,MAAM,CAAO,gCAAgC,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAE/F,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,YAAY,CAAC,gCAAgC,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;QACzF,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;QAEzE,OAAO,OAAO,CAAC,MAAM,CACpB,OAAO,CAAC,SAAS,EACjB,YAAY,EACZ,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CACxD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CACtB,iBAAoC,EACpC,aAAkC;QAElC,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,uBAE3C,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,mBAE3C,aAAa,CACb,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,gCAAgC,CAAC,UAAU,+BAE3C,aAAa,CAAC,WAAW,CACzB,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,gCAAgC,CAAC,UAAU,sCAE3C,aAAa,CAAC,kBAAkB,CAChC,CAAC;QAEF,MAAM,sBAAsB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrE,MAAM,iBAAiB,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAE5D,OAAO,sBAAsB,CAAC,KAAK,CAAC;QACpC,OAAO,iBAAiB,CAAC,UAAU,CAAC;QAEpC,IAAI,iBAAiB,CAAC,WAAW,KAAK,eAAe,CAAC,YAAY,EAAE,CAAC;YACpE,MAAM,IAAI,YAAY,CACrB,gCAAgC,CAAC,UAAU,EAC3C,yBAAyB,EACzB;gBACC,WAAW,EAAE,iBAAiB,CAAC,WAAW;aAC1C,CACD,CAAC;QACH,CAAC;QAED,sBAAsB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,eAAe,CACnE,sBAAsB,CAAC,UAAU,CAAC,EAClC,WAAW,CAAC,oBAAoB,CAChC,CAAC;QAEF,iBAAiB,CAAC,UAAU,CAAC,GAAG,sBAAsB,CACrD,UAAU,CACyB,CAAC;QAErC,MAAM,mBAAmB,GAAG,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC,CAAC;QAE5E,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAE1F,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QAE3E,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAEvF,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAAC,CAAC;IAC7E,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tConverter,\n\tGeneralError,\n\tGuards,\n\tIs,\n\tJsonHelper,\n\tObjectHelper,\n\tUint8ArrayHelper\n} from \"@twin.org/core\";\nimport { Ed25519, Sha256 } from \"@twin.org/crypto\";\nimport { JsonLdProcessor, type IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { Jwk, type IJwk } from \"@twin.org/web\";\nimport { DidContexts } from \"../models/didContexts.js\";\nimport { DidCryptoSuites } from \"../models/didCryptoSuites.js\";\nimport type { IDataIntegrityProof } from \"../models/IDataIntegrityProof.js\";\nimport type { IProof } from \"../models/IProof.js\";\nimport type { IProofSignerVerifier } from \"../models/IProofSignerVerifier.js\";\n\n/**\n * Helper methods for creating and verifying proofs.\n * https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022\n */\nexport class DataIntegrityProofSignerVerifier implements IProofSignerVerifier {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<DataIntegrityProofSignerVerifier>();\n\n\t/**\n\t * Create a proof for the given data.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The proof options.\n\t * @param signKey The key to sign the proof with.\n\t * @returns The created proof.\n\t */\n\tpublic async createProof(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IDataIntegrityProof,\n\t\tsignKey: IJwk\n\t): Promise<IProof> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IProof>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof),\n\t\t\tunsignedProof\n\t\t);\n\t\tGuards.object<IJwk>(DataIntegrityProofSignerVerifier.CLASS_NAME, nameof(signKey), signKey);\n\n\t\tconst rawKeys = await Jwk.toRaw(signKey);\n\t\tif (!Is.uint8Array(rawKeys.privateKey)) {\n\t\t\tthrow new GeneralError(DataIntegrityProofSignerVerifier.CLASS_NAME, \"missingPrivateKey\");\n\t\t}\n\n\t\tconst unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);\n\n\t\tconst signedProof = ObjectHelper.clone(unsignedProof);\n\n\t\tunsecuredDocumentClone[\"@context\"] = JsonLdProcessor.combineContexts(\n\t\t\tunsecuredDocumentClone[\"@context\"],\n\t\t\tDidContexts.ContextDataIntegrity\n\t\t);\n\n\t\tsignedProof[\"@context\"] = unsecuredDocumentClone[\"@context\"] as IDataIntegrityProof[\"@context\"];\n\n\t\tconst combinedHash = await this.createHash(unsecuredDocument, unsignedProof);\n\n\t\tconst signature = Ed25519.sign(rawKeys.privateKey, combinedHash);\n\n\t\tsignedProof.proofValue = `z${Converter.bytesToBase58(signature)}`;\n\n\t\treturn signedProof;\n\t}\n\n\t/**\n\t * Verify a proof for the given data in format.\n\t * @param securedDocument The credential to verify.\n\t * @param signedProof The proof to verify.\n\t * @param verifyKey The public key to verify the proof with.\n\t * @returns True if the credential was verified.\n\t */\n\tpublic async verifyProof(\n\t\tsecuredDocument: IJsonLdNodeObject,\n\t\tsignedProof: IDataIntegrityProof,\n\t\tverifyKey: IJwk\n\t): Promise<boolean> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(securedDocument),\n\t\t\tsecuredDocument\n\t\t);\n\t\tGuards.object<IDataIntegrityProof>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(signedProof),\n\t\t\tsignedProof\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(signedProof.proofValue),\n\t\t\tsignedProof.proofValue\n\t\t);\n\t\tGuards.object<IJwk>(DataIntegrityProofSignerVerifier.CLASS_NAME, nameof(verifyKey), verifyKey);\n\n\t\tconst rawKeys = await Jwk.toRaw(verifyKey);\n\t\tif (!Is.uint8Array(rawKeys.publicKey)) {\n\t\t\tthrow new GeneralError(DataIntegrityProofSignerVerifier.CLASS_NAME, \"missingPublicKey\");\n\t\t}\n\n\t\tconst combinedHash = await this.createHash(securedDocument, signedProof);\n\n\t\treturn Ed25519.verify(\n\t\t\trawKeys.publicKey,\n\t\t\tcombinedHash,\n\t\t\tConverter.base58ToBytes(signedProof.proofValue.slice(1))\n\t\t);\n\t}\n\n\t/**\n\t * Create a hash for the given data.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The unsigned proof.\n\t * @returns The created hash.\n\t */\n\tpublic async createHash(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IDataIntegrityProof\n\t): Promise<Uint8Array> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IDataIntegrityProof>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof),\n\t\t\tunsignedProof\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof.cryptosuite),\n\t\t\tunsignedProof.cryptosuite\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof.verificationMethod),\n\t\t\tunsignedProof.verificationMethod\n\t\t);\n\n\t\tconst unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);\n\t\tconst proofOptionsClone = ObjectHelper.clone(unsignedProof);\n\n\t\tdelete unsecuredDocumentClone.proof;\n\t\tdelete proofOptionsClone.proofValue;\n\n\t\tif (proofOptionsClone.cryptosuite !== DidCryptoSuites.EdDSAJcs2022) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\t\t\"cryptosuiteNotSupported\",\n\t\t\t\t{\n\t\t\t\t\tcryptoSuite: proofOptionsClone.cryptosuite\n\t\t\t\t}\n\t\t\t);\n\t\t}\n\n\t\tunsecuredDocumentClone[\"@context\"] = JsonLdProcessor.combineContexts(\n\t\t\tunsecuredDocumentClone[\"@context\"],\n\t\t\tDidContexts.ContextDataIntegrity\n\t\t);\n\n\t\tproofOptionsClone[\"@context\"] = unsecuredDocumentClone[\n\t\t\t\"@context\"\n\t\t] as IDataIntegrityProof[\"@context\"];\n\n\t\tconst transformedDocument = JsonHelper.canonicalize(unsecuredDocumentClone);\n\n\t\tconst transformedDocumentHash = Sha256.sum256(Converter.utf8ToBytes(transformedDocument));\n\n\t\tconst transformedProofOptions = JsonHelper.canonicalize(proofOptionsClone);\n\n\t\tconst proofOptionsHash = Sha256.sum256(Converter.utf8ToBytes(transformedProofOptions));\n\n\t\treturn Uint8ArrayHelper.concat([proofOptionsHash, transformedDocumentHash]);\n\t}\n}\n"]}
+{"version":3,"file":"dataIntegrityProofSignerVerifier.js","sourceRoot":"","sources":["../../../src/signerVerifiers/dataIntegrityProofSignerVerifier.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,SAAS,EACT,YAAY,EACZ,MAAM,EACN,EAAE,EACF,UAAU,EACV,YAAY,EACZ,gBAAgB,EAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,eAAe,EAA0B,MAAM,wBAAwB,CAAC;AAEjF,OAAO,EAAE,GAAG,EAAa,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAK/D;;;GAGG;AACH,MAAM,OAAO,gCAAgC;IAC5C;;OAEG;IACI,MAAM,CAAU,UAAU,sCAAsD;IAEvF;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,iBAAoC,EACpC,aAAkC,EAClC,OAAa;QAEb,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,uBAE3C,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,mBAE3C,aAAa,CACb,CAAC;QACF,MAAM,CAAC,MAAM,CAAO,gCAAgC,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAE3F,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,YAAY,CAAC,gCAAgC,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;QAC1F,CAAC;QAED,MAAM,sBAAsB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAErE,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAEtD,sBAAsB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,eAAe,CACnE,sBAAsB,CAAC,UAAU,CAAC,EAClC,WAAW,CAAC,oBAAoB,CAChC,CAAC;QAEF,WAAW,CAAC,UAAU,CAAC,GAAG,sBAAsB,CAAC,UAAU,CAAoC,CAAC;QAEhG,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAE7E,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAEjE,WAAW,CAAC,UAAU,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;QAElE,OAAO,WAAW,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,eAAkC,EAClC,WAAgC,EAChC,SAAe;QAEf,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,qBAE3C,eAAe,CACf,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,iBAE3C,WAAW,CACX,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,gCAAgC,CAAC,UAAU,4BAE3C,WAAW,CAAC,UAAU,CACtB,CAAC;QACF,MAAM,CAAC,MAAM,CAAO,gCAAgC,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAE/F,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,YAAY,CAAC,gCAAgC,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;QACzF,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;QAEzE,OAAO,OAAO,CAAC,MAAM,CACpB,OAAO,CAAC,SAAS,EACjB,YAAY,EACZ,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CACxD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CACtB,iBAAoC,EACpC,aAAkC;QAElC,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,uBAE3C,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,gCAAgC,CAAC,UAAU,mBAE3C,aAAa,CACb,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,gCAAgC,CAAC,UAAU,+BAE3C,aAAa,CAAC,WAAW,CACzB,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,gCAAgC,CAAC,UAAU,sCAE3C,aAAa,CAAC,kBAAkB,CAChC,CAAC;QAEF,MAAM,sBAAsB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrE,MAAM,iBAAiB,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAE5D,OAAO,sBAAsB,CAAC,KAAK,CAAC;QACpC,OAAO,iBAAiB,CAAC,UAAU,CAAC;QAEpC,IAAI,iBAAiB,CAAC,WAAW,KAAK,eAAe,CAAC,YAAY,EAAE,CAAC;YACpE,MAAM,IAAI,YAAY,CACrB,gCAAgC,CAAC,UAAU,EAC3C,yBAAyB,EACzB;gBACC,WAAW,EAAE,iBAAiB,CAAC,WAAW;aAC1C,CACD,CAAC;QACH,CAAC;QAED,sBAAsB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,eAAe,CACnE,sBAAsB,CAAC,UAAU,CAAC,EAClC,WAAW,CAAC,oBAAoB,CAChC,CAAC;QAEF,iBAAiB,CAAC,UAAU,CAAC,GAAG,sBAAsB,CACrD,UAAU,CACyB,CAAC;QAErC,MAAM,mBAAmB,GAAG,UAAU,CAAC,YAAY,CAAC,sBAAsB,CAAC,CAAC;QAE5E,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAE1F,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QAE3E,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAEvF,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAAC,CAAC;IAC7E,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tConverter,\n\tGeneralError,\n\tGuards,\n\tIs,\n\tJsonHelper,\n\tObjectHelper,\n\tUint8ArrayHelper\n} from \"@twin.org/core\";\nimport { Ed25519, Sha256 } from \"@twin.org/crypto\";\nimport { JsonLdProcessor, type IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { Jwk, type IJwk } from \"@twin.org/web\";\nimport { DidContexts } from \"../models/didContexts.js\";\nimport { DidCryptoSuites } from \"../models/didCryptoSuites.js\";\nimport type { IDataIntegrityProof } from \"../models/IDataIntegrityProof.js\";\nimport type { IProof } from \"../models/IProof.js\";\nimport type { IProofSignerVerifier } from \"../models/IProofSignerVerifier.js\";\n\n/**\n * Helper methods for creating and verifying Data Integrity proofs using EdDSA-JCS-2022.\n * @see https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022\n */\nexport class DataIntegrityProofSignerVerifier implements IProofSignerVerifier {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<DataIntegrityProofSignerVerifier>();\n\n\t/**\n\t * Create a proof for the given data.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The proof options.\n\t * @param signKey The key to sign the proof with.\n\t * @returns The created proof.\n\t */\n\tpublic async createProof(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IDataIntegrityProof,\n\t\tsignKey: IJwk\n\t): Promise<IProof> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IProof>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof),\n\t\t\tunsignedProof\n\t\t);\n\t\tGuards.object<IJwk>(DataIntegrityProofSignerVerifier.CLASS_NAME, nameof(signKey), signKey);\n\n\t\tconst rawKeys = await Jwk.toRaw(signKey);\n\t\tif (!Is.uint8Array(rawKeys.privateKey)) {\n\t\t\tthrow new GeneralError(DataIntegrityProofSignerVerifier.CLASS_NAME, \"missingPrivateKey\");\n\t\t}\n\n\t\tconst unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);\n\n\t\tconst signedProof = ObjectHelper.clone(unsignedProof);\n\n\t\tunsecuredDocumentClone[\"@context\"] = JsonLdProcessor.combineContexts(\n\t\t\tunsecuredDocumentClone[\"@context\"],\n\t\t\tDidContexts.ContextDataIntegrity\n\t\t);\n\n\t\tsignedProof[\"@context\"] = unsecuredDocumentClone[\"@context\"] as IDataIntegrityProof[\"@context\"];\n\n\t\tconst combinedHash = await this.createHash(unsecuredDocument, unsignedProof);\n\n\t\tconst signature = Ed25519.sign(rawKeys.privateKey, combinedHash);\n\n\t\tsignedProof.proofValue = `z${Converter.bytesToBase58(signature)}`;\n\n\t\treturn signedProof;\n\t}\n\n\t/**\n\t * Verify a proof for the given data.\n\t * @param securedDocument The credential to verify.\n\t * @param signedProof The proof to verify.\n\t * @param verifyKey The public key to verify the proof with.\n\t * @returns True if the credential was verified.\n\t */\n\tpublic async verifyProof(\n\t\tsecuredDocument: IJsonLdNodeObject,\n\t\tsignedProof: IDataIntegrityProof,\n\t\tverifyKey: IJwk\n\t): Promise<boolean> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(securedDocument),\n\t\t\tsecuredDocument\n\t\t);\n\t\tGuards.object<IDataIntegrityProof>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(signedProof),\n\t\t\tsignedProof\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(signedProof.proofValue),\n\t\t\tsignedProof.proofValue\n\t\t);\n\t\tGuards.object<IJwk>(DataIntegrityProofSignerVerifier.CLASS_NAME, nameof(verifyKey), verifyKey);\n\n\t\tconst rawKeys = await Jwk.toRaw(verifyKey);\n\t\tif (!Is.uint8Array(rawKeys.publicKey)) {\n\t\t\tthrow new GeneralError(DataIntegrityProofSignerVerifier.CLASS_NAME, \"missingPublicKey\");\n\t\t}\n\n\t\tconst combinedHash = await this.createHash(securedDocument, signedProof);\n\n\t\treturn Ed25519.verify(\n\t\t\trawKeys.publicKey,\n\t\t\tcombinedHash,\n\t\t\tConverter.base58ToBytes(signedProof.proofValue.slice(1))\n\t\t);\n\t}\n\n\t/**\n\t * Create a hash for the given data.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The unsigned proof.\n\t * @returns The created hash.\n\t */\n\tpublic async createHash(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IDataIntegrityProof\n\t): Promise<Uint8Array> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IDataIntegrityProof>(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof),\n\t\t\tunsignedProof\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof.cryptosuite),\n\t\t\tunsignedProof.cryptosuite\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof.verificationMethod),\n\t\t\tunsignedProof.verificationMethod\n\t\t);\n\n\t\tconst unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);\n\t\tconst proofOptionsClone = ObjectHelper.clone(unsignedProof);\n\n\t\tdelete unsecuredDocumentClone.proof;\n\t\tdelete proofOptionsClone.proofValue;\n\n\t\tif (proofOptionsClone.cryptosuite !== DidCryptoSuites.EdDSAJcs2022) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tDataIntegrityProofSignerVerifier.CLASS_NAME,\n\t\t\t\t\"cryptosuiteNotSupported\",\n\t\t\t\t{\n\t\t\t\t\tcryptoSuite: proofOptionsClone.cryptosuite\n\t\t\t\t}\n\t\t\t);\n\t\t}\n\n\t\tunsecuredDocumentClone[\"@context\"] = JsonLdProcessor.combineContexts(\n\t\t\tunsecuredDocumentClone[\"@context\"],\n\t\t\tDidContexts.ContextDataIntegrity\n\t\t);\n\n\t\tproofOptionsClone[\"@context\"] = unsecuredDocumentClone[\n\t\t\t\"@context\"\n\t\t] as IDataIntegrityProof[\"@context\"];\n\n\t\tconst transformedDocument = JsonHelper.canonicalize(unsecuredDocumentClone);\n\n\t\tconst transformedDocumentHash = Sha256.sum256(Converter.utf8ToBytes(transformedDocument));\n\n\t\tconst transformedProofOptions = JsonHelper.canonicalize(proofOptionsClone);\n\n\t\tconst proofOptionsHash = Sha256.sum256(Converter.utf8ToBytes(transformedProofOptions));\n\n\t\treturn Uint8ArrayHelper.concat([proofOptionsHash, transformedDocumentHash]);\n\t}\n}\n"]}

package/dist/es/signerVerifiers/jsonWebSignature2020AsyncSignerVerifier.js

@@ -0,0 +1,91 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Converter, Guards, ObjectHelper } from "@twin.org/core";
+import { JsonLdProcessor } from "@twin.org/data-json-ld";
+import { JsonWebSignature2020SignerVerifier } from "./jsonWebSignature2020SignerVerifier.js";
+import { DidContexts } from "../models/didContexts.js";
+import { JwsAlgorithms } from "../models/jwsAlgorithms.js";
+/**
+ * Helper methods for creating and verifying JsonWebSignature2020 proofs with async signing callbacks.
+ * This implementation creates JWS signatures manually per RFC 7515 to support async signing callbacks.
+ */
+export class JsonWebSignature2020AsyncSignerVerifier {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "JsonWebSignature2020AsyncSignerVerifier";
+    /**
+     * The underlying sync signer verifier for hash and verify operations.
+     * @internal
+     */
+    _syncSignerVerifier;
+    /**
+     * Create a new instance of JsonWebSignature2020AsyncSignerVerifier.
+     */
+    constructor() {
+        this._syncSignerVerifier = new JsonWebSignature2020SignerVerifier();
+    }
+    /**
+     * Create a proof with an async signing callback.
+     * @param unsecuredDocument The data to create the proof for.
+     * @param unsignedProof The proof options.
+     * @param signCallback Async callback that signs data with a private key from secure storage.
+     * @returns The created proof.
+     */
+    async createProofWithSigner(unsecuredDocument, unsignedProof, signCallback) {
+        Guards.object(JsonWebSignature2020AsyncSignerVerifier.CLASS_NAME, "unsecuredDocument", unsecuredDocument);
+        Guards.object(JsonWebSignature2020AsyncSignerVerifier.CLASS_NAME, "unsignedProof", unsignedProof);
+        Guards.function(JsonWebSignature2020AsyncSignerVerifier.CLASS_NAME, "signCallback", signCallback);
+        const unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);
+        unsecuredDocumentClone["@context"] = JsonLdProcessor.combineContexts(unsecuredDocumentClone["@context"], DidContexts.ContextSecurityJws2020);
+        // Use the sync verifier to create the hash
+        const hash = await this.createHash(unsecuredDocument, unsignedProof);
+        // Create JWS manually per RFC 7515 (Compact Serialization)
+        // Format: BASE64URL(UTF8(JWS Protected Header)) || '.' || BASE64URL(JWS Payload) || '.' || BASE64URL(JWS Signature)
+        // JWS Protected Header for EdDSA with detached payload
+        const header = {
+            alg: "EdDSA",
+            crit: ["b64"],
+            b64: false
+        };
+        const headerJson = JSON.stringify(header);
+        const headerBase64 = Converter.bytesToBase64Url(Converter.utf8ToBytes(headerJson));
+        // Create signing input: header.payload (detached payload means payload is the hash)
+        const signingInput = Converter.utf8ToBytes(`${headerBase64}.`);
+        const dataToSign = new Uint8Array(signingInput.length + hash.length);
+        dataToSign.set(signingInput, 0);
+        dataToSign.set(hash, signingInput.length);
+        // Sign with the callback (key stays in secure storage)
+        // Pass JWS algorithm for vault validation
+        const signature = await signCallback(dataToSign, JwsAlgorithms.EdDSA);
+        // Construct JWS: header..signature (empty payload section for detached content)
+        const signatureBase64 = Converter.bytesToBase64Url(signature);
+        const jws = `${headerBase64}..${signatureBase64}`;
+        const signedProof = ObjectHelper.clone(unsignedProof);
+        signedProof["@context"] = unsecuredDocumentClone["@context"];
+        signedProof.jws = jws;
+        return signedProof;
+    }
+    /**
+     * Verify a proof for the given data.
+     * @param securedDocument The credential to verify.
+     * @param signedProof The proof to verify.
+     * @param verifyKey The public key to verify the proof with.
+     * @returns True if the credential was verified.
+     */
+    async verifyProof(securedDocument, signedProof, verifyKey) {
+        // Delegate to the sync implementation (verification doesn't need the private key)
+        return this._syncSignerVerifier.verifyProof(securedDocument, signedProof, verifyKey);
+    }
+    /**
+     * Create a hash for the given data.
+     * @param unsecuredDocument The data to create the proof for.
+     * @param unsignedProof The unsigned proof.
+     * @returns The created hash.
+     */
+    async createHash(unsecuredDocument, unsignedProof) {
+        // Delegate to the sync implementation
+        return this._syncSignerVerifier.createHash(unsecuredDocument, unsignedProof);
+    }
+}
+//# sourceMappingURL=jsonWebSignature2020AsyncSignerVerifier.js.map

package/dist/es/signerVerifiers/jsonWebSignature2020AsyncSignerVerifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonWebSignature2020AsyncSignerVerifier.js","sourceRoot":"","sources":["../../../src/signerVerifiers/jsonWebSignature2020AsyncSignerVerifier.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,eAAe,EAA0B,MAAM,wBAAwB,CAAC;AAGjF,OAAO,EAAE,kCAAkC,EAAE,MAAM,yCAAyC,CAAC;AAC7F,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAGvD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D;;;GAGG;AACH,MAAM,OAAO,uCAAuC;IACnD;;OAEG;IACI,MAAM,CAAU,UAAU,6CAA6D;IAE9F;;;OAGG;IACc,mBAAmB,CAAqC;IAEzE;;OAEG;IACH;QACC,IAAI,CAAC,mBAAmB,GAAG,IAAI,kCAAkC,EAAE,CAAC;IACrE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,qBAAqB,CACjC,iBAAoC,EACpC,aAAyC,EACzC,YAA0E;QAE1E,MAAM,CAAC,MAAM,CACZ,uCAAuC,CAAC,UAAU,uBAElD,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,uCAAuC,CAAC,UAAU,mBAElD,aAAa,CACb,CAAC;QACF,MAAM,CAAC,QAAQ,CACd,uCAAuC,CAAC,UAAU,kBAElD,YAAY,CACZ,CAAC;QAEF,MAAM,sBAAsB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAErE,sBAAsB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,eAAe,CACnE,sBAAsB,CAAC,UAAU,CAAC,EAClC,WAAW,CAAC,sBAAsB,CAClC,CAAC;QAEF,2CAA2C;QAC3C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAErE,2DAA2D;QAC3D,oHAAoH;QAEpH,uDAAuD;QACvD,MAAM,MAAM,GAAG;YACd,GAAG,EAAE,OAAO;YACZ,IAAI,EAAE,CAAC,KAAK,CAAC;YACb,GAAG,EAAE,KAAK;SACV,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1C,MAAM,YAAY,GAAG,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;QAEnF,oFAAoF;QACpF,MAAM,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG,YAAY,GAAG,CAAC,CAAC;QAC/D,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QACrE,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QAChC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QAE1C,uDAAuD;QACvD,0CAA0C;QAC1C,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,UAAU,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;QAEtE,gFAAgF;QAChF,MAAM,eAAe,GAAG,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAC9D,MAAM,GAAG,GAAG,GAAG,YAAY,KAAK,eAAe,EAAE,CAAC;QAElD,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAEtD,WAAW,CAAC,UAAU,CAAC,GAAG,sBAAsB,CAC/C,UAAU,CACgC,CAAC;QAE5C,WAAW,CAAC,GAAG,GAAG,GAAG,CAAC;QAEtB,OAAO,WAAW,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,eAAkC,EAClC,WAAuC,EACvC,SAAe;QAEf,kFAAkF;QAClF,OAAO,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,eAAe,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IACtF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CACtB,iBAAoC,EACpC,aAAyC;QAEzC,sCAAsC;QACtC,OAAO,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;IAC9E,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Converter, Guards, ObjectHelper } from \"@twin.org/core\";\nimport { JsonLdProcessor, type IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IJwk } from \"@twin.org/web\";\nimport { JsonWebSignature2020SignerVerifier } from \"./jsonWebSignature2020SignerVerifier.js\";\nimport { DidContexts } from \"../models/didContexts.js\";\nimport type { IJsonWebSignature2020Proof } from \"../models/IJsonWebSignature2020Proof.js\";\nimport type { IProofSignerVerifierAsync } from \"../models/IProofSignerVerifierAsync.js\";\nimport { JwsAlgorithms } from \"../models/jwsAlgorithms.js\";\n\n/**\n * Helper methods for creating and verifying JsonWebSignature2020 proofs with async signing callbacks.\n * This implementation creates JWS signatures manually per RFC 7515 to support async signing callbacks.\n */\nexport class JsonWebSignature2020AsyncSignerVerifier implements IProofSignerVerifierAsync {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<JsonWebSignature2020AsyncSignerVerifier>();\n\n\t/**\n\t * The underlying sync signer verifier for hash and verify operations.\n\t * @internal\n\t */\n\tprivate readonly _syncSignerVerifier: JsonWebSignature2020SignerVerifier;\n\n\t/**\n\t * Create a new instance of JsonWebSignature2020AsyncSignerVerifier.\n\t */\n\tconstructor() {\n\t\tthis._syncSignerVerifier = new JsonWebSignature2020SignerVerifier();\n\t}\n\n\t/**\n\t * Create a proof with an async signing callback.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The proof options.\n\t * @param signCallback Async callback that signs data with a private key from secure storage.\n\t * @returns The created proof.\n\t */\n\tpublic async createProofWithSigner(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IJsonWebSignature2020Proof,\n\t\tsignCallback: (data: Uint8Array, algorithm: string) => Promise<Uint8Array>\n\t): Promise<IJsonWebSignature2020Proof> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tJsonWebSignature2020AsyncSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonWebSignature2020Proof>(\n\t\t\tJsonWebSignature2020AsyncSignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof),\n\t\t\tunsignedProof\n\t\t);\n\t\tGuards.function(\n\t\t\tJsonWebSignature2020AsyncSignerVerifier.CLASS_NAME,\n\t\t\tnameof(signCallback),\n\t\t\tsignCallback\n\t\t);\n\n\t\tconst unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);\n\n\t\tunsecuredDocumentClone[\"@context\"] = JsonLdProcessor.combineContexts(\n\t\t\tunsecuredDocumentClone[\"@context\"],\n\t\t\tDidContexts.ContextSecurityJws2020\n\t\t);\n\n\t\t// Use the sync verifier to create the hash\n\t\tconst hash = await this.createHash(unsecuredDocument, unsignedProof);\n\n\t\t// Create JWS manually per RFC 7515 (Compact Serialization)\n\t\t// Format: BASE64URL(UTF8(JWS Protected Header)) || '.' || BASE64URL(JWS Payload) || '.' || BASE64URL(JWS Signature)\n\n\t\t// JWS Protected Header for EdDSA with detached payload\n\t\tconst header = {\n\t\t\talg: \"EdDSA\",\n\t\t\tcrit: [\"b64\"],\n\t\t\tb64: false\n\t\t};\n\n\t\tconst headerJson = JSON.stringify(header);\n\t\tconst headerBase64 = Converter.bytesToBase64Url(Converter.utf8ToBytes(headerJson));\n\n\t\t// Create signing input: header.payload (detached payload means payload is the hash)\n\t\tconst signingInput = Converter.utf8ToBytes(`${headerBase64}.`);\n\t\tconst dataToSign = new Uint8Array(signingInput.length + hash.length);\n\t\tdataToSign.set(signingInput, 0);\n\t\tdataToSign.set(hash, signingInput.length);\n\n\t\t// Sign with the callback (key stays in secure storage)\n\t\t// Pass JWS algorithm for vault validation\n\t\tconst signature = await signCallback(dataToSign, JwsAlgorithms.EdDSA);\n\n\t\t// Construct JWS: header..signature (empty payload section for detached content)\n\t\tconst signatureBase64 = Converter.bytesToBase64Url(signature);\n\t\tconst jws = `${headerBase64}..${signatureBase64}`;\n\n\t\tconst signedProof = ObjectHelper.clone(unsignedProof);\n\n\t\tsignedProof[\"@context\"] = unsecuredDocumentClone[\n\t\t\t\"@context\"\n\t\t] as IJsonWebSignature2020Proof[\"@context\"];\n\n\t\tsignedProof.jws = jws;\n\n\t\treturn signedProof;\n\t}\n\n\t/**\n\t * Verify a proof for the given data.\n\t * @param securedDocument The credential to verify.\n\t * @param signedProof The proof to verify.\n\t * @param verifyKey The public key to verify the proof with.\n\t * @returns True if the credential was verified.\n\t */\n\tpublic async verifyProof(\n\t\tsecuredDocument: IJsonLdNodeObject,\n\t\tsignedProof: IJsonWebSignature2020Proof,\n\t\tverifyKey: IJwk\n\t): Promise<boolean> {\n\t\t// Delegate to the sync implementation (verification doesn't need the private key)\n\t\treturn this._syncSignerVerifier.verifyProof(securedDocument, signedProof, verifyKey);\n\t}\n\n\t/**\n\t * Create a hash for the given data.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The unsigned proof.\n\t * @returns The created hash.\n\t */\n\tpublic async createHash(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IJsonWebSignature2020Proof\n\t): Promise<Uint8Array> {\n\t\t// Delegate to the sync implementation\n\t\treturn this._syncSignerVerifier.createHash(unsecuredDocument, unsignedProof);\n\t}\n}\n"]}

package/dist/es/signerVerifiers/jsonWebSignature2020SignerVerifier.js

@@ -6,7 +6,8 @@ import { JsonLdProcessor } from "@twin.org/data-json-ld";
 import { Jwk, Jws } from "@twin.org/web";
 import { DidContexts } from "../models/didContexts.js";
 /**
- * Helper methods for creating and verifying proofs.
+ * Helper methods for creating and verifying JsonWebSignature2020 proofs.
+ * @see https://w3c-ccg.github.io/lds-jws2020/
  */
 export class JsonWebSignature2020SignerVerifier {
     /**
@@ -35,7 +36,7 @@ export class JsonWebSignature2020SignerVerifier {
         return signedProof;
     }
     /**
-     * Verify a proof for the given data in format.
+     * Verify a proof for the given data.
      * @param securedDocument The credential to verify.
      * @param signedProof The proof to verify.
      * @param verifyKey The public key to verify the proof with.

package/dist/es/signerVerifiers/jsonWebSignature2020SignerVerifier.js.map

@@ -1 +1 @@
-{"version":3,"file":"jsonWebSignature2020SignerVerifier.js","sourceRoot":"","sources":["../../../src/signerVerifiers/jsonWebSignature2020SignerVerifier.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,SAAS,EACT,YAAY,EACZ,MAAM,EACN,EAAE,EACF,YAAY,EACZ,gBAAgB,EAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,eAAe,EAA0B,MAAM,wBAAwB,CAAC;AAEjF,OAAO,EAAE,GAAG,EAAE,GAAG,EAAa,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAIvD;;GAEG;AACH,MAAM,OAAO,kCAAkC;IAC9C;;OAEG;IACI,MAAM,CAAU,UAAU,wCAAwD;IAEzF;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,iBAAoC,EACpC,aAAyC,EACzC,OAAa;QAEb,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,uBAE7C,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,mBAE7C,aAAa,CACb,CAAC;QACF,MAAM,CAAC,MAAM,CAAO,kCAAkC,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAE7F,MAAM,sBAAsB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAErE,sBAAsB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,eAAe,CACnE,sBAAsB,CAAC,UAAU,CAAC,EAClC,WAAW,CAAC,sBAAsB,CAClC,CAAC;QAEF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAErE,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEjD,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QAEjE,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAEtD,WAAW,CAAC,UAAU,CAAC,GAAG,sBAAsB,CAC/C,UAAU,CACgC,CAAC;QAE5C,WAAW,CAAC,GAAG,GAAG,SAAS,CAAC;QAE5B,OAAO,WAAW,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,eAAkC,EAClC,WAAuC,EACvC,SAAe;QAEf,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,qBAE7C,eAAe,CACf,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,iBAE7C,WAAW,CACX,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,eAE7C,SAAS,CACT,CAAC;QACF,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC;QAC5B,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,YAAY,CAAC,kCAAkC,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QACrF,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;QAEjE,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAEnD,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CACtB,iBAAoC,EACpC,aAAyC;QAEzC,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,uBAE7C,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,mBAE7C,aAAa,CACb,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,kCAAkC,CAAC,UAAU,sCAE7C,aAAa,CAAC,kBAAkB,CAChC,CAAC;QACF,MAAM,sBAAsB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrE,MAAM,iBAAiB,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAE5D,sBAAsB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,eAAe,CACnE,sBAAsB,CAAC,UAAU,CAAC,EAClC,WAAW,CAAC,sBAAsB,CAClC,CAAC;QAEF,iBAAiB,CAAC,UAAU,CAAC,GAAG,sBAAsB,CACrD,UAAU,CACgC,CAAC;QAE5C,OAAO,sBAAsB,CAAC,KAAK,CAAC;QACpC,OAAO,iBAAiB,CAAC,GAAG,CAAC;QAE7B,MAAM,aAAa,GAAW,MAAM,eAAe,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC;QACrF,MAAM,cAAc,GAAW,MAAM,eAAe,CAAC,QAAQ,CAC5D,iBAAiD,CACjD,CAAC;QAEF,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;QACzE,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC;QAEvE,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;IAC3D,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tConverter,\n\tGeneralError,\n\tGuards,\n\tIs,\n\tObjectHelper,\n\tUint8ArrayHelper\n} from \"@twin.org/core\";\nimport { Sha256 } from \"@twin.org/crypto\";\nimport { JsonLdProcessor, type IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { Jwk, Jws, type IJwk } from \"@twin.org/web\";\nimport { DidContexts } from \"../models/didContexts.js\";\nimport type { IJsonWebSignature2020Proof } from \"../models/IJsonWebSignature2020Proof.js\";\nimport type { IProofSignerVerifier } from \"../models/IProofSignerVerifier.js\";\n\n/**\n * Helper methods for creating and verifying proofs.\n */\nexport class JsonWebSignature2020SignerVerifier implements IProofSignerVerifier {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<JsonWebSignature2020SignerVerifier>();\n\n\t/**\n\t * Create a proof for the given data.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The proof options.\n\t * @param signKey The key to sign the proof with.\n\t * @returns The created proof.\n\t */\n\tpublic async createProof(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IJsonWebSignature2020Proof,\n\t\tsignKey: IJwk\n\t): Promise<IJsonWebSignature2020Proof> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonWebSignature2020Proof>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof),\n\t\t\tunsignedProof\n\t\t);\n\t\tGuards.object<IJwk>(JsonWebSignature2020SignerVerifier.CLASS_NAME, nameof(signKey), signKey);\n\n\t\tconst unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);\n\n\t\tunsecuredDocumentClone[\"@context\"] = JsonLdProcessor.combineContexts(\n\t\t\tunsecuredDocumentClone[\"@context\"],\n\t\t\tDidContexts.ContextSecurityJws2020\n\t\t);\n\n\t\tconst hash = await this.createHash(unsecuredDocument, unsignedProof);\n\n\t\tconst cryptoKey = await Jwk.toCryptoKey(signKey);\n\n\t\tconst signature = await Jws.create(cryptoKey, hash, signKey.alg);\n\n\t\tconst signedProof = ObjectHelper.clone(unsignedProof);\n\n\t\tsignedProof[\"@context\"] = unsecuredDocumentClone[\n\t\t\t\"@context\"\n\t\t] as IJsonWebSignature2020Proof[\"@context\"];\n\n\t\tsignedProof.jws = signature;\n\n\t\treturn signedProof;\n\t}\n\n\t/**\n\t * Verify a proof for the given data in format.\n\t * @param securedDocument The credential to verify.\n\t * @param signedProof The proof to verify.\n\t * @param verifyKey The public key to verify the proof with.\n\t * @returns True if the credential was verified.\n\t */\n\tpublic async verifyProof(\n\t\tsecuredDocument: IJsonLdNodeObject,\n\t\tsignedProof: IJsonWebSignature2020Proof,\n\t\tverifyKey: IJwk\n\t): Promise<boolean> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(securedDocument),\n\t\t\tsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonWebSignature2020Proof>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(signedProof),\n\t\t\tsignedProof\n\t\t);\n\t\tGuards.object<IJwk>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(verifyKey),\n\t\t\tverifyKey\n\t\t);\n\t\tconst jws = signedProof.jws;\n\t\tif (!Is.stringValue(jws)) {\n\t\t\tthrow new GeneralError(JsonWebSignature2020SignerVerifier.CLASS_NAME, \"missingJws\");\n\t\t}\n\n\t\tconst hash = await this.createHash(securedDocument, signedProof);\n\n\t\tconst cryptoKey = await Jwk.toCryptoKey(verifyKey);\n\n\t\treturn Jws.verify(jws, cryptoKey, hash);\n\t}\n\n\t/**\n\t * Create a hash for the given data.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The unsigned proof.\n\t * @returns The created hash.\n\t */\n\tpublic async createHash(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IJsonWebSignature2020Proof\n\t): Promise<Uint8Array> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonWebSignature2020Proof>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof),\n\t\t\tunsignedProof\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof.verificationMethod),\n\t\t\tunsignedProof.verificationMethod\n\t\t);\n\t\tconst unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);\n\t\tconst proofOptionsClone = ObjectHelper.clone(unsignedProof);\n\n\t\tunsecuredDocumentClone[\"@context\"] = JsonLdProcessor.combineContexts(\n\t\t\tunsecuredDocumentClone[\"@context\"],\n\t\t\tDidContexts.ContextSecurityJws2020\n\t\t);\n\n\t\tproofOptionsClone[\"@context\"] = unsecuredDocumentClone[\n\t\t\t\"@context\"\n\t\t] as IJsonWebSignature2020Proof[\"@context\"];\n\n\t\tdelete unsecuredDocumentClone.proof;\n\t\tdelete proofOptionsClone.jws;\n\n\t\tconst canonizedData: string = await JsonLdProcessor.canonize(unsecuredDocumentClone);\n\t\tconst canonizedProof: string = await JsonLdProcessor.canonize(\n\t\t\tproofOptionsClone as unknown as IJsonLdNodeObject\n\t\t);\n\n\t\tconst hashedProof = Sha256.sum256(Converter.utf8ToBytes(canonizedProof));\n\t\tconst hashedData = Sha256.sum256(Converter.utf8ToBytes(canonizedData));\n\n\t\treturn Uint8ArrayHelper.concat([hashedProof, hashedData]);\n\t}\n}\n"]}
+{"version":3,"file":"jsonWebSignature2020SignerVerifier.js","sourceRoot":"","sources":["../../../src/signerVerifiers/jsonWebSignature2020SignerVerifier.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,SAAS,EACT,YAAY,EACZ,MAAM,EACN,EAAE,EACF,YAAY,EACZ,gBAAgB,EAChB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,eAAe,EAA0B,MAAM,wBAAwB,CAAC;AAEjF,OAAO,EAAE,GAAG,EAAE,GAAG,EAAa,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAIvD;;;GAGG;AACH,MAAM,OAAO,kCAAkC;IAC9C;;OAEG;IACI,MAAM,CAAU,UAAU,wCAAwD;IAEzF;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,iBAAoC,EACpC,aAAyC,EACzC,OAAa;QAEb,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,uBAE7C,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,mBAE7C,aAAa,CACb,CAAC;QACF,MAAM,CAAC,MAAM,CAAO,kCAAkC,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAE7F,MAAM,sBAAsB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAErE,sBAAsB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,eAAe,CACnE,sBAAsB,CAAC,UAAU,CAAC,EAClC,WAAW,CAAC,sBAAsB,CAClC,CAAC;QAEF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAErE,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEjD,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QAEjE,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAEtD,WAAW,CAAC,UAAU,CAAC,GAAG,sBAAsB,CAC/C,UAAU,CACgC,CAAC;QAE5C,WAAW,CAAC,GAAG,GAAG,SAAS,CAAC;QAE5B,OAAO,WAAW,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,eAAkC,EAClC,WAAuC,EACvC,SAAe;QAEf,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,qBAE7C,eAAe,CACf,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,iBAE7C,WAAW,CACX,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,eAE7C,SAAS,CACT,CAAC;QACF,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC;QAC5B,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,YAAY,CAAC,kCAAkC,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QACrF,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;QAEjE,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAEnD,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CACtB,iBAAoC,EACpC,aAAyC;QAEzC,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,uBAE7C,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kCAAkC,CAAC,UAAU,mBAE7C,aAAa,CACb,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,kCAAkC,CAAC,UAAU,sCAE7C,aAAa,CAAC,kBAAkB,CAChC,CAAC;QACF,MAAM,sBAAsB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrE,MAAM,iBAAiB,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAE5D,sBAAsB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC,eAAe,CACnE,sBAAsB,CAAC,UAAU,CAAC,EAClC,WAAW,CAAC,sBAAsB,CAClC,CAAC;QAEF,iBAAiB,CAAC,UAAU,CAAC,GAAG,sBAAsB,CACrD,UAAU,CACgC,CAAC;QAE5C,OAAO,sBAAsB,CAAC,KAAK,CAAC;QACpC,OAAO,iBAAiB,CAAC,GAAG,CAAC;QAE7B,MAAM,aAAa,GAAW,MAAM,eAAe,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC;QACrF,MAAM,cAAc,GAAW,MAAM,eAAe,CAAC,QAAQ,CAC5D,iBAAiD,CACjD,CAAC;QAEF,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;QACzE,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC;QAEvE,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;IAC3D,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tConverter,\n\tGeneralError,\n\tGuards,\n\tIs,\n\tObjectHelper,\n\tUint8ArrayHelper\n} from \"@twin.org/core\";\nimport { Sha256 } from \"@twin.org/crypto\";\nimport { JsonLdProcessor, type IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { Jwk, Jws, type IJwk } from \"@twin.org/web\";\nimport { DidContexts } from \"../models/didContexts.js\";\nimport type { IJsonWebSignature2020Proof } from \"../models/IJsonWebSignature2020Proof.js\";\nimport type { IProofSignerVerifier } from \"../models/IProofSignerVerifier.js\";\n\n/**\n * Helper methods for creating and verifying JsonWebSignature2020 proofs.\n * @see https://w3c-ccg.github.io/lds-jws2020/\n */\nexport class JsonWebSignature2020SignerVerifier implements IProofSignerVerifier {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<JsonWebSignature2020SignerVerifier>();\n\n\t/**\n\t * Create a proof for the given data.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The proof options.\n\t * @param signKey The key to sign the proof with.\n\t * @returns The created proof.\n\t */\n\tpublic async createProof(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IJsonWebSignature2020Proof,\n\t\tsignKey: IJwk\n\t): Promise<IJsonWebSignature2020Proof> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonWebSignature2020Proof>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof),\n\t\t\tunsignedProof\n\t\t);\n\t\tGuards.object<IJwk>(JsonWebSignature2020SignerVerifier.CLASS_NAME, nameof(signKey), signKey);\n\n\t\tconst unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);\n\n\t\tunsecuredDocumentClone[\"@context\"] = JsonLdProcessor.combineContexts(\n\t\t\tunsecuredDocumentClone[\"@context\"],\n\t\t\tDidContexts.ContextSecurityJws2020\n\t\t);\n\n\t\tconst hash = await this.createHash(unsecuredDocument, unsignedProof);\n\n\t\tconst cryptoKey = await Jwk.toCryptoKey(signKey);\n\n\t\tconst signature = await Jws.create(cryptoKey, hash, signKey.alg);\n\n\t\tconst signedProof = ObjectHelper.clone(unsignedProof);\n\n\t\tsignedProof[\"@context\"] = unsecuredDocumentClone[\n\t\t\t\"@context\"\n\t\t] as IJsonWebSignature2020Proof[\"@context\"];\n\n\t\tsignedProof.jws = signature;\n\n\t\treturn signedProof;\n\t}\n\n\t/**\n\t * Verify a proof for the given data.\n\t * @param securedDocument The credential to verify.\n\t * @param signedProof The proof to verify.\n\t * @param verifyKey The public key to verify the proof with.\n\t * @returns True if the credential was verified.\n\t */\n\tpublic async verifyProof(\n\t\tsecuredDocument: IJsonLdNodeObject,\n\t\tsignedProof: IJsonWebSignature2020Proof,\n\t\tverifyKey: IJwk\n\t): Promise<boolean> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(securedDocument),\n\t\t\tsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonWebSignature2020Proof>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(signedProof),\n\t\t\tsignedProof\n\t\t);\n\t\tGuards.object<IJwk>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(verifyKey),\n\t\t\tverifyKey\n\t\t);\n\t\tconst jws = signedProof.jws;\n\t\tif (!Is.stringValue(jws)) {\n\t\t\tthrow new GeneralError(JsonWebSignature2020SignerVerifier.CLASS_NAME, \"missingJws\");\n\t\t}\n\n\t\tconst hash = await this.createHash(securedDocument, signedProof);\n\n\t\tconst cryptoKey = await Jwk.toCryptoKey(verifyKey);\n\n\t\treturn Jws.verify(jws, cryptoKey, hash);\n\t}\n\n\t/**\n\t * Create a hash for the given data.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The unsigned proof.\n\t * @returns The created hash.\n\t */\n\tpublic async createHash(\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IJsonWebSignature2020Proof\n\t): Promise<Uint8Array> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonWebSignature2020Proof>(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof),\n\t\t\tunsignedProof\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tJsonWebSignature2020SignerVerifier.CLASS_NAME,\n\t\t\tnameof(unsignedProof.verificationMethod),\n\t\t\tunsignedProof.verificationMethod\n\t\t);\n\t\tconst unsecuredDocumentClone = ObjectHelper.clone(unsecuredDocument);\n\t\tconst proofOptionsClone = ObjectHelper.clone(unsignedProof);\n\n\t\tunsecuredDocumentClone[\"@context\"] = JsonLdProcessor.combineContexts(\n\t\t\tunsecuredDocumentClone[\"@context\"],\n\t\t\tDidContexts.ContextSecurityJws2020\n\t\t);\n\n\t\tproofOptionsClone[\"@context\"] = unsecuredDocumentClone[\n\t\t\t\"@context\"\n\t\t] as IJsonWebSignature2020Proof[\"@context\"];\n\n\t\tdelete unsecuredDocumentClone.proof;\n\t\tdelete proofOptionsClone.jws;\n\n\t\tconst canonizedData: string = await JsonLdProcessor.canonize(unsecuredDocumentClone);\n\t\tconst canonizedProof: string = await JsonLdProcessor.canonize(\n\t\t\tproofOptionsClone as unknown as IJsonLdNodeObject\n\t\t);\n\n\t\tconst hashedProof = Sha256.sum256(Converter.utf8ToBytes(canonizedProof));\n\t\tconst hashedData = Sha256.sum256(Converter.utf8ToBytes(canonizedData));\n\n\t\treturn Uint8ArrayHelper.concat([hashedProof, hashedData]);\n\t}\n}\n"]}

package/dist/es/utils/proofHelper.js

@@ -4,7 +4,9 @@ import { GeneralError, Guards, Is } from "@twin.org/core";
 import { DidContexts } from "../models/didContexts.js";
 import { DidCryptoSuites } from "../models/didCryptoSuites.js";
 import { ProofTypes } from "../models/proofTypes.js";
+import { DataIntegrityProofAsyncSignerVerifier } from "../signerVerifiers/dataIntegrityProofAsyncSignerVerifier.js";
 import { DataIntegrityProofSignerVerifier } from "../signerVerifiers/dataIntegrityProofSignerVerifier.js";
+import { JsonWebSignature2020AsyncSignerVerifier } from "../signerVerifiers/jsonWebSignature2020AsyncSignerVerifier.js";
 import { JsonWebSignature2020SignerVerifier } from "../signerVerifiers/jsonWebSignature2020SignerVerifier.js";
 /**
  * Helper methods for creating and verifying proofs.
@@ -34,6 +36,27 @@ export class ProofHelper {
         }
         return signerVerifier;
     }
+    /**
+     * Create an async signer verifier that supports signing with callbacks.
+     * This enables signing without exposing private keys.
+     * @param proofType The type of proof to create.
+     * @returns The created async signer verifier.
+     * @throws GeneralError if the proof type is not supported.
+     */
+    static createAsyncSignerVerifier(proofType) {
+        Guards.arrayOneOf(ProofHelper.CLASS_NAME, "proofType", proofType, Object.values(ProofTypes));
+        let signerVerifier;
+        if (proofType === ProofTypes.DataIntegrityProof) {
+            signerVerifier = new DataIntegrityProofAsyncSignerVerifier();
+        }
+        else if (proofType === ProofTypes.JsonWebSignature2020) {
+            signerVerifier = new JsonWebSignature2020AsyncSignerVerifier();
+        }
+        if (Is.empty(signerVerifier)) {
+            throw new GeneralError(ProofHelper.CLASS_NAME, "unsupportedProofType", { proofType });
+        }
+        return signerVerifier;
+    }
     /**
      * Create a proof for the given data.
      * @param proofType The type of proof to create.
@@ -49,6 +72,22 @@ export class ProofHelper {
         Guards.object(ProofHelper.CLASS_NAME, "signKey", signKey);
         return ProofHelper.createSignerVerifier(proofType).createProof(unsecuredDocument, unsignedProof, signKey);
     }
+    /**
+     * Create a proof with an async signing callback.
+     * This method prevents private key exposure by delegating signing to a secure callback.
+     * @param proofType The type of proof to create.
+     * @param unsecuredDocument The data to create the proof for.
+     * @param unsignedProof The proof options.
+     * @param signCallback Async callback that signs data with a private key from secure storage. The algorithm parameter indicates the expected signing algorithm (e.g., "EdDSA") to enable validation.
+     * @returns The created proof.
+     */
+    static async createProofWithSigner(proofType, unsecuredDocument, unsignedProof, signCallback) {
+        Guards.arrayOneOf(ProofHelper.CLASS_NAME, "proofType", proofType, Object.values(ProofTypes));
+        Guards.object(ProofHelper.CLASS_NAME, "unsecuredDocument", unsecuredDocument);
+        Guards.object(ProofHelper.CLASS_NAME, "unsignedProof", unsignedProof);
+        Guards.function(ProofHelper.CLASS_NAME, "signCallback", signCallback);
+        return ProofHelper.createAsyncSignerVerifier(proofType).createProofWithSigner(unsecuredDocument, unsignedProof, signCallback);
+    }
     /**
      * Verify a proof for the given data.
      * @param securedDocument The credential to verify.

package/dist/es/utils/proofHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"proofHelper.js","sourceRoot":"","sources":["../../../src/utils/proofHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAI1D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAG/D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,gCAAgC,EAAE,MAAM,wDAAwD,CAAC;AAC1G,OAAO,EAAE,kCAAkC,EAAE,MAAM,0DAA0D,CAAC;AAE9G;;GAEG;AACH,MAAM,OAAO,WAAW;IACvB;;OAEG;IACI,MAAM,CAAU,UAAU,iBAAiC;IAElE;;;;;OAKG;IACI,MAAM,CAAC,oBAAoB,CAAC,SAAqB;QACvD,MAAM,CAAC,UAAU,CAChB,WAAW,CAAC,UAAU,eAEtB,SAAS,EACT,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CACzB,CAAC;QAEF,IAAI,cAAgD,CAAC;QACrD,IAAI,SAAS,KAAK,UAAU,CAAC,kBAAkB,EAAE,CAAC;YACjD,cAAc,GAAG,IAAI,gCAAgC,EAAE,CAAC;QACzD,CAAC;aAAM,IAAI,SAAS,KAAK,UAAU,CAAC,oBAAoB,EAAE,CAAC;YAC1D,cAAc,GAAG,IAAI,kCAAkC,EAAE,CAAC;QAC3D,CAAC;QAED,IAAI,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,YAAY,CAAC,WAAW,CAAC,UAAU,EAAE,sBAAsB,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,cAAc,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAC9B,SAAqB,EACrB,iBAAoC,EACpC,aAAqB,EACrB,OAAa;QAEb,MAAM,CAAC,UAAU,CAChB,WAAW,CAAC,UAAU,eAEtB,SAAS,EACT,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CACzB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,WAAW,CAAC,UAAU,uBAEtB,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CAAoB,WAAW,CAAC,UAAU,mBAAyB,aAAa,CAAC,CAAC;QAC/F,MAAM,CAAC,MAAM,CAAO,WAAW,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QACtE,OAAO,WAAW,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,WAAW,CAC7D,iBAAiD,EACjD,aAAa,EACb,OAAO,CACP,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAC9B,eAAkC,EAClC,WAAmB,EACnB,SAAe;QAEf,MAAM,CAAC,MAAM,CACZ,WAAW,CAAC,UAAU,qBAEtB,eAAe,CACf,CAAC;QACF,MAAM,CAAC,MAAM,CAAoB,WAAW,CAAC,UAAU,iBAAuB,WAAW,CAAC,CAAC;QAC3F,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,UAAU,sBAA4B,WAAW,CAAC,IAAI,CAAC,CAAC;QACvF,MAAM,CAAC,MAAM,CAAO,WAAW,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAE1E,MAAM,cAAc,GAAG,WAAW,CAAC,oBAAoB,CAAC,WAAW,CAAC,IAAkB,CAAC,CAAC;QAExF,OAAO,cAAc,CAAC,WAAW,CAAC,eAAe,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,mBAAmB,CAChC,SAAqB,EACrB,oBAA4B;IAC5B,8DAA8D;IAC9D,WAAiB;QAEjB,IAAI,KAAyB,CAAC;QAC9B,IAAI,SAAS,KAAK,UAAU,CAAC,kBAAkB,EAAE,CAAC;YACjD,KAAK,GAAG;gBACP,UAAU,EAAE,WAAW,CAAC,oBAAoB;gBAC5C,IAAI,EAAE,UAAU,CAAC,kBAAkB;gBACnC,WAAW,EAAE,eAAe,CAAC,YAAY;gBACzC,OAAO,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE;gBAC3C,kBAAkB,EAAE,oBAAoB;gBACxC,YAAY,EAAE,iBAAiB;gBAC/B,GAAG,WAAW;aACd,CAAC;QACH,CAAC;aAAM,IAAI,SAAS,KAAK,UAAU,CAAC,oBAAoB,EAAE,CAAC;YAC1D,KAAK,GAAG;gBACP,UAAU,EAAE,WAAW,CAAC,sBAAsB;gBAC9C,IAAI,EAAE,UAAU,CAAC,oBAAoB;gBACrC,OAAO,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE;gBAC3C,kBAAkB,EAAE,oBAAoB;gBACxC,YAAY,EAAE,iBAAiB;gBAC/B,GAAG,WAAW;aACd,CAAC;QACH,CAAC;QACD,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,YAAY,CAAC,WAAW,CAAC,UAAU,EAAE,sBAAsB,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Is } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IJwk } from \"@twin.org/web\";\nimport { DidContexts } from \"../models/didContexts.js\";\nimport { DidCryptoSuites } from \"../models/didCryptoSuites.js\";\nimport type { IProof } from \"../models/IProof.js\";\nimport type { IProofSignerVerifier } from \"../models/IProofSignerVerifier.js\";\nimport { ProofTypes } from \"../models/proofTypes.js\";\nimport { DataIntegrityProofSignerVerifier } from \"../signerVerifiers/dataIntegrityProofSignerVerifier.js\";\nimport { JsonWebSignature2020SignerVerifier } from \"../signerVerifiers/jsonWebSignature2020SignerVerifier.js\";\n\n/**\n * Helper methods for creating and verifying proofs.\n */\nexport class ProofHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ProofHelper>();\n\n\t/**\n\t * Create a signer verifier.\n\t * @param proofType The type of proof to create.\n\t * @returns The created signer verifier.\n\t * @throws GeneralError if the proof type is not supported.\n\t */\n\tpublic static createSignerVerifier(proofType: ProofTypes): IProofSignerVerifier {\n\t\tGuards.arrayOneOf(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(proofType),\n\t\t\tproofType,\n\t\t\tObject.values(ProofTypes)\n\t\t);\n\n\t\tlet signerVerifier: IProofSignerVerifier | undefined;\n\t\tif (proofType === ProofTypes.DataIntegrityProof) {\n\t\t\tsignerVerifier = new DataIntegrityProofSignerVerifier();\n\t\t} else if (proofType === ProofTypes.JsonWebSignature2020) {\n\t\t\tsignerVerifier = new JsonWebSignature2020SignerVerifier();\n\t\t}\n\n\t\tif (Is.empty(signerVerifier)) {\n\t\t\tthrow new GeneralError(ProofHelper.CLASS_NAME, \"unsupportedProofType\", { proofType });\n\t\t}\n\t\treturn signerVerifier;\n\t}\n\n\t/**\n\t * Create a proof for the given data.\n\t * @param proofType The type of proof to create.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The proof options.\n\t * @param signKey The key to sign the proof with.\n\t * @returns The created proof.\n\t */\n\tpublic static async createProof(\n\t\tproofType: ProofTypes,\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IProof,\n\t\tsignKey: IJwk\n\t): Promise<IProof> {\n\t\tGuards.arrayOneOf(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(proofType),\n\t\t\tproofType,\n\t\t\tObject.values(ProofTypes)\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(ProofHelper.CLASS_NAME, nameof(unsignedProof), unsignedProof);\n\t\tGuards.object<IJwk>(ProofHelper.CLASS_NAME, nameof(signKey), signKey);\n\t\treturn ProofHelper.createSignerVerifier(proofType).createProof(\n\t\t\tunsecuredDocument as unknown as IJsonLdNodeObject,\n\t\t\tunsignedProof,\n\t\t\tsignKey\n\t\t);\n\t}\n\n\t/**\n\t * Verify a proof for the given data.\n\t * @param securedDocument The credential to verify.\n\t * @param signedProof The proof to verify.\n\t * @param verifyKey The public key to verify the proof with.\n\t * @returns True if the credential was verified.\n\t */\n\tpublic static async verifyProof(\n\t\tsecuredDocument: IJsonLdNodeObject,\n\t\tsignedProof: IProof,\n\t\tverifyKey: IJwk\n\t): Promise<boolean> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(securedDocument),\n\t\t\tsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(ProofHelper.CLASS_NAME, nameof(signedProof), signedProof);\n\t\tGuards.stringValue(ProofHelper.CLASS_NAME, nameof(signedProof.type), signedProof.type);\n\t\tGuards.object<IJwk>(ProofHelper.CLASS_NAME, nameof(verifyKey), verifyKey);\n\n\t\tconst signerVerifier = ProofHelper.createSignerVerifier(signedProof.type as ProofTypes);\n\n\t\treturn signerVerifier.verifyProof(securedDocument, signedProof, verifyKey);\n\t}\n\n\t/**\n\t * Create an unsigned proof.\n\t * @param proofType The type of proof to create.\n\t * @param verificationMethodId The verification method id.\n\t * @param otherParams Other parameters for the proof.\n\t * @returns The created proof.\n\t * @throws GeneralError if the proof type is not supported.\n\t */\n\tpublic static createUnsignedProof(\n\t\tproofType: ProofTypes,\n\t\tverificationMethodId: string,\n\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\totherParams?: any\n\t): IProof {\n\t\tlet proof: IProof | undefined;\n\t\tif (proofType === ProofTypes.DataIntegrityProof) {\n\t\t\tproof = {\n\t\t\t\t\"@context\": DidContexts.ContextDataIntegrity,\n\t\t\t\ttype: ProofTypes.DataIntegrityProof,\n\t\t\t\tcryptosuite: DidCryptoSuites.EdDSAJcs2022,\n\t\t\t\tcreated: new Date(Date.now()).toISOString(),\n\t\t\t\tverificationMethod: verificationMethodId,\n\t\t\t\tproofPurpose: \"assertionMethod\",\n\t\t\t\t...otherParams\n\t\t\t};\n\t\t} else if (proofType === ProofTypes.JsonWebSignature2020) {\n\t\t\tproof = {\n\t\t\t\t\"@context\": DidContexts.ContextSecurityJws2020,\n\t\t\t\ttype: ProofTypes.JsonWebSignature2020,\n\t\t\t\tcreated: new Date(Date.now()).toISOString(),\n\t\t\t\tverificationMethod: verificationMethodId,\n\t\t\t\tproofPurpose: \"assertionMethod\",\n\t\t\t\t...otherParams\n\t\t\t};\n\t\t}\n\t\tif (Is.empty(proof)) {\n\t\t\tthrow new GeneralError(ProofHelper.CLASS_NAME, \"unsupportedProofType\", { proofType });\n\t\t}\n\t\treturn proof;\n\t}\n}\n"]}
+{"version":3,"file":"proofHelper.js","sourceRoot":"","sources":["../../../src/utils/proofHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAI1D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAI/D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,qCAAqC,EAAE,MAAM,6DAA6D,CAAC;AACpH,OAAO,EAAE,gCAAgC,EAAE,MAAM,wDAAwD,CAAC;AAC1G,OAAO,EAAE,uCAAuC,EAAE,MAAM,+DAA+D,CAAC;AACxH,OAAO,EAAE,kCAAkC,EAAE,MAAM,0DAA0D,CAAC;AAE9G;;GAEG;AACH,MAAM,OAAO,WAAW;IACvB;;OAEG;IACI,MAAM,CAAU,UAAU,iBAAiC;IAElE;;;;;OAKG;IACI,MAAM,CAAC,oBAAoB,CAAC,SAAqB;QACvD,MAAM,CAAC,UAAU,CAChB,WAAW,CAAC,UAAU,eAEtB,SAAS,EACT,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CACzB,CAAC;QAEF,IAAI,cAAgD,CAAC;QACrD,IAAI,SAAS,KAAK,UAAU,CAAC,kBAAkB,EAAE,CAAC;YACjD,cAAc,GAAG,IAAI,gCAAgC,EAAE,CAAC;QACzD,CAAC;aAAM,IAAI,SAAS,KAAK,UAAU,CAAC,oBAAoB,EAAE,CAAC;YAC1D,cAAc,GAAG,IAAI,kCAAkC,EAAE,CAAC;QAC3D,CAAC;QAED,IAAI,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,YAAY,CAAC,WAAW,CAAC,UAAU,EAAE,sBAAsB,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,cAAc,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,yBAAyB,CAAC,SAAqB;QAC5D,MAAM,CAAC,UAAU,CAChB,WAAW,CAAC,UAAU,eAEtB,SAAS,EACT,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CACzB,CAAC;QAEF,IAAI,cAAqD,CAAC;QAC1D,IAAI,SAAS,KAAK,UAAU,CAAC,kBAAkB,EAAE,CAAC;YACjD,cAAc,GAAG,IAAI,qCAAqC,EAAE,CAAC;QAC9D,CAAC;aAAM,IAAI,SAAS,KAAK,UAAU,CAAC,oBAAoB,EAAE,CAAC;YAC1D,cAAc,GAAG,IAAI,uCAAuC,EAAE,CAAC;QAChE,CAAC;QAED,IAAI,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,YAAY,CAAC,WAAW,CAAC,UAAU,EAAE,sBAAsB,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,cAAc,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAC9B,SAAqB,EACrB,iBAAoC,EACpC,aAAqB,EACrB,OAAa;QAEb,MAAM,CAAC,UAAU,CAChB,WAAW,CAAC,UAAU,eAEtB,SAAS,EACT,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CACzB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,WAAW,CAAC,UAAU,uBAEtB,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CAAoB,WAAW,CAAC,UAAU,mBAAyB,aAAa,CAAC,CAAC;QAC/F,MAAM,CAAC,MAAM,CAAO,WAAW,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QACtE,OAAO,WAAW,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,WAAW,CAC7D,iBAAiB,EACjB,aAAa,EACb,OAAO,CACP,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,qBAAqB,CACxC,SAAqB,EACrB,iBAAoC,EACpC,aAAqB,EACrB,YAA0E;QAE1E,MAAM,CAAC,UAAU,CAChB,WAAW,CAAC,UAAU,eAEtB,SAAS,EACT,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CACzB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,WAAW,CAAC,UAAU,uBAEtB,iBAAiB,CACjB,CAAC;QACF,MAAM,CAAC,MAAM,CAAoB,WAAW,CAAC,UAAU,mBAAyB,aAAa,CAAC,CAAC;QAC/F,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QAE5E,OAAO,WAAW,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAC5E,iBAAiB,EACjB,aAAa,EACb,YAAY,CACZ,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAC9B,eAAkC,EAClC,WAAmB,EACnB,SAAe;QAEf,MAAM,CAAC,MAAM,CACZ,WAAW,CAAC,UAAU,qBAEtB,eAAe,CACf,CAAC;QACF,MAAM,CAAC,MAAM,CAAoB,WAAW,CAAC,UAAU,iBAAuB,WAAW,CAAC,CAAC;QAC3F,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,UAAU,sBAA4B,WAAW,CAAC,IAAI,CAAC,CAAC;QACvF,MAAM,CAAC,MAAM,CAAO,WAAW,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAE1E,MAAM,cAAc,GAAG,WAAW,CAAC,oBAAoB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAE1E,OAAO,cAAc,CAAC,WAAW,CAAC,eAAe,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,mBAAmB,CAChC,SAAqB,EACrB,oBAA4B;IAC5B,8DAA8D;IAC9D,WAAiB;QAEjB,IAAI,KAAyB,CAAC;QAC9B,IAAI,SAAS,KAAK,UAAU,CAAC,kBAAkB,EAAE,CAAC;YACjD,KAAK,GAAG;gBACP,UAAU,EAAE,WAAW,CAAC,oBAAoB;gBAC5C,IAAI,EAAE,UAAU,CAAC,kBAAkB;gBACnC,WAAW,EAAE,eAAe,CAAC,YAAY;gBACzC,OAAO,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE;gBAC3C,kBAAkB,EAAE,oBAAoB;gBACxC,YAAY,EAAE,iBAAiB;gBAC/B,GAAG,WAAW;aACd,CAAC;QACH,CAAC;aAAM,IAAI,SAAS,KAAK,UAAU,CAAC,oBAAoB,EAAE,CAAC;YAC1D,KAAK,GAAG;gBACP,UAAU,EAAE,WAAW,CAAC,sBAAsB;gBAC9C,IAAI,EAAE,UAAU,CAAC,oBAAoB;gBACrC,OAAO,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE;gBAC3C,kBAAkB,EAAE,oBAAoB;gBACxC,YAAY,EAAE,iBAAiB;gBAC/B,GAAG,WAAW;aACd,CAAC;QACH,CAAC;QACD,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,YAAY,CAAC,WAAW,CAAC,UAAU,EAAE,sBAAsB,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Is } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IJwk } from \"@twin.org/web\";\nimport { DidContexts } from \"../models/didContexts.js\";\nimport { DidCryptoSuites } from \"../models/didCryptoSuites.js\";\nimport type { IProof } from \"../models/IProof.js\";\nimport type { IProofSignerVerifier } from \"../models/IProofSignerVerifier.js\";\nimport type { IProofSignerVerifierAsync } from \"../models/IProofSignerVerifierAsync.js\";\nimport { ProofTypes } from \"../models/proofTypes.js\";\nimport { DataIntegrityProofAsyncSignerVerifier } from \"../signerVerifiers/dataIntegrityProofAsyncSignerVerifier.js\";\nimport { DataIntegrityProofSignerVerifier } from \"../signerVerifiers/dataIntegrityProofSignerVerifier.js\";\nimport { JsonWebSignature2020AsyncSignerVerifier } from \"../signerVerifiers/jsonWebSignature2020AsyncSignerVerifier.js\";\nimport { JsonWebSignature2020SignerVerifier } from \"../signerVerifiers/jsonWebSignature2020SignerVerifier.js\";\n\n/**\n * Helper methods for creating and verifying proofs.\n */\nexport class ProofHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ProofHelper>();\n\n\t/**\n\t * Create a signer verifier.\n\t * @param proofType The type of proof to create.\n\t * @returns The created signer verifier.\n\t * @throws GeneralError if the proof type is not supported.\n\t */\n\tpublic static createSignerVerifier(proofType: ProofTypes): IProofSignerVerifier {\n\t\tGuards.arrayOneOf(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(proofType),\n\t\t\tproofType,\n\t\t\tObject.values(ProofTypes)\n\t\t);\n\n\t\tlet signerVerifier: IProofSignerVerifier | undefined;\n\t\tif (proofType === ProofTypes.DataIntegrityProof) {\n\t\t\tsignerVerifier = new DataIntegrityProofSignerVerifier();\n\t\t} else if (proofType === ProofTypes.JsonWebSignature2020) {\n\t\t\tsignerVerifier = new JsonWebSignature2020SignerVerifier();\n\t\t}\n\n\t\tif (Is.empty(signerVerifier)) {\n\t\t\tthrow new GeneralError(ProofHelper.CLASS_NAME, \"unsupportedProofType\", { proofType });\n\t\t}\n\t\treturn signerVerifier;\n\t}\n\n\t/**\n\t * Create an async signer verifier that supports signing with callbacks.\n\t * This enables signing without exposing private keys.\n\t * @param proofType The type of proof to create.\n\t * @returns The created async signer verifier.\n\t * @throws GeneralError if the proof type is not supported.\n\t */\n\tpublic static createAsyncSignerVerifier(proofType: ProofTypes): IProofSignerVerifierAsync {\n\t\tGuards.arrayOneOf(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(proofType),\n\t\t\tproofType,\n\t\t\tObject.values(ProofTypes)\n\t\t);\n\n\t\tlet signerVerifier: IProofSignerVerifierAsync | undefined;\n\t\tif (proofType === ProofTypes.DataIntegrityProof) {\n\t\t\tsignerVerifier = new DataIntegrityProofAsyncSignerVerifier();\n\t\t} else if (proofType === ProofTypes.JsonWebSignature2020) {\n\t\t\tsignerVerifier = new JsonWebSignature2020AsyncSignerVerifier();\n\t\t}\n\n\t\tif (Is.empty(signerVerifier)) {\n\t\t\tthrow new GeneralError(ProofHelper.CLASS_NAME, \"unsupportedProofType\", { proofType });\n\t\t}\n\t\treturn signerVerifier;\n\t}\n\n\t/**\n\t * Create a proof for the given data.\n\t * @param proofType The type of proof to create.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The proof options.\n\t * @param signKey The key to sign the proof with.\n\t * @returns The created proof.\n\t */\n\tpublic static async createProof(\n\t\tproofType: ProofTypes,\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IProof,\n\t\tsignKey: IJwk\n\t): Promise<IProof> {\n\t\tGuards.arrayOneOf(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(proofType),\n\t\t\tproofType,\n\t\t\tObject.values(ProofTypes)\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(ProofHelper.CLASS_NAME, nameof(unsignedProof), unsignedProof);\n\t\tGuards.object<IJwk>(ProofHelper.CLASS_NAME, nameof(signKey), signKey);\n\t\treturn ProofHelper.createSignerVerifier(proofType).createProof(\n\t\t\tunsecuredDocument,\n\t\t\tunsignedProof,\n\t\t\tsignKey\n\t\t);\n\t}\n\n\t/**\n\t * Create a proof with an async signing callback.\n\t * This method prevents private key exposure by delegating signing to a secure callback.\n\t * @param proofType The type of proof to create.\n\t * @param unsecuredDocument The data to create the proof for.\n\t * @param unsignedProof The proof options.\n\t * @param signCallback Async callback that signs data with a private key from secure storage. The algorithm parameter indicates the expected signing algorithm (e.g., \"EdDSA\") to enable validation.\n\t * @returns The created proof.\n\t */\n\tpublic static async createProofWithSigner(\n\t\tproofType: ProofTypes,\n\t\tunsecuredDocument: IJsonLdNodeObject,\n\t\tunsignedProof: IProof,\n\t\tsignCallback: (data: Uint8Array, algorithm: string) => Promise<Uint8Array>\n\t): Promise<IProof> {\n\t\tGuards.arrayOneOf(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(proofType),\n\t\t\tproofType,\n\t\t\tObject.values(ProofTypes)\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(unsecuredDocument),\n\t\t\tunsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(ProofHelper.CLASS_NAME, nameof(unsignedProof), unsignedProof);\n\t\tGuards.function(ProofHelper.CLASS_NAME, nameof(signCallback), signCallback);\n\n\t\treturn ProofHelper.createAsyncSignerVerifier(proofType).createProofWithSigner(\n\t\t\tunsecuredDocument,\n\t\t\tunsignedProof,\n\t\t\tsignCallback\n\t\t);\n\t}\n\n\t/**\n\t * Verify a proof for the given data.\n\t * @param securedDocument The credential to verify.\n\t * @param signedProof The proof to verify.\n\t * @param verifyKey The public key to verify the proof with.\n\t * @returns True if the credential was verified.\n\t */\n\tpublic static async verifyProof(\n\t\tsecuredDocument: IJsonLdNodeObject,\n\t\tsignedProof: IProof,\n\t\tverifyKey: IJwk\n\t): Promise<boolean> {\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tProofHelper.CLASS_NAME,\n\t\t\tnameof(securedDocument),\n\t\t\tsecuredDocument\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(ProofHelper.CLASS_NAME, nameof(signedProof), signedProof);\n\t\tGuards.stringValue(ProofHelper.CLASS_NAME, nameof(signedProof.type), signedProof.type);\n\t\tGuards.object<IJwk>(ProofHelper.CLASS_NAME, nameof(verifyKey), verifyKey);\n\n\t\tconst signerVerifier = ProofHelper.createSignerVerifier(signedProof.type);\n\n\t\treturn signerVerifier.verifyProof(securedDocument, signedProof, verifyKey);\n\t}\n\n\t/**\n\t * Create an unsigned proof.\n\t * @param proofType The type of proof to create.\n\t * @param verificationMethodId The verification method id.\n\t * @param otherParams Other parameters for the proof.\n\t * @returns The created proof.\n\t * @throws GeneralError if the proof type is not supported.\n\t */\n\tpublic static createUnsignedProof(\n\t\tproofType: ProofTypes,\n\t\tverificationMethodId: string,\n\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\totherParams?: any\n\t): IProof {\n\t\tlet proof: IProof | undefined;\n\t\tif (proofType === ProofTypes.DataIntegrityProof) {\n\t\t\tproof = {\n\t\t\t\t\"@context\": DidContexts.ContextDataIntegrity,\n\t\t\t\ttype: ProofTypes.DataIntegrityProof,\n\t\t\t\tcryptosuite: DidCryptoSuites.EdDSAJcs2022,\n\t\t\t\tcreated: new Date(Date.now()).toISOString(),\n\t\t\t\tverificationMethod: verificationMethodId,\n\t\t\t\tproofPurpose: \"assertionMethod\",\n\t\t\t\t...otherParams\n\t\t\t};\n\t\t} else if (proofType === ProofTypes.JsonWebSignature2020) {\n\t\t\tproof = {\n\t\t\t\t\"@context\": DidContexts.ContextSecurityJws2020,\n\t\t\t\ttype: ProofTypes.JsonWebSignature2020,\n\t\t\t\tcreated: new Date(Date.now()).toISOString(),\n\t\t\t\tverificationMethod: verificationMethodId,\n\t\t\t\tproofPurpose: \"assertionMethod\",\n\t\t\t\t...otherParams\n\t\t\t};\n\t\t}\n\t\tif (Is.empty(proof)) {\n\t\t\tthrow new GeneralError(ProofHelper.CLASS_NAME, \"unsupportedProofType\", { proofType });\n\t\t}\n\t\treturn proof;\n\t}\n}\n"]}

package/dist/es/utils/verifiableCredentialHelper.js

@@ -1,6 +1,7 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-import { ObjectHelper } from "@twin.org/core";
+import { ArrayHelper, Is, ObjectHelper } from "@twin.org/core";
+import { DidContexts } from "../models/didContexts.js";
 /**
  * Helper methods for creating and verifying proofs.
  */
@@ -10,22 +11,78 @@ export class VerifiableCredentialHelper {
      */
     static CLASS_NAME = "VerifiableCredentialHelper";
     /**
-     * Get the valid until date from a verifiable credential.
-     * @param verifiableCredential The verifiable credential to extract the expiration date from.
-     * @returns The expiration date, if available.
+     * Get the JSON-LD context URL for the verifiable credential.
+     * @param verifiableCredential The verifiable credential to inspect.
+     * @returns The context URL, or undefined if the version cannot be determined.
+     */
+    static getContext(verifiableCredential) {
+        const contextVersion = VerifiableCredentialHelper.getContextVersion(verifiableCredential);
+        if (contextVersion === "v1") {
+            return DidContexts.ContextVCv1;
+        }
+        if (contextVersion === "v2") {
+            return DidContexts.ContextVCv2;
+        }
+    }
+    /**
+     * Get the context version string for the verifiable credential.
+     * @param verifiableCredential The verifiable credential to inspect.
+     * @returns The context version ("v1" or "v2"), or undefined if not determinable.
+     */
+    static getContextVersion(verifiableCredential) {
+        const context = ArrayHelper.fromObjectOrArray(verifiableCredential["@context"]);
+        if (Is.arrayValue(context)) {
+            if (context.includes(DidContexts.ContextVCv1)) {
+                return "v1";
+            }
+            if (context.includes(DidContexts.ContextVCv2)) {
+                return "v2";
+            }
+        }
+    }
+    /**
+     * Get the expiration date from a verifiable credential.
+     * @param verifiableCredential The verifiable credential to inspect.
+     * @returns The expiration date string, or undefined if not present.
      */
     static getValidUntil(verifiableCredential) {
         return (ObjectHelper.propertyGet(verifiableCredential, "validUntil") ??
             ObjectHelper.propertyGet(verifiableCredential, "expirationDate"));
     }
     /**
-     * Get the valid from from a verifiable credential.
-     * @param verifiableCredential The verifiable credential to extract the issuance date from.
-     * @returns The issuance date, if available.
+     * Set the expiration date on a verifiable credential.
+     * @param verifiableCredential The verifiable credential to update.
+     * @param validUntil The expiration date to set.
+     */
+    static setValidUntil(verifiableCredential, validUntil) {
+        if (VerifiableCredentialHelper.getContextVersion(verifiableCredential) === "v2") {
+            ObjectHelper.propertySet(verifiableCredential, "validUntil", validUntil);
+        }
+        else {
+            ObjectHelper.propertySet(verifiableCredential, "expirationDate", validUntil);
+        }
+    }
+    /**
+     * Get the issuance date from a verifiable credential.
+     * @param verifiableCredential The verifiable credential to inspect.
+     * @returns The issuance date string, or undefined if not present.
      */
     static getValidFrom(verifiableCredential) {
         return (ObjectHelper.propertyGet(verifiableCredential, "validFrom") ??
             ObjectHelper.propertyGet(verifiableCredential, "issuanceDate"));
     }
+    /**
+     * Set the issuance date on a verifiable credential.
+     * @param verifiableCredential The verifiable credential to update.
+     * @param validFrom The issuance date to set.
+     */
+    static setValidFrom(verifiableCredential, validFrom) {
+        if (VerifiableCredentialHelper.getContextVersion(verifiableCredential) === "v2") {
+            ObjectHelper.propertySet(verifiableCredential, "validFrom", validFrom);
+        }
+        else {
+            ObjectHelper.propertySet(verifiableCredential, "issuanceDate", validFrom);
+        }
+    }
 }
 //# sourceMappingURL=verifiableCredentialHelper.js.map

package/dist/es/utils/verifiableCredentialHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"verifiableCredentialHelper.js","sourceRoot":"","sources":["../../../src/utils/verifiableCredentialHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAI9C;;GAEG;AACH,MAAM,OAAO,0BAA0B;IACtC;;OAEG;IACI,MAAM,CAAU,UAAU,gCAAgD;IAEjF;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,oBAA8C;QACzE,OAAO,CACN,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,YAAY,CAAC;YAC5D,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CAChE,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,oBAA8C;QACxE,OAAO,CACN,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,WAAW,CAAC;YAC3D,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAC9D,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ObjectHelper } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IDidVerifiableCredential } from \"../models/IDidVerifiableCredential.js\";\n\n/**\n * Helper methods for creating and verifying proofs.\n */\nexport class VerifiableCredentialHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<VerifiableCredentialHelper>();\n\n\t/**\n\t * Get the valid until date from a verifiable credential.\n\t * @param verifiableCredential The verifiable credential to extract the expiration date from.\n\t * @returns The expiration date, if available.\n\t */\n\tpublic static getValidUntil(verifiableCredential: IDidVerifiableCredential): string | undefined {\n\t\treturn (\n\t\t\tObjectHelper.propertyGet(verifiableCredential, \"validUntil\") ??\n\t\t\tObjectHelper.propertyGet(verifiableCredential, \"expirationDate\")\n\t\t);\n\t}\n\n\t/**\n\t * Get the valid from from a verifiable credential.\n\t * @param verifiableCredential The verifiable credential to extract the issuance date from.\n\t * @returns The issuance date, if available.\n\t */\n\tpublic static getValidFrom(verifiableCredential: IDidVerifiableCredential): string | undefined {\n\t\treturn (\n\t\t\tObjectHelper.propertyGet(verifiableCredential, \"validFrom\") ??\n\t\t\tObjectHelper.propertyGet(verifiableCredential, \"issuanceDate\")\n\t\t);\n\t}\n}\n"]}
+{"version":3,"file":"verifiableCredentialHelper.js","sourceRoot":"","sources":["../../../src/utils/verifiableCredentialHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE/D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAGvD;;GAEG;AACH,MAAM,OAAO,0BAA0B;IACtC;;OAEG;IACI,MAAM,CAAU,UAAU,gCAAgD;IAEjF;;;;OAIG;IACI,MAAM,CAAC,UAAU,CACvB,oBAA8C;QAE9C,MAAM,cAAc,GAAG,0BAA0B,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;QAC1F,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;YAC7B,OAAO,WAAW,CAAC,WAAW,CAAC;QAChC,CAAC;QACD,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;YAC7B,OAAO,WAAW,CAAC,WAAW,CAAC;QAChC,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAC9B,oBAA8C;QAE9C,MAAM,OAAO,GAAG,WAAW,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;QAChF,IAAI,EAAE,CAAC,UAAU,CAAS,OAAO,CAAC,EAAE,CAAC;YACpC,IAAI,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC/C,OAAO,IAAI,CAAC;YACb,CAAC;YACD,IAAI,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC/C,OAAO,IAAI,CAAC;YACb,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,oBAA8C;QACzE,OAAO,CACN,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,YAAY,CAAC;YAC5D,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CAChE,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAC1B,oBAA8C,EAC9C,UAAkB;QAElB,IAAI,0BAA0B,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,KAAK,IAAI,EAAE,CAAC;YACjF,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;QAC1E,CAAC;aAAM,CAAC;YACP,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC;QAC9E,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,oBAA8C;QACxE,OAAO,CACN,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,WAAW,CAAC;YAC3D,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAC9D,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CACzB,oBAA8C,EAC9C,SAAiB;QAEjB,IAAI,0BAA0B,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,KAAK,IAAI,EAAE,CAAC;YACjF,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;QACxE,CAAC;aAAM,CAAC;YACP,YAAY,CAAC,WAAW,CAAC,oBAAoB,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;QAC3E,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ArrayHelper, Is, ObjectHelper } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { DidContexts } from \"../models/didContexts.js\";\nimport type { IDidVerifiableCredential } from \"../models/IDidVerifiableCredential.js\";\n\n/**\n * Helper methods for creating and verifying proofs.\n */\nexport class VerifiableCredentialHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<VerifiableCredentialHelper>();\n\n\t/**\n\t * Get the JSON-LD context URL for the verifiable credential.\n\t * @param verifiableCredential The verifiable credential to inspect.\n\t * @returns The context URL, or undefined if the version cannot be determined.\n\t */\n\tpublic static getContext(\n\t\tverifiableCredential: IDidVerifiableCredential\n\t): typeof DidContexts.ContextVCv1 | typeof DidContexts.ContextVCv2 | undefined {\n\t\tconst contextVersion = VerifiableCredentialHelper.getContextVersion(verifiableCredential);\n\t\tif (contextVersion === \"v1\") {\n\t\t\treturn DidContexts.ContextVCv1;\n\t\t}\n\t\tif (contextVersion === \"v2\") {\n\t\t\treturn DidContexts.ContextVCv2;\n\t\t}\n\t}\n\n\t/**\n\t * Get the context version string for the verifiable credential.\n\t * @param verifiableCredential The verifiable credential to inspect.\n\t * @returns The context version (\"v1\" or \"v2\"), or undefined if not determinable.\n\t */\n\tpublic static getContextVersion(\n\t\tverifiableCredential: IDidVerifiableCredential\n\t): \"v1\" | \"v2\" | undefined {\n\t\tconst context = ArrayHelper.fromObjectOrArray(verifiableCredential[\"@context\"]);\n\t\tif (Is.arrayValue<string>(context)) {\n\t\t\tif (context.includes(DidContexts.ContextVCv1)) {\n\t\t\t\treturn \"v1\";\n\t\t\t}\n\t\t\tif (context.includes(DidContexts.ContextVCv2)) {\n\t\t\t\treturn \"v2\";\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Get the expiration date from a verifiable credential.\n\t * @param verifiableCredential The verifiable credential to inspect.\n\t * @returns The expiration date string, or undefined if not present.\n\t */\n\tpublic static getValidUntil(verifiableCredential: IDidVerifiableCredential): string | undefined {\n\t\treturn (\n\t\t\tObjectHelper.propertyGet(verifiableCredential, \"validUntil\") ??\n\t\t\tObjectHelper.propertyGet(verifiableCredential, \"expirationDate\")\n\t\t);\n\t}\n\n\t/**\n\t * Set the expiration date on a verifiable credential.\n\t * @param verifiableCredential The verifiable credential to update.\n\t * @param validUntil The expiration date to set.\n\t */\n\tpublic static setValidUntil(\n\t\tverifiableCredential: IDidVerifiableCredential,\n\t\tvalidUntil: string\n\t): void {\n\t\tif (VerifiableCredentialHelper.getContextVersion(verifiableCredential) === \"v2\") {\n\t\t\tObjectHelper.propertySet(verifiableCredential, \"validUntil\", validUntil);\n\t\t} else {\n\t\t\tObjectHelper.propertySet(verifiableCredential, \"expirationDate\", validUntil);\n\t\t}\n\t}\n\n\t/**\n\t * Get the issuance date from a verifiable credential.\n\t * @param verifiableCredential The verifiable credential to inspect.\n\t * @returns The issuance date string, or undefined if not present.\n\t */\n\tpublic static getValidFrom(verifiableCredential: IDidVerifiableCredential): string | undefined {\n\t\treturn (\n\t\t\tObjectHelper.propertyGet(verifiableCredential, \"validFrom\") ??\n\t\t\tObjectHelper.propertyGet(verifiableCredential, \"issuanceDate\")\n\t\t);\n\t}\n\n\t/**\n\t * Set the issuance date on a verifiable credential.\n\t * @param verifiableCredential The verifiable credential to update.\n\t * @param validFrom The issuance date to set.\n\t */\n\tpublic static setValidFrom(\n\t\tverifiableCredential: IDidVerifiableCredential,\n\t\tvalidFrom: string\n\t): void {\n\t\tif (VerifiableCredentialHelper.getContextVersion(verifiableCredential) === \"v2\") {\n\t\t\tObjectHelper.propertySet(verifiableCredential, \"validFrom\", validFrom);\n\t\t} else {\n\t\t\tObjectHelper.propertySet(verifiableCredential, \"issuanceDate\", validFrom);\n\t\t}\n\t}\n}\n"]}

package/dist/types/dataTypes/didDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handles data type registration for DID.
+ */
+export declare abstract class DidDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./dataTypes/didDataTypes.js";
 export * from "./models/didContexts.js";
 export * from "./models/didCryptoSuites.js";
 export * from "./models/didTypes.js";
@@ -19,12 +20,16 @@ export * from "./models/IDidVerifiablePresentationCommon.js";
 export * from "./models/IDidVerifiablePresentationV1.js";
 export * from "./models/IDidVerifiablePresentationV2.js";
 export * from "./models/IJsonWebSignature2020Proof.js";
+export * from "./models/jwsAlgorithms.js";
 export * from "./models/IMultikey.js";
 export * from "./models/IProof.js";
 export * from "./models/IProofSignerVerifier.js";
+export * from "./models/IProofSignerVerifierAsync.js";
 export * from "./models/proofTypes.js";
 export * from "./signerVerifiers/dataIntegrityProofSignerVerifier.js";
+export * from "./signerVerifiers/dataIntegrityProofAsyncSignerVerifier.js";
 export * from "./signerVerifiers/jsonWebSignature2020SignerVerifier.js";
+export * from "./signerVerifiers/jsonWebSignature2020AsyncSignerVerifier.js";
 export * from "./utils/multikeyHelper.js";
 export * from "./utils/proofHelper.js";
 export * from "./utils/verifiableCredentialHelper.js";