1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
from ceph_volume.util import encryption
from mock.mock import call, patch, Mock, MagicMock
from typing import Any
import base64
import pytest
import json
class TestNoWorkqueue:
def setup_method(self):
encryption.conf.dmcrypt_no_workqueue = None
@patch('ceph_volume.util.encryption.process.call',
Mock(return_value=(['cryptsetup 2.7.2 flags: UDEV BLKID KEYRING' \
'FIPS KERNEL_CAPI PWQUALITY '], [''], 0)))
def test_set_dmcrypt_no_workqueue_true(self):
encryption.set_dmcrypt_no_workqueue()
assert encryption.conf.dmcrypt_no_workqueue
@patch('ceph_volume.util.encryption.process.call',
Mock(return_value=(['cryptsetup 2.0.0'], [''], 0)))
def test_set_dmcrypt_no_workqueue_false(self):
encryption.set_dmcrypt_no_workqueue()
assert encryption.conf.dmcrypt_no_workqueue is None
@patch('ceph_volume.util.encryption.process.call',
Mock(return_value=([''], ['fake error'], 1)))
def test_set_dmcrypt_no_workqueue_cryptsetup_version_fails(self):
with pytest.raises(RuntimeError):
encryption.set_dmcrypt_no_workqueue()
@patch('ceph_volume.util.encryption.process.call',
Mock(return_value=(['unexpected output'], [''], 0)))
def test_set_dmcrypt_no_workqueue_pattern_not_found(self):
with pytest.raises(RuntimeError):
encryption.set_dmcrypt_no_workqueue()
@patch('ceph_volume.util.encryption.process.call',
Mock(return_value=([], [''], 0)))
def test_set_dmcrypt_no_workqueue_index_error(self):
with pytest.raises(RuntimeError):
encryption.set_dmcrypt_no_workqueue()
class TestGetKeySize(object):
def test_get_size_from_conf_default(self, conf_ceph_stub):
conf_ceph_stub('''
[global]
fsid=asdf
''')
assert encryption.get_key_size_from_conf() == '512'
def test_get_size_from_conf_custom(self, conf_ceph_stub):
conf_ceph_stub('''
[global]
fsid=asdf
[osd]
osd_dmcrypt_key_size=256
''')
assert encryption.get_key_size_from_conf() == '256'
def test_get_size_from_conf_custom_invalid(self, conf_ceph_stub):
conf_ceph_stub('''
[global]
fsid=asdf
[osd]
osd_dmcrypt_key_size=1024
''')
assert encryption.get_key_size_from_conf() == '512'
class TestStatus(object):
def test_skips_unuseful_lines(self, stub_call):
out = ['some line here', ' device: /dev/sdc1']
stub_call((out, '', 0))
assert encryption.status('/dev/sdc1') == {'device': '/dev/sdc1'}
def test_removes_extra_quotes(self, stub_call):
out = ['some line here', ' device: "/dev/sdc1"']
stub_call((out, '', 0))
assert encryption.status('/dev/sdc1') == {'device': '/dev/sdc1'}
def test_ignores_bogus_lines(self, stub_call):
out = ['some line here', ' ']
stub_call((out, '', 0))
assert encryption.status('/dev/sdc1') == {}
class TestDmcryptClose(object):
def test_mapper_exists(self, fake_run, fake_filesystem):
file_name = fake_filesystem.create_file('mapper-device')
encryption.dmcrypt_close(file_name.path)
arguments = fake_run.calls[0]['args'][0]
assert arguments[0] == 'cryptsetup'
assert arguments[1] == 'remove'
assert arguments[2].startswith('/')
def test_mapper_does_not_exist(self, fake_run):
file_name = '/path/does/not/exist'
encryption.dmcrypt_close(file_name)
assert fake_run.calls == []
class TestDmcryptKey(object):
def test_dmcrypt(self):
result = encryption.create_dmcrypt_key()
assert len(base64.b64decode(result)) == 128
class TestLuksFormat(object):
@patch('ceph_volume.util.encryption.process.call')
def test_luks_format_command_with_default_size(self, m_call, conf_ceph_stub):
conf_ceph_stub('[global]\nfsid=abcd')
expected = [
'cryptsetup',
'--batch-mode',
'--key-size',
'512',
'--key-file',
'-',
'luksFormat',
'/dev/foo'
]
encryption.luks_format('abcd', '/dev/foo')
assert m_call.call_args[0][0] == expected
@patch('ceph_volume.util.encryption.process.call')
def test_luks_format_command_with_custom_size(self, m_call, conf_ceph_stub):
conf_ceph_stub('[global]\nfsid=abcd\n[osd]\nosd_dmcrypt_key_size=256')
expected = [
'cryptsetup',
'--batch-mode',
'--key-size',
'256',
'--key-file',
'-',
'luksFormat',
'/dev/foo'
]
encryption.luks_format('abcd', '/dev/foo')
assert m_call.call_args[0][0] == expected
class TestLuksOpen(object):
@patch('ceph_volume.util.encryption.bypass_workqueue', return_value=False)
@patch('ceph_volume.util.encryption.process.call')
def test_luks_open_command_with_default_size(self, m_call, m_bypass_workqueue, conf_ceph_stub):
conf_ceph_stub('[global]\nfsid=abcd')
expected = [
'cryptsetup',
'--key-size',
'512',
'--key-file',
'-',
'--allow-discards',
'luksOpen',
'/dev/foo',
'/dev/bar'
]
encryption.luks_open('abcd', '/dev/foo', '/dev/bar')
assert m_call.call_args[0][0] == expected
@patch('ceph_volume.util.encryption.bypass_workqueue', return_value=False)
@patch('ceph_volume.util.encryption.process.call')
def test_luks_open_command_with_custom_size(self, m_call, m_bypass_workqueue, conf_ceph_stub):
conf_ceph_stub('[global]\nfsid=abcd\n[osd]\nosd_dmcrypt_key_size=256')
expected = [
'cryptsetup',
'--key-size',
'256',
'--key-file',
'-',
'--allow-discards',
'luksOpen',
'/dev/foo',
'/dev/bar'
]
encryption.luks_open('abcd', '/dev/foo', '/dev/bar')
assert m_call.call_args[0][0] == expected
@patch('ceph_volume.util.encryption.bypass_workqueue', return_value=False)
@patch('ceph_volume.util.encryption.process.call')
def test_luks_open_command_with_tpm(self, m_call, m_bypass_workqueue, conf_ceph_stub):
fake_mapping: str = 'fake-mapping'
fake_device: str = 'fake-device'
expected = [
'/usr/lib/systemd/systemd-cryptsetup',
'attach',
fake_mapping,
fake_device,
'-',
'tpm2-device=auto,discard,headless=true,nofail',
]
encryption.luks_open('', fake_device, fake_mapping, 1)
assert m_call.call_args[0][0] == expected
@patch('ceph_volume.util.encryption.bypass_workqueue', return_value=True)
@patch('ceph_volume.util.encryption.process.call')
def test_luks_open_command_with_tpm_bypass_workqueue(self, m_call, m_bypass_workqueue, conf_ceph_stub):
fake_mapping: str = 'fake-mapping'
fake_device: str = 'fake-device'
expected = [
'/usr/lib/systemd/systemd-cryptsetup',
'attach',
fake_mapping,
fake_device,
'-',
'tpm2-device=auto,discard,headless=true,nofail,no-read-workqueue,no-write-workqueue',
]
encryption.luks_open('', fake_device, fake_mapping, 1)
assert m_call.call_args[0][0] == expected
class TestCephLuks2:
@patch.object(encryption.CephLuks2, 'get_osd_fsid', Mock(return_value='abcd-1234'))
@patch.object(encryption.CephLuks2, 'is_ceph_encrypted', Mock(return_value=True))
def test_init_ceph_encrypted(self) -> None:
assert encryption.CephLuks2('/dev/foo').osd_fsid == 'abcd-1234'
@patch.object(encryption.CephLuks2, 'get_osd_fsid', Mock(return_value=''))
@patch.object(encryption.CephLuks2, 'is_ceph_encrypted', Mock(return_value=False))
def test_init_not_ceph_encrypted(self) -> None:
assert encryption.CephLuks2('/dev/foo').osd_fsid == ''
def test_has_luks2_signature(self) -> None:
with patch('ceph_volume.util.encryption._dd_read', return_value='LUKS'):
assert encryption.CephLuks2('/dev/foo').has_luks2_signature
@patch('ceph_volume.util.encryption._dd_read', side_effect=Exception('foo'))
def test_has_luks2_signature_raises_exception(self, m_dd_read: Any) -> None:
with pytest.raises(RuntimeError):
encryption.CephLuks2('/dev/foo').has_luks2_signature
@patch.object(encryption.CephLuks2, 'get_subsystem', Mock(return_value='ceph_fsid=abcd'))
@patch.object(encryption.CephLuks2, 'has_luks2_signature', Mock(return_value=True))
def test_is_ceph_encrypted(self) -> None:
assert encryption.CephLuks2('/dev/foo').is_ceph_encrypted
@patch.object(encryption.CephLuks2, 'get_label', Mock(return_value=''))
@patch.object(encryption.CephLuks2, 'has_luks2_signature', Mock(return_value=True))
def test_is_not_ceph_encrypted(self) -> None:
assert not encryption.CephLuks2('/dev/foo').is_ceph_encrypted
@patch('ceph_volume.util.encryption.process.call', Mock(return_value=MagicMock()))
def test_config_luks2_invalid_config(self) -> None:
with pytest.raises(RuntimeError):
encryption.CephLuks2('/dev/foo').config_luks2({'subsystem': 'ceph_fsid=1234-abcd', 'label': 'foo', 'foo': 'bar'})
@patch('ceph_volume.util.encryption.process.call', Mock(return_value=MagicMock()))
def test_config_luks2_invalid_config_keys(self) -> None:
with pytest.raises(RuntimeError):
encryption.CephLuks2('/dev/foo').config_luks2({'fake': 'fake-value', 'subsystem': 'ceph_fsid=1234-abcd'})
@patch('ceph_volume.util.encryption.process.call')
def test_config_luks2_ok(self, m_call: Any) -> None:
m_call.return_value = ('', '', 0)
encryption.CephLuks2('/dev/foo').config_luks2({'label': 'foo', 'subsystem': 'ceph_fsid=1234-abcd'})
assert m_call.mock_calls == [call(['cryptsetup', 'config', '/dev/foo', '--label', 'foo', '--subsystem', 'ceph_fsid=1234-abcd'], verbose_on_failure=False)]
@patch('ceph_volume.util.encryption.process.call')
def test_config_luks2_raises_exception(self, m_call: Any) -> None:
m_call.return_value = ('', '', 1)
with pytest.raises(RuntimeError):
encryption.CephLuks2('/dev/foo').config_luks2({'label': 'foo', 'subsystem': 'ceph_fsid=1234-abcd'})
def test_get_label(self) -> None:
with patch('ceph_volume.util.encryption._dd_read', return_value='fake-luks2-label'):
label: str = encryption.CephLuks2('/dev/foo').get_label()
assert label == 'fake-luks2-label'
def test_get_label_raises_exception(self) -> None:
with patch('ceph_volume.util.encryption._dd_read', side_effect=Exception('fake-error')):
with pytest.raises(RuntimeError):
encryption.CephLuks2('/dev/foo').get_label()
@patch.object(encryption.CephLuks2, 'get_subsystem', Mock(return_value='ceph_fsid=abcd'))
def test_get_osd_fsid(self) -> None:
assert encryption.CephLuks2('/dev/foo').get_osd_fsid() == 'abcd'
@patch.object(encryption.CephLuks2, 'get_label', Mock(return_value='ceph'))
def test_get_osd_fsid_error(self) -> None:
result: str = encryption.CephLuks2('/dev/foo').get_osd_fsid()
assert result == ''
def test_get_subsystem(self) -> None:
with patch('ceph_volume.util.encryption._dd_read', return_value='fake-luks2-subsystem'):
assert encryption.CephLuks2('/dev/foo').get_subsystem() == 'fake-luks2-subsystem'
def test_get_subsystem_raises_exception(self) -> None:
with patch('ceph_volume.util.encryption._dd_read', side_effect=Exception('fake-error')):
with pytest.raises(RuntimeError):
encryption.CephLuks2('/dev/foo').get_subsystem()
def test_get_json_area(self) -> None:
mock_json_data = '{"tokens": {"1": {"type": "systemd-tpm2"}}}'
with patch('ceph_volume.util.encryption._dd_read', return_value=mock_json_data):
assert encryption.CephLuks2('/dev/foo').get_json_area() == json.loads(mock_json_data)
def test_get_json_area_invalid(self) -> None:
with patch('ceph_volume.util.encryption._dd_read', return_value='invalid-json-data'):
with pytest.raises(RuntimeError):
encryption.CephLuks2('/dev/foo').get_json_area()
def test_get_json_area_exception_caught(self) -> None:
with patch('ceph_volume.util.encryption._dd_read', side_effect=OSError):
with pytest.raises(OSError):
encryption.CephLuks2('/dev/foo').get_json_area()
@patch('ceph_volume.util.encryption.lsblk', Mock(return_value={'FSTYPE': 'crypto_LUKS'}))
@patch.object(encryption.CephLuks2, 'get_json_area', Mock(return_value={"tokens": {"1": {"type": "systemd-tpm2"}}}))
def test_is_tpm2_enrolled_true(self) -> None:
assert encryption.CephLuks2('/dev/foo').is_tpm2_enrolled
@patch('ceph_volume.util.encryption.lsblk', Mock(return_value={'FSTYPE': 'whatever'}))
def test_is_tpm2_enrolled_false_not_a_luks_device(self) -> None:
assert not encryption.CephLuks2('/dev/foo').is_tpm2_enrolled
@patch('ceph_volume.util.encryption.lsblk', Mock(return_value={'FSTYPE': 'crypto_LUKS'}))
@patch.object(encryption.CephLuks2, 'get_json_area', Mock(return_value={"whatever": "fake-value"}))
def test_is_tpm2_enrolled_false_not_enrolled_with_tpm2(self) -> None:
assert not encryption.CephLuks2('/dev/foo').is_tpm2_enrolled
|
