idnits 2.17.1 draft-ietf-regext-org-04.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 seems to contain a disclaimer for pre-RFC5378 work, but was first submitted on or after 10 November 2008. The disclaimer is usually necessary only for documents that revise or obsolete older RFCs, and that take significant amounts of text from those RFCs. If you can contact all authors of the source material and they are willing to grant the BCP78 rights to the IETF Trust, you can and should remove the disclaimer. Otherwise, the disclaimer is needed and you can ignore this comment. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (May 4, 2018) is 2184 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) No issues found here. Summary: 0 errors (**), 0 flaws (~~), 2 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force L. Zhou 3 Internet-Draft N. Kong 4 Intended status: Standards Track G. Zhou 5 Expires: November 5, 2018 X. Lee 6 CNNIC 7 J. Gould 8 Verisign, Inc. 9 May 4, 2018 11 Extensible Provisioning Protocol (EPP) Organization Mapping 12 draft-ietf-regext-org-04 14 Abstract 16 This document describes an Extensible Provisioning Protocol (EPP) 17 mapping for provisioning and management of organization objects 18 stored in a shared central repository. Specified in Extensible 19 Markup Language (XML), this extended mapping is applied to provide 20 additional features required for the provisioning of organizations. 22 Status of This Memo 24 This Internet-Draft is submitted in full conformance with the 25 provisions of BCP 78 and BCP 79. 27 Internet-Drafts are working documents of the Internet Engineering 28 Task Force (IETF). Note that other groups may also distribute 29 working documents as Internet-Drafts. The list of current Internet- 30 Drafts is at https://datatracker.ietf.org/drafts/current/. 32 Internet-Drafts are draft documents valid for a maximum of six months 33 and may be updated, replaced, or obsoleted by other documents at any 34 time. It is inappropriate to use Internet-Drafts as reference 35 material or to cite them other than as "work in progress." 37 This Internet-Draft will expire on November 5, 2018. 39 Copyright Notice 41 Copyright (c) 2018 IETF Trust and the persons identified as the 42 document authors. All rights reserved. 44 This document is subject to BCP 78 and the IETF Trust's Legal 45 Provisions Relating to IETF Documents 46 (https://trustee.ietf.org/license-info) in effect on the date of 47 publication of this document. Please review these documents 48 carefully, as they describe your rights and restrictions with respect 49 to this document. Code Components extracted from this document must 50 include Simplified BSD License text as described in Section 4.e of 51 the Trust Legal Provisions and are provided without warranty as 52 described in the Simplified BSD License. 54 This document may contain material from IETF Documents or IETF 55 Contributions published or made publicly available before November 56 10, 2008. The person(s) controlling the copyright in some of this 57 material may not have granted the IETF Trust the right to allow 58 modifications of such material outside the IETF Standards Process. 59 Without obtaining an adequate license from the person(s) controlling 60 the copyright in such materials, this document may not be modified 61 outside the IETF Standards Process, and derivative works of it may 62 not be created outside the IETF Standards Process, except to format 63 it for publication as an RFC or to translate it into languages other 64 than English. 66 Table of Contents 68 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 69 2. Conventions Used in This Document . . . . . . . . . . . . . . 3 70 3. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 4 71 3.1. Organization Identifier . . . . . . . . . . . . . . . . . 4 72 3.2. Organization Roles . . . . . . . . . . . . . . . . . . . 4 73 3.2.1. Role Type . . . . . . . . . . . . . . . . . . . . . . 4 74 3.2.2. Role Status . . . . . . . . . . . . . . . . . . . . . 4 75 3.2.3. Role Identifier . . . . . . . . . . . . . . . . . . . 4 76 3.3. Contact and Client Identifiers . . . . . . . . . . . . . 5 77 3.4. Organization Status Values . . . . . . . . . . . . . . . 5 78 3.5. Role Status Values . . . . . . . . . . . . . . . . . . . 6 79 3.6. Parent Identifier . . . . . . . . . . . . . . . . . . . . 7 80 3.7. URL . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 81 3.8. Dates and Times . . . . . . . . . . . . . . . . . . . . . 7 82 4. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 7 83 4.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 7 84 4.1.1. EPP Command . . . . . . . . . . . . . . . . . 8 85 4.1.2. EPP Command . . . . . . . . . . . . . . . . . 9 86 4.1.3. EPP Command . . . . . . . . . . . . . . . 15 87 4.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 15 88 4.2.1. EPP Command . . . . . . . . . . . . . . . . 15 89 4.2.2. EPP Command . . . . . . . . . . . . . . . . 19 90 4.2.3. EPP Command . . . . . . . . . . . . . . . . . 20 91 4.2.4. EPP Command . . . . . . . . . . . . . . . 20 92 4.2.5. EPP Command . . . . . . . . . . . . . . . . 21 93 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 25 94 6. Internationalization Considerations . . . . . . . . . . . . . 33 95 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 33 96 7.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 33 97 7.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 34 98 7.3. Role Values Registry . . . . . . . . . . . . . . . . . . 34 99 7.3.1. Registration Template . . . . . . . . . . . . . . . . 34 100 7.3.2. Initial Registry Contents . . . . . . . . . . . . . . 35 101 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 35 102 8.1. Verisign EPP SDK . . . . . . . . . . . . . . . . . . . . 36 103 8.2. CNNIC Implementation . . . . . . . . . . . . . . . . . . 36 104 8.3. Reseller Extension . . . . . . . . . . . . . . . . . . . 37 105 9. Security Considerations . . . . . . . . . . . . . . . . . . . 37 106 10. Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . 37 107 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 37 108 11.1. Normative References . . . . . . . . . . . . . . . . . . 37 109 11.2. Informative References . . . . . . . . . . . . . . . . . 38 110 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 38 111 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 40 113 1. Introduction 115 There are many entities, such as registrars, resellers, DNS service 116 operators, or privacy proxies involved in the domain registration 117 business. These kind of entities have not been formally defined as 118 an object in EPP which will be specified as "organization" in this 119 document. 121 This document describes an organization object mapping for version 122 1.0 of the Extensible Provisioning Protocol (EPP) [RFC5730]. This 123 mapping is specified using the XML 1.0 as described in 124 [W3C.REC-xml-20040204] and XML Schema notation as described in 125 [W3C.REC-xmlschema-1-20041028] and [W3C.REC-xmlschema-2-20041028]. 127 2. Conventions Used in This Document 129 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 130 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 131 document are to be interpreted as described in [RFC2119]. 133 In examples, "C:" represents lines sent by a protocol client and "S:" 134 represents lines returned by a protocol server. Indentation and 135 white space in examples are provided only to illustrate element 136 relationships and are not a REQUIRED feature of this specification. 138 XML is case sensitive. Unless stated otherwise, XML specifications 139 and examples provided in this document MUST be interpreted in the 140 character case presented to develop a conforming implementation. 142 "org-1.0" in is used as an abbreviation for 143 "urn:ietf:params:xml:ns:org-1.0". The XML namespace prefix "org" is 144 used, but implementations MUST NOT depend on it and instead employ a 145 proper namespace-aware XML parser and serializer to interpret and 146 output the XML documents. 148 3. Object Attributes 150 An EPP organization object has attributes and associated values that 151 can be viewed and modified by the sponsoring client or the server. 152 This section describes each attribute type in detail. The formal 153 syntax for the attribute values described here can be found in the 154 "Formal Syntax" section of this document and in the appropriate 155 normative references. 157 3.1. Organization Identifier 159 All EPP organizations are identified by a server-unique identifier. 160 Organization identifiers are character strings with a specific 161 minimum length, a specified maximum length, and a specified format. 162 Organization identifiers use the "clIDType" client identifier syntax 163 described in [RFC5730]. Its corresponding element is . 165 3.2. Organization Roles 167 The organization roles are used to represent the relationship an 168 organization would have. Its corresponding element is . 170 3.2.1. Role Type 172 An organization would support a list of roles. See Section 7.3 for a 173 list of values. Its corresponding element is . 175 3.2.2. Role Status 177 A role of an organization object would have its own statuses. Its 178 corresponding element is . The values of the role status 179 are defined in Section 3.5. 181 3.2.3. Role Identifier 183 A role MAY have a third party assigned identifier such as the IANA ID 184 for registrars. Its corresponding element is . 186 Example of organization role identifier: 188 189 registrar 190 ok 191 linked 192 1362 193 195 3.3. Contact and Client Identifiers 197 All EPP contacts are identified by a server-unique identifier. 198 Contact identifiers are character strings with a specific minimum 199 length, a specified maximum length, and a specified format. Contact 200 identifiers use the "clIDType" client identifier syntax described in 201 [RFC5730]. 203 3.4. Organization Status Values 205 An organization object MUST always have at least one associated 206 status value. The default value is "ok". 208 Status values that can be added or removed by a client are prefixed 209 with "client". Corresponding status values that can be added or 210 removed by a server are prefixed with "server". The "hold" and 211 "terminated" status values are server-managed when the organization 212 has no parent identifier [Section 3.6] and otherwise MAY be client- 213 managed based on server policy. 215 Status Value Descriptions: 217 o ok: This is the normal status value for an object that has no 218 pending operations or prohibitions. This value is set and removed 219 by the server as other status values are added or removed. 221 o hold: Organization transform commands and new links MUST be 222 rejected. 224 o terminated: The organization which has been terminated MUST NOT be 225 linked. Organization transform commands and new links MUST be 226 rejected. 228 o linked: The organization object has at least one active 229 association with another object. The "linked" status is not 230 explicitly set by the client. Servers SHOULD provide services to 231 determine existing object associations. 233 o clientLinkProhibited, serverLinkProhibited: Requests to add new 234 links to the organization MUST be rejected. 236 o clientUpdateProhibited, serverUpdateProhibited: Requests to update 237 the object (other than to remove this status) MUST be rejected. 239 o clientDeleteProhibited, serverDeleteProhibited: Requests to delete 240 the object MUST be rejected. 242 o pendingCreate, pendingUpdate, pendingDelete: A transform command 243 has been processed for the object, but the action has not been 244 completed by the server. Server operators can delay action 245 completion for a variety of reasons, such as to allow for human 246 review or third-party action. A transform command that is 247 processed, but whose requested action is pending, is noted with 248 response code 1001. 250 "pendingCreate", "ok", "hold", and "terminated" are mutually 251 exclusive statuses. Organization MUST have only one of these 252 statuses set. 254 "ok" status MAY only be combined with "linked" status. 256 "pendingDelete" status MUST NOT be combined with either 257 "clientDeleteProhibited" or "serverDeleteProhibited" status. 259 The pendingCreate, pendingDelete, and pendingUpdate status values 260 MUST NOT be combined with each other. 262 3.5. Role Status Values 264 A role SHOULD have at least one associated status value. Valid 265 values include "ok", "linked", "clientLinkProhibited", and 266 "serverLinkProhibited". The default value is "ok". 268 Status Value Descriptions: 270 o ok: This is the normal status value for an role that has no 271 pending operations or prohibitions. This value is set and removed 272 by the server as other status values are added or removed. 274 o linked: The role of an organization object has at least one active 275 association with another object. The "linked" status is not 276 explicitly set by the client. Servers SHOULD provide services to 277 determine existing object associations. 279 o clientLinkProhibited, serverLinkProhibited: Requests to add new 280 links to the role MUST be rejected. 282 3.6. Parent Identifier 284 There can be more than one layer of organizations, such as a 285 reseller. The parent identifier, as defined with the 286 element, represents the parent organization identifier in a child 287 organization. 289 Take a reseller organization for example, the parent identifier is 290 not defined for the top level reseller, namely the registrar of the 291 registry. An N-tier reseller has a parent reseller and at least one 292 child reseller. A reseller customer has a parent reseller and no 293 child resellers. 295 Loops SHOULD be prohibited. If organization A has B as parent 296 identifier, organization B must not have organization A as parent 297 identifier. 299 3.7. URL 301 The URL represents the organization web home page, as defined with 302 the element. 304 3.8. Dates and Times 306 Date and time attribute values MUST be represented in Universal 307 Coordinated Time (UTC) using the Gregorian calendar. The extended 308 date-time form using upper case "T" and "Z" characters defined in 309 [W3C.REC-xmlschema-2-20041028] MUST be used to represent date-time 310 values, as XML Schema does not support truncated date-time forms or 311 lower case "T" and "Z" characters. 313 4. EPP Command Mapping 315 A detailed description of the EPP syntax and semantics can be found 316 in the EPP core protocol specification [RFC5730]. The command 317 mappings described here are specifically for use in provisioning and 318 managing organization information via EPP. 320 4.1. EPP Query Commands 322 EPP provides two commands to retrieve organization information: 323 to determine if an organization object can be provisioned 324 within a repository, and to retrieve detailed information 325 associated with an organization object. This document does not 326 define a mapping for the EPP command to retrieve 327 organization-object transfer status information.. 329 4.1.1. EPP Command 331 The EPP command is used to determine if an object can be 332 provisioned within a repository. It provides a hint that allows a 333 client to anticipate the success or failure of provisioning an object 334 using the command, as object-provisioning requirements are 335 ultimately a matter of server policy. 337 In addition to the standard EPP command elements, the command 338 MUST contain a element that identifies the organization 339 namespace. The element contains the following child 340 elements: 342 o One or more elements that contain the server-unique 343 identifier of the organization objects to be queried. 345 Example command: 347 C: 348 C: 349 C: 350 C: 351 C: 353 C: res1523 354 C: re1523 355 C: 1523res 356 C: 357 C: 358 C: ABC-12345 359 C: 360 C: 362 When a command has been processed successfully, the EPP 363 element MUST contain a child element that 364 identifies the organization namespace. The element 365 contains one or more elements that contain the following 366 child elements: 368 o A element that identifies the queried object. This 369 element MUST contain an "avail" attribute whose value indicates 370 object availability (can it be provisioned or not) at the moment 371 the command was completed. A value of "1" or "true" means 372 that the object can be provisioned. A value of "0" or "false" 373 means that the object cannot be provisioned. 375 o An OPTIONAL element that MAY be provided when an 376 object cannot be provisioned. If present, this element contains 377 server-specific text to help explain why the object cannot be 378 provisioned. This text MUST be represented in the response 379 language previously negotiated with the client; an OPTIONAL "lang" 380 attribute MAY be present to identify the language if the 381 negotiated value is something other than the default value of 382 "en"(English). 384 Example response: 386 S: 387 S: 388 S: 389 S: 390 S: Command completed successfully 391 S: 392 S: 393 S: 395 S: 396 S: res1523 397 S: 398 S: 399 S: re1523 400 S: In use 401 S: 402 S: 403 S: 1523res 404 S: 405 S: 406 S: 407 S: 408 S: ABC-12345 409 S: 54322-XYZ 410 S: 411 S: 412 S: 414 An EPP error response MUST be returned if a command cannot be 415 processed for any reason. 417 4.1.2. EPP Command 419 The EPP command is used to retrieve information associated 420 with an organization object. In addition to the standard EPP command 421 elements, the command MUST contain a element that 422 identifies the organization namespace. The element 423 contains the following child elements: 425 o A element that contains the server-unique identifier of 426 the organization object to be queried. 428 Example command: 430 C: 431 C: 432 C: 433 C: 434 C: 436 C: res1523 437 C: 438 C: 439 C: ABC-12345 440 C: 441 C: 443 When an command has been processed successfully, the EPP 444 element MUST contain a child element that 445 identifies the organization namespace. The element 446 contains the following child elements: 448 o A element that contains the server-unique identifier of 449 the organization object, as defined in Section 3.1. 451 o A element that contains the Repository Object 452 IDentifier assigned to the organization object when the object was 453 created. 455 o One or more elements that contains the role type, role 456 statuses and optional role id of the organization. 458 * A element that contains the type of the 459 organization, as defined in Section 3.2. 461 * Zero or more elements that contains the role type. 462 The values of the role status are defined in Section 3.5. 464 * An OPTIONAL element that contains a third party 465 assigned identifier, such as IANA ID for registrars, as defined 466 in Section 3.2.3. 468 o Zero or more elements that contains the operational 469 status of the organization, as defined in Section 3.4. 471 o An OPTIONAL element that contains the identifier of 472 the parent object, as defined in Section 3.6. 474 o Zero to two elements that contain postal-address 475 information. Two elements are provided so that address 476 information can be provided in both internationalized and 477 localized forms; a "type" attribute is used to identify the two 478 forms. If an internationalized form (type="int") is provided, 479 element content MUST be represented in a subset of UTF-8 that can 480 be represented in the 7-bit US-ASCII character set. If a 481 localized form (type="loc") is provided, element content MAY be 482 represented in unrestricted UTF-8. The element 483 contains the following child elements: 485 * A element that contains the name of the 486 organization. 488 * A element that contains address information 489 associated with the organization. A element 490 contains the following child elements: 492 + One, two, or three OPTIONAL elements that 493 contain the organization's street address. 495 + A element that contains the organization's city. 497 + An OPTIONAL element that contains the 498 organization's state or province. 500 + An OPTIONAL element that contains the 501 organization's postal code. 503 + A element that contains the organization's country 504 code. 506 o An OPTIONAL element that contains the organization's 507 voice telephone number. 509 o An OPTIONAL element that contains the organization's 510 facsimile telephone number. 512 o An OPTIONAL element that contains the organization's 513 email address. 515 o An OPTIONAL element that contains the URL to the website 516 of the organization. 518 o Zero or more OPTIONAL elements that contain 519 identifiers for the contact objects to be associated with the 520 organization object. Contact object identifiers MUST be known to 521 the server before the contact object can be associated with the 522 organization object. The required "type" is used to represent 523 contact types. The type values include "admin", "tech", 524 "billing", "abuse", and "custom". The OPTIONAL "typeName" 525 attribute is used to define the name of a "custom" type. 527 o An OPTIONAL element that contains the organization 528 identifier of the sponsoring client. There is no 529 element if the organization is managed by the registry. 531 o A element that contains the identifier of the client 532 that created the organization object. 534 o A element that contains the date and time of 535 organization object creation. 537 o A element that contains the identifier of the client 538 that last updated the organization object. This element MUST NOT 539 be present if the organization has never been modified. 541 o A element that contains the date and time of the most 542 recent organization object modification. This element MUST NOT be 543 present if the organization object has never been modified. 545 Example response for "Example Registrar Inc." organization 546 object with registrar identifier "1362": 548 S: 549 S: 550 S: 551 S: 552 S: Command completed successfully 553 S: 554 S: 555 S: 557 S: registrar1362 558 S: registrar1362-REP 559 S: 560 S: registrar 561 S: ok 562 S: linked 563 S: 1362 564 S: 565 S: ok 566 S: 567 S: Example Registrar Inc. 568 S: 569 S: 123 Example Dr. 570 S: Suite 100 571 S: Dulles 572 S: VA 573 S: 20166-6503 574 S: US 575 S: 576 S: 577 S: +1.7035555555 578 S: +1.7035555556 579 S: contact@organization.example 580 S: http://organization.example 581 S: sh8013 582 S: sh8013 583 S: sh8013 585 S: ClientX 586 S: 1999-04-03T22:00:00.0Z 587 S: ClientX 588 S: 1999-12-03T09:00:00.0Z 589 S: 590 S: 591 S: 592 S: ABC-12345 593 S: 54322-XYZ 594 S: 595 S: 596 S: 598 Example response for "Example Reseller Inc." organization 599 object of reseller type managed by registrar identifier "1362": 601 S: 602 S: 603 S: 604 S: 605 S: Command completed successfully 606 S: 607 S: 608 S: 610 S: reseller1523 611 S: reseller1523-REP 612 S: 613 S: reseller 614 S: ok 615 S: linked 616 S: 617 S: ok 618 S: registrar1362 619 S: 620 S: Example Reseller Inc. 621 S: 622 S: 123 Example Dr. 623 S: Suite 100 624 S: Dulles 625 S: VA 626 S: 20166-6503 627 S: US 628 S: 629 S: 630 S: +1.7035555556 631 S: http://organization.example 632 S: sh8013 633 S: 1362 634 S: ClientX 635 S: 1999-04-03T22:00:00.0Z 636 S: ClientX 637 S: 1999-12-03T09:00:00.0Z 638 S: 639 S: 640 S: 641 S: ABC-12345 642 S: 54322-XYZ 643 S: 644 S: 645 S: 647 An EPP error response MUST be returned if an command cannot be 648 processed for any reason. 650 4.1.3. EPP Command 652 The transfer semantics does not apply to organization object. No EPP 653 command is defined in this document. 655 4.2. EPP Transform Commands 657 This document provides three commands to transform organization 658 object information: to create an instance of an organization 659 object, to delete an instance of an organization object, and 660 to change information associated with an organization 661 object. This document does not define a mapping for the EPP 662 and command. 664 Transform commands are typically processed and completed in real 665 time. Server operators MAY receive and process transform commands 666 but defer completing the requested action if human or third-party 667 review is required before the requested action can be completed. In 668 such situations, the server MUST return a 1001 response code to the 669 client to note that the command has been received and processed but 670 that the requested action is pending. The server MUST also manage 671 the status of the object that is the subject of the command to 672 reflect the initiation and completion of the requested action. Once 673 the action has been completed, the client MUST be notified using a 674 service message that the action has been completed and that the 675 status of the object has changed. Other notification methods MAY be 676 used in addition to the required service message. 678 Server operators SHOULD confirm that a client is authorized to 679 perform a transform command on a given object. Any attempt to 680 transform an object by an unauthorized client MUST be rejected, and 681 the server MUST return a 2201 response code to the client to note 682 that the client lacks privileges to execute the requested command. 684 4.2.1. EPP Command 686 The EPP command provides a transform operation that allows a 687 client to create an organization object. In addition to the standard 688 EPP command elements, the command MUST contain a 689 element that identifies the organization namespace. The 690 element contains the following child elements: 692 o A element that contains the desired server-unique 693 identifier for the organization to be created, as defined in 694 Section 3.1. 696 o One or more elements that contains the role type, role 697 statuses and optional role id of the organization. 699 * A element that contains the type of the 700 organization, as defined in Section 3.2. 702 * Zero or more elements that contains the role type. 703 The values of the role status are defined in Section 3.5. 705 * An OPTIONAL element that contains a third party 706 assigned identifier, such as IANA ID for registrars, as defined 707 in Section 3.2.3. 709 o Zero of more element that contains the operational 710 status of the organization, as defined in Section 3.4. 712 o An OPTIONAL element that contains the identifier of 713 the parent object, as defined in Section 3.6. 715 o Zero to two elements that contain postal-address 716 information. Two elements are provided so that address 717 information can be provided in both internationalized and 718 localized forms; a "type" attribute is used to identify the two 719 forms. If an internationalized form (type="int") is provided, 720 element content MUST be represented in a subset of UTF-8 that can 721 be represented in the 7-bit US-ASCII character set. If a 722 localized form (type="loc") is provided, element content MAY be 723 represented in unrestricted UTF-8. The element 724 contains the following child elements: 726 * A element that contains the name of the 727 organization. 729 * A element that contains address information 730 associated with the organization. A element 731 contains the following child elements: 733 + One, two, or three OPTIONAL elements that 734 contain the organization's street address. 736 + A element that contains the organization's city. 738 + An OPTIONAL element that contains the 739 organization's state or province. 741 + An OPTIONAL element that contains the 742 organization's postal code. 744 + A element that contains the organization's country 745 code. 747 o An OPTIONAL element that contains the organization's 748 voice telephone number. 750 o An OPTIONAL element that contains the organization's 751 facsimile telephone number. 753 o An OPTIONAL element that contains the organization's 754 email address. 756 o An OPTIONAL element that contains the URL to the website 757 of the organization. 759 o Zero or more OPTIONAL elements that contain 760 identifiers for the contact objects associated with the 761 organization object. 763 Example command: 765 C: 766 C: 767 C: 768 C: 769 C: 771 C: res1523 772 C: 773 C: reseller 774 C: 775 C: 1523res 776 C: 777 C: Example Organization Inc. 778 C: 779 C: 123 Example Dr. 780 C: Suite 100 781 C: Dulles 782 C: VA 783 C: 20166-6503 784 C: US 785 C: 786 C: 787 C: +1.7035555555 788 C: +1.7035555556 789 C: contact@organization.example 790 C: http://organization.example 791 C: sh8013 792 C: sh8013 793 C: 794 C: 795 C: ABC-12345 796 C: 797 C: 799 When a command has been processed successfully, the EPP 800 element MUST contain a child element that 801 identifies the organization namespace. The element 802 contains the following child elements: 804 o A element that contains the server-unique identifier for 805 the created organization, as defined in Section 3.1. 807 o A element that contains the date and time of 808 organization-object creation. 810 Example response: 812 S: 813 S: 814 S: 815 S: 816 S: Command completed successfully 817 S: 818 S: 819 S: 821 S: res1523 822 S: 1999-04-03T22:00:00.0Z 823 S: 824 S: 825 S: 826 S: ABC-12345 827 S: 54321-XYZ 828 S: 829 S: 830 S: 832 An EPP error response MUST be returned if a command cannot 833 be processed for any reason. 835 4.2.2. EPP Command 837 The EPP command provides a transform operation that allows a 838 client to delete an organization object. In addition to the standard 839 EPP command elements, the command MUST contain a 840 element that identifies the organization namespace. The 841 element MUST contain the following child element: 843 o A element that contains the server-unique identifier of 844 the organization object to be deleted, as defined in Section 3.1. 846 An organization object MUST NOT be deleted if it is associated with 847 other known objects. An associated organization MUST NOT be deleted 848 until associations with other known objects have been broken. A 849 server MUST notify clients that object relationships exist by sending 850 a 2305 error response code when a command is attempted and 851 fails due to existing object relationships. 853 Example command: 855 C: 856 C: 857 C: 858 C: 859 C: 861 C: res1523 862 C: 863 C: 864 C: ABC-12345 865 C: 866 C: 868 When a command has been processed successfully, a server 869 MUST respond with an EPP response with no element. 871 Example response: 873 S: 874 S: 875 S: 876 S: 877 S: Command completed successfully 878 S: 879 S: 880 S: ABC-12345 881 S: 54321-XYZ 882 S: 883 S: 884 S: 886 An EPP error response MUST be returned if a command cannot 887 be processed for any reason. 889 4.2.3. EPP Command 891 Renewal semantics do not apply to organization objects, so there is 892 no mapping defined for the EPP command. 894 4.2.4. EPP Command 896 Transfer semantics do not apply to organization objects, so there is 897 no mapping defined for the EPP command. 899 4.2.5. EPP Command 901 The EPP command provides a transform operation that allows a 902 client to modify the attributes of an organization object. In 903 addition to the standard EPP command elements, the command 904 MUST contain a element that identifies the organization 905 namespace. The element contains the following child 906 elements: 908 o A element that contains the server-unique identifier of 909 the organization object to be updated, as defined in Section 3.1. 911 o An OPTIONAL element that contains attribute values to be 912 added to the object. 914 o An OPTIONAL element that contains attribute values to be 915 removed from the object. 917 o An OPTIONAL element that contains attribute values to be 918 changed. 920 At least one , or element MUST be 921 provided if the command is not being extended. All of these elements 922 MAY be omitted if an extension is present. The OPTIONAL 923 and elements contain the following child element: 925 o Zero or more elements that contain the identifiers 926 for contact objects to be associated with or removed from the 927 organization object. Contact object identifiers MUST be known to 928 the server before the contact object can be associated with the 929 organization object. 931 o Zero or more elements that contains the role type, role 932 statuses and optional role id of the organization. 934 * A element that contains the type of the 935 organization, as defined in Section 3.2. 937 * Zero or more elements that contains the role type. 938 The values of the role status are defined in Section 3.5. 940 * An OPTIONAL element that contains a third party 941 assigned identifier, such as IANA ID for registrars, as defined 942 in Section 3.2.3. 944 o Zero or more element that contains the operational 945 status of the organization. 947 A OPTIONAL element contains the following child elements, 948 where at least one child element MUST be present: 950 o An OPTIONAL element that contains the identifier of 951 the parent object. 953 o Zero to two elements that contain postal-address 954 information. Two elements are provided so that address 955 information can be provided in both internationalized and 956 localized forms; a "type" attribute is used to identify the two 957 forms. If an internationalized form (type="int") is provided, 958 element content MUST be represented in a subset of UTF-8 that can 959 be represented in the 7-bit US-ASCII character set. If a 960 localized form (type="loc") is provided, element content MAY be 961 represented in unrestricted UTF-8. The change of the postal info 962 is defined as a replacement of that postal info element with the 963 contents of the sub-elements included in the update command. An 964 empty element is supported to allow a type of 965 postal info to be removed. The element contains 966 the following child elements: 968 * A element that contains the name of the 969 organization. 971 * A element that contains address information 972 associated with the organization. A element 973 contains the following child elements: 975 + One, two, or three OPTIONAL elements that 976 contain the organization's street address. 978 + A element that contains the organization's city. 980 + An OPTIONAL element that contains the 981 organization's state or province. 983 + An OPTIONAL element that contains the 984 organization's postal code. 986 + A element that contains the organization's country 987 code. 989 o An OPTIONAL element that contains the organization's 990 voice telephone number. 992 o An OPTIONAL element that contains the organization's 993 facsimile telephone number. 995 o An OPTIONAL element that contains the organization's 996 email address. 998 o An OPTIONAL element that contains the URL to the website 999 of the organization. 1001 Example command: 1003 C: 1004 C: 1005 C: 1006 C: 1007 C: 1009 C: res1523 1010 C: 1011 C: sh8013 1012 C: 1013 C: privacyproxy 1014 C: clientLinkProhibited 1015 C: 1016 C: clientLinkProhibited 1017 C: 1018 C: 1019 C: sh8014 1020 C: 1021 C: reseller 1022 C: clientDeleteProhibited 1023 C: 1024 C: 1025 C: 1026 C: 1027 C: 1028 C: 124 Example Dr. 1029 C: Suite 200 1030 C: Dulles 1031 C: VA 1032 C: 20166-6503 1033 C: US 1034 C: 1035 C: 1036 C: +1.7034444444 1037 C: 1038 C: 1039 C: 1040 C: 1041 C: ABC-12345 1042 C: 1043 C: 1045 When an command has been processed successfully, a server 1046 MUST respond with an EPP response with no element. 1048 Example response: 1050 S: 1051 S: 1052 S: 1053 S: 1054 S: Command completed successfully 1055 S: 1056 S: 1057 S: ABC-12345 1058 S: 54321-XYZ 1059 S: 1060 S: 1061 S: 1063 An EPP error response MUST be returned if an command cannot 1064 be processed for any reason. 1066 5. Formal Syntax 1068 An EPP object mapping is specified in XML Schema notation. The 1069 formal syntax presented here is a complete schema representation of 1070 the object mapping suitable for automated validation of EPP XML 1071 instances. The BEGIN and END tags are not part of the schema; they 1072 are used to note the beginning and ending of the schema for URI 1073 registration purposes. 1075 BEGIN 1076 1078 1085 1088 1089 1091 1092 1093 Extensible Provisioning Protocol v1.0 1094 organization provisioning schema. 1095 1096 1098 1101 1102 1103 1104 1105 1107 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1128 1129 1130 1131 1132 1133 1134 1135 1137 1138 1139 1140 1142 1143 1144 1145 1146 1147 1149 1151 1152 1155 1157 1158 1159 1160 1162 1163 1164 1165 1167 1168 1169 1170 1171 1172 1173 1174 1175 1177 1178 1179 1180 1181 1182 1183 1185 1186 1187 1188 1189 1190 1192 1193 1194 1195 1196 1197 1199 1200 1201 1202 1203 1205 1206 1207 1208 1209 1211 1212 1213 1214 1215 1217 1218 1219 1221 1222 1224 1226 1227 1228 1230 1231 1232 1233 1234 1235 1237 1240 1241 1242 1243 1244 1246 1249 1250 1251 1253 1254 1256 1259 1260 1261 1263 1264 1266 1269 1270 1271 1273 1275 1277 1279 1281 1283 1285 1287 1290 1293 1294 1296 1299 1300 1301 1303 1305 1307 1309 1310 1312 1315 1316 1317 1319 1321 1323 1324 1326 1329 1330 1331 1333 1336 1339 1341 1343 1345 1346 1348 1349 1350 1352 1354 1355 1357 1359 1362 1363 1364 1366 1369 1370 1371 1373 1374 1376 1377 1378 1379 1381 1382 1384 1385 1386 1387 1389 1390 1391 1393 1396 1397 1398 1400 1402 1404 1406 1408 1410 1412 1414 1416 1418 1420 1422 1424 1426 1428 1430 1431 1432 1435 1436 1437 1438 1439 1440 1441 1444 1445 END 1447 6. Internationalization Considerations 1449 EPP is represented in XML, which provides native support for encoding 1450 information using the Unicode character set and its more compact 1451 representations including UTF-8. Conformant XML processors recognize 1452 both UTF-8 and UTF-16. Though XML includes provisions to identify 1453 and use other character encodings through use of an "encoding" 1454 attribute in an declaration, use of UTF-8 is RECOMMENDED. 1456 As an extension of the EPP organization object mapping, the elements 1457 and element content described in this document MUST inherit the 1458 internationalization conventions used to represent higher-layer 1459 domain and core protocol structures present in an XML instance that 1460 includes this extension. 1462 7. IANA Considerations 1464 7.1. XML Namespace 1466 This document uses URNs to describe XML namespaces and XML schemas 1467 conforming to a registry mechanism described in [RFC3688]. IANA is 1468 requested to assignment the following URI. 1470 Registration request for the organization namespace: 1472 URI: urn:ietf:params:xml:ns:org-1.0 1474 Registrant Contact: See the "Author's Address" section of this 1475 document. 1477 XML: None. Namespace URIs do not represent an XML specification. 1479 Registration request for the organization XML schema: 1481 URI: urn:ietf:params:xml:ns:org-1.0 1482 Registrant Contact: See the "Author's Address" section of this 1483 document. 1485 XML: See the "Formal Syntax" section of this document. 1487 7.2. EPP Extension Registry 1489 The EPP extension described in this document should be registered by 1490 the IANA in the EPP Extension Registry described in [RFC7451]. The 1491 details of the registration are as follows: 1493 Name of Extension: Organization Object Extension 1495 Document status: Standards Track 1497 Reference: (insert reference to RFC version of this document) 1499 Registrant Name and Email Address: IESG 1501 TLDs: any 1503 IPR Disclosure: none 1505 Status: active 1507 Notes: none 1509 7.3. Role Values Registry 1511 The following values should be registered by the IANA in the "EPP 1512 Organization Role Values" registry. The registration policy for this 1513 registry is "Expert Review" [RFC8126]. 1515 7.3.1. Registration Template 1517 Value: the string value being registered. 1519 Description: Brief description of the organization role values. 1521 Registrant Name: For Standards Track RFCs, state "IESG". For others, 1522 give the name of the responsible party. 1524 Registrant Contact Information: an email address, postal address, or 1525 some other information to be used to contact the registrant. 1527 7.3.2. Initial Registry Contents 1529 Followings are the initial registry contents: 1531 Value: registrar 1533 Description: The entity object instance represents the authority 1534 responsible for the registration in the registry. 1536 Registrant Name: IESG 1538 Registrant Contact Information: iesg@ietf.org 1540 Value: reseller 1542 Description: The entity object instance represents a third party 1543 through which the registration was conducted (i.e., not the 1544 registry or registrar). 1546 Registrant Name: IESG 1548 Registrant Contact Information: iesg@ietf.org 1550 Value: privacyproxy 1552 Description: The entity object instance represents a third-party 1553 who could help to register a domain without exposing the 1554 registrants' private information.. 1556 Registrant Name: IESG 1558 Registrant Contact Information: iesg@ietf.org 1560 8. Implementation Status 1562 Note to RFC Editor: Please remove this section and the reference to 1563 [RFC7942] before publication. This section records the status of 1564 known implementations of the protocol defined by this specification 1565 at the time of posting of this Internet-Draft, and is based on a 1566 proposal described in [RFC7942]. The description of implementations 1567 in this section is intended to assist the IETF in its decision 1568 processes in progressing drafts to RFCs. Please note that the 1569 listing of any individual implementation here does not imply 1570 endorsement by the IETF. Furthermore, no effort has been spent to 1571 verify the information presented here that was supplied by IETF 1572 contributors. This is not intended as, and must not be construed to 1573 be, a catalog of available implementations or their features. 1574 Readers are advised to note that other implementations may exist. 1576 According to [RFC7942], "this will allow reviewers and working groups 1577 to assign due consideration to documents that have the benefit of 1578 running code, which may serve as evidence of valuable experimentation 1579 and feedback that have made the implemented protocols more mature. 1580 It is up to the individual working groups to use this information as 1581 they see fit". 1583 Verisign has already implemented this object mapping. CNNIC and 1584 Net::DRI (Patrick Mevzek) are in the process of development research 1585 to update organization objecct from reseller object. Dns Belgium is 1586 planning to implement it after the publication of this document. 1588 8.1. Verisign EPP SDK 1590 Organization: Verisign Inc. 1592 Name: Verisign EPP SDK 1594 Description: The Verisign EPP SDK includes both a full client 1595 implementation and a full server stub implementation of draft-ietf- 1596 regext-org. 1598 Level of maturity: Development 1600 Coverage: All aspects of the protocol are implemented. 1602 Licensing: GNU Lesser General Public License 1604 Contact: jgould@verisign.com 1606 URL: https://www.verisign.com/en_US/channel-resources/domain- 1607 registry-products/epp-sdks 1609 8.2. CNNIC Implementation 1611 Organization: CNNIC 1613 Name: EPP Organization Mapping 1615 Description: CNNIC is trying to update EPP organization mapping from 1616 previous reseller mapping according to this document. 1618 Level of maturity: Development 1620 Coverage: EPP organization mapping 1622 Contact: zhouguiqing@cnnic.cn 1624 8.3. Reseller Extension 1626 This document was updated from [ID.draft-ietf-regext-reseller]. 1627 CNNIC, Verisign and Net::DRI (Patrick Mevzek) have already 1628 implemented the reseller mapping. 1630 9. Security Considerations 1632 The object mapping extension described in this document does not 1633 provide any other security services or introduce any additional 1634 considerations beyond those described by [RFC5730] or those caused by 1635 the protocol layers used by EPP. The security considerations 1636 described in these other specifications apply to this specification 1637 as well. 1639 10. Acknowledgment 1641 The authors would like to thank Rik Ribbers, Marc Groeneweg, Patrick 1642 Mevzek, Antoin Verschuren and Scott Hollenbeck for their careful 1643 review and valuable comments. 1645 11. References 1647 11.1. Normative References 1649 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1650 Requirement Levels", BCP 14, RFC 2119, 1651 DOI 10.17487/RFC2119, March 1997, 1652 . 1654 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1655 DOI 10.17487/RFC3688, January 2004, 1656 . 1658 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1659 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1660 . 1662 [RFC7942] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1663 Code: The Implementation Status Section", BCP 205, 1664 RFC 7942, DOI 10.17487/RFC7942, July 2016, 1665 . 1667 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 1668 Writing an IANA Considerations Section in RFCs", BCP 26, 1669 RFC 8126, DOI 10.17487/RFC8126, June 2017, 1670 . 1672 [W3C.REC-xml-20040204] 1673 Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and 1674 F. Yergeau, ""Extensible Markup Language (XML) 1.0 (Third 1675 Edition)", World Wide Web Consortium FirstEdition REC-xml- 1676 20040204", February 2004, 1677 . 1679 [W3C.REC-xmlschema-1-20041028] 1680 Thompson, H., Beech, D., Maloney, M., and N. Mendelsohn, 1681 ""XML Schema Part 1: Structures Second Edition", World 1682 Wide Web Consortium Recommendation REC-xmlschema- 1683 1-20041028", October 2004, 1684 . 1686 [W3C.REC-xmlschema-2-20041028] 1687 Biron, P. and A. Malhotra, ""XML Schema Part 2: Datatypes 1688 Second Edition", World Wide Web Consortium Recommendation 1689 REC-xmlschema-2-20041028", October 2004, 1690 . 1692 11.2. Informative References 1694 [ID.draft-ietf-regext-reseller] 1695 Zhou, L., Kong, N., Guiqing, G., Lee, X., and J. Gould, 1696 "Extensible Provisioning Protocol (EPP) Reseller Mapping", 1697 Dec 2016, 1698 . 1700 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1701 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1702 February 2015, . 1704 Appendix A. Change Log 1706 Initial -00: Individual document submitted. 1708 -01: 1710 * Updated abstract text. 1712 * Added sentences to avoid loop of parent identifiers in section 1713 3.4. 1715 * Revised typos in section 3.6. 1717 * Added explanation of contact type attribute in section 4.1.2. 1719 * Updated responses. 1721 * Deleted description of command in section 4.1 and 1722 4.2. 1724 * Deleted whoisInfo disclose type in XML schema. 1726 * Deleted maxOccurs of addRemType. 1728 * Deleted extra "OPTIONAL" in section 4.2.5. 1730 * Updated typos in response. 1732 -02: 1734 * Changed author information. 1736 * Updated url definition. 1738 * Updated XML schema. 1740 -03: 1742 * Changed author information. 1744 * Updated section 3.1. 1746 * Refactoried the XSD file. Added element. 1748 * Added acknowledgment. 1750 WG document-00: WG document submitted 1752 WG document-01: Keep document alive for further discussion. 1753 Reseller object or entity object with multiple roles? 1755 Organization WG document-00: Change to a generic organization object 1756 mapping. 1758 Organization WG document-01: Added "Implementation Status" section. 1760 Organization WG document-02: Accepted some of the feedbacks on the 1761 mailing list. 1763 Organization WG document-03: 1765 * Updated section 3.2, changed the structure of organization 1766 role. 1768 * Updated section 4.2.5 for the "add", "rem" and "chg" example. 1770 * Updated section 5 of formal syntax. 1772 * Updated section 7.2 for the registration template and initial 1773 values. 1775 * Updated section 8 of implementation status. 1777 Organization WG document-04: 1779 * Updated section 3.2, changed the structure of organization 1780 role. 1782 * Updated references. 1784 * Updated section 8 of implementation status. 1786 Authors' Addresses 1788 Linlin Zhou 1789 CNNIC 1790 4 South 4th Street, Zhongguancun, Haidian District 1791 Beijing, Beijing 100190 1792 China 1794 Phone: +86 10 5881 2677 1795 Email: zhoulinlin@cnnic.cn 1797 Ning Kong 1798 CNNIC 1799 4 South 4th Street, Zhongguancun, Haidian District 1800 Beijing, Beijing 100190 1801 China 1803 Phone: +86 10 5881 3147 1804 Email: nkong@cnnic.cn 1806 Guiqing Zhou 1807 CNNIC 1808 4 South 4th Street, Zhongguancun, Haidian District 1809 Beijing, Beijing 100190 1810 China 1812 Phone: +86 10 5881 2692 1813 Email: zhouguiqing@cnnic.cn 1814 Xiaodong Lee 1815 CNNIC 1816 4 South 4th Street, Zhongguancun, Haidian District 1817 Beijing, Beijing 100190 1818 China 1820 Phone: +86 10 5881 3020 1821 Email: xl@cnnic.cn 1823 James Gould 1824 Verisign, Inc. 1825 12061 Bluemont Way 1826 Reston, VA 20190 1827 US 1829 Email: jgould@verisign.com