In computing, the SSH File Transfer Protocol (also Secret File Transfer Protocol, Secure FTP, or SFTP) is a network protocol that provides file access, file transfer, and file management functionalities over any reliable data stream. It was designed by the Internet Engineering Task Force (IETF) as an extension of the Secure Shell protocol (SSH) version 2.0 to provide secure file transfer capability, but is also intended to be usable with other protocols. The IETF of the Internet Draft states that even though this protocol is described in the context of the SSH-2 protocol, it could be used in a number of different applications, such as secure file transfer over Transport Layer Security (TLS) and transfer of management information in VPN applications.

This protocol assumes that it is run over a secure channel, such as SSH, that the server has already authenticated the client, and that the identity of the client user is available to the protocol.

Capabilities[link]

Compared to the earlier SCP protocol, which allows only file transfers, the SFTP protocol allows for a range of operations on remote files – it is more like a remote file system protocol. An SFTP client's extra capabilities compared to an SCP client include resuming interrupted transfers, directory listings, and remote file removal. ^[1]

SFTP attempts to be more platform-independent than SCP; for instance, with SCP, the expansion of wildcards specified by the client is up to the server, whereas SFTP's design avoids this problem. While SCP is most frequently implemented on Unix platforms, SFTP servers are commonly available on most platforms.

SFTP is not FTP run over SSH, but rather a new protocol designed from the ground up by the IETF SECSH working group. It is sometimes confused with Simple File Transfer Protocol. ^[1]

The protocol itself does not provide authentication and security; it expects the underlying protocol to secure this. SFTP is most often used as subsystem of SSH protocol version 2 implementations, having been designed by the same working group. However, it is possible to run it over SSH-1 (and some implementations support this) or other data streams. Running SFTP server over SSH-1 is not platform independent as SSH-1 does not support the concept of subsystems. An SFTP client willing to connect to an SSH-1 server needs to know the path to the SFTP server binary on the server side.

For uploads, the transferred files may be associated with their basic attributes, such as timestamps. This is an advantage over the common FTP protocol, which does not have provision for uploads to include the original date/timestamp attribute without help.

History and development[link]

The Internet Engineering Task Force (IETF) working group "Secsh" that was responsible for the development of the Secure Shell version 2 protocol (RFC 4251) also attempted to draft an extension of that standard for secure file transfer functionality. Internet Drafts were created that successively revised the protocol into new versions.^[2] The software industry began to implement various versions of the protocol before the drafts were standardized. As development work progressed, the scope of the Secsh File Transfer project expanded to include file access and file management. Eventually, development stalled as some committee members began to view SFTP as a file system protocol, not just a file access or file transfer protocol, which places it beyond the purview of the working group.^[3]

As of 2006, version 6 is the last revision to be produced by that group.^[2] The protocol is not an Internet standard but it is still widely implemented.

Version 3[link]

At the outset of the Secure Shell File Transfer project, the Secsh group stated that its objective of SSH File Transfer Protocol was to provide a secure file transfer functionality over any reliable data stream, and to be the standard file transfer protocol for use with the SSH-2 protocol.

Drafts 00 - 02 of the IETF Internet Draft define successive revisions of version 3 of the SFTP protocol.

• SSH File Transfer Protocol, Draft 00, January 2001
• SSH File Transfer Protocol, Draft 01, March 2001
• SSH File Transfer Protocol, Draft 02, October 2001

Version 4[link]

Drafts 03 - 04 of the IETF Internet Draft define version 4 of the protocol.

• SSH File Transfer Protocol, Draft 03, October 2002
• SSH File Transfer Protocol, Draft 04, December 2002

Version 5[link]

Draft 05 of the IETF Internet Draft defines version 5 of the protocol.

• SSH File Transfer Protocol, Draft 05, January 2004

Version 6[link]

Drafts 06 - 13 of the IETF Internet Draft define successive revisions of version 6 of the protocol.

• SSH File Transfer Protocol, Draft 06, October 2004
• SSH File Transfer Protocol, Draft 07, March 2005
• SSH File Transfer Protocol, Draft 08, April 2005
• SSH File Transfer Protocol, Draft 09, June 2005
• SSH File Transfer Protocol, Draft 10, June 2005
• SSH File Transfer Protocol, Draft 11, January 2006
• SSH File Transfer Protocol, Draft 12, January 2006
• SSH File Transfer Protocol, Draft 13, July 2006

Software[link]

SFTP client[link]

The term SFTP can also refer to Secure file transfer program, a command-line program that implements the client part of this protocol, such as that supplied with OpenSSH.

Some implementations of the scp program actually use the SFTP protocol to perform file transfers; however, some such implementations are still able to fallback to the SCP protocol if the server does not provide SFTP service.

SFTP server[link]

There are numerous SFTP server implementations both for UNIX, Windows and z/OS. The most widely known is perhaps OpenSSH, but there are also proprietary implementations. Typically the port used is 22. SFTP file transfer protocol is part of SSH protocol suite.

SFTP proxy[link]

It is difficult to control SFTP transfers on security devices at the network perimeter. There are standard tools for logging FTP transactions, like TIS fwtk or SUSE FTP proxy, but SFTP is encrypted, rendering traditional proxies ineffective for controlling SFTP traffic.

There are some tools that implement man-in-the-middle for SSH which also feature SFTP control. Examples of these tools include Shell Control Box from Balabit ^[4] and FileGate SFP from Presaris.^[5] These provide functions such as SFTP transaction logging and logging of the actual data transmitted on the wire.

See also[link]

Cryptography portal

• SSH Communications Security - SSH.com, original inventor of the SSH protocol (former Tectia)
• Comparison of SSH servers
• Comparison of SSH clients
• FISH
• AbsoluteTelnet - SSH client that includes a GUI SFTP client for file transfer.
• SSHFS - Mounting remote filesystem using SFTP and SSH
• Category:FTP clients
• Category:SFTP clients
• Lsh - A GNU SSH-2 and SFTP server for Unix-like
• List of file transfer protocols
• FTPS

References[link]

1. ^ ^{a b} Barrett, Daniel; Richard E. Silverman (2001), SSH, The Secure Shell: The Definitive Guide, Cambridge: O'Reilly, ISBN 0-596-00011-1 
2. ^ ^{a b} http://tools.ietf.org/wg/secsh/draft-ietf-secsh-filexfer/
3. ^ http://osdir.com/ml/ietf.secsh/2006-07/msg00010.html
4. ^ http://www.balabit.com/network-security/scb/
5. ^ http://www.presaris.com/products/filegate

External links[link]

• Chrooted SFTP with Public Key Authentication – Integrating SFTP into FreeBSD production servers using the public key cryptography approach
• User-based chrooted SFTP in GNU/Linux

File Transfer Protocol (FTP) is a standard network protocol used to transfer files from one host to another host over a TCP-based network, such as the Internet. It is often used to upload web pages and other documents from a private development machine to a public web-hosting server. FTP is built on a client-server architecture and uses separate control and data connections between the client and the server.^[1] FTP users may authenticate themselves using a clear-text sign-in protocol, normally in the form of a username and password, but can connect anonymously if the server is configured to allow it. For secure transmission that hides (encrypts) the username and password, and encrypts the content, SSH File Transfer Protocol may be used.

The first FTP client applications were interactive command-line tools, implementing standard commands and syntax. Graphical user interfaces have since been developed for many of the popular desktop operating systems in use today,^[2][3] including general web design programs like Microsoft Expression Web, and specialist FTP clients such as CuteFTP.

Protocol overview[link]

Differences from HTTP[link]

FTP operates on the application layer of the OSI model, and is used to transfer files using TCP/IP.^[3] To do so, an FTP server has to be running and waiting for incoming requests.^[3] The client computer is then able to communicate with the server on port 21.^[3][4] This connection, called the control connection,^[5] remains open for the duration of the session. A second connection, called the data connection,^[2][5] can either be opened by the server from its port 20 to a negotiated client port (active mode), or by the client from an arbitrary port to a negotiated server port (passive mode) as required to transfer file data.^[2][4] The control connection is used for session administration, for example commands, identification and passwords exchanged between the client and the server using a telnet-like protocol.^[6] For example "RETR filename" would transfer the specified file from the server to the client. Due to this two-port structure, FTP is considered an out-of-band protocol, as opposed to an in-band protocol such as HTTP.^[6]

Communication and data transfer[link]

The protocol is specified in RFC 959,^[2] which is summarized here.^[7]

The server responds over the control connection with three-digit status codes in ASCII with an optional text message. For example "200" (or "200 OK") means that the last command was successful. The numbers represent the code for the response and the optional text represents a human-readable explanation or request (e.g. <Need account for storing file>).^[1] An ongoing transfer of file data over the data connection can be aborted using an interrupt message sent over the control connection.

Illustration of starting a passive connection using port 21

FTP may run in active or passive mode, which determines how the data connection is established.^[5] In active mode, the client creates a TCP control connection to the server and sends the server the client's IP address and an arbitrary client port number, and then waits until the server initiates the data connection over TCP to that client IP address and client port number.^[4] In situations where the client is behind a firewall and unable to accept incoming TCP connections, passive mode may be used. In this mode, the client uses the control connection to send a PASV command to the server and then receives a server IP address and server port number from the server,^[4][5] which the client then uses to open a data connection from an arbitrary client port to the server IP address and server port number received.^[7] Both modes were updated in September 1998 to support IPv6. Further changes were introduced to the passive mode at that time, updating it to extended passive mode.^[8]

While transferring data over the network, four data representations can be used:^[2][3][9]

• ASCII mode: used for text. Data is converted, if needed, from the sending host's character representation to "8-bit ASCII" before transmission, and (again, if necessary) to the receiving host's character representation. As a consequence, this mode is inappropriate for files that contain data other than plain text.
• Image mode (commonly called Binary mode): the sending machine sends each file byte for byte, and the recipient stores the bytestream as it receives it. (Image mode support has been recommended for all implementations of FTP).
• EBCDIC mode: use for plain text between hosts using the EBCDIC character set. This mode is otherwise like ASCII mode.
• Local mode: Allows two computers with identical setups to send data in a proprietary format without the need to convert it to ASCII

For text files, different format control and record structure options are provided. These features were designed to facilitate files containing Telnet or ASA formatting.

Data transfer can be done in any of three modes:^[1][2]

• Stream mode: Data is sent as a continuous stream, relieving FTP from doing any processing. Rather, all processing is left up to TCP. No End-of-file indicator is needed, unless the data is divided into records.
• Block mode: FTP breaks the data into several blocks (block header, byte count, and data field) and then passes it on to TCP.^[9]
• Compressed mode: Data is compressed using a single algorithm (usually run-length encoding).

Login[link]

FTP login utilizes a normal usernames and password scheme for granting access.^[2] The username is sent to the server using the USER command, and the password is sent using the PASS command.^[2] If the information provided by the client is accepted by the server, the server will send a greeting to the client and the session will commence.^[2] If the server supports it, users may log in without providing login credentials, but the server may authorize only limited access for such sessions.^[2]

Anonymous FTP[link]

A host that provides an FTP service may provide anonymous FTP access.^[2] Users typically log into the service with an 'anonymous' (lower-case and case-sensitive in some FTP servers) account when prompted for user name. Although users are commonly asked to send their email address in lieu of a password,^[3] no verification is actually performed on the supplied data.^[10] Many FTP hosts whose purpose is to provide software updates will provide anonymous logins.^[3]

NAT and firewall traversal[link]

FTP normally transfers data by having the server connect back to the client, after the PORT command is sent by the client. This is problematic for both NATs and firewalls, which do not allow connections from the Internet towards internal hosts.^[11] For NATs, an additional complication is that the representation of the IP addresses and port number in the PORT command refer to the internal host's IP address and port, rather than the public IP address and port of the NAT.

There are two approaches to this problem. One is that the FTP client and FTP server use the PASV command, which causes the data connection to be established from the FTP client to the server.^[11] This is widely used by modern FTP clients. Another approach is for the NAT to alter the values of the PORT command, using an application-level gateway for this purpose.^[11]

Web browser support[link]

Most common web browsers can retrieve files hosted on FTP servers, although they may not support protocol extensions such as FTPS.^[3][12] When an FTP—rather than an HTTP—URL is supplied, the accessible contents on the remote server are presented in a manner that is similar to that used for other Web content. A full-featured FTP client can be run within Firefox in the form of an extension called FireFTP

Syntax[link]

FTP URL syntax is described in RFC1738,^[13] taking the form: ftp://[<user>[:<password>]@]<host>[:<port>]/<url-path>^[13] (The bracketed parts are optional.) For example:

ftp://public.ftp-servers.example.com/mydirectory/myfile.txt

or:

ftp://user001:secretpassword@private.ftp-servers.example.com/mydirectory/myfile.txt

More details on specifying a username and password may be found in the browsers' documentation, such as, for example, Firefox ^[14] and Internet Explorer.^[15] By default, most web browsers use passive (PASV) mode, which more easily traverses end-user firewalls.

Security[link]

FTP was not designed to be a secure protocol—especially by today's standards—and has many security weaknesses.^[16] In May 1999, the authors of RFC 2577 listed a vulnerability to the following problems:^[17]

• Bounce attacks
• Spoof attacks
• Brute force attacks
• Packet capture (sniffing)
• Username protection
• Port stealing

FTP is not able to encrypt its traffic; all transmissions are in clear text, and usernames, passwords, commands and data can be easily read by anyone able to perform packet capture (sniffing) on the network.^[2][16] This problem is common to many of the Internet Protocol specifications (such as SMTP, Telnet, POP and IMAP) that were designed prior to the creation of encryption mechanisms such as TLS or SSL.^[9] A common solution to this problem is to use the "secure", TLS-protected versions of the insecure protocols (e.g. FTPS for FTP, TelnetS for Telnet, etc.) or a different, more secure protocol that can handle the job, such as the SFTP/SCP tools included with most implementations of the Secure Shell protocol.

Secure FTP[link]

There are several methods of securely transferring files that have been called "Secure FTP" at one point or another.

FTPS[link]

Explicit FTPS is an extension to the FTP standard that allows clients to request that the FTP session be encrypted. This is done by sending the "AUTH TLS" command. The server has the option of allowing or denying connections that do not request TLS. This protocol extension is defined in the proposed standard: RFC 4217. Implicit FTPS is a deprecated standard for FTP that required the use of a SSL or TLS connection. It was specified to use different ports than plain FTP.

SFTP[link]

SFTP, the "SSH File Transfer Protocol," is not related to FTP except that it also transfers files and has a similar command set for users. SFTP, or secure FTP, is a program that uses Secure Shell (SSH) to transfer files. Unlike standard FTP, it encrypts both commands and data, preventing passwords and sensitive information from being transmitted openly over the network. It is functionally similar to FTP, but because it uses a different protocol, standard FTP clients cannot be used to talk to an SFTP server, nor can one connect to an FTP server with a client that supports only SFTP.

FTP over SSH (not SFTP)[link]

FTP over SSH (not SFTP) refers to the practice of tunneling a normal FTP session over an SSH connection.^[16] Because FTP uses multiple TCP connections (unusual for a TCP/IP protocol that is still in use), it is particularly difficult to tunnel over SSH. With many SSH clients, attempting to set up a tunnel for the control channel (the initial client-to-server connection on port 21) will protect only that channel; when data is transferred, the FTP software at either end will set up new TCP connections (data channels), which bypass the SSH connection and thus have no confidentiality or integrity protection, etc.

Otherwise, it is necessary for the SSH client software to have specific knowledge of the FTP protocol, to monitor and rewrite FTP control channel messages and autonomously open new packet forwardings for FTP data channels. Software packages that support this mode are:

• Tectia ConnectSecure (Win/Linux/Unix) of SSH Communications Security's software suite
• Tectia Server for IBM z/OS of SSH Communications Security's software suite
• FONC (the GPL licensed)
• Co:Z FTPSSH Proxy

FTP over SSH is sometimes referred to as secure FTP; this should not be confused with other methods of securing FTP, such as SSL/TLS (FTPS). Other methods of transferring files using SSH that are not related to FTP include SFTP and SCP; in each of these, the entire conversation (credentials and data) is always protected by the SSH protocol.

List of FTP commands[link]

Below is a list of FTP commands that may be sent to an FTP server, including all commands that are standardized in RFC 959 by the IETF. All commands below are RFC 959-based unless stated otherwise. Note that most command-line FTP clients present their own set of commands to users. For example, GET is the common user command to download a file instead of the raw command RETR.

FTP reply codes[link]

Below is a summary of the reply codes that may be returned by an FTP server. These codes have been standardized in RFC 959 by the IETF. As stated earlier in this article, the reply code is a three-digit value. The first digit is used to indicate one of three possible outcomes—success, failure or to indicate an error or incomplete reply:

• 2xx – Success reply
• 4xx or 5xx – Failure Reply
• 1xx or 3xx – Error or Incomplete reply

The second digit defines the kind of error:

• x0z – Syntax. These replies refer to syntax errors.
• x1z – Information. Replies to requests for information.
• x2z – Connections. Replies referring to the control and data connections.
• x3z – Authentication and accounting. Replies for the login process and accounting procedures.
• x4z – Not defined.
• x5z – File system. These replies relay status codes from the server file system.

The third digit of the reply code is used to provide additional detail for each of the categories defined by the second digit.

See also[link]

• Comparison of FTP client software
• Comparison of FTP server software
• Curl-loader - FTP/S loading/testing open-source SW
• File eXchange Protocol (FXP)
• File Service Protocol (FSP)
• FTAM
• FTPFS
• List of file transfer protocols
• List of FTP server return codes
• Managed File Transfer
• OBEX
• Shared file access
• TCP Wrapper

References[link]

Further reading[link]

• RFC 959 – (Standard) File Transfer Protocol (FTP). J. Postel, J. Reynolds. October 1985.
• RFC 1579 – (Informational) Firewall-Friendly FTP.
• RFC 2228 – (Proposed Standard) FTP Security Extensions.
• RFC 2389 – (Proposed Standard) Feature negotiation mechanism for the File Transfer Protocol. August 1998.
• RFC 2428 – (Proposed Standard) Extensions for IPv6, NAT, and Extended passive mode. September 1998.
• RFC 2640 – (Proposed Standard) Internationalization of the File Transfer Protocol.
• RFC 3659 – (Proposed Standard) Extensions to FTP. P.Hethmon. March 2007.
• RFC 5797 – (Proposed Standard) FTP Command and Extension Registry. March 2010.
• RFC 697 - CWD Command of FTP
• RFC 1639 - FTP Operation Over Big Address Records (FOOBAR)
• RFC 5797 - FTP Command and Extension Registry

External links[link]

Wikibooks has a book on the topic of Communication Networks/File Transfer Protocol

• FTP Reviewed — a review of the protocol notably from a security standpoint, pintday.org
• Related whitepapers sdsusa.com
• Raw FTP command list, nsftools.com
• FTP Sequence Diagram (in PDF format), eventhelix.com
• FTP Server Connectivity Test, infobyip.com
• IANA FTP Commands and Extensions registry - The official registry of FTP Commands and Extensions
• Basic FTP simulation
• A passive FTP replacement for Microsoft Windows™, passive-ftp.com

A list of notable file transfer protocols:

List of file transfer protocols[link]

[edit] Primarily used with TCP/IP

• 9P
• Apple Filing Protocol (AFP)
• BitTorrent
• FTAM
• FTP
  • FTP over SSL (FTPS)
• HFTP
• HULFT^[1]
• HTTP
  • HTTPS
  • WebDAV
• rcp
• rsync
• Simple Asynchronous File Transfer (SAFT), bound to TCP port 487^[2]
• Secure copy (SCP)
• SSH file transfer protocol (SFTP)
• Simple File Transfer Protocol

[edit] Primarily used with UDP

• Fast and Secure Protocol (FASP)
• File Service Protocol
• Multicast File Transfer Protocol
• Multipurpose Transaction Protocol
• Trivial File Transfer Protocol (TFTP) -- designed for simplicity rather than speed
• Tsunami UDP Protocol
• UDP-based Data Transfer Protocol (UDT)
• UFTP – UDP Based FTP with Multicast

[edit] Primarily used with direct modem connections

• ASCII dump
• BiModem
• CModem
• CompuServe B (aka B protocol or CIS-B)
• JMODEM
• HS/Link

• Kermit and variants:
  • Kermit
  • SuperKermit

• LeechModem
• Lynx (protocol)
• MEGAlink (protocol)
• NMODEM
• Punter family

• SEAlink
• SMODEM
• SuperK
• TELINK
• Tmodem

• UUCP and variants:
  • UUCP
  • UUCP-g

• XMODEM and variants:
  • MODEM7 (Batch XMODEM)
  • XMODEM, XMODEM-1K, XMODEM-G
  • WXMODEM

• YMODEM and variants:
  • YMODEM, YMODEM-1K, YMODEM-G

• ZMax
• ZMODEM

See also[link]

• File transfer
• Protocol (computing)
• Communications protocol
• Bulletin board system
• List of network protocols

References[link]

External links[link]

• Evolution and Selection of File Transfer Protocols by Chuck Forsberg