WebSocket Connection methods

samples/utils/command_line_utils.py

@@ -294,6 +294,10 @@ class CmdData:
         # PKCS12
         input_pkcs12_file : str
         input_pkcs12_password : str
+        # Static credentials
+        input_session_token : str
+        input_access_key_id : str
+        input_secret_access_key : str
 
         def __init__(self) -> None:
             pass
@@ -424,6 +428,27 @@ def parse_sample_input_custom_authorizer_connect():
         cmdData.input_is_ci = cmdUtils.get_command(CommandLineUtils.m_cmd_is_ci, None) != None
         return cmdData
 
+    def parse_sample_input_static_credentials_connect():
+        cmdUtils = CommandLineUtils(
+            "Static Credentials Connect - Make a MQTT connection using Static Credentials.")
+        cmdUtils.add_common_mqtt_commands()
+        cmdUtils.add_common_logging_commands()
+        cmdUtils.register_command(CommandLineUtils.m_cmd_client_id, "<str>",
+                                "Client ID to use for MQTT connection (optional, default='test-*').",
+                                default="test-" + str(uuid4()))
+        cmdUtils.register_command(CommandLineUtils.m_cmd_session_token, "<str>", "", default="test-" + str(uuid4()))
+        cmdUtils.register_command(CommandLineUtils.m_cmd_access_key_id, "<int>", "", type=int)
+        cmdUtils.register_command(CommandLineUtils.m_cmd_secret_access_key, "<str>", "")
+        cmdUtils.get_args()
+
+        cmdData = CommandLineUtils.CmdData()
+        cmdData.input_endpoint = cmdUtils.get_command_required(CommandLineUtils.m_cmd_endpoint)
+        cmdData.input_session_token = cmdUtils.get_command(CommandLineUtils.m_cmd_session_token)
+        cmdData.input_access_key_id  = cmdUtils.get_command(CommandLineUtils.m_cmd_access_key_id)
+        cmdData.input_secret_access_key = cmdUtils.get_command(CommandLineUtils.m_secret_access_key)
+        cmdData.input_clientId = cmdUtils.get_command(CommandLineUtils.m_cmd_client_id, "test-" + str(uuid4()))
+        cmdData.input_is_ci = cmdUtils.get_command(CommandLineUtils.m_cmd_is_ci, None) != None
+        return cmdData
 
     def parse_sample_input_fleet_provisioning():
         cmdUtils = CommandLineUtils("Fleet Provisioning - Provision device using either the keys or CSR.")
@@ -892,3 +917,6 @@ def parse_sample_input_pkcs12_connect():
     m_cmd_pkcs12_password = "pkcs12_password"
     m_cmd_region = "region"
     m_cmd_mqtt_version = "mqtt_version"
+    m_cmd_session_token = "session_token"
+    m_cmd_secret_access_key = "secret_access_key"
+    m_cmd_access_key_id = "access_key_id"

samples/websocket_connect.md

@@ -1,10 +1,19 @@
 # Websocket Connect
 
 [**Return to main sample list**](./README.md)
+If you want to use custom auth (or static creds, or basic auth, etc) instead,
+then you will need to replace part of the sample (connection\_setup function) with a code snippet we provided in its corresponding readme.
 
-This sample makes an MQTT connection via Websockets and then disconnects. On startup, the device connects to the server via Websockets and then disconnects right after. This sample is for reference on connecting via Websockets. This sample demonstrates the most straightforward way to connect via Websockets by querying the AWS credentials for the connection from the device's environment variables or local files.
+* [Websocket Connection Using Custom Authentication](#websocket-connection-using-custom-authentication)
+* [Websocket Connection Using Static Credentials](#websocket-connection-using-custom-authentication)
 
-Your IoT Core Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect. Below is a sample policy that can be used on your IoT Core Thing that will allow this sample to run as intended.
+This sample makes an MQTT connection via Websockets and then disconnects.
+On startup, the device connects to the server via Websockets and then disconnects right after.
+This sample is for reference on connecting via Websockets.
+This sample demonstrates the most straightforward way to connect via Websockets by querying the AWS credentials for the connection from the device's environment variables or local files.
+
+Your IoT Core Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect.
+Below is a sample policy that can be used on your IoT Core Thing that will allow this sample to run as intended.
 
 <details>
 <summary>(see sample policy)</summary>
@@ -29,17 +38,153 @@ Replace with the following with the data from your AWS account:
 * `<region>`: The AWS IoT Core region where you created your AWS IoT Core thing you wish to use with this sample. For example `us-east-1`.
 * `<account>`: Your AWS IoT Core account ID. This is the set of numbers in the top right next to your AWS account name when using the AWS IoT Core website.
 
-Note that in a real application, you may want to avoid the use of wildcards in your ClientID or use them selectively. Please follow best practices when working with AWS on production applications using the SDK. Also, for the purposes of this sample, please make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
+Note that in a real application, you may want to avoid the use of wildcards in your ClientID or use them selectively.
+Please follow best practices when working with AWS on production applications using the SDK.
+Also, for the purposes of this sample, please make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
 
-For this sample, using Websockets will attempt to fetch the AWS credentials to authorize the connection from your environment variables or local files. See the [authorizing direct AWS](https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html) page for documentation on how to get the AWS credentials, which then you can set to the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_SESSION_TOKEN` environment variables.
+For this sample, using Websockets will attempt to fetch the AWS credentials to authorize the connection from your environment variables or local files.
+See the [authorizing direct AWS](https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html) page for documentation on how to get the AWS credentials, which then you can set to the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_SESSION_TOKEN` environment variables.
 
 </details>
 
 ## How to run
 
+Optional parameters:
+```
+--proxy_host <str>
+--proxy_port <int>
+```
 To run the websocket connect from the `samples` folder, use the following command:
 
 ``` sh
 # For Windows: replace 'python3' with 'python' and '/' with '\'
-python3 websocket_connect.py --endpoint <endpoint> --signing_region <signing region>
+python3 websocket_connect.py --endpoint <endpoint> --signing_region <signing region> --proxy_host <str> --proxy_port <int>
+```
+
+
+# Websocket Connection Using Custom Authentication
+
+This sample makes an MQTT connection and connects through a [Custom Authorizer](https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html).
+On startup, the device connects to the server and then disconnects.
+This sample is for reference on connecting using a Custom Authorizer.
+Using a Custom Authorizer allows you to perform your own authorization using an AWS Lambda function.
+See [Custom Authorizer](https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html) for more information.
+You will need to setup your Custom Authorizer so that the lambda function returns a policy document.
+See [this page on the documentation](https://docs.aws.amazon.com/iot/latest/developerguide/config-custom-auth.html) for more details and example return result.
+You can customize this lambda function as needed for your application to provide your own security measures based on the needs of your application.
+Your IoT Core Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect.
+Below is a sample policy that can be used on your IoT Core Thing that will allow this sample to run as intended.
+
+If you want to use simple or custom auth (or static creds, or basic auth, etc) instead,
+then you will need to replace part of the sample (connection\_setup function) with a code snippet we provided in its corresponding readme.
+
+<details>
+<summary> (code snipet to replace the similar function)</summary>
+<pre language="python">
+<code>
+def connection_setup():
+    # cmdData is the arguments/input from the command line placed into a single struct for
+    # use in this sample. This handles all of the command line parsing, validating, etc.
+    # See the Utils/CommandLineUtils for more information.
+    cmdData = CommandLineUtils.parse_sample_input_custom_authorizer_connect()
+    # Create the proxy options if the data is present in cmdData
+    proxy_options = None
+
+    if cmdData.input_proxy_host is not None and cmdData.input_proxy_port != 0:
+        proxy_options = http.HttpProxyOptions(
+            host_name=cmdData.input_proxy_host,
+            port=cmdData.input_proxy_port)
+
+    # Create a default credentials provider and a MQTT connection from the command line data
+    credentials_provider = auth.AwsCredentialsProvider.new_default_chain()
+
+    mqtt_connection = mqtt_connection_builder.websockets_with_custom_authorizer(
+        endpoint=cmdData.input_endpoint,
+        credentials_provider=credentials_provider,
+        auth_username=cmdData.input_input_custom_auth_username,
+        auth_authorizer_name=cmdData.input_custom_authorizer_name,
+        auth_authorizer_signature=cmdData.input_custom_authorizer_signature,
+        auth_password=cmdData.input_custom_auth_password,
+        auth_token_key_name=cmdData.input_custom_authorizer_token_key_name,
+        auth_token_value=cmdData.input_custom_authorizer_token_value,
+        on_connection_interrupted=on_connection_interrupted,
+        on_connection_resumed=on_connection_resumed,
+        client_id=cmdData.input_clientId,
+        clean_session=False,
+        keep_alive_secs=30)
+
+    return mqtt_connection, cmdData
+
+</code>
+</pre>
+</details>
+
+## How to run
+Options for custom auth
+```
+--custom_auth_username <str>
+--custom_auth_authorizer_name <str>
+--custom_auth_authorizer_signature <str>
+--custom_auth_password <str>
+--custom_auth_token_name <str>
+--custom_auth_token_value <str>
 ```
+
+To run the websocket connect from the `samples` folder, use the following command:
+``` sh
+# For Windows: replace 'python3' with 'python' and '/' with '\'
+python3 websocket_connect.py --endpoint <endpoint> --custom_auth_username <str> --custom_auth_authorizer_name <str> --custom_auth_authorizer_signature <str> --custom_auth_password <str> --custom_auth_token_name <str> --custom_auth_token_value <str>
+```
+
+
+# Websocket Connection Using Static Credentials
+This sample makes an MQTT connection via Websockets and then disconnects.
+On startup, the device connects to the server via Websockets then disconnects right after.
+This sample demonstrates connecting via static credentials.
+
+If you want to use simple or custom auth (or static creds, or basic auth, etc) instead,
+then you will need to replace part of the sample (connection\_setup function) with a code snippet we provided in its corresponding readme.
+
+For this sample, using Websockets will attempt to fetch the AWS credentials to authorize the connection from static credentials.
+
+<details>
+<summary> (code snipet to replace the similar function)</summary>
+<pre language=cpp>
+<code >
+def connection_setup():
+    # cmdData is the arguments/input from the command line placed into a single struct for
+    # use in this sample. This handles all of the command line parsing, validating, etc.
+    # See the Utils/CommandLineUtils for more information.
+    cmdData = CommandLineUtils.parse_sample_input_static_credentials_connect()
+
+    cred_provider = AwsCredentialsProvider.new_static(
+        access_key_id=cmdData.input_access_key_id,
+        secret_access_key=cmdData.input_secret_access_key,
+        session_token=cmdData.input_session_token)
+
+    mqtt_connection = mqtt_connection_builder.websockets_with_default_aws_signing(
+        region=cmdData.input_signing_region,
+        credentials_provider=cred_provider,
+        endpoint=cmdData.input_endpoint,
+        client_id=cmdData.input_clientId)
+
+    return mqtt_connection, cmdData
+</code>
+</pre>
+</details>
+
+## How to run
+
+Options for static credentials
+```
+--access_key_id <str>
+--secret_access_key <str>
+--session_token <str>
+```
+
+To run the websocket connect from the `samples` folder, use the following command:
+``` sh
+# For Windows: replace 'python3' with 'python' and '/' with '\'
+python3 websocket_connect.py --endpoint <endpoint> --signing_region <signing region> --access_key_id <str> --secret_access_key <str> --session_token <str>
+```
+

samples/websocket_connect.py

@@ -8,10 +8,6 @@
 # This sample shows how to create a MQTT connection using websockets.
 # This sample is intended to be used as a reference for making MQTT connections.
 
-# cmdData is the arguments/input from the command line placed into a single struct for
-# use in this sample. This handles all of the command line parsing, validating, etc.
-# See the Utils/CommandLineUtils for more information.
-cmdData = CommandLineUtils.parse_sample_input_websocket_connect()
 
 # Callback when connection is accidentally lost.
 def on_connection_interrupted(connection, error, **kwargs):
@@ -21,8 +17,12 @@ def on_connection_interrupted(connection, error, **kwargs):
 def on_connection_resumed(connection, return_code, session_present, **kwargs):
     print("Connection resumed. return_code: {} session_present: {}".format(return_code, session_present))
 
+def connection_setup():
+    # cmdData is the arguments/input from the command line placed into a single struct for
+    # use in this sample. This handles all of the command line parsing, validating, etc.
+    # See the Utils/CommandLineUtils for more information.
+    cmdData = CommandLineUtils.parse_sample_input_websocket_connect()
 
-if __name__ == '__main__':
     # Create the proxy options if the data is present in cmdData
     proxy_options = None
     if cmdData.input_proxy_host is not None and cmdData.input_proxy_port != 0:
@@ -42,6 +42,10 @@ def on_connection_resumed(connection, return_code, session_present, **kwargs):
         client_id=cmdData.input_clientId,
         clean_session=False,
         keep_alive_secs=30)
+    return mqtt_connection, cmdData
+
+if __name__ == '__main__':
+    mqtt_connection, cmdData = connection_setup()
 
     if not cmdData.input_is_ci:
         print(f"Connecting to {cmdData.input_endpoint} with client ID '{cmdData.input_clientId}'...")