Skip to content

Commit d3c91f7

Browse files
committed
Add a note to PKCS11 sample about tls 1.3
1 parent eccd25e commit d3c91f7

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

samples/node/mqtt/mqtt5_pkcs11/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,12 @@ You can read more about MQTT5 for the JavaScript IoT Device SDK V2 in the [MQTT5
1717

1818
## Requirements
1919

20-
This sample assumes you have the required AWS IoT resources available and a PKCS#11 compatible hardware security module (HSM) or software token. Information about AWS IoT can be found [HERE](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) and instructions on creating AWS IoT resources (AWS IoT Policy, Device Certificate, Private Key) can be found [HERE](https://docs.aws.amazon.com/iot/latest/developerguide/create-iot-resources.html).
20+
> [!IMPORTANT]
21+
> TLS integration with PKCS#11 has the following limitations:
22+
> - Only supported on Unix-like platforms
23+
> - TLS 1.3 is not supported
2124
22-
**NOTE: This configuration only works on Unix devices.**
25+
This sample assumes you have the required AWS IoT resources available and a PKCS#11 compatible hardware security module (HSM) or software token. Information about AWS IoT can be found [HERE](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) and instructions on creating AWS IoT resources (AWS IoT Policy, Device Certificate, Private Key) can be found [HERE](https://docs.aws.amazon.com/iot/latest/developerguide/create-iot-resources.html).
2326

2427
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, subscribe, publish, and receive. Below is a sample policy that can be used on your IoT Core Thing that will allow this sample to run as intended.
2528

@@ -121,4 +124,4 @@ Additionally, example code might theoretically modify or delete existing AWS res
121124

122125
- Be aware of the resources that these examples create or delete.
123126
- Be aware of the costs that might be charged to your account as a result.
124-
- Back up your important data.
127+
- Back up your important data.

0 commit comments

Comments
 (0)