qvm_backup_restore.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  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 Lesser General Public License as published by
  9. # the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  16. #
  17. # You should have received a copy of the GNU Lesser 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. '''Console frontend for backup restore code'''
  21. import getpass
  22. import sys
  23. from qubesadmin.backup.restore import BackupRestore
  24. import qubesadmin.exc
  25. import qubesadmin.tools
  26. import qubesadmin.utils
  27. parser = qubesadmin.tools.QubesArgumentParser()
  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("--ignore-size-limit", action="store_true",
  64. dest="ignore_size_limit", default=False,
  65. help="Ignore size limit calculated from backup metadata")
  66. parser.add_argument("-d", "--dest-vm", action="store", dest="appvm",
  67. help="Specify VM containing the backup to be restored")
  68. parser.add_argument("-p", "--passphrase-file", action="store",
  69. dest="pass_file", default=None,
  70. help="Read passphrase from file, or use '-' to read from stdin")
  71. parser.add_argument('backup_location', action='store',
  72. help="Backup directory name, or command to pipe from")
  73. parser.add_argument('vms', nargs='*', action='store', default=[],
  74. help='Restore only those VMs')
  75. def handle_broken(app, args, restore_info):
  76. '''Display information about problems with VMs selected for resetore'''
  77. there_are_conflicting_vms = False
  78. there_are_missing_templates = False
  79. there_are_missing_netvms = False
  80. dom0_username_mismatch = False
  81. for vm_info in restore_info.values():
  82. assert isinstance(vm_info, BackupRestore.VMToRestore)
  83. if BackupRestore.VMToRestore.EXCLUDED in \
  84. vm_info.problems:
  85. continue
  86. if BackupRestore.VMToRestore.MISSING_TEMPLATE in \
  87. vm_info.problems:
  88. there_are_missing_templates = True
  89. if BackupRestore.VMToRestore.MISSING_NETVM in \
  90. vm_info.problems:
  91. there_are_missing_netvms = True
  92. if BackupRestore.VMToRestore.ALREADY_EXISTS in \
  93. vm_info.problems:
  94. there_are_conflicting_vms = True
  95. if BackupRestore.Dom0ToRestore.USERNAME_MISMATCH in \
  96. vm_info.problems:
  97. dom0_username_mismatch = True
  98. if there_are_conflicting_vms:
  99. app.log.error(
  100. "*** There are VMs with conflicting names on the host! ***")
  101. if args.skip_conflicting:
  102. app.log.error(
  103. "Those VMs will not be restored. "
  104. "The host VMs will NOT be overwritten.")
  105. else:
  106. raise qubesadmin.exc.QubesException(
  107. "Remove VMs with conflicting names from the host "
  108. "before proceeding.\n"
  109. "Or use --skip-conflicting to restore only those VMs that "
  110. "do not exist on the host.\n"
  111. "Or use --rename-conflicting to restore those VMs under "
  112. "modified names (with numbers at the end).")
  113. app.log.info("The above VMs will be copied and added to your system.")
  114. app.log.info("Exisiting VMs will NOT be removed.")
  115. if there_are_missing_templates:
  116. app.log.warning("*** One or more TemplateVMs are missing on the "
  117. "host! ***")
  118. if not (args.skip_broken or args.ignore_missing):
  119. raise qubesadmin.exc.QubesException(
  120. "Install them before proceeding with the restore."
  121. "Or pass: --skip-broken or --ignore-missing.")
  122. elif args.skip_broken:
  123. app.log.warning("Skipping broken entries: VMs that depend on "
  124. "missing TemplateVMs will NOT be restored.")
  125. elif args.ignore_missing:
  126. app.log.warning("Ignoring missing entries: VMs that depend "
  127. "on missing TemplateVMs will have default value "
  128. "assigned.")
  129. else:
  130. raise qubesadmin.exc.QubesException(
  131. "INTERNAL ERROR! Please report this to the Qubes OS team!")
  132. if there_are_missing_netvms:
  133. app.log.warning("*** One or more NetVMs are missing on the "
  134. "host! ***")
  135. if not (args.skip_broken or args.ignore_missing):
  136. raise qubesadmin.exc.QubesException(
  137. "Install them before proceeding with the restore."
  138. "Or pass: --skip-broken or --ignore-missing.")
  139. elif args.skip_broken:
  140. app.log.warning("Skipping broken entries: VMs that depend on "
  141. "missing NetVMs will NOT be restored.")
  142. elif args.ignore_missing:
  143. app.log.warning("Ignoring missing entries: VMs that depend "
  144. "on missing NetVMs will have default value assigned.")
  145. else:
  146. raise qubesadmin.exc.QubesException(
  147. "INTERNAL ERROR! Please report this to the Qubes OS team!")
  148. if 'dom0' in restore_info.keys() and args.dom0_home:
  149. if dom0_username_mismatch:
  150. app.log.warning("*** Dom0 username mismatch! This can break "
  151. "some settings! ***")
  152. if not args.ignore_username_mismatch:
  153. raise qubesadmin.exc.QubesException(
  154. "Skip restoring the dom0 home directory "
  155. "(--skip-dom0-home), or pass "
  156. "--ignore-username-mismatch to continue anyway.")
  157. else:
  158. app.log.warning("Continuing as directed.")
  159. app.log.warning("NOTE: Before restoring the dom0 home directory, "
  160. "a new directory named "
  161. "'home-pre-restore-<current-time>' will be "
  162. "created inside the dom0 home directory. If any "
  163. "restored files conflict with existing files, "
  164. "the existing files will be moved to this new "
  165. "directory.")
  166. def main(args=None, app=None):
  167. '''Main function of qvm-backup-restore'''
  168. # pylint: disable=too-many-return-statements
  169. args = parser.parse_args(args, app=app)
  170. appvm = None
  171. if args.appvm:
  172. try:
  173. appvm = args.app.domains[args.appvm]
  174. except KeyError:
  175. parser.error('no such domain: {!r}'.format(args.appvm))
  176. if args.pass_file is not None:
  177. pass_f = open(args.pass_file) if args.pass_file != "-" else sys.stdin
  178. passphrase = pass_f.readline().rstrip()
  179. if pass_f is not sys.stdin:
  180. pass_f.close()
  181. else:
  182. passphrase = getpass.getpass("Please enter the passphrase to verify "
  183. "and (if encrypted) decrypt the backup: ")
  184. args.app.log.info("Checking backup content...")
  185. try:
  186. backup = BackupRestore(args.app, args.backup_location,
  187. appvm, passphrase)
  188. except qubesadmin.exc.QubesException as e:
  189. parser.error_runtime(str(e))
  190. # unreachable - error_runtime will raise SystemExit
  191. return 1
  192. if args.ignore_missing:
  193. backup.options.use_default_template = True
  194. backup.options.use_default_netvm = True
  195. if args.replace_template:
  196. backup.options.replace_template = args.replace_template
  197. if args.rename_conflicting:
  198. backup.options.rename_conflicting = True
  199. if not args.dom0_home:
  200. backup.options.dom0_home = False
  201. if args.ignore_username_mismatch:
  202. backup.options.ignore_username_mismatch = True
  203. if args.ignore_size_limit:
  204. backup.options.ignore_size_limit = True
  205. if args.exclude:
  206. backup.options.exclude = args.exclude
  207. if args.verify_only:
  208. backup.options.verify_only = True
  209. restore_info = None
  210. try:
  211. restore_info = backup.get_restore_info()
  212. except qubesadmin.exc.QubesException as e:
  213. parser.error_runtime(str(e))
  214. if args.vms:
  215. # use original name here, not renamed
  216. backup.options.exclude += [vm_info.vm.name
  217. for vm_info in restore_info.values()
  218. if vm_info.vm.name not in args.vms]
  219. restore_info = backup.restore_info_verify(restore_info)
  220. print(backup.get_restore_summary(restore_info))
  221. try:
  222. handle_broken(args.app, args, restore_info)
  223. except qubesadmin.exc.QubesException as e:
  224. parser.error_runtime(str(e))
  225. if args.pass_file is None:
  226. if input("Do you want to proceed? [y/N] ").upper() != "Y":
  227. exit(0)
  228. try:
  229. backup.restore_do(restore_info)
  230. except qubesadmin.exc.QubesException as e:
  231. parser.error_runtime(str(e))
  232. if __name__ == '__main__':
  233. main()