FYI: [ARIN] New Whois Display Format

Oki all,

Ginny Listman sent this to the dbwg list at ARIN. It is self-explanitory.

Eric


------- Forwarded Message

Date: Tue, 12 Mar 2002 11:00:20 -0500 (EST)
From: ginny listman <[email protected]>
To: [email protected]
Subject: New Whois Display Format
Message-ID: <[email protected]>
MIME-Version: 1.0
Content-Type: MULTIPART/MIXED; BOUNDARY="-559023410-851401618-1015948820=:12375"
Sender: [email protected]
Precedence: bulk

  This message is in MIME format.  The first part should be readable text,
  while the remaining parts are likely unreadable without MIME-aware tools.
  Send mail to [email protected] for more info.

- ---559023410-851401618-1015948820=:12375
Content-Type: TEXT/PLAIN; charset=US-ASCII

To coincide with the release of the new database and templates, ARIN has
begun development of a new Whois, in a modular format. The Output Module
will define the Whois display. It is our objective to keep the Whois
display in a easily readable format, while accomodating machine queries
by providing labels.

The requirements outlined in this document are based on feedback from the
community. To provide a usable tool, we are requesting additional comments 
at this time.  Additionally, this format will be discussed at the Member
Meeting taking place April 7-10 in Las Vegas.

Ginny Listman
Director of Engineering
ARIN

*****

           WHOIS REQUIREMENTS

I. Uses of Whois
   a. As a troubleshooting aid
   b. For Applications that use resource assignment information
   c. To show address space utilization
   d. In the future, to display routing objects

II. Privacy
   a. The Whois database is a public resource.

III. Formats
   a. The "default" format is returned when querying Whois without any flags, 
      and there is a single record returned. For ease of use all items will
      include labels. If a field does not exist, for example if a POC is 
      missing a email address, a label will not be displayed. Refer to the 
      attached "Whois Examples" for samples. The four object will be displayed 
      as follows:

      i. Point Of Contact - display all attributes of the POC

         Name: <last name, first name, middle name> or <role account>
         Handle: <point of contact handle>
         Address: <organization name, street address, city, state, zip, 
                   country code>
         Phone: <phone number, phone extension, phone type>
         Phone: <phone number, phone extension, phone type>
         Email: <email address>
         Email: <email address>

     ii. Organization - list the organization and all associated POCs

         Org Name: <organization name>
         Org ID: <organization ID, formerly maintainer ID>
         Org Address: <street address, city, state, zip, country code>

         Org <POC function> Handle: <POC handle>
         Org <POC function> Name: <POC name>
         Org <POC function> Phone: <POC office phone number><*>
         Org <POC function> Email: <POC email address><*>

         Org <POC function> Handle: <POC handle>
         Org <POC function> Name: <POC name>
         Org <POC function> Phone: <POC office phone number><*>
         Org <POC function> Email: <POC email address><*>
          
         Note: Organization POC functions include Admin, Tech, Abuse and NOC.

    iii. Autonomous System - list the organization, the autonomous system,
         POCs for the autonomous system, and POCs for the organization

         Org Name: <organization name>
         Org ID: <organization ID, formerly maintainer ID>
         Org Address: <street address, city, state, zip, country code>

         AS Number: <autonomous system number>
         AS Handle: <autonomous system handle>
         AS Name: <autonomous system name>

         AS <POC function> Handle: <POC handle>
         AS <POC function> Name: <POC name>
         AS <POC function> Phone: <POC office phone number><*>
         AS <POC function> Email: <POC email address><*>

         Org <POC function> Handle: <POC handle>
         Org <POC function> Name: <POC name>
         Org <POC function> Phone: <POC office phone number><*>
         Org <POC function> Email: <POC email address><*>
          
         Note: All POCs for the AS will be displayed. Only the organization's
         Tech, Abuse and NOC POCs will be displayed.

     iv. IPv4 Network - list the organization, the network, POCs for the
         network, POCs for the organization

         Org Name: <organization name>
         Org ID: <organization ID, formerly maintainer ID>
         Org Address: <street address, city, state, zip, country code>

         CIDR Net Address: <network address in CIDR format>
         Network Range: <network address range>
         Network Handle: <network handle>
         Network Name: <network name>
         Can Sub-Delegate: <Y/N>
         IN-ADDR: <in-addr server name>
         IN-ADDR: <in-addr server name>

         Net <POC function> Handle: <POC handle>
         Net <POC function> Name: <POC name>
         Net <POC function> Phone: <POC office phone number><*>
         Net <POC function> Email: <POC email address><*>

         Net <POC function> Handle: <POC handle>
         Net <POC function> Name: <POC name>
         Net <POC function> Phone: <POC office phone number><*>
         Net <POC function> Email: <POC email address><*>
          
         Note: All POCs for the network will be displayed. Only the 
         organization's Tech, Abuse and NOC POCs will be displayed.

         * Indicates that multiple phone numbers or email addresses exist,
           of which only the first is displayed.

   b. The "list" format is returned when querying Whois without specifying any 
      flags, and there are multiple records returned. Labels are not included.
      The fields that are displayed are outlined below.
      i. Point Of Contact - last name, first name, middle name, handle, one 
         email address, one office phone number
     ii. Organization - Organization name, Organization ID
    iii. Autonomous System - AS name, handle, AS number
   iiii. Network - network name, handle, either a single CIDR block or network
         range.

   c. In the future, we may provide the output in RPSL-like format.

IV. Query by type. To narrow a search, a query can include a flag indicating
    the object type as follows:
   a. n <query string> will return only networks
   b. a <query string> will return only autonomous systems
   c. p <query string> will return only point-of-contacts
   d. o <query string> will return only organizations

V. Query by attribute. To narrow a search, a query can also include a flag
   as follows:
   a. ! <handle> will return the single match of the specified handle
   b. @ <DNS name> will return the list of POCs with the specified domain name
      in the email address
   c. . <name> will return a list of POCs, organizations, autonomous systems,
      and/or networks that start with the specified name

VI. Additional features
   a. Sub-queries can be displayed using the % flag.  The queried string
      must return a single record to provide sub-query information.  The
      following objects have sub-query information:
      i. Networks - display the reassignment/reallocation information in
         list format, if data exists.
     ii. Organizations - display the organization's resources information
         in list format, if data exists.
   b. Parentage can be displayed using the * flag.  The queried string
      must return a single record to provide parentage information.  The
      following objects have parentage information:
      i. Networks - display the parentage in default format, if data exists.
     ii. Organizations - will be implemented in future releases.
   c. Other keywords
      i. = <query string> will show default displays for all matches, 
         regardless of the number returned
     ii. HELP will display the help screen
    iii. <query string>. will show a list of all matches starting with the
         given string.
     iv. SUM <query string> will show list displays, even if there is only
         one match.
   d. The maximum number of records output is limited to 256.  This may be
      revised in future versions.
   e. A future enhancement will include an relational lookup.  For example, if
      a POC is queried, the resouces associated with the POC would be 
      displayed.

- ---559023410-851401618-1015948820=:12375
Content-Type: TEXT/PLAIN; charset=US-ASCII; name=whois-ex
Content-Transfer-Encoding: BASE64
Content-ID: <[email protected]>
Content-Description: Whois Examples

ICAgICAgICAgICAgICAgIFdIT0lTIEVYQU1QTEVTDQoNClRoZSBmb2xsb3dp
bmcgaW5mb3JtYXRpb24gaXMgdXNlZCBhcyBzYW1wbGUgZGF0YS4NCg0KMS4g
T3JnYW5pemF0aW9uIEFCQyBJU1AgaXMgcmVnaXN0ZXJlZCB3aXRoIDUgUE9D
cyAtIERFRi1BUklOIGFzIHRoZSANCmFkbWluaXN0cmF0aXZlIGNvbnRhY3Qs
IEFCQy1URUNILUFSSU4gYW5kICBBQkMtVEVDSDItQVJJTiBhcyB0ZWNobmlj
YWwgDQpjb250YWN0cywgQUJDLU5PQy1BUklOIGFzIGEgTk9DIGNvbnRhY3Qg
YW5kIEFCQy1BQlUtQVJJTiBhcyBhbiBhYnVzZSBjb250YWN0Lg0KMi4gQUJD
IElTUCBoYXMgYmVlbiBhc3NpZ25lZCBhdXRvbm9tb3VzIHN5c3RlbSA2NTAw
MCwgYW5kIGhhcyBBQlVTRS1BUklOIGFzIA0KYW4gYWJ1c2UgY29udGFjdC4N
CjMuIEFCQyBJU1AgaGFzIGJlZW4gYWxsb2NhdGVkIHR3byBuZXR3b3JrIGJs
b2Nrcy4gIFRoZSBmaXJzdCAxMC4wLjAuMC8xNQ0KZG9lcyBub3QgaGF2ZSBh
bnkgcmVzb3VyY2UgUE9DcyBhc3NvY2lhdGVkIHdpdGggaXQuICBJdCBoYXMg
dHdvIElOLUFERFIgc2VydmVycy4NCjQuIFRoZSBzZWNvbmQgYWxsb2NhdGlv
biAxMC4zMi4wLjAvMTYgaGFzIFNVUC1BUklOIGFzIGEgdGVjaG5pY2FsIGNv
bnRhY3QgYW5kDQpOT0MyLUFSSU4gYXMgYSBOT0MgY29udGFjdC4gIEl0IGhh
cyA0IElOLUFERFIgc2VydmVycy4NCjUuIEFCQyBoYXMgcmVhc3NpZ25lZCAx
MC4zMi4wLjAtMTAuMzIuMC4xOSB0byBYWVogSVNQLiBYWVogaGFzIHRoZSBt
aW5pbWFsDQphbW91bnQgb2YgUE9DcyAtIFhZWi1URUNILUFSSU4gYXMgdGhl
IG9yZ2FuaXphdGlvbmFsIHRlY2huaWNhbCBhbmQgWFlaLUFETUktQVJJTg0K
YXMgdGhlIGFkbWluaXN0cmF0aXZlLiBUaGVyZSBhcmUgbm8gUE9DcyBvciBJ
Ti1BRERSIHNlcnZlcnMgb24gdGhlIHJlYWxsb2NhdGlvbi4NCg0KQmFzZWQg
b24gdGhpcyBpbmZvcm1hdGlvbiwgdGhlIHdob2lzIGRpc3BsYXkgd291bGQg
YmUgYXMgZm9sbG93czoNCg0KMS4gd2hvaXMgYWJjDQogICAgT3JnIE5hbWU6
IEFCQyBJU1ANCiAgICBPcmcgSUQ6IEFCQw0KICAgIE9yZyBBZGRyZXNzOiAx
MzIgTWFpbiBTdHJlZXQNCiAgICAgICAgICAgICAgICAgQW55dG93biwgVkEg
MjIyMjINCiAgICAgICAgICAgICAgICAgVVMNCg0KICAgIE9yZyBBZG1pbiBI
YW5kbGU6IERFRi1BUklODQogICAgT3JnIEFkbWluIE5hbWU6IEZvb2Jhciwg
RHdpZ2h0IEUuDQogICAgT3JnIEFkbWluIFBob25lOiArMS05OTktOTk5LTc3
NzcgKE9mZmljZSkgKg0KICAgIE9yZyBBZG1pbiBFbWFpbDogZm9vYmFyQGV4
YW1wbGUubmV0DQoNCiAgICBPcmcgVGVjaCBIYW5kbGU6IEFCQy1URUNILUFS
SU4NCiAgICBPcmcgVGVjaCBOYW1lOiBUZWNobmljYWwgU3VwcG9ydA0KICAg
IE9yZyBUZWNoIFBob25lOiArMS05OTktOTk5LTk5OTkgKE9mZmljZSkgKg0K
ICAgIE9yZyBUZWNoIEVtYWlsOiB0ZWNoQGV4YW1wbGUubmV0DQoNCiAgICBP
cmcgVGVjaCBIYW5kbGU6IEFCQy1URUNIMi1BUklODQogICAgT3JnIFRlY2gg
TmFtZTogVGVjaG5pY2FsIFN1cHBvcnQgTWFuYWdlcg0KICAgIE9yZyBUZWNo
IFBob25lOiArMS05OTktOTk5LTg4ODggKE9mZmljZSkNCiAgICBPcmcgVGVj
aCBFbWFpbDogdGVjaC1tZ3JAZXhhbXBsZS5uZXQNCg0KICAgIE9yZyBOT0Mg
SGFuZGxlOiBBQkMtTk9DLUFSSU4NCiAgICBPcmcgTk9DIE5hbWU6IE5ldHdv
cmsgT3BlcmF0aW9ucyBDZW50ZXINCiAgICBPcmcgTk9DIFBob25lOiArMS05
OTktOTk5LTY2NjYgKE9mZmljZSkgKg0KICAgIE9yZyBOT0MgRW1haWw6IG5v
Y0BleGFtcGxlLm5ldA0KDQogICAgT3JnIEFidXNlIEhhbmRsZTogQUJDLUFC
VS1BUklODQogICAgT3JnIEFidXNlIE5hbWU6IE5ldHdvcmsgQWJ1c2UgU3Vw
cG9ydA0KICAgIE9yZyBBYnVzZSBQaG9uZTogKzEtOTk5LTk5OS01NTU1IChP
ZmZpY2UpICoNCiAgICBPcmcgQWJ1c2UgRW1haWw6IGFidXNlQGV4YW1wbGUu
bmV0DQoNCjIuIHdob2lzIDY1MDAwDQogICAgT3JnIE5hbWU6IEFCQyBJU1AN
CiAgICBPcmcgSUQ6IEFCQw0KDQogICAgQVMgTnVtYmVyOiA2NTAwMA0KICAg
IEFTIEhhbmRsZTogQVM2NTAwMA0KICAgIEFTIE5hbWU6IEFCQy1BU042NTAw
MA0KDQogICAgQVMgQWJ1c2UgSGFuZGxlOiBBQlVTRS1BUklODQogICAgQVMg
QWJ1c2UgTmFtZTogQVMgNjUwMDAgQWJ1c2UgU3VwcG9ydA0KICAgIEFTIEFi
dXNlIFBob25lOiArMS03MDMtMDAwLTAwMDAgKE9mZmljZSkgKg0KICAgIEFT
IEFidXNlIEVtYWlsOiBhYnVzZS02NTAwMEBleGFtcGxlLm5ldA0KDQogICAg
T3JnIFRlY2ggSGFuZGxlOiBBQkMtVEVDSC1BUklODQogICAgT3JnIFRlY2gg
TmFtZTogVGVjaG5pY2FsIFN1cHBvcnQNCiAgICBPcmcgVGVjaCBQaG9uZTog
KzEtOTk5LTk5OS05OTk5IChPZmZpY2UpICoNCiAgICBPcmcgVGVjaCBFbWFp
bDogdGVjaEBleGFtcGxlLm5ldA0KDQogICAgT3JnIFRlY2ggSGFuZGxlOiBB
QkMtVEVDSDItQVJJTg0KICAgIE9yZyBUZWNoIE5hbWU6IFRlY2huaWNhbCBT
dXBwb3J0IE1hbmFnZXINCiAgICBPcmcgVGVjaCBQaG9uZTogKzEtOTk5LTk5
OS04ODg4IChPZmZpY2UpDQogICAgT3JnIFRlY2ggRW1haWw6IHRlY2gtbWdy
QGV4YW1wbGUubmV0DQoNCiAgICBPcmcgTk9DIEhhbmRsZTogQUJDLU5PQy1B
UklODQogICAgT3JnIE5PQyBOYW1lOiBOZXR3b3JrIE9wZXJhdGlvbnMgQ2Vu
dGVyDQogICAgT3JnIE5PQyBQaG9uZTogKzEtOTk5LTk5OS02NjY2IChPZmZp
Y2UpICoNCiAgICBPcmcgTk9DIEVtYWlsOiBub2NAZXhhbXBsZS5uZXQNCg0K
ICAgIE9yZyBBYnVzZSBIYW5kbGU6IEFCQy1BQlUtQVJJTg0KICAgIE9yZyBB
YnVzZSBOYW1lOiBOZXR3b3JrIEFidXNlIFN1cHBvcnQNCiAgICBPcmcgQWJ1
c2UgUGhvbmU6ICsxLTk5OS05OTktNTU1NSAoT2ZmaWNlKSAqDQogICAgT3Jn
IEFidXNlIEVtYWlsOiBhYnVzZUBleGFtcGxlLm5ldA0KDQozLiB3aG9pcyAx
MC4wLjAuMA0KICAgIE9yZyBOYW1lOiBBQkMgSVNQDQogICAgT3JnIElEOiBB
QkMNCg0KICAgIENJRFIgTmV0IEFkZHJlc3M6IDEwLjAuMC4wLzE1DQogICAg
TmV0d29yayBSYW5nZTogMTAuMC4wLjAtMTAuMS4yNTUuMjU1DQogICAgTmV0
d29yayBIYW5kbGU6IE5FVC0xMC0wLTAtMA0KICAgIE5ldHdvcmsgTmFtZTog
TkVUV09SSy0xMA0KICAgIENhbiBTdWItRGVsZWdhdGU6IFkNCiAgICBJTi1B
RERSOiBucy5leGFtcGxlLm5ldA0KICAgIElOLUFERFI6IG5zMi5leGFtcGxl
Lm5ldA0KDQogICAgT3JnIFRlY2ggSGFuZGxlOiBBQkMtVEVDSC1BUklODQog
ICAgT3JnIFRlY2ggTmFtZTogVGVjaG5pY2FsIFN1cHBvcnQNCiAgICBPcmcg
VGVjaCBQaG9uZTogKzEtOTk5LTk5OS05OTk5IChPZmZpY2UpICoNCiAgICBP
cmcgVGVjaCBFbWFpbDogdGVjaEBleGFtcGxlLm5ldA0KDQogICAgT3JnIFRl
Y2ggSGFuZGxlOiBBQkMtVEVDSDItQVJJTg0KICAgIE9yZyBUZWNoIE5hbWU6
IFRlY2huaWNhbCBTdXBwb3J0IE1hbmFnZXINCiAgICBPcmcgVGVjaCBQaG9u
ZTogKzEtOTk5LTk5OS04ODg4IChPZmZpY2UpDQogICAgT3JnIFRlY2ggRW1h
aWw6IHRlY2gtbWdyQGV4YW1wbGUubmV0DQoNCiAgICBPcmcgTk9DIEhhbmRs
ZTogQUJDLU5PQy1BUklODQogICAgT3JnIE5PQyBOYW1lOiBOZXR3b3JrIE9w
ZXJhdGlvbnMgQ2VudGVyDQogICAgT3JnIE5PQyBQaG9uZTogKzEtOTk5LTk5
OS02NjY2IChPZmZpY2UpICoNCiAgICBPcmcgTk9DIEVtYWlsOiBub2NAZXhh
bXBsZS5uZXQNCg0KICAgIE9yZyBBYnVzZSBIYW5kbGU6IEFCQy1BQlUtQVJJ
Tg0KICAgIE9yZyBBYnVzZSBOYW1lOiBOZXR3b3JrIEFidXNlIFN1cHBvcnQN
CiAgICBPcmcgQWJ1c2UgUGhvbmU6ICsxLTk5OS05OTktNTU1NSAoT2ZmaWNl
KSAqDQogICAgT3JnIEFidXNlIEVtYWlsOiBhYnVzZUBleGFtcGxlLm5ldA0K
DQo0LiB3aG9pcyAxMC4zMi4wLjANCiAgICBORVRXT1JLLTEwLjMyIChORVQt
MTAtMzItMC0wKSAgICAgICAgICAgICAgICAgIDEwLjMyLjAuMC8xNg0KICAg
IE5FVC0xMC0zMi1SRSAoTkVULTEwLTMyLTAtMC0yKSAgICAgICAgIDEwLjMy
LjAuMC0xMC4zMi4wLjE5DQoNCjUuIHdob2lzIE5FVC0xMC0zMi0wLTAtMg0K
ICAgIE9yZyBOYW1lOiBYWVogSVNQDQogICAgT3JnIElEOiBYWVoNCg0KICAg
IENJRFIgTmV0IEFkZHJlc3M6IDEwLjMyLjAuMC8yOCwgMTAuMzIuMC4xOS8z
MA0KICAgIE5ldHdvcmsgUmFuZ2U6IDEwLjMyLjAuMC0xMC4zMi4wLjE5DQog
ICAgTmV0d29yayBIYW5kbGU6IE5FVC0xMC0zMi0wLTAtMg0KICAgIE5ldHdv
cmsgTmFtZTogTkVULTEwLTMyLVJFDQogICAgQ2FuIFN1Yi1EZWxlZ2F0ZTog
Tg0KDQogICAgT3JnIFRlY2ggSGFuZGxlOiBYWVotVEVDSC1BUklODQogICAg
T3JnIFRlY2ggTmFtZTogVGVjaG5pY2FsIFN1cHBvcnQNCiAgICBPcmcgVGVj
aCBQaG9uZTogKzEtNzc3LTc3Ny03Nzc3IChPZmZpY2UpICoNCiAgICBPcmcg
VGVjaCBFbWFpbDogdGVjaC14eXpAZXhhbXBsZS5uZXQNCg0KNi4gd2hvaXMg
QUJDLU5PQy1BUklODQogICAgTmFtZTogTmV0d29yayBPcGVyYXRpb25zIENl
bnRlcg0KICAgIEhhbmRsZTogQUJDLU5PQy1BUklODQogICAgQWRkcmVzczog
QUJDIElTUA0KICAgICAgICAgICAgIDEzMiBNYWluIFN0cmVldA0KICAgICAg
ICAgICAgIEFueXRvd24sIFZBIDIyMjIyDQogICAgICAgICAgICAgVVMNCiAg
ICBQaG9uZTogKzEtOTk5LTk5OS02NjY2IChPZmZpY2UpDQogICAgUGhvbmU6
ICsxLTg4OC04ODgtODg4OCAoTW9iaWxlKQ0KICAgIFBob25lOiArMS03Nzct
Nzc3LTc3NzcgKEZheCkNCiAgICBFbWFpbDogbm9jQGV4YW1wbGUubmV0DQo=
- ---559023410-851401618-1015948820=:12375--

------- End of Forwarded Message