TElSSHServer.OnAuthBanner event

TElSSHServer.OnAuthBanner

This event requests information that should be shown to the client.

Declaration

[C#]
event TSSHAuthBannerEvent OnAuthBanner;
delegate void TSSHAuthBannerEvent(Object Sender, string Username, int AuthType, ref string Banner, ref byte[] LanguageTag);

[VB.NET]
Event OnAuthBanner As TSSHAuthBannerEvent
Delegate Sub TSSHAuthBannerEvent(ByVal Sender As Object, ByVal Username As String, ByVal AuthType As Integer, ByRef Banner As String, ByRef LanguageTag As Byte())

[Pascal]
    property OnAuthBanner: TSSHAuthBannerEvent;

    TSSHAuthBannerEvent = procedure(Sender : TObject; const Username : string; AuthType : integer; var Banner: string; var LanguageTag : string) of object;

[C++]
    void get_OnAuthBanner(TSSHAuthBannerEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnAuthBanner(TSSHAuthBannerEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSSHAuthBannerEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcUsername, int32_t szUsername, int32_t AuthType, char * pcBanner, int32_t &szBanner, uint8_t pLanguageTag[], int32_t &szLanguageTag);

[PHP]
    TSSHAuthBannerEvent|callable|NULL get_OnAuthBanner()
    void set_OnAuthBanner(TSSHAuthBannerEvent|callable|NULL $Value)
    callable TSSHAuthBannerEvent(TObject $Sender, string $Username, integer $AuthType, string &$Banner, string &$LanguageTag)

[Java]
    TSSHAuthBannerEvent getOnAuthBanner();
    void setOnAuthBanner(TSSHAuthBannerEvent Value);
    TSSHAuthBannerEvent.Callback OnAuthBanner = new TSSHAuthBannerEvent.Callback() {
        public void TSSHAuthBannerEventCallback(TObject Sender, String Username, int AuthType, TSBString Banner, byte[] LanguageTag) {
            //...
        }
    }

Parameters

Username - the name of the client being authenticated
AuthType - the type of authentication
Banner - message text to be shown
LanguageTag - language code (see RFC1766)
pcUsername - the name of the client being authenticated
szUsername - the length of pcUsername.
pcBanner - message text to be shown
szBanner - the length of pcBanner.
pLanguageTag -
szLanguageTag - the length of pcLanguageTag.

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 when it is necessary to show some message to the client during authentication.