IP*Works! SSL ftps Component : ftps OCX, ftps .NET Component, ftps Class, ftps Bean, ftps Object

Available in: SSL

Ftps Class

FTPS Component [IP*Works! SSL V8]

Properties Methods Events Configuration Settings

The FTPS component can be used to transfer files to and from FTP servers using the FTP Protocol.

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 FTPS component is the SSL-enabled equivalent of the IP*Works! FTP component. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The SSLProvider configuration setting chooses a security provider subsystem. The SSLEnabledProtocols and SSLCipherStrength configuration settings determine which protocols are enabled and at what security level. The SSLCertStore, SSLCertSubject, and SSLCertEncoded properties are used to select a client certificate if the server is requesting client authentication. The SSLSecurityFlags configuration setting, together with the SSLServerAuthentication event allow you to check the server identity and other security attributes. Finally, the SSLStatus event provides information about the SSL handshake.

The FTPS component implements a standard FTP client as specified in RFC 959 and RFC 1579 with the added option of SSL security (RFC 2228) in both the protocol and data channels.

The first step in using the component is specifying the RemoteHost, User and Password. 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. The Passive property is especially useful if the client is behind a firewall which inhibits incoming connections to higher ports.

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.

The PITrail event traces the interaction between the client and the server (the FTP Protocol Interface connection).

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 complete descriptions.


Account	The user Account to login with.
Command	Can be used to send additional commands directly to the server.
Connected	Shows whether the component is connected.
DirList	Collection of entries resulting in the last directory listing.
FileExists	Returns true if the file specified by RemoteFile exists on the remote server.
FileSize	The size of the file pointed to by RemoteFile.
FileTime	The last modification time of the file pointed to by RemoteFile.
Firewall	A set of properties related to firewall access.
Idle	The current status of the component.
LastReply	The last reply from the server.
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.
Overwrite	Whether or not the component should overwrite files during transfer.
Passive	Controls whether to direct the server into passive mode. Recommended if behind a firewall.
Password	The password to login with.
RemoteFile	The name of the remote file for uploading, downloading, etc.
RemoteHost	The domain name or IP address of the FTP server.
RemotePath	The current path in the FTP server.
RemotePort	The port for the FTP service (default is 21).
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded	The SSL certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	The password for the certificate store (if any).
SSLCertStoreType	The type of certificate store for the client certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCert	The server certificate for the last established connection.
SSLServerCertStatus	The verification status of the server certificate for the last established connection.
SSLStartMode	Determines how the component starts the SSL negotiation.
StartByte	The byte index in RemoteFile and LocalFile from which to start the transmission.
Timeout	A timeout for the component.
TransferMode	The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.
User	The user id to login as.

Method List

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


Abort	Abort Current Upload/Download.
Append	Append data from LocalFile to a remote file RemoteFile on an FTP server.
Config	Sets or retrieves a component configuration setting.
DeleteFile	Remove a file specified by FileName from an FTP server.
DoEvents	Processes events from the internal message queue.
Download	Download a RemoteFile from an FTP server.
Interrupt	Interrupt the current method.
ListDirectory	List the current directory specified by RemotePath on an FTP server.
ListDirectoryLong	List extended directory information for RemotePath.
Logoff	Logoff from the FTP server by posting a QUIT command.
Logon	Logon to the FTP RemoteHost using the current User and Password.
MakeDirectory	Create a directory on an FTP server.
RemoveDirectory	Remove a directory specified by DirName from an FTP server.
RenameFile	Change the name of RemoteFile to NewName.
SetDownloadStream	Sets the stream to which the downloaded data from the server will be written.
SetUploadStream	Sets the stream from which the component will read data to upload to the server.
StoreUnique	Upload a file with a Unique Name to an FTP server.
Upload	Upload a file specified by LocalFile to an FTP server.

Event List

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


ConnectionStatus	Fired to indicate changes in connection state.
DirList	Fired when a directory entry is received.
EndTransfer	Fired when a file completes downloading/uploading.
Error	Information about errors during data delivery.
PITrail	Traces the commands sent to the server, and the respective replies.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	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 complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
AcceptAnyServerCert	If set the component will accept any certificate presented by the server
ActiveModePORTAddress	Allows the specification of the PORT address value for active mode connections.
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
InBufferSize	The size in bytes of the incoming queue of the socket.
MaxDirEntries	Instructs component to save the amount of entries specified that are returned by the server after a ListDirectory call has been made.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator(PRNG).
OutBufferSize	The size in bytes of the outgoing queue of the socket.
PortRange	Allows the specification of a port range where the component listens for active mode connections.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification
SocketHandle	The handle of the main socket used by the component.
TcpNoDelay	Whether or not to delay when sending packets
UseClearChannel	Allows for the Clear Command Channel (CCC) command
UseClearDataChannel	Allows for the PROT C command
UseEPSV	Allows extended passive mode
UseOldAUTHSSL	Allows use of the 'AUTH SSL' command instead of 'AUTH TLS'.
UseProtWhenImplicit	Sends the PROT P command to the server.
UseRemoteHostAddressForPassive	Instructs component to use the in passive mode
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)