CRLManager Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_CRLManager

Procedural Interface

 secureblackbox_crlmanager_open();
 secureblackbox_crlmanager_close($res);
 secureblackbox_crlmanager_register_callback($res, $id, $function);
 secureblackbox_crlmanager_get_last_error($res);
 secureblackbox_crlmanager_get_last_error_code($res);
 secureblackbox_crlmanager_set($res, $id, $index, $value);
 secureblackbox_crlmanager_get($res, $id, $index);
 secureblackbox_crlmanager_do_add($res, $serialnumber, $revocationdate, $revocationreason);
 secureblackbox_crlmanager_do_clear($res);
 secureblackbox_crlmanager_do_config($res, $configurationstring);
 secureblackbox_crlmanager_do_doaction($res, $actionid, $actionparams);
 secureblackbox_crlmanager_do_download($res, $url);
 secureblackbox_crlmanager_do_getcertentryindex($res, $serialnumber);
 secureblackbox_crlmanager_do_getextensiondata($res, $oid);
 secureblackbox_crlmanager_do_getextensionstate($res, $oid);
 secureblackbox_crlmanager_do_listextensions($res);
 secureblackbox_crlmanager_do_load($res, $bytes);
 secureblackbox_crlmanager_do_loadfromfile($res, $path);
 secureblackbox_crlmanager_do_remove($res, $index);
 secureblackbox_crlmanager_do_save($res);
 secureblackbox_crlmanager_do_savetofile($res, $path);
 secureblackbox_crlmanager_do_selectentry($res, $index);
 secureblackbox_crlmanager_do_setextensiondata($res, $oid, $value);
 secureblackbox_crlmanager_do_setextensionstate($res, $oid, $state);
 secureblackbox_crlmanager_do_validate($res);

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getCACertBytes();

Procedural Interface

secureblackbox_crlmanager_get($res, 1 );

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

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

Object Oriented Interface

public function getCACertHandle();


public function setCACertHandle($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 8 );


secureblackbox_crlmanager_set($res, 8, $value );

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

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getCRLBytes();

Procedural Interface

secureblackbox_crlmanager_get($res, 35 );

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

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

Object Oriented Interface

public function getCRLCAKeyID();


public function setCRLCAKeyID($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 36 );


secureblackbox_crlmanager_set($res, 36, $value );

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

Returns the number of certificate status entries in the CRL.

Object Oriented Interface

public function getCRLEntryCount();

Procedural Interface

secureblackbox_crlmanager_get($res, 37 );

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

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

Object Oriented Interface

public function getCRLHandle();


public function setCRLHandle($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 38 );


secureblackbox_crlmanager_set($res, 38, $value );

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

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

Object Oriented Interface

public function getCRLIssuer();

Procedural Interface

secureblackbox_crlmanager_get($res, 39 );

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

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

Object Oriented Interface

public function getCRLIssuerRDN();

Procedural Interface

secureblackbox_crlmanager_get($res, 40 );

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

The URL that the CRL was downloaded from.

Object Oriented Interface

public function getCRLLocation();

Procedural Interface

secureblackbox_crlmanager_get($res, 41 );

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

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

Object Oriented Interface

public function getCRLNextUpdate();

Procedural Interface

secureblackbox_crlmanager_get($res, 42 );

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

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

Object Oriented Interface

public function getCRLSigAlgorithm();

Procedural Interface

secureblackbox_crlmanager_get($res, 43 );

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

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

Object Oriented Interface

public function getCRLTBS();

Procedural Interface

secureblackbox_crlmanager_get($res, 44 );

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

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

Object Oriented Interface

public function getCRLThisUpdate();

Procedural Interface

secureblackbox_crlmanager_get($res, 45 );

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

The number of items in the CRL.

Object Oriented Interface

public function getEntryCount();

Procedural Interface

secureblackbox_crlmanager_get($res, 46 );

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

This property is read-only.

Data Type

Integer

CRLEntryInfoCertStatus Property (SecureBlackbox_CRLManager Class)

Returns the status of the certificate.

Object Oriented Interface

public function getCRLEntryInfoCertStatus();

Procedural Interface

secureblackbox_crlmanager_get($res, 47 );

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

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

Object Oriented Interface

public function getCRLEntryInfoHandle();

Procedural Interface

secureblackbox_crlmanager_get($res, 48 );

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

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

Object Oriented Interface

public function getCRLEntryInfoRevocationDate();

Procedural Interface

secureblackbox_crlmanager_get($res, 49 );

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

Specifies the reason for certificate revocation.

Object Oriented Interface

public function getCRLEntryInfoRevocationReason();

Procedural Interface

secureblackbox_crlmanager_get($res, 50 );

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

The certificate serial number.

Object Oriented Interface

public function getCRLEntryInfoSerialNumber();

Procedural Interface

secureblackbox_crlmanager_get($res, 51 );

Remarks

The certificate serial number.

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

Data Type

Byte Array

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_CRLManager Class)

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 52 );


secureblackbox_crlmanager_set($res, 52, $value );

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

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 53 );


secureblackbox_crlmanager_set($res, 53, $value );

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

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

Object Oriented Interface

public function getExternalCryptoData();


public function setExternalCryptoData($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 54 );


secureblackbox_crlmanager_set($res, 54, $value );

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

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

Object Oriented Interface

public function getExternalCryptoExternalHashCalculation();


public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 55 );


secureblackbox_crlmanager_set($res, 55, $value );

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

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 56 );


secureblackbox_crlmanager_set($res, 56, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_CRLManager Class)

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

Object Oriented Interface

public function getExternalCryptoKeyID();


public function setExternalCryptoKeyID($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 57 );


secureblackbox_crlmanager_set($res, 57, $value );

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

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 58 );


secureblackbox_crlmanager_set($res, 58, $value );

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

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 59 );


secureblackbox_crlmanager_set($res, 59, $value );

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

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 60 );


secureblackbox_crlmanager_set($res, 60, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_CRLManager Class)

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

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 61 );


secureblackbox_crlmanager_set($res, 61, $value );

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

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_crlmanager_get($res, 62 );


secureblackbox_crlmanager_set($res, 62, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Add Method (SecureBlackbox_CRLManager Class)

Adds a new revoked certificate entry.

Object Oriented Interface

public function doAdd($serialnumber, $revocationdate, $revocationreason);

Procedural Interface

secureblackbox_crlmanager_do_add($res, $serialnumber, $revocationdate, $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 (SecureBlackbox_CRLManager Class)

Empties the CRL.

Object Oriented Interface

public function doClear();

Procedural Interface

secureblackbox_crlmanager_do_clear($res);

Remarks

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

Config Method (SecureBlackbox_CRLManager Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_crlmanager_do_config($res, $configurationstring);

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.

DoAction Method (SecureBlackbox_CRLManager Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_crlmanager_do_doaction($res, $actionid, $actionparams);

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

Download Method (SecureBlackbox_CRLManager Class)

Downloads a CRL from the specified location.

Object Oriented Interface

public function doDownload($url);

Procedural Interface

secureblackbox_crlmanager_do_download($res, $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 (SecureBlackbox_CRLManager Class)

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

Object Oriented Interface

public function doGetCertEntryIndex($serialnumber);

Procedural Interface

secureblackbox_crlmanager_do_getcertentryindex($res, $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 (SecureBlackbox_CRLManager Class)

Returns extension data.

Object Oriented Interface

public function doGetExtensionData($oid);

Procedural Interface

secureblackbox_crlmanager_do_getextensiondata($res, $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 (SecureBlackbox_CRLManager Class)

Returns certificate extension state.

Object Oriented Interface

public function doGetExtensionState($oid);

Procedural Interface

secureblackbox_crlmanager_do_getextensionstate($res, $oid);

Remarks

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

ListExtensions Method (SecureBlackbox_CRLManager Class)

List extensions currently available in the certificate or CRL.

Object Oriented Interface

public function doListExtensions();

Procedural Interface

secureblackbox_crlmanager_do_listextensions($res);

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

Loads a CRL from a byte array.

Object Oriented Interface

public function doLoad($bytes);

Procedural Interface

secureblackbox_crlmanager_do_load($res, $bytes);

Remarks

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

LoadFromFile Method (SecureBlackbox_CRLManager Class)

Loads a CRL from a file.

Object Oriented Interface

public function doLoadFromFile($path);

Procedural Interface

secureblackbox_crlmanager_do_loadfromfile($res, $path);

Remarks

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

Remove Method (SecureBlackbox_CRLManager Class)

Removes the specified entry from the CRL.

Object Oriented Interface

public function doRemove($index);

Procedural Interface

secureblackbox_crlmanager_do_remove($res, $index);

Remarks

Use this method to remove the entry from the CRL.

Save Method (SecureBlackbox_CRLManager Class)

Saves the CRL to a byte array.

Object Oriented Interface

public function doSave();

Procedural Interface

secureblackbox_crlmanager_do_save($res);

Remarks

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

SaveToFile Method (SecureBlackbox_CRLManager Class)

Saves the CRL to a file.

Object Oriented Interface

public function doSaveToFile($path);

Procedural Interface

secureblackbox_crlmanager_do_savetofile($res, $path);

Remarks

Use this method to save the CRL to a file.

SelectEntry Method (SecureBlackbox_CRLManager Class)

Fetches revocation information about the selected certificate from the CRL.

Object Oriented Interface

public function doSelectEntry($index);

Procedural Interface

secureblackbox_crlmanager_do_selectentry($res, $index);

Remarks

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

SetExtensionData Method (SecureBlackbox_CRLManager Class)

Sets extension data.

Object Oriented Interface

public function doSetExtensionData($oid, $value);

Procedural Interface

secureblackbox_crlmanager_do_setextensiondata($res, $oid, $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 (SecureBlackbox_CRLManager Class)

Sets certificate extension state.

Object Oriented Interface

public function doSetExtensionState($oid, $state);

Procedural Interface

secureblackbox_crlmanager_do_setextensionstate($res, $oid, $state);

Remarks

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

Validate Method (SecureBlackbox_CRLManager Class)

Validates the CRL signature.

Object Oriented Interface

public function doValidate();

Procedural Interface

secureblackbox_crlmanager_do_validate($res);

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

Information about errors during CRL management.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_crlmanager_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

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

Object Oriented Interface

public function fireExternalSign($param);

Procedural Interface

secureblackbox_crlmanager_register_callback($res, 2, array($this, 'fireExternalSign'));

Parameter List

 'operationid'
 'hashalgorithm'
 'pars'
 'data'
 'signeddata'

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: 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 (SecureBlackbox_CRLManager Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_crlmanager_register_callback($res, 3, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

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.

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

Base Config Settings

Trappable Errors (CRLManager Class)

CRLManager Errors

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