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 import re
  39
  40 from image_creator.os_type import OSBase, sysprep
  41
  42
  43 class Unix(OSBase):
  44     """OS class for Unix"""
  45     sensitive_userdata = [
  46         '.history',
  47         '.bash_history',
  48         '.gnupg',
  49         '.ssh',
  50         '.kamakirc',
  51         '.kamaki.history'
  52     ]
  53
  54     def _mountpoints(self):
  55         """Return mountpoints in the correct order.
  56         / should be mounted before /boot or /usr, /usr befor /usr/bin ...
  57         """
  58         mps = self.g.inspect_get_mountpoints(self.root)
  59
  60         def compare(a, b):
  61             if len(a[0]) > len(b[0]):
  62                 return 1
  63             elif len(a[0]) == len(b[0]):
  64                 return 0
  65             else:
  66                 return -1
  67         mps.sort(compare)
  68
  69         for mp in mps:
  70             yield mp
  71
  72     def _do_mount(self, readonly):
  73         """Mount partitions in the correct order"""
  74
  75         critical_mpoints = ('/', '/etc', '/root', '/home', '/var')
  76
  77         mopts = 'ro' if readonly else 'rw'
  78         for mp, dev in self._mountpoints():
  79             try:
  80                 self.g.mount_options(mopts, dev, mp)
  81             except RuntimeError as msg:
  82                 if mp in critical_mpoints:
  83                     self.out.warn('unable to mount %s. Reason: %s' % (mp, msg))
  84                     return False
  85                 else:
  86                     self.out.warn('%s (ignored)' % msg)
  87
  88         return True
  89
  90     @sysprep()
  91     def cleanup_cache(self, print_header=True):
  92         """Remove all regular files under /var/cache"""
  93
  94         if print_header:
  95             self.out.output('Removing files under /var/cache')
  96
  97         self._foreach_file('/var/cache', self.g.rm, ftype='r')
  98
  99     @sysprep()
 100     def cleanup_tmp(self, print_header=True):
 101         """Remove all files under /tmp and /var/tmp"""
 102
 103         if print_header:
 104             self.out.output('Removing files under /tmp and /var/tmp')
 105
 106         self._foreach_file('/tmp', self.g.rm_rf, maxdepth=1)
 107         self._foreach_file('/var/tmp', self.g.rm_rf, maxdepth=1)
 108
 109     @sysprep()
 110     def cleanup_log(self, print_header=True):
 111         """Empty all files under /var/log"""
 112
 113         if print_header:
 114             self.out.output('Emptying all files under /var/log')
 115
 116         self._foreach_file('/var/log', self.g.truncate, ftype='r')
 117
 118     @sysprep(enabled=False)
 119     def cleanup_mail(self, print_header=True):
 120         """Remove all files under /var/mail and /var/spool/mail"""
 121
 122         if print_header:
 123             self.out.output('Removing files under /var/mail & /var/spool/mail')
 124
 125         if self.g.is_dir('/var/spool/mail'):
 126             self._foreach_file('/var/spool/mail', self.g.rm_rf, maxdepth=1)
 127
 128         self._foreach_file('/var/mail', self.g.rm_rf, maxdepth=1)
 129
 130     @sysprep()
 131     def cleanup_userdata(self, print_header=True):
 132         """Delete sensitive userdata"""
 133
 134         homedirs = ['/root']
 135         if self.g.is_dir('/home/'):
 136             homedirs += self._ls('/home/')
 137
 138         if print_header:
 139             self.out.output("Removing sensitive user data under %s" %
 140                             " ".join(homedirs))
 141
 142         action = self.g.rm_rf
 143         if self._scrub_support:
 144             action = self.g.scrub_file
 145         else:
 146             self.out.warn("Sensitive data won't be scrubbed (not supported)")
 147         for homedir in homedirs:
 148             for data in self.sensitive_userdata:
 149                 fname = "%s/%s" % (homedir, data)
 150                 if self.g.is_file(fname):
 151                     action(fname)
 152                 elif self.g.is_dir(fname):
 153                     self._foreach_file(fname, action, ftype='r')
 154
 155 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :