291 lines
11 KiB
Python
291 lines
11 KiB
Python
|
# -*- encoding: utf8 -*-
|
||
|
|
#
|
||
|
|
# The Qubes OS Project, http://www.qubes-os.org
|
||
|
|
#
|
||
|
|
# Copyright (C) 2017 Marek Marczykowski-Górecki
|
||
|
|
# <marmarek@invisiblethingslab.com>
|
||
|
|
#
|
||
|
|
# This program is free software; you can redistribute it and/or modify
|
||
|
|
# it under the terms of the GNU Lesser General Public License as published by
|
||
|
|
# the Free Software Foundation; either version 2.1 of the License, or
|
||
|
|
# (at your option) any later version.
|
||
|
|
#
|
||
|
|
# This program is distributed in the hope that it will be useful,
|
||
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
# GNU Lesser General Public License for more details.
|
||
|
|
#
|
||
|
|
# You should have received a copy of the GNU Lesser General Public License along
|
||
|
|
# with this program; if not, see <http://www.gnu.org/licenses/>.
|
||
|
|
|
||
|
|
'''Parser for core2 qubes.xml'''
|
||
|
|
|
||
|
|
import ast
|
||
|
|
import xml.parsers
|
||
|
|
import logging
|
||
|
|
import lxml.etree
|
||
|
|
|
||
|
|
import qubesadmin.backup
|
||
|
|
|
||
|
|
service_to_feature = {
|
||
|
|
'ntpd': 'service.ntpd',
|
||
|
|
'qubes-update-check': 'check-updates',
|
||
|
|
'meminfo-writer': 'services.meminfo-writer',
|
||
|
|
}
|
||
|
|
|
||
|
|
class Core2VM(qubesadmin.backup.BackupVM):
|
||
|
|
'''VM object'''
|
||
|
|
# pylint: disable=too-few-public-methods
|
||
|
|
def __init__(self):
|
||
|
|
super(Core2VM, self).__init__()
|
||
|
|
self.backup_content = False
|
||
|
|
|
||
|
|
@property
|
||
|
|
def included_in_backup(self):
|
||
|
|
return self.backup_content
|
||
|
|
|
||
|
|
class Core2Qubes(qubesadmin.backup.BackupApp):
|
||
|
|
'''Parsed qubes.xml'''
|
||
|
|
def __init__(self, store=None):
|
||
|
|
if store is None:
|
||
|
|
raise ValueError("store path required")
|
||
|
|
self.qid_map = {}
|
||
|
|
self.log = logging.getLogger('qubesadmin.backup.core2')
|
||
|
|
super(Core2Qubes, self).__init__(store)
|
||
|
|
|
||
|
|
def load_globals(self, element):
|
||
|
|
'''Load global settings
|
||
|
|
|
||
|
|
:param element: XML element containing global settings (root node)
|
||
|
|
'''
|
||
|
|
default_netvm = element.get("default_netvm")
|
||
|
|
if default_netvm is not None:
|
||
|
|
self.globals['default_netvm'] = self.qid_map[int(default_netvm)] \
|
||
|
|
if default_netvm != "None" else None
|
||
|
|
|
||
|
|
# default_fw_netvm = element.get("default_fw_netvm")
|
||
|
|
# if default_fw_netvm is not None:
|
||
|
|
# self.globals['default_fw_netvm'] = \
|
||
|
|
# self.qid_map[int(default_fw_netvm)] \
|
||
|
|
# if default_fw_netvm != "None" else None
|
||
|
|
|
||
|
|
updatevm = element.get("updatevm")
|
||
|
|
if updatevm is not None:
|
||
|
|
self.globals['updatevm'] = self.qid_map[int(updatevm)] \
|
||
|
|
if updatevm != "None" else None
|
||
|
|
|
||
|
|
clockvm = element.get("clockvm")
|
||
|
|
if clockvm is not None:
|
||
|
|
self.globals['clockvm'] = self.qid_map[int(clockvm)] \
|
||
|
|
if clockvm != "None" else None
|
||
|
|
|
||
|
|
default_template = element.get("default_template")
|
||
|
|
self.globals['default_template'] = self.qid_map[int(default_template)] \
|
||
|
|
if default_template.lower() != "none" else None
|
||
|
|
|
||
|
|
|
||
|
|
def set_netvm_dependency(self, element):
|
||
|
|
'''Set dependencies between VMs'''
|
||
|
|
kwargs = {}
|
||
|
|
attr_list = ("name", "uses_default_netvm", "netvm_qid")
|
||
|
|
|
||
|
|
for attribute in attr_list:
|
||
|
|
kwargs[attribute] = element.get(attribute)
|
||
|
|
|
||
|
|
vm = self.domains[kwargs["name"]]
|
||
|
|
|
||
|
|
# netvm property
|
||
|
|
if element.get("uses_default_netvm") is None:
|
||
|
|
uses_default_netvm = True
|
||
|
|
else:
|
||
|
|
uses_default_netvm = (
|
||
|
|
True if element.get("uses_default_netvm") == "True" else False)
|
||
|
|
if not uses_default_netvm:
|
||
|
|
netvm_qid = element.get("netvm_qid")
|
||
|
|
if netvm_qid is None or netvm_qid == "none":
|
||
|
|
vm.properties['netvm'] = None
|
||
|
|
else:
|
||
|
|
vm.properties['netvm'] = self.qid_map[int(netvm_qid)]
|
||
|
|
|
||
|
|
# And DispVM netvm, translated to default_dispvm
|
||
|
|
if element.get("uses_default_dispvm_netvm") is None:
|
||
|
|
uses_default_dispvm_netvm = True
|
||
|
|
else:
|
||
|
|
uses_default_dispvm_netvm = (
|
||
|
|
True if element.get("uses_default_dispvm_netvm") == "True"
|
||
|
|
else False)
|
||
|
|
if not uses_default_dispvm_netvm:
|
||
|
|
dispvm_netvm_qid = element.get("dispvm_netvm_qid")
|
||
|
|
if dispvm_netvm_qid is None or dispvm_netvm_qid == "none":
|
||
|
|
dispvm_netvm = None
|
||
|
|
else:
|
||
|
|
dispvm_netvm = self.qid_map[int(dispvm_netvm_qid)]
|
||
|
|
else:
|
||
|
|
dispvm_netvm = vm.properties.get('netvm', self.globals[
|
||
|
|
'default_netvm'])
|
||
|
|
|
||
|
|
if dispvm_netvm != self.globals['default_netvm']:
|
||
|
|
if dispvm_netvm:
|
||
|
|
dispvm_tpl_name = 'disp-{}'.format(dispvm_netvm)
|
||
|
|
else:
|
||
|
|
dispvm_tpl_name = 'disp-no-netvm'
|
||
|
|
|
||
|
|
vm.properties['default_dispvm'] = dispvm_tpl_name
|
||
|
|
|
||
|
|
if dispvm_tpl_name not in self.domains:
|
||
|
|
vm = Core2VM()
|
||
|
|
vm.name = dispvm_tpl_name
|
||
|
|
vm.label = 'red'
|
||
|
|
vm.properties['netvm'] = dispvm_netvm
|
||
|
|
vm.properties['dispvm_allowed'] = True
|
||
|
|
vm.backup_content = True
|
||
|
|
vm.backup_path = None
|
||
|
|
self.domains[vm.name] = vm
|
||
|
|
# TODO: add support for #2075
|
||
|
|
# TODO: set qrexec policy based on dispvm_netvm value
|
||
|
|
|
||
|
|
def import_core2_vm(self, element):
|
||
|
|
'''Parse a single VM from given XML node
|
||
|
|
|
||
|
|
This method load only VM properties not depending on other VMs
|
||
|
|
(other than template). VM connections are set later.
|
||
|
|
:param element: XML node
|
||
|
|
'''
|
||
|
|
vm_class_name = element.tag
|
||
|
|
vm = Core2VM()
|
||
|
|
vm.name = element.get('name')
|
||
|
|
vm.label = element.get('label', 'red')
|
||
|
|
self.domains[vm.name] = vm
|
||
|
|
kwargs = {}
|
||
|
|
if vm_class_name in ["QubesTemplateVm", "QubesTemplateHVm"]:
|
||
|
|
vm.klass = "TemplateVM"
|
||
|
|
elif element.get('template_qid').lower() == "none":
|
||
|
|
kwargs['dir_path'] = element.get('dir_path')
|
||
|
|
vm.klass = "StandaloneVM"
|
||
|
|
else:
|
||
|
|
kwargs['dir_path'] = element.get('dir_path')
|
||
|
|
vm.template = \
|
||
|
|
self.qid_map[int(element.get('template_qid'))]
|
||
|
|
vm.klass = "AppVM"
|
||
|
|
# simple attributes
|
||
|
|
for attr, default in {
|
||
|
|
#'installed_by_rpm': 'False',
|
||
|
|
'include_in_backups': 'True',
|
||
|
|
'qrexec_timeout': '60',
|
||
|
|
'vcpus': '2',
|
||
|
|
'memory': '400',
|
||
|
|
'maxmem': '4000',
|
||
|
|
'default_user': 'user',
|
||
|
|
'debug': 'False',
|
||
|
|
'mac': None,
|
||
|
|
'autostart': 'False'}.items():
|
||
|
|
value = element.get(attr)
|
||
|
|
if value and value != default:
|
||
|
|
vm.properties[attr] = value
|
||
|
|
# attributes with default value
|
||
|
|
for attr in ["kernel", "kernelopts"]:
|
||
|
|
value = element.get(attr)
|
||
|
|
if value and value.lower() == "none":
|
||
|
|
value = None
|
||
|
|
value_is_default = element.get(
|
||
|
|
"uses_default_{}".format(attr))
|
||
|
|
if value_is_default and value_is_default.lower() != \
|
||
|
|
"true":
|
||
|
|
vm.properties[attr] = value
|
||
|
|
vm.properties['hvm'] = "HVm" in vm_class_name
|
||
|
|
if vm_class_name in ('QubesNetVm', 'QubesProxyVm'):
|
||
|
|
vm.properties['provides_network'] = True
|
||
|
|
if vm_class_name == 'QubesNetVm':
|
||
|
|
vm.properties['netvm'] = None
|
||
|
|
if element.get('internal', False) == 'True':
|
||
|
|
vm.features['internal'] = True
|
||
|
|
|
||
|
|
services = element.get('services')
|
||
|
|
if services:
|
||
|
|
services = ast.literal_eval(services)
|
||
|
|
else:
|
||
|
|
services = {}
|
||
|
|
for service, value in services.items():
|
||
|
|
feature = service
|
||
|
|
for repl_service, repl_feature in \
|
||
|
|
service_to_feature.items():
|
||
|
|
if repl_service == service:
|
||
|
|
feature = repl_feature
|
||
|
|
vm.features[feature] = value
|
||
|
|
|
||
|
|
vm.backup_content = element.get('backup_content', False) == 'True'
|
||
|
|
vm.backup_path = element.get('backup_path', None)
|
||
|
|
vm.size = element.get('backup_size', 0)
|
||
|
|
|
||
|
|
pci_strictreset = element.get('pci_strictreset', True)
|
||
|
|
pcidevs = element.get('pcidevs')
|
||
|
|
if pcidevs:
|
||
|
|
pcidevs = ast.literal_eval(pcidevs)
|
||
|
|
for pcidev in pcidevs:
|
||
|
|
if not pci_strictreset:
|
||
|
|
vm.devices['pci'][('dom0', pcidev.replace(':', '_'))] = {
|
||
|
|
'no-strict-reset': True}
|
||
|
|
else:
|
||
|
|
vm.devices['pci'][('dom0', pcidev.replace(':', '_'))] = {}
|
||
|
|
|
||
|
|
def load(self):
|
||
|
|
with open(self.store) as fh:
|
||
|
|
try:
|
||
|
|
# pylint: disable=no-member
|
||
|
|
tree = lxml.etree.parse(fh)
|
||
|
|
except (EnvironmentError, # pylint: disable=broad-except
|
||
|
|
xml.parsers.expat.ExpatError) as err:
|
||
|
|
self.log.error(err)
|
||
|
|
return False
|
||
|
|
|
||
|
|
self.globals['default_kernel'] = tree.getroot().get("default_kernel")
|
||
|
|
|
||
|
|
vm_classes = ["AdminVM", "TemplateVm", "TemplateHVm",
|
||
|
|
"AppVm", "HVm", "NetVm", "ProxyVm"]
|
||
|
|
|
||
|
|
# First build qid->name map
|
||
|
|
for vm_class_name in vm_classes:
|
||
|
|
vms_of_class = tree.findall("Qubes" + vm_class_name)
|
||
|
|
for element in vms_of_class:
|
||
|
|
qid = element.get('qid', None)
|
||
|
|
name = element.get('name', None)
|
||
|
|
if qid and name:
|
||
|
|
self.qid_map[int(qid)] = name
|
||
|
|
|
||
|
|
# Qubes R2 din't have dom0 in qubes.xml
|
||
|
|
if 0 not in self.qid_map:
|
||
|
|
vm = Core2VM()
|
||
|
|
vm.name = 'dom0'
|
||
|
|
vm.klass = 'AdminVM'
|
||
|
|
vm.label = 'black'
|
||
|
|
self.domains['dom0'] = vm
|
||
|
|
self.qid_map[0] = 'dom0'
|
||
|
|
|
||
|
|
# Then load all VMs - since we have qid_map, no need to preserve
|
||
|
|
# specific load older.
|
||
|
|
for vm_class_name in vm_classes:
|
||
|
|
vms_of_class = tree.findall("Qubes" + vm_class_name)
|
||
|
|
for element in vms_of_class:
|
||
|
|
self.import_core2_vm(element)
|
||
|
|
|
||
|
|
# ... and load other VMs
|
||
|
|
for vm_class_name in ["AppVm", "HVm", "NetVm", "ProxyVm"]:
|
||
|
|
vms_of_class = tree.findall("Qubes" + vm_class_name)
|
||
|
|
# first non-template based, then template based
|
||
|
|
sorted_vms_of_class = sorted(vms_of_class,
|
||
|
|
key=lambda x: str(x.get('template_qid')).lower() != "none")
|
||
|
|
for element in sorted_vms_of_class:
|
||
|
|
self.import_core2_vm(element)
|
||
|
|
|
||
|
|
# and load other defaults (default netvm, updatevm etc)
|
||
|
|
self.load_globals(tree.getroot())
|
||
|
|
|
||
|
|
# After importing all VMs, set netvm references, in the same order
|
||
|
|
for vm_class_name in vm_classes:
|
||
|
|
for element in tree.findall("Qubes" + vm_class_name):
|
||
|
|
try:
|
||
|
|
self.set_netvm_dependency(element)
|
||
|
|
except (ValueError, LookupError) as err:
|
||
|
|
self.log.error("VM %s: failed to set netvm dependency: %s",
|
||
|
|
element.get('name'), err)
|