idnits 2.17.1 draft-ietf-weirds-json-response-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack a Security Considerations section. ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (September 19, 2012) is 4237 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Unused Reference: 'RFC0791' is defined on line 1022, but no explicit reference was found in the text == Unused Reference: 'RFC2616' is defined on line 1028, but no explicit reference was found in the text ** Downref: Normative reference to an Informational RFC: RFC 1166 ** Obsolete normative reference: RFC 2616 (Obsoleted by RFC 7230, RFC 7231, RFC 7232, RFC 7233, RFC 7234, RFC 7235) ** Obsolete normative reference: RFC 4627 (Obsoleted by RFC 7158, RFC 7159) == Outdated reference: A later version (-18) exists of draft-ietf-weirds-rdap-query-00 == Outdated reference: A later version (-15) exists of draft-ietf-weirds-using-http-01 -- Possible downref: Normative reference to a draft: ref. 'I-D.ietf-weirds-using-http' Summary: 5 errors (**), 0 flaws (~~), 5 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group A. Newton 3 Internet-Draft ARIN 4 Intended status: Standards Track S. Hollenbeck 5 Expires: March 23, 2013 Verisign Labs 6 September 19, 2012 8 JSON Responses for the Registy Data Access Protocol (RDAP) 9 draft-ietf-weirds-json-response-00 11 Abstract 13 This document describes responses in the JSON format to the Registry 14 Data Access Protocol (RDAP) queries described in 15 draft-ietf-weirds-rdap-query. 17 Status of this Memo 19 This Internet-Draft is submitted in full conformance with the 20 provisions of BCP 78 and BCP 79. 22 Internet-Drafts are working documents of the Internet Engineering 23 Task Force (IETF). Note that other groups may also distribute 24 working documents as Internet-Drafts. The list of current Internet- 25 Drafts is at http://datatracker.ietf.org/drafts/current/. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 This Internet-Draft will expire on March 23, 2013. 34 Copyright Notice 36 Copyright (c) 2012 IETF Trust and the persons identified as the 37 document authors. All rights reserved. 39 This document is subject to BCP 78 and the IETF Trust's Legal 40 Provisions Relating to IETF Documents 41 (http://trustee.ietf.org/license-info) in effect on the date of 42 publication of this document. Please review these documents 43 carefully, as they describe your rights and restrictions with respect 44 to this document. Code Components extracted from this document must 45 include Simplified BSD License text as described in Section 4.e of 46 the Trust Legal Provisions and are provided without warranty as 47 described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 52 2. Terminology and Definitions . . . . . . . . . . . . . . . . . 4 53 3. Common Data Types . . . . . . . . . . . . . . . . . . . . . . 5 54 4. The Entity Object Class . . . . . . . . . . . . . . . . . . . 6 55 4.1. The RIR Entity Object Class . . . . . . . . . . . . . . . 7 56 4.2. The DNR Entity Object Class . . . . . . . . . . . . . . . 9 57 5. The Nameserver Object Class . . . . . . . . . . . . . . . . . 11 58 6. The Domain Object Class . . . . . . . . . . . . . . . . . . . 13 59 6.1. The RIR Domain Object Class . . . . . . . . . . . . . . . 13 60 6.2. The DNR Domain Object Class . . . . . . . . . . . . . . . 16 61 7. The IP Network Object Class . . . . . . . . . . . . . . . . . 20 62 8. Autonomous System Number Entity Object Class . . . . . . . . . 23 63 9. Contributing Authors and Acknowledgements . . . . . . . . . . 26 64 10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 27 65 10.1. Normative References . . . . . . . . . . . . . . . . . . . 27 66 10.2. Informative References . . . . . . . . . . . . . . . . . . 28 67 Appendix A. Suggested Values . . . . . . . . . . . . . . . . . . 29 68 A.1. Status . . . . . . . . . . . . . . . . . . . . . . . . . . 29 69 A.2. Roles . . . . . . . . . . . . . . . . . . . . . . . . . . 29 70 A.3. URI Types . . . . . . . . . . . . . . . . . . . . . . . . 30 71 Appendix B. Suggested Data Modeling with the Entity Object 72 Class . . . . . . . . . . . . . . . . . . . . . . . . 31 73 B.1. Registrants and Contacts . . . . . . . . . . . . . . . . . 31 74 B.2. Registrars . . . . . . . . . . . . . . . . . . . . . . . . 32 75 Appendix C. IDN Query and Response Model . . . . . . . . . . . . 34 76 Appendix D. Postal Addresses vs Location . . . . . . . . . . . . 35 77 Appendix E. Changelog . . . . . . . . . . . . . . . . . . . . . . 36 78 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 37 80 1. Introduction 82 This document describes responses in the JSON [RFC4627] format for 83 the RESTful web queries as defined by UNIFIED-RDAP-QUERY 84 [I-D.ietf-weirds-rdap-query]. The signalling for JSON, JSON naming 85 scheme, JSON namespace and extension mechanism and normalized 86 references to other specifications are documented in RDAP-HTTP 87 [I-D.ietf-weirds-using-http]. 89 The data model for the responses consists of two major categories: 90 responses returned by Regional Internet Registries (RIRs) for 91 registrations data related to IP addresses, reverse DNS names, and 92 Autonomous System numbers; and responses returned by Domain Name 93 Registries (DNRs) for registration data related to forward DNS names. 94 Where overlap exists between RIR and DNR reponse object classes, the 95 RIR object classes are a proper subset of the DNR object classes. 96 The current division between RIR and DNR object classes is given to 97 illustrate an expectation of what data may be expected from an RIR vs 98 a DNR. However, implementers should be aware that RIRs are not 99 limited to the data in the RIR object classes (as an example, some 100 RIRs have a notion of "status" for entities as defined in the DNR 101 entity object class and may at some point start publishing that 102 data). 104 Object classes defined in this document do not represent the full 105 range of data that any registry may wish to publish. RDAP-HTTP 106 [I-D.ietf-weirds-using-http] defines a JSON extension mechanism that 107 maybe used by registries to insert registry specific data values. 109 2. Terminology and Definitions 111 The following list describes terminology and definitions used 112 throughout this document: 114 DNR: "Domain Name Registry". 116 member: data found with in an object as defined by JSON 117 [RFC4627]. 119 object: a data structure as defined by JSON [RFC4627]. 121 object class: the definition of members that may be found in JSON 122 objects described in this document. 124 object instance: an instantiation or specific instance of an object 125 class. 127 RDAP: "Registry Data Access Protocol". 129 RIR: "Regional Internet Registry". 131 3. Common Data Types 133 JSON [RFC4627] defines the data types of a number, character string, 134 boolean, array, object and null. This section describes the 135 semantics and/or syntax reference for data types used in this 136 document derived from the JSON character string. 138 'handle': DNRs and RIRs have registry-unique identifiers that may 139 be used to specifically reference an object instance. The 140 semantics of this data type as found in this document is to be a 141 registry-unique reference to the closest enclosing object where 142 the value is found. The data type names 'registryId', 'roid', 143 'nic-handle', 'registrationNo', etc... are terms often synomous 144 with this data type. In this document, the term 'handle' is used. 145 The term exposed to users by clients is a presentation issue 146 beyond the scope of this document. 148 IPv4 addresses: The representation of IPv4 addresses in this 149 document uses the dotted-decimal notation described in [RFC1166]. 150 An example of this textual representation is '192.0.2.0'. 152 IPv6 addresses: The representation of IPv6 addresses in this 153 document follow the forms outlined in [RFC5952]. An example of 154 this textual representation is '2001:db8::1:0:0:1'. 156 country codes: Where the identity of a geopolitical nation or 157 country is needed, these identities are represented with the 158 alpha-2 or 2 character country code designation as defined in 159 [ISO.3166.1988]. The alpha-2 representation is used because it is 160 freely available whereas the alpha-3 and numeric-3 standards are 161 not. 163 domain names: Textual representations of DNS names follow the rules 164 set forth in [RFC4343], specifically the case insensitivity and 165 character escaping rules. Trailing periods are optional for both 166 input and output. 168 email addresses: Textual representations of email addresses follow 169 the syntax defined in [RFC5322]. 171 dates and times: The syntax for values denoting dates and times is 172 defined in [RFC3339]. 174 URIs: The syntax for values denoting a Uniform Resource Identifier 175 (URI) is defined by [RFC3986]. 177 4. The Entity Object Class 179 The entity object class appears throughout this document and is an 180 appropriate response for the /entity/XXXX query defined in UNIFIED- 181 RDAP-QUERY [I-D.ietf-weirds-rdap-query]. This object class 182 represents the information of organizations, corporations, 183 governments, non-profits, clubs, individual persons, and informal 184 groups of people. All of these representations are so similar that 185 it is best to represent them in JSON [RFC4627] with one construct, 186 the entity object class, to aid in the re-use of code by 187 implementers. 189 Many of the members of the entity object class are repeated in other 190 object classes described later in this document. 192 4.1. The RIR Entity Object Class 194 The following is an example of an RIR entity: 196 { 197 "handle" : "XXXX", 198 "names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], 199 "roles" : [ "registrant" ], 200 "postalAddress" : 201 [ 202 "123 Maple Ave", 203 "Suite 90001", 204 "Vancouver", 205 "BC", 206 "12393" 207 ], 208 "emails" : [ "joe@bob.com", "bob@joe.com" ], 209 "phones" : 210 { 211 "office" : [ "999-999-999-99", "111-111-111-11" ], 212 "fax" : [ "222-222-222-22" ], 213 "mobile" : [ "333-333-333-33" ] 214 }, 215 "remarks" : 216 [ 217 "she sells seas shells", 218 "down by the seashore" 219 ], 220 "uris" : 221 [ 222 { 223 "type" : "source", 224 "uri" : "http://whois-rws.net/contact/xxxx" 225 }, 226 { 227 "type" : "held", 228 "uri" : "http://example.net/location/xxxx" 229 } 230 ], 231 "registrationDate" : "1990-12-31T23:59:60Z", 232 "lastChangedDate" : "1990-12-31T23:59:60Z", 233 "lastChangedBy" : "joe@bob.com" 234 } 236 This object as the following members. 238 o handle -- a string representing an registry unique identifier of 239 the entity 241 o names -- an array of strings, each signifying the name of the 242 entity 244 o roles -- an array of strings, each signifying the relationship an 245 object would have with its closest containing object. 247 o postalAddress -- an array of string, each representing a line in a 248 postal address. 250 o emails -- an array of strings, each containing an email address 251 for the entity 253 o phones -- an object containg telephone information associated with 254 the entity, with the following members: 256 * office -- an array of strings, each being a telephone number 258 * fax -- an array of strings, each being a telephone number 260 * mobile -- an array of strings, each being a telephone number 262 o remarks -- an array of strings, each containing comments about the 263 entity 265 o uris -- an array of objects, each object having the following 266 members: 268 * type -- a string denoting the application type of the "uri" 269 value 271 * uri -- a string containing a URI [RFC3986] 273 o registrationDate -- a string containing the date the entity was 274 registered 276 o lastChangedDate -- a string containing the date of last change 277 made to the entity 279 o lastChangedBy -- a string containing an identifier of the party 280 responsible for the last change made to the entity registration 282 4.2. The DNR Entity Object Class 284 The DNR entity object class is a superset of the RIR entity object 285 class (Section 4.1). It has the following additional members: 287 o registrationBy -- a string containing an identifier of the party 288 responsible for the registration of the entity 290 o sponsoredBy -- a string containing an identifier of the party 291 through which the registration was made, such as an IANA approved 292 registrar 294 o resoldBy -- a string containing an identifier of the party 295 originating the registration of the entity. 297 o status -- an array of strings indicating the state of the entity 299 o port43 -- a string containing the fully-qualified host name of the 300 WHOIS [RFC3912] server where the object instance may be found. 302 The following is an example of a DNR entity: 304 { 305 "handle" : "XXXX", 306 "names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], 307 "status" : [ "validated", "locked" ], 308 "postalAddress" : 309 [ 310 "123 Maple Ave", 311 "Suite 90001", 312 "Vancouver", 313 "BC", 314 "12393" 315 ], 316 "emails" : [ "joe@bob.com", "bob@joe.com" ], 317 "phones" : 318 { 319 "office" : [ "999-999-999-99", "111-111-111-11" ], 320 "fax" : [ "222-222-222-22" ], 321 "mobile" : [ "333-333-333-33" ] 322 }, 323 "remarks" : 324 [ 325 "she sells seas shells", 326 "down by the seashore" 327 ], 328 "uris" : 329 [ 330 { 331 "type" : "source", 332 "uri" : "http://whois-rws.net/entity/xxxx" 333 }, 334 { 335 "type" : "held", 336 "uri" : "http://example.net/location/xxxx" 337 } 338 ], 339 "port43" : "whois.example.net", 340 "registrationDate" : "1990-12-31T23:59:60Z", 341 "registrationBy" : "ABC123", 342 "lastChangedDate" : "1990-12-31T23:59:60Z", 343 "lastChangedBy" : "ABC123", 344 "sponsoredBy" : "SponsorXYZ", 345 "resoldBy" : "ResellerPDQ" 346 } 348 5. The Nameserver Object Class 350 The nameserver object class is used by both RIRs and DNRs. Unlike 351 other object classes used by both registries where the RIR object 352 class is a subset of the DNR object class, a clear delineation is not 353 made with the nameserver object class because some DNRs have the same 354 or a similar registration model as the RIRs. RIRs and some DNRs 355 register or expose nameserver information as an attribute of a domain 356 name, while other DNRs model nameservers as "first class objects". 358 The nameserver object class accomodates both models and degrees of 359 variation in between. 361 The following is an example of a nameserver object. 363 { 364 "handle" : "XXXX", 365 "name" : "ns1.example.com", 366 "status" : "active", 367 "ipAddresses" : [ "192.0.2.0", "192.0.2.1" ], 368 "remarks" : 369 [ 370 "she sells seas shells", 371 "down by the seashore" 372 ], 373 "uris" : 374 [ 375 { 376 "type" : "source", 377 "uri" : "http://example.net/nameserver/xxxx" 378 } 379 ], 380 "port43" : "whois.example.net", 381 "registrationDate" : "1990-12-31T23:59:60Z", 382 "registrationBy" : "ABC123", 383 "lastChangedDate" : "1990-12-31T23:59:60Z", 384 "lastChangedBy" : "ABC123", 385 "sponsoredBy" : "SponsorXYZ", 386 "resoldBy" : "ResellerPDQ" 387 } 389 Figure 1 391 Figure 1 is an example of a nameserver object with all values given. 392 Registries using a first-class nameserver data model would embed this 393 in domain objects as well as allowing references to it with the 394 /nameserver query type (all depending on the registry operators 395 policy). Other registries may pare back the information as needed. 396 Figure 2 is an example of a nameserver object as would be found in 397 RIRs and some DNRs, while Figure 3 is an example of a nameserver 398 object as would be found in other DNRs. 400 The following is an example of the simplest nameserver object. 402 { 403 "name" : "ns1.example.com" 404 } 406 Figure 2 408 The following is an example of a simple nameserver object that might 409 be commonly used by DNRs. 411 { 412 "name" : "ns1.example.com", 413 "ipAddresses" : [ "192.0.2.0", "192.0.2.1" ] 414 } 416 Figure 3 418 The nameserver object class has the following members: 420 o handle -- a string representing an registry unique identifier of 421 the nameserver 423 o name -- a string containing the DNS name of the nameserver 425 o ipAddresses -- an array of strings containing IPv4 and/or IPv6 426 addresses of the nameserver 428 The members "status", "remarks", "uris", "port43", "sponsoredBy", 429 "resoldBy", "registrationBy", "registrationDate", "lastChangedDate", 430 and "lastChangedBy" take the same form of the members of the same 431 name of the entity object (Section 4). 433 6. The Domain Object Class 435 The domain object class represents a DNS name and point of 436 delegation. For RIRs these delegation points are in the reverse DNS 437 tree, whereas for DNRs these delegation points are in the forward DNS 438 tree. The RIR domain object class is a subset of the DNR object 439 class. 441 In both cases, the high level structure of the domain object class 442 consists of information about the domain registration, nameserver 443 information related to the domain name, and entities related to the 444 domain name (e.g. registrant information, contacts, etc...). 446 The following is an elided example of the domain object showing the 447 high level structure. 449 { 450 "handle" : "XXX", 451 "name" : "blah.example.com", 452 ... 453 "nameServers" : 454 [ 455 ... 456 ], 457 ... 458 "entities" : 459 [ 460 ... 461 ] 462 } 464 6.1. The RIR Domain Object Class 466 The following is an example of a JSON object representing a reverse 467 DNS delegation point or the RIR domain object class. 469 { 470 "handle" : "XXXX", 471 "name" : "192.in-addr.arpa", 472 "nameServers" : 473 [ 474 { "name" : "ns1.rir.net" }, 475 { "name" : "ns2.rir.net" } 476 ], 477 "delegationKeys" : 479 [ 480 { 481 "algorithm": 7, 482 "digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C", 483 "digestType" : 1, 484 "keyTag" : 53814 485 } 486 ], 487 "remarks" : 488 [ 489 "she sells seas shells", 490 "down by the seashore" 491 ], 492 "uris" : 493 [ 494 { 495 "type" : "source", 496 "uri" : "http://whois-rws.net/network/xxxx" 497 }, 498 { 499 "type" : "parent", 500 "uri" : "http://whois-rws.net/network/yyyy" 501 }, 502 { 503 "type" : "held", 504 "uri" : "http://example.net/location/xxxx" 505 } 506 ], 507 "registrationDate" : "1990-12-31T23:59:60Z", 508 "lastChangedDate" : "1990-12-31T23:59:60Z", 509 "lastChangedBy" : "joe@bob.com", 510 "entities" : 511 [ 512 { 513 "handle" : "XXXX", 514 "names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], 515 "roles" : [ "registrant" ], 516 "postalAddress" : 517 [ 518 "123 Maple Ave", 519 "Suite 90001", 520 "Vancouver", 521 "BC", 522 "12393" 523 ], 524 "emails" : [ "joe@bob.com", "bob@joe.com" ], 525 "phones" : 526 { 527 "office" : [ "999-999-999-99", "111-111-111-11" ], 528 "fax" : [ "222-222-222-22" ], 529 "mobile" : [ "333-333-333-33" ] 530 }, 531 "remarks" : 532 [ 533 "she sells seas shells", 534 "down by the seashore" 535 ], 536 "uris" : 537 [ 538 { 539 "type" : "source", 540 "uri" : "http://whois-rws.net/entity/xxxx" 541 }, 542 { 543 "type" : "held", 544 "uri" : "http://example.net/location/xxxx" 545 } 546 ], 547 "registrationDate" : "1990-12-31T23:59:60Z", 548 "lastChangedDate" : "1990-12-31T23:59:60Z", 549 "lastChangedBy" : "joe@bob.com" 550 } 551 ] 552 } 554 The following is a description of the members of this object: 556 o handle -- a string representing a registry unique identifier of 557 the domain object instance 559 o name -- a string denoting the DNS zone name, which is a domain 560 name 562 o nameservers -- an array of nameserver objects as defined by 563 Section 5 565 o delegationKeys -- an array of objects, each with the following 566 members: 568 * algorithm -- an integer as specified by the algorithm field of 569 a DNS DS record as specified by RFC 4034 [RFC4034] in 570 presentation format 572 * digest -- an string as specified by the digest field of a DNS 573 DS record as specified by RFC 4034 in presentation format 575 * digestType -- an integer as specified by the digest type field 576 of a DNS DS record as specified by RFC 4034 in presetnation 577 format 579 * keyTag -- an integer as specified by the key tag field of a DNS 580 DS record as specified by RFC 4034 in presentation format 582 o entities -- an array of entity objects as defined by Section 4.1. 584 The members "remarks", "uris", "registrationDate", "lastChangedDate", 585 and "lastChangedBy" take the same form of the members of the same 586 name of the entity object (Section 4). 588 6.2. The DNR Domain Object Class 590 The DNR domain object class is a superset of the RIR domain object 591 class (Section 6.1) and has the following additional members. 593 o variants -- an array of strings, each containing a domain name 594 that is a variant of this domain name object instance. 596 o expirationDate -- a string containing the date and time this 597 domain name registration will expire 599 o registrationBy -- a string containing an identifier of the party 600 responsible for the registration of the domain name 602 o sponsoredBy -- a string containing an identifier of the party 603 through which the registration was made, such as an IANA approved 604 registrar 606 o resoldBy -- a string containing an identifier of the party 607 originating the registration of the domain name 609 o status -- an array of strings indicating the state of the domain 610 name 612 o transferDate -- a string containing the date and time this domain 613 name was transferred 615 o port43 -- a string containing the fully-qualified host name of the 616 WHOIS [RFC3912] server where the object instance may be found. 618 The following is an example of a JSON object representing a forward 619 DNS delegation point or the DNR domain object class. 621 { 622 "handle" : "XXXX", 623 "name" : "blah.example.com", 624 "variants" : [ "blah2.example.com", "blah3.example.com" ], 625 "status" : [ "locked", "transferProhibited" ], 626 "nameServers" : 627 [ 628 { 629 "handle" : "XXXX", 630 "name" : "ns1.example.com", 631 "status" : "active", 632 "ipAddresses" : [ "192.0.2.0", "192.0.2.1" ], 633 "remarks" : 634 [ 635 "she sells seas shells", 636 "down by the seashore" 637 ], 638 "uris" : 639 [ 640 { 641 "type" : "source", 642 "uri" : "http://example.net/nameserver/xxxx" 643 } 644 ], 645 "registrationDate" : "1990-12-31T23:59:60Z", 646 "registrationBy" : "ABC123", 647 "lastChangedDate" : "1990-12-31T23:59:60Z", 648 "lastChangedBy" : "ABC123", 649 "sponsoredBy" : "SponsorXYZ", 650 "resoldBy" : "ResellerPDQ" 651 }, 652 { 653 "handle" : "XXXX", 654 "name" : "ns2.example.com", 655 "status" : "active", 656 "ipAddresses" : [ "192.0.2.2", "192.0.2.3" ], 657 "remarks" : 658 [ 659 "she sells seas shells", 660 "down by the seashore" 661 ], 662 "uris" : 663 [ 664 { 665 "type" : "source", 666 "uri" : "http://example.net/nameserver/xxxx" 667 } 668 ], 669 "registrationDate" : "1990-12-31T23:59:60Z", 670 "registrationBy" : "ABC123", 671 "lastChangedDate" : "1990-12-31T23:59:60Z", 672 "lastChangedBy" : "ABC123", 673 "sponsoredBy" : "SponsorXYZ", 674 "resoldBy" : "ResellerPDQ" 675 } 676 ] 677 "delegationKeys" : 678 [ 679 { 680 "algorithm": 7, 681 "digest" : "E68C017BD813B9AE2F4DD28E61AD014F859ED44C", 682 "digestType" : 1, 683 "keyTag" : 53814 684 } 685 ], 686 "remarks" : 687 [ 688 "she sells seas shells", 689 "down by the seashore" 690 ], 691 "uris" : 692 [ 693 { 694 "type" : "source", 695 "uri" : "http://example.net/domain/xxxx" 696 }, 697 { 698 "type" : "held", 699 "uri" : "http://example.net/location/xxxx" 700 } 701 ], 702 "port43" : "whois.example.net", 703 "registrationDate" : "1990-12-31T23:59:60Z", 704 "registrationBy" : "ABC123", 705 "lastChangedDate" : "1990-12-31T23:59:60Z", 706 "lastChangedBy" : "ABC123", 707 "sponsoredBy" : "SponsorXYZ", 708 "resoldBy" : "ResellerPDQ", 709 "expirationDate" : "2016-12-31T23:59:60Z", 710 "transferDate" : "1990-12-31T23:59:60Z", 711 "entities" : 712 [ 713 { 714 "handle" : "XXXX", 715 "names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], 716 "status" : [ "validated", "locked" ], 717 "postalAddress" : 719 [ 720 "123 Maple Ave", 721 "Suite 90001", 722 "Vancouver", 723 "BC", 724 "12393" 725 ], 726 "emails" : [ "joe@bob.com", "bob@joe.com" ], 727 "phones" : 728 { 729 "office" : [ "999-999-999-99", "111-111-111-11" ], 730 "fax" : [ "222-222-222-22" ], 731 "mobile" : [ "333-333-333-33" ] 732 }, 733 "remarks" : 734 [ 735 "she sells seas shells", 736 "down by the seashore" 737 ], 738 "uris" : 739 [ 740 { 741 "type" : "source", 742 "uri" : "http://whois-rws.net/entity/xxxx" 743 }, 744 { 745 "type" : "held", 746 "uri" : "http://example.net/location/xxxx" 747 } 748 ], 749 "registrationDate" : "1990-12-31T23:59:60Z", 750 "registrationBy" : "ABC123", 751 "lastChangedDate" : "1990-12-31T23:59:60Z", 752 "lastChangedBy" : "ABC123", 753 "sponsoredBy" : "SponsorXYZ", 754 "resoldBy" : "ResellerPDQ" 755 } 756 ] 757 } 759 7. The IP Network Object Class 761 The IP Network object class models IP network registrations found in 762 RIRs and is the expected response for the /ip query as defined by 763 [I-D.ietf-weirds-rdap-query]. There is no equivalent object class 764 for DNRs. The high level structure of the IP network object class 765 consists of information about the network registration and entities 766 related to the IP network (e.g. registrant information, contacts, 767 etc...). 769 The following is an elided example of the IP network object type 770 showing the high level structure. 772 { 773 "handle" : "XXX", 774 ... 775 "entities" : 776 [ 777 ... 778 ] 779 } 781 The following is an example of the JSON object for the network 782 registration information 784 { 785 "handle" : "XXXX-RIR", 786 "startAddress" : "10.0.0.0", 787 "endAddress" : "10.0.0.255", 788 "ipVersion" : 4, 789 "name": "NET-RTR-1", 790 "description" : [ "A network used for routing" ], 791 "type" : "DIRECT ALLOCATION", 792 "country" : "AU", 793 "parentHandle" : "YYYY-RIR", 794 "remarks" : 795 [ 796 "she sells seas shells", 797 "down by the seashore" 798 ], 799 "uris" : 800 [ 801 { 802 "type" : "source", 803 "uri" : "http://whois-rws.net/network/xxxx" 805 }, 806 { 807 "type" : "parent", 808 "uri" : "http://whois-rws.net/network/yyyy" 809 }, 810 ], 811 "registrationDate" : "20110509", 812 "lastChangedDate" : "20110509", 813 "lastChangedBy" : "joe@bob.com", 814 "entities" : 815 [ 816 { 817 "handle" : "XXXX", 818 "names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], 819 "roles" : [ "registrant" ], 820 "postalAddress" : 821 [ 822 "123 Maple Ave", 823 "Suite 90001", 824 "Vancouver", 825 "BC", 826 "12393" 827 ], 828 "emails" : [ "joe@bob.com", "bob@joe.com" ], 829 "phones" : 830 { 831 "office" : [ "999-999-999-99", "111-111-111-11" ], 832 "fax" : [ "222-222-222-22" ], 833 "mobile" : [ "333-333-333-33" ] 834 }, 835 "remarks" : 836 [ 837 "she sells seas shells", 838 "down by the seashore" 839 ], 840 "uris" : 841 [ 842 { 843 "type" : "source", 844 "uri" : "http://whois-rws.net/contact/xxxx" 845 }, 846 { 847 "type" : "held", 848 "uri" : "http://example.net/location/xxxx" 849 } 850 ], 851 "registrationDate" : "1990-12-31T23:59:60Z", 852 "lastChangedDate" : "1990-12-31T23:59:60Z", 853 "lastChangedBy" : "joe@bob.com" 854 } 855 ] 856 } 858 The following is a description of the members of this object: 860 o handle -- a string representing an RIR unique identifier of the 861 network registration 863 o startAddress -- the starting IP address of the network, either 864 IPv4 or IPv6 866 o endAddress -- the ending IP address of the network, either IPv4 or 867 IPv6 869 o ipVersion -- an integer signifying the IP protocol version of the 870 network: 4 signifying an IPv4 network, 6 signifing an IPv6 network 872 o name -- an identifier assigned to the network registration by the 873 registration holder 875 o description -- an array of strings containing descriptive text 876 about the network registration 878 o type -- a string containing an RIR specific classification of the 879 network 881 o country -- a string containing the name of the 2 character country 882 code of the network 884 o parentHandle -- a string containing an RIR unique identifier of 885 the parent network of this network registration 887 o entities -- an array of entity objects as defined by Section 4.1. 889 The members "remarks", "uris", "registrationDate", "lastChangedDate", 890 and "lastChangedBy" take the same form of the members of the same 891 name of the entity object (Section 4.1). 893 8. Autonomous System Number Entity Object Class 895 The Autonomous System Number (autnum) object class models Autonomous 896 System Number registrations found in RIRs and represents the expected 897 response to an /autnum query as defined by 898 [I-D.ietf-weirds-rdap-query]. There is no equivalent object class 899 for DNRs. The high level structure of the autnum object class 900 consists of information about the network registration and entities 901 related to the autnum registration (e.g. registrant information, 902 contacts, etc...), and is similar to the IP Network entity object 903 class. 905 The following is an example of a JSON object representing an autnum. 907 { 908 "handle" : "XXXX-RIR", 909 "startAutnum" : "10", 910 "endAutnum" : "15", 911 "name": "AS-RTR-1", 912 "description" : [ "AS for Exchange" ], 913 "type" : "DIRECT ALLOCATION", 914 "country": "AU", 915 "remarks" : 916 [ 917 "she sells seas shells", 918 "down by the seashore" 919 ], 920 "uris" : 921 [ 922 { 923 "type" : "source", 924 "uri" : "http://whois-rws.net/autnum/xxxx" 925 }, 926 { 927 "type" : "parent", 928 "uri" : "http://whois-rws.net/autnum/yyyy" 929 }, 930 { 931 "type" : "held", 932 "uri" : "http://example.net/location/xxxx" 933 } 934 ], 935 "registrationDate" : "20110509", 936 "lastChangedDate" : "20110509", 937 "lastChangedBy" : "joe@bob.com", 938 "entities" : 939 [ 940 { 941 "handle" : "XXXX", 942 "names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], 943 "roles" : [ "registrant" ], 944 "postalAddress" : 945 [ 946 "123 Maple Ave", 947 "Suite 90001", 948 "Vancouver", 949 "BC", 950 "12393" 951 ], 952 "emails" : [ "joe@bob.com", "bob@joe.com" ], 953 "phones" : 954 { 955 "office" : [ "999-999-999-99", "111-111-111-11" ], 956 "fax" : [ "222-222-222-22" ], 957 "mobile" : [ "333-333-333-33" ] 958 }, 959 "remarks" : 960 [ 961 "she sells seas shells", 962 "down by the seashore" 963 ], 964 "uris" : 965 [ 966 { 967 "type" : "source", 968 "uri" : "http://whois-rws.net/autnum/xxxx" 969 } 970 ], 971 "registrationDate" : "1990-12-31T23:59:60Z", 972 "lastChangedDate" : "1990-12-31T23:59:60Z", 973 "lastChangedBy" : "joe@bob.com" 974 } 975 ] 976 } 978 The following is a description of the members of this object: 980 o handle -- a string representing an RIR unique identifier of the 981 autnum registration 983 o startAutnum -- the starting number [RFC5396] in the block of 984 autonomous system numbers 986 o endAutnum -- the ending number [RFC5396] in the block of 987 autonomous system numbers 989 o name -- an identifier assigned to the autnum registration by the 990 registration holder 992 o description -- an array of strings containing descriptive text 993 about the autnum registration 995 o type -- a string containing an RIR specific classification of the 996 autnum 998 o country -- a string containing the name of the 2 character country 999 code of the autnum 1001 The members "remarks", "uris", "registrationDate", "lastChangedDate", 1002 and "lastChangedBy" take the same form of the members of the same 1003 name of the entity object (Section 4.1). 1005 9. Contributing Authors and Acknowledgements 1007 This document is derived from original work on RIR response in JSON 1008 by Byron J. Ellacott of APNIC, Arturo L. Servin of LACNIC, Kaveh 1009 Ranjbar of the RIPE NCC, and Andrew L. Newton of ARIN. Additionally, 1010 this document incorporates word on DNR responses in JSON by Ning 1011 Kong, Linlin Zhou, Jiagui Xie, and Sean Shen of CNNIC. 1013 The components of the DNR object classes are derived from a 1014 categorization of WHOIS response formats created by Ning Kong, Linlin 1015 Zhou, and Guangqing Deng of CNNIC, Steve Sheng and Francisco Arias of 1016 ICANN, Ray Bellis of Nominet, and Frederico Neves of NIC.BR. 1018 10. References 1020 10.1. Normative References 1022 [RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791, 1023 September 1981. 1025 [RFC1166] Kirkpatrick, S., Stahl, M., and M. Recker, "Internet 1026 numbers", RFC 1166, July 1990. 1028 [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., 1029 Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext 1030 Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. 1032 [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the 1033 Internet: Timestamps", RFC 3339, July 2002. 1035 [RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform 1036 Resource Identifier (URI): Generic Syntax", STD 66, 1037 RFC 3986, January 2005. 1039 [RFC4034] Arends, R., Austein, R., Larson, M., Massey, D., and S. 1040 Rose, "Resource Records for the DNS Security Extensions", 1041 RFC 4034, March 2005. 1043 [RFC4343] Eastlake, D., "Domain Name System (DNS) Case Insensitivity 1044 Clarification", RFC 4343, January 2006. 1046 [RFC4627] Crockford, D., "The application/json Media Type for 1047 JavaScript Object Notation (JSON)", RFC 4627, July 2006. 1049 [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322, 1050 October 2008. 1052 [RFC5396] Huston, G. and G. Michaelson, "Textual Representation of 1053 Autonomous System (AS) Numbers", RFC 5396, December 2008. 1055 [RFC5952] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6 1056 Address Text Representation", RFC 5952, August 2010. 1058 [ISO.3166.1988] 1059 International Organization for Standardization, "Codes for 1060 the representation of names of countries, 3rd edition", 1061 ISO Standard 3166, August 1988. 1063 [I-D.ietf-weirds-rdap-query] 1064 Newton, A. and S. Hollenbeck, "RDAP Query Format", 1065 draft-ietf-weirds-rdap-query-00 (work in progress), 1066 September 2011. 1068 [I-D.ietf-weirds-using-http] 1069 Newton, A., Ellacott, B., and N. Kong, "Using HTTP for 1070 RESTful Whois Services by Internet Registries", 1071 draft-ietf-weirds-using-http-01 (work in progress), 1072 May 2012. 1074 10.2. Informative References 1076 [RFC3912] Daigle, L., "WHOIS Protocol Specification", RFC 3912, 1077 September 2004. 1079 Appendix A. Suggested Values 1081 Due to the wide variation between the hundreds of registry operators 1082 and the on-going policy refinement by registry communities, values of 1083 some data cannot be formally standardized. This section lists 1084 suggested values for such data but is not nor will ever be a complete 1085 list of values and their meanings. 1087 A.1. Status 1089 Many of the object classes have a member named 'status'. This member 1090 is an array of strings, with each string denoting a status associated 1091 with the containing object. The following is a list of suggested 1092 values to use in the 'status' array: 1094 o 'validated' -- Signifies that the data of the object instance has 1095 been found to be accurate. This type of status is usually found 1096 on entity object instances to note the validity of identifying 1097 contact information. 1099 o 'update prohibited' -- Updates to the object instance are 1100 forbidden. 1102 o 'transfer prohibited' -- Transfers of the registration from one 1103 registrar to another are forbidden. This type of status normally 1104 applies to DNR domain names. 1106 o 'delete prohibited' -- Deletion of the registration of the object 1107 instance is forbidden. This type of status normally applies to 1108 DNR domain names. 1110 A.2. Roles 1112 Entity object classes have a member named 'roles'. This member is an 1113 array of strings, with each string indicating the role or 1114 relationship the entity object instance has with a containing object, 1115 such as a domain name or IP network. An entity object instance can 1116 have more than one type of relationship with a containing object. 1117 The following is a list of suggested values to use in the 'roles' 1118 array: 1120 o 'registrant' -- The entity object instance is the registrant of 1121 the registration. 1123 o 'tech' -- The entity object instance is a technical contact for 1124 the registration. 1126 o 'admin' -- The entity object instance is an administrative contact 1127 for the registraton. 1129 o 'abuse' -- The entity object instance handles network abuse issues 1130 on behalf of the registrant of the registration. 1132 o 'billing' -- The entity object instance handles payment and 1133 billing issues on behalf of the registrant of the registration. 1135 o 'registrar' -- The entity object instance represents the authority 1136 responsible for the registration in the registry. 1138 A.3. URI Types 1140 Many of the object classes have a member named 'uris', which is an 1141 array of objects with each object containing a 'type' string and a 1142 'uri' string. These URIs represent a location to find information 1143 about the containing object. The following is a list of suggested 1144 values to use as a 'type' string for an associated URI. 1146 o 'self' -- Indicates the URI is a direct reference to the object 1147 instance via an RDAP query. 1149 o 'parent' -- Indicates a direct reference to an object instance's 1150 parent via an RDAP query. Such a reference might be used in an IP 1151 network to reference the next IP network up the tree of IP address 1152 hierarchies. 1154 o 'source' -- Signifies a direct reference to the registration in 1155 another RESTful protocol. As an example, both ARIN and the RIPE 1156 NCC have RESTful web services for WHOIS data that pre-exists RDAP. 1157 This type of URI would be used to reference the same data in such 1158 a system. 1160 o 'web' -- Signifies the web site of the containing object instance. 1161 The expectation is that a web browser would be needed to use this 1162 URI. 1164 o 'rdap' -- Signifies the RDAP service where RDAP queries can be 1165 issued. 1167 o 'held' -- Signifies a HELD location service for the registered 1168 object. 1170 o 'geo' -- Signifies that the URI is a geo URI related to the 1171 location of the registration. 1173 Appendix B. Suggested Data Modeling with the Entity Object Class 1175 B.1. Registrants and Contacts 1177 This document does not provide specific object classes for 1178 registrants and contacts. Instead the entity object class may be 1179 used to represent a registrant or contact. When the entity object is 1180 embedded inside a containing object such as a domain name or IP 1181 network, the 'roles' string array can be used to signify the 1182 relationship. It is recommended that the values from Appendix A.2 be 1183 used. 1185 The following is an example of an elided containing object with an 1186 embedded entity that is both a registrant and admin contact: 1188 { 1189 ... 1190 "entities" : 1191 [ 1192 { 1193 "handle" : "XXXX", 1194 "names": [ "Joe Bob, Inc.", "Bobby Joe Shopping" ], 1195 "roles" : [ "registrant", "admin" ], 1196 "postalAddress" : 1197 [ 1198 "123 Maple Ave", 1199 "Suite 90001", 1200 "Vancouver", 1201 "BC", 1202 "12393" 1203 ], 1204 "emails" : [ "joe@bob.com", "bob@joe.com" ], 1205 "phones" : 1206 { 1207 "office" : [ "999-999-999-99", "111-111-111-11" ], 1208 "fax" : [ "222-222-222-22" ], 1209 "mobile" : [ "333-333-333-33" ] 1210 }, 1211 "remarks" : 1212 [ 1213 "she sells seas shells", 1214 "down by the seashore" 1215 ], 1216 "registrationDate" : "1990-12-31T23:59:60Z", 1217 "lastChangedDate" : "1990-12-31T23:59:60Z", 1218 "lastChangedBy" : "joe@bob.com" 1219 } 1221 ] 1222 } 1224 B.2. Registrars 1226 This document does not provide a specific object class for 1227 registrars, but like registrants and contacts (see Appendix B.1) the 1228 'roles' string array maybe used. Additionally, a URI type can 1229 signify the registrars point of service (see Appendix A.3). 1231 The following is an example of an elided containing object with an 1232 embedded entity that is a registrar: 1234 { 1235 ... 1236 "entities" : 1237 [ 1238 { 1239 "handle" : "XXXX", 1240 "names": [ "RegistrarsRUS" ], 1241 "roles" : [ "registrar" ], 1242 "postalAddress" : 1243 [ 1244 "1212 Tulip Ave", 1245 "Suite 1", 1246 "Marina Del Rey", 1247 "CA", 1248 "12393-2193" 1249 ], 1250 "emails" : [ "joe@bob.com", "bob@joe.com" ], 1251 "phones" : 1252 { 1253 "office" : [ "999-999-999-99", "111-111-111-11" ], 1254 "fax" : [ "222-222-222-22" ], 1255 "mobile" : [ "333-333-333-33" ] 1256 }, 1257 "remarks" : 1258 [ 1259 "we registrar for less!" 1260 ], 1261 "uris" : 1262 [ 1263 { 1264 "type" : "rdap", 1265 "uri" : "http://rdap.exmaple.com" 1266 }, 1267 { 1268 "type" : "web", 1269 "uri" : "http://www.example.com" 1270 } 1271 ] 1272 } 1273 ] 1274 } 1276 Appendix C. IDN Query and Response Model 1278 Internationalized Domain Names (IDNs) differ from other types of 1279 domain names because multiple domain names as would be represented by 1280 a name in Master File format (see [RFC4343]) may be registered by a 1281 single IDN. IDNs are based on Unicode, and Unicode can have multiple 1282 means for encoding the same word depending on the character set and 1283 language being used. And the rules for determining which IDN 1284 encoding maps to a "wire-format" domain name vary from DNR to DNR. 1286 When an IDN maps to multiple domain names, the various mappings are 1287 called variants. The DNR Domain object class (Section 6.2) 1288 represents the variants using a string array. 1290 The following is an example of an elided DNR domain object with 1291 variants. 1293 { 1294 "handle" : "XXXX", 1295 "name" : "blah.example.com", 1296 "variants" : [ "blah2.example.com", "blah3.example.com" ], 1297 ... 1298 } 1300 Because IDNs can have multiple targets in a mapping and due to the 1301 variance in DNR mapping rules, it is up to the client to reduce an 1302 IDN to a domain name in Master File format so as to narrow the lookup 1303 of the domain name to the proper subset. A query of a DNR using the 1304 IDN itself might map across multiple registrations depending on the 1305 mapping rules of the DNR. 1307 Appendix D. Postal Addresses vs Location 1309 The postal address data listed in the entity object class (Section 4) 1310 does not necessarily represent location. The intent of this 1311 information is to provide a means to send postal mail to an entity. 1312 While in some cases it may also be the location of the entity, there 1313 is no gaurantee that the two are the same. Accurate representation 1314 of location is topic unto itself, and registries wishing to show 1315 location of object instances should use the 'geo' or 'held' URI types 1316 as meantioned in Appendix A.3. 1318 Additionally, the postal address data represented in this document 1319 does not follow any specific standard for postal addresses because 1320 many registries do not keep postal address data in an 1321 internationalized standard form. Publication of such data in a 1322 format that suggests an internationalized standard form when such 1323 data is not known to be well-formed for that purpose would be 1324 misleading. 1326 Appendix E. Changelog 1328 Initial -00 Adopted as working group document 2012-September-18. 1330 Authors' Addresses 1332 Andrew Lee Newton 1333 American Registry for Internet Numbers 1334 3635 Concorde Parkway 1335 Chantilly, VA 20151 1336 US 1338 Email: andy@arin.net 1339 URI: http://www.arin.net 1341 Scott Hollenbeck 1342 Verisign Labs 1343 12061 Bluemont Way 1344 Reston, VA 20190 1345 US 1347 Email: shollenbeck@verisign.com 1348 URI: http://www.verisignlabs.com/