2
0

README 3.0 KB

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