Debian Codegraph @

rfc2293.html

raw
1 <pre>Network Working Group S. Kille
2 Request for Comments: 2293 Isode Ltd.
3 Obsoletes: <a href="./rfc1837">1837</a> March 1998
4 Category: Standards Track
5
6
7 <span class="h1">Representing Tables and Subtrees in the X.500 Directory</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 Copyright Notice
18
19 Copyright (C) The Internet Society (1998). All Rights Reserved.
20
21 Abstract
22
23 This document defines techniques for representing two types of
24 information mapping in the OSI Directory [<a href="#ref-1" title="models and services">1</a>].
25
26 1. Mapping from a key to a value (or set of values), as might
27 be done in a table lookup.
28
29 2. Mapping from a distinguished name to an associated
30 value (or values), where the values are not defined by the owner
31 of the entry. This is achieved by use of a directory subtree.
32
33 These techniques were developed for supporting MHS use of Directory
34 [<a href="#ref-2" title="&quot;X.400-MHS use of the X.500 directory to support X.400-MHS routing,&quot;">2</a>], but are specified separately as they have more general
35 applicability.
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52 <span class="grey">Kille 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="./rfc2293">RFC 2293</a> Table and Subtrees in the X.500 March 1998</span>
55
56
57 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a> Representing Flat Tables</span>
58
59 Before considering specific function, a general purpose technique for
60 representing tables in the directory is introduced. The schema for
61 this is given in Figure 1. A table can be considered as an unordered
62 set of key to (single or multiple) value mappings, where the key
63 cannot be represented as a global name. There are four reasons why
64 this may occur:
65
66 1. The object does not have a natural global name.
67
68 2. The object can only be named effectively in the context of
69 being a key to a binding. In this case, the object will be given
70 a natural global name by the table.
71
72 3. The object has a global name, and the table is being used
73 to associate parameters with this object, in cases where they
74 cannot be placed in the objects global entry. Reasons why they
75 might not be so placed include:
76
77 o The object does not have a directory entry
78
79 o There is no authority to place the parameters in the
80 global entry
81
82 o The parameters are not global --- they only make sense
83 in the context of the table.
84
85 4. It is desirable to group information together as a
86 performance optimization, so that the block of information may be
87 widely replicated.
88
89 A table is represented as a single level subtree. The root of the
90 subtree is an entry of object class Table. This is named with a
91 common name descriptive of the table. The table will be located
92 somewhere appropriate to its function. If a table is private to an
93 MTA, it will be below the MTA's entry. If it is shared by MTA's in
94 an organization, it will be located under the organization.
95
96 The generic table entry contains only a description. All instances
97 will be subclassed, and the subclass will define the naming
98 attribute. Two subclasses are defined:
99
100
101
102
103
104
105
106
107
108 <span class="grey">Kille 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="./rfc2293">RFC 2293</a> Table and Subtrees in the X.500 March 1998</span>
111
112
113 table OBJECT-CLASS ::= {
114 SUBCLASS OF {top}
115 MUST CONTAIN {commonName}
116 MAY CONTAIN {manager}
117 ID oc-table}
118
119
120 tableEntry OBJECT-CLASS ::= {
121 SUBCLASS OF {top}
122 MAY CONTAIN {description} 10
123 ID oc-table-entry}
124
125 textTableEntry OBJECT-CLASS ::= {
126 SUBCLASS OF {tableEntry}
127 MUST CONTAIN {textTableKey}
128 MAY CONTAIN {textTableValue}
129 ID oc-text-table-entry}
130
131 textTableKey ATTRIBUTE ::= {
132 SUBTYPE OF name 20
133 WITH SYNTAX DirectoryString {ub-name}
134 ID at-text-table-key}
135
136 textTableValue ATTRIBUTE ::= {
137 SUBTYPE OF name
138 WITH SYNTAX DirectoryString {ub-description}
139 ID at-text-table-value}
140
141 distinguishedNameTableEntry OBJECT-CLASS ::= {
142 SUBCLASS OF {tableEntry} 30
143 MUST CONTAIN {distinguishedNameTableKey}
144 ID oc-distinguished-name-table-entry}
145
146 distinguishedNameTableKey ATTRIBUTE ::= {
147 SUBTYPE OF distinguishedName
148 ID at-distinguished-name-table-key}
149
150 Figure 1: Representing Tables
151
152
153 1. TextEntry, which define table entries with text keys,
154 which may have single or multiple values of any type. An
155 attribute is defined to allow a text value, to support the
156 frequent text key to text value mapping. Additional values may
157 be defined.
158
159
160
161
162
163
164 <span class="grey">Kille 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="./rfc2293">RFC 2293</a> Table and Subtrees in the X.500 March 1998</span>
167
168
169 2. DistinguishedNameEntry. This is used for associating
170 information with globally defined objects. This approach should
171 be used where the number of objects in the table is small or very
172 sparsely spread over the DIT. In other cases where there are many
173 objects or the objects are tightly clustered in the DIT, the
174 subtree approach defined in <a href="#section-2">Section 2</a> will be preferable. No
175 value attributes are defined for this type of entry. An
176 application of this will make appropriate subtyping to define the
177 needed values.
178
179 This is best illustrated by example. Consider the MTA:
180
181 CN=Bells, OU=Computer Science,
182 O=University College London, C=GB
183
184 Suppose that the MTA needs a table mapping from private keys to fully
185 qualified domain names (this example is fictitious). The table might
186 be named as:
187
188 CN=domain-nicknames,
189 CN=Bells, OU=Computer Science,
190 O=University College London, C=GB
191
192 To represent a mapping in this table from "euclid" to
193 "bloomsbury.ac.uk", the entry:
194
195 TextTableKey=euclid, CN=domain-nicknames,
196 CN=Bells, OU=Computer Science,
197 O=University College London, C=GB
198
199 will contain the attribute:
200
201 TextTableValue=bloomsbury.ac.uk
202
203 A second example, showing the use of DistinguishedNameEntry is now
204 given. Consider again the MTA:
205
206 CN=Bells, OU=Computer Science,
207 O=University College London, C=GB
208
209 Suppose that the MTA needs a table mapping from MTA Name to bilateral
210 agreement information of that MTA. The table might be named as:
211
212 CN=MTA Bilateral Agreements,
213 CN=Bells, OU=Computer Science,
214 O=University College London, C=GB
215
216
217
218
219
220 <span class="grey">Kille 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="./rfc2293">RFC 2293</a> Table and Subtrees in the X.500 March 1998</span>
223
224
225 To represent information on the MTA which has the Distinguished Name:
226
227 CN=Q3T21, ADMD=Gold 400, C=GB
228
229 There would be an entry in this table with the Relative Distinguished
230 Name of the table entry being the Distinguished Name of the MTA being
231 referred to. The MTA Bilateral information would be an attribute in
232 this entry. Using a non-standard notation, the Distinguished Name of
233 the table entry is:
234
235 DistinguishedNameTableKey=&lt;CN=Q3T21, ADMD=Gold 400, C=GB&gt;,
236 CN=MTA Bilateral Agreements,
237 CN=Bells, OU=Computer Science,
238 O=University College London, C=GB
239
240 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a> Representing Subtrees</span>
241
242 A subtree is similar to a table, except that the keys are constructed
243 as a distinguished name hierarchy relative to the location of the
244 subtree in the DIT. The subtree effectively starts a private "root",
245 and has distinguished names relative to this root. Typically, this
246 approach is used to associate local information with global objects.
247 The schema used is defined in Figure 2. Functionally, this is
248 equivalent to a table with distinguished name keys. The table
249 approach is best when the tree is very sparse. This approach is
250 better for subtrees which are more populated.
251
252 The subtree object class defines the root for a subtree in an
253 analogous means to the table. Information within the subtree will
254 generally be defined in the same way as for the global object, and so
255
256 subtree OBJECT-CLASS ::= {
257 SUBCLASS OF {top}
258 MUST CONTAIN {commonName}
259 MAY CONTAIN {manager}
260 ID oc-subtree}
261
262 Figure 2: Representing Subtrees
263
264
265 no specific object classes for subtree entries are needed.
266
267 For example consider University College London.
268
269 O=University College London, C=GB
270
271
272
273
274
275
276 <span class="grey">Kille Standards Track [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc2293">RFC 2293</a> Table and Subtrees in the X.500 March 1998</span>
279
280
281 Suppose that the UCL needs a private subtree, with interesting
282 information about directory objects. The table might be named as:
283
284 CN=private subtree,
285 O=University College London, C=GB
286
287 UCL specific information on Inria might be stored in the entry:
288
289 O=Inria, C=FR,
290 CN=private subtree,
291 O=University College London, C=GB
292
293 Practical examples of this mapping are given in [<a href="#ref-2" title="&quot;X.400-MHS use of the X.500 directory to support X.400-MHS routing,&quot;">2</a>].
294
295 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a> Acknowledgments</span>
296
297 Acknowledgments for work on this document are given in [<a href="#ref-2" title="&quot;X.400-MHS use of the X.500 directory to support X.400-MHS routing,&quot;">2</a>].
298
299 References
300
301 [<a id="ref-1">1</a>] The Directory --- overview of concepts, models and services,
302 1993. CCITT X.500 Series Recommendations.
303
304 [<a id="ref-2">2</a>] Kille, S.E., "X.400-MHS use of the X.500 directory to support
305 X.400-MHS routing," <a href="./rfc1801">RFC 1801</a>, June 1995.
306
307 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a> Security Considerations</span>
308
309 Security considerations are not discussed in this memo.
310
311 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a> Author's Address</span>
312
313 Steve Kille
314 Isode Ltd
315 The Dome
316 The Square
317 Richmond
318 TW9 1DT
319 England
320
321 Phone: +44-181-332-9091
322 EMail: [email protected]
323
324
325
326
327
328
329
330
331
332 <span class="grey">Kille Standards Track [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc2293">RFC 2293</a> Table and Subtrees in the X.500 March 1998</span>
335
336
337 A Object Identifier Assignment
338
339
340 mhs-ds OBJECT IDENTIFIER ::= {iso(1) org(3) dod(6) internet(1)
341 private(4) enterprises(1) isode-consortium (453) mhs-ds (7)}
342
343 tables OBJECT IDENTIFIER ::= {mhs-ds 1}
344
345 oc OBJECT IDENTIFIER ::= {tables 1}
346 at OBJECT IDENTIFIER ::= {tables 2}
347
348 oc-subtree OBJECT IDENTIFIER ::= {oc 1}
349 oc-table OBJECT IDENTIFIER ::= {oc 2} 10
350 oc-table-entry OBJECT IDENTIFIER ::= {oc 3}
351 oc-text-table-entry OBJECT IDENTIFIER ::= {oc 4}
352 oc-distinguished-name-table-entry OBJECT IDENTIFIER ::= {oc 5}
353
354 at-text-table-key OBJECT IDENTIFIER ::= {at 1}
355 at-text-table-value OBJECT IDENTIFIER ::= {at 2}
356 at-distinguished-name-table-key OBJECT IDENTIFIER ::= {at 3}
357
358 Figure 3: Object Identifier Assignment
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388 <span class="grey">Kille Standards Track [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc2293">RFC 2293</a> Table and Subtrees in the X.500 March 1998</span>
391
392
393 Full Copyright Statement
394
395 Copyright (C) The Internet Society (1998). 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 assigns.
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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444 Kille Standards Track [Page 8]
445 </pre>