SFTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The SFTPClient class can be used to transfer files to and from secure file transfer protocol (SFTP) servers.

Class Name

IPWorksSFTP_SFTPClient

Procedural Interface

 ipworkssftp_sftpclient_open();
 ipworkssftp_sftpclient_close($res);
 ipworkssftp_sftpclient_register_callback($res, $id, $function);
 ipworkssftp_sftpclient_get_last_error($res);
 ipworkssftp_sftpclient_get_last_error_code($res);
 ipworkssftp_sftpclient_set($res, $id, $index, $value);
 ipworkssftp_sftpclient_get($res, $id, $index);
 ipworkssftp_sftpclient_do_append($res);
 ipworkssftp_sftpclient_do_changeremotepath($res, $remotepath);
 ipworkssftp_sftpclient_do_checkfileexists($res);
 ipworkssftp_sftpclient_do_config($res, $configurationstring);
 ipworkssftp_sftpclient_do_connect($res);
 ipworkssftp_sftpclient_do_createfile($res, $filename);
 ipworkssftp_sftpclient_do_decodepacket($res, $encodedpacket);
 ipworkssftp_sftpclient_do_deletefile($res, $filename);
 ipworkssftp_sftpclient_do_disconnect($res);
 ipworkssftp_sftpclient_do_doevents($res);
 ipworkssftp_sftpclient_do_download($res);
 ipworkssftp_sftpclient_do_downloadrange($res, $path, $filename, $startbyte, $count, $buffer);
 ipworkssftp_sftpclient_do_encodepacket($res, $packet);
 ipworkssftp_sftpclient_do_getsshparam($res, $payload, $field);
 ipworkssftp_sftpclient_do_getsshparambytes($res, $payload, $field);
 ipworkssftp_sftpclient_do_interrupt($res);
 ipworkssftp_sftpclient_do_listdirectory($res);
 ipworkssftp_sftpclient_do_makedirectory($res, $newdir);
 ipworkssftp_sftpclient_do_queryfileattributes($res);
 ipworkssftp_sftpclient_do_queuefile($res, $localfile, $remotefile);
 ipworkssftp_sftpclient_do_removedirectory($res, $dirname);
 ipworkssftp_sftpclient_do_renamefile($res, $newname);
 ipworkssftp_sftpclient_do_reset($res);
 ipworkssftp_sftpclient_do_resetqueue($res);
 ipworkssftp_sftpclient_do_setsshparam($res, $payload, $fieldtype, $fieldvalue);
 ipworkssftp_sftpclient_do_sshlogoff($res);
 ipworkssftp_sftpclient_do_sshlogon($res, $sshhost, $sshport);
 ipworkssftp_sftpclient_do_updatefileattributes($res);
 ipworkssftp_sftpclient_do_upload($res);
 ipworkssftp_sftpclient_do_uploadrange($res, $path, $filename, $startbyte, $count, $buffer);

Remarks

The SFTPClient class is the Secure Shell (SSH)-enabled equivalent of the IPWorks FTP class. The SSHHost and SSHPort properties specify which Secure Shell (SSH) server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.

The SFTPClient class implements a standard SSH file transfer client.

The first step in using the class is specifying the SSHHost, SSHUser, and SSHPassword. The file to upload to or download from is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile. The current path in the server is specified by the RemotePath property.

If LocalFile is set to something other than an empty string, then files are received in LocalFile; otherwise, the data are received through the Transfer event. StartTransfer and EndTransfer are fired at the beginning and end of transmission.

Directory listings are received through the DirList event.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

ConnectedWhether the class is connected.
DirListCountThe number of records in the DirList arrays.
DirListEntryThis property contains the raw entry as received from the server.
DirListFileNameThis property shows the file name in the last directory listing.
DirListFileSizeThis property shows the file size in the last directory listing.
DirListFileTimeThis property shows the file time in the last directory listing.
DirListIsDirThis property specifies whether entries in the last directory listing are directories.
DirListIsSymlinkThis property indicates whether the entry is a symbolic link.
FileAccessTimeContains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed.
FileACLContains a string containing an access control list (ACL).
FileAllocationSizeSpecifies the size, in bytes, that this file consumes on disk.
FileAttributeBitsAttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server.
FileAttributeBitsValidAttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server.
FileCreationTimeSpecifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created.
FileTypeThe type of file.
FileGroupIdSpecifies the Id of the group that has access rights this file.
FileIsDirSpecifies whether or not the file represented by these attributes is a directory.
FileIsSymlinkSpecifies whether or not the file or directory represented by these attributes is a symbolic link.
FileModifiedTimeSpecifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified.
FileOwnerIdSpecifies the user Id of this file's owner.
FilePermissionsIncludes a 32-bit integer containing the a POSIX-compatible file permission bitmask.
FilePermissionsOctalIncludes an octal string containing the a POSIX-compatible file permission bitmask.
FileSizeSpecifies the total size, in bytes, of this file.
FirewallAutoDetectWhether to automatically detect and use firewall system settings, if available.
FirewallTypeThe type of firewall to connect through.
FirewallHostThe name or IP address of the firewall (optional).
FirewallPasswordA password if authentication is to be used when connecting through the firewall.
FirewallPortThe Transmission Control Protocol (TCP) port for the firewall Host .
FirewallUserA username if authentication is to be used when connecting through a firewall.
IdleThe current status of the class.
LocalFileThe path to a local file for upload or download.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the class binds.
OverwriteThe value indicating whether or not the class should overwrite files during transfer.
RemoteFileThe name of the remote file for uploading or downloading.
RemotePathThe current path in the secure file transfer protocol (SFTP) server.
SSHAcceptServerHostKeyEffectiveDateThe date on which this certificate becomes valid.
SSHAcceptServerHostKeyExpirationDateThe date on which the certificate expires.
SSHAcceptServerHostKeyExtendedKeyUsageA comma-delimited list of extended key usage identifiers.
SSHAcceptServerHostKeyFingerprintThe hex-encoded, 16-byte MD5 fingerprint of the certificate.
SSHAcceptServerHostKeyFingerprintSHA1The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
SSHAcceptServerHostKeyFingerprintSHA256The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
SSHAcceptServerHostKeyIssuerThe issuer of the certificate.
SSHAcceptServerHostKeyPrivateKeyThe private key of the certificate (if available).
SSHAcceptServerHostKeyPrivateKeyAvailableWhether a PrivateKey is available for the selected certificate.
SSHAcceptServerHostKeyPrivateKeyContainerThe name of the PrivateKey container for the certificate (if available).
SSHAcceptServerHostKeyPublicKeyThe public key of the certificate.
SSHAcceptServerHostKeyPublicKeyAlgorithmThe textual description of the certificate's public key algorithm.
SSHAcceptServerHostKeyPublicKeyLengthThe length of the certificate's public key (in bits).
SSHAcceptServerHostKeySerialNumberThe serial number of the certificate encoded as a string.
SSHAcceptServerHostKeySignatureAlgorithmThe text description of the certificate's signature algorithm.
SSHAcceptServerHostKeyStoreThe name of the certificate store for the client certificate.
SSHAcceptServerHostKeyStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSHAcceptServerHostKeyStoreTypeThe type of certificate store for this certificate.
SSHAcceptServerHostKeySubjectAltNamesComma-separated lists of alternative subject names for the certificate.
SSHAcceptServerHostKeyThumbprintMD5The MD5 hash of the certificate.
SSHAcceptServerHostKeyThumbprintSHA1The SHA-1 hash of the certificate.
SSHAcceptServerHostKeyThumbprintSHA256The SHA-256 hash of the certificate.
SSHAcceptServerHostKeyUsageThe text description of UsageFlags .
SSHAcceptServerHostKeyUsageFlagsThe flags that show intended use for the certificate.
SSHAcceptServerHostKeyVersionThe certificate's version number.
SSHAcceptServerHostKeySubjectThe subject of the certificate used for client authentication.
SSHAcceptServerHostKeyEncodedThe certificate (PEM/Base64 encoded).
SSHAuthModeThe authentication method to be used with the class when calling SSHLogon .
SSHCertEffectiveDateThe date on which this certificate becomes valid.
SSHCertExpirationDateThe date on which the certificate expires.
SSHCertExtendedKeyUsageA comma-delimited list of extended key usage identifiers.
SSHCertFingerprintThe hex-encoded, 16-byte MD5 fingerprint of the certificate.
SSHCertFingerprintSHA1The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
SSHCertFingerprintSHA256The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
SSHCertIssuerThe issuer of the certificate.
SSHCertPrivateKeyThe private key of the certificate (if available).
SSHCertPrivateKeyAvailableWhether a PrivateKey is available for the selected certificate.
SSHCertPrivateKeyContainerThe name of the PrivateKey container for the certificate (if available).
SSHCertPublicKeyThe public key of the certificate.
SSHCertPublicKeyAlgorithmThe textual description of the certificate's public key algorithm.
SSHCertPublicKeyLengthThe length of the certificate's public key (in bits).
SSHCertSerialNumberThe serial number of the certificate encoded as a string.
SSHCertSignatureAlgorithmThe text description of the certificate's signature algorithm.
SSHCertStoreThe name of the certificate store for the client certificate.
SSHCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSHCertStoreTypeThe type of certificate store for this certificate.
SSHCertSubjectAltNamesComma-separated lists of alternative subject names for the certificate.
SSHCertThumbprintMD5The MD5 hash of the certificate.
SSHCertThumbprintSHA1The SHA-1 hash of the certificate.
SSHCertThumbprintSHA256The SHA-256 hash of the certificate.
SSHCertUsageThe text description of UsageFlags .
SSHCertUsageFlagsThe flags that show intended use for the certificate.
SSHCertVersionThe certificate's version number.
SSHCertSubjectThe subject of the certificate used for client authentication.
SSHCertEncodedThe certificate (PEM/Base64 encoded).
SSHCompressionAlgorithmsThe comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithmsThe comma-separated list containing all allowable encryption algorithms.
SSHHostThe address of the Secure Shell (SSH) host.
SSHPasswordThe password for Secure Shell (SSH) password-based authentication.
SSHPortThe port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.
SSHUserThe username for Secure Shell (SSH) authentication.
StartByteThe offset in bytes at which to begin the upload or download.
TimeoutThe timeout for the class.

Method List


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

AppendAppend data from LocalFile to a remote file RemoteFile on a Secure File Transfer Protocol (SFTP) server.
ChangeRemotePathChanges the current path on the server.
CheckFileExistsReturns if the file specified by RemoteFile exists on the remote server.
ConfigSets or retrieves a configuration setting.
ConnectConnects to the Secure Shell (SSH) host without logging in.
CreateFileCreates a file on the Secure File Transfer Protocol (SFTP) server.
DecodePacketDecodes a hex-encoded Secure Shell (SSH) packet.
DeleteFileDelete a file specified by FileName from a Secure File Transfer Protocol (SFTP) server.
DisconnectDisconnects from the server without first logging off.
DoEventsThis method processes events from the internal message queue.
DownloadDownload a RemoteFile from a Secure File Transfer Protocol (SFTP) server.
DownloadRangeDownloadRange facilitates the partial downloading of a remote file from a Secure File Transfer Protocol (SFTP) server.
EncodePacketHex encodes a Secure Shell (SSH) packet.
GetSSHParamReads a field from a Secure Shell (SSH) packet's payload.
GetSSHParamBytesReads a field from a Secure Shell (SSH) packet's payload.
InterruptThis method interrupts the current method.
ListDirectoryList the current directory specified by RemotePath on a Secure File Transfer Protocol (SFTP) server.
MakeDirectoryCreates a directory on a Secure File Transfer Protocol (SFTP) server.
QueryFileAttributesQueries the server for the attributes of RemoteFile .
QueueFileAdds a file to the transfer queue.
RemoveDirectoryRemove a directory specified by DirName from a secure file transfer protocol (SFTP) server.
RenameFileChange the name of RemoteFile to NewName .
ResetThis method will reset the class.
ResetQueueResets the queue of files to be transferred.
SetSSHParamWrites a field to the end of a payload.
SSHLogoffLogs off from the Secure Shell (SSH) server.
SSHLogonLogs on to the SSHHost using the current SSHUser and SSHPassword .
UpdateFileAttributesInstructs the class to send the FileAttributes to the server.
UploadUpload a file specified by LocalFile to a secure file transfer protocol (SFTP) server.
UploadRangeUploadRange inserts data into a remote file on a secure file transfer protocol (SFTP) server.

Event List


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

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in the connection state.
DirListFired when a directory entry is received.
DisconnectedFired when a connection is closed.
EndTransferFired when a file completes downloading or uploading.
ErrorFired when errors occur during data delivery.
LogFired once for each log message.
SSHCustomAuthFired when the class is doing a custom authentication.
SSHKeyboardInteractiveFired when the class receives a request for user input from the server.
SSHServerAuthenticationFired after the server presents its public key to the client.
SSHStatusFired to track the progress of the secure connection.
StartTransferFired when a file starts downloading or uploading.
TransferFired during file download or upload.

Config Settings


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

AllowBackslashInNameWhether backslashes are allowed in folder and file names.
AsyncTransferControls whether simultatenous requests are made to read or write files.
AttrAccessTimeCan be queried for the AccessTime file attribute during the DirList event.
AttrCreationTimeCan be queried for the CreationTime file attribute during the DirList event.
AttrFileTypeCan be queried for the FileType file attribute during the DirList event.
AttrGroupIdCan be queried for the GroupId file attribute during the DirList event.
AttrLinkCountCan be queried for the LinkCount file attribute during the DirList event.
AttrOwnerIdCan be queried for the OwnerId file attribute during the DirList event.
AttrPermissionCan be queried for the Permissions file attribute during the DirList event.
CheckFileHashCompares a server-computed hash with a hash calculated locally.
CopyRemoteDataCopies a specified range of bytes in one file to another.
CopyRemoteFileCopies a file from one location to another directly on the server.
DisableRealPathControls whether or not the SSH_FXP_REALPATH request is sent.
ExcludeFileMaskSpecifies a file mask for excluding files in directory listings.
FileMaskDelimiterSpecifies a delimiter to use for setting multiple file masks in the RemoteFile property.
FiletimeFormatSpecifies the format to use when returning filetime strings.
FreeSpaceThe free space on the remote server in bytes.
GetSpaceInfoQueries the server for drive usage information.
GetSymlinkAttrsWhether to get the attributes of the symbolic link, or the resource pointed to by the link.
IgnoreFileMaskCasingControls whether or not the file mask is case sensitive.
LocalEOLWhen TransferMode is set, this specifies the line ending for the local system.
LogSFTPFileDataWhether SFTP file data is present in Debug logs.
MaskSensitiveDataMasks passwords in logs.
MaxFileDataSpecifies the maximum payload size of an SFTP packet.
MaxOutstandingPacketsSets the maximum number of simultaneous read or write requests allowed.
NegotiatedProtocolVersionThe negotiated SFTP version.
NormalizeRemotePathWhether to normalize the RemotePath.
PreserveFileTimePreserves the file's timestamps during transfer.
ProtocolVersionThe highest allowable SFTP version to use.
ReadLinkThis settings returns the target of a specified symbolic link.
RealTimeUploadEnables real time uploading.
RealTimeUploadAgeLimitThe age limit in seconds when using RealTimeUpload.
ServerEOLWhen TransferMode is set, this specifies the line ending for the remote system.
SimultaneousTransferLimitThe maximum number of simultaneous file transfers.
TotalSpaceThe total space on the remote server in bytes.
TransferModeThe transfer mode (ASCII or Binary).
TransferredDataLimitSpecifies the maximum number of bytes to download from the remote file.
UseFxpStatWhether SSH_FXP_STAT is sent.
UseServerFileTimeControls if the file time returned from the server is converted to local time or not.
UseServerFileTimeControls if the file time returned from the server is converted to local time or not.
ChannelDataEOL[ChannelId]Used to break the incoming data stream into chunks.
ChannelDataEOLFound[ChannelId]Determines if ChannelDataEOL was found.
ClientSSHVersionStringThe SSH version string used by the class.
DoNotRepeatAuthMethodsWhether the class will repeat authentication methods during multifactor authentication.
EnablePageantAuthWhether to use a key stored in Pageant to perform client authentication.
KerberosDelegationIf true, asks for credentials with delegation enabled during authentication.
KerberosRealmThe fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosSPNThe Kerberos Service Principal Name of the SSH host.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
LogLevelSpecifies the level of detail that is logged.
MaxChannelDataLength[ChannelId]The maximum amount of data to accumulate when no ChannelDataEOL is found.
MaxPacketSizeThe maximum packet size of the channel, in bytes.
MaxWindowSizeThe maximum window size allowed for the channel, in bytes.
NegotiatedStrictKexReturns whether strict key exchange was negotiated to be used.
PasswordPromptThe text of the password prompt used in keyboard-interactive authentication.
PreferredDHGroupBitsThe size (in bits) of the preferred modulus (p) to request from the server.
RecordLengthThe length of received data records.
ServerSSHVersionStringThe remote host's SSH version string.
SignedSSHCertThe CA signed client public key used when authenticating.
SSHAcceptAnyServerHostKeyIf set the class will accept any key presented by the server.
SSHAcceptServerCAKeyThe CA public key that signed the server's host key.
SSHAcceptServerHostKeyFingerPrintThe fingerprint of the server key to accept.
SSHFingerprintHashAlgorithmThe algorithm used to calculate the fingerprint.
SSHFingerprintMD5The server hostkey's MD5 fingerprint.
SSHFingerprintSHA1The server hostkey's SHA1 fingerprint.
SSHFingerprintSHA256The server hostkey's SHA256 fingerprint.
SSHKeepAliveCountMaxThe maximum number of keep alive packets to send without a response.
SSHKeepAliveIntervalThe interval between keep alive packets.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHKeyRenegotiateCauses the class to renegotiate the SSH keys.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPubKeyAuthSigAlgorithmsSpecifies the enabled signature algorithms that may be used when attempting public key authentication.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms for the server's public key.
SSHVersionPatternThe pattern used to match the remote host's version string.
TryAllAvailableAuthMethodsIf set to true, the class will try all available authentication methods.
UseStrictKeyExchangeSpecifies how strict key exchange is supported.
WaitForChannelCloseWhether to wait for channels to be closed before disconnected.
WaitForServerDisconnectWhether to wait for the server to close the connection.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Connected Property (IPWorksSFTP_SFTPClient Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworkssftp_sftpclient_get($res, 1 );

Default Value

false

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

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

Data Type

Boolean

DirListCount Property (IPWorksSFTP_SFTPClient Class)

The number of records in the DirList arrays.

Object Oriented Interface

public function getDirListCount();

Procedural Interface

ipworkssftp_sftpclient_get($res, 2 );

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at DirListCount - 1.

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

Data Type

Integer

DirListEntry Property (IPWorksSFTP_SFTPClient Class)

This property contains the raw entry as received from the server.

Object Oriented Interface

public function getDirListEntry($entryindex);

Procedural Interface

ipworkssftp_sftpclient_get($res, 3 , $entryindex);

Default Value

''

Remarks

This property contains the raw entry as received from the server. It is the complete unparsed entry in the directory listing.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

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

Data Type

String

DirListFileName Property (IPWorksSFTP_SFTPClient Class)

This property shows the file name in the last directory listing.

Object Oriented Interface

public function getDirListFileName($entryindex);

Procedural Interface

ipworkssftp_sftpclient_get($res, 4 , $entryindex);

Default Value

''

Remarks

This property shows the file name in the last directory listing. This also may be the directory name if a directory is being listed. You can tell whether it is a file or a directory by the Boolean DirListIsDir property.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

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

Data Type

String

DirListFileSize Property (IPWorksSFTP_SFTPClient Class)

This property shows the file size in the last directory listing.

Object Oriented Interface

public function getDirListFileSize($entryindex);

Procedural Interface

ipworkssftp_sftpclient_get($res, 5 , $entryindex);

Default Value

0

Remarks

This property shows the file size in the last directory listing.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

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

Data Type

Long64

DirListFileTime Property (IPWorksSFTP_SFTPClient Class)

This property shows the file time in the last directory listing.

Object Oriented Interface

public function getDirListFileTime($entryindex);

Procedural Interface

ipworkssftp_sftpclient_get($res, 6 , $entryindex);

Default Value

''

Remarks

This property shows the file time in the last directory listing. This contains the date/time stamp in which the file was created.

Note: In Unix systems, the date is given in two types of formats: If the date is in the past 12 months, the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

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

Data Type

String

DirListIsDir Property (IPWorksSFTP_SFTPClient Class)

This property specifies whether entries in the last directory listing are directories.

Object Oriented Interface

public function getDirListIsDir($entryindex);

Procedural Interface

ipworkssftp_sftpclient_get($res, 7 , $entryindex);

Default Value

false

Remarks

This property specifies whether entries in the last directory listing are directories. This Boolean value denotes whether or not the directory entry listed in DirListFileName is a file or a directory.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

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

Data Type

Boolean

DirListIsSymlink Property (IPWorksSFTP_SFTPClient Class)

This property indicates whether the entry is a symbolic link.

Object Oriented Interface

public function getDirListIsSymlink($entryindex);

Procedural Interface

ipworkssftp_sftpclient_get($res, 8 , $entryindex);

Default Value

false

Remarks

This property indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of DirListIsDir will always be False because this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or a folder, set RemoteFile and query the FileAttributes.FileIsDir property.

The $entryindex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

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

Data Type

Boolean

FileAccessTime Property (IPWorksSFTP_SFTPClient Class)

Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed.

Object Oriented Interface

public function getFileAccessTime();
public function setFileAccessTime($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 9 );
ipworkssftp_sftpclient_set($res, 9, $value );

Default Value

0

Remarks

Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed.

This property is not available at design time.

Data Type

Long64

FileACL Property (IPWorksSFTP_SFTPClient Class)

Contains a string containing an access control list (ACL).

Object Oriented Interface

public function getFileACL();
public function setFileACL($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 11 );
ipworkssftp_sftpclient_set($res, 11, $value );

Default Value

''

Remarks

Contains a string containing an access control list (ACL).

This property is not available at design time.

Data Type

String

FileAllocationSize Property (IPWorksSFTP_SFTPClient Class)

Specifies the size, in bytes, that this file consumes on disk.

Object Oriented Interface

public function getFileAllocationSize();

Procedural Interface

ipworkssftp_sftpclient_get($res, 12 );

Default Value

0

Remarks

Specifies the size, in bytes, that this file consumes on disk.

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

Data Type

Long64

FileAttributeBits Property (IPWorksSFTP_SFTPClient Class)

AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server.

Object Oriented Interface

public function getFileAttributeBits();

Procedural Interface

ipworkssftp_sftpclient_get($res, 13 );

Default Value

0

Remarks

FileAttributeBits and FileAttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. These two values must be interpreted together. Any value present in FileAttributeBitsValid must be ignored in FileAttributeBits. This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.

This field can have one or more of the following values ORed together:

  • 0x00000001 (SSH_FILEXFER_ATTR_FLAGS_READONLY)
  • 0x00000002 (SSH_FILEXFER_ATTR_FLAGS_SYSTEM)
  • 0x00000004 (SSH_FILEXFER_ATTR_FLAGS_HIDDEN)
  • 0x00000008 (SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE)
  • 0x00000010 (SSH_FILEXFER_ATTR_FLAGS_ARCHIVE)
  • 0x00000020 (SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED)
  • 0x00000040 (SSH_FILEXFER_ATTR_FLAGS_COMPRESSED)
  • 0x00000080 (SSH_FILEXFER_ATTR_FLAGS_SPARSE)
  • 0x00000100 (SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY)
  • 0x00000200 (SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE)
  • 0x00000400 (SSH_FILEXFER_ATTR_FLAGS_SYNC)
  • 0x00000800 (SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR)

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

Data Type

Integer

FileAttributeBitsValid Property (IPWorksSFTP_SFTPClient Class)

AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server.

Object Oriented Interface

public function getFileAttributeBitsValid();

Procedural Interface

ipworkssftp_sftpclient_get($res, 14 );

Default Value

0

Remarks

FileAttributeBits and FileAttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. These two values must be interpreted together. Any value present in FileAttributeBitsValid must be ignored in FileAttributeBits. This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.

This field can have one or more of the following values ORed together:

  • 0x00000001 (SSH_FILEXFER_ATTR_FLAGS_READONLY)
  • 0x00000002 (SSH_FILEXFER_ATTR_FLAGS_SYSTEM)
  • 0x00000004 (SSH_FILEXFER_ATTR_FLAGS_HIDDEN)
  • 0x00000008 (SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE)
  • 0x00000010 (SSH_FILEXFER_ATTR_FLAGS_ARCHIVE)
  • 0x00000020 (SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED)
  • 0x00000040 (SSH_FILEXFER_ATTR_FLAGS_COMPRESSED)
  • 0x00000080 (SSH_FILEXFER_ATTR_FLAGS_SPARSE)
  • 0x00000100 (SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY)
  • 0x00000200 (SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE)
  • 0x00000400 (SSH_FILEXFER_ATTR_FLAGS_SYNC)
  • 0x00000800 (SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR)

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

Data Type

Integer

FileCreationTime Property (IPWorksSFTP_SFTPClient Class)

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created.

Object Oriented Interface

public function getFileCreationTime();
public function setFileCreationTime($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 15 );
ipworkssftp_sftpclient_set($res, 15, $value );

Default Value

0

Remarks

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created.

This property is not available at design time.

Data Type

Long64

FileType Property (IPWorksSFTP_SFTPClient Class)

The type of file.

Object Oriented Interface

public function getFileType();

Procedural Interface

ipworkssftp_sftpclient_get($res, 17 );

Default Value

0

Remarks

The type of file. FileType may be one of the following values:

1 (sftRegular - default)A normal file.
2 (sftDirectory)A directory.
3 (symlink)The file is a Unix symbolic link.
4 (sftSpecial)The file type is a special system file.
5 (sftUnknown)The file type is unknown.
6 (sftSocket)The file handle is a socket handle.
7 (sftCharDevice)The file handle is a character input device.
8 (sftBlockDevice)The file handle is a block input device.
9 (sftpFIFO)The file handle is a buffering input device.

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

Data Type

Integer

FileGroupId Property (IPWorksSFTP_SFTPClient Class)

Specifies the Id of the group that has access rights this file.

Object Oriented Interface

public function getFileGroupId();
public function setFileGroupId($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 19 );
ipworkssftp_sftpclient_set($res, 19, $value );

Default Value

''

Remarks

Specifies the Id of the group that has access rights this file.

This property is not available at design time.

Data Type

String

FileIsDir Property (IPWorksSFTP_SFTPClient Class)

Specifies whether or not the file represented by these attributes is a directory.

Object Oriented Interface

public function getFileIsDir();

Procedural Interface

ipworkssftp_sftpclient_get($res, 20 );

Default Value

false

Remarks

Specifies whether or not the file represented by these attributes is a directory.

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

Data Type

Boolean

FileIsSymlink Property (IPWorksSFTP_SFTPClient Class)

Specifies whether or not the file or directory represented by these attributes is a symbolic link.

Object Oriented Interface

public function getFileIsSymlink();

Procedural Interface

ipworkssftp_sftpclient_get($res, 21 );

Default Value

false

Remarks

Specifies whether or not the file or directory represented by these attributes is a symbolic link. This setting is applicable only when GetSymlinkAttrs is set to True. By default, the attributes of the actual file referred to by the link (not the symbolic link) are returned and this property will always be False.

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

Data Type

Boolean

FileModifiedTime Property (IPWorksSFTP_SFTPClient Class)

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified.

Object Oriented Interface

public function getFileModifiedTime();
public function setFileModifiedTime($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 24 );
ipworkssftp_sftpclient_set($res, 24, $value );

Default Value

0

Remarks

Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified.

This property is not available at design time.

Data Type

Long64

FileOwnerId Property (IPWorksSFTP_SFTPClient Class)

Specifies the user Id of this file's owner.

Object Oriented Interface

public function getFileOwnerId();
public function setFileOwnerId($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 26 );
ipworkssftp_sftpclient_set($res, 26, $value );

Default Value

''

Remarks

Specifies the user Id of this file's owner.

This property is not available at design time.

Data Type

String

FilePermissions Property (IPWorksSFTP_SFTPClient Class)

Includes a 32-bit integer containing the a POSIX-compatible file permission bitmask.

Object Oriented Interface

public function getFilePermissions();
public function setFilePermissions($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 27 );
ipworkssftp_sftpclient_set($res, 27, $value );

Default Value

0

Remarks

Includes a 32-bit integer containing the a POSIX-compatible file permission bitmask.

The bitmask should be interpreted as a decimal value of a series of octal digits. For example, an octal permission value of "100644" would be "33188" in Base10, and "40755" in octal would be "16877" in Base10.

The last three octal digits are the most significant and represent, in order, the file access capabilities of the file's owner, the owner's group, and other users. Each of these octal digits is, on its own, a 3-bit bitmask with the following possible values:

1 (001)Execute
2 (010)Write
4 (100)Read

An octal permission digit of 7 would have all three values set and would mean that the file can be read, written, and executed by that user class. For example, the octal permissions "100644" would have a value "6" for the owner, "4" for the group, and "4" for other users. This would be interpreted to mean that all users can read the file, no users can execute it, and only the owner can write it. The permissions "40755" would mean that all users can read and execute the file, but only the owner can write it.

The previous octal digit is another bitmask with the following values:

1 (001)Sticky Bit - retain the file in memory for performance
2 (010)Set GID - sets the group Id of the process to the file's group Id upon execution (only for executable files)
4 (100)Set UID - sets the user Id of the process to the file's user Id upon execution (only for executable files)

The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:

01 (000001)Named pipe
02 (000010)Character special
04 (000100)Directory
06 (000110)Block special
10 (001000)Regular
12 (001010)Symbolic link
14 (001100)Socket

For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.

Note: You will need to convert the octal permissions bitmask into its decimal representation.

This property is not available at design time.

Data Type

Integer

FilePermissionsOctal Property (IPWorksSFTP_SFTPClient Class)

Includes an octal string containing the a POSIX-compatible file permission bitmask.

Object Oriented Interface

public function getFilePermissionsOctal();
public function setFilePermissionsOctal($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 28 );
ipworkssftp_sftpclient_set($res, 28, $value );

Default Value

''

Remarks

Includes an octal string containing the a POSIX-compatible file permission bitmask.

The bitmask should be interpreted as a series of octal digits. For example, "100644" and "40755".

The last three octal digits are the most significant and represent, in order, the file access capabilities of the file's owner, the owner's group, and other users. Each of these octal digits is, on its own, a 3-bit bitmask with the following possible values:

1 (001)Execute
2 (010)Write
4 (100)Read

An octal permission digit of 7 would have all three values set and would mean that the file can be read, written, and executed by that user class. For example, the octal permissions "100644" would have a value "6" for the owner, "4" for the group, and "4" for other users. This would be interpreted to mean that all users can read the file, no users can execute it, and only the owner can write it. The permissions "40755" would mean that all users can read and execute the file, but only the owner can write it.

The previous octal digit is another bitmask with the following values:

1 (001)Sticky Bit - retain the file in memory for performance
2 (010)Set GID - sets the group Id of the process to the file's group Id upon execution (only for executable files)
4 (100)Set UID - sets the user Id of the process to the file's user Id upon execution (only for executable files)

The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:

01 (000001)Named pipe
02 (000010)Character special
04 (000100)Directory
06 (000110)Block special
10 (001000)Regular
12 (001010)Symbolic link
14 (001100)Socket

For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.

This property is not available at design time.

Data Type

String

FileSize Property (IPWorksSFTP_SFTPClient Class)

Specifies the total size, in bytes, of this file.

Object Oriented Interface

public function getFileSize();

Procedural Interface

ipworkssftp_sftpclient_get($res, 29 );

Default Value

0

Remarks

Specifies the total size, in bytes, of this file.

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

Data Type

Long64

FirewallAutoDetect Property (IPWorksSFTP_SFTPClient Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 32 );
ipworkssftp_sftpclient_set($res, 32, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksSFTP_SFTPClient Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 33 );
ipworkssftp_sftpclient_set($res, 33, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Data Type

Integer

FirewallHost Property (IPWorksSFTP_SFTPClient Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 34 );
ipworkssftp_sftpclient_set($res, 34, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorksSFTP_SFTPClient Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 35 );
ipworkssftp_sftpclient_set($res, 35, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorksSFTP_SFTPClient Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 36 );
ipworkssftp_sftpclient_set($res, 36, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (IPWorksSFTP_SFTPClient Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 37 );
ipworkssftp_sftpclient_set($res, 37, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (IPWorksSFTP_SFTPClient Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworkssftp_sftpclient_get($res, 38 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (IPWorksSFTP_SFTPClient Class)

The path to a local file for upload or download.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 39 );
ipworkssftp_sftpclient_set($res, 39, $value );

Default Value

''

Remarks

The LocalFile property is used by the Upload and Download methods. The file will be overwritten only if the Overwrite property is set to True.

Example. Setting LocalFile:

SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.Download()

Data Type

String

LocalHost Property (IPWorksSFTP_SFTPClient Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 40 );
ipworkssftp_sftpclient_set($res, 40, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (IPWorksSFTP_SFTPClient Class)

The TCP port in the local host where the class binds.

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 41 );
ipworkssftp_sftpclient_set($res, 41, $value );

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port on the client side.

Data Type

Integer

Overwrite Property (IPWorksSFTP_SFTPClient Class)

The value indicating whether or not the class should overwrite files during transfer.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 42 );
ipworkssftp_sftpclient_set($res, 42, $value );

Default Value

false

Remarks

This property is a value indicating whether or not the class should overwrite LocalFile when downloading and RemoteFile when uploading. If Overwrite is False, an error will be thrown whenever LocalFile exists before a download operation.

Data Type

Boolean

RemoteFile Property (IPWorksSFTP_SFTPClient Class)

The name of the remote file for uploading or downloading.

Object Oriented Interface

public function getRemoteFile();
public function setRemoteFile($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 43 );
ipworkssftp_sftpclient_set($res, 43, $value );

Default Value

''

Remarks

The RemoteFile is either an absolute file path or a relative path based on RemotePath.

A number of methods use RemoteFile as an argument.

Example 1. Setting RemoteFile:

SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.Download()

Note: This property will also act as a file mask when performing ListDirectory.

Example 2. Using RemoteFile as a File Mask: SFTPControl.RemoteFile = "*.txt" SFTPControl.ListDirectory()

The following special characters are supported for pattern matching:

? Any single character.
* Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct).
[,-] A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]).
\ The slash is ignored and exact matching is performed on the next character.

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:

CharacterEscape Sequence
? [?]
* [*]
[ [[]
\ [\]

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

Data Type

String

RemotePath Property (IPWorksSFTP_SFTPClient Class)

The current path in the secure file transfer protocol (SFTP) server.

Object Oriented Interface

public function getRemotePath();

Procedural Interface

ipworkssftp_sftpclient_get($res, 44 );

Default Value

''

Remarks

The RemotePath shows the current working directory on the SFTP server. The ChangeRemotePath method can be used to change the working directory to an absolute directory path or to a relative path with respect to the current value of RemotePath.

Example. Changing Directory:

sftp1.SSHLogon("sftp.server.net", 22); sftp1.ChangeRemotePath("/home/user");

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyEffectiveDate Property (IPWorksSFTP_SFTPClient Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSHAcceptServerHostKeyEffectiveDate();

Procedural Interface

ipworkssftp_sftpclient_get($res, 45 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyExpirationDate Property (IPWorksSFTP_SFTPClient Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSHAcceptServerHostKeyExpirationDate();

Procedural Interface

ipworkssftp_sftpclient_get($res, 46 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyExtendedKeyUsage Property (IPWorksSFTP_SFTPClient Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSHAcceptServerHostKeyExtendedKeyUsage();

Procedural Interface

ipworkssftp_sftpclient_get($res, 47 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyFingerprint Property (IPWorksSFTP_SFTPClient Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprint();

Procedural Interface

ipworkssftp_sftpclient_get($res, 48 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyFingerprintSHA1 Property (IPWorksSFTP_SFTPClient Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprintSHA1();

Procedural Interface

ipworkssftp_sftpclient_get($res, 49 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyFingerprintSHA256 Property (IPWorksSFTP_SFTPClient Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyFingerprintSHA256();

Procedural Interface

ipworkssftp_sftpclient_get($res, 50 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyIssuer Property (IPWorksSFTP_SFTPClient Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyIssuer();

Procedural Interface

ipworkssftp_sftpclient_get($res, 51 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyPrivateKey Property (IPWorksSFTP_SFTPClient Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKey();

Procedural Interface

ipworkssftp_sftpclient_get($res, 52 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSHAcceptServerHostKeyPrivateKey may be available but not exportable. In this case, SSHAcceptServerHostKeyPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyPrivateKeyAvailable Property (IPWorksSFTP_SFTPClient Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKeyAvailable();

Procedural Interface

ipworkssftp_sftpclient_get($res, 53 );

Default Value

false

Remarks

Whether a SSHAcceptServerHostKeyPrivateKey is available for the selected certificate. If SSHAcceptServerHostKeyPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSHAcceptServerHostKeyPrivateKeyContainer Property (IPWorksSFTP_SFTPClient Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSHAcceptServerHostKeyPrivateKeyContainer();

Procedural Interface

ipworkssftp_sftpclient_get($res, 54 );

Default Value

''

Remarks

The name of the SSHAcceptServerHostKeyPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyPublicKey Property (IPWorksSFTP_SFTPClient Class)

The public key of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKey();

Procedural Interface

ipworkssftp_sftpclient_get($res, 55 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyPublicKeyAlgorithm Property (IPWorksSFTP_SFTPClient Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKeyAlgorithm();

Procedural Interface

ipworkssftp_sftpclient_get($res, 56 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyPublicKeyLength Property (IPWorksSFTP_SFTPClient Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSHAcceptServerHostKeyPublicKeyLength();

Procedural Interface

ipworkssftp_sftpclient_get($res, 57 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSHAcceptServerHostKeySerialNumber Property (IPWorksSFTP_SFTPClient Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSHAcceptServerHostKeySerialNumber();

Procedural Interface

ipworkssftp_sftpclient_get($res, 58 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeySignatureAlgorithm Property (IPWorksSFTP_SFTPClient Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSHAcceptServerHostKeySignatureAlgorithm();

Procedural Interface

ipworkssftp_sftpclient_get($res, 59 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyStore Property (IPWorksSFTP_SFTPClient Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyStore();
public function setSSHAcceptServerHostKeyStore($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 60 );
ipworkssftp_sftpclient_set($res, 60, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSHAcceptServerHostKeyStoreType property denotes the type of the certificate store specified by SSHAcceptServerHostKeyStore. If the store is password-protected, specify the password in SSHAcceptServerHostKeyStorePassword.

SSHAcceptServerHostKeyStore is used in conjunction with the SSHAcceptServerHostKeySubject property to specify client certificates. If SSHAcceptServerHostKeyStore has a value, and SSHAcceptServerHostKeySubject or SSHAcceptServerHostKeyEncoded is set, a search for a certificate is initiated. Please see the SSHAcceptServerHostKeySubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSHAcceptServerHostKeyStorePassword Property (IPWorksSFTP_SFTPClient Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSHAcceptServerHostKeyStorePassword();
public function setSSHAcceptServerHostKeyStorePassword($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 61 );
ipworkssftp_sftpclient_set($res, 61, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSHAcceptServerHostKeyStoreType Property (IPWorksSFTP_SFTPClient Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyStoreType();
public function setSSHAcceptServerHostKeyStoreType($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 62 );
ipworkssftp_sftpclient_set($res, 62, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: This store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSHAcceptServerHostKeyStore and set SSHAcceptServerHostKeyStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSHAcceptServerHostKeySubjectAltNames Property (IPWorksSFTP_SFTPClient Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeySubjectAltNames();

Procedural Interface

ipworkssftp_sftpclient_get($res, 63 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyThumbprintMD5 Property (IPWorksSFTP_SFTPClient Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintMD5();

Procedural Interface

ipworkssftp_sftpclient_get($res, 64 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyThumbprintSHA1 Property (IPWorksSFTP_SFTPClient Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintSHA1();

Procedural Interface

ipworkssftp_sftpclient_get($res, 65 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyThumbprintSHA256 Property (IPWorksSFTP_SFTPClient Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyThumbprintSHA256();

Procedural Interface

ipworkssftp_sftpclient_get($res, 66 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyUsage Property (IPWorksSFTP_SFTPClient Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSHAcceptServerHostKeyUsage();

Procedural Interface

ipworkssftp_sftpclient_get($res, 67 );

Default Value

''

Remarks

The text description of SSHAcceptServerHostKeyUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

  • Digital Signature
  • Non-Repudiation
  • Key Encipherment
  • Data Encipherment
  • Key Agreement
  • Certificate Signing
  • CRL Signing
  • Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSHAcceptServerHostKeyUsageFlags Property (IPWorksSFTP_SFTPClient Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSHAcceptServerHostKeyUsageFlags();

Procedural Interface

ipworkssftp_sftpclient_get($res, 68 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSHAcceptServerHostKeyUsageFlags is a combination of the following flags:

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the SSHAcceptServerHostKeyUsage property for a text representation of SSHAcceptServerHostKeyUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSHAcceptServerHostKeyVersion Property (IPWorksSFTP_SFTPClient Class)

The certificate's version number.

Object Oriented Interface

public function getSSHAcceptServerHostKeyVersion();

Procedural Interface

ipworkssftp_sftpclient_get($res, 69 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSHAcceptServerHostKeySubject Property (IPWorksSFTP_SFTPClient Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSHAcceptServerHostKeySubject();
public function setSSHAcceptServerHostKeySubject($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 70 );
ipworkssftp_sftpclient_set($res, 70, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma, it must be quoted.

Data Type

String

SSHAcceptServerHostKeyEncoded Property (IPWorksSFTP_SFTPClient Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSHAcceptServerHostKeyEncoded();
public function setSSHAcceptServerHostKeyEncoded($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 71 );
ipworkssftp_sftpclient_set($res, 71, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSHAcceptServerHostKeyStore and SSHAcceptServerHostKeySubject properties also may be used to specify a certificate.

When SSHAcceptServerHostKeyEncoded is set, a search is initiated in the current SSHAcceptServerHostKeyStore for the private key of the certificate. If the key is found, SSHAcceptServerHostKeySubject is updated to reflect the full subject of the selected certificate; otherwise, SSHAcceptServerHostKeySubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSHAuthMode Property (IPWorksSFTP_SFTPClient Class)

The authentication method to be used with the class when calling SSHLogon .

Object Oriented Interface

public function getSSHAuthMode();
public function setSSHAuthMode($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 72 );
ipworkssftp_sftpclient_set($res, 72, $value );

Default Value

2

Remarks

The Secure Shell (SSH) Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the class will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.

The class will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the class supports the following authentication methods:

amNone (0)No authentication will be performed. The current SSHUser value is ignored, and the connection will be logged as anonymous.
amMultiFactor (1)This allows the class to attempt a multistep authentication process. The class will send authentication data to the server based on the list of methods allowed for the current user and the authentication property values supplied. The class will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the class fails with an error.
amPassword (2)The class will use the values of SSHUser and SSHPassword to authenticate the user.
amPublicKey (3)The class will use the values of SSHUser and the SSHCert* properties to authenticate the user. the SSHCert* properties must have a private key available for this authentication method to succeed.
amKeyboardInteractive (4)At the time of authentication, the class will fire the SSHKeyboardInteractive event containing instructions on how to complete the authentication step.

Note: amKeyboardInteractive is not supported in SSHTunnel.

amGSSAPIWithMic (5)This allows the class to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS.
amGSSAPIKeyex (6)This allows the class to attempt Kerberos authentication using the GSSAPIKeyex scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS.
amCustom (99)This allows the class caller to take over the authentication process completely. When amCustom is set, the class will fire the SSHCustomAuth event as necessary to complete the authentication process.

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

Integer

SSHCertEffectiveDate Property (IPWorksSFTP_SFTPClient Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSHCertEffectiveDate();

Procedural Interface

ipworkssftp_sftpclient_get($res, 73 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSHCertExpirationDate Property (IPWorksSFTP_SFTPClient Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSHCertExpirationDate();

Procedural Interface

ipworkssftp_sftpclient_get($res, 74 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSHCertExtendedKeyUsage Property (IPWorksSFTP_SFTPClient Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSHCertExtendedKeyUsage();

Procedural Interface

ipworkssftp_sftpclient_get($res, 75 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSHCertFingerprint Property (IPWorksSFTP_SFTPClient Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSHCertFingerprint();

Procedural Interface

ipworkssftp_sftpclient_get($res, 76 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSHCertFingerprintSHA1 Property (IPWorksSFTP_SFTPClient Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSHCertFingerprintSHA1();

Procedural Interface

ipworkssftp_sftpclient_get($res, 77 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSHCertFingerprintSHA256 Property (IPWorksSFTP_SFTPClient Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSHCertFingerprintSHA256();

Procedural Interface

ipworkssftp_sftpclient_get($res, 78 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSHCertIssuer Property (IPWorksSFTP_SFTPClient Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSHCertIssuer();

Procedural Interface

ipworkssftp_sftpclient_get($res, 79 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSHCertPrivateKey Property (IPWorksSFTP_SFTPClient Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSHCertPrivateKey();

Procedural Interface

ipworkssftp_sftpclient_get($res, 80 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSHCertPrivateKey may be available but not exportable. In this case, SSHCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSHCertPrivateKeyAvailable Property (IPWorksSFTP_SFTPClient Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSHCertPrivateKeyAvailable();

Procedural Interface

ipworkssftp_sftpclient_get($res, 81 );

Default Value

false

Remarks

Whether a SSHCertPrivateKey is available for the selected certificate. If SSHCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSHCertPrivateKeyContainer Property (IPWorksSFTP_SFTPClient Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSHCertPrivateKeyContainer();

Procedural Interface

ipworkssftp_sftpclient_get($res, 82 );

Default Value

''

Remarks

The name of the SSHCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSHCertPublicKey Property (IPWorksSFTP_SFTPClient Class)

The public key of the certificate.

Object Oriented Interface

public function getSSHCertPublicKey();

Procedural Interface

ipworkssftp_sftpclient_get($res, 83 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSHCertPublicKeyAlgorithm Property (IPWorksSFTP_SFTPClient Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSHCertPublicKeyAlgorithm();

Procedural Interface

ipworkssftp_sftpclient_get($res, 84 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHCertPublicKeyLength Property (IPWorksSFTP_SFTPClient Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSHCertPublicKeyLength();

Procedural Interface

ipworkssftp_sftpclient_get($res, 85 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSHCertSerialNumber Property (IPWorksSFTP_SFTPClient Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSHCertSerialNumber();

Procedural Interface

ipworkssftp_sftpclient_get($res, 86 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSHCertSignatureAlgorithm Property (IPWorksSFTP_SFTPClient Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSHCertSignatureAlgorithm();

Procedural Interface

ipworkssftp_sftpclient_get($res, 87 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHCertStore Property (IPWorksSFTP_SFTPClient Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSHCertStore();
public function setSSHCertStore($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 88 );
ipworkssftp_sftpclient_set($res, 88, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSHCertStoreType property denotes the type of the certificate store specified by SSHCertStore. If the store is password-protected, specify the password in SSHCertStorePassword.

SSHCertStore is used in conjunction with the SSHCertSubject property to specify client certificates. If SSHCertStore has a value, and SSHCertSubject or SSHCertEncoded is set, a search for a certificate is initiated. Please see the SSHCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSHCertStorePassword Property (IPWorksSFTP_SFTPClient Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSHCertStorePassword();
public function setSSHCertStorePassword($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 89 );
ipworkssftp_sftpclient_set($res, 89, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSHCertStoreType Property (IPWorksSFTP_SFTPClient Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSHCertStoreType();
public function setSSHCertStoreType($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 90 );
ipworkssftp_sftpclient_set($res, 90, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: This store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSHCertStore and set SSHCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSHCertSubjectAltNames Property (IPWorksSFTP_SFTPClient Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSHCertSubjectAltNames();

Procedural Interface

ipworkssftp_sftpclient_get($res, 91 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSHCertThumbprintMD5 Property (IPWorksSFTP_SFTPClient Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintMD5();

Procedural Interface

ipworkssftp_sftpclient_get($res, 92 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertThumbprintSHA1 Property (IPWorksSFTP_SFTPClient Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintSHA1();

Procedural Interface

ipworkssftp_sftpclient_get($res, 93 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertThumbprintSHA256 Property (IPWorksSFTP_SFTPClient Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintSHA256();

Procedural Interface

ipworkssftp_sftpclient_get($res, 94 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertUsage Property (IPWorksSFTP_SFTPClient Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSHCertUsage();

Procedural Interface

ipworkssftp_sftpclient_get($res, 95 );

Default Value

''

Remarks

The text description of SSHCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

  • Digital Signature
  • Non-Repudiation
  • Key Encipherment
  • Data Encipherment
  • Key Agreement
  • Certificate Signing
  • CRL Signing
  • Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSHCertUsageFlags Property (IPWorksSFTP_SFTPClient Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSHCertUsageFlags();

Procedural Interface

ipworkssftp_sftpclient_get($res, 96 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSHCertUsageFlags is a combination of the following flags:

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the SSHCertUsage property for a text representation of SSHCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSHCertVersion Property (IPWorksSFTP_SFTPClient Class)

The certificate's version number.

Object Oriented Interface

public function getSSHCertVersion();

Procedural Interface

ipworkssftp_sftpclient_get($res, 97 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSHCertSubject Property (IPWorksSFTP_SFTPClient Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSHCertSubject();
public function setSSHCertSubject($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 98 );
ipworkssftp_sftpclient_set($res, 98, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma, it must be quoted.

Data Type

String

SSHCertEncoded Property (IPWorksSFTP_SFTPClient Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSHCertEncoded();
public function setSSHCertEncoded($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 99 );
ipworkssftp_sftpclient_set($res, 99, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSHCertStore and SSHCertSubject properties also may be used to specify a certificate.

When SSHCertEncoded is set, a search is initiated in the current SSHCertStore for the private key of the certificate. If the key is found, SSHCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSHCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSHCompressionAlgorithms Property (IPWorksSFTP_SFTPClient Class)

The comma-separated list containing all allowable compression algorithms.

Object Oriented Interface

public function getSSHCompressionAlgorithms();
public function setSSHCompressionAlgorithms($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 100 );
ipworkssftp_sftpclient_set($res, 100, $value );

Default Value

'none,zlib'

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following compression algorithms are supported by the class:

  • zlib
  • zlib@openssh.com
  • none

Data Type

String

SSHEncryptionAlgorithms Property (IPWorksSFTP_SFTPClient Class)

The comma-separated list containing all allowable encryption algorithms.

Object Oriented Interface

public function getSSHEncryptionAlgorithms();
public function setSSHEncryptionAlgorithms($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 101 );
ipworkssftp_sftpclient_set($res, 101, $value );

Default Value

'aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,arcfour256,arcfour128,arcfour,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com'

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the class:

aes256-ctr256-bit AES encryption in CTR mode.
aes256-cbc256-bit AES encryption in CBC mode.
aes192-ctr192-bit AES encryption in CTR mode.
aes192-cbc192-bit AES encryption in CBC mode.
aes128-ctr128-bit AES encryption in CTR mode.
aes128-cbc128-bit AES encryption in CBC mode.
3des-ctr192-bit (3-key) triple DES encryption in CTR mode.
3des-cbc192-bit (3-key) triple DES encryption in CBC mode.
cast128-cbcCAST-128 encryption.
blowfish-cbcBlowfish encryption.
arcfourARC4 encryption.
arcfour128128-bit ARC4 encryption.
arcfour256256-bit ARC4 encryption.
aes256-gcm@openssh.com256-bit AES encryption in GCM mode.
aes128-gcm@openssh.com128-bit AES encryption in GCM mode.
chacha20-poly1305@openssh.comChaCha20 with Poly1305-AES encryption.

Data Type

String

SSHHost Property (IPWorksSFTP_SFTPClient Class)

The address of the Secure Shell (SSH) host.

Object Oriented Interface

public function getSSHHost();
public function setSSHHost($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 102 );
ipworkssftp_sftpclient_set($res, 102, $value );

Default Value

''

Remarks

The SSHHost property specifies the IP address (IP number in dotted internet format) or domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If the SSHHost property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.

The SSHHost must be the same host that will be assumed for SSH as for the remote service being connected to.

Data Type

String

SSHPassword Property (IPWorksSFTP_SFTPClient Class)

The password for Secure Shell (SSH) password-based authentication.

Object Oriented Interface

public function getSSHPassword();
public function setSSHPassword($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 103 );
ipworkssftp_sftpclient_set($res, 103, $value );

Default Value

''

Remarks

SSHPassword specifies the password that is used to authenticate the client to the SSH server.

Data Type

String

SSHPort Property (IPWorksSFTP_SFTPClient Class)

The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22.

Object Oriented Interface

public function getSSHPort();
public function setSSHPort($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 104 );
ipworkssftp_sftpclient_set($res, 104, $value );

Default Value

22

Remarks

The SSHPort specifies a service port on the SSH host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

Integer

SSHUser Property (IPWorksSFTP_SFTPClient Class)

The username for Secure Shell (SSH) authentication.

Object Oriented Interface

public function getSSHUser();
public function setSSHUser($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 105 );
ipworkssftp_sftpclient_set($res, 105, $value );

Default Value

''

Remarks

SSHUser specifies the username that is used to authenticate the client to the SSH server. This property is required.

Example 1. User/Password Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example 2. Public Key Authentication: Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

String

StartByte Property (IPWorksSFTP_SFTPClient Class)

The offset in bytes at which to begin the upload or download.

Object Oriented Interface

public function getStartByte();
public function setStartByte($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 106 );
ipworkssftp_sftpclient_set($res, 106, $value );

Default Value

0

Remarks

The StartByte property is used by the Upload and Download methods to determine at what offset to begin the transfer. This allows for resuming both uploads and downloads. The value of this property is reset to 0 after a successful transfer. StartByte is not valid for use with Append.

When downloading, this property can be used in conjunction with the TransferredDataLimit configuration setting to download only a specific range of data from the current RemoteFile.

Data Type

Long64

Timeout Property (IPWorksSFTP_SFTPClient Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworkssftp_sftpclient_get($res, 107 );
ipworkssftp_sftpclient_set($res, 107, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Append Method (IPWorksSFTP_SFTPClient Class)

Append data from LocalFile to a remote file RemoteFile on a Secure File Transfer Protocol (SFTP) server.

Object Oriented Interface

public function doAppend();

Procedural Interface

ipworkssftp_sftpclient_do_append($res);

Remarks

This method is similar to the Upload method, but the local file specified by LocalFile is appended to RemoteFile on the server as opposed to replacing it as with the Upload method. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. The server will create a file with that name if it does not already exist (similar to upload).

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

ChangeRemotePath Method (IPWorksSFTP_SFTPClient Class)

Changes the current path on the server.

Object Oriented Interface

public function doChangeRemotePath($remotepath);

Procedural Interface

ipworkssftp_sftpclient_do_changeremotepath($res, $remotepath);

Remarks

This method changes the current path on the server to the specified RemotePath. When called, the class will issue a command to the server to change the directory. The RemotePath parameter may hold an absolute or relative path.

Absolute Paths

If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For example:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For example:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

CheckFileExists Method (IPWorksSFTP_SFTPClient Class)

Returns if the file specified by RemoteFile exists on the remote server.

Object Oriented Interface

public function doCheckFileExists();

Procedural Interface

ipworkssftp_sftpclient_do_checkfileexists($res);

Remarks

This property returns true if the file exists on the remote server. It returns false if the file does not exist. You must specify the file you wish to check by setting the RemoteFile before calling this method.

If no session is in place, the value of this property will always be false.

Config Method (IPWorksSFTP_SFTPClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworkssftp_sftpclient_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (IPWorksSFTP_SFTPClient Class)

Connects to the Secure Shell (SSH) host without logging in.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworkssftp_sftpclient_do_connect($res);

Remarks

This method establishes a connection with the SSHHost but does not log in. In most cases, it is recommended to use the SSHLogon method, which will both establish a connection and log in to the server.

This method may be useful in cases in which it is desirable to separate the connection and logon operations--for instance, confirming a host is available by first creating the connection.

CreateFile Method (IPWorksSFTP_SFTPClient Class)

Creates a file on the Secure File Transfer Protocol (SFTP) server.

Object Oriented Interface

public function doCreateFile($filename);

Procedural Interface

ipworkssftp_sftpclient_do_createfile($res, $filename);

Remarks

This method creates an empty file on the server with the name specified by the FileName parameter.

To upload a file with content, use Upload instead.

DecodePacket Method (IPWorksSFTP_SFTPClient Class)

Decodes a hex-encoded Secure Shell (SSH) packet.

Object Oriented Interface

public function doDecodePacket($encodedpacket);

Procedural Interface

ipworkssftp_sftpclient_do_decodepacket($res, $encodedpacket);

Remarks

This method is used to decode an SSH packet created by EncodePacket.

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

DeleteFile Method (IPWorksSFTP_SFTPClient Class)

Delete a file specified by FileName from a Secure File Transfer Protocol (SFTP) server.

Object Oriented Interface

public function doDeleteFile($filename);

Procedural Interface

ipworkssftp_sftpclient_do_deletefile($res, $filename);

Remarks

The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

Disconnect Method (IPWorksSFTP_SFTPClient Class)

Disconnects from the server without first logging off.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworkssftp_sftpclient_do_disconnect($res);

Remarks

This method immediately disconnects from the server without first logging off.

In most cases, the SSHLogoff method should be used to log off and disconnect from the server. Call the Disconnect method in cases in which it is desirable to immediately disconnect without first logging off.

DoEvents Method (IPWorksSFTP_SFTPClient Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworkssftp_sftpclient_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Download Method (IPWorksSFTP_SFTPClient Class)

Download a RemoteFile from a Secure File Transfer Protocol (SFTP) server.

Object Oriented Interface

public function doDownload();

Procedural Interface

ipworkssftp_sftpclient_do_download($res);

Remarks

The remote file specified by RemoteFile is downloaded to the local file specified by LocalFile, or it is retrieved through the Transfer event, if the LocalFile property is "" (empty string). RemoteFile is either an absolute path on the server or is a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

Example. Download a File:

SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.Download()

DownloadRange Method (IPWorksSFTP_SFTPClient Class)

DownloadRange facilitates the partial downloading of a remote file from a Secure File Transfer Protocol (SFTP) server.

Object Oriented Interface

public function doDownloadRange($path, $filename, $startbyte, $count, $buffer);

Procedural Interface

ipworkssftp_sftpclient_do_downloadrange($res, $path, $filename, $startbyte, $count, $buffer);

Remarks

This method enables downloading a specific segment of a remote file specified by Path and FileName. StartByte is the offset (in bytes) relative to the beginning of the file from where to start reading, and Count is the number of bytes to read into the specified Buffer.

This functionality is particularly useful for efficient management of large files and targeted data retrieval within them.

Note: If the requested range extends beyond the end of the file, only the available bytes will be returned.

EncodePacket Method (IPWorksSFTP_SFTPClient Class)

Hex encodes a Secure Shell (SSH) packet.

Object Oriented Interface

public function doEncodePacket($packet);

Procedural Interface

ipworkssftp_sftpclient_do_encodepacket($res, $packet);

Remarks

This method is used to encode a raw SSH packet created by SetSSHParam.

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

GetSSHParam Method (IPWorksSFTP_SFTPClient Class)

Reads a field from a Secure Shell (SSH) packet's payload.

Object Oriented Interface

public function doGetSSHParam($payload, $field);

Procedural Interface

ipworkssftp_sftpclient_do_getsshparam($res, $payload, $field);

Remarks

This method is used to read the value of a particular field from an SSH packet's payload. Payload should contain the full payload of a packet received by an event such as SSHChannelRequest. Field is the name of a field to be read out of the packet.

The following is a list of the names of well-known channel request field names and their encodings:

ChannelId (int32)The Id of the channel that received the packet.
RequestType (string)The type of channel requested.
WantsReply (boolean)Whether or not the client wants a reply to the request.

The remaining fields that are available in the payload are dependent on the value of RequestType.

pty-req

Pty-req is a request to open a pseudo terminal on the specified channel. The following fields are available:

TerminalType (string)The type of terminal being requested (e.g., "vt100").
TerminalWidthCharacters (int32)The width, in characters, of the terminal to be opened.
TerminalHeightRows (int32)The height, in rows, of the terminal to be opened.
TerminalWidthPixels (int32)The width, in pixels, of the terminal to be opened.
TerminalHeightPixels (int32)The height, in pixels, of the terminal to be opened.
TerminalModes (string)A list of op-val (int32-byte) encoded modes to be used by the terminal.

x11-req

X11-req is a request to forward x11 sessions over a channel. The following fields are available:

SingleConnection (boolean)Disallows more than one connection to be forwarded by the channel.
X11AuthProtocol (string)The authentication protocol to be used (e.g., "MIT-MAGIC-COOKIE-1").
X11AuthCookie (string)A hexadecimal-encoded cookie to be used for authentication.
X11ScreenNumber (int32)The x11 screen number to be used.

env

Env is a request to set an environment variable to be passed into a shell that may be started later. The following fields are available:

VariableName (string)The name of the variable to be set.
VariableValue (string)The value of the variable to be set.

exec

Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:

Command (string)The command to be executed.

subsystem

Subsystem is a request to start a subsystem on the specified channel. The following field is available:

Subsystem (string)The name of the subsystem to be started (e.g., "sftp").

xon-xoff

Xon-xoff instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:

ClientCanDo (boolean)Whether or not the server should enable flow control.

signal

Sends a signal to the remote process/service. The following field is available:

SignalName (string)The name of the signal to be sent.

If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in SetSSHParam. For example, reading out the X11AuthProtocol of an x11-req payload, you can use "%s,f".

Note: The return value is a string encoded the same way as the FieldValue param in SetSSHParam.

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

GetSSHParamBytes Method (IPWorksSFTP_SFTPClient Class)

Reads a field from a Secure Shell (SSH) packet's payload.

Object Oriented Interface

public function doGetSSHParamBytes($payload, $field);

Procedural Interface

ipworkssftp_sftpclient_do_getsshparambytes($res, $payload, $field);

Remarks

This method is the same as calling GetSSHParam, but it returns raw bytes instead of strings.

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

Interrupt Method (IPWorksSFTP_SFTPClient Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworkssftp_sftpclient_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListDirectory Method (IPWorksSFTP_SFTPClient Class)

List the current directory specified by RemotePath on a Secure File Transfer Protocol (SFTP) server.

Object Oriented Interface

public function doListDirectory();

Procedural Interface

ipworkssftp_sftpclient_do_listdirectory($res);

Remarks

A listing is requested for the directory (or file mask) specified in RemoteFile. RemoteFile is either an absolute path on the server or is a path relative to RemotePath. The file listing is received through the DirList event.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

MakeDirectory Method (IPWorksSFTP_SFTPClient Class)

Creates a directory on a Secure File Transfer Protocol (SFTP) server.

Object Oriented Interface

public function doMakeDirectory($newdir);

Procedural Interface

ipworkssftp_sftpclient_do_makedirectory($res, $newdir);

Remarks

A directory with a path specified by NewDir is created on the SFTP server. NewDir is either an absolute path on the server or is a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

QueryFileAttributes Method (IPWorksSFTP_SFTPClient Class)

Queries the server for the attributes of RemoteFile .

Object Oriented Interface

public function doQueryFileAttributes();

Procedural Interface

ipworkssftp_sftpclient_do_queryfileattributes($res);

Remarks

This method queries the server for attributes of RemoteFile. After calling this method, FileAttributes will be populated with the values returned by the server.

To update attributes, modify the desired values in FileAttributes and call UpdateFileAttributes.

QueueFile Method (IPWorksSFTP_SFTPClient Class)

Adds a file to the transfer queue.

Object Oriented Interface

public function doQueueFile($localfile, $remotefile);

Procedural Interface

ipworkssftp_sftpclient_do_queuefile($res, $localfile, $remotefile);

Remarks

This method adds a file to the queue of files that will be transferred.

It is not required to use this method; however, this method extends the ability of the class to allow for multiple simultaneous file transfers.

To simply transfer a file without using this method, you need only to set LocalFile and RemoteFile and to call Upload or Download, as appropriate. This method allows you to instead queue multiple files before beginning a transfer.

When a file is queued, it will not be transferred until the Upload or Download method is called. If multiple files are queued, the files will be transferred simultaneously. The SimultaneousTransferLimit setting controls the maximum number of simultaneous transfers.

The Upload or Download method will not return until the queue has been completely processed. This method may be called from within events to add additional files to the queue before processing is complete.

To clear the queue, call ResetQueue. This will not affect current transfers.

To cancel an individual file transfer, set the Cancel parameter of the Transfer event to True. The rest of the queue will continue to process as normal.

The Interrupt method may be called to immediately stop all current transfers.

In the event of a file-specific error, the Error event will fire and the LocalFile and RemoteFile event parameters can be used to identify the file to which the error applies.

RemoveDirectory Method (IPWorksSFTP_SFTPClient Class)

Remove a directory specified by DirName from a secure file transfer protocol (SFTP) server.

Object Oriented Interface

public function doRemoveDirectory($dirname);

Procedural Interface

ipworkssftp_sftpclient_do_removedirectory($res, $dirname);

Remarks

A directory with a path specified by DirName is deleted on the SFTP server. DirName is either an absolute path on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

RenameFile Method (IPWorksSFTP_SFTPClient Class)

Change the name of RemoteFile to NewName .

Object Oriented Interface

public function doRenameFile($newname);

Procedural Interface

ipworkssftp_sftpclient_do_renamefile($res, $newname);

Remarks

The name of the remote file or the folder specified by RemoteFile is changed to NewName. RemoteFile and NewName are either absolute paths on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

Reset Method (IPWorksSFTP_SFTPClient Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworkssftp_sftpclient_do_reset($res);

Remarks

This method will reset the class's properties to their default values.

ResetQueue Method (IPWorksSFTP_SFTPClient Class)

Resets the queue of files to be transferred.

Object Oriented Interface

public function doResetQueue();

Procedural Interface

ipworkssftp_sftpclient_do_resetqueue($res);

Remarks

This method will remove all files from the transfer queue.

Calling this method will clear all files that were queued by QueueFile. Calling this method will not affect current transfers.

SetSSHParam Method (IPWorksSFTP_SFTPClient Class)

Writes a field to the end of a payload.

Object Oriented Interface

public function doSetSSHParam($payload, $fieldtype, $fieldvalue);

Procedural Interface

ipworkssftp_sftpclient_do_setsshparam($res, $payload, $fieldtype, $fieldvalue);

Remarks

This method is used to build the payload portion of a Secure Shell (SSH) packet to be sent later by a call to SendSSHPacket. Payload should contain the result of a previous call to SetSSHParam. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.

The following is a list of supported field types and a description of how FieldValue should be encoded:

sA plaintext string containing the default system encoding of the data.
sbA string containing the hex-encoded data (e.g., "A1B23C")
mA variable-length large integer, encoded as a textual representation of the value (e.g., "1234").
iA 32-bit integer, encoded as a textual representation of the value (e.g., "1234").
lA 64-bit integer, encoded as a textual representation of the value (e.g., "1234").
bA single byte, encoded as a textual representation of the value (e.g., "123").
fA boolean flag, encoded as a textual representation of the value (e.g., 'True' or 'False')

Note: Integer values may be hexadecimal encoded by prefixing "0x" to the beginning of the string; otherwise, the value is assumed to be Base10.

Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the SSHCustomAuth event.

SSHLogoff Method (IPWorksSFTP_SFTPClient Class)

Logs off from the Secure Shell (SSH) server.

Object Oriented Interface

public function doSSHLogoff();

Procedural Interface

ipworkssftp_sftpclient_do_sshlogoff($res);

Remarks

Logs off from the SSH server. If that fails, the connection is terminated by the local host.

SSHLogon Method (IPWorksSFTP_SFTPClient Class)

Logs on to the SSHHost using the current SSHUser and SSHPassword .

Object Oriented Interface

public function doSSHLogon($sshhost, $sshport);

Procedural Interface

ipworkssftp_sftpclient_do_sshlogon($res, $sshhost, $sshport);

Remarks

Logs on to the Secure Shell (SSH) server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.

Example. Logging On:

SSHClient.SSHUser = "username" SSHClient.SSHPassword = "password" SSHClient.SSHLogon("sshHost", sshPort)

UpdateFileAttributes Method (IPWorksSFTP_SFTPClient Class)

Instructs the class to send the FileAttributes to the server.

Object Oriented Interface

public function doUpdateFileAttributes();

Procedural Interface

ipworkssftp_sftpclient_do_updatefileattributes($res);

Remarks

When UpdateFileAttributes is called, the class will send the values of the following properties to the server:

Upload Method (IPWorksSFTP_SFTPClient Class)

Upload a file specified by LocalFile to a secure file transfer protocol (SFTP) server.

Object Oriented Interface

public function doUpload();

Procedural Interface

ipworkssftp_sftpclient_do_upload($res);

Remarks

The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile. RemoteFile is either an absolute path on the server or a path relative to RemotePath.

If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.

If you want to append to a server file, please refer to the Append method.

Example. Upload a File:

FTPControl.LocalFile = "C:\\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Upload() FTPControl.LocalFile = "C:\\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Upload()

UploadRange Method (IPWorksSFTP_SFTPClient Class)

UploadRange inserts data into a remote file on a secure file transfer protocol (SFTP) server.

Object Oriented Interface

public function doUploadRange($path, $filename, $startbyte, $count, $buffer);

Procedural Interface

ipworkssftp_sftpclient_do_uploadrange($res, $path, $filename, $startbyte, $count, $buffer);

Remarks

This method enables uploading a buffer into the remote file specified by the Path and FileName. Count bytes will be updated from the provided Buffer starting in the remote file at the StartByte offset.

This functionality enables precise control over the insertion of data into a remote file, allowing for targeted modifications, overwriting, or additions starting from a specific position within the file.

Note: If the offset specified is beyond the file length, empty bytes will be created between the last file byte and the uploaded buffer.

Connected Event (IPWorksSFTP_SFTPClient Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
'description'

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (IPWorksSFTP_SFTPClient Class)

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 2, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
'statuscode'
'description'

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Firewall connection complete.
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.
StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

DirList Event (IPWorksSFTP_SFTPClient Class)

Fired when a directory entry is received.

Object Oriented Interface

public function fireDirList($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 3, array($this, 'fireDirList'));

Parameter List

 'direntry'
'filename'
'isdir'
'filesize'
'filetime'
'issymlink'

Remarks

The DirList events are fired when a directory listing is received as a response to a ListDirectory.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when ListDirectory is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectory method.

The format of the FileTime parameter returned by the class can be controlled through the FileTimeFormat configuration setting. If no format is specified, the class will format the date dependent on the year. If the filetime is in the same year, it will be formatted as "MMM dd HH:mm"; otherwise, it will be formatted as "MMM dd yyyy".

IsSymlink indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of IsDir will always be False because this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or a folder, set RemoteFile and query the FileIsDir property.

Disconnected Event (IPWorksSFTP_SFTPClient Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
'description'

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (IPWorksSFTP_SFTPClient Class)

Fired when a file completes downloading or uploading.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 5, array($this, 'fireEndTransfer'));

Parameter List

 'direction'
'localfile'
'remotefile'

Remarks

The EndTransfer event fires when either an upload or a download operation completes. This occurs when the file finishes transferring or a directory listing is finished.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

Error Event (IPWorksSFTP_SFTPClient Class)

Fired when errors occur during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 6, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'
'localfile'
'remotefile'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

LocalFile identifies the local file. RemoteFile is the remote file.

Log Event (IPWorksSFTP_SFTPClient Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 7, array($this, 'fireLog'));

Parameter List

 'loglevel'
'message'
'logtype'

Remarks

Fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the detail level of the message. Possible values are as follows:

0 (None) No messages are logged.
1 (Info - Default) Informational events such as Secure Shell (SSH) handshake messages are logged.
2 (Verbose) Detailed data such as individual packet information are logged.
3 (Debug) Debug data including all relevant sent and received bytes are logged.

Message is the log message.

LogType is reserved for future use.

SSHCustomAuth Event (IPWorksSFTP_SFTPClient Class)

Fired when the class is doing a custom authentication.

Object Oriented Interface

public function fireSSHCustomAuth($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 8, array($this, 'fireSSHCustomAuth'));

Parameter List

 'packet'

Remarks

SSHCustomAuth is fired during the user authentication stage of the Secure Shell (SSH) logon process if SSHAuthMode is set to amCustom. Packet contains the last raw SSH packet sent by the server, in HEX-encoded format.

The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.

In all cases, Packet will start with the message type field.

To read the incoming packet, call DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet, use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.

SSHKeyboardInteractive Event (IPWorksSFTP_SFTPClient Class)

Fired when the class receives a request for user input from the server.

Object Oriented Interface

public function fireSSHKeyboardInteractive($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 9, array($this, 'fireSSHKeyboardInteractive'));

Parameter List

 'name'
'instructions'
'prompt'
'response'
'echoresponse'

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the Secure Shell (SSH) logon process. During authentication, the class will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the class will fire this event to allow the client application to set the password.

During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.

Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.

Note: The server may send several prompts in a single packet. The class will fire the SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (IPWorksSFTP_SFTPClient Class)

Fired after the server presents its public key to the client.

Object Oriented Interface

public function fireSSHServerAuthentication($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 10, array($this, 'fireSSHServerAuthentication'));

Parameter List

 'hostkey'
'fingerprint'
'keyalgorithm'
'certsubject'
'certissuer'
'status'
'accept'

Remarks

This event is fired when the client can decide whether or not to continue with the connection process. If the public key is known to be a valid key for the Secure Shell (SSH) server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.

Accept will be True only if either HostKey or Fingerprint is identical to the value of SSHAcceptServerHostKey.

Accept may be set to True manually to accept the server host key.

Note: SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to True is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.

Host Key contains the full binary text of the key, in the same format used internally by SSH.

Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value, see SSHFingerprintHashAlgorithm.

KeyAlgorithm identifies the host key algorithm. The following values are supported:

  • ssh-rsa
  • ssh-dss
  • rsa-sha2-256
  • rsa-sha2-512
  • x509v3-sign-rsa
  • x509v3-sign-dss
  • ecdsa-sha2-nistp256
  • ecdsa-sha2-nistp384
  • ecdsa-sha2-nistp521
To limit the accepted host key algorithms, refer to SSHPublicKeyAlgorithms.

CertSubject is the subject of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

CertIssuer is the issuer of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

Status is reserved for future use.

SSHStatus Event (IPWorksSFTP_SFTPClient Class)

Fired to track the progress of the secure connection.

Object Oriented Interface

public function fireSSHStatus($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 11, array($this, 'fireSSHStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (IPWorksSFTP_SFTPClient Class)

Fired when a file starts downloading or uploading.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 12, array($this, 'fireStartTransfer'));

Parameter List

 'direction'
'localfile'
'remotefile'

Remarks

The StartTransfer event fires when a data interface connection is created. This occurs when the file starts transferring or a directory listing is started.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

Transfer Event (IPWorksSFTP_SFTPClient Class)

Fired during file download or upload.

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworkssftp_sftpclient_register_callback($res, 13, array($this, 'fireTransfer'));

Parameter List

 'direction'
'localfile'
'remotefile'
'bytestransferred'
'percentdone'
'text'
'cancel'

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

To cancel the current transfer, set Cancel to True.

Config Settings (SFTPClient Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SFTPClient Config Settings

AllowBackslashInName:   Whether backslashes are allowed in folder and file names.

By default the backslash character is treated as a path separator and is not allowed in file and folder names. When this configuration setting is set to True, backslashes "\" are allowed in file and folder names and are not supported as path separators.

The default value is False.

AsyncTransfer:   Controls whether simultatenous requests are made to read or write files.

When set to True, the class will make several requests to read or write data before waiting for a response from the server. The maximum number of these requests that can be made is controlled by MaxOutstandingPackets. The default is True.

AttrAccessTime:   Can be queried for the AccessTime file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the AccessTime file attribute if it is present in the response from the server.

AttrCreationTime:   Can be queried for the CreationTime file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the CreationTime file attribute if it is present in the response from the server.

AttrFileType:   Can be queried for the FileType file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the FileType file attribute if it is present in the response from the server.

AttrGroupId:   Can be queried for the GroupId file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the GroupId file attribute if it is present in the response from the server.

AttrLinkCount:   Can be queried for the LinkCount file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the LinkCount file attribute if it is present in the response from the server.

AttrOwnerId:   Can be queried for the OwnerId file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the OwnerId file attribute if it is present in the response from the server.

AttrPermission:   Can be queried for the Permissions file attribute during the DirList event.

During DirList, this configuration setting can be queried to retrieve the value of the Permissions file attribute if it is present in the response from the server.

CheckFileHash:   Compares a server-computed hash with a hash calculated locally.

This setting may be queried to compare a hash of the file specified by RemoteFile with the hash calculated by the server. When queried, the class will ask the server to calculate a hash of the file. It will then compute a hash locally and compare the values to confirm that the content that exists in the file specified by RemoteFile is the same as the file specified by LocalFile.

The server must support the check-file extension.

The class supports the following hash algorithms (in order of preference): sha256,sha224,sha384,sha512,sha1,md5. The server may choose to use any value from this list. No action is needed to configure the algorithm, the class will automatically use the same algorithm that the server users.

If the extension is unsupported or a mismatch in hashes is detected, the class fails with an error. If the hashes match the value, True is returned. try { String flag = sftp.Config("CheckFileHash"); // flag will be equal to "True" } catch (Exception e) { // mismatch }

CopyRemoteData:   Copies a specified range of bytes in one file to another.

This configuration setting uses the copy-data extension to copy a range of bytes from one location to another directly on the server. The server must support the copy-data extension.

Set RemoteFile to the path of the source file. Optionally set StartByte to indicate from where in the source file to start reading. Then set CopyRemoteData to a semicolon (;) delimited listed of Name=Value pairs. In this list, DestFile must be set to the path of the destination file. Length may be set to the number of bytes to read. WriteOffset may be set to the location in the destination file from where to start writing. sftp.RemoteFile = "/my/source/file.txt"; sftp.Overwrite = true; sftp.StartByte = 6; sftp.Config("CopyRemoteData=DestFile=/my/destination/file.txt;Length=5;WriteOffset=14");

CopyRemoteFile:   Copies a file from one location to another directly on the server.

This configuration setting uses the copy-file extension to copy a file from one location to another directly on the server. The server must support the copy-file extension.

Set RemoteFile to the path of the source file, then set CopyRemoteFile to the path of the destination file. Overwrite controls whether an existing file will be overwritten. sftp.Overwrite = true; sftp.RemoteFile = "/my/source/file.txt"; sftp.Config("CopyRemoteFile=" + "/my/destination/file.txt");

DisableRealPath:   Controls whether or not the SSH_FXP_REALPATH request is sent.

This configuration setting can be used to skip sending the SSH_FXP_REALPATH request, which asks the server to canonicalize the value in RemotePath to an absolute path. The default value is False, which will cause the component to send the request normally. If set to True, the component will not send the SSH_FXP_REALPATH packet and will use the value in RemotePath directly.

ExcludeFileMask:   Specifies a file mask for excluding files in directory listings.

This configuration setting specifies one or more file masks to be excluded during a directory listing. When using multiple masks, any files that match one or more of the masks will not be listed. For example, setting ExcludeFileMask to "*.txt", RemoteFile to "", and calling ListDirectory will list all files except those ending in .txt.

FileMaskDelimiter:   Specifies a delimiter to use for setting multiple file masks in the RemoteFile property.

If specified, the RemoteFile property will be split into separate masks based on the chosen delimiter. The default is "", which will cause the RemoteFile property to be treated as a single value. When using multiple masks, any files that match one or more of the masks will be listed. For example, setting FileMaskDelimiter to "," and setting RemoteFile to "*.txt, *.csv" will list all files ending in .txt or .csv.

FiletimeFormat:   Specifies the format to use when returning filetime strings.

If specified, the class will use this value to format the filetime string returned through the DirList event. By default, the class will format the date as "MM/dd/yyyy HH:mm:ss".

FreeSpace:   The free space on the remote server in bytes.

This property is populated after calling the GetSpaceInfo configuration setting. This holds the total free space available on the drive on the remote server in bytes.

GetSpaceInfo:   Queries the server for drive usage information.

This configuration setting queries the server for the total space and free space available on the remote drive. When querying this setting, the class will immediately request the information from the server. After calling this setting the TotalSpace and FreeSpace configuration settings will be populated.

Note: The server must understand either the "statvfs@openssh.com" or "space-available" extension for this operation to succeed.

GetSymlinkAttrs:   Whether to get the attributes of the symbolic link, or the resource pointed to by the link.

When FileAttributes is queried, the class will retrieve information about the RemoteFile. This configuration setting controls the behavior when RemoteFile refers to a symbolic link on the server. By default the information returned by FileAttributes is that of the actual file pointed to by the symbolic link, not the symbolic link itself.

If it is desired to retrieve the attributes of the symbolic link itself, set GetSymlinkAttrs to True before querying FileAttributes.

IgnoreFileMaskCasing:   Controls whether or not the file mask is case sensitive.

This configuration setting applies to the file mask value specified by the RemoteFile property. The default value is True. If set to False, the file mask will be case sensitive.

LocalEOL:   When TransferMode is set, this specifies the line ending for the local system.

This configuration setting is applicable only when TransferMode is set to 1 (ASCII). The default value is a CrLf character sequence.

When uploading or downloading, this value will be compared to ServerEOL. If ServerEOL and LocalEOL are different, the line endings in the file being transferred will be converted to the line endings used by the destination. Line endings will be converted to the value in LocalEOL when downloading. Line endings will be converted to the value in ServerEOL when uploading. If ServerEOL and LocalEOL are the same, no conversion takes place.

The value supplied to this setting must be quoted. For example: component.Config("LocalEOL=\"" + myEOLSequence + "\""); Where myEOLSequence is a Cr, Lf, or CrLf character sequence.

Conversion will only happen when TransferMode is set to 1 (ASCII) and ServerEOL and LocalEOL are different.

LogSFTPFileData:   Whether SFTP file data is present in Debug logs.

This configuration setting controls whether file data is logged when LogLevel is set to 3 (Debug). When False (default), the file data being transferred is not included. Set this value to True to include all traffic include file data.

Note: Setting this value to True will increase the amount of data that are logged.

MaskSensitiveData:   Masks passwords in logs.

The default value is True. When set to True, the class will mask passwords that otherwise would appear in its logs.

MaxFileData:   Specifies the maximum payload size of an SFTP packet.

Although the Secure Shell (SSH) specification requires servers and clients to support SSH packets of at least 32,000 bytes, some server implementations limit the packet size to smaller values. MaxFileData provides a means by which the user can specify the maximum amount of data that can be put into a Secure File Transfer Protocol (SFTP) packet so that the class can communicate effectively with these servers. If you are having difficulty when uploading to a server, try setting MaxFileData size to a value smaller than 32,000.

Most servers that use smaller values will use a maximum SSH packet size of 16KB (16384). To most efficiently communicate with such servers, MaxFileData size should be set to 14745.

Note: Values larger than 64,000 (65,536) may not be respected by some servers (such as OpenSSH) and will result in unexpected behavior. If specifying a value, it is recommended to set a value less than or equal to 65,536.

The default value is 32,768.

MaxOutstandingPackets:   Sets the maximum number of simultaneous read or write requests allowed.

This configuration setting sets the number of simultaneous read or write requests allowed. This configuration setting applies only when AsyncTransfer is True. The default is 8.

NegotiatedProtocolVersion:   The negotiated SFTP version.

This configuration setting returns the negotiated version of SFTP. Query this to ensure that the correct version was negotiated. This configuration setting is read only.

NormalizeRemotePath:   Whether to normalize the RemotePath.

When set to True, the component will normalize the value in RemotePath by appending a forward slash (/) if one is not already present. "." and ".." are special cases and will not be affected. The default is True.

PreserveFileTime:   Preserves the file's timestamps during transfer.

If set to True, the class will preserve the file's timestamps during transfer. This is applicable to both uploads and downloads. The default value is False.

ProtocolVersion:   The highest allowable SFTP version to use.

This configuration setting governs the highest allowable SFTP version to use when negotiating the version with the server. The default value is 3 because this is the most common version. The class supports values from 3 to 6. It is recommended to use the default value of 3 unless there is a specific reason a higher version is needed.

ReadLink:   This settings returns the target of a specified symbolic link.

This configuration setting returns the target of the specified symbolic link. To use the setting, pass the remote path and file name of the symbolic link. For example: string resolvedPath = component.Config("ReadLink=/home/test/mysymlink.txt");

RealTimeUpload:   Enables real time uploading.

When this value is set to True, the class will upload the data in the file specified by LocalFile and continue monitoring LocalFile for additional data to upload until no new data are found for RealTimeUploadAgeLimit seconds. This allows you to start uploading a file immediately after the file is created and continue uploading as data is written to the file. The default value is False.

RealTimeUploadAgeLimit:   The age limit in seconds when using RealTimeUpload.

This value is applicable only when RealTimeUpload is set to True. This specifies the number of seconds for which the class will monitor LocalFile for new data to upload. If this limit is reached and no new data are found in LocalFile, the upload will complete. The default value is 1.

ServerEOL:   When TransferMode is set, this specifies the line ending for the remote system.

This configuration setting is applicable only when TransferMode is set to 1 (ASCII). The default value is a CrLf character sequence.

When uploading or downloading, this value will be compared to LocalEOL. If ServerEOL and LocalEOL are different, the line endings in the file being transferred will be converted to the line endings used by the destination. Line endings will be converted to the value in LocalEOL when downloading. Line endings will be converted to the value in ServerEOL when uploading. If ServerEOL and LocalEOL are the same, no conversion takes place.

The value supplied to this setting must be quoted. For example: component.Config("ServerEOL=\"" + myEOLSequence + "\""); Where myEOLSequence is a Cr, Lf, or CrLf character sequence.

Conversion will happen only when TransferMode is set to 1 (ASCII) and ServerEOL and LocalEOL are different.

SimultaneousTransferLimit:   The maximum number of simultaneous file transfers.

This configuration setting specifies the maximum number of simultaneous file transfers. This is used when processing files added to the transfer queue by QueueFile. The default value is 5.

TotalSpace:   The total space on the remote server in bytes.

This property is populated after calling the GetSpaceInfo configuration setting. This holds the total space on the drive on the remote server in bytes.

TransferMode:   The transfer mode (ASCII or Binary).

The value 0 represents binary and the value 1 represents ASCII. If the value is 0 (default), the initial server mode will be used.

When this value is set to 1 (ASCII) the class will use the values specified in LocalEOL and ServerEOL to convert line endings as appropriate.

Note: When this value is set to 1 (ASCII) and ProtocolVersion is set to 4 or higher the class will automatically determine the value for ServerEOL if the server supports the newline protocol extension.

TransferredDataLimit:   Specifies the maximum number of bytes to download from the remote file.

This configuration setting specifies the maximum number of bytes tjat should be downloaded from the current RemoteFile when Download is called. The class will stop downloading data if it reaches the specified limit, or if there are no more data to download.

This configuration setting can be used in conjunction with the StartByte property to download a specific range of data from the current RemoteFile.

UseFxpStat:   Whether SSH_FXP_STAT is sent.

For certain operations the class will send SSH_FXP_STAT to get a file's attributes. Some servers do not support this packet and will return an error.

Set this to false to not send the packet. This will cause PreserveFileTime to not work and prevent PercentDone in Transfer from being calculated.

The default is true.

UseServerFileTime:   Controls if the file time returned from the server is converted to local time or not.

If this configuration setting is set to False, the component will return the filetime as the system's local time; otherwise, it will return with the time as it is reported by the server. Controls if the file time returned from the server is converted to local time or not.

If this configuration setting is set to False, the component will return the filetime as the system's local time; otherwise, it will return with the time as it is reported by the server. The default is false.

UseServerFileTime:   Controls if the file time returned from the server is converted to local time or not.

If this configuration setting is set to False, the component will return the filetime as the system's local time; otherwise, it will return with the time as it is reported by the server. Controls if the file time returned from the server is converted to local time or not.

If this configuration setting is set to False, the component will return the filetime as the system's local time; otherwise, it will return with the time as it is reported by the server. The default is false.

SSHClient Config Settings

ChannelDataEOL[ChannelId]:   Used to break the incoming data stream into chunks.

By default MaxChannelDataLength is 0 and ChannelDataEOL is an empty string. SSHChannelData fires whenever an SSH_MSG_CHANNEL_DATA packet is received.

If MaxChannelDataLength is greater than 0 and ChannelDataEOL is a nonempty string, the class will internally buffer data waiting to fire SSHChannelData until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time SSHChannelData fires.

ChannelDataEOL and MaxChannelDataLength must be set together or unexpected behavior could occur.

ChannelDataEOLFound[ChannelId]:   Determines if ChannelDataEOL was found.

If true,then ChannelDataEOL was found. If false, then MaxChannelDataLength was reached.

This configuration setting is valid only when queried inside SSHChannelData, MaxChannelDataLength > 0, and ChannelDataEOL is nonempty.

ClientSSHVersionString:   The SSH version string used by the class.

This configuration setting specifies the Secure Shell (SSH) version string used by the class. The default value is "SSH-2.0-IPWorks SSH Client 2024".

Most SSH servers expect the SSH version string to have the expected format "SSH-protocol version-software version". See above for an example.

DoNotRepeatAuthMethods:   Whether the class will repeat authentication methods during multifactor authentication.

The default value is true. When set to false, the class will repeat authentication methods that have already been completed during multifactor authentication.

EnablePageantAuth:   Whether to use a key stored in Pageant to perform client authentication.

This configuration setting controls whether Pageant authentication is disabled, enabled, or required. When enabled or required, the class attempts to communicate with PuTTY's ssh-agent, called "Pageant", over shared memory to perform public key authentication. Possible values and the corresponding behavior is described as follows:

ValueDescription
0 (Disabled - default) No communication with Pageant is attempted.
1 (Enabled) Pageant authentication is used if available. If Pageant is not running, or does not contain the expected key, no error is thrown.
2 (Required) Only Pageant authentication is used. If Pageant is not running, or does not contain the expected key, an error is thrown.

Example 1. Enabling Pageant: component.Config("EnablePageantAuth=1"); component.SSHUser = "sshuser"; component.SSHLogon("localhost", 22);

Note: This functionality is available only on Windows.

KerberosDelegation:   If true, asks for credentials with delegation enabled during authentication.

The default value is "True". If set to "False", the client will not ask for credentials delegation support during authentication.

Note: Even if the client asks for delegation, the server/KDC might not grant it, and authentication will still succeed.

KerberosRealm:   The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.

This property may be set to the fully qualified (DNS) name of the kerberos realm (or Windows Active Directory domain name) to use during GSSAPI authentication. This can be used to force authentication with a given realm if the client and server machines are not part of the same domain.

KerberosSPN:   The Kerberos Service Principal Name of the SSH host.

This property can be set to specify the Service Principal Name (SPN) associated with the SSH service on the remote host. This will usually be in the form "host/fqdn.of.sshhost[@REALM]". If not specified, the class will assume the SPN is based on the value of the SSHHost property and the kerberos realm used for authentication.

KeyRenegotiationThreshold:   Sets the threshold for the SSH Key Renegotiation.

This property allows you to specify the threshold, in the number of bytes, for the Secure Shell (SSH) key renegotiation. The default value for this property is set to 1 GB.

Example. Setting the Threshold to 500 MB: SSHComponent.Config("KeyRenegotiationThreshold=524288000")

LogLevel:   Specifies the level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:

0 (None) No messages are logged.
1 (Info - Default) Informational events such as Secure Shell (SSH) handshake messages are logged.
2 (Verbose) Detailed data such as individual packet information are logged.
3 (Debug) Debug data including all relevant sent and received bytes are logged.

MaxChannelDataLength[ChannelId]:   The maximum amount of data to accumulate when no ChannelDataEOL is found.

By default MaxChannelDataLength is 0 and ChannelDataEOL is an empty string. SSHChannelData fires whenever an SSH_MSG_CHANNEL_DATA packet is received.

If MaxChannelDataLength is greater than 0 and ChannelDataEOL is a nonempty string, the class will internally buffer data waiting to fire SSHChannelData until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time SSHChannelData fires.

ChannelDataEOL and MaxChannelDataLength must be set together or unexpected behavior could occur.

MaxPacketSize:   The maximum packet size of the channel, in bytes.

This configuration setting specifies the maximum size of an individual data packet, in bytes, that can be sent to the sender.

MaxWindowSize:   The maximum window size allowed for the channel, in bytes.

This configuration setting specifies how many bytes of channel data can be sent to the sender of this message without adjusting the window.

Note: This value may be changed during the connection, but the window size can only be increased, not decreased.

NegotiatedStrictKex:   Returns whether strict key exchange was negotiated to be used.

This configuration setting specifies whether strict key exchange (strict kex) was negotiated during the SSH handshake. If strict kex is being used, then this will return "True". If strict kex is not being used, then this will return "False".

component.Config("NegotiatedStrictKex")

PasswordPrompt:   The text of the password prompt used in keyboard-interactive authentication.

This configuration setting optionally specifies a pattern to be matched to the prompt received from the server during keyboard-interactive authentication. If a matching prompt is detected the class automatically responds to the prompt with the password specified by SSHPassword.

This provides an easy way to automatically reply to prompts with the password if one is presented by the server. The password will be autofilled in the Response parameter of the SSHKeyboardInteractive event in the case of a match.

The following special characters are supported for pattern matching:

? Any single character.
* Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct).
[,-] A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]).
\ The slash is ignored and exact matching is performed on the next character.

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:

CharacterEscape Sequence
? [?]
* [*]
[ [[]
\ [\]

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

PreferredDHGroupBits:   The size (in bits) of the preferred modulus (p) to request from the server.

This configuration setting may be when using the diffie-hellman-group-exchange-sha1 or diffie-hellman-group-exchange-sha256 key exchange algorithms to control the preferred size, in bits, of the modulus (p) prime number to request from the server. Acceptable values are between 1024 and 8192.

RecordLength:   The length of received data records.

If set to a positive value, this configuration setting defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then will it fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

The default value is 0, meaning this setting is not used.

ServerSSHVersionString:   The remote host's SSH version string.

This configuration setting will return the remote host's SSH version string, which can help when identifying problematic servers. This configuration setting is read-only.

SignedSSHCert:   The CA signed client public key used when authenticating.

When authenticating via public key authentication, this setting may be set to the certificate authority (CA) signed client's public key. This is useful when the server has been configured to trust client keys signed by a particular CA. For instance: component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB..."); The algorithm such as ssh-rsa-cert-v01@openssh.com in the previous string is used as part of the authentication process. To use a different algorithm, simply change this value. For instance, all of the following are acceptable with the same signed public key:

  • ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
  • rsa-sha2-256-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
  • rsa-sha2-512-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...

SSHAcceptAnyServerHostKey:   If set the class will accept any key presented by the server.

The default value is "False". Set this to "True" to accept any key presented by the server.

SSHAcceptServerCAKey:   The CA public key that signed the server's host key.

If the server's host key was signed by a CA, this configuration setting may be used to specify the CA's public key. If specified, the class will trust any server's host key that was signed by the CA. For instance: component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");

SSHAcceptServerHostKeyFingerPrint:   The fingerprint of the server key to accept.

This configuration setting may be set to a comma-delimited collection of 16-byte MD5 fingerprints that should be accepted as the host's key. You may supply it by hex- encoding the values in the form "0a:1b:2c:3d". Example 2. Accepting Fingerprints: SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d"); If the server's fingerprint matches one of the values supplied, the class will accept the host key.

SSHFingerprintHashAlgorithm:   The algorithm used to calculate the fingerprint.

This configuration setting controls which hash algorithm is used to calculate the hostkey's fingerprint, displayed when SSHServerAuthentication fires. Valid values are as follows:

  • MD5
  • SHA1
  • SHA256 (default)
SSHFingerprintMD5:   The server hostkey's MD5 fingerprint.

This configuration setting may be queried in SSHServerAuthentication to get the server hostkey's MD5 fingerprint.

SSHFingerprintSHA1:   The server hostkey's SHA1 fingerprint.

This configuration setting may be queried in SSHServerAuthentication to get the server hostkey's SHA-1 fingerprint.

SSHFingerprintSHA256:   The server hostkey's SHA256 fingerprint.

This configuration setting may be queried in SSHServerAuthentication to get the server hostkey's SHA-256 fingerprint.

SSHKeepAliveCountMax:   The maximum number of keep alive packets to send without a response.

This configuration setting specifies the maximum number of keep-alive packets to send when no response is received. Normally a response to a keep-alive packet is received right away. If no response is received, the class will continue to send keep-alive packets until SSHKeepAliveCountMax is reached. If this is reached, the class will assume the connection is broken and disconnect. The default value is 5.

SSHKeepAliveInterval:   The interval between keep alive packets.

This configuration setting specifies the number of seconds between keep alive packets. If set to a positive value, the class will send a SSH keep-alive packet after KeepAliveInterval seconds of inactivity. This configuration setting takes effect only when there is no activity; if any data are sent or received over the connection, it will reset the timer.

The default value is 0, meaning no keep alives will be sent.

Note: The SSHREVERSETUNNEL class uses a default value of 30.

SSHKeyExchangeAlgorithms:   Specifies the supported key exchange algorithms.

This configuration setting may be used to specify the list of supported key exchange algorithms used during Secure Shell (SSH) negotiation. The value should contain a comma-separated list of algorithms. Supported algorithms are as follows:

  • curve25519-sha256
  • curve25519-sha256@libssh.org
  • diffie-hellman-group1-sha1
  • diffie-hellman-group14-sha1
  • diffie-hellman-group14-sha256
  • diffie-hellman-group16-sha512
  • diffie-hellman-group18-sha512
  • diffie-hellman-group-exchange-sha256
  • diffie-hellman-group-exchange-sha1
  • ecdh-sha2-nistp256
  • ecdh-sha2-nistp384
  • ecdh-sha2-nistp521
  • gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==
  • gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==
  • gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==
  • gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==
  • gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==
  • gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==
The default value is curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==,gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==,gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==.
SSHKeyRenegotiate:   Causes the component to renegotiate the SSH keys.

Once this configuration setting is queried, the component will renegotiate the SSH keys with the remote host.

Example 3. Renegotiating SSH Keys: SSHClient.Config("SSHKeyRenegotiate")

SSHMacAlgorithms:   Specifies the supported Mac algorithms.

This configuration setting may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred. The value should contain a comma-separated list of algorithms. Supported algorithms are as follows:

  • hmac-sha1
  • hmac-md5
  • hmac-sha1-96
  • hmac-md5-96
  • hmac-sha2-256
  • hmac-sha2-256-96
  • hmac-sha2-512
  • hmac-sha2-512-96
  • hmac-ripemd160
  • hmac-ripemd160-96
  • hmac-sha2-256-etm@openssh.com
  • hmac-sha2-512-etm@openssh.com
  • hmac-sha2-256-96-etm@openssh.com
  • hmac-sha2-512-96-etm@openssh.com
  • umac-64@openssh.com
  • umac-64-etm@openssh.com
  • umac-128@openssh.com
  • umac-128-etm@openssh.com
The default value is hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,umac-64@openssh.com,umac-64-etm@openssh.com,umac-128@openssh.com,umac-128-etm@openssh.com.
SSHPubKeyAuthSigAlgorithms:   Specifies the enabled signature algorithms that may be used when attempting public key authentication.

This setting specifies a list of signature algorithms that may be used when authenticating to the server using public key authentication. This applies only when public key authentication is performed by the client.

The setting should be a comma-separated list of algorithms. At runtime, the class will evaluate the specified algorithms, and if the algorithm is applicable to the certificate specified in SSHCert, it will be used. If the algorithm is not applicable, the class will evaluate the next algorithm. Possible values are as follows:

  • ssh-rsa
  • rsa-sha2-256
  • rsa-sha2-512
  • ssh-dss
  • ecdsa-sha2-nistp256
  • ecdsa-sha2-nistp384
  • ecdsa-sha2-nistp521
  • ssh-ed25519
  • x509v3-sign-rsa
  • x509v3-sign-dss

The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.

rsa-sha2-256 and rsa-sha2-512 notes

The class will query the server for supported algorithms when connecting. If the server indicates support for rsa-sha2-256 or rsa-sha2-512 and the algorithm is present in the list defined by this setting (as in the default value), that algorithm will be used instead of ssh-rsa even when ssh-rsa appears first in the list.

For the rsa-sha2-256 and rsa-sha2-512 algorithms to be automatically preferred, the server must support the ext-info-c mechanism. In practice, older servers do not support this, and in that case, ssh-rsa will be used because it appears first in the list. Newer servers do support this mechanism, and in that case, rsa-sha2-256 or rsa-sha2-512 will be used even though it appears after ssh-rsa.

This behavior has been carefully designed to provide maximum compatibility while automatically using more secure algorithms when connecting to servers that support them.

SSHPublicKeyAlgorithms:   Specifies the supported public key algorithms for the server's public key.

This configuration setting specifies the allowed public key algorithms for the server's public key. This list controls only the public key algorithm used when authenticating the server's public key. This list has no bearing on the public key algorithms that can be used by the client when performing public key authentication to the server. The default value is ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss.

SSHVersionPattern:   The pattern used to match the remote host's version string.

This configuration setting specifies the pattern used to accept or deny the remote host's SSH version string. It takes a comma-delimited list of patterns to match. The default value is "*SSH-1.99-*,*SSH-2.0-*" and will accept connections from SSH 1.99 and 2.0 hosts. As an example, the following value would accept connections for SSH 1.99, 2.0, and 2.99 hosts.

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*
TryAllAvailableAuthMethods:   If set to true, the class will try all available authentication methods.

The default value is false. When set to true, the class will try to authenticate using all methods that it has credentials for and the server supports.

UseStrictKeyExchange:   Specifies how strict key exchange is supported.

This configuration setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the class will indicate support for strict key exchange by automatically including the pseudo-algorithm kex-strict-c-v00@openssh.com for client classes and kex-strict-s-v00@openssh.com for server classes in the list of supported key exchange algorithms.

Because both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are as follows:

0Disabled. Strict key exchange is not supported in the class.
1 (default)Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue.
2Enabled, but will 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 continue only if the selected encryption and message authentication code (MAC) algorithms are not affected by the Terrapin attack.
3Required. If the remote host does not support strict key exchange, the connection will fail.

WaitForChannelClose:   Whether to wait for channels to be closed before disconnected.

This configuration setting controls whether the class will wait for a server response to the SSH_MSG_CHANNEL_CLOSE when disconnecting. When the class disconnects, it will first attempt to close all open channels by sending a SSH_MSG_CHANNEL_CLOSE for each channel. This configuration setting controls whether the class will wait for a server response after sending the messages.

When True (default), the class will wait for a response to the channel close message until the responses have been received, the server closes the connection, or Timeout seconds is reached.

When False, the class will still send the channel close messages, but it will not wait for a response and will proceed to close the connection.

WaitForServerDisconnect:   Whether to wait for the server to close the connection.

This configuration setting controls whether to wait for the server to close the connection when SSHLogoff is called.

When set to True, the class will initiate the disconnection sequence by sending SSH_MSG_DISCONNECT, but it will not close the connection and instead will wait for the server to close the connection. Setting this to True may be beneficial in circumstances in which many connections are being established, to avoid port exhaustion when sockets are in a TIME_WAIT state. Allowing the server to close the connection avoids the TIME_WAIT state of socket on the client machine.

When set to False (default), the client will close the connection. It is recommended to use this value unless there is a specific need to change it.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

Possible values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:

0 IPv4 only
1 IPv6 only
2 IPv6 with IPv4 fallback

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the FIPS 140-2 Compliance article.

Note: This setting is applicable only on Windows.

Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (SFTPClient Class)

SFTPClient Errors

118   Firewall error. Error description contains detailed information.
1102   The server's SFTP draft version is unsupported.
1103   SFTP command failed. Error description contains detailed information.
1104   Server does not support renaming.
1105   Received invalid response from server. Error description contains detailed information.
1106   Cannot resolve path: path does not exist.
1107   You must set LocalFile/RemoteFile before attempting to download/upload.
1108   Cannot download file: LocalFile exists and Overwrite is set to False.
1109   CheckFileHash failed because of hash value mismatch.

SSHClient Errors

1001   Server has disconnected.
1002   Protocol version unsupported or other issue with version string.
1003   Cannot negotiate algorithms.
1005   Selected algorithm unsupported.
1006   Cannot set keys.
1010   Unexpected algorithm.
1011   Cannot create exchange hash.
1012   Cannot make key.
1013   Cannot sign data.
1014   Cannot encrypt packet.
1015   Cannot decrypt packet.
1016   Cannot decompress packet.
1020   Failure to open channel.
1021   Invalid channel Id.
1022   Invalid channel data.
1023   Invalid channel message.
1024   SSH message unimplemented.
1027   Server message unsupported.
1030   Server's host key was rejected. The host key may be accepted within the SSHServerAuthentication event or using the SSHAcceptServerHostKey property.
1031   Cannot verify server's host key.
1032   Authentication failed. Check description for details.
1033   Channel request failed.
1034   Diffie-Hellman exchange failed.
1036   SSH connection failed.
1037   SSH reconnect limit reached.
1038   Elliptic curve Diffie-Hellman exchange failed.
1039   SSH keep-alive limit reached.
1098   Request failure.
1130   Would block error.
1133   Would block, reason: key reExchange.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on nonsocket.
10039   [10039] Destination address required.
10040   [10040] Message is too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol is not supported.
10044   [10044] Socket type is not supported.
10045   [10045] Operation is not supported on socket.
10046   [10046] Protocol family is not supported.
10047   [10047] Address family is not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Cannot assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Cannot send after socket shutdown.
10059   [10059] Too many references, cannot splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name is too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory is not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock is not loaded yet.
11001   [11001] Host not found.
11002   [11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).