Connection methods code snippets

aws · Nov 16, 2023 · 82c6f06 · 82c6f06
1 parent 74c8b68
commit 82c6f06
Show file tree

Hide file tree

Showing 7 changed files with 365 additions and 0 deletions.
diff --git a/samples/README.md b/samples/README.md
@@ -5,6 +5,13 @@
 * [Mqtt5 Pub-Sub](./mqtt5/mqtt5_pubsub/README.md)
 * [Mqtt5 Shared Subscription](./mqtt5/mqtt5_shared_subscription/README.md)
 * [Websocket Connect](./mqtt/websocket_connect/README.md)
+
+* [Websocket Connect](./mqtt/websocket_connect/README_custom_auth.md)
+* [Websocket Connect](./mqtt/websocket_connect/README_username_password.md)
+* [Websocket Connect](./mqtt/websocket_connect/README_proxy.md)
+* [Websocket Connect](./mqtt/websocket_connect/README_static_credentials.md)
+
+
 * [PKCS#11 Connect](./mqtt/pkcs11_connect/README.md)
 * [PKCS#12 Connect](./mqtt/pkcs12_connect/README.md)
 * [x509 Credentials Provider Connect](./mqtt/x509_credentials_provider_connect/README.md)

diff --git a/samples/mqtt/websocket_connect/README_custom_auth.md b/samples/mqtt/websocket_connect/README_custom_auth.md
@@ -0,0 +1,86 @@
+# Websocket Connect with Custom Authentication
+
+[**Return to main sample list**](../../README.md)
+
+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>
+<pre>
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "iot:Connect"
+      ],
+      "Resource": [
+        "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+      ]
+    }
+  ]
+}
+</pre>
+
+
+
+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.
+
+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>
+
+<details>
+<summary> (code snipet to replace similar section)</summary>
+<pre>
+```
+Utils::cmdData cmdData = Utils::parseSampleInputCustomAuthorizerConnect(argc, argv, &apiHandle);
+
+// Create the MQTT builder and populate it with data from cmdData.
+Aws::Iot::MqttClient client;
+
+Aws::Crt::Auth::CredentialsProviderChainDefaultConfig defaultConfig;
+
+std::shared_ptr<Aws::Crt::Auth::ICredentialsProvider> provider =
+    Aws::Crt::Auth::CredentialsProvider::CreateCredentialsProviderChainDefault(defaultConfig);
+
+Aws::Iot::WebsocketConfig websocketConfig((cmdData.input_signingRegion), provider);
+
+auto clientConfigBuilder = Aws::Iot::MqttClientConnectionConfigBuilder(websocketConfig);
+
+clientConfigBuilder.WithEndpoint((cmdData.input_endpoint));
+
+clientConfigBuilder.WithCustomAuthorizer(
+    (cmdData.input_customAuthUsername),
+    (cmdData.input_customAuthorizerName),
+    (cmdData.input_customAuthorizerSignature),
+    (cmdData.input_customAuthPassword),
+    (cmdData.input_customTokenKeyName),
+    (cmdData.input_customTokenValue));
+```
+</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 use the following command:
+
+``` sh
+./websocket-connect --endpoint <endpoint> --signing_region <signing region>
+```
diff --git a/samples/mqtt/websocket_connect/README_proxy.md b/samples/mqtt/websocket_connect/README_proxy.md
@@ -0,0 +1,96 @@
+# Websocket Connect with Proxy
+
+[**Return to main sample list**](../../README.md)
+
+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>
+<pre>
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "iot:Connect"
+      ],
+      "Resource": [
+        "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+      ]
+    }
+  ]
+}
+</pre>
+
+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.
+
+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>
+
+<details>
+<summary> (code snipet to replace similar section)</summary>
+<pre>
+```
+Utils::cmdData cmdData = Utils::parseSampleInputWebsocketConnect(argc, argv, &apiHandle);
+
+// Create the MQTT builder and populate it with data from cmdData.
+Aws::Iot::MqttClient client;
+Aws::Iot::MqttClientConnectionConfigBuilder clientConfigBuilder;
+std::shared_ptr<Aws::Crt::Auth::ICredentialsProvider> provider = nullptr;
+Aws::Crt::Auth::CredentialsProviderChainDefaultConfig defaultConfig;
+provider = Aws::Crt::Auth::CredentialsProvider::CreateCredentialsProviderChainDefault(defaultConfig);
+if (!provider)
+{
+fprintf(stderr, "Failure to create credentials provider!\n");
+exit(-1);
+}
+Aws::Iot::WebsocketConfig config(cmdData.input_signingRegion, provider);
+clientConfigBuilder = Aws::Iot::MqttClientConnectionConfigBuilder(config);
+if (cmdData.input_ca != "")
+{
+clientConfigBuilder.WithCertificateAuthority(cmdData.input_ca.c_str());
+}
+if (cmdData.input_proxyHost == "")
+{
+    fprintf(stderr, "proxy address missing!\n");
+    exit(-1);
+}
+Aws::Crt::Http::HttpClientConnectionProxyOptions proxyOptions;
+proxyOptions.HostName = cmdData.input_proxyHost;
+proxyOptions.Port = static_cast<uint16_t>(cmdData.input_proxyPort);
+proxyOptions.AuthType = Aws::Crt::Http::AwsHttpProxyAuthenticationType::None;
+clientConfigBuilder.WithHttpProxyOptions(proxyOptions);
+
+if (cmdData.input_port != 0)
+{
+    clientConfigBuilder.WithPortOverride(static_cast<uint16_t>(cmdData.input_port));
+}
+clientConfigBuilder.WithEndpoint(cmdData.input_endpoint);
+```
+</pre>
+</details>
+
+## How to run
+Options for custom auth
+```
+--proxy_host <str>
+--proxy_port <int>
+```
+
+To run the websocket connect use the following command:
+
+``` sh
+./websocket-connect --endpoint <endpoint> --signing_region <signing region>
+```
+
+
+
+
diff --git a/samples/mqtt/websocket_connect/README_static_credentials.md b/samples/mqtt/websocket_connect/README_static_credentials.md
@@ -0,0 +1,77 @@
+# Websocket Connect with static credentials
+
+[**Return to main sample list**](../../README.md)
+
+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>
+<pre>
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "iot:Connect"
+      ],
+      "Resource": [
+        "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+      ]
+    }
+  ]
+}
+</pre>
+
+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.
+
+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>
+
+
+<details>
+<summary> (code snipet to replace similar section)</summary>
+<pre>
+```
+Utils::cmdData cmdData = Utils::parseSampleInputWebsocketConnect(argc, argv, &apiHandle);
+
+Aws::Crt::Auth::CredentialsProviderChainDefaultConfig defaultConfig;
+
+std::shared_ptr<Aws::Crt::Auth::ICredentialsProvider> provider = nullptr;
+Aws::Crt::Auth::CredentialsProviderStaticConfig providerConfig;
+
+providerConfig.AccessKeyId = aws_byte_cursor_from_c_str((cmdData.input_accessKeyId.c_str()));
+providerConfig.SecretAccessKey = aws_byte_cursor_from_c_str((cmdData.input_secretAccessKey.c_str()));
+providerConfig.SessionToken = aws_byte_cursor_from_c_str((cmdData.input_sessionToken.c_str()));
+
+provider = Aws::Crt::Auth::CredentialsProvider::CreateCredentialsProviderStatic(providerConfig);
+Aws::Iot::WebsocketConfig config(cmdData.input_signingRegion, provider);
+
+Aws::Iot::MqttClient client;
+auto clientConfigBuilder = Aws::Iot::MqttClientConnectionConfigBuilder(config);
+clientConfigBuilder.WithEndpoint((cmdData.input_endpoint));
+```
+</pre>
+</details>
+
+## How to run
+Options for custom auth
+```
+--access_key_id <str>
+--secret_access_key <str>
+--session_token <str>
+```
+
+To run the websocket connect use the following command:
+
+``` sh
+./websocket-connect --endpoint <endpoint> --signing_region <signing region>
+```
+
diff --git a/samples/mqtt/websocket_connect/README_username_password.md b/samples/mqtt/websocket_connect/README_username_password.md
@@ -0,0 +1,76 @@
+# Websocket Connect Username and Password
+
+[**Return to main sample list**](../../README.md)
+
+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>
+<pre>
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "iot:Connect"
+      ],
+      "Resource": [
+        "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+      ]
+    }
+  ]
+}
+</pre>
+
+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.
+
+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>
+
+<details>
+<summary> (code snipet to replace similar section)</summary>
+<pre>
+```
+Utils::cmdData cmdData = Utils::parseSampleInputCustomAuthorizerConnect(argc, argv, &apiHandle);
+
+// Create the MQTT builder and populate it with data from cmdData.
+Aws::Iot::MqttClient client;
+Aws::Crt::Auth::CredentialsProviderChainDefaultConfig defaultConfig;
+std::shared_ptr<Aws::Crt::Auth::ICredentialsProvider> provider =
+    Aws::Crt::Auth::CredentialsProvider::CreateCredentialsProviderChainDefault(defaultConfig);
+Aws::Iot::WebsocketConfig websocketConfig((cmdData.input_signingRegion), provider);
+
+auto clientConfigBuilder = Aws::Iot::MqttClientConnectionConfigBuilder(websocketConfig);
+clientConfigBuilder.WithEndpoint((cmdData.input_endpoint));
+clientConfigBuilder.WithCustomAuthorizer(
+    (cmdData.input_customAuthUsername),
+    (cmdData.input_customAuthorizerName),
+    (cmdData.input_customAuthorizerSignature),
+    (cmdData.input_customAuthPassword));
+```
+</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>
+```
+
+To run the websocket connect use the following command:
+
+``` sh
+./websocket-connect --endpoint <endpoint> --signing_region <signing region>
+```
+