TElSSHServer.OnAuthAttempt event

TElSSHServer.OnAuthAttempt

This event is fired when client requested possibility for authentication.

Declaration

[C#]
event TSSHAuthAttemptEvent OnAuthAttempt;
delegate void TSSHAuthAttemptEvent(Object Sender, string Username, int AuthType, ref bool Accept);

[VB.NET]
Event OnAuthAttempt As TSSHAuthAttemptEvent
Delegate Sub TSSHAuthAttemptEvent(ByVal Sender As Object, ByVal Username As String, ByVal AuthType As Integer, ByRef Accept As Boolean)

[Pascal]
    property OnAuthAttempt: TSSHAuthAttemptEvent;

    TSSHAuthAttemptEvent = procedure(Sender : TObject; const Username : string; AuthType : integer; var Accept: boolean) of object;

[C++]
    void get_OnAuthAttempt(TSSHAuthAttemptEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnAuthAttempt(TSSHAuthAttemptEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSSHAuthAttemptEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcUsername, int32_t szUsername, int32_t AuthType, int8_t &Accept);

[PHP]
    TSSHAuthAttemptEvent|callable|NULL get_OnAuthAttempt()
    void set_OnAuthAttempt(TSSHAuthAttemptEvent|callable|NULL $Value)
    callable TSSHAuthAttemptEvent(TObject $Sender, string $Username, integer $AuthType, bool &$Accept)

[Java]
    TSSHAuthAttemptEvent getOnAuthAttempt();
    void setOnAuthAttempt(TSSHAuthAttemptEvent Value);
    TSSHAuthAttemptEvent.Callback OnAuthAttempt = new TSSHAuthAttemptEvent.Callback() {
        public void TSSHAuthAttemptEventCallback(TObject Sender, String Username, int AuthType, TSBBoolean Accept) {
            //...
        }
    }

Parameters

Username - username (login) on the server
AuthType - the type of authentication that the client wants to use
Accept - set this parameter to True if you want to allow the client to use this method.Otherwise authentication attempt will fail for the client.
pcUsername - username (login) on the server
szUsername - the length of pcUsername.

Authentication type values

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 for each client's attempt to authenticate.