keccak 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ee087f0bdede542d75edc668ec80da13eb7fa370f8b592b15a61ab8b476000b
-  data.tar.gz: b52445cd261c3f41f14162023b98a405a54b7a57623dbbaaefe88a7bc4909906
+  metadata.gz: 10fb878fcf308cc1a44942ef197956f830f0d91cc6c258acb8f5913ef6d270ce
+  data.tar.gz: 359c30bf2d466a0d95d714ea82b4281812788e999607bafe917daf7a7b710919
 SHA512:
-  metadata.gz: df21f0f4067f4eec3b7a095a27b2890110b741dcd3d5236bbd446c17ac11956984e315b61a2e3a9cc40ffe2c531666b1d2caf63a39bd87435d7267113f9c194c
-  data.tar.gz: 113919c41f5a4bf475805849cffcbece79d07acb139cdc83e055c52826c88895614eea682ebe5d6a3d61a5364ba74d4c728e9f69632f8a3e2d299f841442f10b
+  metadata.gz: 95a226c317396f99e6fa1fdb15313dac072da683c5aa1345e7a609e7f283081adccf5e60bff0723e99a903a8564fb303c37a5ac9062eac26a14268394119cbd0
+  data.tar.gz: 5ea35b0f285d115dd8226920dacd21a0a51dcb02d6d08aff16985a9a567c85ee397183678bbc26097b36f3242b0d1745c5d081bebbaa4a76efbe9ee0dc4574a4

data/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2019 @q9f
+   Copyright [yyyy] [name of copyright owner]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,12 +1,16 @@
-# The Keccak (SHA-3) digest for Ruby
+# The Keccak (SHA3) digest for Ruby
 
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/q9f/keccak.rb/Build/main)](https://github.com/q9f/keccak.rb/actions)
 [![GitHub top language](https://img.shields.io/github/languages/top/q9f/keccak.rb?color=black)](https://github.com/q9f/keccak.rb/pulse)
-[![GitHub release](https://img.shields.io/github/v/release/q9f/keccak.rb?color=red)](https://github.com/q9f/keccak.rb/releases/latest)
+[![GitHub release](https://img.shields.io/github/v/release/q9f/keccak.rb)](https://github.com/q9f/keccak.rb/releases/latest)
 [![Gem](https://img.shields.io/gem/v/keccak?color=red)](https://rubygems.org/gems/keccak)
+[![Gem](https://img.shields.io/gem/dt/keccak)](https://rubygems.org/gems/keccak)
+[![Visitors](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fq9f%2Fkeccak.rb&count_bg=%2379C83D&title_bg=%23555555&icon=rubygems.svg&icon_color=%23FF0000&title=visitors&edge_flat=false)](https://hits.seeyoufarm.com)
 [![License](https://img.shields.io/github/license/q9f/keccak.rb.svg?color=black)](LICENSE)
 
-This Ruby extension exposes the [Keccak](http://keccak.noekeon.org/) (SHA-3) digest C bindings in the non-final version used by Ethereum. It is based on the reference `C` implementation, version 3.2. The exposed interface is almost identical to that of the `digest` standard library.
+This Ruby extension exposes the [Keccak](http://keccak.noekeon.org/) (SHA3) digest `C` bindings in the non-final version used by [Ethereum](https://ethereum.org). It is based on the reference `C` implementation, version 3.2. The exposed interface is almost identical to that of the `digest` standard library. See [#16](https://github.com/q9f/keccak.rb/pull/16).
+
+:warning: **Note: version `~> 1.3` exposes `digest/keccak` (`Digest::Keccak`) whereas version `~> 1.2` maintains the old `digest/sha3` (`Digest::SHA3`) for backward compatibility.** Only use `~> 1.2` if you want to lazy-patch your library. It works, but it's _not recommended._ Use `~> 1.3` and simply rename SHA3 to Keccak.
 
 ## Installation
 
@@ -18,28 +22,28 @@ gem install keccak
 ```
 
 ```ruby
-gem 'keccak', '~> 1.2'
+gem 'keccak', '~> 1.3'
 ```
 
-**Note**: as of version `v1.1.0`, `digest-sha3` (historic name) requires Ruby 2.2. The new `keccak` version `v1.2.0` now also supports Ruby 3.0. The last version that worked on older Ruby (1.x) versions was `v1.0.2`. It can be found at the no longer maintained [`digest-sha3` repository from 2015](https://github.com/phusion/digest-sha3-ruby/releases/tag/release-1.0.2).
+**Note**: as of version `~> v1.1`, `digest-sha3` (historic name, see below) requires Ruby 2.2. The new `keccak` version `~> v1.2` now also supports Ruby 3.0. The last version that worked on older Ruby (1.x) versions was `~> v1.0`. It can be found at the no longer maintained `digest-sha3` [repository from 2015](https://github.com/phusion/digest-sha3-ruby/releases/tag/release-1.0.2).
 
 ## Usage
 
-This gem extends the `digest/*` module by a `digest/sha3` class (historic reference, see history section below).
+This gem extends the `digest/*` module by a `digest/keccak` class.
 
 ```ruby
-require 'digest/sha3'
+require 'digest/keccak'
 
 # Generate 512-bit digest.
-Digest::SHA3.digest("foo")       # => "\025\227\204*..."
-Digest::SHA3.hexdigest("foo")    # => "1597842a..."
+Digest::Keccak.digest("foo")       # => "\025\227\204*..."
+Digest::Keccak.hexdigest("foo")    # => "1597842a..."
 
 # Generate 224-bit digest.
-Digest::SHA3.digest("foo", 224)       # => "\332\251M\247..."
-Digest::SHA3.hexdigest("foo", 224)    # => "daa94da7..."
+Digest::Keccak.digest("foo", 224)       # => "\332\251M\247..."
+Digest::Keccak.hexdigest("foo", 224)    # => "daa94da7..."
 
 # Use this interface to feed data in chunks. 512-bit by default.
-digest = Digest::SHA3.new
+digest = Digest::Keccak.new
 digest.update("f")
 digest.update("o")
 digest.update("o")
@@ -47,7 +51,7 @@ digest.digest       # => "\025\227\204*..."
 digest.hexdigest    # => "1597842a..."
 
 # You can pass a hash length to the constructor.
-digest = Digest::SHA3.new(224)
+digest = Digest::Keccak.new(224)
 ```
 
 Keccak supports five hash lengths: 224-bit, 256-bit, 384-bit, 512-bit and variable length. Variable length is not supported by this Ruby extension. Unless the user specifies otherwise, this Ruby extension assumes 512-bit.
@@ -63,13 +67,13 @@ make test
 
 A part of the test suite is automatically generated from Keccak's reference test suite.
 
-## Warning: Keccak vs. SHA-3
+## Warning: Keccak vs. SHA3
 
-**Note:** This gem still uses the `Digest::SHA3` namespace for reasons of backwards compatibility and long-term maintainability. See history section below.
+**Note:** This gem still uses the `Digest::SHA3` namespace in version `~> 1.2` for reasons of backward compatibility and long-term maintainability. See history section below.
 
-:warning: This gem does **not** implement the final FIPS202 standard, today known as SHA-3 but rather an early version, commonly referred to as Keccak. The reason why this is kept around, is that Ethereum uses this earler version of Keccak. See also: [Ethereum: Difference between keccak256 and sha3](https://ethereum.stackexchange.com/questions/30369/difference-between-keccak256-and-sha3)
+:warning: This gem does **not** implement the final FIPS202 standard, today known as SHA3 but rather an early version, commonly referred to as Keccak. The reason why this is kept around, is that Ethereum uses this earler version of Keccak. See also: [Ethereum: Difference between keccak256 and sha3](https://ethereum.stackexchange.com/questions/30369/difference-between-keccak256-and-sha3).
 
-If you are looking for the final SHA-3 gem, please use the following: https://rubygems.org/gems/sha3
+If you are looking for the final SHA3 gem, please use the following: https://rubygems.org/gems/sha3
 
 ## History
 
@@ -79,5 +83,5 @@ This gem was later patched multiple times:
 
 * https://github.com/teamhedge/digest-sha3-ruby (KECCAK, as `digest-sha3-patched`)
 * https://github.com/sydneyitguy/digest-sha3-ruby (KECCAK, as `digest-sha3-patched-ruby-3`)
-* https://github.com/steakknife/digest-sha3-ruby (actual SHA-3, do not use for Ethereum)
+* https://github.com/steakknife/digest-sha3-ruby (actual SHA3, do not use for Ethereum)
 * https://github.com/kotovalexarian/digest-keccak/ (KECCAK, as `digest-keccak`)

data/ext/digest/extconf.rb

@@ -5,7 +5,7 @@ require 'mkmf'
 
 def cflags(*args)
   args.each do |str|
-    $CFLAGS += " #{str.shellescape} "
+    $CFLAGS += (ENV['OS'] == "Windows_NT") ? " #{str} " : " #{str.shellescape} "
   end
 end
 
@@ -28,4 +28,4 @@ have_header! 'string.h'
 
 have_func! 'rb_str_set_len'
 
-create_makefile 'digest/sha3' or exit 1
+create_makefile 'digest/keccak' or exit 1

data/ext/digest/{sha3.c → keccak.c}

@@ -9,23 +9,23 @@
 #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,
@@ -33,7 +33,7 @@ static rb_digest_metadata_t sha3 = {
    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,27 +106,27 @@ 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);
@@ -134,20 +134,20 @@ rb_sha3_block_length(VALUE self) {
 }
 
 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);
 }

data/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 use 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[ruby@q9f.cc]"
@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'homepage_uri'    => 'https://github.com/q9f/keccak.rb',
     'source_code_uri' => 'https://github.com/q9f/keccak.rb',
-    'bug_tracker_uri' =>
-      'https://github.com/q9f/keccak.rb/issues',
+    'github_repo'     => 'https://github.com/q9f/keccak.rb',
+    'bug_tracker_uri' => 'https://github.com/q9f/keccak.rb/issues',
   }.freeze
   spec.require_paths = ['lib']
   spec.files = Dir[

data/lib/digest/{sha3 → keccak}/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Digest
-  class SHA3
-    VERSION = '1.2.1'
+  class Keccak
+    VERSION = "1.3.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keccak
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Afri Schoedon
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-02 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,7 +42,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-description: The Keccak (SHA-3) hash use by Ethereum. This does not implement the
+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.
 email: "%w[ruby@q9f.cc]"
@@ -51,7 +51,6 @@ extensions:
 - ext/digest/extconf.rb
 extra_rdoc_files: []
 files:
-- COPYRIGHT
 - LICENSE
 - Makefile
 - README.md
@@ -66,15 +65,16 @@ files:
 - ext/digest/displayIntermediateValues.c
 - ext/digest/displayIntermediateValues.h
 - ext/digest/extconf.rb
-- ext/digest/sha3.c
+- ext/digest/keccak.c
 - keccak.gemspec
-- lib/digest/sha3/version.rb
+- lib/digest/keccak/version.rb
 homepage: https://github.com/q9f/keccak.rb
 licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/q9f/keccak.rb
   source_code_uri: https://github.com/q9f/keccak.rb
+  github_repo: https://github.com/q9f/keccak.rb
   bug_tracker_uri: https://github.com/q9f/keccak.rb/issues
 post_install_message:
 rdoc_options: []
@@ -94,8 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: The Keccak (SHA-3) hash used by Ethereum.
+summary: The Keccak (SHA3) hash used by Ethereum.
 test_files: []

data/COPYRIGHT

@@ -1,17 +0,0 @@
-This package contains code written by the Keccak authors,
-which is licensed CC0 (Public Domain).
-
-Copyright (c) 2012-2015 Phusion B.V.; licensed under MIT License
-https://github.com/phusion/digest-sha3-ruby
-
-Copyright (c) 2016-2018 Chris Metcalfe; licensed under MIT License
-https://github.com/teamhedge/digest-sha3-ruby
-
-Copyright (c) 2018-2021 Seb's; licensed under MIT License
-https://github.com/sydneyitguy/digest-sha3-ruby
-
-Copyright (c) 2019-2021 Alex Kotov; licensed under MIT License
-https://github.com/kotovalexarian/digest-keccak
-
-Copyright (c) 2021-2022 Afri Schoedon; re-licensed under Apache 2.0
-https://github.com/q9f/digest-sha3-ruby