Network Working Group R. Moats
Request for Comments: 2648 AT&T
Category: Informational August 1999
A URN Namespace for IETF Documents
Status of this Memo
This memo provides information for the Internet community. It does
not specify an Internet standard of any kind. Distribution of this
memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (1999). All Rights Reserved.
Abstract
A system for Uniform Resource Names (URNs) must be capable of
supporting new naming systems. As an example of proposing a new
namespace, this document proposes the "ietf" namespace. This
namespace consists of the RFC family of documents (RFCs, STDs, FYIs,
and BCPs) developed by the IETF and published by the RFC Editor, the
minutes of working groups (WG) and birds of a feather (BOF) meetings
that occur during IETF conferences, and the Internet Drafts published
by the Internet Drafts Editor. Both the current URN framework and
URN syntax support this namespace.
1. Introduction
This document proposes the "ietf" namespace, which consists of the
RFC family of documents (RFCs, STDs, FYIs, and BCPs) developed by the
IETF and published by the RFC editor and the minutes of working
groups (WG) and birds of a feather (BOF) meetings that occur during
IETF conferences.
The namespace specification is for a formal namespace.
2. Specification Template
Namespace ID:
"ietf" requested.
Moats Informational [Page 1]
RFC 2648 A URN Namespace for IETF Documents August 1999
Registration Information:
Registration version number: 1
Registration date: 1999-04-22
Declared registrant of the namespace:
Ryan Moats
jayhawk@att.com
AT&T
15621 Drexel Circle
Omaha, NE 68135-2358
Declaration of structure:
The identifier has the following ABNF [2] specification:
NSS = rfc-nss / fyi-nss / std-nss / bcp-nss /
draft-nss / mtg-nss / other-nss
rfc-nss = "rfc:" 1*DIGIT
fyi-nss = "fyi:" 1*DIGIT
std-nss = "std:" 1*DIGIT
bcp-nss = "bcp:" 1*DIGIT
draft-nss = "id:" string
mtg-nss = "mtg:" string
other-nss = string
; beginning with a prefix other than one of those
; above for future expansion
string = 1*(DIGIT / ALPHA / "-")
If the IESG (or it successor) adds a new document series,
this ABNF specification will need to be updated. Further,
if a working group or BOF is created that used characters
outside the range of this ABNF specification, this
specification will need to be updated. Any system intended
to resolve names for this namespace should be written with
the awareness that this could occur at any time.
Relevant ancillary documentation:
Relevant documentation is in RFC 2648.
Moats Informational [Page 2]
RFC 2648 A URN Namespace for IETF Documents August 1999
Identifier uniqueness considerations:
Because the rfc-editor assigns the RFC number uniquely these
URNs are unique. Since the mapping between RFCs and other
rfc-editor document series (STDs, FYIs or BCPs) is not
necessarily one-to-one, uniqueness of STDs, FYIs and BCPs
are defined based on the document mappings maintained by the
RFC Editor (the index files "rfc-index.txt", "fyi-
index.txt", "bcp-index.txt", "std-index.txt") are defined to
be the definitive statement of the assignment of RFC Family
URNs in this namespace. The meeting minutes portion of the
namespace is guaranteed unique because the URN includes the
sequence number of the IETF conference. The document
mapping maintained by the Internet Drafts editor ("1id-
abstracts.txt") is defined as the definitive statement of
the assignment of URNs for the internet draft portion of
this namespace.
Identifier persistence considerations:
Persistence of the URNs of this namespace is independent of
the mutability of the underlying documents. A URN once
assigned will never be reassigned to a different resource;
the assignment is persistent and immutable. Immutability of
RFCs, STDs, FYIs and BCPs is at the discretion of the RFC
Editor. They may be composites of one or more RFCs and the
set of RFCs that includes them may change with time. It is
important to note that this mutability of some resources is
independent of the immutability of URN assignment to a
resource.
Process of identifier assignment:
Assignment of URNs from this namespace occurs in three ways.
The first is through publication of a new RFC, FYI, STD or
BCP is by the RFC Editor. This new document will have a new
series number and will therefore define a new URN. The
document mappings maintained by the RFC Editor (the index
files "rfc-index.txt", "fyi-index.txt", "bcp-index.txt" and
"std-index.txt") are defined to be the definitive statement
of the assignment of RFC Family URNs in this namespace.
The second way a URN is assigned is through the filing of
meeting minutes by a working group or birds of a feather as
part of an IETF conference. The list of minutes maintained
by the IETF for each working group and conference in the
subtree pointed at by the URL ftp://ietf.org/ietf/ is
considered the definitive assignment of URNs for working
Moats Informational [Page 3]
RFC 2648 A URN Namespace for IETF Documents August 1999
group or birds of a feather minutes.
The third way a URN is assigned is through the publication
of a new internet-draft by the Internet Draft Editor. This
draft will have a distinct name (and version number) and
therefore defined a new URN. The document mapping
maintained by the Internet Drafts editor ("1id-
abstracts.txt") is defined as the definitive statement of
the assignment of URNs for this portion of the namespace.
Process of identifier resolution:
A mirrored copy of the underlying documentation is required
to resolve these URNs. Resolution via HTTP is done by a set
of simple Perl cgi-bin scripts presented in Appendix A.
Rules for Lexical Equivalence:
The entire URN is case-insensitive.
Conformance with URN Syntax:
There are no additional characters reserved.
Validation mechanism:
None additional to resolution specified
Scope:
Global.
3. Examples
The following are examples of URNs that a resolver for this namespace
can resolve:
urn:ietf:rfc:2141
urn:ietf:std:50
urn:ietf:id:ietf-urn-ietf-06
urn:ietf:mtg:41-urn
Moats Informational [Page 4]
RFC 2648 A URN Namespace for IETF Documents August 1999
4. Security Considerations
Because this namespace defines no additional reserved characters, it
does not add any security considerations beyond those inherent from
the existence of the reserved characters from [1]. Further, none of
the reserved characters from [1] are used in the definition of the
NSS. This means that resolvers for this namespace may be considered
"secure" in the sense that any escaping of characters in the NSS MUST
result in the resolver indicating that the URN has incorrect syntax.
5. Acknowledgments
Thanks to various members of the URN working group for comments on
earlier drafts of this document. The work described in this document
is partially supported by the National Science Foundation,
Cooperative Agreement NCR-9218179.
6. References
Request For Comments (RFC) and Internet Draft documents are available
from numerous mirror sites.
[1] Moats, R., "URN Syntax", RFC 2141, May 1997.
[2] Crocker, D. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", RFC 2234, November 1997.
7. Author's Address
Ryan Moats
AT&T
15621 Drexel Circle
Omaha, NE 68135-2358
USA
EMail: jayhawk@att.com
Moats Informational [Page 5]
RFC 2648 A URN Namespace for IETF Documents August 1999
Appendix A. Example Resolution Scripts
The following scripts are examples that can be used for resolving
URNs in this namespace.
A.1 I2C
#!/usr/local/bin/perl
use strict;
#
# this is a URN 2 URC resolver for the ietf namespace
#
my(%cite) = (
bcp => "/ftp/rfc/bcp-index.txt",
fyi => "/ftp/fyi/fyi-index.txt",
id => "/ftp/internet-drafts/1id-abstracts.txt",
rfc => "/ftp/rfc/rfc-index.txt",
std => "/ftp/std/std-index.txt"
);
my(%number2date) = (
44 => "99mar",
43 => "98dec", 42 => "98aug", 41 => "98apr",
40 => "97dec", 39 => "97aug", 38 => "97apr",
37 => "96dec", 36 => "96jun", 35 => "96mar",
34 => "95dec", 33 => "95jul", 32 => "95apr",
31 => "94dec", 30 => "94jul", 29 => "94mar",
28 => "93nov", 27 => "93jul", 26 => "93mar",
25 => "92nov", 24 => "92jul", 23 => "92mar",
22 => "91nov", 21 => "91jul", 20 => "91mar",
19 => "90dec" );
my($wgpath) = "/ftp/ietf";
my($urn) = $ENV{'QUERY_STRING'};
my($host) = $ENV{'SERVER_NAME'}; #get my host name for ftp: URLs
my($accept) = $ENV{'HTTP_ACCEPT'}; #this is the "Accept:" HTTP header
(&resolveid($1), exit) if ($urn =~ /urn:ietf:id:(\S+)/i);
(&resolverfc($1, $2), exit) if ($urn =~ /urn:ietf:(\w*):(\d*)/i);
(&resolvemtg($1, $2), exit) if ($urn =~ /urn:ietf:mtg:(\d*)-(\w*)/i);
&urn_error("400 Bad Request\n");
sub resolvemtg {
my($ietfnum, $sesnam) = @_;
&urn_error("404 Not Found\n") if (!defined $number2date{$ietfnum});
my($date)=$number2date{$ietfnum};
Moats Informational [Page 6]
RFC 2648 A URN Namespace for IETF Documents August 1999
my($link)="$wgpath/$sesnam/$sesnam-minutes-$date.txt";
if (-f $link) {
print "Status: 200 OK\r\n";
print "Content-type: text/html\r\n\r\n";
print "\n
\n";
print "Minutes of the $sesnam working group from the "
. &end($ietfnum) . " IETF";
print "\n\n";
return;
}
my($link)="$wgpath/$date/$sesnam-minutes-$date.txt";
if (-f $link) {
print "Status: 200 OK\r\n";
print "Content-type: text/html\r\n\r\n";
print "\nCitation for $urn\n";
print "\n";
print "
\n\n\n";
Moats Informational [Page 21]
RFC 2648 A URN Namespace for IETF Documents August 1999
}
}
}
sub make_link {
my($sc);
my($inarg)=@_;
($sc=$1) if ($inarg =~ /([a-z]*)/);
return "/$sc/$inarg.ps" if (-e "/ftp/$sc/$inarg.ps");
return "/$sc/$inarg.html" if (-e "/ftp/$sc/$inarg.html");
return "/$sc/$inarg.txt";
}
sub urn_error {
my($code) = @_; #store failure code here...
print "Status: $code";
print "Content-type: text/html\n\n\n";
print "URN Resolution: I2Ns $code\n";
print "\n";
print "
URN to URN resolution failed for the URN:
\n";
print "
$urn
\n";
print "\n";
print "\n";
exit;
};
A.5 I2R
#!/usr/local/bin/perl
use strict;
#
# this is a URN 2 resource resolver for the ietf namespace
#
my(%pathbase) = (
rfc => "rfc/rfc",
fyi => "fyi/fyi",
std => "std/std",
bcp => "bcp/bcp",
id => "internet-drafts/draft-"
);
my(%number2date) = (
44 => "99mar",
43 => "98dec", 42 => "98aug", 41 => "98apr",
Moats Informational [Page 22]
RFC 2648 A URN Namespace for IETF Documents August 1999
40 => "97dec", 39 => "97aug", 38 => "97apr",
37 => "96dec", 36 => "96jun", 35 => "96mar",
34 => "95dec", 33 => "95jul", 32 => "95apr",
31 => "94dec", 30 => "94jul", 29 => "94mar",
28 => "93nov", 27 => "93jul", 26 => "93mar",
25 => "92nov", 24 => "92jul", 23 => "92mar",
22 => "91nov", 21 => "91jul", 20 => "91mar",
19 => "90dec" );
my($wgpath) = "/ftp/ietf";
my($urn) = $ENV{'QUERY_STRING'};
my($host) = $ENV{'SERVER_NAME'}; #get my host name for ftp: URLs
my($accept) = $ENV{'HTTP_ACCEPT'}; #this is the "Accept:" HTTP header
print "$urn\n";
(&resolveid($1), exit) if ($urn =~ /urn:ietf:id:(\S+)/i);
(&resolve1($1, $2), exit) if ($urn =~ /urn:ietf:(\w*):(\d*)/i);
(&resolve2($1, $2), exit) if ($urn =~ /urn:ietf:mtg:(\d*)-(\w*)/i);
&urn_error("400 Bad Request\n");
sub resolve2 {
my($ietfnum, $sesnam) = @_;
&urn_error("404 Not Found\n") if (!defined $number2date{$ietfnum});
my($date)=$number2date{$ietfnum};
my($link)="$wgpath/$sesnam/$sesnam-minutes-$date.txt";
if (-f $link) {
print "Status: 200 OK\n";
print "Content-type: text/plain\n\n";
open(FILE, "$link");
while () {
print $_;
}
close FILE;
return;
}
my($link)="$wgpath/$date/$sesnam-minutes-$date.txt";
if (-f $link) {
print "Status: 200 OK\n";
print "Content-type: text/plain\n\n";
open(FILE, "$link");
while () {
print $_;
}
close FILE;
return;
}
&urn_error("404 Not Found\n");
}
Moats Informational [Page 23]
RFC 2648 A URN Namespace for IETF Documents August 1999
sub end {
my($inarg)=@_;
return $inarg . "st" if ($inarg =~ /1$/);
return $inarg . "nd" if ($inarg =~ /2$/);
return $inarg . "rd" if ($inarg =~ /3$/);
return $inarg . "th";
}
sub resolve1 {
my($flag,@bib,$i,$k,$j,$done,@ref);
my($l,$link);
my($scheme, $value) = @_;
$scheme =~ tr/A-Z/a-z/;
&urn_error("404 Not Found\n")if (!defined $pathbase{$scheme});
my($txttry)="/ftp/$pathbase{$scheme}$value.txt";
my($pstry)="/ftp/$pathbase{$scheme}$value.ps";
my($htmltry)="/ftp/$pathbase{$scheme}$value.html";
MIME_SWITCH: {
if ($accept =~ /application\/postscript/ && -f $pstry) {
print "Status: 200 OK\n";
print "Content-type: application/postscript\n\n";
open(FILE, "$pstry");
while () {
print $_;
}
close FILE;
last MIME_SWITCH;
}
if ($accept =~ /text\/html/ && -f $htmltry) {
print "Status: 200 OK\n";
print "Content-type: text/html\n\n";
open(FILE, "$htmltry");
while () {
print $_;
}
close FILE;
last MIME_SWITCH;
}
if ($accept =~ /\*\/\*|text\/plain/ && -f $txttry) {
print "Status: 200 OK\n";
print "Content-type: text/plain\n\n";
open(FILE, "$txttry");
while () {
print $_;
}
close FILE;
last MIME_SWITCH;
}
Moats Informational [Page 24]
RFC 2648 A URN Namespace for IETF Documents August 1999
&urn_error("404 Not Found\n");
}
}
sub resolveid {
my($flag,@bib,$i,$k,$j,$done,@ref);
my($l,$link);
my($scheme) = "id";
my($value) = @_;
$scheme =~ tr/A-Z/a-z/;
&urn_error("404 Not Found\n")if (!defined $pathbase{$scheme});
my($txttry)="/ftp/$pathbase{$scheme}$value.txt";
my($pstry)="/ftp/$pathbase{$scheme}$value.ps";
my($htmltry)="/ftp/$pathbase{$scheme}$value.html";
MIME_SWITCH: {
if ($accept =~ /application\/postscript/ && -f $pstry) {
print "Status: 200 OK\n";
print "Content-type: application/postscript\n\n";
open(FILE, "$pstry");
while () {
print $_;
}
close FILE;
last MIME_SWITCH;
}
if ($accept =~ /text\/html/ && -f $htmltry) {
print "Status: 200 OK\n";
print "Content-type: text/html\n\n";
open(FILE, "$htmltry");
while () {
print $_;
}
close FILE;
last MIME_SWITCH;
}
if ($accept =~ /\*\/\*|text\/plain/ && -f $txttry) {
print "Status: 200 OK\n";
print "Content-type: text/plain\n\n";
open(FILE, "$txttry");
while () {
print $_;
}
close FILE;
last MIME_SWITCH;
}
&urn_error("404 Not Found\n");
}
}
Moats Informational [Page 25]
RFC 2648 A URN Namespace for IETF Documents August 1999
sub urn_error {
my($code) = @_; #store failure code here...
print "Status: $code";
print "Content-type: text/html\n\n\n";
print "URN Resolution: I2R $code\n";
print "\n";
print "
URN to URL resolution failed for the URN:
\n";
print "
$urn
\n";
print "\n";
print "\n";
exit;
}
A.6 I2Rs
#!/usr/local/bin/perl
use strict;
#
# this is a URN 2 resources resolver for the ietf namespace
#
my(@urls);
my(%pathbase) = (
rfc => "rfc/rfc",
fyi => "fyi/fyi",
std => "std/std",
bcp => "bcp/bcp",
id => "internet-drafts/draft-"
);
my(%number2date) = (
44 => "99mar",
43 => "98dec", 42 => "98aug", 41 => "98apr",
40 => "97dec", 39 => "97aug", 38 => "97apr",
37 => "96dec", 36 => "96jun", 35 => "96mar",
34 => "95dec", 33 => "95jul", 32 => "95apr",
31 => "94dec", 30 => "94jul", 29 => "94mar",
28 => "93nov", 27 => "93jul", 26 => "93mar",
25 => "92nov", 24 => "92jul", 23 => "92mar",
22 => "91nov", 21 => "91jul", 20 => "91mar",
19 => "90dec" );
my($wgpath) = "/ftp/ietf";
my($urn) = $ENV{'QUERY_STRING'};
Moats Informational [Page 26]
RFC 2648 A URN Namespace for IETF Documents August 1999
my($host) = $ENV{'SERVER_NAME'}; #get my host name for ftp: URLs
my($accept) = $ENV{'HTTP_ACCEPT'}; #this is the "Accept:" HTTP header
(&resolveid($1), exit) if ($urn =~ /urn:ietf:id:(\s*)/i);
(&resolve1($1, $2), exit) if ($urn =~ /urn:ietf:(\w*):(\d*)/i);
(&resolve2($1, $2), exit) if ($urn =~ /urn:ietf:mtg:(\d*)-(\w*)/i);
&urn_error("400 Bad Request\n");
sub resolve2 {
my($ietfnum, $sesnam) = @_;
my(@vers,$i);
&urn_error("404 Not Found\n") if (!defined $number2date{$ietfnum});
my($date)=$number2date{$ietfnum};
my($link)="$wgpath/$sesnam/$sesnam-minutes-$date.txt";
if (-f $link) {
push(@vers,$link);
}
$link="$wgpath/$date/$sesnam-minutes-$date.txt";
if (-f $link) {
push(@vers,$link);
}
&urn_error("404 Not Found\n") if ($#vers==-1);
print "Status: 200 OK\n";
print "Content-type: multipart/alternative; boundary=endpart\n\n";
foreach $i (@vers) {
print "--endpart\n";
if ($i =~ /html$/) {
print "Content-Type: text/html\n\n";
}
if ($i =~ /txt$/) {
print "Content-Type: text/plain\n\n";
}
if ($i =~ /ps$/) {
print "Content-Type: application/postscript\n\n";
}
open(FILE, "$i");
while () {
print "$_";
}
close FILE;
}
print "--endpart\n";
}
sub resolve1 {
my($flag,@bib,$i,$k,$j,$done,@ref);
Moats Informational [Page 27]
RFC 2648 A URN Namespace for IETF Documents August 1999
my($l,$link,@vers);
my($scheme, $value) = @_;
$scheme =~ tr/A-Z/a-z/;
&urn_error("404 Not Found\n")if (!defined $pathbase{$scheme});
my($try)="/ftp/$pathbase{$scheme}$value.txt";
if (-f $try) {
push(@vers, $try);
}
$try="/ftp/$pathbase{$scheme}$value.ps";
if (-f $try) {
push(@vers, $try);
}
$try="/ftp/$pathbase{$scheme}$value.html";
if (-f $try) {
push(@vers, $try);
}
print "Status: 200 OK\n";
print "Content-type: multipart/alternative; boundary=endpart\n\n";
foreach $i (@vers) {
print "--endpart\n";
if ($i =~ /html$/) {
print "Content-Type: text/html\n\n";
}
if ($i =~ /txt$/) {
print "Content-Type: text/plain\n\n";
}
if ($i =~ /ps$/) {
print "Content-Type: application/postscript\n\n";
}
open(FILE, "$i");
while () {
print "$_";
}
close FILE;
}
print "--endpart\n";
}
sub resolveid {
my($flag,@bib,$i,$k,$j,$done,@ref);
my($l,$link,@vers);
my($scheme) = "id";
my($value) = @_;
$scheme =~ tr/A-Z/a-z/;
&urn_error("404 Not Found\n")if (!defined $pathbase{$scheme});
my($try)="/ftp/$pathbase{$scheme}$value.txt";
if (-f $try) {
Moats Informational [Page 28]
RFC 2648 A URN Namespace for IETF Documents August 1999
push(@vers, $try);
}
$try="/ftp/$pathbase{$scheme}$value.ps";
if (-f $try) {
push(@vers, $try);
}
$try="/ftp/$pathbase{$scheme}$value.html";
if (-f $try) {
push(@vers, $try);
}
print "Status: 200 OK\n";
print "Content-type: multipart/alternative; boundary=endpart\n\n";
foreach $i (@vers) {
print "--endpart\n";
if ($i =~ /html$/) {
print "Content-Type: text/html\n\n";
}
if ($i =~ /txt$/) {
print "Content-Type: text/plain\n\n";
}
if ($i =~ /ps$/) {
print "Content-Type: application/postscript\n\n";
}
open(FILE, "$i");
while () {
print "$_";
}
close FILE;
}
print "--endpart\n";
}
sub urn_error {
my($code) = @_; #store failure code here...
print "Status: $code";
print "Content-type: text/html\n\n\n";
print "URN Resolution: I2Rs $code\n";
print "\n";
print "
URN to URL resolution failed for the URN:
\n";
print "
$urn
\n";
print "\n";
print "\n";
exit;
}
Moats Informational [Page 29]
RFC 2648 A URN Namespace for IETF Documents August 1999
Full Copyright Statement
Copyright (C) The Internet Society (1999). 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 assigns.
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
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.
Moats Informational [Page 30]