How to Port WOLFSSL Onto TI Sitara AM335 Starterkit

How to Port WOLFSSL Onto TI Sitara AM335 Starterkit

Trademarks

All other trademarks are the property of their respective owners.

1 Introduction

WolfSSL is a famous TLS/SSL software solution and it is proven by many worldwide customers. Its quality is robust and the WolfSSL company maintains the security of their product each year.

This document contains:

• Where to get the right WolfSSL code versions
• Which TI RTOS version will be the suitable base for porting
• Step-by-step porting
• Code building
• How to run the demo

2 Hardware and Software Required Stuffs

• Hardware:
  • TI AM335 Starter Kit
• Software:
  • TI RTOS SDK for AM335
• WolfSSL for TI TivaC:
  • wolfSSL/wolfssl-examples
• WolfSSL main release
• TI CCS 7.4
  • Download CCS
• Microsoft Virtual Studio Express 2012
  • en_visual_studio_express_2012_for_windows_desktop_x86_web_installer_1001991.exe

3 Step-by-Step Porting

Follow these steps for porting:

1. Download the AM335 RTOS SDK.
2. Create the example by referencing this: http://processors.wiki.ti.com/index.php/Rebuilding_The_PDK
3. Build the PDK.
4. Follow the information in Section 4 to merge the WolfSSL required code.
5. The pictures in Section 4 have the WolfSSL original code.
6. Add the must-have compile option.
7. Rebuild the entire project.

4 Merging the WolfSSL Code and Building Regarding the NIMP FTP Example

Create the three sub-folders (see Figure 1) in your code base, then put those folders under the parent folder named: wolfSSL.

1. Copy wolfssl-master\src to (for example):

If you are installing all of the TI packages, then, go to pdk_am335x_1_0_10\packages\MyExampleProjects\NIMU_FtpExample_skAM335x_armExampleproject\wolfssl\src.

Figure 2. Copy wolfssl\src
2. Copy wolfssl-master\wolfcrypt\src to (for example):

If you are installing all of the TI packages, then, go to pdk_am335x_1_0_10\packages\MyExampleProjects\NIMU_FtpExample_skAM335x_armExampleproject\wolfssl\wolfcrypt\src.

Figure 3. Copy wolfssl\wolfcrypt\src

Do not copy the “port” dir.

Do not copy the .asm .s file.

Figure 4 is marked with “X”.

Figure 4. Ignore the .s/.asm Files
3. Copy the wolfssl-master\wolfssl\ files to (for example):

If you are installing all the TI packgeI, then, go to pdk_am335x_1_0_10\packages\MyExampleProjects\ NIMU_FtpExample_skAM335x_armExampleproject\wolfssl\wolfSSL.

Figure 5. Copy wolfssl\wolfSSL
4. Copy the wolfssl-master\wolfssl\wolfcrypt code (without “port” folder”) to (for example):

If you are installing all the TI packge, then, go to pdk_am335x_1_0_10\packages\MyExampleProjects\NIMU_FtpExample_skAM335x_armExampleproject\wolfssl\wolfSSL\wolfcrypt.

Figure 6. Copy wolfssl\wolfSSL\wolfcrypt
5. Modify some codes:

In the wolfssl\wolfcrypt\src\random.c, add the code as shown in Figure 7.

Figure 7. random.c Modification
6. In the wolfssl\src\internal.c, add the code as shown in Figure 8.
Figure 8. internal.c Modification

Add a new file (for example):

• wolfssl\src\random_rng_Porting.c

Reference the random_rng_Porting.c file in this zip file: 2018_5_15_WolfSSL_Importan_Temp_Backup_Client_Server_All_Okay_Release.

Download from here.

Figure 9. random_rng_Porting.c Modification
7. Add the two parts shown in Figure 10 into the file: nimu_skam335x.cfg.
Figure 10. nimu_skam335x.cfg Modification
8. In the wolfssl\src\internal.c file, add the two parts:

The first part is to register the user I/O call back:

• wolfSSL_SetIORecv
• wolfSSL_SetIOSend
Figure 11. My Own IO Callback Regs

Another one is to get the system time, this is related with the NO_ASN_TIME/ASN_TIME config.

Figure 12. My Time Modification
9. Add the “must-have” compile options for wolfSSL.

For example, xNO_FILESYSTEM is to disable the “NO_FILESYSTEM”.

Figure 13. Compile Definition

Add the included folder for the wolfSSL used header file.

Figure 14. Include Path Setting Part 1
10. Add the Variables for environment including use.
Figure 15. Include Path Setting Part 2
11. Adding the variable to the environment.
Figure 16. Include Path Setting Part 3
12. Project settings:

Select the right compiler version and the boards. AM335SK can use the ICE_AM3359.

Figure 17. Project Setting
13. Product settings:

Please make sure the right versions of:

• XDCtools
• SysBios
• PDK
• NDK
Figure 18. Product Setting
14. Target config:

The important key for the download image and debug is the JTAG.

• It needs to choose XDS100V2 USB
• Board of device is: SK_AM3358

You can test the connection while finishing your own setting of the “ccxml.

Figure 19. Target Config
15. Build should be successful.
Figure 20. Project Building

5 How to Verify?

You can reference this article:

• USING WOLFSSL WITH VISUAL STUDIO

You can access the two exe files that are listed under this path: : wolfssl-master\Debug.

• Client.exe
• Server.exe
• Run the WolfSSL Client on the NB to verify your server code (the Server IP/port is depended on the code).
  • Client.exe –h 192.168.1.4 –p 2000
• Run the WolfSSL Server on the NB to verify your WolfSSL client code (the port is dependent on the code).
  • Server.exe –b –p 1000
• Use the NB with Win7 and Virtual studio express.
  • en_visual_studio_express_2012_for_windows_desktop_x86_web_installer_1001991.exe

6 Testing environment

The testing environment is as shown in Figure 21; each node will communicate with the Ethernet.

7 Demo Movie

Search on YouTube for “TI Rio WolfSSL”. Or, visit the link here.

8 Function API

You can reference this article:

• wolfSSL-Porting-Guide.pdf

The four API are the basic soul for the entire demo. All of the important API are listed as shown below.

• wolfSSL_CTX_new
• wolfSSL_CTX_load_verify_buffer
• wolfSSL_CTX_use_certificate_buffer
• wolfSSL_CTX_use_PrivateKey_buffer

The two calls are user configured for your own code; you can refer to the wolSSL porting guide.

• wolfSSL_SetIORecv
• wolfSSL_SetIOSend

The following are the APIs used after the TCP socket is configured and connected. The wolfSSL data transmission on the TCP socket will rely on those APIs.

• wolfSSL_new
• wolfSSL_set_fd
• wolfSSL_connect
• wolfSSL_get_fd
• wolfSSL_write
• wolfSSL_read
• wolfSSL_free