WolfSSL
/
wolfssh
mirror of https://github.com/wolfSSL/wolfssh.git
1
0
Fork 0
Code Issues Releases Wiki Activity
wolfssh/ide/STM32CUBE
History
Lealem Amedie a87fe3fce5 Updates to STM32Cube Pack 2024-05-02 16:33:43 -06:00
..
README.md Document Cube Pack dependencies 2023-05-03 14:56:52 -06:00
default_conf.ftl Updates to STM32Cube Pack 2024-05-02 16:33:43 -06:00
include.am Address feedback & add more relevant files 2023-03-24 13:42:03 -06:00
main.c Update Copyright Date 2024-03-22 12:17:09 -07:00
myFilesystem.h Update Copyright Date 2024-03-22 12:17:09 -07:00
userio_template.h Update Copyright Date 2024-03-22 12:17:09 -07:00
wolfssh_test.c Updates to STM32Cube Pack 2024-05-02 16:33:43 -06:00
wolfssh_test.h Update Copyright Date 2024-03-22 12:17:09 -07:00

README.md

wolfSSH for STM32 Cube IDE

The wolfSSH Cube Pack can be found here 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. 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. Open the project .ioc file and click the Software Packs drop down menu and then Select Components. Expand the wolfSSH pack and check all the components.

  4. In the Software Packs configuration category of the .ioc file, click on the wolfSSH pack and enable the library by checking the box.

  5. The Pack defaults to using custom IO provided by the user. Modify ide/STM32CUBE/userio_template.h to supply the custom IO. If you'd like to use LwIP instead, configure the wolfSSH IO settings in the .ioc to enable LwIP compatibilty. You'll also have to enable LwIP in the Middleware configuration category of the project. Enable the LWIP_DNS option in the LwIP configuration settings.

  6. Save your changes and select yes to the prompt asking about generating code.

  7. Build the project and run the unit tests.

Notes

  • Make sure to make these changes to redirect the printf's to the UART.

  • If looking to enable filesystem support (required for SFTP), the pack assumes the user has defined their own filesystem in wolfssh/myFilesystem.h. That file will originally contain a dummy filesystem. If going the FATFS route, make sure to replace #define WOLFSSH_USER_FILESYSTEM with #define WOLFSSH_FATFS in the wolfSSL.I-CUBE-wolfSSH_conf.h header file. The wolfSSL Cube Pack also defaults to disabling filesystem support so make sure to remove #define NO_FILESYSTEM from wolfSSL.I-CUBE-wolfSSL_conf.h.

  • If building with LwIP and you encounter the error multiple definition of 'errno' in Middlewares/Third_Party/LwIP/system/OS/sys_arch.c, modify the file as shown below.

#if defined(LWIP_SOCKET_SET_ERRNO) && defined(LWIP_PROVIDE_ERRNO)
- int errno;
+ extern int errno;
#endif