@twin.org/identity-models 0.0.1-next.28 → 0.0.1-next.29

package/dist/cjs/index.cjs

@@ -1,6 +1,7 @@
 'use strict';
 
 var core = require('@twin.org/core');
+var standardsW3cDid = require('@twin.org/standards-w3c-did');
 var web = require('@twin.org/web');
 
 // Copyright 2024 IOTA Stiftung.
@@ -33,6 +34,10 @@ const IdentityResolverConnectorFactory = core.Factory.createFactory("identity-re
  * Helper methods for documents.
  */
 class DocumentHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "DocumentHelper";
     /**
      * Parse the document id into its parts.
      * @param documentId The full document id.
@@ -75,43 +80,116 @@ class DocumentHelper {
         }
         return fullId;
     }
+    /**
+     * Get a verification method from a DID document.
+     * @param didDocument The DID Document to get the method from.
+     * @param methodName The name of the method to get the JWK from.
+     * @param methodType The type of the method, defaults to verificationMethod.
+     * @returns The verification method if found.
+     * @throws Error if the method is not found.
+     */
+    static getVerificationMethod(didDocument, methodName, methodType) {
+        const verificationMethod = didDocument[methodType ?? standardsW3cDid.DidVerificationMethodType.VerificationMethod]?.find(vm => core.Is.object(vm) && vm.id === methodName);
+        if (core.Is.object(verificationMethod)) {
+            return verificationMethod;
+        }
+        throw new core.GeneralError(DocumentHelper.CLASS_NAME, "verificationMethodNotFound", {
+            methodName,
+            methodType
+        });
+    }
+    /**
+     * Gets a JWK from a DID document verification method.
+     * @param didDocument The DID Document to get the method from.
+     * @param methodName The name of the method to get the JWK from.
+     * @param methodType The type of the method, defaults to verificationMethod.
+     * @returns The JWK if found.
+     * @throws Error if the method is not found.
+     */
+    static getJwk(didDocument, methodName, methodType) {
+        const verificationMethod = DocumentHelper.getVerificationMethod(didDocument, methodName, methodType);
+        if (core.Is.object(verificationMethod) && core.Is.object(verificationMethod.publicKeyJwk)) {
+            return verificationMethod.publicKeyJwk;
+        }
+        throw new core.GeneralError(DocumentHelper.CLASS_NAME, "verificationMethodJwkNotFound", {
+            methodName,
+            methodType
+        });
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * Helper methods for JSON Web Tokens.
+ * Helper methods for verification.
  */
-class JwtHelper {
+class VerificationHelper {
     /**
      * Runtime name for the class.
      */
-    static CLASS_NAME = "JwtHelper";
+    static CLASS_NAME = "VerificationHelper";
     /**
-     * Parse the token and check that the properties are valid.
-     * @param jwt The token top validate.
-     * @param paramsToCheck Parameters to check they exist.
-     * @returns The token components.
-     * @throws Error if the token is invalid.
+     * Verified the JWT.
+     * @param resolver The resolver to use for finding the document.
+     * @param jwt The token to verify.
+     * @returns The decoded payload.
      */
-    static async parse(jwt, paramsToCheck) {
+    async verifyJwt(resolver, jwt) {
+        core.Guards.object(VerificationHelper.CLASS_NAME, "resolver", resolver);
+        core.Guards.string(VerificationHelper.CLASS_NAME, "jwt", jwt);
         const jwtDecoded = await web.Jwt.decode(jwt);
         const jwtHeader = jwtDecoded.header;
         const jwtPayload = jwtDecoded.payload;
         const jwtSignature = jwtDecoded.signature;
-        if (core.Is.undefined(jwtHeader) || core.Is.undefined(jwtPayload) || core.Is.undefined(jwtSignature)) {
-            throw new core.GeneralError(JwtHelper.CLASS_NAME, "jwtDecodeFailed");
+        if (!core.Is.object(jwtHeader) || !core.Is.object(jwtPayload) || !core.Is.uint8Array(jwtSignature)) {
+            throw new core.GeneralError(VerificationHelper.CLASS_NAME, "jwtDecodeFailed");
         }
-        if (core.Is.arrayValue(paramsToCheck)) {
-            for (const param of paramsToCheck) {
-                if (!core.Is.stringValue(jwtPayload[param])) {
-                    throw new core.GeneralError(JwtHelper.CLASS_NAME, "jwtPayloadMissingParam", {
-                        param
-                    });
-                }
+        const iss = jwtPayload?.iss;
+        const kid = jwtPayload?.kid;
+        core.Guards.stringValue(VerificationHelper.CLASS_NAME, "iss", iss);
+        core.Guards.stringValue(VerificationHelper.CLASS_NAME, "kid", kid);
+        const didDocument = await resolver.resolveDocument(iss);
+        const jwk = DocumentHelper.getJwk(didDocument, kid);
+        const publicKey = await web.Jwk.toCryptoKey(jwk);
+        return web.Jwt.verify(jwt, publicKey);
+    }
+    /**
+     * Verified the proof for the document e.g. verifiable credential.
+     * @param resolver The resolver to use for finding the document.
+     * @param secureDocument The secure document to verify.
+     * @returns True if the verification is successful.
+     */
+    async verifyProof(resolver, secureDocument) {
+        core.Guards.object(VerificationHelper.CLASS_NAME, "resolver", resolver);
+        core.Guards.object(VerificationHelper.CLASS_NAME, "secureDocument", secureDocument);
+        core.Guards.object(VerificationHelper.CLASS_NAME, "secureDocument.proof", secureDocument.proof);
+        const proofList = core.Is.array(secureDocument.proof)
+            ? secureDocument.proof
+            : [secureDocument.proof];
+        const documentCache = {};
+        for (const proof of proofList) {
+            if (!core.Is.stringValue(proof?.verificationMethod)) {
+                throw new core.GeneralError(VerificationHelper.CLASS_NAME, "proofMissingVerificationMethod");
+            }
+            const proofVerificationMethod = DocumentHelper.parseId(proof.verificationMethod);
+            if (!core.Is.stringValue(proofVerificationMethod.fragment)) {
+                throw new core.GeneralError(VerificationHelper.CLASS_NAME, "proofMissingVerificationMethod");
+            }
+            let document;
+            if (documentCache[proofVerificationMethod.id]) {
+                document = documentCache[proofVerificationMethod.id];
+            }
+            else {
+                document = await resolver.resolveDocument(proofVerificationMethod.id);
+                documentCache[proofVerificationMethod.id] = document;
+            }
+            const verificationJwk = await DocumentHelper.getJwk(document, proofVerificationMethod.id);
+            const verified = standardsW3cDid.ProofHelper.verifyProof(secureDocument, proof, verificationJwk);
+            if (!verified) {
+                return false;
             }
         }
-        return jwtDecoded;
+        return true;
     }
 }
 
@@ -119,4 +197,4 @@ exports.DocumentHelper = DocumentHelper;
 exports.IdentityConnectorFactory = IdentityConnectorFactory;
 exports.IdentityProfileConnectorFactory = IdentityProfileConnectorFactory;
 exports.IdentityResolverConnectorFactory = IdentityResolverConnectorFactory;
-exports.JwtHelper = JwtHelper;
+exports.VerificationHelper = VerificationHelper;

package/dist/esm/index.mjs

@@ -1,5 +1,6 @@
-import { Factory, Is, GeneralError } from '@twin.org/core';
-import { Jwt } from '@twin.org/web';
+import { Factory, Is, GeneralError, Guards } from '@twin.org/core';
+import { DidVerificationMethodType, ProofHelper } from '@twin.org/standards-w3c-did';
+import { Jwt, Jwk } from '@twin.org/web';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -31,6 +32,10 @@ const IdentityResolverConnectorFactory = Factory.createFactory("identity-resolve
  * Helper methods for documents.
  */
 class DocumentHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "DocumentHelper";
     /**
      * Parse the document id into its parts.
      * @param documentId The full document id.
@@ -73,44 +78,117 @@ class DocumentHelper {
         }
         return fullId;
     }
+    /**
+     * Get a verification method from a DID document.
+     * @param didDocument The DID Document to get the method from.
+     * @param methodName The name of the method to get the JWK from.
+     * @param methodType The type of the method, defaults to verificationMethod.
+     * @returns The verification method if found.
+     * @throws Error if the method is not found.
+     */
+    static getVerificationMethod(didDocument, methodName, methodType) {
+        const verificationMethod = didDocument[methodType ?? DidVerificationMethodType.VerificationMethod]?.find(vm => Is.object(vm) && vm.id === methodName);
+        if (Is.object(verificationMethod)) {
+            return verificationMethod;
+        }
+        throw new GeneralError(DocumentHelper.CLASS_NAME, "verificationMethodNotFound", {
+            methodName,
+            methodType
+        });
+    }
+    /**
+     * Gets a JWK from a DID document verification method.
+     * @param didDocument The DID Document to get the method from.
+     * @param methodName The name of the method to get the JWK from.
+     * @param methodType The type of the method, defaults to verificationMethod.
+     * @returns The JWK if found.
+     * @throws Error if the method is not found.
+     */
+    static getJwk(didDocument, methodName, methodType) {
+        const verificationMethod = DocumentHelper.getVerificationMethod(didDocument, methodName, methodType);
+        if (Is.object(verificationMethod) && Is.object(verificationMethod.publicKeyJwk)) {
+            return verificationMethod.publicKeyJwk;
+        }
+        throw new GeneralError(DocumentHelper.CLASS_NAME, "verificationMethodJwkNotFound", {
+            methodName,
+            methodType
+        });
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * Helper methods for JSON Web Tokens.
+ * Helper methods for verification.
  */
-class JwtHelper {
+class VerificationHelper {
     /**
      * Runtime name for the class.
      */
-    static CLASS_NAME = "JwtHelper";
+    static CLASS_NAME = "VerificationHelper";
     /**
-     * Parse the token and check that the properties are valid.
-     * @param jwt The token top validate.
-     * @param paramsToCheck Parameters to check they exist.
-     * @returns The token components.
-     * @throws Error if the token is invalid.
+     * Verified the JWT.
+     * @param resolver The resolver to use for finding the document.
+     * @param jwt The token to verify.
+     * @returns The decoded payload.
      */
-    static async parse(jwt, paramsToCheck) {
+    async verifyJwt(resolver, jwt) {
+        Guards.object(VerificationHelper.CLASS_NAME, "resolver", resolver);
+        Guards.string(VerificationHelper.CLASS_NAME, "jwt", jwt);
         const jwtDecoded = await Jwt.decode(jwt);
         const jwtHeader = jwtDecoded.header;
         const jwtPayload = jwtDecoded.payload;
         const jwtSignature = jwtDecoded.signature;
-        if (Is.undefined(jwtHeader) || Is.undefined(jwtPayload) || Is.undefined(jwtSignature)) {
-            throw new GeneralError(JwtHelper.CLASS_NAME, "jwtDecodeFailed");
+        if (!Is.object(jwtHeader) || !Is.object(jwtPayload) || !Is.uint8Array(jwtSignature)) {
+            throw new GeneralError(VerificationHelper.CLASS_NAME, "jwtDecodeFailed");
         }
-        if (Is.arrayValue(paramsToCheck)) {
-            for (const param of paramsToCheck) {
-                if (!Is.stringValue(jwtPayload[param])) {
-                    throw new GeneralError(JwtHelper.CLASS_NAME, "jwtPayloadMissingParam", {
-                        param
-                    });
-                }
+        const iss = jwtPayload?.iss;
+        const kid = jwtPayload?.kid;
+        Guards.stringValue(VerificationHelper.CLASS_NAME, "iss", iss);
+        Guards.stringValue(VerificationHelper.CLASS_NAME, "kid", kid);
+        const didDocument = await resolver.resolveDocument(iss);
+        const jwk = DocumentHelper.getJwk(didDocument, kid);
+        const publicKey = await Jwk.toCryptoKey(jwk);
+        return Jwt.verify(jwt, publicKey);
+    }
+    /**
+     * Verified the proof for the document e.g. verifiable credential.
+     * @param resolver The resolver to use for finding the document.
+     * @param secureDocument The secure document to verify.
+     * @returns True if the verification is successful.
+     */
+    async verifyProof(resolver, secureDocument) {
+        Guards.object(VerificationHelper.CLASS_NAME, "resolver", resolver);
+        Guards.object(VerificationHelper.CLASS_NAME, "secureDocument", secureDocument);
+        Guards.object(VerificationHelper.CLASS_NAME, "secureDocument.proof", secureDocument.proof);
+        const proofList = Is.array(secureDocument.proof)
+            ? secureDocument.proof
+            : [secureDocument.proof];
+        const documentCache = {};
+        for (const proof of proofList) {
+            if (!Is.stringValue(proof?.verificationMethod)) {
+                throw new GeneralError(VerificationHelper.CLASS_NAME, "proofMissingVerificationMethod");
+            }
+            const proofVerificationMethod = DocumentHelper.parseId(proof.verificationMethod);
+            if (!Is.stringValue(proofVerificationMethod.fragment)) {
+                throw new GeneralError(VerificationHelper.CLASS_NAME, "proofMissingVerificationMethod");
+            }
+            let document;
+            if (documentCache[proofVerificationMethod.id]) {
+                document = documentCache[proofVerificationMethod.id];
+            }
+            else {
+                document = await resolver.resolveDocument(proofVerificationMethod.id);
+                documentCache[proofVerificationMethod.id] = document;
+            }
+            const verificationJwk = await DocumentHelper.getJwk(document, proofVerificationMethod.id);
+            const verified = ProofHelper.verifyProof(secureDocument, proof, verificationJwk);
+            if (!verified) {
+                return false;
             }
         }
-        return jwtDecoded;
+        return true;
     }
 }
 
-export { DocumentHelper, IdentityConnectorFactory, IdentityProfileConnectorFactory, IdentityResolverConnectorFactory, JwtHelper };
+export { DocumentHelper, IdentityConnectorFactory, IdentityProfileConnectorFactory, IdentityResolverConnectorFactory, VerificationHelper };

package/dist/types/index.d.ts

@@ -40,4 +40,4 @@ export * from "./models/IIdentityProfileConnector";
 export * from "./models/IIdentityResolverComponent";
 export * from "./models/IIdentityResolverConnector";
 export * from "./utils/documentHelper";
-export * from "./utils/jwtHelper";
+export * from "./utils/verificationHelper";

package/dist/types/models/IIdentityComponent.d.ts

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdContextDefinitionRoot, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IDidProof, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IProof, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation, ProofTypes } from "@twin.org/standards-w3c-did";
 /**
  * Interface describing a contract which provides identity operations.
  */
@@ -117,18 +117,19 @@ export interface IIdentityComponent extends IComponent {
         issuers?: IDidDocument[];
     }>;
     /**
-     * Create a proof for arbitrary data with the specified verification method.
+     * Create a proof for a document with the specified verification method.
      * @param verificationMethodId The verification method id to use.
-     * @param bytes The data bytes to sign.
+     * @param proofType The type of proof to create.
+     * @param unsecureDocument The unsecure document to create the proof for.
      * @param controller The controller of the identity who can make changes.
      * @returns The proof.
      */
-    proofCreate(verificationMethodId: string, bytes: Uint8Array, controller?: string): Promise<IDidProof>;
+    proofCreate(verificationMethodId: string, proofType: ProofTypes, unsecureDocument: IJsonLdNodeObject, controller?: string): Promise<IProof>;
     /**
-     * Verify proof for arbitrary data with the specified verification method.
-     * @param bytes The data bytes to verify.
+     * Verify proof for a document with the specified verification method.
+     * @param document The document to verify.
      * @param proof The proof to verify.
      * @returns True if the proof is verified.
      */
-    proofVerify(bytes: Uint8Array, proof: IDidProof): Promise<boolean>;
+    proofVerify(document: IJsonLdNodeObject, proof: IProof): Promise<boolean>;
 }

package/dist/types/models/IIdentityConnector.d.ts

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdContextDefinitionRoot, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IDidProof, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IProof, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation, ProofTypes } from "@twin.org/standards-w3c-did";
 /**
  * Interface describing an identity connector.
  */
@@ -119,15 +119,16 @@ export interface IIdentityConnector extends IComponent {
      * Create a proof for arbitrary data with the specified verification method.
      * @param controller The controller of the identity who can make changes.
      * @param verificationMethodId The verification method id to use.
-     * @param bytes The data bytes to sign.
+     * @param proofType The type of proof to create.
+     * @param unsecureDocument The unsecure document to create the proof for.
      * @returns The proof.
      */
-    createProof(controller: string, verificationMethodId: string, bytes: Uint8Array): Promise<IDidProof>;
+    createProof(controller: string, verificationMethodId: string, proofType: ProofTypes, unsecureDocument: IJsonLdNodeObject): Promise<IProof>;
     /**
      * Verify proof for arbitrary data with the specified verification method.
-     * @param bytes The data bytes to verify.
+     * @param document The document to verify.
      * @param proof The proof to verify.
      * @returns True if the proof is verified.
      */
-    verifyProof(bytes: Uint8Array, proof: IDidProof): Promise<boolean>;
+    verifyProof(document: IJsonLdNodeObject, proof: IProof): Promise<boolean>;
 }

package/dist/types/models/api/identity/IIdentityProofCreateRequest.d.ts

@@ -1,3 +1,5 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { ProofTypes } from "@twin.org/standards-w3c-did";
 /**
  * Request to create a proof.
  */
@@ -20,8 +22,12 @@ export interface IIdentityProofCreateRequest {
      */
     body: {
         /**
-         * The data bytes base64 encoded.
+         * The type of proof to create.
          */
-        bytes: string;
+        proofType: ProofTypes;
+        /**
+         * The document to create the proof for.
+         */
+        document: IJsonLdNodeObject;
     };
 }

package/dist/types/models/api/identity/IIdentityProofCreateResponse.d.ts

@@ -1,4 +1,4 @@
-import type { IDidProof } from "@twin.org/standards-w3c-did";
+import type { IProof } from "@twin.org/standards-w3c-did";
 /**
  * Response to creating a proof.
  */
@@ -6,5 +6,5 @@ export interface IIdentityProofCreateResponse {
     /**
      * The response payload.
      */
-    body: IDidProof;
+    body: IProof;
 }

package/dist/types/models/api/identity/IIdentityProofVerifyRequest.d.ts

@@ -1,4 +1,5 @@
-import type { IDidProof } from "@twin.org/standards-w3c-did";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IProof } from "@twin.org/standards-w3c-did";
 /**
  * Request to verify a proof.
  */
@@ -8,12 +9,12 @@ export interface IIdentityProofVerifyRequest {
      */
     body: {
         /**
-         * The data bytes base64 encoded.
+         * The document to verify the proof for.
          */
-        bytes: string;
+        document: IJsonLdNodeObject;
         /**
          * The proof to verify.
          */
-        proof: IDidProof;
+        proof: IProof;
     };
 }

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

@@ -1,7 +1,13 @@
+import { DidVerificationMethodType, type IDidDocumentVerificationMethod, type IDidDocument } from "@twin.org/standards-w3c-did";
+import type { IJwk } from "@twin.org/web";
 /**
  * Helper methods for documents.
  */
 export declare class DocumentHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Parse the document id into its parts.
      * @param documentId The full document id.
@@ -18,4 +24,22 @@ export declare class DocumentHelper {
      * @returns The full id.
      */
     static joinId(documentId: string, fragment?: string): string;
+    /**
+     * Get a verification method from a DID document.
+     * @param didDocument The DID Document to get the method from.
+     * @param methodName The name of the method to get the JWK from.
+     * @param methodType The type of the method, defaults to verificationMethod.
+     * @returns The verification method if found.
+     * @throws Error if the method is not found.
+     */
+    static getVerificationMethod(didDocument: IDidDocument, methodName: string, methodType?: DidVerificationMethodType): IDidDocumentVerificationMethod;
+    /**
+     * Gets a JWK from a DID document verification method.
+     * @param didDocument The DID Document to get the method from.
+     * @param methodName The name of the method to get the JWK from.
+     * @param methodType The type of the method, defaults to verificationMethod.
+     * @returns The JWK if found.
+     * @throws Error if the method is not found.
+     */
+    static getJwk(didDocument: IDidDocument, methodName: string, methodType?: DidVerificationMethodType): IJwk;
 }

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

@@ -0,0 +1,29 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IJwtHeader, type IJwtPayload } from "@twin.org/web";
+import type { IIdentityResolverConnector } from "../models/IIdentityResolverConnector";
+/**
+ * Helper methods for verification.
+ */
+export declare class VerificationHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Verified the JWT.
+     * @param resolver The resolver to use for finding the document.
+     * @param jwt The token to verify.
+     * @returns The decoded payload.
+     */
+    verifyJwt<T extends IJwtHeader, U extends IJwtPayload>(resolver: IIdentityResolverConnector, jwt: string): Promise<{
+        header: T;
+        payload: U;
+    }>;
+    /**
+     * Verified the proof for the document e.g. verifiable credential.
+     * @param resolver The resolver to use for finding the document.
+     * @param secureDocument The secure document to verify.
+     * @returns True if the verification is successful.
+     */
+    verifyProof(resolver: IIdentityResolverConnector, secureDocument: IJsonLdNodeObject): Promise<boolean>;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/identity-service-models - Changelog
 
-## v0.0.1-next.28
+## v0.0.1-next.29
 
 - Initial Release

package/docs/reference/classes/DocumentHelper.md

@@ -12,6 +12,14 @@ Helper methods for documents.
 
 [`DocumentHelper`](DocumentHelper.md)
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### parseId()
@@ -69,3 +77,79 @@ The fragment part for the identifier.
 `string`
 
 The full id.
+
+***
+
+### getVerificationMethod()
+
+> `static` **getVerificationMethod**(`didDocument`, `methodName`, `methodType`?): `IDidDocumentVerificationMethod`
+
+Get a verification method from a DID document.
+
+#### Parameters
+
+##### didDocument
+
+`IDidDocument`
+
+The DID Document to get the method from.
+
+##### methodName
+
+`string`
+
+The name of the method to get the JWK from.
+
+##### methodType?
+
+`DidVerificationMethodType`
+
+The type of the method, defaults to verificationMethod.
+
+#### Returns
+
+`IDidDocumentVerificationMethod`
+
+The verification method if found.
+
+#### Throws
+
+Error if the method is not found.
+
+***
+
+### getJwk()
+
+> `static` **getJwk**(`didDocument`, `methodName`, `methodType`?): `IJwk`
+
+Gets a JWK from a DID document verification method.
+
+#### Parameters
+
+##### didDocument
+
+`IDidDocument`
+
+The DID Document to get the method from.
+
+##### methodName
+
+`string`
+
+The name of the method to get the JWK from.
+
+##### methodType?
+
+`DidVerificationMethodType`
+
+The type of the method, defaults to verificationMethod.
+
+#### Returns
+
+`IJwk`
+
+The JWK if found.
+
+#### Throws
+
+Error if the method is not found.

package/docs/reference/classes/VerificationHelper.md

@@ -0,0 +1,83 @@
+# Class: VerificationHelper
+
+Helper methods for verification.
+
+## Constructors
+
+### new VerificationHelper()
+
+> **new VerificationHelper**(): [`VerificationHelper`](VerificationHelper.md)
+
+#### Returns
+
+[`VerificationHelper`](VerificationHelper.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### verifyJwt()
+
+> **verifyJwt**\<`T`, `U`\>(`resolver`, `jwt`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+Verified the JWT.
+
+#### Type Parameters
+
+• **T** *extends* `IJwtHeader`
+
+• **U** *extends* `IJwtPayload`
+
+#### Parameters
+
+##### resolver
+
+[`IIdentityResolverConnector`](../interfaces/IIdentityResolverConnector.md)
+
+The resolver to use for finding the document.
+
+##### jwt
+
+`string`
+
+The token to verify.
+
+#### Returns
+
+`Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
+
+The decoded payload.
+
+***
+
+### verifyProof()
+
+> **verifyProof**(`resolver`, `secureDocument`): `Promise`\<`boolean`\>
+
+Verified the proof for the document e.g. verifiable credential.
+
+#### Parameters
+
+##### resolver
+
+[`IIdentityResolverConnector`](../interfaces/IIdentityResolverConnector.md)
+
+The resolver to use for finding the document.
+
+##### secureDocument
+
+`IJsonLdNodeObject`
+
+The secure document to verify.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the verification is successful.

package/docs/reference/index.md

@@ -3,7 +3,7 @@
 ## Classes
 
 - [DocumentHelper](classes/DocumentHelper.md)
-- [JwtHelper](classes/JwtHelper.md)
+- [VerificationHelper](classes/VerificationHelper.md)
 
 ## Interfaces
 

package/docs/reference/interfaces/IIdentityComponent.md

@@ -428,9 +428,9 @@ The presentation stored in the jwt and the revocation status.
 
 ### proofCreate()
 
-> **proofCreate**(`verificationMethodId`, `bytes`, `controller`?): `Promise`\<`IDidProof`\>
+> **proofCreate**(`verificationMethodId`, `proofType`, `unsecureDocument`, `controller`?): `Promise`\<`IProof`\>
 
-Create a proof for arbitrary data with the specified verification method.
+Create a proof for a document with the specified verification method.
 
 #### Parameters
 
@@ -440,11 +440,17 @@ Create a proof for arbitrary data with the specified verification method.
 
 The verification method id to use.
 
-##### bytes
+##### proofType
 
-`Uint8Array`
+`ProofTypes`
 
-The data bytes to sign.
+The type of proof to create.
+
+##### unsecureDocument
+
+`IJsonLdNodeObject`
+
+The unsecure document to create the proof for.
 
 ##### controller?
 
@@ -454,7 +460,7 @@ The controller of the identity who can make changes.
 
 #### Returns
 
-`Promise`\<`IDidProof`\>
+`Promise`\<`IProof`\>
 
 The proof.
 
@@ -462,21 +468,21 @@ The proof.
 
 ### proofVerify()
 
-> **proofVerify**(`bytes`, `proof`): `Promise`\<`boolean`\>
+> **proofVerify**(`document`, `proof`): `Promise`\<`boolean`\>
 
-Verify proof for arbitrary data with the specified verification method.
+Verify proof for a document with the specified verification method.
 
 #### Parameters
 
-##### bytes
+##### document
 
-`Uint8Array`
+`IJsonLdNodeObject`
 
-The data bytes to verify.
+The document to verify.
 
 ##### proof
 
-`IDidProof`
+`IProof`
 
 The proof to verify.
 

package/docs/reference/interfaces/IIdentityConnector.md

@@ -422,7 +422,7 @@ The presentation stored in the jwt and the revocation status.
 
 ### createProof()
 
-> **createProof**(`controller`, `verificationMethodId`, `bytes`): `Promise`\<`IDidProof`\>
+> **createProof**(`controller`, `verificationMethodId`, `proofType`, `unsecureDocument`): `Promise`\<`IProof`\>
 
 Create a proof for arbitrary data with the specified verification method.
 
@@ -440,15 +440,21 @@ The controller of the identity who can make changes.
 
 The verification method id to use.
 
-##### bytes
+##### proofType
 
-`Uint8Array`
+`ProofTypes`
 
-The data bytes to sign.
+The type of proof to create.
+
+##### unsecureDocument
+
+`IJsonLdNodeObject`
+
+The unsecure document to create the proof for.
 
 #### Returns
 
-`Promise`\<`IDidProof`\>
+`Promise`\<`IProof`\>
 
 The proof.
 
@@ -456,21 +462,21 @@ The proof.
 
 ### verifyProof()
 
-> **verifyProof**(`bytes`, `proof`): `Promise`\<`boolean`\>
+> **verifyProof**(`document`, `proof`): `Promise`\<`boolean`\>
 
 Verify proof for arbitrary data with the specified verification method.
 
 #### Parameters
 
-##### bytes
+##### document
 
-`Uint8Array`
+`IJsonLdNodeObject`
 
-The data bytes to verify.
+The document to verify.
 
 ##### proof
 
-`IDidProof`
+`IProof`
 
 The proof to verify.
 

package/docs/reference/interfaces/IIdentityProofCreateRequest.md

@@ -30,8 +30,14 @@ The verification method id to use.
 
 The data for the request.
 
-#### bytes
+#### proofType
 
-> **bytes**: `string`
+> **proofType**: `ProofTypes`
 
-The data bytes base64 encoded.
+The type of proof to create.
+
+#### document
+
+> **document**: `IJsonLdNodeObject`
+
+The document to create the proof for.

package/docs/reference/interfaces/IIdentityProofCreateResponse.md

@@ -6,6 +6,6 @@ Response to creating a proof.
 
 ### body
 
-> **body**: `IDidProof`
+> **body**: `IProof`
 
 The response payload.

package/docs/reference/interfaces/IIdentityProofVerifyRequest.md

@@ -10,14 +10,14 @@ Request to verify a proof.
 
 The data for the request.
 
-#### bytes
+#### document
 
-> **bytes**: `string`
+> **document**: `IJsonLdNodeObject`
 
-The data bytes base64 encoded.
+The document to verify the proof for.
 
 #### proof
 
-> **proof**: `IDidProof`
+> **proof**: `IProof`
 
 The proof to verify.

package/locales/en.json

@@ -1,8 +1,13 @@
 {
 	"error": {
-		"jwtHelper": {
+		"verificationHelper": {
 			"jwtDecodeFailed": "Decoding the JWT failed",
-			"jwtPayloadMissingParam": "The JWT is missing the required parameter \"{param}\""
+			"proofTypeNotSupported": "The proof type \"{proofType}\" is not supported",
+			"proofMissingVerificationMethod": "The proof is missing the verification method"
+		},
+		"documentHelper": {
+			"verificationMethodNotFound": "The verification method \"{methodName}\" of type \"{methodType}\" could not be found",
+			"verificationMethodJwkNotFound": "The verification method \"{methodName}\" of type \"{methodType}\" is missing the JWK"
 		}
 	},
 	"verifiableCredentialStates": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.1-next.28",
+	"version": "0.0.1-next.29",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",

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

@@ -1,22 +0,0 @@
-import { type IJwtHeader, type IJwtPayload } from "@twin.org/web";
-/**
- * Helper methods for JSON Web Tokens.
- */
-export declare class JwtHelper {
-    /**
-     * Runtime name for the class.
-     */
-    static readonly CLASS_NAME: string;
-    /**
-     * Parse the token and check that the properties are valid.
-     * @param jwt The token top validate.
-     * @param paramsToCheck Parameters to check they exist.
-     * @returns The token components.
-     * @throws Error if the token is invalid.
-     */
-    static parse<U extends IJwtHeader, T extends IJwtPayload>(jwt: string, paramsToCheck?: string[]): Promise<{
-        header?: U;
-        payload?: T;
-        signature?: Uint8Array;
-    }>;
-}

package/docs/reference/classes/JwtHelper.md

@@ -1,59 +0,0 @@
-# Class: JwtHelper
-
-Helper methods for JSON Web Tokens.
-
-## Constructors
-
-### new JwtHelper()
-
-> **new JwtHelper**(): [`JwtHelper`](JwtHelper.md)
-
-#### Returns
-
-[`JwtHelper`](JwtHelper.md)
-
-## Properties
-
-### CLASS\_NAME
-
-> `readonly` `static` **CLASS\_NAME**: `string`
-
-Runtime name for the class.
-
-## Methods
-
-### parse()
-
-> `static` **parse**\<`U`, `T`\>(`jwt`, `paramsToCheck`?): `Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
-
-Parse the token and check that the properties are valid.
-
-#### Type Parameters
-
-• **U** *extends* `IJwtHeader`
-
-• **T** *extends* `IJwtPayload`
-
-#### Parameters
-
-##### jwt
-
-`string`
-
-The token top validate.
-
-##### paramsToCheck?
-
-`string`[]
-
-Parameters to check they exist.
-
-#### Returns
-
-`Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
-
-The token components.
-
-#### Throws
-
-Error if the token is invalid.