15 from importlib import import_module
26 sys.stderr = open('/var/log/osecfs_error.log', 'a+')
29 MINOPTS = { "Main" : ["Logfile", "LogLevel", "Mountpoint", "Rootpath", "ScannerPath", "ScannerModuleName", "ScannerClassName", "ScannerConfig", "ReadOnly"]}
31 CONFIG_NOT_READABLE = "Configfile is not readable"
32 CONFIG_WRONG = "Something is wrong with the config"
33 CONFIG_MISSING = "Section: \"%s\" Option: \"%s\" in configfile is missing"
34 SCAN_WRONG_RETURN_VALUE = "The return Value of the malware scanner is wrong. Has to be an dictionary"
35 SCAN_RETURN_VALUE_KEY_MISSING = "The dictionary has to include key \"infected\" (True, False) and \"virusname\" (String)"
36 VIRUS_FOUND = "Virus found. Access denied"
37 NOTIFICATION_CRITICAL = "critical"
38 NOTIFICATION_INFO = "info"
43 SYSTEM_FILE_COMMAND = "file"
44 httpPool = urllib3.PoolManager(num_pools = 1, timeout = 3)
46 def checkMinimumOptions (config):
47 for section, options in MINOPTS.iteritems ():
48 for option in options:
49 if (config.has_option(section, option) == False):
50 print (CONFIG_MISSING % (section, option))
55 print ("%s configfile mountpath ro/rw" % (sys.argv[0]))
61 if (len (sys.argv) < 4):
64 configfile = sys.argv[1]
65 config = ConfigParser.SafeConfigParser ()
67 if ((os.path.exists (configfile) == False) or (os.path.isfile (configfile) == False) or (os.access (configfile, os.R_OK) == False)):
68 print (CONFIG_NOT_READABLE)
72 config.read (sys.argv[1])
75 print ("Error: %s" % (e))
78 config.set("Main", "Mountpoint", sys.argv[2])
79 if (sys.argv[3] == "rw"):
80 config.set("Main", "ReadOnly", "false")
82 config.set("Main", "ReadOnly", "true")
84 checkMinimumOptions (config)
92 logfile = config.get("Main", "Logfile")
94 numeric_level = getattr(logging, config.get("Main", "LogLevel").upper(), None)
95 if not isinstance(numeric_level, int):
96 raise ValueError('Invalid log level: %s' % loglevel)
98 # ToDo move log level and maybe other things to config file
100 level = numeric_level,
101 format = "%(asctime)s %(name)-12s %(funcName)-15s %(levelname)-8s %(message)s",
102 datefmt = "%Y-%m-%d %H:%M:%S",
106 LOG = logging.getLogger("fuse_main")
110 return ".%s" % (path)
112 def rootPath (rootpath, path):
113 return "%s%s" % (rootpath, path)
115 def flag2mode (flags):
116 md = {os.O_RDONLY: 'r', os.O_WRONLY: 'w', os.O_RDWR: 'w+'}
117 m = md[flags & (os.O_RDONLY | os.O_WRONLY | os.O_RDWR)]
119 # windows sets append even if it would overwrite the whole file (seek 0)
120 # so ignore append option
121 #if flags | os.O_APPEND:
122 # m = m.replace('w', 'a', 1)
126 def scanFile (path, fileobject):
127 LOG.debug ("Scan File \"%s\" with malware Scanner" %(path,) )
128 return MalwareScanner.scanFile (path, fileobject)
131 def scanFileClamAV (path):
134 LOG.debug ("Scan File: %s" % (path))
136 result = pyclamav.scanfile (path)
137 LOG.debug ("Result of file \"%s\": %s" % (path, result))
141 if (infected == True):
142 LOG.error ("Virus found, deny Access %s" % (result,))
146 def whitelistFile (path):
149 LOG.debug ("Execute \"%s\" command on \"%s\"" %(SYSTEM_FILE_COMMAND, path))
153 result = subprocess.check_output ([SYSTEM_FILE_COMMAND, path]);
154 # ToDo replace with real whitelist
156 except Exception as e:
157 LOG.error ("Call returns with an error!")
160 LOG.debug ("Type: %s" %(result))
164 def sendDataToRest (urlpath, data):
165 netifaces.ifaddresses("eth0")[2][0]["addr"]
167 # Get first address in network (0 = network ip -> 192.168.0.0)
168 remote_ip = netaddr.IPNetwork("%s/%s" %(netifaces.ifaddresses("eth0")[2][0]["addr"], netifaces.ifaddresses("eth0")[2][0]["netmask"]))[1]
170 url = ("http://%s:8090//%s" %(remote_ip, urlpath))
172 LOG.debug ("Send data to \"%s\"" %(url, ))
173 LOG.debug ("Data: %s" %(data, ))
176 response = httpPool.request_encode_body("POST", url, fields=data, retries=0)
178 LOG.error("Remote host not reachable")
179 LOG.error ("Exception: %s" %(e,))
182 if response.status == STATUS_CODE_OK:
183 LOG.info("Data sent successfully to rest server")
186 LOG.error("Server returned errorcode: %s" %(response.status,))
190 def sendNotification (type, message):
191 data = {"type" : type, "message" : message}
192 sendDataToRest ("notification", data)
194 def sendReadOnlyNotification():
195 sendNotification("critical", "Filesystem is in read only mode. If you want to export files please initialize an encrypted filesystem.")
197 def sendLogNotPossibleNotification():
198 sendNotification ("critical", "Send log entry to opensecurity rest server failed.")
200 def sendFileLog(filename, filesize, filehash, hashtype):
201 data = {"filename" : filename, "filesize" : "%s" %(filesize,), "filehash" : filehash, "hashtype" : hashtype}
202 retval = sendDataToRest ("log", data)
203 if (retval == False):
204 sendLogNotPossibleNotification()
206 def calcMD5 (path, block_size=256*128, hr=True):
208 with open(path,'rb') as f:
209 for chunk in iter(lambda: f.read(block_size), b''):
212 return md5.hexdigest()
220 def __init__(self, rootpath, *args, **kw):
221 self.__rootpath = rootpath
222 Fuse.__init__ (self, *args, **kw)
223 LOG.debug ("Init complete.")
224 sendNotification("information", "Filesystem successfully mounted.")
226 # defines that our working directory will be the __rootpath
228 os.chdir (self.__rootpath)
230 def getattr(self, path):
231 LOG.debug ("*** getattr (%s)" % (fixPath (path)))
232 return os.lstat (fixPath (path));
234 def getdir(self, path):
235 LOG.debug ("*** getdir (%s)" % (path));
236 return os.listdir (fixPath (path))
238 def readdir(self, path, offset):
239 LOG.debug ("*** readdir (%s %s)" % (path, offset));
240 for e in os.listdir (fixPath (path)):
241 yield fuse.Direntry(e)
243 def chmod (self, path, mode):
244 LOG.debug ("*** chmod %s %s" % (path, oct(mode)))
245 if (config.get("Main", "ReadOnly") == "true"):
246 sendReadOnlyNotification()
248 os.chmod (fixPath (path), mode)
250 def chown (self, path, uid, gid):
251 LOG.debug ("*** chown %s %s %s" % (path, uid, gid))
252 if (config.get("Main", "ReadOnly") == "true"):
253 sendReadOnlyNotification()
255 os.chown (fixPath (path), uid, gid)
257 def link (self, targetPath, linkPath):
258 LOG.debug ("*** link %s %s" % (targetPath, linkPath))
259 if (config.get("Main", "ReadOnly") == "true"):
260 sendReadOnlyNotification()
262 os.link (fixPath (targetPath), fixPath (linkPath))
264 def mkdir (self, path, mode):
265 LOG.debug ("*** mkdir %s %s" % (path, oct(mode)))
266 if (config.get("Main", "ReadOnly") == "true"):
267 sendReadOnlyNotification()
269 os.mkdir (fixPath (path), mode)
271 def mknod (self, path, mode, dev):
272 LOG.debug ("*** mknod %s %s %s" % (path, oct (mode), dev))
273 if (config.get("Main", "ReadOnly") == "true"):
274 sendReadOnlyNotification()
276 os.mknod (fixPath (path), mode, dev)
278 # to implement virus scan
279 def open (self, path, flags):
280 LOG.debug ("*** open %s %s" % (path, oct (flags)))
281 self.file = os.fdopen (os.open (fixPath (path), flags), flag2mode (flags))
283 self.fd = self.file.fileno ()
285 LOG.debug(self.__rootpath)
288 retval = scanFile (rootPath(self.__rootpath, path), self.file)
290 #if type(retval) is not dict:
291 if (isinstance(retval, dict) == False):
292 LOG.error(SCAN_WRONG_RETURN_VALUE)
296 if ((retval.has_key("infected") == False) or (retval.has_key("virusname") == False)):
297 LOG.error(SCAN_RETURN_VALUE_KEY_MISSING)
302 if (retval.get("infected") == True):
304 sendNotification(NOTIFICATION_CRITICAL, "%s\nFile: %s\nVirus: %s" %(VIRUS_FOUND, path, retval.get("virusname")))
305 LOG.error("%s" %(VIRUS_FOUND,))
306 LOG.error("Virus: %s" %(retval.get("virusname"),))
309 whitelisted = whitelistFile (rootPath(self.__rootpath, path))
310 if (whitelisted == False):
312 sendNotification(NOTIFICATION_CRITICAL, "File not in whitelist. Access denied.")
315 def read (self, path, length, offset):
316 LOG.debug ("*** read %s %s %s" % (path, length, offset))
317 self.file.seek (offset)
318 return self.file.read (length)
320 def readlink (self, path):
321 LOG.debug ("*** readlink %s" % (path))
322 return os.readlink (fixPath (path))
324 def release (self, path, flags):
325 LOG.debug ("*** release %s %s" % (path, oct (flags)))
328 if (self.written == True):
329 hashsum = calcMD5(fixPath(path))
330 filesize = os.path.getsize(fixPath(path))
331 sendFileLog(path, filesize, hashsum, "md5")
334 def rename (self, oldPath, newPath):
335 LOG.debug ("*** rename %s %s %s" % (oldPath, newPath, config.get("Main", "ReadOnly")))
336 if (config.get("Main", "ReadOnly") == "true"):
337 sendReadOnlyNotification()
339 os.rename (fixPath (oldPath), fixPath (newPath))
341 def rmdir (self, path):
342 LOG.debug ("*** rmdir %s %s" % (path, config.get("Main", "ReadOnly")))
343 if (config.get("Main", "ReadOnly") == "true"):
344 sendReadOnlyNotification()
346 os.rmdir (fixPath (path))
349 LOG.debug ("*** statfs")
350 return os.statvfs(".")
352 def symlink (self, targetPath, linkPath):
353 LOG.debug ("*** symlink %s %s %s" % (targetPath, linkPath, config.get("Main", "ReadOnly")))
354 if (config.get("Main", "ReadOnly") == "true"):
355 sendReadOnlyNotification()
357 os.symlink (fixPath (targetPath), fixPath (linkPath))
359 def truncate (self, path, length):
360 LOG.debug ("*** truncate %s %s %s" % (path, length, config.get("Main", "ReadOnly")))
361 if (config.get("Main", "ReadOnly") == "true"):
362 sendReadOnlyNotification()
364 f = open (fixPath (path), "w+")
368 def unlink (self, path):
369 LOG.debug ("*** unlink %s %s" % (path, config.get("Main", "ReadOnly")))
370 if (config.get("Main", "ReadOnly") == "true"):
371 sendReadOnlyNotification()
373 os.unlink (fixPath (path))
375 def utime (self, path, times):
376 LOG.debug ("*** utime %s %s" % (path, times))
377 os.utime (fixPath (path), times)
379 def write (self, path, buf, offset):
380 #LOG.debug ("*** write %s %s %s %s" % (path, buf, offset, config.get("Main", "ReadOnly")))
381 LOG.debug ("*** write %s %s %s %s" % (path, "filecontent", offset, config.get("Main", "ReadOnly")))
382 if (config.get("Main", "ReadOnly") == "true"):
384 sendReadOnlyNotification()
386 self.file.seek (offset)
387 self.file.write (buf)
391 def access (self, path, mode):
392 LOG.debug ("*** access %s %s" % (path, oct (mode)))
393 if not os.access (fixPath (path), mode):
396 def create (self, path, flags, mode):
397 LOG.debug ("*** create %s %s %s %s %s" % (fixPath (path), oct (flags), oct (mode), flag2mode (flags), config.get("Main", "ReadOnly")))
398 if (config.get("Main", "ReadOnly") == "true"):
399 sendReadOnlyNotification()
402 self.file = os.fdopen (os.open (fixPath (path), flags), flag2mode(flags))
404 self.fd = self.file.fileno ()
407 if __name__ == "__main__":
409 fuse.fuse_python_api = (0, 2)
410 fuse.feature_assert ('stateful_files', 'has_init')
412 config = loadConfig ()
415 #sendNotification("Info", "OsecFS started")
417 # Import the Malware Scanner
418 sys.path.append(config.get("Main", "ScannerPath"))
420 MalwareModule = import_module(config.get("Main", "ScannerModuleName"))
421 MalwareClass = getattr(MalwareModule, config.get("Main", "ScannerClassName"))
423 MalwareScanner = MalwareClass (config.get("Main", "ScannerConfig"));
425 osecfs = OsecFS (config.get ("Main", "Rootpath"))
427 osecfs.multithreaded = 0
429 fuse_args = [sys.argv[0], config.get ("Main", "Mountpoint")];
430 osecfs.main (fuse_args)