adding function to parse error object
[contrib/cloudeebus.git] / cloudeebus / cloudeebus.py
index 69e499f..49f857e 100755 (executable)
@@ -18,6 +18,7 @@
 #
 # Luc Yriarte <luc.yriarte@intel.com>
 # Christophe Guiraud <christophe.guiraud@intel.com>
+# Frederic Paut <frederic.paut@intel.com>
 #
 
 
@@ -48,13 +49,39 @@ from twisted.python import log
 # XML parser module
 from xml.etree.ElementTree import XMLParser
 
-
 ###############################################################################
 
-VERSION = "0.3.0"
+VERSION = "0.5.1"
 OPENDOOR = False
 CREDENTIALS = {}
 WHITELIST = []
+NETMASK =  []
+
+###############################################################################
+def ipV4ToHex(mask):
+    ## Convert an ip or an IP mask (such as ip/24 or ip/255.255.255.0) in hex value (32bits)
+    maskHex = 0
+    byte = 0
+    if mask.rfind(".") == -1:
+        if (int(mask) < 32):
+            maskHex = (2**(int(mask))-1)
+            maskHex = maskHex << (32-int(mask))
+        else:
+            raise Exception("Illegal mask (larger than 32 bits) " + mask)
+    else:
+        maskField = mask.split(".")
+        # Check if mask has four fields (byte)
+        if len(maskField) != 4:
+            raise Exception("Illegal ip address / mask (should be 4 bytes) " + mask)
+        for maskQuartet in maskField:
+            byte = int(maskQuartet)
+            # Check if each field is really a byte
+            if byte > 255:
+                raise Exception("Illegal ip address / mask (digit larger than a byte) " + mask)              
+            maskHex += byte
+            maskHex = maskHex << 8
+        maskHex = maskHex >> 8
+    return maskHex
 
 ###############################################################################
 class DbusCache:
@@ -153,7 +180,10 @@ class DbusCallHandler:
 
 
 ################################################################################       
-class exec_code:
+class ExecCode:
+    '''
+    Execute DynDBusClass generated code
+    '''
     def __init__(self, globalCtx, localCtx) :
         self.exec_string = ""
         self.exec_code = None
@@ -193,7 +223,7 @@ class exec_code:
 
 
 ################################################################################       
-class XmlCb_Parser: # The target object of the parser
+class XmlCbParser: # The target object of the parser
     maxDepth = 0
     depth = 0
     def __init__(self, dynDBusClass):
@@ -226,6 +256,8 @@ class XmlCb_Parser: # The target object of the parser
                                                 attrib['type'])
                 return
             if (self.current == 'signal'):
+                if (attrib.has_key('name') == False):
+                    attrib['name'] = 'value'
                 self.dynDBusClass.add_signature(attrib['name'], 'in',
                                                 attrib['type'])
                 return
@@ -247,12 +279,12 @@ class XmlCb_Parser: # The target object of the parser
 
        
 ################################################################################       
-class dynDBusClass():
+class DynDBusClass():
     def __init__(self, className, globalCtx, localCtx):
         self.className = className
-        self.xmlCB = XmlCb_Parser(self)
+        self.xmlCB = XmlCbParser(self)
         self.signature = {}
-        self.class_code = exec_code(globalCtx, localCtx)  
+        self.class_code = ExecCode(globalCtx, localCtx)  
         self.class_code.indent_increment = 4
         self.class_code.append_stmt("import dbus")
         self.class_code.append_stmt("\n")
@@ -261,9 +293,9 @@ class dynDBusClass():
         
         ## Overload of __init__ method 
         self.def_method("__init__")
-        self.add_method("bus, callback=None, objName='/sample', busName='org.cloudeebus'")
+        self.add_method("bus, callback=None, objPath='/sample', busName='org.cloudeebus'")
         self.add_stmt("self.bus = bus")
-        self.add_stmt("self.objName = objName")
+        self.add_stmt("self.objPath = objPath")
         self.add_stmt("self.callback = callback")        
         self.add_stmt("dbus.service.Object.__init__(self, conn=bus, bus_name=busName)")
         self.end_method()
@@ -271,13 +303,13 @@ class dynDBusClass():
         ## Create 'add_to_connection' method 
         self.def_method("add_to_connection")
         self.add_method("connection=None, path=None")
-        self.add_stmt("dbus.service.Object.add_to_connection(self, connection=self.bus, path=self.objName)")
+        self.add_stmt("dbus.service.Object.add_to_connection(self, connection=self.bus, path=self.objPath)")
         self.end_method()
                
         ## Create 'remove_from_connection' method 
         self.def_method("remove_from_connection")
         self.add_method("connection=None, path=None")
-        self.add_stmt("dbus.service.Object.remove_from_connection(self, connection=None, path=self.objName)")
+        self.add_stmt("dbus.service.Object.remove_from_connection(self, connection=None, path=self.objPath)")
         self.end_method()
                
     def createDBusServiceFromXML(self, xml):
@@ -374,9 +406,9 @@ class dynDBusClass():
     def add_body_method(self):
         if (self.methodToAdd != None):
             if (self.args_str != str()):
-                self.class_code.append_stmt("self.callback('" + self.methodToAdd + "', dbus_async_cb, dbus_async_err_cb, %s)" % self.args_str)
+                self.class_code.append_stmt("self.callback('" + self.methodToAdd + "', self.objPath, '"  + self.ifName + "', " + "dbus_async_cb, dbus_async_err_cb, %s)" % self.args_str)
             else:        
-                self.class_code.append_stmt("self.callback('" + self.methodToAdd + "', dbus_async_cb, dbus_async_err_cb)")
+                self.class_code.append_stmt("self.callback('" + self.methodToAdd + "', self.objPath, '"  + self.ifName + "', " + "dbus_async_cb, dbus_async_err_cb)")
 
     def add_body_signal(self):
         self.class_code.append_stmt("return") ## TODO: Remove and fix with code ad hoc
@@ -396,7 +428,9 @@ class CloudeebusService:
     support for sending DBus messages and registering for DBus signals
     '''
     def __init__(self, permissions):
-        self.permissions = permissions;
+        self.permissions = {};
+        self.permissions['permissions'] = permissions['permissions']
+        self.permissions['authextra'] = permissions['authextra']
         self.proxyObjects = {}
         self.proxyMethods = {}
         self.pendingCalls = []
@@ -416,7 +450,7 @@ class CloudeebusService:
         if not self.proxyObjects.has_key(id):
             if not OPENDOOR:
                 # check permissions, array.index throws exception
-                self.permissions.index(serviceName)
+                self.permissions['permissions'].index(serviceName)
             bus = cache.dbusConnexion(busName)
             self.proxyObjects[id] = bus.get_object(serviceName, objectName)
         return self.proxyObjects[id]
@@ -443,7 +477,7 @@ class CloudeebusService:
         
         if not OPENDOOR:
             # check permissions, array.index throws exception
-            self.permissions.index(list[1])
+            self.permissions['permissions'].index(list[1])
         
         # check if a handler exists
         sigId = "#".join(list)
@@ -485,15 +519,33 @@ class CloudeebusService:
 
 
     @exportRpc
+    def emitSignal(self, list):
+        '''
+        arguments: agentObjectPath, signalName, result (to emit)
+        '''
+        objectPath = list[0]
+        className = re.sub('/', '_', objectPath[1:])
+        signalName = list[1]
+        result = list[2]
+        if (self.serviceAgents.has_key(className) == True):
+            exe_str = "self.serviceAgents['"+ className +"']."+ signalName + "(" + str(result) + ")"
+            eval(exe_str, self.globalCtx, self.localCtx)
+        else:
+            raise Exception("No object path " + objectPath)
+
+    @exportRpc
     def returnMethod(self, list):
         '''
-        arguments: methodId, success (=true, error otherwise), result (to return)
+        arguments: methodId, callIndex, success (=true, error otherwise), result (to return)
         '''
         methodId = list[0]
-        success = list[1]
-        result = list[2]
+        callIndex = list[1]
+        success = list[2]
+        result = list[3]
         if (self.servicePendingCalls.has_key(methodId)):
-            cb = self.servicePendingCalls[methodId]
+            cb = self.servicePendingCalls[methodId]['calls'][callIndex]
+            if cb is None:
+                raise Exception("No pending call " + str(callIndex) + " for methodID " + methodId)
             if (success):                
                 successCB = cb["successCB"]
                 if (result != None):
@@ -506,74 +558,29 @@ class CloudeebusService:
                     errorCB(result)
                 else:
                     errorCB()
-            self.servicePendingCalls[methodId] = None
+            self.servicePendingCalls[methodId]['calls'][callIndex] = None
+            self.servicePendingCalls[methodId]['count'] = self.servicePendingCalls[methodId]['count'] - 1
+            if self.servicePendingCalls[methodId]['count'] == 0:
+                del self.servicePendingCalls[methodId]
         else:
-            print "No methodID %s  !!" % (methodId)  
-
-    def jsonEncodeTupleKeyDict(self, data):
-        ndict = dict()
-        # creates new dictionary with the original tuple converted to json string
-        dataLen = len(data)
-        string = ""
-        for index in range(dataLen):
-            for key in data[index]:
-                value = data[index][key]
-                print "key=" + key
-                print "value=" + str(value)
-                nkey = str(key)
-                nvalue = ""
-                print "JSON key=" + nkey
-                if (isinstance(value, dbus.Array)):
-                    # Searching dbus byte in array...
-                    ValueLen = len(value)
-                    nvalue = []
-                    for indexValue in range(ValueLen):
-                        a = value[indexValue]
-                        if (isinstance(a, dbus.Byte)):
-                            a = int(value[indexValue])
-                            nvalue.append(a)
-                        else:
-                            nvalue = str(value[indexValue])
-                            
-                print "JSON value=" + str(nvalue)                
-                ndict[nkey] =  nvalue
-
-        return ndict
-
-    def srvCB(self, name, async_succes_cb, async_error_cb, *args):
-        methodId = self.srvName + "#" + self.agentObjectPath + "#" + name
+            raise Exception("No methodID " + methodId)
+
+    def srvCB(self, name, objPath, ifName, async_succes_cb, async_error_cb, *args):
+        methodId = self.srvName + "#" + objPath + "#" + ifName + "#" + name
         cb = { 'successCB': async_succes_cb, 
                'errorCB': async_error_cb}
-        self.servicePendingCalls[methodId] = cb
-
-        if (len(args) > 0):
-            print "Received args=%s" % (str(args))
-        else:                     
-            print "No args received"
+        if methodId not in self.servicePendingCalls:
+            self.servicePendingCalls[methodId] = {'count': 0, 'calls': []}
             
-        try:               
-            print "factory.dispatch(methodId=%s, args=%s)" % (methodId, json.dumps(args))                     
-            factory.dispatch(methodId, json.dumps(args))
-            return
-        except Exception, e :
-            print "Error=%s" % (str(e))
-            
-        print "Trying to decode dbus.Dictionnary..."
         try:
-            params = self.jsonEncodeTupleKeyDict(args)                
-            print "factory.dispatch(methodId=%s, args=%s)" % (methodId, params)                     
-            factory.dispatch(methodId, params)
-            return
-        except Exception, e :
-            print "Error=%s" % (str(e))
-                    
-        print "Trying to pass args as string..."
-        try:               
-            print "factory.dispatch(methodId=%s, args=%s)" % (methodId, str(args))                     
-            factory.dispatch(methodId, str(args))
-            return
-        except Exception, e :
-            print "Error=%s" % (str(e))
+            pendingCallStr = json.dumps({'callIndex': len(self.servicePendingCalls[methodId]['calls']), 'args': args})
+        except Exception, e:                
+            args = eval( str(args).replace("dbus.Byte", "dbus.Int16") )
+            pendingCallStr = json.dumps({'callIndex': len(self.servicePendingCalls[methodId]['calls']), 'args': args})
+               
+        self.servicePendingCalls[methodId]['calls'].append(cb)
+        self.servicePendingCalls[methodId]['count'] = self.servicePendingCalls[methodId]['count'] + 1
+        factory.dispatch(methodId, pendingCallStr)
                     
     @exportRpc
     def serviceAdd(self, list):
@@ -608,13 +615,13 @@ class CloudeebusService:
         xmlTemplate = list[1]
         self.className = re.sub('/', '_', self.agentObjectPath[1:])
         if (self.dynDBusClasses.has_key(self.className) == False):
-            self.dynDBusClasses[self.className] = dynDBusClass(self.className, self.globalCtx, self.localCtx)
+            self.dynDBusClasses[self.className] = DynDBusClass(self.className, self.globalCtx, self.localCtx)
             self.dynDBusClasses[self.className].createDBusServiceFromXML(xmlTemplate)
             self.dynDBusClasses[self.className].declare()
 
         ## Class already exist, instanciate it if not already instanciated
         if (self.serviceAgents.has_key(self.className) == False):
-            self.serviceAgents[self.className] = eval(self.className + "(self.bus, callback=self.srvCB, objName=self.agentObjectPath, busName=self.srvName)", self.globalCtx, self.localCtx)
+            self.serviceAgents[self.className] = eval(self.className + "(self.bus, callback=self.srvCB, objPath=self.agentObjectPath, busName=self.srvName)", self.globalCtx, self.localCtx)
             
         self.serviceAgents[self.className].add_to_connection()
         return (self.agentObjectPath)
@@ -659,25 +666,35 @@ class CloudeebusServerProtocol(WampCraServerProtocol):
     
     
     def getAuthPermissions(self, key, extra):
-        return json.loads(extra.get("permissions", "[]"))
-    
+         return {'permissions': extra.get("permissions", None),
+                 'authextra': extra.get("authextra", None)}   
     
     def getAuthSecret(self, key):
         secret = CREDENTIALS.get(key, None)
         if secret is None:
             return None
         # secret must be of str type to be hashed
-        return secret.encode('utf-8')
+        return str(secret)
     
 
     def onAuthenticated(self, key, permissions):
         if not OPENDOOR:
+            # check net filter
+            if NETMASK != []:
+                ipAllowed = False
+                for netfilter in NETMASK:
+                    ipHex=ipV4ToHex(self.peer.host)
+                    ipAllowed = (ipHex & netfilter['mask']) == netfilter['ipAllowed'] & netfilter['mask']
+                    if ipAllowed:
+                        break
+                if not ipAllowed:
+                    raise Exception("host " + self.peer.host + " is not allowed!")
             # check authentication key
             if key is None:
                 raise Exception("Authentication failed")
             # check permissions, array.index throws exception
-            for req in permissions:
-                WHITELIST.index(req)
+            for req in permissions['permissions']:
+                    WHITELIST.index(req);
         # create cloudeebus service instance
         self.cloudeebusService = CloudeebusService(permissions)
         # register it for RPC
@@ -712,6 +729,8 @@ if __name__ == '__main__':
         help='path to credentials file')
     parser.add_argument('-w', '--whitelist',
         help='path to whitelist file')
+    parser.add_argument('-n', '--netmask',
+        help='netmask,IP filter (comma separated.) eg. : -n 127.0.0.1,192.168.2.0/24,10.12.16.0/255.255.255.0')
     
     args = parser.parse_args(sys.argv[1:])
 
@@ -733,6 +752,18 @@ if __name__ == '__main__':
         jfile = open(args.whitelist)
         WHITELIST = json.load(jfile)
         jfile.close()
+        
+    if args.netmask:
+        iplist = args.netmask.split(",")
+        for ip in iplist:
+            if ip.rfind("/") != -1:
+                ip=ip.split("/")
+                ipAllowed = ip[0]
+                mask = ip[1]
+            else:
+                ipAllowed = ip
+                mask = "255.255.255.255" 
+            NETMASK.append( {'ipAllowed': ipV4ToHex(ipAllowed), 'mask' : ipV4ToHex(mask)} )
     
     uri = "ws://localhost:" + args.port