oroku_saki 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bb2e0fe1dcd41017630398ac68646eb38d5afbb
-  data.tar.gz: 8a95b019ba3f9514206da31bf880a1be35ea466f
+  metadata.gz: 7a969ea2bfd10a3057470e5ddf1f8224b146070b
+  data.tar.gz: 993dc9431b14b241a4827d39e346d98bd049e8a7
 SHA512:
-  metadata.gz: 41bc12a28951a48f193ab84f348148de620629a9af0b32b483d87e1512ae1c038ddd163d57e48f71405176b1797b5a2029f175f8931829d776540c7c91985cc6
-  data.tar.gz: e9c21b707a38c155c962a9b43a593cbad3eef76392176403753da5b21c450303a74206a3d08b6b63efc619c30fb73a3f72f35ad869709a851b88dccc699b4dd4
+  metadata.gz: 83631618395302ee122ff73b95cf94b9f236057a554058b230b2f877d0d8041495198353141cad20847d09687d12816f13d49863f72f08b8ac9a8a195fb535f6
+  data.tar.gz: 9b25c6035f28126972e0c3f89a3f9a34f2273987ae6a0660b6a51213667841a3b8f966c23f1fcd4560ff9c5db07eab6c2f47c763995deb746679fe3f93e8bda0

data/README.md

@@ -38,17 +38,25 @@ second_secret = 'another sekret'
 second_secret.shred! # => "\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000"
 ```
 
-Setting a string to be shredded before garbage collection:
+Setting a string to be shredded before garbage collection via a finalizer:
+
 ```ruby
 my_secret = 'super sekret value!!!'
 OrokuSaki.shred_later(my_secret) # => nil
 puts my_secret # => "super sekret value!!!"
-# A finalizer shreds the str just before it gets collected.
 
 second_secret = 'another sekret'
 second_scret.shred_later
 ```
 
+Comparing Strings in constant time (nearly as fast as `==` for small inputs):
+
+```ruby
+hmac = '16b9b8ae8e164768d0505bcb16269efb35804643dd351084b3c6ebbc6f7db2c8'
+other_hmac = '16b9b8ae8e164768d0505bcb16269efb35804643dd351084b3c6ebbc6f7db2c8'
+OrokuSaki.secure_compare(hmac, other_hmac) #=> true
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/ext/oroku_saki/oroku_saki.c

@@ -39,9 +39,15 @@ int secure_compare(VALUE rb_str_a, VALUE rb_str_b) {
   return (1 & ((d - 1) >> 8)) - 1;
 }
 
-/* The C implementation of the secure compare, the return type is a Fixnum
- * to avoid certain optimizations that cause the branch predictor to leak timing
- * information.
+/* The C implementation of secure compare, don't use!
+ *
+ * The return type is a Fixnum to avoid certain optimizations that cause the
+ * branch predictor to potentially leak timing information.
+ *
+ * @param [String] rb_str_a
+ * @param [String] rb_str_b
+ * @return [Fixnum] Zero for success, other values for failure.
+ * @api private
  */
 VALUE oroku_saki_secure_compare(VALUE rb_module, VALUE rb_str_a, VALUE rb_str_b) {
   raise_unless_string(rb_str_a, "OrokuSaki.secure_compare");
@@ -60,7 +66,7 @@ VALUE oroku_saki_secure_compare(VALUE rb_module, VALUE rb_str_a, VALUE rb_str_b)
  * it does not respect frozen states of strings so make sure you're actually
  * done with the String before using this method.
  *
- * @param [String] str The string to be zeroed out.
+ * @param [String] rb_str The string to be zeroed out.
  * @raise [TypeError] When passed something other than a String
  * @return [nil]
  */

data/lib/oroku_saki.rb

@@ -29,7 +29,7 @@ module OrokuSaki
       raise TypeError,
         "OrokuSaki.shred_later received #{str} (#{str.class}), expected String!"
     end
-    ObjectSpace.define_finalizer(str, STRING_FINALIZER)
+    ObjectSpace.define_finalizer(str, STRING_FINALIZER) unless str.frozen?
     str
   end
 

data/lib/oroku_saki/version.rb

@@ -1,3 +1,3 @@
 module OrokuSaki
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/oroku_saki.gemspec

@@ -10,9 +10,10 @@ Gem::Specification.new do |spec|
   spec.email         = ["t.pickett66@gmail.com"]
 
   spec.summary       = %q{OrokuSaki, a.k.a. Shredder, is the destroyer of strings and attacker's worst nightmare!}
-  spec.description   = "OrokuSaki, a.k.a. Shredder, is a small collection for " \
-    "ensuring the strings used in cryptographic operations remain secret. It is " \
-    "based around a simple memzero C function."
+  spec.description   = "OrokuSaki, a.k.a. Shredder, is a small collection of " \
+    "utilities for ensuring the strings used in cryptographic operations " \
+    "remain secret. This currently includes memory zeroing and constant time " \
+    "String comparisons."
   spec.homepage      = "https://github.com/tpickett66/oroku_saki"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oroku_saki
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Tyler Pickett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,9 +94,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7
-description: OrokuSaki, a.k.a. Shredder, is a small collection for ensuring the strings
-  used in cryptographic operations remain secret. It is based around a simple memzero
-  C function.
+description: OrokuSaki, a.k.a. Shredder, is a small collection of utilities for ensuring
+  the strings used in cryptographic operations remain secret. This currently includes
+  memory zeroing and constant time String comparisons.
 email:
 - t.pickett66@gmail.com
 executables: []