sleeping_kangaroo12 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b89369bac3beb3d85045ea6f94f2c0d995d4e72e04a1887f83818b308e4bae7
-  data.tar.gz: 464479f5b0d85d7d6c5453e208fc287b5637f1fcc99769101aeee75e9dd2ec58
+  metadata.gz: 43f29b860cf5a2c6dc1fac237ebbc490a309277f7e61fcaa078a2f0c097b6a26
+  data.tar.gz: 96f53173416460a9a64decd3312a5c613bf3875a68bec5bb43d8cfdb834c4517
 SHA512:
-  metadata.gz: 7514b62f2f38a373d055f71dd6acce85ab37554403bc3fb294e2b516e768133120134469d29d81b69be36f6804dd002439ce49e9208bf6831d7e99d359bee21a
-  data.tar.gz: 4a5dea0068e28db9180e65c3469863f9c6ada04948866999efe788c1ef941d7eebfdb6d1a18a816175b6dbd85d653d8f83bdd6613514c70e3c907245ee75911e
+  metadata.gz: 7c49649a2576b01241565d83c77e7738eec932239cda39a59cadefffaf3820d996487db856d4c7bc63c00f1b698b832bc871c8627483754bf8ee9a216df113df
+  data.tar.gz: 67cd342201f52cd5c94a4a35d2df005b942d3e1ca2ec5a0eb9b56e36644b996842ce4788635507460cf3f9e3dd92761d6e269224862875f9caf4d23220ce9ed7

data/.yardopts

@@ -0,0 +1,4 @@
+lib/**/digest.rb
+-
+README.md
+LICENSE.md

data/README.md

@@ -1,5 +1,8 @@
 # SleepingKangaroo12
 
+[![GitHub version](https://badge.fury.io/gh/the-cave%2Fsleeping-kangaroo12.svg)](https://badge.fury.io/gh/the-cave%2Fsleeping-kangaroo12)
+[![Gem Version](https://badge.fury.io/rb/sleeping_kangaroo12.svg)](https://badge.fury.io/rb/sleeping_kangaroo12)
+
 ## What is it?
 
 SleepingKangaroo12 is a Ruby binding of [KangarooTwelve](https://keccak.team/kangarootwelve.html), a fast cryptographic
@@ -42,6 +45,12 @@ In order to install the gem, your machine should be ready to build the K12 packa
 - xsltproc executable, normally comes with libxslt package
 - Ruby related stuffs
 
+### TL;DR for Ubuntu-liked OS
+
+~~~bash
+sudo apt install build-essential xsltproc
+~~~
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -50,7 +59,7 @@ Add this line to your application's Gemfile:
 gem 'sleeping_kangaroo12'
 ~~~
 
-And then execute:
+Check the [prerequisites](#prerequisites); and then execute:
 
     $ bundle install
 

data/ext/k12/lib/KangarooTwelve.c

@@ -47,7 +47,7 @@ static void KangarooTwelve_F_Absorb(KangarooTwelve_F *instance, const unsigned c
     i = 0;
     curData = data;
     while(i < dataByteLen) {
-        if ((instance->byteIOIndex == 0) && (dataByteLen >= (i + rateInBytes))) {
+        if ((instance->byteIOIndex == 0) && (dataByteLen-i >= rateInBytes)) {
 #ifdef KeccakP1600_12rounds_FastLoop_supported
             /* processing full blocks first */
             j = KeccakP1600_12rounds_FastLoop_Absorb(instance->state, K12_rateInLanes, curData, dataByteLen - i);
@@ -62,7 +62,7 @@ static void KangarooTwelve_F_Absorb(KangarooTwelve_F *instance, const unsigned c
             i = dataByteLen - j;
         } else {
             /* normal lane: using the message queue */
-            if ((dataByteLen - i) + instance->byteIOIndex > (size_t)rateInBytes) {
+            if (dataByteLen - i > (size_t)rateInBytes - instance->byteIOIndex) {
                 partialBlock = rateInBytes-instance->byteIOIndex;
             } else {
                 partialBlock = (uint8_t)(dataByteLen - i);
@@ -112,7 +112,7 @@ static void KangarooTwelve_F_Squeeze(KangarooTwelve_F *instance, unsigned char *
     i = 0;
     curData = data;
     while(i < dataByteLen) {
-        if ((instance->byteIOIndex == rateInBytes) && (dataByteLen >= (i + rateInBytes))) {
+        if ((instance->byteIOIndex == rateInBytes) && (dataByteLen-i >= rateInBytes)) {
             for(j=dataByteLen-i; j>=rateInBytes; j-=rateInBytes) {
                 KeccakP1600_Permute_12rounds(instance->state);
                 KeccakP1600_ExtractBytes(instance->state, curData, 0, rateInBytes);
@@ -125,9 +125,10 @@ static void KangarooTwelve_F_Squeeze(KangarooTwelve_F *instance, unsigned char *
                 KeccakP1600_Permute_12rounds(instance->state);
                 instance->byteIOIndex = 0;
             }
-            partialBlock = (unsigned int)(dataByteLen - i);
-            if (partialBlock+instance->byteIOIndex > rateInBytes)
+            if (dataByteLen-i > rateInBytes-instance->byteIOIndex)
                 partialBlock = rateInBytes-instance->byteIOIndex;
+            else
+                partialBlock = (unsigned int)(dataByteLen - i);
             i += partialBlock;
 
             KeccakP1600_ExtractBytes(instance->state, curData, instance->byteIOIndex, partialBlock);

data/ext/k12/lib/Optimized64/KeccakP-1600-timesN-AVX2.c

@@ -33,8 +33,8 @@ Please refer to the XKCP for more details.
 #define ROL64in256(d, a, o)     d = _mm256_or_si256(_mm256_slli_epi64(a, o), _mm256_srli_epi64(a, 64-(o)))
 #define ROL64in256_8(d, a)      d = _mm256_shuffle_epi8(a, CONST256(rho8))
 #define ROL64in256_56(d, a)     d = _mm256_shuffle_epi8(a, CONST256(rho56))
-static const uint64_t rho8[4] ALIGN(32) = {0x0605040302010007, 0x0E0D0C0B0A09080F, 0x1615141312111017, 0x1E1D1C1B1A19181F};
-static const uint64_t rho56[4] ALIGN(32) = {0x0007060504030201, 0x080F0E0D0C0B0A09, 0x1017161514131211, 0x181F1E1D1C1B1A19};
+static ALIGN(AVX2alignment) const uint64_t rho8[4] = {0x0605040302010007, 0x0E0D0C0B0A09080F, 0x1615141312111017, 0x1E1D1C1B1A19181F};
+static ALIGN(AVX2alignment) const uint64_t rho56[4] = {0x0007060504030201, 0x080F0E0D0C0B0A09, 0x1017161514131211, 0x181F1E1D1C1B1A19};
 #define STORE256(a, b)          _mm256_store_si256((__m256i *)&(a), b)
 #define STORE256u(a, b)         _mm256_storeu_si256((__m256i *)&(a), b)
 #define XOR256(a, b)            _mm256_xor_si256(a, b)

data/ext/k12/support/Build/ToTargetMakefile.xsl

@@ -52,33 +52,37 @@ http://creativecommons.org/publicdomain/zero/1.0/
 </xsl:template>
 
 <xsl:template match="gcc">
-    <!-- What follows is a shameless hack to avoid -march=native on aarch64 with clang -->
-    <xsl:if test=".= '-march=native'">
-        <xsl:text>ifneq ($(UNAME_M)$(findstring clang,$(CC)),aarch64clang)
+    <!-- What follows is a shameless hack to avoid -march/-mtune=native on arm64/aarch64 with clang -->
+    <xsl:if test=".= '-march=native' or .= '-mtune=native'">
+        <xsl:text>ifneq ($(UNAME_M),aarch64)
+ifneq ($(UNAME_S),Darwin)
 </xsl:text>
     </xsl:if>
     <xsl:text>CFLAGS := $(CFLAGS) </xsl:text>
     <xsl:value-of select="."/>
     <xsl:text>
 </xsl:text>
-    <xsl:if test=".= '-march=native'">
+    <xsl:if test=".= '-march=native' or .= '-mtune=native'">
         <xsl:text>endif
+endif
 </xsl:text>
     </xsl:if>
 </xsl:template>
 
 <xsl:template match="gas">
-    <!-- What follows is a shameless hack to avoid -march=native on aarch64 with clang -->
-    <xsl:if test=".= '-march=native'">
-        <xsl:text>ifneq ($(UNAME_M)$(findstring clang,$(CC)),aarch64clang)
+    <!-- What follows is a shameless hack to avoid -march/-mtune=native on arm64/aarch64 with clang -->
+    <xsl:if test=".= '-march=native' or .= '-mtune=native'">
+        <xsl:text>ifneq ($(UNAME_M),aarch64)
+ifneq ($(UNAME_S),Darwin)
 </xsl:text>
     </xsl:if>
     <xsl:text>ASMFLAGS := $(ASMFLAGS) </xsl:text>
     <xsl:value-of select="."/>
     <xsl:text>
 </xsl:text>
-    <xsl:if test=".= '-march=native'">
+    <xsl:if test=".= '-march=native' or .= '-mtune=native'">
         <xsl:text>endif
+endif
 </xsl:text>
     </xsl:if>
 </xsl:template>
@@ -200,9 +204,11 @@ ifeq ($(UNAME_S),Linux)
     ASMFLAGS :=
 endif
 ifeq ($(UNAME_S),Darwin)
-    ASMFLAGS := -x assembler-with-cpp -Wa,-defsym,macOS=1
+    ASMFLAGS := -x assembler-with-cpp -Wa,-defsym,old_gas_syntax=1 -Wa,-defsym,no_plt=1
+endif
+ifneq (,$(findstring mingw32,$(CC)))
+    ASMFLAGS := -x assembler-with-cpp -Wa,-defsym,old_gas_syntax=1 -Wa,-defsym,no_plt=1
 endif
-
 UNAME_M := $(shell uname -m)
 
 </xsl:text>

data/lib/sleeping_kangaroo12/build/platform.rb

@@ -7,7 +7,6 @@ module SleepingKangaroo12
   module Build
     # mostly taken from:
     # https://github.com/ffi/ffi-compiler/blob/master/lib/ffi-compiler/platform.rb
-
     class Platform
       include ::Singleton
 

data/lib/sleeping_kangaroo12/digest.rb

@@ -6,16 +6,30 @@ require 'objspace'
 require_relative 'binding'
 
 module SleepingKangaroo12
+  # @example basic usage
+  #   digest = ::SleepingKangaroo12::Digest.new(output_length: 10)
+  #   digest << 'some input'
+  #   digest << 'some more input'
+  #   digest.hexdigest
+  #   #=> "cbea8144fbbf6150ceaf"
+  # See {file:README.md README} for more usage examples
   class Digest
+    module Error
+    end
+
     class UpdatingFailed < ::StandardError
+      include Error
     end
 
     class FinalizationFailed < ::StandardError
+      include Error
     end
 
     class Finalized < ::StandardError
+      include Error
     end
 
+    # Create a new Digest
     def initialize(output_length: 32, key: nil)
       raise ::TypeError, 'Hash length is not an Integer' unless output_length.is_a?(::Integer)
       raise ::ArgumentError, 'Hash length out of range' unless (1...(1 << 20)).include?(output_length)
@@ -31,6 +45,7 @@ module SleepingKangaroo12
       @result = nil
     end
 
+    # Feed in the data
     def update(data)
       raise Finalized if @finalized
       data_size = data.bytesize
@@ -42,10 +57,12 @@ module SleepingKangaroo12
       self
     end
 
+    # Alias for {#update}
     def <<(*args, **kwargs)
       update(*args, **kwargs)
     end
 
+    # Finalize and output a binary hash
     def digest
       @finalized = true
       return @_digest if @_digest
@@ -65,30 +82,45 @@ module SleepingKangaroo12
       @_digest = data_buffer.get_bytes(0, @output_length)
     end
 
+    # Finalize and output a hexadecimal-encoded hash
     def hexdigest
       @_hexdigest ||= digest.unpack1('H*')
     end
 
+    # Finalize and output a Base64-encoded hash
     def base64digest
       @_base64digest ||= ::Base64.strict_encode64(digest)
     end
 
     class << self
+      # @!visibility private
       # https://www.mikeperham.com/2010/02/24/the-trouble-with-ruby-finalizers/
       def _create_finalizer(instance)
-        proc {
+        proc do
           Binding.destroy(instance)
-        }
+        end
       end
 
+      # Shortcut to calculate a raw digest
+      # @example basic usage
+      #   ::SleepingKangaroo12::Digest.digest('some input')
+      #   #=> "m\x9FJ\xDA\xE9\x96\xD1X\xC5K\xE83e(x\x8C\xD3o\xFBh\xB2\x17W ,\xD5\xED!\xE4D\xAF\xDD"
+      # @example with key (AKA: customization)
+      #   ::SleepingKangaroo12::Digest.digest('some input', key: 'secret')
+      #   #=> "\x96\xE2K\xC4\xCF\xFFGF\xE1\x05\xB9\xF6f\xF0-\xF8\x1F\a\n\xFC\xD7\xC9\x91\n\xFC\xFB\xA6hOx\x99<"
+      # @example controlled output length
+      #   ::SleepingKangaroo12::Digest.digest('some input', output_length: 5)
+      #   #=> "m\x9FJ\xDA\xE9"
       def digest(*args, **kwargs)
         _generic_digest(*args, **kwargs, &:digest)
       end
 
+      # Same as {.digest} but encode the output in hexadecimal format
       def hexdigest(*args, **kwargs)
         _generic_digest(*args, **kwargs, &:hexdigest)
       end
 
+      # Same as {.digest} but encode the output in Base64 format
       def base64digest(*args, **kwargs)
         _generic_digest(*args, **kwargs, &:base64digest)
       end

data/lib/sleeping_kangaroo12/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SleepingKangaroo12
-  VERSION = '0.0.4'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_kangaroo12
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Sarun Rattanasiri
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -16,52 +16,53 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.5
+        version: 1.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.5
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: posix-spawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.15
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.15
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 13.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
-description: This gem brought the hash algorithm, KangarooTwelve, to Ruby. It uses
-  the official library, K12, maintained by the Keccak team themselves. The implementation
-  is highly optimized on popular hardware, including AVX512, AVX2, SSSE3 instruction
-  sets.
+        version: 13.0.0
+description: |-
+  KangarooTwelve binding for Ruby
+  The gem build on top of the official library, K12, maintained by the Keccak team themselves.
+  The implementation is highly optimized and supporting AVX512, AVX2, SSSE3 instruction sets.
 email: midnight_w@gmx.tw
 executables: []
 extensions:
 - ext/Rakefile
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - LICENSE.md
 - README.md
 - ext/Rakefile
@@ -107,7 +108,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   homepage_uri: https://github.com/the-cave/sleeping-kangaroo12
-  source_code_uri: https://github.com/the-cave/sleeping-kangaroo12/tree/v0.0.4
+  source_code_uri: https://github.com/the-cave/sleeping-kangaroo12/tree/v0.0.6
+  documentation_uri: https://rubydoc.info/gems/sleeping_kangaroo12/0.0.6
+  bug_tracker_uri: https://github.com/the-cave/sleeping-kangaroo12/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -123,8 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A binding of the KangarooTwelve hash algorithm for Ruby
+summary: KangarooTwelve, the hash algorithm, native binding for Ruby
 test_files: []