ronin-support 0.5.2 → 1.0.0.beta1

data/lib/ronin/formatting/extensions/html/string.rb

@@ -1,194 +0,0 @@
-#
-# Copyright (c) 2006-2021 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
-# 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/formatting/extensions/html/integer'
-require 'ronin/formatting/extensions/text/string'
-
-require 'cgi'
-
-class String
-
-  # JavaScript characters that must be back-slashed.
-  JS_BACKSLASHED_CHARS = {
-    "\\b"  => "\b",
-    "\\t"  => "\t",
-    "\\n"  => "\n",
-    "\\f"  => "\f",
-    "\\r"  => "\r",
-    "\\\"" => "\"",
-    "\\\\" => "\\"
-  }
-
-  #
-  # HTML escapes the String.
-  #
-  # @return [String]
-  #   The HTML escaped String.
-  #
-  # @example
-  #   "one & two".html_escape
-  #   # => "one &amp; two"
-  #
-  # @see https://rubydoc.info/stdlib/cgi/1.9.2/CGI.escapeHTML
-  #
-  # @since 0.2.0
-  #
-  # @api public
-  #
-  def html_escape
-    CGI.escapeHTML(self)
-  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
-  #
-  # @since 0.2.0
-  #
-  # @api public
-  #
-  def html_unescape
-    CGI.unescapeHTML(self)
-  end
-
-  #
-  # Formats the chars in the String for HTML.
-  #
-  # @param [Hash] options
-  #   Additional options for {#format_chars}.
-  #
-  # @return [String]
-  #   The formatted HTML String.
-  #
-  # @example
-  #   "abc".format_html
-  #   # => "&#97;&#98;&#99;"
-  #
-  # @see Integer#format_html
-  #
-  # @since 0.2.0
-  #
-  # @api public
-  #
-  def format_html(options={})
-    # String#ord was not backported to Ruby 1.8.7
-    formatter = if RUBY_VERSION < '1.9.' then lambda { |c| c[0].format_html  }
-                else                          lambda { |c| c.ord.format_html }
-                end
-
-    format_chars(options,&formatter)
-  end
-
-  #
-  # Escapes a String for JavaScript.
-  #
-  # @param [Hash] options
-  #   Additional options for {#format_chars}.
-  #
-  # @return [String]
-  #   The JavaScript escaped String.
-  #
-  # @example
-  #   "hello\nworld\n".js_escape
-  #   # => "hello\\nworld\\n"
-  #
-  # @see Integer#js_escape
-  #
-  # @since 0.2.0
-  #
-  # @api public
-  #
-  def js_escape(options={})
-    # String#ord was not backported to Rub 1.8.7
-    formatter = if RUBY_VERSION < '1.9.' then lambda { |c| c[0].js_escape  }
-                else                          lambda { |c| c.ord.js_escape }
-                end
-
-    format_chars(options,&formatter)
-  end
-
-  #
-  # Unescapes a JavaScript escaped String.
-  #
-  # @return [String]
-  #   The unescaped JavaScript String.
-  #
-  # @example
-  #   "\\u0068\\u0065\\u006C\\u006C\\u006F world".js_unescape
-  #   # => "hello world"
-  #
-  # @since 0.2.0
-  #
-  # @api public
-  #
-  def js_unescape
-    unescaped = ''
-
-    scan(/[\\%]u[0-9a-fA-F]{1,4}|[\\%][0-9a-fA-F]{1,2}|\\[btnfr"\\]|./) do |c|
-      unescaped << JS_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
-
-  #
-  # Escapes a String for JavaScript.
-  #
-  # @param [Hash] options
-  #   Additional options for {#format_chars}.
-  #
-  # @return [String]
-  #   The JavaScript escaped String.
-  #
-  # @example
-  #   "hello".js_escape
-  #   # => "\\u0068\\u0065\\u006C\\u006C\\u006F"
-  #
-  # @see Integer#js_escape
-  #
-  # @since 0.2.0
-  #
-  # @api public
-  #
-  def format_js(options={})
-    # String#ord was not backported to Rub 1.8.7
-    formatter = if RUBY_VERSION < '1.9.' then lambda { |c| c[0].format_js  }
-                else                          lambda { |c| c.ord.format_js }
-                end
-
-    format_chars(options,&formatter)
-  end
-
-end

data/lib/ronin/formatting/extensions/html.rb

@@ -1,21 +0,0 @@
-#
-# Copyright (c) 2006-2021 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
-# 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/formatting/extensions/html/integer'
-require 'ronin/formatting/extensions/html/string'

data/lib/ronin/formatting/extensions/http/string.rb

@@ -1,110 +0,0 @@
-#
-# Copyright (c) 2006-2021 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
-# 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/formatting/extensions/http/integer'
-require 'ronin/formatting/extensions/text'
-
-require 'uri/common'
-require 'cgi'
-
-class String
-
-  #
-  # URI encodes the String.
-  #
-  # @return [String]
-  #   The URI encoded form of the String.
-  #
-  # @example
-  #   "art is graffiti".uri_encode
-  #   # => "art%20is%20graffiti"
-  #
-  # @api public
-  #
-  def uri_encode
-    URI::DEFAULT_PARSER.escape(self)
-  end
-
-  #
-  # URI decodes the String.
-  #
-  # @return [String]
-  #   The decoded URI form of the String.
-  #
-  # @example
-  #   "genre%3f".uri_decode
-  #   # => "genre?"
-  #
-  # @api public
-  #
-  def uri_decode
-    URI::DEFAULT_PARSER.unescape(self)
-  end
-
-  #
-  # URI escapes the String.
-  #
-  # @return [String]
-  #   The URI escaped form of the String.
-  #
-  # @example
-  #   "x > y".uri_escape
-  #   # => "x+%3E+y"
-  #
-  # @api public
-  #
-  def uri_escape
-    CGI.escape(self)
-  end
-
-  #
-  # URI unescapes the String.
-  #
-  # @return [String]
-  #   The unescaped URI form of the String.
-  #
-  # @example
-  #   "sweet+%26+sour".uri_unescape
-  #   # => "sweet & sour"
-  #
-  # @api public
-  #
-  def uri_unescape
-    CGI.unescape(self)
-  end
-
-  #
-  # Formats the bytes of the String.
-  #
-  # @return [String]
-  #   The HTTP hexadecimal encoded form of the String.
-  #
-  # @example
-  #   "hello".format_http
-  #   # => "%68%65%6c%6c%6f"
-  #
-  # @see String#format_bytes
-  #
-  # @api public
-  #
-  def format_http(options={})
-    format_bytes(options) { |b| b.format_http }
-  end
-
-end

data/lib/ronin/formatting/extensions/http.rb

@@ -1,21 +0,0 @@
-#
-# Copyright (c) 2006-2021 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
-# 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/formatting/extensions/http/integer'
-require 'ronin/formatting/extensions/http/string'

data/lib/ronin/formatting/extensions/sql/string.rb

@@ -1,130 +0,0 @@
-#
-# Copyright (c) 2006-2021 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
-# 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 String
-
-  #
-  # Escapes an String for SQL.
-  #
-  # @param [:single, :double, :tick] quotes (:single)
-  #   Specifies whether to create a single or double quoted string.
-  #
-  # @return [String]
-  #   The escaped String.
-  #
-  # @raise [ArgumentError]
-  #   The quotes argument was neither `:single` nor `:double`.
-  #
-  # @example
-  #   "O'Brian".sql_escape
-  #   # => "'O''Brian'"
-  #
-  # @since 0.3.0
-  #
-  def sql_escape(quotes=:single)
-    char = case quotes
-           when :single then "'"
-           when :double then '"'
-           when :tick   then '`'
-           else
-             raise(ArgumentError,"invalid quoting style #{quotes.inspect}")
-           end
-
-    return char + gsub(char,char * 2) + char
-  end
-
-  #
-  # Returns the SQL hex-string encoded form of the String.
-  #
-  # @example
-  #   "/etc/passwd".sql_encode
-  #   # => "0x2f6574632f706173737764"
-  #
-  def sql_encode
-    return '' if empty?
-
-    hex_string = '0x'
-
-    each_byte do |b|
-      hex_string << ('%.2x' % b)
-    end
-
-    return hex_string
-  end
-
-  #
-  # Returns the SQL decoded form of the String.
-  #
-  # @example
-  #   "'Conan O''Brian'".sql_decode
-  #   # => "Conan O'Brian"
-  #
-  # @example
-  #  "0x2f6574632f706173737764".sql_decode
-  #  # => "/etc/passwd"
-  #
-  def sql_decode
-    if (start_with?('0x') && (length % 2 == 0))
-      raw = ''
-
-      self[2..-1].scan(/../) do |hex_char|
-        raw << hex_char.to_i(16).chr
-      end
-
-      return raw
-    elsif (start_with?("'") && end_with?("'"))
-      self[1..-2].gsub(/\\'|''/,"'")
-    else
-      return self
-    end
-  end
-
-  #
-  # Prepares the String for injection into a SQL expression.
-  #
-  # @return [String]
-  #   The SQL injection ready String.
-  #
-  # @example
-  #   "'1' OR '1'='1'".sql_inject
-  #   # => "1' OR '1'='1"
-  #
-  # @example
-  #   "'1' OR 1=1".sql_inject
-  #   # => "1' OR 1=1 OR '"
-  #
-  # @example
-  #   "'1' OR 1=1".sql_inject(:terminate => true)
-  #   # => "1' OR 1=1 --"
-  #
-  # @api public
-  #
-  # @since 0.4.0
-  #
-  def sql_inject
-    if (start_with?("'") || start_with?('"') || start_with?('`'))
-      if self[0,1] == self[-1,1] then self[1..-2]
-      else                            "#{self[1..-1]}--"
-      end
-    else
-      self
-    end
-  end
-
-end

data/lib/ronin/formatting/extensions/sql.rb

@@ -1,20 +0,0 @@
-#
-# Copyright (c) 2006-2021 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
-# 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/formatting/extensions/sql/string'

data/lib/ronin/formatting/extensions/text/array.rb

@@ -1,137 +0,0 @@
-#
-# Copyright (c) 2006-2021 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
-# 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 Array
-
-  #
-  # Decodes the bytes contained within the Array. The Array may contain
-  # both Integer and String objects.
-  #
-  # @return [Array]
-  #   The bytes contained within the Array.
-  #
-  # @example
-  #   [0x41, 0x41, 0x20].bytes
-  #   # => [0x41, 0x41, 0x20]
-  #
-  # @example
-  #   ['A', 'BB', 0x90].bytes
-  #   # => [0x41, 0x42, 0x42, 0x90]
-  #
-  # @api public
-  #
-  def bytes
-    bytes = []
-
-    each do |element|
-      case element
-      when Integer then bytes << element
-      else
-        element.to_s.each_byte do |b|
-          bytes << b
-        end
-      end
-    end
-
-    return bytes
-  end
-
-  #
-  # Decodes the characters contained within the Array. The Array may contain
-  # either Integer or String objects.
-  #
-  # @return [Array]
-  #   The characters generated from the array.
-  #
-  # @example
-  #   [0x41, 0x41, 0x20].chars
-  #   # => ["A", "A", " "]
-  #
-  # @api public
-  #
-  def chars
-    array_bytes = bytes
-    array_bytes.map! { |b| b.chr }
-
-    return array_bytes
-  end
-
-  #
-  # @return [String]
-  #   The String created from the characters within the Array.
-  #
-  # @example
-  #   [0x41, 0x41, 0x20].char_string
-  #   # => "AA "
-  #
-  # @api public
-  #
-  def char_string
-    chars.join
-  end
-
-  #
-  # Decodes the bytes contained with the Array, and escapes them as
-  # hexadecimal characters.
-  #
-  # @return [Array<String>]
-  #   The hexadecimal characters contained within the Array.
-  #
-  # @example
-  #   [0x41, 0x41, 0x20].bytes
-  #   # => ['\x41', '\x41', '\x20']
-  #
-  # @example
-  #   ['A', 'BB', 0x90].bytes
-  #   # => ['\x41', '\x42', '\x42', '\x90']
-  #
-  # @api public
-  #
-  def hex_chars
-    array_bytes = bytes
-    array_bytes.map! { |b| '\x%x' % b }
-
-    return array_bytes
-  end
-
-  #
-  # Decodes the bytes contained with the Array, and escapes them as
-  # hexadecimal integers.
-  #
-  # @return [Array<String>]
-  #   The hexadecimal integers contained within the Array.
-  #
-  # @example
-  #   [0x41, 0x41, 0x20].bytes
-  #   # => ['0x41', '0x41', '0x20']
-  #
-  # @example
-  #   ['A', 'BB', 0x90].bytes
-  #   # => ['0x41', '0x42', '0x42', '0x90']
-  #
-  # @api public
-  #
-  def hex_integers
-    array_bytes = bytes
-    array_bytes.map! { |b| '0x%x' % b }
-
-    return array_bytes
-  end
-
-end