SSHKeyManager Class
Properties Methods Events Configuration Settings Errors
The SSHKeyManager class 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 class 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. |
| Key | The key which is currently being processed. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| 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. |
| ExportToStream | Writes the key to a stream. |
| 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. |
| ImportFromStream | Loads key from stream. |
| 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 class 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. |
Configuration Settings
The following is a list of configuration settings for the class 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 class (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. |
| UseOwnDNSResolver | Specifies whether the client classes 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. |