ronin-exploits 1.0.0 → 1.0.1

data/lib/ronin/exploits/lfi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -32,17 +33,17 @@ module Ronin
     # ## Example
     #
     #     require 'ronin/exploits/lfi'
-    #     
+    #
     #     module Ronin
     #       module Exploits
     #         class MyExploit < LFI
-    #     
+    #
     #           register 'my_exploit'
-    #    
+    #
     #           base_path '/path/to/page.php'
     #           query_param 'template'
     #           depth 7
-    #    
+    #
     #         end
     #       end
     #     end
@@ -66,8 +67,7 @@ module Ronin
                               :base64,
                               :rot13,
                               :zlib
-                            ],
-                            desc: 'Optional filter-bypass strategy to use'
+                            ], desc: 'Optional filter-bypass strategy to use'
 
       #
       # Gets or sets the directory traversal depth for the LFI vulnerability.

data/lib/ronin/exploits/loot/file.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -81,7 +82,7 @@ module Ronin
           case @format
           when :json then JSON.pretty_generate(@contents)
           when :yaml then YAML.dump(@contents)
-          when :csv 
+          when :csv
             CSV.generate do |csv|
               @contents.each do |row|
                 csv << row

data/lib/ronin/exploits/loot.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/memory_corruption.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/metadata/arch.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -38,6 +39,9 @@ module Ronin
           exploit.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the exploit's targeted architecture.

data/lib/ronin/exploits/metadata/cookie_param.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -38,6 +39,9 @@ module Ronin
           exploit.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Get or sets the target Cookie param of the exploit.

data/lib/ronin/exploits/metadata/default_filename.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -38,6 +39,9 @@ module Ronin
           exploit.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the exploit's default filename.

data/lib/ronin/exploits/metadata/default_port.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -38,6 +39,9 @@ module Ronin
           exploit.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the exploit's default port.

data/lib/ronin/exploits/metadata/header_name.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -38,6 +39,9 @@ module Ronin
           exploit.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Get or sets the target HTTP Header name of the exploit.

data/lib/ronin/exploits/metadata/os.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -39,6 +40,9 @@ module Ronin
           exploit.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the exploit's targeted Operating System (OS).

data/lib/ronin/exploits/metadata/shouts.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -28,13 +29,13 @@ module Ronin
       # ### Example
       #
       #     require 'ronin/exploits/metadata/shouts'
-      #     
+      #
       #     class MyExploit < Exploit
-      #     
+      #
       #       include Metadata::Shouts
-      #     
+      #
       #       shouts ['Ultra Laser', 'Dr.Doom']
-      #     
+      #
       #     end
       #
       module Shouts
@@ -50,6 +51,9 @@ module Ronin
           base.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Gets or sets the exploit's shouts.
@@ -69,13 +73,17 @@ module Ronin
           #
           def shouts(new_shouts=nil)
             if new_shouts
-              @shouts = shouts() + new_shouts
+              @shouts = if superclass.kind_of?(ClassMethods)
+                          superclass.shouts + new_shouts
+                        else
+                          new_shouts
+                        end
             else
               @shouts || if superclass.kind_of?(ClassMethods)
-                               superclass.shouts
-                             else
-                               []
-                             end
+                           superclass.shouts
+                         else
+                           []
+                         end
             end
           end
         end

data/lib/ronin/exploits/metadata/url_path.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -38,6 +39,9 @@ module Ronin
           exploit.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Get or sets the target URL path of the exploit.

data/lib/ronin/exploits/metadata/url_query_param.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -38,6 +39,9 @@ module Ronin
           exploit.extend ClassMethods
         end
 
+        #
+        # Class-methods.
+        #
         module ClassMethods
           #
           # Get or sets the target URL query param of the exploit.

data/lib/ronin/exploits/mixins/binary.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/mixins/file_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -37,13 +38,13 @@ module Ronin
       #
       #     def build
       #       # ...
-      #     
+      #
       #       build_file do |file|
       #         # ...
       #         file.write(buffer)
       #         # ...
       #       end
-      #     
+      #
       #       # ...
       #     end
       #

data/lib/ronin/exploits/mixins/format_string.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -56,7 +57,7 @@ module Ronin
 
           buffer = String.new(encoding: Encoding::ASCII_8BIT)
           buffer << pack(:machine_word,overwrite)
-          buffer << pack(:machine_word,overwrite + (machine_word.size  / 2))
+          buffer << pack(:machine_word,overwrite + (machine_word.size / 2))
 
           low_mask = 0xff
 
@@ -72,10 +73,10 @@ module Ronin
 
           if low < high
             low    -= (machine_word.size * 2)
-            buffer << format("%%.%ud%%%u$hn%%.%ud%%%u$hn",low,pop_length,high-low,pop_length+1)
+            buffer << format("%%.%ud%%%u$hn%%.%ud%%%u$hn",low,pop_length,high - low,pop_length + 1)
           else
             high   -= (machine_word.size * 2)
-            buffer << format("%%.%ud%%%u$hn%%.%ud%%%u$hn",high,pop_length+1,low-high,pop_length)
+            buffer << format("%%.%ud%%%u$hn%%.%ud%%%u$hn",high,pop_length + 1,low - high,pop_length)
           end
 
           buffer << payload.to_s

data/lib/ronin/exploits/mixins/has_payload.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -32,11 +33,11 @@ module Ronin
       #     module Ronin
       #       module Exploits
       #         class MyExploit < Exploit
-      #     
+      #
       #           include Mixins::HasPayload
-      #     
+      #
       #           payload_class Ronin::Payloads::JavaScriptPayload
-      #     
+      #
       #         end
       #       end
       #     end

data/lib/ronin/exploits/mixins/has_targets.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/mixins/html.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -24,6 +25,9 @@ require 'ronin/support/text/core_ext'
 module Ronin
   module Exploits
     module Mixins
+      #
+      # Mixin which adds methods for building HTML.
+      #
       module HTML
         #
         # Formats an HTML attribute name.

data/lib/ronin/exploits/mixins/http.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -32,6 +33,22 @@ module Ronin
       # @since 1.0.0
       #
       module HTTP
+        # Possible values for the `user_agent` param.
+        #
+        # @api private
+        HTTP_USER_AGENT_ALIASES = [
+          :random,
+          :chrome,
+          :firefox,
+          :safari,
+          :linux,
+          :macos,
+          :windows,
+          :iphone,
+          :ipad,
+          :android
+        ] + Support::Network::HTTP::UserAgents::ALIASES.keys
+
         #
         # Adds the required `base_url` params to the exploit class.
         #
@@ -49,19 +66,7 @@ module Ronin
 
           exploit.param :http_password, desc: 'The HTTP Basic-Auth password'
 
-          user_agent_ids = [
-                             :random,
-                             :chrome,
-                             :firefox,
-                             :safari,
-                             :linux,
-                             :macos,
-                             :windows,
-                             :iphone,
-                             :ipad,
-                             :android
-                           ] + Support::Network::HTTP::UserAgents::ALIASES.keys
-          exploit.param :user_agent, Core::Params::Types::Enum.new(user_agent_ids), desc: 'The HTTP User-Agent to select'
+          exploit.param :user_agent, Core::Params::Types::Enum.new(HTTP_USER_AGENT_ALIASES), desc: 'The HTTP User-Agent to select'
 
           exploit.param :raw_user_agent, desc: 'The raw HTTP User-Agent string to use'
 
@@ -145,22 +150,22 @@ module Ronin
         #
         #   @option kwargs [String, nil] :query
         #     The query-string to append to the request path.
-        #   
+        #
         #   @option kwargs [Hash, nil] :query_params
         #     The query-params to append to the request path.
-        #   
+        #
         #   @option kwargs [String, nil] :body
         #     The body of the request.
-        #   
+        #
         #   @option kwargs [Hash, String, nil] :form_data
         #     The form data that may be sent in the body of the request.
-        #   
+        #
         #   @option kwargs [String, nil] :user (http_user)
         #     The user to authenticate as.
-        #   
+        #
         #   @option kwargs [String, nil] :password (http_password)
         #     The password to authenticate with.
-        #   
+        #
         #   @option kwargs [Hash{Symbol,String => String}, nil] :headers
         #     Additional HTTP headers to use for the request.
         #

data/lib/ronin/exploits/mixins/loot.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -31,7 +32,7 @@ module Ronin
       #     module Ronin
       #       module Exploits
       #         class MyExploit < Exploit
-      #     
+      #
       #           include Mixins::Loot
       #
       #           def launch
@@ -52,7 +53,7 @@ module Ronin
       #             # add CSV data
       #             loot.add('foo.csv',  data, format: :csv)
       #           end
-      #     
+      #
       #         end
       #       end
       #     end

data/lib/ronin/exploits/mixins/nops.rb

@@ -45,10 +45,10 @@ module Ronin
         #
         # @api private
         NOPS = {
-          x86:    "\x90".b,             # nop
-          x86_64: "\x90".b,             # nop
-          arm:    "\x05P\xa0\xe1".b,    # mov r5, r5
-          arm64:  "\xe5\x03\x05\xaa".b, # mov x5, x5
+          x86:    "\x90".b,            # nop
+          x86_64: "\x90".b,            # nop
+          arm:    "\x05P\xa0\xe1".b,   # mov r5, r5
+          arm64:  "\xe5\x03\x05\xaa".b # mov x5, x5
           # TODO: mips
           # TODO: mips64
           # TODO: ppc

data/lib/ronin/exploits/mixins/remote_tcp.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -129,7 +130,7 @@ module Ronin
         # @example
         #   @socket = tcp_connect
         #   # => TCPSocket
-        #   
+        #
         # @example
         #   tcp_connect do |socket|
         #     socket.write("GET /\n\n")

data/lib/ronin/exploits/mixins/remote_udp.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/mixins/seh.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/mixins/stack_overflow.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -102,7 +103,7 @@ module Ronin
         # @example
         #   ebp = 0x06eb9090 # short jump 6 bytes
         #   eip = 0x1001ae86 # pop pop ret 1001AE86 SSLEAY32.DLL
-        #   
+        #
         #   buffer = buffer_overflow(length: 1024, nops: 16, payload: payload, bp: ebp, ip: eip)
         #
         def buffer_overflow(length: , nops: nil, payload: , bp: , ip: )

data/lib/ronin/exploits/mixins/text.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/mixins.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/open_redirect.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -34,16 +35,16 @@ module Ronin
     # ## Example
     #
     #     require 'ronin/exploits/open_redirect'
-    #     
+    #
     #     module Ronin
     #       module Exploits
     #         class MyExploit < OpenRedirect
-    #     
+    #
     #           register 'my_exploit'
-    #    
+    #
     #           base_path '/path/to/page.php'
     #           query_param 'url'
-    #    
+    #
     #         end
     #       end
     #     end

data/lib/ronin/exploits/params/base_url.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/params/bind_host.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/params/bind_port.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/params/filename.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -33,7 +34,7 @@ module Ronin
       # Setting the default port value:
       #
       #     include Params::Filename
-      #     
+      #
       #     default_filename 'exploit.docx'
       #
       # @api public
@@ -53,7 +54,7 @@ module Ronin
         def self.included(exploit)
           exploit.include Metadata::DefaultFilename
           exploit.param :filename, String, required: true,
-                                           default:  ->{ exploit.default_filename },
+                                           default:  -> { exploit.default_filename },
                                            desc:     'The filename for the exploit'
         end
 

data/lib/ronin/exploits/params/host.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.

data/lib/ronin/exploits/params/port.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -33,7 +34,7 @@ module Ronin
       # Setting the default port value:
       #
       #     include Params::Port
-      #     
+      #
       #     default_port 143
       #
       # @api public
@@ -53,7 +54,7 @@ module Ronin
         def self.included(exploit)
           exploit.include Metadata::DefaultPort
           exploit.param :port, Integer, required: true,
-                                        default:  ->{ exploit.default_port },
+                                        default:  -> { exploit.default_port },
                                         desc:     'Remote port to connect to'
         end
 

data/lib/ronin/exploits/registry.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -22,6 +23,9 @@ require 'ronin/core/class_registry'
 require 'ronin/repos/class_dir'
 
 module Ronin
+  #
+  # Namespace for `ronin-exploits`.
+  #
   module Exploits
     include Core::ClassRegistry
     include Repos::ClassDir

data/lib/ronin/exploits/rfi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.
@@ -34,16 +35,16 @@ module Ronin
     # ## Example
     #
     #     require 'ronin/exploits/rfi'
-    #     
+    #
     #     module Ronin
     #       module Exploits
     #         class MyExploit < RFI
-    #     
+    #
     #           register 'my_exploit'
-    #    
+    #
     #           base_path '/path/to/page.php'
     #           query_param 'template'
-    #    
+    #
     #         end
     #       end
     #     end
@@ -64,8 +65,10 @@ module Ronin
 
       param :test_script_url, String, desc: 'The URL for the RFI test script'
 
-      param :filter_bypass, Enum[:null_byte, :double_encode],
-                            desc: 'Optional filter bypass strategy'
+      param :filter_bypass, Enum[
+                              :null_byte,
+                              :double_encode
+                            ], desc: 'Optional filter bypass strategy'
 
       #
       # Returns the type or kind of exploit.

data/lib/ronin/exploits/root.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
 # payload crafting functionality.