keccak 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aceb5b5671d06e3d0db69e7818d8cbf878a6519605beb75e13216bea26d7dce
-  data.tar.gz: 7bb0533a1e1f8f81a6b8ab21e555d0eb54fbd3c803a69a3f8a34bf90aa31bb90
+  metadata.gz: 4ee087f0bdede542d75edc668ec80da13eb7fa370f8b592b15a61ab8b476000b
+  data.tar.gz: b52445cd261c3f41f14162023b98a405a54b7a57623dbbaaefe88a7bc4909906
 SHA512:
-  metadata.gz: e3a55a66d4b3ee22cc992ab3b5b30e584dd5c1a9781f160384f66bd7c378d4c81015fc9d9c935a81dce7c76e1fd42209e04d7dc70aa326ef98263923211cc92b
-  data.tar.gz: e6cf1e8fbe26d116182b462f95dd9371bc9421331b4a8176dc0cd83489846396375c5d5df7dc138d1127edf5d377096899b209ca8a9930f18de831d28f9fd061
+  metadata.gz: df21f0f4067f4eec3b7a095a27b2890110b741dcd3d5236bbd446c17ac11956984e315b61a2e3a9cc40ffe2c531666b1d2caf63a39bd87435d7267113f9c194c
+  data.tar.gz: 113919c41f5a4bf475805849cffcbece79d07acb139cdc83e055c52826c88895614eea682ebe5d6a3d61a5364ba74d4c728e9f69632f8a3e2d299f841442f10b

data/COPYRIGHT

@@ -10,5 +10,8 @@ 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

data/README.md

@@ -1,25 +1,31 @@
 # The Keccak (SHA-3) digest for Ruby
 
-![GitHub Workflow Status](https://img.shields.io/github/workflow/status/q9f/keccak.rb/Build/main)
-![GitHub top language](https://img.shields.io/github/languages/top/q9f/keccak.rb)
-![GitHub release](https://img.shields.io/github/v/release/q9f/keccak.rb)
-![Gem](https://img.shields.io/gem/v/keccak)
+[![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)
+[![Gem](https://img.shields.io/gem/v/keccak?color=red)](https://rubygems.org/gems/keccak)
+[![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.
 
 ## Installation
 
+The gem is called `keccak`.
+
 ```bash
-gem install digest-keccak
+bundle add keccak
+gem install keccak
 ```
 
-**Note**: as of version `v1.1.0`, `digest-keccak` requires Ruby 2.2. `digest-keccak`version `v1.2.0` now also supports Ruby 3.0.
+```ruby
+gem 'keccak', '~> 1.2'
+```
 
-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.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).
 
 ## Usage
 
-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.
+This gem extends the `digest/*` module by a `digest/sha3` class (historic reference, see history section below).
 
 ```ruby
 require 'digest/sha3'
@@ -44,12 +50,14 @@ digest.hexdigest    # => "1597842a..."
 digest = Digest::SHA3.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.
+
 ## Running the test suite
 
 Run the test suite as follows:
 
 ```bash
-gem install test-unit
+bundle install
 make test
 ```
 
@@ -63,7 +71,6 @@ A part of the test suite is automatically generated from Keccak's reference test
 
 If you are looking for the final SHA-3 gem, please use the following: https://rubygems.org/gems/sha3
 
-
 ## History
 
 This gem was initially developed and published as `digest-sha3`: https://github.com/phusion/digest-sha3-ruby
@@ -73,3 +80,4 @@ 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/kotovalexarian/digest-keccak/ (KECCAK, as `digest-keccak`)

data/ext/digest/extconf.rb

@@ -1,7 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'mkmf'
 
-have_header('ruby/digest.h')
-have_func('rb_str_set_len')
+def cflags(*args)
+  args.each do |str|
+    $CFLAGS += " #{str.shellescape} "
+  end
+end
+
+def have_header!(*args)
+  exit 1 unless have_header(*args)
+end
+
+def have_func!(header, *args)
+  exit 1 unless have_func(*args, header)
+end
+
+cflags '-std=c11'
+cflags '-Wall'
+cflags '-Wextra'
+cflags '-fvisibility=hidden'
+
+have_header! 'ruby/digest.h'
+have_header! 'stdio.h'
+have_header! 'string.h'
+
+have_func! 'rb_str_set_len'
 
-$CFLAGS << " -fvisibility=hidden"
-create_makefile('digest/sha3')
+create_makefile 'digest/sha3' or exit 1

data/ext/digest/sha3.c

@@ -9,7 +9,7 @@
 #define MAX_DIGEST_SIZE 64
 #define DEFAULT_DIGEST_LEN 512
 
-static int sha3_init_func(hashState *ctx);
+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);
 
@@ -33,8 +33,8 @@ 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(hashState *ctx) {
-  // Just return a 1 ' successful' we override the init function
+sha3_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
   return 1;

data/keccak.gemspec

@@ -1,18 +1,30 @@
-require File.expand_path('lib/digest/sha3/version')
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name = "keccak"
-  s.version = Digest::SHA3::Version::STRING
-  s.summary = "The Keccak (SHA-3) hash used by Ethereum."
-  s.email = "ruby@q9f.cc"
-  s.homepage = "https://github.com/q9f/keccak.rb"
-  s.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."
-  s.authors = ["Afri Schoedon", "Chris Metcalfe", "Hongli Lai (Phusion)", "Keccak authors"]
-  s.extensions << "ext/digest/extconf.rb"
-  s.required_ruby_version = ">= 2.2"
-  s.license = "Apache-2.0"
+lib = File.expand_path('lib', __dir__).freeze
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include? lib
 
-  s.files = Dir[
+require 'digest/sha3/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.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]"
+  spec.extensions << "ext/digest/extconf.rb"
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = ">= 2.2", "< 4.0"
+  spec.license = "Apache-2.0"
+  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',
+  }.freeze
+  spec.require_paths = ['lib']
+  spec.files = Dir[
     "README.md",
     "COPYRIGHT",
     "LICENSE",
@@ -21,4 +33,7 @@ Gem::Specification.new do |s|
     "ext/**/*.{c,h,rb}",
     "lib/**/*"
   ]
+  spec.test_files = spec.files.grep %r{^(test|spec|features)/}
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'test-unit', '~> 3.4'
 end

data/lib/digest/sha3/version.rb

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

metadata

@@ -1,22 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: keccak
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Afri Schoedon
+- Alex Kotov
 - Chris Metcalfe
 - Hongli Lai (Phusion)
 - Keccak authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
-dependencies: []
+date: 2021-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 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.
-email: ruby@q9f.cc
+email: "%w[ruby@q9f.cc]"
 executables: []
 extensions:
 - ext/digest/extconf.rb
@@ -43,7 +72,10 @@ files:
 homepage: https://github.com/q9f/keccak.rb
 licenses:
 - Apache-2.0
-metadata: {}
+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
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -53,13 +85,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.2'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: The Keccak (SHA-3) hash used by Ethereum.