Land rapid7#4084, prep for Ruby 2.1

Author: Tod Beardsley

.travis.yml

@@ -23,8 +23,9 @@ before_script:
 script: "bundle exec rake $RAKE_TASK"
 
 rvm:
-  #- '1.8.7'
   - '1.9.3'
+  - '2.0'
+  - '2.1'
 
 notifications:
   irc: "irc.freenode.org#msfnotify"

Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 #   spec.add_runtime_dependency '<name>', [<version requirements>]
 gemspec
 
+gem 'rb-readline', require: false
+
 group :db do
   # Needed for Msf::DbManager
   gem 'activerecord', '>= 3.0.0', '< 4.0.0'

Gemfile.lock

@@ -14,6 +14,7 @@ PATH
       nokogiri
       packetfu (= 1.1.9)
       railties
+      rb-readline
       recog (~> 1.0)
       robots
       rubyzip (~> 1.1)
@@ -57,7 +58,7 @@ GEM
       childprocess (>= 0.3.6)
       cucumber (>= 1.1.1)
       rspec-expectations (>= 2.7.0)
-    bcrypt (3.1.7)
+    bcrypt (3.1.9)
     builder (3.0.4)
     capybara (2.4.1)
       mime-types (>= 1.16)
@@ -161,6 +162,7 @@ GEM
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
     rake (10.3.2)
+    rb-readline (0.5.1)
     rdoc (3.12.2)
       json (~> 1.4)
     recog (1.0.0)
@@ -230,6 +232,7 @@ DEPENDENCIES
   pg (>= 0.11)
   pry
   rake (>= 10.0.0)
+  rb-readline
   redcarpet
   rspec (>= 2.12, < 3.0.0)
   rspec-rails (>= 2.12, < 3.0.0)

features/commands/help.feature

@@ -1,9 +1,9 @@
 Feature: Help command
-  
+
   Background:
     Given I run `msfconsole` interactively
     And I wait for stdout to contain "Free Metasploit Pro trial: http://r-7.co/trymsp"
-    
+
   Scenario: The 'help' command's output
     When I type "help"
     And I type "exit"
@@ -75,4 +75,4 @@ Feature: Help command
           vulns             List all vulnerabilities in the database
           workspace         Switch between database workspaces
       """
-  
+

features/modules/exploit/smb/ms08_067_netapi.feature

@@ -7,7 +7,7 @@ Feature: MS08-067 netapi
     And a mocked home directory
     Given I run `msfconsole` interactively
     And I wait for stdout to contain "Free Metasploit Pro trial: http://r-7.co/trymsp"
-    
+
   Scenario: The MS08-067 Module should have the following options
     When I type "use exploit/windows/smb/ms08_067_netapi"
     And I type "show options"
@@ -28,7 +28,7 @@ Feature: MS08-067 netapi
          Id  Name
          --  ----
          0   Automatic Targeting
-      
+
       """
 
   Scenario: The MS08-067 Module should have the following advanced options
@@ -40,19 +40,19 @@ Feature: MS08-067 netapi
       Module advanced options:
 
          Name           : CHOST
-         Current Setting: 
+         Current Setting:
          Description    : The local client address
 
          Name           : CPORT
-         Current Setting: 
+         Current Setting:
          Description    : The local client port
 
          Name           : ConnectTimeout
          Current Setting: 10
          Description    : Maximum number of seconds to establish a TCP connection
 
          Name           : ContextInformationFile
-         Current Setting: 
+         Current Setting:
          Description    : The information file that contains context information
 
          Name           : DCERPC::ReadTimeout
@@ -69,41 +69,41 @@ Feature: MS08-067 netapi
 
          Name           : NTLM::SendLM
          Current Setting: true
-         Description    : Always send the LANMAN response (except when NTLMv2_session is 
+         Description    : Always send the LANMAN response (except when NTLMv2_session is
             specified)
 
          Name           : NTLM::SendNTLM
          Current Setting: true
-         Description    : Activate the 'Negotiate NTLM key' flag, indicating the use of 
+         Description    : Activate the 'Negotiate NTLM key' flag, indicating the use of
             NTLM responses
 
          Name           : NTLM::SendSPN
          Current Setting: true
-         Description    : Send an avp of type SPN in the ntlmv2 client Blob, this allow 
+         Description    : Send an avp of type SPN in the ntlmv2 client Blob, this allow
             authentification on windows Seven/2008r2 when SPN is required
 
          Name           : NTLM::UseLMKey
          Current Setting: false
-         Description    : Activate the 'Negotiate Lan Manager Key' flag, using the LM key 
+         Description    : Activate the 'Negotiate Lan Manager Key' flag, using the LM key
             when the LM response is sent
 
          Name           : NTLM::UseNTLM2_session
          Current Setting: true
-         Description    : Activate the 'Negotiate NTLM2 key' flag, forcing the use of a 
+         Description    : Activate the 'Negotiate NTLM2 key' flag, forcing the use of a
             NTLMv2_session
 
          Name           : NTLM::UseNTLMv2
          Current Setting: true
-         Description    : Use NTLMv2 instead of NTLM2_session when 'Negotiate NTLM2' key 
+         Description    : Use NTLMv2 instead of NTLM2_session when 'Negotiate NTLM2' key
             is true
 
          Name           : Proxies
-         Current Setting: 
+         Current Setting:
          Description    : Use a proxy chain
 
          Name           : SMB::ChunkSize
          Current Setting: 500
-         Description    : The chunk size for SMB segments, bigger values will increase 
+         Description    : The chunk size for SMB segments, bigger values will increase
             speed but break NT 4.0 and SMB signing
 
          Name           : SMB::Native_LM
@@ -131,37 +131,37 @@ Feature: MS08-067 netapi
          Description    : The NetBIOS hostname (required for port 139 connections)
 
          Name           : SMBPass
-         Current Setting: 
+         Current Setting:
          Description    : The password for the specified username
 
          Name           : SMBUser
-         Current Setting: 
+         Current Setting:
          Description    : The username to authenticate as
 
          Name           : SSL
          Current Setting: false
          Description    : Negotiate SSL for outgoing connections
 
          Name           : SSLCipher
-         Current Setting: 
+         Current Setting:
          Description    : String for SSL cipher - "DHE-RSA-AES256-SHA" or "ADH"
 
          Name           : SSLVerifyMode
          Current Setting: PEER
-         Description    : SSL verification method (accepted: CLIENT_ONCE, 
+         Description    : SSL verification method (accepted: CLIENT_ONCE,
             FAIL_IF_NO_PEER_CERT, NONE, PEER)
 
          Name           : SSLVersion
          Current Setting: SSL3
-         Description    : Specify the version of SSL that should be used (accepted: SSL2, 
+         Description    : Specify the version of SSL that should be used (accepted: SSL2,
             SSL3, TLS1)
 
          Name           : VERBOSE
          Current Setting: false
          Description    : Enable detailed status messages
 
          Name           : WORKSPACE
-         Current Setting: 
+         Current Setting:
          Description    : Specify the workspace for this module
 
          Name           : WfsDelay

features/msfconsole/database_yml.feature

@@ -157,11 +157,11 @@ Feature: `msfconsole` `database.yml`
     And the output should not contain "user_metasploit_framework_test"
     And the output should not contain "project_metasploit_framework_test"
     And the output should contain "[*] postgresql selected, no connection"
-    
+
   Scenario: Starting `msfconsole` with a valid database.yml
     Given I run `msfconsole` interactively
     And I wait for stdout to contain "Free Metasploit Pro trial: http://r-7.co/trymsp"
     When I type "db_status"
     And I type "exit"
     Then the output should contain "[*] postgresql connected to metasploit_framework_test"
-  
+

lib/msf/ui/console/driver.rb

@@ -54,21 +54,7 @@ class Driver < Msf::Ui::Driver
   # @option opts [Boolean] 'SkipDatabaseInit' (false) Whether to skip
   #   connecting to the database and running migrations
   def initialize(prompt = DefaultPrompt, prompt_char = DefaultPromptChar, opts = {})
-
-    # Choose a readline library before calling the parent
-    rl = false
-    rl_err = nil
-    begin
-      if(opts['RealReadline'])
-        require 'readline'
-        rl = true
-      end
-    rescue ::LoadError
-      rl_err = $!
-    end
-
-    # Default to the RbReadline wrapper
-    require 'readline_compatible' if(not rl)
+    choose_readline(opts)
 
     histfile = opts['HistFile'] || Msf::Config.history_file
 
@@ -112,9 +98,9 @@ def initialize(prompt = DefaultPrompt, prompt_char = DefaultPromptChar, opts = {
     enstack_dispatcher(CommandDispatcher::Core)
 
     # Report readline error if there was one..
-    if not rl_err.nil?
+    if !@rl_err.nil?
       print_error("***")
-      print_error("* WARNING: Unable to load readline: #{rl_err}")
+      print_error("* WARNING: Unable to load readline: #{@rl_err}")
       print_error("* Falling back to RbReadLine")
       print_error("***")
     end
@@ -719,6 +705,43 @@ def handle_loglevel(val)
     set_log_level(Msf::LogSource, val)
   end
 
+  # Require the appropriate readline library based on the user's preference.
+  #
+  # @return [void]
+  def choose_readline(opts)
+    # Choose a readline library before calling the parent
+    @rl_err = nil
+    if opts['RealReadline']
+      # Remove the gem version from load path to be sure we're getting the
+      # stdlib readline.
+      gem_dir = Gem::Specification.find_all_by_name('rb-readline').first.gem_dir
+      rb_readline_path = File.join(gem_dir, "lib")
+      index = $LOAD_PATH.index(rb_readline_path)
+      # Bundler guarantees that the gem will be there, so it should be safe to
+      # assume we found it in the load path, but check to be on the safe side.
+      if index
+        $LOAD_PATH.delete_at(index)
+      end
+    end
+
+    begin
+      require 'readline'
+    rescue ::LoadError => e
+      if @rl_err.nil? && index
+        # Then this is the first time the require failed and we have an index
+        # for the gem version as a fallback.
+        @rl_err = e
+        # Put the gem back and see if that works
+        $LOAD_PATH.insert(index, rb_readline_path)
+        index = rb_readline_path = nil
+        retry
+      else
+        # Either we didn't have the gem to fall back on, or we failed twice.
+        # Nothing more we can do here.
+        raise e
+      end
+    end
+  end
 end
 
 #
@@ -731,6 +754,7 @@ def to_s
   end
 end
 
+
 end
 end
 end