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.

CACertificate Property (CRLManager Component)

The CA certificate that issues this CRL.

Syntax

property CACertificate: TsbxCertificate read get_CACertificate write set_CACertificate;

Remarks

Assign the CA certificate that is the issuer of this CRL to this property to validate the CRL's signature or re-sign it. In the latter case the CA certificate needs to have an associated private key.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

CRL Property (CRLManager Component)

Provides access to general properties of the CRL.

Syntax

property CRL: TsbxCRL read get_CRL write set_CRL;

Remarks

Use this property to access general information about this CRL, such as its issuer, location, and update times.

Use SelectEntry and EntryInfo to access individual entries.

This property is not available at design time.

Please refer to the CRL type for a complete list of fields.

EntryCount Property (CRLManager Component)

The number of items in the CRL.

Syntax

property EntryCount: Integer read get_EntryCount;

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

This property is read-only.

EntryInfo Property (CRLManager Component)

Revocation details of the selected certificate status entry.

Syntax

property EntryInfo: TsbxCRLEntryInfo read get_EntryInfo;

Remarks

Use this property to access the revocation details of a single certificate status entry. Before accessing this property, please select the needed entry using SelectEntry method.

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

Please refer to the CRLEntryInfo type for a complete list of fields.

ExternalCrypto Property (CRLManager Component)

Provides access to external signing and DC parameters.

Syntax

property ExternalCrypto: TsbxExternalCrypto read get_ExternalCrypto;

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.

Please refer to the ExternalCrypto type for a complete list of fields.

FIPSMode Property (CRLManager Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

Add Method (CRLManager Component)

Adds a new revoked certificate entry.

Syntax

function Add(SerialNumber: TBytes; RevocationDate: String; RevocationReason: Integer): Integer;

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

procedure 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

function Config(ConfigurationString: String): String;

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

function DoAction(ActionID: String; ActionParams: String): String;

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

procedure Download(URL: String);

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

function GetCertEntryIndex(SerialNumber: TBytes): Integer;

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

function GetExtensionData(OID: String): TBytes;

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

function GetExtensionState(OID: String): Integer;

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

function ListExtensions(): String;

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

procedure Load(Bytes: TBytes);

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

procedure LoadFromFile(Path: String);

Remarks

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

LoadFromStream Method (CRLManager Component)

Loads a CRL from a stream.

Syntax

procedure LoadFromStream(Stream: TStream);

Remarks

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

Remove Method (CRLManager Component)

Removes the specified entry from the CRL.

Syntax

procedure Remove(Index: Integer);

Remarks

Use this method to remove the entry from the CRL.

Save Method (CRLManager Component)

Saves the CRL to a byte array.

Syntax

function Save(): TBytes;

Remarks

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

SaveToFile Method (CRLManager Component)

Saves the CRL to a file.

Syntax

procedure SaveToFile(Path: String);

Remarks

Use this method to save the CRL to a file.

SaveToStream Method (CRLManager Component)

Saves this CRL to a stream.

Syntax

procedure SaveToStream(Stream: TStream);

Remarks

Use this method to save the CRL to a stream.

SelectEntry Method (CRLManager Component)

Fetches revocation information about the selected certificate from the CRL.

Syntax

procedure SelectEntry(Index: Integer);

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

procedure SetExtensionData(OID: String; Value: TBytes);

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

procedure SetExtensionState(OID: String; State: Integer);

Remarks

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

Validate Method (CRLManager Component)

Validates the CRL signature.

Syntax

function Validate(): Integer;

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

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent 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

type TExternalSignEvent = procedure (
  Sender: TObject;
  const OperationId: String;
  const HashAlgorithm: String;
  const Pars: String;
  const Data: String;
  var SignedData: String
) of Object;

property OnExternalSign: TExternalSignEvent 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

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent 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.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

>

constructor Create();

Creates a new object with default field values.

CRL Type

Represents a Certificate Revocation List.

Remarks

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

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

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

Fields

Constructors

>

constructor Create();

Creates an empty CRL object.

CRLEntryInfo Type

Represents a single entry of a Certificate Revocation List (CRL).

Remarks

This object contains revocation information for a particular certificate entry in the CRL.

Fields

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

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.

Fields

Constructors

>

constructor Create();

Creates a new ExternalCrypto object with default field values.

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)