Skip to content

Commit 2eb99f7

Browse files
authored
add windows cert snippet to userguide (#557)
* add windows cert snippet to userguide * Add enntry to table of content, and to pubsub user guide * Update MQTT5_Userguide.md Change java to python
1 parent 4bddb9c commit 2eb99f7

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

documents/MQTT5_Userguide.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
* [Direct MQTT with PKCS12 Method](#direct-mqtt-with-pkcs12-method)
1616
* [MQTT over Websockets with Sigv4 authentication](#mqtt-over-websockets-with-sigv4-authentication)
1717
* [MQTT over Websockets with Cognito authentication](#mqtt-over-websockets-with-cognito-authentication)
18+
* [Direct MQTT with Windows Certificate Store Method](#direct-mqtt-with-windows-certificate-store-method)
1819
* [Adding an HTTP Proxy](#adding-an-http-proxy)
1920
* [Client Lifecycle Management](#client-lifecycle-management)
2021
* [Lifecycle Events](#lifecycle-events)
@@ -26,7 +27,7 @@
2627

2728
## **Introduction**
2829

29-
This user guide is designed to act as a reference and guide for how to use MQTT5 with the Java SDK. This guide includes code snippets for how to make a MQTT5 client with proper configuration, how to connect to AWS IoT Core, how to perform operations and interact with AWS IoT Core through MQTT5, and some best practices for MQTT5.
30+
This user guide is designed to act as a reference and guide for how to use MQTT5 with the Python SDK. This guide includes code snippets for how to make a MQTT5 client with proper configuration, how to connect to AWS IoT Core, how to perform operations and interact with AWS IoT Core through MQTT5, and some best practices for MQTT5.
3031

3132
If you are completely new to MQTT, it is highly recommended to check out the following resources to learn more about MQTT:
3233

@@ -211,6 +212,19 @@ To create a MQTT5 builder configured for this connection, see the following code
211212

212213
**Note**: A Cognito identity ID is different from a Cognito identity pool ID and 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.
213214

215+
#### **Direct MQTT with Windows Certificate Store Method**
216+
A MQTT5 direct connection can be made with mutual TLS with the certificate and private key in the Windows certificate
217+
store, rather than simply being files on disk. To create a MQTT5 builder configured for this connection, see the
218+
following code:
219+
220+
```python
221+
client = mqtt5_client_builder.mtls_with_windows_cert_store_path(
222+
cert_store_path="<CurrentUser\\MY\\A11F8A9B5DF5B98BA3508FBCA575D09570E0D2C6>",
223+
endpoint="<client specific endpoint>")
224+
```
225+
226+
**Note**: Windows Certificate Store connection support is only available on Windows devices.
227+
214228
### **Adding an HTTP Proxy**
215229
No matter what your connection transport or authentication method is, you may connect through an HTTP proxy
216230
by adding the http_proxy_options keyword argument to the builder:

samples/mqtt5_pubsub.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ All lifecycle events and the callback for publishes received by the MQTT5 Client
8282
* [Direct MQTT with PKCS12 Method](#direct-mqtt-with-pkcs12-method)
8383
* [MQTT over Websockets with Sigv4 authentication](#mqtt-over-websockets-with-sigv4-authentication)
8484
* [MQTT over Websockets with Cognito authentication](#mqtt-over-websockets-with-cognito-authentication)
85+
* [Direct MQTT with Windows Certificate Store Method](#direct-mqtt-with-windows-certificate-store-method)
8586
### HTTP Proxy
8687
* [Adding an HTTP Proxy](#adding-an-http-proxy)
8788

@@ -171,6 +172,19 @@ To create a MQTT5 builder configured for this connection, see the following code
171172

172173
**Note**: A Cognito identity ID is different from a Cognito identity pool ID and 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.
173174

175+
#### **Direct MQTT with Windows Certificate Store Method**
176+
A MQTT5 direct connection can be made with mutual TLS with the certificate and private key in the Windows certificate
177+
store, rather than simply being files on disk. To create a MQTT5 builder configured for this connection, see the
178+
following code:
179+
180+
```python
181+
client = mqtt5_client_builder.mtls_with_windows_cert_store_path(
182+
cert_store_path="<CurrentUser\\MY\\A11F8A9B5DF5B98BA3508FBCA575D09570E0D2C6>",
183+
endpoint="<client specific endpoint>")
184+
```
185+
186+
**Note**: Windows Certificate Store connection support is only available on Windows devices.
187+
174188
## **Adding an HTTP Proxy**
175189
No matter what your connection transport or authentication method is, you may connect through an HTTP proxy
176190
by adding the http_proxy_options keyword argument to the builder:

0 commit comments

Comments
 (0)