idnits 2.17.1 draft-ietf-regext-org-03.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 : ---------------------------------------------------------------------------- ** There are 2 instances of too long lines in the document, the longest one being 12 characters in excess of 72. 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 (April 27, 2018) is 2191 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Unused Reference: 'RFC5733' is defined on line 1634, but no explicit reference was found in the text ** Obsolete normative reference: RFC 6982 (Obsoleted by RFC 7942) ** Downref: Normative reference to an Informational RFC: RFC 7451 Summary: 3 errors (**), 0 flaws (~~), 3 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: October 29, 2018 X. Lee 6 CNNIC 7 J. Gould 8 VeriSign, Inc. 9 April 27, 2018 11 Extensible Provisioning Protocol (EPP) Organization Mapping 12 draft-ietf-regext-org-03 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 October 29, 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 . . . . . . . . . . . . . . . . . . . . 6 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 . . . . . . . . . . . . . . . . . 7 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 . . . . . . . . . . . . . . 34 101 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 35 102 8.1. CNNIC Implementation . . . . . . . . . . . . . . . . . . 36 103 8.2. Reseller Extension . . . . . . . . . . . . . . . . . . . 36 104 9. Security Considerations . . . . . . . . . . . . . . . . . . . 36 105 10. Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . 36 106 11. Normative References . . . . . . . . . . . . . . . . . . . . 36 107 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 38 108 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 39 110 1. Introduction 112 There are many entities, such as registrars, resellers, DNS service 113 operators, or privacy proxies involved in the domain registration 114 business. These kind of entities have not been formally defined as 115 an object in EPP which will be specified as "organization" in this 116 document. 118 This document describes an organization object mapping for version 119 1.0 of the Extensible Provisioning Protocol (EPP) [RFC5730]. This 120 mapping is specified using the XML 1.0 as described in 121 [W3C.REC-xml-20040204] and XML Schema notation as described in 122 [W3C.REC-xmlschema-1-20041028] and [W3C.REC-xmlschema-2-20041028]. 124 2. Conventions Used in This Document 126 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 127 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 128 document are to be interpreted as described in [RFC2119]. 130 In examples, "C:" represents lines sent by a protocol client and "S:" 131 represents lines returned by a protocol server. Indentation and 132 white space in examples are provided only to illustrate element 133 relationships and are not a REQUIRED feature of this specification. 135 XML is case sensitive. Unless stated otherwise, XML specifications 136 and examples provided in this document MUST be interpreted in the 137 character case presented to develop a conforming implementation. 139 "org-1.0" in is used as an abbreviation for 140 "urn:ietf:params:xml:ns:org-1.0". The XML namespace prefix "org" is 141 used, but implementations MUST NOT depend on it and instead employ a 142 proper namespace-aware XML parser and serializer to interpret and 143 output the XML documents. 145 3. Object Attributes 147 An EPP organization object has attributes and associated values that 148 can be viewed and modified by the sponsoring client or the server. 149 This section describes each attribute type in detail. The formal 150 syntax for the attribute values described here can be found in the 151 "Formal Syntax" section of this document and in the appropriate 152 normative references. 154 3.1. Organization Identifier 156 All EPP organizations are identified by a server-unique identifier. 157 Organization identifiers are character strings with a specific 158 minimum length, a specified maximum length, and a specified format. 159 Organization identifiers use the "clIDType" client identifier syntax 160 described in [RFC5730]. Its corresponding element is . 162 3.2. Organization Roles 164 The organization roles are used to represent the relationship an 165 organization would have. Its corresponding element is . 167 3.2.1. Role Type 169 An organization would support a list of roles. See Section 7.3 for a 170 list of values. Its corresponding element is . 172 3.2.2. Role Status 174 A role of an organization object would have its own statuses. Its 175 corresponding element is . The values of role status are 176 defined in Section 3.5. 178 3.2.3. Role Identifier 180 A role MAY have a third party assigned identifier such as the IANA ID 181 for registrars. Its corresponding element is . 183 Example of organization role identifier: 185 186 registrar 187 ok 188 linked 189 1362 190 192 3.3. Contact and Client Identifiers 194 All EPP contacts are identified by a server-unique identifier. 195 Contact identifiers are character strings with a specific minimum 196 length, a specified maximum length, and a specified format. Contact 197 identifiers use the "clIDType" client identifier syntax described in 198 [RFC5730]. 200 3.4. Organization Status Values 202 An organization object MUST always have at least one associated 203 status value. The default value is "ok". 205 Status values that can be added or removed by a client are prefixed 206 with "client". Corresponding status values that can be added or 207 removed by a server are prefixed with "server". The "hold" and 208 "terminated" are server-managed when the organization has no parent 209 identifier [Section 3.6] and otherwise MAY be client-managed based on 210 server policy. 212 Status Value Descriptions: 214 o ok: This is the normal status value for an object that has no 215 pending operations or prohibitions. This value is set and removed 216 by the server as other status values are added or removed. 218 o hold: Organization transform commands and new links MUST be 219 rejected. 221 o terminated: The organization which has been terminated MUST NOT be 222 linked. Organization transform commands and new links MUST be 223 rejected. 225 o linked: The organization object has at least one active 226 association with another object. The "linked" status is not 227 explicitly set by the client. Servers SHOULD provide services to 228 determine existing object associations. 230 o clientLinkProhibited, serverLinkProhibited: Requests to add new 231 links to the organization MUST be rejected. 233 o clientUpdateProhibited, serverUpdateProhibited: Requests to update 234 the object (other than to remove this status) MUST be rejected. 236 o clientDeleteProhibited, serverDeleteProhibited: Requests to delete 237 the object MUST be rejected. 239 o pendingCreate, pendingUpdate, pendingDelete: A transform command 240 has been processed for the object, but the action has not been 241 completed by the server. Server operators can delay action 242 completion for a variety of reasons, such as to allow for human 243 review or third-party action. A transform command that is 244 processed, but whose requested action is pending, is noted with 245 response code 1001. 247 "pendingCreate", "ok", "hold", and "terminated" are mutually 248 exclusive statuses. Organization MUST have only one of these 249 statuses set. 251 "ok" status MAY only be combined with "linked" status. 253 "pendingDelete" status MUST NOT be combined with either 254 "clientDeleteProhibited" or "serverDeleteProhibited" status. 256 The pendingCreate, pendingDelete, and pendingUpdate status values 257 MUST NOT be combined with each other. 259 3.5. Role Status Values 261 A role SHOULD have at least one associated status value. Valid 262 values include "ok", "linked", "clientLinkProhibited", and 263 "serverLinkProhibited". The default value is "ok". 265 Status Value Descriptions: 267 o ok: This is the normal status value for an role that has no 268 pending operations or prohibitions. This value is set and removed 269 by the server as other status values are added or removed. 271 o linked: The role of an organization object has at least one active 272 association with another object. The "linked" status is not 273 explicitly set by the client. Servers SHOULD provide services to 274 determine existing object associations. 276 o clientLinkProhibited, serverLinkProhibited: Requests to add new 277 links to the role MUST be rejected. 279 3.6. Parent Identifier 281 There can be more than one layer of organizations, such as a 282 reseller. The parent identifier, as defined with the 283 element, represents the parent organization identifier in a child 284 organization. 286 Take a reseller organization for example, the parent identifier is 287 not defined for the top level reseller, namely the registrar of the 288 registry. An N-tier reseller has a parent reseller and at least one 289 child reseller. A reseller customer has a parent reseller and no 290 child resellers. 292 Loops SHOULD be prohibited. If organization A has B as parent 293 identifier, organization B must not have organization A as parent 294 identifier. 296 3.7. URL 298 The URL represents the organization web home page, as defined with 299 the element. 301 3.8. Dates and Times 303 Date and time attribute values MUST be represented in Universal 304 Coordinated Time (UTC) using the Gregorian calendar. The extended 305 date-time form using upper case "T" and "Z" characters defined in 306 [W3C.REC-xmlschema-2-20041028] MUST be used to represent date-time 307 values, as XML Schema does not support truncated date-time forms or 308 lower case "T" and "Z" characters. 310 4. EPP Command Mapping 312 A detailed description of the EPP syntax and semantics can be found 313 in the EPP core protocol specification [RFC5730]. The command 314 mappings described here are specifically for use in provisioning and 315 managing organization information via EPP. 317 4.1. EPP Query Commands 319 EPP provides two commands to retrieve organization information: 320 to determine if an organization object can be provisioned 321 within a repository, and to retrieve detailed information 322 associated with an organization object. This document does not 323 define a mapping for the EPP command to retrieve 324 organization-object transfer status information.. 326 4.1.1. EPP Command 328 The EPP command is used to determine if an object can be 329 provisioned within a repository. It provides a hint that allows a 330 client to anticipate the success or failure of provisioning an object 331 using the command, as object-provisioning requirements are 332 ultimately a matter of server policy. 334 In addition to the standard EPP command elements, the command 335 MUST contain a element that identifies the organization 336 namespace. The element contains the following child 337 elements: 339 o One or more elements that contain the server-unique 340 identifier of the organization objects to be queried. 342 Example command: 344 C: 345 C: 346 C: 347 C: 348 C: 350 C: res1523 351 C: re1523 352 C: 1523res 353 C: 354 C: 355 C: ABC-12345 356 C: 357 C: 359 When a command has been processed successfully, the EPP 360 element MUST contain a child element that 361 identifies the organization namespace. The element 362 contains one or more elements that contain the following 363 child elements: 365 o A element that identifies the queried object. This 366 element MUST contain an "avail" attribute whose value indicates 367 object availability (can it be provisioned or not) at the moment 368 the command was completed. A value of "1" or "true" means 369 that the object can be provisioned. A value of "0" or "false" 370 means that the object cannot be provisioned. 372 o An OPTIONAL element that MAY be provided when an 373 object cannot be provisioned. If present, this element contains 374 server-specific text to help explain why the object cannot be 375 provisioned. This text MUST be represented in the response 376 language previously negotiated with the client; an OPTIONAL "lang" 377 attribute MAY be present to identify the language if the 378 negotiated value is something other than the default value of 379 "en"(English). 381 Example response: 383 S: 384 S: 385 S: 386 S: 387 S: Command completed successfully 388 S: 389 S: 390 S: 392 S: 393 S: res1523 394 S: 395 S: 396 S: re1523 397 S: In use 398 S: 399 S: 400 S: 1523res 401 S: 402 S: 403 S: 404 S: 405 S: ABC-12345 406 S: 54322-XYZ 407 S: 408 S: 409 S: 411 An EPP error response MUST be returned if a command cannot be 412 processed for any reason. 414 4.1.2. EPP Command 416 The EPP command is used to retrieve information associated 417 with an organization object. In addition to the standard EPP command 418 elements, the command MUST contain a element that 419 identifies the organization namespace. The element 420 contains the following child elements: 422 o A element that contains the server-unique identifier of 423 the organization object to be queried. 425 Example command: 427 C: 428 C: 429 C: 430 C: 431 C: 433 C: res1523 434 C: 435 C: 436 C: ABC-12345 437 C: 438 C: 440 When an command has been processed successfully, the EPP 441 element MUST contain a child element that 442 identifies the organization namespace. The element 443 contains the following child elements: 445 o A element that contains the server-unique identifier of 446 the organization object, as defined in Section 3.1. 448 o A element that contains the Repository Object 449 IDentifier assigned to the organization object when the object was 450 created. 452 o One or more elements that contains the role type, role 453 status and optional role id of the organization. 455 * A element that contains the type of the 456 organization, as defined in Section 3.2. 458 * Zero or more elements of a role. The values of 459 role status are defined in Section 3.5. 461 * An OPTIONAL element that contains a third party 462 assigned identifier, such as IANA ID for registrars, as defined 463 in Section 3.2.3. 465 o Zero or more elements that contains the operational 466 status of the organization, as defined in Section 3.4. 468 o An OPTIONAL element that contains the identifier of 469 the parent object, as defined in Section 3.6. 471 o Zero to two elements that contain postal-address 472 information. Two elements are provided so that address 473 information can be provided in both internationalized and 474 localized forms; a "type" attribute is used to identify the two 475 forms. If an internationalized form (type="int") is provided, 476 element content MUST be represented in a subset of UTF-8 that can 477 be represented in the 7-bit US-ASCII character set. If a 478 localized form (type="loc") is provided, element content MAY be 479 represented in unrestricted UTF-8. The element 480 contains the following child elements: 482 * A element that contains the name of the 483 organization. 485 * A element that contains address information 486 associated with the organization. A element 487 contains the following child elements: 489 + One, two, or three OPTIONAL elements that 490 contain the organization's street address. 492 + A element that contains the organization's city. 494 + An OPTIONAL element that contains the 495 organization's state or province. 497 + An OPTIONAL element that contains the 498 organization's postal code. 500 + A element that contains the organization's country 501 code. 503 o An OPTIONAL element that contains the organization's 504 voice telephone number. 506 o An OPTIONAL element that contains the organization's 507 facsimile telephone number. 509 o An OPTIONAL element that contains the organization's 510 email address. 512 o An OPTIONAL element that contains the URL to the website 513 of the organization. 515 o Zero or more OPTIONAL elements that contain 516 identifiers for the contact objects to be associated with the 517 organization object. Contact object identifiers MUST be known to 518 the server before the contact object can be associated with the 519 organization object. The required "type" is used to represent 520 contact types. The type values include "admin", "tech", 521 "billing", "abuse", and "custom". The OPTIONAL "typeName" 522 attribute is used to define the name of a "custom" type. 524 o An OPTIONAL element that contains the organization 525 identifier of the sponsoring client. There is no 526 element if the organization is managed by the registry. 528 o A element that contains the identifier of the client 529 that created the organization object. 531 o A element that contains the date and time of 532 organization object creation. 534 o A element that contains the identifier of the client 535 that last updated the organization object. This element MUST NOT 536 be present if the organization has never been modified. 538 o A element that contains the date and time of the most 539 recent organization object modification. This element MUST NOT be 540 present if the organization object has never been modified. 542 Example response for "Example Registrar Inc." organization 543 object with registrar identifier "1362": 545 S: 546 S: 547 S: 548 S: 549 S: Command completed successfully 550 S: 551 S: 552 S: 554 S: registrar1362 555 S: registrar1362-REP 556 S: 557 S: registrar 558 S: ok 559 S: linked 560 S: 1362 561 S: 562 S: ok 563 S: 564 S: Example Registrar Inc. 565 S: 566 S: 123 Example Dr. 567 S: Suite 100 568 S: Dulles 569 S: VA 570 S: 20166-6503 571 S: US 572 S: 573 S: 574 S: +1.7035555555 575 S: +1.7035555556 576 S: contact@organization.example 577 S: http://organization.example 578 S: sh8013 579 S: sh8013 580 S: sh8013 582 S: ClientX 583 S: 1999-04-03T22:00:00.0Z 584 S: ClientX 585 S: 1999-12-03T09:00:00.0Z 586 S: 587 S: 588 S: 589 S: ABC-12345 590 S: 54322-XYZ 591 S: 592 S: 593 S: 595 Example response for "Example Reseller Inc." organization 596 object of reseller type managed by registrar identifier "1362": 598 S: 599 S: 600 S: 601 S: 602 S: Command completed successfully 603 S: 604 S: 605 S: 607 S: reseller1523 608 S: reseller1523-REP 609 S: 610 S: reseller 611 S: ok 612 S: linked 613 S: 614 S: ok 615 S: registrar1362 616 S: 617 S: Example Reseller Inc. 618 S: 619 S: 123 Example Dr. 620 S: Suite 100 621 S: Dulles 622 S: VA 623 S: 20166-6503 624 S: US 625 S: 626 S: 627 S: +1.7035555556 628 S: http://organization.example 629 S: sh8013 630 S: 1362 631 S: ClientX 632 S: 1999-04-03T22:00:00.0Z 633 S: ClientX 634 S: 1999-12-03T09:00:00.0Z 635 S: 636 S: 637 S: 638 S: ABC-12345 639 S: 54322-XYZ 640 S: 641 S: 642 S: 644 An EPP error response MUST be returned if an command cannot be 645 processed for any reason. 647 4.1.3. EPP Command 649 The transfer semantics does not apply to organization object. No EPP 650 command is defined in this document. 652 4.2. EPP Transform Commands 654 EPP provides three commands to transform organization object 655 information: to create an instance of an organization 656 object, to delete an instance of an organization object, and 657 to change information associated with an organization 658 object. This document does not define a mapping for the EPP 659 and command. 661 Transform commands are typically processed and completed in real 662 time. Server operators MAY receive and process transform commands 663 but defer completing the requested action if human or third-party 664 review is required before the requested action can be completed. In 665 such situations, the server MUST return a 1001 response code to the 666 client to note that the command has been received and processed but 667 that the requested action is pending. The server MUST also manage 668 the status of the object that is the subject of the command to 669 reflect the initiation and completion of the requested action. Once 670 the action has been completed, the client MUST be notified using a 671 service message that the action has been completed and that the 672 status of the object has changed. Other notification methods MAY be 673 used in addition to the required service message. 675 Server operators SHOULD confirm that a client is authorized to 676 perform a transform command on a given object. Any attempt to 677 transform an object by an unauthorized client MUST be rejected, and 678 the server MUST return a 2201 response code to the client to note 679 that the client lacks privileges to execute the requested command. 681 4.2.1. EPP Command 683 The EPP command provides a transform operation that allows a 684 client to create an organization object. In addition to the standard 685 EPP command elements, the command MUST contain a 686 element that identifies the organization namespace. The 687 element contains the following child elements: 689 o A element that contains the desired server-unique 690 identifier for the organization to be created, as defined in 691 Section 3.1. 693 o One or more elements that contains the role type, role 694 status and optional role id of the organization. 696 * A element that contains the type of the 697 organization, as defined in Section 3.2. 699 * Zero or more elements of a role. The values of 700 role status are defined in Section 3.5. 702 * An OPTIONAL element that contains a third party 703 assigned identifier, such as IANA ID for registrars, as defined 704 in Section 3.2.3. 706 o Zero of more element that contains the operational 707 status of the organization, as defined in Section 3.4. 709 o An OPTIONAL element that contains the identifier of 710 the parent object, as defined in Section 3.6. 712 o Zero to two elements that contain postal-address 713 information. Two elements are provided so that address 714 information can be provided in both internationalized and 715 localized forms; a "type" attribute is used to identify the two 716 forms. If an internationalized form (type="int") is provided, 717 element content MUST be represented in a subset of UTF-8 that can 718 be represented in the 7-bit US-ASCII character set. If a 719 localized form (type="loc") is provided, element content MAY be 720 represented in unrestricted UTF-8. The element 721 contains the following child elements: 723 * A element that contains the name of the 724 organization. 726 * A element that contains address information 727 associated with the organization. A element 728 contains the following child elements: 730 + One, two, or three OPTIONAL elements that 731 contain the organization's street address. 733 + A element that contains the organization's city. 735 + An OPTIONAL element that contains the 736 organization's state or province. 738 + An OPTIONAL element that contains the 739 organization's postal code. 741 + A element that contains the organization's country 742 code. 744 o An OPTIONAL element that contains the organization's 745 voice telephone number. 747 o An OPTIONAL element that contains the organization's 748 facsimile telephone number. 750 o An OPTIONAL element that contains the organization's 751 email address. 753 o An OPTIONAL element that contains the URL to the website 754 of the organization. 756 o Zero or more OPTIONAL elements that contain 757 identifiers for the contact objects associated with the 758 organization object. 760 Example command: 762 C: 763 C: 764 C: 765 C: 766 C: 768 C: res1523 769 C: 770 C: reseller 771 C: ok 772 C: 773 C: 1523res 774 C: 775 C: Example Organization Inc. 776 C: 777 C: 123 Example Dr. 778 C: Suite 100 779 C: Dulles 780 C: VA 781 C: 20166-6503 782 C: US 783 C: 784 C: 785 C: +1.7035555555 786 C: +1.7035555556 787 C: contact@organization.example 788 C: http://organization.example 789 C: sh8013 790 C: sh8013 791 C: 792 C: 793 C: ABC-12345 794 C: 795 C: 797 When a command has been processed successfully, the EPP 798 element MUST contain a child element that 799 identifies the organization namespace. The element 800 contains the following child elements: 802 o A element that contains the server-unique identifier for 803 the created organization, as defined in Section 3.1. 805 o A element that contains the date and time of 806 organization-object creation. 808 Example response: 810 S: 811 S: 812 S: 813 S: 814 S: Command completed successfully 815 S: 816 S: 817 S: 819 S: res1523 820 S: 1999-04-03T22:00:00.0Z 821 S: 822 S: 823 S: 824 S: ABC-12345 825 S: 54321-XYZ 826 S: 827 S: 828 S: 830 An EPP error response MUST be returned if a command cannot 831 be processed for any reason. 833 4.2.2. EPP Command 835 The EPP command provides a transform operation that allows a 836 client to delete an organization object. In addition to the standard 837 EPP command elements, the command MUST contain a 838 element that identifies the organization namespace. The 839 element MUST contain the following child element: 841 o A element that contains the server-unique identifier of 842 the organization object to be deleted, as defined in Section 3.1. 844 An organization object MUST NOT be deleted if it is associated with 845 other known objects. An associated organization MUST NOT be deleted 846 until associations with other known objects have been broken. A 847 server MUST notify clients that object relationships exist by sending 848 a 2305 error response code when a command is attempted and 849 fails due to existing object relationships. 851 Example command: 853 C: 854 C: 855 C: 856 C: 857 C: 859 C: res1523 860 C: 861 C: 862 C: ABC-12345 863 C: 864 C: 866 When a command has been processed successfully, a server 867 MUST respond with an EPP response with no element. 869 Example response: 871 S: 872 S: 873 S: 874 S: 875 S: Command completed successfully 876 S: 877 S: 878 S: ABC-12345 879 S: 54321-XYZ 880 S: 881 S: 882 S: 884 An EPP error response MUST be returned if a command cannot 885 be processed for any reason. 887 4.2.3. EPP Command 889 Renewal semantics do not apply to organization objects, so there is 890 no mapping defined for the EPP command. 892 4.2.4. EPP Command 894 Transfer semantics do not apply to organization objects, so there is 895 no mapping defined for the EPP command. 897 4.2.5. EPP Command 899 The EPP command provides a transform operation that allows a 900 client to modify the attributes of an organization object. In 901 addition to the standard EPP command elements, the command 902 MUST contain a element that identifies the organization 903 namespace. The element contains the following child 904 elements: 906 o A element that contains the server-unique identifier of 907 the organization object to be updated, as defined in Section 3.1. 909 o An OPTIONAL element that contains attribute values to be 910 added to the object. 912 o An OPTIONAL element that contains attribute values to be 913 removed from the object. 915 o An OPTIONAL element that contains attribute values to be 916 changed. 918 At least one , or element MUST be 919 provided if the command is not being extended. All of these elements 920 MAY be omitted if an extension is present. The 921 and elements contain the following child element: 923 o Zero or more elements that contain the identifiers 924 for contact objects to be associated with or removed from the 925 organization object. Contact object identifiers MUST be known to 926 the server before the contact object can be associated with the 927 organization object. 929 o Zero or more elements that contains the role type, role 930 status and optional role id of the organization. 932 * A element that contains the type of the 933 organization, as defined in Section 3.2. 935 * Zero or more elements of a role. The values of 936 role status are defined in Section 3.5. 938 * An OPTIONAL element that contains a third party 939 assigned identifier, such as IANA ID for registrars, as defined 940 in Section 3.2.3. 942 o Zero or more element that contains the operational 943 status of the organization. 945 A element contains the following OPTIONAL child elements. 946 At least one child element MUST be present: 948 o A element that contains the identifier of the 949 parent object. 951 o One or two elements that contain postal-address 952 information. Two elements are provided so that address 953 information can be provided in both internationalized and 954 localized forms; a "type" attribute is used to identify the two 955 forms. If an internationalized form (type="int") is provided, 956 element content MUST be represented in a subset of UTF-8 that can 957 be represented in the 7-bit US-ASCII character set. If a 958 localized form (type="loc") is provided, element content MAY be 959 represented in unrestricted UTF-8. The change of the postal info 960 is defined as a replacement of that postal info element with the 961 contents of the sub-elements included in the update command. An 962 empty element is supported to allow a type of 963 postal info to be removed. The element contains 964 the following child elements: 966 * A element that contains the name of the 967 organization. 969 * A element that contains address information 970 associated with the organization. A element 971 contains the following child elements: 973 + One, two, or three OPTIONAL elements that 974 contain the organization's street address. 976 + A element that contains the organization's city. 978 + An OPTIONAL element that contains the 979 organization's state or province. 981 + An OPTIONAL element that contains the 982 organization's postal code. 984 + A element that contains the organization's country 985 code. 987 o A element that contains the organization's voice 988 telephone number. 990 o A element that contains the organization's facsimile 991 telephone number. 993 o A element that contains the organization's email 994 address. 996 o A element that contains the URL to the website of the 997 organization. 999 Example command: 1001 C: 1002 C: 1003 C: 1004 C: 1005 C: 1007 C: res1523 1008 C: 1009 C: sh8013 1010 C: 1011 C: privacyproxy 1012 C: clientLinkProhibited 1013 C: 1014 C: clientLinkProhibited 1015 C: 1016 C: 1017 C: sh8014 1018 C: 1019 C: reseller 1020 C: clientDeleteProhibited 1021 C: 1022 C: 1023 C: 1024 C: 1025 C: 1026 C: 124 Example Dr. 1027 C: Suite 200 1028 C: Dulles 1029 C: VA 1030 C: 20166-6503 1031 C: US 1032 C: 1033 C: 1034 C: +1.7034444444 1035 C: 1036 C: 1037 C: 1038 C: 1039 C: ABC-12345 1040 C: 1041 C: 1043 When an command has been processed successfully, a server 1044 MUST respond with an EPP response with no element. 1046 Example response: 1048 S: 1049 S: 1050 S: 1051 S: 1052 S: Command completed successfully 1053 S: 1054 S: 1055 S: ABC-12345 1056 S: 54321-XYZ 1057 S: 1058 S: 1059 S: 1061 An EPP error response MUST be returned if an command cannot 1062 be processed for any reason. 1064 5. Formal Syntax 1066 An EPP object mapping is specified in XML Schema notation. The 1067 formal syntax presented here is a complete schema representation of 1068 the object mapping suitable for automated validation of EPP XML 1069 instances. The BEGIN and END tags are not part of the schema; they 1070 are used to note the beginning and ending of the schema for URI 1071 registration purposes. 1073 BEGIN 1074 1076 1083 1086 1087 1089 1090 1091 Extensible Provisioning Protocol v1.0 1092 organization provisioning schema. 1093 1094 1096 1099 1100 1101 1102 1103 1105 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1126 1127 1128 1129 1130 1131 1132 1133 1135 1136 1137 1138 1139 1141 1142 1143 1145 1147 1148 1151 1153 1154 1155 1156 1157 1158 1159 1160 1162 1163 1164 1165 1166 1167 1168 1169 1170 1172 1173 1174 1175 1176 1177 1178 1180 1181 1182 1183 1184 1185 1187 1188 1189 1190 1191 1193 1195 1196 1197 1198 1199 1201 1202 1203 1204 1205 1207 1208 1209 1210 1211 1213 1214 1215 1217 1218 1220 1222 1223 1224 1226 1227 1228 1229 1230 1231 1233 1236 1237 1238 1239 1240 1242 1245 1246 1247 1249 1250 1252 1255 1256 1257 1259 1260 1262 1265 1266 1267 1269 1271 1273 1275 1277 1279 1281 1283 1285 1288 1289 1291 1294 1295 1296 1298 1300 1302 1304 1305 1307 1310 1311 1312 1314 1316 1318 1319 1321 1324 1325 1326 1328 1331 1333 1335 1337 1340 1341 1343 1344 1345 1347 1349 1350 1352 1354 1357 1358 1359 1361 1364 1365 1366 1368 1369 1371 1372 1373 1374 1376 1377 1379 1380 1381 1382 1384 1385 1386 1388 1391 1392 1393 1395 1397 1399 1401 1403 1405 1407 1409 1411 1413 1415 1417 1419 1421 1423 1425 1426 1427 1430 1431 1432 1433 1434 1435 1437 1440 1441 END 1443 6. Internationalization Considerations 1445 EPP is represented in XML, which provides native support for encoding 1446 information using the Unicode character set and its more compact 1447 representations including UTF-8. Conformant XML processors recognize 1448 both UTF-8 and UTF-16. Though XML includes provisions to identify 1449 and use other character encodings through use of an "encoding" 1450 attribute in an declaration, use of UTF-8 is RECOMMENDED. 1452 As an extension of the EPP organization object mapping, the elements 1453 and element content described in this document MUST inherit the 1454 internationalization conventions used to represent higher-layer 1455 domain and core protocol structures present in an XML instance that 1456 includes this extension. 1458 7. IANA Considerations 1460 7.1. XML Namespace 1462 This document uses URNs to describe XML namespaces and XML schemas 1463 conforming to a registry mechanism described in [RFC3688]. IANA is 1464 requested to assignment the following URI. 1466 Registration request for the organization namespace: 1468 o URI: urn:ietf:params:xml:ns:org-1.0 1470 o Registrant Contact: See the "Author's Address" section of this 1471 document. 1473 o XML: None. Namespace URIs do not represent an XML specification. 1475 Registration request for the organization XML schema: 1477 o URI: urn:ietf:params:xml:ns:org-1.0 1479 o Registrant Contact: See the "Author's Address" section of this 1480 document. 1482 o XML: See the "Formal Syntax" section of this document. 1484 7.2. EPP Extension Registry 1486 The EPP extension described in this document should be registered by 1487 the IANA in the EPP Extension Registry described in [RFC7451]. The 1488 details of the registration are as follows: 1490 Name of Extension: Organization Object Extension 1492 Document status: Standards Track 1494 Reference: (insert reference to RFC version of this document) 1496 Registrant Name and Email Address: IESG 1498 TLDs: any 1500 IPR Disclosure: none 1502 Status: active 1504 Notes: none 1506 7.3. Role Values Registry 1508 The following values should be registered by the IANA in the "EPP 1509 Organization Role Values" registry. The registration policy for this 1510 registry is "Expert Review" [RFC8126]. 1512 7.3.1. Registration Template 1514 Value: the string value being registered. 1516 Description: Brief description of the organization role values. 1518 Registrant Name: For Standards Track RFCs, state "IESG". For others, 1519 give the name of the responsible party. 1521 Registrant Contact Information: an email address, postal address, or 1522 some other information to be used to contact the registrant. 1524 7.3.2. Initial Registry Contents 1526 Value: registrar 1528 Description: The entity object instance represents the authority 1529 responsible for the registration in the registry. 1531 Registrant Name: IESG 1532 Registrant Contact Information: iesg@ietf.org 1534 Value: reseller 1536 Description: The entity object instance represents a third party 1537 through which the registration was conducted (i.e., not the 1538 registry or registrar). 1540 Registrant Name: IESG 1542 Registrant Contact Information: iesg@ietf.org 1544 Value: privacyproxy 1546 Description: The entity object instance represents a third-party who 1547 could help to register a domain without exposing the registrants' 1548 private information.. 1550 Registrant Name: IESG 1552 Registrant Contact Information: iesg@ietf.org 1554 8. Implementation Status 1556 Note to RFC Editor: Please remove this section and the reference to 1557 [RFC6982] before publication. This section records the status of 1558 known implementations of the protocol defined by this specification 1559 at the time of posting of this Internet-Draft, and is based on a 1560 proposal described in [RFC6982]. The description of implementations 1561 in this section is intended to assist the IETF in its decision 1562 processes in progressing drafts to RFCs. Please note that the 1563 listing of any individual implementation here does not imply 1564 endorsement by the IETF. Furthermore, no effort has been spent to 1565 verify the information presented here that was supplied by IETF 1566 contributors. This is not intended as, and must not be construed to 1567 be, a catalog of available implementations or their features. 1568 Readers are advised to note that other implementations may exist. 1570 According to [RFC6982], "this will allow reviewers and working groups 1571 to assign due consideration to documents that have the benefit of 1572 running code, which may serve as evidence of valuable experimentation 1573 and feedback that have made the implemented protocols more mature. 1574 It is up to the individual working groups to use this information as 1575 they see fit". 1577 CNNIC and Net::DRI (Patrick Mevzek) are in the process of development 1578 research to update organization extension from reseller extension. 1580 Dns Belgium is planning to implement it after the publication of this 1581 document. 1583 8.1. CNNIC Implementation 1585 Organization: CNNIC 1587 Name: EPP Organization Mapping 1589 Description: CNNIC is trying to update EPP organization mapping from 1590 previous reseller mapping according to this document. 1592 Level of maturity: Research. 1594 Coverage: EPP organization mapping. 1596 Contact: zhouguiqing@cnnic.cn 1598 8.2. Reseller Extension 1600 This document was updated from draft-ietf-regext-reseller. CNNIC, 1601 VeriSign and Net::DRI (Patrick Mevzek) have already implemented the 1602 reseller mapping. 1604 9. Security Considerations 1606 The object mapping extension described in this document does not 1607 provide any other security services or introduce any additional 1608 considerations beyond those described by [RFC5730] or those caused by 1609 the protocol layers used by EPP. The security considerations 1610 described in these other specifications apply to this specification 1611 as well. 1613 10. Acknowledgment 1615 The authors would like to thank Rik Ribbers, Marc Groeneweg, Patrick 1616 Mevzek, Antoin Verschuren and Scott Hollenbeck for their careful 1617 review and valuable comments. 1619 11. Normative References 1621 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1622 Requirement Levels", BCP 14, RFC 2119, 1623 DOI 10.17487/RFC2119, March 1997, 1624 . 1626 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1627 DOI 10.17487/RFC3688, January 2004, 1628 . 1630 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1631 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1632 . 1634 [RFC5733] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1635 Contact Mapping", STD 69, RFC 5733, DOI 10.17487/RFC5733, 1636 August 2009, . 1638 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1639 Code: The Implementation Status Section", RFC 6982, 1640 DOI 10.17487/RFC6982, July 2013, 1641 . 1643 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1644 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1645 February 2015, . 1647 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 1648 Writing an IANA Considerations Section in RFCs", BCP 26, 1649 RFC 8126, DOI 10.17487/RFC8126, June 2017, 1650 . 1652 [W3C.REC-xml-20040204] 1653 Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and 1654 F. Yergeau, ""Extensible Markup Language (XML) 1.0 (Third 1655 Edition)", World Wide Web Consortium FirstEdition REC-xml- 1656 20040204", February 2004, 1657 . 1659 [W3C.REC-xmlschema-1-20041028] 1660 Thompson, H., Beech, D., Maloney, M., and N. Mendelsohn, 1661 ""XML Schema Part 1: Structures Second Edition", World 1662 Wide Web Consortium Recommendation REC-xmlschema- 1663 1-20041028", October 2004, 1664 . 1666 [W3C.REC-xmlschema-2-20041028] 1667 Biron, P. and A. Malhotra, ""XML Schema Part 2: Datatypes 1668 Second Edition", World Wide Web Consortium Recommendation 1669 REC-xmlschema-2-20041028", October 2004, 1670 . 1672 Appendix A. Change Log 1674 Initial -00: Individual document submitted. 1676 -01: 1678 * Updated abstract text. 1680 * Added sentences to avoid loop of parent identifiers in section 1681 3.4. 1683 * Revised typos in section 3.6. 1685 * Added explanation of contact type attribute in section 4.1.2. 1687 * Updated responses. 1689 * Deleted description of command in section 4.1 and 1690 4.2. 1692 * Deleted whoisInfo disclose type in XML schema. 1694 * Deleted maxOccurs of addRemType. 1696 * Deleted extra "OPTIONAL" in section 4.2.5. 1698 * Updated typos in response. 1700 -02: 1702 * Changed author information. 1704 * Updated url definition. 1706 * Updated XML schema. 1708 -03: 1710 * Changed author information. 1712 * Updated section 3.1. 1714 * Refactoried the XSD file. Added element. 1716 * Added acknowledgment. 1718 WG document-00: WG document submitted 1719 WG document-01: Keep document alive for further discussion. 1720 Reseller object or entity object with multiple roles? 1722 Organization WG document-00: Change to a generic organization object 1723 mapping. 1725 Organization WG document-01: Added "Implementation Status" section. 1727 Organization WG document-02: Accepted some of the feedbacks on the 1728 mailing list. 1730 Organization WG document-03: 1732 * Updated section 3.2, changed the structure of organization 1733 role. 1735 * Updated section 4.2.5 for the "add", "rem" and "chg" example. 1737 * Updated section 5 of formal syntax. 1739 * Updated section 7.2 for the registration template and initial 1740 values. 1742 * Updated section 8 of implementation status. 1744 Authors' Addresses 1746 Linlin Zhou 1747 CNNIC 1748 4 South 4th Street, Zhongguancun, Haidian District 1749 Beijing, Beijing 100190 1750 China 1752 Phone: +86 10 5881 2677 1753 Email: zhoulinlin@cnnic.cn 1755 Ning Kong 1756 CNNIC 1757 4 South 4th Street, Zhongguancun, Haidian District 1758 Beijing, Beijing 100190 1759 China 1761 Phone: +86 10 5881 3147 1762 Email: nkong@cnnic.cn 1763 Guiqing Zhou 1764 CNNIC 1765 4 South 4th Street, Zhongguancun, Haidian District 1766 Beijing, Beijing 100190 1767 China 1769 Phone: +86 10 5881 2692 1770 Email: zhouguiqing@cnnic.cn 1772 Xiaodong Lee 1773 CNNIC 1774 4 South 4th Street, Zhongguancun, Haidian District 1775 Beijing, Beijing 100190 1776 China 1778 Phone: +86 10 5881 3020 1779 Email: xl@cnnic.cn 1781 James Gould 1782 VeriSign, Inc. 1783 12061 Bluemont Way 1784 Reston, VA 20190 1785 US 1787 Email: jgould@verisign.com