idnits 2.17.1 draft-ietf-regext-epp-fees-13.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 7, 2018) is 2058 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) -- Possible downref: Non-RFC (?) normative reference: ref. 'ISO4217' ** Downref: Normative reference to an Informational RFC: RFC 7451 Summary: 1 error (**), 0 flaws (~~), 1 warning (==), 2 comments (--). 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 11, 2019 CentralNic Group plc 6 J. Frakes 7 September 7, 2018 9 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 10 draft-ietf-regext-epp-fees-13 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 11, 2019. 34 Copyright Notice 36 Copyright (c) 2018 IETF Trust and the persons identified as the 37 document authors. All rights reserved. 39 This document is subject to BCP 78 and the IETF Trust's Legal 40 Provisions Relating to IETF Documents 41 (https://trustee.ietf.org/license-info) in effect on the date of 42 publication of this document. Please review these documents 43 carefully, as they describe your rights and restrictions with respect 44 to this document. Code Components extracted from this document must 45 include Simplified BSD License text as described in Section 4.e of 46 the Trust Legal Provisions and are provided without warranty as 47 described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 52 1.1. Conventions Used in This Document . . . . . . . . . . . . 3 53 2. Migrating to Newer Versions of This Extension . . . . . . . . 4 54 3. Extension Elements . . . . . . . . . . . . . . . . . . . . . 4 55 3.1. Client Commands . . . . . . . . . . . . . . . . . . . . . 4 56 3.2. Currency Codes . . . . . . . . . . . . . . . . . . . . . 5 57 3.3. Validity Periods . . . . . . . . . . . . . . . . . . . . 5 58 3.4. Fees and Credits . . . . . . . . . . . . . . . . . . . . 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 . . . . . . . . . . . . . 11 69 5. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 11 70 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 11 71 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 11 72 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . 16 73 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 17 74 5.2.1. EPP Command . . . . . . . . . . . . . . . . 17 75 5.2.2. EPP Command . . . . . . . . . . . . . . . . 19 76 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 20 77 5.2.4. EPP Command . . . . . . . . . . . . . . . 22 78 5.2.5. EPP Command . . . . . . . . . . . . . . . . 24 79 6. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 26 80 6.1. Fee Extension Schema . . . . . . . . . . . . . . . . . . 26 81 7. Security Considerations . . . . . . . . . . . . . . . . . . . 31 82 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 31 83 8.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 31 84 8.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 32 85 9. Implementation Status . . . . . . . . . . . . . . . . . . . . 32 86 9.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . 33 87 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 33 88 11. Change History . . . . . . . . . . . . . . . . . . . . . . . 34 89 11.1. Change from 12 to 13 . . . . . . . . . . . . . . . . . . 34 90 11.2. Change from 11 to 12 . . . . . . . . . . . . . . . . . . 34 91 11.3. Change from 10 to 11 . . . . . . . . . . . . . . . . . . 34 92 11.4. Change from 09 to 10 . . . . . . . . . . . . . . . . . . 34 93 11.5. Change from 08 to 09 . . . . . . . . . . . . . . . . . . 34 94 11.6. Change from 07 to 08 . . . . . . . . . . . . . . . . . . 34 95 11.7. Change from 06 to 07 . . . . . . . . . . . . . . . . . . 35 96 11.8. Change from 05 to 06 . . . . . . . . . . . . . . . . . . 35 97 11.9. Change from 04 to 05 . . . . . . . . . . . . . . . . . . 35 98 11.10. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 35 99 11.11. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 35 100 11.12. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 35 101 11.13. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 36 102 11.14. Change from draft-brown-00 to draft-ietf-regext-fees-00 36 103 12. Normative References . . . . . . . . . . . . . . . . . . . . 36 104 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 37 106 1. Introduction 108 Historically, domain name registries have applied a simple fee 109 structure for billable transactions, namely a basic unit price 110 applied to domain , , and RGP [RFC3915] 111 restore commands. Given the relatively small number of EPP servers 112 to which EPP clients have been required to connect, it has generally 113 been the case that client operators have been able to obtain details 114 of these fees out-of-band by contacting the server operators. 116 Given the recent expansion of the DNS namespace, and the 117 proliferation of novel business models, it is now desirable to 118 provide a method for EPP clients to query EPP servers for the fees 119 and credits associated with certain commands and specific objects. 121 This document describes an extension mapping for version 1.0 of the 122 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 123 provides a mechanism by which EPP clients may query the fees and 124 credits associated with various billable transactions, and obtain 125 their current account balance. 127 1.1. Conventions Used in This Document 129 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 130 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 131 "OPTIONAL" in this document are to be interpreted as described in BCP 132 14 [RFC2119] [RFC8174] when, and only when, they appear in all 133 capitals, as shown here. 135 XML is case sensitive. Unless stated otherwise, XML specifications 136 and examples provided in this document MUST be interpreted in the 137 character case presented in order to develop a conforming 138 implementation. 140 "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:epp:fee- 141 1.0". The XML namespace prefix "fee" is used, but implementations 142 MUST NOT depend on it and instead employ a proper namespace-aware XML 143 parser and serializer to interpret and output the XML documents. 145 In examples, "C:" represents lines sent by a protocol client and "S:" 146 represents lines returned by a protocol server. Indentation and 147 white space in examples are provided only to illustrate element 148 relationships and are not a REQUIRED feature of this protocol. 150 2. Migrating to Newer Versions of This Extension 152 (Note to RFC Editor: remove this section before publication as an 153 RFC.) 155 Servers which implement this extension SHOULD provide a way for 156 clients to progressively update their implementations when a new 157 version of the extension is deployed. 159 Servers SHOULD (for a temporary migration period) provide support for 160 older versions of the extension in parallel to the newest version, 161 and allow clients to select their preferred version via the 162 element of the command. 164 If a client requests multiple versions of the extension at login, 165 then, when preparing responses to commands which do not include 166 extension elements, the server SHOULD only include extension elements 167 in the namespace of the newest version of the extension requested by 168 the client. 170 When preparing responses to commands which do include extension 171 elements, the server SHOULD only include extension elements for the 172 extension versions present in the command. 174 3. Extension Elements 176 3.1. Client Commands 178 The element is used in the EPP command to 179 determine the fee which is applicable to the given command. 181 The use of the keys off the use of the "name" attribute 182 to define which transform fees the client is requesting information 183 about. Here is the list of possible values for the "name" attribute: 185 o "create" indicating a command as defined in [RFC5730]; 186 o "delete" indicating a command as defined in [RFC5730]; 187 o "renew" indicating a command as defined in [RFC5730]; 188 o "update" indicating a command as defined in [RFC5730]; 189 o "transfer" indicating a command as defined in 190 [RFC5730]; 192 o If the server supports the Registry Grace Period Mapping 193 [RFC3915], then the server MUST also support the "restore" value 194 as defined in [RFC3915]; 195 o "custom" indicating a custom command that uses the "customName" 196 attribute to define the custom operation. 198 The element MAY have an OPTIONAL "phase" attribute 199 specifying a launch phase as described in [RFC8334]. It may also 200 contain an OPTIONAL "subphase" attribute identifying the custom or 201 sub-phase as described in [RFC8334]. 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 server default currency or based 216 on the client's account settings which are agreed to by the client 217 and server via an out-of-band channel. However, the 218 element MUST be present in responses. 220 Servers SHOULD NOT perform a currency conversion if a client uses an 221 incorrect currency code. Servers SHOULD return a 2004 "Parameter 222 value range" error instead. 224 3.3. Validity Periods 226 When querying for fee information using the command, the 227 element is used to indicate the units to be added to the 228 registration period of objects by the , and 229 commands. This element is derived from the 230 element described in [RFC5731]. 232 The element is OPTIONAL in commands, if omitted, 233 the server MUST determine the fee(s) using the server default period. 234 The element MUST be present in responses. 236 3.4. Fees and Credits 238 Servers which implement this extension will include elements in 239 responses which provide information about the fees and/or credits 240 associated with a given billable transaction. 242 The and elements are used to provide this 243 information. The presence of a element in a response 244 indicates a debit against the client's account balance; a 245 element indicates a credit. A element MUST 246 have a non-negative value. A element MUST have a 247 negative value. 249 A server MAY respond with multiple and 250 elements in the same response. In such cases, the net fee or credit 251 applicable to the transaction is the arithmetic sum of the values of 252 each of the and/or elements. This amount 253 applies to the total additional validity period applied to the object 254 (where applicable) rather than to any incremental unit. 256 The following attributes are defined for the element. 257 These are described in detail below: 259 description: an OPTIONAL attribute which provides a human-readable 260 description of the fee. Servers should provide documentation on the 261 possible values of this attribute, and their meanings. 263 refundable: an OPTIONAL boolean attribute indicating whether the fee 264 is refundable if the object is deleted. 266 grace-period: an OPTIONAL attribute which provides the time period 267 during which the fee is refundable. 269 applied: an OPTIONAL attribute indicating when the fee will be 270 deducted from the client's account. 272 The element can take a "description" attribute as 273 described above. No other attributes are defined for this element. 275 3.4.1. Refunds 277 elements MAY have an OPTIONAL "refundable" attribute which 278 takes a boolean value. Fees may be refunded under certain 279 circumstances, such as when a domain application is rejected (as 280 described in [RFC8334]) or when an object is deleted during the 281 relevant Grace Period (see below). 283 If the "refundable" attribute is omitted, then clients SHOULD NOT 284 make any assumption about the refundability of the fee. 286 3.4.2. Grace Periods 288 [RFC3915] describes a system of "grace periods", which are time 289 periods following a billable transaction during which, if an object 290 is deleted, the client receives a refund. 292 The "grace-period" attribute MAY be used to indicate the relevant 293 grace period for a fee. If a server implements the Registry Grace 294 Period extension [RFC3915], it MUST specify the grace period for all 295 relevant transactions. 297 If the "grace-period" attribute is omitted, then clients SHOULD NOT 298 make any assumption about the grace period of the fee. 300 3.4.3. Correlation between Refundability and Grace Periods 302 If a element has a "grace-period" attribute then it MUST 303 also be refundable. If the "refundable" attribute of a 304 element is false then it MUST NOT have a "grace-period" attribute. 306 3.4.4. Applicability 308 Fees may be applied immediately upon receipt of a command from a 309 client, or may only be applied once an out-of-band process (such as 310 the processing of applications at the end of a launch phase) has 311 taken place. 313 The "applied" attribute of the element allows servers to 314 indicate whether a fee will be applied immediately, or whether it 315 will be applied at some point in the future. This attribute takes 316 two possible values: "immediate" or "delayed". 318 3.5. Account Balance 320 The element is an OPTIONAL element which MAY be 321 included in server responses to transform commands. If present, it 322 can be used by the client to determine the remaining credit at the 323 server. 325 Whether or not the is included in responses is a matter 326 of server policy. However, if a server chooses to offer support for 327 this element, it MUST be included in responses to all "transform" or 328 billable commands (e.g. , , , , 329 ). 331 The value of the MAY be negative. A negative balance 332 indicates that the server has extended a line of credit to the client 333 (see below). 335 If a server includes a element in response to transform 336 commands, the value of the element MUST reflect the client's account 337 balance after any fees or credits associated with that command have 338 been applied. 340 3.6. Credit Limit 342 As described above, if a server returns a response containing a 343 with a negative value, then the server has extended a 344 line of credit to the client. A server MAY also include a 345 element in responses which indicates the maximum 346 credit available to a client. A server MAY reject certain 347 transactions if the absolute value of the is equal to 348 or exceeds the value of the element. 350 Whether or not the is included in responses is a 351 matter of server policy. However, if a server chooses to offer 352 support for this element, it MUST be included in responses to all 353 "transform" commands (e.g. , , , , 354 ). 356 3.7. Classification of Objects 358 Objects may be assigned to a particular class, category, or tier, 359 each of which has a particular fee or set of fees associated with it. 360 The element, which MAY appear in and transform 361 responses, is used to indicate the classification of an object. 363 If a server makes use of this element, it should provide clients with 364 a list of all the values that the element may take via an out-of-band 365 channel. Servers MUST NOT use values which do not appear on this 366 list. 368 Servers which make use of this element MUST use a element 369 with the value "standard" for all objects that are subject to the 370 standard or default fee. 372 3.8. Phase and Subphase Attributes 374 The element has two attributes, phase and subphase, 375 that provide additional information related to a specific launch 376 phase as described in [RFC8334]. These attributes are used as 377 filters that should refine the server 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 default general availability phase (e.g. "open" or "claims") 396 including the appropriate phase/subphase attribute(s). 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 [RFC8334] or not supported by server the server MUST respond with a 415 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 a command did not complete as 425 the client expected. An OPTIONAL "lang" attribute MAY be present to 426 identify the language of the returned text and has a default value of 427 "en" (English). 429 The element can be used within the server response 430 element or within the element. 432 If the server cannot calculate the relevant fees, because the object, 433 command, currency, period, class or some combination is invalid per 434 server policy, the server has two ways of handling error processing 435 of element(s): 437 1. Fast-fail - The server, upon error identification, MAY stop 438 processing elements and return to the client a 439 containing the and a element 440 detailing the reason for failure. 442 S: 443 S: example.xyz 444 S: Only 1 year registration periods are 445 S: valid. 446 S: 448 2. Partial-fail - The server, upon error identification, MAY 449 continue processing elements and return to the 450 client a containing successfully processed 451 elements and failed elements. All returned failed 452 elements MUST have a element detailing 453 the reason for failure, and the server MAY additionally include a 454 element at the level. 456 S: 457 S: example.xyz 458 S: 459 S: 2 460 S: Only 1 year registration periods are 461 S: valid. 462 S: 463 S: 465 In either failure scenario the server MUST set the avail 466 attribute to false (0) and the server MUST process all objects in the 467 client request. 469 4. Server Handling of Fee Information 471 Depending on server policy, a client MAY be required to include the 472 extension elements described in this document for certain transform 473 commands. Servers must provide clear documentation to clients about 474 the circumstances in which this extension must be used. 476 The server MUST return avail="0" in its response to a command 477 for any object in the command that does not include the 478 extension for which the server would likewise fail a 479 domain command when no extension is provided for that 480 same object. 482 If a server receives a command from a client, which results 483 in no possible fee combination but where a fee is required, the 484 server MUST set the "avail" attribute of the element to 485 false and provide a . 487 If a server receives a command from a client, which results 488 in an ambiguous result (i.e. multiple possible fee combinations) the 489 server MUST reject the command with a 2003 "Required parameter 490 missing" error. 492 If a server receives a command from a client, which does not include 493 the fee extension data elements required by the server for that 494 command, then the server MUST respond with a 2003 "Required parameter 495 missing" error. 497 If the currency or total fee provided by the client is less than the 498 server's own calculation of the fee for that command, then the server 499 MUST reject the command with a 2004 "Parameter value range" error. 501 5. EPP Command Mapping 503 A detailed description of the EPP syntax and semantics can be found 504 in [RFC5730]. 506 5.1. EPP Query Commands 508 This extension does not add any elements to the EPP or 509 commands or responses. 511 5.1.1. EPP Command 513 This extension defines a new command called the Fee Check Command 514 that defines additional elements for the EPP command to 515 provide fee information along with the availability information of 516 the EPP command. 518 The command MAY contain an element which MAY contain a 519 element. The element MAY contain one 520 element and MUST contain one or more 521 elements. 523 The element(s) contain(s) a "name" attribute (see 524 Section 3.1), an OPTIONAL "phase" attribute, and an OPTIONAL 525 "subphase" attribute (see Section 3.8). The element(s) 526 MAY have the following child elements: 528 o An OPTIONAL element (as described in Section 3.3). 530 Example command: 532 C: 533 C: 534 C: 535 C: 536 C: 538 C: example.com 539 C: example.net 540 C: example.xyz 541 C: 542 C: 543 C: 544 C: 545 C: USD 546 C: 547 C: 2 548 C: 549 C: 550 C: 551 C: 552 C: 553 C: 554 C: ABC-12345 555 C: 556 C: 558 When the server receives a command that includes the 559 extension elements described above, its response MUST contain an 560 element, which MUST contain a child 561 element. The element MUST contain a 562 element and a for each element referenced in the client 563 command. 565 Each element MUST contain the following child elements: 567 o A element, which MUST match an element referenced in 568 the client command. 569 o An OPTIONAL element (as described in Section 3.7). 570 o A element matching each (unless the 571 "avail" attribute of the if false) that appeared in the 572 corresponding of the client command. This element MAY 573 have the OPTIONAL "standard" attribute, with a default value of 574 "0" (or "false"), which indicates whether the fee matches the fee 575 of the "standard" classification (see section 3.7). This element 576 MAY have the OPTIONAL "phase" and "subphase" attributes, which 577 SHOULD match the same attributes in the corresponding 578 element of the client command if sent by the client. 580 The element also has an OPTIONAL "avail" attribute which is 581 a boolean. If the value of this attribute evaluates to false, this 582 indicates that the server cannot calculate the relevant fees, because 583 the object, command, currency, period, class or some combination is 584 invalid per server policy. If "avail" is false then the or 585 the element MUST contain a element (as 586 described in Section 3.9) and the server MAY eliminate some or all of 587 the element(s). 589 The element(s) MAY have the following child elements: 591 o An OPTIONAL element (as described in Section 3.3), 592 which contains the same unit that appeared in the 593 element of the command. If the value of the preceding 594 element is "restore", this element MUST NOT be 595 included, otherwise it MUST be included. If no 596 appeared in the client command (and the command is not "restore") 597 then the server MUST return its default period value. 598 o Zero or more elements (as described in Section 3.4). 599 o Zero or more elements (as described in Section 3.4). 600 o An OPTIONAL element (as described in Section 3.9). 602 If the "avail" attribute of the element is true and if no 603 elements are present in a element, this 604 indicates that no fee will be assessed by the server for this 605 command. 607 If the "avail" attribute is true, then the element MUST 608 NOT contain a element. 610 Example response: 612 S: 613 S: 614 S: 615 S: 616 S: Command completed successfully 617 S: 618 S: 619 S: 621 S: 622 S: example.com 623 S: 624 S: 625 S: example.net 626 S: 627 S: 628 S: example.xyz 629 S: 630 S: 631 S: 632 S: 633 S: 635 S: USD 636 S: 637 S: example.com 638 S: Premium 639 S: 640 S: 2 641 S: 10.00 645 S: 646 S: 647 S: 1 648 S: 10.00 652 S: 653 S: 654 S: 1 655 S: 10.00 659 S: 660 S: 661 S: 15.00 663 S: 664 S: 665 S: 666 S: example.net 667 S: standard 668 S: 669 S: 2 670 S: 5.00 674 S: 675 S: 676 S: 1 677 S: 5.00 681 S: 682 S: 683 S: 1 684 S: 5.00 688 S: 689 S: 690 S: 5.00 692 S: 693 S: 694 S: 695 S: example.xyz 696 S: 697 S: 2 698 S: Only 1 year registration periods are 699 S: valid. 700 S: 701 S: 702 S: 703 S: 704 S: 705 S: ABC-12345 706 S: 54322-XYZ 707 S: 708 S: 709 S: 711 5.1.2. EPP Transfer Query Command 713 This extension does not add any elements to the EPP query 714 command, but does include elements in the response, when the 715 extension is included in the command service extensions. 717 When the query command has been processed successfully, if 718 the client has included the extension in the command service 719 element, and if the client is authorized by the server 720 to view information about the transfer, then the server MAY include 721 in the section of the EPP response a 722 element, which contains the following child elements: 724 o A element (as described in Section 3.2). 725 o A element (as described in Section 3.3). 726 o Zero or more elements (as described in Section 3.4) 727 containing the fees that will be charged to the gaining client. 728 o Zero or more elements (as described in Section 3.4) 729 containing the credits that will be refunded to the losing client. 731 Servers SHOULD omit when returning a response to the 732 gaining client, and omit elements when returning a response 733 to the losing client. 735 If no element is included in the response, then no fee 736 will be assessed by the server for the transfer. 738 Example query response: 740 S: 741 S: 742 S: 743 S: 744 S: Command completed successfully; action pending 745 S: 746 S: 747 S: 749 S: example.com 750 S: pending 751 S: ClientX 752 S: 2000-06-08T22:00:00.0Z 753 S: ClientY 754 S: 2000-06-13T22:00:00.0Z 755 S: 2002-09-08T22:00:00.0Z 756 S: 757 S: 758 S: 759 S: 760 S: USD 761 S: 1 762 S: 5.00 763 S: 764 S: 765 S: 766 S: ABC-12345 767 S: 54322-XYZ 768 S: 769 S: 770 S: 772 5.2. EPP Transform Commands 774 5.2.1. EPP Command 776 This extension adds elements to both the EPP command and 777 response, when the extension is included in the command 778 service extensions. 780 When submitting a command to the server, the client MAY 781 include in the element a element which 782 includes the following child elements: 784 o An OPTIONAL element (as described in Section 3.2); 785 o One or more elements (as described in Section 3.4). 787 The server MUST fail the command if the provided 788 by the client is less than the server fee. 790 When the command has been processed successfully, and the 791 client included the extension in the command service 792 extensions, and a fee was assessed by the server for the transaction, 793 the server MUST include in the section of the EPP 794 response a element, which contains the following child 795 elements: 797 o A element (as described in Section 3.2); 798 o Zero or more elements (as described in Section 3.4); 799 o Zero or more elements (as described in Section 3.4); 800 o An OPTIONAL element (as described in Section 3.5); 801 o An OPTIONAL element (as described in 802 Section 3.6). 804 Example command: 806 C: 807 C: 808 C: 809 C: 810 C: 812 C: example.com 813 C: 2 814 C: 815 C: ns1.example.net 816 C: ns2.example.net 817 C: 818 C: jd1234 819 C: sh8013 820 C: sh8013 821 C: 822 C: 2fooBAR 823 C: 824 C: 825 C: 826 C: 827 C: 828 C: USD 829 C: 5.00 830 C: 831 C: 832 C: ABC-12345 833 C: 834 C: 835 Example response: 837 S: 838 S: 839 S: 840 S: 841 S: Command completed successfully 842 S: 843 S: 844 S: 846 S: example.com 847 S: 1999-04-03T22:00:00.0Z 848 S: 2001-04-03T22:00:00.0Z 849 S: 850 S: 851 S: 852 S: 853 S: USD 854 S: 5.00 858 S: -5.00 859 S: 1000.00 860 S: 861 S: 862 S: 863 S: ABC-12345 864 S: 54321-XYZ 865 S: 866 S: 867 S: 869 5.2.2. EPP Command 871 This extension does not add any elements to the EPP command, 872 but does include elements in the response, when the extension is 873 included in the command service extensions. 875 When the command has been processed successfully, and the 876 client included the extension in the command service 877 extensions, the server MAY include in the section of the 878 EPP response a element, which contains the following 879 child elements: 881 o A element (as described in Section 3.2); 882 o Zero or more elements (as described in Section 3.4); 883 o Zero or more elements (as described in Section 3.4); 884 o An OPTIONAL element (as described in Section 3.5); 885 o An OPTIONAL element (as described in 886 Section 3.6). 888 Example response: 890 S: 891 S: 892 S: 893 S: 894 S: Command completed successfully 895 S: 896 S: 897 S: 899 S: USD 900 S: -5.00 901 S: 1005.00 902 S: 903 S: 904 S: 905 S: ABC-12345 906 S: 54321-XYZ 907 S: 908 S: 909 S: 911 5.2.3. EPP Command 913 This extension adds elements to both the EPP command and 914 response, when the extension is included in the command 915 service extensions. 917 When submitting a command to the server, the client MAY 918 include in the element a element which 919 includes the following child elements: 921 o An OPTIONAL element (as described in Section 3.2); 922 o One or more elements (as described in Section 3.4). 924 When the command has been processed successfully, and the 925 client included the extension in the command service 926 extensions, the server MAY include in the section of the 927 EPP response a element, which contains the following 928 child elements: 930 o A element (as described in Section 3.2); 931 o Zero or more elements (as described in Section 3.4); 932 o Zero or more elements (as described in Section 3.4); 933 o An OPTIONAL element (as described in Section 3.5); 934 o An OPTIONAL element (as described in 935 Section 3.6). 937 Example command: 939 C: 940 C: 941 C: 942 C: 943 C: 945 C: example.com 946 C: 2000-04-03 947 C: 5 948 C: 949 C: 950 C: 951 C: 952 C: USD 953 C: 5.00 954 C: 955 C: 956 C: ABC-12345 957 C: 958 C: 959 Example response: 961 S: 962 S: 963 S: 964 S: 965 S: Command completed successfully 966 S: 967 S: 968 S: 970 S: example.com 971 S: 2005-04-03T22:00:00.0Z 972 S: 973 S: 974 S: 975 S: 976 S: USD 977 S: 5.00 980 S: 1000.00 981 S: 982 S: 983 S: 984 S: ABC-12345 985 S: 54322-XYZ 986 S: 987 S: 988 S: 990 5.2.4. EPP Command 992 This extension adds elements to both the EPP command and 993 response, when the value of the "op" attribute of the 994 command element is "request", and the extension is included in the 995 command service extensions. 997 When submitting a command to the server, the client MAY 998 include in the element a element which 999 includes the following child elements: 1001 o An OPTIONAL element (as described in Section 3.2); 1002 o One or more elements (as described in Section 3.4). 1004 When the command has been processed successfully, and the 1005 client included the extension in the command service 1006 extensions, the server MAY include in the section of the 1007 EPP response a element, which contains the following 1008 child elements: 1010 o A element (as described in Section 3.2); 1011 o Zero or more elements (as described in Section 3.4); 1012 o Zero or more elements (as described in Section 3.4); 1013 o An OPTIONAL element (as described in Section 3.5); 1014 o An OPTIONAL element (as described in 1015 Section 3.6). 1017 Example command: 1019 C: 1020 C: 1021 C: 1022 C: 1023 C: 1025 C: example.com 1026 C: 1 1027 C: 1028 C: 2fooBAR 1029 C: 1030 C: 1031 C: 1032 C: 1033 C: 1034 C: USD 1035 C: 5.00 1036 C: 1037 C: 1038 C: ABC-12345 1039 C: 1040 C: 1041 Example response: 1043 S: 1044 S: 1045 S: 1046 S: 1047 S: Command completed successfully; action pending 1048 S: 1049 S: 1050 S: 1052 S: example.com 1053 S: pending 1054 S: ClientX 1055 S: 2000-06-08T22:00:00.0Z 1056 S: ClientY 1057 S: 2000-06-13T22:00:00.0Z 1058 S: 2002-09-08T22:00:00.0Z 1059 S: 1060 S: 1061 S: 1062 S: 1063 S: USD 1064 S: 5.00 1067 S: 1068 S: 1069 S: 1070 S: ABC-12345 1071 S: 54322-XYZ 1072 S: 1073 S: 1074 S: 1076 5.2.5. EPP Command 1078 This extension adds elements to both the EPP command and 1079 response, when the extension is included in the command 1080 service extensions. 1082 When submitting a command to the server, the client MAY 1083 include in the element a element which 1084 includes the following child elements: 1086 o An OPTIONAL element (as described in Section 3.2); 1087 o One or more elements (as described in Section 3.4). 1089 When the command has been processed successfully, and the 1090 client included the extension in the command service 1091 extensions, the server MAY include in the section of the 1092 EPP response a element, which contains the following 1093 child elements: 1095 o A element (as described in Section 3.2); 1096 o Zero or more elements (as described in Section 3.4); 1097 o Zero or more elements (as described in Section 3.4); 1098 o An OPTIONAL element (as described in Section 3.5); 1099 o An OPTIONAL element (as described in 1100 Section 3.6). 1102 Example command: 1104 C: 1105 C: 1106 C: 1107 C: 1108 C: 1110 C: example.com 1111 C: 1112 C: sh8013 1113 C: 1114 C: 1115 C: 1116 C: 1117 C: 1118 C: USD 1119 C: 5.00 1120 C: 1121 C: 1122 C: ABC-12345 1123 C: 1124 C: 1125 Example response: 1127 S: 1128 S: 1129 S: 1130 S: 1131 S: Command completed successfully 1132 S: 1133 S: 1134 S: 1135 S: USD 1136 S: 5.00 1137 S: 1138 S: 1139 S: 1140 S: ABC-12345 1141 S: 54321-XYZ 1142 S: 1143 S: 1144 S: 1146 6. Formal Syntax 1148 One schema is presented here that is the EPP Fee Extension schema. 1150 The formal syntax presented here is a complete schema representation 1151 of the object mapping suitable for automated validation of EPP XML 1152 instances. The BEGIN and END tags are not part of the schema; they 1153 are used to note the beginning and ending of the schema for URI 1154 registration purposes. 1156 6.1. Fee Extension Schema 1158 Copyright (c) 2018 IETF Trust and the persons identified as authors 1159 of the code. All rights reserved. 1161 Redistribution and use in source and binary forms, with or without 1162 modification, are permitted provided that the following conditions 1163 are met: 1165 o Redistributions of source code must retain the above copyright 1166 notice, this list of conditions and the following disclaimer. 1167 o Redistributions in binary form must reproduce the above copyright 1168 notice, this list of conditions and the following disclaimer in 1169 the documentation and/or other materials provided with the 1170 distribution. 1171 o Neither the name of Internet Society, IETF or IETF Trust, nor the 1172 names of specific contributors, may be used to endorse or promote 1173 products derived from this software without specific prior written 1174 permission. 1176 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1177 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1178 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1179 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1180 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 1181 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 1182 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1183 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 1184 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 1185 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 1186 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 1188 BEGIN 1189 1190 1197 1198 1200 1201 1202 Extensible Provisioning Protocol v1.0 Fee Extension 1203 1204 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1219 1220 1221 1222 1224 1226 1227 1229 1230 1231 1232 1234 1235 1236 1238 1239 1240 1241 1242 1244 1245 1247 1248 1249 1250 1251 1253 1254 1255 1256 1258 1259 1260 1261 1263 1265 1267 1268 1269 1270 1271 1272 1274 1276 1278 1280 1282 1284 1285 1287 1288 1289 1290 1291 1292 1294 1295 1296 1298 1299 1300 1301 1302 1303 1305 1306 1307 1308 1309 1311 1313 1315 1316 1317 1318 1319 1321 1322 1323 1324 1325 1326 1327 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1341 1342 1343 1344 1345 1347 1348 1349 1350 1351 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1366 1367 1368 1369 1370 1372 1373 1374 1375 1376 1377 1378 1380 1381 1382 1384 1385 1386 1388 1389 END 1391 7. Security Considerations 1393 The mapping extensions described in this document do not provide any 1394 security services beyond those described by EPP [RFC5730], the EPP 1395 domain name mapping [RFC5731], and protocol layers used by EPP. The 1396 security considerations described in these other specifications apply 1397 to this specification as well. 1399 8. IANA Considerations 1401 8.1. XML Namespace 1403 This document uses URNs to describe XML namespaces and XML schemas 1404 conforming to a registry mechanism described in [RFC3688]. 1406 Registration request for the fee namespace: 1408 URI: urn:ietf:params:xml:ns:epp:fee-1.0 1410 Registrant Contact: IESG 1412 XML: None. Namespace URIs do not represent an XML specification. 1414 Registration request for the fee schema: 1416 URI: urn:ietf:params:xml:schema:epp:fee-1.0 1418 Registrant Contact: IESG 1420 XML: See the "Formal Syntax" section of this document. 1422 8.2. EPP Extension Registry 1424 The EPP extension described in this document should be registered by 1425 the IANA in the EPP Extension Registry described in [RFC7451]. The 1426 details of the registration are as follows: 1428 Name of Extension: Registry Fee Extension for the Extensible 1429 Provisioning Protocol (EPP) 1431 Document status: Standards Track 1433 Reference: (insert reference to RFC version of this document) 1435 Registrant Name and Email Address: IESG, 1437 TLDs: Any 1439 IPR Disclosure: None 1441 Status: Active 1443 Notes: None 1445 9. Implementation Status 1447 Note to RFC Editor: Please remove this section and the reference to 1448 [RFC7942] before publication. 1450 This section records the status of known implementations of the 1451 protocol defined by this specification at the time of posting of this 1452 Internet-Draft, and is based on a proposal described in [RFC7942]. 1453 The description of implementations in this section is intended to 1454 assist the IETF in its decision processes in progressing drafts to 1455 RFCs. Please note that the listing of any individual implementation 1456 here does not imply endorsement by the IETF. Furthermore, no effort 1457 has been spent to verify the information presented here that was 1458 supplied by IETF contributors. This is not intended as, and must not 1459 be construed to be, a catalog of available implementations or their 1460 features. Readers are advised to note that other implementations may 1461 exist. 1463 According to [RFC7942], "this will allow reviewers and working groups 1464 to assign due consideration to documents that have the benefit of 1465 running code, which may serve as evidence of valuable experimentation 1466 and feedback that have made the implemented protocols more mature. 1467 It is up to the individual working groups to use this information as 1468 they see fit". 1470 9.1. RegistryEngine EPP Service 1472 Organization: CentralNic 1474 Name: RegistryEngine EPP Service 1476 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1477 SLDs 1479 Level of maturity: Deployed in CentralNic's production environment as 1480 well as two other gTLD registry systems, and two ccTLD registry 1481 systems. 1483 Coverage: All aspects of the protocol are implemented. 1485 Licensing: Proprietary In-House software 1487 Contact: epp@centralnic.com 1489 URL: https://www.centralnic.com 1491 10. Acknowledgements 1493 The authors wish to thank the following persons for their feedback 1494 and suggestions: 1496 o James Gould of Verisign Inc 1497 o Luis Munoz of ISC 1498 o Michael Young of Architelos 1499 o Ben Levac and Jeff Eckhaus of Demand Media 1500 o Seth Goldman of Google 1501 o Klaus Malorny and Michael Bauland of Knipp 1502 o Jody Kolker, Joe Snitker and Kevin Allendorf of Go Daddy 1503 o Michael Holloway of Com Laude 1504 o Santosh Kalsangrah of Impetus Infotech 1505 o Alex Mayrhofer of Nic.at 1506 o Thomas Corte of Knipp Medien und Kommunikation GmbH 1508 11. Change History 1510 11.1. Change from 12 to 13 1512 Updated XML namespace and schema registration to be "epp" scoped - 1513 global replace of XML namespace from urn:ietf:params:xml:ns:fee-1.0 1514 to urn:ietf:params:xml:ns:epp:fee-1.0 and the XML schema registration 1515 from urn:ietf:params:xml:schema:fee-1.0 to 1516 urn:ietf:params:xml:schema:epp:fee-1.0. 1518 11.2. Change from 11 to 12 1520 Updated references to current version of documents and moved the 1521 "standard" attribute from the check command (commandType) to the 1522 check response (commandDataType). 1524 11.3. Change from 10 to 11 1526 Updated document per Working Group Last Call comments. Made minor 1527 textual changes throughout for enhanced clarity per WGLC comments. 1529 11.4. Change from 09 to 10 1531 Updated document per Working Group Last Call comments. Updated 1532 schema to version 1.0 in anticipation of standardization, no changes 1533 were made to the latest, 0.25, schema. Made minor textual changes 1534 throughout for enhanced clarity per WGLC comments. 1536 11.5. Change from 08 to 09 1538 Updated scheme to version 0.25 to allow tighter checking on 1539 by splitting the client and server definitions, moved 1540 the class element from the command to the object level and added an 1541 optional standard attribute to the command element. Also updated 1542 section 3.1 for clarity on name attribute; updated section 3.9 for 1543 clarity on uses of ; removed second paragraph in section 1544 5.2.1 as it was duplicative of second to last paragraph in 4.0; and 1545 updated section 5.1.1 to add section references. 1547 11.6. Change from 07 to 08 1549 Updated section 3.8 and 5.1.1 to provide clarity on server processing 1550 and response of various scenarios (i.e. "quiet" period processing). 1552 11.7. Change from 06 to 07 1554 Updated section 3.8 and 4.0 to provide clarity on server processing 1555 and response of various scenarios. 1557 11.8. Change from 05 to 06 1559 Updated scheme to version 0.23 to allow the return of no 1560 element(s) if an error situation occurs. Edited 1561 section 3.8 extensively after input from interim meeting and REGEXT 1562 F2F meeting at IETF-99. Added normative reference for draft-ietf- 1563 eppext-launchphase. 1565 11.9. Change from 04 to 05 1567 Updated scheme to version 0.21 to support the lang attribute for the 1568 reason element of the objectCDType and the commandType types as well 1569 as to add the update command to the commandEnum type. Updated 1570 section 3.1 to include language for the custom command. Added 1571 section 3.9 to provide a description of the element. 1572 Fixed typos and added clarification text on when client fee is less 1573 than server fee in section 4. Additionally, I added description 1574 pointers to appropriate Section 3 definitions for element clarity 1575 throughout the document. 1577 11.10. Change from 03 to 04 1579 Updated scheme to version 0.19 to correct typos and to replace the 1580 commandTypeValue type with the commandEnum type and customName 1581 attribute for stricter validation. Updated various text for grammar 1582 and clarity. Added text to section 4 clarifying the response 1583 when the client provided no fee extension but the server was 1584 expecting the extension. 1586 11.11. Change from 02 to 03 1588 Updated scheme to version 0.17 to simplify the check command syntax. 1589 Moved fee avail to objectCDType to allow fast failing on error 1590 situations. Removed the objectCheckType as it was no longer being 1591 used. Updated examples to reflect these scheme changes. Added 1592 language for server failing a if the passed by the 1593 client is less than the server fee. 1595 11.12. Change from 01 to 02 1597 Updated scheme to version 0.15 to fix errors in CommandType, 1598 objectCDType, transformCommandType and transformResultType 1599 definitions. 1601 11.13. Change from 00 to 01 1603 Added Roger Carney as author to finish draft. Moved Formal Syntax 1604 section to main level numbering. Various grammar, typos, and 1605 administrative edits for clarity. Removed default value for the 1606 "applied" attribute of so that it can truly be optional. 1607 Added support for the command to return a element 1608 as well. Modified default response on the command for the 1609 optional when it was not provided in the command, 1610 leaving it to the server to provide the default period value. 1611 Extensive edits were done to the command, the 1612 response and to the fee extension schema (checkType, objectCheckType, 1613 objectIdentifierType, objectCDType, commandType) to support 1614 requesting and returning multiple transformation fees in a single 1615 call. Added section on Phase/Subphase to provide more context on the 1616 uses. 1618 11.14. Change from draft-brown-00 to draft-ietf-regext-fees-00 1620 Updated to be REGEXT WG document. 1622 12. Normative References 1624 [ISO4217] International Organization for Standardization, "Codes for 1625 the representation of currencies", August 2015, 1626 . 1628 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1629 Requirement Levels", BCP 14, RFC 2119, 1630 DOI 10.17487/RFC2119, March 1997, 1631 . 1633 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1634 DOI 10.17487/RFC3688, January 2004, 1635 . 1637 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1638 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1639 DOI 10.17487/RFC3915, September 2004, 1640 . 1642 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1643 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1644 . 1646 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1647 Domain Name Mapping", STD 69, RFC 5731, 1648 DOI 10.17487/RFC5731, August 2009, 1649 . 1651 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1652 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1653 February 2015, . 1655 [RFC7942] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1656 Code: The Implementation Status Section", BCP 205, 1657 RFC 7942, DOI 10.17487/RFC7942, July 2016, 1658 . 1660 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 1661 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 1662 May 2017, . 1664 [RFC8334] Gould, J., Tan, W., and G. Brown, "Launch Phase Mapping 1665 for the Extensible Provisioning Protocol (EPP)", RFC 8334, 1666 DOI 10.17487/RFC8334, March 2018, 1667 . 1669 Authors' Addresses 1671 Roger Carney 1672 GoDaddy Inc. 1673 14455 N. Hayden Rd. #219 1674 Scottsdale, AZ 85260 1675 US 1677 Email: rcarney@godaddy.com 1678 URI: http://www.godaddy.com 1680 Gavin Brown 1681 CentralNic Group plc 1682 35-39 Moorgate 1683 London, England EC2R 6AR 1684 GB 1686 Phone: +44 20 33 88 0600 1687 Email: gavin.brown@centralnic.com 1688 URI: http://www.centralnic.com 1689 Jothan Frakes 1691 Email: jothan@jothan.com 1692 URI: http://jothan.com