SFTPClient Component
Properties Methods Events Config Settings Errors
The SFTPClient component provides client-side functionality for SFTP (Secure File Transfer Protocol).
Syntax
nsoftware.SecureBlackbox.SFTPClient
Remarks
SFTP is a file transfer subsystem that runs on top of secure shell (SSH) connection. This means that SFTP uses the whole strength of security provided by the SSH protocol, at the same time providing strong file transfer capabilities.
Please do keep in mind that there exist two protocols that offer similar secure file transfer features. SFTP works on top of SSH and normally uses port 22. FTPS works on top of TLS (or SSL) and normally uses ports 21 and 990. The protocols are very different, so please make sure you are after the right component. This component works with SFTP. Use the FTPClient component to connect to FTPS servers.
Below are the typical steps that let you integrate SFTPClient to your project:
- Set up your Username and Password. SSH uses mandatory client-side authentication, so in most cases you need to provide your username, your password, or, sometimes, your private key. Use Key property to provide your key, if needed.
- Be ready to handle server authentication, which is also mandatory in SSH. SSH operates a concept of a trusted keys file, where keys of known servers are stored. You can assign a path to your own trusted keys file to the TrustedKeysFile property. When a client receives a server key, it reports it to your code via its KnownKeyReceived or UnknownKeyReceived event, depending on whether the key was found in the trusted list. If you leave TrustedKeysFile empty, SFTPClient will only be able to fire the UnknownKeyReceived event, since there will be no known keys to report.
- If needed, customize Proxy parameters and SSHSettings.
- Consider interacting more with SFTPClient by subscribing to AuthAttempt, AuthFailed, and AuthSucceeded events to be notified about the client authentication progress.
- When you are ready to connect, call Connect, passing the details of the server as parameters. During the initial handshake, the following events will fire: UnknownKeyReceived (or KnownKeyReceived), and then one or more AuthAttempt, AuthFailed and AuthSucceeded.
- Upon completion of the Connect method, the component is ready for file operations. Use DownloadFile, UploadFile, ListDir, DeleteFile and other file transfer methods to work with the server file system.
- When you are done with your work, call Disconnect to close the connection.
Some SFTP servers, primarily older ones, may expose various transfer issues. If you come across a weird issue that you believe should not be happening (such as repeated connection closures in the middle of the transfer), please try adjusting the following properties:
- AutoAdjustTransferBlock to false,
- PipelineLength to 1,
- UploadBlockSize to 16384,
- DownloadBlockSize to 16384.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| AuthAttempts | Specifies the number of SSH authentication attempts. |
| AutoAdjustTransferBlock | Specifies whether to adjust the send and receive buffer sizes automatically. |
| ConflictResolutionMode | Defines the approach that should be used to resolve various conflicts during batch processing. |
| Connected | Indicates if the client is connected to the SFTP server. |
| ConnectionInfo | Contains the secure connection info. |
| CurrentListEntry | Contains the current entry returned by ListDir . |
| DownloadBlockSize | The download block size in bytes. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| FIPSMode | Reserved. |
| ForceCompression | Enforces compression for the SSH layer. |
| Key | Contains the client's SSH key. |
| MaxSFTPVersion | Higher SFTP version to support. |
| MinSFTPVersion | Lower SFTP version to support. |
| Password | Specifies user's authentication password. |
| PipelineLength | The number of parallelized transfer requests. |
| Proxy | The proxy server settings. |
| ServerKey | Returns the server's public key. |
| SocketSettings | Manages network connection settings. |
| SSHSettings | The SSH connection settings. |
| TrustedKeysFile | A file containing the keys of authorized servers. |
| UploadBlockSize | The upload block size in bytes. |
| Username | The client's username to authenticate to the server. |
| UseUTF8 | Enables UTF8 for all string content. |
| Version | The SFTP version negotiated. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AbsolutePath | Requests the absolute path for a relative path. |
| ChangeDir | Changes current working directory on the server. |
| Config | Sets or retrieves a configuration setting. |
| Connect | Connects to an SFTP server. |
| CreateLink | Creates a symbolic or hard link to a remote file. |
| DeleteDir | Removes directory from the SFTP server. |
| DeleteFile | Deletes a file from the SFTP server. |
| DeleteFiles | Deletes a group of files from the SFTP server. |
| DirExists | Checks if a directory exists on the SFTP server. |
| Disconnect | Disconnects from the SFTP server. |
| DoAction | Performs an additional action. |
| DownloadBytes | Downloads a file from the server into an array of bytes. |
| DownloadFile | Downloads a file from the SFTP server. |
| DownloadFiles | Downloads multiple files from the SFTP server. |
| DownloadStream | Downloads a file from the SFTP server. |
| ExecuteSSHCommand | Sends an SSH command to the server in the middle of SFTP session. |
| ExtensionCmd | Sends an extension command to the server. |
| FileExists | Checks whether a file exists on the server. |
| GetCurrentDir | Returns the current directory on the SFTP server. |
| GetFileSize | Checks the size of a remote file. |
| ListDir | Lists the content of the current remote directory. |
| MakeDir | Creates a new directory on the server. |
| RenameFile | Renames a file. |
| RequestAttributes | Requests attributes of the remote file. |
| Reset | Resets the component settings. |
| SetAttributes | Sets the attributes upon a remote file. |
| UploadBytes | Uploads a byte array to the server. |
| UploadFile | Uploads a file to the server. |
| UploadFiles | Uploads multiple files to the server. |
| UploadStream | Uploads a file to the server. |
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 | Fires when an authentication attempt is performed. |
| AuthFailed | Fires if an authentication attempt fails. |
| AuthSucceeded | Reports a successful authentication. |
| Banner | Reports the receipt of the Welcome message from the server. |
| Disconnect | Reports SFTP connection closure. |
| Error | Information about errors during SFTP connection. |
| ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
| FileNameChangeNeeded | Asks the application for a new file name. |
| FileOperation | Signifies the start of a file transfer operation. |
| FileOperationResult | Signifies the completion of a file transfer operation. |
| KnownKeyReceived | Signals that the server has introduced itself with a known key. |
| ListEntry | Reports a directory listing entry to the application. |
| Notification | This event notifies the application about an underlying control flow event. |
| PasswordChangeRequest | Signals that the server requests a password change. |
| PrivateKeyNeeded | Asks the application for the client's private key. |
| Progress | Fires periodically during the data transfer. |
| UnknownKeyReceived | 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.
| AdjustFileTimes | Whether file times should be adjusted after upload/download. |
| AllAlgorithms | Returns the list of algorithms enabled in the component. |
| ASCIIMode | Whether ASCII transfer mode is used. |
| AvailableSpace | Returns details of server disk space availability. This protocol extension must be supported by the server for this request to work. |
| CaseConversion | Whether file names and paths should be case-converted. |
| CaseSensitive | Specifies if file paths are case-sensitive. |
| CloseQuietly | Controls the client's approach to session closure. |
| CommandTimeout | Specifies the command timeout. |
| CompressionAlgorithms | Returns the list of compression algorithms enabled in the component. |
| CopyMode | Defines what to do with each successfully copied file. |
| DefaultTransferBlock | Specifies the default transfer block size. |
| DefOutboundBlockSize | The default outbound block size. |
| DisablePacketFragmentation | Enables or disables SSH packet fragmentation. |
| EarlyIdString | Enables the proactive approach to SSH handshake. |
| EncryptionAlgorithms | Returns the list of encryption algorithms enabled in the component. |
| ErrorOrigin | Specifies whether the error is local or remote. |
| ErrorSeverity | Specifies whether the error is fatal. |
| FileHash | Returns the hash of the specified file. This protocol extension must be supported by the server for this request to work. |
| HashAlgorithm | The hash algorithm to use for the protocol operations. |
| HomeDir | Returns a user's home directory. This protocol extension must be supported by the server for this request to work. |
| IncomingSpeedLimit | Specifies incoming speed limit. |
| KeepAlivePeriod | The inactivity period after which a keep-alive signal will be sent. |
| KexAlgorithms | Returns the list of key exchange algorithms enabled in the component. |
| LocalCharset | Charset used on the client machine. |
| LocalNewLineConvention | A character string for the end of line (EOL) indication on the local machine. |
| MacAlgorithms | Returns the list of MAC algorithms enabled in the component. |
| NewLineConvention | A character string for the end of line (EOL) indication on the server. |
| OutgoingSpeedLimit | Specifies incoming speed limit. |
| PreserveExistingFileTimes | Whether original file times should be restored upon transfer. |
| PublicKeyAlgorithms | Returns the list of public key algorithms enabled in the component. |
| RedirectStdErr | Whether to redirect output to StdErr. |
| RemoteCharset | Charset used on the server. |
| SFTPBufferSize | The size of internal buffer used for data transfer. |
| SFTPServerExecutableLocations | Location of the SFTP server executable. |
| SocketRecvBufferSize | The inbound socket buffer size. |
| SocketSendBufferSize | The outbound socket buffer size. |
| StatVFS | Returns VFS details. This protocol extension must be supported by the server for this request to work. |
| StdErrData | The buffer for writing StdErr data. |
| SuppressAuxTransferOps | TBD. |
| TempFolder | Returns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work. |
| TempPath | Path for storing temporary files. |
| TreatZeroSizeAsUndefined | Whether zero size returned by STAT should be considered as undefined. |
| TryPasswordAuth | Specifies whether the component should attempt the password-based authentication if no password is set. |
| UseStrictKeyExchange | Specifies how strict key exchange is supported. |
| UseTruncateFlagOnUpload | whether to use the 'truncate' flag on file upload. |
| UseUTF8OnV3 | Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the component. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client components created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
AuthAttempts Property (SFTPClient Component)
Specifies the number of SSH authentication attempts.
Syntax
Default Value
1
Remarks
Use this property to specify the number of authentication attempts to try. The AuthFailed event is fired for every failed attempt.
AutoAdjustTransferBlock Property (SFTPClient Component)
Specifies whether to adjust the send and receive buffer sizes automatically.
Syntax
public bool AutoAdjustTransferBlock { get; set; }
Public Property AutoAdjustTransferBlock As Boolean
Default Value
True
Remarks
Automatic transfer block size adjustment may be beneficial for maximizing interoperability and achieving the best transfer speeds.
Use DownloadBlockSize, UploadBlockSize, and PipelineLength properties to adjust the transfer settings manually.
ConflictResolutionMode Property (SFTPClient Component)
Defines the approach that should be used to resolve various conflicts during batch processing.
Syntax
public SFTPClientConflictResolutionModes ConflictResolutionMode { get; set; }
enum SFTPClientConflictResolutionModes { cftmOverwrite, cftmSkip, cftmAppendToEnd, cftmResume, cftmOverwriteIfDiffSize, cftmSaveWithNewName, cftmRenameExistingTarget }
Public Property ConflictResolutionMode As SftpclientConflictResolutionModes
Enum SFTPClientConflictResolutionModes cftmOverwrite cftmSkip cftmAppendToEnd cftmResume cftmOverwriteIfDiffSize cftmSaveWithNewName cftmRenameExistingTarget End Enum
Default Value
0
Remarks
Use this property to specify the approach to use when landing in conflicting transfer situations.
| cftmOverwrite | 0 | |
| cftmSkip | 1 | |
| cftmAppendToEnd | 2 | The signature is corrupted |
| cftmResume | 3 | |
| cftmOverwriteIfDiffSize | 4 | |
| cftmSaveWithNewName | 5 | |
| cftmRenameExistingTarget | 5 |
Connected Property (SFTPClient Component)
Indicates if the client is connected to the SFTP server.
Syntax
Default Value
False
Remarks
Use this read-only property to check whether the client is connected to the server.
This property is read-only and not available at design time.
ConnectionInfo Property (SFTPClient Component)
Contains the secure connection info.
Syntax
public SSHConnectionInfo ConnectionInfo { get; }
Public ReadOnly Property ConnectionInfo As SSHConnectionInfo
Remarks
This property contains various information about the secure connection.
This property is read-only.
Please refer to the SSHConnectionInfo type for a complete list of fields.CurrentListEntry Property (SFTPClient Component)
Contains the current entry returned by ListDir .
Syntax
public FTPListEntry CurrentListEntry { get; }
Public ReadOnly Property CurrentListEntry As FTPListEntry
Remarks
Use this property to access the current list entry as returned by ListDir call. Entries are passed back to the application one by one, with ListEntry thrown for each entry.
This property is read-only and not available at design time.
Please refer to the FTPListEntry type for a complete list of fields.DownloadBlockSize Property (SFTPClient Component)
The download block size in bytes.
Syntax
Default Value
65536
Remarks
Use this property to manually control the size of download blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.
ExternalCrypto Property (SFTPClient 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 the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).
This property is read-only.
Please refer to the ExternalCrypto type for a complete list of fields.FIPSMode Property (SFTPClient Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
ForceCompression Property (SFTPClient Component)
Enforces compression for the SSH layer.
Syntax
Default Value
False
Remarks
Set this property before opening a connection to enforce compression of the SSH packets.
Key Property (SFTPClient Component)
Contains the client's SSH key.
Syntax
Remarks
Use this property to provide the client's SSH key for authentication. Note that you may start with providing the public part of the key, and only complete it with the private part in response to PrivateKeyNeeded event.
Alternative, you may load the private key straightaway.
This property is not available at design time.
Please refer to the SSHKey type for a complete list of fields.MaxSFTPVersion Property (SFTPClient Component)
Higher SFTP version to support.
Syntax
Default Value
6
Remarks
MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions supported by this client.
MinSFTPVersion Property (SFTPClient Component)
Lower SFTP version to support.
Syntax
Default Value
0
Remarks
MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions to be supported by this client.
Password Property (SFTPClient Component)
Specifies user's authentication password.
Syntax
Default Value
""
Remarks
Use this property to provide an authentication password. This property is only applicable for password-based and keyboard-interactive authentication types.
PipelineLength Property (SFTPClient Component)
The number of parallelized transfer requests.
Syntax
Default Value
32
Remarks
This property controls the number of upload/download requests sent simultaneously. This speeds the transfer up, but may lead to issues with older/immature servers.
Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.
Proxy Property (SFTPClient Component)
The proxy server settings.
Syntax
public ProxySettings Proxy { get; }
Public ReadOnly Property Proxy As ProxySettings
Remarks
Use this property to tune up the proxy server settings.
This property is read-only.
Please refer to the ProxySettings type for a complete list of fields.ServerKey Property (SFTPClient Component)
Returns the server's public key.
Syntax
Remarks
Use this property to check the details of the server public key.
This property is read-only and not available at design time.
Please refer to the SSHKey type for a complete list of fields.SocketSettings Property (SFTPClient 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.
Please refer to the SocketSettings type for a complete list of fields.SSHSettings Property (SFTPClient Component)
The SSH connection settings.
Syntax
public SSHSettings SSHSettings { get; }
Public ReadOnly Property SSHSettings As SSHSettings
Remarks
Use this property to access and tune-up the SSH layer settings.
This property is read-only.
Please refer to the SSHSettings type for a complete list of fields.TrustedKeysFile Property (SFTPClient Component)
A file containing the keys of authorized servers.
Syntax
Default Value
""
Remarks
Use this property to provide a path to the 'authorized_keys' file to be used by the client.
UploadBlockSize Property (SFTPClient Component)
The upload block size in bytes.
Syntax
Default Value
32256
Remarks
Use this property to manually control the size of upload blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.
Username Property (SFTPClient Component)
The client's username to authenticate to the server.
Syntax
Default Value
""
Remarks
Use this property to provide an authentication username (login). This property is only applicable for password-based and keyboard-interactive authentication types.
UseUTF8 Property (SFTPClient Component)
Enables UTF8 for all string content.
Syntax
Default Value
False
Remarks
If UseUTF8 is true, the component expects all downloaded filenames to be encoded in UTF-8. Set UseUTF8 to false if you connect to a server that does not support UTF8 (e.g., OpenSSH). In this case the file names will be interpreted in the default character set.
Version Property (SFTPClient Component)
The SFTP version negotiated.
Syntax
Default Value
0
Remarks
Use this property to get the negotiated SFTP version.
This property is read-only.
AbsolutePath Method (SFTPClient Component)
Requests the absolute path for a relative path.
Syntax
Remarks
Use this method to ask the SFTP server to convert a relative path to an absolute.
ChangeDir Method (SFTPClient Component)
Changes current working directory on the server.
Syntax
Remarks
Changes current working directory on the server to RemoteDir.
Config Method (SFTPClient Component)
Sets or retrieves a configuration setting.
Syntax
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 (SFTPClient Component)
Connects to an SFTP server.
Syntax
Remarks
Use this method to connect to the SFTP server identified via its Address and Port.
CreateLink Method (SFTPClient Component)
Creates a symbolic or hard link to a remote file.
Syntax
Remarks
Use this method to create a symbolic or hard link on the server. Provide the name of the new link object via the LinkPath parameter, and the destinating file or directory path via the TargetPath parameter. HardLink specifies whether the new link should be hard (true) or symbolic (false).
DeleteDir Method (SFTPClient Component)
Removes directory from the SFTP server.
Syntax
Remarks
Use RemoteDir to provide a path to the directory to be deleted.
DeleteFile Method (SFTPClient Component)
Deletes a file from the SFTP server.
Syntax
Remarks
Use the RemoteFile parameter to specify the name of the file to delete.
DeleteFiles Method (SFTPClient Component)
Deletes a group of files from the SFTP server.
Syntax
Remarks
Use this method to delete a group of files from the SFTP server. Specify the files to be deleted via RemotePath and Mask parameters. Use CaseSensitive and Recursive parameters to tune up the operation.
The ErrorHandling parameter specifies the error handling tactics.
| ehStopOnFailure | 0 | Stop on the first failure and throw an exception |
| ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list |
| ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process |
This method is a more efficient way to delete a group of files than deleting them one by one.
DirExists Method (SFTPClient Component)
Checks if a directory exists on the SFTP server.
Syntax
Remarks
RemoteDir specifies the name of the remote directory to check for existence.
Disconnect Method (SFTPClient Component)
Disconnects from the SFTP server.
Syntax
public void Disconnect();
Public Sub Disconnect()
Remarks
Call this method to disconnect from the SFTP server.
DoAction Method (SFTPClient Component)
Performs an additional action.
Syntax
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. |
DownloadBytes Method (SFTPClient Component)
Downloads a file from the server into an array of bytes.
Syntax
Remarks
Use this method to download RemoteFile into a byte array.
DownloadFile Method (SFTPClient Component)
Downloads a file from the SFTP server.
Syntax
Remarks
Use this method to download RemoteFile into the location specified by LocalFile.
DownloadFiles Method (SFTPClient Component)
Downloads multiple files from the SFTP server.
Syntax
Remarks
RemotePath contains a file mask or regular expression by which the files are selected for download.
LocalDir specifies the local folder where the files should be saved. The Recursive parameter tells the component whether it should navigate source directories recursively when downloading files. If set to false, only the files residing in the actual RemotePath, but not its subdirectories, will be downloaded.
The ErrorHandling parameter specifies the error handling tactics.
| ehStopOnFailure | 0 | Stop on the first failure and throw an exception |
| ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list |
| ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process |
DownloadStream Method (SFTPClient Component)
Downloads a file from the SFTP server.
Syntax
public void DownloadStream(string remoteFile, System.IO.Stream localStream);
Public Sub DownloadStream(ByVal RemoteFile As String, ByVal LocalStream As System.IO.Stream)
Remarks
Use this method to download RemoteFile into a LocalStream object.
ExecuteSSHCommand Method (SFTPClient Component)
Sends an SSH command to the server in the middle of SFTP session.
Syntax
Remarks
Use this command to send an SSH command to the server in the middle of an SFTP session. The command is executed in a secondary channel, so the SFTP connection is not affected.
This method is suitable for simple commands that do not require interaction with the user. The call returns the command output.
ExtensionCmd Method (SFTPClient Component)
Sends an extension command to the server.
Syntax
Remarks
Use this method to send an extension command to the SFTP server. Provide the extension type via the Extn parameter, and the request body via the DataBuffer parameter.
Upon completion of the command, the method returns the response as received from the server.
FileExists Method (SFTPClient Component)
Checks whether a file exists on the server.
Syntax
Remarks
Use this method to check if a RemoteFile exists on the server.
GetCurrentDir Method (SFTPClient Component)
Returns the current directory on the SFTP server.
Syntax
Remarks
Use this method to retrieve the current directory as stored by the component. This is a virtualized current directory, as SFTP protocol does not maintain a concept of the current directory.
GetFileSize Method (SFTPClient Component)
Checks the size of a remote file.
Syntax
Remarks
Returns the size of the RemoteFile.
ListDir Method (SFTPClient Component)
Lists the content of the current remote directory.
Syntax
Remarks
IncludeFiles specifies whether file names and symlinks should be included in the results. IncludeDirectories specifies whether directory names should be included in the result.
Upon receiving the listing, the component will report each entry in it via ListEntry event.
MakeDir Method (SFTPClient Component)
Creates a new directory on the server.
Syntax
Remarks
RemoteDir specifies the name of the new directory.
RenameFile Method (SFTPClient Component)
Renames a file.
Syntax
Remarks
Use this method to rename a remote file. Provide the old and the new name via SourceFile and DestFile parameters.
RequestAttributes Method (SFTPClient Component)
Requests attributes of the remote file.
Syntax
Remarks
Use this method to request attributes of a remote file. Pass the name of the file via the RemotePath parameter, and use FollowSymLinks to specify whether symbolic links should be resolved.
The method returns the list of attributes as a line of semicolon-separated entries: Size=78220;Owner=user@system;Group=none@system;Permissions=432;ATime=2020-04-28 08:21:00.295;MTime=2020-04-28 08:21:00.302;CTime=2020-04-28 08:21:00.295;AttribBits=24;LinkCount=1.
Reset Method (SFTPClient Component)
Resets the component settings.
Syntax
public void Reset();
Public Sub Reset()
Remarks
Reset is a generic method available in every component.
SetAttributes Method (SFTPClient Component)
Sets the attributes upon a remote file.
Syntax
Remarks
Use this method to set the attributes of a remote file.
UploadBytes Method (SFTPClient Component)
Uploads a byte array to the server.
Syntax
Remarks
Use this method to upload Bytes or its part to RemoteFile on the server.
UploadFile Method (SFTPClient Component)
Uploads a file to the server.
Syntax
Remarks
Use this method to upload LocalFile to the RemoteFile location on the server.
UploadFiles Method (SFTPClient Component)
Uploads multiple files to the server.
Syntax
Remarks
Use this property to upload a batch of files to the server.
LocalPath specifies a wildcard or regular expression by which the local files are picked for uploading. RemoteDir specifies the location on the server where these files should be saved. The Recursive parameter tells the component whether it should navigate source directories recursively when uploading files. If set to false, only the files residing in the actual LocalPath, but not its subdirectories, will be uploaded.
The ErrorHandling parameter specifies one of the pre-defined error handling tactics:
| ehStopOnFailure | 0 | Stop on the first failure and throw an exception |
| ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list |
| ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process |
UploadStream Method (SFTPClient Component)
Uploads a file to the server.
Syntax
public void UploadStream(System.IO.Stream localStream, string remoteFile);
Public Sub UploadStream(ByVal LocalStream As System.IO.Stream, ByVal RemoteFile As String)
Remarks
Use this method to upload the contents of LocalStream to the RemoteFile location on the server.
AuthAttempt Event (SFTPClient Component)
Fires when an authentication attempt is performed.
Syntax
public event OnAuthAttemptHandler OnAuthAttempt; public delegate void OnAuthAttemptHandler(object sender, SFTPClientAuthAttemptEventArgs e); public class SFTPClientAuthAttemptEventArgs : EventArgs { public int AuthType { get; } }
Public Event OnAuthAttempt As OnAuthAttemptHandler Public Delegate Sub OnAuthAttemptHandler(sender As Object, e As SFTPClientAuthAttemptEventArgs) Public Class SFTPClientAuthAttemptEventArgs Inherits EventArgs Public ReadOnly Property AuthType As Integer End Class
Remarks
This event signals the start of an authentication attempt. The AuthType parameter specifies the authentication type. This event may be fired more than once if the client tries different authentication methods one after another.
Supported authentication types:
| atRhosts | 0x01 | RHOSTS file authentication. Rarely used today. |
| atPublicKey | 0x02 | Public key (sometimes called private key) authentication |
| atPassword | 0x04 | Password-based authentication |
| atHostbased | 0x08 | Hostbased authentication |
| atKeyboard | 0x10 | Keyboard-interactive authentication. This is often used in place of generic password authentication. |
| atGssWithMic | 0x20 | GSS authentication |
| atGssKeyex | 0x40 | GSS authentication with key exchange |
| atPublicKeyAgent | 0x80 | Public key agent authentication |
AuthFailed Event (SFTPClient Component)
Fires if an authentication attempt fails.
Syntax
public event OnAuthFailedHandler OnAuthFailed; public delegate void OnAuthFailedHandler(object sender, SFTPClientAuthFailedEventArgs e); public class SFTPClientAuthFailedEventArgs : EventArgs { public int AuthType { get; } }
Public Event OnAuthFailed As OnAuthFailedHandler Public Delegate Sub OnAuthFailedHandler(sender As Object, e As SFTPClientAuthFailedEventArgs) Public Class SFTPClientAuthFailedEventArgs Inherits EventArgs Public ReadOnly Property AuthType As Integer End Class
Remarks
This event fires if an authentication attempt fails (for example, if a bad password had been provided). AuthType parameter indicates the authentication type.
AuthFailed may be fired more than once, depending on the configured authentication parameters and the value assigned to the AuthAttempts property.
This event does not necessarily lead to connection abortion, as the client may still have a chance of authenticating with a different method.
Supported authentication types:
| atRhosts | 0x01 | RHOSTS file authentication. Rarely used today. |
| atPublicKey | 0x02 | Public key (sometimes called private key) authentication |
| atPassword | 0x04 | Password-based authentication |
| atHostbased | 0x08 | Hostbased authentication |
| atKeyboard | 0x10 | Keyboard-interactive authentication. This is often used in place of generic password authentication. |
| atGssWithMic | 0x20 | GSS authentication |
| atGssKeyex | 0x40 | GSS authentication with key exchange |
| atPublicKeyAgent | 0x80 | Public key agent authentication |
AuthSucceeded Event (SFTPClient Component)
Reports a successful authentication.
Syntax
public event OnAuthSucceededHandler OnAuthSucceeded; public delegate void OnAuthSucceededHandler(object sender, SFTPClientAuthSucceededEventArgs e); public class SFTPClientAuthSucceededEventArgs : EventArgs { }
Public Event OnAuthSucceeded As OnAuthSucceededHandler Public Delegate Sub OnAuthSucceededHandler(sender As Object, e As SFTPClientAuthSucceededEventArgs) Public Class SFTPClientAuthSucceededEventArgs Inherits EventArgs End Class
Remarks
This event marks the completion of the authentication procedure, and signifies transition to the SSH connection subprotocol.
Banner Event (SFTPClient Component)
Reports the receipt of the Welcome message from the server.
Syntax
public event OnBannerHandler OnBanner; public delegate void OnBannerHandler(object sender, SFTPClientBannerEventArgs e); public class SFTPClientBannerEventArgs : EventArgs { public byte[] Text { get; } public byte[] Language { get; } }
Public Event OnBanner As OnBannerHandler Public Delegate Sub OnBannerHandler(sender As Object, e As SFTPClientBannerEventArgs) Public Class SFTPClientBannerEventArgs Inherits EventArgs Public ReadOnly Property Text As Byte() Public ReadOnly Property Language As Byte() End Class
Remarks
The component fires this event when it receives a welcome message from the server. Use the Text parameter to access the encoded message.
Disconnect Event (SFTPClient Component)
Reports SFTP connection closure.
Syntax
public event OnDisconnectHandler OnDisconnect; public delegate void OnDisconnectHandler(object sender, SFTPClientDisconnectEventArgs e); public class SFTPClientDisconnectEventArgs : EventArgs { public int CloseReason { get; } }
Public Event OnDisconnect As OnDisconnectHandler Public Delegate Sub OnDisconnectHandler(sender As Object, e As SFTPClientDisconnectEventArgs) Public Class SFTPClientDisconnectEventArgs Inherits EventArgs Public ReadOnly Property CloseReason As Integer End Class
Remarks
The component fires this event to report connection closure. No more SFTP activity could be done after the disconnect.
Error Event (SFTPClient Component)
Information about errors during SFTP connection.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, SFTPClientErrorEventArgs e); public class SFTPClientErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As SFTPClientErrorEventArgs) Public Class SFTPClientErrorEventArgs 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 (SFTPClient 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, SFTPClientExternalSignEventArgs e); public class SFTPClientExternalSignEventArgs : 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 SFTPClientExternalSignEventArgs) Public Class SFTPClientExternalSignEventArgs 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 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:
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();
};
FileNameChangeNeeded Event (SFTPClient Component)
Asks the application for a new file name.
Syntax
public event OnFileNameChangeNeededHandler OnFileNameChangeNeeded; public delegate void OnFileNameChangeNeededHandler(object sender, SFTPClientFileNameChangeNeededEventArgs e); public class SFTPClientFileNameChangeNeededEventArgs : EventArgs { public string FileName { get; set; } public bool Force { get; set; } }
Public Event OnFileNameChangeNeeded As OnFileNameChangeNeededHandler Public Delegate Sub OnFileNameChangeNeededHandler(sender As Object, e As SFTPClientFileNameChangeNeededEventArgs) Public Class SFTPClientFileNameChangeNeededEventArgs Inherits EventArgs Public Property FileName As String Public Property Force As Boolean End Class
Remarks
The component uses this event to ask the application for a new file name in the case of a name conflict. Adjust the FileName as required to avoid the conflict, or set Force to true to go ahead with the current name (possibly overwriting an existing file).
FileOperation Event (SFTPClient Component)
Signifies the start of a file transfer operation.
Syntax
public event OnFileOperationHandler OnFileOperation; public delegate void OnFileOperationHandler(object sender, SFTPClientFileOperationEventArgs e); public class SFTPClientFileOperationEventArgs : EventArgs { public int Operation { get; } public string RemotePath { get; } public string LocalPath { get; } public bool Skip { get; set; } public bool Cancel { get; set; } }
Public Event OnFileOperation As OnFileOperationHandler Public Delegate Sub OnFileOperationHandler(sender As Object, e As SFTPClientFileOperationEventArgs) Public Class SFTPClientFileOperationEventArgs Inherits EventArgs Public ReadOnly Property Operation As Integer Public ReadOnly Property RemotePath As String Public ReadOnly Property LocalPath As String Public Property Skip As Boolean Public Property Cancel As Boolean End Class
Remarks
This event is fired each time the component starts an upload or download operation within a multi-file call. Operation defines the operation about to start, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.
If needed, set Skip to true to ignore the current file, or Cancel to abort the whole batch.
Supported operations:
| cffoDownloadFile | 0 | Download file |
| cffoUploadFile | 1 | Upload file |
| cffoDeleteFile | 2 | Delete file |
| cffoMakeDir | 3 | Make directory |
FileOperationResult Event (SFTPClient Component)
Signifies the completion of a file transfer operation.
Syntax
public event OnFileOperationResultHandler OnFileOperationResult; public delegate void OnFileOperationResultHandler(object sender, SFTPClientFileOperationResultEventArgs e); public class SFTPClientFileOperationResultEventArgs : EventArgs { public int Operation { get; } public string RemotePath { get; } public string LocalPath { get; } public int ErrorCode { get; } public string Comment { get; } public bool Cancel { get; set; } }
Public Event OnFileOperationResult As OnFileOperationResultHandler Public Delegate Sub OnFileOperationResultHandler(sender As Object, e As SFTPClientFileOperationResultEventArgs) Public Class SFTPClientFileOperationResultEventArgs Inherits EventArgs Public ReadOnly Property Operation As Integer Public ReadOnly Property RemotePath As String Public ReadOnly Property LocalPath As String Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Comment As String Public Property Cancel As Boolean End Class
Remarks
This event is fired each time the component completes a file transfer within a multi-file call. Operation defines the operation performed on the file, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.
ErrorCode and Comment return the code and textual description of the error, if it was encountered.
Set Cancel to True to cancel the multi-file operation.
Supported operations:
| cffoDownloadFile | 0 | Download file |
| cffoUploadFile | 1 | Upload file |
| cffoDeleteFile | 2 | Delete file |
| cffoMakeDir | 3 | Make directory |
KnownKeyReceived Event (SFTPClient Component)
Signals that the server has introduced itself with a known key.
Syntax
public event OnKnownKeyReceivedHandler OnKnownKeyReceived; public delegate void OnKnownKeyReceivedHandler(object sender, SFTPClientKnownKeyReceivedEventArgs e); public class SFTPClientKnownKeyReceivedEventArgs : 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 SFTPClientKnownKeyReceivedEventArgs) Public Class SFTPClientKnownKeyReceivedEventArgs 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.
ListEntry Event (SFTPClient Component)
Reports a directory listing entry to the application.
Syntax
public event OnListEntryHandler OnListEntry; public delegate void OnListEntryHandler(object sender, SFTPClientListEntryEventArgs e); public class SFTPClientListEntryEventArgs : EventArgs { public string FileName { get; } }
Public Event OnListEntry As OnListEntryHandler Public Delegate Sub OnListEntryHandler(sender As Object, e As SFTPClientListEntryEventArgs) Public Class SFTPClientListEntryEventArgs Inherits EventArgs Public ReadOnly Property FileName As String End Class
Remarks
The component fires this event to report a directory listing entry to the application. FileName contains the entry name.
Use CurrentListEntry to access the details of the entry.
Notification Event (SFTPClient Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, SFTPClientNotificationEventArgs e); public class SFTPClientNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As SFTPClientNotificationEventArgs) Public Class SFTPClientNotificationEventArgs 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 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 (SFTPClient Component)
Signals that the server requests a password change.
Syntax
public event OnPasswordChangeRequestHandler OnPasswordChangeRequest; public delegate void OnPasswordChangeRequestHandler(object sender, SFTPClientPasswordChangeRequestEventArgs e); public class SFTPClientPasswordChangeRequestEventArgs : 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 SFTPClientPasswordChangeRequestEventArgs) Public Class SFTPClientPasswordChangeRequestEventArgs Inherits EventArgs Public ReadOnly Property Prompt As String Public Property NewPassword As String Public Property Cancel As Boolean End Class
Remarks
The component fires this event to pass the password change request from the server to the application. This event is fired during the SSH handshake.
PrivateKeyNeeded Event (SFTPClient Component)
Asks the application for the client's private key.
Syntax
public event OnPrivateKeyNeededHandler OnPrivateKeyNeeded; public delegate void OnPrivateKeyNeededHandler(object sender, SFTPClientPrivateKeyNeededEventArgs e); public class SFTPClientPrivateKeyNeededEventArgs : EventArgs { public bool Skip { get; set; } }
Public Event OnPrivateKeyNeeded As OnPrivateKeyNeededHandler Public Delegate Sub OnPrivateKeyNeededHandler(sender As Object, e As SFTPClientPrivateKeyNeededEventArgs) Public Class SFTPClientPrivateKeyNeededEventArgs Inherits EventArgs Public Property Skip As Boolean End Class
Remarks
The component fires this event if the public key provided in Key was accepted by the server, but no private key is available for it.
Use this event handler to attach the private key to your Key. The component will pick the key up and continue the authentication.
Progress Event (SFTPClient Component)
Fires periodically during the data transfer.
Syntax
public event OnProgressHandler OnProgress; public delegate void OnProgressHandler(object sender, SFTPClientProgressEventArgs e); public class SFTPClientProgressEventArgs : EventArgs { public long Total { get; } public long Current { get; } public bool Cancel { get; set; } }
Public Event OnProgress As OnProgressHandler Public Delegate Sub OnProgressHandler(sender As Object, e As SFTPClientProgressEventArgs) Public Class SFTPClientProgressEventArgs Inherits EventArgs Public ReadOnly Property Total As Long Public ReadOnly Property Current As Long Public Property Cancel As Boolean End Class
Remarks
Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.
UnknownKeyReceived Event (SFTPClient Component)
Signals that the server has introduced itself with an unknown key.
Syntax
public event OnUnknownKeyReceivedHandler OnUnknownKeyReceived; public delegate void OnUnknownKeyReceivedHandler(object sender, SFTPClientUnknownKeyReceivedEventArgs e); public class SFTPClientUnknownKeyReceivedEventArgs : 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 SFTPClientUnknownKeyReceivedEventArgs) Public Class SFTPClientUnknownKeyReceivedEventArgs 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:
| 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. |
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
Default: ""
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: ""
Custom parameters to be passed to the signing service (uninterpreted).
Data
string
Default: ""
Additional data to be included in the async state and mirrored back by the requestor.
ExternalHashCalculation
bool
Default: 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: "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: ""
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 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
Default: ""
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
Default: 0
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |
Mode
ExternalCryptoModes
Default: 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: ""
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 |
Constructors
public ExternalCrypto();
Public ExternalCrypto()
Creates a new ExternalCrypto object with default field values.
FTPListEntry Type
Represents a basic container for the remote file details.
Remarks
The component represents the details of a file entry returned by the FTP server.
Fields
AccessTime
string
Default: ""
Contains the last access time for this file, in UTC.
CreationTime
string
Default: ""
Contains this file's creation time, in UTC.
EntryFormat
FTPFileFormats
Default: 0
The file listing format:
| cfefUnknown | 0 |
| cfefUnix | 1 |
| cfefWindows | 2 |
| cfefMLSD | 3 |
FileType
FTPFileTypes
Default: 0
The type of the entry:
| fetUnknown | 0 |
| fetDirectory | 1 |
| fetFile | 2 |
| fetSymlink | 3 |
| fetSpecial | 4 |
| fetCurrentDirectory | 5 |
| fetParentDirectory | 6 |
| fetSocket | 7 |
| fetCharDevice | 8 |
| fetBlockDevice | 9 |
| fetFIFO | 10 |
ModificationTime
string
Default: ""
File last modification date/time.
Name
string
Default: ""
The file or directory name.
Path
string
Default: ""
The full path to the file or directory.
Principal
string
Default: ""
Specifies the owner of the file/directory.
Note: in earlier versions this property was called Owner. It was renamed to Principal to avoid clashes with certain SDK namings.
Size
long
Default: 0
File size in bytes.
UnixPerms
int
Default: 511
The file Unix permissions bit mask (e.g. rwxrwxrwx=511 (0777); rwxr--r--=484 (0744)).
UnparsedName
string
Default: ""
The unparsed entry as returned by the server. Sometimes this is also known as "long name".
Constructors
public FTPListEntry();
Public FTPListEntry()
Creates a new FTPListEntry object.
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
Default: ""
The IP address of the proxy server.
Authentication
ProxyAuthTypes
Default: 0
The authentication type used by the proxy server.
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |
Password
string
Default: ""
The password to authenticate to the proxy server.
Port
int
Default: 0
The port on the proxy server to connect to.
ProxyType
ProxyTypes
Default: 0
The type of the proxy server.
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |
RequestHeaders
string
Default: ""
Contains HTTP request headers for WebTunnel and HTTP proxy.
ResponseBody
string
Default: ""
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ResponseHeaders
string
Default: ""
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
UseIPv6
bool
Default: False
Specifies whether IPv6 should be used when connecting through the proxy.
Username
string
Default: ""
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
Default: 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
int
Default: 0
Specifies the port number to be used for sending queries to the DNS server.
DNSQueryTimeout
int
Default: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
DNSServers
string
Default: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
DNSTotalTimeout
int
Default: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
IncomingSpeedLimit
int
Default: 0
The maximum number of bytes to read from the socket, per second.
LocalAddress
string
Default: ""
The local network interface to bind the socket to.
LocalPort
int
Default: 0
The local port number to bind the socket to.
OutgoingSpeedLimit
int
Default: 0
The maximum number of bytes to write to the socket, per second.
Timeout
int
Default: 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
bool
Default: False
Enables or disables IP protocol version 6.
Constructors
public SocketSettings();
Public SocketSettings()
Creates a new SocketSettings object.
SSHConnectionInfo Type
Contains information about SSH connection.
Remarks
SSHConnectionInfo object contains information about one SSH connection.
Fields
ClientKeyAlgorithm
string (read-only)
Default: ""
Specifies the client's key algorithm.
ClientKeyBits
int (read-only)
Default: 0
Specifies the length of the client's key.
ClientKeyFingerprint
string (read-only)
Default: ""
The fingerprint (hash value) of the client's public key.
CloseReason
string (read-only)
Default: ""
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: ""
Compression algorithm for the incoming traffic.
CompressionAlgorithmOutbound
string (read-only)
Default: ""
Compression algorithm for the outgoing traffic.
EncryptionAlgorithmInbound
string (read-only)
Default: ""
Encryption algorithm for the incoming traffic.
EncryptionAlgorithmOutbound
string (read-only)
Default: ""
Encryption algorithm for the outgoing traffic.
InboundEncryptionKeyBits
int (read-only)
Default: 0
Specifies the length of the key used to encrypt the incoming traffic.
KexAlgorithm
string (read-only)
Default: ""
The key exchange algorithm used during the SSH handshake.
KexBits
int (read-only)
Default: 0
The number of bits used by the key exchange algorithm.
KexLines
string (read-only)
Default: ""
The contents of the received KexInit packet.
KexInit packet contains the list of algorithms supported by the remote party.
MacAlgorithmInbound
string (read-only)
Default: ""
MAC algorithm used for the incoming connection.
MacAlgorithmOutbound
string (read-only)
Default: ""
MAC algorithm used for outbound connection.
OutboundEncryptionKeyBits
int (read-only)
Default: 0
Specifies the length of the key used to encrypt the outgoing traffic.
PublicKeyAlgorithm
string (read-only)
Default: ""
Specifies the public key algorithm which was used during the SSH handshake.
RemoteAddress
string (read-only)
Default: ""
The client's IP address.
RemotePort
int (read-only)
Default: 0
The remote port of the client connection.
ServerKeyAlgorithm
string (read-only)
Default: ""
Specifies the server's key algorithm.
ServerKeyBits
int (read-only)
Default: 0
Specifies the number of bits in the server's key.
ServerKeyFingerprint
string (read-only)
Default: ""
The fingerprint (hash value) of the server's public key.
ServerSoftwareName
string (read-only)
Default: ""
Returns the name of the SSH software running on the server side.
TotalBytesReceived
long (read-only)
Default: 0
Returns the total number of bytes received over this connection.
TotalBytesSent
long (read-only)
Default: 0
Returns the total number of bytes sent over this connection.
Version
int (read-only)
Default: 2
Specifies SSH protocol version.
Constructors
public SSHConnectionInfo();
Public SSHConnectionInfo()
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 (read-only)
Default: ""
Specifies the key algorithm.
The following algorithms are currently supported:
- RSA
- DSS
- ECDSA
- EDDSA
Bits
int (read-only)
Default: 0
The number of bits in the key: the more the better, 2048 or 4096 are typical values.
Comment
string
Default: ""
The comment for the public key.
Curve
string (read-only)
Default: ""
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)
DSSG
byte[] (read-only)
Default: ""
The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.
DSSP
byte[] (read-only)
Default: ""
The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.
DSSQ
byte[] (read-only)
Default: ""
The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.
DSSX
byte[] (read-only)
Default: ""
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[] (read-only)
Default: ""
The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.
ECCD
byte[] (read-only)
Default: ""
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[] (read-only)
Default: ""
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[] (read-only)
Default: ""
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[] (read-only)
Default: ""
The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
EdPublic
byte[] (read-only)
Default: ""
The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
FingerprintMD5
string (read-only)
Default: ""
Contains the MD5 fingerprint (hash) of the key.
FingerprintSHA1
string (read-only)
Default: ""
Contains the SHA-1 fingerprint (hash) of the key.
FingerprintSHA256
string (read-only)
Default: ""
Contains the SHA-256 fingerprint (hash) of the key.
IsExtractable
bool (read-only)
Default: False
Whether the key is extractable (e.g., from a security token), or not.
IsPrivate
bool (read-only)
Default: False
Whether this key is a private key or not.
IsPublic
bool (read-only)
Default: False
Whether this key is a public key or not.
KDFRounds
int (read-only)
Default: 0
Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.
KDFSalt
byte[] (read-only)
Default: ""
The salt value used by the Key Derivation Function (KDF) to generate this key.
KeyFormat
SSHKeyFormats (read-only)
Default: 0
Specifies the format in which the key is stored.
| ckfOpenSSH | 0 | |
| ckfOpenSSH2 | 1 | |
| ckfIETF | 2 | |
| ckfPuTTY | 3 | |
| ckfX509 | 4 | |
| ckfBinary | 5 | |
| ckfSSH1 | 6 | |
| ckfPGP | 7 | |
| ckfPKCS8 | 8 | |
| ckfPuTTY3 | 9 |
KeyProtectionAlgorithm
string (read-only)
Default: ""
Specifies the key protection algorithm.
RSAExponent
byte[] (read-only)
Default: ""
Returns the e parameter (public exponent) of the RSA key.
RSAIQMP
byte[] (read-only)
Default: ""
Returns the iqmp parameter of the RSA key.
RSAModulus
byte[] (read-only)
Default: ""
Returns the m parameter (public modulus) of the RSA key.
RSAP
byte[] (read-only)
Default: ""
Returns the p parameter (first factor of the common modulus n) of the RSA key.
RSAPrivateExponent
byte[] (read-only)
Default: ""
Returns the d parameter (private exponent) of the RSA key.
RSAQ
byte[] (read-only)
Default: ""
Returns the q parameter (second factor of the common modulus n) of the RSA key.
Subject
string
Default: ""
Specifies the public key owner (subject). This property is used only for IETF-keys.
Constructors
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.
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.
Loads private key from the file. Provide a Path to the file and Password to decrypt the key.
Loads public key from the file specified by Path .
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
bool
Default: 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
SecureTransportPredefinedConfigurations
Default: 0
Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.
CompressionAlgorithms
string
Default: ""
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
int
Default: 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
int
Default: 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: ""
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
bool
Default: 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
bool
Default: 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: ""
A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex.
GSSDelegateCreds
bool
Default: False
Switches credential delegation on or off.
GSSHostname
string
Default: ""
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: ""
A path to the GSS-API library (DLL or SO).
GSSMechanisms
string
Default: ""
A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI.
GSSProtocols
string
Default: ""
A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM.
HandshakeTimeout
int
Default: 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: ""
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: ""
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
int
Default: 262144
Specifies the maximum length of one SSH packet in bytes.
MinWindowSize
int
Default: 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
bool
Default: False
Enables or disables handshake obfuscation.
ObfuscationPassword
string
Default: ""
Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.
PublicKeyAlgorithms
string
Default: ""
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
bool
Default: False
Whether to request a password change when connecting.
SoftwareName
string
Default: "SecureBlackbox"
The name to be used by the component to identify itself.
TrustAllKeys
bool
Default: False
Enables or disables explicit trust to all server keys. Use with care.
UseAuthAgent
bool
Default: False
Enables or disables the use of external key agent, such as Putty key agent.
Versions
int
Default: 1
Specifies enabled SSH protocol versions (1 or 2).
Constructors
public SSHSettings();
Public SSHSettings()
Creates a new object with default settings.
Config Settings (SFTPClient 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.SFTPClient Config Settings
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
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
| time | Current time | |
| level | Level | |
| package | Package name | |
| module | Module name | |
| class | Class name | |
| method | Method name | |
| threadid | Thread Id | |
| contenttype | Content type | |
| content | Content | |
| all | All details |
Supported filter names are:
| exclude-package | Exclude a package specified in the value | |
| exclude-module | Exclude a module specified in the value | |
| exclude-class | Exclude a class specified in the value | |
| exclude-method | Exclude a method specified in the value | |
| include-package | Include a package specified in the value | |
| include-module | Include a module specified in the value | |
| include-class | Include a class specified in the value | |
| include-method | Include a method specified in the value |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
| none | None (by default) | |
| fatal | Severe errors that cause premature termination. | |
| error | Other runtime errors or unexpected conditions. | |
| warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
| info | Interesting runtime events (startup/shutdown). | |
| debug | Detailed information on flow of through the system. | |
| trace | More detailed information. |
The default value of this setting is 100.
| none | No rotation | |
| deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
| keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported Values:
| 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):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
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:
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:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
Trappable Errors (SFTPClient Component)
SFTPClient Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 31457281 | Unsupported file operation (SB_ERROR_SFTP_UNSUPPORTED_FILE_OPERATION) |
| 31457282 | Invalid authentication type (SB_ERROR_SFTP_INVALID_AUTH_TYPE) |