4 # Test case QMP's encrypted key management
6 # Copyright (C) 2019 Red Hat, Inc.
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 2 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
27 test_img = os.path.join(iotests.test_dir, 'test.img')
30 def __init__(self, index):
31 self._id = "keysec" + str(index)
32 # you are not supposed to see the password...
33 self._secret = "hunter" + str(index)
41 def to_cmdline_object(self):
42 return [ "secret,id=" + self._id + ",data=" + self._secret]
44 def to_qmp_object(self):
45 return { "qom_type" : "secret", "id": self.id(),
46 "data": self.secret() }
48 ################################################################################
49 class EncryptionSetupTestCase(iotests.QMPTestCase):
54 self.vm = iotests.VM()
57 # create the secrets and load 'em into the VM
58 self.secrets = [ Secret(i) for i in range(0, 6) ]
59 for secret in self.secrets:
60 result = self.vm.qmp("object-add", **secret.to_qmp_object())
61 self.assert_qmp(result, 'return', {})
63 if iotests.imgfmt == "qcow2":
65 self.img_opts = [ '-o', "encrypt.format=luks" ]
75 ###########################################################################
76 # create the encrypted block device
77 def createImg(self, file, secret):
81 '--object', *secret.to_cmdline_object(),
83 '-o', self.pfx + 'key-secret=' + secret.id(),
84 '-o', self.pfx + 'iter-time=10',
89 ###########################################################################
90 # open an encrypted block device
91 def openImageQmp(self, id, file, secret, read_only = False):
94 'key-secret' : secret.id()
97 if iotests.imgfmt == "qcow2":
105 result = self.vm.qmp('blockdev-add', **
107 'driver': iotests.imgfmt,
109 'read-only': read_only,
115 'filename': test_img,
119 self.assert_qmp(result, 'return', {})
121 # close the encrypted block device
122 def closeImageQmp(self, id):
123 result = self.vm.qmp('blockdev-del', **{ 'node-name': id })
124 self.assert_qmp(result, 'return', {})
126 ###########################################################################
127 # add a key to an encrypted block device
128 def addKeyQmp(self, id, new_secret, secret = None,
129 slot = None, force = False):
133 'new-secret' : new_secret.id(),
138 crypt_options['keyslot'] = slot
142 crypt_options['secret'] = secret.id()
144 if iotests.imgfmt == "qcow2":
145 crypt_options['format'] = 'luks'
147 'encrypt': crypt_options
152 'job-id' : 'job_add_key',
154 'driver' : iotests.imgfmt,
162 #TODO: check what jobs return
163 result = self.vm.qmp('x-blockdev-amend', **args)
164 assert result['return'] == {}
165 self.vm.run_job('job_add_key')
167 # erase a key from an encrypted block device
168 def eraseKeyQmp(self, id, old_secret = None, slot = None, force = False):
171 'state' : 'inactive',
175 crypt_options['keyslot'] = slot
176 if old_secret != None:
177 crypt_options['old-secret'] = old_secret.id()
179 if iotests.imgfmt == "qcow2":
180 crypt_options['format'] = 'luks'
182 'encrypt': crypt_options
187 'job-id' : 'job_erase_key',
189 'driver' : iotests.imgfmt,
197 result = self.vm.qmp('x-blockdev-amend', **args)
198 assert result['return'] == {}
199 self.vm.run_job('job_erase_key')
201 ###########################################################################
202 # create image, and change its key
203 def testChangeKey(self):
205 # create the image with secret0 and open it
206 self.createImg(test_img, self.secrets[0]);
207 self.openImageQmp("testdev", test_img, self.secrets[0])
210 self.addKeyQmp("testdev", new_secret = self.secrets[1])
213 self.addKeyQmp("testdev", new_secret = self.secrets[2], slot=5)
215 # erase key from slot 0
216 self.eraseKeyQmp("testdev", old_secret = self.secrets[0])
218 #reopen the image with secret1
219 self.closeImageQmp("testdev")
220 self.openImageQmp("testdev", test_img, self.secrets[1])
222 # close and erase the image for good
223 self.closeImageQmp("testdev")
226 # test that if we erase the old password,
227 # we can still change the encryption keys using 'old-secret'
228 def testOldPassword(self):
230 # create the image with secret0 and open it
231 self.createImg(test_img, self.secrets[0]);
232 self.openImageQmp("testdev", test_img, self.secrets[0])
235 self.addKeyQmp("testdev", new_secret = self.secrets[1])
237 # erase key from slot 0
238 self.eraseKeyQmp("testdev", old_secret = self.secrets[0])
240 # this will fail as the old password is no longer valid
241 self.addKeyQmp("testdev", new_secret = self.secrets[2])
244 self.addKeyQmp("testdev", new_secret = self.secrets[2], secret = self.secrets[1])
246 # close and erase the image for good
247 self.closeImageQmp("testdev")
250 def testUseForceLuke(self):
252 self.createImg(test_img, self.secrets[0]);
253 self.openImageQmp("testdev", test_img, self.secrets[0])
255 # Add bunch of secrets
256 self.addKeyQmp("testdev", new_secret = self.secrets[1], slot=4)
257 self.addKeyQmp("testdev", new_secret = self.secrets[4], slot=2)
259 # overwrite an active secret
260 self.addKeyQmp("testdev", new_secret = self.secrets[5], slot=2)
261 self.addKeyQmp("testdev", new_secret = self.secrets[5], slot=2, force=True)
263 self.addKeyQmp("testdev", new_secret = self.secrets[0])
265 # Now erase all the secrets
266 self.eraseKeyQmp("testdev", old_secret = self.secrets[5])
267 self.eraseKeyQmp("testdev", slot=4)
270 self.eraseKeyQmp("testdev", old_secret = self.secrets[0])
271 self.eraseKeyQmp("testdev", old_secret = self.secrets[0], force=True)
273 self.closeImageQmp("testdev")
277 if __name__ == '__main__':
278 iotests.verify_working_luks()
279 # Encrypted formats support
280 iotests.activate_logging()
281 iotests.main(supported_fmts = ['qcow2', 'luks'])