1.. _external_module_wolfssh:
2
3wolfSSH
4#######
5
6Introduction
7************
8
9wolfSSH is a lightweight, portable SSH library optimized for embedded systems, RTOS environments,
10and resource-constrained devices. It provides secure shell functionality including SSH server and
11client implementations, SCP, and SFTP support. Its support for multiple build configurations makes
12it suitable for a wide range of applications and hardware platforms that are utilizing Zephyr
13RTOS.
14
15wolfSSH has support for the Zephyr networking stack so applications can use the wolfSSH API to
16establish secure SSH connections with other devices or services over the network.
17
18wolfSSH is dual licensed under GPLv3 and commercial licenses.
19
20GitHub Repository: `wolfSSH Repository`_
21
22Requirements
23************
24
25* :ref:`external_module_wolfssl` for cryptographic operations
26
27Usage with Zephyr
28*****************
29
30Add wolfSSH as a project to your west.yml:
31
32.. code-block:: yaml
33
34  manifest:
35    remotes:
36    # <your other remotes>
37    - name: wolfssh
38      url-base: https://github.com/wolfssl
39  projects:
40    # <your other projects>
41    - name: wolfssh
42      path: modules/lib/wolfssh
43      revision: master
44      remote: wolfssh
45
46Update west's modules:
47
48.. code-block:: bash
49
50   west update
51
52Now west recognizes ``wolfssh`` as a module, and will include its Kconfig and CMakeLists.txt in
53the build system.
54
55For more regarding the usage of wolfSSH with Zephyr, please refer to the `wolfSSH Zephyr Example
56Usage`_.
57
58For application code examples in Zephyr, please refer to the `wolfSSL NXP AppCodeHub`_.
59
60For wolfSSH API documentation, please refer to the `wolfSSH Documentation`_.
61
62Reference
63*********
64
65.. target-notes::
66
67.. _wolfSSH Repository:
68    https://github.com/wolfSSL/wolfssh
69
70.. _wolfSSH Zephyr Example Usage:
71    https://github.com/wolfSSL/wolfssh/blob/master/zephyr/README.md#build-and-run-samples
72
73.. _wolfSSL NXP AppCodeHub:
74    https://github.com/wolfSSL/nxp-appcodehub
75
76.. _wolfSSH Documentation:
77    https://www.wolfssl.com/documentation/manuals/wolfssh/
78