@icure/api 4.1.17 → 4.2.1

package/icc-x-api/icc-crypto-x-api.js

@@ -263,7 +263,7 @@ class IccCryptoXApi {
      * the delegations.
      * 3. Decrypt's delegators' keys and returns them.
      *
-     * @param healthcarePartyId : the id of the delegate HCP
+     * @param dataOwnerId : the id of the delegate HCP
      * @param delegations : generic delegations (can be SPKs, CFKs, EKs) for all delegates
      * @param fallbackOnParent  default true; use parent's healthCarePartyId in case there's no delegation for the `healthcarePartyId`
      * @returns  - **delegatorId** : the id of the delegator HcP that shares the **key** with the `healthcarePartyId`
@@ -271,18 +271,18 @@ class IccCryptoXApi {
      */
     decryptAndImportAesHcPartyKeysInDelegations(
     //TODO: suggested name: getDecryptedHcPKeysOfDelegateAndParentsFromGenericDelegations
-    healthcarePartyId, delegations, fallbackOnParent = true) {
+    dataOwnerId, delegations, fallbackOnParent = true) {
         const delegatorIds = {};
-        const delegationsArray = delegations[healthcarePartyId];
+        const delegationsArray = delegations[dataOwnerId];
         if (delegationsArray && delegationsArray.length) {
             delegationsArray.forEach(function (delegationItem) {
                 delegatorIds[delegationItem.owner] = true; //TODO: why is set to true?
             });
         }
         else if (fallbackOnParent) {
-            return this.getDataOwner(healthcarePartyId).then(({ dataOwner: hcp }) => hcp.parentId ? this.decryptAndImportAesHcPartyKeysInDelegations(hcp.parentId, delegations) : Promise.resolve([]));
+            return this.getDataOwner(dataOwnerId).then(({ dataOwner: hcp }) => hcp.parentId ? this.decryptAndImportAesHcPartyKeysInDelegations(hcp.parentId, delegations) : Promise.resolve([]));
         }
-        return this.decryptAndImportAesHcPartyKeysForDelegators(Object.keys(delegatorIds), healthcarePartyId);
+        return this.decryptAndImportAesHcPartyKeysForDelegators(Object.keys(delegatorIds), dataOwnerId);
     }
     /**
      * Retreive the owner HealthCareParty key and use it to encrypt
@@ -674,31 +674,31 @@ class IccCryptoXApi {
     }
     /**
      * Get decrypted generic secret IDs (secretIdSPKs, parentIds, secretIdEKs) from generic delegations (SPKs, CFKs, EKs)
-     * 1. Get HealthCareParty from it's Id.
-     * 2. Decrypt the keys of the given HCP.
+     * 1. Get Data Owner (HCP, Patient or Device) from it's Id.
+     * 2. Decrypt the keys of the given data owner.
      * 3. Decrypt the parent's key if it has parent.
      * 4. Return the decrypted key corresponding to the Health Care Party.
-     * @param hcpartyId : the id of the delegate HcP (including its parents) for which to decrypt `extractedKeys`
+     * @param dataOwnerId : the id of the delegate data owner (including its parents) for which to decrypt `extractedKeys`
      * @param objectId : the id of the object/document of which delegations to decrypt ; used just to log to console a message (Cryptographic mistake) in case the object id inside SPK, CFK, EK is different from this one
      * @param delegations : generic delegations (can be SPKs, CFKs, EKs) for all delegates from where to extract `extractedKeys`
-     * @returns - **extractedKeys** array containing secret IDs from decrypted generic delegations, from both HCP with given `hcpartyId` and its parents; can contain duplicates
-     * - **hcpartyId** the given `hcpartyId` OR, if a parent exist, the HCP id of the top parent in the hierarchy  (even if that parent has no delegations)
+     * @returns - **extractedKeys** array containing secret IDs from decrypted generic delegations, from both data owner with given `dataOwnerId` and its parents; can contain duplicates
+     * - **dataOwnerId** the given `dataOwnerId` OR, if a parent exist, the data owner id of the top parent in the hierarchy  (even if that parent has no delegations)
      */
-    //TODO: even if there are no delegations for parent HCP (but the parent exists), the returned hcpartyId will be the one of the parent
+    //TODO: even if there are no delegations for parent HCP (but the parent exists), the returned dataOwnerId will be the one of the parent
     extractKeysFromDelegationsForHcpHierarchy(
     //TODO suggested name: getSecretIdsOfHcpAndParentsFromGenericDelegations
-    hcpartyId, objectId, delegations) {
-        return this.getDataOwner(hcpartyId).then(({ dataOwner: hcp }) => (delegations[hcpartyId] && delegations[hcpartyId].length
-            ? this.decryptAndImportAesHcPartyKeysInDelegations(hcpartyId, delegations, false).then((decryptedAndImportedAesHcPartyKeys) => {
+    dataOwnerId, objectId, delegations) {
+        return this.getDataOwner(dataOwnerId).then(({ dataOwner: hcp }) => (delegations[dataOwnerId] && delegations[dataOwnerId].length
+            ? this.decryptAndImportAesHcPartyKeysInDelegations(dataOwnerId, delegations, false).then((decryptedAndImportedAesHcPartyKeys) => {
                 const collatedAesKeysFromDelegatorToHcpartyId = {};
                 decryptedAndImportedAesHcPartyKeys.forEach((k) => (collatedAesKeysFromDelegatorToHcpartyId[k.delegatorId] = k));
-                return this.decryptKeyInDelegationLikes(delegations[hcpartyId], collatedAesKeysFromDelegatorToHcpartyId, objectId);
+                return this.decryptKeyInDelegationLikes(delegations[dataOwnerId], collatedAesKeysFromDelegatorToHcpartyId, objectId);
             })
             : Promise.resolve([])).then((extractedKeys) => hcp.parentId
             ? this.extractKeysFromDelegationsForHcpHierarchy(hcp.parentId, objectId, delegations).then((parentResponse) => _.assign(parentResponse, {
                 extractedKeys: parentResponse.extractedKeys.concat(extractedKeys),
             }))
-            : { extractedKeys: extractedKeys, hcpartyId: hcpartyId }));
+            : { extractedKeys: extractedKeys, hcpartyId: dataOwnerId }));
     }
     /**
      * Gets an array of generic secret IDs decrypted from a list of generic delegations (SPKs, CFKs, EKs) `delegationsArray`
@@ -990,13 +990,13 @@ class IccCryptoXApi {
         })));
     }
     // noinspection JSUnusedGlobalSymbols
-    checkPrivateKeyValidity(hcp) {
+    checkPrivateKeyValidity(dataOwner) {
         return new Promise((resolve) => {
             this._RSA
-                .importKey('jwk', this._utils.spkiToJwk(binary_utils_1.hex2ua(hcp.publicKey)), ['encrypt'])
+                .importKey('jwk', this._utils.spkiToJwk(binary_utils_1.hex2ua(dataOwner.publicKey)), ['encrypt'])
                 .then((k) => this._RSA.encrypt(k, binary_utils_1.utf8_2ua('shibboleth')))
                 .then((cipher) => {
-                const kp = this._RSA.loadKeyPairNotImported(hcp.id);
+                const kp = this._RSA.loadKeyPairNotImported(dataOwner.id);
                 return this._RSA
                     .importKeyPair('jwk', kp.privateKey, 'jwk', kp.publicKey)
                     .then((ikp) => this._RSA.decrypt(ikp.privateKey, new Uint8Array(cipher)));
@@ -1024,10 +1024,10 @@ class IccCryptoXApi {
         }
         throw '### THIS SHOULD NOT HAPPEN: ' + argName + ' has an invalid value: ' + argValue + details;
     }
-    getEncryptionDecryptionKeys(healthcarePartyId, document) {
+    getEncryptionDecryptionKeys(dataOwnerId, document) {
         return !document.id
             ? Promise.resolve(null)
-            : this.extractKeysFromDelegationsForHcpHierarchy(healthcarePartyId, document.id, (document.encryptionKeys && Object.keys(document.encryptionKeys).length && document.encryptionKeys) || document.delegations)
+            : this.extractKeysFromDelegationsForHcpHierarchy(dataOwnerId, document.id, (document.encryptionKeys && Object.keys(document.encryptionKeys).length && document.encryptionKeys) || document.delegations)
                 .then(({ extractedKeys }) => _.uniq(extractedKeys))
                 .catch(() => null);
     }