From 3ff153d72d6d96a313db862d77ee6738c977e5cd Mon Sep 17 00:00:00 2001 From: Steve Kim <86316075+sbSteveK@users.noreply.github.com> Date: Mon, 14 Oct 2024 10:50:01 -0700 Subject: [PATCH] move mac-only tls info to main README (#534) --- README.md | 9 +++++++++ documents/FAQ.md | 9 --------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 340304f0..b7e8f373 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ This document provides information about the AWS IoT device SDK for Javascript V *__Jump To:__* * [Installation](#installation) * [Samples](https://github.com/aws/aws-iot-device-sdk-js-v2/tree/main/samples) +* [Mac-Only TLS Behavior](#mac-only-tls-behavior) * [Getting Help](#getting-help) * [FAQ](https://github.com/aws/aws-iot-device-sdk-js-v2/blob/main/documents/FAQ.md) * [API Docs](https://aws.github.io/aws-iot-device-sdk-js-v2/) @@ -53,6 +54,14 @@ npm install [Samples README](https://github.com/aws/aws-iot-device-sdk-js-v2/blob/main/samples/README.md) +### Mac-Only TLS Behavior + +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: + +``` +static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided. +``` + ## Getting Help The best way to interact with our team is through GitHub. You can open a [discussion](https://github.com/aws/aws-iot-device-sdk-js-v2/discussions) for guidance questions or an [issue](https://github.com/aws/aws-iot-device-sdk-js-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. diff --git a/documents/FAQ.md b/documents/FAQ.md index 4857786e..eeda0284 100644 --- a/documents/FAQ.md +++ b/documents/FAQ.md @@ -4,7 +4,6 @@ * [Where should I start](#where-should-i-start) * [How do I enable logging](#how-do-i-enable-logging) * [I keep getting AWS_ERROR_MQTT_UNEXPECTED_HANGUP](#i-keep-getting-aws_error_mqtt_unexpected_hangup) -* [Mac-Only TLS Behavior](#mac-only-tls-behavior) * [How do debug in VSCode?](#how-do-debug-in-vscode) * [What certificates do I need?](#what-certificates-do-i-need) * [I would like to build a browser application and got error "Property does not exist on type 'typeof import("\/node_modules/aws-crt/dist/**native**/*")](#browser-error) @@ -44,14 +43,6 @@ This could be many different things but it most likely is a policy issue. Start After getting it working make sure to only allow the actions and resources that you need. More info about IoT IAM policies can be found [here](https://docs.aws.amazon.com/iot/latest/developerguide/security_iam_service-with-iam.html). -### Mac-Only TLS Behavior - -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: - -``` -static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided. -``` - ### How do debug in VSCode? Here is an example launch.json file to run the pubsub sample