IP*Works! SSH SFTP Component : SFTP OCX, SFTP .NET Component, SFTP Class, SFTP Bean, SFTP Object

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The SFTP component is the SSH-enabled equivalent of the IP*Works! FTP component. The main difference is the introduction of a set of new properties and events that deal with SSH security. The SSHHost and SSHPort properties specify the SSH server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event and/or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.

The SFTP component implements a standard SSH File Transfer client.

The first step in using the component 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 is 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 component with short descriptions. Click on the links for further details.


Connected	Triggers a connection or disconnection.
DirListCount	The number of records in the DirList arrays.
DirListEntry	This property contains the raw entry as received from the server.
DirListFileName	This property shows the file name in the last directory listing.
DirListFileSize	This property shows the file size in the last directory listing.
DirListFileTime	This property shows the file time in the last directory listing.
DirListIsDir	This property specifies whether entries in the last directory listing are directories.
FileAccessTime	The number of milliseconds since 12:00:00 AM January 1, 1970 when this file was last accessed.
FileACL	A string containing an Access Control List (ACL).
FileAllocationSize	The size, in bytes, that this file consumes on disk.
FileAttributeBits	AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the SFTP server.
FileAttributeBitsValid	AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the SFTP server.
FileCreationTime	The number of milliseconds since 12:00:00 AM January 1, 1970 when this file was created.
FileType	The type of file.
FileGroupId	The id of the group that has access rights this file.
FileIsDir	Whether or not the file represented by these attributes is a directory.
FileModifiedTime	The number of milliseconds since 12:00:00 AM January 1, 1970 that this file was last modified.
FileOwnerId	The user id of this file's owner.
FilePermissions	A 32-bit integer containing a POSIX-compatible file permission bitmask.
FileSize	The total size, in bytes, of this file.
FileExists	Returns true if the file specified by RemoteFile exists on the remote server.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
Idle	The current status of the component.
LocalFile	The path to a local file for download/upload. If the file exists, it is overwritten.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where IPPort binds.
Overwrite	Whether or not the component should overwrite files during transfer.
RemoteFile	The name of the remote file for uploading, downloading, etc.
RemotePath	The current path in the SFTP server.
SSHAcceptServerHostKeyEncoded	The certificate (PEM/base64 encoded).
SSHAuthMode	The authentication method to be used the component when performing an SSHLogon.
SSHCertEncoded	The certificate (PEM/base64 encoded).
SSHCertStore	The name of the certificate store for the client certificate.
SSHCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSHCertStoreType	The type of certificate store for this certificate.
SSHCertSubject	The subject of the certificate used for client authentication.
SSHCompressionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHHost	The address of the SSH host.
SSHPassword	The password for SSH password-based authentication.
SSHPort	The port on the SSH server where the SSH service is running; by default, 22.
SSHUser	The username for SSH authentication.
StartByte	The offset in bytes at which to begin the Upload or Download.
Timeout	A timeout for the component.

Method List

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


Append	Append data from LocalFile to a remote file RemoteFile on an SFTP server.
Config	Sets or retrieves a configuration setting.
DeleteFile	Remove a file specified by FileName from an SFTP server.
DoEvents	Processes events from the internal message queue.
Download	Download a RemoteFile from an SFTP server.
Interrupt	Interrupt the current method.
ListDirectory	List the current directory specified by RemotePath on an SFTP server.
MakeDirectory	Create a directory on an SFTP server.
RemoveDirectory	Remove a directory specified by DirName from an SFTP server.
RenameFile	Change the name of RemoteFile to NewName.
SSHLogoff	Logoff from the SSH server.
SSHLogon	Logon to the SSHHost using the current SSHUser and SSHPassword.
UpdateFileAttributes	Instructs the component to send the FileAttributes to the server.
Upload	Upload a file specified by LocalFile to an SFTP server.

Event List

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


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
DirList	Fired when a directory entry is received.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a file completes downloading/uploading.
Error	Information about errors during data delivery.
SSHKeyboardInteractive	Fired when the component receives a request for user input from the server.
SSHServerAuthentication	Fired after the server presents its public key to the client.
SSHStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a file starts downloading/uploading.
Transfer	Fired during file download/upload.

Configuration Settings

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


FiletimeFormat	Specifies the format to use when returning filetime strings.
IgnoreFileMaskCasing	Controls whether or not the file mask is case sensitive.
MaxFileData	Specifies the maximum payload size of an SFTP packet.
ProtocolVersion	The highest allowable SFTP version to use.
TransferMode	The transfer mode (ASCII or Binary).
SSHAcceptAnyServerHostKey	If set the component will accept any key presented by the server.
SSHAcceptServerHostKeyFingerPrint	The fingerprint of the server key to accept.
SSHMacAlgorithms	Specifies the supported Mac algorithms.
SSHKeyRenegotiate	Causes the component to renegotiate the SSH keys.
KeyRenegotiationThreshold	Sets the threshold for the SSH Key Renegotiation.
KerberosRealm	The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosDelegation	If true, asks for credentials with delegation enabled during authentication.
KerberosSPN	The Kerberos Service Principal Name of the SSH host.
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.

|

About

|

Privacy Policy

|

Terms of Use

|