Rename and move PluginConfig to ConfigHelper
[cascardo/ipsilon.git] / ipsilon / providers / saml2 / provider.py
old mode 100755 (executable)
new mode 100644 (file)
index 73ff005..d3cc144
@@ -1,5 +1,3 @@
-#!/usr/bin/python
-#
 # Copyright (C) 2014  Simo Sorce <simo@redhat.com>
 #
 # see file 'COPYING' for use and warranty information
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from ipsilon.providers.common import ProviderException
-import cherrypy
+from ipsilon.util import config as pconfig
+from ipsilon.util.config import ConfigHelper
+from ipsilon.tools.saml2metadata import SAML2_NAMEID_MAP
+from ipsilon.util.log import Log
 import lasso
+import re
 
 
-NAMEID_MAP = {
-    'email': lasso.SAML2_NAME_IDENTIFIER_FORMAT_EMAIL,
-    'encrypted': lasso.SAML2_NAME_IDENTIFIER_FORMAT_ENCRYPTED,
-    'entity': lasso.SAML2_NAME_IDENTIFIER_FORMAT_ENTITY,
-    'kerberos': lasso.SAML2_NAME_IDENTIFIER_FORMAT_KERBEROS,
-    'persistent': lasso.SAML2_NAME_IDENTIFIER_FORMAT_PERSISTENT,
-    'transient': lasso.SAML2_NAME_IDENTIFIER_FORMAT_TRANSIENT,
-    'unspecified': lasso.SAML2_NAME_IDENTIFIER_FORMAT_UNSPECIFIED,
-    'windows': lasso.SAML2_NAME_IDENTIFIER_FORMAT_WINDOWS,
-    'x509': lasso.SAML2_NAME_IDENTIFIER_FORMAT_X509,
-}
+VALID_IN_NAME = r'[^\ a-zA-Z0-9]'
 
 
 class InvalidProviderId(ProviderException):
@@ -45,8 +37,8 @@ class InvalidProviderId(ProviderException):
 
 class NameIdNotAllowed(Exception):
 
-    def __init__(self):
-        message = 'The specified Name ID is not allowed'
+    def __init__(self, nid):
+        message = 'Name ID [%s] is not allowed' % nid
         super(NameIdNotAllowed, self).__init__(message)
         self.message = message
 
@@ -54,9 +46,15 @@ class NameIdNotAllowed(Exception):
         return repr(self.message)
 
 
-class ServiceProvider(object):
+class ServiceProviderConfig(ConfigHelper):
+    def __init__(self):
+        super(ServiceProviderConfig, self).__init__()
+
+
+class ServiceProvider(ServiceProviderConfig):
 
     def __init__(self, config, provider_id):
+        super(ServiceProvider, self).__init__()
         self.cfg = config
         data = self.cfg.get_data(name='id', value=provider_id)
         if len(data) != 1:
@@ -65,6 +63,42 @@ class ServiceProvider(object):
         data = self.cfg.get_data(idval=idval)
         self._properties = data[idval]
         self._staging = dict()
+        self.load_config()
+
+    def load_config(self):
+        self.new_config(
+            self.provider_id,
+            pconfig.String(
+                'Name',
+                'A nickname used to easily identify the Service Provider.'
+                ' Only alphanumeric characters [A-Z,a-z,0-9] and spaces are'
+                '  accepted.',
+                self.name),
+            pconfig.Pick(
+                'Default NameID',
+                'Default NameID used by Service Providers.',
+                SAML2_NAMEID_MAP.keys(),
+                self.default_nameid),
+            pconfig.Choice(
+                'Allowed NameIDs',
+                'Allowed NameIDs for this Service Provider.',
+                SAML2_NAMEID_MAP.keys(),
+                self.allowed_nameids),
+            pconfig.String(
+                'User Owner',
+                'The user that owns this Service Provider',
+                self.owner),
+            pconfig.MappingList(
+                'Attribute Mapping',
+                'Defines how to map attributes before returning them to'
+                ' the SP. Setting this overrides the global values.',
+                self.attribute_mappings),
+            pconfig.ComplexList(
+                'Allowed Attributes',
+                'Defines a list of allowed attributes, applied after mapping.'
+                ' Setting this overrides the global values.',
+                self.allowed_attributes),
+        )
 
     @property
     def provider_id(self):
@@ -114,6 +148,44 @@ class ServiceProvider(object):
     def default_nameid(self, value):
         self._staging['default nameid'] = value
 
+    @property
+    def attribute_mappings(self):
+        if 'attribute mappings' in self._properties:
+            attr_map = pconfig.MappingList('temp', 'temp', None)
+            attr_map.import_value(str(self._properties['attribute mappings']))
+            return attr_map.get_value()
+        else:
+            return None
+
+    @attribute_mappings.setter
+    def attribute_mappings(self, attr_map):
+        if isinstance(attr_map, pconfig.MappingList):
+            value = attr_map.export_value()
+        else:
+            temp = pconfig.MappingList('temp', 'temp', None)
+            temp.set_value(attr_map)
+            value = temp.export_value()
+        self._staging['attribute mappings'] = value
+
+    @property
+    def allowed_attributes(self):
+        if 'allowed_attributes' in self._properties:
+            attr_map = pconfig.ComplexList('temp', 'temp', None)
+            attr_map.import_value(str(self._properties['allowed_attributes']))
+            return attr_map.get_value()
+        else:
+            return None
+
+    @allowed_attributes.setter
+    def allowed_attributes(self, attr_map):
+        if isinstance(attr_map, pconfig.ComplexList):
+            value = attr_map.export_value()
+        else:
+            temp = pconfig.ComplexList('temp', 'temp', None)
+            temp.set_value(attr_map)
+            value = temp.export_value()
+        self._staging['allowed_attributes'] = value
+
     def save_properties(self):
         data = self.cfg.get_data(name='id', value=self.provider_id)
         if len(data) != 1:
@@ -126,17 +198,23 @@ class ServiceProvider(object):
         self._properties = data[idval]
         self._staging = dict()
 
+    def refresh_config(self):
+        """
+        Create a new config object for displaying in the UI based on
+        the current set of properties.
+        """
+        del self._config
+        self.load_config()
+
     def get_valid_nameid(self, nip):
         self._debug('Requested NameId [%s]' % (nip.format,))
         if nip.format is None:
-            return NAMEID_MAP[self.default_nameid]
-        elif nip.format == lasso.SAML2_NAME_IDENTIFIER_FORMAT_UNSPECIFIED:
-            return NAMEID_MAP[self.default_nameid]
+            return SAML2_NAMEID_MAP[self.default_nameid]
         else:
             allowed = self.allowed_nameids
             self._debug('Allowed NameIds %s' % (repr(allowed)))
             for nameid in allowed:
-                if nip.format == NAMEID_MAP[nameid]:
+                if nip.format == SAML2_NAMEID_MAP[nameid]:
                     return nip.format
         raise NameIdNotAllowed(nip.format)
 
@@ -147,15 +225,24 @@ class ServiceProvider(object):
         idval = data.keys()[0]
         self.cfg.del_datum(idval)
 
-    def _debug(self, fact):
-        if cherrypy.config.get('debug', False):
-            cherrypy.log(fact)
-
     def normalize_username(self, username):
         if 'strip domain' in self._properties:
             return username.split('@', 1)[0]
         return username
 
+    def is_valid_name(self, value):
+        if re.search(VALID_IN_NAME, value):
+            return False
+        return True
+
+    def is_valid_nameid(self, value):
+        if value in SAML2_NAMEID_MAP:
+            return True
+        return False
+
+    def valid_nameids(self):
+        return SAML2_NAMEID_MAP.keys()
+
 
 class ServiceProviderCreator(object):
 
@@ -165,6 +252,10 @@ class ServiceProviderCreator(object):
     def create_from_buffer(self, name, metabuf):
         '''Test and add data'''
 
+        if re.search(VALID_IN_NAME, name):
+            raise InvalidProviderId("Name must contain only "
+                                    "numbers and letters")
+
         test = lasso.Server()
         test.addProviderFromBuffer(lasso.PROVIDER_ROLE_SP, metabuf)
         newsps = test.get_providers()
@@ -189,7 +280,7 @@ class ServiceProviderCreator(object):
         return ServiceProvider(self.cfg, spid)
 
 
-class IdentityProvider(object):
+class IdentityProvider(Log):
     def __init__(self, config):
         self.server = lasso.Server(config.idp_metadata_file,
                                    config.idp_key_file,
@@ -211,6 +302,8 @@ class IdentityProvider(object):
     def get_providers(self):
         return self.server.get_providers()
 
-    def _debug(self, fact):
-        if cherrypy.config.get('debug', False):
-            cherrypy.log(fact)
+    def get_logout_handler(self, dump=None):
+        if dump:
+            return lasso.Logout.newFromDump(self.server, dump)
+        else:
+            return lasso.Logout(self.server)