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

---

API Differences between 2024.0.0 and 2016.1.0

262 Additions 54 Removals

Renci.SshNet

• public abstract class BaseClient : IBaseClient, IDisposable
  • public event EventHandler<SshIdentificationEventArgs> ServerIdentificationReceived
  • public Task ConnectAsync(CancellationToken cancellationToken)
• public class ConnectionInfo : IConnectionInfoInternal, IConnectionInfo
  • public TimeSpan ChannelCloseTimeout { get; set; }
  • public IDictionary<string, Type> CompressionAlgorithms { get; }
  • public IDictionary<string, Func<Compressor>> CompressionAlgorithms { get; }
  • public IDictionary<string, Type> KeyExchangeAlgorithms { get; }
  • public IDictionary<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
  • ConnectionInfo ConnectionInfo { get; }
  • bool IsConnected { get; }
  • TimeSpan KeepAliveInterval { get; set; }
  • event EventHandler<ExceptionEventArgs> ErrorOccurred
  • event EventHandler<HostKeyEventArgs> HostKeyReceived
  • void Connect()
  • Task ConnectAsync(CancellationToken cancellationToken)
  • void Disconnect()
  • void SendKeepAlive()
• public interface IPrivateKeySource
  • IReadOnlyCollection<HostAlgorithm> HostKeyAlgorithms { get; }
• public interface ISftpClient : IBaseClient, IDisposable
  • uint BufferSize { get; set; }
  • TimeSpan OperationTimeout { get; set; }
  • int ProtocolVersion { get; }
  • string WorkingDirectory { get; }
  • void AppendAllLines(string path, IEnumerable<string> contents)
  • void AppendAllLines(string path, IEnumerable<string> contents, Encoding encoding)
  • void AppendAllText(string path, string contents)
  • void AppendAllText(string path, string contents, Encoding encoding)
  • StreamWriter AppendText(string path)
  • StreamWriter AppendText(string path, Encoding encoding)
  • IAsyncResult BeginDownloadFile(string path, Stream output)
  • IAsyncResult BeginDownloadFile(string path, Stream output, AsyncCallback asyncCallback)
  • IAsyncResult BeginDownloadFile(string path, Stream output, AsyncCallback asyncCallback, object state, Action<ulong> downloadCallback = null)
  • IAsyncResult BeginListDirectory(string path, AsyncCallback asyncCallback, object state, Action<int> listCallback = null)
  • IAsyncResult BeginSynchronizeDirectories(string sourcePath, string destinationPath, string searchPattern, AsyncCallback asyncCallback, object state)
  • IAsyncResult BeginUploadFile(Stream input, string path)
  • IAsyncResult BeginUploadFile(Stream input, string path, AsyncCallback asyncCallback)
  • IAsyncResult BeginUploadFile(Stream input, string path, AsyncCallback asyncCallback, object state, Action<ulong> uploadCallback = null)
  • IAsyncResult BeginUploadFile(Stream input, string path, bool canOverride, AsyncCallback asyncCallback, object state, Action<ulong> uploadCallback = null)
  • void ChangeDirectory(string path)
  • void ChangePermissions(string path, short mode)
  • SftpFileStream Create(string path)
  • SftpFileStream Create(string path, int bufferSize)
  • void CreateDirectory(string path)
  • StreamWriter CreateText(string path)
  • StreamWriter CreateText(string path, Encoding encoding)
  • void Delete(string path)
  • void DeleteDirectory(string path)
  • void DeleteFile(string path)
  • Task DeleteFileAsync(string path, CancellationToken cancellationToken)
  • void DownloadFile(string path, Stream output, Action<ulong> downloadCallback = null)
  • void EndDownloadFile(IAsyncResult asyncResult)
  • IEnumerable<ISftpFile> EndListDirectory(IAsyncResult asyncResult)
  • IEnumerable<FileInfo> EndSynchronizeDirectories(IAsyncResult asyncResult)
  • void EndUploadFile(IAsyncResult asyncResult)
  • bool Exists(string path)
  • ISftpFile Get(string path)
  • SftpFileAttributes GetAttributes(string path)
  • DateTime GetLastAccessTime(string path)
  • DateTime GetLastAccessTimeUtc(string path)
  • DateTime GetLastWriteTime(string path)
  • DateTime GetLastWriteTimeUtc(string path)
  • SftpFileSytemInformation GetStatus(string path)
  • Task<SftpFileSytemInformation> GetStatusAsync(string path, CancellationToken cancellationToken)
  • IEnumerable<ISftpFile> ListDirectory(string path, Action<int> listCallback = null)
  • IAsyncEnumerable<ISftpFile> ListDirectoryAsync(string path, CancellationToken cancellationToken)
  • SftpFileStream Open(string path, FileMode mode)
  • SftpFileStream Open(string path, FileMode mode, FileAccess access)
  • Task<SftpFileStream> OpenAsync(string path, FileMode mode, FileAccess access, CancellationToken cancellationToken)
  • SftpFileStream OpenRead(string path)
  • StreamReader OpenText(string path)
  • SftpFileStream OpenWrite(string path)
  • byte[] ReadAllBytes(string path)
  • string[] ReadAllLines(string path)
  • string[] ReadAllLines(string path, Encoding encoding)
  • string ReadAllText(string path)
  • string ReadAllText(string path, Encoding encoding)
  • IEnumerable<string> ReadLines(string path)
  • IEnumerable<string> ReadLines(string path, Encoding encoding)
  • void RenameFile(string oldPath, string newPath)
  • void RenameFile(string oldPath, string newPath, bool isPosix)
  • Task RenameFileAsync(string oldPath, string newPath, CancellationToken cancellationToken)
  • void SetAttributes(string path, SftpFileAttributes fileAttributes)
  • void SetLastAccessTime(string path, DateTime lastAccessTime)
  • void SetLastAccessTimeUtc(string path, DateTime lastAccessTimeUtc)
  • void SetLastWriteTime(string path, DateTime lastWriteTime)
  • void SetLastWriteTimeUtc(string path, DateTime lastWriteTimeUtc)
  • void SymbolicLink(string path, string linkPath)
  • IEnumerable<FileInfo> SynchronizeDirectories(string sourcePath, string destinationPath, string searchPattern)
  • void UploadFile(Stream input, string path, Action<ulong> uploadCallback = null)
  • void UploadFile(Stream input, string path, bool canOverride, Action<ulong> uploadCallback = null)
  • void WriteAllBytes(string path, byte[] bytes)
  • void WriteAllLines(string path, IEnumerable<string> contents)
  • void WriteAllLines(string path, IEnumerable<string> contents, Encoding encoding)
  • void WriteAllLines(string path, string[] contents)
  • void WriteAllLines(string path, string[] contents, Encoding encoding)
  • void WriteAllText(string path, string contents)
  • void WriteAllText(string path, string contents, Encoding encoding)
• public class NetConfClient : BaseClient
  • public NetConfClient(string host, int port, string username, PrivateKeyFile[] keyFiles)
  • public NetConfClient(string host, string username, PrivateKeyFile[] keyFiles)
  • public NetConfClient(string host, int port, string username, IPrivateKeySource[] keyFiles)
  • public NetConfClient(string host, string username, IPrivateKeySource[] keyFiles)
• public class PrivateKeyAuthenticationMethod : AuthenticationMethod, IDisposable
  • public ICollection<PrivateKeyFile> KeyFiles { get; }
  • public PrivateKeyAuthenticationMethod(string username, PrivateKeyFile[] keyFiles)
  • public ICollection<IPrivateKeySource> KeyFiles { get; }
  • public PrivateKeyAuthenticationMethod(string username, IPrivateKeySource[] keyFiles)
• public class PrivateKeyConnectionInfo : ConnectionInfo, IDisposable
  • public ICollection<PrivateKeyFile> KeyFiles { get; }
  • public ICollection<IPrivateKeySource> KeyFiles { get; }
  • public PrivateKeyConnectionInfo(string host, int port, string username, PrivateKeyFile[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, int port, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, PrivateKeyFile[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, int port, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, PrivateKeyFile[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, PrivateKeyFile[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, PrivateKeyFile[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword, PrivateKeyFile[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, int port, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword, PrivateKeyFile[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, int port, string username, IPrivateKeySource[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, int port, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, IPrivateKeySource[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, int port, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, IPrivateKeySource[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, IPrivateKeySource[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, IPrivateKeySource[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword, IPrivateKeySource[] keyFiles)
  • public PrivateKeyConnectionInfo(string host, int port, string username, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword, IPrivateKeySource[] keyFiles)
• public class PrivateKeyFile : IPrivateKeySource, IDisposable
  • public HostAlgorithm HostKey { get; }
  • public IReadOnlyCollection<HostAlgorithm> HostKeyAlgorithms { get; }
  • public Key Key { get; }
  • public PrivateKeyFile(Key key)
• public class ScpClient : BaseClient
  • public ScpClient(string host, int port, string username, PrivateKeyFile[] keyFiles)
  • public ScpClient(string host, string username, PrivateKeyFile[] keyFiles)
  • public void Download(string filename, Stream destination)
  • public ScpClient(string host, int port, string username, IPrivateKeySource[] keyFiles)
  • public ScpClient(string host, string username, IPrivateKeySource[] keyFiles)
  • 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 Task ConnectAsync(CancellationToken cancellationToken)
• public class SftpClient : BaseClient, ISftpClient, IBaseClient, IDisposable
  • public SftpClient(string host, int port, string username, PrivateKeyFile[] keyFiles)
  • public SftpClient(string host, string username, PrivateKeyFile[] keyFiles)
  • public SftpClient(string host, int port, string username, IPrivateKeySource[] keyFiles)
  • public SftpClient(string host, string username, IPrivateKeySource[] keyFiles)
  • public Task DeleteFileAsync(string path, CancellationToken cancellationToken)
  • public IEnumerable<SftpFile> EndListDirectory(IAsyncResult asyncResult)
  • public IEnumerable<ISftpFile> EndListDirectory(IAsyncResult asyncResult)
  • public SftpFile Get(string path)
  • public ISftpFile Get(string path)
  • public IEnumerable<SftpFile> ListDirectory(string path, Action<int> listCallback = null)
  • public Task<SftpFileSytemInformation> GetStatusAsync(string path, CancellationToken cancellationToken)
  • public IEnumerable<ISftpFile> ListDirectory(string path, Action<int> listCallback = null)
  • public IAsyncEnumerable<ISftpFile> ListDirectoryAsync(string path, CancellationToken cancellationToken)
  • public Task<SftpFileStream> OpenAsync(string path, FileMode mode, FileAccess access, CancellationToken cancellationToken)
  • public Task RenameFileAsync(string oldPath, string newPath, 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
  • public SshClient(string host, int port, string username, PrivateKeyFile[] keyFiles)
  • public SshClient(string host, string username, PrivateKeyFile[] keyFiles)
  • public SshClient(string host, int port, string username, IPrivateKeySource[] keyFiles)
  • public SshClient(string host, string username, IPrivateKeySource[] keyFiles)
• public class SshCommand : IDisposable
  • public Stream CreateInputStream()

Renci.SshNet.Abstractions

• public static class DiagnosticAbstraction
  • public static readonly TraceSource Source
  • public static void Log(string text, TraceEventType type = 16)

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 class DerData
  • public DerData(byte[] data)
  • public DerData(byte[] data, bool construct = false)
  • public byte[] ReadBitString()
  • public byte ReadByte()
  • public byte[] ReadBytes(int length)
  • public int ReadLength()
  • public byte[] ReadObject()
  • public byte[] ReadOctetString()
  • public void WriteBitstring(byte[] data)
  • public void WriteBytes(IEnumerable<byte> data)
  • public void WriteObjectIdentifier(byte[] bytes)
• public class HostKeyEventArgs : EventArgs
  • public string FingerPrintMD5 { get; }
  • public string FingerPrintSHA256 { get; }
• 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()
• public class SshDataStream : MemoryStream
  • public ushort ReadUInt16()
• public class SshIdentificationEventArgs : EventArgs
  • public SshIdentification SshIdentification { get; }
  • public SshIdentificationEventArgs(SshIdentification sshIdentification)
• public enum TerminalModes
  • IUTF8 = 42

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 KeyExchangeDhReplyMessage : Message
  • public BigInteger F { get; }
  • public byte[] F { get; }
• public class KeyExchangeEcdhReplyMessage : Message
  • public byte[] KS { get; }
  • public byte[] QS { get; }
  • public byte[] Signature { get; }
  • public KeyExchangeEcdhReplyMessage()

Renci.SshNet.Security

• public class DsaKey : Key, IDisposable
  • public DsaKey()
  • public DsaKey(SshKeyData publicKeyData)
• public class EcdsaKey : Key, IDisposable
  • public ECDsa Ecdsa { get; }
  • public HashAlgorithmName HashAlgorithm { get; }
  • public byte[] PrivateKey { get; }
  • public EcdsaKey(SshKeyData publicKeyData)
  • public EcdsaKey(string curve, byte[] publickey, byte[] privatekey)
  • public EcdsaKey(byte[] data)
  • public void Dispose()
  • protected virtual void Dispose(bool disposing)
• public class ED25519Key : Key, IDisposable
  • public byte[] PrivateKey { get; }
  • public byte[] PublicKey { get; }
  • public ED25519Key(SshKeyData publicKeyData)
  • public ED25519Key(byte[] privateKeyData)
  • public void Dispose()
  • protected virtual void Dispose(bool disposing)
• public interface IKeyExchange : IDisposable
  • HashAlgorithm CreateClientHash()
  • HashAlgorithm CreateClientHash(out bool isEncryptThenMAC)
  • HashAlgorithm CreateServerHash()
  • 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
  • protected abstract DigitalSignature DigitalSignature { get; }
  • public string Comment { get; set; }
  • protected Key(byte[] data)
• public abstract class KeyExchange : Algorithm, IKeyExchange, IDisposable
  • public BigInteger SharedKey { get; protected set; }
  • public byte[] SharedKey { get; protected set; }
  • public HashAlgorithm CreateClientHash()
  • public HashAlgorithm CreateClientHash(out bool isEncryptThenMAC)
  • public HashAlgorithm CreateServerHash()
  • 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 DigitalSignature DigitalSignature { get; }
  • public KeyHostAlgorithm(string name, Key key, byte[] data)
  • public KeyHostAlgorithm(string name, Key key, DigitalSignature digitalSignature)
• public class RsaKey : Key, IDisposable
  • public RsaKey()
  • public RsaKey(SshKeyData publicKeyData)
• 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 class EcdsaDigitalSignature : DigitalSignature, IDisposable
  • public EcdsaDigitalSignature(EcdsaKey key)
  • public void Dispose()
  • protected virtual void Dispose(bool disposing)
• public class ED25519DigitalSignature : DigitalSignature, IDisposable
  • public ED25519DigitalSignature(ED25519Key key)
  • public void Dispose()
  • protected virtual void Dispose(bool disposing)
• public class RsaDigitalSignature : CipherDigitalSignature, IDisposable
  • public RsaDigitalSignature(RsaKey rsaKey, HashAlgorithmName hashAlgorithmName)

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(bool disposing)
  • public void Dispose()
• public enum AesCipherMode
  • CBC = 1
  • CFB = 4
  • CTR = 6
  • CTS = 5
  • ECB = 2
  • OFB = 3

Renci.SshNet.Sftp

• public interface ISftpFile
  • SftpFileAttributes Attributes { get; }
  • string FullName { get; }
  • bool GroupCanExecute { get; set; }
  • bool GroupCanRead { get; set; }
  • bool GroupCanWrite { get; set; }
  • int GroupId { get; set; }
  • bool IsBlockDevice { get; }
  • bool IsCharacterDevice { get; }
  • bool IsDirectory { get; }
  • bool IsNamedPipe { get; }
  • bool IsRegularFile { get; }
  • bool IsSocket { get; }
  • bool IsSymbolicLink { get; }
  • DateTime LastAccessTime { get; set; }
  • DateTime LastAccessTimeUtc { get; set; }
  • DateTime LastWriteTime { get; set; }
  • DateTime LastWriteTimeUtc { get; set; }
  • long Length { get; }
  • string Name { get; }
  • bool OthersCanExecute { get; set; }
  • bool OthersCanRead { get; set; }
  • bool OthersCanWrite { get; set; }
  • bool OwnerCanExecute { get; set; }
  • bool OwnerCanRead { get; set; }
  • bool OwnerCanWrite { get; set; }
  • int UserId { get; set; }
  • void Delete()
  • void MoveTo(string destFileName)
  • void SetPermissions(short mode)
  • void UpdateStatus()
• public class SftpFileAttributes
  • public DateTime LastAccessTimeUtc { get; set; }
  • public DateTime LastWriteTimeUtc { get; set; }