idnits 2.17.1 draft-ietf-iri-4395bis-irireg-03.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == The document seems to lack the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. (The document does seem to have the reference to RFC 2119 which the ID-Checklist requires). == Using lowercase 'not' together with uppercase 'MUST', 'SHALL', 'SHOULD', or 'RECOMMENDED' is not an accepted usage according to RFC 2119. Please use uppercase 'NOT' together with RFC 2119 keywords (if that is what you mean). Found 'MUST not' in this paragraph: Encoding considerations: See Section 2.5 of [RFC3986] for guidelines. Applications/protocols that use this URI scheme name: The "example" URI should be used for documentation purposes only. It MUST not be used for any protocol. Interoperability considerations: None. Security considerations: None. Contact: N/A Author/Change controller: IETF References: This RFC XXXX. RFC Editor Note: Replace XXXX with this RFC's reference. -- The document date (July 29, 2011) is 4654 days in the past. Is this intentional? Checking references for intended status: Best Current Practice ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) ** Obsolete normative reference: RFC 2141 (Obsoleted by RFC 8141) ** Obsolete normative reference: RFC 5226 (Obsoleted by RFC 8126) ** Obsolete normative reference: RFC 3978 (Obsoleted by RFC 5378) -- Obsolete informational reference (is this intentional?): RFC 2717 (Obsoleted by RFC 4395) -- Obsolete informational reference (is this intentional?): RFC 2718 (Obsoleted by RFC 4395) -- Obsolete informational reference (is this intentional?): RFC 3406 (Obsoleted by RFC 8141) -- Duplicate reference: RFC3987, mentioned in 'RFC3987', was also mentioned in 'RFC3987bis'. -- Obsolete informational reference (is this intentional?): RFC 4395 (Obsoleted by RFC 7595) Summary: 3 errors (**), 0 flaws (~~), 3 warnings (==), 6 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group T. Hansen 3 Internet-Draft AT&T Laboratories 4 Obsoletes: 4395 (if approved) T. Hardie 5 Intended status: BCP Panasonic Wireless Research Lab 6 Expires: January 30, 2012 L. Masinter 7 Adobe 8 July 29, 2011 10 Guidelines and Registration Procedures for New URI/IRI Schemes 11 draft-ietf-iri-4395bis-irireg-03 13 Abstract 15 This document updates the guidelines and recommendations for the 16 definition of Uniform Resource Identifier (URI) schemes, and extends 17 the registry and guidelines to apply when the schemes are used with 18 Internationalized Resource Identifiers (IRIs). It also updates the 19 process and IANA registry for URI/IRI schemes. It obsoletes RFC 20 4395. 22 Status of this Memo 24 This Internet-Draft is submitted in full conformance with the 25 provisions of BCP 78 and BCP 79. 27 Internet-Drafts are working documents of the Internet Engineering 28 Task Force (IETF). Note that other groups may also distribute 29 working documents as Internet-Drafts. The list of current Internet- 30 Drafts is at http://datatracker.ietf.org/drafts/current/. 32 Internet-Drafts are draft documents valid for a maximum of six months 33 and may be updated, replaced, or obsoleted by other documents at any 34 time. It is inappropriate to use Internet-Drafts as reference 35 material or to cite them other than as "work in progress." 37 This Internet-Draft will expire on January 30, 2012. 39 Copyright Notice 41 Copyright (c) 2011 IETF Trust and the persons identified as the 42 document authors. All rights reserved. 44 This document is subject to BCP 78 and the IETF Trust's Legal 45 Provisions Relating to IETF Documents 46 (http://trustee.ietf.org/license-info) in effect on the date of 47 publication of this document. Please review these documents 48 carefully, as they describe your rights and restrictions with respect 49 to this document. Code Components extracted from this document must 50 include Simplified BSD License text as described in Section 4.e of 51 the Trust Legal Provisions and are provided without warranty as 52 described in the Simplified BSD License. 54 Table of Contents 56 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 57 2. Conformance Guidelines . . . . . . . . . . . . . . . . . . . . 4 58 3. Guidelines for Permanent URI/IRI Scheme Definitions . . . . . 4 59 3.1. Demonstratable, New, Long-Lived Utility . . . . . . . . . 4 60 3.2. Syntactic Compatibility . . . . . . . . . . . . . . . . . 5 61 3.3. Well-Defined . . . . . . . . . . . . . . . . . . . . . . . 5 62 3.4. Definition of Operations . . . . . . . . . . . . . . . . . 6 63 3.5. Context of Use . . . . . . . . . . . . . . . . . . . . . . 6 64 3.6. Internationalization and Character Encoding . . . . . . . 7 65 3.7. Clear Security Considerations . . . . . . . . . . . . . . 7 66 3.8. Scheme Name Considerations . . . . . . . . . . . . . . . . 7 67 4. Guidelines for Provisional URI/IRI Scheme Registration . . . . 8 68 5. Guidelines for Historical URI/IRI Scheme Registration . . . . 9 69 6. URI/IRI Scheme Registration Procedure . . . . . . . . . . . . 9 70 6.1. General . . . . . . . . . . . . . . . . . . . . . . . . . 9 71 6.2. Registration Procedures . . . . . . . . . . . . . . . . . 10 72 6.3. Change Control . . . . . . . . . . . . . . . . . . . . . . 11 73 6.4. URI/IRI Scheme Registration Template . . . . . . . . . . . 11 74 7. The "example" Scheme . . . . . . . . . . . . . . . . . . . . . 12 75 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 13 76 9. Security Considerations . . . . . . . . . . . . . . . . . . . 13 77 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 14 78 Appendix A. Changes Since RFC 4395 . . . . . . . . . . . . . . . 14 79 11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 14 80 11.1. Normative References . . . . . . . . . . . . . . . . . . . 14 81 11.2. Informative References . . . . . . . . . . . . . . . . . . 15 82 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 15 84 1. Introduction 86 The Uniform Resource Identifier (URI) protocol element and generic 87 syntax is defined by [RFC3986]. Each URI begins with a scheme name, 88 as defined by Section 3.1 of RFC 3986, that refers to a specification 89 for identifiers within that scheme. The URI syntax provides a 90 federated and extensible naming system, where each scheme's 91 specification may further restrict the syntax and define the 92 semantics of identifiers using that scheme. As originally defined, 93 URIs only allowed a limited repertoire of characters chosen from US- 94 ASCII. 96 An Interationalized Resource Identifier (IRI), as defined by 97 [RFC3987bis], extends the URI syntax to allow characters from a much 98 greater repertoire, to accomodate resource identifiers from the 99 world's languages. The same schemes used in URIs are used in IRIs. 100 The term Resource Identifier (RI) is used as a shorthand for both 101 URIs and IRIs. [RFC3987] introduced IRIs by defining a mapping 102 between URIs and IRIs; [RFC3987bis] updates that definition, allowing 103 an IRI to be interpreted directly without translating into a URI. 105 This document obsoletes [RFC4395], which in turn obsoleted [RFC2717] 106 and [RFC2718]. Recent documents have used the terms "URI"/"IRI" for 107 all resource identifiers, avoiding the term "URL" and reserving the 108 term "URN" explicitly for those URIs/IRIs using the "urn" scheme name 109 ([RFC2141]). URN "namespaces" ([RFC3406]) are specific to the "urn" 110 scheme and are not covered explicitly by this specification. 112 This document extends the URI scheme registry to be a registry of 113 URI/IRI schemes (i.e., applicable to both URIs and IRIs). This 114 document also provides updated guidelines for the definition of new 115 schemes, for consideration by those who are defining, registering, or 116 evaluating those definitions, as well as a process and mechanism for 117 registering URI/IRI schemes within the IANA URI scheme registry. 118 There is a single namespace for registered schemes. Within that 119 namespace, there are values that are approved as meeting a set of 120 criteria for permanent URI/IRI schemes. Other scheme names may also 121 be registered provisionally or historically, without necessarily 122 meeting those criteria. The intent of the registry is to: 124 o provide a central point of discovery for established URI/IRI 125 scheme names, and easy location of their defining documents; 126 o discourage use of the same scheme name for different purposes; 127 o help those proposing new scheme names to discern established 128 trends and conventions, and avoid names that might be confused 129 with existing ones; 131 o encourage registration by setting a low barrier for provisional 132 registrations. 134 There is no separate, independent registry or registration process 135 for IRIs: the URI Scheme Registry is to be used for both URIs and 136 IRIs. Previously, those who wish to describe resource identifiers 137 that are useful as IRIs were encouraged to define the corresponding 138 URI syntax, and note that the IRI usage follows the rules and 139 transformations defined in [RFC3987]. This document changes that 140 advice to encourage explicit definition of the scheme and allowable 141 syntax elements within the larger character repertoire of IRIs, as 142 defined by [RFC3987bis]. 144 A scheme definition cannot override the overall syntax for IRIs. For 145 example, this means that fragment identifiers (#) cannot be re-used 146 outside the generic syntax restrictions, and in particular scheme- 147 specific syntax cannot override the fragment identifier syntax 148 because it is generic. 150 2. Conformance Guidelines 152 Within this document, the key words MUST, MAY, SHOULD, REQUIRED, 153 RECOMMENDED, and so forth are used within the general meanings 154 established in [RFC2119], within the context that they are 155 requirements on future registration specifications. 157 3. Guidelines for Permanent URI/IRI Scheme Definitions 159 This section gives considerations for new URI/IRI schemes. Meeting 160 these guidelines is REQUIRED for permanent scheme registration. 161 Meeting these guidelines is also RECOMMENDED for provisional 162 registration, as described in Section 4. 164 3.1. Demonstratable, New, Long-Lived Utility 166 The use and deployment of new URI/IRI schemes in the Internet 167 infrastructure is costly; some parts of URI/IRI processing may be 168 scheme-dependent, and deployed software already processes URIs and 169 IRIs of well-known schemes. Introducing a new scheme may require 170 additional software, not only for client software and user agents but 171 also in additional parts of the network infrastructure (gateways, 172 proxies, caches) [W3CWebArch]. URI/IRI schemes constitute a single, 173 global namespace; it is desirable to avoid contention over use of 174 short, mnemonic scheme names. For these reasons, the unbounded 175 registration of new schemes is harmful. New URI/IRI schemes SHOULD 176 have clear utility to the broad Internet community, beyond that 177 available with already registered URI/IRI schemes. 179 3.2. Syntactic Compatibility 181 [RFC3986] defines the generic syntax for all URI schemes, along with 182 the syntax of common URI components that are used by many URI schemes 183 to define hierarchical identifiers. [RFC3987] and subsequently 184 [RFC3987bis] extended this generic syntax to cover IRIs. All URI/IRI 185 scheme specifications MUST define their own syntax such that all 186 strings matching their scheme-specific syntax will also match the 187 grammar described in [RFC3987bis]. 189 New schemes SHOULD reuse the common components of [RFC3987bis] for 190 the definition of hierarchical naming schemes. However, if there is 191 a strong reason for a scheme not to use the hierarchical syntax, then 192 the new scheme definition SHOULD follow the syntax of previously 193 registered schemes. 195 Schemes that are not intended for use with relative URIs/IRIs SHOULD 196 avoid use of the forward slash "/" character, which is used for 197 hierarchical delimiters, and the complete path segments "." and ".." 198 (dot-segments). 200 Avoid improper use of "//". The use of double slashes in the first 201 part of a URI/IRI is not an artistic indicator that what follows is a 202 URI/IRI: Double slashes are used ONLY when the syntax of the contains a hierarchical structure. In URIs and IRIs 204 from such schemes, the use of double slashes indicates that what 205 follows is the top hierarchical element for a naming authority. 206 (Section 3.2 of RFC 3986 has more details.) Schemes that do not 207 contain a conformant hierarchical structure in their SHOULD NOT use double slashes following the 209 ":" string. 211 New schemes SHOULD clearly define the role of [RFC3986] reserved 212 characters in URIs/IRIs of the scheme being defined. The syntax of 213 the new scheme should be clear about which of the "reserved" set of 214 characters are used as delimiters within the URIs/IRIs of the new 215 scheme, and when those characters must be escaped, versus when they 216 may be used without escaping. 218 3.3. Well-Defined 220 While URIs/IRIs may or may not be defined as locators in practice, a 221 scheme definition itself MUST be clear as to how it is expected to 222 function. Schemes that are not intended to be used as locators 223 SHOULD describe how the resource identified can be determined or 224 accessed by software that obtains a URI/IRI of that scheme. 226 For schemes that function as locators, it is important that the 227 mechanism of resource location be clearly defined. This might mean 228 different things depending on the nature of the scheme. 230 In many cases, new schemes are defined as ways to translate between 231 other namespaces or protocols and the general framework of URIs. For 232 example, the "ftp" scheme translates into the FTP protocol, while the 233 "mid" scheme translates into a Message-ID identifier of an email 234 message. For such schemes, the description of the mapping must be 235 complete, and in sufficient detail so that the mapping in both 236 directions is clear: how to map from a URI/IRI into an identifier or 237 set of protocol actions or name in the target namespace, and how 238 legal values in the base namespace, or legal protocol interactions, 239 might be represented in a valid URI or IRI. In particular, the 240 mapping should describe the mechanisms for encoding binary or 241 character strings within valid character sequences in a URI/IRI (See 242 Section 3.6 for guidelines). If not all legal values or protocol 243 interactions of the base standard can be represented using the 244 scheme, the definition should be clear about which subset are 245 allowed, and why. 247 3.4. Definition of Operations 249 As part of the definition of how a URI/IRI identifies a resource, a 250 scheme definition SHOULD define the applicable set of operations that 251 may be performed on a resource using the RI as its identifier. A 252 model for this is HTTP; an HTTP resource can be operated on by GET, 253 POST, PUT, and a number of other operations available through the 254 HTTP protocol. The scheme definition should describe all well- 255 defined operations on the resource identifier, and what they are 256 supposed to do. 258 Some schemes don't fit into the "information access" paradigm of 259 URIs/IRIs. For example, "telnet" provides location information for 260 initiating a bi-directional data stream to a remote host; the only 261 operation defined is to initiate the connection. In any case, the 262 operations appropriate for a scheme should be documented. 264 Note: It is perfectly valid to say that "no operation apart from GET 265 is defined for this RI". It is also valid to say that "there's only 266 one operation defined for this RI, and it's not very GET-like". The 267 important point is that what is defined on this scheme is described. 269 3.5. Context of Use 271 In general, URIs/IRIs are used within a broad range of protocols and 272 applications. Most commonly, URIs/IRIs are used as references to 273 resources within directories or hypertext documents, as hyperlinks to 274 other resources. In some cases, a scheme is intended for use within 275 a different, specific set of protocols or applications. If so, the 276 scheme definition SHOULD describe the intended use and include 277 references to documentation that define the applications and/or 278 protocols cited. 280 3.6. Internationalization and Character Encoding 282 When describing schemes in which (some of) the elements of the URI or 283 IRI are actually representations of human-readable text, care should 284 be taken not to introduce unnecessary variety in the ways in which 285 characters are encoded into octets and then into characters; see 286 [RFC3987bis] and Section 2.5 of [RFC3986] for guidelines. If URIs/ 287 IRIs of a scheme contain any text fields, the scheme definition MUST 288 describe the ways in which characters are encoded and any 289 compatibility issues with IRIs of the scheme. 291 Specifications for IRIs schemes MUST be described in terms of 292 processing an IRI as a sequence of Unicode codepoints, without 293 reference to the encoding of those code points as a sequence of 294 bytes, using UTF-8 or UTF-16. The scheme specification SHOULD be as 295 restrictive as possible regarding what characters are allowed in the 296 URI/IRI, because some characters can create several different 297 security considerations (see for example [RFC4690]). 299 All percent-encoded variants are automatically included by definition 300 for any character given in an IRI production. This means that if you 301 want to restrict the URI percent-encoded forms in some way, you must 302 restrict the Unicode forms that would lead to them. 304 3.7. Clear Security Considerations 306 Definitions of schemes MUST be accompanied by a clear analysis of the 307 security implications for systems that use the scheme; this follows 308 the practice of Security Consideration sections within IANA 309 registrations [RFC5226]. 311 In particular, Section 7 of RFC 3986 [RFC3986] describes general 312 security considerations for URIs, while Section ??? of [RFC3987bis] 313 gives those for IRIs. The definition of an individual URI/IRI scheme 314 should note which of these apply to the specified scheme. 316 3.8. Scheme Name Considerations 318 Section 3.1 of RFC 3986 defines the syntax of a URI scheme name; this 319 sytax remains the same for IRIs. New registered schemes 320 registrations MUST follow this syntax, which only allows a limited 321 repertoire of characters (taken from US-ASCII). Although the syntax 322 for the scheme name in URI/IRIs is case insensitive, the scheme names 323 itself MUST be registered using lowercase letters. 325 URI/IRI scheme names should be short, but also sufficiently 326 descriptive and distinguished to avoid problems. 328 Avoid names or other symbols that might cause problems with rights to 329 use the name in IETF specifications and Internet protocols. For 330 example, be careful with trademark and service mark names. (See 331 Section 7.4 of [RFC3978].) 333 Avoid using names that are either very general purpose or associated 334 in the community with some other application or protocol. Avoid 335 scheme names that are overly general or grandiose in scope (e.g., 336 that allude to their "universal" or "standard" nature.) 338 Organizations that desire a private name space for URI scheme names 339 are encouraged to use a prefix based on their domain name, expressed 340 in reverse order. For example, a URI scheme name of com-example-info 341 might be registered by the vendor that owns the example.com domain 342 name. 344 4. Guidelines for Provisional URI/IRI Scheme Registration 346 Provisional registration can be an intermediate step on the way to 347 permanent registration, e.g., before the scheme specification is 348 finalized. Provisional registration is also appropriate for schemes 349 that are known to be used, but where a definitive specification is 350 not available. There is no time limit for provisional registration. 352 While the guidelines in Section 3 are REQUIRED for permanent 353 registration, they are RECOMMENDED for provisional registration. For 354 a provisional registration, the following are REQUIRED: 356 o The scheme name meets the syntactic requirements of Section 3.8 357 and the encoding requirements of Section 3.6. 358 o There is not already an entry with the same scheme name. (In the 359 unfortunate case that there are multiple, different uses of the 360 same scheme name, the IESG may approve a request to modify an 361 existing entry to note the separate use.) 362 o Contact information identifying the person supplying the 363 registration is included. Previously unregistered schemes 364 discovered in use may be registered by third parties (even if not 365 on behalf of those who created the scheme). In this case, both 366 the registering party and the scheme creator SHOULD be identified. 368 o If no permanent, citable specification for the scheme definition 369 is included, credible reasons for not providing it should be 370 given. 371 o A valid Security Considerations section, as required by Section 6 372 of [RFC5226]. 373 o If the scheme definition does not meet the guidelines laid out in 374 Section 3, the differences and reasons SHOULD be noted. 376 5. Guidelines for Historical URI/IRI Scheme Registration 378 In some circumstances, it is appropriate to note a URI scheme that 379 was once in use or registered but for whatever reason is no longer in 380 common use or the use is not recommended. In this case, it is 381 possible for an individual to request that the scheme be registered 382 (newly, or as an update to an existing registration) as 'historical'. 383 Any scheme that is no longer in common use MAY be designated as 384 historical; the registration should contain some indication to where 385 the scheme was previously defined or documented. 387 6. URI/IRI Scheme Registration Procedure 389 6.1. General 391 The URI/IRI registration process is described in the terminology of 392 [RFC5226]. The registration process is an optional mailing list 393 review, followed by "Expert Review". The registration request should 394 note the desired status. The Designated Expert will evaluate the 395 request against the criteria of the requested status. In the case of 396 a permanent registration request, the Designated Expert may: 397 o Accept the specification of the scheme for permanent registration. 398 o Suggest provisional registration instead. 399 o Request IETF review and IESG approval; in the meanwhile, suggest 400 provisional registration. 402 URI/IRI scheme definitions contained within other IETF documents 403 (Informational, Experimental, or Standards-Track RFCs) must also 404 undergo Expert Review; in the case of Standards-Track documents, 405 permanent registration status approval is required. 407 The registration procedure for URI schemes is intended to be very 408 lightweight for non-contentious registrations. For the most part, we 409 expect the good sense of submitters and reviewers, guided by these 410 procedures, to achieve an acceptable and useful consensus for the 411 community. 413 In exceptional cases, where the negotiating parties cannot form a 414 consensus, the final arbiter of any contested registration shall be 415 the IESG. 417 If parties achieve consensus on a registration proposal that does not 418 fully conform to the strict wording of this procedure, this should be 419 drawn to the attention of a relevant member of the IESG. 421 6.2. Registration Procedures 423 Someone wishing to register a new URI/IRI scheme MUST: 424 1. Check the IANA URI scheme registry to see whether or not there is 425 already an entry for the desired name. If there is already an 426 entry under the name, choose a different URI scheme name, or 427 update the existing scheme definition. 428 2. Prepare a URI/IRI scheme registration template, as specified in 429 Section 6.4. The scheme registration template may be contained 430 in an Internet Draft, submitted alone, or as part of some other 431 permanently available, stable, protocol specification. The 432 template may also be submitted in some other form (as part of 433 another document or as a stand-alone document), but the contents 434 will be treated as an "IETF Contribution" under the guidelines of 435 [RFC3978]. 436 3. Send a copy of the template or a pointer to the containing 437 document (with specific reference to the section with the 438 template) to the mailing list uri-review@ietf.org, requesting 439 review. In addition, request review on other relevant mailing 440 lists as appropriate. For example, general discussion of URI/IRI 441 syntactical issues could be discussed on uri@w3.org; schemes for 442 a network protocol could be discussed on a mailing list for that 443 protocol. Allow a reasonable time for discussion and comments. 444 Four weeks is reasonable for a permanent registration requests. 445 4. Respond to review comments and make revisions to the proposed 446 registration as needed to bring it into line with the guidelines 447 given in this document. 448 5. Submit the (possibly updated) registration template (or pointer 449 to document containing it) to IANA at iana@iana.org, specifying 450 whether 'permanent' or 'provisional' registration is requested. 452 Upon receipt of a URI/IRI scheme registration request, the following 453 steps MUST be followed: 455 1. IANA checks the submission for completeness; if sections are 456 missing or citations are not correct, IANA may reject the 457 registration request. 458 2. IANA checks the current registry for a entry with the same name; 459 if such a registry exists, IANA may reject the registration 460 request. 462 3. IANA requests Expert Review of the registration request against 463 the corresponding guidelines (from this document.) 464 4. The Designated Expert may request additional review or 465 discussion, as necessary. 466 5. If Expert Review recommends registration 'provisional' or 467 'permanent' registration, IANA adds the registration to the 468 appropriate registry. 469 6. Unless Expert Review has explicitly rejected the registration 470 request within two weeks, IANA should automatically add the 471 registration in the 'provisional' registry. 473 Either based on an explicit request or independently initiated, the 474 Designated Expert or IESG may request the upgrade of a 'provisional' 475 registration to a 'permanent' one. In such cases, IANA should move 476 the corresponding entry from the provisional registry. 478 6.3. Change Control 480 Registrations may be updated in each registry by the same mechanism 481 as required for an initial registration. In cases where the original 482 definition of the scheme is contained in an IESG-approved document, 483 update of the specification also requires IESG approval. 485 Provisional registrations may be updated by the original registrant 486 or anyone designated by the original registrant. In addition, the 487 IESG may reassign responsibility for a provisional registration 488 scheme, or may request specific changes to a scheme registration. 489 This will enable changes to be made to schemes where the original 490 registrant is out of contact, or unwilling or unable to make changes. 492 Transition from 'provisional' to 'permanent' status may be requested 493 and approved in the same manner as a new 'permanent' registration. 494 Transition from 'permanent' to 'historical' status requires IESG 495 approval. Transition from 'provisional' to 'historical' may be 496 requested by anyone authorized to update the provisional 497 registration. 499 6.4. URI/IRI Scheme Registration Template 501 This template describes the fields that must be supplied in a URI/IRI 502 scheme registration request: 504 Resource Identifier (RI) Scheme name: 505 See Section 3.8 for guidelines. 507 Status: 508 This reflects the status requested, and should be one of 509 'permanent', 'provisional', or 'historical'. 510 Scheme syntax: 511 See Section 3.2 for guidelines. 512 Scheme semantics: 513 See Section 3.3 and Section 3.4 for guidelines. 514 Encoding considerations: 515 See Section 3.3 and Section 3.6 for guidelines. 516 Applications/protocols that use this scheme name: 517 See Section 3.5. 518 Interoperability considerations: 519 If the person or group registering the scheme is aware of any 520 details regarding the scheme that might impact interoperability, 521 identify them here. For example: proprietary or uncommon encoding 522 methods; inability to support multibyte character sets; 523 incompatibility with types or versions of any underlying protocol. 524 Security considerations: 525 See Section 3.7 for guidelines. 526 Contact: 527 Person (including contact information) to contact for further 528 information. 529 Author/Change controller: 530 Person (including contact information) authorized to change this, 531 if a provisional registration. 532 References: 533 Include full citations for all referenced documents. Registration 534 templates for provisional registration may be included in an 535 Internet Draft; when the documents expire or are approved for 536 publication as an RFC, the registration will be updated. 538 7. The "example" Scheme 540 There is a need for a URI/IRI Scheme name that can be used for 541 examples in documentation without fear of conflicts with current or 542 future actual schemes. The URI/IRI Scheme "example" is hereby 543 registered as a Permanent URI/IRI Scheme for that purpose. 544 Scheme name: example 545 Status: permanent 546 Scheme syntax: The entire range of allowable syntax for URI/IRI 547 schemes specified in [RFC3987bis] is allowed for "example" URI/ 548 IRIs. 549 Scheme semantics: URI/IRIs in the "example" scheme should be used 550 for documentation purposes only. The use of "example" URIs/IRIs 551 must not be used as locators, identify any resources, or specify 552 any particular set of operations. 554 Encoding considerations: See Section 2.5 of [RFC3986] for 555 guidelines. 556 Applications/protocols that use this URI scheme name: The "example" 557 URI should be used for documentation purposes only. It MUST not 558 be used for any protocol. 559 Interoperability considerations: None. 560 Security considerations: None. 561 Contact: N/A 562 Author/Change controller: IETF 563 References: This RFC XXXX. 564 RFC Editor Note: Replace XXXX with this RFC's reference. 566 8. IANA Considerations 568 Previously, the former "URL Scheme" registry was replaced by the 569 Uniform Resource Identifier scheme registry. The process was based 570 on [RFC5226] "Expert Review" with an initial (optional) mailing list 571 review. 573 The updated template has an additional field for the status of the 574 scheme, and the procedures for entering new name schemes have been 575 augmented. Section 6 establishes the process for new URI/IRI scheme 576 registration. 578 IANA is requested to update the name of the registry "URI Schemes" to 579 "URI/IRI Schemes". The registry should be updated to point to this 580 document. For the tables within that registry "Permanent URI 581 Schemes" should become "Permanent URI/IRI Schemes", "Provisional URI 582 Schemes" should become "Provisional URI/IRI Schemes", and "Historical 583 URI Schemes" should become "Historical URI/IRI Schemes". 585 The example URI scheme "example" is hereby registered. (See the 586 template above for registration.) 588 9. Security Considerations 590 All registered values are expected to contain accurate security 591 consideration sections; 'permanent' registered scheme names are 592 expected to contain complete definitions. 594 Information concerning possible security vulnerabilities of a 595 protocol may change over time. Consequently, claims as to the 596 security properties of a registered URI/IRI scheme may change as 597 well. As new vulnerabilities are discovered, information about such 598 vulnerabilities may need to be attached to existing documentation, so 599 that users are not misled as to the true security properties of a 600 registered URI scheme. 602 10. Acknowledgements 604 Many thanks to Patrick Faltstrom for his comments on this version. 606 Many thanks to Paul Hoffmann, Ira McDonald, Roy Fielding, Stu Weibel, 607 Tony Hammond, Charles Lindsey, Mark Baker, and other members of the 608 uri@w3.org mailing list for their comments on earlier versions. 610 Parts of this document are based on [RFC2717], [RFC2718] and 611 [RFC3864]. Some of the ideas about use of URIs were taken from the 612 "Architecture of the World Wide Web" [W3CWebArch]. 614 Appendix A. Changes Since RFC 4395 616 1. Significant edits to be clear that a "URI scheme" and an "IRI 617 scheme" are the same thing. 618 2. Added the "example:" URL Scheme. 619 3. Allow for IRI-specific scheme registration. 620 4. Clarify that the URI scheme registry is also the IRI scheme 621 registry. 623 11. References 625 11.1. Normative References 627 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 628 Requirement Levels", BCP 14, RFC 2119, March 1997. 630 [RFC2141] Moats, R., "URN Syntax", RFC 2141, May 1997. 632 [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an 633 IANA Considerations Section in RFCs", BCP 26, RFC 5226, 634 May 2008. 636 [RFC3978] Bradner, S., "IETF Rights in Contributions", RFC 3978, 637 March 2005. 639 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 640 Resource Identifier (URI): Generic Syntax", STD 66, 641 RFC 3986, January 2005. 643 [RFC3987bis] 644 Duerst, M., Masinter, L., and M. Suignard, 645 "Internationalized Resource Identifiers (IRIs)", 646 September 2010, 647 . 649 11.2. Informative References 651 [RFC2717] Petke, R. and I. King, "Registration Procedures for URL 652 Scheme Names", BCP 35, RFC 2717, November 1999. 654 [RFC2718] Masinter, L., Alvestrand, H., Zigmond, D., and R. Petke, 655 "Guidelines for new URL Schemes", RFC 2718, November 1999. 657 [RFC3406] Daigle, L., van Gulik, D., Iannella, R., and P. Faltstrom, 658 "Uniform Resource Names (URN) Namespace Definition 659 Mechanisms", BCP 66, RFC 3406, October 2002. 661 [RFC3864] Klyne, G., Nottingham, M., and J. Mogul, "Registration 662 Procedures for Message Header Fields", BCP 90, RFC 3864, 663 September 2004. 665 [RFC3987] Duerst, M. and M. Suignard, "Internationalized Resource 666 Identifiers (IRIs)", RFC 3987, January 2005. 668 [RFC4395] Hansen, T., Hardie, T., and L. Masinter, "Guidelines and 669 Registration Procedures for New URI Schemes", BCP 35, 670 RFC 4395, February 2006. 672 [RFC4690] Klensin, J., Faltstrom, P., Karp, C., and IAB, "Review and 673 Recommendations for Internationalized Domain Names 674 (IDNs)", RFC 4690, September 2006. 676 [W3CWebArch] 677 W3C Technical Architecture Group, "Architecture of the 678 World Wide Web, Volume One", December 2004, 679 . 681 Authors' Addresses 683 Tony Hansen 684 AT&T Laboratories 685 200 Laurel Ave. 686 Middletown, NJ 07748 687 USA 689 Email: tony+urireg@maillennium.att.com 690 Ted Hardie 691 Panasonic Wireless Research Lab 692 10900 Tantau Ave. 693 Cupertino, CA 694 USA 696 Phone: +1 408 628 5864 697 Email: ted.ietf@gmail.com 699 Larry Masinter 700 Adobe 701 345 Park Ave. 702 San Jose, CA 95110 703 US 705 Phone: +1 408 536 3024 706 Email: masinter@adobe.com 707 URI: http://larry.masinter.net