WolfSSL
/
wolfssh
mirror of https://github.com/wolfSSL/wolfssh.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Document Cube Pack dependencies

pull/513/head
Lealem Amedie 2023-05-03 14:56:52 -06:00
parent 54df2e99b8
commit 66e19b74d4
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
ide/STM32CUBE/README.md
View File

@ -2,6 +2,23 @@
The wolfSSH Cube Pack can be found [here](https://www.wolfssl.com/files/ide/I-CUBE-wolfSSH.pack) and is dependent on the `wolfCrypt` library.
## Dependencies
### wolfCrypt
The wolfCrypt crypto library is required to build/run the wolfSSH pack.
### RTOS
The wolfSSH pack core functionality can be built without an RTOS but to build/run the tests, FreeRTOS will have to be added as a middlware.
### Input/Output
By default, the wolfSSH pack uses a dummy custom IO implementation. The user is expected to be provide their own implementation in `ide/STM32CUBE/userio_template.h`. Alternatively, they can enable LwIP and configure wolfSSH to use it.
## Building and Running Tests
1. The first step is to set up the wolfCrypt library in your ST project following the guide here [https://github.com/wolfSSL/wolfssl/blob/master/IDE/STM32Cube/README.md](https://github.com/wolfSSL/wolfssl/blob/master/IDE/STM32Cube/README.md). To run the wolfSSH unit tests, name the entry function `wolfSSHTest` instead of `wolfCryptDemo`.
2. Then install the wolfSSH Cube Pack in the same manner as the wolfSSL pack with CUBEMX.

3
ide/STM32CUBE/wolfssh_test.h
View File

@ -25,6 +25,9 @@
#include <config.h>
#endif
#include <wolfssl/wolfcrypt/settings.h>
#include <wolfssh/settings.h>
#include "../../tests/unit.h"
#include "../../tests/api.h"
#include "../../tests/testsuite.h"