--- 1/draft-ietf-regext-epp-fees-00.txt 2017-03-03 15:13:13.000379906 -0800 +++ 2/draft-ietf-regext-epp-fees-01.txt 2017-03-03 15:13:13.060381307 -0800 @@ -1,105 +1,102 @@ -Internet Engineering Task Force G. Brown -Internet-Draft CentralNic Group plc -Intended status: Standards Track J. Frakes -Expires: December 30, 2016 June 28, 2016 +Registration Protocols Extensions R. Carney +Internet-Draft GoDaddy Inc. +Intended status: Standards Track G. Brown +Expires: September 4, 2017 CentralNic Group plc + J. Frakes + March 3, 2017 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) - draft-ietf-regext-epp-fees-00 + draft-ietf-regext-epp-fees-01 Abstract This document describes an Extensible Provisioning Protocol (EPP) extension mapping for registry fees. -Status of this Memo +Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. 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 http://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 December 30, 2016. + This Internet-Draft will expire on September 4, 2017. Copyright Notice - Copyright (c) 2016 IETF Trust and the persons identified as the + Copyright (c) 2017 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 (http://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. Table of Contents - 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4 - 1.1. Conventions Used in This Document . . . . . . . . . . . . 4 - 2. Migrating to Newer Versions of This Extension . . . . . . . . 5 - 3. Extension Elements . . . . . . . . . . . . . . . . . . . . . . 5 - 3.1. Client Commands . . . . . . . . . . . . . . . . . . . . . 5 - 3.2. Currency Codes . . . . . . . . . . . . . . . . . . . . . . 6 - 3.3. Validity Periods . . . . . . . . . . . . . . . . . . . . . 6 - 3.4. Fees and Credits . . . . . . . . . . . . . . . . . . . . . 6 - 3.4.1. Refunds . . . . . . . . . . . . . . . . . . . . . . . 7 - 3.4.2. Grace Periods . . . . . . . . . . . . . . . . . . . . 7 - 3.4.3. Correlation between Refundability and Grace Periods . 8 - 3.4.4. Applicability . . . . . . . . . . . . . . . . . . . . 8 - 3.5. Account Balance . . . . . . . . . . . . . . . . . . . . . 8 - 3.6. Credit Limit . . . . . . . . . . . . . . . . . . . . . . . 8 - 3.7. Classification of Objects . . . . . . . . . . . . . . . . 9 - 4. Server Handling of Fee Information . . . . . . . . . . . . . . 9 + 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 + 1.1. Conventions Used in This Document . . . . . . . . . . . . 3 + 2. Migrating to Newer Versions of This Extension . . . . . . . . 4 + 3. Extension Elements . . . . . . . . . . . . . . . . . . . . . 4 + 3.1. Client Commands . . . . . . . . . . . . . . . . . . . . . 4 + 3.2. Currency Codes . . . . . . . . . . . . . . . . . . . . . 5 + 3.3. Validity Periods . . . . . . . . . . . . . . . . . . . . 5 + 3.4. Fees and Credits . . . . . . . . . . . . . . . . . . . . 5 + 3.4.1. Refunds . . . . . . . . . . . . . . . . . . . . . . . 6 + 3.4.2. Grace Periods . . . . . . . . . . . . . . . . . . . . 6 + 3.4.3. Correlation between Refundability and Grace Periods . 7 + 3.4.4. Applicability . . . . . . . . . . . . . . . . . . . . 7 + 3.5. Account Balance . . . . . . . . . . . . . . . . . . . . . 7 + 3.6. Credit Limit . . . . . . . . . . . . . . . . . . . . . . 7 + 3.7. Classification of Objects . . . . . . . . . . . . . . . . 8 + 3.8. Phase and Subphase Attributes . . . . . . . . . . . . . . 8 + 4. Server Handling of Fee Information . . . . . . . . . . . . . 9 5. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 9 - 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . . 10 - 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 10 - 5.1.1.1. Server Handling of Elements . . . . . 13 - 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . . 14 - 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . . 15 - 5.2.1. EPP Command . . . . . . . . . . . . . . . . . 15 - 5.2.2. EPP Command . . . . . . . . . . . . . . . . . 18 - 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 19 - 5.2.4. EPP Command . . . . . . . . . . . . . . . . 21 - 5.2.5. EPP Command . . . . . . . . . . . . . . . . . 23 - 5.3. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . 25 - 6. Security Considerations . . . . . . . . . . . . . . . . . . . 30 - 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 31 - 7.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 31 - 7.2. EPP Extension Registry . . . . . . . . . . . . . . . . . . 31 - 8. Implementation Status . . . . . . . . . . . . . . . . . . . . 31 - 8.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . . 32 - 9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 32 - 10. Change History . . . . . . . . . . . . . . . . . . . . . . . . 33 - 10.1. Changes from 00 to 01 . . . . . . . . . . . . . . . . . . 33 - 10.2. Changes from 01 to 02 . . . . . . . . . . . . . . . . . . 33 - 10.3. Changes from 02 to 03 . . . . . . . . . . . . . . . . . . 34 - 10.4. Changes from 03 to 04 . . . . . . . . . . . . . . . . . . 34 - 10.5. Changes from 04 to 05 . . . . . . . . . . . . . . . . . . 35 - 10.6. Changes from 05 to 06 . . . . . . . . . . . . . . . . . . 35 - 10.7. Changes from 06 to 07 . . . . . . . . . . . . . . . . . . 36 - 10.8. Changes from draft-brown-epp-fees-00 to - draft-ietf-regext-epp-fees-00 . . . . . . . . . . . . . . 36 - 11. Normative References . . . . . . . . . . . . . . . . . . . . . 36 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 37 + 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 9 + 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 9 + 5.1.1.1. Server Handling of Elements . . . . . . . . . . . 14 + 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . 15 + 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 16 + 5.2.1. EPP Command . . . . . . . . . . . . . . . . 16 + 5.2.2. EPP Command . . . . . . . . . . . . . . . . 19 + 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 20 + 5.2.4. EPP Command . . . . . . . . . . . . . . . 22 + 5.2.5. EPP Command . . . . . . . . . . . . . . . . 24 + 6. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 26 + 6.1. Fee Extension Schema . . . . . . . . . . . . . . . . . . 26 + 7. Security Considerations . . . . . . . . . . . . . . . . . . . 30 + 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 31 + 8.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 31 + 8.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 31 + 9. Implemntation Status . . . . . . . . . . . . . . . . . . . . 31 + 9.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . 32 + 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 32 + 11. Change History . . . . . . . . . . . . . . . . . . . . . . . 33 + 11.1. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 33 + 11.2. Change from draft-brown-00 to draft-ietf-regext-fees-00 33 + 12. Normative References . . . . . . . . . . . . . . . . . . . . 33 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 34 1. Introduction Historically, domain name registries have applied a simple fee structure for billable transactions, namely a basic unit price applied to domain , , and RGP [RFC3915] restore commands. Given the relatively small number of EPP servers to which EPP clients have been required to connect, it has generally been the case that client operators have been able to obtain details of these fees out-of-band by contacting the server operators. @@ -119,31 +116,35 @@ 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 RFC 2119 [RFC2119]. XML is case sensitive. Unless stated otherwise, XML specifications and examples provided in this document MUST be interpreted in the character case presented in order to develop a conforming implementation. - "fee" is used as an abbreviation for - "urn:ietf:params:xml:ns:fee-0.11". The XML namespace prefix "fee" 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. + "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:fee- + 0.13". The XML namespace prefix "fee" 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. + + 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 protocol. (Note to RFC Editor: remove the following paragraph before publication as an RFC.) The XML namespace prefix above contains a version number, - specifically "0.11". This version number will increment with + specifically "0.1". This version number will increment with successive versions of this document, and will reach 1.0 if and when this document is published as an RFC. This permits clients to distinguish which version of the extension a server has implemented. 2. Migrating to Newer Versions of This Extension (Note to RFC Editor: remove this section before publication as an RFC.) Servers which implement this extension SHOULD provide a way for @@ -165,95 +166,96 @@ elements, the server SHOULD only include extension elements for the extension versions present in the command. 3. Extension Elements 3.1. Client Commands The element is used in the EPP command to determine the fee which is applicable to the given command. - The element values permitted by the server is a matter of repository - policy, but MUST include as a minimum the following values: - - o "create" indicating a command; - - o "renew" indicating a command; - - o "transfer" indicating a command; + The list of values include: - If the server supports the Registry Grace Period Mapping [RFC3915], - then the server MUST also support the "restore" value. + o "create" indicating a command as defined in [RFC5730]; + o "delete" indicating a command as defined in [RFC5730]; + o "renew" indicating a command as defined in [RFC5730]; + o "update" indicating a command as defined in [RFC5730]; + o "transfer" indicating a command as defined in + [RFC5730]; + o If the server supports the Registry Grace Period Mapping + [RFC3915], then the server MUST also support the "restore" value + as defined in [RFC3915]. The element MAY have an OPTIONAL "phase" attribute - specifying a launch phase as described in - [draft-ietf-eppext-launchphase]. It may also contain an OPTIONAL - "subphase" attribute identifying the custom or sub-phase as described - in [draft-ietf-eppext-launchphase]. + specifying a launch phase as described in [draft-ietf-eppext- + launchphase]. It may also contain an OPTIONAL "subphase" attribute + identifying the custom or sub-phase as described in [draft-ietf- + eppext-launchphase]. 3.2. Currency Codes The element is used to indicate which currency fees are charged in. This value of this element MUST be a three-character currency code from [ISO4217]. Note that ISO 4217 provides the special "XXX" code, which MAY be used if the server uses a non-currency based system for assessing fees, such as a system of credits. The use of elements in commands is OPTIONAL: if a element is not present in a command, the server MUST determine the currency based on the client's account settings which MUST be agreed by the client and server via an out-of-band channel. However, the element MUST be present in responses. Servers SHOULD NOT perform a currency conversion if a client uses an - incorrect currency code. Servers SHOULD return a 2004 error instead. + incorrect currency code. Servers SHOULD return a 2004 "Parameter + value range" error instead. 3.3. Validity Periods When querying for fee information using the command, the element is used to indicate the units to be added to the registration period of objects by the , and - commands. This element is derived from the element described in [RFC5731]. + commands. This element is derived from the + element described in [RFC5731]. The element is OPTIONAL in commands: if omitted, the server MUST determine the fee(s) using a validity period of 1 year. The element MUST be present in responses. 3.4. Fees and Credits Servers which implement this extension will include elements in responses which provide information about the fees and/or credits associated with a given billable transaction. The and elements are used to provide this information. The presence of a element in a response - indicates a debit against the client's account balance; a element indicates a credit. A element MUST have a - non-negative value. A element MUST have a negative - value. + indicates a debit against the client's account balance; a + element indicates a credit. A element MUST + have a non-negative value. A element MUST have a + negative value. A server MAY respond with multiple and elements in the same response. In such cases, the net fee or credit applicable to the transaction is the arithmetic sum of the values of each of the and/or elements. This amount applies to the total additional validity period applied to the object (where applicable) rather than to any incremental unit. The following attributes are defined for the element. These are described in detail below: description: an OPTIONAL attribute which provides a human-readable - description of the fee. Servers should provide documentation on - the possible values of this attribute, and their meanings. + description of the fee. Servers should provide documentation on the + possible values of this attribute, and their meanings. refundable: an OPTIONAL boolean attribute indicating whether the fee is refundable if the object is deleted. grace-period: an OPTIONAL attribute which provides the time period during which the fee is refundable. applied: an OPTIONAL attribute indicating when the fee will be deducted from the client's account. @@ -294,53 +296,53 @@ 3.4.4. Applicability Fees may be applied immediately upon receipt of a command from a client, or may only be applied once an out-of-band process (such as the processing of applications at the end of a launch phase) has taken place. The "applied" attribute of the element allows servers to indicate whether a fee will be applied immediately, or whether it will be applied at some point in the future. This attribute takes - two possible values: "immediate" (which is the default) or "delayed". + two possible values: "immediate" or "delayed". 3.5. Account Balance The element is an OPTIONAL element which MAY be included in server responses to transform commands. If present, it can be used by the client to determine the remaining credit at the server. Whether or not the is included in responses is a matter of server policy. However, if a server chooses to offer support for - this element, it MUST be included in responses to all "transform" - commands (ie , , , , ). + this element, it MUST be included in responses to all "transform" or + billable commands (ie , , , , + ). The value of the MAY be negative. A negative balance indicates that the server has extended a line of credit to the client (see below). If a server includes a element in response to transform commands, the value of the element MUST reflect the client's account balance after any fees or credits associated with that command have been applied. 3.6. Credit Limit - As described above, if a server returns a response containing a with a negative value, then the server has extended a line - of credit to the client. A server MAY also include a element in responses which indicates the maximum credit - available to a client. A server MAY reject certain transactions if - the absolute value of the is equal to or exceeds the - value of the element. + As described above, if a server returns a response containing a + with a negative value, then the server has extended a + line of credit to the client. A server MAY also include a + element in responses which indicates the maximum + credit available to a client. A server MAY reject certain + transactions if the absolute value of the is equal to + or exceeds the value of the element. Whether or not the is included in responses is a matter of server policy. However, if a server chooses to offer support for this element, it MUST be included in responses to all "transform" commands (ie , , , , ). 3.7. Classification of Objects Objects may be assigned to a particular class, category, or tier, @@ -350,20 +352,52 @@ If a server makes use of this element, it should provide clients with a list of all the values that the element may take via an out-of-band channel. Servers MUST NOT use values which do not appear on this list. Servers which make use of this element MUST use a element with the value "standard" for all objects that are subject to the standard or default fee. +3.8. Phase and Subphase Attributes + + The element has two attributes, phase and subphase, + that provide additional information related to a specific launch + phase as described in [draft-ietf-eppext-launchphase]. + + If the client contains no phase attribute the server + SHOULD return data (including the phase/subphase attribute(s)) for + all valid server combinations of currently active phase(s) and active + subphase(s). + + If the client contains a server supported combination + of phase/subphase the server MUST return fee data (including the + phase/subphase attribute(s)) for the specific combination(s). + + If the client contains a phase attribute with no + subphase, the server SHOULD return data (including the phase/subphase + attribute(s)) for all valid server combinations of provided phase and + available subphase(s). + + If the client contains a subphase with no phase + attribute the server MUST respond with a 2003 "Required parameter + missing" error. + + If the client contains a phase attribute not defined in + [draft-ietf-eppext-launchphase] or not supported by server the server + MUST respond with a 2004 "Parameter value range" error. + + If the client contains a subphase attribute (or phase/ + subphase combination) not supported by server the server MUST respond + with a 2004 "Parameter value range" error. + 4. Server Handling of Fee Information Depending on server policy, a client MAY be required to include the extension elements described in this document for certain transform commands. Servers must provide clear documentation to clients about the circumstances in which this extension must be used. If a server receives a command from a client which does not include the extension elements required by the server for that command, then it MUST respond with a 2003 "Required parameter missing" error. @@ -382,29 +416,34 @@ This extension does not add any elements to the EPP or commands or responses. 5.1.1. EPP Command This extension defines additional elements for the EPP command. The command MAY contain an element which MAY contain a - element. The element contains the following - child elements: + element. The element MUST contain one or + more elements containing the following child elements: - o A element; + o A element that MUST match one and only one of the + domain names in the ; + o An OPTIONAL element. If the server does not + support value, it MUST return a 2306 error + response; + o One or more element(s) with a "name" attribute, an + OPTIONAL "phase" attribute, and an OPTIONAL "subphase" attribute. - o An OPTIONAL element; + The element(s) MAY have the following child elements: o An OPTIONAL element. - o An OPTIONAL element. Example command: C: C: C: C: C: @@ -407,82 +446,96 @@ C: C: C: C: example.com C: example.net C: example.xyz C: C: C: - C: - C: create + C: + C: + C: example.com C: USD + C: + C: 2 + C: + C: + C: + C: + C: + C: + C: example.net + C: USD + C: + C: 11 + C: + C: + C: C: C: C: ABC-12345 C: C: When the server receives a command that includes the - extension elements described above, its response MUST (subject to the - exception described below) contain an element, which MUST - contain a child element. The element - MUST contain a element for each object referenced in the - element in the command. - - The element has an OPTIONAL "avail" atribute which is a - boolean. If the value of this attribute evalutes to false, this - indicates that the server cannot calculate the relevant fees, because - the object, command, currency, period or class is invalid according - to server policy. - - The contains the following child elements: - - o A element, which contains a copy of the child element - of the element of the command, to which the fee - information relates. + extension elements described above, its response MUST contain an + element, which MUST contain a child + element. The element MUST contain a element + for each object element referenced in the + element of the client command. - o A element, which contains the same command that - appeared in the corresponding element. This element - MAY have the OPTIONAL "phase" and "subphase" elements, which MUST - match the same attributes in the corresponding - element. + Each element MUST contain the following child elements: + o A element, which MUST match a from the + client command. o A element, which contains the same currency code that appeared in the element of the command. If no element appeared in the command, then the client's default billing currency should be used. + o A element matching each that appeared + in the corresponding of the command. If a + element in the client command contains no + element the server SHOULD return a + element for each server billable transaction combination of the + . This element MAY have the OPTIONAL "phase" and + "subphase" attributes, which MUST match the same attributes in the + corresponding element of the client command. - o An OPTIONAL element, which contains the same unit - that appeared in the element of the command. If - the value of the preceding element is "restore", - this element MUST NOT be included. Otherwise it MUST be included. - If no appeared in command (and the command is not - "restore") then this element MUST have a value of 1 year. + The element also has an OPTIONAL "avail" attribute + which is a boolean. If the value of this attribute evaluates to + false, this indicates that the server cannot calculate the relevant + fees, because the object, command, currency, period or class is + invalid according to server policy. - o Zero or more elements. + The element(s) MAY have the following child elements: + o An OPTIONAL element, which contains the same unit + that appeared in the element of the command. If the + value of the preceding element is "restore", this + element MUST NOT be included. Otherwise it MUST be included. If + no appeared in command (and the command is not + "restore") then the server MUST return its default period value. + o Zero or more elements. o Zero or more elements. - o An OPTIONAL element. - o An OPTIONAL element. If no elements are present in a element, this indicates that no fee will be assessed by the server for this command. - If the "avail" attribute of the element is false, then the - element MUST NOT contain any or child - elements. If the "avail" attribute is true, then the - element MUST NOT contain a element. + If the "avail" attribute of the element is false, then + the element MUST NOT contain any or + child elements. If the "avail" attribute is true, then + the element MUST NOT contain a element. Example response: S: S: S: S: S: Command completed successfully S: S: @@ -494,84 +547,90 @@ S: S: example.net S: S: S: example.xyz S: S: S: S: S: - S: - S: - S: example.com - S: - S: create + S: + S: example.com S: USD - S: 1 + S: + S: 2 S: 10.00 + S: + S: + S: 1 + S: 5.00 - S: - S: - S: - S: example.com - S: - S: create - S: USD + S: + S: S: 1 S: 5.00 + S: + S: + S: 5.00 + S: S: - S: - S: - S: example.com - S: - S: create + S: + S: example.net S: USD + S: + S: Maximum period is 10 years + S: + S: S: 1 - S: - S: minimum period is 2 years. - S: + S: 5.00 + S: S: S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: -5.1.1.1. Server Handling of Elements +5.1.1.1. Server Handling of Elements - Clients MAY include a in the element. There - are three ways in which servers may handle this element: + Clients MAY include a in the element. + There are three ways in which servers may handle this element: 1. If the server supports the concept of tiers or classes of objects, then the value of this element MUST be validated. If incorrect for the specified object, the "avail" attribute of the - corresponding element MUST be false. - + corresponding element MUST be false. 2. If the server supports different "types" of object registrations (such as a "blocking" registration which does not resolve, or where a registry provides a value-added service that requires an opt-out to disable), then, as with the first model, the server - MUST valudate the value of the element. If the value is - incorrect, the "avail" attribute of the corresponding - element MUST be false. - + MUST validate the value of the element. If the value is + incorrect, the "avail" attribute of the corresponding + element MUST be false. 3. If the server supports neither of the above models, the element MUST be ignored. Server operators must provide clear documentation to client operators which of the above models it supports. 5.1.2. EPP Transfer Query Command This extension does not add any elements to the EPP query command, but does include elements in the response, when the @@ -614,69 +670,65 @@ S: example.com S: pending S: ClientX S: 2000-06-08T22:00:00.0Z S: ClientY S: 2000-06-13T22:00:00.0Z S: 2002-09-08T22:00:00.0Z S: S: S: - S: + S: S: USD S: 1 S: 5.00 S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: 5.2. EPP Transform Commands 5.2.1. EPP Command This extension adds elements to both the EPP command and response, when the extension has been selected during a command. + If a command is received with no extension and + the server requires a extension for the + the server MUST respond with a 2003 "Required parameter missing" + error. + When submitting a command to the server, the client MAY include in the element a element which includes the following child elements: o An OPTIONAL element; - o One or more elements. When the command has been processed successfully, and the client selected the extension when it logged in, and a fee was assessed by the server for the transaction, the server MUST include in the section of the EPP response a element, which contains the following child elements: o A element; - o Zero or more elements; - o Zero or more elements; - o An OPTIONAL element; - o An OPTIONAL element. - If no fee or credit has been assessed by the server for this - transaction, a element MUST NOT be included in the - response. - Example command: C: C: C: C: C: C: example.com C: 2 @@ -686,29 +738,28 @@ C: C: jd1234 C: sh8013 C: sh8013 C: C: 2fooBAR C: C: C: C: - C: + C: C: USD C: 5.00 C: C: C: ABC-12345 C: C: - Example response: S: S: S: S: S: Command completed successfully S: S: S: S: S: S: example.com S: 1999-04-03T22:00:00.0Z S: 2001-04-03T22:00:00.0Z S: S: S: - S: + S: S: USD - S: 5.00 + S: 5.00 S: -5.00 S: 1000.00 S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: 5.2.2. EPP Command This extension does not add any elements to the EPP command, but does include elements in the response, when the extension has been selected during the command. When the command has been processed successfully, and the client selected the extension when it logged in, the server MAY - include in the section of the EPP response a element, which contains the following child elements: + include in the section of the EPP response a + element, which contains the following child elements: o A element; - + o Zero or more elements; o Zero or more elements; - o An OPTIONAL element; - o An OPTIONAL element. - If no credit has been assessed by the server for this transaction, a - element MUST NOT be included in the response. - Example response: S: S: S: S: S: Command completed successfully S: S: S: + S: xmlns:fee="urn:ietf:params:xml:ns:fee-0.13"> S: USD S: -5.00 S: 1005.00 S: S: S: S: ABC-12345 S: 54321-XYZ S: S: @@ -782,64 +831,55 @@ This extension adds elements to both the EPP command and response, when the extension has been selected during a command. When submitting a command to the server, the client MAY include in the element a element which includes the following child elements: o An OPTIONAL element; - o One or more elements. When the command has been processed successfully, and the client selected the extension when it logged in, the server MAY - include in the section of the EPP response a element, which contains the following child elements: + include in the section of the EPP response a + element, which contains the following child elements: o A element; o Zero or more elements; - o Zero or more elements; - o An OPTIONAL element; - o An OPTIONAL element. - If no fee or credit has been assessed by the server for this - transaction, a element MUST NOT be included in the - response. - Example command: C: C: C: C: C: C: example.com C: 2000-04-03 C: 5 C: C: C: - C: + C: C: USD C: 5.00 C: C: C: ABC-12345 C: C: - Example response: S: S: S: S: S: Command completed successfully S: S: S: Command completed successfully S: S: S: S: example.com S: 2005-04-03T22:00:00.0Z S: S: S: - S: + S: S: USD - S: 5.00 + S: 5.00 S: 1000.00 S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: @@ -867,67 +909,57 @@ This extension adds elements to both the EPP command and response, when the value of the "op" attribute of the command element is "request", and the extension has been selected during the command. When submitting a command to the server, the client MAY include in the element a element which includes the following child elements: o An OPTIONAL element; - o One or more elements. When the command has been processed successfully, and the client selected the extension when it logged in, the server MAY - include in the section of the EPP response a element, which contains the following child elements: + include in the section of the EPP response a + element, which contains the following child elements: o A element; - o Zero or more elements; - o Zero or more elements; - o An OPTIONAL element; - o An OPTIONAL element. - If no fee or credit has been assessed by the server for this - transaction, a element MUST NOT be included in the - response. - Example command: C: C: C: C: C: C: example.com C: 1 C: C: 2fooBAR C: C: C: C: - C: + C: C: USD C: 5.00 C: C: C: ABC-12345 C: C: - Example response: S: S: S: S: S: Command completed successfully; action pending S: S: S: example.com S: pending S: ClientX S: 2000-06-08T22:00:00.0Z S: ClientY S: 2000-06-13T22:00:00.0Z S: 2002-09-08T22:00:00.0Z S: S: S: - S: + S: S: USD - S: 5.00 + S: 5.00 S: S: S: S: ABC-12345 S: 54322-XYZ S: S: S: 5.2.5. EPP Command This extension adds elements to both the EPP command and - response, when the extension has been selected during a has - been selected during the command. + response, when the extension has been selected during the + command. When submitting a command to the server, the client MAY include in the element a element which includes the following child elements: o An OPTIONAL element; - o One or more elements. When the command has been processed successfully, and the client selected the extension when it logged in, the server MAY - include in the section of the EPP response a - element, which contains the following child elements: + include in the section of the EPP response a + element, which contains the following child elements: o A element; - o Zero or more elements; - o Zero or more elements; - o An OPTIONAL element; - o An OPTIONAL element. - If no fee or credit has been assessed by the server for this - transaction, a element MUST NOT be included in the - response. - Example command: C: C: C: C: C: C: example.com C: C: sh8013 C: C: C: C: - C: + C: C: USD C: 5.00 C: C: C: ABC-12345 C: C: - Example response: S: S: S: S: S: Command completed successfully S: S: - S: + S: S: USD S: 5.00 S: S: S: S: ABC-12345 S: 54321-XYZ S: S: S: -5.3. Formal Syntax - - An EPP object mapping is specified in XML Schema notation. The - formal syntax presented here is a complete schema representation of - the object mapping suitable for automated validation of EPP XML - instances. - - Copyright (c) 2014 IETF Trust and the persons identified as authors - of the code. All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - - o Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. +6. Formal Syntax - o Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. + One schema is presented here that is the EPP Fee Extension schema. - o Neither the name of Internet Society, IETF or IETF Trust, nor the - names of specific contributors, may be used to endorse or promote - products derived from this software without specific prior written - permission. + The formal syntax presented here is a complete schema representation + of the object mapping suitable for automated validation of EPP XML + instances. The BEGIN and END tags are not part of the schema; they + are used to note the beginning and ending of the schema for URI + registration purposes. - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +6.1. Fee Extension Schema BEGIN - Extensible Provisioning Protocol - v1.0 extension schema for fee - information. + + Extensible Provisioning Protocol v1.0 Fee Extension + + - + - + - + - + + + + + + + - - + - + + + + + + + + + + - - - - - - - - + - - - - - + - - + - - + - - + - - - - - - - - - - + + + + + + + + + - + + @@ -1251,21 +1229,21 @@ - + @@ -1280,47 +1258,46 @@ - END -6. Security Considerations +7. Security Considerations The mapping extensions described in this document do not provide any security services beyond those described by EPP [RFC5730], the EPP domain name mapping [RFC5731], and protocol layers used by EPP. The security considerations described in these other specifications apply to this specification as well. -7. IANA Considerations +8. IANA Considerations -7.1. XML Namespace +8.1. XML Namespace This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. The following URI assignment is requested of IANA: - URI: urn:ietf:params:xml:ns:fee-0.11 + URI: ietf:params:xml:ns:fee-0.13 Registrant Contact: See the "Author's Address" section of this document. XML: See the "Formal Syntax" section of this document. -7.2. EPP Extension Registry +8.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: Name of Extension: EPP Fee Extension Document status: Standards Track Reference: (insert reference to RFC version of this document) @@ -1329,21 +1306,21 @@ of this document. TLDs: any IPR Disclosure: none Status: active Notes: none -8. Implementation Status +9. Implemntation Status Note to RFC Editor: Please remove this section and the reference to [RFC6982] before publication. This section records the status of known implementations of the protocol defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in [RFC6982]. The description of implementations in this section is intended to assist the IETF in its decision processes in progressing drafts to RFCs. Please note that the listing of any individual implementation @@ -1354,258 +1331,129 @@ features. Readers are advised to note that other implementations may exist. According to [RFC6982], "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. It is up to the individual working groups to use this information as they see fit". -8.1. RegistryEngine EPP Service +9.1. RegistryEngine EPP Service Organization: CentralNic Name: RegistryEngine EPP Service Description: Generic high-volume EPP service for gTLDs, ccTLDs and SLDs Level of maturity: Deployed in CentralNic's production environment as well as two other gTLD registry systems, and two ccTLD registry systems. Coverage: All aspects of the protocol are implemented. Licensing: Proprietary In-House software Contact: epp@centralnic.com URL: https://www.centralnic.com -9. Acknowledgements +10. Acknowledgements The authors wish to thank the following persons for their feedback and suggestions: - o James Gould of Verisign - + o James Gould of Verisign Inc o Luis Munoz of ISC o Michael Young of Architelos - o Ben Levac and Jeff Eckhaus of Demand Media - o Seth Goldman of Google - o Klaus Malorny and Michael Bauland of Knipp - - o Jody Kolker and Roger Carney of Go Daddy - + o Jody Kolker, Joe Snitker and Kevin Allendorf of Go Daddy o Michael Holloway of Com Laude - o Santosh Kalsangrah of Impetus Infotech - o Alex Mayrhofer of Nic.at -10. Change History - -10.1. Changes from 00 to 01 - - 1. Restore the command extension; either or - can be used. - - 2. added extension elements for , , and - so that the server can reject the command if the fee is - incorrect. - -10.2. Changes from 01 to 02 - - 1. Use Internet-Draft version number rather than XML namespace - version number in this section. - - 2. Support for multiple and elements. - - 3. Added the "description" attribute to and - elements. - - 4. Added the element. - - 5. Added the element. - - 6. Updated reference to [draft-ietf-eppext-launchphase]. - - 7. Use instead of . - - 8. Use a single child element of instead of multiple - elements for each domain. This also requires using a different - name () for the domain name. - - 9. Added the "refundable" attribute to elements. - - 10. Added the "grace-period" attribute to elements. - -10.3. Changes from 02 to 03 - - 1. Added the "applied" attribute to to elements. - - 2. Simplified the wording in relation to when a server can return an - error for extended commands. - - 3. Added the element to transfer query responses. - - 4. Removed wording about how servers behave when receiving incorrect - fee information from transform commands, and put it into a single - section at the top of the document. - - 5. Allow servers to omit elements from elements - if the command specified by the client is forbidden. - -10.4. Changes from 03 to 04 - - 1. Changed Intended Status to Standards Track. - - 2. As per suggestion from Michael Bauland, the element - is no longer included in and responses for - "restore" commands. It's still mandatory for all other commands. - - 3. Added summary of the attributes for the element. - - 4. Clarified that the "refundable" and "grace-period" attributes of - the elements are dependant on each other and cannot - appear on their own. - - 5. Removed the option of returning a 1001 response when the fee is - incorrect. - - 6. Forbidden the inclusion of extension elements in transform - responses if no fee/credit has been assessed. - - 7. Made the element optional in transform commands. - - 8. Amended XML Namespace section of IANA Considerations, added EPP - Extension Registry section. - -10.5. Changes from 04 to 05 - - 1. Removed the extended command. The command is the - only command that can be used now. - - 2. Introduced a mandatory-to-implement "standard" class for non- - premium domains. - - 3. The decision was made to keep availability info in - responses as registrars have indicated that it is very useful as - it avoids unnecessary round trips to the server. - - 4. Allow elements to be present in responses. - - 5. Allow the number of which can appear in transform - responses to be zero. - - 6. Removed the and elements from - transfer query responses. The reason is that these elements are - defined as containing the values after the transform command has - taken place - which means that it is not appropriate to include - them in a query response. - - 7. Added Implementation Status section. - -10.6. Changes from 05 to 06 - - 1. The specification is now object-agnostic, but works with RFC5731 - [RFC5731] domains by default. - - 2. Renamed the element to . Added the - "objURI" attribute. - - 3. Removed the default value for the "refundable" attribute of elements, and added text about how clients should handle - such cases. Added similar text to the documentation of the - "grace-period" attribute. - - 4. Removed references to the defunct command syntax. - - 5. "MUST" requirements regarding documentation have been changed to - "must". - - 6. Created separate "Correlation between Refundability and Grace - Periods" section describing how the "refundable" and "grace- - period" attributes work together. - -10.7. Changes from 06 to 07 - - 1. Changed the syntax of the form to be simpler: a single - set of , etc elements is applied to - the objects specified in the main body of the command. - - 2. Simplified the object-agnosticism to simply copy the element from - the command into the element. - - 3. Added the "avail" attribute to the element and added - commentary about its semantics. +11. Change History - 4. Added the element to the response so servers - can indicate why fee information is not available. +11.1. Change from 00 to 01 -10.8. Changes from draft-brown-epp-fees-00 to - draft-ietf-regext-epp-fees-00 + Added Roger Carney as author to finish draft. Moved Formal Syntax + section to main level numbering. Various grammar, typos, and + administrative edits for clarity. Removed default value for the + "applied" attribute of so that it can truly be optional. + Added support for the command to return a element + as well. Modified default response on the command for the + optional when it was not provided in the command, + leaving it to the server to provide the default period value. + Extensive edits were done to the command, the + response and to the fee extension schema (checkType, objectCheckType, + objectIdentifierType, objectCDType, commandType) to support + requesting and returning multiple transformation fees in a single + call. Added section on Phase/Subphase to provide more context on the + uses. - 1. Updated to be a WG document. +11.2. Change from draft-brown-00 to draft-ietf-regext-fees-00 -11. Normative References + Updated to be REGEXT WG document. - [ISO4217] International Organization for Standardization, "ISO 4217: - 2008, Codes for the representation of currencies and - funds", 2008. +12. 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, + Requirement Levels", BCP 14, RFC 2119, + DOI 10.17487/RFC2119, March 1997, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for the Extensible Provisioning Protocol (EPP)", RFC 3915, DOI 10.17487/RFC3915, September 2004, . [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, . [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) - Domain Name Mapping", STD 69, RFC 5731, DOI 10.17487/ - RFC5731, August 2009, + Domain Name Mapping", STD 69, RFC 5731, + DOI 10.17487/RFC5731, August 2009, . [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running Code: The Implementation Status Section", RFC 6982, DOI 10.17487/RFC6982, July 2013, . [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, February 2015, . - [draft-ietf-eppext-launchphase] - Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping - for the Extensible Provisioning Protocol (EPP)", 2014. - Authors' Addresses + Roger Carney + GoDaddy Inc. + 14455 N. Hayden Rd. #219 + Scottsdale, AZ 85260 + US + + Email: rcarney@godaddy.com + URI: http://www.godaddy.com + Gavin Brown CentralNic Group plc 35-39 Moorgate London, England EC2R 6AR GB Phone: +44 20 33 88 0600 Email: gavin.brown@centralnic.com - URI: https://www.centralnic.com + URI: http://www.centralnic.com Jothan Frakes Email: jothan@jothan.com URI: http://jothan.com