8489d4dec8ce6017f5c77f0bc9efd0ddc56efb9b
[snf-image-creator] / 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 __init__(self, rootdev, ghandler, output):
51         super(Unix, self).__init__(rootdev, ghandler, output)
52
53     @sysprep()
54     def cleanup_cache(self, print_header=True):
55         """Remove all regular files under /var/cache"""
56
57         if print_header:
58             self.out.output('Removing files under /var/cache')
59
60         self.foreach_file('/var/cache', self.g.rm, ftype='r')
61
62     @sysprep()
63     def cleanup_tmp(self, print_header=True):
64         """Remove all files under /tmp and /var/tmp"""
65
66         if print_header:
67             self.out.output('Removing files under /tmp and /var/tmp')
68
69         self.foreach_file('/tmp', self.g.rm_rf, maxdepth=1)
70         self.foreach_file('/var/tmp', self.g.rm_rf, maxdepth=1)
71
72     @sysprep()
73     def cleanup_log(self, print_header=True):
74         """Empty all files under /var/log"""
75
76         if print_header:
77             self.out.output('Emptying all files under /var/log')
78
79         self.foreach_file('/var/log', self.g.truncate, ftype='r')
80
81     @sysprep(enabled=False)
82     def cleanup_mail(self, print_header=True):
83         """Remove all files under /var/mail and /var/spool/mail"""
84
85         if print_header:
86             self.out.output('Removing files under /var/mail & /var/spool/mail')
87
88         self.foreach_file('/var/spool/mail', self.g.rm_rf, maxdepth=1)
89         self.foreach_file('/var/mail', self.g.rm_rf, maxdepth=1)
90
91     @sysprep()
92     def cleanup_userdata(self, print_header=True):
93         """Delete sensitive userdata"""
94
95         homedirs = ['/root'] + self.ls('/home/')
96
97         if print_header:
98             self.out.output("Removing sensitive user data under %s" %
99                             " ".join(homedirs))
100
101         for homedir in homedirs:
102             for data in self.sensitive_userdata:
103                 fname = "%s/%s" % (homedir, data)
104                 if self.g.is_file(fname):
105                     self.g.scrub_file(fname)
106                 elif self.g.is_dir(fname):
107                     self.foreach_file(fname, self.g.scrub_file, ftype='r')
108
109 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :