Add options for enabling/disabling sysprep tasks
[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, sysprep
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     @sysprep(enabled=False)
74     def remove_user_accounts(self, print_header=True):
75         """Remove all user account with id more than 1000"""
76
77         if print_header:
78             output('Removing all user accounts with id greater than 1000')
79
80         # Remove users from /etc/passwd
81         passwd = []
82         removed_users = {}
83         for line in self.g.cat('/etc/passwd').splitlines():
84             fields = line.split(':')
85             if int(fields[2]) > 1000:
86                 removed_users[fields[0]] = fields
87             else:
88                 passwd.append(':'.join(fields))
89
90         self.g.write('/etc/passwd', '\n'.join(passwd) + '\n')
91
92         # Remove the corresponding /etc/shadow entries
93         shadow = []
94         for line in self.g.cat('/etc/shadow').splitlines():
95             fields = line.split(':')
96             if fields[0] not in removed_users:
97                 shadow.append(':'.join(fields))
98
99         self.g.write('/etc/shadow', "\n".join(shadow) + '\n')
100
101         # Remove the corresponding /etc/group entries
102         group = []
103         for line in self.g.cat('/etc/group').splitlines():
104             fields = line.split(':')
105             # Remove groups tha have the same name as the removed users
106             if fields[0] not in removed_users:
107                 group.append(':'.join(fields))
108
109         self.g.write('/etc/group', '\n'.join(group) + '\n')
110
111         # Remove home directories
112         for home in [field[5] for field in removed_users.values()]:
113             if self.g.is_dir(home) and home.startswith('/home/'):
114                 self.g.rm_rf(home)
115
116     @sysprep()
117     def cleanup_passwords(self, print_header=True):
118         """Remove all passwords and lock all user accounts"""
119
120         if print_header:
121             output('Cleaning up passwords & locking all user accounts')
122
123         shadow = []
124
125         for line in self.g.cat('/etc/shadow').splitlines():
126             fields = line.split(':')
127             if fields[1] not in ('*', '!'):
128                 fields[1] = '!'
129
130             shadow.append(":".join(fields))
131
132         self.g.write('/etc/shadow', "\n".join(shadow) + '\n')
133
134     @sysprep()
135     def cleanup_cache(self, print_header=True):
136         """Remove all regular files under /var/cache"""
137
138         if print_header:
139             output('Removing files under /var/cache')
140
141         self.foreach_file('/var/cache', self.g.rm, ftype='r')
142
143     @sysprep()
144     def cleanup_tmp(self, print_header=True):
145         """Remove all files under /tmp and /var/tmp"""
146
147         if print_header:
148             output('Removing files under /tmp and /var/tmp')
149
150         self.foreach_file('/tmp', self.g.rm_rf, maxdepth=1)
151         self.foreach_file('/var/tmp', self.g.rm_rf, maxdepth=1)
152
153     @sysprep()
154     def cleanup_log(self, print_header=True):
155         """Empty all files under /var/log"""
156
157         if print_header:
158             output('Emptying all files under /var/log')
159
160         self.foreach_file('/var/log', self.g.truncate, ftype='r')
161
162     @sysprep(enabled=False)
163     def cleanup_mail(self, print_header=True):
164         """Remove all files under /var/mail and /var/spool/mail"""
165
166         if print_header:
167             output('Removing files under /var/mail and /var/spool/mail')
168
169         self.foreach_file('/var/spool/mail', self.g.rm_rf, maxdepth=1)
170         self.foreach_file('/var/mail', self.g.rm_rf, maxdepth=1)
171
172     @sysprep()
173     def cleanup_userdata(self, print_header=True):
174         """Delete sensitive userdata"""
175
176         homedirs = ['/root'] + self.ls('/home/')
177
178         if print_header:
179             output('Removing sensitive user data under %s' % " ".
180                                                         join(homedirs))
181
182         for homedir in homedirs:
183             for data in self.sensitive_userdata:
184                 fname = "%s/%s" % (homedir, data)
185                 if self.g.is_file(fname):
186                     self.g.scrub_file(fname)
187
188 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :