@twin.org/identity-connector-entity-storage 0.0.1-next.19 → 0.0.1-next.21

package/dist/cjs/index.cjs

@@ -36,19 +36,19 @@ exports.IdentityDocument = class IdentityDocument {
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], exports.IdentityDocument.prototype, "id", void 0);
+], exports.IdentityDocument.prototype, "id", undefined);
 __decorate([
     entity.property({ type: "object" }),
     __metadata("design:type", Object)
-], exports.IdentityDocument.prototype, "document", void 0);
+], exports.IdentityDocument.prototype, "document", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.IdentityDocument.prototype, "signature", void 0);
+], exports.IdentityDocument.prototype, "signature", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.IdentityDocument.prototype, "controller", void 0);
+], exports.IdentityDocument.prototype, "controller", undefined);
 exports.IdentityDocument = __decorate([
     entity.entity()
 ], exports.IdentityDocument);
@@ -75,15 +75,15 @@ exports.IdentityProfile = class IdentityProfile {
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], exports.IdentityProfile.prototype, "identity", void 0);
+], exports.IdentityProfile.prototype, "identity", undefined);
 __decorate([
     entity.property({ type: "object" }),
     __metadata("design:type", Object)
-], exports.IdentityProfile.prototype, "publicProfile", void 0);
+], exports.IdentityProfile.prototype, "publicProfile", undefined);
 __decorate([
     entity.property({ type: "object" }),
     __metadata("design:type", Object)
-], exports.IdentityProfile.prototype, "privateProfile", void 0);
+], exports.IdentityProfile.prototype, "privateProfile", undefined);
 exports.IdentityProfile = __decorate([
     entity.entity()
 ], exports.IdentityProfile);
@@ -119,14 +119,34 @@ class EntityStorageIdentityConnector {
     _vaultConnector;
     /**
      * Create a new instance of EntityStorageIdentityConnector.
-     * @param options The dependencies for the identity connector.
-     * @param options.didDocumentEntityStorageType The entity storage for the did documents, defaults to "identity-document".
-     * @param options.vaultConnectorType The vault for the private keys, defaults to "vault".
+     * @param options The options for the identity connector.
      */
     constructor(options) {
         this._didDocumentEntityStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.didDocumentEntityStorageType ?? "identity-document");
         this._vaultConnector = vaultModels.VaultConnectorFactory.get(options?.vaultConnectorType ?? "vault");
     }
+    /**
+     * Build the key name to access the specified key in the vault.
+     * @param identity The identity of the user to access the vault keys.
+     * @returns The vault key.
+     * @internal
+     */
+    static buildVaultKey(identity, key) {
+        return `${identity}/${key}`;
+    }
+    /**
+     * Verify the document in storage.
+     * @param didDocument The did document that was stored.
+     * @internal
+     */
+    static async verifyDocument(didDocument, vaultConnector) {
+        const stringifiedDocument = core.JsonHelper.canonicalize(didDocument.document);
+        const docBytes = core.Converter.utf8ToBytes(stringifiedDocument);
+        const verified = await vaultConnector.verify(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, "did"), docBytes, core.Converter.base64ToBytes(didDocument.signature));
+        if (!verified) {
+            throw new core.GeneralError("EntityStorageIdentityResolverConnector", "signatureVerificationFailed");
+        }
+    }
     /**
      * Create a new document.
      * @param controller The controller of the identity who can make changes.
@@ -136,7 +156,7 @@ class EntityStorageIdentityConnector {
         core.Guards.stringValue(this.CLASS_NAME, "controller", controller);
         try {
             const did = `did:${EntityStorageIdentityConnector.NAMESPACE}:${core.Converter.bytesToHex(core.RandomHelper.generate(32), true)}`;
-            await this._vaultConnector.createKey(this.buildVaultKey(did, "did"), vaultModels.VaultKeyType.Ed25519);
+            await this._vaultConnector.createKey(EntityStorageIdentityConnector.buildVaultKey(did, "did"), vaultModels.VaultKeyType.Ed25519);
             const bitString = new core.BitString(EntityStorageIdentityConnector._REVOCATION_BITS_SIZE);
             const compressed = await core.Compression.compress(bitString.getBits(), core.CompressionType.Gzip);
             const didDocument = {
@@ -156,26 +176,6 @@ class EntityStorageIdentityConnector {
             throw new core.GeneralError(this.CLASS_NAME, "createDocumentFailed", undefined, error);
         }
     }
-    /**
-     * Resolve a document from its id.
-     * @param documentId The id of the document to resolve.
-     * @returns The resolved document.
-     * @throws NotFoundError if the id can not be resolved.
-     */
-    async resolveDocument(documentId) {
-        core.Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
-        try {
-            const didIdentityDocument = await this._didDocumentEntityStorage.get(documentId);
-            if (core.Is.undefined(didIdentityDocument)) {
-                throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", documentId);
-            }
-            await this.verifyDocument(didIdentityDocument);
-            return didIdentityDocument.document;
-        }
-        catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "resolveDocumentFailed", undefined, error);
-        }
-    }
     /**
      * Add a verification method to the document in JSON Web key Format.
      * @param controller The controller of the identity who can make changes.
@@ -195,10 +195,10 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(didIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", documentId);
             }
-            await this.verifyDocument(didIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(didIdentityDocument, this._vaultConnector);
             const didDocument = didIdentityDocument.document;
             const tempKeyId = `temp-vm-${core.Converter.bytesToBase64Url(core.RandomHelper.generate(16))}`;
-            const verificationPublicKey = await this._vaultConnector.createKey(this.buildVaultKey(didDocument.id, tempKeyId), vaultModels.VaultKeyType.Ed25519);
+            const verificationPublicKey = await this._vaultConnector.createKey(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, tempKeyId), vaultModels.VaultKeyType.Ed25519);
             const jwkParams = {
                 alg: "EdDSA",
                 kty: "OKP",
@@ -207,7 +207,7 @@ class EntityStorageIdentityConnector {
             };
             const kid = core.Converter.bytesToBase64Url(crypto.Sha256.sum256(core.Converter.utf8ToBytes(JSON.stringify(jwkParams))));
             const methodId = `${documentId}#${verificationMethodId ?? kid}`;
-            await this._vaultConnector.renameKey(this.buildVaultKey(didDocument.id, tempKeyId), this.buildVaultKey(didDocument.id, verificationMethodId ?? kid));
+            await this._vaultConnector.renameKey(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, tempKeyId), EntityStorageIdentityConnector.buildVaultKey(didDocument.id, verificationMethodId ?? kid));
             const methods = this.getAllMethods(didDocument);
             const existingMethodIndex = methods.findIndex(m => {
                 if (core.Is.string(m.method)) {
@@ -259,7 +259,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(didIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", idParts.id);
             }
-            await this.verifyDocument(didIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(didIdentityDocument, this._vaultConnector);
             const didDocument = didIdentityDocument.document;
             const methods = this.getAllMethods(didDocument);
             const existingMethodIndex = methods.findIndex(m => {
@@ -307,7 +307,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(didIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", documentId);
             }
-            await this.verifyDocument(didIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(didIdentityDocument, this._vaultConnector);
             const didDocument = didIdentityDocument.document;
             const fullServiceId = serviceId.includes("#") ? serviceId : `${documentId}#${serviceId}`;
             if (core.Is.array(didDocument.service)) {
@@ -349,7 +349,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(didIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", idParts.id);
             }
-            await this.verifyDocument(didIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(didIdentityDocument, this._vaultConnector);
             const didDocument = didIdentityDocument.document;
             if (core.Is.array(didDocument.service)) {
                 const existingServiceIndex = didDocument.service.findIndex(s => s.id === serviceId);
@@ -395,7 +395,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(issuerIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", idParts.id);
             }
-            await this.verifyDocument(issuerIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(issuerIdentityDocument, this._vaultConnector);
             const issuerDidDocument = issuerIdentityDocument.document;
             const methods = this.getAllMethods(issuerDidDocument);
             const methodAndArray = methods.find(m => {
@@ -467,7 +467,7 @@ class EntityStorageIdentityConnector {
                 vc: jwtVc
             };
             const signature = await web.Jwt.encodeWithSigner(jwtHeader, jwtPayload, async (alg, key, payload) => {
-                const sig = await this._vaultConnector.sign(this.buildVaultKey(idParts.id, idParts.hash ?? ""), payload);
+                const sig = await this._vaultConnector.sign(EntityStorageIdentityConnector.buildVaultKey(idParts.id, idParts.hash ?? ""), payload);
                 return sig;
             });
             return {
@@ -502,7 +502,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(issuerIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", issuerDocumentId);
             }
-            await this.verifyDocument(issuerIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(issuerIdentityDocument, this._vaultConnector);
             const issuerDidDocument = issuerIdentityDocument.document;
             const methods = this.getAllMethods(issuerDidDocument);
             const methodAndArray = methods.find(m => {
@@ -567,7 +567,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(issuerIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", issuerDocumentId);
             }
-            await this.verifyDocument(issuerIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(issuerIdentityDocument, this._vaultConnector);
             const issuerDidDocument = issuerIdentityDocument.document;
             const revocationService = issuerDidDocument.service?.find(s => s.id.endsWith("#revocation"));
             if (revocationService &&
@@ -607,7 +607,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(issuerIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", issuerDocumentId);
             }
-            await this.verifyDocument(issuerIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(issuerIdentityDocument, this._vaultConnector);
             const issuerDidDocument = issuerIdentityDocument.document;
             const revocationService = issuerDidDocument.service?.find(s => s.id.endsWith("#revocation"));
             if (revocationService &&
@@ -665,7 +665,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(holderIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", idParts.id);
             }
-            await this.verifyDocument(holderIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(holderIdentityDocument, this._vaultConnector);
             const holderDidDocument = holderIdentityDocument.document;
             const methods = this.getAllMethods(holderDidDocument);
             const methodAndArray = methods.find(m => {
@@ -717,7 +717,7 @@ class EntityStorageIdentityConnector {
                 jwtPayload.exp = Math.floor(Date.now() / 1000) + expiresInSeconds;
             }
             const signature = await web.Jwt.encodeWithSigner(jwtHeader, jwtPayload, async (alg, key, payload) => {
-                const sig = await this._vaultConnector.sign(this.buildVaultKey(idParts.id, idParts.hash ?? ""), payload);
+                const sig = await this._vaultConnector.sign(EntityStorageIdentityConnector.buildVaultKey(idParts.id, idParts.hash ?? ""), payload);
                 return sig;
             });
             return {
@@ -752,7 +752,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(holderIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", holderDocumentId);
             }
-            await this.verifyDocument(holderIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(holderIdentityDocument, this._vaultConnector);
             const issuers = [];
             const tokensRevoked = [];
             const verifiablePresentation = jwtPayload?.vp;
@@ -769,7 +769,7 @@ class EntityStorageIdentityConnector {
                             if (core.Is.undefined(issuerDidDocument)) {
                                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", issuerDocumentId);
                             }
-                            await this.verifyDocument(issuerDidDocument);
+                            await EntityStorageIdentityConnector.verifyDocument(issuerDidDocument, this._vaultConnector);
                             issuers.push(issuerDidDocument);
                             const vc = jwt.payload.vc;
                             if (core.Is.object(vc)) {
@@ -818,7 +818,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(didIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", idParts.id);
             }
-            await this.verifyDocument(didIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(didIdentityDocument, this._vaultConnector);
             const didDocument = didIdentityDocument.document;
             const methods = this.getAllMethods(didDocument);
             const methodAndArray = methods.find(m => {
@@ -836,7 +836,7 @@ class EntityStorageIdentityConnector {
                     method: verificationMethodId
                 });
             }
-            const signature = await this._vaultConnector.sign(this.buildVaultKey(didDocument.id, idParts.hash ?? ""), bytes);
+            const signature = await this._vaultConnector.sign(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, idParts.hash ?? ""), bytes);
             return {
                 "@context": standardsW3cDid.DidContexts.ContextVCDataIntegrity,
                 type: standardsW3cDid.DidTypes.DataIntegrityProof,
@@ -879,7 +879,7 @@ class EntityStorageIdentityConnector {
             if (core.Is.undefined(didIdentityDocument)) {
                 throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", idParts.id);
             }
-            await this.verifyDocument(didIdentityDocument);
+            await EntityStorageIdentityConnector.verifyDocument(didIdentityDocument, this._vaultConnector);
             const didDocument = didIdentityDocument.document;
             const methods = this.getAllMethods(didDocument);
             const methodAndArray = methods.find(m => {
@@ -899,7 +899,7 @@ class EntityStorageIdentityConnector {
                     method: proof.verificationMethodId
                 });
             }
-            return this._vaultConnector.verify(this.buildVaultKey(didIdentityDocument.id, idParts.hash), bytes, core.Converter.base58ToBytes(proof.proofValue));
+            return this._vaultConnector.verify(EntityStorageIdentityConnector.buildVaultKey(didIdentityDocument.id, idParts.hash), bytes, core.Converter.base58ToBytes(proof.proofValue));
         }
         catch (error) {
             throw new core.GeneralError(this.CLASS_NAME, "verifyProofFailed", undefined, error);
@@ -952,19 +952,6 @@ class EntityStorageIdentityConnector {
         }
         return false;
     }
-    /**
-     * Verify the document in storage.
-     * @param didDocument The did document that was stored.
-     * @internal
-     */
-    async verifyDocument(didDocument) {
-        const stringifiedDocument = core.JsonHelper.canonicalize(didDocument.document);
-        const docBytes = core.Converter.utf8ToBytes(stringifiedDocument);
-        const verified = await this._vaultConnector.verify(this.buildVaultKey(didDocument.id, "did"), docBytes, core.Converter.base64ToBytes(didDocument.signature));
-        if (!verified) {
-            throw new core.GeneralError(this.CLASS_NAME, "signatureVerificationFailed");
-        }
-    }
     /**
      * Update the document in storage.
      * @param controller The controller of the document.
@@ -974,7 +961,7 @@ class EntityStorageIdentityConnector {
     async updateDocument(controller, didDocument) {
         const stringifiedDocument = core.JsonHelper.canonicalize(didDocument);
         const docBytes = core.Converter.utf8ToBytes(stringifiedDocument);
-        const signature = await this._vaultConnector.sign(this.buildVaultKey(didDocument.id, "did"), docBytes);
+        const signature = await this._vaultConnector.sign(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, "did"), docBytes);
         await this._didDocumentEntityStorage.set({
             id: didDocument.id,
             document: didDocument,
@@ -982,15 +969,6 @@ class EntityStorageIdentityConnector {
             controller
         });
     }
-    /**
-     * Build the key name to access the specified key in the vault.
-     * @param identity The identity of the user to access the vault keys.
-     * @returns The vault key.
-     * @internal
-     */
-    buildVaultKey(identity, key) {
-        return `${identity}/${key}`;
-    }
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -1013,9 +991,8 @@ class EntityStorageIdentityProfileConnector {
      */
     _profileEntityStorage;
     /**
-     * Create a new instance of Identity.
-     * @param options The dependencies for the identity service.
-     * @param options.profileEntityStorageType The storage connector for the profiles, default to "identity-profile".
+     * Create a new instance of EntityStorageIdentityProfileConnector.
+     * @param options The options for the identity service.
      */
     constructor(options) {
         this._profileEntityStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.profileEntityStorageType ?? "identity-profile");
@@ -1187,6 +1164,60 @@ class EntityStorageIdentityProfileConnector {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class for performing identity operations using entity storage.
+ */
+class EntityStorageIdentityResolverConnector {
+    /**
+     * The namespace supported by the identity connector.
+     */
+    static NAMESPACE = "entity-storage";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "EntityStorageIdentityResolverConnector";
+    /**
+     * The entity storage for identities.
+     * @internal
+     */
+    _didDocumentEntityStorage;
+    /**
+     * The vault for the keys.
+     * @internal
+     */
+    _vaultConnector;
+    /**
+     * Create a new instance of EntityStorageIdentityResolverConnector.
+     * @param options The options for the identity connector.
+     */
+    constructor(options) {
+        this._didDocumentEntityStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.didDocumentEntityStorageType ?? "identity-document");
+        this._vaultConnector = vaultModels.VaultConnectorFactory.get(options?.vaultConnectorType ?? "vault");
+    }
+    /**
+     * Resolve a document from its id.
+     * @param documentId The id of the document to resolve.
+     * @returns The resolved document.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    async resolveDocument(documentId) {
+        core.Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
+        try {
+            const didIdentityDocument = await this._didDocumentEntityStorage.get(documentId);
+            if (core.Is.undefined(didIdentityDocument)) {
+                throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", documentId);
+            }
+            await EntityStorageIdentityConnector.verifyDocument(didIdentityDocument, this._vaultConnector);
+            return didIdentityDocument.document;
+        }
+        catch (error) {
+            throw new core.GeneralError(this.CLASS_NAME, "resolveDocumentFailed", undefined, error);
+        }
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -1206,4 +1237,5 @@ function initSchema(options) {
 
 exports.EntityStorageIdentityConnector = EntityStorageIdentityConnector;
 exports.EntityStorageIdentityProfileConnector = EntityStorageIdentityProfileConnector;
+exports.EntityStorageIdentityResolverConnector = EntityStorageIdentityResolverConnector;
 exports.initSchema = initSchema;