ASiCVerifier Class

Properties Methods Events Config Settings Errors

The ASiCVerifier class verifies signature containers.

Syntax

ASiCVerifier

Remarks

ASiCVerifier provides the functionality of verifying signatures residing in Associated Signature Containers.

Both ASiC-S and ASiC-E profiles are supported.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


AllSignaturesValid	The cumulative validity of all signatures.
AutoValidateSignatures	Specifies whether ASiCVerifier should validate any present signatures when the document is opened.
BlockedCertificates	The certificates that must be rejected as trust anchors.
Certificates	A collection of certificates included in the electronic signature.
CheckTrustedLists	TBD.
CRLs	A collection of certificate revocation lists embedded into the signature by the signer.
ExtractionMode	Specifies which entries should be extracted from the container upon verification.
Files	Lists all files contained in the container.
FIPSMode	Reserved.
IgnoreChainValidationErrors	Makes the class tolerant to chain validation errors.
InputBytes	Use this property to pass the input to class in the byte array form.
InputFile	A path to the ASiC container to process.
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 the offline mode.
OutputBytes	Use this property to read the output the class object has produced.
OutputFile	The file where the processed data will be saved.
OutputPath	A local path to extract the files to.
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.
Signatures	Contains the list of signatures included in the ASiC container.
SocketSettings	Manages network connection settings.
Timestamps	Contains a collection of timestamps for the processed document.
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.
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.


Close	Closes an opened container.
Config	This method sets or retrieves a configuration setting.
DoAction	Performs an additional action.
ExtractFile	Extracts a file to one of the output media (bytes, stream, or disk file).
ExtractFiles	Extracts files covered by a signature to OutputPath .
Open	Opens an existing container for signing or updating.
Reset	Resets the class settings.
Revalidate	Revalidates a signature in accordance with current settings.
SelectRevInfo	TBD.
Unsign	Deletes a signature from the container.
Verify	Verifies all signatures in the ASiC container.

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.
ChainElementStore	This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.
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.
ContainerLoaded	This event is fired when the container has been loaded into memory.
Error	Information about errors during ASiC signature verification.
FileExtractionStart	Signifies the start of a file extraction process.
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.


DislikeOpenEndedOCSPs	Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.
ExtractToMemory	Tells the class to extract the current entry to memory.
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.
IgnoreChainValidationErrors	Enable this property to ignore any chain validation issues.
IgnoreOCSPNoCheckExtension	Whether OCSP NoCheck extension should be ignored.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
ImplicitlyTrustSelfSignedCertificates	Whether to trust self-signed certificates.
PolicyExplicitText	The explicit text of the user notice.
PolicyUNNumbers	The noticeNumbers part of the NoticeReference CAdES attribute.
PolicyUNOrganization	The organization part of the NoticeReference qualifier.
ProductionPlace	The production place XAdES attribute.
PromoteLongOCSPResponses	Whether long OCSP responses are requested.
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 automatic use of Microsoft online certificate trust list.
UseSystemCertificates	Enables or disables the use of the system certificates.
UseUTF8Filenames	Specifies whether to use UTF-8 filenames.
UseValidationCache	Enables or disable the use of the product-wide certificate chain validation cache.
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.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
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.
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.
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.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

AllSignaturesValid Property (ASiCVerifier Class)

The cumulative validity of all signatures.

Syntax

ANSI (Cross Platform)
int GetAllSignaturesValid();

Unicode (Windows)
BOOL GetAllSignaturesValid();

int secureblackbox_asicverifier_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

AutoValidateSignatures Property (ASiCVerifier Class)

Specifies whether ASiCVerifier should validate any present signatures when the document is opened.

Syntax

ANSI (Cross Platform)
int GetAutoValidateSignatures();
int SetAutoValidateSignatures(int bAutoValidateSignatures);

Unicode (Windows)
BOOL GetAutoValidateSignatures();
INT SetAutoValidateSignatures(BOOL bAutoValidateSignatures);

int secureblackbox_asicverifier_getautovalidatesignatures(void* lpObj);
int secureblackbox_asicverifier_setautovalidatesignatures(void* lpObj, int bAutoValidateSignatures);

bool GetAutoValidateSignatures();
int SetAutoValidateSignatures(bool bAutoValidateSignatures);

Default Value

TRUE

Remarks

This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the Revalidate method.

Data Type

Boolean

BlockedCertificates Property (ASiCVerifier Class)

The certificates that must be rejected as trust anchors.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates();
int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_asicverifier_getblockedcertcount(void* lpObj);
int secureblackbox_asicverifier_setblockedcertcount(void* lpObj, int iBlockedCertCount);

int secureblackbox_asicverifier_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);

int64 secureblackbox_asicverifier_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_asicverifier_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

SecureBlackboxCertificate

Certificates Property (ASiCVerifier Class)

A collection of certificates included in the electronic signature.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetCertificates();

int secureblackbox_asicverifier_getcertcount(void* lpObj);

int secureblackbox_asicverifier_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);

int secureblackbox_asicverifier_getcertca(void* lpObj, int certindex);

int secureblackbox_asicverifier_getcertcakeyid(void* lpObj, int certindex, char** lpCertCAKeyID, int* lenCertCAKeyID);

char* secureblackbox_asicverifier_getcertcrldistributionpoints(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcertcurve(void* lpObj, int certindex);

int secureblackbox_asicverifier_getcertfingerprint(void* lpObj, int certindex, char** lpCertFingerprint, int* lenCertFingerprint);

char* secureblackbox_asicverifier_getcertfriendlyname(void* lpObj, int certindex);

int64 secureblackbox_asicverifier_getcerthandle(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcerthashalgorithm(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcertissuer(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcertissuerrdn(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcertkeyalgorithm(void* lpObj, int certindex);

int secureblackbox_asicverifier_getcertkeybits(void* lpObj, int certindex);

int secureblackbox_asicverifier_getcertkeyfingerprint(void* lpObj, int certindex, char** lpCertKeyFingerprint, int* lenCertKeyFingerprint);

int secureblackbox_asicverifier_getcertkeyusage(void* lpObj, int certindex);

int secureblackbox_asicverifier_getcertkeyvalid(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcertocsplocations(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcertpolicyids(void* lpObj, int certindex);

int secureblackbox_asicverifier_getcertpublickeybytes(void* lpObj, int certindex, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);

int secureblackbox_asicverifier_getcertqualified(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcertqualifiers(void* lpObj, int certindex);

int secureblackbox_asicverifier_getcertselfsigned(void* lpObj, int certindex);

int secureblackbox_asicverifier_getcertserialnumber(void* lpObj, int certindex, char** lpCertSerialNumber, int* lenCertSerialNumber);

char* secureblackbox_asicverifier_getcertsigalgorithm(void* lpObj, int certindex);

int secureblackbox_asicverifier_getcertsource(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcertsubject(void* lpObj, int certindex);

int secureblackbox_asicverifier_getcertsubjectkeyid(void* lpObj, int certindex, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);

char* secureblackbox_asicverifier_getcertsubjectrdn(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcertvalidfrom(void* lpObj, int certindex);

char* secureblackbox_asicverifier_getcertvalidto(void* lpObj, int certindex);

int GetCertCount();

QByteArray GetCertBytes(int iCertIndex);

bool GetCertCA(int iCertIndex);

QByteArray GetCertCAKeyID(int iCertIndex);

QString GetCertCRLDistributionPoints(int iCertIndex);

QString GetCertCurve(int iCertIndex);

QByteArray 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);

QByteArray GetCertKeyFingerprint(int iCertIndex);

int GetCertKeyUsage(int iCertIndex);

bool GetCertKeyValid(int iCertIndex);

QString GetCertOCSPLocations(int iCertIndex);

QString GetCertPolicyIDs(int iCertIndex);

QByteArray GetCertPublicKeyBytes(int iCertIndex);

bool GetCertQualified(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);

QByteArray GetCertSubjectKeyID(int iCertIndex);

QString GetCertSubjectRDN(int iCertIndex);

QString GetCertValidFrom(int iCertIndex);

QString GetCertValidTo(int iCertIndex);

Remarks

Use this property to access all certificates included into the signature(s) by its creator.

This property is read-only and not available at design time.

Data Type

SecureBlackboxCertificate

CheckTrustedLists Property (ASiCVerifier Class)

TBD.

Syntax

ANSI (Cross Platform)
int GetCheckTrustedLists();
int SetCheckTrustedLists(int bCheckTrustedLists);

Unicode (Windows)
BOOL GetCheckTrustedLists();
INT SetCheckTrustedLists(BOOL bCheckTrustedLists);

int secureblackbox_asicverifier_getchecktrustedlists(void* lpObj);
int secureblackbox_asicverifier_setchecktrustedlists(void* lpObj, int bCheckTrustedLists);

bool GetCheckTrustedLists();
int SetCheckTrustedLists(bool bCheckTrustedLists);

Default Value

FALSE

Remarks

TBD

Data Type

Boolean

CRLs Property (ASiCVerifier Class)

A collection of certificate revocation lists embedded into the signature by the signer.

Syntax

SecureBlackboxList<SecureBlackboxCRL>* GetCRLs();

int secureblackbox_asicverifier_getcrlcount(void* lpObj);

int secureblackbox_asicverifier_getcrlbytes(void* lpObj, int crlindex, char** lpCRLBytes, int* lenCRLBytes);

int64 secureblackbox_asicverifier_getcrlhandle(void* lpObj, int crlindex);

char* secureblackbox_asicverifier_getcrlissuer(void* lpObj, int crlindex);

char* secureblackbox_asicverifier_getcrlissuerrdn(void* lpObj, int crlindex);

char* secureblackbox_asicverifier_getcrllocation(void* lpObj, int crlindex);

char* secureblackbox_asicverifier_getcrlnextupdate(void* lpObj, int crlindex);

int secureblackbox_asicverifier_getcrlsource(void* lpObj, int crlindex);

char* secureblackbox_asicverifier_getcrlthisupdate(void* lpObj, int crlindex);

int GetCRLCount();

QByteArray GetCRLBytes(int iCRLIndex);

qint64 GetCRLHandle(int iCRLIndex);

QString GetCRLIssuer(int iCRLIndex);

QString GetCRLIssuerRDN(int iCRLIndex);

QString GetCRLLocation(int iCRLIndex);

QString GetCRLNextUpdate(int iCRLIndex);

int GetCRLSource(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

SecureBlackboxCRL

ExtractionMode Property (ASiCVerifier Class)

Specifies which entries should be extracted from the container upon verification.

Syntax

ANSI (Cross Platform)
int GetExtractionMode();
int SetExtractionMode(int iExtractionMode);

Unicode (Windows)
INT GetExtractionMode();
INT SetExtractionMode(INT iExtractionMode);

Possible Values

AEM_NONE(0), 
AEM_ALL(1), 
AEM_SIGNED(2), 
AEM_SIGNED_AND_VALID(3)

int secureblackbox_asicverifier_getextractionmode(void* lpObj);
int secureblackbox_asicverifier_setextractionmode(void* lpObj, int iExtractionMode);

int GetExtractionMode();
int SetExtractionMode(int iExtractionMode);

Default Value

Remarks

Use this property to choose entries that should be extracted in the Verify method. Choose between extracting all files, signed-only, signed and with verified signature, and none at all (verify-only mode).


aemNone	`0`
aemAll	`1`
aemSigned	`2`
aemSignedAndValid	`3`

Data Type

Integer

Files Property (ASiCVerifier Class)

Lists all files contained in the container.

Syntax

SecureBlackboxList<SecureBlackboxArchivedFile>* GetFiles();

int secureblackbox_asicverifier_getfilecount(void* lpObj);

int secureblackbox_asicverifier_getfileaction(void* lpObj, int fileindex);

int64 secureblackbox_asicverifier_getfilecompressedsize(void* lpObj, int fileindex);

int secureblackbox_asicverifier_getfiledatasource(void* lpObj, int fileindex);

int secureblackbox_asicverifier_getfiledirectory(void* lpObj, int fileindex);

char* secureblackbox_asicverifier_getfileencryptionalgorithm(void* lpObj, int fileindex);

int secureblackbox_asicverifier_getfileencryptionkeylength(void* lpObj, int fileindex);

int secureblackbox_asicverifier_getfileencryptiontype(void* lpObj, int fileindex);

char* secureblackbox_asicverifier_getfilefilename(void* lpObj, int fileindex);

char* secureblackbox_asicverifier_getfilefolder(void* lpObj, int fileindex);

char* secureblackbox_asicverifier_getfilelocalpath(void* lpObj, int fileindex);

char* secureblackbox_asicverifier_getfilemtime(void* lpObj, int fileindex);

int secureblackbox_asicverifier_getfilenewfile(void* lpObj, int fileindex);

char* secureblackbox_asicverifier_getfilepath(void* lpObj, int fileindex);

int secureblackbox_asicverifier_getfilesignaturecount(void* lpObj, int fileindex);

int secureblackbox_asicverifier_getfilesigned(void* lpObj, int fileindex);

int64 secureblackbox_asicverifier_getfilesize(void* lpObj, int fileindex);

int GetFileCount();

int GetFileAction(int iFileIndex);

qint64 GetFileCompressedSize(int iFileIndex);

int GetFileDataSource(int iFileIndex);

bool GetFileDirectory(int iFileIndex);

QString GetFileEncryptionAlgorithm(int iFileIndex);

int GetFileEncryptionKeyLength(int iFileIndex);

int GetFileEncryptionType(int iFileIndex);

QString GetFileFileName(int iFileIndex);

QString GetFileFolder(int iFileIndex);

QString GetFileLocalPath(int iFileIndex);

QString GetFileMTime(int iFileIndex);

bool GetFileNewFile(int iFileIndex);

QString GetFilePath(int iFileIndex);

int GetFileSignatureCount(int iFileIndex);

bool GetFileSigned(int iFileIndex);

qint64 GetFileSize(int iFileIndex);

Remarks

Use this collection property to walk through the list of files contained in the archive.

This property is read-only and not available at design time.

Data Type

SecureBlackboxArchivedFile

FIPSMode Property (ASiCVerifier Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_asicverifier_getfipsmode(void* lpObj);
int secureblackbox_asicverifier_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 (ASiCVerifier 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_asicverifier_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_asicverifier_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 (ASiCVerifier Class)

Use this property to pass the input to class in the 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_asicverifier_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_asicverifier_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 (ASiCVerifier Class)

A path to the ASiC container to process.

Syntax

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* secureblackbox_asicverifier_getinputfile(void* lpObj);
int secureblackbox_asicverifier_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

Remarks

Use this property to provide a path to the signature container. Use InputStream to provide the container from memory rather than a disk file.

Data Type

String

KnownCertificates Property (ASiCVerifier Class)

Additional certificates for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates();
int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_asicverifier_getknowncertcount(void* lpObj);
int secureblackbox_asicverifier_setknowncertcount(void* lpObj, int iKnownCertCount);

int secureblackbox_asicverifier_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

int64 secureblackbox_asicverifier_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_asicverifier_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 component manually.

The purpose of certificates to be added to this collection is roughly equivalent to that of 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

SecureBlackboxCertificate

KnownCRLs Property (ASiCVerifier Class)

Additional CRLs for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs();
int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);

int secureblackbox_asicverifier_getknowncrlcount(void* lpObj);
int secureblackbox_asicverifier_setknowncrlcount(void* lpObj, int iKnownCRLCount);

int secureblackbox_asicverifier_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);

int64 secureblackbox_asicverifier_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_asicverifier_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

SecureBlackboxCRL

KnownOCSPs Property (ASiCVerifier Class)

Additional OCSP responses for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxOCSPResponse>* GetKnownOCSPs();
int SetKnownOCSPs(SecureBlackboxList<SecureBlackboxOCSPResponse>* val);

int secureblackbox_asicverifier_getknownocspcount(void* lpObj);
int secureblackbox_asicverifier_setknownocspcount(void* lpObj, int iKnownOCSPCount);

int secureblackbox_asicverifier_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);

int64 secureblackbox_asicverifier_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_asicverifier_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

SecureBlackboxOCSPResponse

OCSPs Property (ASiCVerifier Class)

A collection of OCSP responses embedded into the signature.

Syntax

SecureBlackboxList<SecureBlackboxOCSPResponse>* GetOCSPs();

int secureblackbox_asicverifier_getocspcount(void* lpObj);

int secureblackbox_asicverifier_getocspbytes(void* lpObj, int ocspindex, char** lpOCSPBytes, int* lenOCSPBytes);

int64 secureblackbox_asicverifier_getocsphandle(void* lpObj, int ocspindex);

char* secureblackbox_asicverifier_getocspissuer(void* lpObj, int ocspindex);

char* secureblackbox_asicverifier_getocspissuerrdn(void* lpObj, int ocspindex);

char* secureblackbox_asicverifier_getocsplocation(void* lpObj, int ocspindex);

char* secureblackbox_asicverifier_getocspproducedat(void* lpObj, int ocspindex);

int secureblackbox_asicverifier_getocspsource(void* lpObj, int ocspindex);

int GetOCSPCount();

QByteArray GetOCSPBytes(int iOCSPIndex);

qint64 GetOCSPHandle(int iOCSPIndex);

QString GetOCSPIssuer(int iOCSPIndex);

QString GetOCSPIssuerRDN(int iOCSPIndex);

QString GetOCSPLocation(int iOCSPIndex);

QString GetOCSPProducedAt(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

SecureBlackboxOCSPResponse

OfflineMode Property (ASiCVerifier Class)

Switches the class to the offline mode.

Syntax

ANSI (Cross Platform)
int GetOfflineMode();
int SetOfflineMode(int bOfflineMode);

Unicode (Windows)
BOOL GetOfflineMode();
INT SetOfflineMode(BOOL bOfflineMode);

int secureblackbox_asicverifier_getofflinemode(void* lpObj);
int secureblackbox_asicverifier_setofflinemode(void* lpObj, int bOfflineMode);

bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);

Default Value

FALSE

Remarks

When working in offline mode, the component 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 validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

Data Type

Boolean

OutputBytes Property (ASiCVerifier Class)

Use this property to read the output the class object has produced.

Syntax

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_asicverifier_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

Remarks

Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.

This property is read-only and not available at design time.

Data Type

Byte Array

OutputFile Property (ASiCVerifier Class)

The file where the processed data will be saved.

Syntax

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* secureblackbox_asicverifier_getoutputfile(void* lpObj);
int secureblackbox_asicverifier_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

Remarks

Provides a path to the file where the class should save the updated container.

Data Type

String

OutputPath Property (ASiCVerifier Class)

A local path to extract the files to.

Syntax

ANSI (Cross Platform)
char* GetOutputPath();
int SetOutputPath(const char* lpszOutputPath);

Unicode (Windows)
LPWSTR GetOutputPath();
INT SetOutputPath(LPCWSTR lpszOutputPath);

char* secureblackbox_asicverifier_getoutputpath(void* lpObj);
int secureblackbox_asicverifier_setoutputpath(void* lpObj, const char* lpszOutputPath);

QString GetOutputPath();
int SetOutputPath(QString qsOutputPath);

Default Value

Remarks

Assign this property with a path where the extracted files (selected according to ExtractionMode criteria) are to be saved.

Data Type

String

Profile Property (ASiCVerifier 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_asicverifier_getprofile(void* lpObj);
int secureblackbox_asicverifier_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 (ASiCVerifier Class)

The proxy server settings.

Syntax

SecureBlackboxProxySettings* GetProxy();

char* secureblackbox_asicverifier_getproxyaddress(void* lpObj);
int secureblackbox_asicverifier_setproxyaddress(void* lpObj, const char* lpszProxyAddress);

int secureblackbox_asicverifier_getproxyauthentication(void* lpObj);
int secureblackbox_asicverifier_setproxyauthentication(void* lpObj, int iProxyAuthentication);

char* secureblackbox_asicverifier_getproxypassword(void* lpObj);
int secureblackbox_asicverifier_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int secureblackbox_asicverifier_getproxyport(void* lpObj);
int secureblackbox_asicverifier_setproxyport(void* lpObj, int iProxyPort);

int secureblackbox_asicverifier_getproxyproxytype(void* lpObj);
int secureblackbox_asicverifier_setproxyproxytype(void* lpObj, int iProxyProxyType);

char* secureblackbox_asicverifier_getproxyrequestheaders(void* lpObj);
int secureblackbox_asicverifier_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);

char* secureblackbox_asicverifier_getproxyresponsebody(void* lpObj);
int secureblackbox_asicverifier_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);

char* secureblackbox_asicverifier_getproxyresponseheaders(void* lpObj);
int secureblackbox_asicverifier_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);

int secureblackbox_asicverifier_getproxyuseipv6(void* lpObj);
int secureblackbox_asicverifier_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);

char* secureblackbox_asicverifier_getproxyusername(void* lpObj);
int secureblackbox_asicverifier_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

SecureBlackboxProxySettings

RevocationCheck Property (ASiCVerifier Class)

Specifies the kind(s) of revocation check to perform.

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_asicverifier_getrevocationcheck(void* lpObj);
int secureblackbox_asicverifier_setrevocationcheck(void* lpObj, int iRevocationCheck);

int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);

Default Value

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 (CRL) 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`	Check all provided CRL endpoints for all chain certificates.
crcAllOCSP	`3`	Check all provided OCSP endpoints for all chain certificates.
crcAllCRLAndOCSP	`4`	Check all CRL and OCSP endpoints for all chain certificates.
crcAnyCRL	`5`	At least one CRL check for every certificate in the chain must succeed.
crcAnyOCSP	`6`	At least one OCSP check for every certificate in the chain must succeed.
crcAnyCRLOrOCSP	`7`	At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed. 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 faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Data Type

Integer

Signatures Property (ASiCVerifier Class)

Contains the list of signatures included in the ASiC container.

Syntax

SecureBlackboxList<SecureBlackboxASiCSignature>* GetSignatures();

int secureblackbox_asicverifier_getsignaturecount(void* lpObj);

int secureblackbox_asicverifier_getsignaturecertificateindex(void* lpObj, int signatureindex);

int secureblackbox_asicverifier_getsignaturechainvalidationdetails(void* lpObj, int signatureindex);

int secureblackbox_asicverifier_getsignaturechainvalidationresult(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignatureclaimedsigningtime(void* lpObj, int signatureindex);

int secureblackbox_asicverifier_getsignaturecontainslongterminfo(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignaturecontenttype(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignaturefilename(void* lpObj, int signatureindex);

int64 secureblackbox_asicverifier_getsignaturehandle(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignaturehashalgorithm(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignatureissuerrdn(void* lpObj, int signatureindex);

int secureblackbox_asicverifier_getsignaturelevel(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignaturepolicyhash(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignaturepolicyhashalgorithm(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignaturepolicyid(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignaturepolicyuri(void* lpObj, int signatureindex);

int secureblackbox_asicverifier_getsignatureserialnumber(void* lpObj, int signatureindex, char** lpSignatureSerialNumber, int* lenSignatureSerialNumber);

int secureblackbox_asicverifier_getsignaturesignaturebytes(void* lpObj, int signatureindex, char** lpSignatureSignatureBytes, int* lenSignatureSignatureBytes);

int secureblackbox_asicverifier_getsignaturesignaturetype(void* lpObj, int signatureindex);

int secureblackbox_asicverifier_getsignaturesignaturevalidationresult(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignaturesignedfiles(void* lpObj, int signatureindex);

int secureblackbox_asicverifier_getsignaturesubjectkeyid(void* lpObj, int signatureindex, char** lpSignatureSubjectKeyID, int* lenSignatureSubjectKeyID);

char* secureblackbox_asicverifier_getsignaturesubjectrdn(void* lpObj, int signatureindex);

int secureblackbox_asicverifier_getsignaturetimestamped(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignaturevalidatedsigningtime(void* lpObj, int signatureindex);

char* secureblackbox_asicverifier_getsignaturevalidationlog(void* lpObj, int signatureindex);

int GetSignatureCount();

int GetSignatureCertificateIndex(int iSignatureIndex);

int GetSignatureChainValidationDetails(int iSignatureIndex);

int GetSignatureChainValidationResult(int iSignatureIndex);

QString GetSignatureClaimedSigningTime(int iSignatureIndex);

bool GetSignatureContainsLongTermInfo(int iSignatureIndex);

QString GetSignatureContentType(int iSignatureIndex);

QString GetSignatureFileName(int iSignatureIndex);

qint64 GetSignatureHandle(int iSignatureIndex);

QString GetSignatureHashAlgorithm(int iSignatureIndex);

QString GetSignatureIssuerRDN(int iSignatureIndex);

int GetSignatureLevel(int iSignatureIndex);

QString GetSignaturePolicyHash(int iSignatureIndex);

QString GetSignaturePolicyHashAlgorithm(int iSignatureIndex);

QString GetSignaturePolicyID(int iSignatureIndex);

QString GetSignaturePolicyURI(int iSignatureIndex);

QByteArray GetSignatureSerialNumber(int iSignatureIndex);

QByteArray GetSignatureSignatureBytes(int iSignatureIndex);

int GetSignatureSignatureType(int iSignatureIndex);

int GetSignatureSignatureValidationResult(int iSignatureIndex);

QString GetSignatureSignedFiles(int iSignatureIndex);

QByteArray GetSignatureSubjectKeyID(int iSignatureIndex);

QString GetSignatureSubjectRDN(int iSignatureIndex);

bool GetSignatureTimestamped(int iSignatureIndex);

QString GetSignatureValidatedSigningTime(int iSignatureIndex);

QString GetSignatureValidationLog(int iSignatureIndex);

Remarks

Use this property to access all signatures in the container.

This property is read-only and not available at design time.

Data Type

SecureBlackboxASiCSignature

SocketSettings Property (ASiCVerifier Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_asicverifier_getsocketdnsmode(void* lpObj);
int secureblackbox_asicverifier_setsocketdnsmode(void* lpObj, int iSocketDNSMode);

int secureblackbox_asicverifier_getsocketdnsport(void* lpObj);
int secureblackbox_asicverifier_setsocketdnsport(void* lpObj, int iSocketDNSPort);

int secureblackbox_asicverifier_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_asicverifier_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);

char* secureblackbox_asicverifier_getsocketdnsservers(void* lpObj);
int secureblackbox_asicverifier_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);

int secureblackbox_asicverifier_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_asicverifier_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);

int secureblackbox_asicverifier_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_asicverifier_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

char* secureblackbox_asicverifier_getsocketlocaladdress(void* lpObj);
int secureblackbox_asicverifier_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

int secureblackbox_asicverifier_getsocketlocalport(void* lpObj);
int secureblackbox_asicverifier_setsocketlocalport(void* lpObj, int iSocketLocalPort);

int secureblackbox_asicverifier_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_asicverifier_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

int secureblackbox_asicverifier_getsockettimeout(void* lpObj);
int secureblackbox_asicverifier_setsockettimeout(void* lpObj, int iSocketTimeout);

int secureblackbox_asicverifier_getsocketuseipv6(void* lpObj);
int secureblackbox_asicverifier_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

SecureBlackboxSocketSettings

Timestamps Property (ASiCVerifier Class)

Contains a collection of timestamps for the processed document.

Syntax

SecureBlackboxList<SecureBlackboxTimestampInfo>* GetTimestamps();

int secureblackbox_asicverifier_gettimestampcount(void* lpObj);

int64 secureblackbox_asicverifier_gettimestampaccuracy(void* lpObj, int timestampindex);

int secureblackbox_asicverifier_gettimestampbytes(void* lpObj, int timestampindex, char** lpTimestampBytes, int* lenTimestampBytes);

int secureblackbox_asicverifier_gettimestampcertificateindex(void* lpObj, int timestampindex);

int secureblackbox_asicverifier_gettimestampchainvalidationdetails(void* lpObj, int timestampindex);

int secureblackbox_asicverifier_gettimestampchainvalidationresult(void* lpObj, int timestampindex);

int secureblackbox_asicverifier_gettimestampcontainslongterminfo(void* lpObj, int timestampindex);

char* secureblackbox_asicverifier_gettimestamphashalgorithm(void* lpObj, int timestampindex);

int secureblackbox_asicverifier_gettimestampserialnumber(void* lpObj, int timestampindex, char** lpTimestampSerialNumber, int* lenTimestampSerialNumber);

int secureblackbox_asicverifier_gettimestampsignatureindex(void* lpObj, int timestampindex);

char* secureblackbox_asicverifier_gettimestamptime(void* lpObj, int timestampindex);

int secureblackbox_asicverifier_gettimestamptimestamptype(void* lpObj, int timestampindex);

char* secureblackbox_asicverifier_gettimestamptsaname(void* lpObj, int timestampindex);

char* secureblackbox_asicverifier_gettimestampvalidationlog(void* lpObj, int timestampindex);

int secureblackbox_asicverifier_gettimestampvalidationresult(void* lpObj, int timestampindex);

int GetTimestampCount();

qint64 GetTimestampAccuracy(int iTimestampIndex);

QByteArray GetTimestampBytes(int iTimestampIndex);

int GetTimestampCertificateIndex(int iTimestampIndex);

int GetTimestampChainValidationDetails(int iTimestampIndex);

int GetTimestampChainValidationResult(int iTimestampIndex);

bool GetTimestampContainsLongTermInfo(int iTimestampIndex);

QString GetTimestampHashAlgorithm(int iTimestampIndex);

QByteArray GetTimestampSerialNumber(int iTimestampIndex);

int GetTimestampSignatureIndex(int iTimestampIndex);

QString GetTimestampTime(int iTimestampIndex);

int GetTimestampTimestampType(int iTimestampIndex);

QString GetTimestampTSAName(int iTimestampIndex);

QString GetTimestampValidationLog(int iTimestampIndex);

int GetTimestampValidationResult(int iTimestampIndex);

Remarks

Use this property to access the timestamps included in the processed document.

This property is read-only and not available at design time.

Data Type

SecureBlackboxTimestampInfo

TLSClientChain Property (ASiCVerifier Class)

The TLS client certificate chain.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain();
int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_asicverifier_gettlsclientcertcount(void* lpObj);
int secureblackbox_asicverifier_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);

int secureblackbox_asicverifier_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);

int64 secureblackbox_asicverifier_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_asicverifier_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 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

SecureBlackboxCertificate

TLSServerChain Property (ASiCVerifier Class)

The TLS server's certificate chain.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();

int secureblackbox_asicverifier_gettlsservercertcount(void* lpObj);

int secureblackbox_asicverifier_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);

int secureblackbox_asicverifier_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex, char** lpTLSServerCertFingerprint, int* lenTLSServerCertFingerprint);

int64 secureblackbox_asicverifier_gettlsservercerthandle(void* lpObj, int tlsservercertindex);

char* secureblackbox_asicverifier_gettlsservercertissuer(void* lpObj, int tlsservercertindex);

char* secureblackbox_asicverifier_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);

char* secureblackbox_asicverifier_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);

int secureblackbox_asicverifier_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);

int secureblackbox_asicverifier_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);

int secureblackbox_asicverifier_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);

int secureblackbox_asicverifier_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);

char* secureblackbox_asicverifier_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);

char* secureblackbox_asicverifier_gettlsservercertsubject(void* lpObj, int tlsservercertindex);

char* secureblackbox_asicverifier_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);

char* secureblackbox_asicverifier_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);

char* secureblackbox_asicverifier_gettlsservercertvalidto(void* lpObj, int tlsservercertindex);

int GetTLSServerCertCount();

QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);

QByteArray 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 OnCertificateValidate event is fired by the client component.

This property is read-only and not available at design time.

Data Type

SecureBlackboxCertificate

TLSSettings Property (ASiCVerifier Class)

Manages TLS layer settings.

Syntax

SecureBlackboxTLSSettings* GetTLSSettings();

int secureblackbox_asicverifier_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_asicverifier_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);

int secureblackbox_asicverifier_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_asicverifier_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

char* secureblackbox_asicverifier_gettlsciphersuites(void* lpObj);
int secureblackbox_asicverifier_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

int secureblackbox_asicverifier_gettlsclientauth(void* lpObj);
int secureblackbox_asicverifier_settlsclientauth(void* lpObj, int iTLSClientAuth);

char* secureblackbox_asicverifier_gettlseccurves(void* lpObj);
int secureblackbox_asicverifier_settlseccurves(void* lpObj, const char* lpszTLSECCurves);

char* secureblackbox_asicverifier_gettlsextensions(void* lpObj);
int secureblackbox_asicverifier_settlsextensions(void* lpObj, const char* lpszTLSExtensions);

int secureblackbox_asicverifier_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_asicverifier_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);

char* secureblackbox_asicverifier_gettlspresharedidentity(void* lpObj);
int secureblackbox_asicverifier_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);

char* secureblackbox_asicverifier_gettlspresharedkey(void* lpObj);
int secureblackbox_asicverifier_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

char* secureblackbox_asicverifier_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_asicverifier_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);

int secureblackbox_asicverifier_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_asicverifier_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

int secureblackbox_asicverifier_gettlsrevocationcheck(void* lpObj);
int secureblackbox_asicverifier_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

int secureblackbox_asicverifier_gettlsssloptions(void* lpObj);
int secureblackbox_asicverifier_settlsssloptions(void* lpObj, int iTLSSSLOptions);

int secureblackbox_asicverifier_gettlstlsmode(void* lpObj);
int secureblackbox_asicverifier_settlstlsmode(void* lpObj, int iTLSTLSMode);

int secureblackbox_asicverifier_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_asicverifier_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

int secureblackbox_asicverifier_gettlsusesessionresumption(void* lpObj);
int secureblackbox_asicverifier_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

int secureblackbox_asicverifier_gettlsversions(void* lpObj);
int secureblackbox_asicverifier_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

SecureBlackboxTLSSettings

TrustedCertificates Property (ASiCVerifier Class)

A list of trusted certificates for chain validation.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates();
int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_asicverifier_gettrustedcertcount(void* lpObj);
int secureblackbox_asicverifier_settrustedcertcount(void* lpObj, int iTrustedCertCount);

int secureblackbox_asicverifier_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);

int64 secureblackbox_asicverifier_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_asicverifier_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 than that of 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

SecureBlackboxCertificate

ValidationMoment Property (ASiCVerifier 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_asicverifier_getvalidationmoment(void* lpObj);
int secureblackbox_asicverifier_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 signature creation time, or 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

Close Method (ASiCVerifier Class)

Closes an opened container.

Syntax

ANSI (Cross Platform)
int Close(int bSaveChanges);

Unicode (Windows)
INT Close(BOOL bSaveChanges);

int secureblackbox_asicverifier_close(void* lpObj, int bSaveChanges);

int Close(bool bSaveChanges);

Remarks

Use this method to close a previously opened container. Set SaveChanges to true to apply any changes made.

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.)

Config Method (ASiCVerifier Class)

This method sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_asicverifier_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 (ASiCVerifier 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_asicverifier_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 insencitive) 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++)

ExtractFile Method (ASiCVerifier Class)

Extracts a file to one of the output media (bytes, stream, or disk file).

Syntax

ANSI (Cross Platform)
int ExtractFile(const char* lpszFileName);

Unicode (Windows)
INT ExtractFile(LPCWSTR lpszFileName);

int secureblackbox_asicverifier_extractfile(void* lpObj, const char* lpszFileName);

int ExtractFile(const QString& qsFileName);

Remarks

Use this method to extract a single archived

Error Handling (C++)

ExtractFiles Method (ASiCVerifier Class)

Extracts files covered by a signature to OutputPath .

Syntax

ANSI (Cross Platform)
int ExtractFiles(int iSigIndex);

Unicode (Windows)
INT ExtractFiles(INT iSigIndex);

int secureblackbox_asicverifier_extractfiles(void* lpObj, int iSigIndex);

int ExtractFiles(int iSigIndex);

Remarks

Use this method to extract all files covered by the signature SigIndex to OutputPath. Set SigIndex to -1 to extract all the files included in the container.

Error Handling (C++)

Open Method (ASiCVerifier Class)

Opens an existing container for signing or updating.

Syntax

ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();

int secureblackbox_asicverifier_open(void* lpObj);

int Open();

Remarks

Use this method to open a container for signing or updating. When finished, call Close to complete or discard the operation.

Error Handling (C++)

Reset Method (ASiCVerifier Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_asicverifier_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

Revalidate Method (ASiCVerifier Class)

Revalidates a signature in accordance with current settings.

Syntax

ANSI (Cross Platform)
int Revalidate(int iIndex);

Unicode (Windows)
INT Revalidate(INT iIndex);

int secureblackbox_asicverifier_revalidate(void* lpObj, int iIndex);

int Revalidate(int iIndex);

Remarks

Use this method to re-validate a signature in the opened ASiC document.

Error Handling (C++)

SelectRevInfo Method (ASiCVerifier Class)

TBD.

Syntax

ANSI (Cross Platform)
int SelectRevInfo(int iSigIndex, int iRevInfoType);

Unicode (Windows)
INT SelectRevInfo(INT iSigIndex, INT iRevInfoType);

int secureblackbox_asicverifier_selectrevinfo(void* lpObj, int iSigIndex, int iRevInfoType);

int SelectRevInfo(int iSigIndex, int iRevInfoType);

Remarks

TBD

Error Handling (C++)

Unsign Method (ASiCVerifier Class)

Deletes a signature from the container.

Syntax

ANSI (Cross Platform)
int Unsign(int iSigIndex);

Unicode (Windows)
INT Unsign(INT iSigIndex);

int secureblackbox_asicverifier_unsign(void* lpObj, int iSigIndex);

int Unsign(int iSigIndex);

Remarks

Use this method to delete an existing signature from the container. Use SigIndex parameter to specify the signature to be removed.

Error Handling (C++)

Verify Method (ASiCVerifier Class)

Verifies all signatures in the ASiC container.

Syntax

ANSI (Cross Platform)
int Verify();

Unicode (Windows)
INT Verify();

int secureblackbox_asicverifier_verify(void* lpObj);

int Verify();

Remarks

Use this method to verify the signature and any associated signed files residing in the ASiC container.

When processing the container, the verifier walks through all the signatures contained in the message, one after another.

For each signature, the SignatureFound event is thrown. The benefits of this are that it:

Lets you know some basic details about the signature and its creator
Allows you to tell the component whether or not you want to validate it and/or its signing certificate's chain
Gives you a chance to provide any missing certificates (CertFound indicates whether you need to do that)

The control then validates the signature and the chain (if told to do so in SignatureFound), reporting the validity of each via SignatureValidated and ChainValidated events, respectively. Before these events are fired, the properties of the signature are populated in the control's properties. Two properties that may be useful to read inside the event handlers are those reporting the signature's creation time, ClaimedSigningTime and ValidatedSigningTime.

The control's properties remain assigned with the last processed signature's details, and are still available after the Verify() call returns, providing a handy way to work with single-signature containers.

Once the main signature's processing completes, the control proceeds to its subordinate elements (countersignatures and/or timestamps). Each timestamp is reported via TimestampValidated event.

Having reported all the countersignatures and timestamps, the control proceeds to the next main signature and any timestamps associated with it - and so on.

Error Handling (C++)

ChainElementDownload Event (ASiCVerifier Class)

Fires when there is a need to download a chain element from an online source.

Syntax

ANSI (Cross Platform)
virtual int FireChainElementDownload(ASiCVerifierChainElementDownloadEventParams *e);

typedef struct {
  int Kind;
  const char *CertRDN;
  const char *CACertRDN;
  const char *Location;
  int Action;
  int reserved;
} ASiCVerifierChainElementDownloadEventParams;


Unicode (Windows)
virtual INT FireChainElementDownload(ASiCVerifierChainElementDownloadEventParams *e);

typedef struct {
  INT Kind;
  LPCWSTR CertRDN;
  LPCWSTR CACertRDN;
  LPCWSTR Location;
  INT Action;
  INT reserved;
} ASiCVerifierChainElementDownloadEventParams;

#define EID_ASICVERIFIER_CHAINELEMENTDOWNLOAD 1

virtual INT SECUREBLACKBOX_CALL FireChainElementDownload(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, LPSTR &lpszLocation, INT &iAction);

class ASiCVerifierChainElementDownloadEventParams {
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(ASiCVerifierChainElementDownloadEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireChainElementDownload(ASiCVerifierChainElementDownloadEventParams *e) {...}

Remarks

Subscribe to this event to be notified about validation element retrievals. Use 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

ChainElementNeeded Event (ASiCVerifier Class)

Fires when an element required to validate the chain was not located.

Syntax

ANSI (Cross Platform)
virtual int FireChainElementNeeded(ASiCVerifierChainElementNeededEventParams *e);

typedef struct {
  int Kind;
  const char *CertRDN;
  const char *CACertRDN;
  int reserved;
} ASiCVerifierChainElementNeededEventParams;


Unicode (Windows)
virtual INT FireChainElementNeeded(ASiCVerifierChainElementNeededEventParams *e);

typedef struct {
  INT Kind;
  LPCWSTR CertRDN;
  LPCWSTR CACertRDN;
  INT reserved;
} ASiCVerifierChainElementNeededEventParams;

#define EID_ASICVERIFIER_CHAINELEMENTNEEDED 2

virtual INT SECUREBLACKBOX_CALL FireChainElementNeeded(INT &iKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN);

class ASiCVerifierChainElementNeededEventParams {
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(ASiCVerifierChainElementNeededEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireChainElementNeeded(ASiCVerifierChainElementNeededEventParams *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.

ChainElementStore Event (ASiCVerifier Class)

This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.

Syntax

ANSI (Cross Platform)
virtual int FireChainElementStore(ASiCVerifierChainElementStoreEventParams *e);

typedef struct {
  int Kind;
  const char *Body;
  int lenBody;
  char *URI;
  int reserved;
} ASiCVerifierChainElementStoreEventParams;


Unicode (Windows)
virtual INT FireChainElementStore(ASiCVerifierChainElementStoreEventParams *e);

typedef struct {
  INT Kind;
  LPCSTR Body;
  INT lenBody;
  LPWSTR URI;
  INT reserved;
} ASiCVerifierChainElementStoreEventParams;

#define EID_ASICVERIFIER_CHAINELEMENTSTORE 3

virtual INT SECUREBLACKBOX_CALL FireChainElementStore(INT &iKind, LPSTR &lpBody, INT &lenBody, LPSTR &lpszURI);

class ASiCVerifierChainElementStoreEventParams {
public:
  int Kind();

  const QByteArray &Body();

  const QString &URI();
  void SetURI(const QString &qsURI);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ChainElementStore(ASiCVerifierChainElementStoreEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireChainElementStore(ASiCVerifierChainElementStoreEventParams *e) {...}

Remarks

This event could occur if you are verifying XAdES-C form or higher. The Body parameter contains the element in binary form that should be stored along with a signature. Use the URI parameter to provide an URI of the stored element.

ChainValidated Event (ASiCVerifier Class)

Reports the completion of a certificate chain validation.

Syntax

ANSI (Cross Platform)
virtual int FireChainValidated(ASiCVerifierChainValidatedEventParams *e);

typedef struct {
  int Index;
  const char *SubjectRDN;
  int ValidationResult;
  int ValidationDetails;
  int reserved;
} ASiCVerifierChainValidatedEventParams;


Unicode (Windows)
virtual INT FireChainValidated(ASiCVerifierChainValidatedEventParams *e);

typedef struct {
  INT Index;
  LPCWSTR SubjectRDN;
  INT ValidationResult;
  INT ValidationDetails;
  INT reserved;
} ASiCVerifierChainValidatedEventParams;

#define EID_ASICVERIFIER_CHAINVALIDATED 4

virtual INT SECUREBLACKBOX_CALL FireChainValidated(INT &iIndex, LPSTR &lpszSubjectRDN, INT &iValidationResult, INT &iValidationDetails);

class ASiCVerifierChainValidatedEventParams {
public:
  int Index();

  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(ASiCVerifierChainValidatedEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireChainValidated(ASiCVerifierChainValidatedEventParams *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)

Any other value reports a failure, and ValidationDetails provides more details on its reasons.


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 (ASiCVerifier 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(ASiCVerifierChainValidationProgressEventParams *e);

typedef struct {
  const char *EventKind;
  const char *CertRDN;
  const char *CACertRDN;
  int Action;
  int reserved;
} ASiCVerifierChainValidationProgressEventParams;


Unicode (Windows)
virtual INT FireChainValidationProgress(ASiCVerifierChainValidationProgressEventParams *e);

typedef struct {
  LPCWSTR EventKind;
  LPCWSTR CertRDN;
  LPCWSTR CACertRDN;
  INT Action;
  INT reserved;
} ASiCVerifierChainValidationProgressEventParams;

#define EID_ASICVERIFIER_CHAINVALIDATIONPROGRESS 5

virtual INT SECUREBLACKBOX_CALL FireChainValidationProgress(LPSTR &lpszEventKind, LPSTR &lpszCertRDN, LPSTR &lpszCACertRDN, INT &iAction);

class ASiCVerifierChainValidationProgressEventParams {
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(ASiCVerifierChainValidationProgressEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireChainValidationProgress(ASiCVerifierChainValidationProgressEventParams *e) {...}

Remarks

Subscribe to this event to be notified about chain validation progress. Use Action parameter to alter the validation flow.

The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind. Use 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

ContainerLoaded Event (ASiCVerifier Class)

This event is fired when the container has been loaded into memory.

Syntax

ANSI (Cross Platform)
virtual int FireContainerLoaded(ASiCVerifierContainerLoadedEventParams *e);

typedef struct {
  int Cancel;
  int reserved;
} ASiCVerifierContainerLoadedEventParams;


Unicode (Windows)
virtual INT FireContainerLoaded(ASiCVerifierContainerLoadedEventParams *e);

typedef struct {
  BOOL Cancel;
  INT reserved;
} ASiCVerifierContainerLoadedEventParams;

#define EID_ASICVERIFIER_CONTAINERLOADED 6

virtual INT SECUREBLACKBOX_CALL FireContainerLoaded(BOOL &bCancel);

class ASiCVerifierContainerLoadedEventParams {
public:
  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ContainerLoaded(ASiCVerifierContainerLoadedEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireContainerLoaded(ASiCVerifierContainerLoadedEventParams *e) {...}

Remarks

The handler for this event is a good place to check for any existing signatures and validate them if required.

Set Cancel to true to terminate document processing on this stage.

Error Event (ASiCVerifier Class)

Information about errors during ASiC signature verification.

Syntax

ANSI (Cross Platform)
virtual int FireError(ASiCVerifierErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} ASiCVerifierErrorEventParams;


Unicode (Windows)
virtual INT FireError(ASiCVerifierErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} ASiCVerifierErrorEventParams;

#define EID_ASICVERIFIER_ERROR 7

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class ASiCVerifierErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(ASiCVerifierErrorEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireError(ASiCVerifierErrorEventParams *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.

FileExtractionStart Event (ASiCVerifier Class)

Signifies the start of a file extraction process.

Syntax

ANSI (Cross Platform)
virtual int FireFileExtractionStart(ASiCVerifierFileExtractionStartEventParams *e);

typedef struct {
  const char *FileName;
  int64 FileSize;
  const char *ModDate;
  int Extract;
  char *DestFile;
  int reserved;
} ASiCVerifierFileExtractionStartEventParams;


Unicode (Windows)
virtual INT FireFileExtractionStart(ASiCVerifierFileExtractionStartEventParams *e);

typedef struct {
  LPCWSTR FileName;
  LONG64 FileSize;
  LPCWSTR ModDate;
  BOOL Extract;
  LPWSTR DestFile;
  INT reserved;
} ASiCVerifierFileExtractionStartEventParams;

#define EID_ASICVERIFIER_FILEEXTRACTIONSTART 8

virtual INT SECUREBLACKBOX_CALL FireFileExtractionStart(LPSTR &lpszFileName, LONG64 &lFileSize, LPSTR &lpszModDate, BOOL &bExtract, LPSTR &lpszDestFile);

class ASiCVerifierFileExtractionStartEventParams {
public:
  const QString &FileName();

  qint64 FileSize();

  const QString &ModDate();

  bool Extract();
  void SetExtract(bool bExtract);

  const QString &DestFile();
  void SetDestFile(const QString &qsDestFile);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FileExtractionStart(ASiCVerifierFileExtractionStartEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireFileExtractionStart(ASiCVerifierFileExtractionStartEventParams *e) {...}

Remarks

This event fires for every file located in the archive and matching the ExtractionMode setting before it is to be extracted.

DestFile indicates the path where the file will be saved to. You can alter the destination path here, by providing an alternative extraction path.

Set DestFile to an empty string and provide a stream object via the OutputStream property if you prefer to save the data to a stream instead of file.

If DestFile is set to an empty string and OutputStream is unassigned, the file will not be extracted.

Alternatively, you can request the extracted content to be saved into a byte array. To do this, leave DestFile and OutputStream empty, and keep the Extract parameter enabled.

Please take care when extracting large files into byte arrays, as those may consume large amounts of memory.

Note: if DestFile already exists, the class will overwrite it. To prevent overwriting of existing files, subscribe to this event, and change DestFile when needed.

Notification Event (ASiCVerifier Class)

This event notifies the application about an underlying control flow event.

Syntax

ANSI (Cross Platform)
virtual int FireNotification(ASiCVerifierNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} ASiCVerifierNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(ASiCVerifierNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} ASiCVerifierNotificationEventParams;

#define EID_ASICVERIFIER_NOTIFICATION 9

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class ASiCVerifierNotificationEventParams {
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(ASiCVerifierNotificationEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireNotification(ASiCVerifierNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

SignatureFound Event (ASiCVerifier Class)

Signifies the start of signature validation.

Syntax

ANSI (Cross Platform)
virtual int FireSignatureFound(ASiCVerifierSignatureFoundEventParams *e);

typedef struct {
  int Index;
  const char *IssuerRDN;
  const char *SerialNumber;
  int lenSerialNumber;
  const char *SubjectKeyID;
  int lenSubjectKeyID;
  int CertFound;
  int ValidateSignature;
  int ValidateChain;
  int reserved;
} ASiCVerifierSignatureFoundEventParams;


Unicode (Windows)
virtual INT FireSignatureFound(ASiCVerifierSignatureFoundEventParams *e);

typedef struct {
  INT Index;
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  BOOL CertFound;
  BOOL ValidateSignature;
  BOOL ValidateChain;
  INT reserved;
} ASiCVerifierSignatureFoundEventParams;

#define EID_ASICVERIFIER_SIGNATUREFOUND 10

virtual INT SECUREBLACKBOX_CALL FireSignatureFound(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);

class ASiCVerifierSignatureFoundEventParams {
public:
  int Index();

  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(ASiCVerifierSignatureFoundEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireSignatureFound(ASiCVerifierSignatureFoundEventParams *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 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 KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SignatureValidated Event (ASiCVerifier Class)

Marks the completion of the signature validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireSignatureValidated(ASiCVerifierSignatureValidatedEventParams *e);

typedef struct {
  int Index;
  const char *IssuerRDN;
  const char *SerialNumber;
  int lenSerialNumber;
  const char *SubjectKeyID;
  int lenSubjectKeyID;
  int ValidationResult;
  int reserved;
} ASiCVerifierSignatureValidatedEventParams;


Unicode (Windows)
virtual INT FireSignatureValidated(ASiCVerifierSignatureValidatedEventParams *e);

typedef struct {
  INT Index;
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  INT ValidationResult;
  INT reserved;
} ASiCVerifierSignatureValidatedEventParams;

#define EID_ASICVERIFIER_SIGNATUREVALIDATED 11

virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult);

class ASiCVerifierSignatureValidatedEventParams {
public:
  int Index();

  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(ASiCVerifierSignatureValidatedEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireSignatureValidated(ASiCVerifierSignatureValidatedEventParams *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 (ASiCVerifier Class)

Signifies the start of a timestamp validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireTimestampFound(ASiCVerifierTimestampFoundEventParams *e);

typedef struct {
  int Index;
  const char *IssuerRDN;
  const char *SerialNumber;
  int lenSerialNumber;
  const char *SubjectKeyID;
  int lenSubjectKeyID;
  int CertFound;
  int ValidateTimestamp;
  int ValidateChain;
  int reserved;
} ASiCVerifierTimestampFoundEventParams;


Unicode (Windows)
virtual INT FireTimestampFound(ASiCVerifierTimestampFoundEventParams *e);

typedef struct {
  INT Index;
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  BOOL CertFound;
  BOOL ValidateTimestamp;
  BOOL ValidateChain;
  INT reserved;
} ASiCVerifierTimestampFoundEventParams;

#define EID_ASICVERIFIER_TIMESTAMPFOUND 12

virtual INT SECUREBLACKBOX_CALL FireTimestampFound(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateTimestamp, BOOL &bValidateChain);

class ASiCVerifierTimestampFoundEventParams {
public:
  int Index();

  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(ASiCVerifierTimestampFoundEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireTimestampFound(ASiCVerifierTimestampFoundEventParams *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.

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 SignatureValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

TimestampValidated Event (ASiCVerifier Class)

Reports the completion of the timestamp validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireTimestampValidated(ASiCVerifierTimestampValidatedEventParams *e);

typedef struct {
  int Index;
  const char *IssuerRDN;
  const char *SerialNumber;
  int lenSerialNumber;
  const char *SubjectKeyID;
  int lenSubjectKeyID;
  const char *Time;
  int ValidationResult;
  int ChainValidationResult;
  int ChainValidationDetails;
  int reserved;
} ASiCVerifierTimestampValidatedEventParams;


Unicode (Windows)
virtual INT FireTimestampValidated(ASiCVerifierTimestampValidatedEventParams *e);

typedef struct {
  INT Index;
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  LPCWSTR Time;
  INT ValidationResult;
  INT ChainValidationResult;
  INT ChainValidationDetails;
  INT reserved;
} ASiCVerifierTimestampValidatedEventParams;

#define EID_ASICVERIFIER_TIMESTAMPVALIDATED 13

virtual INT SECUREBLACKBOX_CALL FireTimestampValidated(INT &iIndex, LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, LPSTR &lpszTime, INT &iValidationResult, INT &iChainValidationResult, INT &iChainValidationDetails);

class ASiCVerifierTimestampValidatedEventParams {
public:
  int Index();

  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(ASiCVerifierTimestampValidatedEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireTimestampValidated(ASiCVerifierTimestampValidatedEventParams *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 (ASiCVerifier Class)

Fires when a remote TLS party requests a client certificate.

Syntax

ANSI (Cross Platform)
virtual int FireTLSCertNeeded(ASiCVerifierTLSCertNeededEventParams *e);

typedef struct {
  const char *Host;
  const char *CANames;
  int reserved;
} ASiCVerifierTLSCertNeededEventParams;


Unicode (Windows)
virtual INT FireTLSCertNeeded(ASiCVerifierTLSCertNeededEventParams *e);

typedef struct {
  LPCWSTR Host;
  LPCWSTR CANames;
  INT reserved;
} ASiCVerifierTLSCertNeededEventParams;

#define EID_ASICVERIFIER_TLSCERTNEEDED 14

virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);

class ASiCVerifierTLSCertNeededEventParams {
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(ASiCVerifierTLSCertNeededEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireTLSCertNeeded(ASiCVerifierTLSCertNeededEventParams *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 (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 (ASiCVerifier 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(ASiCVerifierTLSCertValidateEventParams *e);

typedef struct {
  const char *ServerHost;
  const char *ServerIP;
  int Accept;
  int reserved;
} ASiCVerifierTLSCertValidateEventParams;


Unicode (Windows)
virtual INT FireTLSCertValidate(ASiCVerifierTLSCertValidateEventParams *e);

typedef struct {
  LPCWSTR ServerHost;
  LPCWSTR ServerIP;
  BOOL Accept;
  INT reserved;
} ASiCVerifierTLSCertValidateEventParams;

#define EID_ASICVERIFIER_TLSCERTVALIDATE 15

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);

class ASiCVerifierTLSCertValidateEventParams {
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(ASiCVerifierTLSCertValidateEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireTLSCertValidate(ASiCVerifierTLSCertValidateEventParams *e) {...}

Remarks

This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components 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 component, and can be adjusted if needed.

TLSEstablished Event (ASiCVerifier Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

ANSI (Cross Platform)
virtual int FireTLSEstablished(ASiCVerifierTLSEstablishedEventParams *e);

typedef struct {
  const char *Host;
  const char *Version;
  const char *Ciphersuite;
  const char *ConnectionId;
  int lenConnectionId;
  int Abort;
  int reserved;
} ASiCVerifierTLSEstablishedEventParams;


Unicode (Windows)
virtual INT FireTLSEstablished(ASiCVerifierTLSEstablishedEventParams *e);

typedef struct {
  LPCWSTR Host;
  LPCWSTR Version;
  LPCWSTR Ciphersuite;
  LPCSTR ConnectionId;
  INT lenConnectionId;
  BOOL Abort;
  INT reserved;
} ASiCVerifierTLSEstablishedEventParams;

#define EID_ASICVERIFIER_TLSESTABLISHED 16

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);

class ASiCVerifierTLSEstablishedEventParams {
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(ASiCVerifierTLSEstablishedEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireTLSEstablished(ASiCVerifierTLSEstablishedEventParams *e) {...}

Remarks

The class uses this event to notify the application about successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (ASiCVerifier Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

ANSI (Cross Platform)
virtual int FireTLSHandshake(ASiCVerifierTLSHandshakeEventParams *e);

typedef struct {
  const char *Host;
  int Abort;
  int reserved;
} ASiCVerifierTLSHandshakeEventParams;


Unicode (Windows)
virtual INT FireTLSHandshake(ASiCVerifierTLSHandshakeEventParams *e);

typedef struct {
  LPCWSTR Host;
  BOOL Abort;
  INT reserved;
} ASiCVerifierTLSHandshakeEventParams;

#define EID_ASICVERIFIER_TLSHANDSHAKE 17

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);

class ASiCVerifierTLSHandshakeEventParams {
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(ASiCVerifierTLSHandshakeEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireTLSHandshake(ASiCVerifierTLSHandshakeEventParams *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 with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.

TLSShutdown Event (ASiCVerifier Class)

Reports the graceful closure of a TLS connection.

Syntax

ANSI (Cross Platform)
virtual int FireTLSShutdown(ASiCVerifierTLSShutdownEventParams *e);

typedef struct {
  const char *Host;
  int reserved;
} ASiCVerifierTLSShutdownEventParams;


Unicode (Windows)
virtual INT FireTLSShutdown(ASiCVerifierTLSShutdownEventParams *e);

typedef struct {
  LPCWSTR Host;
  INT reserved;
} ASiCVerifierTLSShutdownEventParams;

#define EID_ASICVERIFIER_TLSSHUTDOWN 18

virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);

class ASiCVerifierTLSShutdownEventParams {
public:
  const QString &Host();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TLSShutdown(ASiCVerifierTLSShutdownEventParams *e);

// Or, subclass ASiCVerifier and override this emitter function.
virtual int FireTLSShutdown(ASiCVerifierTLSShutdownEventParams *e) {...}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

ArchivedFile Type

Provides information about the compressed file.

Syntax

SecureBlackboxArchivedFile (declared in secureblackbox.h)

Remarks

Use this type to access compressed file details.

Fields

Action
int
Default Value: 0

The action to apply to the file.

Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:


atAdd (0)	Add the file to the archive
atKeep (1)	Keep the existing file in the archive
atUpdate (2)	Update the archived file with a fresher copy
atDelete (3)	Delete the file from the archive
atExtract (4)	Extract the file (extraction only)
atSkip (5)	Skip file extraction (extraction only)

CompressedSize
int64 (read-only)
Default Value: 0

The size of the file after compression.

DataSource
int
Default Value: 0

The type of the data source for this entry.

Use this property to control the data source for this entry.


fdsFile (0)	The data for this entry should be taken from the file provided via .
fdsStream (1)	The data is going to be provided on-the-fly via the FileStream property.
fdsBuffer (2)	The data is going to be provided on-the-fly via the FileData property.

Directory
int (read-only)
Default Value: FALSE

Tells if the entry is a directory or a regular file.

EncryptionAlgorithm
char* (read-only)
Default Value: ""

Returns the symmetric algorithm that was used to encrypt the file.

EncryptionKeyLength
int (read-only)
Default Value: 0

Returns the length, in bits, of the encryption key.

EncryptionType
int (read-only)
Default Value: 0

The type of encryption applied to the file.

Use this property to find out what kind of encryption was applied to the file.


aetDefault (0)	Default encryption (not used for already encrypted files)
aetNoEncryption (1)	No encryption
aetGeneric (2)	Standard ZIP encryption
aetWinZip (3)	WinZIP-based encryption
aetStrong (4)	Strong encryption

FileName
char*
Default Value: ""

The original name of the compressed file or folder.

Folder
char* (read-only)
Default Value: ""

The containing folder of the entry.

LocalPath
char*
Default Value: ""

The local path associated with this entry. It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.

MTime
char*
Default Value: ""

The entry's last modification time.

NewFile
int (read-only)
Default Value: FALSE

Indicates whether the entry corresponds to a file to be added to the archive.

Path
char* (read-only)
Default Value: ""

The full internal path of the archived entry.

SignatureCount
int (read-only)
Default Value: 0

The number of signatures covering the entry.

Signed
int (read-only)
Default Value: FALSE

Indicates whether the entry is signed.

Size
int64 (read-only)
Default Value: 0

The size of the file before compression.

Constructors

ArchivedFile()

Creates a new ArchivedFile object.

ASiCSignature Type

Represents a signature in the ASiC container.

Syntax

SecureBlackboxASiCSignature (declared in secureblackbox.h)

Remarks

This type contains information about a signature found in ASiC container. It holds various information about the signature, including its coverage and validation results.

An ASiC-S container can include one CAdES, and/or one XAdES, and/or one Timestamp. An ASiC-E container can include multiple CAdES signatures, XAdES signatures, and timestamp tokens.

Fields

CertificateIndex
int (read-only)
Default Value: -1

Returns the index of the signing certificate in the Certificates collection

Use this property to look up the signing certificate in the Certificates collection.

ChainValidationDetails
int (read-only)
Default Value: 0

The details of a certificate chain validation outcome. They may often suggest what 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*
Default Value: ""

Returns or sets signature's creation time.

Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike does not originate from a trusted TSA and may be forfeited or wrong.

The time is provided in UTC.

ContainsLongTermInfo
int (read-only)
Default Value: FALSE

TBD

ContentType
char*
Default Value: ""

The signature content type.

Use this property to get or set the content type OID to be included with the signature.

FileName
char*
Default Value: ""

The name of the ASiC signature file.

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: ""

Set or returns the hash algorithm used to generate the signature.

Check this property after verifying the signature to get the hash algorithm which was used to calculate it. When creating a signed file, use this property to specify the hash algorithm to use.


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`

IssuerRDN
char* (read-only)
Default Value: ""

The Relative Distinguished Name of the signing certificate's issuer.

A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.

Level
int
Default Value: 0

Specifies the level according to which the inner AdES signature is to be composed

CAdES and XAdES standards define a number of signature levels. The main differences between levels are in the scope of validation information included to the signature. BES signatures only include the most necessary information (the signing chain), whereas XL and A signatures include the complete set.

The supported levels are:


aslUnknown	`0`
aslBES	`1`	BES form
aslEPES	`2`	EPES form
aslT	`3`	T form
aslC	`4`	C form
aslXType1	`5`	X form (type 1)
aslXType2	`6`	X form (type 2)
aslXLType1	`7`	X-L form (type 1)
aslXLType2	`8`	X-L form (type 2)
aslBaselineB	`9`	Baseline B (B-B, basic)
aslBaselineT	`10`	Baseline T (B-T, timestamped)
aslBaselineLT	`11`	Baseline LT (B-LT, long-term)
aslBaselineLTA	`12`	Baseline LTA (B-LTA, long-term with archived timestamp)
aslExtendedBES	`13`	Extended BES form
aslExtendedEPES	`14`	Extended EPES form
aslExtendedT	`15`	Extended T form
aslExtendedC	`16`	Extended C form
aslExtendedXType1	`17`	Extended X form (type 1)
aslExtendedXType2	`18`	Extended X form (type 2)
aslExtendedXLType1	`19`	Extended X-L form (type 1)
aslExtendedXLType2	`20`	Extended X-L form (type 1)
aslA	`21`	A form
aslExtendedA	`22`	Extended A form

PolicyHash
char*
Default Value: ""

The signature policy hash value.

Use this property to get the signature policy hash from EPES signatures

PolicyHashAlgorithm
char*
Default Value: ""

The algorithm that was used to calculate the signature policy hash

Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from .


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`

PolicyID
char*
Default Value: ""

The policy ID that was included or to be included into the signature.

Use this property to retrieve the signature policy identifier from EPES signatures.

PolicyURI
char*
Default Value: ""

The signature policy URI that was included in the signature.

Use this property to set or retrieve the URI of the signature policy from EPES signatures.

SerialNumber
char* (read-only)
Default Value:

The serial number of the timestamp.

SignatureBytes
char* (read-only)
Default Value:

Returns the binary representation of the ASiC signature.

SignatureType
int
Default Value: 0

The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown.


castUnknown	`0`
castCAdES	`1`
castXAdES	`2`
castTimestamp	`3`

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)

SignedFiles
char* (read-only)
Default Value: ""

Contains a comma-separated list of files that are covered by the signature.

SubjectKeyID
char* (read-only)
Default Value:

Contains the subject key identifier of the signing certificate.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.

SubjectRDN
char* (read-only)
Default Value: ""

Contains the RDN of the owner of the signing certificate.

RDN is a number of OID=Value pairs declared in the certificate and providing the owner's details.

Timestamped
int (read-only)
Default Value: FALSE

Use this property to establish whether the signature contains an embedded timestamp.

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.

Constructors

ASiCSignature()

Creates a new empty ASiC signature object.

Certificate Type

Provides details of an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type provides access to X.509 certificate details.

Fields

Bytes
char* (read-only)
Default Value:

Returns raw certificate data in DER format.

CA
int
Default Value: FALSE

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

CAKeyID
char* (read-only)
Default Value:

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

CertType
int (read-only)
Default Value: 0

Returns the type of the entity contained in the object.

CRLDistributionPoints
char*
Default Value: ""

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Curve
char*
Default Value: ""

Specifies the elliptic curve of the EC public key.


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.

FriendlyName
char* (read-only)
Default Value: ""

Contains an associated alias (friendly name) of the certificate.

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.

HashAlgorithm
char*
Default Value: ""

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)


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.

IssuerRDN
char*
Default Value: ""

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

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`

KeyBits
int (read-only)
Default Value: 0

Returns the length of the public key.

KeyFingerprint
char* (read-only)
Default Value:

Returns a fingerprint of the public key contained in the certificate.

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

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 (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

OCSPNoCheck
int
Default Value: FALSE

Accessor to the value of the certificates ocsp-no-check extension.

Origin
int (read-only)
Default Value: 0

Returns the origin of this certificate.

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.

PrivateKeyBytes
char* (read-only)
Default Value:

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

PrivateKeyExists
int (read-only)
Default Value: FALSE

Indicates whether the certificate has an associated private key.

PrivateKeyExtractable
int (read-only)
Default Value: FALSE

Indicates whether the private key is extractable

PublicKeyBytes
char* (read-only)
Default Value:

Contains the certificate's public key in DER format.

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 TSL to be qualified.

QualifiedStatements
int
Default Value: 0

Returns the qualified status of the certificate.

Qualifiers
char* (read-only)
Default Value: ""

A list of qualifiers.

Contains a comma-separated list of qualifiers 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.

SigAlgorithm
char* (read-only)
Default Value: ""

Indicates the algorithm that was used by the CA to sign this certificate.

Source
int (read-only)
Default Value: 0

Returns the source of the entity contained in the object.

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.

SubjectAlternativeName
char*
Default Value: ""

Returns or sets the value of the Subject Alternative Name extension of the certificate.

SubjectKeyID
char*
Default Value:

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

SubjectRDN
char*
Default Value: ""

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Valid
int (read-only)
Default Value: FALSE

Indicates whether or not the signature on the request is valid and matches the public key contained in the 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(const char* lpBytes, int lenBytes, int iStartIndex, int iCount, const char* lpszPassword)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

Certificate(const char* lpCertBytes, int lenCertBytes, int iCertStartIndex, int iCertCount, const char* lpKeyBytes, int lenKeyBytes, int iKeyStartIndex, int iKeyCount, const char* lpszPassword)

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

Certificate(const char* lpBytes, int lenBytes, int iStartIndex, int iCount)

Certificate(const char* lpszPath, const char* lpszPassword)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

Certificate(const char* lpszCertPath, const char* lpszKeyPath, const char* lpszPassword)

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

Certificate(const char* lpszPath)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

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 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.

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* (read-only)
Default Value: ""

The planned time and date of the next version of this CRL to be published.

SigAlgorithm
char* (read-only)
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 of the entity contained in the object.

TBS
char* (read-only)
Default Value:

The to-be-signed part of the CRL (the CRL without the signature part).

ThisUpdate
char* (read-only)
Default Value: ""

The date and time at which this version of the CRL was published.

Constructors

CRL(const char* lpBytes, int lenBytes, int iStartIndex, int iCount)

Creates a CRL object from a memory buffer. Bytes is a buffer containing raw (DER) CRL data, StartIndex and Count specify the starting position and the length of the CRL data in the buffer, respectively.

CRL(const char* lpszLocation)

Creates a CRL object by downloading it from a remote location.

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 (CRL).

An OCSP response is a snapshot of the certificate status at a given time.

Fields

Bytes
char* (read-only)
Default Value:

Buffer containing 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.

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: ""

Location of the OCSP responder.

ProducedAt
char* (read-only)
Default Value: ""

Specifies the time when the response was produced, in UTC.

Source
int (read-only)
Default Value: 0

Returns the source of the entity contained in the object.

Constructors

OCSPResponse(const char* lpBytes, int lenBytes, int iStartIndex, int iCount)

Initializes the response from a memory buffer. Bytes is a buffer containing raw OCSP response data, StartIndex and Count specify the starting position and the number of bytes to be read from this buffer.

OCSPResponse(const char* lpszLocation)

Downloads an OCSP response from a remote location.

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.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.


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.

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 the 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 the 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 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 what 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

TBD

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`

SerialNumber
char* (read-only)
Default Value:

Returns the timestamp's serial number.

SignatureIndex
int (read-only)
Default Value: -1

Returns the index of the owner signature, if applicable.

Use this property to establish the index of the associated signature object in the signature collection.

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 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

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 on offer, 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 that allow to blanketly enable or disable all ciphersuites 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 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 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`	Check all provided CRL endpoints for all chain certificates.
crcAllOCSP	`3`	Check all provided OCSP endpoints for all chain certificates.
crcAllCRLAndOCSP	`4`	Check all CRL and OCSP endpoints for all chain certificates.
crcAnyCRL	`5`	At least one CRL check for every certificate in the chain must succeed.
crcAnyOCSP	`6`	At least one OCSP check for every certificate in the chain must succeed.
crcAnyCRLOrOCSP	`7`	At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first.

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 use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it.
cssloAutoAddServerNameExtension	`0x010`	Automatically add server name extension when known
cssloAcceptTrustedSRPPrimesOnly	`0x020`	Accept trusted SRP primes only
cssloDisableSignatureAlgorithmsExtension	`0x040`	Disable (not send) 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 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, allow plain data.

UseExtendedMasterSecret
int
Default Value: FALSE

Enables Extended Master Secret Extension, as defined in RFC 7627.

UseSessionResumption
int
Default Value: FALSE

Enables or disables 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 ASiCVerifier 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() {}
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 (ASiCVerifier 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.

ASiCVerifier Config Settings

DislikeOpenEndedOCSPs: Tells the component to discourage OCSP responses without an explicit NextUpdate parameter.

When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the component is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022).

ExtractToMemory: Tells the component to extract the current entry to memory.

Set this property to true to extract the entry being currently processed to memory and make it available in OutputBytes property. This property is reset before every subsequent entry is processed. Use FileExtractionStart event handler to re-enable it.

ForceCompleteChainValidation: Whether to check the CA certificates when the signing certificate is invalid.

Set this property to True to check issuer (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.

Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments.

GracePeriod: Specifies a grace period to apply during revocation information checks.

Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.

IgnoreChainLoops: Whether chain loops should be ignored.

Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves.

IgnoreChainValidationErrors: Enable this property to ignore any chain validation issues.

Set this property to True to make the component ignore any chain validation issues. This is not recommended unless you know what you are doing.

IgnoreOCSPNoCheckExtension: Whether OCSP NoCheck extension should be ignored.

Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues.

IgnoreSystemTrust: Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store.

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 TrustedCertificates property) are considered trusted.

ImplicitlyTrustSelfSignedCertificates: Whether to trust self-signed certificates.

Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows to emulate the verifying environment without actually changing its security settings.

PolicyExplicitText: The explicit text of the user notice.

This property specifies the explicit text of the user notice which is displayed when the signature is verified.

PolicyUNNumbers: The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES.

PolicyUNOrganization: The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES.

ProductionPlace: The production place XAdES attribute.

Check this property to access the ProductionPlace XAdES attribute.

PromoteLongOCSPResponses: Whether long OCSP responses are requested.

Set this property to True to force the class to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TLSChainValidationDetails: Contains the advanced details of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to access the TLS certificate validation details.

TLSChainValidationResult: Contains the result of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to obtain the TLS certificate validation result.

TLSClientAuthRequested: Indicates whether the TLS server requests client authentication.

Check this property in TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via TLSClientChain property. Note that the component may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted.

TLSValidationLog: Contains the log of the TLS server certificate validation.

Check this property in TLSCertValidate event handler to retrieve the validation log of the TLS server.

TolerateMinorChainIssues: Whether to tolerate minor chain issues.

This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

CA, revocation source, TLS key usage requirements are not mandated
Violation of OCSP issuer requirements are ignored
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

UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseSystemCertificates: Enables or disables the use of the system certificates.

Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

UseUTF8Filenames: Specifies whether to use UTF-8 filenames.

Set this property to False to use system encoding for filenames inside container.

UseValidationCache: Enables or disable the use of the product-wide certificate chain validation cache.

Use this property to enable or disable the use of the global chain validation cache. If enabled, the component will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the component, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from the fresh start.

Base Config Settings

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

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

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

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

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

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.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


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)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses: Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (ASiCVerifier Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ASiCVerifier Errors

1048577	Invalid parameter value (`SB_ERROR_INVALID_PARAMETER`)
1048578	Class is configured incorrectly (`SB_ERROR_INVALID_SETUP`)
1048579	Operation cannot be executed in the current state (`SB_ERROR_INVALID_STATE`)
1048580	Attempt to set an invalid value to a property (`SB_ERROR_INVALID_VALUE`)
1048581	Certificate does not have its private key loaded (`SB_ERROR_NO_PRIVATE_KEY`)
1048581	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
16777217	Unsupported level (`SB_ERROR_ASIC_UNSUPPORTED_LEVEL`)
16777218	Unsupported signature form (`SB_ERROR_ASIC_UNSUPPORTED_SIGNATURE_FORM`)
16777219	Unsupported signature type (`SB_ERROR_ASIC_UNSUPPORTED_SIGNATURE_TYPE`)
16777220	Unsupported extraction mode (`SB_ERROR_ASIC_UNSUPPORTED_EXTRACTION_MODE`)
16777221	Input file does not exist (`SB_ERROR_ASIC_INPUTFILE_NOT_EXISTS`)
16777222	Output file already exists (`SB_ERROR_ASIC_OUTPUTFILE_ALREADY_EXISTS`)