btcruby 1.4 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 162d9f3dbb8974140831c1e831c72ffaa4ec0c01
-  data.tar.gz: 6c429f7f67eb3fc066fb83e3501f9a26ea6d55a0
+  metadata.gz: b28e8aae378a1e3a925ccb7acdb05b68e2e1987c
+  data.tar.gz: a134759a151e238011207ea52d7ff0a2bbbbf92e
 SHA512:
-  metadata.gz: ff5d4970c74486586c1a4d0ea95b7b92eb8b635324bfc1a8bfbc5ee571af44ce079d381704a6b10a82946e920a2d84d7b6c6f7cfd17db5e518d148f4f651f3e0
-  data.tar.gz: 3b7bd61ff37ba5d332b197b2503b5427be9ff3448298e7adcb79284373f9ba8a6d7dc6cf019f11d4d34ed164781907cba3e620eb0900d1ae2947a49706f448e0
+  metadata.gz: 3a0b2f8cbfc3cb5fba98cc1844beae30410db5da37fcc2decbe91190c41c571ef9be5c16c86d1e496d6ffa46afbb5d5c92c1c9d4fdb494714bc3c531505dd4c3
+  data.tar.gz: 5e2edf87ad3704f45acd614a67763325e73aaf85ab61fdc52c3ac6827e09bc7273a5c48a66764fd1b38836b88888f21e3680d8330750ec8c76c7a653a8b3dbfa

data/RELEASE_NOTES.md

@@ -2,6 +2,11 @@
 BTCRuby Release Notes
 =====================
 
+1.5 (November 29, 2015)
+-----------------------
+
+* `BTC::SecretSharing` changes API to support 96-, 104- and 128-bit secrets.
+
 1.4 (November 26, 2015)
 -----------------------
 

data/lib/btcruby/ssss.rb

@@ -2,7 +2,7 @@
 # Author: Oleg Andreev <oleganza@gmail.com>
 #
 # * Deterministic, extensible algorithm: every combination of secret and threshold produces exactly the same shares on each run. More shares can be generated without invalidating the first ones.
-# * This algorithm splits and restores 128-bit secrets with up to 16 shares and up to 16 shares threshold.
+# * This algorithm splits and restores 96/104/128-bit secrets with up to 16 shares and up to 16 shares threshold.
 # * Secret is a binary 16-byte string below ffffffffffffffffffffffffffffff61.
 # * Shares are 17-byte binary strings with first byte indicating threshold and share index (these are necessary for recovery).
 # 
@@ -10,34 +10,37 @@
 require 'digest/sha2'
 require 'securerandom'
 module BTC
-  module SecretSharing
-    extend self
-    Order = 0xffffffffffffffffffffffffffffff61 # Largest prime below 2**128: (2**128 - 159)
-  
-    def random
-      be_from_int(SecureRandom.random_number(Order))
-    end
-  
-    def prng(seed)
-      x = Order
-      s = nil
-      pad = "".b
-      while x >= Order
-        s = Digest::SHA2.digest(Digest::SHA2.digest(seed + pad))[0,16]
-        x = int_from_be(s)
-        pad = pad + "\x00".b
+  class SecretSharing
+    
+    Order96  = 0xffffffffffffffffffffffef         # Largest prime below 2**96: (2**96 - 17)
+    Order104 = 0xffffffffffffffffffffffffef       # Largest prime below 2**104: (2**104 - 17)
+    Order128 = 0xffffffffffffffffffffffffffffff61 # Largest prime below 2**128: (2**128 - 159)
+    
+    def initialize(bitlength = 128)
+      if bitlength == 128
+        @order = Order128
+      elsif bitlength == 104
+        @order = Order104
+      elsif bitlength == 96
+        @order = Order96
+      else
+        raise ArgumentError, "Unsupported bit length #{bitlength}"
       end
-      s
+      @bitlength = bitlength
+    end
+    
+    def random
+      be_from_int(SecureRandom.random_number(@order))
     end
   
     # Returns N strings, any M of them are enough to retrieve a secret.
     # Each string encodes X and Y coordinates and also M. X & M takes one byte, Y takes 16 bytes:
     # MMMMXXXX YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY YYYYYYYY
     def split(secret, m, n)
-      prime = Order
+      prime = @order
       secret_num = int_from_be(secret)
-      if secret_num >= Order
-        raise "Secret cannot be encoded with 128-bit SSSS"
+      if secret_num >= @order
+        raise "Secret cannot be encoded with #{@bitlength}-bit SSSS"
       end
       if !(n >= 1 && n <= 16)
         raise "N must be between 1 and 16"
@@ -68,7 +71,7 @@ module BTC
     # Transforms M 17-byte binary strings into original secret 16-byte binary string.
     # Each share string must be well-formed.
     def restore(shares)
-      prime = Order
+      prime = @order
       shares = shares.dup.uniq
       raise "No shares provided" if shares.size == 0
       points = shares.map{|s| point_from_string(s) } # [[m,x,y],...]
@@ -97,7 +100,19 @@ module BTC
       end
       return be_from_int(y)
     end
-  
+
+    def prng(seed)
+      x = @order
+      s = nil
+      pad = "".b
+      while x >= @order
+        s = Digest::SHA2.digest(Digest::SHA2.digest(seed + pad))[0,@bitlength/8]
+        x = int_from_be(s)
+        pad = pad + "\x00".b
+      end
+      s
+    end
+
     # Returns mmmmxxxx yyyyyyyy yyyyyyyy ... (16 bytes of y)
     def string_from_point(m, x, y)
       m = to_nibble(m)
@@ -154,7 +169,7 @@ module BTC
       r[:total]
     end
 
-    def be_from_int(i, pad = 128)
+    def be_from_int(i, pad = @bitlength)
       a = []
       while i > 0
         a.unshift(i % 256)
@@ -168,21 +183,21 @@ end
 
 if $0 == __FILE__
   
-  SSSS = BTC::SecretSharing
+  ssss = BTC::SecretSharing.new(128)
   require_relative 'data.rb'
   
   # Usage 
-  secret = SSSS.random
+  secret = ssss.random
   puts "Secret: #{BTC.to_hex(secret)}"
-  shares = SSSS.split(secret, 2, 3)
+  shares = ssss.split(secret, 2, 3)
   shares.each do |share|
     puts "Share:  #{BTC.to_hex(share)}"
   end
-  restored_secret = SSSS.restore([shares[1], shares[0]])
+  restored_secret = ssss.restore([shares[1], shares[0]])
   puts "Recovered secret with shares 2 and 1: #{BTC.to_hex(restored_secret)}"
-  restored_secret = SSSS.restore([shares[0], shares[2]])
+  restored_secret = ssss.restore([shares[0], shares[2]])
   puts "Recovered secret with shares 1 and 3: #{BTC.to_hex(restored_secret)}"
-  restored_secret = SSSS.restore([shares[1], shares[2]])
+  restored_secret = ssss.restore([shares[1], shares[2]])
   puts "Recovered secret with shares 2 and 3: #{BTC.to_hex(restored_secret)}"
   
   # Output:
@@ -232,16 +247,49 @@ if $0 == __FILE__
       "2-of-2" => ["2125df3f1da76af07c37689382bc8201a6", "224bbe7e3b4ed5e0f86ed127057904034c"],
       "2-of-3" => ["2125df3f1da76af07c37689382bc8201a6", "224bbe7e3b4ed5e0f86ed127057904034c", "23719dbd58f640d174a639ba88358604f2"],
       "3-of-3" => ["31651161eeddabb39134be97908f0d7d9e", "32671d1a7e6d7ef24037990a5285a75164", "33062329aeaf79bc0d088f5845e3cd7b52"],
-    }
+    },
+    {
+      "secret" => "31415926535897932384626433", # 104 bits
+      "1-of-1" => ["1131415926535897932384626433"],
+      "1-of-2" => ["1131415926535897932384626433", "1231415926535897932384626433"],
+      "2-of-2" => ["21a8453099fb8ae36aab2c1b6000", "221f49080da3bd2f4232d3d45bde"],
+      "1-of-3" => ["1131415926535897932384626433", "1231415926535897932384626433", "1331415926535897932384626433"],
+      "2-of-3" => ["21a8453099fb8ae36aab2c1b6000", "221f49080da3bd2f4232d3d45bde", "23964cdf814bef7b19ba7b8d57ab"],
+      "3-of-3" => ["312b1880cc54fa4f009a4828f7d1", "3229a1cb3a58caea9c2bf0a31cb3", "332cdd38705eca6a65d87dd0d2d9"],
+      "4-of-6" => ["414dc7bfe7e209630e44617d9737", "422da138cfafb6fa65f2556740c0", "43bd57245c5ccd2a2b2018645fa5", "44e972e30c89b7beeec062b9f2df", "459e7dd55ed6e28541c5ecacf956", "46c9015bd1e4b949b5236e8271e1"],
+      "10-of-16"=>["a1b7a1ae5c3b1de94a8f4b8f7e05", "a25906c43a8969f6b5bf4be06006", "a3e97beb27daf0e2f81e0346a327", "a4d1a2cbee6be940edf213ccbc5f", "a50810074c61f554e9790453f951", "a629b4cf2ee2e5692af73337a0ca", "a7902bbc8ad42f8f9d15128e8758", "a8e6e7bce215a6f69d903a756a02", "a9834eca7f01f1a00215cf0ab33c", "aaa7b73a49f876d11a0b258fec2f", "abde0dc1d5af02f828197e7e0ac7", "acbc9befd7052707b1821140074e", "adadfaa8b410696a0d9089baaf84", "aebcb2502c16b5afd4f377c98514", "afeb62a04f2c15fa2f540d669b95", "a04b86c51029a5de8538e14edf9e"],
+    },
+    {
+      "secret" => "deadbeefcafebabedeadbeefca",
+      "1-of-1" => ["11deadbeefcafebabedeadbeefca"],
+      "2-of-2" => ["210833159d705e79f32a1c8cea96", "2231b86c4b15be3927758b5ae551"],
+      "2-of-3" => ["210833159d705e79f32a1c8cea96", "2231b86c4b15be3927758b5ae551", "235b3dc2f8bb1df85bc0fa28e00c"],
+      "3-of-3" => ["3112462cb0571d40f6e704adf5b7", "320841c292cc488c414627a293e1", "33c0a080972a809c9dfc169cca48"],
+    },
+    {
+      "secret" => "ffffffffffffffffffffffffee",
+      "1-of-1" => ["11ffffffffffffffffffffffffee"],
+      "2-of-2" => ["21b47b7bca3c91cfa72ec99d9ded", "2268f6f79479239f4e5d933b3bec"],
+      "2-of-3" => ["21b47b7bca3c91cfa72ec99d9ded", "2268f6f79479239f4e5d933b3bec", "231d72735eb5b56ef58c5cd8d9eb"],
+      "3-of-3" => ["31354043caf86f780c8d306fa32b", "32fc8f21351fc80c54a2b8604700", "3355ec983e7609bcd84097d1eba0"],
+    },
+    {
+      "secret" => "00000000000000000000000000",
+      "1-of-1" => ["1100000000000000000000000000"],
+      "2-of-2" => ["219aa26f55d8a706cb6801023e74", "223544deabb14e0d96d002047cf9"],
+      "2-of-3" => ["219aa26f55d8a706cb6801023e74", "223544deabb14e0d96d002047cf9", "23cfe74e0189f51462380306bb6d"],
+      "3-of-3" => ["315a50b9d324cbf8cf4546d9e085", "32ca50d93a5f8028070814b77faa", "3350005e35b01c8da7486998dd80"],
+    },
   ]
   
   test_vectors.each do |test|
     hexsecret = test.delete("secret")
     secret = BTC.from_hex(hexsecret)
+    ssss = BTC::SecretSharing.new(secret.bytesize*8)
     test.each do |rule, defined_shares|
       m, n = rule.split("-of-").map{|x|x.to_i}
       puts "Testing #{hexsecret} #{rule}:"
-      shares = SSSS.split(secret, m, n)
+      shares = ssss.split(secret, m, n)
       hexshares = shares.map{|s| BTC.to_hex(s)}
       failed = false
       if hexshares != defined_shares
@@ -250,11 +298,11 @@ if $0 == __FILE__
         puts "            Expected:  #{defined_shares.inspect}"
         puts "            Generated: #{hexshares.inspect}"
       end
-      subshares = hexshares[0...m] # TODO: iterate over various combinations
-      restored_secret = SSSS.restore(subshares.map{|s| BTC.from_hex(s)})
+      subshares = shares[0...m] # TODO: iterate over various combinations
+      restored_secret = ssss.restore(subshares)
       if restored_secret != secret
         failed = true
-        puts "Failed #{hexsecret} #{rule} test: failed to restore secret using #{subshares.inspect}"
+        puts "Failed #{hexsecret} #{rule} test: failed to restore secret using #{subshares.map{|s| BTC.to_hex(s)}.inspect}"
       end
       if !failed
         puts "Ok."
@@ -262,4 +310,30 @@ if $0 == __FILE__
     end
   end
   
+  
+  begin
+    require_relative 'base58'
+    payload_length = 13
+    lengths = {}
+    (0..255).each do |ver|
+      prefixes = []
+      s = nil
+      (0..255).each do |i|
+        s = BTC::Base58.base58_from_data(ver.chr + (i.chr*payload_length))
+        #lengths[s.length] = 1
+        prefixes << s[0,1]
+        s = BTC::Base58.base58_from_data(ver.chr + Digest::SHA2.digest(ver.to_s + i.to_s)[0,payload_length])
+        lengths[s.length] = 1
+        prefixes << s[0,1]
+      end
+      prefixes = prefixes.uniq
+      puts   "Ver: #{ver} => #{prefixes}"
+      if prefixes.size == 1
+        puts "                    " + s
+      end
+    end
+    
+    puts "Lengths: #{lengths.keys.sort.inspect}"
+  rescue => e
+  end
 end

data/lib/btcruby/version.rb

@@ -1,3 +1,3 @@
 module BTC
-  VERSION = "1.4".freeze
+  VERSION = "1.5".freeze
 end

data/spec/ssss_spec.rb

@@ -4,8 +4,11 @@ describe BTC::SecretSharing do
   SSSS = BTC::SecretSharing
   
   test_vectors = [
+    
+    # 128-bit secrets
+    
     {
-      "secret" => "31415926535897932384626433832795",
+      "secret" => "31415926535897932384626433832795", # 128 bits
       "1-of-1" => ["1131415926535897932384626433832795"],
       "1-of-2" => ["1131415926535897932384626433832795", "1231415926535897932384626433832795"],
       "2-of-2" => ["215af384f05d9b45f0e4e348f95b371acd", "2284a5b0ba67ddf44ea6422f8e82eb0e05"],
@@ -39,21 +42,93 @@ describe BTC::SecretSharing do
       "2-of-2" => ["2125df3f1da76af07c37689382bc8201a6", "224bbe7e3b4ed5e0f86ed127057904034c"],
       "2-of-3" => ["2125df3f1da76af07c37689382bc8201a6", "224bbe7e3b4ed5e0f86ed127057904034c", "23719dbd58f640d174a639ba88358604f2"],
       "3-of-3" => ["31651161eeddabb39134be97908f0d7d9e", "32671d1a7e6d7ef24037990a5285a75164", "33062329aeaf79bc0d088f5845e3cd7b52"],
-    }
+    },
+    
+    
+    # 104-bit secrets
+    
+    {
+      "secret" => "31415926535897932384626433",
+      "1-of-1" => ["1131415926535897932384626433"],
+      "1-of-2" => ["1131415926535897932384626433", "1231415926535897932384626433"],
+      "2-of-2" => ["21a8453099fb8ae36aab2c1b6000", "221f49080da3bd2f4232d3d45bde"],
+      "1-of-3" => ["1131415926535897932384626433", "1231415926535897932384626433", "1331415926535897932384626433"],
+      "2-of-3" => ["21a8453099fb8ae36aab2c1b6000", "221f49080da3bd2f4232d3d45bde", "23964cdf814bef7b19ba7b8d57ab"],
+      "3-of-3" => ["312b1880cc54fa4f009a4828f7d1", "3229a1cb3a58caea9c2bf0a31cb3", "332cdd38705eca6a65d87dd0d2d9"],
+      "4-of-6" => ["414dc7bfe7e209630e44617d9737", "422da138cfafb6fa65f2556740c0", "43bd57245c5ccd2a2b2018645fa5", "44e972e30c89b7beeec062b9f2df", "459e7dd55ed6e28541c5ecacf956", "46c9015bd1e4b949b5236e8271e1"],
+      "10-of-16"=>["a1b7a1ae5c3b1de94a8f4b8f7e05", "a25906c43a8969f6b5bf4be06006", "a3e97beb27daf0e2f81e0346a327", "a4d1a2cbee6be940edf213ccbc5f", "a50810074c61f554e9790453f951", "a629b4cf2ee2e5692af73337a0ca", "a7902bbc8ad42f8f9d15128e8758", "a8e6e7bce215a6f69d903a756a02", "a9834eca7f01f1a00215cf0ab33c", "aaa7b73a49f876d11a0b258fec2f", "abde0dc1d5af02f828197e7e0ac7", "acbc9befd7052707b1821140074e", "adadfaa8b410696a0d9089baaf84", "aebcb2502c16b5afd4f377c98514", "afeb62a04f2c15fa2f540d669b95", "a04b86c51029a5de8538e14edf9e"],
+    },
+    {
+      "secret" => "deadbeefcafebabedeadbeefca",
+      "1-of-1" => ["11deadbeefcafebabedeadbeefca"],
+      "2-of-2" => ["210833159d705e79f32a1c8cea96", "2231b86c4b15be3927758b5ae551"],
+      "2-of-3" => ["210833159d705e79f32a1c8cea96", "2231b86c4b15be3927758b5ae551", "235b3dc2f8bb1df85bc0fa28e00c"],
+      "3-of-3" => ["3112462cb0571d40f6e704adf5b7", "320841c292cc488c414627a293e1", "33c0a080972a809c9dfc169cca48"],
+    },
+    {
+      "secret" => "ffffffffffffffffffffffffee",
+      "1-of-1" => ["11ffffffffffffffffffffffffee"],
+      "2-of-2" => ["21b47b7bca3c91cfa72ec99d9ded", "2268f6f79479239f4e5d933b3bec"],
+      "2-of-3" => ["21b47b7bca3c91cfa72ec99d9ded", "2268f6f79479239f4e5d933b3bec", "231d72735eb5b56ef58c5cd8d9eb"],
+      "3-of-3" => ["31354043caf86f780c8d306fa32b", "32fc8f21351fc80c54a2b8604700", "3355ec983e7609bcd84097d1eba0"],
+    },
+    {
+      "secret" => "00000000000000000000000000",
+      "1-of-1" => ["1100000000000000000000000000"],
+      "2-of-2" => ["219aa26f55d8a706cb6801023e74", "223544deabb14e0d96d002047cf9"],
+      "2-of-3" => ["219aa26f55d8a706cb6801023e74", "223544deabb14e0d96d002047cf9", "23cfe74e0189f51462380306bb6d"],
+      "3-of-3" => ["315a50b9d324cbf8cf4546d9e085", "32ca50d93a5f8028070814b77faa", "3350005e35b01c8da7486998dd80"],
+    },
+    
+    
+    # 96-bit secrets
+    
+    {
+      "secret" => "314159265358979323846264",
+      "1-of-1" => ["11314159265358979323846264"],
+      "1-of-2" => ["11314159265358979323846264", "12314159265358979323846264"],
+      "2-of-2" => ["219c6d2fc2303e0a64e380b5a8", "220799065e0d237d36a37d08fd"],
+      "1-of-3" => ["11314159265358979323846264", "12314159265358979323846264", "13314159265358979323846264"],
+      "2-of-3" => ["219c6d2fc2303e0a64e380b5a8", "220799065e0d237d36a37d08fd", "2372c4dcf9ea08f00863795c41"],
+      "3-of-3" => ["318934eda6285292a6b6f2fd0a", "321f6b0d5fe662e2dec79d1572", "33f3e3b8538d89883b5582ab7a"],
+      "4-of-6" => ["4174b316d14c485cf444325100", "4273da5159c33a43335df79a53", "4337969f2f75a6c630f732b1a1", "44c8c796c2210661cd96420a1d", "45304cce8182d191e9c184172d", "467705dcdd5880d265ff574bf3"],
+      "10-of-16"=>["a1090ba03f98fe44fb0c9cbc92", "a28a63d4872a1372ba8bcaa0d9", "a3a6970d6bf596f299b7eea31b", "a43c1da6ae60d076ed901e8853", "a591259cce1d7845820d77ff69", "a685b97fb8b78b4a60fddc7e8c", "a77f135e267940f39c0eb82fb0", "a8586914b4373d3485c68cb2b7", "a9838f54e6dc7e957ebe2c0af8", "aaf53281e124ae4daa376055fc", "ab7d182aacdc5f0d7f3629e66b", "acc2e1748f396e5c4183c7122f", "ad4b1e32f36a2436f87f5f6eb7", "aea729b60757d4fd78576f54f4", "af44458534c9b2a98538f06161", "a033b3472c9623ccff2db82f42"],
+    },
+    {
+      "secret" => "deadbeefcafebabedeadbeef",
+      "1-of-1" => ["11deadbeefcafebabedeadbeef"],
+      "2-of-2" => ["21b7d008c40782c660de3f2759", "2290f252984406d202ddd08fc3"],
+      "2-of-3" => ["21b7d008c40782c660de3f2759", "2290f252984406d202ddd08fc3", "236a149c6c808adda4dd61f82d"],
+      "3-of-3" => ["31f0e31071c238b0b8edf3e099", "32bc5fadd11bda67369fbdfebe", "334123970dd7e3de37f40c195e"],
+    },
+    {
+      "secret" => "ffffffffffffffffffffffee",
+      "1-of-1" => ["11ffffffffffffffffffffffee"],
+      "2-of-2" => ["21177a5ce6e086a40df2a3892c", "222ef4b9cdc10d481be5471259"],
+      "2-of-3" => ["21177a5ce6e086a40df2a3892c", "222ef4b9cdc10d481be5471259", "23466f16b4a193ec29d7ea9b86"],
+      "3-of-3" => ["315adf89c7779b2169a341572a", "32ea101e87f4972984b102f614", "33ad91be4176f418512944dcce"],
+    },
+    {
+      "secret" => "000000000000000000000000",
+      "1-of-1" => ["11000000000000000000000000"],
+      "2-of-2" => ["21197de3ef5aae4f1df4e98384", "2232fbc7deb55c9e3be9d30708"],
+      "2-of-3" => ["21197de3ef5aae4f1df4e98384", "2232fbc7deb55c9e3be9d30708", "234c79abce100aed59debc8a8c"],
+      "3-of-3" => ["317119aa02f2a7f1fccb38a7f7", "324dc572966cb5fdac97a47389", "33960359ba6e2a230f654362a5"],
+    },
   ]
   
   test_vectors.each do |test|
     hexsecret = test.delete("secret")
     secret = BTC.from_hex(hexsecret)
+    ssss = BTC::SecretSharing.new(secret.bytesize*8)    
     test.each do |rule, defined_shares|
       m, n = rule.split("-of-").map{|x|x.to_i}
       it "Should split and restore #{rule} shares for #{hexsecret}" do
-        shares = SSSS.split(secret, m, n)
+        shares = ssss.split(secret, m, n)
         hexshares = shares.map{|s| BTC.to_hex(s)}
-        failed = false
         hexshares.must_equal defined_shares
-        subshares = hexshares[0...m] # TODO: iterate over various combinations
-        restored_secret = SSSS.restore(subshares.map{|s| BTC.from_hex(s)})
+        subshares = shares[0...m] # TODO: iterate over various combinations
+        restored_secret = ssss.restore(subshares)
         BTC.to_hex(restored_secret).must_equal hexsecret
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: btcruby
 version: !ruby/object:Gem::Version
-  version: '1.4'
+  version: '1.5'
 platform: ruby
 authors:
 - Oleg Andreev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2015-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi