sha3 1.0.4 → 2.0.0

data/ext/sha3/SnP-Relaned.h

@@ -1,249 +0,0 @@
-/*
-Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni,
-Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer, hereby
-denoted as "the implementer".
-
-For more information, feedback or questions, please refer to our websites:
-http://keccak.noekeon.org/
-http://keyak.noekeon.org/
-http://ketje.noekeon.org/
-
-To the extent possible under law, the implementer has waived all copyright
-and related or neighboring rights to the source code in this file.
-http://creativecommons.org/publicdomain/zero/1.0/
-*/
-
-#ifndef _SnP_Relaned_h_
-#define _SnP_Relaned_h_
-
-/** Function to XOR data given as bytes into the state.
-  * The bits to modify are restricted to be consecutive and to be in the same lane.
-  * The bit positions that are affected by this function are
-  * from @a lanePosition*(lane size in bits) + @a offset*8
-  * to @a lanePosition*(lane size in bits) + @a offset*8 + @a length*8.
-  * (The bit positions, the x,y,z coordinates and their link are defined in the "Keccak reference".)
-  * @param  state   Pointer to the state.
-  * @param  lanePosition    Index of the lane to be modified (x+5*y,
-  *                         or bit position divided by the lane size).
-  * @param  data    Pointer to the input data.
-  * @param  offset  Offset in bytes within the lane.
-  * @param  length  Number of bytes.
-  * @pre    0 ≤ @a lanePosition < 25
-  * @pre    0 ≤ @a offset < (lane size in bytes)
-  * @pre    0 ≤ @a offset + @a length ≤ (lane size in bytes)
-  */
-void SnP_XORBytesInLane(void *state, unsigned int lanePosition, const unsigned char *data, unsigned int offset, unsigned int length);
-
-/** Function to XOR data given as bytes into the state.
-  * The bits to modify are restricted to start from the bit position 0 and
-  * to span a whole number of lanes.
-  * @param  state   Pointer to the state.
-  * @param  data    Pointer to the input data.
-  * @param  laneCount   The number of lanes, i.e., the length of the data
-  *                     divided by the lane size.
-  * @pre    0 ≤ @a laneCount ≤ 25
-  */
-void SnP_XORLanes(void *state, const unsigned char *data, unsigned int laneCount);
-
-/** Function to overwrite data given as bytes into the state.
-  * The bits to modify are restricted to be consecutive and to be in the same lane.
-  * The bit positions that are affected by this function are
-  * from @a lanePosition*(lane size in bits) + @a offset*8
-  * to @a lanePosition*(lane size in bits) + @a offset*8 + @a length*8.
-  * (The bit positions, the x,y,z coordinates and their link are defined in the "Keccak reference".)
-  * @param  state   Pointer to the state.
-  * @param  lanePosition    Index of the lane to be modified (x+5*y,
-  *                         or bit position divided by the lane size).
-  * @param  data    Pointer to the input data.
-  * @param  offset  Offset in bytes within the lane.
-  * @param  length  Number of bytes.
-  * @pre    0 ≤ @a lanePosition < 25
-  * @pre    0 ≤ @a offset < (lane size in bytes)
-  * @pre    0 ≤ @a offset + @a length ≤ (lane size in bytes)
-  */
-void SnP_OverwriteBytesInLane(void *state, unsigned int lanePosition, const unsigned char *data, unsigned int offset, unsigned int length);
-
-/** Function to overwrite data given as bytes into the state.
-  * The bits to modify are restricted to start from the bit position 0 and
-  * to span a whole number of lanes.
-  * @param  state   Pointer to the state.
-  * @param  data    Pointer to the input data.
-  * @param  laneCount   The number of lanes, i.e., the length of the data
-  *                     divided by the lane size.
-  * @pre    0 ≤ @a laneCount ≤ 25
-  */
-void SnP_OverwriteLanes(void *state, const unsigned char *data, unsigned int laneCount);
-
-/** Function to retrieve data from the state into bytes.
-  * The bits to output are restricted to be consecutive and to be in the same lane.
-  * The bit positions that are retrieved by this function are
-  * from @a lanePosition*(lane size in bits) + @a offset*8
-  * to @a lanePosition*(lane size in bits) + @a offset*8 + @a length*8.
-  * (The bit positions, the x,y,z coordinates and their link are defined in the "Keccak reference".)
-  * @param  state   Pointer to the state.
-  * @param  lanePosition    Index of the lane to be read (x+5*y,
-  *                         or bit position divided by the lane size).
-  * @param  data    Pointer to the area where to store output data.
-  * @param  offset  Offset in byte within the lane.
-  * @param  length  Number of bytes.
-  * @pre    0 ≤ @a lanePosition < 25
-  * @pre    0 ≤ @a offset < (lane size in bytes)
-  * @pre    0 ≤ @a offset + @a length ≤ (lane size in bytes)
-  */
-void SnP_ExtractBytesInLane(const void *state, unsigned int lanePosition, unsigned char *data, unsigned int offset, unsigned int length);
-
-/** Function to retrieve data from the state into bytes.
-  * The bits to output are restricted to start from the bit position 0 and
-  * to span a whole number of lanes.
-  * @param  state   Pointer to the state.
-  * @param  data    Pointer to the area where to store output data.
-  * @param  laneCount   The number of lanes, i.e., the length of the data
-  *                     divided by the lane size.
-  * @pre    0 ≤ @a laneCount ≤ 25
-  */
-void SnP_ExtractLanes(const void *state, unsigned char *data, unsigned int laneCount);
-
-/** Function to retrieve data from the state into bytes and
-  * to XOR them into the output buffer.
-  * The bits to output are restricted to be consecutive and to be in the same lane.
-  * The bit positions that are retrieved by this function are
-  * from @a lanePosition*(lane size in bits) + @a offset*8
-  * to @a lanePosition*(lane size in bits) + @a offset*8 + @a length*8.
-  * (The bit positions, the x,y,z coordinates and their link are defined in the "Keccak reference".)
-  * @param  state   Pointer to the state.
-  * @param  lanePosition    Index of the lane to be read (x+5*y,
-  *                         or bit position divided by the lane size).
-  * @param  data    Pointer to the area where to XOR output data.
-  * @param  offset  Offset in byte within the lane.
-  * @param  length  Number of bytes.
-  * @pre    0 ≤ @a lanePosition < 25
-  * @pre    0 ≤ @a offset < (lane size in bytes)
-  * @pre    0 ≤ @a offset + @a length ≤ (lane size in bytes)
-  */
-void SnP_ExtractAndXORBytesInLane(const void *state, unsigned int lanePosition, unsigned char *data, unsigned int offset, unsigned int length);
-
-/** Function to retrieve data from the state into bytes and
-  * to XOR them into the output buffer.
-  * The bits to output are restricted to start from the bit position 0 and
-  * to span a whole number of lanes.
-  * @param  state   Pointer to the state.
-  * @param  data    Pointer to the area where to XOR output data.
-  * @param  laneCount   The number of lanes, i.e., the length of the data
-  *                     divided by the lane size.
-  * @pre    0 ≤ @a laneCount ≤ 25
-  */
-void SnP_ExtractAndXORLanes(const void *state, unsigned char *data, unsigned int laneCount);
-
-#define SnP_XORBytes(state, data, offset, length) \
-    { \
-        if ((offset) == 0) { \
-            SnP_XORLanes(state, data, (length)/SnP_laneLengthInBytes); \
-            SnP_XORBytesInLane(state, \
-                (length)/SnP_laneLengthInBytes, \
-                (data)+((length)/SnP_laneLengthInBytes)*SnP_laneLengthInBytes, \
-                0, \
-                (length)%SnP_laneLengthInBytes); \
-        } \
-        else { \
-            unsigned int _sizeLeft = (length); \
-            unsigned int _lanePosition = (offset)/SnP_laneLengthInBytes; \
-            unsigned int _offsetInLane = (offset)%SnP_laneLengthInBytes; \
-            const unsigned char *_curData = (data); \
-            while(_sizeLeft > 0) { \
-                unsigned int _bytesInLane = SnP_laneLengthInBytes - _offsetInLane; \
-                if (_bytesInLane > _sizeLeft) \
-                    _bytesInLane = _sizeLeft; \
-                SnP_XORBytesInLane(state, _lanePosition, _curData, _offsetInLane, _bytesInLane); \
-                _sizeLeft -= _bytesInLane; \
-                _lanePosition++; \
-                _offsetInLane = 0; \
-                _curData += _bytesInLane; \
-            } \
-        } \
-    }
-
-#define SnP_OverwriteBytes(state, data, offset, length) \
-    { \
-        if ((offset) == 0) { \
-            SnP_OverwriteLanes(state, data, (length)/SnP_laneLengthInBytes); \
-            SnP_OverwriteBytesInLane(state, \
-                (length)/SnP_laneLengthInBytes, \
-                (data)+((length)/SnP_laneLengthInBytes)*SnP_laneLengthInBytes, \
-                0, \
-                (length)%SnP_laneLengthInBytes); \
-        } \
-        else { \
-            unsigned int _sizeLeft = (length); \
-            unsigned int _lanePosition = (offset)/SnP_laneLengthInBytes; \
-            unsigned int _offsetInLane = (offset)%SnP_laneLengthInBytes; \
-            const unsigned char *_curData = (data); \
-            while(_sizeLeft > 0) { \
-                unsigned int _bytesInLane = SnP_laneLengthInBytes - _offsetInLane; \
-                if (_bytesInLane > _sizeLeft) \
-                    _bytesInLane = _sizeLeft; \
-                SnP_OverwriteBytesInLane(state, _lanePosition, _curData, _offsetInLane, _bytesInLane); \
-                _sizeLeft -= _bytesInLane; \
-                _lanePosition++; \
-                _offsetInLane = 0; \
-                _curData += _bytesInLane; \
-            } \
-        } \
-    }
-
-#define SnP_ExtractBytes(state, data, offset, length) \
-    { \
-        if ((offset) == 0) { \
-            SnP_ExtractLanes(state, data, (length)/SnP_laneLengthInBytes); \
-            SnP_ExtractBytesInLane(state, \
-                (length)/SnP_laneLengthInBytes, \
-                (data)+((length)/SnP_laneLengthInBytes)*SnP_laneLengthInBytes, \
-                0, \
-                (length)%SnP_laneLengthInBytes); \
-        } \
-        else { \
-            unsigned int _sizeLeft = (length); \
-            unsigned int _lanePosition = (offset)/SnP_laneLengthInBytes; \
-            unsigned int _offsetInLane = (offset)%SnP_laneLengthInBytes; \
-            unsigned char *_curData = (data); \
-            while(_sizeLeft > 0) { \
-                unsigned int _bytesInLane = SnP_laneLengthInBytes - _offsetInLane; \
-                if (_bytesInLane > _sizeLeft) \
-                    _bytesInLane = _sizeLeft; \
-                SnP_ExtractBytesInLane(state, _lanePosition, _curData, _offsetInLane, _bytesInLane); \
-                _sizeLeft -= _bytesInLane; \
-                _lanePosition++; \
-                _offsetInLane = 0; \
-                _curData += _bytesInLane; \
-            } \
-        } \
-    }
-
-#define SnP_ExtractAndXORBytes(state, data, offset, length) \
-    { \
-        if ((offset) == 0) { \
-            SnP_ExtractAndXORLanes(state, data, (length)/SnP_laneLengthInBytes); \
-            SnP_ExtractAndXORBytesInLane(state, \
-                (length)/SnP_laneLengthInBytes, \
-                (data)+((length)/SnP_laneLengthInBytes)*SnP_laneLengthInBytes, \
-                0, \
-                (length)%SnP_laneLengthInBytes); \
-        } \
-        else { \
-            unsigned int _sizeLeft = (length); \
-            unsigned int _lanePosition = (offset)/SnP_laneLengthInBytes; \
-            unsigned int _offsetInLane = (offset)%SnP_laneLengthInBytes; \
-            unsigned char *_curData = (data); \
-            while(_sizeLeft > 0) { \
-                unsigned int _bytesInLane = SnP_laneLengthInBytes - _offsetInLane; \
-                if (_bytesInLane > _sizeLeft) \
-                    _bytesInLane = _sizeLeft; \
-                SnP_ExtractAndXORBytesInLane(state, _lanePosition, _curData, _offsetInLane, _bytesInLane); \
-                _sizeLeft -= _bytesInLane; \
-                _lanePosition++; \
-                _offsetInLane = 0; \
-                _curData += _bytesInLane; \
-            } \
-        } \
-    }
-
-#endif

data/ext/sha3/sha3.c

@@ -1,62 +0,0 @@
-/* Copyright (c) 2012 - 2013 Johanns Gregorian <io+sha3@jsani.com> */
-
-#include "sha3.h"
-
-VALUE mSHA3;
-VALUE eSHA3Error;
-
-int get_hlen(VALUE obj)
-{
-    int hlen;
-
-    if (TYPE(obj) == T_SYMBOL)
-    {
-        ID symid;
-
-        symid = SYM2ID(obj);
-
-        if (rb_intern("sha224") == symid)
-        {
-            hlen = 224;
-        }
-        else if (rb_intern("sha256") == symid)
-        {
-            hlen = 256;
-        }
-        else if (rb_intern("sha384") == symid)
-        {
-            hlen = 384;
-        }
-        else if (rb_intern("sha512") == symid)
-        {
-            hlen = 512;
-        }
-        else
-        {
-            rb_raise(eSHA3Error, "invalid hash bit symbol (should be: :sha224, :sha256, :sha384, or :sha512");
-        }
-    }
-    else if (TYPE(obj) == T_FIXNUM)
-    {
-        hlen = NUM2INT(obj);
-
-        if ((hlen != 224) && (hlen != 256) && (hlen != 384) && (hlen != 512))
-        {
-            rb_raise(rb_eArgError, "invalid hash bit length (should be: 224, 256, 384, or 512)");
-        }
-    }
-    else
-    {
-        rb_raise(eSHA3Error, "unknown type value");
-    }
-
-    return hlen;
-}
-
-void Init_sha3_n()
-{
-    mSHA3 = rb_define_module("SHA3");
-    eSHA3Error = rb_define_class_under(mSHA3, "SHA3Error", rb_eStandardError);
-
-    Init_sha3_n_digest();
-}

data/ext/sha3/sha3.h

@@ -1,26 +0,0 @@
-/* Copyright (c) 2012 - 2013 Johanns Gregorian <io+sha3@jsani.com> */
-
-#ifndef _SHA3_H_
-#define _SHA3_H_
-
-#include <ruby.h>
-
-#include "KeccakHash.h"
-#include "digest.h"
-
-#ifdef __cplusplus
-extern "C"
-{
-#endif
-
-    extern VALUE mSHA3;
-    extern VALUE eSHA3Error;
-
-    int get_hlen(VALUE);
-    void Init_sha3_n(void);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif

data/lib/sha3/doc.rb

@@ -1,121 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest'
-
-module SHA3
-  # A sub-class of (MRI Ruby based) Digest::Class, it implements SHA3 (Keccak) digest algorithm.
-  #
-  # @note SHA3::Digest class provides a four sub-classes for the available hash bit lengths (types).
-  #   You can instantiate a new instance of Digest sub-class for a given type using the following sub-classes:
-  #
-  #     SHA3::Digest::SHA224([data])
-  #     SHA3::Digest::SHA256([data])
-  #     SHA3::Digest::SHA384([data])
-  #     SHA3::Digest::SHA512([data])
-  #
-  #   The [data] parameter is optional.
-  class Digest < Digest::Class
-    # Creates a Digest instance based on given hash bit length (type).
-    #
-    # @param type [Number, Symbol] optional parameter used to set hash bit length (type).
-    #   Valid options are:
-    #
-    #       Number: 224, 256, 384, or 512
-    #     Symobols: :sha224, :sha256, :sha384, or :sha512
-    #
-    #   Default value: 256 (bits)
-    # @param data [String] optional parameter used to update initial instance state.
-    #     #
-    # @return [Digest] self
-    #
-    # @example
-    #   digest = SHA3::Digest.new      # => Defaults to 256 bits
-    #   digest = SHA3::Digest.new(224) # => Initialize a new 224 bit digest instance
-    #   digest = SHA3::Digest::SHA224  # => An alternate method for creating a digest class with 224 bit hash bit length
-    def initialize(type, data)
-      # See function: c_digest_init(...) in ext/sha3/_digest.c
-    end
-
-    # Updates, and recalculates Message Digest (state) with given data. If a message digest
-    # is to be computed from several subsequent sources, then each may be passed individually
-    # to the Digest instance.
-    #
-    # @param data [String] data to compute
-    #
-    # @return [Digest] self
-    #
-    # @example
-    #   digest = SHA3::Digest::SHA256.new
-    #   digest.update('hash me')
-    #   digest.update('me too')
-    def update(data)
-      # See function: c_digest_update(...) in ext/sha3/_digest.c
-    end
-
-    # Alias for update method
-    alias << :update
-
-    # Resets the Digest object to initial state, abandoning computed data.
-    #
-    # @return [Digest] self
-    def reset
-      # See function: c_digest_reset(...) in ext/sha3/_digest.c
-    end
-
-    # Returns message digest length in bytes.
-    #
-    # @return [Number] message length in bytes.
-    #
-    # @example
-    #   digest = SHA3::Digest::SHA256.new
-    #   digest.length # Result => 32 (or 256 bits)
-    def length
-      # See function: c_digest_length(...) in ext/sha3/_digest.c
-    end
-
-    # Returns digest block length in bytes.
-    #
-    # @return [Number] digest block length in bytes.
-    #
-    # @example
-    #   digest = SHA3::Digest::SHA384.new
-    #   digest.block_length # Result => 104
-    def block_length
-      # See function: c_digest_block_length(...) in ext/sha3/_digest.c
-    end
-
-    # Returns name of initialized digest
-    #
-    # @return [String] name
-    def name
-      # See function: c_digest_name(...) in ext/sha3/_digest.c
-    end
-
-    # Returns computed hash value for given hash type, and data in hex (string).
-    #
-    # @param type [Number, Symbol] See {#initialize} for valid type values.
-    # @param data [String] data to compute hash value
-    #
-    # @return (String) computed hash as hex-encoded string
-    #
-    # @example
-    #   SHA3::Digest.hexdigest(256, 'compute me, please')
-    #   SHA3::Digest::SHA256.hexdigest('compute me, please') # => Alternate syntax
-    def self.hexdigest(type, data); end
-
-    # Returns computed hash value for given hash type, and data in bytes.
-    #
-    # @param type [Number, Symbol] See {#initialize} for valid type values.
-    # @param data [String] data to compute hash value
-    #
-    # @return [String] computed hash in bytes
-    #
-    # @example
-    #   SHA3::Digest.digest(256, 'compute me, please')
-    #   SHA3::Digest::SHA256.digest('compute me, please') # => Alternate syntax
-    def self.digest(type, data); end
-  end
-
-  class DigestError < StandardError
-  end
-end

data/lib/sha3/version.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module SHA3
-  # sha3 release version
-  VERSION = '1.0.4'
-
-  # keccak version number
-  KECCAK_VERSION = '4.0'
-end

data/sha3.gemspec

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/sha3/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'sha3'
-  spec.version = SHA3::VERSION
-
-  spec.authors = ['Johanns Gregorian']
-  spec.email = ['io+sha3@jsg.io']
-
-  spec.description = 'SHA3 for Ruby is a native (C) FIPS 202 compliant implementation of SHA3 (Keccak) cryptographic hashing algorithm.'
-  spec.summary = 'SHA3 (FIPS 202) cryptographic hashing algorithm'
-
-  spec.homepage = 'https://github.com/johanns/sha3'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
-
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.extensions = ['ext/sha3/extconf.rb']
-  spec.require_paths = ['lib']
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-  spec.metadata['rubygems_mfa_required'] = 'true'
-
-  spec.add_development_dependency('bundler', '~> 2.3')
-  spec.add_development_dependency('rake', '~> 13.0')
-  spec.add_development_dependency('rake-compiler', '~> 1.1')
-  spec.add_development_dependency('rspec', '~> 3.11')
-  spec.add_development_dependency('rubocop', '~> 1.25')
-  spec.add_development_dependency('rubocop-rake', '~> 0.6')
-  spec.add_development_dependency('rubocop-rspec', '~> 2.9')
-
-  spec.cert_chain = ['certs/johanns.pem']
-  spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $PROGRAM_NAME =~ /gem\z/
-end

data/tests.sh

@@ -1,28 +0,0 @@
-#!/bin/sh
-
-rm -fv spec/sha3_compute*.rb
-rm -fv spec/sha3_digest*.rb
-
-if [ -d "spec/data" ]
-then
-    rm -rfv spec/data/*
-else
-    mkdir "spec/data"
-fi
-
-pushd "spec/data"
-
-if [ -f "*.txt" ]
-then
-    rm -v *.txt
-fi
-
-wget "https://raw.githubusercontent.com/XKCP/XKCP/master/tests/TestVectors/ShortMsgKAT_SHA3-224.txt"
-wget "https://raw.githubusercontent.com/XKCP/XKCP/master/tests/TestVectors/ShortMsgKAT_SHA3-256.txt"
-wget "https://raw.githubusercontent.com/XKCP/XKCP/master/tests/TestVectors/ShortMsgKAT_SHA3-384.txt"
-wget "https://raw.githubusercontent.com/XKCP/XKCP/master/tests/TestVectors/ShortMsgKAT_SHA3-512.txt"
-
-cd ".."
-
-ruby generate_tests.rb
-rake