Russh

Low-level Tokio SSH2 client and server implementation.

Crypto backends: enable at least one of the aws-lc-rs or ring features. russh fails to compile when both are disabled because a crypto backend is required.

Examples: simple client, interactive PTY client, server, SFTP client, SFTP server.

This is a fork of Thrussh by Pierre-Étienne Meunier.

✨ = added in Russh

More panic safety ✨
async traits ✨
direct-tcpip (local port forwarding)
forward-tcpip (remote port forwarding) ✨
direct-streamlocal (local UNIX socket forwarding, client only) ✨
forward-streamlocal (remote UNIX socket forwarding) ✨
Ciphers:
- chacha20-poly1305@openssh.com
- aes128-gcm@openssh.com ✨
- aes256-gcm@openssh.com ✨
- aes256-ctr ✨
- aes192-ctr ✨
- aes128-ctr ✨
- aes256-cbc ✨
- aes192-cbc ✨
- aes128-cbc ✨
- 3des-cbc ✨
Key exchanges:
- curve25519-sha256@libssh.org
- diffie-hellman-group-sha1 (GEX) ✨
- diffie-hellman-group1-sha1 ✨
- diffie-hellman-group14-sha1 ✨
- diffie-hellman-group-sha256 (GEX) ✨
- diffie-hellman-group14-sha256 ✨
- diffie-hellman-group16-sha512 ✨
- ecdh-sha2-nistp256 ✨
- ecdh-sha2-nistp384 ✨
- ecdh-sha2-nistp521 ✨
MACs:
- hmac-sha1 ✨
- hmac-sha2-256 ✨
- hmac-sha2-512 ✨
- hmac-sha1-etm@openssh.com ✨
- hmac-sha2-256-etm@openssh.com ✨
- hmac-sha2-512-etm@openssh.com ✨
Host keys and public key auth:
- ssh-ed25519
- rsa-sha2-256
- rsa-sha2-512
- ssh-rsa ✨
- ecdsa-sha2-nistp256 ✨
- ecdsa-sha2-nistp384 ✨
- ecdsa-sha2-nistp521 ✨
Authentication methods:
- password
- publickey
- keyboard-interactive
- none
- OpenSSH certificates ✨
Dependency updates
OpenSSH keepalive request handling ✨
OpenSSH agent forwarding channels ✨
OpenSSH server-sig-algs extension ✨
PPK key format ✨
Pageant support ✨
AsyncRead/AsyncWrite-able channels ✨

Safety

deny(clippy::unwrap_used)
deny(clippy::expect_used)
deny(clippy::indexing_slicing)
deny(clippy::panic)
Exceptions are checked manually

Panics

When the Rust allocator fails to allocate memory during a CryptoVec being resized.
When mlock/munlock fails to protect sensitive data in memory.

Unsafe code

cryptovec uses unsafe for faster copying, initialization and binding to native API.

Ecosystem

russh-sftp - server-side and client-side SFTP subsystem support for russh - see russh/examples/sftp_server.rs or russh/examples/sftp_client.rs.
async-ssh2-tokio - simple high-level API for running commands over SSH.

Adopters

HexPatch - A binary patcher and editor written in Rust with terminal user interface (TUI).
- Uses russh::client and russh_sftp::client to allow remote editing of files.
kartoffels - A game where you're given a potato and your job is to implement a firmware for it
- Uses russh:server to deliver the game, using ratatui as the rendering engine.
kty - The terminal for Kubernetes.
- Uses russh::server to deliver the ratatui based TUI and russh_sftp::server to provide scp based file management.
lapdev - Self-Hosted Remote Dev Environment
- Uses russh::server to construct a proxy into your development environment.
medusa - A fast and secure multi protocol honeypot.
- Uses russh::server to be the basis of the honeypot.
rebels-in-the-sky - P2P terminal game about spacepirates playing basketball across the galaxy
- Uses russh::server to deliver the game, using ratatui as the rendering engine.
warpgate - Smart SSH, HTTPS and MySQL bastion that requires no additional client-side software
- Uses russh::server in addition to russh::client as part of the smart SSH functionality.
Devolutions Gateway - Establish a secure entry point for internal or external segmented networks that require authorized just-in-time (JIT) access.
- Uses russh::client for the web-based SSH client of the standalone web application.
Sandhole - Expose HTTP/SSH/TCP services through SSH port forwarding. A reverse proxy that just works with an OpenSSH client.
- Uses russh::server for reverse forwarding connections, local forwarding tunnels, and the ratatui based admin interface.
Motor OS - A new Rust-based operating system for VMs.
- Uses russh::server as the base for its own SSH Server.
Cubic VM - A lightweight command-line manager for virtual machines.
- Uses russh::client and russh_sftp::client to access the virtual machine instances.
ferrissh - An async SSH CLI scraper library for network device automation in Rust.
- Uses russh::client for SSH transport, authentication, and interactive PTY sessions.
Yazi - Blazing fast terminal file manager written in Rust, based on async I/O.
- Uses russh::client to implement an async SFTP provider for remote file management.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/mihirsamdarshi"><img src="https://avatars.githubusercontent.com/u/5462077?v=4?s=100" width="100px;" alt="Mihir Samdarshi"/> Mihir Samdarshi</a> <a href="https://github.com/Eugeny/russh/commits?author=mihirsamdarshi" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://peet.io/"><img src="https://avatars.githubusercontent.com/u/2230985?v=4?s=100" width="100px;" alt="Connor Peet"/> Connor Peet</a> <a href="https://github.com/Eugeny/russh/commits?author=connor4312" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/kvzn"><img src="https://avatars.githubusercontent.com/u/313271?v=4?s=100" width="100px;" alt="KVZN"/> KVZN</a> <a href="https://github.com/Eugeny/russh/commits?author=kvzn" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://www.telekom.de"><img src="https://avatars.githubusercontent.com/u/21334898?v=4?s=100" width="100px;" alt="Adrian Müller (DTT)"/> Adrian Müller (DTT)</a> <a href="https://github.com/Eugeny/russh/commits?author=amtelekom" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://www.evilsocket.net"><img src="https://avatars.githubusercontent.com/u/86922?v=4?s=100" width="100px;" alt="Simone Margaritelli"/> Simone Margaritelli</a> <a href="https://github.com/Eugeny/russh/commits?author=evilsocket" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="http://joegrund.com"><img src="https://avatars.githubusercontent.com/u/458717?v=4?s=100" width="100px;" alt="Joe Grund"/> Joe Grund</a> <a href="https://github.com/Eugeny/russh/commits?author=jgrund" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/AspectUnk"><img src="https://avatars.githubusercontent.com/u/59799956?v=4?s=100" width="100px;" alt="AspectUnk"/> AspectUnk</a> <a href="https://github.com/Eugeny/russh/commits?author=AspectUnk" title="Code">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://0io.eu"><img src="https://avatars.githubusercontent.com/u/203575?v=4?s=100" width="100px;" alt="Simão Mata"/> Simão Mata</a> <a href="https://github.com/Eugeny/russh/commits?author=simao" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://mariotaku.org"><img src="https://avatars.githubusercontent.com/u/830358?v=4?s=100" width="100px;" alt="Mariotaku"/> Mariotaku</a> <a href="https://github.com/Eugeny/russh/commits?author=mariotaku" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/yorkz1994"><img src="https://avatars.githubusercontent.com/u/16678950?v=4?s=100" width="100px;" alt="yorkz1994"/> yorkz1994</a> <a href="https://github.com/Eugeny/russh/commits?author=yorkz1994" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://volution.ro/"><img src="https://avatars.githubusercontent.com/u/29785?v=4?s=100" width="100px;" alt="Ciprian Dorin Craciun

Russh

Install / Use

README

Russh

Safety

Panics

Unsafe code

Ecosystem

Adopters

Contributors ✨