<PackageReference Include="SSH.NET" Version="2025.0.0" />

---

API Differences between 2025.0.0 and 2023.0.0

204 Additions 107 Removals

Renci.SshNet

• public abstract class AuthenticationMethod : IAuthenticationMethod, IDisposable
  • protected virtual void Dispose(bool disposing)
  • public void Dispose()
• public abstract class BaseClient : IBaseClient, IDisposable
  • public event EventHandler<SshIdentificationEventArgs> ServerIdentificationReceived
• public class CipherInfo
  • public bool IsAead { get; }
  • public CipherInfo(int keySize, Func<byte[], byte[], Cipher> cipher)
  • public CipherInfo(int keySize, Func<byte[], byte[], Cipher> cipher, bool isAead = false)
• public class CommandAsyncResult : IAsyncResult
• public class ConnectionInfo : IConnectionInfoInternal, IConnectionInfo
  • public IDictionary<string, Type> CompressionAlgorithms { get; }
  • public IOrderedDictionary<string, Func<Compressor>> CompressionAlgorithms { get; }
  • public IDictionary<string, CipherInfo> Encryptions { get; }
  • public IDictionary<string, HashInfo> HmacAlgorithms { get; }
  • public IOrderedDictionary<string, CipherInfo> Encryptions { get; }
  • public IOrderedDictionary<string, HashInfo> HmacAlgorithms { get; }
  • public IDictionary<string, Func<byte[], KeyHostAlgorithm>> HostKeyAlgorithms { get; }
  • public IOrderedDictionary<string, Func<byte[], KeyHostAlgorithm>> HostKeyAlgorithms { get; }
  • public IDictionary<string, Type> KeyExchangeAlgorithms { get; }
  • public IOrderedDictionary<string, Func<IKeyExchange>> KeyExchangeAlgorithms { get; }
• public class ExpectAsyncResult : AsyncResult<string>
• public abstract class ForwardedPort : IForwardedPort, IDisposable
  • public event EventHandler Closing
  • public void Dispose()
• public class ForwardedPortDynamic : ForwardedPort
  • public void Dispose()
• public class ForwardedPortLocal : ForwardedPort
  • public void Dispose()
• public class ForwardedPortRemote : ForwardedPort
  • public void Dispose()
• public class HashInfo
  • public bool IsEncryptThenMAC { get; }
  • public HashInfo(int keySize, Func<byte[], HashAlgorithm> hash)
  • public HashInfo(int keySize, Func<byte[], HashAlgorithm> hash, bool isEncryptThenMAC = false)
• public interface IBaseClient : IDisposable
  • event EventHandler<SshIdentificationEventArgs> ServerIdentificationReceived
  • void Dispose()
• public interface IOrderedDictionary<TKey, TValue> : IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable, IReadOnlyDictionary<TKey, TValue>, IReadOnlyCollection<KeyValuePair<TKey, TValue>>
  • int Count { get; }
  • TValue this[TKey key] { get; set; }
  • ICollection<TKey> Keys { get; }
  • ICollection<TValue> Values { get; }
  • bool ContainsKey(TKey key)
  • bool ContainsValue(TValue value)
  • KeyValuePair<TKey, TValue> GetAt(int index)
  • int IndexOf(TKey key)
  • void Insert(int index, TKey key, TValue value)
  • bool Remove(TKey key, out TValue value)
  • void RemoveAt(int index)
  • void SetAt(int index, TKey key, TValue value)
  • void SetAt(int index, TValue value)
  • void SetPosition(int index, int newIndex)
  • void SetPosition(TKey key, int newIndex)
  • bool TryAdd(TKey key, TValue value)
  • bool TryAdd(TKey key, TValue value, out int index)
  • bool TryGetValue(TKey key, out TValue value)
  • bool TryGetValue(TKey key, out TValue value, out int index)
• public interface ISftpClient : IBaseClient, IDisposable
  • Task ChangeDirectoryAsync(string path, CancellationToken cancellationToken = default)
  • Task CreateDirectoryAsync(string path, CancellationToken cancellationToken = default)
  • Task DeleteAsync(string path, CancellationToken cancellationToken = default)
  • Task DeleteDirectoryAsync(string path, CancellationToken cancellationToken = default)
  • Task<bool> ExistsAsync(string path, CancellationToken cancellationToken = default)
  • Task<ISftpFile> GetAsync(string path, CancellationToken cancellationToken)
  • SftpFileSytemInformation GetStatus(string path)
  • Task<SftpFileSytemInformation> GetStatusAsync(string path, CancellationToken cancellationToken)
  • SftpFileSystemInformation GetStatus(string path)
  • Task<SftpFileSystemInformation> GetStatusAsync(string path, CancellationToken cancellationToken)
• public interface ISshClient : IBaseClient, IDisposable
  • IEnumerable<ForwardedPort> ForwardedPorts { get; }
  • void AddForwardedPort(ForwardedPort port)
  • SshCommand CreateCommand(string commandText)
  • SshCommand CreateCommand(string commandText, Encoding encoding)
  • Shell CreateShell(Stream input, Stream output, Stream extendedOutput, string terminalName, uint columns, uint rows, uint width, uint height, IDictionary<TerminalModes, uint> terminalModes, int bufferSize)
  • Shell CreateShell(Stream input, Stream output, Stream extendedOutput, string terminalName, uint columns, uint rows, uint width, uint height, IDictionary<TerminalModes, uint> terminalModes)
  • Shell CreateShell(Stream input, Stream output, Stream extendedOutput)
  • Shell CreateShell(Encoding encoding, string input, Stream output, Stream extendedOutput, string terminalName, uint columns, uint rows, uint width, uint height, IDictionary<TerminalModes, uint> terminalModes, int bufferSize)
  • Shell CreateShell(Encoding encoding, string input, Stream output, Stream extendedOutput, string terminalName, uint columns, uint rows, uint width, uint height, IDictionary<TerminalModes, uint> terminalModes)
  • Shell CreateShell(Encoding encoding, string input, Stream output, Stream extendedOutput)
  • Shell CreateShellNoTerminal(Stream input, Stream output, Stream extendedOutput, int bufferSize = -1)
  • ShellStream CreateShellStream(string terminalName, uint columns, uint rows, uint width, uint height, int bufferSize)
  • ShellStream CreateShellStream(string terminalName, uint columns, uint rows, uint width, uint height, int bufferSize, IDictionary<TerminalModes, uint> terminalModeValues)
  • ShellStream CreateShellStreamNoTerminal(int bufferSize = -1)
  • void RemoveForwardedPort(ForwardedPort port)
  • SshCommand RunCommand(string commandText)
• public class KeyboardInteractiveAuthenticationMethod : AuthenticationMethod
  • public void Dispose()
  • protected virtual void Dispose(bool disposing)
• public class NoneAuthenticationMethod : AuthenticationMethod
  • public void Dispose()
  • protected virtual void Dispose(bool disposing)
• public class PasswordAuthenticationMethod : AuthenticationMethod
  • public void Dispose()
  • protected virtual void Dispose(bool disposing)
• public class PrivateKeyAuthenticationMethod : AuthenticationMethod
  • public void Dispose()
  • protected virtual void Dispose(bool disposing)
• public class PrivateKeyConnectionInfo : ConnectionInfo, IDisposable
  • public PrivateKeyConnectionInfo(string host, string username, PrivateKeyFile[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, string username, IPrivateKeySource[] keyFiles)
• public class PrivateKeyFile : IPrivateKeySource, IDisposable
  • public Certificate Certificate { get; }
  • public PrivateKeyFile(string fileName, string passPhrase, string certificateFileName)
  • public PrivateKeyFile(Stream privateKey, string passPhrase, Stream certificate)
• public class ScpClient : BaseClient
  • public void Download(string filename, Stream destination)
  • public void Download(string filename, Stream destination)
• public class Session : ISession, IDisposable
  • public SemaphoreLight SessionSemaphore { get; }
  • public SemaphoreSlim SessionSemaphore { get; }
  • public event EventHandler<SshIdentificationEventArgs> ServerIdentificationReceived
• public class SftpClient : BaseClient, ISftpClient, IBaseClient, IDisposable
  • public Task ChangeDirectoryAsync(string path, CancellationToken cancellationToken = default)
  • public Task CreateDirectoryAsync(string path, CancellationToken cancellationToken = default)
  • public Task DeleteAsync(string path, CancellationToken cancellationToken = default)
  • public Task DeleteDirectoryAsync(string path, CancellationToken cancellationToken = default)
  • public Task<bool> ExistsAsync(string path, CancellationToken cancellationToken = default)
  • public Task<ISftpFile> GetAsync(string path, CancellationToken cancellationToken)
  • public SftpFileSytemInformation GetStatus(string path)
  • public Task<SftpFileSytemInformation> GetStatusAsync(string path, CancellationToken cancellationToken)
  • public SftpFileSystemInformation GetStatus(string path)
  • public Task<SftpFileSystemInformation> GetStatusAsync(string path, CancellationToken cancellationToken)
• public class ShellStream : Stream
  • public event EventHandler<EventArgs> Closed
  • public IAsyncResult BeginExpect(TimeSpan timeout, int lookback, AsyncCallback callback, object state, ExpectAction[] expectActions)
  • public void Expect(TimeSpan timeout, int lookback, ExpectAction[] expectActions)
  • public string Expect(string text, TimeSpan timeout)
  • public string Expect(string text, TimeSpan timeout, int lookback = -1)
  • public string Expect(Regex regex, TimeSpan timeout)
  • public string Expect(Regex regex, TimeSpan timeout, int lookback = -1)
• public class SshClient : BaseClient, ISshClient, IBaseClient, IDisposable
  • public Shell CreateShellNoTerminal(Stream input, Stream output, Stream extendedOutput, int bufferSize = -1)
  • public ShellStream CreateShellStreamNoTerminal(int bufferSize = -1)
• public class SshCommand : IDisposable
  • public int ExitStatus { get; }
  • public string ExitSignal { get; }
  • public int? ExitStatus { get; }
  • public void CancelAsync()
  • public void CancelAsync(bool forceKill = false, int millisecondsTimeout = 500)
  • public Stream CreateInputStream()
  • public Task ExecuteAsync(CancellationToken cancellationToken = default)
• public static class SshNetLoggingConfiguration
  • public static void InitializeLogging(ILoggerFactory loggerFactory)

Renci.SshNet.Common

• public class AuthenticationPromptEventArgs : AuthenticationEventArgs
  • public IEnumerable<AuthenticationPrompt> Prompts { get; }
  • public AuthenticationPromptEventArgs(string username, string instruction, string language, IEnumerable<AuthenticationPrompt> prompts)
  • public IReadOnlyList<AuthenticationPrompt> Prompts { get; }
  • public AuthenticationPromptEventArgs(string username, string instruction, string language, IReadOnlyList<AuthenticationPrompt> prompts)
• public struct BigInteger : IComparable, IFormattable, IComparable<BigInteger>, IEquatable<BigInteger>
• public class DerData
• public class HostKeyEventArgs : EventArgs
  • public Certificate Certificate { get; }
• public struct ObjectIdentifier
• public class PipeStream : Stream
  • public bool BlockLastReadBuffer { get; set; }
  • public long MaxBufferLength { get; set; }
• public class SemaphoreLight : IDisposable
• public class SshConnectionException : SshException
  • public SshConnectionException(string message, Exception inner)
• public abstract class SshData
  • protected IDictionary<string, string> ReadExtensionPair()
  • protected Dictionary<string, string> ReadExtensionPair()
  • protected void Write(BigInteger data)
  • protected void Write(BigInteger data)
• public class SshDataStream : MemoryStream
  • public BigInteger ReadBigInt()
  • public BigInteger ReadBigInt()
  • public ushort ReadUInt16()
  • public void Write(BigInteger data)
  • public void Write(BigInteger data)
• public class SshIdentificationEventArgs : EventArgs
  • public SshIdentification SshIdentification { get; }
  • public SshIdentificationEventArgs(SshIdentification sshIdentification)

Renci.SshNet.Compression

• public enum CompressionMode
• public abstract class Compressor : Algorithm, IDisposable
  • protected bool IsActive { get; protected set; }
  • protected Session Session { get; }
  • protected Compressor()
  • protected Compressor(bool delayedCompression)
  • protected abstract byte[] CompressCore(byte[] data, int offset, int length)
  • protected abstract byte[] DecompressCore(byte[] data, int offset, int length)
• public class Zlib : Compressor
  • public Zlib()
  • protected Zlib(bool delayedCompression)
• public class ZlibStream

Renci.SshNet.Connection

• public sealed class SshIdentification
  • public string Comments { get; }
  • public string ProtocolVersion { get; }
  • public string SoftwareVersion { get; }
  • public SshIdentification(string protocolVersion, string softwareVersion)
  • public SshIdentification(string protocolVersion, string softwareVersion, string comments)

Renci.SshNet.Messages

• public abstract class Message : SshData
  • public abstract string MessageName { get; }
  • public abstract byte MessageNumber { get; }
• public sealed class MessageAttribute : Attribute

Renci.SshNet.Messages.Transport

• public class KeyExchangeDhGroupExchangeGroup : Message
  • public BigInteger SafePrime { get; }
  • public BigInteger SubGroup { get; }
  • public BigInteger SafePrime { get; }
  • public BigInteger SubGroup { get; }
• public class KeyExchangeHybridReplyMessage : Message
  • public byte[] KS { get; }
  • public byte[] Signature { get; }
  • public byte[] SReply { get; }
  • public KeyExchangeHybridReplyMessage()

Renci.SshNet.Security

• public class Certificate
  • public enum CertificateType
  • public byte[] CertificateAuthorityKey { get; }
  • public string CertificateAuthorityKeyFingerPrint { get; }
  • public IDictionary<string, string> CriticalOptions { get; }
  • public IDictionary<string, string> Extensions { get; }
  • public Key Key { get; }
  • public string KeyId { get; }
  • public string Name { get; }
  • public byte[] Nonce { get; }
  • public ulong Serial { get; }
  • public byte[] Signature { get; }
  • public CertificateType Type { get; }
  • public DateTimeOffset ValidAfter { get; }
  • public ulong ValidAfterUnixSeconds { get; }
  • public DateTimeOffset ValidBefore { get; }
  • public ulong ValidBeforeUnixSeconds { get; }
  • public IList<string> ValidPrincipals { get; }
  • public Certificate(byte[] data)
• public class CertificateHostAlgorithm : KeyHostAlgorithm
  • public CertificateHostAlgorithm(string name)
  • public Certificate Certificate { get; }
  • public CertificateHostAlgorithm(string name, Key privateKey, Certificate certificate)
  • public CertificateHostAlgorithm(string name, Key privateKey, Certificate certificate, DigitalSignature digitalSignature)
  • public CertificateHostAlgorithm(string name, Certificate certificate, IReadOnlyDictionary<string, Func<byte[], KeyHostAlgorithm>> keyAlgorithms)
  • public CertificateHostAlgorithm(string name, Certificate certificate, DigitalSignature digitalSignature, IReadOnlyDictionary<string, Func<byte[], KeyHostAlgorithm>> keyAlgorithms)
• public class DsaKey : Key, IDisposable
• public class EcdsaKey : Key, IDisposable
  • public EcdsaKey()
  • public EcdsaKey(SshKeyData publicKeyData)
• public class ED25519Key : Key, IDisposable
  • public ED25519Key()
  • public ED25519Key(SshKeyData publicKeyData)
  • public ED25519Key(byte[] pk, byte[] sk)
• public interface IKeyExchange : IDisposable
  • Cipher CreateClientCipher()
  • HashAlgorithm CreateClientHash()
  • Cipher CreateClientCipher(out bool isAead)
  • HashAlgorithm CreateClientHash(out bool isEncryptThenMAC)
  • Cipher CreateServerCipher()
  • HashAlgorithm CreateServerHash()
  • Cipher CreateServerCipher(out bool isAead)
  • HashAlgorithm CreateServerHash(out bool isEncryptThenMAC)
  • void Start(Session session, KeyExchangeInitMessage message)
  • void Start(Session session, KeyExchangeInitMessage message, bool sendClientInitMessage)
• public abstract class Key
  • protected BigInteger[] _privateKey
  • public abstract BigInteger[] Public { get; set; }
  • protected Key(byte[] data)
  • public abstract BigInteger[] Public { get; }
• public abstract class KeyExchange : Algorithm, IKeyExchange, IDisposable
  • public Cipher CreateClientCipher()
  • public HashAlgorithm CreateClientHash()
  • public Cipher CreateClientCipher(out bool isAead)
  • public HashAlgorithm CreateClientHash(out bool isEncryptThenMAC)
  • public Cipher CreateServerCipher()
  • public HashAlgorithm CreateServerHash()
  • public Cipher CreateServerCipher(out bool isAead)
  • public HashAlgorithm CreateServerHash(out bool isEncryptThenMAC)
  • public virtual void Start(Session session, KeyExchangeInitMessage message)
  • public virtual void Start(Session session, KeyExchangeInitMessage message, bool sendClientInitMessage)
• public class KeyHostAlgorithm : HostAlgorithm
  • public KeyHostAlgorithm(string name, Key key, byte[] data)
  • public KeyHostAlgorithm(string name, Key key, byte[] data, DigitalSignature digitalSignature)
• public class RsaKey : Key, IDisposable
  • public BigInteger D { get; }
  • public BigInteger DP { get; }
  • public BigInteger DQ { get; }
  • public BigInteger Exponent { get; }
  • public BigInteger InverseQ { get; }
  • public BigInteger Modulus { get; }
  • public BigInteger P { get; }
  • public BigInteger Q { get; }
  • public RsaKey()
  • public BigInteger D { get; }
  • public BigInteger DP { get; }
  • public BigInteger DQ { get; }
  • public BigInteger Exponent { get; }
  • public BigInteger InverseQ { get; }
  • public BigInteger Modulus { get; }
  • public BigInteger P { get; }
  • public BigInteger Q { get; }
  • public RsaKey(SshKeyData publicKeyData)
  • public RsaKey(BigInteger modulus, BigInteger exponent, BigInteger d, BigInteger p, BigInteger q, BigInteger inverseQ)
  • public RsaKey(BigInteger modulus, BigInteger exponent, BigInteger d, BigInteger p, BigInteger q, BigInteger inverseQ)
• public sealed class SshKeyData : SshData
  • public BigInteger[] Keys { get; }
  • public string Name { get; }
  • public SshKeyData(byte[] data)
  • public SshKeyData(string name, BigInteger[] keys)

Renci.SshNet.Security.Cryptography

• public abstract class AsymmetricCipher : Cipher
• public abstract class BlockCipher : SymmetricCipher
  • protected BlockCipher(byte[] key, byte blockSize, CipherMode mode, CipherPadding padding)
  • protected BlockCipher(byte[] key, byte blockSize, CipherMode mode, IBlockCipherPadding padding)
  • public abstract int DecryptBlock(byte[] inputBuffer, int inputOffset, int inputCount, byte[] outputBuffer, int outputOffset)
  • public abstract int EncryptBlock(byte[] inputBuffer, int inputOffset, int inputCount, byte[] outputBuffer, int outputOffset)
• public abstract class Cipher
  • public virtual int TagSize { get; }
• public abstract class CipherDigitalSignature : DigitalSignature
• public class DsaDigitalSignature : DigitalSignature, IDisposable
• public class HMACMD5 : HMACMD5
• public class HMACSHA1 : HMACSHA1
• public class HMACSHA256 : HMACSHA256
• public class HMACSHA384 : HMACSHA384
• public class HMACSHA512 : HMACSHA512
• public abstract class StreamCipher : SymmetricCipher
• public abstract class SymmetricCipher : Cipher
  • public abstract int DecryptBlock(byte[] inputBuffer, int inputOffset, int inputCount, byte[] outputBuffer, int outputOffset)
  • public abstract int EncryptBlock(byte[] inputBuffer, int inputOffset, int inputCount, byte[] outputBuffer, int outputOffset)

Renci.SshNet.Security.Cryptography.Ciphers

• public sealed class AesCipher : BlockCipher, IDisposable
  • public AesCipher(byte[] key, CipherMode mode, CipherPadding padding)
  • public AesCipher(byte[] key, byte[] iv, AesCipherMode mode, bool pkcs7Padding = false)
  • public void Dispose()
• public sealed class Arc4Cipher : StreamCipher
• public sealed class BlowfishCipher : BlockCipher
• public sealed class CastCipher : BlockCipher
• public enum AesCipherMode
  • CBC = 1
  • CFB = 4
  • CTR = 6
  • CTS = 5
  • ECB = 2
  • OFB = 3
• public abstract class CipherPadding
• public class DesCipher : BlockCipher
• public class RsaCipher : AsymmetricCipher
• public sealed class SerpentCipher : BlockCipher
• public sealed class TripleDesCipher : BlockCipher, IDisposable
  • public TripleDesCipher(byte[] key, CipherMode mode, CipherPadding padding)
  • public TripleDesCipher(byte[] key, byte[] iv, CipherMode mode, bool pkcs7Padding)
  • public void Dispose()
• public sealed class TwofishCipher : BlockCipher

Renci.SshNet.Security.Cryptography.Ciphers.Paddings

• public class PKCS5Padding : CipherPadding
• public class PKCS7Padding : CipherPadding

Renci.SshNet.Sftp

• public interface ISftpFile
  • Task DeleteAsync(CancellationToken cancellationToken = default)
• public sealed class SftpFile : ISftpFile
  • public Task DeleteAsync(CancellationToken cancellationToken = default)
• public class SftpFileSytemInformation
• public class SftpFileSystemInformation
  • public ulong AvailableBlocks { get; }
  • public ulong AvailableNodes { get; }
  • public ulong BlockSize { get; }
  • public ulong FileSystemBlockSize { get; }
  • public ulong FreeBlocks { get; }
  • public ulong FreeNodes { get; }
  • public bool IsReadOnly { get; }
  • public ulong MaxNameLenght { get; }
  • public ulong Sid { get; }
  • public bool SupportsSetUid { get; }
  • public ulong TotalBlocks { get; }
  • public ulong TotalNodes { get; }