oroku_saki 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92e35fcb6b712a4480ed16ad9ded3959f066b08a
-  data.tar.gz: 87979e5935c98d372ab042a1d9aa0ddc36adb13b
+  metadata.gz: 1bb2e0fe1dcd41017630398ac68646eb38d5afbb
+  data.tar.gz: 8a95b019ba3f9514206da31bf880a1be35ea466f
 SHA512:
-  metadata.gz: 6a755589cecf5494141b5e78d5598395fd2b022cdb6a4bdc7f94e59f9119fbb9b1218a84276c75727d32d4e7b75368e88526e8411afd631b5fdac29dbe5ad1ad
-  data.tar.gz: f4be1b4ddbd048c686f956c6d1c884a1f3e62b70b8cbeaa6527e2743b3e28c425967044a74fcdd23eb88229cc997f580d2fdc36b74bcc93da0c49596f6a93072
+  metadata.gz: 41bc12a28951a48f193ab84f348148de620629a9af0b32b483d87e1512ae1c038ddd163d57e48f71405176b1797b5a2029f175f8931829d776540c7c91985cc6
+  data.tar.gz: e9c21b707a38c155c962a9b43a593cbad3eef76392176403753da5b21c450303a74206a3d08b6b63efc619c30fb73a3f72f35ad869709a851b88dccc699b4dd4

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
+  - 2.1.1
   - 2.2.2
+  - 2.3.0
 before_install: gem install bundler -v 1.11.2

data/README.md

@@ -1,4 +1,6 @@
 # OrokuSaki
+[![Build Status](https://travis-ci.org/tpickett66/oroku_saki.svg?branch=master)](https://travis-ci.org/tpickett66/oroku_saki)
+[![Gem Version](https://badge.fury.io/rb/oroku_saki.svg)](https://badge.fury.io/rb/oroku_saki)
 
 OrokuSaki, a.k.a. Shredder, is the destroyer of strings and attacker's worst
 nightmare!

data/ext/oroku_saki/oroku_saki.c

@@ -1,31 +1,71 @@
+#include <stdint.h>
 #include "oroku_saki.h"
 
-/* Zero out the memory housing the passed string.
- *
- * This method takes in a string and zeros out the memory it occupies, by design
- * 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.
- * @raise [TypeError] When passed something other than a String
- * @return [nil]
- */
-VALUE oroku_saki_shred_bang(VALUE rb_module, VALUE rb_str) {
-  if (TYPE(rb_str) != T_STRING) {
+void raise_unless_string(VALUE rb_maybe_str, char *original_function_name) {
+  if (TYPE(rb_maybe_str) != T_STRING) {
     VALUE inspected_obj, obj_class_name;
-    inspected_obj = rb_funcall(rb_str, rb_intern("inspect"), 0);
+    inspected_obj = rb_funcall(rb_maybe_str, rb_intern("inspect"), 0);
     obj_class_name = rb_funcall(
-        rb_funcall(rb_str, rb_intern("class"), 0),
+        rb_funcall(rb_maybe_str, rb_intern("class"), 0),
         rb_intern("name"),
         0
         );
     rb_raise(
         rb_eTypeError,
-        "OrokuSaki.shred! received %s (%s), expected String!",
+        "%s received %s (%s), expected String!",
+        original_function_name,
         StringValueCStr(inspected_obj),
         StringValueCStr(obj_class_name)
         );
   }
+}
+
+/*
+ * This is a modified version of NaCl's crypto_verify_N functions adatpted to
+ * work with Ruby's String types and with variable lengths. We're returning
+ * the bitmonkeyed int from this to avoid branch predication.
+ */
+int secure_compare(VALUE rb_str_a, VALUE rb_str_b) {
+  uint_fast16_t d = 0U;
+  int i;
+  int len = RSTRING_LEN(rb_str_a);
+  char *a = RSTRING_PTR(rb_str_a);
+  char *b = RSTRING_PTR(rb_str_b);
+
+  for (i = 0; i < len; i++) {
+    d |= a[i] ^ b[i];
+  }
+
+  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.
+ */
+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");
+  raise_unless_string(rb_str_b, "OrokuSaki.secure_compare");
+
+  if (RSTRING_LEN(rb_str_a) != RSTRING_LEN(rb_str_b)) {
+    return INT2FIX(-1);
+  }
+
+  return INT2FIX(secure_compare(rb_str_a, rb_str_b));
+}
+
+/* Zero out the memory housing the passed string.
+ *
+ * This method takes in a string and zeros out the memory it occupies, by design
+ * 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.
+ * @raise [TypeError] When passed something other than a String
+ * @return [nil]
+ */
+VALUE oroku_saki_shred_bang(VALUE rb_module, VALUE rb_str) {
+  raise_unless_string(rb_str, "OrokuSaki.shred!");
   memzero(RSTRING_PTR(rb_str), RSTRING_LEN(rb_str));
   return Qnil;
 }
@@ -38,4 +78,6 @@ Init_oroku_saki(void)
   rb_mOrokuSaki = rb_define_module("OrokuSaki");
   rb_define_singleton_method(rb_mOrokuSaki, "shred!",
       oroku_saki_shred_bang, 1);
+  rb_define_singleton_method(rb_mOrokuSaki, "secure_compare_c",
+      oroku_saki_secure_compare, 2);
 }

data/ext/oroku_saki/oroku_saki.h

@@ -4,4 +4,7 @@
 #include "ruby.h"
 #include "memzero.h"
 
+VALUE oroku_saki_secure_compare(VALUE rb_module, VALUE rb_str_a, VALUE rb_str_b);
+VALUE oroku_saki_shred_bang(VALUE rb_module, VALUE rb_str);
+
 #endif /* OROKU_SAKI_H */

data/lib/oroku_saki/version.rb

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

data/lib/oroku_saki.rb

@@ -10,6 +10,10 @@ module OrokuSaki
   }
   private_constant :STRING_FINALIZER
 
+  class << self
+    private :secure_compare_c
+  end
+
   # Attaches the shred method as a finalizer for the passed string
   #
   # Gems working with sensitive data that needs to be returned to the user need
@@ -19,7 +23,7 @@ module OrokuSaki
   #
   # @param [String] str The string to be shredded befor GC reaping
   # @return [String] The original string
-  #
+  # @raise [TypeError] When passed something other than a String
   def self.shred_later(str)
     if !(String === str)
       raise TypeError,
@@ -28,4 +32,14 @@ module OrokuSaki
     ObjectSpace.define_finalizer(str, STRING_FINALIZER)
     str
   end
+
+  # Bitewise compare two strings in constant time
+  #
+  # @param [String] a The first string to look at
+  # @param [String] b The second string to look at
+  # @return [Boolean]
+  # @raise [TypeError] When passed something other than a String for either argument
+  def self.secure_compare(a, b)
+    secure_compare_c(a, b) == 0
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oroku_saki
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tyler Pickett