ronin 1.5.1 → 2.0.0.beta1

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

@@ -0,0 +1,143 @@
+# 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/string_methods_command'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Encodes each character of data into a variety of encodings.
+      #
+      # ## Usage
+      #
+      #     ronin encode [options] [FILE ...]
+      #
+      # ## Options
+      #
+      #     -f, --file FILE                  Optional file to process
+      #         --string STRING              Optional string to process
+      #     -M, --multiline                  Process each line separately
+      #     -n, --keep-newlines              Preserves newlines at the end of each line
+      #         --base32                     Base32 encodes the data
+      #     -b, --base64=[strict|url]        Base64 encodes the data
+      #     -c, --c                          Encodes the data as a C string
+      #     -X, --hex                        Hex encode the data (ex: "414141...")
+      #     -H, --html                       HTML encodes the data
+      #     -u, --uri                        URI encodes the data
+      #         --http                       HTTP encodes the data
+      #     -j, --js                         JavaScript encodes the data
+      #     -S, --shell                      Encodes the data as a Shell String
+      #     -P, --powershell                 Encodes the data as a PowerShell String
+      #     -R, --ruby                       Encodes the data as a Ruby String
+      #     -x, --xml                        XML encodes the data
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Encode < StringMethodsCommand
+
+        option :base32, desc: 'Base32 encodes the data' do
+                          require 'ronin/support/encoding/base32'
+                          @method_calls << :base32_encode
+                        end
+
+        option :base64, short: '-b',
+                        equals: true,
+                        value: {
+                          type:     [:strict, :url],
+                          required: false
+                        },
+                        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
+                        end
+
+        option :c, short: '-c',
+                   desc: 'Encodes the data as a C string' do
+                     require 'ronin/support/encoding/c'
+                     @method_calls << :c_encode
+                   end
+
+        option :hex, short: '-X',
+                     desc: 'Hex encode the data (ex: "414141...")' do
+                       require 'ronin/support/encoding/hex'
+                       @method_calls << :hex_encode
+                     end
+
+        option :html, short: '-H',
+                      desc: 'HTML encodes the data' do
+                        require 'ronin/support/encoding/html'
+                        @method_calls << :html_encode
+                      end
+
+        option :uri, short: '-u',
+                     desc: 'URI encodes the data' do
+                       require 'ronin/support/encoding/uri'
+                       @method_calls << :uri_encode
+                     end
+
+        option :http, desc: 'HTTP encodes the data' do
+                        require 'ronin/support/encoding/http'
+                        @method_calls << :http_encode
+                      end
+
+        option :js, short: '-j',
+                    desc: 'JavaScript encodes the data' do
+                      require 'ronin/support/encoding/js'
+                      @method_calls << :js_encode
+                    end
+
+        option :shell, short: '-S',
+                       desc: 'Encodes the data as a Shell String' do
+                         require 'ronin/support/encoding/shell'
+                         @method_calls << :shell_encode
+                       end
+
+        option :powershell, short: '-P',
+                            desc: 'Encodes the data as a PowerShell String' do
+                              require 'ronin/support/encoding/powershell'
+                              @method_calls << :powershell_encode
+                            end
+
+        option :ruby, short: '-R',
+                      desc: 'Encodes the data as a Ruby String' do
+                        require 'ronin/support/encoding/ruby'
+                        @method_calls << :ruby_encode
+                      end
+
+        option :xml, short: '-x',
+                     desc: 'XML encodes the data' do
+                       require 'ronin/support/encoding/xml'
+                       @method_calls << :xml_encode
+                     end
+
+        description 'Encodes each character of data into a variety of encodings'
+
+        man_page 'ronin-encode.1'
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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/cipher_command'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Encrypts data.
+      #
+      # ## Usage
+      #
+      #     ronin encrypt [options] [FILE ...]
+      #
+      # ## Options
+      #
+      #     -k, --key STRING                 The key String
+      #     -K, --key-file FILE              The key file
+      #     -c, --cipher NAME                The cipher to encrypt with. See --list-ciphers (Default: aes-256-cbc)
+      #     -P, --password PASSWORD          The password to encrypt with
+      #     -H md5|sha1|sha256|sha512,       The hash algorithm to use for the password (Default: sha256)
+      #         --hash
+      #         --iv STRING                  Sets the Initial Vector (IV) value of the cipher
+      #         --padding NUM                Sets the padding of the encryption cipher
+      #     -b, --block-size NUM             The size in bytes to read data in (Default: 16384)
+      #         --list-ciphers               List all available ciphers
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       The file(s) to encrypt
+      #
+      class Encrypt < CipherCommand
+
+        description 'Encrypts data'
+
+        man_page 'ronin-encrypt.1'
+
+        #
+        # Creates a new encryption cipher.
+        #
+        # @return [Ronin::Support::Crypto::Cipher]
+        #
+        def cipher
+          super(direction: :encrypt)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# 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/support/text/patterns'
+require 'ronin/support/text/entropy'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Filters lines by their entropy.
+      #
+      # ## Usage
+      #
+      #     ronin entropy [options] [FILE ...]
+      #
+      # ## Options
+      #
+      #     -e, --entropy DEC                Minimum required entropy (Default: 4.0)
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Entropy < FileProcessorCommand
+
+        option :entropy, short: '-e',
+                         value: {
+                           type:    Float,
+                           default: 4.0
+                         },
+                         desc: 'Minimum required entropy'
+
+        description "Filters lines by their entropy"
+
+        man_page 'ronin-entropy.1'
+
+        #
+        # Filters the input stream for high-entropy strings.
+        #
+        # @param [IO, StringIO] input
+        #   The input stream to grep.
+        #
+        def process_input(input)
+          entropy = options[:entropy]
+
+          input.each_line(chomp: true) do |line|
+            if Support::Text::Entropy.calculate(line) > entropy
+              puts line
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# 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/string_methods_command'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Escapes each special character for a variety of encodings.
+      #
+      # ## Usage
+      #
+      #     ronin escape [options] [FILE ...]
+      #
+      # ## Options
+      #
+      #     -f, --file FILE                  Optional file to process
+      #         --string STRING              Optional string to process
+      #     -M, --multiline                  Process each line separately
+      #     -n, --keep-newlines              Preserves newlines at the end of each line
+      #     -c, --c                          Escapes the data as a C string
+      #     -X, --hex                        Escapes the data as a hex string (ex: ABC\x01\x02\x03...)
+      #     -H, --html                       HTML escapes the data
+      #     -u, --uri                        URI escapes the data
+      #         --http                       HTTP escapes the data
+      #     -j, --js                         JavaScript escapes the data
+      #     -S, --shell                      Escapes the data as a Shell String
+      #     -P, --powershell                 Escapes the data as a PowerShell String
+      #     -R, --ruby                       Escapes the data as a Ruby String
+      #     -x, --xml                        XML escapes the data
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Escape < StringMethodsCommand
+
+        option :c, short: '-c',
+                   desc: 'Escapes the data as a C string' do
+                     require 'ronin/support/encoding/c'
+                     @method_calls << :c_escape
+                   end
+
+        option :hex, short: '-X',
+                     desc: 'Escapes the data as a hex string (ex: "ABC\x01\x02\x03...")' do
+                       require 'ronin/support/encoding/hex'
+                       @method_calls << :hex_escape
+                     end
+
+        option :html, short: '-H',
+                      desc: 'HTML escapes the data' do
+                        require 'ronin/support/encoding/html'
+                        @method_calls << :html_escape
+                      end
+
+        option :uri, short: '-u',
+                     desc: 'URI escapes the data' do
+                       require 'ronin/support/encoding/uri'
+                       @method_calls << :uri_escape
+                     end
+
+        option :http, desc: 'HTTP escapes the data' do
+          require 'ronin/support/encoding/http'
+          @method_calls << :http_escape
+        end
+
+        option :js, short: '-j',
+                    desc: 'JavaScript escapes the data' do
+                      require 'ronin/support/encoding/js'
+                      @method_calls << :js_escape
+                    end
+
+        option :shell, short: '-S',
+                       desc: 'Escapes the data as a Shell String' do
+                         require 'ronin/support/encoding/shell'
+                         @method_calls << :shell_escape
+                       end
+
+        option :powershell, short: '-P',
+                            desc: 'Escapes the data as a PowerShell String' do
+                              require 'ronin/support/encoding/powershell'
+                              @method_calls << :powershell_escape
+                            end
+
+        option :ruby, short: '-R',
+                      desc: 'Escapes the data as a Ruby String' do
+                        require 'ronin/support/encoding/ruby'
+                        @method_calls << :ruby_escape
+                      end
+
+        option :xml, short: '-x',
+                     desc: 'XML escapes the data' do
+                       require 'ronin/support/encoding/xml'
+                       @method_calls << :xml_escape
+                     end
+
+        description 'Escapes each special character for a variety of encodings'
+
+        man_page 'ronin-escape.1'
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,138 @@
+# 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/pattern_options'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Extract common patterns from a file/stream.
+      #
+      # ## Usage
+      #
+      #     ronin extract [options] [FILE ...]
+      #
+      # ## Options
+      #
+      #     -N, --number                     Searches for all numbers
+      #     -X, --hex-number                 Searches for all hexadecimal numbers
+      #     -V, --version-number             Searches for all version numbers
+      #     -w, --word                       Searches for all words
+      #         --mac-addr                   Searches for all MAC addresses
+      #     -4, --ipv4-addr                  Searches for all IPv4 addresses
+      #     -6, --ipv6-addr                  Searches for all IPv6 addresses
+      #     -I, --ip                         Searches for all IP addresses
+      #     -H, --host                       Searches for all host names
+      #     -D, --domain                     Searches for all domain names
+      #         --uri                        Searches for all URIs
+      #     -U, --url                        Searches for all URLs
+      #         --user-name                  Searches for all user names
+      #     -E, --email-addr                 Searches for all email addresses
+      #         --obfuscated-email-addr      Searches for all obfuscated email addresses
+      #         --phone-number               Searches for all phone numbers
+      #         --ssn                        Searches for all Social Security Numbers (SSNs)
+      #         --amex-cc                    Searches for all AMEX Credit Card numbers
+      #         --discover-cc                Searches for all Discord Card numbers
+      #         --mastercard-cc              Searches for all MasterCard numbers
+      #         --visa-cc                    Searches for all VISA Credit Card numbers
+      #         --visa-mastercard-cc         Searches for all VISA MasterCard numbers
+      #         --cc                         Searches for all Credit Card numbers
+      #         --file-name                  Searches for all file names
+      #         --dir-name                   Searches for all directory names
+      #         --relative-unix-path         Searches for all relative UNIX paths
+      #         --absolute-unix-path         Searches for all absolute UNIX paths
+      #         --unix-path                  Searches for all UNIX paths
+      #         --relative-windows-path      Searches for all relative Windows paths
+      #         --absolute-windows-path      Searches for all absolute Windows paths
+      #         --windows-path               Searches for all Windows paths
+      #         --relative-path              Searches for all relative paths
+      #         --absolute-path              Searches for all absolute paths
+      #     -P, --path                       Searches for all paths
+      #         --variable-name              Searches for all variable names
+      #         --function-name              Searches for all function names
+      #         --md5                        Searches for all MD5 hashes
+      #         --sha1                       Searches for all SHA1 hashes
+      #         --sha256                     Searches for all SHA256 hashes
+      #         --sha512                     Searches for all SHA512 hashes
+      #         --hash                       Searches for all hashes
+      #         --ssh-private-key            Searches for all SSH private key data
+      #         --ssh-public-key             Searches for all SSH public key data
+      #     -K, --private-key                Searches for all private key data
+      #         --rsa-public-key             Searches for all RSA public key data
+      #         --dsa-public-key             Searches for all DSA public key data
+      #         --ec-public-key              Searches for all EC public key data
+      #         --public-key                 Searches for all public key data
+      #         --aws-access-key-id          Searches for all AWS access key IDs
+      #         --aws-secret-access-key      Searches for all AWS secret access key
+      #     -A, --api-key                    Secretes for all API keys
+      #         --single-quoted-string       Searches for all single-quoted strings
+      #         --double-quoted-string       Searches for all double-quoted strings
+      #     -S, --string                     Searches for all quoted strings
+      #     -B, --base64                     Searches for all Base64 strings
+      #     -e, --regexp /REGEXP/            Custom regular expression to search for
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional input file(s)
+      #
+      class Extract < FileProcessorCommand
+
+        include PatternOptions
+
+        usage '[options] [FILE ...]'
+
+        description 'Extracts common patterns from files/input'
+
+        man_page 'ronin-extract.1'
+
+        #
+        # Runs the `extract` sub-command.
+        #
+        # @param [Array<String>] files
+        #   Additional file arguments.
+        #
+        def run(*files)
+          unless @pattern
+            print_error "must specify a pattern to search for"
+            exit -1
+          end
+
+          super(*files)
+        end
+
+        #
+        # Extracts the pattern from the input stream.
+        #
+        # @param [IO, StringIO] input
+        #   The input stream to process.
+        #
+        def process_input(input)
+          input.each_line(chomp: true) do |line|
+            line.scan(@pattern) do |match|
+              puts match
+            end
+          end
+        end
+
+      end
+    end
+  end
+end