Debian Codegraph @

rfc1835.html

raw
1 <pre>Network Working Group P. Deutsch
2 Request for Comments: 1835 BUNYIP INFORMATION SYSTEMS, Inc.
3 Category: Standards Track R. Schoultz
4 KTHNOC
5 P. Faltstrom
6 BUNYIP INFORMATION SYSTEMS, Inc.
7 C. Weider
8 BUNYIP INFORMATION SYSTEMS, Inc.
9 August 1995
10
11
12 <span class="h1">Architecture of the WHOIS++ service</span>
13
14 Status of this Memo
15
16 This document specifies an Internet standards track protocol for the
17 Internet community, and requests discussion and suggestions for
18 improvements. Please refer to the current edition of the "Internet
19 Official Protocol Standards" (STD 1) for the standardization state
20 and status of this protocol. Distribution of this memo is unlimited.
21
22 Abstract
23
24 This document describes WHOIS++, an extension to the trivial WHOIS
25 service described in <a href="./rfc954">RFC 954</a> to permit WHOIS-like servers to make
26 available more structured information to the Internet. We describe
27 an extension to the simple WHOIS data model and query protocol and a
28 companion extensible, distributed indexing service. A number of
29 options have also been added such as the use of multiple languages
30 and character sets, more advanced search expressions, structured data
31 and a number of other useful features. An optional authentication
32 mechanism for protecting all or part of the associated WHOIS++
33 information database from unauthorized access is also described.
34
35 Table of Contents
36
37 Part I - WHOIS++ Overview ................................. <a href="#page-3">3</a>
38 <a href="#section-1.1">1.1</a>. Purpose and Motivation .............................. <a href="#page-3">3</a>
39 <a href="#section-1.2">1.2</a>. Basic Information Model ............................. <a href="#page-4">4</a>
40 <a href="#section-1.2.1">1.2.1</a>. Changes to the current WHOIS Model ................ <a href="#page-5">5</a>
41 <a href="#section-1.2.2">1.2.2</a>. Registering WHOIS++ servers ....................... <a href="#page-5">5</a>
42 <a href="#section-1.2.3">1.2.3</a>. The WHOIS++ Search Selection Mechanism ............ <a href="#page-7">7</a>
43 <a href="#section-1.2.4">1.2.4</a>. The WHOIS++ Architecture .......................... <a href="#page-7">7</a>
44 <a href="#section-1.3">1.3</a>. Indexing in WHOIS++ ................................. <a href="#page-8">8</a>
45 <a href="#section-1.4">1.4</a>. Getting Help ........................................ <a href="#page-9">9</a>
46 <a href="#section-1.4.1">1.4.1</a>. Minimum HELP Required ............................. <a href="#page-9">9</a>
47 <a href="#section-1.5">1.5</a>. Options and Constraints ............................. <a href="#page-10">10</a>
48 <a href="#section-1.6">1.6</a>. Formatting Responses ................................ <a href="#page-10">10</a>
49
50
51
52 <span class="grey">Deutsch, et al 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="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
55
56
57 <a href="#section-1.7">1.7</a>. Reporting Warnings and Errors ....................... <a href="#page-11">11</a>
58 <a href="#section-1.8">1.8</a>. Privacy and Security Issues ......................... <a href="#page-11">11</a>
59 Part II - WHOIS++ Implementation .......................... <a href="#page-12">12</a>
60 <a href="#section-2.1">2.1</a>. The WHOIS++ interaction model ....................... <a href="#page-12">12</a>
61 <a href="#section-2.2">2.2</a>. The WHOIS++ Command set ............................. <a href="#page-12">12</a>
62 <a href="#section-2.2.1">2.2.1</a>. System Commands ................................... <a href="#page-13">13</a>
63 <a href="#section-2.2.1.1">2.2.1.1</a>. The COMMANDS command ............................ <a href="#page-14">14</a>
64 <a href="#section-2.2.1.2">2.2.1.2</a>. The CONSTRAINTS command ......................... <a href="#page-15">15</a>
65 <a href="#section-2.2.1.3">2.2.1.3</a>. The DESCRIBE command ............................ <a href="#page-15">15</a>
66 <a href="#section-2.2.1.4">2.2.1.4</a>. The HELP command ................................ <a href="#page-15">15</a>
67 <a href="#section-2.2.1.5">2.2.1.5</a>. The LIST command ................................ <a href="#page-15">15</a>
68 <a href="#section-2.2.1.6">2.2.1.6</a>. The POLLED-BY command ........................... <a href="#page-15">15</a>
69 <a href="#section-2.2.1.7">2.2.1.7</a>. The POLLED-FOR command .......................... <a href="#page-16">16</a>
70 <a href="#section-2.2.1.8">2.2.1.8</a>. The SHOW command ................................ <a href="#page-16">16</a>
71 <a href="#section-2.2.1.9">2.2.1.9</a>. The VERSION command ............................. <a href="#page-16">16</a>
72 <a href="#section-2.2.2">2.2.2</a>. The Search Command ................................ <a href="#page-16">16</a>
73 <a href="#section-2.2.2.1">2.2.2.1</a>. Format of a Search Term ......................... <a href="#page-17">17</a>
74 <a href="#section-2.2.2.2">2.2.2.2</a>. Format of a Search String ....................... <a href="#page-18">18</a>
75 <a href="#section-2.3">2.3</a>. WHOIS++ Constraints ................................. <a href="#page-19">19</a>
76 <a href="#section-2.3.1">2.3.1</a>. Required Constraints .............................. <a href="#page-20">20</a>
77 <a href="#section-2.3.2">2.3.2</a>. Optional CONSTRAINTS .............................. <a href="#page-21">21</a>
78 <a href="#section-2.3.2.1">2.3.2.1</a>. The SEARCH Constraint ........................... <a href="#page-22">22</a>
79 <a href="#section-2.3.2.2">2.3.2.2</a>. The FORMAT Constraint ........................... <a href="#page-22">22</a>
80 <a href="#section-2.3.2.3">2.3.2.3</a>. The MAXFULL Constraint .......................... <a href="#page-22">22</a>
81 <a href="#section-2.3.2.4">2.3.2.4</a>. The MAXHITS Constraint .......................... <a href="#page-23">23</a>
82 <a href="#section-2.3.2.5">2.3.2.5</a>. The CASE Constraint ............................. <a href="#page-23">23</a>
83 <a href="#section-2.3.2.6">2.3.2.6</a>. The AUTHENTICATE Constraint ..................... <a href="#page-23">23</a>
84 <a href="#section-2.3.2.7">2.3.2.7</a>. The NAME Constraint ............................. <a href="#page-23">23</a>
85 <a href="#section-2.3.2.8">2.3.2.8</a>. The PASSWORD Constraint ......................... <a href="#page-23">23</a>
86 <a href="#section-2.3.2.9">2.3.2.9</a>. The LANGUAGE Constraint ......................... <a href="#page-23">23</a>
87 <a href="#section-2.3.2.10">2.3.2.10</a>. The INCHARSET Constraint ....................... <a href="#page-24">24</a>
88 <a href="#section-2.3.2.11">2.3.2.11</a>. The IGNORE Constraint .......................... <a href="#page-24">24</a>
89 <a href="#section-2.3.2.12">2.3.2.12</a>. The INCLUDE Constraint ......................... <a href="#page-24">24</a>
90 <a href="#section-2.4">2.4</a>. Server Response Modes ............................... <a href="#page-24">24</a>
91 <a href="#section-2.4.1">2.4.1</a>. Default Responses ................................. <a href="#page-25">25</a>
92 <a href="#section-2.4.2">2.4.2</a>. Format of Responses ............................... <a href="#page-25">25</a>
93 <a href="#section-2.4.3">2.4.3</a>. Syntax of a Formatted Response .................... <a href="#page-26">26</a>
94 <a href="#section-2.4.3.1">2.4.3.1</a>. A FULL format response .......................... <a href="#page-26">26</a>
95 <a href="#section-2.4.3.2">2.4.3.2</a>. ABRIDGED Format Response ........................ <a href="#page-27">27</a>
96 <a href="#section-2.4.3.3">2.4.3.3</a>. HANDLE Format Response .......................... <a href="#page-27">27</a>
97 <a href="#section-2.4.3.4">2.4.3.4</a>. SUMMARY Format Response ......................... <a href="#page-27">27</a>
98 <a href="#section-2.4.3.5">2.4.3.5</a>. SERVERS-TO-ASK Response ......................... <a href="#page-28">28</a>
99 <a href="#section-2.4.4">2.4.4</a>. System Generated Messages ......................... <a href="#page-28">28</a>
100 <a href="#section-2.5">2.5</a>. Compatibility with Older WHOIS Servers .............. <a href="#page-29">29</a>
101 <a href="#section-3">3</a>. Miscellaneous ......................................... <a href="#page-29">29</a>
102 <a href="#section-3.1">3.1</a>. Acknowledgements .................................... <a href="#page-29">29</a>
103 <a href="#section-3.2">3.2</a>. References .......................................... <a href="#page-29">29</a>
104 <a href="#section-3.3">3.3</a>. Authors' Addresses .................................. <a href="#page-30">30</a>
105
106
107
108 <span class="grey">Deutsch, et al 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="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
111
112
113 <a href="#appendix-A">Appendix A</a> - Some Sample Queries .......................... <a href="#page-31">31</a>
114 <a href="#appendix-B">Appendix B</a> - Some sample responses ........................ <a href="#page-31">31</a>
115 <a href="#appendix-C">Appendix C</a> - Sample responses to system commands .......... <a href="#page-33">33</a>
116 <a href="#appendix-D">Appendix D</a> - Sample whois++ session ....................... <a href="#page-35">35</a>
117 <a href="#appendix-E">Appendix E</a> - System messages .............................. <a href="#page-36">36</a>
118 <a href="#appendix-F">Appendix F</a> - The WHOIS++ BNF Grammar ...................... <a href="#page-38">38</a>
119 <a href="#appendix-G">Appendix G</a> - Description of Regular expressions ........... <a href="#page-40">40</a>
120
121 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Part I - WHOIS++ Overview</span>
122
123 <span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Purpose and Motivation</span>
124
125 The current NIC WHOIS service [<a href="#ref-HARR85" title="&quot;NICNAME/WHOIS&quot;">HARR85</a>] is used to provide a very
126 limited directory service, serving information about a small number
127 of Internet users registered with the DDN NIC. Over time the basic
128 service has been expanded to serve additional information and similar
129 services have also been set up on other hosts. Unfortunately, these
130 additions and extensions have been done in an ad hoc and
131 uncoordinated manner.
132
133 The basic WHOIS information model represents each individual record
134 as a Rolodex-like collection of text. Each record has a unique
135 identifier (or handle), but otherwise is assumed to have little
136 structure. The current service allows users to issue searches for
137 individual strings within individual records, as well as searches for
138 individual record handles using a very simple query-response
139 protocol.
140
141 Despite its utility, the current NIC WHOIS service cannot function as
142 a general White Pages service for the entire Internet. Given the
143 inability of a single server to offer guaranteed response or
144 reliability, the huge volume of traffic that a full scale directory
145 service will generate and the potentially huge number of users of
146 such a service, such a trivial architecture is obviously unsuitable
147 for the current Internet's needs for information services.
148
149 This document describes the architecture and protocol for WHOIS++, a
150 simple, distributed and extensible information lookup service based
151 upon a small set of extensions to the original WHOIS information
152 model. These extensions allow the new service to address the
153 community's needs for a simple directory service, yet the extensible
154 architecture is expected to also allow it to find application in a
155 number of other information service areas.
156
157 Added features include an extension to the trivial WHOIS data model
158 and query protocol and a companion extensible, distributed indexing
159 service. A number of other options have also been added, like boolean
160 operators, more powerful search constraints and search methods, and
161
162
163
164 <span class="grey">Deutsch, et al 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="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
167
168
169 most specificly structured the data to make both the client and the
170 server part of the dialogue more stringent and parseable. An optional
171 authentication mechanism for protecting all or parts of the
172 associated WHOIS++ information database from unauthorized access is
173 also briefly described.
174
175 The basic architecture of WHOIS++ allows distributed maintenance of
176 the directory contents and the use of the WHOIS++ indexing service
177 for locating additional WHOIS++ servers. Although a general overview
178 of this service is included for completeness, the indexing extensions
179 are described in a separate paper.
180
181 <span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Basic Information Model</span>
182
183 The WHOIS++ service is centered in a recommendation to structure user
184 information around a series of standardized information templates.
185 Such templates consist of ordered sets of data elements (or
186 attribute-value pairs).
187
188 It is intended that adding such structured templates to a server and
189 subsequently identifying and searching them be simple tasks. The
190 creation and use of customized templates should also be possible with
191 little effort, although their use should be discouraged where
192 appropriate standardized templates exist.
193
194 We also offer methods to allow the user to constrain searches to
195 desired attributes or template types, in addition to the existing
196 commands for specifying handles or simple strings.
197
198 It is expected that the minimalist approach we have taken will find
199 application where the high cost of configuring and operating
200 traditional White Pages services can not currently be justified.
201
202 Also note that the architecture makes no assumptions about the search
203 and retrieval mechanisms used within individual servers. Operators
204 are free to use dedicated database formats, fast indexing software or
205 even provide gateways to other directory services to store and
206 retrieve information, if desired.
207
208 The WHOIS++ server simply functions as a known front end, offering a
209 simple data model and communicating through a well known port and
210 query protocol. The format of both queries and replies has been
211 structured to allow the use of client software for generating
212 searches and displaying the results. At the same time, some effort
213 has been made to keep responses at least to some degree readible by
214 humans, to ensure low entry cost and to ease debugging.
215
216
217
218
219
220 <span class="grey">Deutsch, et al 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="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
223
224
225 The actual implemention details of an individual WHOIS++ search
226 engine are left to the imagination of the implementor and it is hoped
227 that the simple, extensible approach taken will encourage
228 experimentation and the development of improved search engines.
229
230 <span class="h4"><a class="selflink" id="section-1.2.1" href="#section-1.2.1">1.2.1</a>. Changes to the current WHOIS Model</span>
231
232 The current WHOIS service is based upon an extremely simple data
233 model. The NIC WHOIS database consists of a series of individual
234 records, each of which is identified by a single unique identifer
235 (the "handle"). Each record contains one or more lines of
236 information. Currently, there is no structure or implicit ordering of
237 this information, although by implication each record is concerned
238 with information about a single user or service.
239
240 We have implemented two basic changes to this model. First, we have
241 structured the information within the database as collections of data
242 elements, or simple attribute/value pairs. Each individual record
243 contains a specified ordered set of these data elements.
244
245 Secondly, we have introduced typing of the database records. In
246 effect, each record is based upon one of a specified set of
247 templates, each containing a finite and specified number of data
248 elements. This allow users to easily limit searches to specific
249 collections of information, such as information about users,
250 services, abstracts of papers, descriptions of software, and so on.
251
252 As a final extension, we require that each individual WHOIS++
253 database on the Internet be assigned a unique handle, analogous to
254 the handle associated with each database record.
255
256 The WHOIS++ database structure is shown in Fig. 1.
257
258 <span class="h4"><a class="selflink" id="section-1.2.2" href="#section-1.2.2">1.2.2</a>. Registering WHOIS++ servers</span>
259
260 We propose that individual database handles be registered through the
261 Internet Assigned Numbers Authority (the IANA), ensuring their
262 uniqueness. This will allow us to specify each WHOIS++ entry on the
263 Internet as a unique pair consisting of a server handle and a record
264 handle.
265
266 A unique registered handle is preferable to using the host's IP
267 address, since it is conceivable that the WHOIS++ server for a
268 particular domain may move over time. If we preserve the unique
269 WHOIS++ handle in such cases we have the option of using it for
270 resource discovery and networked information retrieval (see [<a href="#ref-IIIR" title="&quot;A Vision of an Integrated Internet Information Service&quot;">IIIR</a>]
271 for a discussion of resource and discovery and support issues).
272
273
274
275
276 <span class="grey">Deutsch, et al 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="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
279
280
281 There are many ways of guaranteeing uniqueness of server handles; we
282 will discuss them in a separate paper.
283
284 We believe that organizing information around a series of such
285 templates will make it easier for administrators to gather and
286 maintain this information and thus encourage them to make such
287 information available. At the same time, as users become more
288 familiar with the data elements available within specific templates
289 they will be better able to specify their searches, leading to a more
290 useful service.
291
292 ______________________________________________________________________
293 | |
294 | + Single unique WHOIS++ database handle |
295 | |
296 | _______ _______ _______ |
297 | handle3 |.. .. | handle6 |.. .. | handle9 |.. .. | |
298 | _______ | _______ | _______ | |
299 | handle2 |.. .. | handle5 |.. .. | handle8 |.. .. | |
300 | _______ | _______ | _______ | |
301 | handle1 |.. .. | handle4 |.. .. | handle7 |.. .. | |
302 | |.. .. | |.. .. | |.. .. | |
303 | ------- ------- ------- |
304 | Template Template Template |
305 | Type 1 Type 2 Type 3 |
306 | |
307 | |
308 | |
309 | |
310 | Fig.1 - Structure of a WHOIS++ database. |
311 | |
312 | Notes: - Entire database is identified by a single unique WHOIS |
313 | handle. |
314 | - Each record has a single unique handle and a specific set |
315 | of attributes, determined by the template type used. |
316 | - Each value associated with an attribute can be any ASCII |
317 | string up to a specified length. |
318 |______________________________________________________________________|
319
320
321
322
323
324
325
326
327
328
329
330
331
332 <span class="grey">Deutsch, et al 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="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
335
336
337 <span class="h4"><a class="selflink" id="section-1.2.3" href="#section-1.2.3">1.2.3</a>. The WHOIS++ Search Selection Mechanism</span>
338
339 The WHOIS++ search mechanism is intended to be extremely simple. A
340 search command consists of one or more search terms, with an optional
341 set of global constraints (specifiers that modify or control a
342 search).
343
344 Search terms allow the user to specify template type, attribute,
345 value or handle that any record returns must satisfy. Each search
346 term can have an optional set of local constraints that apply to only
347 that term.
348
349 A WHOIS++ database may be seen as a single rolodex-like collection of
350 typed records. Each term specifies a further constraint that the
351 selected set of output records must satisfy. Each term may thus be
352 thought of as performing a subtractive selection, in the sense that
353 any record that does not fulfil the term is discarded from the result
354 set. Boolean searches are possible by the use of AND, OR, NOT and
355 parenthesis.
356
357 <span class="h4"><a class="selflink" id="section-1.2.4" href="#section-1.2.4">1.2.4</a>. The WHOIS++ Architecture</span>
358
359 The WHOIS++ directory service has an architecture which is separated
360 into two components; the base level server, which is described in
361 this paper, and a indexing server. A single physical server can act
362 as both a base level server and an indexing server.
363
364 A base level server is one which contains only filled templates. An
365 indexing server is one which contains forward knowledge (q.v.) and
366 pointers to other indexing servers or base level servers.
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">Deutsch, et al 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="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
391
392
393 <span class="h3"><a class="selflink" id="section-1.3" href="#section-1.3">1.3</a>. Indexing in WHOIS++</span>
394
395 Indexing in WHOIS++ is used to tie together many base level servers
396 and index servers into a unified directory service.
397
398 Each base level server and index server which wishes to participate
399 in the unified directory service must generate "forward knowledge"
400 for the entries it contains. One type of forward knowledge is the
401 "centroid".
402
403 An example of a centroid is as follows: if a whois++ server contained
404 exactly three records, as follows:
405
406 Record 1 Record 2
407 Template: Person Template: Person
408 First-Name: John First-Name: Joe
409 Last-Name: Smith Last-Name: Smith
410 Favourite-Drink: Labatt Beer Favourite-Drink: Molson Beer
411
412 Record 3
413 Template: Domain
414 Domain-Name: foo.edu
415 Contact-Name: Mike Foobar
416
417 the centroid for this server would be
418
419 Template: Person
420 First-Name: Joe
421 John
422 Last-Name: Smith
423 Favourite-Drink:Beer
424 Labatt
425 Molson
426
427 Template: Domain
428 Domain-Name: foo.edu
429 Contact-Name: Mike
430 Foobar
431
432 An index server would then collect this centroid for this server as
433 forward knowledge.
434
435 Index servers can collect forward knowledge for any servers it
436 wishes. In effect, all of the servers that the index server knows
437 about can be searched with a single query to the index server; the
438 index server holds the forward knowledge along with pointers to the
439 servers it indexes, and can refer the query to servers which might
440 hold information which satisfies the query.
441
442
443
444 <span class="grey">Deutsch, et al Standards Track [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
447
448
449 Implementors of this protocol are strongly encouraged to incorporate
450 centroid generation abilities into their servers.
451
452 -------------------------------------------------------------------
453
454 ____ ____
455 top level | | | |
456 whois index | | | |
457 servers ---- ----
458
459
460 ____ ____
461 first level | | | |
462 whois index | | | |
463 servers ---- ----
464
465
466 ____ ____ ____
467 individual | | | | | |
468 whois servers | | | | | |
469 ---- ---- ----
470
471
472 Fig. 2 - Indexing system architecture.
473
474 -------------------------------------------------------------------
475
476 <span class="h3"><a class="selflink" id="section-1.4" href="#section-1.4">1.4</a>. Getting Help</span>
477
478 Another extension to the basic WHOIS service is the requirement that
479 all servers support at least a minimal set of help commands, allowing
480 users to find out information about both the individual server and
481 the entire WHOIS++ service itself. This is done in the context of the
482 new extended information model by defining two specific template
483 formats and requiring each server to offer at least one example of
484 each record using these formats. The operator of each WHOIS service
485 is therefor expected to have, as a minimum, a single example of
486 SERVICES and HELP records, which can be accessed through appropriate
487 commands.
488
489 <span class="h4"><a class="selflink" id="section-1.4.1" href="#section-1.4.1">1.4.1</a>. Minimum HELP Required</span>
490
491 Executing the command:
492
493 DESCRIBE
494
495 gives a brief information about the WHOIS++ server.
496
497
498
499
500 <span class="grey">Deutsch, et al Standards Track [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
503
504
505 Executing the command:
506
507 HELP
508
509 gives a brief description of the WHOIS++ service itself.
510
511 The text of both required helped records should contain pointers to
512 additional help subjects that are available.
513
514
515 Executing the command:
516
517 HELP &lt;searchstring&gt;
518
519 may give information on any topic.
520
521 <span class="h3"><a class="selflink" id="section-1.5" href="#section-1.5">1.5</a>. Options and Constraints</span>
522
523 The WHOIS++ service is based upon a minimal core set of commands and
524 controlling constraints. A small set of additional optional commands
525 and constraints can be supported. These would allow users to perform
526 such tasks as provide security options, modify the information
527 contents of a server or add multilingual support. The required set of
528 WHOIS++ commands are summarized in <a href="#section-2.2">section 2.2</a>. WHOIS++ constraints
529 are described in <a href="#section-2.3">section 2.3</a>. Optional constraints are described in
530 <a href="#section-2.3.2">section 2.3.2</a>.
531
532 <span class="h3"><a class="selflink" id="section-1.6" href="#section-1.6">1.6</a>. Formatting Responses</span>
533
534 The output returned by a WHOIS++ server is structured to allow
535 machine parsing and automated handling. Of particular interest in the
536 ability to return summary information about a search (without having
537 to return the entire results).
538
539 All output of searches will be returned in one of five output
540 formats, which will be one of FULL, ABRIDGED, HANDLE, SUMMARY or
541 SERVER-TO-ASK. Note that a conforming server is only required to
542 support the first four formats.
543
544 When available, SERVER-TO-ASK format is used to indicate that a
545 search cannot be completed but that one or more alternative WHOIS++
546 servers may be able to perform the search.
547
548 Details of each output format are specified in <a href="#section-2.4">section 2.4</a>.
549
550
551
552
553
554
555
556 <span class="grey">Deutsch, et al Standards Track [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
559
560
561 <span class="h3"><a class="selflink" id="section-1.7" href="#section-1.7">1.7</a>. Reporting Warnings and Errors</span>
562
563 The formatted response of WHOIS++ commands allows the encoding of
564 warning or error messages to simplify parsing and machine handling.
565 The syntax of output formats are described in detail in <a href="#section-2.4">section 2.4</a>,
566 and details of WHOIS++ warnings and error conditions are given in
567 <a href="#appendix-E">Appendix E</a>.
568
569 All system messages are numerical, but can be tagged with text. It is
570 the clients decision if the text is presented to the user.
571
572 <span class="h3"><a class="selflink" id="section-1.8" href="#section-1.8">1.8</a>. Privacy and Security Issues</span>
573
574 The basic WHOIS++ service was conceived as a simple, unauthenticated
575 information lookup service, but there are occasions when
576 authentication mechanisms are required. To handle such cases, an
577 optional mechanism is provided for authenticating each WHOIS++
578 transaction.
579
580 The current identified authentication mechanism is PASSWORD, which
581 uses simple password authentication. Any other scheme name used must
582 begin with the characters "X-" and should thus be regarded as
583 experimental and non-standard.
584
585 Note that the WHOIS++ authentication mechanism does not dictate the
586 actual authentication scheme used, it merely provides a framework for
587 indicating that a particular transaction is to be authenticated, and
588 the appropriate mechanisms to use. This mechanism is extensible and
589 individual implementors are free to add additional mechanisms.
590
591 This document includes a very simple authentication scheme where a
592 combination of username and password is sent together with the search
593 string so the server can verify that the user have access to the
594 information. Note that this is NOT by any means a method recommended
595 to secure the data itself because both password and information are
596 tranferred unencrypted over the network.
597
598 Given the unauthenticated nature that default services like white
599 pages services are, it is easy to either forget the implications of
600 this and just show all data to the public Internet, or think that
601 Internet is so dangerous that information is hidden from the Internet
602 so the whole idea of a global white pages service is lost. Therefore
603 the type of authentication scheme selected and the public nature of
604 the Internet environment must still be taken into consideration when
605 assessing the security and authentication of the information served.
606
607 A more detailed exposition on security is outside the scope of this
608 document.
609
610
611
612 <span class="grey">Deutsch, et al Standards Track [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
615
616
617 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Part II - WHOIS++ Implementation</span>
618
619 <span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. The WHOIS++ interaction model</span>
620
621 A WHOIS++ server will normally listen for a TCP connections on the
622 allocated WHOIS++ port (although a WHOIS++ server can be accessed
623 over any TCP connection). Once a connection is established, the
624 server issues a banner message, and listens for input. The command
625 specified in this input is processed and the results returned
626 including an ending system message. If the optional HOLD constraint
627 has not been specified the connection is then terminated.
628
629 If the server supports the optional HOLD constraint, and this
630 constraint is specified as part of any command, the server continues
631 to listen on the connection for another line of input. This cycle
632 continues as long as the sender continues to append the required HOLD
633 constraint to each subsequent command.
634
635 At the same time, each server is permitted to set an optional timeout
636 value (which should be indicated in the response to the CONSTRAINTS
637 command). If set, the server is free to terminate an idle connection
638 at any time after this delay has passed with no input from the
639 client. If the server terminates the connection due to timeout, it
640 will be indicated by the system message. The timeout value is not
641 changeable by the client.
642
643 <span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. The WHOIS++ Command set</span>
644
645 There are two types of WHOIS++ commands - system commands and the
646 WHOIS++ search command.
647
648 The WHOIS++ command set consists of a core set of required systems
649 commands, a single required search command and an set of optional
650 system commands which support features that are not required by all
651 servers. The set of required WHOIS++ system commands are listed in
652 Table I. Details of the allowable search terms for the search command
653 are included in Table II.
654
655 Each WHOIS++ command also allows the use of one or more controlling
656 constraints, when selected can be used to override defaults or
657 otherwise modify server behavior. There is a core set of constraints
658 that must be supported by all conforming servers. These include
659 SEARCH (which controls the type of search performed), FORMAT (which
660 determines the output format used) and MAXHITS (which determines the
661 maximum number of matches that a search can return).
662
663 These required constraints are summarized in Table III.
664
665
666
667
668 <span class="grey">Deutsch, et al Standards Track [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
671
672
673 An additional set of optional constraints are used to provide support
674 for different character sets, indicate the need and type of
675 authentication to perform on a transaction, and permit multiple
676 transactions during a single communications session. These optional
677 constraints are listed in Table IV.
678
679 It is possible, using the required COMMANDS and CONSTRAINTS system
680 commands, to query any WHOIS++ server for its list of supported
681 commands and constraints.
682
683 <span class="h4"><a class="selflink" id="section-2.2.1" href="#section-2.2.1">2.2.1</a>. System Commands</span>
684
685 System commands are commands to the server for information or to
686 control its operation. These include commands to list the template
687 types available from individual servers, to obtain a single blank
688 template of any available type, and commands to obtain the list of
689 valid commands and constraints supported on a server.
690
691 There are also commands to obtain the current version of the WHOIS++
692 protocol supported, to access a simple help subsystem, to obtain a
693 brief description of the service (which is intended, among other
694 things, to support the automated registration of the service by
695 yellow pages directory services). All of these commands are required
696 from a conforming WHOIS++ server.
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724 <span class="grey">Deutsch, et al Standards Track [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
727
728
729 ------------------------------------------------------------------------
730
731 Short Long Form Functionality
732 ----- --------- -------------
733 COMMANDS [ ':' HOLD ] list valid WHOIS++ commands
734 supported by this server
735
736 CONSTRAINTS [ ':' HOLD ] List valid constraints
737 supported by this server
738
739 DESCRIBE [ ':' HOLD ] Describe this server,
740 formating the response
741 using a standard
742 "Services" template
743
744 '?' HELP [&lt;string&gt; [':' &lt;cnstrnts&gt;]] System help, using a "Help"
745 template
746
747 LIST [':' &lt;cnstrnts&gt;] List templates supported
748 by this system
749
750 POLLED-BY [ ':' HOLD ] List indexing servers
751 that are know to track
752 this server
753
754 POLLED-FOR [ ':' HOLD ] List information about
755 what this server is
756 tracking for
757
758 SHOW &lt;string&gt; [':' &lt;cnstrnts&gt;] Show contents of templates
759 specified
760
761 VERSION [ ':' HOLD ] return current version of
762 the protocol supported.
763
764 Table I - Required WHOIS++ SYSTEM commands.
765
766 ------------------------------------------------------------------------
767
768 Below follows a descriptions for each command. Examples of responses
769 to each command is in <a href="#appendix-C">Appendix C</a>.
770
771 <span class="h5"><a class="selflink" id="section-2.2.1.1" href="#section-2.2.1.1">2.2.1.1</a>. The COMMANDS command</span>
772
773 The COMMANDS command returns a list of commands that the server
774 supports. The response is formatted as a FULL response.
775
776
777
778
779
780 <span class="grey">Deutsch, et al Standards Track [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
783
784
785 <span class="h5"><a class="selflink" id="section-2.2.1.2" href="#section-2.2.1.2">2.2.1.2</a>. The CONSTRAINTS command</span>
786
787 The CONSTRAINTS command returns a list of constraints and the values
788 of those that the server supports. The response is formatted as a
789 FULL response, where every constraint is represented as a separate
790 record. The template name for these records is CONSTRAINT. No
791 attention is paid to handles. Each record has, as a minimum, the
792 following two fields:
793
794 - "Constraint", which contains the attribute name described -
795 "Default", which shows the default value for this constraint.
796
797 If the client is permitted to change the value of the constraint,
798 there is also:
799
800 - "Range" field, which contains a list of values that this
801 server supports, as a comma separated list; Or, if the range
802 is numerical, as a pair of numbers separated with a hyphen.
803
804 <span class="h5"><a class="selflink" id="section-2.2.1.3" href="#section-2.2.1.3">2.2.1.3</a>. The DESCRIBE command</span>
805
806 The DESCRIBE command gives a brief description about the server in a
807 "Services" template. The result is formatted as a FULL response.
808
809 <span class="h5"><a class="selflink" id="section-2.2.1.4" href="#section-2.2.1.4">2.2.1.4</a>. The HELP command</span>
810
811 The HELP command takes an optional argument as subject to get help
812 for.
813
814 <span class="h5"><a class="selflink" id="section-2.2.1.5" href="#section-2.2.1.5">2.2.1.5</a>. The LIST command</span>
815
816 The LIST command returns the name of the templates available on the
817 server. The answer is formatted FULL format response.
818
819 <span class="h5"><a class="selflink" id="section-2.2.1.6" href="#section-2.2.1.6">2.2.1.6</a>. The POLLED-BY command</span>
820
821 The POLLED-BY command returns a list of servers and the templates and
822 attribute names that those server polled as centroids from this
823 server. The format is in FULL format with two attributes, Template
824 and Field. Each of these is a list of names of the templates or
825 fields polled. An empty result means either that the server is not
826 polled by anyone, or that it doesn't support indexing.
827
828
829
830
831
832
833
834
835
836 <span class="grey">Deutsch, et al Standards Track [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
839
840
841 <span class="h5"><a class="selflink" id="section-2.2.1.7" href="#section-2.2.1.7">2.2.1.7</a>. The POLLED-FOR command</span>
842
843 The POLLED-FOR command returns a list of servers that this server has
844 polled, and the template and attribute names for each of those. The
845 answer is in FULL format with two attributes, Template and Field. An
846 empty result means either that the server is not polling anyone, or
847 that it doesn't support indexing.
848
849 <span class="h5"><a class="selflink" id="section-2.2.1.8" href="#section-2.2.1.8">2.2.1.8</a>. The SHOW command</span>
850
851 The SHOW command takes a template name as argument and returns
852 information about a specific template, formatted as a FULL response.
853 The answer is formatted as a blank template with the requested name.
854
855 <span class="h5"><a class="selflink" id="section-2.2.1.9" href="#section-2.2.1.9">2.2.1.9</a>. The VERSION command</span>
856
857 The output format is a FULL response containg a record with template
858 name VERSION. The record must have attribute name "Version", which
859 value is "1.0" for this version of the protocol. The record may also
860 have the additional fields "Program-Name" and "Program-Version" which
861 gives information about the server implementation if the server so
862 desires.
863
864 <span class="h4"><a class="selflink" id="section-2.2.2" href="#section-2.2.2">2.2.2</a>. The Search Command</span>
865
866 A search command consists of one or more search terms, which might
867 each have local constraints, followed by an optional colon with a set
868 of global search constraints.
869
870 Each attribute value in the WHOIS++ database is divided into one or
871 more words separated by whitespace. Each search term operates on
872 every word in the attribute value.
873
874 Two or more search terms may be combined with boolean operators AND,
875 OR or NOT (other than the implied AND between terms). The operator
876 AND has higher precedence than the operator OR, but this can be
877 changed by the use of parentheses.
878
879 Search constraints that apply to every search term are specified as
880 global constraints. Local constraints override global constraints for
881 the search term they are bound to. The search terms and the global
882 constraints are separated with a colon (':'). Additional global
883 constraints are appended to the end of the search command delimited
884 with a semicolon ';'.
885
886 If different search constraints can not be fulfilled, or the
887 combination of different search constraints is uncombinable, the
888 server may choose to ignore some constraints, but still do the search
889
890
891
892 <span class="grey">Deutsch, et al Standards Track [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
895
896
897 and return some records.
898
899 The set of required constraints are summarized in Table III. The set
900 of optional constraints are summarized in Table IV.
901
902 As an option, the server may accept specifications for attributes for
903 either inclusion or exclusion from a reply. Thus, users could specify
904 -only- those attributes to return, or specific attributes to filter
905 out, thus creating custom views.
906
907 <span class="h5"><a class="selflink" id="section-2.2.2.1" href="#section-2.2.2.1">2.2.2.1</a>. Format of a Search Term</span>
908
909 Each search term consists of one of the following:
910
911 1) A search string, followed by an optional semicolon and set of
912 semicolon-separated local constraints.
913
914 2) A search term specifier (as listed in Table II), followed by a
915 '=', followed by a search string, an optional semicolon and a
916 set of semicolon-separate local constraints.
917
918 3) An abbreviated search term specifier, followed by a search
919 string, followed by an optional semicolon and set of
920 semicolon-separated local constraints.
921
922 4) A combination of attribute name, followed by '=', followed by
923 a search string, followed by an optional semicolon and set of
924 semicolon-separate local constraints.
925
926 If no term identifier is provided, then the search will be applied to
927 attribute values only. This corresponds to an identifier of VALUE.
928
929 If a SEARCH-ALL specifier is used then the search will be applied to
930 all template names, handles, attribute names and attribute values.
931
932 When the user specifies the search term using the form:
933
934 "&lt;attribute_name&gt; = &lt;value&gt;"
935
936 this is considered to be an ATTRIBUTE-VALUE search.
937
938 For discussion of the system reply format, and selecting the
939 appropriate reply format, see <a href="#section-2.4">section 2.4</a>.
940
941
942
943
944
945
946
947
948 <span class="grey">Deutsch, et al Standards Track [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
951
952
953 -------------------------------------------------------------------
954
955 Valid specifiers:
956 -----------------
957
958 Name Functionality
959 ---- -------------
960
961 ATTRIBUTE-VALUE [ ';' &lt;constrnt&gt;]* allows combining
962 attribute and value
963 specifiers in one term.
964 HANDLE [ ';' &lt;constrnt&gt;]* Confine search to handles.
965 SEARCH-ALL [ ';' &lt;constrnt&gt;]* Search everything.
966 TEMPLATE [ ';' &lt;constrnt&gt;]* Confine search to
967 template names.
968 VALUE [ ';' &lt;constrnt&gt;]* Confine search to attribute
969 values. This is the default.
970
971 (Note: The name HANDLE can be replaced with the shortname '!')
972
973 Acceptable forms of a search specifier:
974 ---------------------------------------
975
976 1) &lt;searchstring&gt; [';' &lt;constraint&gt;]*
977
978 2) &lt;specifier&gt; = &lt;searchstring&gt; [';' &lt;constraint&gt;]*
979
980 3) &lt;shortspecifier&gt; &lt;searchstring&gt; [';' &lt;constraint&gt;]*
981
982 4) &lt;attribute_name&gt; = &lt;searchstring&gt; [';' &lt;constraint&gt;]*
983
984 (Note: A &lt;constraint&gt; is a name of a valid local constraint.)
985
986 Table II - Valid search command term specifiers.
987
988 -------------------------------------------------------------------
989
990 <span class="h5"><a class="selflink" id="section-2.2.2.2" href="#section-2.2.2.2">2.2.2.2</a>. Format of a Search String</span>
991
992 Special characters that need to be quoted are preceeded by a
993 backslash, '\'.
994
995 Special characters are space ' ', tab, equal sign '=', comma ',',
996 colon ':', backslash '\', semicolon ';', asterisk '*', period '.',
997 parenthesis '()', square brackets '[]', dollar sign '$' and
998 circumflex '^'.
999
1000
1001
1002
1003
1004 <span class="grey">Deutsch, et al Standards Track [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1007
1008
1009 If the search term is given in some other character set than ISO-
1010 8859-1, it must be specified by the constraint INCHARSET.
1011
1012 <span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. WHOIS++ Constraints</span>
1013
1014 Constraints are intended to be hints or recommendations to the server
1015 about how to process a command. They may also be used to override
1016 default behaviour, such as requesting that a server not drop the
1017 connection after performing a command.
1018
1019 Thus, a user might specify a search constraint as "SEARCH=exact",
1020 which means that the search engine is to perform an exact match
1021 search. It might also specify "LANGUAGE=Fr", which implies that the
1022 server should use French in fuzzy matches. It might also be able to
1023 issue system messages in French.
1024
1025 In general, contraints take the form "&lt;constraintname&gt;=&lt;value&gt;", with
1026 &lt;value&gt; being one of a specified set of valid values. The notable
1027 exception is "HOLD", which takes no argument.
1028
1029 All constraints can be used as a global constraint, but only a few
1030 can be used as local. See tables IV and V for information of which
1031 constraints can be local.
1032
1033 The CONSTRAINTS system command is used to list the search constraints
1034 supported by an individual server.
1035
1036 If a server cannot satisfy the specified constraint there will be a
1037 mechanism for informing the user in the reply, using system messages.
1038 In such cases, the search is still performed, with the the server
1039 ignoring unsupported constraints.
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060 <span class="grey">Deutsch, et al Standards Track [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1063
1064
1065 <span class="h4"><a class="selflink" id="section-2.3.1" href="#section-2.3.1">2.3.1</a>. Required Constraints</span>
1066
1067 The following CONSTRAINTS must be supported in all conforming WHOIS++
1068 servers.
1069
1070 ------------------------------------------------------------------
1071
1072 Format LOCAL/GLOBAL
1073 ------ -------------
1074
1075 SEARCH= {exact | lstring } LOCAL/GLOBAL
1076
1077 FORMAT= {full | abridged | handle | summary } GLOBAL
1078
1079 MAXHITS= { 1-&lt;max-allowed&gt; } GLOBAL
1080
1081 Table III - Required WHOIS++ constraints.
1082
1083 ------------------------------------------------------------------
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116 <span class="grey">Deutsch, et al Standards Track [Page 20]</span></pre>
1117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
1118 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1119
1120
1121 <span class="h4"><a class="selflink" id="section-2.3.2" href="#section-2.3.2">2.3.2</a>. Optional CONSTRAINTS</span>
1122
1123 The following CONSTRAINTS and constraint values are not required of a
1124 conforming WHOIS++ server, but may be supported. If supported, their
1125 names and supported values must be returned in the response to the
1126 CONSTRAINTS command.
1127
1128 ---------------------------------------------------------------------
1129
1130 Format LOCAL/GLOBAL
1131 ------ -------------
1132
1133 SEARCH= { regex | fuzzy | substring | &lt;X-format&gt; } LOCAL/GLOBAL
1134
1135 CASE= { ignore | consider } LOCAL/GLOBAL
1136
1137 FORMAT= { server-to-ask | &lt;X-format&gt; } GLOBAL
1138
1139 MAXFULL= { 1-&lt;max-allowed&gt; } GLOBAL
1140
1141 AUTHENTICATE= password GLOBAL
1142
1143 NAME= &lt;string&gt; GLOBAL
1144
1145 PASSWORD= &lt;string&gt; GLOBAL
1146
1147 INCHARSET= { us-ascii | iso-8859-* } GLOBAL
1148
1149 LANGUAGE= &lt;As defined in ISO 639:1988&gt; GLOBAL
1150
1151 HOLD GLOBAL
1152
1153 IGNORE= {attributelist} GLOBAL
1154
1155 INCLUDE= {attributelist} GLOBAL
1156
1157 Table IV - Optional WHOIS++ constraints.
1158
1159 ----------------------------------------------------------------------
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172 <span class="grey">Deutsch, et al Standards Track [Page 21]</span></pre>
1173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
1174 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1175
1176
1177 <span class="h5"><a class="selflink" id="section-2.3.2.1" href="#section-2.3.2.1">2.3.2.1</a>. The SEARCH Constraint</span>
1178
1179 The SEARCH constraint is used for specifying the method that is to be
1180 used for the search. The default method is "exact". Following is a
1181 definition of each search method.
1182
1183
1184 exact The search will succeed for a word that exactly
1185 matches the search string.
1186
1187 substring The search will succeed for a word that matches
1188 a part of a word.
1189
1190 regex The search will succeed for a word when a regular
1191 expression matches the searched data. Regular
1192 expression is built up by using constructions of
1193 '*', '.', '^', '$', and '[]'. For use of
1194 regular expressions see <a href="#appendix-G">Appendix G</a>.
1195
1196 fuzzy The search will succeed for words that matches the
1197 search string by using an algorithm designed to catch
1198 closely related names with different spelling, e.g.
1199 names with the same pronounciation. The server
1200 chooses which algorithm to use, but it may vary
1201 depending on template name, attribute name and
1202 language used (see Constraint Language above).
1203
1204 lstring The search will succed for words that begins
1205 with the search string.
1206
1207 <span class="h5"><a class="selflink" id="section-2.3.2.2" href="#section-2.3.2.2">2.3.2.2</a>. The FORMAT Constraint</span>
1208
1209 The FORMAT constraint describes what format the result will be in.
1210 Default format is FULL. For a description of each format, see Server
1211 Response Modes below.
1212
1213 <span class="h5"><a class="selflink" id="section-2.3.2.3" href="#section-2.3.2.3">2.3.2.3</a>. The MAXFULL Constraint</span>
1214
1215 The MAXFULL constraint sets the limit of the number of matching
1216 records the server allows before it enforces SUMMARY responses. The
1217 client may attempt to override this value by specifying another value
1218 to that constraint. Example: If, for privacy reasons, the server will
1219 return the response in SUMMARY format if the number of hits exceeds
1220 2, the MAXFULL constraint is set to 2 by the server.
1221
1222 Regardless of what format the client did or did not ask for, the
1223 server will change the response format to SUMMARY when the number of
1224 matching records equals or exceeds this value.
1225
1226
1227
1228 <span class="grey">Deutsch, et al Standards Track [Page 22]</span></pre>
1229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
1230 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1231
1232
1233 <span class="h5"><a class="selflink" id="section-2.3.2.4" href="#section-2.3.2.4">2.3.2.4</a>. The MAXHITS Constraint</span>
1234
1235 The MAXHITS constraint sets the maximum number of records the client
1236 can get in a search respone.
1237
1238 <span class="h5"><a class="selflink" id="section-2.3.2.5" href="#section-2.3.2.5">2.3.2.5</a>. The CASE Constraint</span>
1239
1240 The CASE constraint defines if the search should be done case
1241 sensistive or not. Default value is to have case ignored.
1242
1243 <span class="h5"><a class="selflink" id="section-2.3.2.6" href="#section-2.3.2.6">2.3.2.6</a>. The AUTHENTICATE Constraint</span>
1244
1245 The AUTHENTICATE constraint describes which authentication method to
1246 use when executing the search. By using a specific authentication
1247 method, some other constraints might be needed which is specified by
1248 the authentication method.
1249
1250 The only authentication method described in this document is
1251 "password", if used, also the two other constraints "name" and
1252 "password" need to be set.
1253
1254 <span class="h5"><a class="selflink" id="section-2.3.2.7" href="#section-2.3.2.7">2.3.2.7</a>. The NAME Constraint</span>
1255
1256 The NAME constraint is only used together with some authentication
1257 method named by the constraint "authenticate". The only use described
1258 in this document is by sending a username as a string of characters
1259 which together with the string given as an argument to the "password"
1260 constraint is sent to the server. The server can use that pair of
1261 strings to do a simple authentication check, similar to the UNIX
1262 login program.
1263
1264 <span class="h5"><a class="selflink" id="section-2.3.2.8" href="#section-2.3.2.8">2.3.2.8</a>. The PASSWORD Constraint</span>
1265
1266 The PASSWORD constraint is only used together with some
1267 authentication method named by the constraint "authenticate". The
1268 only use described in this document is by sending a password as a
1269 string of characters which together with the string given as an
1270 argument to the "name" constraint is sent to the server. The server
1271 can use that pair of strings to do a simple authentication check,
1272 similar tothe UNIX login program.
1273
1274 <span class="h5"><a class="selflink" id="section-2.3.2.9" href="#section-2.3.2.9">2.3.2.9</a>. The LANGUAGE Constraint</span>
1275
1276 The LANGUAGE constraints can be used as an extra information to the
1277 fuzzy matching search method, and it might also be used to tell the
1278 server to give the system responses in another language, although
1279 this ability should be handled by the client. The language code
1280 defined in <a href="./rfc1766">RFC 1766</a> [<a href="#ref-ALVE95" title="&quot;Tags for the Identification of Languages&quot;">ALVE95</a>] can be used as a value for the language
1281
1282
1283
1284 <span class="grey">Deutsch, et al Standards Track [Page 23]</span></pre>
1285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
1286 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1287
1288
1289 constraint. In these, the case of the letters are insignigicant.
1290
1291 <span class="h5"><a class="selflink" id="section-2.3.2.10" href="#section-2.3.2.10">2.3.2.10</a>. The INCHARSET Constraint</span>
1292
1293 The INCHARSET constraint tells the server in which character set the
1294 search string itself is given in. The default character set is ISO-
1295 8859-1.
1296
1297 <span class="h5"><a class="selflink" id="section-2.3.2.11" href="#section-2.3.2.11">2.3.2.11</a>. The IGNORE Constraint</span>
1298
1299 The IGNORE constraint specifies which attributes to NOT include in
1300 the result. All other attributes will be included (as if named
1301 explicitly by the "include" constraint).
1302
1303 If an attribute is named both with the "include" and "ignore"
1304 constraint, the attribute is to be included in the result, but the
1305 system message must be "% 205 Requested constraint not fulfilled".
1306
1307 <span class="h5"><a class="selflink" id="section-2.3.2.12" href="#section-2.3.2.12">2.3.2.12</a>. The INCLUDE Constraint</span>
1308
1309 The INCLUDE constraint specifies which attributes to include in the
1310 result. All other attributes will be excluded (as if named explicitly
1311 by the "ignore" constraint).
1312
1313 If an attribute is named both with the "include" and "ignore"
1314 constraint, the attribute is to be included in the result, but the
1315 system message must be "% 205 Requested constraint not fulfilled".
1316
1317 <span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a>. Server Response Modes</span>
1318
1319 There are currently a total of five different response modes possible
1320 for WHOIS++ servers. These are FULL, ABRIDGED, HANDLE, SUMMARY and
1321 SERVER-TO-ASK. The syntax of each output format is specified in more
1322 detail in the following section.
1323
1324 1) A FULL format response provides the complete contents of a
1325 template matching the specified query, including the template
1326 type, the server handle and an optional record handle.
1327
1328 2) An ABRIDGED format response provides a brief summary, including
1329 (as a minimum) the server handle, the corresponding record handle
1330 and relevant information for that template.
1331
1332 3) A HANDLE format response returns a line with information about
1333 the server handle and record handle for a record that matched
1334 the specified query.
1335
1336
1337
1338
1339
1340 <span class="grey">Deutsch, et al Standards Track [Page 24]</span></pre>
1341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
1342 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1343
1344
1345 4) A SUMMARY response provides only a brief summary of information
1346 the number of matches and the list of template types in which the
1347 matches occured.
1348
1349 5) A SERVER-TO-ASK response only returns pointers to other index
1350 servers which might possibly be able to answer the specified
1351 query.
1352
1353 The server may respond with a null answer and may also respond with a
1354 null answer together with a correct system message to indicate that
1355 the query was too complex.
1356
1357 <span class="h4"><a class="selflink" id="section-2.4.1" href="#section-2.4.1">2.4.1</a>. Default Responses</span>
1358
1359 By default, a WHOIS++ server will provide FULL responses. This may be
1360 changed by the client with the use of the global constraint "format".
1361
1362 The server is allowed to provide response in SUMMARY format if the
1363 number of hits exceeds the value of the global constraint "maxfull".
1364
1365 The server will not respond with more matches than the value
1366 specified with the global constraint "maxhits"; Not in any response
1367 format. If the number of matches exceeds this value, the server will
1368 issues the system message 110 (maxhits value exceeded), but will
1369 still show the responses, up to the number of the "maxhits"
1370 constraint value. This mechanism will allow the server to hide the
1371 number of possible matches to a search command.
1372
1373 The server response modes are summarized in Table V.
1374
1375 <span class="h4"><a class="selflink" id="section-2.4.2" href="#section-2.4.2">2.4.2</a>. Format of Responses</span>
1376
1377 Each response consists of a numerical system generated message, which
1378 can be tagged with text, followed by an optional formatted response
1379 message, followed by a second system generated messages.
1380
1381 That is:
1382
1383 '%' &lt;system messages&gt; &lt;nl&gt;
1384
1385 [ &lt;formatted response&gt; ]
1386
1387 '%' &lt;system messages&gt; &lt;nl&gt;
1388
1389
1390 If there are no matches to a query, the system is not required to
1391 generate any output as a formatted response, although it must still
1392 generate system messages.
1393
1394
1395
1396 <span class="grey">Deutsch, et al Standards Track [Page 25]</span></pre>
1397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
1398 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1399
1400
1401 For information about the format for system messages, see <a href="#appendix-E">Appendix E</a>.
1402
1403 <span class="h4"><a class="selflink" id="section-2.4.3" href="#section-2.4.3">2.4.3</a>. Syntax of a Formatted Response</span>
1404
1405 All formatted responses except for the HANDLE response, consists of a
1406 response-specific START line, followed by an optional response-
1407 specific data section, followed by a TERMINATION line. The HANDLE
1408 response is different in that it only consists of a START line. It
1409 is permissible to insert any number of lines consisting solely of
1410 newlines within a formatted response to improve readibility.
1411
1412 Each line shall be limited to no more than 81 characters, including
1413 the terminating newline. If a line (including the required leading
1414 single space) would exceed 81 characters, it is to be broken into
1415 lines of no more than 81 characters, with each continuation line
1416 beginning with a "+" character in the first column instead of the
1417 leading character.
1418
1419 If an attribute value in a data section includes a line break, the
1420 line break must be replaced by a CR/LF pair and the following line
1421 begin with a "-" character in the first column, instead of the
1422 leading character. The attribute name is not repeated on consecutive
1423 lines.
1424
1425 A TERMINATION line consists of a line with a '#' in the first column,
1426 followed by one white space character (SPACE or TAB), followed by the
1427 keyword END, followed by zero or more characters, followed by a
1428 newline.
1429
1430 A response-specific section will be one of the following:
1431
1432 1) FULL Format Response
1433 2) ABRIDGED Format Response
1434 3) HANDLE Format Response
1435 4) SUMMARY Format Response
1436 5) SERVER-TO-ASK Format Response
1437
1438 The details of each are specified in the following sections:
1439
1440 <span class="h5"><a class="selflink" id="section-2.4.3.1" href="#section-2.4.3.1">2.4.3.1</a>. A FULL format response</span>
1441
1442 A FULL format response consists of a series of responses, each
1443 consisting of a START line, followed by the complete template
1444 information for the matching record and a TERMINATION line.
1445
1446 Each START line consists of a '#' in the first column, followed by
1447 one white space character, the word "FULL", a white space character,
1448 the name of the corresponding template type, one white space
1449
1450
1451
1452 <span class="grey">Deutsch, et al Standards Track [Page 26]</span></pre>
1453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
1454 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1455
1456
1457 character, the server handle, a white space character, an optional
1458 handle for the record, and a terminating newline.
1459
1460 The template information for the record will be returned as a series
1461 of lines consisting of a single space, followed by the corresponding
1462 line of the record.
1463
1464 The line of the record shall consist of a single space and the
1465 attribute name followed by a ':', a single space, the value of that
1466 attribute, and a newline.
1467
1468 <span class="h5"><a class="selflink" id="section-2.4.3.2" href="#section-2.4.3.2">2.4.3.2</a>. ABRIDGED Format Response</span>
1469
1470 Each ABRIDGED format response consists of a START line, a single line
1471 excerpt of the template information from each matching record and a
1472 TERMINATION line. The excerpt information shall include information
1473 that is relevant to the template type.
1474
1475 The START line consists of a '#' in the first column, followed by one
1476 white space character, the word "ABRIDGED", a white space character,
1477 the name of the corresponding template type, a white space character,
1478 the server handle, a white space character, the handle for the
1479 record, and a terminating newline.
1480
1481 The abridged template information will be returned as a line,
1482 consisting of a single space, followed by the abridged line of the
1483 record and a newline pair.
1484
1485 <span class="h5"><a class="selflink" id="section-2.4.3.3" href="#section-2.4.3.3">2.4.3.3</a>. HANDLE Format Response</span>
1486
1487 A HANDLE response consists of a single START line, which shall start
1488 with a '#' in the first column, followed by one white space
1489 character, the word "HANDLE", a white space character, the name of
1490 the corresponding template, a white space character, the handle for
1491 the server, a white space character, the handle for that record, and
1492 a terminating newline.
1493
1494 <span class="h5"><a class="selflink" id="section-2.4.3.4" href="#section-2.4.3.4">2.4.3.4</a>. SUMMARY Format Response</span>
1495
1496 A SUMMARY format response consists of a single set of responses,
1497 consisting of a line listing the number of matches to the specified
1498 query, followed by a list of all template types which satisfied the
1499 query at least once.
1500
1501 The START line shall begin with a '#' in the first column, be
1502 followed by one white space character, the word "SUMMARY", a white
1503 space character, the handle for the server, and a terminating
1504 newline.
1505
1506
1507
1508 <span class="grey">Deutsch, et al Standards Track [Page 27]</span></pre>
1509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
1510 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1511
1512
1513 All following lines until the TERMINATION line starts with a leading
1514 space. The first line shall begin with the string "matches: ", be
1515 followed by a space and the number of responses to the query and
1516 terminated by a newline. The second line shall begin with the string
1517 "templates: ", be followed by a newline separated list of the name of
1518 the template types which matched the query. Each line following the
1519 first which include the text "templates:" must begin with a '-'
1520 instead of a space.
1521
1522 <span class="h5"><a class="selflink" id="section-2.4.3.5" href="#section-2.4.3.5">2.4.3.5</a>. SERVER-TO-ASK Response</span>
1523
1524 A SERVER-TO-ASK response consists of information to the client about
1525 a server to contact next to resolve a query. If the server has
1526 pointers to more than one server, it will present additional SERVER-
1527 TO-ASK responses.
1528
1529 The SERVER-TO-ASK response will consist of a START line and a number
1530 of lines with attribute-value pairs, separated by CRLF. Each line is
1531 indented with one space. The end of a SERVER-TO-ASK response is
1532 indicated with a TERMINATION line.
1533
1534 Each START line consists of a '#' in the first column, followed by
1535 one white space character, the word "SERVER-TO-ASK", a white space
1536 character, the handle of the server and a terminating newline.
1537
1538 1. "Server-Handle" - The server handle of the server pointed at.
1539 (req.)
1540 2. "Host-Name" - A cached host named for the server pointed at. (opt.)
1541 3. "Host-Port" - A cached port number for the server pointed at.
1542 (opt.)
1543
1544 Other attributes may be present, depending on the index server.
1545
1546 <span class="h4"><a class="selflink" id="section-2.4.4" href="#section-2.4.4">2.4.4</a>. System Generated Messages</span>
1547
1548 All system generated messages must begin with a '%' as the first
1549 character, a space as the second one, followed by a three digit
1550 number, a space and an optional text message. The total length of the
1551 line must be no more than 81 characters long, including the
1552 terminating CR LF pair. There is no limit to the number of system
1553 messages that may be generated.
1554
1555 The format for multiline replies requires that every line, except the
1556 last, begin with "%", followed by space, the reply code, a hyphen,
1557 and an optional text. The last line will begin with "%", followed by
1558 space, the reply code, a space and some optional text.
1559
1560
1561
1562
1563
1564 <span class="grey">Deutsch, et al Standards Track [Page 28]</span></pre>
1565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
1566 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1567
1568
1569 System generated messages displayed before or after the formatted
1570 response section are expected to refer to operation of the system or
1571 refer to the entire query. System generated messages within the
1572 output of an individual record during a FULL reponse are expected to
1573 refer to that record only, and could (for example) be used to
1574 indicate problems with that record of the response. See <a href="#appendix-E">Appendix E</a>
1575 for a description of system messages.
1576
1577 <span class="h3"><a class="selflink" id="section-2.5" href="#section-2.5">2.5</a>. Compatibility with Older WHOIS Servers</span>
1578
1579 Note that this format, although potentially more verbose, is still in
1580 a human readible form. Responses from older systems that do not
1581 follow this format are still conformant, since their responses would
1582 be interpreted as being equivalent to optional text messages, without
1583 a formatted response. Clients written to this specification would
1584 display the responses as a advisory text message, where it would
1585 still be readible by the user.
1586
1587 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Miscellaneous</span>
1588
1589 <span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Acknowledgements</span>
1590
1591 The WHOIS++ effort began as an intensive brainstorming session at the
1592 24th IETF, in Boston Massachusetts. Present at the birth, and
1593 contributing ideas through this early phase, were (alphabetically)
1594 Peter Deutsch, Alan Emtage, Jim Fullton, Joan Gargano, Brad
1595 Passwaters, Simon Spero, and Chris Weider. Others who have since
1596 helped shape this document with feedback and suggestions include
1597 Roxana Bradescu, Patrik Faltstrom, Kevin Gamiel, Dan Kegel, Michael
1598 Mealling, Mark Prior and Rickard Schoultz.
1599
1600 <span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a> References</span>
1601
1602 [<a id="ref-ALVE95">ALVE95</a>] Alvestrand H., "Tags for the Identification of
1603 Languages", <a href="./rfc1766">RFC 1766</a>, UNINETT, March 1995.
1604
1605 [<a id="ref-HARR85">HARR85</a>] Harrenstein K., Stahl M., and E. Feinler,
1606 "NICNAME/WHOIS", <a href="./rfc954">RFC 954</a>, SRI, October 1985.
1607
1608 [<a id="ref-IIIR">IIIR</a>] Weider C., and P. Deutsch, "A Vision of an
1609 Integrated Internet Information Service", <a href="./rfc1727">RFC 1727</a>
1610 Bunyip Information Systems, Inc., December 1994.
1611
1612 [<a id="ref-POST82">POST82</a>] Postel J., "Simple Mail Transfer Protocol", STD 10,
1613 <a href="./rfc821">RFC 821</a>, USC/Information Sciences Institute,
1614 August 1982.
1615
1616
1617
1618
1619
1620 <span class="grey">Deutsch, et al Standards Track [Page 29]</span></pre>
1621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
1622 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1623
1624
1625 <span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Authors' Addresses</span>
1626
1627 Peter Deutsch
1628 BUNYIP INFORMATION SYSTEMS, Inc.
1629 310 St-Catherine St West,
1630 Suite 202,
1631 Montreal, Quebec H2X 2A1
1632 CANADA
1633
1634 EMail: [email protected]
1635
1636
1637 Rickard Schoultz
1638 KTHNOC, SUNET/NORDUnet/Ebone Operations Centre
1639 100 44 STOCKHOLM
1640 SWEDEN
1641
1642 EMail: [email protected]
1643
1644
1645 Patrik Faltstrom
1646 BUNYIP INFORMATION SYSTEMS, Inc.
1647 310 St-Catherine St West,
1648 Suite 202,
1649 Montreal, Quebec H2X 2A1
1650 CANADA
1651
1652 EMail: [email protected]
1653
1654
1655 Chris Weider
1656 BUNYIP INFORMATION SYSTEMS, Inc.
1657 2001 S. Huron Parkway, #12
1658 Ann Arbor, MI 48104
1659 USA
1660
1661 EMail: [email protected]
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676 <span class="grey">Deutsch, et al Standards Track [Page 30]</span></pre>
1677 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
1678 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1679
1680
1681 Appendix A - Some Sample Queries
1682
1683 author=chris and template=user
1684
1685 The result will consist of all records where attribute "author"
1686 matches "chris" with case ignored. Only USER templates will be
1687 searched. An example of a matching record is "Author=Chris Weider".
1688 This is the typical case of search.
1689
1690 schoultz and rick;search=lstring
1691
1692 The result will consist of all records which have one attribute value
1693 matching "schoultz" exactly and one having "rick" as leading
1694 substring, both with case ignored. One example is "Name=Rickard
1695 choultz".
1696
1697 value=phone;search=substring
1698
1699 The result will consist of all records which have attribute values
1700 matching *phone*, for example the record "Name=Acme telephone inc.",
1701 but will not match the attribute name "phone". (Since "value" term
1702 specifier is the default, the search term could be "phone" as well as
1703 "value=phone".)
1704
1705 search-all=Peter ; search=substring;case=consider
1706
1707 The result will consist of all records which have attribute names,
1708 template names or attribute values matching "Peter" with respect to
1709 case. One example is "Friend-Of-Peter: Yes".
1710
1711 ucdavis;search=substring and (gargano or joan):include=name,email
1712
1713 This search command will find records which have records containing
1714 the words "gargano" or "joan" somewhere in the record, and has the
1715 word "ucdavis" somewhere in a word. The result will only show the
1716 "name" and "email" fields.
1717
1718 Appendix B - Some sample responses
1719
1720 1) FULL format responses:
1721
1722 # FULL USER SERVERHANDLE1 PD45
1723 Name: Peter Deutsch
1724 email: [email protected]
1725 # END
1726 # FULL USER SERVERHANDLE1 AE1
1727 Name: Alan Emtage
1728 email: [email protected]
1729
1730
1731
1732 <span class="grey">Deutsch, et al Standards Track [Page 31]</span></pre>
1733 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
1734 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1735
1736
1737 # END
1738 # FULL USER SERVERHANDLE1 NW1
1739 Name: Nick West
1740 Favourite-Bicycle-Forward-Wheel-Brand: New Bicy
1741 +cles Acme Inc.
1742 email: [email protected]
1743 My-favourite-song: Happy birthday to you!
1744 -Happy birthday to you!
1745 -Happy birthday dear Nick!
1746 -Happy birthday to you.
1747 # END
1748 # FULL SERVICES SERVERHANDLE1 WWW1
1749 Type: World Wide Web
1750 Location: the world
1751 # END
1752
1753 --------------------
1754
1755
1756 2) An ABRIDGED format response:
1757
1758 # ABRIDGED USER SERVERHANDLE1 PD45
1759 Peter Deutsch [email protected]
1760 # END
1761 # ABRIDGED USER SERVERHANDLE1 AE1
1762 Alan Emtage [email protected]
1763 # END
1764 # ABRIDGED USER SERVERHANDLE1 WWW1
1765 World Wide Web the world
1766 # END
1767
1768
1769 --------------------
1770
1771
1772 3) HANDLE format responses:
1773
1774
1775 # HANDLE USER SERVERHANDLE1 PD45
1776 # HANDLE USER SERVERHANDLE1 AE1
1777 # HANDLE SERVICES SERVERHANDLE1 WWW1
1778
1779
1780 --------------------
1781
1782
1783
1784
1785
1786
1787
1788 <span class="grey">Deutsch, et al Standards Track [Page 32]</span></pre>
1789 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
1790 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1791
1792
1793 4) A SUMMARY HANDLE format response:
1794
1795 # SUMMARY SERVERHANDLE1
1796
1797 Matches: 175
1798 Templates: User
1799 - Services
1800 - Abstracts
1801 # END
1802
1803 Appendix C - Sample responses to system commands
1804
1805 C.1 Response to the LIST command
1806
1807 # FULL LIST SERVERHANDLE1
1808 Templates: USER
1809 -SERVICES
1810 -HELP
1811 # END
1812
1813
1814 C.2 Response to the SHOW command
1815
1816 This example shows the result after issuing "show user":
1817
1818 # FULL USER SERVERHANDLE1
1819 Name:
1820 Email:
1821 Work-Phone:
1822 Organization-Name:
1823 City:
1824 Country:
1825 # END
1826
1827 C.3 Response to the POLLED-BY command
1828
1829 # FULL POLLED-BY SERVERHANDLE1
1830 Server-handle: serverhandle2
1831 Cached-Host-Name: sunic.sunet.se
1832 Cached-Host-Port: 7070
1833 Template: USER
1834 Field: ALL
1835 # END
1836 # FULL POLLED-BY SERVERHANDLE1
1837 Server-handle: serverhandle3
1838 Cached-Host-Name: kth.se
1839 Cached-Host-Port: 7070
1840 Template: ALL
1841
1842
1843
1844 <span class="grey">Deutsch, et al Standards Track [Page 33]</span></pre>
1845 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
1846 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1847
1848
1849 Field: Name,Email
1850 # END
1851
1852
1853 C.4 Response to the POLLED-FOR command
1854
1855 # FULL POLLED-FOR SERVERHANDLE1
1856 Server-Handle: serverhandle5
1857 Template: ALL
1858 Field: Name,Address,Job-Title,Organization-Name,
1859 +Organization-Address,Organization-Name
1860 # END
1861 # FULL POLLED-FOR SERVERHANDLE1
1862 Server-Handle: serverhandle4
1863 Template: USER
1864 Field: ALL
1865 # END
1866
1867
1868 C.5 Response to the VERSION command
1869
1870 # FULL VERSION BUNYIP.COM
1871 Version: 1.0
1872 Program-Name: kth-whoisd
1873 Program-Version: 2.0
1874 # END
1875
1876
1877 C.6 Response to the CONSTRAINTS command
1878
1879 # FULL CONSTRAINT COMEDIA.SE
1880 Constraint: format
1881 Default: full
1882 Range: full,abridged,summary,handle
1883 # END
1884 # FULL CONSTRAINT COMEDIA.SE
1885 Constraint: maxhits
1886 Default: 200
1887 Range: 1-1000
1888 # END
1889 # FULL CONSTRAINT COMEDIA.SE
1890 Constraint: search
1891 Default: exact
1892 Range: exact,substring,lstring
1893 # END
1894 # FULL CONSTRAINT COMEDIA.SE
1895 Constraint: maxfull
1896 Default: 20
1897
1898
1899
1900 <span class="grey">Deutsch, et al Standards Track [Page 34]</span></pre>
1901 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
1902 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1903
1904
1905 # END
1906
1907 C.3 Response to the COMMANDS command
1908
1909 # FULL COMMANDS SERVERHANDLE1
1910 Commands: commands
1911 -constraints
1912 -describe
1913 -help
1914 -list
1915 -polled-by
1916 -polled-for
1917 -show
1918 -version
1919 # END
1920
1921 Appendix D - Sample whois++ session
1922
1923 Below is an example of a session between a client and a server. The
1924 angle brackets to the left is not part of the communication, but is
1925 just put there to denonte the direction of the communication between
1926 the server or the client. Text appended to '&gt;' means messages from
1927 the server and '&lt;' from the client.
1928
1929 Client connects to the server
1930
1931 &gt;% 220-Welcome to
1932 &gt;% 220-the whois++ server
1933 &gt;% 220 at ACME inc.
1934 &lt;name=Nick:hold
1935 &gt;% 200 Command okay
1936 &gt;
1937 &gt;# FULL USER ACME.COM NW1
1938 &gt; name: Nick West
1939 &gt; email: [email protected]
1940 &gt;# END
1941 &gt;# SERVER-TO-ASK ACME.COM
1942 &gt; Server-Handle: SUNETSE01
1943 &gt; Host-Name: whois.sunet.se
1944 &gt; Host-Port: 7070
1945 &gt;# END
1946 &gt;# SERVER-TO-ASK ACME.COM
1947 &gt; Server-Handle: KTHSE01
1948 &gt;# END
1949 &gt;% 226 Tranfer complete
1950 &lt;version
1951 &gt;% 200 Command okay
1952 &gt;# FULL VERSION ACME.COM
1953
1954
1955
1956 <span class="grey">Deutsch, et al Standards Track [Page 35]</span></pre>
1957 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
1958 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
1959
1960
1961 &gt; Version: 1.0
1962 &gt;# END
1963 &gt;% 226 Tranfer complete
1964 &gt;% 203 Bye
1965 Server closes the connection
1966
1967 In the example above, the client connected to a whois++ server and
1968 queried for all records where the attribute "name" equals "Nick", and
1969 asked the server not to close the connection after the response by
1970 using the global constraint "HOLD".
1971
1972 The server responds with one record and a pointer to two other
1973 servers that either holds records or pointers to other servers.
1974
1975 The client continues with asking for the servers version number
1976 without using the HOLD constraint. After responding with protocol
1977 version, the server closes the connection.
1978
1979 Note that each response from the server begins system message 200
1980 (Command OK), and ends with system message 226 (Transfer Complete).
1981
1982 Appendix E - System messages
1983
1984 A system message begins with a '%', followed by a space and a three
1985 digit number, a space, and an optional text message. The line message
1986 must be no more than 81 characters long, including the terminating CR
1987 LF pair. There is no limit to the number of system messages that may
1988 be generated.
1989
1990 A multiline system message have a hyphen instead of a space in column
1991 6, immediately after the numeric response code in all lines, except
1992 the last one, where the space is used.
1993
1994 Example 1
1995
1996 % 200 Command okay
1997
1998 Example 2
1999
2000 % 220-Welcome to
2001 % 220-the whois++ server
2002 % 220 at ACME inc.
2003
2004 The client is not expected to parse the text part of the response
2005 message except when receiving reply 600, in which case the text part
2006 is the name of a character set that will be used by the server in the
2007 rest of the response. The valid values for characters sets is
2008 specified in the "characterset" list in the BNF listing in Appendix
2009
2010
2011
2012 <span class="grey">Deutsch, et al Standards Track [Page 36]</span></pre>
2013 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
2014 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
2015
2016
2017 F.
2018
2019 The theory of reply codes is described in <a href="#appendix-E">Appendix E</a> in STD 10, <a href="./rfc821">RFC</a>
2020 <a href="./rfc821">821</a> [<a href="#ref-POST82" title="&quot;Simple Mail Transfer Protocol&quot;">POST82</a>].
2021
2022 ------------------------------------------------------------------------
2023
2024 List of system response codes
2025 ------------------------------
2026
2027 <span class="h2"><a class="selflink" id="section-110" href="#section-110">110</a> Too many hits </span> The number of matches exceeded
2028 the value specified by the
2029 maxhits constraint. Server
2030 will still reply with as many
2031 records as "maxhits" allows.
2032
2033 <span class="h2"><a class="selflink" id="section-111" href="#section-111">111</a> Requested constraint not supported </span> One or more constraints in
2034 query is not implemented, but
2035 the search is still done.
2036
2037 <span class="h2"><a class="selflink" id="section-112" href="#section-112">112</a> Requested constraint not fullfilled </span> One or more constraints in
2038 query has unacceptable value
2039 and was therefore not used,
2040 but the search is still done.
2041
2042 <span class="h2"><a class="selflink" id="section-200" href="#section-200">200</a> Command Ok </span> Command accepted and executed.
2043 The client must wait for a
2044 transaction end system message.
2045
2046 <span class="h2"><a class="selflink" id="section-201" href="#section-201">201</a> Command Completed successfully </span> Command accepted and executed.
2047
2048 <span class="h2"><a class="selflink" id="section-203" href="#section-203">203</a> Bye </span> Server is closing connection
2049
2050 <span class="h2"><a class="selflink" id="section-220" href="#section-220">220</a> Service Ready </span> Greeting message. Server is
2051 accepting commands.
2052
2053 <span class="h2"><a class="selflink" id="section-226" href="#section-226">226</a> Transaction complete </span> End of data. All responses to
2054 query are sent.
2055
2056 <span class="h2"><a class="selflink" id="section-430" href="#section-430">430</a> Authentication needed </span> Client requested information
2057 that needs authentication.
2058
2059 <span class="h2"><a class="selflink" id="section-500" href="#section-500">500</a> Syntax error</span>
2060
2061 <span class="h2"><a class="selflink" id="section-502" href="#section-502">502</a> Search expression too complicated </span> This message is sent when the
2062 server is not able to resolve
2063 a query (i.e. when a client
2064 sent a regular expression that
2065
2066
2067
2068 <span class="grey">Deutsch, et al Standards Track [Page 37]</span></pre>
2069 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
2070 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
2071
2072
2073 is too deeply nested).
2074
2075 <span class="h2"><a class="selflink" id="section-530" href="#section-530">530</a> Authentication failed </span> The authentication phase
2076 failed.
2077
2078 <span class="h2"><a class="selflink" id="section-600" href="#section-600">600</a> &lt;token&gt; </span> Subsequent attribute values
2079 are encoded in the charater
2080 set specified by &lt;token&gt;.
2081
2082 Table V - System response codes
2083
2084 ------------------------------------------------------------------------
2085
2086 Appendix F - The WHOIS++ BNF Grammar
2087
2088
2089
2090 whois-command = ( system-command [":" "hold"]
2091 / terms [":" globalcnstrnts] ) NL
2092
2093 system-command = "constraints"
2094 / "describe"
2095 / "commands"
2096 / "polled-by"
2097 / "polled-for"
2098 / "version"
2099 / "list"
2100 / "show" [1*SP string]
2101 / "help" [1*SP string]
2102 / "?" [string]
2103
2104 terms = and-expr *("or" and-expr)
2105
2106 and-expr = not-expr *("and" not-expr)
2107
2108 not-expr = ["not"] (term / ( "(" terms ")" ))
2109
2110 term = generalterm / specificterm
2111 / shorthandle / combinedterm
2112
2113 generalterm = string *(";" localcnstrnt)
2114
2115 specificterm = specificname "=" string
2116 *(";" localcnstrnt)
2117
2118 specificname = "handle" / "value"
2119
2120 shorthandle = "!" string *(";" localcnstrnt)
2121
2122
2123
2124 <span class="grey">Deutsch, et al Standards Track [Page 38]</span></pre>
2125 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
2126 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
2127
2128
2129 combinedterm = string "=" string *(";" localcnstrnt)
2130
2131 globalcnstrnts = globalcnstrnt *(";" globalcnstrnt)
2132
2133 globalcnstrnt = localcnstrnt
2134 / "format" "=" format
2135 / "maxfull" "=" 1*digit
2136 / "maxhits" "=" 1*digit
2137 / opt-globalcnst
2138
2139 opt-globalcnst = "hold"
2140 / "authenticate" "=" auth-method
2141 / "name" "=" string
2142 / "password" "=" string
2143 / "language" "=" language
2144 / "incharset" "=" characterset
2145 / "ignore" "=" string
2146 / "include" "=" string
2147
2148 format = "full" / "abridged" / "handle" / "summary"
2149 / "server-to-ask"
2150
2151 language = &lt;The language code defined in <a href="./rfc1766">RFC1766</a> [<a href="#ref-ALVE95" title="&quot;Tags for the Identification of Languages&quot;">ALVE95</a>]&gt;
2152
2153 characterset = "us-ascii" / "iso-8859-1" / "iso-8859-2" /
2154 "iso-8859-3" / "iso-8859-4" / "iso-8859-5" /
2155 "iso-8859-6" / "iso-8859-7" / "iso-8859-8" /
2156 "iso-8859-9" / "iso-8859-10" / "utf-8" /
2157 charset-value
2158
2159 charset-value = 1*char
2160
2161 localcnstrnt = "search" "=" searchvalue /
2162 "case" "=" casevalue
2163
2164 searchvalue = "exact" / "substring" / "regex" / "fuzzy"
2165 / "lstring"
2166
2167 casevalue = "ignore" / "consider"
2168
2169 auth-method = "password"
2170
2171 string = 0*char
2172
2173 char = "\" specialchar
2174 / &lt;Characters 0-255 (decimal) except specialchar&gt;
2175
2176
2177
2178
2179
2180 <span class="grey">Deutsch, et al Standards Track [Page 39]</span></pre>
2181 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
2182 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
2183
2184
2185 specialchar = " " / &lt;tab&gt; / "=" / "," / ":" / ";" / "\" /
2186 "*" / "." / "(" / ")" / "[" / "]" / "^" /
2187 "$" / "!" / "?"
2188
2189 digit = "0" / "1" / "2" / "3" / "4" /
2190 "5" / "6" / "7" / "8" / "9"
2191
2192 NL = &lt;CR LF (decimal 13 10)&gt;
2193
2194
2195 NOTE: Significant blanks must be escaped. The following
2196 characters, when significant to the query, may be preceded
2197 and/or followed by a single blank:
2198
2199 : ; , ( ) = !
2200
2201 Appendix G - Description of Regular expressions
2202
2203 The regular expressions described in this section is the same as used
2204 in many other applications and operating systems. It is though very
2205 simple and does not include logical operators AND and OR.
2206
2207 Searches using regular expressions are always using substring
2208 matching except when the regular expression contains the characters
2209 '^' or '$'.
2210
2211 Character Function
2212 --------- --------
2213
2214 &lt;any except those listed in this table&gt; Matches itself
2215
2216 . Matches any character
2217
2218 a* Matches zero or more 'a'
2219
2220 [<a id="ref-ab">ab</a>] Matches 'a' or 'b'
2221
2222 [<a id="ref-a-c">a-c</a>] Matches 'a', 'b' or 'c'
2223
2224 ^ Matches beginning of
2225 a token
2226
2227 $ Matches end of a token
2228
2229
2230
2231
2232
2233
2234
2235
2236 <span class="grey">Deutsch, et al Standards Track [Page 40]</span></pre>
2237 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
2238 <span class="grey"><a href="./rfc1835">RFC 1835</a> Architecture of the WHOIS++ service August 1995</span>
2239
2240
2241 Examples
2242 ---------
2243
2244 String Matches Matches not
2245 ------- ------- -----------
2246 hello xhelloy heello
2247 h.llo hello helio
2248 h.*o hello helloa
2249 h[a-f]llo hello hgllo
2250 ^he.* hello ehello
2251 .*lo$ hello helloo
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292 Deutsch, et al Standards Track [Page 41]
2293 </pre>