wolfssh/zephyr
John Safranek 6e151e45c5 Use wolfCrypt SSHv2 KDF
1. Switching to use the new SSH-KDF function in wolfCrypt when the
   correct version of wolfSSL (v5.0.0 at a minimum) is used, when
   certified version of wolfCrypt is used or Kyber is disabled.
2. Add WOLFSSL_WOLFSSH to the wolfSSL user_settings files for the Zephyr
   testing.
2024-07-30 08:43:05 -07:00
..
samples/tests Use wolfCrypt SSHv2 KDF 2024-07-30 08:43:05 -07:00
CMakeLists.txt Init zephyr support 2023-10-02 20:38:21 +02:00
Kconfig Init zephyr support 2023-10-02 20:38:21 +02:00
README.md Init zephyr support 2023-10-02 20:38:21 +02:00
module.yml Init zephyr support 2023-10-02 20:38:21 +02:00

README.md

Zephyr Project Port

Overview

This port is for the Zephyr RTOS Project, available here.

It provides the following zephyr code.

  • modules/lib/wolfssh
    • wolfSSH library code
  • modules/lib/wolfssh/zephyr/
    • Configuration and CMake files for wolfSSH as a Zephyr module
  • modules/lib/wolfssh/zephyr/samples/tests
    • wolfSSH tests

How to setup as a Zephyr Module

Follow the instructions to setup a zephyr project.

Modify your project's west manifest

Add wolfSSH as a project to your west.yml:

manifest:
  remotes:
    # <your other remotes>
    - name: wolfssh
      url-base: https://github.com/wolfssl

  projects:
    # <your other projects>
    - name: wolfssh
      path: modules/lib/wolfssh
      revision: master
      remote: wolfssh

Update west's modules:

west update

Now west recognizes 'wolfssh' as a module, and will include it's Kconfig and CMakeFiles.txt in the build system.

Build and Run Samples

If you want to run build apps without running west zephyr-export then it is possible by setting the CMAKE_PREFIX_PATH variable to the location of the zephyr sdk and building from the zephyr directory. For example:

CMAKE_PREFIX_PATH=/path/to/zephyr-sdk-<VERSION> west build -p always -b qemu_x86 ../modules/lib/wolfssh/zephyr/samples/tests/

Build and Run Tests

build and execute tests

cd [zephyrproject]
west build -p auto -b qemu_x86 modules/lib/wolfssh/zephyr/samples/tests
west build -t run