Fix a bug in image shrinking code
[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
39
40 class Unix(OSBase):
41
42     sensitive_userdata = [
43         '.bash_history',
44         '.gnupg',
45         '.ssh'
46     ]
47
48     def __init__(self, rootdev, ghandler, output):
49         super(Unix, self).__init__(rootdev, ghandler, output)
50
51         self.meta["USERS"] = " ".join(self._get_passworded_users())
52         # Delete the USERS metadata if empty
53         if not len(self.meta['USERS']):
54             self.out.warn("No passworded users found!")
55             del self.meta['USERS']
56
57     def _get_passworded_users(self):
58         users = []
59         regexp = re.compile('(\S+):((?:!\S+)|(?:[^!*]\S+)|):(?:\S*:){6}')
60
61         for line in self.g.cat('/etc/shadow').splitlines():
62             match = regexp.match(line)
63             if not match:
64                 continue
65
66             user, passwd = match.groups()
67             if len(passwd) > 0 and passwd[0] == '!':
68                 self.out.warn("Ignoring locked %s account." % user)
69             else:
70                 users.append(user)
71
72         return users
73
74     @sysprep(enabled=False)
75     def remove_user_accounts(self, print_header=True):
76         """Remove all user accounts with id greater than 1000"""
77
78         if print_header:
79             self.out.output("Removing all user accounts with id greater than "
80                             "1000")
81
82         if 'USERS' not in self.meta:
83             return
84
85         # Remove users from /etc/passwd
86         passwd = []
87         removed_users = {}
88         metadata_users = self.meta['USERS'].split()
89         for line in self.g.cat('/etc/passwd').splitlines():
90             fields = line.split(':')
91             if int(fields[2]) > 1000:
92                 removed_users[fields[0]] = fields
93                 # remove it from the USERS metadata too
94                 if fields[0] in metadata_users:
95                     metadata_users.remove(fields[0])
96             else:
97                 passwd.append(':'.join(fields))
98
99         self.meta['USERS'] = " ".join(metadata_users)
100
101         # Delete the USERS metadata if empty
102         if not len(self.meta['USERS']):
103             del self.meta['USERS']
104
105         self.g.write('/etc/passwd', '\n'.join(passwd) + '\n')
106
107         # Remove the corresponding /etc/shadow entries
108         shadow = []
109         for line in self.g.cat('/etc/shadow').splitlines():
110             fields = line.split(':')
111             if fields[0] not in removed_users:
112                 shadow.append(':'.join(fields))
113
114         self.g.write('/etc/shadow', "\n".join(shadow) + '\n')
115
116         # Remove the corresponding /etc/group entries
117         group = []
118         for line in self.g.cat('/etc/group').splitlines():
119             fields = line.split(':')
120             # Remove groups tha have the same name as the removed users
121             if fields[0] not in removed_users:
122                 group.append(':'.join(fields))
123
124         self.g.write('/etc/group', '\n'.join(group) + '\n')
125
126         # Remove home directories
127         for home in [field[5] for field in removed_users.values()]:
128             if self.g.is_dir(home) and home.startswith('/home/'):
129                 self.g.rm_rf(home)
130
131     @sysprep()
132     def cleanup_passwords(self, print_header=True):
133         """Remove all passwords and lock all user accounts"""
134
135         if print_header:
136             self.out.output("Cleaning up passwords & locking all user "
137                             "accounts")
138
139         shadow = []
140
141         for line in self.g.cat('/etc/shadow').splitlines():
142             fields = line.split(':')
143             if fields[1] not in ('*', '!'):
144                 fields[1] = '!'
145
146             shadow.append(":".join(fields))
147
148         self.g.write('/etc/shadow', "\n".join(shadow) + '\n')
149
150     @sysprep()
151     def cleanup_cache(self, print_header=True):
152         """Remove all regular files under /var/cache"""
153
154         if print_header:
155             self.out.output('Removing files under /var/cache')
156
157         self.foreach_file('/var/cache', self.g.rm, ftype='r')
158
159     @sysprep()
160     def cleanup_tmp(self, print_header=True):
161         """Remove all files under /tmp and /var/tmp"""
162
163         if print_header:
164             self.out.output('Removing files under /tmp and /var/tmp')
165
166         self.foreach_file('/tmp', self.g.rm_rf, maxdepth=1)
167         self.foreach_file('/var/tmp', self.g.rm_rf, maxdepth=1)
168
169     @sysprep()
170     def cleanup_log(self, print_header=True):
171         """Empty all files under /var/log"""
172
173         if print_header:
174             self.out.output('Emptying all files under /var/log')
175
176         self.foreach_file('/var/log', self.g.truncate, ftype='r')
177
178     @sysprep(enabled=False)
179     def cleanup_mail(self, print_header=True):
180         """Remove all files under /var/mail and /var/spool/mail"""
181
182         if print_header:
183             self.out.output('Removing files under /var/mail & /var/spool/mail')
184
185         self.foreach_file('/var/spool/mail', self.g.rm_rf, maxdepth=1)
186         self.foreach_file('/var/mail', self.g.rm_rf, maxdepth=1)
187
188     @sysprep()
189     def cleanup_userdata(self, print_header=True):
190         """Delete sensitive userdata"""
191
192         homedirs = ['/root'] + self.ls('/home/')
193
194         if print_header:
195             self.out.output("Removing sensitive user data under %s" %
196                             " ".join(homedirs))
197
198         for homedir in homedirs:
199             for data in self.sensitive_userdata:
200                 fname = "%s/%s" % (homedir, data)
201                 if self.g.is_file(fname):
202                     self.g.scrub_file(fname)
203                 elif self.g.is_dir(fname):
204                     self.foreach_file(fname, self.g.scrub_file, ftype='r')
205
206 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :