ronin-support 0.5.1 → 1.0.0.beta1

data/lib/ronin/support/cli/printing.rb

@@ -0,0 +1,216 @@
+# 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 <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/cli/ansi'
+
+module Ronin
+  module Support
+    module CLI
+      #
+      # Printing methods.
+      #
+      # @since 1.0.0
+      #
+      module Printing
+        @@debug = false
+
+        #
+        # The current debug mode.
+        #
+        # @return [Boolean]
+        #   The new debug mode.
+        #
+        # @api semipublic
+        #
+        def self.debug?
+          @@debug
+        end
+
+        #
+        # Sets the debug mode.
+        #
+        # @param [Boolean] debug_mode
+        #   The new debug mode.
+        #
+        # @return [Boolean]
+        #   The new debug mode.
+        #
+        # @api semipublic
+        #
+        def self.debug=(debug_mode)
+          @@debug = debug_mode
+        end
+
+        # Enables or disables debug mode.
+        #
+        # @api semipublic
+        attr_writer :debug
+
+        #
+        # Determines if debug mode has been enabled.
+        #
+        # @return [Boolean]
+        #
+        # @api public
+        #
+        def debug?
+          @debug || Printing.debug?
+        end
+
+        #
+        # Prints an info message.
+        #
+        # @param [String] message
+        #   The message to print.
+        #
+        # @return [Boolean]
+        #   Specifies whether the messages were successfully printed.
+        #
+        # @example
+        #   print_info "Connecting ..."
+        #   # [*] Connecting ...
+        #
+        # @api public
+        #
+        def print_info(message)
+          $stdout.puts "#{ANSI.bold(ANSI.white('[*]'))} #{message}#{ANSI.reset}"
+          return true
+        end
+
+        alias print_status print_info
+
+        #
+        # Prints a debug message.
+        #
+        # @param [String] message
+        #   The message to print.
+        #
+        # @return [Boolean]
+        #   Specifies whether the messages were successfully printed.
+        #
+        # @example
+        #   print_debug "debug information here"
+        #   # [?] debug information here
+        #
+        # @note
+        #   Will return `false` unless verbose printing is enabled.
+        #
+        # @api public
+        #
+        def print_debug(message)
+          if debug?
+            $stdout.puts "#{ANSI.bold(ANSI.yellow('[?]'))} #{message}#{ANSI.reset}"
+            return true
+          else
+            return false
+          end
+        end
+
+        #
+        # Prints a warning message.
+        #
+        # @param [String] message
+        #   The message to print.
+        #
+        # @return [Boolean]
+        #   Specifies whether the messages were successfully printed.
+        #
+        # @example
+        #   print_warning "Rate limit exceeded, slowing down scanning."
+        #   # [~] Rate limit exceeded, slowing down scanning.
+        #
+        # @api public
+        #
+        def print_warning(message)
+          $stdout.puts "#{ANSI.bold(ANSI.yellow('[~]'))} #{message}#{ANSI.reset}"
+          return true
+        end
+
+        #
+        # Prints an error message.
+        #
+        # @param [String] message
+        #   The message to print.
+        #
+        # @return [Boolean]
+        #   Specifies whether the messages were successfully printed.
+        #
+        # @example
+        #   print_error "Could not connect!"
+        #   # [!] Could not connect!
+        #
+        # @api public
+        #
+        def print_error(message)
+          $stdout.puts "#{ANSI.bold(ANSI.red('[!]'))} #{message}#{ANSI.reset}"
+          return true
+        end
+
+        #
+        # Prints a positive message.
+        #
+        # @param [String] message
+        #   The message to print.
+        #
+        # @return [Boolean]
+        #   Specifies whether the messages were successfully printed.
+        #
+        # @example
+        #   print_positive "Password worked!"
+        #   # [+] Password worked!
+        #
+        # @api public
+        #
+        # @since 1.0.0
+        #
+        def print_positive(message)
+          $stdout.puts "#{ANSI.bold(ANSI.green('[+]'))} #{message}#{ANSI.reset}"
+          return true
+        end
+
+        alias print_success print_positive
+        alias print_good print_positive
+
+        #
+        # Prints a negative message.
+        #
+        # @param [String] message
+        #   The message to print.
+        #
+        # @return [Boolean]
+        #   Specifies whether the messages were successfully printed.
+        #
+        # @example
+        #   print_negative "Password failed!"
+        #   # [-] Password failed!
+        #
+        # @api public
+        #
+        # @since 1.0.0
+        #
+        def print_negative(message)
+          $stdout.puts "#{ANSI.bold(ANSI.red('[-]'))} #{message}#{ANSI.reset}"
+          return true
+        end
+
+        alias print_failure print_negative
+        alias print_bad print_negative
+      end
+    end
+  end
+end

data/lib/ronin/support/cli.rb

@@ -0,0 +1,20 @@
+# 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/cli/ansi'
+require 'ronin/support/cli/printing'

data/lib/ronin/support/compression/core_ext/file.rb

@@ -0,0 +1,70 @@
+# 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/gzip/reader'
+require 'ronin/support/compression/gzip/writer'
+
+class File
+
+  #
+  # 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.
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def self.gunzip(path,&block)
+    Ronin::Support::Compression::Gzip::Reader.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 [Ronin::Support::Compression::Gzip::Writer] gz
+  #   The gzip writer object.
+  #
+  # @return [Ronin::Support::Compression::Gzip::Writer]
+  #   The gzip writer object.
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def self.gzip(path,&block)
+    Ronin::Support::Compression::Gzip::Writer.open(path,&block)
+  end
+
+end

data/lib/ronin/support/compression/core_ext/string.rb

@@ -0,0 +1,101 @@
+# 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'
+require 'ronin/support/compression/gzip/reader'
+require 'ronin/support/compression/gzip/writer'
+
+class String
+
+  #
+  # Zlib inflate a string.
+  #
+  # @return [String]
+  #   The Zlib inflated form of the string.
+  #
+  # @example
+  #   "x\x9C\xCBH\xCD\xC9\xC9\a\x00\x06,\x02\x15".zlib_inflate
+  #   # => "hello"
+  #
+  # @api public
+  #
+  def zlib_inflate
+    Ronin::Support::Compression.zlib_inflate(self)
+  end
+
+  #
+  # Zlib deflate a string.
+  #
+  # @return [String]
+  #   The Zlib deflated form of the string.
+  #
+  # @example
+  #   "hello".zlib_deflate
+  #   # => "x\x9C\xCBH\xCD\xC9\xC9\a\x00\x06,\x02\x15"
+  #
+  # @api public
+  #
+  def zlib_deflate
+    Ronin::Support::Compression.zlib_deflate(self)
+  end
+
+  #
+  # Gzip uncompresses the string.
+  #
+  # @return [String]
+  #   The gunzipped version of the string.
+  #
+  # @example
+  #   "\x1F\x8B\b\x00K\x05\x8Fb\x00\x03\xCBH\xCD\xC9\xC9W(\xCF/\xCAI\xE1\x02\x00-;\b\xAF\f\x00\x00\x00".gunzip
+  #   # => "hello world\n"
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def gunzip
+    gz = Ronin::Support::Compression::Gzip::Reader.new(self)
+
+    return gz.read
+  end
+
+  #
+  # Gzip compresses the string.
+  #
+  # @return [String]
+  #   The gzipped version of the string.
+  #
+  # @example
+  #   "hello world\n".gzip
+  #   # => "\x1F\x8B\b\x00K\x05\x8Fb\x00\x03\xCBH\xCD\xC9\xC9W(\xCF/\xCAI\xE1\x02\x00-;\b\xAF\f\x00\x00\x00"
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def gzip
+    buffer = StringIO.new(encoding: Encoding::ASCII_8BIT)
+
+    Ronin::Support::Compression::Gzip::Writer.wrap(buffer) do |gz|
+      gz.write(self)
+    end
+
+    return buffer.string
+  end
+
+end

data/lib/ronin/{formatting/html.rb → support/compression/core_ext.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/>.
 #
 
-require 'ronin/formatting/extensions/html'
+require 'ronin/support/compression/core_ext/string'

data/lib/ronin/support/compression/gzip/reader.rb

@@ -0,0 +1,70 @@
+# 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 'stringio'
+
+module Ronin
+  module Support
+    module Compression
+      module Gzip
+        #
+        # Handles reading gzip compressed data.
+        #
+        # @see https://rubydoc.info/stdlib/zlib/Zlib/GzipReader
+        #
+        # @api public
+        #
+        # @since 1.0.0
+        #
+        class Reader < Zlib::GzipReader
+
+          #
+          # Initializes the gzip writer.
+          #
+          # @param [IO, StringIO, String] io_or_buffer
+          #   The IO object or buffer to read from. If a `String` is given, then
+          #   it will be wrapped in a `StringIO` object using the optional
+          #   `mode` argument.
+          #
+          # @param [String] mode
+          #   The optional mode to initialize the `StringIO` object to wrap
+          #   around the given buffer `String`.
+          #
+          # @example Initializing with an IO object:
+          #   gzip = Compression::Gzip::Reader.new(io)
+          #
+          # @example Initializing with a buffer:
+          #   buffer = "..."
+          #   gzip   = Compression::Gzip::Reader.new(buffer)
+          #
+          def initialize(io_or_buffer, mode: 'r')
+            io = case io_or_buffer
+                 when String then StringIO.new(io_or_buffer,mode)
+                 else             io_or_buffer
+                 end
+
+            super(io)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/compression/gzip/writer.rb

@@ -0,0 +1,74 @@
+# 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 'stringio'
+
+module Ronin
+  module Support
+    module Compression
+      module Gzip
+        #
+        # Handles writing gzip compressed data.
+        #
+        # @see https://rubydoc.info/stdlib/zlib/Zlib/GzipWriter
+        #
+        # @api public
+        #
+        # @since 1.0.0
+        #
+        class Writer < Zlib::GzipWriter
+
+          #
+          # Initializes the gzip writer.
+          #
+          # @param [IO, StringIO, String] io_or_buffer
+          #   The IO object or buffer to write to. If a `String` is given, then
+          #   it will be wrapped in a `StringIO` object using the optional
+          #   `mode` argument.
+          #
+          # @param [String] mode
+          #   The optional mode to initialize the `StringIO` object to wrap
+          #   around the given buffer `String`.
+          #
+          # @example Initializing with an IO object:
+          #   gzip = Compression::Gzip::Writer.new(io)
+          #
+          # @example Initializing with a buffer:
+          #   buffer = ""
+          #   gzip   = Compression::Gzip::Writer.new(buffer)
+          #
+          # @example Initializin with a buffer and append mode:
+          #   buffer = "foo"
+          #   gzip   = Compression::Gzip::Writer.new(buffer, mode: 'a')
+          #
+          def initialize(io_or_buffer, mode: 'w')
+            io = case io_or_buffer
+                 when String then StringIO.new(io_or_buffer,mode)
+                 else             io_or_buffer
+                 end
+
+            super(io)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/support/compression/gzip.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/compression/gzip/reader'
+require 'ronin/support/compression/gzip/writer'
+
+module Ronin
+  module Support
+    module Compression
+      #
+      # Handles gzip compression/decompression.
+      #
+      # @api public
+      #
+      # @since 1.0.0
+      #
+      module Gzip
+        #
+        # Creates a gzip stream around the IO object.
+        #
+        # @param [IO, StringIO, String] io
+        #   The IO or buffer 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 [Reader, Writer] gz
+        #   The gzip reader or writer object.
+        #
+        # @return [Reader, Writer]
+        #   The gzip reader or writer object.
+        #
+        # @raise [ArgumentError]
+        #   The mode must include either `r`, `w`, or `a`.
+        #
+        # @api public
+        #
+        def self.new(io, mode: 'r', &block)
+          gzip_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 gzip_class.wrap(io,&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 [Reader, Writer] gz
+        #   The gzip writer object.
+        #
+        # @return [Reader, Writer]
+        #   The gzip writer object.
+        #
+        # @raise [ArgumentError]
+        #   The mode must include either `r`, `w`, or `a`.
+        #
+        # @api public
+        #
+        def self.open(path, mode: 'r', &block)
+          gzip_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 gzip_class.open(path,&block)
+        end
+      end
+    end
+  end
+end