<PackageReference Include="SSH.NET" Version="2016.1.0-beta3" />

---

API Differences between 2016.1.0-beta3 and 2024.1.0

142 Additions 121 Removals

Renci.SshNet

• public abstract class BaseClient : IDisposable
  • public event EventHandler<SshIdentificationEventArgs> ServerIdentificationReceived
  • public Task ConnectAsync(CancellationToken cancellationToken)
• public class CipherInfo
  • public bool IsAead { get; }
  • public CipherInfo(int keySize, Func<byte[], byte[], Cipher> cipher, bool isAead = false)
  • public CipherInfo(int keySize, Func<byte[], byte[], Cipher> cipher)
• public class CommandAsyncResult : IAsyncResult
  • public object AsyncState { get; }
  • public WaitHandle AsyncWaitHandle { get; }
  • public int BytesReceived { get; set; }
  • public int BytesSent { get; set; }
  • public bool CompletedSynchronously { get; }
  • public bool IsCompleted { get; }
• public class ConnectionInfo : IConnectionInfoInternal, IConnectionInfo
  • public TimeSpan ChannelCloseTimeout { get; set; }
  • public IDictionary<string, Func<Compressor>> CompressionAlgorithms { get; }
  • public IDictionary<string, Type> CompressionAlgorithms { get; }
  • public IDictionary<string, Func<IKeyExchange>> KeyExchangeAlgorithms { get; }
  • public IDictionary<string, Type> KeyExchangeAlgorithms { get; }
• public class ExpectAsyncResult : AsyncResult<string>
• public abstract class ForwardedPort : IForwardedPort
  • public event EventHandler Closing
  • public void Dispose()
• public class ForwardedPortDynamic : ForwardedPort
  • public void Dispose()
• public class ForwardedPortLocal : ForwardedPort, IDisposable
  • public void Dispose()
• public class ForwardedPortRemote : ForwardedPort, IDisposable
  • public void Dispose()
• public class HashInfo
  • public bool IsEncryptThenMAC { get; }
  • public HashInfo(int keySize, Func<byte[], HashAlgorithm> hash, bool isEncryptThenMAC = false)
  • public HashInfo(int keySize, Func<byte[], HashAlgorithm> hash)
• public interface IBaseClient : IDisposable
• public interface IPrivateKeySource
• public interface ISftpClient : IBaseClient, IDisposable
• public class NetConfClient : BaseClient
  • public NetConfClient(string host, int port, string username, IPrivateKeySource[] keyFiles)
  • public NetConfClient(string host, string username, IPrivateKeySource[] keyFiles)
  • public NetConfClient(string host, int port, string username, PrivateKeyFile[] keyFiles)
  • public NetConfClient(string host, string username, PrivateKeyFile[] keyFiles)
• public class PrivateKeyAuthenticationMethod : AuthenticationMethod, IDisposable
  • public ICollection<IPrivateKeySource> KeyFiles { get; }
  • public PrivateKeyAuthenticationMethod(string username, IPrivateKeySource[] keyFiles)
  • public ICollection<PrivateKeyFile> KeyFiles { get; }
  • public PrivateKeyAuthenticationMethod(string username, PrivateKeyFile[] keyFiles)
• public class PrivateKeyConnectionInfo : ConnectionInfo, IDisposable
  • public ICollection<IPrivateKeySource> KeyFiles { get; }
  • public ICollection<PrivateKeyFile> KeyFiles { get; }
  • 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 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 class PrivateKeyFile : IDisposable
  • public IReadOnlyCollection<HostAlgorithm> HostKeyAlgorithms { get; }
  • public Key Key { get; }
  • public PrivateKeyFile(Key key)
  • public HostAlgorithm HostKey { get; }
• public class ScpClient : BaseClient
  • public ScpClient(string host, int port, string username, IPrivateKeySource[] keyFiles)
  • public ScpClient(string host, string username, IPrivateKeySource[] keyFiles)
  • 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 void Download(string filename, Stream destination)
• public class Session : ISession, IDisposable
  • public SemaphoreSlim SessionSemaphore { get; }
  • public SemaphoreLight SessionSemaphore { get; }
  • public event EventHandler<SshIdentificationEventArgs> ServerIdentificationReceived
  • public Task ConnectAsync(CancellationToken cancellationToken)
• public class SftpClient : BaseClient
  • public SftpClient(string host, int port, string username, IPrivateKeySource[] keyFiles)
  • public SftpClient(string host, string username, IPrivateKeySource[] keyFiles)
  • public SftpClient(string host, int port, string username, PrivateKeyFile[] keyFiles)
  • public SftpClient(string host, string username, PrivateKeyFile[] keyFiles)
  • public Task DeleteFileAsync(string path, CancellationToken cancellationToken)
  • public IEnumerable<ISftpFile> EndListDirectory(IAsyncResult asyncResult)
  • public IEnumerable<SftpFile> EndListDirectory(IAsyncResult asyncResult)
  • public ISftpFile Get(string path)
  • public SftpFile Get(string path)
  • public SftpFileSystemInformation GetStatus(string path)
  • public Task<SftpFileSystemInformation> GetStatusAsync(string path, CancellationToken cancellationToken)
  • public IEnumerable<ISftpFile> ListDirectory(string path, Action<int> listCallback = null)
  • public IAsyncEnumerable<ISftpFile> ListDirectoryAsync(string path, CancellationToken cancellationToken)
  • public SftpFileSytemInformation GetStatus(string path)
  • public IEnumerable<SftpFile> ListDirectory(string path, Action<int> listCallback = null)
  • 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, int lookback = -1)
  • public string Expect(string text, TimeSpan timeout)
  • public string Expect(Regex regex, TimeSpan timeout, int lookback = -1)
  • public string Expect(Regex regex, TimeSpan timeout)
• public class SshClient : BaseClient
  • public SshClient(string host, int port, string username, IPrivateKeySource[] keyFiles)
  • public SshClient(string host, string username, IPrivateKeySource[] keyFiles)
  • public SshClient(string host, int port, string username, PrivateKeyFile[] keyFiles)
  • public SshClient(string host, string username, PrivateKeyFile[] keyFiles)
  • public Shell CreateShellNoTerminal(Stream input, Stream output, Stream extendedOutput, int bufferSize = -1)
  • public ShellStream CreateShellStreamNoTerminal(int bufferSize = -1)
• public class SshCommand : IDisposable
  • public string ExitSignal { get; }
  • public int? ExitStatus { get; }
  • public int ExitStatus { get; }
  • public void CancelAsync(bool forceKill = false, int millisecondsTimeout = 500)
  • public Stream CreateInputStream()
  • public void CancelAsync()
  • public Task ExecuteAsync(CancellationToken cancellationToken = default)

Renci.SshNet.Abstractions

• public static class DiagnosticAbstraction

Renci.SshNet.Common

• public class AuthenticationPromptEventArgs : AuthenticationEventArgs
  • public IReadOnlyList<AuthenticationPrompt> Prompts { get; }
  • public AuthenticationPromptEventArgs(string username, string instruction, string language, IReadOnlyList<AuthenticationPrompt> prompts)
  • public IEnumerable<AuthenticationPrompt> Prompts { get; }
  • public AuthenticationPromptEventArgs(string username, string instruction, string language, IEnumerable<AuthenticationPrompt> prompts)
• public class DerData
  • public DerData(byte[] data, bool construct = false)
  • public DerData(byte[] data)
  • 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 PipeStream : Stream
  • public bool BlockLastReadBuffer { get; set; }
  • public long MaxBufferLength { get; set; }
• public class SemaphoreLight : IDisposable
  • public WaitHandle AvailableWaitHandle { get; }
  • public int CurrentCount { get; }
  • public SemaphoreLight(int initialCount)
  • public void Dispose()
  • protected void Dispose(bool disposing)
  • public int Release()
  • public int Release(int releaseCount)
  • public void Wait()
  • public bool Wait(int millisecondsTimeout)
  • public bool Wait(TimeSpan timeout)
• public class SshConnectionException : SshException
  • public SshConnectionException(string message, Exception inner)
• public abstract class SshData
  • protected Dictionary<string, string> ReadExtensionPair()
  • protected IDictionary<string, string> ReadExtensionPair()
• public class SshDataStream : MemoryStream
  • public ushort ReadUInt16()
• public class SshIdentificationEventArgs : EventArgs
• public enum TerminalModes
  • IUTF8 = 42

Renci.SshNet.Compression

• public enum CompressionMode
  • Compress = 0
  • Decompress = 1
• public abstract class Compressor : Algorithm, IDisposable
  • protected Compressor(bool delayedCompression)
  • protected bool IsActive { get; protected set; }
  • protected Session Session { get; }
  • protected Compressor()
  • protected abstract byte[] CompressCore(byte[] data, int offset, int length)
  • protected abstract byte[] DecompressCore(byte[] data, int offset, int length)
• public class ZlibOpenSsh : Compressor
  • public ZlibOpenSsh()
• public class ZlibStream
  • public ZlibStream(Stream stream, CompressionMode mode)
  • public void Write(byte[] buffer, int offset, int count)

Renci.SshNet.Connection

• public sealed class SshIdentification

Renci.SshNet.Messages

• public abstract class Message : SshData
  • public abstract string MessageName { get; }
  • public abstract byte MessageNumber { get; }
• public sealed class MessageAttribute : Attribute
  • public string Name { get; set; }
  • public byte Number { get; set; }
  • public MessageAttribute(string name, byte number)

Renci.SshNet.Messages.Transport

• public class KeyExchangeDhReplyMessage : Message
  • public byte[] F { get; }
  • public BigInteger F { get; }
• public class KeyExchangeEcdhReplyMessage : Message

Renci.SshNet.Security

• public class DsaKey : Key, IDisposable
  • public DsaKey(SshKeyData publicKeyData)
  • public DsaKey()
• public class EcdsaKey : Key, IDisposable
• public class ED25519Key : Key, IDisposable
• public interface IKeyExchange : IDisposable
  • Cipher CreateClientCipher(out bool isAead)
  • HashAlgorithm CreateClientHash(out bool isEncryptThenMAC)
  • Cipher CreateClientCipher()
  • HashAlgorithm CreateClientHash()
  • Cipher CreateServerCipher(out bool isAead)
  • HashAlgorithm CreateServerHash(out bool isEncryptThenMAC)
  • Cipher CreateServerCipher()
  • HashAlgorithm CreateServerHash()
  • void Start(Session session, KeyExchangeInitMessage message, bool sendClientInitMessage)
  • void Start(Session session, KeyExchangeInitMessage message)
• public abstract class Key
  • public string Comment { get; set; }
  • protected BigInteger[] _privateKey
  • protected abstract DigitalSignature DigitalSignature { get; }
  • protected Key(byte[] data)
• public abstract class KeyExchange : Algorithm, IKeyExchange, IDisposable
  • public byte[] SharedKey { get; protected set; }
  • public BigInteger SharedKey { get; protected set; }
  • public Cipher CreateClientCipher(out bool isAead)
  • public HashAlgorithm CreateClientHash(out bool isEncryptThenMAC)
  • public Cipher CreateClientCipher()
  • public HashAlgorithm CreateClientHash()
  • public Cipher CreateServerCipher(out bool isAead)
  • public HashAlgorithm CreateServerHash(out bool isEncryptThenMAC)
  • public Cipher CreateServerCipher()
  • public HashAlgorithm CreateServerHash()
  • public virtual void Start(Session session, KeyExchangeInitMessage message, bool sendClientInitMessage)
  • public virtual void Start(Session session, KeyExchangeInitMessage message)
• public abstract class KeyExchangeDiffieHellman : KeyExchange
  • protected BigInteger _clientExchangeValue
  • protected byte[] _clientPayload
  • protected BigInteger _group
  • protected byte[] _hostKey
  • protected BigInteger _prime
  • protected BigInteger _randomValue
  • protected BigInteger _serverExchangeValue
  • protected byte[] _serverPayload
  • protected byte[] _signature
  • protected KeyExchangeDiffieHellman()
  • protected virtual void HandleServerDhReply(byte[] hostKey, BigInteger serverExchangeValue, byte[] signature)
  • protected void PopulateClientExchangeValue()
• public class KeyExchangeDiffieHellmanGroup1Sha1 : KeyExchangeDiffieHellmanGroupSha1
  • public KeyExchangeDiffieHellmanGroup1Sha1()
• public class KeyExchangeDiffieHellmanGroupExchangeSha1 : KeyExchangeDiffieHellmanGroupExchangeShaBase
  • public KeyExchangeDiffieHellmanGroupExchangeSha1()
• public class KeyExchangeDiffieHellmanGroupExchangeSha256 : KeyExchangeDiffieHellmanGroupExchangeShaBase
  • public KeyExchangeDiffieHellmanGroupExchangeSha256()
• public abstract class KeyExchangeDiffieHellmanGroupExchangeShaBase : KeyExchangeDiffieHellman
  • protected KeyExchangeDiffieHellmanGroupExchangeShaBase()
• public abstract class KeyExchangeDiffieHellmanGroupSha1 : KeyExchangeDiffieHellman
  • public abstract BigInteger GroupPrime { get; }
  • protected KeyExchangeDiffieHellmanGroupSha1()
• public class KeyHostAlgorithm : HostAlgorithm
  • public DigitalSignature DigitalSignature { get; }
  • public KeyHostAlgorithm(string name, Key key, DigitalSignature digitalSignature)
  • public KeyHostAlgorithm(string name, Key key, byte[] data)
• public class RsaKey : Key, IDisposable
  • public RsaKey(SshKeyData publicKeyData)
  • public RsaKey()
• public sealed class SshKeyData : SshData

Renci.SshNet.Security.Cryptography

• public abstract class AsymmetricCipher : Cipher
  • protected AsymmetricCipher()
• public abstract class BlockCipher : SymmetricCipher
  • 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
  • protected CipherDigitalSignature(ObjectIdentifier oid, AsymmetricCipher cipher)
  • protected byte[] DerEncode(byte[] hashData)
  • protected abstract byte[] Hash(byte[] input)
• public class EcdsaDigitalSignature : DigitalSignature, IDisposable
• public class ED25519DigitalSignature : DigitalSignature, IDisposable
• public class RsaDigitalSignature : CipherDigitalSignature, IDisposable
  • public RsaDigitalSignature(RsaKey rsaKey, HashAlgorithmName hashAlgorithmName)
• 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
  • public AesCipher(byte[] key, byte[] iv, AesCipherMode mode, bool pkcs7Padding = false)
  • public void Dispose(bool disposing)
  • public void Dispose()
  • public AesCipher(byte[] key, CipherMode mode, CipherPadding padding)
• public enum AesCipherMode
• public class RsaCipher : AsymmetricCipher
  • public RsaCipher(RsaKey key)

Renci.SshNet.Sftp

• public interface ISftpFile
• public class SftpFileAttributes
  • public DateTime LastAccessTimeUtc { get; set; }
  • public DateTime LastWriteTimeUtc { get; set; }
• public class SftpFileSystemInformation
• public class SftpFileSytemInformation
  • 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; }