-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: nrf: Create documentation for advanced Wi-Fi security modes.
Create documentation for enterprise mode and PSA. Add entry in migration guide for the syntax change in `wifi_cred add` command. Signed-off-by: Ravi Dondaputi <[email protected]> Signed-off-by: Vivekananda Uppunda <[email protected]> Signed-off-by: Chaitanya Tata <[email protected]>
- Loading branch information
Showing
5 changed files
with
92 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
doc/nrf/protocols/wifi/advanced_modes/wifi_advanced_security_modes.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
.. _ug_nrf70_wifi_advanced_security_modes: | ||
|
||
Wi-Fi advanced security modes | ||
############################# | ||
|
||
.. contents:: | ||
:local: | ||
:depth: 2 | ||
|
||
The nRF70 Series device Wi-Fi solution supports various advanced security modes to provide secure communication over Wi-Fi. | ||
The advanced security modes supported by the nRF70 Series device Wi-Fi solution are: | ||
|
||
* Wi-Fi Enterprise security | ||
* Wi-Fi PSA support | ||
|
||
Wi-Fi Enterprise security | ||
************************* | ||
|
||
Te nRF70 Series device Wi-Fi solution supports Wi-Fi Enterprise security, the below methods are supported: | ||
|
||
* WPA2-EAP-TLS | ||
|
||
Below sections provide details on how to enable and use Wi-Fi Enterprise security in your applications. | ||
|
||
|
||
Wi-Fi Enterprise test: X.509 Certificate header generation | ||
========================================================== | ||
|
||
Wi-Fi enterprise security requires use of X.509 certificates, test certificates | ||
in PEM format are committed to the repo at :zephyr_file:`subsys/net/lib/wifi_credentials/test_certs` and the during the | ||
build process the certificates are converted to a C header file that is included by the Wi-Fi shell | ||
module. | ||
|
||
.. note:: | ||
|
||
Only samples that use :ref:`Wi-Fi Credentials <lib_wifi_credentials>` library support Wi-Fi Enterprise security. | ||
|
||
|
||
.. code-block:: bash | ||
$ cp client.pem subsys/net/lib/wifi_credentials/test_certs/ | ||
$ cp client-key.pem subsys/net/lib/wifi_credentials/test_certs/ | ||
$ cp ca.pem subsys/net/lib/wifi_credentials/test_certs/ | ||
$ west build -p -b <board> samples/wifi/sta -- -DEXTRA_CONF_FILE=overlay-enterprise.conf | ||
To initiate Wi-Fi connection, the following command can be used: | ||
|
||
.. code-block:: console | ||
uart:~$ wifi connect -s <SSID> -k 7 -a anon -K <key passphrase> | ||
Server certificate is also provided in the same directory for testing purposes. | ||
Any AAA server can be used for testing purposes, for example, ``FreeRADIUS`` or ``hostapd``. | ||
|
||
.. note:: | ||
|
||
The certificates are for testing purposes only and should not be used in production. | ||
They are generated using `FreeRADIUS raddb <https://github.com/FreeRADIUS/freeradius-server/tree/master/raddb/certs>`_ scripts. | ||
|
||
|
||
Wi-Fi PSA support | ||
***************** | ||
|
||
The nRF70 Series device Wi-Fi solution supports `Platform Security Architecture (PSA)`_ (PSA) APIs for cryptographic operations. | ||
|
||
The nRF70 Series device Wi-Fi solution currently supports only WPA2-personal security profile in PSA mode. | ||
WPA3-personal and Enterprise security profiles will be supported in future releases using PSA APIs. | ||
|
||
|
||
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. | ||
|
||
.. code-block:: console | ||
$ west build -p -b <board> samples/wifi/shell -- -DCONFIG_WIFI_NM_WPA_SUPPLICANT_CRYPTO_ALT_NCS_PSA=y | ||
Wi-Fi connection process is similar to the non-PSA mode, the only difference is that the cryptographic operations are performed using PSA APIs. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters