Description

To establish a connection with a secure FTP server, use the open action with a connection attribute, specify that secure = "yes", and specify the key, passphrase, and fingerprint as appropriate.

<cfftp 
    action = "open|close"
    connection = "name"
    fingerprint = "ssh-dss.ssh-rsa"
    key = "private key"
    passive = "yes|no">
    passphrase = "passphrase"
    password = "password"
    port = "port"
    proxyServer = "proxy server"
    retryCount = "number"
    secure = "yes|no"
    server = "server"
    stopOnError = "yes|no"
    timeout = "time-out in seconds"
    username = "name">

See also

cfhttp, cfldap, cfmail, cfpop

Attributes

Usage

The cfftp tag lets you open a connection to a Secure Shell (SSH) server by using either symmetric or asymmetric encryption. To use symmetric encryption, you specify secure="yes", the user name, password, connection, and fingerprint. To use asymmetric encryption, you must first generate private-public key pairs for each user authorized to have access to the server. Each authorized user's public key is stored on the server; each user's private key is encrypted and stored on that user's computer. To open a connection to the SSH server, you specify secure="yes", the user name, the password or the private key and the passphrase that the server uses to decrypt the private key, connection, and fingerprint. After you open the connection to the SSH server, you can use that connection for any action supported by the cfftp tag.

To keep a connection open throughout a session or longer, put the connection name in the Session or Application scope; for example, specify connection="Session.FTPConnection". However, if you do this, you must specify the full variable name in all FTP operations, and you must use the close action when you are finished. Keeping a connection open prevents others from using the FTP server; so close a connection as soon as possible. If you do not assign the connection name to Session or Application variable, the connection remains open for the current page only, and you do not have to close it manually.

Changes to a cached connection, such as changing retryCount or timeout values, might require reestablishing the connection.

Example

<!--- This example uses symmetric encryption. --->

<!--- Open the secure connection. --->
<cfftp action = "open"
    username = "myusername"
    connection = "My_query"
    password = "mypassword"
    fingerprint = "12:34:56:78:AB:CD:EF:FE:DC:BA:87:65:43:21"
    server = "ftp.tucows.com"
    secure = "yes">
<p>Did it succeed? <cfoutput>#cfftp.succeeded#</cfoutput>
<cfdump var ="#My_query# label="connection">

<!--- Transfer files to the remote server. --->
<cfset absolutePathToLocalFile="C:\one\two\myfile.htm">
    <cfif FileExists(absolutePathToLocalFile)>
        <cfftp action = "putFile"
            connection="My_query"
            localFile="#variables.absolutePathToLocalFile#"
            remoteFile="/home/myname/sftptest/myfile.htm">
    <cfelse>
        <!--- Put error handling code here. --->
    </cfif>
<p>Did it succeed? <cfoutput>#cfftp.succeeded#</cfoutput>

<!--- Close the connection. --->
<cfftp action="close" connection="My_query">

Example

<!--- This example uses asymmetric encryption. --->

<!--- Open the secure connection. --->
<cfftp action = "open"
    username = "myusername"
    connection = "My_query"
    key="C:\mykeys\myprivatekey"
    passphrase = "zHx628Fg"
    fingerprint = "12:34:56:78:AB:CD:EF:FE:DC:BA:87:65:43:21"
    server = "ftp.tucows.com"
    secure = "yes">
<p>Did it succeed? <cfoutput>#cfftp.succeeded#</cfoutput>
<cfdump var ="#My_query# label="connection">

<!--- List files on the remote server. --->
<cftry>
    <!--- List the files in a directory. --->
        <cfftp action = "listDir"
            connection="My_query"
            stopOnError="yes"
            name="ListFiles"
            directory="/">
    <cfcatch>
        <!--- Close the connection. --->
        <cfftp action="close" connection="My_query" stopOnError="no">
    </cfcatch>
</cftry>