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