ronin-support 0.5.1 → 1.0.0.beta1

data/lib/ronin/support/compression/mixin.rb

@@ -0,0 +1,180 @@
+# 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/compression'
+
+module Ronin
+  module Support
+    module Compression
+      #
+      # Provides helper methods for compression algorithms/formats.
+      #
+      # @api public
+      #
+      # @since 1.0.0
+      #
+      module Mixin
+        #
+        # Zlib inflate a string.
+        #
+        # @param [String] string
+        #   The Zlib compressed input.
+        #
+        # @return [String]
+        #   The Zlib inflated form of the input.
+        #
+        # @example
+        #   zlib_inflate("x\x9C\xCBH\xCD\xC9\xC9\a\x00\x06,\x02\x15")
+        #   # => "hello"
+        #
+        # @api public
+        #
+        def zlib_inflate(string)
+          Compression.zlib_inflate(string)
+        end
+
+        #
+        # Zlib deflate a string.
+        #
+        # @param [String] string
+        #   The uncompressed input.
+        #
+        # @return [String]
+        #   The Zlib deflated form of the input.
+        #
+        # @example
+        #   zlib_deflate("hello")
+        #   # => "x\x9C\xCBH\xCD\xC9\xC9\a\x00\x06,\x02\x15"
+        #
+        # @api public
+        #
+        def zlib_deflate(string)
+          Compression.zlib_deflate(string)
+        end
+
+        #
+        # Creates a gzip stream around the IO object.
+        #
+        # @param [IO, Tempfile, StringIO, String] io
+        #   The IO object to read or write data to.
+        #
+        # @param [String] mode
+        #   The mode to open the gzip stream in.
+        #
+        # @yield [gz]
+        #   If a block is given, it will be passed the gzip stream object.
+        #
+        # @yieldparam [Ronin::Support::Compression::Gzip::Reader, Ronin::Support::Compression::Gzip::Writer] gz
+        #   The gzip reader or writer object.
+        #
+        # @return [Ronin::Support::Compression::Gzip::Reader, Ronin::Support::Compression::Gzip::Writer]
+        #   The gzip reader or writer object.
+        #
+        # @raise [ArgumentError]
+        #   The IO object must be either an `IO`, `Tempfile`, `StringIO`, or
+        #   `String` object. The mode must include either `r`, `w`, or `a`.
+        #
+        # @see https://rubydoc.info/stdlib/zlib/Zlib/GzipReader
+        # @see https://rubydoc.info/stdlib/zlib/Zlib/GzipWriter
+        # @see Gzip.new
+        #
+        # @api public
+        #
+        def gzip_stream(io, mode: 'r', &block)
+          Compression.gzip_stream(io,mode: mode,&block)
+        end
+
+        #
+        # Opens a gzip file for reading or writing.
+        #
+        # @param [String] path
+        #   The path to the gzip file.
+        #
+        # @param [String] mode
+        #   The mode to open the file as.
+        #
+        # @yield [gz]
+        #   If a block is given, it will be passed the gzip writer object.
+        #
+        # @yieldparam [Ronin::Support::Compression::Gzip::Reader, Ronin::Support::Compression::Gzip::Writer] gz
+        #   The gzip stream object.
+        #
+        # @return [Ronin::Support::Compression::Gzip::Reader, Ronin::Support::Compression::Gzip::Writer]
+        #   The gzip stream object.
+        #
+        # @raise [ArgumentError]
+        #   The mode must include either `r`, `w`, or `a`.
+        #
+        # @see https://rubydoc.info/stdlib/zlib/Zlib/GzipWriter
+        # @see Gzip.open
+        #
+        # @api public
+        #
+        def gzip_open(path, mode: 'r', &block)
+          Compression.gzip_open(path,mode: mode,&block)
+        end
+
+        #
+        # Opens the gzipped file for reading.
+        #
+        # @param [String] path
+        #   The path to the file to read.
+        #
+        # @yield [gz]
+        #   If a block is given, it will be passed the gzip reader object.
+        #
+        # @yieldparam [Ronin::Support::Compression::Gzip::Reader] gz
+        #   The gzip reader object.
+        #
+        # @return [Ronin::Support::Compression::Gzip::Reader]
+        #   The gzip reader object.
+        #
+        # @see #gzip_open
+        #
+        # @api public
+        #
+        def gunzip(path,&block)
+          Compression.gunzip(path,&block)
+        end
+
+        #
+        # Opens the gzip file for writing.
+        #
+        # @param [String] path
+        #   The path to the file to write to.
+        #
+        # @yield [gz]
+        #   If a block is given, it will be passed the gzip writer object.
+        #
+        # @yieldparam [Ronin::Support::Compression::Gzip::Writer] gz
+        #   The gzip writer object.
+        #
+        # @return [Ronin::Support::Compression::Gzip::Writer]
+        #   The gzip writer object.
+        #
+        # @see #gzip_open
+        #
+        # @api public
+        #
+        def gzip(path,&block)
+          Compression.gzip(path,&block)
+        end
+      end
+    end
+  end
+end

data/lib/ronin/{network/extensions/esmtp/net.rb → support/compression/zlib.rb}

@@ -1,24 +1,23 @@
+# frozen_string_literal: true
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
+# 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,
+# 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 <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/network/esmtp'
-
-module Net
-  extend Ronin::Network::ESMTP
+begin
+  require 'zlib'
+rescue ::LoadError
+  warn "WARNING: Ruby was not compiled with zlib support"
 end

data/lib/ronin/support/compression.rb

@@ -0,0 +1,174 @@
+# 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/compression/zlib'
+require 'ronin/support/compression/gzip'
+require 'ronin/support/compression/core_ext'
+
+module Ronin
+  module Support
+    #
+    # @api public
+    #
+    # @since 1.0.0
+    #
+    module Compression
+      #
+      # Zlib inflate a string.
+      #
+      # @param [String] string
+      #   The Zlib compressed input.
+      #
+      # @return [String]
+      #   The Zlib inflated form of the input.
+      #
+      # @example
+      #   Compression.zlib_inflate("x\x9C\xCBH\xCD\xC9\xC9\a\x00\x06,\x02\x15")
+      #   # => "hello"
+      #
+      # @api public
+      #
+      def self.zlib_inflate(string)
+        Zlib::Inflate.inflate(string)
+      end
+
+      #
+      # Zlib deflate a string.
+      #
+      # @param [String] string
+      #   The uncompressed input.
+      #
+      # @return [String]
+      #   The Zlib deflated form of the input.
+      #
+      # @example
+      #   Compression.zlib_deflate("hello")
+      #   # => "x\x9C\xCBH\xCD\xC9\xC9\a\x00\x06,\x02\x15"
+      #
+      # @api public
+      #
+      def self.zlib_deflate(string)
+        Zlib::Deflate.deflate(string)
+      end
+
+      #
+      # Creates a gzip stream around the IO object.
+      #
+      # @param [IO, StringIO] io
+      #   The IO object to read or write data to.
+      #
+      # @param [String] mode
+      #   The mode to open the gzip stream in.
+      #
+      # @yield [gz]
+      #   If a block is given, it will be passed the gzip stream object.
+      #
+      # @yieldparam [Gzip::Reader, Gzip::Writer] gz
+      #   The gzip reader or writer object.
+      #
+      # @return [Gzip::Reader, Gzip::Writer]
+      #   The gzip reader or writer object.
+      #
+      # @raise [ArgumentError]
+      #   The mode must include either `r`, `w`, or `a`.
+      #
+      # @see Gzip.new
+      #
+      # @api public
+      #
+      def self.gzip_stream(io, mode: 'r', &block)
+        Gzip.new(io, mode: mode, &block)
+      end
+
+      #
+      # Opens a gzip file for reading or writing.
+      #
+      # @param [String] path
+      #   The path to the gzip file.
+      #
+      # @param [String] mode
+      #   The mode to open the file as.
+      #
+      # @yield [output]
+      #   If a block is given, it will be passed the gzip writer object.
+      #
+      # @yieldparam [Gzip::Writer] output
+      #   The gzip writer object.
+      #
+      # @return [Gzip::Writer]
+      #   The gzip writer object.
+      #
+      # @raise [ArgumentError]
+      #   The mode must include either `r`, `w`, or `a`.
+      #
+      # @see Gzip.open
+      #
+      # @api public
+      #
+      def self.gzip_open(path, mode: 'r', &block)
+        Gzip.open(path, mode: mode, &block)
+      end
+
+      #
+      # Opens the gzipped file for reading.
+      #
+      # @param [String] path
+      #   The path to the file to read.
+      #
+      # @yield [gz]
+      #   If a block is given, it will be passed the gzip reader object.
+      #
+      # @yieldparam [Gzip::Reader] gz
+      #   The gzip reader object.
+      #
+      # @return [Gzip::Reader]
+      #   The gzip reader object.
+      #
+      # @see gzip_open
+      #
+      # @api public
+      #
+      def self.gunzip(path,&block)
+        gzip_open(path,&block)
+      end
+
+      #
+      # Opens the gzip file for writing.
+      #
+      # @param [String] path
+      #   The path to the file to write to.
+      #
+      # @yield [gz]
+      #   If a block is given, it will be passed the gzip writer object.
+      #
+      # @yieldparam [Gzip::Writer] gz
+      #   The gzip writer object.
+      #
+      # @return [Gzip::Writer]
+      #   The gzip writer object.
+      #
+      # @see gzip_open
+      #
+      # @api public
+      #
+      def self.gzip(path,&block)
+        gzip_open(path, mode: 'w', &block)
+      end
+    end
+  end
+end

data/lib/ronin/{extensions → support/core_ext}/enumerable.rb

@@ -1,20 +1,19 @@
+# frozen_string_literal: true
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
+# 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,
+# 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 <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 module Enumerable

data/lib/ronin/{extensions → support/core_ext}/file.rb

@@ -1,20 +1,19 @@
+# frozen_string_literal: true
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
+# 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,
+# 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 <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 class File
@@ -43,12 +42,10 @@ class File
   #
   # @api public
   #
-  def File.each_line(path)
+  def self.each_line(path)
     return enum_for(__method__,path) unless block_given?
 
-    File.open(path) do |file|
-      file.each_line { |line| yield line.chomp }
-    end
+    foreach(path) { |line| yield line.chomp }
   end
 
   #
@@ -78,30 +75,10 @@ class File
   #
   # @api public
   #
-  def File.each_row(path,separator=/\s+/)
+  def self.each_row(path,separator=/\s+/)
     return enum_for(__method__,path,separator) unless block_given?
 
-    File.each_line(path) { |line| yield line.split(separator) }
-  end
-
-  #
-  # Writes the given data to a specified path.
-  #
-  # @param [String] path
-  #   The path of the file to write to.
-  #
-  # @param [String] data
-  #   The data to write to the file.
-  #
-  # @return [nil]
-  #
-  # @example
-  #   File.write('dump.txt',data)
-  #
-  # @api public
-  #
-  def File.write(path,data)
-    File.open(path,'w') { |file| file.write(data) }
+    each_line(path) { |line| yield line.split(separator) }
   end
 
   #
@@ -115,7 +92,7 @@ class File
   #
   # @api public
   #
-  def File.escape_path(path)
+  def self.escape_path(path)
     path = path.to_s
 
     # remove any \0 characters first
@@ -124,7 +101,7 @@ class File
     # remove any home-dir expansions
     path.gsub!('~',"\\~")
 
-    path = File.expand_path(File.join('/',path))
+    path = expand_path(File.join('/',path))
 
     # remove the leading slash
     return path[1..-1]

data/lib/ronin/support/core_ext/integer.rb

@@ -0,0 +1,37 @@
+# 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/>.
+#
+
+class Integer
+
+  alias char chr
+
+  #
+  # Converts the Integer to hexadecimal.
+  #
+  # @return [String]
+  #   The integer in hexadecimal format.
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def to_hex
+    to_s(16)
+  end
+
+end

data/lib/ronin/support/core_ext/ipaddr.rb

@@ -0,0 +1,65 @@
+# 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 'ipaddr'
+
+class IPAddr
+
+  include Enumerable
+
+  # Socket families and IP address masks
+  #
+  # @api private
+  MASKS = {
+    Socket::AF_INET  => IN4MASK,
+    Socket::AF_INET6 => IN6MASK
+  }
+
+  #
+  # Iterates over each IP address that is included in the addresses
+  # netmask. Supports both IPv4 and IPv6 addresses.
+  #
+  # @yield [ip]
+  #   The block which will be passed every IP address covered be the
+  #   netmask of the IPAddr object.
+  #
+  # @yieldparam [String] ip
+  #   An IP address.
+  #
+  # @example
+  #   netblock = IPAddr.new('10.1.1.1/24')
+  #
+  #   netblock.each do |ip|
+  #     puts ip
+  #   end
+  #
+  # @api public
+  #
+  def each
+    return enum_for(__method__) unless block_given?
+
+    family_mask = MASKS[@family]
+
+    (0..((~@mask_addr) & family_mask)).each do |i|
+      yield _to_string(@addr | i)
+    end
+
+    return self
+  end
+
+end

data/lib/ronin/{extensions → support/core_ext}/kernel.rb

@@ -1,23 +1,26 @@
+# frozen_string_literal: true
 #
-# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
-# This file is part of Ronin Support.
-#
-# Ronin Support is free software: you can redistribute it and/or modify
+# 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,
+# 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 <http://www.gnu.org/licenses/>.
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+require 'ronin/support/mixin'
+
 module Kernel
+  include Ronin::Support::Mixin
+
   #
   # Calls the given block and ignores any raised exceptions.
   #
@@ -29,7 +32,7 @@ module Kernel
   #   exception occurred and was ignored.
   #
   # @example
-  #   attempt do
+  #   try do
   #     Resolv.getaddress('might.not.exist.com')
   #   end
   #
@@ -42,6 +45,4 @@ module Kernel
       return nil
     end
   end
-
-  alias attempt try
 end