ronin 1.5.1 → 2.0.0.beta1

data/gemspec.yml

@@ -1,9 +1,7 @@
 name: ronin
-summary: A Ruby platform for vulnerability research and exploit development.
+summary: A Ruby toolkit for security research and development.
 description:
-  Ronin is a Ruby platform for vulnerability research and exploit development.
-  Ronin allows for the rapid development and distribution of code, Exploits
-  Payloads, Scanners, etc, via Repositories.
+  Ronin is a Ruby toolkit for security research and development.
 
 license: GPL-3.0
 authors: Postmodern
@@ -15,76 +13,94 @@ post_install_message: |
 
     Thank you for installing Ronin!
 
-    To start the Ronin Console:
-
-        $ ronin
-
     To list the available commands:
 
         $ ronin help
 
-    Additional functionality can be added to Ronin by installing additional
-    libraries:
+    To view help information about a command:
 
-        * ronin-gen
-        * ronin-web
-        * ronin-exploits
-        * ronin-scanners
+        $ ronin help COMMAND
 
   *************************************************************************
 
+metadata:
+  documentation_uri: https://rubydoc.info/gems/ronin
+  source_code_uri:   https://github.com/ronin-rb/ronin
+  bug_tracker_uri:   https://github.com/ronin-rb/ronin/issues
+  changelog_uri:     https://github.com/ronin-rb/ronin/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
 generated_files:
  - man/ronin.1
- - man/ronin-campaigns.1
- - man/ronin-console.1
- - man/ronin-creds.1
- - man/ronin-database.1
- - man/ronin-emails.1
- - man/ronin-exec.1
- - man/ronin-fuzzer.1
+ - man/ronin-asn.1
+ - man/ronin-banner-grab.1
+ - man/ronin-bitflip.1
+ - man/ronin-cert-dump.1
+ - man/ronin-cert-gen.1
+ - man/ronin-cert-grab.1
+ - man/ronin-decode.1
+ - man/ronin-decrypt.1
+ - man/ronin-dns.1
+ - man/ronin-email-addr.1
+ - man/ronin-encrypt.1
+ - man/ronin-encode.1
+ - man/ronin-entropy.1
+ - man/ronin-escape.1
+ - man/ronin-extract.1
+ - man/ronin-grep.1
  - man/ronin-help.1
- - man/ronin-hosts.1
- - man/ronin-install.1
- - man/ronin-ips.1
- - man/ronin-net-proxy.1
- - man/ronin-repos.1
- - man/ronin-uninstall.1
- - man/ronin-update.1
- - man/ronin-urls.1
- - man/ronin-wordlist.1
+ - man/ronin-hexdump.1
+ - man/ronin-highlight.1
+ - man/ronin-hmac.1
+ - man/ronin-homoglyph.1
+ - man/ronin-host.1
+ - man/ronin-http.1
+ - man/ronin-ip.1
+ - man/ronin-iprange.1
+ - man/ronin-irb.1
+ - man/ronin-md5.1
+ - man/ronin-netcat.1
+ - man/ronin-new.1
+ - man/ronin-new-project.1
+ - man/ronin-new-script.1
+ - man/ronin-proxy.1
+ - man/ronin-public-suffix-list.1
+ - man/ronin-quote.1
+ - man/ronin-rot.1
+ - man/ronin-sha1.1
+ - man/ronin-sha256.1
+ - man/ronin-sha512.1
+ - man/ronin-strings.1
+ - man/ronin-tld-list.1
+ - man/ronin-tips.1
+ - man/ronin-typo.1
+ - man/ronin-typosquat.1
+ - man/ronin-unescape.1
+ - man/ronin-unhexdump.1
+ - man/ronin-unquote.1
+ - man/ronin-url.1
+ - man/ronin-xor.1
 
-required_ruby_version: ">= 1.8.7"
+required_ruby_version: ">= 3.0.0"
 
 dependencies:
-  # DataMapper adapters:
-  dm-sqlite-adapter: ~> 1.2
-  # DataMapper dependencies:
-  dm-core: ~> 1.2
-  dm-types: ~> 1.2
-  dm-migrations: ~> 1.2
-  dm-validations: ~> 1.2
-  dm-serializer: ~> 1.2
-  dm-aggregates: ~> 1.2
-  dm-timestamps: ~> 1.2
-  # DataMapper plugins:
-  dm-is-predefined: ~> 0.4
   # Library dependencies:
-  uri-query_params: ~> 0.6
   open_namespace: ~> 0.4
-  data_paths: ~> 0.3
-  object_loader: ~> 1.0
-  parameters: ~> 0.4
-  pullr: ~> 0.1, >= 0.1.2
-  ripl: ~> 0.3
-  ripl-multi_line: ~> 0.2
-  ripl-auto_indent: ~> 0.1
-  ripl-short_errors: ~> 0.1
-  ripl-color_result: ~> 0.3
+  rouge: ~> 3.0
+  async-io: ~> 1.0
+  wordlist: ~> 1.0
   # Ronin dependencies:
-  ronin-support: ~> 0.5, >= 0.5.2
+  ronin-support: ~> 1.0.0.beta1
+  ronin-core: ~> 0.1.0.beta1
+  ronin-repos: ~> 0.1.0.beta1
+  ronin-db: ~> 0.1.0.beta1
+  ronin-fuzzer: ~> 0.1.0.beta1
+  ronin-web: ~> 1.0.0.beta1
+  ronin-code-asm: ~> 1.0.0.beta1
+  ronin-code-sql: ~> 2.0.0.beta1
+  ronin-payloads: ~> 0.1.0.beta1
+  ronin-exploits: ~> 1.0.0.beta1
+  ronin-vulns: ~> 0.1.0.beta1
 
 development_dependencies:
   bundler: ~> 2.0
-  yard: ~> 0.8
-  yard-dm: ~> 0.1
-  yard-dm-is-predefined: ~> 0.2

data/lib/ronin/cli/char_set_options.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# Ronin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'chars'
+
+module Ronin
+  class CLI
+    #
+    # Adds common character set options to a command.
+    #
+    # ## Options
+    #     -N, --numeric                    Searches for numeric characters (0-9)
+    #     -O, --octal                      Searches for octal characters (0-7)
+    #     -X, --upper-hex                  Searches for uppercase hexadecimal (0-9, A-F)
+    #     -x, --lower-hex                  Searches for lowercase hexadecimal (0-9, a-f)
+    #     -H, --hex                        Searches for hexadecimal chars (0-9, a-f, A-F)
+    #         --upper-alpha                Searches for uppercase alpha chars (A-Z)
+    #         --lower-alpha                Searches for lowercase alpha chars (a-z)
+    #     -A, --alpha                      Searches for alpha chars (a-z, A-Z)
+    #         --alpha-num                  Searches for alpha-numeric chars (a-z, A-Z, 0-9)
+    #     -P, --punct                      Searches for punctuation chars
+    #     -S, --symbols                    Searches for symbolic chars
+    #     -s, --space                      Searches for all whitespace chars
+    #     -v, --visible                    Searches for all visible chars
+    #     -p, --printable                  Searches for all printable chars
+    #     -C, --control                    Searches for all control chars (\x00-\x1f, \x7f)
+    #     -a, --signed-ascii               Searches for all signed ASCII chars (\x00-\x7f)
+    #         --ascii                      Searches for all ASCII chars (\x00-\xff)
+    #     -c, --chars CHARS                Searches for all chars in the custom char-set
+    #     -i, --include-chars CHARS        Include the additional chars to the char-set
+    #     -e, --exclude-chars CHARS        Exclude the additional chars from the char-set
+    #
+    module CharSetOptions
+      #
+      # Adds common character set options to the command.
+      #
+      # @param [Class<Command>] command
+      #   The command including {CharSetOptions}.
+      #
+      def self.included(command)
+        command.option :numeric, short: '-N',
+                         desc: 'Searches for numeric characters (0-9)' do
+                           @char_set = Chars::NUMERIC
+                         end
+
+        command.option :octal, short: '-O',
+                       desc: 'Searches for octal characters (0-7)' do
+                         @char_set = Chars::OCTAL
+                       end
+
+        command.option :upper_hex, short: '-X',
+                           desc: 'Searches for uppercase hexadecimal (0-9, A-F)' do
+                             @char_set = Chars::UPPERCASE_HEXADECIMAL
+                           end
+
+        command.option :lower_hex, short: '-x',
+                           desc: 'Searches for lowercase hexadecimal (0-9, a-f)' do
+                             @char_set = Chars::LOWERCASE_HEXADECIMAL
+                           end
+
+        command.option :hex, short: '-H',
+                     desc: 'Searches for hexadecimal chars (0-9, a-f, A-F)' do
+                       @char_set = Chars::HEXADECIMAL
+                     end
+
+        command.option :upper_alpha, desc: 'Searches for uppercase alpha chars (A-Z)' do
+          @char_set = Chars::UPPERCASE_ALPHA
+        end
+
+        command.option :lower_alpha, desc: 'Searches for lowercase alpha chars (a-z)' do
+          @char_set = Chars::LOWERCASE_ALPHA
+        end
+
+        command.option :alpha, short: '-A',
+                       desc: 'Searches for alpha chars (a-z, A-Z)' do
+                         @char_set = Chars::ALPHA
+                       end
+
+        command.option :alpha_num, desc: 'Searches for alpha-numeric chars (a-z, A-Z, 0-9)' do
+          @char_set = Chars::ALPHA_NUMERIC
+        end
+
+        command.option :punct, short: '-P',
+                       desc: 'Searches for punctuation chars' do
+                         @char_set = Chars::PUNCTUATION
+                       end
+
+        command.option :symbols, short: '-S',
+                         desc: 'Searches for symbolic chars' do
+                           @char_set = Chars::SYMBOLS
+                         end
+
+        command.option :space, short: '-s',
+                       desc: 'Searches for all whitespace chars' do
+                         @char_set = Chars::SPACE
+                       end
+
+        command.option :visible, short: '-v',
+                         desc: 'Searches for all visible chars' do
+          @char_set = Chars::VISIBLE
+        end
+
+        command.option :printable, short: '-p',
+                           desc: 'Searches for all printable chars' do
+                             @char_set = Chars::PRINTABLE
+                           end
+
+        command.option :control, short: '-C',
+                         desc: 'Searches for all control chars (\x00-\x1f, \x7f)' do
+                           @char_set = Chars::CONTROL
+                         end
+
+        command.option :signed_ascii, short: '-a',
+                              desc: 'Searches for all signed ASCII chars (\x00-\x7f)' do
+                                @char_set = Chars::SIGNED_ASCII
+                              end
+
+        command.option :ascii, desc: 'Searches for all ASCII chars (\x00-\xff)' do
+                         @char_set = Chars::ASCII
+                       end
+
+        command.option :chars, short: '-c',
+                        value: {
+                          type:  String,
+                          usage: 'CHARS'
+                        },
+                        desc: 'Searches for all chars in the custom char-set' do |string|
+                          @char_set = Chars::CharSet.new(*string.chars)
+                        end
+
+        command.option :include_chars, short: '-i',
+                               value: {
+                                 type: String,
+                                 usage: 'CHARS',
+                               },
+                               desc: 'Include the additional chars to the char-set' do |string|
+                                 @char_set += Chars::CharSet.new(*string.chars)
+                               end
+
+        command.option :exclude_chars, short: '-e',
+                               value: {
+                                 type:  String,
+                                 usage: 'CHARS'
+                               },
+                               desc: 'Exclude the additional chars from the char-set' do |string|
+                                 @char_set -= Chars::CharSet.new(*string.chars)
+                               end
+      end
+
+      # The set character set.
+      attr_reader :char_set
+
+      #
+      # Initializes the command.
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      def initialize(**kwargs)
+        super(**kwargs)
+
+        @char_set = Chars::VISIBLE
+      end
+    end
+  end
+end

data/lib/ronin/cli/cipher_command.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# Ronin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/cli/file_processor_command'
+require 'ronin/cli/key_options'
+
+require 'ronin/support/crypto/cipher'
+
+module Ronin
+  class CLI
+    module Commands
+      class CipherCommand < FileProcessorCommand
+
+        include KeyOptions
+
+        option :cipher, short: '-c',
+                        value: {
+                          type:    String,
+                          usage:   'NAME',
+                          default: 'aes-256-cbc'
+                        },
+                        desc: 'The cipher to use. See --list-ciphers'
+
+        option :password, short: '-P',
+                          value: {
+                            type:  String,
+                            usage: 'PASSWORD'
+                          },
+                          desc: 'The password for the cipher'
+
+        option :hash, short: '-H',
+                      value: {
+                        type:    [:md5, :sha1, :sha256, :sha512],
+                        default: :sha256
+                      },
+                      desc: 'The hash algorithm to use for the password'
+
+        option :iv, value: {
+                      type:  String,
+                      usage: 'STRING'
+                    },
+                    desc: 'Sets the Initial Vector (IV) value of the cipher'
+
+        option :padding, value: {
+                           type:  Integer,
+                           usage: 'NUM'
+                         },
+                         desc: 'Sets the padding of the cipher'
+
+        option :block_size, short: '-b',
+                            value: {
+                              type:    Integer,
+                              usage:   'NUM',
+                              default: 16384
+                            },
+                            desc: 'The size in bytes to read data in'
+
+        option :list_ciphers, desc: 'List the supported ciphers'
+
+        #
+        # Runs the `ronin encrypt` command.
+        #
+        # @param [Array<String>] files
+        #   Optional files to encrypt.
+        #
+        def run(*files)
+          if options[:list_ciphers]
+            puts Support::Crypto::Cipher.supported
+            return
+          end
+
+          unless (options[:key] || options[:key_file] || options[:password])
+            print_error "must specify --password, --key, or --key-file"
+            exit(1)
+          end
+
+          super(*files)
+        end
+
+        #
+        # Opens the file in binary mode.
+        #
+        # @param [Stirng] path
+        #   The path to the file to open.
+        #
+        # @yield [file]
+        #   If a block is given, the newly opened file will be yielded.
+        #   Once the block returns the file will automatically be closed.
+        #
+        # @yieldparam [File] file
+        #   The newly opened file.
+        #
+        # @return [File, nil]
+        #   If no block is given, the newly opened file object will be returned.
+        #   If no block was given, then `nil` will be returned.
+        #
+        def open_file(path,&block)
+          super(path,'rb',&block)
+        end
+
+        #
+        # Initializes a new cipher.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for
+        #   `Ronin::Support::Crypto::Cipher#initialize`.
+        #
+        # @return [Ronin::Support::Crypto::Cipher]
+        #   The new cipher object.
+        #
+        def cipher(**kwargs)
+          Support::Crypto::Cipher.new(
+            options[:cipher], key:       @key,
+                              hash:      options[:hash],
+                              password:  options[:password],
+                              **kwargs
+          )
+        end
+
+        #
+        # Decrypts the input stream.
+        #
+        # @param [IO, StringIO] input
+        #   The input stream to decrypt.
+        #
+        def process_input(input)
+          cipher.stream(input, block_size: @block_size, output: stdout)
+        end
+
+
+      end
+    end
+  end
+end

data/lib/ronin/{script/exceptions/build_failed.rb → cli/command.rb}

@@ -1,7 +1,6 @@
+# frozen_string_literal: true
 #
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # Ronin is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -17,11 +16,17 @@
 # along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/script/exceptions/exception'
+require 'ronin/core/cli/command'
+require 'ronin/root'
 
 module Ronin
-  module Script
-    class BuildFailed < Exception
+  class CLI
+    class Command < Core::CLI::Command
+
+      man_dir File.join(ROOT,'man')
+
+      bug_report_url 'https://github.com/ronin-rb/ronin/issues/new'
+
     end
   end
 end