CertificateManager Module
Properties Methods Events Config Settings Errors
The CertificateManager module supports importing, exporting, and generating X.509 certificates.
Syntax
SecureBlackbox.Certificatemanager
Remarks
Usage of this class includes importing and exporting certificates and keys in various formats, as well as certificate generation.
Loading certificates
In vast majority of SecureBlackbox-powered projects, this component is used to import certificates from files or memory objects for further use in other components, like PDFSigner.To load a certificate from a file, use the ImportFromFile method. This method supports all existing certificate formats, including PFX, PEM, DER, and P7B. Note that keys contained in PFX and PEM certificates are often encrypted with a password, so you will likely need to provide one for the certificate to be loaded correctly. You can either provide the password via the method's parameter, or provide it on-demand by subscribing to the PasswordNeeded event.
Alternatively, you can use ImportCert to load a certificate from a different type of media, such as a database.
If your certificate and its private key are stored in separate files or buffers - which is often the case where PEM or DER format is used - please load the certificate with the ImportFromFile method first, and then add the key to it with a separate call to the ImportKeyFromFile method. You can mix and match the certificate and key formats in this case; CertificateManager will handle this automatically.
Note that CertificateManager can only keep one certificate at a time. If your PFX or PEM file contains more than one certificate, use CertificateStorage component to load it instead.
Generating certificates
You can use CertificateManager to generate your own certificates. To generate a certificate, please follow the below steps:- set all the needed certificate properties - for example, its subject, serial number, and validity period - via the Certificate property.
- load the CA certificate to a different CertificateManager object, and assign it
to the CACertificate property. Note that the CA certificate should have an associated private key. Alternatively,
the CA certificate can be loaded using a CertificateStorage object, which allows to import it from a hardware device
or a system store.
Note: you do not need to load and set the CA certificate if generating a self-signed certificate.
- Call Generate to generate a new keypair and wrap it into a certificate.
- Save the certificate using ExportToFile or ExportCert methods.
Note: take care to choose a format that supports storing private keys. If you do not save the new private key at this stage, you won't be able to recover it later.
Note: you can save the private key separately using the ExportKey method.
Generating certificate requests
Apart from certificates, CertificateManager can generate certificate requests (PKCS10). The procedure is the same as when generating certificates. The only difference is that you need to use CertificateRequest object to set up the certificate request parameters, and GenerateCSR method to generate the request. You can then save the resulting request to a file using the ExportCSR method.Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
| CACertificate | A container for the CA certificate. |
| Certificate | A container for the certificate object. |
| CertificateRequest | A container for the certificate request object. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| FIPSMode | Reserved. |
Method List
The following is the full list of the methods of the module with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| Download | Downloads a certificate from a remote location. |
| ExportCert | Exports the certificate in the chosen format. |
| ExportCSR | Exports a Certificate Signing Request (CSR). |
| ExportKey | Exports the certificate's private key. |
| ExportKeyToFile | Exports the private key to a file in the chosen format. |
| ExportToFile | Exports the certificate to a file. |
| Generate | Generates a new certificate. |
| GenerateAsyncBegin | Initiates asynchronous (DC) certificate generation. |
| GenerateAsyncEnd | Completes asynchronous certificate generation. |
| GenerateCSR | Creates a new certificate signing request (CSR). |
| GenerateExternal | Generates a new certificate or request with an external signing device. |
| GetExtensionData | Returns extension data. |
| GetExtensionState | Returns certificate extension state. |
| GetSampleCert | Generates a sample certificate for the specified purpose. |
| ImportCert | Imports a certificate. |
| ImportFromFile | Loads a certificate from a file. |
| ImportFromObject | Imports a certificate from a platform object. |
| ImportKey | Imports a private key. |
| ImportKeyFromFile | Imports a private key from a file. |
| ListExtensions | List extensions currently available in the certificate or CRL. |
| SetExtensionData | Sets extension data. |
| SetExtensionState | Sets certificate extension state. |
| Update | Renews the certificate. |
| Validate | Validates the certificate. |
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.
| Error | Information about errors during certificate loading, saving or validation. |
| ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
| Notification | This event notifies the application about an underlying control flow event. |
| PasswordNeeded | This event is fired when a decryption password is needed. |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
| KeyExchangePIN | The KeyExchange PIN to provide to the key in runtime. |
| SignaturePIN | The Signature PIN to provide to the key in runtime. |
| TempPath | Path for storing temporary files. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the module (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseOwnDNSResolver | Specifies whether the client modules should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
CACertificate Property (CertificateManager Module)
A container for the CA certificate.
Syntax
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
This property is reserved for future use.
Certificate Property (CertificateManager Module)
A container for the certificate object.
Syntax
public var certificate: Certificate { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=certBytes) NSData* certBytes; - (NSData*)certBytes; @property (nonatomic,readwrite,assign,getter=certCA,setter=setCertCA:) BOOL certCA; - (BOOL)certCA; - (void)setCertCA :(BOOL)newCertCA; @property (nonatomic,readonly,assign,getter=certCAKeyID) NSData* certCAKeyID; - (NSData*)certCAKeyID; @property (nonatomic,readwrite,assign,getter=certCRLDistributionPoints,setter=setCertCRLDistributionPoints:) NSString* certCRLDistributionPoints; - (NSString*)certCRLDistributionPoints; - (void)setCertCRLDistributionPoints :(NSString*)newCertCRLDistributionPoints; @property (nonatomic,readwrite,assign,getter=certCurve,setter=setCertCurve:) NSString* certCurve; - (NSString*)certCurve; - (void)setCertCurve :(NSString*)newCertCurve; @property (nonatomic,readonly,assign,getter=certFingerprint) NSData* certFingerprint; - (NSData*)certFingerprint; @property (nonatomic,readonly,assign,getter=certFriendlyName) NSString* certFriendlyName; - (NSString*)certFriendlyName; @property (nonatomic,readwrite,assign,getter=certHandle,setter=setCertHandle:) long long certHandle; - (long long)certHandle; - (void)setCertHandle :(long long)newCertHandle; @property (nonatomic,readwrite,assign,getter=certHashAlgorithm,setter=setCertHashAlgorithm:) NSString* certHashAlgorithm; - (NSString*)certHashAlgorithm; - (void)setCertHashAlgorithm :(NSString*)newCertHashAlgorithm; @property (nonatomic,readonly,assign,getter=certIssuer) NSString* certIssuer; - (NSString*)certIssuer; @property (nonatomic,readwrite,assign,getter=certIssuerRDN,setter=setCertIssuerRDN:) NSString* certIssuerRDN; - (NSString*)certIssuerRDN; - (void)setCertIssuerRDN :(NSString*)newCertIssuerRDN; @property (nonatomic,readwrite,assign,getter=certKeyAlgorithm,setter=setCertKeyAlgorithm:) NSString* certKeyAlgorithm; - (NSString*)certKeyAlgorithm; - (void)setCertKeyAlgorithm :(NSString*)newCertKeyAlgorithm; @property (nonatomic,readonly,assign,getter=certKeyBits) int certKeyBits; - (int)certKeyBits; @property (nonatomic,readonly,assign,getter=certKeyFingerprint) NSData* certKeyFingerprint; - (NSData*)certKeyFingerprint; @property (nonatomic,readwrite,assign,getter=certKeyUsage,setter=setCertKeyUsage:) int certKeyUsage; - (int)certKeyUsage; - (void)setCertKeyUsage :(int)newCertKeyUsage; @property (nonatomic,readonly,assign,getter=certKeyValid) BOOL certKeyValid; - (BOOL)certKeyValid; @property (nonatomic,readwrite,assign,getter=certOCSPLocations,setter=setCertOCSPLocations:) NSString* certOCSPLocations; - (NSString*)certOCSPLocations; - (void)setCertOCSPLocations :(NSString*)newCertOCSPLocations; @property (nonatomic,readwrite,assign,getter=certOCSPNoCheck,setter=setCertOCSPNoCheck:) BOOL certOCSPNoCheck; - (BOOL)certOCSPNoCheck; - (void)setCertOCSPNoCheck :(BOOL)newCertOCSPNoCheck; @property (nonatomic,readonly,assign,getter=certOrigin) int certOrigin; - (int)certOrigin; @property (nonatomic,readwrite,assign,getter=certPolicyIDs,setter=setCertPolicyIDs:) NSString* certPolicyIDs; - (NSString*)certPolicyIDs; - (void)setCertPolicyIDs :(NSString*)newCertPolicyIDs; @property (nonatomic,readonly,assign,getter=certPrivateKeyBytes) NSData* certPrivateKeyBytes; - (NSData*)certPrivateKeyBytes; @property (nonatomic,readonly,assign,getter=certPrivateKeyExists) BOOL certPrivateKeyExists; - (BOOL)certPrivateKeyExists; @property (nonatomic,readonly,assign,getter=certPrivateKeyExtractable) BOOL certPrivateKeyExtractable; - (BOOL)certPrivateKeyExtractable; @property (nonatomic,readonly,assign,getter=certPublicKeyBytes) NSData* certPublicKeyBytes; - (NSData*)certPublicKeyBytes; @property (nonatomic,readwrite,assign,getter=certQualifiedStatements,setter=setCertQualifiedStatements:) int certQualifiedStatements; - (int)certQualifiedStatements; - (void)setCertQualifiedStatements :(int)newCertQualifiedStatements; @property (nonatomic,readonly,assign,getter=certSelfSigned) BOOL certSelfSigned; - (BOOL)certSelfSigned; @property (nonatomic,readwrite,assign,getter=certSerialNumber,setter=setCertSerialNumber:) NSData* certSerialNumber; - (NSData*)certSerialNumber; - (void)setCertSerialNumber :(NSData*)newCertSerialNumber; @property (nonatomic,readonly,assign,getter=certSigAlgorithm) NSString* certSigAlgorithm; - (NSString*)certSigAlgorithm; @property (nonatomic,readonly,assign,getter=certSubject) NSString* certSubject; - (NSString*)certSubject; @property (nonatomic,readwrite,assign,getter=certSubjectAlternativeName,setter=setCertSubjectAlternativeName:) NSString* certSubjectAlternativeName; - (NSString*)certSubjectAlternativeName; - (void)setCertSubjectAlternativeName :(NSString*)newCertSubjectAlternativeName; @property (nonatomic,readwrite,assign,getter=certSubjectKeyID,setter=setCertSubjectKeyID:) NSData* certSubjectKeyID; - (NSData*)certSubjectKeyID; - (void)setCertSubjectKeyID :(NSData*)newCertSubjectKeyID; @property (nonatomic,readwrite,assign,getter=certSubjectRDN,setter=setCertSubjectRDN:) NSString* certSubjectRDN; - (NSString*)certSubjectRDN; - (void)setCertSubjectRDN :(NSString*)newCertSubjectRDN; @property (nonatomic,readwrite,assign,getter=certValidFrom,setter=setCertValidFrom:) NSString* certValidFrom; - (NSString*)certValidFrom; - (void)setCertValidFrom :(NSString*)newCertValidFrom; @property (nonatomic,readwrite,assign,getter=certValidTo,setter=setCertValidTo:) NSString* certValidTo; - (NSString*)certValidTo; - (void)setCertValidTo :(NSString*)newCertValidTo;
Default Value
False
Remarks
This property is reserved for future use.
CertificateRequest Property (CertificateManager Module)
A container for the certificate request object.
Syntax
public var certificateRequest: CertificateRequest { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=certRequestBytes) NSData* certRequestBytes; - (NSData*)certRequestBytes; @property (nonatomic,readwrite,assign,getter=certRequestCurve,setter=setCertRequestCurve:) NSString* certRequestCurve; - (NSString*)certRequestCurve; - (void)setCertRequestCurve :(NSString*)newCertRequestCurve; @property (nonatomic,readwrite,assign,getter=certRequestHandle,setter=setCertRequestHandle:) long long certRequestHandle; - (long long)certRequestHandle; - (void)setCertRequestHandle :(long long)newCertRequestHandle; @property (nonatomic,readwrite,assign,getter=certRequestHashAlgorithm,setter=setCertRequestHashAlgorithm:) NSString* certRequestHashAlgorithm; - (NSString*)certRequestHashAlgorithm; - (void)setCertRequestHashAlgorithm :(NSString*)newCertRequestHashAlgorithm; @property (nonatomic,readwrite,assign,getter=certRequestKeyAlgorithm,setter=setCertRequestKeyAlgorithm:) NSString* certRequestKeyAlgorithm; - (NSString*)certRequestKeyAlgorithm; - (void)setCertRequestKeyAlgorithm :(NSString*)newCertRequestKeyAlgorithm; @property (nonatomic,readonly,assign,getter=certRequestKeyBits) int certRequestKeyBits; - (int)certRequestKeyBits; @property (nonatomic,readwrite,assign,getter=certRequestKeyUsage,setter=setCertRequestKeyUsage:) int certRequestKeyUsage; - (int)certRequestKeyUsage; - (void)setCertRequestKeyUsage :(int)newCertRequestKeyUsage; @property (nonatomic,readonly,assign,getter=certRequestKeyValid) BOOL certRequestKeyValid; - (BOOL)certRequestKeyValid; @property (nonatomic,readonly,assign,getter=certRequestPrivateKeyBytes) NSData* certRequestPrivateKeyBytes; - (NSData*)certRequestPrivateKeyBytes; @property (nonatomic,readonly,assign,getter=certRequestPublicKeyBytes) NSData* certRequestPublicKeyBytes; - (NSData*)certRequestPublicKeyBytes; @property (nonatomic,readonly,assign,getter=certRequestSigAlgorithm) NSString* certRequestSigAlgorithm; - (NSString*)certRequestSigAlgorithm; @property (nonatomic,readonly,assign,getter=certRequestSubject) NSString* certRequestSubject; - (NSString*)certRequestSubject; @property (nonatomic,readwrite,assign,getter=certRequestSubjectRDN,setter=setCertRequestSubjectRDN:) NSString* certRequestSubjectRDN; - (NSString*)certRequestSubjectRDN; - (void)setCertRequestSubjectRDN :(NSString*)newCertRequestSubjectRDN; @property (nonatomic,readonly,assign,getter=certRequestValid) BOOL certRequestValid; - (BOOL)certRequestValid;
Default Value
False
Remarks
This property is reserved for future use.
ExternalCrypto Property (CertificateManager Module)
Provides access to external signing and DC parameters.
Syntax
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
This property is reserved for future use.
FIPSMode Property (CertificateManager Module)
Reserved.
Syntax
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.
Config Method (CertificateManager Module)
Sets or retrieves a configuration setting.
Syntax
- (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 (CertificateManager Module)
Performs an additional action.
Syntax
- (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 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 (CertificateManager Module)
Downloads a certificate from a remote location.
Syntax
Remarks
URL specifies the remote location where the certificate should be downloaded from.
ExportCert Method (CertificateManager Module)
Exports the certificate in the chosen format.
Syntax
- (NSData*)exportCert:(NSString*)password :(int)format :(BOOL)exportKey;
Remarks
Use this method to save the certificate in one of the formats defined below.
ExportKey specifies whether to export the private key together with the certificate. Pass the encryption password via the Password parameter if needed.
| cfmUnknown | 0 | Unknown certificate format |
| cfmDER | 1 | DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported |
| cfmPEM | 2 | PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys. |
| cfmPFX | 3 | PFX/PKCS#12 file format. Applicable to certificates. Encryption supported. |
| cfmSPC | 4 | SPC file format. Applicable to certificates. Encryption not supported. |
| cfmPVK | 5 | PVK file format. Applicable to private keys. Encryption not supported. |
| cfmPKCS8 | 6 | PKCS#8 file format. Applicable to private keys. Encryption supported. |
| cfmNET | 7 | NET file format. Applicable to private keys. Encryption not supported. |
Note that not all formats support encryption, and some (like PEM) only support partial encryption (key only). Keep this in mind when considering which format to choose for storing your certificates.
ExportCSR Method (CertificateManager Module)
Exports a Certificate Signing Request (CSR).
Syntax
Remarks
Use this method to save a certification request according to PKCS#10 specification.
Supported certificate request format values:
| cfmUnknown | 0 | Unknown certificate format |
| cfmDER | 1 | DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported |
| cfmPEM | 2 | PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys. |
| cfmPFX | 3 | PFX/PKCS#12 file format. Applicable to certificates. Encryption supported. |
| cfmSPC | 4 | SPC file format. Applicable to certificates. Encryption not supported. |
| cfmPVK | 5 | PVK file format. Applicable to private keys. Encryption not supported. |
| cfmPKCS8 | 6 | PKCS#8 file format. Applicable to private keys. Encryption supported. |
| cfmNET | 7 | NET file format. Applicable to private keys. Encryption not supported. |
ExportKey Method (CertificateManager Module)
Exports the certificate's private key.
Syntax
- (NSData*)exportKey:(NSString*)password :(int)format;
Remarks
Use this method to save the certificate private key in one of the formats given below. Pass the encryption password via the Password parameter.
Supported certificate key format values:
| cfmUnknown | 0 | Unknown certificate format |
| cfmDER | 1 | DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported |
| cfmPEM | 2 | PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys. |
| cfmPFX | 3 | PFX/PKCS#12 file format. Applicable to certificates. Encryption supported. |
| cfmSPC | 4 | SPC file format. Applicable to certificates. Encryption not supported. |
| cfmPVK | 5 | PVK file format. Applicable to private keys. Encryption not supported. |
| cfmPKCS8 | 6 | PKCS#8 file format. Applicable to private keys. Encryption supported. |
| cfmNET | 7 | NET file format. Applicable to private keys. Encryption not supported. |
ExportKeyToFile Method (CertificateManager Module)
Exports the private key to a file in the chosen format.
Syntax
- (void)exportKeyToFile:(NSString*)keyFile :(NSString*)password :(int)format;
Remarks
Use this method to save the certificate key in one of the formats given below. Pass the encryption password via the Password parameter.
Supported certificate key format values:
| cfmUnknown | 0 | Unknown certificate format |
| cfmDER | 1 | DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported |
| cfmPEM | 2 | PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys. |
| cfmPFX | 3 | PFX/PKCS#12 file format. Applicable to certificates. Encryption supported. |
| cfmSPC | 4 | SPC file format. Applicable to certificates. Encryption not supported. |
| cfmPVK | 5 | PVK file format. Applicable to private keys. Encryption not supported. |
| cfmPKCS8 | 6 | PKCS#8 file format. Applicable to private keys. Encryption supported. |
| cfmNET | 7 | NET file format. Applicable to private keys. Encryption not supported. |
ExportToFile Method (CertificateManager Module)
Exports the certificate to a file.
Syntax
public func exportToFile(certFile: String, password: String, format: Int32, exportKey: Bool) throws -> Void
- (void)exportToFile:(NSString*)certFile :(NSString*)password :(int)format :(BOOL)exportKey;
Remarks
Use this method to save the certificate to a file in one of the formats given below. Pass the encryption password via the Password parameter. Set ExportKey to true to save the private key together with the certificate.
| cfmUnknown | 0 | Unknown certificate format |
| cfmDER | 1 | DER file format. Applicable to certificates, certificate requests, private keys. Encryption not supported |
| cfmPEM | 2 | PEM file format. Applicable to certificates, certificate requests, private keys. Encryption supported for private keys. |
| cfmPFX | 3 | PFX/PKCS#12 file format. Applicable to certificates. Encryption supported. |
| cfmSPC | 4 | SPC file format. Applicable to certificates. Encryption not supported. |
| cfmPVK | 5 | PVK file format. Applicable to private keys. Encryption not supported. |
| cfmPKCS8 | 6 | PKCS#8 file format. Applicable to private keys. Encryption supported. |
| cfmNET | 7 | NET file format. Applicable to private keys. Encryption not supported. |
Note that not all formats support encryption, and some (like PEM) only support partial encryption (key only). Keep this in mind when considering which format to choose for storing your certificates.
Generate Method (CertificateManager Module)
Generates a new certificate.
Syntax
Remarks
Call this method to generate a new certificate based on the information provided via Certificate, CACertificate, and CertificateRequest parameters as given below:
If neither CACertificate nor CertificateRequest are set, a self-signed certificate will be generated based on the information set up in Certificate object.
If CACertificate is provided but CertificateRequest is not, a certificate signed by the CA certificate will be generated based on the information configured in the Certificate object.
If both CACertificate and CertificateRequest are set, a certificate based on the certificate request and signed by the CA certificate will be generated. The private key contained in the certificate request will be used.
KeyBits specifies the number of bits in the key to be generated. Note that this property is ignored in the case of request-based generation.
GenerateAsyncBegin Method (CertificateManager Module)
Initiates asynchronous (DC) certificate generation.
Syntax
- (NSString*)generateAsyncBegin:(int)keyBits;
Remarks
Call this method to initiate an asynchronous certificate generation process. Pass the obtained async state to the DC server for signing. To finalize the generation, pass the async state received from the DC server to GenerateAsyncEnd.
AsyncState is a message of the distributed cryptography (DC) protocol. DC protocol is based on exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.
In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth control), which processes it and produces a matching signatures state. The async state produced by the server is then passed to the SignAsyncEnd method.
GenerateAsyncEnd Method (CertificateManager Module)
Completes asynchronous certificate generation.
Syntax
- (void)generateAsyncEnd:(NSString*)asyncReply;
Remarks
Call this method to finalize the asynchronous generation process and pass the async state received from DC server via AsyncReply parameter.
AsyncState is a message of the distributed cryptography (DC) protocol. DC protocol is based on exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.
In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth control), which processes it and produces a matching signatures state. The async state produced by the server is then passed to the SignAsyncEnd method.
GenerateCSR Method (CertificateManager Module)
Creates a new certificate signing request (CSR).
Syntax
Remarks
Call this method to generate a new certificate request with the specified parameters. The newly generated CSR is saved in CertificateRequest property. Use ExportCSR and ExportKey to serialize the generated objects.
GenerateExternal Method (CertificateManager Module)
Generates a new certificate or request with an external signing device.
Syntax
- (void)generateExternal:(BOOL)CSR :(NSData*)keyBytes :(NSString*)keyPassword;
Remarks
Call this method to generate a new certificate based on the information provided via Certificate, CACertificate, and CertificateRequest parameters as given below:
If CACertificate is provided but CertificateRequest is not, a certificate signed by the CA certificate will be generated based on the information configured in the Certificate object.
If both CACertificate and CertificateRequest are set, a certificate based on the certificate request and signed by the CA certificate will be generated. The private key contained in the certificate request will be used.
If neither CACertificate nor CertificateRequest are set, an exception will be thrown: only CA-issued certificates can be generated remotely.
KeyBits specifies the number of bits in the key to be generated. Note that this property is ignored in the case of request-based generation.
GetExtensionData Method (CertificateManager Module)
Returns extension data.
Syntax
- (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 (CertificateManager Module)
Returns certificate extension state.
Syntax
Remarks
Use this method to find out whether the extension is included in the certificate/CRL and check its critical attribute.
| cesNotIncluded | 0 | The extension is not included in the certificate |
| cesCritical | 1 | The extension is included and is marked critical |
| cesNonCritical | 2 | The extension is included and is not marked critical |
GetSampleCert Method (CertificateManager Module)
Generates a sample certificate for the specified purpose.
Syntax
- (void)getSampleCert:(NSString*)purpose :(NSString*)subject;
Remarks
This method generates a sample self-signed certificate for the specified purpose. Use it as a quick method to get a working certificate to evaluate or test a piece of functionality that relies on certificates. The certificate will use pre-defined settings for most of its fields; use Generate method to generate bespoke real-world certificates. Purpose specifies the intended use of certificate:
- "generic": a generic certificate with no specific purpose
- "tls": a TLS server certificate
- "tls-client": a client-side TLS certificate
- "email": a secure e-mail (S/MIME) certificate
Subject specifies the common name to include in the certificate (e.g. "*.domain.com")
ImportCert Method (CertificateManager Module)
Imports a certificate.
Syntax
- (void)importCert:(NSData*)certBytes :(NSString*)password;
Remarks
Use this method to load a certificate from a byte array. Provide the password via the Password parameter. The Password parameter is optional. If it is omitted and it is later discovered that the key is password-encrypted, the PasswordNeeded event will be fired to request it. This method supports certificates in DER, PEM, PFX, and SPC formats.
ImportFromFile Method (CertificateManager Module)
Loads a certificate from a file.
Syntax
- (void)importFromFile:(NSString*)path :(NSString*)password;
Remarks
This method can load certificates saved in one of the following formats: DER, PEM, PFX, SPC.
Use the Path parameter to provide a path to the certificate, and Password to specify the password. The Password parameter is optional. If it is omitted and it is later discovered that the certificate is password-encrypted, the PasswordNeeded event will be fired to request it.
ImportFromObject Method (CertificateManager Module)
Imports a certificate from a platform object.
Syntax
- (void)importFromObject:(long long)srcObj;
Remarks
Use this method to import a certificate from a native platform object, such as X509Certificate2. Depending on the platform, the ObjHandle parameter can be one of the following:
- .NET: X509Certificate2
- Java: X509Certificate
- Windows-based platforms: PCCERT_CONTEXT
ImportKey Method (CertificateManager Module)
Imports a private key.
Syntax
- (void)importKey:(NSData*)key :(NSString*)password;
Remarks
Use this method to load a private key from a byte array. Provide the encryption password via the Password parameter. The Password parameter is optional. If it is omitted and it is later discovered that the key is password-encrypted, the PasswordNeeded event will be fired to request it. If there is an initialized certificate or certificate request object inside the manager, the loaded key gets associated with that object. This method supports keys in DER, PEM, PKCS#8, and PVK formats.
ImportKeyFromFile Method (CertificateManager Module)
Imports a private key from a file.
Syntax
- (void)importKeyFromFile:(NSString*)path :(NSString*)password;
Remarks
Use this method to load a private key from a file. Provide the encryption password via the Password parameter. The Password parameter is optional. If it is omitted and it is later discovered that the key is password-encrypted, the PasswordNeeded event will be fired to request it. If there is an initialized certificate or certificate request object inside the manager, the loaded key gets associated with that object. This method supports keys in DER, PEM, PKCS#8, and PVK formats.
ListExtensions Method (CertificateManager Module)
List extensions currently available in the certificate or CRL.
Syntax
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.
SetExtensionData Method (CertificateManager Module)
Sets extension data.
Syntax
- (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 (CertificateManager Module)
Sets certificate extension state.
Syntax
- (void)setExtensionState:(NSString*)OID :(int)state;
Remarks
Use this method to enable or disable the extension and set its critical attribute.
| cesNotIncluded | 0 | The extension is not included in the certificate |
| cesCritical | 1 | The extension is included and is marked critical |
| cesNonCritical | 2 | The extension is included and is not marked critical |
Update Method (CertificateManager Module)
Renews the certificate.
Syntax
public func update() throws -> Void
- (void)update;
Remarks
This method renews a certificate by updating its validity period and re-signing the updated version.
Note that this operation expects both Certificate and CACertificate properties to be set.
Validate Method (CertificateManager Module)
Validates the certificate.
Syntax
public func validate() throws -> Int32
- (int)validate;
Remarks
Use this method to validate the certificate contained in Certificate. If the certificate being validated is not self-signed, please provide the CA certificate via CACertificate property.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
Error Event (CertificateManager Module)
Information about errors during certificate loading, saving or validation.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
Reports exceptional conditions during certificate loading, exporting, or validation.
ErrorCode contains an error code and Description contains a textual description of the error.
ExternalSign Event (CertificateManager Module)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
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 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();
};
Notification Event (CertificateManager Module)
This event notifies the application about an underlying control flow event.
Syntax
- (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 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.
PasswordNeeded Event (CertificateManager Module)
This event is fired when a decryption password is needed.
Syntax
func onPasswordNeeded(password: inout String, cancel: inout Bool)
- (void)onPasswordNeeded:(NSString**)password :(int*)cancel;
Remarks
The class fires this event when a password is needed to decrypt a certificate or a private key.
In the handler of this event, assign the password to the Password parameter, or set Cancel to true to abort the operation.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
bytes Data |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ca Bool |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
caKeyID Data |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
crlDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fingerprint Data |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
friendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
handle Int64 |
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.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
issuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyBits Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyFingerprint Data |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyUsage Int32 |
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyValid Bool |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ocspNoCheck Bool |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
origin Int32 |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
policyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyBytes Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExists Bool |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyExtractable Bool |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBytes Data |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
qualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
selfSigned Bool |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
serialNumber Data |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectKeyID Data |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
validTo String |
The time point at which the certificate expires, in UTC. |
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.
CertificateRequest Type
Provides access to details of an individual certificate request (CSR).
Remarks
This type represents a certificate request as defined in PKCS#10.
Fields
|
bytes Data |
Provides access to raw certificate request data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
handle Int64 |
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.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate request (such as signing).
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyAlgorithm String |
Specifies the public key algorithm of this certificate request.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyBits Int32 |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyUsage Int32 |
Indicates the purposes of the key contained in the certificate request, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyValid Bool |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
privateKeyBytes Data |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyBytes Data |
Contains the public key incorporated in the request, in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
sigAlgorithm String |
Indicates the algorithm that was used by the requestor to sign this certificate request. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
subjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
valid Bool |
Indicates whether or not the signature on the request is valid and matches the public key contained in the request. |
Constructors
public init()
Creates a new object with default field values.
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
|
asyncDocumentID String |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
customParams String |
Custom parameters to be passed to the signing service (uninterpreted). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
data String |
Additional data to be included in the async state and mirrored back by the requestor |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
externalHashCalculation Bool |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
hashAlgorithm String |
Specifies the request's signature hash algorithm.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keyID String |
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 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
keySecret String |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
method AsyncSignMethods |
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
mode ExternalCryptoModes |
Specifies the external cryptography mode. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
publicKeyAlgorithm String |
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
|
Constructors
public init()
Creates a new ExternalCrypto object with default field values.
Config Settings (CertificateManager Module)
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.CertificateManager Config Settings | ||||||||||||||||||||||||||||||
| KeyExchangePIN: The KeyExchange PIN to provide to the key in runtime.Sets the key exchange PIN to pass to the private key in runtime. This property can be used with certificates originating from Windows (system://) or PKCS#11 (pkcs11://) certificate stores. | ||||||||||||||||||||||||||||||
| SignaturePIN: The Signature PIN to provide to the key in runtime.Sets the signature PIN to pass to the private key in runtime. This property can be used with certificates originating from Windows (system://) or PKCS#11 (pkcs11://) certificate stores. | ||||||||||||||||||||||||||||||
| TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| StaticDNS:
Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.
Supported values are:
|
||||||||||||||||||||||||||||||
| StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character. | ||||||||||||||||||||||||||||||
| StaticIPAddresses: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. | ||||||||||||||||||||||||||||||
| TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). | ||||||||||||||||||||||||||||||
| TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). | ||||||||||||||||||||||||||||||
| UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (CertificateManager Module)
CertificateManager 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) |