rubyzip 3.0.2 → 3.2.2

data/lib/zip/entry.rb

@@ -127,10 +127,10 @@ module Zip
     # Returns modification time by default.
     def time(component: :mtime)
       time =
-        if @extra['UniversalTime']
-          @extra['UniversalTime'].send(component)
-        elsif @extra['NTFS']
-          @extra['NTFS'].send(component)
+        if @extra[:universaltime]
+          @extra[:universaltime].send(component)
+        elsif @extra[:ntfs]
+          @extra[:ntfs].send(component)
         end
 
       # Standard time field in central directory has local time
@@ -155,13 +155,13 @@ module Zip
     # Sets modification time by default.
     def time=(value, component: :mtime)
       @dirty = true
-      unless @extra.member?('UniversalTime') || @extra.member?('NTFS')
-        @extra.create('UniversalTime')
+      unless @extra.member?(:universaltime) || @extra.member?(:ntfs)
+        @extra.create(:universaltime)
       end
 
       value = DOSTime.from_time(value)
       comp = "#{component}=" unless component.to_s.end_with?('=')
-      (@extra['UniversalTime'] || @extra['NTFS']).send(comp, value)
+      (@extra[:universaltime] || @extra[:ntfs]).send(comp, value)
       @time = value if component == :mtime
     end
 
@@ -179,7 +179,7 @@ module Zip
 
     # Does this entry return time fields with accurate timezone information?
     def absolute_time?
-      @extra.member?('UniversalTime') || @extra.member?('NTFS')
+      @extra.member?(:universaltime) || @extra.member?(:ntfs)
     end
 
     # Return the compression method for this entry.
@@ -200,7 +200,12 @@ module Zip
 
     # Does this entry use the ZIP64 extensions?
     def zip64?
-      !@extra['Zip64'].nil?
+      !@extra[:zip64].nil?
+    end
+
+    # Is this entry encrypted with AES encryption?
+    def aes?
+      !@extra[:aes].nil?
     end
 
     def file_type_is?(type) # :nodoc:
@@ -382,11 +387,12 @@ module Zip
 
       read_extra_field(extra, local: true)
       parse_zip64_extra(true)
+      parse_aes_extra
       @local_header_size = calculate_local_header_size
     end
 
     def pack_local_entry # :nodoc:
-      zip64 = @extra['Zip64']
+      zip64 = @extra[:zip64]
       [::Zip::LOCAL_ENTRY_SIGNATURE,
        @version_needed_to_extract, # version needed to extract
        @gp_flags, # @gp_flags
@@ -400,9 +406,17 @@ module Zip
        @extra ? @extra.local_size : 0].pack('VvvvvvVVVvv')
     end
 
-    def write_local_entry(io, rewrite: false) # :nodoc:
+    def write_local_entry(io, suppress_extra_fields: false, rewrite: false) # :nodoc:
       prep_local_zip64_extra
-      verify_local_header_size! if rewrite
+
+      # If we are rewriting the local header, then we verify that we haven't changed
+      # its size. At this point we have to keep extra fields if they are present.
+      if rewrite
+        verify_local_header_size!
+      elsif suppress_extra_fields
+        @extra.suppress_fields!(suppress_extra_fields)
+      end
+
       @local_header_offset = io.tell
 
       io << pack_local_entry
@@ -430,10 +444,7 @@ module Zip
         _, # diskNumberStart
         @internal_file_attributes,
         @external_file_attributes,
-        @local_header_offset,
-        @name,
-        @extra,
-        @comment = buf.unpack('VCCvvvvvVVVvvvvvVV')
+        @local_header_offset = buf.unpack('VCCvvvvvVVVvvvvvVV')
     end
 
     def set_ftype_from_c_dir_entry # :nodoc:
@@ -511,6 +522,7 @@ module Zip
       check_c_dir_entry_comment_size
       set_ftype_from_c_dir_entry
       parse_zip64_extra(false)
+      parse_aes_extra
     end
 
     def file_stat(path) # :nodoc:
@@ -559,7 +571,7 @@ module Zip
     end
 
     def pack_c_dir_entry # :nodoc:
-      zip64 = @extra['Zip64']
+      zip64 = @extra[:zip64]
       [
         @header_signature,
         @version, # version of encoding software
@@ -578,14 +590,11 @@ module Zip
         zip64 && zip64.disk_start_number ? 0xFFFF : 0, # disk number start
         @internal_file_attributes, # file type (binary=0, text=1)
         @external_file_attributes, # native filesystem attributes
-        zip64 && zip64.relative_header_offset ? 0xFFFFFFFF : @local_header_offset,
-        @name,
-        @extra,
-        @comment
+        zip64 && zip64.relative_header_offset ? 0xFFFFFFFF : @local_header_offset
       ].pack('VCCvvvvvVVVvvvvvVV')
     end
 
-    def write_c_dir_entry(io) # :nodoc:
+    def write_c_dir_entry(io, suppress_extra_fields: false) # :nodoc:
       prep_cdir_zip64_extra
 
       case @fstype
@@ -607,6 +616,7 @@ module Zip
         end
       end
 
+      @extra.suppress_fields!(suppress_extra_fields) if suppress_extra_fields
       io << pack_c_dir_entry
 
       io << @name
@@ -667,7 +677,7 @@ module Zip
                when 'file'
                  if name_is_directory?
                    raise ArgumentError,
-                         "entry name '#{newEntry}' indicates directory entry, but " \
+                         "entry name '#{@name}' indicates a directory entry, but " \
                          "'#{src_path}' is not a directory"
                  end
                  :file
@@ -677,7 +687,7 @@ module Zip
                when 'link'
                  if name_is_directory?
                    raise ArgumentError,
-                         "entry name '#{newEntry}' indicates directory entry, but " \
+                         "entry name '#{@name}' indicates a directory entry, but " \
                          "'#{src_path}' is not a directory"
                  end
                  :symlink
@@ -792,14 +802,28 @@ module Zip
       return unless zip64?
 
       if for_local_header
-        @size, @compressed_size = @extra['Zip64'].parse(@size, @compressed_size)
+        @size, @compressed_size = @extra[:zip64].parse(@size, @compressed_size)
       else
-        @size, @compressed_size, @local_header_offset = @extra['Zip64'].parse(
+        @size, @compressed_size, @local_header_offset = @extra[:zip64].parse(
           @size, @compressed_size, @local_header_offset
         )
       end
     end
 
+    def parse_aes_extra # :nodoc:
+      return unless aes?
+
+      if @extra[:aes].vendor_id != 'AE'
+        raise Error, "Unsupported encryption method #{@extra[:aes].vendor_id}"
+      end
+
+      unless ::Zip::AESEncryption::VERSIONS.include? @extra[:aes].vendor_version
+        raise Error, "Unsupported encryption style #{@extra[:aes].vendor_version}"
+      end
+
+      @compression_method = @extra[:aes].compression_method if ftype != :directory
+    end
+
     # For DEFLATED compression *only*: set the general purpose flags 1 and 2 to
     # indicate compression level. This seems to be mainly cosmetic but they are
     # generally set by other tools - including in docx files. It is these flags
@@ -830,7 +854,7 @@ module Zip
       # If we already have a ZIP64 extra (placeholder) then we must fill it in.
       if zip64? || @size.nil? || @size >= 0xFFFFFFFF || @compressed_size >= 0xFFFFFFFF
         @version_needed_to_extract = VERSION_NEEDED_TO_EXTRACT_ZIP64
-        zip64 = @extra['Zip64'] || @extra.create('Zip64')
+        zip64 = @extra[:zip64] || @extra.create(:zip64)
 
         # Local header always includes size and compressed size.
         zip64.original_size = @size || 0
@@ -844,7 +868,7 @@ module Zip
       if (@size && @size >= 0xFFFFFFFF) || @compressed_size >= 0xFFFFFFFF ||
          @local_header_offset >= 0xFFFFFFFF
         @version_needed_to_extract = VERSION_NEEDED_TO_EXTRACT_ZIP64
-        zip64 = @extra['Zip64'] || @extra.create('Zip64')
+        zip64 = @extra[:zip64] || @extra.create(:zip64)
 
         # Central directory entry entries include whichever fields are necessary.
         zip64.original_size = @size if @size && @size >= 0xFFFFFFFF

data/lib/zip/extra_field/aes.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Zip
+  # Info-ZIP Extra for AES encryption
+  class ExtraField::AES < ExtraField::Generic # :nodoc:
+    attr_reader :vendor_version, :vendor_id, :encryption_strength, :compression_method
+
+    HEADER_ID = [0x9901].pack('v')
+    register_map
+
+    def initialize(binstr = nil)
+      @vendor_version = nil
+      @vendor_id = nil
+      @encryption_strength = nil
+      @compression_method = nil
+      binstr && merge(binstr)
+    end
+
+    def ==(other)
+      @vendor_version == other.vendor_version &&
+        @vendor_id == other.vendor_id &&
+        @encryption_strength == other.encryption_strength &&
+        @compression_method == other.compression_method
+    end
+
+    def merge(binstr)
+      return if binstr.empty?
+
+      size, content = initial_parse(binstr)
+      (size && content) || return
+
+      @vendor_version, @vendor_id,
+        @encryption_strength, @compression_method = content.unpack('va2Cv')
+    end
+
+    # We can never suppress the AES extra field as it is needed to read the file.
+    def suppress?
+      false
+    end
+
+    def pack_for_local
+      [@vendor_version, @vendor_id,
+       @encryption_strength, @compression_method].pack('va2Cv')
+    end
+
+    def pack_for_c_dir
+      pack_for_local
+    end
+  end
+end

data/lib/zip/extra_field/generic.rb

@@ -9,7 +9,7 @@ module Zip
     end
 
     def self.name
-      @name ||= to_s.split('::')[-1]
+      @name ||= to_s.split('::').last.downcase.to_sym
     end
 
     # return field [size, content] or false
@@ -24,6 +24,12 @@ module Zip
       [binstr[2, 2].unpack1('v'), binstr[4..]]
     end
 
+    # Default strategy is to suppress all extra fields if we're asked to.
+    # Specific extra field types can override this if they need to be kept.
+    def suppress?
+      true
+    end
+
     def to_local_bin
       s = pack_for_local
       (self.class.const_get(:HEADER_ID) + [s.bytesize].pack('v')) << s

data/lib/zip/extra_field/unknown.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'generic'
+
 module Zip
   # A class to hold unknown extra fields so that they are preserved.
-  class ExtraField::Unknown # :nodoc:
+  class ExtraField::Unknown < ExtraField::Generic # :nodoc:
     def initialize
       @local_bin = +''
       @cdir_bin = +''

data/lib/zip/extra_field/zip64.rb

@@ -56,6 +56,13 @@ module Zip
     end
     private :extract
 
+    # We can suppress the zip64 extra field unless we know the size is large or
+    # the relative header offset is large (for central directory entries).
+    def suppress?
+      !(@original_size && @original_size >= 0xFFFFFFFF) ||
+        (@relative_header_offset && @relative_header_offset >= 0xFFFFFFFF)
+    end
+
     def pack_for_local
       # Local header entries must contain original size and compressed size;
       # other fields do not apply.

data/lib/zip/extra_field.rb

@@ -19,14 +19,14 @@ module Zip
     end
 
     def extra_field_type_unknown(binstr, len, index, local)
-      self['Unknown'] ||= Unknown.new
+      self[:unknown] ||= Unknown.new
 
       if !len || len + 4 > binstr[index..].bytesize
-        self['Unknown'].merge(binstr[index..], local: local)
+        self[:unknown].merge(binstr[index..], local: local)
         return
       end
 
-      self['Unknown'].merge(binstr[index, len + 4], local: local)
+      self[:unknown].merge(binstr[index, len + 4], local: local)
     end
 
     def merge(binstr, local: false)
@@ -57,10 +57,17 @@ module Zip
     # signature/size does not prevent known fields from being read back in.
     def ordered_values
       result = []
-      each { |k, v| k == 'Unknown' ? result.push(v) : result.unshift(v) }
+      each { |k, v| k == :unknown ? result.push(v) : result.unshift(v) }
       result
     end
 
+    # Remove any extra fields that indicate they can be safely suppressed.
+    def suppress_fields!(fields)
+      reject! do |k, v|
+        v.suppress? if fields == true || [*fields].include?(k)
+      end
+    end
+
     def to_local_bin
       ordered_values.map! { |v| v.to_local_bin.force_encoding('BINARY') }.join
     end
@@ -91,6 +98,7 @@ require 'zip/extra_field/old_unix'
 require 'zip/extra_field/unix'
 require 'zip/extra_field/zip64'
 require 'zip/extra_field/ntfs'
+require 'zip/extra_field/aes'
 
 # Copyright (C) 2002, 2003 Thomas Sondergaard
 # rubyzip is free software; you can redistribute it and/or

data/lib/zip/file.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'fileutils'
 require 'forwardable'
 
 require_relative 'file_split'
@@ -75,7 +76,8 @@ module Zip
                    restore_ownership: DEFAULT_RESTORE_OPTIONS[:restore_ownership],
                    restore_permissions: DEFAULT_RESTORE_OPTIONS[:restore_permissions],
                    restore_times: DEFAULT_RESTORE_OPTIONS[:restore_times],
-                   compression_level: ::Zip.default_compression)
+                   compression_level: ::Zip.default_compression,
+                   suppress_extra_fields: false)
       super()
 
       @name    = path_or_io.respond_to?(:path) ? path_or_io.path : path_or_io
@@ -83,10 +85,11 @@ module Zip
 
       initialize_cdir(path_or_io, buffer: buffer)
 
-      @restore_ownership   = restore_ownership
-      @restore_permissions = restore_permissions
-      @restore_times       = restore_times
-      @compression_level   = compression_level
+      @restore_ownership     = restore_ownership
+      @restore_permissions   = restore_permissions
+      @restore_times         = restore_times
+      @compression_level     = compression_level
+      @suppress_extra_fields = suppress_extra_fields
     end
 
     class << self
@@ -97,13 +100,14 @@ module Zip
                restore_ownership: DEFAULT_RESTORE_OPTIONS[:restore_ownership],
                restore_permissions: DEFAULT_RESTORE_OPTIONS[:restore_permissions],
                restore_times: DEFAULT_RESTORE_OPTIONS[:restore_times],
-               compression_level: ::Zip.default_compression)
-
-        zf = ::Zip::File.new(file_name, create:              create,
-                                        restore_ownership:   restore_ownership,
-                                        restore_permissions: restore_permissions,
-                                        restore_times:       restore_times,
-                                        compression_level:   compression_level)
+               compression_level: ::Zip.default_compression,
+               suppress_extra_fields: false)
+        zf = ::Zip::File.new(file_name, create:                create,
+                                        restore_ownership:     restore_ownership,
+                                        restore_permissions:   restore_permissions,
+                                        restore_times:         restore_times,
+                                        compression_level:     compression_level,
+                                        suppress_extra_fields: suppress_extra_fields)
 
         return zf unless block_given?
 
@@ -122,8 +126,8 @@ module Zip
                       restore_ownership: DEFAULT_RESTORE_OPTIONS[:restore_ownership],
                       restore_permissions: DEFAULT_RESTORE_OPTIONS[:restore_permissions],
                       restore_times: DEFAULT_RESTORE_OPTIONS[:restore_times],
-                      compression_level: ::Zip.default_compression)
-
+                      compression_level: ::Zip.default_compression,
+                      suppress_extra_fields: false)
         unless IO_METHODS.map { |method| io.respond_to?(method) }.all? || io.kind_of?(String)
           raise 'Zip::File.open_buffer expects a String or IO-like argument' \
                 "(responds to #{IO_METHODS.join(', ')}). Found: #{io.class}"
@@ -132,10 +136,11 @@ module Zip
         io = ::StringIO.new(io) if io.kind_of?(::String)
 
         zf = ::Zip::File.new(io, create: create, buffer: true,
-                                 restore_ownership:   restore_ownership,
-                                 restore_permissions: restore_permissions,
-                                 restore_times:       restore_times,
-                                 compression_level:   compression_level)
+                                 restore_ownership:     restore_ownership,
+                                 restore_permissions:   restore_permissions,
+                                 restore_times:         restore_times,
+                                 compression_level:     compression_level,
+                                 suppress_extra_fields: suppress_extra_fields)
 
         return zf unless block_given?
 
@@ -191,7 +196,6 @@ module Zip
                           extra: nil, compressed_size: nil, crc: nil,
                           compression_method: nil, compression_level: nil,
                           size: nil, time: nil, &a_proc)
-
       new_entry =
         if entry.kind_of?(Entry)
           entry
@@ -288,7 +292,7 @@ module Zip
       return if name.kind_of?(StringIO) || !commit_required?
 
       on_success_replace do |tmp_file|
-        ::Zip::OutputStream.open(tmp_file) do |zos|
+        ::Zip::OutputStream.open(tmp_file, suppress_extra_fields: @suppress_extra_fields) do |zos|
           @cdir.each do |e|
             e.write_to_zip_output_stream(zos)
             e.clean_up
@@ -304,7 +308,7 @@ module Zip
     def write_buffer(io = ::StringIO.new)
       return io unless commit_required?
 
-      ::Zip::OutputStream.write_buffer(io) do |zos|
+      ::Zip::OutputStream.write_buffer(io, suppress_extra_fields: @suppress_extra_fields) do |zos|
         @cdir.each { |e| e.write_to_zip_output_stream(zos) }
         zos.comment = comment
       end
@@ -412,7 +416,7 @@ module Zip
           ::File.chmod(@file_permissions, name) unless @create
         end
       ensure
-        ::File.unlink(tmp_filename) if ::File.exist?(tmp_filename)
+        FileUtils.rm_f(tmp_filename)
       end
     end
   end

data/lib/zip/filesystem/file.rb

@@ -27,7 +27,7 @@ module Zip
 
       def unix_mode_cmp(filename, mode)
         e = find_entry(filename)
-        e.fstype == FSTYPE_UNIX && ((e.external_file_attributes >> 16) & mode) != 0
+        e.fstype == FSTYPE_UNIX && (e.external_file_attributes >> 16).anybits?(mode)
       rescue Errno::ENOENT
         false
       end
@@ -102,18 +102,19 @@ module Zip
         @mapped_zip.get_entry(filename).size
       end
 
-      # Returns nil for not found and nil for directories
+      # Returns nil for not found and nil for directories.
+      # We disable the cop here for compatibility with `::File.size?`.
       def size?(filename)
         entry = @mapped_zip.find_entry(filename)
-        entry.nil? || entry.directory? ? nil : entry.size
+        entry.nil? || entry.directory? ? nil : entry.size # rubocop:disable Style/ReturnNilInPredicateMethodDefinition
       end
 
       def chown(owner, group, *filenames)
         filenames.each do |filename|
           e = find_entry(filename)
-          e.extra.create('IUnix') unless e.extra.member?('IUnix')
-          e.extra['IUnix'].uid = owner
-          e.extra['IUnix'].gid = group
+          e.extra.create(:iunix) unless e.extra.member?(:iunix)
+          e.extra[:iunix].uid = owner
+          e.extra[:iunix].gid = group
         end
         filenames.size
       end

data/lib/zip/filesystem/file_stat.rb

@@ -36,8 +36,8 @@ module Zip
 
         def gid
           e = find_entry
-          if e.extra.member? 'IUnix'
-            e.extra['IUnix'].gid || 0
+          if e.extra.member? :iunix
+            e.extra[:iunix].gid || 0
           else
             0
           end
@@ -45,8 +45,8 @@ module Zip
 
         def uid
           e = find_entry
-          if e.extra.member? 'IUnix'
-            e.extra['IUnix'].uid || 0
+          if e.extra.member? :iunix
+            e.extra[:iunix].uid || 0
           else
             0
           end

data/lib/zip/inflater.rb

@@ -10,7 +10,7 @@ module Zip
     end
 
     def read(length = nil, outbuf = +'')
-      return (length.nil? || length.zero? ? '' : nil) if eof
+      return (length.nil? || length.zero? ? '' : nil) if eof?
 
       while length.nil? || (@buffer.bytesize < length)
         break if input_finished?
@@ -21,11 +21,12 @@ module Zip
       outbuf.replace(@buffer.slice!(0...(length || @buffer.bytesize)))
     end
 
-    def eof
+    def eof?
       @buffer.empty? && input_finished?
     end
 
-    alias eof? eof
+    # Alias for compatibility. Remove for version 4.
+    alias eof eof?
 
     private
 

data/lib/zip/input_stream.rb

@@ -55,7 +55,7 @@ module Zip
       super()
       @archive_io = get_io(context, offset)
       @decompressor = ::Zip::NullDecompressor
-      @decrypter = decrypter || ::Zip::NullDecrypter.new
+      @decrypter = decrypter
       @current_entry = nil
       @complete_entry = nil
     end
@@ -135,29 +135,48 @@ module Zip
       @current_entry = ::Zip::Entry.read_local_entry(@archive_io)
       return if @current_entry.nil?
 
-      if @current_entry.encrypted? && @decrypter.kind_of?(NullDecrypter)
-        raise Error,
-              'A password is required to decode this zip file'
-      end
-
       if @current_entry.incomplete? && @current_entry.compressed_size == 0 && !@complete_entry
         raise StreamingError, @current_entry
       end
 
-      @decrypted_io = get_decrypted_io
-      @decompressor = get_decompressor
+      @decompressor = assemble_io
       flush
       @current_entry
     end
 
+    def assemble_io # :nodoc:
+      io = if @current_entry.encrypted?
+             raise Error, 'A password is required to decode this zip file.' if @decrypter.nil?
+
+             get_decrypted_io
+           else
+             @archive_io
+           end
+
+      get_decompressor(io)
+    end
+
     def get_decrypted_io # :nodoc:
       header = @archive_io.read(@decrypter.header_bytesize)
       @decrypter.reset!(header)
 
-      ::Zip::DecryptedIo.new(@archive_io, @decrypter)
+      compressed_size =
+        if @current_entry.incomplete? && @current_entry.crc == 0 &&
+           @current_entry.compressed_size == 0 && @complete_entry
+          @complete_entry.compressed_size
+        else
+          @current_entry.compressed_size
+        end
+
+      if @decrypter.kind_of?(::Zip::AESDecrypter)
+        compressed_size -= @decrypter.header_bytesize
+        compressed_size -= ::Zip::AESEncryption::AUTHENTICATION_CODE_LENGTH
+      end
+
+      ::Zip::DecryptedIo.new(@archive_io, @decrypter, compressed_size)
     end
 
-    def get_decompressor # :nodoc:
+    def get_decompressor(io) # :nodoc:
       return ::Zip::NullDecompressor if @current_entry.nil?
 
       decompressed_size =
@@ -175,7 +194,7 @@ module Zip
         raise ::Zip::CompressionMethodError, @current_entry.compression_method
       end
 
-      decompressor_class.new(@decrypted_io, decompressed_size)
+      decompressor_class.new(io, decompressed_size)
     end
 
     def produce_input # :nodoc:
@@ -183,7 +202,7 @@ module Zip
     end
 
     def input_finished? # :nodoc:
-      @decompressor.eof
+      @decompressor.eof?
     end
   end
 end

data/lib/zip/ioextras/abstract_input_stream.rb

@@ -117,11 +117,12 @@ module Zip
 
       alias each each_line
 
-      def eof
+      def eof?
         @output_buffer.empty? && input_finished?
       end
 
-      alias eof? eof
+      # Alias for compatibility. Remove for version 4.
+      alias eof eof?
     end
   end
 end

data/lib/zip/null_decompressor.rb

@@ -8,11 +8,12 @@ module Zip
       nil
     end
 
-    def eof
+    def eof?
       true
     end
 
-    alias eof? eof
+    # Alias for compatibility. Remove for version 4.
+    alias eof eof?
   end
 end