CRLManager Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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

Method List

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

Event List

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

Config Settings

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

CACertificate Property (CRLManager Module)

The CA certificate that issues this CRL.

Syntax

• Swift
• Objective-C

public var caCertificate: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=CACertBytes) NSData* CACertBytes;

- (NSData*)CACertBytes;

@property (nonatomic,readwrite,assign,getter=CACertHandle,setter=setCACertHandle:) long long CACertHandle;

- (long long)CACertHandle;
- (void)setCACertHandle :(long long)newCACertHandle;

 

Default Value

False

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.

CRL Property (CRLManager Module)

Provides access to general properties of the CRL.

Syntax

• Swift
• Objective-C

public var crl: CRL {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=CRLBytes) NSData* CRLBytes;

- (NSData*)CRLBytes;

@property (nonatomic,readwrite,assign,getter=CRLCAKeyID,setter=setCRLCAKeyID:) NSData* CRLCAKeyID;

- (NSData*)CRLCAKeyID;
- (void)setCRLCAKeyID :(NSData*)newCRLCAKeyID;

@property (nonatomic,readonly,assign,getter=CRLEntryCount) int CRLEntryCount;

- (int)CRLEntryCount;

@property (nonatomic,readwrite,assign,getter=CRLHandle,setter=setCRLHandle:) long long CRLHandle;

- (long long)CRLHandle;
- (void)setCRLHandle :(long long)newCRLHandle;

@property (nonatomic,readonly,assign,getter=CRLIssuer) NSString* CRLIssuer;

- (NSString*)CRLIssuer;

@property (nonatomic,readonly,assign,getter=CRLIssuerRDN) NSString* CRLIssuerRDN;

- (NSString*)CRLIssuerRDN;

@property (nonatomic,readonly,assign,getter=CRLLocation) NSString* CRLLocation;

- (NSString*)CRLLocation;

@property (nonatomic,readonly,assign,getter=CRLNextUpdate) NSString* CRLNextUpdate;

- (NSString*)CRLNextUpdate;

@property (nonatomic,readonly,assign,getter=CRLSigAlgorithm) NSString* CRLSigAlgorithm;

- (NSString*)CRLSigAlgorithm;

@property (nonatomic,readonly,assign,getter=CRLTBS) NSData* CRLTBS;

- (NSData*)CRLTBS;

@property (nonatomic,readonly,assign,getter=CRLThisUpdate) NSString* CRLThisUpdate;

- (NSString*)CRLThisUpdate;

 

Default Value

False

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.

EntryCount Property (CRLManager Module)

The number of items in the CRL.

Syntax

• Swift
• Objective-C

public var entryCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=entryCount) int entryCount;

- (int)entryCount;

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

This property is read-only.

EntryInfo Property (CRLManager Module)

Revocation details of the selected certificate status entry.

Syntax

• Swift
• Objective-C

public var entryInfo: CRLEntryInfo {
  get {...}
}

@property (nonatomic,readonly,assign,getter=CRLEntryInfoCertStatus) int CRLEntryInfoCertStatus;

- (int)CRLEntryInfoCertStatus;

@property (nonatomic,readonly,assign,getter=CRLEntryInfoHandle) long long CRLEntryInfoHandle;

- (long long)CRLEntryInfoHandle;

@property (nonatomic,readonly,assign,getter=CRLEntryInfoRevocationDate) NSString* CRLEntryInfoRevocationDate;

- (NSString*)CRLEntryInfoRevocationDate;

@property (nonatomic,readonly,assign,getter=CRLEntryInfoRevocationReason) int CRLEntryInfoRevocationReason;

- (int)CRLEntryInfoRevocationReason;

@property (nonatomic,readonly,assign,getter=CRLEntryInfoSerialNumber) NSData* CRLEntryInfoSerialNumber;

- (NSData*)CRLEntryInfoSerialNumber;

 

Default Value

False

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.

ExternalCrypto Property (CRLManager Module)

Provides access to external signing and DC parameters.

Syntax

• Swift
• Objective-C

public var externalCrypto: ExternalCrypto {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=externalCryptoAsyncDocumentID,setter=setExternalCryptoAsyncDocumentID:) NSString* externalCryptoAsyncDocumentID;

- (NSString*)externalCryptoAsyncDocumentID;
- (void)setExternalCryptoAsyncDocumentID :(NSString*)newExternalCryptoAsyncDocumentID;

@property (nonatomic,readwrite,assign,getter=externalCryptoCustomParams,setter=setExternalCryptoCustomParams:) NSString* externalCryptoCustomParams;

- (NSString*)externalCryptoCustomParams;
- (void)setExternalCryptoCustomParams :(NSString*)newExternalCryptoCustomParams;

@property (nonatomic,readwrite,assign,getter=externalCryptoData,setter=setExternalCryptoData:) NSString* externalCryptoData;

- (NSString*)externalCryptoData;
- (void)setExternalCryptoData :(NSString*)newExternalCryptoData;

@property (nonatomic,readwrite,assign,getter=externalCryptoExternalHashCalculation,setter=setExternalCryptoExternalHashCalculation:) BOOL externalCryptoExternalHashCalculation;

- (BOOL)externalCryptoExternalHashCalculation;
- (void)setExternalCryptoExternalHashCalculation :(BOOL)newExternalCryptoExternalHashCalculation;

@property (nonatomic,readwrite,assign,getter=externalCryptoHashAlgorithm,setter=setExternalCryptoHashAlgorithm:) NSString* externalCryptoHashAlgorithm;

- (NSString*)externalCryptoHashAlgorithm;
- (void)setExternalCryptoHashAlgorithm :(NSString*)newExternalCryptoHashAlgorithm;

@property (nonatomic,readwrite,assign,getter=externalCryptoKeyID,setter=setExternalCryptoKeyID:) NSString* externalCryptoKeyID;

- (NSString*)externalCryptoKeyID;
- (void)setExternalCryptoKeyID :(NSString*)newExternalCryptoKeyID;

@property (nonatomic,readwrite,assign,getter=externalCryptoKeySecret,setter=setExternalCryptoKeySecret:) NSString* externalCryptoKeySecret;

- (NSString*)externalCryptoKeySecret;
- (void)setExternalCryptoKeySecret :(NSString*)newExternalCryptoKeySecret;

@property (nonatomic,readwrite,assign,getter=externalCryptoMethod,setter=setExternalCryptoMethod:) int externalCryptoMethod;

- (int)externalCryptoMethod;
- (void)setExternalCryptoMethod :(int)newExternalCryptoMethod;

@property (nonatomic,readwrite,assign,getter=externalCryptoMode,setter=setExternalCryptoMode:) int externalCryptoMode;

- (int)externalCryptoMode;
- (void)setExternalCryptoMode :(int)newExternalCryptoMode;

@property (nonatomic,readwrite,assign,getter=externalCryptoPublicKeyAlgorithm,setter=setExternalCryptoPublicKeyAlgorithm:) NSString* externalCryptoPublicKeyAlgorithm;

- (NSString*)externalCryptoPublicKeyAlgorithm;
- (void)setExternalCryptoPublicKeyAlgorithm :(NSString*)newExternalCryptoPublicKeyAlgorithm;

 

Default Value

False

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

FIPSMode Property (CRLManager Module)

Reserved.

Syntax

• Swift
• Objective-C

public var fipsMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

Add Method (CRLManager Module)

Adds a new revoked certificate entry.

Syntax

• Swift
• Objective-C

public func add(serialNumber: Data, revocationDate: String, revocationReason: Int32) throws -> Int32

- (int)add:(NSData*)serialNumber :(NSString*)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 Module)

Empties the CRL.

Syntax

• Swift
• Objective-C

public func clear() throws -> Void

- (void)clear;

Remarks

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

Config Method (CRLManager Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 (CRLManager Module)

Performs an additional action.

Syntax

• Swift
• Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)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 (CRLManager Module)

Downloads a CRL from the specified location.

Syntax

• Swift
• Objective-C

public func download(url: String) throws -> Void

- (void)download:(NSString*)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 Module)

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

Syntax

• Swift
• Objective-C

public func getCertEntryIndex(serialNumber: Data) throws -> Int32

- (int)getCertEntryIndex:(NSData*)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 Module)

Returns extension data.

Syntax

• Swift
• Objective-C

public func getExtensionData(oid: String) throws -> Data

- (NSData*)getExtensionData:(NSString*)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 Module)

Returns certificate extension state.

Syntax

• Swift
• Objective-C

public func getExtensionState(oid: String) throws -> Int32

- (int)getExtensionState:(NSString*)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 Module)

List extensions currently available in the certificate or CRL.

Syntax

• Swift
• Objective-C

public func listExtensions() throws -> String

- (NSString*)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 Module)

Loads a CRL from a byte array.

Syntax

• Swift
• Objective-C

public func load(bytes: Data) throws -> Void

- (void)load:(NSData*)bytes;

Remarks

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

LoadFromFile Method (CRLManager Module)

Loads a CRL from a file.

Syntax

• Swift
• Objective-C

public func loadFromFile(path: String) throws -> Void

- (void)loadFromFile:(NSString*)path;

Remarks

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

Remove Method (CRLManager Module)

Removes the specified entry from the CRL.

Syntax

• Swift
• Objective-C

public func remove(index: Int32) throws -> Void

- (void)remove:(int)index;

Remarks

Use this method to remove the entry from the CRL.

Save Method (CRLManager Module)

Saves the CRL to a byte array.

Syntax

• Swift
• Objective-C

public func save() throws -> Data

- (NSData*)save;

Remarks

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

SaveToFile Method (CRLManager Module)

Saves the CRL to a file.

Syntax

• Swift
• Objective-C

public func saveToFile(path: String) throws -> Void

- (void)saveToFile:(NSString*)path;

Remarks

Use this method to save the CRL to a file.

SelectEntry Method (CRLManager Module)

Fetches revocation information about the selected certificate from the CRL.

Syntax

• Swift
• Objective-C

public func selectEntry(index: Int32) throws -> Void

- (void)selectEntry:(int)index;

Remarks

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

SetExtensionData Method (CRLManager Module)

Sets extension data.

Syntax

• Swift
• Objective-C

public func setExtensionData(oid: String, value: Data) throws -> Void

- (void)setExtensionData:(NSString*)OID :(NSData*)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 Module)

Sets certificate extension state.

Syntax

• Swift
• Objective-C

public func setExtensionState(oid: String, state: Int32) throws -> Void

- (void)setExtensionState:(NSString*)OID :(int)state;

Remarks

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

Validate Method (CRLManager Module)

Validates the CRL signature.

Syntax

• Swift
• Objective-C

public func validate() throws -> Int32

- (int)validate;

Remarks

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

Error Event (CRLManager Module)

Information about errors during CRL management.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)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 (CRLManager Module)

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

Syntax

• Swift
• Objective-C

func onExternalSign(operationId: String, hashAlgorithm: String, pars: String, data: String, signedData: inout String)

- (void)onExternalSign:(NSString*)operationId :(NSString*)hashAlgorithm :(NSString*)pars :(NSString*)data :(NSString**)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 (CRLManager Module)

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

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)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.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

public init(stream: )

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public init()

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

public init()

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

public init()

Creates a new ExternalCrypto object with default field values.

Config Settings (CRLManager Module)

Base Config Settings

Trappable Errors (CRLManager Module)

CRLManager Errors