1
diff --git a/cloudinit/sources/DataSourceOVF.py b/cloudinit/sources/DataSourceOVF.py
2
index f20c9a6..73d3877 100644
3
--- a/cloudinit/sources/DataSourceOVF.py
4
+++ b/cloudinit/sources/DataSourceOVF.py
5
@@ -25,6 +25,8 @@ from cloudinit.sources.helpers.vmware.imc.config_file \
6
25
    import ConfigFile
25
    import ConfigFile
7
26
from cloudinit.sources.helpers.vmware.imc.config_nic \
26
from cloudinit.sources.helpers.vmware.imc.config_nic \
8
27
    import NicConfigurator
27
    import NicConfigurator
9
28
from cloudinit.sources.helpers.vmware.imc.config_passwd \
10
29
    import PasswordConfigurator
11
28
from cloudinit.sources.helpers.vmware.imc.guestcust_error \
30
from cloudinit.sources.helpers.vmware.imc.guestcust_error \
12
29
    import GuestCustErrorEnum
31
    import GuestCustErrorEnum
13
30
from cloudinit.sources.helpers.vmware.imc.guestcust_event \
32
from cloudinit.sources.helpers.vmware.imc.guestcust_event \
14
@@ -117,6 +119,8 @@ class DataSourceOVF(sources.DataSource):
15
117
                (md, ud, cfg) = read_vmware_imc(conf)
119
                (md, ud, cfg) = read_vmware_imc(conf)
16
118
                dirpath = os.path.dirname(vmwareImcConfigFilePath)
120
                dirpath = os.path.dirname(vmwareImcConfigFilePath)
17
119
                nics = get_nics_to_enable(dirpath)
121
                nics = get_nics_to_enable(dirpath)
18
122
                markerid = conf.marker_id
19
123
                markerexists = check_marker_exists(markerid)
20
120
            except Exception as e:
124
            except Exception as e:
21
121
                LOG.debug("Error parsing the customization Config File")
125
                LOG.debug("Error parsing the customization Config File")
22
122
                LOG.exception(e)
126
                LOG.exception(e)
23
@@ -127,7 +131,6 @@ class DataSourceOVF(sources.DataSource):
24
127
                return False
131
                return False
25
128
            finally:
132
            finally:
26
129
                util.del_dir(os.path.dirname(vmwareImcConfigFilePath))
133
                util.del_dir(os.path.dirname(vmwareImcConfigFilePath))
27
130
28
131
            try:
134
            try:
29
132
                LOG.debug("Applying the Network customization")
135
                LOG.debug("Applying the Network customization")
30
133
                nicConfigurator = NicConfigurator(conf.nics)
136
                nicConfigurator = NicConfigurator(conf.nics)
31
@@ -140,6 +143,35 @@ class DataSourceOVF(sources.DataSource):
32
140
                    GuestCustEventEnum.GUESTCUST_EVENT_NETWORK_SETUP_FAILED)
143
                    GuestCustEventEnum.GUESTCUST_EVENT_NETWORK_SETUP_FAILED)
33
141
                enable_nics(nics)
144
                enable_nics(nics)
34
142
                return False
145
                return False
35
146
            if markerid and not markerexists:
36
147
                LOG.debug("Applying password customization")
37
148
                pwdConfigurator = PasswordConfigurator()
38
149
                adminpwd = conf.admin_password
39
150
                try:
40
151
                    resetpwd = conf.reset_password
41
152
                    if adminpwd or resetpwd:
42
153
                        pwdConfigurator.configure(adminpwd, resetpwd,
43
154
                                                  self.distro)
44
155
                    else:
45
156
                        LOG.debug("Changing password is not needed")
46
157
                except Exception as e:
47
158
                    LOG.debug("Error applying Password Configuration: %s", e)
48
159
                    set_customization_status(
49
160
                        GuestCustStateEnum.GUESTCUST_STATE_RUNNING,
50
161
                        GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED)
51
162
                    enable_nics(nics)
52
163
                    return False
53
164
            if markerid:
54
165
                LOG.debug("Handle marker creation")
55
166
                try:
56
167
                    setup_marker_files(markerid)
57
168
                except Exception as e:
58
169
                    LOG.debug("Error creating marker files: %s", e)
59
170
                    set_customization_status(
60
171
                        GuestCustStateEnum.GUESTCUST_STATE_RUNNING,
61
172
                        GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED)
62
173
                    enable_nics(nics)
63
174
                    return False
64
143
175
65
144
            vmwarePlatformFound = True
176
            vmwarePlatformFound = True
66
145
            set_customization_status(
177
            set_customization_status(
67
@@ -445,4 +477,33 @@ datasources = (
68
445
def get_datasource_list(depends):
477
def get_datasource_list(depends):
69
446
    return sources.list_from_depends(depends, datasources)
478
    return sources.list_from_depends(depends, datasources)
70
447
479
71
480
72
481
# To check if marker file exists
73
482
def check_marker_exists(markerid):
74
483
    """
75
484
    Check the existence of a marker file.
76
485
    Presence of marker file determines whether a certain code path is to be
77
486
    executed. It is needed for partial guest customization in VMware.
78
487
    """
79
488
    if not markerid:
80
489
        return False
81
490
    markerfile = "/.markerfile-" + markerid
82
491
    if os.path.exists(markerfile):
83
492
        return True
84
493
    return False
85
494
86
495
87
496
# Create a marker file
88
497
def setup_marker_files(markerid):
89
498
    """
90
499
    Create a new marker file.
91
500
    Marker files are unique to a full customization workflow in VMware
92
501
    environment.
93
502
    """
94
503
    if not markerid:
95
504
        return
96
505
    markerfile = "/.markerfile-" + markerid
97
506
    util.del_file("/.markerfile-*.txt")
98
507
    open(markerfile, 'w').close()
99
508
100
448
# vi: ts=4 expandtab
509
# vi: ts=4 expandtab
101
diff --git a/cloudinit/sources/helpers/vmware/imc/config.py b/cloudinit/sources/helpers/vmware/imc/config.py
102
index 9a5e3a8..49d441d 100644
103
--- a/cloudinit/sources/helpers/vmware/imc/config.py
104
+++ b/cloudinit/sources/helpers/vmware/imc/config.py
105
@@ -5,6 +5,7 @@
106
5
#
5
#
107
6
# This file is part of cloud-init. See LICENSE file for license information.
6
# This file is part of cloud-init. See LICENSE file for license information.
108
7
7
109
8
110
8
from .nic import Nic
9
from .nic import Nic
111
9
10
112
10
11
113
@@ -14,13 +15,16 @@ class Config(object):
114
14
    Specification file.
15
    Specification file.
115
15
    """
16
    """
116
16
17
117
18
    CUSTOM_SCRIPT = 'CUSTOM-SCRIPT|SCRIPT-NAME'
118
17
    DNS = 'DNS|NAMESERVER|'
19
    DNS = 'DNS|NAMESERVER|'
120
18
    SUFFIX = 'DNS|SUFFIX|'
20
    DOMAINNAME = 'NETWORK|DOMAINNAME'
121
21
    HOSTNAME = 'NETWORK|HOSTNAME'
122
22
    MARKERID = 'MISC|MARKER-ID'
123
19
    PASS = 'PASSWORD|-PASS'
23
    PASS = 'PASSWORD|-PASS'
124
24
    RESETPASS = 'PASSWORD|RESET'
125
25
    SUFFIX = 'DNS|SUFFIX|'
126
20
    TIMEZONE = 'DATETIME|TIMEZONE'
26
    TIMEZONE = 'DATETIME|TIMEZONE'
127
21
    UTC = 'DATETIME|UTC'
27
    UTC = 'DATETIME|UTC'
128
22
    HOSTNAME = 'NETWORK|HOSTNAME'
129
23
    DOMAINNAME = 'NETWORK|DOMAINNAME'
130
24
28
131
25
    def __init__(self, configFile):
29
    def __init__(self, configFile):
132
26
        self._configFile = configFile
30
        self._configFile = configFile
133
@@ -82,4 +86,18 @@ class Config(object):
134
82
86
135
83
        return res
87
        return res
136
84
88
137
89
    @property
138
90
    def reset_password(self):
139
91
        """Retreives if the root password needs to be reset."""
140
92
        resetPass = self._configFile.get(Config.RESETPASS, 'no')
141
93
        resetPass = resetPass.lower()
142
94
        if resetPass not in ('yes', 'no'):
143
95
            raise ValueError('ResetPassword value should be yes/no')
144
96
        return resetPass == 'yes'
145
97
146
98
    @property
147
99
    def marker_id(self):
148
100
        """Returns marker id."""
149
101
        return self._configFile.get(Config.MARKERID, None)
150
102
151
85
# vi: ts=4 expandtab
103
# vi: ts=4 expandtab
152
diff --git a/cloudinit/sources/helpers/vmware/imc/config_passwd.py b/cloudinit/sources/helpers/vmware/imc/config_passwd.py
153
86
new file mode 100644
104
new file mode 100644
154
index 0000000..75cfbaa
155
--- /dev/null
156
+++ b/cloudinit/sources/helpers/vmware/imc/config_passwd.py
157
@@ -0,0 +1,67 @@
158
1
#    Copyright (C) 2016 Canonical Ltd.
159
2
#    Copyright (C) 2016 VMware INC.
160
3
#
161
4
#    Author: Maitreyee Saikia <msaikia@vmware.com>
162
5
#
163
6
#    This file is part of cloud-init. See LICENSE file for license information.
164
7
165
8
166
9
import logging
167
10
import os
168
11
169
12
from cloudinit import util
170
13
171
14
LOG = logging.getLogger(__name__)
172
15
173
16
174
17
class PasswordConfigurator(object):
175
18
    """
176
19
    Class for changing configurations related to passwords in a VM. Includes
177
20
    setting and expiring passwords.
178
21
    """
179
22
    def configure(self, passwd, resetPasswd, distro):
180
23
        """
181
24
        Main method to perform all functionalities based on configuration file
182
25
        inputs.
183
26
        @param passwd: encoded admin password.
184
27
        @param resetPasswd: boolean to determine if password needs to be reset.
185
28
        @return cfg: dict to be used by cloud-init set_passwd code.
186
29
        """
187
30
        LOG.info('Starting password configuration')
188
31
        if passwd:
189
32
            passwd = util.b64d(passwd)
190
33
        allRootUsers = []
191
34
        for line in open('/etc/passwd', 'r'):
192
35
            if line.split(':')[2] == '0':
193
36
                allRootUsers.append(line.split(':')[0])
194
37
        # read shadow file and check for each user, if its uid0 or root.
195
38
        uidUsersList = []
196
39
        for line in open('/etc/shadow', 'r'):
197
40
            user = line.split(':')[0]
198
41
            if user in allRootUsers:
199
42
                uidUsersList.append(user)
200
43
        if passwd:
201
44
            LOG.info('Setting admin password')
202
45
            distro.set_passwd('root', passwd)
203
46
        if resetPasswd:
204
47
            self.reset_password(uidUsersList)
205
48
        LOG.info('Configure Password completed!')
206
49
207
50
    def reset_password(self, uidUserList):
208
51
        """
209
52
        Method to reset password. Use passwd --expire command. Use chage if
210
53
        not succeeded using passwd command. Log failure message otherwise.
211
54
        @param: list of users for which to expire password.
212
55
        """
213
56
        LOG.info('Expiring password.')
214
57
        for user in uidUserList:
215
58
            try:
216
59
                out, err = util.subp(['passwd', '--expire', user])
217
60
            except util.ProcessExecutionError as e:
218
61
                if os.path.exists('/usr/bin/chage'):
219
62
                    out, e = util.subp(['chage', '-d', '0', user])
220
63
                else:
221
64
                    LOG.warning('Failed to expire password for %s with error: '
222
65
                                '%s', user, e)
223
66
224
67
# vi: ts=4 expandtab
225
diff --git a/tests/unittests/test_vmware_config_file.py b/tests/unittests/test_vmware_config_file.py
226
index 18475f1..03b36d3 100644
227
--- a/tests/unittests/test_vmware_config_file.py
228
+++ b/tests/unittests/test_vmware_config_file.py
229
@@ -7,8 +7,8 @@
230
7
7
231
8
import logging
8
import logging
232
9
import sys
9
import sys
233
10
import unittest
234
11
10
235
11
from .helpers import CiTestCase
236
12
from cloudinit.sources.helpers.vmware.imc.boot_proto import BootProtoEnum
12
from cloudinit.sources.helpers.vmware.imc.boot_proto import BootProtoEnum
237
13
from cloudinit.sources.helpers.vmware.imc.config import Config
13
from cloudinit.sources.helpers.vmware.imc.config import Config
238
14
from cloudinit.sources.helpers.vmware.imc.config_file import ConfigFile
14
from cloudinit.sources.helpers.vmware.imc.config_file import ConfigFile
239
@@ -17,7 +17,7 @@ logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
240
17
logger = logging.getLogger(__name__)
17
logger = logging.getLogger(__name__)
241
18
18
242
19
19
244
20
class TestVmwareConfigFile(unittest.TestCase):
20
class TestVmwareConfigFile(CiTestCase):
245
21
21
246
22
    def test_utility_methods(self):
22
    def test_utility_methods(self):
247
23
        cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
23
        cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
248
@@ -90,4 +90,32 @@ class TestVmwareConfigFile(unittest.TestCase):
249
90
        self.assertEqual('00:50:56:a6:8c:08', nics[0].mac, "mac0")
90
        self.assertEqual('00:50:56:a6:8c:08', nics[0].mac, "mac0")
250
91
        self.assertEqual(BootProtoEnum.DHCP, nics[0].bootProto, "bootproto0")
91
        self.assertEqual(BootProtoEnum.DHCP, nics[0].bootProto, "bootproto0")
251
92
92
252
93
    def test_config_password(self):
253
94
        cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
254
95
255
96
        cf._insertKey("PASSWORD|-PASS", "test-password")
256
97
        cf._insertKey("PASSWORD|RESET", "no")
257
98
258
99
        conf = Config(cf)
259
100
        self.assertEqual('test-password', conf.admin_password, "password")
260
101
        self.assertFalse(conf.reset_password, "do not reset password")
261
102
262
103
    def test_config_reset_passwd(self):
263
104
        cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
264
105
265
106
        cf._insertKey("PASSWORD|-PASS", "test-password")
266
107
        cf._insertKey("PASSWORD|RESET", "random")
267
108
268
109
        conf = Config(cf)
269
110
        with self.assertRaises(ValueError):
270
111
            conf.reset_password()
271
112
272
113
        cf.clear()
273
114
        cf._insertKey("PASSWORD|RESET", "yes")
274
115
        self.assertEqual(1, len(cf), "insert size")
275
116
276
117
        conf = Config(cf)
277
118
        self.assertTrue(conf.reset_password, "reset password")
278
119
279
120
280
93
# vi: ts=4 expandtab
121
# vi: ts=4 expandtab
Status:	Merged
Approved by:	Chad Smith on 2017-08-15
Approved revision:	d9e02b9b1d777445c2a8151f56fa3a1a3ba35e1a
Merge reported by:	Chad Smith
Merged at revision:	d9e02b9b1d777445c2a8151f56fa3a1a3ba35e1a
Proposed branch:	~msaikia/cloud-init:topic-msaikia-vmware
Merge into:	cloud-init:master
Diff against target:	280 lines (+180/-6) 4 files modified cloudinit/sources/DataSourceOVF.py (+62/-1) cloudinit/sources/helpers/vmware/imc/config.py (+21/-3) cloudinit/sources/helpers/vmware/imc/config_passwd.py (+67/-0) tests/unittests/test_vmware_config_file.py (+30/-2)
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Chad Smith			Approve on 2017-08-15
Server Team CI bot	continuous-integration	2017-04-21	Approve on 2017-08-09
Scott Moser		2017-04-21	Pending
Review via email: mp+322991@code.launchpad.net