# SSHClient Class The SSHClient class provides client-side SSH protocol functionality. ## Class Name **SecureBlackbox_SSHClient** ## Procedural Interface ```text secureblackbox_sshclient_open(); secureblackbox_sshclient_close($res); secureblackbox_sshclient_register_callback($res, $id, $function); secureblackbox_sshclient_get_last_error($res); secureblackbox_sshclient_get_last_error_code($res); secureblackbox_sshclient_set($res, $id, $index, $value); secureblackbox_sshclient_get($res, $id, $index); secureblackbox_sshclient_do_config($res, $configurationstring); secureblackbox_sshclient_do_connect($res, $address, $port); secureblackbox_sshclient_do_connectandexec($res, $address, $port, $command, $wantstdout, $wantstderr); secureblackbox_sshclient_do_disconnect($res); secureblackbox_sshclient_do_doaction($res, $actionid, $actionparams); secureblackbox_sshclient_do_ping($res); secureblackbox_sshclient_do_poll($res, $milliseconds); secureblackbox_sshclient_do_receive($res); secureblackbox_sshclient_do_receivebytes($res, $maxlen); secureblackbox_sshclient_do_receivebytesfrom($res, $channel, $maxlen); secureblackbox_sshclient_do_receivefrom($res, $channel); secureblackbox_sshclient_do_reset($res); secureblackbox_sshclient_do_send($res, $datastr, $addeol); secureblackbox_sshclient_do_sendbytes($res, $data); secureblackbox_sshclient_do_sendspecial($res, $specialchar); ``` ## Remarks Use SSHClient to establish terminal-like connections to remote systems and run commands remotely. The component supports most of third-party implementations out there, and is capable of working in "shell" and "command" modes. Start with assigning your sign-in credentials to [Username](#username-property-secureblackbox_sshclient-class) and [Password](#password-property-secureblackbox_sshclient-class) properties. Where public key authentication is to be used, assign your private authentication key to Key property (remember to set [Username](#username-property-secureblackbox_sshclient-class) in this case too). Subscribe to events to be notified of the session progress. [AuthFailed](#authfailed-event-secureblackbox_sshclient-class), [AuthSucceeded](#authsucceeded-event-secureblackbox_sshclient-class), and [Connect](#connect-event-secureblackbox_sshclient-class) are among those particularly useful. Special attention should be paid to setting up the server key trust. Class only allows connections to servers whose public keys are recognized as trusted, much like any other SSH clients do. Assign a path to the file containing the list of trusted keys to [TrustedKeysFile](#trustedkeysfile-property-secureblackbox_sshclient-class) property. If you don't have such file, or if you would like to make trust decisions on the fly, subscribe to [KnownKeyReceived](#knownkeyreceived-event-secureblackbox_sshclient-class) and [UnknownKeyReceived](#unknownkeyreceived-event-secureblackbox_sshclient-class) events. These are fired whenever a trusted or untrusted key is received from the server. For unknown/untrusted keys, you need to set the Action parameter in your [UnknownKeyReceived](#unknownkeyreceived-event-secureblackbox_sshclient-class) event handler to catAcceptOnce (1) or catAcceptPermanently (2) for the connection to proceed. Once you are all set up, you can go ahead by calling the [Connect](#connect-method-secureblackbox_sshclient-class) method. This launches the SSH handshake and, if everything has been set up right, establishes a connection to the server. You can now use [Send](#send-method-secureblackbox_sshclient-class) and [Receive](#receive-method-secureblackbox_sshclient-class) methods to exchange information with the server. You can exchange data in synchronous or asynchronous way; see the description in [AsyncMode](#asyncmode-property-secureblackbox_sshclient-class) topic to learn more about each mode. When you are done with the session, call [Disconnect](#disconnect-method-secureblackbox_sshclient-class) to shut the connection down. Hint: If you are only interested in a quick-and-dirty execution of a simple, non-interactive command, SSHClient offers a handy shortcut. [ConnectAndExec](#connectandexec-method-secureblackbox_sshclient-class) method is a self-contained mechanism which sets up a connection, performs the data exchange internally, and returns the command output. Please keep in mind that you still need to set up the server trust settings as described above for this method to work. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AsyncMode](#asyncmode-property-secureblackbox_sshclient-class) | Controls the SSH clients mode of work. | | [AuthAttempts](#authattempts-property-secureblackbox_sshclient-class) | Specifies the number of SSH password authentication attempts. | | [Commands](#commands-property-secureblackbox_sshclient-class) | Specifies the list of commands to execute. | | [Connected](#connected-property-secureblackbox_sshclient-class) | Specifies whether the client is connected to the SFTP server. | | [ConnInfoClientKeyAlgorithm](#conninfoclientkeyalgorithm-property-secureblackbox_sshclient-class) | Specifies the client's key algorithm. | | [ConnInfoClientKeyBits](#conninfoclientkeybits-property-secureblackbox_sshclient-class) | Specifies the length of the client's key. | | [ConnInfoClientKeyFingerprint](#conninfoclientkeyfingerprint-property-secureblackbox_sshclient-class) | The fingerprint (hash value) of the client's public key. | | [ConnInfoCloseReason](#conninfoclosereason-property-secureblackbox_sshclient-class) | Contains the line sent by the server just before closing the connection. | | [ConnInfoCompressionAlgorithmInbound](#conninfocompressionalgorithminbound-property-secureblackbox_sshclient-class) | Compression algorithm for the incoming traffic. | | [ConnInfoCompressionAlgorithmOutbound](#conninfocompressionalgorithmoutbound-property-secureblackbox_sshclient-class) | Compression algorithm for the outgoing traffic. | | [ConnInfoEncryptionAlgorithmInbound](#conninfoencryptionalgorithminbound-property-secureblackbox_sshclient-class) | Encryption algorithm for the incoming traffic. | | [ConnInfoEncryptionAlgorithmOutbound](#conninfoencryptionalgorithmoutbound-property-secureblackbox_sshclient-class) | Encryption algorithm for the outgoing traffic. | | [ConnInfoInboundEncryptionKeyBits](#conninfoinboundencryptionkeybits-property-secureblackbox_sshclient-class) | Specifies the length of the key used to encrypt the incoming traffic. | | [ConnInfoKexAlgorithm](#conninfokexalgorithm-property-secureblackbox_sshclient-class) | The key exchange algorithm used during the SSH handshake. | | [ConnInfoKexBits](#conninfokexbits-property-secureblackbox_sshclient-class) | The number of bits used by the key exchange algorithm. | | [ConnInfoKexLines](#conninfokexlines-property-secureblackbox_sshclient-class) | The contents of the received KexInit packet. | | [ConnInfoMacAlgorithmInbound](#conninfomacalgorithminbound-property-secureblackbox_sshclient-class) | MAC algorithm used for the incoming connection. | | [ConnInfoMacAlgorithmOutbound](#conninfomacalgorithmoutbound-property-secureblackbox_sshclient-class) | MAC algorithm used for outbound connection. | | [ConnInfoOutboundEncryptionKeyBits](#conninfooutboundencryptionkeybits-property-secureblackbox_sshclient-class) | Specifies the length of the key used to encrypt the outgoing traffic. | | [ConnInfoPublicKeyAlgorithm](#conninfopublickeyalgorithm-property-secureblackbox_sshclient-class) | Specifies the public key algorithm which was used during the SSH handshake. | | [ConnInfoRemoteAddress](#conninforemoteaddress-property-secureblackbox_sshclient-class) | The client's IP address. | | [ConnInfoRemotePort](#conninforemoteport-property-secureblackbox_sshclient-class) | The remote port of the client connection. | | [ConnInfoRemoteSoftwareName](#conninforemotesoftwarename-property-secureblackbox_sshclient-class) | Returns the name (self-advertised) of the SSH software running on the other side. | | [ConnInfoServerKeyAlgorithm](#conninfoserverkeyalgorithm-property-secureblackbox_sshclient-class) | Specifies the server's key algorithm. | | [ConnInfoServerKeyBits](#conninfoserverkeybits-property-secureblackbox_sshclient-class) | Specifies the number of bits in the server's key. | | [ConnInfoServerKeyFingerprint](#conninfoserverkeyfingerprint-property-secureblackbox_sshclient-class) | The fingerprint (hash value) of the server's public key. | | [ConnInfoTotalBytesReceived](#conninfototalbytesreceived-property-secureblackbox_sshclient-class) | Returns the total number of bytes received over this connection. | | [ConnInfoTotalBytesSent](#conninfototalbytessent-property-secureblackbox_sshclient-class) | Returns the total number of bytes sent over this connection. | | [ConnInfoVersion](#conninfoversion-property-secureblackbox_sshclient-class) | Specifies SSH protocol version. | | [ExitMessage](#exitmessage-property-secureblackbox_sshclient-class) | Contains the last commands exit message. | | [ExitSignal](#exitsignal-property-secureblackbox_sshclient-class) | Contains the last commands exit signal. | | [ExitStatus](#exitstatus-property-secureblackbox_sshclient-class) | Contains the last commands exit status. | | [ExternalCryptoAsyncDocumentID](#externalcryptoasyncdocumentid-property-secureblackbox_sshclient-class) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [ExternalCryptoCustomParams](#externalcryptocustomparams-property-secureblackbox_sshclient-class) | Custom parameters to be passed to the signing service (uninterpreted). | | [ExternalCryptoData](#externalcryptodata-property-secureblackbox_sshclient-class) | Additional data to be included in the async state and mirrored back by the requestor. | | [ExternalCryptoExternalHashCalculation](#externalcryptoexternalhashcalculation-property-secureblackbox_sshclient-class) | Specifies whether the message hash is to be calculated at the external endpoint. | | [ExternalCryptoHashAlgorithm](#externalcryptohashalgorithm-property-secureblackbox_sshclient-class) | Specifies the request's signature hash algorithm. | | [ExternalCryptoKeyID](#externalcryptokeyid-property-secureblackbox_sshclient-class) | The ID of the pre-shared key used for DC request authentication. | | [ExternalCryptoKeySecret](#externalcryptokeysecret-property-secureblackbox_sshclient-class) | The pre-shared key used for DC request authentication. | | [ExternalCryptoMethod](#externalcryptomethod-property-secureblackbox_sshclient-class) | Specifies the asynchronous signing method. | | [ExternalCryptoMode](#externalcryptomode-property-secureblackbox_sshclient-class) | Specifies the external cryptography mode. | | [ExternalCryptoPublicKeyAlgorithm](#externalcryptopublickeyalgorithm-property-secureblackbox_sshclient-class) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [FIPSMode](#fipsmode-property-secureblackbox_sshclient-class) | Reserved. | | [KeyFingerprintSHA1](#keyfingerprintsha1-property-secureblackbox_sshclient-class) | Contains the SHA-1 fingerprint (hash) of the key. | | [KeyFingerprintSHA256](#keyfingerprintsha256-property-secureblackbox_sshclient-class) | Contains the SHA-256 fingerprint (hash) of the key. | | [KeyHandle](#keyhandle-property-secureblackbox_sshclient-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [Password](#password-property-secureblackbox_sshclient-class) | Specifies user's password on the server. | | [ProxySettingsAddress](#proxysettingsaddress-property-secureblackbox_sshclient-class) | The IP address of the proxy server. | | [ProxySettingsAuthentication](#proxysettingsauthentication-property-secureblackbox_sshclient-class) | The authentication type used by the proxy server. | | [ProxySettingsPassword](#proxysettingspassword-property-secureblackbox_sshclient-class) | The password to authenticate to the proxy server. | | [ProxySettingsPort](#proxysettingsport-property-secureblackbox_sshclient-class) | The port on the proxy server to connect to. | | [ProxySettingsProxyType](#proxysettingsproxytype-property-secureblackbox_sshclient-class) | The type of the proxy server. | | [ProxySettingsRequestHeaders](#proxysettingsrequestheaders-property-secureblackbox_sshclient-class) | Contains HTTP request headers for WebTunnel and HTTP proxy. | | [ProxySettingsResponseBody](#proxysettingsresponsebody-property-secureblackbox_sshclient-class) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. | | [ProxySettingsResponseHeaders](#proxysettingsresponseheaders-property-secureblackbox_sshclient-class) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. | | [ProxySettingsUseIPv6](#proxysettingsuseipv6-property-secureblackbox_sshclient-class) | Specifies whether IPv6 should be used when connecting through the proxy. | | [ProxySettingsUsername](#proxysettingsusername-property-secureblackbox_sshclient-class) | Specifies the username credential for proxy authentication. | | [ServerKeyAlgorithm](#serverkeyalgorithm-property-secureblackbox_sshclient-class) | Specifies the key algorithm. | | [ServerKeyBits](#serverkeybits-property-secureblackbox_sshclient-class) | The number of bits in the key: the more the better, 2048 or 4096 are typical values. | | [ServerKeyComment](#serverkeycomment-property-secureblackbox_sshclient-class) | The comment for the public key. | | [ServerKeyCurve](#serverkeycurve-property-secureblackbox_sshclient-class) | Specifies the elliptical curve when EC cryptography is used. | | [ServerKeyExtractable](#serverkeyextractable-property-secureblackbox_sshclient-class) | Whether the key is extractable (e. | | [ServerKeyFingerprintMD5](#serverkeyfingerprintmd5-property-secureblackbox_sshclient-class) | Contains the MD5 fingerprint (hash) of the key. | | [ServerKeyFingerprintSHA1](#serverkeyfingerprintsha1-property-secureblackbox_sshclient-class) | Contains the SHA-1 fingerprint (hash) of the key. | | [ServerKeyFingerprintSHA256](#serverkeyfingerprintsha256-property-secureblackbox_sshclient-class) | Contains the SHA-256 fingerprint (hash) of the key. | | [ServerKeyHandle](#serverkeyhandle-property-secureblackbox_sshclient-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [ServerKeyKeyFormat](#serverkeykeyformat-property-secureblackbox_sshclient-class) | Specifies the format in which the key is stored. | | [ServerKeyKeyProtectionAlgorithm](#serverkeykeyprotectionalgorithm-property-secureblackbox_sshclient-class) | Specifies the key protection algorithm. | | [ServerKeyPrivate](#serverkeyprivate-property-secureblackbox_sshclient-class) | Whether this key is a private key or not. | | [ServerKeyPublic](#serverkeypublic-property-secureblackbox_sshclient-class) | Whether this key is a public key or not. | | [ServerKeySubject](#serverkeysubject-property-secureblackbox_sshclient-class) | Specifies the public key owner (subject). | | [SocketDNSMode](#socketdnsmode-property-secureblackbox_sshclient-class) | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. | | [SocketDNSPort](#socketdnsport-property-secureblackbox_sshclient-class) | Specifies the port number to be used for sending queries to the DNS server. | | [SocketDNSQueryTimeout](#socketdnsquerytimeout-property-secureblackbox_sshclient-class) | The timeout (in milliseconds) for each DNS query. | | [SocketDNSServers](#socketdnsservers-property-secureblackbox_sshclient-class) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. | | [SocketDNSTotalTimeout](#socketdnstotaltimeout-property-secureblackbox_sshclient-class) | The timeout (in milliseconds) for the whole resolution process. | | [SocketIncomingSpeedLimit](#socketincomingspeedlimit-property-secureblackbox_sshclient-class) | The maximum number of bytes to read from the socket, per second. | | [SocketLocalAddress](#socketlocaladdress-property-secureblackbox_sshclient-class) | The local network interface to bind the socket to. | | [SocketLocalPort](#socketlocalport-property-secureblackbox_sshclient-class) | The local port number to bind the socket to. | | [SocketOutgoingSpeedLimit](#socketoutgoingspeedlimit-property-secureblackbox_sshclient-class) | The maximum number of bytes to write to the socket, per second. | | [SocketTimeout](#sockettimeout-property-secureblackbox_sshclient-class) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [SocketUseIPv6](#socketuseipv6-property-secureblackbox_sshclient-class) | Enables or disables IP protocol version 6. | | [SSHSettingsAutoAdjustCiphers](#sshsettingsautoadjustciphers-property-secureblackbox_sshclient-class) | Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to. | | [SSHSettingsBaseConfiguration](#sshsettingsbaseconfiguration-property-secureblackbox_sshclient-class) | Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility. | | [SSHSettingsCompressionAlgorithms](#sshsettingscompressionalgorithms-property-secureblackbox_sshclient-class) | A list of session compression algorithms separated with commas or semicolons. | | [SSHSettingsCompressionLevel](#sshsettingscompressionlevel-property-secureblackbox_sshclient-class) | Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). | | [SSHSettingsDefaultWindowSize](#sshsettingsdefaultwindowsize-property-secureblackbox_sshclient-class) | The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server. | | [SSHSettingsEncryptionAlgorithms](#sshsettingsencryptionalgorithms-property-secureblackbox_sshclient-class) | A list of session encryption algorithms separated with commas or semicolons. | | [SSHSettingsForceCompression](#sshsettingsforcecompression-property-secureblackbox_sshclient-class) | Whether the SSH client should explicitly request compression. | | [SSHSettingsForwardAuthAgent](#sshsettingsforwardauthagent-property-secureblackbox_sshclient-class) | Enables or disables auth agent forwarding. | | [SSHSettingsGSSAuthTypes](#sshsettingsgssauthtypes-property-secureblackbox_sshclient-class) | A comma-separated list of authentication types. | | [SSHSettingsGSSDelegateCreds](#sshsettingsgssdelegatecreds-property-secureblackbox_sshclient-class) | Switches credential delegation on or off. | | [SSHSettingsGSSHostname](#sshsettingsgsshostname-property-secureblackbox_sshclient-class) | The GSS host name, in form of a FQDN (e. | | [SSHSettingsGSSLib](#sshsettingsgsslib-property-secureblackbox_sshclient-class) | A path to the GSS-API library (DLL or SO). | | [SSHSettingsGSSMechanisms](#sshsettingsgssmechanisms-property-secureblackbox_sshclient-class) | A comma-separated list of GSS mechanisms to use. | | [SSHSettingsGSSProtocols](#sshsettingsgssprotocols-property-secureblackbox_sshclient-class) | A comma-separated list of SSPI protocols. | | [SSHSettingsHandshakeTimeout](#sshsettingshandshaketimeout-property-secureblackbox_sshclient-class) | Specifies the maximal time for the SSH handshake to proceed, in seconds. | | [SSHSettingsKexAlgorithms](#sshsettingskexalgorithms-property-secureblackbox_sshclient-class) | A list of key exchange algorithms separated with commas or semicolons. | | [SSHSettingsMacAlgorithms](#sshsettingsmacalgorithms-property-secureblackbox_sshclient-class) | A list of MAC (for message authentication code ) algorithms separated with commas or semicolons. | | [SSHSettingsMaxSSHPacketSize](#sshsettingsmaxsshpacketsize-property-secureblackbox_sshclient-class) | Specifies the maximum length of one SSH packet in bytes. | | [SSHSettingsMinWindowSize](#sshsettingsminwindowsize-property-secureblackbox_sshclient-class) | Specifies the minimal internal window size. | | [SSHSettingsObfuscateHandshake](#sshsettingsobfuscatehandshake-property-secureblackbox_sshclient-class) | Enables or disables handshake obfuscation. | | [SSHSettingsObfuscationPassword](#sshsettingsobfuscationpassword-property-secureblackbox_sshclient-class) | Specifies the password used to encrypt the handshake when ObfuscateHandshake is set. | | [SSHSettingsPublicKeyAlgorithms](#sshsettingspublickeyalgorithms-property-secureblackbox_sshclient-class) | A list of public key algorithms separated with commas or semicolons. | | [SSHSettingsRequestPasswordChange](#sshsettingsrequestpasswordchange-property-secureblackbox_sshclient-class) | Whether to request a password change when connecting. | | [SSHSettingsSoftwareName](#sshsettingssoftwarename-property-secureblackbox_sshclient-class) | The name to be used by the class to identify itself. | | [SSHSettingsTrustAllKeys](#sshsettingstrustallkeys-property-secureblackbox_sshclient-class) | Enables or disables explicit trust to all server keys. | | [SSHSettingsUseAuthAgent](#sshsettingsuseauthagent-property-secureblackbox_sshclient-class) | Enables or disables the use of external key agent, such as Putty key agent. | | [SSHSettingsVersions](#sshsettingsversions-property-secureblackbox_sshclient-class) | Specifies enabled SSH protocol versions (1 or 2). | | [Subsystem](#subsystem-property-secureblackbox_sshclient-class) | Specifies the subsystem to request from the server. | | [TerminalCols](#terminalcols-property-secureblackbox_sshclient-class) | Specifies the width of the pseudoterminal, in characters. | | [TerminalEnvironment](#terminalenvironment-property-secureblackbox_sshclient-class) | Specifies the list of environment variables. | | [TerminalEOLChar](#terminaleolchar-property-secureblackbox_sshclient-class) | Specifies the End-of-Line character or sequence. | | [TerminalHeight](#terminalheight-property-secureblackbox_sshclient-class) | Specifies the height of the pseudoterminal, in pixels. | | [TerminalOpcodes](#terminalopcodes-property-secureblackbox_sshclient-class) | Specifies the operation codes specific for the terminal. | | [TerminalProtocol](#terminalprotocol-property-secureblackbox_sshclient-class) | The terminal protocol name. | | [TerminalRequestPty](#terminalrequestpty-property-secureblackbox_sshclient-class) | Specifies whether to request a pseudoterminal for the session. | | [TerminalRows](#terminalrows-property-secureblackbox_sshclient-class) | Specifies the height of the pseudoterminal, in lines. | | [TerminalWidth](#terminalwidth-property-secureblackbox_sshclient-class) | Specifies the width of the pseudoterminal, in pixels. | | [TrustedKeysFile](#trustedkeysfile-property-secureblackbox_sshclient-class) | Path to the file containing public keys of authorized servers. | | [Username](#username-property-secureblackbox_sshclient-class) | Specifies client's username on the server. | ## 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](#config-method-secureblackbox_sshclient-class) | Sets or retrieves a configuration setting. | | [Connect](#connect-method-secureblackbox_sshclient-class) | Establishes connection to an SSH server. | | [ConnectAndExec](#connectandexec-method-secureblackbox_sshclient-class) | Connects to an SSH server and executes a command in one go. | | [Disconnect](#disconnect-method-secureblackbox_sshclient-class) | Closes connection to the SSH server. | | [DoAction](#doaction-method-secureblackbox_sshclient-class) | Performs an additional action. | | [Ping](#ping-method-secureblackbox_sshclient-class) | Sends a keep-alive request to the SSH server. | | [Poll](#poll-method-secureblackbox_sshclient-class) | Checks whether there is any inbound data readily available. | | [Receive](#receive-method-secureblackbox_sshclient-class) | Reads a portion of received data into a string. | | [ReceiveBytes](#receivebytes-method-secureblackbox_sshclient-class) | Reads a portion of received data into a byte array. | | [ReceiveBytesFrom](#receivebytesfrom-method-secureblackbox_sshclient-class) | Reads a portion of data received via a specific channel into a byte array. | | [ReceiveFrom](#receivefrom-method-secureblackbox_sshclient-class) | Reads a portion of data received via a specific channel into a string. | | [Reset](#reset-method-secureblackbox_sshclient-class) | Resets the class settings. | | [Send](#send-method-secureblackbox_sshclient-class) | Sends a string to the server. | | [SendBytes](#sendbytes-method-secureblackbox_sshclient-class) | Sends an array of bytes to the server. | | [SendSpecial](#sendspecial-method-secureblackbox_sshclient-class) | Sends a special character to the server or remote command. | ## 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.* | | | | --- | --- | | [AuthAttempt](#authattempt-event-secureblackbox_sshclient-class) | Fires when a single authentication attempt is performed. | | [AuthFailed](#authfailed-event-secureblackbox_sshclient-class) | Fires when a single authentication attempt is failed. | | [AuthSucceeded](#authsucceeded-event-secureblackbox_sshclient-class) | Reports a successful authentication. | | [Banner](#banner-event-secureblackbox_sshclient-class) | Reports the receipt of the Hello message from the server. | | [CommandCompleted](#commandcompleted-event-secureblackbox_sshclient-class) | Signifies completion of the command execution. | | [CommandStart](#commandstart-event-secureblackbox_sshclient-class) | Marks the commencement of a command execution. | | [Connect](#connect-event-secureblackbox_sshclient-class) | This event is fired when an SSH session has been established. | | [DataReceived](#datareceived-event-secureblackbox_sshclient-class) | Reports receipt of another chunk of data from the server. | | [DataSent](#datasent-event-secureblackbox_sshclient-class) | Notifies the application that a piece of data has been sent to the server. | | [Disconnect](#disconnect-event-secureblackbox_sshclient-class) | This event is fired when the SFTP subsystem connection is closed. | | [Error](#error-event-secureblackbox_sshclient-class) | Information about errors during SFTP connection. | | [ExternalSign](#externalsign-event-secureblackbox_sshclient-class) | Handles remote or external signing initiated by the SignExternal method or other source. | | [KnownKeyReceived](#knownkeyreceived-event-secureblackbox_sshclient-class) | Signals that the server has introduced itself with a known key. | | [Notification](#notification-event-secureblackbox_sshclient-class) | This event notifies the application about an underlying control flow event. | | [PasswordChangeRequest](#passwordchangerequest-event-secureblackbox_sshclient-class) | This event is fired when a password change is requested. | | [PrivateKeyNeeded](#privatekeyneeded-event-secureblackbox_sshclient-class) | This event is fired when client's public key was accepted by the server, but the corresponding secret key is not available. | | [UnknownKeyReceived](#unknownkeyreceived-event-secureblackbox_sshclient-class) | Signals that the server has introduced itself with an unknown key. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AllAlgorithms](#AllAlgorithms) | Returns the list of algorithms enabled in the class. | | [BlockSize](#BlockSize) | The data block size. | | [CommandTimeout](#CommandTimeout) | Specifies the command timeout. | | [CompressionAlgorithms](#CompressionAlgorithms) | Returns the list of compression algorithms enabled in the class. | | [EarlyIdString](#EarlyIdString) | Enables the proactive approach to SSH handshake. | | [EncryptionAlgorithms](#EncryptionAlgorithms) | Returns the list of encryption algorithms enabled in the class. | | [ErrorOrigin](#ErrorOrigin) | Specifies whether the error is local or remote. | | [ErrorSeverity](#ErrorSeverity) | Specifies whether the error is fatal. | | [KexAlgorithms](#KexAlgorithms) | Returns the list of key exchange algorithms enabled in the class. | | [LocalCharset](#LocalCharset) | Charset used on the client machine. | | [MacAlgorithms](#MacAlgorithms) | Returns the list of MAC algorithms enabled in the class. | | [PublicKeyAlgorithms](#PublicKeyAlgorithms) | Returns the list of public key algorithms enabled in the class. | | [RemoteCharset](#RemoteCharset) | Charset used on the server. | | [SendCommandEOF](#SendCommandEOF) | Defines whether EOF control character should be sent after the command data. | | [ThrottleControl](#ThrottleControl) | Enables or disables throttle control for the connection. | | [UseStrictKeyExchange](#UseStrictKeyExchange) | Specifies how strict key exchange is supported. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # AsyncMode Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Controls the SSH clients mode of work. ## Object Oriented Interface ```text public function getAsyncMode(); public function setAsyncMode($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 1 ); secureblackbox_sshclient_set($res, 1, $value ); ``` ## Default Value false ## Remarks This property defines the way in which the class communicates with the application/user code. AsyncMode set to false makes the component use synchronous single-thread approach. Synchronous mode is generally simpler to integrate and use, but please keep in mind that the calls like [Connect](#connect-method-secureblackbox_sshclient-class), [Receive](#receive-method-secureblackbox_sshclient-class) or [SendBytes](#sendbytes-method-secureblackbox_sshclient-class) may block until their execution completes. In asynchronous mode all operations return immediately, but more care should be taken about handling them in your code properly. Here are a few highlights of each mode. Synchronous mode: - All operations are performed within the caller thread context - Operations like [Connect](#connect-method-secureblackbox_sshclient-class) or [SendBytes](#sendbytes-method-secureblackbox_sshclient-class) may block - Use [Poll](#poll-method-secureblackbox_sshclient-class) to check for the availability of data before reading it out with [Receive](#receive-method-secureblackbox_sshclient-class) or [ReceiveBytes](#receivebytes-method-secureblackbox_sshclient-class) - Return of a call guarantees completion of the operation - Connection errors are reported straight from the methods via exceptions Asynchronous mode: - All operations are performed in a separate thread (and so are the event calls!) - Methods like [Send](#send-method-secureblackbox_sshclient-class) return immediately - Use [DataSent](#datasent-event-secureblackbox_sshclient-class) and [DataReceived](#datareceived-event-secureblackbox_sshclient-class) events to be notified about actual data transmissions - Return of call only marks the beginning of the operation and does not guarantee its successful completion - Connection errors are reported via [Error](#error-event-secureblackbox_sshclient-class) event, often followed by [Disconnect](#disconnect-event-secureblackbox_sshclient-class). Please note that this is a very important and sensitive property, which has a wide-scale effect on the way the SSH client works and co-operates with the application. Depending on the value assigned to this setting you may need to work with the component very differently. When setting this property to true, please make sure that your code is prepared to handle events coming from the context of a different thread. ## Data Type Boolean # AuthAttempts Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the number of SSH password authentication attempts. ## Object Oriented Interface ```text public function getAuthAttempts(); public function setAuthAttempts($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 2 ); secureblackbox_sshclient_set($res, 2, $value ); ``` ## Default Value 1 ## Remarks In case of password authentication failure provide new password inside the [AuthFailed](#authfailed-event-secureblackbox_sshclient-class) event handler. ## Data Type Integer # Commands Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the list of commands to execute. ## Object Oriented Interface ```text public function getCommands(); public function setCommands($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 3 ); secureblackbox_sshclient_set($res, 3, $value ); ``` ## Default Value '' ## Remarks Use this property to provide a list of commands to execute remotely. Separate different commands with EOL characters. When this property is set, the component works in the command mode, meaning each command is executed in its own virtual terminal session. No shell connection is established. If no commands are provided via this property, the component will establish a shell session. ## Data Type String # Connected Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies whether the client is connected to the SFTP server. ## Object Oriented Interface ```text public function getConnected(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 4 ); ``` ## Default Value false ## Remarks Use this read-only property to check whether the client is connected to the server. This property is read-only. ## Data Type Boolean # ConnInfoClientKeyAlgorithm Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the client's key algorithm. ## Object Oriented Interface ```text public function getConnInfoClientKeyAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 5 ); ``` ## Default Value '' ## Remarks Specifies the client's key algorithm. This property is read-only and not available at design time. ## Data Type String # ConnInfoClientKeyBits Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the length of the client's key. ## Object Oriented Interface ```text public function getConnInfoClientKeyBits(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 6 ); ``` ## Default Value 0 ## Remarks Specifies the length of the client's key. This property is read-only and not available at design time. ## Data Type Integer # ConnInfoClientKeyFingerprint Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The fingerprint (hash value) of the client's public key. ## Object Oriented Interface ```text public function getConnInfoClientKeyFingerprint(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 7 ); ``` ## Default Value '' ## Remarks The fingerprint (hash value) of the client's public key. This property is read-only and not available at design time. ## Data Type String # ConnInfoCloseReason Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains the line sent by the server just before closing the connection. ## Object Oriented Interface ```text public function getConnInfoCloseReason(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 8 ); ``` ## Default Value '' ## Remarks Contains the line sent by the server just before closing the connection. It might contain the error description if the connection was not closed gracefully. This property is read-only and not available at design time. ## Data Type String # ConnInfoCompressionAlgorithmInbound Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Compression algorithm for the incoming traffic. ## Object Oriented Interface ```text public function getConnInfoCompressionAlgorithmInbound(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 9 ); ``` ## Default Value '' ## Remarks Compression algorithm for the incoming traffic. This property is read-only and not available at design time. ## Data Type String # ConnInfoCompressionAlgorithmOutbound Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Compression algorithm for the outgoing traffic. ## Object Oriented Interface ```text public function getConnInfoCompressionAlgorithmOutbound(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 10 ); ``` ## Default Value '' ## Remarks Compression algorithm for the outgoing traffic. This property is read-only and not available at design time. ## Data Type String # ConnInfoEncryptionAlgorithmInbound Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Encryption algorithm for the incoming traffic. ## Object Oriented Interface ```text public function getConnInfoEncryptionAlgorithmInbound(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 11 ); ``` ## Default Value '' ## Remarks Encryption algorithm for the incoming traffic. This property is read-only and not available at design time. ## Data Type String # ConnInfoEncryptionAlgorithmOutbound Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Encryption algorithm for the outgoing traffic. ## Object Oriented Interface ```text public function getConnInfoEncryptionAlgorithmOutbound(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 12 ); ``` ## Default Value '' ## Remarks Encryption algorithm for the outgoing traffic. This property is read-only and not available at design time. ## Data Type String # ConnInfoInboundEncryptionKeyBits Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the length of the key used to encrypt the incoming traffic. ## Object Oriented Interface ```text public function getConnInfoInboundEncryptionKeyBits(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 13 ); ``` ## Default Value 0 ## Remarks Specifies the length of the key used to encrypt the incoming traffic. This property is read-only and not available at design time. ## Data Type Integer # ConnInfoKexAlgorithm Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The key exchange algorithm used during the SSH handshake. ## Object Oriented Interface ```text public function getConnInfoKexAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 14 ); ``` ## Default Value '' ## Remarks The key exchange algorithm used during the SSH handshake. This property is read-only and not available at design time. ## Data Type String # ConnInfoKexBits Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The number of bits used by the key exchange algorithm. ## Object Oriented Interface ```text public function getConnInfoKexBits(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 15 ); ``` ## Default Value 0 ## Remarks The number of bits used by the key exchange algorithm. This property is read-only and not available at design time. ## Data Type Integer # ConnInfoKexLines Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The contents of the received KexInit packet. ## Object Oriented Interface ```text public function getConnInfoKexLines(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 16 ); ``` ## Default Value '' ## Remarks The contents of the received KexInit packet. KexInit packet contains the list of algorithms supported by the remote party. This property is read-only and not available at design time. ## Data Type String # ConnInfoMacAlgorithmInbound Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) MAC algorithm used for the incoming connection. ## Object Oriented Interface ```text public function getConnInfoMacAlgorithmInbound(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 17 ); ``` ## Default Value '' ## Remarks MAC algorithm used for the incoming connection. This property is read-only and not available at design time. ## Data Type String # ConnInfoMacAlgorithmOutbound Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) MAC algorithm used for outbound connection. ## Object Oriented Interface ```text public function getConnInfoMacAlgorithmOutbound(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 18 ); ``` ## Default Value '' ## Remarks MAC algorithm used for outbound connection. This property is read-only and not available at design time. ## Data Type String # ConnInfoOutboundEncryptionKeyBits Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the length of the key used to encrypt the outgoing traffic. ## Object Oriented Interface ```text public function getConnInfoOutboundEncryptionKeyBits(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 19 ); ``` ## Default Value 0 ## Remarks Specifies the length of the key used to encrypt the outgoing traffic. This property is read-only and not available at design time. ## Data Type Integer # ConnInfoPublicKeyAlgorithm Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the public key algorithm which was used during the SSH handshake. ## Object Oriented Interface ```text public function getConnInfoPublicKeyAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 20 ); ``` ## Default Value '' ## Remarks Specifies the public key algorithm which was used during the SSH handshake. This property is read-only and not available at design time. ## Data Type String # ConnInfoRemoteAddress Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The client's IP address. ## Object Oriented Interface ```text public function getConnInfoRemoteAddress(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 21 ); ``` ## Default Value '' ## Remarks The client's IP address. This property is read-only and not available at design time. ## Data Type String # ConnInfoRemotePort Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The remote port of the client connection. ## Object Oriented Interface ```text public function getConnInfoRemotePort(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 22 ); ``` ## Default Value 0 ## Remarks The remote port of the client connection. This property is read-only and not available at design time. ## Data Type Integer # ConnInfoRemoteSoftwareName Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Returns the name (self-advertised) of the SSH software running on the other side. ## Object Oriented Interface ```text public function getConnInfoRemoteSoftwareName(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 23 ); ``` ## Default Value '' ## Remarks Returns the name (self-advertised) of the SSH software running on the other side. This property is read-only and not available at design time. ## Data Type String # ConnInfoServerKeyAlgorithm Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the server's key algorithm. ## Object Oriented Interface ```text public function getConnInfoServerKeyAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 24 ); ``` ## Default Value '' ## Remarks Specifies the server's key algorithm. This property is read-only and not available at design time. ## Data Type String # ConnInfoServerKeyBits Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the number of bits in the server's key. ## Object Oriented Interface ```text public function getConnInfoServerKeyBits(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 25 ); ``` ## Default Value 0 ## Remarks Specifies the number of bits in the server's key. This property is read-only and not available at design time. ## Data Type Integer # ConnInfoServerKeyFingerprint Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The fingerprint (hash value) of the server's public key. ## Object Oriented Interface ```text public function getConnInfoServerKeyFingerprint(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 26 ); ``` ## Default Value '' ## Remarks The fingerprint (hash value) of the server's public key. This property is read-only and not available at design time. ## Data Type String # ConnInfoTotalBytesReceived Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Returns the total number of bytes received over this connection. ## Object Oriented Interface ```text public function getConnInfoTotalBytesReceived(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 27 ); ``` ## Default Value 0 ## Remarks Returns the total number of bytes received over this connection. This property is read-only and not available at design time. ## Data Type Long64 # ConnInfoTotalBytesSent Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Returns the total number of bytes sent over this connection. ## Object Oriented Interface ```text public function getConnInfoTotalBytesSent(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 28 ); ``` ## Default Value 0 ## Remarks Returns the total number of bytes sent over this connection. This property is read-only and not available at design time. ## Data Type Long64 # ConnInfoVersion Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies SSH protocol version. ## Object Oriented Interface ```text public function getConnInfoVersion(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 29 ); ``` ## Default Value 2 ## Remarks Specifies SSH protocol version. This property is read-only and not available at design time. ## Data Type Integer # ExitMessage Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains the last commands exit message. ## Object Oriented Interface ```text public function getExitMessage(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 30 ); ``` ## Default Value '' ## Remarks Use this property to access the exit message of the last command or shell session. This property normally gets assigned if the command or shell was closed due to an error. This property is read-only and not available at design time. ## Data Type String # ExitSignal Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains the last commands exit signal. ## Object Oriented Interface ```text public function getExitSignal(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 31 ); ``` ## Default Value '' ## Remarks Use this property to access the exit signal of the last command or shell session. This property normally gets assigned if the command or shell was closed due to an error. This property is read-only and not available at design time. ## Data Type String # ExitStatus Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains the last commands exit status. ## Object Oriented Interface ```text public function getExitStatus(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 32 ); ``` ## Default Value 0 ## Remarks Check this property to obtain the exit status (also sometimes referred to as errorlevel) of the last command or shell session. This property is read-only and not available at design time. ## Data Type Integer # ExternalCryptoAsyncDocumentID Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Object Oriented Interface ```text public function getExternalCryptoAsyncDocumentID(); public function setExternalCryptoAsyncDocumentID($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 33 ); secureblackbox_sshclient_set($res, 33, $value ); ``` ## Default Value '' ## Remarks Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. ## Data Type String # ExternalCryptoCustomParams Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Custom parameters to be passed to the signing service (uninterpreted). ## Object Oriented Interface ```text public function getExternalCryptoCustomParams(); public function setExternalCryptoCustomParams($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 34 ); secureblackbox_sshclient_set($res, 34, $value ); ``` ## Default Value '' ## Remarks Custom parameters to be passed to the signing service (uninterpreted). This property is not available at design time. ## Data Type String # ExternalCryptoData Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Additional data to be included in the async state and mirrored back by the requestor. ## Object Oriented Interface ```text public function getExternalCryptoData(); public function setExternalCryptoData($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 35 ); secureblackbox_sshclient_set($res, 35, $value ); ``` ## Default Value '' ## Remarks Additional data to be included in the async state and mirrored back by the requestor. This property is not available at design time. ## Data Type String # ExternalCryptoExternalHashCalculation Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies whether the message hash is to be calculated at the external endpoint. ## Object Oriented Interface ```text public function getExternalCryptoExternalHashCalculation(); public function setExternalCryptoExternalHashCalculation($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 36 ); secureblackbox_sshclient_set($res, 36, $value ); ``` ## Default Value false ## Remarks Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. ## Data Type Boolean # ExternalCryptoHashAlgorithm Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the request's signature hash algorithm. ## Object Oriented Interface ```text public function getExternalCryptoHashAlgorithm(); public function setExternalCryptoHashAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 37 ); secureblackbox_sshclient_set($res, 37, $value ); ``` ## Default Value 'SHA256' ## Remarks Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | 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 | | ## Data Type String # ExternalCryptoKeyID Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The ID of the pre-shared key used for DC request authentication. ## Object Oriented Interface ```text public function getExternalCryptoKeyID(); public function setExternalCryptoKeyID($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 38 ); secureblackbox_sshclient_set($res, 38, $value ); ``` ## Default Value '' ## Remarks The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [ExternalCryptoKeySecret](#externalcryptokeysecret-property-secureblackbox_sshclient-class) to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` ## Data Type String # ExternalCryptoKeySecret Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The pre-shared key used for DC request authentication. ## Object Oriented Interface ```text public function getExternalCryptoKeySecret(); public function setExternalCryptoKeySecret($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 39 ); secureblackbox_sshclient_set($res, 39, $value ); ``` ## Default Value '' ## Remarks The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the [ExternalCryptoKeyID](#externalcryptokeyid-property-secureblackbox_sshclient-class) topic. ## Data Type String # ExternalCryptoMethod Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the asynchronous signing method. ## Object Oriented Interface ```text public function getExternalCryptoMethod(); public function setExternalCryptoMethod($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 40 ); secureblackbox_sshclient_set($res, 40, $value ); ``` ## Possible Values ```text SSHCLIENT_EXTERNALCRYPTOMETHOD_PKCS1(0), SSHCLIENT_EXTERNALCRYPTOMETHOD_PKCS7(1) ``` ## Default Value 0 ## Remarks Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | ## Data Type Integer # ExternalCryptoMode Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the external cryptography mode. ## Object Oriented Interface ```text public function getExternalCryptoMode(); public function setExternalCryptoMode($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 41 ); secureblackbox_sshclient_set($res, 41, $value ); ``` ## Possible Values ```text SSHCLIENT_EXTERNALCRYPTOMODE_DEFAULT(0), SSHCLIENT_EXTERNALCRYPTOMODE_DISABLED(1), SSHCLIENT_EXTERNALCRYPTOMODE_GENERIC(2), SSHCLIENT_EXTERNALCRYPTOMODE_DCAUTH(3), SSHCLIENT_EXTERNALCRYPTOMODE_DCAUTH_JSON(4) ``` ## Default Value 0 ## Remarks Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | This property is not available at design time. ## Data Type Integer # ExternalCryptoPublicKeyAlgorithm Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Object Oriented Interface ```text public function getExternalCryptoPublicKeyAlgorithm(); public function setExternalCryptoPublicKeyAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 42 ); secureblackbox_sshclient_set($res, 42, $value ); ``` ## Default Value '' ## Remarks Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | 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 | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | ## Data Type String # FIPSMode Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Reserved. ## Object Oriented Interface ```text public function getFIPSMode(); public function setFIPSMode($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 43 ); secureblackbox_sshclient_set($res, 43, $value ); ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type Boolean # KeyFingerprintSHA1 Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains the SHA-1 fingerprint (hash) of the key. ## Object Oriented Interface ```text public function getKeyFingerprintSHA1(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 50 ); ``` ## Default Value '' ## Remarks Contains the SHA-1 fingerprint (hash) of the key. This property is read-only. ## Data Type String # KeyFingerprintSHA256 Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains the SHA-256 fingerprint (hash) of the key. ## Object Oriented Interface ```text public function getKeyFingerprintSHA256(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 51 ); ``` ## Default Value '' ## Remarks Contains the SHA-256 fingerprint (hash) of the key. This property is read-only. ## Data Type String # KeyHandle Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getKeyHandle(); public function setKeyHandle($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 52 ); secureblackbox_sshclient_set($res, 52, $value ); ``` ## Default Value 0 ## Remarks 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is not available at design time. ## Data Type Long64 # Password Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies user's password on the server. ## Object Oriented Interface ```text public function getPassword(); public function setPassword($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 58 ); secureblackbox_sshclient_set($res, 58, $value ); ``` ## Default Value '' ## Remarks Invalid password fires the [AuthFailed](#authfailed-event-secureblackbox_sshclient-class) event. ## Data Type String # ProxySettingsAddress Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The IP address of the proxy server. ## Object Oriented Interface ```text public function getProxySettingsAddress(); public function setProxySettingsAddress($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 59 ); secureblackbox_sshclient_set($res, 59, $value ); ``` ## Default Value '' ## Remarks The IP address of the proxy server. ## Data Type String # ProxySettingsAuthentication Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The authentication type used by the proxy server. ## Object Oriented Interface ```text public function getProxySettingsAuthentication(); public function setProxySettingsAuthentication($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 60 ); secureblackbox_sshclient_set($res, 60, $value ); ``` ## Possible Values ```text SSHCLIENT_PROXYSETTINGSAUTHENTICATION_NO_AUTHENTICATION(0), SSHCLIENT_PROXYSETTINGSAUTHENTICATION_BASIC(1), SSHCLIENT_PROXYSETTINGSAUTHENTICATION_DIGEST(2), SSHCLIENT_PROXYSETTINGSAUTHENTICATION_NTLM(3) ``` ## Default Value 0 ## Remarks The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | ## Data Type Integer # ProxySettingsPassword Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The password to authenticate to the proxy server. ## Object Oriented Interface ```text public function getProxySettingsPassword(); public function setProxySettingsPassword($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 61 ); secureblackbox_sshclient_set($res, 61, $value ); ``` ## Default Value '' ## Remarks The password to authenticate to the proxy server. ## Data Type String # ProxySettingsPort Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The port on the proxy server to connect to. ## Object Oriented Interface ```text public function getProxySettingsPort(); public function setProxySettingsPort($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 62 ); secureblackbox_sshclient_set($res, 62, $value ); ``` ## Default Value 0 ## Remarks The port on the proxy server to connect to. ## Data Type Integer # ProxySettingsProxyType Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The type of the proxy server. ## Object Oriented Interface ```text public function getProxySettingsProxyType(); public function setProxySettingsProxyType($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 63 ); secureblackbox_sshclient_set($res, 63, $value ); ``` ## Possible Values ```text SSHCLIENT_PROXYSETTINGSPROXYTYPE_NONE(0), SSHCLIENT_PROXYSETTINGSPROXYTYPE_SOCKS_4(1), SSHCLIENT_PROXYSETTINGSPROXYTYPE_SOCKS_5(2), SSHCLIENT_PROXYSETTINGSPROXYTYPE_WEB_TUNNEL(3), SSHCLIENT_PROXYSETTINGSPROXYTYPE_HTTP(4) ``` ## Default Value 0 ## Remarks The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | ## Data Type Integer # ProxySettingsRequestHeaders Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains HTTP request headers for WebTunnel and HTTP proxy. ## Object Oriented Interface ```text public function getProxySettingsRequestHeaders(); public function setProxySettingsRequestHeaders($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 64 ); secureblackbox_sshclient_set($res, 64, $value ); ``` ## Default Value '' ## Remarks Contains HTTP request headers for WebTunnel and HTTP proxy. ## Data Type String # ProxySettingsResponseBody Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Object Oriented Interface ```text public function getProxySettingsResponseBody(); public function setProxySettingsResponseBody($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 65 ); secureblackbox_sshclient_set($res, 65, $value ); ``` ## Default Value '' ## Remarks Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Data Type String # ProxySettingsResponseHeaders Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Object Oriented Interface ```text public function getProxySettingsResponseHeaders(); public function setProxySettingsResponseHeaders($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 66 ); secureblackbox_sshclient_set($res, 66, $value ); ``` ## Default Value '' ## Remarks Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Data Type String # ProxySettingsUseIPv6 Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies whether IPv6 should be used when connecting through the proxy. ## Object Oriented Interface ```text public function getProxySettingsUseIPv6(); public function setProxySettingsUseIPv6($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 67 ); secureblackbox_sshclient_set($res, 67, $value ); ``` ## Default Value false ## Remarks Specifies whether IPv6 should be used when connecting through the proxy. ## Data Type Boolean # ProxySettingsUsername Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the username credential for proxy authentication. ## Object Oriented Interface ```text public function getProxySettingsUsername(); public function setProxySettingsUsername($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 68 ); secureblackbox_sshclient_set($res, 68, $value ); ``` ## Default Value '' ## Remarks Specifies the username credential for proxy authentication. ## Data Type String # ServerKeyAlgorithm Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the key algorithm. ## Object Oriented Interface ```text public function getServerKeyAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 69 ); ``` ## Default Value '' ## Remarks Specifies the key algorithm. The following key algorithms are currently supported and can be returned by this property: - RSA - DSS - ECDSA - EDDSA - MLDSA - ECDSA-SK - EDDSA-SK This property is read-only and not available at design time. ## Data Type String # ServerKeyBits Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The number of bits in the key: the more the better, 2048 or 4096 are typical values. ## Object Oriented Interface ```text public function getServerKeyBits(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 70 ); ``` ## Default Value 0 ## Remarks The number of bits in the key: the more the better, 2048 or 4096 are typical values. This property is read-only and not available at design time. ## Data Type Integer # ServerKeyComment Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The comment for the public key. ## Object Oriented Interface ```text public function getServerKeyComment(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 71 ); ``` ## Default Value '' ## Remarks The comment for the public key. This property is read-only and not available at design time. ## Data Type String # ServerKeyCurve Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the elliptical curve when EC cryptography is used. ## Object Oriented Interface ```text public function getServerKeyCurve(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 72 ); ``` ## Default Value '' ## Remarks Specifies the elliptical curve when EC cryptography is used. The following curves are currently supported: - NISTP256 - NISTP384 - NISTP521 - NISTK163 - NISTP192 - NISTP224 - NISTK233 - NISTB233 - NISTK283 - NISTK409 - NISTB409 - NISTK571 - CURVE25519 (EdDSA curve) - CURVE448 (EdDSA curve) This property is read-only and not available at design time. ## Data Type String # ServerKeyExtractable Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Whether the key is extractable (e. ## Object Oriented Interface ```text public function getServerKeyExtractable(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 73 ); ``` ## Default Value false ## Remarks Whether the key is extractable (e.g., from a security token), or not. This property is read-only and not available at design time. ## Data Type Boolean # ServerKeyFingerprintMD5 Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains the MD5 fingerprint (hash) of the key. ## Object Oriented Interface ```text public function getServerKeyFingerprintMD5(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 74 ); ``` ## Default Value '' ## Remarks Contains the MD5 fingerprint (hash) of the key. This property is read-only and not available at design time. ## Data Type String # ServerKeyFingerprintSHA1 Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains the SHA-1 fingerprint (hash) of the key. ## Object Oriented Interface ```text public function getServerKeyFingerprintSHA1(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 75 ); ``` ## Default Value '' ## Remarks Contains the SHA-1 fingerprint (hash) of the key. This property is read-only and not available at design time. ## Data Type String # ServerKeyFingerprintSHA256 Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Contains the SHA-256 fingerprint (hash) of the key. ## Object Oriented Interface ```text public function getServerKeyFingerprintSHA256(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 76 ); ``` ## Default Value '' ## Remarks Contains the SHA-256 fingerprint (hash) of the key. This property is read-only and not available at design time. ## Data Type String # ServerKeyHandle Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getServerKeyHandle(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 77 ); ``` ## Default Value 0 ## Remarks 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is read-only and not available at design time. ## Data Type Long64 # ServerKeyKeyFormat Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the format in which the key is stored. ## Object Oriented Interface ```text public function getServerKeyKeyFormat(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 78 ); ``` ## Possible Values ```text SSHCLIENT_SERVERKEYKEYFORMAT_OPEN_SSH(0), SSHCLIENT_SERVERKEYKEYFORMAT_OPEN_SSH2(1), SSHCLIENT_SERVERKEYKEYFORMAT_IETF(2), SSHCLIENT_SERVERKEYKEYFORMAT_PU_TTY(3), SSHCLIENT_SERVERKEYKEYFORMAT_X509(4), SSHCLIENT_SERVERKEYKEYFORMAT_BINARY(5), SSHCLIENT_SERVERKEYKEYFORMAT_SSH1(6), SSHCLIENT_SERVERKEYKEYFORMAT_PGP(7), SSHCLIENT_SERVERKEYKEYFORMAT_PKCS8(8), SSHCLIENT_SERVERKEYKEYFORMAT_PU_TTY3(9), SSHCLIENT_SERVERKEYKEYFORMAT_OPEN_SSHCERT(10) ``` ## Default Value 0 ## Remarks 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 | | | ckfOpenSSHCert | 10 | | This property is read-only and not available at design time. ## Data Type Integer # ServerKeyKeyProtectionAlgorithm Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the key protection algorithm. ## Object Oriented Interface ```text public function getServerKeyKeyProtectionAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 79 ); ``` ## Default Value '' ## Remarks Specifies the key protection algorithm. This property is read-only and not available at design time. ## Data Type String # ServerKeyPrivate Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Whether this key is a private key or not. ## Object Oriented Interface ```text public function getServerKeyPrivate(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 80 ); ``` ## Default Value false ## Remarks Whether this key is a private key or not. This property is read-only and not available at design time. ## Data Type Boolean # ServerKeyPublic Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Whether this key is a public key or not. ## Object Oriented Interface ```text public function getServerKeyPublic(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 81 ); ``` ## Default Value false ## Remarks Whether this key is a public key or not. This property is read-only and not available at design time. ## Data Type Boolean # ServerKeySubject Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the public key owner (subject). ## Object Oriented Interface ```text public function getServerKeySubject(); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 82 ); ``` ## Default Value '' ## Remarks Specifies the public key owner (subject). This property is used only for IETF-keys. This property is read-only and not available at design time. ## Data Type String # SocketDNSMode Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. ## Object Oriented Interface ```text public function getSocketDNSMode(); public function setSocketDNSMode($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 83 ); secureblackbox_sshclient_set($res, 83, $value ); ``` ## Possible Values ```text SSHCLIENT_SOCKETDNSMODE_AUTO(0), SSHCLIENT_SOCKETDNSMODE_PLATFORM(1), SSHCLIENT_SOCKETDNSMODE_OWN(2), SSHCLIENT_SOCKETDNSMODE_OWN_SECURE(3) ``` ## Default Value 0 ## Remarks Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. | | | | --- | --- | | dmAuto | 0 | | dmPlatform | 1 | | dmOwn | 2 | | dmOwnSecure | 3 | ## Data Type Integer # SocketDNSPort Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the port number to be used for sending queries to the DNS server. ## Object Oriented Interface ```text public function getSocketDNSPort(); public function setSocketDNSPort($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 84 ); secureblackbox_sshclient_set($res, 84, $value ); ``` ## Default Value 0 ## Remarks Specifies the port number to be used for sending queries to the DNS server. ## Data Type Integer # SocketDNSQueryTimeout Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The timeout (in milliseconds) for each DNS query. ## Object Oriented Interface ```text public function getSocketDNSQueryTimeout(); public function setSocketDNSQueryTimeout($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 85 ); secureblackbox_sshclient_set($res, 85, $value ); ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. ## Data Type Integer # SocketDNSServers Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Object Oriented Interface ```text public function getSocketDNSServers(); public function setSocketDNSServers($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 86 ); secureblackbox_sshclient_set($res, 86, $value ); ``` ## Default Value '' ## Remarks The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Data Type String # SocketDNSTotalTimeout Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The timeout (in milliseconds) for the whole resolution process. ## Object Oriented Interface ```text public function getSocketDNSTotalTimeout(); public function setSocketDNSTotalTimeout($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 87 ); secureblackbox_sshclient_set($res, 87, $value ); ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. ## Data Type Integer # SocketIncomingSpeedLimit Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The maximum number of bytes to read from the socket, per second. ## Object Oriented Interface ```text public function getSocketIncomingSpeedLimit(); public function setSocketIncomingSpeedLimit($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 88 ); secureblackbox_sshclient_set($res, 88, $value ); ``` ## Default Value 0 ## Remarks The maximum number of bytes to read from the socket, per second. ## Data Type Integer # SocketLocalAddress Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The local network interface to bind the socket to. ## Object Oriented Interface ```text public function getSocketLocalAddress(); public function setSocketLocalAddress($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 89 ); secureblackbox_sshclient_set($res, 89, $value ); ``` ## Default Value '' ## Remarks The local network interface to bind the socket to. ## Data Type String # SocketLocalPort Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The local port number to bind the socket to. ## Object Oriented Interface ```text public function getSocketLocalPort(); public function setSocketLocalPort($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 90 ); secureblackbox_sshclient_set($res, 90, $value ); ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. ## Data Type Integer # SocketOutgoingSpeedLimit Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The maximum number of bytes to write to the socket, per second. ## Object Oriented Interface ```text public function getSocketOutgoingSpeedLimit(); public function setSocketOutgoingSpeedLimit($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 91 ); secureblackbox_sshclient_set($res, 91, $value ); ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. ## Data Type Integer # SocketTimeout Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Object Oriented Interface ```text public function getSocketTimeout(); public function setSocketTimeout($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 92 ); secureblackbox_sshclient_set($res, 92, $value ); ``` ## Default Value 60000 ## Remarks The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If *Timeout* is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). ## Data Type Integer # SocketUseIPv6 Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Enables or disables IP protocol version 6. ## Object Oriented Interface ```text public function getSocketUseIPv6(); public function setSocketUseIPv6($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 93 ); secureblackbox_sshclient_set($res, 93, $value ); ``` ## Default Value false ## Remarks Enables or disables IP protocol version 6. ## Data Type Boolean # SSHSettingsAutoAdjustCiphers Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to. ## Object Oriented Interface ```text public function getSSHSettingsAutoAdjustCiphers(); public function setSSHSettingsAutoAdjustCiphers($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 94 ); secureblackbox_sshclient_set($res, 94, $value ); ``` ## Default Value true ## Remarks Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to. ## Data Type Boolean # SSHSettingsBaseConfiguration Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility. ## Object Oriented Interface ```text public function getSSHSettingsBaseConfiguration(); public function setSSHSettingsBaseConfiguration($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 95 ); secureblackbox_sshclient_set($res, 95, $value ); ``` ## Possible Values ```text SSHCLIENT_SSHSETTINGSBASECONFIGURATION_DEFAULT(0), SSHCLIENT_SSHSETTINGSBASECONFIGURATION_COMPATIBLE(1), SSHCLIENT_SSHSETTINGSBASECONFIGURATION_COMPREHENSIVE_INSECURE(2), SSHCLIENT_SSHSETTINGSBASECONFIGURATION_HIGHLY_SECURE(3) ``` ## Default Value 0 ## Remarks Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility. ## Data Type Integer # SSHSettingsCompressionAlgorithms Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) A list of session compression algorithms separated with commas or semicolons. ## Object Oriented Interface ```text public function getSSHSettingsCompressionAlgorithms(); public function setSSHSettingsCompressionAlgorithms($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 96 ); secureblackbox_sshclient_set($res, 96, $value ); ``` ## Default Value '' ## Remarks A list of session compression algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all compression algorithms at once. Note: the list of algorithms provided to this property alters the baseline list of compression algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported compression algorithms is provided below: - none - zlib - zlib@openssh.com ## Data Type String # SSHSettingsCompressionLevel Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). ## Object Oriented Interface ```text public function getSSHSettingsCompressionLevel(); public function setSSHSettingsCompressionLevel($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 97 ); secureblackbox_sshclient_set($res, 97, $value ); ``` ## Default Value 6 ## Remarks Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted. ## Data Type Integer # SSHSettingsDefaultWindowSize Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server. ## Object Oriented Interface ```text public function getSSHSettingsDefaultWindowSize(); public function setSSHSettingsDefaultWindowSize($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 98 ); secureblackbox_sshclient_set($res, 98, $value ); ``` ## Default Value 2048000 ## Remarks The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server. ## Data Type Integer # SSHSettingsEncryptionAlgorithms Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) A list of session encryption algorithms separated with commas or semicolons. ## Object Oriented Interface ```text public function getSSHSettingsEncryptionAlgorithms(); public function setSSHSettingsEncryptionAlgorithms($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 99 ); secureblackbox_sshclient_set($res, 99, $value ); ``` ## Default Value '' ## Remarks A list of session encryption algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all encryption algorithms at once. Note: the list of algorithms provided to this property alters the baseline list of encryption algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported encryption algorithms is provided below: - 3des-cbc - blowfish-cbc - twofish256-cbc - twofish192-cbc - twofish128-cbc - aes256-cbc - aes192-cbc - aes128-cbc - serpent256-cbc - serpent192-cbc - serpent128-cbc - arcfour - idea-cbc - cast128-cbc - none - des-cbc - aes128-ctr - aes192-ctr - aes256-ctr - 3des-ctr - blowfish-ctr - twofish128-ctr - twofish192-ctr - twofish256-ctr - serpent128-ctr - serpent192-ctr - serpent256-ctr - idea-ctr - cast128-ctr - arcfour128 - arcfour256 - aes128-gcm - aes256-gcm - aes128-gcm@openssh.com - aes256-gcm@openssh.com - chacha20-poly1305 - chacha20-poly1305@openssh.com ## Data Type String # SSHSettingsForceCompression Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Whether the SSH client should explicitly request compression. ## Object Oriented Interface ```text public function getSSHSettingsForceCompression(); public function setSSHSettingsForceCompression($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 100 ); secureblackbox_sshclient_set($res, 100, $value ); ``` ## Default Value false ## Remarks Whether the SSH client should explicitly request compression. If *ForceCompression* is False, compression will be used only if the server doesn't support algorithms without compression. ## Data Type Boolean # SSHSettingsForwardAuthAgent Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Enables or disables auth agent forwarding. ## Object Oriented Interface ```text public function getSSHSettingsForwardAuthAgent(); public function setSSHSettingsForwardAuthAgent($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 101 ); secureblackbox_sshclient_set($res, 101, $value ); ``` ## Default Value false ## Remarks Enables or disables auth agent forwarding. This allows the class to connect to the second and subsequent servers in the chain with the key agent available on the client computer. ## Data Type Boolean # SSHSettingsGSSAuthTypes Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) A comma-separated list of authentication types. ## Object Oriented Interface ```text public function getSSHSettingsGSSAuthTypes(); public function setSSHSettingsGSSAuthTypes($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 102 ); secureblackbox_sshclient_set($res, 102, $value ); ``` ## Default Value '' ## Remarks A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex. ## Data Type String # SSHSettingsGSSDelegateCreds Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Switches credential delegation on or off. ## Object Oriented Interface ```text public function getSSHSettingsGSSDelegateCreds(); public function setSSHSettingsGSSDelegateCreds($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 103 ); secureblackbox_sshclient_set($res, 103, $value ); ``` ## Default Value false ## Remarks Switches credential delegation on or off. ## Data Type Boolean # SSHSettingsGSSHostname Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The GSS host name, in form of a FQDN (e. ## Object Oriented Interface ```text public function getSSHSettingsGSSHostname(); public function setSSHSettingsGSSHostname($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 104 ); secureblackbox_sshclient_set($res, 104, $value ); ``` ## Default Value '' ## Remarks The GSS host name, in form of a FQDN (e.g. hostname.com), a principal name (e.g. 'host@hostname.com), or a cross-real ticket-granting ticket (e.g. krbtgt/test.com@example.com). ## Data Type String # SSHSettingsGSSLib Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) A path to the GSS-API library (DLL or SO). ## Object Oriented Interface ```text public function getSSHSettingsGSSLib(); public function setSSHSettingsGSSLib($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 105 ); secureblackbox_sshclient_set($res, 105, $value ); ``` ## Default Value '' ## Remarks A path to the GSS-API library (DLL or SO). ## Data Type String # SSHSettingsGSSMechanisms Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) A comma-separated list of GSS mechanisms to use. ## Object Oriented Interface ```text public function getSSHSettingsGSSMechanisms(); public function setSSHSettingsGSSMechanisms($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 106 ); secureblackbox_sshclient_set($res, 106, $value ); ``` ## Default Value '' ## Remarks A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI. ## Data Type String # SSHSettingsGSSProtocols Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) A comma-separated list of SSPI protocols. ## Object Oriented Interface ```text public function getSSHSettingsGSSProtocols(); public function setSSHSettingsGSSProtocols($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 107 ); secureblackbox_sshclient_set($res, 107, $value ); ``` ## Default Value '' ## Remarks A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM. ## Data Type String # SSHSettingsHandshakeTimeout Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the maximal time for the SSH handshake to proceed, in seconds. ## Object Oriented Interface ```text public function getSSHSettingsHandshakeTimeout(); public function setSSHSettingsHandshakeTimeout($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 108 ); secureblackbox_sshclient_set($res, 108, $value ); ``` ## Default Value 45 ## Remarks Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted. ## Data Type Integer # SSHSettingsKexAlgorithms Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) A list of key exchange algorithms separated with commas or semicolons. ## Object Oriented Interface ```text public function getSSHSettingsKexAlgorithms(); public function setSSHSettingsKexAlgorithms($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 109 ); secureblackbox_sshclient_set($res, 109, $value ); ``` ## Default Value '' ## Remarks A list of key exchange algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all key exchange algorithms at once. Note: the list of algorithms provided to this property alters the baseline list of key exchange algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported kex algorithms is provided below: - diffie-hellman-group-exchange-sha1 - diffie-hellman-group1-sha1 - diffie-hellman-group14-sha1 - diffie-hellman-group-exchange-sha256 - rsa1024-sha1 - rsa2048-sha256 - ecdh-sha2-nistp256 - ecdh-sha2-nistp384 - ecdh-sha2-nistp521 - ecdh-sha2-nistk163 - ecdh-sha2-nistp192 - ecdh-sha2-nistp224 - ecdh-sha2-nistk233 - ecdh-sha2-nistb233 - ecdh-sha2-nistk283 - ecdh-sha2-nistk409 - ecdh-sha2-nistb409 - ecdh-sha2-nistt571 - ecdh-sha2-curve25519 - curve25519-sha256@libssh.org - curve448-sha512@libssh.org - diffie-hellman-group14-sha256 - diffie-hellman-group15-sha512 - diffie-hellman-group16-sha512 - diffie-hellman-group17-sha512 - diffie-hellman-group18-sha512 ## Data Type String # SSHSettingsMacAlgorithms Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) A list of MAC (for message authentication code ) algorithms separated with commas or semicolons. ## Object Oriented Interface ```text public function getSSHSettingsMacAlgorithms(); public function setSSHSettingsMacAlgorithms($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 110 ); secureblackbox_sshclient_set($res, 110, $value ); ``` ## Default Value '' ## Remarks A list of MAC (for *message authentication code*) algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all MAC algorithms at once. Note: the list of algorithms provided to this property alters the baseline list of MAC algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported MAC algorithms is provided below: - hmac-sha1 - hmac-sha1-96 - hmac-md5 - hmac-md5-96 - none - hmac-ripemd160 - hmac-ripemd - hmac-ripemd160@openssh.com - hmac-sha256@ssh.com - hmac-sha256-96@ssh.com - umac-32@openssh.com - umac-64@openssh.com - umac-96@openssh.com - umac-128@openssh.com - hmac-sha2-256 - hmac-sha2-512 - aes128-gcm - aes256-gcm - chacha20-poly1305@openssh.com - hmac-sha2-256-etm@openssh.com - hmac-sha2-512-etm@openssh.com ## Data Type String # SSHSettingsMaxSSHPacketSize Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the maximum length of one SSH packet in bytes. ## Object Oriented Interface ```text public function getSSHSettingsMaxSSHPacketSize(); public function setSSHSettingsMaxSSHPacketSize($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 111 ); secureblackbox_sshclient_set($res, 111, $value ); ``` ## Default Value 262144 ## Remarks Specifies the maximum length of one SSH packet in bytes. ## Data Type Integer # SSHSettingsMinWindowSize Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the minimal internal window size. ## Object Oriented Interface ```text public function getSSHSettingsMinWindowSize(); public function setSSHSettingsMinWindowSize($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 112 ); secureblackbox_sshclient_set($res, 112, $value ); ``` ## Default Value 2048 ## Remarks Specifies the minimal internal window size. When the minimal window size is reached, the 'window extension' request is sent to the server. This request notifies the server that the window was extended, and it can send more data. ## Data Type Integer # SSHSettingsObfuscateHandshake Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Enables or disables handshake obfuscation. ## Object Oriented Interface ```text public function getSSHSettingsObfuscateHandshake(); public function setSSHSettingsObfuscateHandshake($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 113 ); secureblackbox_sshclient_set($res, 113, $value ); ``` ## Default Value false ## Remarks Enables or disables handshake obfuscation. ## Data Type Boolean # SSHSettingsObfuscationPassword Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the password used to encrypt the handshake when ObfuscateHandshake is set. ## Object Oriented Interface ```text public function getSSHSettingsObfuscationPassword(); public function setSSHSettingsObfuscationPassword($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 114 ); secureblackbox_sshclient_set($res, 114, $value ); ``` ## Default Value '' ## Remarks Specifies the password used to encrypt the handshake when ObfuscateHandshake is set. ## Data Type String # SSHSettingsPublicKeyAlgorithms Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) A list of public key algorithms separated with commas or semicolons. ## Object Oriented Interface ```text public function getSSHSettingsPublicKeyAlgorithms(); public function setSSHSettingsPublicKeyAlgorithms($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 115 ); secureblackbox_sshclient_set($res, 115, $value ); ``` ## Default Value '' ## Remarks A list of public key algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the *all* (and *-all*) aliases that allow to blanketly enable or disable all public key algorithms at once. Note: the list of algorithms provided to this property alters the baseline list of public key algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported public key algorithms is provided below: - ssh-dss - ssh-rsa - x509v3-sign-rsa - x509v3-sign-dss - spki-sign-rsa, - spki-sign-dss - pgp-sign-rsa - pgp-sign-dss - ecdsa-sha2-nistp256 - ecdsa-sha2-nistp384 - ecdsa-sha2-nistp521 - ecdsa-sha2-nistk163 - ecdsa-sha2-nistp192 - ecdsa-sha2-nistp224 - ecdsa-sha2-nistk233 - ecdsa-sha2-nistb233 - ecdsa-sha2-nistk283 - ecdsa-sha2-nistk409 - ecdsa-sha2-nistb409 - ecdsa-sha2-nistt571, - ecdsa-sha2-curve25519 - x509v3-ssh-rsa - x509v3-ssh-dss - x509v3-rsa2048-sha256 - x509v3-ecdsa-sha2-nistp256 - x509v3-ecdsa-sha2-nistp384 - x509v3-ecdsa-sha2-nistp521 - x509v3-ecdsa-sha2-nistk163 - x509v3-ecdsa-sha2-nistp192 - x509v3-ecdsa-sha2-nistp224 - x509v3-ecdsa-sha2-nistk233 - x509v3-ecdsa-sha2-nistb233 - x509v3-ecdsa-sha2-nistk283 - x509v3-ecdsa-sha2-nistk409 - x509v3-ecdsa-sha2-nistb409 - x509v3-ecdsa-sha2-nistt571 - x509v3-ecdsa-sha2-curve25519 - ssh-ed25519 - ssh-ed448 - rsa-sha2-256 - rsa-sha2-512 ## Data Type String # SSHSettingsRequestPasswordChange Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Whether to request a password change when connecting. ## Object Oriented Interface ```text public function getSSHSettingsRequestPasswordChange(); public function setSSHSettingsRequestPasswordChange($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 116 ); secureblackbox_sshclient_set($res, 116, $value ); ``` ## Default Value false ## Remarks Whether to request a password change when connecting. ## Data Type Boolean # SSHSettingsSoftwareName Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The name to be used by the class to identify itself. ## Object Oriented Interface ```text public function getSSHSettingsSoftwareName(); public function setSSHSettingsSoftwareName($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 117 ); secureblackbox_sshclient_set($res, 117, $value ); ``` ## Default Value 'SecureBlackbox' ## Remarks The name to be used by the component to identify itself. ## Data Type String # SSHSettingsTrustAllKeys Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Enables or disables explicit trust to all server keys. ## Object Oriented Interface ```text public function getSSHSettingsTrustAllKeys(); public function setSSHSettingsTrustAllKeys($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 118 ); secureblackbox_sshclient_set($res, 118, $value ); ``` ## Default Value false ## Remarks Enables or disables explicit trust to all server keys. Use with care. ## Data Type Boolean # SSHSettingsUseAuthAgent Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Enables or disables the use of external key agent, such as Putty key agent. ## Object Oriented Interface ```text public function getSSHSettingsUseAuthAgent(); public function setSSHSettingsUseAuthAgent($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 119 ); secureblackbox_sshclient_set($res, 119, $value ); ``` ## Default Value false ## Remarks Enables or disables the use of external key agent, such as Putty key agent. ## Data Type Boolean # SSHSettingsVersions Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies enabled SSH protocol versions (1 or 2). ## Object Oriented Interface ```text public function getSSHSettingsVersions(); public function setSSHSettingsVersions($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 120 ); secureblackbox_sshclient_set($res, 120, $value ); ``` ## Default Value 1 ## Remarks Specifies enabled SSH protocol versions (1 or 2). ## Data Type Integer # Subsystem Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the subsystem to request from the server. ## Object Oriented Interface ```text public function getSubsystem(); public function setSubsystem($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 121 ); secureblackbox_sshclient_set($res, 121, $value ); ``` ## Default Value '' ## Remarks Subsystem is a special form of an SSH channel. It is typically used to transfer third-party protocol data, with SFTP being the most widely known. You can tell class to set up a subsystem connection (rather than a shell or command) by assigning the subsystem name to this property. ## Data Type String # TerminalCols Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the width of the pseudoterminal, in characters. ## Object Oriented Interface ```text public function getTerminalCols(); public function setTerminalCols($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 122 ); secureblackbox_sshclient_set($res, 122, $value ); ``` ## Default Value 80 ## Remarks Specifies the width of the pseudoterminal, in characters. ## Data Type Integer # TerminalEnvironment Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the list of environment variables. ## Object Oriented Interface ```text public function getTerminalEnvironment(); public function setTerminalEnvironment($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 123 ); secureblackbox_sshclient_set($res, 123, $value ); ``` ## Default Value '' ## Remarks Specifies the list of environment variables. ## Data Type String # TerminalEOLChar Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the End-of-Line character or sequence. ## Object Oriented Interface ```text public function getTerminalEOLChar(); public function setTerminalEOLChar($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 124 ); secureblackbox_sshclient_set($res, 124, $value ); ``` ## Remarks Specifies the End-of-Line character or sequence. This property is not available at design time. ## Data Type Byte Array # TerminalHeight Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the height of the pseudoterminal, in pixels. ## Object Oriented Interface ```text public function getTerminalHeight(); public function setTerminalHeight($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 125 ); secureblackbox_sshclient_set($res, 125, $value ); ``` ## Default Value 0 ## Remarks Specifies the height of the pseudoterminal, in pixels. ## Data Type Integer # TerminalOpcodes Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the operation codes specific for the terminal. ## Object Oriented Interface ```text public function getTerminalOpcodes(); public function setTerminalOpcodes($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 126 ); secureblackbox_sshclient_set($res, 126, $value ); ``` ## Default Value '' ## Remarks Specifies the operation codes specific for the terminal. ## Data Type String # TerminalProtocol Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) The terminal protocol name. ## Object Oriented Interface ```text public function getTerminalProtocol(); public function setTerminalProtocol($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 127 ); secureblackbox_sshclient_set($res, 127, $value ); ``` ## Default Value 'vt100' ## Remarks The terminal protocol name. ## Data Type String # TerminalRequestPty Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies whether to request a pseudoterminal for the session. ## Object Oriented Interface ```text public function getTerminalRequestPty(); public function setTerminalRequestPty($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 128 ); secureblackbox_sshclient_set($res, 128, $value ); ``` ## Default Value true ## Remarks Specifies whether to request a pseudoterminal for the session. ## Data Type Boolean # TerminalRows Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the height of the pseudoterminal, in lines. ## Object Oriented Interface ```text public function getTerminalRows(); public function setTerminalRows($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 129 ); secureblackbox_sshclient_set($res, 129, $value ); ``` ## Default Value 25 ## Remarks Specifies the height of the pseudoterminal, in lines. ## Data Type Integer # TerminalWidth Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies the width of the pseudoterminal, in pixels. ## Object Oriented Interface ```text public function getTerminalWidth(); public function setTerminalWidth($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 130 ); secureblackbox_sshclient_set($res, 130, $value ); ``` ## Default Value 0 ## Remarks Specifies the width of the pseudoterminal, in pixels. ## Data Type Integer # TrustedKeysFile Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Path to the file containing public keys of authorized servers. ## Object Oriented Interface ```text public function getTrustedKeysFile(); public function setTrustedKeysFile($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 131 ); secureblackbox_sshclient_set($res, 131, $value ); ``` ## Default Value '' ## Remarks Path to the file containing public keys of authorized servers. ## Data Type String # Username Property ([SecureBlackbox_SSHClient](#sshclient-class) Class) Specifies client's username on the server. ## Object Oriented Interface ```text public function getUsername(); public function setUsername($value); ``` ## Procedural Interface ```text secureblackbox_sshclient_get($res, 132 ); secureblackbox_sshclient_set($res, 132, $value ); ``` ## Default Value '' ## Remarks Client's password is set by [Password](#password-property-secureblackbox_sshclient-class) property. ; ## Data Type String # Config Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Sets or retrieves a configuration setting. ## Object Oriented Interface ```text public function doConfig($configurationstring); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_config($res, $configurationstring); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-sshclient-class) 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](#config-settings-sshclient-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # Connect Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Establishes connection to an SSH server. ## Object Oriented Interface ```text public function doConnect($address, $port); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_connect($res, $address, $port); ``` ## Remarks Use this method to connect to the SSH server by providing its *Address* and *Port*. Before connecting to the server you might want to set up your credentials using [Username](#username-property-secureblackbox_sshclient-class) and [Password](#password-property-secureblackbox_sshclient-class) properties. You might also need to configure the server key validation routine. You can do this by subscribing to [KnownKeyReceived](#knownkeyreceived-event-secureblackbox_sshclient-class) and [UnknownKeyReceived](#unknownkeyreceived-event-secureblackbox_sshclient-class) events and implementing the event handlers as required. Adjust [AsyncMode](#asyncmode-property-secureblackbox_sshclient-class) before connecting to switch the component to either synchronous or asynchronous mode. In synchronous mode, all the calls to the component, such as Connect or [SendBytes](#sendbytes-method-secureblackbox_sshclient-class), are executed within the context of the caller thread, and block until the action completes. In asynchronous mode, the component runs the SSH session in a background thread, which makes all such calls return immediately. Find out more about the modes in the [AsyncMode](#asyncmode-property-secureblackbox_sshclient-class) topic. # ConnectAndExec Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Connects to an SSH server and executes a command in one go. ## Object Oriented Interface ```text public function doConnectAndExec($address, $port, $command, $wantstdout, $wantstderr); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_connectandexec($res, $address, $port, $command, $wantstdout, $wantstderr); ``` ## Remarks Use this method to connect to an SSH server at *Address* and *Port* and execute a command. The method returns the output of the executed command. This method is a handy shortcut for running non-interactive commands. It encapsulates calls to [Connect](#connect-method-secureblackbox_sshclient-class), [Receive](#receive-method-secureblackbox_sshclient-class), [Disconnect](#disconnect-method-secureblackbox_sshclient-class) internally to save you time and space. Please note that ConnectAndExec always runs synchronously, thus ignoring the [AsyncMode](#asyncmode-property-secureblackbox_sshclient-class) setting. # Disconnect Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Closes connection to the SSH server. ## Object Oriented Interface ```text public function doDisconnect(); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_disconnect($res); ``` ## Remarks Call this method to terminate the active SSH connection. Please note that in some cases the component may still have some inbound data cached internally even after the connection is closed. You can read that data out using [Receive](#receive-method-secureblackbox_sshclient-class) and/or [ReceiveBytes](#receivebytes-method-secureblackbox_sshclient-class) methods. # DoAction Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Performs an additional action. ## Object Oriented Interface ```text public function doDoAction($actionid, $actionparams); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_doaction($res, $actionid, $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;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # Ping Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Sends a keep-alive request to the SSH server. ## Object Oriented Interface ```text public function doPing(); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_ping($res); ``` ## Remarks Use this method to send a keep-alive message to the SSH server. Keep-alive messages are empty data packets which carry no useful information but are a handy way of checking if the connection is still alive. # Poll Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Checks whether there is any inbound data readily available. ## Object Oriented Interface ```text public function doPoll($milliseconds); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_poll($res, $milliseconds); ``` ## Remarks Use this method to check whether there is any incoming data available in the connection. If this method returns true, you can read the data with [Receive](#receive-method-secureblackbox_sshclient-class) or [ReceiveBytes](#receivebytes-method-secureblackbox_sshclient-class) calls. Use the *Milliseconds* parameter to tell the component how long it can wait for the data to arrive. # Receive Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Reads a portion of received data into a string. ## Object Oriented Interface ```text public function doReceive(); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_receive($res); ``` ## Remarks Use this method to read out a piece of data received from the server into a string. Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use [Poll](#poll-method-secureblackbox_sshclient-class) to check if there is any data in the connection that is immediately available for reading. In asynchronous mode a good time to call this method is upon receiving a read notification in [DataReceived](#datareceived-event-secureblackbox_sshclient-class) event handler. When working in asynchronous mode, this call returns immediately. This method only returns data that arrives via the stdout channel. Use [ReceiveFrom](#receivefrom-method-secureblackbox_sshclient-class) to read stderr data. # ReceiveBytes Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Reads a portion of received data into a byte array. ## Object Oriented Interface ```text public function doReceiveBytes($maxlen); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_receivebytes($res, $maxlen); ``` ## Remarks Use this method to read out a piece of data received from the server into a byte array. Control the maximum length of the data chunk with the *MaxLen* parameter. Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use [Poll](#poll-method-secureblackbox_sshclient-class) to check if there is any data in the connection that is immediately available for reading. In asynchronous mode a good time to call this method is upon receiving a read notification in [DataReceived](#datareceived-event-secureblackbox_sshclient-class) event handler. When working in asynchronous mode, this call returns immediately. This method only returns data that arrives via the stdout channel. Use [ReceiveBytesFrom](#receivebytesfrom-method-secureblackbox_sshclient-class) to read stderr data. # ReceiveBytesFrom Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Reads a portion of data received via a specific channel into a byte array. ## Object Oriented Interface ```text public function doReceiveBytesFrom($channel, $maxlen); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_receivebytesfrom($res, $channel, $maxlen); ``` ## Remarks Use this method to read out a piece of data received from the server into a byte array. Specify the channel that you are interested in reading from (0 for stdout, 1 for stderr) via the *Channel* parameter, and control the maximum length of the data chunk with the *MaxLen* parameter. Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use [Poll](#poll-method-secureblackbox_sshclient-class) to check if there is any data in the connection that is immediately available for reading. In asynchronous mode a good time to call this method is upon receiving a read notification in [DataReceived](#datareceived-event-secureblackbox_sshclient-class) event handler. When working in asynchronous mode, this call returns immediately. Please also note that stdout and stderr channels are fully independent, which implies that data arriving via each channel should be read out separately. # ReceiveFrom Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Reads a portion of data received via a specific channel into a string. ## Object Oriented Interface ```text public function doReceiveFrom($channel); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_receivefrom($res, $channel); ``` ## Remarks Use this method to read out a piece of data received from the server into a string. Use the *Channel* parameter to specify the channel that you would like to read from (0 for stdout, 1 for stderr). Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use [Poll](#poll-method-secureblackbox_sshclient-class) to check if there is any data in the connection that is immediately available for reading. In asynchronous mode a good time to call this method is upon receiving a read notification in [DataReceived](#datareceived-event-secureblackbox_sshclient-class) event handler. When working in asynchronous mode, this call returns immediately. # Reset Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Resets the class settings. ## Object Oriented Interface ```text public function doReset(); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_reset($res); ``` ## Remarks Reset is a generic method available in every class. # Send Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Sends a string to the server. ## Object Oriented Interface ```text public function doSend($datastr, $addeol); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_send($res, $datastr, $addeol); ``` ## Remarks Use this method to send *DataStr* to the remote command's stdin channel. Set the *AddEOL* parameter to true to append the end-of-line character to the string automatically. Note that in synchronous mode this method may block until the whole string is committed to the network connection. In asynchronous mode this method returns immediately; the application is eventually notified that the data has been sent via the [DataSent](#datasent-event-secureblackbox_sshclient-class) event. # SendBytes Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Sends an array of bytes to the server. ## Object Oriented Interface ```text public function doSendBytes($data); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_sendbytes($res, $data); ``` ## Remarks Use this method to send *Data* to the remote command's stdin channel. Note that in synchronous mode this method may block until the whole byte array is committed to the network connection. In asynchronous mode this method returns immediately; the application is eventually notified that the data has been sent via the [DataSent](#datasent-event-secureblackbox_sshclient-class) event. # SendSpecial Method ([SecureBlackbox_SSHClient](#sshclient-class) Class) Sends a special character to the server or remote command. ## Object Oriented Interface ```text public function doSendSpecial($specialchar); ``` ## Procedural Interface ```text secureblackbox_sshclient_do_sendspecial($res, $specialchar); ``` ## Remarks Use this method to send a special or control character to the SSH server or the command being executed. Specify the character id via the *SpecialChar* parameter. Currently the only supported special character is "eof", which is sometimes used as a way to close the stdin channel gracefully. # AuthAttempt Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Fires when a single authentication attempt is performed. ## Object Oriented Interface ```text public function fireAuthAttempt($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 1, array($this, 'fireAuthAttempt')); ``` ## Parameter List ```text 'authtype' ``` ## Remarks This event is fired each time a single authentication attempt is performed. *AuthType* parameter specifies the type of authentication. Note, this event could be fired more than once if the client tries different authentication methods one after another. # AuthFailed Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Fires when a single authentication attempt is failed. ## Object Oriented Interface ```text public function fireAuthFailed($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 2, array($this, 'fireAuthFailed')); ``` ## Parameter List ```text 'authenticationtype' ``` ## Remarks This event is fired each time a single authentication attempt fails. *AuthType* parameter specifies the type of authentication. As SSH may try a number of authentication attempts of different types or with different parameters (such as public keys) during one session, this event may be fired more than once. It is not critical and may not lead to closing of the connection. # AuthSucceeded Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Reports a successful authentication. ## Object Oriented Interface ```text public function fireAuthSucceeded($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 3, array($this, 'fireAuthSucceeded')); ``` ## Parameter List ```text ``` ## Remarks This event may be preceded by some [AuthFailed](#authfailed-event-secureblackbox_sshclient-class) events if the client tries different authentication methods one after another. # Banner Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Reports the receipt of the Hello message from the server. ## Object Oriented Interface ```text public function fireBanner($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 4, array($this, 'fireBanner')); ``` ## Parameter List ```text 'text' 'language' ``` ## Remarks SFTPClient fires this event when it receives hello message from the server. # CommandCompleted Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Signifies completion of the command execution. ## Object Oriented Interface ```text public function fireCommandCompleted($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 5, array($this, 'fireCommandCompleted')); ``` ## Parameter List ```text 'command' 'exitstatus' 'exitmessage' 'exitsignal' ``` ## Remarks Subscribe to this event to be notified about completion of the remote command execution. This event fires for every command in the [Commands](#commands-property-secureblackbox_sshclient-class) list. The *Command* parameter indicates the command being completed. *ExitStatus* specifies the command's return code. *ExitMessage* or *ExitSignal* parameters provide error details if the command execution was terminated forcefully, # CommandStart Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Marks the commencement of a command execution. ## Object Oriented Interface ```text public function fireCommandStart($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 6, array($this, 'fireCommandStart')); ``` ## Parameter List ```text 'command' ``` ## Remarks Subscribe to this event to be notified about the start of execution of a remote command. The *Command* parameter indicates the command being started. This event is fired for all commands in the [Commands](#commands-property-secureblackbox_sshclient-class) list, in order. The completion of the command is reported via the [CommandCompleted](#commandcompleted-event-secureblackbox_sshclient-class) event. # Connect Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) This event is fired when an SSH session has been established. ## Object Oriented Interface ```text public function fireConnect($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 7, array($this, 'fireConnect')); ``` ## Parameter List ```text ``` ## Remarks Use this event to track the moment when SSH session has been set up. # DataReceived Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Reports receipt of another chunk of data from the server. ## Object Oriented Interface ```text public function fireDataReceived($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 8, array($this, 'fireDataReceived')); ``` ## Parameter List ```text 'channel' 'bytesreceived' 'totalbytespending' ``` ## Remarks This event fires in asynchronous mode to report the receipt of another chunk of data from the server. Use [Receive](#receive-method-secureblackbox_sshclient-class) or [ReceiveBytes](#receivebytes-method-secureblackbox_sshclient-class) methods to read out the received data. The *Channel* parameter indicates the channel on which the data was received: stdout (0) or stderr (1). *BytesReceived* specify the size of the newly received chunk, and *TotalBytesPending* contain the total number of bytes available for reading. Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities. This event does not fire in synchronous mode. # DataSent Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Notifies the application that a piece of data has been sent to the server. ## Object Oriented Interface ```text public function fireDataSent($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 9, array($this, 'fireDataSent')); ``` ## Parameter List ```text 'bytessent' 'bytespending' ``` ## Remarks Subscribe to this event to be notified about the outbound data flow. This event fires following a call to [Send](#send-method-secureblackbox_sshclient-class) or [SendBytes](#sendbytes-method-secureblackbox_sshclient-class) methods to notify the application that the data provided has been sent to the server. This event may fire more than once for each [Send](#send-method-secureblackbox_sshclient-class) or [SendBytes](#sendbytes-method-secureblackbox_sshclient-class) call, subject to the volume of data being sent and the settings of the server. The *BytesSent* parameter specifies the number of bytes that has just been sent to the server. The *BytesPending* indicate the number of bytes that remain cached in the internal buffer. Any bytes cached in such way will be sent again on the next available opportunity and reported via a separate DataSent event invocation. Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities. This event does not fire in synchronous mode. # Disconnect Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) This event is fired when the SFTP subsystem connection is closed. ## Object Oriented Interface ```text public function fireDisconnect($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 10, array($this, 'fireDisconnect')); ``` ## Parameter List ```text 'closereason' ``` ## Remarks Do not perform any file operations after this event has been fired. # Error Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Information about errors during SFTP connection. ## Object Oriented Interface ```text public function fireError($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 11, array($this, 'fireError')); ``` ## Parameter List ```text 'errorcode' 'description' ``` ## Remarks The event is fired in case of exceptional conditions during data transfer. *ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of error codes please refer to [SFTP](#trappable-errors-sshclient-class). # ExternalSign Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Handles remote or external signing initiated by the SignExternal method or other source. ## Object Oriented Interface ```text public function fireExternalSign($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 12, array($this, 'fireExternalSign')); ``` ## Parameter List ```text 'operationid' 'hashalgorithm' 'pars' 'data' 'signeddata' ``` ## Remarks Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed. The event handler must pass the value of *Data* to the signer, obtain the signature, and pass it back to the class via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The class uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing. A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: ```text signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); }; ``` # KnownKeyReceived Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Signals that the server has introduced itself with a known key. ## Object Oriented Interface ```text public function fireKnownKeyReceived($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 13, array($this, 'fireKnownKeyReceived')); ``` ## Parameter List ```text 'algorithm' 'bits' 'fingerprintsha256' ``` ## Remarks The class fires this event to tell the application that the server has introduced itself with a known key from [TrustedKeysFile](#trustedkeysfile-property-secureblackbox_sshclient-class). The details of the key are provided: *Algorithm* and *Bits* specify the key algorithm and the number of bits. *FingerprintSHA256* contains the key's fingerprint. Use ServerKey to access more key details. # Notification Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) This event notifies the application about an underlying control flow event. ## Object Oriented Interface ```text public function fireNotification($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 14, array($this, 'fireNotification')); ``` ## Parameter List ```text 'eventid' '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. # PasswordChangeRequest Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) This event is fired when a password change is requested. ## Object Oriented Interface ```text public function firePasswordChangeRequest($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 15, array($this, 'firePasswordChangeRequest')); ``` ## Parameter List ```text 'prompt' 'newpassword' 'cancel' ``` ## Remarks This event is fired by the class when a password change is requested by the server. *Prompt* contains the password prompt message. Handler should either provide the new password via *NewPassword*, or deny the request by setting *Cancel* to true. # PrivateKeyNeeded Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) This event is fired when client's public key was accepted by the server, but the corresponding secret key is not available. ## Object Oriented Interface ```text public function firePrivateKeyNeeded($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 16, array($this, 'firePrivateKeyNeeded')); ``` ## Parameter List ```text 'skip' ``` ## Remarks Set *Skip* to true when it is not possible to load the missing key for some reason. # UnknownKeyReceived Event ([SecureBlackbox_SSHClient](#sshclient-class) Class) Signals that the server has introduced itself with an unknown key. ## Object Oriented Interface ```text public function fireUnknownKeyReceived($param); ``` ## Procedural Interface ```text secureblackbox_sshclient_register_callback($res, 17, array($this, 'fireUnknownKeyReceived')); ``` ## Parameter List ```text 'algorithm' 'bits' 'fingerprintsha256' 'action' ``` ## Remarks The class fires this event to tell the application that the server has introduced itself with a key not present in [TrustedKeysFile](#trustedkeysfile-property-secureblackbox_sshclient-class). The details of the key are provided: *Algorithm* and *Bits* specify the key algorithm and the number of bits. *FingerprintSHA256* contains the key's fingerprint. In this event handler, you need to make a decision whether to proceed with the connection. Use *Action* to tell the class what it should do with the key: | | | | | --- | --- | --- | | catAcceptOnce | 1 | Accept the key for the current session only. | | catAcceptPermanently | 2 | Accept the key for the current session and store the key to the trusted keys list. | | catReject | 3 | Reject the key and close the connection. | Note that accepting an unknown and unchecked key may be risky. # Config Settings ([SSHClient](#sshclient-class) Class) 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](#config-method-secureblackbox_sshclient-class) method. ### SSHClient Config Settings **AllAlgorithms**: Returns the list of algorithms enabled in the component.Use this configuration setting to obtain the list of algorithms currently enabled in the component in the *kexinit* format. **BlockSize**: The data block size.This property specifies the data block size to use. **CommandTimeout**: Specifies the command timeout.Specifies the command timeout (the maximum time to expect the result from the SSH command), in milliseconds. **CompressionAlgorithms**: Returns the list of compression algorithms enabled in the component.Use this configuration setting to get the list of compression algorithms currently enabled in the component, as a respective *kexinit* block line. **EarlyIdString**: Enables the proactive approach to SSH handshake.The rule of thumb in the majority of SSH environments is for the server to initiate the handshake with its identification string (and for the client to respond). By setting this property to true you can tell the client to initiate the handshake by sending out the identification string proactively without waiting for the server to send one in. This setting may help in situations where your SSH or SFTP connection fails unexpectedly due to a timeout or network error. **EncryptionAlgorithms**: Returns the list of encryption algorithms enabled in the component.Use this configuration setting to get the list of symmetric encryption algorithms currently enabled in the component, as a respective *kexinit* block line. **ErrorOrigin**: Specifies whether the error is local or remote.Use this property to check where the error took place. **ErrorSeverity**: Specifies whether the error is fatal.Use this property to check whether the error is fatal or not. **KexAlgorithms**: Returns the list of key exchange algorithms enabled in the component.Use this configuration setting to get the list of key exchange algorithms currently enabled in the component, as a respective *kexinit* block line. **LocalCharset**: Charset used on the client machine.This property specifies the charset used on the local client computer. **MacAlgorithms**: Returns the list of MAC algorithms enabled in the component.Use this configuration setting to get the list of MAC algorithms currently enabled in the component, as a respective *kexinit* block line. **PublicKeyAlgorithms**: Returns the list of public key algorithms enabled in the component.Use this configuration setting to get the list of public key algorithms currently enabled in the component, as a respective *kexinit* block line. **RemoteCharset**: Charset used on the server.This property specifies the charset used on the server. **SendCommandEOF**: Defines whether EOF control character should be sent after the command data.Enable this property to enforce sending of a trailing EOF character after the command data. **ThrottleControl**: Enables or disables throttle control for the connection.Use this property to enable or disable throttle control. **UseStrictKeyExchange**: Specifies how strict key exchange is supported.This setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the class will indicate support for strict key exchange by automatically including the pseudo-algorithm *kex-strict-c-v00@openssh.com* for client classes and *kex-strict-s-v00@openssh.com* for server classes in the list of supported key exchange algorithms. Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are: | | | | --- | --- | | 0 | Disabled. Strict key exchange is not supported in the class. | | 1 (default) | Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue. | | 2 | Enabled, but reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange all algorithms may be used. If the remote host does not support strict key exchange the connection will only continue if the selected encryption and MAC algorithms are not affected by the Terrapin attack. | | 3 | Required. If the remote host does not support strict key exchange the connection will fail. | ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **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: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.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. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **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. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **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". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **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. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **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: | | | | | --- | --- | --- | | 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 | **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: | | | | | --- | --- | --- | | 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 | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. 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. | **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: | | | | | --- | --- | --- | | 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) | **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. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **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. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **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. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([SSHClient](#sshclient-class) Class)