Class KeyboardInteractiveAuthenticationMethod

Namespace

Renci.SshNet

Assembly

Renci.SshNet.dll

Provides functionality to perform keyboard interactive authentication.

public class KeyboardInteractiveAuthenticationMethod : AuthenticationMethod, IDisposable

Inheritance

object

AuthenticationMethod

KeyboardInteractiveAuthenticationMethod

Implements

IDisposable

Inherited Members

AuthenticationMethod.Username

AuthenticationMethod.AllowedAuthentications

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

KeyboardInteractiveAuthenticationMethod(string)

Initializes a new instance of the KeyboardInteractiveAuthenticationMethod class.

public KeyboardInteractiveAuthenticationMethod(string username)

Parameters

username string

The username.

Exceptions

ArgumentException

username is whitespace or null.

Properties

Name

Gets the name of the authentication method.

public override string Name { get; }

Property Value

string

The name of the authentication method.

Methods

Authenticate(Session)

Authenticates the specified session.

public override AuthenticationResult Authenticate(Session session)

Parameters

session Session

The session to authenticate.

Returns

AuthenticationResult

Result of authentication process.

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.

~KeyboardInteractiveAuthenticationMethod()

Finalizes an instance of the KeyboardInteractiveAuthenticationMethod class.

protected ~KeyboardInteractiveAuthenticationMethod()

Events

AuthenticationPrompt

Occurs when server prompts for more authentication information.

public event EventHandler<AuthenticationPromptEventArgs> AuthenticationPrompt

Event Type

EventHandler<AuthenticationPromptEventArgs>