keccak256 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee15cbda09e860d595c0efd6974b8ede74ef568620b20946386d879f6bbd3416
+  data.tar.gz: b6a761015bf6712727d73311dd8f2060f886e77584a1a2ed615529fec74af874
+SHA512:
+  metadata.gz: baa31c4d0b438bd4c198d1ac6d65ea883ae4a71e12d0e090d4b379f4c5aa19e3f049eb9f6ab3f1f6c108804ff1cfd5af2add3661b305d2372191fd865a3414ff
+  data.tar.gz: a8d3dd4f3039126ab8a31f259d53aecf0077bf1d7b4259f029f256563cbed3bce8941bca772fdea449df9bf853e7998311b9fd7005fa0376043ee38e06e6eb99

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+.idea/
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+sudo: false
+
+before_install: rvm get head
+
+rvm:
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+  - jruby-9.0.5.0
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/ChangeLog.md

@@ -0,0 +1,3 @@
+### 2.0.0 / 2021-06-04
+
+* Initial Release

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,32 @@
+# Keccak256 Gem
+
+**Note:** This is a fork of [havenwood/sha3-pure-ruby](https://github.com/havenwood/sha3-pure-ruby) to add support for the (older) Keccak version this hashing algorithm which Ethereum uses.  
+
+> A pure Ruby implementation of Keccak256.
+
+## Installation
+
+Install it from the command line:
+
+```bash
+gem install keccak256
+```
+
+Or execute `bundle` after adding this line to your app's Gemfile:
+
+```ruby
+gem 'keccak256'
+```
+
+## Usage Example
+
+```ruby
+Digest::Keccak256.new.hexdigest 'cat'
+#=> "52763589e772702fa7977a28b3cfb6ca534f0208a2b2d55f7558af664eac478a"
+```
+
+## License
+
+Creative Commons
+
+See original license: [havenwood/sha3-pure-ruby](https://github.com/havenwood/sha3-pure-ruby)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+task default: [:test]
+
+task :test do
+  ruby 'test/test_keccak256.rb'
+end

data/keccack256.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path '../lib', __FILE__
+$:.unshift lib unless $:.include? lib
+
+Gem::Specification.new do |spec|
+  spec.name          = 'keccak256'
+  spec.version       = '2.0.0'
+  spec.authors       = ['havenwood', 'evtaylor']
+  spec.email         = ['admin@evantaylor.ca']
+  spec.description   = 'An implementation of Keccak256 (the hash function used by Ethereum) in pure Ruby.'
+  spec.summary       = 'Pure Ruby Keccack256.'
+  spec.homepage      = 'https://github.com/evtaylor/sha3-pure-ruby'
+  spec.license       = 'https://creativecommons.org/publicdomain/zero/1.0/'
+  spec.files         = `git ls-files`.split $/
+  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename f }
+  spec.test_files    = spec.files.grep %r{^(test)/}
+  spec.require_paths = ['lib']
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+end

data/lib/keccak256.rb

@@ -0,0 +1,103 @@
+require 'digest'
+
+module Digest
+  class Keccak256 < 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
+      @size = 256 / 8
+      @buffer = ''
+    end
+    
+    def << s
+      @buffer << s
+      self
+    end
+    alias update <<
+    
+    def reset
+      @buffer.clear
+      self
+    end
+    
+    def finish
+      s = Array.new 25, 0
+      width = 200 - @size * 2
+      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
+end

data/test/test_keccak256.rb

@@ -0,0 +1,24 @@
+require File.expand_path '../../lib/keccak256', __FILE__
+require 'minitest/autorun'
+require 'minitest/pride'
+
+# http://emn178.github.io/online-tools/sha3_224.html
+# http://emn178.github.io/online-tools/sha3_256.html
+# http://emn178.github.io/online-tools/sha3_512.html
+# http://emn178.github.io/online-tools/sha3_384.html
+
+describe Digest::Keccak256 do
+  describe 'Default 256 Keccak padding' do
+    it 'should work when empty' do
+      empty_string_sha3 = 'c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470'
+      assert_equal Digest::Keccak256.new.hexdigest(''), empty_string_sha3
+    end
+
+    it 'should work with content' do
+      cat_sha3 = '52763589e772702fa7977a28b3cfb6ca534f0208a2b2d55f7558af664eac478a'
+      assert_equal Digest::Keccak256.new.hexdigest('cat'), cat_sha3
+    end
+
+  end
+end
+    

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: keccak256
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- havenwood
+- evtaylor
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An implementation of Keccak256 (the hash function used by Ethereum) in
+  pure Ruby.
+email:
+- admin@evantaylor.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ChangeLog.md
+- Gemfile
+- README.md
+- Rakefile
+- keccack256.gemspec
+- lib/keccak256.rb
+- test/test_keccak256.rb
+homepage: https://github.com/evtaylor/sha3-pure-ruby
+licenses:
+- https://creativecommons.org/publicdomain/zero/1.0/
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Pure Ruby Keccack256.
+test_files:
+- test/test_keccak256.rb