idnits 2.17.1 draft-ietf-regext-epp-fees-03.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 : ---------------------------------------------------------------------------- ** There is 1 instance of too long lines in the document, the longest one being 11 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (April 24, 2017) is 2558 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 200, but not defined ** Obsolete normative reference: RFC 6982 (Obsoleted by RFC 7942) ** Downref: Normative reference to an Informational RFC: RFC 7451 Summary: 3 errors (**), 0 flaws (~~), 2 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Registration Protocols Extensions R. Carney 3 Internet-Draft GoDaddy Inc. 4 Intended status: Standards Track G. Brown 5 Expires: October 26, 2017 CentralNic Group plc 6 J. Frakes 7 April 24, 2017 9 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 10 draft-ietf-regext-epp-fees-03 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 http://datatracker.ietf.org/drafts/current/. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 This Internet-Draft will expire on October 26, 2017. 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 (http://trustee.ietf.org/license-info) in effect on the date of 42 publication of this document. Please review these documents 43 carefully, as they describe your rights and restrictions with respect 44 to this document. Code Components extracted from this document must 45 include Simplified BSD License text as described in Section 4.e of 46 the Trust Legal Provisions and are provided without warranty as 47 described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 52 1.1. Conventions Used in This Document . . . . . . . . . . . . 3 53 2. Migrating to Newer Versions of This Extension . . . . . . . . 4 54 3. Extension Elements . . . . . . . . . . . . . . . . . . . . . 4 55 3.1. Client Commands . . . . . . . . . . . . . . . . . . . . . 4 56 3.2. Currency Codes . . . . . . . . . . . . . . . . . . . . . 5 57 3.3. Validity Periods . . . . . . . . . . . . . . . . . . . . 5 58 3.4. Fees and Credits . . . . . . . . . . . . . . . . . . . . 5 59 3.4.1. Refunds . . . . . . . . . . . . . . . . . . . . . . . 6 60 3.4.2. Grace Periods . . . . . . . . . . . . . . . . . . . . 6 61 3.4.3. Correlation between Refundability and Grace Periods . 7 62 3.4.4. Applicability . . . . . . . . . . . . . . . . . . . . 7 63 3.5. Account Balance . . . . . . . . . . . . . . . . . . . . . 7 64 3.6. Credit Limit . . . . . . . . . . . . . . . . . . . . . . 7 65 3.7. Classification of Objects . . . . . . . . . . . . . . . . 8 66 3.8. Phase and Subphase Attributes . . . . . . . . . . . . . . 8 67 4. Server Handling of Fee Information . . . . . . . . . . . . . 9 68 5. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 9 69 5.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 9 70 5.1.1. EPP Command . . . . . . . . . . . . . . . . . 9 71 5.1.1.1. Server Handling of Elements . . . . . . . . . . . 13 72 5.1.2. EPP Transfer Query Command . . . . . . . . . . . . . 14 73 5.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 15 74 5.2.1. EPP Command . . . . . . . . . . . . . . . . 15 75 5.2.2. EPP Command . . . . . . . . . . . . . . . . 18 76 5.2.3. EPP Command . . . . . . . . . . . . . . . . . 19 77 5.2.4. EPP Command . . . . . . . . . . . . . . . 21 78 5.2.5. EPP Command . . . . . . . . . . . . . . . . 23 79 6. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 25 80 6.1. Fee Extension Schema . . . . . . . . . . . . . . . . . . 25 81 7. Security Considerations . . . . . . . . . . . . . . . . . . . 29 82 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 29 83 8.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 29 84 8.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 29 85 9. Implemntation Status . . . . . . . . . . . . . . . . . . . . 30 86 9.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . 30 87 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 31 88 11. Change History . . . . . . . . . . . . . . . . . . . . . . . 31 89 11.1. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 31 90 11.2. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 31 91 11.3. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 32 92 11.4. Change from draft-brown-00 to draft-ietf-regext-fees-00 32 93 12. Normative References . . . . . . . . . . . . . . . . . . . . 32 94 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 33 96 1. Introduction 98 Historically, domain name registries have applied a simple fee 99 structure for billable transactions, namely a basic unit price 100 applied to domain , , and RGP [RFC3915] 101 restore commands. Given the relatively small number of EPP servers 102 to which EPP clients have been required to connect, it has generally 103 been the case that client operators have been able to obtain details 104 of these fees out-of-band by contacting the server operators. 106 Given the recent expansion of the DNS namespace, and the 107 proliferation of novel business models, it is now desirable to 108 provide a method for EPP clients to query EPP servers for the fees 109 and credits associated with certain commands and specific objects. 111 This document describes an extension mapping for version 1.0 of the 112 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 113 provides a mechanism by which EPP clients may query the fees and 114 credits associated with various billable transactions, and also 115 obtain their current account balance. 117 1.1. Conventions Used in This Document 119 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 120 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 121 document are to be interpreted as described in RFC 2119 [RFC2119]. 123 XML is case sensitive. Unless stated otherwise, XML specifications 124 and examples provided in this document MUST be interpreted in the 125 character case presented in order to develop a conforming 126 implementation. 128 "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:fee- 129 0.17". The XML namespace prefix "fee" is used, but implementations 130 MUST NOT depend on it and instead employ a proper namespace-aware XML 131 parser and serializer to interpret and output the XML documents. 133 In examples, "C:" represents lines sent by a protocol client and "S:" 134 represents lines returned by a protocol server. Indentation and 135 white space in examples are provided only to illustrate element 136 relationships and are not a REQUIRED feature of this protocol. 138 (Note to RFC Editor: remove the following paragraph before 139 publication as an RFC.) 141 The XML namespace prefix above contains a version number, 142 specifically "0.17". This version number will increment with 143 successive versions of this document, and will reach 1.0 if and when 144 this document is published as an RFC. This permits clients to 145 distinguish which version of the extension a server has implemented. 147 2. Migrating to Newer Versions of This Extension 149 (Note to RFC Editor: remove this section before publication as an 150 RFC.) 152 Servers which implement this extension SHOULD provide a way for 153 clients to progressively update their implementations when a new 154 version of the extension is deployed. 156 Servers SHOULD (for a temporary migration period) provide support for 157 older versions of the extension in parallel to the newest version, 158 and allow clients to select their preferred version via the 159 element of the command. 161 If a client requests multiple versions of the extension at login, 162 then, when preparing responses to commands which do not include 163 extension elements, the server SHOULD only include extension elements 164 in the namespace of the newest version of the extension requested by 165 the client. 167 When preparing responses to commands which do include extension 168 elements, the server SHOULD only include extension elements for the 169 extension versions present in the command. 171 3. Extension Elements 173 3.1. Client Commands 175 The element is used in the EPP command to 176 determine the fee which is applicable to the given command. 178 The list of values include: 180 o "create" indicating a command as defined in [RFC5730]; 181 o "delete" indicating a command as defined in [RFC5730]; 182 o "renew" indicating a command as defined in [RFC5730]; 183 o "update" indicating a command as defined in [RFC5730]; 184 o "transfer" indicating a command as defined in 185 [RFC5730]; 186 o If the server supports the Registry Grace Period Mapping 187 [RFC3915], then the server MUST also support the "restore" value 188 as defined in [RFC3915]. 190 The element MAY have an OPTIONAL "phase" attribute 191 specifying a launch phase as described in [draft-ietf-eppext- 192 launchphase]. It may also contain an OPTIONAL "subphase" attribute 193 identifying the custom or sub-phase as described in [draft-ietf- 194 eppext-launchphase]. 196 3.2. Currency Codes 198 The element is used to indicate which currency fees 199 are charged in. This value of this element MUST be a three-character 200 currency code from [ISO4217]. 202 Note that ISO 4217 provides the special "XXX" code, which MAY be used 203 if the server uses a non-currency based system for assessing fees, 204 such as a system of credits. 206 The use of elements in commands is OPTIONAL: if a 207 element is not present in a command, the server MUST 208 determine the currency based on the client's account settings which 209 MUST be agreed by the client and server via an out-of-band channel. 210 However, the element MUST be present in responses. 212 Servers SHOULD NOT perform a currency conversion if a client uses an 213 incorrect currency code. Servers SHOULD return a 2004 "Parameter 214 value range" error instead. 216 3.3. Validity Periods 218 When querying for fee information using the command, the 219 element is used to indicate the units to be added to the 220 registration period of objects by the , and 221 commands. This element is derived from the 222 element described in [RFC5731]. 224 The element is OPTIONAL in commands: if omitted, 225 the server MUST determine the fee(s) using a validity period of 1 226 year. The element MUST be present in responses. 228 3.4. Fees and Credits 230 Servers which implement this extension will include elements in 231 responses which provide information about the fees and/or credits 232 associated with a given billable transaction. 234 The and elements are used to provide this 235 information. The presence of a element in a response 236 indicates a debit against the client's account balance; a 237 element indicates a credit. A element MUST 238 have a non-negative value. A element MUST have a 239 negative value. 241 A server MAY respond with multiple and 242 elements in the same response. In such cases, the net fee or credit 243 applicable to the transaction is the arithmetic sum of the values of 244 each of the and/or elements. This amount 245 applies to the total additional validity period applied to the object 246 (where applicable) rather than to any incremental unit. 248 The following attributes are defined for the element. 249 These are described in detail below: 251 description: an OPTIONAL attribute which provides a human-readable 252 description of the fee. Servers should provide documentation on the 253 possible values of this attribute, and their meanings. 255 refundable: an OPTIONAL boolean attribute indicating whether the fee 256 is refundable if the object is deleted. 258 grace-period: an OPTIONAL attribute which provides the time period 259 during which the fee is refundable. 261 applied: an OPTIONAL attribute indicating when the fee will be 262 deducted from the client's account. 264 The element can take a "description" attribute as 265 described above. No other attributes are defined for this element. 267 3.4.1. Refunds 269 elements MAY have an OPTIONAL "refundable" attribute which 270 takes a boolean value. Fees may be refunded under certain 271 circumstances, such as when a domain application is rejected (as 272 described in [draft-ietf-eppext-launchphase]) or when an object is 273 deleted during the relevant Grace Period (see below). 275 If the "refundable" attribute is omitted, then clients SHOULD NOT 276 make any assumption about the refundability of the fee. 278 3.4.2. Grace Periods 280 [RFC3915] describes a system of "grace periods", which are time 281 periods following a billable transaction during which, if an object 282 is deleted, the client receives a refund. 284 The "grace-period" attribute MAY be used to indicate the relevant 285 grace period for a fee. If a server implements the Registry Grace 286 Period extension, it MUST specify the grace period for all relevant 287 transactions. 289 If the "grace-period" attribute is omitted, then clients SHOULD NOT 290 make any assumption about the grace period of the fee. 292 3.4.3. Correlation between Refundability and Grace Periods 294 If a element has a "grace-period" attribute then it MUST 295 also be refundable. If the "refundable" attribute of a 296 element is false then it MUST NOT have a "grace-period" attribute. 298 3.4.4. Applicability 300 Fees may be applied immediately upon receipt of a command from a 301 client, or may only be applied once an out-of-band process (such as 302 the processing of applications at the end of a launch phase) has 303 taken place. 305 The "applied" attribute of the element allows servers to 306 indicate whether a fee will be applied immediately, or whether it 307 will be applied at some point in the future. This attribute takes 308 two possible values: "immediate" or "delayed". 310 3.5. Account Balance 312 The element is an OPTIONAL element which MAY be 313 included in server responses to transform commands. If present, it 314 can be used by the client to determine the remaining credit at the 315 server. 317 Whether or not the is included in responses is a matter 318 of server policy. However, if a server chooses to offer support for 319 this element, it MUST be included in responses to all "transform" or 320 billable commands (ie , , , , 321 ). 323 The value of the MAY be negative. A negative balance 324 indicates that the server has extended a line of credit to the client 325 (see below). 327 If a server includes a element in response to transform 328 commands, the value of the element MUST reflect the client's account 329 balance after any fees or credits associated with that command have 330 been applied. 332 3.6. Credit Limit 334 As described above, if a server returns a response containing a 335 with a negative value, then the server has extended a 336 line of credit to the client. A server MAY also include a 337 element in responses which indicates the maximum 338 credit available to a client. A server MAY reject certain 339 transactions if the absolute value of the is equal to 340 or exceeds the value of the element. 342 Whether or not the is included in responses is a 343 matter of server policy. However, if a server chooses to offer 344 support for this element, it MUST be included in responses to all 345 "transform" commands (ie , , , , 346 ). 348 3.7. Classification of Objects 350 Objects may be assigned to a particular class, category, or tier, 351 each of which has a particular fee or set of fees associated with it. 352 The element which appears in responses is used to 353 indicate the classification of an object. 355 If a server makes use of this element, it should provide clients with 356 a list of all the values that the element may take via an out-of-band 357 channel. Servers MUST NOT use values which do not appear on this 358 list. 360 Servers which make use of this element MUST use a element 361 with the value "standard" for all objects that are subject to the 362 standard or default fee. 364 3.8. Phase and Subphase Attributes 366 The element has two attributes, phase and subphase, 367 that provide additional information related to a specific launch 368 phase as described in [draft-ietf-eppext-launchphase]. 370 If the client contains no phase attribute the server 371 SHOULD return data (including the phase/subphase attribute(s)) for 372 all valid server combinations of currently active phase(s) and active 373 subphase(s). 375 If the client contains a server supported combination 376 of phase/subphase the server MUST return fee data (including the 377 phase/subphase attribute(s)) for the specific combination(s). 379 If the client contains a phase attribute with no 380 subphase, the server SHOULD return data (including the phase/subphase 381 attribute(s)) for all valid server combinations of provided phase and 382 available subphase(s). 384 If the client contains a subphase with no phase 385 attribute the server MUST respond with a 2003 "Required parameter 386 missing" error. 388 If the client contains a phase attribute not defined in 389 [draft-ietf-eppext-launchphase] or not supported by server the server 390 MUST respond with a 2004 "Parameter value range" error. 392 If the client contains a subphase attribute (or phase/ 393 subphase combination) not supported by server the server MUST respond 394 with a 2004 "Parameter value range" error. 396 4. Server Handling of Fee Information 398 Depending on server policy, a client MAY be required to include the 399 extension elements described in this document for certain transform 400 commands. Servers must provide clear documentation to clients about 401 the circumstances in which this extension must be used. 403 If a server receives a command from a client which does not include 404 the extension elements required by the server for that command, then 405 it MUST respond with a 2003 "Required parameter missing" error. 407 If the currency or total fee provided by the client do not agree with 408 the server's own calculation of the fee for that command, then the 409 server MUST reject the command with a 2004 "Parameter value range" 410 error. 412 5. EPP Command Mapping 414 A detailed description of the EPP syntax and semantics can be found 415 in [RFC5730]. 417 5.1. EPP Query Commands 419 This extension does not add any elements to the EPP or 420 commands or responses. 422 5.1.1. EPP Command 424 This extension defines additional elements for the EPP 425 command. 427 The command MAY contain an element which MAY contain a 428 element. The element MAY contain one 429 element and MUST contain one or more 430 elements. 432 The element(s) contain(s) a "name" attribute, an 433 OPTIONAL "phase" attribute, and an OPTIONAL "subphase" attribute. 434 The element(s) MAY have the following child elements: 436 o An OPTIONAL element. 437 o An OPTIONAL element. 439 Example command: 441 C: 442 C: 443 C: 444 C: 445 C: 447 C: example.com 448 C: example.net 449 C: example.xyz 450 C: 451 C: 452 C: 453 C: 454 C: USD 455 C: 456 C: 2 457 C: 458 C: 459 C: 460 C: 461 C: 462 C: 463 C: ABC-12345 464 C: 465 C: 467 When the server receives a command that includes the 468 extension elements described above, its response MUST contain an 469 element, which MUST contain a child 470 element. The element MUST contain a 471 element and a for each element referenced in 472 the element of the client command. 474 Each element MUST contain the following child elements: 476 o A element, which MUST match a from the 477 client command. 478 o A element matching each that appeared 479 in the corresponding of the client command. This 480 element MAY have the OPTIONAL "phase" and "subphase" attributes, 481 which MUST match the same attributes in the corresponding 482 element of the client command. 484 The element also has an OPTIONAL "avail" attribute which is 485 a boolean. If the value of this attribute evaluates to false, this 486 indicates that the server cannot calculate the relevant fees, because 487 the object, command, currency, period, class or some combination is 488 invalid per server policy. If "avail" is false then the 489 element MAY contain a element and the server MAY 490 eliminate some or all of the element(s). 492 The element(s) MAY have the following child elements: 494 o An OPTIONAL element, which contains the same unit 495 that appeared in the element of the command. If the 496 value of the preceding element is "restore", this 497 element MUST NOT be included, otherwise it MUST be included. If 498 no appeared in command (and the command is not 499 "restore") then the server MUST return its default period value. 500 o Zero or more elements. 501 o Zero or more elements. 502 o An OPTIONAL element. 503 o An OPTIONAL element. 505 If the "avail" attribute of the elelment is true and if no 506 elements are present in a element, this 507 indicates that no fee will be assessed by the server for this 508 command. 510 If the "avail" attribute of the element is false, then the 511 element MUST NOT contain any or 512 child elements. If the "avail" attribute is true, then the 513 element MUST NOT contain a element. 515 Example response: 517 S: 518 S: 519 S: 520 S: 521 S: Command completed successfully 522 S: 523 S: 524 S: 526 S: 527 S: example.com 528 S: 529 S: 530 S: example.net 531 S: 532 S: 533 S: example.xyz 534 S: 535 S: 536 S: 537 S: 538 S: 541 S: USD 542 S: 543 S: example.com 544 S: 545 S: 2 546 S: 10.00 550 S: 551 S: 552 S: 1 553 S: 5.00 557 S: 558 S: 559 S: 1 560 S: 5.00 564 S: 565 S: 566 S: 5.00 568 S: 569 S: 570 S: 571 S: example.net 572 S: 573 S: 2 574 S: 10.00 578 S: 579 S: 580 S: 1 581 S: 5.00 585 S: 586 S: 587 S: 1 588 S: 5.00 592 S: 593 S: 594 S: 5.00 596 S: 597 S: 598 S: 599 S: example.xyz 600 S: 601 S: 2 602 S: Only 1 year registration periods are vaild. 603 S: 604 S: 605 S: 606 S: 607 S: 608 S: ABC-12345 609 S: 54322-XYZ 610 S: 611 S: 612 S: 614 5.1.1.1. Server Handling of Elements 616 Clients MAY include a in the element. 617 There are three ways in which servers may handle this element: 619 1. If the server supports the concept of tiers or classes of 620 objects, then the value of this element MUST be validated. If 621 incorrect for the specified object, the "avail" attribute of the 622 corresponding element MUST be false. 624 2. If the server supports different "types" of object registrations 625 (such as a "blocking" registration which does not resolve, or 626 where a registry provides a value-added service that requires an 627 opt-out to disable), then, as with the first model, the server 628 MUST validate the value of the element. If the value is 629 incorrect, the "avail" attribute of the corresponding 630 element MUST be false, and a element 631 MUST be provided. 632 3. If the server supports neither of the above models, the element 633 MUST be ignored. 635 Server operators must provide clear documentation to client operators 636 which of the above models it supports. 638 5.1.2. EPP Transfer Query Command 640 This extension does not add any elements to the EPP query 641 command, but does include elements in the response, when the 642 extension has been selected during a command. 644 When the query command has been processed successfully, 645 the client selected the extension when it logged in, and the client 646 is authorised by the server to view information about the transfer, 647 the server MAY include in the section of the EPP response 648 a element, which contains the following child elements: 650 o A element. 651 o A element. 652 o Zero or more elements containing the fees that will be 653 charged to the gaining client. 654 o Zero or more elements containing the credits that 655 will be refunded to the losing client. 657 Servers SHOULD omit when returning a response to the 658 gaining client, and omit elements when returning a response 659 to the losing client. 661 If no element is included in the response, then no fee 662 will be assessed by the server for the transfer. 664 Example query response: 666 S: 667 S: 668 S: 669 S: 670 S: Command completed successfully; action pending 671 S: 672 S: 673 S: 675 S: example.com 676 S: pending 677 S: ClientX 678 S: 2000-06-08T22:00:00.0Z 679 S: ClientY 680 S: 2000-06-13T22:00:00.0Z 681 S: 2002-09-08T22:00:00.0Z 682 S: 683 S: 684 S: 685 S: 686 S: USD 687 S: 1 688 S: 5.00 689 S: 690 S: 691 S: 692 S: ABC-12345 693 S: 54322-XYZ 694 S: 695 S: 696 S: 698 5.2. EPP Transform Commands 700 5.2.1. EPP Command 702 This extension adds elements to both the EPP command and 703 response, when the extension has been selected during a 704 command. 706 If a command is received with no extension and 707 the server requires a extension for the 708 the server MUST respond with a 2003 "Required parameter missing" 709 error. 711 When submitting a command to the server, the client MAY 712 include in the element a element which 713 includes the following child elements: 715 o An OPTIONAL element; 716 o One or more elements. 718 The server MUST fail the command if the provided 719 by the client is less than the server fee. 721 When the command has been processed successfully, and the 722 client selected the extension when it logged in, and a fee was 723 assessed by the server for the transaction, the server MUST include 724 in the section of the EPP response a 725 element, which contains the following child elements: 727 o A element; 728 o Zero or more elements; 729 o Zero or more elements; 730 o An OPTIONAL element; 731 o An OPTIONAL element. 733 Example command: 735 C: 736 C: 737 C: 738 C: 739 C: 741 C: example.com 742 C: 2 743 C: 744 C: ns1.example.net 745 C: ns2.example.net 746 C: 747 C: jd1234 748 C: sh8013 749 C: sh8013 750 C: 751 C: 2fooBAR 752 C: 753 C: 754 C: 755 C: 756 C: 757 C: USD 758 C: 5.00 759 C: 760 C: 761 C: ABC-12345 762 C: 763 C: 764 Example response: 766 S: 767 S: 768 S: 769 S: 770 S: Command completed successfully 771 S: 772 S: 773 S: 775 S: example.com 776 S: 1999-04-03T22:00:00.0Z 777 S: 2001-04-03T22:00:00.0Z 778 S: 779 S: 780 S: 781 S: 782 S: USD 783 S: 5.00 787 S: -5.00 788 S: 1000.00 789 S: 790 S: 791 S: 792 S: ABC-12345 793 S: 54321-XYZ 794 S: 795 S: 796 S: 798 5.2.2. EPP Command 800 This extension does not add any elements to the EPP command, 801 but does include elements in the response, when the extension has 802 been selected during the command. 804 When the command has been processed successfully, and the 805 client selected the extension when it logged in, the server MAY 806 include in the section of the EPP response a 807 element, which contains the following child elements: 809 o A element; 810 o Zero or more elements; 811 o Zero or more elements; 812 o An OPTIONAL element; 813 o An OPTIONAL element. 815 Example response: 817 S: 818 S: 819 S: 820 S: 821 S: Command completed successfully 822 S: 823 S: 824 S: 826 S: USD 827 S: -5.00 828 S: 1005.00 829 S: 830 S: 831 S: 832 S: ABC-12345 833 S: 54321-XYZ 834 S: 835 S: 836 S: 838 5.2.3. EPP Command 840 This extension adds elements to both the EPP command and 841 response, when the extension has been selected during a 842 command. 844 When submitting a command to the server, the client MAY 845 include in the element a element which 846 includes the following child elements: 848 o An OPTIONAL element; 849 o One or more elements. 851 When the command has been processed successfully, and the 852 client selected the extension when it logged in, the server MAY 853 include in the section of the EPP response a 854 element, which contains the following child elements: 856 o A element; 857 o Zero or more elements; 858 o Zero or more elements; 859 o An OPTIONAL element; 860 o An OPTIONAL element. 862 Example command: 864 C: 865 C: 866 C: 867 C: 868 C: 870 C: example.com 871 C: 2000-04-03 872 C: 5 873 C: 874 C: 875 C: 876 C: 877 C: USD 878 C: 5.00 879 C: 880 C: 881 C: ABC-12345 882 C: 883 C: 884 Example response: 886 S: 887 S: 888 S: 889 S: 890 S: Command completed successfully 891 S: 892 S: 893 S: 895 S: example.com 896 S: 2005-04-03T22:00:00.0Z 897 S: 898 S: 899 S: 900 S: 901 S: USD 902 S: 5.00 905 S: 1000.00 906 S: 907 S: 908 S: 909 S: ABC-12345 910 S: 54322-XYZ 911 S: 912 S: 913 S: 915 5.2.4. EPP Command 917 This extension adds elements to both the EPP command and 918 response, when the value of the "op" attribute of the 919 command element is "request", and the extension has been selected 920 during the command. 922 When submitting a command to the server, the client MAY 923 include in the element a element which 924 includes the following child elements: 926 o An OPTIONAL element; 927 o One or more elements. 929 When the command has been processed successfully, and the 930 client selected the extension when it logged in, the server MAY 931 include in the section of the EPP response a 932 element, which contains the following child elements: 934 o A element; 935 o Zero or more elements; 936 o Zero or more elements; 937 o An OPTIONAL element; 938 o An OPTIONAL element. 940 Example command: 942 C: 943 C: 944 C: 945 C: 946 C: 948 C: example.com 949 C: 1 950 C: 951 C: 2fooBAR 952 C: 953 C: 954 C: 955 C: 956 C: 957 C: USD 958 C: 5.00 959 C: 960 C: 961 C: ABC-12345 962 C: 963 C: 964 Example response: 966 S: 967 S: 968 S: 969 S: 970 S: Command completed successfully; action pending 971 S: 972 S: 973 S: 975 S: example.com 976 S: pending 977 S: ClientX 978 S: 2000-06-08T22:00:00.0Z 979 S: ClientY 980 S: 2000-06-13T22:00:00.0Z 981 S: 2002-09-08T22:00:00.0Z 982 S: 983 S: 984 S: 985 S: 986 S: USD 987 S: 5.00 990 S: 991 S: 992 S: 993 S: ABC-12345 994 S: 54322-XYZ 995 S: 996 S: 997 S: 999 5.2.5. EPP Command 1001 This extension adds elements to both the EPP command and 1002 response, when the extension has been selected during the 1003 command. 1005 When submitting a command to the server, the client MAY 1006 include in the element a element which 1007 includes the following child elements: 1009 o An OPTIONAL element; 1010 o One or more elements. 1012 When the command has been processed successfully, and the 1013 client selected the extension when it logged in, the server MAY 1014 include in the section of the EPP response a 1015 element, which contains the following child elements: 1017 o A element; 1018 o Zero or more elements; 1019 o Zero or more elements; 1020 o An OPTIONAL element; 1021 o An OPTIONAL element. 1023 Example command: 1025 C: 1026 C: 1027 C: 1028 C: 1029 C: 1031 C: example.com 1032 C: 1033 C: sh8013 1034 C: 1035 C: 1036 C: 1037 C: 1038 C: 1039 C: USD 1040 C: 5.00 1041 C: 1042 C: 1043 C: ABC-12345 1044 C: 1045 C: 1046 Example response: 1048 S: 1049 S: 1050 S: 1051 S: 1052 S: Command completed successfully 1053 S: 1054 S: 1055 S: 1056 S: USD 1057 S: 5.00 1058 S: 1059 S: 1060 S: 1061 S: ABC-12345 1062 S: 54321-XYZ 1063 S: 1064 S: 1065 S: 1067 6. Formal Syntax 1069 One schema is presented here that is the EPP Fee Extension schema. 1071 The formal syntax presented here is a complete schema representation 1072 of the object mapping suitable for automated validation of EPP XML 1073 instances. The BEGIN and END tags are not part of the schema; they 1074 are used to note the beginning and ending of the schema for URI 1075 registration purposes. 1077 6.1. Fee Extension Schema 1079 BEGIN 1080 1081 1088 1089 1091 1092 1093 Extensible Provisioning Protocol v1.0 Fee Extension 1095 1096 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1111 1112 1113 1114 1116 1118 1119 1121 1122 1123 1124 1126 1127 1128 1130 1131 1132 1133 1134 1136 1137 1139 1140 1141 1142 1144 1145 1146 1147 1149 1150 1151 1152 1154 1156 1158 1159 1161 1162 1163 1164 1166 1168 1170 1172 1174 1176 1177 1179 1180 1181 1182 1183 1184 1186 1187 1188 1190 1192 1194 1195 1196 1197 1198 1199 1200 1202 1203 1204 1205 1206 1207 1209 1210 1211 1212 1213 1215 1216 1217 1218 1219 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1246 1247 1248 1250 1251 1252 1254 1255 END 1257 7. Security Considerations 1259 The mapping extensions described in this document do not provide any 1260 security services beyond those described by EPP [RFC5730], the EPP 1261 domain name mapping [RFC5731], and protocol layers used by EPP. The 1262 security considerations described in these other specifications apply 1263 to this specification as well. 1265 8. IANA Considerations 1267 8.1. XML Namespace 1269 This document uses URNs to describe XML namespaces and XML schemas 1270 conforming to a registry mechanism described in [RFC3688]. The 1271 following URI assignment is requested of IANA: 1273 URI: ietf:params:xml:ns:fee-0.17 1275 Registrant Contact: See the "Author's Address" section of this 1276 document. 1278 XML: See the "Formal Syntax" section of this document. 1280 8.2. EPP Extension Registry 1282 The EPP extension described in this document should be registered by 1283 the IANA in the EPP Extension Registry described in [RFC7451]. The 1284 details of the registration are as follows: 1286 Name of Extension: EPP Fee Extension 1288 Document status: Standards Track 1290 Reference: (insert reference to RFC version of this document) 1292 Registrant Name and Email Address: See the "Author's Address" section 1293 of this document. 1295 TLDs: any 1297 IPR Disclosure: none 1299 Status: active 1301 Notes: none 1303 9. Implemntation Status 1305 Note to RFC Editor: Please remove this section and the reference to 1306 [RFC6982] before publication. 1308 This section records the status of known implementations of the 1309 protocol defined by this specification at the time of posting of this 1310 Internet-Draft, and is based on a proposal described in [RFC6982]. 1311 The description of implementations in this section is intended to 1312 assist the IETF in its decision processes in progressing drafts to 1313 RFCs. Please note that the listing of any individual implementation 1314 here does not imply endorsement by the IETF. Furthermore, no effort 1315 has been spent to verify the information presented here that was 1316 supplied by IETF contributors. This is not intended as, and must not 1317 be construed to be, a catalog of available implementations or their 1318 features. Readers are advised to note that other implementations may 1319 exist. 1321 According to [RFC6982], "this will allow reviewers and working groups 1322 to assign due consideration to documents that have the benefit of 1323 running code, which may serve as evidence of valuable experimentation 1324 and feedback that have made the implemented protocols more mature. 1325 It is up to the individual working groups to use this information as 1326 they see fit". 1328 9.1. RegistryEngine EPP Service 1330 Organization: CentralNic 1332 Name: RegistryEngine EPP Service 1333 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1334 SLDs 1336 Level of maturity: Deployed in CentralNic's production environment as 1337 well as two other gTLD registry systems, and two ccTLD registry 1338 systems. 1340 Coverage: All aspects of the protocol are implemented. 1342 Licensing: Proprietary In-House software 1344 Contact: epp@centralnic.com 1346 URL: https://www.centralnic.com 1348 10. Acknowledgements 1350 The authors wish to thank the following persons for their feedback 1351 and suggestions: 1353 o James Gould of Verisign Inc 1354 o Luis Munoz of ISC 1355 o Michael Young of Architelos 1356 o Ben Levac and Jeff Eckhaus of Demand Media 1357 o Seth Goldman of Google 1358 o Klaus Malorny and Michael Bauland of Knipp 1359 o Jody Kolker, Joe Snitker and Kevin Allendorf of Go Daddy 1360 o Michael Holloway of Com Laude 1361 o Santosh Kalsangrah of Impetus Infotech 1362 o Alex Mayrhofer of Nic.at 1364 11. Change History 1366 11.1. Change from 02 to 03 1368 Updated scheme to version 0.17 to simplify the check command syntax. 1369 Moved fee avail to objectCDType to allow fast failing on error 1370 situations. Removed the objectCheckTpye as it was no longer being 1371 used. Updated examples to reflect these scheme changes. Added 1372 language for server failing a if the passed by the 1373 client is less than the server fee. 1375 11.2. Change from 01 to 02 1377 Updated scheme to version 0.15 to fix errors in CommandType, 1378 objectCDType, transformCommandType and transformResultType 1379 definitions. 1381 11.3. Change from 00 to 01 1383 Added Roger Carney as author to finish draft. Moved Formal Syntax 1384 section to main level numbering. Various grammar, typos, and 1385 administrative edits for clarity. Removed default value for the 1386 "applied" attribute of so that it can truly be optional. 1387 Added support for the command to return a element 1388 as well. Modified default response on the command for the 1389 optional when it was not provided in the command, 1390 leaving it to the server to provide the default period value. 1391 Extensive edits were done to the command, the 1392 response and to the fee extension schema (checkType, objectCheckType, 1393 objectIdentifierType, objectCDType, commandType) to support 1394 requesting and returning multiple transformation fees in a single 1395 call. Added section on Phase/Subphase to provide more context on the 1396 uses. 1398 11.4. Change from draft-brown-00 to draft-ietf-regext-fees-00 1400 Updated to be REGEXT WG document. 1402 12. Normative References 1404 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1405 Requirement Levels", BCP 14, RFC 2119, 1406 DOI 10.17487/RFC2119, March 1997, 1407 . 1409 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1410 DOI 10.17487/RFC3688, January 2004, 1411 . 1413 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1414 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1415 DOI 10.17487/RFC3915, September 2004, 1416 . 1418 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1419 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1420 . 1422 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1423 Domain Name Mapping", STD 69, RFC 5731, 1424 DOI 10.17487/RFC5731, August 2009, 1425 . 1427 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1428 Code: The Implementation Status Section", RFC 6982, 1429 DOI 10.17487/RFC6982, July 2013, 1430 . 1432 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1433 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1434 February 2015, . 1436 Authors' Addresses 1438 Roger Carney 1439 GoDaddy Inc. 1440 14455 N. Hayden Rd. #219 1441 Scottsdale, AZ 85260 1442 US 1444 Email: rcarney@godaddy.com 1445 URI: http://www.godaddy.com 1447 Gavin Brown 1448 CentralNic Group plc 1449 35-39 Moorgate 1450 London, England EC2R 6AR 1451 GB 1453 Phone: +44 20 33 88 0600 1454 Email: gavin.brown@centralnic.com 1455 URI: http://www.centralnic.com 1457 Jothan Frakes 1459 Email: jothan@jothan.com 1460 URI: http://jothan.com