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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import uuid
from os import urandom
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives.asymmetric.padding import (
OAEP,
MGF1,
)
from cryptography.hazmat.primitives.asymmetric.rsa import generate_private_key
from cryptography.hazmat.primitives.hashes import SHA1
from cryptography.hazmat.primitives.keywrap import (
aes_key_wrap,
aes_key_unwrap,
)
# Sample implementations of the encryption-related interfaces.
class KeyWrapper:
def __init__(self, kid):
self.kek = urandom(32)
self.backend = default_backend()
self.kid = 'local:' + kid
def wrap_key(self, key, algorithm='A256KW'):
if algorithm == 'A256KW':
return aes_key_wrap(self.kek, key, self.backend)
raise ValueError(_ERROR_UNKNOWN_KEY_WRAP_ALGORITHM)
def unwrap_key(self, key, algorithm):
if algorithm == 'A256KW':
return aes_key_unwrap(self.kek, key, self.backend)
raise ValueError(_ERROR_UNKNOWN_KEY_WRAP_ALGORITHM)
def get_key_wrap_algorithm(self):
return 'A256KW'
def get_kid(self):
return self.kid
class KeyResolver:
def __init__(self):
self.keys = {}
def put_key(self, key):
self.keys[key.get_kid()] = key
def resolve_key(self, kid):
return self.keys[kid]
class RSAKeyWrapper:
def __init__(self, kid):
self.private_key = generate_private_key(public_exponent=65537,
key_size=2048,
backend=default_backend())
self.public_key = self.private_key.public_key()
self.kid = 'local:' + kid
def wrap_key(self, key, algorithm='RSA'):
if algorithm == 'RSA':
return self.public_key.encrypt(key,
OAEP(
mgf=MGF1(algorithm=SHA1()),
algorithm=SHA1(),
label=None)
)
raise ValueError(_ERROR_UNKNOWN_KEY_WRAP_ALGORITHM)
def unwrap_key(self, key, algorithm):
if algorithm == 'RSA':
return self.private_key.decrypt(key,
OAEP(
mgf=MGF1(algorithm=SHA1()),
algorithm=SHA1(),
label=None)
)
raise ValueError(_ERROR_UNKNOWN_KEY_WRAP_ALGORITHM)
def get_key_wrap_algorithm(self):
return 'RSA'
def get_kid(self):
return self.kid
class QueueEncryptionSamples():
def __init__(self, account):
self.account = account
def run_all_samples(self):
self.service = self.account.create_queue_service()
self.put_encrypted_message()
self.peek_get_update_encrypted()
self.decrypt_with_key_encryption_key()
self.require_encryption()
self.alternate_key_algorithms()
def _get_queue_reference(self, prefix='queue'):
queue_name = '{}{}'.format(prefix, str(uuid.uuid4()).replace('-', ''))
return queue_name
def _create_queue(self, prefix='queue'):
queue_name = self._get_queue_reference(prefix)
self.service.create_queue(queue_name)
return queue_name
def put_encrypted_message(self):
queue_name = self._create_queue()
# KeyWrapper implements the key encryption key interface
# outlined in the get/update message documentation.
# Setting the key_encryption_key property will tell these
# APIs to encrypt messages.
self.service.key_encryption_key = KeyWrapper('key1')
self.service.put_message(queue_name, 'message1')
self.service.delete_queue(queue_name)
def peek_get_update_encrypted(self):
queue_name = self._create_queue()
# The KeyWrapper is still needed for encryption
self.service.key_encryption_key = KeyWrapper('key1')
self.service.put_message(queue_name, 'message1')
# KeyResolver is used to resolve a key from its id.
# Its interface is defined in the get/peek messages documentation.
key_resolver = KeyResolver()
key_resolver.put_key(self.service.key_encryption_key)
self.service.key_resolver_function = key_resolver.resolve_key
self.service.peek_messages(queue_name)
messages = self.service.get_messages(queue_name)
self.service.update_message(queue_name,
messages[0].id,
messages[0].pop_receipt,
0,
content='encrypted_message2')
self.service.delete_queue(queue_name)
def require_encryption(self):
queue_name = self._create_queue()
self.service.put_message(queue_name, 'Not encrypted')
# Set the require_encryption property on the service to
# ensure all messages sent/received are encrypted.
self.service.require_encryption = True
# If the property is set, but no kek is specified upon
# upload, the method will throw.
try:
self.service.put_message(queue_name, 'message1')
except:
pass
self.service.key_encryption_key = KeyWrapper('key1')
self.service.key_resolver_function = KeyResolver()
self.service.key_resolver_function.put_key(self.service.key_encryption_key)
# If encryption is required, but a retrieved message is not
# encrypted, the method will throw.
try:
self.service.peek_message(queue_name, 'message1')
except:
pass
self.service.delete_queue(queue_name)
def alternate_key_algorithms(self):
queue_name = self._create_queue()
# To use an alternate method of key wrapping, simply set the
# key_encryption_key property to a wrapper that uses a different algorithm.
self.service.key_encryption_key = RSAKeyWrapper('key2')
self.service.key_resolver_function = None
self.service.put_message(queue_name, 'message')
key_resolver = KeyResolver()
key_resolver.put_key(self.service.key_encryption_key)
self.service.key_resolver_function = key_resolver.resolve_key
message = self.service.peek_messages(queue_name)
self.service.delete_queue(queue_name)
def decrypt_with_key_encryption_key(self):
queue_name = self._create_queue()
# The KeyWrapper object also defines methods necessary for
# decryption as defined in the get/peek messages documentation.
# Since the key_encryption_key property is still set, messages
# will be decrypted automatically.
kek = KeyWrapper('key1')
self.service.key_encryption_key = kek
self.service.put_message(queue_name, 'message1')
# When decrypting, if both a kek and resolver are set,
# the resolver will take precedence. Remove the resolver to just use the kek.
self.service.key_resolver_function = None
messages = self.service.peek_messages(queue_name)
self.service.delete_queue(queue_name)
|