symmetric-encryption 0.6.0 → 0.6.1

data/examples/symmetric-encryption.yml

@@ -6,9 +6,9 @@
 # can be placed directly in the source code.
 # And therefore no RSA private key is required
 development: &development_defaults
-  key: 1234567890ABCDEF1234567890ABCDEF
-  iv:  1234567890ABCDEF
-  cipher:        aes-128-cbc
+  key:    1234567890ABCDEF1234567890ABCDEF
+  iv:     1234567890ABCDEF
+  cipher: aes-128-cbc
 
 test:
   <<: *development_defaults

data/lib/csv_encrypted

@@ -0,0 +1 @@
+"������	W��ga�

data/lib/symmetric_encryption/reader.rb

@@ -67,8 +67,7 @@ module SymmetricEncryption
     #
     # require 'fastercsv'
     # begin
-    #   # Must supply :row_sep for FasterCSV otherwise it will attempt to rewind the file etc.
-    #   csv = FasterCSV.new(SymmetricEncryption::Reader.open('csv_encrypted'), :row_sep => "\n")
+    #   csv = FasterCSV.new(SymmetricEncryption::Reader.open('csv_encrypted'))
     #   csv.each {|row| p row}
     # ensure
     #   csv.close if csv
@@ -92,29 +91,8 @@ module SymmetricEncryption
     def initialize(ios,options={})
       @ios         = ios
       @buffer_size = options.fetch(:buffer_size, 4096).to_i
-      @compressed  = nil
-      @read_buffer = ''
-
-      # Read first block and check for the header
-      buf = @ios.read(@buffer_size)
-      if buf.start_with?(SymmetricEncryption::MAGIC_HEADER)
-        # Header includes magic header and version byte
-        # Remove header and extract flags
-        header, flags = buf.slice!(0..MAGIC_HEADER_SIZE+1).unpack(MAGIC_HEADER_UNPACK)
-        @compressed = (flags & 0b1000_0000_0000_0000) != 0
-        @version = @compressed ? flags - 0b1000_0000_0000_0000 : flags
-      else
-        @version = options[:version]
-      end
-
-      # Use primary cipher by default, but allow a secondary cipher to be selected for encryption
-      @cipher = SymmetricEncryption.cipher(@version)
-      raise "Cipher with version:#{@version} not found in any of the configured SymmetricEncryption ciphers" unless @cipher
-      @stream_cipher = @cipher.send(:openssl_cipher, :decrypt)
-
-      # First call to #update should return an empty string anyway
-      @read_buffer << @stream_cipher.update(buf)
-      @read_buffer << @stream_cipher.final if @ios.eof?
+      @version = options[:version]
+      read_header
     end
 
     # Returns whether the stream being read is compressed
@@ -186,6 +164,7 @@ module SymmetricEncryption
           data << @stream_cipher.final
         end
       end
+      @pos += data.length
       data
     end
 
@@ -209,6 +188,7 @@ module SymmetricEncryption
       end
       index ||= -1
       data = @read_buffer.slice!(0..index)
+      @pos += data.length
       return nil if data.length == 0 && eof?
       data
     end
@@ -231,21 +211,45 @@ module SymmetricEncryption
       (@read_buffer.size == 0) && @ios.eof?
     end
 
-    # Return the approximate offset in bytes of the current input stream
-    # Since the encrypted data size does not match the unencrypted size
-    # this value cannot be guaranteed. Especially if compression is turned on
+    # Return the number of bytes read so far from the input stream
     def pos
-      @ios.pos - @read_buffer.size
+      @pos
     end
 
     # Rewind back to the beginning of the file
     def rewind
       @read_buffer = ''
       @ios.rewind
+      read_header
     end
 
     private
 
+    # Read the header from the file if present
+    def read_header
+      @compressed  = nil
+      @pos = 0
+
+      # Read first block and check for the header
+      buf = @ios.read(@buffer_size)
+      if buf.start_with?(MAGIC_HEADER)
+        # Header includes magic header and version byte
+        # Remove header and extract flags
+        header, flags = buf.slice!(0..MAGIC_HEADER_SIZE+1).unpack(MAGIC_HEADER_UNPACK)
+        @compressed = (flags & 0b1000_0000_0000_0000) != 0
+        @version = @compressed ? flags - 0b1000_0000_0000_0000 : flags
+      end
+
+      # Use primary cipher by default, but allow a secondary cipher to be selected for encryption
+      @cipher = SymmetricEncryption.cipher(@version)
+      raise "Cipher with version:#{@version.inspect} not found in any of the configured SymmetricEncryption ciphers" unless @cipher
+      @stream_cipher = @cipher.send(:openssl_cipher, :decrypt)
+
+      # First call to #update should return an empty string anyway
+      @read_buffer = @stream_cipher.update(buf)
+      @read_buffer << @stream_cipher.final if @ios.eof?
+    end
+
     # Read a block of data and append the decrypted data in the read buffer
     def read_block
       buf = @ios.read(@buffer_size)

data/lib/symmetric_encryption/symmetric_encryption.rb

@@ -13,6 +13,14 @@ module SymmetricEncryption
   @@secondary_ciphers = []
 
   # Set the Primary Symmetric Cipher to be used
+  #
+  # Example: For testing purposes the following test cipher can be used:
+  #
+  #   SymmetricEncryption.cipher = SymmetricEncryption::Cipher.new(
+  #     :key    => '1234567890ABCDEF1234567890ABCDEF',
+  #     :iv     => '1234567890ABCDEF',
+  #     :cipher => 'aes-128-cbc'
+  #   )
   def self.cipher=(cipher)
     raise "Cipher must be similar to SymmetricEncryption::Ciphers" unless cipher.respond_to?(:encrypt) && cipher.respond_to?(:decrypt)
     @@cipher = cipher
@@ -22,6 +30,7 @@ module SymmetricEncryption
   # If a version is supplied, then the cipher matching that version will be
   # returned or nil if no match was found
   def self.cipher(version = 0)
+    raise "Call SymmetricEncryption.load! or SymmetricEncryption.cipher= prior to encrypting or decrypting data" unless @@cipher
     return @@cipher if version.nil? || (version == 0) || (@@cipher.version == version)
     secondary_ciphers.find {|c| c.version == version}
   end

data/lib/symmetric_encryption/version.rb

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

data/test/reader_test.rb

@@ -98,6 +98,16 @@ class ReaderTest < Test::Unit::TestCase
               end
             end
           end
+
+          should "support rewind" do
+            decrypted = SymmetricEncryption::Reader.open(@filename) do |file|
+              file.read
+              file.rewind
+              file.read
+            end
+            assert_equal @data_str, decrypted
+          end
+
         end
       end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Reid Morrison
@@ -29,6 +29,7 @@ extra_rdoc_files: []
 
 files: 
 - examples/symmetric-encryption.yml
+- lib/csv_encrypted
 - lib/symmetric-encryption.rb
 - lib/symmetric_encryption/cipher.rb
 - lib/symmetric_encryption/extensions/active_record/base.rb
@@ -49,6 +50,8 @@ files:
 - nbproject/project.xml
 - Rakefile
 - README.md
+- symmetric-encryption-0.6.0.gem
+- symmetric-encryption-0.6.1.gem
 - test/attr_encrypted_test.rb
 - test/cipher_test.rb
 - test/config/database.yml