TElSimpleFTPSClient.OnDNSKeyNeeded event

TElSimpleFTPSClient.OnDNSKeyNeeded

This event is fired when a key is needed to verify the signature.

Declaration

[C#]
event TSBDNSKeyNeededEvent OnDNSKeyNeeded;
delegate void TSBDNSKeyNeededEvent(Object Sender, string Owner, ushort KeyTag, byte Algorithm, ref TElDNSPublicKeyRecord Key, ref bool ReleaseKey);

[VB.NET]
Event OnDNSKeyNeeded As TSBDNSKeyNeededEvent
Delegate Sub TSBDNSKeyNeededEvent(ByVal Sender As Object, ByVal Owner As String, ByVal KeyTag As UInt16, ByVal Algorithm As Byte, ByRef Key As TElDNSPublicKeyRecord, ByRef ReleaseKey As Boolean)

[Pascal]
property OnDNSKeyNeeded : TSBDNSKeyNeededEvent;
TSBDNSKeyNeededEvent = procedure (Sender: TObject; const Owner : string; KeyTag : word; Algorithm : byte; var Key : TElDNSPublicKeyRecord; var ReleaseKey : boolean) of object;

[C++]
    void get_OnDNSKeyNeeded(TSBDNSKeyNeededEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnDNSKeyNeeded(TSBDNSKeyNeededEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBDNSKeyNeededEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcOwner, int32_t szOwner, uint16_t KeyTag, uint8_t Algorithm, TElDNSPublicKeyRecordHandle &Key, int8_t &ReleaseKey);

[PHP]
    TSBDNSKeyNeededEvent|callable|NULL get_OnDNSKeyNeeded()
    void set_OnDNSKeyNeeded(TSBDNSKeyNeededEvent|callable|NULL $Value)
    callable TSBDNSKeyNeededEvent(TObject $Sender, string $Owner, integer $KeyTag, integer $Algorithm, TElDNSPublicKeyRecord &$Key, bool &$ReleaseKey)

[Java]
    TSBDNSKeyNeededEvent getOnDNSKeyNeeded();
    void setOnDNSKeyNeeded(TSBDNSKeyNeededEvent Value);
    TSBDNSKeyNeededEvent.Callback OnDNSKeyNeeded = new TSBDNSKeyNeededEvent.Callback() {
        public void TSBDNSKeyNeededEventCallback(TObject Sender, String Owner, short KeyTag, byte Algorithm, TElDNSPublicKeyRecord[] Key, TSBBoolean ReleaseKey) {
            //...
        }
    }

Parameters

Owner - specifies key owner
KeyTag - specifies key tag
Algorithm - contains signature algorithm
Key - value of the key should be provided via this parameter
ReleaseKey - set this parameter to True to release the key
pcOwner - specifies key owner
szOwner - the length of pcOwner.

Values:

[.NET] [Pascal] [C++]	Value	Description
SB_DNS_ALGORITHM_RSAMD5	1 (0x01)	RSA/MD5 (deprecated by RSA/SHA-1)
SB_DNS_ALGORITHM_DH	2 (0x02)	Diffie-Hellman
SB_DNS_ALGORITHM_DSASHA1	3 (0x03)	DSA/SHA1
SB_DNS_ALGORITHM_ECC	4 (0x04)	Elliptic Curve Cryptography
SB_DNS_ALGORITHM_RSASHA1	5 (0x05)	RSA/SHA-1
SB_DNS_ALGORITHM_DSA_NSEC3_SHA1	6 (0x06)	DSA-NSEC3-SHA1
SB_DNS_ALGORITHM_RSASHA1_NSEC3_SHA1	7 (0x07)	RSASHA1-NSEC3-SHA1
SB_DNS_ALGORITHM_RSASHA256	8 (0x08)	RSA/SHA-256
SB_DNS_ALGORITHM_RSASHA512	10 (0x0A)	RSA/SHA-512
SB_DNS_ALGORITHM_INDIRECT	252 (0xFC)	Reserved for Indirect Keys
SB_DNS_ALGORITHM_PRIVATEDNS	253 (0xFD)	Private algorithms - domain name
SB_DNS_ALGORITHM_PRIVATEOID	254 (0xFE)	Private algorithms - OID

Description

This event is fired by TElSimpleFTPSClient when a key is required to verify a signature. Provide the corresponding key record via Key parameter.

Discuss this help topic in SecureBlackbox Forum