TElSimpleSSHClient.OnAuthenticationAttempt event

TElSimpleSSHClient.OnAuthenticationAttempt

This event is fired when a single authentication attempt is performed.

Declaration

[C#]
event TSSHAuthenticationAttemptEvent OnAuthenticationAttempt;
delegate void TSSHAuthenticationAttemptEvent(Object Sender, int AuthType, Object AuthParam);

[VB.NET]
Event OnAuthenticationAttempt As TSSHAuthenticationAttemptEvent
Delegate Sub TSSHAuthenticationAttemptEvent(ByVal Sender As Object, ByVal AuthType As Integer, ByVal AuthParam As Object)

[Pascal]
property OnAuthenticationAttempt : TSSHAuthenticationAttemptEvent;
TSSHAuthenticationAttemptEvent = procedure (Sender: TObject; AuthType : integer; AuthParam: TObject) of object;

[C++]
    void get_OnAuthenticationAttempt(TSSHAuthenticationAttemptEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnAuthenticationAttempt(TSSHAuthenticationAttemptEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSSHAuthenticationAttemptEvent)(void * _ObjectData, TObjectHandle Sender, int32_t AuthType, TObjectHandle AuthParam);

[PHP]
    TSSHAuthenticationAttemptEvent|callable|NULL get_OnAuthenticationAttempt()
    void set_OnAuthenticationAttempt(TSSHAuthenticationAttemptEvent|callable|NULL $Value)
    callable TSSHAuthenticationAttemptEvent(TObject $Sender, integer $AuthType, TObject $AuthParam)

[Java]
    TSSHAuthenticationAttemptEvent getOnAuthenticationAttempt();
    void setOnAuthenticationAttempt(TSSHAuthenticationAttemptEvent Value);
    TSSHAuthenticationAttemptEvent.Callback OnAuthenticationAttempt = new TSSHAuthenticationAttemptEvent.Callback() {
        public void TSSHAuthenticationAttemptEventCallback(TObject Sender, int AuthType, TObject AuthParam) {
            //...
        }
    }

Parameters

AuthType - type of authentication
AuthParam - parameter which is required for authentication, depending on AuthType

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 when the single authentication attempt is performed. The corresponding parameters contain the authentication type and authentication parameter, e.g., if SSH_AUTH_TYPE_PUBLICKEY authentication is specified, AuthParam will contain the key.

Discuss this help topic in SecureBlackbox Forum