ext: rename sha3 to keccak for clarity (#16)

* ext: rename sha3 to keccak for clarity

* lib: minor version bump

* test: s/sha3/keccak/ on tests

* gem: update keccak gemspec

Author: q9f

ext/digest/extconf.rb

@@ -28,4 +28,4 @@ def have_func!(header, *args)
 
 have_func! 'rb_str_set_len'
 
-create_makefile 'digest/sha3' or exit 1
+create_makefile 'digest/keccak' or exit 1

ext/digest/sha3.c renamed to ext/digest/keccak.c

@@ -9,31 +9,31 @@
 #define MAX_DIGEST_SIZE 64
 #define DEFAULT_DIGEST_LEN 512
 
-static int sha3_init_func();
-static void sha3_update_func(hashState *ctx, unsigned char *str, size_t len);
-static int sha3_finish_func(hashState *ctx, unsigned char *digest);
+static int keccak_init_func();
+static void keccak_update_func(hashState *ctx, unsigned char *str, size_t len);
+static int keccak_finish_func(hashState *ctx, unsigned char *digest);
 
 /*
-  Metadata definition for the SHA3 algorithm.
+  Metadata definition for the Keccak algorithm.
   Defines the Version, sizes for block and digest as well as
   the entry points for the algorithms
 */
-static rb_digest_metadata_t sha3 = {
+static rb_digest_metadata_t keccak = {
 	RUBY_DIGEST_API_VERSION,
 	DEFAULT_DIGEST_LEN,
 	KeccakPermutationSize - (2 * DEFAULT_DIGEST_LEN), //size of blocks
 	sizeof(hashState), //size of context for the object we'll be passed in below functions.
-	(rb_digest_hash_init_func_t)sha3_init_func,
-	(rb_digest_hash_update_func_t)sha3_update_func,
-	(rb_digest_hash_finish_func_t)sha3_finish_func,
+	(rb_digest_hash_init_func_t)keccak_init_func,
+	(rb_digest_hash_update_func_t)keccak_update_func,
+	(rb_digest_hash_finish_func_t)keccak_finish_func,
 };
 
 /* Initialization function for the algorithm,
    gets called during allocation of the digest object.
    we override initialize to do custom hash size, so we don't care too much here.
 */
 static int
-sha3_init_func() {
+keccak_init_func() {
   // Just return a 1 'successful' we override the init function
   // so this is not necessary
   // the base class alloc calls this to initialize the algorithm
@@ -42,29 +42,29 @@ sha3_init_func() {
 
 /* Update function, take the current context and add str to it */
 static void
-sha3_update_func(hashState *ctx, unsigned char *str, size_t len) {
+keccak_update_func(hashState *ctx, unsigned char *str, size_t len) {
 	Update(ctx, str, len * 8);
 }
 
 /* Finish the hash calculation and return the finished string */
 static int
-sha3_finish_func(hashState *ctx, unsigned char *digest) {
+keccak_finish_func(hashState *ctx, unsigned char *digest) {
 	Final(ctx, digest);
 	return 1;
 }
 
-/* Ruby method.  Digest::SHA3#finish()
+/* Ruby method.  Digest::Keccak#finish()
  * No Arguments
  * @returns [String] Encoded Digest String
  */
 static VALUE
-rb_sha3_finish(VALUE self) {
+rb_keccak_finish(VALUE self) {
   hashState *ctx;
   VALUE digest;
 
   ctx = (hashState *)RTYPEDDATA_DATA(self);
   digest = rb_str_new(0, ctx->capacity / 2 / 8);
-  sha3_finish_func(ctx, (unsigned char *)RSTRING_PTR(digest));
+  keccak_finish_func(ctx, (unsigned char *)RSTRING_PTR(digest));
 
   return digest;
 }
@@ -73,7 +73,7 @@ rb_sha3_finish(VALUE self) {
  * initialize the ctx with the bitlength
  */
 static void
-sha3_init(hashState *ctx, size_t bitlen) {
+keccak_init(hashState *ctx, size_t bitlen) {
 	switch (Init(ctx, bitlen)) {
 	case SUCCESS:
 		return;
@@ -86,12 +86,12 @@ sha3_init(hashState *ctx, size_t bitlen) {
 	}
 }
 
-/* Ruby method.  Digest::SHA3.new(hashlen)
+/* Ruby method.  Digest::Keccak.new(hashlen)
  * @param hashlen The length of hash, only supports 224, 256, 384 or 512
- * @returns [Digest::SHA3] new object.
+ * @returns [Digest::Keccak] new object.
  */
 static VALUE
-rb_sha3_initialize(int argc, VALUE *argv, VALUE self) {
+rb_keccak_initialize(int argc, VALUE *argv, VALUE self) {
 	hashState *ctx;
 	VALUE hashlen;
 	int i_hashlen;
@@ -106,48 +106,48 @@ rb_sha3_initialize(int argc, VALUE *argv, VALUE self) {
   }
 
   ctx = (hashState *)RTYPEDDATA_DATA(self);
-	sha3_init(ctx, i_hashlen);
+	keccak_init(ctx, i_hashlen);
 
 	return rb_call_super(0, NULL);
 }
 
-/* Ruby method.  Digest::SHA3#digest_length
+/* Ruby method.  Digest::Keccak#digest_length
  * @returns [Numeric] Length of the digest.
  */
 static VALUE
-rb_sha3_digest_length(VALUE self) {
+rb_keccak_digest_length(VALUE self) {
 	hashState *ctx;
 
 	ctx = (hashState *)RTYPEDDATA_DATA(self);
 	return INT2FIX(ctx->capacity / 2 / 8);
 }
 
-/* Ruby method.  Digest::SHA3#block_length
+/* Ruby method.  Digest::Keccak#block_length
  * @returns [Numeric] Length of blocks in this digest.
  */
 static VALUE
-rb_sha3_block_length(VALUE self) {
+rb_keccak_block_length(VALUE self) {
 	hashState *ctx;
 
 	ctx = (hashState *)RTYPEDDATA_DATA(self);
 	return INT2FIX(ctx->rate / 8);
 }
 
 void __attribute__((visibility("default")))
-Init_sha3() {
-	VALUE mDigest, cDigest_Base, cSHA3;
+Init_keccak() {
+	VALUE mDigest, cDigest_Base, cKeccak;
 
 	rb_require("digest");
 
 	mDigest = rb_path2class("Digest");
 	cDigest_Base = rb_path2class("Digest::Base");
 
-	cSHA3 = rb_define_class_under(mDigest, "SHA3", cDigest_Base);
+	cKeccak = rb_define_class_under(mDigest, "Keccak", cDigest_Base);
 
-	rb_iv_set(cSHA3, "metadata", Data_Wrap_Struct(0, 0, 0, (void *)&sha3));
+	rb_iv_set(cKeccak, "metadata", Data_Wrap_Struct(0, 0, 0, (void *)&keccak));
 
-  rb_define_method(cSHA3, "initialize", rb_sha3_initialize, -1);
-  rb_define_method(cSHA3, "digest_length", rb_sha3_digest_length, 0);
-  rb_define_method(cSHA3, "block_length", rb_sha3_block_length, 0);
-  rb_define_method(cSHA3, "finish", rb_sha3_finish, 0);
+  rb_define_method(cKeccak, "initialize", rb_keccak_initialize, -1);
+  rb_define_method(cKeccak, "digest_length", rb_keccak_digest_length, 0);
+  rb_define_method(cKeccak, "block_length", rb_keccak_block_length, 0);
+  rb_define_method(cKeccak, "finish", rb_keccak_finish, 0);
 }

keccak.gemspec

@@ -3,13 +3,13 @@
 lib = File.expand_path('lib', __dir__).freeze
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
 
-require 'digest/sha3/version'
+require 'digest/keccak/version'
 
 Gem::Specification.new do |spec|
   spec.name = "keccak"
-  spec.version = Digest::SHA3::VERSION
-  spec.summary = "The Keccak (SHA-3) hash used by Ethereum."
-  spec.description = "The Keccak (SHA-3) hash used by Ethereum. This does not implement the final FIPS202 standard, today known as SHA3 but rather an early version, commonly referred to as Keccak."
+  spec.version = Digest::Keccak::VERSION
+  spec.summary = "The Keccak (SHA3) hash used by Ethereum."
+  spec.description = "The Keccak (SHA3) hash used by Ethereum. This does not implement the final FIPS202 standard, today known as SHA3 but rather an early version, commonly referred to as Keccak."
   spec.homepage = "https://github.com/q9f/keccak.rb"
   spec.authors = ["Afri Schoedon", "Alex Kotov", "Chris Metcalfe", "Hongli Lai (Phusion)", "Keccak authors"]
   spec.email = "%w[[email protected]]"

lib/digest/sha3/version.rb renamed to lib/digest/keccak/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Digest
-  class SHA3
-    VERSION = '1.2.2'
+  class Keccak
+    VERSION = '1.3.0'
   end
 end

test/generate_tests.rb

@@ -19,7 +19,7 @@ def generate
 
     require 'test/unit'
 
-    class SHA3Tests < Test::Unit::TestCase
+    class KeccakTests < Test::Unit::TestCase
   }
 
   FILES.each do |path, hashlen|
@@ -34,7 +34,7 @@ class SHA3Tests < Test::Unit::TestCase
           name = File.basename(path).split('.')[0]
           puts %Q{
             def test_#{name}_#{length}
-              inst = Digest::SHA3.new(#{hashlen})
+              inst = Digest::Keccak.new(#{hashlen})
               inst.update(#{msg_raw.inspect})
               assert_equal #{md.inspect}, inst.hexdigest
             end

test/test_all.rb

@@ -2,7 +2,7 @@
 
 $LOAD_PATH.unshift(File.expand_path("lib"))
 $LOAD_PATH.unshift(File.expand_path("ext"))
-require 'digest/sha3'
+require 'digest/keccak'
 require File.expand_path('test/test_usage')
 require File.expand_path('test/test_vectors')
 require File.expand_path('test/test_new')

test/test_new.rb

@@ -2,17 +2,17 @@
 
 require 'test/unit'
 
-class SHA3NewTests < Test::Unit::TestCase
+class KeccakNewTests < Test::Unit::TestCase
   def test_singleton_method_hexdigest_256_empty
-    result = Digest::SHA3.hexdigest '', 256
+    result = Digest::Keccak.hexdigest '', 256
     assert_instance_of String, result
     assert_equal 'c5d2460186f7233c927e7db2dcc703c0' \
                  'e500b653ca82273b7bfad8045d85a470',
                  result
   end
 
   def test_singleton_method_hexdigest_256_sample
-    result = Digest::SHA3.hexdigest 'sample', 256
+    result = Digest::Keccak.hexdigest 'sample', 256
     assert_instance_of String, result
     assert_equal 'b80204f7e9243e4fca5489740ccd31dc' \
                  'd0a54619a7f4165cee73c191ef7271a1',

test/test_usage.rb

@@ -2,9 +2,9 @@
 
 require 'test/unit'
 
-class SHA3UsageTest < Test::Unit::TestCase
+class KeccakUsageTest < Test::Unit::TestCase
   def init(hashsize = 512)
-    @digest = Digest::SHA3.new(hashsize)
+    @digest = Digest::Keccak.new(hashsize)
   end
 
   def test_copy
@@ -18,7 +18,7 @@ def test_copy
 
   def test_class_methods
     assert_equal 'a9cab59eb40a10b246290f2d6086e32e3689faf1d26b470c899f2802',
-      Digest::SHA3.hexdigest("\xcc", 224)
+      Digest::Keccak.hexdigest("\xcc", 224)
   end
 
   def test_update