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