Class PasswordConnectionInfo

Namespace

Renci.SshNet

Assembly

Renci.SshNet.dll

Provides connection information when password authentication method is used.

public class PasswordConnectionInfo : ConnectionInfo, IDisposable

Inheritance

object

ConnectionInfo

PasswordConnectionInfo

Implements

IDisposable

Inherited Members

ConnectionInfo.KeyExchangeAlgorithms

ConnectionInfo.Encryptions

ConnectionInfo.HmacAlgorithms

ConnectionInfo.HostKeyAlgorithms

ConnectionInfo.AuthenticationMethods

ConnectionInfo.CompressionAlgorithms

ConnectionInfo.ChannelRequests

ConnectionInfo.IsAuthenticated

ConnectionInfo.Host

ConnectionInfo.Port

ConnectionInfo.Username

ConnectionInfo.ProxyType

ConnectionInfo.ProxyHost

ConnectionInfo.ProxyPort

ConnectionInfo.ProxyUsername

ConnectionInfo.ProxyPassword

ConnectionInfo.Timeout

ConnectionInfo.ChannelCloseTimeout

ConnectionInfo.Encoding

ConnectionInfo.RetryAttempts

ConnectionInfo.MaxSessions

ConnectionInfo.AuthenticationBanner

ConnectionInfo.CurrentKeyExchangeAlgorithm

ConnectionInfo.CurrentServerEncryption

ConnectionInfo.CurrentClientEncryption

ConnectionInfo.CurrentServerHmacAlgorithm

ConnectionInfo.CurrentClientHmacAlgorithm

ConnectionInfo.CurrentHostKeyAlgorithm

ConnectionInfo.CurrentServerCompressionAlgorithm

ConnectionInfo.ServerVersion

ConnectionInfo.ClientVersion

ConnectionInfo.CurrentClientCompressionAlgorithm

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

PasswordConnectionInfo(string, string, string)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, string username, string password)

Parameters

host string

Connection host.

username string

Connection username.

password string

Connection password.

Exceptions

ArgumentNullException

password is null.

ArgumentException

host is invalid, or username is null or contains only whitespace characters.

PasswordConnectionInfo(string, int, string, string)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, int port, string username, string password)

Parameters

host string

Connection host.

port int

Connection port.

username string

Connection username.

password string

Connection password.

Exceptions

ArgumentNullException

password is null.

ArgumentException

host is invalid, or username is null or contains only whitespace characters.

ArgumentOutOfRangeException

port is not within System.Net.IPEndPoint.MinPort and System.Net.IPEndPoint.MaxPort.

PasswordConnectionInfo(string, int, string, string, ProxyTypes, string, int)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, int port, string username, string password, ProxyTypes proxyType, string proxyHost, int proxyPort)

Parameters

host string

Connection host.

port int

The port.

username string

Connection username.

password string

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

PasswordConnectionInfo(string, int, string, string, ProxyTypes, string, int, string)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, int port, string username, string password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername)

Parameters

host string

Connection host.

port int

The port.

username string

Connection username.

password string

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

proxyUsername string

The proxy username.

PasswordConnectionInfo(string, string, string, ProxyTypes, string, int)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, string username, string password, ProxyTypes proxyType, string proxyHost, int proxyPort)

Parameters

host string

Connection host.

username string

Connection username.

password string

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

PasswordConnectionInfo(string, string, string, ProxyTypes, string, int, string)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, string username, string password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername)

Parameters

host string

Connection host.

username string

Connection username.

password string

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

proxyUsername string

The proxy username.

PasswordConnectionInfo(string, string, string, ProxyTypes, string, int, string, string)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, string username, string password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword)

Parameters

host string

Connection host.

username string

Connection username.

password string

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

proxyUsername string

The proxy username.

proxyPassword string

The proxy password.

PasswordConnectionInfo(string, string, byte[])

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, string username, byte[] password)

Parameters

host string

Connection host.

username string

Connection username.

password byte[]

Connection password.

PasswordConnectionInfo(string, int, string, byte[])

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, int port, string username, byte[] password)

Parameters

host string

Connection host.

port int

Connection port.

username string

Connection username.

password byte[]

Connection password.

Exceptions

ArgumentNullException

password is null.

ArgumentException

host is invalid, or username is null or contains only whitespace characters.

ArgumentOutOfRangeException

port is not within System.Net.IPEndPoint.MinPort and System.Net.IPEndPoint.MaxPort.

PasswordConnectionInfo(string, int, string, byte[], ProxyTypes, string, int)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, int port, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort)

Parameters

host string

Connection host.

port int

The port.

username string

Connection username.

password byte[]

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

PasswordConnectionInfo(string, int, string, byte[], ProxyTypes, string, int, string)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, int port, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername)

Parameters

host string

Connection host.

port int

The port.

username string

Connection username.

password byte[]

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

proxyUsername string

The proxy username.

PasswordConnectionInfo(string, string, byte[], ProxyTypes, string, int)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort)

Parameters

host string

Connection host.

username string

Connection username.

password byte[]

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

PasswordConnectionInfo(string, string, byte[], ProxyTypes, string, int, string)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername)

Parameters

host string

Connection host.

username string

Connection username.

password byte[]

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

proxyUsername string

The proxy username.

PasswordConnectionInfo(string, string, byte[], ProxyTypes, string, int, string, string)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword)

Parameters

host string

Connection host.

username string

Connection username.

password byte[]

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

proxyUsername string

The proxy username.

proxyPassword string

The proxy password.

PasswordConnectionInfo(string, int, string, byte[], ProxyTypes, string, int, string, string)

Initializes a new instance of the Renci.SshNet.PasswordConnectionInfo class.

public PasswordConnectionInfo(string host, int port, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword)

Parameters

host string

Connection host.

port int

The port.

username string

Connection username.

password byte[]

Connection password.

proxyType ProxyTypes

Type of the proxy.

proxyHost string

The proxy host.

proxyPort int

The proxy port.

proxyUsername string

The proxy username.

proxyPassword string

The proxy password.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

PasswordExpired

Occurs when user's password has expired and needs to be changed.

public event EventHandler<AuthenticationPasswordChangeEventArgs> PasswordExpired

Event Type

EventHandler<AuthenticationPasswordChangeEventArgs>