digest-sip_hash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fb155635e2e5bd99bcff43710d42625ad2568666d0aad79ec1e37685c74aad2
+  data.tar.gz: 68b5c8b28f2c60e7fdf8a67a3f0af9b672222c3bd42ac309a266085f4e0c595b
+SHA512:
+  metadata.gz: c5bef15d6df7931d938ca1b1968d801365acc1739ea26957396e73b09ffee98bb69776ad4b08f097b4ba0cc2df890559acebf18c70c4ad9121362d79c16c1527
+  data.tar.gz: b643ae5e6c91ead012d6c1985657421017a775680ca1b186b74fce76354192b330a13d5a25893eaa1a70ab29d351a4511d5f03eea4486e88f01b23a1a5367479

data/Gemfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2018 Shannon Skipper
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Digest::SipHash
+
+A pure Ruby implementation of SipHash 1-3 and 2-4.
+
+## Installation
+
+```bash
+gem install digest-sip_hash
+```
+
+## Usage Examples
+
+The default key is 16 null bytes. Use `SecureRandom.bytes 16` to generate a random key.
+
+```ruby
+Digest::SipHash.new.hexdigest ''
+#=> "d1fba762150c532c"
+
+Digest::SipHash.new(key: 16.times.map(&:chr).join).hexdigest ''
+#=> "abac0158050fc4dc"
+
+Digest::SipHash.new(1, 3).hexdigest ''
+#=> "d1fba762150c532c"
+
+Digest::SipHash13.hexdigest ''
+#=> "d1fba762150c532c"
+
+Digest::SipHash.new(2, 4).hexdigest ''
+#=> "1e924b9d737700d7"
+
+Digest::SipHash24.hexdigest ''
+#=> "1e924b9d737700d7"
+```
+
+## C-Extension Alternative
+
+[digest-siphash](https://github.com/ksss/digest-siphash)
+
+## Requirements
+
+Ruby 2.5+
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+task default: %w[test]
+
+task :test do
+  ruby 'spec/runner.rb'
+end

data/lib/digest/sip_hash.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'digest/sip_hash/version'
+
+module Digest
+  class SipHash < Digest::Class
+    DEFAULT_KEY = (0.chr * 16).freeze
+
+    attr_accessor :key
+
+    def initialize c_rounds = 1, d_rounds = 3, key: DEFAULT_KEY
+      @c_rounds = c_rounds
+      @d_rounds = d_rounds
+      @key = key
+      @buffer = +''
+    end
+
+    def << s
+      @buffer << s
+      self
+    end
+    alias update <<
+
+    def reset
+      @buffer.clear
+      self
+    end
+
+    def finish
+      sip = Sip.new @buffer, @key, @c_rounds, @d_rounds
+      sip.append
+      sip.finalize
+    end
+
+    class Sip
+      MASK = 2 ** 64 - 1
+      V0 = 'somepseu'.unpack1 'Q>'
+      V1 = 'dorandom'.unpack1 'Q>'
+      V2 = 'lygenera'.unpack1 'Q>'
+      V3 = 'tedbytes'.unpack1 'Q>'
+
+      def initialize buffer, key, c_rounds, d_rounds
+        @buffer = buffer
+        @size = @buffer.size
+        @c_rounds = c_rounds
+        @d_rounds = d_rounds
+
+        k0 = key[0..7].unpack1 'Q<'
+        k1 = key[8..15].unpack1 'Q<'
+
+        @v0 = V0 ^ k0
+        @v1 = V1 ^ k1
+        @v2 = V2 ^ k0
+        @v3 = V3 ^ k1
+      end
+
+      def append
+        (@size / 8).times { |n| compress_word @buffer.slice(n * 8, 8).unpack1 'Q<' }
+        compress_word complete_pending
+      end
+
+      def finalize
+        @v2 ^= 2 ** 8 - 1
+        @d_rounds.times { compress }
+        [@v0 ^ @v1 ^ @v2 ^ @v3].pack 'Q>'
+      end
+
+      private
+
+      def compress
+        @v0 = (@v0 + @v1) & MASK
+        @v1 = rotate @v1, by: 13
+        @v1 ^= @v0
+        @v0 = rotate @v0, by: 32
+        @v2 = (@v2 + @v3) & MASK
+        @v3 = rotate @v3, by: 16
+        @v3 ^= @v2
+        @v0 = (@v0 + @v3) & MASK
+        @v3 = rotate @v3, by: 21
+        @v3 ^= @v0
+        @v2 = (@v2 + @v1) & 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
+      end
+    end
+  end
+
+  class SipHash13 < SipHash
+    def initialize key: DEFAULT_KEY
+      super 1, 3, key: key
+    end
+  end
+
+  class SipHash24 < SipHash
+    def initialize key: DEFAULT_KEY
+      super 2, 4, key: key
+    end
+  end
+end

data/lib/digest/sip_hash/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Digest
+  class SipHash < Digest::Class
+    VERSION = '0.0.1'
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative '../lib/digest/sip_hash'
+require 'minitest/autorun'
+require 'minitest/pride'

data/spec/runner.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+describe Digest::SipHash do
+  describe Digest::SipHash13 do
+    it 'is the default' do
+      assert_equal Digest::SipHash.hexdigest(''), Digest::SipHash13.hexdigest('')
+    end
+
+    it 'produces the correct hash' do
+      assert_equal 'd1fba762150c532c', Digest::SipHash13.hexdigest('')
+      assert_equal 'abac0158050fc4dc', Digest::SipHash13.hexdigest('', key: 16.times.map(&:chr).join)
+      assert_equal 'ce31007e34130c0a', Digest::SipHash13.hexdigest('digest-sip_hash')
+      assert_equal '1b47c0cc4dd21f05', Digest::SipHash13.hexdigest('x' * 1_000)
+    end
+  end
+
+  describe Digest::SipHash24 do
+    it 'produces the correct hash' do
+      assert_equal '1e924b9d737700d7', Digest::SipHash24.hexdigest('')
+      assert_equal '726fdb47dd0e0e31', Digest::SipHash24.hexdigest('', key: 16.times.map(&:chr).join)
+      assert_equal '4b5cd6bb2500bc8f', Digest::SipHash24.hexdigest('digest-sip_hash')
+      assert_equal 'a07a230346e2656b', Digest::SipHash24.hexdigest('x' * 1_000)
+    end
+  end
+
+  describe 'arbitrary rounds other than 1-3 and 2-4' do
+    it 'produces the correct hash' 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('')
+      assert_equal 'f344baf915afc13a', Digest::SipHash.new(3, 5).hexdigest('x' * 1_000)
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: digest-sip_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shannon Skipper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: An implementation of SipHash 1-3 and 2-4 in pure Ruby.
+email:
+- shannonskipper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/digest/sip_hash.rb
+- lib/digest/sip_hash/version.rb
+- spec/helper.rb
+- spec/runner.rb
+homepage: https://github.com/havenwood/digest-sip_hash
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Pure Ruby SipHash 1-3 and 2-4.
+test_files: []