sha3 0.2.2 → 1.0.2

data/ext/sha3/KeccakNISTInterface.c

@@ -1,81 +0,0 @@
-/*
-The Keccak sponge function, designed by Guido Bertoni, Joan Daemen,
-Michaël Peeters and Gilles Van Assche. For more information, feedback or
-questions, please refer to our website: http://keccak.noekeon.org/
-
-Implementation by the designers,
-hereby denoted as "the implementer".
-
-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/
-*/
-
-#include <string.h>
-#include "KeccakNISTInterface.h"
-#include "KeccakF-1600-interface.h"
-
-HashReturn Init(hashState *state, int hashbitlen)
-{
-    switch(hashbitlen) {
-        case 0: // Default parameters, arbitrary length output
-            InitSponge((spongeState*)state, 1024, 576);
-            break;
-        case 224:
-            InitSponge((spongeState*)state, 1152, 448);
-            break;
-        case 256:
-            InitSponge((spongeState*)state, 1088, 512);
-            break;
-        case 384:
-            InitSponge((spongeState*)state, 832, 768);
-            break;
-        case 512:
-            InitSponge((spongeState*)state, 576, 1024);
-            break;
-        default:
-            return BAD_HASHLEN;
-    }
-    state->fixedOutputLength = hashbitlen;
-    return SUCCESS;
-}
-
-HashReturn Update(hashState *state, const BitSequence *data, DataLength databitlen)
-{
-    if ((databitlen % 8) == 0)
-        return Absorb((spongeState*)state, data, databitlen);
-    else {
-        HashReturn ret = Absorb((spongeState*)state, data, databitlen - (databitlen % 8));
-        if (ret == SUCCESS) {
-            unsigned char lastByte; 
-            // Align the last partial byte to the least significant bits
-            lastByte = data[databitlen/8] >> (8 - (databitlen % 8));
-            return Absorb((spongeState*)state, &lastByte, databitlen % 8);
-        }
-        else
-            return ret;
-    }
-}
-
-HashReturn Final(hashState *state, BitSequence *hashval)
-{
-    return Squeeze(state, hashval, state->fixedOutputLength);
-}
-
-HashReturn Hash(int hashbitlen, const BitSequence *data, DataLength databitlen, BitSequence *hashval)
-{
-    hashState state;
-    HashReturn result;
-
-    if ((hashbitlen != 224) && (hashbitlen != 256) && (hashbitlen != 384) && (hashbitlen != 512))
-        return BAD_HASHLEN; // Only the four fixed output lengths available through this API
-    result = Init(&state, hashbitlen);
-    if (result != SUCCESS)
-        return result;
-    result = Update(&state, data, databitlen);
-    if (result != SUCCESS)
-        return result;
-    result = Final(&state, hashval);
-    return result;
-}
-

data/ext/sha3/KeccakNISTInterface.h

@@ -1,70 +0,0 @@
-/*
-The Keccak sponge function, designed by Guido Bertoni, Joan Daemen,
-Michaël Peeters and Gilles Van Assche. For more information, feedback or
-questions, please refer to our website: http://keccak.noekeon.org/
-
-Implementation by the designers,
-hereby denoted as "the implementer".
-
-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 _KeccakNISTInterface_h_
-#define _KeccakNISTInterface_h_
-
-#include "KeccakSponge.h"
-
-typedef unsigned char BitSequence;
-typedef unsigned long long DataLength;
-typedef enum { SUCCESS = 0, FAIL = 1, BAD_HASHLEN = 2 } HashReturn;
-
-typedef spongeState hashState;
-
-/**
-  * Function to initialize the state of the Keccak[r, c] sponge function.
-  * The rate r and capacity c values are determined from @a hashbitlen.
-  * @param  state       Pointer to the state of the sponge function to be initialized.
-  * @param  hashbitlen  The desired number of output bits, 
-  *                     or 0 for Keccak[] with default parameters
-  *                     and arbitrarily-long output.
-  * @pre    The value of hashbitlen must be one of 0, 224, 256, 384 and 512.
-  * @return SUCCESS if successful, BAD_HASHLEN if the value of hashbitlen is incorrect.
-  */
-HashReturn Init(hashState *state, int hashbitlen);
-/**
-  * Function to give input data for the sponge function to absorb.
-  * @param  state       Pointer to the state of the sponge function initialized by Init().
-  * @param  data        Pointer to the input data. 
-  *                     When @a databitLen is not a multiple of 8, the last bits of data must be
-  *                     in the most significant bits of the last byte.
-  * @param  databitLen  The number of input bits provided in the input data.
-  * @pre    In the previous call to Absorb(), databitLen was a multiple of 8.
-  * @return SUCCESS if successful, FAIL otherwise.
-  */
-HashReturn Update(hashState *state, const BitSequence *data, DataLength databitlen);
-/**
-  * Function to squeeze output data from the sponge function.
-  * If @a hashbitlen was not 0 in the call to Init(), the number of output bits is equal to @a hashbitlen.
-  * If @a hashbitlen was 0 in the call to Init(), the output bits must be extracted using the Squeeze() function.
-  * @param  state       Pointer to the state of the sponge function initialized by Init().
-  * @param  hashval     Pointer to the buffer where to store the output data.
-  * @return SUCCESS if successful, FAIL otherwise.
-  */
-HashReturn Final(hashState *state, BitSequence *hashval);
-/**
-  * Function to compute a hash using the Keccak[r, c] sponge function.
-  * The rate r and capacity c values are determined from @a hashbitlen.
-  * @param  hashbitlen  The desired number of output bits.
-  * @param  data        Pointer to the input data. 
-  *                     When @a databitLen is not a multiple of 8, the last bits of data must be
-  *                     in the most significant bits of the last byte.
-  * @param  databitLen  The number of input bits provided in the input data.
-  * @param  hashval     Pointer to the buffer where to store the output data.
-  * @pre    The value of hashbitlen must be one of 224, 256, 384 and 512.
-  * @return SUCCESS if successful, BAD_HASHLEN if the value of hashbitlen is incorrect.
-  */
-HashReturn Hash(int hashbitlen, const BitSequence *data, DataLength databitlen, BitSequence *hashval);
-
-#endif

data/ext/sha3/_sha3.c

@@ -1,309 +0,0 @@
-#include "_sha3.h"
-
-/* Document-module: SHA3 
- * SHA3
- */
-
-/* Document-class: SHA3::Digest < Digest::Class
- * SHA3::Digest allows you to compute message digests
- * (interchangeably called "hashes") of arbitrary data that are
- * cryptographically secure using SHA3 (Keccak) algorithm.
- *  
- * == Usage
- *
- *  require 'sha3'
- * 
- * === Basics
- *     
- *  # Instantiate a new SHA3::Digest class with 256 bit length
- *  s = SHA3::Digest.new(:sha256)
- *  # => #<SHA3::Digest: c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470>
- *
- *  # Update hash state, and compute new value
- *  s.update "Compute Me"
- *  # => #<SHA3::Digest: c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470>
- *     
- *  # << is an .update() alias
- *  s << "Me too"
- *  # => #<SHA3::Digest: e26f539eee3a05c52eb1f9439652d23343adea9764f011da232d24cd6d19924a>
- *     
- *  # Print digest bytes string
- *  puts s.digest
- *     
- *  # Print digest hex string
- *  puts s.hexdigest
- *
- * === Hashing a file
- *
- *  # Compute the hash value for given file, and return the result as hex
- *  s = SHA3::Digest.new(224).file("my_awesome_file.bin").hexdigest
- *
- * === Bit operation
- *     
- *  # Compute hash of "011"
- *  SHA3::Digest.compute(:sha224, "\xC0", 3).unpack("H*")
- *  # => ["2b695a6fd92a2b3f3ce9cfca617d22c9bb52815dd59a9719b01bad25"]
- *
- * == Notes
- *  
- *    ::Digest::Class call sequence ->
- *    | .alloc() ->
- *    | .new() ->
- *    | .update() ->
- *    | .digest or .hexdigest or .inspect -> (Instance.digest or .hexdigest()) ->
- *    --| .alloc() ->
- *      | .copy() ->
- *      | .finish() ->
- *  
- */
-
-static 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(eDigestError, "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(eDigestError, "unknown type value");
-
-  return hlen;
-}
-
-static void free_allox(MDX *mdx) 
-{
-  if (mdx) {
-    if (mdx->state)
-      free(mdx->state);
-
-    free(mdx);
-  } 
-
-  return;
-}
-
-static VALUE c_digest_alloc(VALUE klass) 
-{
-  MDX *mdx;
-  VALUE obj;
-
-  mdx = (MDX *) malloc(sizeof(*mdx));
-  if (!mdx)
-    rb_raise(eDigestError, "failed to allocate object memory");
-
-  mdx->state = (hashState *) malloc(sizeof(*mdx->state));  
-  if (!mdx->state) {
-    free_allox(mdx);
-    rb_raise(eDigestError, "failed to allocate state memory");
-  }
-
-  obj = Data_Wrap_Struct(klass, 0, free_allox, mdx);
-
-  memset(mdx->state, 0, sizeof(*mdx->state));
-  mdx->hashbitlen = 0;
-
-  return obj;
-}
-
-static VALUE c_digest_update(VALUE, VALUE);
-
-// SHA3::Digest.new(type, [data]) -> self
-static VALUE c_digest_init(int argc, VALUE *argv, VALUE self)
-{ 
-  MDX *mdx;
-  VALUE hlen, data;
-
-  rb_scan_args(argc, argv, "02", &hlen, &data);
-  GETMDX(self, mdx);
-
-  if (!NIL_P(hlen))
-    mdx->hashbitlen = get_hlen(hlen);
-  else
-    mdx->hashbitlen = 256;
-
-  if (Init(mdx->state, mdx->hashbitlen) != SUCCESS)
-    rb_raise(eDigestError, "failed to initialize algorithm state");
-
-  if (!NIL_P(data))
-    return c_digest_update(self, data);
-
-  return self;
-}
-
-// SHA3::Digest.update(data) -> self
-static VALUE c_digest_update(VALUE self, VALUE data) 
-{
-  MDX *mdx;
-  DataLength dlen;
-
-  StringValue(data);
-  GETMDX(self, mdx);
-
-  dlen = (RSTRING_LEN(data) * 8);
-
-  if (Update(mdx->state, RSTRING_PTR(data), dlen) != SUCCESS)
-    rb_raise(eDigestError, "failed to update hash data");
-
-  return self;
-}
-
-// SHA3::Digest.reset() -> self
-static VALUE c_digest_reset(VALUE self) 
-{
-  MDX *mdx;
-
-  GETMDX(self, mdx);
-
-  memset(mdx->state, 0, sizeof(*mdx->state));
-
-  if (Init(mdx->state, mdx->hashbitlen) != SUCCESS)
-    rb_raise(eDigestError, "failed to reset internal state");
-
-  return self;
-}
-
-// SHA3::Digest.copy(obj) -> self
-static VALUE c_digest_copy(VALUE self, VALUE obj) 
-{
-  MDX *mdx1, *mdx2;
-
-  rb_check_frozen(self);
-  if (self == obj)
-    return self;
-
-  GETMDX(self, mdx1);
-  SAFEGETMDX(obj, mdx2);
-
-  memcpy(mdx1->state, mdx2->state, sizeof(hashState));
-  mdx1->hashbitlen = mdx2->hashbitlen;
- 
-  // Fetch the data again to make sure it was copied
-  GETMDX(self, mdx1);
-  SAFEGETMDX(obj, mdx2);
-  if ((mdx1->state != mdx2->state) && (mdx1->hashbitlen != mdx2->hashbitlen))
-    rb_raise(eDigestError, "failed to copy state");
-
-  return self;
-}
-
-// SHA3::Digest.digest_length -> Integer
-static VALUE c_digest_length(VALUE self) 
-{
-  MDX *mdx;
-  GETMDX(self, mdx);
-
-  return ULL2NUM(mdx->hashbitlen / 8);
-}
-
-// SHA3::Digest.block_length -> Integer
-static VALUE c_digest_block_length(VALUE self) 
-{
-  MDX *mdx;
-  GETMDX(self, mdx);
-
-  return ULL2NUM(200 - (2 * (mdx->hashbitlen / 8)));
-}
-
-// SHA3::Digest.name -> String
-static VALUE c_digest_name(VALUE self) 
-{
-  return rb_str_new2("SHA3");
-}
-
-// SHA3::Digest.finish() -> String
-static VALUE c_digest_finish(int argc, VALUE *argv, VALUE self) 
-{
-  MDX *mdx;
-  VALUE str;
-
-  rb_scan_args(argc, argv, "01", &str);
-  GETMDX(self, mdx);
-
-  if (NIL_P(str)) {
-    str = rb_str_new(0, mdx->hashbitlen / 8);
-  } 
-  else {
-    StringValue(str);
-    rb_str_resize(str, mdx->hashbitlen / 8);
-  }
-
-  if (Final(mdx->state, RSTRING_PTR(str)) != SUCCESS)
-    rb_raise(eDigestError, "failed to finalize digest");
-
-  return str;
-}
-
-// SHA3::Digest.compute(type, data, [datalen]) -> String (bytes)
-// TO-DO: styled output (hex)
-VALUE c_digest_compute(int argc, VALUE *argv, VALUE self)
-{
-  VALUE hlen, data, dlen, str;
-  int hashbitlen;
-  DataLength datalen;
-
-  rb_scan_args(argc, argv, "21", &hlen, &data, &dlen);
-
-  hashbitlen = get_hlen(hlen);
-
-  StringValue(data);
-  
-  if (!NIL_P(dlen))
-    datalen = NUM2ULL(dlen);
-  else
-    datalen = (RSTRING_LEN(data) * 8);
-
-  str = rb_str_new(0, hashbitlen / 8);
-
-  if (Hash(hashbitlen, RSTRING_PTR(data), datalen, RSTRING_PTR(str)) != SUCCESS)
-    rb_raise(eDigestError, "failed to generate hash");
-
-  return str;
-}
-
-void Init_sha3_n()
-{
-  rb_require("digest");
-
-  mSHA3 = rb_define_module("SHA3");
-  /* SHA3::Digest (class) */
-  cDigest = rb_define_class_under(mSHA3, "Digest", rb_path2class("Digest::Class"));
-  /* SHA3::Digest::DigestError (class) */ 
-  eDigestError = rb_define_class_under(cDigest, "DigestError", rb_eStandardError);
-
-  // SHA3::Digest (class) methods
-  rb_define_alloc_func(cDigest, c_digest_alloc);
-  rb_define_method(cDigest, "initialize", c_digest_init, -1);
-  rb_define_method(cDigest, "update", c_digest_update, 1);
-  rb_define_method(cDigest, "reset", c_digest_reset, 0);
-  rb_define_method(cDigest, "initialize_copy", c_digest_copy, 1);
-  rb_define_method(cDigest, "digest_length", c_digest_length, 0);
-  rb_define_method(cDigest, "block_length", c_digest_block_length, 0);
-  rb_define_method(cDigest, "name", c_digest_name, 0);
-  rb_define_private_method(cDigest, "finish", c_digest_finish, -1);
-
-  rb_define_alias(cDigest, "<<", "update");
-  
-  // SHA3 (module) functions (support bit operations)
-  rb_define_singleton_method(cDigest, "compute", c_digest_compute, -1);
-
-  return;
-}