symmetric-encryption 0.8.0 → 0.9.0

data/README.md

@@ -129,6 +129,18 @@ Example: Compress, Encrypt and write data to a file
       file.write "Keep this safe and secure\n"
     end
 
+### Standalone test
+
+Before generating keys we can use SymmetricEncryption in a standalone test environment:
+
+    # Use test encryption keys
+    SymmetricEncryption.cipher = SymmetricEncryption::Cipher.new(
+      :key    => '1234567890ABCDEF1234567890ABCDEF',
+      :iv     => '1234567890ABCDEF',
+      :cipher => 'aes-128-cbc'
+    )
+    encrypted = SymmetricEncryption.encrypt('hello world')
+    puts SymmetricEncryption.decrypt(encrypted)
 
 ### Generating encrypted passwords
 
@@ -143,11 +155,11 @@ Note: Passwords must be encrypted in the environment in which they will be used.
 ### Add to an existing Rails project
 Add the following line to Gemfile
 
-  gem 'symmetric-encryption'
+    gem 'symmetric-encryption'
 
 Install the Gem with bundler
 
-  bundle install
+    bundle install
 
 ## Rails Configuration
 
@@ -160,7 +172,7 @@ modified as needed.
 
 Generate the configuration file:
 
-  rails generate symmetric_encryption:config /etc/rails/keys
+    rails generate symmetric_encryption:config /etc/rails/keys
 
 Note: Ignore the warning about "Symmetric Encryption config not found" since it is
 being generated
@@ -224,7 +236,7 @@ SymmetricEncryption can also be used in non-Rails environment.
 
 Install SymmetricEncryption
 
-  gem install symmetric-encryption
+    gem install symmetric-encryption
 
 Manually create a symmetric-encryption.yml configuration file based on the
 one supplied in examples/symmetric-encryption.yml.

data/lib/symmetric-encryption.rb

@@ -1,19 +1 @@
-require 'symmetric_encryption/version'
-require 'symmetric_encryption/cipher'
-require 'symmetric_encryption/symmetric_encryption'
-require 'symmetric_encryption/reader'
-require 'symmetric_encryption/writer'
-require 'zlib'
-if defined?(Rails)
-  require 'symmetric_encryption/railtie'
-end
-# attr_encrypted and Encrypted validator
-if defined?(ActiveRecord::Base)
-  require 'symmetric_encryption/extensions/active_record/base'
-  require 'symmetric_encryption/railties/symmetric_encryption_validator'
-end
-
-# field encryption for Mongoid
-if defined?(Mongoid)
-  require 'symmetric_encryption/extensions/mongoid/fields'
-end
+require 'symmetric_encryption'

data/lib/symmetric_encryption.rb

@@ -0,0 +1,19 @@
+require 'symmetric_encryption/version'
+require 'symmetric_encryption/cipher'
+require 'symmetric_encryption/symmetric_encryption'
+require 'symmetric_encryption/reader'
+require 'symmetric_encryption/writer'
+require 'zlib'
+if defined?(Rails)
+  require 'symmetric_encryption/railtie'
+end
+# attr_encrypted and Encrypted validator
+if defined?(ActiveRecord::Base)
+  require 'symmetric_encryption/extensions/active_record/base'
+  require 'symmetric_encryption/railties/symmetric_encryption_validator'
+end
+
+# field encryption for Mongoid
+if defined?(Mongoid)
+  require 'symmetric_encryption/extensions/mongoid/fields'
+end

data/lib/symmetric_encryption/cipher.rb

@@ -32,13 +32,33 @@ module SymmetricEncryption
     # Create a Symmetric::Key for encryption and decryption purposes
     #
     # Parameters:
-    #   :key
+    #   :key [String]
     #     The Symmetric Key to use for encryption and decryption
-    #   :iv
+    #
+    #   :iv [String]
     #     Optional. The Initialization Vector to use with Symmetric Key
-    #   :cipher
+    #     Highly Recommended as it is the input into the CBC algorithm
+    #
+    #   :cipher [String]
     #     Optional. Encryption Cipher to use
     #     Default: aes-256-cbc
+    #
+    #   :encoding [Symbol]
+    #     :base64strict
+    #       Return as a base64 encoded string that does not include additional newlines
+    #       This is the recommended format since newlines in the values to
+    #       SQL queries are cumbersome. Also the newline reformatting is unnecessary
+    #       It is not the default for backward compatibility
+    #     :base64
+    #       Return as a base64 encoded string
+    #     :binary
+    #       Return as raw binary data string. Note: String can contain embedded nulls
+    #     Default: :base64
+    #     Recommended: :base64strict
+    #
+    #   :version [Fixnum]
+    #     Optional. The version number of this encryption key
+    #     Used by SymmetricEncryption to select the correct key when decrypting data
     def initialize(parms={})
       raise "Missing mandatory parameter :key" unless @key = parms[:key]
       @iv = parms[:iv]
@@ -50,34 +70,46 @@ module SymmetricEncryption
     end
 
     # AES Symmetric Encryption of supplied string
+    # The String is encoded to UTF-8 prior to encryption
+    #
     #  Returns result as a Base64 encoded string
     #  Returns nil if the supplied str is nil
     #  Returns "" if it is a string and it is empty
-    #
-    #  options:
-    #    :encoding
-    #       :base64 Return as a base64 encoded string
-    #       :binary Return as raw binary data string. Note: String can contain embedded nulls
-    #      Default: :base64
-    #    :compress
-    #      [true|false] Whether or not to compress the data _before_ encrypting
-    #      Default: false
-    def encrypt(str)
-      return if str.nil?
-      buf = str.to_s
-      return str if buf.empty?
-      crypt(:encrypt, buf)
+    if defined?(Encoding)
+      def encrypt(str)
+        return if str.nil?
+        buf = str.to_s.encode(SymmetricEncryption::UTF8_ENCODING)
+        return str if buf.empty?
+        crypt(:encrypt, buf)
+      end
+    else
+      def encrypt(str)
+        return if str.nil?
+        buf = str.to_s
+        return str if buf.empty?
+        crypt(:encrypt, buf)
+      end
     end
 
     # AES Symmetric Decryption of supplied string
-    #  Returns decrypted string
+    # The encoding of the supplied string is ignored since it must be binary data
+    #  Returns a UTF-8 encoded, decrypted string
     #  Returns nil if the supplied str is nil
     #  Returns "" if it is a string and it is empty
-    def decrypt(str)
-      return if str.nil?
-      buf = str.to_s
-      return str if buf.empty?
-      crypt(:decrypt, buf)
+    if defined?(Encoding)
+      def decrypt(str)
+        return if str.nil?
+        buf = str.to_s.force_encoding(SymmetricEncryption::BINARY_ENCODING)
+        return str if buf.empty?
+        crypt(:decrypt, buf).force_encoding(SymmetricEncryption::UTF8_ENCODING)
+      end
+    else
+      def decrypt(str)
+        return if str.nil?
+        buf = str.to_s
+        return str if buf.empty?
+        crypt(:decrypt, buf)
+      end
     end
 
     # Return a new random key using the configured cipher
@@ -104,6 +136,7 @@ module SymmetricEncryption
 
     # Creates a new OpenSSL::Cipher with every call so that this call
     # is thread-safe
+    # Return a binary encoded decrypted or encrypted string
     def crypt(cipher_method, string) #:nodoc:
       openssl_cipher = ::OpenSSL::Cipher.new(self.cipher)
       openssl_cipher.send(cipher_method)

data/lib/symmetric_encryption/reader.rb

@@ -74,7 +74,7 @@ module SymmetricEncryption
     # end
     def self.open(filename_or_stream, options={}, &block)
       raise "options must be a hash" unless options.respond_to?(:each_pair)
-      mode = options.fetch(:mode, 'r')
+      mode = options.fetch(:mode, 'rb')
       compress = options.fetch(:compress, false)
       ios = filename_or_stream.is_a?(String) ? ::File.open(filename_or_stream, mode) : filename_or_stream
 

data/lib/symmetric_encryption/symmetric_encryption.rb

@@ -160,9 +160,6 @@ module SymmetricEncryption
     true
   end
 
-  # Future: Generate private key in config file generator
-  #new_key = OpenSSL::PKey::RSA.generate(2048)
-
   # Generate new random symmetric keys for use with this Encryption library
   #
   # Note: Only the current Encryption key settings are used
@@ -310,4 +307,10 @@ module SymmetricEncryption
     )
   end
 
+  # With Ruby 1.9 strings have encodings
+  if defined?(Encoding)
+    BINARY_ENCODING = Encoding.find("binary")
+    UTF8_ENCODING = Encoding.find("UTF-8")
+  end
+
 end

data/lib/symmetric_encryption/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module SymmetricEncryption #:nodoc
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/symmetric_encryption/writer.rb

@@ -66,7 +66,7 @@ module SymmetricEncryption
     #  end
     def self.open(filename_or_stream, options={}, &block)
       raise "options must be a hash" unless options.respond_to?(:each_pair)
-      mode = options.fetch(:mode, 'w')
+      mode = options.fetch(:mode, 'wb')
       compress = options.fetch(:compress, false)
       ios = filename_or_stream.is_a?(String) ? ::File.open(filename_or_stream, mode) : filename_or_stream
 

data/nbproject/private/private.properties

@@ -0,0 +1,3 @@
+file.reference.symmetry-lib=/Users/rmorrison/Sandbox/symmetry/lib
+file.reference.symmetry-test=/Users/rmorrison/Sandbox/symmetry/test
+platform.active=JRuby

data/nbproject/private/private.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project-private xmlns="http://www.netbeans.org/ns/project-private/1">
+    <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1">
+        <file>
+            <url>lib/symmetric/encryption.rb</url>
+            <line>62</line>
+        </file>
+        <file>
+            <url>lib/symmetric_encryption/symmetric_encryption.rb</url>
+            <line>75</line>
+        </file>
+        <file>
+            <url>lib/symmetric_encryption/encryption.rb</url>
+            <line>60</line>
+        </file>
+    </editor-bookmarks>
+</project-private>

data/nbproject/private/rake-d.txt

@@ -0,0 +1,4 @@
+clean=Remove any temporary products.
+clobber=Remove any generated file.
+gem=Build gem
+test=Run Test Suite

data/nbproject/project.properties

@@ -0,0 +1,9 @@
+file.reference.symmetry-lib=lib
+file.reference.symmetry-test=test
+javac.classpath=
+main.file=
+platform.active=JRuby
+source.encoding=UTF-8
+src.examples.dir=examples
+src.lib.dir=lib
+test.test.dir=test

data/nbproject/project.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.ruby.rubyproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
+            <name>symmetric-encryption</name>
+            <source-roots>
+                <root id="src.lib.dir" name="Source Files"/>
+                <root id="src.examples.dir" name="Examples"/>
+            </source-roots>
+            <test-roots>
+                <root id="test.test.dir" name="Test Files"/>
+            </test-roots>
+        </data>
+    </configuration>
+</project>

data/test/cipher_test.rb

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
-require 'symmetric_encryption/cipher'
+require 'symmetric_encryption'
 
 # Unit Test for SymmetricEncryption::Cipher
 #
@@ -24,7 +24,13 @@ class CipherTest < Test::Unit::TestCase
       cipher = SymmetricEncryption::Cipher.new(
         :key => '1234567890ABCDEF1234567890ABCDEF'
       )
-      assert_equal "\302<\351\227oj\372\3331\310\260V\001\v'\346", cipher.encrypt('Hello World')
+      result = "\302<\351\227oj\372\3331\310\260V\001\v'\346"
+      # Note: This test fails on JRuby 1.7 RC1 since it's OpenSSL
+      #       behaves differently when no IV is supplied.
+      #       It instead encrypts to the following value:
+      # result = "0h\x92\x88\xA1\xFE\x8D\xF5\xF3v\x82\xAF(P\x83Y"
+      result.force_encoding('binary') if defined?(Encoding)
+      assert_equal result, cipher.encrypt('Hello World')
     end
 
     should "throw an exception on bad data" do
@@ -47,7 +53,10 @@ class CipherTest < Test::Unit::TestCase
         :iv  => '1234567890ABCDEF'
       )
       @social_security_number = "987654321"
+
       @social_security_number_encrypted = "A\335*\314\336\250V\340\023%\000S\177\305\372\266"
+      @social_security_number_encrypted.force_encoding('binary') if defined?(Encoding)
+
       @sample_data = [
         { :text => '555052345', :encrypted => ''}
       ]
@@ -65,5 +74,17 @@ class CipherTest < Test::Unit::TestCase
       assert_equal @social_security_number, @cipher.decrypt(@social_security_number_encrypted)
     end
 
+    if defined?(Encoding)
+      context "on Ruby 1.9" do
+        should "encode encrypted data as binary" do
+          assert_equal Encoding.find('binary'), @cipher.encrypt(@social_security_number).encoding
+        end
+
+        should "decode encrypted data as utf-8" do
+          assert_equal Encoding.find('utf-8'), @cipher.decrypt(@cipher.encrypt(@social_security_number)).encoding
+        end
+      end
+    end
+
   end
 end

data/test/config/mongoid_v3.yml

@@ -0,0 +1,9 @@
+test:
+  sessions:
+    default:
+      hosts:
+        - localhost:27017
+      # All Dates and Times should be returned in UTC, not the local timezone
+      use_utc: true
+      persist_in_safe_mode: true
+      database: symmetric_encryption_test

data/test/field_encrypted_test.rb

@@ -6,13 +6,15 @@ require 'logger'
 require 'erb'
 require 'test/unit'
 require 'shoulda'
-# Since we want both the AR and Mongoid extensions loaded we need to require them first
+# Since we want both the Mongoid extensions loaded we need to require it first
 require 'active_record'
 require 'mongoid'
 require 'symmetric-encryption'
+require 'symmetric_encryption/extensions/mongoid/fields'
 
 Mongoid.logger = Logger.new($stdout)
-Mongoid.load!("test/config/mongoid.yml")
+filename = defined?(Mongoid::VERSION) ? "test/config/mongoid_v3.yml" : "test/config/mongoid_v2.yml"
+Mongoid.load!(filename)
 
 class MongoidUser
   include Mongoid::Document

data/test/reader_test.rb

@@ -69,8 +69,8 @@ class ReaderTest < Test::Unit::TestCase
 
     context "reading from file" do
       # With and without header
-      [{:header => false}, {:header => true}, {:header => true, :compress => true}].each do |options|
-        context "with#{'out' unless options[:header]} header" do
+      [{:header => false}, {:compress => false}, {:compress => true}].each_with_index do |options, i|
+        context "with#{'out' unless options[:header]} header #{i}" do
           setup do
             @filename = '._test'
             # Create encrypted file

data/test/writer_test.rb

@@ -36,7 +36,9 @@ class EncryptionWriterTest < Test::Unit::TestCase
       file.close
 
       assert_equal @data_len, written_len
-      assert_equal @data_encrypted, stream.string
+      result = stream.string
+      result.force_encoding('binary') if defined?(Encoding)
+      assert_equal @data_encrypted, result
     end
 
     should "encrypt to string stream using .open" do
@@ -54,7 +56,7 @@ class EncryptionWriterTest < Test::Unit::TestCase
         written_len = @data.inject(0) {|sum,str| sum + file.write(str)}
       end
       assert_equal @data_len, written_len
-      assert_equal @data_encrypted, File.read(@filename)
+      assert_equal @data_encrypted, File.open(@filename, 'rb') {|f| f.read }
     end
   end
 end

metadata

@@ -1,37 +1,27 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: symmetric-encryption
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 8
-  - 0
-  version: 0.8.0
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-28 00:00:00 -04:00
-default_executable: 
+date: 2012-09-26 00:00:00.000000000 Z
 dependencies: []
-
-description: SymmetricEncryption supports encrypting ActiveRecord data, Mongoid data, passwords in configuration files, encrypting and decrypting of large files through streaming
-email: 
+description: SymmetricEncryption supports encrypting ActiveRecord data, Mongoid data,
+  passwords in configuration files, encrypting and decrypting of large files through
+  streaming
+email:
 - reidmo@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- csv.zip
-- csv_encrypted
-- csv_encrypted_zip
+files:
 - examples/symmetric-encryption.yml
+- foo.zip
 - lib/rails/generators/symmetric_encryption/config/config_generator.rb
 - lib/rails/generators/symmetric_encryption/config/templates/symmetric-encryption.yml
 - lib/rails/generators/symmetric_encryption/new_keys/new_keys_generator.rb
@@ -46,13 +36,21 @@ files:
 - lib/symmetric_encryption/symmetric_encryption.rb
 - lib/symmetric_encryption/version.rb
 - lib/symmetric_encryption/writer.rb
+- lib/symmetric_encryption.rb
 - LICENSE.txt
+- nbproject/private/config.properties
+- nbproject/private/private.properties
+- nbproject/private/private.xml
+- nbproject/private/rake-d.txt
+- nbproject/project.properties
+- nbproject/project.xml
 - Rakefile
 - README.md
 - test/attr_encrypted_test.rb
 - test/cipher_test.rb
 - test/config/database.yml
-- test/config/mongoid.yml
+- test/config/mongoid_v2.yml
+- test/config/mongoid_v3.yml
 - test/config/symmetric-encryption.yml
 - test/config/test_new.iv
 - test/config/test_new.key
@@ -62,35 +60,28 @@ files:
 - test/reader_test.rb
 - test/symmetric_encryption_test.rb
 - test/writer_test.rb
-has_rdoc: true
 homepage: https://github.com/ClarityServices/symmetric-encryption
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+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.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Symmetric Encryption for Ruby, and Ruby on Rails
 test_files: []
-