You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documents/MQTT5_Userguide.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,7 +88,7 @@ For X509 based mutual TLS, you can create a client where the certificate and pri
88
88
client = mqtt5_client_builder.mtls_from_path(
89
89
endpoint="<account-specific endpoint>",
90
90
cert_filepath=cert_filepath,
91
-
pri_key_filepath=pri_key_filepath))
91
+
pri_key_filepath=pri_key_filepath)
92
92
```
93
93
94
94
#### **Direct MQTT with Custom Authentication**
@@ -121,7 +121,7 @@ If your custom authorizer uses signing, you must specify the three signed token
121
121
122
122
In both cases, the builder will construct a final CONNECT packet username field value for you based on the values configured. Do not add the token-signing fields to the value of the username that you assign within the custom authentication config structure. Similarly, do not add any custom authentication related values to the username in the CONNECT configuration optionally attached to the client configuration. The builder will do everything for you.
123
123
124
-
#### **Direct MQTT with PKCS11 Method**
124
+
#### **Direct MQTT with PKCS11 Method (Unix Only)**
125
125
126
126
An MQTT5 direct connection can be made using a PKCS11 device rather than using a PEM encoded private key, the private key for mutual TLSis stored on a PKCS#11 compatible smart card or Hardware Security Module (HSM). To create an MQTT5 builder configured for this connection, see the following code:
127
127
@@ -144,7 +144,7 @@ An MQTT5 direct connection can be made using a PKCS11 device rather than using a
144
144
145
145
**Note**: Currently, TLS integration withPKCS#11 is only available on Unix devices.
146
146
147
-
#### **Direct MQTT with PKCS12 Method**
147
+
#### **Direct MQTT with PKCS12 Method (MacOs Only)**
148
148
149
149
An MQTT5 direct connection can be made using a PKCS12file rather than using a PEM encoded private key. To create an MQTT5 builder configured for this connection, see the following code:
**Note**: A Cognito identity IDis different from a Cognito identity pool IDand trying to connect with a Cognito identity pool ID will not work. If you are unable to connect, make sure you are passing a Cognito identity ID rather than a Cognito identity pool ID.
@@ -239,7 +239,7 @@ by adding the http_proxy_options keyword argument to the builder:
239
239
endpoint="<account-specific endpoint>",
240
240
cert_filepath="<certificate file path>",
241
241
pri_key_filepath="<private key file path>",
242
-
http_proxy_options= http_proxy_options))
242
+
http_proxy_options= http_proxy_options)
243
243
```
244
244
245
245
SDK Proxy support also includes support for basic authentication andTLS-to-proxy. SDK proxy support does not include any additional
Copy file name to clipboardExpand all lines: samples/mqtt/mqtt5_aws_websocket.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,6 +64,11 @@ Note that in a real application, you may want to avoid the use of wildcards in y
64
64
65
65
</details>
66
66
67
+
### Determining your signing region
68
+
69
+
The `signing_region` parameter specifies the AWS region used to sign WebSocket connection requests via [SigV4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). It must match the region of your AWS IoT Core endpoint.
70
+
For example, if your endpoint is `abcdef12345-ats.iot.us-west-2.amazonaws.com`, the signing region is `us-west-2`.
71
+
67
72
## How to run
68
73
69
74
To Run this sample from the `samples\mqtt` folder, use the following command:
0 commit comments