idnits 2.17.1 draft-ietf-regext-epp-fees-04.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 (June 4, 2017) is 2518 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 201, but not defined ** Obsolete normative reference: RFC 6982 (Obsoleted by RFC 7942) ** Downref: Normative reference to an Informational RFC: RFC 7451 Summary: 2 errors (**), 0 flaws (~~), 2 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Registration Protocols Extensions R. Carney 3 Internet-Draft GoDaddy Inc. 4 Intended status: Standards Track G. Brown 5 Expires: December 6, 2017 CentralNic Group plc 6 J. Frakes 7 June 4, 2017 9 Registry Fee Extension for the Extensible Provisioning Protocol (EPP) 10 draft-ietf-regext-epp-fees-04 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 December 6, 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 . . . . . . . . . . . . . . . . . 10 71 5.1.1.1. Server Handling of Elements . . . . . . . . . . . 14 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 . . . . . . . . . . . . . . . . . 30 85 9. Implemntation Status . . . . . . . . . . . . . . . . . . . . 30 86 9.1. RegistryEngine EPP Service . . . . . . . . . . . . . . . 31 87 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 31 88 11. Change History . . . . . . . . . . . . . . . . . . . . . . . 31 89 11.1. Change from 03 to 04 . . . . . . . . . . . . . . . . . . 31 90 11.2. Change from 02 to 03 . . . . . . . . . . . . . . . . . . 32 91 11.3. Change from 01 to 02 . . . . . . . . . . . . . . . . . . 32 92 11.4. Change from 00 to 01 . . . . . . . . . . . . . . . . . . 32 93 11.5. Change from draft-brown-00 to draft-ietf-regext-fees-00 32 94 12. Normative References . . . . . . . . . . . . . . . . . . . . 32 95 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 33 97 1. Introduction 99 Historically, domain name registries have applied a simple fee 100 structure for billable transactions, namely a basic unit price 101 applied to domain , , and RGP [RFC3915] 102 restore commands. Given the relatively small number of EPP servers 103 to which EPP clients have been required to connect, it has generally 104 been the case that client operators have been able to obtain details 105 of these fees out-of-band by contacting the server operators. 107 Given the recent expansion of the DNS namespace, and the 108 proliferation of novel business models, it is now desirable to 109 provide a method for EPP clients to query EPP servers for the fees 110 and credits associated with certain commands and specific objects. 112 This document describes an extension mapping for version 1.0 of the 113 Extensible Provisioning Protocol (EPP) [RFC5730]. This EPP mapping 114 provides a mechanism by which EPP clients may query the fees and 115 credits associated with various billable transactions, and obtain 116 their current account balance. 118 1.1. Conventions Used in This Document 120 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 121 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 122 document are to be interpreted as described in RFC 2119 [RFC2119]. 124 XML is case sensitive. Unless stated otherwise, XML specifications 125 and examples provided in this document MUST be interpreted in the 126 character case presented in order to develop a conforming 127 implementation. 129 "fee" is used as an abbreviation for "urn:ietf:params:xml:ns:fee- 130 0.19". The XML namespace prefix "fee" is used, but implementations 131 MUST NOT depend on it and instead employ a proper namespace-aware XML 132 parser and serializer to interpret and output the XML documents. 134 In examples, "C:" represents lines sent by a protocol client and "S:" 135 represents lines returned by a protocol server. Indentation and 136 white space in examples are provided only to illustrate element 137 relationships and are not a REQUIRED feature of this protocol. 139 (Note to RFC Editor: remove the following paragraph before 140 publication as an RFC.) 142 The XML namespace prefix above contains a version number, 143 specifically "0.19". This version number will increment with 144 successive versions of this document, and will reach 1.0 if and when 145 this document is published as an RFC. This permits clients to 146 distinguish which version of the extension a server has implemented. 148 2. Migrating to Newer Versions of This Extension 150 (Note to RFC Editor: remove this section before publication as an 151 RFC.) 153 Servers which implement this extension SHOULD provide a way for 154 clients to progressively update their implementations when a new 155 version of the extension is deployed. 157 Servers SHOULD (for a temporary migration period) provide support for 158 older versions of the extension in parallel to the newest version, 159 and allow clients to select their preferred version via the 160 element of the command. 162 If a client requests multiple versions of the extension at login, 163 then, when preparing responses to commands which do not include 164 extension elements, the server SHOULD only include extension elements 165 in the namespace of the newest version of the extension requested by 166 the client. 168 When preparing responses to commands which do include extension 169 elements, the server SHOULD only include extension elements for the 170 extension versions present in the command. 172 3. Extension Elements 174 3.1. Client Commands 176 The element is used in the EPP command to 177 determine the fee which is applicable to the given command. 179 The list of values include: 181 o "create" indicating a command as defined in [RFC5730]; 182 o "delete" indicating a command as defined in [RFC5730]; 183 o "renew" indicating a command as defined in [RFC5730]; 184 o "update" indicating a command as defined in [RFC5730]; 185 o "transfer" indicating a command as defined in 186 [RFC5730]; 187 o If the server supports the Registry Grace Period Mapping 188 [RFC3915], then the server MUST also support the "restore" value 189 as defined in [RFC3915]. 191 The element MAY have an OPTIONAL "phase" attribute 192 specifying a launch phase as described in [draft-ietf-eppext- 193 launchphase]. It may also contain an OPTIONAL "subphase" attribute 194 identifying the custom or sub-phase as described in [draft-ietf- 195 eppext-launchphase]. 197 3.2. Currency Codes 199 The element is used to indicate which currency fees 200 are charged in. This value of this element MUST be a three-character 201 currency code from [ISO4217]. 203 Note that ISO 4217 provides the special "XXX" code, which MAY be used 204 if the server uses a non-currency based system for assessing fees, 205 such as a system of credits. 207 The use of elements in client commands is OPTIONAL: if 208 a element is not present in a command, the server MUST 209 determine the currency based on the client's account settings which 210 MUST be agreed by the client and server via an out-of-band channel. 211 However, the element MUST be present in responses. 213 Servers SHOULD NOT perform a currency conversion if a client uses an 214 incorrect currency code. Servers SHOULD return a 2004 "Parameter 215 value range" error instead. 217 3.3. Validity Periods 219 When querying for fee information using the command, the 220 element is used to indicate the units to be added to the 221 registration period of objects by the , and 222 commands. This element is derived from the 223 element described in [RFC5731]. 225 The element is OPTIONAL in commands, if omitted, 226 the server MUST determine the fee(s) using the server default period. 227 The element MUST be present in responses. 229 3.4. Fees and Credits 231 Servers which implement this extension will include elements in 232 responses which provide information about the fees and/or credits 233 associated with a given billable transaction. 235 The and elements are used to provide this 236 information. The presence of a element in a response 237 indicates a debit against the client's account balance; a 238 element indicates a credit. A element MUST 239 have a non-negative value. A element MUST have a 240 negative value. 242 A server MAY respond with multiple and 243 elements in the same response. In such cases, the net fee or credit 244 applicable to the transaction is the arithmetic sum of the values of 245 each of the and/or elements. This amount 246 applies to the total additional validity period applied to the object 247 (where applicable) rather than to any incremental unit. 249 The following attributes are defined for the element. 250 These are described in detail below: 252 description: an OPTIONAL attribute which provides a human-readable 253 description of the fee. Servers should provide documentation on the 254 possible values of this attribute, and their meanings. 256 refundable: an OPTIONAL boolean attribute indicating whether the fee 257 is refundable if the object is deleted. 259 grace-period: an OPTIONAL attribute which provides the time period 260 during which the fee is refundable. 262 applied: an OPTIONAL attribute indicating when the fee will be 263 deducted from the client's account. 265 The element can take a "description" attribute as 266 described above. No other attributes are defined for this element. 268 3.4.1. Refunds 270 elements MAY have an OPTIONAL "refundable" attribute which 271 takes a boolean value. Fees may be refunded under certain 272 circumstances, such as when a domain application is rejected (as 273 described in [draft-ietf-eppext-launchphase]) or when an object is 274 deleted during the relevant Grace Period (see below). 276 If the "refundable" attribute is omitted, then clients SHOULD NOT 277 make any assumption about the refundability of the fee. 279 3.4.2. Grace Periods 281 [RFC3915] describes a system of "grace periods", which are time 282 periods following a billable transaction during which, if an object 283 is deleted, the client receives a refund. 285 The "grace-period" attribute MAY be used to indicate the relevant 286 grace period for a fee. If a server implements the Registry Grace 287 Period extension, it MUST specify the grace period for all relevant 288 transactions. 290 If the "grace-period" attribute is omitted, then clients SHOULD NOT 291 make any assumption about the grace period of the fee. 293 3.4.3. Correlation between Refundability and Grace Periods 295 If a element has a "grace-period" attribute then it MUST 296 also be refundable. If the "refundable" attribute of a 297 element is false then it MUST NOT have a "grace-period" attribute. 299 3.4.4. Applicability 301 Fees may be applied immediately upon receipt of a command from a 302 client, or may only be applied once an out-of-band process (such as 303 the processing of applications at the end of a launch phase) has 304 taken place. 306 The "applied" attribute of the element allows servers to 307 indicate whether a fee will be applied immediately, or whether it 308 will be applied at some point in the future. This attribute takes 309 two possible values: "immediate" or "delayed". 311 3.5. Account Balance 313 The element is an OPTIONAL element which MAY be 314 included in server responses to transform commands. If present, it 315 can be used by the client to determine the remaining credit at the 316 server. 318 Whether or not the is included in responses is a matter 319 of server policy. However, if a server chooses to offer support for 320 this element, it MUST be included in responses to all "transform" or 321 billable commands (ie , , , , 322 ). 324 The value of the MAY be negative. A negative balance 325 indicates that the server has extended a line of credit to the client 326 (see below). 328 If a server includes a element in response to transform 329 commands, the value of the element MUST reflect the client's account 330 balance after any fees or credits associated with that command have 331 been applied. 333 3.6. Credit Limit 335 As described above, if a server returns a response containing a 336 with a negative value, then the server has extended a 337 line of credit to the client. A server MAY also include a 338 element in responses which indicates the maximum 339 credit available to a client. A server MAY reject certain 340 transactions if the absolute value of the is equal to 341 or exceeds the value of the element. 343 Whether or not the is included in responses is a 344 matter of server policy. However, if a server chooses to offer 345 support for this element, it MUST be included in responses to all 346 "transform" commands (ie , , , , 347 ). 349 3.7. Classification of Objects 351 Objects may be assigned to a particular class, category, or tier, 352 each of which has a particular fee or set of fees associated with it. 353 The element, which MAY appear in and transform 354 responses, is used to indicate the classification of an object. 356 If a server makes use of this element, it should provide clients with 357 a list of all the values that the element may take via an out-of-band 358 channel. Servers MUST NOT use values which do not appear on this 359 list. 361 Servers which make use of this element MUST use a element 362 with the value "standard" for all objects that are subject to the 363 standard or default fee. 365 3.8. Phase and Subphase Attributes 367 The element has two attributes, phase and subphase, 368 that provide additional information related to a specific launch 369 phase as described in [draft-ietf-eppext-launchphase]. 371 If the client contains no phase attribute the server 372 SHOULD return data (including the phase/subphase attribute(s)) for 373 all valid server combinations of currently active phase(s) and active 374 subphase(s). 376 If the client contains a server supported combination 377 of phase/subphase the server MUST return fee data (including the 378 phase/subphase attribute(s)) for the specific combination(s). 380 If the client contains a phase attribute with no 381 subphase, the server SHOULD return data (including the phase/subphase 382 attribute(s)) for all valid server combinations of provided phase and 383 available subphase(s). 385 If the client contains a subphase with no phase 386 attribute the server MUST respond with a 2003 "Required parameter 387 missing" error. 389 If the client contains a phase attribute not defined in 390 [draft-ietf-eppext-launchphase] or not supported by server the server 391 MUST respond with a 2004 "Parameter value range" error. 393 If the client contains a subphase attribute (or phase/ 394 subphase combination) not supported by server the server MUST respond 395 with a 2004 "Parameter value range" error. 397 4. Server Handling of Fee Information 399 Depending on server policy, a client MAY be required to include the 400 extension elements described in this document for certain transform 401 commands. Servers must provide clear documentation to clients about 402 the circumstances in which this extension must be used. 404 The server MUST return avail="0" in its response to a command 405 for any domain name in the command that does not include the 406 extension for which the server would likewise fail a 407 domain > command when no or 428 commands or responses. 430 5.1.1. EPP Command 432 This extension defines additional elements for the EPP 433 command. 435 The command MAY contain an element which MAY contain a 436 element. The element MAY contain one 437 element and MUST contain one or more 438 elements. 440 The element(s) contain(s) a "name" attribute, an 441 OPTIONAL "phase" attribute, and an OPTIONAL "subphase" attribute. 442 The element(s) MAY have the following child elements: 444 o An OPTIONAL element. 446 Example command: 448 C: 449 C: 450 C: 451 C: 452 C: 454 C: example.com 455 C: example.net 456 C: example.xyz 457 C: 458 C: 459 C: 460 C: 461 C: USD 462 C: 463 C: 2 464 C: 465 C: 466 C: 467 C: 468 C: 469 C: 470 C: ABC-12345 471 C: 472 C: 474 When the server receives a command that includes the 475 extension elements described above, its response MUST contain an 476 element, which MUST contain a child 477 element. The element MUST contain a 478 element and a for each element referenced in the client 479 command. 481 Each element MUST contain the following child elements: 483 o A element, which MUST match an element referenced in 484 the client command. 485 o A element matching each (unless the 486 "avail" attribute of the if false) that appeared in the 487 corresponding of the client command. This element MAY 488 have the OPTIONAL "phase" and "subphase" attributes, which MUST 489 match the same attributes in the corresponding 490 element of the client command. 492 The element also has an OPTIONAL "avail" attribute which is 493 a boolean. If the value of this attribute evaluates to false, this 494 indicates that the server cannot calculate the relevant fees, because 495 the object, command, currency, period, class or some combination is 496 invalid per server policy. If "avail" is false then the 497 element MUST contain a element and the server MAY 498 eliminate some or all of the element(s). 500 The element(s) MAY have the following child elements: 502 o An OPTIONAL element, which contains the same unit 503 that appeared in the element of the command. If the 504 value of the preceding element is "restore", this 505 element MUST NOT be included, otherwise it MUST be included. If 506 no appeared in the client command (and the command is 507 not "restore") then the server MUST return its default period 508 value. 509 o Zero or more elements. 510 o Zero or more elements. 511 o An OPTIONAL element. 512 o An OPTIONAL element. 514 If the "avail" attribute of the element is true and if no 515 elements are present in a element, this 516 indicates that no fee will be assessed by the server for this 517 command. 519 If the "avail" attribute is true, then the element MUST 520 NOT contain a element. 522 Example response: 524 S: 525 S: 526 S: 527 S: 528 S: Command completed successfully 529 S: 530 S: 531 S: 533 S: 534 S: example.com 535 S: 536 S: 537 S: example.net 538 S: 539 S: 540 S: example.xyz 541 S: 542 S: 543 S: 544 S: 545 S: 548 S: USD 549 S: 550 S: example.com 551 S: 552 S: 2 553 S: 10.00 557 S: 558 S: 559 S: 1 560 S: 5.00 564 S: 565 S: 566 S: 1 567 S: 5.00 571 S: 572 S: 573 S: 5.00 575 S: 576 S: 577 S: 578 S: example.net 579 S: 580 S: 2 581 S: 10.00 585 S: 586 S: 587 S: 1 588 S: 5.00 592 S: 593 S: 594 S: 1 595 S: 5.00 599 S: 600 S: 601 S: 5.00 603 S: 604 S: 605 S: 606 S: example.xyz 607 S: 608 S: 2 609 S: Only 1 year registration periods are 610 S: vaild. 611 S: 612 S: 613 S: 614 S: 615 S: 616 S: ABC-12345 617 S: 54322-XYZ 618 S: 619 S: 620 S: 622 5.1.1.1. Server Handling of Elements 624 Clients MAY include a in the element. 625 There are two ways in which servers may handle this element: 627 1. If the server supports the concept of tiers or classes of 628 objects, then the value of this element MUST be validated. If 629 incorrect for the specified object, the "avail" attribute of the 630 corresponding element MUST be false. 631 2. If the server supports different "types" of object registrations 632 (such as a "blocking" registration which does not resolve, or 633 where a registry provides a value-added service that requires an 634 opt-out to disable), then, as with the first model, the server 635 MUST validate the value of the element. If the value is 636 incorrect, the "avail" attribute of the corresponding 637 element MUST be false, and a element MUST be 638 provided. 640 Server operators must provide clear documentation to client operators 641 which of the above models it supports. 643 5.1.2. EPP Transfer Query Command 645 This extension does not add any elements to the EPP query 646 command, but does include elements in the response, when the 647 extension has been selected during a command. 649 When the query command has been processed successfully, 650 the client selected the extension when it logged in, and the client 651 is authorized by the server to view information about the transfer, 652 the server MAY include in the section of the EPP response 653 a element, which contains the following child elements: 655 o A element. 656 o A element. 657 o Zero or more elements containing the fees that will be 658 charged to the gaining client. 659 o Zero or more elements containing the credits that 660 will be refunded to the losing client. 662 Servers SHOULD omit when returning a response to the 663 gaining client, and omit elements when returning a response 664 to the losing client. 666 If no element is included in the response, then no fee 667 will be assessed by the server for the transfer. 669 Example query response: 671 S: 672 S: 673 S: 674 S: 675 S: Command completed successfully; action pending 676 S: 677 S: 678 S: 680 S: example.com 681 S: pending 682 S: ClientX 683 S: 2000-06-08T22:00:00.0Z 684 S: ClientY 685 S: 2000-06-13T22:00:00.0Z 686 S: 2002-09-08T22:00:00.0Z 687 S: 688 S: 689 S: 690 S: 691 S: USD 692 S: 1 693 S: 5.00 694 S: 695 S: 696 S: 697 S: ABC-12345 698 S: 54322-XYZ 699 S: 700 S: 701 S: 703 5.2. EPP Transform Commands 705 5.2.1. EPP Command 707 This extension adds elements to both the EPP command and 708 response, when the extension has been selected during a 709 command. 711 If a command is received with no extension and 712 the server requires a extension for the 713 the server MUST respond with a 2003 "Required parameter missing" 714 error. 716 When submitting a command to the server, the client MAY 717 include in the element a element which 718 includes the following child elements: 720 o An OPTIONAL element; 721 o One or more elements. 723 The server MUST fail the command if the provided 724 by the client is less than the server fee. 726 When the command has been processed successfully, and the 727 client selected the extension when it logged in, and a fee was 728 assessed by the server for the transaction, the server MUST include 729 in the section of the EPP response a 730 element, which contains the following child elements: 732 o A element; 733 o Zero or more elements; 734 o Zero or more elements; 735 o An OPTIONAL element; 736 o An OPTIONAL element. 738 Example command: 740 C: 741 C: 742 C: 743 C: 744 C: 746 C: example.com 747 C: 2 748 C: 749 C: ns1.example.net 750 C: ns2.example.net 751 C: 752 C: jd1234 753 C: sh8013 754 C: sh8013 755 C: 756 C: 2fooBAR 757 C: 758 C: 759 C: 760 C: 761 C: 762 C: USD 763 C: 5.00 764 C: 765 C: 766 C: ABC-12345 767 C: 768 C: 769 Example response: 771 S: 772 S: 773 S: 774 S: 775 S: Command completed successfully 776 S: 777 S: 778 S: 780 S: example.com 781 S: 1999-04-03T22:00:00.0Z 782 S: 2001-04-03T22:00:00.0Z 783 S: 784 S: 785 S: 786 S: 787 S: USD 788 S: 5.00 792 S: -5.00 793 S: 1000.00 794 S: 795 S: 796 S: 797 S: ABC-12345 798 S: 54321-XYZ 799 S: 800 S: 801 S: 803 5.2.2. EPP Command 805 This extension does not add any elements to the EPP command, 806 but does include elements in the response, when the extension has 807 been selected during the command. 809 When the command has been processed successfully, and the 810 client selected the extension when it logged in, the server MAY 811 include in the section of the EPP response a 812 element, which contains the following child elements: 814 o A element; 815 o Zero or more elements; 816 o Zero or more elements; 817 o An OPTIONAL element; 818 o An OPTIONAL element. 820 Example response: 822 S: 823 S: 824 S: 825 S: 826 S: Command completed successfully 827 S: 828 S: 829 S: 831 S: USD 832 S: -5.00 833 S: 1005.00 834 S: 835 S: 836 S: 837 S: ABC-12345 838 S: 54321-XYZ 839 S: 840 S: 841 S: 843 5.2.3. EPP Command 845 This extension adds elements to both the EPP command and 846 response, when the extension has been selected during a 847 command. 849 When submitting a command to the server, the client MAY 850 include in the element a element which 851 includes the following child elements: 853 o An OPTIONAL element; 854 o One or more elements. 856 When the command has been processed successfully, and the 857 client selected the extension when it logged in, the server MAY 858 include in the section of the EPP response a 859 element, which contains the following child elements: 861 o A element; 862 o Zero or more elements; 863 o Zero or more elements; 864 o An OPTIONAL element; 865 o An OPTIONAL element. 867 Example command: 869 C: 870 C: 871 C: 872 C: 873 C: 875 C: example.com 876 C: 2000-04-03 877 C: 5 878 C: 879 C: 880 C: 881 C: 882 C: USD 883 C: 5.00 884 C: 885 C: 886 C: ABC-12345 887 C: 888 C: 889 Example response: 891 S: 892 S: 893 S: 894 S: 895 S: Command completed successfully 896 S: 897 S: 898 S: 900 S: example.com 901 S: 2005-04-03T22:00:00.0Z 902 S: 903 S: 904 S: 905 S: 906 S: USD 907 S: 5.00 910 S: 1000.00 911 S: 912 S: 913 S: 914 S: ABC-12345 915 S: 54322-XYZ 916 S: 917 S: 918 S: 920 5.2.4. EPP Command 922 This extension adds elements to both the EPP command and 923 response, when the value of the "op" attribute of the 924 command element is "request", and the extension has been selected 925 during the command. 927 When submitting a command to the server, the client MAY 928 include in the element a element which 929 includes the following child elements: 931 o An OPTIONAL element; 932 o One or more elements. 934 When the command has been processed successfully, and the 935 client selected the extension when it logged in, the server MAY 936 include in the section of the EPP response a 937 element, which contains the following child elements: 939 o A element; 940 o Zero or more elements; 941 o Zero or more elements; 942 o An OPTIONAL element; 943 o An OPTIONAL element. 945 Example command: 947 C: 948 C: 949 C: 950 C: 951 C: 953 C: example.com 954 C: 1 955 C: 956 C: 2fooBAR 957 C: 958 C: 959 C: 960 C: 961 C: 962 C: USD 963 C: 5.00 964 C: 965 C: 966 C: ABC-12345 967 C: 968 C: 969 Example response: 971 S: 972 S: 973 S: 974 S: 975 S: Command completed successfully; action pending 976 S: 977 S: 978 S: 980 S: example.com 981 S: pending 982 S: ClientX 983 S: 2000-06-08T22:00:00.0Z 984 S: ClientY 985 S: 2000-06-13T22:00:00.0Z 986 S: 2002-09-08T22:00:00.0Z 987 S: 988 S: 989 S: 990 S: 991 S: USD 992 S: 5.00 995 S: 996 S: 997 S: 998 S: ABC-12345 999 S: 54322-XYZ 1000 S: 1001 S: 1002 S: 1004 5.2.5. EPP Command 1006 This extension adds elements to both the EPP command and 1007 response, when the extension has been selected during the 1008 command. 1010 When submitting a command to the server, the client MAY 1011 include in the element a element which 1012 includes the following child elements: 1014 o An OPTIONAL element; 1015 o One or more elements. 1017 When the command has been processed successfully, and the 1018 client selected the extension when it logged in, the server MAY 1019 include in the section of the EPP response a 1020 element, which contains the following child elements: 1022 o A element; 1023 o Zero or more elements; 1024 o Zero or more elements; 1025 o An OPTIONAL element; 1026 o An OPTIONAL element. 1028 Example command: 1030 C: 1031 C: 1032 C: 1033 C: 1034 C: 1036 C: example.com 1037 C: 1038 C: sh8013 1039 C: 1040 C: 1041 C: 1042 C: 1043 C: 1044 C: USD 1045 C: 5.00 1046 C: 1047 C: 1048 C: ABC-12345 1049 C: 1050 C: 1051 Example response: 1053 S: 1054 S: 1055 S: 1056 S: 1057 S: Command completed successfully 1058 S: 1059 S: 1060 S: 1061 S: USD 1062 S: 5.00 1063 S: 1064 S: 1065 S: 1066 S: ABC-12345 1067 S: 54321-XYZ 1068 S: 1069 S: 1070 S: 1072 6. Formal Syntax 1074 One schema is presented here that is the EPP Fee Extension schema. 1076 The formal syntax presented here is a complete schema representation 1077 of the object mapping suitable for automated validation of EPP XML 1078 instances. The BEGIN and END tags are not part of the schema; they 1079 are used to note the beginning and ending of the schema for URI 1080 registration purposes. 1082 6.1. Fee Extension Schema 1084 BEGIN 1085 1086 1093 1094 1096 1097 1098 Extensible Provisioning Protocol v1.0 Fee Extension 1100 1101 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1116 1117 1118 1119 1121 1123 1124 1126 1127 1128 1129 1131 1132 1133 1135 1136 1137 1138 1139 1141 1142 1144 1145 1146 1147 1149 1150 1151 1152 1154 1155 1156 1157 1159 1161 1163 1164 1166 1167 1168 1169 1171 1173 1175 1177 1179 1181 1182 1184 1185 1186 1187 1188 1189 1191 1192 1193 1195 1197 1199 1200 1201 1202 1203 1204 1205 1206 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1219 1220 1221 1222 1223 1225 1226 1227 1228 1229 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1245 1246 1247 1248 1250 1251 1252 1253 1254 1255 1256 1258 1259 1260 1262 1263 1264 1266 1267 END 1269 7. Security Considerations 1271 The mapping extensions described in this document do not provide any 1272 security services beyond those described by EPP [RFC5730], the EPP 1273 domain name mapping [RFC5731], and protocol layers used by EPP. The 1274 security considerations described in these other specifications apply 1275 to this specification as well. 1277 8. IANA Considerations 1279 8.1. XML Namespace 1281 This document uses URNs to describe XML namespaces and XML schemas 1282 conforming to a registry mechanism described in [RFC3688]. The 1283 following URI assignment is requested of IANA: 1285 URI: ietf:params:xml:ns:fee-0.19 1287 Registrant Contact: See the "Author's Address" section of this 1288 document. 1290 XML: See the "Formal Syntax" section of this document. 1292 8.2. EPP Extension Registry 1294 The EPP extension described in this document should be registered by 1295 the IANA in the EPP Extension Registry described in [RFC7451]. The 1296 details of the registration are as follows: 1298 Name of Extension: EPP Fee Extension 1300 Document status: Standards Track 1302 Reference: (insert reference to RFC version of this document) 1304 Registrant Name and Email Address: See the "Author's Address" section 1305 of this document. 1307 TLDs: any 1309 IPR Disclosure: none 1311 Status: active 1313 Notes: none 1315 9. Implemntation Status 1317 Note to RFC Editor: Please remove this section and the reference to 1318 [RFC6982] before publication. 1320 This section records the status of known implementations of the 1321 protocol defined by this specification at the time of posting of this 1322 Internet-Draft, and is based on a proposal described in [RFC6982]. 1323 The description of implementations in this section is intended to 1324 assist the IETF in its decision processes in progressing drafts to 1325 RFCs. Please note that the listing of any individual implementation 1326 here does not imply endorsement by the IETF. Furthermore, no effort 1327 has been spent to verify the information presented here that was 1328 supplied by IETF contributors. This is not intended as, and must not 1329 be construed to be, a catalog of available implementations or their 1330 features. Readers are advised to note that other implementations may 1331 exist. 1333 According to [RFC6982], "this will allow reviewers and working groups 1334 to assign due consideration to documents that have the benefit of 1335 running code, which may serve as evidence of valuable experimentation 1336 and feedback that have made the implemented protocols more mature. 1337 It is up to the individual working groups to use this information as 1338 they see fit". 1340 9.1. RegistryEngine EPP Service 1342 Organization: CentralNic 1344 Name: RegistryEngine EPP Service 1346 Description: Generic high-volume EPP service for gTLDs, ccTLDs and 1347 SLDs 1349 Level of maturity: Deployed in CentralNic's production environment as 1350 well as two other gTLD registry systems, and two ccTLD registry 1351 systems. 1353 Coverage: All aspects of the protocol are implemented. 1355 Licensing: Proprietary In-House software 1357 Contact: epp@centralnic.com 1359 URL: https://www.centralnic.com 1361 10. Acknowledgements 1363 The authors wish to thank the following persons for their feedback 1364 and suggestions: 1366 o James Gould of Verisign Inc 1367 o Luis Munoz of ISC 1368 o Michael Young of Architelos 1369 o Ben Levac and Jeff Eckhaus of Demand Media 1370 o Seth Goldman of Google 1371 o Klaus Malorny and Michael Bauland of Knipp 1372 o Jody Kolker, Joe Snitker and Kevin Allendorf of Go Daddy 1373 o Michael Holloway of Com Laude 1374 o Santosh Kalsangrah of Impetus Infotech 1375 o Alex Mayrhofer of Nic.at 1377 11. Change History 1379 11.1. Change from 03 to 04 1381 Updated scheme to version 0.19 to correct typos and to replace the 1382 commandTypeValue type with the commandEnum type and customName 1383 attribute for stricter validation. Updated various text for grammar 1384 and clarity. Added text to section 4 clarifying the response 1385 when the client provided no fee extension but the server was 1386 expecting the extension. 1388 11.2. Change from 02 to 03 1390 Updated scheme to version 0.17 to simplify the check command syntax. 1391 Moved fee avail to objectCDType to allow fast failing on error 1392 situations. Removed the objectCheckType as it was no longer being 1393 used. Updated examples to reflect these scheme changes. Added 1394 language for server failing a if the passed by the 1395 client is less than the server fee. 1397 11.3. Change from 01 to 02 1399 Updated scheme to version 0.15 to fix errors in CommandType, 1400 objectCDType, transformCommandType and transformResultType 1401 definitions. 1403 11.4. Change from 00 to 01 1405 Added Roger Carney as author to finish draft. Moved Formal Syntax 1406 section to main level numbering. Various grammar, typos, and 1407 administrative edits for clarity. Removed default value for the 1408 "applied" attribute of so that it can truly be optional. 1409 Added support for the command to return a element 1410 as well. Modified default response on the command for the 1411 optional when it was not provided in the command, 1412 leaving it to the server to provide the default period value. 1413 Extensive edits were done to the command, the 1414 response and to the fee extension schema (checkType, objectCheckType, 1415 objectIdentifierType, objectCDType, commandType) to support 1416 requesting and returning multiple transformation fees in a single 1417 call. Added section on Phase/Subphase to provide more context on the 1418 uses. 1420 11.5. Change from draft-brown-00 to draft-ietf-regext-fees-00 1422 Updated to be REGEXT WG document. 1424 12. Normative References 1426 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1427 Requirement Levels", BCP 14, RFC 2119, 1428 DOI 10.17487/RFC2119, March 1997, 1429 . 1431 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1432 DOI 10.17487/RFC3688, January 2004, 1433 . 1435 [RFC3915] Hollenbeck, S., "Domain Registry Grace Period Mapping for 1436 the Extensible Provisioning Protocol (EPP)", RFC 3915, 1437 DOI 10.17487/RFC3915, September 2004, 1438 . 1440 [RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", 1441 STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009, 1442 . 1444 [RFC5731] Hollenbeck, S., "Extensible Provisioning Protocol (EPP) 1445 Domain Name Mapping", STD 69, RFC 5731, 1446 DOI 10.17487/RFC5731, August 2009, 1447 . 1449 [RFC6982] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 1450 Code: The Implementation Status Section", RFC 6982, 1451 DOI 10.17487/RFC6982, July 2013, 1452 . 1454 [RFC7451] Hollenbeck, S., "Extension Registry for the Extensible 1455 Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451, 1456 February 2015, . 1458 Authors' Addresses 1460 Roger Carney 1461 GoDaddy Inc. 1462 14455 N. Hayden Rd. #219 1463 Scottsdale, AZ 85260 1464 US 1466 Email: rcarney@godaddy.com 1467 URI: http://www.godaddy.com 1469 Gavin Brown 1470 CentralNic Group plc 1471 35-39 Moorgate 1472 London, England EC2R 6AR 1473 GB 1475 Phone: +44 20 33 88 0600 1476 Email: gavin.brown@centralnic.com 1477 URI: http://www.centralnic.com 1478 Jothan Frakes 1480 Email: jothan@jothan.com 1481 URI: http://jothan.com