make SAS Key more specific

Author: askpatrickw

README.rst

@@ -203,7 +203,7 @@ To use Azure IoT Central, you will need to create an Azure IoT Central app, crea
 
     from adafruit_azureiot import IoTCentralDevice
 
-    device = IoTCentralDevice(wifi, secrets["id_scope"], secrets["device_id"], secrets["sas_key"])
+    device = IoTCentralDevice(wifi, secrets["id_scope"], secrets["device_id"], secrets["device_device_sas_key"])
     device.connect()
 
 Once the device is connected, you will regularly need to run a ``loop`` to poll for messages from the cloud.

adafruit_azureiot/device_registration.py

@@ -49,19 +49,19 @@ def __init__(
         iface,
         id_scope: str,
         device_id: str,
-        key: str,
+        device_sas_key: str,
         logger: Logger = None,
     ):
         """Creates an instance of the device registration service
         :param socket: The network socket
         :param str id_scope: The ID scope of the device to register
         :param str device_id: The device ID of the device to register
-        :param str key: The primary or secondary key of the device to register
+        :param str device_sas_key: The primary or secondary key of the device to register
         :param adafruit_logging.Logger logger: The logger to use to log messages
         """
         self._id_scope = id_scope
         self._device_id = device_id
-        self._key = key
+        self._device_sas_key = device_sas_key
         self._logger = logger if logger is not None else logging.getLogger("log")
 
         self._mqtt = None
@@ -76,7 +76,7 @@ def __init__(
     # pylint: disable=C0103
     def _on_connect(self, client, userdata, _, rc) -> None:
         self._logger.info(
-            f"- device_registration :: _on_connect :: rc = {str(rc)}, userdata = {str(userdata)}"
+            f"- device_registration :: _on_connect :: rc = {rc}, userdata = {userdata}"
         )
 
         self._auth_response_received = True
@@ -110,7 +110,7 @@ def _connect_to_mqtt(self) -> None:
             self._mqtt.loop()
 
         self._logger.info(
-            f" - device_registration :: connect :: on_connect must be fired. Connected ? {str(self._mqtt.is_connected())}"
+            f" - device_registration :: connect :: on_connect must be fired. Connected ? {self._mqtt.is_connected()}"
         )
 
         if not self._mqtt.is_connected():
@@ -132,7 +132,7 @@ def _start_registration(self) -> None:
 
         while self._operation_id is None and retry < 10:
             time.sleep(1)
-            retry = retry + 1
+            retry += 1
             self._mqtt.loop()
 
         if self._operation_id is None:
@@ -151,7 +151,7 @@ def _wait_for_operation(self) -> None:
 
         while self._hostname is None and retry < 10:
             time.sleep(1)
-            retry = retry + 1
+            retry += 1
             self._mqtt.loop()
 
         if self._hostname is None:
@@ -175,10 +175,10 @@ def register_device(self, expiry: int) -> str:
         # pylint: disable=C0103
         sr = self._id_scope + "%2Fregistrations%2F" + self._device_id
         sig_no_encode = compute_derived_symmetric_key(
-            self._key, sr + "\n" + str(expiry)
+            self._device_sas_key, sr + "\n" + str(expiry)
         )
         sig_encoded = quote(sig_no_encode, "~()*!.'")
-        auth_string = f"SharedAccessSignature sr={sr}&sig={sig_encoded}&se={str(expiry)}&skn=registration"
+        auth_string = f"SharedAccessSignature sr={sr}&sig={sig_encoded}&se={expiry}&skn=registration"
 
         MQTT.set_socket(self._socket, self._iface)
 

adafruit_azureiot/hmac.py

@@ -331,12 +331,11 @@ def sha_update(sha_info: dict, buffer: Union[bytes, bytearray]) -> None:
         buffer_idx += i
 
         sha_info["local"] += i
-        if sha_info["local"] == SHA_BLOCKSIZE:
-            sha_transform(sha_info)
-            sha_info["local"] = 0
-        else:
+        if sha_info["local"] != SHA_BLOCKSIZE:
             return
 
+        sha_transform(sha_info)
+        sha_info["local"] = 0
     while count >= SHA_BLOCKSIZE:
         # copy buffer
         sha_info["data"] = list(buffer[buffer_idx : buffer_idx + SHA_BLOCKSIZE])
@@ -351,9 +350,7 @@ def sha_update(sha_info: dict, buffer: Union[bytes, bytearray]) -> None:
 
 
 def getbuf(s: Union[str, bytes, bytearray]) -> Union[bytes, bytearray]:
-    if isinstance(s, str):
-        return s.encode("ascii")
-    return bytes(s)
+    return s.encode("ascii") if isinstance(s, str) else bytes(s)
 
 
 def sha_final(sha_info: dict) -> bytes:

adafruit_azureiot/iot_mqtt.py

@@ -98,17 +98,16 @@ def _gen_sas_token(self) -> str:
         token_expiry = int(time.time() + self._token_expires)
         uri = self._hostname + "%2Fdevices%2F" + self._device_id
         signed_hmac_sha256 = compute_derived_symmetric_key(
-            self._key, uri + "\n" + str(token_expiry)
+            self._device_sas_key, uri + "\n" + str(token_expiry)
         )
         signature = quote(signed_hmac_sha256, "~()*!.'")
         if signature.endswith(
             "\n"
         ):  # somewhere along the crypto chain a newline is inserted
             signature = signature[:-1]
-        token = "SharedAccessSignature sr={}&sig={}&se={}".format(
+        return "SharedAccessSignature sr={}&sig={}&se={}".format(
             uri, signature, token_expiry
         )
-        return token
 
     def _create_mqtt_client(self) -> None:
         MQTT.set_socket(self._socket, self._iface)
@@ -205,11 +204,7 @@ def _handle_device_twin_update(self, client, topic: str, msg: str) -> None:
 
         is_patch = "desired" not in twin
 
-        if is_patch:
-            desired = twin
-        else:
-            desired = twin["desired"]
-
+        desired = twin if is_patch else twin["desired"]
         if "$version" in desired:
             desired_version = desired["$version"]
             desired.pop("$version")
@@ -295,18 +290,18 @@ def _send_common(self, topic: str, data) -> None:
                 break
             except RuntimeError as runtime_error:
                 self._logger.info(
-                    "Could not send data, retrying after 0.5 seconds: "
-                    + str(runtime_error)
+                    (
+                        "Could not send data, retrying after 0.5 seconds: "
+                        + str(runtime_error)
+                    )
                 )
-                retry = retry + 1
 
+                retry += 1
                 if retry >= 10:
                     self._logger.error("Failed to send data")
                     raise
-
                 time.sleep(0.5)
                 continue
-
         gc.collect()
 
     def _get_device_settings(self) -> None:
@@ -322,7 +317,7 @@ def __init__(
         iface,
         hostname: str,
         device_id: str,
-        key: str,
+        device_sas_key: str,
         token_expires: int = 21600,
         logger: logging = None,
     ):
@@ -332,7 +327,7 @@ def __init__(
         :param iface: The network interface to communicate over
         :param str hostname: The hostname of the MQTT broker to connect to, get this by registering the device
         :param str device_id: The device ID of the device to register
-        :param str key: The primary or secondary key of the device to register
+        :param str device_sas_key: The primary or secondary key of the device to register
         :param int token_expires: The number of seconds till the token expires, defaults to 6 hours
         :param adafruit_logging logger: The logger
         """
@@ -343,7 +338,7 @@ def __init__(
         self._mqtts = None
         self._device_id = device_id
         self._hostname = hostname
-        self._key = key
+        self._device_sas_key = device_sas_key
         self._token_expires = token_expires
         self._username = "{}/{}/?api-version={}".format(
             self._hostname, device_id, constants.IOTC_API_VERSION
@@ -458,12 +453,12 @@ def send_device_to_cloud_message(
 
         if system_properties is not None:
             firstProp = True
-            for prop in system_properties:
+            for prop, value in system_properties.items():
                 if not firstProp:
                     topic += "&"
                 else:
                     firstProp = False
-                topic += prop + "=" + str(system_properties[prop])
+                topic += prop + "=" + str(value)
 
         # Convert message to a string
         if isinstance(message, dict):

adafruit_azureiot/iotcentral_device.py

@@ -86,7 +86,7 @@ def __init__(
         iface,
         id_scope: str,
         device_id: str,
-        key: str,
+        device_sas_key: str,
         token_expires: int = 21600,
         logger: logging = None,
     ):
@@ -95,15 +95,15 @@ def __init__(
         :param iface: The network interface
         :param str id_scope: The ID Scope of the device in IoT Central
         :param str device_id: The device ID of the device in IoT Central
-        :param str key: The primary or secondary key of the device in IoT Central
+        :param str device_sas_key: The primary or secondary key of the device in IoT Central
         :param int token_expires: The number of seconds till the token expires, defaults to 6 hours
         :param adafruit_logging logger: The logger
         """
         self._socket = socket
         self._iface = iface
         self._id_scope = id_scope
         self._device_id = device_id
-        self._key = key
+        self._device_sas_key = device_sas_key
         self._token_expires = token_expires
         self._logger = logger if logger is not None else logging.getLogger("log")
         self._device_registration = None
@@ -140,7 +140,7 @@ def connect(self) -> None:
             self._iface,
             self._id_scope,
             self._device_id,
-            self._key,
+            self._device_sas_key,
             self._logger,
         )
 
@@ -152,14 +152,14 @@ def connect(self) -> None:
             self._iface,
             hostname,
             self._device_id,
-            self._key,
+            self._device_sas_key,
             self._token_expires,
             self._logger,
         )
 
         self._logger.debug("Hostname: " + hostname)
         self._logger.debug("Device Id: " + self._device_id)
-        self._logger.debug("Shared Access Key: " + self._key)
+        self._logger.debug("Shared Access Key: " + self._device_sas_key)
 
         self._mqtt.connect()
         self._mqtt.subscribe_to_twins()
@@ -185,10 +185,7 @@ def is_connected(self) -> bool:
         :returns: True if there is an open connection, False if not
         :rtype: bool
         """
-        if self._mqtt is not None:
-            return self._mqtt.is_connected()
-
-        return False
+        return self._mqtt.is_connected() if self._mqtt is not None else False
 
     def loop(self) -> None:
         """Listens for MQTT messages

adafruit_azureiot/iothub_device.py

@@ -336,10 +336,7 @@ def is_connected(self) -> bool:
         :returns: True if there is an open connection, False if not
         :rtype: bool
         """
-        if self._mqtt is not None:
-            return self._mqtt.is_connected()
-
-        return False
+        return self._mqtt.is_connected() if self._mqtt is not None else False
 
     def send_device_to_cloud_message(
         self, message: Union[str, dict], system_properties: dict = None

adafruit_azureiot/quote.py

@@ -37,7 +37,7 @@ def quote(bytes_val: bytes, safe: Union[str, bytes, bytearray] = "/") -> str:
         # Normalize 'safe' by converting to bytes and removing non-ASCII chars
         safe = safe.encode("ascii", "ignore")
     else:
-        safe = bytes([char for char in safe if char < 128])
+        safe = bytes(char for char in safe if char < 128)
     if not bytes_val.rstrip(_ALWAYS_SAFE_BYTES + safe):
         return bytes_val.decode()
     try:

examples/ esp32spi /azureiot_central_commands.py

@@ -99,7 +99,7 @@
 
 # Create an IoT Hub device client and connect
 device = IoTCentralDevice(
-    socket, esp, secrets["id_scope"], secrets["device_id"], secrets["sas_key"]
+    socket, esp, secrets["id_scope"], secrets["device_id"], secrets["device_sas_key"]
 )
 
 # Subscribe to commands

examples/ esp32spi /azureiot_central_notconnected.py

@@ -103,7 +103,7 @@
 
 # Create an IoT Hub device client and connect
 device = IoTCentralDevice(
-    socket, esp, secrets["id_scope"], secrets["device_id"], secrets["sas_key"]
+    socket, esp, secrets["id_scope"], secrets["device_id"], secrets["device_sas_key"]
 )
 
 # don't connect

examples/ esp32spi /azureiot_central_properties.py

@@ -96,7 +96,7 @@
 
 # Create an IoT Hub device client and connect
 device = IoTCentralDevice(
-    socket, esp, secrets["id_scope"], secrets["device_id"], secrets["sas_key"]
+    socket, esp, secrets["id_scope"], secrets["device_id"], secrets["device_sas_key"]
 )
 
 # Subscribe to property changes
@@ -133,16 +133,14 @@ def property_changed(property_name, property_value, version):
             device.send_property("Desired_Temperature", random.randint(0, 50))
             message_counter = 0
         else:
-            message_counter = message_counter + 1
+            message_counter += 1
 
         # Poll every second for messages from the cloud
         device.loop()
     except (ValueError, RuntimeError) as e:
         print("Connection error, reconnecting\n", str(e))
-        # If we lose connectivity, reset the wifi and reconnect
         wifi.reset()
         wifi.connect()
         device.reconnect()
         continue
-
     time.sleep(1)

examples/ esp32spi /azureiot_central_simpletest.py

@@ -97,7 +97,7 @@
 
 # Create an IoT Hub device client and connect
 device = IoTCentralDevice(
-    socket, esp, secrets["id_scope"], secrets["device_id"], secrets["sas_key"]
+    socket, esp, secrets["id_scope"], secrets["device_id"], secrets["device_sas_key"]
 )
 
 print("Connecting to Azure IoT Central...")
@@ -118,7 +118,7 @@
             device.send_telemetry(json.dumps(message))
             message_counter = 0
         else:
-            message_counter = message_counter + 1
+            message_counter += 1
 
         # Poll every second for messages from the cloud
         device.loop()

examples/ esp32spi /azureiot_hub_messages.py

@@ -122,16 +122,14 @@ def cloud_to_device_message_received(body: str, properties: dict):
             device.send_device_to_cloud_message(json.dumps(message))
             message_counter = 0
         else:
-            message_counter = message_counter + 1
+            message_counter += 1
 
         # Poll every second for messages from the cloud
         device.loop()
     except (ValueError, RuntimeError) as e:
         print("Connection error, reconnecting\n", str(e))
-        # If we lose connectivity, reset the wifi and reconnect
         wifi.reset()
         wifi.connect()
         device.reconnect()
         continue
-
     time.sleep(1)

examples/ esp32spi /azureiot_hub_simpletest.py

@@ -112,16 +112,14 @@
             device.send_device_to_cloud_message(json.dumps(message))
             message_counter = 0
         else:
-            message_counter = message_counter + 1
+            message_counter += 1
 
         # Poll every second for messages from the cloud
         device.loop()
     except (ValueError, RuntimeError) as e:
         print("Connection error, reconnecting\n", str(e))
-        # If we lose connectivity, reset the wifi and reconnect
         wifi.reset()
         wifi.connect()
         device.reconnect()
         continue
-
     time.sleep(1)