Skip to content

Commit dc12eb5

Browse files
authored
move mac-only tls info to main README (#754)
1 parent 6bf060a commit dc12eb5

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 @@ __Jump To:__
77
* [Supported Architectures](#supported-architectures)
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-cpp-v2/)
@@ -108,6 +109,14 @@ existing `libcrypto`, instead of building its own copy.
108109

109110
[Samples README](./samples)
110111

112+
### Mac-Only TLS Behavior
113+
114+
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:
115+
116+
```
117+
static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.
118+
```
119+
111120
## Getting Help
112121

113122
The best way to interact with our team is through GitHub. You can open a [discussion](https://github.com/aws/aws-iot-device-sdk-cpp-v2/discussions) for guidance questions or an [issue](https://github.com/aws/aws-iot-device-sdk-cpp-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
@@ -8,7 +8,6 @@
88
* [Detecting connection loss (tldr use keepAliveTimeSecs and pingTimeoutMs)](#connection-loss)
99
* [How to use a Pre-Built aws-crt-cpp (Most useful for development of this package)](#prebuilt-aws-crt-cpp)
1010
* [I am experiencing deadlocks](#i-am-experiencing-deadlocks)
11-
* [Mac-Only TLS Behavior](#mac-only-tls-behavior)
1211
* [How do debug in VSCode?](#how-do-debug-in-vscode)
1312
* [What certificates do I need?](#what-certificates-do-i-need)
1413
* [I still have more questions about this sdk?](#i-still-have-more-questions-about-this-sdk)
@@ -82,14 +81,6 @@ cmake --build . --target install
8281

8382
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.
8483

85-
### Mac-Only TLS Behavior
86-
87-
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:
88-
89-
```
90-
static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.
91-
```
92-
9384
### How do debug in VSCode?
9485

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

0 commit comments

Comments
 (0)