sha3 0.2.6 → 1.0.1

data/ext/sha3/digest.c

@@ -7,7 +7,7 @@ VALUE eSHA3DigestError;
 
 /*
  * == Notes
- *  
+ *
  *    ::Digest::Class call sequence ->
  *    | .alloc() ->
  *    | .new() ->
@@ -16,31 +16,33 @@ VALUE eSHA3DigestError;
  *    --| .alloc() ->
  *      | .copy() ->
  *      | .finish() ->
- *  
+ *
  */
 
-static void free_allox(MDX *mdx) 
+static void free_allox(MDX *mdx)
 {
   if (mdx) {
-    if (mdx->state)
+    if (mdx->state) {
       free(mdx->state);
+    }
 
     free(mdx);
-  } 
+  }
 
   return;
 }
 
-static VALUE c_digest_alloc(VALUE klass) 
-{ 
+static VALUE c_digest_alloc(VALUE klass)
+{
   MDX *mdx;
   VALUE obj;
 
   mdx = (MDX *) malloc(sizeof(MDX));
-  if (!mdx)
+  if (!mdx) {
     rb_raise(eSHA3DigestError, "failed to allocate object memory");
+  }
 
-  mdx->state = (hashState *) malloc(sizeof(hashState));  
+  mdx->state = (Keccak_HashInstance *) malloc(sizeof(Keccak_HashInstance));
   if (!mdx->state) {
     free_allox(mdx);
     rb_raise(eSHA3DigestError, "failed to allocate state memory");
@@ -48,7 +50,7 @@ static VALUE c_digest_alloc(VALUE klass)
 
   obj = Data_Wrap_Struct(klass, 0, free_allox, mdx);
 
-  memset(mdx->state, 0, sizeof(hashState));
+  memset(mdx->state, 0, sizeof(Keccak_HashInstance));
   mdx->hashbitlen = 0;
 
   return obj;
@@ -56,31 +58,56 @@ static VALUE c_digest_alloc(VALUE klass)
 
 static VALUE c_digest_update(VALUE, VALUE);
 
+HashReturn c_keccak_hash_initialize(MDX *mdx)
+{
+  HashReturn r = FAIL;
+
+  switch (mdx->hashbitlen) {
+    case 224:
+      r = Keccak_HashInitialize_SHA3_224(mdx->state);
+      break;
+    case 256:
+      r = Keccak_HashInitialize_SHA3_256(mdx->state);
+      break;
+    case 384:
+      r = Keccak_HashInitialize_SHA3_384(mdx->state);
+      break;
+    case 512:
+      r = Keccak_HashInitialize_SHA3_512(mdx->state);
+      break;
+    }
+
+  return r;
+}
+
 // SHA3::Digest.new(type, [data]) -> self
 static VALUE c_digest_init(int argc, VALUE *argv, VALUE self)
-{ 
+{
   MDX *mdx;
   VALUE hlen, data;
 
   rb_scan_args(argc, argv, "02", &hlen, &data);
   GETMDX(self, mdx);
 
-  if (!NIL_P(hlen))
+  if (!NIL_P(hlen)) {
     mdx->hashbitlen = get_hlen(hlen);
-  else
+  } else {
     mdx->hashbitlen = 256;
+  }
 
-  if (Init(mdx->state, mdx->hashbitlen) != SUCCESS)
+  if (c_keccak_hash_initialize(mdx) != SUCCESS) {
     rb_raise(eSHA3DigestError, "failed to initialize algorithm state");
+  }
 
-  if (!NIL_P(data))
+  if (!NIL_P(data)) {
     return c_digest_update(self, data);
+  }
 
   return self;
 }
 
 // SHA3::Digest.update(data) -> self
-static VALUE c_digest_update(VALUE self, VALUE data) 
+static VALUE c_digest_update(VALUE self, VALUE data)
 {
   MDX *mdx;
   DataLength dlen;
@@ -90,41 +117,39 @@ static VALUE c_digest_update(VALUE self, VALUE data)
 
   dlen = (RSTRING_LEN(data) * 8);
 
-  if (Update(mdx->state, RSTRING_PTR(data), dlen) != SUCCESS)
+  if (Keccak_HashUpdate(mdx->state, (BitSequence *) RSTRING_PTR(data), dlen) != SUCCESS) {
     rb_raise(eSHA3DigestError, "failed to update hash data");
+  }
 
   return self;
 }
 
 // SHA3::Digest.reset() -> self
-static VALUE c_digest_reset(VALUE self) 
+static VALUE c_digest_reset(VALUE self)
 {
   MDX *mdx;
 
   GETMDX(self, mdx);
 
-  memset(mdx->state, 0, sizeof(hashState));
+  memset(mdx->state, 0, sizeof(Keccak_HashInstance));
 
-  if (Init(mdx->state, mdx->hashbitlen) != SUCCESS)
+  if (c_keccak_hash_initialize(mdx) != SUCCESS) {
     rb_raise(eSHA3DigestError, "failed to reset internal state");
+  }
 
   return self;
 }
 
-// Fix: And, permanent reminder of a rookie mistake in c_digest_copy, comparing structs with ==/!= op
-// Fix: Woke-up after 2-hours of sleep, and for good reason. Fixed string comparison. Need to re-read K&R!
 static int cmp_states(MDX *mdx1, MDX *mdx2)
 {
     return (
       (mdx1->hashbitlen == mdx2->hashbitlen) &&
-      (strcmp((const char *) mdx1->state->state, (const char *)mdx2->state->state) == 0) &&
-      (strcmp((const char *) mdx1->state->dataQueue, (const char *) mdx2->state->dataQueue) == 0) &&
-      (mdx1->state->rate == mdx2->state->rate) &&
-      (mdx1->state->capacity == mdx2->state->capacity) &&
-      (mdx1->state->bitsInQueue == mdx2->state->bitsInQueue) &&
+      (strcmp((const char *) mdx1->state->sponge.state, (const char *)mdx2->state->sponge.state) == 0) &&
+      (mdx1->state->sponge.rate == mdx2->state->sponge.rate) &&
+      (mdx1->state->sponge.byteIOIndex == mdx2->state->sponge.byteIOIndex) &&
+      (mdx1->state->sponge.squeezing == mdx2->state->sponge.squeezing) &&
       (mdx1->state->fixedOutputLength == mdx2->state->fixedOutputLength) &&
-      (mdx1->state->squeezing == mdx2->state->squeezing) &&
-      (mdx1->state->bitsAvailableForSqueezing == mdx2->state->bitsAvailableForSqueezing)
+      (mdx1->state->delimitedSuffix == mdx2->state->delimitedSuffix)
     );
 }
 
@@ -134,20 +159,22 @@ static VALUE c_digest_copy(VALUE self, VALUE obj)
   MDX *mdx1, *mdx2;
 
   rb_check_frozen(self);
-  if (self == obj)
+  if (self == obj) {
     return self;
+  }
 
   GETMDX(self, mdx1);
   SAFEGETMDX(obj, mdx2);
 
-  memcpy(mdx1->state, mdx2->state, sizeof(hashState));
+  memcpy(mdx1->state, mdx2->state, sizeof(Keccak_HashInstance));
   mdx1->hashbitlen = mdx2->hashbitlen;
 
   // Fetch the data again to make sure it was copied
   GETMDX(self, mdx1);
   SAFEGETMDX(obj, mdx2);
-  if (!cmp_states(mdx1, mdx2))
+  if (!cmp_states(mdx1, mdx2)) {
     rb_raise(eSHA3DigestError, "failed to copy state");
+  }
 
   return self;
 }
@@ -162,7 +189,7 @@ static VALUE c_digest_length(VALUE self)
 }
 
 // SHA3::Digest.block_length -> Integer
-static VALUE c_digest_block_length(VALUE self) 
+static VALUE c_digest_block_length(VALUE self)
 {
   MDX *mdx;
   GETMDX(self, mdx);
@@ -171,13 +198,13 @@ static VALUE c_digest_block_length(VALUE self)
 }
 
 // SHA3::Digest.name -> String
-static VALUE c_digest_name(VALUE self) 
+static VALUE c_digest_name(VALUE self)
 {
   return rb_str_new2("SHA3");
 }
 
 // SHA3::Digest.finish() -> String
-static VALUE c_digest_finish(int argc, VALUE *argv, VALUE self) 
+static VALUE c_digest_finish(int argc, VALUE *argv, VALUE self)
 {
   MDX *mdx;
   VALUE str;
@@ -187,41 +214,14 @@ static VALUE c_digest_finish(int argc, VALUE *argv, VALUE self)
 
   if (NIL_P(str)) {
     str = rb_str_new(0, mdx->hashbitlen / 8);
-  } 
-  else {
+  } else {
     StringValue(str);
     rb_str_resize(str, mdx->hashbitlen / 8);
   }
 
-  if (Final(mdx->state, RSTRING_PTR(str)) != SUCCESS)
+  if (Keccak_HashFinal(mdx->state, (BitSequence *) RSTRING_PTR(str)) != SUCCESS) {
     rb_raise(eSHA3DigestError, "failed to finalize digest");
-
-  return str;
-}
-
-// SHA3::Digest.compute(type, data, [datalen]) -> String (bytes)
-// TO-DO: styled output (hex)
-static VALUE c_digest_compute(int argc, VALUE *argv, VALUE self)
-{
-  VALUE hlen, data, dlen, str;
-  int hashbitlen;
-  DataLength datalen;
-
-  rb_scan_args(argc, argv, "21", &hlen, &data, &dlen);
-
-  hashbitlen = get_hlen(hlen);
-
-  StringValue(data);
-  
-  if (!NIL_P(dlen))
-    datalen = NUM2ULL(dlen);
-  else
-    datalen = (RSTRING_LEN(data) * 8);
-
-  str = rb_str_new(0, hashbitlen / 8);
-
-  if (Hash(hashbitlen, RSTRING_PTR(data), datalen, RSTRING_PTR(str)) != SUCCESS)
-    rb_raise(eSHA3DigestError, "failed to generate hash");
+  }
 
   return str;
 }
@@ -232,7 +232,7 @@ void Init_sha3_n_digest()
 
   /* SHA3::Digest (class) */
   cSHA3Digest = rb_define_class_under(mSHA3, "Digest", rb_path2class("Digest::Class"));
-  /* SHA3::Digest::DigestError (class) */ 
+  /* SHA3::Digest::DigestError (class) */
   eSHA3DigestError = rb_define_class_under(cSHA3Digest, "DigestError", rb_eStandardError);
 
   // SHA3::Digest (class) methods
@@ -247,9 +247,6 @@ void Init_sha3_n_digest()
   rb_define_private_method(cSHA3Digest, "finish", c_digest_finish, -1);
 
   rb_define_alias(cSHA3Digest, "<<", "update");
-  
-  // SHA3 (module) functions (support bit operations)
-  rb_define_singleton_method(cSHA3Digest, "compute", c_digest_compute, -1);
 
   return;
-}
+}

data/ext/sha3/digest.h

@@ -27,7 +27,7 @@ extern VALUE cSHA3Digest;
 extern VALUE eSHA3DigestError;
 
 typedef struct {
-  hashState *state;
+  Keccak_HashInstance *state;
   int hashbitlen;
 } MDX;
 
@@ -37,4 +37,4 @@ void Init_sha3_n_digest(void);
 }
 #endif
 
-#endif
+#endif

data/ext/sha3/extconf.rb

@@ -1,24 +1,19 @@
 require 'mkmf'
 require 'rbconfig'
 
-FileUtils.rm "#{$srcdir}/KeccakF-1600-opt.c", :force => true
-
 target_cpu = RbConfig::CONFIG['target_cpu']
 
 if 1.size == 4 and target_cpu =~ /i386|x86_32/   # x86 32bit optimized code
-  Logging::message "=== Using i386 optimized Keccak code ===\n"
-  FileUtils.cp "#{$srcdir}/KeccakF-1600-opt32.c-arch", "#{$srcdir}/KeccakF-1600-opt.c"
+  Logging::message "=== Using reference  ===\n"
+  FileUtils.cp Dir["#{$srcdir}/Reference/*"].collect { |f| File.expand_path(f) }, "#{$srcdir}/"
 elsif 1.size == 8 and target_cpu =~ /i686|x86_64/
-  Logging::message "=== Using i686 optimized Keccak code ===\n"
-  FileUtils.cp "#{$srcdir}/KeccakF-1600-opt64.c-arch", "#{$srcdir}/KeccakF-1600-opt.c"
-else # Ha? Use reference code -- slow
-  Logging::message "=== Using reference Keccak code ===\n"
-  FileUtils.cp "#{$srcdir}/KeccakF-1600-reference.c-arch", "#{$srcdir}/KeccakF-1600-opt.c"
+  Logging::message "=== Using optimized (64-bit) ===\n"
+  FileUtils.cp Dir["#{$srcdir}/Optimized64/*"].collect { |f| File.expand_path(f) }, "#{$srcdir}/"
+else
+  Logging::message "=== Using reference ===\n"
+  FileUtils.cp Dir["#{$srcdir}/Reference/*"].collect { |f| File.expand_path(f) }, "#{$srcdir}/"
 end
 
-find_header("KeccakF-1600-interface.h")
-find_header("KeccakSponge.h")
-find_header("KeccakNISTInterface.h")
 find_header("sha3.h")
 find_header("digest.h")
 

data/ext/sha3/sha3.h

@@ -5,7 +5,7 @@
 
 #include <ruby.h>
 
-#include "KeccakNISTInterface.h"
+#include "KeccakHash.h"
 #include "digest.h"
 
 #ifdef  __cplusplus
@@ -22,4 +22,4 @@ void Init_sha3_n(void);
 }
 #endif
 
-#endif
+#endif

data/lib/sha3/doc.rb

@@ -2,10 +2,10 @@ require 'digest'
 
 module SHA3
   # A sub-class of (MRI Ruby based) Digest::Class, it implements SHA3 (Keccak) digest algorithm.
-  #  
+  #
   # @note SHA3::Digest class provides a four sub-classes for the available hash bit lengths (types).
   #   You can instantiate a new instance of Digest sub-class for a given type using the following sub-classes:
-  #   
+  #
   #     SHA3::Digest::SHA224([data])
   #     SHA3::Digest::SHA256([data])
   #     SHA3::Digest::SHA384([data])
@@ -14,18 +14,18 @@ module SHA3
   #   The [data] parameter is optional.
   class Digest < Digest::Class
     # Creates a Digest instance based on given hash bit length (type).
-    # 
-    # @param type [Number, Symbol] optional parameter used to set hash bit length (type). 
-    #   Valid options are: 
-    #   
+    #
+    # @param type [Number, Symbol] optional parameter used to set hash bit length (type).
+    #   Valid options are:
+    #
     #       Number: 224, 256, 384, or 512
     #     Symobols: :sha224, :sha256, :sha384, or :sha512
-    #   
+    #
     #   Default value: 256 (bits)
     # @param data [String] optional parameter used to update initial instance state.
-    #     # 
+    #     #
     # @return [Digest] self
-    # 
+    #
     # @example
     #   digest = SHA3::Digest.new      # => Defaults to 256 bits
     #   digest = SHA3::Digest.new(224) # => Initialize a new 224 bit digest instance
@@ -34,15 +34,15 @@ module SHA3
       # See function: c_digest_init(...) in ext/sha3/_digest.c
     end
 
-    # Updates, and recalculates Message Digest (state) with given data. If a message digest 
-    # is to be computed from several subsequent sources, then each may be passed individually 
+    # Updates, and recalculates Message Digest (state) with given data. If a message digest
+    # is to be computed from several subsequent sources, then each may be passed individually
     # to the Digest instance.
-    # 
+    #
     # @param data [String] data to compute
-    # 
+    #
     # @return [Digest] self
-    # 
-    # @example 
+    #
+    # @example
     #   digest = SHA3::Digest::SHA256.new
     #   digest.update('hash me')
     #   digest.update('me too')
@@ -61,9 +61,9 @@ module SHA3
     end
 
     # Returns message digest length in bytes.
-    # 
+    #
     # @return [Number] message length in bytes.
-    # 
+    #
     # @example
     #   digest = SHA3::Digest::SHA256.new
     #   digest.length # Result => 32 (or 256 bits)
@@ -72,9 +72,9 @@ module SHA3
     end
 
     # Returns digest block length in bytes.
-    # 
+    #
     # @return [Number] digest block length in bytes.
-    # 
+    #
     # @example
     #   digest = SHA3::Digest::SHA384.new
     #   digest.block_length # Result => 104
@@ -83,19 +83,19 @@ module SHA3
     end
 
     # Returns name of initialized digest
-    # 
+    #
     # @return [String] name
     def name
       # See function: c_digest_name(...) in ext/sha3/_digest.c
     end
 
     # Returns computed hash value for given hash type, and data in hex (string).
-    # 
+    #
     # @param type [Number, Symbol] See {#initialize} for valid type values.
     # @param data [String] data to compute hash value
-    # 
+    #
     # @return (String) computed hash as hex-encoded string
-    # 
+    #
     # @example
     #   SHA3::Digest.hexdigest(256, 'compute me, please')
     #   SHA3::Digest::SHA256.hexdigest('compute me, please') # => Alternate syntax
@@ -103,30 +103,17 @@ module SHA3
     end
 
     # Returns computed hash value for given hash type, and data in bytes.
-    # 
+    #
     # @param type [Number, Symbol] See {#initialize} for valid type values.
     # @param data [String] data to compute hash value
-    # 
+    #
     # @return [String] computed hash in bytes
-    # 
+    #
     # @example
     #   SHA3::Digest.digest(256, 'compute me, please')
     #   SHA3::Digest::SHA256.digest('compute me, please') # => Alternate syntax
     def self.digest(type, data)
     end
-
-    # Returns computed hash value of bit-length data.
-    # 
-    # @param type [Number, Symbol] See {#initialize} for valid type values.
-    # @param data [String] data to compute hash value
-    # @param data_length [Number] data bit length
-    # 
-    # @return [String] computed hash in bytes
-    # 
-    # @example
-    #   SHA3::Digest.compute(:sha384, '\0C', 2)
-    def self.compute(type, data, data_length)
-    end
   end
 
   class DigestError < StandardError