conceal 0.1.0

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in conceal.gemspec
+gemspec
+
+gem 'fuubar', '~> 2.0'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Scott
+
+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,33 @@
+# Conceal
+
+Simple OpenSSL-based string encryption using a shared secret. The algorithm, initialization vector, salt, crypttext, and HMAC are all encoded into a single string
+so it is easy to copy around.
+
+## Requirements
+
+* Ruby 1.9.3 or newer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'conceal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install conceal
+
+## Usage
+
+```ruby
+encrypted = Conceal.encrypt('some plaintext', key: 'your shared secret', algorithm: 'aes-256-cbc')
+decrypted = Conceal.decrypt(encrypted, key: 'your shared secret')
+```
+
+## Authors
+
+* Ben Scott (<gamepoet@gmail.com>)

data/Rakefile

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

data/bin/decrypt

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'conceal'
+require 'optparse'
+
+class Options < Struct.new(:trailing_newline)
+end
+
+def main
+  opts = Options.new
+  opts.trailing_newline = true
+
+  OptionParser.new do |o|
+    o.banner = 'Usage: decrypt KEY_FILE'
+    o.on('-h', '--help', 'show this message') do
+      puts o
+      exit(0)
+    end
+    o.on('-n', "don't print the trailing newline") do
+      opts.trailing_newline = false
+    end
+    o.on('-v', '--version', 'print the version') do
+      puts Conceal::VERSION
+    end
+  end.parse!(ARGV)
+
+  # read the key file
+  if ARGV.empty?
+    $stderr.puts "Missing KEY_FILE argument"
+    exit(1)
+  end
+  key_file = ARGV.shift
+  key = IO.read(key_file)
+
+  # decrypt from stdin
+  encrypted_data = $stdin.read
+  plaintext = Conceal.decrypt(encrypted_data, key: key)
+
+  $stdout.write(plaintext)
+  $stdout.write("\n") if opts.trailing_newline
+end
+
+main

data/bin/encrypt

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'conceal'
+require 'optparse'
+
+class Options < Struct.new(:trailing_newline)
+end
+
+def main
+  opts = Options.new
+  opts.trailing_newline = true
+
+  OptionParser.new do |o|
+    o.banner = 'Usage: encrypt KEY_FILE'
+    o.on('-h', '--help', 'show this message') do
+      puts o
+      exit(0)
+    end
+    o.on('-n', "don't print the trailing newline") do
+      opts.trailing_newline = false
+    end
+    o.on('-v', '--version', 'print the version') do
+      puts Conceal::VERSION
+    end
+  end.parse!(ARGV)
+
+  # read the key file
+  if ARGV.empty?
+    $stderr.puts "Missing KEY_FILE argument"
+    exit(1)
+  end
+  key_file = ARGV.shift
+  key = IO.read(key_file)
+
+  # encrypt from stdin
+  plaintext = $stdin.read
+  encrypted_data = Conceal.encrypt(plaintext, key: key)
+
+  $stdout.write(encrypted_data)
+  $stdout.write("\n") if opts.trailing_newline
+end
+
+main

data/conceal.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'conceal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'conceal'
+  spec.version       = Conceal::VERSION
+  spec.authors       = ['Ben Scott']
+  spec.email         = ['gamepoet@gmail.com']
+  spec.summary       = 'Simple OpenSSL-based string encryption.'
+  spec.description   = 'Encrypts and decrypts strings using OpenSSL.'
+  spec.homepage      = 'https://github.com/gamepoet/conceal'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake',    '>= 0.8.7'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+end

data/lib/conceal/version.rb

@@ -0,0 +1,3 @@
+module Conceal
+  VERSION = '0.1.0'
+end

data/lib/conceal.rb

@@ -0,0 +1,91 @@
+require 'conceal/version'
+require 'base64'
+require 'openssl'
+require 'securerandom'
+
+module Conceal
+  class << self
+    FORMAT_VERSION  = 1
+    FIELD_SEPARATOR = ':'
+
+    # Encrypts the given plaintext string.
+    #
+    # @param plaintext  [String]  the plaintext string to encrypt
+    # @param opts       [Hash]    additional options
+    #
+    # @option opts [String] :algorithm  the cipher algorithm to use (defaults to 'aes-25c-cbc')
+    # @option opts [String] :key        the secret shared key
+    def encrypt(plaintext, opts = {})
+      opts = {
+        algorithm: 'aes-256-cbc',
+      }.merge(opts)
+      key       = opts[:key]
+      algorithm = opts[:algorithm]
+      raise ArgumentError.new(':key option missing') if key.to_s.empty?
+      salt = SecureRandom.hex(128)
+
+      # setup the cipher
+      cipher = OpenSSL::Cipher::Cipher.new(algorithm)
+      cipher.encrypt
+      iv = cipher.random_iv
+      cipher.iv = iv
+      cipher.key = OpenSSL::PKCS5.pbkdf2_hmac_sha1(key, salt, 2000, cipher.key_len)
+
+      # encrypt
+      ciphertext = cipher.update(plaintext)
+      ciphertext << cipher.final
+
+      # MAC
+      digest = OpenSSL::Digest.new('sha256')
+      hmac = OpenSSL::HMAC.digest(digest, key, ciphertext)
+
+      [
+        FORMAT_VERSION,
+        algorithm,
+        encode64(iv),
+        encode64(salt),
+        encode64(hmac),
+        encode64(ciphertext),
+      ].join(FIELD_SEPARATOR)
+    end
+
+    # Decrypts the given encrypted string.
+    #
+    # @param data [String]    the encrypted string to decrypt
+    # @param opts [Hash]      additional options
+    #
+    # @option opts [String] :key    the secret shared key
+    def decrypt(data, opts = {})
+      key = opts[:key]
+      raise ArgumentError.new(':key option missing') if key.to_s.empty?
+
+      ver, algorithm, iv64, salt64, hmac64, ciphertext64 = data.split(FIELD_SEPARATOR, 6)
+      raise ArgumentError.new('ciphertext has unknown version') unless ver == FORMAT_VERSION.to_s
+
+      iv         = Base64.decode64(iv64)
+      salt       = Base64.decode64(salt64)
+      hmac       = Base64.decode64(hmac64)
+      ciphertext = Base64.decode64(ciphertext64)
+
+      # validate the hmac
+      digest = OpenSSL::Digest.new('sha256')
+      actual_hmac = OpenSSL::HMAC.digest(digest, key, ciphertext)
+      raise ArgumentError.new('HMAC mismatch') unless actual_hmac == hmac
+
+      # decrypt
+      cipher = OpenSSL::Cipher::Cipher.new(algorithm)
+      cipher.decrypt
+      cipher.iv = iv
+      cipher.key = OpenSSL::PKCS5.pbkdf2_hmac_sha1(key, salt, 2000, cipher.key_len)
+
+      plaintext = cipher.update(ciphertext)
+      plaintext << cipher.final
+      plaintext
+    end
+
+    private
+      def encode64(value)
+        Base64.encode64(value).gsub(/[\r\n]/, '')
+      end
+  end
+end

data/spec/conceal_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Conceal do
+  let(:key) { SecureRandom.hex(128) }
+
+  it 'has a version number' do
+    expect(Conceal::VERSION).not_to be nil
+  end
+
+  it 'encrypt then decrypt returns the same original plaintext' do
+    expect(Conceal.decrypt(Conceal.encrypt('hello', key: key), key: key)).to eq('hello')
+  end
+
+  describe '#encrypt' do
+    it 'does not return the plaintext' do
+      expect(Conceal.encrypt('hello', key: key)).not_to eq('hello')
+    end
+
+    it 'outputs different values each time (different iv/salt)' do
+      first  = Conceal.encrypt('hello', key: key)
+      second = Conceal.encrypt('hello', key: key)
+
+      expect(first).not_to eq(second)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'conceal'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: conceal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Encrypts and decrypts strings using OpenSSL.
+email:
+- gamepoet@gmail.com
+executables:
+- decrypt
+- encrypt
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/decrypt
+- bin/encrypt
+- conceal.gemspec
+- lib/conceal.rb
+- lib/conceal/version.rb
+- spec/conceal_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gamepoet/conceal
+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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3065879142632505148
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Simple OpenSSL-based string encryption.
+test_files:
+- spec/conceal_spec.rb
+- spec/spec_helper.rb