idnits 2.17.1 draft-ietf-regext-epp-fees-07.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 (September 21, 2017) is 2399 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 207, but not defined == Unused Reference: 'I-D.ietf-regext-launchphase' is defined on line 1508, 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: March 25, 2018 CentralNic Group plc 6 J. Frakes 7 September 21, 2017 9 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 10 draft-ietf-regext-epp-fees-07 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 March 25, 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 . . . . . . . . . . . . . . . . . . . . 5 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 06 to 07 . . . . . . . . . . . . . . . . . . 33 91 11.2. Change from 05 to 06 . . . . . . . . . . . . . . . . . . 33 92 11.3. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 33 93 11.4. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 33 94 11.5. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 33 95 11.6. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 34 96 11.7. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 34 97 11.8. Change from draft-brown-00 to draft-ietf-regext-fees-00 34 98 12. Normative References . . . . . . . . . . . . . . . . . . . . 34 99 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 35 101 1. Introduction 103 Historically, domain name registries have applied a simple fee 104 structure for billable transactions, namely a basic unit price 105 applied to domain , , and RGP [RFC3915] 106 restore commands. Given the relatively small number of EPP servers 107 to which EPP clients have been required to connect, it has generally 108 been the case that client operators have been able to obtain details 109 of these fees out-of-band by contacting the server operators. 111 Given the recent expansion of the DNS namespace, and the 112 proliferation of novel business models, it is now desirable to 113 provide a method for EPP clients to query EPP servers for the fees 114 and credits associated with certain commands and specific objects. 116 This document describes an extension mapping for version 1.0 of the 117 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 118 provides a mechanism by which EPP clients may query the fees and 119 credits associated with various billable transactions, and obtain 120 their current account balance. 122 1.1. Conventions Used in This Document 124 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 125 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 126 document are to be interpreted as described in RFC 2119 [RFC2119]. 128 XML is case sensitive. Unless stated otherwise, XML specifications 129 and examples provided in this document MUST be interpreted in the 130 character case presented in order to develop a conforming 131 implementation. 133 "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:fee- 134 0.23". The XML namespace prefix "fee" is used, but implementations 135 MUST NOT depend on it and instead employ a proper namespace-aware XML 136 parser and serializer to interpret and output the XML documents. 138 In examples, "C:" represents lines sent by a protocol client and "S:" 139 represents lines returned by a protocol server. Indentation and 140 white space in examples are provided only to illustrate element 141 relationships and are not a REQUIRED feature of this protocol. 143 (Note to RFC Editor: remove the following paragraph before 144 publication as an RFC.) 145 The XML namespace prefix above contains a version number, 146 specifically "0.23". This version number will increment with 147 successive versions of this document, and will reach 1.0 if and when 148 this document is published as an RFC. This permits clients to 149 distinguish which version of the extension a server has implemented. 151 2. Migrating to Newer Versions of This Extension 153 (Note to RFC Editor: remove this section before publication as an 154 RFC.) 156 Servers which implement this extension SHOULD provide a way for 157 clients to progressively update their implementations when a new 158 version of the extension is deployed. 160 Servers SHOULD (for a temporary migration period) provide support for 161 older versions of the extension in parallel to the newest version, 162 and allow clients to select their preferred version via the 163 element of the command. 165 If a client requests multiple versions of the extension at login, 166 then, when preparing responses to commands which do not include 167 extension elements, the server SHOULD only include extension elements 168 in the namespace of the newest version of the extension requested by 169 the client. 171 When preparing responses to commands which do include extension 172 elements, the server SHOULD only include extension elements for the 173 extension versions present in the command. 175 3. Extension Elements 177 3.1. Client Commands 179 The element is used in the EPP command to 180 determine the fee which is applicable to the given command. 182 The list of values include: 184 o "create" indicating a command as defined in [RFC5730]; 185 o "delete" indicating a command as defined in [RFC5730]; 186 o "renew" indicating a command as defined in [RFC5730]; 187 o "update" indicating a command as defined in [RFC5730]; 188 o "transfer" indicating a command as defined in 189 [RFC5730]; 190 o If the server supports the Registry Grace Period Mapping 191 [RFC3915], then the server MUST also support the "restore" value 192 as defined in [RFC3915]; 194 o "custom" indicating a custom command that uses the customName 195 attribute to define the custom operation. 197 The element MAY have an OPTIONAL "phase" attribute 198 specifying a launch phase as described in [draft-ietf-eppext- 199 launchphase]. It may also contain an OPTIONAL "subphase" attribute 200 identifying the custom or sub-phase as described in [draft-ietf- 201 eppext-launchphase]. 203 3.2. Currency Codes 205 The element is used to indicate which currency fees 206 are charged in. This value of this element MUST be a three-character 207 currency code from [ISO4217]. 209 Note that ISO 4217 provides the special "XXX" code, which MAY be used 210 if the server uses a non-currency based system for assessing fees, 211 such as a system of credits. 213 The use of elements in client commands is OPTIONAL: if 214 a element is not present in a command, the server MUST 215 determine the currency based on the client's account settings which 216 MUST be agreed by the client and server via an out-of-band channel. 217 However, the element MUST be present in responses. 219 Servers SHOULD NOT perform a currency conversion if a client uses an 220 incorrect currency code. Servers SHOULD return a 2004 "Parameter 221 value range" error instead. 223 3.3. Validity Periods 225 When querying for fee information using the command, the 226 element is used to indicate the units to be added to the 227 registration period of objects by the , and 228 commands. This element is derived from the 229 element described in [RFC5731]. 231 The element is OPTIONAL in commands, if omitted, 232 the server MUST determine the fee(s) using the server default period. 233 The element MUST be present in responses. 235 3.4. Fees and Credits 237 Servers which implement this extension will include elements in 238 responses which provide information about the fees and/or credits 239 associated with a given billable transaction. 241 The and elements are used to provide this 242 information. The presence of a element in a response 243 indicates a debit against the client's account balance; a 244 element indicates a credit. A element MUST 245 have a non-negative value. A element MUST have a 246 negative value. 248 A server MAY respond with multiple and 249 elements in the same response. In such cases, the net fee or credit 250 applicable to the transaction is the arithmetic sum of the values of 251 each of the and/or elements. This amount 252 applies to the total additional validity period applied to the object 253 (where applicable) rather than to any incremental unit. 255 The following attributes are defined for the element. 256 These are described in detail below: 258 description: an OPTIONAL attribute which provides a human-readable 259 description of the fee. Servers should provide documentation on the 260 possible values of this attribute, and their meanings. 262 refundable: an OPTIONAL boolean attribute indicating whether the fee 263 is refundable if the object is deleted. 265 grace-period: an OPTIONAL attribute which provides the time period 266 during which the fee is refundable. 268 applied: an OPTIONAL attribute indicating when the fee will be 269 deducted from the client's account. 271 The element can take a "description" attribute as 272 described above. No other attributes are defined for this element. 274 3.4.1. Refunds 276 elements MAY have an OPTIONAL "refundable" attribute which 277 takes a boolean value. Fees may be refunded under certain 278 circumstances, such as when a domain application is rejected (as 279 described in [draft-ietf-eppext-launchphase]) or when an object is 280 deleted during the relevant Grace Period (see below). 282 If the "refundable" attribute is omitted, then clients SHOULD NOT 283 make any assumption about the refundability of the fee. 285 3.4.2. Grace Periods 287 [RFC3915] describes a system of "grace periods", which are time 288 periods following a billable transaction during which, if an object 289 is deleted, the client receives a refund. 291 The "grace-period" attribute MAY be used to indicate the relevant 292 grace period for a fee. If a server implements the Registry Grace 293 Period extension, it MUST specify the grace period for all relevant 294 transactions. 296 If the "grace-period" attribute is omitted, then clients SHOULD NOT 297 make any assumption about the grace period of the fee. 299 3.4.3. Correlation between Refundability and Grace Periods 301 If a element has a "grace-period" attribute then it MUST 302 also be refundable. If the "refundable" attribute of a 303 element is false then it MUST NOT have a "grace-period" attribute. 305 3.4.4. Applicability 307 Fees may be applied immediately upon receipt of a command from a 308 client, or may only be applied once an out-of-band process (such as 309 the processing of applications at the end of a launch phase) has 310 taken place. 312 The "applied" attribute of the element allows servers to 313 indicate whether a fee will be applied immediately, or whether it 314 will be applied at some point in the future. This attribute takes 315 two possible values: "immediate" or "delayed". 317 3.5. Account Balance 319 The element is an OPTIONAL element which MAY be 320 included in server responses to transform commands. If present, it 321 can be used by the client to determine the remaining credit at the 322 server. 324 Whether or not the is included in responses is a matter 325 of server policy. However, if a server chooses to offer support for 326 this element, it MUST be included in responses to all "transform" or 327 billable commands (ie , , , , 328 ). 330 The value of the MAY be negative. A negative balance 331 indicates that the server has extended a line of credit to the client 332 (see below). 334 If a server includes a element in response to transform 335 commands, the value of the element MUST reflect the client's account 336 balance after any fees or credits associated with that command have 337 been applied. 339 3.6. Credit Limit 341 As described above, if a server returns a response containing a 342 with a negative value, then the server has extended a 343 line of credit to the client. A server MAY also include a 344 element in responses which indicates the maximum 345 credit available to a client. A server MAY reject certain 346 transactions if the absolute value of the is equal to 347 or exceeds the value of the element. 349 Whether or not the is included in responses is a 350 matter of server policy. However, if a server chooses to offer 351 support for this element, it MUST be included in responses to all 352 "transform" commands (ie , , , , 353 ). 355 3.7. Classification of Objects 357 Objects may be assigned to a particular class, category, or tier, 358 each of which has a particular fee or set of fees associated with it. 359 The element, which MAY appear in and transform 360 responses, is used to indicate the classification of an object. 362 If a server makes use of this element, it should provide clients with 363 a list of all the values that the element may take via an out-of-band 364 channel. Servers MUST NOT use values which do not appear on this 365 list. 367 Servers which make use of this element MUST use a element 368 with the value "standard" for all objects that are subject to the 369 standard or default fee. 371 3.8. Phase and Subphase Attributes 373 The element has two attributes, phase and subphase, 374 that provide additional information related to a specific launch 375 phase as described in [draft-ietf-eppext-launchphase]. These 376 attributes are used as filters that should refine the server 377 processing. 379 If the client contains a server supported combination 380 of phase/subphase the server MUST return fee data (including the 381 phase/subphase attribute(s)) for the specific combination. 383 If the client contains no phase/subphase attributes and 384 the server has only one active phase/subphase combination the server 385 MUST return data (including the phase/subphase attribute(s)) of the 386 currently active phase/subphase. 388 If the client contains no phase/subphase attributes and 389 the server has more than one active phase/subphase combination the 390 server MUST respond with a 2003 "Required parameter missing" error. 392 If the client contains no phase/subphase attributes and 393 the server is currently in a "quiet period" (e.g. not accepting 394 registrations or applications) the server MUST return data consistent 395 with the "open" general availability phase (the default phase) and 396 the server MUST return "open" as the phase. 398 If the client contains a phase attribute with no 399 subphase and the server has only one active subphase (or no subphase) 400 of this phase, the server MUST return data (including the phase/ 401 subphase attribute(s)) of the provided phase and currently active 402 subphase. 404 If the client contains a phase attribute with no 405 subphase and the server has more than one active subphase combination 406 of this phase, the server MUST respond with a 2003 "Required 407 parameter missing" error. 409 If the client contains a subphase with no phase 410 attribute the server MUST respond with a 2003 "Required parameter 411 missing" error. 413 If the client contains a phase attribute not defined in 414 [draft-ietf-eppext-launchphase] or not supported by server the server 415 MUST respond with a 2004 "Parameter value range" error. 417 If the client contains a subphase attribute (or phase/ 418 subphase combination) not supported by server the server MUST respond 419 with a 2004 "Parameter value range" error. 421 3.9. Reason 423 The element is used to provide server specific text in 424 an effort to better explain why an operation did not complete as the 425 client expected. An OPTIONAL "lang" attribute MAY be present to 426 identify the language of the returned text. 428 4. Server Handling of Fee Information 430 Depending on server policy, a client MAY be required to include the 431 extension elements described in this document for certain transform 432 commands. Servers must provide clear documentation to clients about 433 the circumstances in which this extension must be used. 435 The server MUST return avail="0" in its response to a command 436 for any domain name in the command that does not include the 437 extension for which the server would likewise fail a 438 domain command when no extension is provided for that 439 same domain name. 441 If a server receives a command from a client which results in 442 no possible fee combination but where a fee is required, the server 443 MUST set the "avail" attribute of the element to false and 444 provide a . 446 If a server receives a command from a client which results in 447 an ambiguous result (i.e. multiple possible fee combinations) the 448 server MUST reject the command with a 2003 "Required parameter 449 missing" error. 451 If a server receives a command from a client which does not include 452 the fee extension data elements required by the server for that 453 command, then the server MUST respond with a 2003 "Required parameter 454 missing" error. 456 If the currency or total fee provided by the client is less than the 457 server's own calculation of the fee for that command, then the server 458 MUST reject the command with a 2004 "Parameter value range" error. 460 5. EPP Command Mapping 462 A detailed description of the EPP syntax and semantics can be found 463 in [RFC5730]. 465 5.1. EPP Query Commands 467 This extension does not add any elements to the EPP or 468 commands or responses. 470 5.1.1. EPP Command 472 This extension defines a new command called the Fee Check Command 473 that defines additional elements for the EPP command to 474 provide fee information along with the availability information of 475 the EPP command. 477 The command MAY contain an element which MAY contain a 478 element. The element MAY contain one 479 element and MUST contain one or more 480 elements. 482 The element(s) contain(s) a "name" attribute, an 483 OPTIONAL "phase" attribute, and an OPTIONAL "subphase" attribute. 484 The element(s) MAY have the following child elements: 486 o An OPTIONAL element (as described in Section 3.3). 488 Example command: 490 C: 491 C: 492 C: 493 C: 494 C: 496 C: example.com 497 C: example.net 498 C: example.xyz 499 C: 500 C: 501 C: 502 C: 503 C: USD 504 C: 505 C: 2 506 C: 507 C: 508 C: 509 C: 510 C: 511 C: 512 C: ABC-12345 513 C: 514 C: 516 When the server receives a command that includes the 517 extension elements described above, its response MUST contain an 518 element, which MUST contain a child 519 element. The element MUST contain a 520 element and a for each element referenced in the client 521 command. 523 Each element MUST contain the following child elements: 525 o A element, which MUST match an element referenced in 526 the client command. 527 o A element matching each (unless the 528 "avail" attribute of the if false) that appeared in the 529 corresponding of the client command. This element MAY 530 have the OPTIONAL "phase" and "subphase" attributes, which MUST 531 match the same attributes in the corresponding 532 element of the client command if sent by the client. 534 The element also has an OPTIONAL "avail" attribute which is 535 a boolean. If the value of this attribute evaluates to false, this 536 indicates that the server cannot calculate the relevant fees, because 537 the object, command, currency, period, class or some combination is 538 invalid per server policy. If "avail" is false then the 539 element MUST contain a element (as described in 540 Section 3.9) and the server MAY eliminate some or all of the 541 element(s). 543 The element(s) MAY have the following child elements: 545 o An OPTIONAL element (as described in Section 3.3), 546 which contains the same unit that appeared in the 547 element of the command. If the value of the preceding 548 element is "restore", this element MUST NOT be 549 included, otherwise it MUST be included. If no 550 appeared in the client command (and the command is not "restore") 551 then the server MUST return its default period value. 552 o Zero or more elements (as described in Section 3.4). 553 o Zero or more elements (as described in Section 3.4). 554 o An OPTIONAL element (as described in Section 3.7). 555 o An OPTIONAL element (as described in Section 3.9). 557 If the "avail" attribute of the element is true and if no 558 elements are present in a element, this 559 indicates that no fee will be assessed by the server for this 560 command. 562 If the "avail" attribute is true, then the element MUST 563 NOT contain a element. 565 Example response: 567 S: 568 S: 569 S: 570 S: 571 S: Command completed successfully 572 S: 573 S: 574 S: 576 S: 577 S: example.com 578 S: 579 S: 580 S: example.net 581 S: 582 S: 583 S: example.xyz 584 S: 585 S: 586 S: 587 S: 588 S: 591 S: USD 592 S: 593 S: example.com 594 S: 595 S: 2 596 S: 10.00 600 S: 601 S: 602 S: 1 603 S: 5.00 607 S: 608 S: 609 S: 1 610 S: 5.00 614 S: 615 S: 616 S: 5.00 618 S: 619 S: 620 S: 621 S: example.net 622 S: 623 S: 2 624 S: 10.00 628 S: 629 S: 630 S: 1 631 S: 5.00 635 S: 636 S: 637 S: 1 638 S: 5.00 642 S: 643 S: 644 S: 5.00 646 S: 647 S: 648 S: 649 S: example.xyz 650 S: 651 S: 2 652 S: Only 1 year registration periods are 653 S: vaild. 654 S: 655 S: 656 S: 657 S: 658 S: 659 S: ABC-12345 660 S: 54322-XYZ 661 S: 662 S: 663 S: 665 5.1.1.1. Server Handling of Elements 667 Clients MAY include a in the element. 668 There are two ways in which servers may handle this element: 670 1. If the server supports the concept of tiers or classes of 671 objects, then the value of this element MUST be validated. If 672 incorrect for the specified object, the "avail" attribute of the 673 corresponding element MUST be false. 674 2. If the server supports different "types" of object registrations 675 (such as a "blocking" registration which does not resolve, or 676 where a registry provides a value-added service that requires an 677 opt-out to disable), then, as with the first model, the server 678 MUST validate the value of the element. If the value is 679 incorrect, the "avail" attribute of the corresponding 680 element MUST be false, and a element (as described 681 in Section 3.9) MUST be provided. 683 Server operators must provide clear documentation to client operators 684 which of the above models it supports. 686 5.1.2. EPP Transfer Query Command 688 This extension does not add any elements to the EPP query 689 command, but does include elements in the response, when the 690 extension has been selected during a command. 692 When the query command has been processed successfully, 693 the client selected the extension when it logged in, and the client 694 is authorized by the server to view information about the transfer, 695 the server MAY include in the section of the EPP response 696 a element, which contains the following child elements: 698 o A element (as described in Section 3.2). 699 o A element (as described in Section 3.3). 700 o Zero or more elements (as described in Section 3.4) 701 containing the fees that will be charged to the gaining client. 702 o Zero or more elements (as described in Section 3.4) 703 containing the credits that will be refunded to the losing client. 705 Servers SHOULD omit when returning a response to the 706 gaining client, and omit elements when returning a response 707 to the losing client. 709 If no element is included in the response, then no fee 710 will be assessed by the server for the transfer. 712 Example query response: 714 S: 715 S: 716 S: 717 S: 718 S: Command completed successfully; action pending 719 S: 720 S: 721 S: 723 S: example.com 724 S: pending 725 S: ClientX 726 S: 2000-06-08T22:00:00.0Z 727 S: ClientY 728 S: 2000-06-13T22:00:00.0Z 729 S: 2002-09-08T22:00:00.0Z 730 S: 731 S: 732 S: 733 S: 734 S: USD 735 S: 1 736 S: 5.00 737 S: 738 S: 739 S: 740 S: ABC-12345 741 S: 54322-XYZ 742 S: 743 S: 744 S: 746 5.2. EPP Transform Commands 748 5.2.1. EPP Command 750 This extension adds elements to both the EPP command and 751 response, when the extension has been selected during a 752 command. 754 If a command is received with no extension and 755 the server requires a extension for the 756 the server MUST respond with a 2003 "Required parameter missing" 757 error. 759 When submitting a command to the server, the client MAY 760 include in the element a element which 761 includes the following child elements: 763 o An OPTIONAL element (as described in Section 3.2); 764 o One or more elements (as described in Section 3.4). 766 The server MUST fail the command if the provided 767 by the client is less than the server fee. 769 When the command has been processed successfully, and the 770 client selected the extension when it logged in, and a fee was 771 assessed by the server for the transaction, the server MUST include 772 in the section of the EPP response a 773 element, which contains the following child elements: 775 o A element (as described in Section 3.2); 776 o Zero or more elements (as described in Section 3.4); 777 o Zero or more elements (as described in Section 3.4); 778 o An OPTIONAL element (as described in Section 3.5); 779 o An OPTIONAL element (as described in 780 Section 3.6). 782 Example command: 784 C: 785 C: 786 C: 787 C: 788 C: 790 C: example.com 791 C: 2 792 C: 793 C: ns1.example.net 794 C: ns2.example.net 795 C: 796 C: jd1234 797 C: sh8013 798 C: sh8013 799 C: 800 C: 2fooBAR 801 C: 802 C: 803 C: 804 C: 805 C: 806 C: USD 807 C: 5.00 808 C: 809 C: 810 C: ABC-12345 811 C: 812 C: 813 Example response: 815 S: 816 S: 817 S: 818 S: 819 S: Command completed successfully 820 S: 821 S: 822 S: 824 S: example.com 825 S: 1999-04-03T22:00:00.0Z 826 S: 2001-04-03T22:00:00.0Z 827 S: 828 S: 829 S: 830 S: 831 S: USD 832 S: 5.00 836 S: -5.00 837 S: 1000.00 838 S: 839 S: 840 S: 841 S: ABC-12345 842 S: 54321-XYZ 843 S: 844 S: 845 S: 847 5.2.2. EPP Command 849 This extension does not add any elements to the EPP command, 850 but does include elements in the response, when the extension has 851 been selected during the command. 853 When the command has been processed successfully, and the 854 client selected the extension when it logged in, the server MAY 855 include in the section of the EPP response a 856 element, which contains the following child elements: 858 o A element (as described in Section 3.2); 859 o Zero or more elements (as described in Section 3.4); 860 o Zero or more elements (as described in Section 3.4); 861 o An OPTIONAL element (as described in Section 3.5); 862 o An OPTIONAL element (as described in 863 Section 3.6). 865 Example response: 867 S: 868 S: 869 S: 870 S: 871 S: Command completed successfully 872 S: 873 S: 874 S: 876 S: USD 877 S: -5.00 878 S: 1005.00 879 S: 880 S: 881 S: 882 S: ABC-12345 883 S: 54321-XYZ 884 S: 885 S: 886 S: 888 5.2.3. EPP Command 890 This extension adds elements to both the EPP command and 891 response, when the extension has been selected during a 892 command. 894 When submitting a command to the server, the client MAY 895 include in the element a element which 896 includes the following child elements: 898 o An OPTIONAL element (as described in Section 3.2); 899 o One or more elements (as described in Section 3.4). 901 When the command has been processed successfully, and the 902 client selected the extension when it logged in, the server MAY 903 include in the section of the EPP response a 904 element, which contains the following child elements: 906 o A element (as described in Section 3.2); 907 o Zero or more elements (as described in Section 3.4); 908 o Zero or more elements (as described in Section 3.4); 909 o An OPTIONAL element (as described in Section 3.5); 910 o An OPTIONAL element (as described in 911 Section 3.6). 913 Example command: 915 C: 916 C: 917 C: 918 C: 919 C: 921 C: example.com 922 C: 2000-04-03 923 C: 5 924 C: 925 C: 926 C: 927 C: 928 C: USD 929 C: 5.00 930 C: 931 C: 932 C: ABC-12345 933 C: 934 C: 935 Example response: 937 S: 938 S: 939 S: 940 S: 941 S: Command completed successfully 942 S: 943 S: 944 S: 946 S: example.com 947 S: 2005-04-03T22:00:00.0Z 948 S: 949 S: 950 S: 951 S: 952 S: USD 953 S: 5.00 956 S: 1000.00 957 S: 958 S: 959 S: 960 S: ABC-12345 961 S: 54322-XYZ 962 S: 963 S: 964 S: 966 5.2.4. EPP Command 968 This extension adds elements to both the EPP command and 969 response, when the value of the "op" attribute of the 970 command element is "request", and the extension has been selected 971 during the command. 973 When submitting a command to the server, the client MAY 974 include in the element a element which 975 includes the following child elements: 977 o An OPTIONAL element (as described in Section 3.2); 978 o One or more elements (as described in Section 3.4). 980 When the command has been processed successfully, and the 981 client selected the extension when it logged in, the server MAY 982 include in the section of the EPP response a 983 element, which contains the following child elements: 985 o A element (as described in Section 3.2); 986 o Zero or more elements (as described in Section 3.4); 987 o Zero or more elements (as described in Section 3.4); 988 o An OPTIONAL element (as described in Section 3.5); 989 o An OPTIONAL element (as described in 990 Section 3.6). 992 Example command: 994 C: 995 C: 996 C: 997 C: 998 C: 1000 C: example.com 1001 C: 1 1002 C: 1003 C: 2fooBAR 1004 C: 1005 C: 1006 C: 1007 C: 1008 C: 1009 C: USD 1010 C: 5.00 1011 C: 1012 C: 1013 C: ABC-12345 1014 C: 1015 C: 1016 Example response: 1018 S: 1019 S: 1020 S: 1021 S: 1022 S: Command completed successfully; action pending 1023 S: 1024 S: 1025 S: 1027 S: example.com 1028 S: pending 1029 S: ClientX 1030 S: 2000-06-08T22:00:00.0Z 1031 S: ClientY 1032 S: 2000-06-13T22:00:00.0Z 1033 S: 2002-09-08T22:00:00.0Z 1034 S: 1035 S: 1036 S: 1037 S: 1038 S: USD 1039 S: 5.00 1042 S: 1043 S: 1044 S: 1045 S: ABC-12345 1046 S: 54322-XYZ 1047 S: 1048 S: 1049 S: 1051 5.2.5. EPP Command 1053 This extension adds elements to both the EPP command and 1054 response, when the extension has been selected during the 1055 command. 1057 When submitting a command to the server, the client MAY 1058 include in the element a element which 1059 includes the following child elements: 1061 o An OPTIONAL element (as described in Section 3.2); 1062 o One or more elements (as described in Section 3.4). 1064 When the command has been processed successfully, and the 1065 client selected the extension when it logged in, the server MAY 1066 include in the section of the EPP response a 1067 element, which contains the following child elements: 1069 o A element (as described in Section 3.2); 1070 o Zero or more elements (as described in Section 3.4); 1071 o Zero or more elements (as described in Section 3.4); 1072 o An OPTIONAL element (as described in Section 3.5); 1073 o An OPTIONAL element (as described in 1074 Section 3.6). 1076 Example command: 1078 C: 1079 C: 1080 C: 1081 C: 1082 C: 1084 C: example.com 1085 C: 1086 C: sh8013 1087 C: 1088 C: 1089 C: 1090 C: 1091 C: 1092 C: USD 1093 C: 5.00 1094 C: 1095 C: 1096 C: ABC-12345 1097 C: 1098 C: 1099 Example response: 1101 S: 1102 S: 1103 S: 1104 S: 1105 S: Command completed successfully 1106 S: 1107 S: 1108 S: 1109 S: USD 1110 S: 5.00 1111 S: 1112 S: 1113 S: 1114 S: ABC-12345 1115 S: 54321-XYZ 1116 S: 1117 S: 1118 S: 1120 6. Formal Syntax 1122 One schema is presented here that is the EPP Fee Extension schema. 1124 The formal syntax presented here is a complete schema representation 1125 of the object mapping suitable for automated validation of EPP XML 1126 instances. The BEGIN and END tags are not part of the schema; they 1127 are used to note the beginning and ending of the schema for URI 1128 registration purposes. 1130 6.1. Fee Extension Schema 1132 BEGIN 1133 1134 1141 1142 1144 1145 1146 Extensible Provisioning Protocol v1.0 Fee Extension 1148 1149 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1164 1165 1166 1167 1169 1171 1172 1174 1175 1176 1177 1179 1180 1181 1183 1184 1185 1186 1187 1189 1190 1192 1193 1194 1195 1197 1198 1199 1200 1202 1203 1204 1205 1207 1209 1211 1212 1214 1215 1216 1217 1219 1221 1223 1225 1227 1229 1230 1232 1233 1234 1235 1236 1237 1239 1240 1241 1243 1245 1247 1248 1249 1250 1251 1252 1253 1254 1256 1257 1258 1259 1260 1261 1262 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1276 1277 1278 1279 1280 1282 1283 1284 1285 1286 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1306 1307 1308 1309 1310 1311 1312 1314 1315 1316 1318 1319 1320 1322 1323 END 1325 7. Security Considerations 1327 The mapping extensions described in this document do not provide any 1328 security services beyond those described by EPP [RFC5730], the EPP 1329 domain name mapping [RFC5731], and protocol layers used by EPP. The 1330 security considerations described in these other specifications apply 1331 to this specification as well. 1333 8. IANA Considerations 1335 8.1. XML Namespace 1337 This document uses URNs to describe XML namespaces and XML schemas 1338 conforming to a registry mechanism described in [RFC3688]. The 1339 following URI assignment is requested of IANA: 1341 URI: ietf:params:xml:ns:fee-0.23 1343 Registrant Contact: See the "Author's Address" section of this 1344 document. 1346 XML: See the "Formal Syntax" section of this document. 1348 8.2. EPP Extension Registry 1350 The EPP extension described in this document should be registered by 1351 the IANA in the EPP Extension Registry described in [RFC7451]. The 1352 details of the registration are as follows: 1354 Name of Extension: EPP Fee Extension 1356 Document status: Standards Track 1358 Reference: (insert reference to RFC version of this document) 1360 Registrant Name and Email Address: See the "Author's Address" section 1361 of this document. 1363 TLDs: any 1365 IPR Disclosure: none 1367 Status: active 1369 Notes: none 1371 9. Implemntation Status 1373 Note to RFC Editor: Please remove this section and the reference to 1374 [RFC6982] before publication. 1376 This section records the status of known implementations of the 1377 protocol defined by this specification at the time of posting of this 1378 Internet-Draft, and is based on a proposal described in [RFC6982]. 1379 The description of implementations in this section is intended to 1380 assist the IETF in its decision processes in progressing drafts to 1381 RFCs. Please note that the listing of any individual implementation 1382 here does not imply endorsement by the IETF. Furthermore, no effort 1383 has been spent to verify the information presented here that was 1384 supplied by IETF contributors. This is not intended as, and must not 1385 be construed to be, a catalog of available implementations or their 1386 features. Readers are advised to note that other implementations may 1387 exist. 1389 According to [RFC6982], "this will allow reviewers and working groups 1390 to assign due consideration to documents that have the benefit of 1391 running code, which may serve as evidence of valuable experimentation 1392 and feedback that have made the implemented protocols more mature. 1393 It is up to the individual working groups to use this information as 1394 they see fit". 1396 9.1. RegistryEngine EPP Service 1398 Organization: CentralNic 1400 Name: RegistryEngine EPP Service 1402 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1403 SLDs 1405 Level of maturity: Deployed in CentralNic's production environment as 1406 well as two other gTLD registry systems, and two ccTLD registry 1407 systems. 1409 Coverage: All aspects of the protocol are implemented. 1411 Licensing: Proprietary In-House software 1413 Contact: epp@centralnic.com 1415 URL: https://www.centralnic.com 1417 10. Acknowledgements 1419 The authors wish to thank the following persons for their feedback 1420 and suggestions: 1422 o James Gould of Verisign Inc 1423 o Luis Munoz of ISC 1424 o Michael Young of Architelos 1425 o Ben Levac and Jeff Eckhaus of Demand Media 1426 o Seth Goldman of Google 1427 o Klaus Malorny and Michael Bauland of Knipp 1428 o Jody Kolker, Joe Snitker and Kevin Allendorf of Go Daddy 1429 o Michael Holloway of Com Laude 1430 o Santosh Kalsangrah of Impetus Infotech 1431 o Alex Mayrhofer of Nic.at 1432 o Thomas Corte of Knipp Medien und Kommunikation GmbH 1434 11. Change History 1436 11.1. Change from 06 to 07 1438 Updated section 3.8 and 4.0 to provide clarity on server processing 1439 and response of various scenarios. 1441 11.2. Change from 05 to 06 1443 Updated scheme to version 0.23 to allow the return of no 1444 element(s) if an error situation occurs. Edited 1445 section 3.8 extensively after input from interim meeting and REGEXT 1446 F2F meeting at IETF-99. Added normative reference for draft-ietf- 1447 eppext-launchphase. 1449 11.3. Change from 04 to 05 1451 Updated scheme to version 0.21 to support the lang attribute for the 1452 reason element of the objectCDType and the commandType types as well 1453 as to add the update command to the commandEnum type. Updated 1454 section 3.1 to include language for the custom command. Added 1455 section 3.9 to provide a description of the element. 1456 Fixed typos and added clarification text on when client fee is less 1457 than server fee in section 4. Additionally, I added description 1458 pointers to appropriate Section 3 definitions for element clarity 1459 throughout the document. 1461 11.4. Change from 03 to 04 1463 Updated scheme to version 0.19 to correct typos and to replace the 1464 commandTypeValue type with the commandEnum type and customName 1465 attribute for stricter validation. Updated various text for grammar 1466 and clarity. Added text to section 4 clarifying the response 1467 when the client provided no fee extension but the server was 1468 expecting the extension. 1470 11.5. Change from 02 to 03 1472 Updated scheme to version 0.17 to simplify the check command syntax. 1473 Moved fee avail to objectCDType to allow fast failing on error 1474 situations. Removed the objectCheckType as it was no longer being 1475 used. Updated examples to reflect these scheme changes. Added 1476 language for server failing a if the passed by the 1477 client is less than the server fee. 1479 11.6. Change from 01 to 02 1481 Updated scheme to version 0.15 to fix errors in CommandType, 1482 objectCDType, transformCommandType and transformResultType 1483 definitions. 1485 11.7. Change from 00 to 01 1487 Added Roger Carney as author to finish draft. Moved Formal Syntax 1488 section to main level numbering. Various grammar, typos, and 1489 administrative edits for clarity. Removed default value for the 1490 "applied" attribute of so that it can truly be optional. 1491 Added support for the command to return a element 1492 as well. Modified default response on the command for the 1493 optional when it was not provided in the command, 1494 leaving it to the server to provide the default period value. 1495 Extensive edits were done to the command, the 1496 response and to the fee extension schema (checkType, objectCheckType, 1497 objectIdentifierType, objectCDType, commandType) to support 1498 requesting and returning multiple transformation fees in a single 1499 call. Added section on Phase/Subphase to provide more context on the 1500 uses. 1502 11.8. Change from draft-brown-00 to draft-ietf-regext-fees-00 1504 Updated to be REGEXT WG document. 1506 12. Normative References 1508 [I-D.ietf-regext-launchphase] 1509 Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping 1510 for the Extensible Provisioning Protocol (EPP)", draft- 1511 ietf-regext-launchphase-05 (work in progress), June 2017. 1513 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1514 Requirement Levels", BCP 14, RFC 2119, 1515 DOI 10.17487/RFC2119, March 1997, 1516 . 1518 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1519 DOI 10.17487/RFC3688, January 2004, 1520 . 1522 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1523 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1524 DOI 10.17487/RFC3915, September 2004, 1525 . 1527 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1528 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1529 . 1531 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1532 Domain Name Mapping", STD 69, RFC 5731, 1533 DOI 10.17487/RFC5731, August 2009, 1534 . 1536 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1537 Code: The Implementation Status Section", RFC 6982, 1538 DOI 10.17487/RFC6982, July 2013, 1539 . 1541 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1542 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1543 February 2015, . 1545 Authors' Addresses 1547 Roger Carney 1548 GoDaddy Inc. 1549 14455 N. Hayden Rd. #219 1550 Scottsdale, AZ 85260 1551 US 1553 Email: rcarney@godaddy.com 1554 URI: http://www.godaddy.com 1556 Gavin Brown 1557 CentralNic Group plc 1558 35-39 Moorgate 1559 London, England EC2R 6AR 1560 GB 1562 Phone: +44 20 33 88 0600 1563 Email: gavin.brown@centralnic.com 1564 URI: http://www.centralnic.com 1566 Jothan Frakes 1568 Email: jothan@jothan.com 1569 URI: http://jothan.com