| 1 |
<pre>Network Working Group M. Smith |
| 2 |
Request for Comments: 2079 Netscape Communications |
| 3 |
Category: Standards Track January 1997 |
| 4 |
|
| 5 |
|
| 6 |
<span class="h1">Definition of an X.500 Attribute Type and an Object Class to Hold</span> |
| 7 |
<span class="h1">Uniform Resource Identifiers (URIs)</span> |
| 8 |
|
| 9 |
Status of this Memo |
| 10 |
|
| 11 |
This document specifies an Internet standards track protocol for the |
| 12 |
Internet community, and requests discussion and suggestions for |
| 13 |
improvements. Please refer to the current edition of the "Internet |
| 14 |
Official Protocol Standards" (STD 1) for the standardization state |
| 15 |
and status of this protocol. Distribution of this memo is unlimited. |
| 16 |
|
| 17 |
Abstract |
| 18 |
|
| 19 |
Uniform Resource Locators (URLs) are being widely used to specify the |
| 20 |
location of Internet resources. There is an urgent need to be able |
| 21 |
to include URLs in directories that conform to the LDAP and X.500 |
| 22 |
information models, and a desire to include other types of Uniform |
| 23 |
Resource Identifiers (URIs) as they are defined. A number of |
| 24 |
independent groups are already experimenting with the inclusion of |
| 25 |
URLs in LDAP and X.500 directories. This document builds on the |
| 26 |
experimentation to date and defines a new attribute type and an |
| 27 |
auxiliary object class to allow URIs, including URLs, to be stored in |
| 28 |
directory entries in a standard way. |
| 29 |
|
| 30 |
Background and Intended Usage |
| 31 |
|
| 32 |
Uniform Resource Locators (URLs) as defined by [<a href="#ref-1" title=""Uniform Resource Locators (URL)"">1</a>] are the first of |
| 33 |
several types of Uniform Resource Identifiers (URIs) being defined by |
| 34 |
the IETF. URIs are widely used on the Internet, most notably within |
| 35 |
Hypertext Markup Language [<a href="#ref-2" title=""Hypertext Markup Language - 2.0"">2</a>] documents. This document defines an |
| 36 |
X.500 [<a href="#ref-3" title="Models and Service. CCITT Recommendation X.500">3</a>,<a href="#ref-4" title="Models and Service. ISO/IEC JTC 1/SC21; International Standard 9594-1">4</a>] attribute type called labeledURI and an auxiliary object |
| 37 |
class called labeledURIObject to hold all types of URIs, including |
| 38 |
URLs. These definitions are designed for use in LDAP and X.500 |
| 39 |
directories, and may be used in other contexts as well. |
| 40 |
|
| 41 |
|
| 42 |
|
| 43 |
|
| 44 |
|
| 45 |
|
| 46 |
|
| 47 |
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
<span class="grey">Smith Standards Track [Page 1]</span></pre> |
| 53 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span> |
| 54 |
<span class="grey"><a href="./rfc2079">RFC 2079</a> URI Attribute Type and Object Class January 1997</span> |
| 55 |
|
| 56 |
|
| 57 |
Schema Definition of the labeledURI Attribute Type |
| 58 |
|
| 59 |
Name: labeledURI |
| 60 |
ShortName: None |
| 61 |
Description: Uniform Resource Identifier with optional label |
| 62 |
OID: umichAttributeType.57 (1.3.6.1.4.1.250.1.57) |
| 63 |
Syntax: caseExactString |
| 64 |
SizeRestriction: None |
| 65 |
SingleValued: False |
| 66 |
|
| 67 |
Discussion of the labeledURI Attribute Type |
| 68 |
|
| 69 |
The labeledURI attribute type has the caseExactString syntax (since |
| 70 |
URIs are case-sensitive) and it is multivalued. Values placed in the |
| 71 |
attribute should consist of a URI (at the present time, a URL) |
| 72 |
optionally followed by one or more space characters and a label. |
| 73 |
Since space characters are not allowed to appear un-encoded in URIs, |
| 74 |
there is no ambiguity about where the label begins. At the present |
| 75 |
time, the URI portion must comply with the URL specification [<a href="#ref-1" title=""Uniform Resource Locators (URL)"">1</a>]. |
| 76 |
Multiple labeledURI values will generally indicate different |
| 77 |
resources that are all related to the X.500 object, but may indicate |
| 78 |
different locations for the same resource. |
| 79 |
|
| 80 |
The label is used to describe the resource to which the URI points, |
| 81 |
and is intended as a friendly name fit for human consumption. This |
| 82 |
document does not propose any specific syntax for the label part. In |
| 83 |
some cases it may be helpful to include in the label some indication |
| 84 |
of the kind and/or size of the resource referenced by the URI. |
| 85 |
|
| 86 |
Note that the label may include any characters allowed by the |
| 87 |
caseExactString syntax, but that the use of non-IA5 (non-ASCII) |
| 88 |
characters is discouraged as not all directory clients may handle |
| 89 |
them in the same manner. If non-IA5 characters are included, they |
| 90 |
should be represented using the X.500 conventions, not the HTML |
| 91 |
conventions (e.g., the character that is an "a" with a ring above it |
| 92 |
should be encoded using the T.61 sequence 0xCA followed by an "a" |
| 93 |
character; do not use the HTML escape sequence "&aring"). |
| 94 |
|
| 95 |
Examples of labeledURI Attribute Values |
| 96 |
|
| 97 |
An example of a labeledURI attribute value that does not include a |
| 98 |
label: |
| 99 |
|
| 100 |
<a href="ftp://ds.internic.net/rfc/rfc822.txt">ftp://ds.internic.net/rfc/rfc822.txt</a> |
| 101 |
|
| 102 |
|
| 103 |
|
| 104 |
|
| 105 |
|
| 106 |
|
| 107 |
|
| 108 |
<span class="grey">Smith Standards Track [Page 2]</span></pre> |
| 109 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span> |
| 110 |
<span class="grey"><a href="./rfc2079">RFC 2079</a> URI Attribute Type and Object Class January 1997</span> |
| 111 |
|
| 112 |
|
| 113 |
An example of a labeledURI attribute value that contains a tilde |
| 114 |
character in the URL (special characters in a URL must be encoded as |
| 115 |
specified by the URL document [<a href="#ref-1" title=""Uniform Resource Locators (URL)"">1</a>]). The label is "LDAP Home Page": |
| 116 |
|
| 117 |
<a href="http://www.umich.edu/%7Ersug/ldap/">http://www.umich.edu/%7Ersug/ldap/</a> LDAP Home Page |
| 118 |
|
| 119 |
Another example. This one includes a hint in the label to help the |
| 120 |
user realize that the URL points to a photo image. |
| 121 |
|
| 122 |
<a href="http://champagne.inria.fr/Unites/rennes.gif">http://champagne.inria.fr/Unites/rennes.gif</a> Rennes [photo] |
| 123 |
|
| 124 |
Schema Definition of the labeledURIObject Object Class |
| 125 |
|
| 126 |
Name: labeledURIObject |
| 127 |
Description: object that contains the URI attribute type |
| 128 |
OID: umichObjectClass.15 (1.3.6.1.4.1.250.3.15) |
| 129 |
SubclassOf: top |
| 130 |
MustContain: |
| 131 |
MayContain: labeledURI |
| 132 |
|
| 133 |
Discussion of the labeledURIObject Object Class |
| 134 |
|
| 135 |
The labeledURIObject class is a subclass of top and may contain the |
| 136 |
labeledURI attribute. The intent is that this object class can be |
| 137 |
added to existing directory objects to allow for inclusion of URI |
| 138 |
values. This approach does not preclude including the labeledURI |
| 139 |
attribute type directly in other object classes as appropriate. |
| 140 |
|
| 141 |
Security Considerations |
| 142 |
|
| 143 |
Security considerations are not discussed in this memo, except to |
| 144 |
note that blindly inserting the label portion of a labeledURI |
| 145 |
attribute value into an HTML document is not recommended, as this may |
| 146 |
allow a malicious individual to include HTML tags in the label that |
| 147 |
mislead viewers of the entire document in which the labeledURI value |
| 148 |
was inserted. |
| 149 |
|
| 150 |
Acknowledgments |
| 151 |
|
| 152 |
Paul-Andre Pays, Martijn Koster, Tim Howes, Rakesh Patel, Russ |
| 153 |
Wright, and Hallvard Furuseth provided invaluable assistance in the |
| 154 |
creation of this document. |
| 155 |
|
| 156 |
This material is based in part upon work supported by the National |
| 157 |
Science Foundation under Grant No. NCR-9416667. |
| 158 |
|
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
<span class="grey">Smith Standards Track [Page 3]</span></pre> |
| 165 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span> |
| 166 |
<span class="grey"><a href="./rfc2079">RFC 2079</a> URI Attribute Type and Object Class January 1997</span> |
| 167 |
|
| 168 |
|
| 169 |
Appendix: The labeledURL Attribute Type (Deprecated) |
| 170 |
|
| 171 |
An earlier draft of this document defined an additional attribute |
| 172 |
type called labeledURL. This attribute type is deprecated, and |
| 173 |
should not be used when adding new values to directory entries. The |
| 174 |
original motivation for including a separate attribute type to hold |
| 175 |
URLs was that this would better enable efficient progammatic access |
| 176 |
to specific types of URIs. After some deliberation, the IETF-ASID |
| 177 |
working group concluded that it was better to simply have one |
| 178 |
attribute than two. |
| 179 |
|
| 180 |
The schema definition for labeledURL is included here for historical |
| 181 |
reference only. Directory client software may want to support this |
| 182 |
schema definition (in addition to labeledURI) to ease the transition |
| 183 |
away from labeledURL for those sites that are using it. |
| 184 |
|
| 185 |
Name: labeledURL |
| 186 |
ShortName: None |
| 187 |
Description: Uniform Resource Locator with optional label |
| 188 |
OID: umichAttributeType.41 (1.3.6.1.4.1.250.1.41) |
| 189 |
Syntax: caseExactString |
| 190 |
SizeRestriction: None |
| 191 |
SingleValued: False |
| 192 |
OID: umichAttributeType.41 (1.3.6.1.4.1.250.1.41) |
| 193 |
|
| 194 |
References |
| 195 |
|
| 196 |
[<a id="ref-1">1</a>] Berners-Lee, T., Masinter, L., and M. McCahill, "Uniform |
| 197 |
Resource Locators (URL)", <a href="./rfc1738">RFC 1738</a>, CERN, Xerox Corporation, |
| 198 |
University of Minnesota, December 1994. |
| 199 |
<URL:ftp://ds.internic.net/rfc/rfc1738.txt> |
| 200 |
|
| 201 |
[<a id="ref-2">2</a>] Berners-Lee, T., and D. Connolly, "Hypertext Markup Language - |
| 202 |
2.0", <a href="./rfc1866">RFC 1866</a>, <URL:ftp://ds.internic.net/rfc/rfc1866.txt> |
| 203 |
|
| 204 |
[<a id="ref-3">3</a>] The Directory: Overview of Concepts, Models and Service. CCITT |
| 205 |
Recommendation X.500, 1988. |
| 206 |
|
| 207 |
[<a id="ref-4">4</a>] Information Processing Systems -- Open Systems Interconnection -- |
| 208 |
The Directory: Overview of Concepts, Models and Service. ISO/IEC JTC |
| 209 |
1/SC21; International Standard 9594-1, 1988. |
| 210 |
|
| 211 |
|
| 212 |
|
| 213 |
|
| 214 |
|
| 215 |
|
| 216 |
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
<span class="grey">Smith Standards Track [Page 4]</span></pre> |
| 221 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span> |
| 222 |
<span class="grey"><a href="./rfc2079">RFC 2079</a> URI Attribute Type and Object Class January 1997</span> |
| 223 |
|
| 224 |
|
| 225 |
Author's Address |
| 226 |
|
| 227 |
Mark Smith |
| 228 |
Netscape Communications Corp. |
| 229 |
501 E. Middlefield Rd. |
| 230 |
Mountain View, CA 94043, USA |
| 231 |
|
| 232 |
Phone: +1 415 937-3477 |
| 233 |
EMail: [email protected] |
| 234 |
|
| 235 |
|
| 236 |
|
| 237 |
|
| 238 |
|
| 239 |
|
| 240 |
|
| 241 |
|
| 242 |
|
| 243 |
|
| 244 |
|
| 245 |
|
| 246 |
|
| 247 |
|
| 248 |
|
| 249 |
|
| 250 |
|
| 251 |
|
| 252 |
|
| 253 |
|
| 254 |
|
| 255 |
|
| 256 |
|
| 257 |
|
| 258 |
|
| 259 |
|
| 260 |
|
| 261 |
|
| 262 |
|
| 263 |
|
| 264 |
|
| 265 |
|
| 266 |
|
| 267 |
|
| 268 |
|
| 269 |
|
| 270 |
|
| 271 |
|
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
Smith Standards Track [Page 5] |
| 277 |
</pre> |