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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import unittest
import pytest
import six
from base64 import (
b64decode,
)
from json import (
loads,
dumps,
)
from cryptography.hazmat import backends
from cryptography.hazmat.primitives.ciphers import Cipher
from cryptography.hazmat.primitives.ciphers.algorithms import AES
from cryptography.hazmat.primitives.ciphers.modes import CBC
from cryptography.hazmat.primitives.padding import PKCS7
from devtools_testutils import ResourceGroupPreparer, StorageAccountPreparer
from azure.core.exceptions import HttpResponseError, ResourceExistsError
from azure.storage.queue._shared import decode_base64_to_bytes
from azure.storage.queue._shared.encryption import (
_ERROR_OBJECT_INVALID,
_WrappedContentKey,
_EncryptionAgent,
_EncryptionData,
)
from azure.storage.queue import (
VERSION,
QueueServiceClient,
QueueClient,
BinaryBase64EncodePolicy,
BinaryBase64DecodePolicy,
)
from encryption_test_helper import (
KeyWrapper,
KeyResolver,
RSAKeyWrapper,
)
from _shared.testcase import GlobalStorageAccountPreparer, StorageTestCase
# ------------------------------------------------------------------------------
TEST_QUEUE_PREFIX = 'encryptionqueue'
# ------------------------------------------------------------------------------
def _decode_base64_to_bytes(data):
if isinstance(data, six.text_type):
data = data.encode('utf-8')
return b64decode(data)
class StorageQueueEncryptionTest(StorageTestCase):
# --Helpers-----------------------------------------------------------------
def _get_queue_reference(self, qsc, prefix=TEST_QUEUE_PREFIX, **kwargs):
queue_name = self.get_resource_name(prefix)
queue = qsc.get_queue_client(queue_name, **kwargs)
return queue
def _create_queue(self, qsc, prefix=TEST_QUEUE_PREFIX, **kwargs):
queue = self._get_queue_reference(qsc, prefix, **kwargs)
try:
created = queue.create_queue()
except ResourceExistsError:
pass
return queue
# --------------------------------------------------------------------------
@GlobalStorageAccountPreparer()
def test_get_messages_encrypted_kek(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
qsc.key_encryption_key = KeyWrapper('key1')
queue = self._create_queue(qsc)
queue.send_message(u'encrypted_message_2')
# Act
li = next(queue.receive_messages())
# Assert
self.assertEqual(li.content, u'encrypted_message_2')
@GlobalStorageAccountPreparer()
def test_get_messages_encrypted_resolver(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
qsc.key_encryption_key = KeyWrapper('key1')
queue = self._create_queue(qsc)
queue.send_message(u'encrypted_message_2')
key_resolver = KeyResolver()
key_resolver.put_key(qsc.key_encryption_key)
queue.key_resolver_function = key_resolver.resolve_key
queue.key_encryption_key = None # Ensure that the resolver is used
# Act
li = next(queue.receive_messages())
# Assert
self.assertEqual(li.content, u'encrypted_message_2')
@GlobalStorageAccountPreparer()
def test_peek_messages_encrypted_kek(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
qsc.key_encryption_key = KeyWrapper('key1')
queue = self._create_queue(qsc)
queue.send_message(u'encrypted_message_3')
# Act
li = queue.peek_messages()
# Assert
self.assertEqual(li[0].content, u'encrypted_message_3')
@GlobalStorageAccountPreparer()
def test_peek_messages_encrypted_resolver(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
qsc.key_encryption_key = KeyWrapper('key1')
queue = self._create_queue(qsc)
queue.send_message(u'encrypted_message_4')
key_resolver = KeyResolver()
key_resolver.put_key(qsc.key_encryption_key)
queue.key_resolver_function = key_resolver.resolve_key
queue.key_encryption_key = None # Ensure that the resolver is used
# Act
li = queue.peek_messages()
# Assert
self.assertEqual(li[0].content, u'encrypted_message_4')
@pytest.mark.live_test_only
@GlobalStorageAccountPreparer()
def test_peek_messages_encrypted_kek_RSA(self, resource_group, location, storage_account, storage_account_key):
# We can only generate random RSA keys, so this must be run live or
# the playback test will fail due to a change in kek values.
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
qsc.key_encryption_key = RSAKeyWrapper('key2')
queue = self._create_queue(qsc)
queue.send_message(u'encrypted_message_3')
# Act
li = queue.peek_messages()
# Assert
self.assertEqual(li[0].content, u'encrypted_message_3')
@pytest.mark.live_test_only
@GlobalStorageAccountPreparer()
def test_update_encrypted_message(self, resource_group, location, storage_account, storage_account_key):
# TODO: Recording doesn't work
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc)
queue.key_encryption_key = KeyWrapper('key1')
queue.send_message(u'Update Me')
messages = queue.receive_messages()
list_result1 = next(messages)
list_result1.content = u'Updated'
# Act
message = queue.update_message(list_result1)
list_result2 = next(messages)
# Assert
self.assertEqual(u'Updated', list_result2.content)
@GlobalStorageAccountPreparer()
def test_update_encrypted_binary_message(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc, message_encode_policy=BinaryBase64EncodePolicy(), message_decode_policy=BinaryBase64DecodePolicy())
queue.key_encryption_key = KeyWrapper('key1')
binary_message = self.get_random_bytes(100)
queue.send_message(binary_message)
messages = []
for m in queue.receive_messages():
messages.append(m)
list_result1 = messages[0]
# Act
binary_message = self.get_random_bytes(100)
list_result1.content = binary_message
queue.update_message(list_result1)
for m in queue.receive_messages():
messages.append(m)
list_result2 = messages[0]
# Assert
self.assertEqual(binary_message, list_result2.content)
@pytest.mark.live_test_only
@GlobalStorageAccountPreparer()
def test_update_encrypted_raw_text_message(self, resource_group, location, storage_account, storage_account_key):
# TODO: Recording doesn't work
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc, message_encode_policy=None, message_decode_policy=None)
queue.key_encryption_key = KeyWrapper('key1')
raw_text = u'Update Me'
queue.send_message(raw_text)
messages = queue.receive_messages()
list_result1 = next(messages)
# Act
raw_text = u'Updated'
list_result1.content = raw_text
queue.update_message(list_result1)
list_result2 = next(messages)
# Assert
self.assertEqual(raw_text, list_result2.content)
@pytest.mark.live_test_only
@GlobalStorageAccountPreparer()
def test_update_encrypted_json_message(self, resource_group, location, storage_account, storage_account_key):
# TODO: Recording doesn't work
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc, message_encode_policy=None, message_decode_policy=None)
queue.key_encryption_key = KeyWrapper('key1')
message_dict = {'val1': 1, 'val2': '2'}
json_text = dumps(message_dict)
queue.send_message(json_text)
messages = queue.receive_messages()
list_result1 = next(messages)
# Act
message_dict['val1'] = 0
message_dict['val2'] = 'updated'
json_text = dumps(message_dict)
list_result1.content = json_text
queue.update_message(list_result1)
list_result2 = next(messages)
# Assert
self.assertEqual(message_dict, loads(list_result2.content))
@GlobalStorageAccountPreparer()
def test_invalid_value_kek_wrap(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc)
queue.key_encryption_key = KeyWrapper('key1')
queue.key_encryption_key.get_kid = None
with self.assertRaises(AttributeError) as e:
queue.send_message(u'message')
self.assertEqual(str(e.exception), _ERROR_OBJECT_INVALID.format('key encryption key', 'get_kid'))
queue.key_encryption_key = KeyWrapper('key1')
queue.key_encryption_key.get_kid = None
with self.assertRaises(AttributeError):
queue.send_message(u'message')
queue.key_encryption_key = KeyWrapper('key1')
queue.key_encryption_key.wrap_key = None
with self.assertRaises(AttributeError):
queue.send_message(u'message')
@GlobalStorageAccountPreparer()
def test_missing_attribute_kek_wrap(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc)
valid_key = KeyWrapper('key1')
# Act
invalid_key_1 = lambda: None # functions are objects, so this effectively creates an empty object
invalid_key_1.get_key_wrap_algorithm = valid_key.get_key_wrap_algorithm
invalid_key_1.get_kid = valid_key.get_kid
# No attribute wrap_key
queue.key_encryption_key = invalid_key_1
with self.assertRaises(AttributeError):
queue.send_message(u'message')
invalid_key_2 = lambda: None # functions are objects, so this effectively creates an empty object
invalid_key_2.wrap_key = valid_key.wrap_key
invalid_key_2.get_kid = valid_key.get_kid
# No attribute get_key_wrap_algorithm
queue.key_encryption_key = invalid_key_2
with self.assertRaises(AttributeError):
queue.send_message(u'message')
invalid_key_3 = lambda: None # functions are objects, so this effectively creates an empty object
invalid_key_3.get_key_wrap_algorithm = valid_key.get_key_wrap_algorithm
invalid_key_3.wrap_key = valid_key.wrap_key
# No attribute get_kid
queue.key_encryption_key = invalid_key_3
with self.assertRaises(AttributeError):
queue.send_message(u'message')
@GlobalStorageAccountPreparer()
def test_invalid_value_kek_unwrap(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc)
queue.key_encryption_key = KeyWrapper('key1')
queue.send_message(u'message')
# Act
queue.key_encryption_key.unwrap_key = None
with self.assertRaises(HttpResponseError):
queue.peek_messages()
queue.key_encryption_key.get_kid = None
with self.assertRaises(HttpResponseError):
queue.peek_messages()
@GlobalStorageAccountPreparer()
def test_missing_attribute_kek_unrwap(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc)
queue.key_encryption_key = KeyWrapper('key1')
queue.send_message(u'message')
# Act
valid_key = KeyWrapper('key1')
invalid_key_1 = lambda: None # functions are objects, so this effectively creates an empty object
invalid_key_1.unwrap_key = valid_key.unwrap_key
# No attribute get_kid
queue.key_encryption_key = invalid_key_1
with self.assertRaises(HttpResponseError) as e:
queue.peek_messages()
self.assertEqual(str(e.exception), "Decryption failed.")
invalid_key_2 = lambda: None # functions are objects, so this effectively creates an empty object
invalid_key_2.get_kid = valid_key.get_kid
# No attribute unwrap_key
queue.key_encryption_key = invalid_key_2
with self.assertRaises(HttpResponseError):
queue.peek_messages()
@GlobalStorageAccountPreparer()
def test_validate_encryption(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc)
kek = KeyWrapper('key1')
queue.key_encryption_key = kek
queue.send_message(u'message')
# Act
queue.key_encryption_key = None # Message will not be decrypted
li = queue.peek_messages()
message = li[0].content
message = loads(message)
encryption_data = message['EncryptionData']
wrapped_content_key = encryption_data['WrappedContentKey']
wrapped_content_key = _WrappedContentKey(
wrapped_content_key['Algorithm'],
b64decode(wrapped_content_key['EncryptedKey'].encode(encoding='utf-8')),
wrapped_content_key['KeyId'])
encryption_agent = encryption_data['EncryptionAgent']
encryption_agent = _EncryptionAgent(
encryption_agent['EncryptionAlgorithm'],
encryption_agent['Protocol'])
encryption_data = _EncryptionData(
b64decode(encryption_data['ContentEncryptionIV'].encode(encoding='utf-8')),
encryption_agent,
wrapped_content_key,
{'EncryptionLibrary': VERSION})
message = message['EncryptedMessageContents']
content_encryption_key = kek.unwrap_key(
encryption_data.wrapped_content_key.encrypted_key,
encryption_data.wrapped_content_key.algorithm)
# Create decryption cipher
backend = backends.default_backend()
algorithm = AES(content_encryption_key)
mode = CBC(encryption_data.content_encryption_IV)
cipher = Cipher(algorithm, mode, backend)
# decode and decrypt data
decrypted_data = decode_base64_to_bytes(message)
decryptor = cipher.decryptor()
decrypted_data = (decryptor.update(decrypted_data) + decryptor.finalize())
# unpad data
unpadder = PKCS7(128).unpadder()
decrypted_data = (unpadder.update(decrypted_data) + unpadder.finalize())
decrypted_data = decrypted_data.decode(encoding='utf-8')
# Assert
self.assertEqual(decrypted_data, u'message')
@GlobalStorageAccountPreparer()
def test_put_with_strict_mode(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc)
kek = KeyWrapper('key1')
queue.key_encryption_key = kek
queue.require_encryption = True
queue.send_message(u'message')
queue.key_encryption_key = None
# Assert
with self.assertRaises(ValueError) as e:
queue.send_message(u'message')
self.assertEqual(str(e.exception), "Encryption required but no key was provided.")
@GlobalStorageAccountPreparer()
def test_get_with_strict_mode(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc)
queue.send_message(u'message')
queue.require_encryption = True
queue.key_encryption_key = KeyWrapper('key1')
with self.assertRaises(ValueError) as e:
next(queue.receive_messages())
self.assertEqual(str(e.exception), 'Message was not encrypted.')
@GlobalStorageAccountPreparer()
def test_encryption_add_encrypted_64k_message(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc)
message = u'a' * 1024 * 64
# Act
queue.send_message(message)
# Assert
queue.key_encryption_key = KeyWrapper('key1')
with self.assertRaises(HttpResponseError):
queue.send_message(message)
@GlobalStorageAccountPreparer()
def test_encryption_nonmatching_kid(self, resource_group, location, storage_account, storage_account_key):
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account, "queue"), storage_account_key)
queue = self._create_queue(qsc)
queue.key_encryption_key = KeyWrapper('key1')
queue.send_message(u'message')
# Act
queue.key_encryption_key.kid = 'Invalid'
# Assert
with self.assertRaises(HttpResponseError) as e:
next(queue.receive_messages())
self.assertEqual(str(e.exception), "Decryption failed.")
# ------------------------------------------------------------------------------
if __name__ == '__main__':
unittest.main()
|
