ronin-support 0.5.1 → 1.0.0.beta1

data/lib/ronin/support/encoding/hex/core_ext/string.rb

@@ -0,0 +1,133 @@
+# 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/encoding/hex'
+
+class String
+
+  #
+  # Hex-encodes characters in the String.
+  #
+  # @return [String]
+  #   The hex encoded version of the String.
+  #
+  # @example
+  #   "hello".hex_encode
+  #   # => "68656C6C6F"
+  #
+  # @see Ronin::Support::Encoding::Hex.encodde
+  #
+  # @since 0.6.0
+  #
+  def hex_encode
+    Ronin::Support::Encoding::Hex.encode(self)
+  end
+
+  #
+  # Hex-decodes the String.
+  #
+  # @return [String]
+  #   The hex decoded version of the String.
+  #
+  # @example
+  #   "68656C6C6F".hex_decode
+  #   # => "hello"
+  #
+  # @see Ronin::Support::Encoding::Hex.decodde
+  #
+  def hex_decode
+    Ronin::Support::Encoding::Hex.decode(self)
+  end
+
+  #
+  # Hex-escapes the characters within the String.
+  #
+  # @return [String]
+  #   The hex escaped version of the String.
+  #
+  # @example
+  #   "hello\nworld".hex_escape
+  #   # => "hello\\nworld"
+  #
+  # @see Ronin::Support::Encoding::Hex.escape
+  #
+  # @api public
+  #
+  def hex_escape
+    Ronin::Support::Encoding::Hex.escape(self)
+  end
+
+  #
+  # Unescapes the characters within the String.
+  #
+  # @return [String]
+  #   The hex unescaped version of the String.
+  #
+  # @example
+  #   "hello\\nworld".hex_escape
+  #   # => "hello\nworld"
+  #
+  # @see Ronin::Support::Encoding::Hex.unescape
+  #
+  # @api public
+  #
+  def hex_unescape
+    Ronin::Support::Encoding::Hex.unescape(self)
+  end
+
+  #
+  # Converts the String into a double-quoted hex string.
+  #
+  # @return [String]
+  #
+  # @example
+  #   "hello\nworld".hex_string
+  #   # => "\"hello\\nworld\""
+  #
+  # @see Ronin::Support::Encoding::Hex.quote
+  #
+  # @since 1.0.0
+  #
+  # @api public
+  #
+  def hex_string
+    Ronin::Support::Encoding::Hex.quote(self)
+  end
+
+  #
+  # Removes the quotes and unescapes a hex string.
+  #
+  # @return [String]
+  #   The un-quoted String if the String begins and ends with quotes, or the
+  #   same String if it is not quoted.
+  #
+  # @example
+  #   "\"hello\\nworld\"".hex_unquote
+  #   # => "hello\nworld"
+  #
+  # @see Ronin::Support::Encoding::Hex.unquote
+  #
+  # @since 1.0.0
+  #
+  # @api public
+  #
+  def hex_unquote
+    Ronin::Support::Encoding::Hex.unquote(self)
+  end
+
+end

data/lib/ronin/support/encoding/hex/core_ext.rb

@@ -0,0 +1,22 @@
+# 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/encoding/hex/core_ext/integer'
+require 'ronin/support/encoding/hex/core_ext/string'
+
+require 'hexdump/core_ext'

data/lib/ronin/support/encoding/hex.rb

@@ -0,0 +1,248 @@
+# 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 'strscan'
+
+module Ronin
+  module Support
+    class Encoding < ::Encoding
+      #
+      # Contains methods for hex encoding/decoding and escaping/unescaping data.
+      #
+      module Hex
+        #
+        # Hex encodes the given byte.
+        #
+        # @param [Integer] byte
+        #   The byte to hex encode.
+        #
+        # @return [String]
+        #   The hex encoded version of the byte.
+        #
+        # @example
+        #   Encoding::Hex.encode_byte(0x41)
+        #   # => "41"
+        #
+        def self.encode_byte(byte)
+          "%.2x" % byte
+        end
+
+        #
+        # Hex escapes the given byte.
+        #
+        # @param [Integer] byte
+        #   The byte value to hex escape.
+        #
+        # @return [String]
+        #   The hex escaped version of the Integer.
+        #
+        # @raise [RangeError]
+        #   The byte value is negative.
+        #
+        # @example
+        #   Encoding::Hex.escape_byte(42)
+        #   # => "\\x2a"
+        #
+        def self.escape_byte(byte)
+          if byte >= 0x00 && byte <= 0xff
+            if    byte == 0x22
+              "\\\""
+            elsif byte == 0x5d
+              "\\\\"
+            elsif byte >= 0x20 && byte <= 0x7e
+              byte.chr
+            else
+              "\\x%.2x" % byte
+            end
+          elsif byte > 0xff
+            "\\x%x" % byte
+          else
+            raise(RangeError,"#{byte.inspect} out of char range")
+          end
+        end
+
+        #
+        # Hex encodes the given data.
+        #
+        # @param [String] data
+        #   The given data to hex encode.
+        #
+        # @return [String]
+        #   The hex encoded version of the String.
+        #
+        # @example
+        #   Encoding::Hex.encode("hello")
+        #   # => "68656C6C6F"
+        #
+        def self.encode(data)
+          encoded = String.new
+
+          data.each_byte do |byte|
+            encoded << encode_byte(byte)
+          end
+
+          return encoded
+        end
+
+        #
+        # Hex decodes the String.
+        #
+        # @param [String] data
+        #   The given data to hex decode.
+        #
+        # @return [String]
+        #   The hex decoded version of the String.
+        #
+        # @example
+        #   Encoding::Hex.decode("68656C6C6F")
+        #   # => "hello"
+        #
+        def self.decode(data)
+          decoded = String.new
+
+          data.scan(/../) do |hex|
+            decoded << hex.to_i(16).chr
+          end
+
+          return decoded
+        end
+
+        #
+        # Hex-escapes the given data.
+        #
+        # @param [String] data
+        #   The given data to hex escape.
+        #
+        # @return [String]
+        #   The hex escaped version of the String.
+        #
+        # @example
+        #   Encoding::Hex.escape("hello")
+        #   # => "\\x68\\x65\\x6c\\x6c\\x6f"
+        #
+        def self.escape(data)
+          escaped = String.new
+
+          if data.valid_encoding?
+            data.each_codepoint do |codepoint|
+              escaped << escape_byte(codepoint)
+            end
+          else
+            data.each_byte do |byte|
+              escaped << escape_byte(byte)
+            end
+          end
+
+          return escaped
+        end
+
+        # Backslash escaped characters.
+        BACKSLASHED_CHARS = {
+          "\\" => '\\',
+          '"'  => '"',
+          '0'  => "\0",
+          'a'  => "\a",
+          'b'  => "\b",
+          't'  => "\t",
+          'n'  => "\n",
+          'v'  => "\v",
+          'f'  => "\f",
+          'r'  => "\r"
+        }
+
+        #
+        # Removes the quotes an unescapes a quoted hex string.
+        #
+        # @param [String] data
+        #   The quoted and hex escaped hex string.
+        #
+        # @return [String]
+        #   The un-quoted String if the String begins and ends with quotes, or
+        #   the same String if it is not quoted.
+        #
+        # @example
+        #   Encoding::Hex.unescape("\"hello\\nworld\"")
+        #   # => "hello\nworld"
+        #
+        def self.unescape(data)
+          buffer  = String.new
+          scanner = StringScanner.new(data)
+
+          until scanner.eos?
+            buffer << case (char = scanner.getch)
+                      when '\\'
+                        if (hex_escape = scanner.scan(/x[0-9a-fA-F]{4,8}/))
+                          hex_escape[1..].to_i(16).chr(Encoding::UTF_8)
+                        elsif (hex_escape = scanner.scan(/x[0-9a-fA-F]{1,2}/))
+                          hex_escape[1..].to_i(16).chr
+                        elsif (char = scanner.getch)
+                          BACKSLASHED_CHARS.fetch(char,char)
+                        end
+                      else
+                        char
+                      end
+          end
+
+          return buffer
+        end
+
+        #
+        # Converts the given data into a double-quoted hex string.
+        #
+        # @param [String] data
+        #   The given data to hex-escape and double-quote.
+        #
+        # @return [String]
+        #   The double-quoted and hex escaped string.
+        #
+        # @example
+        #   Encoding::Hex.quote("hello\nworld")
+        #   # => "\"hello\\nworld\""
+        #
+        def self.quote(data)
+          "\"#{escape(data)}\""
+        end
+
+        #
+        # Removes the quotes and unescapes a hex string.
+        #
+        # @param [String] data
+        #   The quoted hex String to unescape and unquote.
+        #
+        # @return [String]
+        #   The un-quoted String if the String begins and ends with quotes, or
+        #   the same String if it is not quoted.
+        #
+        # @example
+        #   Encoding::Hex.unquote("\"hello\\nworld\"")
+        #   # => "hello\nworld"
+        #
+        def self.unquote(data)
+          if ((data[0] == '"' && data[-1] == '"') ||
+              (data[0] == "'" && data[-1] == "'"))
+            unescape(data[1..-2])
+          else
+            data
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'ronin/support/encoding/hex/core_ext'

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

@@ -0,0 +1,106 @@
+# 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/encoding/html'
+
+class Integer
+
+  #
+  # Escapes the Integer as an HTML String.
+  #
+  # @param [Hash{Symbol => Object}] kwargs
+  #   Additional keyword arguments.
+  #
+  # @option kwargs [:lower, :upper, nil] :case
+  #   Controls whether to output lowercase or uppercase XML special
+  #   characters. Defaults to lowercase hexadecimal.
+  #
+  # @return [String]
+  #   The escaped HTML String.
+  #
+  # @raise [ArgumentError]
+  #   The `case:` keyword argument is invalid.
+  #
+  # @example
+  #   0x26.html_escape
+  #   # => "&amp;"
+  #
+  # @example Uppercase encoding:
+  #   0x26.html_escape(case: :upper)
+  #   # => "&AMP;"
+  #
+  # @since 0.2.0
+  #
+  # @see Ronin::Support::Encoding::HTML.escape_byte
+  #
+  # @api public
+  #
+  def html_escape(**kwargs)
+    Ronin::Support::Encoding::HTML.escape_byte(self,**kwargs)
+  end
+
+  #
+  # Encodes the Integer as a HTML String.
+  #
+  # @param [Hash{Symbol => Object}] kwargs
+  #   Additional keyword arguments.
+  #
+  # @option kwargs [:decimal, :hex] :format (:decimal)
+  #   The numeric format for the escaped characters.
+  #
+  # @option kwargs [Boolean] :zero_pad
+  #   Controls whether the escaped characters will be left-padded with
+  #   up to seven `0` characters.
+  #
+  # @option kwargs [:lower, :upper, nil] :case
+  #   Controls whether to output lowercase or uppercase XML special
+  #   characters. Defaults to lowercase hexadecimal.
+  #
+  # @return [String]
+  #   The encoded HTML String.
+  #
+  # @raise [ArgumentError]
+  #   The `format:` or `case:` keyword argument is invalid.
+  #
+  # @example
+  #   0x41.html_enocde
+  #   # => "&#65;"
+  #
+  # @example Zero-padding:
+  #   0x41.html_encode(zero_pad: true)
+  #   # => "&#0000065;"
+  #
+  # @example Hexadecimal escaped characters:
+  #   0x41.html_encode(format: :hex)
+  #   # => "&#x41;"
+  #
+  # @example Uppercase hexadecimal escaped characters:
+  #   0xff.html_encode(format: :hex, case: :upper)
+  #   # => "&#XFF;"
+  #
+  # @since 0.2.0
+  #
+  # @see Ronin::Support::Encoding::HTML.encode_byte
+  #
+  # @api public
+  #
+  def html_encode(**kwargs)
+    Ronin::Support::Encoding::HTML.encode_byte(self,**kwargs)
+  end
+
+end

data/lib/ronin/support/encoding/html/core_ext/string.rb

@@ -0,0 +1,130 @@
+# 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/encoding/html'
+
+class String
+
+  #
+  # HTML escapes the String.
+  #
+  # @param [Hash{Symbol => Object}] kwargs
+  #   Additional keyword arguments.
+  #
+  # @option kwargs [:lower, :upper, nil] :case
+  #   Controls whether to output lowercase or uppercase XML special
+  #   characters. Defaults to lowercase hexadecimal.
+  #
+  # @return [String]
+  #   The HTML escaped String.
+  #
+  # @raise [ArgumentError]
+  #   The `case:` keyword argument is invalid.
+  #
+  # @example
+  #   "one & two".html_escape
+  #   # => "one &amp; two"
+  #
+  # @example Uppercase escaped characters:
+  #   "one & two".html_escape(case: :upper)
+  #   # => "one &AMP; two"
+  #
+  # @see https://rubydoc.info/stdlib/cgi/1.9.2/CGI.escapeHTML
+  # @see Ronin::Support::Encoding::HTML.escape
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def html_escape(**kwargs)
+    Ronin::Support::Encoding::HTML.escape(self,**kwargs)
+  end
+
+  #
+  # Unescapes the HTML encoded String.
+  #
+  # @return [String]
+  #   The unescaped String.
+  #
+  # @example
+  #   "&lt;p&gt;one &lt;span&gt;two&lt;/span&gt;&lt;/p&gt;".html_unescape
+  #   # => "<p>one <span>two</span></p>"
+  #
+  # @see https://rubydoc.info/stdlib/cgi/1.9.2/CGI.unescapeHTML
+  # @see Ronin::Support::Encoding::HTML.unescape
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def html_unescape
+    Ronin::Support::Encoding::HTML.unescape(self)
+  end
+
+  #
+  # Encodes the chars in the String for HTML.
+  #
+  # @param [Hash{Symbol => Object}] kwargs
+  #   Additional keyword arguments.
+  #
+  # @option kwargs [:decimal, :hex] :format (:decimal)
+  #   The numeric format for the escaped characters.
+  #
+  # @option kwargs [Boolean] :zero_pad
+  #   Controls whether the escaped characters will be left-padded with
+  #   up to seven `0` characters.
+  #
+  # @option kwargs [:lower, :upper, nil] :case
+  #   Controls whether to output lowercase or uppercase XML special
+  #   characters. Defaults to lowercase hexadecimal.
+  #
+  # @return [String]
+  #   The encoded HTML String.
+  #
+  # @raise [ArgumentError]
+  #   The `format:` or `case:` keyword argument is invalid.
+  #
+  # @example
+  #   "abc".html_encode
+  #   # => "&#97;&#98;&#99;"
+  #
+  # @example Zero-padding:
+  #   "abc".html_encode(zero_pad: true)
+  #   # => "&#0000097;&#0000098;&#0000099;"
+  #
+  # @example Hexadecimal encoded characters:
+  #   "abc".html_encode(format: :hex)
+  #   # => "&#x61;&#x62;&#x63;"
+  #
+  # @example Uppercase hexadecimal encoded characters:
+  #   "abc\xff".html_encode(format: :hex, case: :upper)
+  #   # => "&#X61;&#X62;&#X63;&#XFF;"
+  #
+  # @see Ronin::Support::Encoding::HTML.encode
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def html_encode(**kwargs)
+    Ronin::Support::Encoding::HTML.encode(self,**kwargs)
+  end
+
+  alias html_decode html_unescape
+
+end

data/lib/ronin/support/encoding/html/core_ext.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/encoding/html/core_ext/integer'
+require 'ronin/support/encoding/html/core_ext/string'