ronin-support 0.5.2 → 1.0.0.beta1

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

@@ -0,0 +1,279 @@
+# 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 encoding/decoding escaping/unescaping JavaScript
+      # data.
+      #
+      # @api public
+      #
+      module JS
+        # Special JavaScript bytes and their escaped Strings.
+        ESCAPE_BYTES = {
+          0x00 => '\u0000',
+          0x01 => '\u0001',
+          0x02 => '\u0002',
+          0x03 => '\u0003',
+          0x04 => '\u0004',
+          0x05 => '\u0005',
+          0x06 => '\u0006',
+          0x07 => '\u0007',
+          0x08 => '\b',
+          0x09 => '\t',
+          0x0a => '\n',
+          0x0b => '\u000b',
+          0x0c => '\f',
+          0x0d => '\r',
+          0x0e => '\u000e',
+          0x0f => '\u000f',
+          0x10 => '\u0010',
+          0x11 => '\u0011',
+          0x12 => '\u0012',
+          0x13 => '\u0013',
+          0x14 => '\u0014',
+          0x15 => '\u0015',
+          0x16 => '\u0016',
+          0x17 => '\u0017',
+          0x18 => '\u0018',
+          0x19 => '\u0019',
+          0x1a => '\u001a',
+          0x1b => '\u001b',
+          0x1c => '\u001c',
+          0x1d => '\u001d',
+          0x1e => '\u001e',
+          0x1f => '\u001f',
+          0x22 => '\"',
+          0x5c => '\\\\'
+        }
+
+        #
+        # Escapes the byte as a JavaScript character.
+        #
+        # @param [Integer] byte
+        #   The byte to escape.
+        #
+        # @return [String]
+        #   The escaped JavaScript character.
+        #
+        # @example 
+        #   Encoding::JS.escape_byte(0x41)
+        #   # => "A"
+        #   Encoding::JS.escape_byte(0x22)
+        #   # => "\\\""
+        #   Encoding::JS.escape_byte(0x7f)
+        #   # => "\\x7F"
+        #
+        def self.escape_byte(byte)
+          if byte >= 0x00 && byte <= 0xff
+            ESCAPE_BYTES.fetch(byte) do
+              if byte >= 0x20 && byte <= 0x7e
+                byte.chr
+              else
+                encode_byte(byte)
+              end
+            end
+          else
+            encode_byte(byte)
+          end
+        end
+
+        #
+        # Encodes the byte as a JavaScript character.
+        #
+        # @param [Integer] byte
+        #   The byte to encode.
+        #
+        # @return [String]
+        #   The encoded JavaScript character.
+        #
+        # @example
+        #   Encoding::JS.encode_byte(0x41)
+        #   # => "\\x41"
+        #
+        def self.encode_byte(byte)
+          if byte > 0xff then "\\u%.4X" % byte
+          else                "\\x%.2X" % byte
+          end
+        end
+
+        # JavaScript characters that must be back-slashed.
+        BACKSLASHED_CHARS = {
+          "\\b"  => "\b",
+          "\\t"  => "\t",
+          "\\n"  => "\n",
+          "\\f"  => "\f",
+          "\\r"  => "\r",
+          "\\\"" => "\"",
+          "\\\'" => "'",
+          "\\\\" => "\\"
+        }
+
+        #
+        # Escapes a String for JavaScript.
+        #
+        # @param [String] data
+        #   The data to JavaScript escape.
+        #
+        # @return [String]
+        #   The JavaScript escaped String.
+        #
+        # @example
+        #   "hello\nworld\n".js_escape
+        #   # => "hello\\nworld\\n"
+        #
+        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
+
+        #
+        # Unescapes a JavaScript escaped String.
+        #
+        # @param [String] data
+        #   The escaped JavaScript data.
+        #
+        # @return [String]
+        #   The unescaped JavaScript String.
+        #
+        # @example
+        #   Encoding::JS.unescape("\\u0068\\u0065\\u006C\\u006C\\u006F world")
+        #   # => "hello world"
+        #
+        def self.unescape(data)
+          unescaped = String.new
+
+          data.scan(/[\\%]u[0-9a-fA-F]{1,4}|[\\%][0-9a-fA-F]{1,2}|\\[btnfr\'\"\\]|./) do |c|
+            unescaped << BACKSLASHED_CHARS.fetch(c) do
+                           if (c.start_with?("\\u") || c.start_with?("%u"))
+                             c[2..-1].to_i(16)
+                           elsif (c.start_with?("\\") || c.start_with?("%"))
+                             c[1..-1].to_i(16)
+                           else
+                             c
+                           end
+                         end
+          end
+
+          return unescaped
+        end
+
+        #
+        # JavaScript escapes every character of the String.
+        #
+        # @param [String] data
+        #   The data to JavaScript escape.
+        #
+        # @return [String]
+        #   The JavaScript escaped String.
+        #
+        # @example
+        #   Encoding::JS.encode("hello")
+        #   # => "\\u0068\\u0065\\u006C\\u006C\\u006F"
+        #
+        def self.encode(data)
+          encoded = String.new
+
+          if data.valid_encoding?
+            data.each_codepoint do |codepoint|
+              encoded << encode_byte(codepoint)
+            end
+          else
+            data.each_byte do |byte|
+              encoded << encode_byte(byte)
+            end
+          end
+
+          return encoded
+        end
+
+        #
+        # Alias for {unescape}.
+        #
+        # @param [String] data
+        #   The escaped JavaScript data.
+        #
+        # @return [String]
+        #   The unescaped JavaScript String.
+        #
+        # @see unescape
+        #
+        def self.decode(data)
+          unescape(data)
+        end
+
+        #
+        # Converts the String into a JavaScript string.
+        #
+        # @param [String] data
+        #   The data to escape and quote.
+        #
+        # @return [String]
+        #   The unquoted and unescaped String.
+        #
+        # @example
+        #   Encoding::JS.quote("hello\nworld\n")
+        #   # => "\"hello\\nworld\\n\""
+        #
+        def self.quote(data)
+          "\"#{escape(data)}\""
+        end
+
+        #
+        # Removes the quotes an unescapes a JavaScript string.
+        #
+        # @param [String] data
+        #   The JavaScript string to 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::JS.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/js/core_ext'

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

@@ -0,0 +1,87 @@
+# 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/powershell'
+
+class Integer
+
+  #
+  # Encodes the Integer as a PowerShell character.
+  #
+  # @return [String]
+  #   The encoded PowerShell character.
+  #
+  # @raise [RangeError]
+  #   The integer value is negative.
+  #
+  # @example 
+  #   0x41.powershell_encode
+  #   # => "[char]0x41"
+  #   0x0a.powershell_encode
+  #   # => "`n"
+  #
+  # @example Encoding unicode characters:
+  #   1001.powershell_escape
+  #   # => "`u{1001}"
+  #
+  # @see Ronin::Support::Encoding::PowerShell.encode_byte
+  #
+  # @since 1.0.0
+  #
+  # @api public
+  #
+  def powershell_encode
+    Ronin::Support::Encoding::PowerShell.encode_byte(self)
+  end
+
+  alias psh_encode powershell_encode
+
+  #
+  # Escapes the Integer as a PowerShell character.
+  #
+  # @return [String]
+  #   The escaped PowerShell character.
+  #
+  # @raise [RangeError]
+  #   The integer value is negative.
+  #
+  # @example 
+  #   0x41.powershell_escape
+  #   # => "A"
+  #   0x08.powershell_escape
+  #   # => "`b"
+  #   0xff.powershell_escape
+  #   # => "[char]0xff"
+  #
+  # @example Escaping unicode characters:
+  #   1001.powershell_escape
+  #   # => "`u{1001}"
+  #
+  # @see Ronin::Support::Encoding::PowerShell.escape_byte
+  #
+  # @since 1.0.0
+  #
+  # @api public
+  #
+  def powershell_escape
+    Ronin::Support::Encoding::PowerShell.escape_byte(self)
+  end
+
+  alias psh_escape powershell_escape
+
+end

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

@@ -0,0 +1,145 @@
+# 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/powershell'
+
+class String
+
+  #
+  # [PowerShell escapes][1] the characters in the String.
+  #
+  # [1]: https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_special_characters?view=powershell-7.2
+  #
+  # @return [String]
+  #   The PowerShell escaped string.
+  #
+  # @example
+  #   "hello\nworld".powershell_escape
+  #   # => "hello`nworld"
+  #
+  # @see Ronin::Support::Encoding::PowerShell.escape
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def powershell_escape
+    Ronin::Support::Encoding::PowerShell.escape(self)
+  end
+
+  alias psh_escape powershell_escape
+
+  #
+  # [PowerShell unescapes][1] the characters in the String.
+  #
+  # [1]: https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_special_characters?view=powershell-7.2
+  #
+  # @return [String]
+  #   The PowerShell unescaped string.
+  #
+  # @example
+  #   "hello`nworld".powershell_unescape
+  #   # => "hello\nworld"
+  #
+  # @see Ronin::Support::Encoding::PowerShell.unescape
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def powershell_unescape
+    Ronin::Support::Encoding::PowerShell.unescape(self)
+  end
+
+  alias psh_unescape powershell_unescape
+
+  #
+  # [PowerShell encodes][1] every character in the String.
+  #
+  # [1]: https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_special_characters?view=powershell-7.2
+  #
+  # @return [String]
+  #   The PowerShell encoded String.
+  #
+  # @example
+  #   "hello world".powershell_encode
+  #   # => "$([char]0x68)$([char]0x65)$([char]0x6c)$([char]0x6c)$([char]0x6f)$([char]0x20)$([char]0x77)$([char]0x6f)$([char]0x72)$([char]0x6c)$([char]0x64)"
+  #
+  # @see Ronin::Support::Encoding::PowerShell.encode
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def powershell_encode
+    Ronin::Support::Encoding::PowerShell.encode(self)
+  end
+
+  alias psh_encode powershell_encode
+
+  alias powershell_decode powershell_unescape
+  alias psh_decode powershell_decode
+
+  #
+  # Converts the String into a double-quoted PowerShell escaped String.
+  #
+  # @return [String]
+  #   The quoted and escaped PowerShell string.
+  #
+  # @example
+  #   "hello\nworld".powershell_string
+  #   # => "\"hello`nworld\""
+  #
+  # @see Ronin::Support::Encoding::PowerShell.quote
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def powershell_string
+    Ronin::Support::Encoding::PowerShell.quote(self)
+  end
+
+  alias psh_string powershell_string
+
+  #
+  # Removes the quotes an unescapes a PowerShell 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\"".powershell_unquote
+  #   # => "hello\nworld"
+  #   "'hello''world'".powershell_unquote
+  #   # => "hello'world"
+  #
+  # @see Ronin::Support::Encoding::PowerShell.unquote
+  #
+  # @since 1.0.0
+  #
+  # @api public
+  #
+  def powershell_unquote
+    Ronin::Support::Encoding::PowerShell.unquote(self)
+  end
+
+  alias psh_unquote powershell_unquote
+
+end

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