TElSimpleSSHClient.OnAuthenticationStart event

TElSimpleSSHClient.OnAuthenticationStart

This event is fired on the very beginning of authentication process.

Declaration

[C#]
event TSSHAuthenticationStartEvent OnAuthenticationStart;
delegate void TSSHAuthenticationStartEvent(Object Sender, int SupportedAuths);

[VB.NET]
Event OnAuthenticationStart As TSSHAuthenticationStartEvent
Delegate Sub TSSHAuthenticationStartEvent(ByVal Sender As Object, ByVal SupportedAuths As Integer)

[Pascal]
property OnAuthenticationStart : TSSHAuthenticationStartEvent;
TSSHAuthenticationStartEvent = procedure (Sender: TObject; SupportedAuths : integer) of object;

[C++]
    void get_OnAuthenticationStart(TSSHAuthenticationStartEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnAuthenticationStart(TSSHAuthenticationStartEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSSHAuthenticationStartEvent)(void * _ObjectData, TObjectHandle Sender, int32_t SupportedAuths);

[PHP]
    TSSHAuthenticationStartEvent|callable|NULL get_OnAuthenticationStart()
    void set_OnAuthenticationStart(TSSHAuthenticationStartEvent|callable|NULL $Value)
    callable TSSHAuthenticationStartEvent(TObject $Sender, integer $SupportedAuths)

[Java]
    TSSHAuthenticationStartEvent getOnAuthenticationStart();
    void setOnAuthenticationStart(TSSHAuthenticationStartEvent Value);
    TSSHAuthenticationStartEvent.Callback OnAuthenticationStart = new TSSHAuthenticationStartEvent.Callback() {
        public void TSSHAuthenticationStartEventCallback(TObject Sender, int SupportedAuths) {
            //...
        }
    }

Parameters

SupportedAuths - supported authentication types

Possible authentication types:

Definition	Value	Description
SSH_AUTH_TYPE_RHOSTS	1 (0x01)	"rhosts" authentication.
SSH_AUTH_TYPE_PUBLICKEY	2 (0x02)	Public key authentication.
SSH_AUTH_TYPE_PASSWORD	4 (0x04)	Password authentication.
SSH_AUTH_TYPE_HOSTBASED	8 (0x08)	"hostbased" authentication.
SSH_AUTH_TYPE_KEYBOARD	16 (0x10)	Keyboard-interactive authentication.
SSH_AUTH_TYPE_GSSAPI_WITH_MIC	32 (0x20)	GSSAPI with MIC authentication.
SSH_AUTH_TYPE_GSSAPI_KEYEX	64 (0x40)	GSSAPI-keyex authentication.
SSH_AUTH_TYPE_PUBLICKEYAGENT	128 (0x40)	Authentification via SSH public key agent like pageant or ssh-agent.This is supported only for Windows OS (within VCL/.NET, pageant and cygwin ssh-agent are supported) or *nix/Mac OS (ssh-agent).

Description

This event is fired on the very beginning of authentication process. Use SupportedAuths parameter to get the list of authentication types supported by server. The authentication type is calculated as bitwise OR operation on masks of types that should be enabled.

Discuss this help topic in SecureBlackbox Forum