oroku_saki 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92e35fcb6b712a4480ed16ad9ded3959f066b08a
+  data.tar.gz: 87979e5935c98d372ab042a1d9aa0ddc36adb13b
+SHA512:
+  metadata.gz: 6a755589cecf5494141b5e78d5598395fd2b022cdb6a4bdc7f94e59f9119fbb9b1218a84276c75727d32d4e7b75368e88526e8411afd631b5fdac29dbe5ad1ad
+  data.tar.gz: f4be1b4ddbd048c686f956c6d1c884a1f3e62b70b8cbeaa6527e2743b3e28c425967044a74fcdd23eb88229cc997f580d2fdc36b74bcc93da0c49596f6a93072

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at t.pickett66@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oroku_saki.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tyler Pickett
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# OrokuSaki
+
+OrokuSaki, a.k.a. Shredder, is the destroyer of strings and attacker's worst
+nightmare!
+
+But seriously, this is a collection of small tools for helping your secrets in
+crypto applications stay secret.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oroku_saki'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oroku_saki
+
+## Usage
+
+Immediately zeroing out the memory location of a string you want to protect:
+
+```ruby
+my_secret = 'super sekret value!!!'
+OrokuSaki.shred!(my_secret) # => nil
+puts my_secret # => "\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000"
+
+second_secret = 'another sekret'
+# String#shred! delegates to OrokuSaki.shred!
+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:
+```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
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tpickett66/oroku_saki. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rake/extensiontask"
+
+task :build => :compile
+
+Rake::ExtensionTask.new("oroku_saki") do |ext|
+  ext.lib_dir = "lib/oroku_saki"
+end
+
+task :default => [:clobber, :compile, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oroku_saki"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/oroku_saki/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile("oroku_saki/oroku_saki")

data/ext/oroku_saki/memzero.c

@@ -0,0 +1,114 @@
+/* Copyright 2012-2016, Mansour Moufid <mansourmoufid@gmail.com>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include <assert.h>
+#include <stddef.h>
+#include <stdint.h>
+
+#include "memzero.h"
+
+static const unsigned long int qzero = 0UL;
+
+/*@ requires \valid((unsigned char *)mem);
+    requires stride > 0;
+    assigns \nothing;
+ */
+static size_t
+offset_align(void *const mem, const size_t stride)
+{
+    uintptr_t offset = (uintptr_t) mem % stride;
+    if (offset == 0) {
+        return (size_t) 0;
+    } else {
+        return (stride - (size_t) offset);
+    }
+}
+
+/*@ requires \valid(p + (0 .. n - 1));
+    assigns *(p + (0 .. n - 1));
+    ensures \forall integer i; 0 <= i < n ==> p[i] == 0;
+ */
+static inline void
+zero_bytes(unsigned char *p, const size_t n)
+{
+    size_t i;
+    if (n == 0) {
+        return;
+    }
+    p[0] = 0;
+    /*@ loop invariant n;
+        loop invariant i > 0;
+        loop assigns i, p[1 .. n - 1];
+     */
+    for (i = 1; i < n; i++) {
+        p[i] = p[i - 1];
+    }
+    return;
+}
+
+/*@ requires \valid((unsigned char *)mem + (0 .. (n - 1)));
+    ensures \forall integer i; 0 <= i < n
+        ==> ((unsigned char *)mem)[i] == 0;
+ */
+void *
+memzero(void *const mem, const size_t n)
+{
+    size_t i, j;
+    unsigned long int *q;
+    unsigned char *b;
+
+    assert(mem != NULL);
+
+    if (n == 0) {
+        goto done;
+    }
+
+    i = 0;
+
+    if (n - i >= 2 * sizeof(qzero)) {
+        /* Zero bytes up to the first aligned word. */
+        b = mem;
+        b += i;
+        zero_bytes(b, offset_align(b, sizeof(qzero)));
+        i += offset_align(b, sizeof(qzero));
+        b += i;
+
+        /* Zero word by word. */
+        assert(offset_align(b, sizeof(qzero)) == 0);
+        q = (unsigned long int *) b;
+        q[0] = qzero;
+        /*@ loop invariant i;
+            loop invariant n;
+            loop invariant j > 0;
+            loop assigns q[j];
+         */
+        for (j = 1; j < (n - i) / sizeof(qzero); j++) {
+            q[j] = q[j - 1];
+        }
+        i += j * sizeof(qzero);
+    }
+
+    if (i >= n) {
+        goto done;
+    }
+
+    /* Zero any trailing bytes. */
+    b = mem;
+    b += i;
+    zero_bytes(b, n - i);
+
+done:
+    return mem;
+}

data/ext/oroku_saki/memzero.h

@@ -0,0 +1,23 @@
+/* Copyright 2012-2016, Mansour Moufid <mansourmoufid@gmail.com>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#if !defined(MEMZERO_H)
+#define MEMZERO_H
+
+#include <stddef.h>
+
+void *memzero(void *const, const size_t);
+
+#endif

data/ext/oroku_saki/oroku_saki.c

@@ -0,0 +1,41 @@
+#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) {
+    VALUE inspected_obj, obj_class_name;
+    inspected_obj = rb_funcall(rb_str, rb_intern("inspect"), 0);
+    obj_class_name = rb_funcall(
+        rb_funcall(rb_str, rb_intern("class"), 0),
+        rb_intern("name"),
+        0
+        );
+    rb_raise(
+        rb_eTypeError,
+        "OrokuSaki.shred! received %s (%s), expected String!",
+        StringValueCStr(inspected_obj),
+        StringValueCStr(obj_class_name)
+        );
+  }
+  memzero(RSTRING_PTR(rb_str), RSTRING_LEN(rb_str));
+  return Qnil;
+}
+
+VALUE rb_mOrokuSaki;
+
+void
+Init_oroku_saki(void)
+{
+  rb_mOrokuSaki = rb_define_module("OrokuSaki");
+  rb_define_singleton_method(rb_mOrokuSaki, "shred!",
+      oroku_saki_shred_bang, 1);
+}

data/ext/oroku_saki/oroku_saki.h

@@ -0,0 +1,7 @@
+#ifndef OROKU_SAKI_H
+#define OROKU_SAKI_H 1
+
+#include "ruby.h"
+#include "memzero.h"
+
+#endif /* OROKU_SAKI_H */

data/lib/oroku_saki.rb

@@ -0,0 +1,31 @@
+require 'oroku_saki/version'
+require 'oroku_saki/oroku_saki'
+require 'oroku_saki/string_ext'
+
+require 'objspace'
+
+module OrokuSaki
+  STRING_FINALIZER =  ->(id) {
+    OrokuSaki.shred!(ObjectSpace._id2ref(id))
+  }
+  private_constant :STRING_FINALIZER
+
+  # 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
+  # a way to ensure the data gets cleared from memory without user intervention.
+  # Having this finalizer attached ensures the sensitive contents will be zeroed
+  # before the GC reaps the object.
+  #
+  # @param [String] str The string to be shredded befor GC reaping
+  # @return [String] The original string
+  #
+  def self.shred_later(str)
+    if !(String === str)
+      raise TypeError,
+        "OrokuSaki.shred_later received #{str} (#{str.class}), expected String!"
+    end
+    ObjectSpace.define_finalizer(str, STRING_FINALIZER)
+    str
+  end
+end

data/lib/oroku_saki/string_ext.rb

@@ -0,0 +1,22 @@
+module OrokuSaki
+  # A handful of extensions included in String to give easy access to the shred
+  # methods.
+  module StringExt
+    # Zero out the receiver
+    #
+    # Delegates to the method with the same name on the {OrokuSaki} method.
+    # @return [nil]
+    def shred!
+      OrokuSaki.shred!(self)
+    end
+
+    # Attach a zeroing finalizer to the receiver
+    #
+    # Delegates to the method with the same name on the {OrokuSaki} method.
+    # @return [self]
+    def shred_later
+      OrokuSaki.shred_later(self)
+    end
+  end
+end
+String.send(:include, OrokuSaki::StringExt)

data/lib/oroku_saki/version.rb

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

data/oroku_saki.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oroku_saki/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oroku_saki"
+  spec.version       = OrokuSaki::VERSION
+  spec.authors       = ["Tyler Pickett"]
+  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.homepage      = "https://github.com/tpickett66/oroku_saki"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/oroku_saki/extconf.rb"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler", "~> 0.9"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 8.2"
+  spec.add_development_dependency "yard", "~> 0.8.7"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: oroku_saki
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tyler Pickett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email:
+- t.pickett66@gmail.com
+executables: []
+extensions:
+- ext/oroku_saki/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/oroku_saki/extconf.rb
+- ext/oroku_saki/memzero.c
+- ext/oroku_saki/memzero.h
+- ext/oroku_saki/oroku_saki.c
+- ext/oroku_saki/oroku_saki.h
+- lib/oroku_saki.rb
+- lib/oroku_saki/string_ext.rb
+- lib/oroku_saki/version.rb
+- oroku_saki.gemspec
+homepage: https://github.com/tpickett66/oroku_saki
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: OrokuSaki, a.k.a. Shredder, is the destroyer of strings and attacker's worst
+  nightmare!
+test_files: []
+has_rdoc: