'''
dnsWildcard.py

Copyright 2006 Andres Riancho

This file is part of w3af, w3af.sourceforge.net .

w3af 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 version 2 of the License.

w3af 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 w3af; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

'''

import core.controllers.outputManager as om

# options
from core.data.options.option import option
from core.data.options.optionList import optionList

from core.controllers.basePlugin.baseDiscoveryPlugin import baseDiscoveryPlugin

import core.data.kb.knowledgeBase as kb
import core.data.kb.info as info
import core.data.parsers.urlParser as urlParser
from core.controllers.w3afException import w3afException, w3afRunOnce

import re
import socket


class dnsWildcard(baseDiscoveryPlugin):
    '''
    Find out if www.site.com and site.com return the same page.
    @author: Andres Riancho ( andres.riancho@gmail.com )
    '''

    def __init__(self):
        baseDiscoveryPlugin.__init__(self)
        self._exec = True

    def discover(self, fuzzableRequest ):
        '''
        Get www.site.com and site.com and compare responses.
        
        @parameter fuzzableRequest: A fuzzableRequest instance that contains (among other things) the URL to test.
        '''
        if not self._exec :
            # This will remove the plugin from the discovery plugins to be runned.
            raise w3afRunOnce()
            
        else:
            # Only run once
            self._exec = False
            
            if not re.match('\d?\d?\d?\.\d?\d?\d?\.\d?\d?\d?\.\d?\d?\d?',
                                    urlParser.getDomain( fuzzableRequest.getURL() ) ):
                # Only do all this if this is a domain name!
                base_url = urlParser.baseUrl( fuzzableRequest.getURL() )
                original_response = self._urlOpener.GET( base_url, useCache=True )
                
                domain = urlParser.getDomain( fuzzableRequest.getURL() )
                proto = urlParser.getProtocol( fuzzableRequest.getURL() )
                if domain.startswith('www.'):
                    dns_wildcard_url = proto + '://' + domain.replace('www.', '') + '/'
                else:
                    dns_wildcard_url = proto + '://www.' + domain + '/'
                
                self._test_DNS( original_response, dns_wildcard_url )
                self._test_IP( original_response, domain )
                
            return []
    
    def _test_IP( self, original_response, domain ):
        '''
        Check if http://ip(domain)/ == http://domain/
        '''
        ip_address = socket.gethostbyname( domain )
        ip_url = urlParser.getProtocol( original_response.getURL() ) + '://'+ ip_address + '/'
        try:
            modified_response = self._urlOpener.GET( ip_url, useCache=True )
        except w3afException:
            om.out.debug('An error ocurred while fetching IP address URL in dnsWildcard plugin.')
        else:
            if modified_response.getBody() != original_response.getBody():
                i = info.info()
                i.setName('DNS Wildcard')
                i.setURL( modified_response.getURL() )
                i.setMethod( 'GET' )
                msg = 'The contents of ' + modified_response.getURI()
                msg += ' differ from the contents of ' + original_response.getURI() 
                i.setDesc( msg )
                i.setId( modified_response.id )
                kb.kb.append( self, 'dnsWildcard', i )
                om.out.information( i.getDesc() )
        
    def _test_DNS( self, original_response, dns_wildcard_url ):
        '''
        Check if http://www.domain.tld/ == http://domain.tld/
        '''
        try:
            modified_response = self._urlOpener.GET( dns_wildcard_url, useCache=True )
        except w3afException, w3:
            if 'Failed to resolve' in str(w3):
                i = info.info()
                i.setName('No DNS wildcard')
                i.setURL( original_response.getURL() )
                i.setMethod( 'GET' )
                i.setDesc('The target site has no DNS wildcard.')
                kb.kb.append( self, 'dnsWildcard', i )
                om.out.information( i.getDesc() )
        else:
            if modified_response.getBody() != original_response.getBody():
                i = info.info()
                i.setName('No DNS wildcard')
                i.setURL( modified_response.getURL() )
                i.setMethod( 'GET' )
                msg = 'The target site has no DNS wildcard, and the contents of '
                msg += modified_response.getURI() + ' differ from the contents of ' 
                msg += original_response.getURI()
                i.setDesc( msg )
                i.setId( modified_response.id )
                kb.kb.append( self, 'dnsWildcard', i )
                om.out.information( i.getDesc() )
            else:
                i = info.info()
                i.setName('DNS wildcard')
                i.setURL( original_response.getURL() )
                i.setMethod( 'GET' )
                i.setDesc('The target site *has* a DNS wildcard configuration.' )
                i.setId( modified_response.id )
                kb.kb.append( self, 'dnsWildcard', i )
                om.out.information( i.getDesc() )
                
    def getOptions( self ):
        '''
        @return: A list of option objects for this plugin.
        '''    
        ol = optionList()
        return ol

    def setOptions( self, OptionList ):
        '''
        This method sets all the options that are configured using the user interface 
        generated by the framework using the result of getOptions().
        
        @parameter OptionList: A dictionary with the options for the plugin.
        @return: No value is returned.
        ''' 
        pass

    def getPluginDeps( self ):
        '''
        @return: A list with the names of the plugins that should be runned before the
        current one.
        '''
        return []
        
    def getLongDesc( self ):
        '''
        @return: A DETAILED description of the plugin functions and features.
        '''
        return '''
        This plugin compares the contents of www.site.com and site.com and tries to verify if the target site
        has a DNS wildcard configuration or not.
        '''