README
1The wolfSSL examples in the WICED SDK require a server or client application. wolfSSL
2provides an easy solution in the <wolfSSL root>/examples/ directory. The wolfSSL
3code repository is located on GitHub at https://github.com/wolfSSL/wolfssl.
4You can download or clone the repository. Run the autogen script and configure
5the library with necessary functionality, see ./configure -h
6for a list of configure options. Finally, run make and make check to ensure the
7build was successful. You can install wolfSSL on your system with make
8install if you wish. See www.wolfssl.com/docs/wolfssl-manual/ch2/, 'Building
9Wolfssl' for more information.
10
11Run ./examples/server/server -h for a list of server options or
12./examples/client/client -h for client options. If you would like
13to test the server or client, you may run them on localhost. Instructions on
14running the client or server can be found in the snip code examples in the
15WICED SDK. The snips are meant to be a starting off point for your applications.
16
17Download and install WICED Studio from the Cypress website.
18
19In the <wolfSSL_root>/IDE/WICED-STUDIO/ directory, you will find the library file
20user_settings.h which should be copied to <wolfSSL_root>. This is your wolfSSL
21configuration file. Please see www.wolfssl.com/docs/ for detailed instructions on
22how to use the configure options.
23
24Once you have installed the WICED software:
25 1. Create a directory called 'wolfssl_lib' in the BESL directory of WICED
26 SDK. The path to the new directory should be:
27 43xxx_Wi-Fi/WICED/security/BESL/wolfssl_lib.
28 2. Drag and drop the wolfssl library directory into the wolfssl_lib folder
29 you just created. The root wolfSSL directory was created when you either
30 downloaded or cloned the wolfSSL repository from github.
31 3. The user_settings.h file in the IDE/WICED-STUDIO/ directory should be
32 placed at <wolfssl_root> added to the WICED project in step #2.. This
33 file provides the configure options for compiling wolfSSL with your project.
34 The default values will give you a starting point and you may further
35 configure the library to meet your needs.
36 4. Apply the patch to your WICED IDE project's 43xxx_Wi-Fi/ directory.
37 a. Open a terminal and cd into the project 43xxx_Wi-Fi/ directory.:
38 b. git apply --ignore-space-change --ignore-whitespace mychanges.patch
39
40You can now build and use the wolfSSL and wolfCrypt snips within the WICED SDK.
41Cypress includes great documentation and getting started videos to learn how to
42build and run the snips in the Cypress Community section of their website,
43https://community.cypress.com/welcome/..
44
45wolfSSL provides a wolfCrypt test application, a TLS client and server application,
46and an HTTPS client application. Future development and additions will be made.
47
48Support for TLS 1.3 is available in the provided snippets and it is the most current
49TLS version available.
50
51Further instructions and documentation can be found on the wolfSSL website at
52www.wolfssl.com or visit us on our forums at www.wolfssl.com/forums/.
53
54