Merge pull request #1089 from eordano/check/hdpriv

Add precondition checks to HDPrivateKey.from*

lib/hdprivatekey.js

@@ -4,6 +4,7 @@
 var assert = require('assert');
 var buffer = require('buffer');
 var _ = require('lodash');
+var $ = require('./util/preconditions');
 
 var BN = require('./crypto/bn');
 var Base58 = require('./encoding/base58');
@@ -277,7 +278,18 @@ HDPrivateKey._validateNetwork = function(data, networkArg) {
   return null;
 };
 
-HDPrivateKey.fromJSON = HDPrivateKey.fromObject = HDPrivateKey.fromString = function(arg) {
+HDPrivateKey.fromJSON = function(arg) {
+  $.checkArgument(JSUtil.isValidJSON(arg), 'No valid JSON string was provided');
+  return new HDPrivateKey(arg);
+};
+
+HDPrivateKey.fromString = function(arg) {
+  $.checkArgument(_.isString(arg), 'No valid string was provided');
+  return new HDPrivateKey(arg);
+};
+
+HDPrivateKey.fromObject = function(arg) {
+  $.checkArgument(_.isObject(arg), 'No valid argument was provided');
   return new HDPrivateKey(arg);
 };
 

lib/hdpublickey.js

@@ -1,6 +1,8 @@
 'use strict';
 
 var _ = require('lodash');
+var $ = require('./util/preconditions');
+
 var BN = require('./crypto/bn');
 var Base58 = require('./encoding/base58');
 var Base58Check = require('./encoding/base58check');
@@ -356,7 +358,18 @@ HDPublicKey._validateBufferArguments = function (arg) {
   }
 };
 
-HDPublicKey.fromString = HDPublicKey.fromObject = HDPublicKey.fromJSON = function(arg) {
+HDPublicKey.fromJSON = function(arg) {
+  $.checkArgument(JSUtil.isValidJSON(arg), 'No valid JSON string was provided');
+  return new HDPublicKey(arg);
+};
+
+HDPublicKey.fromObject = function(arg) {
+  $.checkArgument(_.isObject(arg), 'No valid argument was provided');
+  return new HDPublicKey(arg);
+};
+
+HDPublicKey.fromString = function(arg) {
+  $.checkArgument(_.isString(arg), 'No valid string was provided');
   return new HDPublicKey(arg);
 };
 

lib/util/js.js

@@ -29,6 +29,9 @@ module.exports = {
    */
   isValidJSON: function isValidJSON(arg) {
     var parsed;
+    if (!_.isString(arg)) {
+      return false;
+    }
     try {
       parsed = JSON.parse(arg);
     } catch (e) {

test/hdkeys.js

@@ -10,12 +10,48 @@
 /* jshint maxstatements: 100 */
 /* jshint unused: false */
 
+var _ = require('lodash');
 var should = require('chai').should();
+var expect = require('chai').expect;
 var bitcore = require('..');
 var Networks = bitcore.Networks;
 var HDPrivateKey = bitcore.HDPrivateKey;
 var HDPublicKey = bitcore.HDPublicKey;
 
+describe('HDKeys building with static methods', function() {
+  var classes = [HDPublicKey, HDPrivateKey];
+  var clazz, index;
+
+  _.each(classes, function(clazz) {
+    var expectStaticMethodFail = function(staticMethod, argument, message) {
+      expect(clazz[staticMethod].bind(null, argument)).to.throw(message);
+    };
+    it(clazz.name + ' fromJSON checks that a valid JSON is provided', function() {
+      var errorMessage = 'No valid JSON string was provided';
+      var method = 'fromJSON';
+      expectStaticMethodFail(method, undefined, errorMessage);
+      expectStaticMethodFail(method, null, errorMessage);
+      expectStaticMethodFail(method, 'invalid JSON', errorMessage);
+      expectStaticMethodFail(method, '{\'singlequotes\': true}', errorMessage);
+      expectStaticMethodFail(method, {}, errorMessage);
+    });
+    it(clazz.name + ' fromString checks that a string is provided', function() {
+      var errorMessage = 'No valid string was provided';
+      var method = 'fromString';
+      expectStaticMethodFail(method, undefined, errorMessage);
+      expectStaticMethodFail(method, null, errorMessage);
+      expectStaticMethodFail(method, {}, errorMessage);
+    });
+    it(clazz.name + ' fromObject checks that an object is provided', function() {
+      var errorMessage = 'No valid argument was provided';
+      var method = 'fromObject';
+      expectStaticMethodFail(method, undefined, errorMessage);
+      expectStaticMethodFail(method, null, errorMessage);
+      expectStaticMethodFail(method, '', errorMessage);
+    });
+  });
+});
+
 describe('BIP32 compliance', function() {
 
   it('should initialize test vector 1 from the extended public key', function() {

test/hdprivatekey.js

@@ -78,15 +78,14 @@ describe('HDPrivate key interface', function() {
     ));
   });
 
-  describe('should error with a nonsensical argument', function() {
-    it('like a number', function() {
+  describe('instantiation', function() {
+    it('invalid argument: can not instantiate from a number', function() {
       expectFailBuilding(1, hdErrors.UnrecognizedArgument);
     });
-  });
-
     it('allows no-new calling', function() {
       HDPrivateKey(xprivkey).toString().should.equal(xprivkey);
     });
+  });
 
   it('inspect() displays correctly', function() {
     HDPrivateKey(xprivkey).inspect().should.equal('<HDPrivateKey: ' + xprivkey + '>');

test/hdpublickey.js

@@ -122,7 +122,6 @@ describe('HDPublicKey interface', function() {
         return new HDPublicKey(buffers);
       }, errors.InvalidB58Checksum);
     });
-
   });
 
   describe('error checking on serialization', function() {