libssh-esp

This is a port of libssh for use in the ESP-IDF environment. libssh is a library that implements the SSH protocol, and this component enables SSH client and server functionality on the ESP32 series.

https://www.libssh.org/

Features

• SSH client and server support
• SFTP support (optional)
• Support for various authentication methods
• Port forwarding support

Supported Targets

• ESP32
• ESP32-S2
• ESP32-S3
• ESP32-C3 (tested)
• ESP32-C6

Dependencies

• ESP-IDF (v5.4 tested)
• mbedtls
• lwip

Installation

To use this component, clone this repository into your project's components directory, or add the following dependency to your idf_component.yml file:

dependencies:
  shinys000114/libssh-esp:
    version: "~0.11.2"
    git: https://github.com/shinys000114/libssh-esp.git

Usage

The libssh/examples directory contains various example code. You can build the examples using the idf.py build command, and upload and run the firmware with the idf.py flash monitor command.

For example, to run the example/echo example:

TBD

Configuration

You can configure the features of libssh using the idf.py menuconfig command.

• Component config -> libssh
  • support ssh server: Enable SSH server functionality.
  • support sftp: Enable SFTP functionality.

License

This project is licensed under the GNU Lesser General Public License. See the LICENSE file for details.