SSH.NET 2024.0.0

dotnet add package SSH.NET --version 2024.0.0
NuGet\Install-Package SSH.NET -Version 2024.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SSH.NET" Version="2024.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SSH.NET --version 2024.0.0
#r "nuget: SSH.NET, 2024.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SSH.NET as a Cake Addin
#addin nuget:?package=SSH.NET&version=2024.0.0

// Install SSH.NET as a Cake Tool
#tool nuget:?package=SSH.NET&version=2024.0.0

Logo SSH.NET

SSH.NET is a Secure Shell (SSH-2) library for .NET, optimized for parallelism.

Version NuGet download count Build status

Introduction

This project was inspired by Sharp.SSH library which was ported from java and it seems like was not supported for quite some time. This library is a complete rewrite, without any third party dependencies, using parallelism to achieve the best performance possible.

Documentation

There is MSDN-style class documentation in a .chm file for each release, which you can find in the Assets section of the latest release page. Please note that you will need to right-click and "unblock" the CHM file after you download it.

Currently (4/18/2020), the documentation is very sparse. Fortunately, there are a large number of tests in Renci.SshNet.Tests that demonstrate usage with working code.

If the test for the functionality you would like to see documented is not complete, then you are cordially invited to read the source, Luke, and highly encouraged to generate a pull request for the implementation of the missing test once you figure things out. 🤓

Features

  • Execution of SSH command using both synchronous and asynchronous methods
  • Return command execution exit status and other information
  • Provide SFTP functionality for both synchronous and asynchronous operations
  • Provides SCP functionality
  • Provide status report for upload and download sftp operations to allow accurate progress bar implementation
  • Remote, dynamic and local port forwarding
  • Shell/Terminal implementation
  • Specify key file pass phrase
  • Use multiple key files to authenticate
  • Supports publickey, password and keyboard-interactive authentication methods
  • Supports two-factor or higher authentication
  • Supports SOCKS4, SOCKS5 and HTTP Proxy

Encryption Method

SSH.NET supports the following encryption methods:

  • aes256-ctr
  • 3des-cbc
  • aes128-cbc
  • aes192-cbc
  • aes256-cbc
  • blowfish-cbc
  • twofish-cbc
  • twofish192-cbc
  • twofish128-cbc
  • twofish256-cbc
  • arcfour
  • arcfour128
  • arcfour256
  • cast128-cbc
  • aes128-ctr
  • aes192-ctr

Key Exchange Method

SSH.NET supports the following key exchange methods:

  • curve25519-sha256
  • curve25519-sha256<span></span>@libssh.org
  • ecdh-sha2-nistp256
  • ecdh-sha2-nistp384
  • ecdh-sha2-nistp521
  • diffie-hellman-group-exchange-sha256
  • diffie-hellman-group-exchange-sha1
  • diffie-hellman-group16-sha512
  • diffie-hellman-group14-sha256
  • diffie-hellman-group14-sha1
  • diffie-hellman-group1-sha1

Public Key Authentication

SSH.NET supports the following private key formats:

  • RSA in OpenSSL PEM and ssh.com format
  • DSA in OpenSSL PEM and ssh.com format
  • ECDSA 256/384/521 in OpenSSL PEM format
  • ECDSA 256/384/521, ED25519 and RSA in OpenSSH key format

Private keys can be encrypted using one of the following cipher methods:

  • DES-EDE3-CBC
  • DES-EDE3-CFB
  • DES-CBC
  • AES-128-CBC
  • AES-192-CBC
  • AES-256-CBC

Host Key Algorithms

SSH.NET supports the following host key algorithms:

  • ssh-ed25519
  • ecdsa-sha2-nistp256
  • ecdsa-sha2-nistp384
  • ecdsa-sha2-nistp521
  • rsa-sha2-512
  • rsa-sha2-256
  • ssh-rsa
  • ssh-dss

Message Authentication Code

SSH.NET supports the following MAC algorithms:

  • hmac-md5
  • hmac-md5-96
  • hmac-sha1
  • hmac-sha1-96
  • hmac-sha2-256
  • hmac-sha2-256-96
  • hmac-sha2-512
  • hmac-sha2-512-96
  • hmac-md5-etm<span></span>@openssh.com
  • hmac-md5-96-etm<span></span>@openssh.com
  • hmac-sha1-etm<span></span>@openssh.com
  • hmac-sha1-96-etm<span></span>@openssh.com
  • hmac-sha2-256-etm<span></span>@openssh.com
  • hmac-sha2-512-etm<span></span>@openssh.com

Framework Support

SSH.NET supports the following target frameworks:

  • .NETFramework 4.6.2 (and higher)
  • .NET Standard 2.0 and 2.1
  • .NET 6 (and higher)

Usage

Multi-factor authentication

Establish a SFTP connection using both password and public-key authentication:

var connectionInfo = new ConnectionInfo("sftp.foo.com",
                                        "guest",
                                        new PasswordAuthenticationMethod("guest", "pwd"),
                                        new PrivateKeyAuthenticationMethod("rsa.key"));
using (var client = new SftpClient(connectionInfo))
{
    client.Connect();
}

Verify host identify

Establish a SSH connection using user name and password, and reject the connection if the fingerprint of the server does not match the expected fingerprint:

string expectedFingerPrint = "LKOy5LvmtEe17S4lyxVXqvs7uPMy+yF79MQpHeCs/Qo";

using (var client = new SshClient("sftp.foo.com", "guest", "pwd"))
{
    client.HostKeyReceived += (sender, e) =>
        {
            e.CanTrust = expectedFingerPrint.Equals(e.FingerPrintSHA256);
        };
    client.Connect();
}

Supporting SSH.NET

Do you or your company rely on SSH.NET in your projects? If you want to encourage us to keep on going and show us that you appreciate our work, please consider becoming a sponsor through GitHub Sponsors.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (284)

Showing the top 5 NuGet packages that depend on SSH.NET:

Package Downloads
Testcontainers The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Testcontainers for .NET is a library to support tests with throwaway instances of Docker containers for all compatible .NET Standard versions.

Renci.SshNet.Async

Extends Renci.SshNet to implement the task-based async pattern

AspNetCore.HealthChecks.Network

HealthChecks.Network is the health check package for network services.

MongoDBMigrations

MongoDbMigrations uses the official MongoDB C# Driver to migrate your documents in your mongo database via useful fluent API. Supports up and down migrations with cancelation and progress handling. Also, this library is able to check a schema of collections in your database during the migration run. This version supports on-premise Mongo database either Azure CosmosDB (with Mongo-like API) or even AWS DocumentDB. In addition you can use TLS and/or SHH tunnels in your migrations. PS1 script for integration with CI/CD pipelines provides inside of the repository

Naos.Deployment.Core

Created on 2023-05-05 19:43

GitHub repositories (61)

Showing the top 5 popular GitHub repositories that depend on SSH.NET:

Repository Stars
ShareX/ShareX
ShareX is a free and open source program that lets you capture or record any area of your screen and share it with a single press of a key. It also allows uploading images, text or other types of files to many supported destinations you can choose from.
duplicati/duplicati
Store securely encrypted backups in the cloud!
mRemoteNG/mRemoteNG
mRemoteNG is the next generation of mRemote, open source, tabbed, multi-protocol, remote connections manager.
stride3d/stride
Stride Game Engine (formerly Xenko)
btcpayserver/btcpayserver
Accept Bitcoin payments. Free, open-source & self-hosted, Bitcoin payment processor.
Version Downloads Last updated
2024.0.0 30,621 2/21/2024
2023.0.1 547,267 12/29/2023
2023.0.0 2,718,185 10/10/2023
2020.0.2 22,029,725 5/29/2022
2020.0.1 18,411,582 1/24/2021
2020.0.0 1,890,409 12/31/2020
2020.0.0-beta1 3,271,893 6/7/2020
2016.1.0 45,601,422 10/16/2017
2016.1.0-beta4 4,406 10/7/2017
2016.1.0-beta3 39,243 9/20/2017
2016.1.0-beta2 64,363 8/16/2017
2016.1.0-beta1 142,289 12/14/2016
2016.0.0 5,643,332 8/2/2016
2016.0.0-beta3 4,577 7/27/2016
2016.0.0-beta2 16,786 6/25/2016
2016.0.0-beta1 3,968 6/19/2016
2014.4.6-beta2 441,417 11/22/2014
2014.4.6-beta1 13,759 4/6/2014
2013.4.7 1,959,689 4/6/2013
2013.1.27 110,832 1/27/2013
2013.1.8 7,287 1/8/2013
2012.21.12 4,108 12/21/2012
2012.20.12 2,947 12/20/2012
2012.12.3 4,622 12/4/2012
2012.3.9 12,785 3/9/2012
2011.12.7 3,543 3/3/2012
2011.9.28 4,087 10/13/2011
2011.7.29 12,832 9/16/2011