idnits 2.17.1 draft-ietf-regext-epp-fees-11.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 date (April 10, 2018) is 2180 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) == Missing Reference: 'ISO4217' is mentioned on line 202, but not defined ** Obsolete normative reference: RFC 6982 (Obsoleted by RFC 7942) ** Downref: Normative reference to an Informational RFC: RFC 7451 Summary: 2 errors (**), 0 flaws (~~), 2 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Registration Protocols Extensions R. Carney 3 Internet-Draft GoDaddy Inc. 4 Intended status: Standards Track G. Brown 5 Expires: October 12, 2018 CentralNic Group plc 6 J. Frakes 7 April 10, 2018 9 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 10 draft-ietf-regext-epp-fees-11 12 Abstract 14 This document describes an Extensible Provisioning Protocol (EPP) 15 extension mapping for registry fees. 17 Status of This Memo 19 This Internet-Draft is submitted in full conformance with the 20 provisions of BCP 78 and BCP 79. 22 Internet-Drafts are working documents of the Internet Engineering 23 Task Force (IETF). Note that other groups may also distribute 24 working documents as Internet-Drafts. The list of current Internet- 25 Drafts is at https://datatracker.ietf.org/drafts/current/. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 This Internet-Draft will expire on October 12, 2018. 34 Copyright Notice 36 Copyright (c) 2018 IETF Trust and the persons identified as the 37 document authors. All rights reserved. 39 This document is subject to BCP 78 and the IETF Trust's Legal 40 Provisions Relating to IETF Documents 41 (https://trustee.ietf.org/license-info) in effect on the date of 42 publication of this document. Please review these documents 43 carefully, as they describe your rights and restrictions with respect 44 to this document. Code Components extracted from this document must 45 include Simplified BSD License text as described in Section 4.e of 46 the Trust Legal Provisions and are provided without warranty as 47 described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 52 1.1. Conventions Used in This Document . . . . . . . . . . . . 3 53 2. Migrating to Newer Versions of This Extension . . . . . . . . 4 54 3. Extension Elements . . . . . . . . . . . . . . . . . . . . . 4 55 3.1. Client Commands . . . . . . . . . . . . . . . . . . . . . 4 56 3.2. Currency Codes . . . . . . . . . . . . . . . . . . . . . 5 57 3.3. Validity Periods . . . . . . . . . . . . . . . . . . . . 5 58 3.4. Fees and Credits . . . . . . . . . . . . . . . . . . . . 5 59 3.4.1. Refunds . . . . . . . . . . . . . . . . . . . . . . . 6 60 3.4.2. Grace Periods . . . . . . . . . . . . . . . . . . . . 6 61 3.4.3. Correlation between Refundability and Grace Periods . 7 62 3.4.4. Applicability . . . . . . . . . . . . . . . . . . . . 7 63 3.5. Account Balance . . . . . . . . . . . . . . . . . . . . . 7 64 3.6. Credit Limit . . . . . . . . . . . . . . . . . . . . . . 8 65 3.7. Classification of Objects . . . . . . . . . . . . . . . . 8 66 3.8. Phase and Subphase Attributes . . . . . . . . . . . . . . 8 67 3.9. Reason . . . . . . . . . . . . . . . . . . . . . . . . . 9 68 4. Server Handling of Fee Information . . . . . . . . . . . . . 10 69 5. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 11 70 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 11 71 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 11 72 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . 15 73 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 17 74 5.2.1. EPP Command . . . . . . . . . . . . . . . . 17 75 5.2.2. EPP Command . . . . . . . . . . . . . . . . 19 76 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 20 77 5.2.4. EPP Command . . . . . . . . . . . . . . . 22 78 5.2.5. EPP Command . . . . . . . . . . . . . . . . 24 79 6. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 26 80 6.1. Fee Extension Schema . . . . . . . . . . . . . . . . . . 26 81 7. Security Considerations . . . . . . . . . . . . . . . . . . . 31 82 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 31 83 8.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 31 84 8.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 32 85 9. Implementation Status . . . . . . . . . . . . . . . . . . . . 32 86 9.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . 33 87 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 33 88 11. Change History . . . . . . . . . . . . . . . . . . . . . . . 34 89 11.1. Change from 10 to 11 . . . . . . . . . . . . . . . . . . 34 90 11.2. Change from 09 to 10 . . . . . . . . . . . . . . . . . . 34 91 11.3. Change from 08 to 09 . . . . . . . . . . . . . . . . . . 34 92 11.4. Change from 07 to 08 . . . . . . . . . . . . . . . . . . 34 93 11.5. Change from 06 to 07 . . . . . . . . . . . . . . . . . . 34 94 11.6. Change from 05 to 06 . . . . . . . . . . . . . . . . . . 34 95 11.7. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 34 96 11.8. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 35 97 11.9. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 35 98 11.10. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 35 99 11.11. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 35 100 11.12. Change from draft-brown-00 to draft-ietf-regext-fees-00 36 101 12. Normative References . . . . . . . . . . . . . . . . . . . . 36 102 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 36 104 1. Introduction 106 Historically, domain name registries have applied a simple fee 107 structure for billable transactions, namely a basic unit price 108 applied to domain , , and RGP [RFC3915] 109 restore commands. Given the relatively small number of EPP servers 110 to which EPP clients have been required to connect, it has generally 111 been the case that client operators have been able to obtain details 112 of these fees out-of-band by contacting the server operators. 114 Given the recent expansion of the DNS namespace, and the 115 proliferation of novel business models, it is now desirable to 116 provide a method for EPP clients to query EPP servers for the fees 117 and credits associated with certain commands and specific objects. 119 This document describes an extension mapping for version 1.0 of the 120 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 121 provides a mechanism by which EPP clients may query the fees and 122 credits associated with various billable transactions, and obtain 123 their current account balance. 125 1.1. Conventions Used in This Document 127 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 128 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 129 document are to be interpreted as described in RFC 2119 [RFC2119]. 131 XML is case sensitive. Unless stated otherwise, XML specifications 132 and examples provided in this document MUST be interpreted in the 133 character case presented in order to develop a conforming 134 implementation. 136 "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:fee- 137 1.0". The XML namespace prefix "fee" is used, but implementations 138 MUST NOT depend on it and instead employ a proper namespace-aware XML 139 parser and serializer to interpret and output the XML documents. 141 In examples, "C:" represents lines sent by a protocol client and "S:" 142 represents lines returned by a protocol server. Indentation and 143 white space in examples are provided only to illustrate element 144 relationships and are not a REQUIRED feature of this protocol. 146 2. Migrating to Newer Versions of This Extension 148 (Note to RFC Editor: remove this section before publication as an 149 RFC.) 151 Servers which implement this extension SHOULD provide a way for 152 clients to progressively update their implementations when a new 153 version of the extension is deployed. 155 Servers SHOULD (for a temporary migration period) provide support for 156 older versions of the extension in parallel to the newest version, 157 and allow clients to select their preferred version via the 158 element of the command. 160 If a client requests multiple versions of the extension at login, 161 then, when preparing responses to commands which do not include 162 extension elements, the server SHOULD only include extension elements 163 in the namespace of the newest version of the extension requested by 164 the client. 166 When preparing responses to commands which do include extension 167 elements, the server SHOULD only include extension elements for the 168 extension versions present in the command. 170 3. Extension Elements 172 3.1. Client Commands 174 The element is used in the EPP command to 175 determine the fee which is applicable to the given command. 177 The use of the keys off the use of the "name" attribute 178 to define which transform fees the client is requesting information 179 about. Here is the list of possible values for the "name" attribute: 181 o "create" indicating a command as defined in [RFC5730]; 182 o "delete" indicating a command as defined in [RFC5730]; 183 o "renew" indicating a command as defined in [RFC5730]; 184 o "update" indicating a command as defined in [RFC5730]; 185 o "transfer" indicating a command as defined in 186 [RFC5730]; 187 o If the server supports the Registry Grace Period Mapping 188 [RFC3915], then the server MUST also support the "restore" value 189 as defined in [RFC3915]; 190 o "custom" indicating a custom command that uses the "customName" 191 attribute to define the custom operation. 193 The element MAY have an OPTIONAL "phase" attribute 194 specifying a launch phase as described in [RFC8334]. It may also 195 contain an OPTIONAL "subphase" attribute identifying the custom or 196 sub-phase as described in [RFC8334]. 198 3.2. Currency Codes 200 The element is used to indicate which currency fees 201 are charged in. This value of this element MUST be a three-character 202 currency code from [ISO4217]. 204 Note that ISO 4217 provides the special "XXX" code, which MAY be used 205 if the server uses a non-currency based system for assessing fees, 206 such as a system of credits. 208 The use of elements in client commands is OPTIONAL: if 209 a element is not present in a command, the server MUST 210 determine the currency based on the server default currency or based 211 on the client's account settings which are agreed to by the client 212 and server via an out-of-band channel. However, the 213 element MUST be present in responses. 215 Servers SHOULD NOT perform a currency conversion if a client uses an 216 incorrect currency code. Servers SHOULD return a 2004 "Parameter 217 value range" error instead. 219 3.3. Validity Periods 221 When querying for fee information using the command, the 222 element is used to indicate the units to be added to the 223 registration period of objects by the , and 224 commands. This element is derived from the 225 element described in [RFC5731]. 227 The element is OPTIONAL in commands, if omitted, 228 the server MUST determine the fee(s) using the server default period. 229 The element MUST be present in responses. 231 3.4. Fees and Credits 233 Servers which implement this extension will include elements in 234 responses which provide information about the fees and/or credits 235 associated with a given billable transaction. 237 The and elements are used to provide this 238 information. The presence of a element in a response 239 indicates a debit against the client's account balance; a 240 element indicates a credit. A element MUST 241 have a non-negative value. A element MUST have a 242 negative value. 244 A server MAY respond with multiple and 245 elements in the same response. In such cases, the net fee or credit 246 applicable to the transaction is the arithmetic sum of the values of 247 each of the and/or elements. This amount 248 applies to the total additional validity period applied to the object 249 (where applicable) rather than to any incremental unit. 251 The following attributes are defined for the element. 252 These are described in detail below: 254 description: an OPTIONAL attribute which provides a human-readable 255 description of the fee. Servers should provide documentation on the 256 possible values of this attribute, and their meanings. 258 refundable: an OPTIONAL boolean attribute indicating whether the fee 259 is refundable if the object is deleted. 261 grace-period: an OPTIONAL attribute which provides the time period 262 during which the fee is refundable. 264 applied: an OPTIONAL attribute indicating when the fee will be 265 deducted from the client's account. 267 The element can take a "description" attribute as 268 described above. No other attributes are defined for this element. 270 3.4.1. Refunds 272 elements MAY have an OPTIONAL "refundable" attribute which 273 takes a boolean value. Fees may be refunded under certain 274 circumstances, such as when a domain application is rejected (as 275 described in [RFC8334]) or when an object is deleted during the 276 relevant Grace Period (see below). 278 If the "refundable" attribute is omitted, then clients SHOULD NOT 279 make any assumption about the refundability of the fee. 281 3.4.2. Grace Periods 283 [RFC3915] describes a system of "grace periods", which are time 284 periods following a billable transaction during which, if an object 285 is deleted, the client receives a refund. 287 The "grace-period" attribute MAY be used to indicate the relevant 288 grace period for a fee. If a server implements the Registry Grace 289 Period extension [RFC3915], it MUST specify the grace period for all 290 relevant transactions. 292 If the "grace-period" attribute is omitted, then clients SHOULD NOT 293 make any assumption about the grace period of the fee. 295 3.4.3. Correlation between Refundability and Grace Periods 297 If a element has a "grace-period" attribute then it MUST 298 also be refundable. If the "refundable" attribute of a 299 element is false then it MUST NOT have a "grace-period" attribute. 301 3.4.4. Applicability 303 Fees may be applied immediately upon receipt of a command from a 304 client, or may only be applied once an out-of-band process (such as 305 the processing of applications at the end of a launch phase) has 306 taken place. 308 The "applied" attribute of the element allows servers to 309 indicate whether a fee will be applied immediately, or whether it 310 will be applied at some point in the future. This attribute takes 311 two possible values: "immediate" or "delayed". 313 3.5. Account Balance 315 The element is an OPTIONAL element which MAY be 316 included in server responses to transform commands. If present, it 317 can be used by the client to determine the remaining credit at the 318 server. 320 Whether or not the is included in responses is a matter 321 of server policy. However, if a server chooses to offer support for 322 this element, it MUST be included in responses to all "transform" or 323 billable commands (e.g. , , , , 324 ). 326 The value of the MAY be negative. A negative balance 327 indicates that the server has extended a line of credit to the client 328 (see below). 330 If a server includes a element in response to transform 331 commands, the value of the element MUST reflect the client's account 332 balance after any fees or credits associated with that command have 333 been applied. 335 3.6. Credit Limit 337 As described above, if a server returns a response containing a 338 with a negative value, then the server has extended a 339 line of credit to the client. A server MAY also include a 340 element in responses which indicates the maximum 341 credit available to a client. A server MAY reject certain 342 transactions if the absolute value of the is equal to 343 or exceeds the value of the element. 345 Whether or not the is included in responses is a 346 matter of server policy. However, if a server chooses to offer 347 support for this element, it MUST be included in responses to all 348 "transform" commands (e.g. , , , , 349 ). 351 3.7. Classification of Objects 353 Objects may be assigned to a particular class, category, or tier, 354 each of which has a particular fee or set of fees associated with it. 355 The element, which MAY appear in and transform 356 responses, is used to indicate the classification of an object. 358 If a server makes use of this element, it should provide clients with 359 a list of all the values that the element may take via an out-of-band 360 channel. Servers MUST NOT use values which do not appear on this 361 list. 363 Servers which make use of this element MUST use a element 364 with the value "standard" for all objects that are subject to the 365 standard or default fee. 367 3.8. Phase and Subphase Attributes 369 The element has two attributes, phase and subphase, 370 that provide additional information related to a specific launch 371 phase as described in [RFC8334]. These attributes are used as 372 filters that should refine the server processing. 374 If the client contains a server supported combination 375 of phase/subphase the server MUST return fee data (including the 376 phase/subphase attribute(s)) for the specific combination. 378 If the client contains no phase/subphase attributes and 379 the server has only one active phase/subphase combination the server 380 MUST return data (including the phase/subphase attribute(s)) of the 381 currently active phase/subphase. 383 If the client contains no phase/subphase attributes and 384 the server has more than one active phase/subphase combination the 385 server MUST respond with a 2003 "Required parameter missing" error. 387 If the client contains no phase/subphase attributes and 388 the server is currently in a "quiet period" (e.g. not accepting 389 registrations or applications) the server MUST return data consistent 390 with the default general availability phase (e.g. "open" or "claims") 391 including the appropriate phase/subphase attribute(s). 393 If the client contains a phase attribute with no 394 subphase and the server has only one active subphase (or no subphase) 395 of this phase, the server MUST return data (including the phase/ 396 subphase attribute(s)) of the provided phase and currently active 397 subphase. 399 If the client contains a phase attribute with no 400 subphase and the server has more than one active subphase combination 401 of this phase, the server MUST respond with a 2003 "Required 402 parameter missing" error. 404 If the client contains a subphase with no phase 405 attribute the server MUST respond with a 2003 "Required parameter 406 missing" error. 408 If the client contains a phase attribute not defined in 409 [RFC8334] or not supported by server the server MUST respond with a 410 2004 "Parameter value range" error. 412 If the client contains a subphase attribute (or phase/ 413 subphase combination) not supported by server the server MUST respond 414 with a 2004 "Parameter value range" error. 416 3.9. Reason 418 The element is used to provide server specific text in 419 an effort to better explain why a command did not complete as 420 the client expected. An OPTIONAL "lang" attribute MAY be present to 421 identify the language of the returned text and has a default value of 422 "en" (English). 424 The element can be used within the server response 425 element or within the element. 427 If the server cannot calculate the relevant fees, because the object, 428 command, currency, period, class or some combination is invalid per 429 server policy, the server has two ways of handling error processing 430 of element(s): 432 1. Fast-fail - The server, upon error identification, MAY stop 433 processing elements and return to the client a 434 containing the and a element 435 detailing the reason for failure. 437 S: 438 S: example.xyz 439 S: Only 1 year registration periods are 440 S: valid. 441 S: 443 2. Partial-fail - The server, upon error identification, MAY 444 continue processing elements and return to the 445 client a containing successfully processed 446 elements and failed elements. All returned failed 447 elements MUST have a element detailing 448 the reason for failure, and the server MAY additionally include a 449 element at the level. 451 S: 452 S: example.xyz 453 S: 454 S: 2 455 S: Only 1 year registration periods are 456 S: valid. 457 S: 458 S: 460 In either failure scenario the server MUST set the avail 461 attribute to false (0) and the server MUST process all objects in the 462 client request. 464 4. Server Handling of Fee Information 466 Depending on server policy, a client MAY be required to include the 467 extension elements described in this document for certain transform 468 commands. Servers must provide clear documentation to clients about 469 the circumstances in which this extension must be used. 471 The server MUST return avail="0" in its response to a command 472 for any object in the command that does not include the 473 extension for which the server would likewise fail a 474 domain command when no extension is provided for that 475 same object. 477 If a server receives a command from a client, which results 478 in no possible fee combination but where a fee is required, the 479 server MUST set the "avail" attribute of the element to 480 false and provide a . 482 If a server receives a command from a client, which results 483 in an ambiguous result (i.e. multiple possible fee combinations) the 484 server MUST reject the command with a 2003 "Required parameter 485 missing" error. 487 If a server receives a command from a client, which does not include 488 the fee extension data elements required by the server for that 489 command, then the server MUST respond with a 2003 "Required parameter 490 missing" error. 492 If the currency or total fee provided by the client is less than the 493 server's own calculation of the fee for that command, then the server 494 MUST reject the command with a 2004 "Parameter value range" error. 496 5. EPP Command Mapping 498 A detailed description of the EPP syntax and semantics can be found 499 in [RFC5730]. 501 5.1. EPP Query Commands 503 This extension does not add any elements to the EPP or 504 commands or responses. 506 5.1.1. EPP Command 508 This extension defines a new command called the Fee Check Command 509 that defines additional elements for the EPP command to 510 provide fee information along with the availability information of 511 the EPP command. 513 The command MAY contain an element which MAY contain a 514 element. The element MAY contain one 515 element and MUST contain one or more 516 elements. 518 The element(s) contain(s) a "name" attribute (see 519 Section 3.1), an OPTIONAL "standard" attribute with a default value 520 of false (0) (see section 3.7), an OPTIONAL "phase" attribute, and an 521 OPTIONAL "subphase" attribute (see Section 3.8). The 522 element(s) MAY have the following child elements: 524 o An OPTIONAL element (as described in Section 3.3). 526 Example command: 528 C: 529 C: 530 C: 531 C: 532 C: 534 C: example.com 535 C: example.net 536 C: example.xyz 537 C: 538 C: 539 C: 540 C: 541 C: USD 542 C: 543 C: 2 544 C: 545 C: 546 C: 547 C: 548 C: 549 C: 550 C: ABC-12345 551 C: 552 C: 554 When the server receives a command that includes the 555 extension elements described above, its response MUST contain an 556 element, which MUST contain a child 557 element. The element MUST contain a 558 element and a for each element referenced in the client 559 command. 561 Each element MUST contain the following child elements: 563 o A element, which MUST match an element referenced in 564 the client command. 565 o An OPTIONAL element (as described in Section 3.7). 566 o A element matching each (unless the 567 "avail" attribute of the if false) that appeared in the 568 corresponding of the client command. This element MAY 569 have the OPTIONAL "phase" and "subphase" attributes, which SHOULD 570 match the same attributes in the corresponding 571 element of the client command if sent by the client. 573 The element also has an OPTIONAL "avail" attribute which is 574 a boolean. If the value of this attribute evaluates to false, this 575 indicates that the server cannot calculate the relevant fees, because 576 the object, command, currency, period, class or some combination is 577 invalid per server policy. If "avail" is false then the or 578 the element MUST contain a element (as 579 described in Section 3.9) and the server MAY eliminate some or all of 580 the element(s). 582 The element(s) MAY have the following child elements: 584 o An OPTIONAL element (as described in Section 3.3), 585 which contains the same unit that appeared in the 586 element of the command. If the value of the preceding 587 element is "restore", this element MUST NOT be 588 included, otherwise it MUST be included. If no 589 appeared in the client command (and the command is not "restore") 590 then the server MUST return its default period value. 591 o Zero or more elements (as described in Section 3.4). 592 o Zero or more elements (as described in Section 3.4). 593 o An OPTIONAL element (as described in Section 3.9). 595 If the "avail" attribute of the element is true and if no 596 elements are present in a element, this 597 indicates that no fee will be assessed by the server for this 598 command. 600 If the "avail" attribute is true, then the element MUST 601 NOT contain a element. 603 Example response: 605 S: 606 S: 607 S: 608 S: 609 S: Command completed successfully 610 S: 611 S: 612 S: 614 S: 615 S: example.com 616 S: 617 S: 618 S: example.net 619 S: 620 S: 621 S: example.xyz 622 S: 623 S: 624 S: 625 S: 626 S: 628 S: USD 629 S: 630 S: example.com 631 S: Premium 632 S: 633 S: 2 634 S: 10.00 638 S: 639 S: 640 S: 1 641 S: 5.00 645 S: 646 S: 647 S: 1 648 S: 5.00 652 S: 653 S: 654 S: 5.00 656 S: 657 S: 658 S: 659 S: example.net 660 S: 661 S: 2 662 S: 10.00 666 S: 667 S: 668 S: 1 669 S: 5.00 673 S: 674 S: 675 S: 1 676 S: 5.00 680 S: 681 S: 682 S: 5.00 684 S: 685 S: 686 S: 687 S: example.xyz 688 S: 689 S: 2 690 S: Only 1 year registration periods are 691 S: valid. 692 S: 693 S: 694 S: 695 S: 696 S: 697 S: ABC-12345 698 S: 54322-XYZ 699 S: 700 S: 701 S: 703 5.1.2. EPP Transfer Query Command 705 This extension does not add any elements to the EPP query 706 command, but does include elements in the response, when the 707 extension is included in the command service extensions. 709 When the query command has been processed successfully, if 710 the client has included the extension in the command service 711 element, and if the client is authorized by the server 712 to view information about the transfer, then the server MAY include 713 in the section of the EPP response a 714 element, which contains the following child elements: 716 o A element (as described in Section 3.2). 718 o A element (as described in Section 3.3). 719 o Zero or more elements (as described in Section 3.4) 720 containing the fees that will be charged to the gaining client. 721 o Zero or more elements (as described in Section 3.4) 722 containing the credits that will be refunded to the losing client. 724 Servers SHOULD omit when returning a response to the 725 gaining client, and omit elements when returning a response 726 to the losing client. 728 If no element is included in the response, then no fee 729 will be assessed by the server for the transfer. 731 Example query response: 733 S: 734 S: 735 S: 736 S: 737 S: Command completed successfully; action pending 738 S: 739 S: 740 S: 742 S: example.com 743 S: pending 744 S: ClientX 745 S: 2000-06-08T22:00:00.0Z 746 S: ClientY 747 S: 2000-06-13T22:00:00.0Z 748 S: 2002-09-08T22:00:00.0Z 749 S: 750 S: 751 S: 752 S: 753 S: USD 754 S: 1 755 S: 5.00 756 S: 757 S: 758 S: 759 S: ABC-12345 760 S: 54322-XYZ 761 S: 762 S: 763 S: 765 5.2. EPP Transform Commands 767 5.2.1. EPP Command 769 This extension adds elements to both the EPP command and 770 response, when the extension is included in the command 771 service extensions. 773 When submitting a command to the server, the client MAY 774 include in the element a element which 775 includes the following child elements: 777 o An OPTIONAL element (as described in Section 3.2); 778 o One or more elements (as described in Section 3.4). 780 The server MUST fail the command if the provided 781 by the client is less than the server fee. 783 When the command has been processed successfully, and the 784 client included the extension in the command service 785 extensions, and a fee was assessed by the server for the transaction, 786 the server MUST include in the section of the EPP 787 response a element, which contains the following child 788 elements: 790 o A element (as described in Section 3.2); 791 o Zero or more elements (as described in Section 3.4); 792 o Zero or more elements (as described in Section 3.4); 793 o An OPTIONAL element (as described in Section 3.5); 794 o An OPTIONAL element (as described in 795 Section 3.6). 797 Example command: 799 C: 800 C: 801 C: 802 C: 803 C: 805 C: example.com 806 C: 2 807 C: 808 C: ns1.example.net 809 C: ns2.example.net 810 C: 811 C: jd1234 812 C: sh8013 813 C: sh8013 814 C: 815 C: 2fooBAR 816 C: 817 C: 818 C: 819 C: 820 C: 821 C: USD 822 C: 5.00 823 C: 824 C: 825 C: ABC-12345 826 C: 827 C: 828 Example response: 830 S: 831 S: 832 S: 833 S: 834 S: Command completed successfully 835 S: 836 S: 837 S: 839 S: example.com 840 S: 1999-04-03T22:00:00.0Z 841 S: 2001-04-03T22:00:00.0Z 842 S: 843 S: 844 S: 845 S: 846 S: USD 847 S: 5.00 851 S: -5.00 852 S: 1000.00 853 S: 854 S: 855 S: 856 S: ABC-12345 857 S: 54321-XYZ 858 S: 859 S: 860 S: 862 5.2.2. EPP Command 864 This extension does not add any elements to the EPP command, 865 but does include elements in the response, when the extension is 866 included in the command service extensions. 868 When the command has been processed successfully, and the 869 client included the extension in the command service 870 extensions, the server MAY include in the section of the 871 EPP response a element, which contains the following 872 child elements: 874 o A element (as described in Section 3.2); 875 o Zero or more elements (as described in Section 3.4); 876 o Zero or more elements (as described in Section 3.4); 877 o An OPTIONAL element (as described in Section 3.5); 878 o An OPTIONAL element (as described in 879 Section 3.6). 881 Example response: 883 S: 884 S: 885 S: 886 S: 887 S: Command completed successfully 888 S: 889 S: 890 S: 892 S: USD 893 S: -5.00 894 S: 1005.00 895 S: 896 S: 897 S: 898 S: ABC-12345 899 S: 54321-XYZ 900 S: 901 S: 902 S: 904 5.2.3. EPP Command 906 This extension adds elements to both the EPP command and 907 response, when the extension is included in the command 908 service extensions. 910 When submitting a command to the server, the client MAY 911 include in the element a element which 912 includes the following child elements: 914 o An OPTIONAL element (as described in Section 3.2); 915 o One or more elements (as described in Section 3.4). 917 When the command has been processed successfully, and the 918 client included the extension in the command service 919 extensions, the server MAY include in the section of the 920 EPP response a element, which contains the following 921 child elements: 923 o A element (as described in Section 3.2); 924 o Zero or more elements (as described in Section 3.4); 925 o Zero or more elements (as described in Section 3.4); 926 o An OPTIONAL element (as described in Section 3.5); 927 o An OPTIONAL element (as described in 928 Section 3.6). 930 Example command: 932 C: 933 C: 934 C: 935 C: 936 C: 938 C: example.com 939 C: 2000-04-03 940 C: 5 941 C: 942 C: 943 C: 944 C: 945 C: USD 946 C: 5.00 947 C: 948 C: 949 C: ABC-12345 950 C: 951 C: 952 Example response: 954 S: 955 S: 956 S: 957 S: 958 S: Command completed successfully 959 S: 960 S: 961 S: 963 S: example.com 964 S: 2005-04-03T22:00:00.0Z 965 S: 966 S: 967 S: 968 S: 969 S: USD 970 S: 5.00 973 S: 1000.00 974 S: 975 S: 976 S: 977 S: ABC-12345 978 S: 54322-XYZ 979 S: 980 S: 981 S: 983 5.2.4. EPP Command 985 This extension adds elements to both the EPP command and 986 response, when the value of the "op" attribute of the 987 command element is "request", and the extension is included in the 988 command service extensions. 990 When submitting a command to the server, the client MAY 991 include in the element a element which 992 includes the following child elements: 994 o An OPTIONAL element (as described in Section 3.2); 995 o One or more elements (as described in Section 3.4). 997 When the command has been processed successfully, and the 998 client included the extension in the command service 999 extensions, the server MAY include in the section of the 1000 EPP response a element, which contains the following 1001 child elements: 1003 o A element (as described in Section 3.2); 1004 o Zero or more elements (as described in Section 3.4); 1005 o Zero or more elements (as described in Section 3.4); 1006 o An OPTIONAL element (as described in Section 3.5); 1007 o An OPTIONAL element (as described in 1008 Section 3.6). 1010 Example command: 1012 C: 1013 C: 1014 C: 1015 C: 1016 C: 1018 C: example.com 1019 C: 1 1020 C: 1021 C: 2fooBAR 1022 C: 1023 C: 1024 C: 1025 C: 1026 C: 1027 C: USD 1028 C: 5.00 1029 C: 1030 C: 1031 C: ABC-12345 1032 C: 1033 C: 1034 Example response: 1036 S: 1037 S: 1038 S: 1039 S: 1040 S: Command completed successfully; action pending 1041 S: 1042 S: 1043 S: 1045 S: example.com 1046 S: pending 1047 S: ClientX 1048 S: 2000-06-08T22:00:00.0Z 1049 S: ClientY 1050 S: 2000-06-13T22:00:00.0Z 1051 S: 2002-09-08T22:00:00.0Z 1052 S: 1053 S: 1054 S: 1055 S: 1056 S: USD 1057 S: 5.00 1060 S: 1061 S: 1062 S: 1063 S: ABC-12345 1064 S: 54322-XYZ 1065 S: 1066 S: 1067 S: 1069 5.2.5. EPP Command 1071 This extension adds elements to both the EPP command and 1072 response, when the extension is included in the command 1073 service extensions. 1075 When submitting a command to the server, the client MAY 1076 include in the element a element which 1077 includes the following child elements: 1079 o An OPTIONAL element (as described in Section 3.2); 1080 o One or more elements (as described in Section 3.4). 1082 When the command has been processed successfully, and the 1083 client included the extension in the command service 1084 extensions, the server MAY include in the section of the 1085 EPP response a element, which contains the following 1086 child elements: 1088 o A element (as described in Section 3.2); 1089 o Zero or more elements (as described in Section 3.4); 1090 o Zero or more elements (as described in Section 3.4); 1091 o An OPTIONAL element (as described in Section 3.5); 1092 o An OPTIONAL element (as described in 1093 Section 3.6). 1095 Example command: 1097 C: 1098 C: 1099 C: 1100 C: 1101 C: 1103 C: example.com 1104 C: 1105 C: sh8013 1106 C: 1107 C: 1108 C: 1109 C: 1110 C: 1111 C: USD 1112 C: 5.00 1113 C: 1114 C: 1115 C: ABC-12345 1116 C: 1117 C: 1118 Example response: 1120 S: 1121 S: 1122 S: 1123 S: 1124 S: Command completed successfully 1125 S: 1126 S: 1127 S: 1128 S: USD 1129 S: 5.00 1130 S: 1131 S: 1132 S: 1133 S: ABC-12345 1134 S: 54321-XYZ 1135 S: 1136 S: 1137 S: 1139 6. Formal Syntax 1141 One schema is presented here that is the EPP Fee Extension schema. 1143 The formal syntax presented here is a complete schema representation 1144 of the object mapping suitable for automated validation of EPP XML 1145 instances. The BEGIN and END tags are not part of the schema; they 1146 are used to note the beginning and ending of the schema for URI 1147 registration purposes. 1149 6.1. Fee Extension Schema 1151 Copyright (c) 2018 IETF Trust and the persons identified as authors 1152 of the code. All rights reserved. 1154 Redistribution and use in source and binary forms, with or without 1155 modification, are permitted provided that the following conditions 1156 are met: 1158 o Redistributions of source code must retain the above copyright 1159 notice, this list of conditions and the following disclaimer. 1160 o Redistributions in binary form must reproduce the above copyright 1161 notice, this list of conditions and the following disclaimer in 1162 the documentation and/or other materials provided with the 1163 distribution. 1164 o Neither the name of Internet Society, IETF or IETF Trust, nor the 1165 names of specific contributors, may be used to endorse or promote 1166 products derived from this software without specific prior written 1167 permission. 1169 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1170 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1171 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1172 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1173 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 1174 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 1175 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1176 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 1177 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 1178 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 1179 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 1181 BEGIN 1182 1183 1190 1191 1193 1194 1195 Extensible Provisioning Protocol v1.0 Fee Extension 1196 1197 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1212 1213 1214 1215 1217 1219 1220 1222 1223 1224 1225 1227 1228 1229 1231 1232 1233 1234 1235 1237 1238 1240 1241 1242 1243 1244 1246 1247 1248 1249 1251 1252 1253 1254 1256 1258 1260 1261 1262 1263 1264 1265 1267 1269 1271 1273 1275 1277 1278 1280 1281 1282 1283 1284 1285 1287 1288 1289 1291 1292 1293 1294 1295 1296 1297 1299 1300 1301 1302 1303 1305 1307 1309 1311 1312 1313 1315 1316 1317 1318 1319 1320 1321 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1335 1336 1337 1338 1339 1341 1342 1343 1344 1345 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1360 1361 1362 1363 1364 1366 1367 1368 1369 1370 1371 1372 1374 1375 1376 1378 1379 1380 1382 1383 END 1385 7. Security Considerations 1387 The mapping extensions described in this document do not provide any 1388 security services beyond those described by EPP [RFC5730], the EPP 1389 domain name mapping [RFC5731], and protocol layers used by EPP. The 1390 security considerations described in these other specifications apply 1391 to this specification as well. 1393 8. IANA Considerations 1395 8.1. XML Namespace 1397 This document uses URNs to describe XML namespaces and XML schemas 1398 conforming to a registry mechanism described in [RFC3688]. 1400 Registration request for the fee namespace: 1402 URI: urn:ietf:params:xml:ns:fee-1.0 1404 Registrant Contact: IESG 1406 XML: None. Namespace URIs do not represent an XML specification. 1408 Registration request for the fee schema: 1410 URI: urn:ietf:params:xml:schema:fee-1.0 1412 Registrant Contact: IESG 1414 XML: See the "Formal Syntax" section of this document. 1416 8.2. EPP Extension Registry 1418 The EPP extension described in this document should be registered by 1419 the IANA in the EPP Extension Registry described in [RFC7451]. The 1420 details of the registration are as follows: 1422 Name of Extension: Registry Fee Extension for the Extensible 1423 Provisioning Protocol (EPP) 1425 Document status: Standards Track 1427 Reference: (insert reference to RFC version of this document) 1429 Registrant Name and Email Address: IESG, 1431 TLDs: Any 1433 IPR Disclosure: None 1435 Status: Active 1437 Notes: None 1439 9. Implementation Status 1441 Note to RFC Editor: Please remove this section and the reference to 1442 [RFC6982] before publication. 1444 This section records the status of known implementations of the 1445 protocol defined by this specification at the time of posting of this 1446 Internet-Draft, and is based on a proposal described in [RFC6982]. 1447 The description of implementations in this section is intended to 1448 assist the IETF in its decision processes in progressing drafts to 1449 RFCs. Please note that the listing of any individual implementation 1450 here does not imply endorsement by the IETF. Furthermore, no effort 1451 has been spent to verify the information presented here that was 1452 supplied by IETF contributors. This is not intended as, and must not 1453 be construed to be, a catalog of available implementations or their 1454 features. Readers are advised to note that other implementations may 1455 exist. 1457 According to [RFC6982], "this will allow reviewers and working groups 1458 to assign due consideration to documents that have the benefit of 1459 running code, which may serve as evidence of valuable experimentation 1460 and feedback that have made the implemented protocols more mature. 1461 It is up to the individual working groups to use this information as 1462 they see fit". 1464 9.1. RegistryEngine EPP Service 1466 Organization: CentralNic 1468 Name: RegistryEngine EPP Service 1470 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1471 SLDs 1473 Level of maturity: Deployed in CentralNic's production environment as 1474 well as two other gTLD registry systems, and two ccTLD registry 1475 systems. 1477 Coverage: All aspects of the protocol are implemented. 1479 Licensing: Proprietary In-House software 1481 Contact: epp@centralnic.com 1483 URL: https://www.centralnic.com 1485 10. Acknowledgements 1487 The authors wish to thank the following persons for their feedback 1488 and suggestions: 1490 o James Gould of Verisign Inc 1491 o Luis Munoz of ISC 1492 o Michael Young of Architelos 1493 o Ben Levac and Jeff Eckhaus of Demand Media 1494 o Seth Goldman of Google 1495 o Klaus Malorny and Michael Bauland of Knipp 1496 o Jody Kolker, Joe Snitker and Kevin Allendorf of Go Daddy 1497 o Michael Holloway of Com Laude 1498 o Santosh Kalsangrah of Impetus Infotech 1499 o Alex Mayrhofer of Nic.at 1500 o Thomas Corte of Knipp Medien und Kommunikation GmbH 1502 11. Change History 1504 11.1. Change from 10 to 11 1506 Updated document per Working Group Last Call comments. Made minor 1507 textual changes throughout for enhanced clarity per WGLC comments. 1509 11.2. Change from 09 to 10 1511 Updated document per Working Group Last Call comments. Updated 1512 schema to version 1.0 in anticipation of standardization, no changes 1513 were made to the latest, 0.25, schema. Made minor textual changes 1514 throughout for enhanced clarity per WGLC comments. 1516 11.3. Change from 08 to 09 1518 Updated scheme to version 0.25 to allow tighter checking on 1519 by splitting the client and server definitions, moved 1520 the class element from the command to the object level and added an 1521 optional standard attribute to the command element. Also updated 1522 section 3.1 for clarity on name attribute; updated section 3.9 for 1523 clarity on uses of ; removed second paragraph in section 1524 5.2.1 as it was duplicative of second to last paragraph in 4.0; and 1525 updated section 5.1.1 to add section references. 1527 11.4. Change from 07 to 08 1529 Updated section 3.8 and 5.1.1 to provide clarity on server processing 1530 and response of various scenarios (i.e. "quiet" period processing). 1532 11.5. Change from 06 to 07 1534 Updated section 3.8 and 4.0 to provide clarity on server processing 1535 and response of various scenarios. 1537 11.6. Change from 05 to 06 1539 Updated scheme to version 0.23 to allow the return of no 1540 element(s) if an error situation occurs. Edited 1541 section 3.8 extensively after input from interim meeting and REGEXT 1542 F2F meeting at IETF-99. Added normative reference for draft-ietf- 1543 eppext-launchphase. 1545 11.7. Change from 04 to 05 1547 Updated scheme to version 0.21 to support the lang attribute for the 1548 reason element of the objectCDType and the commandType types as well 1549 as to add the update command to the commandEnum type. Updated 1550 section 3.1 to include language for the custom command. Added 1551 section 3.9 to provide a description of the element. 1552 Fixed typos and added clarification text on when client fee is less 1553 than server fee in section 4. Additionally, I added description 1554 pointers to appropriate Section 3 definitions for element clarity 1555 throughout the document. 1557 11.8. Change from 03 to 04 1559 Updated scheme to version 0.19 to correct typos and to replace the 1560 commandTypeValue type with the commandEnum type and customName 1561 attribute for stricter validation. Updated various text for grammar 1562 and clarity. Added text to section 4 clarifying the response 1563 when the client provided no fee extension but the server was 1564 expecting the extension. 1566 11.9. Change from 02 to 03 1568 Updated scheme to version 0.17 to simplify the check command syntax. 1569 Moved fee avail to objectCDType to allow fast failing on error 1570 situations. Removed the objectCheckType as it was no longer being 1571 used. Updated examples to reflect these scheme changes. Added 1572 language for server failing a if the passed by the 1573 client is less than the server fee. 1575 11.10. Change from 01 to 02 1577 Updated scheme to version 0.15 to fix errors in CommandType, 1578 objectCDType, transformCommandType and transformResultType 1579 definitions. 1581 11.11. Change from 00 to 01 1583 Added Roger Carney as author to finish draft. Moved Formal Syntax 1584 section to main level numbering. Various grammar, typos, and 1585 administrative edits for clarity. Removed default value for the 1586 "applied" attribute of so that it can truly be optional. 1587 Added support for the command to return a element 1588 as well. Modified default response on the command for the 1589 optional when it was not provided in the command, 1590 leaving it to the server to provide the default period value. 1591 Extensive edits were done to the command, the 1592 response and to the fee extension schema (checkType, objectCheckType, 1593 objectIdentifierType, objectCDType, commandType) to support 1594 requesting and returning multiple transformation fees in a single 1595 call. Added section on Phase/Subphase to provide more context on the 1596 uses. 1598 11.12. Change from draft-brown-00 to draft-ietf-regext-fees-00 1600 Updated to be REGEXT WG document. 1602 12. Normative References 1604 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1605 Requirement Levels", BCP 14, RFC 2119, 1606 DOI 10.17487/RFC2119, March 1997, 1607 . 1609 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1610 DOI 10.17487/RFC3688, January 2004, 1611 . 1613 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1614 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1615 DOI 10.17487/RFC3915, September 2004, 1616 . 1618 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1619 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1620 . 1622 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1623 Domain Name Mapping", STD 69, RFC 5731, 1624 DOI 10.17487/RFC5731, August 2009, 1625 . 1627 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1628 Code: The Implementation Status Section", RFC 6982, 1629 DOI 10.17487/RFC6982, July 2013, 1630 . 1632 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1633 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1634 February 2015, . 1636 [RFC8334] Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping 1637 for the Extensible Provisioning Protocol (EPP)", RFC 8334, 1638 DOI 10.17487/RFC8334, March 2018, 1639 . 1641 Authors' Addresses 1642 Roger Carney 1643 GoDaddy Inc. 1644 14455 N. Hayden Rd. #219 1645 Scottsdale, AZ 85260 1646 US 1648 Email: rcarney@godaddy.com 1649 URI: http://www.godaddy.com 1651 Gavin Brown 1652 CentralNic Group plc 1653 35-39 Moorgate 1654 London, England EC2R 6AR 1655 GB 1657 Phone: +44 20 33 88 0600 1658 Email: gavin.brown@centralnic.com 1659 URI: http://www.centralnic.com 1661 Jothan Frakes 1663 Email: jothan@jothan.com 1664 URI: http://jothan.com