ronin-support 0.4.1 → 0.5.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b09de7aeb48e4982f04cf079b79afdb6cdc5f133979440ee57470f7d121e3701
+  data.tar.gz: 17c1b5906bddf040dd705d4f3186db54dd8ca4a60789e77188d51ffd61d97ffa
+SHA512:
+  metadata.gz: 1c897be3967938ebce021b834b504a453fbbceac6375a7733714cc7995265a28bd3f002124ed4fd78179f188240315bacd20618f120389f7b1ad1c022e4b313b
+  data.tar.gz: 322fd58c49d71eefd767bc11a451a6ec0a0b58c802b95b64423a9e554d0c5e1a26581be10bb4674fcc737e5e5e463801c0fad5a8a471e061f542352dc58c6b05

data/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+tab_width = 8
+trim_trailing_whitespace = true
+
+[{Gemfile,Rakefile,*.rb,*.gemspec,*.yml}]
+indent_style = space
+indent_size = 2

data/.github/workflows/ruby.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+          - jruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7

data/.yardopts

@@ -1,2 +1,2 @@
---markup markdown --title 'Ronin Support Documentation' --protected
+--markup markdown --title 'ronin-support Documentation' --protected
 --plugin yard-parameters

data/ChangeLog.md

@@ -1,19 +1,107 @@
-### 0.4.1 / 2012-04-01
+### 0.5.2 / 2021-02-28
 
-* Added "WARNING" messages for when ronin-support cannot load `openssl` or
-  `zlib`.
-* Added YARD `@see` tags to all methods defined in {Ronin::Network::Mixins}.
-* Use `$stdout`, `$stderr` instead of `STDOUT`, `STDERR`, respectively.
-* Included {Ronin::Network::DNS} into {Net} as well.
-* Included {Ronin::Network::TCP} into {Ronin::Network::SSL}.
-* Require `ronin/network/ssl` in `ronin/network`.
-* Require `ronin/network/extensions/ssl` in `ronin/network/extensions`.
-* Included {Ronin::Network::SSL} into {Ronin::Support}.
-* Default all `local_port` variables to `0` instead of `nil`. Workaround
-  for JRuby bug [#6574](http://jira.codehaus.org/browse/JRUBY-6574).
-* Fixed a major syntax error in `ronin/network/ssl`, that caused the `ssl_*`
-  methods to not be defined in {Ronin::Network::SSL}.
-* Fixed YARD `@see` tags in the {Ronin::Network} modules.
+* Ruby 3.0 support:
+  * Temporarily added the [net-telnet] gem as a dependency, since Ruby 3.0 moved
+    `net/telnet` out of the stdlib.
+  * {Ronin::Fuzzing::SHORT_LENGTHS} and {Ronin::Fuzzing::LONG_LENGTHS} are now
+    `Set` objects, instead of `SortedSet`, which Ruby 3.0 moved out of stdlib.
+  * Use `URI::DEFAULT_PARSER.escape` / `.unescape` in {String#uri_encode},
+    {String#uri_decode}, and {Integer#uri_encode} now that `URI.encode`,
+    `URI.decode`, `URI.escape`, `URI.unescape` have all been removed in
+    Ruby 3.0.
+* Deprecated {Ronin::Network::Telnet}.
+* Allow {Ronin::Path#initialize} to accept a separator argument.
+* No longer bind new sockets to `0.0.0.0` by default in {Ronin::Network::TCP}
+  and {Ronin::Network::UDP}. `0.0.0.0` is the IPv4 Any address, which makes the
+  socket IPv4 and thus incompatible with IPv6 hosts.
+* Fixed a bug in {Ronin::Network::UDP#udp_open?} where it would always timeout
+  and return `nil`, even when the UDP port was open.
+* Filter out `nil` or empty `:query` options passed to
+  {Ronin::Network::HTTP.request}.
+* No longer append the query String to the path in
+  {Ronin::Network::HTTP.expand_url}.
+* Support escaping `"\`"` tick-marks in {String#sql_escape}.
+* Allow setting the request body or form-data in {Ronin::Network::HTTP.request},
+  even for request types that typically do not use a body or form-data.
+
+[net-telnet]: https://github.com/ruby/net-telnet
+
+### 0.5.1 / 2012-06-29
+
+* Added {Ronin::Binary::Template#inspect}.
+* Added the `:passive` option to {Ronin::Network::FTP#ftp_connect}.
+* Forgot to require `ronin/formatting/extensions/binary/array`.
+* Fixed a bug where {Array#pack} would not accept tuples (ex: `[:uint8, 2]`).
+* Fixed a bug in {String#sql_decode} where `"\\'\\'"` would incorrectly be
+  converted to `'"'`.
+* Ensure that {Integer#pack} only accepts one argument.
+* Have {String#hex_unescape} to decode every two characters.
+* Enable passive-mode by default in {Ronin::Network::FTP#ftp_connect}.
+
+### 0.5.0 / 2012-06-16
+
+* Require uri-query_params ~> 0.6.
+* Added {Float#pack}.
+* Added {Regexp::WORD}.
+* Added {Regexp::PHONE_NUMBER}.
+* Added {Ronin::Binary::Template}.
+* Added {Ronin::Binary::Struct}.
+* Added {Ronin::Binary::Hexdump::Parser}.
+* Added {Ronin::Fuzzing::Template}.
+* Added {Ronin::Fuzzing::Repeater}.
+* Added {Ronin::Fuzzing::Fuzzer}.
+* Added {Ronin::Fuzzing::Mutator}.
+* Added {Ronin::Wordlist.create}.
+* Added {Ronin::Wordlist#path} and {Ronin::Wordlist#words}.
+* Added {Ronin::Wordlist#save}.
+* Added {Ronin::Network::Proxy}, {Ronin::Network::TCP::Proxy} and
+  {Ronin::Network::UDP::Proxy}.
+* Added {Ronin::Network::TCP#tcp_open?}.
+* Added {Ronin::Network::TCP#tcp_server_loop}.
+* Added {Ronin::Network::UDP#udp_open?}.
+* Added {Ronin::Network::UDP#udp_server_loop}.
+* Added {Ronin::Network::Mixins::TCP#tcp_open?}.
+* Added {Ronin::Network::Mixins::UDP#udp_open?}.
+* Added {Ronin::Network::Mixins::UDP#udp_server_loop}.
+* Added {Ronin::Network::Mixins::UDP#udp_recv}.
+* Added {Ronin::Network::FTP}.
+* Added {Ronin::Network::UNIX}.
+* Added {Ronin::Network::Mixins::FTP}.
+* Added {Ronin::Network::Mixins::UNIX}.
+* Aliased {String#escape} to {String#dump}.
+* Renamed {String#hex_unescape} to {String#unescape}.
+  * Aliased {String#hex_unescape} to {String#unescape}.
+* Renamed {Ronin::Network::TCP#tcp_single_server} to
+  {Ronin::Network::TCP#tcp_accept}.
+* Renamed {Ronin::Network::UDP#udp_single_server} to
+  {Ronin::Network::UDP#udp_recv}.
+* Deprecated {Ronin::Network::TCP#tcp_single_server}.
+* Deprecated {Ronin::Network::UDP#udp_single_server}.
+* Backported Ruby 1.9 only {Base64} methods.
+* Allow {Integer#pack} to accept a type from {Ronin::Binary::Template::TYPES}.
+* Allow {Array#pack} to accept types from {Ronin::Binary::Template::TYPES}.
+* Allow {String#unpack} to accept types from {Ronin::Binary::Template::TYPES}.
+* Support nmap-style `i,j-k` globbed IP address ranges in {IPAddr.each}.
+* Moved {String#unhexdump} logic into {Ronin::Binary::Hexdump::Parser}.
+  * Added the `:named_chars` option.
+  * Improved the parsing of `od` hexdumps.
+  * Support unhexdumping specific endianness.
+  * Support unhexdumping floats / doubles.
+* Allow {String#mutate} to accept Symbols that map to {Ronin::Fuzzing}
+  generator methods.
+* {Ronin::Fuzzing.[]} now raises a `NoMethodError` for unknown fuzzing methods.
+* Use `module_function` in {Ronin::Fuzzing}, so the generator methods can be
+  included into other Classes/Modules.
+* Use `$stdout` instead of calling `Kernel.puts` or `STDOUT`.
+  Prevents infinite recursion if another library overrides `Kernel.puts`.
+* Allow {Ronin::Network::DNS} methods to yield resolved addresses.
+* Inject {Ronin::Network::DNS} into {Net} for backwards compatibility.
+* Allow {Ronin::Network::TCP#tcp_server} to accept a `backlog` argument.
+* Default the server host to `0.0.0.0` in
+  {Ronin::Network::TCP#tcp_accept}.
+* No longer honor the `VERBOSE` environment variable for enabling verbose output
+  in {Ronin::UI::Output}. Use `ruby -w` or `ruby -d` instead.
+* No longer support loading `extlib` in `ronin/support/inflector`.
 
 ### 0.4.0 / 2012-02-12
 
@@ -40,23 +128,23 @@
 * Added {String#mutate}.
 * Added {Ronin::Fuzzing}.
   * Added {Ronin::Fuzzing.[]}.
-  * Added {Ronin::Fuzzing.bad_strings}.
-  * Added {Ronin::Fuzzing.format_strings}.
-  * Added {Ronin::Fuzzing.bad_paths}.
-  * Added {Ronin::Fuzzing.bit_fields}.
-  * Added {Ronin::Fuzzing.signed_bit_fields}.
-  * Added {Ronin::Fuzzing.uint8}.
-  * Added {Ronin::Fuzzing.uint16}.
-  * Added {Ronin::Fuzzing.uint32}.
-  * Added {Ronin::Fuzzing.uint64}.
-  * Added {Ronin::Fuzzing.int8}.
-  * Added {Ronin::Fuzzing.int16}.
-  * Added {Ronin::Fuzzing.int32}.
-  * Added {Ronin::Fuzzing.int64}.
-  * Added {Ronin::Fuzzing.sint8}.
-  * Added {Ronin::Fuzzing.sint16}.
-  * Added {Ronin::Fuzzing.sint32}.
-  * Added {Ronin::Fuzzing.sint64}.
+  * Added `Ronin::Fuzzing.bad_strings`.
+  * Added `Ronin::Fuzzing.format_strings`.
+  * Added `Ronin::Fuzzing.bad_paths`.
+  * Added `Ronin::Fuzzing.bit_fields`.
+  * Added `Ronin::Fuzzing.signed_bit_fields`.
+  * Added `Ronin::Fuzzing.uint8`.
+  * Added `Ronin::Fuzzing.uint16`.
+  * Added `Ronin::Fuzzing.uint32`.
+  * Added `Ronin::Fuzzing.uint64`.
+  * Added `Ronin::Fuzzing.int8`.
+  * Added `Ronin::Fuzzing.int16`.
+  * Added `Ronin::Fuzzing.int32`.
+  * Added `Ronin::Fuzzing.int64`.
+  * Added `Ronin::Fuzzing.sint8`.
+  * Added `Ronin::Fuzzing.sint16`.
+  * Added `Ronin::Fuzzing.sint32`.
+  * Added `Ronin::Fuzzing.sint64`.
 * Added {Ronin::Wordlist}.
 * Added {Ronin::Network::DNS}.
 * Added {Ronin::Network::Mixins::Mixin}.
@@ -84,7 +172,7 @@
   was not being escaped.
 * Allow {Ronin::Network::HTTP.request} to accept `:query` and `:query_params`
   options.
-* Fixed a bug in {Ronin::Network::Mixins::HTTP#http_session}, where
+* Fixed a bug in `Ronin::Network::Mixins::HTTP#http_session`, where
   normalized options were not being yielded.
 * {Ronin::Network::HTTP#http_get_headers} and
   {Ronin::Network::HTTP#http_post_headers} now return a Hash of Capitalized

data/Gemfile

@@ -2,29 +2,28 @@ source 'https://rubygems.org'
 
 gemspec
 
-platforms :jruby do
-  gem 'jruby-openssl',	'~> 0.7'
-end
+gem 'jruby-openssl',	'~> 0.7.0', :platforms => :jruby
 
 group :development do
-  gem 'rake',		        '~> 0.8'
+  gem 'rake'
+  gem 'rubygems-tasks',     '~> 0.1'
+  gem 'rspec',              '~> 3.0'
 
-  gem 'ore-tasks',	    '~> 0.4'
-  gem 'rspec',          '~> 2.8'
+  gem 'ripl',               '~> 0.3'
+  gem 'ripl-multi_line',    '~> 0.2'
+  gem 'ripl-auto_indent',   '~> 0.1'
+  gem 'ripl-color_result',  '~> 0.3'
 
-  gem 'kramdown',       '~> 0.12'
+  gem 'kramdown',           '~> 2.0'
 end
 
 group :test do
-  gem 'i18n',           '~> 0.4'
-  gem 'tzinfo',         '~> 0.3'
-
-  INFLECTORS = {
-    'activesupport' => '~> 3.0',
-    'dm-core'       => '~> 1.0',
-    'extlib'        => '~> 0.9'
-  }
-
-  inflector = ENV.fetch('INFLECTOR','dm-core')
-  gem(inflector,INFLECTORS[inflector])
+  case ENV['INFLECTOR']
+  when 'activesupport'
+    gem 'i18n',           '~> 1.0'
+    gem 'tzinfo',         '~> 2.0'
+    gem 'activesupport',  '~> 6.0'
+  else
+    gem 'dm-core',        '~> 1.0'
+  end
 end

data/README.md

@@ -1,17 +1,24 @@
-# Ronin Support
+# ronin-support
+
+[![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)
-* [Documentation](http://ronin-ruby.github.com/docs/ronin-support/frames)
-* [Mailing List](http://groups.google.com/group/ronin-ruby)
-* [irc.freenode.net #ronin](http://webchat.freenode.net/?channels=ronin&uio=Mj10cnVldd)
+* [Documentation](https://ronin-rb.dev/docs/ronin-support/frames)
+* [Slack](https://ronin-rb.slack.com) |
+  [Discord](https://discord.gg/6WAb3PsVX9) |
+  [Twitter](https://twitter.com/ronin_rb) |
+  [IRC](https://ronin-rb.dev/irc/)
 
 ## Description
 
-Ronin Support is a support library for Ronin. Ronin Support contains many of
+ronin-support is a support library for ronin-rb. ronin-support contains many of
 the convenience methods used by Ronin and additional libraries.
 
-Ronin is a Ruby platform for exploit development and security research.
+It's like activesupport, but for hacking!
+
+[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.
 
@@ -20,18 +27,23 @@ or payloads over many common Source-Code-Management (SCM) systems.
 * Provides convenience methods for:
   * Formatting data:
     * Binary
+      * Structs
     * Text
-    * HTTP
     * URIs
+    * HTTP
     * HTML
     * JavaScript
     * SQL
   * Fuzzing
+    * Generating
+    * Mutating
   * Networking:
     * DNS
+    * UNIX
     * TCP
     * UDP
     * SSL
+    * FTP
     * SMTP / ESMTP
     * POP3
     * Imap
@@ -44,6 +56,7 @@ or payloads over many common Source-Code-Management (SCM) systems.
   * Handling exceptions.
 * Provides Modules/Classes for:
   * Paths
+  * Fuzzing
   * Wordlists
   * Erb Templates
   * UI:
@@ -53,52 +66,63 @@ or payloads over many common Source-Code-Management (SCM) systems.
 ## Examples
 
 For examples of the convenience methods provided by ronin-support,
-please see [Everyday Ronin](http://ronin-ruby.github.com/guides/everyday_ronin.html).
+please see [Everyday Ronin].
 
 ## Requirements
 
-* [Ruby](http://www.ruby-lang.org/) >= 1.8.7
-* [chars](https://github.com/postmodern/chars#readme)
-  ~> 0.2
-* [hexdump](https://github.com/postmodern/hexdump#readme)
-  ~> 0.1
-* [combinatorics](https://github.com/postmodern/combinatorics#readme)
-  ~> 0.4
-* [uri-query_params](https://github.com/postmodern/uri-query_params#readme)
-  ~> 0.6
-* [data_paths](https://github.com/postmodern/data_paths#readme)
-  ~> 0.3
-* [parameters](https://github.com/postmodern/parameters#readme)
-  ~> 0.4
+* [Ruby] >= 1.8.7
+* [chars] ~> 0.2
+* [hexdump] ~> 0.1
+* [combinatorics] ~> 0.4
+* [uri-query_params] ~> 0.6
+* [data_paths] ~> 0.3
+* [parameters] ~> 0.4
 
 ## Install
 
-### Stable
-
     $ gem install ronin-support
 
-### Edge
+### Gemfile
+
+    gem 'ronin-support', '~> 0.5'
+
+## Development
 
-    $ git clone git://github.com/ronin-ruby/ronin-support.git
-    $ cd ronin-support/
-    $ bundle install
-    $ rake console
+1. [Fork It!](https://github.com/ronin-rb/ronin-support/fork)
+2. Clone It!
+3. `cd ronin-support`
+4. `bundle install`
+5. `git checkout -b my_feature`
+6. Code It!
+7. `bundle exec rake spec`
+8. `git push origin my_feature`
 
 ## License
 
-Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 
-This file is part of Ronin Support.
+This file is part of ronin-support.
 
-Ronin Support is free software: you can redistribute it and/or modify
+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,
+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/>.
+along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+
+[ronin-rb]: https://ronin-rb.dev
+[Everyday Ronin]: https://ronin-rb.dev/guides/everyday_ronin.html
+[Ruby]: https://www.ruby-lang.org/
+
+[chars]: https://github.com/postmodern/chars#readme
+[hexdump]: https://github.com/postmodern/hexdump#readme
+[combinatorics]: https://github.com/postmodern/combinatorics#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

@@ -18,8 +18,15 @@ end
 
 require 'rake'
 
-require 'ore/tasks'
-Ore::Tasks.new
+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
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
@@ -31,7 +38,7 @@ namespace :spec do
   end
 end
 
-task :test => :spec
+task :test    => :spec
 task :default => :spec
 
 require 'yard'