NFS URL Scheme
RFC 2224

 
Document Type RFC - Informational (October 1997; No errata)
Was draft-callaghan-url-nfs (individual)
Last updated 2013-03-02
Stream Legacy
Formats plain text pdf html
Stream Legacy state (None)
Document shepherd No shepherd assigned
IESG IESG state RFC 2224 (Informational)
Telechat date
Responsible AD (None)
Send notices to (None)

Email authors IPR References Referenced by Nits Search lists

Network Working Group                                        B. Callaghan
Request for Comments: 2224                         Sun Microsystems, Inc.
Category: Informational                                      October 1997

                             NFS URL Scheme

Status of this Memo

   This memo provides information for the Internet community.  It does
   not specify an Internet standard of any kind.  Distribution of this
   memo is unlimited.

Copyright Notice

   Copyright (C) The Internet Society (1997).  All Rights Reserved.

Abstract

   A new URL scheme, 'nfs' is defined.  It is used to refer to files and
   directories on NFS servers using the general URL syntax defined in
   RFC 1738, "Uniform Resource Locators (URL)".

   This scheme uses the public filehandle and multi-component lookup
   [RFC2054, RFC2055] to access server data with a minimum of protocol
   overhead.

   The NFS protocol provides access to shared filesystems across
   networks.  It is designed to be machine, operating system, network
   architecture, and transport protocol independent.  The protocol
   currently exists in two versions: version 2 [RFC1094] and version 3
   [RFC1813], both built on ONC RPC [RFC1831] at its associated eXternal
   Data Representation (XDR) [RFC1832] and Binding Protocol [RFC1833].

Table of Contents

      1.    URL Syntax . . . . . . . . . . . . . . . . . . . . . . .  2
      2.    URL Evaluation . . . . . . . . . . . . . . . . . . . . .  2
      3.    Server Connection  . . . . . . . . . . . . . . . . . . .  2
      4.    NFS Version  . . . . . . . . . . . . . . . . . . . . . .  2
      5.    Public Filehandle  . . . . . . . . . . . . . . . . . . .  3
      5.1     NFS Version 2 Public Filehandle  . . . . . . . . . . .  3
      5.2     NFS Version 3 Public Filehandle  . . . . . . . . . . .  3
      6.    Multi-component Lookup . . . . . . . . . . . . . . . . .  3
      6.1     Absolute vs Relative Pathname  . . . . . . . . . . . .  4
      6.2     Symbolic Links . . . . . . . . . . . . . . . . . . . .  5
      7.    Mount Protocol . . . . . . . . . . . . . . . . . . . . .  6
      8.    Bibliography . . . . . . . . . . . . . . . . . . . . . .  7
      9.    Security Considerations  . . . . . . . . . . . . . . . .  8

Callaghan                    Informational                      [Page 1]
RFC 2224                     NFS URL Scheme                 October 1997

      10.   BNF for NFS URL Scheme . . . . . . . . . . . . . . . . .  9
      11.   Acknowledgements . . . . . . . . . . . . . . . . . . . . 10
      12.   Author's Address . . . . . . . . . . . . . . . . . . . . 10
      13.   Full Copyright Statement . . . . . . . . . . . . . . . . 11

1. URL Syntax

   An NFS URL is based on the Common Internet Scheme Syntax described in
   section 3.1 of RFC 1738.  It has the general form:

        nfs://<host>:<port><url-path>

   The ":<port>" part is optional.  If omitted then port 2049 is
   assumed.  The <url-path> is also optional.

   The <url-path> is a hierarchical directory path of the form
   /<directory>/<directory>/<directory>/.../<name>. The <url-path> must
   consist only of characters within the US-ASCII character set.  Within
   a <directory> or <name> component the character "/" is reserved and
   must be encoded as described in Section 2.2 of RFC 1738.  If <url-
   path> is omitted or consists solely of "/", it must default to the
   path ".".

2. URL Evaluation

   A client must evaluate an NFS URL by a method known as WebNFS
   [RFC2054, RFC2055]. This method provides easy passage through
   firewalls and proxy servers, as well as using a minimum number of
   messages.  The WebNFS method is defined for NFS versions 2 and 3. It
   assumes that the server registers on TCP or UDP port 2049 and
   supports the public filehandle and multi-component lookup semantics
   as described in the following sections.

3. Server Connection

   The client must first attempt to create a TCP connection to <host>
   using the <port> specified.  If :<port> is omitted, then port 2049
   will be used.  If the server refuses the TCP connection, then the
   client will use UDP.

4. NFS Version

   The client must first attempt to use NFS version 3.  If the server
   returns an RPC PROG_MISMATCH error then the client must assume that
   NFS version 3 is not supported, and retry the operation with an NFS
   version 2 public filehandle.

Callaghan                    Informational                      [Page 2]
RFC 2224                     NFS URL Scheme                 October 1997
Show full document text