--- 1/draft-ietf-regext-org-08.txt 2018-08-19 20:13:23.495556467 -0700 +++ 2/draft-ietf-regext-org-09.txt 2018-08-19 20:13:23.571558306 -0700 @@ -1,22 +1,24 @@ Internet Engineering Task Force L. Zhou -Internet-Draft N. Kong -Intended status: Standards Track G. Zhou -Expires: January 3, 2019 X. Lee +Internet-Draft CNNIC +Intended status: Standards Track N. Kong +Expires: February 21, 2019 Consultant + G. Zhou + J. Yao CNNIC J. Gould Verisign, Inc. - July 2, 2018 + August 20, 2018 Extensible Provisioning Protocol (EPP) Organization Mapping - draft-ietf-regext-org-08 + draft-ietf-regext-org-09 Abstract This document describes an Extensible Provisioning Protocol (EPP) mapping for provisioning and management of organization objects stored in a shared central repository. Specified in Extensible Markup Language (XML), this extended mapping is applied to provide additional features required for the provisioning of organizations. Status of This Memo @@ -27,69 +29,57 @@ Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." - This Internet-Draft will expire on January 3, 2019. + This Internet-Draft will expire on February 21, 2019. Copyright Notice Copyright (c) 2018 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. - This document may contain material from IETF Documents or IETF - Contributions published or made publicly available before November - 10, 2008. The person(s) controlling the copyright in some of this - material may not have granted the IETF Trust the right to allow - modifications of such material outside the IETF Standards Process. - Without obtaining an adequate license from the person(s) controlling - the copyright in such materials, this document may not be modified - outside the IETF Standards Process, and derivative works of it may - not be created outside the IETF Standards Process, except to format - it for publication as an RFC or to translate it into languages other - than English. - Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Conventions Used in This Document . . . . . . . . . . . . . . 3 - 3. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 4 + 3. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 3 3.1. Organization Identifier . . . . . . . . . . . . . . . . . 4 3.2. Organization Roles . . . . . . . . . . . . . . . . . . . 4 3.2.1. Role Type . . . . . . . . . . . . . . . . . . . . . . 4 3.2.2. Role Status . . . . . . . . . . . . . . . . . . . . . 4 3.2.3. Role Identifier . . . . . . . . . . . . . . . . . . . 4 3.3. Contact and Client Identifiers . . . . . . . . . . . . . 5 3.4. Organization Status Values . . . . . . . . . . . . . . . 5 3.5. Role Status Values . . . . . . . . . . . . . . . . . . . 6 3.6. Parent Identifier . . . . . . . . . . . . . . . . . . . . 7 3.7. URL . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 3.8. Dates and Times . . . . . . . . . . . . . . . . . . . . . 7 4. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 7 4.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 7 4.1.1. EPP Command . . . . . . . . . . . . . . . . . 8 - 4.1.2. EPP Command . . . . . . . . . . . . . . . . . 10 + 4.1.2. EPP Command . . . . . . . . . . . . . . . . . 9 4.1.3. EPP Query Command . . . . . . . . . . . . 15 4.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 15 4.2.1. EPP Command . . . . . . . . . . . . . . . . 15 4.2.2. EPP Command . . . . . . . . . . . . . . . . 19 4.2.3. EPP Command . . . . . . . . . . . . . . . . . 20 4.2.4. EPP Command . . . . . . . . . . . . . . . 20 4.2.5. EPP Command . . . . . . . . . . . . . . . . 21 4.3. Offline Review of Requested Actions . . . . . . . . . . . 25 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 27 6. Internationalization Considerations . . . . . . . . . . . . . 36 @@ -101,56 +91,56 @@ 7.3.2. Initial Registry Contents . . . . . . . . . . . . . . 37 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 38 8.1. Verisign EPP SDK . . . . . . . . . . . . . . . . . . . . 39 8.2. CNNIC Implementation . . . . . . . . . . . . . . . . . . 39 9. Security Considerations . . . . . . . . . . . . . . . . . . . 39 10. Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . 40 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 40 11.1. Normative References . . . . . . . . . . . . . . . . . . 40 11.2. Informative References . . . . . . . . . . . . . . . . . 41 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 41 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 43 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 44 1. Introduction There are many entities, such as registrars, resellers, DNS service operators, or privacy proxies involved in the domain registration business. These kind of entities have not been formally defined as an object in EPP which will be specified as "organization" in this document. This document describes an organization object mapping for version 1.0 of the Extensible Provisioning Protocol (EPP) [RFC5730]. This mapping is specified using the XML 1.0 as described in [W3C.REC-xml-20040204] and XML Schema notation as described in [W3C.REC-xmlschema-1-20041028] and [W3C.REC-xmlschema-2-20041028]. 2. Conventions Used in This Document The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this - document are to be interpreted as described in [RFC2119]. + document are to be interpreted as described in BCP 14 + [RFC2119][RFC8174] when, and only when, they appear in all capitals, + as shown here. In examples, "C:" represents lines sent by a protocol client and "S:" represents lines returned by a protocol server. Indentation and white space in examples are provided only to illustrate element - relationships and are not a REQUIRED feature of this specification. + relationships and are not a required feature of this specification. XML is case sensitive. Unless stated otherwise, XML specifications and examples provided in this document MUST be interpreted in the character case presented to develop a conforming implementation. - "org-1.0" in is used as an abbreviation for - "urn:ietf:params:xml:ns:org-1.0". The XML namespace prefix "org" is - used, but implementations MUST NOT depend on it and instead employ a - proper namespace-aware XML parser and serializer to interpret and - output the XML documents. + The XML namespace prefix "org" is used, but implementations MUST NOT + depend on it and instead employ a proper namespace-aware XML parser + and serializer to interpret and output the XML documents. 3. Object Attributes An EPP organization object has attributes and associated values that can be viewed and modified by the sponsoring client or the server. This section describes each attribute type in detail. The formal syntax for the attribute values described here can be found in the "Formal Syntax" section of this document and in the appropriate normative references. @@ -166,57 +156,57 @@ The organization roles are used to represent the relationship an organization could have. Its corresponding element is . An organization object MUST always have at least one associated role. Roles can be set only by the client that sponsors an organization object. A client can change the role of an organization object using the EPP command. 3.2.1. Role Type - An organization role MUST have a type which support a list of values. - An organization could have multiple roles with a different role type. - See Section 7.3 for a list of values. Its corresponding element is - . + An organization role MUST have a type which supports a list of + values. An organization could have multiple roles with a different + role type. See Section 7.3 for a list of values. Its corresponding + element is . 3.2.2. Role Status A role of an organization object MAY have its own statuses. Its corresponding element is . The values of the role status are defined in Section 3.5. 3.2.3. Role Identifier - A role MAY have a third party assigned identifier such as the IANA ID - for registrars. Its corresponding element is . + A role MAY have a third-party-assigned identifier such as the IANA ID + for registrars. Its corresponding element is . Example of organization role identifier: registrar ok linked - 1362 + 1362 3.3. Contact and Client Identifiers All EPP contacts are identified by a server-unique identifier. - Contact identifiers are character strings with a specific minimum + Contact identifiers are character strings with a specified minimum length, a specified maximum length, and a specified format. Contact identifiers use the "clIDType" client identifier syntax described in [RFC5730]. 3.4. Organization Status Values An organization object MUST always have at least one associated - status value. The default value is "ok". + status value. Status values that can be added or removed by a client are prefixed with "client". Corresponding status values that can be added or removed by a server are prefixed with "server". The "hold" and "terminated" status values are server-managed when the organization has no parent identifier [Section 3.6] and otherwise MAY be client- managed based on server policy. Status Value Descriptions: @@ -226,21 +216,21 @@ o hold: Organization transform commands and new links MUST be rejected. o terminated: The organization which has been terminated MUST NOT be linked. Organization transform commands and new links MUST be rejected. o linked: The organization object has at least one active association with another object. The "linked" status is not - explicitly set by the client. Servers SHOULD provide services to + explicitly set by the client. Servers should provide services to determine existing object associations. o clientLinkProhibited, serverLinkProhibited: Requests to add new links to the organization MUST be rejected. o clientUpdateProhibited, serverUpdateProhibited: Requests to update the object (other than to remove this status) MUST be rejected. o clientDeleteProhibited, serverDeleteProhibited: Requests to delete the object MUST be rejected. @@ -266,21 +256,21 @@ "pendingDelete" status MUST NOT be combined with either "clientDeleteProhibited" or "serverDeleteProhibited" status. The pendingCreate, pendingDelete, and pendingUpdate status values MUST NOT be combined with each other. 3.5. Role Status Values A role SHOULD have at least one associated status value. Valid values include "ok", "linked", "clientLinkProhibited", and - "serverLinkProhibited". The default value is "ok". + "serverLinkProhibited". Status Value Descriptions: o ok: This is the normal status value for an role that has no pending operations or prohibitions. This value is set and removed by the server as other status values are added or removed. o linked: The role of an organization object has at least one active association with another object. The "linked" status is not explicitly set by the client. Servers SHOULD provide services to @@ -289,29 +279,30 @@ o clientLinkProhibited, serverLinkProhibited: Requests to add new links to the role MUST be rejected. 3.6. Parent Identifier There can be more than one layer of organizations, such as a reseller. The parent identifier, as defined with the element, represents the parent organization identifier in a child organization. - Take a reseller organization for example, the parent identifier is + Take a reseller organization, for example, the parent identifier is not defined for the top level reseller, namely the registrar of the registry. An N-tier reseller has a parent reseller and at least one child reseller. A reseller customer has a parent reseller and no child resellers. - Loops SHOULD be prohibited. If organization A has B as parent - identifier, organization B must not have organization A as parent - identifier. + Loops SHOULD be prohibited. For example: if organization A has B as + its parent identifier, organization B should not have organization A + as its parent identifier. The same is true for larger loops + involving three or more organizations. 3.7. URL The URL represents the organization web home page, as defined with the element. 3.8. Dates and Times Date and time attribute values MUST be represented in Universal Coordinated Time (UTC) using the Gregorian calendar. The extended @@ -338,23 +329,23 @@ 4.1.1. EPP Command The EPP command is used to determine if an object can be provisioned within a repository. It provides a hint that allows a client to anticipate the success or failure of provisioning an object using the command, as object-provisioning requirements are ultimately a matter of server policy. In addition to the standard EPP command elements, the command - MUST contain a element that identifies the organization - namespace. The element contains the following child - elements: + MUST contain an element. This element or its ancestor + element MUST identify the organization namespace. The + ement contains the following child elements: o One or more elements that contain the server-unique identifier of the organization objects to be queried. Example command: C: C: C: C: @@ -363,58 +354,58 @@ C: res1523 C: re1523 C: 1523res C: C: C: ABC-12345 C: C: When a command has been processed successfully, the EPP - element MUST contain a child element that - identifies the organization namespace. The element - contains one or more elements that contain the following - child elements: + element MUST contain a child element. This + element or its ancestor element MUST identify the organization + namespace. The element contains one or more + elements that contain the following child elements: - o A element that identifies the queried object. This + o An element that identifies the queried object. This element MUST contain an "avail" attribute whose value indicates object availability (can it be provisioned or not) at the moment the command was completed. A value of "1" or "true" means that the object can be provisioned. A value of "0" or "false" means that the object cannot be provisioned. - o An OPTIONAL element that MAY be provided when an + o An OPTIONAL element that may be provided when an object cannot be provisioned. If present, this element contains server-specific text to help explain why the object cannot be provisioned. This text MUST be represented in the response language previously negotiated with the client; an OPTIONAL "lang" attribute MAY be present to identify the language if the negotiated value is something other than the default value of "en"(English). Example response: S: S: S: S: - S: Command completed successfully + S: Command completed successfully S: S: S: S: S: res1523 S: S: S: re1523 - S: In use + S: In use S: S: S: 1523res S: S: S: S: S: ABC-12345 S: 54322-XYZ S: @@ -423,108 +414,110 @@ An EPP error response MUST be returned if a command cannot be processed for any reason. 4.1.2. EPP Command The EPP command is used to retrieve information associated with an organization object. It is up to the server policy to decide what attributes will be returned of an organization object. In addition to the standard EPP command elements, the command - MUST contain a element that identifies the organization - namespace. The element contains the following child - elements: + MUST contain a element. This element or its ancestor + element MUST identify the organization namespace. The + element contains the following child elements: - o A element that contains the server-unique identifier of + o An element that contains the server-unique identifier of the organization object to be queried. Example command: C: C: C: C: C: C: res1523 C: C: C: ABC-12345 C: C: When an command has been processed successfully, the EPP - element MUST contain a child element that - identifies the organization namespace. The element - contains the following child elements: + element MUST contain a child element. This + element or its ancestor element MUST identify the organization + namespace. The element contains the following child + elements: - o A element that contains the server-unique identifier of + o An element that contains the server-unique identifier of the organization object, as defined in Section 3.1. - o A element that contains the Repository Object + o An element that contains the Repository Object IDentifier assigned to the organization object when the object was created. - o One or more elements that contains the role type, role + o One or more elements that contain the role type, role statuses and optional role id of the organization. - * A element that contains the type of the + * An element that contains the type of the organization, as defined in Section 3.2. - * One or more elements that contains the role + * One or more elements that contain the role statuses. The values of the role status are defined in Section 3.5. - * An OPTIONAL element that contains a third party + * An OPTIONAL element that contains a third-party- assigned identifier, such as IANA ID for registrars, as defined in Section 3.2.3. - o One or more elements that contains the operational + o One or more elements that contain the operational status of the organization, as defined in Section 3.4. o An OPTIONAL element that contains the identifier of the parent object, as defined in Section 3.6. o Zero to two elements that contain postal-address information. Two elements are provided so that address information can be provided in both internationalized and localized forms; a "type" attribute is used to identify the two forms. If an internationalized form (type="int") is provided, - element content MUST be represented in a subset of UTF-8 that can - be represented in the 7-bit US-ASCII character set. If a - localized form (type="loc") is provided, element content MAY be - represented in unrestricted UTF-8. The element - contains the following child elements: + element content MUST be represented in a subset of Unicode in the + range U+0020 - U+007E. If a localized form (type="loc") is + provided, element content MAY be represented in unrestricted UTF- + 8. The element contains the following child + elements: - * A element that contains the name of the + * An element that contains the name of the organization. * An OPTIONAL element that contains address information associated with the organization. A element contains the following child elements: + One, two, or three OPTIONAL elements that contain the organization's street address. - + A element that contains the organization's city. + + An element that contains the organization's city. + An OPTIONAL element that contains the organization's state or province. + An OPTIONAL element that contains the organization's postal code. - + A element that contains the organization's country + + An element that contains the organization's country code. o An OPTIONAL element that contains the organization's - voice telephone number. + voice telephone number. The detailed format of this element is + described in Section 2.5 of [RFC5733]. o An OPTIONAL element that contains the organization's facsimile telephone number. o An OPTIONAL element that contains the organization's email address. o An OPTIONAL element that contains the URL to the website of the organization. @@ -534,70 +527,70 @@ the server before the contact object can be associated with the organization object. The required "type" is used to represent contact types. The type values include "admin", "tech", "billing", "abuse", and "custom". The OPTIONAL "typeName" attribute is used to define the name of a "custom" type. o An OPTIONAL element that contains the organization identifier of the sponsoring client. There is no element if the organization is managed by the registry. - o A element that contains the identifier of the client + o An element that contains the identifier of the client that created the organization object. - o A element that contains the date and time of + o An element that contains the date and time of organization object creation. - o A element that contains the identifier of the client + o An element that contains the identifier of the client that last updated the organization object. This element MUST NOT be present if the organization has never been modified. - o A element that contains the date and time of the most - recent organization object modification. This element MUST NOT be - present if the organization object has never been modified. + o An element that contains the date and time of the + most recent organization object modification. This element MUST + NOT be present if the organization object has never been modified. Example response for "Example Registrar Inc." organization organization object with identifier "registrar1362": S: S: S: S: - S: Command completed successfully + S: Command completed successfully S: S: S: S: registrar1362 S: registrar1362-REP S: S: registrar S: ok S: linked - S: 1362 + S: 1362 S: S: ok S: S: Example Registrar Inc. S: S: 123 Example Dr. S: Suite 100 S: Dulles S: VA S: 20166-6503 S: US S: S: S: +1.7035555555 S: +1.7035555556 S: contact@organization.example - S: http://organization.example + S: https://organization.example S: sh8013 S: sh8013 S: sh8013 S: ClientX S: 1999-04-03T22:00:00.0Z S: ClientX S: 1999-12-03T09:00:00.0Z S: S: @@ -608,21 +601,21 @@ S: S: Example response for "Example Reseller Inc." organization object of reseller type managed by identifier "registrar1362": S: S: S: S: - S: Command completed successfully + S: Command completed successfully S: S: S: S: reseller1523 S: reseller1523-REP S: S: reseller S: ok S: linked @@ -634,21 +627,21 @@ S: S: 123 Example Dr. S: Suite 100 S: Dulles S: VA S: 20166-6503 S: US S: S: S: +1.7035555556 - S: http://organization.example + S: https://organization.example S: sh8013 S: 1362 S: ClientX S: 1999-04-03T22:00:00.0Z S: ClientX S: 1999-12-03T09:00:00.0Z S: S: S: S: ABC-12345 @@ -692,77 +685,78 @@ perform a transform command on a given object. Any attempt to transform an object by an unauthorized client MUST be rejected, and the server MUST return a 2201 response code to the client to note that the client lacks privileges to execute the requested command. 4.2.1. EPP Command The EPP command provides a transform operation that allows a client to create an organization object. In addition to the standard EPP command elements, the command MUST contain a - element that identifies the organization namespace. The - element contains the following child elements: + element. This element or its ancestor element MUST + identify the organization namespace. The element + contains the following child elements: - o A element that contains the desired server-unique + o An element that contains the desired server-unique identifier for the organization to be created, as defined in Section 3.1. - o One or more elements that contains the role type, role + o One or more elements that contain the role type, role statuses and optional role id of the organization. - * A element that contains the type of the + * An element that contains the type of the organization, as defined in Section 3.2. - * Zero or more elements that contains the role + * Zero or more elements that contain the role statuses. The values of the role status are defined in Section 3.5. - * An OPTIONAL element that contains a third party + * An OPTIONAL element that contains a third-party- assigned identifier, such as IANA ID for registrars, as defined in Section 3.2.3. - o Zero of more element that contains the operational + o Zero of more element that contain the operational status of the organization, as defined in Section 3.4. o An OPTIONAL element that contains the identifier of the parent object, as defined in Section 3.6. o Zero to two elements that contain postal-address information. Two elements are provided so that address information can be provided in both internationalized and localized forms; a "type" attribute is used to identify the two forms. If an internationalized form (type="int") is provided, - element content MUST be represented in a subset of UTF-8 that can - be represented in the 7-bit US-ASCII character set. If a - localized form (type="loc") is provided, element content MAY be - represented in unrestricted UTF-8. The element - contains the following child elements: + element content MUST be represented in a subset of Unicode in the + range U+0020 - U+007E. If a localized form (type="loc") is + provided, element content MAY be represented in unrestricted UTF- + 8. The element contains the following child + elements: - * A element that contains the name of the + * An element that contains the name of the organization. * An OPTIONAL element that contains address information associated with the organization. A element contains the following child elements: + One, two, or three OPTIONAL elements that contain the organization's street address. - + A element that contains the organization's city. + + An element that contains the organization's city. + An OPTIONAL element that contains the organization's state or province. + An OPTIONAL element that contains the organization's postal code. - + A element that contains the organization's country + + An element that contains the organization's country code. o An OPTIONAL element that contains the organization's voice telephone number. o An OPTIONAL element that contains the organization's facsimile telephone number. o An OPTIONAL element that contains the organization's email address. @@ -794,47 +788,48 @@ C: Suite 100 C: Dulles C: VA C: 20166-6503 C: US C: C: C: +1.7035555555 C: +1.7035555556 C: contact@organization.example - C: http://organization.example + C: https://organization.example C: sh8013 C: sh8013 C: C: C: ABC-12345 C: C: When a command has been processed successfully, the EPP - element MUST contain a child element that - identifies the organization namespace. The element - contains the following child elements: + element MUST contain a child element. This + element or its ancestor element MUST identify the organization + namespace. The element contains the following child + elements: - o A element that contains the server-unique identifier for + o An element that contains the server-unique identifier for the created organization, as defined in Section 3.1. - o A element that contains the date and time of + o An element that contains the date and time of organization-object creation. Example response: S: S: S: S: - S: Command completed successfully + S: Command completed successfully S: S: S: S: res1523 S: 1999-04-03T22:00:00.0Z S: S: S: S: ABC-12345 @@ -843,25 +838,26 @@ S: S: An EPP error response MUST be returned if a command cannot be processed for any reason. 4.2.2. EPP Command The EPP command provides a transform operation that allows a client to delete an organization object. In addition to the standard - EPP command elements, the command MUST contain a - element that identifies the organization namespace. The - element MUST contain the following child element: + EPP command elements, the command MUST contain an + element. This element or its ancestor element MUST + identify the organization namespace. The element MUST + contain the following child element: - o A element that contains the server-unique identifier of + o An element that contains the server-unique identifier of the organization object to be deleted, as defined in Section 3.1. An organization object MUST NOT be deleted if it is associated with other known objects. An associated organization MUST NOT be deleted until associations with other known objects have been broken. A server MUST notify clients that object relationships exist by sending a 2305 error response code when a command is attempted and fails due to existing object relationships. Example command: @@ -881,21 +877,21 @@ When a command has been processed successfully, a server MUST respond with an EPP response with no element. Example response: S: S: S: S: - S: Command completed successfully + S: Command completed successfully S: S: S: ABC-12345 S: 54321-XYZ S: S: S: An EPP error response MUST be returned if a command cannot be processed for any reason. @@ -908,105 +904,105 @@ 4.2.4. EPP Command Transfer semantics do not apply to organization objects, so there is no mapping defined for the EPP command. 4.2.5. EPP Command The EPP command provides a transform operation that allows a client to modify the attributes of an organization object. In addition to the standard EPP command elements, the command - MUST contain a element that identifies the organization - namespace. The element contains the following child - elements: + MUST contain a element. This element or its ancestor + element MUST identify the organization namespace. The + element contains the following child elements: - o A element that contains the server-unique identifier of + o An element that contains the server-unique identifier of the organization object to be updated, as defined in Section 3.1. o An OPTIONAL element that contains attribute values to be added to the object. o An OPTIONAL element that contains attribute values to be removed from the object. o An OPTIONAL element that contains attribute values to be changed. At least one , or element MUST be provided if the command is not being extended. All of these elements MAY be omitted if an extension is present. The OPTIONAL - and elements contain the following child element: + and elements contain the following child + elements: o Zero or more elements that contain the identifiers for contact objects to be associated with or removed from the organization object. Contact object identifiers MUST be known to the server before the contact object can be associated with the organization object. - o Zero or more elements that contains the role type, role + o Zero or more elements that contain the role type, role statuses and optional role id of the organization. - * A element that contains the role type of the + * An element that contains the role type of the organization, as defined in Section 3.2. The role type uniquely identifies the role to update. - * Zero or more elements that contains the role + * Zero or more elements that contain the role statuses. The values of the role status are defined in Section 3.5. - * An OPTIONAL element that contains a third party + * An OPTIONAL element that contains a third-party- assigned identifier, such as IANA ID for registrars, as defined in Section 3.2.3. - o Zero or more element that contains the operational + o Zero or more element that contain the operational status of the organization. An OPTIONAL element contains the following child elements, where at least one child element MUST be present: o An OPTIONAL element that contains the identifier of the parent object. o Zero to two elements that contain postal-address information. Two elements are provided so that address information can be provided in both internationalized and localized forms; a "type" attribute is used to identify the two forms. If an internationalized form (type="int") is provided, - element content MUST be represented in a subset of UTF-8 that can - be represented in the 7-bit US-ASCII character set. If a - localized form (type="loc") is provided, element content MAY be - represented in unrestricted UTF-8. The change of the postal info - is defined as a replacement of that postal info element with the - contents of the sub-elements included in the update command. An - empty element is supported to allow a type of - postal info to be removed. The element contains - the following child elements: + element content MUST be represented in a subset of Unicode in the + range U+0020 - U+007E. If a localized form (type="loc") is + provided, element content MAY be represented in unrestricted UTF- + 8. The change of the postal info is defined as a replacement of + that postal info element with the contents of the sub-elements + included in the update command. An empty element + is supported to allow a type of postal info to be removed. The + element contains the following child elements: - * A element that contains the name of the + * An element that contains the name of the organization. * An OPTIONAL element that contains address information associated with the organization. A element contains the following child elements: + One, two, or three OPTIONAL elements that contain the organization's street address. - + A element that contains the organization's city. + + An element that contains the organization's city. + An OPTIONAL element that contains the organization's state or province. + An OPTIONAL element that contains the organization's postal code. - + A element that contains the organization's country + + An element that contains the organization's country code. o An OPTIONAL element that contains the organization's voice telephone number. o An OPTIONAL element that contains the organization's facsimile telephone number. o An OPTIONAL element that contains the organization's email address. @@ -1059,21 +1055,21 @@ When an command has been processed successfully, a server MUST respond with an EPP response with no element. Example response: S: S: S: S: - S: Command completed successfully + S: Command completed successfully S: S: S: ABC-12345 S: 54321-XYZ S: S: S: An EPP error response MUST be returned if an command cannot be processed for any reason. @@ -1092,21 +1088,21 @@ when offline processing of the action has been completed. Examples describing a command that requires offline review are included here. Note the result code and message returned in response to the command. S: S: S: S: - S: Command completed successfully; action pending +S: Command completed successfully; action pending S: S: S: S: res1523 S: 1999-04-03T22:00:00.0Z S: S: S: S: ABC-12345 @@ -1118,46 +1114,47 @@ The status of the organization object after returning this response MUST include "pendingCreate". The server operator reviews the request offline, and informs the client of the outcome of the review either by queuing a service message for retrieval via the command or by using an out-of-band mechanism to inform the client of the request. The service message MUST contain text that describes the notification in the child element of the response element. In addition, the EPP element MUST contain a child - element that identifies the organization namespace. - The element contains the following child elements: + element. This element or its ancestor element MUST + identify the organization namespace. The element + contains the following child elements: - o A element that contains the server-unique identifier of + o An element that contains the server-unique identifier of the organization object. The element contains a REQUIRED "paResult" attribute. A positive boolean value indicates that the request has been approved and completed. A negative boolean value indicates that the request has been denied and the requested action has not been taken. - o A element that contains the client transaction + o An element that contains the client transaction identifier and server transaction identifier returned with the original response to process the command. The client transaction identifier is OPTIONAL and will only be returned if the client provided an identifier with the original command. - o A element that contains the date and time describing + o An element that contains the date and time describing when review of the requested action was completed. Example "review completed" service message: S: S: S: S: - S: Command completed successfully; ack to dequeue +S: Command completed successfully; ack to dequeue S: S: S: 1999-04-04T22:01:00.0Z S: Pending action completed successfully. S: S: S: S: res1523 S: @@ -1244,21 +1241,21 @@ - + @@ -1502,21 +1499,21 @@ + minOccurs="0" maxOccurs="5" /> @@ -1575,49 +1572,50 @@ End of schema. --> END 6. Internationalization Considerations EPP is represented in XML, which provides native support for encoding information using the Unicode character set and its more compact representations including UTF-8. Conformant XML processors recognize - both UTF-8 and UTF-16. Though XML includes provisions to identify - and use other character encodings through use of an "encoding" - attribute in an declaration, use of UTF-8 is RECOMMENDED. + both UTF-8 [RFC3629] and UTF-16 [RFC2718]. Though XML includes + provisions to identify and use other character encodings through use + of an "encoding" attribute in an declaration, use of UTF-8 is + RECOMMENDED. As an extension of the EPP organization object mapping, the elements and element content described in this document MUST inherit the internationalization conventions used to represent higher-layer domain and core protocol structures present in an XML instance that includes this extension. 7. IANA Considerations 7.1. XML Namespace This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. IANA is requested to assignment the following URI. Registration request for the organization namespace: - URI: urn:ietf:params:xml:ns:org-1.0 + URI: urn:ietf:params:xml:ns:epp:org-1.0 Registrant Contact: IESG XML: None. Namespace URIs do not represent an XML specification. Registration request for the organization XML schema: - URI: urn:ietf:params:xml:ns:org-1.0 + URI: urn:ietf:params:xml:schema:epp:org-1.0 Registrant Contact: IESG XML: See the "Formal Syntax" section of this document. 7.2. EPP Extension Registry The EPP extension described in this document should be registered by the IANA in the EPP Extension Registry described in [RFC7451]. The details of the registration are as follows: @@ -1630,23 +1628,24 @@ TLDs: Any IPR Disclosure: None Status: Active Notes: None 7.3. Role Type Values Registry - The following values should be registered by the IANA in the "EPP - Organization Role Values" registry. The registration policy for this - registry is "Expert Review" [RFC8126]. + IANA has created a new category of protocol registry for values of + the organization roles. The name of this registry is "EPP + Organization Role Values". The registration policy for this registry + is "Expert Review" [RFC8126]. 7.3.1. Registration Template Value: the string value being registered. Description: Brief description of the organization role values. Registrant Name: For Standards Track RFCs, state "IESG". For others, give the name of the responsible party. @@ -1771,38 +1770,55 @@ 11. References 11.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . + [RFC2718] Masinter, L., Alvestrand, H., Zigmond, D., and R. Petke, + "Guidelines for new URL Schemes", RFC 2718, + DOI 10.17487/RFC2718, November 1999, + . + + [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO + 10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November + 2003, . + [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, . + [RFC5733] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) + Contact Mapping", STD 69, RFC 5733, DOI 10.17487/RFC5733, + August 2009, . + [RFC7942] Sheffer, Y. and A. Farrel, "Improving Awareness of Running Code: The Implementation Status Section", BCP 205, RFC 7942, DOI 10.17487/RFC7942, July 2016, . [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for Writing an IANA Considerations Section in RFCs", BCP 26, RFC 8126, DOI 10.17487/RFC8126, June 2017, . + [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC + 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, + May 2017, . + [W3C.REC-xml-20040204] Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and F. Yergeau, ""Extensible Markup Language (XML) 1.0 (Third Edition)", World Wide Web Consortium FirstEdition REC-xml- 20040204", February 2004, . [W3C.REC-xmlschema-1-20041028] Thompson, H., Beech, D., Maloney, M., and N. Mendelsohn, ""XML Schema Part 1: Structures Second Edition", World @@ -1928,53 +1944,71 @@ * Updated typos. * Added dns-operator in section 7.1. * Added "OPTIONAL" for Organization WG document-08: * Updated "Offline Review of Requested Actions". + Organization WG document-09: + + * Updated "This element or its ancestor element MUST identify the + organization namespace." in section 4.1.1 and other parts of + this document. + + * Updated text in section 2 match RFC 8174. + + * Modified "roleid" to "roleID". + + * Updated text about loops in section 3.6. + + * Referred section 2.5 of RFC5733 for voice format. + + * Updated XML schema for the maxOccurs value of "reason" element. + + * Updated section 7.3. + + * Replaced "http" with "https" in the examples. + + * Updated writing typos. + + * Modified XML namespace and schema. + Authors' Addresses Linlin Zhou CNNIC 4 South 4th Street, Zhongguancun, Haidian District Beijing, Beijing 100190 China - Phone: +86 10 5881 2677 Email: zhoulinlin@cnnic.cn - Ning Kong - CNNIC - 4 South 4th Street, Zhongguancun, Haidian District - Beijing, Beijing 100190 - China - Phone: +86 10 5881 3147 - Email: nkong@cnnic.cn + Ning Kong + Consultant + Email: ietfing@gmail.com Guiqing Zhou CNNIC 4 South 4th Street, Zhongguancun, Haidian District Beijing, Beijing 100190 China - Phone: +86 10 5881 2692 Email: zhouguiqing@cnnic.cn - Xiaodong Lee + Jiankang Yao CNNIC 4 South 4th Street, Zhongguancun, Haidian District Beijing, Beijing 100190 China - Email: xl@cnnic.cn + Email: yaojk@cnnic.cn James Gould Verisign, Inc. 12061 Bluemont Way Reston, VA 20190 US Email: jgould@verisign.com