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