code.grnet.gr Git - snf-image-creator/blob - image_creator/os_type/unix.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright 2012 GRNET S.A. All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or
   6 # without modification, are permitted provided that the following
   7 # conditions are met:
   8 #
   9 #   1. Redistributions of source code must retain the above
  10 #      copyright notice, this list of conditions and the following
  11 #      disclaimer.
  12 #
  13 #   2. Redistributions in binary form must reproduce the above
  14 #      copyright notice, this list of conditions and the following
  15 #      disclaimer in the documentation and/or other materials
  16 #      provided with the distribution.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  19 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  22 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  25 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  28 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29 # POSSIBILITY OF SUCH DAMAGE.
  30 #
  31 # The views and conclusions contained in the software and
  32 # documentation are those of the authors and should not be
  33 # interpreted as representing official policies, either expressed
  34 # or implied, of GRNET S.A.
  35
  36 """This module hosts OS-specific code common to all Unix-like OSs."""
  37
  38 from image_creator.os_type import OSBase, sysprep
  39
  40
  41 class Unix(OSBase):
  42     """OS class for Unix"""
  43     sensitive_userdata = [
  44         '.history',
  45         '.bash_history',
  46         '.gnupg',
  47         '.ssh',
  48         '.kamakirc',
  49         '.kamaki.history'
  50     ]
  51
  52     def _mountpoints(self):
  53         """Return mountpoints in the correct order.
  54         / should be mounted before /boot or /usr, /usr befor /usr/bin ...
  55         """
  56         mps = self.image.g.inspect_get_mountpoints(self.root)
  57
  58         def compare(a, b):
  59             if len(a[0]) > len(b[0]):
  60                 return 1
  61             elif len(a[0]) == len(b[0]):
  62                 return 0
  63             else:
  64                 return -1
  65         mps.sort(compare)
  66
  67         for mp in mps:
  68             yield mp
  69
  70     def _do_mount(self, readonly):
  71         """Mount partitions in the correct order"""
  72
  73         critical_mpoints = ('/', '/etc', '/root', '/home', '/var')
  74
  75         mopts = 'ro' if readonly else 'rw'
  76         for mp, dev in self._mountpoints():
  77             try:
  78                 self.image.g.mount_options(mopts, dev, mp)
  79             except RuntimeError as msg:
  80                 if mp in critical_mpoints:
  81                     self.out.warn('unable to mount %s. Reason: %s' % (mp, msg))
  82                     return False
  83                 else:
  84                     self.out.warn('%s (ignored)' % msg)
  85
  86         return True
  87
  88     @sysprep('Removing files under /var/cache')
  89     def cleanup_cache(self):
  90         """Remove all regular files under /var/cache"""
  91
  92         self._foreach_file('/var/cache', self.image.g.rm, ftype='r')
  93
  94     @sysprep('Removing files under /tmp and /var/tmp')
  95     def cleanup_tmp(self):
  96         """Remove all files under /tmp and /var/tmp"""
  97
  98         self._foreach_file('/tmp', self.image.g.rm_rf, maxdepth=1)
  99         self._foreach_file('/var/tmp', self.image.g.rm_rf, maxdepth=1)
 100
 101     @sysprep('Emptying all files under /var/log')
 102     def cleanup_log(self):
 103         """Empty all files under /var/log"""
 104
 105         self._foreach_file('/var/log', self.image.g.truncate, ftype='r')
 106
 107     @sysprep('Removing files under /var/mail & /var/spool/mail', enabled=False)
 108     def cleanup_mail(self):
 109         """Remove all files under /var/mail and /var/spool/mail"""
 110
 111         if self.image.g.is_dir('/var/spool/mail'):
 112             self._foreach_file('/var/spool/mail', self.image.g.rm_rf,
 113                                maxdepth=1)
 114
 115         self._foreach_file('/var/mail', self.image.g.rm_rf, maxdepth=1)
 116
 117     @sysprep('Removing sensitive user data')
 118     def cleanup_userdata(self):
 119         """Delete sensitive userdata"""
 120
 121         homedirs = ['/root']
 122         if self.image.g.is_dir('/home/'):
 123             homedirs += self._ls('/home/')
 124
 125         action = self.image.g.rm_rf
 126         if self._scrub_support:
 127             action = self.image.g.scrub_file
 128         else:
 129             self.out.warn("Sensitive data won't be scrubbed (not supported)")
 130
 131         for homedir in homedirs:
 132             for data in self.sensitive_userdata:
 133                 fname = "%s/%s" % (homedir, data)
 134                 if self.image.g.is_file(fname):
 135                     action(fname)
 136                 elif self.image.g.is_dir(fname):
 137                     self._foreach_file(fname, action, ftype='r')
 138
 139 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :