CRLManager Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TsbxCRLManager

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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

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

CACertBytes Property (CRLManager Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray CACertBytes = { read=FCACertBytes };

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

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

Syntax

__property __int64 CACertHandle = { read=FCACertHandle, write=FSetCACertHandle };

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

CRLBytes Property (CRLManager Component)

Returns the raw CRL data in DER format.

Syntax

__property DynamicArray CRLBytes = { read=FCRLBytes };

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

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

Syntax

__property DynamicArray CRLCAKeyID = { read=FCRLCAKeyID, write=FSetCRLCAKeyID };

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

Returns the number of certificate status entries in the CRL.

Syntax

__property int CRLEntryCount = { read=FCRLEntryCount };

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

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

Syntax

__property __int64 CRLHandle = { read=FCRLHandle, write=FSetCRLHandle };

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

CRLIssuer Property (CRLManager Component)

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

Syntax

__property String CRLIssuer = { read=FCRLIssuer };

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

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

Syntax

__property String CRLIssuerRDN = { read=FCRLIssuerRDN };

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

The URL that the CRL was downloaded from.

Syntax

__property String CRLLocation = { read=FCRLLocation };

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

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

Syntax

__property String CRLNextUpdate = { read=FCRLNextUpdate };

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

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

Syntax

__property String CRLSigAlgorithm = { read=FCRLSigAlgorithm };

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

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

Syntax

__property DynamicArray CRLTBS = { read=FCRLTBS };

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

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

Syntax

__property String CRLThisUpdate = { read=FCRLThisUpdate };

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

The number of items in the CRL.

Syntax

__property int EntryCount = { read=FEntryCount };

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

Returns the status of the certificate.

Syntax

__property TsbxCRLManagerCRLEntryInfoCertStatus CRLEntryInfoCertStatus = { read=FCRLEntryInfoCertStatus };

enum TsbxCRLManagerCRLEntryInfoCertStatus {
  csUnknown=0,
  csGood=1,
  csRevoked=2
};

Default Value

csUnknown

Remarks

Returns the status of the certificate.

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

Data Type

Integer

CRLEntryInfoHandle Property (CRLManager Component)

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

Syntax

__property __int64 CRLEntryInfoHandle = { read=FCRLEntryInfoHandle };

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

Data Type

Long64

CRLEntryInfoRevocationDate Property (CRLManager Component)

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

Syntax

__property String CRLEntryInfoRevocationDate = { read=FCRLEntryInfoRevocationDate };

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

Specifies the reason for certificate revocation.

Syntax

__property int CRLEntryInfoRevocationReason = { read=FCRLEntryInfoRevocationReason };

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

The certificate serial number.

Syntax

__property DynamicArray CRLEntryInfoSerialNumber = { read=FCRLEntryInfoSerialNumber };

Remarks

The certificate serial number.

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

Data Type

Byte Array

ExternalCryptoAsyncDocumentID Property (CRLManager Component)

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

Syntax

__property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID };

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

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

Syntax

__property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams };

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

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

Syntax

__property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData };

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

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

Syntax

__property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation };

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

If set to true, the component 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 Component)

Specifies the request's signature hash algorithm.

Syntax

__property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (CRLManager Component)

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

Syntax

__property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID };

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: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (CRLManager Component)

The pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret };

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

Specifies the asynchronous signing method.

Syntax

__property TsbxCRLManagerExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };

enum TsbxCRLManagerExternalCryptoMethods {
  asmdPKCS1=0,
  asmdPKCS7=1
};

Default Value

asmdPKCS1

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

Specifies the external cryptography mode.

Syntax

__property TsbxCRLManagerExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };

enum TsbxCRLManagerExternalCryptoModes {
  ecmDefault=0,
  ecmDisabled=1,
  ecmGeneric=2,
  ecmDCAuth=3,
  ecmDCAuthJSON=4
};

Default Value

ecmDefault

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (CRLManager Component)

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

Syntax

__property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm };

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

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Add Method (CRLManager Component)

Adds a new revoked certificate entry.

Syntax

int __fastcall Add(DynamicArray<Byte> SerialNumber, String RevocationDate, int RevocationReason);

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.

Clear Method (CRLManager Component)

Empties the CRL.

Syntax

void __fastcall Clear();

Remarks

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

Config Method (CRLManager Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

DoAction Method (CRLManager Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. 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;....

Download Method (CRLManager Component)

Downloads a CRL from the specified location.

Syntax

void __fastcall Download(String URL);

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.

GetCertEntryIndex Method (CRLManager Component)

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

Syntax

int __fastcall GetCertEntryIndex(DynamicArray<Byte> SerialNumber);

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.

GetExtensionData Method (CRLManager Component)

Returns extension data.

Syntax

DynamicArray<Byte> __fastcall GetExtensionData(String OID);

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.

GetExtensionState Method (CRLManager Component)

Returns certificate extension state.

Syntax

int __fastcall GetExtensionState(String OID);

Remarks

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

ListExtensions Method (CRLManager Component)

List extensions currently available in the certificate or CRL.

Syntax

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

Load Method (CRLManager Component)

Loads a CRL from a byte array.

Syntax

void __fastcall Load(DynamicArray<Byte> Bytes);

Remarks

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

LoadFromFile Method (CRLManager Component)

Loads a CRL from a file.

Syntax

void __fastcall LoadFromFile(String Path);

Remarks

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

Remove Method (CRLManager Component)

Removes the specified entry from the CRL.

Syntax

void __fastcall Remove(int Index);

Remarks

Use this method to remove the entry from the CRL.

Save Method (CRLManager Component)

Saves the CRL to a byte array.

Syntax

DynamicArray<Byte> __fastcall Save();

Remarks

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

SaveToFile Method (CRLManager Component)

Saves the CRL to a file.

Syntax

void __fastcall SaveToFile(String Path);

Remarks

Use this method to save the CRL to a file.

SelectEntry Method (CRLManager Component)

Fetches revocation information about the selected certificate from the CRL.

Syntax

void __fastcall SelectEntry(int Index);

Remarks

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

SetExtensionData Method (CRLManager Component)

Sets extension data.

Syntax

void __fastcall SetExtensionData(String OID, DynamicArray<Byte> Value);

Remarks

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

SetExtensionState Method (CRLManager Component)

Sets certificate extension state.

Syntax

void __fastcall SetExtensionState(String OID, int State);

Remarks

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

Validate Method (CRLManager Component)

Validates the CRL signature.

Syntax

int __fastcall 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 Event (CRLManager Component)

Information about errors during CRL management.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxCRLManagerErrorEventParams;
typedef void __fastcall (__closure *TsbxCRLManagerErrorEvent)(System::TObject* Sender, TsbxCRLManagerErrorEventParams *e);
__property TsbxCRLManagerErrorEvent OnError = { read=FOnError, write=FOnError };

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

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

Syntax

typedef struct {
  String OperationId;
  String HashAlgorithm;
  String Pars;
  String Data;
  String SignedData;
} TsbxCRLManagerExternalSignEventParams;
typedef void __fastcall (__closure *TsbxCRLManagerExternalSignEvent)(System::TObject* Sender, TsbxCRLManagerExternalSignEventParams *e);
__property TsbxCRLManagerExternalSignEvent OnExternalSign = { read=FOnExternalSign, write=FOnExternalSign };

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 component via the SignedData parameter.

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

The component 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: 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 Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxCRLManagerNotificationEventParams;
typedef void __fastcall (__closure *TsbxCRLManagerNotificationEvent)(System::TObject* Sender, TsbxCRLManagerNotificationEventParams *e);
__property TsbxCRLManagerNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

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

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

Config Settings (CRLManager Component)

The component 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 component, access to these internal properties is provided through the Config method.

Base Config Settings

Trappable Errors (CRLManager Component)

CRLManager Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)