view Side-By-Side changes
Network Working Group T. Berners-Lee Internet-Draft MIT/LCS Updates: 1738 (if approved) R. Fielding Obsoletes: 2732, 2396, 1808 (if approved) Day SoftwareExpires: September 1, 2003L. Masinter Expires: November 21, 2003 AdobeMarch 3,May 23, 2003 Uniform Resource Identifier (URI): Generic Syntaxdraft-fielding-uri-rfc2396bis-01draft-fielding-uri-rfc2396bis-02 Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. 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." The list of current Internet-Drafts can be accessed athttp://www.ietf.org/ietf/1id-abstracts.txt.<http://www.ietf.org/ietf/1id-abstracts.txt>. The list of Internet-Draft Shadow Directories can be accessed athttp://www.ietf.org/shadow.html. This Internet-Draft will expire on September 1, 2003.<http://www.ietf.org/shadow.html>. Copyright Notice Copyright (C) The Internet Society (2003). All Rights Reserved. Abstract A Uniform Resource Identifier (URI) is a compact string of characters for identifying an abstract or physical resource. This document defines the generic syntax of a URI, including both absolute and relative forms, and guidelines for their use. This document defines a grammar that is a superset of all valid URIs, such that an implementation can parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier type. This document does not define a generativeBerners-Lee, et al. Expires September 1, 2003 [Page 1] Internet-Draft URI Generic Syntax March 2003grammar for all URIs; that task will be performed by the individual specifications of each URI scheme. Berners-Lee, et al. Expires November 21, 2003 [Page 1] Internet-Draft URI Generic Syntax May 2003 Editorial Note Discussion of this draft and comments to the editors should be sent to the uri@w3.org mailing list. An issues list and version history is available at<http://www.apache.org/~fielding/uri/rev-2002/>.<http://www.apache.org/~fielding/uri/rev-2002/ issues.html>. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 1.1 Overview of URIs . . . . . . . . . . . . . . . . . . . . . . 41.2 URI, URL, and URN1.1.1 Generic Syntax . . . . . . . . . . . . . . . . . . . . . . . 51.3 Example URIs1.1.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 61.4 Hierarchical URIs1.1.3 URI, URL, andRelative FormsURN . . . . . . . . . . . .6 1.5 URI Transcribability. . . . . . . . . 6 1.2 Design Considerations . . . . . . . . . . .7 1.6 Syntax Notation and Common Elements. . . . . . . . 6 1.2.1 Transcription . . . .8 2. URI Characters and Escape Sequences. . . . . . . . . . . .9 2.1 URIs and non-ASCII characters. . . . . . . 6 1.2.2 Separating Identification from Interaction . . . . . . . .9 2.2 Reserved Characters. 7 1.2.3 Hierarchical Identifiers . . . . . . . . . . . . . . . . . . 9 1.3 Syntax Notation .10 2.3 Unreserved Characters. . . . . . . . . . . . . . . . . . .11 2.4 Escape Sequences. . 9 2. Characters . . . . . . . . . . . . . . . . . . . .11 2.4.1 Escaped Encoding. . . . . 10 2.1 Encoding of Characters . . . . . . . . . . . . . . . . .11 2.4.2 When to Escape and Unescape. . 10 2.2 Reserved Characters . . . . . . . . . . . . . .11 2.4.3 Excluded US-ASCII Characters. . . . . . 10 2.3 Unreserved Characters . . . . . . . . . .12 3. URI Syntactic Components. . . . . . . . . 11 2.4 Escaped Characters . . . . . . . . .14 3.1 Scheme Component. . . . . . . . . . . . 12 2.4.1 Escaped Encoding . . . . . . . . . .15 3.2 Authority Component. . . . . . . . . . . . 12 2.4.2 When to Escape and Unescape . . . . . . . .15 3.2.1 Registry-based Naming Authority. . . . . . . . 12 2.5 Excluded Characters . . . . . .16 3.2.2 Server-based Naming Authority. . . . . . . . . . . . . . 13 3. Syntax Components .16 3.3 Path Component. . . . . . . . . . . . . . . . . . . . 15 3.1 Scheme . . .18 3.4 Query Component. . . . . . . . . . . . . . . . . . . . . .19 4. URI References. . 15 3.2 Authority . . . . . . . . . . . . . . . . . . . . .20 4.1 Fragment Identifier. . . . 16 3.2.1 User Information . . . . . . . . . . . . . . . .20 4.2 Same-document References. . . . . . 16 3.2.2 Host . . . . . . . . . . . .21 4.3 Parsing a URI Reference. . . . . . . . . . . . . . . . 17 3.2.3 Port . .21 5. Relative URI References. . . . . . . . . . . . . . . . . .22 5.1 Establishing a Base URI. . . . . . . . 18 3.3 Path . . . . . . . . . .23 5.1.1 Base URI within Document Content. . . . . . . . . . . . . .24 5.1.2 Base URI from the Encapsulating Entity. . . . 19 3.4 Query . . . . . . .24 5.1.3 Base URI from the Retrieval URI. . . . . . . . . . . . . .25 5.1.4 Default Base URI. . . . . . 20 3.5 Fragment . . . . . . . . . . . . . . . .25 5.2 Resolving Relative References to Absolute Form. . . . . . .25 6. URI Normalization and Comparison. . . 20 4. Usage . . . . . . . . . . .29 6.1 URI Equivalence. . . . . . . . . . . . . . . . 22 4.1 URI Reference . . . . . .29 6.2 Comparison Ladder. . . . . . . . . . . . . . . . . 22 4.2 Relative URI . . . .29 6.2.1 Simple String Comparison. . . . . . . . . . . . . . . . . .30 Berners-Lee, et al. Expires September 1, 2003 [Page 2] Internet-Draft URI Generic Syntax March 2003 6.2.2 Syntax-based Normalization. . 22 4.3 Absolute URI . . . . . . . . . . . . . . .31 6.2.3 Scheme-based Normalization. . . . . . . . . 23 4.4 Same-document Reference . . . . . . . .32 6.2.4 Protocol-based Normalization. . . . . . . . . . 23 4.5 Suffix Reference . . . . . .32 6.3 Good Practice When Using URIs. . . . . . . . . . . . . . .32 7. Security Considerations. 23 5. Relative Resolution . . . . . . . . . . . . . . . . .34 7.1 Reliability and Consistency. . . 25 5.1 Establishing a Base URI . . . . . . . . . . . . .34 7.2 Malicious Construction. . . . . 25 5.1.1 Base URI within Document Content . . . . . . . . . . . . . .34 7.3 Rare IP Address Formats26 5.1.2 Base URI from the Encapsulating Entity . . . . . . . . . . . 26 5.1.3 Base URI from the Retrieval URI . . . . . . .35 7.4 Sensitive Information. . . . . . . 27 5.1.4 Default Base URI . . . . . . . . . . . .35 7.5 Semantic Attacks. . . . . . . . . . 27 Berners-Lee, et al. Expires November 21, 2003 [Page 2] Internet-Draft URI Generic Syntax May 2003 5.2 Obtaining the Referenced URI . . . . . . . . . . . .36 8. Acknowledgements. . . . 27 5.3 Recomposition of a Parsed URI . . . . . . . . . . . . . . . 29 5.4 Examples of Relative Resolution . . .37 Normative References. . . . . . . . . . . 30 5.4.1 Normal Examples . . . . . . . . .38 Non-normative References. . . . . . . . . . . . . 30 5.4.2 Abnormal Examples . . . . .39 Authors' Addresses. . . . . . . . . . . . . . . . 31 6. Normalization and Comparison . . . . .40 A. Collected BNF for URI. . . . . . . . . . . 33 6.1 Equivalence . . . . . . . .42 B. Parsing a URI Reference with a Regular Expression. . . . .43 C. Examples of Resolving Relative URI References. . . . . . .44 C.1 Normal Examples. . . . 33 6.2 Comparison Ladder . . . . . . . . . . . . . . . . . .44 C.2 Abnormal Examples. . . 33 6.2.1 Simple String Comparison . . . . . . . . . . . . . . . . . .44 D. Embedding the Base URI in HTML documents34 6.2.2 Syntax-based Normalization . . . . . . . . . .46 E. Recommendations for Delimiting URI in Context. . . . . . .47 F. Abbreviated URIs35 6.2.3 Scheme-based Normalization . . . . . . . . . . . . . . . . . 36 6.2.4 Protocol-based Normalization . . . . .49 G. Summary of Non-editorial Changes. . . . . . . . . . . 36 6.3 Canonical Form . . .50 G.1 Additions. . . . . . . . . . . . . . . . . . . . 36 7. Security Considerations . . . . .50 G.2 Modifications from RFC 2396. . . . . . . . . . . . . 38 7.1 Reliability and Consistency . . .50 Index. . . . . . . . . . . . . 38 7.2 Malicious Construction . . . . . . . . . . . . . .52 Intellectual Property and Copyright Statements. . . . . 38 7.3 Rare IP Address Formats . .55 Berners-Lee, et al. Expires September 1, 2003 [Page 3] Internet-Draft URI Generic Syntax March 2003 1. Introduction A Uniform Resource Identifier (URI) provides a simple and extensible means. . . . . . . . . . . . . . . . 39 7.4 Sensitive Information . . . . . . . . . . . . . . . . . . . 39 7.5 Semantic Attacks . . . . . . . . . . . . . . . . . . . . . . 39 8. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . 41 Normative References . . . . . . . . . . . . . . . . . . . . 42 Informative References . . . . . . . . . . . . . . . . . . . 43 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 45 A. Collected ABNF foridentifyingURI . . . . . . . . . . . . . . . . . . . 46 B. Parsing aresource. This specification ofURIsyntax and semantics is derived from concepts introduced byReference with a Regular Expression . . . . . 47 C. Embedding the Base URI in HTML documents . . . . . . . . . . 48 D. Delimiting a URI in Context . . . . . . . . . . . . . . . . 49 E. Summary of Non-editorial Changes . . . . . . . . . . . . . . 51 E.1 Additions . . . . . . . . . . . . . . . . . . . . . . . . . 51 E.2 Modifications from RFC 2396 . . . . . . . . . . . . . . . . 51 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Intellectual Property and Copyright Statements . . . . . . . 57 Berners-Lee, et al. Expires November 21, 2003 [Page 3] Internet-Draft URI Generic Syntax May 2003 1. Introduction A Uniform Resource Identifier (URI) provides a simple and extensible means for identifying a resource. This specification of URI syntax and semantics is derived from concepts introduced by the World Wide Web global information initiative, whose use of suchobjectsidentifiers dates from 1990 and is described in "Universal Resource Identifiers in WWW" [RFC1630], and is designed to meet the recommendations laid out in "Functional Recommendations for Internet Resource Locators" [RFC1736] and "Functional Requirements for Uniform Resource Names" [RFC1737]. This document obsoletes [RFC2396], which merged "Uniform Resource Locators" [RFC1738] and "Relative Uniform Resource Locators" [RFC1808] in order to define a single, generic syntax for all URIs. It excludes those portions of RFC 1738 that defined the specific syntax of individual URI schemes; those portions will be updated as separate documents. The process for registration of new URI schemes is defined separately by [RFC2717]. All significant changes from RFC 2396 are noted in Appendix G. 1.1 Overview of URIs URIs are characterizedby the following definitions:as follows: Uniform Uniformity provides several benefits: it allows different types of resource identifiers to be used in the same context, even when the mechanisms used to access those resources may differ; it allows uniform semantic interpretation of common syntactic conventions across different types of resource identifiers; it allows introduction of new types of resource identifiers without interfering with the way that existing identifiers are used; and, it allows the identifiers to be reused in many different contexts, thus permitting new applications or protocols to leverage a pre-existing, large, and widely-used set of resource identifiers. ResourceA resourceAnything that can beanything that has identity.named or described can be a resource. Familiar examples include an electronic document, an image, a service (e.g., "today's weather report for Los Angeles"), and a collection of other resources.Not all resources are network "retrievable";A resource is not necessarily accessible via the Internet; e.g., human beings, corporations, and bound books in a library can also beconsideredresources.The resource isLikewise, abstract concepts can be resources, such as theconceptual mapping to an entity or setoperators and operands of a Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page 4] Internet-Draft URI Generic SyntaxMarchMay 2003entities, not necessarilymathematical equation or theentity which corresponds to that mapping at any particular instance in time. Thus, a resource can remain constant even when its content---the entities to which it currently corresponds---changes over time, provided that the conceptual mapping is not changed in the process.types of a relationship (e.g., "parent" or "employee"). Identifier An identifier embodies the information required to distinguish what is being identified from all other things within its scope of identification. A URI is anobject that can act as a reference to somethingidentifier thathas identity. In the caseconsists of aURI, the object is asequence of characterswith a restricted syntax. Having identified a resource, a system may perform a variety of operations onmatching theresource, as might be characterizedrestricted syntax defined bysuch words as `access', `update', `replace', or `find attributes'. 1.2 URI, URL, and URNthis specification. A URI can befurther classified asused to refer to alocator,resource. This specification does not place any limits on the nature of aname,resource orboth. The term "Uniform Resource Locator" (URL) refers tothesubset of URIs that, in additionreasons why an application might wish to refer toidentifying the resource, provideameansresource. URIs have a global scope and should be interpreted consistently regardless oflocatingcontext, but that interpretation may be defined in relation to theresource by describing its primary access mechanismuser's context (e.g.,its network "location"). The term "Uniform Resource Name" (URN)"http://localhost/" refers tothe subset of URIsa resource thatare requiredis relative toremain globally unique and persistent even whentheresource ceases to exist or becomes unavailable. An individual scheme doesuser's network interface and yet notneedspecific tobe cast intoany oneof a discrete set of URI types such as "URL", "URN", "URC", etc. Any givenuser). 1.1.1 Generic Syntax Each URIscheme may define subspaces that have the characteristics ofbegins with a scheme name, as defined in Section 3.1, that refers to alocator, or both, often depending on the persistence and care in the assignment ofspecification for assigning identifiersby the naming authority, rather than on any quality of the URI scheme. Forwithin thatreason, this specification deprecates use of the terms URL or URN to distinguish between schemes, instead usingscheme. As such, theterm URI throughout. EachURIscheme (Section 3.1) defines the namespace of the URI,syntax is a federated andthusextensible naming system wherein each scheme's specification may further restrict the syntax and semantics of identifiers using that scheme. This specification defines those elements of the URI syntax that areeitherrequired of all URI schemes or are common to many URI schemes. It thus defines the syntax and semantics that are needed to implement a scheme-independent parsing mechanism for URI references, such that the scheme-dependent handling of a URI can be postponed until the scheme-dependent semantics are needed.Although many URI schemes are named after protocols, this does not implyLikewise, protocols and data formats that make use ofsuch aURIwill result in accessreferences can refer to this specification as defining theresource via the named protocol. URIs are often used in contexts that are Berners-Lee, et al. Expires September 1, 2003 [Page 5] Internet-Draft URI Generic Syntax March 2003 purely for identification, just like any other identifier. Even when a URI is used to obtain a representationrange ofa resource, that access might be through gateways, proxies, caches, and name resolution servicessyntax allowed for all URIs, including those schemes thatare independent of the protocol of the resource origin, and the resolution of some URIs may require the use of more than one protocol (e.g., both DNS and HTTP are typically usedhave yet toaccess an "http" URI's resource when it can'tbefound in a local cache).defined. A parser of the generic URI syntax is capable of parsing any URI reference into its major components; once the scheme is determined, further scheme-specific parsing can be performed on the components. In other words, the URI generic syntax is a superset of the syntax of all URI schemes.1.3 Example URIsBerners-Lee, et al. Expires November 21, 2003 [Page 5] Internet-Draft URI Generic Syntax May 2003 1.1.2 Examples The following examples illustrate URIs that are in common use. ftp://ftp.is.co.za/rfc/rfc1808.txt -- ftp scheme for File Transfer Protocol services gopher://gopher.tc.umn.edu:70/11/Mailing%20Lists/ -- gopher scheme for Gopher and Gopher+ Protocol services http://www.ietf.org/rfc/rfc2396.txt -- http scheme for Hypertext Transfer Protocol services mailto:John.Doe@example.com -- mailto scheme for electronic mail addresses news:comp.infosystems.www.servers.unix -- news scheme for USENET news groups and articles telnet://melvyl.ucop.edu/ -- telnet scheme for interactive TELNET services1.4 Hierarchical URIs1.1.3 URI, URL, andRelative Forms An absolute identifier refers toURN A URI can be further classified as aresource independent of the context in which the identifier is used. In contrast,locator, arelative identifiername, or both. The term "Uniform Resource Locator" (URL) refers toa resource by describing the difference within a hierarchical namespace betweenthecurrent context and an absolute identifiersubset of URIs that, in addition to identifying theresource. Some URI schemes supportresource, provide ahierarchical naming system, where the hierarchymeans of locating thename is denotedresource bya "/" delimiter separating the components indescribing its primary access mechanism (e.g., its network "location"). The term "Uniform Resource Name" (URN) refers to thescheme. This document defines a scheme-independent Berners-Lee, et al. Expires September 1, 2003 [Page 6] Internet-Draft URI Generic Syntax March 2003 `relative' formsubset ofURI referenceURIs thatcanare required to remain globally unique and persistent even when the resource ceases to exist or becomes unavailable. An individual scheme does not need to beused in conjunction with a `base' URIclassified as being just one ofa hierarchical"name" or "locator". Instances of URIs from any given schemeto producemay have the`absolute' URI formcharacteristics of names or locators or both, often depending on thereference. The syntax of a hierarchical URI is describedpersistence and care inSection 3;therelative URI calculation is describedassignment of identifiers by the naming authority, rather than any quality of the scheme. This specification deprecates use of the term "URN" for anything but URIs inSection 5. 1.5 URI Transcribabilitythe "urn" scheme [RFC2141]. This specification also deprecates the term "URL". 1.2 Design Considerations 1.2.1 Transcription The URI syntaxwashas been designed with globaltranscribabilitytranscription as one of Berners-Lee, et al. Expires November 21, 2003 [Page 6] Internet-Draft URI Generic Syntax May 2003 its mainconcerns.considerations. A URI is a sequence of characters from a very limitedset, i.e.set: the letters of the basic Latin alphabet, digits, and a few special characters. A URI may be represented in a variety of ways: e.g., ink on paper, pixels on a screen, or a sequence of octets in a coded character set. The interpretation of a URI depends only on the characters used and not how those characters are represented in a network protocol. The goal oftranscribabilitytranscription can be described by a simple scenario. Imagine two colleagues, Sam and Kim, sitting in a pub at an international conference and exchanging research ideas. Sam asks Kim for a location to get more information, so Kim writes the URI for the research site on a napkin. Upon returning home, Sam takes out the napkin and types the URI into a computer, which then retrieves the information to which Kim referred. There are several designconcernsconsiderations revealed by the scenario: o A URI is a sequence ofcharacters, whichcharacters that is not always represented as a sequence of octets. o A URImaymight be transcribed from a non-network source, and thus should consist of characters that are most likely to be able to betypedentered into a computer, within the constraints imposed by keyboards (and related input devices) across languages and locales. o A URI often needs to be remembered by people, and it is easier for people to remember a URI when it consists of meaningful or familiar components. These designconcernsconsiderations are not always in alignment. For example, it is often the case that the most meaningful name for a URI component would require characters that cannot be typed into some systems. The ability to transcribethea resource identifier from one medium to anotherwashas been considered more important than havingitsa URI consist of the most meaningful of components. In localandor regional contexts and with improving technology, users might benefit from being able to use a wider range of characters; such use is not defined in this document.Berners-Lee,1.2.2 Separating Identification from Interaction A common misunderstanding of URIs is that they are only used to refer to accessible resources. In fact, the URI alone only provides identification; access to the resource is neither guaranteed nor implied by the presence of a URI. Instead, an operation (if any) associated with a URI reference is defined by the protocol element, Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page 7] Internet-Draft URI Generic SyntaxMarchMay 20031.6 Syntax Notation and Common Elements This document uses two conventionsdata format attribute, or natural language text in which it appears. Given a URI, a system may attempt todescribe and define the syntax for URI. The first, called the layout form, isperform ageneral descriptionvariety of operations on theorder of components and component separators,resource, asin <first>/<second>;<third>?<fourth> The component names are enclosed in angle-brackets and any characters outside angle-brackets are literal separators. Whitespace shouldmight beignored. These descriptionscharacterized by such words as "denote", "access", "update", "replace", or "find attributes". Such operations areused informally and do not define the syntax requirements. The second convention is a formal grammardefinedusing the Augmented Backus-Naur Form (ABNF) notation of [RFC2234]. Although the ABNF defines syntax in terms of the ASCII character encoding [ASCII], the URI syntax should be interpreted in terms ofby thecharacterprotocols thatthe ASCII-encoded octet represents, rather than the octet encoding itself. Howmake use of URIs, not by this specification. However, we do use a few general terms for describing common operations on URIs. URI "resolution" isrepresented in termsthe process ofbitsdetermining an access mechanism andbytesthe appropriate parameters necessary to dereference a URI; such resolution may require several iterations. Using that access mechanism to perform some action on thewireURI's resource isdependent upon the character encodingtermed a "dereference" of theprotocolURI. When URIs are used within information systems totransport it, or the charsetidentify sources of information, thedocument that contains it. The completemost common form of URIsyntaxdereference iscollected in Appendix A. Berners-Lee, et al. Expires September 1, 2003 [Page 8] Internet-Draft URI Generic Syntax March 2003 2. URI Characters and Escape Sequences A URI consists"retrieval": making use of arestricted set of characters, primarily chosen to aid transcribability and usability both in computer systems andURI innon-computer communications. Characters used conventionally as delimiters aroundorder to retrieve aURI are excluded. The restricted set of characters consistsrepresentation ofdigits, letters, andits associated resource. A "representation" is afew graphic symbols chosen fromsequence of octets, along with metadata describing thosecommon to mostoctets, that constitutes a record of thecharacter encodings and input facilities available to Internet users. uric = reserved / unreserved / escaped Within a URI, characters are either used as delimiters or to represent stringsstate ofdata (octets) withinthedelimited portions. Octets are either represented directly by a character (usingresource at theUS-ASCII character fortime thatoctet [ASCII]) or by an escape encoding. Thisthe representation iselaborated below. 2.1 URIs and non-ASCII characters The relationship between URIs and characters has beengenerated. Retrieval is achieved by asource of confusion for charactersprocess thatare not part of US-ASCII. To describemight include using therelationship, it is useful to distinguish betweenURI as a"character" (ascache key to check for adistinguishable semantic entity) and an "octet" (an 8-bit byte). There are two mappings, one fromlocally cached representation, resolution of the URIcharacterstooctets,determine an appropriate access mechanism (if any), anda second from octets to original characters: URI character sequence->octet sequence->original character sequence A URI is represented as a sequencedereference ofcharacters, not as a sequencethe URI for the sake ofoctets. That is becauseapplying a retrieval operation. URImight be "transported" by means thatreferences in information systems arenot through a computer network, e.g., printed on paper, read overdesigned to be late-binding: theradio, etc. Within a delimited component of a URI, a sequenceresult ofcharactersan access isusedgenerally determined at the time it is accessed and may vary over time or due torepresent a sequenceother aspects ofoctets. For example,thecharacter "a" representsinteraction. When an author creates a reference to such a resource, they do so with theoctet 97 (decimal), whileintention that thecharacter sequence "%", "0", "a" representsreference be used in theoctet 10 (decimal). Therefuture; what isa second translation forbeing identified is not someresources:specific result that was obtained in thesequence of octets definedpast, but rather some characteristic that is expected to be true for future results. In such cases, the resource referred to bya component ofthe URI issubsequently used to representactually asequencesameness ofcharacters. A 'charset' defines this mapping. There arecharacteristics as observed over time, perhaps elucidated by additional comments or assertions made by the resource provider. Although manycharsets inURI schemes are named after protocols, this does not imply that usein Internet protocols. For example, UTF-8 [UTF-8] defines a mapping from sequences of octets to sequencesofcharacterssuch a URI will result in access to therepertoire of ISO 10646. In the simplest case,resource via theoriginal character sequence contains only characters thatnamed protocol. URIs aredefined in US-ASCII, andoften used simply for thetwo levelssake ofBerners-Lee, et al. Expires September 1, 2003 [Page 9] Internet-Draftidentification. Even when a URIGeneric Syntax March 2003 mapping are simple and easily invertible: each 'original character'isrepresented asused to retrieve a representation of a resource, that access might be through gateways, proxies, caches, and name resolution services that are independent of theoctet forprotocol associated with theUS-ASCII code for it, which is, in turn, represented as either the US-ASCII character, or else the "%" escape sequence for that octet. For original character sequences that contain non-ASCII characters, however,scheme name, and thesituation is more difficult. Internet protocols that transmit octet sequences intended to represent character sequences are expected to provide some wayresolution ofidentifyingsome URIs may require thecharset used, if there might beuse of more than one[RFC2277]. However, there is currently no provision within the genericprotocol (e.g., both DNS and HTTP are typically used to access an "http" URI's origin server when a representation isn't found in a local cache). Berners-Lee, et al. Expires November 21, 2003 [Page 8] Internet-Draft URI Generic Syntax May 2003 1.2.3 Hierarchical Identifiers The URI syntax is organized hierarchically, with components listed in decreasing order from left toaccomplish this identification. An individualright. For some URIscheme may require a single charset, define a default charset, or provide a wayschemes, the visible hierarchy is limited toindicatethecharset used. For example, a newscheme"foo" might be defined such that any escaped octetitself: everything after the scheme component delimiter iskeyedconsidered opaque to URI processing. Other URI schemes make theUTF-8 encoding in orderhierarchy explicit and visible todeterminegeneric parsing algorithms. The URI syntax reserves thecorresponding Unicode character. It is expected that a systematic treatment of character encoding within URIs will be developed as a future modificationslash ("/"), question-mark ("?"), and crosshatch ("#") characters for the purpose ofthis specification. 2.2 Reserved Characters Many URI includedelimiting componentsconsisting of or delimited by, certain special characters. These charactersthat arecalled "reserved", since their usage withinsignificant to theURI component is limitedgeneric parser's hierarchical interpretation of an identifier. In addition totheir reserved purpose. Ifaiding thedata for a URI component would conflict with the reserved purpose, thenreadability of such identifiers through theconflicting data mustconsistent use of familiar syntax, this uniform representation of hierarchy across naming schemes allows scheme-independent references to beescaped before forming the URI. reserved = "[" / "]" / ";" / "/" / "?" / ":" / "@" / "&" / "=" / "+" / "$" / "," The "reserved" syntax class above refersmade relative tothose charactersthatare allowed withinhierarchy. An "absolute" URI refers to aURI, butresource independent of the naming hierarchy in whichmay not be allowedthe identifier is used. In contrast, a "relative" URI refers to a resource by describing the difference within aparticular component ofhierarchical name space between thegenericcurrent context and an absolute URIsyntax; they are used as delimitersof thecomponents described inresource. Section3. Characters in the "reserved" set are not reserved in all contexts. The set4.2 defines a scheme-independent form ofcharacters actually reserved within any givenrelative URIcomponent is defined byreference thatcomponent. In general,can be used in conjunction with acharacter is reserved ifbase URI of a hierarchical scheme to produce thesemanticsabsolute URI form of that reference. 1.3 Syntax Notation This document uses the Augmented Backus-Naur Form (ABNF) notation of [RFC2234] to define the URIchanges ifsyntax. Although the ABNF defines syntax in terms of thecharacter is replaced with its escapedUS-ASCIIencoding. Berners-Lee, et al. Expires September 1, 2003 [Page 10] Internet-Draftcharacter encoding [ASCII], the URIGeneric Syntax March 2003 2.3 Unreserved Characters Data characters that are allowedsyntax should be interpreted ina URI but do not have a reserved purpose are called unreserved. These include upper and lower case letters, decimal digits, and a limited setterms ofpunctuation marks and symbols. unreserved = ALPHA / DIGIT / mark mark = "-" / "_" / "." / "!" / "~" / "*" / "'" / "(" / ")" Unreserved characters can be escaped without changingthesemantics ofcharacter that theURI, but this should not be done unlessASCII-encoded octet represents, rather than theURI is being used inoctet encoding itself. How acontext that does not allow the unescaped character to appear.URInormalization processes may unescape sequencesis represented inthe rangesterms ofALPHA (%41-%5Abits and%61-%7A), DIGIT (%30-%39), underscore (%5F), or tilde (%7E) without fear of creating a conflict, but unescapingbytes on theother mark characterswire isusually counterproductive. 2.4 Escape Sequences Data must be escaped if it does not have a representation using an unreserved character; this includes data that does not correspond to a printabledependent upon the character encoding of theUS-ASCII coded character set, or that correspondsprotocol used toany US-ASCII character that is disallowed, as explained below. 2.4.1 Escaped Encoding An escaped octet is encoded as a character triplet, consistingtransport it, or the charset of thepercent character "%" followeddocument that contains it. The following core ABNF productions are used bythe two hexadecimal digits representing the octet code in . For example, "%20" is the escaped encoding for the US-ASCII space character. escaped = "%" HEXDIG HEXDIG 2.4.2 When to Escapethis specification as defined by Section 6.1 of [RFC2234]: ALPHA, CR, CTL, DIGIT, DQUOTE, HEXDIG, LF, OCTET, andUnescape ASP. The complete URI syntax isalwayscollected inan "escaped" form, since escaping or unescaping a completed URI might change its semantics. Normally, the only time escape encodings can safely be made is when the URI is being created from its component parts; each component may have its own set of characters that are reserved, so only the mechanism responsible for generating or interpreting that component can determine whether or not escaping a character will change its semantics. Likewise, a URI must be separated into its components before the escaped characters within those components can be safely decoded.Appendix A. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page11]9] Internet-Draft URI Generic SyntaxMarchMay 2003In some cases, data that could be represented by an unreserved character may appear escaped; for example, some of the unreserved "mark" characters are automatically escaped by some systems. If the given2. Characters A URIscheme definesconsists of acanonicalization algorithm, then unreserved characters may be unescaped according to that algorithm. For example, "%7e" is sometimes used insteadrestricted set of"~"characters, primarily chosen to aid transcription and usability both inan httpcomputer systems and in non-computer communications. Characters used conventionally as delimiters around a URIpath, but the twoareequivalent for an http URI. Becauseexcluded. The set of URI characters consists of digits, letters, and a few graphic symbols chosen from those common to most of thepercent "%"characteralways has theencodings and input facilities available to Internet users. uric = reservedpurpose of being the escape indicator, it must be/ unreserved / escapedas "%25" in orderWithin a URI, reserved characters are used tobedelimit syntax components, unreserved characters are usedasto describe registered names, and unreserved, non-delimiting reserved, and escaped characters are used to represent strings of data (1*OCTET) withina URI. Implementers should be carefulthe components. 2.1 Encoding of Characters As described above (Section 1.3), the URI syntax is defined in terms of characters by reference to the US-ASCII encoding of characters to octets. This specification does not mandate the use of any particular mapping between its character set and the octets used toescapestore orunescapetransmit those characters. URI characters representing strings of data within a component may, if allowed by thesame string more than once, since unescapingcomponent production, represent analready unescaped stringarbitrary sequence of octets. For example, portions of a given URI mightleadcorrespond tomisinterpretingapercentfilename on a non-ASCII file system, a query on non-ASCII data, numeric coordinates on a map, etc. Some URI schemes define a specific encoding of raw datacharacterto US-ASCII characters asanother escaped character, or vice versapart of their scheme-specific requirements. Most URI schemes represent data octets by the US-ASCII character corresponding to that octet, either directly in thecaseform ofescaping an already escaped string. 2.4.3 Excluded US-ASCII Characters Although they are disallowed withinthe character's glyph or by use of an escape triplet (Section 2.4). When a URIsyntax, we include herescheme defines adescriptioncomponent that represents textual data consisting ofthose US-ASCIIcharacters from the Unicode (ISO 10646) character set, we recommend thathave been excluded andthereasons for their exclusion. The control characters (CTL) indata be encoded first as octets according to theUS-ASCII codedUTF-8 [UTF-8] charactersetencoding, and then escaping any octets that are notused within a URI, both because they are non-printablein the unreserved character set. 2.2 Reserved Characters URIs include components andbecause theysub-components that arelikely to be misinterpreteddelimited bysome control mechanisms. The space character (SP) is excluded because significant spaces may disappear and insignificant spaces may be introduced when a URI is transcribed or typeset or subjected to the treatment of word-processing programs. Whitespace is also used to delimit a URI in many contexts. The angle-bracket "<" and ">" and double-quote (")certain special characters. These characters areexcluded because they are often used as the delimiters aroundcalled "reserved", since their usage within a URIin text documents and protocol fields. The character "#" is excluded because itcomponent isusedlimited todelimit atheir reserved Berners-Lee, et al. Expires November 21, 2003 [Page 10] Internet-Draft URIfrom a fragment identifier inGeneric Syntax May 2003 purpose within that component. If data for a URIreference (Section 4). The percent character "%" is excluded because it is used forcomponent would conflict with theencoding ofreserved purpose, then the conflicting data must be escapedcharacters. delims(Section 2.4) before forming the URI. reserved ="<""/" /">""?" / "#" /"%""[" /DQUOTE Other characters are excluded because gateways and other transport agents are known to sometimes modify such characters, or they are used as delimiters. unwise = "{""]" /"}"";" /"|"":" /"\""@" /"^""&" /"`" Berners-Lee, et al. Expires September 1, 2003 [Page 12] Internet-Draft URI Generic Syntax March 2003 Data corresponding to excluded"=" / "+" / "$" / "," Reserved charactersmust be escaped in order to be properly represented within a URI. Berners-Lee, et al. Expires September 1, 2003 [Page 13] Internet-Draft URI Generic Syntax March 2003 3. URI Syntactic Components The URI syntax is dependent upon the scheme. In general, absolute URIsarewrittenused asfollows: <scheme>:<scheme-specific-part> An absolute URI contains the namedelimiters of thescheme being used (<scheme>) followed by a colon (":") and then a string (the <scheme-specific-part>) whose interpretation depends on the scheme. Thegeneric URI components described in Section 3, as well as within those components for delimiting sub-components. A component's ABNF syntaxdoesrule will notrequireuse the "reserved" production directly; instead, each rule lists those reserved characters that are allowed within that component. Allowed reserved characters that are not assigned a sub-component delimiter role by this specification should be considered reserved for special use by whatever software generates thescheme-specific-part have any general structureURI (i.e., they may be used to delimit orset of semantics whichindicate information that iscommon among all URIs. However, a subsetsignificant to interpretation ofURI do share a common syntax for representing hierarchical relationships withinthenamespace. This "generic URI" syntax consistsidentifier, but that significance is outside the scope ofa sequencethis specification). Outside offour main components: <scheme>://<authority><path>?<query> eachthe URI's origin, a reserved character cannot be escaped without fear ofwhich, except <scheme>, maychanging how it will beabsent from a particular URI. For example, some URI schemes do not allowinterpreted; likewise, an<authority> component, and others do not useescaped octet that corresponds to a<query> component. absolute-URI = scheme ":" ( hier-part / opaque-part ) URIsreserved character cannot be unescaped outside the software that is responsible for interpreting it during URI resolution. The slash ("/"), question-mark ("?"), and crosshatch ("#") characters arehierarchicalreserved innature use the slash "/" characterall URI forseparating hierarchical components. For some file systems, a "/" character (usedthe purpose of delimiting components that are significant todenotethe generic parser's hierarchicalstructureinterpretation of an identifier. The hierarchical prefix of aURI) isURI, wherein thedelimiter used to constructslash ("/") character signifies afile name hierarchy, and thushierarchy delimiter, extends from theURI path will look similarscheme (Section 3.1) through toa file pathname. This does NOT imply thattheresource is a filefirst question-mark ("?"), crosshatch ("#"), orthattheURI maps to an actual filesystem pathname. hier-part = [ net-path / abs-path ] [ "?" query ] net-path = "//" authority [ abs-path ] abs-path = "/" path-segments URIs that do not make useend of the URI string. In other words, the slash"/"("/") characterfor separatingis not treated as a hierarchical separator within the query (Section 3.4) and fragment (Section 3.5) componentsareof a URI, but is still consideredopaque byreserved within those components for purposes outside thegenericscope of this specification. 2.3 Unreserved Characters Data characters that are allowed in a URIparser. opaque-part = uric-no-slash *uric uric-no-slash =but do not have a reserved purpose are called unreserved. These include uppercase and lowercase letters, decimal digits, and a limited set of punctuation marks and symbols. unreserved = ALPHA /escaped / "[" / "]"DIGIT /";"mark mark = "-" /"?""_" /":""." /"@""!" /"&""~" /"=""*" /"+""'" /"$""(" /","")" Unreserved characters can be escaped without changing the semantics of a URI, but this should not be done unless the URI is being used in Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page14]11] Internet-Draft URI Generic SyntaxMarchMay 2003We usea context that does not allow theterm <path> to referunescaped character toboth the <abs-path> and <opaque-part> constructs, since they are mutually exclusive for any givenappear. URI normalization processes may unescape sequences in the ranges of ALPHA (%41-%5A andcan be parsed as%61-%7A), DIGIT (%30-%39), hyphen (%2D), underscore (%5F), or tilde (%7E) without fear of creating asingle component. 3.1 Scheme Component Just as there are many different methods of accessconflict, but unescaping the other mark characters is usually counterproductive. 2.4 Escaped Characters Data must be escaped if it does not have a representation using an unreserved character; this includes data that does not correspond toresources, there areavariety of schemes for identifying such resources. The URI syntax consistsprintable character of the US-ASCII coded character set or corresponds to asequence of components separated by reserved characters, withUS-ASCII character that delimits thefirstcomponentdefining the semanticsfrom others, is reserved in that component forthe remainder of thedelimiting sub-components, or is excluded from any use within a URIstring. Scheme names consist of(Section 2.5). 2.4.1 Escaped Encoding An escaped octet is encoded as asequencecharacter triplet, consisting ofcharacters beginning with a lower case letter andthe percent character "%" followed byany combination of lower case letters, digits, plus ("+"), period ("."), or hyphen ("-").the two hexadecimal digits representing that octet's numeric value. Forresiliency, programs interpreting a URI should treat upper case lettersexample, "%20" is the escaped encoding for the US-ASCII space character (SP). This is sometimes referred to as "percent-encoding" the octet. escaped = "%" HEXDIG HEXDIG The uppercase hexadecimal digits 'A' through 'F' are equivalent tolowerthe lowercase digits 'a' through 'f', respectively. Two URIs that differ only in the case of hexadecimal digits used inscheme names (e.g., allow "HTTP" as well as "http"). scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) Relative URI referencesescaped octets aredistinguished from absoluteequivalent. For consistency, we recommend that uppercase digits be used by URIingenerators and normalizers. 2.4.2 When to Escape and Unescape Under normal circumstances, the only time thatthey do not begin withcharacters within ascheme name. Instead, the scheme is inherited from the base URI, as described in Section 5.2. 3.2 Authority Component ManyURIschemes include a top hierarchical element for a naming authority, such that the namespace defined bystring are escaped is during theremainderprocess of generating the URIis governed byfrom its component parts. Each component may have its own set of characters that are reserved, so only the mechanism responsible for generating or interpreting thatauthority. This authoritycomponentis typically defined by an Internet-based servercan determine whether or not escaping ascheme-specific registry of naming authorities. authority = server / reg-namecharacter will change its semantics. Theauthority componentexception ispreceded bywhen adouble slash "//" andURI isterminated by the next slash "/", question-mark "?", or by the end of the URI. Within the authority component,being used within a context where the unreserved "mark" characters";", ":", "@", "?", "/", "[", and "]" are reserved. An authority component is not requiredmight need to be escaped, such as when used for a command-line argument or within a single-quoted attribute. Once generated, a URIscheme to make use of relative references. A base URI withoutis always in anauthority component impliesescaped form. When a URI is resolved, the components significant to thatany relative reference will alsoscheme-specific resolution process (if any) must bewithout an authority component.parsed and separated before the escaped characters within those components can be safely unescaped. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page15]12] Internet-Draft URI Generic SyntaxMarchMay 20033.2.1 Registry-based Naming Authority The structureIn some cases, data that could be represented by an unreserved character may appear escaped; for example, some ofa registry-based naming authority is specific to the URI scheme, but constrained totheallowed characters for an authority component. reg-name = 1*(unreserved/"mark" characters are automatically escaped/ ";" / ":" / "@" / "&" / "=" / "+" / "$" / "," ) 3.2.2 Server-based Naming Authorityby some systems. A URIschemesnormalizer may unescape escaped octets thatinvolveare represented by characters in thedirect useunreserved set. For example, "%7E" is sometimes used instead of tilde ("~") in anIP-based protocol"http" URI path and can be converted to "~" without changing the interpretation of the URI. Because the percent ("%") character serves as the escape indicator, it must be escaped as "%25" in order for that octet to be used as data within aspecified server onURI. Implementers should be careful not to escape or unescape theInternet usesame string more than once, since unescaping an already unescaped string might lead to misinterpreting acommon syntax forpercent data character as another escaped character, or vice versa in theserver componentcase of escaping an already escaped string. 2.5 Excluded Characters Although they are disallowed within theURI's scheme-specific data: <userinfo>@<host>:<port> where <userinfo> may consistURI syntax, we include here a description of those characters that have been excluded and the reasons for their exclusion. excluded = invisible / delims / unwise The control characters (CTL) in the US-ASCII coded character set are not used within auser name and, optionally, scheme-specific information about how to gain authorizationURI, both because they are non-printable and because they are likely toaccess the server.be misinterpreted by some control mechanisms. Theparts "<userinfo>@"space character (SP) is excluded because significant spaces may disappear and":<port>"insignificant spaces may beomitted. If <host> is omitted, the default hostintroduced when a URI isdefined bytranscribed, typeset, or subjected to thescheme-specific semanticstreatment ofthe URI (e.g., the "file" URI scheme defaultsword-processing programs. Whitespace is also used to"localhost", whereas the "http"delimit a URIscheme does not allow host to be omitted). serverin many contexts. Characters outside the US-ASCII set are excluded as well. invisible =[ [ userinfo "@" ] hostport ]CTL / SP / %x80-FF Theuser information, if present, is followed byangle-bracket ("<" and ">") and double-quote (") characters are excluded because they are often used as the delimiters around acommercial at-sign "@". userinfoURI in text documents and protocol fields. The percent character ("%") is excluded because it is used for the encoding of escaped (Section 2.4) characters. delims =*( unreserved"<" /escaped">" /";""%" /":"DQUOTE Other characters are excluded because gateways and other transport agents are known to sometimes modify such characters. unwise = "{" /"&""}" /"=""|" /"+""\" /"$""^" /"," ) Some"`" Berners-Lee, et al. Expires November 21, 2003 [Page 13] Internet-Draft URIschemes use the format "user:password" in the userinfo field. This practice is NOT RECOMMENDED, because the passing of authentication information in clear text has provenGeneric Syntax May 2003 Data octets corresponding to excluded characters must bea security riskescaped inalmost every case where it has been used. Note also that userinfo which is craftedorder tolook like a trusted domain name mightbeused to mislead users, as described in Section 7.5.represented within a URI. Berners-Lee, et al. Expires November 21, 2003 [Page 14] Internet-Draft URI Generic Syntax May 2003 3. Syntax Components Theserver is identified bygeneric URI syntax consists of anetwork host ---hierarchical sequence of components referred to asdescribed by an IPv6 literal encapsulated within square brackets, an IPv4 address in dotted-decimal form, or a domain name --- and an optional port number. The server's port, if any is required bytheURIscheme,can be specified by a port number in decimal following the hostauthority, path, query, anddelimited from it by a colon (":") character. If no explicit port number is given, the default port number, as defined by the URI Berners-Lee, et al. Expires September 1, 2003 [Page 16] Internet-Draft URI Generic Syntax March 2003 scheme, is assumed. The type of network port identified by the URI (e.g., TCP, UDP, SCTP, etc.) is defined by the scheme-specific semantics of thefragment. URIscheme. hostport=host [scheme ":"porthier-part [ "?" query ]host[ "#" fragment ] hier-part =IPv6referencenet-path /IPv4addressabs-path /hostname portrel-path net-path =*DIGIT A hostname takes the form described in Section 3 of [RFC1034] and Section 2.1 of [RFC1123]: a sequence of domain labels separated by ".", each domain label starting and ending with an alphanumeric character and possibly also containing "-" characters."//" authority [ abs-path ] abs-path = "/" path-segments rel-path = path-segments Therightmost domain label of a fully qualified domain name will never start with a digit, thus syntactically distinguishing domain names from IPv4 addresses,scheme and path components are required, though path may befollowedempty (no characters). An ABNF-driven parser of hier-part will find that the three productions in the rule are ambiguous: they are disambiguated by the "first-match-wins" (a.k.a. "greedy") algorithm. In other words, if the string begins with two slash characters ("// "), then it is asingle "."net-path; if it begins with only one slash character, then it isnecessary to distinguish between the complete domain name and any local domain. hostname = domainlabel qualified qualified = *( "." domainlabel ) [ "." toplabel "." ] domainlabel = alphanum [ 0*61( alphanum | "-" ) alphanum ] toplabel = alpha [ 0*61( alphanum | "-" ) alphanum ] alphanum = ALPHA / DIGIT A host identified byanIPv4 literal addressabs-path; otherwise, it isrepresented in dotted-decimal notation (a sequence of four decimal numbers in the range 0 to 255, separated by "."), as described in [RFC1123] by reference to [RFC0952].a rel-path. Note thatother forms of dotted notation mayrel-path does not necessarily contain any slash ("/") characters; a non-hierarchical path will beinterpreted on some platforms,treated asdescribed in Section 7.3, butopaque data by a generic URI parser. The authority component is only present when a string matches thedotted-decimal formnet-path production. Since the presence offour octets is allowed by this grammar. IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet dec-octet = DIGIT / ; 0-9 ( %x31-39 DIGIT ) / ; 10-99 ( "1" 2DIGIT ) / ; 100-199 ( "2" %x30-34 DIGIT ) / ; 200-249 ( "25" %x30-35 ) ; 250-255 Berners-Lee, et al. Expires September 1, 2003 [Page 17] Internet-Draft URI Generic Syntax March 2003 A host identified byanIPv6 literal address [RFC2373] is distinguished by enclosingauthority component restricts theIPv6 literal within square-brakets ("[" and "]"). Thisremaining syntax for path, we have not included a specific "path" rule in the syntax. Instead, what we refer to as the URI path is that part of theonly place where square-bracket characters are allowedparsed URI string matching the abs-path or rel-path production in thehierarchical URI syntax. IPv6reference = "[" IPv6address "]" IPv6address = ( 6( h4 ":" ) ls32 ) / ( "::" 5( h4 ":" ) ls32 ) / ( [ h4 ] "::" 4( h4 ":" ) ls32 ) / ( [ *1( h4 ":" ) h4 ] "::" 3( h4 ":" ) ls32 ) / ( [ *2( h4 ":" ) h4 ] "::" 2( h4 ":" ) ls32 ) / ( [ *3( h4 ":" ) h4 ] "::" h4 ":" ls32 ) / ( [ *4( h4 ":" ) h4 ] "::" ls32 ) / ( [ *5( h4 ":" ) h4 ] "::" h4 ) / ( [ *6( h4 ":" ) h4 ] "::" ) ls32 = ( h4 ":" h4 ) / IPv4address ; least-significant 32 bits of address h4 = 1*4HEXDIG 3.3 Path Component The path component contains data, specificsyntax above, since they are mutually exclusive for any given URI and can be parsed as a single component. 3.1 Scheme Each URI begins with a scheme name that refers to a specification for assigning identifiers within that scheme. As such, theauthority (or the scheme if thereURI syntax isno authority component), identifying the resource withina federated and extensible naming system wherein each scheme's specification may further restrict thescopesyntax and semantics of identifiers using that scheme. Scheme names consist of a sequence of characters beginning with a letter and followed by any combination of letters, digits, plus ("+"), period ("."), or hyphen ("-"). Although scheme is case-insensitive, the canonical form is lowercase andauthority. path = [ abs-path / opaque-part ] path-segments = segment *( "/" segment ) segment = *pchar pchar = unreserved / escaped / ";" / ":" / "@" / "&" / "=" / "+" / "$" / "," The path may consist of a sequence of path segments separated by a single slash "/" character. Within a path segment, the characters "/ ", ";", "=", and "?" are reserved. The semicolon (";") and equals ("=") characters have the reserved purpose of delimiting parameters and parameter values within a path segment. However, parameters are not significantdocuments that specify schemes must do so using lowercase letters. An implementation should accept uppercase letters as equivalent tothe parsing of relative references.lowercase in scheme names (e.g., allow "HTTP" as well as "http"), for Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page18]15] Internet-Draft URI Generic SyntaxMarchMay 20033.4 Query Component The query component is a string of information to be interpreted bytheresource. querysake of robustness, but should only generate lowercase scheme names, for consistency. scheme = ALPHA *(pcharALPHA /"/"DIGIT /"?""+" / "-" / "." )Within a query component, the characters ";", "/", "?", ":", "@", "&", "=", "+", ",", and "$"Individual schemes arereserved. Berners-Lee, et al. Expires September 1, 2003 [Page 19] Internet-Draft URI Generic Syntax March 2003 4. URI Referencesnot specified by this document. Theterm "URI-reference" is used here to denote the common usageprocess for registration ofa resource identifier. Anew URIreference may be absolute or relative, and may have additional information attached inschemes is defined separately by [RFC2717]. The scheme registry maintains theform ofmapping between scheme names and their specifications. 3.2 Authority Many URI schemes include afragment identifier. However, "the URI" that results from suchhierarchical element for areference includes only the absolute URI afternaming authority, such that governance of the name space defined by the remainder of thefragment identifier (if any) is removed and after any relativeURI isresolveddelegated toits absolute form. Althoughthat authority (which may, in turn, delegate itis possible to limit the discussion of URIfurther). The generic syntax provides a common means for distinguishing an authority based on a registered domain name or server address, along with optional port andsemantics to that of the absolute result, most usage of URIuser information. The authority component iswithin general URI references,preceded by a double slash ("//") anditisimpossible to obtainterminated by theURI from such a reference without also parsingnext slash ("/"), question-mark ("?"), or crosshatch ("#") character, or by thefragment and resolvingend of therelative form. URI-referenceURI. authority = [absolute-URI / relative-URIuserinfo "@" ] host ["#" fragment":" port ]Many protocol elementsThe parts "<userinfo>@" and ":<port>" may be omitted. Some schemes do not allowonlytheabsolute form of a URIuserinfo and/or port sub-components. When presented withan optional fragment identifier. absolute-URI-reference = absolute-URI [ "#" fragment ] The syntax forarelativeURIis a shortened form ofthatfor an absolute URI, where some prefix ofviolates one or more scheme-specific restrictions, the scheme-specific URIis missing and certain path components ("." and "..") have a special meaning when, and only when, interpreting a relative path. The relative URI syntax is defined in Section 5. 4.1 Fragment Identifier When a URI reference is used to perform a retrieval action onresolution process should flag theidentified resource,reference as an error rather than ignore theoptional fragment identifier, separated fromunused parts; doing so reduces theURI by a crosshatch ("#") character, consistsnumber of equivalent URIs and helps detect abuses ofadditional reference information to be interpreted bytheuser agent aftergeneric syntax that might indicate theretrieval actionURI has beensuccessfully completed. As such, it is not partconstructed to mislead the user (Section 7.5). 3.2.1 User Information The userinfo sub-component may consist of aURI, butuser name and, optionally, scheme-specific information about how to gain authorization to access the server. The user information, if present, isoften used in conjunction withfollowed by aURI. fragmentcommercial at-sign ("@") that delimits it from the host. userinfo = *(pcharunreserved /"/"escaped /"?"";" / ":" / "&" / "=" / "+" / "$" / "," )The semantics of a fragment identifier is a property of the data resulting from a retrieval action, regardless of the type ofSome URIused in the reference. Therefore,schemes use the formatand interpretation of fragment identifiers is dependent on the media type [RFC2046] of the retrieval result. The character restrictions described in Section 2 for a URI also apply to the fragment"user:password" ina URI-reference. Individual media types may define additional restrictions or structure withinthefragment for specifying different types of "partial views" that can be identified within that media type.userinfo Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page20]16] Internet-Draft URI Generic SyntaxMarchMay 2003A fragment identifier is only meaningful when a URI referencefield. This practice isintended for retrieval andNOT RECOMMENDED, because theresultpassing ofthat retrieval isauthentication information in clear text has proven to be adocument for which the identified fragment is consistently defined. 4.2 Same-document References A URI referencesecurity risk in almost every case where it has been used. Note also thatdoes not contain a URI is a referenceuserinfo might be crafted tothe current document. In other words, an empty URI reference within a document is interpreted aslook like areferencetrusted domain name in order tothe startmislead users, as described in Section 7.5. 3.2.2 Host The host sub-component ofthat document, and a reference containing only a fragment identifierauthority isa reference to theidentifiedfragment of that document. Traversal of such a reference should not result inby anadditional retrieval action. However, if the URI reference occursIPv6 literal encapsulated within square brackets, an IPv4 address in dotted-decimal form, or acontext thatdomain name. host = [ IPv6reference / IPv4address / hostname ] If host isalways intended to result inomitted, anew request, as indefault may be defined by thecasescheme-specific semantics ofHTML's FORM element [HTML], then an empty URI reference representsthebase URI ofURI. For example, thecurrent document and should be replaced by that URI when transformed into a request. 4.3 Parsing a URI Reference A"file" URIreference is typically parsed accordingscheme defaults to "localhost", whereas thefour main components and fragment identifier in order"http" URI scheme does not allow host todetermine what components are present and whether the reference is relative or absolute.be omitted. Theindividual components are then parsedproduction fortheir subparts and, if not opaque, to verify their validity. Although the BNF defines what is allowed in each component, ithost is ambiguousin terms of differentiatingbecause it does not completely distinguish between anauthority componentIPv4address and apath component that begins with two slash characters. The greedy algorithm is used for disambiguation:hostname. Again, theleft-most matching rule soaks up as much of"first-match-wins" algorithm applies: If host matches theURI reference string asproduction for IPv4address, then itis capable of matching. In other words, the authority component wins. Readers familiar with regular expressionsshouldsee Appendix B for a concrete parsing examplebe considered an IPv4 address literal andtest oracle. Berners-Lee, et al. Expires September 1, 2003 [Page 21] Internet-Draft URI Generic Syntax March 2003 5. Relative URI References It is often the case that a group or "tree" of documents has been constructed to servenot acommon purpose;hostname. A hostname takes thevast majority of URIsform described inthese documents point to resources within the tree rather than outside of it. Similarly, documents located at a particular site are much more likely to refer to other resources at that site than to resources at remote sites. Relative addressing of URIs allows document trees to be partially independentSection 3 oftheir location[RFC1034] andaccess scheme. For instance, it is possible forSection 2.1 of [RFC1123]: asingle setsequence ofhypertext documents to be simultaneously accessible and traversable viadomain labels separated by ".", eachof the "file", "http",domain label starting and"ftp" schemes if the documents refer to each other using relative URIs. Furthermore, such document trees can be moved, as a whole, without changing any of the relative references. Experience within the WWW has demonstrated that the ability to perform relative referencing is necessary for the long-term usability of embedded URIs.ending with an alphanumeric character and possibly also containing "-" characters. Therelative URI syntax takes advantage of the <hier-part> syntaxrightmost domain label of<absolute-URI> (Section 3) in order to expressareference thatfully qualified domain name may be followed by a single "." if it isrelativenecessary to distinguish between thenamespace of another hierarchical URI. relative-URIcomplete domain name and some local domain. hostname = domainlabel qualified qualified = *( "." domainlabel ) [net-path / abs-path / rel-path"." ] domainlabel = alphanum ["?" query0*61( alphanum / "-" ) alphanum ] alphanum = ALPHA / DIGIT Arelative reference beginning with two slash charactershost identified by an IPv4 literal address istermed a network-path reference, as definedrepresented in dotted-decimal notation (a sequence of four decimal numbers in the range 0 to 255, separated by<net-path>"."), as described inSection 3. Such references are rarely used. A relative[RFC1123] by referencebeginning with a single slash character is termed an absolute-path reference,to [RFC0952]. Note that other forms of dotted notation may be interpreted on some platforms, asdefined by <abs-path>described in Section3. A relative reference that does not begin with a scheme name or a slash character7.3, but only the dotted-decimal form of four octets istermed a relative-path reference. rel-path = rel-segment [ abs-path ] rel-segmentallowed by this grammar. IPv4address =1*( unreserved / escaped / ";" / "@" / "&" / "=" / "+" / "$" / "," ) Within a relative-path reference, the complete path segmentsdec-octet "."and ".." have special meanings: "the current hierarchy level" and "the level above this hierarchy level", respectively. Although this is very similar to their use within Unix-based filesystems to indicate directory levels, these path components are only considered special when resolving a relative-path reference to its absolute form (Section 5.2).dec-octet "." dec-octet "." dec-octet Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page22]17] Internet-Draft URI Generic SyntaxMarchMay 2003Authors should be aware that a path segment which contains a colon character cannot be used as the first segment of a relative URI path (e.g., "this:that"), because it would be mistaken for a scheme name. Itdec-octet = DIGIT ; 0-9 / %x31-39 DIGIT ; 10-99 / "1" 2DIGIT ; 100-199 / "2" %x30-34 DIGIT ; 200-249 / "25" %x30-35 ; 250-255 A host identified by an IPv6 literal address [RFC3513] istherefore necessary to precede such segments with other segments (e.g., "./this:that") in order for them to be referenced as a relative path. Itdistinguished by enclosing the IPv6 literal within square-brackets ("[" and "]"). This isnot necessary for allthe only place where square-bracket characters are allowed in the URI syntax. IPv6reference = "[" IPv6address "]" IPv6address = 6( h4 ":" ) ls32 / "::" 5( h4 ":" ) ls32 / [ h4 ] "::" 4( h4 ":" ) ls32 / [ *1( h4 ":" ) h4 ] "::" 3( h4 ":" ) ls32 / [ *2( h4 ":" ) h4 ] "::" 2( h4 ":" ) ls32 / [ *3( h4 ":" ) h4 ] "::" h4 ":" ls32 / [ *4( h4 ":" ) h4 ] "::" ls32 / [ *5( h4 ":" ) h4 ] "::" h4 / [ *6( h4 ":" ) h4 ] "::" ls32 = ( h4 ":" h4 ) / IPv4address ; least-significant 32 bits of address h4 = 1*4HEXDIG The presence of host within agivenURI does not imply that the schemeto be restrictedrequires access to the<hier-part> syntax, sincegiven host on thehierarchical properties of thatInternet. In many cases, the host syntaxare only necessary when a relative URIis usedwithin a particular document. Documents canonlymake usefor the sake ofa relative URI when their base URI fits withinreusing the<hier-part> syntax. It is assumed that any document which contains a relative reference will also haveexisting registration process created and deployed for DNS, thus obtaining abase URI that obeysglobally unique name without thesyntax. In other words, a relative URI cannot be used within a document that has an unsuitable base URI. Some URI schemes docost of deploying another registry. However, such use comes with its own costs: domain name ownership may change over time for reasons notallow a hierarchical syntax matchinganticipated by the<hier-part> syntax, and thus cannot use relative references. 5.1 Establishing a BaseURI creator. 3.2.3 Port Theterm "relative URI" implies that there exists some absolute "base URI" against which the relative referenceport sub-component of authority isapplied. Indeed,designated by an optional port number in decimal following thebase URIhost and delimited from it by a single colon (":") character. port = *DIGIT If port isnecessary to defineomitted, a default may be defined by the scheme-specific semantics ofany relative URI reference; without it, a relative referencethe URI. Likewise, the type of network port designated by the port number (e.g., TCP, UDP, SCTP, etc.) ismeaningless. In order for relative URI to be usable within a document,defined by thebaseURIof that document must be known toscheme. For example, theparser. The base"http" URIofscheme defines adocument can be established in one of four ways, listed below in order of precedence. The order of precedence can be thought of in termsdefault oflayers, where the innermost defined base URI has the highest precedence. This can be visualized graphically as: Berners-Lee, et al. Expires September 1, 2003 [Page 23] Internet-DraftTCP Berners-Lee, et al. Expires November 21, 2003 [Page 18] Internet-Draft URI Generic SyntaxMarchMay 2003.----------------------------------------------------------. | .----------------------------------------------------. | | | .----------------------------------------------. | | | | | .----------------------------------------. | | | | | | | .----------------------------------. | | | | | | | | | <relative-reference> | | | | | | | | | `----------------------------------' | | | | | | | | (5.1.1) Base URI embeddedport 80. 3.3 Path The path component contains hierarchical data that, along with data in the| | | | | | | | document's content | | | | | | | `----------------------------------------' | | | | | | (5.1.2) Base URIoptional query (Section 3.4) component, serves to identify a resource within the scope of that URI's scheme and naming authority (if any). There is no specific "path" syntax production in theencapsulating entity | | | | | | (message, document, or none). | | | | | `----------------------------------------------' | | | | (5.1.3)generic URIusedsyntax. Instead, what we refer toretrieveas theentity | | | `----------------------------------------------------' | | (5.1.4) Default BaseURI path isapplication-dependent | `----------------------------------------------------------' 5.1.1 Base URI within Document Content Within certain document media types,that part of thebaseparsed URIofstring matching either thedocument can be embedded withinabs-path or thecontent itself such that it can be readily obtained by a parser. Thisrel-path production, since they are mutually exclusive for any given URI and can beuseful for descriptive documents, suchparsed astables of content, which may be transmitted to others through protocols other than their usual retrieval context (e.g., E-Mail or USENET news). Ita single component. The path isbeyondterminated by thescopefirst question-mark ("?") or crosshatch ("#") character, or by the end ofthis document to specify how, for each media type,thebase URI can be embedded. ItURI. path-segments = segment *( "/" segment ) segment = *pchar pchar = unreserved / escaped / ";" / ":" / "@" / "&" / "=" / "+" / "$" / "," The path consists of a sequence of path segments separated by a slash ("/") character. A path isassumed that user agents manipulating such media types willalways defined for a URI, though the defined path may beable to obtainempty (zero length) or opaque (not containing any "/" delimiters). For example, theappropriate syntax from that media type's specification. An exampleURI <mailto:fred@example.com> has a path ofhow"fred@example.com". Within a path segment, thebasesemicolon (";") and equals ("=") reserved characters are often used for delimiting parameters and parameter values applicable to that segment. The comma (",") reserved character is often used for similar purposes. For example, one URIcangenerator might use a segment like "name;v=1.1" to indicate a reference to version 1.1 of "name", whereas another might use a segment like "name,1.1" to indicate the same. Parameter types may beembeddeddefined by scheme-specific semantics, but in most cases theHypertext Markup Language (HTML) [HTML]meaning of a parameter isprovided in Appendix D. A mechanism for embeddingspecific to thebaseURIwithin MIME container types (e.g., the message and multipart types) is defined by MHTML [RFC2110]. Protocols that dooriginator. Parameters are notusesignificant to theMIME message header syntax, but which do allow some formparsing oftagged metainformation to be includedrelative references. The path segments "." and ".." are defined for relative reference withinmessages, may define their own syntaxthe path name hierarchy. They are intended fordefininguse at thebase URI as partbeginning of amessage. 5.1.2 Base URI from the Encapsulating Entity If no base URI is embedded,relative path reference (Section 4.2) for indicating relative position within thebase URIhierarchical tree of names, with adocument is defined bysimilar effect to how they are used within some operating systems' file directory structure to indicate thedocument's retrieval context. Forcurrent directory and parent directory, respectively. Unlike adocument that is enclosedfile system, however, these dot-segments are only interpreted withinanother entity (such as a message or another document), the retrieval context is that entity; thus,thedefault baseURI path hierarchy and must be removed as part of the URI normalization or resolution process, in accordance with the process described in Section 5.2. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page24]19] Internet-Draft URI Generic SyntaxMarchMay 2003document is the base URI of the entity3.4 Query The query component contains non-hierarchical data that, along with data inwhichthedocument is encapsulated. 5.1.3 Base URI from the Retrieval URI If no base URI is embedded and the document is not encapsulatedpath (Section 3.3) component, serves to identify a resource withinsome other entity (e.g.,thetop levelscope ofa composite entity), then, if a URI was used to retrieve the base document, that URI shall be considered the base URI. NotethatifURI's scheme and naming authority (if any). The query component is indicated by theretrieval wasfirst question-mark ("?") character and terminated by a crosshatch ("#") character or by theresultend ofa redirected request,thelast URI used (i.e., that which resulted in the actual retrieval of the document) is the baseURI.5.1.4 Default Base URI If none of the conditions described in Sections 5.1.1--5.1.3 apply, then the base URI is defined by the context of the application. Since this definition is necessarily application-dependent, failingquery = *( pchar / "/" / "?" ) The characters slash ("/") and question-mark ("?") are allowed todefine the base URI using one of the other methods may result inrepresent data within thesame content being interpreted differently by different types of application. Itquery component, but such use isthe responsibility of the distributor(s)discouraged; incorrect implementations ofa document containing arelative URI resolution often fail toensure that the base URI for that document can be established. It must be emphasized that adistinguish them from hierarchical separators, thus resulting in non-interoperable results while parsing relativeURI cannot bereferences. However, since query components are often usedreliablyto carry identifying information insituations wherethedocument's base URIform of "key=value" pairs, and one frequently used value isnot well-defined. 5.2 Resolving Relative Referencesa reference toAbsolute Form This section describes an example algorithmanother URI, it is sometimes better forresolving URI references that might be relativeusability toa given base URI.include those characters unescaped. 3.5 Fragment Thealgorithm is intendedfragment identifier component allows indirect identification of a secondary resource by reference toprovideadefinitive resultprimary resource and additional identifying information thatcanis selective within that resource. The identified secondary resource may beused to test the outputsome portion or subset ofother implementations. Implementationthe primary resource, some view on representations of thealgorithm itselfprimary resource, or some other resource that isnot required, butmerely named within theresult givenprimary resource. A fragment identifier component is indicated byan implementation must matchtheresult that would be givenpresence of a crosshatch ("#") character and terminated bythis algorithm. The base URI is established according totherulesend ofSection 5.1 and parsed intothefour main components as described in Section 3. NoteURI string. fragment = *( pchar / "/" / "?" ) The semantics of a fragment identifier are defined by the set of representations thatonlymight result from a retrieval action on theschemeprimary resource. Therefore, the format and interpretation of a fragment identifier component isrequired to be present in the base URI;dependent on theother componentsmedia type [RFC2046] of a potential retrieval result. Individual media types maybe emptydefine their own restrictions on, orundefined. A component is undefined if its preceding separator does not appear instructure within, theURI reference;fragment identifier syntax for specifying different types of subsets, views, or external references that are identifiable as fragments by that media type. If thepath component is never undefined, though it may be empty. The base URI's query componentprimary resource isnot usedrepresented by multiple media types, as is often theresolution algorithm and may be discarded. For each URI reference (R), the following pseudocode describes an algorithmcase fortransforming R into its target (T), whichresources whose representation iseither an absolute URI orselected based on attributes of thecurrent document, and R's optional fragment:retrieval request, then interpretation of the given fragment identifier must be consistent across all of those media types in order for it to be viable as an Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page25]20] Internet-Draft URI Generic SyntaxMarchMay 2003(R.scheme, R.authority, R.path, R.query, fragment) = parse(R); -- Theidentifier. As with any URI, use of a fragment identifier component does not imply that a retrieval action will take place. A URIreference is parsed intowith a fragment identifier may be used to refer to thefour componentssecondary resource without any implication that the primary resource is accessible. However, if that URI is used in a context that does call for retrieval and--is not a same-document reference (Section 4.4), the fragmentidentifier,identifier is only valid asdescribed in Section 4.3.a reference if((not validating)a retrieval action on the primary resource succeeds and(R.scheme == Base.scheme)) then -- A non-validating parser may ignoreresults in aschemerepresentation that defines the fragment. Fragment identifiers have a special role in information systems as the-- reference if it is identicalprimary form of client-side indirect referencing, allowing an author to specifically identify those aspects of an existing resource that are only indirectly provided by thebase URI's scheme. undefine(R.scheme); endif; if defined(R.scheme) then T.scheme = R.scheme; T.authority = R.authority; T.path = R.path; T.query = R.query; else if defined(R.authority) then T.authority = R.authority; T.path = R.path; T.query = R.query; else if (R.path == "") then if defined(R.query) then T.path = Base.path; T.query = R.query; else -- An empty reference refers toresource owner. As such, interpretation of thecurrent document return (current-document, fragment); endif; else if (R.path starts-with "/") then T.path = R.path; else T.path = merge(Base.path, R.path); endif; T.query = R.query; endif; T.authority = Base.authority; endif; T.scheme = Base.scheme; endif; return (T, fragment); The pseudocode above refers to a merge routine for mergingfragment identifier during arelative-path reference withretrieval action is performed solely by thepath ofuser agent; thebase URIfragment identifier is not passed toobtainother systems during thetarget path.process of retrieval. Althoughthere are many waysthis is often perceived todo this, we will describebe asimple method usingloss of information, particularly in regards to accurate redirection of references as content moves over time, it also serves to prevent information providers from denying reference authors the right to selectively refer to information within aseparate string buffer:resource. The characters slash ("/") and question-mark ("?") are allowed to represent data within the fragment identifier, but such use is discouraged for the same reasons as described above for query. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page26]21] Internet-Draft URI Generic SyntaxMarchMay 20031. All but4. Usage When applications make reference to a URI, they do not always use thelast segmentfull form of reference defined by thebase URI's path component is copied"URI" syntax production. In order to save space and take advantage of hierarchical locality, many Internet protocol elements and media type formats allow an abbreviation of a URI, while others restrict thebuffer. In other words, any characters aftersyntax to a particular form of URI. We define thelast (right-most) slash character, if any, are excluded. Ifmost common forms of reference syntax in this specification because they impact and depend upon thebase URI's path component isdesign of theempty string, thengeneric syntax, requiring asingle slash character ("/") is copieduniform parsing algorithm in order tothe buffer. 2.be interpreted consistently. 4.1 URI Reference Thereference's path componentABNF rule URI-reference isappendedused to denote thebuffer string. 3. All occurrencesmost common usage of"./", where "." isacomplete path segment, are removed from the buffer string. 4. Ifresource identifier. URI-reference = URI / relative-URI A URI-reference may be absolute or relative: if thebuffer string ends with "." as a complete path segment, that "." is removed. 5. All occurrencesreference string's prefix matches the syntax of"<segment>/../", where <segment>a scheme followed by its colon separator, then the reference is acomplete path segment not equalURI rather than a relative-URI. A URI-reference is typically parsed first into the five URI components, in order to"..",determine what components areremoved frompresent and whether thebuffer string. Removal of these path segmentsreference isperformed iteratively, removing the leftmost matching pattern onrelative or absolute, and then eachiteration, until no matching pattern remains. 6. If the buffer string endscomponent is parsed for its subparts and their validation. The ABNF of URI-reference, along with"<segment>/..", where <segment>the "first-match-wins" disambiguation rule, isa complete path segment not equalsufficient to"..", that "<segment>/.." is removed. 7. Ifdefine a validating parser for theresulting buffer string still beginsgeneric syntax. Readers familiar withone or more complete path segmentsregular expressions should see Appendix B for an example of a non-validating URI-reference parser that will take any given string and extract the URI components. 4.2 Relative URI A relative URI reference takes advantage of"..", thenthe hier-part syntax (Section 3) in order to express a reference that isconsideredrelative tobe in error. Implementations may handle this error by retaining these components intheresolved path (i.e., treating them as partname space ofthe final URI),another hierarchical URI. relative-URI = hier-part [ "?" query ] [ "#" fragment ] The URI referred to byremoving them from the resolved path (i.e., discardinga relativelevels above the root), orURI reference is obtained byavoiding traversal ofapplying thereference. 8. The remaining buffer string is the target URI's path component. Some systems may find it more efficient to implement the mergerelative resolution algorithmas a pairofpath segment stacks being merged, rather than asSection 5. A relative reference that begins with two slash characters is termed aseries of string pattern replacements. Note: Some WWW client applications will fail to separate the reference's query component from its path component before merging the base andnetwork-path reference; such references are rarely used. A relative referencepaths. This may result inthat begins with aloss of information if the query component contains the strings "/../" or "/./".single slash character is termed an absolute-path reference. A relative reference that does not begin Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page27]22] Internet-Draft URI Generic SyntaxMarchMay 2003The resulting target URI components and fragment canwith a slash character is termed a relative-path reference. A path segment that contains a colon character (e.g., "this:that") cannot berecombinedused as the first segment of a relative-path reference because it might be mistaken for a scheme name. Such a segment must be preceded by a dot-segment (e.g., "./this:that") toprovidemake a relative-path reference. 4.3 Absolute URI Some protocol elements allow only the absolute form of a URI without a fragment identifier. For example, defining the base URIreference. Using pseudocode, this would be: resultfor later use by relative references calls for an absolute-URI production that does not allow a fragment. absolute-URI ="" if defined(T.scheme) then append T.scheme to result; appendscheme ":"to result; endif; if defined(T.authority) then append "//" to result; append T.authority to result; endif; append T.path to result; if defined(T.query) then appendhier-part [ "?" query ] 4.4 Same-document Reference When a URI reference occurring within a document or message refers toresult; append T.query to result; endif; if defined(fragment) then append "#" to result; appenda URI that is, aside from its fragment component (if any), identical toresult; endif; return result; Notethe base URI (Section 5), thatwe must be careful to preservereference is called a "same-document" reference. The most frequent examples of same-document references are relative references that are empty or include only thedistinction betweencrosshatch ("#") separator followed by acomponentfragment identifier. When a same-document reference is dereferenced for the purpose of a retrieval action, the target of that reference isundefined, meaningdefined to be within thatits separator wascurrent document or message; the dereference should notpresentresult in a new retrieval. 4.5 Suffix Reference The URI syntax is designed for unambiguous reference to resources and extensibility via thereference,URI scheme. However, as URI identification and usage have become commonplace, traditional media (television, radio, newspapers, billboards, etc.) have increasingly used acomponent that is empty, meaning thatsuffix of theseparator was presentURI as a reference, consisting of only the authority andwas immediately followed bypath portions of thenext component separatorURI, such as www.w3.org/Addressing/ or simply theend ofDNS hostname on its own. Such references are primarily intended for human interpretation rather than machine, with thereference. Resolution examplesassumption that context-based heuristics areprovided in Appendix C.sufficient to complete the URI (e.g., most hostnames beginning with "www" are likely to have Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page28]23] Internet-Draft URI Generic SyntaxMarchMay 20036.a URINormalization and Comparison Oneprefix ofthe most common operations on URIs"http://"). Although there issimple comparison: determining if two URIs are equivalent without using the URIs to access their respective resource(s). A comparison is performed every time a response cache is accessed, a browser checks its history to color a link, or an XML parser processes tags within a namespace. Extensive normalization prior to comparisonno standard set ofURIs is often used by spiders and indexing engines to pruneheuristics for disambiguating asearch space or reduce duplication of request actions and response storage.URIcomparison is performed in respectsuffix, many client implementations allow them tosome particular purpose, and software with differing purposes will oftenbesubject to differing design trade-offs in regards to how much effortentered by the user and heuristically resolved. It should bespent in reducing duplicate identifiers. This section describes a variety of methodsnoted that such heuristics maybe used to compare URIs, the trade-offs between them, and the types of applications that might use them. 6.1change over time, particularly when new URIEquivalenceschemes are introduced. SinceURIs exist to identify resources, presumably they should be considered equivalent when they identifya URI suffix has the sameresource. However, suchsyntax as adefinition of equivalence is notrelative path reference, a suffix reference cannot be used in contexts where relative URIs are expected. This limits use ofmuch practical use, sincesuffix references to those places where there is noway for softwaredefined base URI, such as dialog boxes and off-line advertisements. Berners-Lee, et al. Expires November 21, 2003 [Page 24] Internet-Draft URI Generic Syntax May 2003 5. Relative Resolution It is often the case that a group or "tree" of documents has been constructed tocompare two resources without knowledge of their origin. For this reason, determination of equivalence or differenceserve a common purpose; the vast majority of URIsis based on string comparison, perhaps augmented by reference to additional rules provided by URI scheme definitions. We use the terms "different" and "equivalent"in these documents point todescriberesources within thepossible outcomestree rather than outside ofsuch comparisons, but thereit. Similarly, documents located at a particular site aremany application-dependent versions of equivalence. Even though it is possiblemuch more likely todetermine that two URIs are equivalent, it is never possiblerefer tobe sureother resources at thattwosite than to resources at remote sites. Relative referencing of URIsidentify different resources. Therefore, comparison methods are designedallows document trees tominimize false negatives while strictly avoiding false positives. In testing for equivalence,be partially independent of their location and access scheme. For instance, it isgenerally unwisepossible for a single set of hypertext documents todirectly compare relative URI references; they shouldbeconvertedsimultaneously accessible and traversable via each of the "file", "http", and "ftp" schemes if the documents refer totheir absolute forms before comparison.each other using relative URIs. Furthermore,when URI references are being compared for the purpose of selecting (or avoiding) a network action,such document trees can be moved, asretrieval ofarepresentation, itwhole, without changing any of the relative references. Experience within the WWW has demonstrated that the ability to perform relative referencing isoftennecessaryto separate fragment identifiers fromfor theURIs prior to comparison. 6.2 Comparison Ladder A varietylong-term usability ofmethods are used in practice to test URI equivalence. These methods fall intoembedded URIs. 5.1 Establishing arange, distinguished by the amount of Berners-Lee, et al. Expires September 1, 2003 [Page 29] Internet-DraftBase URIGeneric Syntax March 2003 processing required andThe term "relative URI" implies that there exists some absolute "base URI" against which thedegreerelative reference is applied. Indeed, the base URI is necessary towhichdefine theprobabilitysemantics offalse negativesany relative URI reference; without it, a relative reference isreduced. As noted above, false negatives cannot in principle be eliminated.meaningless. Inpractice, their probability can be reduced, but this reduction requires more processing and is not cost-effectiveorder forall applications. If this range of comparison practices is considered asrelative URI to be usable within aladder,document, thefollowing discussion will climbbase URI of that document must be known to theladder, starting with thoseparser. A document thatare cheap butcontains relative references must have arelatively higher chance of producing false negatives, and proceeding to thosebase URI thathave higher computational cost and lower risk of false negatives. 6.2.1 Simple String Comparison If two URIs, considered as character strings, are identical, then it is safe to concludecontains a hierarchical path component. In other words, a relative-URI cannot be used within a document thatthey are equivalent. This type of equivalence testhasvery low computational costan unsuitable base URI. Some URI schemes do not allow a hierarchical path component and are thus restricted to full URI references. An authority component isin wide use innot required for avariety of applications, particularly in the domain of parsing. Testing strings for equivalence requires some basic precautions. This procedure is often referredURI scheme toas "bit-for-bit" or "byte-for-byte" comparison, which is potentially misleading. Testing of strings for equality is normally based on pairwise comparison of the characters thatmakeup the strings, starting from the first and proceeding until both strings are exhausted and all characters found to be equal, or a pair of characters compares unequal or oneuse ofthe strings is exhausted before the other. Such character comparisons requirerelative references. A base URI without an authority component implies thateach pair of charactersany relative reference will also beput in comparable form. For example, should onewithout an authority component. The base URIbe stored inof abyte array in EBCDIC encoding, and the seconddocument can be established ina Java String object, bit-for-bit comparisons applied naively will produce both false-positive and false-negative errors. Thus,one of four ways, listed below inprinciple, it is better to speakorder ofequality on a character-for-character rather than byte-for-byte or bit-for-bit basis. Unicode defines a character as being identified by number ("codepoint") with an associated bundleprecedence. The order of precedence can be thought ofvisual and other semantics. At the software level, it is not practical to compare semantic bundles, soinpractical terms, character-by-character comparisons are done codepoint-by-codepoint.terms of layers, where the innermost defined base URI has the highest precedence. This can be visualized graphically as: .----------------------------------------------------------. | .----------------------------------------------------. | | | .----------------------------------------------. | | | | | .----------------------------------------. | | | Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page30]25] Internet-Draft URI Generic SyntaxMarchMay 20036.2.2 Syntax-based Normalization Software may use logic based on the definitions provided by this specification to reduce the probability of false negatives. Such processing is (moderately) higher| | | | .----------------------------------. | | | | | | | | | <relative-reference> | | | | | | | | | `----------------------------------' | | | | | | | | (5.1.1) Base URI embedded incost than character-for-character string comparison. For example, an application using this approach could reasonably considerthefollowing two URIs equivalent: example://a/b/c/%7A eXAMPLE://a/./b/../b/c/%7a Web user agents, such as browsers, typically apply this type| | | | | | | | document's content | | | | | | | `----------------------------------------' | | | | | | (5.1.2) Base URI of the encapsulating entity | | | | | | (message, document, or none). | | | | | `----------------------------------------------' | | | | (5.1.3) URI used to retrieve the entity | | | `----------------------------------------------------' | | (5.1.4) Default Base URInormalization when determining whether a cached responseisavailable. Syntax-based normalization includes such techniques as case normalization, escape normalization, and removal of leftover relative path segments. 6.2.2.1 Case Normalization When aapplication-dependent | `----------------------------------------------------------' 5.1.1 Base URI within Document Content Within certain document media types, the base URIscheme uses elementsof thecommon syntax, it will also usedocument can be embedded within thecommon syntax equivalence rules, namelycontent itself such thatthe scheme and hostname are case insensitive and thereforeit can benormailized to lowercase. For example, the URI <HTTP://www.EXAMPLE.com/> is equivalent to <http://www.example.com/>. 6.2.2.2 Escape Normalization The %-escape mechanism described in Section 2.4 isreadily obtained by afrequent sourceparser. This can be useful for descriptive documents, such as tables ofvariance among otherwise identical URIs. One causecontent, which may be transmitted to others through protocols other than their usual retrieval context (e.g., E-Mail or USENET news). It is beyond thechoicescope ofupper-case or lower-case letters for the hexadecimal digits within the escape sequence (e.g., "%3a" versus "%3A"). Such sequences are always equivalent;this document to specify how, for each media type, thesake of uniformity,base URIgenerators and normalizers are strongly encouragedcan be embedded. It is assumed that user agents manipulating such media types will be able touse upper-case letters forobtain thehex digits A-F. Only characters that are excludedappropriate syntax fromor reserved withinthat media type's specification. An example of how the base URIsyntax mustcan beescaped when used as data. However, someembedded in the Hypertext Markup Language (HTML) [HTML] is provided in Appendix D. A mechanism for embedding the base URIgenerators go beyond thatwithin MIME container types (e.g., the message andescape charactersmultipart types) is defined by MHTML [RFC2110]. Protocols that do notrequire escaping, resulting in URIs that are equivalentuse the MIME message header syntax, but do allow some form of tagged metadata totheir unescaped counterparts. Such URIs canbenormalized by unescaping sequences that representincluded within messages, may define their own syntax for defining theunreserved characters,base URI asdescribed in Section 2.3. 6.2.2.3 Path Segment Normalization The complete path segments "." and ".." havepart of aspecial meaning within hierarchicalmessage. 5.1.2 Base URIschemes. As such, they should not appearfrom the Encapsulating Entity If no base URI is embedded, the base URI of a document is defined by the document's retrieval context. For a document that is enclosed within another entity (such as a message or another document), the retrieval context is that entity; thus, the default base URI of the document is the base URI of the entity in which the document is encapsulated. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page31]26] Internet-Draft URI Generic SyntaxMarchMay 2003absolute5.1.3 Base URIpaths; if they are found, they can be removed by splittingfrom the Retrieval URIjust after the "/" that startsIf no base URI is embedded and thepath, usingdocument is not encapsulated within some other entity (e.g., theleft half astop level of a composite entity), then, if a URI was used to retrieve the base document, that URIandshall be considered theright asbase URI. Note that if the retrieval was the result of arelative reference, and normalizingredirected request, the last URIby merging the two inused (i.e., that which resulted inaccordance withtherelativeactual retrieval of the document) is the base URI. 5.1.4 Default Base URIprocessing algorithm (Section 5). 6.2.3 Scheme-based Normalization The syntax and semanticsIf none ofURIs vary from scheme to scheme, asthe conditions described in above apply, then the base URI is defined by thedefining specification for each scheme. Software may use scheme-specific rules, at further processing cost,context of the application. Since this definition is necessarily application-dependent, failing toreducedefine theprobabilitybase URI using one offalse negatives. For example, Web spiders that populate most large search engines would considerthefollowing two URIs to be equivalent: http://example.com/ http://example.com:80/ This behavior is based onother methods may result in therules providedsame content being interpreted differently by different types of application. It is thesyntax and semanticsresponsibility of the"http"distributor(s) of a document containing a relative URIscheme, which defines an empty port component as being equivalentto ensure that thedefault TCP port for HTTP (port 80). In general, abase URIschemefor thatuses the generic syntax of hostport is defined suchdocument can be established. It must be emphasized that a relative URIwith an explicit ":port",cannot be used reliably in situations where theportdocument's base URI is not well-defined. 5.2 Obtaining thedefaultReferenced URI This section describes an example algorithm forthe scheme, is equivalentresolving URI references that might be relative toone where the porta given base URI. The algorithm iselided. 6.2.4 Protocol-based Normalization Web spiders, for which substantial effortintended toreduceprovide a definitive result that can be used to test theincidenceoutput offalse negativesother implementations. Implementation of the algorithm itself isoften cost-effective, are observed to implement even more aggressive techniques in URI comparison. For example, if they observenot required, but the result given by an implementation must match the result thatawould be given by this algorithm. The base URIsuch as http://example.com/data redirects(Base) is established according tohttp://example.com/data/ they will likely regardthetwo as equivalentrules of Section 5.1 and parsed into the five main components described in Section 3. Note that only thefuture. Obviously, this kind of techniquescheme component isonly appropriaterequired to be present inspecial situations. 6.3 Good Practice When Using URIs Itthe base URI; the other components may be empty or undefined. A component is undefined if its preceding separator does not appear in thebest interests of everyone to avoid false-negatives in comparing URIs, and to only requireURI reference; theminimum amount of software processing for such comparisons. Those who generate and make Berners-Lee, et al. Expires September 1, 2003 [Page 32] Internet-Draftpath component is never undefined, though it may be empty. For each URIGeneric Syntax March 2003referenceto URIs can reduce the cost of processing and(R), therisk of false negatives by consistently providing them in a form thatfollowing pseudocode describes an algorithm for transforming R into its target URI (T): (R.scheme, R.authority, R.path, R.query, R.fragment) = parse(R); -- The URI reference isreasonably canonical with respect to their scheme. Specifically: Always provideparsed into the five URIscheme in lower-case characters. Always provide the hostname,components ifany, in lower-case characters. Only perform %-escaping where it is essential. Always use upper-case A-through-F characters when %-escaping. Use the UTF-8 character-to-octet mapping, whenever possible. Prevent /./((not validating) and/../ from appearing in absolute URI paths. The choices listed above are motivated by observations that(R.scheme == Base.scheme)) then -- A non-validating parser may ignore ahigh proportion of deployed software already use these techniquesscheme inpractice forthepurposes of normalization.Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page33]27] Internet-Draft URI Generic SyntaxMarchMay 20037. Security Considerations A URI does not in itself pose a security threat. However, since URIs are often used to provide a compact set of instructions for access to network resources, care must be taken-- reference if it is identical toproperly interpretthedata within a URI, to prevent that data from causing unintended access, andbase URI's scheme. undefine(R.scheme); endif; if defined(R.scheme) then T.scheme = R.scheme; T.authority = R.authority; T.path = R.path; T.query = R.query; else if defined(R.authority) then T.authority = R.authority; T.path = R.path; T.query = R.query; else if (R.path == "") then T.path = Base.path; if defined(R.query) then T.query = R.query; else T.query = Base.query; endif; else if (R.path starts-with "/") then T.path = R.path; else T.path = merge(Base.path, R.path); endif; T.query = R.query; endif; T.authority = Base.authority; endif; T.scheme = Base.scheme; endif; T.fragment = R.fragment; The pseudocode above refers toavoid including data that should not be revealed in plain text. 7.1 Reliability and Consistency There is no guarantee that, having once usedagivenmerge routine for merging a relative-path reference with the path of the base URI toretrieve some information, thatobtain thesame informationtarget path. Although there are many ways to do this, we willbe retievable by that URI indescribe a simple method using a separate string buffer: 1. All but thefuture. Norlast segment of the base URI's path component istherecopied to the buffer. In other words, anyguarantee thatcharacters after theinformation retrievable via that URI inlast (right-most) slash character, if any, are excluded. If thefuture will be observably similar to that retrieved inbase URI's path component is thepast. The URI syntax does not constrain how a given scheme or authority apportions its namespace or maintains it over time. Suchempty string, then aguarantee can only be obtained from the person(s) controlling that namespace andsingle slash character ("/") is copied to theresource in question. A specificbuffer. Berners-Lee, et al. Expires November 21, 2003 [Page 28] Internet-Draft URIscheme may define additional semantics, such as name persistence, if those semantics are required of all naming authorities for that scheme. 7.2 Malicious Construction ItGeneric Syntax May 2003 2. The reference's path component issometimes possible to construct a URI such that an attemptappended toperform a seemingly harmless, idempotent operation, such astheretrievalbuffer string. 3. All occurrences ofa representation associated with a resource, will in fact cause a possibly damaging remote operation to occur. The unsafe URI"./", where "." istypically constructed by specifyingaport number other than that reserved forcomplete path segment, are removed from thenetwork protocol in question. The client unwittingly contactsbuffer string. 4. If the buffer string ends with "." as asitecomplete path segment, that "." isin fact running a different protocol. The contentremoved. 5. All occurrences ofthe URI contains instructions that, when interpreted according"<segment>/../", where <segment> is a complete path segment not equal tothis other protocol, cause an unexpected operation. An example has been"..", are removed from theusebuffer string. Removal of these path segments is performed iteratively, removing the leftmost matching pattern on each iteration, until no matching pattern remains. 6. If the buffer string ends with "<segment>/..", where <segment> is agopher URIcomplete path segment not equal tocause an unintended"..", that "<segment>/.." is removed. 7. If the resulting buffer string still begins with one orimpersonating messagemore complete path segments of "..", then the reference is considered to besent via a SMTP server. Caution should be used when using any URI that specifies a TCP port number other thanin error. Implementations may handle this error by removing them from thedefault forresolved path (i.e., discarding relative levels above theprotocol, especially when itroot) or by avoiding traversal of the reference. 8. The remaining buffer string isa number withinthereserved space. Care should be taken whentarget URI's path component. Some systems may find it more efficient to implement the merge algorithm as aURI contains escaped delimiters forpair of path segment stacks being merged, rather than as agiven protocol (for example, CR and LF characters for telnet protocols) that these are not unescapedseries of string pattern replacements. Note: Some WWW client applications will fail to separate the reference's query component from its path component beforetransmission.merging the base and reference paths. Thismight violatemay result in a loss of information if theprotocol, but avoidsquery component contains thepotential for such characters tostrings "/../" or "/./". 5.3 Recomposition of a Parsed URI Parsed URI components can beusedrecombined tosimulate an extra operation or parameter in that protocol, which might leadobtain the referenced URI. Using pseudocode, this would be: result = "" if defined(T.scheme) then append T.scheme toan unexpected and possibly harmful remote operation being performed.result; append ":" to result; endif; Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page34]29] Internet-Draft URI Generic SyntaxMarchMay 20037.3 Rare IP Address Formats Although the URI syntax for IPv4address only allows the common, dotted-decimal form of IPv4 address literal, many implementations that process URIs make use of platform-dependent system routines, such as gethostbyname() and inet_aton(),if defined(T.authority) then append "//" totranslate the string literalresult; append T.authority toan actual IP address. Unfortunately, such system routines often allow and process a much larger set of formats than those described in Section 3.2.2. For example, many implementations allow dotted forms of three numbers, wherein the last part is interpreted as a 16-bit quantity and placed in the right-most two bytes ofresult; endif; append T.path to result; if defined(T.query) then append "?" to result; append T.query to result; endif; if defined(fragment) then append "#" to result; append fragment to result; endif; return result; Note that we are careful to preserve thenetwork address (e.g., a Class B network). Likewise,distinction between adotted form of two numbers means the last partcomponent that isinterpreted as a 24-bit quantity and placedundefined, meaning that its separator was not present in theright most three bytes of the network address (Class A),reference, and asingle number (without dots)component that isinterpreted as a 32-bit quantity and stored directly inempty, meaning that thenetwork address. Adding further toseparator was present and was immediately followed by theconfusion, some implementations allow each dotted part to be interpreted as decimal, octal,next component separator orhexadecimal, as specified intheC language (i.e.,end of the reference. 5.4 Examples of Relative Resolution Within an object with aleading 0x or 0X implies hexadecimal; otherwise,well-defined base URI of http://a/b/c/d;p?q aleading 0 implies octal; otherwise, the number is interpreted as decimal). These additional IP address formats are not allowed in therelative URIsyntax due to differences between platform implementations. However, they can become a security concern if an application attempts to filter access to resources based on the IP address in string literal format. If such filtering is performed, it is recommended that literals be converted to numeric form and filtered based on the numeric value, rather than a prefix or suffix of the string form. 7.4 Sensitive Information It is clearly unwise to use a URI that contains a password which is intended to be secret. In particular, the use of a password within the userinfo component of a URI is strongly discouraged except in those rare cases where the 'password' parameter is intended toreference would bepublic.resolved as follows: 5.4.1 Normal Examples "g:h" = "g:h" "g" = "http://a/b/c/g" "./g" = "http://a/b/c/g" "g/" = "http://a/b/c/g/" "/g" = "http://a/g" "//g" = "http://g" "?y" = "http://a/b/c/d;p?y" "g?y" = "http://a/b/c/g?y" "#s" = "http://a/b/c/d;p?q#s" "g#s" = "http://a/b/c/g#s" "g?y#s" = "http://a/b/c/g?y#s" ";x" = "http://a/b/c/;x" "g;x" = "http://a/b/c/g;x" Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page35]30] Internet-Draft URI Generic SyntaxMarchMay 20037.5 Semantic Attacks Because"g;x?y#s" = "http://a/b/c/g;x?y#s" "." = "http://a/b/c/" "./" = "http://a/b/c/" ".." = "http://a/b/" "../" = "http://a/b/" "../g" = "http://a/b/g" "../.." = "http://a/" "../../" = "http://a/" "../../g" = "http://a/g" 5.4.2 Abnormal Examples Although theuserinfo component is rarely used and appears beforefollowing abnormal examples are unlikely to occur in normal practice, all URI parsers should be capable of resolving them consistently. Each example uses thehostnamesame base as above. An empty reference refers to the current base URI. "" = "http://a/b/c/d;p?q" Parsers must be careful in handling theauthority component, it cancase where there are more relative path ".." segments than there are hierarchical levels in the base URI's path. Note that the ".." syntax cannot be used toconstruct a URI that is intended to misleadchange the authority component of ahuman user by appearing to identify one (trusted) naming authority while actually identifying a different authority hidden behind the noise. For example http://www.example.com&story=breaking_news@10.0.0.1/top_story.htm might lead a human user to assume that the authority is 'www.example.com', whereas it is actually '10.0.0.1'. Note that the misleading userinfo could be much longer than the example above. A misleading URI, such as the one above, is an attack on the user's preconceived notions aboutURI. "../../../g" = "http://a/g" "../../../../g" = "http://a/g" Similarly, parsers should remove themeaningdot-segments "." and ".." when they are complete components of aURI, rather than an attack on the software itself. User agents may be able to reduce the impact of such attacks by visually distinguishing the various componentspath, but not when they are only part of a segment. "/./g" = "http://a/g" "/../g" = "http://a/g" "g." = "http://a/b/c/g." ".g" = "http://a/b/c/.g" "g.." = "http://a/b/c/g.." "..g" = "http://a/b/c/..g" Less likely are cases where the relative URIwhen rendered, such as by using a different coloruses unnecessary ortone to render userinfo if any is present, though there is no general panacea. More information on URI-based semantic attacks can be found in [Siedzik].nonsensical forms of the "." and ".." complete path segments. "./../g" = "http://a/b/g" "./g/." = "http://a/b/c/g/" "g/./h" = "http://a/b/c/g/h" "g/../h" = "http://a/b/c/h" "g;x=1/./y" = "http://a/b/c/g;x=1/y" Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page36]31] Internet-Draft URI Generic SyntaxMarchMay 20038. Acknowledgements"g;x=1/../y" = "http://a/b/c/y" Some applications fail to separate the reference's query and/or fragment components from a relative path before merging it with the base path. Thisdocumenterror isderived from RFC 2396 [RFC2396], RFC 1808 [RFC1808], and RFC 1738 [RFC1738];rarely noticed, since typical usage of a fragment never includes theacknowledgements in those specifications still apply. It also incorporateshierarchy ("/") character, and theupdate (with corrections) for IPv6 literals inquery component is not normally used within relative references. "g?y/./x" = "http://a/b/c/g?y/./x" "g?y/../x" = "http://a/b/c/g?y/../x" "g#s/./x" = "http://a/b/c/g#s/./x" "g#s/../x" = "http://a/b/c/g#s/../x" Some parsers allow thehost syntax,scheme name to be present in a relative URI if it is the same asdefined by Robert M. Hinden, Brian E. Carpenter, and Larry Masinterthe base URI scheme. This is considered to be a loophole in[RFC2732]. In addition, contributions by Reese Anschultz, Tim Bray, Dan Connolly, Adam M. Costello, Jason Diamond, Martin Duerst, Henry Holtzman, Graham Klyne, Dan Kohn, Bruce Lilly, Michael Mealling, Julian Reschke, Tomas Rokicki, Miles Sabin, Ronald Tschalaer, Marc Warne, Henry Zongaro, and Zefram are gratefully acknowledged. Berners-Lee, et al. Expires September 1, 2003 [Page 37] Internet-Draftprior specifications of partial URIGeneric Syntax March 2003 Normative References [ASCII] American National Standards Institute, "Coded Character Set -- 7-bit American Standard Code[RFC1630]. Its use should be avoided, but is allowed forInformation Interchange", ANSI X3.4, 1986. [RFC2234] Crocker, D. and P. Overell, "Augmented BNFbackward compatibility. "http:g" = "http:g" ; forSyntax Specifications: ABNF", RFC 2234, November 1997.validating parsers / "http://a/b/c/g" ; for backward compatibility Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page38]32] Internet-Draft URI Generic SyntaxMarchMay 2003Non-normative References [RFC2277] Alvestrand, H., "IETF Policy on Character Sets and Languages", BCP 18, RFC 2277, January 1998. [RFC1630] Berners-Lee, T., "Universal Resource Identifiers in WWW: A Unifying Syntax for the Expression of Names6. Normalization andAddressesComparison One ofObjects ontheNetwork as used inmost common operations on URIs is simple comparison: determining if two URIs are equivalent without using theWorld-Wide Web", RFC 1630, June 1994. [RFC1738] Berners-Lee, T., Masinter, L. and M. McCahill, "Uniform Resource Locators (URL)", RFC 1738, December 1994. [RFC2396] Berners-Lee, T., Fielding, R.URIs to access their respective resource(s). A comparison is performed every time a response cache is accessed, a browser checks its history to color a link, or an XML parser processes tags within a namespace. Extensive normalization prior to comparison of URIs is often used by spiders andL. Masinter, "Uniform Resource Identifiers (URI): Generic Syntax", RFC 2396, August 1998. [RFC1123] Braden, R., "Requirements for Internet Hosts - Applicationindexing engines to prune a search space or reduce duplication of request actions andSupport", STD 3, RFC 1123, October 1989. [RFC1808] Fielding, R., "Relative Uniform Resource Locators", RFC 1808, June 1995. [RFC2046] Freed, N.response storage. URI comparison is performed in respect to some particular purpose, andN. Borenstein, "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types", RFC 2046, November 1996. [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S.software with differing purposes will often be subject to differing design trade-offs in regards to how much effort should be spent in reducing duplicate identifiers. This section describes a variety of methods that may be used to compare URIs, the trade-offs between them, andD. Jensen, "HTTP Extensionsthe types of applications that might use them. 6.1 Equivalence Since URIs exist to identify resources, presumably they should be considered equivalent when they identify the same resource. However, such a definition of equivalence is not of much practical use, since there is no way forDistributed Authoring -- WEBDAV", RFC 2518, February 1999. [RFC0952] Harrenstien, K., Stahl, M. and E. Feinler, "DoD Internet host table specification", RFC 952, October 1985. [RFC2373] Hinden, R. and S. Deering, "IP Version 6 Addressing Architecture", RFC 2373, July 1998. [RFC2732] Hinden, R., Carpenter, B.software to compare two resources without knowledge of their origin. For this reason, determination of equivalence or difference of URIs is based on string comparison, perhaps augmented by reference to additional rules provided by URI scheme definitions. We use the terms "different" andL. Masinter, "Format for Literal IPv6 Addresses in URL's", RFC 2732, December 1999. [RFC1736] Kunze, J., "Functional Recommendations"equivalent" to describe the possible outcomes of such comparisons, but there are many application-dependent versions of equivalence. Even though it is possible to determine that two URIs are equivalent, it is never possible to be sure that two URIs identify different resources. Therefore, comparison methods are designed to minimize false negatives while strictly avoiding false positives. In testing forInternet Resource Locators", RFC 1736, February 1995. [RFC1737] Masinter, L. and K. Sollins, "Functional Requirementsequivalence, it is generally unwise to directly compare relative URI references; they should be converted to their absolute forms before comparison. Furthermore, when URI references are being compared forUniform Resource Names", RFC 1737, December 1994. [RFC1034] Mockapetris, P., "Domain names - concepts and facilities", STD 13, RFC 1034,the purpose of selecting (or avoiding) a network action, such as retrieval of a representation, it is often necessary to remove fragment identifiers from the URIs prior to comparison. 6.2 Comparison Ladder A variety of methods are used in practice to test URI equivalence. These methods fall into a range, distinguished by the amount of Berners-Lee, et al. Expires November1987.21, 2003 [Page 33] Internet-Draft URI Generic Syntax May 2003 processing required and the degree to which the probability of false negatives is reduced. As noted above, false negatives cannot in principle be eliminated. In practice, their probability can be reduced, but this reduction requires more processing and is not cost-effective for all applications. If this range of comparison practices is considered as a ladder, the following discussion will climb the ladder, starting with those that are cheap but have a relatively higher chance of producing false negatives, and proceeding to those that have higher computational cost and lower risk of false negatives. 6.2.1 Simple String Comparison If two URIs, considered as character strings, are identical, then it is safe to conclude that they are equivalent. This type of equivalence test has very low computational cost and is in wide use in a variety of applications, particularly in the domain of parsing. Testing strings for equivalence requires some basic precautions. This procedure is often referred to as "bit-for-bit" or "byte-for-byte" comparison, which is potentially misleading. Testing of strings for equality is normally based on pairwise comparison of the characters that make up the strings, starting from the first and proceeding until both strings are exhausted and all characters found to be equal, a pair of characters compares unequal, or one of the strings is exhausted before the other. Such character comparisons require that each pair of characters be put in comparable form. For example, should one URI be stored in a byte array in EBCDIC encoding, and the second be in a Java String object, bit-for-bit comparisons applied naively will produce both false-positive and false-negative errors. Thus, in principle, it is better to speak of equality on a character-for-character rather than byte-for-byte or bit-for-bit basis. Unicode defines a character as being identified by number ("codepoint") with an associated bundle of visual and other semantics. At the software level, it is not practical to compare semantic bundles, so in practical terms, character-by-character comparisons are done codepoint-by-codepoint. Berners-Lee, et al. Expires November 21, 2003 [Page 34] Internet-Draft URI Generic Syntax May 2003 6.2.2 Syntax-based Normalization Software may use logic based on the definitions provided by this specification to reduce the probability of false negatives. Such processing is moderately higher in cost than character-for-character string comparison. For example, an application using this approach could reasonably consider the following two URIs equivalent: example://a/b/c/%7A eXAMPLE://a/./b/../b/c/%7a Web user agents, such as browsers, typically apply this type of URI normalization when determining whether a cached response is available. Syntax-based normalization includes such techniques as case normalization, escape normalization, and removal of leftover relative path segments. 6.2.2.1 Case Normalization When a URI scheme uses components of the generic syntax, it will also use the common syntax equivalence rules, namely that the scheme and hostname are case insensitive and therefore can be normalized to lowercase. For example, the URI <HTTP://www.EXAMPLE.com/> is equivalent to <http://www.example.com/>. 6.2.2.2 Escape Normalization The percent-escape mechanism described in Section 2.4 is a frequent source of variance among otherwise identical URIs. One cause is the choice of uppercase or lowercase letters for the hexadecimal digits within the escape sequence (e.g., "%3a" versus "%3A"). Such sequences are always equivalent; for the sake of uniformity, URI generators and normalizers are strongly encouraged to use uppercase letters for the hex digits A-F. Only characters that are excluded from or reserved within the URI syntax must be escaped when used as data. However, some URI generators go beyond that and escape characters that do not require escaping, resulting in URIs that are equivalent to their unescaped counterparts. Such URIs can be normalized by unescaping sequences that represent the unreserved characters, as described in Section 2.3. 6.2.2.3 Path Segment Normalization The complete path segments "." and ".." have a special meaning within hierarchical URI schemes. As such, they should not appear in absolute URI paths; if they are found, they can be removed by Berners-Lee, et al. Expires November 21, 2003 [Page 35] Internet-Draft URI Generic Syntax May 2003 splitting the URI just after the "/" that starts the path, using the left half as the base URI and the right as a relative reference, and normalizing the URI by merging the two in in accordance with the relative URI processing algorithm (Section 5). 6.2.3 Scheme-based Normalization The syntax and semantics of URIs vary from scheme to scheme, as described by the defining specification for each scheme. Software may use scheme-specific rules, at further processing cost, to reduce the probability of false negatives. For example, Web spiders that populate most large search engines would consider the following two URIs to be equivalent: http://example.com/ http://example.com:80/ This behavior is based on the rules provided by the syntax and semantics of the "http" URI scheme, which defines an empty port component as being equivalent to the default TCP port for HTTP (port 80). In general, a URI scheme that uses the generic syntax for authority is defined such that a URI with an explicit ":port", where the port is the default for the scheme, is equivalent to one where the port is elided. 6.2.4 Protocol-based Normalization Web spiders, for which substantial effort to reduce the incidence of false negatives is often cost-effective, are observed to implement even more aggressive techniques in URI comparison. For example, if they observe that a URI such as http://example.com/data redirects to http://example.com/data/ they will likely regard the two as equivalent in the future. Obviously, this kind of technique is only appropriate in special situations. 6.3 Canonical Form It is in the best interests of everyone to avoid false-negatives in comparing URIs and to minimize the amount of software processing for such comparisons. Those who generate and make reference to URIs can reduce the cost of processing and the risk of false negatives by Berners-Lee, et al. Expires November 21, 2003 [Page 36] Internet-Draft URI Generic Syntax May 2003 consistently providing them in a form that is reasonably canonical with respect to their scheme. Specifically: Always provide the URI scheme in lowercase characters. Always provide the hostname, if any, in lowercase characters. Only perform percent-escaping where it is essential. Always use uppercase A-through-F characters when percent-escaping. Prevent /./ and /../ from appearing in non-relative URI paths. The good practices listed above are motivated by observations that a high proportion of deployed software use these techniques for the purposes of normalization. Berners-Lee, et al. Expires November 21, 2003 [Page 37] Internet-Draft URI Generic Syntax May 2003 7. Security Considerations A URI does not in itself pose a security threat. However, since URIs are often used to provide a compact set of instructions for access to network resources, care must be taken to properly interpret the data within a URI, to prevent that data from causing unintended access, and to avoid including data that should not be revealed in plain text. 7.1 Reliability and Consistency There is no guarantee that, having once used a given URI to retrieve some information, that the same information will be retrievable by that URI in the future. Nor is there any guarantee that the information retrievable via that URI in the future will be observably similar to that retrieved in the past. The URI syntax does not constrain how a given scheme or authority apportions its name space or maintains it over time. Such a guarantee can only be obtained from the person(s) controlling that name space and the resource in question. A specific URI scheme may define additional semantics, such as name persistence, if those semantics are required of all naming authorities for that scheme. 7.2 Malicious Construction It is sometimes possible to construct a URI such that an attempt to perform a seemingly harmless, idempotent operation, such as the retrieval of a representation, will in fact cause a possibly damaging remote operation to occur. The unsafe URI is typically constructed by specifying a port number other than that reserved for the network protocol in question. The client unwittingly contacts a site that is running a different protocol service. The content of the URI contains instructions that, when interpreted according to this other protocol, cause an unexpected operation. An example has been the use of a gopher URI to cause an unintended or impersonating message to be sent via a SMTP server. Caution should be used when dereferencing a URI that specifies a TCP port number other than the default for the scheme, especially when it is a number within the reserved space. Care should be taken when a URI contains escaped delimiters for a given protocol (for example, CR and LF characters for telnet protocols) that these octets are not unescaped before transmission. This might violate the protocol, but avoids the potential for such characters to be used to simulate an extra operation or parameter in that protocol which might lead to an unexpected and possibly harmful remote operation being performed. Berners-Lee, et al. Expires November 21, 2003 [Page 38] Internet-Draft URI Generic Syntax May 2003 7.3 Rare IP Address Formats Although the URI syntax for IPv4address only allows the common, dotted-decimal form of IPv4 address literal, many implementations that process URIs make use of platform-dependent system routines, such as gethostbyname() and inet_aton(), to translate the string literal to an actual IP address. Unfortunately, such system routines often allow and process a much larger set of formats than those described in Section 3.2.2. For example, many implementations allow dotted forms of three numbers, wherein the last part is interpreted as a 16-bit quantity and placed in the right-most two bytes of the network address (e.g., a Class B network). Likewise, a dotted form of two numbers means the last part is interpreted as a 24-bit quantity and placed in the right most three bytes of the network address (Class A), and a single number (without dots) is interpreted as a 32-bit quantity and stored directly in the network address. Adding further to the confusion, some implementations allow each dotted part to be interpreted as decimal, octal, or hexadecimal, as specified in the C language (i.e., a leading 0x or 0X implies hexadecimal; otherwise, a leading 0 implies octal; otherwise, the number is interpreted as decimal). These additional IP address formats are not allowed in the URI syntax due to differences between platform implementations. However, they can become a security concern if an application attempts to filter access to resources based on the IP address in string literal format. If such filtering is performed, it is recommended that literals be converted to numeric form and filtered based on the numeric value, rather than a prefix or suffix of the string form. 7.4 Sensitive Information It is clearly unwise to use a URI that contains a password which is intended to be secret. In particular, the use of a password within the userinfo component of a URI is strongly discouraged except in those rare cases where the 'password' parameter is intended to be public. 7.5 Semantic Attacks Because the userinfo component is rarely used and appears before the hostname in the authority component, it can be used to construct a URI that is intended to mislead a human user by appearing to identify one (trusted) naming authority while actually identifying a different authority hidden behind the noise. For example http://www.example.com&story=breaking_news@10.0.0.1/top_story.htm Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page 39] Internet-Draft URI Generic SyntaxMarchMay 2003[RFC2110] Palme, J. and A. Hopmann, "MIME E-mail Encapsulation of Aggregate Documents,might lead a human user to assume that the host is 'www.example.com', whereas it is actually '10.0.0.1'. Note that the misleading userinfo could be much longer than the example above. A misleading URI, such asHTML (MHTML)", RFC 2110, March 1997. [RFC2717] Petke, R. and I. King, "Registration Procedures for URL Scheme Names", BCP 35, RFC 2717, November 1999. [HTML] Raggett, D., Le Hors, A. and I. Jacobs, "Hypertext Markup Language (HTML 4.01) Specification", December 1999. [Siedzik] Siedzik, R., "Semantic Attacks: What's in a URL?", April 2001. [UTF-8] Yergeau, F., "UTF-8,the one above, is an attack on the user's preconceived notions about the meaning of atransformation formatURI, rather than an attack on the software itself. User agents may be able to reduce the impact ofISO 10646", RFC 2279, January 1998. Authors' Addresses Tim Berners-Lee World Wide Web Consortium MIT/LCS, Room NE43-356 200 Technology Square Cambridge, MA 02139 USA Phone: +1-617-253-5702 Fax: +1-617-258-5999 EMail: timbl@w3.org URI: http://www.w3.org/People/Berners-Lee/ Roy T. Fielding Day Software 2 Corporate Plaza, Suite 150 Newport Beach, CA 92660 USA Phone: +1-949-999-2523 Fax: +1-949-644-5064 EMail: roy.fielding@day.com URI: http://www.apache.org/~fielding/such attacks by visually distinguishing the various components of the URI when rendered, such as by using a different color or tone to render userinfo if any is present, though there is no general panacea. More information on URI-based semantic attacks can be found in [Siedzik]. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page 40] Internet-Draft URI Generic SyntaxMarchMay 2003 8. Acknowledgments This document is derived from RFC 2396 [RFC2396], RFC 1808 [RFC1808], and RFC 1738 [RFC1738]; the acknowledgments in those specifications still apply. It also incorporates the update (with corrections) for IPv6 literals in the host syntax, as defined by Robert M. Hinden, Brian E. Carpenter, and Larry MasinterAdobe Systems Incorporated 345 Park Ave San Jose, CA 95110 USA Phone: +1-408-536-3024 EMail: LMM@acm.org URI: http://larry.masinter.net/in [RFC2732]. In addition, contributions by Reese Anschultz, Tim Bray, Rob Cameron, Dan Connolly, Adam M. Costello, Jason Diamond, Martin Duerst, Stefan Eissing, Clive D.W. Feather, Pat Hayes, Henry Holtzman, Graham Klyne, Dan Kohn, Bruce Lilly, Andrew Main, Michael Mealling, Julian Reschke, Tomas Rokicki, Miles Sabin, Ronald Tschalaer, Marc Warne, Stuart Williams, and Henry Zongaro are gratefully acknowledged. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page 41] Internet-Draft URI Generic SyntaxMarchMay 2003Appendix A. CollectedNormative References [ASCII] American National Standards Institute, "Coded Character Set -- 7-bit American Standard Code for Information Interchange", ANSI X3.4, 1986. [RFC2234] Crocker, D. and P. Overell, "Augmented BNF forURI To be filled-in later.Syntax Specifications: ABNF", RFC 2234, November 1997. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page 42] Internet-Draft URI Generic SyntaxMarchMay 2003Appendix B. Parsing a URI Reference with a Regular Expression As described in Section 4.3, the generic URI syntax is not sufficient to disambiguate the components of some forms of URI. Since the "greedy algorithm" described in that section is identical to the disambiguation method used by POSIX regular expressions, it is naturalInformative References [RFC2277] Alvestrand, H., "IETF Policy on Character Sets andcommonplace to use a regular expression for parsing the potential four componentsLanguages", BCP 18, RFC 2277, January 1998. [RFC1630] Berners-Lee, T., "Universal Resource Identifiers in WWW: A Unifying Syntax for the Expression of Names andfragment identifierAddresses ofa URI reference. The following line isObjects on theregular expression for breaking-down a URI reference into its components. ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))? 12 3 4 5 6 7 8 9 The numbersNetwork as used in thesecond line above are only to assist readability; they indicate the reference pointsWorld-Wide Web", RFC 1630, June 1994. [RFC1738] Berners-Lee, T., Masinter, L. and M. McCahill, "Uniform Resource Locators (URL)", RFC 1738, December 1994. [RFC2396] Berners-Lee, T., Fielding, R. and L. Masinter, "Uniform Resource Identifiers (URI): Generic Syntax", RFC 2396, August 1998. [RFC1123] Braden, R., "Requirements foreach subexpression (i.e., each paired parenthesis). We refer to the value matchedInternet Hosts - Application and Support", STD 3, RFC 1123, October 1989. [RFC1808] Fielding, R., "Relative Uniform Resource Locators", RFC 1808, June 1995. [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types", RFC 2046, November 1996. [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S. and D. Jensen, "HTTP Extensions forsubexpression <n> as $<n>. For example, matching the above expression to http://www.ics.uci.edu/pub/ietf/uri/#Related results in the following subexpression matches: $1 = http: $2 = http $3 = //www.ics.uci.edu $4 = www.ics.uci.edu $5 = /pub/ietf/uri/ $6 = <undefined> $7 = <undefined> $8 = #Related $9 = Related where <undefined> indicates that the component is not present, as is the caseDistributed Authoring -- WEBDAV", RFC 2518, February 1999. [RFC0952] Harrenstien, K., Stahl, M. and E. Feinler, "DoD Internet host table specification", RFC 952, October 1985. [RFC3513] Hinden, R. and S. Deering, "Internet Protocol Version 6 (IPv6) Addressing Architecture", RFC 3513, April 2003. [RFC2732] Hinden, R., Carpenter, B. and L. Masinter, "Format forthe query componentLiteral IPv6 Addresses inthe above example. Therefore, we can determine the value of the four componentsURL's", RFC 2732, December 1999. [RFC1736] Kunze, J., "Functional Recommendations for Internet Resource Locators", RFC 1736, February 1995. [RFC1737] Masinter, L. andfragmentK. Sollins, "Functional Requirements for Uniform Resource Names", RFC 1737, December 1994. [RFC2141] Moats, R., "URN Syntax", RFC 2141, May 1997. Berners-Lee, et al. Expires November 21, 2003 [Page 43] Internet-Draft URI Generic Syntax May 2003 [RFC1034] Mockapetris, P., "Domain names - concepts and facilities", STD 13, RFC 1034, November 1987. [RFC2110] Palme, J. and A. Hopmann, "MIME E-mail Encapsulation of Aggregate Documents, such asscheme = $2 authority = $4 path = $5 query = $7 fragment = $9 and, goingHTML (MHTML)", RFC 2110, March 1997. [RFC2717] Petke, R. and I. King, "Registration Procedures for URL Scheme Names", BCP 35, RFC 2717, November 1999. [HTML] Raggett, D., Le Hors, A. and I. Jacobs, "Hypertext Markup Language (HTML 4.01) Specification", December 1999. [Siedzik] Siedzik, R., "Semantic Attacks: What's inthe opposite direction, we can recreateaURI reference from its components using the algorithmURL?", April 2001. [UTF-8] Yergeau, F., "UTF-8, a transformation format ofSection 5.2.ISO 10646", RFC 2279, January 1998. Berners-Lee, et al. Expires November 21, 2003 [Page 44] Internet-Draft URI Generic Syntax May 2003 Authors' Addresses Tim Berners-Lee World Wide Web Consortium MIT/LCS, Room NE43-356 200 Technology Square Cambridge, MA 02139 USA Phone: +1-617-253-5702 Fax: +1-617-258-5999 EMail: timbl@w3.org URI: http://www.w3.org/People/Berners-Lee/ Roy T. Fielding Day Software 2 Corporate Plaza, Suite 150 Newport Beach, CA 92660 USA Phone: +1-949-999-2523 Fax: +1-949-644-5064 EMail: roy.fielding@day.com URI: http://www.apache.org/~fielding/ Larry Masinter Adobe Systems Incorporated 345 Park Ave San Jose, CA 95110 USA Phone: +1-408-536-3024 EMail: LMM@acm.org URI: http://larry.masinter.net/ Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page43]45] Internet-Draft URI Generic SyntaxMarchMay 2003 AppendixC. Examples of Resolving Relative URI References Within an object with a well-defined base URI of http://a/b/c/d;p?q the relative URI would be resolved as follows: C.1 Normal Examples g:h = g:h g = http://a/b/c/g ./g = http://a/b/c/g g/ = http://a/b/c/g/ /g = http://a/g //g = http://g ?y = http://a/b/c/d;p?y g?y = http://a/b/c/g?y #s = (current document)#s g#s = http://a/b/c/g#s g?y#s = http://a/b/c/g?y#s ;x = http://a/b/c/;x g;x = http://a/b/c/g;x g;x?y#s = http://a/b/c/g;x?y#s . = http://a/b/c/ ./ = http://a/b/c/ .. = http://a/b/ ../ = http://a/b/ ../g = http://a/b/g ../.. = http://a/ ../../ = http://a/ ../../g = http://a/g C.2 Abnormal Examples Although the following abnormal examples are unlikely to occur in normal practice, allA. Collected ABNF for URIparsers should be capable of resolving them consistently. Each example uses the same base as above. An empty reference refers to the start of the current document. <> = (current document) Parsers must be careful in handling the case where there are more relative path ".." segments than there are hierarchical levels in the base URI's path. Note that the ".." syntax cannotTo beused to change the authority component of a URI.filled-in later. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page44]46] Internet-Draft URI Generic SyntaxMarchMay 2003../../../g = http://a/../g ../../../../g = http://a/../../g In practice, some implementations strip leading relative symbolic elements (".", "..") after applyingAppendix B. Parsing arelativeURIcalculation, based onReference with a Regular Expression Since the "first-match-wins" algorithm is identical to the "greedy" disambiguation method used by POSIX regular expressions, it is natural and commonplace to use a regular expression for parsing the potential five components of a URI reference. The following line is the regular expression for breaking-down a well-formed URI reference into its components. ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))? 12 3 4 5 6 7 8 9 The numbers in thetheory that compensating for obvious author errors is better than allowingsecond line above are only to assist readability; they indicate therequestreference points for each subexpression (i.e., each paired parenthesis). We refer tofail. Thus,theabove two references will be interpreted as "http://a/g" by some implementations. Similarly, parsers must avoid treating "." and ".."value matched for subexpression <n> asspecial when they are not complete components of a relative path. /./g = http://a/./g /../g = http://a/../g g. = http://a/b/c/g. .g$<n>. For example, matching the above expression to http://www.ics.uci.edu/pub/ietf/uri/#Related results in the following subexpression matches: $1 =http://a/b/c/.g g..http: $2 =http://a/b/c/g.. ..ghttp $3 =http://a/b/c/..g Less likely are cases where the relative URI uses unnecessary or nonsensical forms of the "." and ".." complete path segments. ./../g//www.ics.uci.edu $4 =http://a/b/g ./g/.www.ics.uci.edu $5 =http://a/b/c/g/ g/./h/pub/ietf/uri/ $6 =http://a/b/c/g/h g/../h<undefined> $7 =http://a/b/c/h g;x=1/./y<undefined> $8 =http://a/b/c/g;x=1/y g;x=1/../y#Related $9 =http://a/b/c/y Some applications fail to separate the reference's query and/or fragment components from a relative path before merging it withRelated where <undefined> indicates that thebase path. This errorcomponent is not present, as israrely noticed, since typical usage of a fragment never includesthehierarchy ("/") character, andcase for the query componentis not normally used within relative references. g?y/./x = http://a/b/c/g?y/./x g?y/../x = http://a/b/c/g?y/../x g#s/./x = http://a/b/c/g#s/./x g#s/../x = http://a/b/c/g#s/../x Some parsers allow the scheme name to be presentina relative URI if it isthesame asabove example. Therefore, we can determine thebase URI scheme. This is considered to be a loophole in prior specificationsvalue ofpartial URI [RFC1630]. Its use should be avoided, but is allowed for backwards compatibility. http:gthe four components and fragment as scheme = $2 authority = $4 path = $5 query =http:g ; for validating parsers / http://a/b/c/g ; for backwards compatibility$7 fragment = $9 and, going in the opposite direction, we can recreate a URI reference from its components using the algorithm of Section 5.3. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page45]47] Internet-Draft URI Generic SyntaxMarchMay 2003 AppendixD.C. Embedding the Base URI in HTML documents It is useful to consider an example of how the base URI of a document can be embedded within the document's content. In this appendix, we describe how documents written in the Hypertext Markup Language (HTML) [HTML] can include an embedded base URI. This appendix does not form a part of the URI specification and should not be considered as anything more than a descriptive example. HTML defines a special element "BASE" which, when present in the "HEAD" portion of a document, signals that the parser should use the BASE element's "HREF" attribute as the base URI for resolving any relative URI. The "HREF" attribute must be an absolute URI. Note that, in HTML, element and attribute names are case-insensitive. For example: <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML><HEAD> <TITLE>An example HTML document</TITLE> <BASE href="http://www.example.com/Test/a/b/c"> </HEAD><BODY> ... <A href="../x">a hypertext anchor</A> ... </BODY></HTML> A parser reading the example document should interpret the given relative URI "../x" as representing the absolute URI <http://www.example.com/Test/a/x> regardless of the context in which the example document was obtained. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page46]48] Internet-Draft URI Generic SyntaxMarchMay 2003 AppendixE. Recommendations forD. Delimiting a URI in Context URIs are often transmitted through formats that do not provide a clear context for their interpretation. For example, there are many occasions when a URI is included in plain text; examples include text sent in electronic mail, USENET news messages, and, most importantly, printed on paper. In such cases, it is important to be able to delimit the URI from the rest of the text, and in particular from punctuation marks that might be mistaken for part of the URI. In practice, URI are delimited in a variety of ways, but usually within double-quotes "http://example.com/", angle brackets <http:// example.com/>, or just using whitespace http://example.com/ These wrappers do not form part of the URI. In the case where a fragment identifier is associated with a URI reference, the fragment would be placed within the brackets as well (separated from the URI with a "#" character). In some cases, extra whitespace (spaces,linebreaks,line-breaks, tabs, etc.) may need to be added to break a long URI across lines. The whitespace should be ignored when extracting the URI. No whitespace should be introduced after a hyphen ("-") character. Because some typesetters and printers may (erroneously) introduce a hyphen at the end of line when breaking a line, the interpreter of a URI containing a line break immediately after a hyphen should ignore all unescaped whitespace around the line break, and should be aware that the hyphen may or may not actually be part of the URI. Using <> angle brackets around each URI is especially recommended as a delimiting style for a URI that contains whitespace. The prefix "URL:" (with or without a trailing space) was formerly recommended as a way to help distinguish a URI from other bracketed designators, though it is not commonly used in practice and is no longer recommended. For robustness, software that accepts user-typed URI should attempt to recognize and strip both delimiters and embedded whitespace.Berners-Lee, et al. Expires September 1, 2003 [Page 47] Internet-Draft URI Generic Syntax March 2003For example, the text: Yes, Jim, I found it under "http://www.w3.org/Addressing/", but you can probably pick it up from <ftp://ds.internic.net/rfc/>. Note the warning in <http://www.ics.uci.edu/pub/ ietf/uri/historical.html#WARNING>. contains the URI references http://www.w3.org/Addressing/ ftp://ds.internic.net/rfc/ http://www.ics.uci.edu/pub/ietf/uri/historical.html#WARNINGBerners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page48]49] Internet-Draft URI Generic SyntaxMarchMay 2003Appendix F. Abbreviated URIs The URI syntax was designed for unambiguous reference to network resources and extensibility via the URI scheme. However, as URI identification and usage have become commonplace, traditional media (television, radio, newspapers, billboards, etc.) have increasingly used abbreviated URI references. That is, a reference consisting of only the authority and path portions of the identified resource, such as www.w3.org/Addressing/ or simply the DNS hostname on its own. Such references are primarily intended for human interpretation rather than machine, with the assumption that context-based heuristics are sufficient to complete the URI (e.g., most hostnames beginning with "www" are likely to have a URI prefix of "http://"). Although there is no standard set of heuristics for disambiguating abbreviated URI references, many client implementations allow them to be entered by the user and heuristically resolved. It should be noted that such heuristics may change over time, particularly when new URI schemes are introduced. Since an abbreviated URI hasnet/rfc/>. Note thesame syntax as a relative URI path, abbreviated URI references cannot be usedwarning incontexts where relative URIs are expected. This limits<http://www.ics.uci.edu/pub/ ietf/uri/historical.html#WARNING>. contains theuse of abbreviated URIs to places where there is no defined base URI, such as dialog boxes and off-line advertisements.URI references http://www.w3.org/Addressing/ ftp://ds.internic.net/rfc/ http://www.ics.uci.edu/pub/ietf/uri/historical.html#WARNING Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page49]50] Internet-Draft URI Generic SyntaxMarchMay 2003 AppendixG.E. Summary of Non-editorial ChangesG.1E.1 Additions IPv6 literals have been added to the list of possible identifiers for the host portion of aserverauthority component, as described by [RFC2732], with the addition of "[" and "]" to thereserved, uric,reserved anduric-no-slashuric sets. Square brackets are now specified as reservedfor the authority component, allowedwithin theopaque part of an opaque URI,authority component and not allowedin the hierarchical syntax except foroutside their use as delimiters for an IPv6reference within host. In order to make this change without changing the technical definition of the path, query, and fragment components, those rules were redefined to directly specify the characters allowed rather thancontinuing tobe defined in terms of uric. Since [RFC2732] defers to[RFC2373][RFC3513] for definition of an IPv6 literal address, which unfortunatelyhaslacks anincorrectABNF description of IPv6address, we created a new ABNF rule for IPv6address that matches the text representations defined by Section 2.2 of[RFC2373].[RFC3513]. Likewise, the definition of IPv4address has beenimproved in orderimproved in order to limit each decimal octet to the range 0-255, and the definition of hostname has been improved to better specify length limitations and partially-qualified domain names. Section 6 (Section 6) on URI normalization and comparison has been completely rewritten and extended using input from Tim Bray and discussion within the W3C Technical Architecture Group. Likewise, Section 2.1 on the encoding of characters has been replaced. An ABNF production for URI has been introduced to correspond to the common usage of the term: an absolute URI with optional fragment. E.2 Modifications from RFC 2396 The ad-hoc BNF syntax has been replaced with the ABNF of [RFC2234]. This change required all rule names that formerly included underscore characters to be renamed with a dash instead. Section 2.2 on reserved characters has been rewritten to clearly explain what characters are reserved, when they are reserved, and why they are reserved even when not used as delimiters by the generic syntax. Likewise, the section on escaped characters has been rewritten, and URI normalizers are now given license to unescape any octets corresponding to unreserved characters. The crosshatch ("#") character has been moved back from the excluded delims to the reserved set. The ABNF for URI and URI-reference has been redesigned tolimit each decimal octetmake them more friendly tothe range 0-255,LALR parsers and significantly reduce complexity. As Berners-Lee, et al. Expires November 21, 2003 [Page 51] Internet-Draft URI Generic Syntax May 2003 a result, thedefinitionlayout form ofhostnamesyntax description has beenimprovedremoved, along with the uric-no-slash, opaque-part, and rel-segment productions. All references to "opaque" URIs have been replaced with a betterspecify length limitations and partially-qualified domain names. Section 6 on URI normalization and comparisondescription of how the path component may be opaque to hierarchy. The fragment identifier has beencompletely rewritten and extended using input from Tim Braymoved back into the section on generic syntax components anddiscussionwithin theW3C Technical Architecture Group. G.2 ModificationsURI and relative-URI productions, though it remains excluded fromRFC 2396absolute-URI. Thead-hoc BNF syntax has been replaced withambiguity regarding theABNFparsing of[RFC2234]. This change required all rule names that formerly included underscore characters to be renamedURI-reference as a URI or a relative-URI with adash instead. Likewise, absoluteURI and relativeURI have been changed to absolute-URIcolon in the first segment is now explained andrelative-URI, respectively, for consistency.disambiguated in the section defining relative-URI. The ABNF of hier-part and relative-URI(Section 3)has been corrected to allow a relative URI path to be empty. This also allows an absolute-URI to consist of nothing after the "scheme:", as is present in practice with the "DAV:" namespace [RFC2518] and the "about:" URI used by many browser implementations. The ambiguity regarding the parsing of net-path, abs-path, and rel-path is now explained and disambiguated in the same section. Registry-based naming authorities that use the hierarchical authority syntax component are now limited to DNS hostnames, since those have been the only such URIs in deployment. This change was necessary to enable internationalized domain names to be processed in their native character encodings at the application layers above URI processing. The reg_name, server, and hostport productions have been removed to simplify parsing of the URI syntax. The ABNF of qualified has been simplified to remove a parsing ambiguity without changing theallowed syntax.allowed syntax. The toplabel production has been removed because it served no useful purpose. The ambiguity regarding the parsing of host as IPv4address or hostname is now explained and disambiguated in the same section. The resolving relative references algorithm of [RFC2396] has been rewritten using pseudocode for this revision to improve clarity andBerners-Lee, et al. Expires September 1, 2003 [Page 50] Internet-Draft URI Generic Syntax March 2003fix the following issues: o [RFC2396] section 5.2, step 6a, failed to account for a base URI with no path. o Restored the behavior of [RFC1808] where, if thethereference contains an empty path and a defined query component, then the target URI inherits the base URI's path component. o Removed the special-case treatment of same-document references in favor of a section that explains that a new retrieval action should not be made if the target URI and base URI, excluding fragments, match. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page51]52] Internet-Draft URI Generic SyntaxMarchMay 2003 Index A ABNF 9 abs-path1415 absolute 9 absolute-path 22 absolute-URI14 absolute-URI-reference 2023 access 7 alphanum 17 authority1515, 16 D dec-octet 17 delims1213 dereference 8 domainlabel 17 dot-segments 19 E escaped1112 excluded 13 F fragment 20 G generic syntax 5 H h4 18 hier-part1415 hierarchical 9 host1617 hostname 17hostport 16I identifier 5 invisible 13 IPv4 17 IPv4address 17 IPv6 18 IPv6address 18 IPv6reference 18 L locator 6 ls32 18M mark 11 N net-path 14 O opaque-part 14 P path 18Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page52]53] Internet-Draft URI Generic SyntaxMarchMay 2003 M mark 11 N name 6 net-path 15 network-path 22 P path 15, 19 path-segments1819 pchar1819 port1618 Q qualified 17 query1920 Rreg-name 16rel-path22 rel-segment15 relative 9 relative-path 22 relative-URI 22 representation 8 reserved 10 resolution 8 resource 4 retrieval 8 S same-document 23 sameness 8 scheme 15 segment18 server 1619 suffix 23 Ttoplabel 17transcription 6 U uniform 4 unreserved 11 unwise1213 URI grammar abs-path1415 absolute-URI14 absolute-URI-reference 2023 ALPHA 9 alphanum 17 Berners-Lee, et al. Expires November 21, 2003 [Page 54] Internet-Draft URI Generic Syntax May 2003 authority1515, 16 CR 9 CTL 9 dec-octet 17delims 12DIGIT 9 domainlabel 17 DQUOTE 9 escaped1112 fragment2015, 20, 22 h4 18 HEXDIG 9 hier-part1415, 22, 23 host 16, 17 hostname 17hostport 17IPv4address 17 IPv6address 18 IPv6reference 18 LF 9 ls32 18 mark 11 net-path14 Berners-Lee, et al. Expires September 1, 2003 [Page 53] Internet-Draft URI Generic Syntax March 2003 opaque-part 14 path 1815 OCTET 9 path-segments1815, 19 pchar1819, 20, 20 port1716, 18 qualified 17 query19 reg-name 1615, 20, 22, 23 rel-path22 rel-segment 2215 relative-URI 22, 22 reserved1011 scheme1515, 16, 23 segment18 server 16 toplabel 1719 SP 9 unreserved 11unwise 12URI 15, 22 URI-reference2022 uric9 uric-no-slash 1410 userinfo 16, 16 URI 15 URI-reference2022 uric9 uric-no-slash 1410 URL 6 URN 6 userinfo 16 Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page54]55] Internet-Draft URI Generic SyntaxMarchMay 2003 Intellectual Property Statement The IETF takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on the IETF's procedures with respect to rights in standards-track and standards-related documentation can be found in BCP-11. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementors or users of this specification can be obtained from the IETF Secretariat. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to practice this standard. Please address the information to the IETF Executive Director. Full Copyright Statement Copyright (C) The Internet Society (2003). All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assignees. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page55]56] Internet-Draft URI Generic SyntaxMarchMay 2003 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Acknowledgement Funding for the RFC Editor function is currently provided by the Internet Society. Berners-Lee, et al. ExpiresSeptember 1,November 21, 2003 [Page56]57] ----