qubes.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764
  1. #!/usr/bin/python2
  2. #
  3. # The Qubes OS Project, http://www.qubes-os.org
  4. #
  5. # Copyright (C) 2010 Joanna Rutkowska <joanna@invisiblethingslab.com>
  6. #
  7. # This program is free software; you can redistribute it and/or
  8. # modify it under the terms of the GNU General Public License
  9. # as published by the Free Software Foundation; either version 2
  10. # of the License, or (at your option) any later version.
  11. #
  12. # This program is distributed in the hope that it will be useful,
  13. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. # GNU General Public License for more details.
  16. #
  17. # You should have received a copy of the GNU General Public License
  18. # along with this program; if not, write to the Free Software
  19. # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20. #
  21. #
  22. import sys
  23. import os
  24. import os.path
  25. import lxml.etree
  26. import xml.parsers.expat
  27. import fcntl
  28. import time
  29. import warnings
  30. import tempfile
  31. import grp
  32. # Do not use XenAPI or create/read any VM files
  33. # This is for testing only!
  34. dry_run = False
  35. #dry_run = True
  36. if not dry_run:
  37. import xen.lowlevel.xc
  38. import xen.lowlevel.xl
  39. import xen.lowlevel.xs
  40. qubes_base_dir = "/var/lib/qubes"
  41. system_path = {
  42. 'qubes_guid_path': '/usr/bin/qubes-guid',
  43. 'qrexec_daemon_path': '/usr/lib/qubes/qrexec-daemon',
  44. 'qrexec_client_path': '/usr/lib/qubes/qrexec-client',
  45. 'qubes_base_dir': qubes_base_dir,
  46. 'qubes_appvms_dir': qubes_base_dir + '/appvms',
  47. 'qubes_templates_dir': qubes_base_dir + '/vm-templates',
  48. 'qubes_servicevms_dir': qubes_base_dir + '/servicevms',
  49. 'qubes_store_filename': qubes_base_dir + '/qubes.xml',
  50. 'qubes_kernels_base_dir': qubes_base_dir + '/vm-kernels',
  51. 'qubes_icon_dir': '/usr/share/qubes/icons',
  52. 'config_template_pv': '/usr/share/qubes/vm-template.conf',
  53. 'qubes_pciback_cmd': '/usr/lib/qubes/unbind-pci-device.sh',
  54. 'prepare_volatile_img_cmd': '/usr/lib/qubes/prepare-volatile-img.sh',
  55. 'monitor_layout_notify_cmd': '/usr/bin/qubes-monitor-layout-notify',
  56. }
  57. vm_files = {
  58. 'root_img': 'root.img',
  59. 'rootcow_img': 'root-cow.img',
  60. 'volatile_img': 'volatile.img',
  61. 'clean_volatile_img': 'clean-volatile.img.tar',
  62. 'private_img': 'private.img',
  63. 'kernels_subdir': 'kernels',
  64. 'firewall_conf': 'firewall.xml',
  65. 'whitelisted_appmenus': 'whitelisted-appmenus.list',
  66. 'updates_stat_file': 'updates.stat',
  67. }
  68. defaults = {
  69. 'memory': 400,
  70. 'kernelopts': "nopat",
  71. 'kernelopts_pcidevs': "nopat iommu=soft swiotlb=4096",
  72. 'dom0_update_check_interval': 6*3600,
  73. # how long (in sec) to wait for VMs to shutdown,
  74. # before killing them (when used qvm-run with --wait option),
  75. 'shutdown_counter_max': 60,
  76. 'vm_default_netmask': "255.255.255.0",
  77. # Set later
  78. 'appvm_label': None,
  79. 'template_label': None,
  80. 'servicevm_label': None,
  81. }
  82. qubes_max_qid = 254
  83. qubes_max_netid = 254
  84. class QubesException (Exception):
  85. pass
  86. if not dry_run:
  87. xc = xen.lowlevel.xc.xc()
  88. xs = xen.lowlevel.xs.xs()
  89. xl_ctx = xen.lowlevel.xl.ctx()
  90. class QubesHost(object):
  91. def __init__(self):
  92. self.physinfo = xc.physinfo()
  93. self.xen_total_mem = long(self.physinfo['total_memory'])
  94. self.xen_no_cpus = self.physinfo['nr_cpus']
  95. # print "QubesHost: total_mem = {0}B".format (self.xen_total_mem)
  96. # print "QubesHost: free_mem = {0}".format (self.get_free_xen_memory())
  97. # print "QubesHost: total_cpus = {0}".format (self.xen_no_cpus)
  98. @property
  99. def memory_total(self):
  100. return self.xen_total_mem
  101. @property
  102. def no_cpus(self):
  103. return self.xen_no_cpus
  104. def get_free_xen_memory(self):
  105. ret = self.physinfo['free_memory']
  106. return long(ret)
  107. def measure_cpu_usage(self, previous=None, previous_time = None,
  108. wait_time=1):
  109. """measure cpu usage for all domains at once"""
  110. if previous is None:
  111. previous_time = time.time()
  112. previous = {}
  113. info = xc.domain_getinfo(0, qubes_max_qid)
  114. for vm in info:
  115. previous[vm['domid']] = {}
  116. previous[vm['domid']]['cpu_time'] = (
  117. vm['cpu_time'] / vm['online_vcpus'])
  118. previous[vm['domid']]['cpu_usage'] = 0
  119. time.sleep(wait_time)
  120. current_time = time.time()
  121. current = {}
  122. info = xc.domain_getinfo(0, qubes_max_qid)
  123. for vm in info:
  124. current[vm['domid']] = {}
  125. current[vm['domid']]['cpu_time'] = (
  126. vm['cpu_time'] / max(vm['online_vcpus'], 1))
  127. if vm['domid'] in previous.keys():
  128. current[vm['domid']]['cpu_usage'] = (
  129. float(current[vm['domid']]['cpu_time'] -
  130. previous[vm['domid']]['cpu_time']) /
  131. long(1000**3) / (current_time-previous_time) * 100)
  132. if current[vm['domid']]['cpu_usage'] < 0:
  133. # VM has been rebooted
  134. current[vm['domid']]['cpu_usage'] = 0
  135. else:
  136. current[vm['domid']]['cpu_usage'] = 0
  137. return (current_time, current)
  138. class QubesVmLabel(object):
  139. def __init__(self, index, color, name, icon = None):
  140. self.name = name
  141. self.index = index
  142. self.color = color
  143. self.icon = icon if icon is not None else name
  144. self.icon_path = os.path.join(
  145. system_path['qubes_icon_dir'], self.icon) + ".png"
  146. # Globally defined lables
  147. QubesVmLabels = {
  148. "red": QubesVmLabel(1, "0xcc0000", "red" ),
  149. "orange": QubesVmLabel(2, "0xf57900", "orange" ),
  150. "yellow": QubesVmLabel(3, "0xedd400", "yellow" ),
  151. "green": QubesVmLabel(4, "0x73d216", "green" ),
  152. "gray": QubesVmLabel(5, "0x555753", "gray" ),
  153. "blue": QubesVmLabel(6, "0x3465a4", "blue" ),
  154. "purple": QubesVmLabel(7, "0x75507b", "purple" ),
  155. "black": QubesVmLabel(8, "0x000000", "black" ),
  156. }
  157. QubesDispVmLabels = {
  158. "red": QubesVmLabel(1, "0xcc0000", "red", icon="dispvm-red" ),
  159. "orange": QubesVmLabel(2, "0xf57900", "orange", icon="dispvm-orange"),
  160. "yellow": QubesVmLabel(3, "0xedd400", "yellow", icon="dispvm-yellow"),
  161. "green": QubesVmLabel(4, "0x73d216", "green", icon="dispvm-green" ),
  162. "gray": QubesVmLabel(5, "0x555753", "gray", icon="dispvm-gray" ),
  163. "blue": QubesVmLabel(6, "0x3465a4", "blue", icon="dispvm-blue" ),
  164. "purple": QubesVmLabel(7, "0x75507b", "purple", icon="dispvm-purple"),
  165. "black": QubesVmLabel(8, "0x000000", "black", icon="dispvm-black" ),
  166. }
  167. defaults["appvm_label"] = QubesVmLabels["red"]
  168. defaults["template_label"] = QubesVmLabels["black"]
  169. defaults["servicevm_label"] = QubesVmLabels["red"]
  170. QubesVmClasses = {}
  171. def register_qubes_vm_class(vm_class):
  172. QubesVmClasses[vm_class.__name__] = vm_class
  173. # register class as local for this module - to make it easy to import from
  174. # other modules
  175. setattr(sys.modules[__name__], vm_class.__name__, vm_class)
  176. class QubesVmCollection(dict):
  177. """
  178. A collection of Qubes VMs indexed by Qubes id (qid)
  179. """
  180. def __init__(self, store_filename=system_path["qubes_store_filename"]):
  181. super(QubesVmCollection, self).__init__()
  182. self.default_netvm_qid = None
  183. self.default_fw_netvm_qid = None
  184. self.default_template_qid = None
  185. self.default_kernel = None
  186. self.updatevm_qid = None
  187. self.qubes_store_filename = store_filename
  188. self.clockvm_qid = None
  189. self.qubes_store_file = None
  190. def values(self):
  191. for qid in self.keys():
  192. yield self[qid]
  193. def items(self):
  194. for qid in self.keys():
  195. yield (qid, self[qid])
  196. def __iter__(self):
  197. for qid in sorted(super(QubesVmCollection, self).keys()):
  198. yield qid
  199. keys = __iter__
  200. def __setitem__(self, key, value):
  201. if key not in self:
  202. return super(QubesVmCollection, self).__setitem__(key, value)
  203. else:
  204. assert False, "Attempt to add VM with qid that already exists in the collection!"
  205. def add_new_vm(self, vm_type, **kwargs):
  206. if vm_type not in QubesVmClasses.keys():
  207. raise ValueError("Unknown VM type: %s" % vm_type)
  208. qid = self.get_new_unused_qid()
  209. vm_cls = QubesVmClasses[vm_type]
  210. if 'template' in kwargs:
  211. if not vm_cls.is_template_compatible(kwargs['template']):
  212. raise QubesException("Template not compatible with selected "
  213. "VM type")
  214. vm = vm_cls(qid=qid, collection=self, **kwargs)
  215. if not self.verify_new_vm(vm):
  216. raise QubesException("Wrong VM description!")
  217. self[vm.qid] = vm
  218. # make first created NetVM the default one
  219. if self.default_fw_netvm_qid is None and vm.is_netvm():
  220. self.set_default_fw_netvm(vm)
  221. if self.default_netvm_qid is None and vm.is_proxyvm():
  222. self.set_default_netvm(vm)
  223. # make first created TemplateVM the default one
  224. if self.default_template_qid is None and vm.is_template():
  225. self.set_default_template(vm)
  226. # make first created ProxyVM the UpdateVM
  227. if self.updatevm_qid is None and vm.is_proxyvm():
  228. self.set_updatevm_vm(vm)
  229. # by default ClockVM is the first NetVM
  230. if self.clockvm_qid is None and vm.is_netvm():
  231. self.set_clockvm_vm(vm)
  232. return vm
  233. def add_new_appvm(self, name, template,
  234. dir_path = None, conf_file = None,
  235. private_img = None,
  236. label = None):
  237. warnings.warn("Call to deprecated function, use add_new_vm instead",
  238. DeprecationWarning, stacklevel=2)
  239. return self.add_new_vm("QubesAppVm", name=name, template=template,
  240. dir_path=dir_path, conf_file=conf_file,
  241. private_img=private_img,
  242. netvm = self.get_default_netvm(),
  243. kernel = self.get_default_kernel(),
  244. uses_default_kernel = True,
  245. label=label)
  246. def add_new_hvm(self, name, label = None):
  247. warnings.warn("Call to deprecated function, use add_new_vm instead",
  248. DeprecationWarning, stacklevel=2)
  249. return self.add_new_vm("QubesHVm", name=name, label=label)
  250. def add_new_disposablevm(self, name, template, dispid,
  251. label = None, netvm = None):
  252. warnings.warn("Call to deprecated function, use add_new_vm instead",
  253. DeprecationWarning, stacklevel=2)
  254. return self.add_new_vm("QubesDisposableVm", name=name, template=template,
  255. netvm = netvm,
  256. label=label, dispid=dispid)
  257. def add_new_templatevm(self, name,
  258. dir_path = None, conf_file = None,
  259. root_img = None, private_img = None,
  260. installed_by_rpm = True):
  261. warnings.warn("Call to deprecated function, use add_new_vm instead",
  262. DeprecationWarning, stacklevel=2)
  263. return self.add_new_vm("QubesTemplateVm", name=name,
  264. dir_path=dir_path, conf_file=conf_file,
  265. root_img=root_img, private_img=private_img,
  266. installed_by_rpm=installed_by_rpm,
  267. netvm = self.get_default_netvm(),
  268. kernel = self.get_default_kernel(),
  269. uses_default_kernel = True)
  270. def add_new_netvm(self, name, template,
  271. dir_path = None, conf_file = None,
  272. private_img = None, installed_by_rpm = False,
  273. label = None):
  274. warnings.warn("Call to deprecated function, use add_new_vm instead",
  275. DeprecationWarning, stacklevel=2)
  276. return self.add_new_vm("QubesNetVm", name=name, template=template,
  277. label=label,
  278. private_img=private_img, installed_by_rpm=installed_by_rpm,
  279. uses_default_kernel = True,
  280. dir_path=dir_path, conf_file=conf_file)
  281. def add_new_proxyvm(self, name, template,
  282. dir_path = None, conf_file = None,
  283. private_img = None, installed_by_rpm = False,
  284. label = None):
  285. warnings.warn("Call to deprecated function, use add_new_vm instead",
  286. DeprecationWarning, stacklevel=2)
  287. return self.add_new_vm("QubesProxyVm", name=name, template=template,
  288. label=label,
  289. private_img=private_img, installed_by_rpm=installed_by_rpm,
  290. dir_path=dir_path, conf_file=conf_file,
  291. uses_default_kernel = True,
  292. netvm = self.get_default_fw_netvm())
  293. def set_default_template(self, vm):
  294. if vm is None:
  295. self.default_template_qid = None
  296. else:
  297. assert vm.is_template(), "VM {0} is not a TemplateVM!".format(vm.name)
  298. self.default_template_qid = vm.qid
  299. def get_default_template(self):
  300. if self.default_template_qid is None:
  301. return None
  302. else:
  303. return self[self.default_template_qid]
  304. def set_default_netvm(self, vm):
  305. if vm is None:
  306. self.default_netvm_qid = None
  307. else:
  308. assert vm.is_netvm(), "VM {0} does not provide network!".format(vm.name)
  309. self.default_netvm_qid = vm.qid
  310. def get_default_netvm(self):
  311. if self.default_netvm_qid is None:
  312. return None
  313. else:
  314. return self[self.default_netvm_qid]
  315. def set_default_kernel(self, kernel):
  316. assert os.path.exists(
  317. os.path.join(system_path["qubes_kernels_base_dir"], kernel)), \
  318. "Kerel {0} not installed!".format(kernel)
  319. self.default_kernel = kernel
  320. def get_default_kernel(self):
  321. return self.default_kernel
  322. def set_default_fw_netvm(self, vm):
  323. if vm is None:
  324. self.default_fw_netvm_qid = None
  325. else:
  326. assert vm.is_netvm(), "VM {0} does not provide network!".format(vm.name)
  327. self.default_fw_netvm_qid = vm.qid
  328. def get_default_fw_netvm(self):
  329. if self.default_fw_netvm_qid is None:
  330. return None
  331. else:
  332. return self[self.default_fw_netvm_qid]
  333. def set_updatevm_vm(self, vm):
  334. if vm is None:
  335. self.updatevm_qid = None
  336. else:
  337. self.updatevm_qid = vm.qid
  338. def get_updatevm_vm(self):
  339. if self.updatevm_qid is None:
  340. return None
  341. else:
  342. return self[self.updatevm_qid]
  343. def set_clockvm_vm(self, vm):
  344. if vm is None:
  345. self.clockvm_qid = None
  346. else:
  347. self.clockvm_qid = vm.qid
  348. def get_clockvm_vm(self):
  349. if self.clockvm_qid is None:
  350. return None
  351. else:
  352. return self[self.clockvm_qid]
  353. def get_vm_by_name(self, name):
  354. for vm in self.values():
  355. if (vm.name == name):
  356. return vm
  357. return None
  358. def get_qid_by_name(self, name):
  359. vm = self.get_vm_by_name(name)
  360. return vm.qid if vm is not None else None
  361. def get_vms_based_on(self, template_qid):
  362. vms = set([vm for vm in self.values()
  363. if (vm.template and vm.template.qid == template_qid)])
  364. return vms
  365. def get_vms_connected_to(self, netvm_qid):
  366. new_vms = [ netvm_qid ]
  367. dependend_vms_qid = []
  368. # Dependency resolving only makes sense on NetVM (or derivative)
  369. if not self[netvm_qid].is_netvm():
  370. return set([])
  371. while len(new_vms) > 0:
  372. cur_vm = new_vms.pop()
  373. for vm in self[cur_vm].connected_vms.values():
  374. if vm.qid not in dependend_vms_qid:
  375. dependend_vms_qid.append(vm.qid)
  376. if vm.is_netvm():
  377. new_vms.append(vm.qid)
  378. vms = [vm for vm in self.values() if vm.qid in dependend_vms_qid]
  379. return vms
  380. def verify_new_vm(self, new_vm):
  381. # Verify that qid is unique
  382. for vm in self.values():
  383. if vm.qid == new_vm.qid:
  384. print >> sys.stderr, "ERROR: The qid={0} is already used by VM '{1}'!".\
  385. format(vm.qid, vm.name)
  386. return False
  387. # Verify that name is unique
  388. for vm in self.values():
  389. if vm.name == new_vm.name:
  390. print >> sys.stderr, \
  391. "ERROR: The name={0} is already used by other VM with qid='{1}'!".\
  392. format(vm.name, vm.qid)
  393. return False
  394. return True
  395. def get_new_unused_qid(self):
  396. used_ids = set([vm.qid for vm in self.values()])
  397. for id in range (1, qubes_max_qid):
  398. if id not in used_ids:
  399. return id
  400. raise LookupError ("Cannot find unused qid!")
  401. def get_new_unused_netid(self):
  402. used_ids = set([vm.netid for vm in self.values() if vm.is_netvm()])
  403. for id in range (1, qubes_max_netid):
  404. if id not in used_ids:
  405. return id
  406. raise LookupError ("Cannot find unused netid!")
  407. def check_if_storage_exists(self):
  408. try:
  409. f = open (self.qubes_store_filename, 'r')
  410. except IOError:
  411. return False
  412. f.close()
  413. return True
  414. def create_empty_storage(self):
  415. self.qubes_store_file = open (self.qubes_store_filename, 'w')
  416. self.clear()
  417. self.save()
  418. def lock_db_for_reading(self):
  419. self.qubes_store_file = open (self.qubes_store_filename, 'r')
  420. fcntl.lockf (self.qubes_store_file, fcntl.LOCK_SH)
  421. def lock_db_for_writing(self):
  422. self.qubes_store_file = open (self.qubes_store_filename, 'r+')
  423. fcntl.lockf (self.qubes_store_file, fcntl.LOCK_EX)
  424. def unlock_db(self):
  425. # intentionally do not call explicit unlock to not unlock the file
  426. # before all buffers are flushed
  427. self.qubes_store_file.close()
  428. def save(self):
  429. root = lxml.etree.Element(
  430. "QubesVmCollection",
  431. default_template=str(self.default_template_qid) \
  432. if self.default_template_qid is not None else "None",
  433. default_netvm=str(self.default_netvm_qid) \
  434. if self.default_netvm_qid is not None else "None",
  435. default_fw_netvm=str(self.default_fw_netvm_qid) \
  436. if self.default_fw_netvm_qid is not None else "None",
  437. updatevm=str(self.updatevm_qid) \
  438. if self.updatevm_qid is not None else "None",
  439. clockvm=str(self.clockvm_qid) \
  440. if self.clockvm_qid is not None else "None",
  441. default_kernel=str(self.default_kernel) \
  442. if self.default_kernel is not None else "None",
  443. )
  444. for vm in self.values():
  445. element = vm.create_xml_element()
  446. if element is not None:
  447. root.append(element)
  448. tree = lxml.etree.ElementTree(root)
  449. try:
  450. new_store_file = tempfile.NamedTemporaryFile(prefix=self.qubes_store_filename, delete=False)
  451. # XXX: do not get lock on the new file, as in all use cases
  452. # unlock_db() is the next operation after save()
  453. tree.write(new_store_file, encoding="UTF-8", pretty_print=True)
  454. new_store_file.flush()
  455. os.chmod(new_store_file.name, 0660)
  456. os.chown(new_store_file.name, -1, grp.getgrnam('qubes').gr_gid)
  457. os.rename(new_store_file.name, self.qubes_store_filename)
  458. self.qubes_store_file.close()
  459. self.qubes_store_file = new_store_file
  460. except EnvironmentError as err:
  461. print("{0}: export error: {1}".format(
  462. os.path.basename(sys.argv[0]), err))
  463. return False
  464. return True
  465. def set_netvm_dependency(self, element):
  466. kwargs = {}
  467. attr_list = ("qid", "uses_default_netvm", "netvm_qid")
  468. for attribute in attr_list:
  469. kwargs[attribute] = element.get(attribute)
  470. vm = self[int(kwargs["qid"])]
  471. if "uses_default_netvm" not in kwargs:
  472. vm.uses_default_netvm = True
  473. else:
  474. vm.uses_default_netvm = (
  475. True if kwargs["uses_default_netvm"] == "True" else False)
  476. if vm.uses_default_netvm is True:
  477. if vm.is_proxyvm():
  478. netvm = self.get_default_fw_netvm()
  479. else:
  480. netvm = self.get_default_netvm()
  481. kwargs.pop("netvm_qid")
  482. else:
  483. if kwargs["netvm_qid"] == "none" or kwargs["netvm_qid"] is None:
  484. netvm = None
  485. kwargs.pop("netvm_qid")
  486. else:
  487. netvm_qid = int(kwargs.pop("netvm_qid"))
  488. if netvm_qid not in self:
  489. netvm = None
  490. else:
  491. netvm = self[netvm_qid]
  492. # directly set internal attr to not call setters...
  493. vm._netvm = netvm
  494. if netvm:
  495. netvm.connected_vms[vm.qid] = vm
  496. def load_globals(self, element):
  497. default_template = element.get("default_template")
  498. self.default_template_qid = int(default_template) \
  499. if default_template.lower() != "none" else None
  500. default_netvm = element.get("default_netvm")
  501. if default_netvm is not None:
  502. self.default_netvm_qid = int(default_netvm) \
  503. if default_netvm != "None" else None
  504. #assert self.default_netvm_qid is not None
  505. default_fw_netvm = element.get("default_fw_netvm")
  506. if default_fw_netvm is not None:
  507. self.default_fw_netvm_qid = int(default_fw_netvm) \
  508. if default_fw_netvm != "None" else None
  509. #assert self.default_netvm_qid is not None
  510. updatevm = element.get("updatevm")
  511. if updatevm is not None:
  512. self.updatevm_qid = int(updatevm) \
  513. if updatevm != "None" else None
  514. #assert self.default_netvm_qid is not None
  515. clockvm = element.get("clockvm")
  516. if clockvm is not None:
  517. self.clockvm_qid = int(clockvm) \
  518. if clockvm != "None" else None
  519. self.default_kernel = element.get("default_kernel")
  520. def load(self):
  521. self.clear()
  522. try:
  523. tree = lxml.etree.parse(self.qubes_store_file)
  524. except (EnvironmentError,
  525. xml.parsers.expat.ExpatError) as err:
  526. print("{0}: import error: {1}".format(
  527. os.path.basename(sys.argv[0]), err))
  528. return False
  529. self.load_globals(tree.getroot())
  530. for (vm_class_name, vm_class) in sorted(QubesVmClasses.items(),
  531. key=lambda _x: _x[1].load_order):
  532. vms_of_class = tree.findall(vm_class_name)
  533. # first non-template based, then template based
  534. sorted_vms_of_class = sorted(vms_of_class, key= \
  535. lambda x: str(x.get('template_qid')).lower() != "none")
  536. for element in sorted_vms_of_class:
  537. try:
  538. vm = vm_class(xml_element=element, collection=self)
  539. self[vm.qid] = vm
  540. except (ValueError, LookupError) as err:
  541. print("{0}: import error ({1}): {2}".format(
  542. os.path.basename(sys.argv[0]), vm_class_name, err))
  543. raise
  544. return False
  545. # After importing all VMs, set netvm references, in the same order
  546. for (vm_class_name, vm_class) in sorted(QubesVmClasses.items(),
  547. key=lambda _x: _x[1].load_order):
  548. for element in tree.findall(vm_class_name):
  549. try:
  550. self.set_netvm_dependency(element)
  551. except (ValueError, LookupError) as err:
  552. print("{0}: import error2 ({}): {}".format(
  553. os.path.basename(sys.argv[0]), vm_class_name, err))
  554. return False
  555. # if there was no clockvm entry in qubes.xml, try to determine default:
  556. # root of default NetVM chain
  557. if tree.getroot().get("clockvm") is None:
  558. if self.default_netvm_qid is not None:
  559. clockvm = self[self.default_netvm_qid]
  560. # Find root of netvm chain
  561. while clockvm.netvm is not None:
  562. clockvm = clockvm.netvm
  563. self.clockvm_qid = clockvm.qid
  564. # Disable ntpd in ClockVM - to not conflict with ntpdate (both are
  565. # using 123/udp port)
  566. if self.clockvm_qid is not None:
  567. self[self.clockvm_qid].services['ntpd'] = False
  568. # Add dom0 if wasn't present in qubes.xml
  569. if not 0 in self.keys():
  570. dom0vm = QubesAdminVm (collection=self)
  571. self[dom0vm.qid] = dom0vm
  572. return True
  573. def pop(self, qid):
  574. if self.default_netvm_qid == qid:
  575. self.default_netvm_qid = None
  576. if self.default_fw_netvm_qid == qid:
  577. self.default_fw_netvm_qid = None
  578. if self.clockvm_qid == qid:
  579. self.clockvm_qid = None
  580. if self.updatevm_qid == qid:
  581. self.updatevm_qid = None
  582. if self.default_template_qid == qid:
  583. self.default_template_qid = None
  584. return super(QubesVmCollection, self).pop(qid)
  585. class QubesDaemonPidfile(object):
  586. def __init__(self, name):
  587. self.name = name
  588. self.path = "/var/run/qubes/" + name + ".pid"
  589. def create_pidfile(self):
  590. f = open (self.path, 'w')
  591. f.write(str(os.getpid()))
  592. f.close()
  593. def pidfile_exists(self):
  594. return os.path.exists(self.path)
  595. def read_pid(self):
  596. f = open (self.path)
  597. pid = f.read ().strip()
  598. f.close()
  599. return int(pid)
  600. def pidfile_is_stale(self):
  601. if not self.pidfile_exists():
  602. return False
  603. # check if the pid file is valid...
  604. proc_path = "/proc/" + str(self.read_pid()) + "/cmdline"
  605. if not os.path.exists (proc_path):
  606. print >> sys.stderr, \
  607. "Path {0} doesn't exist, assuming stale pidfile.".\
  608. format(proc_path)
  609. return True
  610. return False # It's a good pidfile
  611. def remove_pidfile(self):
  612. os.remove (self.path)
  613. def __enter__ (self):
  614. # assumes the pidfile doesn't exist -- you should ensure it before opening the context
  615. self.create_pidfile()
  616. def __exit__ (self, exc_type, exc_val, exc_tb):
  617. self.remove_pidfile()
  618. return False
  619. modules_dir = os.path.join(os.path.dirname(__file__), 'modules')
  620. for module_file in sorted(os.listdir(modules_dir)):
  621. if not module_file.endswith(".py") or module_file == "__init__.py":
  622. continue
  623. __import__('qubes.modules.%s' % module_file[:-3])
  624. # vim:sw=4:et: