TElCustomTSPClient.OnCertificateValidate event

TElCustomTSPClient.OnCertificateValidate

This event is fired when signing certificate of the TSP response needs validation.

Declaration

[C#]
event TSBCertificateValidationEvent OnCertificateValidate;
delegate void TSBCertificateValidationEvent(Object Sender, TElX509Certificate Certificate, TElCustomCertStorage AdditionalCertificates, ref TSBCertificateValidity Validity, ref TSBCertificateValidityReason Reason, ref bool DoContinue);

[VB.NET]
Event OnCertificateValidate As TSBCertificateValidationEvent
Delegate Sub TSBCertificateValidationEvent(ByVal Sender As Object, ByVal Certificate As TElX509Certificate, ByVal AdditionalCertificates As TElCustomCertStorage, ByRef Validity As TSBCertificateValidity, ByRef Reason As TSBCertificateValidityReason, ByRef DoContinue As Boolean)

[Pascal]
property OnCertificateValidate : TSBCertificateValidationEvent;
TSBCertificateValidationEvent = procedure (Sender: TObject; Certificate : TElX509Certificate; AdditionalCertificates : TElCustomCertStorage; var Validity : TSBCertificateValidity; var Reason : TSBCertificateValidityReason; var DoContinue : boolean) of object;

[C++]
    void get_OnCertificateValidate(TSBCertificateValidationEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnCertificateValidate(TSBCertificateValidationEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBCertificateValidationEvent)(void * _ObjectData, TObjectHandle Sender, TElX509CertificateHandle Certificate, TElCustomCertStorageHandle AdditionalCertificates, TSBCertificateValidityRaw &Validity, TSBCertificateValidityReasonRaw &Reason, int8_t &DoContinue);

[PHP]
    TSBCertificateValidationEvent|callable|NULL get_OnCertificateValidate()
    void set_OnCertificateValidate(TSBCertificateValidationEvent|callable|NULL $Value)
    callable TSBCertificateValidationEvent(TObject $Sender, TElX509Certificate $Certificate, TElCustomCertStorage $AdditionalCertificates, integer &$Validity, integer &$Reason, bool &$DoContinue)

[Java]
    TSBCertificateValidationEvent getOnCertificateValidate();
    void setOnCertificateValidate(TSBCertificateValidationEvent Value);
    TSBCertificateValidationEvent.Callback OnCertificateValidate = new TSBCertificateValidationEvent.Callback() {
        public void TSBCertificateValidationEventCallback(TObject arg0, TElX509Certificate arg1, TElCustomCertStorage arg2, TElCertificateValidationEventParams arg3) {
            //...
        }
    }

Parameters

Certificate - the certificate that is being validated.
AdditionalCertificates - additional certificates.
Validity - certificate validity.
Reason - certificate invalidity reason.
DoContinue - specifies, whether to continue even if validation failed.

Certificate validity values:

[.NET] [C++]	[Pascal]	Description
cvOk = 0	cvOk	Certificate was validated successfully and is valid
cvSelfSigned = 1	cvSelfSigned	Certificate is self signed
cvInvalid = 2	cvInvalid	Certificate is invalid
cvStorageError = 3	cvStorageError	Certificate was not validated due to certificate storage error
cvChainUnvalidated = 4	cvChainUnvalidated	Certificate chain was not validated because while the certificate itself is valid, one or more of CA Certificates in the chain have validation problems

Certificate validity reasons:

[.NET]	[Pascal]	[C++]	Description
vrBadData = 1	vrBadData	f_vrBadData = 1	Invalid certificate format or certificate is corrupted
vrRevoked = 2	vrRevoked	f_vrRevoked = 2	Certificate is revoked by Issuer
vrNotYetValid = 4	vrNotYetValid	f_vrNotYetValid = 4	Certificate is not valid yet
vrExpired = 8	vrExpired	f_vrExpired = 8	Certificate is expired
vrInvalidSignature = 16	vrInvalidSignature	f_vrInvalidSignature = 16	Certificate contains invalid digital signature, it could be corrupted
vrUnknownCA = 32	vrUnknownCA	f_vrUnknownCA = 32	Issuer (CA) certificate was not found.
vrCAUnauthorized = 64	vrCAUnauthorized	f_vrCAUnauthorized = 64	Issuer (CA) certificate was found but its key usage fields don't allow use of this certificate for signing other certificates.
vrCRLNotVerified = 128	vrCRLNotVerified	f_vrCRLNotVerified = 128	Certificate Revocation List for this certificate could not be retrieved and/or validated.
vrOCSPNotVerified = 256	vrOCSPNotVerified	f_vrOCSPNotVerified = 256	OCSP response for this certificate could not be retrieved and/or validated.
vrIdentityMismatch = 512	vrIdentityMismatch	f_vrIdentityMismatch = 512	Provided certificate doesn't include the specified name and / or IP address. Either the remote side in TLS or sender in S/MIME is misconfigured, or the certificate is misused by the remote side or sender, or authenticity of the remote side or sender is forged.
vrNoKeyUsage = 1024	vrNoKeyUsage	f_vrNoKeyUsage = 1024	Provided certificate may not be used for chosen activity (identifying TLS server or client or S/MIME message sender)
vrBlocked = 2048	vrBlocked	f_vrBlocked = 2048	Provided certificate has been found in the list of blocked certificates
vrFailure = 4096	vrFailure	f_vrFailure = 4096	Validation took too long, aborted
vrChainLoop = 8192	vrChainLoop	f_vrChainLoop = 8192	Certificate chain includes a loop. Further validation is not possible.
vrWeakAlgorithm = 16384	vrWeakAlgorithm	f_vrWeakAlgorithm = 16384	One of certificates is signed using the weak hash algorithm

Description

This event is fired, when signed TSP response is received from the server, and a signing certificate is included to the response. The application must validate the certificate and specify validation results via Validity and Reason parameters.

Discuss this help topic in SecureBlackbox Forum