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 a14e6d0f3c ssh, apps, examples: take the worker's status from its return 
- wolfSSH_OutputPending() moves from wolfssh/internal.h to
  wolfssh/ssh.h as a WOLFSSH_API taking a const WOLFSSH*, defined
  in src/ssh.c beside the other public calls.
- wolfSSH_worker() puts the send's code in the return in place of
  an event when the flush fails outright, and gates its flush on
  wolfSSH_OutputPending(). wolfssh/ssh.h states both.
- Both wolfsshd shell loops, both echoservers and
  ReceiveScpMessage() dispatch on wolfSSH_worker()'s return, and
  call wolfSSH_get_error() only to tell a transient failure from a
  terminal one. The POSIX wolfsshd loop sets wantWrite from
  wolfSSH_OutputPending().
- Five worker tests expect the send's code where they expected the
  event, and tests/testsuite.c calls wolfSSH_OutputPending().
 		2026-09-14 10:40:48 -07:00
..
ESP-IDF ssh, apps, examples: take the worker's status from its return 2026-09-14 10:40:48 -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