digest-lite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b97f9380b612a38fadac785f5b716ca86c86aa45fe2c04c61f4894a42bdddd45
+  data.tar.gz: 945c6911c0ccba36229fe864b476006f4586bf4cb65d0202dc6801a479cf8a54
+SHA512:
+  metadata.gz: cbe48b8857dd2477511736154a6097f8c353b15e0adb9da482ad6e89226d182fe4d5fb926939fc281490f7d1f7adb541c9c6676646148749b08fda69aebd5cbb
+  data.tar.gz: efd0c3394b2249dde99b040dbbb1a2c0a0b856c8be11231a05fb234ed22eab0287a627a1ec311443e7d4f8e91c3cf081dfc3c70bce0eb5aec4ce6f928f44ec20

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2022-12-08
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,8 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/digest-lite.rb
+lib/digest-lite/keccak.rb
+lib/digest-lite/sha3.rb
+lib/digest-lite/version.rb

data/README.md

@@ -0,0 +1,110 @@
+# Digest Lite
+
+
+digest-lite gem - crypto(graphic) hash functions / classes - Digest::KeccakLite (512bit, 256bit, etc), Digest::SHA3Lite (512bit, 256bit, etc) in "100% pure" ruby "lite" scripts, that is, without any c-extensions and with zero-dependency
+
+
+
+* home  :: [github.com/rubycoco/blockchain](https://github.com/rubycoco/blockchain)
+* bugs  :: [github.com/rubycoco/blockchain/issues](https://github.com/rubycoco/blockchain/issues)
+* gem   :: [rubygems.org/gems/digest-lite](https://rubygems.org/gems/digest-lite)
+* rdoc  :: [rubydoc.info/gems/digest-lite](http://rubydoc.info/gems/digest-lite)
+
+
+
+
+## Background -  Digest - The Standard Built-In Module / Library For Crypto(graphic) Hash Function Algorithms
+
+In [Ruby's standard Digest module](https://github.com/ruby/digest) the following crypto(graphic) hash function algorithms / classes
+are available:
+
+- MD5  (128 bits / 16 bytes) -- Message-Digest Algorithm by RSA Data Security, Inc., described in RFC1321.
+- RIPEMD-160 / RMD160  (160 bits / 20 bytes) -- RIPEMD-160 cryptographic hash function, designed by Hans Dobbertin, Antoon Bosselaers, and Bart Preneel.
+- SHA1  (160 bits / 20 bytes) -- Secure Hash Algorithm by NIST (the US' National Institute of Standards and Technology), described in FIPS PUB 180-1.
+- SHA2 Family -- described in FIPS 180-2.
+  - SHA512  (512 bits / 64 bytes)
+  - SHA384  (384 bits / 48 bytes)
+  - SHA256  (256 bits / 32 bytes)
+
+Example:
+
+``` ruby
+require 'digest'
+
+Digest::MD5.hexdigest( 'abc' )
+#=> "900150983cd24fb0d6963f7d28e17f72"
+
+Digest::RMD160.hexdigest( 'abc' )
+#=> "8eb208f7e05d987a9b044a8e98c6b087f15a0bfc"
+
+Digest::SHA1.hexdigest( 'abc' )
+#=> "a9993e364706816aba3e25717850c26c9cd0d89d"
+
+Digest::SHA2.new(256).hexdigest( 'abc' )  # or
+Digest::SHA256.hexdigest( 'abc' )
+#=> "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
+
+Digest::SHA2.new(384).hexdigest 'abc'  # or
+Digest::SHA384.hexdigest 'abc'
+#=> "cb00753f45a35e8bb5a03d699ac65007272c32ab0eded1631a8b605a43ff5bed8086072ba1e7cc2358baeca134c825a7"
+
+Digest::SHA2.new(512).hexdigest 'abc'   # or
+Digest::SHA512.hexdigest 'abc'
+#=> "ddaf35a193617abacc417349ae20413112e6fa4e89a97ea20a9eeee64b55d39a2192992a274fc1a836ba3c23a3feebbd454d4423643ce80e2a9ac94fa54ca49f"
+```
+
+
+What about the Keccak or SHA3 (family of hash function algorithms)?   Read on.
+
+
+## Usage
+
+
+``` ruby
+require 'digest-lite'
+
+Digest::KeccakLite.new( 256 ).hexdigest( 'abc' )   # or
+Digest::KeccakLite.hexdigest( 'abc', 256 )
+#=> "4e03657aea45a94fc7d47ba826c8d667c0d1e6e33a64a036ec44f58fa12d6c45"
+
+Digest::SHA3Lite.new( 224 ).hexdigest( 'abc' )  # or
+Digest::SHA3Lite.hexdigest( 'abc', 224 )
+#=> "e642824c3f8cf24ad09234ee7d3c766fc9a3a5168d0c94ad73b46fdf"
+
+Digest::SHA3Lite.new( 256 ).hexdigest( 'abc' )  # or
+Digest::SHA3Lite.hexdigest( 'abc', 256 )
+#=> "3a985da74fe225b2045c172d6bd390bd855f086e3e9d525b46bfe24511431532"
+
+Digest::SHA3Lite.new( 384 ).hexdigest( 'abc' )  # or
+Digest::SHA3Lite.hexdigest( 'abc', 384 )
+#=> "ec01498288516fc926459f58e2c6ad8df9b473cb0fc08c2596da7cf0e49be4b298d88cea927ac7f539f1edf228376d25"
+
+Digest::SHA3Lite.new( 512 ).hexdigest( 'abc' )  # or
+Digest::SHA3Lite.hexdigest( 'abc', 512 )
+#=> "b751850b1a57168a5693cd924b6b096e08f621827444f70d884f5d0240d2712e10e116e9192af3c91a7ec57647e3934057340b4cf408d5a56592f8274eec53f0"
+```
+
+
+
+Note:  To avoid naming conflicts / errors with
+`Digest::Keccak` or `Digest::SHA3` as used in alternate
+digest gems (with or without c-extensions)  this gem
+uses  `Digest::KeccakLite` or `Digest::SHA3Lite`
+to let you load different (faster) variants
+ at the same time.
+
+
+
+
+
+## License
+
+The scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+
+Post them on the [D.I.Y. Punk (Pixel) Art reddit](https://old.reddit.com/r/DIYPunkArt). Thanks.
+

data/Rakefile

@@ -0,0 +1,29 @@
+require 'hoe'
+require './lib/digest-lite/version.rb'
+
+Hoe.spec 'digest-lite' do
+
+  self.version = Digestlite::VERSION
+
+  self.summary = 'digest-lite - crypto(graphic) hash functions / classes - Digest::KeccakLite (512bit, 256bit, etc), Digest::SHA3Lite (512bit, 256bit, etc) in "100% pure" ruby "lite" scripts, that is, without any c-extensions and with zero-dependency'
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/rubycoco/blockchain' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end

data/lib/digest-lite/keccak.rb

@@ -0,0 +1,125 @@
+###
+#  use a "vendor" bundled   keccak 256 in all ruby (no c-extensions required)
+#
+#   see  https://github.com/evtaylor/keccak256
+
+
+
+## require 'digest'
+
+
+
+##
+#  note:  use KeccakLite (or KeccakZero? KeccakSHA3?) instead  of Keccak
+#          to allow usage of native w/ c-extension Keccak and "lite" version
+
+
+
+module Digest
+  class KeccakLite < Digest::Class
+    PILN = [10,  7, 11, 17, 18,  3,  5, 16,
+             8, 21, 24,  4, 15, 23, 19, 13,
+            12,  2, 20, 14, 22,  9,  6,  1]
+
+    ROTC = [ 1,  3,  6, 10, 15, 21, 28, 36,
+            45, 55,  2, 14, 27, 41, 56,  8,
+            25, 43, 62, 18, 39, 61, 20, 44]
+
+    RNDC = [0x0000000000000001, 0x0000000000008082, 0x800000000000808a,
+            0x8000000080008000, 0x000000000000808b, 0x0000000080000001,
+            0x8000000080008081, 0x8000000000008009, 0x000000000000008a,
+            0x0000000000000088, 0x0000000080008009, 0x000000008000000a,
+            0x000000008000808b, 0x800000000000008b, 0x8000000000008089,
+            0x8000000000008003, 0x8000000000008002, 0x8000000000000080,
+            0x000000000000800a, 0x800000008000000a, 0x8000000080008081,
+            0x8000000000008080, 0x0000000080000001, 0x8000000080008008]
+
+    ## note: changed initialize to use param hash_size = 512
+    ##           do NOT hard-code only 256 bit
+    def initialize( hash_size = 512 )
+      @size = hash_size / 8
+      @buffer = ''
+    end
+
+    def <<( s )
+      @buffer << s
+      self
+    end
+    alias_method :update, :<<
+
+    def reset
+      @buffer.clear
+      self
+    end
+
+    def finish
+      s = Array.new( 25, 0 )
+      width = 200 - @size * 2
+
+      ###  note: padding changed in final FIPS PUB 202 standard
+      ##           from "\x01" to "\x06"
+      padding = "\x01"
+
+      buffer = @buffer
+      buffer << padding << "\0" * (width - buffer.size % width)
+      buffer[-1] = (buffer[-1].ord | 0x80).chr
+
+      0.step( buffer.size - 1, width ) do |j|
+        quads = buffer[j, width].unpack( 'Q*' )
+        (width / 8).times do |i|
+          s[i] ^= quads[i]
+        end
+
+        _keccak( s )
+      end
+
+      s.pack('Q*')[0, @size]
+    end
+
+    private
+    def _keccak( s )
+      24.times.each_with_object( [] ) do |round, a|
+        # Theta
+        5.times do |i|
+          a[i] = s[i] ^ s[i + 5] ^ s[i + 10] ^ s[i + 15] ^ s[i + 20]
+        end
+
+        5.times do |i|
+          t = a[(i + 4) % 5] ^ _rotate(a[(i + 1) % 5], 1)
+          0.step( 24, 5 ) do |j|
+            s[j + i] ^= t
+          end
+        end
+
+        # Rho Pi
+        t = s[1]
+        24.times do |i|
+          j = PILN[i]
+          a[0] = s[j]
+          s[j] = _rotate( t, ROTC[i] )
+          t = a[0]
+        end
+
+        # Chi
+        0.step( 24, 5 ) do |j|
+          5.times do |i|
+            a[i] = s[j + i]
+          end
+
+          5.times do |i|
+            s[j + i] ^= ~a[(i + 1) % 5] & a[(i + 2) % 5]
+          end
+        end
+
+        # Iota
+        s[0] ^= RNDC[round]
+      end
+    end
+
+    def _rotate( x, y )
+      (x << y | x >> 64 - y) & (1 << 64) - 1
+    end
+
+
+  end   # class KeccakLite
+end     # module Digest

data/lib/digest-lite/sha3.rb

@@ -0,0 +1,118 @@
+###
+#  use a "vendor" bundled   sha3 in all ruby (no c-extensions required)
+#
+#   see  https://github.com/havenwood/sha3-pure-ruby/blob/master/lib/sha3-pure-ruby.rb
+
+
+## require 'digest'
+
+##
+#  note:  use SHA3Lite (or SHA3Zero? ZeroSHA3?) instead  of SHA3
+#          to allow usage of native w/ c-extension SHA3 and "lite" version
+
+
+module Digest
+  class SHA3Lite < Digest::Class
+    PILN = [10,  7, 11, 17, 18,  3,  5, 16,
+             8, 21, 24,  4, 15, 23, 19, 13,
+            12,  2, 20, 14, 22,  9,  6,  1]
+
+    ROTC = [ 1,  3,  6, 10, 15, 21, 28, 36,
+            45, 55,  2, 14, 27, 41, 56,  8,
+            25, 43, 62, 18, 39, 61, 20, 44]
+
+    RNDC = [0x0000000000000001, 0x0000000000008082, 0x800000000000808a,
+            0x8000000080008000, 0x000000000000808b, 0x0000000080000001,
+            0x8000000080008081, 0x8000000000008009, 0x000000000000008a,
+            0x0000000000000088, 0x0000000080008009, 0x000000008000000a,
+            0x000000008000808b, 0x800000000000008b, 0x8000000000008089,
+            0x8000000000008003, 0x8000000000008002, 0x8000000000000080,
+            0x000000000000800a, 0x800000008000000a, 0x8000000080008081,
+            0x8000000000008080, 0x0000000080000001, 0x8000000080008008]
+
+    def initialize( hash_size = 512 )
+      @size   = hash_size / 8
+      @buffer = ''     ## todo/check: make sure buffer is with encoding BINARY - why? why not?
+    end
+
+    def <<( s )
+      @buffer << s
+      self
+    end
+    alias_method :update, :<<
+
+    def reset
+      @buffer.clear
+      self
+    end
+
+    def finish
+      s = Array.new( 25, 0 )
+      width = 200 - @size * 2
+
+      ###  note: padding changed in final FIPS PUB 202 standard
+      ##           from "\x01" to "\x06"
+      padding = "\x06"
+
+      buffer = @buffer
+      buffer << padding << "\0" * (width - buffer.size % width)
+      buffer[-1] = (buffer[-1].ord | 0x80).chr
+
+      0.step( buffer.size - 1, width ) do |j|
+        quads = buffer[j, width].unpack( 'Q*' )
+        (width / 8).times do |i|
+          s[i] ^= quads[i]
+        end
+
+        _keccak( s )
+      end
+
+      s.pack('Q*')[0, @size]
+    end
+
+ private
+    def _keccak( s )
+      24.times.each_with_object( [] ) do |round, a|
+        # Theta
+        5.times do |i|
+          a[i] = s[i] ^ s[i + 5] ^ s[i + 10] ^ s[i + 15] ^ s[i + 20]
+        end
+
+        5.times do |i|
+          t = a[(i + 4) % 5] ^ _rotate(a[(i + 1) % 5], 1)
+          0.step( 24, 5 ) do |j|
+            s[j + i] ^= t
+          end
+        end
+
+        # Rho Pi
+        t = s[1]
+        24.times do |i|
+          j = PILN[i]
+          a[0] = s[j]
+          s[j] = _rotate( t, ROTC[i] )
+          t = a[0]
+        end
+
+        # Chi
+        0.step( 24, 5 ) do |j|
+          5.times do |i|
+            a[i] = s[j + i]
+          end
+
+          5.times do |i|
+            s[j + i] ^= ~a[(i + 1) % 5] & a[(i + 2) % 5]
+          end
+        end
+
+        # Iota
+        s[0] ^= RNDC[round]
+      end
+    end
+
+    def _rotate( x, y )
+      (x << y | x >> 64 - y) & (1 << 64) - 1
+    end
+
+  end  # class SHA3Lite
+end    # module Digest

data/lib/digest-lite/version.rb

@@ -0,0 +1,22 @@
+
+
+module Digestlite
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "digest-lite/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in (#{root})"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+
+end # module Digestlite
+

data/lib/digest-lite.rb

@@ -0,0 +1,14 @@
+require 'digest'
+
+## our own code
+require_relative 'digest-lite/version'   # note: let version always go first
+require_relative 'digest-lite/keccak'
+require_relative 'digest-lite/sha3'
+
+
+##
+## add camcel case alias - why? why not?
+DigestLite = Digestlite
+
+
+puts Digestlite ## say hello

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: digest-lite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+description: digest-lite - crypto(graphic) hash functions / classes - Digest::KeccakLite
+  (512bit, 256bit, etc), Digest::SHA3Lite (512bit, 256bit, etc) in "100% pure" ruby
+  "lite" scripts, that is, without any c-extensions and with zero-dependency
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/digest-lite.rb
+- lib/digest-lite/keccak.rb
+- lib/digest-lite/sha3.rb
+- lib/digest-lite/version.rb
+homepage: https://github.com/rubycoco/blockchain
+licenses:
+- Public Domain
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: digest-lite - crypto(graphic) hash functions / classes - Digest::KeccakLite
+  (512bit, 256bit, etc), Digest::SHA3Lite (512bit, 256bit, etc) in "100% pure" ruby
+  "lite" scripts, that is, without any c-extensions and with zero-dependency
+test_files: []