# SSHClient Component

The SSHClient component provides client-side SSH protocol functionality.

## Syntax

```text
TsbxSSHClient
```

## 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-sshclient-component) and [Password](#password-property-sshclient-component) properties. Where public key authentication is to be used, assign your private authentication key to [Key](#key-property-sshclient-component) property (remember to set [Username](#username-property-sshclient-component) in this case too). Subscribe to events to be notified of the session progress. [AuthFailed](#authfailed-event-sshclient-component), [AuthSucceeded](#authsucceeded-event-sshclient-component), and [Connect](#connect-event-sshclient-component) are among those particularly useful.

Special attention should be paid to setting up the server key trust. Component 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-sshclient-component) 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-sshclient-component) and [UnknownKeyReceived](#unknownkeyreceived-event-sshclient-component) 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-sshclient-component) 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-sshclient-component) 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-sshclient-component) and [Receive](#receive-method-sshclient-component) methods to exchange information with the server. You can exchange data in synchronous or asynchronous way; see the description in [AsyncMode](#asyncmode-property-sshclient-component) topic to learn more about each mode.

When you are done with the session, call [Disconnect](#disconnect-method-sshclient-component) 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-sshclient-component) 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 component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AsyncMode](#asyncmode-property-sshclient-component) | Controls the SSH clients mode of work. |
| [AuthAttempts](#authattempts-property-sshclient-component) | Specifies the number of SSH password authentication attempts. |
| [Commands](#commands-property-sshclient-component) | Specifies the list of commands to execute. |
| [Connected](#connected-property-sshclient-component) | Specifies whether the client is connected to the SFTP server. |
| [ConnectionInfo](#connectioninfo-property-sshclient-component) | Contains the secure connection info. |
| [ExitMessage](#exitmessage-property-sshclient-component) | Contains the last commands exit message. |
| [ExitSignal](#exitsignal-property-sshclient-component) | Contains the last commands exit signal. |
| [ExitStatus](#exitstatus-property-sshclient-component) | Contains the last commands exit status. |
| [ExternalCrypto](#externalcrypto-property-sshclient-component) | Provides access to external signing and DC parameters. |
| [FIPSMode](#fipsmode-property-sshclient-component) | Reserved. |
| [Key](#key-property-sshclient-component) | Contains client's SSH key. |
| [Password](#password-property-sshclient-component) | Specifies user's password on the server. |
| [Proxy](#proxy-property-sshclient-component) | Allows connection through a proxy server. |
| [ServerKey](#serverkey-property-sshclient-component) | Returns server's public key. |
| [SocketSettings](#socketsettings-property-sshclient-component) | Manages network connection settings. |
| [SSHSettings](#sshsettings-property-sshclient-component) | Provides access to SSH connection settings. |
| [Subsystem](#subsystem-property-sshclient-component) | Specifies the subsystem to request from the server. |
| [Terminal](#terminal-property-sshclient-component) | Provides access to SSH terminal settings object. |
| [TrustedKeysFile](#trustedkeysfile-property-sshclient-component) | Path to the file containing public keys of authorized servers. |
| [Username](#username-property-sshclient-component) | Specifies client's username on the server. |

## Method List

*The following is the full list of the methods of the component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Config](#config-method-sshclient-component) | Sets or retrieves a configuration setting. |
| [Connect](#connect-method-sshclient-component) | Establishes connection to an SSH server. |
| [ConnectAndExec](#connectandexec-method-sshclient-component) | Connects to an SSH server and executes a command in one go. |
| [Disconnect](#disconnect-method-sshclient-component) | Closes connection to the SSH server. |
| [DoAction](#doaction-method-sshclient-component) | Performs an additional action. |
| [Ping](#ping-method-sshclient-component) | Sends a keep-alive request to the SSH server. |
| [Poll](#poll-method-sshclient-component) | Checks whether there is any inbound data readily available. |
| [Receive](#receive-method-sshclient-component) | Reads a portion of received data into a string. |
| [ReceiveBytes](#receivebytes-method-sshclient-component) | Reads a portion of received data into a byte array. |
| [ReceiveBytesFrom](#receivebytesfrom-method-sshclient-component) | Reads a portion of data received via a specific channel into a byte array. |
| [ReceiveFrom](#receivefrom-method-sshclient-component) | Reads a portion of data received via a specific channel into a string. |
| [Reset](#reset-method-sshclient-component) | Resets the component settings. |
| [Send](#send-method-sshclient-component) | Sends a string to the server. |
| [SendBytes](#sendbytes-method-sshclient-component) | Sends an array of bytes to the server. |
| [SendSpecial](#sendspecial-method-sshclient-component) | Sends a special character to the server or remote command. |

## Event List

*The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AuthAttempt](#authattempt-event-sshclient-component) | Fires when a single authentication attempt is performed. |
| [AuthFailed](#authfailed-event-sshclient-component) | Fires when a single authentication attempt is failed. |
| [AuthSucceeded](#authsucceeded-event-sshclient-component) | Reports a successful authentication. |
| [Banner](#banner-event-sshclient-component) | Reports the receipt of the Hello message from the server. |
| [CommandCompleted](#commandcompleted-event-sshclient-component) | Signifies completion of the command execution. |
| [CommandStart](#commandstart-event-sshclient-component) | Marks the commencement of a command execution. |
| [Connect](#connect-event-sshclient-component) | This event is fired when an SSH session has been established. |
| [DataReceived](#datareceived-event-sshclient-component) | Reports receipt of another chunk of data from the server. |
| [DataSent](#datasent-event-sshclient-component) | Notifies the application that a piece of data has been sent to the server. |
| [Disconnect](#disconnect-event-sshclient-component) | This event is fired when the SFTP subsystem connection is closed. |
| [Error](#error-event-sshclient-component) | Information about errors during SFTP connection. |
| [ExternalSign](#externalsign-event-sshclient-component) | Handles remote or external signing initiated by the SignExternal method or other source. |
| [KnownKeyReceived](#knownkeyreceived-event-sshclient-component) | Signals that the server has introduced itself with a known key. |
| [Notification](#notification-event-sshclient-component) | This event notifies the application about an underlying control flow event. |
| [PasswordChangeRequest](#passwordchangerequest-event-sshclient-component) | This event is fired when a password change is requested. |
| [PrivateKeyNeeded](#privatekeyneeded-event-sshclient-component) | 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-sshclient-component) | Signals that the server has introduced itself with an unknown key. |

## Config Settings

*The following is a list of config settings for the component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AllAlgorithms](#AllAlgorithms) | Returns the list of algorithms enabled in the component. |
| [BlockSize](#BlockSize) | The data block size. |
| [CommandTimeout](#CommandTimeout) | Specifies the command timeout. |
| [CompressionAlgorithms](#CompressionAlgorithms) | Returns the list of compression algorithms enabled in the component. |
| [EarlyIdString](#EarlyIdString) | Enables the proactive approach to SSH handshake. |
| [EncryptionAlgorithms](#EncryptionAlgorithms) | Returns the list of encryption algorithms enabled in the component. |
| [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 component. |
| [LocalCharset](#LocalCharset) | Charset used on the client machine. |
| [MacAlgorithms](#MacAlgorithms) | Returns the list of MAC algorithms enabled in the component. |
| [PublicKeyAlgorithms](#PublicKeyAlgorithms) | Returns the list of public key algorithms enabled in the component. |
| [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 component. |
| [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 components. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server components. |
| [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 components 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 components 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 ([SSHClient](#sshclient-component) Component)

Controls the SSH clients mode of work.

## Syntax

*Delphi Syntax*

```text
property AsyncMode: Boolean read get_AsyncMode write set_AsyncMode;
```

## Default Value

false

## Remarks

This property defines the way in which the component 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-sshclient-component), [Receive](#receive-method-sshclient-component) or [SendBytes](#sendbytes-method-sshclient-component) 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-sshclient-component) or [SendBytes](#sendbytes-method-sshclient-component) may block
- Use [Poll](#poll-method-sshclient-component) to check for the availability of data before reading it out with [Receive](#receive-method-sshclient-component) or [ReceiveBytes](#receivebytes-method-sshclient-component)
- 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-sshclient-component) return immediately
- Use [DataSent](#datasent-event-sshclient-component) and [DataReceived](#datareceived-event-sshclient-component) 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-sshclient-component) event, often followed by [Disconnect](#disconnect-event-sshclient-component).

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.

# AuthAttempts Property ([SSHClient](#sshclient-component) Component)

Specifies the number of SSH password authentication attempts.

## Syntax

*Delphi Syntax*

```text
property AuthAttempts: Integer read get_AuthAttempts write set_AuthAttempts;
```

## Default Value

1

## Remarks

In case of password authentication failure provide new password inside the [AuthFailed](#authfailed-event-sshclient-component) event handler.

# Commands Property ([SSHClient](#sshclient-component) Component)

Specifies the list of commands to execute.

## Syntax

*Delphi Syntax*

```text
property Commands: String read get_Commands write set_Commands;
```

## 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.

# Connected Property ([SSHClient](#sshclient-component) Component)

Specifies whether the client is connected to the SFTP server.

## Syntax

*Delphi Syntax*

```text
property Connected: Boolean read get_Connected;
```

## Default Value

false

## Remarks

Use this read-only property to check whether the client is connected to the server.

This property is read-only.

# ConnectionInfo Property ([SSHClient](#sshclient-component) Component)

Contains the secure connection info.

## Syntax

*Delphi Syntax*

```text
property ConnectionInfo: TsbxSSHConnectionInfo read get_ConnectionInfo;
```

## Remarks

This property contains various information about the secure connection.

This property is read-only and not available at design time.

 Please refer to the [SSHConnectionInfo](#sshconnectioninfo-type) type for a complete list of fields.

# ExitMessage Property ([SSHClient](#sshclient-component) Component)

Contains the last commands exit message.

## Syntax

*Delphi Syntax*

```text
property ExitMessage: String read get_ExitMessage;
```

## 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.

# ExitSignal Property ([SSHClient](#sshclient-component) Component)

Contains the last commands exit signal.

## Syntax

*Delphi Syntax*

```text
property ExitSignal: String read get_ExitSignal;
```

## 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.

# ExitStatus Property ([SSHClient](#sshclient-component) Component)

Contains the last commands exit status.

## Syntax

*Delphi Syntax*

```text
property ExitStatus: Integer read get_ExitStatus;
```

## 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.

# ExternalCrypto Property ([SSHClient](#sshclient-component) Component)

Provides access to external signing and DC parameters.

## Syntax

*Delphi Syntax*

```text
property ExternalCrypto: TsbxExternalCrypto read get_ExternalCrypto;
```

## Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the [ExternalSign](#externalsign-event-sshclient-component) event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

 Please refer to the [ExternalCrypto](#externalcrypto-type) type for a complete list of fields.

# FIPSMode Property ([SSHClient](#sshclient-component) Component)

Reserved.

## Syntax

*Delphi Syntax*

```text
property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;
```

## Default Value

false

## Remarks

This property is reserved for future use.

# Key Property ([SSHClient](#sshclient-component) Component)

Contains client's SSH key.

## Syntax

*Delphi Syntax*

```text
property Key: TsbxSSHKey read get_Key write set_Key;
```

## Remarks

Server's public key is returned by [ServerKey](#serverkey-property-sshclient-component) property.

 Please refer to the [SSHKey](#sshkey-type) type for a complete list of fields.

# Password Property ([SSHClient](#sshclient-component) Component)

Specifies user's password on the server.

## Syntax

*Delphi Syntax*

```text
property Password: String read get_Password write set_Password;
```

## Default Value

''

## Remarks

Invalid password fires the [AuthFailed](#authfailed-event-sshclient-component) event.

# Proxy Property ([SSHClient](#sshclient-component) Component)

Allows connection through a proxy server.

## Syntax

*Delphi Syntax*

```text
property Proxy: TsbxProxySettings read get_Proxy;
```

## Remarks

Set this property if the connection should be established through a proxy server.

This property is read-only.

 Please refer to the [ProxySettings](#proxysettings-type) type for a complete list of fields.

# ServerKey Property ([SSHClient](#sshclient-component) Component)

Returns server's public key.

## Syntax

*Delphi Syntax*

```text
property ServerKey: TsbxSSHKey read get_ServerKey;
```

## Remarks

Client's SSH key is specified by [Key](#key-property-sshclient-component).

This property is read-only and not available at design time.

 Please refer to the [SSHKey](#sshkey-type) type for a complete list of fields.

# SocketSettings Property ([SSHClient](#sshclient-component) Component)

Manages network connection settings.

## Syntax

*Delphi Syntax*

```text
property SocketSettings: TsbxSocketSettings read get_SocketSettings;
```

## Remarks

Use this property to tune up network connection parameters.

This property is read-only.

 Please refer to the [SocketSettings](#socketsettings-type) type for a complete list of fields.

# SSHSettings Property ([SSHClient](#sshclient-component) Component)

Provides access to SSH connection settings.

## Syntax

*Delphi Syntax*

```text
property SSHSettings: TsbxSSHSettings read get_SSHSettings;
```

## Remarks

Use this property to configure SSH protocol settings.

This property is read-only.

 Please refer to the [SSHSettings](#sshsettings-type) type for a complete list of fields.

# Subsystem Property ([SSHClient](#sshclient-component) Component)

Specifies the subsystem to request from the server.

## Syntax

*Delphi Syntax*

```text
property Subsystem: String read get_Subsystem write set_Subsystem;
```

## 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 component to set up a subsystem connection (rather than a shell or command) by assigning the subsystem name to this property.

# Terminal Property ([SSHClient](#sshclient-component) Component)

Provides access to SSH terminal settings object.

## Syntax

*Delphi Syntax*

```text
property Terminal: TsbxSSHTerm read get_Terminal;
```

## Remarks

Use this property to configure the pseudo-terminal parameters before opening a shell or command connection.

This property is read-only.

 Please refer to the [SSHTerm](#sshterm-type) type for a complete list of fields.

# TrustedKeysFile Property ([SSHClient](#sshclient-component) Component)

Path to the file containing public keys of authorized servers.

## Syntax

*Delphi Syntax*

```text
property TrustedKeysFile: String read get_TrustedKeysFile write set_TrustedKeysFile;
```

## Default Value

''

## Remarks

Path to the file containing public keys of authorized servers.

# Username Property ([SSHClient](#sshclient-component) Component)

Specifies client's username on the server.

## Syntax

*Delphi Syntax*

```text
property Username: String read get_Username write set_Username;
```

## Default Value

''

## Remarks

Client's password is set by [Password](#password-property-sshclient-component) property. ;

# Config Method ([SSHClient](#sshclient-component) Component)

Sets or retrieves a configuration setting.

## Syntax

*Delphi Syntax*

```text
function Config(ConfigurationString: String): String;
```

## Remarks

Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-sshclient-component) for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Connect Method ([SSHClient](#sshclient-component) Component)

Establishes connection to an SSH server.

## Syntax

*Delphi Syntax*

```text
procedure Connect(Address: String; Port: Integer);
```

## 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-sshclient-component) and [Password](#password-property-sshclient-component) properties. You might also need to configure the server key validation routine. You can do this by subscribing to [KnownKeyReceived](#knownkeyreceived-event-sshclient-component) and [UnknownKeyReceived](#unknownkeyreceived-event-sshclient-component) events and implementing the event handlers as required.

Adjust [AsyncMode](#asyncmode-property-sshclient-component) 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-sshclient-component), 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-sshclient-component) topic.

# ConnectAndExec Method ([SSHClient](#sshclient-component) Component)

Connects to an SSH server and executes a command in one go.

## Syntax

*Delphi Syntax*

```text
function ConnectAndExec(Address: String; Port: Integer; Command: String; WantStdout: Boolean; WantStdErr: Boolean): TBytes;
```

## 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-sshclient-component), [Receive](#receive-method-sshclient-component), [Disconnect](#disconnect-method-sshclient-component) internally to save you time and space.

Please note that ConnectAndExec always runs synchronously, thus ignoring the [AsyncMode](#asyncmode-property-sshclient-component) setting.

# Disconnect Method ([SSHClient](#sshclient-component) Component)

Closes connection to the SSH server.

## Syntax

*Delphi Syntax*

```text
procedure Disconnect();
```

## 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-sshclient-component) and/or [ReceiveBytes](#receivebytes-method-sshclient-component) methods.

# DoAction Method ([SSHClient](#sshclient-component) Component)

Performs an additional action.

## Syntax

*Delphi Syntax*

```text
function DoAction(ActionID: String; ActionParams: String): String;
```

## Remarks

DoAction is a generic method available in every component. 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 ([SSHClient](#sshclient-component) Component)

Sends a keep-alive request to the SSH server.

## Syntax

*Delphi Syntax*

```text
procedure Ping();
```

## 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 ([SSHClient](#sshclient-component) Component)

Checks whether there is any inbound data readily available.

## Syntax

*Delphi Syntax*

```text
function Poll(Milliseconds: Integer): Boolean;
```

## 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-sshclient-component) or [ReceiveBytes](#receivebytes-method-sshclient-component) calls.

Use the *Milliseconds* parameter to tell the component how long it can wait for the data to arrive.

# Receive Method ([SSHClient](#sshclient-component) Component)

Reads a portion of received data into a string.

## Syntax

*Delphi Syntax*

```text
function Receive(): String;
```

## 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-sshclient-component) 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-sshclient-component) 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-sshclient-component) to read stderr data.

# ReceiveBytes Method ([SSHClient](#sshclient-component) Component)

Reads a portion of received data into a byte array.

## Syntax

*Delphi Syntax*

```text
function ReceiveBytes(MaxLen: Integer): TBytes;
```

## 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-sshclient-component) 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-sshclient-component) 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-sshclient-component) to read stderr data.

# ReceiveBytesFrom Method ([SSHClient](#sshclient-component) Component)

Reads a portion of data received via a specific channel into a byte array.

## Syntax

*Delphi Syntax*

```text
function ReceiveBytesFrom(Channel: Integer; MaxLen: Integer): TBytes;
```

## 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-sshclient-component) 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-sshclient-component) 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 ([SSHClient](#sshclient-component) Component)

Reads a portion of data received via a specific channel into a string.

## Syntax

*Delphi Syntax*

```text
function ReceiveFrom(Channel: Integer): String;
```

## 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-sshclient-component) 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-sshclient-component) event handler. When working in asynchronous mode, this call returns immediately.

# Reset Method ([SSHClient](#sshclient-component) Component)

Resets the component settings.

## Syntax

*Delphi Syntax*

```text
procedure Reset();
```

## Remarks

Reset is a generic method available in every component.

# Send Method ([SSHClient](#sshclient-component) Component)

Sends a string to the server.

## Syntax

*Delphi Syntax*

```text
procedure Send(DataStr: String; AddEOL: Boolean);
```

## 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-sshclient-component) event.

# SendBytes Method ([SSHClient](#sshclient-component) Component)

Sends an array of bytes to the server.

## Syntax

*Delphi Syntax*

```text
procedure SendBytes(Data: TBytes);
```

## 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-sshclient-component) event.

# SendSpecial Method ([SSHClient](#sshclient-component) Component)

Sends a special character to the server or remote command.

## Syntax

*Delphi Syntax*

```text
procedure SendSpecial(SpecialChar: String);
```

## 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 ([SSHClient](#sshclient-component) Component)

Fires when a single authentication attempt is performed.

## Syntax

*Delphi Syntax*

```text
type TAuthAttemptEvent = procedure (
  Sender: TObject;
  AuthType: Integer
) of Object;
property OnAuthAttempt: TAuthAttemptEvent read FOnAuthAttempt write FOnAuthAttempt;
```

## 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 ([SSHClient](#sshclient-component) Component)

Fires when a single authentication attempt is failed.

## Syntax

*Delphi Syntax*

```text
type TAuthFailedEvent = procedure (
  Sender: TObject;
  AuthenticationType: Integer
) of Object;
property OnAuthFailed: TAuthFailedEvent read FOnAuthFailed write FOnAuthFailed;
```

## 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 ([SSHClient](#sshclient-component) Component)

Reports a successful authentication.

## Syntax

*Delphi Syntax*

```text
type TAuthSucceededEvent = procedure (
  Sender: TObject
) of Object;
property OnAuthSucceeded: TAuthSucceededEvent read FOnAuthSucceeded write FOnAuthSucceeded;
```

## Remarks

This event may be preceded by some [AuthFailed](#authfailed-event-sshclient-component) events if the client tries different authentication methods one after another.

# Banner Event ([SSHClient](#sshclient-component) Component)

Reports the receipt of the Hello message from the server.

## Syntax

*Delphi Syntax*

```text
type TBannerEvent = procedure (
  Sender: TObject;
  const Text: TBytes;
  const Language: TBytes
) of Object;
property OnBanner: TBannerEvent read FOnBanner write FOnBanner;
```

## Remarks

SFTPClient fires this event when it receives hello message from the server.

# CommandCompleted Event ([SSHClient](#sshclient-component) Component)

Signifies completion of the command execution.

## Syntax

*Delphi Syntax*

```text
type TCommandCompletedEvent = procedure (
  Sender: TObject;
  const Command: String;
  ExitStatus: Integer;
  const ExitMessage: String;
  const ExitSignal: String
) of Object;
property OnCommandCompleted: TCommandCompletedEvent read FOnCommandCompleted write FOnCommandCompleted;
```

## 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-sshclient-component) 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 ([SSHClient](#sshclient-component) Component)

Marks the commencement of a command execution.

## Syntax

*Delphi Syntax*

```text
type TCommandStartEvent = procedure (
  Sender: TObject;
  const Command: String
) of Object;
property OnCommandStart: TCommandStartEvent read FOnCommandStart write FOnCommandStart;
```

## 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-sshclient-component) list, in order. The completion of the command is reported via the [CommandCompleted](#commandcompleted-event-sshclient-component) event.

# Connect Event ([SSHClient](#sshclient-component) Component)

This event is fired when an SSH session has been established.

## Syntax

*Delphi Syntax*

```text
type TConnectEvent = procedure (
  Sender: TObject
) of Object;
property OnConnect: TConnectEvent read FOnConnect write FOnConnect;
```

## Remarks

Use this event to track the moment when SSH session has been set up.

# DataReceived Event ([SSHClient](#sshclient-component) Component)

Reports receipt of another chunk of data from the server.

## Syntax

*Delphi Syntax*

```text
type TDataReceivedEvent = procedure (
  Sender: TObject;
  Channel: Integer;
  BytesReceived: Integer;
  TotalBytesPending: Integer
) of Object;
property OnDataReceived: TDataReceivedEvent read FOnDataReceived write FOnDataReceived;
```

## Remarks

This event fires in asynchronous mode to report the receipt of another chunk of data from the server. Use [Receive](#receive-method-sshclient-component) or [ReceiveBytes](#receivebytes-method-sshclient-component) 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 ([SSHClient](#sshclient-component) Component)

Notifies the application that a piece of data has been sent to the server.

## Syntax

*Delphi Syntax*

```text
type TDataSentEvent = procedure (
  Sender: TObject;
  BytesSent: Integer;
  BytesPending: Integer
) of Object;
property OnDataSent: TDataSentEvent read FOnDataSent write FOnDataSent;
```

## Remarks

Subscribe to this event to be notified about the outbound data flow. This event fires following a call to [Send](#send-method-sshclient-component) or [SendBytes](#sendbytes-method-sshclient-component) 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-sshclient-component) or [SendBytes](#sendbytes-method-sshclient-component) 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 ([SSHClient](#sshclient-component) Component)

This event is fired when the SFTP subsystem connection is closed.

## Syntax

*Delphi Syntax*

```text
type TDisconnectEvent = procedure (
  Sender: TObject;
  CloseReason: Integer
) of Object;
property OnDisconnect: TDisconnectEvent read FOnDisconnect write FOnDisconnect;
```

## Remarks

Do not perform any file operations after this event has been fired.

# Error Event ([SSHClient](#sshclient-component) Component)

Information about errors during SFTP connection.

## Syntax

*Delphi Syntax*

```text
type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
```

## 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-component).

# ExternalSign Event ([SSHClient](#sshclient-component) Component)

Handles remote or external signing initiated by the SignExternal method or other source.

## Syntax

*Delphi Syntax*

```text
type TExternalSignEvent = procedure (
  Sender: TObject;
  const OperationId: String;
  const HashAlgorithm: String;
  const Pars: String;
  const Data: String;
  var SignedData: String
) of Object;
property OnExternalSign: TExternalSignEvent read FOnExternalSign write FOnExternalSign;
```

## Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of *Data* to the signer, obtain the signature, and pass it back to the component via the *SignedData* parameter.

*OperationId* provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters.

The component 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 ([SSHClient](#sshclient-component) Component)

Signals that the server has introduced itself with a known key.

## Syntax

*Delphi Syntax*

```text
type TKnownKeyReceivedEvent = procedure (
  Sender: TObject;
  const Algorithm: String;
  Bits: Integer;
  const FingerprintSHA256: String
) of Object;
property OnKnownKeyReceived: TKnownKeyReceivedEvent read FOnKnownKeyReceived write FOnKnownKeyReceived;
```

## Remarks

The component fires this event to tell the application that the server has introduced itself with a known key from [TrustedKeysFile](#trustedkeysfile-property-sshclient-component).

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](#serverkey-property-sshclient-component) to access more key details.

# Notification Event ([SSHClient](#sshclient-component) Component)

This event notifies the application about an underlying control flow event.

## Syntax

*Delphi Syntax*

```text
type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;
property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;
```

## Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

# PasswordChangeRequest Event ([SSHClient](#sshclient-component) Component)

This event is fired when a password change is requested.

## Syntax

*Delphi Syntax*

```text
type TPasswordChangeRequestEvent = procedure (
  Sender: TObject;
  const Prompt: String;
  var NewPassword: String;
  var Cancel: Boolean
) of Object;
property OnPasswordChangeRequest: TPasswordChangeRequestEvent read FOnPasswordChangeRequest write FOnPasswordChangeRequest;
```

## Remarks

This event is fired by the component 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 ([SSHClient](#sshclient-component) Component)

This event is fired when client's public key was accepted by the server, but the corresponding secret key is not available.

## Syntax

*Delphi Syntax*

```text
type TPrivateKeyNeededEvent = procedure (
  Sender: TObject;
  var Skip: Boolean
) of Object;
property OnPrivateKeyNeeded: TPrivateKeyNeededEvent read FOnPrivateKeyNeeded write FOnPrivateKeyNeeded;
```

## Remarks

Set *Skip* to true when it is not possible to load the missing key for some reason.

# UnknownKeyReceived Event ([SSHClient](#sshclient-component) Component)

Signals that the server has introduced itself with an unknown key.

## Syntax

*Delphi Syntax*

```text
type TUnknownKeyReceivedEvent = procedure (
  Sender: TObject;
  const Algorithm: String;
  Bits: Integer;
  const FingerprintSHA256: String;
  var Action: Integer
) of Object;
property OnUnknownKeyReceived: TUnknownKeyReceivedEvent read FOnUnknownKeyReceived write FOnUnknownKeyReceived;
```

## Remarks

The component fires this event to tell the application that the server has introduced itself with a key not present in [TrustedKeysFile](#trustedkeysfile-property-sshclient-component).

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 component 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.

# ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

## Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

The following fields are available:

- [AsyncDocumentID](#ExternalCrypto_f_AsyncDocumentID)

- [CustomParams](#ExternalCrypto_f_CustomParams)

- [Data](#ExternalCrypto_f_Data)

- [ExternalHashCalculation](#ExternalCrypto_f_ExternalHashCalculation)

- [HashAlgorithm](#ExternalCrypto_f_HashAlgorithm)

- [KeyID](#ExternalCrypto_f_KeyID)

- [KeySecret](#ExternalCrypto_f_KeySecret)

- [Method](#ExternalCrypto_f_Method)

- [Mode](#ExternalCrypto_f_Mode)

- [PublicKeyAlgorithm](#ExternalCrypto_f_PublicKeyAlgorithm)

## Fields

 **AsyncDocumentID** *String*
*Default Value: ""*

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.

 **CustomParams** *String*
*Default Value: ""*

Custom parameters to be passed to the signing service (uninterpreted).

 **Data** *String*
*Default Value: ""*

Additional data to be included in the async state and mirrored back by the requestor.

 **ExternalHashCalculation** *Boolean*
*Default Value: False*

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth component.

If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

 **HashAlgorithm** *String*
*Default Value: "SHA256"*

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 |  |

 **KeyID** *String*
*Default Value: ""*

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 [KeySecret](#ExternalCrypto_f_KeySecret) 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";
```

 **KeySecret** *String*
*Default Value: ""*

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 [KeyID](#ExternalCrypto_f_KeyID) topic.

 **Method** *TsbxAsyncSignMethods*
*Default Value: 0*

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

|  |  |
| --- | --- |
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |

 **Mode** *TsbxExternalCryptoModes*
*Default Value: 0*

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) |

 **PublicKeyAlgorithm** *String*
*Default Value: ""*

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 |  |

## Constructors

 >

*Delphi Syntax*

```text
constructor Create();
```

 Creates a new ExternalCrypto object with default field values.

# ProxySettings Type

A container for proxy server settings.

## Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

The following fields are available:

- [Address](#ProxySettings_f_Address)

- [Authentication](#ProxySettings_f_Authentication)

- [Password](#ProxySettings_f_Password)

- [Port](#ProxySettings_f_Port)

- [ProxyType](#ProxySettings_f_ProxyType)

- [RequestHeaders](#ProxySettings_f_RequestHeaders)

- [ResponseBody](#ProxySettings_f_ResponseBody)

- [ResponseHeaders](#ProxySettings_f_ResponseHeaders)

- [UseIPv6](#ProxySettings_f_UseIPv6)

- [Username](#ProxySettings_f_Username)

## Fields

 **Address** *String*
*Default Value: ""*

The IP address of the proxy server.

 **Authentication** *TsbxProxyAuthTypes*
*Default Value: 0*

The authentication type used by the proxy server.

|  |  |
| --- | --- |
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |

 **Password** *String*
*Default Value: ""*

The password to authenticate to the proxy server.

 **Port** *Integer*
*Default Value: 0*

The port on the proxy server to connect to.

 **ProxyType** *TsbxProxyTypes*
*Default Value: 0*

The type of the proxy server.

|  |  |
| --- | --- |
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |

 **RequestHeaders** *String*
*Default Value: ""*

Contains HTTP request headers for WebTunnel and HTTP proxy.

 **ResponseBody** *String*
*Default Value: ""*

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

 **ResponseHeaders** *String*
*Default Value: ""*

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

 **UseIPv6** *Boolean*
*Default Value: False*

Specifies whether IPv6 should be used when connecting through the proxy.

 **Username** *String*
*Default Value: ""*

Specifies the username credential for proxy authentication.

## Constructors

 >

*Delphi Syntax*

```text
constructor Create();
```

 Creates a new ProxySettings object.

# SocketSettings Type

A container for the socket settings.

## Remarks

This type is a container for socket-layer parameters.

The following fields are available:

- [DNSMode](#SocketSettings_f_DNSMode)

- [DNSPort](#SocketSettings_f_DNSPort)

- [DNSQueryTimeout](#SocketSettings_f_DNSQueryTimeout)

- [DNSServers](#SocketSettings_f_DNSServers)

- [DNSTotalTimeout](#SocketSettings_f_DNSTotalTimeout)

- [IncomingSpeedLimit](#SocketSettings_f_IncomingSpeedLimit)

- [LocalAddress](#SocketSettings_f_LocalAddress)

- [LocalPort](#SocketSettings_f_LocalPort)

- [OutgoingSpeedLimit](#SocketSettings_f_OutgoingSpeedLimit)

- [Timeout](#SocketSettings_f_Timeout)

- [UseIPv6](#SocketSettings_f_UseIPv6)

## Fields

 **DNSMode** *TsbxDNSResolveModes*
*Default Value: 0*

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 |

 **DNSPort** *Integer*
*Default Value: 0*

Specifies the port number to be used for sending queries to the DNS server.

 **DNSQueryTimeout** *Integer*
*Default Value: 0*

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

 **DNSServers** *String*
*Default Value: ""*

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

 **DNSTotalTimeout** *Integer*
*Default Value: 0*

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

 **IncomingSpeedLimit** *Integer*
*Default Value: 0*

The maximum number of bytes to read from the socket, per second.

 **LocalAddress** *String*
*Default Value: ""*

The local network interface to bind the socket to.

 **LocalPort** *Integer*
*Default Value: 0*

The local port number to bind the socket to.

 **OutgoingSpeedLimit** *Integer*
*Default Value: 0*

The maximum number of bytes to write to the socket, per second.

 **Timeout** *Integer*
*Default Value: 60000*

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).

 **UseIPv6** *Boolean*
*Default Value: False*

Enables or disables IP protocol version 6.

## Constructors

 >

*Delphi Syntax*

```text
constructor Create();
```

 Creates a new SocketSettings object.

# SSHConnectionInfo Type

Contains information about SSH connection.

## Remarks

SSHConnectionInfo object contains information about one SSH connection.

The following fields are available:

- [ClientKeyAlgorithm](#SSHConnectionInfo_f_ClientKeyAlgorithm)

- [ClientKeyBits](#SSHConnectionInfo_f_ClientKeyBits)

- [ClientKeyFingerprint](#SSHConnectionInfo_f_ClientKeyFingerprint)

- [CloseReason](#SSHConnectionInfo_f_CloseReason)

- [CompressionAlgorithmInbound](#SSHConnectionInfo_f_CompressionAlgorithmInbound)

- [CompressionAlgorithmOutbound](#SSHConnectionInfo_f_CompressionAlgorithmOutbound)

- [EncryptionAlgorithmInbound](#SSHConnectionInfo_f_EncryptionAlgorithmInbound)

- [EncryptionAlgorithmOutbound](#SSHConnectionInfo_f_EncryptionAlgorithmOutbound)

- [InboundEncryptionKeyBits](#SSHConnectionInfo_f_InboundEncryptionKeyBits)

- [KexAlgorithm](#SSHConnectionInfo_f_KexAlgorithm)

- [KexBits](#SSHConnectionInfo_f_KexBits)

- [KexLines](#SSHConnectionInfo_f_KexLines)

- [MacAlgorithmInbound](#SSHConnectionInfo_f_MacAlgorithmInbound)

- [MacAlgorithmOutbound](#SSHConnectionInfo_f_MacAlgorithmOutbound)

- [OutboundEncryptionKeyBits](#SSHConnectionInfo_f_OutboundEncryptionKeyBits)

- [PublicKeyAlgorithm](#SSHConnectionInfo_f_PublicKeyAlgorithm)

- [RemoteAddress](#SSHConnectionInfo_f_RemoteAddress)

- [RemotePort](#SSHConnectionInfo_f_RemotePort)

- [RemoteSoftwareName](#SSHConnectionInfo_f_RemoteSoftwareName)

- [ServerKeyAlgorithm](#SSHConnectionInfo_f_ServerKeyAlgorithm)

- [ServerKeyBits](#SSHConnectionInfo_f_ServerKeyBits)

- [ServerKeyFingerprint](#SSHConnectionInfo_f_ServerKeyFingerprint)

- [TotalBytesReceived](#SSHConnectionInfo_f_TotalBytesReceived)

- [TotalBytesSent](#SSHConnectionInfo_f_TotalBytesSent)

- [Version](#SSHConnectionInfo_f_Version)

## Fields

 **ClientKeyAlgorithm** *String (read-only)*
*Default Value: ""*

Specifies the client's key algorithm.

 **ClientKeyBits** *Integer (read-only)*
*Default Value: 0*

Specifies the length of the client's key.

 **ClientKeyFingerprint** *String (read-only)*
*Default Value: ""*

The fingerprint (hash value) of the client's public key.

 **CloseReason** *String (read-only)*
*Default Value: ""*

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.

 **CompressionAlgorithmInbound** *String (read-only)*
*Default Value: ""*

Compression algorithm for the incoming traffic.

 **CompressionAlgorithmOutbound** *String (read-only)*
*Default Value: ""*

Compression algorithm for the outgoing traffic.

 **EncryptionAlgorithmInbound** *String (read-only)*
*Default Value: ""*

Encryption algorithm for the incoming traffic.

 **EncryptionAlgorithmOutbound** *String (read-only)*
*Default Value: ""*

Encryption algorithm for the outgoing traffic.

 **InboundEncryptionKeyBits** *Integer (read-only)*
*Default Value: 0*

Specifies the length of the key used to encrypt the incoming traffic.

 **KexAlgorithm** *String (read-only)*
*Default Value: ""*

The key exchange algorithm used during the SSH handshake.

 **KexBits** *Integer (read-only)*
*Default Value: 0*

The number of bits used by the key exchange algorithm.

 **KexLines** *String (read-only)*
*Default Value: ""*

The contents of the received KexInit packet.

KexInit packet contains the list of algorithms supported by the remote party.

 **MacAlgorithmInbound** *String (read-only)*
*Default Value: ""*

MAC algorithm used for the incoming connection.

 **MacAlgorithmOutbound** *String (read-only)*
*Default Value: ""*

MAC algorithm used for outbound connection.

 **OutboundEncryptionKeyBits** *Integer (read-only)*
*Default Value: 0*

Specifies the length of the key used to encrypt the outgoing traffic.

 **PublicKeyAlgorithm** *String (read-only)*
*Default Value: ""*

Specifies the public key algorithm which was used during the SSH handshake.

 **RemoteAddress** *String (read-only)*
*Default Value: ""*

The client's IP address.

 **RemotePort** *Integer (read-only)*
*Default Value: 0*

The remote port of the client connection.

 **RemoteSoftwareName** *String (read-only)*
*Default Value: ""*

Returns the name (self-advertised) of the SSH software running on the other side.

 **ServerKeyAlgorithm** *String (read-only)*
*Default Value: ""*

Specifies the server's key algorithm.

 **ServerKeyBits** *Integer (read-only)*
*Default Value: 0*

Specifies the number of bits in the server's key.

 **ServerKeyFingerprint** *String (read-only)*
*Default Value: ""*

The fingerprint (hash value) of the server's public key.

 **TotalBytesReceived** *Int64 (read-only)*
*Default Value: 0*

Returns the total number of bytes received over this connection.

 **TotalBytesSent** *Int64 (read-only)*
*Default Value: 0*

Returns the total number of bytes sent over this connection.

 **Version** *Integer (read-only)*
*Default Value: 2*

Specifies SSH protocol version.

## Constructors

 >

*Delphi Syntax*

```text
constructor Create();
```

 Creates an empty object representing a SSH connection info.

# SSHKey Type

SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key.

## Remarks

SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits.

The following fields are available:

- [Algorithm](#SSHKey_f_Algorithm)

- [Bits](#SSHKey_f_Bits)

- [Comment](#SSHKey_f_Comment)

- [Curve](#SSHKey_f_Curve)

- [Extractable](#SSHKey_f_Extractable)

- [FingerprintMD5](#SSHKey_f_FingerprintMD5)

- [FingerprintSHA1](#SSHKey_f_FingerprintSHA1)

- [FingerprintSHA256](#SSHKey_f_FingerprintSHA256)

- [Handle](#SSHKey_f_Handle)

- [KeyFormat](#SSHKey_f_KeyFormat)

- [KeyProtectionAlgorithm](#SSHKey_f_KeyProtectionAlgorithm)

- [Private](#SSHKey_f_Private)

- [Public](#SSHKey_f_Public)

- [Subject](#SSHKey_f_Subject)

## Fields

 **Algorithm** *String (read-only)*
*Default Value: ""*

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

 **Bits** *Integer (read-only)*
*Default Value: 0*

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

 **Comment** *String*
*Default Value: ""*

The comment for the public key.

 **Curve** *String (read-only)*
*Default Value: ""*

Specifies the elliptical curve when EC cryptography is used.

The following curves are currently supported:

- NISTP256
- NISTP384
- NISTP521
- NISTK163
- NISTP192
- NISTP224
- NISTK233
- NISTB233
- NISTK283
- NISTK409
- NISTB409
- NISTK571
- CURVE25519 (EdDSA curve)
- CURVE448 (EdDSA curve)

 **Extractable** *Boolean (read-only)*
*Default Value: False*

Whether the key is extractable (e.g., from a security token), or not.

 **FingerprintMD5** *String (read-only)*
*Default Value: ""*

Contains the MD5 fingerprint (hash) of the key.

 **FingerprintSHA1** *String (read-only)*
*Default Value: ""*

Contains the SHA-1 fingerprint (hash) of the key.

 **FingerprintSHA256** *String (read-only)*
*Default Value: ""*

Contains the SHA-256 fingerprint (hash) of the key.

 **Handle** *Int64*
*Default Value: 0*

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

 **KeyFormat** *TsbxSSHKeyFormats (read-only)*
*Default Value: 0*

Specifies the format in which the key is stored.

|  |  |  |
| --- | --- | --- |
| ckfOpenSSH | 0 |  |
| ckfOpenSSH2 | 1 |  |
| ckfIETF | 2 |  |
| ckfPuTTY | 3 |  |
| ckfX509 | 4 |  |
| ckfBinary | 5 |  |
| ckfSSH1 | 6 |  |
| ckfPGP | 7 |  |
| ckfPKCS8 | 8 |  |
| ckfPuTTY3 | 9 |  |
| ckfOpenSSHCert | 10 |  |

 **KeyProtectionAlgorithm** *String (read-only)*
*Default Value: ""*

Specifies the key protection algorithm.

 **Private** *Boolean (read-only)*
*Default Value: False*

Whether this key is a private key or not.

 **Public** *Boolean (read-only)*
*Default Value: False*

Whether this key is a public key or not.

 **Subject** *String*
*Default Value: ""*

Specifies the public key owner (subject). This property is used only for IETF-keys.

## Constructors

 >

*Delphi Syntax*

```text
constructor Create();
```

 Creates a new key.

# SSHSettings Type

A container for various SSH protocol settings.

## Remarks

SSHSettings stores various settings of SSH client or server.

The following fields are available:

- [AutoAdjustCiphers](#SSHSettings_f_AutoAdjustCiphers)

- [BaseConfiguration](#SSHSettings_f_BaseConfiguration)

- [CompressionAlgorithms](#SSHSettings_f_CompressionAlgorithms)

- [CompressionLevel](#SSHSettings_f_CompressionLevel)

- [DefaultWindowSize](#SSHSettings_f_DefaultWindowSize)

- [EncryptionAlgorithms](#SSHSettings_f_EncryptionAlgorithms)

- [ForceCompression](#SSHSettings_f_ForceCompression)

- [ForwardAuthAgent](#SSHSettings_f_ForwardAuthAgent)

- [GSSAuthTypes](#SSHSettings_f_GSSAuthTypes)

- [GSSDelegateCreds](#SSHSettings_f_GSSDelegateCreds)

- [GSSHostname](#SSHSettings_f_GSSHostname)

- [GSSLib](#SSHSettings_f_GSSLib)

- [GSSMechanisms](#SSHSettings_f_GSSMechanisms)

- [GSSProtocols](#SSHSettings_f_GSSProtocols)

- [HandshakeTimeout](#SSHSettings_f_HandshakeTimeout)

- [KexAlgorithms](#SSHSettings_f_KexAlgorithms)

- [MacAlgorithms](#SSHSettings_f_MacAlgorithms)

- [MaxSSHPacketSize](#SSHSettings_f_MaxSSHPacketSize)

- [MinWindowSize](#SSHSettings_f_MinWindowSize)

- [ObfuscateHandshake](#SSHSettings_f_ObfuscateHandshake)

- [ObfuscationPassword](#SSHSettings_f_ObfuscationPassword)

- [PublicKeyAlgorithms](#SSHSettings_f_PublicKeyAlgorithms)

- [RequestPasswordChange](#SSHSettings_f_RequestPasswordChange)

- [SoftwareName](#SSHSettings_f_SoftwareName)

- [TrustAllKeys](#SSHSettings_f_TrustAllKeys)

- [UseAuthAgent](#SSHSettings_f_UseAuthAgent)

- [Versions](#SSHSettings_f_Versions)

## Fields

 **AutoAdjustCiphers** *Boolean*
*Default Value: True*

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

 **BaseConfiguration** *TsbxSecureTransportPredefinedConfigurations*
*Default Value: 0*

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

 **CompressionAlgorithms** *String*
*Default Value: ""*

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

 **CompressionLevel** *Integer*
*Default Value: 6*

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted.

 **DefaultWindowSize** *Integer*
*Default Value: 2048000*

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.

 **EncryptionAlgorithms** *String*
*Default Value: ""*

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

 **ForceCompression** *Boolean*
*Default Value: False*

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.

 **ForwardAuthAgent** *Boolean*
*Default Value: False*

Enables or disables auth agent forwarding. This allows the component to connect to the second and subsequent servers in the chain with the key agent available on the client computer.

 **GSSAuthTypes** *String*
*Default Value: ""*

A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex.

 **GSSDelegateCreds** *Boolean*
*Default Value: False*

Switches credential delegation on or off.

 **GSSHostname** *String*
*Default Value: ""*

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).

 **GSSLib** *String*
*Default Value: ""*

A path to the GSS-API library (DLL or SO).

 **GSSMechanisms** *String*
*Default Value: ""*

A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI.

 **GSSProtocols** *String*
*Default Value: ""*

A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM.

 **HandshakeTimeout** *Integer*
*Default Value: 45*

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.

 **KexAlgorithms** *String*
*Default Value: ""*

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

 **MacAlgorithms** *String*
*Default Value: ""*

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

 **MaxSSHPacketSize** *Integer*
*Default Value: 262144*

Specifies the maximum length of one SSH packet in bytes.

 **MinWindowSize** *Integer*
*Default Value: 2048*

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.

 **ObfuscateHandshake** *Boolean*
*Default Value: False*

Enables or disables handshake obfuscation.

 **ObfuscationPassword** *String*
*Default Value: ""*

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

 **PublicKeyAlgorithms** *String*
*Default Value: ""*

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

 **RequestPasswordChange** *Boolean*
*Default Value: False*

Whether to request a password change when connecting.

 **SoftwareName** *String*
*Default Value: "SecureBlackbox"*

The name to be used by the component to identify itself.

 **TrustAllKeys** *Boolean*
*Default Value: False*

Enables or disables explicit trust to all server keys. Use with care.

 **UseAuthAgent** *Boolean*
*Default Value: False*

Enables or disables the use of external key agent, such as Putty key agent.

 **Versions** *Integer*
*Default Value: 1*

Specifies enabled SSH protocol versions (1 or 2).

## Constructors

 >

*Delphi Syntax*

```text
constructor Create();
```

 Creates a new object with default settings.

# SSHTerm Type

A container for SSH terminal settings.

## Remarks

SSHTerm stores terminal settings of the SSH client.

The following fields are available:

- [Cols](#SSHTerm_f_Cols)

- [Environment](#SSHTerm_f_Environment)

- [EOLChar](#SSHTerm_f_EOLChar)

- [Height](#SSHTerm_f_Height)

- [Opcodes](#SSHTerm_f_Opcodes)

- [Protocol](#SSHTerm_f_Protocol)

- [RequestPty](#SSHTerm_f_RequestPty)

- [Rows](#SSHTerm_f_Rows)

- [Width](#SSHTerm_f_Width)

## Fields

 **Cols** *Integer*
*Default Value: 80*

Specifies the width of the pseudoterminal, in characters.

 **Environment** *String*
*Default Value: ""*

Specifies the list of environment variables.

 **EOLChar** *TBytes*
*Default Value: ""*

Specifies the End-of-Line character or sequence.

 **Height** *Integer*
*Default Value: 0*

Specifies the height of the pseudoterminal, in pixels.

 **Opcodes** *String*
*Default Value: ""*

Specifies the operation codes specific for the terminal.

 **Protocol** *String*
*Default Value: "vt100"*

The terminal protocol name.

 **RequestPty** *Boolean*
*Default Value: True*

Specifies whether to request a pseudoterminal for the session.

 **Rows** *Integer*
*Default Value: 25*

Specifies the height of the pseudoterminal, in lines.

 **Width** *Integer*
*Default Value: 0*

Specifies the width of the pseudoterminal, in pixels.

# Config Settings ([SSHClient](#sshclient-component) Component)

 The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-sshclient-component) 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 component will indicate support for strict key exchange by automatically including the pseudo-algorithm *kex-strict-c-v00@openssh.com* for client components and *kex-strict-s-v00@openssh.com* for server components 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 component 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 component. |
| 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 component.

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the component.Use this property to get cookies from the internal cookie storage of the component 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 components 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 components.

**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 component. 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 component) 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 component is set to "*local*", the property returns/restores the rules from/to the internal storage of the component. If *StaticDNS* of the component 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 components.

**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-component) Component)