Merge branch 'main' into ct/py-overhaul

Author: cartertinney

credscan_suppression.json

@@ -40,6 +40,22 @@
     {
       "file": "\\tests\\unit\\iothub\\aio\\test_async_clients.py",
       "_justification": "Test containing fake signed data"
+    },
+    {
+      "file": "\\tests\\unit\\iothub\\pipeline\\test_pipeline_stages_iothub.py",
+      "_justification": "Test containing fake keys"
+    },
+    {
+      "file": "\\tests\\unit\\provisioning\\shared_client_tests.py",
+      "_justification": "Test containing fake keys"
+    },
+    {
+      "file": "\\tests\\unit\\provisioning\\pipeline\\test_pipeline_stages_provisioning.py",
+      "_justification": "Test containing fake keys"
+    },
+    {
+      "file": "\\tests\\unit\\common\\pipeline\\test_pipeline_stages_base.py",
+      "_justification": "Test containing fake signed data"
     }
   ]
 

sdklab/meantimerecovery/README.md

@@ -46,6 +46,18 @@ dead_duration : the amount of time the MQTT broker will be taken down for.
 
 Before running the the `mean_time_recover_with_docker.py` script make sure your docker engine is running.
 
+#### Connection string
+
+Both `mean_time_recover_with_docker.py` and `simple_send_message.py` read the device connection
+string from the `IOTHUB_DEVICE_CONNECTION_STRING` environment variable; neither script contains a
+connection string or key of its own. The local `aedes` broker does not verify the key, so any
+base64 value works, for example:
+
+`export IOTHUB_DEVICE_CONNECTION_STRING="HostName=localhost;DeviceId=devicemtr;SharedAccessKey=<base64 key>"`
+
+Use a throwaway value here. Never place a real IoT Hub device key in a shell history or a file
+that can be committed.
+
 #### Certificate creation
 
 There is another script which will create some self signed certificates for use in the `aedes` server.

sdklab/meantimerecovery/mean_time_recover_with_docker.py

@@ -5,6 +5,7 @@
 # --------------------------------------------------------------------------
 import docker
 import asyncio
+import os
 import uuid
 from azure.iot.device.aio import IoTHubDeviceClient
 from azure.iot.device import Message
@@ -124,6 +125,14 @@ def timer_done():
 
 async def main():
 
+    conn_str = os.getenv("IOTHUB_DEVICE_CONNECTION_STRING")
+    if not conn_str:
+        raise RuntimeError(
+            "Set the IOTHUB_DEVICE_CONNECTION_STRING environment variable to the connection "
+            "string of the device used against the local test broker, e.g. "
+            "HostName=localhost;DeviceId=devicemtr;SharedAccessKey=<base64 key>"
+        )
+
     ca_cert = "self_cert_localhost.pem"
     certfile = open(ca_cert)
     root_ca_cert = certfile.read()
@@ -140,7 +149,6 @@ async def main():
 
     # Do not delete sleep from here. Server needs some time to start.
     await asyncio.sleep(5)
-    conn_str = "HostName=localhost;DeviceId=devicemtr;SharedAccessKey=Zm9vYmFy"
     device_client = IoTHubDeviceClient.create_from_connection_string(
         conn_str, keep_alive=KEEP_ALIVE, server_verification_cert=root_ca_cert
     )

sdklab/meantimerecovery/simple_send_message.py

@@ -4,6 +4,7 @@
 # license information.
 # --------------------------------------------------------------------------
 import asyncio
+import os
 import uuid
 from azure.iot.device.aio import IoTHubDeviceClient
 from azure.iot.device import Message
@@ -41,7 +42,13 @@ async def main():
     # Scenario based values
     keep_alive = 15
 
-    conn_str = "HostName=localhost;DeviceId=devicemtr;SharedAccessKey=Zm9vYmFy"
+    conn_str = os.getenv("IOTHUB_DEVICE_CONNECTION_STRING")
+    if not conn_str:
+        raise RuntimeError(
+            "Set the IOTHUB_DEVICE_CONNECTION_STRING environment variable to the connection "
+            "string of the device used against the local test broker, e.g. "
+            "HostName=localhost;DeviceId=devicemtr;SharedAccessKey=<base64 key>"
+        )
     device_client = IoTHubDeviceClient.create_from_connection_string(
         conn_str, keep_alive=keep_alive
     )