digest-sha3 1.0.2 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12bda300d0395d0e05c8e6cebf8820790451f238
+  data.tar.gz: 0938f5e9d49f152d2cd905a0bd80a3b9cce92203
+SHA512:
+  metadata.gz: 9fad069c73d041038890a3fa59ac220f8970f392cb9e5fe93db9ad39908ecc9a73b90de7883ff1df56635e95f27451d5c2fadc9f96ed97ef22e0898be7ba66ec
+  data.tar.gz: d09ea65383a9c91858c5427fb425fa3ee34200d9698dc7c8baa4ddb6f567a66d6400bea41cc0d84e334e129e8f49c1610ee63cc4bb947e3a7e2a709e66da31ef

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Phusion
+Copyright (c) 2012-2015 Phusion B.V.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -8,9 +8,7 @@ This Ruby extension implements the SHA-3 ([Keccak](http://keccak.noekeon.org/))
 
     gem install digest-sha3
 
-Our gem is signed using PGP with the [Phusion Software Signing key](http://www.phusion.nl/about/gpg). That key in turn is signed by [the rubygems-openpgp Certificate Authority](http://www.rubygems-openpgp-ca.org/).
-
-You can verify the authenticity of the gem by following [The Complete Guide to Verifying Gems with rubygems-openpgp](http://www.rubygems-openpgp-ca.org/blog/the-complete-guide-to-verifying-gems-with-rubygems-openpgp.html).
+**Note**: as of version 1.1.0, digest-sha3 requires Ruby 2.2. The last version that worked on older versions was 1.0.2.
 
 ## Usage
 

data/digest-sha3.gemspec

@@ -9,6 +9,8 @@ Gem::Specification.new do |s|
   s.description = "The SHA-3 (Keccak) hash."
   s.authors = ["Hongli Lai (Phusion)", "Keccak authors"]
   s.extensions << "ext/digest/extconf.rb"
+  s.required_ruby_version = "~> 2.2"
+  s.license = "MIT"
 
   s.files = Dir[
     "README.md",

data/ext/digest/sha3.c

@@ -9,19 +9,69 @@
 #define MAX_DIGEST_SIZE 64
 #define DEFAULT_DIGEST_LEN 512
 
-static void sha3_init_func(hashState *ctx);
+static int sha3_init_func(hashState *ctx);
 static void sha3_update_func(hashState *ctx, unsigned char *str, size_t len);
+static int sha3_finish_func(hashState *ctx, unsigned char *digest);
 
+/*
+  Metadata definition for the SHA3 algorithm.
+  Defines the Version, sizes for block and digest as well as
+  the entry points for the algorithms
+*/
 static rb_digest_metadata_t sha3 = {
 	RUBY_DIGEST_API_VERSION,
 	DEFAULT_DIGEST_LEN,
-	KeccakPermutationSize - (2 * DEFAULT_DIGEST_LEN),
-	sizeof(hashState),
+	KeccakPermutationSize - (2 * DEFAULT_DIGEST_LEN), //size of blocks
+	sizeof(hashState), //size of context for the object we'll be passed in below functions.
 	(rb_digest_hash_init_func_t)sha3_init_func,
 	(rb_digest_hash_update_func_t)sha3_update_func,
-	NULL,
+	(rb_digest_hash_finish_func_t)sha3_finish_func,
 };
 
+/* Initialization function for the algorithm,
+   gets called during allocation of the digest object.
+   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
+  // so this is not necessary
+  // the base class alloc calls this to initialize the algorithm
+  return 1;
+}
+
+/* Update function, take the current context and add str to it */
+static void
+sha3_update_func(hashState *ctx, unsigned char *str, size_t len) {
+	Update(ctx, str, len * 8);
+}
+
+/* Finish the hash calculation and return the finished string */
+static int
+sha3_finish_func(hashState *ctx, unsigned char *digest) {
+	Final(ctx, digest);
+	return 1;
+}
+
+/* Ruby method.  Digest::SHA3#finish()
+ * No Arguments
+ * @returns [String] Encoded Digest String
+ */
+static VALUE
+rb_sha3_finish(VALUE self) {
+  hashState *ctx;
+  VALUE digest;
+
+  ctx = (hashState *)RTYPEDDATA_DATA(self);
+  digest = rb_str_new(0, ctx->capacity / 2 / 8);
+  sha3_finish_func(ctx, (unsigned char *)RSTRING_PTR(digest));
+
+  return digest;
+}
+
+/* :nodoc: private method
+ * initialize the ctx with the bitlength
+ */
 static void
 sha3_init(hashState *ctx, size_t bitlen) {
 	switch (Init(ctx, bitlen)) {
@@ -36,25 +86,10 @@ sha3_init(hashState *ctx, size_t bitlen) {
 	}
 }
 
-static void
-sha3_init_func(hashState *ctx) {
-	Init(ctx, ctx->capacity / 2);
-}
-
-static void
-sha3_update_func(hashState *ctx, unsigned char *str, size_t len) {
-	Update(ctx, str, len * 8);
-}
-
-static VALUE
-rb_sha3_alloc(VALUE klass) {
-	hashState *ctx;
-
-	ctx = (hashState *) xmalloc(sizeof(hashState));
-	sha3_init(ctx, DEFAULT_DIGEST_LEN);
-	return Data_Wrap_Struct(klass, 0, xfree, ctx);
-}
-
+/* Ruby method.  Digest::SHA3.new(hashlen)
+ * @param hashlen The length of hash, only supports 224, 256, 384 or 512
+ * @returns [Digest::SHA3] new object.
+ */
 static VALUE
 rb_sha3_initialize(int argc, VALUE *argv, VALUE self) {
 	hashState *ctx;
@@ -66,46 +101,35 @@ rb_sha3_initialize(int argc, VALUE *argv, VALUE self) {
 	} else {
 		i_hashlen = NUM2INT(hashlen);
 	}
-	switch (i_hashlen) {
-	case 0:
+	if ( i_hashlen == 0) {
 		rb_raise(rb_eArgError, "Unsupported hash length");
-	case DEFAULT_DIGEST_LEN:
-		break;
-	default:
-		Data_Get_Struct(self, hashState, ctx);
-		sha3_init(ctx, i_hashlen);
-	}
-
-	return self;
-}
-
-static VALUE
-rb_sha3_finish(VALUE self) {
-	hashState *ctx;
-	VALUE digest;
-
-	Data_Get_Struct(self, hashState, ctx);
-
-	digest = rb_str_new(0, ctx->capacity / 2 / 8);
+  }
 
-	Final(ctx, (unsigned char *)RSTRING_PTR(digest));
+  ctx = (hashState *)RTYPEDDATA_DATA(self);
+	sha3_init(ctx, i_hashlen);
 
-	return digest;
+	return rb_call_super(0, NULL);
 }
 
+/* Ruby method.  Digest::SHA3#digest_length
+ * @returns [Numeric] Length of the digest.
+ */
 static VALUE
 rb_sha3_digest_length(VALUE self) {
 	hashState *ctx;
 
-	Data_Get_Struct(self, hashState, ctx);
+	ctx = (hashState *)RTYPEDDATA_DATA(self);
 	return INT2FIX(ctx->capacity / 2 / 8);
 }
 
+/* Ruby method.  Digest::SHA3#block_length
+ * @returns [Numeric] Length of blocks in this digest.
+ */
 static VALUE
 rb_sha3_block_length(VALUE self) {
 	hashState *ctx;
 
-	Data_Get_Struct(self, hashState, ctx);
+	ctx = (hashState *)RTYPEDDATA_DATA(self);
 	return INT2FIX(ctx->rate / 8);
 }
 
@@ -120,11 +144,10 @@ Init_sha3() {
 
 	cSHA3 = rb_define_class_under(mDigest, "SHA3", cDigest_Base);
 
-	rb_ivar_set(cSHA3, rb_intern("metadata"), Data_Wrap_Struct(rb_cObject, 0, 0, &sha3));
+	rb_iv_set(cSHA3, "metadata", Data_Wrap_Struct(0, 0, 0, (void *)&sha3));
 
-	rb_define_alloc_func(cSHA3, rb_sha3_alloc);
-	rb_define_method(cSHA3, "initialize", rb_sha3_initialize, -1);
-	rb_define_private_method(cSHA3, "finish", rb_sha3_finish, 0);
-	rb_define_method(cSHA3, "digest_length", rb_sha3_digest_length, 0);
-	rb_define_method(cSHA3, "block_length", rb_sha3_block_length, 0);
+  rb_define_method(cSHA3, "initialize", rb_sha3_initialize, -1);
+  rb_define_method(cSHA3, "digest_length", rb_sha3_digest_length, 0);
+  rb_define_method(cSHA3, "block_length", rb_sha3_block_length, 0);
+  rb_define_method(cSHA3, "finish", rb_sha3_finish, 0);
 }

data/lib/digest/sha3/version.rb

@@ -1,7 +1,7 @@
 module Digest
   class SHA3
     module Version
-      STRING = "1.0.2"
+      STRING = "1.1.0"
     end
   end
-end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: digest-sha3
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Hongli Lai (Phusion)
@@ -10,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies: []
 description: The SHA-3 (Keccak) hash.
 email: software-signing@phusion.nl
@@ -19,45 +18,45 @@ extensions:
 - ext/digest/extconf.rb
 extra_rdoc_files: []
 files:
-- README.md
 - LICENSE
 - Makefile
+- README.md
 - digest-sha3.gemspec
-- ext/digest/displayIntermediateValues.c
+- ext/digest/KeccakF-1600-int-set.h
+- ext/digest/KeccakF-1600-interface.h
 - ext/digest/KeccakF-1600-reference.c
 - ext/digest/KeccakNISTInterface.c
+- ext/digest/KeccakNISTInterface.h
 - ext/digest/KeccakSponge.c
-- ext/digest/sha3.c
+- ext/digest/KeccakSponge.h
 - ext/digest/brg_endian.h
+- ext/digest/displayIntermediateValues.c
 - ext/digest/displayIntermediateValues.h
-- ext/digest/KeccakF-1600-int-set.h
-- ext/digest/KeccakF-1600-interface.h
-- ext/digest/KeccakNISTInterface.h
-- ext/digest/KeccakSponge.h
 - ext/digest/extconf.rb
+- ext/digest/sha3.c
 - lib/digest/sha3/version.rb
 homepage: https://github.com/phusion/digest-sha3-ruby
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.4.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: The SHA-3 (Keccak) hash
 test_files: []

data.tar.gz.asc

@@ -1,12 +0,0 @@
------BEGIN PGP SIGNATURE-----
-Version: GnuPG/MacGPG2 v2.0.17 (Darwin)
-Comment: GPGTools - http://gpgtools.org
-
-iQEcBAABAgAGBQJRnfcdAAoJECrHRaUKISqMiYIH/AoNOUG3VBjW9BJWSkRjJr7H
-QyweWpKE+H7AEAzIyZnMH4qICKBfNfRgMVL6H07Ie+xX8Tm2YBOoHWYXvn2So5bL
-SULpEktHsbc0QSEEWnMUb9oA91qM3e514oJ+xhGQokvVZoFeG6q/WSunuY3TE7Y/
-nxe5PiYCkwCCWdPRtMhgOKgPjK9RDmINml58NI46CL4wscbduXzrv0U91CjVkzsj
-WkCiXCoYQ0hb7vzofbtMppFEhBtO9XlfUoAfl6u7OQOyh553swIP4xoVTKEQ9DMz
-RL6MAzaMtmzCgijT7JYGza/Cmezg0dRzrwWtLPpX43RIk4jWdFCBcwNSHHB5CXA=
-=zd36
------END PGP SIGNATURE-----

metadata.gz.asc

@@ -1,12 +0,0 @@
------BEGIN PGP SIGNATURE-----
-Version: GnuPG/MacGPG2 v2.0.17 (Darwin)
-Comment: GPGTools - http://gpgtools.org
-
-iQEcBAABAgAGBQJRnfcdAAoJECrHRaUKISqM52QH/2XN6fviuj7l8v5IMTgp6taA
-oFdoPqVRcyJA+lU7gPK6goHJLPF62f/M0GBaRmpmnjVi0af5nUjB4kCgZC4aOe6t
-N6eCV7We7nT+bSGZN33keaIceGa/V/b7xeK3o9tNbCxv01iMvigmCi86SXjpydvT
-j9hFedYxGmwpkxAiNeoK7fqyChx3AUbNTcHAh9p+uA0liTvXaH8a7Ot+3R4itCdQ
-fKA73NvVGSoIfD9Vs36obCAZeIQp1E9IIHsEODa+ogBRUNcJbclaNZF9XxUEukq9
-gN9i1Anlf9Y3I9MO2NbZUi58PJg8VFl/bG98OHSbim5e8XYWz3Bfkcvojxtbldc=
-=LIg6
------END PGP SIGNATURE-----