SSL Client with Multiple TLS Versions#

1. Purpose / Scope#

This application demonstrates how to open a TCP client socket on RS9116W EVK and use this TCP client socket with secure connection using SSL and send the data on socket.

2. Prerequisites / Setup Requirements#

Before running the application, the user will need the following things to setup.

2.1 Hardware Requirements#

• Windows PC with Host interface (UART / SPI/ SDIO).

• Silicon Labs RS9116 Wi-Fi Evaluation Kit

• Host MCU Eval Kit. This example has been tested with:

  • Silicon Labs WSTK + EFR32MG21

  • Silicon Labs WSTK + EFM32GG11

  • STM32F411 Nucleo

• Wireless Access Point

• TCP server over SSL running in Windows PC2 (This application uses OpenSSL to create TCP server over SSL)

2.2 Software Requirements#

• WiSeConnect SDK

• Embedded Development Environment

  • For STM32, use licensed Keil IDE

  • For Silicon Labs EFx32, use the latest version of Simplicity Studio

  • OpenSSL Application in Windows PC (Remote PC).

3. Application Build Environment#

3.1 Platform#

The Application can be built and executed on below Host platforms

• STM32F411 Nucleo

• WSTK + EFR32MG21

• WSTK + EFM32GG11

3.2 Host Interface#

• By default, the application is configured to use the SPI bus for interfacing between Host platforms(STM32F411 Nucleo / EFR32MG21) and the RS9116W EVK.

• This application is also configured to use the SDIO bus for interfacing between Host platforms(EFM32GG11) and the RS9116W EVK.

3.3 Project Configuration#

The Application is provided with the project folder containing Keil and Simplicity Studio project files.

• Keil Project

  • The Keil project is used to evaluate the application on STM32.

  • Project path: <SDK>/examples/snippets/tls_client/projects/tls_client-nucleo-f411re.uvprojx

• Simplicity Studio

  • The Simplicity Studio project is used to evaluate the application on EFR32MG21.

  • Project path:

    • If the Radio Board is BRD4180A or BRD4181A, then access the path <SDK>/examples/snippets/tls_client/projects/tls_client-brd4180a-mg21.slsproj

    • If the Radio Board is BRD4180B or BRD4181B, then access the path <SDK>/examples/snippets/tls_client/projects/tls_client-brd4180b-mg21.slsproj

    • User can find the Radio Board version as given below

• EFM32GG11 platform

  • The Simplicity Studio project is used to evaluate the application on EFM32GG11.

    • Project path:<SDK>/examples/snippets/wlan/tls_client/projects/tls_client-brd2204a-gg11.slsproj

3.4 Bare Metal/RTOS Support#

This application supports bare metal and RTOS environment. By default, the application project files (Keil and Simplicity studio) are provided with bare metal configuration in the SDK.

4. Application Configuration Parameters#

The application can be configured to suit user requirements and development environment. Read through the following sections and make any changes needed.

4.1 Open rsi_ssl_client_tls_versions.c file#

4.1.1 User must update the below parameters#

SSID refers to the name of the Access point.

#define SSID                                           "SILABS_AP"

SECURITY_TYPE refers to the type of security. In this application STA supports Open, WPA-PSK, WPA2-PSK securities.

Valid configuration is:

• RSI_OPEN - For OPEN security mode

• RSI_WPA - For WPA security mode

• RSI_WPA2 - For WPA2 security mode

#define SECURITY_TYPE                                  RSI_WPA2

PSK refers to the secret key if the Access point configured in WPA-PSK /WPA2-PSK security modes.

#define PSK                                            "1234567890"

DEVICE_PORT1 port refers TCP client port number

#define DEVICE_PORT1                                   <local port>

SERVER_PORT1 port refers remote TCP server port number which is opened in Windows PC2.

#define SERVER_PORT1                                   <remote port>

DEVICE_PORT2 refers another TCP client port number

#define DEVICE_PORT2                                   <local port>

SERVER_PORT2 refers another remote TCP server port number which is opened in Windows PC2.

#define SERVER_PORT2                                   <remote port>

SERVER_IP_ADDRESS refers remote peer IP address to connect with TCP server socket.

IP address should be in long format and in little endian byte order.

Example: To configure "192.168.10.100" as IP address, update the macro DEVICE_IP as 0x640AA8C0.

#define SERVER_IP_ADDRESS                              0x640AA8C0

NUMEBR_OF_PACKETS refers how many packets to receive from TCP client

#define NUMBER_OF_PACKETS                              <no of packets>

4.1.2 The desired parameters are provided below. User can also modify the parameters as per their needs and requirements.#

The following parameters are configured if OS is used. WLAN task should be of low priority

#define RSI_WLAN_TASK_PRIORITY                   1

Driver task should have the highest priority among all threads

#define RSI_DRIVER_TASK_PRIORITY                 2

WLAN Task stack size is configured by this macro

#define RSI_WLAN_TASK_STACK_SIZE           500

Driver Task stack size is configured by this macro

#define RSI_DRIVER_TASK_STACK_SIZE         500

Application memory length which is required by the driver

#define GLOBAL_BUFF_LEN                                15000

LOAD_CERTIFICATE refers to load certificates into flash

0 - Already certificates are there in flash so no need to laod.

1 - Certicates will load into flash.

#define LOAD_CERTIFICATE                               0 

Note: If certificates are not there in flash then ssl handshake will fail.

DHCP_MODE refers whether IP address is configured through DHCP or STATIC

#define DHCP_MODE                                      1

Note: If user wants to configure STA IP address through DHCP then set DHCP_MODE to "1" and skip configuring the following DEVICE_IP, GATEWAY and NETMASK macros. (Or) If user wants to configure STA IP address through STATIC then set DHCP_MODE macro to "0" and configure following DEVICE_IP, GATEWAY and NETMASK macros.

IP address to be configured to the device in STA mode should be in long format and in little endian byte order.

Example: To configure "192.168.10.10" as IP address, update the macro DEVICE_IP as 0x0A0AA8C0.

#define DEVICE_IP                                     0X0A0AA8C0

IP address of the gateway should also be in long format and in little endian byte order.

Example: To configure "192.168.10.1" as Gateway, update the macro GATEWAY as 0x010AA8C0

#define GATEWAY                                       0x010AA8C0

IP address of the network mask should also be in long format and in little endian byte order

Example: To configure "255.255.255.0" as network mask, update the macro NETMASK as 0x00FFFFFF

#define NETMASK                                       0x00FFFFFF

4.2 Open rsi_wlan_config.h file. User can also modify the below parameters as per their needs and requirements.#

#define CONCURRENT_MODE                               RSI_DISABLE
#define RSI_FEATURE_BIT_MAP                           FEAT_SECURITY_OPEN
#define RSI_TCP_IP_BYPASS                             RSI_DISABLE
#define RSI_TCP_IP_FEATURE_BIT_MAP                    (TCP_IP_FEAT_DHCPV4_CLIENT | TCP_IP_FEAT_SSL)
#define RSI_CUSTOM_FEATURE_BIT_MAP                    FEAT_CUSTOM_FEAT_EXTENTION_VALID
#define RSI_EXT_CUSTOM_FEATURE_BIT_MAP                EXT_FEAT_SSL_VERSIONS_SUPPORT
#define RSI_BAND                                      RSI_BAND_2P4GHZ

Power save configuration

• By default, the application is configured without power save.

#define ENABLE_POWER_SAVE               0

• If user wants to run the application in power save, modify the below macro.

#define ENABLE_POWER_SAVE               1

5. Testing the Application#

Follow the below steps for the successful execution of the application.

5.1 Loading the RS9116W Firmware#

Refer Getting started with a PC to load the firmware into RS9116W EVK. The firmware file is located in <SDK>/firmware/

5.2 Building the Application on the Host Platform#

5.2.1 Using STM32#

Refer Getting started with STM32

• Open the project <SDK>/examples/snippets/tls_client/projects/tls_client-nucleo-f411re.uvprojx

• Build and Debug the project

• Check for the RESET pin:

  • If RESET pin is connected from STM32 to RS9116W EVK, then user need not press the RESET button on RS9116W EVK before free run.

  • If RESET pin is not connected from STM32 to RS9116W EVK, then user need to press the RESET button on RS9116W EVK before free run.

• Free run the project

• Then continue the common steps from 5.3

5.2.2 Using EFX32#

Refer Getting started with EFX32, for settin-up EFR & EFM host platforms

• Open Simplicity Studio and import the EFR32/EFM32 project from <SDK>/examples/snippets/wlan/tls_client/projects

  • Select the appropriate .slsproj as per Radio Board type mentioned in Section 3.3 for EFR32 board. (or)

  • Select the *.brd2204a-gg11.slsproj for EFM32GG11 board.

• Compile and flash the project in to Host MCU

• Debug the project

• Check for the RESET pin:

  • If RESET pin is connected from EFX32 to RS9116W EVK, then user need not press the RESET button on RS9116W EVK before free run

  • If RESET pin is not connected from EFX32 to RS9116W EVK, then user need to press the RESET button on RS9116W EVK before free run

• Free run the project

• Then continue the common steps from 5.3

5.3 Common Steps#

1. Configure the Access point in OPEN / WPA-PSK / WPA2-PSK mode to connect RS9116W EVK in STA mode.

2. Copy the certificates server-cert and server-key into Openssl/bin folder in the Windows PC2 (Remote PC).

Note: All the certificates are given in the SDK. Path: <SDK>/resources/certificates

1. In Windows PC2 (Remote PC) which is connected to AP, run the Openssl and run two SSL servers by giving the following command

Openssl.exe s_server -accept<SERVER_PORT> -cert <server_certificate_file_path> -key <server_key_file_path> -tls<tls_version> Example: openssl.exe s_server -accept 5001 -cert server-cert.pem -key server-key.pem -tls1 Example: openssl.exe s_server -accept 5002 -cert server-cert.pem -key server-key.pem -tls1_2 Note: openssl.exe s_server -accept 5002 -cert server-cert.pem -key server-key.pem -tls1_2 is not supporting if the open ssl version 0.9.8h but supporting if the open ssl version is 1.1.1h.

1. After the program gets executed, RS9116W EVK would be connected to access point having the configuration same as that of in the application and get IP.

2. The RS9116W EVK which is configured as SSL client will connect to remote SSL server and sends number of packets configured in NUMBER_OF_PACKETS.

Compressed Debug Logging#

To enable the compressed debug logging feature please refer to Logging User Guide