SSHKeyManager Module
Properties Methods Events Config Settings Errors
The SSHKeyManager module stores information about SSH keys.
Syntax
SecureBlackbox.Sshkeymanager
Remarks
SSHKeyManager provides the capabilities of generating, storing, importing, and exporting SSH keys.
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. |
CryptoKey | The key object that the manager is currently working with. |
FIPSMode | Reserved. |
Key | The key which is currently being processed. |
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. |
ExportBytes | Writes the key to a memory buffer. |
ExportToCert | Exports the key to a certificate. |
ExportToCryptoKey | Exports the key to a crypto key object. |
ExportToFile | Writes key to file. |
Generate | Generates a new SSH key. |
GetKeyParam | Returns an algorithm-specific key parameter. |
GetKeyParamStr | Returns an algorithm-specific key parameter to a string. |
ImportBytes | Loads key from buffer. |
ImportFromCert | Loads a key from a certificate. |
ImportFromCryptoKey | Imports a key from a crypto key. |
ImportFromFile | Loads key from 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 | Information about errors during SSH key management. |
Notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the module with short descriptions. Click on the links for further details.
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. |
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. |
Certificate Property (SSHKeyManager 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
""
Remarks
Use this property to set or access the properties of the certificate object on which an import or export action is to be performed.
CryptoKey Property (SSHKeyManager Module)
The key object that the manager is currently working with.
Syntax
public var cryptoKey: CryptoKey { get {...} set {...} }
@property (nonatomic,readwrite,assign,getter=cryptoKeyAlgorithm,setter=setCryptoKeyAlgorithm:) NSString* cryptoKeyAlgorithm; - (NSString*)cryptoKeyAlgorithm; - (void)setCryptoKeyAlgorithm :(NSString*)newCryptoKeyAlgorithm; @property (nonatomic,readonly,assign,getter=cryptoKeyBits) int cryptoKeyBits; - (int)cryptoKeyBits; @property (nonatomic,readwrite,assign,getter=cryptoKeyCurve,setter=setCryptoKeyCurve:) NSString* cryptoKeyCurve; - (NSString*)cryptoKeyCurve; - (void)setCryptoKeyCurve :(NSString*)newCryptoKeyCurve; @property (nonatomic,readonly,assign,getter=cryptoKeyExportable) BOOL cryptoKeyExportable; - (BOOL)cryptoKeyExportable; @property (nonatomic,readwrite,assign,getter=cryptoKeyHandle,setter=setCryptoKeyHandle:) long long cryptoKeyHandle; - (long long)cryptoKeyHandle; - (void)setCryptoKeyHandle :(long long)newCryptoKeyHandle; @property (nonatomic,readwrite,assign,getter=cryptoKeyID,setter=setCryptoKeyID:) NSData* cryptoKeyID; - (NSData*)cryptoKeyID; - (void)setCryptoKeyID :(NSData*)newCryptoKeyID; @property (nonatomic,readwrite,assign,getter=cryptoKeyIV,setter=setCryptoKeyIV:) NSData* cryptoKeyIV; - (NSData*)cryptoKeyIV; - (void)setCryptoKeyIV :(NSData*)newCryptoKeyIV; @property (nonatomic,readonly,assign,getter=cryptoKeyKey) NSData* cryptoKeyKey; - (NSData*)cryptoKeyKey; @property (nonatomic,readwrite,assign,getter=cryptoKeyNonce,setter=setCryptoKeyNonce:) NSData* cryptoKeyNonce; - (NSData*)cryptoKeyNonce; - (void)setCryptoKeyNonce :(NSData*)newCryptoKeyNonce; @property (nonatomic,readonly,assign,getter=cryptoKeyPrivate) BOOL cryptoKeyPrivate; - (BOOL)cryptoKeyPrivate; @property (nonatomic,readonly,assign,getter=cryptoKeyPublic) BOOL cryptoKeyPublic; - (BOOL)cryptoKeyPublic; @property (nonatomic,readwrite,assign,getter=cryptoKeySubject,setter=setCryptoKeySubject:) NSData* cryptoKeySubject; - (NSData*)cryptoKeySubject; - (void)setCryptoKeySubject :(NSData*)newCryptoKeySubject; @property (nonatomic,readonly,assign,getter=cryptoKeySymmetric) BOOL cryptoKeySymmetric; - (BOOL)cryptoKeySymmetric; @property (nonatomic,readonly,assign,getter=cryptoKeyValid) BOOL cryptoKeyValid; - (BOOL)cryptoKeyValid;
Default Value
""
Remarks
Use this property to pass a key to the manager (for example, for importing), or to obtain a key from the manager (e.g., after exporting to it).
FIPSMode Property (SSHKeyManager 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.
Key Property (SSHKeyManager Module)
The key which is currently being processed.
Syntax
public var key: SSHKey { get {...} set {...} }
@property (nonatomic,readonly,assign,getter=keyAlgorithm) NSString* keyAlgorithm; - (NSString*)keyAlgorithm; @property (nonatomic,readonly,assign,getter=keyBits) int keyBits; - (int)keyBits; @property (nonatomic,readwrite,assign,getter=keyComment,setter=setKeyComment:) NSString* keyComment; - (NSString*)keyComment; - (void)setKeyComment :(NSString*)newKeyComment; @property (nonatomic,readonly,assign,getter=keyCurve) NSString* keyCurve; - (NSString*)keyCurve; @property (nonatomic,readonly,assign,getter=keyDSSG) NSData* keyDSSG; - (NSData*)keyDSSG; @property (nonatomic,readonly,assign,getter=keyDSSP) NSData* keyDSSP; - (NSData*)keyDSSP; @property (nonatomic,readonly,assign,getter=keyDSSQ) NSData* keyDSSQ; - (NSData*)keyDSSQ; @property (nonatomic,readonly,assign,getter=keyDSSX) NSData* keyDSSX; - (NSData*)keyDSSX; @property (nonatomic,readonly,assign,getter=keyDSSY) NSData* keyDSSY; - (NSData*)keyDSSY; @property (nonatomic,readonly,assign,getter=keyECCD) NSData* keyECCD; - (NSData*)keyECCD; @property (nonatomic,readonly,assign,getter=keyECCQX) NSData* keyECCQX; - (NSData*)keyECCQX; @property (nonatomic,readonly,assign,getter=keyECCQY) NSData* keyECCQY; - (NSData*)keyECCQY; @property (nonatomic,readonly,assign,getter=keyEdPrivate) NSData* keyEdPrivate; - (NSData*)keyEdPrivate; @property (nonatomic,readonly,assign,getter=keyEdPublic) NSData* keyEdPublic; - (NSData*)keyEdPublic; @property (nonatomic,readonly,assign,getter=keyFingerprintMD5) NSString* keyFingerprintMD5; - (NSString*)keyFingerprintMD5; @property (nonatomic,readonly,assign,getter=keyFingerprintSHA1) NSString* keyFingerprintSHA1; - (NSString*)keyFingerprintSHA1; @property (nonatomic,readonly,assign,getter=keyFingerprintSHA256) NSString* keyFingerprintSHA256; - (NSString*)keyFingerprintSHA256; @property (nonatomic,readwrite,assign,getter=keyHandle,setter=setKeyHandle:) long long keyHandle; - (long long)keyHandle; - (void)setKeyHandle :(long long)newKeyHandle; @property (nonatomic,readonly,assign,getter=keyIsExtractable) BOOL keyIsExtractable; - (BOOL)keyIsExtractable; @property (nonatomic,readonly,assign,getter=keyIsPrivate) BOOL keyIsPrivate; - (BOOL)keyIsPrivate; @property (nonatomic,readonly,assign,getter=keyIsPublic) BOOL keyIsPublic; - (BOOL)keyIsPublic; @property (nonatomic,readonly,assign,getter=keyKDFRounds) int keyKDFRounds; - (int)keyKDFRounds; @property (nonatomic,readonly,assign,getter=keyKDFSalt) NSData* keyKDFSalt; - (NSData*)keyKDFSalt; @property (nonatomic,readonly,assign,getter=keyKeyFormat) int keyKeyFormat; - (int)keyKeyFormat; @property (nonatomic,readonly,assign,getter=keyKeyProtectionAlgorithm) NSString* keyKeyProtectionAlgorithm; - (NSString*)keyKeyProtectionAlgorithm; @property (nonatomic,readonly,assign,getter=keyRSAExponent) NSData* keyRSAExponent; - (NSData*)keyRSAExponent; @property (nonatomic,readonly,assign,getter=keyRSAIQMP) NSData* keyRSAIQMP; - (NSData*)keyRSAIQMP; @property (nonatomic,readonly,assign,getter=keyRSAModulus) NSData* keyRSAModulus; - (NSData*)keyRSAModulus; @property (nonatomic,readonly,assign,getter=keyRSAP) NSData* keyRSAP; - (NSData*)keyRSAP; @property (nonatomic,readonly,assign,getter=keyRSAPrivateExponent) NSData* keyRSAPrivateExponent; - (NSData*)keyRSAPrivateExponent; @property (nonatomic,readonly,assign,getter=keyRSAQ) NSData* keyRSAQ; - (NSData*)keyRSAQ; @property (nonatomic,readwrite,assign,getter=keySubject,setter=setKeySubject:) NSString* keySubject; - (NSString*)keySubject; - (void)setKeySubject :(NSString*)newKeySubject;
Default Value
""
Remarks
This property contains the key on which the class could operate now.
Config Method (SSHKeyManager 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 (SSHKeyManager 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 insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
ExportBytes Method (SSHKeyManager Module)
Writes the key to a memory buffer.
Syntax
- (NSData*)exportBytes:(int)keyType :(NSString*)password;
Remarks
Use this method to save Key in the buffer. KeyType specifies the format in which the key should be stored, and Password is a password to decrypt the private key.
Allowed key types:
cktPrivate | 0 | A private key |
cktPublic | 1 | A public key |
ExportToCert Method (SSHKeyManager 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.
ExportToCryptoKey Method (SSHKeyManager Module)
Exports the key to a crypto key object.
Syntax
public func exportToCryptoKey() throws -> Void
- (void)exportToCryptoKey;
Remarks
Use this method to save the Key (both the public and secret parts) to the crypto key provided via CryptoKey.
ExportToFile Method (SSHKeyManager Module)
Writes key to file.
Syntax
- (void)exportToFile:(int)keyType :(NSString*)path :(NSString*)password;
Remarks
Use this method to save Key in the file. KeyType specifies the format in which the key should be stored, Path specifies the full path to the file, and Password is a password to decrypt the private key.
Allowed key types:
cktPrivate | 0 | A private key |
cktPublic | 1 | A public key |
Generate Method (SSHKeyManager Module)
Generates a new SSH 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.
The KeyAlgorithm parameter supports the following algorithm identifiers:
- RSA
- DSS
- ECDSA
- EDDSA
If using ECDSA, the following curves are supported (to be passed as the Scheme parameter):
- NISTP256
- NISTP384
- NISTP521
- NISTK163
- NISTP192
- NISTP224
- NISTK233
- NISTB233
- NISTK283
- NISTK409
- NISTB409
- NISTK571
The following curves can also be used with EDDSA:
- CURVE25519
- CURVE448
GetKeyParam Method (SSHKeyManager Module)
Returns an algorithm-specific key parameter.
Syntax
Remarks
Use this method to retrieve an algorithm-specific key parameter.
GetKeyParamStr Method (SSHKeyManager 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 (SSHKeyManager Module)
Loads key from buffer.
Syntax
- (void)importBytes:(NSData*)bytes :(NSString*)password;
Remarks
Use this method to read a key stored in a buffer. Password specifies a password to decrypt the private key.
ImportFromCert Method (SSHKeyManager 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.
ImportFromCryptoKey Method (SSHKeyManager Module)
Imports a key from a crypto key.
Syntax
public func importFromCryptoKey() throws -> Void
- (void)importFromCryptoKey;
Remarks
Use this method to load a key, either public or private, from a crypto key. Provide the key via CryptoKey property.
ImportFromFile Method (SSHKeyManager Module)
Loads key from file.
Syntax
- (void)importFromFile:(NSString*)path :(NSString*)password;
Remarks
Use this method to read a key stored in a file. Path specifies the full path to the file, Password is a password to decrypt the private key.
SetKeyParam Method (SSHKeyManager 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 (SSHKeyManager 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 (SSHKeyManager Module)
Information about errors during SSH key management.
Syntax
- (void)onError:(int)errorCode :(NSString*)description;
Remarks
The event is fired in case of exceptional conditions during key management.
ErrorCode contains an error code and Description contains a textual description of the error.
Notification Event (SSHKeyManager 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 class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
bytes
Data (read-only)
Default Value: ""
Returns the raw certificate data in DER format.
ca
Bool
Default Value: False
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
caKeyID
Data (read-only)
Default Value: ""
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
Default Value: ""
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
curve
String
Default Value: ""
Specifies the elliptic curve of the EC public key.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
fingerprint
Data (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
friendlyName
String (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate.
handle
Int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
hashAlgorithm
String
Default Value: ""
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
issuer
String (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name.
issuerRDN
String
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
keyAlgorithm
String
Default Value: "0"
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
keyBits
Int32 (read-only)
Default Value: 0
Returns the length of the public key.
keyFingerprint
Data (read-only)
Default Value: ""
Returns a fingerprint of the public key contained in the certificate.
keyUsage
Int32
Default Value: 0
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:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
keyValid
Bool (read-only)
Default Value: False
Returns True if the certificate's key is cryptographically valid, and False otherwise.
ocspLocations
String
Default Value: ""
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
Default Value: False
Accessor to the value of the certificate's ocsp-no-check extension.
origin
Int32 (read-only)
Default Value: 0
Returns the origin of this certificate.
policyIDs
String
Default Value: ""
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 (read-only)
Default Value: ""
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
privateKeyExists
Bool (read-only)
Default Value: False
Indicates whether the certificate has an associated private key.
privateKeyExtractable
Bool (read-only)
Default Value: False
Indicates whether the private key is extractable.
publicKeyBytes
Data (read-only)
Default Value: ""
Contains the certificate's public key in DER format.
qualifiedStatements
QualifiedStatementsTypes
Default Value: 0
Returns the qualified status of the certificate.
selfSigned
Bool (read-only)
Default Value: False
Indicates whether the certificate is self-signed (root) or signed by an external CA.
serialNumber
Data
Default Value: ""
Returns the certificate's serial number.
sigAlgorithm
String (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
subject
String (read-only)
Default Value: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
subjectAlternativeName
String
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
subjectKeyID
Data
Default Value: ""
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
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
validFrom
String
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
validTo
String
Default Value: ""
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
Default Value: ""
The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
SB_SYMMETRIC_ALGORITHM_DES | DES | |
SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity | |
SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 | |
SB_SYMMETRIC_ALGORITHM_IDEA | IDEA | |
SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish | |
SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 | |
SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent | |
SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 | |
SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 | |
SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 | |
SB_SYMMETRIC_ALGORITHM_SEED | SEED | |
SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit | |
SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic | |
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 | |
SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
bits
Int32 (read-only)
Default Value: 0
The length of the key in bits.
curve
String
Default Value: ""
This property specifies the name of the curve the EC key is built on.
exportable
Bool (read-only)
Default Value: False
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
handle
Int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
id
Data
Default Value: ""
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
Default Value: ""
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 (read-only)
Default Value: ""
The byte array representation of the key. This may not be available for non- keys.
nonce
Data
Default Value: ""
A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.
private_
Bool (read-only)
Default Value: False
Returns True if the object hosts a private key, and False otherwise.
public_
Bool (read-only)
Default Value: False
Returns True if the object hosts a public key, and False otherwise.
subject
Data
Default Value: ""
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 (read-only)
Default Value: False
Returns True if the object contains a symmetric key, and False otherwise.
valid
Bool (read-only)
Default Value: False
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.
SSHKey Type
SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key.
Remarks
SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits.
Fields
algorithm
String (read-only)
Default Value: ""
Specifies the key algorithm.
bits
Int32 (read-only)
Default Value: 0
The number of bits in the key: the more the better, 2048 or 4096 are typical values.
comment
String
Default Value: ""
The comment for the public key.
curve
String (read-only)
Default Value: ""
Specifies the elliptical curve when EC cryptography is used.
dssg
Data (read-only)
Default Value: ""
The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.
dssp
Data (read-only)
Default Value: ""
The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.
dssq
Data (read-only)
Default Value: ""
The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.
dssx
Data (read-only)
Default Value: ""
The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.
This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).
dssy
Data (read-only)
Default Value: ""
The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.
eccd
Data (read-only)
Default Value: ""
The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.
eccqx
Data (read-only)
Default Value: ""
The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.
eccqy
Data (read-only)
Default Value: ""
The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.
edPrivate
Data (read-only)
Default Value: ""
The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
edPublic
Data (read-only)
Default Value: ""
The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
fingerprintMD5
String (read-only)
Default Value: ""
Contains the MD5 fingerprint (hash) of the key.
fingerprintSHA1
String (read-only)
Default Value: ""
Contains the SHA-1 fingerprint (hash) of the key.
fingerprintSHA256
String (read-only)
Default Value: ""
Contains the SHA-256 fingerprint (hash) of the key.
handle
Int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
isExtractable
Bool (read-only)
Default Value: False
Whether the key is extractable (e.g., from a security token), or not.
isPrivate
Bool (read-only)
Default Value: False
Whether this key is a private key or not.
isPublic
Bool (read-only)
Default Value: False
Whether this key is a public key or not.
kdfRounds
Int32 (read-only)
Default Value: 0
Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.
kdfSalt
Data (read-only)
Default Value: ""
The salt value used by the Key Derivation Function (KDF) to generate this key.
keyFormat
SSHKeyFormats (read-only)
Default Value: 0
Specifies the format in which the key is stored.
ckfOpenSSH | 0 | |
ckfOpenSSH2 | 1 | |
ckfIETF | 2 | |
ckfPuTTY | 3 | |
ckfX509 | 4 | |
ckfBinary | 5 | |
ckfSSH1 | 6 | |
ckfPGP | 7 | |
ckfPKCS8 | 8 | |
ckfPuTTY3 | 9 |
keyProtectionAlgorithm
String (read-only)
Default Value: ""
Specifies the key protection algorithm.
rsaExponent
Data (read-only)
Default Value: ""
Returns the e parameter (public exponent) of the RSA key.
rsaiqmp
Data (read-only)
Default Value: ""
Returns the iqmp parameter of the RSA key.
rsaModulus
Data (read-only)
Default Value: ""
Returns the m parameter (public modulus) of the RSA key.
rsap
Data (read-only)
Default Value: ""
Returns the p parameter (first factor of the common modulus n) of the RSA key.
rsaPrivateExponent
Data (read-only)
Default Value: ""
Returns the d parameter (private exponent) of the RSA key.
rsaq
Data (read-only)
Default Value: ""
Returns the q parameter (second factor of the common modulus n) of the RSA key.
subject
String
Default Value: ""
Specifies the public key owner (subject). This property is used only for IETF-keys.
Constructors
public init()
Creates a new key.
Config Settings (SSHKeyManager 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.SSHKeyManager Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (SSHKeyManager Module)
SSHKeyManager 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) | |
34603009 Invalid key (SB_ERROR_SSH_INVALID_KEY) |