digest-sip_hash 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fb155635e2e5bd99bcff43710d42625ad2568666d0aad79ec1e37685c74aad2
-  data.tar.gz: 68b5c8b28f2c60e7fdf8a67a3f0af9b672222c3bd42ac309a266085f4e0c595b
+  metadata.gz: 97550c1117af3f364f69b7cf6fe0811b98abe710c1de440d75d43e2d8da30fc9
+  data.tar.gz: 50f608c0b241a416890727a44be29dda80ba78e213c7b74cee9e114dfed62822
 SHA512:
-  metadata.gz: c5bef15d6df7931d938ca1b1968d801365acc1739ea26957396e73b09ffee98bb69776ad4b08f097b4ba0cc2df890559acebf18c70c4ad9121362d79c16c1527
-  data.tar.gz: b643ae5e6c91ead012d6c1985657421017a775680ca1b186b74fce76354192b330a13d5a25893eaa1a70ab29d351a4511d5f03eea4486e88f01b23a1a5367479
+  metadata.gz: 3e1ce5568375369e28fe69708ae0780d29e74c7859d3df3e8ae248e484a8f6c13d2d851c932a3084831deaf3f8ca7b05f75184bd616a2716151cd08ea9fbd30e
+  data.tar.gz: 47537c8a82aae0818eb6eeea9e879bc6d33e6f340e70efa11d2cb14f6a267bbe1a54bb7b8b651afacd23be918ec6d97133e422706c82dfbd9c0b519bec7e1694

data/README.md

@@ -1,6 +1,6 @@
 # Digest::SipHash
 
-A pure Ruby implementation of SipHash 1-3 and 2-4.
+A pure Ruby implementation of SipHash 1-3 and 2-4. Arbitrary round counts are also supported. If rounds and key are not specified, the default is SipHash 1-3 with a key of sixteen null bytes.
 
 ## Installation
 
@@ -8,7 +8,7 @@ A pure Ruby implementation of SipHash 1-3 and 2-4.
 gem install digest-sip_hash
 ```
 
-## Usage Examples
+## Library Examples
 
 The default key is 16 null bytes. Use `SecureRandom.bytes 16` to generate a random key.
 
@@ -32,6 +32,36 @@ Digest::SipHash24.hexdigest ''
 #=> "1e924b9d737700d7"
 ```
 
+## Command Line Examples
+
+```
+Usage: siphash [OPTIONS] FILE
+    -c=ROUNDS                        Number of c rounds. Default: 1
+    -d=ROUNDS                        Number of d rounds. Default: 3
+    -k, --key=KEY                    Sixteen-byte hex key. Default: "00000000000000000000000000000000"
+```
+
+Check hashes by providing a filename to the `siphash` executable:
+```sh
+touch empty_file
+siphash empty_file
+#>> d1fba762150c532c  empty_file
+```
+
+Or pipe input to `siphash`:
+```sh
+# SipHash 1-3
+echo -n "" | siphash
+#>> d1fba762150c532c  -
+
+# SipHash 2-4
+echo -n "" | siphash -c2 -d4
+#>> 1e924b9d737700d7  -
+
+echo -n "" | siphash --key "00010203040506070809101112131415"
+#>> 067c02f6c87ccd93  -
+```
+
 ## C-Extension Alternative
 
 [digest-siphash](https://github.com/ksss/digest-siphash)

data/bin/siphash

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'digest/sip_hash'
+require 'optionparser'
+
+hex_key = Digest::SipHash::DEFAULT_KEY.unpack1 'H*'
+Settings = Struct.new :c, :d, :key, keyword_init: true
+settings = Settings.new c: 1, d: 3, key: hex_key
+options = ARGV.options do |x|
+  x.banner = "Usage: #{x.program_name} [OPTIONS] FILE"
+  x.version = Digest::SipHash::VERSION
+
+  UnsignedInteger = /\A\d+\z/
+  x.accept UnsignedInteger, UnsignedInteger, &:to_i
+
+  x.on '-c=ROUNDS', UnsignedInteger, "Number of c rounds. Default: #{settings.c}"
+  x.on '-d=ROUNDS', UnsignedInteger, "Number of d rounds. Default: #{settings.d}"
+  x.on '-k', '--key=KEY', String, "Sixteen-byte hex key. Default: \"#{hex_key}\""
+end.freeze
+options.permute! into: settings
+
+path = ARGV.fetch 0, '-'
+hash = Digest::SipHash.new(settings.c, settings.d, key: [settings.key].pack('H*')).hexdigest ARGF.read
+
+puts "#{hash}  #{path}"

data/lib/digest/sip_hash.rb

@@ -5,7 +5,7 @@ require 'digest/sip_hash/version'
 
 module Digest
   class SipHash < Digest::Class
-    DEFAULT_KEY = (0.chr * 16).freeze
+    DEFAULT_KEY = 0.chr * 16
 
     attr_accessor :key
 
@@ -29,7 +29,7 @@ module Digest
 
     def finish
       sip = Sip.new @buffer, @key, @c_rounds, @d_rounds
-      sip.append
+      sip.transform
       sip.finalize
     end
 
@@ -55,9 +55,10 @@ module Digest
         @v3 = V3 ^ k1
       end
 
-      def append
-        (@size / 8).times { |n| compress_word @buffer.slice(n * 8, 8).unpack1 'Q<' }
-        compress_word complete_pending
+      def transform
+        return compress_word 0 if @size.zero?
+        (@size / 8).times { |n| compress_word word n }
+        compress_word last_word
       end
 
       def finalize
@@ -68,45 +69,53 @@ module Digest
 
       private
 
+      def compress_word m
+        @v3 ^= m
+        @c_rounds.times { compress }
+        @v0 ^= m
+      end
+
+      def word n
+        @buffer.slice(n * 8, 8).unpack1 'Q<'
+      end
+
+      def last_word
+        remainder = @size % 8
+        offset = @size - remainder
+
+        last = @size << 56 & MASK
+
+        7.downto 0 do |n|
+          next if n >= remainder
+          last |= @buffer[n + offset].ord << 8 * n
+        end
+
+        last
+      end
+
       def compress
-        @v0 = (@v0 + @v1) & MASK
+        @v0 += @v1
+        @v0 &= MASK
         @v1 = rotate @v1, by: 13
         @v1 ^= @v0
         @v0 = rotate @v0, by: 32
-        @v2 = (@v2 + @v3) & MASK
+        @v2 += @v3
+        @v2 &= MASK
         @v3 = rotate @v3, by: 16
         @v3 ^= @v2
-        @v0 = (@v0 + @v3) & MASK
+        @v0 += @v3
+        @v0 &= MASK
         @v3 = rotate @v3, by: 21
         @v3 ^= @v0
-        @v2 = (@v2 + @v1) & MASK
+        @v2 += @v1
+        @v2 &= MASK
         @v1 = rotate @v1, by: 17
         @v1 ^= @v2
         @v2 = rotate @v2, by: 32
       end
 
       def rotate n, by:
-        n << by & MASK | (n >> (64 - by))
-      end
-
-      def compress_word m
-        @v3 ^= m
-        @c_rounds.times { compress }
-        @v0 ^= m
-      end
-
-      def complete_pending
-        last = (@size << 56) & MASK
-        return last if @size.zero?
-
-        r = @size % 8
-        offset = @size / 8 * 8
-
-        [0, 8, 16, 24, 32, 40, 48].each_with_index.reverse_each do |n, i|
-          last |= @buffer[offset + i].ord << n if r > i
-        end
-
-        last
+        n << by & MASK | n >> 64 - by
       end
     end
   end

data/lib/digest/sip_hash/version.rb

@@ -2,6 +2,6 @@
 
 module Digest
   class SipHash < Digest::Class
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/spec/helper.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../lib/digest/sip_hash'
+lib = File.expand_path '../../lib', __FILE__
+$LOAD_PATH.prepend lib unless $LOAD_PATH.include? lib
+
+require 'digest/sip_hash'
 require 'minitest/autorun'
 require 'minitest/pride'

data/spec/runner.rb

@@ -8,25 +8,51 @@ describe Digest::SipHash do
       assert_equal Digest::SipHash.hexdigest(''), Digest::SipHash13.hexdigest('')
     end
 
-    it 'produces the correct hash' do
+    it 'is the correct hexdigest' do
       assert_equal 'd1fba762150c532c', Digest::SipHash13.hexdigest('')
-      assert_equal 'abac0158050fc4dc', Digest::SipHash13.hexdigest('', key: 16.times.map(&:chr).join)
+      assert_equal '8264ceeccb16bcbe', Digest::SipHash13.hexdigest('siphash')
       assert_equal 'ce31007e34130c0a', Digest::SipHash13.hexdigest('digest-sip_hash')
       assert_equal '1b47c0cc4dd21f05', Digest::SipHash13.hexdigest('x' * 1_000)
     end
+
+    describe 'with a key' do
+      let :key do
+        16.times.map(&:chr).join
+      end
+
+      it 'is the correct hexdigest' do
+        assert_equal 'abac0158050fc4dc', Digest::SipHash13.hexdigest('', key: key)
+        assert_equal 'd5518fe19f28c745', Digest::SipHash13.hexdigest('siphash', key: key)
+        assert_equal '71783f159400d4b5', Digest::SipHash13.hexdigest('digest-sip_hash', key: key)
+        assert_equal '2a82bb3e74675b16', Digest::SipHash13.hexdigest('x' * 1_000, key: key)
+      end
+    end
   end
 
   describe Digest::SipHash24 do
-    it 'produces the correct hash' do
+    it 'is the correct hexdigest' do
       assert_equal '1e924b9d737700d7', Digest::SipHash24.hexdigest('')
-      assert_equal '726fdb47dd0e0e31', Digest::SipHash24.hexdigest('', key: 16.times.map(&:chr).join)
+      assert_equal '59caaeb90d542464', Digest::SipHash24.hexdigest('siphash')
       assert_equal '4b5cd6bb2500bc8f', Digest::SipHash24.hexdigest('digest-sip_hash')
       assert_equal 'a07a230346e2656b', Digest::SipHash24.hexdigest('x' * 1_000)
     end
+
+    describe 'with a key' do
+      let :key do
+        16.times.map(&:chr).join
+      end
+
+      it 'is the correct hexdigest' do
+        assert_equal '726fdb47dd0e0e31', Digest::SipHash24.hexdigest('', key: key)
+        assert_equal '882768570dc71c92', Digest::SipHash24.hexdigest('siphash', key: key)
+        assert_equal '882768570dc71c92', Digest::SipHash24.hexdigest('siphash', key: key)
+        assert_equal '882768570dc71c92', Digest::SipHash24.hexdigest('siphash', key: key)
+      end
+    end
   end
 
   describe 'arbitrary rounds other than 1-3 and 2-4' do
-    it 'produces the correct hash' do
+    it 'is the correct hexdigest' do
       assert_equal '3204eeb59b3cccdd', Digest::SipHash.new(1, 2).hexdigest('')
       assert_equal 'cea28b51565c12e2', Digest::SipHash.new(1, 2, key: 16.times.map(&:chr).join).hexdigest('')
       assert_equal '95772adebda3f3f0', Digest::SipHash.new(3, 5).hexdigest('')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digest-sip_hash
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Shannon Skipper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-31 00:00:00.000000000 Z
+date: 2018-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -41,7 +41,8 @@ dependencies:
 description: An implementation of SipHash 1-3 and 2-4 in pure Ruby.
 email:
 - shannonskipper@gmail.com
-executables: []
+executables:
+- siphash
 extensions: []
 extra_rdoc_files: []
 files:
@@ -49,6 +50,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/siphash
 - lib/digest/sip_hash.rb
 - lib/digest/sip_hash/version.rb
 - spec/helper.rb