pivotal-sentry 0.4.0

data/lib/sentry.rb

@@ -0,0 +1,46 @@
+#Copyright (c) 2005 Rick Olson
+#
+#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.
+
+require 'openssl'
+require 'base64'
+require 'sentry/symmetric_sentry'
+require 'sentry/asymmetric_sentry'
+require 'sentry/sha_sentry'
+require 'sentry/symmetric_sentry_callback'
+require 'sentry/asymmetric_sentry_callback'
+
+module Sentry
+  class NoKeyError < StandardError
+  end
+  class NoPublicKeyError < StandardError
+  end
+  class NoPrivateKeyError < StandardError
+  end
+end
+
+begin
+  require 'active_record/sentry'
+  ActiveRecord::Base.class_eval do
+    include ActiveRecord::Sentry
+  end
+rescue NameError
+  nil
+end

data/lib/sentry/asymmetric_sentry.rb

@@ -0,0 +1,144 @@
+module Sentry
+  class AsymmetricSentry
+    attr_reader   :private_key_file
+    attr_reader   :public_key_file
+    attr_accessor :symmetric_algorithm
+    @@default_private_key_file = nil
+    @@default_public_key_file = nil
+    @@default_symmetric_algorithm = nil
+
+    # available options:
+    # * <tt>:private_key_file</tt> - encrypted private key file
+    # * <tt>:public_key_file</tt>  - public key file
+    # * <tt>:symmetric_algorithm</tt> - algorithm to use for SymmetricSentry
+    def initialize(options = {})
+      @public_key = @private_key = nil
+      private_key_file = options[:private_key_file]
+      public_key_file  = options[:public_key_file] || @@default_public_key_file
+      @symmetric_algorithm = options[:symmetric_algorithm] || @@default_symmetric_algorithm
+    end
+  
+    def encrypt(data)
+      raise NoPublicKeyError unless public?
+      public_rsa.public_encrypt(data)
+    end
+  
+    def encrypt_to_base64(data)
+      Base64.encode64(encrypt(data))
+    end
+  
+    def decrypt(data, key = nil)
+      raise NoPrivateKeyError unless private?
+      private_rsa(key).private_decrypt(data)
+    end
+  
+    def decrypt_from_base64(data, key = nil)
+      decrypt(Base64.decode64(data), key)
+    end
+  
+    def private_key_file=(file)
+      @private_key_file = file and load_private_key
+    end
+  
+    def public_key_file=(file)
+      @public_key_file = file and load_public_key
+    end
+  
+    def public?
+      return true unless @public_key.nil?
+      load_public_key and return @public_key
+    end
+  
+    def private?
+      return true unless @private_key.nil?
+      load_private_key and return @private_key
+    end
+
+    class << self
+      # * <tt>:key</tt> - secret password
+      # * <tt>:symmetric_algorithm</tt> - symmetrical algorithm to use
+      def save_random_rsa_key(private_key_file, public_key_file, options = {})
+        rsa = OpenSSL::PKey::RSA.new(512)
+        public_key = rsa.public_key
+        private_key = options[:key].to_s.empty? ? 
+          rsa.to_s :
+          SymmetricSentry.new(:algorithm => options[:symmetric_algorithm]).encrypt_to_base64(rsa.to_s, options[:key])
+        File.open(public_key_file, 'w')  { |f| f.write(public_key) }
+        File.open(private_key_file, 'w') { |f| f.write(private_key) }
+      end
+
+      def encrypt(data)
+        self.new.encrypt(data)
+      end
+  
+      def encrypt_to_base64(data)
+        self.new.encrypt_to_base64(data)
+      end
+  
+      def decrypt(data, key = nil)
+        self.new.decrypt(data, key)
+      end
+  
+      def decrypt_from_base64(data, key = nil)
+        self.new.decrypt_from_base64(data, key)
+      end
+
+      # cattr_accessor would be lovely
+      def default_private_key_file
+        @@default_private_key_file
+      end
+      
+      def default_private_key_file=(value)
+        @@default_private_key_file = value
+      end
+      
+      def default_public_key_file
+        @@default_public_key_file
+      end
+      
+      def default_public_key_file=(value)
+        @@default_public_key_file = value
+      end
+      
+      def default_symmetric_algorithm
+        @@default_symmetric_algorithm
+      end
+      
+      def default_symmetric_algorithm=(value)
+        @@default_symmetric_algorithm = value
+      end
+    end
+  
+    private
+    def encryptor
+      @encryptor ||= SymmetricSentry.new(:algorithm => @symmetric_algorithm)
+    end
+
+    def load_private_key
+      @private_rsa = nil
+      @private_key_file ||= @@default_private_key_file
+      if @private_key_file and File.file?(@private_key_file)
+        @private_key = File.open(@private_key_file) { |f| f.read }
+      end
+    end
+  
+    def load_public_key
+      @public_rsa = nil
+      @public_key_file ||= @@default_public_key_file
+      if @public_key_file and File.file?(@public_key_file)
+        @public_key = File.open(@public_key_file) { |f| f.read }
+      end
+    end
+
+    # retrieves private rsa from encrypted private key
+    def private_rsa(key = nil)
+      return @private_rsa ||= OpenSSL::PKey::RSA.new(@private_key) unless key
+      OpenSSL::PKey::RSA.new(encryptor.decrypt_from_base64(@private_key, key))
+    end
+
+    # retrieves public rsa
+    def public_rsa
+      @public_rsa ||= OpenSSL::PKey::RSA.new(@public_key)
+    end
+  end
+end

data/lib/sentry/asymmetric_sentry_callback.rb

@@ -0,0 +1,17 @@
+module Sentry
+  class AsymmetricSentryCallback
+    def initialize(attr_name)
+      @attr_name = attr_name
+    end
+  
+    # Performs encryption on before_validation Active Record callback
+    #def before_validation(model)
+    #  return if model.send(@attr_name).blank?
+    #  model.send("crypted_#{@attr_name}=", AsymmetricSentry.encrypt_to_base64(model.send(@attr_name)))
+    #end
+    
+    #def after_save(model)
+    #  model.send("#{@attr_name}=", nil)
+    #end
+  end
+end

data/lib/sentry/sha_sentry.rb

@@ -0,0 +1,41 @@
+require 'digest/sha1'
+module Sentry
+  class ShaSentry
+    @@salt = 'salt'
+    attr_accessor :salt
+    
+    # Encrypts data using SHA.
+    def encrypt(data)
+      self.class.encrypt(data + salt.to_s)
+    end
+    
+    # Initialize the class.  
+    # Used by ActiveRecord::Base#generates_crypted to set up as a callback object for a model
+    def initialize(attribute = nil)
+      @attribute = attribute
+    end
+    
+    # Performs encryption on before_validation Active Record callback
+    def before_validation(model)
+      return unless model.send(@attribute)
+      model.send("crypted_#{@attribute}=", encrypt(model.send(@attribute)))
+    end
+        
+    class << self
+      # Gets the class salt value used when encrypting
+      def salt
+        @@salt
+      end
+      
+      # Sets the class salt value used when encrypting
+      def salt=(value)
+        @@salt = value
+      end
+      
+      # Encrypts the data
+      def encrypt(data)
+        Digest::SHA1.hexdigest(data + @@salt)
+      end
+    end
+  end
+end

data/lib/sentry/symmetric_sentry.rb

@@ -0,0 +1,79 @@
+module Sentry
+  class SymmetricSentry
+    @@default_algorithm = 'DES-EDE3-CBC'
+    @@default_key = nil
+    attr_accessor :algorithm
+    def initialize(options = {})
+      @algorithm = options[:algorithm] || @@default_algorithm
+    end
+  
+    def encrypt(data, key = nil)
+      key = check_for_key!(key)
+      des = encryptor
+      des.encrypt(key)
+      data = des.update(data)
+      data << des.final
+    end
+  
+    def encrypt_to_base64(text, key = nil)
+      Base64.encode64(encrypt(text, key))
+    end
+  
+    def decrypt(data, key = nil)
+      key = check_for_key!(key)
+      des = encryptor
+      des.decrypt(key)
+      text = des.update(data)
+      text << des.final
+    end
+  
+    def decrypt_from_base64(text, key = nil)
+      decrypt(Base64.decode64(text), key)
+    end
+
+    class << self
+      def default_algorithm
+        @@default_algorithm
+      end
+    
+      def default_algorithm=(value)
+        @@default_algorithm = value
+      end
+      
+      def default_key
+        @@default_key
+      end
+      
+      def default_key=(value)
+        @@default_key = value
+      end
+
+      def encrypt(data, key = nil)
+        self.new.encrypt(data, key)
+      end
+  
+      def encrypt_to_base64(text, key = nil)
+        self.new.encrypt_to_base64(text, key)
+      end
+  
+      def decrypt(data, key = nil)
+        self.new.decrypt(data, key)
+      end
+  
+      def decrypt_from_base64(text, key = nil)
+        self.new.decrypt_from_base64(text, key)
+      end
+    end
+
+    private
+    def encryptor
+      @encryptor ||= OpenSSL::Cipher::Cipher.new(@algorithm)
+    end
+    
+    def check_for_key!(key)
+      valid_key = key || @@default_key
+      raise Sentry::NoKeyError if valid_key.nil?
+      valid_key
+    end
+  end
+end

data/lib/sentry/symmetric_sentry_callback.rb

@@ -0,0 +1,17 @@
+module Sentry
+  class SymmetricSentryCallback
+    def initialize(attr_name)
+      @attr_name = attr_name
+    end
+
+    ## Performs encryption on before_validation Active Record callback
+    #def before_validation(model)
+    #  return if model.send(@attr_name).blank?
+    #  model.send("crypted_#{@attr_name}=", SymmetricSentry.encrypt_to_base64(model.send(@attr_name)))
+    #end
+    
+    #def after_save(model)
+    #  #model.send("#{@attr_name}=", nil)
+    #end
+  end
+end

data/tasks/sentry.rake

@@ -0,0 +1,9 @@
+require 'sentry'
+
+desc "Creates a private/public key for asymmetric encryption:  rake sentry_key PUB=/path/to/public.key PRIV=/path/to/priv.key [KEY=secret]"
+task :sentry_key do
+  Sentry::AsymmetricSentry.save_random_rsa_key(
+    ENV['PRIV'] || 'private.key', 
+    ENV['PUB']  || 'public.key', 
+    :key => ENV['KEY'])
+end

data/test/abstract_unit.rb

@@ -0,0 +1,44 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_record/fixtures'
+require 'active_support/test_case'
+#require 'active_support/binding_of_caller'
+#require 'active_support/breakpoint'
+require "#{File.dirname(__FILE__)}/../lib/sentry"
+
+config_location = File.dirname(__FILE__) + '/database.yml'
+
+config = YAML::load(IO.read(config_location))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'mysql'])
+ActiveRecord::Base.configurations["test"] = "lolcatz"
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+class ActiveSupport::TestCase #:nodoc:
+  include ActiveRecord::TestFixtures
+  #def create_fixtures(*table_names)
+  #  if block_given?
+  #    Fixtures.create_fixtures(ActiveSupport::TestCase.fixture_path, table_names) { yield }
+  #  else
+  #    Fixtures.create_fixtures(ActiveSupport::TestCase.fixture_path, table_names)
+  #  end
+  #end
+
+  self.use_instantiated_fixtures  = false
+  self.use_transactional_fixtures = true
+end
+
+def create_fixtures(*table_names, &block)
+  Fixtures.create_fixtures(ActiveSupport::TestCase.fixture_path, table_names, {}, &block)
+end
+
+
+
+ActiveSupport::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+ActiveSupport::TestCase.use_instantiated_fixtures = true
+ActiveSupport::TestCase.use_transactional_fixtures = (ENV['AR_TX_FIXTURES'] == "yes")
+$LOAD_PATH.unshift(ActiveSupport::TestCase.fixture_path)

data/test/asymmetric_sentry_callback_test.rb

@@ -0,0 +1,72 @@
+require 'abstract_unit'
+require 'fixtures/user'
+
+class AsymmetricSentryCallbackTest < ActiveSupport::TestCase
+  fixtures :users
+
+  def setup
+    super
+    @str = 'sentry'
+    @key = 'secret'
+    @public_key_file = File.dirname(__FILE__) + '/keys/public'
+    @private_key_file = File.dirname(__FILE__) + '/keys/private'
+    @encrypted_public_key_file = File.dirname(__FILE__) + '/keys/encrypted_public'
+    @encrypted_private_key_file = File.dirname(__FILE__) + '/keys/encrypted_private'
+
+    @orig = 'sentry'
+    Sentry::AsymmetricSentry.default_public_key_file = @public_key_file
+    Sentry::AsymmetricSentry.default_private_key_file = @private_key_file
+    Sentry::SymmetricSentry.default_key = @key
+  end
+
+  def test_should_encrypt_creditcard
+    u = User.create :login => 'jones'
+    u.creditcard = @orig
+    assert u.save
+    assert !u.crypted_creditcard.empty?
+  end
+
+  def test_should_deal_with_before_typecast
+    u = User.create :login => 'jones'
+    u.creditcard = "123123"
+    assert_equal "123123", u.creditcard_before_type_cast
+    assert u.save
+    u.reload
+    assert_equal "123123", u.creditcard_before_type_cast
+  end
+
+  def test_should_decrypt_creditcard
+    assert_equal @orig, users(:user_1).creditcard
+  end
+
+  def test_should_not_decrypt_encrypted_creditcard_with_invalid_key
+    assert_nil users(:user_2).creditcard
+    assert_nil users(:user_2).creditcard(@key)
+    use_encrypted_keys
+    assert_nil users(:user_1).creditcard
+  end
+
+  def test_should_not_decrypt_encrypted_creditcard
+    use_encrypted_keys
+    assert_nil users(:user_2).creditcard
+    assert_nil users(:user_2).creditcard('other secret')
+  end
+
+  def test_should_encrypt_encrypted_creditcard
+    use_encrypted_keys
+    u = User.create :login => 'jones'
+    u.creditcard = @orig
+    assert u.save
+    assert !u.crypted_creditcard.empty?
+  end
+
+  def test_should_decrypt_encrypted_creditcard
+    use_encrypted_keys
+    assert_equal @orig, users(:user_2).creditcard(@key)
+  end
+
+  def use_encrypted_keys
+    Sentry::AsymmetricSentry.default_public_key_file = @encrypted_public_key_file
+    Sentry::AsymmetricSentry.default_private_key_file = @encrypted_private_key_file
+  end
+end