fix copayerName decrypt in certain cases

Author: matiu

bitcore-wallet-client.min.js

@@ -164,23 +164,6 @@ API._encryptMessage = function(message, encryptingKey) {
   return Utils.encryptMessage(message, encryptingKey);
 };
 
-/**
- * Decrypt a message
- * @private
- * @static
- * @memberof Client.API
- * @param {String} message
- * @param {String} encryptingKey
- */
-API._decryptMessage = function(message, encryptingKey) {
-  if (!message) return '';
-  try {
-    return Utils.decryptMessage(message, encryptingKey);
-  } catch (ex) {
-    return '<ECANNOTDECRYPT>';
-  }
-};
-
 API.prototype._processTxNotes = function(notes) {
   var self = this;
 
@@ -189,9 +172,9 @@ API.prototype._processTxNotes = function(notes) {
   var encryptingKey = self.credentials.sharedEncryptingKey;
   _.each([].concat(notes), function(note) {
     note.encryptedBody = note.body;
-    note.body = API._decryptMessage(note.body, encryptingKey);
+    note.body = Utils.decryptMessageNoThrow(note.body, encryptingKey);
     note.encryptedEditedByName = note.editedByName;
-    note.editedByName = API._decryptMessage(note.editedByName, encryptingKey);
+    note.editedByName = Utils.decryptMessageNoThrow(note.editedByName, encryptingKey);
   });
 };
 
@@ -210,18 +193,21 @@ API.prototype._processTxps = function(txps) {
   var encryptingKey = self.credentials.sharedEncryptingKey;
   _.each([].concat(txps), function(txp) {
     txp.encryptedMessage = txp.message;
-    txp.message = API._decryptMessage(txp.message, encryptingKey) || null;
-    txp.creatorName = API._decryptMessage(txp.creatorName, encryptingKey);
+    txp.message = Utils.decryptMessageNoThrow(txp.message, encryptingKey) || null;
+    txp.creatorName = Utils.decryptMessageNoThrow(txp.creatorName, encryptingKey);
 
     _.each(txp.actions, function(action) {
-      action.copayerName = API._decryptMessage(action.copayerName, encryptingKey);
-      action.comment = API._decryptMessage(action.comment, encryptingKey);
+
+      // CopayerName encryption is optional (not available in older wallets)
+      action.copayerName = Utils.decryptMessageNoThrow(action.copayerName, encryptingKey);
+
+      action.comment = Utils.decryptMessageNoThrow(action.comment, encryptingKey);
       // TODO get copayerName from Credentials -> copayerId to copayerName
       // action.copayerName = null;
     });
     _.each(txp.outputs, function(output) {
       output.encryptedMessage = output.message;
-      output.message = API._decryptMessage(output.message, encryptingKey) || null;
+      output.message = Utils.decryptMessageNoThrow(output.message, encryptingKey) || null;
     });
     txp.hasUnconfirmedInputs = _.some(txp.inputs, function(input) {
       return input.confirmations == 0;

lib/api.js

@@ -43,15 +43,36 @@ Utils.decryptMessage = function(cyphertextJson, encryptingKey) {
 
 
 Utils.decryptMessageNoThrow = function(cyphertextJson, encryptingKey) {
+  function isJsonString(str) {
+    var r;
+    try {
+      r=JSON.parse(str);
+    } catch (e) {
+      return false;
+    }
+    return r;
+  }
+
+  if (!encryptingKey)
+    return '<ECANNOTDECRYPT>';
+
+  if (!cyphertextJson)
+    return '';
+
+  // no sjcl encrypted json
+  var r= isJsonString(cyphertextJson);
+  if (!r|| !r.iv || !r.ct) {
+    return cyphertextJson;
+  }
+
   try {
     return Utils.decryptMessage(cyphertextJson, encryptingKey);
   } catch (e) {
-    return cyphertextJson;
+    return '<ECANNOTDECRYPT>';
   }
 };
 
 
-
 /* TODO: It would be nice to be compatible with bitcoind signmessage. How
  * the hash is calculated there? */
 Utils.hashMessage = function(text) {

lib/common/utils.js

@@ -2,7 +2,7 @@
   "name": "bitcore-wallet-client",
   "description": "Client for bitcore-wallet-service",
   "author": "BitPay Inc",
-  "version": "6.7.4",
+  "version": "6.7.5",
   "license": "MIT",
   "keywords": [
     "bitcoin",

package-lock.json

@@ -204,11 +204,47 @@ describe('Utils', function() {
     it('should encrypt and decrypt', function() {
       var pwd = "ezDRS2NRchMJLf1IWtjL5A==";
       var ct = Utils.encryptMessage('hello world', pwd);
-      var msg = Utils.decryptMessageNoThrow(ct, 'test');
-      // returns encrypted json
-      should.exist(JSON.parse(msg).iv);
-      should.exist(JSON.parse(msg).ct);
+      var msg = Utils.decryptMessageNoThrow(ct, pwd);
+
+      msg.should.equal('hello world');
+    });
+
+    it('should encrypt and  fail to decrypt', function() {
+      var pwd = "ezDRS2NRchMJLf1IWtjL5A==";
+      var ct = Utils.encryptMessage('hello world', pwd);
+      var msg = Utils.decryptMessageNoThrow(ct, 'hola');
+
+      msg.should.equal('<ECANNOTDECRYPT>');
+    });
+
+
+    it('should failover to decrypt a non-encrypted msg' , function() {
+      var pwd = "ezDRS2NRchMJLf1IWtjL5A==";
+      var msg = Utils.decryptMessageNoThrow('hola mundo', 'hola');
+
+      msg.should.equal('hola mundo');
+    });
+ 
+    it('should failover to decrypt a non-encrypted msg (case 2)' , function() {
+      var pwd = "ezDRS2NRchMJLf1IWtjL5A==";
+      var msg = Utils.decryptMessageNoThrow('{"pepe":1}', 'hola');
+
+      msg.should.equal('{"pepe":1}');
     });
+
+
+    it('should no try to decrypt empty', function() {
+      var msg = Utils.decryptMessageNoThrow('', 'hola');
+      msg.should.equal('');
+    });
+
+
+    it('should no try to decrypt null', function() {
+      var msg = Utils.decryptMessageNoThrow(null, 'hola');
+      msg.should.equal('');
+    });
+
+ 
   });