idnits 2.17.1 draft-ietf-regext-epp-fees-08.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 (October 1, 2017) is 2398 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 209, but not defined == Unused Reference: 'I-D.ietf-regext-launchphase' is defined on line 1515, but no explicit reference was found in the text == Outdated reference: A later version (-07) exists of draft-ietf-regext-launchphase-05 ** Obsolete normative reference: RFC 6982 (Obsoleted by RFC 7942) ** Downref: Normative reference to an Informational RFC: RFC 7451 Summary: 2 errors (**), 0 flaws (~~), 4 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: April 4, 2018 CentralNic Group plc 6 J. Frakes 7 October 1, 2017 9 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 10 draft-ietf-regext-epp-fees-08 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 April 4, 2018. 34 Copyright Notice 36 Copyright (c) 2017 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 . . . . . . . . . . . . . . . . . . . . 6 59 3.4.1. Refunds . . . . . . . . . . . . . . . . . . . . . . . 6 60 3.4.2. Grace Periods . . . . . . . . . . . . . . . . . . . . 7 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 . . . . . . . . . . . . . . . . . . . . . 10 70 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 10 71 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 10 72 5.1.1.1. Server Handling of Elements . . . . . . . . . . . 15 73 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . 15 74 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 16 75 5.2.1. EPP Command . . . . . . . . . . . . . . . . 16 76 5.2.2. EPP Command . . . . . . . . . . . . . . . . 19 77 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 20 78 5.2.4. EPP Command . . . . . . . . . . . . . . . 22 79 5.2.5. EPP Command . . . . . . . . . . . . . . . . 24 80 6. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 26 81 6.1. Fee Extension Schema . . . . . . . . . . . . . . . . . . 26 82 7. Security Considerations . . . . . . . . . . . . . . . . . . . 30 83 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 30 84 8.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 30 85 8.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 31 86 9. Implemntation Status . . . . . . . . . . . . . . . . . . . . 31 87 9.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . 32 88 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 32 89 11. Change History . . . . . . . . . . . . . . . . . . . . . . . 33 90 11.1. Change from 07 to 08 . . . . . . . . . . . . . . . . . . 33 91 11.2. Change from 06 to 07 . . . . . . . . . . . . . . . . . . 33 92 11.3. Change from 05 to 06 . . . . . . . . . . . . . . . . . . 33 93 11.4. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 33 94 11.5. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 33 95 11.6. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 33 96 11.7. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 34 97 11.8. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 34 98 11.9. Change from draft-brown-00 to draft-ietf-regext-fees-00 34 99 12. Normative References . . . . . . . . . . . . . . . . . . . . 34 100 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 35 102 1. Introduction 104 Historically, domain name registries have applied a simple fee 105 structure for billable transactions, namely a basic unit price 106 applied to domain , , and RGP [RFC3915] 107 restore commands. Given the relatively small number of EPP servers 108 to which EPP clients have been required to connect, it has generally 109 been the case that client operators have been able to obtain details 110 of these fees out-of-band by contacting the server operators. 112 Given the recent expansion of the DNS namespace, and the 113 proliferation of novel business models, it is now desirable to 114 provide a method for EPP clients to query EPP servers for the fees 115 and credits associated with certain commands and specific objects. 117 This document describes an extension mapping for version 1.0 of the 118 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 119 provides a mechanism by which EPP clients may query the fees and 120 credits associated with various billable transactions, and obtain 121 their current account balance. 123 1.1. Conventions Used in This Document 125 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 126 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 127 document are to be interpreted as described in RFC 2119 [RFC2119]. 129 XML is case sensitive. Unless stated otherwise, XML specifications 130 and examples provided in this document MUST be interpreted in the 131 character case presented in order to develop a conforming 132 implementation. 134 "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:fee- 135 0.23". The XML namespace prefix "fee" is used, but implementations 136 MUST NOT depend on it and instead employ a proper namespace-aware XML 137 parser and serializer to interpret and output the XML documents. 139 In examples, "C:" represents lines sent by a protocol client and "S:" 140 represents lines returned by a protocol server. Indentation and 141 white space in examples are provided only to illustrate element 142 relationships and are not a REQUIRED feature of this protocol. 144 (Note to RFC Editor: remove the following paragraph before 145 publication as an RFC.) 147 The XML namespace prefix above contains a version number, 148 specifically "0.23". This version number will increment with 149 successive versions of this document, and will reach 1.0 if and when 150 this document is published as an RFC. This permits clients to 151 distinguish which version of the extension a server has implemented. 153 2. Migrating to Newer Versions of This Extension 155 (Note to RFC Editor: remove this section before publication as an 156 RFC.) 158 Servers which implement this extension SHOULD provide a way for 159 clients to progressively update their implementations when a new 160 version of the extension is deployed. 162 Servers SHOULD (for a temporary migration period) provide support for 163 older versions of the extension in parallel to the newest version, 164 and allow clients to select their preferred version via the 165 element of the command. 167 If a client requests multiple versions of the extension at login, 168 then, when preparing responses to commands which do not include 169 extension elements, the server SHOULD only include extension elements 170 in the namespace of the newest version of the extension requested by 171 the client. 173 When preparing responses to commands which do include extension 174 elements, the server SHOULD only include extension elements for the 175 extension versions present in the command. 177 3. Extension Elements 179 3.1. Client Commands 181 The element is used in the EPP command to 182 determine the fee which is applicable to the given command. 184 The list of values include: 186 o "create" indicating a command as defined in [RFC5730]; 187 o "delete" indicating a command as defined in [RFC5730]; 188 o "renew" indicating a command as defined in [RFC5730]; 189 o "update" indicating a command as defined in [RFC5730]; 190 o "transfer" indicating a command as defined in 191 [RFC5730]; 193 o If the server supports the Registry Grace Period Mapping 194 [RFC3915], then the server MUST also support the "restore" value 195 as defined in [RFC3915]; 196 o "custom" indicating a custom command that uses the customName 197 attribute to define the custom operation. 199 The element MAY have an OPTIONAL "phase" attribute 200 specifying a launch phase as described in [draft-ietf-eppext- 201 launchphase]. It may also contain an OPTIONAL "subphase" attribute 202 identifying the custom or sub-phase as described in [draft-ietf- 203 eppext-launchphase]. 205 3.2. Currency Codes 207 The element is used to indicate which currency fees 208 are charged in. This value of this element MUST be a three-character 209 currency code from [ISO4217]. 211 Note that ISO 4217 provides the special "XXX" code, which MAY be used 212 if the server uses a non-currency based system for assessing fees, 213 such as a system of credits. 215 The use of elements in client commands is OPTIONAL: if 216 a element is not present in a command, the server MUST 217 determine the currency based on the client's account settings which 218 MUST be agreed by the client and server via an out-of-band channel. 219 However, the element MUST be present in responses. 221 Servers SHOULD NOT perform a currency conversion if a client uses an 222 incorrect currency code. Servers SHOULD return a 2004 "Parameter 223 value range" error instead. 225 3.3. Validity Periods 227 When querying for fee information using the command, the 228 element is used to indicate the units to be added to the 229 registration period of objects by the , and 230 commands. This element is derived from the 231 element described in [RFC5731]. 233 The element is OPTIONAL in commands, if omitted, 234 the server MUST determine the fee(s) using the server default period. 235 The element MUST be present in responses. 237 3.4. Fees and Credits 239 Servers which implement this extension will include elements in 240 responses which provide information about the fees and/or credits 241 associated with a given billable transaction. 243 The and elements are used to provide this 244 information. The presence of a element in a response 245 indicates a debit against the client's account balance; a 246 element indicates a credit. A element MUST 247 have a non-negative value. A element MUST have a 248 negative value. 250 A server MAY respond with multiple and 251 elements in the same response. In such cases, the net fee or credit 252 applicable to the transaction is the arithmetic sum of the values of 253 each of the and/or elements. This amount 254 applies to the total additional validity period applied to the object 255 (where applicable) rather than to any incremental unit. 257 The following attributes are defined for the element. 258 These are described in detail below: 260 description: an OPTIONAL attribute which provides a human-readable 261 description of the fee. Servers should provide documentation on the 262 possible values of this attribute, and their meanings. 264 refundable: an OPTIONAL boolean attribute indicating whether the fee 265 is refundable if the object is deleted. 267 grace-period: an OPTIONAL attribute which provides the time period 268 during which the fee is refundable. 270 applied: an OPTIONAL attribute indicating when the fee will be 271 deducted from the client's account. 273 The element can take a "description" attribute as 274 described above. No other attributes are defined for this element. 276 3.4.1. Refunds 278 elements MAY have an OPTIONAL "refundable" attribute which 279 takes a boolean value. Fees may be refunded under certain 280 circumstances, such as when a domain application is rejected (as 281 described in [draft-ietf-eppext-launchphase]) or when an object is 282 deleted during the relevant Grace Period (see below). 284 If the "refundable" attribute is omitted, then clients SHOULD NOT 285 make any assumption about the refundability of the fee. 287 3.4.2. Grace Periods 289 [RFC3915] describes a system of "grace periods", which are time 290 periods following a billable transaction during which, if an object 291 is deleted, the client receives a refund. 293 The "grace-period" attribute MAY be used to indicate the relevant 294 grace period for a fee. If a server implements the Registry Grace 295 Period extension, it MUST specify the grace period for all relevant 296 transactions. 298 If the "grace-period" attribute is omitted, then clients SHOULD NOT 299 make any assumption about the grace period of the fee. 301 3.4.3. Correlation between Refundability and Grace Periods 303 If a element has a "grace-period" attribute then it MUST 304 also be refundable. If the "refundable" attribute of a 305 element is false then it MUST NOT have a "grace-period" attribute. 307 3.4.4. Applicability 309 Fees may be applied immediately upon receipt of a command from a 310 client, or may only be applied once an out-of-band process (such as 311 the processing of applications at the end of a launch phase) has 312 taken place. 314 The "applied" attribute of the element allows servers to 315 indicate whether a fee will be applied immediately, or whether it 316 will be applied at some point in the future. This attribute takes 317 two possible values: "immediate" or "delayed". 319 3.5. Account Balance 321 The element is an OPTIONAL element which MAY be 322 included in server responses to transform commands. If present, it 323 can be used by the client to determine the remaining credit at the 324 server. 326 Whether or not the is included in responses is a matter 327 of server policy. However, if a server chooses to offer support for 328 this element, it MUST be included in responses to all "transform" or 329 billable commands (ie , , , , 330 ). 332 The value of the MAY be negative. A negative balance 333 indicates that the server has extended a line of credit to the client 334 (see below). 336 If a server includes a element in response to transform 337 commands, the value of the element MUST reflect the client's account 338 balance after any fees or credits associated with that command have 339 been applied. 341 3.6. Credit Limit 343 As described above, if a server returns a response containing a 344 with a negative value, then the server has extended a 345 line of credit to the client. A server MAY also include a 346 element in responses which indicates the maximum 347 credit available to a client. A server MAY reject certain 348 transactions if the absolute value of the is equal to 349 or exceeds the value of the element. 351 Whether or not the is included in responses is a 352 matter of server policy. However, if a server chooses to offer 353 support for this element, it MUST be included in responses to all 354 "transform" commands (ie , , , , 355 ). 357 3.7. Classification of Objects 359 Objects may be assigned to a particular class, category, or tier, 360 each of which has a particular fee or set of fees associated with it. 361 The element, which MAY appear in and transform 362 responses, is used to indicate the classification of an object. 364 If a server makes use of this element, it should provide clients with 365 a list of all the values that the element may take via an out-of-band 366 channel. Servers MUST NOT use values which do not appear on this 367 list. 369 Servers which make use of this element MUST use a element 370 with the value "standard" for all objects that are subject to the 371 standard or default fee. 373 3.8. Phase and Subphase Attributes 375 The element has two attributes, phase and subphase, 376 that provide additional information related to a specific launch 377 phase as described in [draft-ietf-eppext-launchphase]. These 378 attributes are used as filters that should refine the server 379 processing. 381 If the client contains a server supported combination 382 of phase/subphase the server MUST return fee data (including the 383 phase/subphase attribute(s)) for the specific combination. 385 If the client contains no phase/subphase attributes and 386 the server has only one active phase/subphase combination the server 387 MUST return data (including the phase/subphase attribute(s)) of the 388 currently active phase/subphase. 390 If the client contains no phase/subphase attributes and 391 the server has more than one active phase/subphase combination the 392 server MUST respond with a 2003 "Required parameter missing" error. 394 If the client contains no phase/subphase attributes and 395 the server is currently in a "quiet period" (e.g. not accepting 396 registrations or applications)the server MUST return data consistent 397 with the default general availability phase (e.g. "open" or "claims") 398 including the appropriate phase/subphase attribute(s). 400 If the client contains a phase attribute with no 401 subphase and the server has only one active subphase (or no subphase) 402 of this phase, the server MUST return data (including the phase/ 403 subphase attribute(s)) of the provided phase and currently active 404 subphase. 406 If the client contains a phase attribute with no 407 subphase and the server has more than one active subphase combination 408 of this phase, the server MUST respond with a 2003 "Required 409 parameter missing" error. 411 If the client contains a subphase with no phase 412 attribute the server MUST respond with a 2003 "Required parameter 413 missing" error. 415 If the client contains a phase attribute not defined in 416 [draft-ietf-eppext-launchphase] or not supported by server the server 417 MUST respond with a 2004 "Parameter value range" error. 419 If the client contains a subphase attribute (or phase/ 420 subphase combination) not supported by server the server MUST respond 421 with a 2004 "Parameter value range" error. 423 3.9. Reason 425 The element is used to provide server specific text in 426 an effort to better explain why an operation did not complete as the 427 client expected. An OPTIONAL "lang" attribute MAY be present to 428 identify the language of the returned text. 430 4. Server Handling of Fee Information 432 Depending on server policy, a client MAY be required to include the 433 extension elements described in this document for certain transform 434 commands. Servers must provide clear documentation to clients about 435 the circumstances in which this extension must be used. 437 The server MUST return avail="0" in its response to a command 438 for any domain name in the command that does not include the 439 extension for which the server would likewise fail a 440 domain command when no extension is provided for that 441 same domain name. 443 If a server receives a command from a client which results in 444 no possible fee combination but where a fee is required, the server 445 MUST set the "avail" attribute of the element to false and 446 provide a . 448 If a server receives a command from a client which results in 449 an ambiguous result (i.e. multiple possible fee combinations) the 450 server MUST reject the command with a 2003 "Required parameter 451 missing" error. 453 If a server receives a command from a client which does not include 454 the fee extension data elements required by the server for that 455 command, then the server MUST respond with a 2003 "Required parameter 456 missing" error. 458 If the currency or total fee provided by the client is less than the 459 server's own calculation of the fee for that command, then the server 460 MUST reject the command with a 2004 "Parameter value range" error. 462 5. EPP Command Mapping 464 A detailed description of the EPP syntax and semantics can be found 465 in [RFC5730]. 467 5.1. EPP Query Commands 469 This extension does not add any elements to the EPP or 470 commands or responses. 472 5.1.1. EPP Command 474 This extension defines a new command called the Fee Check Command 475 that defines additional elements for the EPP command to 476 provide fee information along with the availability information of 477 the EPP command. 479 The command MAY contain an element which MAY contain a 480 element. The element MAY contain one 481 element and MUST contain one or more 482 elements. 484 The element(s) contain(s) a "name" attribute, an 485 OPTIONAL "phase" attribute, and an OPTIONAL "subphase" attribute. 486 The element(s) MAY have the following child elements: 488 o An OPTIONAL element (as described in Section 3.3). 490 Example command: 492 C: 493 C: 494 C: 495 C: 496 C: 498 C: example.com 499 C: example.net 500 C: example.xyz 501 C: 502 C: 503 C: 504 C: 505 C: USD 506 C: 507 C: 2 508 C: 509 C: 510 C: 511 C: 512 C: 513 C: 514 C: ABC-12345 515 C: 516 C: 518 When the server receives a command that includes the 519 extension elements described above, its response MUST contain an 520 element, which MUST contain a child 521 element. The element MUST contain a 522 element and a for each element referenced in the client 523 command. 525 Each element MUST contain the following child elements: 527 o A element, which MUST match an element referenced in 528 the client command. 529 o A element matching each (unless the 530 "avail" attribute of the if false) that appeared in the 531 corresponding of the client command. This element MAY 532 have the OPTIONAL "phase" and "subphase" attributes, which SHOULD 533 match the same attributes in the corresponding 534 element of the client command if sent by the client. 536 The element also has an OPTIONAL "avail" attribute which is 537 a boolean. If the value of this attribute evaluates to false, this 538 indicates that the server cannot calculate the relevant fees, because 539 the object, command, currency, period, class or some combination is 540 invalid per server policy. If "avail" is false then the 541 element MUST contain a element (as described in 542 Section 3.9) and the server MAY eliminate some or all of the 543 element(s). 545 The element(s) MAY have the following child elements: 547 o An OPTIONAL element (as described in Section 3.3), 548 which contains the same unit that appeared in the 549 element of the command. If the value of the preceding 550 element is "restore", this element MUST NOT be 551 included, otherwise it MUST be included. If no 552 appeared in the client command (and the command is not "restore") 553 then the server MUST return its default period value. 554 o Zero or more elements (as described in Section 3.4). 555 o Zero or more elements (as described in Section 3.4). 556 o An OPTIONAL element (as described in Section 3.7). 557 o An OPTIONAL element (as described in Section 3.9). 559 If the "avail" attribute of the element is true and if no 560 elements are present in a element, this 561 indicates that no fee will be assessed by the server for this 562 command. 564 If the "avail" attribute is true, then the element MUST 565 NOT contain a element. 567 Example response: 569 S: 570 S: 571 S: 572 S: 573 S: Command completed successfully 574 S: 575 S: 576 S: 578 S: 579 S: example.com 580 S: 581 S: 582 S: example.net 583 S: 584 S: 585 S: example.xyz 586 S: 587 S: 588 S: 589 S: 590 S: 593 S: USD 594 S: 595 S: example.com 596 S: 597 S: 2 598 S: 10.00 602 S: 603 S: 604 S: 1 605 S: 5.00 609 S: 610 S: 611 S: 1 612 S: 5.00 616 S: 617 S: 618 S: 5.00 620 S: 621 S: 622 S: 623 S: example.net 624 S: 625 S: 2 626 S: 10.00 630 S: 631 S: 632 S: 1 633 S: 5.00 637 S: 638 S: 639 S: 1 640 S: 5.00 644 S: 645 S: 646 S: 5.00 648 S: 649 S: 650 S: 651 S: example.xyz 652 S: 653 S: 2 654 S: Only 1 year registration periods are 655 S: vaild. 656 S: 657 S: 658 S: 659 S: 660 S: 661 S: ABC-12345 662 S: 54322-XYZ 663 S: 664 S: 665 S: 667 5.1.1.1. Server Handling of Elements 669 Clients MAY include a in the element. 670 There are two ways in which servers may handle this element: 672 1. If the server supports the concept of tiers or classes of 673 objects, then the value of this element MUST be validated. If 674 incorrect for the specified object, the "avail" attribute of the 675 corresponding element MUST be false. 676 2. If the server supports different "types" of object registrations 677 (such as a "blocking" registration which does not resolve, or 678 where a registry provides a value-added service that requires an 679 opt-out to disable), then, as with the first model, the server 680 MUST validate the value of the element. If the value is 681 incorrect, the "avail" attribute of the corresponding 682 element MUST be false, and a element (as described 683 in Section 3.9) MUST be provided. 685 Server operators must provide clear documentation to client operators 686 which of the above models it supports. 688 5.1.2. EPP Transfer Query Command 690 This extension does not add any elements to the EPP query 691 command, but does include elements in the response, when the 692 extension has been selected during a command. 694 When the query command has been processed successfully, 695 the client selected the extension when it logged in, and the client 696 is authorized by the server to view information about the transfer, 697 the server MAY include in the section of the EPP response 698 a element, which contains the following child elements: 700 o A element (as described in Section 3.2). 701 o A element (as described in Section 3.3). 702 o Zero or more elements (as described in Section 3.4) 703 containing the fees that will be charged to the gaining client. 704 o Zero or more elements (as described in Section 3.4) 705 containing the credits that will be refunded to the losing client. 707 Servers SHOULD omit when returning a response to the 708 gaining client, and omit elements when returning a response 709 to the losing client. 711 If no element is included in the response, then no fee 712 will be assessed by the server for the transfer. 714 Example query response: 716 S: 717 S: 718 S: 719 S: 720 S: Command completed successfully; action pending 721 S: 722 S: 723 S: 725 S: example.com 726 S: pending 727 S: ClientX 728 S: 2000-06-08T22:00:00.0Z 729 S: ClientY 730 S: 2000-06-13T22:00:00.0Z 731 S: 2002-09-08T22:00:00.0Z 732 S: 733 S: 734 S: 735 S: 736 S: USD 737 S: 1 738 S: 5.00 739 S: 740 S: 741 S: 742 S: ABC-12345 743 S: 54322-XYZ 744 S: 745 S: 746 S: 748 5.2. EPP Transform Commands 750 5.2.1. EPP Command 752 This extension adds elements to both the EPP command and 753 response, when the extension has been selected during a 754 command. 756 If a command is received with no extension and 757 the server requires a extension for the 758 the server MUST respond with a 2003 "Required parameter missing" 759 error. 761 When submitting a command to the server, the client MAY 762 include in the element a element which 763 includes the following child elements: 765 o An OPTIONAL element (as described in Section 3.2); 766 o One or more elements (as described in Section 3.4). 768 The server MUST fail the command if the provided 769 by the client is less than the server fee. 771 When the command has been processed successfully, and the 772 client selected the extension when it logged in, and a fee was 773 assessed by the server for the transaction, the server MUST include 774 in the section of the EPP response a 775 element, which contains the following child elements: 777 o A element (as described in Section 3.2); 778 o Zero or more elements (as described in Section 3.4); 779 o Zero or more elements (as described in Section 3.4); 780 o An OPTIONAL element (as described in Section 3.5); 781 o An OPTIONAL element (as described in 782 Section 3.6). 784 Example command: 786 C: 787 C: 788 C: 789 C: 790 C: 792 C: example.com 793 C: 2 794 C: 795 C: ns1.example.net 796 C: ns2.example.net 797 C: 798 C: jd1234 799 C: sh8013 800 C: sh8013 801 C: 802 C: 2fooBAR 803 C: 804 C: 805 C: 806 C: 807 C: 808 C: USD 809 C: 5.00 810 C: 811 C: 812 C: ABC-12345 813 C: 814 C: 815 Example response: 817 S: 818 S: 819 S: 820 S: 821 S: Command completed successfully 822 S: 823 S: 824 S: 826 S: example.com 827 S: 1999-04-03T22:00:00.0Z 828 S: 2001-04-03T22:00:00.0Z 829 S: 830 S: 831 S: 832 S: 833 S: USD 834 S: 5.00 838 S: -5.00 839 S: 1000.00 840 S: 841 S: 842 S: 843 S: ABC-12345 844 S: 54321-XYZ 845 S: 846 S: 847 S: 849 5.2.2. EPP Command 851 This extension does not add any elements to the EPP command, 852 but does include elements in the response, when the extension has 853 been selected during the command. 855 When the command has been processed successfully, and the 856 client selected the extension when it logged in, the server MAY 857 include in the section of the EPP response a 858 element, which contains the following child elements: 860 o A element (as described in Section 3.2); 861 o Zero or more elements (as described in Section 3.4); 862 o Zero or more elements (as described in Section 3.4); 863 o An OPTIONAL element (as described in Section 3.5); 864 o An OPTIONAL element (as described in 865 Section 3.6). 867 Example response: 869 S: 870 S: 871 S: 872 S: 873 S: Command completed successfully 874 S: 875 S: 876 S: 878 S: USD 879 S: -5.00 880 S: 1005.00 881 S: 882 S: 883 S: 884 S: ABC-12345 885 S: 54321-XYZ 886 S: 887 S: 888 S: 890 5.2.3. EPP Command 892 This extension adds elements to both the EPP command and 893 response, when the extension has been selected during a 894 command. 896 When submitting a command to the server, the client MAY 897 include in the element a element which 898 includes the following child elements: 900 o An OPTIONAL element (as described in Section 3.2); 901 o One or more elements (as described in Section 3.4). 903 When the command has been processed successfully, and the 904 client selected the extension when it logged in, the server MAY 905 include in the section of the EPP response a 906 element, which contains the following child elements: 908 o A element (as described in Section 3.2); 909 o Zero or more elements (as described in Section 3.4); 910 o Zero or more elements (as described in Section 3.4); 911 o An OPTIONAL element (as described in Section 3.5); 912 o An OPTIONAL element (as described in 913 Section 3.6). 915 Example command: 917 C: 918 C: 919 C: 920 C: 921 C: 923 C: example.com 924 C: 2000-04-03 925 C: 5 926 C: 927 C: 928 C: 929 C: 930 C: USD 931 C: 5.00 932 C: 933 C: 934 C: ABC-12345 935 C: 936 C: 937 Example response: 939 S: 940 S: 941 S: 942 S: 943 S: Command completed successfully 944 S: 945 S: 946 S: 948 S: example.com 949 S: 2005-04-03T22:00:00.0Z 950 S: 951 S: 952 S: 953 S: 954 S: USD 955 S: 5.00 958 S: 1000.00 959 S: 960 S: 961 S: 962 S: ABC-12345 963 S: 54322-XYZ 964 S: 965 S: 966 S: 968 5.2.4. EPP Command 970 This extension adds elements to both the EPP command and 971 response, when the value of the "op" attribute of the 972 command element is "request", and the extension has been selected 973 during the command. 975 When submitting a command to the server, the client MAY 976 include in the element a element which 977 includes the following child elements: 979 o An OPTIONAL element (as described in Section 3.2); 980 o One or more elements (as described in Section 3.4). 982 When the command has been processed successfully, and the 983 client selected the extension when it logged in, the server MAY 984 include in the section of the EPP response a 985 element, which contains the following child elements: 987 o A element (as described in Section 3.2); 988 o Zero or more elements (as described in Section 3.4); 989 o Zero or more elements (as described in Section 3.4); 990 o An OPTIONAL element (as described in Section 3.5); 991 o An OPTIONAL element (as described in 992 Section 3.6). 994 Example command: 996 C: 997 C: 998 C: 999 C: 1000 C: 1002 C: example.com 1003 C: 1 1004 C: 1005 C: 2fooBAR 1006 C: 1007 C: 1008 C: 1009 C: 1010 C: 1011 C: USD 1012 C: 5.00 1013 C: 1014 C: 1015 C: ABC-12345 1016 C: 1017 C: 1018 Example response: 1020 S: 1021 S: 1022 S: 1023 S: 1024 S: Command completed successfully; action pending 1025 S: 1026 S: 1027 S: 1029 S: example.com 1030 S: pending 1031 S: ClientX 1032 S: 2000-06-08T22:00:00.0Z 1033 S: ClientY 1034 S: 2000-06-13T22:00:00.0Z 1035 S: 2002-09-08T22:00:00.0Z 1036 S: 1037 S: 1038 S: 1039 S: 1040 S: USD 1041 S: 5.00 1044 S: 1045 S: 1046 S: 1047 S: ABC-12345 1048 S: 54322-XYZ 1049 S: 1050 S: 1051 S: 1053 5.2.5. EPP Command 1055 This extension adds elements to both the EPP command and 1056 response, when the extension has been selected during the 1057 command. 1059 When submitting a command to the server, the client MAY 1060 include in the element a element which 1061 includes the following child elements: 1063 o An OPTIONAL element (as described in Section 3.2); 1064 o One or more elements (as described in Section 3.4). 1066 When the command has been processed successfully, and the 1067 client selected the extension when it logged in, the server MAY 1068 include in the section of the EPP response a 1069 element, which contains the following child elements: 1071 o A element (as described in Section 3.2); 1072 o Zero or more elements (as described in Section 3.4); 1073 o Zero or more elements (as described in Section 3.4); 1074 o An OPTIONAL element (as described in Section 3.5); 1075 o An OPTIONAL element (as described in 1076 Section 3.6). 1078 Example command: 1080 C: 1081 C: 1082 C: 1083 C: 1084 C: 1086 C: example.com 1087 C: 1088 C: sh8013 1089 C: 1090 C: 1091 C: 1092 C: 1093 C: 1094 C: USD 1095 C: 5.00 1096 C: 1097 C: 1098 C: ABC-12345 1099 C: 1100 C: 1101 Example response: 1103 S: 1104 S: 1105 S: 1106 S: 1107 S: Command completed successfully 1108 S: 1109 S: 1110 S: 1111 S: USD 1112 S: 5.00 1113 S: 1114 S: 1115 S: 1116 S: ABC-12345 1117 S: 54321-XYZ 1118 S: 1119 S: 1120 S: 1122 6. Formal Syntax 1124 One schema is presented here that is the EPP Fee Extension schema. 1126 The formal syntax presented here is a complete schema representation 1127 of the object mapping suitable for automated validation of EPP XML 1128 instances. The BEGIN and END tags are not part of the schema; they 1129 are used to note the beginning and ending of the schema for URI 1130 registration purposes. 1132 6.1. Fee Extension Schema 1134 BEGIN 1135 1136 1143 1144 1146 1147 1148 Extensible Provisioning Protocol v1.0 Fee Extension 1150 1151 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1166 1167 1168 1169 1171 1173 1174 1176 1177 1178 1179 1181 1182 1183 1185 1186 1187 1188 1189 1191 1192 1194 1195 1196 1197 1199 1200 1201 1202 1204 1205 1206 1207 1209 1211 1213 1214 1216 1217 1218 1219 1221 1223 1225 1227 1229 1231 1232 1234 1235 1236 1237 1238 1239 1241 1242 1243 1245 1247 1249 1250 1251 1252 1253 1254 1255 1256 1258 1259 1260 1261 1262 1263 1264 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1278 1279 1280 1281 1282 1284 1285 1286 1287 1288 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1308 1309 1310 1311 1312 1313 1314 1316 1317 1318 1320 1321 1322 1324 1325 END 1327 7. Security Considerations 1329 The mapping extensions described in this document do not provide any 1330 security services beyond those described by EPP [RFC5730], the EPP 1331 domain name mapping [RFC5731], and protocol layers used by EPP. The 1332 security considerations described in these other specifications apply 1333 to this specification as well. 1335 8. IANA Considerations 1337 8.1. XML Namespace 1339 This document uses URNs to describe XML namespaces and XML schemas 1340 conforming to a registry mechanism described in [RFC3688]. The 1341 following URI assignment is requested of IANA: 1343 URI: ietf:params:xml:ns:fee-0.23 1345 Registrant Contact: See the "Author's Address" section of this 1346 document. 1348 XML: See the "Formal Syntax" section of this document. 1350 8.2. EPP Extension Registry 1352 The EPP extension described in this document should be registered by 1353 the IANA in the EPP Extension Registry described in [RFC7451]. The 1354 details of the registration are as follows: 1356 Name of Extension: EPP Fee Extension 1358 Document status: Standards Track 1360 Reference: (insert reference to RFC version of this document) 1362 Registrant Name and Email Address: See the "Author's Address" section 1363 of this document. 1365 TLDs: any 1367 IPR Disclosure: none 1369 Status: active 1371 Notes: none 1373 9. Implemntation Status 1375 Note to RFC Editor: Please remove this section and the reference to 1376 [RFC6982] before publication. 1378 This section records the status of known implementations of the 1379 protocol defined by this specification at the time of posting of this 1380 Internet-Draft, and is based on a proposal described in [RFC6982]. 1381 The description of implementations in this section is intended to 1382 assist the IETF in its decision processes in progressing drafts to 1383 RFCs. Please note that the listing of any individual implementation 1384 here does not imply endorsement by the IETF. Furthermore, no effort 1385 has been spent to verify the information presented here that was 1386 supplied by IETF contributors. This is not intended as, and must not 1387 be construed to be, a catalog of available implementations or their 1388 features. Readers are advised to note that other implementations may 1389 exist. 1391 According to [RFC6982], "this will allow reviewers and working groups 1392 to assign due consideration to documents that have the benefit of 1393 running code, which may serve as evidence of valuable experimentation 1394 and feedback that have made the implemented protocols more mature. 1395 It is up to the individual working groups to use this information as 1396 they see fit". 1398 9.1. RegistryEngine EPP Service 1400 Organization: CentralNic 1402 Name: RegistryEngine EPP Service 1404 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1405 SLDs 1407 Level of maturity: Deployed in CentralNic's production environment as 1408 well as two other gTLD registry systems, and two ccTLD registry 1409 systems. 1411 Coverage: All aspects of the protocol are implemented. 1413 Licensing: Proprietary In-House software 1415 Contact: epp@centralnic.com 1417 URL: https://www.centralnic.com 1419 10. Acknowledgements 1421 The authors wish to thank the following persons for their feedback 1422 and suggestions: 1424 o James Gould of Verisign Inc 1425 o Luis Munoz of ISC 1426 o Michael Young of Architelos 1427 o Ben Levac and Jeff Eckhaus of Demand Media 1428 o Seth Goldman of Google 1429 o Klaus Malorny and Michael Bauland of Knipp 1430 o Jody Kolker, Joe Snitker and Kevin Allendorf of Go Daddy 1431 o Michael Holloway of Com Laude 1432 o Santosh Kalsangrah of Impetus Infotech 1433 o Alex Mayrhofer of Nic.at 1434 o Thomas Corte of Knipp Medien und Kommunikation GmbH 1436 11. Change History 1438 11.1. Change from 07 to 08 1440 Updated section 3.8 and 5.1.1 to provide clarity on server processing 1441 and response of various scenarios (i.e. "quiet" period processing). 1443 11.2. Change from 06 to 07 1445 Updated section 3.8 and 4.0 to provide clarity on server processing 1446 and response of various scenarios. 1448 11.3. Change from 05 to 06 1450 Updated scheme to version 0.23 to allow the return of no 1451 element(s) if an error situation occurs. Edited 1452 section 3.8 extensively after input from interim meeting and REGEXT 1453 F2F meeting at IETF-99. Added normative reference for draft-ietf- 1454 eppext-launchphase. 1456 11.4. Change from 04 to 05 1458 Updated scheme to version 0.21 to support the lang attribute for the 1459 reason element of the objectCDType and the commandType types as well 1460 as to add the update command to the commandEnum type. Updated 1461 section 3.1 to include language for the custom command. Added 1462 section 3.9 to provide a description of the element. 1463 Fixed typos and added clarification text on when client fee is less 1464 than server fee in section 4. Additionally, I added description 1465 pointers to appropriate Section 3 definitions for element clarity 1466 throughout the document. 1468 11.5. Change from 03 to 04 1470 Updated scheme to version 0.19 to correct typos and to replace the 1471 commandTypeValue type with the commandEnum type and customName 1472 attribute for stricter validation. Updated various text for grammar 1473 and clarity. Added text to section 4 clarifying the response 1474 when the client provided no fee extension but the server was 1475 expecting the extension. 1477 11.6. Change from 02 to 03 1479 Updated scheme to version 0.17 to simplify the check command syntax. 1480 Moved fee avail to objectCDType to allow fast failing on error 1481 situations. Removed the objectCheckType as it was no longer being 1482 used. Updated examples to reflect these scheme changes. Added 1483 language for server failing a if the passed by the 1484 client is less than the server fee. 1486 11.7. Change from 01 to 02 1488 Updated scheme to version 0.15 to fix errors in CommandType, 1489 objectCDType, transformCommandType and transformResultType 1490 definitions. 1492 11.8. Change from 00 to 01 1494 Added Roger Carney as author to finish draft. Moved Formal Syntax 1495 section to main level numbering. Various grammar, typos, and 1496 administrative edits for clarity. Removed default value for the 1497 "applied" attribute of so that it can truly be optional. 1498 Added support for the command to return a element 1499 as well. Modified default response on the command for the 1500 optional when it was not provided in the command, 1501 leaving it to the server to provide the default period value. 1502 Extensive edits were done to the command, the 1503 response and to the fee extension schema (checkType, objectCheckType, 1504 objectIdentifierType, objectCDType, commandType) to support 1505 requesting and returning multiple transformation fees in a single 1506 call. Added section on Phase/Subphase to provide more context on the 1507 uses. 1509 11.9. Change from draft-brown-00 to draft-ietf-regext-fees-00 1511 Updated to be REGEXT WG document. 1513 12. Normative References 1515 [I-D.ietf-regext-launchphase] 1516 Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping 1517 for the Extensible Provisioning Protocol (EPP)", draft- 1518 ietf-regext-launchphase-05 (work in progress), June 2017. 1520 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1521 Requirement Levels", BCP 14, RFC 2119, 1522 DOI 10.17487/RFC2119, March 1997, 1523 . 1525 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1526 DOI 10.17487/RFC3688, January 2004, 1527 . 1529 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1530 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1531 DOI 10.17487/RFC3915, September 2004, 1532 . 1534 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1535 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1536 . 1538 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1539 Domain Name Mapping", STD 69, RFC 5731, 1540 DOI 10.17487/RFC5731, August 2009, 1541 . 1543 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1544 Code: The Implementation Status Section", RFC 6982, 1545 DOI 10.17487/RFC6982, July 2013, 1546 . 1548 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1549 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1550 February 2015, . 1552 Authors' Addresses 1554 Roger Carney 1555 GoDaddy Inc. 1556 14455 N. Hayden Rd. #219 1557 Scottsdale, AZ 85260 1558 US 1560 Email: rcarney@godaddy.com 1561 URI: http://www.godaddy.com 1563 Gavin Brown 1564 CentralNic Group plc 1565 35-39 Moorgate 1566 London, England EC2R 6AR 1567 GB 1569 Phone: +44 20 33 88 0600 1570 Email: gavin.brown@centralnic.com 1571 URI: http://www.centralnic.com 1572 Jothan Frakes 1574 Email: jothan@jothan.com 1575 URI: http://jothan.com