crypto-lite 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7c97262d69928c8f9b51816fcf3fff1f5bc61ba5bf49bc81d011ec9567be877
-  data.tar.gz: bfb41f345684cc2f27256e64d95f4a4535b908784f6353643bfef251c83262b7
+  metadata.gz: 8380b7856889a9c184423b31a39b84dff8197bcb34a58687cd8d496bf7ded819
+  data.tar.gz: b91ff4cb4baaa9a7de69224e99585ad5efa6491bb2d8e54adf36841675dfd00c
 SHA512:
-  metadata.gz: 450adb10806e9944fafc4fdf04bb3b09a59fa6fc20ac62a8c9b48b780711ef23555174765b7f545ded98607185bad5488f116a691b34d253de7b7cd30d84fd62
-  data.tar.gz: 524b2c9ae838156c20eb313a045057974e51339e912c48f6945864429ecfd958a7cc8236a83fbbd0121ebc119c2b4a0e76b4b55383b9e64e9ccee35363e912ea
+  metadata.gz: 37c7deea2e4badbeb25abd89e4df6ad98f9503c5b8c7fc22f14bd141d2036d97aa33b2fd9c00f538490c9eb6e5eb4fa554199574948b893691c5bf1dfab34fd0
+  data.tar.gz: 8727fbeea1fa393124ff0d302d1e0f11cc88517424cefba0e809c1f7d1685a758cf0e60eff2d978355da158fd4cb55bea4190f0368eae327d43124ef7d6fe7b6

data/Manifest.txt

@@ -7,5 +7,6 @@ lib/crypto-lite/version.rb
 lib/crypto.rb
 lib/crypto/lite.rb
 test/helper.rb
-test/test_hash.rb
+test/test_hash_keccak.rb
+test/test_hash_sha.rb
 test/test_version.rb

data/README.md

@@ -12,21 +12,21 @@
 
 ### Secure Hashing / Hash Functions
 
-SHA256 - Secure Hash Algorithm (SHA) 256-bits (32 bytes)
+**SHA256 - Secure Hash Algorithm (SHA) 256-Bits (32 Bytes)**
 
 
 ``` ruby
 require 'crypto'      ## or use require 'crypto-lite'
 
 ## try abc
-sha256( "abc" )             #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
-sha256( "abc".b )           #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
-sha256( "\x61\x62\x63" )    #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
-sha256( 0x616263 )          #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
+sha256( "abc" )           #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
+sha256( "abc".b )         #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
+sha256( "\x61\x62\x63" )  #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
+sha256( 0x616263 )        #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
 
-pp sha256hex( '616263' )    #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
-pp sha256hex( '0x616263' )  #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
-pp sha256hex( '0X616263' )  #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
+sha256hex( '616263' )     #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
+sha256hex( '0x616263' )   #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
+sha256hex( '0X616263' )   #=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
 
 
 ## try a
@@ -45,10 +45,64 @@ sha256( "Hello, Cryptos!" )  #=> "33eedea60b0662c66c289ceba71863a864cf84b00e1000
 
 
 
+**Keccak 256-Bit**
+
+``` ruby
+keccak256( "Hello, Cryptos!" )  #=> "2cf14baa817e931f5cc2dcb63c889619d6b7ae0794fc2223ebadf8e672c776f5"
+```
+
+
+**RMD  - RACE¹ Integrity Primitives Evaluation Message Digest 160-Bit**
+
+¹: Research and development in Advanced Communications technologies in Europe
+
+
+``` ruby
+rmd160( "Hello, Cryptos!" )  #=>"4d65f7b740bbade4097e1348e15d2a7d52ac5f53"
+```
+
+
+
+#### Helpers
+
+**HASH160 -  RMD160(SHA256())**
+
+All-in-one "best-of-both-worlds" helper - first hash with sha256 and than hash with rmd160. Why?  Get the higher security of sha256 and the smaller size of rmd160.
+
+
+``` ruby
+hash160hex( '02b9d1cc0b793b03b9f64d022e9c67d5f32670b03f636abf0b3147b34123d13990' )
+=> "e6b145a3908a4d6616b13c1109717add8672c900"
+
+hash160hex( '02b4632d08485ff1df2db55b9dafd23347d1c47a457072a1e87be26896549a8737' )
+=> "93ce48570b55c42c2af816aeaba06cfee1224fae"
+```
+
+Why hex? The input string is a hex string.
+Note: It's optional to start a hex string with `0x` or `0X`.
+
+
+
+**HASH256 -  SHA256(SHA256())**
+
+All-in-one double sha256 hash helper, that is, first hash with sha256 and than hash with sha256 again. Why?  Arguably higher security.
+
+``` ruby
+hash256hex( '6fe6b145a3908a4d6616b13c1109717add8672c900' )
+=> "02335f08b8fe4ddad263a50b7a33c5d38ea1cbd8fd2056a1320a3ddece541711"
+```
+
+
+Why hex? The input string is a hex string.
+Note: It's optional to start a hex string with `0x` or `0X`.
+
+
+
+
 
 ### Public Key Signature Algorithms
 
-RSA - Rivest-Shamir-Adleman
+**RSA - Rivest, Shamir and Adleman**
 
 
 

data/Rakefile

@@ -19,6 +19,7 @@ Hoe.spec 'crypto-lite' do
   self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
+     ['digest-sha3-patched']
   ]
 
   self.licenses = ['Public Domain']

data/lib/crypto-lite.rb

@@ -3,6 +3,15 @@ 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 code
 require 'crypto-lite/version'    # note: let version always go first
@@ -11,7 +20,8 @@ require 'crypto-lite/version'    # note: let version always go first
 
 module Crypto
 
-  def self.sha256bin( input, engine=nil )   ## todo/check: add alias sha256b or such to - why? why not?
+
+  def self.message( input )  ## convert input to (binary) string
     input_type = if input.is_a?( String )
                   "#{input.class.name}/#{input.encoding}"
                  else
@@ -28,13 +38,42 @@ module Crypto
                 input
               end
 
+    bytes = message.bytes
+    bin   = bytes.map {|byte| byte.to_s(2).rjust(8, "0")}.join( ' ' )
+    hex   = bytes.map {|byte| byte.to_s(16).rjust(2, "0")}.join( ' ' )
+    puts "  #{pluralize( bytes.size, 'byte')}:  #{bytes.inspect}"
+    puts "  binary: #{bin}"
+    puts "  hex:    #{hex}"
+
+    message
+  end
+
 
-       bytes = message.bytes
-       bin   = bytes.map {|byte| byte.to_s(2).rjust(8, "0")}.join( ' ' )
-       hex   = bytes.map {|byte| byte.to_s(16).rjust(2, "0")}.join( ' ' )
-       puts "  #{pluralize( bytes.size, 'byte')}:  #{bytes.inspect}"
-       puts "  binary: #{bin}"
-       puts "  hex:    #{hex}"
+
+  def self.keccak256bin( input )
+    message = message( input )   ## "normalize" / convert to (binary) string
+    Digest::SHA3.digest( message, 256 )
+  end
+
+  def self.keccak256( input )
+    keccak256bin( input ).unpack( 'H*' )[0]
+  end
+
+
+  def self.rmd160bin( input )
+    message = message( input )   ## "normalize" / convert to (binary) string
+    Digest::RMD160.digest( message )
+  end
+
+  def self.rmd160( input )
+    rmd160bin( input ).unpack( 'H*' )[0]
+  end
+  ## todo/fix: add alias RIPEMD160 - why? why not?
+
+
+
+  def self.sha256bin( input, engine=nil )   ## todo/check: add alias sha256b or such to - why? why not?
+       message = message( input )  ## "normalize" / convert to (binary) string
 
        if engine && ['openssl'].include?( engine.to_s.downcase )
          puts "  engine: #{engine}"
@@ -65,6 +104,44 @@ module Crypto
 
 
 
+  ####
+  ## helper
+  # def hash160( pubkey )
+  #  binary    = [pubkey].pack( "H*" )       # Convert to binary first before hashing
+  #  sha256    = Digest::SHA256.digest( binary )
+  #  ripemd160 = Digest::RMD160.digest( sha256 )
+  #              ripemd160.unpack( "H*" )[0]    # Convert back to hex
+  # end
+
+  def self.hash160hex( input )
+    ## convenience helper - lets you pass in hex string
+
+    ##  check if input starts with 0x or 0X if yes - (auto-)cut off!!!!!
+    if input.start_with?( '0x') || input.start_with?( '0X' )
+      input = input[2..-1]
+    end
+
+    raise ArgumentError, "expected hex string (0-9a-f) - got >#{input}< - can't pack string; sorry"   if input.downcase =~ /[^0-9a-f]/
+    sha256bin = sha256bin( [input].pack( 'H*' ) )
+    rmd160    = rmd160bin( sha256bin ).unpack( "H*" )[0]
+    rmd160
+  end
+
+  def self.hash256hex( input )
+    ## convenience helper - lets you pass in hex string
+
+    ##  check if input starts with 0x or 0X if yes - (auto-)cut off!!!!!
+    if input.start_with?( '0x') || input.start_with?( '0X' )
+      input = input[2..-1]
+    end
+
+    raise ArgumentError, "expected hex string (0-9a-f) - got >#{input}< - can't pack string; sorry"   if input.downcase =~ /[^0-9a-f]/
+    sha256bin = sha256bin( [input].pack( 'H*' ) )
+    sha256    = sha256bin( sha256bin ).unpack( "H*" )[0]
+    sha256
+  end
+
+
   def self.pluralize( count, noun )
      count == 1 ? "#{count} #{noun}" : "#{count} #{noun}s"
   end
@@ -105,6 +182,14 @@ end # module Crypto
 def sha256( input, engine=nil )    Crypto.sha256( input, engine ); end
 def sha256hex( input, engine=nil ) Crypto.sha256hex( input, engine ); end
 
+def keccak256( input )    Crypto.keccak256( input ); end
+
+def rmd160( input )    Crypto.rmd160( input ); end
+
+def hash160hex( input )   Crypto.hash160hex( input ); end
+def hash256hex( input )   Crypto.hash256hex( input ); end
+
+
 RSA = Crypto::RSA
 
 

data/lib/crypto-lite/version.rb

@@ -2,7 +2,7 @@
 module CryptoLite
 
   MAJOR = 0
-  MINOR = 1
+  MINOR = 2
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/test/test_hash_keccak.rb

@@ -0,0 +1,25 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_hash_keccak.rb
+
+
+require 'helper'
+
+
+class TestHashKeccak < MiniTest::Test
+
+  KECCAK256_EMPTY         = 'c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470'
+  KECCAK256_TESTING       = '5f16f4c7f149ac4f9510d9cf8cf384038ad348b3bcdc01915f95de12df9d1b02'
+  KECCAK256_HELLO_CRYPTOS = '2cf14baa817e931f5cc2dcb63c889619d6b7ae0794fc2223ebadf8e672c776f5'
+
+
+def test_empty
+   assert_equal KECCAK256_EMPTY, keccak256( '' )
+end
+
+def test_misc
+   assert_equal KECCAK256_TESTING,       keccak256( 'testing' )
+   assert_equal KECCAK256_HELLO_CRYPTOS, keccak256( 'Hello, Cryptos!' )
+end
+
+end # class TestHashKeccak

data/test/{test_hash.rb → test_hash_sha.rb}

@@ -1,6 +1,6 @@
 ###
 #  to run use
-#     ruby -I ./lib -I ./test test/test_hash.rb
+#     ruby -I ./lib -I ./test test/test_hash_sha.rb
 
 
 require 'helper'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: crypto-lite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: digest-sha3-patched
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -63,7 +77,8 @@ files:
 - lib/crypto.rb
 - lib/crypto/lite.rb
 - test/helper.rb
-- test/test_hash.rb
+- test/test_hash_keccak.rb
+- test/test_hash_sha.rb
 - test/test_version.rb
 homepage: https://github.com/rubycoco/blockchain
 licenses: