GitHub - sshnet/SSH.NET: SSH.NET is a Secure Shell (SSH) library for .NET, optimized for parallelism. (original) (raw)

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

Version NuGet download count Build status

Key Features

How to Use

Run a command

using (var client = new SshClient("sftp.foo.com", "guest", new PrivateKeyFile("path/to/my/key"))) { client.Connect(); using SshCommand cmd = client.RunCommand("echo 'Hello World!'"); Console.WriteLine(cmd.Result); // "Hello World!\n" }

Upload and list files using SFTP

using (var client = new SftpClient("sftp.foo.com", "guest", "pwd")) { client.Connect();

using (FileStream fs = File.OpenRead(@"C:\tmp\test-file.txt"))
{
    client.UploadFile(fs, "/home/guest/test-file.txt");
}

foreach (ISftpFile file in client.ListDirectory("/home/guest/"))
{
    Console.WriteLine($"{file.FullName} {file.LastWriteTime}");
}

}

Main Types

The main types provided by this library are:

Additional Documentation

Encryption Methods

SSH.NET supports the following encryption methods:

Key Exchange Methods

SSH.NET supports the following key exchange methods:

Public Key Authentication

SSH.NET supports the following private key formats:

Private keys in OpenSSL traditional PEM format can be encrypted using one of the following cipher methods:

Private keys in OpenSSL PKCS#8 PEM format can be encrypted using any cipher method BouncyCastle supports.

Private keys in ssh.com format can be encrypted using the following cipher method:

Private keys in OpenSSH key format can be encrypted using one of the following cipher methods:

Private keys in PuTTY private key format can be encrypted using the following cipher method:

Host Key Algorithms

SSH.NET supports the following host key algorithms:

OpenSSH certificate authentication is supported for all of the above, e.g. ssh-ed25519-cert-v01@openssh.com.

Message Authentication Code

SSH.NET supports the following MAC algorithms:

Compression

SSH.NET supports the following compression algorithms:

Framework Support

SSH.NET supports the following target frameworks:

Building the library

The library has no special requirements to build, other than an up-to-date .NET SDK. See also CONTRIBUTING.md.

Using Pre-Release NuGet Packages

Pre-release NuGet packages are published from the develop branch to the GitHub NuGet Registry. In order to pull packages from the registry, create a Personal Access Token with the read:packages permissions. Then add a package source for SSH.NET:

dotnet nuget add source --name SSH.NET --username <username> --password <personalaccesstoken> https://nuget.pkg.github.com/sshnet/index.json

Note: you may have to add --store-password-in-clear-text on non-Windows platforms.

Then you can add the the package as described here.

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.