CRLManager Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class secureblackbox.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.

ca_cert_bytes Property

Returns raw certificate data in DER format.

Syntax

def get_ca_cert_bytes() -> bytes: ...

ca_cert_bytes = property(get_ca_cert_bytes, None)

Remarks

Returns raw certificate data in DER format.

This property is read-only.

ca_cert_handle Property

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

Syntax

def get_ca_cert_handle() -> int: ...
def set_ca_cert_handle(value: int) -> None: ...

ca_cert_handle = property(get_ca_cert_handle, set_ca_cert_handle)

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());

crl_bytes Property

Returns raw CRL data in DER format.

Syntax

def get_crl_bytes() -> bytes: ...

crl_bytes = property(get_crl_bytes, None)

Remarks

Returns raw CRL data in DER format.

This property is read-only.

crlca_key_id Property

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

Syntax

def get_crlca_key_id() -> bytes: ...
def set_crlca_key_id(value: bytes) -> None: ...

crlca_key_id = property(get_crlca_key_id, set_crlca_key_id)

Remarks

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

crl_entry_count Property

Returns the number of certificate status entries in the CRL.

Syntax

def get_crl_entry_count() -> int: ...

crl_entry_count = property(get_crl_entry_count, None)

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

This property is read-only.

crl_handle Property

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

Syntax

def get_crl_handle() -> int: ...
def set_crl_handle(value: int) -> None: ...

crl_handle = property(get_crl_handle, set_crl_handle)

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());

crl_issuer Property

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

Syntax

def get_crl_issuer() -> str: ...

crl_issuer = property(get_crl_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

crl_issuer_rdn Property

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

Syntax

def get_crl_issuer_rdn() -> str: ...

crl_issuer_rdn = property(get_crl_issuer_rdn, None)

Default Value

""

Remarks

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

This property is read-only.

crl_location Property

The URL that the CRL was downloaded from.

Syntax

def get_crl_location() -> str: ...

crl_location = property(get_crl_location, None)

Default Value

""

Remarks

The URL that the CRL was downloaded from.

This property is read-only.

crl_next_update Property

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

Syntax

def get_crl_next_update() -> str: ...

crl_next_update = property(get_crl_next_update, None)

Default Value

""

Remarks

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

This property is read-only.

crl_sig_algorithm Property

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

Syntax

def get_crl_sig_algorithm() -> str: ...

crl_sig_algorithm = property(get_crl_sig_algorithm, None)

Default Value

"0"

Remarks

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

This property is read-only.

crltbs Property

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

Syntax

def get_crltbs() -> bytes: ...

crltbs = property(get_crltbs, None)

Remarks

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

This property is read-only.

crl_this_update Property

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

Syntax

def get_crl_this_update() -> str: ...

crl_this_update = property(get_crl_this_update, None)

Default Value

""

Remarks

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

This property is read-only.

entry_count Property

The number of items in the CRL.

Syntax

def get_entry_count() -> int: ...

entry_count = property(get_entry_count, None)

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

This property is read-only.

crl_entry_info_cert_status Property

Returns the status of the certificate.

Syntax

def get_crl_entry_info_cert_status() -> int: ...

crl_entry_info_cert_status = property(get_crl_entry_info_cert_status, None)

Default Value

0

Remarks

Returns the status of the certificate.

This property is read-only.

crl_entry_info_handle Property

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

Syntax

def get_crl_entry_info_handle() -> int: ...

crl_entry_info_handle = property(get_crl_entry_info_handle, None)

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.

crl_entry_info_revocation_date Property

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

Syntax

def get_crl_entry_info_revocation_date() -> str: ...

crl_entry_info_revocation_date = property(get_crl_entry_info_revocation_date, None)

Default Value

""

Remarks

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

This property is read-only.

crl_entry_info_revocation_reason Property

Specifies the reason for certificate revocation.

Syntax

def get_crl_entry_info_revocation_reason() -> int: ...

crl_entry_info_revocation_reason = property(get_crl_entry_info_revocation_reason, None)

Default Value

0

Remarks

Specifies the reason for certificate revocation.

This property is read-only.

crl_entry_info_serial_number Property

The certificate serial number.

Syntax

def get_crl_entry_info_serial_number() -> bytes: ...

crl_entry_info_serial_number = property(get_crl_entry_info_serial_number, None)

Remarks

The certificate serial number.

This property is read-only.

external_crypto_async_document_id Property

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

Syntax

def get_external_crypto_async_document_id() -> str: ...
def set_external_crypto_async_document_id(value: str) -> None: ...

external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id)

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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

external_crypto_custom_params Property

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

Syntax

def get_external_crypto_custom_params() -> str: ...
def set_external_crypto_custom_params(value: str) -> None: ...

external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params)

Default Value

""

Remarks

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

external_crypto_data Property

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

Syntax

def get_external_crypto_data() -> str: ...
def set_external_crypto_data(value: str) -> None: ...

external_crypto_data = property(get_external_crypto_data, set_external_crypto_data)

Default Value

""

Remarks

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

external_crypto_external_hash_calculation Property

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

Syntax

def get_external_crypto_external_hash_calculation() -> bool: ...
def set_external_crypto_external_hash_calculation(value: bool) -> None: ...

external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation)

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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

external_crypto_hash_algorithm Property

Specifies the request's signature hash algorithm.

Syntax

def get_external_crypto_hash_algorithm() -> str: ...
def set_external_crypto_hash_algorithm(value: str) -> None: ...

external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm)

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

external_crypto_key_id Property

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

Syntax

def get_external_crypto_key_id() -> str: ...
def set_external_crypto_key_id(value: str) -> None: ...

external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id)

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 extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use external_crypto_key_secret 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";

external_crypto_key_secret Property

The pre-shared key used for DC request authentication.

Syntax

def get_external_crypto_key_secret() -> str: ...
def set_external_crypto_key_secret(value: str) -> None: ...

external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret)

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

external_crypto_method Property

Specifies the asynchronous signing method.

Syntax

def get_external_crypto_method() -> int: ...
def set_external_crypto_method(value: int) -> None: ...

external_crypto_method = property(get_external_crypto_method, set_external_crypto_method)

Default Value

0

Remarks

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

Available options:

external_crypto_mode Property

Specifies the external cryptography mode.

Syntax

def get_external_crypto_mode() -> int: ...
def set_external_crypto_mode(value: int) -> None: ...

external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode)

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

external_crypto_public_key_algorithm Property

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

Syntax

def get_external_crypto_public_key_algorithm() -> str: ...
def set_external_crypto_public_key_algorithm(value: str) -> None: ...

external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm)

Default Value

""

Remarks

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

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

add Method

Adds a new revoked certificate entry.

Syntax

def add(serial_number: bytes, revocation_date: str, revocation_reason: int) -> int: ...

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

Empties the CRL.

Syntax

def clear() -> None: ...

Remarks

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

do_action 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 insencitive) 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

Downloads a CRL from the specified location.

Syntax

def download(url: str) -> None: ...

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.

get_cert_entry_index Method

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

Syntax

def get_cert_entry_index(serial_number: bytes) -> int: ...

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.

get_extension_data Method

Returns extension data.

Syntax

def get_extension_data(oid: str) -> bytes: ...

Remarks

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

get_extension_state Method

Returns certificate extension state.

Syntax

def get_extension_state(oid: str) -> int: ...

Remarks

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

list_extensions Method

List extensions currently available in the certificate or CRL.

Syntax

def list_extensions() -> str: ...

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

Loads a CRL from a byte array.

Syntax

def load(bytes: bytes) -> None: ...

Remarks

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

load_from_file Method

Loads a CRL from a file.

Syntax

def load_from_file(path: str) -> None: ...

Remarks

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

remove Method

Removes the specified entry from the CRL.

Syntax

def remove(index: int) -> None: ...

Remarks

Use this method to remove the entry from the CRL.

save Method

Saves the CRL to a byte array.

Syntax

def save() -> bytes: ...

Remarks

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

save_to_file Method

Saves the CRL to a file.

Syntax

def save_to_file(path: str) -> None: ...

Remarks

Use this method to save the CRL to a file.

select_entry Method

Fetches revocation information about the selected certificate from the CRL.

Syntax

def select_entry(index: int) -> None: ...

Remarks

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

set_extension_data Method

Sets extension data.

Syntax

def set_extension_data(oid: str, value: bytes) -> None: ...

Remarks

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

set_extension_state Method

Sets certificate extension state.

Syntax

def set_extension_state(oid: str, state: int) -> None: ...

Remarks

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

validate Method

Validates the CRL signature.

Syntax

def validate() -> int: ...

Remarks

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

on_error Event

Information about errors during CRL management.

Syntax

class CRLManagerErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class CRLManager:
@property
def on_error() -> Callable[[CRLManagerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[CRLManagerErrorEventParams], None]) -> None: ...

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.

on_external_sign Event

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

Syntax

class CRLManagerExternalSignEventParams(object):
  @property
  def operation_id() -> str: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def pars() -> str: ...

  @property
  def data() -> str: ...

  @property
  def signed_data() -> str: ...
  @signed_data.setter
  def signed_data(value) -> None: ...

# In class CRLManager:
@property
def on_external_sign() -> Callable[[CRLManagerExternalSignEventParams], None]: ...
@on_external_sign.setter
def on_external_sign(event_hook: Callable[[CRLManagerExternalSignEventParams], None]) -> None: ...

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 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 contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for 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 a .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(); };

on_notification Event

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

Syntax

class CRLManagerNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class CRLManager:
@property
def on_notification() -> Callable[[CRLManagerNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[CRLManagerNotificationEventParams], None]) -> None: ...

Remarks

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

CRLManager Config Settings

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

CRLManager Errors

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)