ronin-support 0.5.1 → 1.0.0.beta1

data/lib/ronin/support/archive/zip/reader.rb

@@ -0,0 +1,273 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/archive/zip/reader/entry'
+require 'ronin/support/archive/zip/reader/statistics'
+
+require 'time'
+
+module Ronin
+  module Support
+    module Archive
+      module Zip
+        #
+        # Handles reading zip archives.
+        #
+        # @note
+        #   This provides a simple interface for reading zip archives using
+        #   the `unzip` command. If you need something more powerful, use the
+        #   [archive-zip] gem instead.
+        #
+        # [archive-zip]: https://github.com/javanthropus/archive-zip
+        #
+        # @api public
+        #
+        # @since 1.0.0
+        #
+        class Reader
+
+          include Enumerable
+
+          # The path to the zip archive that will be read.
+          #
+          # @return [String]
+          attr_reader :path
+
+          # The optional password to use when reading the zip archive.
+          #
+          # @return [String, nil]
+          attr_reader :password
+
+          #
+          # Initializes the zip archive reader.
+          #
+          # @param [String] path
+          #   The path to the zip archive file.
+          #
+          # @param [String, nil] password
+          #   Optional password to use when reading the zip archive.
+          #
+          # @yield [zip]
+          #   If a block is given, it will be yielded the new zip reader.
+          #
+          # @yieldparam [Reader] zip
+          #   The new zip reacher.
+          #
+          def initialize(path, password: nil)
+            @path     = File.expand_path(path)
+            @password = password
+
+            yield self if block_given?
+          end
+
+          #
+          # Alias to {#initialize new}.
+          #
+          # @param [String] path
+          #   The path to the zip archive file.
+          #
+          # @param [Hash{Symbol => Object}] kwargs
+          #   Additional keyword arguments for {#initialize new}.
+          #
+          # @option kwargs [String, nil] :password
+          #   Optional password to use when reading the zip archive.
+          #
+          # @yield [zip]
+          #   If a block is given, it will be yielded the new zip reader.
+          #
+          # @yieldparam [Reader] zip
+          #   The new zip reacher.
+          #
+          # @see #initialize
+          #
+          def self.open(path,**kwargs,&block)
+            new(path,**kwargs,&block)
+          end
+
+          #
+          # Lists the contents of the zip archive.
+          #
+          # @yield [entry]
+          #   If a block is given it will be passed each parsed entry in the
+          #   zip archive.
+          #
+          # @yieldparam [Entry] entry
+          #   An entry in the zip archive.
+          #
+          # @return [Enumerator, Statistics]
+          #   If no block is given an enumerator will be returned.
+          #   If a block was given, then a statistics object will be returned.
+          #
+          # @note
+          #   This method actually executes the `unzip -v -l ZIP` command
+          #   and parses it's output.
+          #
+          def each
+            return enum_for(__method__) unless block_given?
+
+            io = IO.popen(command_argv('-v','-l',@path))
+
+            # skip lines until the "---------  ---------- -----   ----" line
+            until io.eof?
+              break if io.readline.start_with?('-')
+            end
+
+            until io.eof?
+              line = io.readline(chomp: true)
+
+              unless line.start_with?('-')
+                yield parse_entry_line(line)
+              else
+                # reached the "---------                     -------" line
+                break
+              end
+            end
+
+            last_line = io.readline(chomp: true)
+            return parse_statistics_line(last_line)
+          end
+
+          alias list each
+          alias entries to_a
+
+          #
+          # Finds the entry with the given name.
+          #
+          # @param [String] name
+          #   The file name to search for.
+          #
+          # @return [Entry, nil]
+          #   The matching entry or `nil` if no entry could be found.
+          #
+          def [](name)
+            find { |entry| entry.name == name }
+          end
+
+          #
+          # Reads the contents of an entry from the zip archive.
+          #
+          # @param [String] name
+          #   The name of the entry to read.
+          #
+          # @param [Integer, nil] length
+          #   Optional number of bytes to read.
+          #
+          # @return [String]
+          #   The read data.
+          #
+          # @note
+          #   This method actually executes the `unzip -p ZIP FILE` command
+          #   and reads it's output.
+          #
+          def read(name, length: nil)
+            io = IO.popen(command_argv('-p', @path, name))
+
+            if length then io.read(length)
+            else           io.read
+            end
+          end
+
+          private
+          
+          #
+          # Creates an `unzip` command with the additional arguments.
+          #
+          # @param [Array<String>] arguments
+          #   Additional arguments for the `unzip` command.
+          #
+          # @return [Array<String>]
+          #   The `unzip` command argv.
+          #
+          def command_argv(*arguments)
+            argv = ['unzip']
+
+            if @password
+              argv << '-P' << @password
+            end
+
+            argv.concat(arguments)
+          end
+
+          # Translates the Method column in `unzip -v -l` output to Symbols.
+          METHODS = {
+            'Stored' => :stored,
+            'Defl:N' => :deflate
+          }
+
+          #
+          # Parses a entry line from the output of `unzip -v -l ZIP`.
+          #
+          # @param [String] line
+          #   The line to parse.
+          #
+          # @return [Entry]
+          #   The parsed entry.
+          #
+          def parse_entry_line(line)
+            length, method, size, compression, date, time, crc32, name =
+              line.lstrip.split(/\s+/,8)
+
+            time_fmt = case date
+                       when /\A\d{2}-\d{2}-\d{4}\z/ then "%m-%d-%Y %H:%M"
+                       when /\A\d{4}-\d{2}-\d{2}\z/ then "%Y-%m-%d %H:%M"
+                       else
+                         raise(NotImplementedError,"unrecognized date format: #{date.inspect}")
+                       end
+
+            length      = length.to_i
+            method      = METHODS.fetch(method)
+            size        = size.to_i
+            compression = compression.chomp('%').to_i
+            time        = Time.strptime("#{date} #{time}",time_fmt)
+            date        = time.to_date
+
+            return Entry.new(self, length:      length,
+                                   method:      method,
+                                   size:        size,
+                                   compression: compression,
+                                   date:        date,
+                                   time:        time,
+                                   crc32:       crc32,
+                                   name:        name)
+          end
+
+          #
+          # Parses the last line from the output of `unzip -v -l ZIP`.
+          #
+          # @param [String] line
+          #   The line to parse.
+          #
+          # @return [Statistics]
+          #   The parsed statistics.
+          #
+          def parse_statistics_line(line)
+            length, size, compression, files, _ = line.lstrip.split(/\s+/,5)
+
+            return Statistics.new(
+              length:      length.to_i,
+              size:        size.to_i,
+              compression: compression.chomp('%').to_i,
+              files:       files.to_i
+            )
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/archive/zip/writer.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'tmpdir'
+require 'fileutils'
+
+module Ronin
+  module Support
+    module Archive
+      module Zip
+        #
+        # Handles creating zip archives.
+        #
+        # @note
+        #   This provides a simple interface for creating zip archives using
+        #   the `zip` command. If you need something more powerful, use the
+        #   [archive-zip] gem instead.
+        #
+        # [archive-zip]: https://github.com/javanthropus/archive-zip
+        #
+        # @api public
+        #
+        # @since 1.0.0
+        #
+        class Writer
+
+          # The path to the zip archive.
+          #
+          # @return [String]
+          attr_reader :path
+
+          # The optional password for the zip archive.
+          #
+          # @return [String, nil]
+          attr_reader :password
+
+          # The temp directory where the contents of the zip archive will be
+          # written into before zipping.
+          #
+          # @return [String]
+          #
+          # @api private
+          attr_reader :tempdir
+
+          #
+          # Initializes the zip writer.
+          #
+          # @param [String] path
+          #   The path to the zip archive.
+          #
+          # @param [String, nil] password
+          #   The optional password for the zip archive.
+          #
+          # @yield [self]
+          #   If a block is given it will be passed the zip archive writer.
+          #
+          def initialize(path, password: nil)
+            @path     = File.expand_path(path)
+            @password = password
+
+            @tempdir  = Dir.mktmpdir('ronin-support')
+
+            if block_given?
+              yield self
+              close
+            end
+          end
+
+          #
+          # Alias for {new}.
+          #
+          # @param [String] path
+          #   The path to the zip archive.
+          #
+          # @param [Hash{Symbol => Object}] kwargs
+          #   Additional keyword arguments for {new}.
+          #
+          # @option kwargs [String, nil] :password
+          #   The optional password for the zip archive.
+          #
+          # @yield [zip]
+          #   If a block is given it will be passed the zip archive writer.
+          #
+          # @yieldparam [Writer] zip
+          #   The newly created zip archive writer.
+          #
+          # @return [Writer]
+          #   The newly created zip archive writer.
+          #
+          # @see new
+          #
+          def self.open(path,**kwargs,&block)
+            new(path,**kwargs,&block)
+          end
+
+          #
+          # Adds a file to the zip archive.
+          #
+          # @param [String] name
+          #   The relative path to the file.
+          #
+          # @param [String, nil] contents
+          #   The optional contents for the file.
+          #
+          # @yield [file]
+          #   If a block is given, it will be passed the opened file for
+          #   writing.
+          #
+          # @yieldparam [File] file
+          #   The opened file for writing.
+          #
+          def add_file(name,contents=nil,&block)
+            file_path = File.join(@tempdir,name)
+
+            if contents
+              File.write(file_path,contents)
+            else
+              File.open(file_path,'w',&block)
+            end
+          end
+
+          #
+          # Saves the contents of the zip archive to {#path}.
+          #
+          # @api private
+          #
+          def save
+            Dir.chdir(@tempdir) do
+              args = ['-q']
+
+              if @password
+                args << '-P' << @password
+              end
+
+              system('zip',*args,'-r',@path,'.')
+            end
+          end
+
+          #
+          # Cleanup the zip archive's {#tempdir}.
+          #
+          # @api private
+          #
+          def cleanup
+            FileUtils.rm_r(@tempdir)
+          end
+
+          #
+          # Closes the zip archive.
+          #
+          def close
+            save
+            cleanup
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/archive/zip.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/archive/zip/reader'
+require 'ronin/support/archive/zip/writer'
+
+module Ronin
+  module Support
+    module Archive
+      #
+      # Handles zip archive reading/writing.
+      #
+      # @api public
+      #
+      # @since 1.0.0
+      #
+      module Zip
+        #
+        # Creates a zip archive reader or writer object.
+        #
+        # @param [String] path
+        #   The path of the zip archive.
+        #
+        # @param [String] mode
+        #   The mode to open the zip archive in.
+        #
+        # @yield [zip]
+        #   If a block is given, it will be passed the zip stream object.
+        #
+        # @yieldparam [Reader, Writer] zip
+        #   The zip reader or writer object.
+        #
+        # @return [Reader, Writer]
+        #   The zip reader or writer object.
+        #
+        # @raise [ArgumentError]
+        #   The mode must include either `r`, `w`, or `a`.
+        #
+        # @api public
+        #
+        def self.new(path, mode: 'r', &block)
+          zip_class = if mode.include?('w') || mode.include?('a')
+                        Writer
+                      elsif mode.include?('r')
+                        Reader
+                      else
+                        raise(ArgumentError,"mode argument must include either 'r', 'w', or 'a': #{mode.inspect}")
+                      end
+
+          return zip_class.new(path,&block)
+        end
+
+        #
+        # Opens a zip file for reading or writing.
+        #
+        # @param [String] path
+        #   The path to the zip file.
+        #
+        # @param [String] mode
+        #   The mode to open the zip file in.
+        #
+        # @yield [gz]
+        #   If a block is given, it will be passed the zip writer object.
+        #
+        # @yieldparam [Reader, Writer] gz
+        #   The zip writer object.
+        #
+        # @return [Reader, Writer]
+        #   The zip writer object.
+        #
+        # @raise [ArgumentError]
+        #   The mode must include either `r`, `w`, or `a`.
+        #
+        # @api public
+        #
+        def self.open(path, mode: 'r', &block)
+          zip_class = if mode.include?('w') || mode.include?('a')
+                        Writer
+                      elsif mode.include?('r')
+                        Reader
+                      else
+                        raise(ArgumentError,"mode argument must include either 'r', 'w', or 'a'")
+                      end
+
+          return zip_class.open(path,&block)
+        end
+      end
+    end
+  end
+end