'''
wsdlGreper.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.baseGrepPlugin import baseGrepPlugin
from core.data.bloomfilter.pybloom import ScalableBloomFilter

import core.data.kb.knowledgeBase as kb
import core.data.kb.info as info


class wsdlGreper(baseGrepPlugin):
    '''
    Grep every page for web service definition files.
    
    @author: Andres Riancho ( andres.riancho@gmail.com )
    '''

    def __init__(self):
        baseGrepPlugin.__init__(self)

        # Only generate the lists once.
        # Adding 0,001% performance ;)
        self._already_inspected = ScalableBloomFilter()
        self._wsdl_strings = self._get_WSDL_strings()
        self._disco_strings = ['disco:discovery ']

    def grep(self, request, response):
        '''
        Plugin entry point.
        
        @parameter request: The HTTP request object.
        @parameter response: The HTTP response object
        @return: None, all results are saved in the kb.

        Init
        >>> from core.data.url.httpResponse import httpResponse
        >>> from core.data.request.fuzzableRequest import fuzzableRequest
        >>> from core.data.parsers.urlParser import url_object
        >>> from core.controllers.coreHelpers.fingerprint_404 import fingerprint_404_singleton
        >>> f = fingerprint_404_singleton( [False, False, False] )

        Simple test, empty string.
        >>> body = ''
        >>> url = url_object('http://www.w3af.com/')
        >>> headers = {'content-type': 'text/html'}
        >>> response = httpResponse(200, body , headers, url, url)
        >>> request = fuzzableRequest()
        >>> request.setURL(url)
        >>> request.setMethod('GET')
        >>> w = wsdlGreper()
        >>> w.grep(request, response)
        >>> len(kb.kb.getData('wsdlGreper', 'wsdl'))
        0

        One long string
        >>> body = 'ABC ' * 10000
        >>> url = url_object('http://www.w3af.com/')
        >>> headers = {'content-type': 'text/html'}
        >>> response = httpResponse(200, body , headers, url, url)
        >>> request = fuzzableRequest()
        >>> request.setURL(url)
        >>> request.setMethod('GET')
        >>> w = wsdlGreper()
        >>> w.grep(request, response)
        >>> len(kb.kb.getData('wsdlGreper', 'wsdl'))
        0

        Something interesting to match
        >>> body = 'ABC ' * 100
        >>> body += '/s:sequence'
        >>> body += '</br> ' * 50
        >>> url = url_object('http://www.w3af.com/')
        >>> headers = {'content-type': 'text/html'}
        >>> response = httpResponse(200, body , headers, url, url)
        >>> request = fuzzableRequest()
        >>> request.setURL(url)
        >>> request.setMethod('GET')
        >>> w = wsdlGreper()
        >>> w.grep(request, response)
        >>> len(kb.kb.getData('wsdlGreper', 'wsdl'))
        1

        Something interesting to match
        >>> kb.kb.cleanup()
        >>> body = 'ABC ' * 100
        >>> body += 'disco:discovery '
        >>> body += '</br> ' * 50
        >>> url = url_object('http://www.w3af.com/')
        >>> headers = {'content-type': 'text/html'}
        >>> response = httpResponse(200, body , headers, url, url)
        >>> request = fuzzableRequest()
        >>> request.setURL(url)
        >>> request.setMethod('GET')
        >>> w = wsdlGreper()
        >>> w.grep(request, response)
        >>> len(kb.kb.getData('wsdlGreper', 'disco'))
        1
        '''
        url = response.getURL()
        if response.is_text_or_html() and response.getCode() == 200  and \
            url not in self._already_inspected:
            # Don't repeat URLs
            self._already_inspected.add(url)
            is_WSDL = False
            for wsdl_string in self._wsdl_strings:
                if wsdl_string in response:
                    is_WSDL = True
                    break
                
            if is_WSDL:
                i = info.info()
                i.setPluginName(self.getName())
                i.setName('WSDL file')
                i.setURL( response.getURL() )
                i.setId( response.id )
                i.addToHighlight( wsdl_string )
                msg = 'The URL: "' +  i.getURL() + '" is a Web Services '
                msg += 'Description Language page.'
                i.setDesc( msg )
                kb.kb.append( self , 'wsdl' , i )
            
            is_Disco = False
            for disco_string in self._disco_strings:
                if disco_string in response:
                    is_Disco = True
                    break
                
            if is_Disco:
                i = info.info()
                i.setPluginName(self.getName())
                i.setURL( response.getURL() )
                msg = 'The URL: "' +  i.getURL() + '" is a DISCO file that contains'
                msg += ' references to WSDLs.'
                i.setDesc( msg )
                i.addToHighlight( disco_string )
                kb.kb.append( self , 'disco' , i )
            
    def setOptions( self, OptionList ):
        pass
    
    def getOptions( self ):
        '''
        @return: A list of option objects for this plugin.
        '''    
        ol = optionList()
        return ol

    def _get_WSDL_strings( self ):
        res = []
        
        res.append( 'xs:int' )
        res.append( 'targetNamespace' )
        res.append( 'soap:body' )
        res.append( '/s:sequence' )
        res.append( 'wsdl:' )
        res.append( 'soapAction=' )
        # This isn't WSDL... but well...
        res.append( 'xmlns="urn:uddi"' )
        res.append( '<p>Hi there, this is an AXIS service!</p>' )
                
        return res
        
    def getPluginDeps( self ):
        '''
        @return: A list with the names of the plugins that should be runned before the
        current one.
        '''
        return []
    
    def end(self):
        '''
        This method is called when the plugin wont be used anymore.
        '''
        self.printUniq( kb.kb.getData( 'wsdlGreper', 'wsdl' ), 'URL' )
        self.printUniq( kb.kb.getData( 'wsdlGreper', 'disco' ), 'URL' )
        
    def getLongDesc( self ):
        '''
        @return: A DETAILED description of the plugin functions and features.
        '''
        return '''
        This plugin greps every page for WSDL definitions.
        
        Not all wsdls are found appending "?WSDL" to the url like discovery.wsdlFinder
        plugin does, this grep plugin will find some wsdl's that arent found by the 
        discovery plugin.
        '''
