Skip to content

Commit 968adab

Browse files
authored
move mac-only tls info to main README (#595)
1 parent 1ef6533 commit 968adab

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This document provides information about the AWS IoT Device SDK v2 for Python. T
77
*__Jump To:__*
88
* [Installation](#installation)
99
* [Samples](samples)
10+
* [Mac-Only TLS Behavior](#mac-only-tls-behavior)
1011
* [Getting Help](#getting-help)
1112
* [FAQ](./documents/FAQ.md)
1213
* [API Docs](https://aws.github.io/aws-iot-device-sdk-python-v2/)
@@ -59,6 +60,14 @@ python3 -m pip install ./aws-iot-device-sdk-python-v2
5960

6061
[Samples README](samples)
6162

63+
### Mac-Only TLS Behavior
64+
65+
Please note that on Mac, once a private key is used with a certificate, that certificate-key pair is imported into the Mac Keychain. All subsequent uses of that certificate will use the stored private key and ignore anything passed in programmatically. Beginning in v1.7.3, when a stored private key from the Keychain is used, the following will be logged at the "info" log level:
66+
67+
```
68+
static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.
69+
```
70+
6271
## Getting Help
6372

6473
The best way to interact with our team is through GitHub. You can open a [discussion](https://github.com/aws/aws-iot-device-sdk-python-v2/discussions) for guidance questions or an [issue](https://github.com/aws/aws-iot-device-sdk-python-v2/issues/new/choose) for bug reports, or feature requests. You may also find help on community resources such as [StackOverFlow](https://stackoverflow.com/questions/tagged/aws-iot) with the tag [#aws-iot](https://stackoverflow.com/questions/tagged/aws-iot) or if you have a support plan with [AWS Support](https://aws.amazon.com/premiumsupport/), you can also create a new support case.

documents/FAQ.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
* [Installation Issues](#installation-issues)
77
* [I keep getting AWS_ERROR_MQTT_UNEXPECTED_HANGUP](#i-keep-getting-aws_error_mqtt_unexpected_hangup)
88
* [I am experiencing deadlocks](#i-am-experiencing-deadlocks)
9-
* [Mac-Only TLS Behavior](#mac-only-tls-behavior)
109
* [How do debug in VSCode?](#how-do-debug-in-vscode)
1110
* [What certificates do I need?](#what-certificates-do-i-need)
1211
* [I still have more questions about this sdk?](#i-still-have-more-questions-about-this-sdk)
@@ -84,14 +83,6 @@ After getting it working make sure to only allow the actions and resources that
8483
### I am experiencing deadlocks
8584
You MUST NOT perform blocking operations on any callback, or you will cause a deadlock. For example: in the on_publish_received callback, do not send a publish, and then wait for the future to complete within the callback. The Client cannot do work until your callback returns, so the thread will be stuck.
8685

87-
### Mac-Only TLS Behavior
88-
89-
Please note that on Mac, once a private key is used with a certificate, that certificate-key pair is imported into the Mac Keychain. All subsequent uses of that certificate will use the stored private key and ignore anything passed in programmatically. Beginning in v1.7.3, when a stored private key from the Keychain is used, the following will be logged at the "info" log level:
90-
91-
```
92-
static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.
93-
```
94-
9586
### How do debug in VSCode?
9687

9788
Here is an example launch.json file to run the pubsub sample

0 commit comments

Comments
 (0)