qvm-backup 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  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 qubes.qubes import QubesVmCollection
  24. from qubes.qubes import QubesException
  25. from qubes.backup import backup_prepare, backup_do
  26. from qubes.qubesutils import size_to_human
  27. from optparse import OptionParser
  28. import qubes.backup
  29. import os
  30. import sys
  31. import getpass
  32. def print_progress(progress):
  33. print >> sys.stderr, "\r-> Backing up files: {0}%...".format (progress),
  34. def main():
  35. usage = "usage: %prog [options] <backup-dir-path> [vms-to-be-included ...]"
  36. parser = OptionParser (usage)
  37. parser.add_option ("-x", "--exclude", action="append",
  38. dest="exclude_list", default=[],
  39. help="Exclude the specified VM from backup (may be "
  40. "repeated)")
  41. parser.add_option ("--force-root", action="store_true", dest="force_root", default=False,
  42. help="Force to run, even with root privileges")
  43. parser.add_option ("-d", "--dest-vm", action="store", dest="appvm",
  44. help="The AppVM to send backups to (implies -e)")
  45. parser.add_option ("-e", "--encrypt", action="store_true", dest="encrypt", default=False,
  46. help="Encrypts the backup")
  47. parser.add_option ("--no-encrypt", action="store_true",
  48. dest="no_encrypt", default=False,
  49. help="Skip encryption even if sending the backup to VM")
  50. parser.add_option ("-E", "--enc-algo", action="store",
  51. dest="crypto_algorithm", default=None,
  52. help="Specify non-default encryption algorithm. For "
  53. "list of supported algos execute 'openssl "
  54. "list-cipher-algorithms' (implies -e)")
  55. parser.add_option ("-H", "--hmac-algo", action="store",
  56. dest="hmac_algorithm", default=None,
  57. help="Specify non-default hmac algorithm. For list of "
  58. "supported algos execute 'openssl "
  59. "list-message-digest-algorithms'")
  60. parser.add_option ("-z", "--compress", action="store_true", dest="compress", default=False,
  61. help="Compress the backup")
  62. parser.add_option ("--debug", action="store_true", dest="debug",
  63. default=False, help="Enable (a lot of) debug output")
  64. (options, args) = parser.parse_args ()
  65. if (len (args) < 1):
  66. print >> sys.stderr, "You must specify the target backup directory (e.g. /mnt/backup)"
  67. print >> sys.stderr, "qvm-backup will create a subdirectory there for each individual backup."
  68. exit (0)
  69. base_backup_dir = args[0]
  70. if os.geteuid() == 0:
  71. if not options.force_root:
  72. print >> sys.stderr, "*** Running this tool as root is strongly discouraged, this will lead you in permissions problems."
  73. print >> sys.stderr, "Retry as unprivileged user."
  74. print >> sys.stderr, "... or use --force-root to continue anyway."
  75. exit(1)
  76. # Only for locking
  77. qvm_collection = QubesVmCollection()
  78. qvm_collection.lock_db_for_reading()
  79. qvm_collection.load()
  80. vms = None
  81. if (len (args) > 1):
  82. vms = [qvm_collection.get_vm_by_name(vmname) for vmname in args[1:]]
  83. if options.appvm:
  84. options.exclude_list.append(options.appvm)
  85. if options.appvm or options.crypto_algorithm:
  86. options.encrypt = True
  87. if options.no_encrypt:
  88. options.encrypt = False
  89. if options.debug:
  90. qubes.backup.BACKUP_DEBUG = True
  91. files_to_backup = None
  92. try:
  93. files_to_backup = backup_prepare(
  94. vms_list=vms,
  95. exclude_list=options.exclude_list,
  96. hide_vm_names=options.encrypt)
  97. except QubesException as e:
  98. print >>sys.stderr, "ERROR: %s" % str(e)
  99. exit(1)
  100. total_backup_sz = reduce(lambda size, file: size+file["size"],
  101. files_to_backup, 0)
  102. if not options.appvm:
  103. appvm = None
  104. if os.path.isdir(base_backup_dir):
  105. stat = os.statvfs(base_backup_dir)
  106. else:
  107. stat = os.statvfs(os.path.dirname(base_backup_dir))
  108. backup_fs_free_sz = stat.f_bsize * stat.f_bavail
  109. print
  110. if (total_backup_sz > backup_fs_free_sz):
  111. print >>sys.stderr, "ERROR: Not enough space available on the backup filesystem!"
  112. exit(1)
  113. print "-> Available space: {0}".format(size_to_human(backup_fs_free_sz))
  114. else:
  115. appvm = qvm_collection.get_vm_by_name(options.appvm)
  116. if appvm is None:
  117. print >>sys.stderr, "ERROR: VM {0} does not exist".format(options.appvm)
  118. exit(1)
  119. stat = os.statvfs('/var/tmp')
  120. backup_fs_free_sz = stat.f_bsize * stat.f_bavail
  121. print
  122. if (backup_fs_free_sz < 1000000000):
  123. print >>sys.stderr, "ERROR: Not enough space available " \
  124. "on the local filesystem (needs 1GB for temporary files)!"
  125. exit(1)
  126. if not appvm.is_running():
  127. appvm.start(verbose=True)
  128. if options.appvm:
  129. print >>sys.stderr, ("WARNING: VM {} excluded because it's used to "
  130. "store the backup.").format(options.appvm)
  131. options.exclude_list.append(options.appvm)
  132. if not options.encrypt:
  133. print >>sys.stderr, "WARNING: encryption will not be used"
  134. prompt = raw_input ("Do you want to proceed? [y/N] ")
  135. if not (prompt == "y" or prompt == "Y"):
  136. exit (0)
  137. if options.encrypt:
  138. passphrase = getpass.getpass("Please enter the pass phrase that will "
  139. "be used to encrypt and verify the "
  140. "backup: ")
  141. else:
  142. passphrase = getpass.getpass("Please enter the pass phrase that will "
  143. "be used to verify the backup: ")
  144. passphrase2 = getpass.getpass("Enter again for verification: ")
  145. if passphrase != passphrase2:
  146. print >>sys.stderr, "ERROR: Password mismatch"
  147. exit(1)
  148. passphrase = passphrase.decode(sys.stdin.encoding)
  149. kwargs = {}
  150. if options.hmac_algorithm:
  151. kwargs['hmac_algorithm'] = options.hmac_algorithm
  152. if options.crypto_algorithm:
  153. kwargs['crypto_algorithm'] = options.crypto_algorithm
  154. try:
  155. backup_do(base_backup_dir, files_to_backup, passphrase,
  156. progress_callback=print_progress,
  157. encrypted=options.encrypt,
  158. compressed=options.compress,
  159. appvm=appvm, **kwargs)
  160. except QubesException as e:
  161. print >>sys.stderr, "ERROR: %s" % str(e)
  162. exit(1)
  163. print
  164. print "-> Backup completed."
  165. qvm_collection.unlock_db()
  166. main()