ronin-support 0.5.2 → 1.0.0.beta1

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

@@ -0,0 +1,330 @@
+# 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/>.
+#
+
+module Ronin
+  module Support
+    module CLI
+      #
+      # Defines ANSI colors.
+      #
+      # @api public
+      #
+      # @since 1.0.0
+      #
+      module ANSI
+        # ANSI reset code
+        RESET = "\e[0m"
+
+        # ANSI code for bold text
+        BOLD_ON = "\e[1m"
+
+        # ANSI code to disable boldness
+        BOLD_OFF = "\e[22m"
+
+        # ANSI color code for black
+        BLACK = "\e[30m"
+
+        # ANSI color code for red
+        RED = "\e[31m"
+
+        # ANSI color code for green
+        GREEN = "\e[32m"
+
+        # ANSI color code for yellow
+        YELLOW = "\e[33m"
+
+        # ANSI color code for blue
+        BLUE = "\e[34m"
+
+        # ANSI color code for magenta
+        MAGENTA = "\e[35m"
+
+        # ANSI color code for cyan
+        CYAN = "\e[36m"
+
+        # ANSI color code for white
+        WHITE = "\e[37m"
+
+        # ANSI color for the default foreground color
+        RESET_COLOR = "\e[39m"
+
+        module_function
+
+        #
+        # Resets text formatting.
+        #
+        # @return [String, nil]
+        #   The ANSI reset String or `nil` if STDOUT is not a TTY.
+        #
+        # @see RESET
+        #
+        # @api public
+        #
+        def reset
+          if $stdout.tty? then RESET
+          else                 ''
+          end
+        end
+
+        #
+        # Alias for {reset}.
+        #
+        # @return [String, nil]
+        #   The ANSI reset String or `nil` if STDOUT is not a TTY.
+        #
+        # @see reset
+        #
+        # @api public
+        #
+        def clear
+          reset
+        end
+
+        #
+        # Bolds the text.
+        #
+        # @param [String, nil] string
+        #   An optional string.
+        #
+        # @return [String]
+        #   The bolded string or just {BOLD_ON} if no arguments were given.
+        #
+        # @see BOLD_ON
+        #
+        # @api public
+        #
+        def bold(string=nil)
+          if string
+            if $stdout.tty? then "#{BOLD_ON}#{string}#{BOLD_OFF}"
+            else                 string
+            end
+          else
+            if $stdout.tty? then BOLD_ON
+            else                 ''
+            end
+          end
+        end
+
+        #
+        # @group Foreground Color Methods
+        #
+
+        #
+        # Sets the text color to black.
+        #
+        # @param [String, nil] string
+        #   An optional string.
+        #
+        # @return [String]
+        #   The colorized string or just {BLACK} if no arguments were given.
+        #
+        # @see BLACK
+        #
+        # @api public
+        #
+        def black(string=nil)
+          if string
+            if $stdout.tty? then "#{BLACK}#{string}#{RESET_COLOR}"
+            else                 string
+            end
+          else
+            if $stdout.tty? then BLACK
+            else                 ''
+            end
+          end
+        end
+
+        #
+        # Sets the text color to red.
+        #
+        # @param [String, nil] string
+        #   An optional string.
+        #
+        # @return [String]
+        #   The colorized string or just {RED} if no arguments were given.
+        #
+        # @see RED
+        #
+        # @api public
+        #
+        def red(string=nil)
+          if string
+            if $stdout.tty? then "#{RED}#{string}#{RESET_COLOR}"
+            else                 string
+            end
+          else
+            if $stdout.tty? then RED
+            else                 ''
+            end
+          end
+        end
+
+        #
+        # Sets the text color to green.
+        #
+        # @param [String, nil] string
+        #   An optional string.
+        #
+        # @return [String]
+        #   The colorized string or just {GREEN} if no arguments were given.
+        #
+        # @see GREEN
+        #
+        # @api public
+        #
+        def green(string=nil)
+          if string
+            if $stdout.tty? then "#{GREEN}#{string}#{RESET_COLOR}"
+            else                 string
+            end
+          else
+            if $stdout.tty? then GREEN
+            else                 ''
+            end
+          end
+        end
+
+        #
+        # Sets the text color to yellow.
+        #
+        # @param [String, nil] string
+        #   An optional string.
+        #
+        # @return [String]
+        #   The colorized string or just {YELLOW} if no arguments were given.
+        #
+        # @see YELLOW
+        #
+        # @api public
+        #
+        def yellow(string=nil)
+          if string
+            if $stdout.tty? then "#{YELLOW}#{string}#{RESET_COLOR}"
+            else                 string
+            end
+          else
+            if $stdout.tty? then YELLOW
+            else                 ''
+            end
+          end
+        end
+
+        #
+        # Sets the text color to blue.
+        #
+        # @param [String, nil] string
+        #   An optional string.
+        #
+        # @return [String]
+        #   The colorized string or just {BLUE} if no arguments were given.
+        #
+        # @see BLUE
+        #
+        # @api public
+        #
+        def blue(string=nil)
+          if string
+            if $stdout.tty? then "#{BLUE}#{string}#{RESET_COLOR}"
+            else                 string
+            end
+          else
+            if $stdout.tty? then BLUE
+            else                 ''
+            end
+          end
+        end
+
+        #
+        # Sets the text color to magenta.
+        #
+        # @param [String, nil] string
+        #   An optional string.
+        #
+        # @return [String]
+        #   The colorized string or just {MAGENTA} if no arguments were given.
+        #
+        # @see MAGENTA
+        #
+        # @api public
+        #
+        def magenta(string=nil)
+          if string
+            if $stdout.tty? then "#{MAGENTA}#{string}#{RESET_COLOR}"
+            else                 string
+            end
+          else
+            if $stdout.tty? then MAGENTA
+            else                 ''
+            end
+          end
+        end
+
+        #
+        # Sets the text color to cyan.
+        #
+        # @param [String, nil] string
+        #   An optional string.
+        #
+        # @return [String]
+        #   The colorized string or just {CYAN} if no arguments were given.
+        #
+        # @see CYAN
+        #
+        # @api public
+        #
+        def cyan(string=nil)
+          if string
+            if $stdout.tty? then "#{CYAN}#{string}#{RESET_COLOR}"
+            else                 string
+            end
+          else
+            if $stdout.tty? then CYAN
+            else                 ''
+            end
+          end
+        end
+
+        #
+        # Sets the text color to white.
+        #
+        # @param [String, nil] string
+        #   An optional string.
+        #
+        # @return [String]
+        #   The colorized string or just {WHITE} if no arguments were given.
+        #
+        # @see WHITE
+        #
+        # @api public
+        #
+        def white(string=nil)
+          if string
+            if $stdout.tty? then "#{WHITE}#{string}#{RESET_COLOR}"
+            else                 string
+            end
+          else
+            if $stdout.tty? then WHITE
+            else                 ''
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/support/cli/io_shell/core_ext/io.rb

@@ -0,0 +1,67 @@
+# 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/io_shell'
+
+class IO
+
+  #
+  # Starts an interactive session between STDIO and the IO object.
+  #
+  # @param [Hash{Symbol => Object}] kwargs
+  #   Additional keyword arguments for
+  #   {Ronin::Support::CLI::IOShell#initialize}.
+  #
+  # @option kwargs [IO] :stdin
+  #   Optional alternative STDIN stream. Defaults to `$stdin`.
+  #
+  # @option kwargs [IO] :stdout
+  #   Optional alternative STDOUT stream. Defaults to `$stdout`.
+  #
+  # @example
+  #   socket = TCPSocket.new('irc.undernet.org',6667)
+  #   socket.shell
+  #   # NOTICE AUTH :*** Looking up your hostname
+  #   # NOTICE AUTH :*** Checking Ident
+  #   # NOTICE AUTH :*** Found your hostname
+  #   # NOTICE AUTH :*** No ident response
+  #   # USER test_ruby * * * 
+  #   # NICK test_ruby
+  #   # PING :3167790481
+  #   # PONG 3167790481
+  #   # :Chicago.IL.US.Undernet.Org 001 test_ruby :Welcome to the UnderNet IRC Network, test_ruby
+  #   # :Chicago.IL.US.Undernet.Org 002 test_ruby :Your host is Chicago.IL.US.Undernet.Org, running version u2.10.12.19
+  #   # :Chicago.IL.US.Undernet.Org 003 test_ruby :This server was created Wed Apr 15 2020 at 22:02:43 UTC
+  #   # :Chicago.IL.US.Undernet.Org 004 test_ruby Chicago.IL.US.Undernet.Org u2.10.12.19 diOoswkgx biklmnopstvrDdRcC bklov
+  #   # :Chicago.IL.US.Undernet.Org 005 test_ruby WHOX WALLCHOPS WALLVOICES USERIP CPRIVMSG CNOTICE SILENCE=25 MODES=6 MAXCHANNELS=40 MAXBANS=100 NICKLEN=12 :are supported by this server
+  #   # :Chicago.IL.US.Undernet.Org 005 test_ruby MAXNICKLEN=15 TOPICLEN=160 AWAYLEN=160 KICKLEN=160 CHANNELLEN=200 MAXCHANNELLEN=200 CHANTYPES=#& PREFIX=(ov)@+ STATUSMSG=@+ CHANMODES=b,k,l,imnpstrDdRcC CASEMAPPING=rfc1459 NETWORK=UnderNet :are supported by this server
+  #   # :Chicago.IL.US.Undernet.Org 251 test_ruby :There are 3241 users and 9182 invisible on 38 servers
+  #   # :Chicago.IL.US.Undernet.Org 252 test_ruby 57 :operator(s) online
+  #   # :Chicago.IL.US.Undernet.Org 253 test_ruby 23 :unknown connection(s)
+  #   # :Chicago.IL.US.Undernet.Org 254 test_ruby 6230 :channels formed
+  #   # :Chicago.IL.US.Undernet.Org 255 test_ruby :I have 1179 clients and 1 servers
+  #   # :Chicago.IL.US.Undernet.Org NOTICE test_ruby :Highest connection count: 1388 (1387 clients)
+  #   # :Chicago.IL.US.Undernet.Org 422 test_ruby :MOTD File is missing
+  #   # :Chicago.IL.US.Undernet.Org NOTICE test_ruby :on 1 ca 1(4) ft 10(10)
+  #   # Ctrl^D
+  #
+  def shell(**kwargs)
+    Ronin::Support::CLI::IOShell.start(self,**kwargs)
+  end
+
+end

data/lib/ronin/{extensions/meta.rb → support/cli/io_shell/core_ext.rb}

@@ -1,7 +1,6 @@
+# frozen_string_literal: true
 #
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
+# 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
@@ -17,4 +16,4 @@
 # along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/extensions/meta/object'
+require 'ronin/support/cli/io_shell/core_ext/io'

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

@@ -0,0 +1,161 @@
+# 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/>.
+#
+
+module Ronin
+  module Support
+    module CLI
+      #
+      # Starts an interactive shell for the IO object,
+      # where data read from the IO object is printed to STDOUT and
+      # data read from STDIN is written to the IO object.
+      #
+      # ## Example
+      #
+      #     socket = TCPSocket.new('irc.undernet.org',6667)
+      #     CLI::IOShell.sstart(socket)
+      #
+      # ```
+      # NOTICE AUTH :*** Looking up your hostname
+      # NOTICE AUTH :*** Checking Ident
+      # NOTICE AUTH :*** Found your hostname
+      # NOTICE AUTH :*** No ident response
+      # USER test_ruby * * * 
+      # NICK test_ruby
+      # PING :3167790481
+      # PONG 3167790481
+      # :Chicago.IL.US.Undernet.Org 001 test_ruby :Welcome to the UnderNet IRC Network, test_ruby
+      # :Chicago.IL.US.Undernet.Org 002 test_ruby :Your host is Chicago.IL.US.Undernet.Org, running version u2.10.12.19
+      # :Chicago.IL.US.Undernet.Org 003 test_ruby :This server was created Wed Apr 15 2020 at 22:02:43 UTC
+      # :Chicago.IL.US.Undernet.Org 004 test_ruby Chicago.IL.US.Undernet.Org u2.10.12.19 diOoswkgx biklmnopstvrDdRcC bklov
+      # :Chicago.IL.US.Undernet.Org 005 test_ruby WHOX WALLCHOPS WALLVOICES USERIP CPRIVMSG CNOTICE SILENCE=25 MODES=6 MAXCHANNELS=40 MAXBANS=100 NICKLEN=12 :are supported by this server
+      # :Chicago.IL.US.Undernet.Org 005 test_ruby MAXNICKLEN=15 TOPICLEN=160 AWAYLEN=160 KICKLEN=160 CHANNELLEN=200 MAXCHANNELLEN=200 CHANTYPES=#& PREFIX=(ov)@+ STATUSMSG=@+ CHANMODES=b,k,l,imnpstrDdRcC CASEMAPPING=rfc1459 NETWORK=UnderNet :are supported by this server
+      # :Chicago.IL.US.Undernet.Org 251 test_ruby :There are 3241 users and 9182 invisible on 38 servers
+      # :Chicago.IL.US.Undernet.Org 252 test_ruby 57 :operator(s) online
+      # :Chicago.IL.US.Undernet.Org 253 test_ruby 23 :unknown connection(s)
+      # :Chicago.IL.US.Undernet.Org 254 test_ruby 6230 :channels formed
+      # :Chicago.IL.US.Undernet.Org 255 test_ruby :I have 1179 clients and 1 servers
+      # :Chicago.IL.US.Undernet.Org NOTICE test_ruby :Highest connection count: 1388 (1387 clients)
+      # :Chicago.IL.US.Undernet.Org 422 test_ruby :MOTD File is missing
+      # :Chicago.IL.US.Undernet.Org NOTICE test_ruby :on 1 ca 1(4) ft 10(10)
+      # Ctrl^D
+      # ```
+      #
+      class IOShell
+
+        # The IO object to interact with.
+        #
+        # @return [IO]
+        attr_reader :io
+
+        # The STDIN stream.
+        #
+        # @return [IO]
+        attr_reader :stdin
+
+        # The STDOUT stream.
+        #
+        # @return [IO]
+        attr_reader :stdout
+
+        #
+        # Initialies the IO shell object.
+        #
+        # @param [IO] io
+        #   The IO object to interact with.
+        #
+        # @param [IO] stdin
+        #   Alternative STDIN stream.
+        #
+        # @param [IO] stdout
+        #   Alternative STDOUT stream.
+        #
+        def initialize(io, stdin: $stdin, stdout: $stdout)
+          @io = io
+
+          @stdin  = stdin
+          @stdout = stdout
+        end
+
+        #
+        # Starts the interactive shell with the given IO object.
+        #
+        # @param [IO] io
+        #   The IO object to interact with.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {#initialize}.
+        #
+        # @option kwargs [IO] :stdin
+        #   Optional alternative STDIN stream. Defaults to `$stdin`.
+        #
+        # @option kwargs [IO] :stdout
+        #   Optional alternative STDOUT stream. Defaults to `$stdout`.
+        #
+        def self.start(io,**kwargs)
+          new(io,**kwargs).run
+        end
+
+        #
+        # Runs the interaction shell. Data read from the IO object is
+        # printed to STDOUT and data read from STDIN is written to the IO
+        # object. `Ctrl^D` or `Ctrl^C` will exit the session.
+        #
+        # @return [Boolean]
+        #   Returns `true` if the user exited the interactive shell.
+        #   Returns `false` if there an IOError was encountered.
+        #
+        def run
+          io_array = [@io, @stdin]
+
+          loop do
+            readable, writable, errors = IO.select(io_array,nil,io_array)
+
+            if errors.include?(@io) || errors.include?(@stdin)
+              return false
+            end
+
+            if readable.include?(@io)
+              data = begin
+                       @io.readpartial(4096)
+                     rescue EOFError => error
+                       return false
+                     end
+
+              @stdout.write(data)
+            end
+
+            if readable.include?(@stdin)
+              data = begin
+                       @stdin.readpartial(4096)
+                     rescue EOFError => error
+                       return true
+                     end
+
+              @io.write(data)
+            end
+          end
+        rescue Interrupt
+          return true
+        end
+
+      end
+    end
+  end
+end
+
+require 'ronin/support/cli/io_shell/core_ext'