ronin 2.0.0.beta1 → 2.0.0.beta2

data/lib/ronin/cli/pattern_options.rb

@@ -43,7 +43,7 @@ module Ronin
     #         --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
+    #         --discover-cc                Searches for all Discover 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
@@ -74,8 +74,8 @@ module Ronin
     #         --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
+    #         --aws-secret-access-key      Searches for all AWS secret access keys
+    #     -A, --api-key                    Searches 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
@@ -92,76 +92,124 @@ module Ronin
       #   The command including {PatternOptions}.
       #
       def self.included(command)
+        define_numeric_options(command)
+        define_language_options(command)
+        define_network_options(command)
+        define_pii_options(command)
+        define_file_system_options(command)
+        define_source_code_options(command)
+        define_crypto_options(command)
+        define_credentials_options(command)
+
+        command.option :regexp, short: '-e',
+                        value: {type: Regexp},
+                        desc: 'Custom regular expression to search for' do |regexp|
+                          @pattern = regexp
+                        end
+      end
+
+      #
+      # Defines numeric pattern options.
+      #
+      # @param [Class<Command>] command
+      #   The command including {PatternOptions}.
+      #
+      def self.define_numeric_options(command)
         command.option :number, short: '-N',
-                         desc: 'Searches for all numbers' do
-                           @pattern = NUMBER
-                         end
+                                desc: 'Searches for all numbers' do
+                                  @pattern = NUMBER
+                                end
 
         command.option :hex_number, short: '-X',
-                             desc: 'Searches for all hexadecimal numbers' do
-                               @pattern = NUMBER
-                             end
+                                    desc: 'Searches for all hexadecimal numbers' do
+                                      @pattern = HEX_NUMBER
+                                    end
 
         command.option :version_number, short: '-V',
                                         desc: 'Searches for all version numbers' do
                                           @pattern = VERSION_NUMBER
                                         end
 
+      end
+
+      #
+      # Defines language pattern options.
+      #
+      # @param [Class<Command>] command
+      #   The command including {PatternOptions}.
+      #
+      def self.define_language_options(command)
         command.option :word, short: '-w',
-                       desc: 'Searches for all words' do
-                         @pattern = WORD
-                       end
+                              desc: 'Searches for all words' do
+                                @pattern = WORD
+                              end
+      end
 
+      #
+      # Defines network pattern options.
+      #
+      # @param [Class<Command>] command
+      #   The command including {PatternOptions}.
+      #
+      def self.define_network_options(command)
         command.option :mac_addr, desc: 'Searches for all MAC addresses' do
           @pattern = MAC_ADDR
         end
 
         command.option :ipv4_addr, short: '-4',
-                            desc: 'Searches for all IPv4 addresses' do
-                              @pattern = IPV4_ADDR
-                            end
+                                   desc: 'Searches for all IPv4 addresses' do
+                                     @pattern = IPV4_ADDR
+                                   end
 
         command.option :ipv6_addr, short: '-6',
-                            desc: 'Searches for all IPv6 addresses' do
-                              @pattern = IPV6_ADDR
-                            end
+                                   desc: 'Searches for all IPv6 addresses' do
+                                     @pattern = IPV6_ADDR
+                                   end
 
         command.option :ip, short: '-I',
-                     desc: 'Searches for all IP addresses' do
-                       @pattern = IP
-                     end
+                            desc: 'Searches for all IP addresses' do
+                              @pattern = IP
+                            end
 
         command.option :host, short: '-H',
-                       desc: 'Searches for all host names' do
-                         @pattern = HOST_NAME
-                       end
+                              desc: 'Searches for all host names' do
+                                @pattern = HOST_NAME
+                              end
 
         command.option :domain, short: '-D',
-                         desc: 'Searches for all domain names' do
-                           @pattern = DOMAIN
-                         end
+                                desc: 'Searches for all domain names' do
+                                  @pattern = DOMAIN
+                                end
 
         command.option :uri, desc: 'Searches for all URIs' do
                                @pattern = URI
                              end
 
         command.option :url, short: '-U',
-                      desc: 'Searches for all URLs' do
-                        @pattern = URL
-                      end
+                             desc: 'Searches for all URLs' do
+                               @pattern = URL
+                            end
+      end
 
+      #
+      # Defines PII pattern options.
+      #
+      # @param [Class<Command>] command
+      #   The command including {PatternOptions}.
+      #
+      def self.define_pii_options(command)
         command.option :user_name, desc: 'Searches for all user names' do
           @pattern = USER_NAME
         end
 
         command.option :email_addr, short: '-E',
-                             desc: 'Searches for all email addresses' do
-                               @pattern = EMAIL_ADDRESS
-                             end
+                                    desc: 'Searches for all email addresses' do
+                                      @pattern = EMAIL_ADDRESS
+                                    end
 
         command.option :obfuscated_email_addr, desc: 'Searches for all obfuscated email addresses' do
-                               @pattern = OBFUSCATED_EMAIL_ADDRESS
-                             end
+          @pattern = OBFUSCATED_EMAIL_ADDRESS
+        end
 
         command.option :phone_number, desc: 'Searches for all phone numbers' do
           @pattern = PHONE_NUMBER
@@ -175,7 +223,7 @@ module Ronin
           @pattern = AMEX_CC
         end
 
-        command.option :discover_cc, desc: 'Searches for all Discord Card numbers' do
+        command.option :discover_cc, desc: 'Searches for all Discover Card numbers' do
           @pattern = DISCOVER_CC
         end
 
@@ -194,7 +242,15 @@ module Ronin
         command.option :cc, desc: 'Searches for all Credit Card numbers' do
           @pattern = CC
         end
+      end
 
+      #
+      # Defines File System pattern options.
+      #
+      # @param [Class<Command>] command
+      #   The command including {PatternOptions}.
+      #
+      def self.define_file_system_options(command)
         command.option :file_name, desc: 'Searches for all file names' do
           @pattern = FILE_NAME
         end
@@ -232,22 +288,96 @@ module Ronin
         end
 
         command.option :absolute_path, desc: 'Searches for all absolute paths' do
-          @pattern = ABSOLUTE_PATHS
+          @pattern = ABSOLUTE_PATH
         end
 
         command.option :path, short: '-P',
-                      desc: 'Searches for all paths' do
-                        @pattern = PATH
-                      end
+                              desc: 'Searches for all paths' do
+                                @pattern = PATH
+                              end
+      end
+
+      #
+      # Defines source code pattern options.
+      #
+      # @param [Class<Command>] command
+      #   The command including {PatternOptions}.
+      #
+      def self.define_source_code_options(command)
+        command.option :identifier, desc: 'Searches for all identifier names' do
+          @pattern = IDENTIFIER
+        end
 
         command.option :variable_name, desc: 'Searches for all variable names' do
           @pattern = VARIABLE_NAME
         end
 
+        command.option :variable_assignment, desc: 'Searches for all variable assignments' do
+          @pattern = VARIABLE_ASSIGNMENT
+        end
+
         command.option :function_name, desc: 'Searches for all function names' do
           @pattern = FUNCTION_NAME
         end
 
+        command.option :single_quoted_string,  desc: 'Searches for all single-quoted strings' do
+          @pattern = SINGLE_QUOTED_STRING
+        end
+
+        command.option :double_quoted_string,  desc: 'Searches for all double-quoted strings' do
+          @pattern = DOUBLE_QUOTED_STRING
+        end
+
+        command.option :string, short: '-S',
+                                desc: 'Searches for all quoted strings' do
+                                  @pattern = STRING
+                                end
+
+        command.option :base64, short: '-B',
+                                desc: 'Searches for all Base64 strings' do
+                                  @pattern = BASE64
+                                end
+
+        command.option :c_comment, desc: 'Searches for all C comments' do
+          @pattern = C_COMMENT
+        end
+
+        command.option :cpp_comment, desc: 'Searches for all C++ comments' do
+          @pattern = CPP_COMMENT
+        end
+
+        command.option :java_comment, desc: 'Searches for all Java comments' do
+          @pattern = JAVA_COMMENT
+        end
+
+        command.option :javascript_comment, desc: 'Searches for all JavaScript comments' do
+          @pattern = JAVASCRIPT_COMMENT
+        end
+
+        command.option :shell_comment, desc: 'Searches for all Shell comments' do
+          @pattern = SHELL_COMMENT
+        end
+
+        command.option :ruby_comment, desc: 'Searches for all Ruby comments' do
+          @pattern = RUBY_COMMENT
+        end
+
+        command.option :python_comment, desc: 'Searches for all Python comments' do
+          @pattern = PYTHON_COMMENT
+        end
+
+        command.option :comment, desc: 'Searches for all comments' do
+          @pattern = COMMENT
+        end
+      end
+
+      #
+      # Defines cryptographic pattern options.
+      #
+      # @param [Class<Command>] command
+      #   The command including {PatternOptions}.
+      #
+      def self.define_crypto_options(command)
         command.option :md5, desc: 'Searches for all MD5 hashes' do
           @pattern = MD5
         end
@@ -268,76 +398,61 @@ module Ronin
           @pattern = HASH
         end
 
-        command.option :ssh_private_key, desc: 'Searches for all SSH private key data' do
-          @pattern = SSH_PRIVATE_KEY
-        end
-
         command.option :ssh_public_key, desc: 'Searches for all SSH public key data' do
           @pattern = SSH_PUBLIC_KEY
         end
 
-        command.option :private_key, short: '-K',
-                                     desc: 'Searches for all private key data' do
-                                       @pattern = PRIVATE_KEY
-                                     end
-
-        command.option :rsa_public_key, desc: 'Searches for all RSA public key data' do
-          @pattern = RSA_PUBLIC_KEY
+        command.option :public_key, desc: 'Searches for all public key data' do
+          @pattern = PUBLIC_KEY
         end
+      end
 
-        command.option :dsa_public_key, desc: 'Searches for all DSA public key data' do
-          @pattern = DSA_PUBLIC_KEY
+      #
+      # Defines credentials pattern options.
+      #
+      # @param [Class<Command>] command
+      #   The command including {PatternOptions}.
+      #
+      def self.define_credentials_options(command)
+        command.option :ssh_private_key, desc: 'Searches for all SSH private key data' do
+          @pattern = SSH_PRIVATE_KEY
         end
 
-        command.option :ec_public_key, desc: 'Searches for all EC public key data' do
-          @pattern = EC_PUBLIC_KEY
+        command.option :dsa_private_key, desc: 'Searches for all DSA private key data' do
+          @pattern = DSA_PRIVATE_KEY
         end
 
-        command.option :ssh_public_key, desc: 'Searches for all SSH public key data' do
-          @pattern = SSH_PUBLIC_KEY
+        command.option :ec_private_key, desc: 'Searches for all EC private key data' do
+          @pattern = EC_PRIVATE_KEY
         end
 
-        command.option :public_key, desc: 'Searches for all public key data' do
-          @pattern = PUBLIC_KEY
+        command.option :rsa_private_key, desc: 'Searches for all RSA private key data' do
+          @pattern = RSA_PRIVATE_KEY
         end
 
+        command.option :private_key, short: '-K',
+                                     desc: 'Searches for all private key data' do
+                                       @pattern = PRIVATE_KEY
+                                     end
+
         command.option :aws_access_key_id, desc: 'Searches for all AWS access key IDs' do
           @pattern = AWS_ACCESS_KEY_ID
         end
 
-        command.option :aws_secret_access_key, desc: 'Searches for all AWS secret access key' do
+        command.option :aws_secret_access_key, desc: 'Searches for all AWS secret access keys' do
           @pattern = AWS_SECRET_ACCESS_KEY
         end
 
         command.option :api_key, short: '-A',
-                                 desc: 'Secretes for all API keys' do
+                                 desc: 'Searches for all API keys' do
                                    @pattern = API_KEY
                                  end
-
-        command.option :single_quoted_string,  desc: 'Searches for all single-quoted strings' do
-          @pattern = SINGLE_QUOTED_STRING
-        end
-
-        command.option :double_quoted_string,  desc: 'Searches for all double-quoted strings' do
-          @pattern = DOUBLE_QUOTED_STRING
-        end
-
-        command.option :string, short: '-S',
-                         desc: 'Searches for all quoted strings' do
-                           @pattern = STRING
-                         end
-
-        command.option :base64, short: '-B',
-                        desc: 'Searches for all Base64 strings' do
-                          @pattern = BASE64
-                        end
-
-        command.option :regexp, short: '-e',
-                        value: {type: Regexp},
-                        desc: 'Custom regular expression to search for' do |regexp|
-                          @pattern = regexp
-                        end
       end
+
+      # The pattern to search for.
+      #
+      # @return [Regexp, nil]
+      attr_reader :pattern
     end
   end
 end

data/lib/ronin/cli.rb

@@ -16,8 +16,11 @@
 # along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+require 'ronin/version'
+
 require 'command_kit/commands'
 require 'command_kit/commands/auto_load'
+require 'command_kit/options/version'
 
 module Ronin
   #
@@ -34,8 +37,10 @@ module Ronin
       dir:       "#{__dir__}/cli/commands",
       namespace: "#{self}::Commands"
     )
+    include CommandKit::Options::Version
 
     command_name 'ronin'
+    version Ronin::VERSION
 
     command_aliases['enc'] = 'encode'
     command_aliases['dec'] = 'decode'

data/lib/ronin/version.rb

@@ -18,5 +18,5 @@
 
 module Ronin
   # ronin version 
-  VERSION = '2.0.0.beta1'
+  VERSION = '2.0.0.beta2'
 end

data/man/ronin-extract.1

@@ -95,7 +95,7 @@ Searches for all AMEX Credit Card numbers\.
 .LP
 .TP
 \fB--discover-cc\fR
-Searches for all Discord Card numbers\.
+Searches for all Discover Card numbers\.
 .LP
 .TP
 \fB--mastercard-cc\fR
@@ -158,10 +158,18 @@ Searches for all absolute paths\.
 Searches for all paths\.
 .LP
 .TP
+\fB--identifier\fR
+Searches for all identifier names\.
+.LP
+.TP
 \fB--variable-name\fR
 Searches for all variable names\.
 .LP
 .TP
+\fB--variable-assignment\fR
+Searches for all variable assignments\.
+.LP
+.TP
 \fB--function-name\fR
 Searches for all function names\.
 .LP
@@ -190,24 +198,24 @@ Searches for all hashes\.
 Searches for all SSH private key data\.
 .LP
 .TP
-\fB--ssh-public-key\fR
-Searches for all SSH public key data\.
+\fB--dsa-private-key\fR
+Searches for all DSA private key data\.
 .LP
 .TP
-\fB-K\fR, \fB--private-key\fR
-Searches for all private key data\.
+\fB--ec-private-key\fR
+Searches for all EC private key data\.
 .LP
 .TP
-\fB--rsa-public-key\fR
-Searches for all RSA public key data\.
+\fB--rsa-private-key\fR
+Searches for all RSA private key data\.
 .LP
 .TP
-\fB--dsa-public-key\fR
-Searches for all DSA public key data\.
+\fB-K\fR, \fB--private-key\fR
+Searches for all private key data\.
 .LP
 .TP
-\fB--ec-public-key\fR
-Searches for all EC public key data\.
+\fB--ssh-public-key\fR
+Searches for all SSH public key data\.
 .LP
 .TP
 \fB--public-key\fR
@@ -219,7 +227,7 @@ Searches for all AWS access key IDs\.
 .LP
 .TP
 \fB--aws-secret-access-key\fR
-Searches for all AWS secret access key\.
+Searches for all AWS secret access keys\.
 .LP
 .TP
 \fB-A\fR, \fB--api-key\fR
@@ -242,6 +250,38 @@ Searches for all quoted strings\.
 \fB-B\fR, \fB--base64\fR
 Searches for all Base64 strings\.
 .LP
+.TP
+\fB--c-comment\fR
+Searches for all C comments\.
+.LP
+.TP
+\fB--cpp-comment\fR
+Searches for all C\[pl]\[pl] comments\.
+.LP
+.TP
+\fB--java-comment\fR
+Searches for all Java comments\.
+.LP
+.TP
+\fB--javascript-comment\fR
+Searches for all JavaScript comments\.
+.LP
+.TP
+\fB--shell-comment\fR
+Searches for all Shell comments\.
+.LP
+.TP
+\fB--ruby-comment\fR
+Searches for all Ruby comments\.
+.LP
+.TP
+\fB--python-comment\fR
+Searches for all Python comments\.
+.LP
+.TP
+\fB--comment\fR
+Searches for all comments\.
+.LP
 .HP
 \fB-e\fR, \fB--regexp\fR \[sl]\fIREGEXP\fP\[sl]
 Custom regular expression to search for\.

data/man/ronin-extract.1.md

@@ -71,7 +71,7 @@ Extract common patterns in the given file(s) or input stream.
   Searches for all AMEX Credit Card numbers.
 
 `--discover-cc`
-  Searches for all Discord Card numbers.
+  Searches for all Discover Card numbers.
 
 `--mastercard-cc`
   Searches for all MasterCard numbers.
@@ -118,9 +118,15 @@ Extract common patterns in the given file(s) or input stream.
 `-P`, `--path`
   Searches for all paths.
 
+`--identifier`
+  Searches for all identifier names.
+
 `--variable-name`
   Searches for all variable names.
 
+`--variable-assignment`
+  Searches for all variable assignments.
+
 `--function-name`
   Searches for all function names.
 
@@ -142,20 +148,20 @@ Extract common patterns in the given file(s) or input stream.
 `--ssh-private-key`
   Searches for all SSH private key data.
 
-`--ssh-public-key`
-  Searches for all SSH public key data.
+`--dsa-private-key`
+  Searches for all DSA private key data.
 
-`-K`, `--private-key`
-  Searches for all private key data.
+`--ec-private-key`
+  Searches for all EC private key data.
 
-`--rsa-public-key`
-  Searches for all RSA public key data.
+`--rsa-private-key`
+  Searches for all RSA private key data.
 
-`--dsa-public-key`
-  Searches for all DSA public key data.
+`-K`, `--private-key`
+  Searches for all private key data.
 
-`--ec-public-key`
-  Searches for all EC public key data.
+`--ssh-public-key`
+  Searches for all SSH public key data.
 
 `--public-key`
   Searches for all public key data.
@@ -164,7 +170,7 @@ Extract common patterns in the given file(s) or input stream.
   Searches for all AWS access key IDs.
 
 `--aws-secret-access-key`
-  Searches for all AWS secret access key.
+  Searches for all AWS secret access keys.
 
 `-A`, `--api-key`
   Searches for all API keys (MD5, SHA1, SHA256, SHA512, AWS access key ID, or
@@ -182,6 +188,30 @@ Extract common patterns in the given file(s) or input stream.
 `-B`, `--base64`
   Searches for all Base64 strings.
 
+`--c-comment`
+  Searches for all C comments.
+
+`--cpp-comment`
+  Searches for all C++ comments.
+
+`--java-comment`
+  Searches for all Java comments.
+
+`--javascript-comment`
+  Searches for all JavaScript comments.
+
+`--shell-comment`
+  Searches for all Shell comments.
+
+`--ruby-comment`
+  Searches for all Ruby comments.
+
+`--python-comment`
+  Searches for all Python comments.
+
+`--comment`
+  Searches for all comments.
+
 `-e`, `--regexp` /*REGEXP*/
   Custom regular expression to search for.