crypt_keeper_providers 0.1.0 → 0.2.0

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/debug.log
+spec/database.yml

data/.travis.yml

@@ -1,5 +1,12 @@
 language: ruby
-script: "bundle exec rake spec"
+gemfile:
+  - gemfiles/activerecord_3_0.gemfile
+  - gemfiles/activerecord_3_1.gemfile
+  - gemfiles/activerecord_3_2.gemfile
+before_script:
+  - cp spec/default.database.yml spec/database.yml
+  - psql -c 'CREATE DATABASE crypt_keeper_providers;' -U postgres
+  - psql crypt_keeper_providers -c 'CREATE EXTENSION IF NOT EXISTS pgcrypto;' -U postgres
 notifications:
   email:
     recipients:
@@ -9,4 +16,6 @@ notifications:
 rvm:
   - 1.9.2
   - 1.9.3
-  - jruby-19mode
+
+jdk:
+  - openjdk7

data/Appraisals

@@ -0,0 +1,14 @@
+appraise "activerecord_3_0" do
+  gem 'activerecord',  '~> 3.0'
+  gem 'activesupport', '~> 3.0'
+end
+
+appraise "activerecord_3_1" do
+  gem 'activerecord',  '~> 3.1'
+  gem 'activesupport', '~> 3.1'
+end
+
+appraise "activerecord_3_2" do
+  gem 'activerecord',  '~> 3.2'
+  gem 'activesupport', '~> 3.2'
+end

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', version: 2, fail_fast: true, all_on_start: false, all_after_pass: false do
+guard 'rspec', version: 2, all_on_start: false, all_after_pass: false, cli: '--fail-fast' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://secure.travis-ci.org/jmazzi/crypt_keeper_providers.png?branch=master)](http://travis-ci.org/jmazzi/crypt_keeper_providers)
+
 # CryptKeeperProviders
 
 Provides encryption classes for use with [crypt_keeper](https://github.com/jmazzi/crypt_keeper)

data/Rakefile

@@ -1,6 +1,7 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
+require 'appraisal'
 
 RSpec::Core::RakeTask.new :spec
 Bundler::GemHelper.install_tasks

data/crypt_keeper_providers.gemspec

@@ -19,7 +19,13 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'guard', '~> 1.2.0'
   gem.add_development_dependency 'guard-rspec', '~> 1.1.0'
   gem.add_development_dependency 'rake', '~> 0.9.2.2'
-  gem.add_development_dependency 'jruby-openssl', '~> 0.7.7' if RUBY_PLATFORM == 'java'
-
+  gem.add_development_dependency 'activerecord', '>= 3.0'
+  gem.add_development_dependency 'appraisal', '~> 0.4.1'
 
+  if RUBY_PLATFORM == 'java'
+    gem.add_development_dependency 'jruby-openssl', '~> 0.7.7'
+    gem.add_development_dependency 'activerecord-jdbcpostgresql-adapter'
+  else
+    gem.add_development_dependency 'pg', '~> 0.14.0'
+  end
 end

data/gemfiles/activerecord_3_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.0"
+gem "activesupport", "~> 3.0"
+
+gemspec :path=>"../"

data/gemfiles/activerecord_3_0.gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: /home/justin/work/ruby/crypt_keeper_providers
+  specs:
+    crypt_keeper_providers (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.7)
+      activesupport (= 3.2.7)
+      builder (~> 3.0.0)
+    activerecord (3.2.7)
+      activemodel (= 3.2.7)
+      activesupport (= 3.2.7)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    ffi (1.1.1)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.1.0)
+      guard (>= 1.1)
+    i18n (0.6.0)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    multi_json (1.3.6)
+    pg (0.14.0)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    thor (0.15.4)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0)
+  activesupport (~> 3.0)
+  appraisal (~> 0.4.1)
+  crypt_keeper_providers!
+  guard (~> 1.2.0)
+  guard-rspec (~> 1.1.0)
+  pg (~> 0.14.0)
+  rake (~> 0.9.2.2)
+  rspec (~> 2.10.0)

data/gemfiles/activerecord_3_1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.1"
+gem "activesupport", "~> 3.1"
+
+gemspec :path=>"../"

data/gemfiles/activerecord_3_1.gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: /home/justin/work/ruby/crypt_keeper_providers
+  specs:
+    crypt_keeper_providers (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.7)
+      activesupport (= 3.2.7)
+      builder (~> 3.0.0)
+    activerecord (3.2.7)
+      activemodel (= 3.2.7)
+      activesupport (= 3.2.7)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    ffi (1.1.1)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.1.0)
+      guard (>= 1.1)
+    i18n (0.6.0)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    multi_json (1.3.6)
+    pg (0.14.0)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    thor (0.15.4)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.1)
+  activesupport (~> 3.1)
+  appraisal (~> 0.4.1)
+  crypt_keeper_providers!
+  guard (~> 1.2.0)
+  guard-rspec (~> 1.1.0)
+  pg (~> 0.14.0)
+  rake (~> 0.9.2.2)
+  rspec (~> 2.10.0)

data/gemfiles/activerecord_3_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2"
+gem "activesupport", "~> 3.2"
+
+gemspec :path=>"../"

data/gemfiles/activerecord_3_2.gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: /home/justin/work/ruby/crypt_keeper_providers
+  specs:
+    crypt_keeper_providers (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.7)
+      activesupport (= 3.2.7)
+      builder (~> 3.0.0)
+    activerecord (3.2.7)
+      activemodel (= 3.2.7)
+      activesupport (= 3.2.7)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    ffi (1.1.1)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.1.0)
+      guard (>= 1.1)
+    i18n (0.6.0)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    multi_json (1.3.6)
+    pg (0.14.0)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    thor (0.15.4)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2)
+  activesupport (~> 3.2)
+  appraisal (~> 0.4.1)
+  crypt_keeper_providers!
+  guard (~> 1.2.0)
+  guard-rspec (~> 1.1.0)
+  pg (~> 0.14.0)
+  rake (~> 0.9.2.2)
+  rspec (~> 2.10.0)

data/lib/crypt_keeper_providers/aes.rb

@@ -1,4 +1,4 @@
-require 'digest/sha1'
+require 'digest/sha2'
 require 'openssl'
 require 'base64'
 
@@ -6,39 +6,45 @@ module CryptKeeperProviders
   class Aes
     SEPARATOR = ":crypt_keeper:"
 
-    attr_accessor :key, :aes
+    # Public: The encryption key
+    attr_accessor :key
+
+    # Public: An instance of  OpenSSL::Cipher::Cipher
+    attr_accessor :aes
 
     # Public: Initializes the class
     #
-    #   options - A hash of options. :passphrase is required
+    #   options - A hash of options. :key is required
     def initialize(options = {})
-      @key         = options[:passphrase]
       @aes         = ::OpenSSL::Cipher::Cipher.new("AES-256-CBC")
       @aes.padding = 1
-      @key         = Digest::SHA256.digest(key)
+
+      key = options.fetch(:key) do
+        raise ArgumentError, "Missing :key"
+      end
+
+      @key = Digest::SHA256.digest(key)
     end
 
     # Public: Encrypt a string
     #
     # Returns a string
     def encrypt(value)
-      value = value.to_s
       aes.encrypt
       aes.key = key
-      iv = rand.to_s
-      aes.iv = iv
-      Base64::encode64("#{iv}#{SEPARATOR}#{aes.update(value) + aes.final}")
+      iv      = rand.to_s
+      aes.iv  = iv
+      Base64::encode64("#{iv}#{SEPARATOR}#{aes.update(value.to_s) + aes.final}")
     end
 
     # Public: Decrypt a string
     #
     # Returns a string
     def decrypt(value)
-      value = Base64::decode64(value.to_s)
-      iv, value = value.split(SEPARATOR)
+      iv, value = Base64::decode64(value.to_s).split(SEPARATOR)
       aes.decrypt
       aes.key = key
-      aes.iv = iv
+      aes.iv  = iv
       aes.update(value) + aes.final
     end
   end

data/lib/crypt_keeper_providers/postgres_pgp/log_subscriber.rb

@@ -0,0 +1,27 @@
+require 'active_support/concern'
+require 'active_support/lazy_load_hooks'
+
+module CryptKeeperProviders
+  module PostgresPgpLogSubscriber
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :sql, :filter
+    end
+
+    # Public: Prevents sensitive data from being logged
+    def sql_with_filter(event)
+      filter = /(pgp_sym_(encrypt|decrypt))\(((.|\n)*?)\)/i
+
+      event.payload[:sql] = event.payload[:sql].gsub(filter) do |_|
+        "#{$1}([FILTERED])"
+      end
+
+      sql_without_filter(event)
+    end
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::LogSubscriber.send :include, CryptKeeperProviders::PostgresPgpLogSubscriber
+end

data/lib/crypt_keeper_providers/postgres_pgp.rb

@@ -0,0 +1,38 @@
+require 'crypt_keeper_providers/postgres_pgp/log_subscriber'
+
+module CryptKeeperProviders
+  class PostgresPgp
+    attr_accessor :key
+
+    # Public: Initializes the encryptor
+    #
+    #  options - A hash, :key is required
+    def initialize(options = {})
+      @key = options.fetch(:key) do
+        raise ArgumentError, "Missing :key"
+      end
+    end
+
+    # Public: Encrypts a string
+    #
+    # Returns an encrypted string
+    def encrypt(value)
+      escape_and_execute_sql(["SELECT pgp_sym_encrypt(?, ?)", value, key])['pgp_sym_encrypt']
+    end
+
+    # Public: Decrypts a string
+    #
+    # Returns a plaintext string
+    def decrypt(value)
+      escape_and_execute_sql(["SELECT pgp_sym_decrypt(?, ?)", value, key])['pgp_sym_decrypt']
+    end
+
+    private
+
+    # Private: Sanitize an sql query and then execute it
+    def escape_and_execute_sql(query)
+      query = ::ActiveRecord::Base.send :sanitize_sql_array, query
+      ::ActiveRecord::Base.connection.execute(query).first
+    end
+  end
+end

data/lib/crypt_keeper_providers/version.rb

@@ -1,3 +1,3 @@
 module CryptKeeperProviders
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/crypt_keeper_providers.rb

@@ -1,5 +1,6 @@
 require 'crypt_keeper_providers/version'
 require 'crypt_keeper_providers/aes'
+require 'crypt_keeper_providers/postgres_pgp'
 
 module CryptKeeperProviders
 end

data/spec/aes_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module CryptKeeperProviders
   describe Aes do
-    subject { Aes.new(passphrase: 'cake') }
+    subject { Aes.new(key: 'cake') }
 
     describe "#initialize" do
       let(:hexed_key) do
@@ -12,6 +12,10 @@ module CryptKeeperProviders
       it "should extract the key and digest it" do
         subject.key.should == hexed_key
       end
+
+      it "should raise an exception with a missing key" do
+        expect { Aes.new }.to raise_error(ArgumentError, "Missing :key")
+      end
     end
 
     describe "#encrypt" do

data/spec/default.database.yml

@@ -0,0 +1,8 @@
+test:
+  adapter: postgresql
+  encoding: utf8
+  reconnect: false
+  database: crypt_keeper_providers
+  pool: 5
+  username: postgres
+  password:

data/spec/postgres_sql_log_subscriber_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module CryptKeeperProviders
+  describe PostgresPgpLogSubscriber do
+    use_postgres
+
+    subject { ::ActiveRecord::LogSubscriber.new }
+
+    let(:input_query) do
+      "SELECT pgp_sym_encrypt('encrypt_value', 'encrypt_key'), pgp_sym_decrypt('decrypt_value', 'decrypt_key') FROM DUAL;"
+    end
+
+    let(:output_query) do
+      "SELECT pgp_sym_encrypt([FILTERED]), pgp_sym_decrypt([FILTERED]) FROM DUAL;"
+    end
+
+    it "filters pgp functions" do
+      subject.should_receive(:sql_without_filter).with do |event|
+        event.payload[:sql].should == output_query
+      end
+
+      subject.sql(ActiveSupport::Notifications::Event.new(:sql, 1, 1, 1, { sql: output_query }))
+    end
+  end
+end

data/spec/postgres_sql_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+module CryptKeeperProviders
+  describe PostgresPgp do
+    use_postgres
+
+    let(:cipher_text) { '\\xc30d0407030283b15f71b6a7d0296cd23501bd2c8fe3c7a56005ff4619527c4291509a78c77a6758cddd2a14acbde589fa10b3e0686865182d3beadaf237b9f928e7ba1810b8' }
+    let(:plain_text) { 'test' }
+
+    subject { PostgresPgp.new key: 'candy' }
+
+    its(:key) { should == 'candy' }
+
+    describe "#initialize" do
+      it "should raise an exception with a missing key" do
+        expect { PostgresPgp.new }.to raise_error(ArgumentError, "Missing :key")
+      end
+    end
+
+    describe "#encrypt" do
+      it "should encrypt the string" do
+        subject.encrypt(plain_text).should_not == plain_text
+        subject.encrypt(plain_text).should_not be_empty
+      end
+    end
+
+    describe "#decrypt" do
+      it "should decrypt the string" do
+        subject.decrypt(cipher_text).should == plain_text
+      end
+    end
+  end
+end

data/spec/support/active_record.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+require 'logger'
+require 'yaml'
+
+module CryptKeeperProviders
+  module ActiveRecord
+    # extend self
+
+    def use_postgres
+      before :all do
+        config = YAML.load_file SPEC_ROOT.join('database.yml')
+        ::ActiveRecord::Base.establish_connection(config['test'])
+        ::ActiveRecord::Base.logger = Logger.new SPEC_ROOT.join('debug.log').to_s
+      end
+    end
+  end
+end
+
+
+RSpec.configure do |config|
+  config.extend CryptKeeperProviders::ActiveRecord
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crypt_keeper_providers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -75,6 +75,54 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
 description: Encryption providers for crypt_keeper
 email:
 - jmazzi@gmail.com
@@ -85,17 +133,30 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- Appraisals
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - crypt_keeper_providers.gemspec
+- gemfiles/activerecord_3_0.gemfile
+- gemfiles/activerecord_3_0.gemfile.lock
+- gemfiles/activerecord_3_1.gemfile
+- gemfiles/activerecord_3_1.gemfile.lock
+- gemfiles/activerecord_3_2.gemfile
+- gemfiles/activerecord_3_2.gemfile.lock
 - lib/crypt_keeper_providers.rb
 - lib/crypt_keeper_providers/aes.rb
+- lib/crypt_keeper_providers/postgres_pgp.rb
+- lib/crypt_keeper_providers/postgres_pgp/log_subscriber.rb
 - lib/crypt_keeper_providers/version.rb
 - spec/aes_spec.rb
+- spec/default.database.yml
+- spec/postgres_sql_log_subscriber_spec.rb
+- spec/postgres_sql_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_record.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -110,7 +171,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2013321014928306756
+      hash: 533015026195049068
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2013321014928306756
+      hash: 533015026195049068
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -128,4 +189,8 @@ specification_version: 3
 summary: Encryption providers for crypt_keeper
 test_files:
 - spec/aes_spec.rb
+- spec/default.database.yml
+- spec/postgres_sql_log_subscriber_spec.rb
+- spec/postgres_sql_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_record.rb