base on SSH.NET is a Secure Shell (SSH) library for .NET, optimized for parallelism. ![Logo](https://raw.githubusercontent.com/sshnet/SSH.NET/develop/images/logo/png/SS-NET-icon-h50.png) SSH.NET ======= SSH.NET is a Secure Shell (SSH-2) library for .NET, optimized for parallelism. [![Version](https://img.shields.io/nuget/vpre/SSH.NET.svg)](https://www.nuget.org/packages/SSH.NET) [![NuGet download count](https://img.shields.io/nuget/dt/SSH.NET.svg)](https://www.nuget.org/packages/SSH.NET) ![Build status](https://github.com/sshnet/SSH.NET/actions/workflows/build.yml/badge.svg) ## Key Features * Execution of SSH commands using both synchronous and asynchronous methods * SFTP functionality for both synchronous and asynchronous operations * SCP functionality * Remote, dynamic and local port forwarding * Interactive shell/terminal implementation * Authentication via public key, password and keyboard-interactive methods, including multi-factor * Connection via SOCKS4, SOCKS5 or HTTP proxy ## How to Use ### Run a command ```cs 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 ```cs 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: * [Renci.SshNet.SshClient](https://sshnet.github.io/SSH.NET/api/Renci.SshNet.SshClient.html) * [Renci.SshNet.SftpClient](https://sshnet.github.io/SSH.NET/api/Renci.SshNet.SftpClient.html) * [Renci.SshNet.PrivateKeyFile](https://sshnet.github.io/SSH.NET/api/Renci.SshNet.PrivateKeyFile.html) * [Renci.SshNet.SshCommand](https://sshnet.github.io/SSH.NET/api/Renci.SshNet.SshCommand.html) * [Renci.SshNet.ForwardedPort](https://sshnet.github.io/SSH.NET/api/Renci.SshNet.ForwardedPort.html) * [Renci.SshNet.ShellStream](https://sshnet.github.io/SSH.NET/api/Renci.SshNet.ShellStream.html) ## Additional Documentation * [Further examples](https://sshnet.github.io/SSH.NET/examples.html) * [Logging](https://sshnet.github.io/SSH.NET/logging.html) * [API browser](https://sshnet.github.io/SSH.NET/api/Renci.SshNet.html) ## Encryption Methods **SSH.NET** supports the following encryption methods: * aes128-ctr * aes192-ctr * aes256-ctr * aes128-gcm<span></span>@openssh.com * aes256-gcm<span></span>@openssh.com * chacha20-poly1305<span></span>@openssh.com * aes128-cbc * aes192-cbc * aes256-cbc * 3des-cbc ## Key Exchange Methods **SSH.NET** supports the following key exchange methods: * mlkem768x25519-sha256 * sntrup761x25519-sha512 * sntrup761x25519-sha512<span></span>@openssh.com * 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 traditional PEM format ("BEGIN RSA PRIVATE KEY") * OpenSSL PKCS#8 PEM format ("BEGIN PRIVATE KEY", "BEGIN ENCRYPTED PRIVATE KEY") * ssh.com format ("BEGIN SSH2 ENCRYPTED PRIVATE KEY") * OpenSSH key format ("BEGIN OPENSSH PRIVATE KEY") * PuTTY private key format ("PuTTY-User-Key-File-2", "PuTTY-User-Key-File-3") * ECDSA 256/384/521 in * OpenSSL traditional PEM format ("BEGIN EC PRIVATE KEY") * OpenSSL PKCS#8 PEM format ("BEGIN PRIVATE KEY", "BEGIN ENCRYPTED PRIVATE KEY") * OpenSSH key format ("BEGIN OPENSSH PRIVATE KEY") * PuTTY private key format ("PuTTY-User-Key-File-2", "PuTTY-User-Key-File-3") * ED25519 in * OpenSSL PKCS#8 PEM format ("BEGIN PRIVATE KEY", "BEGIN ENCRYPTED PRIVATE KEY") * OpenSSH key format ("BEGIN OPENSSH PRIVATE KEY") * PuTTY private key format ("PuTTY-User-Key-File-2", "PuTTY-User-Key-File-3") Private keys in OpenSSL traditional PEM format can be encrypted using one of the following cipher methods: * DES-EDE3-CBC * DES-EDE3-CFB * AES-128-CBC * AES-192-CBC * AES-256-CBC 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: * 3des-cbc Private keys in OpenSSH key format can be encrypted using one of the following cipher methods: * 3des-cbc * aes128-cbc * aes192-cbc * aes256-cbc * aes128-ctr * aes192-ctr * aes256-ctr * aes128-gcm<span></span>@openssh.com * aes256-gcm<span></span>@openssh.com * chacha20-poly1305<span></span>@openssh.com Private keys in PuTTY private key format can be encrypted using the following cipher method: * aes256-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 OpenSSH certificate authentication is supported for all of the above, e.g. ssh-ed25519-cert-v01<span></span>@openssh.com. ## Message Authentication Code **SSH.NET** supports the following MAC algorithms: * hmac-sha2-256 * hmac-sha2-512 * hmac-sha1 * hmac-sha2-256-etm<span></span>@openssh.com * hmac-sha2-512-etm<span></span>@openssh.com * hmac-sha1-etm<span></span>@openssh.com ## Compression **SSH.NET** supports the following compression algorithms: * none (default) * zlib<span></span>@openssh.com ## Framework Support **SSH.NET** supports the following target frameworks: * .NETFramework 4.6.2 (and higher) * .NET Standard 2.0 * .NET 8 (and higher) ## Building the library The library has no special requirements to build, other than an up-to-date .NET SDK. See also [CONTRIBUTING.md](https://github.com/sshnet/SSH.NET/blob/develop/CONTRIBUTING.md). ## Using Pre-Release NuGet Packages Pre-release NuGet packages are published from the `develop` branch to the [GitHub NuGet Registry](https://github.com/sshnet/SSH.NET/pkgs/nuget/SSH.NET). 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](https://github.com/sshnet/SSH.NET/pkgs/nuget/SSH.NET). ## 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](https://github.com/sponsors/sshnet) through GitHub Sponsors. ", Assign "at most 3 tags" to the expected json: {"id":"5923","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"