qvm_backup_restore.py 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  1. #
  2. # The Qubes OS Project, http://www.qubes-os.org
  3. #
  4. # Copyright (C) 2016 Marek Marczykowski-Górecki
  5. # <marmarek@invisiblethingslab.com>
  6. #
  7. # This program is free software; you can redistribute it and/or modify
  8. # it under the terms of the GNU General Public License as published by
  9. # the Free Software Foundation; either version 2 of the License, or
  10. # (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 along
  18. # with this program; if not, write to the Free Software Foundation, Inc.,
  19. # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20. from __future__ import print_function
  21. import getpass
  22. import locale
  23. import sys
  24. import qubes.backup
  25. import qubes.tools
  26. import qubes.utils
  27. parser = qubes.tools.QubesArgumentParser(want_force_root=True)
  28. parser.add_argument("--verify-only", action="store_true",
  29. dest="verify_only", default=False,
  30. help="Verify backup integrity without restoring any "
  31. "data")
  32. parser.add_argument("--skip-broken", action="store_true", dest="skip_broken",
  33. default=False,
  34. help="Do not restore VMs that have missing TemplateVMs "
  35. "or NetVMs")
  36. parser.add_argument("--ignore-missing", action="store_true",
  37. dest="ignore_missing", default=False,
  38. help="Restore VMs even if their associated TemplateVMs "
  39. "and NetVMs are missing")
  40. parser.add_argument("--skip-conflicting", action="store_true",
  41. dest="skip_conflicting", default=False,
  42. help="Do not restore VMs that are already present on "
  43. "the host")
  44. parser.add_argument("--rename-conflicting", action="store_true",
  45. dest="rename_conflicting", default=False,
  46. help="Restore VMs that are already present on the host "
  47. "under different names")
  48. parser.add_argument("--replace-template", action="append",
  49. dest="replace_template", default=[],
  50. help="Restore VMs using another TemplateVM; syntax: "
  51. "old-template-name:new-template-name (may be "
  52. "repeated)")
  53. parser.add_argument("-x", "--exclude", action="append", dest="exclude",
  54. default=[],
  55. help="Skip restore of specified VM (may be repeated)")
  56. parser.add_argument("--skip-dom0-home", action="store_false", dest="dom0_home",
  57. default=True,
  58. help="Do not restore dom0 user home directory")
  59. parser.add_argument("--ignore-username-mismatch", action="store_true",
  60. dest="ignore_username_mismatch", default=False,
  61. help="Ignore dom0 username mismatch when restoring home "
  62. "directory")
  63. parser.add_argument("-d", "--dest-vm", action="store", dest="appvm",
  64. help="Specify VM containing the backup to be restored")
  65. parser.add_argument("-p", "--passphrase-file", action="store",
  66. dest="pass_file", default=None,
  67. help="Read passphrase from file, or use '-' to read from stdin")
  68. parser.add_argument('backup_location', action='store',
  69. help="Backup directory name, or command to pipe from")
  70. parser.add_argument('vms', nargs='*', action='store', default='[]',
  71. help='Restore only those VMs')
  72. def handle_broken(app, args, restore_info):
  73. there_are_conflicting_vms = False
  74. there_are_missing_templates = False
  75. there_are_missing_netvms = False
  76. dom0_username_mismatch = False
  77. for vm_info in restore_info.values():
  78. assert isinstance(vm_info, qubes.backup.BackupRestore.VMToRestore)
  79. if qubes.backup.BackupRestore.VMToRestore.EXCLUDED in vm_info.problems:
  80. continue
  81. if qubes.backup.BackupRestore.VMToRestore.MISSING_TEMPLATE in \
  82. vm_info.problems:
  83. there_are_missing_templates = True
  84. if qubes.backup.BackupRestore.VMToRestore.MISSING_NETVM in \
  85. vm_info.problems:
  86. there_are_missing_netvms = True
  87. if qubes.backup.BackupRestore.VMToRestore.ALREADY_EXISTS in \
  88. vm_info.problems:
  89. there_are_conflicting_vms = True
  90. if qubes.backup.BackupRestore.Dom0ToRestore.USERNAME_MISMATCH in \
  91. vm_info.problems:
  92. dom0_username_mismatch = True
  93. if there_are_conflicting_vms:
  94. app.log.error(
  95. "*** There are VMs with conflicting names on the host! ***")
  96. if args.skip_conflicting:
  97. app.log.error(
  98. "Those VMs will not be restored. "
  99. "The host VMs will NOT be overwritten.")
  100. else:
  101. raise qubes.exc.QubesException(
  102. "Remove VMs with conflicting names from the host "
  103. "before proceeding.\n"
  104. "Or use --skip-conflicting to restore only those VMs that "
  105. "do not exist on the host.\n"
  106. "Or use --rename-conflicting to restore those VMs under "
  107. "modified names (with numbers at the end).")
  108. app.log.info("The above VMs will be copied and added to your system.")
  109. app.log.info("Exisiting VMs will NOT be removed.")
  110. if there_are_missing_templates:
  111. app.log.warning("*** One or more TemplateVMs are missing on the "
  112. "host! ***")
  113. if not (args.skip_broken or args.ignore_missing):
  114. raise qubes.exc.QubesException(
  115. "Install them before proceeding with the restore."
  116. "Or pass: --skip-broken or --ignore-missing.")
  117. elif args.skip_broken:
  118. app.log.warning("Skipping broken entries: VMs that depend on "
  119. "missing TemplateVMs will NOT be restored.")
  120. elif args.ignore_missing:
  121. app.log.warning("Ignoring missing entries: VMs that depend "
  122. "on missing TemplateVMs will NOT be restored.")
  123. else:
  124. raise qubes.exc.QubesException(
  125. "INTERNAL ERROR! Please report this to the Qubes OS team!")
  126. if there_are_missing_netvms:
  127. app.log.warning("*** One or more NetVMs are missing on the "
  128. "host! ***")
  129. if not (args.skip_broken or args.ignore_missing):
  130. raise qubes.exc.QubesException(
  131. "Install them before proceeding with the restore."
  132. "Or pass: --skip-broken or --ignore-missing.")
  133. elif args.skip_broken:
  134. app.log.warning("Skipping broken entries: VMs that depend on "
  135. "missing NetVMs will NOT be restored.")
  136. elif args.ignore_missing:
  137. app.log.warning("Ignoring missing entries: VMs that depend "
  138. "on missing NetVMs will NOT be restored.")
  139. else:
  140. raise qubes.exc.QubesException(
  141. "INTERNAL ERROR! Please report this to the Qubes OS team!")
  142. if 'dom0' in restore_info.keys() and args.dom0_home:
  143. if dom0_username_mismatch:
  144. app.log.warning("*** Dom0 username mismatch! This can break "
  145. "some settings! ***")
  146. if not args.ignore_username_mismatch:
  147. raise qubes.exc.QubesException(
  148. "Skip restoring the dom0 home directory "
  149. "(--skip-dom0-home), or pass "
  150. "--ignore-username-mismatch to continue anyway.")
  151. else:
  152. app.log.warning("Continuing as directed.")
  153. app.log.warning("NOTE: Before restoring the dom0 home directory, "
  154. "a new directory named "
  155. "'home-pre-restore-<current-time>' will be "
  156. "created inside the dom0 home directory. If any "
  157. "restored files conflict with existing files, "
  158. "the existing files will be moved to this new "
  159. "directory.")
  160. def main(args=None):
  161. # pylint: disable=too-many-return-statements
  162. args = parser.parse_args(args)
  163. appvm = None
  164. if args.appvm:
  165. try:
  166. appvm = args.app.domains[args.appvm]
  167. except KeyError:
  168. parser.error('no such domain: {!r}'.format(args.appvm))
  169. if args.pass_file is not None:
  170. pass_f = open(args.pass_file) if args.pass_file != "-" else sys.stdin
  171. passphrase = pass_f.readline().rstrip()
  172. if pass_f is not sys.stdin:
  173. pass_f.close()
  174. else:
  175. passphrase = getpass.getpass("Please enter the passphrase to verify "
  176. "and (if encrypted) decrypt the backup: ")
  177. encoding = sys.stdin.encoding or locale.getpreferredencoding()
  178. passphrase = passphrase.decode(encoding)
  179. args.app.log.info("Checking backup content...")
  180. try:
  181. backup = qubes.backup.BackupRestore(args.app, args.backup_location,
  182. appvm, passphrase)
  183. except qubes.exc.QubesException as e:
  184. parser.error_runtime(str(e))
  185. # unreachable - error_runtime will raise SystemExit
  186. return 1
  187. if args.ignore_missing:
  188. backup.options.use_default_template = True
  189. backup.options.use_default_netvm = True
  190. if args.replace_template:
  191. backup.options.replace_template = args.replace_template
  192. if args.rename_conflicting:
  193. backup.options.rename_conflicting = True
  194. if not args.dom0_home:
  195. backup.options.dom0_home = False
  196. if args.ignore_username_mismatch:
  197. backup.options.ignore_username_mismatch = True
  198. if args.exclude:
  199. backup.options.exclude = args.exclude
  200. if args.verify_only:
  201. backup.options.verify_only = True
  202. restore_info = None
  203. try:
  204. restore_info = backup.get_restore_info()
  205. except qubes.exc.QubesException as e:
  206. parser.error_runtime(str(e))
  207. print(backup.get_restore_summary(restore_info))
  208. try:
  209. handle_broken(args.app, args, restore_info)
  210. except qubes.exc.QubesException as e:
  211. parser.error_runtime(str(e))
  212. if args.pass_file is None:
  213. if input("Do you want to proceed? [y/N] ").upper() != "Y":
  214. exit(0)
  215. try:
  216. backup.restore_do(restore_info)
  217. except qubes.exc.QubesException as e:
  218. parser.error_runtime(str(e))
  219. if __name__ == '__main__':
  220. main()