CRLManager Class

Properties   Methods   Events   Config Settings   Errors  

The CRLManager class supports the importing, exporting, and validation of Certificate Revocation Lists (CRLs).

Syntax

CRLManager

Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid for any number of reasons by the issuing certificate authority (CA). CRLs identify certificates by their serial numbers. Therefore, by knowing the certificate's SerialNumber, its validity status can be checked against a CRL.

Each CRL corresponds to one issuing point, and each Certificate Authority (CA) certificate can have a corresponding CRL which contains information about the certificates signed with this CA certificate.

CAs are not required to issue CRLs if other revocation or certificate status mechanisms are provided. Each CRL must contain the date by which the next CRL will be issued. This date is specified by the NextUpdate field.

Property List

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

Method List

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

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.

Config Settings

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

CACertBytes Property (CRLManager Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCACertBytes(char* &lpCACertBytes, int &lenCACertBytes);

Unicode (Windows)
INT GetCACertBytes(LPSTR &lpCACertBytes, INT &lenCACertBytes);

int secureblackbox_crlmanager_getcacertbytes(void* lpObj, char** lpCACertBytes, int* lenCACertBytes);

QByteArray GetCACertBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CACertHandle Property (CRLManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCACertHandle();
int SetCACertHandle(int64 lCACertHandle);

Unicode (Windows)
LONG64 GetCACertHandle();
INT SetCACertHandle(LONG64 lCACertHandle);

int64 secureblackbox_crlmanager_getcacerthandle(void* lpObj);
int secureblackbox_crlmanager_setcacerthandle(void* lpObj, int64 lCACertHandle);

qint64 GetCACertHandle();
int SetCACertHandle(qint64 lCACertHandle);

Default Value

0

Remarks

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

CRLBytes Property (CRLManager Class)

Returns the raw CRL data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCRLBytes(char* &lpCRLBytes, int &lenCRLBytes);

Unicode (Windows)
INT GetCRLBytes(LPSTR &lpCRLBytes, INT &lenCRLBytes);

int secureblackbox_crlmanager_getcrlbytes(void* lpObj, char** lpCRLBytes, int* lenCRLBytes);

QByteArray GetCRLBytes();

Remarks

Returns the raw CRL data in DER format.

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

Data Type

Byte Array

CRLCAKeyID Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCRLCAKeyID(char* &lpCRLCAKeyID, int &lenCRLCAKeyID);
int SetCRLCAKeyID(const char* lpCRLCAKeyID, int lenCRLCAKeyID);

Unicode (Windows)
INT GetCRLCAKeyID(LPSTR &lpCRLCAKeyID, INT &lenCRLCAKeyID);
INT SetCRLCAKeyID(LPCSTR lpCRLCAKeyID, INT lenCRLCAKeyID);

int secureblackbox_crlmanager_getcrlcakeyid(void* lpObj, char** lpCRLCAKeyID, int* lenCRLCAKeyID);
int secureblackbox_crlmanager_setcrlcakeyid(void* lpObj, const char* lpCRLCAKeyID, int lenCRLCAKeyID);

QByteArray GetCRLCAKeyID();
int SetCRLCAKeyID(QByteArray qbaCRLCAKeyID);

Remarks

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

This property is not available at design time.

Data Type

Byte Array

CRLEntryCount Property (CRLManager Class)

Returns the number of certificate status entries in the CRL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCRLEntryCount();

Unicode (Windows)
INT GetCRLEntryCount();

int secureblackbox_crlmanager_getcrlentrycount(void* lpObj);

int GetCRLEntryCount();

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

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

Data Type

Integer

CRLHandle Property (CRLManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCRLHandle();
int SetCRLHandle(int64 lCRLHandle);

Unicode (Windows)
LONG64 GetCRLHandle();
INT SetCRLHandle(LONG64 lCRLHandle);

int64 secureblackbox_crlmanager_getcrlhandle(void* lpObj);
int secureblackbox_crlmanager_setcrlhandle(void* lpObj, int64 lCRLHandle);

qint64 GetCRLHandle();
int SetCRLHandle(qint64 lCRLHandle);

Default Value

0

Remarks

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

CRLIssuer Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLIssuer();

Unicode (Windows)
LPWSTR GetCRLIssuer();

char* secureblackbox_crlmanager_getcrlissuer(void* lpObj);

QString GetCRLIssuer();

Default Value

""

Remarks

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

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

Data Type

String

CRLIssuerRDN Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLIssuerRDN();

Unicode (Windows)
LPWSTR GetCRLIssuerRDN();

char* secureblackbox_crlmanager_getcrlissuerrdn(void* lpObj);

QString GetCRLIssuerRDN();

Default Value

""

Remarks

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

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

Data Type

String

CRLLocation Property (CRLManager Class)

The URL that the CRL was downloaded from.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLLocation();

Unicode (Windows)
LPWSTR GetCRLLocation();

char* secureblackbox_crlmanager_getcrllocation(void* lpObj);

QString GetCRLLocation();

Default Value

""

Remarks

The URL that the CRL was downloaded from.

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

Data Type

String

CRLNextUpdate Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLNextUpdate();

Unicode (Windows)
LPWSTR GetCRLNextUpdate();

char* secureblackbox_crlmanager_getcrlnextupdate(void* lpObj);

QString GetCRLNextUpdate();

Default Value

""

Remarks

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

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

Data Type

String

CRLSigAlgorithm Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLSigAlgorithm();

Unicode (Windows)
LPWSTR GetCRLSigAlgorithm();

char* secureblackbox_crlmanager_getcrlsigalgorithm(void* lpObj);

QString GetCRLSigAlgorithm();

Default Value

"0"

Remarks

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

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

Data Type

String

CRLTBS Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCRLTBS(char* &lpCRLTBS, int &lenCRLTBS);

Unicode (Windows)
INT GetCRLTBS(LPSTR &lpCRLTBS, INT &lenCRLTBS);

int secureblackbox_crlmanager_getcrltbs(void* lpObj, char** lpCRLTBS, int* lenCRLTBS);

QByteArray GetCRLTBS();

Remarks

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

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

Data Type

Byte Array

CRLThisUpdate Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLThisUpdate();

Unicode (Windows)
LPWSTR GetCRLThisUpdate();

char* secureblackbox_crlmanager_getcrlthisupdate(void* lpObj);

QString GetCRLThisUpdate();

Default Value

""

Remarks

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

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

Data Type

String

EntryCount Property (CRLManager Class)

The number of items in the CRL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntryCount();

Unicode (Windows)
INT GetEntryCount();

int secureblackbox_crlmanager_getentrycount(void* lpObj);

int GetEntryCount();

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

This property is read-only.

Data Type

Integer

CRLEntryInfoCertStatus Property (CRLManager Class)

Returns the status of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCRLEntryInfoCertStatus();

Unicode (Windows)
INT GetCRLEntryInfoCertStatus();

CS_UNKNOWN(0), 
CS_GOOD(1), 
CS_REVOKED(2)

int secureblackbox_crlmanager_getcrlentryinfocertstatus(void* lpObj);

int GetCRLEntryInfoCertStatus();

Default Value

0

Remarks

Returns the status of the certificate.

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

Data Type

Integer

CRLEntryInfoHandle Property (CRLManager Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetCRLEntryInfoHandle();

Unicode (Windows)
LONG64 GetCRLEntryInfoHandle();

int64 secureblackbox_crlmanager_getcrlentryinfohandle(void* lpObj);

qint64 GetCRLEntryInfoHandle();

Default Value

0

Remarks

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.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

Data Type

Long64

CRLEntryInfoRevocationDate Property (CRLManager Class)

The time and date when the certificate gets revoked or cancelled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCRLEntryInfoRevocationDate();

Unicode (Windows)
LPWSTR GetCRLEntryInfoRevocationDate();

char* secureblackbox_crlmanager_getcrlentryinforevocationdate(void* lpObj);

QString GetCRLEntryInfoRevocationDate();

Default Value

""

Remarks

The time and date when the certificate gets revoked or cancelled.

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

Data Type

String

CRLEntryInfoRevocationReason Property (CRLManager Class)

Specifies the reason for certificate revocation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCRLEntryInfoRevocationReason();

Unicode (Windows)
INT GetCRLEntryInfoRevocationReason();

int secureblackbox_crlmanager_getcrlentryinforevocationreason(void* lpObj);

int GetCRLEntryInfoRevocationReason();

Default Value

0

Remarks

Specifies the reason for certificate revocation.

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

Data Type

Integer

CRLEntryInfoSerialNumber Property (CRLManager Class)

The certificate serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCRLEntryInfoSerialNumber(char* &lpCRLEntryInfoSerialNumber, int &lenCRLEntryInfoSerialNumber);

Unicode (Windows)
INT GetCRLEntryInfoSerialNumber(LPSTR &lpCRLEntryInfoSerialNumber, INT &lenCRLEntryInfoSerialNumber);

int secureblackbox_crlmanager_getcrlentryinfoserialnumber(void* lpObj, char** lpCRLEntryInfoSerialNumber, int* lenCRLEntryInfoSerialNumber);

QByteArray GetCRLEntryInfoSerialNumber();

Remarks

The certificate serial number.

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

Data Type

Byte Array

ExternalCryptoAsyncDocumentID Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID);

Unicode (Windows)
LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_crlmanager_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_crlmanager_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

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

Default Value

""

Remarks

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.

Data Type

String

ExternalCryptoCustomParams Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams);

Unicode (Windows)
LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);

char* secureblackbox_crlmanager_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_crlmanager_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData);

Unicode (Windows)
LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);

char* secureblackbox_crlmanager_getexternalcryptodata(void* lpObj);
int secureblackbox_crlmanager_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (CRLManager Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation);

Unicode (Windows)
BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);

int secureblackbox_crlmanager_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_crlmanager_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

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

Default Value

FALSE

Remarks

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.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (CRLManager Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);

char* secureblackbox_crlmanager_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_crlmanager_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

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

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID);

Unicode (Windows)
LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);

char* secureblackbox_crlmanager_getexternalcryptokeyid(void* lpObj);
int secureblackbox_crlmanager_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

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

Default Value

""

Remarks

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

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (CRLManager Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret);

Unicode (Windows)
LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);

char* secureblackbox_crlmanager_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_crlmanager_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

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

Default Value

""

Remarks

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

Data Type

String

ExternalCryptoMethod Property (CRLManager Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Unicode (Windows)
INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_crlmanager_getexternalcryptomethod(void* lpObj);
int secureblackbox_crlmanager_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

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

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (CRLManager Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Unicode (Windows)
INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

int secureblackbox_crlmanager_getexternalcryptomode(void* lpObj);
int secureblackbox_crlmanager_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

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

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (CRLManager Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);

char* secureblackbox_crlmanager_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_crlmanager_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

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

Default Value

""

Remarks

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

Data Type

String

FIPSMode Property (CRLManager Class)

Reserved.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_crlmanager_getfipsmode(void* lpObj);
int secureblackbox_crlmanager_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

Add Method (CRLManager Class)

Adds a new revoked certificate entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add(const char* lpSerialNumber, int lenSerialNumber, const char* lpszRevocationDate, int iRevocationReason);

Unicode (Windows)
INT Add(LPCSTR lpSerialNumber, INT lenSerialNumber, LPCWSTR lpszRevocationDate, INT iRevocationReason);

int secureblackbox_crlmanager_add(void* lpObj, const char* lpSerialNumber, int lenSerialNumber, const char* lpszRevocationDate, int iRevocationReason);

int Add(QByteArray qbaSerialNumber, const QString& qsRevocationDate, int iRevocationReason);

Remarks

Use this method to add information about a revoked certificate to the CRL. SerialNumber identifies the certificate, while RevocationDate and RevocationReason set the termination date and the reason for revocation.

Note that a single CRL may only contain certificates issued by a single CA, and this CRL must be signed by that CA.

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.

Clear Method (CRLManager Class)

Empties the CRL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Clear();

Unicode (Windows)
INT Clear();

int secureblackbox_crlmanager_clear(void* lpObj);

int Clear();

Remarks

Use this method to remove all elements currently included in the CRL.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (CRLManager Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_crlmanager_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 (CRLManager Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_crlmanager_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

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

Remarks

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Download Method (CRLManager Class)

Downloads a CRL from the specified location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Download(const char* lpszURL);

Unicode (Windows)
INT Download(LPCWSTR lpszURL);

int secureblackbox_crlmanager_download(void* lpObj, const char* lpszURL);

int Download(const QString& qsURL);

Remarks

Use this method to download a CRL from a remote location specified by URL. If the download succeeds, the CRL property will be initialized with its details.

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

GetCertEntryIndex Method (CRLManager Class)

Returns the index of the CRL item by the certificate's serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertEntryIndex(const char* lpSerialNumber, int lenSerialNumber);

Unicode (Windows)
INT GetCertEntryIndex(LPCSTR lpSerialNumber, INT lenSerialNumber);

int secureblackbox_crlmanager_getcertentryindex(void* lpObj, const char* lpSerialNumber, int lenSerialNumber);

int GetCertEntryIndex(QByteArray qbaSerialNumber);

Remarks

Use this method to get the index of the CRL entry that corresponds to the certificate. The return value of -1 indicates that no entry for the given certificate was found in the CRL.

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.

GetExtensionData Method (CRLManager Class)

Returns extension data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExtensionData(const char* lpszOID, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetExtensionData(LPCWSTR lpszOID, LPINT lpSize = NULL);

char* secureblackbox_crlmanager_getextensiondata(void* lpObj, const char* lpszOID, int *lpSize);

QByteArray GetExtensionData(const QString& qsOID);

Remarks

Use this method to retrieve extension data in ASN.1 encoded format. Use GetExtensionState to check the availability of the extension and establish its critical attribute.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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.

GetExtensionState Method (CRLManager Class)

Returns certificate extension state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExtensionState(const char* lpszOID);

Unicode (Windows)
INT GetExtensionState(LPCWSTR lpszOID);

int secureblackbox_crlmanager_getextensionstate(void* lpObj, const char* lpszOID);

int GetExtensionState(const QString& qsOID);

Remarks

Use this method to find out whether the extension is included in the certificate/CRL and check its critical attribute.

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.

ListExtensions Method (CRLManager Class)

List extensions currently available in the certificate or CRL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ListExtensions();

Unicode (Windows)
LPWSTR ListExtensions();

char* secureblackbox_crlmanager_listextensions(void* lpObj);

QString ListExtensions();

Remarks

Use this method to list the extensions included in the certificate or CRL. The method returns a list of OIDs separated by newline characters.

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.

Load Method (CRLManager Class)

Loads a CRL from a byte array.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Load(const char* lpBytes, int lenBytes);

Unicode (Windows)
INT Load(LPCSTR lpBytes, INT lenBytes);

int secureblackbox_crlmanager_load(void* lpObj, const char* lpBytes, int lenBytes);

int Load(QByteArray qbaBytes);

Remarks

Use this method to load a CRL from a byte array. DER and PEM formats are supported.

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 (CRLManager Class)

Loads a CRL from a file.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT LoadFromFile(LPCWSTR lpszPath);

int secureblackbox_crlmanager_loadfromfile(void* lpObj, const char* lpszPath);

int LoadFromFile(const QString& qsPath);

Remarks

Use this method to load a CRL from a file. DER and PEM formats are supported.

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

LoadFromStream Method (CRLManager Class)

Loads a CRL from a stream.

Syntax

• C++
• C
• Qt

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

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

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

int LoadFromStream(SecureBlackboxStream* sStream);

Remarks

Use this method to load a CRL from a stream. DER and PEM formats are supported.

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

Remove Method (CRLManager Class)

Removes the specified entry from the CRL.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Remove(INT iIndex);

int secureblackbox_crlmanager_remove(void* lpObj, int iIndex);

int Remove(int iIndex);

Remarks

Use this method to remove the entry from the CRL.

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

Save Method (CRLManager Class)

Saves the CRL to a byte array.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Save(int *lpSize = NULL);

Unicode (Windows)
LPSTR Save(LPINT lpSize = NULL);

char* secureblackbox_crlmanager_save(void* lpObjint *lpSize);

QByteArray Save();

Remarks

Use this method to save the CRL to a byte array.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); 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.

SaveToFile Method (CRLManager Class)

Saves the CRL to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveToFile(const char* lpszPath);

Unicode (Windows)
INT SaveToFile(LPCWSTR lpszPath);

int secureblackbox_crlmanager_savetofile(void* lpObj, const char* lpszPath);

int SaveToFile(const QString& qsPath);

Remarks

Use this method to save the CRL to a file.

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

SaveToStream Method (CRLManager Class)

Saves this CRL to a stream.

Syntax

• C++
• C
• Qt

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

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

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

int SaveToStream(SecureBlackboxStream* sStream);

Remarks

Use this method to save the CRL to a stream.

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

SelectEntry Method (CRLManager Class)

Fetches revocation information about the selected certificate from the CRL.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SelectEntry(INT iIndex);

int secureblackbox_crlmanager_selectentry(void* lpObj, int iIndex);

int SelectEntry(int iIndex);

Remarks

Upon calling this method the revocation information for the chosen certificate entry will be propagated in EntryInfo.

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

SetExtensionData Method (CRLManager Class)

Sets extension data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetExtensionData(const char* lpszOID, const char* lpValue, int lenValue);

Unicode (Windows)
INT SetExtensionData(LPCWSTR lpszOID, LPCSTR lpValue, INT lenValue);

int secureblackbox_crlmanager_setextensiondata(void* lpObj, const char* lpszOID, const char* lpValue, int lenValue);

int SetExtensionData(const QString& qsOID, QByteArray qbaValue);

Remarks

Use this method to set extension data in encoded ASN.1 format. Use SetExtensionState to enable the extension or change its critical attribute.

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

SetExtensionState Method (CRLManager Class)

Sets certificate extension state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetExtensionState(const char* lpszOID, int iState);

Unicode (Windows)
INT SetExtensionState(LPCWSTR lpszOID, INT iState);

int secureblackbox_crlmanager_setextensionstate(void* lpObj, const char* lpszOID, int iState);

int SetExtensionState(const QString& qsOID, int iState);

Remarks

Use this method to enable or disable the extension and set its critical attribute.

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

Validate Method (CRLManager Class)

Validates the CRL signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Validate();

Unicode (Windows)
INT Validate();

int secureblackbox_crlmanager_validate(void* lpObj);

int Validate();

Remarks

Call this method to check the validity of this CRL's signature. The CACertificate property needs to be set for this method to be capable of doing the check.

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.

Error Event (CRLManager Class)

Information about errors during CRL management.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_CRLMANAGER_ERROR 1

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

class CRLManagerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

ErrorCode contains the error code and Description contains a textual description of the error. For the list of error codes please refer to CRL.

ExternalSign Event (CRLManager Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireExternalSign(CRLManagerExternalSignEventParams *e);

typedef struct {
  const char *OperationId;
  const char *HashAlgorithm;
  const char *Pars;
  const char *Data;
  char *SignedData;
  int reserved;
} CRLManagerExternalSignEventParams;


Unicode (Windows)
virtual INT FireExternalSign(CRLManagerExternalSignEventParams *e);

typedef struct {
  LPCWSTR OperationId;
  LPCWSTR HashAlgorithm;
  LPCWSTR Pars;
  LPCWSTR Data;
  LPWSTR SignedData;
  INT reserved;
} CRLManagerExternalSignEventParams;

#define EID_CRLMANAGER_EXTERNALSIGN 2

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);

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

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

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

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

// Or, subclass CRLManager and override this emitter function.
virtual int FireExternalSign(CRLManagerExternalSignEventParams *e) {...}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

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

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

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:

 
 Copy
signer.OnExternalSign += (s, e) =>
{
       var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
       var key = (RSACryptoServiceProvider)cert.PrivateKey;

       var dataToSign = e.Data.FromBase16String();
       var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
       e.SignedData = signedData.ToBase16String();
};

Notification Event (CRLManager Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_CRLMANAGER_NOTIFICATION 3

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

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

// Or, subclass CRLManager and override this emitter function.
virtual int FireNotification(CRLManagerNotificationEventParams *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.

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

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

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (CRLManager Class)

Base Config Settings

Trappable Errors (CRLManager 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.

CRLManager Errors