28d58bd05dfbb26c3dfd37a31fab204f37f4138b
[snf-image-creator] / image_creator / os_type / freebsd.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 from image_creator.os_type.unix import Unix, sysprep
35
36 import re
37
38
39 class Freebsd(Unix):
40     """OS class for FreeBSD Unix-like os"""
41     def __init__(self, rootdev, ghandler, output):
42         super(Freebsd, self).__init__(rootdev, ghandler, output)
43
44     def _do_collect_metadata(self):
45
46         super(Freebsd, self)._do_collect_metadata()
47         self.meta["USERS"] = " ".join(self._get_passworded_users())
48
49         #The original product name key is long and ugly
50         self.meta['DESCRIPTION'] = \
51             self.meta['DESCRIPTION'].split('#')[0].strip()
52
53         # Delete the USERS metadata if empty
54         if not len(self.meta['USERS']):
55             self.out.warn("No passworded users found!")
56             del self.meta['USERS']
57
58     def _get_passworded_users(self):
59         users = []
60         regexp = re.compile(
61             '^([^:]+):((?:![^:]+)|(?:[^!*][^:]+)|):(?:[^:]*:){7}(?:[^:]*)'
62         )
63
64         for line in self.g.cat('/etc/master.passwd').splitlines():
65             line = line.split('#')[0]
66             match = regexp.match(line)
67             if not match:
68                 continue
69
70             user, passwd = match.groups()
71             if len(passwd) > 0 and passwd[0] == '!':
72                 self.out.warn("Ignoring locked %s account." % user)
73             else:
74                 users.append(user)
75
76         return users
77
78     def _do_mount(self, readonly):
79         """Mount partitions in the correct order"""
80
81         critical_mpoints = ('/', '/etc', '/root', '/home', '/var')
82
83         # libguestfs can't handle correct freebsd partitions on GUID
84         # Partition Table. We have to do the translation to linux
85         # device names ourselves
86         guid_device = re.compile('^/dev/((?:ada)|(?:vtbd))(\d+)p(\d+)$')
87
88         mopts = "ufstype=ufs2,%s" % ('ro' if readonly else 'rw')
89         for mp, dev in self._mountpoints():
90             match = guid_device.match(dev)
91             if match:
92                 m2 = int(match.group(2))
93                 m3 = int(match.group(3))
94                 dev = '/dev/sd%c%d' % (chr(ord('a') + m2), m3)
95             try:
96                 self.g.mount_vfs(mopts, 'ufs', dev, mp)
97             except RuntimeError as msg:
98                 if mp in critical_mpoints:
99                     self.out.warn('unable to mount %s. Reason: %s' % (mp, msg))
100                     return False
101                 else:
102                     self.out.warn('%s (ignored)' % msg)
103
104         return True
105
106     @sysprep()
107     def cleanup_password(self, print_header=True):
108         """Remove all passwords and lock all user accounts"""
109
110         if print_header:
111             self.out.output("Cleaning up passwords & locking all user "
112                             "accounts")
113
114         master_passwd = []
115
116         for line in self.g.cat('/etc/master.passwd').splitlines():
117
118             # Check for empty or comment lines
119             if len(line.split('#')[0]) == 0:
120                 master_passwd.append(line)
121                 continue
122
123             fields = line.split(':')
124             if fields[1] not in ('*', '!'):
125                 fields[1] = '!'
126
127             master_passwd.append(":".join(fields))
128
129         self.g.write('/etc/master.passwd', "\n".join(master_passwd) + '\n')
130
131         # Make sure no one can login on the system
132         self.g.rm_rf('/etc/spwd.db')
133
134 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :