WolfSSL
/
wolfssh
mirror of https://github.com/wolfSSL/wolfssh.git
1
0
Fork 0
Code Issues Releases Wiki Activity
wolfssh/ide/Espressif
History
Yosuke Shimizu 1a195cb1ec examples, ide, tests: classify the worker's status at the call site 
- ssh_worker() in both echoservers maps a WS_FATAL_ERROR return from
  wolfSSH_worker() to WS_WANT_READ or WS_WANT_WRITE at the call site,
  off a new local err, and keeps the result in rc.
- The terminal arm tests rc in place of re-reading wolfSSH_get_error():
  rc != WS_WANT_READ in examples/echoserver, and rc != WS_WANT_READ &&
  rc != WS_WANT_WRITE in the Espressif copy, whose empty WS_WANT_WRITE
  arm is removed.
- ssh_worker() in examples/echoserver sets wantWrite from
  wolfSSH_OutputPending() before it builds writeFds.
- The comment above rc = cnt_r in both echoservers names cnt_r and
  ssh->error as the values that are reused.
- scripts/sshclient.test and scripts/fwd-bulk.test name the client's
  missing non-blocking mode in the skip message where they echoed the
  macro name, and the comments above both skips are removed.
 		2026-09-17 10:26:52 -07:00
..
ESP-IDF examples, ide, tests: classify the worker's status at the call site 2026-09-17 10:26:52 -07:00
README.md Update Espressif README with getting started info. 2025-06-12 11:36:35 -07:00

README.md

wolfSSH Espressif Component Install

For more information on getting started with wolfSSL on the ESP32, see wolfssl/IDE/Espressif/README.md.

See also wolfSSH - Now Available as an Espressif Managed Component Includes SSH Echo Server Example.

ESP-IDF port

Overview

ESP-IDF development framework with wolfSSL by setting WOLFSSL_ESPIDF definition

Including the following examples:

  • SSH UART Server

The user_settings.h file enables some of the hardened settings.

Requirements

  1. ESP-IDF development framework

  2. The wolfSSH component requires the wolfssl component be installed first.

Setup for Linux

  1. Run setup.sh at /path/to/wolfssl/IDE/Espressif/ESP-IDF/ to deploy files into ESP-IDF tree
  2. Find Wolfssl files at /path/to/esp/esp-idf/components/wolfssl/
  3. Find Example programs under /path/to/esp/esp-idf/examples/protocols/wolfssl_xxx (where xxx is the project name)

Setup for Windows ESP-IDF

  1. Run ESP-IDF Command Prompt (cmd.exe) or Run ESP-IDF PowerShell Environment. The component path should be in "%IDF_PATH%".
  2. Run setup_win.bat at .\IDE\Espressif\ESP-IDF\
cd ESP-IDF
setup_win.bat
  1. Find Wolfssl files at /path/to/esp/esp-idf/components/wolfssl/

Setup for Windows ESP-IDF Project

Install a static copy of wolfSSH into a specific project component directory.

cd ESP-IDF
setup_win.bat C:\workspace\wolfssh\examples\ESP32-SSH-Server

Setup for Windows VisualGDB.

Install a static copy of wolfSSH into shared VisualGDB component directory

cd ESP-IDF
setup_win.bat C:\SysGCC\esp32\esp-idf\v4.4

Configuration

  1. The user_settings.h can be found in /path/to/esp/esp-idf/components/wolfssl/include/user_settings.h

Build examples

  1. See README in each example folder

Support

For question please email [support@wolfssl.com]

Note: This is tested with :

  • OS: Ubuntu 20.04.3 LTS and Microsoft Windows 10 Pro 10.0.19041 and well as WSL Ubuntu
  • ESP-IDF: ESP-IDF v4.3.2
  • Module : ESP32-WROOM-32