qvm_template_postprocess.py 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. #
  2. # The Qubes OS Project, https://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. ''' Tool for importing rpm-installed template'''
  21. import asyncio
  22. import glob
  23. import os
  24. import shutil
  25. import subprocess
  26. import sys
  27. import grp
  28. import qubesadmin
  29. import qubesadmin.exc
  30. import qubesadmin.tools
  31. try:
  32. # pylint: disable=wrong-import-position
  33. import qubesadmin.events.utils
  34. have_events = True
  35. except ImportError:
  36. have_events = False
  37. parser = qubesadmin.tools.QubesArgumentParser(
  38. description='Postprocess template package')
  39. parser.add_argument('--really', action='store_true', default=False,
  40. help='Really perform the action, YOU SHOULD REALLY KNOW WHAT YOU ARE DOING')
  41. parser.add_argument('--skip-start', action='store_true',
  42. help='Do not start the VM - do not retrieve menu entries etc.')
  43. parser.add_argument('--keep-source', action='store_true',
  44. help='Do not remove source data (*dir* directory) after import')
  45. parser.add_argument('action', choices=['post-install', 'pre-remove'],
  46. help='Action to perform')
  47. parser.add_argument('name', action='store',
  48. help='Template name')
  49. parser.add_argument('dir', action='store',
  50. help='Template directory')
  51. def get_root_img_size(source_dir):
  52. '''Extract size of root.img to be imported'''
  53. root_path = os.path.join(source_dir, 'root.img')
  54. if os.path.exists(root_path + '.part.00'):
  55. # get just file root_size from the tar header
  56. p = subprocess.Popen(['tar', 'tvf', root_path + '.part.00'],
  57. stdout=subprocess.PIPE, stderr=subprocess.DEVNULL)
  58. (stdout, _) = p.communicate()
  59. # -rw-r--r-- 0/0 1073741824 1970-01-01 01:00 root.img
  60. root_size = int(stdout.split()[2])
  61. elif os.path.exists(root_path):
  62. root_size = os.path.getsize(root_path)
  63. else:
  64. raise qubesadmin.exc.QubesException('root.img not found')
  65. return root_size
  66. def import_root_img(vm, source_dir):
  67. '''Import root.img into VM object'''
  68. root_size = get_root_img_size(source_dir)
  69. vm.volumes['root'].resize(root_size)
  70. root_path = os.path.join(source_dir, 'root.img')
  71. if os.path.exists(root_path + '.part.00'):
  72. input_files = glob.glob(root_path + '.part.*')
  73. cat = subprocess.Popen(['cat'] + sorted(input_files),
  74. stdout=subprocess.PIPE)
  75. tar = subprocess.Popen(['tar', 'xSOf', '-'],
  76. stdin=cat.stdout,
  77. stdout=subprocess.PIPE)
  78. cat.stdout.close()
  79. vm.volumes['root'].import_data(stream=tar.stdout)
  80. if tar.wait() != 0:
  81. raise qubesadmin.exc.QubesException('root.img extraction failed')
  82. if cat.wait() != 0:
  83. raise qubesadmin.exc.QubesException('root.img extraction failed')
  84. elif os.path.exists(root_path):
  85. if vm.app.qubesd_connection_type == 'socket':
  86. # check if root.img was already overwritten, i.e. if the source
  87. # and destination paths are the same
  88. vid = vm.volumes['root'].vid
  89. pool = vm.app.pools[vm.volumes['root'].pool]
  90. if (pool.driver in ('file', 'file-reflink')
  91. and root_path == os.path.join(pool.config['dir_path'],
  92. vid + '.img')):
  93. vm.log.info('root.img already in place, do not re-import')
  94. return
  95. with open(root_path, 'rb') as root_file:
  96. vm.volumes['root'].import_data(stream=root_file)
  97. def import_appmenus(vm, source_dir):
  98. '''Import appmenus settings into VM object (later: GUI VM)'''
  99. if os.getuid() == 0:
  100. try:
  101. qubes_group = grp.getgrnam('qubes')
  102. user = qubes_group.gr_mem[0]
  103. cmd_prefix = ['runuser', '-u', user, '--', 'env', 'DISPLAY=:0']
  104. except KeyError as e:
  105. vm.log.warning('Default user not found, not importing appmenus: ' +
  106. str(e))
  107. return
  108. else:
  109. cmd_prefix = []
  110. # TODO: change this to qrexec calls to GUI VM, when GUI VM will be
  111. # implemented
  112. try:
  113. subprocess.check_call(cmd_prefix + ['qvm-appmenus',
  114. '--set-default-whitelist={}'.format(os.path.join(source_dir,
  115. 'vm-whitelisted-appmenus.list')), vm.name])
  116. subprocess.check_call(cmd_prefix + ['qvm-appmenus',
  117. '--set-whitelist={}'.format(os.path.join(source_dir,
  118. 'whitelisted-appmenus.list')), vm.name])
  119. except subprocess.CalledProcessError as e:
  120. vm.log.warning('Failed to set default application list: %s', e)
  121. @asyncio.coroutine
  122. def call_postinstall_service(vm):
  123. '''Call qubes.PostInstall service
  124. And adjust related settings (netvm, features).
  125. '''
  126. # just created, so no need to save previous value - we know what it was
  127. vm.netvm = None
  128. # temporarily enable qrexec feature - so vm.start() will wait for it;
  129. # if start fails, rollback it
  130. vm.features['qrexec'] = True
  131. try:
  132. vm.start()
  133. except qubesadmin.exc.QubesException:
  134. del vm.features['qrexec']
  135. else:
  136. try:
  137. vm.run_service_for_stdio('qubes.PostInstall')
  138. except subprocess.CalledProcessError:
  139. vm.log.error('qubes.PostInstall service failed')
  140. vm.shutdown()
  141. if have_events:
  142. try:
  143. # pylint: disable=no-member
  144. yield from asyncio.wait_for(
  145. qubesadmin.events.utils.wait_for_domain_shutdown([vm]),
  146. qubesadmin.config.defaults['shutdown_timeout'])
  147. except asyncio.TimeoutError:
  148. vm.kill()
  149. else:
  150. timeout = qubesadmin.config.defaults['shutdown_timeout']
  151. while timeout >= 0:
  152. if vm.is_halted():
  153. break
  154. yield from asyncio.sleep(1)
  155. timeout -= 1
  156. if not vm.is_halted():
  157. vm.kill()
  158. finally:
  159. vm.netvm = qubesadmin.DEFAULT
  160. @asyncio.coroutine
  161. def post_install(args):
  162. '''Handle post-installation tasks'''
  163. app = args.app
  164. try:
  165. # reinstall
  166. vm = app.domains[args.name]
  167. except KeyError:
  168. if app.qubesd_connection_type == 'socket' and \
  169. args.dir == '/var/lib/qubes/vm-templates/' + args.name:
  170. # vm.create_on_disk() need to create the directory on its own,
  171. # move it away for from its way
  172. tmp_sourcedir = os.path.join('/var/lib/qubes/vm-templates',
  173. 'tmp-' + args.name)
  174. shutil.move(args.dir, tmp_sourcedir)
  175. args.dir = tmp_sourcedir
  176. vm = app.add_new_vm('TemplateVM',
  177. name=args.name,
  178. label=qubesadmin.config.defaults['template_label'])
  179. vm.log.info('Importing data')
  180. try:
  181. import_root_img(vm, args.dir)
  182. except:
  183. # if data import fails, remove half-created VM
  184. del app.domains[vm.name]
  185. raise
  186. vm.installed_by_rpm = True
  187. import_appmenus(vm, args.dir)
  188. if not args.skip_start:
  189. yield from call_postinstall_service(vm)
  190. if not args.keep_source:
  191. shutil.rmtree(args.dir)
  192. # if running as root, tell underlying storage layer about just freed
  193. # data blocks
  194. if os.getuid() == 0:
  195. subprocess.call(['sync', '-f', os.path.dirname(args.dir)])
  196. subprocess.call(['fstrim', os.path.dirname(args.dir)])
  197. return 0
  198. def pre_remove(args):
  199. '''Handle pre-removal tasks'''
  200. app = args.app
  201. try:
  202. tpl = app.domains[args.name]
  203. except KeyError:
  204. parser.error('No Qube with this name exists')
  205. for appvm in tpl.appvms:
  206. parser.error('Qube {} uses this template'.format(appvm.name))
  207. tpl.installed_by_rpm = False
  208. del app.domains[args.name]
  209. return 0
  210. def is_chroot():
  211. '''Detect if running inside chroot'''
  212. try:
  213. stat_root = os.stat('/')
  214. stat_init_root = os.stat('/proc/1/root/.')
  215. return (
  216. stat_root.st_dev != stat_init_root.st_dev or
  217. stat_root.st_ino != stat_init_root.st_ino)
  218. except IOError:
  219. print('Stat failed, assuming not chroot', file=sys.stderr)
  220. return False
  221. def main(args=None, app=None):
  222. '''Main function of qvm-template-postprocess'''
  223. args = parser.parse_args(args, app=app)
  224. if is_chroot():
  225. print('Running in chroot, ignoring request. Import template with:',
  226. file=sys.stderr)
  227. print(' '.join(sys.argv), file=sys.stderr)
  228. return
  229. if not args.really:
  230. parser.error('Do not call this tool directly.')
  231. if args.action == 'post-install':
  232. loop = asyncio.get_event_loop()
  233. try:
  234. loop.run_until_complete(post_install(args))
  235. loop.stop()
  236. loop.run_forever()
  237. finally:
  238. loop.close()
  239. elif args.action == 'pre-remove':
  240. pre_remove(args)
  241. else:
  242. parser.error('Unknown action')
  243. return 0
  244. if __name__ == '__main__':
  245. sys.exit(main())