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

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