Discuss this help topic in SecureBlackbox Forum

TElSSHServer.OnAuthKeyboardResponse

TElSSHServer     See also     


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


This event is fired when answers for questions passed via OnAuthKeyboard or previous OnAuthKeyboardResponse event are received from the client.

Declaration

[C#/Java]
    event TSSHAuthKeyboardResponseEvent OnAuthKeyboardResponse;
    delegate void TSSHAuthKeyboardResponseEvent(Object Sender, TElStringList Requests, TElStringList Responses, ref string Name, ref string Instruction, TElStringList NewRequests, TElBits Echoes, ref bool Accept);

[VB.NET]
    Event OnAuthKeyboardResponse As TSSHAuthKeyboardResponseEvent
    Delegate Sub TSSHAuthKeyboardResponseEvent(ByVal Sender As Object, ByVal Requests As TElStringList, ByVal Responses As TElStringList, ByRef Name As String, ByRef Instruction As String, ByVal NewRequests As TElStringList, ByVal Echoes As TElBits, ByRef Accept As Boolean)

[Pascal]
    property OnAuthKeyboardResponse: TSSHAuthKeyboardResponseEvent;
    TSSHAuthKeyboardResponseEvent = procedure(Sender: TObject; Requests : TStringList; Responses: TStringList; var Name: string; var Instruction: string; NewRequests : TStringList; Echoes : TBits; var Accept : boolean) of object;

[C++]
    void get_OnAuthKeyboardResponse(TSSHAuthKeyboardResponseEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnAuthKeyboardResponse(TSSHAuthKeyboardResponseEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSSHAuthKeyboardResponseEvent)(void * _ObjectData, TObjectHandle Sender, TStringListHandle Requests, TStringListHandle Responses, char * pcName, int32_t &szName, char * pcInstruction, int32_t &szInstruction, TStringListHandle NewRequests, TBitsHandle Echoes, int8_t &Accept);

[PHP]
    TSSHAuthKeyboardResponseEvent|callable|NULL get_OnAuthKeyboardResponse()
    void set_OnAuthKeyboardResponse(TSSHAuthKeyboardResponseEvent|callable|NULL $Value)
    callable TSSHAuthKeyboardResponseEvent(TObject $Sender, TStringList $Requests, TStringList $Responses, string &$Name, string &$Instruction, TStringList $NewRequests, TBits $Echoes, bool &$Accept)

Parameters

  • Requests - asked questions
  • Responses - client's answers
  • Submethods - names of server-dependent submethods client would like to use
  • Name - line that names the authentication
  • Instruction - instructions that will be shown to the client before the list of questions/prompts
  • NewRequests - list of new questions/prompts (each line contains one question/prompt)
  • Echoes - set Size equal to the total number of questions/prompts. If the bit is turned on, it specifies that the answer for corresponding question/prompt must be shown on client's display (on),if turned off - the responce should not be shown (ex. password)
  • Accept - set this parameter to True if authentication is successful. In this case NewRequests and Echoes parameters will be ignored.
  • pcName - line that names the authentication
  • szName - the length of pcName.
  • pcInstruction - instructions that will be shown to the client before the list of questions/prompts
  • szInstruction - the length of pcInstruction.

Description

    This event handler has to check answers' correctness and optionally new questions may be passed to the client.

See also:     OnAuthHostbased     OnAuthPassword     OnAuthPublicKey     OnAuthKeyboard    

Discuss this help topic in SecureBlackbox Forum