Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Psa documentation changes #18025

Closed

Conversation

VivekUppunda
Copy link
Contributor

This adds Wi-Fi PSA API support documentation. It details

  1. how to enable PSA API support
  2. current level of PSA API support
  3. connection establishment

@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Oct 21, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Oct 21, 2024

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 3

Inputs:

Sources:

more details

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (0)

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ❌ Toolchain
  • ❌ Build twister
  • ❌ Integration tests

Note: This message is automatically posted and updated by the CI

This commit adds documentation for current Wi-Fi support for PSA.

Signed-off-by: Vivekananda Uppunda <[email protected]>
The commit updates the release notes for Wi-Fi PSA support till WPA2.

Signed-off-by: Vivekananda Uppunda <[email protected]>
Comment on lines +36 to +37
.. code-block:: console
uart:~$ wifi connect -s <SSID> -p <passphrase> -k 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaving a blank line should resolve the doc build error.

Suggested change
.. code-block:: console
uart:~$ wifi connect -s <SSID> -p <passphrase> -k 1
.. code-block:: console
uart:~$ wifi connect -s <SSID> -p <passphrase> -k 1

Comment on lines +10 to +11
The nRF70 Series device Wi-Fi solution supports Platform Security Architecture(PSA) security framework.
The nRF70 Series device Wi-Fi solution achieves this by providing PSA API support for Wi-Fi cryptographic operations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove Wi-Fi solution since it is known that 70 Series is a Wi-Fi Series.

Suggested change
The nRF70 Series device Wi-Fi solution supports Platform Security Architecture(PSA) security framework.
The nRF70 Series device Wi-Fi solution achieves this by providing PSA API support for Wi-Fi cryptographic operations.
The nRF70 Series devices support the Platform Security Architecture (PSA) security framework.
This is achieved by providing PSA API support for Wi-Fi® cryptographic operations.

Enabling Wi-Fi PSA support
**************************

To enable the Wi-Fi PSA support in your applications, you must enable the :kconfig:option:`CONFIG_WIFI_NM_WPA_SUPPLICANT_CRYPTO_ALT_NCS_PSA` Kconfig option in your application.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To enable the Wi-Fi PSA support in your applications, you must enable the :kconfig:option:`CONFIG_WIFI_NM_WPA_SUPPLICANT_CRYPTO_ALT_NCS_PSA` Kconfig option in your application.
To enable the Wi-Fi PSA support in your applications, use the :kconfig:option:`CONFIG_WIFI_NM_WPA_SUPPLICANT_CRYPTO_ALT_NCS_PSA` Kconfig option.

Current Wi-Fi PSA Support level
*******************************

The nRF70 Series device Wi-Fi solution currently supports WPA2 and open security profiles. WPA2 security profiles use PSA APIs while performing cryptographic operations during connection establishment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The nRF70 Series device Wi-Fi solution currently supports WPA2 and open security profiles. WPA2 security profiles use PSA APIs while performing cryptographic operations during connection establishment.
The nRF70 Series devices currently support Wi-Fi Protected Access (WPA2™) and open security profiles.
WPA2 security profiles use PSA APIs for cryptographic operations during connection establishment.

*******************************

The nRF70 Series device Wi-Fi solution currently supports WPA2 and open security profiles. WPA2 security profiles use PSA APIs while performing cryptographic operations during connection establishment.
WPA3 and Enterprise security profiles currently are disabled for PSA operation and will not function when enabling :kconfig:option:`CONFIG_WIFI_NM_WPA_SUPPLICANT_CRYPTO_ALT_NCS_PSA` kconfig option.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
WPA3 and Enterprise security profiles currently are disabled for PSA operation and will not function when enabling :kconfig:option:`CONFIG_WIFI_NM_WPA_SUPPLICANT_CRYPTO_ALT_NCS_PSA` kconfig option.
WPA3 and Enterprise security profiles are currently disabled for PSA operation and will not function when the :kconfig:option:`CONFIG_WIFI_NM_WPA_SUPPLICANT_CRYPTO_ALT_NCS_PSA` Kconfig option is enabled.

Comment on lines +33 to +34
There is no change in the command used in establishing Wi-Fi connection.
The below command can be used to establish a Wi-Fi connection using WPA2 security profile.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest to remove the first sentence to avoid redundancy.

Suggested change
There is no change in the command used in establishing Wi-Fi connection.
The below command can be used to establish a Wi-Fi connection using WPA2 security profile.
To establish a Wi-Fi connection with a WPA2 security profile, run the following command:

@@ -254,6 +254,7 @@ Wi-Fi
-----

* The WPA supplicant is now switched to Zephyr upstream's fork instead of |NCS|.
* Added Platform Security Architecture (PSA) APIs support for WPA2 security profiles.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the link to the document.

Suggested change
* Added Platform Security Architecture (PSA) APIs support for WPA2 security profiles.
* Added :ref:`Platform Security Architecture (PSA) APIs support <ug_nrf70_developing_wifi_psa_support>` for WPA2 security profiles.

Copy link
Contributor

@richabp richabp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sachinthegreen Is it for 2.8.0 release?

@sachinthegreen
Copy link
Contributor

@sachinthegreen Is it for 2.8.0 release?

Yes.

@sachinthegreen sachinthegreen added this to the 2.8.0 milestone Oct 22, 2024
@krish2718
Copy link
Contributor

This PR has been cherry-picked to #18066

@krish2718 krish2718 closed this Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants