qvm-backup-restore 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  1. #!/usr/bin/python2
  2. # -*- encoding: utf8 -*-
  3. #
  4. # The Qubes OS Project, http://www.qubes-os.org
  5. #
  6. # Copyright (C) 2010 Joanna Rutkowska <joanna@invisiblethingslab.com>
  7. #
  8. # This program is free software; you can redistribute it and/or
  9. # modify it under the terms of the GNU General Public License
  10. # as published by the Free Software Foundation; either version 2
  11. # of the License, or (at your option) any later version.
  12. #
  13. # This program is distributed in the hope that it will be useful,
  14. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. # GNU General Public License for more details.
  17. #
  18. # You should have received a copy of the GNU General Public License
  19. # along with this program; if not, write to the Free Software
  20. # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21. #
  22. #
  23. from multiprocessing import Event
  24. from qubes.qubes import QubesVmCollection
  25. from qubes.qubes import QubesException
  26. from qubes.backup import backup_restore_header
  27. from qubes.backup import backup_restore_prepare
  28. from qubes.backup import backup_restore_print_summary
  29. from qubes.backup import backup_restore_do
  30. import qubes.backup
  31. import sys
  32. from optparse import OptionParser
  33. import os
  34. import sys
  35. import getpass
  36. def main():
  37. usage = "usage: %prog [options] <backup-dir> [vms-to-be-restored ...]"
  38. parser = OptionParser (usage)
  39. parser.add_option ("--verify-only", action="store_true",
  40. dest="verify_only", default=False,
  41. help="Do not restore the data, only verify backup "
  42. "integrify.")
  43. parser.add_option ("--skip-broken", action="store_true", dest="skip_broken", default=False,
  44. help="Do not restore VMs that have missing templates or netvms")
  45. parser.add_option ("--ignore-missing", action="store_true", dest="ignore_missing", default=False,
  46. help="Ignore missing templates or netvms, restore VMs anyway")
  47. parser.add_option ("--skip-conflicting", action="store_true", dest="skip_conflicting", default=False,
  48. help="Do not restore VMs that are already present on the host")
  49. parser.add_option ("--force-root", action="store_true", dest="force_root", default=False,
  50. help="Force to run, even with root privileges")
  51. parser.add_option ("--replace-template", action="append", dest="replace_template", default=[],
  52. help="Restore VMs using another template, syntax: "
  53. "old-template-name:new-template-name (may be "
  54. "repeated)")
  55. parser.add_option ("-x", "--exclude", action="append", dest="exclude", default=[],
  56. help="Skip restore of specified VM (may be repeated)")
  57. parser.add_option ("--skip-dom0-home", action="store_false", dest="dom0_home", default=True,
  58. help="Do not restore dom0 user home dir")
  59. parser.add_option ("--ignore-username-mismatch", action="store_true", dest="ignore_username_mismatch", default=False,
  60. help="Ignore dom0 username mismatch while restoring homedir")
  61. parser.add_option ("-d", "--dest-vm", action="store", dest="appvm",
  62. help="The AppVM to send backups to")
  63. parser.add_option ("-e", "--encrypted", action="store_true", dest="decrypt", default=False,
  64. help="The backup is encrypted")
  65. parser.add_option ("-z", "--compressed", action="store_true", dest="compressed", default=False,
  66. help="The backup is compressed")
  67. parser.add_option ("--debug", action="store_true", dest="debug",
  68. default=False, help="Enable (a lot of) debug output")
  69. (options, args) = parser.parse_args ()
  70. if (len (args) < 1):
  71. print >> sys.stderr, "You must specify the backup directory (e.g. /mnt/backup/qubes-2010-12-01-235959)"
  72. exit (0)
  73. backup_dir = args[0]
  74. vmlist = args[1:]
  75. #if not os.path.exists (backup_dir):
  76. # print >> sys.stderr, "The backup directory doesn't exist!"
  77. # exit(1)
  78. host_collection = QubesVmCollection()
  79. host_collection.lock_db_for_writing()
  80. host_collection.load()
  81. restore_options = {}
  82. if options.ignore_missing:
  83. restore_options['use-default-template'] = True
  84. restore_options['use-default-netvm'] = True
  85. if options.replace_template:
  86. restore_options['replace-template'] = options.replace_template
  87. if not options.dom0_home:
  88. restore_options['dom0-home'] = False
  89. if options.ignore_username_mismatch:
  90. restore_options['ignore-username-mismatch'] = True
  91. if options.exclude:
  92. restore_options['exclude'] = options.exclude
  93. if options.verify_only:
  94. restore_options['verify-only'] = True
  95. if options.debug:
  96. qubes.backup.BACKUP_DEBUG = True
  97. appvm = None
  98. if options.appvm is not None:
  99. appvm = host_collection.get_vm_by_name(options.appvm)
  100. if appvm is None:
  101. print >>sys.stderr, "ERROR: VM {0} does not exist".format(options.appvm)
  102. exit(1)
  103. passphrase = getpass.getpass("Please enter the pass phrase that will be used to decrypt/verify the backup: ")
  104. passphrase = passphrase.decode(sys.stdin.encoding)
  105. print >> sys.stderr, "Checking backup content..."
  106. error_detected = Event()
  107. def error_callback(message):
  108. error_detected.set()
  109. print >> sys.stderr, message
  110. restore_info = None
  111. try:
  112. restore_info = backup_restore_prepare(
  113. backup_dir,
  114. passphrase=passphrase,
  115. options=restore_options,
  116. host_collection=host_collection,
  117. encrypted=options.decrypt,
  118. compressed=options.compressed,
  119. appvm=appvm,
  120. error_callback=error_callback)
  121. except QubesException as e:
  122. print >> sys.stderr, "ERROR: %s" % str(e)
  123. exit(1)
  124. if len(vmlist) > 0:
  125. for vm in restore_info.keys():
  126. if vm.startswith('$'):
  127. continue
  128. if not vm in vmlist:
  129. restore_info.pop(vm)
  130. backup_restore_print_summary(restore_info)
  131. there_are_conflicting_vms = False
  132. there_are_missing_templates = False
  133. there_are_missing_netvms = False
  134. dom0_username_mismatch = False
  135. for vm_info in restore_info.values():
  136. if 'excluded' in vm_info and vm_info['excluded']:
  137. continue
  138. if 'missing-template' in vm_info.keys():
  139. there_are_missing_templates = True
  140. if 'missing-netvm' in vm_info.keys():
  141. there_are_missing_netvms = True
  142. if 'already-exists' in vm_info.keys():
  143. there_are_conflicting_vms = True
  144. if 'username-mismatch' in vm_info.keys():
  145. dom0_username_mismatch = True
  146. print
  147. if hasattr(os, "geteuid") and os.geteuid() == 0:
  148. print >> sys.stderr, "*** Running this tool as root is strongly discouraged, this will lead you in permissions problems."
  149. if options.force_root:
  150. print >> sys.stderr, "Continuing as commanded. You have been warned."
  151. else:
  152. print >> sys.stderr, "Retry as unprivileged user."
  153. print >> sys.stderr, "... or use --force-root to continue anyway."
  154. exit(1)
  155. if there_are_conflicting_vms:
  156. print >> sys.stderr, "*** There VMs with conflicting names on the host! ***"
  157. if options.skip_conflicting:
  158. print >> sys.stderr, "Those VMs will not be restored, the host VMs will not be overwritten!"
  159. else:
  160. print >> sys.stderr, "Remove VMs with conflicting names from the host before proceeding."
  161. print >> sys.stderr, "... or use --skip-conflicting to restore only those VMs that do not exist on the host."
  162. exit (1)
  163. print "The above VMs will be copied and added to your system."
  164. print "Exisiting VMs will not be removed."
  165. if there_are_missing_templates:
  166. print >> sys.stderr, "*** One or more template VM is missing on the host! ***"
  167. if not (options.skip_broken or options.ignore_missing):
  168. print >> sys.stderr, "Install it first, before proceeding with backup restore."
  169. print >> sys.stderr, "Or pass: --skip-broken or --ignore-missing switch."
  170. exit (1)
  171. elif options.skip_broken:
  172. print >> sys.stderr, "... VMs that depend on it will not be restored (--skip-broken used)"
  173. elif options.ignore_missing:
  174. print >> sys.stderr, "... VMs that depend on it will be restored anyway (--ignore-missing used)"
  175. else:
  176. print >> sys.stderr, "INTERNAL ERROR?!"
  177. exit (1)
  178. if there_are_missing_netvms:
  179. print >> sys.stderr, "*** One or more network VM is missing on the host! ***"
  180. if not (options.skip_broken or options.ignore_missing):
  181. print >> sys.stderr, "Install it first, before proceeding with backup restore."
  182. print >> sys.stderr, "Or pass: --skip_broken or --ignore_missing switch."
  183. exit (1)
  184. elif options.skip_broken:
  185. print >> sys.stderr, "... VMs that depend on it will not be restored (--skip-broken used)"
  186. elif options.ignore_missing:
  187. print >> sys.stderr, "... VMs that depend on it be restored anyway (--ignore-missing used)"
  188. else:
  189. print >> sys.stderr, "INTERNAL ERROR?!"
  190. exit (1)
  191. if 'dom0' in restore_info.keys() and options.dom0_home:
  192. if dom0_username_mismatch:
  193. print >> sys.stderr, "*** Dom0 username mismatch! This can break some settings ***"
  194. if not options.ignore_username_mismatch:
  195. print >> sys.stderr, "Skip dom0 home restore (--skip-dom0-home)"
  196. print >> sys.stderr, "Or pass: --ignore-username-mismatch to continue anyway"
  197. exit(1)
  198. else:
  199. print >> sys.stderr, "Continuing as directed"
  200. print >> sys.stderr, "While restoring user homedir, existing files/dirs will be backed up in 'home-pre-restore-<current-time>' dir"
  201. prompt = raw_input ("Do you want to proceed? [y/N] ")
  202. if not (prompt == "y" or prompt == "Y"):
  203. exit (0)
  204. try:
  205. backup_restore_do(restore_info,
  206. host_collection=host_collection,
  207. error_callback=error_callback)
  208. except QubesException as e:
  209. print >> sys.stderr, "ERROR: %s" % str(e)
  210. host_collection.unlock_db()
  211. if error_detected.is_set():
  212. print "-> Completed with errors!"
  213. exit(1)
  214. else:
  215. print "-> Done."
  216. main()