X-Git-Url: http://git.cascardo.info/?p=cascardo%2Fipsilon.git;a=blobdiff_plain;f=ipsilon%2Flogin%2Fcommon.py;h=ef84e1093f65ba8fa7910cf0c252f086a69ec501;hp=94284b05a677b325a5acf46b18a144c24720388e;hb=HEAD;hpb=5ea128eca075c19880419c072be36fd761aad4a4 diff --git a/ipsilon/login/common.py b/ipsilon/login/common.py old mode 100755 new mode 100644 index 94284b0..ef84e10 --- a/ipsilon/login/common.py +++ b/ipsilon/login/common.py @@ -1,76 +1,151 @@ -#!/usr/bin/python -# -# Copyright (C) 2013 Simo Sorce -# -# see file 'COPYING' for use and warranty information -# -# This program 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, either version 3 of the License, or -# (at your option) any later version. -# -# This program 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 this program. If not, see . +# Copyright (C) 2013 Ipsilon project Contributors, for license see COPYING -from ipsilon.util.log import Log from ipsilon.util.page import Page from ipsilon.util.user import UserSession -from ipsilon.util.plugin import PluginLoader, PluginObject -from ipsilon.util.plugin import PluginInstaller +from ipsilon.util.plugin import PluginInstaller, PluginLoader +from ipsilon.util.plugin import PluginObject +from ipsilon.util.config import ConfigHelper from ipsilon.info.common import Info from ipsilon.util.cookies import SecureCookie -from ipsilon.util.trans import Transaction +from ipsilon.util.log import Log import cherrypy USERNAME_COOKIE = 'ipsilon_default_username' -class LoginManagerBase(PluginObject, Log): +class LoginHelper(Log): - def __init__(self): - super(LoginManagerBase, self).__init__() - self.path = '/' - self.next_login = None - self.info = None + """Common code supporing login operations. - def redirect_to_path(self, path): - base = cherrypy.config.get('base.mount', "") - raise cherrypy.HTTPRedirect('%s/login/%s' % (base, path)) + Ipsilon can authtenticate a user by itself via it's own login + handlers (classes derived from `LoginManager`) or it can + capitalize on the authentication provided by the container Ipsilon + is running in (currently WSGI inside Apache). We refer to the + later as "external authentication" because it occurs outside of + Ipsilon. However in both cases there is a common need to execute + the same code irregardless of where the authntication + occurred. This class serves that purpose. + """ + + def get_external_auth_info(self): + """Return the username and auth type for external authentication. + + If the container Ipsilon is running inside of has already + authenticated the user prior to reaching one of our endpoints + return the username and the name of authenticaion method + used. In Apache this will be REMOTE_USER and AUTH_TYPE. + + The returned auth_type will be prefixed with the string + "external:" to clearly distinguish between the same method + being used internally by Ipsilon from the same method used by + the container hosting Ipsilon. The returned auth_type string + will be lower case. + + If there was no external authentication both username and + auth_type will be None. It is possible for a username to be + returned without knowing the auth_type. + + :return: tuple of (username, auth_type) + """ + + auth_type = None + username = cherrypy.request.login + if username: + auth_type = cherrypy.request.wsgi_environ.get('AUTH_TYPE') + if auth_type: + auth_type = 'external:%s' % (auth_type.lower()) + + self.debug("get_external_auth_info: username=%s auth_type=%s" % ( + username, auth_type)) + + return username, auth_type + + def initialize_login_session(self, username, info=None, + auth_type=None, userdata=None): + """Establish a login session for a user. + + Builds a `UserSession` object and bind attributes associated + with the user to the session. + + User attributes derive from two sources, the `Info` object + passed as the info parameter and the userdata dict. The `Info` + object encapsulates the info plugins run by Ipsilon. The + userdata dict is additional information typically derived + during authentication. + + The `Info` derived attributes are merged with the userdata + attributes to form one set of user attributes. The user + attributes are checked for consistenccy. Additional attrbutes + may be synthesized and added to the user attributes. The final + set of user attributes is then bound to the returned + `UserSession` object. + + :param username: The username bound to the identity principal + :param info: A `Info` object providing user attributes + :param auth_type: Authenication method name + :param userdata: Dict of additional user attributes + + :return: `UserSession` object + """ - def auth_successful(self, trans, username, auth_type=None, userdata=None): session = UserSession() - if self.info: - userattrs = self.info.get_user_attrs(username) - if userdata: - userdata.update(userattrs.get('userdata', {})) - else: - userdata = userattrs.get('userdata', {}) + # merge attributes from login plugin and info plugin + if info: + infoattrs = info.get_user_attrs(username) + else: + infoattrs = dict() + + if userdata is None: + userdata = dict() - # merge groups and extras from login plugin and info plugin - userdata['groups'] = list(set(userdata.get('groups', []) + - userattrs.get('groups', []))) + if '_groups' in infoattrs: + userdata['_groups'] = list(set(userdata.get('_groups', []) + + infoattrs['_groups'])) + del infoattrs['_groups'] - userdata['extras'] = userdata.get('extras', {}) - userdata['extras'].update(userattrs.get('extras', {})) + if '_extras' in infoattrs: + userdata['_extras'] = userdata.get('_extras', {}) + userdata['_extras'].update(infoattrs['_extras']) + del infoattrs['_extras'] - self.debug("User %s attributes: %s" % (username, repr(userdata))) + userdata.update(infoattrs) + + self.debug("User %s attributes: %s" % (username, repr(userdata))) if auth_type: if userdata: - userdata.update({'auth_type': auth_type}) + userdata.update({'_auth_type': auth_type}) else: - userdata = {'auth_type': auth_type} + userdata = {'_auth_type': auth_type} # create session login including all the userdata just gathered session.login(username, userdata) + return session + + +class LoginManagerBase(ConfigHelper, PluginObject, LoginHelper): + + def __init__(self, *args): + ConfigHelper.__init__(self) + PluginObject.__init__(self, *args) + self._root = None + self._site = None + self.path = '/' + self.info = None + + def redirect_to_path(self, path, trans=None): + base = cherrypy.config.get('base.mount', "") + url = '%s/login/%s' % (base, path) + if trans: + url += '?%s' % trans.get_GET_arg() + raise cherrypy.HTTPRedirect(url) + + def auth_successful(self, trans, username, auth_type=None, userdata=None): + self.initialize_login_session(username, self.info, auth_type, userdata) + # save username into a cookie if parent was form base auth if auth_type == 'password': cookie = SecureCookie(USERNAME_COOKIE, username) @@ -91,10 +166,11 @@ class LoginManagerBase(PluginObject, Log): trans.wipe() raise cherrypy.HTTPRedirect(redirect) - def auth_failed(self, trans): + def auth_failed(self, trans, message=None): # try with next module - if self.next_login: - return self.redirect_to_path(self.next_login.path) + next_login = self.next_login() + if next_login: + return self.redirect_to_path(next_login.path, trans) # return to the caller if any session = UserSession() @@ -109,63 +185,49 @@ class LoginManagerBase(PluginObject, Log): # destroy session and return error if 'login_return' not in transdata: session.logout(None) - raise cherrypy.HTTPError(401) + raise cherrypy.HTTPError(401, message) raise cherrypy.HTTPRedirect(transdata['login_return']) + def set_auth_error(self): + cherrypy.response.status = 401 + def get_tree(self, site): raise NotImplementedError - def enable(self, site): - plugins = site[FACILITY] - if self in plugins['enabled']: - return + def register(self, root, site): + self._root = root + self._site = site + + def next_login(self): + plugins = self._site[FACILITY] + try: + idx = plugins.enabled.index(self.name) + item = plugins.enabled[idx + 1] + return plugins.available[item] + except (ValueError, IndexError): + return None + + def other_login_stacks(self): + plugins = self._site[FACILITY] + stack = list() + try: + idx = plugins.enabled.index(self.name) + except (ValueError, IndexError): + idx = None + for i in range(0, len(plugins.enabled)): + if i == idx: + continue + stack.append(plugins.available[plugins.enabled[i]]) + return stack - # configure self - if self.name in plugins['config']: - self.set_config(plugins['config'][self.name]) + def on_enable(self): # and add self to the root - root = plugins['root'] - root.add_subtree(self.name, self.get_tree(site)) - - # finally add self in login chain - prev_obj = None - for prev_obj in plugins['enabled']: - if prev_obj.next_login: - break - if prev_obj: - while prev_obj.next_login: - prev_obj = prev_obj.next_login - prev_obj.next_login = self - if not root.first_login: - root.first_login = self - - plugins['enabled'].append(self) - self._debug('Login plugin enabled: %s' % self.name) + self._root.add_subtree(self.name, self.get_tree(self._site)) # Get handle of the info plugin - self.info = root.info - - def disable(self, site): - plugins = site[FACILITY] - if self not in plugins['enabled']: - return - - # remove self from chain - root = plugins['root'] - if root.first_login == self: - root.first_login = self.next_login - elif root.first_login: - prev_obj = root.first_login - while prev_obj.next_login != self: - prev_obj = prev_obj.next_login - if prev_obj: - prev_obj.next_login = self.next_login - self.next_login = None - - plugins['enabled'].remove(self) - self._debug('Login plugin disabled: %s' % self.name) + self.info = self._root.info class LoginPageBase(Page): @@ -189,34 +251,41 @@ class LoginFormBase(LoginPageBase): def GET(self, *args, **kwargs): context = self.create_tmpl_context() - # pylint: disable=star-args return self._template(self.formtemplate, **context) def root(self, *args, **kwargs): - self.trans = Transaction('login', **kwargs) + self.trans = self.get_valid_transaction('login', **kwargs) op = getattr(self, cherrypy.request.method, self.GET) if callable(op): return op(*args, **kwargs) def create_tmpl_context(self, **kwargs): - next_url = None - if self.lm.next_login is not None: - next_url = '%s?%s' % (self.lm.next_login.path, - self.trans.get_GET_arg()) + other_stacks = None + other_login_stacks = self.lm.other_login_stacks() + if other_login_stacks: + other_stacks = list() + for ls in other_login_stacks: + url = '%s/login/%s?%s' % ( + self.basepath, ls.path, self.trans.get_GET_arg() + ) + name = ls.name + other_stacks.append({'url': url, 'name': name}) cookie = SecureCookie(USERNAME_COOKIE) cookie.receive() username = cookie.value - if username is None: - username = '' target = None if self.trans is not None: tid = self.trans.transaction_id target = self.trans.retrieve().get('login_target') + username = self.trans.retrieve().get('login_username') if tid is None: tid = '' + if username is None: + username = '' + context = { "title": 'Login', "action": '%s/%s' % (self.basepath, self.formpage), @@ -224,9 +293,11 @@ class LoginFormBase(LoginPageBase): "username_text": self.lm.username_text, "password_text": self.lm.password_text, "description": self.lm.help_text, - "next_url": next_url, + "other_stacks": other_stacks, "username": username, "login_target": target, + "cancel_url": '%s/login/cancel?%s' % (self.basepath, + self.trans.get_GET_arg()), } context.update(kwargs) if self.trans is not None: @@ -243,45 +314,112 @@ class Login(Page): def __init__(self, *args, **kwargs): super(Login, self).__init__(*args, **kwargs) - self.first_login = None + self.cancel = Cancel(*args, **kwargs) self.info = Info(self._site) - loader = PluginLoader(Login, FACILITY, 'LoginManager') - self._site[FACILITY] = loader.get_plugin_data() - plugins = self._site[FACILITY] + plugins = PluginLoader(Login, FACILITY, 'LoginManager') + plugins.get_plugin_data() + self._site[FACILITY] = plugins - available = plugins['available'].keys() - self._debug('Available login managers: %s' % str(available)) + available = plugins.available.keys() + self.debug('Available login managers: %s' % str(available)) - plugins['root'] = self - for item in plugins['whitelist']: - self._debug('Login plugin in whitelist: %s' % item) - if item not in plugins['available']: + for item in plugins.available: + plugin = plugins.available[item] + plugin.register(self, self._site) + + for item in plugins.enabled: + self.debug('Login plugin in enabled list: %s' % item) + if item not in plugins.available: continue - plugins['available'][item].enable(self._site) + plugins.available[item].enable() def add_subtree(self, name, page): self.__dict__[name] = page + def get_first_login(self): + plugin = None + plugins = self._site[FACILITY] + if plugins.enabled: + first = plugins.enabled[0] + plugin = plugins.available[first] + return plugin + def root(self, *args, **kwargs): - if self.first_login: - trans = Transaction('login', **kwargs) + plugin = self.get_first_login() + if plugin: + trans = self.get_valid_transaction('login', **kwargs) redirect = '%s/login/%s?%s' % (self.basepath, - self.first_login.path, + plugin.path, trans.get_GET_arg()) raise cherrypy.HTTPRedirect(redirect) return self._template('login/index.html', title='Login') class Logout(Page): + def __init__(self, *args, **kwargs): + super(Logout, self).__init__(*args, **kwargs) + self.handlers = {} def root(self, *args, **kwargs): - UserSession().logout(self.user) + us = UserSession() + + for provider in self.handlers: + self.debug("Calling logout for provider %s" % provider) + obj = self.handlers[provider] + obj() + + us.logout(self.user) return self._template('logout.html', title='Logout') + def add_handler(self, provider, handler): + """ + Providers can register a logout handler here that is called + when the IdP logout link is accessed. + """ + self.handlers[provider] = handler + + +class Cancel(Page): + + def GET(self, *args, **kwargs): + + session = UserSession() + session.logout(None) + + # return to the caller if any + transdata = self.get_valid_transaction('login', **kwargs).retrieve() + if 'login_return' not in transdata: + raise cherrypy.HTTPError(401) + raise cherrypy.HTTPRedirect(transdata['login_return']) + + def root(self, *args, **kwargs): + op = getattr(self, cherrypy.request.method, self.GET) + if callable(op): + return op(*args, **kwargs) + + +class LoginManagerInstaller(object): + def __init__(self): + self.facility = FACILITY + self.ptype = 'login' + self.name = None + + def unconfigure(self, opts, changes): + return + + def install_args(self, group): + raise NotImplementedError + + def validate_args(self, args): + return + + def configure(self, opts, changes): + raise NotImplementedError + class LoginMgrsInstall(object): def __init__(self): - pi = PluginInstaller(LoginMgrsInstall) + pi = PluginInstaller(LoginMgrsInstall, FACILITY) self.plugins = pi.get_plugins()