TElSSLClient.OnCertificateNeeded event

TElSSLClient.OnCertificateNeeded

Deprecated. Use OnCertificateNeededEx event instead.

Declaration

[C#]
event TSBCertificateNeededEvent OnCertificateNeeded;
delegate void TSBCertificateNeededEvent(Object Sender, ref byte[] CertificateBuffer, ref int CertificateSize, ref byte[] PrivateKeyBuffer, ref int PrivateKeySize, TClientCertificateType CertificateType);

[VB.NET]
Event OnCertificateNeeded As TSBCertificateNeededEvent
Delegate Sub TSBCertificateNeededEvent(ByVal Sender As Object, ByRef CertificateBuffer As Byte(), ByRef CertificateSize As Integer, ByRef PrivateKeyBuffer As Byte(), ByRef PrivateKeySize As Integer, ByVal CertificateType As TClientCertificateType)

[Pascal]
property OnCertificateNeeded : TSBCertificateNeededEvent;
TSBCertificateNeededEvent = procedure(Sender: TObject; CertificateBuffer: pointer; var CertificateSize: LongInt; PrivateKeyBuffer: pointer; var PrivateKeySize: LongInt; CertificateType : TClientCertificateType) of object;

[C++]
    void get_OnCertificateNeeded(TSBCertificateNeededEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnCertificateNeeded(TSBCertificateNeededEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBCertificateNeededEvent)(void * _ObjectData, TObjectHandle Sender, void * CertificateBuffer, int32_t &CertificateSize, void * PrivateKeyBuffer, int32_t &PrivateKeySize, TClientCertificateTypeRaw CertificateType);

[PHP]
    TSBCertificateNeededEvent|callable|NULL get_OnCertificateNeeded()
    void set_OnCertificateNeeded(TSBCertificateNeededEvent|callable|NULL $Value)
    callable TSBCertificateNeededEvent(TObject $Sender, TSBPointer|NULL $CertificateBuffer, integer &$CertificateSize, TSBPointer|NULL $PrivateKeyBuffer, integer &$PrivateKeySize, integer $CertificateType)

[Java]
    TSBCertificateNeededEvent getOnCertificateNeeded();
    void setOnCertificateNeeded(TSBCertificateNeededEvent Value);
    TSBCertificateNeededEvent.Callback OnCertificateNeeded = new TSBCertificateNeededEvent.Callback() {
        public void TSBCertificateNeededEventCallback(TObject arg0, TElCertificateNeededEventParams arg1, TClientCertificateType arg2) {
            //...
        }
    }

Parameters

CertificateBuffer - Contains a buffer for the certificate
CertificateSize - When the event handler is called, this parameter contains the size of the buffer passed via CertificateBuffer. The event handler should put the data to the buffer and return the size of the data in CertificateSize
PrivateKeyBuffer - Contains a buffer for the private key that corresponds to the given certificate
PrivateKeySize - When the event handler is called, this parameter contains the size of the buffer passed via PrivateKeyBuffer. The event handler should put the data to the buffer and return the size of the data in PrivateKeySize
CertificateType - specifies the type of certificate requested.

TClientCertificateType values:

[.NET] [C++]	[Pascal]	Description
ccRSA = 0	ccRSA	a certificate containing an RSA key
ccDSS = 1	ccDSS	a certificate containing a DSA key
ccRSADH = 2	ccRSADH	a certificate containing a static DH key
ccDSSDH = 3	ccDSSDH	a certificate containing a static DH key
ccECDSA = 4	ccECDSA	a certificate containing a ECDSA key
ccRSA_ECDH = 5	ccRSA_ECDH	a certificate with ECDH-capable public key
ccECDSA_ECDH = 6	ccECDSA_ECDH	a certificate with ECDH-capable public key

Description

This event is fired by TElSSLClient when the negotiated protocol requires a client-side X509 certificate to be used during session.

Discuss this help topic in SecureBlackbox Forum