Debian Codegraph @

rfc3688.html

raw
1 <pre>Network Working Group M. Mealling
2 Request for Comments: 3688 VeriSign, Inc.
3 BCP: 81 January 2004
4 Category: Best Current Practice
5
6
7 <span class="h1">The IETF XML Registry</span>
8
9 Status of this Memo
10
11 This document specifies an Internet Best Current Practices for the
12 Internet Community, and requests discussion and suggestions for
13 improvements. Distribution of this memo is unlimited.
14
15 Copyright Notice
16
17 Copyright (C) The Internet Society (2004). All Rights Reserved.
18
19 Abstract
20
21 This document describes an IANA maintained registry for IETF
22 standards which use Extensible Markup Language (XML) related items
23 such as Namespaces, Document Type Declarations (DTDs), Schemas, and
24 Resource Description Framework (RDF) Schemas.
25
26 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
27
28 Over the past few years, the Extensible Markup Language (XML)
29 [<a href="#ref-W3C.REC-xml" title="&quot;Extensible Markup Language (XML) 1.0 (2nd ed)&quot;">W3C.REC-xml</a>] has become a widely used method for data markup. There
30 have already been several IETF Working Groups that have produced
31 standards that define XML Document Type Definitions (DTDs), XML
32 Namespaces [<a href="#ref-W3C.REC-xml-names" title="&quot;Namespaces in XML&quot;">W3C.REC-xml-names</a>], and XML Schemas [W3C.REC-xmlschema-
33 1]. Each one of these technologies uses Uniform Resource Identifiers
34 (URIs) [<a href="./rfc2396" title="&quot;Uniform Resource Identifiers (URI): Generic Syntax&quot;">RFC2396</a>] and other standardized identifiers to identify
35 various components.
36
37 For example, while it has been the practice within some standards
38 that use Document Type Definitions (DTDs) to forego the use of the
39 PUBLIC identifiers in favor of 'well known' SYSTEM identifiers, it
40 has proven to be more trouble than its worth to attempt to
41 standardize SYSTEM identifiers. The result is that several IETF
42 standards that have simply created non-resolvable URIs in order to
43 simply identify but not resolve the DTD for some given XML document.
44
45 This document seeks to standardize and improve these practices by
46 creating an IANA maintained registry of XML element identifiers so
47 that document authors and implementors have a well maintained and
48
49
50
51
52 <span class="grey">Mealling Best Current Practice [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc3688">RFC 3688</a> The IETF XML Registry January 2004</span>
55
56
57 authoritative location for their XML elements. As part of this
58 standard, the IANA will maintain:
59
60 o the public representation of the document,
61
62 o the URI for the elements if one is provided at the time of
63 registration,
64
65 o a registry of Public Identifiers as URIs.
66
67 In the case where the registrant does not request a particular URI,
68 the IANA will assign it a Uniform Resource Name (URN) that follows
69 [<a href="./rfc3553" title="&quot;An IETF URN Sub-namespace for Registered Protocol Parameters&quot;">RFC3553</a>].
70
71 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Terminology</span>
72
73 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
74 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
75 document are to be interpreted as described in <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>
76 [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>].
77
78 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Registerable Documents</span>
79
80 <span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. The Assigned/Registered URI</span>
81
82 All elements (except PUBLIC identifiers) in this registry will
83 require a URI in order to be registered. If the registrant wishes to
84 have a URI assigned, then a URN of the form
85
86 urn:ietf:params:xml:&lt;class&gt;:&lt;id&gt;
87
88 will be assigned where &lt;class&gt; is the type of the document being
89 registered (see below). &lt;id&gt; is a unique id generated by the IANA
90 based on any means the IANA deems necessary to maintain uniqueness
91 and persistence. NOTE: in order for a URN of this type to be
92 assigned, the item being registered MUST have been through the IETF
93 consensus process. Basically, this means that it must be documented
94 in a RFC. The <a href="./rfc3553">RFC 3553</a> [<a href="./rfc3553" title="&quot;An IETF URN Sub-namespace for Registered Protocol Parameters&quot;">RFC3553</a>] URN registration template is found
95 in <a href="#section-6">Section 6</a>.
96
97 The IANA will also maintain a file server available via at least HTTP
98 and FTP that contains all of the registered elements in some publicly
99 accessible file space in the same way that all of the IANA's
100 registered elements are available via
101 <a href="http://www.iana.org/assignments/">http://www.iana.org/assignments/</a>. While the directory structure of
102 this server is up to the IANA, it is suggested that the files be
103 organized by the &lt;class&gt; and the individual files have the &lt;id&gt; as
104 their filename.
105
106
107
108 <span class="grey">Mealling Best Current Practice [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc3688">RFC 3688</a> The IETF XML Registry January 2004</span>
111
112
113 Implementors are warned that they should not programatically rely on
114 those resources being available or the directory structure remaining
115 static for any reason. It is explicitly recognized that some
116 software tools attempt to download DTDs, schema, etc., 'on the fly'
117 and that developers should understand when this is done and when to
118 not reference IANA network resources as a 'schema download
119 repository'. This is the reason that the IANA will not register or
120 provide SYSTEM identifiers.
121
122 <span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Registerable Classes</span>
123
124 The list of types of XML elements that can be registered with the
125 IANA are:
126
127 publicid -- An XML document that contains a DOCTYPE declaration or
128 any other external reference can identify that reference via both
129 a PUBLIC identifier and a SYSTEM identifier. The SYSTEM
130 identifier is system-specific information that enables the entity
131 manager of an XML system to locate the file, memory location, or
132 pointer within a file where the entity can be found. It should
133 also be noted that a system identifier could be an invocation of a
134 program that controls access to an entity that is being
135 identified. Thus, they are not registered items. In many cases,
136 SYSTEM identifiers are also URIs. However, in these cases, the
137 URI is still only used for system-specific information. In the
138 case where a PUBLIC Identifier is also a URI, it is possible for
139 the SYSTEM Identifier to contain the same URI but this behavior is
140 not recommended unless its side effects are well known and
141 understood to not cause any unacceptable harm.
142
143 A PUBLIC identifier is a name that is intended to be meaningful
144 across systems and different user environments. Typically, it
145 will be a name that has a registered owner associated with it, so
146 that public identifiers will be guaranteed unique and no two
147 entities will have the same public identifier. In practice,
148 PUBLIC identifiers are typically Formal Public Identifiers
149 [<a href="#ref-ISO.8879.1986" title="&quot;Information processing - Text and office systems - Standard generalized markup language (SGML)&quot;">ISO.8879.1986</a>] but they are not restricted to just that set. As
150 said in [<a href="./rfc3151" title="&quot;A URN Namespace for Public Identifiers&quot;">RFC3151</a>]:
151
152 "Any string which consists only of the public identifier
153 characters (defined by Production 13 of Extensible Markup
154 Language (XML) 1.0 Second Edition) is a legal public
155 identifier."
156
157 Therefore, it is legal for a PUBLIC identifier to be a URN if it
158 adheres to the character set restrictions.
159
160
161
162
163
164 <span class="grey">Mealling Best Current Practice [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc3688">RFC 3688</a> The IETF XML Registry January 2004</span>
167
168
169 Thus, the identifier registered along with a DTD is its PUBLIC
170 identifier. The only restriction being that it must adhere to the
171 character set restrictions. In the case where the registrant does
172 not provide one, the IANA will assign one of the form
173 'urn:ietf:params:xml:pi:&lt;id&gt;'. Registrants are encouraged to
174 investigate RFC 3151 [<a href="./rfc3151" title="&quot;A URN Namespace for Public Identifiers&quot;">RFC3151</a>] as a recommended method for
175 minting a URN that can also be represented as an FPI.
176
177 ns -- XML Namespaces [<a href="#ref-W3C.REC-xml-names" title="&quot;Namespaces in XML&quot;">W3C.REC-xml-names</a>] are named by a URI. They
178 have no real, machine-parseable representation. Thus, the
179 registered document will be either the specification or a
180 reference to it. In the case where a URI is not provided by the
181 registrant, the IANA will assign a URN of the form
182 'urn:ietf:params:xml:ns:&lt;id&gt; which will be the XML Namespace's
183 name.
184
185 schema -- XML Schemas [<a href="#ref-W3C.REC-xmlschema-1" title="&quot;XML Schema Part 1: Structures&quot;">W3C.REC-xmlschema-1</a>] are also identified by a
186 URI but their contents are machine parseable. The IANA registered
187 document will be the XML Schema file. The URN the IANA assigns
188 can be used as the URI for the schema and is of the form
189 'urn:ietf:params:xml:schema:&lt;id&gt;'.
190
191 rdfschema -- The Resource Description Format (RDF)
192 [<a href="#ref-W3C.CR-rdf-schema" title="&quot;Resource Description Framework (RDF) Schema Specification 1.0&quot;">W3C.CR-rdf-schema</a>] is an XML serialization of a connected graph
193 based data model used for metadata expression. RDF makes use of
194 schemas for RDF that express grammars about relationships between
195 URIs. These grammars are identified by URIs. The URN assigned by
196 the IANA can be used as the identifying URI and is of the form
197 'urn:ietf:params:xml:rdfschema:&lt;id&gt;'.
198
199 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Registration Procedures</span>
200
201 Until the IANA requests or implements an automated process for the
202 registration of these elements, any specifications must make that
203 request part of the IANA considerations section of their respective
204 documents. That request must be in the form of the following
205 template:
206
207 URI
208 The URI or PUBLIC identifier that identifies the XML component. If
209 the registrant is requesting that the IANA assign a URI then this
210 field should be specified as "please assign".
211
212 Registrant Contact
213 The individual/organization that is the registration contact for
214 the component being registered. Ideally, this will be the name
215 and pertinent physical and network contact information. In the
216 case of IETF developed standards, the Registrant will be the IESG.
217
218
219
220 <span class="grey">Mealling Best Current Practice [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc3688">RFC 3688</a> The IETF XML Registry January 2004</span>
223
224
225 XML
226 The exact XML to be stored in the registry. Unless the beginning
227 and end of the file is obvious, the document should use the text
228 "BEGIN" to mark the beginning of the file and "END" to mark the
229 end of the file. The IANA will insert any text between those two
230 strings (minus any page breaks and RFC formatting inserted by the
231 RFC Editor) into the file kept in the repository.
232
233 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Security Considerations</span>
234
235 The information maintained by the IANA will be authoritative and will
236 be a target for attack. In some cases, such as XML Schema and DTDs,
237 the content maintained by the IANA may be directly input into
238 software. Thus, extra care should be taken by the IANA to maintain
239 the security precautions required for an important reference location
240 for the Internet.
241
242 Beyond this concern, there are no other security considerations not
243 already found with any other IANA registry.
244
245 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. IANA Considerations</span>
246
247 This document seeks to create a rather large registry for which the
248 IANA (at the direction of the IESG) will be primarily responsible.
249 The amount of effort required to maintain this registry is not
250 insignificant and the policies and procedures surrounding any
251 approval process are non-trivial. The registry is on a First Come
252 First Served basis, but a Specification is Required. Once the IETF
253 has some experience with this registry, these policies may change.
254
255 <a href="./rfc3553">RFC 3553</a> [<a href="./rfc3553" title="&quot;An IETF URN Sub-namespace for Registered Protocol Parameters&quot;">RFC3553</a>] specifies that any new registry requiring a name,
256 to be assigned below the 'urn:ietf:params' namespace and must specify
257 the structure of that space in template form. The IANA has created
258 and will maintain this new sub-namespace:
259
260 Registry-name: xml
261
262 Specification: This document contains the registry specification.
263 The namespace is organized with one sub-namespace which is the
264 &lt;id&gt;.
265
266 Repository: To be assigned according to the guidelines found above.
267
268 Index value: The class name
269
270
271
272
273
274
275
276 <span class="grey">Mealling Best Current Practice [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc3688">RFC 3688</a> The IETF XML Registry January 2004</span>
279
280
281 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Normative References</span>
282
283 [<a id="ref-ISO.8879.1986">ISO.8879.1986</a>] International Organization for Standardization,
284 "Information processing - Text and office
285 systems - Standard generalized markup language
286 (SGML)", ISO Standard 8879, 1986.
287
288 [<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to
289 Indicate Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
290 March 1997.
291
292 [<a id="ref-RFC2396">RFC2396</a>] Berners-Lee, T., Fielding, R. and L. Masinter,
293 "Uniform Resource Identifiers (URI): Generic
294 Syntax", <a href="./rfc2396">RFC 2396</a>, August 1998.
295
296 [<a id="ref-RFC3151">RFC3151</a>] Walsh, N., Cowan, J. and P. Grosso, "A URN
297 Namespace for Public Identifiers", <a href="./rfc3151">RFC 3151</a>,
298 August 2001.
299
300 [<a id="ref-RFC3553">RFC3553</a>] Mealling, M., Masinter, L., Hardie, T. and G.
301 Klyne, "An IETF URN Sub-namespace for
302 Registered Protocol Parameters", <a href="https://www.rfc-editor.org/bcp/bcp73">BCP 73</a>, <a href="./rfc3553">RFC</a>
303 <a href="./rfc3553">3553</a>, June 2003.
304
305 [<a id="ref-W3C.CR-rdf-schema">W3C.CR-rdf-schema</a>] Brickley, D. and R. Guha, "Resource Description
306 Framework (RDF) Schema Specification 1.0", W3C
307 CR-rdf-schema, March 2000,
308 &lt;<a href="http://www.w3.org/TR/2000/CR-rdf-schema-20000327">http://www.w3.org/TR/2000/CR-rdf-schema-</a>
309 <a href="http://www.w3.org/TR/2000/CR-rdf-schema-20000327">20000327</a>&gt;.
310
311 [<a id="ref-W3C.REC-xml">W3C.REC-xml</a>] Bray, T., Paoli, J., Sperberg-McQueen, C. and
312 E. Maler, "Extensible Markup Language (XML) 1.0
313 (2nd ed)", W3C REC-xml, October 2000,
314 &lt;<a href="http://www.w3.org/TR/REC-xml">http://www.w3.org/TR/REC-xml</a>&gt;.
315
316 [<a id="ref-W3C.REC-xml-names">W3C.REC-xml-names</a>] Bray, T., Hollander, D. and A. Layman,
317 "Namespaces in XML", W3C REC-xml-names, January
318 1999, &lt;<a href="http://www.w3.org/TR/REC-xml-names">http://www.w3.org/TR/REC-xml-names</a>&gt;.
319
320 [<a id="ref-W3C.REC-xmlschema-1">W3C.REC-xmlschema-1</a>] Thompson, H., Beech, D., Maloney, M. and N.
321 Mendelsohn, "XML Schema Part 1: Structures",
322 W3C REC-xmlschema-1, May 2001,
323 &lt;<a href="http://www.w3.org/TR/xmlschema-1/">http://www.w3.org/TR/xmlschema-1/</a>&gt;.
324
325
326
327
328
329
330
331
332 <span class="grey">Mealling Best Current Practice [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc3688">RFC 3688</a> The IETF XML Registry January 2004</span>
335
336
337 <span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Intellectual Property Statement</span>
338
339 The IETF takes no position regarding the validity or scope of any
340 intellectual property or other rights that might be claimed to
341 pertain to the implementation or use of the technology described in
342 this document or the extent to which any license under such rights
343 might or might not be available; neither does it represent that it
344 has made any effort to identify any such rights. Information on the
345 IETF's procedures with respect to rights in standards-track and
346 standards-related documentation can be found in <a href="https://www.rfc-editor.org/bcp/bcp11">BCP-11</a>. Copies of
347 claims of rights made available for publication and any assurances of
348 licenses to be made available, or the result of an attempt made to
349 obtain a general license or permission for the use of such
350 proprietary rights by implementors or users of this specification can
351 be obtained from the IETF Secretariat.
352
353 The IETF invites any interested party to bring to its attention any
354 copyrights, patents or patent applications, or other proprietary
355 rights which may cover technology that may be required to practice
356 this standard. Please address the information to the IETF Executive
357 Director.
358
359 <span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Author's Address</span>
360
361 Michael Mealling
362 VeriSign, Inc.
363 Mountain View, CA
364 USA
365
366 EMail: [email protected]
367 URI: <a href="http://www.research.verisignlabs.com">http://www.research.verisignlabs.com</a>
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388 <span class="grey">Mealling Best Current Practice [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc3688">RFC 3688</a> The IETF XML Registry January 2004</span>
391
392
393 <span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Full Copyright Statement</span>
394
395 Copyright (C) The Internet Society (2004). All Rights Reserved.
396
397 This document and translations of it may be copied and furnished to
398 others, and derivative works that comment on or otherwise explain it
399 or assist in its implementation may be prepared, copied, published
400 and distributed, in whole or in part, without restriction of any
401 kind, provided that the above copyright notice and this paragraph are
402 included on all such copies and derivative works. However, this
403 document itself may not be modified in any way, such as by removing
404 the copyright notice or references to the Internet Society or other
405 Internet organizations, except as needed for the purpose of
406 developing Internet standards in which case the procedures for
407 copyrights defined in the Internet Standards process must be
408 followed, or as required to translate it into languages other than
409 English.
410
411 The limited permissions granted above are perpetual and will not be
412 revoked by the Internet Society or its successors or assignees.
413
414 This document and the information contained herein is provided on an
415 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
416 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
417 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
418 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
419 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
420
421 Acknowledgement
422
423 Funding for the RFC Editor function is currently provided by the
424 Internet Society.
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444 Mealling Best Current Practice [Page 8]
445 </pre>