The Keccak (draft version of SHA-3) cryptographic hash function
Find a file
2012-10-05 12:30:09 +02:00
ext/digest Use hidden visibility by default 2012-10-04 18:37:58 +02:00
lib/digest/sha3 Add gemspec 2012-10-04 18:46:08 +02:00
.gitignore Move into subdirectory and add Ruby extension file 2012-10-04 14:00:56 +02:00
digest-sha3.gemspec Add documentation and license 2012-10-05 12:30:09 +02:00
LICENSE Add documentation and license 2012-10-05 12:30:09 +02:00
README.md Add documentation and license 2012-10-05 12:30:09 +02:00

The SHA-3 (Keccak) extension for Ruby

This Ruby extension implements the SHA-3 (Keccak) cryptographic hashing algorithm. 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

gem install digest-sha3

Usage

Keccak supports 5 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.

require 'digest/sha3'

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

# Generate 224-bit digest.
Digest::SHA3.digest("foo", 224)       # => "\332\251M\247..."
Digest::SHA3.hexdigest("foo", 224)    # => "daa94da7..."

# Use this interface to feed data in chunks. 512-bit by default.
digest = Digest::SHA3.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::SHA3.new(224)