ronin-support 0.5.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,3 +1,31 @@
+### 0.5.2 / 2021-02-28
+
+* 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}.

data/Gemfile

@@ -5,25 +5,24 @@ gemspec
 gem 'jruby-openssl',	'~> 0.7.0', :platforms => :jruby
 
 group :development do
-  gem 'rake',               '~> 0.8'
+  gem 'rake'
   gem 'rubygems-tasks',     '~> 0.1'
-  gem 'rspec',              '~> 2.8'
+  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 'rspec',              '~> 2.8'
 
-  gem 'kramdown',           '~> 0.12'
+  gem 'kramdown',           '~> 2.0'
 end
 
 group :test do
   case ENV['INFLECTOR']
   when 'activesupport'
-    gem 'i18n',           '~> 0.4'
-    gem 'tzinfo',         '~> 0.3.0'
-    gem 'activesupport',  '~> 3.0.0'
+    gem 'i18n',           '~> 1.0'
+    gem 'tzinfo',         '~> 2.0'
+    gem 'activesupport',  '~> 6.0'
   else
     gem 'dm-core',        '~> 1.0'
   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](https://groups.google.com/group/ronin-ruby)
-* [irc.freenode.net #ronin](http://ronin-ruby.github.com/irc/)
+* [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,6 +27,7 @@ or payloads over many common Source-Code-Management (SCM) systems.
 * Provides convenience methods for:
   * Formatting data:
     * Binary
+      * Structs
     * Text
     * URIs
     * HTTP
@@ -27,6 +35,8 @@ or payloads over many common Source-Code-Management (SCM) systems.
     * JavaScript
     * SQL
   * Fuzzing
+    * Generating
+    * Mutating
   * Networking:
     * DNS
     * UNIX
@@ -56,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

@@ -20,7 +20,6 @@ require 'rake'
 
 require 'rubygems/tasks'
 Gem::Tasks.new(:sign => {:checksum => true, :pgp => true}) do |tasks|
-  tasks.scm.tag.format  = 'v%s'
   tasks.console.command = 'ripl'
   tasks.console.options = %w[
     -rripl/multi_line
@@ -39,7 +38,7 @@ namespace :spec do
   end
 end
 
-task :test => :spec
+task :test    => :spec
 task :default => :spec
 
 require 'yard'

data/gemspec.yml

@@ -1,18 +1,27 @@
 name: ronin-support
-summary: A support library for Ronin.
-description:
-  Ronin Support is a support library for Ronin. Ronin Support contains many
+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.
 
-license: LGPL-3
+  It's like activesupport, but for hacking!
+
+license: LGPL-3.0
 authors: Postmodern
 email: postmodern.mod3@gmail.com
-homepage: http://ronin-ruby.github.com/
+homepage: https://ronin-rb.dev
 has_yard: true
 
+metadata:
+  documentation_uri: https://ronin-rb.dev/docs/ronin-support/frames
+  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
+
 required_ruby_version: ">= 1.8.7"
 
 dependencies:
+  net-telnet: ~> 0.1
   chars: ~> 0.2
   hexdump: ~> 0.1
   combinatorics: ~> 0.4
@@ -21,6 +30,6 @@ dependencies:
   parameters: ~> 0.4
 
 development_dependencies:
-  bundler: ~> 1.0
-  yard: ~> 0.8
+  bundler: ~> 2.0
+  yard: ~> 0.9
   yard-parameters: ~> 0.1

data/lib/ronin/binary.rb

@@ -1,20 +1,20 @@
 #
-# 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/>.
 #
 
 require 'ronin/binary/template'

data/lib/ronin/binary/hexdump.rb

@@ -1,20 +1,20 @@
 #
-# 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/>.
 #
 
 require 'ronin/binary/hexdump/parser'

data/lib/ronin/binary/hexdump/parser.rb

@@ -1,20 +1,20 @@
 #
-# 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/>.
 #
 
 require 'chars'

data/lib/ronin/binary/struct.rb

@@ -1,20 +1,20 @@
 #
-# 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/>.
 #
 
 require 'ronin/binary/template'

data/lib/ronin/binary/template.rb

@@ -1,20 +1,20 @@
 #
-# 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/>.
 #
 
 require 'set'
@@ -91,7 +91,7 @@ module Ronin
     # * `:long_be` (`l>`) - signed long integer, little endian.
     # * `:long_long_be` (`q>`) - signed quad integer, little endian.
     #
-    # @see http://rubydoc.info/stdlib/core/Array:pack
+    # @see https://rubydoc.info/stdlib/core/Array:pack
     #
     # @api semipbulic
     #
@@ -431,7 +431,7 @@ module Ronin
       # @return [String]
       #   The template String.
       #
-      # @see http://rubydoc.info/stdlib/core/Array:pack
+      # @see https://rubydoc.info/stdlib/core/Array:pack
       #
       def to_s
         @template