ronin-support 0.5.1 → 1.0.0.beta1

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

@@ -0,0 +1,63 @@
+# 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/base16'
+
+class String
+
+  #
+  # [Base16] encodes the String.
+  #
+  # [Base16]: https://en.wikipedia.org/wiki/Base16
+  #
+  # @return [String]
+  #   The Base16 encoded String.
+  #
+  # @example
+  #   "The quick brown fox jumps over the lazy dog".base16_encode
+  #   # => "54686520717569636b2062726f776e20666f78206a756d7073206f76657220746865206c617a7920646f67"
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def base16_encode
+    Ronin::Support::Encoding::Base16.encode(self)
+  end
+
+  #
+  # [Base16] decodes the String.
+  #
+  # [Base16]: https://en.wikipedia.org/wiki/Base16
+  #
+  # @return [String]
+  #   The Base16 decodes String.
+  #
+  # @example
+  #   "54686520717569636b2062726f776e20666f78206a756d7073206f76657220746865206c617a7920646f67".base16_decode
+  #   # => "The quick brown fox jumps over the lazy dog"
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def base16_decode
+    Ronin::Support::Encoding::Base16.decode(self)
+  end
+
+end

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

@@ -0,0 +1,19 @@
+# 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/base16/core_ext/string'

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

@@ -0,0 +1,82 @@
+# 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
+    class Encoding < ::Encoding
+      #
+      # Base16 encoding.
+      #
+      # @see https://www.rfc-editor.org/rfc/rfc4648#page-10
+      #
+      # @api public
+      #
+      # @since 1.0.0
+      #
+      module Base16
+        #
+        # Base16 encodes the given data.
+        #
+        # @param [String] data
+        #   The given data to Base16 encode.
+        #
+        # @return [String]
+        #   The Base16 encoded version of the String.
+        #
+        # @example
+        #   Encoding::Base16.encode("hello")
+        #   # => "68656C6C6F"
+        #
+        def self.encode(data)
+          encoded = String.new
+
+          data.each_byte do |byte|
+            encoded << "%.2x" % byte
+          end
+
+          return encoded
+        end
+
+        #
+        # Base16 decodes the String.
+        #
+        # @param [String] data
+        #   The given data to Base16 decode.
+        #
+        # @return [String]
+        #   The Base16 decoded version of the String.
+        #
+        # @example
+        #   Encoding::Base16.decode("68656C6C6F")
+        #   # => "hello"
+        #
+        def self.decode(data)
+          decoded = String.new
+
+          data.scan(/../).each do |hex_char|
+            decoded << hex_char.to_i(16).chr
+          end
+
+          return decoded
+        end
+      end
+    end
+  end
+end
+
+require 'ronin/support/encoding/base16/core_ext'

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

@@ -0,0 +1,63 @@
+# 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/base32'
+
+class String
+
+  #
+  # [Base32] encodes the String.
+  #
+  # [Base32]: https://en.wikipedia.org/wiki/Base32
+  #
+  # @return [String]
+  #   The Base32 encoded String.
+  #
+  # @example
+  #   "The quick brown fox jumps over the lazy dog".base32_encode
+  #   # => "KRUGKIDROVUWG2ZAMJZG653OEBTG66BANJ2W24DTEBXXMZLSEB2GQZJANRQXU6JAMRXWO==="
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def base32_encode
+    Ronin::Support::Encoding::Base32.encode(self)
+  end
+
+  #
+  # [Base32] decodes the String.
+  #
+  # [Base32]: https://en.wikipedia.org/wiki/Base32
+  #
+  # @return [String]
+  #   The Base32 decodes String.
+  #
+  # @example
+  #   "KRUGKIDROVUWG2ZAMJZG653OEBTG66BANJ2W24DTEBXXMZLSEB2GQZJANRQXU6JAMRXWO===".base32_decode
+  #   # => "The quick brown fox jumps over the lazy dog"
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def base32_decode
+    Ronin::Support::Encoding::Base32.decode(self)
+  end
+
+end

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

@@ -0,0 +1,19 @@
+# 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/base32/core_ext/string'

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

@@ -0,0 +1,164 @@
+# 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
+    class Encoding < ::Encoding
+      #
+      # Base32 encoding.
+      #
+      # @see https://datatracker.ietf.org/doc/html/rfc3548#page-6
+      #
+      # @api public
+      #
+      # @since 1.0.0
+      #
+      module Base32
+        #
+        # Base32 encodes the given String.
+        #
+        # @param [String] data
+        #   The String to encode.
+        #
+        # @return [String]
+        #   The Base32 encoded String.
+        #
+        def self.encode(data)
+          encoded = String.new
+
+          each_chunk(data,5) do |chunk|
+            chunk.encode(encoded)
+          end
+
+          return encoded
+        end
+
+        #
+        # Base32 decodes the given String.
+        #
+        # @param [String] data
+        #   The String to decode.
+        #
+        # @return [String]
+        #   The Base32 decoded String.
+        #
+        def self.decode(data)
+          decoded = String.new
+
+          each_chunk(data,8) do |chunk|
+            chunk.decode(decoded)
+          end
+
+          return decoded
+        end
+
+        private
+
+        # Base32 alphabet
+        TABLE = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'
+
+        #
+        # Represents a chunk of data.
+        #
+        class Chunk
+
+          #
+          # Initializes the chunk.
+          #
+          # @param [Array<Integer>] bytes
+          #   The bytes for the chunk.
+          #
+          def initialize(bytes)
+            @bytes = bytes
+          end
+
+          #
+          # Decodes the chunk.
+          #
+          # @param [String] output
+          #   Optional output buffer.
+          #
+          # @return [String]
+          #   The Base32 decoded chunk.
+          #
+          def decode(output=String.new)
+            bytes = @bytes.take_while { |b| b != 61 } # strip padding
+            n = (bytes.length * 5.0 / 8.0).floor
+            p = bytes.length < 8 ? 5 - (n * 8) % 5 : 0
+            c = bytes.reduce(0) { |m,o|
+              unless (i = Base32::TABLE.index(o.chr))
+                raise ArgumentError, "invalid character '#{o.chr}'"
+              end
+
+              (m << 5) + i
+            } >> p
+
+            (0..n-1).reverse_each.each do |i|
+              output << ((c >> i * 8) & 0xff).chr
+            end
+
+            return output
+          end
+
+          #
+          # Encodes the chunk.
+          #
+          # @param [String] output
+          #   Optional output buffer.
+          #
+          # @return [String]
+          #   The Base32 encoded chunk.
+          #
+          def encode(output=String.new)
+            n = (@bytes.length * 8.0 / 5.0).ceil
+            p = n < 8 ? 5 - (@bytes.length * 8) % 5 : 0
+            c = @bytes.inject(0) {|m,o| (m << 8) + o} << p
+
+            (0..n-1).reverse_each do |i|
+              output << Base32::TABLE[(c >> i * 5) & 0x1f].chr
+            end
+
+            return output << ("=" * (8-n))
+          end
+
+        end
+
+        #
+        # Enumerates over the consecutive chunks within the given data.
+        #
+        # @param [String] data
+        #
+        # @param [Integer] size
+        #
+        # @yield [chunk]
+        #
+        # @yieldparam [Chunk] chunk
+        #
+        def self.each_chunk(data,size)
+          bytes  = data.bytes
+
+          data.bytes.each_slice(size) do |bytes|
+            yield Chunk.new(bytes)
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'ronin/support/encoding/base32/core_ext'

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

@@ -0,0 +1,76 @@
+# 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/base64'
+
+class String
+
+  #
+  # [Base64] encodes a string.
+  #
+  # [Base64]: https://en.wikipedia.org/wiki/Base64
+  #
+  # @param [Symbol, nil] mode
+  #   The base64 mode to use. May be either:
+  #
+  #   * `nil`
+  #   * `:strict`
+  #   * `:url_safe`
+  #
+  # @return [String]
+  #   The base64 encoded form of the string.
+  #
+  # @example
+  #   "hello".base64_encode
+  #   # => "aGVsbG8=\n"
+  #
+  # @api public
+  #
+  def base64_encode(mode: nil)
+    Ronin::Support::Encoding::Base64.encode(self, mode: mode)
+  end
+
+  #
+  # [Base64] decodes a string.
+  #
+  # [Base64]: https://en.wikipedia.org/wiki/Base64
+  #
+  # @param [Symbol, nil] mode
+  #   The base64 mode to use. May be either:
+  #
+  #   * `nil`
+  #   * `:strict`
+  #   * `:url_safe`
+  #
+  # @return [String]
+  #   The base64 decoded form of the string.
+  #
+  # @note
+  #   `mode` argument is only available on Ruby >= 1.9.
+  #
+  # @example
+  #   "aGVsbG8=\n".base64_decode
+  #   # => "hello"
+  #
+  # @api public
+  #
+  def base64_decode(mode: nil)
+    Ronin::Support::Encoding::Base64.decode(self, mode: mode)
+  end
+
+end

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

@@ -0,0 +1,19 @@
+# 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/base64/core_ext/string'

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

@@ -0,0 +1,78 @@
+# 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 'base64'
+
+module Ronin
+  module Support
+    class Encoding < ::Encoding
+      #
+      # Base64 encoding/decoding.
+      #
+      # @api public
+      #
+      module Base64
+        #
+        # Base64 encodes the given data.
+        #
+        # @param [String] data
+        #   The data to Base64 encode.
+        #
+        # @param [:strict, :url_safe, nil] mode
+        #   The Base64 encoding mode.
+        #
+        # @return [String]
+        #   The Base64 encoded data.
+        #
+        def self.encode(data, mode: nil)
+          case mode
+          when :strict   then ::Base64.strict_encode64(data)
+          when :url_safe then ::Base64.urlsafe_encode64(data)
+          when nil       then ::Base64.encode64(data)
+          else
+            raise(ArgumentError,"Base64 mode must be either :string, :url, or nil: #{mode.inspect}")
+          end
+        end
+
+        #
+        # Base64 decodes the given data.
+        #
+        # @param [String] data
+        #   The Base64 data to decode.
+        #
+        # @param [:strict, :url_safe, nil] mode
+        #   The Base64 encoding mode.
+        #
+        # @return [String]
+        #   The decoded data.
+        #
+        def self.decode(data, mode: nil)
+          case mode
+          when :strict   then ::Base64.strict_decode64(data)
+          when :url_safe then ::Base64.urlsafe_decode64(data)
+          when nil       then ::Base64.decode64(data)
+          else
+            raise(ArgumentError,"Base64 mode must be either :string, :url, or nil: #{mode.inspect}")
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'ronin/support/encoding/base64/core_ext'

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

@@ -0,0 +1,82 @@
+# 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/encoding/c'
+
+class Integer
+
+  #
+  # Escapes the Integer as a C character.
+  #
+  # @return [String]
+  #   The escaped C character.
+  #
+  # @raise [RangeError]
+  #   The integer value is negative.
+  #
+  # @example 
+  #   0x41.c_escape
+  #   # => "A"
+  #   0x22.c_escape
+  #   # => "\\\""
+  #   0x7f.c_escape
+  #   # => "\\x7F"
+  #
+  # @example Escaping unicode characters:
+  #   0xffff.c_escape
+  #   # => "\\uFFFF"
+  #   0x10000.c_escape
+  #   # => "\\U000100000"
+  #
+  # @see Ronin::Support::Encoding::C.escape_byte
+  #
+  # @since 1.0.0
+  #
+  # @api public
+  #
+  def c_escape
+    Ronin::Support::Encoding::C.escape_byte(self)
+  end
+
+  alias c_char c_escape
+
+  #
+  # Formats the Integer as a C escaped String.
+  #
+  # @return [String]
+  #   The escaped C character.
+  #
+  # @example
+  #   0x41.c_encode
+  #   # => "\\x41"
+  #   0x100.c_encode
+  #   # => "\\u1000"
+  #   0x10000.c_encode
+  #   # => "\\U000100000"
+  #
+  # @see Ronin::Support::Encoding::C.encode_byte
+  #
+  # @since 1.0.0
+  #
+  # @api public
+  #
+  def c_encode
+    Ronin::Support::Encoding::C.encode_byte(self)
+  end
+
+end