CryptoKeyManager Module
Properties Methods Events Config Settings Errors
The CryptoKeyManager module provides a simple way to load, generate and manage generic crypto keys.
Syntax
SecureBlackbox.Cryptokeymanager
Remarks
CryptoKeyManager allows you to load, save, generate, import, and export low-level crypto keys. One example of such keys are raw RSA keys stored in PKCS1 format or AES256 keys. CryptoKeyManager supports asymmetric, symmetric, and HMAC keys.
CryptoKeyManager is a typical companion for low-level cryptography classes, such as PublicKeyCrypto, SymmetricCrypto, and HashFunction. It can also be used to provide external key material to certificate objects, and to derive cryptographic keys from passwords.
Use ImportBytes or ImportFromFile method to load the key material from a buffer or file. Use ImportFromCert (and remember to assign the certificate object to the Certificate property before calling it) to import a key from an X.509 certificate. Once loaded, the key will be available in the Key property.
To generate a new key or keypair use Generate method. You can export the generated key using ExportBytes or ExportToFile method. You can attach the generated or loaded key to an external certificate object using the ExportToCert method.
Note: CryptoKeyManager can only work with one cryptographic key at a time. Use CryptoKeyStorage to access media containing more than one key.
Property List
The following is the full list of the properties of the module with short descriptions. Click on the links for further details.
Certificate | A container for the certificate object. |
DerivationAlgorithm | Specifies the algorithm to use for key derivation. |
DeriveIterations | Specifies the number of iterations to use as part of key derivation routine. |
FIPSMode | Reserved. |
HMACAlgorithm | Specifies the HMAC algorithm to use with the key derivation algorithm. |
Key | The key object that the manager is currently working with. |
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. |
DeriveKey | Generates a strong cryptographic key from a password. |
DoAction | Performs an additional action. |
ExportBytes | Exports the key to a byte array. |
ExportToCert | Exports the key to a certificate. |
ExportToFile | Exports the key to a file. |
Generate | Generates a new crypto key. |
GetKeyParam | Returns an algorithm-specific key parameter. |
GetKeyParamStr | Returns an algorithm-specific key parameter to a string. |
ImportBytes | Loads a key from a byte array. |
ImportFromCert | Loads a key from a certificate. |
ImportFromFile | Loads a key from a file. |
SetKeyParam | Sets an algorithm-specific key parameter. |
SetKeyParamStr | Sets an algorithm-specific key parameter. |
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 | Informs about an error during an operation. |
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.
Argon2MemoryCost | Sets the memory cost parameter of Argon2 key derivation algorithm. |
Argon2Parallelism | Sets the parallelism parameter of Argon2 key derivation algorithm. |
DerivationAlgorithm | The algorithm to use for key derivation. |
DeriveIterations | The number of iterations to use as part of key derivation routine. |
HMACAlgorithm | Specifies the HMAC algorithm to use with the key derivation algorithm. |
TempPath | Path for storing temporary files. |
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. |
Tag | Allows to store any custom data. |
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. |
Certificate Property (CryptoKeyManager 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 read-only.
DerivationAlgorithm Property (CryptoKeyManager Module)
Specifies the algorithm to use for key derivation.
Syntax
public var derivationAlgorithm: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=derivationAlgorithm,setter=setDerivationAlgorithm:) NSString* derivationAlgorithm; - (NSString*)derivationAlgorithm; - (void)setDerivationAlgorithm :(NSString*)newDerivationAlgorithm;
Default Value
"PKCS5"
Remarks
Use this property to specify the key derivation algorithm to use.
Class supports the following algorithms: PKCS5, BCrypt, SCrypt, Argon2, Argon2i, Argon2d.
DeriveIterations Property (CryptoKeyManager Module)
Specifies the number of iterations to use as part of key derivation routine.
Syntax
public var deriveIterations: Int32 { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=deriveIterations,setter=setDeriveIterations:) int deriveIterations; - (int)deriveIterations; - (void)setDeriveIterations :(int)newDeriveIterations;
Default Value
2048
Remarks
Use this property to adjust the number of hash algorithm iterations to employ as part of key derivation function.
FIPSMode Property (CryptoKeyManager 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.
HMACAlgorithm Property (CryptoKeyManager Module)
Specifies the HMAC algorithm to use with the key derivation algorithm.
Syntax
public var hmacAlgorithm: String { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=HMACAlgorithm,setter=setHMACAlgorithm:) NSString* HMACAlgorithm; - (NSString*)HMACAlgorithm; - (void)setHMACAlgorithm :(NSString*)newHMACAlgorithm;
Default Value
"SHA1"
Remarks
Use this property to specify the HMAC algorithm to use with the chosen key derivation algorithm.
Class supports the following algorithms: SHA1, SHA224, SHA256, SHA384, SHA512, MD5, RIPEMD, HMAC.
Key Property (CryptoKeyManager Module)
The key object that the manager is currently working with.
Syntax
public var key: CryptoKey { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=keyAlgorithm,setter=setKeyAlgorithm:) NSString* keyAlgorithm; - (NSString*)keyAlgorithm; - (void)setKeyAlgorithm :(NSString*)newKeyAlgorithm; @property (nonatomic,readonly,assign,getter=keyBits) int keyBits; - (int)keyBits; @property (nonatomic,readwrite,assign,getter=keyCurve,setter=setKeyCurve:) NSString* keyCurve; - (NSString*)keyCurve; - (void)setKeyCurve :(NSString*)newKeyCurve; @property (nonatomic,readonly,assign,getter=keyExportable) BOOL keyExportable; - (BOOL)keyExportable; @property (nonatomic,readwrite,assign,getter=keyHandle,setter=setKeyHandle:) long long keyHandle; - (long long)keyHandle; - (void)setKeyHandle :(long long)newKeyHandle; @property (nonatomic,readwrite,assign,getter=keyID,setter=setKeyID:) NSData* keyID; - (NSData*)keyID; - (void)setKeyID :(NSData*)newKeyID; @property (nonatomic,readwrite,assign,getter=keyIV,setter=setKeyIV:) NSData* keyIV; - (NSData*)keyIV; - (void)setKeyIV :(NSData*)newKeyIV; @property (nonatomic,readonly,assign,getter=keyKey) NSData* keyKey; - (NSData*)keyKey; @property (nonatomic,readwrite,assign,getter=keyNonce,setter=setKeyNonce:) NSData* keyNonce; - (NSData*)keyNonce; - (void)setKeyNonce :(NSData*)newKeyNonce; @property (nonatomic,readonly,assign,getter=keyPrivate) BOOL keyPrivate; - (BOOL)keyPrivate; @property (nonatomic,readonly,assign,getter=keyPublic) BOOL keyPublic; - (BOOL)keyPublic; @property (nonatomic,readwrite,assign,getter=keySubject,setter=setKeySubject:) NSData* keySubject; - (NSData*)keySubject; - (void)setKeySubject :(NSData*)newKeySubject; @property (nonatomic,readonly,assign,getter=keySymmetric) BOOL keySymmetric; - (BOOL)keySymmetric; @property (nonatomic,readonly,assign,getter=keyValid) BOOL keyValid; - (BOOL)keyValid;
Default Value
False
Remarks
This property is read-only.
Config Method (CryptoKeyManager 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.
DeriveKey Method (CryptoKeyManager Module)
Generates a strong cryptographic key from a password.
Syntax
- (void)deriveKey:(int)keyBits :(NSString*)password :(NSString*)salt;
Remarks
Use this method to generate a cryptographically strong key of a needed length from a password.
This method uses a general-purpose PBKDF2 function with PRF1 and 2048 iterations.
DoAction Method (CryptoKeyManager 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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
ExportBytes Method (CryptoKeyManager Module)
Exports the key to a byte array.
Syntax
- (NSData*)exportBytes:(int)format :(int)keyType;
Remarks
Use this method to save the Key (both the public and secret parts) to a byte array.
kffUnknown | 0 | The key format was not recognized as one of the known formats. |
kffAuto | 1 | The default format in current circumstances. This depends on the key being loaded or saved. |
kffDER | 2 | DER (binary) format |
kffPEM | 3 | PEM format (base64-encoded with headers) |
kffJSON | 4 | JSON key format |
ktAuto | 0 | The default key type in current circumstances. This depends on the operation, the file content, and the storage type. |
ktPublic | 1 | The operation should be performed on a public key. |
ktSecret | 2 | The operation should be performed on a private or secret key |
ExportToCert Method (CryptoKeyManager Module)
Exports the key to a certificate.
Syntax
public func exportToCert() throws -> Void
- (void)exportToCert;
Remarks
Use this method to save the Key (both the public and secret parts) to the certificate specified in Certificate.
ExportToFile Method (CryptoKeyManager Module)
Exports the key to a file.
Syntax
- (void)exportToFile:(NSString*)filename :(int)format :(int)keyType;
Remarks
Use this method to save the Key (both the public and secret parts) to the file passed via the Filename parameter.
kffUnknown | 0 | The key format was not recognized as one of the known formats. |
kffAuto | 1 | The default format in current circumstances. This depends on the key being loaded or saved. |
kffDER | 2 | DER (binary) format |
kffPEM | 3 | PEM format (base64-encoded with headers) |
kffJSON | 4 | JSON key format |
ktAuto | 0 | The default key type in current circumstances. This depends on the operation, the file content, and the storage type. |
ktPublic | 1 | The operation should be performed on a public key. |
ktSecret | 2 | The operation should be performed on a private or secret key |
Generate Method (CryptoKeyManager Module)
Generates a new crypto key.
Syntax
public func generate(keyAlgorithm: String, scheme: String, schemeParams: String, keyBits: Int32) throws -> Void
- (void)generate:(NSString*)keyAlgorithm :(NSString*)scheme :(NSString*)schemeParams :(int)keyBits;
Remarks
Call this method to generate a new key or keypair with the desired KeyAlgorithm and KeyBits of length.
The generated key will be populated in the Key property.
GetKeyParam Method (CryptoKeyManager Module)
Returns an algorithm-specific key parameter.
Syntax
Remarks
Use this method to retrieve an algorithm-specific key parameter.
GetKeyParamStr Method (CryptoKeyManager Module)
Returns an algorithm-specific key parameter to a string.
Syntax
- (NSString*)getKeyParamStr:(NSString*)name;
Remarks
Use this method to get an algorithm-specific key parameter to a string.
ImportBytes Method (CryptoKeyManager Module)
Loads a key from a byte array.
Syntax
public func importBytes(value: Data, format: Int32, keyAlgorithm: String, scheme: String, schemeParams: String, keyType: Int32) throws -> Void
- (void)importBytes:(NSData*)value :(int)format :(NSString*)keyAlgorithm :(NSString*)scheme :(NSString*)schemeParams :(int)keyType;
Remarks
Use this method to load a key, either public or secret, from a byte array.
kffUnknown | 0 | The key format was not recognized as one of the known formats. |
kffAuto | 1 | The default format in current circumstances. This depends on the key being loaded or saved. |
kffDER | 2 | DER (binary) format |
kffPEM | 3 | PEM format (base64-encoded with headers) |
kffJSON | 4 | JSON key format |
ktAuto | 0 | The default key type in current circumstances. This depends on the operation, the file content, and the storage type. |
ktPublic | 1 | The operation should be performed on a public key. |
ktSecret | 2 | The operation should be performed on a private or secret key |
Mgr.ImportBytes(ThirtyTwoKeyBytes, kffDER, "AES256", "", "", ktSecret)
ImportFromCert Method (CryptoKeyManager Module)
Loads a key from a certificate.
Syntax
public func importFromCert() throws -> Void
- (void)importFromCert;
Remarks
Use this method to load a key, either public or secret, from a certificate.
ImportFromFile Method (CryptoKeyManager Module)
Loads a key from a file.
Syntax
public func importFromFile(filename: String, format: Int32, keyAlgorithm: String, scheme: String, schemeParams: String, keyType: Int32) throws -> Void
- (void)importFromFile:(NSString*)filename :(int)format :(NSString*)keyAlgorithm :(NSString*)scheme :(NSString*)schemeParams :(int)keyType;
Remarks
Use this method to load a key, either public or secret, from a file.
kffUnknown | 0 | The key format was not recognized as one of the known formats. |
kffAuto | 1 | The default format in current circumstances. This depends on the key being loaded or saved. |
kffDER | 2 | DER (binary) format |
kffPEM | 3 | PEM format (base64-encoded with headers) |
kffJSON | 4 | JSON key format |
ktAuto | 0 | The default key type in current circumstances. This depends on the operation, the file content, and the storage type. |
ktPublic | 1 | The operation should be performed on a public key. |
ktSecret | 2 | The operation should be performed on a private or secret key |
SetKeyParam Method (CryptoKeyManager Module)
Sets an algorithm-specific key parameter.
Syntax
- (void)setKeyParam:(NSString*)name :(NSData*)value;
Remarks
Use this method to set an algorithm-specific key parameter.
SetKeyParamStr Method (CryptoKeyManager Module)
Sets an algorithm-specific key parameter.
Syntax
- (void)setKeyParamStr:(NSString*)name :(NSString*)valueStr;
Remarks
Use this method to set an algorithm-specific key parameter provided in a string.
Error Event (CryptoKeyManager Module)
Informs about an error during an operation.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The event is fired when an error happens in the middle of the class's work.
ErrorCode contains an error code and Description contains a textual description of the error.
Notification Event (CryptoKeyManager 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 (CryptoKeyManager Module)
This event is fired when a decryption password is needed.
Syntax
func onPasswordNeeded(neededFor: String, password: inout String, cancel: inout Bool)
- (void)onPasswordNeeded:(NSString*)neededFor :(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.
The NeededFor parameter identifies the certificate for which the password is requested.
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.
CryptoKey Type
This container represents a cryptographic key.
Remarks
This type is a universal placeholder for cryptographic keys.
Fields
algorithm String |
The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bits Int32 |
The length of the key in bits. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
curve String |
This property specifies the name of the curve the EC key is built on. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exportable Bool |
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id Data |
Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
iv Data |
The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
key Data |
The byte array representation of the key. This may not be available for non- keys. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nonce Data |
A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
private_ Bool |
Returns True if the object hosts a private key, and False otherwise. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
public_ Bool |
Returns True if the object hosts a public key, and False otherwise. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subject Data |
Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
symmetric Bool |
Returns True if the object contains a symmetric key, and False otherwise. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
valid Bool |
Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent. |
Constructors
public init()
Creates an empty crypto key object.
Config Settings (CryptoKeyManager 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.CryptoKeyManager Config Settings | ||||||||||||||||||||||||||||||
Argon2MemoryCost: Sets the memory cost parameter of Argon2 key derivation algorithm.Use this property to specify the memory cost parameter of Argon2 algorithm. The default value is 1048576. | ||||||||||||||||||||||||||||||
Argon2Parallelism: Sets the parallelism parameter of Argon2 key derivation algorithm.Use this property to specify the parallelism parameter of Argon2 algorithm. The default value is 2. | ||||||||||||||||||||||||||||||
DerivationAlgorithm:
The algorithm to use for key derivation.This property specifies the key derivation algorithm to use.
The following values are supported: PKCS5 (the default setting), BCrypt, SCrypt, Argon2, Argon2i, Argon2d. |
||||||||||||||||||||||||||||||
DeriveIterations: The number of iterations to use as part of key derivation routine.Use this property to adjust the number of hash algorithm iterations to employ as part of key derivation function. | ||||||||||||||||||||||||||||||
HMACAlgorithm:
Specifies the HMAC algorithm to use with the key derivation algorithm.This property specifies the HMAC algorithm to use with the chosen key derivation algorithm.
Use normal hash algorithm constants with this property: SHA1, SHA224, SHA256, SHA384, SHA512, RIPEMD. |
||||||||||||||||||||||||||||||
TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. 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. | ||||||||||||||||||||||||||||||
Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
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 (CryptoKeyManager Module)
CryptoKeyManager 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) |