Skip to content

Commit 15cf0c5

Browse files
kapbhkartben
authored andcommitted
doc: networking: Add doc for EAP methods
Add commands to connect with EAP-TTLS and EAP-PEAP security modes. Signed-off-by: Kapil Bhatt <kapil.bhatt@nordicsemi.no>
1 parent d29719e commit 15cf0c5

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

doc/connectivity/networking/api/wifi.rst

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +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, the following command can be used:
100+
To initiate Wi-Fi connection using enterprise security, use one of the following commands depending on the EAP method:
101+
102+
**EAP-TLS**
103+
104+
.. code-block:: console
105+
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>
107+
108+
**EAP-TTLS-MSCHAPV2**
109+
110+
.. code-block:: console
111+
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>
113+
114+
**EAP-PEAP-MSCHAPV2**
101115

102116
.. code-block:: console
103117
104-
uart:~$ wifi connect -s <SSID> -c 149 -k 7 -w 2 -a client1 --key1-pwd whatever --key2-pwd whatever
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>
105119
106120
Server certificate is also provided in the same directory for testing purposes.
107121
Any AAA server can be used for testing purposes, for example, ``FreeRADIUS`` or ``hostapd``.
108122

123+
Certificate requirements for EAP methods
124+
----------------------------------------
125+
126+
Different EAP methods require different certificates on the client side:
127+
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.
130+
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.
133+
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.
136+
109137
.. note::
110138

111139
The certificates are for testing purposes only and should not be used in production.

0 commit comments

Comments
 (0)