/usr/share/w3af/plugins/auth/detailed.py is in w3af-console 1.1svn5547-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 | '''
detailed.py
Copyright 2011 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
from core.controllers.basePlugin.baseAuthPlugin import baseAuthPlugin
from core.controllers.w3afException import w3afException
from core.data.options.option import option
from core.data.options.optionList import optionList
class detailed(baseAuthPlugin):
'''Detailed authentication plugin.'''
def __init__(self):
baseAuthPlugin.__init__(self)
self.username = ''
self.password = ''
self.username_field = ''
self.password_field = ''
self.method = 'POST'
self.data_format = '%u=%U&%p=%P'
self.auth_url = ''
self.check_url = ''
self.check_string = ''
self._login_error = True
def login(self):
'''
Login to the application.
'''
msg = 'Logging into the application using %s/%s' % (self.username, self.password)
om.out.debug( msg )
data = self._get_data_from_format()
try:
functor = getattr(self._uri_opener, self.method)
# TODO Why we don't use httpPostDataRequest here?
functor(self.auth_url, data)
if not self.is_logged():
raise Exception("Can't login into web application as %s/%s"
% (self.username, self.password))
else:
om.out.debug( 'Login success for %s/%s' % (self.username, self.password) )
return True
except Exception, e:
if self._login_error:
om.out.error(str(e))
self._login_error = False
return False
def _get_data_from_format(self):
'''
@return: A string with all the information to send to the login URL.
This string contains the username, password, and all the other information
that was provided by the user and needs to be transmitted to the remote
web application.
'''
result = self.data_format
result = result.replace('%u', self.username_field)
result = result.replace('%U', self.username)
result = result.replace('%p', self.password_field)
result = result.replace('%P', self.password)
return result
def logout(self):
'''User login.'''
return None
def is_logged(self):
'''Check user session.'''
try:
body = self._uri_opener.GET(self.check_url, grep=False).body
logged_in = self.check_string in body
msg_yes = 'User "%s" is currently logged into the application'
msg_no = 'User "%s" is NOT logged into the application'
msg = msg_yes if logged_in else msg_no
om.out.debug( msg % self.username )
return logged_in
except Exception:
return False
def getOptions(self):
'''
@return: A list of option objects for this plugin.
'''
options = [
('username', self.username, 'string', 'Username for using in the authentication'),
('password', self.password, 'string', 'Password for using in the authentication'),
('username_field', self.username_field, 'string', 'Username HTML field name'),
('password_field', self.password_field, 'string', 'Password HTML field name'),
('data_format', self.data_format, 'string', 'The format for the POST-data or query string'),
('auth_url', self.auth_url, 'url',
'Auth URL - URL for POSTing the authentication information'),
('method', self.method, 'string', 'The HTTP method to use'),
('check_url', self.check_url, 'url',
'Check session URL - URL in which response body check_string will be searched'),
('check_string', self.check_string, 'string',
'String for searching on check_url page to determine if user\
is logged in the web application'),
]
ol = optionList()
for o in options:
ol.add(option(o[0], o[1], o[3], o[2]))
return ol
def setOptions(self, optionsMap):
'''
This method sets all the options that are configured using
the user interface generated by the framework using
the result of getOptions().
@parameter optionsMap: A dict with the options for the plugin.
@return: No value is returned.
'''
self.username = optionsMap['username'].getValue()
self.password = optionsMap['password'].getValue()
self.username_field = optionsMap['username_field'].getValue()
self.password_field = optionsMap['password_field'].getValue()
self.data_format = optionsMap['data_format'].getValue()
self.check_string = optionsMap['check_string'].getValue()
self.method = optionsMap['method'].getValue()
self.auth_url = optionsMap['auth_url'].getValue()
self.check_url = optionsMap['check_url'].getValue()
for o in optionsMap:
if not o.getValue():
msg = "All parameters are required and can't be empty."
raise w3afException( msg )
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 authentication plugin can login to web application with more detailed
and complex authentication schemas where the generic plugin does not work.
Three configurable parameters exist:
- username
- password
- username_field
- password_field
- data_format
- auth_url
- method
- check_url
- check_string
'''
|