Add exclude_task decorator in os_type
[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 import sys
36
37 from image_creator.os_type import OSBase, exclude_task
38 from image_creator.util import warn, output
39
40
41 class Unix(OSBase):
42
43     sensitive_userdata = [
44         '.bash_history',
45         '.gnupg',
46         '.ssh',
47         '.mozilla',
48         '.thunderbird'
49     ]
50
51     def get_metadata(self):
52         meta = super(Unix, self).get_metadata()
53         meta["USERS"] = " ".join(self.get_passworded_users())
54         return meta
55
56     def get_passworded_users(self):
57         users = []
58         regexp = re.compile('(\S+):((?:!\S+)|(?:[^!*]\S+)|):(?:\S*:){6}')
59
60         for line in self.g.cat('/etc/shadow').splitlines():
61             match = regexp.match(line)
62             if not match:
63                 continue
64
65             user, passwd = match.groups()
66             if len(passwd) > 0 and passwd[0] == '!':
67                 warn("Ignoring locked %s account." % user)
68             else:
69                 users.append(user)
70
71         return users
72
73     def data_cleanup_cache(self, print_header=True):
74         """Remove all regular files under /var/cache"""
75
76         if print_header:
77             output('Removing files under /var/cache')
78
79         self.foreach_file('/var/cache', self.g.rm, ftype='r')
80
81     def data_cleanup_tmp(self, print_header=True):
82         """Remove all files under /tmp and /var/tmp"""
83
84         if print_header:
85             output('Removing files under /tmp and /var/tmp')
86
87         self.foreach_file('/tmp', self.g.rm_rf, maxdepth=1)
88         self.foreach_file('/var/tmp', self.g.rm_rf, maxdepth=1)
89
90     def data_cleanup_log(self, print_header=True):
91         """Empty all files under /var/log"""
92
93         if print_header:
94             output('Emptying all files under /var/log')
95
96         self.foreach_file('/var/log', self.g.truncate, ftype='r')
97
98     @exclude_task
99     def data_cleanup_mail(self, print_header=True):
100         """Remove all files under /var/mail and /var/spool/mail"""
101
102         if print_header:
103             output('Removing files under /var/mail and /var/spool/mail')
104
105         self.foreach_file('/var/spool/mail', self.g.rm_rf, maxdepth=1)
106         self.foreach_file('/var/mail', self.g.rm_rf, maxdepth=1)
107
108     def data_cleanup_userdata(self, print_header=True):
109         """Delete sensitive userdata"""
110
111         homedirs = ['/root'] + self.ls('/home/')
112
113         if print_header:
114             output('Removing sensitive user data under %s' % " ".
115                                                         join(homedirs))
116
117         for homedir in homedirs:
118             for data in self.sensitive_userdata:
119                 fname = "%s/%s" % (homedir, data)
120                 if self.g.is_file(fname):
121                     self.g.scrub_file(fname)
122
123 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :