qvm_backup_restore.py 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262
  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("-x", "--exclude", action="append", dest="exclude",
  49. default=[],
  50. help="Skip restore of specified VM (may be repeated)")
  51. parser.add_argument("--skip-dom0-home", action="store_false", dest="dom0_home",
  52. default=True,
  53. help="Do not restore dom0 user home directory")
  54. parser.add_argument("--ignore-username-mismatch", action="store_true",
  55. dest="ignore_username_mismatch", default=False,
  56. help="Ignore dom0 username mismatch when restoring home "
  57. "directory")
  58. parser.add_argument("--ignore-size-limit", action="store_true",
  59. dest="ignore_size_limit", default=False,
  60. help="Ignore size limit calculated from backup metadata")
  61. parser.add_argument("-d", "--dest-vm", action="store", dest="appvm",
  62. help="Specify VM containing the backup to be restored")
  63. parser.add_argument("-p", "--passphrase-file", action="store",
  64. dest="pass_file", default=None,
  65. help="Read passphrase from file, or use '-' to read from stdin")
  66. parser.add_argument('backup_location', action='store',
  67. help="Backup directory name, or command to pipe from")
  68. parser.add_argument('vms', nargs='*', action='store', default=[],
  69. help='Restore only those VMs')
  70. def handle_broken(app, args, restore_info):
  71. '''Display information about problems with VMs selected for resetore'''
  72. there_are_conflicting_vms = False
  73. there_are_missing_templates = False
  74. there_are_missing_netvms = False
  75. dom0_username_mismatch = False
  76. for vm_info in restore_info.values():
  77. assert isinstance(vm_info, BackupRestore.VMToRestore)
  78. if BackupRestore.VMToRestore.EXCLUDED in \
  79. vm_info.problems:
  80. continue
  81. if BackupRestore.VMToRestore.MISSING_TEMPLATE in \
  82. vm_info.problems:
  83. there_are_missing_templates = True
  84. if BackupRestore.VMToRestore.MISSING_NETVM in \
  85. vm_info.problems:
  86. there_are_missing_netvms = True
  87. if BackupRestore.VMToRestore.ALREADY_EXISTS in \
  88. vm_info.problems:
  89. there_are_conflicting_vms = True
  90. if 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 qubesadmin.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. if args.verify_only:
  109. app.log.info("The above VM archive(s) will be verified.")
  110. app.log.info("Existing VMs will NOT be removed or altered.")
  111. else:
  112. app.log.info("The above VMs will be copied and added to your system.")
  113. app.log.info("Exisiting VMs will NOT be removed.")
  114. if there_are_missing_templates:
  115. app.log.warning("*** One or more TemplateVMs are missing on the "
  116. "host! ***")
  117. if not (args.skip_broken or args.ignore_missing):
  118. raise qubesadmin.exc.QubesException(
  119. "Install them before proceeding with the restore."
  120. "Or pass: --skip-broken or --ignore-missing.")
  121. elif args.skip_broken:
  122. app.log.warning("Skipping broken entries: VMs that depend on "
  123. "missing TemplateVMs will NOT be restored.")
  124. elif args.ignore_missing:
  125. app.log.warning("Ignoring missing entries: VMs that depend "
  126. "on missing TemplateVMs will have default value "
  127. "assigned.")
  128. else:
  129. raise qubesadmin.exc.QubesException(
  130. "INTERNAL ERROR! Please report this to the Qubes OS team!")
  131. if there_are_missing_netvms:
  132. app.log.warning("*** One or more NetVMs are missing on the "
  133. "host! ***")
  134. if not (args.skip_broken or args.ignore_missing):
  135. raise qubesadmin.exc.QubesException(
  136. "Install them before proceeding with the restore."
  137. "Or pass: --skip-broken or --ignore-missing.")
  138. elif args.skip_broken:
  139. app.log.warning("Skipping broken entries: VMs that depend on "
  140. "missing NetVMs will NOT be restored.")
  141. elif args.ignore_missing:
  142. app.log.warning("Ignoring missing entries: VMs that depend "
  143. "on missing NetVMs will have default value assigned.")
  144. else:
  145. raise qubesadmin.exc.QubesException(
  146. "INTERNAL ERROR! Please report this to the Qubes OS team!")
  147. if 'dom0' in restore_info.keys() and args.dom0_home \
  148. and not args.verify_only:
  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: The archived dom0 home directory "
  160. "will be restored to a new directory "
  161. "'home-restore-<current-time>' "
  162. "created inside the dom0 home directory. Restored "
  163. "files should be copied or moved out of the new "
  164. "directory before using them.")
  165. def main(args=None, app=None):
  166. '''Main function of qvm-backup-restore'''
  167. # pylint: disable=too-many-return-statements
  168. args = parser.parse_args(args, app=app)
  169. appvm = None
  170. if args.appvm:
  171. try:
  172. appvm = args.app.domains[args.appvm]
  173. except KeyError:
  174. parser.error('no such domain: {!r}'.format(args.appvm))
  175. if args.pass_file is not None:
  176. pass_f = open(args.pass_file) if args.pass_file != "-" else sys.stdin
  177. passphrase = pass_f.readline().rstrip()
  178. if pass_f is not sys.stdin:
  179. pass_f.close()
  180. else:
  181. passphrase = getpass.getpass("Please enter the passphrase to verify "
  182. "and (if encrypted) decrypt the backup: ")
  183. args.app.log.info("Checking backup content...")
  184. try:
  185. backup = BackupRestore(args.app, args.backup_location,
  186. appvm, passphrase)
  187. except qubesadmin.exc.QubesException as e:
  188. parser.error_runtime(str(e))
  189. # unreachable - error_runtime will raise SystemExit
  190. return 1
  191. backup.options.use_default_template = args.ignore_missing
  192. backup.options.use_default_netvm = args.ignore_missing
  193. backup.options.rename_conflicting = args.rename_conflicting
  194. backup.options.dom0_home = args.dom0_home
  195. backup.options.ignore_username_mismatch = args.ignore_username_mismatch
  196. backup.options.ignore_size_limit = args.ignore_size_limit
  197. backup.options.exclude = args.exclude
  198. backup.options.verify_only = args.verify_only
  199. restore_info = None
  200. try:
  201. restore_info = backup.get_restore_info()
  202. except qubesadmin.exc.QubesException as e:
  203. parser.error_runtime(str(e))
  204. if args.vms:
  205. # use original name here, not renamed
  206. backup.options.exclude += [vm_info.vm.name
  207. for vm_info in restore_info.values()
  208. if vm_info.vm.name not in args.vms]
  209. restore_info = backup.restore_info_verify(restore_info)
  210. print(backup.get_restore_summary(restore_info))
  211. try:
  212. handle_broken(args.app, args, restore_info)
  213. except qubesadmin.exc.QubesException as e:
  214. parser.error_runtime(str(e))
  215. if args.pass_file is None:
  216. if input("Do you want to proceed? [y/N] ").upper() != "Y":
  217. exit(0)
  218. try:
  219. backup.restore_do(restore_info)
  220. except qubesadmin.exc.QubesException as e:
  221. parser.error_runtime(str(e))
  222. if __name__ == '__main__':
  223. main()