Discuss this help topic in SecureBlackbox Forum


TElSimpleSFTPClient     See also     

Filter: C#/Java  VB.NET  Pascal  C++  PHP  

This event is fired when the keyboard-interactive authentication is chosen by server


    event TSSHAuthenticationKeyboardEvent OnAuthenticationKeyboard;
    delegate void TSSHAuthenticationKeyboardEvent(Object Sender, TElStringList Prompts, Boolean[] Echo, TElStringList Responses);

    Event OnAuthenticationKeyboard As TSSHAuthenticationKeyboardEvent
    Delegate Sub TSSHAuthenticationKeyboardEvent(ByVal Sender As Object, ByVal Prompts As TElStringList, ByVal Echo As Boolean[], ByVal Responses As TElStringList)

    property OnAuthenticationKeyboard: TSSHAuthenticationKeyboardEvent;
    TSSHAuthenticationKeyboardEvent = procedure (Sender: TObject; Prompts : TStringList; Echo : TBits; Responses : TStringList) of object;

    void get_OnAuthenticationKeyboard(TSSHAuthenticationKeyboardEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnAuthenticationKeyboard(TSSHAuthenticationKeyboardEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSSHAuthenticationKeyboardEvent)(void * _ObjectData, TObjectHandle Sender, TStringListHandle Prompts, TBitsHandle Echo, TStringListHandle Responses);

    TSSHAuthenticationKeyboardEvent|callable|NULL get_OnAuthenticationKeyboard()
    void set_OnAuthenticationKeyboard(TSSHAuthenticationKeyboardEvent|callable|NULL $Value)
    callable TSSHAuthenticationKeyboardEvent(TObject $Sender, TStringList $Prompts, TBits $Echo, TStringList $Responses)


  • Prompts - The list of prompts sent by the server
  • Echo - The list of flags which specify which responses should be echoed on screen
  • Responses - The list of responses entered by user


    This event is fired when the keyboard-interactive authentication type is chosen by server. According to this authentication type, server should send to client a number of prompts, and client should respond to each prompt with text line. The Echo parameter specifies which of client's responses (in case of entering them from console) should be displayed to him.

See also:     OnAuthenticationSuccess     OnAuthenticationFailed    

Discuss this help topic in SecureBlackbox Forum