3 # Copyright (C) 2013 Simo Sorce <simo@redhat.com>
5 # see file 'COPYING' for use and warranty information
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 from ipsilon.util.page import Page
21 from ipsilon.util.user import UserSession
22 from ipsilon.util.plugin import PluginLoader, PluginObject
23 from ipsilon.util.plugin import PluginInstaller
27 class LoginManagerBase(PluginObject):
30 super(LoginManagerBase, self).__init__()
32 self.next_login = None
34 def redirect_to_path(self, path):
35 base = cherrypy.config.get('base.mount', "")
36 raise cherrypy.HTTPRedirect('%s/login/%s' % (base, path))
38 def auth_successful(self, username, userdata=None):
39 # save ref before calling UserSession login() as it
40 # may regenerate the session
41 session = UserSession()
42 ref = session.get_data('login', 'Return')
44 ref = cherrypy.config.get('base.mount', "") + '/'
46 session.login(username)
48 # Save additional data provided by the login manager
51 session.save_data('user', key, userdata[key])
53 raise cherrypy.HTTPRedirect(ref)
55 def auth_failed(self):
56 # try with next module
58 return self.redirect_to_path(self.next_login.path)
60 # return to the caller if any
61 session = UserSession()
62 ref = session.get_data('login', 'Return')
64 # otherwise destroy session and return error
67 raise cherrypy.HTTPError(401)
69 raise cherrypy.HTTPRedirect(ref)
71 def _debug(self, fact):
72 if cherrypy.config.get('debug', False):
75 def get_tree(self, site):
76 raise NotImplementedError
78 def enable(self, site):
79 plugins = site[FACILITY]
80 if self in plugins['enabled']:
84 if self.name in plugins['config']:
85 self.set_config(plugins['config'][self.name])
87 # and add self to the root
88 root = plugins['root']
89 root.add_subtree(self.name, self.get_tree(site))
91 # finally add self in login chain
93 for prev_obj in plugins['enabled']:
94 if prev_obj.next_login:
97 while prev_obj.next_login:
98 prev_obj = prev_obj.next_login
99 prev_obj.next_login = self
100 if not root.first_login:
101 root.first_login = self
103 plugins['enabled'].append(self)
104 self._debug('Login plugin enabled: %s' % self.name)
106 def disable(self, site):
107 plugins = site[FACILITY]
108 if self not in plugins['enabled']:
111 #remove self from chain
112 root = plugins['root']
113 if root.first_login == self:
114 root.first_login = self.next_login
115 elif root.first_login:
116 prev_obj = root.first_login
117 while prev_obj.next_login != self:
118 prev_obj = prev_obj.next_login
120 prev_obj.next_login = self.next_login
121 self.next_login = None
123 plugins['enabled'].remove(self)
124 self._debug('Login plugin disabled: %s' % self.name)
127 class LoginPageBase(Page):
129 def __init__(self, site, mgr):
130 super(LoginPageBase, self).__init__(site)
133 def root(self, *args, **kwargs):
134 raise cherrypy.HTTPError(500)
137 FACILITY = 'login_config'
142 def __init__(self, *args, **kwargs):
143 super(Login, self).__init__(*args, **kwargs)
144 self.first_login = None
146 loader = PluginLoader(Login, FACILITY, 'LoginManager')
147 self._site[FACILITY] = loader.get_plugin_data()
148 plugins = self._site[FACILITY]
150 available = plugins['available'].keys()
151 self._debug('Available login managers: %s' % str(available))
153 plugins['root'] = self
154 for item in plugins['whitelist']:
155 self._debug('Login plugin in whitelist: %s' % item)
156 if item not in plugins['available']:
158 plugins['available'][item].enable(self._site)
160 def add_subtree(self, name, page):
161 self.__dict__[name] = page
163 def root(self, *args, **kwargs):
165 raise cherrypy.HTTPRedirect('%s/login/%s' %
167 self.first_login.path))
168 return self._template('login/index.html', title='Login')
173 def root(self, *args, **kwargs):
174 UserSession().logout(self.user)
175 return self._template('logout.html', title='Logout')
178 class LoginMgrsInstall(object):
181 pi = PluginInstaller(LoginMgrsInstall)
182 self.plugins = pi.get_plugins()