From 81ba3dfa92f48391dbdef71ea46826433dfa25ce Mon Sep 17 00:00:00 2001 From: Kapil Bhatt Date: Wed, 2 Jul 2025 05:39:22 +0000 Subject: [PATCH] doc: networking: Modify the wifi documents Modify the wifi documents for better format. Signed-off-by: Kapil Bhatt --- doc/connectivity/networking/api/wifi.rst | 35 ++++++++++--------- .../networking/api/wifi_credentials.rst | 3 +- 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/doc/connectivity/networking/api/wifi.rst b/doc/connectivity/networking/api/wifi.rst index 084d48383af..65cc7d9502d 100644 --- a/doc/connectivity/networking/api/wifi.rst +++ b/doc/connectivity/networking/api/wifi.rst @@ -97,25 +97,25 @@ To facilitate installation of the certificates, a helper script is provided, see The script will install the certificates in the ``rsa2k`` directory to the TLS credentials store in the device over UART and using TLS credentials shell commands. -To initiate Wi-Fi connection using enterprise security, use one of the following commands depending on the EAP method: +To initiate a Wi-Fi connection using enterprise security, use one of the following commands depending on the EAP method: -**EAP-TLS** +* EAP-TLS -.. code-block:: console + .. code-block:: console - uart:~$ wifi connect -s -c -k 7 -w 2 -a --key1-pwd --key2-pwd + uart:~$ wifi connect -s -c -k 7 -w 2 -a --key1-pwd --key2-pwd -**EAP-TTLS-MSCHAPV2** +* EAP-TTLS-MSCHAPV2 -.. code-block:: console + .. code-block:: console - uart:~$ wifi connect -s -c -k 14 -K --eap-id1 --eap-pwd1 -a + uart:~$ wifi connect -s -c -k 14 -K --eap-id1 --eap-pwd1 -a -**EAP-PEAP-MSCHAPV2** +* EAP-PEAP-MSCHAPV2 -.. code-block:: console + .. code-block:: console - uart:~$ wifi connect -s -c -k 12 -K --eap-id1 --eap-pwd1 -a + uart:~$ wifi connect -s -c -k 12 -K --eap-id1 --eap-pwd1 -a 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``. @@ -123,16 +123,17 @@ Any AAA server can be used for testing purposes, for example, ``FreeRADIUS`` or Certificate requirements for EAP methods ---------------------------------------- -Different EAP methods require different certificates on the client side: +Different EAP methods have varying client-side certificate requirements, as outlined below: -* **EAP-TLS**: - Requires both a client certificate (and private key) and the CA certificate on the client. The client authenticates itself to the server using its certificate. +* EAP-TLS - Requires both a client certificate (and its private key) and a CA certificate on the client. + The client authenticates itself to the server using its certificate. -* **EAP-TTLS-MSCHAPV2**: - Requires only the CA certificate on the client. The client authenticates to the server using a username and password (MSCHAPV2) inside the TLS tunnel. No client certificate is needed. +* EAP-TTLS-MSCHAPV2 - Requires only the CA certificate on the client. + The client authenticates to the server using a username and password inside the TLS tunnel. + No client certificate is needed. -* **EAP-PEAP-MSCHAPV2**: - Requires only the CA certificate on the client. Like TTLS, the client uses a username and password (MSCHAPV2) inside the TLS tunnel and does not need a client certificate. +* EAP-PEAP-MSCHAPV2 - Requires only the CA certificate on the client. + Like TTLS, the client uses a username and password inside the TLS tunnel and does not require a client certificate. .. note:: diff --git a/doc/connectivity/networking/api/wifi_credentials.rst b/doc/connectivity/networking/api/wifi_credentials.rst index 6713f29729b..d13a7d6608b 100644 --- a/doc/connectivity/networking/api/wifi_credentials.rst +++ b/doc/connectivity/networking/api/wifi_credentials.rst @@ -53,7 +53,8 @@ You can remove credentials using the :c:func:`wifi_credentials_delete_by_ssid` f Shell commands ************** -``wifi cred`` is an extension to the Wi-Fi command line. It adds the following subcommands to interact with the Wi-Fi credentials library: +``wifi cred`` is an extension to the Wi-Fi command line. +It adds the following subcommands to interact with the Wi-Fi credentials library: .. list-table:: Wi-Fi credentials shell subcommands :header-rows: 1