simple-secrets 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tim Shadel
+
+MIT License
+
+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,47 @@
+
+# SimpleSecrets [![Build Status](https://travis-ci.org/timshadel/simple-secrets.rb.png?branch=master)](https://travis-ci.org/timshadel/simple-secrets.rb)
+
+A Ruby client for [simple-secrets][simple-secrets], the simple, opinionated library for encrypting small packets of data securely.
+
+[simple-secrets]: https://github.com/timshadel/simple-secrets
+
+## Examples
+
+### Basic
+
+Send:
+
+```ruby
+require('simple-secrets')
+
+# Try `head /dev/urandom | shasum -a 256` to make a decent 256-bit key
+master_key = new Buffer('<64-char hex string (32 bytes, 256 bits)>', 'hex');
+# => <Buffer 71 c8 67 56 23 4b fd 3c 37 ... >
+
+var sender = secrets(master_key);
+var packet = sender.pack('this is a secret message');
+# => 'OqlG6KVMeyFYmunboS3HIXkvN_nXKTxg2yNkQydZOhvJrZvmfov54hUmkkiZCnlhzyrlwOJkbV7XnPPbqvdzZ6TsFOO5YdmxjxRksZmeIhbhLaMiDbfsOuSY1dBn_ZgtYCw-FRIM'
+```
+
+Receive:
+
+```js
+var secrets = require('simple-secrets');
+
+// Same shared key
+var master_key = new Buffer('<shared-key-hex>', 'hex');
+var sender = secrets(master_key);
+var packet = new Buffer('<read data from somewhere>');
+// => 'OqlG6KVMeyFYmunboS3HIXkvN_nXKTxg2yNkQydZOhvJrZvmfov54hUmkkiZCnlhzyrlwOJkbV7XnPPbqvdzZ6TsFOO5YdmxjxRksZmeIhbhLaMiDbfsOuSY1dBn_ZgtYCw-FRIM'
+var secret_message = sender.unpack(packet);
+// => 'this is a secret message'
+```
+
+
+## Can you add ...
+
+This implementation follows [simple-secrets] for 100% compatibility.
+
+## License 
+
+MIT.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/simple-secrets.rb

@@ -0,0 +1 @@
+require "simple_secrets"

data/lib/simple_secrets.rb

@@ -0,0 +1,7 @@
+require "simple_secrets/version"
+require "simple_secrets/primitives"
+require "simple_secrets/packet"
+
+module SimpleSecrets
+  # Your code goes here...
+end

data/lib/simple_secrets/packet.rb

@@ -0,0 +1,107 @@
+
+
+module SimpleSecrets
+
+  class Packet
+
+    def initialize master_key
+      raise ArgumentError unless master_key
+
+      @master_key = hex_to_bin master_key
+      @identity = Primitives.identify @master_key
+    end
+
+    def build_body data
+      nonce = Primitives.nonce
+      bindata = Primitives.serialize data
+
+      body = "#{nonce}#{bindata}"
+
+      Primitives.zero nonce, bindata
+      body
+    end
+
+    def body_to_data body
+      nonce = body[0...16]
+      bindata = body[16..-1]
+
+      data = Primitives.deserialize bindata
+
+      Primitives.zero nonce, bindata
+      data
+    end
+
+    def encrypt_body body, master_key
+      key = Primitives.derive_sender_key master_key
+
+      cipher_data = Primitives.encrypt body, key
+
+      Primitives.zero key
+      cipher_data
+    end
+
+    def decrypt_body cipher_data, master_key
+      key = Primitives.derive_sender_key master_key
+      iv = cipher_data[0...16]
+      encrypted = cipher_data[16..-1]
+
+      body = Primitives.decrypt encrypted, key, iv
+
+      Primitives.zero key, iv, encrypted
+      body
+    end
+
+    def authenticate data, master_key, identity
+      hmac_key = Primitives.derive_sender_hmac master_key
+
+      auth = "#{identity}#{data}"
+      mac = Primitives.mac auth, hmac_key
+      packet = "#{auth}#{mac}"
+
+      Primitives.zero hmac_key, mac
+      packet
+    end
+
+    def verify packet, master_key, identity
+      packet_id = packet[0...6]
+      return nil unless Primitives.compare packet_id, identity
+
+      data = packet[0...-32]
+      packet_mac = packet[-32..-1]
+      hmac_key = Primitives.derive_sender_hmac master_key
+      mac = Primitives.mac data, hmac_key
+      return nil unless Primitives.compare packet_mac, mac
+
+      Primitives.zero hmac_key, mac
+      packet[6...-32]
+    end
+
+    def pack data
+      body = build_body data
+      encrypted = encrypt_body body, @master_key
+      packet = authenticate encrypted, @master_key, @identity
+      websafe = Primitives.stringify packet
+
+      Primitives.zero body, encrypted, packet
+      websafe
+    end
+
+    def unpack websafe_data
+      packet = Primitives.binify websafe_data
+      cipher_data = verify packet, @master_key, @identity
+      Primitives.zero packet
+      return nil unless cipher_data
+
+      body = decrypt_body cipher_data, @master_key
+      data = body_to_data body
+
+      Primitives.zero body, cipher_data
+      data
+    end
+
+    private
+    def hex_to_bin string
+      [string].pack('H*')
+    end
+  end
+end

data/lib/simple_secrets/primitives.rb

@@ -0,0 +1,372 @@
+require 'openssl'
+require 'base64'
+require 'msgpack'
+
+module SimpleSecrets
+
+
+  # Public: Various methods useful for performing cryptographic operations.
+  # WARNING: Using any of these primitives in isolation could be Bad. Take cautious.
+  #
+  # Examples
+  #
+  #   Primitives.nonce
+  #   # => "\x02\x0E\xBB\xBE\xA2\xA4\f\x80\x11N\xCDui\xEE<e"
+  module Primitives
+
+
+    # Public: Provide 16 securely random bytes.
+    #
+    # Examples
+    #
+    #   nonce
+    #   # => "\x02\x0E\xBB\xBE\xA2\xA4\f\x80\x11N\xCDui\xEE<e"
+    #
+    # Returns 16 random bytes in a binary string
+    def self.nonce
+      OpenSSL::Random.random_bytes 16
+    end
+
+
+    # Public: Generate the authentication key for messages originating
+    # from the channel's Sender side.
+    #
+    # Uses the ASCII string 'simple-crypto/sender-hmac-key' as the role.
+    #
+    # master_key - the 256-bit master key of this secure channel
+    #
+    # Examples
+    #
+    #   Primitives.derive_sender_hmac(master_key)
+    #   # =>
+    #
+    # Returns 256-bit sender hmac key
+    def self.derive_sender_hmac master_key
+      derive(master_key, 'simple-crypto/sender-hmac-key')
+    end
+
+
+    # Public: Generate the encryption key for messages originating from the
+    # channel's Sender side.
+    #
+    # Uses the ASCII string 'simple-crypto/sender-cipher-key' as the role.
+    #
+    # master_key - the 256-bit master key of this secure channel
+    #
+    # Examples
+    #
+    #   Primitives.derive_sender_key(master_key)
+    #   # =>
+    #
+    # Returns 256-bit sender encryption key
+    def self.derive_sender_key master_key
+      derive(master_key, 'simple-crypto/sender-cipher-key')
+    end
+
+
+    # Public: Generate the authentication key for messages originating
+    # from the channel's Receiver side.
+    #
+    # Uses the ASCII string 'simple-crypto/receiver-hmac-key' as the role.
+    #
+    # master_key - the 256-bit master key of this secure channel
+    #
+    # Examples
+    #
+    #   Primitives.derive_receiver_hmac(master_key)
+    #   # =>
+    #
+    # Returns 256-bit receiver hmac key
+    def self.derive_receiver_hmac master_key
+      derive(master_key, 'simple-crypto/receiver-hmac-key')
+    end
+
+
+    # Public: Generate the encryption key for messages originating
+    # from the channel's Receiver side.
+    #
+    # Uses the ASCII string 'simple-crypto/receiver-cipher-key' as the role.
+    #
+    # master_key - the 256-bit master key of this secure channel
+    #
+    # Examples
+    #
+    #   Primitives.derive_receiver_key(master_key)
+    #   # =>
+    #
+    # Returns 256-bit receiver encryption key
+    def self.derive_receiver_key master_key
+      derive(master_key, 'simple-crypto/receiver-cipher-key')
+    end
+
+
+    # Public: Encrypt buffer with the given key.
+    #
+    # Uses AES256 with a random 128-bit initialization vector.
+    #
+    # binary - the plaintext binary string
+    # key    - the 256-bit encryption key
+    #
+    # Examples
+    #
+    #   Primitives.encrypt('', '')
+    #   # =>
+    #
+    # Returns a binary string of (IV || ciphertext)
+    def self.encrypt binary, key
+      assertBinary(binary)
+      assertBinary(key)
+      assert256BitBinary(key)
+
+      cipher = OpenSSL::Cipher::AES256.new(:CBC)
+      cipher.encrypt
+      cipher.key = key
+      iv = cipher.random_iv
+
+      encrypted = ''.force_encoding('BINARY')
+      encrypted << iv
+      encrypted << cipher.update(binary)
+      encrypted << cipher.final
+      encrypted
+    end
+
+
+    # Public: Decrypt buffer with the given key and initialization vector.
+    #
+    # Uses AES256.
+    #
+    # binary - ciphertext
+    # key    - the 256-bit encryption key
+    # iv     - the 128-bit initialization vector
+    #
+    # Examples
+    #
+    #   Primitives.decrypt('', '')
+    #   # =>
+    #
+    # Returns the plaintext binary string
+    def self.decrypt binary, key, iv
+      assertBinary(binary, key, iv)
+      assert256BitBinary(key)
+      assert128BitBinary(iv)
+
+      cipher = OpenSSL::Cipher::AES256.new(:CBC)
+      cipher.decrypt
+      cipher.key = key
+      cipher.iv = iv
+
+      decrypted = ''.force_encoding('BINARY')
+      decrypted << cipher.update(binary)
+      decrypted << cipher.final
+      decrypted
+    end
+
+
+    # Public: Create a short identifier for potentially sensitive data.
+    #
+    # binary - the data to identify
+    #
+    # Examples
+    #
+    #   Primitives.identify('')
+    #   # =>
+    #
+    # Returns a 6-byte binary string identifier
+    def self.identify binary
+      assertBinary(binary)
+
+      hash = OpenSSL::Digest::SHA256.new
+      hash << [binary.size].pack("C*")
+      hash << binary
+      hash.digest[0..5]
+    end
+
+
+    # Public: Create a message authentication code for the given data.
+    # Uses HMAC-SHA256.
+    #
+    # binary   - data to authenticate
+    # hmac_key - the authentication key
+    #
+    # Examples
+    #
+    #   Primitives.mac('','')
+    #   # =>
+    #
+    # Returns a 32-byte MAC binary string
+    def self.mac binary, hmac_key
+      assertBinary(binary, hmac_key)
+      assert256BitBinary(hmac_key)
+
+      OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, hmac_key, binary)
+    end
+
+
+    # Public: Use a constant-time comparison algorithm to reduce
+    # side-channel attacks.
+    #
+    # Short-circuits only when the two buffers aren't the same length.
+    #
+    # a - a binary string
+    # b - a binary string
+    #
+    # Examples
+    #
+    #   Primitives.compare('','')
+    #   # =>
+    #
+    # Returns true if both buffer contents match
+    def self.compare a, b
+      assertBinary(a, b)
+
+      # things must be the same length to compare them.
+      return false if a.bytesize != b.bytesize
+
+      # constant-time compare
+      #   hat-tip to https://github.com/freewil/scmp for |=
+      same = 0;
+      (0...a.bytesize).each do |i|
+        same |= a.getbyte(i) ^ b.getbyte(i)
+      end
+      same == 0
+    end
+
+
+    # Public: Turn a websafe string back into a binary string.
+    #
+    # Uses base64url encoding.
+    #
+    # string - websafe string
+    #
+    # Examples
+    #
+    #   Primitives.binify('')
+    #   # =>
+    #
+    # Returns the binary version of this string
+    def self.binify string
+      raise 'base64url string required.' unless (string.instance_of?(String) && string =~ /^[a-zA-Z0-9_\-]+$/)
+
+      string += '=' while !(string.size % 4).zero?
+      Base64.urlsafe_decode64(string)
+    end
+
+
+    # Public: Turn a binary buffer into a websafe string.
+    #
+    # Uses base64url encoding.
+    #
+    # binary - data which needs to be websafe
+    #
+    # Examples
+    #
+    #   Primitives.stringify('')
+    #   # =>
+    #
+    # Returns the websafe string
+    def self.stringify binary
+      assertBinary(binary)
+
+      Base64.urlsafe_encode64(binary).gsub('=','')
+    end
+
+
+    # Public: Turn a JSON-like object into a binary
+    # representation suitable for use in crypto functions.
+    # This object will possibly be deserialized in a different
+    # programming environment—it should be JSON-like in structure.
+    #
+    # Uses MsgPack data serialization.
+    #
+    # object - any object without cycles which responds to `to_msgpack`
+    #
+    # Examples
+    #
+    #   Primitives.serialize('')
+    #   # =>
+    #
+    # Returns the binary version of this object
+    def self.serialize object
+      object.to_msgpack
+    end
+
+
+    # Public: Turn a binary representation into a Ruby object
+    # suitable for use in application logic. This object
+    # possibly originated in a different programming
+    # environment—it should be JSON-like in structure.
+    #
+    # Uses MsgPack data serialization.
+    #
+    # binary - a binary string version of the object
+    #
+    # Examples
+    #
+    #   Primitives.deserialize('')
+    #   # =>
+    #
+    # Returns the Ruby object
+    def self.deserialize binary
+      assertBinary(binary)
+
+      MessagePack.unpack(binary)
+    end
+
+
+    # Public: Overwrite the contents of the buffer with zeroes.
+    # This is critical for removing sensitive data from memory.
+    #
+    # args - binary strings whose content should be wiped
+    #
+    # Examples
+    #
+    #   Primitives.zero('','')
+    #   # =>
+    #
+    # Returns an array of references to the strings which have been zeroed
+    def self.zero *args
+      assertBinary(*args)
+      args.each do |buf|
+        buf.gsub!(/./,"\x00")
+      end
+    end
+
+private
+
+    # Private: Generate an encryption or hmac key from the master key and role.
+    #          Uses SHA256(key || role).  [TODO: link or citation]
+    #
+    # master_key - The 256-bit binary string master key of this secure channel.
+    # role       - The part of the protocol in which this key will be used.
+    #
+    # Examples
+    #
+    #   derive "\x0ER\xE5\x88\xC2\xBB<\xAFZ?\xA5\xCCx\xA6@AB(Bc\x962\x7F:\xF7\x0E\x1Cl\xB9\x02Y\xE4", "some-protocol/some-role"
+    #   # => "~\x80\xB4\xC3>\xC4\xDEw\xB2\xD2\x92\xC9\x88\xA8\xD7p\xAF\xF6Y\x95\x91\xA3\xFDV\xC5qo\x80U\x19P\xB0"
+    #
+    # Returns 256-bit derived key as a 32-byte binary string
+
+    def self.derive master_key, role
+      assertBinary(master_key)
+      assert256BitBinary(master_key)
+      hash = OpenSSL::Digest::SHA256.new
+      hash << master_key
+      hash << role.force_encoding('BINARY')
+      hash.digest
+    end
+
+    def self.assertBinary *binaries
+      binaries.each { |binary| raise "Bad encoding. Binary string required." unless binary.instance_of?(String) && binary.encoding == Encoding::ASCII_8BIT }
+    end
+
+    def self.assert256BitBinary binary
+      raise '256-bit binary string required.' unless binary.size == 32
+    end
+
+    def self.assert128BitBinary binary
+      raise '128-bit binary string required.' unless binary.size == 16
+    end
+
+  end
+
+end

data/lib/simple_secrets/version.rb

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

data/simple_secrets.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_secrets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple-secrets"
+  spec.version       = SimpleSecrets::VERSION
+  spec.authors       = ["Tim Shadel"]
+  spec.email         = ["tim@shadelsoftware.com"]
+  spec.description   = %q{A Ruby client for simple-secrets, the simple, opinionated library for encrypting small packets of data securely.}
+  spec.summary       = %q{A Ruby client for simple-secrets, the simple, opinionated library for encrypting small packets of data securely.}
+  spec.homepage      = "https://github.com/timshadel/simple-secrets.rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "msgpack"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/packet_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+include SimpleSecrets
+
+describe Packet do
+
+  let(:master_key){ "cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd".force_encoding 'BINARY' }
+  let(:data){ 'foobar' }
+  let(:nonce){ '11'.hex_to_bin 16 }  # Generated with Primitives.nonce
+
+  let(:test_body){ "\x11\x11\x11\x11\x11\x11\x11\x11\x11\x11\x11\x11\x11\x11\x11\x11\xA6foobar".force_encoding 'BINARY' }
+  let(:bad_id){ 'fd'.hex_to_bin 6 }
+  let(:bad_mac){ 'fd'.hex_to_bin 32 }
+
+  subject{ Packet.new master_key }
+
+  describe '#initialize' do
+    it 'sets its master key' do
+      its_key = subject.instance_variable_get(:@master_key)
+      its_key.unpack('H*').first.should eq master_key
+      its_key.encoding.should eq Encoding::ASCII_8BIT
+    end
+
+    it 'sets its identity' do
+      identity = Primitives.identify subject.instance_variable_get(:@master_key)
+      subject.instance_variable_get(:@identity).should eq identity
+    end
+  end
+
+  describe '#build_body' do
+    it 'concatenates the serialized body with a nonce' do
+      Primitives.should_receive(:nonce){ nonce }
+      subject.build_body(data).should eq test_body
+    end
+  end
+
+  describe '#body_to_data' do
+    it 'it splits out the nonce and deserializes the body' do
+      subject.body_to_data(test_body).should eq data
+    end
+  end
+
+  describe '#encrypt_body and #decrypt_body' do
+    it 'encrypts the data and then decrypts it back' do
+      key = subject.instance_variable_get(:@master_key)
+
+      cipher_data = subject.encrypt_body test_body, key
+      decrypted_body = subject.decrypt_body cipher_data, key
+      test_body.should_not eq cipher_data
+      cipher_data.should_not eq decrypted_body
+      decrypted_body.should eq test_body
+    end
+  end
+
+  describe '#authenticate and #verify' do
+    it 'creates an authentication signature and then verifies it' do
+      key = subject.instance_variable_get(:@master_key)
+      id = subject.instance_variable_get(:@identity)
+
+      packet = subject.authenticate test_body, key, id
+      data = subject.verify packet, key, id
+      data.should eq test_body
+    end
+
+    it 'returns nil if the key identity does not match' do
+      key = subject.instance_variable_get(:@master_key)
+      id = subject.instance_variable_get(:@identity)
+
+      packet = subject.authenticate test_body, key, bad_id
+      data = subject.verify packet, key, id
+      data.should be_nil
+    end
+
+    it 'returns nil if the MAC does not match' do
+      key = subject.instance_variable_get(:@master_key)
+      id = subject.instance_variable_get(:@identity)
+
+      packet = subject.authenticate test_body, key, id
+      packet = "#{packet[0...-32]}#{bad_mac}"
+
+      data = subject.verify packet, key, id
+      data.should be_nil
+    end
+  end
+
+  describe '.pack and .unpack' do
+    it 'encrypts and signs data into web-safe string, then verifies and decrypts it back' do
+      packed_data = subject.pack data
+      packed_data.should_not eq data
+
+      unpacked_data = subject.unpack packed_data
+      unpacked_data.should eq data
+    end
+  end
+end

data/spec/primitives_spec.rb

@@ -0,0 +1,362 @@
+require 'spec_helper'
+
+include SimpleSecrets
+
+describe Primitives do
+
+  describe 'nonce' do
+    it 'should return 16 random bytes' do
+      expect(Primitives.nonce.size).to eq(16)
+      expect(Primitives.nonce).to_not eq(Primitives.nonce)
+    end
+  end
+
+  describe 'derive_sender_hmac' do
+    it 'should require a buffer' do
+      buf = "32".hex_to_bin(32)
+      expect { Primitives.derive_sender_hmac('') }.to raise_error(/binary string required/i)
+      expect { Primitives.derive_sender_hmac(buf) }.to_not raise_error
+    end
+
+    it 'should require a 256-bit key' do
+      short = "33".hex_to_bin(31)
+      exact = "33".hex_to_bin(32)
+      long = "33".hex_to_bin(33)
+
+      expect { Primitives.derive_sender_hmac(short) }.to raise_error(/256-bit/i)
+      expect(Primitives.derive_sender_hmac(exact).encoding).to eq(Encoding::ASCII_8BIT)
+      expect { Primitives.derive_sender_hmac(long)  }.to raise_error(/256-bit/i)
+    end
+
+    it 'should derive a 256-bit hmac key from a 256-bit master key' do
+      master_key = 'bc'.hex_to_bin(32)
+
+      hmac_key = Primitives.derive_sender_hmac(master_key);
+      expect(hmac_key.size).to eq(32)
+      expect(hmac_key).to eq('1e2e2725f135463f05c268ffd1c1687dbc9dd7da65405697471052236b3b3088'.hex_to_bin);
+    end
+  end
+
+  describe 'derive_sender_key' do
+    it 'should require a buffer' do
+      buf = "32".hex_to_bin(32)
+      expect { Primitives.derive_sender_key('') }.to raise_error(/binary string required/i)
+      expect { Primitives.derive_sender_key(buf) }.to_not raise_error
+    end
+
+    it 'should require a 256-bit key' do
+      short = "33".hex_to_bin(31)
+      exact = "33".hex_to_bin(32)
+      long = "33".hex_to_bin(33)
+
+      expect { Primitives.derive_sender_key(short) }.to raise_error(/256-bit/i)
+      expect(Primitives.derive_sender_key(exact).encoding).to eq(Encoding::ASCII_8BIT)
+      expect { Primitives.derive_sender_key(long)  }.to raise_error(/256-bit/i)
+    end
+
+    it 'should derive a 256-bit encryption key from a 256-bit master key' do
+      master_key = 'bc'.hex_to_bin(32)
+
+      hmac_key = Primitives.derive_sender_key(master_key);
+      expect(hmac_key.size).to eq(32)
+      expect(hmac_key).to eq('327b5f32d7ff0beeb0a7224166186e5f1fc2ba681092214a25b1465d1f17d837'.hex_to_bin);
+    end
+  end
+
+  describe 'derive_receiver_hmac' do
+    it 'should require a buffer' do
+      buf = "32".hex_to_bin(32)
+      expect { Primitives.derive_receiver_hmac('') }.to raise_error(/binary string required/i)
+      expect { Primitives.derive_receiver_hmac(buf) }.to_not raise_error
+    end
+
+    it 'should require a 256-bit key' do
+      short = "33".hex_to_bin(31)
+      exact = "33".hex_to_bin(32)
+      long = "33".hex_to_bin(33)
+
+      expect { Primitives.derive_receiver_hmac(short) }.to raise_error(/256-bit/i)
+      expect(Primitives.derive_receiver_hmac(exact).encoding).to eq(Encoding::ASCII_8BIT)
+      expect { Primitives.derive_receiver_hmac(long)  }.to raise_error(/256-bit/i)
+    end
+
+    it 'should derive a 256-bit hmac key from a 256-bit master key' do
+      master_key = 'bc'.hex_to_bin(32)
+
+      hmac_key = Primitives.derive_receiver_hmac(master_key);
+      expect(hmac_key.size).to eq(32)
+      expect(hmac_key).to eq('375f52dff2a263f2d0e0df11d252d25ba18b2f9abae1f0cbf299bab8d8c4904d'.hex_to_bin);
+    end
+  end
+
+  describe 'derive_receiver_key' do
+    it 'should require a buffer' do
+      buf = "32".hex_to_bin(32)
+      expect { Primitives.derive_receiver_key('') }.to raise_error(/binary string required/i)
+      expect { Primitives.derive_receiver_key(buf) }.to_not raise_error
+    end
+
+    it 'should require a 256-bit key' do
+      short = "33".hex_to_bin(31)
+      exact = "33".hex_to_bin(32)
+      long = "33".hex_to_bin(33)
+
+      expect { Primitives.derive_receiver_key(short) }.to raise_error(/256-bit/i)
+      expect(Primitives.derive_receiver_key(exact).encoding).to eq(Encoding::ASCII_8BIT)
+      expect { Primitives.derive_receiver_key(long)  }.to raise_error(/256-bit/i)
+    end
+
+    it 'should derive a 256-bit encryption key from a 256-bit master key' do
+      master_key = 'bc'.hex_to_bin(32)
+
+      hmac_key = Primitives.derive_receiver_key(master_key);
+      expect(hmac_key.size).to eq(32)
+      expect(hmac_key).to eq('c7e2a9660369f243aed71b0de0c49ee69719d20261778fdf39991a456566ef22'.hex_to_bin);
+    end
+  end
+
+  describe 'encrypt' do
+    it 'should require a buffer' do
+      buf = "32".hex_to_bin(32)
+      expect { Primitives.encrypt('', '') }.to raise_error(/binary string required/i)
+      expect { Primitives.encrypt('', buf) }.to raise_error(/binary string required/i)
+      expect { Primitives.encrypt(buf, '') }.to raise_error(/binary string required/i)
+      expect { Primitives.encrypt(buf, buf) }.to_not raise_error
+    end
+
+    it 'should encrypt data using a 256-bit key' do
+      key = 'cd'.hex_to_bin(32)
+      data = '11'.hex_to_bin(25)
+
+      binmessage = Primitives.encrypt(data, key)
+      iv = binmessage[0...16]
+      ciphertext = binmessage[16..-1]
+
+      expect(iv.size).to eq(16)
+      expect(ciphertext.size).to eq(32)
+      recovered = Primitives.decrypt(ciphertext, key, iv)
+      expect(recovered).to eq(data)
+    end
+
+    it 'should return a Buffer of (iv || ciphertext)' do
+      key = 'cd'.hex_to_bin(32)
+      data = '11'.hex_to_bin(25)
+
+      output = Primitives.encrypt(data, key)
+      expect(output.encoding).to eq(Encoding::ASCII_8BIT)
+      # 16-byte IV, 32 bytes to encrypt the 25 data bytes
+      expect(output.size).to eq(48)
+    end
+  end
+
+  describe 'decrypt' do
+    it 'should require a buffer' do
+      buf = "32".hex_to_bin(32)
+      expect { Primitives.decrypt('', '', '') }.to raise_error(/binary string required/i)
+      expect { Primitives.decrypt('', '', buf) }.to raise_error(/binary string required/i)
+      expect { Primitives.decrypt('', buf, '') }.to raise_error(/binary string required/i)
+      expect { Primitives.decrypt(buf, '', '') }.to raise_error(/binary string required/i)
+      expect { Primitives.decrypt(buf, buf, '') }.to raise_error(/binary string required/i)
+      expect { Primitives.decrypt(buf, '', buf) }.to raise_error(/binary string required/i)
+      expect { Primitives.decrypt('', buf, buf) }.to raise_error(/binary string required/i)
+    end
+
+    it 'should decrypt data using a 256-bit key' do
+      key = "cd".hex_to_bin(32)
+      plaintext = "11".hex_to_bin(25)
+      iv = 'd4a5794c81015dde3b9b0648f2b9f5b9'.hex_to_bin
+      ciphertext = 'cb7f804ec83617144aa261f24af07023a91a3864601a666edea98938f2702dbc'.hex_to_bin
+
+      recovered = Primitives.decrypt(ciphertext, key, iv)
+      expect(recovered).to eq(plaintext)
+    end
+  end
+
+  describe 'identify' do
+    it 'should require a buffer' do
+      buf = "32".hex_to_bin(10)
+      expect { Primitives.identify('') }.to raise_error(/binary string required/i)
+      expect { Primitives.identify(buf) }.to_not raise_error
+    end
+
+    it 'should calculate an id for a key' do
+      key = "ab".hex_to_bin(32)
+      id = Primitives.identify(key)
+
+      expect(id.size).to eq(6)
+      expect(id).to eq('0d081b0889d7'.hex_to_bin)
+    end
+  end
+
+  describe 'mac' do
+    it 'should create a message authentication code' do
+      key = "9f".hex_to_bin(32)
+      data = "11".hex_to_bin(25)
+      mac = Primitives.mac(data, key)
+
+      expect(mac.size).to eq(32)
+      expect(mac).to eq('adf1793fdef44c54a2c01513c0c7e4e71411600410edbde61558db12d0a01c65'.hex_to_bin)
+    end
+  end
+
+  describe 'compare' do
+    it 'should require a buffer' do
+      buf = "32".hex_to_bin(10)
+      expect { Primitives.compare('', '') }.to raise_error(/binary string required/i)
+      expect { Primitives.compare('', buf) }.to raise_error(/binary string required/i)
+      expect { Primitives.compare(buf, '') }.to raise_error(/binary string required/i)
+      expect { Primitives.compare(buf, buf) }.to_not raise_error
+    end
+
+    it 'should correctly distinguish data equality' do
+      a = "11".hex_to_bin
+      b = "12".hex_to_bin
+      c = "11".hex_to_bin
+
+      expect(Primitives.compare(a,a)).to be_true
+      expect(Primitives.compare(a,b)).to be_false
+      expect(Primitives.compare(a,c)).to be_true
+    end
+
+    # Timing test, in progress from node.js version
+    # # (node.js) This works fine locally, but has tons of variation on build server
+    # it 'should take just as long to compare different data as identical data', :skip => true do
+    #   a = "ff".hex_to_bin(250000)
+    #   b = "00".hex_to_bin(250000)
+    #   c = "ff".hex_to_bin(250000)
+    #
+    #   benchAA = benchmark(primitives.compare, a, a)
+    #   benchAB = benchmark(primitives.compare, a, b)
+    #   benchAC = benchmark(primitives.compare, a, c)
+    #
+    #   naiveAA = benchmark(naiveEquals, a, a)
+    #   naiveAB = benchmark(naiveEquals, a, b)
+    #   naiveAC = benchmark(naiveEquals, a, c)
+    #
+    #   # All constant-time comparisons should be roughly equal in time
+    #   expect(difference(benchAA, benchAB)).to.be.greaterThan(0.95)
+    #   expect(difference(benchAA, benchAC)).to.be.greaterThan(0.95)
+    #   expect(difference(benchAB, benchAC)).to.be.greaterThan(0.95)
+    #
+    #   # Naive comparisons of the same item with itself, or with obviously
+    #   # different items should be ridiculously fast
+    #   expect(difference(benchAA, naiveAA)).to.be.lessThan(0.01)
+    #   expect(difference(benchAB, naiveAB)).to.be.lessThan(0.01)
+    #
+    #   # It should take just about as long to compare identical arrays as the constant time compare
+    #   expect(difference(benchAC, naiveAC)).to.be.greaterThan(0.90)
+    #
+    #   function naiveEquals(a, b) {
+    #     if (a === b) return true;
+    #     for (var i = 0; i < a.length; i++) {
+    #       if (a[i] !== b[i]) {
+    #         return false;
+    #       }
+    #     }
+    #     return true;
+    #   }
+    #
+    #   function benchmark(fn, a, b) {
+    #     var time = process.hrtime();
+    #     for (var i = 0; i < 100; i++) {
+    #       fn(a, b);
+    #     };
+    #     var diff = process.hrtime(time);
+    #     return diff[0] * 1e9 + diff[1];
+    #   }
+    #
+    #   function difference(first, second) {
+    #     var smaller = Math.min(first, second);
+    #     var larger = Math.max(first, second);
+    #     return (smaller / larger);
+    #   }
+    #
+    # end
+  end
+
+  describe 'binify' do
+    it 'should require a base64url string' do
+      expect { Primitives.binify(123) }.to raise_error(/string required/i)
+      expect { Primitives.binify('arstnei; another.') }.to raise_error(/base64url/i)
+      expect { Primitives.binify('cartinir90_-') }.to_not raise_error
+    end
+
+    it 'should return a Buffer' do
+      bin = Primitives.binify('abcd')
+      expect(bin.encoding).to eq(Encoding::ASCII_8BIT)
+      expect(bin.size).to eq(3)
+    end
+  end
+
+  describe 'stringify' do
+    it 'should require a buffer' do
+      buf = "32".hex_to_bin(10)
+      expect { Primitives.stringify('') }.to raise_error(/binary string required/i)
+      expect { Primitives.stringify(buf) }.to_not raise_error
+    end
+
+    it 'should return a base64url string' do
+      buf = "32".hex_to_bin(10)
+      str = Primitives.stringify(buf)
+      expect(str.encoding).to eq(Encoding::US_ASCII)
+      expect(str.size).to eq(14)
+      expect(str).to match(/^[a-zA-Z0-9_-]+$/)
+    end
+  end
+
+  describe 'serialize' do
+    it 'should accept javascript object' do
+      expect { Primitives.serialize(1) }.to_not raise_error
+      expect { Primitives.serialize('a') }.to_not raise_error
+      expect { Primitives.serialize([]) }.to_not raise_error
+      expect { Primitives.serialize({}) }.to_not raise_error
+    end
+
+    it 'should return a Buffer' do
+      bin = Primitives.serialize('abcd')
+      expect(bin.encoding).to eq(Encoding::ASCII_8BIT)
+      expect(bin.size).to eq(5)
+    end
+  end
+
+  describe 'deserialize' do
+    it 'should require a buffer' do
+      buf = "32".hex_to_bin(10)
+      expect { Primitives.deserialize('') }.to raise_error(/binary string required/i)
+    end
+
+    it 'should return a javascript primitive or object' do
+      expect(Primitives.deserialize(Primitives.serialize(1))).to eq(1)
+      expect(Primitives.deserialize(Primitives.serialize('abcd'))).to eq('abcd')
+      expect(Primitives.deserialize(Primitives.serialize([]))).to eq([])
+      expect(Primitives.deserialize(Primitives.serialize({}))).to eq({})
+    end
+  end
+
+  describe 'zero' do
+    it 'should require a Buffer' do
+      expect { Primitives.zero({}) }.to raise_error(/binary string required/i)
+    end
+
+    it 'should overwrite all buffer contents with zeros' do
+      b = '7468697320697320736f6d65'.hex_to_bin
+      z = '000000000000000000000000'.hex_to_bin
+
+      expect(b).to_not eq(z)
+      Primitives.zero(b)
+      expect(b).to eq(z)
+    end
+
+    it 'should zero multiple buffers' do
+      b = '7468697320697320736f6d65'.hex_to_bin
+      c = '697320736f6d657468697320'.hex_to_bin
+      z = '000000000000000000000000'.hex_to_bin
+
+      expect(b).to_not eq(z)
+      expect(c).to_not eq(z)
+      Primitives.zero(b, c)
+      expect(b).to eq(z)
+      expect(c).to eq(z)
+    end
+  end
+end

data/spec/simple_secrets_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SimpleSecrets do
+  it 'should have a version number' do
+    SimpleSecrets::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'simple_secrets'
+
+
+class String
+  def hex_to_bin repeat=1
+    [self*repeat].pack('H*')
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: simple-secrets
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tim Shadel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client for simple-secrets, the simple, opinionated library for
+  encrypting small packets of data securely.
+email:
+- tim@shadelsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple-secrets.rb
+- lib/simple_secrets.rb
+- lib/simple_secrets/packet.rb
+- lib/simple_secrets/primitives.rb
+- lib/simple_secrets/version.rb
+- simple_secrets.gemspec
+- spec/packet_spec.rb
+- spec/primitives_spec.rb
+- spec/simple_secrets_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/timshadel/simple-secrets.rb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Ruby client for simple-secrets, the simple, opinionated library for encrypting
+  small packets of data securely.
+test_files:
+- spec/packet_spec.rb
+- spec/primitives_spec.rb
+- spec/simple_secrets_spec.rb
+- spec/spec_helper.rb