ronin-support 0.5.2 → 1.0.0.beta1

data/Gemfile

@@ -2,28 +2,29 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'jruby-openssl',	'~> 0.7.0', :platforms => :jruby
+gem 'jruby-openssl',	'~> 0.7', platforms: :jruby
+
+gem 'net-telnet', '~> 0.1', group: :net
+if RUBY_VERSION >= '3.1.0'
+  gem 'net-ftp',    '~> 0.1', group: :net, platform: :mri
+  gem 'net-smtp',   '~> 0.1', group: :net, platform: :mri
+  gem 'net-pop',    '~> 0.1', group: :net, platform: :mri
+  gem 'net-imap',   '~> 0.1', group: :net, platform: :mri
+end
 
 group :development do
   gem 'rake'
   gem 'rubygems-tasks',     '~> 0.1'
   gem 'rspec',              '~> 3.0'
-
-  gem 'ripl',               '~> 0.3'
-  gem 'ripl-multi_line',    '~> 0.2'
-  gem 'ripl-auto_indent',   '~> 0.1'
-  gem 'ripl-color_result',  '~> 0.3'
+  gem 'webmock',            '~> 3.0'
+  gem 'simplecov',          '~> 0.18'
 
   gem 'kramdown',           '~> 2.0'
-end
+  gem 'redcarpet',          platform: :mri
+  gem 'yard',               '~> 0.9'
+  gem 'yard-spellcheck',    require: false
 
-group :test do
-  case ENV['INFLECTOR']
-  when 'activesupport'
-    gem 'i18n',           '~> 1.0'
-    gem 'tzinfo',         '~> 2.0'
-    gem 'activesupport',  '~> 6.0'
-  else
-    gem 'dm-core',        '~> 1.0'
-  end
+  gem 'dead_end',           require: false
+  gem 'sord',               require: false
+  gem 'stackprof',          require: false
 end

data/README.md

@@ -3,88 +3,143 @@
 [![CI](https://github.com/ronin-rb/ronin-support/actions/workflows/ruby.yml/badge.svg)](https://github.com/ronin-rb/ronin-support/actions/workflows/ruby.yml)
 [![Code Climate](https://codeclimate.com/github/ronin-rb/ronin-support.svg)](https://codeclimate.com/github/ronin-rb/ronin-support)
 
-* [Source](https://github.com/ronin-ruby/ronin-support)
-* [Issues](https://github.com/ronin-ruby/ronin-support/issues)
+* [Source](https://github.com/ronin-rb/ronin-support)
+* [Issues](https://github.com/ronin-rb/ronin-support/issues)
 * [Documentation](https://ronin-rb.dev/docs/ronin-support/frames)
-* [Slack](https://ronin-rb.slack.com) |
-  [Discord](https://discord.gg/6WAb3PsVX9) |
+* [Discord](https://discord.gg/6WAb3PsVX9) |
   [Twitter](https://twitter.com/ronin_rb) |
-  [IRC](https://ronin-rb.dev/irc/)
+  [Mastodon](https://infosec.exchange/@ronin_rb)
 
 ## Description
 
-ronin-support is a support library for ronin-rb. ronin-support contains many of
-the convenience methods used by Ronin and additional libraries.
+ronin-support is a support library for [Ronin][ronin-rb]. ronin-support provides
+many Core Extensions to Ruby's built-in classes as well as it's own
+Classes/Modules. ronin-support can be used by other Ruby libraries, tools, or
+scripts.
 
-It's like activesupport, but for hacking!
+It's like [pwntools] combined with [activesupport].
 
-[ronin-rb] is a Ruby platform for exploit development and security research.
-Ronin allows for the rapid development and distribution of code, exploits
-or payloads over many common Source-Code-Management (SCM) systems.
+[Ronin][ronin-rb] is a [Ruby] toolkit for security research and development.
 
 ## Features
 
-* Provides convenience methods for:
-  * Formatting data:
-    * Binary
-      * Structs
-    * Text
-    * URIs
-    * HTTP
+* Provides user-friendly APIs for:
+  * Bit-flipping.
+  * Hexdump/unhexdump data.
+  * Packing/unpacking binary data:
+    * C types
+    * Buffers
+    * IO streams
+    * Stacks
+    * Strings
+    * Arrays
+    * Structs
+    * Unions
+  * Encoding data:
+    * Base16
+    * Base32
+    * Base64
+    * C strings
+    * Hex
     * HTML
+    * HTTP
     * JavaScript
+    * PowerShell
+    * Punycode
+    * Quoted-printable
+    * Ruby strings
+    * Shell
     * SQL
-  * Fuzzing
-    * Generating
-    * Mutating
+    * URI
+    * UUencoding
+    * XML
+  * Reading/writing compressed data:
+    * Zlib
+    * GZip
+  * Reading/writing archive files:
+    * Tar
+    * Zip
+  * Cryptography:
+    * RSA
+    * DSA
+    * DH
+    * EC
+    * HMAC
+    * Ciphers
+    * X509 certificates
   * Networking:
     * DNS
     * UNIX
     * TCP
     * UDP
-    * SSL
+    * SSL / TLS
     * FTP
     * SMTP / ESMTP
     * POP3
-    * Imap
+    * IMAP
     * Telnet
     * HTTP / HTTPS
-  * Enumerating IP ranges:
-    * IPv4 / IPv6 addresses.
-    * CIDR / globbed ranges.
-  * (Un-)Hexdumping data.
-  * Handling exceptions.
-* Provides Modules/Classes for:
-  * Paths
-  * Fuzzing
-  * Wordlists
-  * Erb Templates
-  * UI:
-    * Terminal Output
-    * Custom Shells
+    * Raw packets
+    * ASNs
+    * IP addresses
+    * IP ranges
+    * TLDs
+    * Public Suffix List
+    * Host names
+    * Domain names
+  * Working with text:
+    * Generating typos.
+    * Generating homoglyphs.
+    * Regexs for matching/extracting common types of data.
+* Has 95% documentation coverage.
+* Has 93% test coverage.
+
+## Synopsis
+
+```shell
+$ irb -r ronin/support
+irb(main):001:0> "hello world".base64_encode
+=> "aGVsbG8gd29ybGQ=\n"
+irb(main):002:0> "aGVsbG8gd29ybGQ=\n".base64_decode
+=> "hello world"
+```
 
 ## Examples
 
-For examples of the convenience methods provided by ronin-support,
+```ruby
+require 'ronin/support'
+include Ronin::Support
+
+string = "hello world"
+puts string.base64_encode
+
+data = "aGVsbG8gd29ybGQ=\n"
+puts data.base64_decode
+```
+
+For more examples of the convenience methods provided by ronin-support,
 please see [Everyday Ronin].
 
 ## Requirements
 
-* [Ruby] >= 1.8.7
-* [chars] ~> 0.2
-* [hexdump] ~> 0.1
+* [Ruby] >= 1.9.1
+* [chars] ~> 0.3, >= 0.3.2
+* [hexdump] ~> 1.0
 * [combinatorics] ~> 0.4
-* [uri-query_params] ~> 0.6
-* [data_paths] ~> 0.3
-* [parameters] ~> 0.4
+* [addressable] ~> 2.0
+* [uri-query_params] ~> 0.8
 
 ## Install
 
-    $ gem install ronin-support
+```shell
+$ gem install ronin-support
+```
 
 ### Gemfile
 
-    gem 'ronin-support', '~> 0.5'
+```ruby
+gem 'ronin-support', '~> 0.5'
+```
 
 ## Development
 
@@ -99,9 +154,7 @@ please see [Everyday Ronin].
 
 ## License
 
-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
@@ -120,9 +173,11 @@ along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 [Everyday Ronin]: https://ronin-rb.dev/guides/everyday_ronin.html
 [Ruby]: https://www.ruby-lang.org/
 
+[pwntools]: https://github.com/Gallopsled/pwntools
+[activesupport]: https://github.com/rails/rails/tree/main/activesupport#readme
+
 [chars]: https://github.com/postmodern/chars#readme
 [hexdump]: https://github.com/postmodern/hexdump#readme
 [combinatorics]: https://github.com/postmodern/combinatorics#readme
+[addressable]: https://github.com/sporkmonger/addressable#readme
 [uri-query_params]: https://github.com/postmodern/uri-query_params#readme
-[data_paths]: https://github.com/postmodern/data_paths#readme
-[parameters]: https://github.com/postmodern/parameters#readme

data/Rakefile

@@ -19,14 +19,7 @@ end
 require 'rake'
 
 require 'rubygems/tasks'
-Gem::Tasks.new(:sign => {:checksum => true, :pgp => true}) do |tasks|
-  tasks.console.command = 'ripl'
-  tasks.console.options = %w[
-    -rripl/multi_line
-    -rripl/auto_indent
-    -rripl/color_result
-  ]
-end
+Gem::Tasks.new(sign: {checksum: true, pgp: true})
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
@@ -44,3 +37,30 @@ task :default => :spec
 require 'yard'
 YARD::Rake::YardocTask.new
 task :docs => :yard
+
+namespace :public_suffix do
+  desc 'Downloads the public_suffix_list.dat file'
+  task :download do
+    require 'ronin/support/network/public_suffix/list'
+    Ronin::Support::Network::PublicSuffix::List.download(
+      path: 'public_suffix_list.dat'
+    )
+  end
+
+  desc 'Builds a regex for every public suffix'
+  task :build_regex => :download do
+    require 'ronin/support/network/public_suffix/list'
+    list = Ronin::Support::Network::PublicSuffix::List.load_file(
+      'public_suffix_list.dat'
+    )
+    
+    regex = list.to_regexp
+
+    template = 'data/text/patterns/network/public_suffix.rb.erb'
+    output   = 'lib/ronin/support/text/patterns/network/public_suffix.rb'
+
+    require 'erb'
+    erb = ERB.new(File.read(template))
+    File.write(output,erb.result(binding))
+  end
+end

data/data/text/homoglyphs/ascii.txt

@@ -0,0 +1,8 @@
+l I
+I l
+m rr
+O 0
+0 O
+w vv
+g q
+q g

data/data/text/homoglyphs/cyrillic.txt

@@ -0,0 +1,33 @@
+A А
+C С
+E Е
+H Н
+I І
+J Ј
+K К
+M М
+O О
+P Р
+S Ѕ
+T Т
+V Ѵ
+X Х
+Y Ү
+a а
+b Ь
+c с
+e е
+h һ
+i і
+j ј
+o о
+p р
+s ѕ
+v ѵ
+w ѡ
+x х
+y у
+Ä Ӓ
+Ö Ӧ
+ä ӓ
+ö ӧ

data/data/text/homoglyphs/full_width.txt

@@ -0,0 +1,81 @@
+! ！
+" ＂
+, ，
+- －
+/ ／
+; ；
+< ＜
+> ＞
+? ？
+A Ａ
+B Ｂ
+C Ｃ
+D Ｄ
+E Ｅ
+F Ｆ
+G Ｇ
+H Ｈ
+I Ｉ
+J Ｊ
+K Ｋ
+L Ｌ
+M Ｍ
+N Ｎ
+O Ｏ
+P Ｐ
+Q Ｑ
+R Ｒ
+S Ｓ
+T Ｔ
+U Ｕ
+V Ｖ
+W Ｗ
+X Ｘ
+Y Ｙ
+Z Ｚ
+[ ［
+\ ＼
+] ］
+^ ＾
+_ ＿
+` ｀
+a ａ
+b ｂ
+c ｃ
+d ｄ
+e ｅ
+f ｆ
+g ｇ
+h ｈ
+i ｉ
+j ｊ
+k ｋ
+l ｌ
+m ｍ
+n ｎ
+o ｏ
+p ｐ
+q ｑ
+r ｒ
+s ｓ
+t ｔ
+u ｕ
+v ｖ
+w ｗ
+x ｘ
+y ｙ
+z ｚ
+0 ０
+1 １
+2 ２
+3 ３
+4 ４
+5 ５
+6 ６
+7 ７
+8 ８
+9 ９
+{ ｛
+| ｜
+} ｝
+~ ～

data/data/text/homoglyphs/greek.txt

@@ -0,0 +1,21 @@
+; ;
+A Α
+B Β
+C Ϲ
+E Ε
+F Ϝ
+H Η
+I Ι
+K Κ
+M Μ
+N Ν
+O Ο
+P Ρ
+T Τ
+X Χ
+Y Υ
+Z Ζ
+c ϲ
+o ο
+v ν
+ß β

data/data/text/homoglyphs/latin_numbers.txt

@@ -0,0 +1,14 @@
+C Ⅽ
+D Ⅾ
+I Ⅰ
+L Ⅼ
+M Ⅿ
+V Ⅴ
+X Ⅹ
+c ⅽ
+d ⅾ
+i ⅰ
+l ⅼ
+m ⅿ
+v ⅴ
+x ⅹ

data/data/text/homoglyphs/punctuation.txt

@@ -0,0 +1,7 @@
+" ″
+* ⁎
+, ‚
+- ‐
+/ ⁄
+> ›
+~ ⁓

data/data/text/patterns/network/public_suffix.rb.erb

@@ -0,0 +1,44 @@
+# 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 Text
+      #
+      # @since 0.3.0
+      #
+      module Patterns
+        #
+        # @group Networking Patterns
+        #
+
+        # Regular expression to match all domain public suffixes.
+        #
+        # @note
+        #   This regex may be out of date since the [public suffix list] is
+        #   updated on a monthly basis, but should still match the majority of
+        #   valid TLDs.
+        #
+        # [public suffix list]: https://publicsuffix.org/
+        #
+        # @since 1.0.0
+        PUBLIC_SUFFIX = <%= regex.inspect %>
+      end
+    end
+  end
+end

data/examples/ssl_proxy.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ronin/support/network/ssl/proxy'
+
+Ronin::Support::Network::SSL::Proxy.start(port: 1337, server: ['example.com', 443]) do |proxy|
+  address = lambda { |socket|
+    addrinfo = socket.peeraddr
+
+    "#{addrinfo[3]}:#{addrinfo[1]}"
+  }
+
+  proxy.on_client_data do |client,server,data|
+    puts "#{address[client]} -> #{proxy}"
+    puts data
+  end
+
+  proxy.on_client_connect do |client|
+    puts "#{address[client]} -> #{proxy} [connected]"
+  end
+
+  proxy.on_client_disconnect do |client,server|
+    puts "#{address[client]} <- #{proxy} [disconnected]"
+  end
+
+  proxy.on_server_data do |client,server,data|
+    puts "#{address[client]} <- #{proxy}"
+    puts data
+  end
+
+  proxy.on_server_connect do |client,server|
+    puts "#{address[client]} <- #{proxy} [connected]"
+  end
+
+  proxy.on_server_disconnect do |client,server|
+    puts "#{address[client]} <- #{proxy} [disconnected]"
+  end
+end

data/examples/tcp_proxy.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'ronin/support/network/tcp/proxy'
+require 'hexdump'
+
+Ronin::Support::Network::TCP::Proxy.start(port: 1337, server: ['www.wired.com', 80]) do |proxy|
+  address = lambda { |socket|
+    addrinfo = socket.peeraddr
+
+    "#{addrinfo[3]}:#{addrinfo[1]}"
+  }
+  hex = Hexdump::Dumper.new
+
+  proxy.on_client_data do |client,server,data|
+    puts "#{address[client]} -> #{proxy}"
+    hex.dump(data)
+  end
+
+  proxy.on_client_connect do |client|
+    puts "#{address[client]} -> #{proxy} [connected]"
+  end
+
+  proxy.on_client_disconnect do |client,server|
+    puts "#{address[client]} <- #{proxy} [disconnected]"
+  end
+
+  proxy.on_server_data do |client,server,data|
+    puts "#{address[client]} <- #{proxy}"
+    hex.dump(data)
+  end
+
+  proxy.on_server_connect do |client,server|
+    puts "#{address[client]} <- #{proxy} [connected]"
+  end
+
+  proxy.on_server_disconnect do |client,server|
+    puts "#{address[client]} <- #{proxy} [disconnected]"
+  end
+end

data/gemspec.yml

@@ -1,10 +1,14 @@
 name: ronin-support
 summary: A support library for ronin-rb.
 description: |
-  ronin-support is a support library for ronin-rb. ronin-support contains many
-  of the convenience methods used by Ronin and additional libraries.
-
-  It's like activesupport, but for hacking!
+  ronin-support is a support library for ronin-rb. ronin-support provides
+  many Core Extensions to Ruby's built-in classes as well as it's own
+  Classes/Modules. ronin-support can be used by other Ruby libraries, tools, or
+  scripts.
+  
+  It's like pwntools combined with activesupport.
+  
+  Ronin is a Ruby toolkit for security research and development.
 
 license: LGPL-3.0
 authors: Postmodern
@@ -17,19 +21,16 @@ metadata:
   source_code_uri:   https://github.com/ronin-rb/ronin-support
   bug_tracker_uri:   https://github.com/ronin-rb/ronin-support/issues
   changelog_uri:     https://github.com/ronin-rb/ronin-support/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
 
-required_ruby_version: ">= 1.8.7"
+required_ruby_version: ">= 3.0.0"
 
 dependencies:
-  net-telnet: ~> 0.1
-  chars: ~> 0.2
-  hexdump: ~> 0.1
+  chars: ~> 0.3, >= 0.3.2
+  hexdump: ~> 1.0
   combinatorics: ~> 0.4
-  uri-query_params: ~> 0.6
-  data_paths: ~> 0.3
-  parameters: ~> 0.4
+  addressable: ~> 2.0
+  uri-query_params: ~> 0.8
 
 development_dependencies:
   bundler: ~> 2.0
-  yard: ~> 0.9
-  yard-parameters: ~> 0.1