X-Git-Url: http://git.cascardo.info/?p=cascardo%2Fipsilon.git;a=blobdiff_plain;f=ipsilon%2Fproviders%2Fcommon.py;h=9dcfa5219188082a96f209ef2625462c3cb5f131;hp=f9c13112700d24eeb6f8ff1726998b558368a99c;hb=158c4cdefc0bd5b8dabe38685c1bebccc24d656b;hpb=7b56b1311ba0c730fa884c75ccf15dfbf996ebd8 diff --git a/ipsilon/providers/common.py b/ipsilon/providers/common.py old mode 100755 new mode 100644 index f9c1311..9dcfa52 --- a/ipsilon/providers/common.py +++ b/ipsilon/providers/common.py @@ -1,5 +1,3 @@ -#!/usr/bin/python -# # Copyright (C) 2014 Simo Sorce # # see file 'COPYING' for use and warranty information @@ -17,13 +15,17 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -from ipsilon.util.plugin import PluginLoader, PluginObject -from ipsilon.util.plugin import PluginInstaller +from ipsilon.util.log import Log +from ipsilon.util.plugin import PluginInstaller, PluginLoader +from ipsilon.util.plugin import PluginObject +from ipsilon.util.config import ConfigHelper from ipsilon.util.page import Page +from ipsilon.util.page import admin_protect +from ipsilon.rest.common import RestPage import cherrypy -class ProviderException(Exception): +class ProviderException(Exception, Log): def __init__(self, message): super(ProviderException, self).__init__(message) @@ -32,53 +34,47 @@ class ProviderException(Exception): def __str__(self): return repr(self.message) - def _debug(self, fact): - if cherrypy.config.get('debug', False): - cherrypy.log('%s: %s' % (self.__class__.__name__, fact)) +class AuthenticationError(ProviderException): -class ProviderBase(PluginObject): + def __init__(self, message, code): + super(AuthenticationError, self).__init__(message) + self.code = code + self.debug('%s [%s]' % (message, code)) - def __init__(self, name, path): - super(ProviderBase, self).__init__() - self.name = name - self.path = path - self.admin = None - def _debug(self, fact): - if cherrypy.config.get('debug', False): - cherrypy.log(fact) +class InvalidRequest(ProviderException): + + def __init__(self, message): + super(InvalidRequest, self).__init__(message) + self.debug(message) - def get_tree(self, site): - raise NotImplementedError - def enable(self, site): - plugins = site[FACILITY] - if self in plugins['enabled']: - return +class ProviderBase(ConfigHelper, PluginObject): - # configure self - if self.name in plugins['config']: - self.set_config(plugins['config'][self.name]) + def __init__(self, name, path, *pargs): + ConfigHelper.__init__(self) + PluginObject.__init__(self, *pargs) + self.name = name + self._root = None + self.path = path + self.tree = None - # and add self to the root - root = plugins['root'] - root.add_subtree(self.name, self.get_tree(site)) + def get_tree(self, site): + raise NotImplementedError - plugins['enabled'].append(self) - self._debug('IdP Provider enabled: %s' % self.name) + def register(self, root, site): - def disable(self, site): - plugins = site[FACILITY] - if self not in plugins['enabled']: - return + self._root = root + # init pages and admin interfaces + self.tree = self.get_tree(site) + self.debug('IdP Provider registered: %s' % self.name) - # remove self to the root - root = plugins['root'] - root.del_subtree(self.name) + def on_enable(self): + self._root.add_subtree(self.name, self.tree) - plugins['enabled'].remove(self) - self._debug('IdP Provider disabled: %s' % self.name) + def on_disable(self): + self._root.del_subtree(self.name) class ProviderPageBase(Page): @@ -95,15 +91,21 @@ class ProviderPageBase(Page): raise cherrypy.HTTPError(501) def root(self, *args, **kwargs): - op = getattr(self, cherrypy.request.method, self.GET) + method = cherrypy.request.method + + preop = getattr(self, 'pre_%s' % method, None) + if preop and callable(preop): + preop(*args, **kwargs) + + op = getattr(self, method, self.GET) if callable(op): return op(*args, **kwargs) else: raise cherrypy.HTTPError(405) - def _debug(self, fact): + def debug(self, fact): superfact = '%s: %s' % (self.plugin_name, fact) - super(ProviderPageBase, self)._debug(superfact) + super(ProviderPageBase, self).debug(superfact) def _audit(self, fact): cherrypy.log('%s: %s' % (self.plugin_name, fact)) @@ -112,30 +114,92 @@ class ProviderPageBase(Page): FACILITY = 'provider_config' -class LoadProviders(object): +class ProviderInstaller(object): + def __init__(self): + self.facility = FACILITY + self.ptype = 'provider' + self.name = None + + def unconfigure(self, opts): + return + + def install_args(self, group): + raise NotImplementedError + + def validate_args(self, args): + return + + def configure(self, opts): + raise NotImplementedError + + +class LoadProviders(Log): def __init__(self, root, site): - loader = PluginLoader(LoadProviders, FACILITY, 'IdpProvider') - site[FACILITY] = loader.get_plugin_data() - providers = site[FACILITY] + plugins = PluginLoader(LoadProviders, FACILITY, 'IdpProvider') + plugins.get_plugin_data() + site[FACILITY] = plugins - available = providers['available'].keys() - self._debug('Available providers: %s' % str(available)) + available = plugins.available.keys() + self.debug('Available providers: %s' % str(available)) - providers['root'] = root - for item in providers['whitelist']: - self._debug('IdP Provider in whitelist: %s' % item) - if item not in providers['available']: - continue - providers['available'][item].enable(site) + for item in plugins.available: + plugin = plugins.available[item] + plugin.register(root, site) - def _debug(self, fact): - if cherrypy.config.get('debug', False): - cherrypy.log(fact) + for item in plugins.enabled: + self.debug('Provider plugin in enabled list: %s' % item) + if item not in plugins.available: + continue + plugins.available[item].enable() class ProvidersInstall(object): def __init__(self): - pi = PluginInstaller(ProvidersInstall) + pi = PluginInstaller(ProvidersInstall, FACILITY) self.plugins = pi.get_plugins() + + +class RestProviderBase(RestPage): + + def __init__(self, site, config): + super(RestProviderBase, self).__init__(site) + self.plugin_name = config.name + self.cfg = config + + @admin_protect + def GET(self, *args, **kwargs): + raise cherrypy.HTTPError(501) + + @admin_protect + def POST(self, *args, **kwargs): + raise cherrypy.HTTPError(501) + + @admin_protect + def DELETE(self, *args, **kwargs): + raise cherrypy.HTTPError(501) + + @admin_protect + def PUT(self, *args, **kwargs): + raise cherrypy.HTTPError(501) + + def root(self, *args, **kwargs): + method = cherrypy.request.method + + preop = getattr(self, 'pre_%s' % method, None) + if preop and callable(preop): + preop(*args, **kwargs) + + op = getattr(self, method, self.GET) + if callable(op): + return op(*args, **kwargs) + else: + raise cherrypy.HTTPError(405) + + def debug(self, fact): + superfact = '%s: %s' % (self.plugin_name, fact) + super(RestProviderBase, self).debug(superfact) + + def _audit(self, fact): + cherrypy.log('%s: %s' % (self.plugin_name, fact))