SSH.NET 2024.1.0

API Differences between 2024.1.0 and 2020.0.0

187 Additions 81 Removals

Renci.SshNet

public abstract class BaseClient : IBaseClient, 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)
- 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 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
- Task DeleteFileAsync(string path, CancellationToken cancellationToken)
- IEnumerable<SftpFile> EndListDirectory(IAsyncResult asyncResult)
- IEnumerable<ISftpFile> EndListDirectory(IAsyncResult asyncResult)
- SftpFile Get(string path)
- ISftpFile Get(string path)
- SftpFileSytemInformation GetStatus(string path)
- IEnumerable<SftpFile> ListDirectory(string path, Action<int> listCallback = null)
- SftpFileSystemInformation GetStatus(string path)
- Task<SftpFileSystemInformation> GetStatusAsync(string path, CancellationToken cancellationToken)
- IEnumerable<ISftpFile> ListDirectory(string path, Action<int> listCallback = null)
- IAsyncEnumerable<ISftpFile> ListDirectoryAsync(string path, CancellationToken cancellationToken)
- Task<SftpFileStream> OpenAsync(string path, FileMode mode, FileAccess access, CancellationToken cancellationToken)
- Task RenameFileAsync(string oldPath, string newPath, CancellationToken cancellationToken)
- void SetLastAccessTime(string path, DateTime lastAccessTime)
- void SetLastAccessTimeUtc(string path, DateTime lastAccessTimeUtc)
- void SetLastWriteTime(string path, DateTime lastWriteTime)
- void SetLastWriteTimeUtc(string path, DateTime lastWriteTimeUtc)
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 SftpFileSytemInformation GetStatus(string path)
- public IEnumerable<SftpFile> ListDirectory(string path, Action<int> listCallback = null)
- 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 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 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)

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 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 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)

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 ZlibOpenSsh : Compressor
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.Security

public class DsaKey : Key, IDisposable
- public DsaKey()
- public DsaKey(SshKeyData publicKeyData)
public class EcdsaKey : Key, IDisposable
- public EcdsaKey()
- public byte[] PrivateKey { get; }
- public EcdsaKey(SshKeyData publicKeyData)
public class ED25519Key : Key, IDisposable
- public ED25519Key()
- public ED25519Key(byte[] pk, byte[] sk)
- public ED25519Key(SshKeyData publicKeyData)
- public ED25519Key(byte[] privateKeyData)
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
- protected abstract DigitalSignature DigitalSignature { get; }
- public string Comment { get; set; }
- protected Key(byte[] data)
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 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 abstract class AsymmetricCipher : Cipher
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
public class RsaDigitalSignature : DigitalSignature, 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, 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
public class RsaCipher : AsymmetricCipher

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 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; }