SSHKeyboardInteractive Event

Fired when the component receives a request for user input from the server.

Syntax

public event OnSSHKeyboardInteractiveHandler OnSSHKeyboardInteractive;

public delegate void OnSSHKeyboardInteractiveHandler(object sender, SftpSSHKeyboardInteractiveEventArgs e);

public class SftpSSHKeyboardInteractiveEventArgs : EventArgs {
  public string Name { get; }
  public string Instructions { get; }
  public string Prompt { get; }
  public string Response { get; set; }
  public bool EchoResponse { get; }
}
Public Event OnSSHKeyboardInteractive As OnSSHKeyboardInteractiveHandler

Public Delegate Sub OnSSHKeyboardInteractiveHandler(sender As Object, e As SftpSSHKeyboardInteractiveEventArgs)

Public Class SftpSSHKeyboardInteractiveEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property Instructions As String
  Public ReadOnly Property Prompt As String
  Public Property Response As String
  Public ReadOnly Property EchoResponse As Boolean
End Class

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the SSH logon process. During authentication, the component will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the component will fire this event to allow the client application to set the password.

During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.

Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.

Note: the server may send several prompts in a single packet. The component will fire the SSHKeyboardInteractive event once for each prompt.

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 .NET Edition - Version 20.0 [Build 8501]