ronin 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b96dfac7bb76a9141b93ec0fb0de42a39b33b395ba1a0d946ad6a1be89f080f
-  data.tar.gz: bddecb41842c7930939cce565afc39d93881c27bff7ef51cfb9f730d2e77e020
+  metadata.gz: 42aeafda3468e4c0f5427a4f2323d40b96bb4aaafc042bb8380d569f5c8c5414
+  data.tar.gz: a150c7211fa93770dc9be47343f8f3d3391396996885263580c0185742476255
 SHA512:
-  metadata.gz: 3c61141e197c44975416cc10c76a13962b9bc3764d1892fc60ded4785aabf960eeab2bbdfb8b1d5e0c6db523afeb3f46c9c9fcb35c15d581fbdab287e185889a
-  data.tar.gz: 1d8f93d1f6bcef6b08cafc1527bfa81d46ab7ddb31bdab97813c4cc3b40c30674d31593a513dcf3468a7ad80134b00165f0cbf1dbb3bcf059f17a828e6dbfd20
+  metadata.gz: 562df97d739aedfad72706c939d40697f8ab39136a3aab69e2d67e7aa29b3ea03bf1534695f259af8060c5e09f26e6e6c51ff62c57fa8d1ad73242c0c48e9c78
+  data.tar.gz: '018c73e255ed3b3468d84c054d8b79095cef777443536beac09e572d1bf183ce0d3a019a8e45560013c13a0b8df202a7402d1c4d4cd41ff884a0179f932e51bb'

data/.github/workflows/ruby.yml

@@ -30,3 +30,17 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+inherit_gem:
+  rubocop-ronin: rubocop.yml
+
+#
+# ronin specific exceptions
+#
+
+# this rule does not take into account the spacing of commented out lines
+Layout/ExtraSpacing:
+  Exclude:
+    - 'Gemfile'
+
+# no need to add `frozen_string_literal: true` to new scripts/projects
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'data/new/**/*'

data/ChangeLog.md

@@ -1,4 +1,20 @@
-### 2.0.0 / 2023-XX-XX
+### 2.0.1 / 2023-03-01
+
+* Require [ronin-support] ~> 1.0, >= 1.0.1.
+* Require [ronin-core] ~> 0.1, >= 0.1.1.
+* Require [ronin-web] ~> 1.0, >= 1.0.1.
+* Require [ronin-payloads] ~> 0.1, >= 0.1.1.
+* Require [ronin-vulns] ~> 0.1, >= 0.1.2.
+* Require [ronin-exploits] ~> 1.0, >= 1.0.1.
+* Added {Ronin::CLI::HostAndPort} for common `host:port` parsing logic.
+* Minor bug fixes.
+* Improved documentation.
+
+#### CLI
+
+* Ensure that the `ronin http` command works with IDN host-names.
+
+### 2.0.0 / 2023-02-01
 
 * Require `ruby` >= 3.0.0.
 * Require [rouge] ~> 3.0
@@ -756,7 +772,7 @@
 * Require Spidr >= 0.1.3.
 * Moved Ronin::Parameters into the parameters 0.1.0 RubyGem.
 * Added a Ronin::Hexdump module:
-  * Provides Ronin::Hexdump.dump and Kernel#hexdump, which can hexdump any 
+  * Provides Ronin::Hexdump.dump and Kernel#hexdump, which can hexdump any
     object that supports the #each_byte method.
 * Refactored Ronin::Chars::CharSet:
   * Now inherites the SortedSet class.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
@@ -45,9 +47,9 @@ end
 #                                        branch: 'main'
 # gem 'ronin-vulns',           '~> 0.1', github: "ronin-rb/ronin-vulns",
 #                                        branch: 'main'
-# gem 'ronin-web-server',	     '~> 0.1', github: "ronin-rb/ronin-web-server",
+# gem 'ronin-web-server',      '~> 0.1', github: "ronin-rb/ronin-web-server",
 #                                        branch: 'main'
-# gem 'ronin-web-spider',	     '~> 0.1', github: "ronin-rb/ronin-web-spider",
+# gem 'ronin-web-spider',      '~> 0.1', github: "ronin-rb/ronin-web-spider",
 #                                        branch: 'main'
 # gem 'ronin-web-user_agents', '~> 0.1', github: "ronin-rb/ronin-web-user_agents",
 #                                        branch: 'main'
@@ -70,4 +72,6 @@ group :development do
   gem 'dead_end',        require: false
   gem 'sord',            require: false, platform: :mri
   gem 'stackprof',       require: false, platform: :mri
+  gem 'rubocop',         require: false, platform: :mri
+  gem 'rubocop-ronin',   require: false, platform: :mri
 end

data/Rakefile

@@ -1,11 +1,11 @@
-require 'rubygems'
+# frozen_string_literal: true
 
 begin
   require 'bundler'
 rescue LoadError => e
   warn e.message
   warn "Run `gem install bundler` to install Bundler"
-  exit -1
+  exit(-1)
 end
 
 begin

data/bin/ronin

@@ -1,17 +1,16 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rubygems'
 
 root = File.expand_path(File.join(File.dirname(__FILE__),'..'))
 if File.file?(File.join(root,'Gemfile.lock'))
   Dir.chdir(root) do
-    begin
-      require 'bundler/setup'
-    rescue LoadError => e
-      warn e.message
-      warn "Run `gem install bundler` to install Bundler"
-      exit -1
-    end
+    require 'bundler/setup'
+  rescue LoadError => e
+    warn e.message
+    warn "Run `gem install bundler` to install Bundler"
+    exit(-1)
   end
 end
 

data/data/new/project/Gemfile.erb

@@ -4,13 +4,13 @@ source 'https://rubygems.org'
 gem 'rake'
 
 <%- end -%>
-gem 'ronin-support',         '~> 1.0' #, github: 'ronin-rb/ronin-support'
+gem 'ronin-support',         '~> 1.0' # , github: 'ronin-rb/ronin-support'
 
-# gem 'ronin-code-asm',        '~> 0.3' #, github: 'ronin-rb/ronin-code-asm'
-# gem 'ronin-code-sql',        '~> 1.2' #, github: 'ronin-rb/ronin-code-sql'
-# gem 'ronin-db',              '~> 0.1' #, github: 'ronin-rb/ronin-db'
-# gem 'ronin-web-server',      '~> 0.1' #, github: 'ronin-rb/ronin-web-server'
-# gem 'ronin-web-spider',      '~> 0.1' #, github: 'ronin-rb/ronin-web-spider'
-# gem 'ronin-web-user_agents', '~> 0.1' #, github: 'ronin-rb/ronin-web-user_agents'
-# gem 'ronin-payloads',        '~> 0.1' #, github: 'ronin-rb/ronin-payloads'
-# gem 'ronin-exploits',        '~> 1.0' #, github: 'ronin-rb/ronin-exploits'
+# gem 'ronin-code-asm',        '~> 0.3' # , github: 'ronin-rb/ronin-code-asm'
+# gem 'ronin-code-sql',        '~> 1.2' # , github: 'ronin-rb/ronin-code-sql'
+# gem 'ronin-db',              '~> 0.1' # , github: 'ronin-rb/ronin-db'
+# gem 'ronin-web-server',      '~> 0.1' # , github: 'ronin-rb/ronin-web-server'
+# gem 'ronin-web-spider',      '~> 0.1' # , github: 'ronin-rb/ronin-web-spider'
+# gem 'ronin-web-user_agents', '~> 0.1' # , github: 'ronin-rb/ronin-web-user_agents'
+# gem 'ronin-payloads',        '~> 0.1' # , github: 'ronin-rb/ronin-payloads'
+# gem 'ronin-exploits',        '~> 1.0' # , github: 'ronin-rb/ronin-exploits'

data/gemspec.yml

@@ -2,7 +2,7 @@ name: ronin
 summary: A Ruby toolkit for security research and development.
 description:
   Ronin is a free and Open Source Ruby toolkit for security research and
-  development.Ronin contains many different CLI commands and Ruby libraries for 
+  development.Ronin contains many different CLI commands and Ruby libraries for
   a variety of security tasks, such as encoding/decoding data, filter
   IPs/hosts/URLs, querying ASNs, querying DNS, HTTP, scanning for web
   vulnerabilities, spidering websites, install 3rd party repositories of
@@ -96,17 +96,17 @@ dependencies:
   async-io: ~> 1.0
   wordlist: ~> 1.0
   # Ronin dependencies:
-  ronin-support: ~> 1.0
-  ronin-core: ~> 0.1
+  ronin-support: ~> 1.0, >= 1.0.1
+  ronin-core: ~> 0.1, >= 0.1.1
   ronin-repos: ~> 0.1
   ronin-db: ~> 0.1
   ronin-fuzzer: ~> 0.1
-  ronin-web: ~> 1.0
+  ronin-web: ~> 1.0, >= 1.0.1
   ronin-code-asm: ~> 1.0
   ronin-code-sql: ~> 2.0
-  ronin-payloads: ~> 0.1
-  ronin-exploits: ~> 1.0
-  ronin-vulns: ~> 0.1
+  ronin-payloads: ~> 0.1, >= 0.1.1
+  ronin-exploits: ~> 1.0, >= 1.0.1
+  ronin-vulns: ~> 0.1, >= 0.1.2
 
 development_dependencies:
   bundler: ~> 2.0

data/lib/ronin/cli/char_set_options.rb

@@ -68,7 +68,7 @@ module Ronin
         command.option :include_chars, short: '-i',
                                        value: {
                                          type: String,
-                                         usage: 'CHARS',
+                                         usage: 'CHARS'
                                        },
                                        desc: 'Include the additional chars to the char-set' do |string|
                                          @char_set += Chars::CharSet.new(*string.chars)

data/lib/ronin/cli/cipher_command.rb

@@ -24,6 +24,9 @@ require 'ronin/support/crypto/cipher'
 module Ronin
   class CLI
     module Commands
+      #
+      # Base class for all commands which use ciphers.
+      #
       class CipherCommand < FileProcessorCommand
 
         include KeyOptions
@@ -142,7 +145,6 @@ module Ronin
           cipher.stream(input, block_size: @block_size, output: stdout)
         end
 
-
       end
     end
   end

data/lib/ronin/cli/command.rb

@@ -21,6 +21,9 @@ require 'ronin/root'
 
 module Ronin
   class CLI
+    #
+    # Base class for all `ronin` sub-commands.
+    #
     class Command < Core::CLI::Command
 
       man_dir File.join(ROOT,'man')

data/lib/ronin/cli/commands/asn.rb

@@ -151,7 +151,7 @@ module Ronin
               print_asn_record(record)
             else
               print_error "could not find a record for the IP: #{options[:ip]}"
-              exit -1
+              exit(-1)
             end
           else
             print_asn_records(search_asn_records)

data/lib/ronin/cli/commands/banner_grab.rb

@@ -17,6 +17,7 @@
 #
 
 require 'ronin/cli/value_processor_command'
+require 'ronin/cli/host_and_port'
 
 require 'ronin/support/network/tcp'
 
@@ -42,6 +43,8 @@ module Ronin
       #
       class BannerGrab < ValueProcessorCommand
 
+        include HostAndPort
+
         usage '[options] {HOST:PORT} ...'
 
         option :with_host_port, desc: 'Print the service with the banner'
@@ -62,8 +65,7 @@ module Ronin
         #   The `HOST:PORT` service pair.
         #
         def process_value(service)
-          host, port = service.split(':',2)
-          port = port.to_i
+          host, port = host_and_port(service)
 
           begin
             banner = Support::Network::TCP.banner(host,port)
@@ -73,7 +75,7 @@ module Ronin
             else
               puts banner
             end
-          rescue => error
+          rescue StandardError => error
             print_error("#{service}: #{error.message}")
           end
         end

data/lib/ronin/cli/commands/cert_dump.rb

@@ -17,6 +17,7 @@
 #
 
 require 'ronin/cli/value_processor_command'
+require 'ronin/cli/host_and_port'
 require 'ronin/support/crypto/cert'
 require 'ronin/support/network/ssl/mixin'
 
@@ -62,6 +63,7 @@ module Ronin
         include CommandKit::Printing::Indent
         include CommandKit::Printing::Fields
         include CommandKit::Printing::Lists
+        include HostAndPort
 
         usage '[options] {HOST:PORT | URL | FILE} ...'
 
@@ -100,14 +102,11 @@ module Ronin
         def process_value(value)
           case value
           when /\A[^:]+:\d+\z/
-            host, port = value.split(':',2)
-            port = port.to_i
+            host, port = host_and_port(value)
 
             print_cert(ssl_cert(host,port))
           when /\Ahttps:/
-            uri = URI.parse(value)
-            host = uri.host
-            port = uri.port
+            host, port = host_and_port_from_url(value)
 
             print_cert(ssl_cert(host,port))
           else
@@ -180,8 +179,6 @@ module Ronin
 
           puts
 
-          fields = {}
-
           if options[:extensions]
             puts "Extensions:"
             indent do

data/lib/ronin/cli/commands/cert_gen.rb

@@ -103,8 +103,8 @@ module Ronin
 
         option :subject_alt_name, short: '-A',
                                   value: {
-                                     type:  /[a-z0-9:\._-]+/,
-                                     usage: 'HOST|IP'
+                                    type:  /[a-z0-9:\._-]+/,
+                                    usage: 'HOST|IP'
                                   },
                                   desc: 'Adds HOST or IP to subjectAltName' do |value|
                                     @subject_alt_names << value
@@ -277,7 +277,7 @@ module Ronin
           @not_after ||= if options[:not_after]
                            Time.parse(options[:not_after])
                          else
-                           not_before+Support::Crypto::Cert::ONE_YEAR
+                           not_before + Support::Crypto::Cert::ONE_YEAR
                          end
         end
 
@@ -378,7 +378,7 @@ module Ronin
         # @return [String, nil]
         #
         def subject_alt_name_ext
-          if !@subject_alt_names.empty?
+          unless @subject_alt_names.empty?
             @subject_alt_names.map { |name|
               if name =~ IP_REGEXP
                 "IP: #{name}"

data/lib/ronin/cli/commands/cert_grab.rb

@@ -17,6 +17,7 @@
 #
 
 require 'ronin/cli/value_processor_command'
+require 'ronin/cli/host_and_port'
 require 'ronin/support/network/ssl/mixin'
 
 require 'uri'
@@ -49,6 +50,7 @@ module Ronin
       #
       class CertGrab < ValueProcessorCommand
 
+        include HostAndPort
         include Support::Network::SSL::Mixin
 
         usage '[options] {HOST:PORT | URL} ...'
@@ -63,7 +65,7 @@ module Ronin
         examples [
           'github.com:443',
           '93.184.216.34:443',
-          'https://github.com/',
+          'https://github.com/'
         ]
 
         man_page 'ronin-cert-grab.1'
@@ -77,14 +79,11 @@ module Ronin
         def process_value(value)
           case value
           when /\A[^:]+:\d+\z/
-            host, port = value.split(':',2)
-            port = port.to_i
+            host, port = host_and_port(value)
 
             grab_cert(host,port)
           when /\Ahttps:/
-            uri = URI.parse(value)
-            host = uri.host
-            port = uri.port
+            host, port = host_and_port_from_url(value)
 
             grab_cert(host,port)
           else

data/lib/ronin/cli/commands/decode.rb

@@ -61,14 +61,14 @@ module Ronin
       class Decode < StringMethodsCommand
 
         option :base16, desc: 'Base16 decodes the data' do
-                          require 'ronin/support/encoding/base16'
-                          @method_calls << :base16_decode
-                        end
+          require 'ronin/support/encoding/base16'
+          @method_calls << :base16_decode
+        end
 
         option :base32, desc: 'Base32 decodes the data' do
-                          require 'ronin/support/encoding/base32'
-                          @method_calls << :base32_decode
-                        end
+          require 'ronin/support/encoding/base32'
+          @method_calls << :base32_decode
+        end
 
         option :base64, short: '-b',
                         equals: true,
@@ -78,11 +78,11 @@ module Ronin
                         },
                         desc: 'Base64 decodes the data' do |mode=nil|
                           require 'ronin/support/encoding/base64'
-                          if mode
-                            @method_calls << [:base64_decode, [mode]]
-                          else
-                            @method_calls << :base64_decode
-                          end
+                          @method_calls << if mode
+                                             [:base64_decode, [mode]]
+                                           else
+                                             :base64_decode
+                                           end
                         end
 
         option :zlib, short: '-z',
@@ -122,9 +122,9 @@ module Ronin
                      end
 
         option :http, desc: 'HTTP decodes the data' do
-                        require 'ronin/support/encoding/http'
-                        @method_calls << :http_decode
-                      end
+          require 'ronin/support/encoding/http'
+          @method_calls << :http_decode
+        end
 
         option :js, short: '-j',
                     desc: 'JavaScript decodes the data' do

data/lib/ronin/cli/commands/encode.rb

@@ -61,14 +61,14 @@ module Ronin
       class Encode < StringMethodsCommand
 
         option :base16, desc: 'Base16 encodes the data' do
-                          require 'ronin/support/encoding/base16'
-                          @method_calls << :base16_encode
-                        end
+          require 'ronin/support/encoding/base16'
+          @method_calls << :base16_encode
+        end
 
         option :base32, desc: 'Base32 encodes the data' do
-                          require 'ronin/support/encoding/base32'
-                          @method_calls << :base32_encode
-                        end
+          require 'ronin/support/encoding/base32'
+          @method_calls << :base32_encode
+        end
 
         option :base64, short: '-b',
                         equals: true,
@@ -78,11 +78,11 @@ module Ronin
                         },
                         desc: 'Base64 encodes the data' do |mode=nil|
                           require 'ronin/support/encoding/base64'
-                          if mode
-                            @method_calls << [:base64_encode, [mode]]
-                          else
-                            @method_calls << :base64_encode
-                          end
+                          @method_calls << if mode
+                                             [:base64_encode, [mode]]
+                                           else
+                                             :base64_encode
+                                           end
                         end
 
         option :zlib, short: '-z',
@@ -122,9 +122,9 @@ module Ronin
                      end
 
         option :http, desc: 'HTTP encodes the data' do
-                        require 'ronin/support/encoding/http'
-                        @method_calls << :http_encode
-                      end
+          require 'ronin/support/encoding/http'
+          @method_calls << :http_encode
+        end
 
         option :js, short: '-j',
                     desc: 'JavaScript encodes the data' do

data/lib/ronin/cli/commands/extract.rb

@@ -122,7 +122,7 @@ module Ronin
         def run(*files)
           unless @pattern
             print_error "must specify a pattern to search for"
-            exit -1
+            exit(-1)
           end
 
           super(*files)

data/lib/ronin/cli/commands/grep.rb

@@ -136,7 +136,7 @@ module Ronin
         def run(*files)
           unless @pattern
             print_error "must specify a pattern to search for"
-            exit -1
+            exit(-1)
           end
 
           super(*files)
@@ -151,8 +151,8 @@ module Ronin
         def process_input(input)
           filename = filename_of(input)
 
-          input.each_line(chomp: true).each_with_index do |line,index|
-            match_line(line, filename: filename, line_number: index+1)
+          input.each_line(chomp: true).with_index do |line,index|
+            match_line(line, filename: filename, line_number: index + 1)
           end
         end
 
@@ -184,7 +184,9 @@ module Ronin
         #
         def match_line(line,**kwargs)
           index = 0
+
           printed_prefix = false
+          only_matching  = options[:only_matching]
 
           while (match = line.match(@pattern,index))
             unless printed_prefix
@@ -195,13 +197,13 @@ module Ronin
             match_start, match_stop = match.offset(0)
 
             # print the text before the match, unless --only-matching is enabled
-            print(line[index...match_start]) unless options[:only_matching]
+            print(line[index...match_start]) unless only_matching
             print_match(match)
 
             index = match_stop
           end
 
-          unless options[:only_matching]
+          unless only_matching
             # print the rest of the line, if we've had at least one match
             puts(line[index..]) if index > 0
           end