Docs

SecureBlackbox 2022 .NET Edition

Version 22.0 [Build 8174]

SSHClient Component

Properties   Methods   Events   Configuration Settings   Errors  

The SSHClient component provides client-side SSH protocol functionality

Syntax

nsoftware.SecureBlackbox.Sshclient

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 and Password properties. Where public key authentication is to be used, assign your private authentication key to Key property (remember to set Username in this case too). Subscribe to events to be notified of the session progress. AuthFailed, AuthSucceeded, and Connect 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 property. If you don't have such file, or if you would like to make trust decisions on the fly, subscribe to KnownKeyReceived and UnknownKeyReceived 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 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 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 and Receive methods to exchange information with the server. You can exchange data in synchronous or asynchronous way; see the description in AsyncMode topic to learn more about each mode.

When you are done with the session, call Disconnect 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 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.

AsyncModeControls the SSH clients mode of work.
AuthAttemptsSpecifies the number of SSH password authentication attempts.
CommandsSpecifies the list of commands to execute
ConnectedSpecifies whether the client is connected to the SFTP server.
ConnectionInfoContains the secure connection info.
ExitMessageContains the last commands exit message
ExitSignalContains the last commands exit signal
ExitStatusContains the last commands exit status.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
KeyContains client's SSH key.
PasswordSpecifies user's password on the server.
ProxyAllows connection through a proxy server.
ServerKeyReturns server's public key.
SocketSettingsManages network connection settings.
SSHSettingsProvides access to SSH connection settings.
SubsystemSpecifies the subsystem to request from the server.
TerminalProvides access to SSH terminal settings object
TrustedKeysFilePath to the file containing public keys of authorized servers.
UsernameSpecifies 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.

ConfigSets or retrieves a configuration setting.
ConnectEstablishes connection to an SSH server.
ConnectAndExecConnects to an SSH server and executes a command in one go.
DisconnectCloses connection to the SSH server.
DoActionPerforms an additional action.
PingSends a keep-alive request to the SSH server.
PollChecks whether there is any inbound data readily available.
ReceiveReads a portion of received data into a string.
ReceiveBytesReads a portion of received data into a byte array.
ReceiveBytesFromReads a portion of data received via a specific channel into a byte array.
ReceiveFromReads a portion of data received via a specific channel into a string.
SendSends a string to the server.
SendBytesSends an array of bytes to the server.
SendSpecialSends 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.

AuthAttemptFires when a single authentication attempt is performed.
AuthFailedFires when a single authentication attempt is failed.
AuthSucceededReports a successful authentication.
BannerReports the receipt of the Hello message from the server.
CommandCompletedSignifies completion of the command execution.
CommandStartMarks the commencement of a command execution.
ConnectThis event is fired when an SSH session has been established.
DataReceivedReports receipt of another chunk of data from the server.
DataSentNotifies the application that a piece of data has been sent to the server.
DisconnectThis event is fired when the SFTP subsystem connection is closed.
ErrorInformation about errors during SFTP connection.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
KnownKeyReceivedSignals that the server has introduced itself with a known key.
NotificationThis event notifies the application about an underlying control flow event.
PasswordChangeRequestThis event is fired when a password change is requested.
PrivateKeyNeededThis event is fired when client's public key was accepted by the server, but the corresponding secret key is not available.
UnknownKeyReceivedSignals that the server has introduced itself with an unknown key.

Configuration Settings


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

BlockSizeThe data block size.
ErrorOriginSpecifies whether the error is local or remote.
ErrorSeveritySpecifies whether the error is fatal.
LocalCharsetCharset used on the client machine.
RemoteCharsetCharset used on the server.
SendCommandEOFDefines whether EOF control character should be sent after the command data.
ThrottleControlEnables or disables throttle control for the connection.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
TagAllows to store any custom data.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

AsyncMode Property (SSHClient Component)

Controls the SSH clients mode of work.

Syntax

public bool AsyncMode { get; set; }
Public Property AsyncMode As Boolean

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, Receive or SendBytes may block until their execution completes. In asyncronous 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 or SendBytes may block
  • Use Poll to check for the availability of data before reading it out with Receive or ReceiveBytes
  • 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 return immediately
  • Use DataSent and DataReceived 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 event, often followed by Disconnect.

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

Specifies the number of SSH password authentication attempts.

Syntax

public int AuthAttempts { get; set; }
Public Property AuthAttempts As Integer

Default Value

1

Remarks

In case of password authentication failure provide new password inside the AuthFailed event handler.

Commands Property (SSHClient Component)

Specifies the list of commands to execute

Syntax

public string Commands { get; set; }
Public Property Commands As String

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

Specifies whether the client is connected to the SFTP server.

Syntax

public bool Connected { get; }
Public ReadOnly Property Connected As Boolean

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

Contains the secure connection info.

Syntax

public SSHInfo ConnectionInfo { get; }
Public ReadOnly Property ConnectionInfo As SSHInfo

Remarks

This property contains various information about the secure connection.

This property is read-only.

ExitMessage Property (SSHClient Component)

Contains the last commands exit message

Syntax

public string ExitMessage { get; }
Public ReadOnly Property ExitMessage As String

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

Contains the last commands exit signal

Syntax

public string ExitSignal { get; }
Public ReadOnly Property ExitSignal As String

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

Contains the last commands exit status.

Syntax

public int ExitStatus { get; }
Public ReadOnly Property ExitStatus As Integer

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

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto ExternalCrypto { get; }
Public ReadOnly Property ExternalCrypto As ExternalCrypto

Remarks

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

This property is read-only.

FIPSMode Property (SSHClient Component)

Reserved.

Syntax

public bool FIPSMode { get; set; }
Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

Key Property (SSHClient Component)

Contains client's SSH key.

Syntax

public SSHKey Key { get; set; }
Public Property Key As SSHKey

Remarks

Server's public key is returned by ServerKey property.

Password Property (SSHClient Component)

Specifies user's password on the server.

Syntax

public string Password { get; set; }
Public Property Password As String

Default Value

""

Remarks

Invalid password fires the AuthFailed event.

Proxy Property (SSHClient Component)

Allows connection through a proxy server.

Syntax

public ProxySettings Proxy { get; }
Public ReadOnly Property Proxy As ProxySettings

Remarks

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

This property is read-only.

ServerKey Property (SSHClient Component)

Returns server's public key.

Syntax

public SSHKey ServerKey { get; }
Public ReadOnly Property ServerKey As SSHKey

Remarks

Client's SSH key is specified by Key.

This property is read-only.

SocketSettings Property (SSHClient Component)

Manages network connection settings.

Syntax

public SocketSettings SocketSettings { get; }
Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

SSHSettings Property (SSHClient Component)

Provides access to SSH connection settings.

Syntax

public SSHSettings SSHSettings { get; }
Public ReadOnly Property SSHSettings As SSHSettings

Remarks

Use this property to configure SSH protocol settings.

This property is read-only.

Subsystem Property (SSHClient Component)

Specifies the subsystem to request from the server.

Syntax

public string Subsystem { get; set; }
Public Property Subsystem As String

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

Provides access to SSH terminal settings object

Syntax

public SSHTerm Terminal { get; }
Public ReadOnly Property Terminal As SSHTerm

Remarks

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

This property is read-only.

TrustedKeysFile Property (SSHClient Component)

Path to the file containing public keys of authorized servers.

Syntax

public string TrustedKeysFile { get; set; }
Public Property TrustedKeysFile As String

Default Value

""

Remarks

Path to the file containing public keys of authorized servers.

Username Property (SSHClient Component)

Specifies client's username on the server.

Syntax

public string Username { get; set; }
Public Property Username As String

Default Value

""

Remarks

Client's password is set by Password property. ;

Config Method (SSHClient Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);
Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (SSHClient Component)

Establishes connection to an SSH server.

Syntax

public void Connect(string address, int port);
Public Sub Connect(ByVal Address As String, ByVal Port As 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 and Password properties. You might also need to configure the server key validation routine. You can do this by subscribing to KnownKeyReceived and UnknownKeyReceived events and implementing the event handlers as required.

Adjust AsyncMode 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, 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 topic.

ConnectAndExec Method (SSHClient Component)

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

Syntax

public byte[] ConnectAndExec(string address, int port, string command, bool wantStdout, bool wantStdErr);
Public Function ConnectAndExec(ByVal Address As String, ByVal Port As Integer, ByVal Command As String, ByVal WantStdout As Boolean, ByVal WantStdErr As Boolean) As Byte()

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, Receive, Disconnect internally to save you time and space.

Please note that ConnectAndExec always runs synchronously, thus ignoring the AsyncMode setting.

Disconnect Method (SSHClient Component)

Closes connection to the SSH server.

Syntax

public void Disconnect();
Public Sub 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 and/or ReceiveBytes methods.

DoAction Method (SSHClient Component)

Performs an additional action.

Syntax

public string DoAction(string actionID, string actionParams);
Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As 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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Ping Method (SSHClient Component)

Sends a keep-alive request to the SSH server.

Syntax

public void Ping();
Public Sub 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 Component)

Checks whether there is any inbound data readily available.

Syntax

public bool Poll(int milliseconds);
Public Function Poll(ByVal Milliseconds As Integer) As 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 or ReceiveBytes calls.

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

Receive Method (SSHClient Component)

Reads a portion of received data into a string.

Syntax

public string Receive();
Public Function Receive() As 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 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 event handler. When working in asynchronous mode, this call returns immediately.

This method only returns data that arrives via the stdout channel. Use ReceiveFrom to read stderr data.

ReceiveBytes Method (SSHClient Component)

Reads a portion of received data into a byte array.

Syntax

public byte[] ReceiveBytes(int maxLen);
Public Function ReceiveBytes(ByVal MaxLen As Integer) As Byte()

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

This method only returns data that arrives via the stdout channel. Use ReceiveBytesFrom to read stderr data.

ReceiveBytesFrom Method (SSHClient Component)

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

Syntax

public byte[] ReceiveBytesFrom(int channel, int maxLen);
Public Function ReceiveBytesFrom(ByVal Channel As Integer, ByVal MaxLen As Integer) As Byte()

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

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

Syntax

public string ReceiveFrom(int channel);
Public Function ReceiveFrom(ByVal Channel As Integer) As 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 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 event handler. When working in asynchronous mode, this call returns immediately.

Send Method (SSHClient Component)

Sends a string to the server.

Syntax

public void Send(string dataStr, bool addEOL);
Public Sub Send(ByVal DataStr As String, ByVal AddEOL As 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 commited 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 event.

SendBytes Method (SSHClient Component)

Sends an array of bytes to the server.

Syntax

public void SendBytes(byte[] data);
Public Sub SendBytes(ByVal Data As Byte())

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 commited 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 event.

SendSpecial Method (SSHClient Component)

Sends a special character to the server or remote command.

Syntax

public void SendSpecial(string specialChar);
Public Sub SendSpecial(ByVal SpecialChar As 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 Component)

Fires when a single authentication attempt is performed.

Syntax

public event OnAuthAttemptHandler OnAuthAttempt;

public delegate void OnAuthAttemptHandler(object sender, SshclientAuthAttemptEventArgs e);

public class SshclientAuthAttemptEventArgs : EventArgs {
  public int AuthType { get; }

}
Public Event OnAuthAttempt As OnAuthAttemptHandler

Public Delegate Sub OnAuthAttemptHandler(sender As Object, e As SshclientAuthAttemptEventArgs)

Public Class SshclientAuthAttemptEventArgs Inherits EventArgs
  Public ReadOnly Property AuthType As Integer

End Class

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

Fires when a single authentication attempt is failed.

Syntax

public event OnAuthFailedHandler OnAuthFailed;

public delegate void OnAuthFailedHandler(object sender, SshclientAuthFailedEventArgs e);

public class SshclientAuthFailedEventArgs : EventArgs {
  public int AuthenticationType { get; }

}
Public Event OnAuthFailed As OnAuthFailedHandler

Public Delegate Sub OnAuthFailedHandler(sender As Object, e As SshclientAuthFailedEventArgs)

Public Class SshclientAuthFailedEventArgs Inherits EventArgs
  Public ReadOnly Property AuthenticationType As Integer

End Class

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

Reports a successful authentication.

Syntax

public event OnAuthSucceededHandler OnAuthSucceeded;

public delegate void OnAuthSucceededHandler(object sender, SshclientAuthSucceededEventArgs e);

public class SshclientAuthSucceededEventArgs : EventArgs {
}
Public Event OnAuthSucceeded As OnAuthSucceededHandler

Public Delegate Sub OnAuthSucceededHandler(sender As Object, e As SshclientAuthSucceededEventArgs)

Public Class SshclientAuthSucceededEventArgs Inherits EventArgs
End Class

Remarks

This event may be preceded by some AuthFailed events if the client tries different authentication methods one after another.

Banner Event (SSHClient Component)

Reports the receipt of the Hello message from the server.

Syntax

public event OnBannerHandler OnBanner;

public delegate void OnBannerHandler(object sender, SshclientBannerEventArgs e);

public class SshclientBannerEventArgs : EventArgs {
  public string Text { get; }
public byte[] TextB { get; } public string Language { get; }
public byte[] LanguageB { get; } }
Public Event OnBanner As OnBannerHandler

Public Delegate Sub OnBannerHandler(sender As Object, e As SshclientBannerEventArgs)

Public Class SshclientBannerEventArgs Inherits EventArgs
  Public ReadOnly Property Text As String
Public ReadOnly Property TextB As Byte() Public ReadOnly Property Language As String
Public ReadOnly Property LanguageB As Byte() End Class

Remarks

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

CommandCompleted Event (SSHClient Component)

Signifies completion of the command execution.

Syntax

public event OnCommandCompletedHandler OnCommandCompleted;

public delegate void OnCommandCompletedHandler(object sender, SshclientCommandCompletedEventArgs e);

public class SshclientCommandCompletedEventArgs : EventArgs {
  public string Command { get; }

  public int ExitStatus { get; }

  public string ExitMessage { get; }

  public string ExitSignal { get; }

}
Public Event OnCommandCompleted As OnCommandCompletedHandler

Public Delegate Sub OnCommandCompletedHandler(sender As Object, e As SshclientCommandCompletedEventArgs)

Public Class SshclientCommandCompletedEventArgs Inherits EventArgs
  Public ReadOnly Property Command As String

  Public ReadOnly Property ExitStatus As Integer

  Public ReadOnly Property ExitMessage As String

  Public ReadOnly Property ExitSignal As String

End Class

Remarks

Subscribe to this event to be notified about completion of the remote command execution. This event fires for every command in the Commands 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 Component)

Marks the commencement of a command execution.

Syntax

public event OnCommandStartHandler OnCommandStart;

public delegate void OnCommandStartHandler(object sender, SshclientCommandStartEventArgs e);

public class SshclientCommandStartEventArgs : EventArgs {
  public string Command { get; }

}
Public Event OnCommandStart As OnCommandStartHandler

Public Delegate Sub OnCommandStartHandler(sender As Object, e As SshclientCommandStartEventArgs)

Public Class SshclientCommandStartEventArgs Inherits EventArgs
  Public ReadOnly Property Command As String

End Class

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 list, in order. The completion of the command is reported via the CommandCompleted event.

Connect Event (SSHClient Component)

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

Syntax

public event OnConnectHandler OnConnect;

public delegate void OnConnectHandler(object sender, SshclientConnectEventArgs e);

public class SshclientConnectEventArgs : EventArgs {
}
Public Event OnConnect As OnConnectHandler

Public Delegate Sub OnConnectHandler(sender As Object, e As SshclientConnectEventArgs)

Public Class SshclientConnectEventArgs Inherits EventArgs
End Class

Remarks

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

DataReceived Event (SSHClient Component)

Reports receipt of another chunk of data from the server.

Syntax

public event OnDataReceivedHandler OnDataReceived;

public delegate void OnDataReceivedHandler(object sender, SshclientDataReceivedEventArgs e);

public class SshclientDataReceivedEventArgs : EventArgs {
  public int Channel { get; }

  public int BytesReceived { get; }

  public int TotalBytesPending { get; }

}
Public Event OnDataReceived As OnDataReceivedHandler

Public Delegate Sub OnDataReceivedHandler(sender As Object, e As SshclientDataReceivedEventArgs)

Public Class SshclientDataReceivedEventArgs Inherits EventArgs
  Public ReadOnly Property Channel As Integer

  Public ReadOnly Property BytesReceived As Integer

  Public ReadOnly Property TotalBytesPending As Integer

End Class

Remarks

This event fires in asynchronous mode to report the receipt of another chunk of data from the server. Use Receive or ReceiveBytes 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 Component)

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

Syntax

public event OnDataSentHandler OnDataSent;

public delegate void OnDataSentHandler(object sender, SshclientDataSentEventArgs e);

public class SshclientDataSentEventArgs : EventArgs {
  public int BytesSent { get; }

  public int BytesPending { get; }

}
Public Event OnDataSent As OnDataSentHandler

Public Delegate Sub OnDataSentHandler(sender As Object, e As SshclientDataSentEventArgs)

Public Class SshclientDataSentEventArgs Inherits EventArgs
  Public ReadOnly Property BytesSent As Integer

  Public ReadOnly Property BytesPending As Integer

End Class

Remarks

Subscribe to this event to be notified about the outbound data flow. This event fires following a call to Send or SendBytes 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 or SendBytes 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 Component)

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

Syntax

public event OnDisconnectHandler OnDisconnect;

public delegate void OnDisconnectHandler(object sender, SshclientDisconnectEventArgs e);

public class SshclientDisconnectEventArgs : EventArgs {
  public int CloseReason { get; }

}
Public Event OnDisconnect As OnDisconnectHandler

Public Delegate Sub OnDisconnectHandler(sender As Object, e As SshclientDisconnectEventArgs)

Public Class SshclientDisconnectEventArgs Inherits EventArgs
  Public ReadOnly Property CloseReason As Integer

End Class

Remarks

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

Error Event (SSHClient Component)

Information about errors during SFTP connection.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, SshclientErrorEventArgs e);

public class SshclientErrorEventArgs : EventArgs {
  public int ErrorCode { get; }

  public string Description { get; }

}
Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As SshclientErrorEventArgs)

Public Class SshclientErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer

  Public ReadOnly Property Description As String

End Class

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.

ExternalSign Event (SSHClient Component)

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

Syntax

public event OnExternalSignHandler OnExternalSign;

public delegate void OnExternalSignHandler(object sender, SshclientExternalSignEventArgs e);

public class SshclientExternalSignEventArgs : EventArgs {
  public string OperationId { get; }

  public string HashAlgorithm { get; }

  public string Pars { get; }

  public string Data { get; }

  public string SignedData { get; set; }

}
Public Event OnExternalSign As OnExternalSignHandler

Public Delegate Sub OnExternalSignHandler(sender As Object, e As SshclientExternalSignEventArgs)

Public Class SshclientExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property OperationId As String

  Public ReadOnly Property HashAlgorithm As String

  Public ReadOnly Property Pars As String

  Public ReadOnly Property Data As String

  Public Property SignedData As String

End Class

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 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 contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for 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 a .NET RSACryptoServiceProvider class may look like the following: 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 Component)

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

Syntax

public event OnKnownKeyReceivedHandler OnKnownKeyReceived;

public delegate void OnKnownKeyReceivedHandler(object sender, SshclientKnownKeyReceivedEventArgs e);

public class SshclientKnownKeyReceivedEventArgs : EventArgs {
  public string Algorithm { get; }

  public int Bits { get; }

  public string FingerprintSHA256 { get; }

}
Public Event OnKnownKeyReceived As OnKnownKeyReceivedHandler

Public Delegate Sub OnKnownKeyReceivedHandler(sender As Object, e As SshclientKnownKeyReceivedEventArgs)

Public Class SshclientKnownKeyReceivedEventArgs Inherits EventArgs
  Public ReadOnly Property Algorithm As String

  Public ReadOnly Property Bits As Integer

  Public ReadOnly Property FingerprintSHA256 As String

End Class

Remarks

The component fires this event to tell the application that the server has introduced itself with a known key from TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

Use ServerKey to access more key details.

Notification Event (SSHClient Component)

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

Syntax

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, SshclientNotificationEventArgs e);

public class SshclientNotificationEventArgs : EventArgs {
  public string EventID { get; }

  public string EventParam { get; }

}
Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As SshclientNotificationEventArgs)

Public Class SshclientNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String

  Public ReadOnly Property EventParam As String

End Class

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

This event is fired when a password change is requested.

Syntax

public event OnPasswordChangeRequestHandler OnPasswordChangeRequest;

public delegate void OnPasswordChangeRequestHandler(object sender, SshclientPasswordChangeRequestEventArgs e);

public class SshclientPasswordChangeRequestEventArgs : EventArgs {
  public string Prompt { get; }

  public string NewPassword { get; set; }

  public bool Cancel { get; set; }

}
Public Event OnPasswordChangeRequest As OnPasswordChangeRequestHandler

Public Delegate Sub OnPasswordChangeRequestHandler(sender As Object, e As SshclientPasswordChangeRequestEventArgs)

Public Class SshclientPasswordChangeRequestEventArgs Inherits EventArgs
  Public ReadOnly Property Prompt As String

  Public Property NewPassword As String

  Public Property Cancel As Boolean

End Class

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

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

Syntax

public event OnPrivateKeyNeededHandler OnPrivateKeyNeeded;

public delegate void OnPrivateKeyNeededHandler(object sender, SshclientPrivateKeyNeededEventArgs e);

public class SshclientPrivateKeyNeededEventArgs : EventArgs {
  public bool Skip { get; set; }

}
Public Event OnPrivateKeyNeeded As OnPrivateKeyNeededHandler

Public Delegate Sub OnPrivateKeyNeededHandler(sender As Object, e As SshclientPrivateKeyNeededEventArgs)

Public Class SshclientPrivateKeyNeededEventArgs Inherits EventArgs
  Public Property Skip As Boolean

End Class

Remarks

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

UnknownKeyReceived Event (SSHClient Component)

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

Syntax

public event OnUnknownKeyReceivedHandler OnUnknownKeyReceived;

public delegate void OnUnknownKeyReceivedHandler(object sender, SshclientUnknownKeyReceivedEventArgs e);

public class SshclientUnknownKeyReceivedEventArgs : EventArgs {
  public string Algorithm { get; }

  public int Bits { get; }

  public string FingerprintSHA256 { get; }

  public int Action { get; set; }

}
Public Event OnUnknownKeyReceived As OnUnknownKeyReceivedHandler

Public Delegate Sub OnUnknownKeyReceivedHandler(sender As Object, e As SshclientUnknownKeyReceivedEventArgs)

Public Class SshclientUnknownKeyReceivedEventArgs Inherits EventArgs
  Public ReadOnly Property Algorithm As String

  Public ReadOnly Property Bits As Integer

  Public ReadOnly Property FingerprintSHA256 As String

  Public Property Action As Integer

End Class

Remarks

The component fires this event to tell the application that the server has introduced itself with a key not present in TrustedKeysFile.

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:

catAcceptOnce1Accept the key for the current session only.
catAcceptPermanently2Accept the key for the current session and store the key to the trusted keys list.
catReject3Reject 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.

Fields

AsyncDocumentID
String

Specifies the document ID for SignAsyncEnd() call

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner 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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

CustomParams
String

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

Data
String

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

ExternalHashCalculation
Boolean

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

HashAlgorithm
String

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

KeyID
String

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 extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use 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: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

KeySecret
String

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

Method
AsyncSignMethods

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

Available options:

asmdPKCS10
asmdPKCS71

Mode
ExternalCryptoModes

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

PublicKeyAlgorithm
String

Provide public key algorithm here if the certificate is not available on the pre-signing stage.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Constructors

public ExternalCrypto();
Public ExternalCrypto()

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.

Fields

Address
String

The IP address of the proxy server.

Authentication
ProxyAuthTypes

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

Password
String

The password to authenticate to the proxy server.

Port
Integer

The port on the proxy server to connect to.

ProxyType
ProxyTypes

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

RequestHeaders
String

Contains HTTP request headers for WebTunnel and HTTP proxy.

ResponseBody
String

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

ResponseHeaders
String

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

UseIPv6
Boolean

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

UseProxy
Boolean

Enables or disables proxy-driven connection.

Username
String

Specifies the username credential for proxy authentication.

Constructors

public ProxySettings();
Public ProxySettings()

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

DNSMode
DNSResolveModes

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

DNSPort
Integer

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

DNSQueryTimeout
Integer

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

DNSServers
String

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

DNSTotalTimeout
Integer

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

IncomingSpeedLimit
Integer

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

LocalAddress
String

The local network interface to bind the socket to.

LocalPort
Integer

The local port number to bind the socket to.

OutgoingSpeedLimit
Integer

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

Timeout
Integer

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

Enables or disables IP protocol version 6.

Constructors

public SocketSettings();
Public SocketSettings()

Creates a new SocketSettings object.

SSHInfo Type

Contains information about SSH connection.

Remarks

SSHInfo object contains information about one SSH connection.

Fields

ClientKeyAlgorithm
String

Specifies the client's key algorithm.

ClientKeyBits
Integer

Specifies the length of the client's key.

ClientKeyFingerprint
String

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

CloseReason
String

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

Compression algorithm for the incoming traffic.

CompressionAlgorithmOutbound
String

Compression algorithm for the outgoing traffic.

EncryptionAlgorithmInbound
String

Encryption algorithm for the incoming traffic.

EncryptionAlgorithmOutbound
String

Encryption algorithm for the outgoing traffic.

InboundEncryptionKeyBits
Integer

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

KexAlgorithm
String

The key exchange algorithm used during the SSH handshake.

KexBits
Integer

The number of bits used by the key exchange algorithm.

KexLines
String

The contents of the received KexInit packet.

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

MacAlgorithmInbound
String

MAC algorithm used for the incoming connection.

MacAlgorithmOutbound
String

MAC algorithm used for outbound connection.

OutboundEncryptionKeyBits
Integer

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

PublicKeyAlgorithm
String

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

ServerKeyBits
Integer

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

ServerKeyFingerprint
String

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

ServerSoftwareName
String

Returns the name of the SSH software running on the server side.

TotalBytesReceived
Long

Returns the total number of bytes received over this connection.

TotalBytesSent
Long

Returns the total number of bytes sent over this connection.

Version
Integer

Specifies SSH protocol version.

Constructors

public SSHInfo();
Public SSHInfo()

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.

Fields

Algorithm
String

Specifies the key algorithm.

Bits
Integer

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

Comment
String

The comment for the public key.

Curve
String

Specifies the elliptical curve when EC cryptography is used.

DSSG
Byte()

The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.

DSSP
Byte()

The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.

DSSQ
Byte()

The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.

DSSX
Byte()

The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.

This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).

DSSY
Byte()

The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.

ECCD
Byte()

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.

ECCQX
Byte()

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.

ECCQY
Byte()

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.

EdPrivate
Byte()

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

EdPublic
Byte()

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

FingerprintMD5
String

Contains the MD5 fingerprint (hash) of the key.

FingerprintSHA1
String

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

FingerprintSHA256
String

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

IsExtractable
Boolean

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

IsPrivate
Boolean

Whether this key is a private key or not.

IsPublic
Boolean

Whether this key is a public key or not.

KDFRounds
Integer

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

KDFSalt
Byte()

The salt value used by the Key Derivation Function (KDF) to generate this key.

KeyFormat
SSHKeyFormats

Specifies the format in which the key is stored.

ckfOpenSSH0
ckfOpenSSH21
ckfIETF2
ckfPuTTY3
ckfX5094
ckfBinary5
ckfSSH16
ckfPGP7
ckfPKCS88

KeyProtectionAlgorithm
String

Specifies the key protection algorithm.

RSAExponent
Byte()

Returns the e parameter (public exponent) of the RSA key.

RSAIQMP
Byte()

Returns the iqmp parameter of the RSA key.

RSAModulus
Byte()

Returns the m parameter (public modulus) of the RSA key.

RSAP
Byte()

Returns the p parameter (first factor of the common modulus n) of the RSA key.

RSAPrivateExponent
Byte()

Returns the d parameter (private exponent) of the RSA key.

RSAQ
Byte()

Returns the q parameter (second factor of the common modulus n) of the RSA key.

Subject
String

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

Constructors

public SSHKey(byte[] bytes, int startIndex, int count, string password);
Public SSHKey(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

Loads private key from the Bytes buffer. Parameters StartIndex and Count specify the starting index of the key data and its length, correspondingly. Provide a Password to decrypt the key.

public SSHKey(byte[] bytes, int startIndex, int count);
Public SSHKey(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Loads public key from the Bytes buffer. Parameters StartIndex and Count specify the starting index of the key data and its length, correspondingly.

public SSHKey(System.IO.Stream stream, string password);
Public SSHKey(ByVal Stream As System.IO.Stream, ByVal Password As String)

Loads private key from the stream. Provide a Password to decrypt the key.

public SSHKey(System.IO.Stream stream);
Public SSHKey(ByVal Stream As System.IO.Stream)

Loads public key from the stream.

public SSHKey(string path, string password);
Public SSHKey(ByVal Path As String, ByVal Password As String)

Loads private key from the file. Provide a Path to the file and Password to decrypt the key.

public SSHKey(string path);
Public SSHKey(ByVal Path As String)

Loads public key from the file specified by Path .

public SSHKey();
Public SSHKey()

Creates a new key.

SSHSettings Type

A container for various SSH protocol settings.

Remarks

SSHSettings stores various settings of SSH client or server.

Fields

AutoAdjustCiphers
Boolean

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
SecureTransportPredefinedConfigurations

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

CompressionAlgorithms
String

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

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

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

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

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.

GSSAuthTypes
String

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

GSSDelegateCreds
Boolean

Switches credential delegation on or off.

GSSHostname
String

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

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

GSSMechanisms
String

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

GSSProtocols
String

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

HandshakeTimeout
Integer

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

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

MacAlgorithms
String

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

Specifies the maximum length of one SSH packet in bytes.

MinWindowSize
Integer

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

Enables or disables handshake obfuscation.

ObfuscationPassword
String

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

PublicKeyAlgorithms
String

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

RequestPasswordChange
Boolean

Whether to request a password change when connecting.

SoftwareName
String

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

TrustAllKeys
Boolean

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

UseAuthAgent
Boolean

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

Versions
Integer

Specifies enabled SSH protocol versions (1 or 2).

Constructors

public SSHSettings();
Public SSHSettings()

Creates a new object with default settings.

SSHTerm Type

A container for SSH terminal settings.

Remarks

SSHTerm stores terminal settings of the SSH client.

Fields

Cols
Integer

Specifies the width of the pseudoterminal, in characters.

Environment
String

Specifies the list of environment variables.

EOLChar
Byte()

Specifies the End-of-Line character or sequence.

Height
Integer

Specifies the height of the pseudoterminal, in pixels.

Opcodes
String

Specifies the operation codes specific for the terminal.

Protocol
String

The terminal protocol name.

RequestPty
Boolean

Specifies whether to request a pseudoterminal for the session.

Rows
Integer

Specifies the height of the pseudoterminal, in lines.

Width
Integer

Specifies the width of the pseudoterminal, in pixels.

Configuration Settings (SSHClient 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 method.

SSHClient Configuration Settings

BlockSize:   The data block size.

This property specifies the data block size to use.

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.

LocalCharset:   Charset used on the client machine.

This property specifies the charset used on the local client computer.

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.

Base Configuration Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the component.

Supported values are:

offNo caching (default)
localLocal caching (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

Cookies:   Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).

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.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (SSHClient Component)

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2022 .NET Edition - Version 22.0 [Build 8174]