symmetric-encryption 0.5.2 → 0.6.0

data/lib/symmetric_encryption/reader.rb

@@ -4,34 +4,6 @@ module SymmetricEncryption
   # Features:
   # * Decryption on the fly whilst reading files
   # * Large file support by only buffering small amounts of data in memory
-  #
-  # # Example: Read and decrypt a line at a time from a file
-  # SymmetricEncryption::Reader.open('test_file') do |file|
-  #   file.each_line {|line| p line }
-  # end
-  #
-  # # Example: Read and decrypt entire file in memory
-  # # Not recommended for large files
-  # SymmetricEncryption::Reader.open('test_file') {|f| f.read }
-  #
-  # # Example: Reading a limited number of bytes at a time from the file
-  # SymmetricEncryption::Reader.open('test_file') do |file|
-  #   file.read(1)
-  #   file.read(5)
-  #   file.read
-  # end
-  #
-  # # Example: Read and decrypt 5 bytes at a time until the end of file is reached
-  # SymmetricEncryption::Reader.open('test_file') do |file|
-  #   while !file.eof? do
-  #     file.read(5)
-  #   end
-  # end
-  #
-  # # Example: Read, Unencrypt and decompress data in a file
-  # SymmetricEncryption::Reader.open('encrypted_compressed.zip', :compress => true) do |file|
-  #   file.each_line {|line| p line }
-  # end
   class Reader
     # Open a file for reading, or use the supplied IO Stream
     #
@@ -62,6 +34,45 @@ module SymmetricEncryption
     #          Default: 4096
     #
     # Note: Decryption occurs before decompression
+    #
+    # # Example: Read and decrypt a line at a time from a file
+    # SymmetricEncryption::Reader.open('test_file') do |file|
+    #   file.each_line {|line| p line }
+    # end
+    #
+    # # Example: Read and decrypt entire file in memory
+    # # Not recommended for large files
+    # SymmetricEncryption::Reader.open('test_file') {|f| f.read }
+    #
+    # # Example: Reading a limited number of bytes at a time from the file
+    # SymmetricEncryption::Reader.open('test_file') do |file|
+    #   file.read(1)
+    #   file.read(5)
+    #   file.read
+    # end
+    #
+    # # Example: Read and decrypt 5 bytes at a time until the end of file is reached
+    # SymmetricEncryption::Reader.open('test_file') do |file|
+    #   while !file.eof? do
+    #     file.read(5)
+    #   end
+    # end
+    #
+    # # Example: Read, Unencrypt and decompress data in a file
+    # SymmetricEncryption::Reader.open('encrypted_compressed.zip', :compress => true) do |file|
+    #   file.each_line {|line| p line }
+    # end
+    #
+    # # Example: Reading from a CSV file
+    #
+    # 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.each {|row| p row}
+    # ensure
+    #   csv.close if csv
+    # 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')
@@ -71,9 +82,9 @@ module SymmetricEncryption
       begin
         file = self.new(ios, options)
         file = Zlib::GzipReader.new(file) if file.compressed? || compress
-        block.call(file)
+        block ? block.call(file) : file
       ensure
-        file.close if file
+        file.close if block && file
       end
     end
 
@@ -89,8 +100,8 @@ module SymmetricEncryption
       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).unpack(MAGIC_HEADER_UNPACK)
-        @compressed = flags & 0b1000_0000_0000_0000
+        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]
@@ -179,15 +190,27 @@ module SymmetricEncryption
     end
 
     # Reads a single decrypted line from the file up to and including the optional sep_string.
-    # Returns nil on eof
+    # Raises EOFError on eof
     # The stream must be opened for reading or an IOError will be raised.
     def readline(sep_string = "\n")
+      gets(sep_string) || raise(EOFError.new("End of file reached when trying to read a line"))
+    end
+
+    # Reads a single decrypted line from the file up to and including the optional sep_string.
+    # A sep_string of nil reads the entire contents of the file
+    # Returns nil on eof
+    # The stream must be opened for reading or an IOError will be raised.
+    def gets(sep_string)
+      return read if sep_string.nil?
+
       # Read more data until we get the sep_string
       while (index = @read_buffer.index(sep_string)).nil? && !@ios.eof?
         read_block
       end
       index ||= -1
-      @read_buffer.slice!(0..index)
+      data = @read_buffer.slice!(0..index)
+      return nil if data.length == 0 && eof?
+      data
     end
 
     # ios.each(sep_string="\n") {|line| block } => ios
@@ -196,7 +219,7 @@ module SymmetricEncryption
     # ios must be opened for reading or an IOError will be raised.
     def each_line(sep_string = "\n")
       while !eof?
-        yield readline(sep_string)
+        yield gets(sep_string)
       end
       self
     end
@@ -208,6 +231,19 @@ 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
+    def pos
+      @ios.pos - @read_buffer.size
+    end
+
+    # Rewind back to the beginning of the file
+    def rewind
+      @read_buffer = ''
+      @ios.rewind
+    end
+
     private
 
     # Read a block of data and append the decrypted data in the read buffer

data/lib/symmetric_encryption/symmetric_encryption.rb

@@ -21,8 +21,8 @@ module SymmetricEncryption
   # Returns the Primary Symmetric Cipher being used
   # 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 = nil)
-    return @@cipher if version.nil? || (@@cipher.version == version)
+  def self.cipher(version = 0)
+    return @@cipher if version.nil? || (version == 0) || (@@cipher.version == version)
     secondary_ciphers.find {|c| c.version == version}
   end
 
@@ -190,7 +190,7 @@ module SymmetricEncryption
   unless defined? MAGIC_HEADER
     MAGIC_HEADER = '@EnC'
     MAGIC_HEADER_SIZE = MAGIC_HEADER.size
-    MAGIC_HEADER_UNPACK = "A#{MAGIC_HEADER_SIZE}v"
+    MAGIC_HEADER_UNPACK = "a#{MAGIC_HEADER_SIZE}v"
   end
 
   protected

data/lib/symmetric_encryption/version.rb

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

data/lib/symmetric_encryption/writer.rb

@@ -1,29 +1,13 @@
 module SymmetricEncryption
+  # Write to encrypted files and other IO streams
+  #
+  # Features:
+  # * Encryption on the fly whilst writing files.
+  # * Large file support by only buffering small amounts of data in memory
+  # * Underlying buffering to ensure that encrypted data fits
+  #   into the Symmetric Encryption Cipher block size
+  #   Only the last block in the file will be padded if it is less than the block size
   class Writer
-    # Write to encrypted files and other IO streams
-    #
-    # Features:
-    # * Encryption on the fly whilst writing files.
-    # * Large file support by only buffering small amounts of data in memory
-    # * Underlying buffering to ensure that encrypted data fits
-    #   into the Symmetric Encryption Cipher block size
-    #   Only the last block in the file will be padded if it is less than the block size
-    #
-    # # Example: Encrypt and write data to a file
-    # SymmetricEncryption::Writer.open('test_file') do |file|
-    #   file.write "Hello World\n"
-    #   file.write "Keep this secret"
-    # end
-    #
-    # # Example: Compress, Encrypt and write data to a file
-    # SymmetricEncryption::Writer.open('encrypted_compressed.zip', :compress => true) do |file|
-    #   file.write "Hello World\n"
-    #   file.write "Compress this\n"
-    #   file.write "Keep this safe and secure\n"
-    # end
-    #
-
-
     # Open a file for writing, or use the supplied IO Stream
     #
     # Parameters:
@@ -57,6 +41,29 @@ module SymmetricEncryption
     #
     # Note: Compression occurs before encryption
     #
+    #
+    # # Example: Encrypt and write data to a file
+    # SymmetricEncryption::Writer.open('test_file') do |file|
+    #   file.write "Hello World\n"
+    #   file.write "Keep this secret"
+    # end
+    #
+    # # Example: Compress, Encrypt and write data to a file
+    # SymmetricEncryption::Writer.open('encrypted_compressed.zip', :compress => true) do |file|
+    #   file.write "Hello World\n"
+    #   file.write "Compress this\n"
+    #   file.write "Keep this safe and secure\n"
+    # end
+    #
+    # # Example: Writing to a CSV file
+    #  require 'fastercsv'
+    #  begin
+    #    # Must supply :row_sep for FasterCSV otherwise it will attempt to read from and then rewind the file
+    #    csv = FasterCSV.new(SymmetricEncryption::Writer.open('csv_encrypted'), :row_sep => "\n")
+    #    csv << [1,2,3,4,5]
+    #  ensure
+    #    csv.close if csv
+    #  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')
@@ -66,9 +73,9 @@ module SymmetricEncryption
       begin
         file = self.new(ios, options)
         file = Zlib::GzipWriter.new(file) if compress
-        block.call(file)
+        block ? block.call(file) : file
       ensure
-        file.close if file
+        file.close if block && file
       end
     end
 
@@ -114,6 +121,16 @@ module SymmetricEncryption
       data.length
     end
 
+    # Write to the IO Stream as encrypted data
+    # Returns self
+    #
+    # Example:
+    #   file << "Hello.\n" << "This is Jack"
+    def <<(data)
+      write(data)
+      self
+    end
+
     private
 
     # Write the Encryption header if this is the first write

data/nbproject/private/private.xml

@@ -6,11 +6,11 @@
             <line>62</line>
         </file>
         <file>
-            <url>lib/symmetric_encryption/encryption.rb</url>
+            <url>lib/symmetric_encryption/symmetric_encryption.rb</url>
             <line>60</line>
         </file>
         <file>
-            <url>lib/symmetric_encryption/symmetric_encryption.rb</url>
+            <url>lib/symmetric_encryption/encryption.rb</url>
             <line>60</line>
         </file>
     </editor-bookmarks>

data/test/reader_test.rb

@@ -22,7 +22,6 @@ class ReaderTest < Test::Unit::TestCase
       @data_str = @data.inject('') {|sum,str| sum << str}
       @data_len = @data_str.length
       @data_encrypted = SymmetricEncryption.cipher.encrypt(@data_str)
-      @filename = '._test'
     end
 
     should "decrypt from string stream as a single read" do
@@ -68,9 +67,40 @@ class ReaderTest < Test::Unit::TestCase
       end
     end
 
-    should "decrypt from file" do
+    context "reading from file" do
+      # With and without header
+      [false, true].each do |header|
+        context "with#{'out' unless header} header" do
+          setup do
+            @filename = '._test'
+            @options = { :header => header }
+            # Create encrypted file
+            SymmetricEncryption::Writer.open(@filename, @options) do |file|
+              @data.inject(0) {|sum,str| sum + file.write(str)}
+            end
+          end
+
+          teardown do
+            File.delete(@filename) if File.exist?(@filename)
+          end
+
+          should "decrypt from file in a single read" do
+            decrypted = SymmetricEncryption::Reader.open(@filename) {|file| file.read}
+            assert_equal @data_str, decrypted
+          end
+
+          should "decrypt from file a line at a time" do
+            decrypted = SymmetricEncryption::Reader.open(@filename) do |file|
+              i = 0
+              file.each_line do |line|
+                assert_equal @data[i], line
+                i += 1
+              end
+            end
+          end
+        end
+      end
 
     end
   end
-
-end
+end

data/test/writer_test.rb

@@ -25,6 +25,10 @@ class EncryptionWriterTest < Test::Unit::TestCase
       @filename = '._test'
     end
 
+    teardown do
+      File.delete(@filename) if File.exist?(@filename)
+    end
+
     should "encrypt to string stream" do
       stream = StringIO.new
       file = SymmetricEncryption::Writer.new(stream)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 2
-  version: 0.5.2
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Reid Morrison
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-17 00:00:00 -04:00
+date: 2012-04-30 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -49,10 +49,6 @@ files:
 - nbproject/project.xml
 - Rakefile
 - README.md
-- symmetric-encryption-0.2.0.gem
-- symmetric-encryption-0.4.0.gem
-- symmetric-encryption-0.5.0.gem
-- symmetric-encryption-0.5.1.gem
 - test/attr_encrypted_test.rb
 - test/cipher_test.rb
 - test/config/database.yml