|
|
|
|
using System;
|
|
|
|
|
using System.Linq;
|
|
|
|
|
using System.Net;
|
|
|
|
|
using System.Text;
|
|
|
|
|
using Renci.SshNet.Common;
|
|
|
|
|
|
|
|
|
|
namespace Renci.SshNet
|
|
|
|
|
{
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Provides connection information when password authentication method is used
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <example>
|
|
|
|
|
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo" language="C#" title="Connect using username and password" />
|
|
|
|
|
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo PasswordExpired" language="C#" title="Change password when connecting" />
|
|
|
|
|
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo AuthenticationBanner" language="C#" title="Display authentication banner" />
|
|
|
|
|
/// </example>
|
|
|
|
|
public class PasswordConnectionInfo : ConnectionInfo, IDisposable
|
|
|
|
|
{
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Occurs when user's password has expired and needs to be changed.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <example>
|
|
|
|
|
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo PasswordExpired" language="C#" title="Change password when connecting" />
|
|
|
|
|
/// </example>
|
|
|
|
|
public event EventHandler<AuthenticationPasswordChangeEventArgs> PasswordExpired;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo" /> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <example>
|
|
|
|
|
/// <code source="..\..\src\Renci.SshNet.Tests\Classes\PasswordConnectionInfoTest.cs" region="Example PasswordConnectionInfo" language="C#" title="Connect using username and password" />
|
|
|
|
|
/// </example>
|
|
|
|
|
/// <exception cref="ArgumentNullException"><paramref name="password"/> is <c>null</c>.</exception>
|
|
|
|
|
/// <exception cref="ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <c>null</c> or contains only whitespace characters.</exception>
|
|
|
|
|
public PasswordConnectionInfo(string host, string username, string password)
|
|
|
|
|
: this(host, DefaultPort, username, Encoding.UTF8.GetBytes(password))
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="port">Connection port.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <exception cref="ArgumentNullException"><paramref name="password"/> is <c>null</c>.</exception>
|
|
|
|
|
/// <exception cref="ArgumentException"><paramref name="host"/> is invalid, or <paramref name="username"/> is <c>null</c> or contains only whitespace characters.</exception>
|
|
|
|
|
/// <exception cref="ArgumentOutOfRangeException"><paramref name="port"/> is not within <see cref="IPEndPoint.MinPort"/> and <see cref="IPEndPoint.MaxPort"/>.</exception>
|
|
|
|
|
public PasswordConnectionInfo(string host, int port, string username, string password)
|
|
|
|
|
: this(host, port, username, Encoding.UTF8.GetBytes(password), ProxyTypes.None, string.Empty, 0, string.Empty, string.Empty)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="port">The port.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, int port, string username, string password, ProxyTypes proxyType, string proxyHost, int proxyPort)
|
|
|
|
|
: this(host, port, username, Encoding.UTF8.GetBytes(password), proxyType, proxyHost, proxyPort, string.Empty, string.Empty)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="port">The port.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
/// <param name="proxyUsername">The proxy username.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, int port, string username, string password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername)
|
|
|
|
|
: this(host, port, username, Encoding.UTF8.GetBytes(password), proxyType, proxyHost, proxyPort, proxyUsername, string.Empty)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, string username, string password, ProxyTypes proxyType, string proxyHost, int proxyPort)
|
|
|
|
|
: this(host, DefaultPort, username, Encoding.UTF8.GetBytes(password), proxyType, proxyHost, proxyPort, string.Empty, string.Empty)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
/// <param name="proxyUsername">The proxy username.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, string username, string password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername)
|
|
|
|
|
: this(host, DefaultPort, username, Encoding.UTF8.GetBytes(password), proxyType, proxyHost, proxyPort, proxyUsername, string.Empty)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
/// <param name="proxyUsername">The proxy username.</param>
|
|
|
|
|
/// <param name="proxyPassword">The proxy password.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, string username, string password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword)
|
|
|
|
|
: this(host, DefaultPort, username, Encoding.UTF8.GetBytes(password), proxyType, proxyHost, proxyPort, proxyUsername, proxyPassword)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, string username, byte[] password)
|
|
|
|
|
: this(host, DefaultPort, username, password)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo" /> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="port">Connection port.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <exception cref="ArgumentNullException"><paramref name="password" /> is <c>null</c>.</exception>
|
|
|
|
|
/// <exception cref="ArgumentException"><paramref name="host" /> is invalid, or <paramref name="username" /> is <c>null</c> or contains only whitespace characters.</exception>
|
|
|
|
|
/// <exception cref="ArgumentOutOfRangeException"><paramref name="port" /> is not within <see cref="IPEndPoint.MinPort" /> and <see cref="IPEndPoint.MaxPort" />.</exception>
|
|
|
|
|
public PasswordConnectionInfo(string host, int port, string username, byte[] password)
|
|
|
|
|
: this(host, port, username, password, ProxyTypes.None, string.Empty, 0, string.Empty, string.Empty)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="port">The port.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, int port, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort)
|
|
|
|
|
: this(host, port, username, password, proxyType, proxyHost, proxyPort, string.Empty, string.Empty)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="port">The port.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
/// <param name="proxyUsername">The proxy username.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, int port, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername)
|
|
|
|
|
: this(host, port, username, password, proxyType, proxyHost, proxyPort, proxyUsername, string.Empty)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort)
|
|
|
|
|
: this(host, DefaultPort, username, password, proxyType, proxyHost, proxyPort, string.Empty, string.Empty)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
/// <param name="proxyUsername">The proxy username.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername)
|
|
|
|
|
: this(host, DefaultPort, username, password, proxyType, proxyHost, proxyPort, proxyUsername, string.Empty)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
/// <param name="proxyUsername">The proxy username.</param>
|
|
|
|
|
/// <param name="proxyPassword">The proxy password.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword)
|
|
|
|
|
: this(host, DefaultPort, username, password, proxyType, proxyHost, proxyPort, proxyUsername, proxyPassword)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Initializes a new instance of the <see cref="PasswordConnectionInfo"/> class.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="host">Connection host.</param>
|
|
|
|
|
/// <param name="port">The port.</param>
|
|
|
|
|
/// <param name="username">Connection username.</param>
|
|
|
|
|
/// <param name="password">Connection password.</param>
|
|
|
|
|
/// <param name="proxyType">Type of the proxy.</param>
|
|
|
|
|
/// <param name="proxyHost">The proxy host.</param>
|
|
|
|
|
/// <param name="proxyPort">The proxy port.</param>
|
|
|
|
|
/// <param name="proxyUsername">The proxy username.</param>
|
|
|
|
|
/// <param name="proxyPassword">The proxy password.</param>
|
|
|
|
|
public PasswordConnectionInfo(string host, int port, string username, byte[] password, ProxyTypes proxyType, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword)
|
|
|
|
|
: base(host, port, username, proxyType, proxyHost, proxyPort, proxyUsername, proxyPassword, new PasswordAuthenticationMethod(username, password))
|
|
|
|
|
{
|
|
|
|
|
foreach (var authenticationMethod in AuthenticationMethods.OfType<PasswordAuthenticationMethod>())
|
|
|
|
|
{
|
|
|
|
|
authenticationMethod.PasswordExpired += AuthenticationMethod_PasswordExpired;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private void AuthenticationMethod_PasswordExpired(object sender, AuthenticationPasswordChangeEventArgs e)
|
|
|
|
|
{
|
|
|
|
|
if (PasswordExpired != null)
|
|
|
|
|
{
|
|
|
|
|
PasswordExpired(sender, e);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#region IDisposable Members
|
|
|
|
|
|
|
|
|
|
private bool _isDisposed;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public void Dispose()
|
|
|
|
|
{
|
|
|
|
|
Dispose(true);
|
|
|
|
|
GC.SuppressFinalize(this);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Releases unmanaged and - optionally - managed resources
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
|
|
|
protected virtual void Dispose(bool disposing)
|
|
|
|
|
{
|
|
|
|
|
if (_isDisposed)
|
|
|
|
|
return;
|
|
|
|
|
|
|
|
|
|
if (disposing)
|
|
|
|
|
{
|
|
|
|
|
if (AuthenticationMethods != null)
|
|
|
|
|
{
|
|
|
|
|
foreach (var authenticationMethods in AuthenticationMethods.OfType<IDisposable>())
|
|
|
|
|
{
|
|
|
|
|
authenticationMethods.Dispose();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
_isDisposed = true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Releases unmanaged resources and performs other cleanup operations before the
|
|
|
|
|
/// <see cref="PasswordConnectionInfo"/> is reclaimed by garbage collection.
|
|
|
|
|
/// </summary>
|
|
|
|
|
~PasswordConnectionInfo()
|
|
|
|
|
{
|
|
|
|
|
// Do not re-create Dispose clean-up code here.
|
|
|
|
|
// Calling Dispose(false) is optimal in terms of
|
|
|
|
|
// readability and maintainability.
|
|
|
|
|
Dispose(false);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#endregion
|
|
|
|
|
}
|
|
|
|
|
}
|