idnits 2.17.1 draft-ietf-regext-org-05.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 7, 2018) is 2178 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 8, 2018 X. Lee 6 CNNIC 7 J. Gould 8 Verisign, Inc. 9 May 7, 2018 11 Extensible Provisioning Protocol (EPP) Organization Mapping 12 draft-ietf-regext-org-05 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 8, 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 9. Security Considerations . . . . . . . . . . . . . . . . . . . 36 105 10. Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . 37 106 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 37 107 11.1. Normative References . . . . . . . . . . . . . . . . . . 37 108 11.2. Informative References . . . . . . . . . . . . . . . . . 38 109 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 38 110 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 40 112 1. Introduction 114 There are many entities, such as registrars, resellers, DNS service 115 operators, or privacy proxies involved in the domain registration 116 business. These kind of entities have not been formally defined as 117 an object in EPP which will be specified as "organization" in this 118 document. 120 This document describes an organization object mapping for version 121 1.0 of the Extensible Provisioning Protocol (EPP) [RFC5730]. This 122 mapping is specified using the XML 1.0 as described in 123 [W3C.REC-xml-20040204] and XML Schema notation as described in 124 [W3C.REC-xmlschema-1-20041028] and [W3C.REC-xmlschema-2-20041028]. 126 2. Conventions Used in This Document 128 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 129 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 130 document are to be interpreted as described in [RFC2119]. 132 In examples, "C:" represents lines sent by a protocol client and "S:" 133 represents lines returned by a protocol server. Indentation and 134 white space in examples are provided only to illustrate element 135 relationships and are not a REQUIRED feature of this specification. 137 XML is case sensitive. Unless stated otherwise, XML specifications 138 and examples provided in this document MUST be interpreted in the 139 character case presented to develop a conforming implementation. 141 "org-1.0" in is used as an abbreviation for 142 "urn:ietf:params:xml:ns:org-1.0". The XML namespace prefix "org" is 143 used, but implementations MUST NOT depend on it and instead employ a 144 proper namespace-aware XML parser and serializer to interpret and 145 output the XML documents. 147 3. Object Attributes 149 An EPP organization object has attributes and associated values that 150 can be viewed and modified by the sponsoring client or the server. 151 This section describes each attribute type in detail. The formal 152 syntax for the attribute values described here can be found in the 153 "Formal Syntax" section of this document and in the appropriate 154 normative references. 156 3.1. Organization Identifier 158 All EPP organizations are identified by a server-unique identifier. 159 Organization identifiers are character strings with a specific 160 minimum length, a specified maximum length, and a specified format. 161 Organization identifiers use the "clIDType" client identifier syntax 162 described in [RFC5730]. Its corresponding element is . 164 3.2. Organization Roles 166 The organization roles are used to represent the relationship an 167 organization would have. Its corresponding element is . 169 3.2.1. Role Type 171 An organization would support a list of roles. See Section 7.3 for a 172 list of values. Its corresponding element is . 174 3.2.2. Role Status 176 A role of an organization object would have its own statuses. Its 177 corresponding element is . The values of the role status 178 are defined in Section 3.5. 180 3.2.3. Role Identifier 182 A role MAY have a third party assigned identifier such as the IANA ID 183 for registrars. Its corresponding element is . 185 Example of organization role identifier: 187 188 registrar 189 ok 190 linked 191 1362 192 194 3.3. Contact and Client Identifiers 196 All EPP contacts are identified by a server-unique identifier. 197 Contact identifiers are character strings with a specific minimum 198 length, a specified maximum length, and a specified format. Contact 199 identifiers use the "clIDType" client identifier syntax described in 200 [RFC5730]. 202 3.4. Organization Status Values 204 An organization object MUST always have at least one associated 205 status value. The default value is "ok". 207 Status values that can be added or removed by a client are prefixed 208 with "client". Corresponding status values that can be added or 209 removed by a server are prefixed with "server". The "hold" and 210 "terminated" status values are server-managed when the organization 211 has no parent identifier [Section 3.6] and otherwise MAY be client- 212 managed based on server policy. 214 Status Value Descriptions: 216 o ok: This is the normal status value for an object that has no 217 pending operations or prohibitions. This value is set and removed 218 by the server as other status values are added or removed. 220 o hold: Organization transform commands and new links MUST be 221 rejected. 223 o terminated: The organization which has been terminated MUST NOT be 224 linked. Organization transform commands and new links MUST be 225 rejected. 227 o linked: The organization object has at least one active 228 association with another object. The "linked" status is not 229 explicitly set by the client. Servers SHOULD provide services to 230 determine existing object associations. 232 o clientLinkProhibited, serverLinkProhibited: Requests to add new 233 links to the organization MUST be rejected. 235 o clientUpdateProhibited, serverUpdateProhibited: Requests to update 236 the object (other than to remove this status) MUST be rejected. 238 o clientDeleteProhibited, serverDeleteProhibited: Requests to delete 239 the object MUST be rejected. 241 o pendingCreate, pendingUpdate, pendingDelete: A transform command 242 has been processed for the object, but the action has not been 243 completed by the server. Server operators can delay action 244 completion for a variety of reasons, such as to allow for human 245 review or third-party action. A transform command that is 246 processed, but whose requested action is pending, is noted with 247 response code 1001. 249 "pendingCreate", "ok", "hold", and "terminated" are mutually 250 exclusive statuses. Organization MUST have only one of these 251 statuses set. 253 "ok" status MAY only be combined with "linked" status. 255 "pendingDelete" status MUST NOT be combined with either 256 "clientDeleteProhibited" or "serverDeleteProhibited" status. 258 The pendingCreate, pendingDelete, and pendingUpdate status values 259 MUST NOT be combined with each other. 261 3.5. Role Status Values 263 A role SHOULD have at least one associated status value. Valid 264 values include "ok", "linked", "clientLinkProhibited", and 265 "serverLinkProhibited". The default value is "ok". 267 Status Value Descriptions: 269 o ok: This is the normal status value for an role that has no 270 pending operations or prohibitions. This value is set and removed 271 by the server as other status values are added or removed. 273 o linked: The role of an organization object has at least one active 274 association with another object. The "linked" status is not 275 explicitly set by the client. Servers SHOULD provide services to 276 determine existing object associations. 278 o clientLinkProhibited, serverLinkProhibited: Requests to add new 279 links to the role MUST be rejected. 281 3.6. Parent Identifier 283 There can be more than one layer of organizations, such as a 284 reseller. The parent identifier, as defined with the 285 element, represents the parent organization identifier in a child 286 organization. 288 Take a reseller organization for example, the parent identifier is 289 not defined for the top level reseller, namely the registrar of the 290 registry. An N-tier reseller has a parent reseller and at least one 291 child reseller. A reseller customer has a parent reseller and no 292 child resellers. 294 Loops SHOULD be prohibited. If organization A has B as parent 295 identifier, organization B must not have organization A as parent 296 identifier. 298 3.7. URL 300 The URL represents the organization web home page, as defined with 301 the element. 303 3.8. Dates and Times 305 Date and time attribute values MUST be represented in Universal 306 Coordinated Time (UTC) using the Gregorian calendar. The extended 307 date-time form using upper case "T" and "Z" characters defined in 308 [W3C.REC-xmlschema-2-20041028] MUST be used to represent date-time 309 values, as XML Schema does not support truncated date-time forms or 310 lower case "T" and "Z" characters. 312 4. EPP Command Mapping 314 A detailed description of the EPP syntax and semantics can be found 315 in the EPP core protocol specification [RFC5730]. The command 316 mappings described here are specifically for use in provisioning and 317 managing organization information via EPP. 319 4.1. EPP Query Commands 321 EPP provides two commands to retrieve organization information: 322 to determine if an organization object can be provisioned 323 within a repository, and to retrieve detailed information 324 associated with an organization object. This document does not 325 define a mapping for the EPP command to retrieve 326 organization-object transfer status information.. 328 4.1.1. EPP Command 330 The EPP command is used to determine if an object can be 331 provisioned within a repository. It provides a hint that allows a 332 client to anticipate the success or failure of provisioning an object 333 using the command, as object-provisioning requirements are 334 ultimately a matter of server policy. 336 In addition to the standard EPP command elements, the command 337 MUST contain a element that identifies the organization 338 namespace. The element contains the following child 339 elements: 341 o One or more elements that contain the server-unique 342 identifier of the organization objects to be queried. 344 Example command: 346 C: 347 C: 348 C: 349 C: 350 C: 352 C: res1523 353 C: re1523 354 C: 1523res 355 C: 356 C: 357 C: ABC-12345 358 C: 359 C: 361 When a command has been processed successfully, the EPP 362 element MUST contain a child element that 363 identifies the organization namespace. The element 364 contains one or more elements that contain the following 365 child elements: 367 o A element that identifies the queried object. This 368 element MUST contain an "avail" attribute whose value indicates 369 object availability (can it be provisioned or not) at the moment 370 the command was completed. A value of "1" or "true" means 371 that the object can be provisioned. A value of "0" or "false" 372 means that the object cannot be provisioned. 374 o An OPTIONAL element that MAY be provided when an 375 object cannot be provisioned. If present, this element contains 376 server-specific text to help explain why the object cannot be 377 provisioned. This text MUST be represented in the response 378 language previously negotiated with the client; an OPTIONAL "lang" 379 attribute MAY be present to identify the language if the 380 negotiated value is something other than the default value of 381 "en"(English). 383 Example response: 385 S: 386 S: 387 S: 388 S: 389 S: Command completed successfully 390 S: 391 S: 392 S: 394 S: 395 S: res1523 396 S: 397 S: 398 S: re1523 399 S: In use 400 S: 401 S: 402 S: 1523res 403 S: 404 S: 405 S: 406 S: 407 S: ABC-12345 408 S: 54322-XYZ 409 S: 410 S: 411 S: 413 An EPP error response MUST be returned if a command cannot be 414 processed for any reason. 416 4.1.2. EPP Command 418 The EPP command is used to retrieve information associated 419 with an organization object. In addition to the standard EPP command 420 elements, the command MUST contain a element that 421 identifies the organization namespace. The element 422 contains the following child elements: 424 o A element that contains the server-unique identifier of 425 the organization object to be queried. 427 Example command: 429 C: 430 C: 431 C: 432 C: 433 C: 435 C: res1523 436 C: 437 C: 438 C: ABC-12345 439 C: 440 C: 442 When an command has been processed successfully, the EPP 443 element MUST contain a child element that 444 identifies the organization namespace. The element 445 contains the following child elements: 447 o A element that contains the server-unique identifier of 448 the organization object, as defined in Section 3.1. 450 o A element that contains the Repository Object 451 IDentifier assigned to the organization object when the object was 452 created. 454 o One or more elements that contains the role type, role 455 statuses and optional role id of the organization. 457 * A element that contains the type of the 458 organization, as defined in Section 3.2. 460 * One or more elements that contains the role 461 statuses. The values of the role status are defined in 462 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 703 statuses. The values of the role status are defined in 704 Section 3.5. 706 * An OPTIONAL element that contains a third party 707 assigned identifier, such as IANA ID for registrars, as defined 708 in Section 3.2.3. 710 o Zero of more element that contains the operational 711 status of the organization, as defined in Section 3.4. 713 o An OPTIONAL element that contains the identifier of 714 the parent object, as defined in Section 3.6. 716 o Zero to two elements that contain postal-address 717 information. Two elements are provided so that address 718 information can be provided in both internationalized and 719 localized forms; a "type" attribute is used to identify the two 720 forms. If an internationalized form (type="int") is provided, 721 element content MUST be represented in a subset of UTF-8 that can 722 be represented in the 7-bit US-ASCII character set. If a 723 localized form (type="loc") is provided, element content MAY be 724 represented in unrestricted UTF-8. The element 725 contains the following child elements: 727 * A element that contains the name of the 728 organization. 730 * A element that contains address information 731 associated with the organization. A element 732 contains the following child elements: 734 + One, two, or three OPTIONAL elements that 735 contain the organization's street address. 737 + A element that contains the organization's city. 739 + An OPTIONAL element that contains the 740 organization's state or province. 742 + An OPTIONAL element that contains the 743 organization's postal code. 745 + A element that contains the organization's country 746 code. 748 o An OPTIONAL element that contains the organization's 749 voice telephone number. 751 o An OPTIONAL element that contains the organization's 752 facsimile telephone number. 754 o An OPTIONAL element that contains the organization's 755 email address. 757 o An OPTIONAL element that contains the URL to the website 758 of the organization. 760 o Zero or more OPTIONAL elements that contain 761 identifiers for the contact objects associated with the 762 organization object. 764 Example command: 766 C: 767 C: 768 C: 769 C: 770 C: 772 C: res1523 773 C: 774 C: reseller 775 C: 776 C: 1523res 777 C: 778 C: Example Organization Inc. 779 C: 780 C: 123 Example Dr. 781 C: Suite 100 782 C: Dulles 783 C: VA 784 C: 20166-6503 785 C: US 786 C: 787 C: 788 C: +1.7035555555 789 C: +1.7035555556 790 C: contact@organization.example 791 C: http://organization.example 792 C: sh8013 793 C: sh8013 794 C: 795 C: 796 C: ABC-12345 797 C: 798 C: 800 When a command has been processed successfully, the EPP 801 element MUST contain a child element that 802 identifies the organization namespace. The element 803 contains the following child elements: 805 o A element that contains the server-unique identifier for 806 the created organization, as defined in Section 3.1. 808 o A element that contains the date and time of 809 organization-object creation. 811 Example response: 813 S: 814 S: 815 S: 816 S: 817 S: Command completed successfully 818 S: 819 S: 820 S: 822 S: res1523 823 S: 1999-04-03T22:00:00.0Z 824 S: 825 S: 826 S: 827 S: ABC-12345 828 S: 54321-XYZ 829 S: 830 S: 831 S: 833 An EPP error response MUST be returned if a command cannot 834 be processed for any reason. 836 4.2.2. EPP Command 838 The EPP command provides a transform operation that allows a 839 client to delete an organization object. In addition to the standard 840 EPP command elements, the command MUST contain a 841 element that identifies the organization namespace. The 842 element MUST contain the following child element: 844 o A element that contains the server-unique identifier of 845 the organization object to be deleted, as defined in Section 3.1. 847 An organization object MUST NOT be deleted if it is associated with 848 other known objects. An associated organization MUST NOT be deleted 849 until associations with other known objects have been broken. A 850 server MUST notify clients that object relationships exist by sending 851 a 2305 error response code when a command is attempted and 852 fails due to existing object relationships. 854 Example command: 856 C: 857 C: 858 C: 859 C: 860 C: 862 C: res1523 863 C: 864 C: 865 C: ABC-12345 866 C: 867 C: 869 When a command has been processed successfully, a server 870 MUST respond with an EPP response with no element. 872 Example response: 874 S: 875 S: 876 S: 877 S: 878 S: Command completed successfully 879 S: 880 S: 881 S: ABC-12345 882 S: 54321-XYZ 883 S: 884 S: 885 S: 887 An EPP error response MUST be returned if a command cannot 888 be processed for any reason. 890 4.2.3. EPP Command 892 Renewal semantics do not apply to organization objects, so there is 893 no mapping defined for the EPP command. 895 4.2.4. EPP Command 897 Transfer semantics do not apply to organization objects, so there is 898 no mapping defined for the EPP command. 900 4.2.5. EPP Command 902 The EPP command provides a transform operation that allows a 903 client to modify the attributes of an organization object. In 904 addition to the standard EPP command elements, the command 905 MUST contain a element that identifies the organization 906 namespace. The element contains the following child 907 elements: 909 o A element that contains the server-unique identifier of 910 the organization object to be updated, as defined in Section 3.1. 912 o An OPTIONAL element that contains attribute values to be 913 added to the object. 915 o An OPTIONAL element that contains attribute values to be 916 removed from the object. 918 o An OPTIONAL element that contains attribute values to be 919 changed. 921 At least one , or element MUST be 922 provided if the command is not being extended. All of these elements 923 MAY be omitted if an extension is present. The OPTIONAL 924 and elements contain the following child element: 926 o Zero or more elements that contain the identifiers 927 for contact objects to be associated with or removed from the 928 organization object. Contact object identifiers MUST be known to 929 the server before the contact object can be associated with the 930 organization object. 932 o Zero or more elements that contains the role type, role 933 statuses and optional role id of the organization. 935 * A element that contains the type of the 936 organization, as defined in Section 3.2. 938 * Zero or more elements that contains the role 939 statuses. The values of the role status are defined in 940 Section 3.5. 942 * An OPTIONAL element that contains a third party 943 assigned identifier, such as IANA ID for registrars, as defined 944 in Section 3.2.3. 946 o Zero or more element that contains the operational 947 status of the organization. 949 An OPTIONAL element contains the following child elements, 950 where at least one child element MUST be present: 952 o An OPTIONAL element that contains the identifier of 953 the parent object. 955 o Zero to two elements that contain postal-address 956 information. Two elements are provided so that address 957 information can be provided in both internationalized and 958 localized forms; a "type" attribute is used to identify the two 959 forms. If an internationalized form (type="int") is provided, 960 element content MUST be represented in a subset of UTF-8 that can 961 be represented in the 7-bit US-ASCII character set. If a 962 localized form (type="loc") is provided, element content MAY be 963 represented in unrestricted UTF-8. The change of the postal info 964 is defined as a replacement of that postal info element with the 965 contents of the sub-elements included in the update command. An 966 empty element is supported to allow a type of 967 postal info to be removed. The element contains 968 the following child elements: 970 * A element that contains the name of the 971 organization. 973 * A element that contains address information 974 associated with the organization. A element 975 contains the following child elements: 977 + One, two, or three OPTIONAL elements that 978 contain the organization's street address. 980 + A element that contains the organization's city. 982 + An OPTIONAL element that contains the 983 organization's state or province. 985 + An OPTIONAL element that contains the 986 organization's postal code. 988 + A element that contains the organization's country 989 code. 991 o An OPTIONAL element that contains the organization's 992 voice telephone number. 994 o An OPTIONAL element that contains the organization's 995 facsimile telephone number. 997 o An OPTIONAL element that contains the organization's 998 email address. 1000 o An OPTIONAL element that contains the URL to the website 1001 of the organization. 1003 Example command: 1005 C: 1006 C: 1007 C: 1008 C: 1009 C: 1011 C: res1523 1012 C: 1013 C: sh8013 1014 C: 1015 C: privacyproxy 1016 C: clientLinkProhibited 1017 C: 1018 C: clientLinkProhibited 1019 C: 1020 C: 1021 C: sh8014 1022 C: 1023 C: reseller 1024 C: clientDeleteProhibited 1025 C: 1026 C: 1027 C: 1028 C: 1029 C: 1030 C: 124 Example Dr. 1031 C: Suite 200 1032 C: Dulles 1033 C: VA 1034 C: 20166-6503 1035 C: US 1036 C: 1037 C: 1038 C: +1.7034444444 1039 C: 1040 C: 1041 C: 1042 C: 1043 C: ABC-12345 1044 C: 1045 C: 1047 When an command has been processed successfully, a server 1048 MUST respond with an EPP response with no element. 1050 Example response: 1052 S: 1053 S: 1054 S: 1055 S: 1056 S: Command completed successfully 1057 S: 1058 S: 1059 S: ABC-12345 1060 S: 54321-XYZ 1061 S: 1062 S: 1063 S: 1065 An EPP error response MUST be returned if an command cannot 1066 be processed for any reason. 1068 5. Formal Syntax 1070 An EPP object mapping is specified in XML Schema notation. The 1071 formal syntax presented here is a complete schema representation of 1072 the object mapping suitable for automated validation of EPP XML 1073 instances. The BEGIN and END tags are not part of the schema; they 1074 are used to note the beginning and ending of the schema for URI 1075 registration purposes. 1077 BEGIN 1078 1080 1087 1090 1091 1093 1094 1095 Extensible Provisioning Protocol v1.0 1096 organization provisioning schema. 1097 1098 1100 1103 1104 1105 1106 1107 1109 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1130 1131 1132 1133 1134 1135 1136 1137 1139 1140 1141 1142 1144 1145 1146 1147 1148 1149 1151 1153 1154 1157 1159 1160 1161 1162 1164 1165 1166 1167 1169 1170 1171 1172 1173 1174 1175 1176 1177 1179 1180 1181 1182 1183 1184 1185 1187 1188 1189 1190 1191 1192 1194 1195 1196 1197 1198 1199 1201 1202 1203 1204 1205 1207 1208 1209 1210 1211 1213 1214 1215 1216 1217 1219 1220 1221 1223 1224 1226 1228 1229 1230 1232 1233 1234 1235 1236 1237 1239 1242 1243 1244 1245 1246 1248 1251 1252 1253 1255 1256 1258 1261 1262 1263 1265 1266 1268 1271 1272 1273 1275 1277 1279 1281 1283 1285 1287 1289 1292 1295 1296 1298 1301 1302 1303 1305 1307 1309 1311 1312 1314 1317 1318 1319 1321 1323 1325 1326 1328 1331 1332 1333 1335 1338 1341 1343 1345 1347 1348 1350 1351 1352 1354 1356 1357 1359 1361 1364 1365 1366 1368 1371 1372 1373 1375 1376 1378 1379 1380 1381 1383 1384 1386 1387 1388 1389 1391 1392 1393 1395 1398 1399 1400 1402 1404 1406 1408 1410 1412 1414 1416 1418 1420 1422 1424 1426 1428 1430 1432 1433 1434 1437 1438 1439 1440 1441 1442 1443 1446 1447 END 1449 6. Internationalization Considerations 1451 EPP is represented in XML, which provides native support for encoding 1452 information using the Unicode character set and its more compact 1453 representations including UTF-8. Conformant XML processors recognize 1454 both UTF-8 and UTF-16. Though XML includes provisions to identify 1455 and use other character encodings through use of an "encoding" 1456 attribute in an declaration, use of UTF-8 is RECOMMENDED. 1458 As an extension of the EPP organization object mapping, the elements 1459 and element content described in this document MUST inherit the 1460 internationalization conventions used to represent higher-layer 1461 domain and core protocol structures present in an XML instance that 1462 includes this extension. 1464 7. IANA Considerations 1466 7.1. XML Namespace 1468 This document uses URNs to describe XML namespaces and XML schemas 1469 conforming to a registry mechanism described in [RFC3688]. IANA is 1470 requested to assignment the following URI. 1472 Registration request for the organization namespace: 1474 URI: urn:ietf:params:xml:ns:org-1.0 1476 Registrant Contact: See the "Author's Address" section of this 1477 document. 1479 XML: None. Namespace URIs do not represent an XML specification. 1481 Registration request for the organization XML schema: 1483 URI: urn:ietf:params:xml:ns:org-1.0 1484 Registrant Contact: See the "Author's Address" section of this 1485 document. 1487 XML: See the "Formal Syntax" section of this document. 1489 7.2. EPP Extension Registry 1491 The EPP extension described in this document should be registered by 1492 the IANA in the EPP Extension Registry described in [RFC7451]. The 1493 details of the registration are as follows: 1495 Name of Extension: Organization Object Extension 1497 Document status: Standards Track 1499 Reference: (insert reference to RFC version of this document) 1501 Registrant Name and Email Address: IESG 1503 TLDs: any 1505 IPR Disclosure: none 1507 Status: active 1509 Notes: none 1511 7.3. Role Values Registry 1513 The following values should be registered by the IANA in the "EPP 1514 Organization Role Values" registry. The registration policy for this 1515 registry is "Expert Review" [RFC8126]. 1517 7.3.1. Registration Template 1519 Value: the string value being registered. 1521 Description: Brief description of the organization role values. 1523 Registrant Name: For Standards Track RFCs, state "IESG". For others, 1524 give the name of the responsible party. 1526 Registrant Contact Information: an email address, postal address, or 1527 some other information to be used to contact the registrant. 1529 7.3.2. Initial Registry Contents 1531 Followings are the initial registry contents: 1533 Value: registrar 1535 Description: The entity object instance represents the authority 1536 responsible for the registration in the registry. 1538 Registrant Name: IESG 1540 Registrant Contact Information: iesg@ietf.org 1542 Value: reseller 1544 Description: The entity object instance represents a third party 1545 through which the registration was conducted (i.e., not the 1546 registry or registrar). 1548 Registrant Name: IESG 1550 Registrant Contact Information: iesg@ietf.org 1552 Value: privacyproxy 1554 Description: The entity object instance represents a third-party 1555 who could help to register a domain without exposing the 1556 registrants' private information.. 1558 Registrant Name: IESG 1560 Registrant Contact Information: iesg@ietf.org 1562 8. Implementation Status 1564 Note to RFC Editor: Please remove this section and the reference to 1565 [RFC7942] before publication. This section records the status of 1566 known implementations of the protocol defined by this specification 1567 at the time of posting of this Internet-Draft, and is based on a 1568 proposal described in [RFC7942]. The description of implementations 1569 in this section is intended to assist the IETF in its decision 1570 processes in progressing drafts to RFCs. Please note that the 1571 listing of any individual implementation here does not imply 1572 endorsement by the IETF. Furthermore, no effort has been spent to 1573 verify the information presented here that was supplied by IETF 1574 contributors. This is not intended as, and must not be construed to 1575 be, a catalog of available implementations or their features. 1576 Readers are advised to note that other implementations may exist. 1578 According to [RFC7942], "this will allow reviewers and working groups 1579 to assign due consideration to documents that have the benefit of 1580 running code, which may serve as evidence of valuable experimentation 1581 and feedback that have made the implemented protocols more mature. 1582 It is up to the individual working groups to use this information as 1583 they see fit". 1585 8.1. Verisign EPP SDK 1587 Organization: Verisign Inc. 1589 Name: Verisign EPP SDK 1591 Description: The Verisign EPP SDK includes both a full client 1592 implementation and a full server stub implementation of draft-ietf- 1593 regext-org. 1595 Level of maturity: Development 1597 Coverage: All aspects of the protocol are implemented. 1599 Licensing: GNU Lesser General Public License 1601 Contact: jgould@verisign.com 1603 URL: https://www.verisign.com/en_US/channel-resources/domain- 1604 registry-products/epp-sdks 1606 8.2. CNNIC Implementation 1608 Organization: CNNIC 1610 Name: EPP Organization Mapping 1612 Description: CNNIC is trying to update EPP organization mapping from 1613 previous reseller mapping according to this document. 1615 Level of maturity: Development 1617 Coverage: EPP organization mapping 1619 Contact: zhouguiqing@cnnic.cn 1621 9. Security Considerations 1623 The object mapping extension described in this document does not 1624 provide any other security services or introduce any additional 1625 considerations beyond those described by [RFC5730] or those caused by 1626 the protocol layers used by EPP. The security considerations 1627 described in these other specifications apply to this specification 1628 as well. 1630 10. Acknowledgment 1632 The authors would like to thank Rik Ribbers, Marc Groeneweg, Patrick 1633 Mevzek, Antoin Verschuren and Scott Hollenbeck for their careful 1634 review and valuable comments. 1636 11. References 1638 11.1. Normative References 1640 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1641 Requirement Levels", BCP 14, RFC 2119, 1642 DOI 10.17487/RFC2119, March 1997, 1643 . 1645 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1646 DOI 10.17487/RFC3688, January 2004, 1647 . 1649 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1650 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1651 . 1653 [RFC7942] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1654 Code: The Implementation Status Section", BCP 205, 1655 RFC 7942, DOI 10.17487/RFC7942, July 2016, 1656 . 1658 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 1659 Writing an IANA Considerations Section in RFCs", BCP 26, 1660 RFC 8126, DOI 10.17487/RFC8126, June 2017, 1661 . 1663 [W3C.REC-xml-20040204] 1664 Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and 1665 F. Yergeau, ""Extensible Markup Language (XML) 1.0 (Third 1666 Edition)", World Wide Web Consortium FirstEdition REC-xml- 1667 20040204", February 2004, 1668 . 1670 [W3C.REC-xmlschema-1-20041028] 1671 Thompson, H., Beech, D., Maloney, M., and N. Mendelsohn, 1672 ""XML Schema Part 1: Structures Second Edition", World 1673 Wide Web Consortium Recommendation REC-xmlschema- 1674 1-20041028", October 2004, 1675 . 1677 [W3C.REC-xmlschema-2-20041028] 1678 Biron, P. and A. Malhotra, ""XML Schema Part 2: Datatypes 1679 Second Edition", World Wide Web Consortium Recommendation 1680 REC-xmlschema-2-20041028", October 2004, 1681 . 1683 11.2. Informative References 1685 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1686 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1687 February 2015, . 1689 Appendix A. Change Log 1691 Initial -00: Individual document submitted. 1693 -01: 1695 * Updated abstract text. 1697 * Added sentences to avoid loop of parent identifiers in section 1698 3.4. 1700 * Revised typos in section 3.6. 1702 * Added explanation of contact type attribute in section 4.1.2. 1704 * Updated responses. 1706 * Deleted description of command in section 4.1 and 1707 4.2. 1709 * Deleted whoisInfo disclose type in XML schema. 1711 * Deleted maxOccurs of addRemType. 1713 * Deleted extra "OPTIONAL" in section 4.2.5. 1715 * Updated typos in response. 1717 -02: 1719 * Changed author information. 1721 * Updated url definition. 1723 * Updated XML schema. 1725 -03: 1727 * Changed author information. 1729 * Updated section 3.1. 1731 * Refactoried the XSD file. Added element. 1733 * Added acknowledgment. 1735 WG document-00: WG document submitted 1737 WG document-01: Keep document alive for further discussion. 1738 Reseller object or entity object with multiple roles? 1740 Organization WG document-00: Change to a generic organization object 1741 mapping. 1743 Organization WG document-01: Added "Implementation Status" section. 1745 Organization WG document-02: Accepted some of the feedbacks on the 1746 mailing list. 1748 Organization WG document-03: 1750 * Updated section 3.2, changed the structure of organization 1751 role. 1753 * Updated section 4.2.5 for the "add", "rem" and "chg" example. 1755 * Updated section 5 of formal syntax. 1757 * Updated section 7.2 for the registration template and initial 1758 values. 1760 * Updated section 8 of implementation status. 1762 Organization WG document-04: 1764 * Updated section 3.2, changed the structure of organization 1765 role. 1767 * Updated references. 1769 * Updated section 8 of implementation status. 1771 Organization WG document-05: 1773 * Updated the description of of a role. 1775 * Removed the third paragraph of "Implementation Status". 1777 * Remove the Informative Reference to draft-ietf-regext-reseller 1778 from the draft. 1780 Authors' Addresses 1782 Linlin Zhou 1783 CNNIC 1784 4 South 4th Street, Zhongguancun, Haidian District 1785 Beijing, Beijing 100190 1786 China 1788 Phone: +86 10 5881 2677 1789 Email: zhoulinlin@cnnic.cn 1791 Ning Kong 1792 CNNIC 1793 4 South 4th Street, Zhongguancun, Haidian District 1794 Beijing, Beijing 100190 1795 China 1797 Phone: +86 10 5881 3147 1798 Email: nkong@cnnic.cn 1800 Guiqing Zhou 1801 CNNIC 1802 4 South 4th Street, Zhongguancun, Haidian District 1803 Beijing, Beijing 100190 1804 China 1806 Phone: +86 10 5881 2692 1807 Email: zhouguiqing@cnnic.cn 1808 Xiaodong Lee 1809 CNNIC 1810 4 South 4th Street, Zhongguancun, Haidian District 1811 Beijing, Beijing 100190 1812 China 1814 Phone: +86 10 5881 3020 1815 Email: xl@cnnic.cn 1817 James Gould 1818 Verisign, Inc. 1819 12061 Bluemont Way 1820 Reston, VA 20190 1821 US 1823 Email: jgould@verisign.com