Skip to content

Commit

Permalink
doc: Updates to AWS IoT lib docs
Browse files Browse the repository at this point in the history
NCSDK-28995
* Improve commands on how to install
dependencies and usage of the AWS CLI.
* Improve instructions of AWS IoT setup
for nRF70 Series

Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
  • Loading branch information
divipillai committed Sep 11, 2024
1 parent 25e225e commit 47c9977
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
12 changes: 12 additions & 0 deletions doc/nrf/libraries/networking/aws_iot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ To complete the steps described in this document, make sure that the following p

* Install `AWS Command Line Interface`_ on your system and login as a user with appropriate permissions.
* To use the ``nrfcredstore`` tool, the dependencies in the :file:`nrf/scripts/requirements-extra.txt` file must be installed.
Enter the following commands in a ``cmd.exe`` terminal window in the :file:`ncs` folder to install all the dependencies in the file:

.. code-block:: console
pip3 install -r nrf/scripts/requirements-extra.txt
.. rst-class:: numbered-step

Expand All @@ -58,6 +63,8 @@ Generating and provisioning certificates
There are multiple ways to generate and register these certificates:

* The device key pair and certificate are generated by AWS and downloaded onto the device.
* You must configure AWS with the AWS configure command to generate the key pair.
See `AWS CLI example`_ for the commands on AWS configuration.
* The device generates the key pair and a Certificate Signing Request (CSR).
This request is uploaded to AWS to obtain a device certificate and is used to generate a self-signed device certificate.

Expand Down Expand Up @@ -188,8 +195,13 @@ There are multiple ways to generate and register these certificates:
#. Take note of the certificate ARN, as it will be required later.
#. Download the `Amazon Root CA 1`_ PEM file as :file:`ca-cert.pem`.
You need to rename the file if it is not saved as a :file:`.pem` file.
#. Place the PEM files into the folder path specified by the :kconfig:option:`CONFIG_MQTT_HELPER_CERTIFICATES_FOLDER` option, default is :file:`<app_src_dir>/certs/`.
Ensure that the :kconfig:option:`CONFIG_MQTT_HELPER_PROVISION_CERTIFICATES` option is set.

.. note::
It is not necessary to set the :kconfig:option:`CONFIG_MQTT_HELPER_CERTIFICATES_FOLDER` Kconfig option if the file is placed in a folder named :file:`certs` under the application source directory.

#. If the files are placed correctly, the :ref:`lib_mqtt_helper` library finds the certificates and provisions them to the Mbed TLS stack when connecting to AWS IoT.

.. rst-class:: numbered-step
Expand Down
1 change: 1 addition & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1114,6 +1114,7 @@
.. _`Security best practices in AWS IoT Core`: https://docs.aws.amazon.com/iot/latest/developerguide/security-best-practices.html
.. _`AWS IoT Core Server Authentication`: https://docs.aws.amazon.com/iot/latest/developerguide/server-authentication.html
.. _`CA certificates for server authentication in AWS IoT Core`: https://docs.aws.amazon.com/iot/latest/developerguide/server-authentication.html#server-authentication-certs
.. _`AWS CLI example`: https://docs.aws.amazon.com/cli/latest/reference/configure/#examples

.. _`AWS IoT console`: https://console.aws.amazon.com/iot/home
.. _`AWS S3 console`: https://console.aws.amazon.com/s3/home
Expand Down

0 comments on commit 47c9977

Please sign in to comment.