README.md

The Keccak (SHA3 candidate) digest for Ruby

This Ruby extension exposes the Keccak (SHA3 candidate) 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. See #16.

Installation

The gem is called keccak.

bundle add keccak
gem install keccak

gem 'keccak', '~> 1.3'

Usage

This gem extends the digest/* module by a digest/keccak class.

require 'digest/keccak'

# Generate 512-bit digest.
Digest::Keccak.digest("foo")       # => "\025\227\204*..."
Digest::Keccak.hexdigest("foo")    # => "1597842a..."

# Generate 224-bit digest.
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::Keccak.new
digest.update("f")
digest.update("o")
digest.update("o")
digest.digest       # => "\025\227\204*..."
digest.hexdigest    # => "1597842a..."

# You can pass a hash length to the constructor.
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.

Running the test suite

Run the test suite as follows:

bundle install
make test

A part of the test suite is automatically generated from Keccak's reference test suite.

Warning: Keccak vs. SHA3

⚠️ 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.

If you are looking for the final SHA3 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

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 SHA3, do not use for Ethereum)
• https://github.com/kotovalexarian/digest-keccak/ (KECCAK, as digest-keccak)