idnits 2.17.1 draft-lozano-icann-registry-interfaces-08.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 : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (March 22, 2018) is 2227 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Missing Reference: '1-9' is mentioned on line 1223, but not defined -- Looks like a reference, but probably isn't: '012' on line 1223 -- Looks like a reference, but probably isn't: '12' on line 1223 == Missing Reference: '0-9' is mentioned on line 1223, but not defined -- Looks like a reference, but probably isn't: '01' on line 1223 == Unused Reference: 'RFC3688' is defined on line 1449, but no explicit reference was found in the text == Unused Reference: 'RFC5891' is defined on line 1460, but no explicit reference was found in the text == Outdated reference: A later version (-10) exists of draft-arias-noguchi-dnrd-objects-mapping-06 Summary: 0 errors (**), 0 flaws (~~), 6 warnings (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force G. Lozano 3 Internet-Draft E. Alvarez 4 Intended status: Informational ICANN 5 Expires: September 23, 2018 March 22, 2018 7 ICANN Registry Interfaces 8 draft-lozano-icann-registry-interfaces-08 10 Abstract 12 This document describes the technical details of the interfaces 13 provided by the Internet Corporation for Assigned Names and Numbers 14 (ICANN) to its contracted parties in order to fulfill reporting 15 requirements. The interfaces provided by ICANN to Data Escrow Agents 16 and Registry Operators to fulfill the requirements of Specifications 17 2 and 3 of the gTLD Base Registry Agreement are also described in 18 this document. 20 Status of This Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at https://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on September 23, 2018. 37 Copyright Notice 39 Copyright (c) 2018 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents 44 (https://trustee.ietf.org/license-info) in effect on the date of 45 publication of this document. Please review these documents 46 carefully, as they describe your rights and restrictions with respect 47 to this document. Code Components extracted from this document must 48 include Simplified BSD License text as described in Section 4.e of 49 the Trust Legal Provisions and are provided without warranty as 50 described in the Simplified BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 55 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 56 1.2. Date and Time . . . . . . . . . . . . . . . . . . . . . . 3 57 1.3. Object Description . . . . . . . . . . . . . . . . . . . 3 58 2. Interfaces for Specification 2 - Data Escrow Reporting . . . 9 59 2.1. Registry Operator Reporting . . . . . . . . . . . . . . . 9 60 2.2. Data Escrow Agent Reporting . . . . . . . . . . . . . . . 11 61 3. Interfaces of Specification 3 - Registry Operator Monthly 62 Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . 12 63 3.1. Per-Registrar Transactions Report . . . . . . . . . . . . 13 64 3.2. Registry Functions Activity Report . . . . . . . . . . . 13 65 4. Technical details of the interfaces . . . . . . . . . . . . . 14 66 4.1. Response Object . . . . . . . . . . . . . . . . . . . . . 15 67 5. Monitoring the reporting status . . . . . . . . . . . . . . . 20 68 5.1. Monitoring the status of Data Escrow Reports . . . . . . 20 69 5.2. Monitoring the status of Data Escrow Notifications . . . 20 70 5.3. Monitoring the status of Registry Functions Activity 71 Report . . . . . . . . . . . . . . . . . . . . . . . . . 21 72 5.4. Monitoring the status of the Per-Registrar Transactions 73 Report . . . . . . . . . . . . . . . . . . . . . . . . . 21 74 6. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 23 75 6.1. IIRDEA Result Schema . . . . . . . . . . . . . . . . . . 23 76 6.2. Report Object . . . . . . . . . . . . . . . . . . . . . . 24 77 6.3. Notification Object . . . . . . . . . . . . . . . . . . . 25 78 6.4. RRI Reporting Summary Object . . . . . . . . . . . . . . 27 79 6.5. Notifications Object . . . . . . . . . . . . . . . . . . 29 80 6.6. Reports Object . . . . . . . . . . . . . . . . . . . . . 30 81 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 31 82 8. Change History . . . . . . . . . . . . . . . . . . . . . . . 31 83 8.1. Version 00 . . . . . . . . . . . . . . . . . . . . . . . 31 84 8.2. Version 01 . . . . . . . . . . . . . . . . . . . . . . . 31 85 8.3. Version 02 . . . . . . . . . . . . . . . . . . . . . . . 32 86 8.4. Version 03 . . . . . . . . . . . . . . . . . . . . . . . 32 87 8.5. Version 04 . . . . . . . . . . . . . . . . . . . . . . . 32 88 8.6. Version 05 . . . . . . . . . . . . . . . . . . . . . . . 32 89 8.7. Version 06 . . . . . . . . . . . . . . . . . . . . . . . 33 90 8.8. Version 07 . . . . . . . . . . . . . . . . . . . . . . . 33 91 8.9. Version 08 . . . . . . . . . . . . . . . . . . . . . . . 33 92 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 33 93 10. Security Considerations . . . . . . . . . . . . . . . . . . . 33 94 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 34 95 11.1. Normative References . . . . . . . . . . . . . . . . . . 34 96 11.2. Informative References . . . . . . . . . . . . . . . . . 34 98 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 34 100 1. Introduction 102 This document describes the technical details of the interfaces 103 provided by the Internet Corporation for Assigned Names and Numbers 104 (ICANN) to other contracted parties in order to fulfill reporting 105 requirements. The interface provided by ICANN to Registry Operators 106 and Data Escrow Agents in order to fulfill the requirements of 107 Specifications 2 and 3 of the gTLD Base Registry Agreement 108 [ICANN-GTLD-BASE-RA] are also described in this document. 110 1.1. Terminology 112 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 113 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 114 document are to be interpreted as described in RFC 2119 [RFC2119]. 116 XML is case sensitive. Unless stated otherwise, XML specifications 117 and examples provided in this document MUST be interpreted in the 118 character case presented in order to develop a conforming 119 implementation. 121 1.2. Date and Time 123 Numerous fields indicate "date and time", such as the creation and 124 receipt dates for data escrow deposits. These fields SHALL contain 125 timestamps indicating the date and time in UTC as specified in 126 [RFC3339], with no offset from the zero meridian. 128 1.3. Object Description 130 This section describes the base objects supported by this 131 specification. 133 1.3.1. object 135 The ICANN interfaces for registries and data escrow agents (IIRDEA) 136 object is used to provide information on the result 137 of a verification process when interacting with the interfaces. 139 The object contains the following attribute and child 140 elements: 142 o A "code" attribute whose value is a four-digit decimal number that 143 identifies the result of a process. Available result code values 144 MUST be defined for the corresponding process. 146 o An OPTIONAL "domainCount" attribute to indicate the number of 147 domain names related to the reported result. 149 o A element containing a human-readable description of the 150 result code. 152 o An OPTIONAL element that includes additional details 153 on the result conditions. 155 An example of a object is presented below: 157 158 The structure of the report is invalid. 159 160 'XX' could not be parsed as a number (line: 2 column:3) 161 162 164 1.3.2. object 166 The contents of a data escrow deposit are described using a 167 object. The object contains 168 the following child elements: 170 o An element that contains the identifier assigned to this 171 report. The report identifier MUST be the same as the "id" 172 attribute from the . If the data escrow deposit does not 173 include a unique identifer, the Data Escrow Agent MUST generate a 174 unique identifier to reference the data escrow deposit and use it 175 in the element. 177 o A element contains the version of the specification 178 used. This value MUST be 1. 180 o A element contains the version of the Data Escrow 181 Specification (e.g. draft-arias-noguchi-registry-data-escrow-06) 182 used to create the deposit. After the specification is published 183 as an RFC, the value MUST be the RFC number assigned by IANA. 185 o An OPTIONAL element contains the version of the 186 Domain Name Registration Data (DNRD) Objects Mapping (e.g. draft- 187 arias-noguchi-dnrd-objects-mapping-05) used to create the deposit. 188 After the specification is published as an RFC, the value MUST be 189 the RFC number assigned by IANA. The element 190 MUST be included if the deposit was created using any version of 191 the DNRD objects mapping specification (see, 192 [I-D.arias-noguchi-dnrd-objects-mapping]). 194 o A element contains the value of the "resend" attribute of 195 the . 197 o A element contains the date and time that the deposit was 198 created by the Registry Operator. 200 o A element is used to identify the kind of deposit: FULL, 201 INCR (Incremental) or DIFF (Differential). 203 o A element contains the date and time corresponding to 204 the Timeline Watermark ( element) of the . 206 o A element contains the header of the 207 as defined in [I-D.arias-noguchi-dnrd-objects-mapping] 209 An example of a object is available in 210 Section 2.1. 212 1.3.3. object 214 The object is used by Data Escrow 215 Agents to document the result of the data escrow deposit verification 216 process. The object contains the 217 following child elements: 219 o A element contains the name of the Data Escrow Agent. 221 o A element contains the version of the specification 222 used. This value MUST be 1. 224 o A element contains the reported date. In case of a DVPN 225 or DVFN notification this value MUST be the date of the 226 element of the . In case of a DRFN deposit 227 notification, this value MUST be the date for which no deposit was 228 received from the Registrar or Registry Operator. 230 o A element is used to specify the status of . 231 The possible values of status are: DVPN, DVFN and DRFN. The value 232 for the element is determined by the three types of 233 notices: 235 * Deposit Receipt Failure Notice (DRFN): generated by the Data 236 Escrow Agent when no deposit is received pursuant to the data 237 escrow deposit schedule. 239 * Deposit Verification Failure Notice (DVFN): generated by the 240 Data Escrow Agent when a deposit is received, but the final 241 result of the verification process is failure. 243 * Deposit Verification Pass Notice (DVPN): generated by the Data 244 Escrow Agent when a deposit is received and the final result of 245 the verification process is success. 247 o An OPTIONAL element contains the errors detected during 248 the data escrow deposit verification process performed by the Data 249 Escrow Agent. The element includes one or more 250 elements as defined in Section 1.3.1. In case of 251 a DRFN or DVPN deposit notification the element MUST NOT 252 be present. 254 o An OPTIONAL element contains the date and time that the 255 deposit was successful received by the Data Escrow Agent. In case 256 of a DRFN deposit notification this element MUST NOT be present. 258 o An OPTIONAL element contains the date and time that the 259 deposit was successfully validated by the Data Escrow Agent. In 260 case of a DRFN deposit notification this element MUST NOT be 261 present. 263 o An OPTIONAL element contains the date of the 264 Timeline Watermark ( element) of the most recent FULL 265 deposit that was successfully validated by the Data Escrow Agent. 266 This element MUST NOT be present if a successfully validated full 267 deposit has never been deposited. 269 o An OPTIONAL element is used by the Data Escrow 270 Agent to provide extended information about the deposit. In case 271 of a DRFN deposit notification this element MUST NOT be present. 272 In case of a DVPN or DVFN deposit notification this element MUST 273 be present. When this element is present, the 274 element MUST be generated by the Data Escrow Agent for the 275 Timeline Watermark ( element) of the deposit being 276 processed. If the deposit being processed is a differential or 277 incremental deposit, the Data Escrow Agent MUST process the last 278 full plus all differentials or last full plus last incremental 279 escrow deposits from the same repository (e.g. TLD) to generate 280 the element. 282 o Note: In case of a DPVN or DVFN deposit notification, the is 283 used as unique identifier. 285 An example of a object is available in 286 Section 2.2. 288 1.3.4. Object 290 Interfaces that support monitoring the reporting status for a 291 specific repository, provide a object as 292 defined by the schema in Section 6 in the HTTP Entity-body when a 293 HTTP/200 code is sent by the interface. 295 The element includes the following child 296 elements: 298 o A choice of one of the elements as defined in the 299 "rdeHeader:repositoryTypeGroup" (see 300 [I-D.arias-noguchi-dnrd-objects-mapping]) that indicates the 301 unique identifier for the repository being escrowed. 303 o A element with the date and time in which the 304 queried repository was created in the system. 306 o A OPTIONAL element indicating the current Data 307 Escrow Deposit schedule for the queried repository. Possible 308 values are "None", "Weekly", and "Daily". 310 o A element indicating the date of the Timeline 311 Watermark ( element) of the most recent FULL deposit 312 that was successfully validated for the queried repository as 313 notified by the Data Escrow Agent. 315 o A element with a element for each 316 report type for the queried repository. Each 317 element includes the following child elements: 319 * : a string value indicating the report type to which the 320 information provided pertains. 322 * : a boolean value indicating if the report type is 323 enabled for the repository. 325 * : a string value indicating the reporting status. A 326 value of "ok" indicates there are no reporting issues in the 327 corresponding report type, otherwise the value of 328 "unsatisfactory" is shown. 330 * An OPTIONAL element included only when the 331 element has a value of "unsatisfactory", and includes an empty 332 element for each date with a reporting problem found in 333 the corresponding report type. Each element includes a 334 REQUIRED "date" attribute in "YYYY-MM-DD" format and a REQUIRED 335 "description" attribute to describe the issue. The possible 336 values to describe each reporting issue are: 338 + "Missing_Deposit_Full": If the latest notification received 339 from the Data Escrow Agent for the date indicates that a 340 scheduled "Full" deposit was not submitted by the repository 341 owner. 343 + "Missing_Deposit_Diff": If the latest notification received 344 from the Data Escrow Agent for the date indicates that a 345 scheduled "Differential" deposit was not submitted by the 346 repository owner. 348 + "Invalid_Deposit_Full": If the latest notification received 349 from the Data Escrow Agent for the date indicates that a 350 "Full" deposit was received by the Data Escrow Agent, but 351 failed the verification process. 353 + "Invalid_Deposit_Diff": If the latest notification received 354 from the Data Escrow Agent for the date indicates that a 355 "Differential" deposit was received by the Data Escrow 356 Agent, but failed the verification process. 358 + "No_Report_Received" If no report has been received for the 359 date. 361 o A element to indicate the date and time in which the 362 reporting status response was created. 364 1.3.5. Object 366 Interfaces that support monitoring and retrieving Data Escrow Reports 367 received, provide a object as defined by the 368 schema in Section 6 in the HTTP Entity-body when a HTTP/200 code is 369 sent by the interface. 371 The element includes a list of 372 objects, one for each 373 successfully received by ICANN. Each 374 object includes the following child elements: 376 o A element to indicate the date and time in which the 377 report was received by ICANN. 379 o A element as defined in Section 1.3.2 as 380 received by ICANN. 382 1.3.6. Object 384 Interfaces that support monitoring and retrieving Data Escrow 385 Notifications received from Data Escrow Agents, provide a 386 object as defined by the schema in 387 Section 6 in the HTTP Entity-body when a HTTP/200 code is sent by the 388 interface. 390 The element includes a list of 391 objects, one for each 392 successfully received by ICANN. Each 393 object includes the following 394 child elements: 396 o A element to indicate the date and time in which the 397 notification was received by ICANN. 399 o A element as defined in 400 Section 1.3.3 as received by ICANN. 402 2. Interfaces for Specification 2 - Data Escrow Reporting 404 This section describes the interfaces provided by ICANN to Registry 405 Operators and Data Escrow Agents in order to fulfill the reporting 406 requirements detailed in Specification 2 of the gTLD Base Registry 407 Agreement [ICANN-GTLD-BASE-RA]. 409 2.1. Registry Operator Reporting 411 The gTLD Base Registry Agreement [ICANN-GTLD-BASE-RA], Specification 412 2, Part A, Section 7 requires Registry Operators to provide ICANN 413 with a written statement that includes a copy of the report generated 414 upon creation of a deposit and a statement that the deposit has been 415 inspected by the Registry Operator and is complete and accurate. 417 In order to satisfy this requirement, the Registry Operator sends to 418 ICANN a object as defined in Section 1.3.2 for 419 each deposit successfully sent to the Data Escrow Agent, using the 420 PUT HTTP verb in the interface provided by ICANN at: 422 https://ry-api.icann.org/report/registry-escrow-report// 424 Where: 426 * MUST be substituted by the TLD for which the report is 427 being provided. In case of an IDN TLD, the A-label (see 428 [RFC5890]) MUST be used. 430 * MUST be substituted by the identifier assigned to this 431 report, which MUST be the same as the "id" attribute from the 432 . 434 Note: the interface supports overwriting the information of a 435 particular report to support asynchronous interfaces between 436 Registry Operators and Data Escrow Agents. 438 Example of a object for a data escrow deposit 439 corresponding to a TLD Registry repository: 441 442 445 20101017001 446 1 447 448 draft-arias-noguchi-registry-data-escrow-06 449 450 451 draft-arias-noguchi-dnrd-objects-mapping-05 452 453 0 454 2010-10-17T00:15:00.0Z 455 FULL 456 2010-10-17T00:00:00Z 457 458 test 459 2 461 1 463 1 465 1 467 468 1 470 1 472 1 474 475 476 478 2.2. Data Escrow Agent Reporting 480 The gTLD Base Registry Agreement [ICANN-GTLD-BASE-RA], Specification 481 2, Part B, Section 7 requires Data Escrow Agents, to deliver ICANN 482 with a notification object every time a successfully processed 483 deposit is received from the Registry Operator regardless of the 484 final status of the verification process. 486 In order to satisfy this requirement, the Data Escrow Agent sends to 487 ICANN a object as defined in 488 Section 1.3.3, using the POST HTTP verb in the interface provided by 489 ICANN at: 491 https://ry-api.icann.org/report/escrow-agent-notification/ 493 Where: 495 * MUST be substituted by the TLD for which the notification 496 is being provided. In case of an IDN TLD, the A-label (see 497 [RFC5890]) MUST be used. 499 If by 23:59:59 UTC, a deposit has not been successfully processed 500 regardless of the final status of the verification process, a 501 object with DRFN status MUST be send 502 to ICANN. 504 Example of a object of a Data Escrow 505 Agent notification corresponding to a Registry repository Data Escrow 506 Deposit: 508 509 513 Escrow Agent Inc. 514 1 515 2010-10-17 516 DVPN 517 518 2010-10-17T03:15:00.0Z 519 520 521 2010-10-17T05:15:00.0Z 522 523 524 2010-10-14 525 526 527 20101017001 528 1 529 530 draft-arias-noguchi-registry-data-escrow-06 531 532 533 draft-arias-noguchi-dnrd-objects-mapping-03 534 535 0 536 2010-10-17T00:15:00.0Z 537 FULL 538 2010-10-17T00:00:00Z 539 540 test 541 1 543 3 545 1 547 3 549 1 551 10 553 0 555 556 557 559 3. Interfaces of Specification 3 - Registry Operator Monthly Reporting 561 Specification 3 of the gTLD Base Registry Agreement 562 [ICANN-GTLD-BASE-RA] requires Registry Operators to provide a set of 563 monthly reports per gTLD. Two type of reports are required to be 564 sent by Registries: Per-Registrar Transactions Report and Registry 565 Functions Activity Report. This section specifies the interfaces 566 provided by ICANN to automate the upload of these reports by Registry 567 Operators. 569 The cut-off date for the reception of the reports specified in 570 specification 3 is defined in the gTLD Base Registry Agreement 571 [ICANN-GTLD-BASE-RA]. Before the cut-off date the Registry Operator 572 could replace a successfully validated report as many times as it 573 needs. 575 3.1. Per-Registrar Transactions Report 577 The Per-Registrar Transactions Report is a CSV report described in 578 Section 1 of Specification 3. 580 In order to satisfy this requirement, the Registry Operator sends a 581 CSV report on a monthly basis as described in the gTLD Base Registry 582 Agreement [ICANN-GTLD-BASE-RA], using the PUT HTTP verb in the 583 interface provided by ICANN at: 585 https://ry-api.icann.org/report/registrar- 586 transactions// 588 Where: 590 * MUST be substituted by the TLD for which the reports is 591 being provided. In case of an IDN TLD, the A-label (see 592 [RFC5890]) MUST be used. 594 * MUST be substituted by the month for which the reports 595 is being provided in the form of YYYY-MM. Where 'YYYY' is the 596 year and 'MM' is the two digit month number. For example: 597 2013-03 599 3.2. Registry Functions Activity Report 601 The Registry Functions Activity Report is a CSV report described in 602 Section 2 of Specification 3 of the gTLD Base Registry Agreement 603 [ICANN-GTLD-BASE-RA]. 605 In order to satisfy this requirement, the Registry Operator sends a 606 CSV report on a monthly basis as described in the gTLD Base Registry 607 Agreement [ICANN-GTLD-BASE-RA], using the PUT HTTP verb in the 608 interface provided by ICANN at: 610 https://ry-api.icann.org/report/registry-functions- 611 activity// 613 Where: 615 * MUST be substituted by the TLD for which the report is 616 being provided. In case of an IDN TLD, the A-label (see 617 [RFC5890]) MUST be used. 619 * MUST be substituted by the month for which the reports 620 is being provided in the form of YYYY-MM. Where 'YYYY' is the 621 year and 'MM' is the two digit month number. For example: 622 2013-03 624 4. Technical details of the interfaces 626 Content-type value in the HTTP header: 628 o The client MUST set "text/xml" in the HTTP header Content-type 629 when using the Data Escrow Agent Reporting and Registry Operator 630 Reporting interfaces described in Section 2. 632 o The client MUST set "text/csv" in the HTTP header Content-type 633 when using the Per-Registrar Transactions Report Registry 634 Functions Activity Report interfaces described in Section 3. 636 The interfaces support HTTP streams only (HTTP multi-part forms are 637 not supported). 639 After successfully receiving an input in any of the interfaces, ICANN 640 validates it and provides a object with an result element 641 in the same HTTP transaction. 643 The following HTTP status codes are standard across all interfaces: 645 o The interface provides a HTTP/200 status code and sets the HTTP 646 header Content-type: text/xml, if the interface was able to 647 receive the input sucessfully, the client MUST review the response 648 object to verify the result code after processing the input. 650 o The interface provides a HTTP/400 status code and sets the HTTP 651 header Content-type: text/xml, if the input is incorrect or the 652 syntax of the input is invalid. A response object is included 653 with the input validation failure details. 655 o The interface provides a HTTP/401 status code and sets the HTTP 656 header Content-type: text/plain, if the credentials provided does 657 not authorize the Registry Operator to upload a report for that 658 . 660 o The interface provides a HTTP/403 status code and sets the HTTP 661 header Content-type: text/plain, if the credentials provided are 662 valid but are being used to access a resource that permission is 663 not granted for or the connecting IP address is not whitelisted 664 for the . 666 o The interface provides a HTTP/405 status code if the interface 667 does not support the request method. 669 o The interface provides a HTTP/500 status code and sets the HTTP 670 header Content-type: text/plain, if the system is experiencing a 671 general failure. The sending party is responsible to send the 672 input again. 674 o The interface provides a HTTP/501 status code and sets the HTTP 675 header Content-type: text/plain, if the functionality has not yet 676 been implemented. 678 After sending the response, the interfaces closes the TCP connection. 680 4.1. Response Object 682 After processing the input provided in any of the interfaces, a 683 response object as defined by the schema in Section 6 is provided in 684 the HTTP Entity-body when an HTTP/200 or HTTP/400 status code is sent 685 by the interface. 687 An example of a response object is presented below: 689 690 691 692 The structure of the report is invalid. 693 694 'XX' could not be parsed as a number (line: 2 column:3) 695 696 697 699 The following sections provide the IIRDEA Result Codes per interface: 701 4.1.1. Registry Operator Reporting 703 The following table lists the result codes of the interface: 705 +--------+----------------------------------------------------------+ 706 | Result | Message | 707 | Code | | 708 +--------+----------------------------------------------------------+ 709 | 1000 | No ERRORs were found and the report has been accepted by | 710 | | ICANN. | 711 | 2001 | The report did not validate against the schema. | 712 | 2004 | Report for a date in the future. The and | 713 | | date should not be in the future. | 714 | 2005 | Version is not supported. | 715 | 2006 | The in the element and the in the URL | 716 | | path do not match. | 717 | 2007 | Interface is disabled for this TLD. | 718 | 2008 | The and date should not be before | 719 | | the creation date of the TLD in the system. | 720 | 2202 | The in the
and the TLD in the URL path do | 721 | | not match. | 722 | 2205 | Report regarding a differential deposit received for a | 723 | | Sunday (). | 724 | 2206 | csvDomain and rdeDomain count provided in the
. | 725 | 2209 | Missing required element in the
. | 726 | 2210 | The value of the "rcdn" attribute in the element | 727 | | does not match the same or lower level names in the | 728 | | in the URL path. | 729 | 2211 | Multiple count elements with the same "uri", "rcdn", and | 730 | | "registrarId" attribute values provided in the
. | 731 | 2212 | An invalid NR-LDH label or A-label was found or the | 732 | | domain name syntax is invalid in the "rcdn" attribute. | 733 +--------+----------------------------------------------------------+ 735 Data Escrow Reporting Result Codes 737 4.1.2. Data Escrow Agent Reporting 739 The following table lists the result codes of the interface: 741 +--------+----------------------------------------------------------+ 742 | Result | Message | 743 | Code | | 744 +--------+----------------------------------------------------------+ 745 | 1000 | No ERRORs were found and the notification has been | 746 | | accepted by ICANN. | 747 | 2001 | The notification did not validate against the schema. | 748 | 2002 | A DVPN notification exists for that date (). | 749 | 2004 | Notification for a date in the future. The and | 750 | | and date should not be in the | 751 | | future. | 752 | 2005 | Version is not supported. | 753 | 2007 | Interface is disabled for this TLD. | 754 | 2008 | The and and date should | 755 | | not be before the creation date of the TLD in the | 756 | | system. | 757 | 2201 | The and in the notification do not | 758 | | match. | 759 | 2202 | The in the
and the TLD in the URL path do | 760 | | not match. | 761 | 2203 | A Deposit Verification Pass Notice (DVPN) notification | 762 | | was received, but the Domain Name count is missing in | 763 | | the
. | 764 | 2204 | The notification for the report "id" already exists. | 765 | 2205 | Notification regarding a differential deposit received | 766 | | for a Sunday (). | 767 | 2206 | csvDomain and rdeDomain count provided in the
. | 768 | 2207 | A DVPN or DVFN was received, but the element is | 769 | | missing in the notification. | 770 | 2208 | A DRFN was received, but a element exists in | 771 | | the notification. | 772 | 2209 | Missing required element in the
. | 773 | 2210 | The value of the "rcdn" attribute in the element | 774 | | does not match the same or lower level names in the | 775 | | in the URL path. | 776 | 2211 | Multiple count elements with the same "uri", "rcdn", and | 777 | | "registrarId" attribute values provided in the
. | 778 | 2212 | An invalid NR-LDH label or A-label was found or the | 779 | | domain name syntax is invalid in the "rcdn" attribute. | 780 +--------+----------------------------------------------------------+ 782 Data Escrow Reporting Result Codes 784 4.1.3. Per-Registrar Transactions Report 786 The following table lists the result codes of the interface: 788 +----------+--------------------------------------------------------+ 789 | Result | Message | 790 | Code | | 791 +----------+--------------------------------------------------------+ 792 | 1000 | No ERRORs were found and the report has been accepted | 793 | | by ICANN. | 794 | 2001 | The structure of the report is invalid. | 795 | 2002 | A report for that month already exists, the cut-off | 796 | | date already passed. | 797 | 2003 | Negative numeric value present in the report. | 798 | 2004 | Report for a month in the future. | 799 | 2007 | Interface is disabled for this TLD. | 800 | 2008 | Reported month before the creation date of the TLD in | 801 | | the system. | 802 | 2101 | Incorrect totals present in the report. | 803 | 2102 | A non ICANN-accredited registrar is present in the | 804 | | report. | 805 | 2103 | Values found in the second field of the totals line. | 806 | 2105 | The report is not encoded in UTF-8. Note: reports | 807 | | encoded in US-ASCII are accepted. | 808 +----------+--------------------------------------------------------+ 810 Per-Registrar Transactions Report Result Codes 812 4.1.4. Registry Functions Activity Report 814 The following table lists the result codes of the interface: 816 +----------+--------------------------------------------------------+ 817 | Result | Message | 818 | Code | | 819 +----------+--------------------------------------------------------+ 820 | 1000 | No ERRORs were found and the report has been accepted | 821 | | by ICANN. | 822 | 2001 | The structure of the report is invalid. | 823 | 2002 | A report for that month already exists, the cut-off | 824 | | date already passed. | 825 | 2003 | Negative numeric value present in the report. | 826 | 2004 | Report for a month in the future. | 827 | 2007 | Interface is disabled for this TLD. | 828 | 2008 | Reported month before the creation date of the TLD in | 829 | | the system. | 830 | 2105 | The report is not encoded in UTF-8. Note: reports | 831 | | encoded in US-ASCII are accepted. | 832 +----------+--------------------------------------------------------+ 834 Registry Functions Activity Report Result Codes 836 5. Monitoring the reporting status 838 Registries MAY monitor the status of the reports described in 839 Specification 2 and Specification 3 of the gTLD Base Registry 840 Agreement [ICANN-GTLD-BASE-RA] using the following interfaces that 841 supports the HEAD HTTP verb: 843 5.1. Monitoring the status of Data Escrow Reports 845 Registries MAY monitor the status of Data Escrow Reports using the 846 following interface: 848 https://ry-api.icann.org/info/report/registry-escrow- 849 report// 851 Where: 853 * MUST be substituted by the TLD being queried. In case of 854 an IDN TLD, the A-label (see [RFC5890]) MUST be used. 856 * MUST be substituted by the day being queried. For 857 example: 2013-03-02 859 Possible results are: 861 * The interface provides a HTTP/200 status code, if a 862 syntactically valid data escrow report was received for the 863 queried date. 865 * The interface provides a HTTP/404 status code, if a 866 syntactically valid data escrow report has not been received 867 for the queried date. 869 5.2. Monitoring the status of Data Escrow Notifications 871 Registries and Data Escrow Agents MAY monitor the status of Data 872 Escrow Notifications using the following interface: 874 https://ry-api.icann.org/info/report/escrow-agent- 875 notification// 877 Where: 879 * MUST be substituted by the TLD being queried. In case of 880 an IDN TLD, the A-label (see [RFC5890]) MUST be used. 882 * MUST be substituted by the day being queried. For 883 example: 2013-03-02 885 Possible results are: 887 * The interface provides a HTTP/200 status code, if a 888 syntactically valid data escrow notification was received for 889 the queried date. 891 * The interface provides a HTTP/404 status code, if a 892 syntactically valid data escrow notification has not been 893 received for the queried date. 895 5.3. Monitoring the status of Registry Functions Activity Report 897 Registries MAY monitor the status of Registry Functions Activity 898 Report using the following interface: 900 https://ry-api.icann.org/info/report/registry-functions- 901 activity// 903 Where: 905 * MUST be substituted by the TLD being queried. In case of 906 an IDN TLD, the A-label (see [RFC5890]) MUST be used. 908 * MUST be substituted by the month being queried. For 909 example: 2013-03 911 Possible results are: 913 * The interface provides a HTTP/200 status code, if a 914 syntactically valid registry functions activity report was 915 received for the queried month. 917 * The interface provides a HTTP/404 status code, if a 918 syntactically valid registry functions activity report has not 919 been received for the queried month. 921 5.4. Monitoring the status of the Per-Registrar Transactions Report 923 Registries MAY monitor the status of Per-Registrar Transactions 924 Report using the following interface: 926 https://ry-api.icann.org/info/report/registrar- 927 transactions// 929 Where: 931 * MUST be substituted by the TLD being queried. In case of 932 an IDN TLD, the A-label (see [RFC5890]) MUST be used. 934 * MUST be substituted by the month being queried. For 935 example: 2013-03 937 Possible results are: 939 * The interface provides a HTTP/200 status code, if a 940 syntactically valid per-registrar transactions report was 941 received for the queried month. 943 * The interface provides a HTTP/404 status code, if a 944 syntactically valid per-registrar transactions report has not 945 been received for the queried month. 947 6. Formal Syntax 949 The schema of the IIRDEA Result, Report, Notification, RRI Reporting, 950 Notifications, and Reports objects described in Section 1.3 are 951 presented here. 953 The BEGIN and END tags are not part of the schema; they are used to 954 note the beginning and ending of the schema for URI registration 955 purposes. 957 6.1. IIRDEA Result Schema 959 Copyright (c) 2017 IETF Trust and the persons identified as authors 960 of the code. All rights reserved. 962 Redistribution and use in source and binary forms, with or without 963 modification, is permitted pursuant to, and subject to the license 964 terms contained in, the Simplified BSD License set forth in 965 Section 4.c of the IETF Trust's Legal Provisions Relating to IETF 966 Documents (http://trustee.ietf.org/license-info). 967 BEGIN 968 969 974 975 976 ICANN interfaces for registries and data escrow agents 977 978 980 981 983 984 985 986 987 989 990 991 992 994 995 997 998 1000 1001 1002 1003 1004 1005 1007 1008 END 1010 6.2. Report Object 1012 Copyright (c) 2017 IETF Trust and the persons identified as authors 1013 of the code. All rights reserved. 1015 Redistribution and use in source and binary forms, with or without 1016 modification, is permitted pursuant to, and subject to the license 1017 terms contained in, the Simplified BSD License set forth in 1018 Section 4.c of the IETF Trust's Legal Provisions Relating to IETF 1019 Documents (http://trustee.ietf.org/license-info). 1021 BEGIN 1022 1023 1030 1031 1033 1034 1035 Data Escrow Report schema 1036 1037 1039 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 END 1057 6.3. Notification Object 1059 Copyright (c) 2017 IETF Trust and the persons identified as authors 1060 of the code. All rights reserved. 1062 Redistribution and use in source and binary forms, with or without 1063 modification, is permitted pursuant to, and subject to the license 1064 terms contained in, the Simplified BSD License set forth in 1065 Section 4.c of the IETF Trust's Legal Provisions Relating to IETF 1066 Documents (http://trustee.ietf.org/license-info). 1068 BEGIN 1069 1070 1077 1078 1080 1081 1082 Data Escrow Notification schema 1083 1084 1086 1089 1090 1091 1092 1093 1094 1095 1097 1098 1099 1100 1101 1102 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1116 1117 1118 1119 1120 1121 1122 1123 1124 END 1126 6.4. RRI Reporting Summary Object 1128 Copyright (c) 2018 IETF Trust and the persons identified as authors 1129 of the code. All rights reserved. 1131 Redistribution and use in source and binary forms, with or without 1132 modification, is permitted pursuant to, and subject to the license 1133 terms contained in, the Simplified BSD License set forth in 1134 Section 4.c of the IETF Trust's Legal Provisions Relating to IETF 1135 Documents (http://trustee.ietf.org/license-info). 1137 BEGIN 1138 1139 1145 1147 1149 1150 1151 1152 1153 1155 1156 1159 1160 1161 1163 1164 1165 1166 1167 1168 1169 1171 1172 1173 1175 1176 1178 1179 1180 1181 1182 1183 1185 1186 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1200 1201 1202 1203 1204 1205 1206 1207 1208 1210 1211 1213 1214 1216 1218 1220 1221 1222 1224 1225 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 END 1239 6.5. Notifications Object 1241 Copyright (c) 2018 IETF Trust and the persons identified as authors 1242 of the code. All rights reserved. 1244 Redistribution and use in source and binary forms, with or without 1245 modification, is permitted pursuant to, and subject to the license 1246 terms contained in, the Simplified BSD License set forth in 1247 Section 4.c of the IETF Trust's Legal Provisions Relating to IETF 1248 Documents (http://trustee.ietf.org/license-info). 1249 BEGIN 1250 1251 1257 1259 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 END 1277 6.6. Reports Object 1279 Copyright (c) 2018 IETF Trust and the persons identified as authors 1280 of the code. All rights reserved. 1282 Redistribution and use in source and binary forms, with or without 1283 modification, is permitted pursuant to, and subject to the license 1284 terms contained in, the Simplified BSD License set forth in 1285 Section 4.c of the IETF Trust's Legal Provisions Relating to IETF 1286 Documents (http://trustee.ietf.org/license-info). 1287 BEGIN 1288 1289 1295 1297 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 END 1314 7. Acknowledgements 1316 Special suggestions that have been incorporated into this document 1317 were provided by David Kipling, James Gould, Gregory Zaltsman, Brett 1318 Carr and Harel Efraim. 1320 8. Change History 1322 8.1. Version 00 1324 Initial version. 1326 8.2. Version 01 1328 o and moved from 1329 escrow drafts to this draft 1331 o Added to 1333 o element of is now OPTIONAL 1334 o Added element to 1336 o and added to the draft 1338 o Several report elements are OPTIONAL to support async interfaces 1339 between Registry Operators and Data Escrow Agents 1341 o Added and to registry-escrow-report interface in order 1342 to make the interface idempotent and support async RyO-DEA 1343 interfaces 1345 o Added to escrow-agent-notification interface 1347 o The escrow-agent-notification uses POST and not PUT, this has been 1348 fixed 1350 o Several clarifications 1352 8.3. Version 02 1354 o Added and updated several result codes. 1356 o Added element. 1358 o Added Content-type definition. 1360 8.4. Version 03 1362 o Added several result codes. 1364 o unsignedShort is now used for result code in iirdea schema. 1366 o Enumeration was removed from the iirdea schema. 1368 8.5. Version 04 1370 o Added result codes: 2207 and 2208. 1372 o Removed result codes: 2203. 1374 o Added clarification regarding the support of HTTP streams. 1376 8.6. Version 05 1378 o Added result codes: 2007 and 2008. 1380 8.7. Version 06 1382 o Added clarification of error code HTTP/403 in Section 4. 1384 8.8. Version 07 1386 o Added Section 5: "Monitoring compliance with the New gTLD Base 1387 Agreement". 1389 8.9. Version 08 1391 o Reorganized specification structure to allow easier references 1392 from new specifications expanding functionality in the ICANN 1393 Registry Interfaces. 1395 o Added Section 1.3 to document object definitions, previously 1396 defined in other sections. 1398 o Added , , and object 1399 descriptions to Section 1.3, and schema definitions to Section 6. 1401 o Renamed Section 5 title as "Monitoring the reporting status". 1403 o Updated element as OPTIONAL in the 1404 schema. 1406 o Added OPTIONAL attribute "domainCount" to the 1407 element. 1409 o Added OPTIONAL element to the schema. 1411 o Added result codes: 2105, 2209, 2210 and 2211. 1413 o Added "gTLD Base Registry Agreement" references. 1415 o Added clarifications to Section 4. 1417 9. IANA Considerations 1419 TODO 1421 10. Security Considerations 1423 TODO 1425 11. References 1427 11.1. Normative References 1429 [I-D.arias-noguchi-dnrd-objects-mapping] 1430 Lozano, G., Gould, J., and C. Thippeswamy, "Domain Name 1431 Registration Data (DNRD) Objects Mapping", draft-arias- 1432 noguchi-dnrd-objects-mapping-06 (work in progress), June 1433 2017. 1435 [ICANN-GTLD-BASE-RA] 1436 ICANN, "gTLD Base Registry Agreement", Jan 2014, 1437 . 1440 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1441 Requirement Levels", BCP 14, RFC 2119, 1442 DOI 10.17487/RFC2119, March 1997, 1443 . 1445 [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: 1446 Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, 1447 . 1449 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1450 DOI 10.17487/RFC3688, January 2004, 1451 . 1453 11.2. Informative References 1455 [RFC5890] Klensin, J., "Internationalized Domain Names for 1456 Applications (IDNA): Definitions and Document Framework", 1457 RFC 5890, DOI 10.17487/RFC5890, August 2010, 1458 . 1460 [RFC5891] Klensin, J., "Internationalized Domain Names in 1461 Applications (IDNA): Protocol", RFC 5891, 1462 DOI 10.17487/RFC5891, August 2010, 1463 . 1465 Authors' Addresses 1466 Gustavo Lozano 1467 ICANN 1468 12025 Waterfront Drive, Suite 300 1469 Los Angeles 90292 1470 US 1472 Phone: +1.3103015800 1473 Email: gustavo.lozano@icann.org 1475 Eduardo Alvarez 1476 ICANN 1477 12025 Waterfront Drive, Suite 300 1478 Los Angeles 90292 1479 US 1481 Phone: +1.3103015800 1482 Email: eduardo.alvarez@icann.org