spec: add more openssl tests (#49)

* spec: ensure addresses to be instance of self

* lib: trim whitespaces

* spec: trim whitespaces

* spec: add wobine's blackboard series' keys

* spec: add tests for validating points

* spec: add bitcoin wiki keys

Author: q9f

lib/money-tree.rb

@@ -8,5 +8,4 @@
 require "money-tree/node"
 
 module MoneyTree
-  
 end

lib/money-tree/address.rb

@@ -1,13 +1,13 @@
 module MoneyTree
   class Address
     attr_reader :private_key, :public_key
-    
+
     def initialize(opts = {})
       private_key = opts.delete(:private_key)
       @private_key = MoneyTree::PrivateKey.new({ key: private_key }.merge(opts))
       @public_key = MoneyTree::PublicKey.new(@private_key, opts)
     end
-    
+
     def to_s(network: :bitcoin)
       public_key.to_s(network: network)
     end

lib/money-tree/support.rb

@@ -4,11 +4,11 @@
 module MoneyTree
   module Support
     include OpenSSL
-    
+
     INT32_MAX = 256 ** [1].pack("L*").size
     INT64_MAX = 256 ** [1].pack("Q*").size
     BASE58_CHARS = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"
-    
+
     def int_to_base58(int_val, leading_zero_bytes=0)
       base58_val, base = '', BASE58_CHARS.size
       while int_val > 0
@@ -40,61 +40,61 @@ def decode_base58(base58_val)
       s
     end
     alias_method :base58_to_hex, :decode_base58
-    
+
     def to_serialized_base58(hex)
       hash = sha256 hex
       hash = sha256 hash
       checksum = hash.slice(0..7)
       address = hex + checksum
       encode_base58 address
     end
-    
+
     def from_serialized_base58(base58)
       hex = decode_base58 base58
       checksum = hex.slice!(-8..-1)
       compare_checksum = sha256(sha256(hex)).slice(0..7)
       raise EncodingError unless checksum == compare_checksum
       hex
     end
-    
+
     def digestify(digest_type, source, opts = {})
       source = [source].pack("H*") unless opts[:ascii]
       bytes_to_hex Digest.digest(digest_type, source)
     end
-    
+
     def sha256(source, opts = {})
       digestify('SHA256', source, opts)
     end
-    
+
     def ripemd160(source, opts = {})
       digestify('RIPEMD160', source, opts)
     end
-    
+
     def encode_base64(hex)
       Base64.encode64([hex].pack("H*")).chomp
     end
-    
+
     def decode_base64(base64)
       Base64.decode64(base64).unpack("H*")[0]
     end
-    
+
     def hmac_sha512(key, message)
       digest = Digest::SHA512.new
       HMAC.digest digest, key, message
     end
-    
+
     def hmac_sha512_hex(key, message)
       md = hmac_sha512(key, message)
       md.unpack("H*").first.rjust(64, '0')
     end
-    
+
     def bytes_to_int(bytes, base = 16)
       if bytes.is_a?(Array)
         bytes = bytes.pack("C*")
       end
       bytes.unpack("H*")[0].to_i(16)
     end
-    
+
     def int_to_hex(i, size=nil)
       hex = i.to_s(16).downcase
       if (hex.size % 2) != 0
@@ -107,19 +107,19 @@ def int_to_hex(i, size=nil)
         hex
       end
     end
-        
+
     def int_to_bytes(i)
       [int_to_hex(i)].pack("H*")
     end
-    
+
     def bytes_to_hex(bytes)
       bytes.unpack("H*")[0].downcase
     end
-    
+
     def hex_to_bytes(hex)
       [hex].pack("H*")
     end
-    
+
     def hex_to_int(hex)
       hex.to_i(16)
     end

lib/openssl_extensions.rb

@@ -6,28 +6,23 @@ module MoneyTree
   module OpenSSLExtensions
     def self.add(point_0, point_1)
       validate_points(point_0, point_1)
-
       group = OpenSSL::PKey::EC::Group.new('secp256k1')
-      
       point_0_hex = point_0.to_bn.to_s(16)
       point_0_pt = OpenSSL::PKey::EC::Point.new(group, OpenSSL::BN.new(point_0_hex, 16))
       point_1_hex = point_1.to_bn.to_s(16)
       point_1_pt = OpenSSL::PKey::EC::Point.new(group, OpenSSL::BN.new(point_1_hex, 16))
-
       sum_point = point_0_pt.add(point_1_pt)
-
       sum_point.to_bn.to_s(16)
     end
 
     def self.validate_points(*points)
       points.each do |point|
         if !point.is_a?(OpenSSL::PKey::EC::Point)
-          raise ArgumentError, "point must be an OpenSSL::PKey::EC::Point object" 
+          raise ArgumentError, "point must be an OpenSSL::PKey::EC::Point object"
         elsif point.infinity?
-          raise ArgumentError, "point must not be infinity" 
+          raise ArgumentError, "point must not be infinity"
         end
       end
     end
   end
 end
-

spec/lib/money-tree/address_spec.rb

@@ -4,14 +4,20 @@
   describe "initialize" do
     it "generates a private key by default" do
       address = MoneyTree::Address.new
+      expect(address).to be
+      expect(address).to be_instance_of MoneyTree::Address
+      expect(address.private_key).to be_instance_of MoneyTree::PrivateKey
       expect(address.private_key.key.length).to eql(64)
     end
-    
+
     it "generates a public key by default" do
       address = MoneyTree::Address.new
+      expect(address).to be
+      expect(address).to be_instance_of MoneyTree::Address
+      expect(address.public_key).to be_instance_of MoneyTree::PublicKey
       expect(address.public_key.key.length).to eql(66)
     end
-        
+
     it "imports a private key in hex form" do
       address = MoneyTree::Address.new private_key: "5eae5375fb5f7a0ea650566363befa2830ef441bdcb19198adf318faee86d64b"
       expect(address.private_key.key).to eql("5eae5375fb5f7a0ea650566363befa2830ef441bdcb19198adf318faee86d64b")
@@ -20,36 +26,46 @@
       expect(address.private_key.to_s).to eql("KzPkwAXJ4wtXHnbamTaJqoMrzwCUUJaqhUxnqYhnZvZH6KhgmDPK")
       expect(address.public_key.to_s).to eql("13uVqa35BMo4mYq9LiZrXVzoz9EFZ6aoXe")
     end
-    
+
     it "imports a private key in compressed wif format" do
       address = MoneyTree::Address.new private_key: "KzPkwAXJ4wtXHnbamTaJqoMrzwCUUJaqhUxnqYhnZvZH6KhgmDPK"
       expect(address.private_key.key).to eql("5eae5375fb5f7a0ea650566363befa2830ef441bdcb19198adf318faee86d64b")
       expect(address.public_key.key).to eql("022dfc2557a007c93092c2915f11e8aa70c4f399a6753e2e908330014091580e4b")
       expect(address.to_s).to eql("13uVqa35BMo4mYq9LiZrXVzoz9EFZ6aoXe")
     end
-    
+
     it "imports a private key in uncompressed wif format" do
       address = MoneyTree::Address.new private_key: "5JXz5ZyFk31oHVTQxqce7yitCmTAPxBqeGQ4b7H3Aj3L45wUhoa"
       expect(address.private_key.key).to eql("5eae5375fb5f7a0ea650566363befa2830ef441bdcb19198adf318faee86d64b")
       expect(address.public_key.key).to eql("022dfc2557a007c93092c2915f11e8aa70c4f399a6753e2e908330014091580e4b")
     end
   end
-  
+
   describe "to_s" do
     before do
       @address = MoneyTree::Address.new private_key: "5eae5375fb5f7a0ea650566363befa2830ef441bdcb19198adf318faee86d64b"
     end
-    
+
     it "returns compressed base58 public key" do
       expect(@address.to_s).to eql("13uVqa35BMo4mYq9LiZrXVzoz9EFZ6aoXe")
       expect(@address.public_key.to_s).to eql("13uVqa35BMo4mYq9LiZrXVzoz9EFZ6aoXe")
     end
-    
+
     it "returns compressed WIF private key" do
       expect(@address.private_key.to_s).to eql("KzPkwAXJ4wtXHnbamTaJqoMrzwCUUJaqhUxnqYhnZvZH6KhgmDPK")
     end
   end
 
+  context "bitcoin wiki" do
+    # ref https://en.bitcoin.it/wiki/Technical_background_of_version_1_Bitcoin_addresses
+    subject(:wiki) { MoneyTree::Address.new private_key: '18e14a7b6a307f426a94f8114701e7c8e774e7f9a47e2c2035db29a206321725' }
+
+    it "always regenerates the bitcoin wiki example" do
+      expect(wiki.public_key.key).to eq "0250863ad64a87ae8a2fe83c1af1a8403cb53f53e486d8511dad8a04887e5b2352"
+      expect(wiki.to_s).to eq "1PMycacnJaSqwwJqjawXBErnLsZ7RkXUAs"
+    end
+  end
+
   context "testnet3" do
     before do
       @address = MoneyTree::Address.new network: :bitcoin_testnet

spec/lib/money-tree/openssl_extensions_spec.rb

@@ -42,6 +42,13 @@
       expect { MoneyTree::OpenSSLExtensions.add(0, point_2) }.to raise_error(ArgumentError)
       expect { MoneyTree::OpenSSLExtensions.add(point_infinity, point_2) }.to raise_error(ArgumentError)
       expect { MoneyTree::OpenSSLExtensions.add(point_1, point_2) }.to_not raise_error
+      expect { MoneyTree::OpenSSLExtensions.validate_points(point_1) }.to_not raise_error
+    end
+
+    it "validates points correctly" do
+      expect { MoneyTree::OpenSSLExtensions.validate_points(point_1) }.to_not raise_error
+      expect { MoneyTree::OpenSSLExtensions.validate_points(point_2) }.to_not raise_error
+      expect { MoneyTree::OpenSSLExtensions.validate_points(point_infinity) }.to raise_error(ArgumentError)
     end
 
     it "should add points correctly" do

spec/lib/money-tree/private_key_spec.rb

@@ -4,7 +4,7 @@
   before do
     @key = MoneyTree::PrivateKey.new key: "5eae5375fb5f7a0ea650566363befa2830ef441bdcb19198adf318faee86d64b"
   end
-  
+
   describe "to_hex" do
     it "has 64 characters" do
       # must always be 64 characters - leading zeroes need to be preserved!
@@ -15,81 +15,81 @@
       master = MoneyTree::Master.new seed_hex: "9cf6b6e8451c7d551cb402e2997566e5c7c258543eadb184f9f39322b2e6959b"
       expect(master.node_for_path("m/427").private_key.to_hex.length).to eql(64)
     end
-    
+
     it "is a valid hex" do
-      expect(@key.to_hex).to eql('5eae5375fb5f7a0ea650566363befa2830ef441bdcb19198adf318faee86d64b'      )
+      expect(@key.to_hex).to eql('5eae5375fb5f7a0ea650566363befa2830ef441bdcb19198adf318faee86d64b')
     end
   end
-  
+
   describe "to_wif" do
     it "is a 52 character base58 key" do
       expect(@key.to_wif.length).to eql(52)
     end
-    
+
     it "starts with K or L" do
       expect(%w(K L)).to include(@key.to_wif[0])
     end
-    
+
     it "is a valid compressed wif" do
-      expect(@key.to_wif).to eql('KzPkwAXJ4wtXHnbamTaJqoMrzwCUUJaqhUxnqYhnZvZH6KhgmDPK'      )
+      expect(@key.to_wif).to eql('KzPkwAXJ4wtXHnbamTaJqoMrzwCUUJaqhUxnqYhnZvZH6KhgmDPK')
     end
   end
-  
+
   describe "to_wif(compressed: false)" do
     it "is a 51 character base58 key" do
       expect(@key.to_wif(compressed: false).length).to eql(51)
     end
-    
+
     it "starts with 5" do
       expect(@key.to_wif(compressed: false)[0]).to eql('5')
     end
-    
+
     it "is valid" do
       expect(@key.to_wif(compressed: false)).to eql('5JXz5ZyFk31oHVTQxqce7yitCmTAPxBqeGQ4b7H3Aj3L45wUhoa')
     end
   end
-  
+
   describe "from_wif(wif)" do
     it "returns the key from a wif" do
       expect(@key.from_wif("5HueCGU8rMjxEXxiPuD5BDku4MkFqeZyd4dZ1jvhTVqvbTLvyTJ")).to eql('0c28fca386c7a227600b2fe50b7cae11ec86d3bf1fbe471be89827e19d72aa1d')
     end
-    
+
     it "raises an error on bad checksum" do
       expect { @key.from_wif("5HueCGU8rMjxEXxiPuD5BDku4MkFqeZyd4dZ1jvhTVqvbTBADTJ") }.to raise_error(MoneyTree::Key::InvalidWIFFormat)
     end
   end
-  
+
   describe "to_base64" do
     it "has 44 characters" do
       expect(@key.to_base64.length).to eql(44)
     end
-  
+
     it "is a valid base64" do
-      expect(@key.to_base64).to eql('Xq5Tdftfeg6mUFZjY776KDDvRBvcsZGYrfMY+u6G1ks='      )
+      expect(@key.to_base64).to eql('Xq5Tdftfeg6mUFZjY776KDDvRBvcsZGYrfMY+u6G1ks=')
     end
   end
-  
+
   describe "from_base64(base64_key)" do
     it "parses base64 key" do
       @key = MoneyTree::PrivateKey.new(key: "Xq5Tdftfeg6mUFZjY776KDDvRBvcsZGYrfMY+u6G1ks=")
       expect(@key.to_hex).to eql("5eae5375fb5f7a0ea650566363befa2830ef441bdcb19198adf318faee86d64b")
     end
-    
+
     it "returns the key from base64 encoding" do
       expect(@key.from_base64("Xq5Tdftfeg6mUFZjY776KDDvRBvcsZGYrfMY+u6G1ks=")).to eql('5eae5375fb5f7a0ea650566363befa2830ef441bdcb19198adf318faee86d64b')
     end
-    
+
     it "raises an error on bad encoding" do
       expect { @key.from_base64("Xq5Tdftfeg6mUFZjY776KD&%#BbadBADrfMY+u6G1ks=") }.to raise_error(MoneyTree::Key::InvalidBase64Format)
     end
   end
-  
+
   describe "valid?(eckey)" do
     it "checks for a valid key" do
       expect(@key.valid?).to be_truthy
     end
   end
-  
+
   describe "parse_raw_key" do
     it "returns error if key is not Bignum, hex, base64, or wif formatted" do
       expect { @key = MoneyTree::PrivateKey.new(key: "Thisisnotakey") }.to raise_error(MoneyTree::Key::KeyFormatNotFound)