Skip to content

Commit 9b0cfcc

Browse files
kapbhrlubos
authored andcommitted
[nrf fromtree] doc: networking: Modify the wifi documents
Modify the wifi documents for better format. Signed-off-by: Kapil Bhatt <[email protected]> (cherry picked from commit 81ba3df)
1 parent 4fc21cb commit 9b0cfcc

File tree

2 files changed

+20
-18
lines changed

2 files changed

+20
-18
lines changed

doc/connectivity/networking/api/wifi.rst

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -97,42 +97,43 @@ To facilitate installation of the certificates, a helper script is provided, see
9797
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.
9898

9999

100-
To initiate Wi-Fi connection using enterprise security, use one of the following commands depending on the EAP method:
100+
To initiate a Wi-Fi connection using enterprise security, use one of the following commands depending on the EAP method:
101101

102-
**EAP-TLS**
102+
* EAP-TLS
103103

104-
.. code-block:: console
104+
.. code-block:: console
105105
106-
uart:~$ wifi connect -s <SSID> -c <channel> -k 7 -w 2 -a <Anonymous identity> --key1-pwd <Password EAP phase1> --key2-pwd <Password EAP phase2>
106+
uart:~$ wifi connect -s <SSID> -c <channel> -k 7 -w 2 -a <Anonymous identity> --key1-pwd <Password EAP phase1> --key2-pwd <Password EAP phase2>
107107
108-
**EAP-TTLS-MSCHAPV2**
108+
* EAP-TTLS-MSCHAPV2
109109

110-
.. code-block:: console
110+
.. code-block:: console
111111
112-
uart:~$ wifi connect -s <SSID> -c <channel> -k 14 -K <Private key Password> --eap-id1 <Client Identity> --eap-pwd1 <Client Password> -a <Anonymous identity>
112+
uart:~$ wifi connect -s <SSID> -c <channel> -k 14 -K <Private key Password> --eap-id1 <Client Identity> --eap-pwd1 <Client Password> -a <Anonymous identity>
113113
114-
**EAP-PEAP-MSCHAPV2**
114+
* EAP-PEAP-MSCHAPV2
115115

116-
.. code-block:: console
116+
.. code-block:: console
117117
118-
uart:~$ wifi connect -s <SSID> -c <channel> -k 12 -K <Private key Password> --eap-id1 <Client Identity> --eap-pwd1 <Client Password> -a <Anonymous identity>
118+
uart:~$ wifi connect -s <SSID> -c <channel> -k 12 -K <Private key Password> --eap-id1 <Client Identity> --eap-pwd1 <Client Password> -a <Anonymous identity>
119119
120120
Server certificate is also provided in the same directory for testing purposes.
121121
Any AAA server can be used for testing purposes, for example, ``FreeRADIUS`` or ``hostapd``.
122122

123123
Certificate requirements for EAP methods
124124
----------------------------------------
125125

126-
Different EAP methods require different certificates on the client side:
126+
Different EAP methods have varying client-side certificate requirements, as outlined below:
127127

128-
* **EAP-TLS**:
129-
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.
128+
* EAP-TLS - Requires both a client certificate (and its private key) and a CA certificate on the client.
129+
The client authenticates itself to the server using its certificate.
130130

131-
* **EAP-TTLS-MSCHAPV2**:
132-
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.
131+
* EAP-TTLS-MSCHAPV2 - Requires only the CA certificate on the client.
132+
The client authenticates to the server using a username and password <MSCHAPV2> inside the TLS tunnel.
133+
No client certificate is needed.
133134

134-
* **EAP-PEAP-MSCHAPV2**:
135-
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.
135+
* EAP-PEAP-MSCHAPV2 - Requires only the CA certificate on the client.
136+
Like TTLS, the client uses a username and password <MSCHAPV2> inside the TLS tunnel and does not require a client certificate.
136137

137138
.. note::
138139

doc/connectivity/networking/api/wifi_credentials.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ You can remove credentials using the :c:func:`wifi_credentials_delete_by_ssid` f
5353
Shell commands
5454
**************
5555

56-
``wifi cred`` is an extension to the Wi-Fi command line. It adds the following subcommands to interact with the Wi-Fi credentials library:
56+
``wifi cred`` is an extension to the Wi-Fi command line.
57+
It adds the following subcommands to interact with the Wi-Fi credentials library:
5758

5859
.. list-table:: Wi-Fi credentials shell subcommands
5960
:header-rows: 1

0 commit comments

Comments
 (0)