[Docs] [txt|pdf|xml] [Tracker] [Email] [Diff1] [Diff2] [Nits]

Versions: 00 01 02 03 04 05 06 07 08

Network Working Group                                           A. Bryan
Internet-Draft                                              T. Tsujikawa
Intended status: Standards Track                             D. Stenberg
Expires: November 25, 2012                                  May 24, 2012


          File Transfer Protocol RANG Command for Octet Ranges
                        draft-bryan-ftp-range-06

Abstract

   The File Transfer Protocol offers the REST command to designate a
   starting point for a transfer, but does not currently offer any
   method to specify an end point.  This document specifies a new FTP
   RANG command to be used by clients to designate a start and end point
   to permit restarts and repairs of interrupted data transfers in
   STREAM mode.

Editorial Note (To be removed by RFC Editor)

   Discussion of this draft should take place on the FTPEXT2 working
   group mailing list (ftpext@ietf.org), although this draft is not a WG
   item.  Related documents (including fancy diffs) can be found at
   <http://tools.ietf.org/wg/ftpext2/>.

   The changes in this draft are summarized in Appendix B.

Status of this Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on November 25, 2012.

Copyright Notice

   Copyright (c) 2012 IETF Trust and the persons identified as the
   document authors.  All rights reserved.



Bryan, et al.           Expires November 25, 2012               [Page 1]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.


Table of Contents

   1.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  3
   2.  Document Conventions . . . . . . . . . . . . . . . . . . . . .  3
     2.1.  Basic Tokens . . . . . . . . . . . . . . . . . . . . . . .  4
     2.2.  Server Replies . . . . . . . . . . . . . . . . . . . . . .  4
   3.  octet Ranges in STREAM Mode  . . . . . . . . . . . . . . . . .  4
     3.1.  Error Recovery and Range Requests  . . . . . . . . . . . .  5
   4.  The RANGe Command (RANG) . . . . . . . . . . . . . . . . . . .  6
     4.1.  FEAT Command Response for RANG Command . . . . . . . . . .  8
     4.2.  User-PI usage of RANG  . . . . . . . . . . . . . . . . . .  8
     4.3.  RANG Command Errors  . . . . . . . . . . . . . . . . . . .  9
   5.  RANG Command Use with Other Commands . . . . . . . . . . . . .  9
   6.  IANA Considerations  . . . . . . . . . . . . . . . . . . . . .  9
   7.  Security Considerations  . . . . . . . . . . . . . . . . . . . 10
   8.  References . . . . . . . . . . . . . . . . . . . . . . . . . . 10
     8.1.  Normative References . . . . . . . . . . . . . . . . . . . 10
     8.2.  Informative References . . . . . . . . . . . . . . . . . . 10
   Appendix A.  Acknowledgements and Contributors . . . . . . . . . . 11
   Appendix B.  Document History  . . . . . . . . . . . . . . . . . . 11
   Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 11



















Bryan, et al.           Expires November 25, 2012               [Page 2]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


1.  Introduction

   The File Transfer Protocol offers the REST command [RFC3659] to
   designate a starting point for a transfer, but does not currently
   offer any method to specify an end point.  This document specifies a
   new FTP RANG command to be used by clients to designate a start and
   end point to permit restarts and repairs of interrupted data
   transfers in STREAM mode.

   The current alternatives, without being able to specify an end point,
   are to issue an ABOR command or close the data connection.

   HTTP offers similar functionality with the Range: header field in
   Section 14.35 of [RFC2616], where a specific octet (8 bit byte) range
   can optionally be requested.


2.  Document Conventions

   This specification describes conformance of File Transfer Protocol
   Extension for RANG, a start and end point in a octet range.

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in BCP 14, [RFC2119], as
   scoped to those conformance targets.

   This document also uses notation defined in STD 9, [RFC0959].  In
   particular, the terms or commands "reply", "user", "file", "FTP
   commands", "user-PI" (user protocol interpreter), "server-FTP
   process", "server-PI", "mode", "Image type", "Stream transfer mode",
   "type", "STOR", "RETR", and "ASCII", are all used here as defined
   there.  The command "REST" is used as defined in Section 5 of
   [RFC3659].

   In the examples of FTP dialogs presented in this document, lines that
   begin "C> " were sent over the control connection from the user-PI to
   the server-PI, and lines that begin "S> " were sent over the control
   connection from the server-PI to the user-PI.  In all cases, the
   prefixes shown above, including the one space, have been added for
   the purposes of this document, and are not a part of the data
   exchanged between client and server.

   Syntax required is defined using the Augmented BNF defined in
   [RFC5234].






Bryan, et al.           Expires November 25, 2012               [Page 3]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


2.1.  Basic Tokens

   This document imports the core definitions given in Appendix B of
   [RFC5234].  There definitions will be found for basic ABNF elements
   like ALPHA, DIGIT, SP, etc.  To that, the following term is added for
   use in this document.


      TCHAR = VCHAR / SP / HTAB    ; visible plus white space

   The VCHAR (from [RFC5234]) and TCHAR rules give basic character types
   from varying sub-sets of the ASCII character set for use in various
   commands and responses.

   Note that in ABNF, string literals are case insensitive.  That
   convention is preserved in this document, and implies that FTP
   commands and parameters that are added by this specification have
   values that can be represented in any case.  That is, "RANG" is the
   same as "rang", "Rang", "RaNg", etc., and "ftp.example.com" is the
   same as "Ftp.Example.Com", "fTp.eXample.cOm", etc.

2.2.  Server Replies

   Section 4.2 of [RFC0959] defines the format and meaning of replies by
   the server-PI to FTP commands from the user-PI.  Those reply
   conventions are used here without change.


      error-response = error-code SP *TCHAR CRLF
      error-code     = ("4" / "5") 2DIGIT

   Implementers should note that the ABNF syntax (which was not used in
   [RFC0959]) used in this document, and other FTP related documents,
   sometimes shows replies using the one line format.  Unless otherwise
   explicitly stated, that is not intended to imply that multi-line
   responses are not permitted.  Implementers should assume that, unless
   stated to the contrary, any reply to any FTP command (including QUIT)
   can be of the multi-line format described in [RFC0959].

   Throughout this document, replies will be identified by the three
   digit code that is their first element.  Thus the term "500 reply"
   means a reply from the server-PI using the three digit code "500".


3.  octet Ranges in STREAM Mode

   To get a specific part of a file without sending entire file, both
   sides need some way to agree on where in the data stream to start and



Bryan, et al.           Expires November 25, 2012               [Page 4]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


   end the data transfer.

   In STREAM mode, the data connection contains just a stream of
   unformatted octets of data.  Explicit restart markers thus cannot be
   inserted into the data stream, they would be indistinguishable from
   data.  For this reason, the FTP specification [RFC0959] did not
   provide the ability to do restarts in stream mode.  However, there is
   not really a need to have explicit restart markers in this case, as
   restart markers can be implied by the octet offset into the data
   stream.

   Because the data stream defines the file in STREAM mode, a different
   data stream would represent a different file.  Thus, an offset will
   always represent the same position within a file.  On the other hand,
   in other modes than STREAM, the same file can be transferred using
   quite different octet sequences and yet be reconstructed into the one
   identical file.  Thus an offset into the data stream in transfer
   modes other than STREAM would not give an unambiguous restart or end
   point.

   If the data representation TYPE is IMAGE and the STRUcture is File,
   for many systems the file will be stored exactly in the same format
   as it is sent across the data connection.  It is then usually very
   easy for the receiver to determine how much data was previously
   received, and notify the sender of the offset where the transfer
   should be restarted.  In other representation types and structures
   more effort will be required, but it remains always possible to
   determine the offset with finite, but perhaps non-negligible, effort.
   In the worst case, an FTP process may need to open a data connection
   to itself, set the appropriate transfer type and structure, and
   actually transmit the file, counting the transmitted octets.

   If the user-FTP process is intending to restart a retrieve, it will
   directly calculate the restart marker and send that information in
   the RESTart command.  However, if the user-FTP process is intending
   to restart sending the file, it needs to be able to determine how
   much data was previously sent, and correctly received and saved.  The
   purpose of the SIZE command, as documented in Section 4 of [RFC3659],
   is to get this information.

3.1.  Error Recovery and Range Requests

   STREAM mode transfers with FILE STRUcture may be range requested even
   though no restart marker has been transferred in addition to the data
   itself.  This is done by using the SIZE command, if needed, in
   combination with the RANG command, and one of the standard file
   transfer commands.




Bryan, et al.           Expires November 25, 2012               [Page 5]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


   When using TYPE ASCII or IMAGE, the SIZE command will return the
   number of octets that would actually be transferred if the file were
   to be sent between the two systems, i.e., with type IMAGE, the SIZE
   normally would be the number of octets in the file.  With type ASCII,
   the SIZE would be the number of octets in the file including any
   modifications required to satisfy the TYPE ASCII CR-LF end-of-line
   convention.


4.  The RANGe Command (RANG)

   A new command "RANG" is added to the FTP command set to allow the
   client to specify both a start point octet range and an end point
   octet range of a file from a server-FTP process.

   The syntax for the RANG command when the current transfer mode is
   STREAM is:


      range-command = "RANG" SP start-point SP end-point CRLF
      start-point = 1*DIGIT
      end-point = 1*DIGIT

   [NOTE: end-point is inclusive.]

   <start-point> gives the number of octets of the immediately-following
   transfer to not actually send, effectively causing the transmission
   to be started at a later point.  A value of zero effectively causes
   the transmission to be started at first octet.

   <end-point> gives the number of octets, counted from the beginning of
   the file, of the immediately-following transfer to stop sending at,
   effectively causing the transmission to be ended.  (That is, the end
   point is relative to the start of the file and not relative to the
   start point).  The server-PI will respond to the RANG command with a
   350 reply, indicating that RANG parameters have been saved, and that
   another command, which can be one of the standard file transfer
   commands, should then follow to complete the ranged request.

   To reset the range command, "RANG 1 0" should be issued.  Invalid
   RANG requests where <start-point> is larger than <end-point>
   automatically reset the octet selection to the default, which is the
   whole file.  The server-PI MUST reply with a 350 reply if "RANG 1 0"
   is issued by client-PI because it is a valid way of resetting the
   range.  (The range would also be reset if the session is
   reinitialized with REIN but this terminates the user and resets all
   parameters).




Bryan, et al.           Expires November 25, 2012               [Page 6]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


      range-response = range-ok / error-response
      range-ok       = "350" SP *TCHAR CRLF

   Server-FTP processes may permit transfer commands other than RETR and
   STOR, such as APPE and STOU, to complete a restart or repair;
   however, this is not recommended.  STOU (store unique) is undefined
   in this usage, as storing the remainder of a file into a unique file
   name is rarely going to be useful.  If APPE (append) is permitted, it
   MUST act identically to STOR when a restart marker has been set.
   That is, in both cases, octets from the data connection are placed
   into the file at the location indicated by the restart marker value.

   The RANG command is intended to complete or repair a failed transfer.
   Use with RETR is comparatively well defined in all cases, as the
   client bears the responsibility of merging the retrieved data with
   the partially retrieved file.  It may choose to use the data obtained
   other than to complete an earlier transfer, or to re-retrieve data
   that had been retrieved before.  With STOR, however, the server must
   insert the data into the file named.  The results are undefined if a
   client uses RANG to do other than restart to complete a transfer of a
   file that had previously failed to completely transfer.  In
   particular, if the restart marker set with a RANG command is not at
   the end of the data currently stored at the server, as reported by
   the server, or if insufficient data are provided in a STOR that
   follows a RANG to extend the destination file to at least its
   previous size, then the effects are undefined.

   The RANG command MUST be the last command issued before the data
   transfer command that is to cause a partial data transfer.  The
   effect of issuing a RANG command at any other time is undefined.  The
   server-PI may react to a badly positioned RANG command by issuing an
   error response to the following command, not being a restartable data
   transfer command, or it may save the start-point and/or end-point
   octet range value and apply it to the next data transfer command, or
   it may silently ignore the inappropriate restart attempt.  Because of
   this, a user-PI that has issued a RANG command, but that has not
   successfully transmitted the following data transfer command for any
   reason, should send another RANG command before the next data
   transfer command.  If that transfer is not to be restarted, then
   "RANG 1 0" should be issued.

   An error response will follow a RANG command only when the server
   does not implement the command, or when command syntax is invalid.
   Any other errors, including such problems as start-point and/or end-
   point octet range out of range, should be reported when the following
   transfer command is issued.  Such errors will cause that transfer
   request to be rejected with an error indicating the invalid restart
   attempt.



Bryan, et al.           Expires November 25, 2012               [Page 7]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


   The server-PI SHOULD transfer 0 octets with RETR if the specified
   start point or start point and end point are larger than the actual
   file size.

   The server-PI SHOULD transfer the whole range from the start point to
   the end point with RETR if the end point is larger than the actual
   file.

4.1.  FEAT Command Response for RANG Command

   When replying to the FEAT command [RFC2389], a server-FTP process
   that supports the RANG command, as specified here, MUST include, a
   line containing exactly the string "RANG STREAM".  This string is
   case insensitive, and MAY be sent in any mixture of upper or lower
   case, however it SHOULD be sent in upper case.  That is, the response
   SHOULD be:


      C> FEAT
      S> 211-Extensions supported:
      S>  ...
      S>  RANG STREAM
      S>  ...
      S> 211 END

   The ellipses indicate place holders where other features may be
   included, and are not required.  The one-space indentation of the
   feature lines is mandatory [RFC2389].


      range-feat = SP "RANG" SP "STREAM" CRLF

4.2.  User-PI usage of RANG

   The user-PI issues the FEAT command to query the server-PI if it
   supports the RANG command.  In this example, the server-PI also
   supports REST.


      C> FEAT
      S> 211-Extensions supported:
      S>  ...
      S>  REST STREAM
      S>  RANG STREAM
      S>  ...
      S> 211 END

   Assume that the transfer of a largish file has previously been



Bryan, et al.           Expires November 25, 2012               [Page 8]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


   interrupted after 802816 octets had been received, that the transfer
   should stop at octet 1000000 of the file, that the previous transfer
   was with TYPE=I, and that it has been verified that the file on the
   server has not since changed.


      C> TYPE I
      S> 200 Type set to I.
      C> PORT 127,0,0,1,15,107
      S> 200 PORT command successful.
      C> RANG 802816 1000000
      S> 350 Restarting at 802816. End Byte range at 1000000.
      C> RETR cap60.pl198.tar
      S> 150 Opening BINARY mode data connection
      [...]
      S> 226 Transfer complete.

   In the above example, data is sent from offset 802816 to, and
   including, offset 1000000.

4.3.  RANG Command Errors

   Where the RANG command is unrecognized or there is a syntax error in
   parameters or arguments, a 500 or 501 reply can be sent by the
   server-PI, as specified in [RFC0959].

   The server-PI SHOULD reply with a 551 reply if the server-PI is not
   configured to use TYPE I and MODE S.

   The server-PI SHOULD reply with a 552 reply if the user is not
   allowed to use the RANG command.


5.  RANG Command Use with Other Commands

   This specification defines the use of RANG in a certain way.  Other
   commands could decide to use RANG in a similar way, to select a octet
   range, and their specification would define how they operate with
   RANG.  The HASH command [draft-bryan-ftpext-hash] uses RANG to select
   a octet range for partial file hashing.


6.  IANA Considerations

   This new command is added to the "FTP Commands and Extensions"
   registry created by [RFC5797].

   Command Name: RANG



Bryan, et al.           Expires November 25, 2012               [Page 9]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


   Description: End point octet range (for STREAM mode).

   FEAT String: RANG STREAM

   Command Type: Service execution/parameter setting

   Conformance Requirements: Optional

   Reference: This specification


7.  Security Considerations

   This memo does not directly concern security.  It is not believed
   that any of the mechanisms documented here impact in any particular
   way upon the security of FTP.


8.  References

8.1.  Normative References

   [RFC0959]  Postel, J. and J. Reynolds, "File Transfer Protocol",
              STD 9, RFC 0959, October 1985.

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119, March 1997.

   [RFC2389]  Hethmon, P. and R. Elz, "Feature negotiation mechanism for
              the File Transfer Protocol", RFC 2389, August 1998.

   [RFC3659]  Hethmon, P., "Extensions to FTP", RFC 3659, March 2007.

   [RFC5234]  Crocker, D. and P. Overell, "Augmented BNF for Syntax
              Specifications: ABNF", STD 68, RFC 5234, January 2008.

8.2.  Informative References

   [RFC2616]  Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
              Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
              Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.

   [RFC5797]  Klensin, J. and A. Hoenes, "FTP Command and Extension
              Registry", RFC 5797, March 2010.

   [draft-bryan-ftpext-hash]
              Bryan, A., Kosse, T., and D. Stenberg, "FTP Extensions for
              Cryptographic Hashes", draft-bryan-ftpext-hash-00 (work in



Bryan, et al.           Expires November 25, 2012              [Page 10]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


              progress).


Appendix A.  Acknowledgements and Contributors

   Thanks to the FTPEXT2 Working Group and Kamil Dudka.

   Portions of [RFC3659] were wholly reused in this document.


Appendix B.  Document History

   [[ to be removed by the RFC editor before publication as an RFC. ]]

   Known issues concerning this draft:
   o  None

   draft-bryan-ftp-range-05 : April 6, 2012.
   o  FTPEXT2 WG concluded, HASH draft renamed.

   draft-bryan-ftp-range-04 : March 27, 2012.
   o  Editorial nits.

   draft-bryan-ftp-range-03 : March 14, 2011.
   o  Refinements.

   draft-bryan-ftp-range-02 : February 1, 2011.
   o  Refinements.

   draft-bryan-ftp-range-01 : January 25, 2011.
   o  Refinements.  "RANG 1 0" resets octet selection.

   draft-bryan-ftp-range-00 : December 13, 2010.
   o  Initial draft.


Authors' Addresses

   Anthony Bryan
   Pompano Beach, FL
   USA

   Email: anthonybryan@gmail.com
   URI:   http://www.metalinker.org







Bryan, et al.           Expires November 25, 2012              [Page 11]


Internet-Draft      FTP RANG Command for Octet Ranges           May 2012


   Tatsuhiro Tsujikawa
   Shiga
   Japan

   Email: tatsuhiro.t@gmail.com
   URI:   http://aria2.sourceforge.net


   Daniel Stenberg

   Email: daniel@haxx.se
   URI:   http://www.haxx.se/







































Bryan, et al.           Expires November 25, 2012              [Page 12]


Html markup produced by rfcmarkup 1.122, available from https://tools.ietf.org/tools/rfcmarkup/