Skip to content

Commit bc6b5b0

Browse files
authored
move mac-only tls info to main README (#599)
1 parent 227c674 commit bc6b5b0

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 for Java V2. Thi
77
* [Installation](#installation)
88
* [Android](./documents/ANDROID.md)
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-java-v2/)
@@ -71,6 +72,14 @@ mvn versions:use-latest-versions -Dincludes="software.amazon.awssdk.crt*"
7172

7273
[Samples README](samples)
7374

75+
### Mac-Only TLS Behavior
76+
77+
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:
78+
79+
```
80+
static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.
81+
```
82+
7483
## Getting Help
7584

7685
The best way to interact with our team is through GitHub. You can open a [discussion](https://github.com/aws/aws-iot-device-sdk-java-v2/discussions) for guidance questions or an [issue](https://github.com/aws/aws-iot-device-sdk-java-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
@@ -5,7 +5,6 @@
55
* [How do I enable logging](#how-do-i-enable-logging)
66
* [I keep getting AWS_ERROR_MQTT_UNEXPECTED_HANGUP](#i-keep-getting-aws_error_mqtt_unexpected_hangup)
77
* [I am experiencing deadlocks](#i-am-experiencing-deadlocks)
8-
* [Mac-Only TLS Behavior](#mac-only-tls-behavior)
98
* [How do debug in VSCode?](#how-do-debug-in-vscode)
109
* [What certificates do I need?](#what-certificates-do-i-need)
1110
* [How do I build and use the Android SDK?](#how-do-i-build-and-use-the-android-sdk)
@@ -64,14 +63,6 @@ After getting it working make sure to only allow the actions and resources that
6463

6564
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.
6665

67-
### Mac-Only TLS Behavior
68-
69-
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:
70-
71-
```
72-
static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.
73-
```
74-
7566
### How do debug in VSCode?
7667

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

0 commit comments

Comments
 (0)