AuthenticodeVerifier Class
Properties Methods Events Config Settings Errors
The AuthenticodeVerifier class verifies digital signatures over executable files (EXE) and dynamically linked libraries (DLL).
Syntax
AuthenticodeVerifier
Remarks
Use this component to verify signatures created over executable files.
AuthenticodeVerifier verifier = new AuthenticodeVerifier();
// Select the file which contains the executable that is timestamped
verifier.setInputFile("signedExecutable.exe");
verifier.verify(); // Verify
System.out.println("Validation result: " + verifier.getSignatureValidationResult() +
"Signing time: " + verifier.getValidatedSigningTime() +
"TSA Certificate: " + verifier.getSigningCertificate().getSubjectRDN());
// Validation result: 0 // 0 == svtValid
// Signing time: 2024-05-17 12:37:24
// TSA Certificate: /CN=Test Certificate
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
ActualChecksum | Returns the executable's checksum computed during signature verification. |
AllSignaturesValid | The cumulative validity of all signatures. |
BlockedCertificates | The certificates that must be rejected as trust anchors. |
Certificates | A collection of certificates included in the electronic signature. |
CRLs | A collection of certificate revocation lists embedded into the signature by the signer. |
FIPSMode | Reserved. |
IgnoreChainValidationErrors | Makes the class tolerant to chain validation errors. |
InputBytes | Use this property to pass the input to class in byte array form. |
InputFile | A path to the signed executable. |
KnownCertificates | Additional certificates for chain validation. |
KnownCRLs | Additional CRLs for chain validation. |
KnownOCSPs | Additional OCSP responses for chain validation. |
OCSPs | A collection of OCSP responses embedded into the signature. |
OfflineMode | Switches the class to offline mode. |
Profile | Specifies a pre-defined profile to apply when creating the signature. |
Proxy | The proxy server settings. |
RevocationCheck | Specifies the kind(s) of revocation check to perform for all chain certificates. |
Signature | Contains the signature which is currently being validated. |
Signed | Indicates whether the executable is signed. |
SignedAttributes | Custom signature attributes that are covered by the electronic signature. |
SigningCertificate | The certificate of the signature creator. |
SocketSettings | Manages network connection settings. |
SpecifiedChecksum | Returns the checksum of the executable. |
Timestamp | Contains the timestamp which is being validated. |
Timestamped | Indicates whether or not the signature is timestamped. |
TLSClientChain | The TLS client certificate chain. |
TLSServerChain | The TLS server's certificate chain. |
TLSSettings | Manages TLS layer settings. |
TrustedCertificates | A list of trusted certificates for chain validation. |
TSACertificate | The certificate of the Time Stamping Authority. |
UnsignedAttributes | Custom unsigned attributes included in the electronic signature. |
ValidationMoment | The time point at which signature validity is to be established. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
Reset | Resets the class settings. |
Verify | Verifies a digitally signed executable. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
ChainElementDownload | Fires when there is a need to download a chain element from an online source. |
ChainElementNeeded | Fires when an element required to validate the chain was not located. |
ChainValidated | Reports the completion of a certificate chain validation. |
ChainValidationProgress | This event is fired multiple times during chain validation to report various stages of the validation procedure. |
Error | Information about errors during ASiC signature verification. |
Notification | This event notifies the application about an underlying control flow event. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Marks the completion of the signature validation routine. |
TimestampFound | Signifies the start of a timestamp validation routine. |
TimestampValidated | Reports the completion of the timestamp validation routine. |
TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
TLSShutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
BufferSize | Specifies buffer size in bytes. |
ChainCurrentCACert | Returns the current CA certificate. |
ChainCurrentCert | Returns the certificate that is currently being validated. |
ChainCurrentCRL | Returns the current CRL. |
ChainCurrentCRLSize | Returns the size of the current CRL. |
ChainCurrentOCSP | Returns the current OCSP response. |
ChainCurrentOCSPSigner | Returns the signer of the current OCSP object. |
ChainInterimDetails | Returns the current interim validation details. |
ChainInterimResult | Returns the current interim validation result. |
CheckValidityPeriodForTrusted | Whether to check validity period for trusted certificates. |
DelayVerification | Specifies whether signatures validation should be delayed. |
DislikeOpenEndedOCSPs | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. |
ForceCompleteChainValidation | Whether to check the CA certificates when the signing certificate is invalid. |
ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
GracePeriod | Specifies a grace period to apply during revocation information checks. |
IgnoreChainLoops | Whether chain loops should be ignored. |
IgnoreOCSPNoCheckExtension | Whether the OCSP NoCheck extension should be ignored. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
SignatureCount | Returns the number of signatures in the executable. |
TempPath | Path for storing temporary files. |
TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
TLSValidationLog | Contains the log of the TLS server certificate validation. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
UseValidatorSettingsForTLSValidation | Whether to employ the primary chain validator setup for auxiliary TLS chain validations. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
ActualChecksum Property (AuthenticodeVerifier Class)
Returns the executable's checksum computed during signature verification.
Syntax
ANSI (Cross Platform) int GetActualChecksum(); Unicode (Windows) INT GetActualChecksum();
int secureblackbox_authenticodeverifier_getactualchecksum(void* lpObj);
int GetActualChecksum();
Default Value
0
Remarks
Use this property to get the actual checksum of the executable.
This property is read-only and not available at design time.
Data Type
Integer
AllSignaturesValid Property (AuthenticodeVerifier Class)
The cumulative validity of all signatures.
Syntax
ANSI (Cross Platform) int GetAllSignaturesValid(); Unicode (Windows) BOOL GetAllSignaturesValid();
int secureblackbox_authenticodeverifier_getallsignaturesvalid(void* lpObj);
bool GetAllSignaturesValid();
Default Value
FALSE
Remarks
Use this property to check if all the signatures found in the message or document are valid.
This property is read-only and not available at design time.
Data Type
Boolean
BlockedCertificates Property (AuthenticodeVerifier Class)
The certificates that must be rejected as trust anchors.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates(); int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_authenticodeverifier_getblockedcertcount(void* lpObj);
int secureblackbox_authenticodeverifier_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int secureblackbox_authenticodeverifier_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
int64 secureblackbox_authenticodeverifier_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_authenticodeverifier_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount); QByteArray GetBlockedCertBytes(int iBlockedCertIndex); qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);
Remarks
Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.
This property is not available at design time.
Data Type
Certificates Property (AuthenticodeVerifier Class)
A collection of certificates included in the electronic signature.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetCertificates();
int secureblackbox_authenticodeverifier_getcertcount(void* lpObj);
int secureblackbox_authenticodeverifier_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);
int secureblackbox_authenticodeverifier_getcertca(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertcakeyid(void* lpObj, int certindex, char** lpCertCAKeyID, int* lenCertCAKeyID);
int secureblackbox_authenticodeverifier_getcertcerttype(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertcrldistributionpoints(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertcurve(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertfingerprint(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertfriendlyname(void* lpObj, int certindex);
int64 secureblackbox_authenticodeverifier_getcerthandle(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcerthashalgorithm(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertissuer(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertissuerrdn(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertkeyalgorithm(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertkeybits(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertkeyfingerprint(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertkeyusage(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertkeyvalid(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertocsplocations(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertocspnocheck(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertorigin(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertpolicyids(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertprivatekeybytes(void* lpObj, int certindex, char** lpCertPrivateKeyBytes, int* lenCertPrivateKeyBytes);
int secureblackbox_authenticodeverifier_getcertprivatekeyexists(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertprivatekeyextractable(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertpublickeybytes(void* lpObj, int certindex, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);
int secureblackbox_authenticodeverifier_getcertqualified(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertqualifiedstatements(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertqualifiers(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertselfsigned(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertserialnumber(void* lpObj, int certindex, char** lpCertSerialNumber, int* lenCertSerialNumber);
char* secureblackbox_authenticodeverifier_getcertsigalgorithm(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertsource(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertsubject(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertsubjectalternativename(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertsubjectkeyid(void* lpObj, int certindex, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
char* secureblackbox_authenticodeverifier_getcertsubjectrdn(void* lpObj, int certindex);
int secureblackbox_authenticodeverifier_getcertvalid(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertvalidfrom(void* lpObj, int certindex);
char* secureblackbox_authenticodeverifier_getcertvalidto(void* lpObj, int certindex);
int GetCertCount(); QByteArray GetCertBytes(int iCertIndex); bool GetCertCA(int iCertIndex); QByteArray GetCertCAKeyID(int iCertIndex); int GetCertCertType(int iCertIndex); QString GetCertCRLDistributionPoints(int iCertIndex); QString GetCertCurve(int iCertIndex); QString GetCertFingerprint(int iCertIndex); QString GetCertFriendlyName(int iCertIndex); qint64 GetCertHandle(int iCertIndex); QString GetCertHashAlgorithm(int iCertIndex); QString GetCertIssuer(int iCertIndex); QString GetCertIssuerRDN(int iCertIndex); QString GetCertKeyAlgorithm(int iCertIndex); int GetCertKeyBits(int iCertIndex); QString GetCertKeyFingerprint(int iCertIndex); int GetCertKeyUsage(int iCertIndex); bool GetCertKeyValid(int iCertIndex); QString GetCertOCSPLocations(int iCertIndex); bool GetCertOCSPNoCheck(int iCertIndex); int GetCertOrigin(int iCertIndex); QString GetCertPolicyIDs(int iCertIndex); QByteArray GetCertPrivateKeyBytes(int iCertIndex); bool GetCertPrivateKeyExists(int iCertIndex); bool GetCertPrivateKeyExtractable(int iCertIndex); QByteArray GetCertPublicKeyBytes(int iCertIndex); bool GetCertQualified(int iCertIndex); int GetCertQualifiedStatements(int iCertIndex); QString GetCertQualifiers(int iCertIndex); bool GetCertSelfSigned(int iCertIndex); QByteArray GetCertSerialNumber(int iCertIndex); QString GetCertSigAlgorithm(int iCertIndex); int GetCertSource(int iCertIndex); QString GetCertSubject(int iCertIndex); QString GetCertSubjectAlternativeName(int iCertIndex); QByteArray GetCertSubjectKeyID(int iCertIndex); QString GetCertSubjectRDN(int iCertIndex); bool GetCertValid(int iCertIndex); QString GetCertValidFrom(int iCertIndex); QString GetCertValidTo(int iCertIndex);
Remarks
This property includes a collection of certificates of the currently selected info.
This property is read-only and not available at design time.
Data Type
CRLs Property (AuthenticodeVerifier Class)
A collection of certificate revocation lists embedded into the signature by the signer.
Syntax
SecureBlackboxList<SecureBlackboxCRL>* GetCRLs();
int secureblackbox_authenticodeverifier_getcrlcount(void* lpObj);
int secureblackbox_authenticodeverifier_getcrlbytes(void* lpObj, int crlindex, char** lpCRLBytes, int* lenCRLBytes);
int secureblackbox_authenticodeverifier_getcrlcakeyid(void* lpObj, int crlindex, char** lpCRLCAKeyID, int* lenCRLCAKeyID);
int secureblackbox_authenticodeverifier_getcrlentrycount(void* lpObj, int crlindex);
int64 secureblackbox_authenticodeverifier_getcrlhandle(void* lpObj, int crlindex);
char* secureblackbox_authenticodeverifier_getcrlissuer(void* lpObj, int crlindex);
char* secureblackbox_authenticodeverifier_getcrlissuerrdn(void* lpObj, int crlindex);
char* secureblackbox_authenticodeverifier_getcrllocation(void* lpObj, int crlindex);
char* secureblackbox_authenticodeverifier_getcrlnextupdate(void* lpObj, int crlindex);
char* secureblackbox_authenticodeverifier_getcrlsigalgorithm(void* lpObj, int crlindex);
int secureblackbox_authenticodeverifier_getcrlsource(void* lpObj, int crlindex);
int secureblackbox_authenticodeverifier_getcrltbs(void* lpObj, int crlindex, char** lpCRLTBS, int* lenCRLTBS);
char* secureblackbox_authenticodeverifier_getcrlthisupdate(void* lpObj, int crlindex);
int GetCRLCount(); QByteArray GetCRLBytes(int iCRLIndex); QByteArray GetCRLCAKeyID(int iCRLIndex); int GetCRLEntryCount(int iCRLIndex); qint64 GetCRLHandle(int iCRLIndex); QString GetCRLIssuer(int iCRLIndex); QString GetCRLIssuerRDN(int iCRLIndex); QString GetCRLLocation(int iCRLIndex); QString GetCRLNextUpdate(int iCRLIndex); QString GetCRLSigAlgorithm(int iCRLIndex); int GetCRLSource(int iCRLIndex); QByteArray GetCRLTBS(int iCRLIndex); QString GetCRLThisUpdate(int iCRLIndex);
Remarks
Use this property to access the CRLs embedded into the signature by the signer.
This property is read-only and not available at design time.
Data Type
FIPSMode Property (AuthenticodeVerifier Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_authenticodeverifier_getfipsmode(void* lpObj);
int secureblackbox_authenticodeverifier_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
FALSE
Remarks
This property is reserved for future use.
Data Type
Boolean
IgnoreChainValidationErrors Property (AuthenticodeVerifier Class)
Makes the class tolerant to chain validation errors.
Syntax
ANSI (Cross Platform) int GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(int bIgnoreChainValidationErrors); Unicode (Windows) BOOL GetIgnoreChainValidationErrors();
INT SetIgnoreChainValidationErrors(BOOL bIgnoreChainValidationErrors);
int secureblackbox_authenticodeverifier_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_authenticodeverifier_setignorechainvalidationerrors(void* lpObj, int bIgnoreChainValidationErrors);
bool GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(bool bIgnoreChainValidationErrors);
Default Value
FALSE
Remarks
If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.
Data Type
Boolean
InputBytes Property (AuthenticodeVerifier Class)
Use this property to pass the input to class in byte array form.
Syntax
ANSI (Cross Platform) int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes); Unicode (Windows) INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);
int secureblackbox_authenticodeverifier_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_authenticodeverifier_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);
QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);
Remarks
Assign a byte array containing the data to be processed to this property.
This property is not available at design time.
Data Type
Byte Array
InputFile Property (AuthenticodeVerifier Class)
A path to the signed executable.
Syntax
ANSI (Cross Platform) char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* secureblackbox_authenticodeverifier_getinputfile(void* lpObj);
int secureblackbox_authenticodeverifier_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
A path to the file containing the signed executable. The input can alternatively be provided via InputStream.
Data Type
String
KnownCertificates Property (AuthenticodeVerifier Class)
Additional certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates(); int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_authenticodeverifier_getknowncertcount(void* lpObj);
int secureblackbox_authenticodeverifier_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_authenticodeverifier_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_authenticodeverifier_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_authenticodeverifier_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); QByteArray GetKnownCertBytes(int iKnownCertIndex); qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);
Remarks
Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.
The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.
Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.
This property is not available at design time.
Data Type
KnownCRLs Property (AuthenticodeVerifier Class)
Additional CRLs for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs(); int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);
int secureblackbox_authenticodeverifier_getknowncrlcount(void* lpObj);
int secureblackbox_authenticodeverifier_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int secureblackbox_authenticodeverifier_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
int64 secureblackbox_authenticodeverifier_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_authenticodeverifier_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount); QByteArray GetKnownCRLBytes(int iKnownCRLIndex); qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);
Remarks
Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.
This property is not available at design time.
Data Type
KnownOCSPs Property (AuthenticodeVerifier Class)
Additional OCSP responses for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxOCSPResponse>* GetKnownOCSPs(); int SetKnownOCSPs(SecureBlackboxList<SecureBlackboxOCSPResponse>* val);
int secureblackbox_authenticodeverifier_getknownocspcount(void* lpObj);
int secureblackbox_authenticodeverifier_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int secureblackbox_authenticodeverifier_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
int64 secureblackbox_authenticodeverifier_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_authenticodeverifier_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount); QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex); qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);
Remarks
Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.
This property is not available at design time.
Data Type
OCSPs Property (AuthenticodeVerifier Class)
A collection of OCSP responses embedded into the signature.
Syntax
SecureBlackboxList<SecureBlackboxOCSPResponse>* GetOCSPs();
int secureblackbox_authenticodeverifier_getocspcount(void* lpObj);
int secureblackbox_authenticodeverifier_getocspbytes(void* lpObj, int ocspindex, char** lpOCSPBytes, int* lenOCSPBytes);
int secureblackbox_authenticodeverifier_getocspentrycount(void* lpObj, int ocspindex);
int64 secureblackbox_authenticodeverifier_getocsphandle(void* lpObj, int ocspindex);
char* secureblackbox_authenticodeverifier_getocspissuer(void* lpObj, int ocspindex);
char* secureblackbox_authenticodeverifier_getocspissuerrdn(void* lpObj, int ocspindex);
char* secureblackbox_authenticodeverifier_getocsplocation(void* lpObj, int ocspindex);
char* secureblackbox_authenticodeverifier_getocspproducedat(void* lpObj, int ocspindex);
char* secureblackbox_authenticodeverifier_getocspsigalgorithm(void* lpObj, int ocspindex);
int secureblackbox_authenticodeverifier_getocspsource(void* lpObj, int ocspindex);
int GetOCSPCount(); QByteArray GetOCSPBytes(int iOCSPIndex); int GetOCSPEntryCount(int iOCSPIndex); qint64 GetOCSPHandle(int iOCSPIndex); QString GetOCSPIssuer(int iOCSPIndex); QString GetOCSPIssuerRDN(int iOCSPIndex); QString GetOCSPLocation(int iOCSPIndex); QString GetOCSPProducedAt(int iOCSPIndex); QString GetOCSPSigAlgorithm(int iOCSPIndex); int GetOCSPSource(int iOCSPIndex);
Remarks
Use this property to access the OCSP responses embedded into the signature by its creator.
This property is read-only and not available at design time.
Data Type
OfflineMode Property (AuthenticodeVerifier Class)
Switches the class to offline mode.
Syntax
ANSI (Cross Platform) int GetOfflineMode();
int SetOfflineMode(int bOfflineMode); Unicode (Windows) BOOL GetOfflineMode();
INT SetOfflineMode(BOOL bOfflineMode);
int secureblackbox_authenticodeverifier_getofflinemode(void* lpObj);
int secureblackbox_authenticodeverifier_setofflinemode(void* lpObj, int bOfflineMode);
bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);
Default Value
FALSE
Remarks
When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.
Data Type
Boolean
Profile Property (AuthenticodeVerifier Class)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
ANSI (Cross Platform) char* GetProfile();
int SetProfile(const char* lpszProfile); Unicode (Windows) LPWSTR GetProfile();
INT SetProfile(LPCWSTR lpszProfile);
char* secureblackbox_authenticodeverifier_getprofile(void* lpObj);
int secureblackbox_authenticodeverifier_setprofile(void* lpObj, const char* lpszProfile);
QString GetProfile();
int SetProfile(QString qsProfile);
Default Value
""
Remarks
Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.
Data Type
String
Proxy Property (AuthenticodeVerifier Class)
The proxy server settings.
Syntax
SecureBlackboxProxySettings* GetProxy();
char* secureblackbox_authenticodeverifier_getproxyaddress(void* lpObj);
int secureblackbox_authenticodeverifier_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
int secureblackbox_authenticodeverifier_getproxyauthentication(void* lpObj);
int secureblackbox_authenticodeverifier_setproxyauthentication(void* lpObj, int iProxyAuthentication);
char* secureblackbox_authenticodeverifier_getproxypassword(void* lpObj);
int secureblackbox_authenticodeverifier_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int secureblackbox_authenticodeverifier_getproxyport(void* lpObj);
int secureblackbox_authenticodeverifier_setproxyport(void* lpObj, int iProxyPort);
int secureblackbox_authenticodeverifier_getproxyproxytype(void* lpObj);
int secureblackbox_authenticodeverifier_setproxyproxytype(void* lpObj, int iProxyProxyType);
char* secureblackbox_authenticodeverifier_getproxyrequestheaders(void* lpObj);
int secureblackbox_authenticodeverifier_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
char* secureblackbox_authenticodeverifier_getproxyresponsebody(void* lpObj);
int secureblackbox_authenticodeverifier_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
char* secureblackbox_authenticodeverifier_getproxyresponseheaders(void* lpObj);
int secureblackbox_authenticodeverifier_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
int secureblackbox_authenticodeverifier_getproxyuseipv6(void* lpObj);
int secureblackbox_authenticodeverifier_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
char* secureblackbox_authenticodeverifier_getproxyusername(void* lpObj);
int secureblackbox_authenticodeverifier_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress); int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders); QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody); QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders); bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6); QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Remarks
Use this property to tune up the proxy server settings.
This property is read-only.
Data Type
RevocationCheck Property (AuthenticodeVerifier Class)
Specifies the kind(s) of revocation check to perform for all chain certificates.
Syntax
ANSI (Cross Platform) int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck); Unicode (Windows) INT GetRevocationCheck();
INT SetRevocationCheck(INT iRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
int secureblackbox_authenticodeverifier_getrevocationcheck(void* lpObj);
int secureblackbox_authenticodeverifier_setrevocationcheck(void* lpObj, int iRevocationCheck);
int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);
Default Value
1
Remarks
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
Data Type
Integer
Signature Property (AuthenticodeVerifier Class)
Contains the signature which is currently being validated.
Syntax
SecureBlackboxAuthenticodeSignature* GetSignature();
int secureblackbox_authenticodeverifier_getsigchainvalidationdetails(void* lpObj);
int secureblackbox_authenticodeverifier_getsigchainvalidationresult(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigclaimedsigningtime(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigdescription(void* lpObj);
int secureblackbox_authenticodeverifier_getsigerrorcode(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigerrormessage(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigfilehashalgorithm(void* lpObj);
int64 secureblackbox_authenticodeverifier_getsighandle(void* lpObj);
char* secureblackbox_authenticodeverifier_getsighashalgorithm(void* lpObj);
int secureblackbox_authenticodeverifier_getsigsignaturebytes(void* lpObj, char** lpSigSignatureBytes, int* lenSigSignatureBytes);
int secureblackbox_authenticodeverifier_getsigsignaturevalidationresult(void* lpObj);
int secureblackbox_authenticodeverifier_getsigstatementtype(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigurl(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigvalidatedsigningtime(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigvalidationlog(void* lpObj);
int GetSigChainValidationDetails(); int GetSigChainValidationResult(); QString GetSigClaimedSigningTime(); QString GetSigDescription(); int GetSigErrorCode(); QString GetSigErrorMessage(); QString GetSigFileHashAlgorithm(); qint64 GetSigHandle(); QString GetSigHashAlgorithm(); QByteArray GetSigSignatureBytes(); int GetSigSignatureValidationResult(); int GetSigStatementType(); QString GetSigURL(); QString GetSigValidatedSigningTime(); QString GetSigValidationLog();
Remarks
Use this property to access the signature which is currently being validated.
This information is available in the SignatureValidated event handler and provides the validated signature details.
Also, this property provides details about the last validated signature after the Verify method call.
This property is read-only and not available at design time.
Data Type
SecureBlackboxAuthenticodeSignature
Signed Property (AuthenticodeVerifier Class)
Indicates whether the executable is signed.
Syntax
ANSI (Cross Platform) int GetSigned(); Unicode (Windows) BOOL GetSigned();
int secureblackbox_authenticodeverifier_getsigned(void* lpObj);
bool GetSigned();
Default Value
FALSE
Remarks
Check this property after calling Verify to find out whether or not the provided executable is signed.
This property is read-only and not available at design time.
Data Type
Boolean
SignedAttributes Property (AuthenticodeVerifier Class)
Custom signature attributes that are covered by the electronic signature.
Syntax
SecureBlackboxList<SecureBlackboxSignatureAttribute>* GetSignedAttributes();
int secureblackbox_authenticodeverifier_getsignedattributecount(void* lpObj);
char* secureblackbox_authenticodeverifier_getsignedattributeoid(void* lpObj, int signedattributeindex);
int secureblackbox_authenticodeverifier_getsignedattributevalue(void* lpObj, int signedattributeindex, char** lpSignedAttributeValue, int* lenSignedAttributeValue);
int GetSignedAttributeCount(); QString GetSignedAttributeOID(int iSignedAttributeIndex); QByteArray GetSignedAttributeValue(int iSignedAttributeIndex);
Remarks
Signature attributes are used to store auxiliary information in the signature. Values included as signed attributes are covered by the signature.
This property is read-only and not available at design time.
Data Type
SecureBlackboxSignatureAttribute
SigningCertificate Property (AuthenticodeVerifier Class)
The certificate of the signature creator.
Syntax
SecureBlackboxCertificate* GetSigningCertificate();
int secureblackbox_authenticodeverifier_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);
int secureblackbox_authenticodeverifier_getsigningcertca(void* lpObj);
int secureblackbox_authenticodeverifier_getsigningcertcakeyid(void* lpObj, char** lpSigningCertCAKeyID, int* lenSigningCertCAKeyID);
char* secureblackbox_authenticodeverifier_getsigningcertcrldistributionpoints(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertcurve(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertfingerprint(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertfriendlyname(void* lpObj);
int64 secureblackbox_authenticodeverifier_getsigningcerthandle(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcerthashalgorithm(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertissuer(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertissuerrdn(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertkeyalgorithm(void* lpObj);
int secureblackbox_authenticodeverifier_getsigningcertkeybits(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertkeyfingerprint(void* lpObj);
int secureblackbox_authenticodeverifier_getsigningcertkeyusage(void* lpObj);
int secureblackbox_authenticodeverifier_getsigningcertkeyvalid(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertocsplocations(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertpolicyids(void* lpObj);
int secureblackbox_authenticodeverifier_getsigningcertpublickeybytes(void* lpObj, char** lpSigningCertPublicKeyBytes, int* lenSigningCertPublicKeyBytes);
int secureblackbox_authenticodeverifier_getsigningcertselfsigned(void* lpObj);
int secureblackbox_authenticodeverifier_getsigningcertserialnumber(void* lpObj, char** lpSigningCertSerialNumber, int* lenSigningCertSerialNumber);
char* secureblackbox_authenticodeverifier_getsigningcertsigalgorithm(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertsubject(void* lpObj);
int secureblackbox_authenticodeverifier_getsigningcertsubjectkeyid(void* lpObj, char** lpSigningCertSubjectKeyID, int* lenSigningCertSubjectKeyID);
char* secureblackbox_authenticodeverifier_getsigningcertsubjectrdn(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertvalidfrom(void* lpObj);
char* secureblackbox_authenticodeverifier_getsigningcertvalidto(void* lpObj);
QByteArray GetSigningCertBytes(); bool GetSigningCertCA(); QByteArray GetSigningCertCAKeyID(); QString GetSigningCertCRLDistributionPoints(); QString GetSigningCertCurve(); QString GetSigningCertFingerprint(); QString GetSigningCertFriendlyName(); qint64 GetSigningCertHandle(); QString GetSigningCertHashAlgorithm(); QString GetSigningCertIssuer(); QString GetSigningCertIssuerRDN(); QString GetSigningCertKeyAlgorithm(); int GetSigningCertKeyBits(); QString GetSigningCertKeyFingerprint(); int GetSigningCertKeyUsage(); bool GetSigningCertKeyValid(); QString GetSigningCertOCSPLocations(); QString GetSigningCertPolicyIDs(); QByteArray GetSigningCertPublicKeyBytes(); bool GetSigningCertSelfSigned(); QByteArray GetSigningCertSerialNumber(); QString GetSigningCertSigAlgorithm(); QString GetSigningCertSubject(); QByteArray GetSigningCertSubjectKeyID(); QString GetSigningCertSubjectRDN(); QString GetSigningCertValidFrom(); QString GetSigningCertValidTo();
Remarks
Use this property to access the certificate that was used to create the signature.
This property is read-only and not available at design time.
Data Type
SocketSettings Property (AuthenticodeVerifier Class)
Manages network connection settings.
Syntax
SecureBlackboxSocketSettings* GetSocketSettings();
int secureblackbox_authenticodeverifier_getsocketdnsmode(void* lpObj);
int secureblackbox_authenticodeverifier_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int secureblackbox_authenticodeverifier_getsocketdnsport(void* lpObj);
int secureblackbox_authenticodeverifier_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int secureblackbox_authenticodeverifier_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_authenticodeverifier_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
char* secureblackbox_authenticodeverifier_getsocketdnsservers(void* lpObj);
int secureblackbox_authenticodeverifier_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
int secureblackbox_authenticodeverifier_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_authenticodeverifier_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int secureblackbox_authenticodeverifier_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_authenticodeverifier_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_authenticodeverifier_getsocketlocaladdress(void* lpObj);
int secureblackbox_authenticodeverifier_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_authenticodeverifier_getsocketlocalport(void* lpObj);
int secureblackbox_authenticodeverifier_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_authenticodeverifier_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_authenticodeverifier_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_authenticodeverifier_getsockettimeout(void* lpObj);
int secureblackbox_authenticodeverifier_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_authenticodeverifier_getsocketuseipv6(void* lpObj);
int secureblackbox_authenticodeverifier_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers); int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
Data Type
SpecifiedChecksum Property (AuthenticodeVerifier Class)
Returns the checksum of the executable.
Syntax
ANSI (Cross Platform) int GetSpecifiedChecksum(); Unicode (Windows) INT GetSpecifiedChecksum();
int secureblackbox_authenticodeverifier_getspecifiedchecksum(void* lpObj);
int GetSpecifiedChecksum();
Default Value
0
Remarks
Use this property to get the checksum of the executable as included by the signer.
This property is read-only and not available at design time.
Data Type
Integer
Timestamp Property (AuthenticodeVerifier Class)
Contains the timestamp which is being validated.
Syntax
SecureBlackboxTimestampInfo* GetTimestamp();
int64 secureblackbox_authenticodeverifier_gettimestampaccuracy(void* lpObj);
int secureblackbox_authenticodeverifier_gettimestampbytes(void* lpObj, char** lpTimestampBytes, int* lenTimestampBytes);
int secureblackbox_authenticodeverifier_gettimestampcertificateindex(void* lpObj);
int secureblackbox_authenticodeverifier_gettimestampchainvalidationdetails(void* lpObj);
int secureblackbox_authenticodeverifier_gettimestampchainvalidationresult(void* lpObj);
int secureblackbox_authenticodeverifier_gettimestampcontainslongterminfo(void* lpObj);
char* secureblackbox_authenticodeverifier_gettimestampentitylabel(void* lpObj);
char* secureblackbox_authenticodeverifier_gettimestamphashalgorithm(void* lpObj);
char* secureblackbox_authenticodeverifier_gettimestampparententity(void* lpObj);
int secureblackbox_authenticodeverifier_gettimestampserialnumber(void* lpObj, char** lpTimestampSerialNumber, int* lenTimestampSerialNumber);
char* secureblackbox_authenticodeverifier_gettimestamptime(void* lpObj);
int secureblackbox_authenticodeverifier_gettimestamptimestamptype(void* lpObj);
char* secureblackbox_authenticodeverifier_gettimestamptsaname(void* lpObj);
char* secureblackbox_authenticodeverifier_gettimestampvalidationlog(void* lpObj);
int secureblackbox_authenticodeverifier_gettimestampvalidationresult(void* lpObj);
qint64 GetTimestampAccuracy(); QByteArray GetTimestampBytes(); int GetTimestampCertificateIndex(); int GetTimestampChainValidationDetails(); int GetTimestampChainValidationResult(); bool GetTimestampContainsLongTermInfo(); QString GetTimestampEntityLabel(); QString GetTimestampHashAlgorithm(); QString GetTimestampParentEntity(); QByteArray GetTimestampSerialNumber(); QString GetTimestampTime(); int GetTimestampTimestampType(); QString GetTimestampTSAName(); QString GetTimestampValidationLog(); int GetTimestampValidationResult();
Remarks
Use this property to access the timestamp which is currently being validated.
This property is read-only and not available at design time.
Data Type
Timestamped Property (AuthenticodeVerifier Class)
Indicates whether or not the signature is timestamped.
Syntax
ANSI (Cross Platform) int GetTimestamped(); Unicode (Windows) BOOL GetTimestamped();
int secureblackbox_authenticodeverifier_gettimestamped(void* lpObj);
bool GetTimestamped();
Default Value
FALSE
Remarks
This property returns True if the signature is timestamped, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
TLSClientChain Property (AuthenticodeVerifier Class)
The TLS client certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain(); int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_authenticodeverifier_gettlsclientcertcount(void* lpObj);
int secureblackbox_authenticodeverifier_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);
int secureblackbox_authenticodeverifier_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);
int64 secureblackbox_authenticodeverifier_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_authenticodeverifier_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount); QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex); qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);
Remarks
Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.
Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.
This property is not available at design time.
Data Type
TLSServerChain Property (AuthenticodeVerifier Class)
The TLS server's certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int secureblackbox_authenticodeverifier_gettlsservercertcount(void* lpObj);
int secureblackbox_authenticodeverifier_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
char* secureblackbox_authenticodeverifier_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex);
int64 secureblackbox_authenticodeverifier_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
char* secureblackbox_authenticodeverifier_gettlsservercertissuer(void* lpObj, int tlsservercertindex);
char* secureblackbox_authenticodeverifier_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_authenticodeverifier_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);
int secureblackbox_authenticodeverifier_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);
int secureblackbox_authenticodeverifier_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);
int secureblackbox_authenticodeverifier_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);
int secureblackbox_authenticodeverifier_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);
char* secureblackbox_authenticodeverifier_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);
char* secureblackbox_authenticodeverifier_gettlsservercertsubject(void* lpObj, int tlsservercertindex);
char* secureblackbox_authenticodeverifier_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_authenticodeverifier_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);
char* secureblackbox_authenticodeverifier_gettlsservercertvalidto(void* lpObj, int tlsservercertindex);
int GetTLSServerCertCount(); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); QString GetTLSServerCertFingerprint(int iTLSServerCertIndex); qint64 GetTLSServerCertHandle(int iTLSServerCertIndex); QString GetTLSServerCertIssuer(int iTLSServerCertIndex); QString GetTLSServerCertIssuerRDN(int iTLSServerCertIndex); QString GetTLSServerCertKeyAlgorithm(int iTLSServerCertIndex); int GetTLSServerCertKeyBits(int iTLSServerCertIndex); int GetTLSServerCertKeyUsage(int iTLSServerCertIndex); bool GetTLSServerCertSelfSigned(int iTLSServerCertIndex); QByteArray GetTLSServerCertSerialNumber(int iTLSServerCertIndex); QString GetTLSServerCertSigAlgorithm(int iTLSServerCertIndex); QString GetTLSServerCertSubject(int iTLSServerCertIndex); QString GetTLSServerCertSubjectRDN(int iTLSServerCertIndex); QString GetTLSServerCertValidFrom(int iTLSServerCertIndex); QString GetTLSServerCertValidTo(int iTLSServerCertIndex);
Remarks
Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.
This property is read-only and not available at design time.
Data Type
TLSSettings Property (AuthenticodeVerifier Class)
Manages TLS layer settings.
Syntax
SecureBlackboxTLSSettings* GetTLSSettings();
int secureblackbox_authenticodeverifier_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_authenticodeverifier_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_authenticodeverifier_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_authenticodeverifier_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_authenticodeverifier_gettlsciphersuites(void* lpObj);
int secureblackbox_authenticodeverifier_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_authenticodeverifier_gettlsclientauth(void* lpObj);
int secureblackbox_authenticodeverifier_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_authenticodeverifier_gettlseccurves(void* lpObj);
int secureblackbox_authenticodeverifier_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_authenticodeverifier_gettlsextensions(void* lpObj);
int secureblackbox_authenticodeverifier_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_authenticodeverifier_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_authenticodeverifier_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_authenticodeverifier_gettlspresharedidentity(void* lpObj);
int secureblackbox_authenticodeverifier_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_authenticodeverifier_gettlspresharedkey(void* lpObj);
int secureblackbox_authenticodeverifier_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_authenticodeverifier_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_authenticodeverifier_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_authenticodeverifier_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_authenticodeverifier_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_authenticodeverifier_gettlsrevocationcheck(void* lpObj);
int secureblackbox_authenticodeverifier_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_authenticodeverifier_gettlsssloptions(void* lpObj);
int secureblackbox_authenticodeverifier_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_authenticodeverifier_gettlstlsmode(void* lpObj);
int secureblackbox_authenticodeverifier_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_authenticodeverifier_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_authenticodeverifier_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_authenticodeverifier_gettlsusesessionresumption(void* lpObj);
int secureblackbox_authenticodeverifier_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_authenticodeverifier_gettlsversions(void* lpObj);
int secureblackbox_authenticodeverifier_settlsversions(void* lpObj, int iTLSVersions);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates); int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites); int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth); QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves); QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions); bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges); QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity); QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey); QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite); int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret); bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption); int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
Data Type
TrustedCertificates Property (AuthenticodeVerifier Class)
A list of trusted certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates(); int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_authenticodeverifier_gettrustedcertcount(void* lpObj);
int secureblackbox_authenticodeverifier_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int secureblackbox_authenticodeverifier_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
int64 secureblackbox_authenticodeverifier_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_authenticodeverifier_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount); QByteArray GetTrustedCertBytes(int iTrustedCertIndex); qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);
Remarks
Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.
Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.
This property is not available at design time.
Data Type
TSACertificate Property (AuthenticodeVerifier Class)
The certificate of the Time Stamping Authority.
Syntax
SecureBlackboxCertificate* GetTSACertificate();
int secureblackbox_authenticodeverifier_gettsacertbytes(void* lpObj, char** lpTSACertBytes, int* lenTSACertBytes);
int secureblackbox_authenticodeverifier_gettsacertca(void* lpObj);
int secureblackbox_authenticodeverifier_gettsacertcakeyid(void* lpObj, char** lpTSACertCAKeyID, int* lenTSACertCAKeyID);
char* secureblackbox_authenticodeverifier_gettsacertcrldistributionpoints(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertcurve(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertfingerprint(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertfriendlyname(void* lpObj);
int64 secureblackbox_authenticodeverifier_gettsacerthandle(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacerthashalgorithm(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertissuer(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertissuerrdn(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertkeyalgorithm(void* lpObj);
int secureblackbox_authenticodeverifier_gettsacertkeybits(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertkeyfingerprint(void* lpObj);
int secureblackbox_authenticodeverifier_gettsacertkeyusage(void* lpObj);
int secureblackbox_authenticodeverifier_gettsacertkeyvalid(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertocsplocations(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertpolicyids(void* lpObj);
int secureblackbox_authenticodeverifier_gettsacertpublickeybytes(void* lpObj, char** lpTSACertPublicKeyBytes, int* lenTSACertPublicKeyBytes);
int secureblackbox_authenticodeverifier_gettsacertselfsigned(void* lpObj);
int secureblackbox_authenticodeverifier_gettsacertserialnumber(void* lpObj, char** lpTSACertSerialNumber, int* lenTSACertSerialNumber);
char* secureblackbox_authenticodeverifier_gettsacertsigalgorithm(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertsubject(void* lpObj);
int secureblackbox_authenticodeverifier_gettsacertsubjectkeyid(void* lpObj, char** lpTSACertSubjectKeyID, int* lenTSACertSubjectKeyID);
char* secureblackbox_authenticodeverifier_gettsacertsubjectrdn(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertvalidfrom(void* lpObj);
char* secureblackbox_authenticodeverifier_gettsacertvalidto(void* lpObj);
QByteArray GetTSACertBytes(); bool GetTSACertCA(); QByteArray GetTSACertCAKeyID(); QString GetTSACertCRLDistributionPoints(); QString GetTSACertCurve(); QString GetTSACertFingerprint(); QString GetTSACertFriendlyName(); qint64 GetTSACertHandle(); QString GetTSACertHashAlgorithm(); QString GetTSACertIssuer(); QString GetTSACertIssuerRDN(); QString GetTSACertKeyAlgorithm(); int GetTSACertKeyBits(); QString GetTSACertKeyFingerprint(); int GetTSACertKeyUsage(); bool GetTSACertKeyValid(); QString GetTSACertOCSPLocations(); QString GetTSACertPolicyIDs(); QByteArray GetTSACertPublicKeyBytes(); bool GetTSACertSelfSigned(); QByteArray GetTSACertSerialNumber(); QString GetTSACertSigAlgorithm(); QString GetTSACertSubject(); QByteArray GetTSACertSubjectKeyID(); QString GetTSACertSubjectRDN(); QString GetTSACertValidFrom(); QString GetTSACertValidTo();
Remarks
Use this property to access the certificate of the TSA that produced the timestamp.
Note that in some instances the TSA certificate might be unavailable, even for timestamped documents and signatures.
This property is read-only and not available at design time.
Data Type
UnsignedAttributes Property (AuthenticodeVerifier Class)
Custom unsigned attributes included in the electronic signature.
Syntax
SecureBlackboxList<SecureBlackboxSignatureAttribute>* GetUnsignedAttributes();
int secureblackbox_authenticodeverifier_getunsignedattributecount(void* lpObj);
char* secureblackbox_authenticodeverifier_getunsignedattributeoid(void* lpObj, int unsignedattributeindex);
int secureblackbox_authenticodeverifier_getunsignedattributevalue(void* lpObj, int unsignedattributeindex, char** lpUnsignedAttributeValue, int* lenUnsignedAttributeValue);
int GetUnsignedAttributeCount(); QString GetUnsignedAttributeOID(int iUnsignedAttributeIndex); QByteArray GetUnsignedAttributeValue(int iUnsignedAttributeIndex);
Remarks
Signature attributes are used to store auxiliary information in the signature. Values included as unsigned attributes are not covered by the signature and can be changed or removed without affecting the signature.
This property is read-only and not available at design time.
Data Type
SecureBlackboxSignatureAttribute
ValidationMoment Property (AuthenticodeVerifier Class)
The time point at which signature validity is to be established.
Syntax
ANSI (Cross Platform) char* GetValidationMoment();
int SetValidationMoment(const char* lpszValidationMoment); Unicode (Windows) LPWSTR GetValidationMoment();
INT SetValidationMoment(LPCWSTR lpszValidationMoment);
char* secureblackbox_authenticodeverifier_getvalidationmoment(void* lpObj);
int secureblackbox_authenticodeverifier_setvalidationmoment(void* lpObj, const char* lpszValidationMoment);
QString GetValidationMoment();
int SetValidationMoment(QString qsValidationMoment);
Default Value
""
Remarks
Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).
The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.
Data Type
String
Config Method (AuthenticodeVerifier Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_authenticodeverifier_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (AuthenticodeVerifier Class)
Performs an additional action.
Syntax
ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_authenticodeverifier_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Reset Method (AuthenticodeVerifier Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_authenticodeverifier_reset(void* lpObj);
int Reset();
Remarks
Reset is a generic method available in every class.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Verify Method (AuthenticodeVerifier Class)
Verifies a digitally signed executable.
Syntax
ANSI (Cross Platform) int Verify(); Unicode (Windows) INT Verify();
int secureblackbox_authenticodeverifier_verify(void* lpObj);
int Verify();
Remarks
Use this method to verify all signatures in the executable provided via InputFile or via InputStream.
During the verification process, the SignatureFound, SignatureValidated, TimestampFound and TimestampValidated events are fired to provide details about the signatures and timestamps.
After this method is executed, the Signature property contains information about the last verified signature.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ChainElementDownload Event (AuthenticodeVerifier Class)
Fires when there is a need to download a chain element from an online source.
Syntax
ANSI (Cross Platform) virtual int FireChainElementDownload(AuthenticodeVerifierChainElementDownloadEventParams *e);
typedef struct {
int Kind;
const char *CertRDN;
const char *CACertRDN;
const char *Location;
int Action; int reserved; } AuthenticodeVerifierChainElementDownloadEventParams;
Unicode (Windows) virtual INT FireChainElementDownload(AuthenticodeVerifierChainElementDownloadEventParams *e);
typedef struct {
INT Kind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
LPCWSTR Location;
INT Action; INT reserved; } AuthenticodeVerifierChainElementDownloadEventParams;
#define EID_AUTHENTICODEVERIFIER_CHAINELEMENTDOWNLOAD 1 virtual INT SECUREBLACKBOX_CALL FireChainElementDownload(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, LPSTR &lpszLocation, INT &iAction);
class AuthenticodeVerifierChainElementDownloadEventParams { public: int Kind(); const QString &CertRDN(); const QString &CACertRDN(); const QString &Location(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChainElementDownload(AuthenticodeVerifierChainElementDownloadEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireChainElementDownload(AuthenticodeVerifierChainElementDownloadEventParams *e) {...}
Remarks
Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.
veaAuto | 0 | Handle the action automatically (the default behaviour) |
veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
veaAcceptNow | 3 | Accept the validated certificate immediately |
veaAbortNow | 4 | Abort the validation, reject the certificate |
cekUnknown | 0 | Unknown or unsupported element type |
cekCertificate | 1 | An X.509 certificate |
cekCRL | 2 | A CRL |
cekOCSP | 3 | An OCSP response |
ChainElementNeeded Event (AuthenticodeVerifier Class)
Fires when an element required to validate the chain was not located.
Syntax
ANSI (Cross Platform) virtual int FireChainElementNeeded(AuthenticodeVerifierChainElementNeededEventParams *e);
typedef struct {
int Kind;
const char *CertRDN;
const char *CACertRDN; int reserved; } AuthenticodeVerifierChainElementNeededEventParams;
Unicode (Windows) virtual INT FireChainElementNeeded(AuthenticodeVerifierChainElementNeededEventParams *e);
typedef struct {
INT Kind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN; INT reserved; } AuthenticodeVerifierChainElementNeededEventParams;
#define EID_AUTHENTICODEVERIFIER_CHAINELEMENTNEEDED 2 virtual INT SECUREBLACKBOX_CALL FireChainElementNeeded(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN);
class AuthenticodeVerifierChainElementNeededEventParams { public: int Kind(); const QString &CertRDN(); const QString &CACertRDN(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChainElementNeeded(AuthenticodeVerifierChainElementNeededEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireChainElementNeeded(AuthenticodeVerifierChainElementNeededEventParams *e) {...}
Remarks
Subscribe to this event to be notified about missing validation elements. Use the KnownCRLs, KnownCertificates, and KnownOCSPs properties in the event handler to provide the missing piece.
cekUnknown | 0 | Unknown or unsupported element type |
cekCertificate | 1 | An X.509 certificate |
cekCRL | 2 | A CRL |
cekOCSP | 3 | An OCSP response |
ChainValidated Event (AuthenticodeVerifier Class)
Reports the completion of a certificate chain validation.
Syntax
ANSI (Cross Platform) virtual int FireChainValidated(AuthenticodeVerifierChainValidatedEventParams *e);
typedef struct {
const char *SubjectRDN;
int ValidationResult;
int ValidationDetails; int reserved; } AuthenticodeVerifierChainValidatedEventParams;
Unicode (Windows) virtual INT FireChainValidated(AuthenticodeVerifierChainValidatedEventParams *e);
typedef struct {
LPCWSTR SubjectRDN;
INT ValidationResult;
INT ValidationDetails; INT reserved; } AuthenticodeVerifierChainValidatedEventParams;
#define EID_AUTHENTICODEVERIFIER_CHAINVALIDATED 3 virtual INT SECUREBLACKBOX_CALL FireChainValidated(LPSTR &lpszSubjectRDN, INT &iValidationResult, INT &iValidationDetails);
class AuthenticodeVerifierChainValidatedEventParams { public: const QString &SubjectRDN(); int ValidationResult(); int ValidationDetails(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChainValidated(AuthenticodeVerifierChainValidatedEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireChainValidated(AuthenticodeVerifierChainValidatedEventParams *e) {...}
Remarks
This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.
ValidationResult set to 0 (zero) indicates successful chain validation.
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationProgress Event (AuthenticodeVerifier Class)
This event is fired multiple times during chain validation to report various stages of the validation procedure.
Syntax
ANSI (Cross Platform) virtual int FireChainValidationProgress(AuthenticodeVerifierChainValidationProgressEventParams *e);
typedef struct {
const char *EventKind;
const char *CertRDN;
const char *CACertRDN;
int Action; int reserved; } AuthenticodeVerifierChainValidationProgressEventParams;
Unicode (Windows) virtual INT FireChainValidationProgress(AuthenticodeVerifierChainValidationProgressEventParams *e);
typedef struct {
LPCWSTR EventKind;
LPCWSTR CertRDN;
LPCWSTR CACertRDN;
INT Action; INT reserved; } AuthenticodeVerifierChainValidationProgressEventParams;
#define EID_AUTHENTICODEVERIFIER_CHAINVALIDATIONPROGRESS 4 virtual INT SECUREBLACKBOX_CALL FireChainValidationProgress(LPSTR &lpszEventKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, INT &iAction);
class AuthenticodeVerifierChainValidationProgressEventParams { public: const QString &EventKind(); const QString &CertRDN(); const QString &CACertRDN(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ChainValidationProgress(AuthenticodeVerifierChainValidationProgressEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireChainValidationProgress(AuthenticodeVerifierChainValidationProgressEventParams *e) {...}
Remarks
Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.
The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.
veaAuto | 0 | Handle the action automatically (the default behaviour) |
veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
veaAcceptNow | 3 | Accept the validated certificate immediately |
veaAbortNow | 4 | Abort the validation, reject the certificate |
Error Event (AuthenticodeVerifier Class)
Information about errors during ASiC signature verification.
Syntax
ANSI (Cross Platform) virtual int FireError(AuthenticodeVerifierErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } AuthenticodeVerifierErrorEventParams;
Unicode (Windows) virtual INT FireError(AuthenticodeVerifierErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } AuthenticodeVerifierErrorEventParams;
#define EID_AUTHENTICODEVERIFIER_ERROR 5 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class AuthenticodeVerifierErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(AuthenticodeVerifierErrorEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireError(AuthenticodeVerifierErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during ASiC signature verification.
ErrorCode contains an error code and Description contains a textual description of the error.
Notification Event (AuthenticodeVerifier Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(AuthenticodeVerifierNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } AuthenticodeVerifierNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(AuthenticodeVerifierNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } AuthenticodeVerifierNotificationEventParams;
#define EID_AUTHENTICODEVERIFIER_NOTIFICATION 6 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class AuthenticodeVerifierNotificationEventParams { public: const QString &EventID(); const QString &EventParam(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Notification(AuthenticodeVerifierNotificationEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireNotification(AuthenticodeVerifierNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
SignatureFound Event (AuthenticodeVerifier Class)
Signifies the start of signature validation.
Syntax
ANSI (Cross Platform) virtual int FireSignatureFound(AuthenticodeVerifierSignatureFoundEventParams *e);
typedef struct {
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int CertFound;
int ValidateSignature;
int ValidateChain; int reserved; } AuthenticodeVerifierSignatureFoundEventParams;
Unicode (Windows) virtual INT FireSignatureFound(AuthenticodeVerifierSignatureFoundEventParams *e);
typedef struct {
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateSignature;
BOOL ValidateChain; INT reserved; } AuthenticodeVerifierSignatureFoundEventParams;
#define EID_AUTHENTICODEVERIFIER_SIGNATUREFOUND 7 virtual INT SECUREBLACKBOX_CALL FireSignatureFound(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);
class AuthenticodeVerifierSignatureFoundEventParams { public: const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); bool CertFound(); bool ValidateSignature(); void SetValidateSignature(bool bValidateSignature); bool ValidateChain(); void SetValidateChain(bool bValidateChain); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignatureFound(AuthenticodeVerifierSignatureFoundEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireSignatureFound(AuthenticodeVerifierSignatureFoundEventParams *e) {...}
Remarks
This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.
The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the SignatureValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
SignatureValidated Event (AuthenticodeVerifier Class)
Marks the completion of the signature validation routine.
Syntax
ANSI (Cross Platform) virtual int FireSignatureValidated(AuthenticodeVerifierSignatureValidatedEventParams *e);
typedef struct {
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int ValidationResult; int reserved; } AuthenticodeVerifierSignatureValidatedEventParams;
Unicode (Windows) virtual INT FireSignatureValidated(AuthenticodeVerifierSignatureValidatedEventParams *e);
typedef struct {
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
INT ValidationResult; INT reserved; } AuthenticodeVerifierSignatureValidatedEventParams;
#define EID_AUTHENTICODEVERIFIER_SIGNATUREVALIDATED 8 virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult);
class AuthenticodeVerifierSignatureValidatedEventParams { public: const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); int ValidationResult(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SignatureValidated(AuthenticodeVerifierSignatureValidatedEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireSignatureValidated(AuthenticodeVerifierSignatureValidatedEventParams *e) {...}
Remarks
This event is fired upon the completion of the signature validation routine, and reports the respective validation result.
Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
TimestampFound Event (AuthenticodeVerifier Class)
Signifies the start of a timestamp validation routine.
Syntax
ANSI (Cross Platform) virtual int FireTimestampFound(AuthenticodeVerifierTimestampFoundEventParams *e);
typedef struct {
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int CertFound;
int ValidateTimestamp;
int ValidateChain; int reserved; } AuthenticodeVerifierTimestampFoundEventParams;
Unicode (Windows) virtual INT FireTimestampFound(AuthenticodeVerifierTimestampFoundEventParams *e);
typedef struct {
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateTimestamp;
BOOL ValidateChain; INT reserved; } AuthenticodeVerifierTimestampFoundEventParams;
#define EID_AUTHENTICODEVERIFIER_TIMESTAMPFOUND 9 virtual INT SECUREBLACKBOX_CALL FireTimestampFound(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateTimestamp, BOOL &bValidateChain);
class AuthenticodeVerifierTimestampFoundEventParams { public: const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); bool CertFound(); bool ValidateTimestamp(); void SetValidateTimestamp(bool bValidateTimestamp); bool ValidateChain(); void SetValidateChain(bool bValidateChain); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TimestampFound(AuthenticodeVerifierTimestampFoundEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireTimestampFound(AuthenticodeVerifierTimestampFoundEventParams *e) {...}
Remarks
This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.
The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.
Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the ValidationResult and ChainValidationResult properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
TimestampValidated Event (AuthenticodeVerifier Class)
Reports the completion of the timestamp validation routine.
Syntax
ANSI (Cross Platform) virtual int FireTimestampValidated(AuthenticodeVerifierTimestampValidatedEventParams *e);
typedef struct {
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
const char *Time;
int ValidationResult;
int ChainValidationResult;
int ChainValidationDetails; int reserved; } AuthenticodeVerifierTimestampValidatedEventParams;
Unicode (Windows) virtual INT FireTimestampValidated(AuthenticodeVerifierTimestampValidatedEventParams *e);
typedef struct {
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
LPCWSTR Time;
INT ValidationResult;
INT ChainValidationResult;
INT ChainValidationDetails; INT reserved; } AuthenticodeVerifierTimestampValidatedEventParams;
#define EID_AUTHENTICODEVERIFIER_TIMESTAMPVALIDATED 10 virtual INT SECUREBLACKBOX_CALL FireTimestampValidated(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, LPSTR &lpszTime, INT &iValidationResult, INT &iChainValidationResult, INT &iChainValidationDetails);
class AuthenticodeVerifierTimestampValidatedEventParams { public: const QString &IssuerRDN(); const QByteArray &SerialNumber(); const QByteArray &SubjectKeyID(); const QString &Time(); int ValidationResult(); int ChainValidationResult(); int ChainValidationDetails(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TimestampValidated(AuthenticodeVerifierTimestampValidatedEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireTimestampValidated(AuthenticodeVerifierTimestampValidatedEventParams *e) {...}
Remarks
This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
TLSCertNeeded Event (AuthenticodeVerifier Class)
Fires when a remote TLS party requests a client certificate.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertNeeded(AuthenticodeVerifierTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } AuthenticodeVerifierTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(AuthenticodeVerifierTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } AuthenticodeVerifierTLSCertNeededEventParams;
#define EID_AUTHENTICODEVERIFIER_TLSCERTNEEDED 11 virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class AuthenticodeVerifierTLSCertNeededEventParams { public: const QString &Host(); const QString &CANames(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertNeeded(AuthenticodeVerifierTLSCertNeededEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireTLSCertNeeded(AuthenticodeVerifierTLSCertNeededEventParams *e) {...}
Remarks
This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.
This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.
TLSCertValidate Event (AuthenticodeVerifier Class)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertValidate(AuthenticodeVerifierTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } AuthenticodeVerifierTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(AuthenticodeVerifierTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } AuthenticodeVerifierTLSCertValidateEventParams;
#define EID_AUTHENTICODEVERIFIER_TLSCERTVALIDATE 12 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class AuthenticodeVerifierTLSCertValidateEventParams { public: const QString &ServerHost(); const QString &ServerIP(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertValidate(AuthenticodeVerifierTLSCertValidateEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireTLSCertValidate(AuthenticodeVerifierTLSCertValidateEventParams *e) {...}
Remarks
This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.
TLSEstablished Event (AuthenticodeVerifier Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(AuthenticodeVerifierTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } AuthenticodeVerifierTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(AuthenticodeVerifierTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } AuthenticodeVerifierTLSEstablishedEventParams;
#define EID_AUTHENTICODEVERIFIER_TLSESTABLISHED 13 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class AuthenticodeVerifierTLSEstablishedEventParams { public: const QString &Host(); const QString &Version(); const QString &Ciphersuite(); const QByteArray &ConnectionId(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSEstablished(AuthenticodeVerifierTLSEstablishedEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireTLSEstablished(AuthenticodeVerifierTLSEstablishedEventParams *e) {...}
Remarks
The class uses this event to notify the application about a successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.
TLSHandshake Event (AuthenticodeVerifier Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(AuthenticodeVerifierTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } AuthenticodeVerifierTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(AuthenticodeVerifierTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } AuthenticodeVerifierTLSHandshakeEventParams;
#define EID_AUTHENTICODEVERIFIER_TLSHANDSHAKE 14 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class AuthenticodeVerifierTLSHandshakeEventParams { public: const QString &Host(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSHandshake(AuthenticodeVerifierTLSHandshakeEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireTLSHandshake(AuthenticodeVerifierTLSHandshakeEventParams *e) {...}
Remarks
The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.
TLSShutdown Event (AuthenticodeVerifier Class)
Reports the graceful closure of a TLS connection.
Syntax
ANSI (Cross Platform) virtual int FireTLSShutdown(AuthenticodeVerifierTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } AuthenticodeVerifierTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(AuthenticodeVerifierTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } AuthenticodeVerifierTLSShutdownEventParams;
#define EID_AUTHENTICODEVERIFIER_TLSSHUTDOWN 15 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class AuthenticodeVerifierTLSShutdownEventParams { public: const QString &Host(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(AuthenticodeVerifierTLSShutdownEventParams *e);
// Or, subclass AuthenticodeVerifier and override this emitter function. virtual int FireTLSShutdown(AuthenticodeVerifierTLSShutdownEventParams *e) {...}
Remarks
This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.
AuthenticodeSignature Type
Represents a signature over an executable binary (EXE, DLL, PE).
Syntax
SecureBlackboxAuthenticodeSignature (declared in secureblackbox.h)
Remarks
This type contains all information about a single signature produced (or read from the binary) by AuthenticodeVerifier.
Fields
ChainValidationDetails
int (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationResult
int (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
ClaimedSigningTime
char* (read-only)
Default Value: ""
Returns the signature's claimed signing time.
Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by a trusted timestamp and may be forfeited or wrong. Use ValidatedSigningTime to obtain the signing time figure verified by a trusted timestamping authority. The time is in UTC.
Description
char* (read-only)
Default Value: ""
Returns a human-readable signature description.
ErrorCode
int (read-only)
Default Value: 0
Returns the error code returned by the signature validation routine.
ErrorMessage
char* (read-only)
Default Value: ""
Returns the error message returned by the signature validation routine.
FileHashAlgorithm
char* (read-only)
Default Value: ""
Returns the algorithm that was used to hash the executable.
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char* (read-only)
Default Value: ""
Returns the hash algorithm used when generating the signature.
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
SignatureBytes
char* (read-only)
Default Value:
Returns the binary representation of the inner PKCS7 signature.
SignatureValidationResult
int (read-only)
Default Value: 0
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
StatementType
int (read-only)
Default Value: 0
Returns the signature statement type.
Available options:
acsUnknown | 0 |
acsIndividual | 1 |
acsCommercial | 2 |
URL
char* (read-only)
Default Value: ""
Returns the URL included in the signature by the signer.
ValidatedSigningTime
char* (read-only)
Default Value: ""
Contains the certified signing time.
Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.
ClaimedSigningTime returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
ValidationLog
char* (read-only)
Default Value: ""
Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.
Certificate Type
Encapsulates an individual X.509 certificate.
Syntax
SecureBlackboxCertificate (declared in secureblackbox.h)
Remarks
This type keeps and provides access to X.509 certificate details.
Fields
Bytes
char* (read-only)
Default Value:
Returns the raw certificate data in DER format.
CA
int
Default Value: FALSE
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.
CAKeyID
char* (read-only)
Default Value:
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
CertType
int (read-only)
Default Value: 0
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager class to load or create new certificate and certificate requests objects.
CRLDistributionPoints
char*
Default Value: ""
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
Curve
char*
Default Value: ""
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
Fingerprint
char* (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
FriendlyName
char* (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char*
Default Value: ""
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Issuer
char* (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.
IssuerRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
KeyAlgorithm
char*
Default Value: "0"
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.
KeyBits
int (read-only)
Default Value: 0
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.
KeyFingerprint
char* (read-only)
Default Value: ""
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
KeyUsage
int
Default Value: 0
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this field before generating the certificate to propagate the key usage flags to the new certificate.
KeyValid
int (read-only)
Default Value: FALSE
Returns True if the certificate's key is cryptographically valid, and False otherwise.
OCSPLocations
char*
Default Value: ""
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
OCSPNoCheck
int
Default Value: FALSE
Accessor to the value of the certificate's ocsp-no-check extension.
Origin
int (read-only)
Default Value: 0
Returns the location that the certificate was taken or loaded from.
PolicyIDs
char*
Default Value: ""
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this field when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
PrivateKeyBytes
char* (read-only)
Default Value:
Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
PrivateKeyExists
int (read-only)
Default Value: FALSE
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
PrivateKeyExtractable
int (read-only)
Default Value: FALSE
Indicates whether the private key is extractable (exportable).
PublicKeyBytes
char* (read-only)
Default Value:
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
Qualified
int (read-only)
Default Value: FALSE
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
QualifiedStatements
int
Default Value: 0
Returns a simplified qualified status of the certificate.
Qualifiers
char* (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
SelfSigned
int (read-only)
Default Value: FALSE
Indicates whether the certificate is self-signed (root) or signed by an external CA.
SerialNumber
char*
Default Value:
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
SigAlgorithm
char* (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Subject
char* (read-only)
Default Value: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.
SubjectAlternativeName
char*
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
SubjectKeyID
char*
Default Value:
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
SubjectRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
Valid
int (read-only)
Default Value: FALSE
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
ValidFrom
char*
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
ValidTo
char*
Default Value: ""
The time point at which the certificate expires, in UTC.
Constructors
Certificate()
Creates a new object with default field values.
CRL Type
Represents a Certificate Revocation List.
Syntax
SecureBlackboxCRL (declared in secureblackbox.h)
Remarks
CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.
Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.
Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.
Fields
Bytes
char* (read-only)
Default Value:
Returns the raw CRL data in DER format.
CAKeyID
char*
Default Value:
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
EntryCount
int (read-only)
Default Value: 0
Returns the number of certificate status entries in the CRL.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
The common name of the CRL issuer (CA), typically a company name.
IssuerRDN
char* (read-only)
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Location
char* (read-only)
Default Value: ""
The URL that the CRL was downloaded from.
NextUpdate
char*
Default Value: ""
The planned time and date of the next version of this CRL to be published.
SigAlgorithm
char*
Default Value: "0"
The public key algorithm that was used by the CA to sign this CRL.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
TBS
char* (read-only)
Default Value:
The to-be-signed part of the CRL (the CRL without the signature part).
ThisUpdate
char*
Default Value: ""
The date and time at which this version of the CRL was published.
Constructors
CRL()
Creates an empty CRL object.
OCSPResponse Type
Represents a single OCSP response originating from an OCSP responder.
Syntax
SecureBlackboxOCSPResponse (declared in secureblackbox.h)
Remarks
OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
Bytes
char* (read-only)
Default Value:
A buffer containing the raw OCSP response data.
EntryCount
int (read-only)
Default Value: 0
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
Indicates the issuer of this response (a CA or its authorized representative).
IssuerRDN
char* (read-only)
Default Value: ""
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Location
char* (read-only)
Default Value: ""
The location of the OCSP responder.
ProducedAt
char*
Default Value: ""
Specifies the time when the response was produced, in UTC.
SigAlgorithm
char*
Default Value: "0"
The public key algorithm that was used by the CA to sign this OCSP response.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Constructors
OCSPResponse()
Creates an empty OCSP response object.
ProxySettings Type
A container for proxy server settings.
Syntax
SecureBlackboxProxySettings (declared in secureblackbox.h)
Remarks
This type exposes a collection of properties for tuning up the proxy server configuration.
Fields
Address
char*
Default Value: ""
The IP address of the proxy server.
Authentication
int
Default Value: 0
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Password
char*
Default Value: ""
The password to authenticate to the proxy server.
Port
int
Default Value: 0
The port on the proxy server to connect to.
ProxyType
int
Default Value: 0
The type of the proxy server.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
RequestHeaders
char*
Default Value: ""
Contains HTTP request headers for WebTunnel and HTTP proxy.
ResponseBody
char*
Default Value: ""
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ResponseHeaders
char*
Default Value: ""
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
UseIPv6
int
Default Value: FALSE
Specifies whether IPv6 should be used when connecting through the proxy.
Username
char*
Default Value: ""
Specifies the username credential for proxy authentication.
Constructors
ProxySettings()
Creates a new ProxySettings object.
SignatureAttribute Type
Represents an attribute of a digital PKCS#7/CMS signature.
Syntax
SecureBlackboxSignatureAttribute (declared in secureblackbox.h)
Remarks
Attributes store auxiliary information about the signed message, the signature, or the owner. Each attribute is a OID=Value pair.
Common attributes are signing time, a content type, a policy identifier, and a signature timestamp.
Fields
OID
char*
Default Value: ""
The object identifier of the attribute.
Value
char*
Default Value:
The value of the attribute.
Constructors
SignatureAttribute()
Creates a new, empty, signature attribute.
SocketSettings Type
A container for the socket settings.
Syntax
SecureBlackboxSocketSettings (declared in secureblackbox.h)
Remarks
This type is a container for socket-layer parameters.
Fields
DNSMode
int
Default Value: 0
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
DNSPort
int
Default Value: 0
Specifies the port number to be used for sending queries to the DNS server.
DNSQueryTimeout
int
Default Value: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
DNSServers
char*
Default Value: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
DNSTotalTimeout
int
Default Value: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
IncomingSpeedLimit
int
Default Value: 0
The maximum number of bytes to read from the socket, per second.
LocalAddress
char*
Default Value: ""
The local network interface to bind the socket to.
LocalPort
int
Default Value: 0
The local port number to bind the socket to.
OutgoingSpeedLimit
int
Default Value: 0
The maximum number of bytes to write to the socket, per second.
Timeout
int
Default Value: 60000
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
UseIPv6
int
Default Value: FALSE
Enables or disables IP protocol version 6.
Constructors
SocketSettings()
Creates a new SocketSettings object.
TimestampInfo Type
A container for timestamp information.
Syntax
SecureBlackboxTimestampInfo (declared in secureblackbox.h)
Remarks
The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation.
Fields
Accuracy
int64 (read-only)
Default Value: 0
This field indicates the accuracy of the included time mark, in microseconds.
Bytes
char* (read-only)
Default Value:
Returns the raw timestamp data in DER format.
CertificateIndex
int (read-only)
Default Value: -1
Returns the index of the TSA certificate in the Certificates collection.
Use this property to look up the TSA certificate in the Certificates collection.
ChainValidationDetails
int (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationResult
int (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
ContainsLongTermInfo
int (read-only)
Default Value: FALSE
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
EntityLabel
char* (read-only)
Default Value: ""
Use this property to get the timestamp entity label.
This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
HashAlgorithm
char* (read-only)
Default Value: ""
Returns the timestamp's hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
ParentEntity
char* (read-only)
Default Value: ""
Use this property to get the label of the timestamp's parent entity.
This property references the EntityLabel of the object that the timestamp covers, typically a signature.
SerialNumber
char* (read-only)
Default Value:
Returns the timestamp's serial number.
Time
char* (read-only)
Default Value: ""
The time point incorporated into the timestamp.
TimestampType
int (read-only)
Default Value: 0
Returns the type of the timestamp.
Available options:
tstUnknown | 0 | |
tstLegacy | 1 | Supported by: Authenticode components |
tstTrusted | 2 | Supported by: Authenticode components |
tstGeneric | 3 | Supported by: CAdES components |
tstESC | 4 | Supported by: CAdES components |
tstContent | 5 | Supported by: CAdES components |
tstCertsAndCRLs | 6 | Supported by: CAdES components |
tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components |
tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components |
tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components |
tstIndividualDataObjects | 10 | Individual data objects timetamp. Supported by: ASiC, Office, SOAP, XAdES components |
tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components |
tstArchive141 | 16 | Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components |
Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).
TSAName
char* (read-only)
Default Value: ""
This value uniquely identifies the Timestamp Authority (TSA).
This property provides information about the entity that manages the TSA.
ValidationLog
char* (read-only)
Default Value: ""
Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.
ValidationResult
int (read-only)
Default Value: 0
Contains the timestamp validation outcome.
Use this property to check the result of the most recent timestamp validation.
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
Constructors
TimestampInfo()
Creates a new TimestampInfo object with default field values.
TLSSettings Type
A container for TLS connection settings.
Syntax
SecureBlackboxTLSSettings (declared in secureblackbox.h)
Remarks
The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
AutoValidateCertificates
int
Default Value: TRUE
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
BaseConfiguration
int
Default Value: 0
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Ciphersuites
char*
Default Value: ""
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
ClientAuth
int
Default Value: 0
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
ccatNoAuth | 0 | |
ccatRequestCert | 1 | |
ccatRequireCert | 2 |
ECCurves
char*
Default Value: ""
Defines the elliptic curves to enable.
Extensions
char*
Default Value: ""
Provides access to TLS extensions.
ForceResumeIfDestinationChanges
int
Default Value: FALSE
Whether to force TLS session resumption when the destination address changes.
PreSharedIdentity
char*
Default Value: ""
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedKey
char*
Default Value: ""
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
PreSharedKeyCiphersuite
char*
Default Value: ""
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
RenegotiationAttackPreventionMode
int
Default Value: 2
Selects the renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
RevocationCheck
int
Default Value: 1
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
SSLOptions
int
Default Value: 16
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
TLSMode
int
Default Value: 0
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
UseExtendedMasterSecret
int
Default Value: FALSE
Enables the Extended Master Secret Extension, as defined in RFC 7627.
UseSessionResumption
int
Default Value: FALSE
Enables or disables the TLS session resumption capability.
Versions
int
Default Value: 16
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Constructors
TLSSettings()
Creates a new TLSSettings object.
SecureBlackboxList Type
Syntax
SecureBlackboxList<T> (declared in secureblackbox.h)
Remarks
SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the AuthenticodeVerifier class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount(int count) {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
Config Settings (AuthenticodeVerifier Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.AuthenticodeVerifier Config Settings
This is useful to speedup getting the signature(s) information. Set this property to true and then return false from the SignatureFound event in the ValidateSignature parameter. In this case, the class will not calculate file digests and its checksum until at least one signature is validated.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.
- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |