crypto-lite 0.3.0 → 0.4.0

data/lib/crypto-lite.rb

@@ -1,148 +1,39 @@
-require 'pp'
-require 'digest'
-require 'base64'
-require 'openssl'
-
-## 3rd party gems
-require 'digest/sha3'  # e.g. keccak (original submission/proposal NOT official sha3)
-## see https://rubygems.org/gems/digest-sha3-patched
-##     https://github.com/teamhedge/digest-sha3-ruby
-
-## our own 3rd party (2nd party?)
-require 'base32-alphabets'
-require 'base58-alphabets'
-require 'elliptic'
-
-
-
-## our own code
-require 'crypto-lite/version'    # note: let version always go first
-require 'crypto-lite/config'
-require 'crypto-lite/metal'
-
-
-
-
-module Crypto
-
-  def self.base58( *args, **kwargs )
-    input = args_to_input( args, kwargs )
-    Metal.base58bin( input )
-  end
-
-  def self.base58check( *args, **kwargs )
-    input = args_to_input( args, kwargs )
-    Metal.base58bin_check( input )
-  end
-
-
-  ########################
-  # (secure) hash functions
-
-  def self.keccak256( *args, **kwargs )
-    input = args_to_input( args, kwargs )
-    Metal.keccak256bin( input ).unpack( 'H*' )[0]
-  end
-
-
-  def self.rmd160( *args, **kwargs )
-    input = args_to_input( args, kwargs )
-    Metal.rmd160bin( input ).unpack( 'H*' )[0]
-  end
-
-  ## add alias RIPEMD160 - why? why not?
-  class << self
-    alias_method :ripemd160,    :rmd160
-  end
-
-
-  def self.sha256( *args, **kwargs )
-    input = args_to_input( args, kwargs )
-    engine = kwargs[:engine]
-    Metal.sha256bin( input, engine ).unpack( 'H*' )[0]
-  end
-
-  def self.sha3_256( *args, **kwargs )
-    input = args_to_input( args, kwargs )
-    Metal.sha3_256bin( input ).unpack( 'H*' )[0]
-  end
-
-
-
-  def self.hash160( *args, **kwargs )
-    input = args_to_input( args, kwargs )
-    Metal.hash160bin( input ).unpack( 'H*' )[0]
-  end
-
-  def self.hash256( *args, **kwargs )
-    input = args_to_input( args, kwargs )
-    Metal.hash256bin( input ).unpack( 'H*' )[0]
-  end
-
-
-
-  ########
-  # more helpers
-  ## check if it is a hex (string)
-  ##  - allow optiona 0x or 0X  and allow abcdef and ABCDEF
-  HEX_RE = /\A(?:0x)?[0-9a-f]+\z/i
-
-  def self.args_to_input( args, kwargs )
-    if kwargs[:hex]
-      hex = kwargs[:hex]
-      raise ArgumentError, "expected hex string (0-9a-f) - got >#{hex}< - can't pack string; sorry"   unless hex =~ HEX_RE
-
-      hex = strip0x( hex )  ##  check if input starts with 0x or 0X if yes - (auto-)cut off!!!!!
-      [hex].pack( 'H*' )
-    else   ## assume single input arg for now
-      input = args[0]
-      input = hex_to_bin_automagic( input )  ## add automagic hex (string) to bin (string) check - why? why not?
-      input
-    end
-  end
-
-  def self.hex_to_bin_automagic( input )
-    ## todo/check/fix: add configure setting to turn off automagic - why? why not?
-     if input.is_a?( String ) && input =~ HEX_RE
-        if input[0,2] == '0x' || input[0,2] == '0X'
-          ## starting with 0x or 0X always assume hex string for now - why? why not?
-          input = input[2..-1]
-          [input].pack( 'H*' )
-        elsif input.size >= 10
-          ## note: hex heuristic!!
-          ##   for now assumes string MUST have more than 10 digits to qualify!!!
-          [input].pack( 'H*' )
-        else
-          input ## pass through as is!!! (e.g.   a, abc, etc.)
-        end
-     else
-          input  ## pass through as is
-     end
-  end
-
-
-  def self.strip0x( str )    ## todo/check: add alias e.g. strip_hex_prefix or such - why? why not?
-    (str[0,2] == '0x' || str[0,2] == '0X') ?  str[2..-1] : str
-  end
-
-#  def self.hex_to_bin( str )
-#    str = strip0x( str )  ##  check if input starts with 0x or 0X if yes - (auto-)cut off!!!!!
-#    [str].pack( 'H*' )
-#  end
-
-end # module Crypto
-
-
-
-
-require 'crypto-lite/helper'
-include CryptoHelper      # add convenience "top-level" / global helpers
-
-
-require 'crypto-lite/sign_rsa'
-RSA = Crypto::RSA
-
-
-
-
-puts CryptoLite.banner    ## say hello
+require 'pp'
+require 'digest'
+require 'base64'
+require 'openssl'
+
+
+## our own 3rd party (2nd party?)
+require 'bytes'
+
+## extend String
+class String
+  alias_method :hexdigest, :bin_to_hex   ## note: bin_to_hex added via Bytes!!!
+end
+
+
+require 'digest-lite'  # e.g. keccak (original submission/proposal NOT official sha3)
+require 'base32-alphabets'
+require 'base58-alphabets'
+require 'elliptic'
+
+
+## our own code
+require_relative 'crypto-lite/version'    # note: let version always go first
+require_relative 'crypto-lite/config'
+require_relative 'crypto-lite/metal'
+require_relative 'crypto-lite/helper'
+
+
+require_relative 'crypto-lite/sign_rsa'
+RSA = Crypto::RSA
+
+
+## auto-add top-level helpers - why? why not?
+include CryptoHelper
+
+
+
+
+puts CryptoLite.banner    ## say hello

data/lib/crypto.rb

@@ -1,2 +1,2 @@
-require_relative 'crypto-lite'    ## lets you use require 'crypto' too
-
+require_relative 'crypto-lite'    ## lets you use require 'crypto' too
+

data/test/helper.rb

@@ -1,11 +1,11 @@
-## $:.unshift(File.dirname(__FILE__))
-
-## minitest setup
-
-require 'minitest/autorun'
-
-
-## our own code
-
-require 'crypto-lite'
-
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+
+require 'minitest/autorun'
+
+
+## our own code
+
+require 'crypto-lite'
+

data/test/test_base58.rb

@@ -1,36 +1,39 @@
-###
-#  to run use
-#     ruby -I ./lib -I ./test test/test_base58.rb
-
-
-require 'helper'
-
-
-class TestBase58 < MiniTest::Test
-
-HEX_TESTS = [
-   ["00000000000000000000", "1111111111"],
-   ["00000000000000000000123456789abcdef0", "111111111143c9JGph3DZ"],
-]
-
-def test_hex
-   HEX_TESTS.each do |item|
-      assert_equal item[1],  base58( hex: item[0] )
-      assert_equal item[1],  base58( item[0] )
-    end
-end
-
-
-def test_bitcoin_addr
-   addr_exp = '1PMycacnJaSqwwJqjawXBErnLsZ7RkXUAs'
-
-   pkh = 'f54a5851e9372b87810a8e60cdd2e7cfd80b6e31'
-
-   ## all-in-one
-   assert_equal addr_exp, base58check( hex: '00' + pkh )
-   assert_equal addr_exp, base58check( '00' + pkh )
-
-   assert_equal addr_exp, Crypto::Metal.base58bin_check( "\x00" + [pkh].pack('H*') )
-end
-
-end # class TestBase58
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_base58.rb
+
+
+require 'helper'
+
+
+class TestBase58 < MiniTest::Test
+
+HEX_TESTS = [
+   ["00000000000000000000",                 "1111111111"],
+   ["00000000000000000000123456789abcdef0", "111111111143c9JGph3DZ"],
+]
+
+
+def test_hex
+   HEX_TESTS.each do |item|
+      assert_equal item[1],  Crypto.base58( hex: item[0] )
+      bin = Bytes.hex_to_bin( item[0] )
+      assert_equal item[1],  Crypto.base58( bin )
+    end
+end
+
+
+def test_bitcoin_addr
+   addr_exp = '1PMycacnJaSqwwJqjawXBErnLsZ7RkXUAs'
+
+   pkh = 'f54a5851e9372b87810a8e60cdd2e7cfd80b6e31'
+
+   ## all-in-one
+   assert_equal addr_exp, Crypto.base58check( hex: '00' + pkh )
+   bin = Bytes.hex_to_bin('00' + pkh)
+   assert_equal addr_exp, Crypto.base58check( bin )
+
+   assert_equal addr_exp, Crypto::Metal.base58check( "\x00" + [pkh].pack('H*') )
+end
+
+end # class TestBase58

data/test/test_bitcoin_addr.rb

@@ -1,58 +1,58 @@
-###
-#  to run use
-#     ruby -I ./lib -I ./test test/test_bitcoin_addr.rb
-
-
-require 'helper'
-
-class TestBitcoinAddr < MiniTest::Test
-
-
-def test_bitcoin_addr_v1
-   pk = "0250863ad64a87ae8a2fe83c1af1a8403cb53f53e486d8511dad8a04887e5b2352"
-
-   step1 = sha256( pk )
-   assert_equal "0b7c28c9b7290c98d7438e70b3d3f7c848fbd7d1dc194ff83f4f7cc9b1378e98",
-                step1
-
-   step2 = ripemd160( step1 )
-   assert_equal "f54a5851e9372b87810a8e60cdd2e7cfd80b6e31",
-                step2
-
-   step3 = "00" + step2
-   assert_equal "00f54a5851e9372b87810a8e60cdd2e7cfd80b6e31",
-                step3
-
-   step4 = sha256( step3 )
-   assert_equal "ad3c854da227c7e99c4abfad4ea41d71311160df2e415e713318c70d67c6b41c",
-                step4
-
-   step5 = sha256( step4 )
-   assert_equal "c7f18fe8fcbed6396741e58ad259b5cb16b7fd7f041904147ba1dcffabf747fd",
-                 step5
-
-   step6 = step5[0..7]      # note: 4 bytes in hex string are 8 digits/chars
-   assert_equal "c7f18fe8", step6
-
-   step7 = step3 + step6
-   assert_equal "00f54a5851e9372b87810a8e60cdd2e7cfd80b6e31c7f18fe8", step7
-
-   addr  = base58( step7 )
-   assert_equal "1PMycacnJaSqwwJqjawXBErnLsZ7RkXUAs", addr
-end
-
-
-def test_bitcoin_addr_v2
-   pk = "0250863ad64a87ae8a2fe83c1af1a8403cb53f53e486d8511dad8a04887e5b2352"
-
-   step1 = hash160( pk )
-   assert_equal "f54a5851e9372b87810a8e60cdd2e7cfd80b6e31", step1
-
-   step2 = "00" + step1
-   assert_equal "00f54a5851e9372b87810a8e60cdd2e7cfd80b6e31", step2
-
-   addr  = base58check( step2 )
-   assert_equal "1PMycacnJaSqwwJqjawXBErnLsZ7RkXUAs", addr
-end
-
-end # class TestBitcoinAddr
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_bitcoin_addr.rb
+
+
+require 'helper'
+
+class TestBitcoinAddr < MiniTest::Test
+
+
+def test_bitcoin_addr_v1
+   pk = "0250863ad64a87ae8a2fe83c1af1a8403cb53f53e486d8511dad8a04887e5b2352"
+
+   step1 = Crypto.sha256( hex: pk ).hexdigest
+   assert_equal "0b7c28c9b7290c98d7438e70b3d3f7c848fbd7d1dc194ff83f4f7cc9b1378e98",
+                step1
+
+   step2 = Crypto.ripemd160( hex: step1 ).hexdigest
+   assert_equal "f54a5851e9372b87810a8e60cdd2e7cfd80b6e31",
+                step2
+
+   step3 = "00" + step2
+   assert_equal "00f54a5851e9372b87810a8e60cdd2e7cfd80b6e31",
+                step3
+
+   step4 = Crypto.sha256( hex: step3 ).hexdigest
+   assert_equal "ad3c854da227c7e99c4abfad4ea41d71311160df2e415e713318c70d67c6b41c",
+                step4
+
+   step5 = Crypto.sha256( hex: step4 ).hexdigest
+   assert_equal "c7f18fe8fcbed6396741e58ad259b5cb16b7fd7f041904147ba1dcffabf747fd",
+                 step5
+
+   step6 = step5[0..7]      # note: 4 bytes in hex string are 8 digits/chars
+   assert_equal "c7f18fe8", step6
+
+   step7 = step3 + step6
+   assert_equal "00f54a5851e9372b87810a8e60cdd2e7cfd80b6e31c7f18fe8", step7
+
+   addr  = Crypto.base58( hex: step7 )
+   assert_equal "1PMycacnJaSqwwJqjawXBErnLsZ7RkXUAs", addr
+end
+
+
+def test_bitcoin_addr_v2
+   pk = "0250863ad64a87ae8a2fe83c1af1a8403cb53f53e486d8511dad8a04887e5b2352"
+
+   step1 = Crypto.hash160( hex: pk ).hexdigest
+   assert_equal "f54a5851e9372b87810a8e60cdd2e7cfd80b6e31", step1
+
+   step2 = "00" + step1
+   assert_equal "00f54a5851e9372b87810a8e60cdd2e7cfd80b6e31", step2
+
+   addr  = Crypto.base58check( hex: step2 )
+   assert_equal "1PMycacnJaSqwwJqjawXBErnLsZ7RkXUAs", addr
+end
+
+end # class TestBitcoinAddr

data/test/test_hash.rb

@@ -1,47 +1,53 @@
-###
-#  to run use
-#     ruby -I ./lib -I ./test test/test_hash.rb
-
-
-require 'helper'
-
-
-class TestHash < MiniTest::Test
-
- KECCAK256_TESTS = [
-   ['',                'c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470'],
-   ['testing',         '5f16f4c7f149ac4f9510d9cf8cf384038ad348b3bcdc01915f95de12df9d1b02'],
-   ['Hello, Cryptos!', '2cf14baa817e931f5cc2dcb63c889619d6b7ae0794fc2223ebadf8e672c776f5'],
- ]
-
- SHA3_256_TESTS = [
-   ['',                'a7ffc6f8bf1ed76651c14756a061d662f580ff4de43b49fa82d80a4b80f8434a'],
-   ['Hello, Cryptos!', '7dddf4bc9b86352b67e8823e5010ddbd2a90a854469e2517992ca7ca89e5bd58'],
- ]
-
- RIPEMD160_TESTS = [
-   ['Hello, Cryptos!', '4d65f7b740bbade4097e1348e15d2a7d52ac5f53'],
- ]
-
-
-
-def test_keccak256
-   KECCAK256_TESTS.each do |item|
-     assert_equal item[1], keccak256( item[0].b )
-   end
-end
-
-def test_sha3_256
-  SHA3_256_TESTS.each do |item|
-    assert_equal item[1], sha3_256( item[0].b )
-  end
-end
-
-def test_ripemd160
-  RIPEMD160_TESTS.each do |item|
-    assert_equal item[1], ripemd160( item[0].b )
-  end
-end
-
-
-end # class TestHash
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_hash.rb
+
+
+require 'helper'
+
+
+class TestHash < MiniTest::Test
+
+ KECCAK256_TESTS = [
+   ['',                'c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470'],
+   ['testing',         '5f16f4c7f149ac4f9510d9cf8cf384038ad348b3bcdc01915f95de12df9d1b02'],
+   ['Hello, Cryptos!', '2cf14baa817e931f5cc2dcb63c889619d6b7ae0794fc2223ebadf8e672c776f5'],
+ ]
+
+ SHA3_256_TESTS = [
+   ['',                'a7ffc6f8bf1ed76651c14756a061d662f580ff4de43b49fa82d80a4b80f8434a'],
+   ['Hello, Cryptos!', '7dddf4bc9b86352b67e8823e5010ddbd2a90a854469e2517992ca7ca89e5bd58'],
+ ]
+
+ RIPEMD160_TESTS = [
+   ['Hello, Cryptos!', '4d65f7b740bbade4097e1348e15d2a7d52ac5f53'],
+ ]
+
+
+def assert_hexdigest( exp, bin )
+  assert_equal exp, bin.hexdigest
+end
+
+
+
+def test_keccak256
+   KECCAK256_TESTS.each do |item|
+     assert_hexdigest item[1], Crypto.keccak256( item[0].b )
+   end
+end
+
+def test_sha3_256
+  SHA3_256_TESTS.each do |item|
+    assert_hexdigest item[1], Crypto.sha3_256( item[0].b )
+  end
+end
+
+def test_ripemd160
+  RIPEMD160_TESTS.each do |item|
+    assert_hexdigest item[1], Crypto.ripemd160( item[0].b )
+    assert_hexdigest item[1], Crypto.rmd160( item[0].b )
+  end
+end
+
+
+end # class TestHash