MailReader Class

Properties Methods Events Config Settings Errors

The MailReader class implements parsing and decryption of e-mail messages.

Syntax

MailReader

Remarks

MailReader parses and decrypts e-mail messages, as well as verifies electronic signatures.

Loading a e-mail message and accessing its properties: MailReader reader = new MailReader(); reader.LoadFromFile("path\\message.eml"); Console.WriteLine($"From: {reader.Message.From}"); Console.WriteLine($"To : {reader.Message.SendTo}"); Console.WriteLine($"Subject: {reader.Message.Subject}"); Console.WriteLine($"Attachments: {reader.Message.AttachmentCount}"); Console.WriteLine("Plain text:"); Console.WriteLine(reader.Message.PlainText);

Checking a signed message and validating its signature: MailReader reader = new MailReader(); reader.LoadFromFile("path\\message.eml"); if (reader.SecurityInfo.Signed) { if (reader.SecurityInfo.SignatureValidationResult == SignatureValidities.svtValid) Console.WriteLine($"Signed by {reader.SigningCertificate.Subject} and the signature is valid"); else Console.WriteLine("Signature is NOT valid"); }

Processing an encrypted e-mail message: MailReader reader = new MailReader(); reader.OnDecryptionInfoNeeded += (s, e) => { // here you should provide a certificate for decryption; // use the provided IssuerRDN and SerialNumber/SubjectKeyID // values to find an appropriate certificate, then // assign the certificate to DecryptionCertificate property; // the certificate should include its private key }; reader.LoadFromFile("path\\message.eml");

Property List

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


Attachments	Provides access to Message's attachments.
Bcc	The contents of the BCC header field of the Message.
BlockedCertificates	The certificates that must be rejected as trust anchors.
Cc	The value of the CC header field of the Message.
DecryptionCertificate	The certificate to be used for decryption.
ExternalCrypto	Provides access to external signing and DC parameters.
FIPSMode	Reserved.
From	Contains the value of the From header of the Message.
IgnoreChainValidationErrors	Makes the class tolerant to chain validation errors.
KnownCertificates	Additional certificates for chain validation.
KnownCRLs	Additional CRLs for chain validation.
KnownOCSPs	Additional OCSP responses for chain validation.
Message	The message that is currently stored in the class.
OfflineMode	Switches the class to offline mode.
OtherHeaders	Contains secondary headers of the mail message.
Profile	Specifies a pre-defined profile to apply when creating the signature.
Proxy	The proxy server settings.
ReplyTo	The value of the Reply-To header field of the Message.
RevocationCheck	Specifies the kind(s) of revocation check to perform for all chain certificates.
SecurityInfo	Contains the Message's security info.
Sender	The value of the Sender header field of the Message.
SendTo	The value of the To header field of the Message.
SigningCertificate	The certificate of the signature creator.
SocketSettings	Manages network connection settings.
TLSSettings	Manages TLS layer settings.
TrustedCertificates	A list of trusted certificates for chain validation.
UsedCertificates	Contains a list of certificates used during the chain validation routine.
ValidationMoment	The time point at which signature validity is to be established.

Method List

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


Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
FindAttachment	Looks up a Message's attachment by its ID.
LoadFromBytes	Loads an e-mail message from a byte array.
LoadFromFile	Loads an e-mail message from a file.
LoadFromStream	Loads an e-mail message from a stream.
Reset	Resets the class settings.

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.


ChainValidated	Reports the completion of a certificate chain validation.
DecryptionInfoNeeded	Asks the application to provide a decryption certificate.
Error	Reports information about errors during e-mail message loading, parsing or saving.
ExternalDecrypt	Handles remote or external decryption.
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.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


ChainCurrentCACert	Returns the current CA certificate.
ChainCurrentCert	Returns the certificate that is currently being validated.
ChainCurrentCRL	Returns the current CRL.
ChainCurrentCRLSize	Returns the size of the current CRL.
ChainCurrentOCSP	Returns the current OCSP response.
ChainCurrentOCSPSigner	Returns the signer of the current OCSP object.
ChainInterimDetails	Returns the current interim validation details.
ChainInterimResult	Returns the current interim validation result.
CheckValidityPeriodForTrusted	Whether to check validity period for trusted certificates.
DislikeOpenEndedOCSPs	Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.
ForceCompleteChainValidation	Whether to check the CA certificates when the signing certificate is invalid.
ForceCompleteChainValidationForTrusted	Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.
GracePeriod	Specifies a grace period to apply during revocation information checks.
HeaderCharset	Charset of the header. If not empty, the one specified in the message header will be ignored.
IgnoreChainLoops	Whether chain loops should be ignored.
IgnoreOCSPNoCheckExtension	Whether the OCSP NoCheck extension should be ignored.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
ImplicitlyTrustSelfSignedCertificates	Whether to trust self-signed certificates.
MaxHeaderSize	Specifies the maximum mail message header size in bytes.
PromoteLongOCSPResponses	Whether long OCSP responses are requested.
TempPath	Path for storing temporary files.
TextCharset	Charset of text parts, if any. If not empty, the one specified in the message text parts will be ignored.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
UseMicrosoftCTL	Enables or disables the automatic use of the Microsoft online certificate trust list.
UseSystemCertificates	Enables or disables the use of the system certificates.
UseValidationCache	Enables or disable the use of the product-wide certificate chain validation cache.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

Attachments Property (MailReader Class)

Provides access to Message's attachments.

Syntax

SecureBlackboxList<SecureBlackboxMailAttachment>* GetAttachments();

int secureblackbox_mailreader_getattachcount(void* lpObj);

char* secureblackbox_mailreader_getattachcontentsubtype(void* lpObj, int attachindex);

char* secureblackbox_mailreader_getattachcontenttype(void* lpObj, int attachindex);

char* secureblackbox_mailreader_getattachcreationdate(void* lpObj, int attachindex);

int secureblackbox_mailreader_getattachdata(void* lpObj, int attachindex, char** lpAttachData, int* lenAttachData);

char* secureblackbox_mailreader_getattachdescription(void* lpObj, int attachindex);

char* secureblackbox_mailreader_getattachfilename(void* lpObj, int attachindex);

int64 secureblackbox_mailreader_getattachhandle(void* lpObj, int attachindex);

char* secureblackbox_mailreader_getattachid(void* lpObj, int attachindex);

char* secureblackbox_mailreader_getattachmodificationdate(void* lpObj, int attachindex);

char* secureblackbox_mailreader_getattachreaddate(void* lpObj, int attachindex);

int64 secureblackbox_mailreader_getattachsize(void* lpObj, int attachindex);

int GetAttachCount();

QString GetAttachContentSubtype(int iAttachIndex);

QString GetAttachContentType(int iAttachIndex);

QString GetAttachCreationDate(int iAttachIndex);

QByteArray GetAttachData(int iAttachIndex);

QString GetAttachDescription(int iAttachIndex);

QString GetAttachFileName(int iAttachIndex);

qint64 GetAttachHandle(int iAttachIndex);

QString GetAttachID(int iAttachIndex);

QString GetAttachModificationDate(int iAttachIndex);

QString GetAttachReadDate(int iAttachIndex);

qint64 GetAttachSize(int iAttachIndex);

Remarks

Use this property to access the attachments of the loaded message.

This property is read-only.

Data Type

SecureBlackboxMailAttachment

Bcc Property (MailReader Class)

The contents of the BCC header field of the Message.

Syntax

SecureBlackboxList<SecureBlackboxMailAddress>* GetBcc();

int secureblackbox_mailreader_getbccaddrcount(void* lpObj);

char* secureblackbox_mailreader_getbccaddraddress(void* lpObj, int bccaddrindex);

char* secureblackbox_mailreader_getbccaddrdisplayname(void* lpObj, int bccaddrindex);

char* secureblackbox_mailreader_getbccaddrgroupname(void* lpObj, int bccaddrindex);

int GetBccAddrCount();

QString GetBccAddrAddress(int iBccAddrIndex);

QString GetBccAddrDisplayName(int iBccAddrIndex);

QString GetBccAddrGroupName(int iBccAddrIndex);

Remarks

The BCC header field contains the addresses of secondary recipients of the message whose addresses are not to be revealed to other recipients of the message.

Mail servers remove the BCC header when processing the message and use its value for dispatching the message only.

This property is read-only.

Data Type

SecureBlackboxMailAddress

BlockedCertificates Property (MailReader Class)

The certificates that must be rejected as trust anchors.

Syntax

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

int secureblackbox_mailreader_getblockedcertcount(void* lpObj);
int secureblackbox_mailreader_setblockedcertcount(void* lpObj, int iBlockedCertCount);

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

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

Cc Property (MailReader Class)

The value of the CC header field of the Message.

Syntax

SecureBlackboxList<SecureBlackboxMailAddress>* GetCc();

int secureblackbox_mailreader_getccaddrcount(void* lpObj);

char* secureblackbox_mailreader_getccaddraddress(void* lpObj, int ccaddrindex);

char* secureblackbox_mailreader_getccaddrdisplayname(void* lpObj, int ccaddrindex);

char* secureblackbox_mailreader_getccaddrgroupname(void* lpObj, int ccaddrindex);

int GetCcAddrCount();

QString GetCcAddrAddress(int iCcAddrIndex);

QString GetCcAddrDisplayName(int iCcAddrIndex);

QString GetCcAddrGroupName(int iCcAddrIndex);

Remarks

The CC field contains the addresses of secondary recipients of the message.

This property is read-only.

Data Type

SecureBlackboxMailAddress

DecryptionCertificate Property (MailReader Class)

The certificate to be used for decryption.

Syntax

SecureBlackboxCertificate* GetDecryptionCertificate();
int SetDecryptionCertificate(SecureBlackboxCertificate* val);

int secureblackbox_mailreader_getdecryptioncertbytes(void* lpObj, char** lpDecryptionCertBytes, int* lenDecryptionCertBytes);

int secureblackbox_mailreader_getdecryptioncertca(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertca(void* lpObj, int bDecryptionCertCA);

int secureblackbox_mailreader_getdecryptioncertcakeyid(void* lpObj, char** lpDecryptionCertCAKeyID, int* lenDecryptionCertCAKeyID);

int secureblackbox_mailreader_getdecryptioncertcerttype(void* lpObj);

char* secureblackbox_mailreader_getdecryptioncertcrldistributionpoints(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertcrldistributionpoints(void* lpObj, const char* lpszDecryptionCertCRLDistributionPoints);

char* secureblackbox_mailreader_getdecryptioncertcurve(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertcurve(void* lpObj, const char* lpszDecryptionCertCurve);

char* secureblackbox_mailreader_getdecryptioncertfingerprint(void* lpObj);

char* secureblackbox_mailreader_getdecryptioncertfriendlyname(void* lpObj);

int64 secureblackbox_mailreader_getdecryptioncerthandle(void* lpObj);
int secureblackbox_mailreader_setdecryptioncerthandle(void* lpObj, int64 lDecryptionCertHandle);

char* secureblackbox_mailreader_getdecryptioncerthashalgorithm(void* lpObj);
int secureblackbox_mailreader_setdecryptioncerthashalgorithm(void* lpObj, const char* lpszDecryptionCertHashAlgorithm);

char* secureblackbox_mailreader_getdecryptioncertissuer(void* lpObj);

char* secureblackbox_mailreader_getdecryptioncertissuerrdn(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertissuerrdn(void* lpObj, const char* lpszDecryptionCertIssuerRDN);

char* secureblackbox_mailreader_getdecryptioncertkeyalgorithm(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertkeyalgorithm(void* lpObj, const char* lpszDecryptionCertKeyAlgorithm);

int secureblackbox_mailreader_getdecryptioncertkeybits(void* lpObj);

char* secureblackbox_mailreader_getdecryptioncertkeyfingerprint(void* lpObj);

int secureblackbox_mailreader_getdecryptioncertkeyusage(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertkeyusage(void* lpObj, int iDecryptionCertKeyUsage);

int secureblackbox_mailreader_getdecryptioncertkeyvalid(void* lpObj);

char* secureblackbox_mailreader_getdecryptioncertocsplocations(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertocsplocations(void* lpObj, const char* lpszDecryptionCertOCSPLocations);

int secureblackbox_mailreader_getdecryptioncertocspnocheck(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertocspnocheck(void* lpObj, int bDecryptionCertOCSPNoCheck);

int secureblackbox_mailreader_getdecryptioncertorigin(void* lpObj);

char* secureblackbox_mailreader_getdecryptioncertpolicyids(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertpolicyids(void* lpObj, const char* lpszDecryptionCertPolicyIDs);

int secureblackbox_mailreader_getdecryptioncertprivatekeybytes(void* lpObj, char** lpDecryptionCertPrivateKeyBytes, int* lenDecryptionCertPrivateKeyBytes);

int secureblackbox_mailreader_getdecryptioncertprivatekeyexists(void* lpObj);

int secureblackbox_mailreader_getdecryptioncertprivatekeyextractable(void* lpObj);

int secureblackbox_mailreader_getdecryptioncertpublickeybytes(void* lpObj, char** lpDecryptionCertPublicKeyBytes, int* lenDecryptionCertPublicKeyBytes);

int secureblackbox_mailreader_getdecryptioncertqualified(void* lpObj);

int secureblackbox_mailreader_getdecryptioncertqualifiedstatements(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertqualifiedstatements(void* lpObj, int iDecryptionCertQualifiedStatements);

char* secureblackbox_mailreader_getdecryptioncertqualifiers(void* lpObj);

int secureblackbox_mailreader_getdecryptioncertselfsigned(void* lpObj);

int secureblackbox_mailreader_getdecryptioncertserialnumber(void* lpObj, char** lpDecryptionCertSerialNumber, int* lenDecryptionCertSerialNumber);
int secureblackbox_mailreader_setdecryptioncertserialnumber(void* lpObj, const char* lpDecryptionCertSerialNumber, int lenDecryptionCertSerialNumber);

char* secureblackbox_mailreader_getdecryptioncertsigalgorithm(void* lpObj);

int secureblackbox_mailreader_getdecryptioncertsource(void* lpObj);

char* secureblackbox_mailreader_getdecryptioncertsubject(void* lpObj);

char* secureblackbox_mailreader_getdecryptioncertsubjectalternativename(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertsubjectalternativename(void* lpObj, const char* lpszDecryptionCertSubjectAlternativeName);

int secureblackbox_mailreader_getdecryptioncertsubjectkeyid(void* lpObj, char** lpDecryptionCertSubjectKeyID, int* lenDecryptionCertSubjectKeyID);
int secureblackbox_mailreader_setdecryptioncertsubjectkeyid(void* lpObj, const char* lpDecryptionCertSubjectKeyID, int lenDecryptionCertSubjectKeyID);

char* secureblackbox_mailreader_getdecryptioncertsubjectrdn(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertsubjectrdn(void* lpObj, const char* lpszDecryptionCertSubjectRDN);

int secureblackbox_mailreader_getdecryptioncertvalid(void* lpObj);

char* secureblackbox_mailreader_getdecryptioncertvalidfrom(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertvalidfrom(void* lpObj, const char* lpszDecryptionCertValidFrom);

char* secureblackbox_mailreader_getdecryptioncertvalidto(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertvalidto(void* lpObj, const char* lpszDecryptionCertValidTo);

QByteArray GetDecryptionCertBytes();

bool GetDecryptionCertCA();
int SetDecryptionCertCA(bool bDecryptionCertCA);

QByteArray GetDecryptionCertCAKeyID();

int GetDecryptionCertCertType();

QString GetDecryptionCertCRLDistributionPoints();
int SetDecryptionCertCRLDistributionPoints(QString qsDecryptionCertCRLDistributionPoints);

QString GetDecryptionCertCurve();
int SetDecryptionCertCurve(QString qsDecryptionCertCurve);

QString GetDecryptionCertFingerprint();

QString GetDecryptionCertFriendlyName();

qint64 GetDecryptionCertHandle();
int SetDecryptionCertHandle(qint64 lDecryptionCertHandle);

QString GetDecryptionCertHashAlgorithm();
int SetDecryptionCertHashAlgorithm(QString qsDecryptionCertHashAlgorithm);

QString GetDecryptionCertIssuer();

QString GetDecryptionCertIssuerRDN();
int SetDecryptionCertIssuerRDN(QString qsDecryptionCertIssuerRDN);

QString GetDecryptionCertKeyAlgorithm();
int SetDecryptionCertKeyAlgorithm(QString qsDecryptionCertKeyAlgorithm);

int GetDecryptionCertKeyBits();

QString GetDecryptionCertKeyFingerprint();

int GetDecryptionCertKeyUsage();
int SetDecryptionCertKeyUsage(int iDecryptionCertKeyUsage);

bool GetDecryptionCertKeyValid();

QString GetDecryptionCertOCSPLocations();
int SetDecryptionCertOCSPLocations(QString qsDecryptionCertOCSPLocations);

bool GetDecryptionCertOCSPNoCheck();
int SetDecryptionCertOCSPNoCheck(bool bDecryptionCertOCSPNoCheck);

int GetDecryptionCertOrigin();

QString GetDecryptionCertPolicyIDs();
int SetDecryptionCertPolicyIDs(QString qsDecryptionCertPolicyIDs);

QByteArray GetDecryptionCertPrivateKeyBytes();

bool GetDecryptionCertPrivateKeyExists();

bool GetDecryptionCertPrivateKeyExtractable();

QByteArray GetDecryptionCertPublicKeyBytes();

bool GetDecryptionCertQualified();

int GetDecryptionCertQualifiedStatements();
int SetDecryptionCertQualifiedStatements(int iDecryptionCertQualifiedStatements);

QString GetDecryptionCertQualifiers();

bool GetDecryptionCertSelfSigned();

QByteArray GetDecryptionCertSerialNumber();
int SetDecryptionCertSerialNumber(QByteArray qbaDecryptionCertSerialNumber);

QString GetDecryptionCertSigAlgorithm();

int GetDecryptionCertSource();

QString GetDecryptionCertSubject();

QString GetDecryptionCertSubjectAlternativeName();
int SetDecryptionCertSubjectAlternativeName(QString qsDecryptionCertSubjectAlternativeName);

QByteArray GetDecryptionCertSubjectKeyID();
int SetDecryptionCertSubjectKeyID(QByteArray qbaDecryptionCertSubjectKeyID);

QString GetDecryptionCertSubjectRDN();
int SetDecryptionCertSubjectRDN(QString qsDecryptionCertSubjectRDN);

bool GetDecryptionCertValid();

QString GetDecryptionCertValidFrom();
int SetDecryptionCertValidFrom(QString qsDecryptionCertValidFrom);

QString GetDecryptionCertValidTo();
int SetDecryptionCertValidTo(QString qsDecryptionCertValidTo);

Remarks

Use this property to provide the decryption certificate. The decryption certificate must have a private key associated with it.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

ExternalCrypto Property (MailReader Class)

Provides access to external signing and DC parameters.

Syntax

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_mailreader_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_mailreader_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_mailreader_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_mailreader_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

char* secureblackbox_mailreader_getexternalcryptodata(void* lpObj);
int secureblackbox_mailreader_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

int secureblackbox_mailreader_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_mailreader_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

char* secureblackbox_mailreader_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_mailreader_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

char* secureblackbox_mailreader_getexternalcryptokeyid(void* lpObj);
int secureblackbox_mailreader_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

char* secureblackbox_mailreader_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_mailreader_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

int secureblackbox_mailreader_getexternalcryptomethod(void* lpObj);
int secureblackbox_mailreader_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int secureblackbox_mailreader_getexternalcryptomode(void* lpObj);
int secureblackbox_mailreader_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

char* secureblackbox_mailreader_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_mailreader_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FIPSMode Property (MailReader Class)

Reserved.

Syntax

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

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

int secureblackbox_mailreader_getfipsmode(void* lpObj);
int secureblackbox_mailreader_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

From Property (MailReader Class)

Contains the value of the From header of the Message.

Syntax

SecureBlackboxList<SecureBlackboxMailAddress>* GetFrom();

int secureblackbox_mailreader_getfromaddrcount(void* lpObj);

char* secureblackbox_mailreader_getfromaddraddress(void* lpObj, int fromaddrindex);

char* secureblackbox_mailreader_getfromaddrdisplayname(void* lpObj, int fromaddrindex);

char* secureblackbox_mailreader_getfromaddrgroupname(void* lpObj, int fromaddrindex);

int GetFromAddrCount();

QString GetFromAddrAddress(int iFromAddrIndex);

QString GetFromAddrDisplayName(int iFromAddrIndex);

QString GetFromAddrGroupName(int iFromAddrIndex);

Remarks

This field contains address(es) of message author(s). If the actual sender is not the author of the message, the sender is provided separately via Sender property.

This property is read-only.

Data Type

SecureBlackboxMailAddress

IgnoreChainValidationErrors Property (MailReader 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_mailreader_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_mailreader_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

KnownCertificates Property (MailReader Class)

Additional certificates for chain validation.

Syntax

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

int secureblackbox_mailreader_getknowncertcount(void* lpObj);
int secureblackbox_mailreader_setknowncertcount(void* lpObj, int iKnownCertCount);

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

int64 secureblackbox_mailreader_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_mailreader_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

KnownCRLs Property (MailReader Class)

Additional CRLs for chain validation.

Syntax

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

int secureblackbox_mailreader_getknowncrlcount(void* lpObj);
int secureblackbox_mailreader_setknowncrlcount(void* lpObj, int iKnownCRLCount);

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

int64 secureblackbox_mailreader_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_mailreader_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 (MailReader Class)

Additional OCSP responses for chain validation.

Syntax

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

int secureblackbox_mailreader_getknownocspcount(void* lpObj);
int secureblackbox_mailreader_setknownocspcount(void* lpObj, int iKnownOCSPCount);

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

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

Message Property (MailReader Class)

The message that is currently stored in the class.

Syntax

SecureBlackboxMailMessage* GetMessage();
int SetMessage(SecureBlackboxMailMessage* val);

int secureblackbox_mailreader_getmsgattachmentcount(void* lpObj);

char* secureblackbox_mailreader_getmsgbcc(void* lpObj);
int secureblackbox_mailreader_setmsgbcc(void* lpObj, const char* lpszMsgBcc);

char* secureblackbox_mailreader_getmsgcc(void* lpObj);
int secureblackbox_mailreader_setmsgcc(void* lpObj, const char* lpszMsgCc);

char* secureblackbox_mailreader_getmsgcomments(void* lpObj);
int secureblackbox_mailreader_setmsgcomments(void* lpObj, const char* lpszMsgComments);

char* secureblackbox_mailreader_getmsgdate(void* lpObj);
int secureblackbox_mailreader_setmsgdate(void* lpObj, const char* lpszMsgDate);

int secureblackbox_mailreader_getmsgdeliveryreceipt(void* lpObj);
int secureblackbox_mailreader_setmsgdeliveryreceipt(void* lpObj, int bMsgDeliveryReceipt);

char* secureblackbox_mailreader_getmsgfrom(void* lpObj);
int secureblackbox_mailreader_setmsgfrom(void* lpObj, const char* lpszMsgFrom);

int64 secureblackbox_mailreader_getmsghandle(void* lpObj);
int secureblackbox_mailreader_setmsghandle(void* lpObj, int64 lMsgHandle);

char* secureblackbox_mailreader_getmsghtmltext(void* lpObj);
int secureblackbox_mailreader_setmsghtmltext(void* lpObj, const char* lpszMsgHtmlText);

char* secureblackbox_mailreader_getmsgid(void* lpObj);
int secureblackbox_mailreader_setmsgid(void* lpObj, const char* lpszMsgID);

char* secureblackbox_mailreader_getmsginreplyto(void* lpObj);
int secureblackbox_mailreader_setmsginreplyto(void* lpObj, const char* lpszMsgInReplyTo);

char* secureblackbox_mailreader_getmsgkeywords(void* lpObj);
int secureblackbox_mailreader_setmsgkeywords(void* lpObj, const char* lpszMsgKeywords);

char* secureblackbox_mailreader_getmsgmailer(void* lpObj);

char* secureblackbox_mailreader_getmsgplaintext(void* lpObj);
int secureblackbox_mailreader_setmsgplaintext(void* lpObj, const char* lpszMsgPlainText);

int secureblackbox_mailreader_getmsgpriority(void* lpObj);
int secureblackbox_mailreader_setmsgpriority(void* lpObj, int iMsgPriority);

int secureblackbox_mailreader_getmsgreadreceipt(void* lpObj);
int secureblackbox_mailreader_setmsgreadreceipt(void* lpObj, int bMsgReadReceipt);

char* secureblackbox_mailreader_getmsgreferences(void* lpObj);
int secureblackbox_mailreader_setmsgreferences(void* lpObj, const char* lpszMsgReferences);

char* secureblackbox_mailreader_getmsgreplyto(void* lpObj);
int secureblackbox_mailreader_setmsgreplyto(void* lpObj, const char* lpszMsgReplyTo);

char* secureblackbox_mailreader_getmsgreturnpath(void* lpObj);
int secureblackbox_mailreader_setmsgreturnpath(void* lpObj, const char* lpszMsgReturnPath);

char* secureblackbox_mailreader_getmsgsender(void* lpObj);
int secureblackbox_mailreader_setmsgsender(void* lpObj, const char* lpszMsgSender);

char* secureblackbox_mailreader_getmsgsendto(void* lpObj);
int secureblackbox_mailreader_setmsgsendto(void* lpObj, const char* lpszMsgSendTo);

char* secureblackbox_mailreader_getmsgsubject(void* lpObj);
int secureblackbox_mailreader_setmsgsubject(void* lpObj, const char* lpszMsgSubject);

int GetMsgAttachmentCount();

QString GetMsgBcc();
int SetMsgBcc(QString qsMsgBcc);

QString GetMsgCc();
int SetMsgCc(QString qsMsgCc);

QString GetMsgComments();
int SetMsgComments(QString qsMsgComments);

QString GetMsgDate();
int SetMsgDate(QString qsMsgDate);

bool GetMsgDeliveryReceipt();
int SetMsgDeliveryReceipt(bool bMsgDeliveryReceipt);

QString GetMsgFrom();
int SetMsgFrom(QString qsMsgFrom);

qint64 GetMsgHandle();
int SetMsgHandle(qint64 lMsgHandle);

QString GetMsgHtmlText();
int SetMsgHtmlText(QString qsMsgHtmlText);

QString GetMsgID();
int SetMsgID(QString qsMsgID);

QString GetMsgInReplyTo();
int SetMsgInReplyTo(QString qsMsgInReplyTo);

QString GetMsgKeywords();
int SetMsgKeywords(QString qsMsgKeywords);

QString GetMsgMailer();

QString GetMsgPlainText();
int SetMsgPlainText(QString qsMsgPlainText);

int GetMsgPriority();
int SetMsgPriority(int iMsgPriority);

bool GetMsgReadReceipt();
int SetMsgReadReceipt(bool bMsgReadReceipt);

QString GetMsgReferences();
int SetMsgReferences(QString qsMsgReferences);

QString GetMsgReplyTo();
int SetMsgReplyTo(QString qsMsgReplyTo);

QString GetMsgReturnPath();
int SetMsgReturnPath(QString qsMsgReturnPath);

QString GetMsgSender();
int SetMsgSender(QString qsMsgSender);

QString GetMsgSendTo();
int SetMsgSendTo(QString qsMsgSendTo);

QString GetMsgSubject();
int SetMsgSubject(QString qsMsgSubject);

Remarks

Use this property to access the message that has been processed and populated by class.

This property is not available at design time.

Data Type

SecureBlackboxMailMessage

OfflineMode Property (MailReader Class)

Switches the class to offline mode.

Syntax

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

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

int secureblackbox_mailreader_getofflinemode(void* lpObj);
int secureblackbox_mailreader_setofflinemode(void* lpObj, int bOfflineMode);

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

Default Value

FALSE

Remarks

When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

Data Type

Boolean

OtherHeaders Property (MailReader Class)

Contains secondary headers of the mail message.

Syntax

SecureBlackboxList<SecureBlackboxStringNameValuePair>* GetOtherHeaders();

int secureblackbox_mailreader_getheaderfieldcount(void* lpObj);

char* secureblackbox_mailreader_getheaderfieldcategory(void* lpObj, int headerfieldindex);

int secureblackbox_mailreader_getheaderfieldformat(void* lpObj, int headerfieldindex);

char* secureblackbox_mailreader_getheaderfieldname(void* lpObj, int headerfieldindex);

char* secureblackbox_mailreader_getheaderfieldvalue(void* lpObj, int headerfieldindex);

int GetHeaderFieldCount();

QString GetHeaderFieldCategory(int iHeaderFieldIndex);

int GetHeaderFieldFormat(int iHeaderFieldIndex);

QString GetHeaderFieldName(int iHeaderFieldIndex);

QString GetHeaderFieldValue(int iHeaderFieldIndex);

Remarks

Use this property to access the headers that have not been published in first-level object's properties.

This property is read-only.

Data Type

SecureBlackboxStringNameValuePair

Profile Property (MailReader 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_mailreader_getprofile(void* lpObj);
int secureblackbox_mailreader_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 (MailReader Class)

The proxy server settings.

Syntax

SecureBlackboxProxySettings* GetProxy();

char* secureblackbox_mailreader_getproxyaddress(void* lpObj);
int secureblackbox_mailreader_setproxyaddress(void* lpObj, const char* lpszProxyAddress);

int secureblackbox_mailreader_getproxyauthentication(void* lpObj);
int secureblackbox_mailreader_setproxyauthentication(void* lpObj, int iProxyAuthentication);

char* secureblackbox_mailreader_getproxypassword(void* lpObj);
int secureblackbox_mailreader_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int secureblackbox_mailreader_getproxyport(void* lpObj);
int secureblackbox_mailreader_setproxyport(void* lpObj, int iProxyPort);

int secureblackbox_mailreader_getproxyproxytype(void* lpObj);
int secureblackbox_mailreader_setproxyproxytype(void* lpObj, int iProxyProxyType);

char* secureblackbox_mailreader_getproxyrequestheaders(void* lpObj);
int secureblackbox_mailreader_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);

char* secureblackbox_mailreader_getproxyresponsebody(void* lpObj);
int secureblackbox_mailreader_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);

char* secureblackbox_mailreader_getproxyresponseheaders(void* lpObj);
int secureblackbox_mailreader_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);

int secureblackbox_mailreader_getproxyuseipv6(void* lpObj);
int secureblackbox_mailreader_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);

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

ReplyTo Property (MailReader Class)

The value of the Reply-To header field of the Message.

Syntax

SecureBlackboxList<SecureBlackboxMailAddress>* GetReplyTo();

int secureblackbox_mailreader_getreplytoaddrcount(void* lpObj);

char* secureblackbox_mailreader_getreplytoaddraddress(void* lpObj, int replytoaddrindex);

char* secureblackbox_mailreader_getreplytoaddrdisplayname(void* lpObj, int replytoaddrindex);

char* secureblackbox_mailreader_getreplytoaddrgroupname(void* lpObj, int replytoaddrindex);

int GetReplyToAddrCount();

QString GetReplyToAddrAddress(int iReplyToAddrIndex);

QString GetReplyToAddrDisplayName(int iReplyToAddrIndex);

QString GetReplyToAddrGroupName(int iReplyToAddrIndex);

Remarks

This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies should be sent to the addresses specified in the From field.

This property is read-only.

Data Type

SecureBlackboxMailAddress

RevocationCheck Property (MailReader Class)

Specifies the kind(s) of revocation check to perform for all chain certificates.

Syntax

ANSI (Cross Platform)
int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);

Unicode (Windows)
INT GetRevocationCheck();
INT SetRevocationCheck(INT iRevocationCheck);

Possible Values

CRC_NONE(0), 
CRC_AUTO(1), 
CRC_ALL_CRL(2), 
CRC_ALL_OCSP(3), 
CRC_ALL_CRLAND_OCSP(4), 
CRC_ANY_CRL(5), 
CRC_ANY_OCSP(6), 
CRC_ANY_CRLOR_OCSP(7), 
CRC_ANY_OCSPOR_CRL(8)

int secureblackbox_mailreader_getrevocationcheck(void* lpObj);
int secureblackbox_mailreader_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 (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.


crcNone	`0`	No revocation checking.
crcAuto	`1`	Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL	`2`	All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP	`3`	All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP	`4`	All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL	`5`	All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP	`6`	All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP	`7`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Data Type

Integer

SecurityInfo Property (MailReader Class)

Contains the Message's security info.

Syntax

SecureBlackboxMailSecurityInfo* GetSecurityInfo();

int secureblackbox_mailreader_getsecinfochainvalidationdetails(void* lpObj);

int secureblackbox_mailreader_getsecinfochainvalidationresult(void* lpObj);

char* secureblackbox_mailreader_getsecinfoclaimedsigningtime(void* lpObj);

int secureblackbox_mailreader_getsecinfoencrypted(void* lpObj);

char* secureblackbox_mailreader_getsecinfoencryptionalgorithm(void* lpObj);

char* secureblackbox_mailreader_getsecinfohashalgorithm(void* lpObj);

int secureblackbox_mailreader_getsecinfosignaturevalidationresult(void* lpObj);

int secureblackbox_mailreader_getsecinfosigned(void* lpObj);

char* secureblackbox_mailreader_getsecinfovalidationlog(void* lpObj);

int GetSecInfoChainValidationDetails();

int GetSecInfoChainValidationResult();

QString GetSecInfoClaimedSigningTime();

bool GetSecInfoEncrypted();

QString GetSecInfoEncryptionAlgorithm();

QString GetSecInfoHashAlgorithm();

int GetSecInfoSignatureValidationResult();

bool GetSecInfoSigned();

QString GetSecInfoValidationLog();

Remarks

Use this property to check the security information about the Message, such as whether the message is signed or the encryption algorithm used.

This property is read-only.

Data Type

SecureBlackboxMailSecurityInfo

Sender Property (MailReader Class)

The value of the Sender header field of the Message.

Syntax

SecureBlackboxMailAddress* GetSender();

char* secureblackbox_mailreader_getsenderaddraddress(void* lpObj);

char* secureblackbox_mailreader_getsenderaddrdisplayname(void* lpObj);

char* secureblackbox_mailreader_getsenderaddrgroupname(void* lpObj);

QString GetSenderAddrAddress();

QString GetSenderAddrDisplayName();

QString GetSenderAddrGroupName();

Remarks

This field specifies the mailbox of the agent responsible for the actual transmission of this message.

If the originator of the message can be indicated by a single mailbox and both the author and the transmitter are the same entity, the "Sender:" field is not used ("From:" used instead).

This property is read-only.

Data Type

SecureBlackboxMailAddress

SendTo Property (MailReader Class)

The value of the To header field of the Message.

Syntax

SecureBlackboxList<SecureBlackboxMailAddress>* GetSendTo();

int secureblackbox_mailreader_getsendtoaddrcount(void* lpObj);

char* secureblackbox_mailreader_getsendtoaddraddress(void* lpObj, int sendtoaddrindex);

char* secureblackbox_mailreader_getsendtoaddrdisplayname(void* lpObj, int sendtoaddrindex);

char* secureblackbox_mailreader_getsendtoaddrgroupname(void* lpObj, int sendtoaddrindex);

int GetSendToAddrCount();

QString GetSendToAddrAddress(int iSendToAddrIndex);

QString GetSendToAddrDisplayName(int iSendToAddrIndex);

QString GetSendToAddrGroupName(int iSendToAddrIndex);

Remarks

This field specifies the address(es) of the primary recipient(s) of the message.

This property is read-only.

Data Type

SecureBlackboxMailAddress

SigningCertificate Property (MailReader Class)

The certificate of the signature creator.

Syntax

SecureBlackboxCertificate* GetSigningCertificate();

int secureblackbox_mailreader_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);

int secureblackbox_mailreader_getsigningcertca(void* lpObj);

int secureblackbox_mailreader_getsigningcertcakeyid(void* lpObj, char** lpSigningCertCAKeyID, int* lenSigningCertCAKeyID);

char* secureblackbox_mailreader_getsigningcertcrldistributionpoints(void* lpObj);

char* secureblackbox_mailreader_getsigningcertcurve(void* lpObj);

char* secureblackbox_mailreader_getsigningcertfingerprint(void* lpObj);

char* secureblackbox_mailreader_getsigningcertfriendlyname(void* lpObj);

int64 secureblackbox_mailreader_getsigningcerthandle(void* lpObj);

char* secureblackbox_mailreader_getsigningcerthashalgorithm(void* lpObj);

char* secureblackbox_mailreader_getsigningcertissuer(void* lpObj);

char* secureblackbox_mailreader_getsigningcertissuerrdn(void* lpObj);

char* secureblackbox_mailreader_getsigningcertkeyalgorithm(void* lpObj);

int secureblackbox_mailreader_getsigningcertkeybits(void* lpObj);

char* secureblackbox_mailreader_getsigningcertkeyfingerprint(void* lpObj);

int secureblackbox_mailreader_getsigningcertkeyusage(void* lpObj);

int secureblackbox_mailreader_getsigningcertkeyvalid(void* lpObj);

char* secureblackbox_mailreader_getsigningcertocsplocations(void* lpObj);

char* secureblackbox_mailreader_getsigningcertpolicyids(void* lpObj);

int secureblackbox_mailreader_getsigningcertpublickeybytes(void* lpObj, char** lpSigningCertPublicKeyBytes, int* lenSigningCertPublicKeyBytes);

int secureblackbox_mailreader_getsigningcertselfsigned(void* lpObj);

int secureblackbox_mailreader_getsigningcertserialnumber(void* lpObj, char** lpSigningCertSerialNumber, int* lenSigningCertSerialNumber);

char* secureblackbox_mailreader_getsigningcertsigalgorithm(void* lpObj);

char* secureblackbox_mailreader_getsigningcertsubject(void* lpObj);

int secureblackbox_mailreader_getsigningcertsubjectkeyid(void* lpObj, char** lpSigningCertSubjectKeyID, int* lenSigningCertSubjectKeyID);

char* secureblackbox_mailreader_getsigningcertsubjectrdn(void* lpObj);

char* secureblackbox_mailreader_getsigningcertvalidfrom(void* lpObj);

char* secureblackbox_mailreader_getsigningcertvalidto(void* lpObj);

QByteArray GetSigningCertBytes();

bool GetSigningCertCA();

QByteArray GetSigningCertCAKeyID();

QString GetSigningCertCRLDistributionPoints();

QString GetSigningCertCurve();

QString GetSigningCertFingerprint();

QString GetSigningCertFriendlyName();

qint64 GetSigningCertHandle();

QString GetSigningCertHashAlgorithm();

QString GetSigningCertIssuer();

QString GetSigningCertIssuerRDN();

QString GetSigningCertKeyAlgorithm();

int GetSigningCertKeyBits();

QString GetSigningCertKeyFingerprint();

int GetSigningCertKeyUsage();

bool GetSigningCertKeyValid();

QString GetSigningCertOCSPLocations();

QString GetSigningCertPolicyIDs();

QByteArray GetSigningCertPublicKeyBytes();

bool GetSigningCertSelfSigned();

QByteArray GetSigningCertSerialNumber();

QString GetSigningCertSigAlgorithm();

QString GetSigningCertSubject();

QByteArray GetSigningCertSubjectKeyID();

QString GetSigningCertSubjectRDN();

QString GetSigningCertValidFrom();

QString GetSigningCertValidTo();

Remarks

Use this property to access the certificate that was used to create the signature.

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

Data Type

SecureBlackboxCertificate

SocketSettings Property (MailReader Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_mailreader_getsocketdnsmode(void* lpObj);
int secureblackbox_mailreader_setsocketdnsmode(void* lpObj, int iSocketDNSMode);

int secureblackbox_mailreader_getsocketdnsport(void* lpObj);
int secureblackbox_mailreader_setsocketdnsport(void* lpObj, int iSocketDNSPort);

int secureblackbox_mailreader_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_mailreader_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);

char* secureblackbox_mailreader_getsocketdnsservers(void* lpObj);
int secureblackbox_mailreader_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);

int secureblackbox_mailreader_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_mailreader_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);

int secureblackbox_mailreader_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_mailreader_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

char* secureblackbox_mailreader_getsocketlocaladdress(void* lpObj);
int secureblackbox_mailreader_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

int secureblackbox_mailreader_getsocketlocalport(void* lpObj);
int secureblackbox_mailreader_setsocketlocalport(void* lpObj, int iSocketLocalPort);

int secureblackbox_mailreader_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_mailreader_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

int secureblackbox_mailreader_getsockettimeout(void* lpObj);
int secureblackbox_mailreader_setsockettimeout(void* lpObj, int iSocketTimeout);

int secureblackbox_mailreader_getsocketuseipv6(void* lpObj);
int secureblackbox_mailreader_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

TLSSettings Property (MailReader Class)

Manages TLS layer settings.

Syntax

SecureBlackboxTLSSettings* GetTLSSettings();

int secureblackbox_mailreader_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_mailreader_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);

int secureblackbox_mailreader_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_mailreader_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

char* secureblackbox_mailreader_gettlsciphersuites(void* lpObj);
int secureblackbox_mailreader_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

int secureblackbox_mailreader_gettlsclientauth(void* lpObj);
int secureblackbox_mailreader_settlsclientauth(void* lpObj, int iTLSClientAuth);

char* secureblackbox_mailreader_gettlseccurves(void* lpObj);
int secureblackbox_mailreader_settlseccurves(void* lpObj, const char* lpszTLSECCurves);

char* secureblackbox_mailreader_gettlsextensions(void* lpObj);
int secureblackbox_mailreader_settlsextensions(void* lpObj, const char* lpszTLSExtensions);

int secureblackbox_mailreader_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_mailreader_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);

char* secureblackbox_mailreader_gettlspresharedidentity(void* lpObj);
int secureblackbox_mailreader_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);

char* secureblackbox_mailreader_gettlspresharedkey(void* lpObj);
int secureblackbox_mailreader_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

char* secureblackbox_mailreader_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_mailreader_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);

int secureblackbox_mailreader_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_mailreader_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

int secureblackbox_mailreader_gettlsrevocationcheck(void* lpObj);
int secureblackbox_mailreader_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

int secureblackbox_mailreader_gettlsssloptions(void* lpObj);
int secureblackbox_mailreader_settlsssloptions(void* lpObj, int iTLSSSLOptions);

int secureblackbox_mailreader_gettlstlsmode(void* lpObj);
int secureblackbox_mailreader_settlstlsmode(void* lpObj, int iTLSTLSMode);

int secureblackbox_mailreader_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_mailreader_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

int secureblackbox_mailreader_gettlsusesessionresumption(void* lpObj);
int secureblackbox_mailreader_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

int secureblackbox_mailreader_gettlsversions(void* lpObj);
int secureblackbox_mailreader_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 (MailReader Class)

A list of trusted certificates for chain validation.

Syntax

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

int secureblackbox_mailreader_gettrustedcertcount(void* lpObj);
int secureblackbox_mailreader_settrustedcertcount(void* lpObj, int iTrustedCertCount);

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

int64 secureblackbox_mailreader_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_mailreader_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);

int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

QByteArray GetTrustedCertBytes(int iTrustedCertIndex);

qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);

Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

UsedCertificates Property (MailReader Class)

Contains a list of certificates used during the chain validation routine.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetUsedCertificates();

int secureblackbox_mailreader_getusedcertcount(void* lpObj);

int secureblackbox_mailreader_getusedcertbytes(void* lpObj, int usedcertindex, char** lpUsedCertBytes, int* lenUsedCertBytes);

int secureblackbox_mailreader_getusedcertca(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertcakeyid(void* lpObj, int usedcertindex, char** lpUsedCertCAKeyID, int* lenUsedCertCAKeyID);

int secureblackbox_mailreader_getusedcertcerttype(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertcrldistributionpoints(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertcurve(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertfingerprint(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertfriendlyname(void* lpObj, int usedcertindex);

int64 secureblackbox_mailreader_getusedcerthandle(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcerthashalgorithm(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertissuer(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertissuerrdn(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertkeyalgorithm(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertkeybits(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertkeyfingerprint(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertkeyusage(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertkeyvalid(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertocsplocations(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertocspnocheck(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertorigin(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertpolicyids(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertprivatekeybytes(void* lpObj, int usedcertindex, char** lpUsedCertPrivateKeyBytes, int* lenUsedCertPrivateKeyBytes);

int secureblackbox_mailreader_getusedcertprivatekeyexists(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertprivatekeyextractable(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertpublickeybytes(void* lpObj, int usedcertindex, char** lpUsedCertPublicKeyBytes, int* lenUsedCertPublicKeyBytes);

int secureblackbox_mailreader_getusedcertqualified(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertqualifiedstatements(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertqualifiers(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertselfsigned(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertserialnumber(void* lpObj, int usedcertindex, char** lpUsedCertSerialNumber, int* lenUsedCertSerialNumber);

char* secureblackbox_mailreader_getusedcertsigalgorithm(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertsource(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertsubject(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertsubjectalternativename(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertsubjectkeyid(void* lpObj, int usedcertindex, char** lpUsedCertSubjectKeyID, int* lenUsedCertSubjectKeyID);

char* secureblackbox_mailreader_getusedcertsubjectrdn(void* lpObj, int usedcertindex);

int secureblackbox_mailreader_getusedcertvalid(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertvalidfrom(void* lpObj, int usedcertindex);

char* secureblackbox_mailreader_getusedcertvalidto(void* lpObj, int usedcertindex);

int GetUsedCertCount();

QByteArray GetUsedCertBytes(int iUsedCertIndex);

bool GetUsedCertCA(int iUsedCertIndex);

QByteArray GetUsedCertCAKeyID(int iUsedCertIndex);

int GetUsedCertCertType(int iUsedCertIndex);

QString GetUsedCertCRLDistributionPoints(int iUsedCertIndex);

QString GetUsedCertCurve(int iUsedCertIndex);

QString GetUsedCertFingerprint(int iUsedCertIndex);

QString GetUsedCertFriendlyName(int iUsedCertIndex);

qint64 GetUsedCertHandle(int iUsedCertIndex);

QString GetUsedCertHashAlgorithm(int iUsedCertIndex);

QString GetUsedCertIssuer(int iUsedCertIndex);

QString GetUsedCertIssuerRDN(int iUsedCertIndex);

QString GetUsedCertKeyAlgorithm(int iUsedCertIndex);

int GetUsedCertKeyBits(int iUsedCertIndex);

QString GetUsedCertKeyFingerprint(int iUsedCertIndex);

int GetUsedCertKeyUsage(int iUsedCertIndex);

bool GetUsedCertKeyValid(int iUsedCertIndex);

QString GetUsedCertOCSPLocations(int iUsedCertIndex);

bool GetUsedCertOCSPNoCheck(int iUsedCertIndex);

int GetUsedCertOrigin(int iUsedCertIndex);

QString GetUsedCertPolicyIDs(int iUsedCertIndex);

QByteArray GetUsedCertPrivateKeyBytes(int iUsedCertIndex);

bool GetUsedCertPrivateKeyExists(int iUsedCertIndex);

bool GetUsedCertPrivateKeyExtractable(int iUsedCertIndex);

QByteArray GetUsedCertPublicKeyBytes(int iUsedCertIndex);

bool GetUsedCertQualified(int iUsedCertIndex);

int GetUsedCertQualifiedStatements(int iUsedCertIndex);

QString GetUsedCertQualifiers(int iUsedCertIndex);

bool GetUsedCertSelfSigned(int iUsedCertIndex);

QByteArray GetUsedCertSerialNumber(int iUsedCertIndex);

QString GetUsedCertSigAlgorithm(int iUsedCertIndex);

int GetUsedCertSource(int iUsedCertIndex);

QString GetUsedCertSubject(int iUsedCertIndex);

QString GetUsedCertSubjectAlternativeName(int iUsedCertIndex);

QByteArray GetUsedCertSubjectKeyID(int iUsedCertIndex);

QString GetUsedCertSubjectRDN(int iUsedCertIndex);

bool GetUsedCertValid(int iUsedCertIndex);

QString GetUsedCertValidFrom(int iUsedCertIndex);

QString GetUsedCertValidTo(int iUsedCertIndex);

Remarks

Use this property to access the list of certificates that were used during the chain validation.

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

Data Type

SecureBlackboxCertificate

ValidationMoment Property (MailReader 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_mailreader_getvalidationmoment(void* lpObj);
int secureblackbox_mailreader_setvalidationmoment(void* lpObj, const char* lpszValidationMoment);

QString GetValidationMoment();
int SetValidationMoment(QString qsValidationMoment);

Default Value

Remarks

Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).

The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.

Data Type

String

Config Method (MailReader Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_mailreader_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 (MailReader 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_mailreader_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling (C++)

FindAttachment Method (MailReader Class)

Looks up a Message's attachment by its ID.

Syntax

ANSI (Cross Platform)
int FindAttachment(const char* lpszID);

Unicode (Windows)
INT FindAttachment(LPCWSTR lpszID);

int secureblackbox_mailreader_findattachment(void* lpObj, const char* lpszID);

int FindAttachment(const QString& qsID);

Remarks

Use this method to find the attachment by its ID.

Error Handling (C++)

This method returns an Integer 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.

LoadFromBytes Method (MailReader Class)

Loads an e-mail message from a byte array.

Syntax

ANSI (Cross Platform)
int LoadFromBytes(const char* lpMessageBytes, int lenMessageBytes);

Unicode (Windows)
INT LoadFromBytes(LPCSTR lpMessageBytes, INT lenMessageBytes);

int secureblackbox_mailreader_loadfrombytes(void* lpObj, const char* lpMessageBytes, int lenMessageBytes);

int LoadFromBytes(QByteArray qbaMessageBytes);

Remarks

Use this method to load a message from a byte array and process it. Once the message has been loaded, use Message to access its properties.

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

LoadFromFile Method (MailReader Class)

Loads an e-mail message from a file.

Syntax

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

Unicode (Windows)
INT LoadFromFile(LPCWSTR lpszFileName);

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

int LoadFromFile(const QString& qsFileName);

Remarks

Use this method to load a message from a file and process it. Once the message has been loaded, use Message to access its properties.

Error Handling (C++)

LoadFromStream Method (MailReader Class)

Loads an e-mail message from a stream.

Syntax

ANSI (Cross Platform)
int LoadFromStream(SecureBlackboxStream* sStream);

Unicode (Windows)
INT LoadFromStream(SecureBlackboxStream* sStream);

int secureblackbox_mailreader_loadfromstream(void* lpObj, SecureBlackboxStream* sStream);

int LoadFromStream(SecureBlackboxStream* sStream);

Remarks

Use this method to load a message from a stream and process it. Once the message has been loaded, use Message to access its properties.

Error Handling (C++)

Reset Method (MailReader Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_mailreader_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

ChainValidated Event (MailReader Class)

Reports the completion of a certificate chain validation.

Syntax

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

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


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

typedef struct {
  LPCWSTR SubjectRDN;
  INT ValidationResult;
  INT ValidationDetails;
  INT reserved;
} MailReaderChainValidatedEventParams;

#define EID_MAILREADER_CHAINVALIDATED 1

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

class MailReaderChainValidatedEventParams {
public:
  const QString &SubjectRDN();

  int ValidationResult();

  int ValidationDetails();

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

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

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

DecryptionInfoNeeded Event (MailReader Class)

Asks the application to provide a decryption certificate.

Syntax

ANSI (Cross Platform)
virtual int FireDecryptionInfoNeeded(MailReaderDecryptionInfoNeededEventParams *e);

typedef struct {
  const char *IssuerRDN;
  const char *SerialNumber;
  int lenSerialNumber;
  const char *SubjectKeyID;
  int lenSubjectKeyID;
  int reserved;
} MailReaderDecryptionInfoNeededEventParams;


Unicode (Windows)
virtual INT FireDecryptionInfoNeeded(MailReaderDecryptionInfoNeededEventParams *e);

typedef struct {
  LPCWSTR IssuerRDN;
  LPCSTR SerialNumber;
  INT lenSerialNumber;
  LPCSTR SubjectKeyID;
  INT lenSubjectKeyID;
  INT reserved;
} MailReaderDecryptionInfoNeededEventParams;

#define EID_MAILREADER_DECRYPTIONINFONEEDED 2

virtual INT SECUREBLACKBOX_CALL FireDecryptionInfoNeeded(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID);

class MailReaderDecryptionInfoNeededEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

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

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

// Or, subclass MailReader and override this emitter function.
virtual int FireDecryptionInfoNeeded(MailReaderDecryptionInfoNeededEventParams *e) {...}

Remarks

This event is fired when the component needs a decryption certificate. Use the provided values to look up the certificate, and assign it to DecryptionCertificate property.

Note that the decryption certificate must have an associated private key.

Error Event (MailReader Class)

Reports information about errors during e-mail message loading, parsing or saving.

Syntax

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

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


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

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

#define EID_MAILREADER_ERROR 3

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

class MailReaderErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass MailReader and override this emitter function.
virtual int FireError(MailReaderErrorEventParams *e) {...}

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error.

ExternalDecrypt Event (MailReader Class)

Handles remote or external decryption.

Syntax

ANSI (Cross Platform)
virtual int FireExternalDecrypt(MailReaderExternalDecryptEventParams *e);

typedef struct {
  const char *OperationId;
  const char *Algorithm;
  const char *Pars;
  const char *EncryptedData;
  char *Data;
  int reserved;
} MailReaderExternalDecryptEventParams;


Unicode (Windows)
virtual INT FireExternalDecrypt(MailReaderExternalDecryptEventParams *e);

typedef struct {
  LPCWSTR OperationId;
  LPCWSTR Algorithm;
  LPCWSTR Pars;
  LPCWSTR EncryptedData;
  LPWSTR Data;
  INT reserved;
} MailReaderExternalDecryptEventParams;

#define EID_MAILREADER_EXTERNALDECRYPT 4

virtual INT SECUREBLACKBOX_CALL FireExternalDecrypt(LPSTR &lpszOperationId, LPSTR &lpszAlgorithm, LPSTR &lpszPars, LPSTR &lpszEncryptedData, LPSTR &lpszData);

class MailReaderExternalDecryptEventParams {
public:
  const QString &OperationId();

  const QString &Algorithm();

  const QString &Pars();

  const QString &EncryptedData();

  const QString &Data();
  void SetData(const QString &qsData);

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

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

// Or, subclass MailReader and override this emitter function.
virtual int FireExternalDecrypt(MailReaderExternalDecryptEventParams *e) {...}

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

Notification Event (MailReader Class)

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

Syntax

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

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


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

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

#define EID_MAILREADER_NOTIFICATION 5

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

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

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

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

SignatureFound Event (MailReader Class)

Signifies the start of signature validation.

Syntax

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

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


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

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

#define EID_MAILREADER_SIGNATUREFOUND 6

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

class MailReaderSignatureFoundEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool CertFound();

  bool ValidateSignature();
  void SetValidateSignature(bool bValidateSignature);

  bool ValidateChain();
  void SetValidateChain(bool bValidateChain);

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

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

// Or, subclass MailReader and override this emitter function.
virtual int FireSignatureFound(MailReaderSignatureFoundEventParams *e) {...}

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

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

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

SignatureValidated Event (MailReader Class)

Marks the completion of the signature validation routine.

Syntax

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

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


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

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

#define EID_MAILREADER_SIGNATUREVALIDATED 7

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

class MailReaderSignatureValidatedEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  int ValidationResult();

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

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

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

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

Fields

Bytes
char* (read-only)
Default Value:

Returns the raw certificate data in DER format.

CA
int
Default Value: FALSE

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.

CAKeyID
char* (read-only)
Default Value:

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

CertType
int (read-only)
Default Value: 0

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager class to load or create new certificate and certificate requests objects.

CRLDistributionPoints
char*
Default Value: ""

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

Curve
char*
Default Value: ""

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

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

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

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

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

Handle
int64
Default Value: 0

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

HashAlgorithm
char*
Default Value: ""

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

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

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.

IssuerRDN
char*
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

KeyAlgorithm
char*
Default Value: "0"

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.

KeyBits
int (read-only)
Default Value: 0

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.

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

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

KeyUsage
int
Default Value: 0

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this field before generating the certificate to propagate the key usage flags to the new certificate.

KeyValid
int (read-only)
Default Value: FALSE

Returns True if the certificate's key is cryptographically valid, and False otherwise.

OCSPLocations
char*
Default Value: ""

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

OCSPNoCheck
int
Default Value: FALSE

Accessor to the value of the certificate's ocsp-no-check extension.

Origin
int (read-only)
Default Value: 0

Returns the location that the certificate was taken or loaded from.

PolicyIDs
char*
Default Value: ""

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this field when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

PrivateKeyBytes
char* (read-only)
Default Value:

Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

PrivateKeyExists
int (read-only)
Default Value: FALSE

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

PrivateKeyExtractable
int (read-only)
Default Value: FALSE

Indicates whether the private key is extractable (exportable).

PublicKeyBytes
char* (read-only)
Default Value:

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

Qualified
int (read-only)
Default Value: FALSE

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

QualifiedStatements
int
Default Value: 0

Returns a simplified qualified status of the certificate.

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

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

SelfSigned
int (read-only)
Default Value: FALSE

Indicates whether the certificate is self-signed (root) or signed by an external CA.

SerialNumber
char*
Default Value:

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

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

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

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

Source
int (read-only)
Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.

SubjectAlternativeName
char*
Default Value: ""

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

Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

SubjectKeyID
char*
Default Value:

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

SubjectRDN
char*
Default Value: ""

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

Valid
int (read-only)
Default Value: FALSE

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

ValidFrom
char*
Default Value: ""

The time point at which the certificate becomes valid, in UTC.

ValidTo
char*
Default Value: ""

The time point at which the certificate expires, in UTC.

Constructors

Certificate()

Creates a new object with default field values.

CRL Type

Represents a Certificate Revocation List.

Syntax

SecureBlackboxCRL (declared in secureblackbox.h)

Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

The following fields are available:

Fields

Bytes
char* (read-only)
Default Value:

Returns the raw CRL data in DER format.

CAKeyID
char*
Default Value:

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

EntryCount
int (read-only)
Default Value: 0

Returns the number of certificate status entries in the CRL.

Handle
int64
Default Value: 0

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

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

The common name of the CRL issuer (CA), typically a company name.

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

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

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

The URL that the CRL was downloaded from.

NextUpdate
char*
Default Value: ""

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

SigAlgorithm
char*
Default Value: "0"

The public key algorithm that was used by the CA to sign this CRL.

Source
int (read-only)
Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

TBS
char* (read-only)
Default Value:

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

ThisUpdate
char*
Default Value: ""

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

Constructors

CRL()

Creates an empty CRL object.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

The following fields are available:

AsyncDocumentID

CustomParams

Data

ExternalHashCalculation

Fields

AsyncDocumentID
char*
Default Value: ""

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

CustomParams
char*
Default Value: ""

Custom parameters to be passed to the signing service (uninterpreted).

Data
char*
Default Value: ""

Additional data to be included in the async state and mirrored back by the requestor.

ExternalHashCalculation
int
Default Value: FALSE

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

HashAlgorithm
char*
Default Value: "SHA256"

Specifies the request's signature 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`

KeyID
char*
Default Value: ""

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

KeySecret
char*
Default Value: ""

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the KeyID topic.

Method
int
Default Value: 0

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Mode
int
Default Value: 0

Specifies the external cryptography mode.

Available options:


ecmDefault	The default value (`0`)
ecmDisabled	Do not use DC or external signing (`1`)
ecmGeneric	Generic external signing with the OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

PublicKeyAlgorithm
char*
Default Value: ""

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.


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`

Constructors

ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

MailAddress Type

A container for an e-mail addressee.

Syntax

SecureBlackboxMailAddress (declared in secureblackbox.h)

Remarks

This object is a container for an e-mail identity record. A typical e-mail address consists of an RFC822 e-mail address (john@doe.com), a friendly name (John Doe), and a group name (Officers).

The following fields are available:

Address

DisplayName

GroupName

Fields

Address
char*
Default Value: ""

Contains the e-mail address in the form of john@doe.com.

DisplayName
char*
Default Value: ""

Contains the friendly name of the user of this address, such as John Doe.

GroupName
char*
Default Value: ""

The name of the group this address belongs to.

Constructors

MailAddress(const char* lpszAddress)

Creates a new e-mail address object.

MailAddress(const char* lpszDisplayName, const char* lpszAddress)

Creates a new e-mail address object from an address and a display name.

MailAttachment Type

Represents an attachment to an e-mail message.

Syntax

SecureBlackboxMailAttachment (declared in secureblackbox.h)

Remarks

This object is a container for message attachments.

The following fields are available:

Fields

ContentSubtype
char*
Default Value: ""

Contains the content subtype of the attachment.

ContentType
char*
Default Value: ""

Contains the content type of the attachment.

CreationDate
char*
Default Value: ""

The creation date.

Data
char*
Default Value:

The content of the attachment.

Description
char*
Default Value: ""

Textual description of the attachment.

This property maps to the Content-Description e-mail header field. Although the field is optional, the ability to associate descriptive information with a given body is often desirable. One example is specifying the title of an image using this property.

FileName
char*
Default Value: ""

Specifies the name of the attachment 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.

ID
char*
Default Value: ""

Contains the attachment's unique identifier.

ModificationDate
char*
Default Value: ""

Specifies the date and time of the file's last modification.

ReadDate
char*
Default Value: ""

Specifies the file's last read date.

Size
int64
Default Value: 0

The attachment's size in bytes.

Constructors

MailAttachment(const char* lpszContentType)

Creates an empty mail attachment object.

MailMessage Type

Represents an e-mail message.

Syntax

SecureBlackboxMailMessage (declared in secureblackbox.h)

Remarks

This object is a container for an e-mail message.

A message consists of a header and a body. The header, in turn, consists of several header fields. The names, syntax, and expected contents of the header fields are standardized.

The message body can contain anything you like (a message may not even have a body at all).

The following fields are available:

Fields

AttachmentCount
int (read-only)
Default Value: 0

Returns the number of attachments in this message.

Bcc
char*
Default Value: ""

The contents of the BCC header field.

The BCC header field contains the addresses of secondary recipients of the message whose addresses are not to be revealed to other recipients of the message. Mail servers remove the BCC header when processing the message and use its value for dispatching the message only.

Cc
char*
Default Value: ""

The value of the CC header field.

The CC field contains the addresses of secondary recipients of the message.

Comments
char*
Default Value: ""

Contains additional information about the message body.

Date
char*
Default Value: ""

The date and time when the message entered the mail delivery system.

This field contains the date and time at which the creator of the message posted the message to the mail delivery system.

The date is returned and accepted in UTC time zone.

DeliveryReceipt
int
Default Value: FALSE

Enables delivery notification.

From
char*
Default Value: ""

Contains the value of the From header field.

This field contains the address(es) of the message author(s). If the actual sender is not the author of the message, use Sender to specify the sender separately.

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.

HtmlText
char*
Default Value: ""

The HTML version of the message.

ID
char*
Default Value: ""

The contents of the Message-ID header field.

This field contains a unique identifier that refers to a particular version of this message.

InReplyTo
char*
Default Value: ""

The value of the In-Reply-To header field.

A reply message should have the "In-Reply-To:" header field which may be used to identify the message (or messages) to which the new message is a reply.

Keywords
char*
Default Value: ""

The value of the Keywords header field.

This field can be used to add some important words and phrases that might be useful for the recipient.

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

The name of the software that was used to send the message.

PlainText
char*
Default Value: ""

The plain text version of the message.

Priority
int
Default Value: 2

Specifies the message priority.

Available options:


mpLowest	`0`
mpLow	`1`
mpNormal	`2`
mpHigh	`3`
mpHighest	`4`

ReadReceipt
int
Default Value: FALSE

Enables a read notification.

References
char*
Default Value: ""

The value of the References header field.

A reply message should include a "References:" header field which may be used to identify the "conversation thread". If the initial message is a reply itself, the References of the reply contain combined content of its "References:", "InReplyTo:" and "MessageID:" fields, subject to their presence in the original message.

ReplyTo
char*
Default Value: ""

The value of the Reply-To header field.

This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the From field.

ReturnPath
char*
Default Value: ""

The value of the Return-Path header field.

This field contains the address to which this message shall be returned in case of unsuccessful delivery.

Sender
char*
Default Value: ""

The value of the Sender header field.

This field specifies the mailbox of the agent responsible for the actual transmission of this message. If the originator of the message can be indicated by a single mailbox and both the author and the transmitter are identical, the "Sender:" field is deemed excessive and should not be used.

SendTo
char*
Default Value: ""

The value of the To header field.

This field specifies the address(es) of the primary recipient(s) of the message.

Subject
char*
Default Value: ""

Contains the subject field of this message.

Constructors

MailMessage()

Creates a new empty mail message object.

MailSecurityInfo Type

Contains security details for the processed e-mail message.

Syntax

SecureBlackboxMailSecurityInfo (declared in secureblackbox.h)

Remarks

This object provides access to security details of an e-mail message.

The following fields are available:

ChainValidationDetails

ChainValidationResult

SignatureValidationResult

Signed

ValidationLog

Fields

ChainValidationDetails
int (read-only)
Default Value: 0

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

ChainValidationResult
int (read-only)
Default Value: 0

The outcome of a certificate chain validation routine.

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

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

Returns the signature's claimed signing time.

Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by a trusted timestamp and may be forfeited or wrong. The time is provided in UTC.

Encrypted
int (read-only)
Default Value: FALSE

Indicates whether the message is encrypted.

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

Indicates the algorithm that was used to encrypt the message.

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

Specifies the hash algorithm that was used to calculate the signature.

SignatureValidationResult
int (read-only)
Default Value: 0

The outcome of the cryptographic signature validation.

The following signature validity values are supported:


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

Signed
int (read-only)
Default Value: FALSE

Indicates whether the message is signed.

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

MailSecurityInfo()

Creates a new MailSecurityInfo object.

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Syntax

SecureBlackboxOCSPResponse (declared in secureblackbox.h)

Remarks

OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).

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

The following fields are available:

Fields

Bytes
char* (read-only)
Default Value:

A buffer containing the raw OCSP response data.

EntryCount
int (read-only)
Default Value: 0

The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

Handle
int64
Default Value: 0

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

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

Indicates the issuer of this response (a CA or its authorized representative).

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

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

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

The location of the OCSP responder.

ProducedAt
char*
Default Value: ""

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

SigAlgorithm
char*
Default Value: "0"

The public key algorithm that was used by the CA to sign this OCSP response.

Source
int (read-only)
Default Value: 0

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Constructors

OCSPResponse()

Creates an empty OCSP response object.

ProxySettings Type

A container for proxy server settings.

Syntax

SecureBlackboxProxySettings (declared in secureblackbox.h)

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

The following fields are available:

Fields

Address
char*
Default Value: ""

The IP address of the proxy server.

Authentication
int
Default Value: 0

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

Password
char*
Default Value: ""

The password to authenticate to the proxy server.

Port
int
Default Value: 0

The port on the proxy server to connect to.

ProxyType
int
Default Value: 0

The type of the proxy server.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

RequestHeaders
char*
Default Value: ""

Contains HTTP request headers for WebTunnel and HTTP proxy.

ResponseBody
char*
Default Value: ""

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

ResponseHeaders
char*
Default Value: ""

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

UseIPv6
int
Default Value: FALSE

Specifies whether IPv6 should be used when connecting through the proxy.

Username
char*
Default Value: ""

Specifies the username credential for proxy authentication.

Constructors

ProxySettings()

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Syntax

SecureBlackboxSocketSettings (declared in secureblackbox.h)

Remarks

This type is a container for socket-layer parameters.

The following fields are available:

Fields

DNSMode
int
Default Value: 0

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

DNSPort
int
Default Value: 0

Specifies the port number to be used for sending queries to the DNS server.

DNSQueryTimeout
int
Default Value: 0

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

DNSServers
char*
Default Value: ""

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

DNSTotalTimeout
int
Default Value: 0

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

IncomingSpeedLimit
int
Default Value: 0

The maximum number of bytes to read from the socket, per second.

LocalAddress
char*
Default Value: ""

The local network interface to bind the socket to.

LocalPort
int
Default Value: 0

The local port number to bind the socket to.

OutgoingSpeedLimit
int
Default Value: 0

The maximum number of bytes to write to the socket, per second.

Timeout
int
Default Value: 60000

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

UseIPv6
int
Default Value: FALSE

Enables or disables IP protocol version 6.

Constructors

SocketSettings()

Creates a new SocketSettings object.

StringNameValuePair Type

A simple name-value pair object.

Syntax

SecureBlackboxStringNameValuePair (declared in secureblackbox.h)

Remarks

The class represents a name-value string pair used in a variety of network components.

The following fields are available:

Fields

Category
char*
Default Value: ""

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

Format
int
Default Value: 0

Specifies the format (encoding) of the value contained in the Value property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:


svfText	`0`	The property contains text
svfBinary	`1`	The property contains binary data. The Value property contains a hex encoding of it.

Name
char*
Default Value: ""

The name element in a (name, value) pair.

Value
char*
Default Value: ""

The value element in a (name, value) pair.

Constructors

StringNameValuePair(const char* lpszName, const char* lpszValue)

Creates a name-value pair from a name and a value.

StringNameValuePair()

Creates an empty name-value object.

TLSSettings Type

A container for TLS connection settings.

Syntax

SecureBlackboxTLSSettings (declared in secureblackbox.h)

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

The following fields are available:

AutoValidateCertificates

ForceResumeIfDestinationChanges

PreSharedIdentity

PreSharedKey

PreSharedKeyCiphersuite

RenegotiationAttackPreventionMode

RevocationCheck

SSLOptions

TLSMode

UseExtendedMasterSecret

UseSessionResumption

Versions

Fields

AutoValidateCertificates
int
Default Value: TRUE

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

BaseConfiguration
int
Default Value: 0

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.


stpcDefault	`0`
stpcCompatible	`1`
stpcComprehensiveInsecure	`2`
stpcHighlySecure	`3`

Ciphersuites
char*
Default Value: ""

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

NULL_NULL_NULL
RSA_NULL_MD5
RSA_NULL_SHA
RSA_RC4_MD5
RSA_RC4_SHA
RSA_RC2_MD5
RSA_IDEA_MD5
RSA_IDEA_SHA
RSA_DES_MD5
RSA_DES_SHA
RSA_3DES_MD5
RSA_3DES_SHA
RSA_AES128_SHA
RSA_AES256_SHA
DH_DSS_DES_SHA
DH_DSS_3DES_SHA
DH_DSS_AES128_SHA
DH_DSS_AES256_SHA
DH_RSA_DES_SHA
DH_RSA_3DES_SHA
DH_RSA_AES128_SHA
DH_RSA_AES256_SHA
DHE_DSS_DES_SHA
DHE_DSS_3DES_SHA
DHE_DSS_AES128_SHA
DHE_DSS_AES256_SHA
DHE_RSA_DES_SHA
DHE_RSA_3DES_SHA
DHE_RSA_AES128_SHA
DHE_RSA_AES256_SHA
DH_ANON_RC4_MD5
DH_ANON_DES_SHA
DH_ANON_3DES_SHA
DH_ANON_AES128_SHA
DH_ANON_AES256_SHA
RSA_RC2_MD5_EXPORT
RSA_RC4_MD5_EXPORT
RSA_DES_SHA_EXPORT
DH_DSS_DES_SHA_EXPORT
DH_RSA_DES_SHA_EXPORT
DHE_DSS_DES_SHA_EXPORT
DHE_RSA_DES_SHA_EXPORT
DH_ANON_RC4_MD5_EXPORT
DH_ANON_DES_SHA_EXPORT
RSA_CAMELLIA128_SHA
DH_DSS_CAMELLIA128_SHA
DH_RSA_CAMELLIA128_SHA
DHE_DSS_CAMELLIA128_SHA
DHE_RSA_CAMELLIA128_SHA
DH_ANON_CAMELLIA128_SHA
RSA_CAMELLIA256_SHA
DH_DSS_CAMELLIA256_SHA
DH_RSA_CAMELLIA256_SHA
DHE_DSS_CAMELLIA256_SHA
DHE_RSA_CAMELLIA256_SHA
DH_ANON_CAMELLIA256_SHA
PSK_RC4_SHA
PSK_3DES_SHA
PSK_AES128_SHA
PSK_AES256_SHA
DHE_PSK_RC4_SHA
DHE_PSK_3DES_SHA
DHE_PSK_AES128_SHA
DHE_PSK_AES256_SHA
RSA_PSK_RC4_SHA
RSA_PSK_3DES_SHA
RSA_PSK_AES128_SHA
RSA_PSK_AES256_SHA
RSA_SEED_SHA
DH_DSS_SEED_SHA
DH_RSA_SEED_SHA
DHE_DSS_SEED_SHA
DHE_RSA_SEED_SHA
DH_ANON_SEED_SHA
SRP_SHA_3DES_SHA
SRP_SHA_RSA_3DES_SHA
SRP_SHA_DSS_3DES_SHA
SRP_SHA_AES128_SHA
SRP_SHA_RSA_AES128_SHA
SRP_SHA_DSS_AES128_SHA
SRP_SHA_AES256_SHA
SRP_SHA_RSA_AES256_SHA
SRP_SHA_DSS_AES256_SHA
ECDH_ECDSA_NULL_SHA
ECDH_ECDSA_RC4_SHA
ECDH_ECDSA_3DES_SHA
ECDH_ECDSA_AES128_SHA
ECDH_ECDSA_AES256_SHA
ECDHE_ECDSA_NULL_SHA
ECDHE_ECDSA_RC4_SHA
ECDHE_ECDSA_3DES_SHA
ECDHE_ECDSA_AES128_SHA
ECDHE_ECDSA_AES256_SHA
ECDH_RSA_NULL_SHA
ECDH_RSA_RC4_SHA
ECDH_RSA_3DES_SHA
ECDH_RSA_AES128_SHA
ECDH_RSA_AES256_SHA
ECDHE_RSA_NULL_SHA
ECDHE_RSA_RC4_SHA
ECDHE_RSA_3DES_SHA
ECDHE_RSA_AES128_SHA
ECDHE_RSA_AES256_SHA
ECDH_ANON_NULL_SHA
ECDH_ANON_RC4_SHA
ECDH_ANON_3DES_SHA
ECDH_ANON_AES128_SHA
ECDH_ANON_AES256_SHA
RSA_NULL_SHA256
RSA_AES128_SHA256
RSA_AES256_SHA256
DH_DSS_AES128_SHA256
DH_RSA_AES128_SHA256
DHE_DSS_AES128_SHA256
DHE_RSA_AES128_SHA256
DH_DSS_AES256_SHA256
DH_RSA_AES256_SHA256
DHE_DSS_AES256_SHA256
DHE_RSA_AES256_SHA256
DH_ANON_AES128_SHA256
DH_ANON_AES256_SHA256
RSA_AES128_GCM_SHA256
RSA_AES256_GCM_SHA384
DHE_RSA_AES128_GCM_SHA256
DHE_RSA_AES256_GCM_SHA384
DH_RSA_AES128_GCM_SHA256
DH_RSA_AES256_GCM_SHA384
DHE_DSS_AES128_GCM_SHA256
DHE_DSS_AES256_GCM_SHA384
DH_DSS_AES128_GCM_SHA256
DH_DSS_AES256_GCM_SHA384
DH_ANON_AES128_GCM_SHA256
DH_ANON_AES256_GCM_SHA384
ECDHE_ECDSA_AES128_SHA256
ECDHE_ECDSA_AES256_SHA384
ECDH_ECDSA_AES128_SHA256
ECDH_ECDSA_AES256_SHA384
ECDHE_RSA_AES128_SHA256
ECDHE_RSA_AES256_SHA384
ECDH_RSA_AES128_SHA256
ECDH_RSA_AES256_SHA384
ECDHE_ECDSA_AES128_GCM_SHA256
ECDHE_ECDSA_AES256_GCM_SHA384
ECDH_ECDSA_AES128_GCM_SHA256
ECDH_ECDSA_AES256_GCM_SHA384
ECDHE_RSA_AES128_GCM_SHA256
ECDHE_RSA_AES256_GCM_SHA384
ECDH_RSA_AES128_GCM_SHA256
ECDH_RSA_AES256_GCM_SHA384
PSK_AES128_GCM_SHA256
PSK_AES256_GCM_SHA384
DHE_PSK_AES128_GCM_SHA256
DHE_PSK_AES256_GCM_SHA384
RSA_PSK_AES128_GCM_SHA256
RSA_PSK_AES256_GCM_SHA384
PSK_AES128_SHA256
PSK_AES256_SHA384
PSK_NULL_SHA256
PSK_NULL_SHA384
DHE_PSK_AES128_SHA256
DHE_PSK_AES256_SHA384
DHE_PSK_NULL_SHA256
DHE_PSK_NULL_SHA384
RSA_PSK_AES128_SHA256
RSA_PSK_AES256_SHA384
RSA_PSK_NULL_SHA256
RSA_PSK_NULL_SHA384
RSA_CAMELLIA128_SHA256
DH_DSS_CAMELLIA128_SHA256
DH_RSA_CAMELLIA128_SHA256
DHE_DSS_CAMELLIA128_SHA256
DHE_RSA_CAMELLIA128_SHA256
DH_ANON_CAMELLIA128_SHA256
RSA_CAMELLIA256_SHA256
DH_DSS_CAMELLIA256_SHA256
DH_RSA_CAMELLIA256_SHA256
DHE_DSS_CAMELLIA256_SHA256
DHE_RSA_CAMELLIA256_SHA256
DH_ANON_CAMELLIA256_SHA256
ECDHE_ECDSA_CAMELLIA128_SHA256
ECDHE_ECDSA_CAMELLIA256_SHA384
ECDH_ECDSA_CAMELLIA128_SHA256
ECDH_ECDSA_CAMELLIA256_SHA384
ECDHE_RSA_CAMELLIA128_SHA256
ECDHE_RSA_CAMELLIA256_SHA384
ECDH_RSA_CAMELLIA128_SHA256
ECDH_RSA_CAMELLIA256_SHA384
RSA_CAMELLIA128_GCM_SHA256
RSA_CAMELLIA256_GCM_SHA384
DHE_RSA_CAMELLIA128_GCM_SHA256
DHE_RSA_CAMELLIA256_GCM_SHA384
DH_RSA_CAMELLIA128_GCM_SHA256
DH_RSA_CAMELLIA256_GCM_SHA384
DHE_DSS_CAMELLIA128_GCM_SHA256
DHE_DSS_CAMELLIA256_GCM_SHA384
DH_DSS_CAMELLIA128_GCM_SHA256
DH_DSS_CAMELLIA256_GCM_SHA384
DH_anon_CAMELLIA128_GCM_SHA256
DH_anon_CAMELLIA256_GCM_SHA384
ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
ECDH_ECDSA_CAMELLIA128_GCM_SHA256
ECDH_ECDSA_CAMELLIA256_GCM_SHA384
ECDHE_RSA_CAMELLIA128_GCM_SHA256
ECDHE_RSA_CAMELLIA256_GCM_SHA384
ECDH_RSA_CAMELLIA128_GCM_SHA256
ECDH_RSA_CAMELLIA256_GCM_SHA384
PSK_CAMELLIA128_GCM_SHA256
PSK_CAMELLIA256_GCM_SHA384
DHE_PSK_CAMELLIA128_GCM_SHA256
DHE_PSK_CAMELLIA256_GCM_SHA384
RSA_PSK_CAMELLIA128_GCM_SHA256
RSA_PSK_CAMELLIA256_GCM_SHA384
PSK_CAMELLIA128_SHA256
PSK_CAMELLIA256_SHA384
DHE_PSK_CAMELLIA128_SHA256
DHE_PSK_CAMELLIA256_SHA384
RSA_PSK_CAMELLIA128_SHA256
RSA_PSK_CAMELLIA256_SHA384
ECDHE_PSK_CAMELLIA128_SHA256
ECDHE_PSK_CAMELLIA256_SHA384
ECDHE_PSK_RC4_SHA
ECDHE_PSK_3DES_SHA
ECDHE_PSK_AES128_SHA
ECDHE_PSK_AES256_SHA
ECDHE_PSK_AES128_SHA256
ECDHE_PSK_AES256_SHA384
ECDHE_PSK_NULL_SHA
ECDHE_PSK_NULL_SHA256
ECDHE_PSK_NULL_SHA384
ECDHE_RSA_CHACHA20_POLY1305_SHA256
ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
DHE_RSA_CHACHA20_POLY1305_SHA256
PSK_CHACHA20_POLY1305_SHA256
ECDHE_PSK_CHACHA20_POLY1305_SHA256
DHE_PSK_CHACHA20_POLY1305_SHA256
RSA_PSK_CHACHA20_POLY1305_SHA256
AES128_GCM_SHA256
AES256_GCM_SHA384
CHACHA20_POLY1305_SHA256
AES128_CCM_SHA256
AES128_CCM8_SHA256

ClientAuth
int
Default Value: 0

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:


ccatNoAuth	`0`
ccatRequestCert	`1`
ccatRequireCert	`2`

ECCurves
char*
Default Value: ""

Defines the elliptic curves to enable.

Extensions
char*
Default Value: ""

Provides access to TLS extensions.

ForceResumeIfDestinationChanges
int
Default Value: FALSE

Whether to force TLS session resumption when the destination address changes.

PreSharedIdentity
char*
Default Value: ""

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

PreSharedKey
char*
Default Value: ""

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

PreSharedKeyCiphersuite
char*
Default Value: ""

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

RenegotiationAttackPreventionMode
int
Default Value: 2

Selects the renegotiation attack prevention mechanism.

The following options are available:


crapmCompatible	`0`	TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict	`1`	Renegotiation attack prevention is enabled and enforced.
crapmAuto	`2`	Automatically choose whether to enable or disable renegotiation attack prevention.

RevocationCheck
int
Default Value: 1

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

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.


crcNone	`0`	No revocation checking.
crcAuto	`1`	Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL	`2`	All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP	`3`	All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP	`4`	All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL	`5`	All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP	`6`	All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP	`7`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

SSLOptions
int
Default Value: 16

Various SSL (TLS) protocol options, set of


cssloExpectShutdownMessage	`0x001`	Wait for the close-notify message when shutting down the connection
cssloOpenSSLDTLSWorkaround	`0x002`	(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions
cssloDisableKexLengthAlignment	`0x004`	Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.
cssloForceUseOfClientCertHashAlg	`0x008`	Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.
cssloAutoAddServerNameExtension	`0x010`	Automatically add the server name extension when known
cssloAcceptTrustedSRPPrimesOnly	`0x020`	Accept trusted SRP primes only
cssloDisableSignatureAlgorithmsExtension	`0x040`	Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.
cssloIntolerateHigherProtocolVersions	`0x080`	(server option) Do not allow fallback from TLS versions higher than currently enabled
cssloStickToPrefCertHashAlg	`0x100`	Stick to preferred certificate hash algorithms
cssloNoImplicitTLS12Fallback	`0x200`	Disable implicit TLS 1.3 to 1.2 fallbacks
cssloUseHandshakeBatches	`0x400`	Send the handshake message as large batches rather than individually

TLSMode
int
Default Value: 0

Specifies the TLS mode to use.


smDefault	`0`
smNoTLS	`1`	Do not use TLS
smExplicitTLS	`2`	Connect to the server without any encryption and then request an SSL session.
smImplicitTLS	`3`	Connect to the specified port, and establish the SSL session at once.
smMixedTLS	`4`	Connect to the specified port, and establish the SSL session at once, but allow plain data.

UseExtendedMasterSecret
int
Default Value: FALSE

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

UseSessionResumption
int
Default Value: FALSE

Enables or disables the TLS session resumption capability.

Versions
int
Default Value: 16

The SSL/TLS versions to enable by default.


csbSSL2	`0x01`	SSL 2
csbSSL3	`0x02`	SSL 3
csbTLS1	`0x04`	TLS 1.0
csbTLS11	`0x08`	TLS 1.1
csbTLS12	`0x10`	TLS 1.2
csbTLS13	`0x20`	TLS 1.3

Constructors

TLSSettings()

Creates a new TLSSettings object.

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the MailReader class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The MailReader class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the MailReader class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

Properties

CanRead	Whether the stream supports reading. bool CanRead() { return true; }
CanSeek	Whether the stream supports seeking. bool CanSeek() { return true; }
CanWrite	Whether the stream supports writing. bool CanWrite() { return true; }
Length	Gets the length of the stream, in bytes. int64 GetLength() = 0;
Methods

Close	Closes the stream, releasing all resources currently allocated for it. void Close() {} This method is called automatically when a SecureBlackboxStream object is deleted.
Flush	Forces all data held by the stream's buffers to be written out to storage. int Flush() { return 0; } Must return `0` if flushing is successful; or `-1` if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return `0`.
Read	Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. int Read(void* buffer, int count) = 0; `Buffer` specifies the buffer to populate with data from the stream. `Count` specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into `Buffer`; this may be less than `Count` if that many bytes are not currently available, or `0` if the end of the stream has been reached. Must return `-1` if an error occurs, if reading is not supported, or if the stream is closed.
Seek	Sets the current position within the stream based on a particular point of origin. int64 Seek(int64 offset, int seekOrigin) = 0; `Offset` specifies the offset in the stream to seek to, relative to `SeekOrigin`. Valid values for `SeekOrigin` are: `0`: Seek from beginning. `1`: Seek from current position. `2`: Seek from end. Must return the new position within the stream; or `-1` if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If `-1` is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an `Offset` of `0` and a `SeekOrigin` of `1` to obtain the current position within the stream, even if seeking is not otherwise supported.
Write	Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. int Write(const void* buffer, int count) = 0; `Buffer` specifies the buffer with data to write to the stream. `Count` specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than `Count` if that many bytes could not be written. Must return `-1` if an error occurs, if writing is not supported, or if the stream is closed.

Config Settings (MailReader 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.

MailReader Config Settings

ChainCurrentCACert: Returns the current CA certificate.

This property returns the CA certificate that is used on the current step.

ChainCurrentCert: Returns the certificate that is currently being validated.

Use this property to obtain the body of the certificate that is currently being validated.

ChainCurrentCRL: Returns the current CRL.

Returns the CRL object that is currently being processed.

ChainCurrentCRLSize: Returns the size of the current CRL.

This property returns the size of the CRL object that is currently being processed.

ChainCurrentOCSP: Returns the current OCSP response.

Returns the OCSP object that is currently being processed.

ChainCurrentOCSPSigner: Returns the signer of the current OCSP object.

Returns the signer/CA that has issued the OCSP response that is currently being processed.

ChainInterimDetails: Returns the current interim validation details.

This property returns the interim chain validation details.

ChainInterimResult: Returns the current interim validation result.

Use this setting to obtain the current (mid-chain) validation result. This property applies to the current validation step and may change as the chain walk proceeds. The final result will be published in the ChainValidationResult property once the validation process completes.

CheckValidityPeriodForTrusted: Whether to check validity period for trusted certificates.

Whether to check validity period for trusted certificates.

DislikeOpenEndedOCSPs: Tells the class 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 class 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).

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

Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain 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.

HeaderCharset: Charset of the header. If not empty, the one specified in the message header will be ignored.

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.

IgnoreOCSPNoCheckExtension: Whether the 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 class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class 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 the 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 emulating the verifying environment without actually changing its security settings.

MaxHeaderSize: Specifies the maximum mail message header size in bytes.

Use this property to adjust the maximum size of a mail message header. If no header end (CRLFCRLF) found, the header is considered blank. Default size is 32768 (i.e. 32KB).

PromoteLongOCSPResponses: Whether long OCSP responses are requested.

Set this property to True to force the class to publish the '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.

TextCharset: Charset of text parts, if any. If not empty, the one specified in the message text parts will be ignored.

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
The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
Basic constraints and name constraints of CA certificates are ignored
Some weaker algorithms are tolerated

UseMicrosoftCTL: Enables or disables the automatic use of the 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 the chain validation module to 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.

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 class will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the class, 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 a fresh start.

Base Config Settings

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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.

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

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

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

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.

HttpVersion: The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert: Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter: The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

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.

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

ProductVersion: Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

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

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

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.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

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

MailReader Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)
22020097	Failed to assemble the mail message (`SB_ERROR_MAIL_ASSEMBLY_FAILED`)
22020098	Failed to assemble the mail message (`SB_ERROR_MAIL_PARSING_FAILED`)
22020099	No decryption certificate found (`SB_ERROR_MAIL_NO_DECRYPTION_CERTIFICATE`)