-#!/usr/bin/python
-#
# Copyright (C) 2014 Simo Sorce <simo@redhat.com>
#
# see file 'COPYING' for use and warranty information
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-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, PluginConfig
from ipsilon.util.page import Page
+from ipsilon.rest.common import RestPage
import cherrypy
-class ProviderException(Exception):
+class ProviderException(Exception, Log):
def __init__(self, message):
super(ProviderException, self).__init__(message)
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):
+
+ def __init__(self, message, code):
+ super(AuthenticationError, self).__init__(message)
+ self.code = code
+ self._debug('%s [%s]' % (message, code))
+
+
+class InvalidRequest(ProviderException):
+
+ def __init__(self, message):
+ super(InvalidRequest, self).__init__(message)
+ self._debug(message)
-class ProviderBase(PluginObject):
+class ProviderBase(PluginConfig, PluginObject):
- def __init__(self, name, path):
- super(ProviderBase, self).__init__()
+ def __init__(self, name, path, *pargs):
+ PluginConfig.__init__(self)
+ PluginObject.__init__(self, *pargs)
self.name = name
+ self._root = None
self.path = path
self.tree = None
- self.admin = None
-
- def _debug(self, fact):
- if cherrypy.config.get('debug', False):
- cherrypy.log(fact)
def get_tree(self, site):
raise NotImplementedError
- def register(self, site):
- if self.tree:
- # already registered
- return
-
- # configure self
- plugins = site[FACILITY]
- if self.name in plugins['config']:
- self.set_config(plugins['config'][self.name])
+ def register(self, root, site):
+ self._root = root
# init pages and admin interfaces
self.tree = self.get_tree(site)
-
self._debug('IdP Provider registered: %s' % self.name)
- if self.get_config_value('enabled') == '1':
- # and add self to the root
- root = site[FACILITY]['root']
- root.add_subtree(self.name, self.tree)
- self._debug('IdP Provider enabled: %s' % self.name)
-
- @property
- def is_enabled(self):
- if self.get_config_value('enabled') == '1':
- return True
- return False
-
- def enable(self, site):
- if self.is_enabled:
- return
-
- # and add self to the root
- root = site[FACILITY]['root']
- root.add_subtree(self.name, self.tree)
+ def on_enable(self):
+ self._root.add_subtree(self.name, self.tree)
- self.set_config_value('enabled', '1')
- self.save_plugin_config(FACILITY)
- self._debug('IdP Provider enabled: %s' % self.name)
-
- def disable(self, site):
- if not self.is_enabled:
- return
-
- # remove self to the root
- root = site[FACILITY]['root']
- root.del_subtree(self.name)
-
- self.set_config_value('enabled', '0')
- self.save_plugin_config(FACILITY)
- self._debug('IdP Provider disabled: %s' % self.name)
+ def on_disable(self):
+ self._root.del_subtree(self.name)
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:
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 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()
+ available = plugins.available.keys()
self._debug('Available providers: %s' % str(available))
- providers['root'] = root
- for item in providers['available']:
- plugin = providers['available'][item]
- plugin.register(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
+
+ def GET(self, *args, **kwargs):
+ raise cherrypy.HTTPError(501)
+
+ def POST(self, *args, **kwargs):
+ raise cherrypy.HTTPError(501)
+
+ def DELETE(self, *args, **kwargs):
+ raise cherrypy.HTTPError(501)
+
+ 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))