User Guide Cancel

cfftp: Opening and closing secure FTP server connections

Last updated on May 30, 2024 | Also applies to ColdFusion

CFML Reference User Guide
ColdFusion functions
ColdFusion Tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcol
    5. cfcontent
    6. cfdocument
    7. cfdocumentitem
    8. cfdocumentsection
    9. cfflush
    10. cfheader
    11. cflog
    12. cfoutput
    13. cfpresentation
    14. cfpresentationslide
    15. cfpresenter
    16. cfprocessingdirective
    17. cfprint
    18. cfreport
    19. cfreportparam
    20. cfsilent
    21. cftable
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

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">

cfscript equivalent of the syntax

<cfscript> 
    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") 
</cfscript>

Note: You can specify this tag's attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag's attribute names as structure keys.

Attributes

Attribute	Req/Opt	Default	Description
action	Required		FTP operation to perform. open: creates an FTP connection. close: terminates an FTP connection.
connection	Optional, but always used with open or close		Name of the FTP connection. If you specify the username, password, and server attributes, and if no connection exists for them, ColdFusion creates one. Calls to cfftp with the same connection name reuse the connection.
fingerprint	Optional. Used only when server, username, and password are supplied		Fingerprint of the host key in the form ssh-dss.ssh-rsa, which is a 16-byte unique identifier for the server attribute that you specify, The fingerprint consists of eight pairs of hexadecimal values in the form hh:hh:hh:hh::hh:hh:hh:hh. ColdFusion checks the fingerprint of the remote server only if the fingerprint value is specified.
key	Required if action="open" (}}When {{secure="yes", either password or key is required.)		Public-key based authentication. Refers to the absolute path to the private key of the user. Possession of a private key provides authentication by sending a signature created with a private key. The server must ensure that the key is a valid authentication for the user and that the signature is valid. Both must be valid to accept the authentication.
passive	Optional	no	Valid only if secure="no". yes: enables passive mode. no
passphrase	Optional. Used when key is specified		Because private keys are stored in an encrypted form on the client host, the user must supply a passphrase to enable generating the signature.
password	Required if action="open" (}}When {{secure="yes", either password or key is required.)		Password to log in the user.
port	Optional	21	Remote port to which to connect.
proxyServer	Optional		String. Name of proxy server (or servers) to use, if proxy access is specified.
retryCount	Optional	1	Number of retries until failure is reported.
secure	Optional	no	yes: enables secure FTP no
server	Required if action="open"		FTP server to which to connect; for example, ftp.myserver.com.
stopOnError	Optional	no	yes: halts processing, displays an appropriate error. no: if secure="yes", populates the following variables: If ColdFusion fails to connect to the secure FTP server, it halts processing and displays the appropriate error message cfftp.succeeded: yes or no cfftp.errorCode: error number cfftp.errorText: message text For all file operations, returns the following error codes: SSH-CONNECT 25 SSH_MSG_USERAUTH_FAILURE 51 SSH_MSG_USERAUTH_SUCCESS 52 SSH_MSG_REQUEST_SUCCESS 81 SSH_MSG_REQUEST_FAILURE 82For conditional operations, use cfftp.errorCode. Do not use cfftp.errorText for this purpose.
timeout	Optional	30	Value in seconds for the time-out of all operations, including individual data request operations.
username	Required if action="open"		User name to pass in the FTP operation.

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, 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, specify the full variable name in all FTP operations, and 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>

Get help faster and easier

New user?

cfftp: Opening and closing secure FTP server connections

Description

cfscript equivalent of the syntax

See also

Attributes

Usage

Example

Example

Get help faster and easier

Ask the Community

Contact Us