ultimatepp/uppsrc/Core/SSH/ReadMe
oblivion 665332a5e3 SSH: SshHosts error handling improved. Various fixes & cosmetics.
git-svn-id: svn://ultimatepp.org/upp/trunk@12181 f0d560ea-af0d-0410-9eb7-867de7ffcac7
2018-08-23 12:50:05 +00:00

49 lines
No EOL
1.7 KiB
Text

SSH package for U++
--------------------
SSH package is a flexible and easy-to-use libssh2 wrapper for Ultimate++.
It supports both console and GUI-based applications on POSIX-compliant operating systems and
MS Windows (tm).
Classes:
--------------------
- Base (core) class -> Ssh
- Ssh session -----> SshSession
- Sftp subsystem -----> SFtp
- Ssh channel -----> SshChannel
- Scp channel -----> Scp
- Exec channel -----> SshExec
- Real-time interactive shell -----> SshShell
- X11 forwarding -----> SshShell (as operation mode)
- Tcp/IP and port forwarding -----> SshTunnel
- Known hosts manager -> SshHosts
Features and Highlights:
--------------------
- Ssh-derived classes have pick semantics, based on RAII principle, support RTTI, and allow
polymorphism (i.e. different classes can be stored in the same arrays, etc.) through a common
interface.
- Uses U++ memory allocators (Native allocators is also a compile-time option)
- Uses OpenSSL by default.
- Supports 3rd-party network proxies.
- Supports known hosts verification mechanism.
- Supports password, public key, host-based, and keyboard-interactive authentication methods.
- Supports ssh-agents.
- Supports real-time interactive command line (shell) interface with both console and GUI integration
(works on both Windows and Posix-compliant OS'es)
- Supports multiple X11 connection forwarding.
- Supports Tcp/IP and port forwarding.
- Supports detailed (full) debug logging.
Todo:
--------------------
- Improve documentation.
Reference examples:
-------------------
- SshBasics: Demonstrates basic capabilities of SSH package.
- SFtpGUI: Demonstrates a simple sftp browser with GUI.